Added CommonMark writer.

Added `Text.Pandoc.Writers.CommonMark`, exporting
`writeCommonMark`.

README

@@ -158,22 +158,22 @@ General options
 
 :   Specify input format.  *FORMAT* can be `native` (native Haskell),
     `json` (JSON version of native AST), `markdown` (pandoc's
-    extended markdown), `markdown_strict` (original unextended markdown),
+    extended markdown), `markdown_strict` (original unextended
-    `markdown_phpextra` (PHP Markdown Extra extended markdown),
+    markdown), `markdown_phpextra` (PHP Markdown Extra extended
-    `markdown_github` (github extended markdown),
+    markdown), `markdown_github` (github extended markdown),
-    `commonmark` (CommonMark markdown),
+    `commonmark` (CommonMark markdown), `textile` (Textile), `rst`
-    `textile` (Textile), `rst` (reStructuredText), `html` (HTML),
+    (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t`
-    `docbook` (DocBook), `t2t` (txt2tags), `docx` (docx), `epub` (EPUB),
+    (txt2tags), `docx` (docx), `epub` (EPUB), `opml` (OPML), `org`
-    `opml` (OPML), `org` (Emacs Org-mode), `mediawiki` (MediaWiki markup),
+    (Emacs Org-mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki
-    `twiki` (TWiki markup), `haddock` (Haddock markup), or `latex` (LaTeX).
+    markup), `haddock` (Haddock markup), or `latex` (LaTeX).  If
-    If `+lhs` is appended to `markdown`, `rst`,
+    `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, the
-    `latex`, or `html`, the input will be treated as literate Haskell
+    input will be treated as literate Haskell source: see [Literate
-    source: see [Literate Haskell support](#literate-haskell-support),
+    Haskell support](#literate-haskell-support), below. Markdown
-    below. Markdown syntax extensions can be individually enabled or
+    syntax extensions can be individually enabled or disabled by
-    disabled by appending `+EXTENSION` or `-EXTENSION` to the format
+    appending `+EXTENSION` or `-EXTENSION` to the format name. So, for
-    name. So, for example, `markdown_strict+footnotes+definition_lists`
+    example, `markdown_strict+footnotes+definition_lists` is strict
-    is strict markdown with footnotes and definition lists enabled,
+    markdown with footnotes and definition lists enabled, and
-    and `markdown-pipe_tables+hard_line_breaks` is pandoc's markdown
+    `markdown-pipe_tables+hard_line_breaks` is pandoc's markdown
     without pipe tables and with hard line breaks. See [Pandoc's
     markdown](#pandocs-markdown), below, for a list of extensions and
     their names.
@@ -182,30 +182,33 @@ General options
 
 :   Specify output format.  *FORMAT* can be `native` (native Haskell),
     `json` (JSON version of native AST), `plain` (plain text),
-    `markdown` (pandoc's extended markdown), `markdown_strict` (original
+    `markdown` (pandoc's extended markdown), `markdown_strict`
-    unextended markdown), `markdown_phpextra` (PHP Markdown extra
+    (original unextended markdown), `markdown_phpextra` (PHP Markdown
-    extended markdown), `markdown_github` (github extended markdown),
+    extra extended markdown), `markdown_github` (github extended
-    `rst` (reStructuredText), `html` (XHTML 1), `html5` (HTML 5),
+    markdown), `commonmark` (CommonMark markdown), `rst`
-    `latex` (LaTeX), `beamer` (LaTeX beamer slide show),
+    (reStructuredText), `html` (XHTML 1), `html5` (HTML 5), `latex`
-    `context` (ConTeXt), `man` (groff man), `mediawiki` (MediaWiki markup),
+    (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt),
-    `dokuwiki` (DokuWiki markup),
+    `man` (groff man), `mediawiki` (MediaWiki markup), `dokuwiki`
-    `textile` (Textile), `org` (Emacs Org-Mode), `texinfo` (GNU Texinfo),
+    (DokuWiki markup), `textile` (Textile), `org` (Emacs Org-Mode),
-    `opml` (OPML), `docbook` (DocBook), `opendocument` (OpenDocument), `odt`
+    `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` (DocBook),
-    (OpenOffice text document), `docx` (Word docx), `haddock` (Haddock
+    `opendocument` (OpenDocument), `odt` (OpenOffice text document),
-    markup), `rtf` (rich text format), `epub` (EPUB v2 book), `epub3`
+    `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text
-    (EPUB v3), `fb2` (FictionBook2 e-book), `asciidoc` (AsciiDoc),
+    format), `epub` (EPUB v2 book), `epub3` (EPUB v3), `fb2`
-    `icml` (InDesign ICML), `slidy` (Slidy HTML and javascript slide show),
+    (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml` (InDesign
-    `slideous` (Slideous HTML and javascript slide show), `dzslides`
+    ICML), `slidy` (Slidy HTML and javascript slide show), `slideous`
-    (DZSlides HTML5 + javascript slide show), `revealjs` (reveal.js
+    (Slideous HTML and javascript slide show), `dzslides` (DZSlides
-    HTML5 + javascript slide show), `s5` (S5 HTML and javascript slide show),
+    HTML5 + javascript slide show), `revealjs` (reveal.js HTML5 +
-    or the path of a custom lua writer (see [Custom writers](#custom-writers),
+    javascript slide show), `s5` (S5 HTML and javascript slide show),
-    below). Note that `odt`, `epub`, and `epub3` output will not be directed
+    or the path of a custom lua writer (see [Custom
-    to *stdout*; an output filename must be specified using the `-o/--output`
+    writers](#custom-writers), below). Note that `odt`, `epub`, and
-    option. If `+lhs` is appended to `markdown`, `rst`, `latex`, `beamer`,
+    `epub3` output will not be directed to *stdout*; an output
-    `html`, or `html5`, the output will be rendered as literate Haskell
+    filename must be specified using the `-o/--output` option. If
-    source: see [Literate Haskell support](#literate-haskell-support), below.
+    `+lhs` is appended to `markdown`, `rst`, `latex`, `beamer`,
-    Markdown syntax extensions can be individually enabled or disabled by
+    `html`, or `html5`, the output will be rendered as literate
-    appending `+EXTENSION` or `-EXTENSION` to the format name, as described
+    Haskell source: see [Literate Haskell
+    support](#literate-haskell-support), below.  Markdown syntax
+    extensions can be individually enabled or disabled by appending
+    `+EXTENSION` or `-EXTENSION` to the format name, as described
     above under `-f`.
 
 `-o` *FILE*, `--output=`*FILE*

pandoc.cabal

@@ -342,6 +342,7 @@ Library
                    Text.Pandoc.Writers.Texinfo,
                    Text.Pandoc.Writers.Man,
                    Text.Pandoc.Writers.Markdown,
+                   Text.Pandoc.Writers.CommonMark,
                    Text.Pandoc.Writers.Haddock,
                    Text.Pandoc.Writers.RST,
                    Text.Pandoc.Writers.Org,

src/Text/Pandoc.hs

@@ -112,6 +112,7 @@ module Text.Pandoc
                , writeOrg
                , writeAsciiDoc
                , writeHaddock
+               , writeCommonMark
                , writeCustom
                -- * Rendering templates and default templates
                , module Text.Pandoc.Templates
@@ -165,6 +166,7 @@ import Text.Pandoc.Writers.Textile
 import Text.Pandoc.Writers.Org
 import Text.Pandoc.Writers.AsciiDoc
 import Text.Pandoc.Writers.Haddock
+import Text.Pandoc.Writers.CommonMark
 import Text.Pandoc.Writers.Custom
 import Text.Pandoc.Templates
 import Text.Pandoc.Options
@@ -305,6 +307,7 @@ writers = [
   ,("org"          , PureStringWriter writeOrg)
   ,("asciidoc"     , PureStringWriter writeAsciiDoc)
   ,("haddock"      , PureStringWriter writeHaddock)
+  ,("commonmark"   , PureStringWriter writeCommonMark)
   ]
 
 getDefaultExtensions :: String -> Set Extension

src/Text/Pandoc/Writers/CommonMark.hs

@@ -0,0 +1,178 @@
+{-
+Copyright (C) 2015 John MacFarlane <jgm@berkeley.edu>
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+-}
+
+{- |
+   Module      : Text.Pandoc.Writers.CommonMark
+   Copyright   : Copyright (C) 2015 John MacFarlane
+   License     : GNU GPL, version 2 or above
+
+   Maintainer  : John MacFarlane <jgm@berkeley.edu>
+   Stability   : alpha
+   Portability : portable
+
+Conversion of 'Pandoc' documents to CommonMark.
+
+CommonMark:  <http://commonmark.org>
+-}
+module Text.Pandoc.Writers.CommonMark (writeCommonMark) where
+
+import Text.Pandoc.Writers.HTML (writeHtmlString)
+import Text.Pandoc.Definition
+import Text.Pandoc.Shared (isTightList)
+import Text.Pandoc.Templates (renderTemplate')
+import Text.Pandoc.Writers.Shared
+import Text.Pandoc.Options
+import CMark
+import qualified Data.Text as T
+import Control.Monad.Identity (runIdentity, Identity)
+import Control.Monad.State (runState, State, modify, get)
+import Text.Pandoc.Walk (walkM)
+
+-- | Convert Pandoc to CommonMark.
+writeCommonMark :: WriterOptions -> Pandoc -> String
+writeCommonMark opts (Pandoc meta blocks) = rendered
+  where main = runIdentity $ blocksToCommonMark opts (blocks' ++ notes')
+        (blocks', notes) = runState (walkM processNotes blocks) []
+        notes' = if null notes
+                    then []
+                    else [OrderedList (1, Decimal, Period) $ reverse notes]
+        metadata = runIdentity $ metaToJSON opts
+                     (blocksToCommonMark opts)
+                     (inlinesToCommonMark opts)
+                     meta
+        context = defField "body" main $ metadata
+        rendered = if writerStandalone opts
+                      then renderTemplate' (writerTemplate opts) context
+                      else main
+
+processNotes :: Inline -> State [[Block]] Inline
+processNotes (Note bs) = do
+  modify (bs :)
+  notes <- get
+  return $ Str $ "[" ++ show (length notes) ++ "]"
+processNotes x = return x
+
+node :: NodeType -> [Node] -> Node
+node = Node Nothing
+
+blocksToCommonMark :: WriterOptions -> [Block] -> Identity String
+blocksToCommonMark opts bs = return $
+  T.unpack $ nodeToCommonmark cmarkOpts colwidth
+           $ node DOCUMENT (blocksToNodes bs)
+   where cmarkOpts = [optHardBreaks | isEnabled Ext_hard_line_breaks opts]
+         colwidth = if writerWrapText opts
+                       then writerColumns opts
+                       else 0
+
+inlinesToCommonMark :: WriterOptions -> [Inline] -> Identity String
+inlinesToCommonMark opts ils = return $
+  T.unpack $ nodeToCommonmark cmarkOpts colwidth
+           $ node PARAGRAPH (inlinesToNodes ils)
+   where cmarkOpts = [optHardBreaks | isEnabled Ext_hard_line_breaks opts]
+         colwidth = if writerWrapText opts
+                       then writerColumns opts
+                       else 0
+
+blocksToNodes :: [Block] -> [Node]
+blocksToNodes = foldr blockToNodes []
+
+blockToNodes :: Block -> [Node] -> [Node]
+blockToNodes (Plain xs) = (node PARAGRAPH (inlinesToNodes xs) :)
+blockToNodes (Para xs) = (node PARAGRAPH (inlinesToNodes xs) :)
+blockToNodes (CodeBlock (_,classes,_) xs) =
+  (node (CODE_BLOCK (T.pack (unwords classes)) (T.pack xs)) [] :)
+blockToNodes (RawBlock fmt xs)
+  | fmt == Format "html" = (node (HTML (T.pack xs)) [] :)
+  | otherwise = id
+blockToNodes (BlockQuote bs) =
+  (node BLOCK_QUOTE (blocksToNodes bs) :)
+blockToNodes (BulletList items) =
+  (node (LIST ListAttributes{
+               listType = BULLET_LIST,
+               listDelim = PERIOD_DELIM,
+               listTight = isTightList items,
+               listStart = 1 }) (map (node ITEM . blocksToNodes) items) :)
+blockToNodes (OrderedList (start, _sty, delim) items) =
+  (node (LIST ListAttributes{
+               listType = ORDERED_LIST,
+               listDelim = case delim of
+                                OneParen  -> PAREN_DELIM
+                                TwoParens -> PAREN_DELIM
+                                _         -> PERIOD_DELIM,
+               listTight = isTightList items,
+               listStart = start }) (map (node ITEM . blocksToNodes) items) :)
+blockToNodes HorizontalRule = (node HRULE [] :)
+blockToNodes (Header lev _ ils) = (node (HEADER lev) (inlinesToNodes ils) :)
+blockToNodes (Div _ bs) = (blocksToNodes bs ++)
+blockToNodes (DefinitionList items) = blockToNodes (BulletList items')
+  where items' = map dlToBullet items
+        dlToBullet (term, ((Para xs : ys) : zs))  =
+          Para (term ++ [LineBreak] ++ xs) : ys ++ concat zs
+        dlToBullet (term, ((Plain xs : ys) : zs)) =
+          Plain (term ++ [LineBreak] ++ xs) : ys ++ concat zs
+        dlToBullet (term, xs) =
+          Para term : concat xs
+blockToNodes t@(Table _ _ _ _ _) =
+  (node (HTML (T.pack $! writeHtmlString def $! Pandoc nullMeta [t])) [] :)
+blockToNodes Null = id
+
+inlinesToNodes :: [Inline] -> [Node]
+inlinesToNodes  = foldr inlineToNodes []
+
+inlineToNodes :: Inline -> [Node] -> [Node]
+inlineToNodes (Str s) = (node (TEXT (T.pack s)) [] :)
+inlineToNodes Space   = (node (TEXT (T.pack " ")) [] :)
+inlineToNodes LineBreak = (node LINEBREAK [] :)
+inlineToNodes (Emph xs) = (node EMPH (inlinesToNodes xs) :)
+inlineToNodes (Strong xs) = (node STRONG (inlinesToNodes xs) :)
+inlineToNodes (Strikeout xs) =
+  ((node (INLINE_HTML (T.pack "<s>")) [] : inlinesToNodes xs ++
+   [node (INLINE_HTML (T.pack "</s>")) []]) ++ )
+inlineToNodes (Superscript xs) =
+  ((node (INLINE_HTML (T.pack "<sub>")) [] : inlinesToNodes xs ++
+   [node (INLINE_HTML (T.pack "</sub>")) []]) ++ )
+inlineToNodes (Subscript xs) =
+  ((node (INLINE_HTML (T.pack "<sup>")) [] : inlinesToNodes xs ++
+   [node (INLINE_HTML (T.pack "</sup>")) []]) ++ )
+inlineToNodes (SmallCaps xs) =
+  ((node (INLINE_HTML (T.pack "<span style=\"font-variant:small-caps;\">")) []
+    : inlinesToNodes xs ++
+    [node (INLINE_HTML (T.pack "</span>")) []]) ++ )
+inlineToNodes (Link ils (url,tit)) =
+  (node (LINK (T.pack url) (T.pack tit)) (inlinesToNodes ils) :)
+inlineToNodes (Image ils (url,tit)) =
+  (node (IMAGE (T.pack url) (T.pack tit)) (inlinesToNodes ils) :)
+inlineToNodes (RawInline fmt xs)
+  | fmt == Format "html" = (node (INLINE_HTML (T.pack xs)) [] :)
+  | otherwise = id
+inlineToNodes (Quoted qt ils) =
+  ((node (TEXT start) [] : inlinesToNodes ils ++ [node (TEXT end) []]) ++)
+  where (start, end) = case qt of
+                          SingleQuote -> (T.pack "‘", T.pack "’")
+                          DoubleQuote -> (T.pack "“", T.pack "”")
+inlineToNodes (Code _ str) = (node (CODE (T.pack str)) [] :)
+inlineToNodes (Math mt str) =
+  case mt of
+    InlineMath  ->
+      (node (INLINE_HTML (T.pack ("\\(" ++ str ++ "\\)"))) [] :)
+    DisplayMath ->
+      (node (INLINE_HTML (T.pack ("\\[" ++ str ++ "\\]"))) [] :)
+inlineToNodes (Span _ ils) = (inlinesToNodes ils ++)
+inlineToNodes (Cite _ ils) = (inlinesToNodes ils ++)
+inlineToNodes (Note _) = id -- should not occur
+-- we remove Note elements in preprocessing