T.P.App: extract Opt into separate module

The new Opt module has only a few dependencies. This is important for
compile-times during development, as Template Haskell containing modules
are be recompiled whenever a (transitive) dependency changes.

1 files changed, 2 insertions, 177 deletions

diff --git a/src/Text/Pandoc/App/CommandLineOptions.hs b/src/Text/Pandoc/App/CommandLineOptions.hs
index 0fb88aeb3..088192021 100644
--- a/src/Text/Pandoc/App/CommandLineOptions.hs
+++ b/src/Text/Pandoc/App/CommandLineOptions.hs
@@ -1,6 +1,5 @@
 {-# LANGUAGE NoImplicitPrelude   #-}
 {-# LANGUAGE CPP                 #-}
-{-# LANGUAGE DeriveGeneric       #-}
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE TupleSections       #-}
 #ifdef DERIVE_JSON_VIA_TH
@@ -36,10 +35,7 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 Does a pandoc conversion based on command-line options.
 -}
 module Text.Pandoc.App.CommandLineOptions (
-            Opt(..)
-          , LineEnding (..)
-          , defaultOpts
-          , parseOptions
+            parseOptions
           , options
           , engines
           ) where
@@ -51,7 +47,6 @@ import Data.Aeson.Encode.Pretty (encodePretty', Config(..), keyOrder,
 import Data.Char (toLower, toUpper)
 import Data.List (intercalate, sort)
 import Data.Maybe (fromMaybe)
-import GHC.Generics
 import Skylighting (Style, Syntax (..), defaultSyntaxMap, parseTheme,
                     pygments)
 import System.Console.GetOpt
@@ -60,19 +55,13 @@ import System.Exit (exitSuccess)
 import System.FilePath
 import System.IO (stdout)
 import Text.Pandoc
+import Text.Pandoc.App.Opt (Opt (..), LineEnding (..))
 import Text.Pandoc.Filter (Filter (..))
 import Text.Pandoc.Highlighting (highlightingStyles)
 import Text.Pandoc.Writers.Math (defaultMathJaxURL, defaultKaTeXURL)
 import Text.Pandoc.Shared (ordNub, safeRead)
 import Text.Printf
 
-#ifdef DERIVE_JSON_VIA_TH
-import Data.Aeson.TH (deriveJSON, defaultOptions)
-#else
-import Data.Aeson (FromJSON (..), ToJSON (..),
-                   defaultOptions, genericToEncoding)
-#endif
-
 #ifdef EMBED_DATA_FILES
 import Text.Pandoc.Data (dataFiles)
 import System.Directory (getAppUserDataDirectory)
@@ -88,9 +77,6 @@ import qualified Data.Map as M
 import qualified Data.Text as T
 import qualified Text.Pandoc.UTF8 as UTF8
 
--- | The type of line-endings to be used when writing plain-text.
-data LineEnding = LF | CRLF | Native deriving (Show, Generic)
-
 parseOptions :: [OptDescr (Opt -> IO Opt)] -> Opt -> IO Opt
 parseOptions options' defaults = do
   rawArgs <- map UTF8.decodeArg <$> getArgs
@@ -130,152 +116,6 @@ engines = map ("html",) htmlEngines ++
 pdfEngines :: [String]
 pdfEngines = ordNub $ map snd engines
 
-
--- | Data structure for command line options.
-data Opt = Opt
-    { optTabStop               :: Int     -- ^ Number of spaces per tab
-    , optPreserveTabs          :: Bool    -- ^ Preserve tabs instead of converting to spaces
-    , optStandalone            :: Bool    -- ^ Include header, footer
-    , optReader                :: Maybe String  -- ^ Reader format
-    , optWriter                :: Maybe String  -- ^ Writer format
-    , optTableOfContents       :: Bool    -- ^ Include table of contents
-    , optBaseHeaderLevel       :: Int     -- ^ Base header level
-    , optTemplate              :: Maybe FilePath  -- ^ Custom template
-    , optVariables             :: [(String,String)] -- ^ Template variables to set
-    , optMetadata              :: [(String, String)] -- ^ Metadata fields to set
-    , optMetadataFile          :: Maybe FilePath  -- ^ Name of YAML metadata file
-    , optOutputFile            :: Maybe FilePath  -- ^ Name of output file
-    , optInputFiles            :: [FilePath] -- ^ Names of input files
-    , optNumberSections        :: Bool    -- ^ Number sections in LaTeX
-    , optNumberOffset          :: [Int]   -- ^ Starting number for sections
-    , optSectionDivs           :: Bool    -- ^ Put sections in div tags in HTML
-    , optIncremental           :: Bool    -- ^ Use incremental lists in Slidy/Slideous/S5
-    , optSelfContained         :: Bool    -- ^ Make HTML accessible offline
-    , optHtmlQTags             :: Bool    -- ^ Use <q> tags in HTML
-    , optHighlightStyle        :: Maybe Style -- ^ Style to use for highlighted code
-    , optSyntaxDefinitions     :: [FilePath]  -- ^ xml syntax defs to load
-    , optTopLevelDivision      :: TopLevelDivision -- ^ Type of the top-level divisions
-    , optHTMLMathMethod        :: HTMLMathMethod -- ^ Method to print HTML math
-    , optAbbreviations         :: Maybe FilePath -- ^ Path to abbrevs file
-    , optReferenceDoc          :: Maybe FilePath -- ^ Path of reference doc
-    , optEpubSubdirectory      :: String -- ^ EPUB subdir in OCF container
-    , optEpubMetadata          :: Maybe FilePath   -- ^ EPUB metadata
-    , optEpubFonts             :: [FilePath] -- ^ EPUB fonts to embed
-    , optEpubChapterLevel      :: Int     -- ^ Header level at which to split chapters
-    , optEpubCoverImage        :: Maybe FilePath -- ^ Cover image for epub
-    , optTOCDepth              :: Int     -- ^ Number of levels to include in TOC
-    , optDumpArgs              :: Bool    -- ^ Output command-line arguments
-    , optIgnoreArgs            :: Bool    -- ^ Ignore command-line arguments
-    , optVerbosity             :: Verbosity  -- ^ Verbosity of diagnostic output
-    , optTrace                 :: Bool  -- ^ Enable tracing
-    , optLogFile               :: Maybe FilePath -- ^ File to write JSON log output
-    , optFailIfWarnings        :: Bool    -- ^ Fail on warnings
-    , optReferenceLinks        :: Bool    -- ^ Use reference links in writing markdown, rst
-    , optReferenceLocation     :: ReferenceLocation -- ^ location for footnotes and link references in markdown output
-    , optDpi                   :: Int     -- ^ Dpi
-    , optWrapText              :: WrapOption  -- ^ Options for wrapping text
-    , optColumns               :: Int     -- ^ Line length in characters
-    , optFilters               :: [Filter] -- ^ Filters to apply
-    , optEmailObfuscation      :: ObfuscationMethod
-    , optIdentifierPrefix      :: String
-    , optStripEmptyParagraphs  :: Bool -- ^ Strip empty paragraphs
-    , optIndentedCodeClasses   :: [String] -- ^ Default classes for indented code blocks
-    , optDataDir               :: Maybe FilePath
-    , optCiteMethod            :: CiteMethod -- ^ Method to output cites
-    , optListings              :: Bool       -- ^ Use listings package for code blocks
-    , optPdfEngine             :: Maybe String -- ^ Program to use for latex/html -> pdf
-    , optPdfEngineArgs         :: [String]   -- ^ Flags to pass to the engine
-    , optSlideLevel            :: Maybe Int  -- ^ Header level that creates slides
-    , optSetextHeaders         :: Bool       -- ^ Use atx headers for markdown level 1-2
-    , optAscii                 :: Bool       -- ^ Prefer ascii output
-    , optDefaultImageExtension :: String -- ^ Default image extension
-    , optExtractMedia          :: Maybe FilePath -- ^ Path to extract embedded media
-    , optTrackChanges          :: TrackChanges -- ^ Accept or reject MS Word track-changes.
-    , optFileScope             :: Bool         -- ^ Parse input files before combining
-    , optTitlePrefix           :: Maybe String     -- ^ Prefix for title
-    , optCss                   :: [FilePath]       -- ^ CSS files to link to
-    , optIncludeBeforeBody     :: [FilePath]       -- ^ Files to include before
-    , optIncludeAfterBody      :: [FilePath]       -- ^ Files to include after body
-    , optIncludeInHeader       :: [FilePath]       -- ^ Files to include in header
-    , optResourcePath          :: [FilePath] -- ^ Path to search for images etc
-    , optRequestHeaders        :: [(String, String)] -- ^ Headers for HTTP requests
-    , optEol                   :: LineEnding -- ^ Style of line-endings to use
-    , optStripComments         :: Bool       -- ^ Skip HTML comments
-    } deriving (Generic, Show)
-
--- | Defaults for command-line options.
-defaultOpts :: Opt
-defaultOpts = Opt
-    { optTabStop               = 4
-    , optPreserveTabs          = False
-    , optStandalone            = False
-    , optReader                = Nothing
-    , optWriter                = Nothing
-    , optTableOfContents       = False
-    , optBaseHeaderLevel       = 1
-    , optTemplate              = Nothing
-    , optVariables             = []
-    , optMetadata              = []
-    , optMetadataFile          = Nothing
-    , optOutputFile            = Nothing
-    , optInputFiles            = []
-    , optNumberSections        = False
-    , optNumberOffset          = [0,0,0,0,0,0]
-    , optSectionDivs           = False
-    , optIncremental           = False
-    , optSelfContained         = False
-    , optHtmlQTags             = False
-    , optHighlightStyle        = Just pygments
-    , optSyntaxDefinitions     = []
-    , optTopLevelDivision      = TopLevelDefault
-    , optHTMLMathMethod        = PlainMath
-    , optAbbreviations         = Nothing
-    , optReferenceDoc          = Nothing
-    , optEpubSubdirectory      = "EPUB"
-    , optEpubMetadata          = Nothing
-    , optEpubFonts             = []
-    , optEpubChapterLevel      = 1
-    , optEpubCoverImage        = Nothing
-    , optTOCDepth              = 3
-    , optDumpArgs              = False
-    , optIgnoreArgs            = False
-    , optVerbosity             = WARNING
-    , optTrace                 = False
-    , optLogFile               = Nothing
-    , optFailIfWarnings        = False
-    , optReferenceLinks        = False
-    , optReferenceLocation     = EndOfDocument
-    , optDpi                   = 96
-    , optWrapText              = WrapAuto
-    , optColumns               = 72
-    , optFilters               = []
-    , optEmailObfuscation      = NoObfuscation
-    , optIdentifierPrefix      = ""
-    , optStripEmptyParagraphs  = False
-    , optIndentedCodeClasses   = []
-    , optDataDir               = Nothing
-    , optCiteMethod            = Citeproc
-    , optListings              = False
-    , optPdfEngine             = Nothing
-    , optPdfEngineArgs         = []
-    , optSlideLevel            = Nothing
-    , optSetextHeaders         = True
-    , optAscii                 = False
-    , optDefaultImageExtension = ""
-    , optExtractMedia          = Nothing
-    , optTrackChanges          = AcceptChanges
-    , optFileScope             = False
-    , optTitlePrefix           = Nothing
-    , optCss                   = []
-    , optIncludeBeforeBody     = []
-    , optIncludeAfterBody      = []
-    , optIncludeInHeader       = []
-    , optResourcePath          = ["."]
-    , optRequestHeaders        = []
-    , optEol                   = Native
-    , optStripComments          = False
-    }
-
 lookupHighlightStyle :: String -> IO (Maybe Style)
 lookupHighlightStyle s
   | takeExtension s == ".theme" = -- attempt to load KDE theme
@@ -1091,18 +931,3 @@ deprecatedOption o msg =
     \r -> case r of
        Right () -> return ()
        Left e   -> E.throwIO e
-
--- see https://github.com/jgm/pandoc/pull/4083
--- using generic deriving caused long compilation times
-#ifdef DERIVE_JSON_VIA_TH
-$(deriveJSON defaultOptions ''LineEnding)
-$(deriveJSON defaultOptions ''Opt)
-#else
-instance ToJSON LineEnding where
-  toEncoding = genericToEncoding defaultOptions
-instance FromJSON LineEnding
-
-instance ToJSON Opt where
-  toEncoding = genericToEncoding defaultOptions
-instance FromJSON Opt
-#endif