linktime-proc-macro 0.2.0

proc-macro helpers for linktime crates (ctors, dtors, linker sections)
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
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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
mod args;

use std::borrow::Cow;

use proc_macro::{Group, Ident, Literal, Span, TokenStream, TokenTree};

use self::args::{
    parse_arguments, pop_argument, pop_optional_argument, OutputType, PatternString,
    TranslateString,
};

pub(crate) fn combine(item: TokenStream) -> TokenStream {
    let mut args = parse_arguments(item, "combine!");
    let output = pop_argument::<OutputType>(&mut args, "combine!", "output");
    let input = pop_argument::<TokenStream>(&mut args, "combine!", "input");
    let prefix = pop_optional_argument::<TokenStream>(&mut args, "combine!", "prefix");
    let suffix = pop_optional_argument::<TokenStream>(&mut args, "combine!", "suffix");
    let paren = pop_optional_argument::<TokenTree>(&mut args, "combine!", "paren");
    let paren_prefix = pop_optional_argument::<TokenStream>(&mut args, "combine!", "paren_prefix");
    let paren_suffix = pop_optional_argument::<TokenStream>(&mut args, "combine!", "paren_suffix");
    let span = pop_optional_argument::<Span>(&mut args, "combine!", "span");

    let mut s = String::with_capacity(32);

    parse_stream(&mut s, "input", output, input);

    let span = span.unwrap_or_else(Span::call_site);

    let output_token = match output {
        OutputType::Ident => TokenTree::Ident(Ident::new(to_ident(&s).as_ref(), span)),
        OutputType::String => TokenTree::Literal(Literal::string(s.as_str())),
        OutputType::ISize => {
            let s = s.replace(|c: char| c != '+' && c != '-' && !c.is_ascii_digit(), "");
            TokenTree::Literal(Literal::isize_suffixed(
                s.parse::<isize>().expect("input: Expected a valid isize"),
            ))
        }
        OutputType::RawString => unreachable!(),
    };

    let mut stream = TokenStream::new();
    if let Some(prefix) = prefix {
        stream.extend(prefix);
    }
    if let Some(paren) = paren {
        let TokenTree::Group(group) = paren else {
            panic!("combine!: Expected an empty group in paren");
        };
        let mut paren_stream = TokenStream::new();
        if let Some(paren_prefix) = paren_prefix {
            paren_stream.extend(paren_prefix);
        }
        paren_stream.extend([output_token]);
        if let Some(paren_suffix) = paren_suffix {
            paren_stream.extend(paren_suffix);
        }
        let group = Group::new(group.delimiter(), paren_stream);
        stream.extend([TokenTree::Group(group)]);
    } else {
        stream.extend([output_token]);
    }
    if let Some(suffix) = suffix {
        stream.extend(suffix);
    }
    stream
}

#[allow(unknown_lints, tail_expr_drop_order)]
fn parse_stream(s: &mut String, arg: &str, output: OutputType, input: TokenStream) {
    let mut input = input.into_iter();
    while let Some(token) = input.next() {
        match token {
            TokenTree::Literal(literal) => {
                let literal = literal.to_string();
                if literal.starts_with('"') && literal.ends_with('"') {
                    decode_literal_string(
                        s,
                        arg,
                        literal
                            .strip_prefix('"')
                            .unwrap()
                            .strip_suffix('"')
                            .unwrap(),
                    );
                } else if literal.starts_with('\'') && literal.ends_with('\'') {
                    decode_literal_string(
                        s,
                        arg,
                        literal
                            .strip_prefix('\'')
                            .unwrap()
                            .strip_suffix('\'')
                            .unwrap(),
                    );
                } else if literal.starts_with(|c: char| c.is_ascii_digit()) {
                    s.push_str(&literal);
                } else {
                    panic!(
                        "{arg}: Expected a literal string or numeric literal, got `{literal:?}`"
                    );
                }
            }
            TokenTree::Ident(ident) => {
                let ident = ident.to_string();
                if output != OutputType::RawString
                    && ident.len() > 2
                    && ident.starts_with("__")
                    && ident.ends_with("__")
                {
                    parse_function(s, arg, &mut input, &ident);
                } else {
                    s.push_str(&ident);
                }
            }
            TokenTree::Group(group) => parse_stream(s, arg, output, group.stream()),
            TokenTree::Punct(punct) => s.push(punct.as_char()),
        }
    }
}

