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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
use std::fmt::{Display, Formatter};

use ariadne::{CharSet, Color, Config, Label, Report, ReportKind, Source};
use schemars::JsonSchema;
use serde::Deserialize;
use serde::Serialize;

use crate::lexer::error::SyntaxError;
use crate::lexer::token::{Span, Token, TokenKind};
use crate::parser::ast::attributes::AttributeGroup;
use crate::parser::ast::data_type::Type;
use crate::parser::ast::modifiers::PromotedPropertyModifier;
use crate::parser::ast::Program;

use super::ast::identifiers::SimpleIdentifier;
use super::ast::variables::SimpleVariable;
use super::state::State;

pub type ParseResult<T> = Result<T, ParseError>;

#[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize, JsonSchema)]
#[serde(tag = "type")]
pub enum ParseErrorAnnotationType {
    Hint,
    Error,
}

#[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize, JsonSchema)]
pub struct ParseErrorAnnotation {
    pub r#type: ParseErrorAnnotationType,
    pub message: String,
    pub position: usize,
    pub length: usize,
}

#[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize, JsonSchema)]
pub struct ParseError {
    pub id: String,
    pub message: String,
    pub span: Span,
    pub annotations: Vec<ParseErrorAnnotation>,
    pub note: Option<String>,
}

#[derive(Debug, PartialEq, Eq, Clone, Deserialize, Serialize, JsonSchema)]
pub struct ParseErrorStack {
    pub partial: Program,
    pub errors: Vec<ParseError>,
}

impl ParseErrorStack {
    pub fn report<'a>(
        &self,
        source: &'a str,
        origin: Option<&'a str>,
        colored: bool,
        ascii: bool,
    ) -> std::io::Result<String> {
        let mut reports = Vec::new();

        for error in &self.errors {
            reports.push(error.report(source, origin, colored, ascii)?);
        }

        Ok(reports.join("\n"))
    }
}

impl ParseError {
    pub fn new<TId: ToString, TMessage: ToString>(id: TId, message: TMessage, span: Span) -> Self {
        Self {
            id: id.to_string(),
            message: message.to_string(),
            span,
            annotations: Vec::new(),
            note: None,
        }
    }

    pub fn highlight(mut self, position: usize, length: usize) -> Self {
        self.annotations.push(ParseErrorAnnotation {
            r#type: ParseErrorAnnotationType::Hint,
            message: "".to_owned(),
            position,
            length,
        });

        self
    }

    pub fn error<T: ToString>(mut self, message: T, position: usize, length: usize) -> Self {
        self.annotations.push(ParseErrorAnnotation {
            r#type: ParseErrorAnnotationType::Error,
            message: message.to_string(),
            position,
            length,
        });

        self
    }

    pub fn note<T: ToString>(mut self, note: T) -> Self {
        self.note = Some(note.to_string());

        self
    }

    pub fn report<'a>(
        &self,
        source: &'a str,
        origin: Option<&'a str>,
        colored: bool,
        ascii: bool,
    ) -> std::io::Result<String> {
        let origin = origin.unwrap_or("input");

        let mut report = Report::build(ReportKind::Error, origin, self.span.position)
            .with_code(&self.id)
            .with_message(&self.message)
            .with_config(
                Config::default()
                    .with_color(colored)
                    .with_char_set(if ascii {
                        CharSet::Ascii
                    } else {
                        CharSet::Unicode
                    }),
            );

        for (order, annotation) in self.annotations.iter().enumerate() {
            let mut label = Label::new((
                origin,
                annotation.position..annotation.position + annotation.length,
            ))
            .with_order(order.try_into().unwrap());

            if !annotation.message.is_empty() {
                label = label.with_message(&annotation.message);
            }

            if colored {
                label = match annotation.r#type {
                    ParseErrorAnnotationType::Hint => label.with_color(Color::Cyan),
                    ParseErrorAnnotationType::Error => label.with_color(Color::Red),
                };
            }

            report = report.with_label(label);
        }

        if let Some(note) = &self.note {
            report = report.with_note(note);
        }

        let code = (origin, Source::from(source));

        let mut bytes = Vec::new();

        report.finish().write(code, &mut bytes)?;

        let string = unsafe {
            // SAFETY: We know that the bytes are valid UTF-8
            String::from_utf8_unchecked(bytes)
        };

        Ok(string)
    }
}

