package ostap

  1. Overview
  2. Docs

Module Ostap.MsgSource

Parsing message interface.

Messaging operations

Sourcemodule Coord : sig ... end

Text coordinate.

Sourcemodule MC : Map.S with type key = Coord.t
module Locator : sig ... end

Various ways to denote the location in the source text.

module FileLoc : sig ... end
Sourcetype t

Type of the message.

Sourceval make : string -> string array -> Locator.t -> t

General constructor. make phrase args loc creates message with format string phrase, arguments args and locator loc. Format string may contain parameter references of the form "%0", "%1", "%2" etc. These references to be substituted with corresponding actual values (i.e. args.(0), args.(1) etc.) during toString visualization. For example, toString {phrase="%0 %1 not found"; args=[|"type"; "int"|]; loc=No} is "type int not found".

Sourceval phrase : string -> t

Custom constructor; takes no parameters, no locator.

Sourceval orphan : string -> string array -> t

Custom constructor; takes no locator.

Sourceval loc : t -> Locator.t

Gets locator of a message.

Sourceval string : t -> string

Substitute parameters.

Sourceval toString : t -> string

Visualization with parameter substitution.

Sourceval augment : t -> Locator.t -> t

Augment the message with the location (replaces Locator.No (if any) in its argument with the loc).

Sourceval augmentList : t list -> Locator.t -> t list

Augment the list of messages with the location.

Sourceval extend : t -> string -> t

Extends phrase of the message by given string.

Sourceval extendList : t list -> string -> t list

Extends all phrases of the list of messages by given string.