Module IBase.Logging

log messages at different levels of verbosity

module F = Stdlib.Format
include module type of Die
exception InferExternalError of string
exception InferInternalError of string
exception InferUserError of string
exception InferExit of int

This can be used to avoid scattering exit invocations all over the codebase

type error =
  1. | ExternalError
  2. | InternalError
  3. | UserError

kind of error for die, with similar semantics as Logging.{external,internal,user}_error

val exit : int -> 'a
val exit_code_of_exception : IStdlib.IStd.Exn.t -> int
val set_log_uncaught_exception_callback : (exn -> exitcode:int -> unit) -> unit
val log_uncaught_exception : exn -> exitcode:int -> unit
val die : error -> ('a, Stdlib.Format.formatter, unit, _) IStdlib.IStd.format4 -> 'a

Raise the corresponding exception.

val raise_error : ?backtrace:Stdlib.Printexc.raw_backtrace -> error -> msg:string -> 'a
type style =
  1. | Error
  2. | Fatal
  3. | Normal
  4. | Warning
val term_styles_of_style : style -> IStdlib.IStd.ANSITerminal.style list
val environment_info : ('a, F.formatter, unit) IStdlib.IStd.format -> 'a

log information about the environment

val progress : ('a, F.formatter, unit) IStdlib.IStd.format -> 'a

print immediately to standard error unless --quiet is specified

val log_task : ('a, F.formatter, unit) IStdlib.IStd.format -> 'a

log progress in the log file and on the console unless there is an active task bar

val task_progress : f:(unit -> 'a) -> (F.formatter -> 'b -> unit) -> 'b -> 'a

task_progress ~f pp x executes f and log progress pp x in the log file and also on the console unless there is an active task bar

val result : ?style:IStdlib.IStd.ANSITerminal.style list -> ('a, F.formatter, unit) IStdlib.IStd.format -> 'a

Emit a result to stdout. Use only if the output format is stable and useful enough that it may conceivably get piped to another program, ie, almost never (use progress instead otherwise).

val user_error : ('a, F.formatter, unit) IStdlib.IStd.format -> 'a

bad input, etc. detected

val user_warning : ('a, F.formatter, unit) IStdlib.IStd.format -> 'a

the user may have done something wrong

val internal_error : ('a, F.formatter, unit) IStdlib.IStd.format -> 'a

huho, infer has a bug

val external_error : ('a, F.formatter, unit) IStdlib.IStd.format -> 'a

some other tool has a bug or is called wrongly

val external_warning : ('a, F.formatter, unit) IStdlib.IStd.format -> 'a
type debug_kind =
  1. | Analysis
  2. | BufferOverrun
  3. | Capture
  4. | MergeCapture
  5. | Report
type debug_level =
  1. | Quiet
    (*

    innocuous, eg emitted once per toplevel execution

    *)
  2. | Medium
    (*

    still fairly lightweight, eg emitted O(<number of infer processes>)

    *)
  3. | Verbose
    (*

    go crazy

    *)

Level of verbosity for debug output. Each level enables all the levels before it.

val debug : debug_kind -> debug_level -> ('a, F.formatter, unit) IStdlib.IStd.format -> 'a

log debug info

val debug_dev : ('a, Stdlib.Format.formatter, unit) IStdlib.IStd.format -> 'a

For debugging during development.

  • deprecated Only use to debug during development. If you want more permanent logging, use [Logging.debug] instead.
type ocaml_pos = string * int * int * int

Type of location in ml source: __POS__

val pp_ocaml_pos_opt : F.formatter -> ocaml_pos option -> unit

Pretty print a position in ocaml source

log management

val setup_log_file : unit -> unit

Set up logging to go to the log file. Call this once the results directory has been set up.

val flush_formatters : unit -> unit

Flushes the formatters used for logging. Call this in the parent before you fork(2).

val reset_formatters : unit -> unit

Reset the formatters used for logging. Call this in the child after you fork(2).

Delayed printing (HTML debug, ...)

type delayed_prints
val force_and_reset_delayed_prints : F.formatter -> unit
val get_and_reset_delayed_prints : unit -> delayed_prints

return the delayed print actions and reset them

val set_delayed_prints : delayed_prints -> unit

set the delayed print actions

val reset_delayed_prints : unit -> unit

reset the delayed print actions

val d_ln : unit -> unit

dump a newline

val d_printf : ?color:IStdlib.Pp.color -> ('a, F.formatter, unit) IStdlib.IStd.format -> 'a
val d_printfln : ?color:IStdlib.Pp.color -> ('a, F.formatter, unit) IStdlib.IStd.format -> 'a
val d_printfln_escaped : ?color:IStdlib.Pp.color -> ('a, F.formatter, unit) IStdlib.IStd.format -> 'a
val d_error : string -> unit

dump an error string

val d_warning : string -> unit

dump a warning string

val d_info : string -> unit

dump an info string

val with_indent : ?name_color:IStdlib.Pp.color -> ?collapsible:bool -> ?escape_result:bool -> ?pp_result:(F.formatter -> 'a -> unit) -> f:(unit -> 'a) -> ('b, F.formatter, unit, 'a) IStdlib.IStd.format4 -> 'b

Unconditionally execute f so that all logs written inside (if any) are written with indentation, using the title format provided.

pp_result, if provided, will make the result of a call to be printed as well (useful for cases when there are several places when the function returns).

NOTE: If you want to use it NOT at the very top level of a function, it is a code smell, and you probably want to split your function into smaller ones.