fn parse_function(
    s: &mut String,
    arg: &str,
    input: &mut proc_macro::token_stream::IntoIter,
    ident: &String,
) {
    let func = &ident[2..ident.len() - 2];
    let Some(TokenTree::Group(group)) = input.next() else {
        panic!("Expected arguments after {ident:?}");
    };
    let mut args = parse_arguments(group.stream(), ident);
    match func {
        "FILE" => {
            let of = pop_optional_argument::<Span>(&mut args, ident, "of")
                .unwrap_or_else(Span::call_site);
            let file = crate::fallback::file(&of);
            s.push_str(&file);
        }
        "LINE" => {
            let of = pop_optional_argument::<Span>(&mut args, ident, "of")
                .unwrap_or_else(Span::call_site);
            let line = crate::fallback::line(&of);
            s.push_str(&line.to_string());
        }
        "COLUMN" => {
            let of = pop_optional_argument::<Span>(&mut args, ident, "of")
                .unwrap_or_else(Span::call_site);
            let column = crate::fallback::column(&of);
            s.push_str(&column.to_string());
        }
        "SOURCE" => {
            let of = pop_argument::<TokenStream>(&mut args, ident, "of");
            for (i, token) in of.into_iter().enumerate() {
                if i > 0 {
                    s.push(' ');
                }
                s.push_str(
                    crate::fallback::source_text(&token.span())
                        .unwrap_or_default()
                        .as_ref(),
                );
            }
        }
        "DEBUG" => {
            let of = pop_argument::<TokenTree>(&mut args, ident, "of");
            s.push_str(&format!("{:?}", of));
        }
        "HASH" => {
            let input = pop_argument::<String>(&mut args, ident, "string");
            let alphabet = pop_optional_argument::<TranslateString>(&mut args, ident, "alphabet");
            let mut hash = crate::hash::xx3::xx3hash(&input);
            if let Some(alphabet) = alphabet {
                if hash == 0 {
                    s.push(alphabet.char(0));
                } else {
                    let mut hash_str = String::with_capacity(32);
                    while hash > 0 {
                        hash_str.push(alphabet.char(hash as usize % alphabet.len()));
                        hash /= alphabet.len() as u64;
                    }
                    s.extend(hash_str.chars().rev());
                }
            } else {
                s.push_str(&format!("{:016x}", hash));
            }
        }
        "LOCATIONHASH" => {
            let input = pop_argument::<TokenStream>(&mut args, ident, "of");
            let alphabet = pop_optional_argument::<TranslateString>(&mut args, ident, "alphabet");
            let mut hash = crate::hash::location_hash(input);
            if let Some(alphabet) = alphabet {
                if hash == 0 {
                    s.push(alphabet.char(0));
                } else {
                    let mut hash_str = String::with_capacity(32);
                    while hash > 0 {
                        hash_str.push(alphabet.char(hash as usize % alphabet.len()));
                        hash /= alphabet.len() as u64;
                    }
                    s.extend(hash_str.chars().rev());
                }
            } else {
                s.push_str(&format!("{:016x}", hash));
            }
        }
        "LENGTH" => {
            let input = pop_argument::<String>(&mut args, ident, "string");
            s.push_str(&input.len().to_string());
        }
        "REPLACE" => {
            let input = pop_argument::<String>(&mut args, ident, "input");
            let pattern = pop_argument::<PatternString>(&mut args, ident, "pattern");
            let replacement = pop_argument::<String>(&mut args, ident, "replacement");

            match pattern {
                PatternString::Range(range) => {
                    s.push_str(&input.replace(|c: char| range.is_match(c), &replacement));
                }
                PatternString::String(string) => {
                    s.push_str(&input.replace(&string, &replacement));
                }
            }
        }
        "TRANSLATE" => {
            let input = pop_argument::<String>(&mut args, ident, "input");
            let pattern = pop_argument::<TranslateString>(&mut args, ident, "pattern");
            let replacement =
                pop_optional_argument::<TranslateString>(&mut args, ident, "replacement")
                    .unwrap_or_default();
            for c in input.chars() {
                if let Some(index) = pattern.find(c) {
                    if !replacement.is_empty() {
                        s.push(replacement.char(index));
                    }
                } else {
                    s.push(c);
                }
            }
        }
        "TRIM" => {
            let input = pop_argument::<String>(&mut args, ident, "input");
            let left = pop_argument::<PatternString>(&mut args, ident, "left");
            let right = pop_argument::<PatternString>(&mut args, ident, "right");
            let input = match left {
                PatternString::Range(range) => {
                    input.trim_start_matches(|c: char| range.is_match(c))
                }
                PatternString::String(string) => input.trim_start_matches(&string),
            };
            let input = match right {
                PatternString::Range(range) => input.trim_end_matches(|c: char| range.is_match(c)),
                PatternString::String(string) => input.trim_end_matches(&string),
            };
            s.push_str(input);
        }
        "CONTAINS" => {
            let input = pop_argument::<String>(&mut args, ident, "input");
            let pattern = pop_argument::<PatternString>(&mut args, ident, "pattern");
            let sucesss = match pattern {
                PatternString::Range(range) => input.contains(|c: char| range.is_match(c)),
                PatternString::String(string) => input.contains(&string),
            };
            s.push_str(if sucesss { "1" } else { "0" });
        }
        "STREQ" => {
            let a = pop_argument::<String>(&mut args, ident, "a");
            let b = pop_argument::<String>(&mut args, ident, "b");
            s.push_str(if a == b { "1" } else { "0" });
        }
        "SUBSTRING" => {
            let input = pop_argument::<String>(&mut args, ident, "input");
            let start = pop_optional_argument::<usize>(&mut args, ident, "start").unwrap_or(0);
            let end = pop_optional_argument::<usize>(&mut args, ident, "end");
            let length = pop_optional_argument::<usize>(&mut args, ident, "length");

            let end = end.or(length.map(|l| start + l)).unwrap_or(usize::MAX);
            let end = end.min(input.len());

            s.push_str(&input[start..end]);
        }
        "PAD" => {
            let input = pop_argument::<String>(&mut args, ident, "input");
            let length = pop_argument::<usize>(&mut args, ident, "length");
            let left =
                pop_optional_argument::<String>(&mut args, ident, "left").unwrap_or_default();
            let right =
                pop_optional_argument::<String>(&mut args, ident, "right").unwrap_or_default();
            if !left.is_empty() && !right.is_empty() {
                panic!("{arg}: Expected a left xor right padding, got both");
            }

            let mut len = input.len();
            if !left.is_empty() {
                while len < length {
                    s.push_str(&left);
                    len += left.len();
                }
            }
            s.push_str(&input);
            if !right.is_empty() {
                while len < length {
                    s.push_str(&right);
                    len += right.len();
                }
            }
        }
        "IF" => {
            let a = pop_argument::<isize>(&mut args, ident, "test");
            let then_tree = pop_argument::<String>(&mut args, ident, "then");
            let else_tree =
                pop_optional_argument::<String>(&mut args, ident, "else").unwrap_or_default();

            if a != 0 {
                s.push_str(&then_tree);
            } else {
                s.push_str(&else_tree);
            }
        }
        "ADD" => {
            let a = pop_argument::<isize>(&mut args, ident, "a");
            let b = pop_argument::<isize>(&mut args, ident, "b");
            s.push_str(&(a + b).to_string());
        }
        "SUB" => {
            let a = pop_argument::<isize>(&mut args, ident, "a");
            let b = pop_argument::<isize>(&mut args, ident, "b");
            s.push_str(&(a - b).to_string());
        }
        "MUL" => {
            let a = pop_argument::<isize>(&mut args, ident, "a");
            let b = pop_argument::<isize>(&mut args, ident, "b");
            s.push_str(&(a * b).to_string());
        }
        "DIV" => {
            let a = pop_argument::<isize>(&mut args, ident, "a");
            let b = pop_argument::<isize>(&mut args, ident, "b");
            s.push_str(&(a / b).to_string());
        }
        "AND" => {
            let a = pop_argument::<isize>(&mut args, ident, "a");
            let b = pop_argument::<isize>(&mut args, ident, "b");
            s.push_str(&(a & b).to_string());
        }
        "OR" => {
            let a = pop_argument::<isize>(&mut args, ident, "a");
            let b = pop_argument::<isize>(&mut args, ident, "b");
            s.push_str(&(a | b).to_string());
        }
        "NE" => {
            let a = pop_argument::<isize>(&mut args, ident, "a");
            let b = pop_argument::<isize>(&mut args, ident, "b");
            s.push_str(&((a != b) as u8).to_string());
        }
        "EQ" => {
            let a = pop_argument::<isize>(&mut args, ident, "a");
            let b = pop_argument::<isize>(&mut args, ident, "b");
            s.push_str(&((a == b) as u8).to_string());
        }
        "GE" => {
            let a = pop_argument::<isize>(&mut args, ident, "a");
            let b = pop_argument::<isize>(&mut args, ident, "b");
            s.push_str(&((a >= b) as u8).to_string());
        }
        "GT" => {
            let a = pop_argument::<isize>(&mut args, ident, "a");
            let b = pop_argument::<isize>(&mut args, ident, "b");
            s.push_str(&((a > b) as u8).to_string());
        }
        "LE" => {
            let a = pop_argument::<isize>(&mut args, ident, "a");
            let b = pop_argument::<isize>(&mut args, ident, "b");
            s.push_str(&((a <= b) as u8).to_string());
        }
        "LT" => {
            let a = pop_argument::<isize>(&mut args, ident, "a");
            let b = pop_argument::<isize>(&mut args, ident, "b");
            s.push_str(&((a < b) as u8).to_string());
        }
        "RAW" => {
            let input = pop_argument::<TokenStream>(&mut args, ident, "input");
            let mut raw = String::with_capacity(32);
            parse_stream(&mut raw, ident, OutputType::RawString, input);
            s.push_str(&raw);
        }
        "TOSTRING" => {
            let input = pop_argument::<String>(&mut args, ident, "input");
            s.push_str(&input);
        }
        "TOIDENT" => {
            let input = pop_argument::<String>(&mut args, ident, "input");
            s.push_str(to_ident(&input).as_ref());
        }
        "TONUMBER" => {
            let input = pop_argument::<isize>(&mut args, ident, "input");
            s.push_str(&input.to_string());
        }
        _ => {
            panic!("Unknown function: {func}");
        }
    }
}

