Module `Grace.Diagnostic`Source

Diagnostic types and constructors.

Sourcetype ('a, 'b) format = ('a, Grace_std.Format.formatter, unit, 'b) format4

The type of format strings associated with messages.

Sourcemodule Severity : sig ... end

The type of severity.

Sourcemodule Priority : sig ... end

The type of priority. These are used to style the primary and secondary causes of a diagnostic.

Sourcemodule Message : sig ... end

Sourcemodule Label : sig ... end

Sourcetype 'code t = {

severity : Severity.t;
(*
The overall severity of the diagnostic.
*)
message : Message.t;
(*
The main message associated with the diagnostic. These should not include control characters (such as the newline character \n). To support compact rendering, the message should be specific enough to make sense on its own, without the additional context provided by labels and notes.
*)
code : 'code option;
(*
The (optional) error code assicoated with the diagnostic
*)
labels : Label.t list;
(*
Labels that describe the cause of the diagnostic. The order of the labels has no meaning, Grace's rendering engine will determine the order they appear.
*)
notes : Message.t list;
(*
Notes that are associated with the primary cause of the diagnostic.
*)

}

The type of diagnostics.

include Sexplib0.Sexpable.S1 with type 'code t := 'code t

Sourceval t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a t

Sourceval sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t

val create : 
  ?notes:Message.t list ->
  ?labels:Label.t list ->
  ?code:'code ->
  Severity.t ->
  Message.t ->
  'code t

create severity message constructs a diagnostic with the message.

parameter notes
additional notes associated with the primary cause of the diagnostic.
@param labels
used to describe the cause of the diagnostic.

val createf : 
  ?notes:Message.t list ->
  ?labels:Label.t list ->
  ?code:'code ->
  Severity.t ->
  ('a, 'code t) format ->
  'a

createf severity fmt ... formats a message and constructs a diagnostic.

parameter notes
additional notes associated with the primary cause of the diagnostic.
@param labels
used to describe the cause of the diagnostic.

val kcreatef : 
  ?notes:Message.t list ->
  ?labels:Label.t list ->
  ?code:'code ->
  ('code t -> 'b) ->
  Severity.t ->
  ('a, 'b) format ->
  'a

kcreatef kont severity fmt ... is equivalent to kont (createf severity fmt ...).

parameter notes
additional notes associated with the primary cause of the diagnostic.

Install