package shexp

You can search for identifiers within the package.

in-package search v0.2.0

shexp.bigstring
- Shexp_bigstring
  - Bigstring
  - Std
shexp.bigstring-io
- Shexp_bigstring_io
  - Bigstring
  - Std
shexp.process
- Shexp_process
  - Background_command
  - Context
    
    Working_dir
  - Debugger
  - Exit_status
  - Infix
  - Let_syntax
    
    Let_syntax
    
    Open_on_rhs
  - List
  - Logged
  - Prim
    
    Args
  - Std
    
    Process
    
    Background_command
    
    Context
    
    Working_dir
    
    Debugger
    
    Infix
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    List
    
    Logged
    
    Prim
    
    Args
    
    Traced
    
    With_debug
    
    Dbg
  - Std_io
  - Traced
  - With_debug
    
    Dbg
shexp.sexp
- Shexp_sexp
  - Sexp
  - Std

Legend:
Library
Module
Module type
Parameter
Class
Class type

shexp_process allows one to plug a debugger in the evaluator. Logged and Traced are essentially two non-interactive debuggers.

type t

type ('a, 'b) prim_token

val before_prim : 
  t ->
  ('a, 'b) Prim.t ->
  ('a, 'b) Prim.Args.t ->
  ('a, 'b) prim_token

Called before the execution of a primitive. The S-expression is a representation of the primitive call, for instance (mkdir "foo").

val after_prim : 
  t ->
  ('a, 'b) Prim.t ->
  ('b, exn * Printexc.raw_backtrace) result ->
  ('a, 'b) prim_token ->
  unit

Called after the execution of a primitive, with the result.

val user_exn : t -> exn -> Printexc.raw_backtrace -> unit

Register a user exception, i.e. when a bind raises.

val output : t -> string -> unit

Captured output

val fork : t -> t * t

Called before forking.

val end_fork : t -> t -> t -> unit

Called in the same thread that started the fork.

val enter_sub : t -> unit

Shexp tries to linearize the trace as much as possible. When an execution parameter is changed locally, such as in (chdir ...) >>= ..., a sub context is entered.

val leave_sub : t -> unit

val force_threads : bool

Force the use of threads in all forks, even when Shexp_process detect they are not necessary.