Merge branch 'typeclass'

1 files changed, 17 insertions, 248 deletions

diff --git a/src/Text/Pandoc/Options.hs b/src/Text/Pandoc/Options.hs
index 48bc5f4eb..02ae9f771 100644
--- a/src/Text/Pandoc/Options.hs
+++ b/src/Text/Pandoc/Options.hs
@@ -29,13 +29,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 Data structures and functions for representing parser and writer
 options.
 -}
-module Text.Pandoc.Options ( Extension(..)
-                           , pandocExtensions
-                           , plainExtensions
-                           , strictExtensions
-                           , phpMarkdownExtraExtensions
-                           , githubMarkdownExtensions
-                           , multimarkdownExtensions
+module Text.Pandoc.Options ( module Text.Pandoc.Extensions
                            , ReaderOptions(..)
                            , HTMLMathMethod (..)
                            , CiteMethod (..)
@@ -43,6 +37,7 @@ module Text.Pandoc.Options ( Extension(..)
                            , HTMLSlideVariant (..)
                            , EPUBVersion (..)
                            , WrapOption (..)
+                           , Verbosity (..)
                            , TopLevelDivision (..)
                            , WriterOptions (..)
                            , TrackChanges (..)
@@ -50,246 +45,37 @@ module Text.Pandoc.Options ( Extension(..)
                            , def
                            , isEnabled
                            ) where
-import Data.Set (Set)
-import qualified Data.Set as Set
+import Text.Pandoc.Extensions
 import Data.Default
 import Text.Pandoc.Highlighting (Style, pygments)
-import Text.Pandoc.MediaBag (MediaBag)
 import Data.Data (Data)
 import Data.Typeable (Typeable)
 import GHC.Generics (Generic)
 
--- | Individually selectable syntax extensions.
-data Extension =
-      Ext_footnotes           -- ^ Pandoc/PHP/MMD style footnotes
-    | Ext_inline_notes        -- ^ Pandoc-style inline notes
-    | Ext_pandoc_title_block  -- ^ Pandoc title block
-    | Ext_yaml_metadata_block -- ^ YAML metadata block
-    | Ext_mmd_title_block     -- ^ Multimarkdown metadata block
-    | Ext_table_captions      -- ^ Pandoc-style table captions
-    | Ext_implicit_figures    -- ^ A paragraph with just an image is a figure
-    | Ext_simple_tables       -- ^ Pandoc-style simple tables
-    | Ext_multiline_tables    -- ^ Pandoc-style multiline tables
-    | Ext_grid_tables         -- ^ Grid tables (pandoc, reST)
-    | Ext_pipe_tables         -- ^ Pipe tables (as in PHP markdown extra)
-    | Ext_citations           -- ^ Pandoc/citeproc citations
-    | Ext_raw_tex             -- ^ Allow raw TeX (other than math)
-    | Ext_raw_html            -- ^ Allow raw HTML
-    | Ext_tex_math_dollars    -- ^ TeX math between $..$ or $$..$$
-    | Ext_tex_math_single_backslash  -- ^ TeX math btw \(..\) \[..\]
-    | Ext_tex_math_double_backslash  -- ^ TeX math btw \\(..\\) \\[..\\]
-    | Ext_latex_macros        -- ^ Parse LaTeX macro definitions (for math only)
-    | Ext_fenced_code_blocks  -- ^ Parse fenced code blocks
-    | Ext_fenced_code_attributes  -- ^ Allow attributes on fenced code blocks
-    | Ext_backtick_code_blocks    -- ^ GitHub style ``` code blocks
-    | Ext_inline_code_attributes  -- ^ Allow attributes on inline code
-    | Ext_markdown_in_html_blocks -- ^ Interpret as markdown inside HTML blocks
-    | Ext_native_divs             -- ^ Use Div blocks for contents of <div> tags
-    | Ext_native_spans            -- ^ Use Span inlines for contents of <span>
-    | Ext_bracketed_spans         -- ^ Bracketed spans with attributes
-    | Ext_markdown_attribute      -- ^ Interpret text inside HTML as markdown
-                                  --   iff container has attribute 'markdown'
-    | Ext_escaped_line_breaks     -- ^ Treat a backslash at EOL as linebreak
-    | Ext_link_attributes         -- ^ link and image attributes
-    | Ext_mmd_link_attributes     -- ^ MMD style reference link attributes
-    | Ext_autolink_bare_uris  -- ^ Make all absolute URIs into links
-    | Ext_fancy_lists         -- ^ Enable fancy list numbers and delimiters
-    | Ext_lists_without_preceding_blankline -- ^ Allow lists without preceding blank
-    | Ext_startnum            -- ^ Make start number of ordered list significant
-    | Ext_definition_lists    -- ^ Definition lists as in pandoc, mmd, php
-    | Ext_compact_definition_lists  -- ^ Definition lists without
-                               -- space between items, and disallow laziness
-    | Ext_example_lists       -- ^ Markdown-style numbered examples
-    | Ext_all_symbols_escapable  -- ^ Make all non-alphanumerics escapable
-    | Ext_angle_brackets_escapable  -- ^ Make < and > escapable
-    | Ext_intraword_underscores  -- ^ Treat underscore inside word as literal
-    | Ext_blank_before_blockquote -- ^ Require blank line before a blockquote
-    | Ext_blank_before_header     -- ^ Require blank line before a header
-    | Ext_strikeout           -- ^ Strikeout using ~~this~~ syntax
-    | Ext_superscript         -- ^ Superscript using ^this^ syntax
-    | Ext_subscript           -- ^ Subscript using ~this~ syntax
-    | Ext_hard_line_breaks    -- ^ All newlines become hard line breaks
-    | Ext_ignore_line_breaks  -- ^ Newlines in paragraphs are ignored
-    | Ext_east_asian_line_breaks  -- ^ Newlines in paragraphs are ignored between
-                              -- East Asian wide characters
-    | Ext_literate_haskell    -- ^ Enable literate Haskell conventions
-    | Ext_abbreviations       -- ^ PHP markdown extra abbreviation definitions
-    | Ext_emoji               -- ^ Support emoji like :smile:
-    | Ext_auto_identifiers    -- ^ Automatic identifiers for headers
-    | Ext_ascii_identifiers   -- ^ ascii-only identifiers for headers
-    | Ext_header_attributes   -- ^ Explicit header attributes {#id .class k=v}
-    | Ext_mmd_header_identifiers -- ^ Multimarkdown style header identifiers [myid]
-    | Ext_implicit_header_references -- ^ Implicit reference links for headers
-    | Ext_line_blocks         -- ^ RST style line blocks
-    | Ext_epub_html_exts      -- ^ Recognise the EPUB extended version of HTML
-    | Ext_shortcut_reference_links -- ^ Shortcut reference links
-    deriving (Show, Read, Enum, Eq, Ord, Bounded, Data, Typeable, Generic)
-
-pandocExtensions :: Set Extension
-pandocExtensions = Set.fromList
-  [ Ext_footnotes
-  , Ext_inline_notes
-  , Ext_pandoc_title_block
-  , Ext_yaml_metadata_block
-  , Ext_table_captions
-  , Ext_implicit_figures
-  , Ext_simple_tables
-  , Ext_multiline_tables
-  , Ext_grid_tables
-  , Ext_pipe_tables
-  , Ext_citations
-  , Ext_raw_tex
-  , Ext_raw_html
-  , Ext_tex_math_dollars
-  , Ext_latex_macros
-  , Ext_fenced_code_blocks
-  , Ext_fenced_code_attributes
-  , Ext_backtick_code_blocks
-  , Ext_inline_code_attributes
-  , Ext_markdown_in_html_blocks
-  , Ext_native_divs
-  , Ext_native_spans
-  , Ext_bracketed_spans
-  , Ext_escaped_line_breaks
-  , Ext_fancy_lists
-  , Ext_startnum
-  , Ext_definition_lists
-  , Ext_example_lists
-  , Ext_all_symbols_escapable
-  , Ext_intraword_underscores
-  , Ext_blank_before_blockquote
-  , Ext_blank_before_header
-  , Ext_strikeout
-  , Ext_superscript
-  , Ext_subscript
-  , Ext_auto_identifiers
-  , Ext_header_attributes
-  , Ext_link_attributes
-  , Ext_implicit_header_references
-  , Ext_line_blocks
-  , Ext_shortcut_reference_links
-  ]
-
-plainExtensions :: Set Extension
-plainExtensions = Set.fromList
-  [ Ext_table_captions
-  , Ext_implicit_figures
-  , Ext_simple_tables
-  , Ext_multiline_tables
-  , Ext_grid_tables
-  , Ext_latex_macros
-  , Ext_fancy_lists
-  , Ext_startnum
-  , Ext_definition_lists
-  , Ext_example_lists
-  , Ext_intraword_underscores
-  , Ext_blank_before_blockquote
-  , Ext_blank_before_header
-  , Ext_strikeout
-  ]
-
-phpMarkdownExtraExtensions :: Set Extension
-phpMarkdownExtraExtensions = Set.fromList
-  [ Ext_footnotes
-  , Ext_pipe_tables
-  , Ext_raw_html
-  , Ext_markdown_attribute
-  , Ext_fenced_code_blocks
-  , Ext_definition_lists
-  , Ext_intraword_underscores
-  , Ext_header_attributes
-  , Ext_link_attributes
-  , Ext_abbreviations
-  , Ext_shortcut_reference_links
-  ]
-
-githubMarkdownExtensions :: Set Extension
-githubMarkdownExtensions = Set.fromList
-  [ Ext_angle_brackets_escapable
-  , Ext_pipe_tables
-  , Ext_raw_html
-  , Ext_fenced_code_blocks
-  , Ext_auto_identifiers
-  , Ext_ascii_identifiers
-  , Ext_backtick_code_blocks
-  , Ext_autolink_bare_uris
-  , Ext_intraword_underscores
-  , Ext_strikeout
-  , Ext_hard_line_breaks
-  , Ext_emoji
-  , Ext_lists_without_preceding_blankline
-  , Ext_shortcut_reference_links
-  ]
-
-multimarkdownExtensions :: Set Extension
-multimarkdownExtensions = Set.fromList
-  [ Ext_pipe_tables
-  , Ext_raw_html
-  , Ext_markdown_attribute
-  , Ext_mmd_link_attributes
-  -- , Ext_raw_tex
-  -- Note: MMD's raw TeX syntax requires raw TeX to be
-  -- enclosed in HTML comment
-  , Ext_tex_math_double_backslash
-  , Ext_intraword_underscores
-  , Ext_mmd_title_block
-  , Ext_footnotes
-  , Ext_definition_lists
-  , Ext_all_symbols_escapable
-  , Ext_implicit_header_references
-  , Ext_auto_identifiers
-  , Ext_mmd_header_identifiers
-  , Ext_implicit_figures
-  -- Note: MMD's syntax for superscripts and subscripts
-  -- is a bit more permissive than pandoc's, allowing
-  -- e^2 and a~1 instead of e^2^ and a~1~, so even with
-  -- these options we don't have full support for MMD
-  -- superscripts and subscripts, but there's no reason
-  -- not to include these:
-  , Ext_superscript
-  , Ext_subscript
-  ]
-
-strictExtensions :: Set Extension
-strictExtensions = Set.fromList
-  [ Ext_raw_html
-  , Ext_shortcut_reference_links
-  ]
-
 data ReaderOptions = ReaderOptions{
-         readerExtensions      :: Set Extension  -- ^ Syntax extensions
-       , readerSmart           :: Bool -- ^ Smart punctuation
+         readerExtensions      :: Extensions  -- ^ Syntax extensions
        , readerStandalone      :: Bool -- ^ Standalone document with header
        , readerParseRaw        :: Bool -- ^ Parse raw HTML, LaTeX
        , readerColumns         :: Int  -- ^ Number of columns in terminal
        , readerTabStop         :: Int  -- ^ Tab stop
-       , readerOldDashes       :: Bool -- ^ Use pandoc <= 1.8.2.1 behavior
-                                       --   in parsing dashes; -- is em-dash;
-                                       --   - before numerial is en-dash
        , readerApplyMacros     :: Bool -- ^ Apply macros to TeX math
        , readerIndentedCodeClasses :: [String] -- ^ Default classes for
                                        -- indented code blocks
        , readerDefaultImageExtension :: String -- ^ Default extension for images
-       , readerTrace           :: Bool -- ^ Print debugging info
        , readerTrackChanges    :: TrackChanges
-       , readerFileScope      :: Bool -- ^ Parse before combining
 } deriving (Show, Read, Data, Typeable, Generic)
 
 instance Default ReaderOptions
   where def = ReaderOptions{
-                 readerExtensions            = pandocExtensions
-               , readerSmart                 = False
+                 readerExtensions            = emptyExtensions
                , readerStandalone            = False
                , readerParseRaw              = False
                , readerColumns               = 80
                , readerTabStop               = 4
-               , readerOldDashes             = False
                , readerApplyMacros           = True
                , readerIndentedCodeClasses   = []
                , readerDefaultImageExtension = ""
-               , readerTrace                 = False
                , readerTrackChanges          = AcceptChanges
-               , readerFileScope             = False
                }
 
 --
@@ -354,20 +140,22 @@ data ReferenceLocation = EndOfBlock    -- ^ End of block
                        | EndOfDocument -- ^ at end of document
                        deriving (Show, Read, Eq, Data, Typeable, Generic)
 
+-- | Verbosity level.
+data Verbosity = ERROR | WARNING | INFO | DEBUG
+     deriving (Show, Read, Eq, Data, Enum, Ord, Bounded, Typeable, Generic)
+
 -- | Options for writers
 data WriterOptions = WriterOptions
   { writerTemplate         :: Maybe String -- ^ Template to use
   , writerVariables        :: [(String, String)] -- ^ Variables to set in template
   , writerTabStop          :: Int    -- ^ Tabstop for conversion btw spaces and tabs
   , writerTableOfContents  :: Bool   -- ^ Include table of contents
-  , writerSlideVariant     :: HTMLSlideVariant -- ^ Are we writing S5, Slidy or Slideous?
   , writerIncremental      :: Bool   -- ^ True if lists should be incremental
   , writerHTMLMathMethod   :: HTMLMathMethod  -- ^ How to print math in HTML
-  , writerIgnoreNotes      :: Bool   -- ^ Ignore footnotes (used in making toc)
   , writerNumberSections   :: Bool   -- ^ Number sections in LaTeX
   , writerNumberOffset     :: [Int]  -- ^ Starting number for section, subsection, ...
   , writerSectionDivs      :: Bool   -- ^ Put sections in div tags in HTML
-  , writerExtensions       :: Set Extension -- ^ Markdown extensions that can be used
+  , writerExtensions       :: Extensions -- ^ Markdown extensions that can be used
   , writerReferenceLinks   :: Bool   -- ^ Use reference links in writing markdown, rst
   , writerDpi              :: Int    -- ^ Dpi for pixel to/from inch/cm conversions
   , writerWrapText         :: WrapOption  -- ^ Option for wrapping text
@@ -378,27 +166,19 @@ data WriterOptions = WriterOptions
   , writerSourceURL        :: Maybe String  -- ^ Absolute URL + directory of 1st source file
   , writerUserDataDir      :: Maybe FilePath -- ^ Path of user data directory
   , writerCiteMethod       :: CiteMethod -- ^ How to print cites
-  , writerDocbook5         :: Bool       -- ^ Produce DocBook5
-  , writerHtml5            :: Bool       -- ^ Produce HTML5
   , writerHtmlQTags        :: Bool       -- ^ Use @<q>@ tags for quotes in HTML
-  , writerBeamer           :: Bool       -- ^ Produce beamer LaTeX slide show
   , writerSlideLevel       :: Maybe Int  -- ^ Force header level of slides
   , writerTopLevelDivision :: TopLevelDivision -- ^ Type of top-level divisions
   , writerListings         :: Bool       -- ^ Use listings package for code
-  , writerHighlight        :: Bool       -- ^ Highlight source code
-  , writerHighlightStyle   :: Style      -- ^ Style to use for highlighting
+  , writerHighlightStyle   :: Maybe Style  -- ^ Style to use for highlighting
+                                           -- (Nothing = no highlighting)
   , writerSetextHeaders    :: Bool       -- ^ Use setext headers for levels 1-2 in markdown
-  , writerTeXLigatures     :: Bool       -- ^ Use tex ligatures quotes, dashes in latex
-  , writerEpubVersion      :: Maybe EPUBVersion -- ^ Nothing or EPUB version
   , writerEpubMetadata     :: String     -- ^ Metadata to include in EPUB
   , writerEpubStylesheet   :: Maybe String -- ^ EPUB stylesheet specified at command line
   , writerEpubFonts        :: [FilePath] -- ^ Paths to fonts to embed
   , writerEpubChapterLevel :: Int            -- ^ Header level for chapters (separate files)
   , writerTOCDepth         :: Int            -- ^ Number of levels to include in TOC
-  , writerReferenceODT     :: Maybe FilePath -- ^ Path to reference ODT if specified
-  , writerReferenceDocx    :: Maybe FilePath -- ^ Path to reference DOCX if specified
-  , writerMediaBag         :: MediaBag       -- ^ Media collected by docx or epub reader
-  , writerVerbose          :: Bool           -- ^ Verbose debugging output
+  , writerReferenceDoc     :: Maybe FilePath -- ^ Path to reference document if specified
   , writerLaTeXArgs        :: [String]       -- ^ Flags to pass to latex-engine
   , writerReferenceLocation :: ReferenceLocation    -- ^ Location of footnotes and references for writing markdown
   } deriving (Show, Data, Typeable, Generic)
@@ -408,14 +188,12 @@ instance Default WriterOptions where
                       , writerVariables        = []
                       , writerTabStop          = 4
                       , writerTableOfContents  = False
-                      , writerSlideVariant     = NoSlides
                       , writerIncremental      = False
                       , writerHTMLMathMethod   = PlainMath
-                      , writerIgnoreNotes      = False
                       , writerNumberSections   = False
                       , writerNumberOffset     = [0,0,0,0,0,0]
                       , writerSectionDivs      = False
-                      , writerExtensions       = pandocExtensions
+                      , writerExtensions       = emptyExtensions
                       , writerReferenceLinks   = False
                       , writerDpi              = 96
                       , writerWrapText         = WrapAuto
@@ -425,31 +203,22 @@ instance Default WriterOptions where
                       , writerSourceURL        = Nothing
                       , writerUserDataDir      = Nothing
                       , writerCiteMethod       = Citeproc
-                      , writerDocbook5         = False
-                      , writerHtml5            = False
                       , writerHtmlQTags        = False
-                      , writerBeamer           = False
                       , writerSlideLevel       = Nothing
                       , writerTopLevelDivision = TopLevelDefault
                       , writerListings         = False
-                      , writerHighlight        = False
-                      , writerHighlightStyle   = pygments
+                      , writerHighlightStyle   = Just pygments
                       , writerSetextHeaders    = True
-                      , writerTeXLigatures     = True
-                      , writerEpubVersion      = Nothing
                       , writerEpubMetadata     = ""
                       , writerEpubStylesheet   = Nothing
                       , writerEpubFonts        = []
                       , writerEpubChapterLevel = 1
                       , writerTOCDepth         = 3
-                      , writerReferenceODT     = Nothing
-                      , writerReferenceDocx    = Nothing
-                      , writerMediaBag         = mempty
-                      , writerVerbose          = False
+                      , writerReferenceDoc     = Nothing
                       , writerLaTeXArgs        = []
                       , writerReferenceLocation = EndOfDocument
                       }
 
 -- | Returns True if the given extension is enabled.
 isEnabled :: Extension -> WriterOptions -> Bool
-isEnabled ext opts = ext `Set.member` (writerExtensions opts)
+isEnabled ext opts = ext `extensionEnabled` (writerExtensions opts)