[project @ 2004-07-19 11:51:16 by simonmar]
[ghc-hetmet.git] / ghc / utils / hasktags / HaskTags.hs
index 27f32e6..9df6637 100644 (file)
@@ -2,6 +2,7 @@ module Main where
 import System
 import Char
 import List
+import IO
 
 
 -- search for definitions of things 
@@ -11,55 +12,159 @@ import List
 -- bla :: ...          giving a function location
 --
 -- by doing it this way, we avoid picking up local definitions
+--             (whether this is good or not is a matter for debate)
+--
+
+-- We generate both CTAGS and ETAGS format tags files
+-- The former is for use in most sensible editors, while EMACS uses ETAGS
 
 
 main :: IO ()
 main = do
        filenames <- getArgs
-       foundthings <- mapM findthings filenames
-       mapM_ (\x -> putStrLn $ dumpthing x) (concat foundthings)
+       filedata <- mapM findthings filenames
+       ctagsfile <- openFile "tags" WriteMode
+       writectagsfile ctagsfile filedata
+       hClose ctagsfile
+       etagsfile <- openFile "TAGS" WriteMode
+       writeetagsfile etagsfile filedata
+       hClose etagsfile
        
 type FileName = String
 
 type ThingName = String
 
-data Pos = Pos FileName Int
+-- 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
 
+-- A definition we have found
 data FoundThing = FoundThing ThingName Pos
        deriving Show
 
-dumpthing :: FoundThing -> String
-dumpthing (FoundThing name (Pos filename line)) = 
-       name ++ "\t" ++ filename ++ "\t" ++ (show line)
+-- Data we have obtained from a file
+data FileData = FileData FileName [FoundThing]
+       deriving Show
 
 data Token = Token String Pos
        deriving Show
 
-findthings :: FileName -> IO [FoundThing]
-findthings filename = 
-       do
-               text <- readFile filename
-               let aslines = lines text
-               let wordlines = map words aslines 
-               let nocoms = map stripslcomments wordlines
-               let tokens = concat $ zipWith (withline filename) nocoms $ ints 0       
-               return $ findstuff tokens
+
+-- stuff for dealing with ctags output format
+
+writectagsfile :: Handle -> [FileData] -> IO ()
+writectagsfile ctagsfile filedata = do
+       let things = concat $ map getfoundthings filedata
+       mapM_ (\x -> hPutStrLn ctagsfile $ dumpthing 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)
+
+
+-- stuff for dealing with etags output format
+
+writeetagsfile :: Handle -> [FileData] -> IO ()
+writeetagsfile etagsfile filedata = do
+       mapM_ (\x -> hPutStr etagsfile $ e_dumpfiledata x) filedata
+
+e_dumpfiledata :: FileData -> String
+e_dumpfiledata (FileData filename things) = 
+       "\x0c\n" ++ filename ++ "," ++ (show thingslength) ++ "\n" ++ thingsdump
+       where 
+               thingsdump = concat $ map e_dumpthing things 
+               thingslength = length thingsdump
+
+e_dumpthing :: FoundThing -> String
+e_dumpthing (FoundThing name (Pos filename line token fullline)) =
+       (concat $ take (token + 1) $ spacedwords fullline) 
+       ++ "\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
        
-withline :: FileName -> [String] -> Int -> [Token]
-withline fname words i = map (\w -> Token w (Pos fname i)) words 
+       
+-- Find the definitions in a file      
+       
+findthings :: FileName -> IO FileData
+findthings filename = do
+       text <- readFile filename
+       let aslines = lines text
+       let wordlines = map words aslines
+       let noslcoms = map stripslcomments wordlines
+       let tokens = concat $ zipWith3 (withline filename) noslcoms 
+                                       aslines [0 ..]
+       let nocoms = stripblockcomments tokens
+       return $ FileData filename $ findstuff nocoms
+       
+-- Create tokens from words, by recording their line number
+-- and which token they are through that line
+
+withline :: FileName -> [String] -> String -> Int -> [Token]           
+withline filename words fullline i = 
+       zipWith (\w t -> Token w (Pos filename i t fullline)) words $ [0 ..]
+
+-- comments stripping
 
 stripslcomments :: [String] -> [String]
-stripslcomments ("--":xs) = []
-stripslcomments (x:xs) = x : stripslcomments xs 
+stripslcomments (x:xs) | isPrefixOf "--" x = []
+                                          | otherwise = x : stripslcomments xs
 stripslcomments [] = []
 
+stripblockcomments :: [Token] -> [Token]
+stripblockcomments ((Token "\\end{code}" _):xs) = 
+       stripblockcomments $ afterlitend xs
+stripblockcomments ((Token "{-" _):xs) = 
+       stripblockcomments $ afterblockcomend xs
+stripblockcomments (x:xs) = x:stripblockcomments xs
+stripblockcomments [] = []
+
+afterlitend2 :: [Token] -> [Token]
+afterlitend2 (x:xs) = afterlitend xs
+afterlitend2 [] = []
+
+afterlitend :: [Token] -> [Token]
+afterlitend ((Token "\\begin{code}" _):xs) = xs
+afterlitend (x:xs) = afterlitend xs
+afterlitend [] = []
+
+afterblockcomend :: [Token] -> [Token]
+afterblockcomend ((Token token _):xs) | contains "-}" token = xs
+                                               | otherwise = afterblockcomend xs
+afterblockcomend [] = []
+
+
+-- does one string contain another string
+
+contains :: Eq a => [a] -> [a] -> Bool
+contains sub full = any (isPrefixOf sub) $ tails full 
+
 ints :: Int -> [Int]
 ints i = i:(ints $ i+1)
 
+
+-- actually pick up definitions
+
 findstuff :: [Token] -> [FoundThing]
 findstuff ((Token "data" _):(Token name pos):xs) = 
        FoundThing name pos : (getcons xs) ++ (findstuff xs)
+findstuff ((Token "newtype" _):(Token name pos):xs) = 
+       FoundThing name pos : findstuff xs
 findstuff ((Token "type" _):(Token name pos):xs) = 
        FoundThing name pos : findstuff xs
 findstuff ((Token name pos):(Token "::" _):xs) = 
@@ -83,4 +188,3 @@ getcons2 ((Token "|" _):(Token name pos):xs) =
 getcons2 (x:xs) = getcons2 xs
 getcons2 [] = []
 
-