Module `Feedback`Source

Sourcetype level =

| Debug
| Info
| Notice
| Warning
| Error

Sourcetype doc_id = int

Document unique identifier for serialization

Sourcetype route_id = int

Rocq "semantic" infos obtained during execution

Sourceval default_route : route_id

Sourcetype feedback_content =

| Processed
| Incomplete
| Complete
| ProcessingIn of string
| InProgress of int
| WorkerStatus of string * string
| AddedAxiom
| GlobRef of Loc.t * string * string * string * string
| GlobDef of Loc.t * string * string * string
| FileDependency of string option * string
| FileLoaded of string * string
| Custom of Loc.t option * string * Xml_datatype.xml
| Message of level * Loc.t option * Quickfix.t list * Pp.t

Sourcetype feedback = {

doc_id : doc_id;
span_id : Stateid.t;
route : route_id;
contents : feedback_content;

}

Feedback sent, even asynchronously, to the user interface

Sourceval add_feeder : (feedback -> unit) -> int

add_feeder f adds a feeder listiner f, returning its id

Sourceval del_feeder : int -> unit

del_feeder fid removes the feeder with id fid

Source

val feedback : 
  ?did:doc_id ->
  ?id:Stateid.t ->
  ?route:route_id ->
  feedback_content ->
  unit

feedback ?did ?sid ?route fb produces feedback fb, with route and did, sid set appropiatedly, if absent, it will use the defaults set by set_id_for_feedback

Sourceval set_id_for_feedback : ?route:route_id -> doc_id -> Stateid.t -> unit

set_id_for_feedback route id Set the defaults for feedback

output functions

Sourceval msg_info : ?loc:Loc.t -> Pp.t -> unit

Message that displays information, usually in verbose mode, such as Foobar is defined

Sourceval msg_notice : ?loc:Loc.t -> Pp.t -> unit

Message that should be displayed, such as Print Foo or Show Bar.

Sourceval msg_warning : ?loc:Loc.t -> ?quickfix:Quickfix.t list -> Pp.t -> unit

Message indicating that something went wrong, but without serious consequences. A list of quick fixes, in the VSCode sense, can be provided

Sourceval msg_debug : ?loc:Loc.t -> Pp.t -> unit

For debugging purposes

Sourceval console_feedback_listener : Format.formatter -> feedback -> unit

Helper for tools willing to print to the feedback system

Sourceval warn_no_listeners : bool ref

The library will print a warning to the console if no listener is available by default; ML-clients willing to use Rocq without a feedback handler should set this to false.

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module `Feedback`Source

Feedback sent, even asynchronously, to the user interface

output functions

package rocq-runtime

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module FeedbackSource

Feedback sent, even asynchronously, to the user interface

output functions

Module `Feedback`Source