Module `Forester_compiler.State`Source

Sourcetype resource = Forester_core.Types.content Forester_core.Types.resource

Sourcetype t = {

env : Eio_unix.Stdenv.base;
dev : bool;
config : Forester_core.Config.t;
index : Forester_core.Tree.t Forester_core.URI.Tbl.t;
diagnostics : Forester_core.Reporter.Message.t Asai.Diagnostic.t list Forester_core.URI.Tbl.t;
graphs : (module Forester_core.Forest_graphs.S);
import_graph : Forester_core.Forest_graph.t;
dependency_cache : Cache.t;
resolver : string Forester_core.URI.Tbl.t;
search_index : Forester_search.Index.t;
usages : (Forester_core.Tree.exports, Forester_core.URI.t Asai.Range.located) Hashtbl.t;
history : Action.t list;
hosts : (string, unit) Hashtbl.t;
suggestions : Forester_core.URI.t Forester_core.URI.Tbl.t;

}

val make : 
  env:Eio_unix.Stdenv.base ->
  config:Forester_core.Config.t ->
  dev:bool ->
  ?graphs:(module Forester_core.Forest_graphs.S) ->
  ?import_graph:Forester_core.Forest_graph.t ->
  ?resolver:string Forester_core.URI.Tbl.t ->
  ?index:Forester_core.Tree.t Forester_core.URI.Tbl.t ->
  ?diagnostics:
    Forester_core.Reporter.Message.t Asai.Diagnostic.t list
      Forester_core.URI.Tbl.t ->
  ?usages:
    (Forester_core.Tree.exports, Forester_core.URI.t Asai.Range.located)
      Hashtbl.t ->
  ?search_index:Forester_search.Index.t ->
  ?dependency_cache:Cache.t ->
  ?hosts:(string, unit) Hashtbl.t ->
  ?suggestions:Forester_core.URI.t Forester_core.URI.Tbl.t ->
  unit ->
  t

Sourcemodule Syntax : sig ... end

Sourceval update_history : t -> Action.t -> t

Sourceval find_opt : t -> Forester_core.URI.Tbl.key -> Forester_core.Tree.t option

Sourceval to_seq : t -> (Forester_core.URI.Tbl.key * Forester_core.Tree.t) Seq.t

Sourceval get_all_unparsed : t -> Forester_core.Tree.t Seq.t

Sourceval get_all_code : t -> Forester_core.Tree.code Seq.t

Sourceval get_all_unexpanded : t -> Forester_core.Tree.t Seq.t

Sourceval get_all_expanded : t -> Forester_core.Tree.syn Seq.t

Sourceval get_all_unevaluated : t -> Forester_core.Tree.t Seq.t

Source

val get_all_articles : 
  t ->
  Forester_core.Types.content Forester_core.Types.article Seq.t

Sourceval get_all_evaluated : t -> Forester_core.Tree.evaluated Seq.t

Source

val get_all_resources : 
  t ->
  Forester_core.Types.content Forester_core.Types.resource Seq.t

Source

val get_resource : 
  t ->
  Forester_core.URI.Tbl.key ->
  Forester_core__Types.content Forester_core__Types.resource option

Sourceval get_code : t -> Forester_core.URI.Tbl.key -> Forester_core.Tree.code option

Source

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

Sourceval section_symbol : string

Source

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

Source

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

Source

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

Sourceval wrong_variants_for_uri : Forester_core.URI.t -> Forester_core.URI.t list

Sourcetype uri_suggestion =

| Ok
| Not_found of {
1. suggestion : Forester_core.URI.t option;
}

Sourceval suggestion_for_uri : Forester_core.URI.t -> t -> uri_suggestion

Source

val plant_resource : 
  ?route_locally:bool ->
  Forester_core.Types.content Forester_core.Types.resource ->
  t ->
  unit

Source

val serialize_graphs : 
  (module Forester_core.Forest_graphs.S) ->
  Forester_core.Datalog_engine.db

Sourceval batch_write : t -> Cache.t

Source

val reconstruct : 
  env:'a ->
  _config:Forester_core.Config.t ->
  'b Seq.t ->
  t ->
  unit

Sourceval source_path_of_uri : Forester_core.URI.t -> t -> string option

Sourceval source_path_of_origin : Forester_core.origin -> t -> string option

Sourceval source_path_of_identity : Forester_core.identity -> t -> string option

Install

Dune Dependency

Authors

Maintainers

Sources

doc/forester.compiler/Forester_compiler/State/index.html

Module `Forester_compiler.State`Source

package forester

Install

Dune Dependency

Authors

Maintainers

Sources

doc/forester.compiler/Forester_compiler/State/index.html

Module Forester_compiler.StateSource

Module `Forester_compiler.State`Source