(**
 * Copyright (c) 2013-present, Facebook, Inc.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *)

open Utils_js

exception Props_not_found of Type.Properties.id
exception Exports_not_found of Type.Exports.id
exception Require_not_found of string
exception Module_not_found of string
exception Tvar_not_found of Constraint.ident

type env = Scope.t list

type t
type sig_t

type metadata = {
  (* local *)
  checked: bool;
  munge_underscores: bool;
  verbose: Verbose.t option;
  weak: bool;
  jsx: Options.jsx_mode;
  strict: bool;
  strict_local: bool;
  (* global *)
  max_literal_length: int;
  enable_const_params: bool;
  enforce_strict_call_arity: bool;
  esproposal_class_static_fields: Options.esproposal_feature_mode;
  esproposal_class_instance_fields: Options.esproposal_feature_mode;
  esproposal_decorators: Options.esproposal_feature_mode;
  esproposal_export_star_as: Options.esproposal_feature_mode;
  esproposal_optional_chaining: Options.esproposal_feature_mode;
  esproposal_nullish_coalescing: Options.esproposal_feature_mode;
  facebook_fbt: string option;
  ignore_non_literal_requires: bool;
  max_trace_depth: int;
  root: Path.t;
  strip_root: bool;
  suppress_comments: Str.regexp list;
  suppress_types: SSet.t;
  max_workers: int;
}

type module_kind =
  | CommonJSModule of Loc.t option
  | ESModule

type type_assert_kind = Is | Throws | Wraps

val make_sig: unit -> sig_t
val make: sig_t -> metadata -> File_key.t -> string -> t
val metadata_of_options: Options.t -> metadata

val sig_cx: t -> sig_t
val graph_sig: sig_t -> Constraint.node IMap.t
val find_module_sig: sig_t -> string -> Type.t

(* accessors *)
val all_unresolved: t -> ISet.t IMap.t
val annot_table: t -> (Loc.t, Type.t) Hashtbl.t
val max_literal_length: t -> int
val enable_const_params: t -> bool
val enforce_strict_call_arity: t -> bool
val envs: t -> env IMap.t
val errors: t -> Errors.ErrorSet.t
val error_suppressions: t -> Error_suppressions.t
val esproposal_class_static_fields: t -> Options.esproposal_feature_mode
val esproposal_class_instance_fields: t -> Options.esproposal_feature_mode
val esproposal_decorators: t -> Options.esproposal_feature_mode
val esproposal_export_star_as: t -> Options.esproposal_feature_mode
val esproposal_optional_chaining: t -> Options.esproposal_feature_mode
val esproposal_nullish_coalescing: t -> Options.esproposal_feature_mode
val evaluated: t -> Type.t IMap.t
val file: t -> File_key.t
val find_props: t -> Type.Properties.id -> Type.Properties.t
val find_call: t -> int -> Type.t
val find_exports: t -> Type.Exports.id -> Type.Exports.t
val find_require: t -> Loc.t -> Type.t
val find_module: t -> string -> Type.t
val find_tvar: t -> Constraint.ident -> Constraint.node
val mem_nominal_id: t -> Constraint.ident -> bool
val graph: t -> Constraint.node IMap.t
val import_stmts: t -> (Loc.t, Loc.t) Flow_ast.Statement.ImportDeclaration.t list
val imported_ts: t -> Type.t SMap.t
val is_checked: t -> bool
val is_verbose: t -> bool
val is_weak: t -> bool
val is_strict: t -> bool
val is_strict_local: t -> bool
val severity_cover: t -> ExactCover.lint_severity_cover Utils_js.FilenameMap.t
val max_trace_depth: t -> int
val module_kind: t -> module_kind
val require_map: t -> Type.t LocMap.t
val module_map: t -> Type.t SMap.t
val module_ref: t -> string
val property_maps: t -> Type.Properties.map
val call_props: t -> Type.t IMap.t
val refs_table: t -> (Loc.t, Loc.t) Hashtbl.t
val export_maps: t -> Type.Exports.map
val root: t -> Path.t
val facebook_fbt: t -> string option
val should_ignore_non_literal_requires: t -> bool
val should_munge_underscores: t -> bool
val should_strip_root: t -> bool
val suppress_comments: t -> Str.regexp list
val suppress_types: t -> SSet.t
val type_graph: t -> Graph_explorer.graph
val type_table: t -> Type_table.t
val type_asserts: t -> (type_assert_kind * Loc.t) LocMap.t
val verbose: t -> Verbose.t option
val max_workers: t -> int
val jsx: t -> Options.jsx_mode
val exists_checks: t -> ExistsCheck.t LocMap.t
val exists_excuses: t -> ExistsCheck.t LocMap.t
val use_def: t -> Scope_api.info * Ssa_api.values
val pid_prefix: t -> string

