Symantic.Parser.Machine.Generate

Documentation

genCode :: TermInstr a -> CodeQ a

Type Gen

data Gen inp vs es a

Generate the CodeQ parsing the input.

Constructors

Gen

Fields

• minHorizon :: Map Name Horizon -> Horizon

  Synthetized (bottom-up) minimal input length required by the parser to not fail. This requires a minHorizonByName containing the minimal Horizons of all the Names this parser calls, jumps or refJoins to.

• unGen :: GenCtx inp vs es a -> CodeQ (Either (ParsingError inp) a)

Instances

Joinable Gen

Defined in Symantic.Parser.Machine.Generate

Methods

defJoin :: forall v inp (vs :: [Type]) (es :: Peano) a. LetName v -> Gen inp (v ': vs) es a -> Gen inp vs es a -> Gen inp vs es a

refJoin :: forall v inp (vs :: [Type]) (es :: Peano) a. LetName v -> Gen inp (v ': vs) es a

Inputable Gen

Defined in Symantic.Parser.Machine.Generate

Methods

loadInput :: forall inp (vs :: [Type]) (es :: Peano) a. Gen inp vs es a -> Gen inp (Cursor inp ': vs) es a

pushInput :: forall inp (vs :: [Type]) (es :: Peano) a. Gen inp (Cursor inp ': vs) es a -> Gen inp vs es a

Failable Gen

Defined in Symantic.Parser.Machine.Generate

Methods

fail :: forall inp (vs :: [Type]) (es :: Peano) a. [ErrorItem (InputToken inp)] -> Gen inp vs ('Succ es) a

popFail :: forall inp (vs :: [Type]) (es :: Peano) a. Gen inp vs es a -> Gen inp vs ('Succ es) a

catchFail :: forall inp (vs :: [Type]) (es :: Peano) a. Gen inp vs ('Succ es) a -> Gen inp (Cursor inp ': vs) es a -> Gen inp vs es a

Branchable Gen

Defined in Symantic.Parser.Machine.Generate

Methods

caseI :: forall inp x (vs :: [Type]) (es :: Peano) r y. Gen inp (x ': vs) es r -> Gen inp (y ': vs) es r -> Gen inp (Either x y ': vs) es r

choices :: forall v inp (vs :: [Type]) (es :: Peano) a. [TermInstr (v -> Bool)] -> [Gen inp vs es a] -> Gen inp vs es a -> Gen inp (v ': vs) es a

ifI :: forall inp (vs :: [Type]) (es :: Peano) a. Gen inp vs es a -> Gen inp vs es a -> Gen inp (Bool ': vs) es a

Routinable Gen

Defined in Symantic.Parser.Machine.Generate

Methods

subroutine :: forall v inp (vs :: [Type]) (es :: Peano) a. LetName v -> Gen inp '[] ('Succ 'Zero) v -> Gen inp vs ('Succ es) a -> Gen inp vs ('Succ es) a

call :: forall v inp (vs :: [Type]) (es :: Peano) a. LetName v -> Gen inp (v ': vs) ('Succ es) a -> Gen inp vs ('Succ es) a

ret :: forall inp a (es :: Peano). Gen inp '[a] es a

jump :: forall a inp (es :: Peano). LetName a -> Gen inp '[] ('Succ es) a

Stackable Gen

Defined in Symantic.Parser.Machine.Generate

Methods

push :: forall v inp (vs :: [Type]) (es :: Peano) a. TermInstr v -> Gen inp (v ': vs) es a -> Gen inp vs es a

pop :: forall inp (vs :: [Type]) (es :: Peano) a v. Gen inp vs es a -> Gen inp (v ': vs) es a

liftI2 :: forall x y z inp (vs :: [Type]) (es :: Peano) a. TermInstr (x -> y -> z) -> Gen inp (z ': vs) es a -> Gen inp (y ': (x ': vs)) es a

swap :: forall inp x y (vs :: [Type]) (es :: Peano) a. Gen inp (x ': (y ': vs)) es a -> Gen inp (y ': (x ': vs)) es a

mapI :: forall x y inp (vs :: [Type]) (es :: Peano) a. TermInstr (x -> y) -> Gen inp (y ': vs) es a -> Gen inp (x ': vs) es a

appI :: forall inp y (vs :: [Type]) (es :: Peano) a x. Gen inp (y ': vs) es a -> Gen inp (x ': ((x -> y) ': vs)) es a

Readable Char Gen

Defined in Symantic.Parser.Machine.Generate

Methods

read :: forall inp (vs :: [Type]) (es :: Peano) a. Char ~ InputToken inp => [ErrorItem Char] -> TermInstr (Char -> Bool) -> Gen inp (Char ': vs) ('Succ es) a -> Gen inp vs ('Succ es) a

Type ParsingError

data ParsingError inp

Constructors

ParsingErrorStandard

Fields

• parsingErrorOffset :: Offset
• parsingErrorUnexpected :: Maybe (InputToken inp)

  Note that if an ErrorItemHorizon greater than 1 is amongst the parsingErrorExpecting then this is only the InputToken at the begining of the expected Horizon.

• parsingErrorExpecting :: Set (ErrorItem (InputToken inp))

Instances

Show (InputToken inp) => Show (ParsingError inp)

Defined in Symantic.Parser.Machine.Generate

Methods

showsPrec :: Int -> ParsingError inp -> ShowS

show :: ParsingError inp -> String

showList :: [ParsingError inp] -> ShowS

Type Offset

type Offset = Int

Type Horizon

type Horizon = Offset

Synthetized minimal input length required for a successful parsing. Used with checkedHorizon to factorize input length checks, instead of checking the input length one InputToken at a time at each read.

Type Cont

type Cont inp v a = Cursor inp -> [ErrorItem (InputToken inp)] -> v -> Cursor inp -> Either (ParsingError inp) a

Type FailHandler

type FailHandler inp a = Cursor inp -> Cursor inp -> [ErrorItem (InputToken inp)] -> Either (ParsingError inp) a

generateCode :: forall inp ret. Ord (InputToken inp) => Show (InputToken inp) => Lift (InputToken inp) => Input inp => CodeQ inp -> Show (Cursor inp) => Gen inp '[] ('Succ 'Zero) ret -> CodeQ (Either (ParsingError inp) ret)

(generateCode input mach) generates TemplateHaskell code parsing the given input according to the given Machine.

Type GenCtx

data GenCtx inp vs (es :: Peano) a

This is an inherited (top-down) context only present at compile-time, to build TemplateHaskell splices.

Constructors

(Lift (InputToken inp), Cursorable (Cursor inp), Show (InputToken inp)) => GenCtx

Fields

• valueStack :: ValueStack vs
• failStack :: FailStack inp a es
• retCode :: CodeQ (Cont inp a a)
• input :: CodeQ (Cursor inp)
• moreInput :: CodeQ (Cursor inp -> Bool)
• nextInput :: CodeQ (Cursor inp -> (# InputToken inp, Cursor inp #))
• farthestInput :: CodeQ (Cursor inp)
• farthestExpecting :: CodeQ [ErrorItem (InputToken inp)]
• checkedHorizon :: Offset

  Remaining horizon already checked. Updated by checkHorizon and reset elsewhere when needed.

• minHorizonByName :: Map Name Offset

  Minimal horizon for each subroutine or defJoin. This can be done as an inherited attribute because OverserveSharing introduces def as an ancestor node of all the refs pointing to it. Same for defJoin and its refJoins.

Type ValueStack

data ValueStack vs where

Constructors

ValueStackEmpty :: ValueStack '[]

ValueStackCons

Fields

• :: { valueStackHead :: TermInstr v
•    , valueStackTail :: ValueStack vs
•    } -> ValueStack (v ': vs)

Type FailStack

data FailStack inp a es where

Constructors

FailStackEmpty :: FailStack inp a 'Zero

FailStackCons

Fields

• :: { failStackHead :: CodeQ (FailHandler inp a)
•    , failStackTail :: FailStack inp a es
•    } -> FailStack inp a ('Succ es)

generateSuspend :: Gen inp (v ': vs) es a -> GenCtx inp vs es a -> CodeQ (Cont inp v a)

Generate a continuation to be called with generateResume, used when call returns. The return value is pushed on the valueStack.

generateResume :: CodeQ (Cont inp v a) -> Gen inp (v ': vs) es a

Generate a call to the generateSuspend continuation. Used when call returns.

checkHorizon :: Lift (InputToken inp) => Gen inp vs ('Succ es) a -> Gen inp vs ('Succ es) a

checkToken :: forall inp vs es a. Ord (InputToken inp) => Lift (InputToken inp) => [ErrorItem (InputToken inp)] -> TermInstr (InputToken inp -> Bool) -> Gen inp (InputToken inp ': vs) ('Succ es) a -> Gen inp vs ('Succ es) a