Functor Kwapp.Messages

module Messages: functor (M : MYSELF) -> functor (V : VERBOSITY) -> sig .. end

Parameters:

`M`	:	`MYSELF`
`V`	:	`VERBOSITY`

Functions for printing simple messages from command-line applications.

val verbose : ?notreally:bool ->
       ?chan:Pervasives.out_channel ->
       ?flush:bool ->
       ?nl:bool ->
       ?initial:bool ->
       ?myself:string option ->
       int -> ('a, unit, string, unit) Pervasives.format4 -> 'a

verbose ?chan ?flush ?nl ?initial ?myself level fmt ...: print verbose messages.

The VERBOSITY module controls the printing of the message with an int. If level <= V.get (), the message is printed, so higher values print more verbose messages.

notreally : if true, precede message with "NOT: " (default: false)

chan : channel on which to print (default: stderr)

flush : if true, flush chan after each printing (default: true)

nl : if true, print a newline after each message (default: true)

initial : if true, prepend message with myself (default: true)

myself : name of application (default: M.myself)

level : the verbosity level of this message

fmt : format string as per Printf.printf

val verbosely : (?notreally:bool ->
        ?chan:Pervasives.out_channel ->
        ?flush:bool ->
        ?nl:bool ->
        ?initial:bool ->
        ?myself:string option ->
        int ->
        (string -> string -> string -> unit, unit, string, unit) Pervasives.format4 ->
        string -> string -> string -> unit) ->
       int ->
       string ->
       ?after:string -> ?printexc:(exn -> string) -> ('a -> 'b) -> 'a -> 'b

verbosely v level what f x: return f x, with a verbose message before and after the evaluation.

Typically, you will partially apply verbosely to a verbose function:

      let verbosely = verbosely verbose

and then call that.
Returns f x

level : the verbosity level of this message

what : the message describing what is happening

after : post-evaluation suffix

printexc : function to convert any exception raised in the evaluation of f x to a string (default: Printexc.to_string)

f : the function

x : the parameter

val warning : ?chan:Pervasives.out_channel ->
       ?myself:string option ->
       ?fatal:bool -> ('a, unit, string, unit) Pervasives.format4 -> 'a

warning ?chan ?myself fmt ...: print a warning (i.e. non-fatal) message on chan.

The message is prefixed with the application's name (myself), terminated with a newline, and flushed.

chan : channel on which to print (default: stderr)

myself : name of application (default: M.myself)

fmt : format string as per Printf.printf

val fatal : ?chan:Pervasives.out_channel ->
       ?myself:string option ->
       ?status:int -> ('a, unit, string, 'b) Pervasives.format4 -> 'a

fatal ?myself ?status fmt ...: print a fatal error message on chan, terminating the application.

The message is prefixed with the application's name (myself), terminated with a newline, and flushed.

chan : channel on which to print (default: stderr)

myself : name of application (default: M.myself)

status : exit status (default: 1)

fmt : format string as per Printf.printf

val dryrot : ?chan:Pervasives.out_channel ->
       ?myself:string option ->
       ?status:int -> ?bt:bool -> ('a, unit, string, 'b) Pervasives.format4 -> 'a

dryrot ?myself ?status ?bt fmt ...: print a dryrot error message on chan, terminating the application.

This is equivalent to a failed assertion.

The message is prefixed with the application's name (myself) and the string "DRYROT", terminated with a newline, and flushed.

chan : channel on which to print (default: stderr)

myself : name of application (default: M.myself)

status : exit status (default: 3)

bt : print a backtrace (default: false)

fmt : format string as per Printf.printf

val hdl : ?myself:string option -> 'a -> ('b -> 'c) -> 'b -> 'c

hdl ?myself interface f x: apply f to x, catching all exceptions defined in Kwapp and terminating the program with an appropriate error message.

Typical usage is to wrap it around your main function, e.g.

      let main () = ...
      let () = Messages.hdl main ()

myself : name of application (default: M.myself)

interface : the application interface

f : the function

x : the value