package forester

You can search for identifiers within the package.

in-package search v0.2.0

package forester

forester.core
- Forester_core
  - Addr
  - BaseN
    
    Base36
    
    I
    
    Make
    
    _
    
    S
  - Code
  - Eval
  - Expand
    
    Builtins
    
    Transclude
    
    UnitMap
  - Prim
  - Query
  - Range
  - Reporter
    
    Message
  - Resolver
    
    P
    
    Scope
    
    Perform
    
    Silence
  - Sem
    
    MethodTable
    
    Query
    
    Text_modifier
    
    Util
  - Symbol
  - Syn
  - TeX_cs
forester.frontend
- Forester_frontend
  - Analysis
    
    Gph
    
    Map
    
    Tbl
    
    Topo
  - Build_latex
  - Config
    
    Forest_config
  - Forest
  - Grammar
    
    Incremental
    
    MenhirInterpreter
  - LaTeX_queue
    
    Make
    
    S
  - LaTeX_template
  - Lexer
  - Parse
forester.prelude
- Forester_prelude
  - Compare
  - Date
  - Eio_util
    
    NullSink
  - Printer_kit
    
    Kit
    
    P
    
    S
    
    S0
  - String_util
forester.render
- Forester_render
  - Dream_forester
  - Dream_html_lite
    
    Aria
    
    HTML
    
    Hx
    
    MathML
    
    SVG
  - Render_TeX_like
    
    Printer
  - Render_dream
    
    Addr_map
    
    Ancestors
    
    Current_addr
    
    Mainmatter_cache
    
    String_map
    
    Xmlns_map
    
    Xmlns_prefixes
  - Render_effect
    
    Handler
    
    Perform
    
    Run
    
    _
  - Render_json
  - Render_text
    
    Printer
  - Render_util

Legend:
Library
Module
Module type
Parameter
Class
Class type

type config = {

env : Eio_unix.Stdenv.base;
assets_dirs : Eio.Fs.dir_ty Eio.Path.t list;
theme_dir : Eio.Fs.dir_ty Eio.Path.t;
root : string option;
base_url : string option;
stylesheet : string;
ignore_tex_cache : bool;
no_assets : bool;
no_theme : bool;
max_fibers : int;

}

type raw_forest = Forester_core.Code.tree list

type forest = {

trees : Forester_core.Sem.tree Analysis.Map.t;
analysis : Analysis.analysis Lazy.t;

}

val plant_forest : raw_forest -> forest

val render_trees : 
  cfg:config ->
  forest:forest ->
  render_only:Forester_core.addr list option ->
  unit

val create_tree : 
  cfg:config ->
  addrs:string Seq.t ->
  dest:Eio.Fs.dir_ty Eio.Path.t ->
  prefix:string ->
  template:string option ->
  mode:[ `Sequential | `Random ] ->
  string

val complete : forest:forest -> string -> (string * string) Seq.t

val taxa : forest:forest -> (string * string) Seq.t

val tags : forest:forest -> (string * string list) Seq.t

val run_renderer : cfg:config -> forest -> (unit -> 'a) -> 'a

val render_json : 
  cwd:[> Eio.Fs.dir_ty ] Eio.Path.t ->
  Forester_core.Sem.tree Analysis.Map.t ->
  unit