Module `Pulselib.PulseTrace`

module F = Stdlib.Format

module CallEvent = PulseCallEvent

module Invalidation = PulseInvalidation

module ValueHistory = PulseValueHistory

type t = | Immediate of { location : IBase.Location.t; history : ValueHistory.t; } | ViaCall of { f : CallEvent.t; location : IBase.Location.t; location of the call event history : ValueHistory.t; the call involves a value with this prior history in_call : t; last step of the trace is in a call to f made at location }

val compare : t -> t -> int
val equal : t -> t -> bool

val pp : pp_immediate:(F.formatter -> unit) -> F.formatter -> t -> unit
val get_outer_location : t -> IBase.Location.t: skip histories and go straight to the where the action is: either the action itself or the call that leads to the action

val get_start_location : t -> IBase.Location.t: initial step in the history if not empty, or else same as get_outer_location

val add_to_errlog : ?⁠include_value_history:bool -> nesting:int -> pp_immediate:(F.formatter -> unit) -> t -> Absint.Errlog.loc_trace_elem list -> Absint.Errlog.loc_trace_elem list
val find_map : t -> f:(ValueHistory.event -> 'a option) -> 'a option: find_map applied to history events

val get_invalidation : t -> Invalidation.t option: return the first invalidation event of the trace, if any

val has_invalidation : t -> bool: whether the trace contains an invalidation event

val trace_up_to_key_event : is_key_event:(ValueHistory.event -> bool) -> ValueHistory.t -> t option: turns a history containing a "key event" into a trace leading to the most recent such event