moonrockz/gleam-parser/parser

README
U
Arg
U
ArgNames
U
Assert
U
AssignName
U
Assignment
U
AssignmentKind
U
BinOp
U
BitArrayOption
U
BitArraySegment
U
BitArraySize
U
CallArg
U
Clause
U
ClauseGuard
U
Comment
U
CommentKind
U
Constant
U
CustomType
U
DecodeError
U
Definition
U
DefinitionCst
U
DefinitionKind
U
Deprecation
U
Diagnostic
U
Dialect
U
Documentation
U
Expr
U
External
U
Function
U
FunctionLiteralKind
U
ImplicitCallArgOrigin
U
Import
U
ImportAlias
U
IncorrectNamePosition
U
IntOperator
U
Keyword
U
Label
U
LexicalErrorType
U
Module
U
ModuleConstant
U
ModuleCst
U
ModuleExtra
U
OracleOutput
U
ParseError
U
ParseErrorDetails
U
ParseErrorType
U
ParseResult
U
Parsed
U
Pattern
U
Position
U
Publicity
U
RecordBeingUpdated
U
RecordConstructor
U
RecordConstructorArg
U
RecordUpdateArg
U
Rule
U
Severity
U
SourceText
U
SpannedString
U
SrcSpan
U
Statement
U
StringPrefixLeftSideAssignment
U
TailPattern
U
Target
U
TargetedDefinition
U
TodoKind
U
Token
U
TokenKind
U
TokenStream
U
Trivia
U
TypeAlias
U
TypeAst
U
TypeAstConstructor
U
TypeAstConstructorName
U
TypeAstFn
U
TypeAstHole
U
TypeAstTuple
U
TypeAstVar
U
UnicodeEscapeError
U
UnqualifiedImport
U
Use
U
UseAssignment
U
Warning
V
canonical
V
decode_expr
V
decode_oracle_output
V
decode_parsed
V
diagnostic_description
V
encode_diagnostics
V
encode_expr
V
encode_oracle_output
V
encode_parsed
V
parse_float_value
V
parse_int_value
V
parse_module
V
parse_text
V
render_plain
V
render_terminal
V
tokenize
V
tokenize_text
V
version

moonrockz/gleam-parser/parser does not have a README file

ParseError

