Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: slightly improve "unexpected token" error message #6279

Merged
merged 1 commit into from
Oct 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions compiler/noirc_frontend/src/parser/errors.rs
Original file line number Diff line number Diff line change
Expand Up @@ -174,12 +174,17 @@ impl ParserError {

impl std::fmt::Display for ParserError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let token_to_string = |token: &Token| match token {
Token::EOF => token.to_string(),
_ => format!("'{}'", token),
};

let reason_str: String = if self.reason.is_none() {
"".to_string()
} else {
format!("\nreason: {}", Diagnostic::from(self))
};
let mut expected = vecmap(&self.expected_tokens, ToString::to_string);
let mut expected = vecmap(&self.expected_tokens, token_to_string);
expected.append(&mut vecmap(&self.expected_labels, |label| format!("{label}")));

if expected.is_empty() {
Expand All @@ -192,7 +197,7 @@ impl std::fmt::Display for ParserError {
"Expected a{} {} but found {}{}",
if vowel { "n" } else { "" },
first,
self.found,
token_to_string(&self.found),
reason_str
)
} else {
Expand Down
2 changes: 2 additions & 0 deletions compiler/noirc_frontend/src/parser/labels.rs
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ pub enum ParsingRuleLabel {
Cast,
Expression,
FieldAccess,
Function,
GenericParameter,
Global,
Identifier,
Expand Down Expand Up @@ -41,6 +42,7 @@ impl fmt::Display for ParsingRuleLabel {
ParsingRuleLabel::Cast => write!(f, "cast"),
ParsingRuleLabel::Expression => write!(f, "expression"),
ParsingRuleLabel::FieldAccess => write!(f, "field access"),
ParsingRuleLabel::Function => write!(f, "function"),
ParsingRuleLabel::GenericParameter => write!(f, "generic parameter"),
ParsingRuleLabel::Global => write!(f, "global"),
ParsingRuleLabel::Identifier => write!(f, "identifier"),
Expand Down
2 changes: 1 addition & 1 deletion compiler/noirc_frontend/src/parser/parser/expression.rs
Original file line number Diff line number Diff line change
Expand Up @@ -565,7 +565,7 @@
/// = bool
/// | int
/// | str
/// | rawstr

Check warning on line 568 in compiler/noirc_frontend/src/parser/parser/expression.rs

View workflow job for this annotation

GitHub Actions / Code

Unknown word (rawstr)
/// | fmtstr
/// | QuoteExpression
/// | ArrayExpression
Expand Down Expand Up @@ -1354,7 +1354,7 @@
let expr = parser.parse_expression_or_error();

let error = get_single_error(&parser.errors, span);
assert_eq!(error.to_string(), "Expected a : but found =");
assert_eq!(error.to_string(), "Expected a ':' but found '='");

let ExpressionKind::Constructor(mut constructor) = expr.kind else {
panic!("Expected constructor");
Expand Down
4 changes: 2 additions & 2 deletions compiler/noirc_frontend/src/parser/parser/function.rs
Original file line number Diff line number Diff line change
Expand Up @@ -442,7 +442,7 @@ mod tests {
assert_eq!(noir_function.parameters().len(), 1);

let error = get_single_error(&errors, span);
assert_eq!(error.to_string(), "Expected a pattern but found 1");
assert_eq!(error.to_string(), "Expected a pattern but found '1'");
}

#[test]
Expand Down Expand Up @@ -478,7 +478,7 @@ mod tests {
assert_eq!(noir_function.parameters().len(), 2);

let error = get_single_error(&errors, span);
assert_eq!(error.to_string(), "Expected a type but found ,");
assert_eq!(error.to_string(), "Expected a type but found ','");
}

#[test]
Expand Down
2 changes: 1 addition & 1 deletion compiler/noirc_frontend/src/parser/parser/global.rs
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,6 @@ mod tests {
let (src, span) = get_source_with_error_span(src);
let (_, errors) = parse_program(&src);
let error = get_single_error(&errors, span);
assert_eq!(error.to_string(), "Expected a ; but found end of input");
assert_eq!(error.to_string(), "Expected a ';' but found end of input");
}
}
51 changes: 24 additions & 27 deletions compiler/noirc_frontend/src/parser/parser/impls.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ use crate::{
UnresolvedGeneric, UnresolvedType, UnresolvedTypeData,
},
parser::{labels::ParsingRuleLabel, ParserErrorReason},
token::{Keyword, Token, TokenKind},
token::{Keyword, Token},
};

use super::{parse_many::without_separator, Parser};
Expand Down Expand Up @@ -79,31 +79,28 @@ impl<'a> Parser<'a> {
}

fn parse_type_impl_method(&mut self) -> Option<(Documented<NoirFunction>, Span)> {
self.parse_item_in_list(
ParsingRuleLabel::TokenKind(TokenKind::Token(Token::Keyword(Keyword::Fn))),
|parser| {
let doc_comments = parser.parse_outer_doc_comments();
let start_span = parser.current_token_span;
let attributes = parser.parse_attributes();
let modifiers = parser.parse_modifiers(
false, // allow mutable
);
self.parse_item_in_list(ParsingRuleLabel::Function, |parser| {
let doc_comments = parser.parse_outer_doc_comments();
let start_span = parser.current_token_span;
let attributes = parser.parse_attributes();
let modifiers = parser.parse_modifiers(
false, // allow mutable
);

if parser.eat_keyword(Keyword::Fn) {
let method = parser.parse_function(
attributes,
modifiers.visibility,
modifiers.comptime.is_some(),
modifiers.unconstrained.is_some(),
true, // allow_self
);
Some((Documented::new(method, doc_comments), parser.span_since(start_span)))
} else {
parser.modifiers_not_followed_by_an_item(modifiers);
None
}
},
)
if parser.eat_keyword(Keyword::Fn) {
let method = parser.parse_function(
attributes,
modifiers.visibility,
modifiers.comptime.is_some(),
modifiers.unconstrained.is_some(),
true, // allow_self
);
Some((Documented::new(method, doc_comments), parser.span_since(start_span)))
} else {
parser.modifiers_not_followed_by_an_item(modifiers);
None
}
})
}

/// TraitImpl = 'impl' Generics Path GenericTypeArgs 'for' Type TraitImplBody
Expand Down Expand Up @@ -542,7 +539,7 @@ mod tests {
assert_eq!(type_impl.methods.len(), 1);

let error = get_single_error(&errors, span);
assert_eq!(error.to_string(), "Expected a fn but found hello");
assert_eq!(error.to_string(), "Expected a function but found 'hello'");
}

#[test]
Expand All @@ -562,6 +559,6 @@ mod tests {
assert_eq!(trait_imp.items.len(), 1);

let error = get_single_error(&errors, span);
assert_eq!(error.to_string(), "Expected a trait impl item but found hello");
assert_eq!(error.to_string(), "Expected a trait impl item but found 'hello'");
}
}
4 changes: 2 additions & 2 deletions compiler/noirc_frontend/src/parser/parser/item.rs
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,7 @@ mod tests {
let (module, errors) = parse_program(&src);
assert_eq!(module.items.len(), 2);
let error = get_single_error(&errors, span);
assert_eq!(error.to_string(), "Expected an item but found hello");
assert_eq!(error.to_string(), "Expected an item but found 'hello'");
}

#[test]
Expand All @@ -237,6 +237,6 @@ mod tests {
let (module, errors) = parse_program(&src);
assert_eq!(module.items.len(), 1);
let error = get_single_error(&errors, span);
assert_eq!(error.to_string(), "Expected a } but found end of input");
assert_eq!(error.to_string(), "Expected a '}' but found end of input");
}
}
6 changes: 3 additions & 3 deletions compiler/noirc_frontend/src/parser/parser/item_visibility.rs
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ mod tests {
let visibility = parser.parse_item_visibility();
assert_eq!(visibility, ItemVisibility::Public);
let error = get_single_error(&parser.errors, span);
assert_eq!(error.to_string(), "Expected a crate but found end of input");
assert_eq!(error.to_string(), "Expected a 'crate' but found end of input");
}

#[test]
Expand All @@ -87,7 +87,7 @@ mod tests {
let visibility = parser.parse_item_visibility();
assert_eq!(visibility, ItemVisibility::Public);
let error = get_single_error(&parser.errors, span);
assert_eq!(error.to_string(), "Expected a crate but found hello");
assert_eq!(error.to_string(), "Expected a 'crate' but found 'hello'");
}
#[test]
fn parses_public_visibility_missing_paren_after_pub_crate() {
Expand All @@ -100,7 +100,7 @@ mod tests {
let visibility = parser.parse_item_visibility();
assert_eq!(visibility, ItemVisibility::PublicCrate);
let error = get_single_error(&parser.errors, span);
assert_eq!(error.to_string(), "Expected a ) but found end of input");
assert_eq!(error.to_string(), "Expected a ')' but found end of input");
}

#[test]
Expand Down
2 changes: 1 addition & 1 deletion compiler/noirc_frontend/src/parser/parser/pattern.rs
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ mod tests {
let pattern = parser.parse_pattern_or_error();

let error = get_single_error(&parser.errors, span);
assert_eq!(error.to_string(), "Expected a : but found =");
assert_eq!(error.to_string(), "Expected a ':' but found '='");

let Pattern::Struct(path, mut patterns, _) = pattern else {
panic!("Expected a struct pattern")
Expand Down
2 changes: 1 addition & 1 deletion compiler/noirc_frontend/src/parser/parser/statement.rs
Original file line number Diff line number Diff line change
Expand Up @@ -702,7 +702,7 @@ mod tests {
let statement = parser.parse_statement_or_error();
assert!(matches!(statement.kind, StatementKind::Let(..)));
let error = get_single_error(&parser.errors, span);
assert_eq!(error.to_string(), "Expected a statement but found ]");
assert_eq!(error.to_string(), "Expected a statement but found ']'");
}

#[test]
Expand Down
2 changes: 1 addition & 1 deletion compiler/noirc_frontend/src/parser/parser/structs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,6 @@ mod tests {
assert_eq!(noir_struct.fields.len(), 1);

let error = get_single_error(&errors, span);
assert_eq!(error.to_string(), "Expected an identifier but found 42");
assert_eq!(error.to_string(), "Expected an identifier but found '42'");
}
}
2 changes: 1 addition & 1 deletion compiler/noirc_frontend/src/parser/parser/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -495,10 +495,10 @@
for quoted_type in QuotedType::iter() {
let src = quoted_type.to_string();
let typ = parse_type_no_errors(&src);
let UnresolvedTypeData::Quoted(parsed_qouted_type) = typ.typ else {

Check warning on line 498 in compiler/noirc_frontend/src/parser/parser/types.rs

View workflow job for this annotation

GitHub Actions / Code

Unknown word (qouted)
panic!("Expected a quoted type for {}", quoted_type)
};
assert_eq!(parsed_qouted_type, quoted_type);

Check warning on line 501 in compiler/noirc_frontend/src/parser/parser/types.rs

View workflow job for this annotation

GitHub Actions / Code

Unknown word (qouted)
}
}

Expand Down Expand Up @@ -588,7 +588,7 @@
let mut parser = Parser::for_str(&src);
parser.parse_type();
let error = get_single_error(&parser.errors, span);
assert_eq!(error.to_string(), "Expected a ] but found end of input");
assert_eq!(error.to_string(), "Expected a ']' but found end of input");
}

#[test]
Expand Down
Loading