package dolmen

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package dolmen

dolmen
- Dolmen
dolmen.ae
- Dolmen_ae
  - Id
  - Make
    
    I
    
    L
    
    Lexer
    
    Parser
    
    Incremental
    
    MenhirInterpreter
    
    S
    
    T
  - Statement
  - Term
dolmen.class
- Dolmen_class
  - Logic
    
    Make
    
    I
    
    L
    
    S
    
    Lexer
    
    Parser
    
    Incremental
    
    MenhirInterpreter
    
    T
    
    S
    
    S
    
    Lexer
    
    Parser
    
    Incremental
    
    MenhirInterpreter
dolmen.dimacs
- Dolmen_dimacs
  - Make
    
    L
    
    Lexer
    
    Parser
    
    Incremental
    
    MenhirInterpreter
    
    S
    
    T
  - Statement
  - Term
dolmen.icnf
- Dolmen_icnf
  - Make
    
    L
    
    Lexer
    
    Parser
    
    Incremental
    
    MenhirInterpreter
    
    S
    
    T
  - Statement
  - Term
dolmen.intf
- Dolmen_intf
  - Id
    
    Escape
    
    Logic
  - Language
    
    S
    
    Lexer
    
    Parser
    
    Incremental
    
    MenhirInterpreter
  - Lex
    
    S
  - Location
    
    S
  - Msg
  - Parse
    
    S
    
    Incremental
    
    MenhirInterpreter
  - Stmt
    
    Logic
  - Tag
    
    S
    
    Smtlib_Base
    
    Zf_Base
  - Term
    
    Ae_Arith
    
    Ae_Base
    
    Logic
    
    Smtlib_Arith_Common
    
    Smtlib_Array
    
    Smtlib_Base
    
    Smtlib_Bitv
    
    Smtlib_Float
    
    Bitv
    
    Float
    
    Real
    
    Smtlib_Float_Bitv
    
    Smtlib_Float_Float
    
    Smtlib_Float_Real
    
    Smtlib_Int
    
    Smtlib_Real
    
    Smtlib_Real_Int
    
    Int
    
    Real
    
    Smtlib_String
    
    String
    
    RegLan
    
    Smtlib_String_RegLan
    
    Smtlib_String_String
    
    RegLan
    
    Tff
    
    Const
    
    Cstr
    
    Field
    
    Var
    
    Tptp_Arith
    
    Int
    
    Rat
    
    Real
    
    Tptp_Arith_Common
    
    Tptp_Base
  - Tok
  - Ty
    
    Ae_Arith
    
    Ae_Base
    
    Smtlib_Array
    
    Smtlib_Base
    
    Smtlib_Bitv
    
    Smtlib_Float
    
    Smtlib_Int
    
    Smtlib_Real
    
    Smtlib_Real_Int
    
    Smtlib_String
    
    Tff
    
    Const
    
    Var
    
    Tptp_Arith
    
    Tptp_Base
dolmen.line
- Dolmen_line
dolmen.smtlib2
- Dolmen_smtlib2
dolmen.smtlib2.poly
- Dolmen_smtlib2_poly
  - Id
  - Make
    
    I
    
    L
    
    Lexer
    
    Parser
    
    Incremental
    
    MenhirInterpreter
    
    S
    
    T
  - Statement
  - Term
dolmen.smtlib2.v6
- Dolmen_smtlib2_v6
  - Id
  - Make
    
    I
    
    L
    
    Lexer
    
    Parser
    
    Incremental
    
    MenhirInterpreter
    
    S
    
    T
  - Statement
  - Term
dolmen.std
- Dolmen_std
  - Escape
    
    Make
    
    Id
  - Expr
    
    Filter
    
    S
    
    Id
    
    Print
    
    Subst
    
    S
    
    Var
    
    Tags
    
    Term
    
    Bitv
    
    Const
    
    Cstr
    
    Field
    
    Float
    
    Int
    
    Rat
    
    Real
    
    String
    
    RegLan
    
    Var
    
    Ty
    
    Const
    
    Var
  - Id
  - Loc
  - Misc
  - Msg
  - Normalize
    
    Smtlib
    
    Tptp
  - Pretty
  - Statement
  - Tag
  - Term
  - Tok
  - Transformer
    
    Make
    
    Lex
    
    Loc
    
    Parse
    
    Incremental
    
    MenhirInterpreter
    
    Ty
  - Vec
dolmen.tptp
- Dolmen_tptp
dolmen.tptp.v6_3_0
- Dolmen_tptp_v6_3_0
  - Id
  - Make
    
    I
    
    L
    
    Lexer
    
    Parser
    
    Incremental
    
    MenhirInterpreter
    
    S
    
    T
  - Statement
  - Term
dolmen.zf
- Dolmen_zf
  - Id
  - Make
    
    I
    
    L
    
    Lexer
    
    Parser
    
    Incremental
    
    MenhirInterpreter
    
    S
    
    T
  - Statement
  - Term

Legend:
Library
Module
Module type
Parameter
Class
Class type

Parameters

module L : Dolmen_intf.Location.S

module I : Dolmen_intf.Id.Logic

module T : Dolmen_intf.Term.Logic with type location := L.t and type id := I.t

module S : 
  Dolmen_intf.Stmt.Logic
    with type location := L.t
     and type id := I.t
     and type term := T.t

Signature

exception Extension_not_found of string

Raised when trying to find a language given a file extension.

Supported languages

type language =

| Alt_ergo
(*
Alt-ergo's native language
*)
| Dimacs
(*
Dimacs CNF format
*)
| ICNF
(*
iCNF format
*)
| Smtlib2 of Dolmen_smtlib2.version
(*
Smtlib v2 latest version
*)
| Tptp of Dolmen_tptp.version
(*
TPTP format (including THF), latest version
*)
| Zf
(*
Zipperposition format
*)

The languages supported by the Logic class.

val enum : (string * language) list

Enumeration of languages together with an appropriate name. Can be used for command-line arguments (for instance, with cmdliner).

val string_of_language : language -> string

String representation of the variant

High-level parsing

val find : ?language:language -> ?dir:string -> string -> string option

Tries and find the given file, using the language specification.

val parse_file : ?language:language -> string -> language * L.file * S.t list

Given a filename, parse the file, and return the detected language together with the list of statements parsed.

parameter language
specify a language; overrides auto-detection.

val parse_file_lazy : 
  ?language:language ->
  string ->
  language * L.file * S.t list Lazy.t

Given a filename, parse the file, and return the detected language together with the list of statements parsed.

parameter language
specify a language; overrides auto-detection.

val parse_input : 
  ?language:language ->
  [< `File of string
  | `Stdin of language
  | `Raw of string * language * string ] ->
  language * L.file * (unit -> S.t option) * (unit -> unit)

Incremental parsing of either a file (see parse_file), stdin (with given language), or some arbitrary contents, of the form `Raw (filename, language, contents). Returns a triplet (lan, gen, cl), containing the language detexted lan, a genratro function gen for parsing the input, and a cleanup function cl to call in order to cleanup the file descriptors.

parameter language
specify a language for parsing, overrides auto-detection and stdin specification.

Mid-level parsing

module type S =
  Dolmen_intf.Language.S with type statement := S.t and type file := L.file

The type of language modules.

val of_language : language -> language * string * (module S)

val of_extension : string -> language * string * (module S)

val of_filename : string -> language * string * (module S)

These function take as argument either a language, a filename, or an extension, and return a triple:

language
language file extension (starting with a dot)
appropriate parsing module

Extensions should start with a dot (for instance : ".smt2")

raises Extension_not_found
when the extension is not recognized.