use std::fmt::{Debug, Display};
create_messages!(
ParserError,
code_mask: 0000i32,
code_prefix: "PAR",
@formatted
unexpected_token {
args: (message: impl Display),
msg: message,
help: None,
}
@formatted
invalid_address_lit {
args: (token: impl Display),
msg: format!("invalid address literal: '{token}'"),
help: None,
}
/// For when the parser encountered an empty import list.
@formatted
invalid_import_list {
args: (),
msg: "Cannot import empty list",
help: None,
}
/// For when the parser encountered an unexpected End of File.
@formatted
unexpected_eof {
args: (),
msg: "unexpected EOF",
help: None,
}
/// For when the parser encountered an unexpected whitespace.
// TODO This error is unused. Remove it in a future version.
@formatted
unexpected_whitespace {
args: (left: impl Display, right: impl Display),
msg: format!("Unexpected white space between terms {left} and {right}"),
help: None,
}
/// For when the parser encountered an unexpected list of tokens.
@formatted
unexpected {
args: (found: impl Display, expected: impl Display),
msg: format!("expected {expected} -- found '{found}'"),
help: None,
}
/// For when the parser encountered a mix of commas and semi-colons in struct member variables.
// TODO This error is unused. Remove it in a future version.
@formatted
mixed_commas_and_semicolons {
args: (),
msg: "Cannot mix use of commas and semi-colons for struct member variable declarations.",
help: None,
}
@formatted
unexpected_ident {
args: (found: impl Display, expected: &[impl Display]),
msg: format!(
"unexpected identifier: expected {} -- found '{found}'",
expected
.iter()
.map(|x| format!("'{x}'"))
.collect::<Vec<_>>()
.join(", "),
),
help: None,
}
@formatted
unexpected_statement {
args: (found: impl Display, expected: impl Display),
msg: format!("unexpected statement: expected '{expected}', found '{found}'"),
help: None,
}
/// For when the parser encountered an unexpected string.
// TODO This error is unused. Remove it in a future version.
@formatted
unexpected_str {
args: (found: impl Display, expected: impl Display),
msg: format!("unexpected string: expected '{expected}', found '{found}'"),
help: None,
}
/// For when the parser encountered an unexpected spread in an array init expression.
@formatted
spread_in_array_init {
args: (),
msg: "illegal spread in array initializer",
help: None,
}
/// When more input was expected but not found.
// TODO This error is unused. Remove it in a future version.
@backtraced
lexer_empty_input {
args: (),
msg: "Expected more characters to lex but found none.",
help: None,
}
/// When an integer is started with a leading zero.
// TODO This error is unused. Remove it in a future version.
@backtraced
lexer_expected_valid_escaped_char {
args: (input: impl Display),
msg: format!("Expected a valid escape character but found `{input}`."),
help: None,
}
/// When a string is not properly closed.
// TODO This error is unused. Remove it in a future version.
@backtraced
lexer_string_not_closed {
args: (input: impl Display),
msg: format!("Expected a closed string but found `{input}`."),
help: None,
}
/// When a block comment is empty.
// TODO This error is unused. Remove it in a future version.
@backtraced
lexer_empty_block_comment {
args: (),
msg: "Empty block comment.",
help: None,
}
/// When a block comment is not closed before end of file.
// TODO This error is unused. Remove it in a future version.
@backtraced
lexer_block_comment_does_not_close_before_eof {
args: (input: impl Display),
msg: format!("Block comment does not close with content: `{input}`."),
help: None,
}
/// When the lexer could not lex some text.
@backtraced
could_not_lex {
args: (input: impl Display),
msg: format!("Could not lex the following content: `{input}`.\n"),
help: None,
}
/// When the user tries to pass an implicit value.
// TODO This error is unused. Remove it in a future version.
@formatted
implicit_values_not_allowed {
args: (input: impl Display),
msg: format!("Could not parse the implicit value: {input}."),
help: None,
}
/// When a hex number is provided.
// TODO This error is unused. Remove it in a future version.
@backtraced
lexer_hex_number_provided {
args: (input: impl Display),
msg: format!("A hex number `{input}..` was provided but hex is not allowed."),
help: None,
}
/// For when a user specified more than one mode on a parameter.
// TODO This error is unused. Remove it in a future version.
@formatted
inputs_multiple_variable_modes_specified {
args: (),
msg: "A parameter cannot have multiple modes.",
help: Some("Consider using either `constant`, `public`, `private`, or none at all.".to_string()),
}
/// For when the lexer encountered a bidi override character
@backtraced
lexer_bidi_override {
args: (),
msg: "Unicode bidi override code point encountered.",
help: None,
}
/// Parsed an unknown method call on the type of an expression.
@formatted
invalid_method_call {
args: (expr: impl Display, func: impl Display, num_args: impl Display),
msg: format!("The type of `{expr}` has no associated function `{func}` that takes {num_args} argument(s)."),
help: None,
}
// TODO This error is unused. Remove it in a future version.
@formatted
invalid_associated_access {
args: (name: impl Display),
msg: format!("Invalid associated access call to struct {name}."),
help: Some("Double colon `::` syntax is only supported for core functions in Leo for mainnet.".to_string()),
}
@formatted
leo_and_aleo_imports_only {
args: (),
msg: "Invalid import call to non-leo non-aleo file.",
help: Some("Only imports of Leo `.leo` and Aleo `.aleo` files are currently supported.".to_string()),
}
@formatted
space_in_annotation {
args: (),
msg: "Illegal spacing in the annotation declaration.",
help: Some("Remove whitespace between the `@` symbol and the identifier.".to_string()),
}
@formatted
circuit_is_deprecated {
args: (),
msg: "The keyword `circuit` is deprecated.",
help: Some("Use `struct` instead.".to_string()),
}
@formatted
only_one_program_scope_is_allowed {
args: (),
msg: "Only one program scope is allowed in a Leo file.",
help: None,
}
@formatted
missing_program_scope {
args: (),
msg: "Missing a program scope in a Leo file.",
help: Some("Add a program scope of the form: `program <name>.aleo { ... }` to the Leo file.".to_string()),
}
@formatted
invalid_network {
args: (),
msg: "Invalid network identifier. The only supported identifier is `.aleo`.",
help: None,
}
@formatted
tuple_must_have_at_least_two_elements {
args: (kind: impl Display),
msg: format!("A tuple {kind} must have at least two elements."),
help: None,
}
// TODO This error is unused. Remove it in a future version.
@formatted
async_finalize_is_deprecated {
args: (),
msg: format!("`async finalize` is deprecated."),
help: Some("Use `return <expr> then finalize(<args>)` instead.".to_string()),
}
// TODO This error is unused. Remove it in a future version.
@formatted
finalize_statements_are_deprecated {
args: (),
msg: format!("`finalize` statements are deprecated."),
help: Some("Use `return <expr> then finalize(<args>)` instead.".to_string()),
}
// TODO This error is unused. Remove it in a future version.
@formatted
console_statements_are_not_yet_supported {
args: (),
msg: format!("`console` statements are not yet supported."),
help: Some("Consider using `assert`, `assert_eq`, or `assert_neq` instead.".to_string()),
}
/// Enforce that tuple index must not have leading 0, or underscore in between digits
// TODO This error is unused. Remove it in a future version.
@formatted
tuple_index_must_be_whole_number {
args: (found: impl Display),
msg: format!("expected no underscores or leading zeros -- found '{found}'"),
help: None,
}
@formatted
array_must_have_at_least_one_element {
args: (kind: impl Display),
msg: format!("An array {kind} must have at least one element."),
help: None,
}
// TODO This error is unused. Remove it in a future version.
@formatted
invalid_external_type {
args: (),
msg: format!("Invalid external type."),
help: Some("External type should have the form `<program>.aleo::<record>`. For example `bank.aleo::loan`".to_string()),
}
// TODO This error is unused. Remove it in a future version.
@formatted
cannot_declare_external_struct {
args: (),
msg: format!("Cannot declare external struct."),
help: None,
}
// TODO This error is unused. Remove it in a future version.
@formatted
external_type_cannot_be_used_inside_function {
args: (program: impl Display, file_type: impl Display),
msg: format!("External types cannot be used inside function (only as input/output types) -- found exported type from '{program}.{file_type}'."),
help: None,
}
/// Enforce that cannot use import in program scope
// TODO This error is unused. Remove it in a future version.
@formatted
cannot_import_inside_program_body {
args: (),
msg: format!("Cannot use import inside program body."),
help: None,
}
// TODO This error is unused. Remove it in a future version.
@formatted
only_aleo_external_calls {
args: (),
msg: format!("Only external calls to `.aleo` programs are supported."),
help: None,
}
@formatted
cannot_define_external_record {
args: (),
msg: format!("Cannot create an external record. Records can only be created in the program that they are defined in."),
help: None,
}
/// For when the parser encountered a member declaration not followed by a comma.
// TODO This error is unused. Remove it in a future version.
@formatted
comma_expected_after_member {
args: (),
msg: "Each member declaration in a struct or record must be followed by a comma (except the last).",
help: None,
}
@formatted
hexbin_literal_nonintegers {
args: (),
msg: format!("Hex, octal, and binary literals may only be used for integer types."),
help: None,
}
@backtraced
wrong_digit_for_radix {
args: (digit: char, radix: u32, token: String),
msg: format!("Digit {digit} invalid in radix {radix} (token {token})."),
help: None,
}
@formatted
identifier_too_long {
args: (ident: impl Display, length: usize, max_length: usize),
msg: format!("Identifier {ident} is too long ({length} bytes; maximum is {max_length})"),
help: None,
}
// TODO This error is unused. Remove it in a future version.
@formatted
expected_identifier {
args: (),
msg: format!("Expected an identifier."),
help: None,
}
@formatted
identifier_cannot_contain_double_underscore {
args : (ident: impl Display),
msg: format!("Identifier {ident} cannot contain a double underscore `__`"),
help: None,
}
@formatted
custom {
args: (msg: impl Display),
msg: format!("{msg}"),
help: None,
}
// TODO This error is unused. Remove it in a future version.
@backtraced
conflicting_module_definitions {
args: (module_name: impl Display, file_a: impl Display, file_b: impl Display),
msg: format!(
"Module `{module_name}` is defined in both `{file_a}` and `{file_b}`"
),
help: Some({
let module_path_fs = format!("{module_name}").replace("::", "/");
format!(
"Use `{module_path_fs}.leo` for a simple module with no submodules, or place a `mod.leo` file in a `{module_path_fs}/` directory if it contains submodules — not both."
)
}),
}
@backtraced
keyword_used_as_module_name {
args: (module_name: impl Display, keyword: impl Display),
msg: format!(
"Module `{module_name}` uses the reserved keyword `{keyword}` as a name"
),
help: {
Some(format!(
"Rename the module so it does not conflict with the language keyword `{keyword}`."
))
},
}
@formatted
could_not_lex_span {
args: (input: impl Display),
msg: format!("Could not lex the following content: `{input}`.\n"),
help: None,
}
/// For when the lexer encountered a bidi override character
@formatted
lexer_bidi_override_span {
args: (),
msg: "Unicode bidi override code point encountered.",
help: None,
}
@formatted
wrong_digit_for_radix_span {
args: (digit: char, radix: u32, token: impl Display),
msg: format!("Digit {digit} invalid in radix {radix} (token {token})."),
help: None,
}
@formatted
identifier_cannot_start_with_underscore {
args: (),
msg: "Identifiers cannot start with an underscore.",
help: Some("Identifiers must start with a letter.".to_string()),
}
@formatted
missing_program_declaration {
args: (),
msg: "A Leo program must have exactly one `program` declaration.",
help: Some("Add a `program` block to define your program's entry point fns.".to_string()),
}
@formatted
multiple_program_declarations {
args: (),
msg: "A Leo program can only have one `program` declaration.",
help: Some("Remove the duplicate `program` block. Only one is allowed per program.".to_string()),
}
@formatted
const_must_be_outside_program_block {
args: (),
msg: "Constant declarations must be outside the `program` block.",
help: Some("Move this constant declaration to the top level, before the `program` block.".to_string()),
}
@formatted
composite_must_be_outside_program_block {
args: (type_name: impl Display),
msg: format!("{type_name} declarations must be outside the `program` block."),
help: Some("Move this type declaration to the top level, before the `program` block.".to_string()),
}
// Unused
@formatted
only_entry_point_fns_allowed_in_program_block {
args: (variant: impl Display),
msg: format!("Only entry point fns can be declared inside the `program` block, found `{variant}`."),
help: Some("Move regular fns outside the `program` block. Only entry point fns belong inside.".to_string()),
}
@formatted
entry_points_must_be_in_program_block {
args: (),
msg: "Entry point fns must be declared inside the `program` block.",
help: Some("Move this function into the `program` block to make it an entry point fn.".to_string()),
}
);