package catala

You can search for identifiers within the package.

in-package search v0.2.0

Compiler and library for the literate programming language for tax code specification

Install

Dune Dependency

github.com Readme Edit opam file Versions (8)

Authors

Maintainers

C

contact@catala-lang.org

Sources

0.10.0.tar.gz

md5=5abd76e8c51a47670645e91b21b57fc5

sha512=9c6fbe50c0b5a60566e877eeddadca0a339e2ce35deb5c1beceb03bc40eb6af2d519313e71859d88645b53fad591d4fa5288c633b185c9d765603da0f5b7dd7b

doc/catala.catala_utils/Catala_utils/Message/index.html

Module `Catala_utils.Message`Source

Interface for emitting compiler messages.

All messages are expected to use the Format module. Flush, "@?", "@.", "%!" etc. are not supposed to be used outside of this module.

WARNING: this module performs side-effects at load time, adding support for ocolor tags (e.g. "@{<blue>text@}") to the standard string formatter used by e.g. Format.sprintf. (In this case, the tags are ignored, for color output you should use the functions of this module that toggle support depending on cli flags and terminal support).

Message content

Sourcetype level =

| Error
| Warning
| Debug
| Log
| Result

Sourcemodule Content : sig ... end

This functions emits the message according to the emission type defined by Cli.message_format_flag.

Error exception

Sourceexception CompilerError of Content.t

Some formatting helpers

Sourceval unformat : (Format.formatter -> unit) -> string

Converts f to a string, discarding formatting and skipping newlines and indents

Sourceval has_color : out_channel -> bool

Sourceval set_terminal_width_function : (unit -> int) -> unit

Sourceval formatter_of_out_channel : out_channel -> Format.formatter

Creates a new formatter from the given out channel, with correct handling of the ocolor tags. Actual use of escape codes in the output depends on Cli.style_flag -- and wether the channel is a tty if that is set to auto.

Simple interface for various message emission

Source

type ('a, 'b) emitter =
  ?header:Content.message ->
  ?internal:bool ->
  ?pos:Pos.t ->
  ?pos_msg:Content.message ->
  ?extra_pos:(string * Pos.t) list ->
  ?fmt_pos:(Content.message * Pos.t) list ->
  ?outcome:Content.message list ->
  ?suggestion:string list ->
  ('a, Format.formatter, unit, 'b) format4 ->
  'a

Sourceval log : ('a, unit) emitter

Sourceval debug : ('a, unit) emitter

Sourceval result : ('a, unit) emitter

Sourceval warning : ('a, unit) emitter

Sourceval error : ('a, 'b) emitter

Sourceval results : Content.message list -> unit

On This Page

Message content
Error exception
Some formatting helpers
Simple interface for various message emission