DDC.Core.Lexer.Tokens

Documentation

data Located a

A located thing.

Constructors

Located !SourcePos !a

Instances

Eq a => Eq (Located a)

Methods

(==) :: Located a -> Located a -> Bool

(/=) :: Located a -> Located a -> Bool

Show a => Show (Located a)

Methods

showsPrec :: Int -> Located a -> ShowS

show :: Located a -> String

showList :: [Located a] -> ShowS

columnOfLocated :: Located a -> Int

Yield the column number of a located thing.

Tokens

data Token n

Tokens accepted by the core language parser.

Constructors

KErrorJunk String

Some junk symbol that isn't part of the language.

KErrorUnterm String

The first part of an unterminated string.

KM !TokenMeta

Meta tokens contain out-of-band information that is eliminated before parsing proper.

KA !TokenAtom

Atomic tokens are keywords, punctuation and baked-in constructor names.

KN !(TokenNamed n)

A named token that is specific to the language fragment (maybe it's a primop), or a user defined name.

Instances

Eq n => Eq (Token n)

Methods

(==) :: Token n -> Token n -> Bool

(/=) :: Token n -> Token n -> Bool

Show n => Show (Token n)

Methods

showsPrec :: Int -> Token n -> ShowS

show :: Token n -> String

showList :: [Token n] -> ShowS

data TokenMeta

Meta tokens contain out-of-band information that is eliminated before parsing proper.

Constructors

KNewLine

KComment String

Comment string.

KCommentUnterminated

This is injected by dropCommentBlock when it finds an unterminated block comment.

KOffsideClosingBrace

This is injected by applyOffside when it finds an explit close brace in a position where it would close a synthetic one.

Instances

Eq TokenMeta

Methods

(==) :: TokenMeta -> TokenMeta -> Bool

(/=) :: TokenMeta -> TokenMeta -> Bool

Show TokenMeta

Methods

showsPrec :: Int -> TokenMeta -> ShowS

show :: TokenMeta -> String

showList :: [TokenMeta] -> ShowS

data TokenAtom

Atomic tokens are keywords, punctuation and baked-in constructor names. They don't contain user-defined names or primops specific to the language fragment.

Constructors

KPragma Text

Pragmas.

KSymbol Symbol

Symbols.

KKeyword Keyword

Keywords.

KBuiltin Builtin

Builtin names.

KOp String

Infix operators, like in 1 + 2.

KOpVar String

Wrapped operator, like in (+) 1 2.

KIndex Int

Debrujn indices.

KLiteral Literal Bool

Literal values.

Instances

Eq TokenAtom

Methods

(==) :: TokenAtom -> TokenAtom -> Bool

(/=) :: TokenAtom -> TokenAtom -> Bool

Show TokenAtom

Methods

showsPrec :: Int -> TokenAtom -> ShowS

show :: TokenAtom -> String

showList :: [TokenAtom] -> ShowS

data TokenNamed n

A token with a user-defined name.

Constructors

KCon n

KVar n

Instances

Eq n => Eq (TokenNamed n)

Methods

(==) :: TokenNamed n -> TokenNamed n -> Bool

(/=) :: TokenNamed n -> TokenNamed n -> Bool

Show n => Show (TokenNamed n)

Methods

showsPrec :: Int -> TokenNamed n -> ShowS

show :: TokenNamed n -> String

showList :: [TokenNamed n] -> ShowS

data Keyword

Keyword tokens.

Constructors

EModule

EImport

EExport

EForeign

EType

ECapability

EValue

EData

EWith

EWhere

EIn

ELet

ELetCase

ELetRec

EPrivate

EExtend

EUsing

ECase

EOf

EWeakEff

EWeakClo

EPurify

EForget

EBox

ERun

EDo

EMatch

EIf

EThen

EElse

EOtherwise

Instances

Eq Keyword

Methods

(==) :: Keyword -> Keyword -> Bool

(/=) :: Keyword -> Keyword -> Bool

Show Keyword

Methods

showsPrec :: Int -> Keyword -> ShowS

show :: Keyword -> String

showList :: [Keyword] -> ShowS

data Symbol

Symbol tokens.

Constructors

SRoundBra

Like '('

SRoundKet

Like ')'

SSquareBra

Like '['

SSquareKet

Like ']'

SBraceBra

Like '{'

SBraceKet

Like '}'

SSquareColonBra

Like '[:'

SSquareColonKet

Like ':]'

SBraceColonBra

Like '{:'

SBraceColonKet

Like ':}'

SBigLambdaSlash

Like /\\

SArrowTilde

Like ~>

SArrowDashRight

Like '->'

SArrowDashLeft

Like '<-'

SArrowEquals

Like '=>'

SAt

Like '@'

SHat

Like ^

SDot

Like .

SBar

Like '|'

SComma

Like ','

SEquals

Like '='

SLambda

Like 'λ'

SSemiColon

Like ';'

SBackSlash

Like \\

SBigLambda

Like 'Λ'

SUnderscore

Like '_'

Instances

Eq Symbol

Methods

(==) :: Symbol -> Symbol -> Bool

(/=) :: Symbol -> Symbol -> Bool

Show Symbol

Methods

showsPrec :: Int -> Symbol -> ShowS

show :: Symbol -> String

showList :: [Symbol] -> ShowS

data Builtin

Builtin name tokens.

Constructors

BSoCon SoCon

BKiCon KiCon

BTwCon TwCon

BTcCon TcCon

BPure

BEmpty

BDaConUnit

Instances

Eq Builtin

Methods

(==) :: Builtin -> Builtin -> Bool

(/=) :: Builtin -> Builtin -> Bool

Show Builtin

Methods

showsPrec :: Int -> Builtin -> ShowS

show :: Builtin -> String

showList :: [Builtin] -> ShowS

data Literal

Types of literal values known to the compiler.

Note that literals are embedded in the name type of each fragment rather than in the expression itself so that fragments can choose which types of literals they support.

Constructors

LInt Integer

LNat Integer

LSize Integer

LWord Integer Int

LFloat Double Int

LChar Char

LString Text

Instances

Eq Literal

Methods

(==) :: Literal -> Literal -> Bool

(/=) :: Literal -> Literal -> Bool

Show Literal

Methods

showsPrec :: Int -> Literal -> ShowS

show :: Literal -> String

showList :: [Literal] -> ShowS

Description

describeToken :: Pretty n => Token n -> String

Describe a token for parser error messages.

describeTokenMeta :: TokenMeta -> String

Describe a TokMeta, for lexer error messages.

describeTokenAtom :: TokenAtom -> String

Describe a TokAtom, for parser error messages.

describeTokenNamed :: Pretty n => TokenNamed n -> String

Describe a TokNamed, for parser error messages.

sayKeyword :: Keyword -> String

Yield the string name of a keyword.

saySymbol :: Symbol -> String

Yield the string name of a symbol token.

sayBuiltin :: Builtin -> String

Yield the string name of a Builtin.

Renaming

renameToken :: Ord n2 => (n1 -> Maybe n2) -> Token n1 -> Maybe (Token n2)

Apply a function to all the names in a Tok.

Predicates

isVarName :: String -> Bool

Check if this string is a variable name.

isVarStart :: Char -> Bool

Charater can start a variable name.

isVarBody :: Char -> Bool

Character can be part of a variable body.

isConName :: String -> Bool

String is a constructor name.

isConStart :: Char -> Bool

Character can start a constructor name.

isConBody :: Char -> Bool

Charater can be part of a constructor body.

isLitName :: String -> Bool

String is the name of a literal.

isLitStart :: Char -> Bool

Character can start a literal.

isLitBody :: Char -> Bool

Character can be part of a literal body.

Literal Reading

readLitInteger :: String -> Maybe Integer

Read a signed integer.

readLitNat :: String -> Maybe Integer

Read an integer with an explicit format specifier like 1234i.

readLitInt :: String -> Maybe Integer

Read an integer literal with an explicit format specifier like 1234i.

readLitSize :: String -> Maybe Integer

Read an size literal with an explicit format specifier like 1234s.

readLitWordOfBits :: String -> Maybe (Integer, Int)

Read a word with an explicit format speficier.

readLitFloatOfBits :: String -> Maybe (Double, Int)

Read a float literal with an explicit format specifier like 123.00f32#.

readBinary :: Num a => String -> a

Read a binary string as a number.

readHex :: (Enum a, Num a) => String -> a

Read a hex string as a number.