Module Wp.Warning

Contextual Errors

exception Error of string * string

Source, Reason

val error : ?source:string -> ('a, Stdlib.Format.formatter, unit, 'b) Stdlib.format4 -> 'a

Warning Manager

type t = {
  1. loc : Frama_c_kernel.Filepath.position;
  2. severe : bool;
  3. source : string;
  4. reason : string;
  5. fallback : string;
}
val compare : t -> t -> int
val pretty : Stdlib.Format.formatter -> t -> unit
module Set : Stdlib.Set.S with type elt = t
module Map : Stdlib.Map.S with type key = t
val severe : Set.t -> bool
type context
val context : ?source:string -> unit -> context
val flush : context -> Set.t
val add : t -> unit
val create : ?log:bool -> ?severe:bool -> ?source:string -> fallback:string -> ('a, Stdlib.Format.formatter, unit, t) Stdlib.format4 -> 'a
val emit : ?severe:bool -> ?source:string -> fallback:string -> ('a, Stdlib.Format.formatter, unit) Stdlib.format -> 'a

Emit a warning in current context. Defaults: severe=true, source="wp".

val handle : ?severe:bool -> fallback:string -> handler:('a -> 'b) -> ('a -> 'b) -> 'a -> 'b

Handle the error and emit a warning with specified severity and fallback if a context has been set. Otherwise, a WP-fatal error is raised instead. Default for severe is false.

  • before 30.0-Zinc

    fallback was effect

type 'a outcome =
  1. | Result of Set.t * 'a
  2. | Failed of Set.t
val catch : ?source:string -> ?severe:bool -> fallback:string -> ('a -> 'b) -> 'a -> 'b outcome

Set up a context for the job. If non-handled errors are raised, then a warning is emitted with specified severity and fallback. Default for severe is true.