package dolmen

  1. Overview
  2. Docs
A parser library

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (11)

Authors

  1. G
    Guillaume Bury <guillaume.bury@gmail.com>

Maintainers

  1. G
    Guillaume Bury <guillaume.bury@gmail.com>

Sources

dolmen-v0.5.tbz
sha256=b9a6f80bf13fdf1fd69ff2013f583582fa00e13c86ee6f800737fabcfd530458
sha512=84b8c18e56b3fb20674af0a3729b7e15e543f21b0062c565b575b994388eb55ee8123e5d3d31f5f1042b204544b3084089a024c742ab741ddd7e18b5641dd399

doc/dolmen.zf/Dolmen_zf/Make/index.html

Module Dolmen_zf.MakeSource

Functor to generate a parser for the Zipperposition format.

Parameters

module I : Id
module T : Term with type location := L.t and type id := I.t
module S : Statement with type location := L.t and type id := I.t and type term := T.t

Signature

Sourcetype token

The type of tokens produced by the language lexer.

Sourcetype statement = S.t

The type of top-level directives recognised by the parser.

The Lexer module for the language.

The Parser module for the language.

Sourceval find : ?dir:string -> string -> string option

Helper function to find a file using a language specification. Separates directory and file because most include directives in languages are relative to the directory of the original file being processed.

Sourceval parse_file : string -> L.file * statement list

Parse the given file.

  • parameter dir:

    optional directory to use if the file path is relative.

Sourceval parse_file_lazy : string -> L.file * statement list Lazy.t

Parse the given file.

  • parameter dir:

    optional directory to use if the file path is relative.

Sourceval parse_input : [ `Stdin | `File of string | `Contents of string * string ] -> L.file * (unit -> statement option) * (unit -> unit)

Incremental parsing. Given an input to read (either a file, stdin, or some contents of the form (filename, s) where s is the contents to parse), returns a generator that will incrementally parse the statements, together with a cleanup function to close file descriptors. In case of a syntax error, the current line will be completely consumed and parsing will restart at the beginning of the next line. Useful to process input from stdin, or even large files where it would be impractical to parse the entire file before processing it.