pub(crate) fn decode_literal_string(s: &mut String, name: &str, literal: &str) {
    if !literal.contains('\\') {
        s.push_str(literal);
    } else {
        let mut iter = literal.chars();
        while let Some(c) = iter.next() {
            if c == '\\' {
                match iter.next() {
                    Some('n') => s.push('\n'),
                    Some('r') => s.push('\r'),
                    Some('t') => s.push('\t'),
                    Some('\\') => s.push('\\'),
                    Some('"') => s.push('"'),
                    Some('\'') => s.push('\''),
                    Some('0') => s.push('\0'),
                    Some('x') => {
                        let Some(c) = iter.next() else {
                            panic!("{}: Expected a hexadecimal character", name);
                        };
                        let Some(c2) = iter.next() else {
                            panic!("{}: Expected a hexadecimal character", name);
                        };
                        let Ok(c) = format!("{}{}", c, c2).parse::<u8>() else {
                            panic!("{}: Expected a hexadecimal character", name);
                        };
                        s.push(char::from(c));
                    }
                    Some(_) => panic!("{name}: Expected a valid escape sequence (got {c:?})"),
                    None => break,
                }
            } else {
                s.push(c);
            }
        }
    }
}

fn to_ident(input: &str) -> Cow<'_, str> {
    // Idents must be XID_Start + XID_Continue*, but we just use
    // is_alphabetic and is_alphanumeric as an approximation.
    let mut s = input;
    while !s.starts_with(|c: char| c.is_alphabetic() || c == '_') {
        if s.is_empty() {
            panic!("No valid ident characters found in `{input}`");
        }
        s = &s[1..];
    }

    // If we detect any invalid chars, filter them one-by-one.
    if s[1..].contains(|c: char| !c.is_alphanumeric() && c != '_') {
        let mut output = String::with_capacity(s.len());
        let mut chars = s.chars();
        // We know there's always at least one
        output.push(chars.next().unwrap());
        for c in chars {
            if c.is_alphanumeric() || c == '_' {
                output.push(c);
            }
        }
        Cow::Owned(output)
    } else {
        // Fast path: all valid chars are alphanumeric or underscore.
        Cow::Borrowed(s)
    }
}