moonrockz/gleam-parser/cst

README
U
Arg
U
ArgNames
U
Assert
U
AssignName
U
Assignment
U
AssignmentKind
U
BinOp
U
BindingError
U
BitArrayOption
U
BitArraySegment
U
BitArraySize
U
BitArrayUnit
U
Budget
U
ByteLength
U
ByteOffset
U
CallArg
U
ChildIndex
U
Clause
U
ClauseGuard
U
ColumnNumber
U
Comment
U
CommentError
U
CommentKind
U
Config
U
ConfigError
U
Constant
U
Control
U
CoordinateError
U
CustomType
U
DecodeError
U
Definition
U
DefinitionCst
U
DefinitionKind
U
Deprecation
U
Diagnostic
U
Dialect
U
Documentation
U
EnterEvent
U
Environment
U
Event
U
EventReader
U
EventSource
U
ExportError
U
Expr
U
Extended
U
ExtendedError
U
External
U
ExternalBinding
U
ExternalBindings
U
FormatError
U
Fuel
U
FuelExhausted
U
Function
U
FunctionLiteralKind
U
Handler
U
ImplicitCallArgOrigin
U
Import
U
ImportAlias
U
IncorrectNamePosition
U
IntOperator
U
InvalidBitArrayUnit
U
InvalidBudget
U
Keyword
U
Label
U
LeaveEvent
U
LexicalErrorType
U
LineCount
U
LineNumber
U
Module
U
ModuleConstant
U
ModuleCst
U
ModuleExtra
U
NestingLimit
U
NodeDepth
U
NodePath
U
NodeRef
U
Operation
U
OracleOutput
U
ParseError
U
ParseErrorDetails
U
ParseErrorType
U
ParseResult
U
Parsed
U
Partial
U
PathStep
U
Pattern
U
Position
U
Profile
U
ProfileError
U
Profiles
U
Publicity
U
RecordBeingUpdated
U
RecordConstructor
U
RecordConstructorArg
U
RecordUpdateArg
U
RegistrationError
U
Rule
U
Severity
U
Source
U
SourceText
U
SpannedString
U
Spent
U
SrcSpan
U
Statement
U
StringPrefixLeftSideAssignment
U
TailPattern
U
Target
U
TargetName
U
TargetRegistry
U
TargetedDefinition
U
TodoKind
U
Token
U
TokenKind
U
TokenStream
U
TraversalValueError
U
Tree
U
TreeCursor
U
Trivia
U
TupleIndex
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
Utf16Offset
U
Visitor
U
Warning
V
accept
V
canonical
V
decode_expr
V
decode_extended
V
decode_oracle_output
V
decode_parsed
V
default_budget
V
diagnostic_description
V
encode_diagnostics
V
encode_expr
V
encode_extended
V
encode_oracle_output
V
encode_parsed
V
fold
V
format
V
format_parsed
V
kind_table
V
parse_float_value
V
parse_int_value
V
parse_module
V
parse_text
V
push_events
V
reduce
V
reduce_with_fields
V
render_plain
V
render_terminal
V
tokenize
V
tokenize_text
V
version
V
walk

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

DefinitionCst

pub(all) struct DefinitionCst {
  kind : DefinitionKind
  name : String?
  tokens : ArrayView[@moonrockz/gleam-parser/scanner.Token
Token]
  span : @moonrockz/gleam-parser/span.SrcSpan
SrcSpan
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The tokens of one definition, with their trivia. name is the module path of an import, the name of a constant, function or type, or None for a skipped run or an anonymous head. span runs from the first token's start to the last token's end (trivia not included); 0..0 when there is no token.

DefinitionCst::DefinitionCst

source

#alias(new, deprecated="Use `DefinitionCst(...)` instead")
fn DefinitionCst::DefinitionCst(kind~ : DefinitionKind, name~ : String?, tokens~ : ArrayView[@moonrockz/gleam-parser/scanner.Token
Token]) -> DefinitionCst

Group a definition's tokens and derive its span, or 0..0 when empty.

DefinitionCst::to_source

source

fn DefinitionCst::to_source(self : DefinitionCst) -> String

The text of the definition's tokens with their trivia.

DefinitionKind

source

pub(all) enum DefinitionKind {
  Import
  Constant
  Function
  CustomType
  TypeAlias
  Skipped
} derive(Eq, Hash, @moonbitlang/core/debug.Debug
Debug)

What a definition's tokens parsed as. Skipped is a run of tokens the parser reported and skipped (recovery per definition).

ModuleCst

source

pub(all) struct ModuleCst {
  tokens : ArrayView[@moonrockz/gleam-parser/scanner.Token
Token]
  trivia : ArrayView[@moonrockz/gleam-parser/scanner.Trivia
Trivia]
  definitions : ArrayView[DefinitionCst]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Every token of a module, grouped per definition. definitions tile tokens in order; trivia is the stream's trivia for a text with no token.

test {
  let stream = @scanner.tokenize_text("const x = 1\n")
  let d = @cst.DefinitionCst(
    kind=Constant,
    name=Some("x"),
    tokens=stream.tokens,
  )
  let cst = @cst.ModuleCst(stream, [d])
  inspect(cst.to_source(), content="const x = 1\n")
}

ModuleCst::ModuleCst

source

#alias(new, deprecated="Use `ModuleCst(...)` instead")
fn ModuleCst::ModuleCst(stream : @moonrockz/gleam-parser/scanner.TokenStream
TokenStream, definitions : Array[DefinitionCst]) -> ModuleCst

Group a token stream with its parsed definitions and trivia.

ModuleCst::to_source

source

fn ModuleCst::to_source(self : ModuleCst) -> String

The scanned text, byte for byte.

trivia_extra

source

fn trivia_extra(stream : @moonrockz/gleam-parser/scanner.TokenStream
TokenStream) -> @moonrockz/gleam-parser/ast.ModuleExtra
ModuleExtra

The ModuleExtra positions that come from trivia, as the compiler's Parser::next_token gathers them: the content span of every comment by kind; the start of every line end (\r for \r\n); and an empty line, recorded as the previous line end's start plus one, for every line end that follows another line end in the same gap between two tokens with no comment between them (whitespace does not break the pair). The trailing commas come from the parser; here the list is empty.