Module `Dolmen_std.Loc`Source

Standard implementation of file locations.

Interface definition

Sourcetype loc = private {

file : string;
start_line : int;
start_column : int;
start_line_offset : int;
stop_line : int;
stop_column : int;
stop_line_offset : int;
max_line_length : int;

}

A full location, including file, start position and end position. Dummy positions (i.e. with start_line = stop_line and start_column = stop_column) are allowed to represent unknown locations.

Sourcetype file

Meta-data about files to enable more compact location storage.

Sourcetype t

A compact representation of locations.

Sourcetype full = {

file : file;
loc : t;

}

Interface definition

Sourcemodule type S = Dolmen_intf.Location.S

An anstract module type for providing locations. Used as argumentby much of the functors provided in Dolmen.

This module implements the signature S.

include S with type t := t and type file := file

Sourceexception Uncaught of t * exn * Printexc.raw_backtrace

The exception to be raised whenever an unexpected exception is raised during parsing.

Sourceexception Lexing_error of t * string

The exception to be raised when the lexer cannot parse the input.

Source

exception Syntax_error of t
  * [ `Regular of Dolmen_intf.Msg.t
    | `Advanced of
      string * Dolmen_intf.Msg.t * Dolmen_intf.Msg.t * Dolmen_intf.Msg.t ]

Syntax_error (loc, msg) denotes a syntax error at the given location. In the `Advanced (error_ref, prod, parsed, expected) case,

error_ref is an identifier for the error state
prod is a delayed message to print in order to identify which production/syntax construction the parser was trying to reduce,
parsed is a description of the token which raised the error,
expected is a messages describing what would have been corect tokens/inputs at that point.

Sourceval of_lexbuf : Lexing.lexbuf -> t

Make a position using a lexbuf directly.

Sourceval mk_pos : Lexing.position -> Lexing.position -> t

Make a position from two lewing positions.

Sourceval newline : file -> Lexing.lexbuf -> unit

Offer a way for the file meta-data to store the current location of the lexbuf as the start of a new line.

Sourceval update_size : file -> Lexing.lexbuf -> unit

Update the file meta-data to store the maximum offset currently seen for this file.

Sourceval hash : t -> int

Hashing function.

Sourceval eq : t -> t -> bool

Location equality.

Sourceval compare : t -> t -> int

Comparision.

Sourceval no_loc : t

A dummy location pointing at the first byte of a file.

Sourceval dummy : loc

A dummy location pointing at the first byte of a file.

Sourceval is_dummy : loc -> bool

Is the location an actual location, or a dummy one ?

Compact location handling

Sourceval mk_file : string -> file

Create a new set of meta-data for the given filename.

Sourceval new_line : file -> int -> unit

Compact<->full translations

Sourceval loc : file -> t -> loc

Sourceval full_loc : full -> loc

Return a complete location from a compact location and meta-data.

Sourceval compact : loc -> file * t

Compactify a full location into a compact representation.

Sourceval lexing_positions : loc -> Lexing.position * Lexing.position

Return the pair of lexing positions corresponding to a location.

Printing locations

Sourceval pp : Buffer.t -> loc -> unit

Sourceval fmt : Format.formatter -> loc -> unit

Sourceval fmt_pos : Format.formatter -> loc -> unit

Sourceval fmt_hint : Format.formatter -> loc -> unit

Sourceval fmt_compact : Format.formatter -> loc -> unit

Printing functions

Sourceval print_compact : Format.formatter -> t -> unit

misc

Sourceval file_name : file -> string

Filename for a file

Install

Dune Dependency

Authors

Maintainers

Sources

doc/dolmen.std/Dolmen_std/Loc/index.html

Module `Dolmen_std.Loc`Source

Interface definition

Interface definition

Compact location handling

Compact<->full translations

Printing locations

package dolmen

Install

Dune Dependency

Authors

Maintainers

Sources

doc/dolmen.std/Dolmen_std/Loc/index.html

Module Dolmen_std.LocSource

Interface definition

Interface definition

Compact location handling

Compact<->full translations

Printing locations

Module `Dolmen_std.Loc`Source