X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=utils%2Fghctags%2FGhcTags.hs;h=fe760978d06dc5002ba2b6ccd783e579f2928ead;hb=1034ef27adc8473722d612bb4d8e3ebf40618770;hp=88c2dcbd0201fc2a32800b20473e6da1dd8eedbe;hpb=6735097cdbe113e74555a5a748b0648e5ed762b5;p=ghc-hetmet.git diff --git a/utils/ghctags/GhcTags.hs b/utils/ghctags/GhcTags.hs index 88c2dcb..fe76097 100644 --- a/utils/ghctags/GhcTags.hs +++ b/utils/ghctags/GhcTags.hs @@ -1,19 +1,22 @@ module Main where import Bag import Char +import DriverPhases ( isHaskellSrcFilename ) import DynFlags(GhcMode, defaultDynFlags) +import ErrUtils ( printBagOfErrors ) import FastString import GHC import HscTypes (msHsFilePath) -import List import IO +import List +import Maybe import Name import Outputable import SrcLoc import System.Environment import System.Console.GetOpt import System.Exit - +import Util ( handle, handleDyn ) -- search for definitions of things -- we do this by parsing the source and grabbing top-level definitions @@ -21,12 +24,28 @@ import System.Exit -- We generate both CTAGS and ETAGS format tags files -- The former is for use in most sensible editors, while EMACS uses ETAGS -{- -placateGhc :: IO () -placateGhc = defaultErrorHandler defaultDynFlags $ do - GHC.init (Just "/usr/local/lib/ghc-6.5") -- or your build tree! - s <- newSession mode --} +--------------------------------- +--------- CONFIGURATION --------- + +ghcRootDir = "/usr/local/lib/ghc-6.5" --- root for -package ghc? (passed to GHC.init) + + +---------------------------------- +---- CENTRAL DATA TYPES ---------- + +type FileName = String +type ThingName = String -- name of a defined entity in a Haskell program + +-- A definition we have found (we know its containing module, name, and location) +data FoundThing = FoundThing ModuleName ThingName SrcLoc + +-- Data we have obtained from a file (list of things we found) +data FileData = FileData FileName [FoundThing] +--- invariant (not checked): every found thing has a source location in that file? + + +------------------------------ +-------- MAIN PROGRAM -------- main :: IO () main = do @@ -36,48 +55,36 @@ main = do args <- getArgs let (ghcArgs, ourArgs, unbalanced) = splitArgs args let (modes, filenames, errs) = getOpt Permute options ourArgs - if unbalanced || errs /= [] || elem Help modes || filenames == [] + let (hsfiles, otherfiles) = List.partition isHaskellSrcFilename filenames + mapM_ (\n -> putStr $ "Warning: ignoring non-Haskellish file " ++ n ++ "\n") + otherfiles + if unbalanced || errs /= [] || elem Help modes || hsfiles == [] then do putStr $ unlines errs putStr $ usageInfo usageString options exitWith (ExitFailure 1) else return () - let mode = getMode (Append `delete` modes) - let openFileMode = if elem Append modes - then AppendMode - else WriteMode - GHC.init (Just "/usr/local/lib/ghc-6.5") GHC.defaultErrorHandler defaultDynFlags $ do - session <- newSession JustTypecheck - print "created a session" + session <- newSession (Just ghcRootDir) flags <- getSessionDynFlags session (pflags, _) <- parseDynamicFlags flags ghcArgs - let flags = pflags { hscTarget = HscNothing } + let flags = pflags { hscTarget = HscNothing } -- don't generate anything GHC.defaultCleanupHandler flags $ do - flags <- initPackages flags setSessionDynFlags session flags - setTargets session (map fileTarget filenames) - print "set targets" - success <- load session LoadAllTargets --- bring module graph up to date - filedata <- case success of - Failed -> do { putStr "Load failed"; exitWith (ExitFailure 2) } - Succeeded -> do - print "loaded all targets" - graph <- getModuleGraph session - print "got modules graph" - graphData session graph - 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 () + -- 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 + + +---------------------------------------------- +---------- ARGUMENT PROCESSING -------------- + +data Mode = ETags | CTags | BothTags | Append | Help 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 @@ -89,15 +96,14 @@ getMode (x:xs) = max x (getMode xs) splitArgs :: [String] -> ([String], [String], Bool) --- pull out arguments between -- for GHC +-- ^Pull out arguments between -- for GHC splitArgs args = split [] [] False args where split ghc' tags' unbal ("--" : args) = split tags' ghc' (not unbal) args split ghc' tags' unbal (arg : args) = split ghc' (arg:tags') unbal args split ghc' tags' unbal [] = (reverse ghc', reverse tags', unbal) -data Mode = ETags | CTags | BothTags | Append | Help deriving (Ord, Eq, Show) - options :: [OptDescr Mode] +-- supports getopt options = [ Option "c" ["ctags"] (NoArg CTags) "generate CTAGS file (ctags)" , Option "e" ["etags"] @@ -109,31 +115,157 @@ options = [ Option "c" ["ctags"] , Option "h" ["help"] (NoArg Help) "This help" ] -type FileName = String - -type ThingName = String --- The position of a token or definition -data Pos = Pos - FileName -- file name - Int -- line number - Int -- token number - String -- string that makes up that line - deriving Show +---------------------------------------------------------------- +--- LOADING HASKELL SOURCE +--- (these bits actually run the compiler and produce abstract syntax) + +safeLoad :: Session -> LoadHowMuch -> IO SuccessFlag +-- like GHC.load, but does not stop process on exception +safeLoad session mode = do + dflags <- getSessionDynFlags session + handle (\exception -> return Failed ) $ + handleDyn (\dyn -> do printBagOfErrors dflags (unitBag dyn) + return Failed) $ load session mode + + +targetsAtOneGo :: Session -> [FileName] -> IO (Maybe [FileData]) +-- load a list of targets +targetsAtOneGo session hsfiles = do + let targets = map fileTarget 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 + +fileTarget :: FileName -> Target +fileTarget filename = Target (TargetFile filename Nothing) Nothing -srcLocToPos :: SrcLoc -> Pos -srcLocToPos loc = - Pos (unpackFS $ srcLocFile loc) (srcLocLine loc) (srcLocCol loc) "bogus" +--------------------------------------------------------------- +----- CRAWLING ABSTRACT SYNTAX TO SNAFFLE THE DEFINITIONS ----- --- A definition we have found -data FoundThing = FoundThing ThingName Pos - deriving Show +graphData :: Session -> ModuleGraph -> IO [FileData] +graphData session graph = + 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 --- Data we have obtained from a file -data FileData = FileData FileName [FoundThing] +fileData :: FileName -> ModuleName -> RenamedSource -> FileData +fileData filename modname (group, _imports, _lie, _doc, _haddock) = + -- lie is related to type checking and so is irrelevant + -- imports contains import declarations and no definitions + -- doc and haddock seem haddock-related; let's hope to ignore them + FileData filename (boundValues modname group) -data Token = Token String Pos - deriving Show +boundValues :: ModuleName -> HsGroup Name -> [FoundThing] +-- ^Finds all the top-level definitions in a module +boundValues mod group = + let vals = case hs_valds group of + ValBindsOut nest sigs -> + [ x | (_rec, binds) <- nest, bind <- bagToList binds, + x <- boundThings mod bind ] + tys = concat $ map tyBound (hs_tyclds group) + where tyBound ltcd = case unLoc ltcd of + ForeignType { tcdLName = n } -> [found n] + TyData { tcdLName = tycon, tcdCons = cons } -> + dataNames tycon cons + TySynonym { tcdLName = n } -> [found n] + ClassDecl { tcdLName = n } -> [found n] + fors = concat $ map forBound (hs_fords group) + where forBound lford = case unLoc lford of + ForeignImport n _ _ -> [found n] + ForeignExport { } -> [] + in vals ++ tys ++ fors + where dataNames tycon cons = found tycon : map conName cons + conName td = found $ con_name $ unLoc td + found = foundOfLName mod + +startOfLocated :: Located a -> SrcLoc +startOfLocated lHs = srcSpanStart $ getLoc lHs + +foundOfLName :: ModuleName -> Located Name -> FoundThing +foundOfLName mod id = FoundThing mod (getOccString $ unLoc id) (startOfLocated id) + +boundThings :: ModuleName -> LHsBind Name -> [FoundThing] +boundThings modname lbinding = + case unLoc lbinding of + FunBind { fun_id = id } -> [thing id] + PatBind { pat_lhs = lhs } -> patThings lhs [] + VarBind { var_id = id } -> [FoundThing modname (getOccString id) (startOfLocated lbinding)] + AbsBinds { } -> [] -- nothing interesting in a type abstraction + where thing = foundOfLName modname + patThings lpat tl = + let loc = startOfLocated lpat + lid id = FoundThing modname (getOccString id) loc + in case unLoc lpat of + WildPat _ -> tl + VarPat name -> lid name : tl + VarPatOut name _ -> lid name : tl -- XXX need help here + LazyPat p -> patThings p tl + AsPat id p -> patThings p (thing id : tl) + ParPat p -> patThings p tl + BangPat p -> patThings p tl + ListPat ps _ -> foldr patThings tl ps + TuplePat ps _ _ -> foldr patThings tl ps + PArrPat ps _ -> foldr patThings tl ps + ConPatIn _ conargs -> conArgs conargs tl + ConPatOut _ _ _ _ conargs _ -> conArgs conargs tl + LitPat _ -> tl + NPat _ _ _ _ -> tl -- form of literal pattern? + NPlusKPat id _ _ _ -> thing id : tl + TypePat _ -> tl -- XXX need help here + SigPatIn p _ -> patThings p tl + SigPatOut p _ -> patThings p tl + conArgs (PrefixCon ps) tl = foldr patThings tl ps + 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 @@ -141,15 +273,19 @@ data Token = Token String Pos writectagsfile :: Handle -> [FileData] -> IO () writectagsfile ctagsfile filedata = do let things = concat $ map getfoundthings filedata - mapM_ (\x -> hPutStrLn ctagsfile $ dumpthing x) things + mapM_ (\x -> hPutStrLn ctagsfile $ dumpthing False x) things + mapM_ (\x -> hPutStrLn ctagsfile $ dumpthing True x) things getfoundthings :: FileData -> [FoundThing] getfoundthings (FileData filename things) = things -dumpthing :: FoundThing -> String -dumpthing (FoundThing name (Pos filename line _ _)) = - name ++ "\t" ++ filename ++ "\t" ++ (show $ line + 1) - +dumpthing :: Bool -> FoundThing -> String +dumpthing showmod (FoundThing modname name loc) = + fullname ++ "\t" ++ filename ++ "\t" ++ (show $ line + 1) + where line = srcLocLine loc + filename = unpackFS $ srcLocFile loc + fullname = if showmod then moduleNameString modname ++ "." ++ name + else name -- stuff for dealing with etags output format @@ -165,85 +301,7 @@ e_dumpfiledata (FileData filename things) = thingslength = length thingsdump e_dumpthing :: FoundThing -> String -e_dumpthing (FoundThing name (Pos filename line token fullline)) = - ---- (concat $ take (token + 1) $ spacedwords fullline) - name - ++ "\x7f" ++ (show line) ++ "," ++ (show $ line+1) ++ "\n" - - --- like "words", but keeping the whitespace, and so letting us build --- accurate prefixes - -spacedwords :: String -> [String] -spacedwords [] = [] -spacedwords xs = (blanks ++ wordchars):(spacedwords rest2) - where - (blanks,rest) = span Char.isSpace xs - (wordchars,rest2) = span (\x -> not $ Char.isSpace x) rest - - --- Find the definitions in a file - -modsummary :: ModuleGraph -> FileName -> Maybe ModSummary -modsummary graph n = - List.find matches graph - where matches ms = n == msHsFilePath ms - -modname :: ModSummary -> ModuleName -modname summary = moduleName $ ms_mod $ summary - -fileTarget :: FileName -> Target -fileTarget filename = Target (TargetFile filename Nothing) Nothing - -graphData :: Session -> ModuleGraph -> IO [FileData] -graphData session graph = - mapM foundthings graph - where foundthings ms = - let filename = msHsFilePath ms - in do mod <- checkModule session (moduleName $ ms_mod ms) - return $ maybe (FileData filename []) id $ do - m <- mod - s <- renamedSource m - return $ fileData filename s - -fileData :: FileName -> RenamedSource -> FileData -fileData filename (group, imports, lie) = - -- lie is related to type checking and so is irrelevant - -- imports contains import declarations and no definitions - FileData filename (boundValues group) - -boundValues :: HsGroup Name -> [FoundThing] -boundValues group = - let vals = case hs_valds group of - ValBindsOut nest sigs -> - [ x | (_rec, binds) <- nest, bind <- bagToList binds, x <- boundThings bind ] - tys = concat $ map tyBound (hs_tyclds group) - where tyBound ltcd = case unLoc ltcd of - ForeignType { tcdLName = n } -> [foundOfLName n] - TyData { tcdLName = tycon, tcdCons = cons } -> - dataNames tycon cons - TySynonym { tcdLName = n } -> [foundOfLName n] - ClassDecl { tcdLName = n } -> [foundOfLName n] - fors = concat $ map forBound (hs_fords group) - where forBound lford = case unLoc lford of - ForeignImport n _ _ -> [foundOfLName n] - ForeignExport { } -> [] - in vals ++ tys ++ fors - where dataNames tycon cons = foundOfLName tycon : map conName cons - conName td = foundOfLName $ con_name $ unLoc td - -posOfLocated :: Located a -> Pos -posOfLocated lHs = srcLocToPos $ srcSpanStart $ getLoc lHs - -foundOfLName :: Located Name -> FoundThing -foundOfLName id = FoundThing (getOccString $ unLoc id) (posOfLocated id) - -boundThings :: LHsBind Name -> [FoundThing] -boundThings lbinding = - let thing = foundOfLName - in case unLoc lbinding of - FunBind { fun_id = id } -> [thing id] - PatBind { pat_lhs = lhs } -> panic "Pattern at top level" - VarBind { var_id = id } -> [FoundThing (getOccString id) (posOfLocated lbinding)] - AbsBinds { } -> [] -- nothing interesting in a type abstraction - +e_dumpthing (FoundThing modname name loc) = + tagline name ++ tagline (moduleNameString modname ++ "." ++ name) + where tagline n = n ++ "\x7f" ++ (show line) ++ "," ++ (show $ line+1) ++ "\n" + line = srcLocLine loc