{-# LANGUAGE RecordWildCards #-}
{-# OPTIONS_GHC -Wno-incomplete-patterns #-}
module HLint(hlint, readAllSettings) where
import Control.Applicative
import Control.Monad.Extra
import Control.Exception.Extra
import Control.Concurrent.Extra
import System.Console.CmdArgs.Verbosity
import GHC.Util.DynFlags
import Data.List.Extra
import GHC.Conc
import System.Exit
import System.IO.Extra
import System.Time.Extra
import Data.Tuple.Extra
import Prelude
import CmdLine
import Config.Read
import Config.Type
import Config.Compute
import Report
import Idea
import Apply
import Test.All
import Hint.All
import Grep
import Refact
import Timing
import Test.Proof
import Parallel
import HSE.All
import CC
import EmbedData
hlint :: [String] -> IO [Idea]
hlint args = do
initGlobalDynFlags
cmd <- getCmd args
case cmd of
CmdMain{} -> do
startTimings
(time, xs) <- duration $ hlintMain args cmd
when (cmdTiming cmd) $ do
printTimings
putStrLn $ "Took " ++ showDuration time
pure $ if cmdNoExitCode cmd then [] else xs
CmdGrep{} -> hlintGrep cmd >> pure []
CmdTest{} -> hlintTest cmd >> pure []
hlintTest :: Cmd -> IO ()
hlintTest cmd@CmdTest{..} =
if not $ null cmdProof then do
files <- cmdHintFiles cmd
s <- readFilesConfig files
let reps = if cmdReports == ["report.html"] then ["report.txt"] else cmdReports
mapM_ (proof reps s) cmdProof
else do
failed <- test cmd (\args -> do errs <- hlint args; unless (null errs) $ exitWith $ ExitFailure 1) cmdDataDir cmdGivenHints
when (failed > 0) exitFailure
cmdParseFlags :: Cmd -> ParseFlags
cmdParseFlags cmd = parseFlagsSetLanguage (cmdExtensions cmd) $ defaultParseFlags{cppFlags=cmdCpp cmd}
hlintGrep :: Cmd -> IO ()
hlintGrep cmd@CmdGrep{..} =
if null cmdFiles then
exitWithHelp
else do
files <- concatMapM (resolveFile cmd Nothing) cmdFiles
if null files then
errorIO "No files found"
else
runGrep cmdPattern (cmdParseFlags cmd) files
withVerbosity :: Verbosity -> IO a -> IO a
withVerbosity new act = do
old <- getVerbosity
(setVerbosity new >> act) `finally` setVerbosity old
hlintMain :: [String] -> Cmd -> IO [Idea]
hlintMain args cmd@CmdMain{..}
| cmdDefault = do
ideas <- if null cmdFiles then pure [] else withVerbosity Quiet $
runHlintMain args cmd{cmdJson=False,cmdSerialise=False,cmdRefactor=False} Nothing
let bad = nubOrd $ map ideaHint ideas
if null bad then putStr defaultYaml else do
let group1:groups = splitOn ["",""] $ lines defaultYaml
let group2 = "# Warnings currently triggered by your code" :
["- ignore: {name: " ++ show x ++ "}" | x <- bad]
putStr $ unlines $ intercalate ["",""] $ group1:group2:groups
pure []
| null cmdFiles && not (null cmdFindHints) = do
hints <- concatMapM (resolveFile cmd Nothing) cmdFindHints
mapM_ (putStrLn . fst <=< computeSettings (cmdParseFlags cmd)) hints >> pure []
| null cmdFiles =
exitWithHelp
| cmdRefactor =
withTempFile $ runHlintMain args cmd . Just
| otherwise =
runHlintMain args cmd Nothing
runHlintMain :: [String] -> Cmd -> Maybe FilePath -> IO [Idea]
runHlintMain args cmd tmpFile = do
(cmd, settings) <- readAllSettings args cmd
runHints args settings =<< resolveFiles cmd tmpFile
resolveFiles :: Cmd -> Maybe FilePath -> IO Cmd
resolveFiles cmd@CmdMain{..} tmpFile = do
files <- concatMapM (resolveFile cmd tmpFile) cmdFiles
if null files
then error "No files found"
else pure cmd { cmdFiles = files }
resolveFiles cmd _ = pure cmd
readAllSettings :: [String] -> Cmd -> IO (Cmd, [Setting])
readAllSettings args1 cmd@CmdMain{..} = do
files <- cmdHintFiles cmd
settings1 <-
readFilesConfig $
files
++ [("CommandLine.yaml",Just (enableGroup x)) | x <- cmdWithGroups]
let args2 = [x | SettingArgument x <- settings1]
cmd@CmdMain{..} <- if null args2 then pure cmd else getCmd $ args2 ++ args1
settings2 <- concatMapM (fmap snd . computeSettings (cmdParseFlags cmd)) cmdFindHints
let settings3 = [SettingClassify $ Classify Ignore x "" "" | x <- cmdIgnore]
pure (cmd, settings1 ++ settings2 ++ settings3)
where
enableGroup groupName =
unlines
["- group:"
," name: " ++ groupName
," enabled: true"
]
runHints :: [String] -> [Setting] -> Cmd -> IO [Idea]
runHints args settings cmd@CmdMain{..} = do
j <- if cmdThreads == 0 then getNumProcessors else pure cmdThreads
withNumCapabilities j $ do
let outStrLn = whenNormal . putStrLn
ideas <- getIdeas cmd settings
ideas <- pure $ if cmdShowAll then ideas else filter (\i -> ideaSeverity i /= Ignore) ideas
if cmdJson then
putStrLn $ showIdeasJson ideas
else if cmdCC then
mapM_ (printIssue . fromIdea) ideas
else if cmdSerialise then do
hSetBuffering stdout NoBuffering
print $ map (show &&& ideaRefactoring) ideas
else if cmdRefactor then
handleRefactoring ideas cmdFiles cmd
else do
usecolour <- cmdUseColour cmd
showItem <- if usecolour then showANSI else pure show
mapM_ (outStrLn . showItem) ideas
handleReporting ideas cmd
pure ideas
getIdeas :: Cmd -> [Setting] -> IO [Idea]
getIdeas cmd@CmdMain{..} settings = do
settings <- pure $ settings ++ map (Builtin . fst) builtinHints
let flags = cmdParseFlags cmd
ideas <- if cmdCross
then applyHintFiles flags settings cmdFiles
else concat <$> parallel cmdThreads [evaluateList =<< applyHintFile flags settings x Nothing | x <- cmdFiles]
pure $ if not (null cmdOnly)
then [i | i <- ideas, ideaHint i `elem` cmdOnly]
else ideas
handleRefactoring :: [Idea] -> [String] -> Cmd -> IO ()
handleRefactoring [] _ _ = pure ()
handleRefactoring ideas files cmd@CmdMain{..} =
case cmdFiles of
[file] -> do
path <- checkRefactor (if cmdWithRefactor == "" then Nothing else Just cmdWithRefactor)
let hints = show $ map (show &&& ideaRefactoring) ideas
withTempFile $ \f -> do
writeFile f hints
exitWith =<< runRefactoring path file f cmdRefactorOptions
_ -> errorIO "Refactor flag can only be used with an individual file"
handleReporting :: [Idea] -> Cmd -> IO ()
handleReporting showideas cmd@CmdMain{..} = do
let outStrLn = whenNormal . putStrLn
forM_ cmdReports $ \x -> do
outStrLn $ "Writing report to " ++ x ++ " ..."
writeReport cmdDataDir x showideas
unless cmdNoSummary $ do
let n = length showideas
outStrLn $ if n == 0 then "No hints" else show n ++ " hint" ++ ['s' | n/=1]
evaluateList :: [a] -> IO [a]
evaluateList xs = do
evaluate $ length xs
pure xs