package dolmen

  1. Overview
  2. Docs

Source file parse.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

(* This file is free software, part of dolmen. See file "LICENSE" formore information *)

(** Interface for Dolmen parsers. *)

module type S = sig

  (** {2 Main interface} *)

  type token
  (** The type of token consumed by the parser. *)

  type statement
  (** The type of top-level declarations returned by the parser. *)

  exception Error of int
  (** Exception raised by the parser when it encounters an error. *)

  val file : (Lexing.lexbuf -> token) -> Lexing.lexbuf -> statement list
  (** A function that parses an entire file, i.e until the end-of-file token,
      and return the list of parsed statements. *)

  val input : (Lexing.lexbuf -> token) -> Lexing.lexbuf -> statement option
  (** A function to parse a single statement. Returns [None] if it encounters
      the end-of-file token. Used for incremental parsing. *)

end