Equations
- Lean.Parser.mkAtom info val = Lean.Syntax.atom info val
Equations
- Lean.Parser.mkIdent info rawVal val = Lean.Syntax.ident info rawVal val []
Return character after position pos
Equations
- Lean.Parser.getNext input pos = input.get (input.next pos)
Maximal (and function application) precedence.
In the standard lean language, no parser has precedence higher than maxPrec
.
Note that nothing prevents users from using a higher precedence, but we strongly discourage them from doing it.
Equations
- Lean.Parser.maxPrec = 1024
Equations
- s.insert k = Lean.PersistentHashMap.insert s k ()
Input string and related data. Recall that the FileMap
is a helper structure for mapping
String.Pos
in the input string to line/column information.
- input : String
- fileName : String
- fileMap : Lean.FileMap
Instances For
Equations
- Lean.Parser.instInhabitedInputContext = { default := { input := default, fileName := default, fileMap := default } }
Input context derived from elaboration of previous commands.
- env : Lean.Environment
- options : Lean.Options
- currNamespace : Lake.Name
- openDecls : List Lean.OpenDecl
Parser context parts that can be updated without invalidating the parser cache.
- prec : Nat
- quotDepth : Nat
- suppressInsideQuot : Bool
- savedPos? : Option String.Pos
- forbiddenTk? : Option Lean.Parser.Token
Instances For
Parser context updateable in adaptUncacheableContextFn
.
- input : String
- fileName : String
- fileMap : Lean.FileMap
- env : Lean.Environment
- options : Lean.Options
- currNamespace : Lake.Name
- openDecls : List Lean.OpenDecl
- prec : Nat
- quotDepth : Nat
- suppressInsideQuot : Bool
- savedPos? : Option String.Pos
- forbiddenTk? : Option Lean.Parser.Token
- tokens : Lean.Parser.TokenTable
Opaque parser context updateable using adaptCacheableContextFn
and adaptUncacheableContextFn
.
- unexpectedTk : Lean.Syntax
If not
missing
, used for lazily calculatingunexpected
message and range inmkErrorMessage
. Otherwise,ParserState.pos
is used as an empty range. - unexpected : String
Equations
- Lean.Parser.instInhabitedError = { default := { unexpectedTk := default, unexpected := default, expected := default } }
Equations
- Lean.Parser.instBEqError = { beq := Lean.Parser.beqError✝ }
Equations
- One or more equations did not get rendered due to their size.
Equations
- Lean.Parser.Error.instToString = { toString := Lean.Parser.Error.toString }
Equations
- One or more equations did not get rendered due to their size.
- startPos : String.Pos
- stopPos : String.Pos
- token : Lean.Syntax
- prec : Nat
- quotDepth : Nat
- suppressInsideQuot : Bool
- savedPos? : Option String.Pos
- forbiddenTk? : Option Lean.Parser.Token
- parserName : Lake.Name
- pos : String.Pos
Equations
Equations
- Lean.Parser.instHashableParserCacheKey = { hash := fun (k : Lean.Parser.ParserCacheKey) => hash (k.pos, k.parserName) }
- stx : Lean.Syntax
- lhsPrec : Nat
- newPos : String.Pos
- errorMsg : Option Lean.Parser.Error
- tokenCache : Lean.Parser.TokenCacheEntry
Equations
- Lean.Parser.initCacheForInput input = { tokenCache := { startPos := input.endPos + ' ', stopPos := 0, token := Lean.Syntax.missing }, parserCache := ∅ }
A syntax array with an inaccessible prefix, used for sound caching.
- raw : Array Lean.Syntax
- drop : Nat
Instances For
Equations
- stack.toSubarray = stack.raw.toSubarray stack.drop
Equations
- Lean.Parser.SyntaxStack.empty = { raw := #[], drop := 0 }
Equations
- stack.push a = { raw := stack.raw.push a, drop := stack.drop }
Equations
- stack.back = if stack.size > 0 then stack.raw.back else panicWithPosWithDecl "Lean.Parser.Types" "Lean.Parser.SyntaxStack.back" 175 4 "SyntaxStack.back: element is inaccessible"
Equations
- One or more equations did not get rendered due to their size.
Equations
- Lean.Parser.SyntaxStack.instHAppendArraySyntax = { hAppend := fun (stack : Lean.Parser.SyntaxStack) (stxs : Array Lean.Syntax) => { raw := stack.raw ++ stxs, drop := stack.drop } }
- stxStack : Lean.Parser.SyntaxStack
- lhsPrec : Nat
Set to the precedence of the preceding (not surrounding) parser by
runLongestMatchParser
for the use ofcheckLhsPrec
in trailing parsers. Note that with chaining, the preceding parser can be another trailing parser: in1 * 2 + 3
, the preceding parser is '*' when '+' is executed. - pos : String.Pos
- cache : Lean.Parser.ParserCache
- errorMsg : Option Lean.Parser.Error
- recoveredErrors : Array (String.Pos × Lean.Parser.SyntaxStack × Lean.Parser.Error)
Equations
- s.stackSize = s.stxStack.size
Equations
- s.restore iniStackSz iniPos = { stxStack := s.stxStack.shrink iniStackSz, lhsPrec := s.lhsPrec, pos := iniPos, cache := s.cache, errorMsg := none, recoveredErrors := s.recoveredErrors }
Equations
- s.setPos pos = { stxStack := s.stxStack, lhsPrec := s.lhsPrec, pos := pos, cache := s.cache, errorMsg := s.errorMsg, recoveredErrors := s.recoveredErrors }
Equations
- s.setCache cache = { stxStack := s.stxStack, lhsPrec := s.lhsPrec, pos := s.pos, cache := cache, errorMsg := s.errorMsg, recoveredErrors := s.recoveredErrors }
Equations
- s.pushSyntax n = { stxStack := s.stxStack.push n, lhsPrec := s.lhsPrec, pos := s.pos, cache := s.cache, errorMsg := s.errorMsg, recoveredErrors := s.recoveredErrors }
Equations
- s.popSyntax = { stxStack := s.stxStack.pop, lhsPrec := s.lhsPrec, pos := s.pos, cache := s.cache, errorMsg := s.errorMsg, recoveredErrors := s.recoveredErrors }
Equations
- s.shrinkStack iniStackSz = { stxStack := s.stxStack.shrink iniStackSz, lhsPrec := s.lhsPrec, pos := s.pos, cache := s.cache, errorMsg := s.errorMsg, recoveredErrors := s.recoveredErrors }
Equations
- s.next input pos = { stxStack := s.stxStack, lhsPrec := s.lhsPrec, pos := input.next pos, cache := s.cache, errorMsg := s.errorMsg, recoveredErrors := s.recoveredErrors }
Equations
- s.next' input pos h = { stxStack := s.stxStack, lhsPrec := s.lhsPrec, pos := input.next' pos h, cache := s.cache, errorMsg := s.errorMsg, recoveredErrors := s.recoveredErrors }
Equations
- One or more equations did not get rendered due to their size.
Equations
- One or more equations did not get rendered due to their size.
Equations
- s.allErrors = s.recoveredErrors ++ (Option.map (fun (e : Lean.Parser.Error) => #[(s.pos, s.stxStack, e)]) s.errorMsg).getD #[]
Equations
- One or more equations did not get rendered due to their size.
Equations
- s.mkError msg = (s.setError { unexpectedTk := Lean.Syntax.missing, unexpected := "", expected := [msg] }).pushSyntax Lean.Syntax.missing
Equations
- One or more equations did not get rendered due to their size.
Equations
- s.mkEOIError expected = s.mkUnexpectedError "unexpected end of input" expected
Equations
- One or more equations did not get rendered due to their size.
Equations
- s.mkErrorAt msg pos initStackSz? = s.mkErrorsAt [msg] pos initStackSz?
Reports given 'expected' messages at range of top stack element (assumed to be a single token).
Replaces the element with missing
and resets position to the token position.
iniPos
can be specified to avoid this position lookup but still must be identical to the token position.
Equations
- One or more equations did not get rendered due to their size.
Reports given 'expected' message at range of top stack element (assumed to be a single token).
Replaces the element with missing
and resets position to the token position.
iniPos
can be specified to avoid this position lookup but still must be identical to the token position.
Equations
- s.mkUnexpectedTokenError msg iniPos = s.mkUnexpectedTokenErrors [msg] iniPos
Equations
- s.mkUnexpectedErrorAt msg pos = (s.setPos pos).mkUnexpectedError msg []
Equations
- One or more equations did not get rendered due to their size.
Equations
- Lean.Parser.instInhabitedParserFn = { default := fun (x : Lean.Parser.ParserContext) (s : Lean.Parser.ParserState) => s }
- epsilon: Lean.Parser.FirstTokens
- unknown: Lean.Parser.FirstTokens
- tokens: List Lean.Parser.Token → Lean.Parser.FirstTokens
- optTokens: List Lean.Parser.Token → Lean.Parser.FirstTokens
Equations
- Lean.Parser.instInhabitedFirstTokens = { default := Lean.Parser.FirstTokens.epsilon }
Equations
- One or more equations did not get rendered due to their size.
Equations
- x.toOptional = match x with | Lean.Parser.FirstTokens.tokens tks => Lean.Parser.FirstTokens.optTokens tks | tks => tks
Equations
- One or more equations did not get rendered due to their size.
Equations
- One or more equations did not get rendered due to their size.
Equations
- Lean.Parser.FirstTokens.instToString = { toString := Lean.Parser.FirstTokens.toStr }
- collectTokens : List Lean.Parser.Token → List Lean.Parser.Token
- collectKinds : Lean.Parser.SyntaxNodeKindSet → Lean.Parser.SyntaxNodeKindSet
- firstTokens : Lean.Parser.FirstTokens
Instances For
Equations
- Lean.Parser.instInhabitedParserInfo = { default := { collectTokens := default, collectKinds := default, firstTokens := default } }
Equations
- Lean.Parser.instInhabitedParser = { default := { info := default, fn := default } }
Create a simple parser combinator that inherits the info
of the nested parser.
Equations
- Lean.Parser.withFn f p = { info := p.info, fn := f p.fn }
Equations
- One or more equations did not get rendered due to their size.
Run p
with a fresh cache, restore outer cache afterwards.
p
may access the entire syntax stack.
Equations
- One or more equations did not get rendered due to their size.
Run p
with a fresh cache, restore outer cache afterwards.
p
may access the entire syntax stack.
Run p
under the given context transformation with a fresh cache (see also withResetCacheFn
).
Equations
- One or more equations did not get rendered due to their size.
Run p
and record result in parser cache for any further invocation with this parserName
, parser context, and parser state.
p
cannot access syntax stack elements pushed before the invocation in order to make caching independent of parser history.
As this excludes trailing parsers from being cached, we also reset lhsPrec
, which is not read but set by leading parsers, to 0
in order to increase cache hits. Finally, errorMsg
is also reset to none
as a leading parser should not be called in the first
place if there was an error.
Equations
- One or more equations did not get rendered due to their size.
Run p
and record result in parser cache for any further invocation with this parserName
, parser context, and parser state.
p
cannot access syntax stack elements pushed before the invocation in order to make caching independent of parser history.
As this excludes trailing parsers from being cached, we also reset lhsPrec
, which is not read but set by leading parsers, to 0
in order to increase cache hits. Finally, errorMsg
is also reset to none
as a leading parser should not be called in the first
place if there was an error.
Equations
- Lean.Parser.withCache parserName = Lean.Parser.withFn (Lean.Parser.withCacheFn parserName)
Equations
- One or more equations did not get rendered due to their size.