Forest (p.forester.5.0.doc.forester.compiler.Forester

include module type of Forester_core.URI.Tbl

Sourcetype key = Forester_core.URI.t

Sourcetype !'a t = 'a Forester_core.URI.Tbl.t

Sourceval create : int -> 'a t

Sourceval clear : 'a t -> unit

Sourceval reset : 'a t -> unit

since 4.00

Sourceval copy : 'a t -> 'a t

Sourceval add : 'a t -> key -> 'a -> unit

Sourceval remove : 'a t -> key -> unit

Sourceval find : 'a t -> key -> 'a

Sourceval find_opt : 'a t -> key -> 'a option

since 4.05

Sourceval find_all : 'a t -> key -> 'a list

Sourceval replace : 'a t -> key -> 'a -> unit

Sourceval mem : 'a t -> key -> bool

Sourceval iter : (key -> 'a -> unit) -> 'a t -> unit

Sourceval filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit

since 4.03

Sourceval fold : (key -> 'a -> 'acc -> 'acc) -> 'a t -> 'acc -> 'acc

Sourceval length : 'a t -> int

Sourceval stats : 'a t -> Hashtbl.statistics

since 4.00

Sourceval to_seq : 'a t -> (key * 'a) Seq.t

since 4.07

Sourceval to_seq_keys : _ t -> key Seq.t

since 4.07

Sourceval to_seq_values : 'a t -> 'a Seq.t

since 4.07

Sourceval add_seq : 'a t -> (key * 'a) Seq.t -> unit

since 4.07

Sourceval replace_seq : 'a t -> (key * 'a) Seq.t -> unit

since 4.07

Sourceval of_seq : (key * 'a) Seq.t -> 'a t

since 4.07

Source

val analyse_resource : 
  (module Forester_core.Forest_graphs.S) ->
  Forester_core.Types.content Forester_core.Types.resource ->
  unit

analyse_resource graphs resource traverses resource, recording facts about it in graphs.

When encountering a Link, it adds an edge to the links_to relation in graphs.

When encountering a Transclude, it adds an edge to the transcludes relation in graphs.

When encountering a Datalog_script script, it runs the script and records the results in graphs.

Source

val get_article : 
  key ->
  Forester_core.Types.content Forester_core.Types.resource t ->
  Forester_core.Types.content Forester_core.Types.article option

Source

val run_datalog_query : 
  (module Forester_core.Forest_graphs.S) ->
  (string, Forester_core.Vertex.t) Forester_core.Datalog_expr.query ->
  Forester_core.Vertex_set.t

Source

val get_expanded_title : 
  ?scope:key ->
  ?flags:Forester_core.Types.title_flags ->
  Forester_core.Types.content Forester_core.Types.frontmatter ->
  Forester_core.Types.content Forester_core.Types.resource t ->
  Forester_core.Types.content

Source

val get_content_of_transclusion : 
  Forester_core.Types.transclusion ->
  Forester_core.Types.content Forester_core.Types.resource t ->
  Forester_core.Types.content option

Source

val get_title_or_content_of_vertex : 
  ?not_found:(key -> Forester_core.Types.content option) ->
  Forester_core.Types.content Forester_core.Types.vertex ->
  Forester_core.Types.content Forester_core.Types.resource t ->
  Forester_core.Types.content option

Source

val get_all_articles : 
  'a Forester_core.Types.resource t ->
  'a Forester_core.Types.article list

Source

val get_all_assets : 
  'a Forester_core.Types.resource t ->
  Forester_core.Types.asset list

Sourceval get_all_resources : 'a t -> 'a list