(************************************************************************)
(*         *      The Rocq Prover / The Rocq Development Team           *)
(*  v      *         Copyright INRIA, CNRS and contributors             *)
(* <O___,, * (see version control and CREDITS file for authors & dates) *)
(*   \VV/  **************************************************************)
(*    //   *    This file is distributed under the terms of the         *)
(*         *     GNU Lesser General Public License Version 2.1          *)
(*         *     (see LICENSE file for the text of the license)         *)
(************************************************************************)

open Names
open Libnames
open Miniml
open Declarations

module Refset' : CSig.USetS with type elt = global
module Refmap' : CSig.UMapS with type key = global

type t

val safe_basename_of_global : t -> global -> Id.t

val make_table : unit -> t

(*s Warning and Error messages. *)

val warning_axioms : t -> unit
val warning_opaques : t -> bool -> unit
val warning_ambiguous_name : ?loc:Loc.t -> qualid * ModPath.t * GlobRef.t -> unit
val warning_id : string -> unit
(*s Target language. *)

type lang =
  | Ocaml | Haskell | Scheme | JSON
  | External of string (** provided by a plugin *)

val lang : unit -> lang
val lang_name : lang -> string

val error_axiom_scheme : ?loc:Loc.t -> global -> int -> 'a
val error_constant : ?loc:Loc.t -> global -> 'a
val error_inductive : ?loc:Loc.t -> global -> 'a
val error_nb_cons : unit -> 'a
val error_module_clash : ModPath.t -> ModPath.t -> 'a
val error_no_module_expr : ModPath.t -> 'a
val error_singleton_become_prop : inductive -> 'a
val error_unknown_module : ?loc:Loc.t -> qualid -> 'a
val error_not_modular : lang -> 'a
val error_not_visible : global -> 'a
val error_MPfile_as_mod : ModPath.t -> bool -> 'a
val check_inside_section : unit -> unit
val check_loaded_modfile : ModPath.t -> unit
val msg_of_implicit : kill_reason -> string
val err_or_warn_remaining_implicit : kill_reason -> unit

val info_file : string -> unit

(*s utilities about [module_path] and [kernel_names] and [GlobRef.t] *)

val occur_kn_in_ref : MutInd.t -> global -> bool
val repr_of_r : global -> KerName.t
val modpath_of_r : global -> ModPath.t
val label_of_r : global -> Id.t
val base_mp : ModPath.t -> ModPath.t
val is_modfile : ModPath.t -> bool
val string_of_modfile : t -> DirPath.t -> string
val file_of_modfile : t -> DirPath.t -> string
val is_toplevel : ModPath.t -> bool
val at_toplevel : ModPath.t -> bool
val mp_length : ModPath.t -> int
val prefixes_mp : ModPath.t -> ModPath.Set.t
val common_prefix_from_list :
  ModPath.t -> ModPath.t list -> ModPath.t option
val get_nth_label_mp : int -> ModPath.t -> Id.t
val labels_of_ref : global -> ModPath.t * Id.t list

(*s Some table-related operations *)

(* For avoiding repeated extraction of the same constant or inductive,
   we use cache functions below. Indexing by constant name isn't enough,
   due to modules we could have a same constant name but different
   content. So we check that the [constant_body] hasn't changed from
   recording time to retrieving time. Same for inductive : we store
   [mutual_inductive_body] as checksum. In both case, we should ideally
   also check the env *)

val add_typedef : t -> Constant.t -> InfvInst.t -> constant_body -> ml_type -> unit
val lookup_typedef : t -> Constant.t -> InfvInst.t -> constant_body -> ml_type option

val add_cst_type : t -> Constant.t -> InfvInst.t -> constant_body -> ml_schema -> unit
val lookup_cst_type : t -> Constant.t -> InfvInst.t -> constant_body -> ml_schema option

val add_ind : t -> MutInd.t -> InfvInst.t -> mutual_inductive_body -> ml_ind -> unit
val lookup_ind : t -> MutInd.t ->  InfvInst.t -> mutual_inductive_body -> ml_ind option

val add_inductive_kind : t -> MutInd.t -> InfvInst.t -> inductive_kind -> unit
val is_coinductive : t -> global -> bool
val is_coinductive_type : t -> ml_type -> bool
(* What are the fields of a record (empty for a non-record) *)
val get_record_fields :
  t -> global -> global option list
val record_fields_of_type : t -> ml_type -> global option list

val add_recursors : t -> Environ.env -> MutInd.t -> unit
val is_recursor : t -> global -> bool

val add_projection : t -> int -> Constant.t -> inductive -> unit
val is_projection : t -> global -> bool

val add_info_axiom : t -> GlobRef.t -> unit
val remove_info_axiom : t -> GlobRef.t -> unit
val add_log_axiom : t -> GlobRef.t-> unit
val add_symbol : t -> GlobRef.t -> unit
val add_symbol_rule : t -> GlobRef.t -> Id.t -> unit

val add_opaque : t -> GlobRef.t -> unit
val remove_opaque : t -> GlobRef.t -> unit

(*s Output Directory parameter *)

val output_directory : unit -> string

(*s AccessOpaque parameter *)

val access_opaque : unit -> bool

(*s AutoInline parameter *)

val auto_inline : unit -> bool

(*s TypeExpand parameter *)

val type_expand : unit -> bool

(*s KeepSingleton parameter *)

val keep_singleton : unit -> bool

(*s Prefix parameter *)

val prefix : unit -> string

(*s Optimize parameter *)

type opt_flag =
    { opt_kill_dum : bool; (* 1 *)
      opt_fix_fun : bool;   (* 2 *)
      opt_case_iot : bool;  (* 4 *)
      opt_case_idr : bool;  (* 8 *)
      opt_case_idg : bool;  (* 16 *)
      opt_case_cst : bool;  (* 32 *)
      opt_case_fun : bool;  (* 64 *)
      opt_case_app : bool;  (* 128 *)
      opt_let_app : bool;   (* 256 *)
      opt_lin_let : bool;   (* 512 *)
      opt_lin_beta : bool } (* 1024 *)

val optims :  unit -> opt_flag

(*s Controls whether dummy lambda are removed *)

val conservative_types : unit -> bool

(*s A comment to print at the beginning of the files *)

val file_comment : unit -> string

(*s Table for custom inlining *)

val to_inline : global -> bool
val to_keep : global -> bool

(*s Table for implicits arguments *)

val implicits_of_global : global -> Int.Set.t

(*s Table for user-given custom ML extractions. *)

(* UGLY HACK: registration of a function defined in [extraction.ml] *)
val type_scheme_nb_args_hook : (Environ.env -> Constr.t -> int) Hook.t

val is_custom : global -> bool
val is_inline_custom : global -> bool
val is_foreign_custom : global -> bool
val find_callback : global -> string option
val find_custom : global -> string
val find_type_custom : global -> string list * string

val is_custom_match : ml_branch array -> bool
val find_custom_match : ml_branch array -> string

(*s Extraction commands. *)

val extraction_language : lang -> unit
val extraction_inline : bool -> qualid list -> unit
val print_extraction_inline : unit -> Pp.t
val print_extraction_foreign : unit -> Pp.t
val print_extraction_callback : unit -> Pp.t
val reset_extraction_inline : unit -> unit
val reset_extraction_foreign : unit -> unit
val reset_extraction_callback : unit -> unit
val extract_callback : string option -> qualid -> unit
val extract_constant_inline :
  bool -> qualid -> string list -> string -> unit
val extract_constant_foreign :
  qualid -> string -> unit
val extract_inductive :
  qualid -> string -> string list -> string option -> unit


type int_or_id = ArgInt of int | ArgId of Id.t
val extraction_implicit : qualid -> int_or_id list -> unit

(*s Table of blacklisted filenames *)

val extraction_blacklist : string list -> unit
val reset_extraction_blacklist : unit -> unit
val print_extraction_blacklist : unit -> Pp.t