(*
 * Copyright (c) 2013-2020 Thomas Gazagnaire <thomas@gazagnaire.org>
 * Copyright (c) 2013-2020 Anil Madhavapeddy <anil@recoil.org>
 * Copyright (c) 2015-2020 Gabriel Radanne <drupyog@zoho.com>
 *
 * 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.
 *)

(** Information about the final application. *)

type t
(** The type for information about the final application. *)

val config_file : t -> Fpath.t
(** [config_file t] is the configuration file of the application. *)

val name : t -> string
(** [name t] is the name of the application. *)

val project_name : t -> string
(** [project_name t] is the project name. *)

val main : t -> Fpath.t
(** [main t] is the name of the main application file. *)

val output : t -> string option
(** [output t] is the name of [t]'s output. Derived from {!name} if not set. *)

val with_output : t -> string -> t
(** [with_output t o] is similar to [t] but with the output set to [Some o]. *)

val libraries : t -> string list
(** [libraries t] are the direct OCamlfind dependencies. *)

val packages : t -> Package.t list
(** [packages t] are the opam package dependencies by the project. *)

val opam :
  t ->
  extra_repo:(string * string) list ->
  install:Install.t ->
  opam_name:string ->
  Opam.t
(** [opam scope t] is [t]'opam file to install in the [scope] context.*)

val keys : t -> Key.t list
(** [keys t] is the list of keys which can be used to configure [t]. *)

val runtime_args : t -> Runtime_arg.t list
(** [runtime_args t] is the list of command-line arguments which can be used to
    configure [t] at runtime. *)

val context : t -> Context.t
(** [parsed t] is a value representing the command-line argument being parsed.
*)

val get : t -> 'a Key.key -> 'a
(** [get i k] is the value associated with [k] in [context i]. *)

val v :
  ?config_file:Fpath.t ->
  packages:Package.t list ->
  local_libs:string list ->
  keys:Key.t list ->
  runtime_args:Runtime_arg.t list ->
  context:Context.t ->
  ?configure_cmd:string ->
  ?pre_build_cmd:(Fpath.t option -> string) ->
  ?lock_location:(Fpath.t option -> string -> string) ->
  build_cmd:(Fpath.t option -> string) ->
  src:[ `Auto | `None | `Some of string ] ->
  project_name:string ->
  string ->
  t
(** [create context n r] contains information about the application being built.
*)

val pp : bool -> t Fmt.t

(** {1 Devices} *)

val t : t Type.t