printexc(3o) [debian man page]

Printexc(3o)							   OCaml library						      Printexc(3o)

NAME

       Printexc - Facilities for printing exceptions.

Module
       Module	Printexc

Documentation
       Module Printexc
	: sig end

       Facilities for printing exceptions.

       val to_string : exn -> string

       Printexc.to_string e returns a string representation of the exception e .

       val print : ('a -> 'b) -> 'a -> 'b

       Printexc.print  fn  x applies fn to x and returns the result.  If the evaluation of fn x raises any exception, the name of the exception is
       printed on standard error output, and the exception is raised again.  The typical use is to catch and report exceptions that escape a func-
       tion application.

       val catch : ('a -> 'b) -> 'a -> 'b

       Printexc.catch  fn  x  is  similar to Printexc.print , but aborts the program with exit code 2 after printing the uncaught exception.  This
       function is deprecated: the runtime system is now able to print uncaught exceptions as precisely as Printexc.catch does.  Moreover, calling
       Printexc.catch  makes  it harder to track the location of the exception using the debugger or the stack backtrace facility.  So, do not use
       Printexc.catch in new code.

       val print_backtrace : Pervasives.out_channel -> unit

       Printexc.print_backtrace oc prints an exception backtrace on the output channel oc .  The backtrace lists the program locations	where  the
       most-recently raised exception was raised and where it was propagated through function calls.

       Since 3.11.0

       val get_backtrace : unit -> string

       Printexc.get_backtrace () returns a string containing the same exception backtrace that Printexc.print_backtrace would print.

       Since 3.11.0

       val record_backtrace : bool -> unit

       Printexc.record_backtrace  b  turns  recording of exception backtraces on (if b = true ) or off (if b = false ).  Initially, backtraces are
       not recorded, unless the b flag is given to the program through the OCAMLRUNPARAM variable.

       Since 3.11.0

       val backtrace_status : unit -> bool

       Printexc.backtrace_status() returns true if exception backtraces are currently recorded, false if not.

       Since 3.11.0

       val register_printer : (exn -> string option) -> unit

       Printexc.register_printer fn registers fn as an exception printer.  The printer should return None or raise an exception  if  it  does  not
       know  how to convert the passed exception, and Some s with s the resulting string if it can convert the passed exception. Exceptions raised
       by the printer are ignored.

       When converting an exception into a string, the printers will be invoked in the reverse order  of  their  registrations,  until	a  printer
       returns a Some s value (if no such printer exists, the runtime will use a generic printer).

       Since 3.11.2

OCamldoc							    2012-06-26							      Printexc(3o)

Check Out this Related Man Page

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)

Linux and UNIX Man Pages

printexc(3o) [debian man page]

Check Out this Related Man Page