val copy_of_context: t -> t
val merge_into: sig_t -> sig_t -> unit

val push_declare_module: t -> string -> unit
val pop_declare_module: t -> unit

(* mutators *)
val add_env: t -> int -> env -> unit
val add_error: t -> Errors.error -> unit
val add_error_suppression: t -> Loc.t -> unit
val add_severity_cover: t -> File_key.t -> ExactCover.lint_severity_cover -> unit
val add_lint_suppressions: t -> LocSet.t -> unit
val add_import_stmt: t -> (Loc.t, Loc.t) Flow_ast.Statement.ImportDeclaration.t -> unit
val add_imported_t: t -> string -> Type.t -> unit
val add_require: t -> Loc.t -> Type.t -> unit
val add_module: t -> string -> Type.t -> unit
val add_property_map: t -> Type.Properties.id -> Type.Properties.t -> unit
val add_call_prop: t -> int -> Type.t -> unit
val add_export_map: t -> Type.Exports.id -> Type.Exports.t -> unit
val add_tvar: t -> Constraint.ident -> Constraint.node -> unit
val add_nominal_id: t -> Constraint.ident -> unit
val add_type_assert: t -> Loc.t -> (type_assert_kind * Loc.t) -> unit
val remove_all_errors: t -> unit
val remove_all_error_suppressions: t -> unit
val remove_all_lint_severities: t -> unit
val remove_tvar: t -> Constraint.ident -> unit
val set_envs: t -> env IMap.t -> unit
val set_evaluated: t  -> Type.t IMap.t -> unit
val set_type_graph: t  -> Graph_explorer.graph -> unit
val set_all_unresolved: t  -> ISet.t IMap.t -> unit
val set_graph: t -> Constraint.node IMap.t -> unit
val set_module_kind: t -> module_kind -> unit
val set_property_maps: t -> Type.Properties.map -> unit
val set_call_props: t -> Type.t IMap.t -> unit
val set_export_maps: t -> Type.Exports.map -> unit
val set_exists_checks: t -> ExistsCheck.t LocMap.t -> unit
val set_exists_excuses: t -> ExistsCheck.t LocMap.t -> unit
val set_use_def: t -> Scope_api.info * Ssa_api.values -> unit
val set_module_map: t -> Type.t SMap.t -> unit

val clear_intermediates: t -> unit
val clear_master_shared: t -> sig_t -> unit

(* Flow allows you test test if a property exists inside a conditional. However, we only wan to
 * allow this test if there's a chance that the property might exist. So `if (foo.bar)` should be
 *
 * - Allowed for the types `{ bar: string }`, `any`, `mixed`, `{ bar: string } | number`, etc
 *
 * - Disallowed for the types ` { baz: string }`, `number`, ` { baz: string} | number`
 *
 * It's really difficult to say that something never happens in Flow. Our best way of approximating
 * this is waiting until typechecking is done and then seeing if something happened. In this case,
 * we record if testing a property ever succeeds. If if never succeeds after typechecking is done,
 * we emit an error.
 *)
val test_prop_hit: t -> Constraint.ident -> unit
val test_prop_miss: t -> Constraint.ident -> string option -> (Reason.t * Reason.t) -> Type.use_op -> unit
val test_prop_get_never_hit: t -> (string option * (Reason.t * Reason.t) * Type.use_op) list

val mark_optional_chain: t -> Loc.t -> Reason.t -> useful:bool -> unit
val unnecessary_optional_chains: t -> (Loc.t * Reason.t) list
val mark_invariant: t -> Loc.t -> Reason.t -> useful:bool -> unit
val unnecessary_invariants: t -> (Loc.t * Reason.t) list

(* utils *)
val iter_props: t -> Type.Properties.id -> (string -> Type.Property.t -> unit) -> unit
val has_prop: t -> Type.Properties.id -> string -> bool
val get_prop: t -> Type.Properties.id -> string -> Type.Property.t option
val set_prop: t -> Type.Properties.id -> string -> Type.Property.t -> unit
val has_export: t -> Type.Exports.id -> string -> bool
val set_export: t -> Type.Exports.id -> string -> (Loc.t option * Type.t) -> unit

(* constructors *)
val make_property_map: t -> Type.Properties.t -> Type.Properties.id
val make_call_prop: t -> Type.t -> int
val make_export_map: t -> Type.Exports.t -> Type.Exports.id
val make_nominal: t -> int

val find_constraints:
  t ->
  Constraint.ident ->
  Constraint.ident * Constraint.constraints
val find_graph: t -> Constraint.ident -> Constraint.constraints
val find_root: t -> Constraint.ident -> Constraint.ident * Constraint.root
val find_resolved: t -> Type.t -> Type.t option
