3Copyright (C) 2006-8 John MacFarlane <jgm@berkeley.edu>
5This program is free software; you can redistribute it and/or modify
6it under the terms of the GNU General Public License as published by
7the Free Software Foundation; either version 2 of the License, or
8(at your option) any later version.
10This program is distributed in the hope that it will be useful,
11but WITHOUT ANY WARRANTY; without even the implied warranty of
12MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13GNU General Public License for more details.
15You should have received a copy of the GNU General Public License
16along with this program; if not, write to the Free Software
17Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 Copyright : Copyright (C) 2006-8 John MacFarlane
23 License : GNU GPL, version 2 or above
25 Maintainer : John MacFarlane <jgm@berkeley@edu>
27 Portability : portable
29Parses command-line options and calls the appropriate readers and
35import Text.Pandoc.Shared ( HTMLMathMethod (..) )
36import Text.Pandoc.Highlighting ( languages )
37import System.Environment ( getArgs, getProgName, getEnvironment )
38import System.Exit ( exitWith, ExitCode (..) )
39import System.FilePath ( takeExtension, takeDirectory )
40import System.Console.GetOpt
41import Data.Maybe ( fromMaybe )
42import Data.Char ( toLower )
43import Data.List ( intercalate )
44import Prelude hiding ( putStrLn, writeFile, readFile, getContents )
45import System.IO ( stdout, stderr )
49import Text.Pandoc.Biblio
52copyrightMessage :: String
53copyrightMessage = "\nCopyright (C) 2006-8 John MacFarlane\n" ++
54 "Web: http://johnmacfarlane.net/pandoc\n" ++
55 "This is free software; see the source for copying conditions. There is no\n" ++
56 "warranty, not even for merchantability or fitness for a particular purpose."
72 else "\nCompiled with syntax highlighting support for:\n" ++ wrapWords 78 languages
74-- | Converts a list of strings into a single string with the items printed as
75-- comma separated words in lines with a maximum line length.
76wrapWords :: Int -> [String] -> String
77wrapWords c = wrap' c c where
79 wrap' cols remaining (x:xs) = if remaining == cols
80 then x ++ wrap' cols (remaining - length x) xs
81 else if (length x + 1) > remaining
82 then ",\n" ++ x ++ wrap' cols (cols - length x) xs
83 else ", " ++ x ++ wrap' cols (remaining - (length x + 2)) xs
85-- | Association list of formats and readers.
86readers :: [(String, ParserState -> String -> Pandoc)]
87readers = [("native" , readPandoc)
88 ,("markdown" , readMarkdown)
91 ,("latex" , readLaTeX)
94-- | Reader for native Pandoc format.
95readPandoc :: ParserState -> String -> Pandoc
96readPandoc _ input = read input
98-- | Association list of formats and pairs of writers and default headers.
99writers :: [ ( String, ( WriterOptions -> Pandoc -> String, String ) ) ]
100writers = [("native" , (writeDoc, ""))
101 ,("html" , (writeHtmlString, ""))
102 ,("s5" , (writeS5String, defaultS5Header))
103 ,("docbook" , (writeDocbook, defaultDocbookHeader))
104 ,("opendocument" , (writeOpenDocument, defaultOpenDocumentHeader))
105 ,("odt" , (writeOpenDocument, defaultOpenDocumentHeader))
106 ,("latex" , (writeLaTeX, defaultLaTeXHeader))
107 ,("context" , (writeConTeXt, defaultConTeXtHeader))
108 ,("texinfo" , (writeTexinfo, ""))
109 ,("man" , (writeMan, ""))
110 ,("markdown" , (writeMarkdown, ""))
111 ,("rst" , (writeRST, ""))
112 ,("mediawiki" , (writeMediaWiki, ""))
113 ,("rtf" , (writeRTF, defaultRTFHeader))
116isNonTextOutput :: String -> Bool
117isNonTextOutput = (`elem` ["odt"])
119-- | Writer for Pandoc native format.
120writeDoc :: WriterOptions -> Pandoc -> String
121writeDoc _ = prettyPandoc
123-- | Data structure for command line options.
125 { optPreserveTabs :: Bool -- ^ Convert tabs to spaces
126 , optTabStop :: Int -- ^ Number of spaces per tab
127 , optStandalone :: Bool -- ^ Include header, footer
128 , optReader :: String -- ^ Reader format
129 , optWriter :: String -- ^ Writer format
130 , optParseRaw :: Bool -- ^ Parse unconvertable HTML and TeX
131 , optCSS :: [String] -- ^ CSS file to link to
132 , optTableOfContents :: Bool -- ^ Include table of contents
133 , optIncludeInHeader :: String -- ^ File to include in header
134 , optIncludeBeforeBody :: String -- ^ File to include at top of body
135 , optIncludeAfterBody :: String -- ^ File to include at end of body
136 , optCustomHeader :: String -- ^ Custom header to use, or "DEFAULT"
137 , optTitlePrefix :: String -- ^ Optional prefix for HTML title
138 , optOutputFile :: String -- ^ Name of output file
139 , optNumberSections :: Bool -- ^ Number sections in LaTeX
140 , optIncremental :: Bool -- ^ Use incremental lists in S5
141 , optSmart :: Bool -- ^ Use smart typography
142 , optHTMLMathMethod :: HTMLMathMethod -- ^ Method to print HTML math
143 , optDumpArgs :: Bool -- ^ Output command-line arguments
144 , optIgnoreArgs :: Bool -- ^ Ignore command-line arguments
145 , optStrict :: Bool -- ^ Use strict markdown syntax
146 , optReferenceLinks :: Bool -- ^ Use reference links in writing markdown, rst
147 , optWrapText :: Bool -- ^ Wrap text
148 , optSanitizeHTML :: Bool -- ^ Sanitize HTML
149 , optLHSIn :: Bool -- ^ Treat input as literate haskell
150 , optLHSOut :: Bool -- ^ Write output as literate haskell
152 , optModsFile :: String
153 , optCslFile :: String
157-- | Defaults for command-line options.
160 { optPreserveTabs = False
162 , optStandalone = False
163 , optReader = "" -- null for default reader
164 , optWriter = "" -- null for default writer
165 , optParseRaw = False
167 , optTableOfContents = False
168 , optIncludeInHeader = ""
169 , optIncludeBeforeBody = ""
170 , optIncludeAfterBody = ""
171 , optCustomHeader = "DEFAULT"
172 , optTitlePrefix = ""
173 , optOutputFile = "-" -- "-" means stdout
174 , optNumberSections = False
175 , optIncremental = False
177 , optHTMLMathMethod = PlainMath
178 , optDumpArgs = False
179 , optIgnoreArgs = False
181 , optReferenceLinks = False
183 , optSanitizeHTML = False
192-- | A list of functions, each transforming the options data structure
193-- in response to a command-line option.
194options :: [OptDescr (Opt -> IO Opt)]
196 [ Option "fr" ["from","read"]
198 (\arg opt -> return opt { optReader = map toLower arg })
200 "" -- ("(" ++ (intercalate ", " $ map fst readers) ++ ")")
202 , Option "tw" ["to","write"]
204 (\arg opt -> return opt { optWriter = map toLower arg })
206 "" -- ("(" ++ (intercalate ", " $ map fst writers) ++ ")")
208 , Option "s" ["standalone"]
210 (\opt -> return opt { optStandalone = True }))
211 "" -- "Include needed header and footer on output"
213 , Option "o" ["output"]
215 (\arg opt -> return opt { optOutputFile = arg })
217 "" -- "Name of output file"
219 , Option "p" ["preserve-tabs"]
221 (\opt -> return opt { optPreserveTabs = True }))
222 "" -- "Preserve tabs instead of converting to spaces"
224 , Option "" ["tab-stop"]
226 (\arg opt -> return opt { optTabStop = (read arg) } )
228 "" -- "Tab stop (default 4)"
230 , Option "" ["strict"]
232 (\opt -> return opt { optStrict = True } ))
233 "" -- "Disable markdown syntax extensions"
235 , Option "" ["reference-links"]
237 (\opt -> return opt { optReferenceLinks = True } ))
238 "" -- "Use reference links in parsing HTML"
240 , Option "R" ["parse-raw"]
242 (\opt -> return opt { optParseRaw = True }))
243 "" -- "Parse untranslatable HTML codes and LaTeX environments as raw"
245 , Option "S" ["smart"]
247 (\opt -> return opt { optSmart = True }))
248 "" -- "Use smart quotes, dashes, and ellipses"
250 , Option "m" ["latexmathml", "asciimathml"]
252 (\arg opt -> return opt { optHTMLMathMethod =
255 "" -- "Use LaTeXMathML script in html output"
257 , Option "" ["mimetex"]
259 (\arg opt -> return opt { optHTMLMathMethod = MimeTeX
260 (fromMaybe "/cgi-bin/mimetex.cgi" arg)})
262 "" -- "Use mimetex for HTML math"
264 , Option "" ["jsmath"]
266 (\arg opt -> return opt { optHTMLMathMethod = JsMath arg})
268 "" -- "Use jsMath for HTML math"
270 , Option "" ["gladtex"]
272 (\opt -> return opt { optHTMLMathMethod = GladTeX }))
273 "" -- "Use gladtex for HTML math"
275 , Option "i" ["incremental"]
277 (\opt -> return opt { optIncremental = True }))
278 "" -- "Make list items display incrementally in S5"
280 , Option "N" ["number-sections"]
282 (\opt -> return opt { optNumberSections = True }))
283 "" -- "Number sections in LaTeX"
285 , Option "" ["no-wrap"]
287 (\opt -> return opt { optWrapText = False }))
288 "" -- "Do not wrap text in output"
290 , Option "" ["sanitize-html"]
292 (\opt -> return opt { optSanitizeHTML = True }))
293 "" -- "Sanitize HTML"
295 , Option "" ["lhs-in"]
297 (\opt -> return opt { optLHSIn = True }))
298 "" -- "Treat input as literate haskell"
300 , Option "" ["lhs-out"]
302 (\opt -> return opt { optLHSOut = True }))
303 "" -- "Write output as literate haskell"
307 (\opt -> return opt { optLHSIn = True,
309 "" -- "Equivalent to --lhs-in --lhs-out"
311 , Option "" ["toc", "table-of-contents"]
313 (\opt -> return opt { optTableOfContents = True }))
314 "" -- "Include table of contents"
320 return opt { optCSS = old ++ [arg],
321 optStandalone = True })
323 "" -- "Link to CSS style sheet"
325 , Option "H" ["include-in-header"]
328 let old = optIncludeInHeader opt
330 return opt { optIncludeInHeader = old ++ text,
331 optStandalone = True })
333 "" -- "File to include at end of header (implies -s)"
335 , Option "B" ["include-before-body"]
338 let old = optIncludeBeforeBody opt
340 return opt { optIncludeBeforeBody = old ++ text })
342 "" -- "File to include before document body"
344 , Option "A" ["include-after-body"]
347 let old = optIncludeAfterBody opt
349 return opt { optIncludeAfterBody = old ++ text })
351 "" -- "File to include after document body"
353 , Option "C" ["custom-header"]
357 return opt { optCustomHeader = text,
358 optStandalone = True })
360 "" -- "File to use for custom header (implies -s)"
362 , Option "T" ["title-prefix"]
364 (\arg opt -> return opt { optTitlePrefix = arg,
365 optStandalone = True })
367 "" -- "String to prefix to HTML window title"
369 , Option "D" ["print-default-header"]
372 let header = case (lookup arg writers) of
374 Nothing -> error ("Unknown reader: " ++ arg)
375 hPutStr stdout header
376 exitWith ExitSuccess)
378 "" -- "Print default header for FORMAT"
382 (\arg opt -> return opt { optModsFile = arg} )
387 (\arg opt -> return opt { optCslFile = arg} )
391 , Option "" ["dump-args"]
393 (\opt -> return opt { optDumpArgs = True }))
394 "" -- "Print output filename and arguments to stdout."
396 , Option "" ["ignore-args"]
398 (\opt -> return opt { optIgnoreArgs = True }))
399 "" -- "Ignore command-line arguments."
401 , Option "v" ["version"]
405 hPutStrLn stderr (prg ++ " " ++ pandocVersion ++ compileInfo ++
407 exitWith $ ExitFailure 4))
408 "" -- "Print version"
410 , Option "h" ["help"]
414 hPutStr stderr (usageMessage prg options)
415 exitWith $ ExitFailure 2))
419-- Returns usage message
420usageMessage :: String -> [OptDescr (Opt -> IO Opt)] -> String
421usageMessage programName opts = usageInfo
422 (programName ++ " [OPTIONS] [FILES]" ++ "\nInput formats: " ++
423 (intercalate ", " $ map fst readers) ++ "\nOutput formats: " ++
424 (intercalate ", " $ map fst writers) ++ "\nOptions:")
427-- Determine default reader based on source file extensions
428defaultReaderName :: [FilePath] -> String
429defaultReaderName [] = "markdown"
430defaultReaderName (x:xs) =
431 case takeExtension (map toLower x) of
439 ".native" -> "native"
440 _ -> defaultReaderName xs
442-- Returns True if extension of first source is .lhs
443lhsExtension :: [FilePath] -> Bool
444lhsExtension (x:_) = takeExtension x == ".lhs"
445lhsExtension _ = False
447-- Determine default writer based on output file extension
448defaultWriterName :: FilePath -> String
449defaultWriterName "-" = "html" -- no output file
451 case takeExtension (map toLower x) of
452 "" -> "markdown" -- empty extension
456 ".context" -> "context"
461 ".native" -> "native"
463 ".text" -> "markdown"
465 ".markdown" -> "markdown"
467 ".texinfo" -> "texinfo"
470 ['.',y] | y `elem` ['1'..'9'] -> "man"
478 let compatMode = (prg == "hsmarkdown")
480 let (actions, args, errors) = if compatMode
481 then ([], rawArgs, [])
482 else getOpt Permute options rawArgs
484 if (not (null errors))
487 mapM (\e -> hPutStrLn stderr e) errors
488 hPutStr stderr (usageMessage name options)
489 exitWith $ ExitFailure 2
493 let defaultOpts' = if compatMode
494 then defaultOpts { optReader = "markdown"
499 -- thread option data structure through all supplied option actions
500 opts <- foldl (>>=) (return defaultOpts') actions
502 let Opt { optPreserveTabs = preserveTabs
503 , optTabStop = tabStop
504 , optStandalone = standalone
505 , optReader = readerName
506 , optWriter = writerName
507 , optParseRaw = parseRaw
509 , optTableOfContents = toc
510 , optIncludeInHeader = includeHeader
511 , optIncludeBeforeBody = includeBefore
512 , optIncludeAfterBody = includeAfter
513 , optCustomHeader = customHeader
514 , optTitlePrefix = titlePrefix
515 , optOutputFile = outputFile
516 , optNumberSections = numberSections
517 , optIncremental = incremental
519 , optHTMLMathMethod = mathMethod
520 , optDumpArgs = dumpArgs
521 , optIgnoreArgs = ignoreArgs
523 , optReferenceLinks = referenceLinks
525 , optSanitizeHTML = sanitize
529 , optModsFile = modsFile
530 , optCslFile = cslFile
536 hPutStrLn stdout outputFile
537 mapM (\arg -> hPutStrLn stdout arg) args
538 exitWith $ ExitSuccess
541 let sources = if ignoreArgs then [] else args
543 -- assign reader and writer based on options and filenames
544 let readerName' = if null readerName
545 then defaultReaderName sources
548 let writerName' = if null writerName
549 then defaultWriterName outputFile
552 reader <- case (lookup readerName' readers) of
554 Nothing -> error ("Unknown reader: " ++ readerName')
556 (writer, defaultHeader) <- case (lookup writerName' writers) of
557 Just (w,h) -> return (w, h)
558 Nothing -> error ("Unknown writer: " ++ writerName')
560 environment <- getEnvironment
561 let columns = case lookup "COLUMNS" environment of
562 Just cols -> read cols
563 Nothing -> stateColumns defaultParserState
565 let tabFilter _ [] = ""
566 tabFilter _ ('\n':xs) = '\n':(tabFilter tabStop xs)
567 -- remove DOS line endings
568 tabFilter _ ('\r':'\n':xs) = '\n':(tabFilter tabStop xs)
569 tabFilter _ ('\r':xs) = '\n':(tabFilter tabStop xs)
570 tabFilter spsToNextStop ('\t':xs) =
572 then '\t':(tabFilter tabStop xs)
573 else replicate spsToNextStop ' ' ++ tabFilter tabStop xs
575 x:(tabFilter tabStop xs)
576 tabFilter spsToNextStop (x:xs) =
577 x:(tabFilter (spsToNextStop - 1) xs)
579 let standalone' = (standalone && not strict) || isNonTextOutput writerName'
582 refs <- if null modsFile then return [] else readModsColletionFile modsFile
585 let startParserState =
586 defaultParserState { stateParseRaw = parseRaw,
587 stateTabStop = tabStop,
588 stateSanitizeHTML = sanitize,
589 stateLiterateHaskell = lhsIn ||
590 lhsExtension sources,
591 stateStandalone = standalone',
593 stateCitations = map citeKey refs,
595 stateSmart = smart || writerName' `elem`
596 ["latex", "context"],
597 stateColumns = columns,
598 stateStrict = strict }
599 let csslink = if null css
602 (\f -> "<link rel=\"stylesheet\" href=\"" ++
603 f ++ "\" type=\"text/css\" media=\"all\" />\n")
605 let header = (if (customHeader == "DEFAULT")
607 else customHeader) ++ csslink ++ includeHeader
608 let writerOptions = WriterOptions { writerStandalone = standalone',
609 writerHeader = header,
610 writerTitlePrefix = titlePrefix,
611 writerTabStop = tabStop,
612 writerTableOfContents = toc &&
615 writerHTMLMathMethod = mathMethod,
616 writerS5 = (writerName' == "s5"),
617 writerIgnoreNotes = False,
618 writerIncremental = incremental,
619 writerNumberSections = numberSections,
620 writerIncludeBefore = includeBefore,
621 writerIncludeAfter = includeAfter,
622 writerStrictMarkdown = strict,
623 writerReferenceLinks = referenceLinks,
624 writerWrapText = wrap,
625 writerLiterateHaskell = lhsOut ||
626 lhsExtension [outputFile] }
628 if isNonTextOutput writerName' && outputFile == "-"
629 then do hPutStrLn stderr ("Error: Cannot write " ++ writerName ++ " output to stdout.\n" ++
630 "Specify an output file using the -o option.")
631 exitWith $ ExitFailure 5
634 let sourceDirRelative = if null sources
636 else takeDirectory (head sources)
638 let writeOutput = case writerName' of
639 "odt" -> saveOpenDocumentAsODT outputFile sourceDirRelative
640 _ -> if outputFile == "-"
642 else writeFile outputFile . (++ "\n")
644 fmap (reader startParserState . tabFilter tabStop . intercalate "\n")
645 (readSources sources) >>=
647 processBiblio cslFile refs >>=
649 writeOutput . writer writerOptions
652 readSources [] = mapM readSource ["-"]
653 readSources sources = mapM readSource sources
654 readSource "-" = getContents
655 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