ocamllex(1) [centos man page]

OCAMLLEX(1)						      General Commands Manual						       OCAMLLEX(1)

NAME

       ocamllex - The OCaml lexer generator

SYNOPSIS

       ocamllex [ -o output-file ] [ -ml ] filename.mll

DESCRIPTION

       The ocamllex(1) command generates OCaml lexers from a set of regular expressions with associated semantic actions, in the style of lex(1).

       Running ocamllex(1) on the input file lexer.mll produces OCaml code for a lexical analyzer in file lexer.ml.

       This  file  defines  one  lexing function per entry point in the lexer definition. These functions have the same names as the entry points.
       Lexing functions take as argument a lexer buffer, and return the semantic attribute of the corresponding entry point.

       Lexer buffers are an abstract data type implemented in  the  standard  library  module  Lexing.	The  functions	Lexing.from_channel,  Lex-
       ing.from_string and Lexing.from_function create lexer buffers that read from an input channel, a character string, or any reading function,
       respectively.

       When used in conjunction with a parser generated by ocamlyacc(1), the semantic actions compute a value belonging to the type token  defined
       by the generated parsing module.

OPTIONS

       The ocamllex(1) command recognizes the following options:

       -ml    Output  code  that  does	not use OCaml's built-in automata interpreter. Instead, the automaton is encoded by OCaml functions.  This
	      option is mainly useful for debugging ocamllex(1), using it for production lexers is not recommended.

       -o output-file
	      Specify the name of the output file produced by ocamllex(1).  The default is the input file name, with  its  extension  replaced	by
	      .ml.

       -q     Quiet mode.  ocamllex(1) normally outputs informational messages to standard output.  They are suppressed if option -q is used.

       -v or -version
	      Print version string and exit.

       -vnum  Print short version number and exit.

       -help or --help
	      Display a short usage summary and exit.

SEE ALSO

       ocamlyacc(1).
       The OCaml user's manual, chapter "Lexer and parser generators".

																       OCAMLLEX(1)

Parsing(3o)							   OCaml library						       Parsing(3o)

NAME

       Parsing - The run-time library for parsers generated by ocamlyacc.

Module
       Module	Parsing

Documentation
       Module Parsing
	: sig end

       The run-time library for parsers generated by ocamlyacc .

       val symbol_start : unit -> int

       symbol_start  and  Parsing.symbol_end are to be called in the action part of a grammar rule only. They return the offset of the string that
       matches the left-hand side of the rule: symbol_start() returns the offset of the first character; symbol_end() returns the offset after the
       last character. The first character in a file is at offset 0.

       val symbol_end : unit -> int

       See Parsing.symbol_start .

       val rhs_start : int -> int

       Same  as Parsing.symbol_start and Parsing.symbol_end , but return the offset of the string matching the n th item on the right-hand side of
       the rule, where n is the integer parameter to rhs_start and rhs_end .  n is 1 for the leftmost item.

       val rhs_end : int -> int

       See Parsing.rhs_start .

       val symbol_start_pos : unit -> Lexing.position

       Same as symbol_start , but return a position instead of an offset.

       val symbol_end_pos : unit -> Lexing.position

       Same as symbol_end , but return a position instead of an offset.

       val rhs_start_pos : int -> Lexing.position

       Same as rhs_start , but return a position instead of an offset.

       val rhs_end_pos : int -> Lexing.position

       Same as rhs_end , but return a position instead of an offset.

       val clear_parser : unit -> unit

       Empty the parser stack. Call it just after a parsing function has returned, to remove all pointers from the parser stack to structures that
       were built by semantic actions during parsing.  This is optional, but lowers the memory requirements of the programs.

       exception Parse_error

       Raised when a parser encounters a syntax error.	Can also be raised from the action part of a grammar rule, to initiate error recovery.

       val set_trace : bool -> bool

       Control	debugging  support  for  ocamlyacc  -generated	parsers.   After Parsing.set_trace true , the pushdown automaton that executes the
       parsers prints a trace of its actions (reading a token, shifting a state, reducing by a rule) on standard output.  Parsing.set_trace  false
       turns this debugging trace off.	The boolean returned is the previous state of the trace flag.

       Since 3.11.0

OCamldoc							    2012-06-26							       Parsing(3o)