package rocq-runtime

  1. Overview
  2. Docs
The Rocq Prover -- Core Binaries and Tools

Install 

dune-project
 Dependency

rocq-prover.org Readme Edit opam file Versions (3)

Authors

  1. T
    The Rocq development team, INRIA, CNRS, and contributors

Maintainers

  1. T
    The Rocq development team <rocq+rocq-development@discoursemail.com>

Sources

rocq-9.0.1.tar.gz
sha256=051f7bf702ff0a3b370449728921e5a95e18bc2b31b8eb949d48422888c98af4

doc/rocq-runtime.lib/CWarnings/index.html

Module CWarningsSource

Sourcetype status =
  1. | Disabled
  2. | Enabled
  3. | AsError
Sourcetype category

Categories and warnings form a DAG with a common root all and warnings as the leaves.

Sourceval all : category
Sourcetype warning

Each warning belongs to some categories maybe including "default". It is possible to query the status of a warning (unlike categories). XXX we should probably have "default-error" too.

Sourcetype 'a msg

A msg belongs to a warning.

Sourceval warn : 'a msg -> ?loc:Loc.t -> ?quickfix:Quickfix.t list -> 'a -> unit

Emit a message in some warning.

Creation functions

Note that names are in a combined namespace including the special name "none".

Sourceval create_category : ?from:category list -> name:string -> unit -> category

When from is not specified it defaults to [all]. Empty list from is not allowed. "default" is not allowed in from.

Sourceval create_warning : ?from:category list -> ?default:status -> name:string -> unit -> warning

from works the same as with create_category. In particular default status is specified through the default argument not by using the "default" category.

Sourceval create_hybrid : ?from:category list -> ?default:status -> name:string -> unit -> category * warning

As create_warning, but the warning can also be used as a category i.e. have sub-warnings.

Sourceval create_msg : warning -> unit -> 'a msg

A message with data 'a in the given warning.

Sourceval create_in : warning -> ('a -> Pp.t) -> ?loc:Loc.t -> ?quickfix:Quickfix.t list -> 'a -> unit

Create a msg with registered printer.

Sourceval register_printer : 'a msg -> ('a -> Pp.t) -> unit

Register the printer for a given message. If a printer is already registered it is replaced.

Sourceval create : name:string -> ?category:category -> ?default:status -> ('a -> Pp.t) -> ?loc:Loc.t -> 'a -> unit

Combined creation function. name must be a fresh name.

Sourceval create_with_quickfix : name:string -> ?category:category -> ?default:status -> ('a -> Pp.t) -> ?loc:Loc.t -> ?quickfix:Quickfix.t list -> 'a -> unit

Combined creation function. name must be a fresh name.

Misc APIs

Sourceval get_flags : unit -> string
Sourceval set_flags : string -> unit
Sourcetype 'a elt =
  1. | There of 'a
  2. | NotThere
  3. | OtherType
Sourceval get_category : string -> category elt

Get preexisting category by name.

Sourceval get_warning : string -> warning elt

Get preexisting warning by name.

Sourceval warning_status : warning -> status

Current status of the warning.

Sourceval get_status : name:string -> status
Sourceval normalize_flags_string : string -> string

Cleans up a user provided warnings status string, e.g. removing unknown warnings (in which case a warning is emitted) or subsumed warnings .

Sourceval with_warn : string -> ('b -> 'a) -> 'b -> 'a

with_warn "-xxx,+yyy..." f x calls f x after setting the warnings as specified in the string (keeping other previously set warnings), and restores current warnings after f() returns or raises an exception. If both f and restoring the warnings raise exceptions, the latter is raised.

Sourceval check_unknown_warnings : string -> unit

Warn with "unknown-warning" if any unknown warnings are in the string with non-disabled status.

Sourceval override_unknown_warning : bool ref

For command line -w, this avoids using the warning system to avoid breaking "-w -unknown-warning".

  • deprecated (8.18) Do not use, internal.
Sourcemodule CoreCategories : sig ... end

Categories used in rocq-runtime. Might not be exhaustive.