Module `Odoc_xref2.Env`Source

Sourcetype lookup_unit_result =

| Forward_reference
| Found of Odoc_model.Lang.Compilation_unit.t

Sourcetype path_query = [

| `Path of Odoc_model.Paths.Reference.Hierarchy.t
| `Name of string

]

Sourcetype lookup_error = [

| `Not_found

]

Sourcetype resolver = {

open_units : string list;
lookup_unit : Odoc_xref2.Env.path_query -> (Odoc_xref2.Env.lookup_unit_result, Odoc_xref2.Env.lookup_error) Stdlib.result;
lookup_page : Odoc_xref2.Env.path_query -> (Odoc_model.Lang.Page.t, Odoc_xref2.Env.lookup_error) Stdlib.result;
lookup_asset : Odoc_xref2.Env.path_query -> (Odoc_model.Lang.Asset.t, Odoc_xref2.Env.lookup_error) Stdlib.result;
lookup_impl : string -> Odoc_model.Lang.Implementation.t option;

}

Sourcetype root =

| Resolved of Odoc_model.Root.t * Odoc_model.Paths.Identifier.Module.t * Odoc_xref2.Component.Module.t
| Forward

Sourcetype lookup_type =

| Module of Odoc_model.Paths.Identifier.Path.Module.t
| ModuleType of Odoc_model.Paths.Identifier.ModuleType.t
| RootModule of Odoc_model.Names.ModuleName.t * [ `Forward | `Resolved of Stdlib.Digest.t ] option
| ModuleByName of string * Odoc_model.Paths.Identifier.Path.Module.t
| FragmentRoot of int

module LookupTypeSet : Stdlib.Set.S with type elt = Odoc_xref2.Env.lookup_type

Source

val pp_lookup_type_list : 
  Stdlib.Format.formatter ->
  Odoc_xref2.Env.lookup_type list ->
  unit

Sourcetype t

Sourceval is_linking : Odoc_xref2.Env.t -> bool

Source

val with_recorded_lookups : 
  Odoc_xref2.Env.t ->
  (Odoc_xref2.Env.t -> 'a) ->
  Odoc_xref2.Env.LookupTypeSet.t * 'a

Source

val set_resolver : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.resolver ->
  Odoc_xref2.Env.t

Sourceval has_resolver : Odoc_xref2.Env.t -> bool

Sourceval id : Odoc_xref2.Env.t -> int

Sourceval empty : Odoc_xref2.Env.t

Source

val add_fragment_root : 
  Odoc_xref2.Component.Signature.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val add_module : 
  Odoc_model.Paths.Identifier.Path.Module.t ->
  Odoc_xref2.Component.Module.t Odoc_xref2.Component.Delayed.t ->
  Odoc_xref2.Component.CComment.docs ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val add_type : 
  Odoc_model.Paths.Identifier.Type.t ->
  Odoc_xref2.Component.TypeDecl.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val add_module_type : 
  Odoc_model.Paths.Identifier.Path.ModuleType.t ->
  Odoc_xref2.Component.ModuleType.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val add_value : 
  Odoc_model.Paths.Identifier.Value.t ->
  Odoc_xref2.Component.Value.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val add_label : 
  Odoc_model.Paths.Identifier.Label.t ->
  Odoc_xref2.Component.Label.t ->
  Odoc_xref2.Env.t ->
  unboxed:bool ->
  Odoc_xref2.Env.t

Source

val add_class : 
  Odoc_model.Paths.Identifier.Class.t ->
  Odoc_xref2.Component.Class.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val add_class_type : 
  Odoc_model.Paths.Identifier.ClassType.t ->
  Odoc_xref2.Component.ClassType.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val add_exception : 
  Odoc_model.Paths.Identifier.Exception.t ->
  Odoc_xref2.Component.Exception.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val add_extension_constructor : 
  Odoc_model.Paths.Identifier.Extension.t ->
  Odoc_xref2.Component.Extension.Constructor.t ->
  Odoc_xref2.Component.Extension.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Sourceval add_docs : Odoc_model.Comment.docs -> Odoc_xref2.Env.t -> Odoc_xref2.Env.t

Source

val add_comment : 
  Odoc_model.Comment.docs_or_stop ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val add_method : 
  Odoc_model.Paths.Identifier.Method.t ->
  Odoc_xref2.Component.Method.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val add_module_functor_args : 
  Odoc_xref2.Component.Module.t ->
  Odoc_model.Paths.Identifier.Path.Module.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val add_module_type_functor_args : 
  Odoc_xref2.Component.ModuleType.t ->
  Odoc_model.Paths.Identifier.ModuleType.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val lookup_fragment_root : 
  Odoc_xref2.Env.t ->
  (int * Odoc_xref2.Component.Signature.t) option

Source

val lookup_page_by_name : 
  string ->
  Odoc_xref2.Env.t ->
  (Odoc_model.Lang.Page.t, Odoc_xref2.Env.lookup_error) Stdlib.result

Source

val lookup_page_by_path : 
  Odoc_model.Paths.Reference.Hierarchy.t ->
  Odoc_xref2.Env.t ->
  (Odoc_model.Lang.Page.t, Odoc_xref2.Env.lookup_error) Stdlib.result

Source

val lookup_asset_by_path : 
  Odoc_model.Paths.Reference.Hierarchy.t ->
  Odoc_xref2.Env.t ->
  (Odoc_model.Lang.Asset.t, Odoc_xref2.Env.lookup_error) Stdlib.result

Source

val lookup_asset_by_name : 
  string ->
  Odoc_xref2.Env.t ->
  (Odoc_model.Lang.Asset.t, Odoc_xref2.Env.lookup_error) Stdlib.result

Source

val lookup_impl : 
  string ->
  Odoc_xref2.Env.t ->
  Odoc_model.Lang.Implementation.t option

Source

val lookup_unit_by_path : 
  Odoc_model.Paths.Reference.Hierarchy.t ->
  Odoc_xref2.Env.t ->
  (Odoc_xref2.Component.Element.module_, Odoc_xref2.Env.lookup_error)
    Stdlib.result

Source

val module_of_unit : 
  Odoc_model.Lang.Compilation_unit.t ->
  Odoc_xref2.Component.Module.t

Source

val lookup_root_module : 
  Odoc_model.Names.ModuleName.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.root option

Sourcetype 'a scope constraint 'a = [< Odoc_xref2.Component.Element.any ]

Target of a lookup

Source

type 'a maybe_ambiguous =
  ('a, [ `Ambiguous of 'a * 'a list | `Not_found ]) Stdlib.result

Source

val lookup_by_name : 
  'a Odoc_xref2.Env.scope ->
  string ->
  Odoc_xref2.Env.t ->
  'a Odoc_xref2.Env.maybe_ambiguous

Lookup an element in Env depending on the given scope. Return Error (`Ambiguous _) when two or more elements match the given scope and name.

