Pos (p.pacomb.1.0.doc.pacomb.Pacomb.Pos)

Functions managing positions

Sourcetype pos = {

name : string;
(*
file's name
*)
line : int;
(*
line number
*)
col : int;
(*
column number
*)
phantom : bool;
(*
is the postion a "phantom", i.e. not really in the file
*)

}

Type to represent position

Sourcetype interval = {

start : pos;
end_ : pos;

}

Sourcetype t = pos

Abbreviation

Sourceval phantom : pos

a phantom position, used for grammar accepting the empty input

Sourceval max_pos : pos -> pos -> pos

the max of to position (further in the file

Sourceval get_pos : Input.buffer -> Input.pos -> pos

Get a position from an input buffer and a column number

Sourcetype style =

| OCaml
(*
like OCaml
*)
| Short
(*
like gcc
*)

Style for printing positions:

Sourceval print_pos : ?style:style -> unit -> out_channel -> pos -> unit

printting for position

Sourceval print_interval : ?style:style -> unit -> out_channel -> interval -> unit

and interval

Source

val print_buf_pos : 
  ?style:style ->
  unit ->
  out_channel ->
  (Input.buffer * Input.pos) ->
  unit

print_buf_pos () ch (buf,pos) = print_pos () ch (get_pos buf pos)

Sourceexception Parse_error of Input.buffer * Input.pos * string list

Exception raised by the function below when parsing fails

Source

val handle_exception : 
  ?error:(exn -> 'b) ->
  ?style:style ->
  ('a -> 'b) ->
  'a ->
  'b

handle_exception fn v applies the function fn to v and handles the Parse_error exception. In particular, a parse error message is presented to the user in case of a failure, then error e is called where e is the raised exception. The default error is fun _ -> exit 1. raise is another possibility.