cairo-language-server 2.20.0

The Cairo Language Server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166

use indoc::indoc;

use crate::macros::{
    fixtures::ProjectWithUserDefinedInlineMacros, test_macro_expansion_and_diagnostics,
};

#[test]
fn test_simple_expr_macro() {
    test_macro_expansion_and_diagnostics!(
        project = ProjectWithUserDefinedInlineMacros,
        cwd = "test_package",
        files {
            "test_package/src/a.cairo" => indoc!(r#"
                use test_package::add_one;

                fn foo() {
                    let x = 1;
                    let _ = add_on<caret>e!(x);
                }
            "#)
        }
    );
}

#[test]
fn test_multiple_branch_expr_macro() {
    test_macro_expansion_and_diagnostics!(
        project = ProjectWithUserDefinedInlineMacros,
        cwd = "test_package",
        files {
            "test_package/src/a.cairo" => indoc!(r#"
                use test_package::add_many;

                fn foo() {
                    let x = 1;
                    let y = 1;
                    let z = add_many<caret>!(x, y);
                    let _ = add_many<caret>!(x, y, z);
                }
            "#)
        }
    );
}

#[test]
fn test_repetition_expr_macro() {
    test_macro_expansion_and_diagnostics!(
        project = ProjectWithUserDefinedInlineMacros,
        cwd = "test_package",
        files {
            "test_package/src/a.cairo" => indoc!(r#"
                use test_package::build_array;

                fn foo() {
                    let _full = build_arr<caret>ay!(1, 2, 3);
                    let _empty: Array<felt252> = build_arr<caret>ay!();
                }
            "#)
        }
    );
}

#[test]
fn test_statement_macros() {
    test_macro_expansion_and_diagnostics!(
        project = ProjectWithUserDefinedInlineMacros,
        cwd = "test_package",
        files {
            "test_package/src/a.cairo" => indoc!(r#"
                use test_package::{append_twice, declare_two};

                fn foo() {
                    declare_t<caret>wo!(10);
                    let mut data: Array<felt252> = ArrayTrait::new();
                    append_t<caret>wice!(data, 1);
                }
            "#)
        }
    );
}

// Two independent item-level macro invocations on adjacent lines: expanding one
// must not leak fragments of the other expansion into the result.
//
// Note: the item-level macros are defined in the same module they are invoked in,
// like in the compiler test suite. Importing a macro with `use` and invoking it
// at the top level of the importing module results in `E2025: Cycle detected
// while resolving 'use' items`.
#[test]
fn test_adjacent_top_level_item_macros() {
    test_macro_expansion_and_diagnostics!(
        project = ProjectWithUserDefinedInlineMacros,
        cwd = "test_package",
        files {
            "test_package/src/a.cairo" => indoc!(r#"
                macro define_fn {
                    ($name:ident) => {
                        expose! {
                            fn $name() -> felt252 {
                                42
                            }
                        }
                    };
                }

                macro define_struct {
                    ($name:ident) => {
                        expose! {
                            struct $name {
                                pub value: felt252,
                            }
                        }
                    };
                }

                define_f<caret>n!(the_answer);
                define_str<caret>uct!(Wrapper);

                fn foo() -> felt252 {
                    let w = Wrapper { value: the_answer() };
                    w.value
                }
            "#)
        }
    );
}

// Note: the item-level macro is defined in the same module it is invoked in,
// like in the compiler test suite. Importing a macro with `use` and invoking it
// at the top level of the importing module results in `E2025: Cycle detected
// while resolving 'use' items`.
#[test]
fn test_top_level_item_macro() {
    test_macro_expansion_and_diagnostics!(
        project = ProjectWithUserDefinedInlineMacros,
        cwd = "test_package",
        files {
            "test_package/src/a.cairo" => indoc!(r#"
                macro define_fn_and_struct {
                    ($name:ident) => {
                        expose! {
                            fn $name() -> felt252 {
                                42
                            }

                            struct Wrapper {
                                pub value: felt252,
                            }

                            fn get_value(s: Wrapper) -> felt252 {
                                s.value
                            }
                        }
                    };
                }

                define_fn_an<caret>d_struct!(the_answer);

                fn foo() -> felt252 {
                    let w = Wrapper { value: the_answer() };
                    get_value(w)
                }
            "#)
        }
    );
}