<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Utils.html">
<link rel="next" href="Images.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="IgnoreParser" rel="Chapter" href="IgnoreParser.html">
<link title="ConfigParser" rel="Chapter" href="ConfigParser.html">
<link title="IgnoreLexer" rel="Chapter" href="IgnoreLexer.html">
<link title="ConfigLexer" rel="Chapter" href="ConfigLexer.html">
<link title="CategoryName" rel="Chapter" href="CategoryName.html">
<link title="OutputName" rel="Chapter" href="OutputName.html">
<link title="OcamldocUtils" rel="Chapter" href="OcamldocUtils.html">
<link title="Annotation" rel="Chapter" href="Annotation.html">
<link title="Ignore" rel="Chapter" href="Ignore.html">
<link title="Utils" rel="Chapter" href="Utils.html">
<link title="Report" rel="Chapter" href="Report.html">
<link title="Images" rel="Chapter" href="Images.html">
<link title="Output" rel="Chapter" href="Output.html">
<link title="ParameterName" rel="Chapter" href="ParameterName.html">
<link title="Ocamldep" rel="Chapter" href="Ocamldep.html">
<link title="Cache" rel="Chapter" href="Cache.html">
<link title="Check" rel="Chapter" href="Check.html">
<link title="Camlp4Utils" rel="Chapter" href="Camlp4Utils.html">
<link title="Configuration" rel="Chapter" href="Configuration.html">
<link title="State" rel="Chapter" href="State.html">
<link title="Plugin" rel="Chapter" href="Plugin.html">
<link title="Aspell" rel="Chapter" href="Aspell.html">
<link title="CheckName" rel="Chapter" href="CheckName.html">
<link title="Parameter" rel="Chapter" href="Parameter.html">
<link title="Version" rel="Chapter" href="Version.html">
<link title="RollingHash" rel="Chapter" href="RollingHash.html">
<link title="Args" rel="Chapter" href="Args.html">
<link title="Predefined" rel="Chapter" href="Predefined.html">
<link title="Html" rel="Chapter" href="Html.html">
<link title="Jdepend" rel="Chapter" href="Jdepend.html">
<link title="Xml" rel="Chapter" href="Xml.html">
<link title="Summary" rel="Chapter" href="Summary.html">
<link title="Checkstyle" rel="Chapter" href="Checkstyle.html">
<link title="Binary" rel="Chapter" href="Binary.html">
<link title="Csv" rel="Chapter" href="Csv.html">
<link title="Text" rel="Chapter" href="Text.html">
<link title="Code_uselessExternalParentheses" rel="Chapter" href="Code_uselessExternalParentheses.html">
<link title="Metrics_halstead" rel="Chapter" href="Metrics_halstead.html">
<link title="Typo_header" rel="Chapter" href="Typo_header.html">
<link title="Typo_spacesAroundBlocks" rel="Chapter" href="Typo_spacesAroundBlocks.html">
<link title="Code_tupleSize" rel="Chapter" href="Code_tupleSize.html">
<link title="Doc_classComment" rel="Chapter" href="Doc_classComment.html">
<link title="Code_uselessBinding" rel="Chapter" href="Code_uselessBinding.html">
<link title="Code_builtinTypes" rel="Chapter" href="Code_builtinTypes.html">
<link title="Code_deprecated" rel="Chapter" href="Code_deprecated.html">
<link title="Code_noEffectAssignment" rel="Chapter" href="Code_noEffectAssignment.html">
<link title="Typo_tabCharacter" rel="Chapter" href="Typo_tabCharacter.html">
<link title="Code_nestedWhile" rel="Chapter" href="Code_nestedWhile.html">
<link title="Interf_exportedEmpty" rel="Chapter" href="Interf_exportedEmpty.html">
<link title="Doc_spell" rel="Chapter" href="Doc_spell.html">
<link title="Code_parameterCount" rel="Chapter" href="Code_parameterCount.html">
<link title="Code_length" rel="Chapter" href="Code_length.html">
<link title="Code_nestedTry" rel="Chapter" href="Code_nestedTry.html">
<link title="Doc_moduleComment" rel="Chapter" href="Doc_moduleComment.html">
<link title="Code_identifierLength" rel="Chapter" href="Code_identifierLength.html">
<link title="Code_negatedIf" rel="Chapter" href="Code_negatedIf.html">
<link title="Interf_duplicate" rel="Chapter" href="Interf_duplicate.html">
<link title="Code_nestedFor" rel="Chapter" href="Code_nestedFor.html">
<link title="Code_nestedIf" rel="Chapter" href="Code_nestedIf.html">
<link title="Code_ignoreUnit" rel="Chapter" href="Code_ignoreUnit.html">
<link title="Doc_classTypeComment" rel="Chapter" href="Doc_classTypeComment.html">
<link title="Code_textualDuplicate" rel="Chapter" href="Code_textualDuplicate.html">
<link title="Typo_spacesAroundOperators" rel="Chapter" href="Typo_spacesAroundOperators.html">
<link title="Code_idempotentOperations" rel="Chapter" href="Code_idempotentOperations.html">
<link title="Code_physicalComparisons" rel="Chapter" href="Code_physicalComparisons.html">
<link title="Typo_lineLength" rel="Chapter" href="Typo_lineLength.html">
<link title="Code_complexCondition" rel="Chapter" href="Code_complexCondition.html">
<link title="Interf_exportedCount" rel="Chapter" href="Interf_exportedCount.html">
<link title="Doc_typeComment" rel="Chapter" href="Doc_typeComment.html">
<link title="Typo_trailingNewLine" rel="Chapter" href="Typo_trailingNewLine.html">
<link title="Typo_fileLength" rel="Chapter" href="Typo_fileLength.html">
<link title="Code_emptyFor" rel="Chapter" href="Code_emptyFor.html">
<link title="Doc_exceptionComment" rel="Chapter" href="Doc_exceptionComment.html">
<link title="Typo_spacesAroundPunctuation" rel="Chapter" href="Typo_spacesAroundPunctuation.html">
<link title="Doc_valueComment" rel="Chapter" href="Doc_valueComment.html">
<link title="Code_stringLiterals" rel="Chapter" href="Code_stringLiterals.html">
<link title="Code_emptyWhile" rel="Chapter" href="Code_emptyWhile.html">
<link title="Code_magicNumber" rel="Chapter" href="Code_magicNumber.html">
<link title="Misc_regexp" rel="Chapter" href="Misc_regexp.html">
<link title="Code_catchAll" rel="Chapter" href="Code_catchAll.html">
<link title="Interf_methodCount" rel="Chapter" href="Interf_methodCount.html">
<link title="Metrics_mccabe" rel="Chapter" href="Metrics_mccabe.html">
<link title="Metrics_coupling" rel="Chapter" href="Metrics_coupling.html">
<link title="Doc_moduleTypeComment" rel="Chapter" href="Doc_moduleTypeComment.html">
<link title="Code_emptyTry" rel="Chapter" href="Code_emptyTry.html">
<link title="Code_predefinedOperators" rel="Chapter" href="Code_predefinedOperators.html">
<link title="Code_predefinedExceptions" rel="Chapter" href="Code_predefinedExceptions.html">
<link title="Code_open" rel="Chapter" href="Code_open.html">
<link title="Typo_trailingWhiteSpace" rel="Chapter" href="Typo_trailingWhiteSpace.html"><link title="Base elements" rel="Section" href="#6_Baseelements">
<link title="Reports" rel="Section" href="#6_Reports">
<title>Report</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Utils.html" title="Utils">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Images.html" title="Images">Next</a>
</div>
<h1>Module <a href="type_Report.html">Report</a></h1>
<pre><span class="keyword">module</span> Report: <code class="code">sig</code> <a href="Report.html">..</a> <code class="code">end</code></pre><div class="info module top">
Reports of check violations.<br>
</div>
<hr width="100%">
<br>
<h6 id="6_Baseelements">Base elements</h6><br>
<pre><code><span id="TYPEkind"><span class="keyword">type</span> <code class="type"></code>kind</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Info"><span class="constructor">Info</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Lowest level of element.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Warning"><span class="constructor">Warning</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Medium level of element.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTkind.Error"><span class="constructor">Error</span></span></code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Highest level of element.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
<div class="info ">
The type of element kinds, that is the level of a report element.<br>
</div>
<pre><span id="VALstring_of_kind"><span class="keyword">val</span> string_of_kind</span> : <code class="type"><a href="Report.html#TYPEkind">kind</a> -> string</code></pre><div class="info ">
Converts the passed kind into a string.<br>
</div>
<pre><code><span id="TYPEelement"><span class="keyword">type</span> <code class="type"></code>element</span> = private {</code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTelement.kind">kind</span> : <code class="type"><a href="Report.html#TYPEkind">kind</a></code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Kind (level) of element.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTelement.category">category</span> : <code class="type"><a href="CategoryName.html#TYPEt">CategoryName.t</a></code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Category of element.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTelement.check">check</span> : <code class="type"><a href="CheckName.html#TYPEt">CheckName.t</a></code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Check of element.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTelement.filename">filename</span> : <code class="type">string</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Location of violation.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTelement.line">line</span> : <code class="type">int</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Location of violation.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTelement.column">column</span> : <code class="type">int option</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Location of violation.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTelement.message">message</span> : <code class="type">string</code>;</code></td>
<td class="typefieldcomment" align="left" valign="top" ><code>(*</code></td><td class="typefieldcomment" align="left" valign="top" >Short description of violation.</td><td class="typefieldcomment" align="left" valign="bottom" ><code>*)</code></td>
</tr></table>
}
<div class="info ">
The type of report element, that is check violations.<br>
</div>
<br>
<h6 id="6_Reports">Reports</h6><br>
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> </pre>
<div class="info ">
The type of reports, that is collections of elements.<br>
</div>
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type"><a href="Report.html#TYPEt">t</a></code></pre><div class="info ">
The empty report.<br>
</div>
<pre><span id="VALstatistics"><span class="keyword">val</span> statistics</span> : <code class="type"><a href="Report.html#TYPEt">t</a> -> int * int * int</code></pre><div class="info ">
Returns the numbers of <code class="code">Info</code>, <code class="code">Warning</code>, and <code class="code">Error</code> element in the passed
report.<br>
</div>
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type"><a href="Report.html#TYPEkind">kind</a> -><br> <a href="CategoryName.html#TYPEt">CategoryName.t</a> -><br> <a href="CheckName.html#TYPEt">CheckName.t</a> -> string -> int -> int option -> string -> <a href="Report.html#TYPEt">t</a> -> <a href="Report.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">add knd cat chk fn ln cn msg x</code> returns <code class="code">x</code> augmented with a new element,
duplicate elements being discarded.
<p>
The added element is defined by:<ul>
<li>its kind <code class="code">knd</code>;</li>
<li>its category name <code class="code">cat</code>;</li>
<li>its check name <code class="code">chk</code>;</li>
<li>its filename <code class="code">fn</code>;</li>
<li>its line <code class="code">ln</code>;</li>
<li>its column <code class="code">cn</code>;</li>
<li>its message <code class="code">msg</code>.</li>
</ul>
<br>
</div>
<pre><span id="VALconcat"><span class="keyword">val</span> concat</span> : <code class="type"><a href="Report.html#TYPEt">t</a> -> <a href="Report.html#TYPEt">t</a> -> <a href="Report.html#TYPEt">t</a></code></pre><div class="info ">
Concatenates the passed reports into a new one.<br>
</div>
<pre><span id="VALconcat_list"><span class="keyword">val</span> concat_list</span> : <code class="type"><a href="Report.html#TYPEt">t</a> list -> <a href="Report.html#TYPEt">t</a></code></pre><div class="info ">
Concatenates the passed list of reports into a new one.<br>
</div>
<pre><span id="VALfilter"><span class="keyword">val</span> filter</span> : <code class="type">bool -> bool -> bool -> <a href="Ignore.html#TYPEt">Ignore.t</a> list -> <a href="Report.html#TYPEt">t</a> -> <a href="Report.html#TYPEt">t</a></code></pre><div class="info ">
<code class="code">filter no_info no_warning no_error il rep</code> filters the report elements of
<code class="code">rep</code> by ignoring elements in <code class="code">il</code>; additionally:<ul>
<li><code class="code">no_info</code> indicates whether <code class="code">Info</code> elements are ignored;</li>
<li><code class="code">no_warning</code> indicates whether <code class="code">Warning</code> elements are ignored;</li>
<li><code class="code">no_error</code> indicates whether <code class="code">Error</code> elements are ignored.</li>
</ul>
<br>
</div>
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">(<a href="Report.html#TYPEelement">element</a> -> unit) -> <a href="Report.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<code class="code">iter f rep</code> iterates over the report elements of <code class="code">rep</code> by applying <code class="code">f</code>.<br>
</div>
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">(<a href="Report.html#TYPEelement">element</a> -> 'a) -> <a href="Report.html#TYPEt">t</a> -> 'a list</code></pre><div class="info ">
<code class="code">map f rep</code> maps the report elements of <code class="code">rep</code> through <code class="code">f</code>.<br>
</div>
<pre><span id="VALfold"><span class="keyword">val</span> fold</span> : <code class="type">(<a href="Report.html#TYPEelement">element</a> -> 'a -> 'a) -> 'a -> <a href="Report.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
<code class="code">fold f z rep</code> folds over the report elements of <code class="code">rep</code>, starting with
value <code class="code">z</code> and using function <code class="code">f</code>.<br>
</div>
<pre><span id="VALsplit_by_file"><span class="keyword">val</span> split_by_file</span> : <code class="type"><a href="Report.html#TYPEt">t</a> -> (string * <a href="Report.html#TYPEt">t</a>) list</code></pre><div class="info ">
Splits the passed report, returning an association list from filenames
to associated (sub-)reports.<br>
</div>
</body></html>
