A simple parser combinator library.
This module permits the simple definition of highly modular, dynamic parsers with unlimited backtracking. It may be used to parse any form of enumeration, including regular text, latin-1 text, bits, etc.
This library is vastly more powerful than Lexing, Str, Parsing or Scanf. It is also considerably slower.
Module CharParser contains pre-defined parsers to deal specifically with latin-1 text. Module Genlex contains a number of pre-defined parsers to deal specifically with programming languages.
Note This library is still very rough and needs much testing.
The current state of the parser.
The actual set of states is defined by the user. States are typically used to convey informations, such as position in the file (i.e. line number and character).
module Source : sig ... endA source for parsing. Unless you are parsing from exotic sources, you will probably not need to use this module directly. Rather, use CharParser.source_of_string or CharParser.source_of_enum.
A parser for elements of type 'a, producing elements of type 'b, with user-defined states of type 'c.
val eof : (_, unit, _) tAccept the end of an enumeration.
Monadic-style combination:
bind p f results in a new parser which behaves as p then, in case of success, applies f to the result.
cons p q applies parser p then parser q and conses the results into a list.
Give a name to a parser, for debugging purposes.
val any : ('a, 'a, _) tAccept any singleton value.
val return : 'b -> (_, 'b, _) tA parser which always succeds
val satisfy : ('a -> bool) -> ('a, 'a, _) tsatisfy p accepts one value p x such that p x = true
filter f p is only accepts values x such that p accepts x and f (p x) is true
val suspend :
('a, 'b, 'c) t ->
('a, unit -> ('b, 'c report) BatPervasives.result, 'c) tsuspend s returns the state of the parser in a form that can be resumed by calling the returned function. evaluation will resume from parser s
val run :
('a, 'b, 'c) t ->
('a, 'c) Source.t ->
('b, 'c report) BatPervasives.resultrun p s executes parser p on source s. In case of success, returns Ok v, where v is the return value of p. In case of failure, returns Bad f, with f containing details on the parsing error.
val fail : (_, _, _) tAlways fail, without consuming anything.
val fatal : (_, _, _) tlookahead p behaves as maybe p but without consuming anything
val exactly : 'a -> ('a, 'a, 'c) tAccept exactly one singleton.
val one_of : 'a list -> ('a, 'a, 'c) tAccept one of several values. Faster and more convenient than combining satisfy and either.
val none_of : 'a list -> ('a, 'a, 'c) tAccept any value not in a list Faster and more convenient than combining satisfy and either.
val range : 'a -> 'a -> ('a, 'a, 'c) tAccept any element from a given range.
Accept a (possibly empty) list of expressions.
Ignore a (possibly empty) list of expressions. Optimized version of zero_plus, for use when the list of expressions is unimportant.
Accept a (non-empty) list of expressions
Ignore a (non-empty) list of expressions. Optimized version of one_plus, for use when the list of expressions is unimportant.
times n p accepts a list of n expressions accepted by p
Pass the (successful) result of some parser through a map.
Use a parser to extract list of tokens, but return that list of tokens instead of whatever the original parser returned.
val sat : ('a -> bool) -> ('a, unit, _) tsatisfy p accepts one value p x such that p x = true
val debug_mode : bool Pervasives.refIf set to true, debugging information will be printed to the standard error.
module Infix : sig ... end