(** Representation of dune-package files.

    dune-package files record package data for the purposes of installation.
    They are not intended to be written or read by human users. *)

open Import

(** The filename of a dune-package file*)
val fn : string

module External_location : sig
  type t =
    | Relative_to_stdlib of Path.Local.t
    | Relative_to_findlib of (Path.t * Path.Local.t)
    | Absolute of Path.t

  val to_dyn : t Dyn.builder
  val compare : t -> t -> Ordering.t
  val hash : t -> int
end

module Lib : sig
  type t

  val info : t -> Path.t Lib_info.t
  val external_location : t -> External_location.t option
  val of_findlib : Path.t Lib_info.t -> External_location.t -> t
  val of_dune_lib : info:Path.t Lib_info.t -> main_module_name:Module_name.t option -> t
  val to_dyn : t Dyn.builder
end

module Deprecated_library_name : sig
  type t =
    { loc : Loc.t
    ; old_public_name : Lib_name.t
    ; new_public_name : Lib_name.t
    }

  val to_dyn : t Dyn.builder
end

module Entry : sig
  type t =
    | Library of Lib.t
    | Deprecated_library_name of Deprecated_library_name.t
    | Hidden_library of Lib.t
    (** Only for external libraries that:

        - are not built with dune

        - have a [META] file with an unsatisfied [exists_if] field

        Dune itself never produces hidden libraries. *)

  val name : t -> Lib_name.t
  val version : t -> Package_version.t option
  val loc : t -> Loc.t
  val to_dyn : t Dyn.builder
end

type path = [ `File | `Dir ] * Install.Entry.Dst.t

type t =
  { name : Package.Name.t
  ; entries : Entry.t Lib_name.Map.t
  ; version : Package_version.t option
  ; sections : Path.t Section.Map.t
  ; sites : Section.t Site.Map.t
  ; dir : Path.t
  ; files : (Section.t * path list) list
  }

type replace_info

(** Replace sections by the external paths for sites to refer to them.
    It saves some information that needs to be passed to [Or_meta.pp] using
    [~encoding:Absolute info]. *)
val replace_site_sections
  :  t
  -> get_location:(Section.t -> Package.Name.t -> Path.t)
  -> t * replace_info

val to_dyn : t Dyn.builder

type encoding =
  | Absolute of replace_info
  | Relative

module Or_meta : sig
  type nonrec t =
    | Use_meta
    | Dune_package of t

  val pp
    :  encoding:encoding
    -> dune_version:Dune_lang.Syntax.Version.t
    -> Format.formatter
    -> t
    -> unit

  val pp_use_meta : dune_version:Dune_lang.Syntax.Version.t -> Format.formatter -> unit
  val parse : Path.t -> Lexbuf.t -> (t, User_message.t) result
  val load : Path.t -> (t, User_message.t) result Memo.t
  val to_dyn : t Dyn.builder
end
