You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
119 lines
3.7 KiB
119 lines
3.7 KiB
(*
|
|
* Copyright (c) 2015 - present Facebook, Inc.
|
|
* All rights reserved.
|
|
*
|
|
* This source code is licensed under the BSD style license found in the
|
|
* LICENSE file in the root directory of this source tree. An additional grant
|
|
* of patent rights can be found in the PATENTS file in the same directory.
|
|
*)
|
|
|
|
open! IStd
|
|
|
|
(** Module for error logs. *)
|
|
|
|
type node_tag =
|
|
| Condition of bool
|
|
| Exception of Typ.name
|
|
| Procedure_start of Typ.Procname.t
|
|
| Procedure_end of Typ.Procname.t
|
|
|
|
(** Element of a loc trace *)
|
|
type loc_trace_elem = private {
|
|
lt_level : int; (** nesting level of procedure calls *)
|
|
lt_loc : Location.t; (** source location at the current step in the trace *)
|
|
lt_description : string; (** description of the current step in the trace *)
|
|
lt_node_tags : node_tag list (** tags describing the node at the current location *)
|
|
}
|
|
|
|
(** build a loc_trace_elem from its constituents (unambiguously identified by their types). *)
|
|
val make_trace_element : int -> Location.t -> string -> node_tag list -> loc_trace_elem
|
|
|
|
(** Trace of locations *)
|
|
type loc_trace = loc_trace_elem list
|
|
|
|
(** Look at all the trace steps and find those that are arising any exception,
|
|
then bind them to the closest step at level 0.
|
|
This extra information adds value to the report itself, and may avoid
|
|
digging into the trace to understand the cause of the report. *)
|
|
val compute_local_exception_line : loc_trace -> int option
|
|
|
|
type node_id_key = private {
|
|
node_id : int;
|
|
node_key : int
|
|
}
|
|
|
|
type err_key = private {
|
|
err_kind : Exceptions.err_kind;
|
|
in_footprint : bool;
|
|
err_name : Localise.t;
|
|
err_desc : Localise.error_desc;
|
|
severity : string
|
|
}[@@deriving compare]
|
|
|
|
(** Data associated to a specific error *)
|
|
type err_data = private {
|
|
node_id_key : node_id_key;
|
|
session : int;
|
|
loc : Location.t;
|
|
loc_in_ml_source : Logging.ml_loc option;
|
|
loc_trace : loc_trace;
|
|
err_class : Exceptions.err_class;
|
|
visibility : Exceptions.visibility;
|
|
linters_def_file : string option
|
|
}
|
|
|
|
(** Type of the error log *)
|
|
type t[@@deriving compare]
|
|
|
|
(** Empty error log *)
|
|
val empty : unit -> t
|
|
|
|
(** type of the function to be passed to iter *)
|
|
type iter_fun = err_key -> err_data -> unit
|
|
|
|
(** Apply f to nodes and error names *)
|
|
val iter : iter_fun -> t -> unit
|
|
|
|
val pp_loc_trace_elem : Format.formatter -> loc_trace_elem -> unit
|
|
|
|
val pp_loc_trace : Format.formatter -> loc_trace -> unit
|
|
|
|
(** Print errors from error log *)
|
|
val pp_errors : Format.formatter -> t -> unit
|
|
|
|
(** Print warnings from error log *)
|
|
val pp_warnings : Format.formatter -> t -> unit
|
|
|
|
(** Print an error log in html format *)
|
|
val pp_html : SourceFile.t -> DB.Results_dir.path -> Format.formatter -> t -> unit
|
|
|
|
(** Return the number of elements in the error log which satisfy the filter. *)
|
|
val size : (Exceptions.err_kind -> bool -> bool) -> t -> int
|
|
|
|
(** Update an old error log with a new one *)
|
|
val update : t -> t -> unit
|
|
|
|
val log_issue :
|
|
Exceptions.err_kind -> t -> Location.t -> (int * int) -> int -> loc_trace ->
|
|
?linters_def_file:string -> exn -> unit
|
|
|
|
(** {2 Functions for manipulating per-file error tables} *)
|
|
|
|
(** Type for per-file error tables *)
|
|
type err_table
|
|
|
|
(** Create an error table *)
|
|
val create_err_table : unit -> err_table
|
|
|
|
(** Add an error log to the global per-file table *)
|
|
val extend_table : err_table -> t -> unit
|
|
|
|
(** Size of the global per-file error table for the footprint phase *)
|
|
val err_table_size_footprint : Exceptions.err_kind -> err_table -> int
|
|
|
|
(** Print stats for the global per-file error table *)
|
|
val pp_err_table_stats : Exceptions.err_kind -> Format.formatter -> err_table -> unit
|
|
|
|
(** Print details of the global per-file error table *)
|
|
val print_err_table_details : Format.formatter -> err_table -> unit
|