moonrockz/krueger/scanner

README
U
AttributeGroup
U
AttributeSyntax
U
AttributeTarget
U
Block
U
Case
U
CaseBlock
U
Cases
U
Chunk
U
Color
U
Comment
U
CommentKind
U
Control
U
Declaration
U
DeclarationCst
U
DecodeError
U
DefaultModuleData
U
Diagnostic
U
Dialect
U
DocAttribute
U
Documentation
U
EffectModuleData
U
EnterEvent
U
Event
U
EventReader
U
EventSource
U
ExposedType
U
Exposing
U
Expression
U
File
U
Function
U
FunctionCst
U
FunctionImplementation
U
Handler
U
Import
U
ImportCst
U
Infix
U
InfixDirection
U
KeywordKind
U
Lambda
U
LeaveEvent
U
LetBlock
U
LetDeclaration
U
Location
U
Module
U
ModuleCst
U
ModuleHeaderCst
U
ModuleName
U
Node
U
NodePath
U
NodeRef
U
OperatorDef
U
ParseResult
U
PathStep
U
Pattern
U
Position
U
QualifiedNameRef
U
Range
U
RecordDefinition
U
RecordField
U
RecordSetter
U
Rule
U
ScanErrorList
U
Scanner
U
Severity
U
Signature
U
SourceText
U
Span
U
Token
U
TokenKind
U
TokenStream
U
TopLevelExpose
U
Tree
U
TreeCursor
U
Trivia
U
Type
U
TypeAlias
U
TypeAliasCst
U
TypeAnnotation
U
UnionTypeCst
U
ValueConstructor
U
Visitor
V
accept
V
diagnostic_description
V
encode_attributes
V
encode_attributes_with
V
encode_diagnostics
V
fold
V
is_lower_start
V
is_name_part
V
is_upper_start
V
kind_table
V
parse_module
V
parse_tokens
V
push_events
V
render_elm_json
V
render_plain
V
render_terminal
V
standard_operators
V
tokenize
V
version
V
walk

moonrockz/krueger/scanner does not have a README file

Scanner

pub trait Scanner {
  fn tokenize(Self, SourceText) -> Result[TokenStream, ScanErrorList]
}

Block

source

