Unnamed repository; edit this file 'description' to name the repository.
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
//! Eager expansion related utils
//!
//! Here is a dump of a discussion from Vadim Petrochenkov about Eager Expansion and
//! Its name resolution :
//!
//! > Eagerly expanded macros (and also macros eagerly expanded by eagerly expanded macros,
//! > which actually happens in practice too!) are resolved at the location of the "root" macro
//! > that performs the eager expansion on its arguments.
//! > If some name cannot be resolved at the eager expansion time it's considered unresolved,
//! > even if becomes available later (e.g. from a glob import or other macro).
//!
//! > Eagerly expanded macros don't add anything to the module structure of the crate and
//! > don't build any speculative module structures, i.e. they are expanded in a "flat"
//! > way even if tokens in them look like modules.
//!
//! > In other words, it kinda works for simple cases for which it was originally intended,
//! > and we need to live with it because it's available on stable and widely relied upon.
//!
//!
//! See the full discussion : <https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/Eager.20expansion.20of.20built-in.20macros>
use base_db::CrateId;
use rustc_hash::{FxHashMap, FxHashSet};
use syntax::{ted, Parse, SyntaxNode, TextRange, TextSize, WalkEvent};
use triomphe::Arc;

use crate::{
    ast::{self, AstNode},
    db::ExpandDatabase,
    hygiene::Hygiene,
    mod_path::ModPath,
    EagerCallInfo, ExpandError, ExpandResult, ExpandTo, InFile, MacroCallId, MacroCallKind,
    MacroCallLoc, MacroDefId, MacroDefKind,
};

pub fn expand_eager_macro_input(
    db: &dyn ExpandDatabase,
    krate: CrateId,
    macro_call: InFile<ast::MacroCall>,
    def: MacroDefId,
    resolver: &dyn Fn(ModPath) -> Option<MacroDefId>,
) -> ExpandResult<Option<MacroCallId>> {
    let ast_map = db.ast_id_map(macro_call.file_id);
    // the expansion which the ast id map is built upon has no whitespace, so the offsets are wrong as macro_call is from the token tree that has whitespace!
    let call_id = InFile::new(macro_call.file_id, ast_map.ast_id(&macro_call.value));
    let expand_to = ExpandTo::from_call_site(&macro_call.value);

    // Note:
    // When `lazy_expand` is called, its *parent* file must already exist.
    // Here we store an eager macro id for the argument expanded subtree
    // for that purpose.
    let arg_id = db.intern_macro_call(MacroCallLoc {
        def,
        krate,
        eager: None,
        kind: MacroCallKind::FnLike { ast_id: call_id, expand_to: ExpandTo::Expr },
    });
    let ExpandResult { value: (arg_exp, arg_exp_map), err: parse_err } =
        db.parse_macro_expansion(arg_id.as_macro_file());
    // we need this map here as the expansion of the eager input fake file loses whitespace ...
    let mut ws_mapping = FxHashMap::default();
    if let Some((_, tm, _)) = db.macro_arg(arg_id).value.as_deref() {
        ws_mapping.extend(tm.entries().filter_map(|(id, range)| {
            Some((arg_exp_map.first_range_by_token(id, syntax::SyntaxKind::TOMBSTONE)?, range))
        }));
    }

    let ExpandResult { value: expanded_eager_input, err } = {
        eager_macro_recur(
            db,
            &Hygiene::new(db, macro_call.file_id),
            InFile::new(arg_id.as_file(), arg_exp.syntax_node()),
            krate,
            resolver,
        )
    };
    let err = parse_err.or(err);

    let Some((expanded_eager_input, mapping)) = expanded_eager_input else {
        return ExpandResult { value: None, err };
    };

    let (mut subtree, expanded_eager_input_token_map) =
        mbe::syntax_node_to_token_tree(&expanded_eager_input);

    let og_tmap = if let Some(tt) = macro_call.value.token_tree() {
        let mut ids_used = FxHashSet::default();
        let mut og_tmap = mbe::syntax_node_to_token_map(tt.syntax());
        // The tokenmap and ids of subtree point into the expanded syntax node, but that is inaccessible from the outside
        // so we need to remap them to the original input of the eager macro.
        subtree.visit_ids(&mut |id| {
            // Note: we discard all token ids of braces and the like here, but that's not too bad and only a temporary fix

            if let Some(range) = expanded_eager_input_token_map
                .first_range_by_token(id, syntax::SyntaxKind::TOMBSTONE)
            {
                // remap from expanded eager input to eager input expansion
                if let Some(og_range) = mapping.get(&range) {
                    // remap from eager input expansion to original eager input
                    if let Some(&og_range) = ws_mapping.get(og_range) {
                        if let Some(og_token) = og_tmap.token_by_range(og_range) {
                            ids_used.insert(og_token);
                            return og_token;
                        }
                    }
                }
            }
            tt::TokenId::UNSPECIFIED
        });
        og_tmap.filter(|id| ids_used.contains(&id));
        og_tmap
    } else {
        Default::default()
    };
    subtree.delimiter = crate::tt::Delimiter::unspecified();

    let loc = MacroCallLoc {
        def,
        krate,
        eager: Some(Box::new(EagerCallInfo {
            arg: Arc::new((subtree, og_tmap)),
            arg_id,
            error: err.clone(),
        })),
        kind: MacroCallKind::FnLike { ast_id: call_id, expand_to },
    };

    ExpandResult { value: Some(db.intern_macro_call(loc)), err }
}

