package functoria

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

package functoria

functoria
- Functoria
  - ImplTbl
  - Info
  - KEY
  - base_configurable
  - configurable
  - foreign
- Functoria_key
  - Alias
  - Arg
  - Set
functoria.app
- Functoria_app
  - Cmd
    
    OCamlfind
  - Codegen
  - DSL
    
    base_configurable
    
    configurable
    
    foreign
  - Log
  - Make
    
    P
  - Name
  - S
functoria.runtime
- Functoria_info
- Functoria_runtime
  - Arg
  - Key

Legend:
Library
Module
Module type
Parameter
Class
Class type

Make is an helper to generate new a application builder with the custom constructs defined by S.

Parameters

module P : S

Signature

val register : 
  ?packages:string list ->
  ?libraries:string list ->
  ?keys:Functoria.key list ->
  ?init:Functoria.job Functoria.impl list ->
  string ->
  Functoria.job Functoria.impl list ->
  unit

register name jobs registers the application named by name which will executes the given jobs. Same optinal arguments as Functoria.foreign.

init is the list of job to execute before anything else (such as command-line argument parsing, log reporter setup, etc.). The jobs are always executed in the sequence specified by the caller.

val get_base_context : unit -> Functoria.context

get_base_context () returns a subset of the parsed keys which are part of the base configuration of the DSL. This functions should be avoided as it exposes the internal parsing context.

deprecated
Use the regular key mechanism.

val run : unit -> unit

Run the application builder. This should be called exactly once to run the application builder: command-line argument will be parsed, and some code will be generated and compiled.