<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>src/HLint.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE RecordWildCards #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>HLint</span><span class='hs-layout'>(</span><span class='hs-varid'>hlint</span><span class='hs-layout'>,</span> <span class='hs-conid'>Suggestion</span><span class='hs-layout'>,</span> <span class='hs-varid'>suggestionLocation</span><span class='hs-layout'>,</span> <span class='hs-varid'>suggestionSeverity</span><span class='hs-layout'>,</span> <span class='hs-conid'>Severity</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-4"></a>
<a name="line-5"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span>
<a name="line-6"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>List</span>
<a name="line-7"></a>
<a name="line-8"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>CmdLine</span>
<a name="line-9"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Settings</span>
<a name="line-10"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Report</span>
<a name="line-11"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Idea</span>
<a name="line-12"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Apply</span>
<a name="line-13"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Test</span>
<a name="line-14"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Util</span>
<a name="line-15"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Parallel</span>
<a name="line-16"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>HSE</span><span class='hs-varop'>.</span><span class='hs-conid'>All</span>
<a name="line-17"></a>
<a name="line-18"></a>
<a name="line-19"></a><a name="Suggestion"></a><span class='hs-comment'>-- | A suggestion - the @Show@ instance is of particular use.</span>
<a name="line-20"></a><a name="Suggestion"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>Suggestion</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Suggestion</span> <span class='hs-layout'>{</span><span class='hs-varid'>fromSuggestion</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Idea</span><span class='hs-layout'>}</span>
<a name="line-21"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span><span class='hs-conid'>Ord</span><span class='hs-layout'>)</span>
<a name="line-22"></a>
<a name="line-23"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Show</span> <span class='hs-conid'>Suggestion</span> <span class='hs-keyword'>where</span>
<a name="line-24"></a> <span class='hs-varid'>show</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>show</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fromSuggestion</span>
<a name="line-25"></a>
<a name="line-26"></a><a name="suggestionLocation"></a><span class='hs-comment'>-- | From a suggestion, extract the file location it refers to.</span>
<a name="line-27"></a><span class='hs-definition'>suggestionLocation</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Suggestion</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>SrcLoc</span>
<a name="line-28"></a><span class='hs-definition'>suggestionLocation</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>loc</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fromSuggestion</span>
<a name="line-29"></a>
<a name="line-30"></a>
<a name="line-31"></a><a name="suggestionSeverity"></a><span class='hs-comment'>-- | From a suggestion, determine how severe it is.</span>
<a name="line-32"></a><span class='hs-definition'>suggestionSeverity</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Suggestion</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Severity</span>
<a name="line-33"></a><span class='hs-definition'>suggestionSeverity</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>severity</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fromSuggestion</span>
<a name="line-34"></a>
<a name="line-35"></a>
<a name="line-36"></a>
<a name="line-37"></a><a name="hlint"></a><span class='hs-comment'>-- | This function takes a list of command line arguments, and returns the given suggestions.</span>
<a name="line-38"></a><span class='hs-comment'>-- To see a list of arguments type @hlint --help@ at the console.</span>
<a name="line-39"></a><span class='hs-comment'>-- This function writes to the stdout/stderr streams, unless @--quiet@ is specified.</span>
<a name="line-40"></a><span class='hs-comment'>--</span>
<a name="line-41"></a><span class='hs-comment'>-- As an example:</span>
<a name="line-42"></a><span class='hs-comment'>--</span>
<a name="line-43"></a><span class='hs-comment'>-- > do hints <- hlint ["src", "--ignore=Use map","--quiet"]</span>
<a name="line-44"></a><span class='hs-comment'>-- > when (length hints > 3) $ error "Too many hints!"</span>
<a name="line-45"></a><span class='hs-definition'>hlint</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Suggestion</span><span class='hs-keyglyph'>]</span>
<a name="line-46"></a><span class='hs-definition'>hlint</span> <span class='hs-varid'>args</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-47"></a> <span class='hs-varid'>cmd</span><span class='hs-keyglyph'>@</span><span class='hs-conid'>Cmd</span><span class='hs-layout'>{</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>}</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getCmd</span> <span class='hs-varid'>args</span>
<a name="line-48"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>flags</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>parseFlags</span><span class='hs-layout'>{</span><span class='hs-varid'>cppFlags</span><span class='hs-keyglyph'>=</span><span class='hs-varid'>cmdCpp</span><span class='hs-layout'>,</span> <span class='hs-varid'>encoding</span><span class='hs-keyglyph'>=</span><span class='hs-varid'>cmdEncoding</span><span class='hs-layout'>,</span> <span class='hs-varid'>language</span><span class='hs-keyglyph'>=</span><span class='hs-varid'>cmdLanguage</span><span class='hs-layout'>}</span>
<a name="line-49"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>cmdTest</span> <span class='hs-keyword'>then</span>
<a name="line-50"></a> <span class='hs-varid'>test</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>hlint</span> <span class='hs-varid'>x</span> <span class='hs-varop'>>></span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span> <span class='hs-varid'>cmdDataDir</span> <span class='hs-varid'>cmdGivenHints</span> <span class='hs-varop'>>></span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span>
<a name="line-51"></a> <span class='hs-keyword'>else</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>null</span> <span class='hs-varid'>cmdFiles</span> <span class='hs-varop'>&&</span> <span class='hs-varid'>notNull</span> <span class='hs-varid'>cmdFindHints</span> <span class='hs-keyword'>then</span>
<a name="line-52"></a> <span class='hs-varid'>mapM_</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>putStrLn</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fst</span> <span class='hs-varop'>=<<</span> <span class='hs-varid'>findSettings</span> <span class='hs-varid'>flags</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span> <span class='hs-varid'>cmdFindHints</span> <span class='hs-varop'>>></span> <span class='hs-varid'>return</span> <span class='hs-conid'>[]</span>
<a name="line-53"></a> <span class='hs-keyword'>else</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>null</span> <span class='hs-varid'>cmdFiles</span> <span class='hs-keyword'>then</span>
<a name="line-54"></a> <span class='hs-varid'>exitWithHelp</span>
<a name="line-55"></a> <span class='hs-keyword'>else</span>
<a name="line-56"></a> <span class='hs-varid'>runHints</span> <span class='hs-varid'>cmd</span> <span class='hs-varid'>flags</span>
<a name="line-57"></a>
<a name="line-58"></a>
<a name="line-59"></a><a name="runHints"></a><span class='hs-definition'>runHints</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Cmd</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ParseFlags</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Suggestion</span><span class='hs-keyglyph'>]</span>
<a name="line-60"></a><span class='hs-definition'>runHints</span> <span class='hs-conid'>Cmd</span><span class='hs-layout'>{</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>}</span> <span class='hs-varid'>flags</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-61"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>outStrLn</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unless</span> <span class='hs-varid'>cmdQuiet</span> <span class='hs-varop'>$</span> <span class='hs-varid'>putStrLn</span> <span class='hs-varid'>x</span>
<a name="line-62"></a> <span class='hs-varid'>settings1</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>readSettings</span> <span class='hs-varid'>cmdDataDir</span> <span class='hs-varid'>cmdHintFiles</span>
<a name="line-63"></a> <span class='hs-varid'>settings2</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>concatMapM</span> <span class='hs-layout'>(</span><span class='hs-varid'>fmap</span> <span class='hs-varid'>snd</span> <span class='hs-varop'>.</span> <span class='hs-varid'>findSettings</span> <span class='hs-varid'>flags</span><span class='hs-layout'>)</span> <span class='hs-varid'>cmdFindHints</span>
<a name="line-64"></a> <span class='hs-varid'>settings3</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>return</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Classify</span> <span class='hs-conid'>Ignore</span> <span class='hs-varid'>x</span> <span class='hs-layout'>(</span><span class='hs-str'>""</span><span class='hs-layout'>,</span><span class='hs-str'>""</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>cmdIgnore</span><span class='hs-keyglyph'>]</span>
<a name="line-65"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>settings</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>settings1</span> <span class='hs-varop'>++</span> <span class='hs-varid'>settings2</span> <span class='hs-varop'>++</span> <span class='hs-varid'>settings3</span>
<a name="line-66"></a>
<a name="line-67"></a> <span class='hs-varid'>ideas</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>fmap</span> <span class='hs-varid'>concat</span> <span class='hs-varop'>$</span> <span class='hs-varid'>parallel</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>listM'</span> <span class='hs-varop'>=<<</span> <span class='hs-varid'>applyHint</span> <span class='hs-varid'>flags</span> <span class='hs-varid'>settings</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>cmdFiles</span><span class='hs-keyglyph'>]</span>
<a name="line-68"></a> <span class='hs-keyword'>let</span> <span class='hs-layout'>(</span><span class='hs-varid'>showideas</span><span class='hs-layout'>,</span><span class='hs-varid'>hideideas</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>partition</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>i</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>cmdShowAll</span> <span class='hs-varop'>||</span> <span class='hs-varid'>severity</span> <span class='hs-varid'>i</span> <span class='hs-varop'>/=</span> <span class='hs-conid'>Ignore</span><span class='hs-layout'>)</span> <span class='hs-varid'>ideas</span>
<a name="line-69"></a> <span class='hs-varid'>showItem</span> <span class='hs-keyglyph'><-</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>cmdColor</span> <span class='hs-keyword'>then</span> <span class='hs-varid'>showANSI</span> <span class='hs-keyword'>else</span> <span class='hs-varid'>return</span> <span class='hs-varid'>show</span>
<a name="line-70"></a> <span class='hs-varid'>mapM_</span> <span class='hs-layout'>(</span><span class='hs-varid'>outStrLn</span> <span class='hs-varop'>.</span> <span class='hs-varid'>showItem</span><span class='hs-layout'>)</span> <span class='hs-varid'>showideas</span>
<a name="line-71"></a>
<a name="line-72"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>null</span> <span class='hs-varid'>showideas</span> <span class='hs-keyword'>then</span>
<a name="line-73"></a> <span class='hs-varid'>when</span> <span class='hs-layout'>(</span><span class='hs-varid'>cmdReports</span> <span class='hs-varop'>/=</span> <span class='hs-conid'>[]</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>outStrLn</span> <span class='hs-str'>"Skipping writing reports"</span>
<a name="line-74"></a> <span class='hs-keyword'>else</span>
<a name="line-75"></a> <span class='hs-varid'>forM_</span> <span class='hs-varid'>cmdReports</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>x</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-76"></a> <span class='hs-varid'>outStrLn</span> <span class='hs-varop'>$</span> <span class='hs-str'>"Writing report to "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>x</span> <span class='hs-varop'>++</span> <span class='hs-str'>" ..."</span>
<a name="line-77"></a> <span class='hs-varid'>writeReport</span> <span class='hs-varid'>cmdDataDir</span> <span class='hs-varid'>x</span> <span class='hs-varid'>showideas</span>
<a name="line-78"></a> <span class='hs-varid'>outStrLn</span> <span class='hs-varop'>$</span>
<a name="line-79"></a> <span class='hs-layout'>(</span><span class='hs-keyword'>let</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>length</span> <span class='hs-varid'>showideas</span> <span class='hs-keyword'>in</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>i</span> <span class='hs-varop'>==</span> <span class='hs-num'>0</span> <span class='hs-keyword'>then</span> <span class='hs-str'>"No suggestions"</span> <span class='hs-keyword'>else</span> <span class='hs-varid'>show</span> <span class='hs-varid'>i</span> <span class='hs-varop'>++</span> <span class='hs-str'>" suggestion"</span> <span class='hs-varop'>++</span> <span class='hs-keyglyph'>[</span><span class='hs-chr'>'s'</span><span class='hs-keyglyph'>|</span><span class='hs-varid'>i</span><span class='hs-varop'>/=</span><span class='hs-num'>1</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-varop'>++</span>
<a name="line-80"></a> <span class='hs-layout'>(</span><span class='hs-keyword'>let</span> <span class='hs-varid'>i</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>length</span> <span class='hs-varid'>hideideas</span> <span class='hs-keyword'>in</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>i</span> <span class='hs-varop'>==</span> <span class='hs-num'>0</span> <span class='hs-keyword'>then</span> <span class='hs-str'>""</span> <span class='hs-keyword'>else</span> <span class='hs-str'>" ("</span> <span class='hs-varop'>++</span> <span class='hs-varid'>show</span> <span class='hs-varid'>i</span> <span class='hs-varop'>++</span> <span class='hs-str'>" ignored)"</span><span class='hs-layout'>)</span>
<a name="line-81"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>map</span> <span class='hs-conid'>Suggestion</span> <span class='hs-varid'>showideas</span>
</pre></body>
</html>
