Tools (odoc.Odoc_xref2.Tools)

type expansion =

| Signature of Odoc_xref2.Component.Signature.t
| Functor of Odoc_xref2.Component.FunctorParameter.t * Odoc_xref2.Component.ModuleType.expr

val lookup_module : 
  mark_substituted:bool ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.Resolved.module_ ->
  (Odoc_xref2.Component.Module.t Odoc_xref2.Component.Delayed.t,
    Odoc_xref2.Errors.Tools_error.simple_module_lookup_error)
    Result.result

val lookup_module_type : 
  mark_substituted:bool ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.Resolved.module_type ->
  (Odoc_xref2.Component.ModuleType.t,
    Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error)
    Result.result

val lookup_type : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.Resolved.type_ ->
  (Odoc_xref2.Find.careful_type,
    Odoc_xref2.Errors.Tools_error.simple_type_lookup_error)
    Result.result

val lookup_class_type : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.Resolved.class_type ->
  (Odoc_xref2.Find.careful_class,
    Odoc_xref2.Errors.Tools_error.simple_type_lookup_error)
    Result.result

val resolve_module : 
  mark_substituted:bool ->
  add_canonical:bool ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.module_ ->
  (Odoc_xref2.Cpath.Resolved.module_
   * Odoc_xref2.Component.Module.t Odoc_xref2.Component.Delayed.t,
    Odoc_xref2.Errors.Tools_error.simple_module_lookup_error)
    Result.result

val resolve_module_type : 
  mark_substituted:bool ->
  add_canonical:bool ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.module_type ->
  (Odoc_xref2.Cpath.Resolved.module_type * Odoc_xref2.Component.ModuleType.t,
    Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error)
    Result.result

val resolve_type : 
  Odoc_xref2.Env.t ->
  add_canonical:bool ->
  Odoc_xref2.Cpath.type_ ->
  (Odoc_xref2.Cpath.Resolved.type_ * Odoc_xref2.Find.careful_type,
    Odoc_xref2.Errors.Tools_error.simple_type_lookup_error)
    Result.result

val resolve_class_type : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.class_type ->
  (Odoc_xref2.Cpath.Resolved.class_type * Odoc_xref2.Find.careful_class,
    Odoc_xref2.Errors.Tools_error.simple_type_lookup_error)
    Result.result

val resolve_module_path : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.module_ ->
  (Odoc_xref2.Cpath.Resolved.module_,
    Odoc_xref2.Errors.Tools_error.simple_module_lookup_error)
    Result.result

val resolve_module_type_path : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.module_type ->
  (Odoc_xref2.Cpath.Resolved.module_type,
    Odoc_xref2.Errors.Tools_error.simple_module_type_lookup_error)
    Result.result

val resolve_type_path : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.type_ ->
  (Odoc_xref2.Cpath.Resolved.type_,
    Odoc_xref2.Errors.Tools_error.simple_type_lookup_error)
    Result.result

val resolve_value_path : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.value ->
  (Odoc_xref2.Cpath.Resolved.value,
    Odoc_xref2.Errors.Tools_error.simple_value_lookup_error)
    Result.result

val resolve_constructor_path : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.constructor ->
  (Odoc_xref2.Cpath.Resolved.constructor,
    Odoc_xref2.Errors.Tools_error.simple_constructor_lookup_error)
    Result.result

val resolve_class_type_path : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.class_type ->
  (Odoc_xref2.Cpath.Resolved.class_type,
    Odoc_xref2.Errors.Tools_error.simple_type_lookup_error)
    Result.result

val reresolve_module : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.Resolved.module_ ->
  Odoc_xref2.Cpath.Resolved.module_

val reresolve_module_type : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.Resolved.module_type ->
  Odoc_xref2.Cpath.Resolved.module_type

val reresolve_type : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.Resolved.type_ ->
  Odoc_xref2.Cpath.Resolved.type_

val reresolve_constructor : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.Resolved.constructor ->
  Odoc_xref2.Cpath.Resolved.constructor

val reresolve_value : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.Resolved.value ->
  Odoc_xref2.Cpath.Resolved.value

val reresolve_class_type : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.Resolved.class_type ->
  Odoc_xref2.Cpath.Resolved.class_type

val reresolve_parent : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cpath.Resolved.parent ->
  Odoc_xref2.Cpath.Resolved.parent

val handle_module_type_lookup : 
  Odoc_xref2.Env.t ->
  add_canonical:bool ->
  string ->
  Odoc_xref2.Cpath.Resolved.parent ->
  Odoc_xref2.Component.Signature.t ->
  Odoc_xref2.Component.Substitution.t ->
  (Odoc_xref2.Cpath.Resolved.module_type * Odoc_xref2.Component.ModuleType.t)
    option