fn lazy_expand(
    db: &dyn ExpandDatabase,
    def: &MacroDefId,
    macro_call: InFile<ast::MacroCall>,
    krate: CrateId,
) -> ExpandResult<(InFile<Parse<SyntaxNode>>, Arc<mbe::TokenMap>)> {
    let ast_id = db.ast_id_map(macro_call.file_id).ast_id(&macro_call.value);

    let expand_to = ExpandTo::from_call_site(&macro_call.value);
    let ast_id = macro_call.with_value(ast_id);
    let id = def.as_lazy_macro(db, krate, MacroCallKind::FnLike { ast_id, expand_to });
    let macro_file = id.as_macro_file();

    db.parse_macro_expansion(macro_file)
        .map(|parse| (InFile::new(macro_file.into(), parse.0), parse.1))
}

fn eager_macro_recur(
    db: &dyn ExpandDatabase,
    hygiene: &Hygiene,
    curr: InFile<SyntaxNode>,
    krate: CrateId,
    macro_resolver: &dyn Fn(ModPath) -> Option<MacroDefId>,
) -> ExpandResult<Option<(SyntaxNode, FxHashMap<TextRange, TextRange>)>> {
    let original = curr.value.clone_for_update();
    let mut mapping = FxHashMap::default();

    let mut replacements = Vec::new();

    // FIXME: We only report a single error inside of eager expansions
    let mut error = None;
    let mut offset = 0i32;
    let apply_offset = |it: TextSize, offset: i32| {
        TextSize::from(u32::try_from(offset + u32::from(it) as i32).unwrap_or_default())
    };
    let mut children = original.preorder_with_tokens();

    // Collect replacement
    while let Some(child) = children.next() {
        let WalkEvent::Enter(child) = child else { continue };
        let call = match child {
            syntax::NodeOrToken::Node(node) => match ast::MacroCall::cast(node) {
                Some(it) => {
                    children.skip_subtree();
                    it
                }
                None => continue,
            },
            syntax::NodeOrToken::Token(t) => {
                mapping.insert(
                    TextRange::new(
                        apply_offset(t.text_range().start(), offset),
                        apply_offset(t.text_range().end(), offset),
                    ),
                    t.text_range(),
                );
                continue;
            }
        };
        let def = match call.path().and_then(|path| ModPath::from_src(db, path, hygiene)) {
            Some(path) => match macro_resolver(path.clone()) {
                Some(def) => def,
                None => {
                    error =
                        Some(ExpandError::other(format!("unresolved macro {}", path.display(db))));
                    continue;
                }
            },
            None => {
                error = Some(ExpandError::other("malformed macro invocation"));
                continue;
            }
        };
        let ExpandResult { value, err } = match def.kind {
            MacroDefKind::BuiltInEager(..) => {
                let ExpandResult { value, err } = expand_eager_macro_input(
                    db,
                    krate,
                    curr.with_value(call.clone()),
                    def,
                    macro_resolver,
                );
                match value {
                    Some(call_id) => {
                        let ExpandResult { value, err: err2 } =
                            db.parse_macro_expansion(call_id.as_macro_file());

                        if let Some(tt) = call.token_tree() {
                            let call_tt_start = tt.syntax().text_range().start();
                            let call_start =
                                apply_offset(call.syntax().text_range().start(), offset);
                            if let Some((_, arg_map, _)) = db.macro_arg(call_id).value.as_deref() {
                                mapping.extend(arg_map.entries().filter_map(|(tid, range)| {
                                    value
                                        .1
                                        .first_range_by_token(tid, syntax::SyntaxKind::TOMBSTONE)
                                        .map(|r| (r + call_start, range + call_tt_start))
                                }));
                            }
                        }

                        ExpandResult {
                            value: Some(value.0.syntax_node().clone_for_update()),
                            err: err.or(err2),
                        }
                    }
                    None => ExpandResult { value: None, err },
                }
            }
            MacroDefKind::Declarative(_)
            | MacroDefKind::BuiltIn(..)
            | MacroDefKind::BuiltInAttr(..)
            | MacroDefKind::BuiltInDerive(..)
            | MacroDefKind::ProcMacro(..) => {
                let ExpandResult { value: (parse, tm), err } =
                    lazy_expand(db, &def, curr.with_value(call.clone()), krate);
                let decl_mac = if let MacroDefKind::Declarative(ast_id) = def.kind {
                    Some(db.decl_macro_expander(def.krate, ast_id))
                } else {
                    None
                };

                // replace macro inside
                let hygiene = Hygiene::new(db, parse.file_id);
                let ExpandResult { value, err: error } = eager_macro_recur(
                    db,
                    &hygiene,
                    // FIXME: We discard parse errors here
                    parse.as_ref().map(|it| it.syntax_node()),
                    krate,
                    macro_resolver,
                );
                let err = err.or(error);

                if let Some(tt) = call.token_tree() {
                    let call_tt_start = tt.syntax().text_range().start();
                    let call_start = apply_offset(call.syntax().text_range().start(), offset);
                    if let Some((_tt, arg_map, _)) = parse
                        .file_id
                        .macro_file()
                        .and_then(|id| db.macro_arg(id.macro_call_id).value)
                        .as_deref()
                    {
                        mapping.extend(arg_map.entries().filter_map(|(tid, range)| {
                            tm.first_range_by_token(
                                decl_mac.as_ref().map(|it| it.map_id_down(tid)).unwrap_or(tid),
                                syntax::SyntaxKind::TOMBSTONE,
                            )
                            .map(|r| (r + call_start, range + call_tt_start))
                        }));
                    }
                }
                // FIXME: Do we need to re-use _m here?
                ExpandResult { value: value.map(|(n, _m)| n), err }
            }
        };
        if err.is_some() {
            error = err;
        }
        // check if the whole original syntax is replaced
        if call.syntax() == &original {
            return ExpandResult { value: value.zip(Some(mapping)), err: error };
        }

        if let Some(insert) = value {
            offset += u32::from(insert.text_range().len()) as i32
                - u32::from(call.syntax().text_range().len()) as i32;
            replacements.push((call, insert));
        }
    }

    replacements.into_iter().rev().for_each(|(old, new)| ted::replace(old.syntax(), new));
    ExpandResult { value: Some((original, mapping)), err: error }
}