+{-# OPTIONS_GHC -XCPP -XPatternGuards -Wall #-}
module Main where
+
+import GHC hiding (flags)
+import HscTypes ( isBootSummary )
+import BasicTypes
+import Digraph ( flattenSCCs )
+import DriverPhases ( isHaskellSrcFilename )
+import HscTypes ( msHsFilePath )
+import Name ( getOccString )
+import ErrUtils ( printBagOfErrors )
+import DynFlags ( defaultDynFlags )
+import SrcLoc
import Bag
-import Char
-import DriverPhases ( isHaskellSrcFilename )
-import DynFlags(GhcMode, defaultDynFlags)
-import ErrUtils ( printBagOfErrors )
+import Util ( handle, handleDyn )
import FastString
-import GHC
-import HscTypes (msHsFilePath)
-import IO
-import List
-import Maybe
-import Name
-import Outputable
-import SrcLoc
+
+import Prelude hiding (mapM)
+import Control.Monad hiding (mapM)
import System.Environment
import System.Console.GetOpt
import System.Exit
-import Util ( handle, handleDyn )
+import Data.Char
+import System.IO
+import Data.List as List
+import Data.Maybe
+import Data.Traversable (mapM)
-- search for definitions of things
-- we do this by parsing the source and grabbing top-level definitions
-- We generate both CTAGS and ETAGS format tags files
-- The former is for use in most sensible editors, while EMACS uses ETAGS
----------------------------------
---------- CONFIGURATION ---------
-
-ghcRootDir = "/usr/local/lib/ghc-6.5" --- root for -package ghc? (passed to GHC.init)
-
-
----------------------------------
---- CENTRAL DATA TYPES ----------
"Usage: " ++ progName ++ " [OPTION...] [-- GHC OPTION... --] [files...]"
args <- getArgs
let (ghcArgs, ourArgs, unbalanced) = splitArgs args
- let (modes, filenames, errs) = getOpt Permute options ourArgs
+ let (flags, filenames, errs) = getOpt Permute options ourArgs
let (hsfiles, otherfiles) = List.partition isHaskellSrcFilename filenames
+ let ghc_topdir = case [ d | FlagTopDir d <- flags ] of
+ [] -> ""
+ (x:_) -> x
mapM_ (\n -> putStr $ "Warning: ignoring non-Haskellish file " ++ n ++ "\n")
otherfiles
- if unbalanced || errs /= [] || elem Help modes || hsfiles == []
+ if unbalanced || errs /= [] || elem FlagHelp flags || hsfiles == []
then do
putStr $ unlines errs
putStr $ usageInfo usageString options
exitWith (ExitFailure 1)
else return ()
- GHC.defaultErrorHandler defaultDynFlags $ do
- session <- newSession JustTypecheck (Just ghcRootDir)
- flags <- getSessionDynFlags session
- (pflags, _) <- parseDynamicFlags flags ghcArgs
- let flags = pflags { hscTarget = HscNothing } -- don't generate anything
- GHC.defaultCleanupHandler flags $ do
- setSessionDynFlags session flags
- -- targets <- mapM (\s -> guessTarget s Nothing) hsfiles
- -- guessTarget would be more compatible with ghc -M
- filedata <- targetsAtOneGo session hsfiles
- filedata <- case filedata of
- Just fd -> return fd
- Nothing -> targetsOneAtATime session hsfiles
- emitTagsData modes filedata
+ let modes = getMode flags
+ let openFileMode = if elem FlagAppend flags
+ then AppendMode
+ else WriteMode
+ ctags_hdl <- if CTags `elem` modes
+ then Just `liftM` openFile "tags" openFileMode
+ else return Nothing
+ etags_hdl <- if ETags `elem` modes
+ then Just `liftM` openFile "TAGS" openFileMode
+ else return Nothing
+
+ GHC.defaultErrorHandler defaultDynFlags $ do
+ session <- newSession (Just ghc_topdir)
+ dflags <- getSessionDynFlags session
+ (pflags, _) <- parseDynamicFlags dflags{ verbosity=1 } ghcArgs
+ let dflags2 = pflags { hscTarget = HscNothing } -- don't generate anything
+ GHC.defaultCleanupHandler dflags2 $ do
+
+ setSessionDynFlags session dflags2
+ targetsAtOneGo session hsfiles (ctags_hdl,etags_hdl)
+ mapM_ (mapM hClose) [ctags_hdl, etags_hdl]
----------------------------------------------
---------- ARGUMENT PROCESSING --------------
-data Mode = ETags | CTags | BothTags | Append | Help deriving (Ord, Eq, Show)
+data Flag
+ = FlagETags
+ | FlagCTags
+ | FlagBoth
+ | FlagAppend
+ | FlagHelp
+ | FlagTopDir FilePath
+ deriving (Ord, Eq, Show)
-- ^Represents options passed to the program
--- | getMode takes a list of modes and extract the mode with the
--- highest precedence. These are as follows: Both, CTags, ETags
--- The default case is Both.
-getMode :: [Mode] -> Mode
-getMode [] = BothTags
-getMode [x] = x
-getMode (x:xs) = max x (getMode xs)
+data Mode = ETags | CTags deriving Eq
+
+getMode :: [Flag] -> [Mode]
+getMode fs = go (concatMap modeLike fs)
+ where go [] = [ETags,CTags]
+ go [x] = [x]
+ go more = nub more
+ modeLike FlagETags = [ETags]
+ modeLike FlagCTags = [CTags]
+ modeLike FlagBoth = [ETags,CTags]
+ modeLike _ = []
splitArgs :: [String] -> ([String], [String], Bool)
-- ^Pull out arguments between -- for GHC
split ghc' tags' unbal (arg : args) = split ghc' (arg:tags') unbal args
split ghc' tags' unbal [] = (reverse ghc', reverse tags', unbal)
-options :: [OptDescr Mode]
+options :: [OptDescr Flag]
-- supports getopt
-options = [ Option "c" ["ctags"]
- (NoArg CTags) "generate CTAGS file (ctags)"
+options = [ Option "" ["topdir"]
+ (ReqArg FlagTopDir "DIR") "root of GHC installation (optional)"
+ , Option "c" ["ctags"]
+ (NoArg FlagCTags) "generate CTAGS file (ctags)"
, Option "e" ["etags"]
- (NoArg ETags) "generate ETAGS file (etags)"
+ (NoArg FlagETags) "generate ETAGS file (etags)"
, Option "b" ["both"]
- (NoArg BothTags) ("generate both CTAGS and ETAGS")
+ (NoArg FlagBoth) ("generate both CTAGS and ETAGS")
, Option "a" ["append"]
- (NoArg Append) ("append to existing CTAGS and/or ETAGS file(s)")
- , Option "h" ["help"] (NoArg Help) "This help"
+ (NoArg FlagAppend) ("append to existing CTAGS and/or ETAGS file(s)")
+ , Option "h" ["help"] (NoArg FlagHelp) "This help"
]
-- like GHC.load, but does not stop process on exception
safeLoad session mode = do
dflags <- getSessionDynFlags session
- handle (\exception -> return Failed ) $
+ handle (\_exception -> return Failed ) $
handleDyn (\dyn -> do printBagOfErrors dflags (unitBag dyn)
return Failed) $ load session mode
-targetsAtOneGo :: Session -> [FileName] -> IO (Maybe [FileData])
+targetsAtOneGo :: Session -> [FileName] -> (Maybe Handle, Maybe Handle) -> IO ()
-- load a list of targets
-targetsAtOneGo session hsfiles = do
- let targets = map fileTarget hsfiles
+targetsAtOneGo session hsfiles handles = do
+ targets <- mapM (\f -> guessTarget f Nothing) hsfiles
setTargets session targets
- print $ "trying " ++ targetInfo hsfiles
- success <- safeLoad session LoadAllTargets --- bring module graph up to date
- case success of
- Failed -> return Nothing
- Succeeded -> do
- print $ "loaded " ++ targetInfo hsfiles
- graph <- getModuleGraph session
- print "got modules graph"
- fd <- graphData session graph
- return $ Just fd
-
- where targetInfo [hs] = "target " ++ hs
- targetInfo hss = show (length hss) ++ " targets at one go"
-
-targetsOneAtATime :: Session -> [FileName] -> IO ([FileData])
--- load a list of targets, one at a time (more resilient to errors)
-targetsOneAtATime session hsfiles = do
- print "trying targets one by one"
- results <- mapM (targetsAtOneGo session) [[f] | f <- hsfiles]
- return $ List.concat $ catMaybes results
-
+ mb_modgraph <- depanal session [] False
+ case mb_modgraph of
+ Nothing -> exitWith (ExitFailure 1)
+ Just modgraph -> do
+ let mods = flattenSCCs $ topSortModuleGraph False modgraph Nothing
+ graphData session mods handles
+
fileTarget :: FileName -> Target
fileTarget filename = Target (TargetFile filename Nothing) Nothing
---------------------------------------------------------------
----- CRAWLING ABSTRACT SYNTAX TO SNAFFLE THE DEFINITIONS -----
-graphData :: Session -> ModuleGraph -> IO [FileData]
-graphData session graph =
- mapM foundthings graph
+graphData :: Session -> ModuleGraph -> (Maybe Handle, Maybe Handle) -> IO ()
+graphData session graph handles = do
+ mapM_ foundthings graph
where foundthings ms =
let filename = msHsFilePath ms
modname = moduleName $ ms_mod ms
- in do mod <- checkModule session modname
- return $ maybe (FileData filename []) id $ do
- m <- mod
- s <- renamedSource m
- return $ fileData filename modname s
+ in do putStrLn ("loading " ++ filename)
+ mb_mod <- checkAndLoadModule session ms False
+ case mb_mod of
+ _ | isBootSummary ms -> return ()
+ Just mod | Just s <- renamedSource mod ->
+ writeTagsData handles (fileData filename modname s)
+ _otherwise ->
+ exitWith (ExitFailure 1)
fileData :: FileName -> ModuleName -> RenamedSource -> FileData
fileData filename modname (group, _imports, _lie, _doc, _haddock) =
-- ^Finds all the top-level definitions in a module
boundValues mod group =
let vals = case hs_valds group of
- ValBindsOut nest sigs ->
+ ValBindsOut nest _sigs ->
[ x | (_rec, binds) <- nest, bind <- bagToList binds,
x <- boundThings mod bind ]
+ _other -> error "boundValues"
tys = concat $ map tyBound (hs_tyclds group)
where tyBound ltcd = case unLoc ltcd of
ForeignType { tcdLName = n } -> [found n]
dataNames tycon cons
TySynonym { tcdLName = n } -> [found n]
ClassDecl { tcdLName = n } -> [found n]
+ _ -> error "boundValues: tys"
fors = concat $ map forBound (hs_fords group)
where forBound lford = case unLoc lford of
ForeignImport n _ _ -> [found n]
ConPatIn _ conargs -> conArgs conargs tl
ConPatOut _ _ _ _ conargs _ -> conArgs conargs tl
LitPat _ -> tl
+#if __GLASGOW_HASKELL__ > 608
+ NPat _ _ _ -> tl -- form of literal pattern?
+#else
NPat _ _ _ _ -> tl -- form of literal pattern?
+#endif
NPlusKPat id _ _ _ -> thing id : tl
TypePat _ -> tl -- XXX need help here
SigPatIn p _ -> patThings p tl
SigPatOut p _ -> patThings p tl
- DictPat _ _ -> tl
+ _ -> error "boundThings"
conArgs (PrefixCon ps) tl = foldr patThings tl ps
- conArgs (RecCon pairs) tl = foldr (\f tl -> patThings (hsRecFieldArg f) tl) tl pairs
+ conArgs (RecCon (HsRecFields { rec_flds = flds })) tl
+ = foldr (\f tl -> patThings (hsRecFieldArg f) tl) tl flds
conArgs (InfixCon p1 p2) tl = patThings p1 $ patThings p2 tl
------------------------------------------------
-------- WRITING THE DATA TO TAGS FILES --------
-
-emitTagsData :: [Mode] -> [FileData] -> IO ()
-emitTagsData modes filedata = do
- let mode = getMode (Append `delete` modes)
- let openFileMode = if elem Append modes
- then AppendMode
- else WriteMode
- if mode == BothTags || mode == CTags
- then do
- ctagsfile <- openFile "tags" openFileMode
- writectagsfile ctagsfile filedata
- hClose ctagsfile
- else return ()
- if mode == BothTags || mode == ETags
- then do
- etagsfile <- openFile "TAGS" openFileMode
- writeetagsfile etagsfile filedata
- hClose etagsfile
- else return ()
-
-
-- stuff for dealing with ctags output format
-writectagsfile :: Handle -> [FileData] -> IO ()
+writeTagsData :: (Maybe Handle, Maybe Handle) -> FileData -> IO ()
+writeTagsData (mb_ctags_hdl, mb_etags_hdl) fd = do
+ maybe (return ()) (\hdl -> writectagsfile hdl fd) mb_ctags_hdl
+ maybe (return ()) (\hdl -> writeetagsfile hdl fd) mb_etags_hdl
+
+writectagsfile :: Handle -> FileData -> IO ()
writectagsfile ctagsfile filedata = do
- let things = concat $ map getfoundthings filedata
+ let things = getfoundthings filedata
mapM_ (\x -> hPutStrLn ctagsfile $ dumpthing False x) things
mapM_ (\x -> hPutStrLn ctagsfile $ dumpthing True x) things
getfoundthings :: FileData -> [FoundThing]
-getfoundthings (FileData filename things) = things
+getfoundthings (FileData _filename things) = things
dumpthing :: Bool -> FoundThing -> String
dumpthing showmod (FoundThing modname name loc) =
-- stuff for dealing with etags output format
-writeetagsfile :: Handle -> [FileData] -> IO ()
-writeetagsfile etagsfile filedata = do
- mapM_ (\x -> hPutStr etagsfile $ e_dumpfiledata x) filedata
+writeetagsfile :: Handle -> FileData -> IO ()
+writeetagsfile etagsfile = hPutStr etagsfile . e_dumpfiledata
e_dumpfiledata :: FileData -> String
e_dumpfiledata (FileData filename things) =