(*
 * Copyright (c) 2014 Leo White <lpw25@cl.cam.ac.uk>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *)

module Paths = Odoc_model.Paths

val cmti_builddir : string ref
val read_module_expr :
  (Cmi.env ->
  Paths.Identifier.Signature.t ->
  Paths.Identifier.LabelParent.t ->
  Typedtree.module_expr ->
  Odoc_model.Lang.ModuleType.expr)
  ref

val read_interface :
  Odoc_model.Paths.Identifier.ContainerPage.t option ->
  string ->
  warnings_tag:string option ->
  Typedtree.signature ->
  Paths.Identifier.RootModule.t
  * Odoc_model.Lang.Signature.t
  * Paths.Path.Module.t option
(** Returns [id, sg, canonical_path]. [canonical_path] is the path set from the
    [@canonical] tag. *)

val read_module_type :
  Cmi.env ->
  Paths.Identifier.Signature.t ->
  Paths.Identifier.LabelParent.t ->
  Typedtree.module_type ->
  Odoc_model.Lang.ModuleType.expr

val read_value_description :
  Cmi.env ->
  Paths.Identifier.Signature.t ->
  Typedtree.value_description ->
  Odoc_model.Lang.Signature.item

val read_type_declarations :
  Cmi.env ->
  Paths.Identifier.Signature.t ->
  Odoc_model.Lang.Signature.recursive ->
  Typedtree.type_declaration list ->
  Odoc_model.Lang.Signature.item list

val read_module_type_declaration :
  Cmi.env ->
  Paths.Identifier.Signature.t ->
  Typedtree.module_type_declaration ->
  Odoc_model.Lang.ModuleType.t

val read_class_type_declarations :
  Cmi.env ->
  Paths.Identifier.Signature.t ->
  Typedtree.class_type Typedtree.class_infos list ->
  Odoc_model.Lang.Signature.item list