pub fn unexpected_token(expected: Vec<String>, found: &Token) -> ParseError {
    let (found_name, eof) = match &found.kind {
        TokenKind::Eof => ("end of file".to_string(), true),
        kind => match kind {
            TokenKind::Identifier
            | TokenKind::QualifiedIdentifier
            | TokenKind::FullyQualifiedIdentifier => ("identifier".to_string(), false),
            TokenKind::Variable => ("variable".to_string(), false),
            TokenKind::LiteralInteger | TokenKind::LiteralFloat | TokenKind::LiteralString => {
                ("literal".to_string(), false)
            }
            _ => (format!("token `{}`", found.value), false),
        },
    };

    if expected.is_empty() {
        return if eof {
            ParseError::new("E002", format!("unexpected {}", found_name), found.span)
        } else {
            ParseError::new("E003", format!("unexpected {}", found_name), found.span).error(
                "try removing this".to_string(),
                found.span.position,
                found.value.len(),
            )
        };
    }

    let expected: Vec<String> = expected
        .iter()
        .map(|s| {
            if s.starts_with("a ") || s.starts_with("an ") {
                s.to_string()
            } else {
                format!("`{}`", s)
            }
        })
        .collect();

    let length = expected.len();
    let expected = if length > 2 {
        let (left, right) = expected.split_at(length - 1);

        format!("{}, or {}", left.join(", "), right[0])
    } else {
        expected.join(", or ")
    };

    ParseError::new(
        "E005",
        format!("unexpected {}, expecting {}", found_name, expected),
        found.span,
    )
    .error(
        format!("expected {}", expected),
        found.span.position,
        found.value.len(),
    )
}

pub fn unexpected_identifier(expected: Vec<String>, found: String, span: Span) -> ParseError {
    let length = expected.len();
    let expected = if length >= 2 {
        let (left, right) = expected.split_at(length - 1);

        format!("{}`, or `{}", left.join("`, `"), right[0])
    } else {
        expected.join("")
    };

    ParseError::new(
        "E006",
        format!(
            "unexpected identifier `{}`, expecting `{}`",
            found, expected
        ),
        span,
    )
    .error(
        format!("try replacing this with `{}`", expected),
        span.position,
        found.len(),
    )
}

pub fn multiple_modifiers(modifier: String, first: Span, second: Span) -> ParseError {
    ParseError::new(
        "E007",
        format!("multiple `{}` modifiers are not allowed", modifier),
        second,
    )
    .highlight(first.position, modifier.len())
    .error("try removing this", second.position, modifier.len())
}

pub fn multiple_visibility_modifiers(first: (String, Span), second: (String, Span)) -> ParseError {
    ParseError::new(
        "E008",
        "multiple visibility modifiers are not allowed",
        second.1,
    )
    .highlight(first.1.position, first.0.len())
    .error("try removing this", second.1.position, second.0.len())
}

pub fn standalone_type_used_as_nullable(ty: &Type, span: Span) -> ParseError {
    let type_span = ty.first_span();
    let type_string = ty.to_string();

    ParseError::new(
        "E009",
        format!("standalone type `{}` cannot be nullable", type_string),
        type_span,
    )
    .error("try removing this", span.position, 1)
    .highlight(type_span.position, type_string.len())
    .note("`never`, `void`, and `mixed` cannot be nullable")
}

pub fn standalone_type_used_in_union(ty: &Type, span: Span) -> ParseError {
    let type_span = ty.first_span();
    let type_string = ty.to_string();

    ParseError::new(
        "E010",
        format!(
            "standalone type `{}` cannot be used in a union",
            type_string
        ),
        type_span,
    )
    .error(
        format!("try using a type other than `{}`", type_string),
        type_span.position,
        type_string.len(),
    )
    .highlight(span.position, 1)
    .note("`never`, `void`, `mixed`, and nullable types cannot be used in a union")
}

pub fn standalone_type_used_in_intersection(ty: &Type, span: Span) -> ParseError {
    let type_span = ty.first_span();
    let type_string = ty.to_string();

    ParseError::new(
        "E011",
        format!(
            "standalone type `{}` cannot be used in an intersection",
            type_string
        ),
        type_span,
    )
    .error(
        format!("try using a type other than `{}`", type_string),
        type_span.position,
        type_string.len(),
    )
    .highlight(span.position, 1)
    .note("`never`, `void`, `mixed`, and nullable types cannot be used in an intersection")
}

pub fn try_without_catch_or_finally(try_span: Span, last_right_brace: Span) -> ParseError {
    ParseError::new(
        "E012",
        "cannot use `try` without `catch` or `finally`",
        try_span,
    )
    .highlight(
        try_span.position,
        last_right_brace.position - try_span.position + 1,
    )
}