type module_modifiers = [

| `Aliased of Odoc_xref2.Cpath.Resolved.module_
| `SubstMT of Odoc_xref2.Cpath.Resolved.module_type

]

type module_type_modifiers = [

| `AliasModuleType of Odoc_xref2.Cpath.Resolved.module_type

]

val get_module_path_modifiers : 
  Odoc_xref2.Env.t ->
  add_canonical:bool ->
  Odoc_xref2.Component.Module.t ->
  module_modifiers option

val get_module_type_path_modifiers : 
  Odoc_xref2.Env.t ->
  add_canonical:bool ->
  Odoc_xref2.Component.ModuleType.t ->
  module_type_modifiers option

val prefix_signature : 
  (Odoc_xref2.Cpath.Resolved.parent * Odoc_xref2.Component.Signature.t) ->
  Odoc_xref2.Component.Signature.t

val assert_not_functor : 
  expansion ->
  (Odoc_xref2.Component.Signature.t, 'err) Result.result

val expansion_of_module_path : 
  Odoc_xref2.Env.t ->
  strengthen:bool ->
  Odoc_xref2.Cpath.module_ ->
  (expansion, Odoc_xref2.Errors.Tools_error.expansion_of_module_error)
    Result.result

val expansion_of_module : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Component.Module.t ->
  (expansion, Odoc_xref2.Errors.Tools_error.expansion_of_module_error)
    Result.result

val expansion_of_module_type : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Component.ModuleType.t ->
  (expansion, Odoc_xref2.Errors.Tools_error.expansion_of_module_error)
    Result.result

val class_signature_of_class_type : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Component.ClassType.t ->
  Odoc_xref2.Component.ClassSignature.t option

val class_signature_of_class : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Component.Class.t ->
  Odoc_xref2.Component.ClassSignature.t option

val expansion_of_module_type_expr : 
  mark_substituted:bool ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Component.ModuleType.expr ->
  (expansion, Odoc_xref2.Errors.Tools_error.expansion_of_module_error)
    Result.result

val signature_of_u_module_type_expr : 
  mark_substituted:bool ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Component.ModuleType.U.expr ->
  (Odoc_xref2.Component.Signature.t,
    Odoc_xref2.Errors.Tools_error.expansion_of_module_error)
    Result.result

val resolve_module_fragment : 
  Odoc_xref2.Env.t ->
  (Odoc_xref2.Cfrag.root * Odoc_xref2.Component.Signature.t) ->
  Odoc_xref2.Cfrag.module_ ->
  Odoc_xref2.Cfrag.resolved_module option

val resolve_module_type_fragment : 
  Odoc_xref2.Env.t ->
  (Odoc_xref2.Cfrag.root * Odoc_xref2.Component.Signature.t) ->
  Odoc_xref2.Cfrag.module_type ->
  Odoc_xref2.Cfrag.resolved_module_type option

val resolve_type_fragment : 
  Odoc_xref2.Env.t ->
  (Odoc_xref2.Cfrag.root * Odoc_xref2.Component.Signature.t) ->
  Odoc_xref2.Cfrag.type_ ->
  Odoc_xref2.Cfrag.resolved_type option

val reresolve_module_fragment : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cfrag.resolved_module ->
  Odoc_xref2.Cfrag.resolved_module

val reresolve_type_fragment : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cfrag.resolved_type ->
  Odoc_xref2.Cfrag.resolved_type

val reresolve_module_type_fragment : 
  Odoc_xref2.Env.t ->
  Odoc_xref2.Cfrag.resolved_module_type ->
  Odoc_xref2.Cfrag.resolved_module_type

val fragmap : 
  mark_substituted:bool ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Component.ModuleType.substitution ->
  Odoc_xref2.Component.Signature.t ->
  (Odoc_xref2.Component.Signature.t,
    Odoc_xref2.Errors.Tools_error.expansion_of_module_error)
    Result.result

val handle_signature_with_subs : 
  mark_substituted:bool ->
  Odoc_xref2.Env.t ->
  Odoc_xref2.Component.Signature.t ->
  Odoc_xref2.Component.ModuleType.substitution list ->
  (Odoc_xref2.Component.Signature.t,
    Odoc_xref2.Errors.Tools_error.expansion_of_module_error)
    Result.result

val reset_caches : unit -> unit

val disable_all_caches : unit -> unit