package pacomb

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Functions managing positions

package pacomb

pacomb
- Pacomb
  - Assoc
  - Blank
  - Charset
  - Comb
  - Container
    
    Make
    
    T
    
    Param
    
    Ref
  - Grammar
  - Hashtbl_eq
  - Input
    
    Preprocessor
    
    Tbl
    
    WithPP
    
    PP
  - Keywords
    
    Make
    
    S
    
    Spec
  - Lex
  - Pos
  - Regexp
  - UnionFind
  - Utf8
  - Word_list

Legend:
Library
Module
Module type
Parameter
Class
Class type

Functions managing positions

type 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

type interval = {

start : pos;
end_ : pos;

}

type t = pos

Abbreviation

val phantom : pos

a phantom position, used for grammar accepting the empty input

val max_pos : pos -> pos -> pos

the max of to position (further in the file

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

Get a position from an input buffer and a column number

type style =

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

Style for printing positions:

val print_pos : ?style:style -> unit -> Stdlib.out_channel -> pos -> unit

printting for position

val print_interval : 
  ?style:style ->
  unit ->
  Stdlib.out_channel ->
  interval ->
  unit

and interval

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

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

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

Exception raised by the function below when parsing fails

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.