Module Args

module Args: sig .. end
Handling of command-line arguments.

type error = 
| Invalid_output_name of string
| No_configuration_file_specified
| No_output_specified
| No_file_specified
| No_syntax_specified
| Multiple_preprocessors
| Duplicate_check of CategoryName.t * CheckName.t
| Missing_check of CategoryName.t * CheckName.t
exception Exception of error
Exception to be raised when a function of this module fails.
module CategoryMap: Map.S  with type key = CategoryName.t
The type of maps, with CategoryName.t as keys.
val config_file : string Pervasives.ref
Configuration file: definition of activated checks.
val ignore_file : string Pervasives.ref
Ignore file: list of report element to ignore.
val no_warning : bool Pervasives.ref
Whether warnings should be ignored.
val no_error : bool Pervasives.ref
Whether errors should be ignored.
val no_info : bool Pervasives.ref
Whether infos should be ignored.
val disable_cache : bool Pervasives.ref
Whether cache file should be disabled (useful to avoid data corruption by a buggy plugin).
val syntax : string Pervasives.ref
Camlp4 preprocessor to be applied on sources.
val syntax_extensions : string list Pervasives.ref
Arguments to camlp4 preprocessor to be applied on sources.
val preprocessor : string Pervasives.ref
Preprocessor to be applied on sources.
val search_path : string list Pervasives.ref
Where to look for additional files.
val report_only : bool Pervasives.ref
Whether report should be made from binary files.
val outputs : (Output.t * string Pervasives.ref) list Pervasives.ref
Association list from outputs to result destination, an empty string means that the output is not activated. Interpretation of string is output-dependent, but it usually refers to a file name.
val checks : Check.t list CategoryMap.t Pervasives.ref
Available checks, stored in a map from category names to list of checks.
val files : string list Pervasives.ref
List of files to analyze.
val parse : unit -> unit
Loads plugins, and then parses the command-line. Also performs sanity checks over the arguments, raising Exception if such a check fails.
val find_check : Configuration.category -> Configuration.check -> Check.t
find_check cat chk returns the check whose name is chk in the category cat. Raises Exception if such a check does not exist.