diff options
| -rw-r--r-- | src/Text/Pandoc/App.hs | 5 | ||||
| -rw-r--r-- | src/Text/Pandoc/Class.hs | 29 | ||||
| -rw-r--r-- | test/Tests/Readers/EPUB.hs | 4 |
3 files changed, 28 insertions, 10 deletions
diff --git a/src/Text/Pandoc/App.hs b/src/Text/Pandoc/App.hs index 0d4a82b70..498cfae22 100644 --- a/src/Text/Pandoc/App.hs +++ b/src/Text/Pandoc/App.hs @@ -76,7 +76,7 @@ import System.IO.Error (isDoesNotExistError) import Text.Pandoc import Text.Pandoc.Builder (setMeta) import Text.Pandoc.Class (PandocIO, extractMedia, fillMediaBag, getLog, - setResourcePath, withMediaBag, setTrace) + setResourcePath, getMediaBag, setTrace) import Text.Pandoc.Highlighting (highlightingStyles) import Text.Pandoc.Lua (runLuaFilter, LuaException(..)) import Text.Pandoc.Writers.Math (defaultMathJaxURL, defaultKaTeXURL) @@ -445,7 +445,7 @@ convertWithOpts opts = do runIO' $ do setResourcePath (optResourcePath opts) - (doc, media) <- withMediaBag $ sourceToDoc sources >>= + doc <- sourceToDoc sources >>= ( (if isJust (optExtractMedia opts) then fillMediaBag (writerSourceURL writerOptions) else return) @@ -455,6 +455,7 @@ convertWithOpts opts = do >=> applyLuaFilters datadir (optLuaFilters opts) [format] >=> applyFilters datadir filters' [format] ) + media <- getMediaBag case writer of ByteStringWriter f -> f writerOptions doc >>= writeFnBinary outputFile diff --git a/src/Text/Pandoc/Class.hs b/src/Text/Pandoc/Class.hs index 46e300953..df6da5a68 100644 --- a/src/Text/Pandoc/Class.hs +++ b/src/Text/Pandoc/Class.hs @@ -32,7 +32,11 @@ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Stability : alpha Portability : portable -Typeclass for pandoc readers and writers, allowing both IO and pure instances. +This module defines a type class, 'PandocMonad', for pandoc readers +and writers. A pure instance 'PandocPure' and an impure instance +'PandocIO' are provided. This allows users of the library to choose +whether they want conversions to perform IO operations (such as +reading include files or images). -} module Text.Pandoc.Class ( PandocMonad(..) @@ -65,7 +69,6 @@ module Text.Pandoc.Class ( PandocMonad(..) , runIO , runIOorExplode , runPure - , withMediaBag , fillMediaBag , extractMedia ) where @@ -173,8 +176,9 @@ class (Functor m, Applicative m, Monad m, MonadError PandocError m) modifyCommonState f = getCommonState >>= putCommonState . f -- Output a log message. logOutput :: LogMessage -> m () - -- Output a debug message to sterr, using 'Debug.Trace.trace'. - -- Note: this writes to stderr even in pure instances. + -- Output a debug message to sterr, using 'Debug.Trace.trace', + -- if tracing is enabled. Note: this writes to stderr even in + -- pure instances. trace :: String -> m () trace msg = do tracing <- getsCommonState stTrace @@ -241,13 +245,26 @@ readFileFromDirs (d:ds) f = catchError -- +-- | 'CommonState' represents state that is used by all +-- instances of 'PandocMonad'. Normally users should not +-- need to interact with it directly; instead, auxiliary +-- functions like 'setVerbosity' and 'withMediaBag' should be used. data CommonState = CommonState { stLog :: [LogMessage] + -- ^ A list of log messages in reverse order , stMediaBag :: MediaBag + -- ^ Media parsed from binary containers , stInputFiles :: Maybe [FilePath] + -- ^ List of input files from command line , stOutputFile :: Maybe FilePath + -- ^ Output file from command line , stResourcePath :: [FilePath] + -- ^ Path to search for resources like + -- included images , stVerbosity :: Verbosity + -- ^ Verbosity level , stTrace :: Bool + -- ^ Controls whether tracing messages are + -- issued. } instance Default CommonState where @@ -260,12 +277,10 @@ instance Default CommonState where , stTrace = False } +-- | Evaluate a 'PandocIO' operation. runIO :: PandocIO a -> IO (Either PandocError a) runIO ma = flip evalStateT def $ runExceptT $ unPandocIO ma -withMediaBag :: PandocMonad m => m a -> m (a, MediaBag) -withMediaBag ma = (,) <$> ma <*> getMediaBag - runIOorExplode :: PandocIO a -> IO a runIOorExplode ma = runIO ma >>= handleError diff --git a/test/Tests/Readers/EPUB.hs b/test/Tests/Readers/EPUB.hs index 5da5d33d3..201fd10a5 100644 --- a/test/Tests/Readers/EPUB.hs +++ b/test/Tests/Readers/EPUB.hs @@ -11,7 +11,9 @@ import Text.Pandoc.Readers.EPUB getMediaBag :: FilePath -> IO MediaBag getMediaBag fp = do bs <- BL.readFile fp - snd <$> (P.runIOorExplode $ P.withMediaBag $ readEPUB def bs) + P.runIOorExplode $ do + readEPUB def bs + P.getMediaBag testMediaBag :: FilePath -> [(String, String, Int)] -> IO () testMediaBag fp bag = do |