package dolmen_loop

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature
1. Pipes

package dolmen_loop

dolmen_loop
- Dolmen_loop
  - Code
  - Expr_intf
    
    S
  - Headers
    
    Field
    
    Pipe
    
    State
  - Headers_intf
    
    S
  - Logic
    
    S
    
    Lexer
    
    Parser
    
    Incremental
    
    MenhirInterpreter
  - Parser
    
    Pipe
    
    Expr
    
    State
  - Pipeline
    
    Make
    
    State
  - State
  - State_intf
    
    Header_pipe
    
    Parser_pipe
    
    Pipeline
    
    Typer
    
    Typer_pipe
  - Typer
    
    Make
    
    S
    
    Pipe
    
    Expr
    
    State
    
    Typer
    
    T
    
    T
    
    Const
    
    Cstr
    
    Field
    
    Var
    
    Tag
    
    Ty
    
    Const
    
    Var
  - Typer_intf
    
    Pipe_arg
    
    Pipe_res
    
    Pipe_types
    
    S

Legend:
Library
Module
Module type
Parameter
Class
Class type

This module provides convenient pipes for parsing and dealing with includes.

Parameters

module Expr : Expr_intf.S

module State : State_intf.Parser_pipe with type term := Expr.term

Signature

Pipes

val parse : 
  Dolmen.Std.Statement.t list ->
  State.t ->
  State.t * (State.t -> Dolmen.Std.Statement.t option)

Parsing function. Reads a list of prelude statements, and the state and returns a tuple of the new state (including the detected input language), together with a statement generator.

val expand : 
  State.t ->
  Dolmen.Std.Statement.t ->
  State.t
  * [ `Ok
    | `Gen of (State.t -> State.t -> State.t) * Dolmen.Std.Statement.t Gen.t ]

Expand statements (such as includes). Returns the new state, and either:

`Ok , which means the statement can be propagated as is
`Gen (flat, g) , if the statement expands into a generator g. The bool flat indicates wether the statements in g should be treated as a single group of statements (with regards to timeouts, etc...), or as a list of independant statements (each with its own timeout...).