forester 4.2.0 · OCaml Package

module MethodTable : sig ... end

module Text_modifier : sig ... end

type modifier = Text_modifier.t

val pp_modifier : 
  Ppx_deriving_runtime.Format.formatter ->
  Text_modifier.t ->
  Ppx_deriving_runtime.unit

type node =

| Text of string
| Verbatim of string
| Transclude of transclusion_opts * Base.addr
| Subtree of transclusion_opts * tree
| Query_tree of transclusion_opts * query
| Link of Base.addr * t option * modifier
| Xml_tag of Base.xml_resolved_qname * (Base.xml_resolved_qname * t) list * t
| TeX_cs of TeX_cs.t
| Math of Base.math_mode * t
| Embed_tex of embedded_tex
| Img of string
| Prim of Prim.t * t
| Ref of Base.addr

and embedded_tex = {

preamble : t;
source : t;

}

and transclusion_opts = {

toc : bool;
show_heading : bool;
show_metadata : bool;
title_override : t option;
taxon_override : string option;
expanded : bool;
numbered : bool;

}

and t = node Range.located list

and tree = {

fm : frontmatter;
bm : backmatter_section list;
body : t;

}

and frontmatter = {

title : t option;
taxon : string option;
authors : Base.addr list;
contributors : Base.addr list;
dates : Forester_prelude.Date.t list;
addr : Base.addr;
metas : (string * t) list;
tags : string list;
physical_parent : Base.addr option;
designated_parent : Base.addr option;
source_path : string option;
number : string option;

}

and backmatter_section =

| Backmatter_section of {
1. title : t;
2. query : query;
}

and value =

| VContent of t
| VQuery_polarity of Query.polarity
| VQuery_mode of Query.mode
| VQuery of query
| VSym of Symbol.t
| VObject of Symbol.t
| VAddr of Base.addr

and query =

| Rel of Query.rel_query * Base.addr
| Isect of query list
| Union of query list
| Complement of query
| Isect_fam of query * query_clo
| Union_fam of query * query_clo

and query_clo =

| QClo_rel of Query.rel_query

val pp_node : 
  Ppx_deriving_runtime.Format.formatter ->
  node ->
  Ppx_deriving_runtime.unit

val show_node : node -> Ppx_deriving_runtime.string

val pp_embedded_tex : 
  Ppx_deriving_runtime.Format.formatter ->
  embedded_tex ->
  Ppx_deriving_runtime.unit

val show_embedded_tex : embedded_tex -> Ppx_deriving_runtime.string

val pp_transclusion_opts : 
  Ppx_deriving_runtime.Format.formatter ->
  transclusion_opts ->
  Ppx_deriving_runtime.unit

val show_transclusion_opts : transclusion_opts -> Ppx_deriving_runtime.string

val pp : 
  Ppx_deriving_runtime.Format.formatter ->
  t ->
  Ppx_deriving_runtime.unit

val show : t -> Ppx_deriving_runtime.string

val pp_tree : 
  Ppx_deriving_runtime.Format.formatter ->
  tree ->
  Ppx_deriving_runtime.unit

val show_tree : tree -> Ppx_deriving_runtime.string

val pp_frontmatter : 
  Ppx_deriving_runtime.Format.formatter ->
  frontmatter ->
  Ppx_deriving_runtime.unit

val show_frontmatter : frontmatter -> Ppx_deriving_runtime.string

val pp_backmatter_section : 
  Ppx_deriving_runtime.Format.formatter ->
  backmatter_section ->
  Ppx_deriving_runtime.unit

val show_backmatter_section : backmatter_section -> Ppx_deriving_runtime.string

val pp_value : 
  Ppx_deriving_runtime.Format.formatter ->
  value ->
  Ppx_deriving_runtime.unit

val show_value : value -> Ppx_deriving_runtime.string

val pp_query : 
  Ppx_deriving_runtime.Format.formatter ->
  query ->
  Ppx_deriving_runtime.unit

val show_query : query -> Ppx_deriving_runtime.string

val pp_query_clo : 
  Ppx_deriving_runtime.Format.formatter ->
  query_clo ->
  Ppx_deriving_runtime.unit

val show_query_clo : query_clo -> Ppx_deriving_runtime.string

type obj_method = {

body : Syn.t;
self : Symbol.t;
super : Symbol.t;
env : value Stdlib__Map.Make(Symbol).t;

}

type obj = {

prototype : Symbol.t option;
methods : obj_method MethodTable.t;

}

val is_whitespace : node Range.located -> bool

val strip_whitespace : node Range.located list -> node Range.located list

val trim_whitespace : node Range.located list -> node Range.located list

val sentence_case : node Range.located list -> node Range.located list

val apply_modifier : 
  Text_modifier.t ->
  node Range.located list ->
  node Range.located list

val string_of_nodes : t -> string

Best-effort rendering of a nodes as a string, to use in text-only contexts.

module Util : sig ... end

module Query : sig ... end

val empty_frontmatter : addr:Base.addr -> frontmatter

val default_backmatter : addr:Base.addr -> backmatter_section list

val empty_tree : addr:Base.addr -> tree

val default_transclusion_opts : transclusion_opts

val extract_content : value Range.located -> t

val extract_query_clo : value Range.located -> query_clo

val extract_string : value Range.located -> string

val extract_obj_ptr : value Range.located -> Symbol.t

val extract_sym : value Range.located -> Symbol.t

val extract_query_node : value Range.located -> query

val extract_query_polarity : value Range.located -> Query.polarity

val extract_query_mode : value Range.located -> Query.mode

val extract_addr : value Range.located -> Base.addr

package forester