pub(all) suberror ParseError {
  ParseError(error~ : ParseErrorType, location~ : @moonrockz/gleam-parser/span.SrcSpan
SrcSpan)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A syntax error: the compiler's error and its span.

ParseError::to_diagnostic

source

fn ParseError::to_diagnostic(self : ParseError) -> @moonrockz/gleam-parser/diagnostic.Diagnostic
Diagnostic

The diagnostic for a parse error: GL-PARSE-001 with the compiler's title "Syntax error" and wording; GL-PARSE-004 for TooMuchNesting; the scanner's own diagnostic for LexError. UnexpectedEof keeps the compiler's raw span 0..0; the renderer moves it to the last byte as error.rs does.

IncorrectNamePosition

source

pub(all) enum IncorrectNamePosition {
  AsPattern
  Module
  Function
  Attribute
  Constant
  Target
  Variable
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Where an incorrect name was found (the compiler's IncorrectNamePosition).

ParseErrorDetails

source

pub(all) struct ParseErrorDetails {
  text : String
  label_text : String
  extra_labels : ArrayView[@moonrockz/gleam-parser/diagnostic.Label
Label]
  hint : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The compiler's ParseErrorDetails: the body text, the primary label text, the extra labels and the hint.

ParseErrorType

source

pub(all) enum ParseErrorType {
  ExpectedEqual
  ExpectedExpr
  ExpectedName
  ExpectedPattern
  ExpectedType
  ExpectedUpName
  ExpectedValue
  ExpectedDefinition
  ExpectedDeprecationMessage
  ExpectedExternalArguments
  ExpectedFunctionDefinition
  ExpectedTargetName
  ExprLparStart
  ExtraSeparator
  IncorrectName(IncorrectNamePosition)
  IncorrectUpName
  InvalidBitArraySegment
  InvalidBitArrayUnit
  InvalidTailPattern
  InvalidTupleAccess
  LexError(@moonrockz/gleam-parser/diagnostic.Diagnostic
Diagnostic)
  NestedBitArrayPattern
  NoLetBinding
  NoValueAfterEqual
  NotConstType
  OpNakedRight
  OpaqueTypeAlias
  TooManyArgHoles
  DuplicateAttribute
  UnknownAttribute
  UnknownTarget
  ListSpreadWithoutElements
  ListSpreadFollowedByElements
  ListSpreadWithAnotherSpread(first_spread_location~ : @moonrockz/gleam-parser/span.SrcSpan
SrcSpan)
  UnexpectedLabel
  UnexpectedEof
  UnexpectedReservedWord
  UnexpectedToken(token~ : @moonrockz/gleam-parser/scanner.TokenKind
TokenKind, expected~ : ArrayView[String], hint~ : String?)
  UnexpectedFunction
  ConcatPatternVariableLeftHandSide
  ConcatPatternVariableWithSuffix(name~ : String)
  ListSpreadWithoutTail
  ExpectedFunctionBody
  RedundantInternalAttribute
  InvalidModuleTypePattern
  ListPatternSpreadFollowedByElements
  ExpectedRecordConstructor(type_name~ : String, public~ : Bool, opaque_~ : Bool, fields~ : ArrayView[@moonrockz/gleam-parser/ast.RecordConstructorArg
RecordConstructorArg])
  CallInClauseGuard
  IfExpression
  TypeDefinitionNoArguments
  UnknownAttributeRecordVariant
  IncorrectImportModuleSeparator(module_~ : String, item~ : String)
  EmptyGuardBlock
  ConstantInsideFunction
  FunctionDefinitionAngleGenerics
  TypeUsageAngleGenerics(module_~ : String?, name~ : String, arguments~ : ArrayView[@moonrockz/gleam-parser/ast.TypeAst
TypeAst])
  TypeDefinitionAngleGenerics(name~ : String, arguments~ : ArrayView[String])
  MissingConstantAsMessage
  RecordUpdateAfterFields
  TooMuchNesting
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The compiler's ParseErrorType, one variant each, plus TooMuchNesting (gleam-parser's own limit). LexError carries the scanner's diagnostic for a lexical error met by a snippet parser.

ParseErrorType::details

source

fn ParseErrorType::details(self : ParseErrorType) -> ParseErrorDetails

The compiler's ParseErrorType::details(): body text, primary label, extra labels and hint, with its exact wording and wrap at 75 bytes.

ParseErrorType::kind

source

fn ParseErrorType::kind(self : ParseErrorType) -> String

The variant name (UnexpectedToken, …), as the oracle writes it.

ParseResult

source

pub(all) struct ParseResult {
  module_ : @moonrockz/gleam-parser/ast.Module
Module
  extra : @moonrockz/gleam-parser/ast.ModuleExtra
ModuleExtra
  warnings : ArrayView[@moonrockz/gleam-parser/ast.Warning
Warning]
  cst : @moonrockz/gleam-parser/cst.ModuleCst
ModuleCst
  diagnostics : ArrayView[@moonrockz/gleam-parser/diagnostic.Diagnostic
Diagnostic]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

What parse_module returns: the AST (module_), the compiler's extra, the warnings, the CST (every token, grouped per definition, also the skipped ones) and the diagnostics. A definition with a syntax error is not in module_; its tokens are a Skipped run in cst.

test {
  let r = @parser.parse_text("pub fn main() {\n  1\n}\n")
  inspect(r.module_.definitions.length(), content="1")
  inspect(r.has_errors(), content="false")
  inspect(r.cst.to_source(), content="pub fn main() {\n  1\n}\n")
}

ParseResult::has_errors

source

fn ParseResult::has_errors(self : ParseResult) -> Bool

Whether any diagnostic is an error.

ParseResult::parsed

source

fn ParseResult::parsed(self : ParseResult) -> @moonrockz/gleam-parser/ast.Parsed
Parsed

The oracle's Parsed shape: module, extra and warnings.

definition_root_depth

source

let definition_root_depth : Int

The JSON path depth of $.module.definitions[i].definition: the steps the decoder counts before a definition's own fields.

json_depth

source

fn json_depth(d : @moonrockz/gleam-parser/ast.Definition
Definition) -> Int

The depth of the deepest JSON path inside a definition's canonical JSON, counted as the decoder counts (@ast.max_depth): steps from the definition object to its deepest scalar. Measured with an explicit stack, so a definition of any depth is safe to measure.

test {
  let r = @parser.parse_text("const x = 1\n")
  // $.location.start, $.name_location.start, $.value.location.start: 3
  inspect(@parser.json_depth(r.module_.definitions[0].definition), content="3")
}

max_nesting

source

let max_nesting : Int

Deepest syntactic nesting the parser enters (brackets, blocks, case, fn, nested patterns, types and constants). Deeper text is a GL-PARSE-004 error (TooMuchNesting), never a stack overflow, on every target: wasm overflows at about 140 nested lists, so the limit is 100. The JSON depth limit (@ast.max_depth) rejects most constructs before this one. The Gleam compiler has no such limit.

parse_constant_text

source

fn parse_constant_text(text : String) -> @moonrockz/gleam-parser/ast.Constant
Constant raise ParseError

Parse text as one constant value (the compiler's parse_const_value test interface; a missing value is ExpectedExpr at 0..0).

parse_expression_text

source

fn parse_expression_text(text : String) -> @moonrockz/gleam-parser/ast.Expr
Expr raise ParseError

Parse text as one expression (a pipeline or an operator chain counts as one); a missing expression is ExpectedExpr at 0..0.

test {
  let e = @parser.parse_expression_text("1 + 2")
  debug_inspect(e.location(), content="{ start: 0, end: 5 }")
}

parse_module

source

fn parse_module(stream : @moonrockz/gleam-parser/scanner.TokenStream
TokenStream, dialect? : @moonrockz/gleam-parser/dialect.Dialect
Dialect) -> ParseResult

Parse a token stream into a module. Recovery per definition: an error is reported, the parser skips to the next definition start (import, const, pub, fn, type, opaque or @ in column 1) and goes on. The first error diagnostic has the compiler's kind and span.

parse_pattern_text

source

fn parse_pattern_text(text : String) -> @moonrockz/gleam-parser/ast.Pattern
Pattern raise ParseError

Parse text as one pattern.

parse_statements_text

source

fn parse_statements_text(text : String) -> ArrayView[@moonrockz/gleam-parser/ast.Statement
Statement] raise ParseError

Parse text as a statement sequence (a function body without braces), the compiler's parse_statement_sequence test interface.

parse_text

source

fn parse_text(text : String, dialect? : @moonrockz/gleam-parser/dialect.Dialect
Dialect) -> ParseResult

parse_module of the tokens of text.

parse_type_text

source

fn parse_type_text(text : String) -> @moonrockz/gleam-parser/ast.TypeAst
TypeAst raise ParseError

Parse text as one type annotation (without :), for tests and tools.

test {
  let t = @parser.parse_type_text("List(a)")
  debug_inspect(t.location(), content="{ start: 0, end: 7 }")
}

token_text

source

fn token_text(kind : @moonrockz/gleam-parser/scanner.TokenKind
TokenKind) -> String

The compiler's Display for a token: its text in backquotes. A name, number or string shows its own text.

type_ast_text

source

fn type_ast_text(t : @moonrockz/gleam-parser/ast.TypeAst
TypeAst) -> String

The source form of a type annotation (TypeAst::print), for messages.

warning_diagnostic

source

fn warning_diagnostic(w : @moonrockz/gleam-parser/ast.Warning
Warning) -> @moonrockz/gleam-parser/diagnostic.Diagnostic
Diagnostic

The diagnostic for a parser warning, with the compiler's title, text and label (warning.rs): GL-PARSE-002 for deprecated syntax, GL-PARSE-003 for a detached doc comment.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#ParseError

#ParseError::to_diagnostic

#IncorrectNamePosition

#ParseErrorDetails

#ParseErrorType

#ParseErrorType::details

#ParseErrorType::kind

#ParseResult

#ParseResult::has_errors

#ParseResult::parsed

#definition_root_depth

#json_depth

#max_nesting

#parse_constant_text

#parse_expression_text

#parse_module

#parse_pattern_text

#parse_statements_text

#parse_text

#parse_type_text

#token_text

#type_ast_text

#warning_diagnostic

Source Files

ParseError

ParseError::to_diagnostic

IncorrectNamePosition

ParseErrorDetails

ParseErrorType

ParseErrorType::details

ParseErrorType::kind

ParseResult

ParseResult::has_errors

ParseResult::parsed

definition_root_depth

json_depth

max_nesting

parse_constant_text

parse_expression_text

parse_module

parse_pattern_text

parse_statements_text

parse_text

parse_type_text

token_text

type_ast_text

warning_diagnostic