2Copyright (C) 2006 John MacFarlane <jgm at berkeley dot edu>
4This program is free software; you can redistribute it and/or modify
5it under the terms of the GNU General Public License as published by
6the Free Software Foundation; either version 2 of the License, or
7(at your option) any later version.
9This program is distributed in the hope that it will be useful,
10but WITHOUT ANY WARRANTY; without even the implied warranty of
11MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12GNU General Public License for more details.
14You should have received a copy of the GNU General Public License
15along with this program; if not, write to the Free Software
16Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 Copyright : Copyright (C) 2006 John MacFarlane
22 License : GNU GPL, version 2 or above
24 Maintainer : John MacFarlane <jgm at berkeley dot edu>
26 Portability : portable
28Parses command-line options and calls the appropriate readers and
32import Text.Pandoc.UTF8 ( decodeUTF8, encodeUTF8 )
33import Text.Pandoc.Readers.Markdown ( readMarkdown )
34import Text.Pandoc.Readers.HTML ( readHtml )
35import Text.Pandoc.Writers.S5 ( s5CSS, s5Javascript, writeS5 )
36import Text.Pandoc.Writers.RST ( writeRST )
37import Text.Pandoc.Readers.RST ( readRST )
38import Text.Pandoc.ASCIIMathML ( asciiMathMLScript )
39import Text.Pandoc.Writers.HTML ( writeHtml )
40import Text.Pandoc.Writers.LaTeX ( writeLaTeX )
41import Text.Pandoc.Readers.LaTeX ( readLaTeX )
42import Text.Pandoc.Writers.RTF ( writeRTF )
43import Text.Pandoc.Writers.Markdown ( writeMarkdown )
44import Text.Pandoc.Writers.DefaultHeaders ( defaultHtmlHeader,
45 defaultRTFHeader, defaultS5Header, defaultLaTeXHeader )
46import Text.Pandoc.Definition
47import Text.Pandoc.Shared
48import Text.Regex ( mkRegex, splitRegex )
49import System ( exitWith, getArgs, getProgName )
51import System.Console.GetOpt
53import Data.Maybe ( fromMaybe )
54import Data.List ( isPrefixOf )
55import Char ( toLower )
56import Control.Monad ( (>>=) )
61copyrightMessage :: String
62copyrightMessage = "\nCopyright (C) 2006 John MacFarlane\nWeb: http://sophos.berkeley.edu/macfarlane/pandoc\nThis is free software; see the source for copying conditions. There is no\nwarranty, not even for merchantability or fitness for a particular purpose."
64-- | Association list of formats and readers.
65readers :: [(String, ParserState -> String -> Pandoc)]
66readers = [("native" , readPandoc)
67 ,("markdown" , readMarkdown)
70 ,("latex" , readLaTeX)
73-- | Reader for native Pandoc format.
74readPandoc :: ParserState -> String -> Pandoc
75readPandoc state input = read input
77-- | Association list of formats and pairs of writers and default headers.
78writers :: [ ( String, ( WriterOptions -> Pandoc -> String, String ) ) ]
79writers = [("native" , (writeDoc, ""))
80 ,("html" , (writeHtml, defaultHtmlHeader))
81 ,("s5" , (writeS5, defaultS5Header))
82 ,("latex" , (writeLaTeX, defaultLaTeXHeader))
83 ,("markdown" , (writeMarkdown, ""))
84 ,("rst" , (writeRST, ""))
85 ,("rtf" , (writeRTF, defaultRTFHeader))
88-- | Writer for Pandoc native format.
89writeDoc :: WriterOptions -> Pandoc -> String
90writeDoc options = prettyPandoc
92-- | Data structure for command line options.
94 { optPreserveTabs :: Bool -- ^ If @False@, convert tabs to spaces
95 , optTabStop :: Int -- ^ Number of spaces per tab
96 , optStandalone :: Bool -- ^ If @True@, include header, footer
97 , optReader :: ParserState -> String -> Pandoc -- ^ Read format
98 , optWriter :: WriterOptions -> Pandoc -> String -- ^ Write fmt
99 , optParseRaw :: Bool -- ^ If @True@, parse unconvertable
101 , optCSS :: String -- ^ CSS file to link to
102 , optIncludeInHeader :: String -- ^ File to include in header
103 , optIncludeBeforeBody :: String -- ^ File to include at top of body
104 , optIncludeAfterBody :: String -- ^ File to include at end of body
105 , optCustomHeader :: String -- ^ Custom header to use, or "DEFAULT"
106 , optDefaultHeader :: String -- ^ Default header
107 , optTitlePrefix :: String -- ^ Optional prefix for HTML title
108 , optOutputFile :: String -- ^ Name of output file
109 , optNumberSections :: Bool -- ^ If @True@, number sections in LaTeX
110 , optIncremental :: Bool -- ^ If @True@, incremental lists in S5
111 , optSmart :: Bool -- ^ If @True@, use smart typography
112 , optASCIIMathML :: Bool -- ^ If @True@, use ASCIIMathML in HTML
113 , optShowUsage :: Bool -- ^ If @True@, show usage message
114 , optDebug :: Bool -- ^ If @True@, output debug messages
117-- | Defaults for command-line options.
120 { optPreserveTabs = False
122 , optStandalone = False
123 , optReader = readMarkdown
124 , optWriter = writeHtml
125 , optParseRaw = False
127 , optIncludeInHeader = ""
128 , optIncludeBeforeBody = ""
129 , optIncludeAfterBody = ""
130 , optCustomHeader = "DEFAULT"
131 , optDefaultHeader = defaultHtmlHeader
132 , optTitlePrefix = ""
133 , optOutputFile = "" -- null for stdout
134 , optNumberSections = False
135 , optIncremental = False
137 , optASCIIMathML = False
138 , optShowUsage = False
142-- | A list of functions, each transforming the options data structure in response
143-- to a command-line option.
144allOptions :: [OptDescr (Opt -> IO Opt)]
146 [ Option "fr" ["from","read"]
148 (\arg opt -> case (lookup (map toLower arg) readers) of
149 Just reader -> return opt { optReader = reader }
150 Nothing -> error ("Unknown reader: " ++ arg) )
152 ("Source format (" ++
153 (concatMap (\(name, fn) -> " " ++ name) readers) ++ " )")
155 , Option "tw" ["to","write"]
157 (\arg opt -> case (lookup (map toLower arg) writers) of
158 Just (writer, defaultHeader) ->
159 return opt { optWriter = writer,
160 optDefaultHeader = defaultHeader }
161 Nothing -> error ("Unknown writer: " ++ arg) )
163 ("Output format (" ++ (concatMap (\(name, fn) -> " " ++ name) writers) ++ " )")
165 , Option "s" ["standalone"]
167 (\opt -> return opt { optStandalone = True }))
168 "Include needed header and footer on output"
170 , Option "o" ["output"]
173 return opt { optOutputFile = arg })
175 "Name of output file"
177 , Option "p" ["preserve-tabs"]
179 (\opt -> return opt { optPreserveTabs = True }))
180 "Preserve tabs instead of converting to spaces"
182 , Option "" ["tab-stop"]
184 (\arg opt -> return opt { optTabStop = (read arg) } )
186 "Tab stop (default 4)"
188 , Option "R" ["parse-raw"]
190 (\opt -> return opt { optParseRaw = True }))
191 "Parse untranslatable HTML codes and LaTeX environments as raw"
193 , Option "S" ["smart"]
195 (\opt -> return opt { optSmart = True }))
196 "Use smart quotes, dashes, and ellipses in HTML output"
198 , Option "m" ["asciimathml"]
200 (\opt -> return opt { optASCIIMathML = True,
201 optStandalone = True }))
202 "Use ASCIIMathML script in html output"
204 , Option "i" ["incremental"]
206 (\opt -> return opt { optIncremental = True }))
207 "Make list items display incrementally in S5"
209 , Option "N" ["number-sections"]
211 (\opt -> return opt { optNumberSections = True }))
212 "Number sections in LaTeX"
216 (\arg opt -> return opt { optCSS = arg,
217 optStandalone = True })
219 "Link to CSS style sheet"
221 , Option "H" ["include-in-header"]
225 return opt { optIncludeInHeader = text,
226 optStandalone = True })
228 "File to include at end of header (implies -s)"
230 , Option "B" ["include-before-body"]
234 return opt { optIncludeBeforeBody = text })
236 "File to include before document body"
238 , Option "A" ["include-after-body"]
242 return opt { optIncludeAfterBody = text })
244 "File to include after document body"
246 , Option "C" ["custom-header"]
250 return opt { optCustomHeader = text,
251 optStandalone = True })
253 "File to use for custom header (implies -s)"
255 , Option "T" ["title-prefix"]
257 (\arg opt -> return opt { optTitlePrefix = arg,
258 optStandalone = True })
260 "String to prefix to HTML window title"
262 , Option "D" ["print-default-header"]
265 let header = case (lookup arg writers) of
266 Just (writer, head) -> head
267 Nothing -> error ("Unknown reader: " ++ arg)
268 hPutStr stdout header
269 exitWith ExitSuccess)
271 "Print default header for FORMAT"
273 , Option "d" ["debug"]
275 (\opt -> return opt { optDebug = True }))
276 "Print debug messages to stderr, output to stdout"
278 , Option "v" ["version"]
282 hPutStrLn stderr (prg ++ " " ++ version ++
284 exitWith $ ExitFailure 2))
287 , Option "h" ["help"]
289 (\opt -> return opt { optShowUsage = True }))
293-- parse name of calling program and return default reader and writer descriptions
295 case (splitRegex (mkRegex "2") (map toLower name)) of
296 [from, to] -> (from, to)
297 _ -> ("markdown", "html")
299-- set default options based on reader and writer descriptions; start is starting options
300setDefaultOpts from to start =
301 case ((lookup from readers), (lookup to writers)) of
302 (Just reader, Just (writer, header)) -> start {optReader = reader,
304 optDefaultHeader = header}
307-- True if single-letter option is in option list
308inOptList :: [Char] -> OptDescr (Opt -> IO Opt) -> Bool
310 let (Option letters _ _ _) = desc in
311 any (\x -> x `elem` list) letters
313-- Reformat usage message so it doesn't wrap illegibly
314reformatUsageInfo = gsub " *--" " --" .
315 gsub "(-[A-Za-z0-9]) *--" "\\1, --" .
316 gsub " *([^- ])" "\n\t\\1"
321 let (from, to) = parseProgName name
323 let irrelevantOptions = if not ('2' `elem` name)
326 (if (to /= "html" && to /= "s5") then "SmcT" else "") ++
327 (if (to /= "latex") then "N" else "") ++
328 (if (to /= "s5") then "i" else "") ++
329 (if (from /= "html" && from /= "latex") then "R" else "")
331 let options = filter (not . inOptList irrelevantOptions) allOptions
333 let defaultOpts = setDefaultOpts from to startOpt
336 let (actions, sources, errors) = getOpt Permute options args
338 if (not (null errors))
340 mapM (\e -> hPutStrLn stderr e) errors
341 hPutStrLn stderr (reformatUsageInfo $
342 usageInfo (name ++ " [OPTIONS] [FILES]") options)
343 exitWith $ ExitFailure 2
347 -- thread option data structure through all supplied option actions
348 opts <- foldl (>>=) (return defaultOpts) actions
350 let Opt { optPreserveTabs = preserveTabs
351 , optTabStop = tabStop
352 , optStandalone = standalone
355 , optParseRaw = parseRaw
357 , optIncludeInHeader = includeHeader
358 , optIncludeBeforeBody = includeBefore
359 , optIncludeAfterBody = includeAfter
360 , optCustomHeader = customHeader
361 , optDefaultHeader = defaultHeader
362 , optTitlePrefix = titlePrefix
363 , optOutputFile = outputFile
364 , optNumberSections = numberSections
365 , optIncremental = incremental
367 , optASCIIMathML = asciiMathML
368 , optShowUsage = showUsage
374 hPutStr stderr (reformatUsageInfo $ usageInfo (name ++ " [OPTIONS] [FILES]") options)
375 exitWith $ ExitFailure 2
378 output <- if ((null outputFile) || debug)
380 else openFile outputFile WriteMode
384 hPutStrLn stderr ("OUTPUT=" ++ outputFile)
385 hPutStr stderr $ concatMap (\s -> "INPUT=" ++ s ++ "\n") sources
388 let writingS5 = (defaultHeader == defaultS5Header)
389 let tabFilter = if preserveTabs then id else (tabsToSpaces tabStop)
390 let addBlank str = str ++ "\n\n"
391 let removeCRs str = filter (/= '\r') str -- remove DOS-style line endings
392 let filter = tabFilter . addBlank . removeCRs
393 let startParserState = defaultParserState { stateParseRaw = parseRaw,
394 stateTabStop = tabStop,
395 stateStandalone = standalone }
396 let csslink = if (css == "")
398 else "<link rel=\"stylesheet\" href=\"" ++ css ++
399 "\" type=\"text/css\" media=\"all\" />\n"
400 let asciiMathMLLink = if asciiMathML then asciiMathMLScript else ""
401 let header = (if (customHeader == "DEFAULT")
403 else customHeader) ++
404 csslink ++ asciiMathMLLink ++ includeHeader
405 let writerOptions = WriterOptions { writerStandalone = standalone,
406 writerHeader = header,
407 writerTitlePrefix = titlePrefix,
409 writerTabStop = tabStop,
410 writerS5 = writingS5,
411 writerIncremental = incremental,
412 writerNumberSections = numberSections,
413 writerIncludeBefore = includeBefore,
414 writerIncludeAfter = includeAfter }
416 (readSources sources) >>= (hPutStr output . encodeUTF8 .
417 (writer writerOptions) .
418 (reader startParserState) . filter .
419 decodeUTF8 . (joinWithSep "\n")) >> hClose output
422 readSources [] = mapM readSource ["-"]
423 readSources sources = mapM readSource sources
424 readSource "-" = getContents
425 readSource source = readFile source
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list