pub fn variadic_promoted_property(
    state: &mut State,
    class: Option<&SimpleIdentifier>,
    property: &SimpleVariable,
    span: Span,
    modifier: &PromotedPropertyModifier,
) -> ParseError {
    let error = ParseError::new(
        "E013",
        format!(
            "promoted property `{}::{}` cannot declare variadic",
            class
                .map(|c| state.named(c))
                .unwrap_or_else(|| "anonymous@class".to_string()),
            property.name
        ),
        span,
    )
    .highlight(modifier.span().position, modifier.to_string().len())
    .highlight(property.span.position, property.name.len())
    .error("try removing this variadic declaration", span.position, 3);

    if let Some(class) = class {
        error.highlight(class.span.position, class.value.len())
    } else {
        error
    }
}

pub fn missing_type_for_readonly_property(
    state: &mut State,
    class: Option<&SimpleIdentifier>,
    property: &SimpleVariable,
    readonly_span: Span,
) -> ParseError {
    let error = ParseError::new(
        "E014",
        format!(
            "missing type for readonly property `{}::{}`",
            class
                .map(|c| state.named(c))
                .unwrap_or_else(|| "anonymous@class".to_string()),
            property.name
        ),
        property.span,
    )
    .error(
        format!("try adding a type before `{}`", property.name),
        property.span.position,
        property.name.len(),
    )
    .highlight(readonly_span.position, 8);

    if let Some(class) = class {
        error.highlight(class.span.position, class.value.len())
    } else {
        error
    }
}

pub fn abstract_method_on_a_non_abstract_class(
    state: &mut State,
    class: &SimpleIdentifier,
    method: &SimpleIdentifier,
    abstract_span: Span,
    semicolon_span: Span,
) -> ParseError {
    ParseError::new(
        "E015",
        format!(
            "cannot declare method `{}::{}` abstract, as `{}` class is not abstract",
            state.named(&class),
            method.value,
            class,
        ),
        semicolon_span,
    )
    .error(
        "try removing this `abstract` modifier",
        abstract_span.position,
        "abstract".len(),
    )
    .highlight(class.span.position, class.value.len())
    .highlight(method.span.position, method.value.len())
}