pub(all) enum Block {
  Text(Array[Chunk])
  Excerpt(context~ : Span, highlight~ : Span)
  Hint(Array[Chunk])
  Note(Array[Chunk])
  Example(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One block of a report. Excerpt shows the source lines of context with markers under highlight; renderers read the lines from the source.

Chunk

source

pub(all) enum Chunk {
  Plain(String)
  Styled(text~ : String, color~ : Color?, bold~ : Bool, underline~ : Bool)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A piece of report text: plain, or styled like elm make styles code and keywords.

Chunk::code

source

fn Chunk::code(text : String) -> Chunk

Elm code inside a paragraph, in yellow as elm make shows it.

Chunk::keyword

source

fn Chunk::keyword(text : String) -> Chunk

An Elm keyword inside a paragraph, in bright cyan as elm make shows it.

Color

source

pub(all) enum Color {
  Red
  Yellow
  Green
  Cyan
  Magenta
  Blue
  Black
  White
  VividRed
  VividYellow
  VividGreen
  VividCyan
  VividMagenta
  VividBlue
  VividBlack
  VividWhite
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Colours of elm make reports. Vivid* are the bright variants; in the --report=json output they are upper case ("RED"), the others lower case.

Color::json_name

source

fn Color::json_name(self : Color) -> String

The colour name in elm make --report=json output.

Comment

source

pub(all) struct Comment {
  kind : CommentKind
  text : String
  span : Span
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

CommentKind

source

pub(all) enum CommentKind {
  Line
  Block
  Doc
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

DefaultScanner

source

pub struct DefaultScanner {
  dialect : @moonrockz/krueger/dialect.Dialect
Dialect
}

impl Scanner for DefaultScanner

DefaultScanner::new

source

fn DefaultScanner::new(dialect? : @moonrockz/krueger/dialect.Dialect
Dialect) -> DefaultScanner

A scanner for dialect (reserved words and operator symbols).

DefaultScanner::tokenize

source

fn DefaultScanner::tokenize(self : DefaultScanner, _source : SourceText) -> Result[TokenStream, ScanErrorList]

Diagnostic

source

pub(all) struct Diagnostic {
  code : String
  severity : Severity
  message : String
  span : Span
  title : String
  report : Array[Block]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

KeywordKind

source

pub(all) enum KeywordKind {
  Module
  Exposing
  Import
  As
  Type
  If
  Then
  Else
  Let
  In
  Case
  Of
  Port
  Where
  Custom(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Reserved words of Elm 0.19.1 as elm-syntax 7.3.9 treats them. alias, infix and effect are not reserved; they are identifiers.

Position

source

pub(all) struct Position {
  offset : Int
  line : Int
  column : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

RawToken

source

pub(all) struct RawToken {
  kind : RawTokenKind
  lexeme : String
  span : Span
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

RawTokenKind

source

pub(all) enum RawTokenKind {
  Significant(TokenKind)
  Whitespace
  Newline
  LineComment
  BlockComment
  DocComment
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A lexical unit before trivia is attached: a significant token or trivia.

ScanErrorList

source

pub(all) struct ScanErrorList {
  diagnostics : Array[Diagnostic]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Severity

source

pub(all) enum Severity {
  Error
  Warning
  Info
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

SourceText

source

pub(all) struct SourceText {
  module_name : String?
  text : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Span

source

pub(all) struct Span {
  start : Position
  end : Position
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Token

source

pub(all) struct Token {
  kind : TokenKind
  lexeme : String
  span : Span
  trivia_before : Array[Trivia]
  trivia_after : Array[Trivia]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

TokenKind

source

pub(all) enum TokenKind {
  Keyword(KeywordKind)
  Identifier
  IntLiteral
  FloatLiteral
  StringLiteral
  CharLiteral
  Glsl
  LParen
  RParen
  LBracket
  RBracket
  LBrace
  RBrace
  Comma
  Equals
  Dot
  DotDot
  Colon
  Pipe
  Arrow
  Backslash
  Underscore
  Operator(String)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

TokenKind::as_kw

source

fn TokenKind::as_kw() -> TokenKind

TokenKind::case_kw

source

fn TokenKind::case_kw() -> TokenKind

TokenKind::else_kw

source

fn TokenKind::else_kw() -> TokenKind

TokenKind::exposing_kw

source

fn TokenKind::exposing_kw() -> TokenKind

TokenKind::if_kw

source

fn TokenKind::if_kw() -> TokenKind

TokenKind::import_kw

source

fn TokenKind::import_kw() -> TokenKind

TokenKind::in_kw

source

fn TokenKind::in_kw() -> TokenKind

TokenKind::keyword

source

fn TokenKind::keyword(kind : KeywordKind) -> TokenKind

TokenKind::let_kw

source

fn TokenKind::let_kw() -> TokenKind

TokenKind::module_kw

source

fn TokenKind::module_kw() -> TokenKind

TokenKind::of_kw

source

fn TokenKind::of_kw() -> TokenKind

TokenKind::port_kw

source

fn TokenKind::port_kw() -> TokenKind

TokenKind::then_kw

source

fn TokenKind::then_kw() -> TokenKind

TokenKind::type_kw

source

fn TokenKind::type_kw() -> TokenKind

TokenKind::where_kw

source

fn TokenKind::where_kw() -> TokenKind

TokenStream

source

pub(all) struct TokenStream {
  tokens : Array[Token]
  trivia : Array[Trivia]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Trivia

source

pub(all) enum Trivia {
  Whitespace(String, Span)
  Newline(String, Span)
  Comment(Comment)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

invalid_sequence

source

fn invalid_sequence(span : Span) -> Diagnostic

A character Elm does not allow here.

is_lower_start

source

fn is_lower_start(c : Char) -> Bool

Whether c can start a lower-case name (a Unicode lower-case letter).

is_name_part

source

fn is_name_part(c : Char) -> Bool

Whether c can continue a name: a Unicode letter or number, or _.

is_upper_start

source

fn is_upper_start(c : Char) -> Bool

Whether c can start an upper-case name (a Unicode upper-case or title-case letter).

lex_raw

source

fn lex_raw(source : SourceText, dialect? : @moonrockz/krueger/dialect.Dialect
Dialect) -> Result[Array[RawToken], ScanErrorList]

Split Elm source into significant tokens and trivia. Diagnostics: KR-SCAN-001 unterminated block comment, KR-SCAN-002 malformed doc comment, KR-SCAN-003 a character Elm does not allow here, KR-SCAN-004 an unterminated string, char or GLSL literal.

malformed_doc_comment

source

fn malformed_doc_comment(span : Span) -> Diagnostic

A doc comment with no end. span runs from {-| to the end of the input.

normalize_tokens

source

fn normalize_tokens(raw_tokens : Array[RawToken]) -> TokenStream

raw_to_trivia

source

fn raw_to_trivia(raw : RawToken) -> Trivia?

tab_character

source

fn tab_character(span : Span) -> Diagnostic

A tab character.

unexpected_character

source

fn unexpected_character(span : Span) -> Diagnostic

A character that is not a symbol and is not used in Elm, such as a backtick or a non-ASCII letter outside a string.

unexpected_semicolon

source

fn unexpected_semicolon(span : Span) -> Diagnostic

A semicolon.

unterminated_block_comment

source

fn unterminated_block_comment(span : Span) -> Diagnostic

A block comment with no end. span runs from {- to the end of the input.

unterminated_char

source

fn unterminated_char(span : Span) -> Diagnostic

A character literal with no closing quote.

unterminated_glsl

source

fn unterminated_glsl(span : Span) -> Diagnostic

A GLSL block with no closing |].

unterminated_multiline_string

source

fn unterminated_multiline_string(span : Span) -> Diagnostic

A multi-line string with no closing """.

unterminated_string

source

fn unterminated_string(span : Span) -> Diagnostic

A string with no closing quote. span runs from the opening quote to where the scanner stopped (the end of the line, or of the input).

Source Files

Site source Report issue Packages Build queue Skills Statistics

#Scanner

#Block

#Chunk

#Chunk::code

#Chunk::keyword

#Color

#Color::json_name

#Comment

#CommentKind

#DefaultScanner

#DefaultScanner::new

#DefaultScanner::tokenize

#Diagnostic

#KeywordKind

#Position

#RawToken

#RawTokenKind

#ScanErrorList

#Severity

#SourceText

#Span

#Token

#TokenKind

#TokenKind::as_kw

#TokenKind::case_kw

#TokenKind::else_kw

#TokenKind::exposing_kw

#TokenKind::if_kw

#TokenKind::import_kw

#TokenKind::in_kw

#TokenKind::keyword

#TokenKind::let_kw

#TokenKind::module_kw

#TokenKind::of_kw

#TokenKind::port_kw

#TokenKind::then_kw

#TokenKind::type_kw

#TokenKind::where_kw

#TokenStream

#Trivia

#invalid_sequence

#is_lower_start

#is_name_part

#is_upper_start

#lex_raw

#malformed_doc_comment

#normalize_tokens

#raw_to_trivia

#tab_character

#unexpected_character

#unexpected_semicolon

#unterminated_block_comment

#unterminated_char

#unterminated_glsl

#unterminated_multiline_string

#unterminated_string

Source Files

Scanner

Block

Chunk

Chunk::code

Chunk::keyword

Color

Color::json_name

Comment

CommentKind

DefaultScanner

DefaultScanner::new

DefaultScanner::tokenize

Diagnostic

KeywordKind

Position

RawToken

RawTokenKind

ScanErrorList

Severity

SourceText

Span

Token

TokenKind

TokenKind::as_kw

TokenKind::case_kw

TokenKind::else_kw

TokenKind::exposing_kw

TokenKind::if_kw

TokenKind::import_kw

TokenKind::in_kw

TokenKind::keyword

TokenKind::let_kw

TokenKind::module_kw

TokenKind::of_kw

TokenKind::port_kw

TokenKind::then_kw

TokenKind::type_kw

TokenKind::where_kw

TokenStream

Trivia

invalid_sequence

is_lower_start

is_name_part

is_upper_start

lex_raw

malformed_doc_comment

normalize_tokens

raw_to_trivia

tab_character

unexpected_character

unexpected_semicolon

unterminated_block_comment

unterminated_char

unterminated_glsl

unterminated_multiline_string

unterminated_string