Source

val lookup_by_id : 
  'a Odoc_xref2.Env.scope ->
  [< Odoc_model.Paths.Identifier.t_pv ] Odoc_model.Paths.Identifier.id ->
  Odoc_xref2.Env.t ->
  'a option

Like lookup_by_name but use an identifier as key.

Sourceval s_any : Odoc_xref2.Component.Element.any Odoc_xref2.Env.scope

Sourceval s_signature : Odoc_xref2.Component.Element.signature Odoc_xref2.Env.scope

Sourceval s_module : Odoc_xref2.Component.Element.module_ Odoc_xref2.Env.scope

Source

val s_module_type : 
  Odoc_xref2.Component.Element.module_type Odoc_xref2.Env.scope

Sourceval s_type : Odoc_xref2.Component.Element.type_ Odoc_xref2.Env.scope

Sourceval s_datatype : Odoc_xref2.Component.Element.datatype Odoc_xref2.Env.scope

Sourceval s_class : Odoc_xref2.Component.Element.class_ Odoc_xref2.Env.scope

Sourceval s_class_type : Odoc_xref2.Component.Element.class_type Odoc_xref2.Env.scope

Sourceval s_value : Odoc_xref2.Component.Element.value Odoc_xref2.Env.scope

Sourceval s_label : Odoc_xref2.Component.Element.label Odoc_xref2.Env.scope

Source

val s_constructor : 
  Odoc_xref2.Component.Element.constructor Odoc_xref2.Env.scope

Sourceval s_exception : Odoc_xref2.Component.Element.exception_ Odoc_xref2.Env.scope

Sourceval s_extension : Odoc_xref2.Component.Element.extension Odoc_xref2.Env.scope

Sourceval s_field : Odoc_xref2.Component.Element.field Odoc_xref2.Env.scope

Source

val s_unboxed_field : 
  Odoc_xref2.Component.Element.unboxed_field Odoc_xref2.Env.scope

Source

val s_label_parent : 
  Odoc_xref2.Component.Element.label_parent Odoc_xref2.Env.scope

Source

val s_fragment_type_parent : 
  Odoc_xref2.Component.Element.fragment_type_parent Odoc_xref2.Env.scope

Source

val add_functor_parameter : 
  Odoc_model.Lang.FunctorParameter.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val open_class_signature : 
  Odoc_model.Lang.ClassSignature.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val open_signature : 
  Odoc_model.Lang.Signature.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val open_type_substitution : 
  Odoc_model.Lang.TypeDecl.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val open_module_substitution : 
  Odoc_model.Lang.ModuleSubstitution.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Source

val open_module_type_substitution : 
  Odoc_model.Lang.ModuleTypeSubstitution.t ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Env.t

Sourceval open_page : Odoc_model.Lang.Page.t -> Odoc_xref2.Env.t -> Odoc_xref2.Env.t

Add a page content to the env.

Source

val env_of_unit : 
  Odoc_model.Lang.Compilation_unit.t ->
  linking:bool ->
  Odoc_xref2.Env.resolver ->
  Odoc_xref2.Env.t

Create a new env with a module initially opened.

Source

val env_of_page : 
  Odoc_model.Lang.Page.t ->
  Odoc_xref2.Env.resolver ->
  Odoc_xref2.Env.t

Create a new env for a page.

Source

val env_of_impl : 
  Odoc_model.Lang.Implementation.t ->
  Odoc_xref2.Env.resolver ->
  Odoc_xref2.Env.t

Create a new env for an implementation.

Sourceval env_for_reference : Odoc_xref2.Env.resolver -> Odoc_xref2.Env.t

Create a new env for a reference.

Sourceval env_for_testing : linking:bool -> Odoc_xref2.Env.t

Create a new env for testing purposes

Sourceval inherit_resolver : Odoc_xref2.Env.t -> Odoc_xref2.Env.t

Create an empty environment reusing the same resolver.

Sourceval len : int Stdlib.ref

Sourceval n : int Stdlib.ref

Sourceval should_suppress_warnings : Odoc_xref2.Env.t -> string option -> bool

Sourceval set_warnings_tags : Odoc_xref2.Env.t -> string list -> Odoc_xref2.Env.t

Sourceval verify_lookups : Odoc_xref2.Env.t -> Odoc_xref2.Env.LookupTypeSet.t -> bool

Module Odoc_xref2.EnvSource

Module `Odoc_xref2.Env`Source