pub fn constructor_in_enum(
    state: &mut State,
    r#enum: &SimpleIdentifier,
    constructor: &SimpleIdentifier,
) -> ParseError {
    ParseError::new(
        "E016",
        format!(
            "cannot declare a constructor on enum `{}`",
            state.named(&r#enum)
        ),
        constructor.span,
    )
    .error(
        "try removing this constructor",
        constructor.span.position,
        constructor.value.len(),
    )
    .highlight(r#enum.span.position, r#enum.value.len())
}

pub fn magic_method_in_enum(
    state: &mut State,
    r#enum: &SimpleIdentifier,
    method: &SimpleIdentifier,
) -> ParseError {
    ParseError::new(
        "E017",
        format!(
            "cannot declare magic method `{}::{}` in an enum",
            state.named(&r#enum),
            method.value
        ),
        method.span,
    )
    .error(
        "try removing this magic method",
        method.span.position,
        method.value.len(),
    )
    .highlight(r#enum.span.position, r#enum.value.len())
}

pub fn missing_case_value_for_backed_enum(
    state: &mut State,
    r#enum: &SimpleIdentifier,
    case: &SimpleIdentifier,
    semicolon_span: Span,
) -> ParseError {
    ParseError::new(
        "E018",
        format!(
            "case `{}::{}` of backed enum `{}` must have a value",
            state.named(&r#enum),
            case,
            r#enum
        ),
        semicolon_span,
    )
    .error("try adding a value", semicolon_span.position, 1)
    .highlight(case.span.position, case.value.len())
    .highlight(r#enum.span.position, r#enum.value.len())
}

pub fn case_value_for_unit_enum(
    state: &mut State,
    r#enum: &SimpleIdentifier,
    case: &SimpleIdentifier,
    equals_span: Span,
) -> ParseError {
    ParseError::new(
        "E019",
        format!(
            "case `{}::{}` of unit enum `{}` cannot have a value",
            state.named(&r#enum),
            case,
            r#enum
        ),
        equals_span,
    )
    .error("try replacing this with `;`", equals_span.position, 1)
    .highlight(case.span.position, case.value.len())
    .highlight(r#enum.span.position, r#enum.value.len())
}

pub fn modifier_cannot_be_used_for_constant(modifier: String, modifier_span: Span) -> ParseError {
    ParseError::new(
        "E020",
        format!("cannot use '{}' as constant modifier", modifier),
        modifier_span,
    )
    .error("try removing this", modifier_span.position, modifier.len())
    .note("only `public`, `protected`, `private`, and `final` modifiers can be used on constants")
}

pub fn modifier_cannot_be_used_for_interface_constant(
    modifier: String,
    modifier_span: Span,
) -> ParseError {
    ParseError::new(
        "E021",
        format!(
            "cannot use '{}' as an interface constant modifier",
            modifier
        ),
        modifier_span,
    )
    .error("try removing this", modifier_span.position, modifier.len())
    .note("only `public`, and `final` modifiers can be used on interface constants")
}

pub fn modifier_cannot_be_used_for_promoted_property(
    modifier: String,
    modifier_span: Span,
) -> ParseError {
    ParseError::new(
        "E022",
        format!("cannot use '{}' as a promoted property modifier", modifier),
        modifier_span,
    )
    .error(
        "try removing this",
        modifier_span.position,
        modifier.len(),
    )
    .note("only `public`, `protected`, `private`, and `readonly` modifiers can be used on promoted properties")
}

pub fn modifier_cannot_be_used_for_property(modifier: String, modifier_span: Span) -> ParseError {
    ParseError::new(
        "E023",
        format!("cannot use '{}' as a property modifier", modifier),
        modifier_span,
    )
    .error(
        "try removing this",
        modifier_span.position,
        modifier.len(),
    )
    .note("only `public`, `protected`, `private`, `static`, and `readonly` modifiers can be used on properties")
}

pub fn modifier_cannot_be_used_for_class(modifier: String, modifier_span: Span) -> ParseError {
    ParseError::new(
        "E024",
        format!("cannot use '{}' as a class modifier", modifier),
        modifier_span,
    )
    .error("try removing this", modifier_span.position, modifier.len())
    .note("only `final`, `abstract`, and `readonly` modifiers can be used on classes")
}

pub fn modifier_cannot_be_used_for_class_method(
    modifier: String,
    modifier_span: Span,
) -> ParseError {
    ParseError::new(
        "E025",
        format!("cannot use '{}' as a class method modifier", modifier),
        modifier_span,
    )
    .error(
        "try removing this",
        modifier_span.position,
        modifier.len(),
    )
    .note("only `public`, `protected`, `private`, `final`, `static`, and `abstract` modifiers can be used on class methods")
}

pub fn modifier_cannot_be_used_for_enum_method(
    modifier: String,
    modifier_span: Span,
) -> ParseError {
    ParseError::new(
        "E026",
        format!("cannot use '{}' as an enum method modifier", modifier),
        modifier_span,
    )
    .error(
        "try removing this",
        modifier_span.position,
        modifier.len(),
    )
    .note("only `public`, `protected`, `private`, `final`, and `static` modifiers can be used on enum methods")
}

pub fn modifier_cannot_be_used_for_interface_method(
    modifier: String,
    modifier_span: Span,
) -> ParseError {
    ParseError::new(
        "E027",
        format!("cannot use '{}' as an interface method modifier", modifier),
        modifier_span,
    )
    .error("try removing this", modifier_span.position, modifier.len())
    .note("only `public`, and `static` modifiers can be used on interface methods")
}

pub fn final_and_abstract_modifiers_combined_for_class(
    final_span: Span,
    abstract_span: Span,
) -> ParseError {
    ParseError::new(
        "E028",
        "cannot declare a `final` class as `abstract`",
        abstract_span,
    )
    .highlight(final_span.position, "final".len())
    .error(
        "try removing this",
        abstract_span.position,
        "abstract".len(),
    )
}

pub fn final_and_abstract_modifiers_combined_for_class_member(
    final_span: Span,
    abstract_span: Span,
) -> ParseError {
    ParseError::new(
        "E029",
        "cannot declare a `final` class member as `abstract`",
        abstract_span,
    )
    .highlight(final_span.position, "final".len())
    .error(
        "try removing this",
        abstract_span.position,
        "abstract".len(),
    )
}

pub fn final_and_private_modifiers_combined_for_constant(
    final_span: Span,
    private_span: Span,
) -> ParseError {
    ParseError::new(
        "E030",
        "cannot declare a `private` constant as `final`",
        final_span,
    )
    .highlight(private_span.position, "private".len())
    .error("try removing this", final_span.position, "final".len())
    .note("private constants cannot be final as they are not visible to other classes")
}

pub fn reached_unpredictable_state(span: Span) -> ParseError {
    ParseError::new("E031", "reached unpredictable state", span).error(
        "please report this as a bug",
        span.position,
        1,
    )
}

pub fn static_property_cannot_be_readonly(
    state: &mut State,
    class: Option<&SimpleIdentifier>,
    property: &SimpleVariable,
    static_span: Span,
    readonly_span: Span,
) -> ParseError {
    let error = ParseError::new(
        "E032",
        format!(
            "cannot declare `readonly` property `{}::{}` as 'static'",
            class
                .map(|c| state.named(c))
                .unwrap_or_else(|| "anonymous@class".to_string()),
            property.name,
        ),
        static_span,
    )
    .highlight(property.span.position, property.name.len())
    .highlight(readonly_span.position, "readonly".len())
    .error("try removing this", static_span.position, "static".len());

    // If the class is anonymous, we don't have a span to highlight
    if let Some(class) = class {
        error.highlight(class.span.position, class.value.len())
    } else {
        error
    }
}

pub fn readonly_property_has_default_value(
    state: &mut State,
    class: Option<&SimpleIdentifier>,
    property: &SimpleVariable,
    readonly_span: Span,
    equals_span: Span,
) -> ParseError {
    let error = ParseError::new(
        "E033",
        format!(
            "readonly property `{}::{}` cannot have a default value",
            class
                .map(|c| state.named(c))
                .unwrap_or_else(|| "anonymous@class".to_string()),
            property.name,
        ),
        equals_span,
    )
    .highlight(property.span.position, property.name.len())
    .highlight(readonly_span.position, "readonly".len())
    .error("try removing this `=`", equals_span.position, 1);

    // If the class is anonymous, we don't have a span to highlight
    if let Some(class) = class {
        error.highlight(class.span.position, class.value.len())
    } else {
        error
    }
}

pub fn unbraced_namespace_declarations_in_braced_context(span: Span) -> ParseError {
    ParseError::new(
        "E034",
        "cannot mix braced and unbraced namespace declarations",
        span,
    )
    .error("try replacing this `;` with `{`", span.position, 1)
}

pub fn braced_namespace_declarations_in_unbraced_context(span: Span) -> ParseError {
    ParseError::new(
        "E035",
        "cannot mix braced and unbraced namespace declarations",
        span,
    )
    .error("try replacing this `{` with `;`", span.position, 1)
}

pub fn nested_namespace_declarations(span: Span) -> ParseError {
    ParseError::new("E035", "cannot nest namespace declarations", span).error(
        "try closing previous namespace with `}` before declaring a new one",
        span.position,
        1,
    )
}

pub fn forbidden_type_used_in_property(
    state: &mut State,
    class: Option<&SimpleIdentifier>,
    property: &SimpleVariable,
    ty: Type,
) -> ParseError {
    let type_string = ty.to_string();
    let type_span = ty.first_span();

    let error = ParseError::new(
        "E037".to_string(),
        format!(
            "property `{}::{}` cannot have type `{}`",
            class
                .map(|c| state.named(c))
                .unwrap_or_else(|| "anonymous@class".to_string()),
            property.name,
            type_string
        ),
        type_span,
    )
    .highlight(property.span.position, property.name.len())
    .error(
        "try using a different type",
        type_span.position,
        type_string.len(),
    )
    .note("`void`, `never`, and `callable` types are not allowed in properties");

    // If the class is anonymous, we don't have a span to highlight
    if let Some(class) = class {
        error.highlight(class.span.position, class.value.len())
    } else {
        error
    }
}

pub fn match_expression_has_multiple_default_arms(first: Span, second: Span) -> ParseError {
    ParseError::new(
        "E038".to_string(),
        "match expression cannot have more than one default arm",
        second,
    )
    .highlight(first.position, "default".len())
    .error("try removing this arm", second.position, "default".len())
}

pub fn missing_item_definition_after_attributes(
    attributes: &Vec<AttributeGroup>,
    current: &Token,
) -> ParseError {
    let mut annotations = vec![];

    for attribute in attributes {
        annotations.push(ParseErrorAnnotation {
            r#type: ParseErrorAnnotationType::Hint,
            message: "".to_string(),
            position: attribute.start.position,
            length: attribute.end.position - attribute.start.position,
        });
    }

    annotations.push(match current.kind {
        TokenKind::Eof => ParseErrorAnnotation {
            r#type: ParseErrorAnnotationType::Error,
            message: "reached end of file before an item definition".to_string(),
            position: current.span.position,
            length: current.value.len(),
        },
        _ => ParseErrorAnnotation {
            r#type: ParseErrorAnnotationType::Error,
            message: format!("expected an item definition, found `{}`", current.value),
            position: current.span.position,
            length: current.value.len(),
        },
    });

    ParseError {
        id: "E039".to_string(),
        message: "missing item definition after attribute(s)".to_string(),
        span: current.span,
        annotations,
        note: None,
    }
}

pub fn nested_disjunctive_normal_form_types(span: Span) -> ParseError {
    ParseError::new(
        "E040".to_string(),
        "cannot nest disjunctive normal form types",
        span,
    )
    .error("try removing this", span.position, 1)
}

pub fn illegal_spread_operator_usage(span: Span) -> ParseError {
    ParseError::new("E041".to_string(), "illegal spread operator usage", span).error(
        "try removing this",
        span.position,
        3,
    )
}

pub fn cannot_assign_reference_to_non_referencable_value(span: Span) -> ParseError {
    ParseError::new(
        "E042".to_string(),
        "cannot assign reference to non-referencable value",
        span,
    )
    .error("try removing this", span.position, 1)
}

pub fn mixing_keyed_and_unkeyed_list_entries(span: Span) -> ParseError {
    ParseError::new(
        "E043".to_string(),
        "cannot mix keyed and un-keyed list entries",
        span,
    )
    .error("", span.position, 1)
}

pub fn cannot_use_positional_argument_after_named_argument(
    span: Span,
    current_span: Span,
) -> ParseError {
    ParseError::new(
        "E044".to_string(),
        "cannot use positional argument after named argument",
        span,
    )
    .error(
        "try adding a name for this argument",
        span.position,
        current_span.position - span.position,
    )
}

pub fn cannot_use_reserved_keyword_as_a_type_name(span: Span, keyword: String) -> ParseError {
    ParseError::new(
        "E045".to_string(),
        format!("cannot use reserved keyword `{}` as a type name", keyword),
        span,
    )
    .error("try using a different name", span.position, keyword.len())
}

pub fn cannot_use_reserved_keyword_as_a_goto_label(span: Span, keyword: String) -> ParseError {
    ParseError::new(
        "E046".to_string(),
        format!("cannot use reserved keyword `{}` as a goto label", keyword),
        span,
    )
    .error("try using a different name", span.position, keyword.len())
}

pub fn cannot_use_reserved_keyword_as_a_constant_name(span: Span, keyword: String) -> ParseError {
    ParseError::new(
        "E047".to_string(),
        format!(
            "cannot use reserved keyword `{}` as a constant name",
            keyword
        ),
        span,
    )
    .error("try using a different name", span.position, keyword.len())
}

pub fn cannot_use_type_in_context(span: Span, ty: String) -> ParseError {
    ParseError::new(
        "E048".to_string(),
        format!("cannot use type `{}` in current context", ty),
        span,
    )
    .error("try using a different type", span.position, ty.len())
}

pub fn only_positional_arguments_are_accepted(span: Span, current_span: Span) -> ParseError {
    ParseError::new(
        "E049".to_string(),
        "cannot use named argument, only positional arguments are accepted",
        span,
    )
    .error(
        "try changing this to a positional argument",
        span.position,
        current_span.position - span.position,
    )
}

pub fn only_one_argument_is_accepted(span: Span, current_span: Span) -> ParseError {
    ParseError::new("E050".to_string(), "only one argument are accepted", span).error(
        "try removing this argument",
        span.position,
        current_span.position - span.position,
    )
}

pub fn argument_is_required(span: Span, current_span: Span) -> ParseError {
    ParseError::new("E051".to_string(), "argument is required", span).error(
        "try passing an argument",
        span.position,
        current_span.position - span.position,
    )
}

impl From<SyntaxError> for ParseError {
    fn from(e: SyntaxError) -> Self {
        Self {
            id: "E001".to_string(),
            message: format!("syntax error, {}", e),
            annotations: vec![],
            span: e.span(),
            note: None,
        }
    }
}

impl Display for ParseError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        write!(
            f,
            "[{}] Error: {} on line {} column {}",
            self.id, self.message, self.span.line, self.span.column
        )?;

        if let Some(note) = &self.note {
            write!(f, ", Note: {}", note)?;
        }

        Ok(())
    }
}

impl Display for ParseErrorStack {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        for error in &self.errors {
            writeln!(f, "{}", error)?;
        }

        Ok(())
    }
}