diff options
| author | Alasdair Armstrong | 2019-05-22 15:20:54 +0100 |
|---|---|---|
| committer | Alasdair Armstrong | 2019-05-22 15:20:54 +0100 |
| commit | 3e56cca75ea1e749fed71cda6a0c8b07659df611 (patch) | |
| tree | 729732074d562a3404df63573e18e67f3ffac4ef /src/reporting.mli | |
| parent | 7b4bf2bd14cae99a4d8086a0b66d9875be1acbab (diff) | |
Move Util.warn to Reporting, and make it take the location as a parameter
Also add a $suppress_warnings directive that ensures that no warnings
are generated for a specific file.
Diffstat (limited to 'src/reporting.mli')
| -rw-r--r-- | src/reporting.mli | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/src/reporting.mli b/src/reporting.mli index 28f2a799..0bdff5ca 100644 --- a/src/reporting.mli +++ b/src/reporting.mli @@ -50,16 +50,18 @@ (** Basic error reporting - [Reporting] contains functions to report errors and warnings. + [Reporting] contains functions to report errors and warnings. It contains functions to print locations ([Parse_ast.l] and [Ast.l]) and lexing positions. The main functionality is reporting errors. This is done by raising a - [Fatal_error] exception. This is caught internally and reported via [report_error]. + [Fatal_error] exception. This is caught internally and reported via [report_error]. There are several predefined types of errors which all cause different error - messages. If none of these fit, [Err_general] can be used. + messages. If none of these fit, [Err_general] can be used. *) +val opt_warnings : bool ref + (** {2 Auxiliary Functions } *) (** [loc_to_string] includes code from file if code optional argument is true (default) *) @@ -70,7 +72,7 @@ val simp_loc : Ast.l -> (Lexing.position * Lexing.position) option (** [short_loc_to_string] prints the location as a single line in a simple format *) val short_loc_to_string : Parse_ast.l -> string - + (** [print_err fatal print_loc_source l head mes] prints an error / warning message to std-err. It starts with printing location information stored in [l] It then prints "head: mes". If [fatal] is set, the program exists with error-code 1 afterwards. @@ -113,7 +115,15 @@ val err_typ : Parse_ast.l -> string -> exn (** [err_syntax_loc] is an abbreviation for [Fatal_error (Err_syntax_loc (l, m))] *) val err_syntax_loc : Parse_ast.l -> string -> exn - + val unreachable : Parse_ast.l -> (string * int * int * int) -> string -> 'a val print_error : error -> unit + +(** Print a warning message. The first string is printed before the + location, the second after. *) +val warn : string -> Parse_ast.l -> string -> unit + +(** Will suppress all warnings for a given file. Used by + $suppress_warnings directive in process_file.ml *) +val suppress_warnings_for_file : string -> unit |
