git.iko.soy/rowtype-yoga/purescript-native
on golang help sign in
Merge pull request #914 from jacereda/psc-docs-tags

Support ctags/etags generation

commited4fe544272aa97ebc57fe7414f33bb4d1f4543c authorPhil Freeman <paf31@cantab.net> dateTue 24 Feb 2015, 13:57 (12 years ago) parentcd2e91795fd264
4 files changed+79−5
compare with golang
unifiedsplit
psc-docs/Ctags.hs+13 psc-docs/Etags.hs+15 psc-docs/Main.hs+33−5 psc-docs/Tags.hs+18
psc-docs/Ctags.hsnew file+13
@@ -0,0 +1,13 @@
1+module Ctags (dumpCtags) where
2+
3+import qualified Language.PureScript as P
4+import Tags
5+import Data.List (sort)
6+
7+dumpCtags :: [(String, P.Module)] -> [String]
8+dumpCtags = sort . concat . (map renderModCtags)
9+
10+renderModCtags :: (String, P.Module) -> [String]
11+renderModCtags (path, mdl) = sort tagLines
12+ where tagLines = map tagLine $ tags mdl
13+ tagLine (name, line) = name ++ "\t" ++ path ++ "\t" ++ show line
psc-docs/Etags.hsnew file+15
@@ -0,0 +1,15 @@
1+module Etags (dumpEtags) where
2+
3+import qualified Language.PureScript as P
4+import Tags
5+
6+dumpEtags :: [(String, P.Module)] -> [String]
7+dumpEtags = concat . (map renderModEtags)
8+
9+renderModEtags :: (String, P.Module) -> [String]
10+renderModEtags (path, mdl) = ["\x0c", path ++ "," ++ show tagsLen] ++ tagLines
11+ where tagsLen = sum $ map length tagLines
12+ tagLines = map tagLine $ tags mdl
13+ tagLine (name, line) = "\x7f" ++ name ++ "\x01" ++ show line ++ ","
14+
15+
psc-docs/Main.hs+33−5
@@ -30,21 +30,37 @@ import qualified Paths_purescript as Paths
3030import System.Exit (exitSuccess, exitFailure)
3131import System.IO (hPutStrLn, stderr)
3232
33+import Etags
34+import Ctags
35+
36+-- Available output formats
37+data Format = Markdown -- Output documentation in Markdown format
38+ | Ctags -- Output ctags symbol index suitable for use with vi
39+ | Etags -- Output etags symbol index suitable for use with emacs
40+
3341data PSCDocsOptions = PSCDocsOptions
34− { pscdInputFiles :: [FilePath]
42+ { pscdFormat :: Format
43+ , pscdInputFiles :: [FilePath]
3544 }
3645
3746docgen :: PSCDocsOptions -> IO ()
38−docgen (PSCDocsOptions input) = do
47+docgen (PSCDocsOptions fmt input) = do
3948 e <- P.parseModulesFromFiles (fromMaybe "") <$> mapM (fmap (first Just) . parseFile) (nub input)
4049 case e of
4150 Left err -> do
4251 hPutStrLn stderr $ show err
4352 exitFailure
4453 Right ms -> do
45− putStrLn . runDocs $ renderModules (map snd ms)
54+ case fmt of
55+ Markdown -> putStrLn . runDocs $ renderModules (map snd ms)
56+ Etags -> ldump $ dumpEtags $ pairs ms
57+ Ctags -> ldump $ dumpCtags $ pairs ms
4658 exitSuccess
47−
59+ where pairs :: [(Maybe String, m)] -> [(String, m)]
60+ pairs = map (\(k,m) -> (fromMaybe "" k,m))
61+ ldump :: [String] -> IO ()
62+ ldump = mapM_ putStrLn
63+
4864parseFile :: FilePath -> IO (FilePath, String)
4965parseFile input = (,) input <$> readFile input
5066
@@ -222,8 +238,20 @@ inputFile = strArgument $
222238 metavar "FILE"
223239 <> help "The input .purs file(s)"
224240
241+instance Read Format where
242+ readsPrec _ "etags" = [(Etags, "")]
243+ readsPrec _ "ctags" = [(Ctags, "")]
244+ readsPrec _ "markdown" = [(Markdown, "")]
245+ readsPrec _ _ = []
246+
247+format :: Parser Format
248+format = option auto $ value Markdown
249+ <> long "format"
250+ <> metavar "FORMAT"
251+ <> help "Set output FORMAT (markdown | etags | ctags)"
252+
225253pscDocsOptions :: Parser PSCDocsOptions
226−pscDocsOptions = PSCDocsOptions <$> many inputFile
254+pscDocsOptions = PSCDocsOptions <$> format <*> many inputFile
227255
228256main :: IO ()
229257main = execParser opts >>= docgen
psc-docs/Tags.hsnew file+18
@@ -0,0 +1,18 @@
1+module Tags where
2+
3+import qualified Language.PureScript as P
4+
5+tags :: P.Module -> [(String, Int)]
6+tags = concatMap dtags . P.exportedDeclarations
7+ where dtags (P.PositionedDeclaration sp _ d) = map tag $ names d
8+ where tag name = (name, line)
9+ line = P.sourcePosLine $ P.spanStart sp
10+ dtags _ = []
11+ names (P.DataDeclaration _ name _ dcons) = P.runProperName name : consNames
12+ where consNames = map (\(cname, _) -> P.runProperName cname) dcons
13+ names (P.TypeDeclaration ident _) = [show ident]
14+ names (P.ExternDeclaration _ ident _ _) = [show ident]
15+ names (P.TypeSynonymDeclaration name _ _) = [P.runProperName name]
16+ names (P.TypeClassDeclaration name _ _ _) = [P.runProperName name]
17+ names (P.TypeInstanceDeclaration name _ _ _ _) = [show name]
18+ names _ = []