lisette-emit 0.4.1

Little language inspired by Rust that compiles to Go
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
use rustc_hash::{FxHashMap as HashMap, FxHashSet as HashSet};

use diagnostics::{LisetteDiagnostic, emit as emit_diag};
use syntax::ast::{Expression, ImportAlias, Pattern, Span, StructKind, VariantFields, Visibility};
use syntax::program::File;

use crate::Planner;
use crate::definitions::enum_layout::{
    ENUM_GO_STRINGER_METHOD, ENUM_STRINGER_METHOD, ENUM_TAG_FIELD,
};
use crate::definitions::structs::{should_synthesize_stringer, struct_field_go_name};
use crate::names::go_name;

type SpanMap = HashMap<String, Vec<Span>>;

impl Planner<'_> {
    pub(crate) fn detect_name_collisions(&self, files: &[&File]) -> Vec<LisetteDiagnostic> {
        let mut package_block: SpanMap = HashMap::default();
        let mut selectors: HashMap<String, SpanMap> = HashMap::default();
        let mut interfaces: HashMap<String, SpanMap> = HashMap::default();
        let mut diagnostics = Vec::new();

        for file in files {
            for item in &file.items {
                self.collect_item(
                    item,
                    &mut package_block,
                    &mut selectors,
                    &mut interfaces,
                    &mut diagnostics,
                );
            }
        }

        self.collect_import_aliases(files, &mut package_block);

        report_collisions(package_block, &mut diagnostics);
        for (_, members) in sort_by_key(selectors) {
            report_collisions(members, &mut diagnostics);
        }
        for (_, methods) in sort_by_key(interfaces) {
            report_collisions(methods, &mut diagnostics);
        }

        diagnostics
    }

    fn collect_item(
        &self,
        item: &Expression,
        package_block: &mut SpanMap,
        selectors: &mut HashMap<String, SpanMap>,
        interfaces: &mut HashMap<String, SpanMap>,
        diagnostics: &mut Vec<LisetteDiagnostic>,
    ) {
        match item {
            Expression::Function {
                name,
                name_span,
                visibility,
                generics,
                ..
            } => {
                if self.facts.is_unused_definition(name_span) {
                    return;
                }
                self.check_reserved_qualifier_generics(generics, diagnostics);
                let go = self.free_function_go_name(name, visibility);
                self.check_reserved_prefix(&go, name_span, diagnostics);
                package_block.entry(go).or_default().push(*name_span);
            }
            Expression::Const {
                identifier,
                identifier_span,
                ..
            } => {
                let go = self.const_go_name(identifier);
                self.check_reserved_prefix(&go, identifier_span, diagnostics);
                package_block.entry(go).or_default().push(*identifier_span);
            }
            Expression::TypeAlias {
                name,
                name_span,
                generics,
                ..
            } => {
                let go = go_name::escape_keyword(name).into_owned();
                self.check_reserved_prefix(&go, name_span, diagnostics);
                self.check_reserved_qualifier(&go, name_span, diagnostics);
                self.check_reserved_qualifier_generics(generics, diagnostics);
                package_block.entry(go).or_default().push(*name_span);
            }
            Expression::Struct {
                name,
                name_span,
                fields,
                kind,
                attributes,
                generics,
                ..
            } => {
                let type_go = go_name::escape_keyword(name).into_owned();
                self.check_reserved_prefix(&type_go, name_span, diagnostics);
                self.check_reserved_qualifier(&type_go, name_span, diagnostics);
                self.check_reserved_qualifier_generics(generics, diagnostics);
                package_block
                    .entry(type_go.clone())
                    .or_default()
                    .push(*name_span);

                let members = selectors.entry(type_go).or_default();
                match kind {
                    StructKind::Record => {
                        for field in fields {
                            let field_go = struct_field_go_name(field, attributes);
                            members.entry(field_go).or_default().push(field.name_span);
                        }
                    }
                    StructKind::Tuple => {
                        // A single-field tuple with no generics is a newtype (a Go
                        // scalar type, no struct fields); empty tuples have none.
                        let is_newtype = fields.len() == 1 && generics.is_empty();
                        if !fields.is_empty() && !is_newtype {
                            for (index, field) in fields.iter().enumerate() {
                                members
                                    .entry(format!("F{}", index))
                                    .or_default()
                                    .push(field.name_span);
                            }
                        }
                    }
                }
                if let Some(stringer) = self.stringer_method_name(name, attributes) {
                    members
                        .entry(stringer.to_string())
                        .or_default()
                        .push(*name_span);
                }
                if self.should_synthesize_to_string(name, attributes) {
                    members
                        .entry(self.to_string_method_go_name())
                        .or_default()
                        .push(*name_span);
                }
            }
            Expression::Enum {
                name,
                name_span,
                variants,
                attributes,
                visibility,
                generics,
                ..
            } => {
                let type_go = go_name::escape_keyword(name).into_owned();
                self.check_reserved_prefix(&type_go, name_span, diagnostics);
                self.check_reserved_qualifier(&type_go, name_span, diagnostics);
                self.check_reserved_qualifier_generics(generics, diagnostics);

                if attributes
                    .iter()
                    .any(|attribute| attribute.name == "iterate")
                {
                    let variants_fn =
                        self.variants_go_name(name, matches!(visibility, Visibility::Public));
                    package_block
                        .entry(variants_fn)
                        .or_default()
                        .push(*name_span);
                }

                package_block
                    .entry(type_go.clone())
                    .or_default()
                    .push(*name_span);
                package_block
                    .entry(format!("{}Tag", name))
                    .or_default()
                    .push(*name_span);
                for variant in variants {
                    let tag_constant = if variant.name.as_str() == ENUM_TAG_FIELD {
                        format!("{}Tag_", name)
                    } else {
                        format!("{}{}", name, variant.name)
                    };
                    package_block
                        .entry(tag_constant)
                        .or_default()
                        .push(variant.name_span);
                    let constructor =
                        format!("Make{}{}", go_name::escape_keyword(name), variant.name);
                    package_block
                        .entry(constructor)
                        .or_default()
                        .push(variant.name_span);
                }

                let members = selectors.entry(type_go).or_default();
                members
                    .entry(ENUM_TAG_FIELD.to_string())
                    .or_default()
                    .push(*name_span);
                let synthesize = should_synthesize_stringer(attributes);
                let (has_user_string, has_user_go_string) = self.stringer_overrides(name);
                if synthesize && !has_user_string {
                    members
                        .entry(ENUM_STRINGER_METHOD.to_string())
                        .or_default()
                        .push(*name_span);
                }
                if synthesize && !has_user_go_string {
                    members
                        .entry(ENUM_GO_STRINGER_METHOD.to_string())
                        .or_default()
                        .push(*name_span);
                }
                if self.should_synthesize_to_string(name, attributes) {
                    members
                        .entry(self.to_string_method_go_name())
                        .or_default()
                        .push(*name_span);
                }
                if attributes.iter().any(|attribute| attribute.name == "json") {
                    members
                        .entry("MarshalJSON".to_string())
                        .or_default()
                        .push(*name_span);
                    members
                        .entry("UnmarshalJSON".to_string())
                        .or_default()
                        .push(*name_span);
                }
                // Enum payload fields share the type's selector namespace. They
                // are coalesced by Go name across variants, so each distinct
                // name is recorded once (coalescing is intentional, not a
                // collision). Within one variant, two fields landing on the
                // same Go name would assign one struct field twice, so each
                // struct variant's fields are also grouped on their own.
                let qualified = self.facts.qualified_current(name);
                if let Some(layout) = self.enum_layout(&qualified) {
                    let mut seen: HashSet<&str> = HashSet::default();
                    for (variant, layout_variant) in variants.iter().zip(&layout.variants) {
                        for field in &layout_variant.fields {
                            if seen.insert(field.go_name.as_str()) {
                                members
                                    .entry(field.go_name.clone())
                                    .or_default()
                                    .push(variant.name_span);
                            }
                        }
                        if let VariantFields::Struct(fields) = &variant.fields {
                            let mut variant_fields: SpanMap = HashMap::default();
                            for (field, layout_field) in fields.iter().zip(&layout_variant.fields) {
                                variant_fields
                                    .entry(layout_field.go_name.clone())
                                    .or_default()
                                    .push(field.name_span);
                            }
                            report_collisions(variant_fields, diagnostics);
                        }
                    }
                }
            }
            Expression::Interface {
                name,
                name_span,
                method_signatures,
                visibility,
                generics,
                ..
            } => {
                let type_go = go_name::escape_keyword(name).into_owned();
                self.check_reserved_prefix(&type_go, name_span, diagnostics);
                self.check_reserved_qualifier(&type_go, name_span, diagnostics);
                self.check_reserved_qualifier_generics(generics, diagnostics);
                package_block
                    .entry(type_go.clone())
                    .or_default()
                    .push(*name_span);

                let is_public = matches!(visibility, Visibility::Public);
                let methods = interfaces.entry(type_go).or_default();
                for signature in method_signatures {
                    if let Expression::Function {
                        name: method_name,
                        name_span: method_span,
                        generics: method_generics,
                        ..
                    } = signature
                    {
                        self.check_reserved_qualifier_generics(method_generics, diagnostics);
                        let method_go = if is_public || self.method_needs_export(method_name) {
                            go_name::snake_to_camel(method_name)
                        } else {
                            go_name::escape_keyword(method_name).into_owned()
                        };
                        methods.entry(method_go).or_default().push(*method_span);
                    }
                }
            }
            Expression::ImplBlock {
                receiver_name,
                methods,
                generics,
                ..
            } => {
                self.check_reserved_qualifier_generics(generics, diagnostics);
                let type_go = go_name::escape_keyword(receiver_name).into_owned();
                let qualified_type = self.facts.qualified_current(receiver_name);
                for method in methods {
                    let Expression::Function {
                        name,
                        name_span,
                        visibility,
                        params,
                        generics: method_generics,
                        ..
                    } = method
                    else {
                        continue;
                    };
                    if self.facts.is_unused_definition(name_span) {
                        continue;
                    }
                    self.check_reserved_qualifier_generics(method_generics, diagnostics);
                    let has_self = params.first().is_some_and(|binding| {
                        matches!(&binding.pattern, Pattern::Identifier { identifier, .. } if identifier == "self")
                    });
                    let is_ufcs = self.facts.is_ufcs_method(&qualified_type, name);
                    let should_export =
                        matches!(visibility, Visibility::Public) || self.method_needs_export(name);
                    if has_self && !is_ufcs {
                        // Go receiver method: lives in the type's selector set.
                        let method_go = if should_export {
                            go_name::snake_to_camel(name)
                        } else {
                            go_name::escape_keyword(name).into_owned()
                        };
                        self.check_reserved_prefix(&method_go, name_span, diagnostics);
                        selectors
                            .entry(type_go.clone())
                            .or_default()
                            .entry(method_go)
                            .or_default()
                            .push(*name_span);
                    } else {
                        // self-less or UFCS method: package-level free function.
                        let method_go = if should_export {
                            go_name::snake_to_camel(name)
                        } else {
                            name.to_string()
                        };
                        let base = format!("{}_{}", receiver_name, method_go);
                        let go = self
                            .module
                            .escape_remap(&base)
                            .map(str::to_string)
                            .unwrap_or_else(|| go_name::escape_reserved(&base).into_owned());
                        self.check_reserved_prefix(&go, name_span, diagnostics);
                        package_block.entry(go).or_default().push(*name_span);
                    }
                }
            }
            _ => {}
        }
    }

    fn collect_import_aliases(&self, files: &[&File], package_block: &mut SpanMap) {
        let go_package_names = self.facts.go_package_names();
        let unused = self.facts.unused_imports_for_current_module();
        for file in files {
            for import in file.imports() {
                if matches!(import.alias, Some(ImportAlias::Blank(_))) {
                    continue;
                }
                let Some(alias) = import.effective_alias(go_package_names) else {
                    continue;
                };
                if unused.contains(alias.as_str()) {
                    continue;
                }
                let qualifier = go_name::sanitize_package_name(&alias);
                if let Some(spans) = package_block.get_mut(qualifier.as_ref()) {
                    spans.push(import.name_span);
                }
            }
        }
    }

    fn free_function_go_name(&self, name: &str, visibility: &Visibility) -> String {
        if matches!(visibility, Visibility::Public) {
            go_name::snake_to_camel(name)
        } else {
            self.module
                .escape_remap(name)
                .map(str::to_string)
                .unwrap_or_else(|| go_name::escape_reserved(name).into_owned())
        }
    }

    fn const_go_name(&self, identifier: &str) -> String {
        self.module
            .escape_remap(identifier)
            .map(str::to_string)
            .unwrap_or_else(|| identifier.to_string())
    }

    fn check_reserved_prefix(&self, go: &str, span: &Span, out: &mut Vec<LisetteDiagnostic>) {
        if go.starts_with(go_name::ADAPTER_TYPE_PREFIX) {
            out.push(emit_diag::reserved_go_prefix(
                go,
                go_name::ADAPTER_TYPE_PREFIX,
                span,
            ));
        }
    }

    fn check_reserved_qualifier(&self, go: &str, span: &Span, out: &mut Vec<LisetteDiagnostic>) {
        if go_name::is_generated_import_qualifier(go) {
            out.push(emit_diag::reserved_go_qualifier(go, span));
        }
    }

    fn check_reserved_qualifier_generics(
        &self,
        generics: &[syntax::ast::Generic],
        out: &mut Vec<LisetteDiagnostic>,
    ) {
        for generic in generics {
            self.check_reserved_qualifier(&generic.name, &generic.span, out);
        }
    }
}

fn report_collisions(map: SpanMap, diagnostics: &mut Vec<LisetteDiagnostic>) {
    let mut groups: Vec<(String, Vec<Span>)> = map.into_iter().collect();
    groups.sort_by(|a, b| a.0.cmp(&b.0));
    for (go, mut spans) in groups {
        spans.sort_by_key(|span| (span.file_id, span.byte_offset));
        spans.dedup();
        if spans.len() > 1 {
            diagnostics.push(emit_diag::go_name_collision(&go, &spans, None));
        }
    }
}

fn sort_by_key(map: HashMap<String, SpanMap>) -> Vec<(String, SpanMap)> {
    let mut entries: Vec<(String, SpanMap)> = map.into_iter().collect();
    entries.sort_by(|a, b| a.0.cmp(&b.0));
    entries
}