Module InferIR__Localise

Support for localisation

module Tags : sig ... end
type error_desc = {
descriptions : string list;
tags : Tags.t;
dotty : string option;
}

description field of error messages

include sig ... end
val compare_error_desc : error_desc ‑> error_desc ‑> int
val no_desc : error_desc

empty error description

val verbatim_desc : string ‑> error_desc

verbatim desc from a string, not to be used for user-visible descs

val custom_desc : string ‑> (string * string) list ‑> error_desc

verbatim desc with custom tags

module BucketLevel : sig ... end
val error_desc_extract_tag_value : error_desc ‑> string ‑> string

returns the value of a tag or the empty string

val error_desc_get_bucket : error_desc ‑> string option

get the bucket value of an error_desc, if any

val error_desc_set_bucket : error_desc ‑> string ‑> error_desc

set the bucket value of an error_desc

val error_desc_is_reportable_bucket : error_desc ‑> bool

check if the report is in a high confidence bucket

val error_desc_hash : error_desc ‑> int

hash function for error_desc

val error_desc_equal : error_desc ‑> error_desc ‑> bool

equality for error_desc

val pp_error_desc : Format.formatter ‑> error_desc ‑> unit

pretty print an error description

val error_desc_get_dotty : error_desc ‑> string option

Description functions for error messages

type deref_str

dereference strings used to explain a dereference action in an error message

val deref_str_null : InferIR.Typ.Procname.t option ‑> deref_str

dereference strings for null dereference

val deref_str_nullable : InferIR.Typ.Procname.t option ‑> string ‑> deref_str

dereference strings for null dereference due to Nullable annotation

val deref_str_weak_variable_in_block : InferIR.Typ.Procname.t option ‑> string ‑> deref_str

dereference strings for null dereference due to weak captured variable in block

val deref_str_undef : (InferIR.Typ.Procname.t * InferBase.Location.t) ‑> deref_str

dereference strings for an undefined value coming from the given procedure

val deref_str_freed : InferIR.PredSymb.res_action ‑> deref_str

dereference strings for a freed pointer dereference

val deref_str_dangling : InferIR.PredSymb.dangling_kind option ‑> deref_str

dereference strings for a dangling pointer dereference

val deref_str_array_bound : InferIR.IntLit.t option ‑> InferIR.IntLit.t option ‑> deref_str

dereference strings for an array out of bound access

val deref_str_nil_argument_in_variadic_method : InferIR.Typ.Procname.t ‑> int ‑> int ‑> deref_str

dereference strings for nonterminal nil arguments in c/objc variadic methods

val deref_str_pointer_size_mismatch : InferIR.Typ.t ‑> InferIR.Typ.t ‑> deref_str

dereference strings for a pointer size mismatch

type access =
| Last_assigned of int * bool

(** line, null_case_flag *)

| Last_accessed of int * bool

(** line, is_nullable flag *)

| Initialized_automatically
| Returned_from_call of int

type of access

val nullable_annotation_name : InferIR.Typ.Procname.t ‑> string

Name of the nullable annotation

val dereference_string : InferIR.Typ.Procname.t ‑> deref_str ‑> string ‑> access option ‑> InferBase.Location.t ‑> error_desc
val parameter_field_not_null_checked_desc : error_desc ‑> InferIR.Exp.t ‑> error_desc
val is_parameter_not_null_checked_desc : error_desc ‑> bool
val is_field_not_null_checked_desc : error_desc ‑> bool
val desc_allocation_mismatch : (InferIR.Typ.Procname.t * InferIR.Typ.Procname.t * InferBase.Location.t) ‑> (InferIR.Typ.Procname.t * InferIR.Typ.Procname.t * InferBase.Location.t) ‑> error_desc
val desc_class_cast_exception : InferIR.Typ.Procname.t option ‑> string ‑> string ‑> string option ‑> InferBase.Location.t ‑> error_desc
val desc_condition_always_true_false : InferIR.IntLit.t ‑> string option ‑> InferBase.Location.t ‑> error_desc
val desc_unreachable_code_after : InferBase.Location.t ‑> error_desc
val desc_deallocate_stack_variable : string ‑> InferIR.Typ.Procname.t ‑> InferBase.Location.t ‑> error_desc
val desc_deallocate_static_memory : string ‑> InferIR.Typ.Procname.t ‑> InferBase.Location.t ‑> error_desc
val desc_divide_by_zero : string ‑> InferBase.Location.t ‑> error_desc
val desc_double_lock : InferIR.Typ.Procname.t option ‑> string ‑> InferBase.Location.t ‑> error_desc
val is_double_lock_desc : error_desc ‑> bool
val desc_empty_vector_access : InferIR.Typ.Procname.t option ‑> string ‑> InferBase.Location.t ‑> error_desc
val is_empty_vector_access_desc : error_desc ‑> bool
val desc_frontend_warning : string ‑> string option ‑> InferBase.Location.t ‑> error_desc
val desc_leak : InferIR.Exp.t option ‑> string option ‑> InferIR.PredSymb.resource option ‑> InferIR.PredSymb.res_action option ‑> InferBase.Location.t ‑> string option ‑> error_desc
val desc_buffer_overrun : string ‑> error_desc
val desc_null_test_after_dereference : string ‑> int ‑> InferBase.Location.t ‑> error_desc
val java_unchecked_exn_desc : InferIR.Typ.Procname.t ‑> InferIR.Typ.Name.t ‑> string ‑> error_desc
val desc_fragment_retains_view : InferIR.Typ.t ‑> InferIR.Typ.Fieldname.t ‑> InferIR.Typ.t ‑> InferIR.Typ.Procname.t ‑> error_desc
val desc_custom_error : InferBase.Location.t ‑> error_desc

Create human-readable error description for assertion failures

type pnm_kind =
| Pnm_bounds
| Pnm_dangling

kind of precondition not met

val desc_precondition_not_met : pnm_kind option ‑> InferIR.Typ.Procname.t ‑> InferBase.Location.t ‑> error_desc
val desc_retain_cycle : string ‑> InferBase.Location.t ‑> string option ‑> error_desc
val desc_registered_observer_being_deallocated : InferIR.Pvar.t ‑> InferBase.Location.t ‑> error_desc
val desc_stack_variable_address_escape : InferIR.Pvar.t ‑> string option ‑> InferBase.Location.t ‑> error_desc
val desc_skip_function : InferIR.Typ.Procname.t ‑> error_desc
val desc_inherently_dangerous_function : InferIR.Typ.Procname.t ‑> error_desc
val desc_unary_minus_applied_to_unsigned_expression : string option ‑> string ‑> InferBase.Location.t ‑> error_desc
val desc_unsafe_guarded_by_access : InferIR.Typ.Fieldname.t ‑> string ‑> InferBase.Location.t ‑> error_desc
val desc_uninitialized_dangling_pointer_deref : deref_str ‑> string ‑> InferBase.Location.t ‑> error_desc
val access_desc : access option ‑> string list