package fmlib_parse

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Feeding Tokens
Success
Syntax Errors
Semantic Errors
State

package fmlib_parse

Legend:
Library
Module
Module type
Parameter
Class
Class type

A normal parser parses a stream of tokens like a MINIMAL_PARSER. In addition it can have a state and semantic errors.

type t

Type of the parser.

Feeding Tokens

type token

Type of the tokens.

val needs_more : t -> bool

needs_more p Does the parser p need more tokens?

val put : token -> t -> t

put tok p Push token tok into the parser p.

Even if the parser has ended, more tokens can be pushed into the parser. The parser stores the token as lookahead token.

If the parser has already received the end of the token stream via put_end, then all subsequent tokens are ignored.

val put_end : t -> t

put_end p Push and end token into the parser p.

val run_on_stream : token Stream.t -> t -> t

run_on_stream str p Run the parser p on the stream of tokens str.

Success

type final

Type of the final result.

val has_succeeded : t -> bool

has_succeeded p Has the parser p succeeded?

val final : t -> final

final p The final object constructed by the parser p in case of success.

Precondition: has_succeeded p

Syntax Errors

type expect

Type of expectations.

val has_failed_syntax : t -> bool

has_failed_syntax p Has the parser p failed with a syntax error?

val failed_expectations : t -> expect list

failed_expectations p The failed expectations due to a syntax error.

Precondition: has_failed_syntax p

Semantic Errors

type semantic

Type of semantic errors.

val has_failed_semantic : t -> bool

Has the parser failed because of a semantic error?

val failed_semantic : t -> semantic

The semantic error encountered.

Precondition: A semantic error has occurred.

State

type state

Type of the state of the parser (in many cases unit)

val state : t -> state

The state of the parser.