diff options
Diffstat (limited to 'src/reporting.mli')
| -rw-r--r-- | src/reporting.mli | 41 |
1 files changed, 26 insertions, 15 deletions
diff --git a/src/reporting.mli b/src/reporting.mli index 2d886111..e0744c66 100644 --- a/src/reporting.mli +++ b/src/reporting.mli @@ -50,24 +50,31 @@ (** 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) *) val loc_to_string : ?code:bool -> Parse_ast.l -> string +(** Reduce a location to a pair of positions if possible *) +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. + std-err. *) val print_err : Parse_ast.l -> string -> string -> unit @@ -75,36 +82,40 @@ val print_err : Parse_ast.l -> string -> string -> unit (** Errors stop execution and print a message; they typically have a location and message. *) -type error = +type error = private (** General errors, used for multi purpose. If you are unsure, use this one. *) | Err_general of Parse_ast.l * string (** Unreachable errors should never be thrown. It means that some code was excuted that the programmer thought of as unreachable *) - | Err_unreachable of Parse_ast.l * (string * int * int * int) * string + | Err_unreachable of Parse_ast.l * (string * int * int * int) * Printexc.raw_backtrace * string (** [Err_todo] indicates that some feature is unimplemented; it should be built using [err_todo]. *) | Err_todo of Parse_ast.l * string | Err_syntax of Lexing.position * string - | Err_syntax_locn of Parse_ast.l * string + | Err_syntax_loc of Parse_ast.l * string | Err_lex of Lexing.position * string | Err_type of Parse_ast.l * string exception Fatal_error of error -(** [err_todo l m] is an abreviatiation for [Fatal_error (Err_todo (l, m))] *) val err_todo : Parse_ast.l -> string -> exn - -(** [err_general l m] is an abreviatiation for [Fatal_error (Err_general (b, l, m))] *) val err_general : Parse_ast.l -> string -> exn - -(** [err_unreachable l __POS__ m] is an abreviatiation for [Fatal_error (Err_unreachable (l, __POS__, m))] *) val err_unreachable : Parse_ast.l -> (string * int * int * int) -> string -> exn - -(** [err_typ l m] is an abreviatiation for [Fatal_error (Err_type (l, m))] *) val err_typ : Parse_ast.l -> string -> exn +val err_syntax : Lexing.position -> string -> exn +val err_syntax_loc : Parse_ast.l -> string -> exn +val err_lex : Lexing.position -> 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 |