ghc-tags-plugin-0.6.2.0: lib/Plugin/GhcTags.hs
{-# LANGUAGE CPP #-}
{-# LANGUAGE BangPatterns #-}
{-# LANGUAGE GADTs #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE RankNTypes #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeApplications #-}
{-# OPTIONS_GHC -Wno-incomplete-uni-patterns #-}
module Plugin.GhcTags ( plugin, Options (..) ) where
import Control.Exception
import Control.Monad (when)
#if MIN_VERSION_GLASGOW_HASKELL(9,6,0,0)
import Control.Monad.State.Strict
#else
import Control.Monad.State.Strict hiding (when, void)
#endif
import Data.ByteString (ByteString)
import qualified Data.ByteString as BS
import qualified Data.ByteString.Char8 as BSC
import qualified Data.ByteString.Lazy as BSL
import qualified Data.ByteString.Builder as BB
import Data.Functor (void)
import qualified Data.Text as Text
import qualified Data.Text.Encoding as Text
import Data.Functor.Identity (Identity (..))
import Data.List (sortBy)
import Data.Either (partitionEithers, rights)
import Data.Foldable (traverse_)
import Data.Maybe (mapMaybe)
#if MIN_VERSION_filepath(1,4,100)
import qualified System.OsPath as OsPath
import System.Directory.OsPath
#else
import System.Directory
#endif
import qualified System.FilePath as FilePath
import System.IO
import Options.Applicative.Types (ParserFailure (..))
import qualified Pipes
import Pipes.Safe (SafeT)
import qualified Pipes.Safe
import qualified Pipes.ByteString as Pipes.BS
import GHC.Driver.Plugins
( CommandLineOption
, Plugin (..)
)
import qualified GHC.Driver.Plugins as GhcPlugins
import GHC.Driver.Env ( Hsc
, HscEnv (..)
)
import GHC.Hs (HsParsedModule (..))
import GHC.Unit.Module.ModSummary
(ModSummary (..))
import GHC.Types.Meta ( MetaHook
, MetaRequest (..)
, MetaResult
, metaRequestAW
, metaRequestD
, metaRequestE
, metaRequestP
, metaRequestT
)
import GHC.Driver.Hooks (Hooks (..))
import GHC.Unit.Types (Module)
import GHC.Unit.Module.Location (ModLocation (..))
import GHC.Tc.Types (TcM)
import GHC.Tc.Gen.Splice (defaultRunMeta)
import GHC.Types.SrcLoc (Located)
import qualified GHC.Types.SrcLoc as GHC (SrcSpan (..), getLoc, srcSpanFile)
import GHC.Driver.Session (DynFlags)
import GHC.Hs (GhcPs, GhcTc, HsModule (..), LHsDecl, LHsExpr)
import GHC.Utils.Outputable (($+$), ($$))
import qualified GHC.Utils.Outputable as Out
import qualified GHC.Utils.Ppr.Colour as PprColour
import GHC.Data.FastString (bytesFS)
import GhcTags.Ghc
import GhcTags.Tag
import GhcTags.Stream
import qualified GhcTags.CTag as CTag
import qualified GhcTags.ETag as ETag
import Plugin.GhcTags.Options
import Plugin.GhcTags.FileLock
import qualified Plugin.GhcTags.CTag as CTag
#if MIN_VERSION_GLASGOW_HASKELL(9,6,0,0)
type GhcPsModule = HsModule GhcPs
#else
type GhcPsModule = HsModule
#endif
-- | The GhcTags plugin. It will run for every compiled module and have access
-- to parsed syntax tree. It will inspect it and:
--
-- * update a global mutable state variable, which stores a tag map.
-- It is shared across modules compiled in the same `ghc` run.
-- * update 'tags' file.
--
-- The global mutable variable save us from parsing the tags file for every
-- compiled module.
--
-- __The syntax tree is left unchanged.__
--
-- The tags file will contain location information about:
--
-- * /top level terms/
-- * /data types/
-- * /record fields/
-- * /type synonyms/
-- * /type classes/
-- * /type class members/
-- * /type class instances/
-- * /type families/ /(standalone and associated)/
-- * /type family instances/ /(standalone and associated)/
-- * /data type families/ /(standalone and associated)/
-- * /data type families instances/ /(standalone and associated)/
-- * /data type family instances constructors/ /(standalone and associated)/
--
plugin :: Plugin
plugin = GhcPlugins.defaultPlugin {
parsedResultAction =
-- TODO: add warnings / errors to 'ParsedResult'
\args summary result@GhcPlugins.ParsedResult { GhcPlugins.parsedResultModule } ->
result <$ ghcTagsParserPlugin args summary parsedResultModule,
driverPlugin = ghcTagsDriverPlugin,
pluginRecompile = GhcPlugins.purePlugin
}
-- | IOException wrapper; it is useful for the user to know that it's the plugin
-- not `ghc` that thrown the error.
--
data GhcTagsPluginException
= GhcTagsParserPluginIOException IOException
| GhcTagsDynFlagsPluginIOException IOException
deriving Show
instance Exception GhcTagsPluginException
-- | The plugin does not change the 'HsParedModule', it only runs side effects.
--
ghcTagsParserPlugin :: [CommandLineOption]
-> ModSummary
-> HsParsedModule
-> Hsc HsParsedModule
ghcTagsParserPlugin options
moduleSummary@ModSummary {ms_mod, ms_hspp_opts = dynFlags}
hsParsedModule@HsParsedModule {hpm_module} =
hsParsedModule <$
case runOptionParser options of
Success opts@Options { filePath = Identity tagsFile
, debug
} ->
liftIO $ do
#if MIN_VERSION_filepath(1,4,100)
tagsPath <- OsPath.encodeUtf tagsFile
#endif
-- wrap 'IOException's
handle (\ioerr -> do
putDocLn dynFlags
(messageDoc UnhandledException (Just ms_mod)
(displayException ioerr))
throwIO (GhcTagsParserPluginIOException ioerr)) $
-- Take advisory exclusive lock (a BSD lock using `flock`) on the tags
-- file. This is needed when `cabal` compiles in parallel.
-- We take the lock on the copy, otherwise the lock would be removed when
-- we move the file.
withFileLock debug (lockFilePath tagsFile) ExclusiveLock $ \_ -> do
mbInSize <-
if debug
then Just <$> getFileSize
#if MIN_VERSION_filepath(1,4,100)
tagsPath
#else
tagsFile
#endif
`catch` \(_ :: IOException) -> pure 0
else pure Nothing
updateTags opts moduleSummary hpm_module
when debug $ do
let Just inSize = mbInSize
outSize <- getFileSize
#if MIN_VERSION_filepath(1,4,100)
tagsPath
#else
tagsFile
#endif
when (inSize > outSize)
$ liftIO
$ putDocLn dynFlags
(messageDoc SizeWarning
(Just ms_mod)
(concat [ show inSize
, "→"
, show outSize
]))
Failure (ParserFailure f) ->
liftIO $
putDocLn dynFlags
(messageDoc
OptionParserFailure
(Just ms_mod)
(show (case f "<ghc-tags-plugin>" of (h, _, _) -> h)
++ " " ++ show options))
CompletionInvoked {} -> error "ghc-tags-plugin: impossible happend"
data MessageType =
ReadException
| ParserException
| WriteException
| UnhandledException
| OptionParserFailure
| DebugMessage
| SizeWarning
instance Show MessageType where
show ReadException = "read error"
show ParserException = "tags parser error"
show WriteException = "write error"
show UnhandledException = "unhandled error"
show OptionParserFailure = "plugin options parser error"
show SizeWarning = "tags file shrinked"
show DebugMessage = ""
-- | Extract tags from a module and update tags file
--
updateTags :: Options Identity
-> ModSummary
-> Located GhcPsModule
-> IO ()
updateTags Options { etags, stream, filePath = Identity tagsFile, debug }
ModSummary {ms_mod, ms_location, ms_hspp_opts = dynFlags}
lmodule = do
case (etags, stream) of
(False, True) -> updateCTags_stream
(False, False) -> updateCTags
(True, _) -> updateETags
where
updateCTags_stream, updateCTags, updateETags :: IO ()
--
-- update ctags (streaming)
--
-- Stream ctags from from the tags file and intersperse tags parsed from
-- the current module. The results are written to a destination file which
-- is then renamed to tags file.
updateCTags_stream = do
#if MIN_VERSION_filepath(1,4,100)
tagsPath <- OsPath.encodeUtf tagsFile
#endif
tagsFileExists <- doesFileExist
#if MIN_VERSION_filepath(1,4,100)
tagsPath
#else
tagsFile
#endif
let destFile = case FilePath.splitFileName tagsFile of
(dir, name) -> dir FilePath.</> "." ++ name
mbInSize <-
if debug
then
if tagsFileExists
then Just <$> getFileSize
#if MIN_VERSION_filepath(1,4,100)
tagsPath
#else
tagsFile
#endif
`catch` \(_ :: IOException) -> pure 0
else pure (Just 0)
else pure Nothing
withFile destFile WriteMode $ \writeHandle ->
withFile tagsFile ReadWriteMode $ \readHandle -> do
#if MIN_VERSION_filepath(1,4,100)
cwd <- getCurrentDirectory
#else
cwd <- rawFilePathFromBS . BSC.pack <$> getCurrentDirectory
#endif
-- absolute directory path of the tags file; we need canonical path
-- (without ".." and ".") to make 'makeRelative' works.
#if MIN_VERSION_filepath(1,4,100)
tagsDir <- canonicalizePath (fst $ OsPath.splitFileName tagsPath)
#else
tagsDir <- rawFilePathFromBS . BSC.pack <$> canonicalizePath (fst $ FilePath.splitFileName tagsFile)
#endif
case ml_hs_file ms_location of
Nothing -> pure ()
Just sourcePath -> do
let sourcePathBS = rawFilePathFromBS $ Text.encodeUtf8 (Text.pack sourcePath)
-- path of the compiled module; it is relative to the cabal file,
-- not the project.
modulePath =
case GHC.getLoc lmodule of
GHC.RealSrcSpan rss _ ->
rawFilePathFromBS
. bytesFS
. GHC.srcSpanFile
$ rss
GHC.UnhelpfulSpan {} ->
fixFilePath cwd tagsDir sourcePathBS
-- text parser
producer :: Pipes.Producer ByteString (SafeT IO) ()
producer
| tagsFileExists =
void (Pipes.BS.fromHandle readHandle)
`Pipes.Safe.catchP` \(e :: IOException) ->
Pipes.lift $ Pipes.liftIO $
-- don't re-throw; this would kill `ghc`, error
-- loudly and continue.
putDocLn dynFlags (messageDoc ReadException (Just ms_mod) (displayException e))
| otherwise = pure ()
-- tags pipe
pipe :: Pipes.Effect (StateT Int (StateT [CTag] (SafeT IO))) ()
pipe =
Pipes.for
(Pipes.hoist Pipes.lift $ Pipes.hoist Pipes.lift (tagParser (either (const Nothing) Just <$> CTag.parseTagLine) producer)
`Pipes.Safe.catchP` \(e :: IOException) ->
Pipes.lift $ Pipes.liftIO $
-- don't re-throw; this would kill `ghc`, error
-- loudly and continue.
putDocLn dynFlags $ messageDoc ParserException (Just ms_mod) (displayException e)
)
-- merge tags
(\tag -> do
-- update tags counter
modify' succ
Pipes.hoist Pipes.lift $
runCombineTagsPipe writeHandle
CTag.compareTags
CTag.formatTag
modulePath
tag
`Pipes.Safe.catchP` \(e :: IOException) ->
Pipes.lift $ Pipes.liftIO $
-- don't re-throw; this would kill `ghc`, error
-- loudly and continue.
putDocLn dynFlags $ messageDoc WriteException (Just ms_mod) (displayException e)
)
let tags :: [CTag]
tags = map (fixTagFilePath cwd tagsDir)
-- fix file names
. filterAdjacentTags
. sortBy compareTags -- sort
. mapMaybe (ghcTagToTag SingCTag dynFlags)
-- translate 'GhcTag' to 'Tag'
. getGhcTags -- generate 'GhcTag's
$ lmodule
-- Write header
BSL.hPut writeHandle (BB.toLazyByteString (foldMap CTag.formatHeader CTag.headers))
-- update tags file / run 'pipe'
(parsedTags, tags') <- Pipes.Safe.runSafeT $ runStateT (execStateT (Pipes.runEffect pipe) 0) tags
-- write the remaining tags'
traverse_ (BSL.hPut writeHandle . BB.toLazyByteString . CTag.formatTag) tags'
hFlush writeHandle
when debug $ do
outSize <- getFileSize
#if MIN_VERSION_filepath(1,4,100)
tagsPath
#else
tagsFile
#endif
let Just inSize = mbInSize
printMessageDoc dynFlags DebugMessage (Just ms_mod)
(concat [ "path: "
, show modulePath
, " parsed: "
, show parsedTags
, " found: "
, show (length tags + length tags')
, " in-size: "
, show inSize
, " out-size: "
, show outSize
])
#if MIN_VERSION_filepath(1,4,100)
destPath <- OsPath.encodeUtf destFile
destFileExists <- doesFileExist destPath
#else
destFileExists <- doesFileExist destFile
#endif
when destFileExists $
#if MIN_VERSION_filepath(1,4,100)
renameFile destPath tagsPath
#else
renameFile destFile tagsFile
#endif
--
-- update ctags (non streaming)
--
updateCTags = do
#if MIN_VERSION_filepath(1,4,100)
tagsPath <- OsPath.encodeUtf tagsFile
tagsFileExists <- doesFileExist tagsPath
#else
tagsFileExists <- doesFileExist tagsFile
#endif
mbInSize <-
if debug
then
if tagsFileExists
then
#if MIN_VERSION_filepath(1,4,100)
Just <$> getFileSize tagsPath
`catch` \(_ :: IOException) -> pure 0
#else
Just <$> getFileSize tagsFile
`catch` \(_ :: IOException) -> pure 0
#endif
else pure (Just 0)
else pure Nothing
!tagsContent <- if tagsFileExists
then BS.readFile tagsFile
else return mempty
withFile tagsFile WriteMode $ \writeHandle -> do
#if MIN_VERSION_filepath(1,4,100)
cwd <- getCurrentDirectory
#else
cwd <- rawFilePathFromBS . BSC.pack <$> getCurrentDirectory
#endif
-- absolute directory path of the tags file; we need canonical path
-- (without ".." and ".") to make 'makeRelative' works.
#if MIN_VERSION_filepath(1,4,100)
tagsDir <- canonicalizePath (fst $ OsPath.splitFileName tagsPath)
#else
tagsDir <- rawFilePathFromBS . BSC.pack <$> canonicalizePath (fst $ FilePath.splitFileName tagsFile)
#endif
case ml_hs_file ms_location of
Nothing -> pure ()
Just sourcePath -> do
let sourcePathBS = rawFilePathFromBS $ Text.encodeUtf8 (Text.pack sourcePath)
-- path of the compiled module; it is relative to the cabal file,
-- not the project.
modulePath =
case GHC.getLoc lmodule of
GHC.RealSrcSpan rss _ ->
rawFilePathFromBS
. bytesFS
. GHC.srcSpanFile
$ rss
GHC.UnhelpfulSpan {} ->
fixFilePath cwd tagsDir sourcePathBS
pres <- try @IOException $ CTag.parseTagsFile tagsContent
case pres of
Left err ->
putDocLn dynFlags $ messageDoc ParserException (Just ms_mod) (displayException err)
Right (Left err) ->
printMessageDoc dynFlags ParserException (Just ms_mod) err
Right (Right parsed) -> do
let parsedTags = rights parsed
tags :: [CTag]
tags = map (fixTagFilePath cwd tagsDir)
-- fix file names
. filterAdjacentTags
. sortBy compareTags -- sort
. mapMaybe (ghcTagToTag SingCTag dynFlags)
-- translate 'GhcTag' to 'Tag'
. getGhcTags -- generate 'GhcTag's
$ lmodule
combined :: [CTag]
combined = combineTags CTag.compareTags modulePath tags parsedTags
BB.hPutBuilder writeHandle
( foldMap CTag.formatHeader CTag.headers
<> foldMap CTag.formatTag combined
)
when debug $ do
#if MIN_VERSION_filepath(1,4,100)
outSize <- getFileSize tagsPath
#else
outSize <- getFileSize tagsFile
#endif
let Just inSize = mbInSize
printMessageDoc dynFlags DebugMessage (Just ms_mod)
(concat [ "parsed: "
, show (length parsedTags)
, " found: "
, show (length tags)
, " in-size: "
, show inSize
, " out-size: "
, show outSize
])
--
-- update etags file
--
updateETags = do
#if MIN_VERSION_filepath(1,4,100)
tagsPath <- OsPath.encodeUtf tagsFile
tagsFileExists <- doesFileExist tagsPath
#else
tagsFileExists <- doesFileExist tagsFile
#endif
mbInSize <-
if debug
then
if tagsFileExists
then
#if MIN_VERSION_filepath(1,4,100)
Just <$> getFileSize tagsPath
`catch` \(_ :: IOException) -> pure 0
#else
Just <$> getFileSize tagsFile
`catch` \(_ :: IOException) -> pure 0
#endif
else pure (Just 0)
else pure Nothing
!tagsContent <- if tagsFileExists
then BS.readFile tagsFile
else return mempty
withFile tagsFile WriteMode $ \writeHandle -> do
#if MIN_VERSION_filepath(1,4,100)
cwd <- getCurrentDirectory
#else
cwd <- rawFilePathFromBS . BSC.pack <$> getCurrentDirectory
#endif
-- absolute directory path of the tags file; we need canonical path
-- (without ".." and ".") to make 'makeRelative' works.
#if MIN_VERSION_filepath(1,4,100)
tagsDir <- canonicalizePath (fst $ OsPath.splitFileName tagsPath)
#else
tagsDir <- rawFilePathFromBS . BSC.pack <$> canonicalizePath (fst $ FilePath.splitFileName tagsFile)
#endif
case ml_hs_file ms_location of
Nothing -> pure ()
Just sourcePath -> do
pres <- try @IOException $ ETag.parseTagsFile tagsContent
case pres of
Left err ->
putDocLn dynFlags $ messageDoc ParserException (Just ms_mod) (displayException err)
Right (Left err) ->
printMessageDoc dynFlags ParserException (Just ms_mod) err
Right (Right parsedTags) -> do
let sourcePathBS = rawFilePathFromBS
$ Text.encodeUtf8 (Text.pack sourcePath)
modulePath =
case GHC.getLoc lmodule of
GHC.RealSrcSpan rss _ ->
rawFilePathFromBS
. bytesFS
. GHC.srcSpanFile
$ rss
GHC.UnhelpfulSpan {} ->
fixFilePath cwd tagsDir sourcePathBS
tags :: [ETag]
tags = filterAdjacentTags
. sortBy ETag.compareTags
. map (fixTagFilePath cwd tagsDir)
. mapMaybe (ghcTagToTag SingETag dynFlags)
. getGhcTags
$ lmodule
combined :: [ETag]
combined = combineTags ETag.compareTags modulePath tags parsedTags
BB.hPutBuilder writeHandle (ETag.formatETagsFile combined)
when debug $ do
#if MIN_VERSION_filepath(1,4,100)
outSize <- getFileSize tagsPath
#else
outSize <- getFileSize tagsFile
#endif
let Just inSize = mbInSize
printMessageDoc dynFlags DebugMessage (Just ms_mod)
(concat [ "parsed: "
, show (length parsedTags)
, " found: "
, show (length tags)
, " in-size: "
, show inSize
, " out-size: "
, show outSize
])
-- | Filter adjacent tags.
--
filterAdjacentTags :: [Tag tk] -> [Tag tk]
filterAdjacentTags tags =
foldr
(\(mprev, c, mnext) acc ->
case (mprev, mnext) of
-- filter out terms preceded by a type signature
(Just p, _) | tagName p == tagName c
, TkTypeSignature <- tagKind p
, k <- tagKind c
, k == TkTerm
|| k == TkFunction
-> acc
-- filter out type constructors followed by a data constructor
(_, Just n) | tagName c == tagName n
, TkTypeConstructor <- tagKind c
, k <- tagKind n
, k == TkDataConstructor
|| k == TkGADTConstructor
-> acc
_ -> c : acc
)
[]
(zip3 tags' tags tags'')
where
-- previous
tags' = case tags of
[] -> []
_ -> Nothing : map Just (init tags)
-- next
tags'' = case tags of
[] -> []
_:ts -> map Just ts ++ [Nothing]
--
-- Tags for Template-Haskell splices
--
ghcTagsDriverPlugin :: [CommandLineOption] -> HscEnv -> IO HscEnv
ghcTagsDriverPlugin opts env@HscEnv{ hsc_hooks } = do
let hook = ghcTagsMetaHook opts (hsc_dflags env)
return env { hsc_hooks = hsc_hooks { runMetaHook = Just hook } }
-- | DynFlags plugin which extract tags from TH splices.
--
ghcTagsMetaHook :: [CommandLineOption] -> DynFlags -> MetaHook TcM
ghcTagsMetaHook options dynFlags request expr =
case runOptionParser options of
Success Options { filePath = Identity tagsFile
, etags
, debug
} -> do
withMetaD defaultRunMeta request expr $ \decls ->
liftIO $
handle (\ioerr -> do
putDocLn dynFlags
(messageDoc UnhandledException Nothing
(displayException ioerr))
throwIO (GhcTagsDynFlagsPluginIOException ioerr)) $
withFileLock debug (lockFilePath tagsFile) ExclusiveLock $ \_ -> do
#if MIN_VERSION_filepath(1,4,100)
cwd <- getCurrentDirectory
#else
cwd <- rawFilePathFromBS . BSC.pack <$> getCurrentDirectory
#endif
#if MIN_VERSION_filepath(1,4,100)
tagsPath <- OsPath.encodeUtf tagsFile
tagsDir <- canonicalizePath (fst $ OsPath.splitFileName tagsPath)
#else
tagsDir <- rawFilePathFromBS . BSC.pack <$> canonicalizePath (fst $ FilePath.splitFileName tagsFile)
#endif
tagsContent <- BSC.readFile tagsFile
if etags
then do
pr <- ETag.parseTagsFile tagsContent
case pr of
Left err ->
printMessageDoc dynFlags ParserException Nothing err
Right tags -> do
let tags' :: [ETag]
tags' = sortBy ETag.compareTags $
tags
++
(fmap (fixTagFilePath cwd tagsDir)
. ghcTagToTag SingETag dynFlags)
`mapMaybe`
hsDeclsToGhcTags Nothing decls
BSL.writeFile tagsFile (BB.toLazyByteString $ ETag.formatTagsFile tags')
else do
pr <- fmap partitionEithers <$> CTag.parseTagsFile tagsContent
case pr of
Left err ->
printMessageDoc dynFlags ParserException Nothing err
Right (headers, tags) -> do
let tags' :: [Either CTag.Header CTag]
tags' = Left `map` headers
++ Right `map`
sortBy CTag.compareTags
( tags
++
(fmap (fixTagFilePath cwd tagsDir)
. ghcTagToTag SingCTag dynFlags)
`mapMaybe`
hsDeclsToGhcTags Nothing decls
)
BSL.writeFile tagsFile (BB.toLazyByteString $ CTag.formatTagsFile tags')
Failure (ParserFailure f) ->
withMetaD defaultRunMeta request expr $ \_ ->
liftIO $
putDocLn dynFlags
(messageDoc
OptionParserFailure
Nothing
(show (case f "<ghc-tags-plugin>" of (h, _, _) -> h)
++ " " ++ show options))
CompletionInvoked {} -> error "ghc-tags-plugin: impossible happend"
where
-- run the hook and call call the callback with new declarations
withMetaD :: MetaHook TcM -> MetaRequest -> LHsExpr GhcTc
-> ([LHsDecl GhcPs] -> TcM a)
-> TcM MetaResult
withMetaD h req e f = case req of
MetaE k -> k <$> metaRequestE h e
MetaP k -> k <$> metaRequestP h e
MetaT k -> k <$> metaRequestT h e
MetaD k -> do
res <- metaRequestD h e
k res <$ f res
MetaAW k -> k <$> metaRequestAW h e
--
-- File path utils
--
fixFilePath :: RawFilePath
-- ^ current directory
-> RawFilePath
-- ^ tags file directory
-> RawFilePath
-- ^ tag's file path
-> RawFilePath
fixFilePath cwd tagsDir =
normaliseRawFilePath
. makeRelativeRawFilePath tagsDir
. (cwd </>)
-- we are missing `Text` based `FilePath` library!
fixTagFilePath :: RawFilePath
-- ^ current directory
-> RawFilePath
-- ^ tags file directory
-> Tag tk -> Tag tk
fixTagFilePath cwd tagsDir tag@Tag { tagFilePath = TagFilePath fp } =
tag { tagFilePath =
TagFilePath
( Text.decodeUtf8 . rawFilePathToBS
$ fixFilePath cwd tagsDir
(rawFilePathFromBS $ Text.encodeUtf8 fp))
}
lockFilePath :: FilePath -> FilePath
lockFilePath tagsFile =
case FilePath.splitFileName tagsFile of
(dir, name) -> dir FilePath.</> "." ++ name ++ ".lock"
--
-- Error Formatting
--
data MessageSeverity
= Debug
| Warning
| Error
messageDoc :: MessageType -> Maybe Module -> String -> Out.SDoc
messageDoc errorType mb_mod errorMessage =
Out.blankLine
$+$
Out.coloured PprColour.colBold
(Out.text "GhcTagsPlugin: "
Out.<> Out.coloured messageColour (Out.text $ show errorType))
$$
case mb_mod of
Just mod_ ->
Out.coloured PprColour.colBold (Out.nest 4 $ Out.ppr mod_)
Nothing -> Out.empty
$$
(Out.nest 8 $ Out.coloured messageColour (Out.text errorMessage))
$+$
Out.blankLine
$+$ case severity of
Error ->
Out.coloured PprColour.colBold (Out.text "Please report this bug to: ")
Out.<> Out.text "https://github.com/coot/ghc-tags-plugin/issues"
$+$ Out.blankLine
Warning -> Out.blankLine
Debug -> Out.blankLine
where
severity = case errorType of
ReadException -> Error
ParserException -> Error
WriteException -> Error
UnhandledException -> Error
OptionParserFailure -> Warning
SizeWarning -> Warning
DebugMessage -> Debug
messageColour = case severity of
Error -> PprColour.colRedFg
Warning -> PprColour.colBlueFg
Debug -> PprColour.colCyanFg
putDocLn :: DynFlags -> Out.SDoc -> IO ()
putDocLn _dynFlags sdoc =
putStrLn $
Out.renderWithContext
Out.defaultSDocContext { Out.sdocStyle = Out.mkErrStyle Out.neverQualify }
sdoc
printMessageDoc :: DynFlags -> MessageType -> Maybe Module -> String -> IO ()
printMessageDoc dynFlags = (fmap . fmap . fmap) (putDocLn dynFlags) messageDoc