]> git.wincent.com - docvim.git/blob - lib/Text/Docvim/Printer/Markdown.hs
Add additional blank line above headings
[docvim.git] / lib / Text / Docvim / Printer / Markdown.hs
1 {-# LANGUAGE CPP #-}
2
3 module Text.Docvim.Printer.Markdown (markdown) where
4
5 #if !MIN_VERSION_base(4,8,0)
6 import Control.Applicative ((<$>))
7 #endif
8 import Control.Monad.Reader
9 import Data.List
10 import Data.Maybe
11 import Text.Docvim.AST
12 import Text.Docvim.Parse
13 import Text.Docvim.Visitor.Plugin
14 import Text.Docvim.Visitor.Symbol
15
16 data Metadata = Metadata { pluginName :: Maybe String
17                          , symbols :: [String]
18                          }
19 type Env = Reader Metadata String
20
21 data Anchor = Anchor [Attribute] String
22 data Attribute = Attribute String String
23
24 markdown :: Node -> String
25 markdown n = if null stripped
26              then ""
27              else stripped ++ "\n"
28   where
29     metadata = Metadata (getPluginName n) (getSymbols n)
30     stripped = rstrip (runReader (node n) metadata)
31
32 nodes :: [Node] -> Env
33 nodes ns = concat <$> mapM node ns
34
35 node :: Node -> Env
36 node n = case n of
37   Blockquote b            -> blockquote b >>= nl >>= nl
38   -- TODO, for readability, this should be "<br />\n" (custom, context-aware separator; see Vim.hs)
39   BreakTag                -> return "<br />"
40   Code c                  -> return $ "`" ++ c ++ "`"
41   CommandAnnotation {}    -> command n
42   CommandsAnnotation      -> h2 "Commands"
43   DocBlock d              -> nodes d
44   Fenced f                -> return $ fenced f ++ "\n\n"
45   FunctionAnnotation {}   -> function n
46   FunctionDeclaration {}  -> nodes $ functionBody n
47   FunctionsAnnotation     -> h2 "Functions"
48   HeadingAnnotation h     -> h2 h
49   Link l                  -> link l
50   LinkTargets l           -> return $ linkTargets l
51   List ls                 -> nodes ls >>= nl
52   ListItem l              -> fmap ("- " ++) (nodes l) >>= nl
53   MappingAnnotation m     -> mapping m
54   MappingsAnnotation      -> h2 "Mappings"
55   OptionAnnotation {}     -> option n
56   OptionsAnnotation       -> h2 "Options"
57   Paragraph p             -> nodes p >>= nl >>= nl
58   Plaintext p             -> return p
59   -- TODO: this should be order-independent and always appear at the top.
60   -- Note that I don't really have anywhere to put the description; maybe I should
61   -- scrap it (nope: need it in the Vim help version).
62   PluginAnnotation name _ -> h1 name
63   Project p               -> nodes p
64   Separator               -> return $ "---" ++ "\n\n"
65   SubheadingAnnotation s  -> h3 s
66   Unit u                  -> nodes u
67   Whitespace              -> return " "
68   _                       -> return ""
69
70 -- | Append a newline.
71 nl :: String -> Env
72 nl = return . (++ "\n")
73
74 blockquote :: [Node] -> Env
75 blockquote ps = do
76   ps' <- mapM paragraph ps
77   return $ "> " ++ intercalate "\n>\n> " ps'
78   where
79     -- Strip off trailing newlines from each paragraph.
80     paragraph p = fmap trim (node p)
81     trim contents = take (length contents - 2) contents
82
83 -- TODO: handle "interesting" link text like containing [, ], "
84 link :: String -> Env
85 link l = do
86   metadata <- ask
87   return $ if l `elem` symbols metadata
88            -- TODO: beware names with < ` etc in them
89            -- TODO: consider not using <strong>
90            then "<strong>[`" ++ l ++ "`](" ++ gitHubAnchor l ++ ")</strong>"
91            else "<strong>`" ++ l ++ "`</strong>" -- TODO:
92                                 -- may want to try producing a link to Vim
93                                 -- online help if I can find a search for it
94
95 fenced :: [String] -> String
96 fenced f = "```\n" ++ code ++ "```"
97   where code = if null f
98                then ""
99                else intercalate "\n" f ++ "\n"
100
101 linkTargets :: [String] -> String
102 linkTargets ls =  "<p align=\"right\">"
103                ++ unwords (map linkify $ sort ls)
104                ++ "</p>"
105                ++ "\n"
106   where
107     linkify l = a $ Anchor [ Attribute "name" (sanitizeAnchor l)
108                            , Attribute "href" (gitHubAnchor l)
109                            ]
110                            (codify l)
111
112 h1 :: String -> Env
113 h1 = heading 1
114
115 h2 :: String -> Env
116 h2 = heading 2
117
118 h3 :: String -> Env
119 h3 = heading 3
120
121 heading :: Int -> String -> Env
122 heading level string = do
123   metadata <- ask
124   return $ "\n" ++ replicate level '#' ++ " " ++ string ++ anch (pluginName metadata) ++ "\n\n"
125   where
126     anch name = a $ Anchor [ Attribute "name" (sanitizeAnchor $ pre ++ string)
127                            , Attribute "href" (gitHubAnchor $ pre ++ string)
128                            ]
129                            ""
130       where
131         pre = maybe "" (++ "-") name
132
133 -- | Wraps a string in `<code>`/`</code>` tags.
134 -- TODO: remember why I'm not using backticks here.
135 codify :: String -> String
136 codify s = "<code>" ++ s ++ "</code>"
137
138 a :: Anchor -> String
139 a (Anchor attributes target) = "<a" ++ attrs ++ ">" ++ target ++ "</a>"
140   where
141     attrs = if not (null attributes)
142             then " " ++ attributesString attributes
143             else ""
144
145 attributesString :: [Attribute] -> String
146 attributesString as = unwords (map attributeToString as)
147   where attributeToString (Attribute name value) = name ++ "=\"" ++ value ++ "\""
148
149 gitHubAnchor :: String -> String
150 gitHubAnchor n = "#user-content-" ++ sanitizeAnchor n
151
152 -- TODO: make sure symbol table knows about option targets too
153 option :: Node -> Env
154 option (OptionAnnotation n t d) = do
155   h <- h3 $ "`" ++ n ++ "` (" ++ t ++ ", default: " ++ def ++ ")"
156   return $ targets ++ h
157   where targets = linkTargets [n]
158         def = fromMaybe "none" d
159 option _ = invalidNode
160
161 command :: Node -> Env
162 command (CommandAnnotation name params) = do
163   content <- h3 $ "`:" ++ annotation ++ "`"
164   return $ target ++ content
165   where target = linkTargets [":" ++ name]
166         annotation = rstrip $ name ++ " " ++ fromMaybe "" params
167 command _ = invalidNode
168
169 function :: Node -> Env
170 function (FunctionAnnotation name) = do
171   content <- h3 $ "`" ++ name ++ "()`"
172   return $ target ++ content
173   where target = linkTargets [name ++ "()"]
174 function _ = invalidNode
175
176 mapping :: String -> Env
177 mapping name = h3 $ "`" ++ name ++ "`"