{-# LANGUAGE MultiWayIf #-}
{-# LANGUAGE OverloadedStrings #-}
module Text.Pandoc.Filter.Pyplot (
makePlot
, makePlotWithConfig
, plotTransform
, plotTransformWithConfig
, configuration
, Configuration (..)
, PandocPyplotError(..)
, makePlot'
) where
import Control.Monad ((>=>), join)
import Data.List (intersperse)
import Data.Default.Class (def)
import qualified Data.Map.Strict as Map
import Data.Maybe (fromMaybe)
import Data.Monoid ((<>))
import qualified Data.Text as T
import qualified Data.Text.IO as T
import Data.Version (showVersion)
import Paths_pandoc_pyplot (version)
import System.Directory (createDirectoryIfMissing,
doesFileExist)
import System.FilePath (makeValid, takeDirectory)
import Text.Pandoc.Definition
import Text.Pandoc.Walk (walkM)
import Text.Pandoc.Filter.Pyplot.Internal
data PandocPyplotError
= ScriptError Int
| BlockingCallError
deriving (Eq)
instance Show PandocPyplotError where
show (ScriptError exitcode) = "Script error: plot could not be generated. Exit code " <> (show exitcode)
show BlockingCallError = "Script contains a blocking call to show, like 'plt.show()'"
parseFigureSpec :: Configuration -> Block -> IO (Maybe FigureSpec)
parseFigureSpec config (CodeBlock (id', cls, attrs) content)
| "pyplot" `elem` cls = Just <$> figureSpec
| otherwise = return Nothing
where
attrs' = Map.fromList attrs
filteredAttrs = filter (\(k, _) -> k `notElem` inclusionKeys) attrs
includePath = Map.lookup includePathKey attrs'
figureSpec :: IO FigureSpec
figureSpec = do
includeScript <- fromMaybe (return $ defaultIncludeScript config) $ T.readFile <$> includePath
let header = "# Generated by pandoc-pyplot " <> ((T.pack . showVersion) version)
fullScript = mconcat $ intersperse "\n" [header, includeScript, T.pack content]
caption' = Map.findWithDefault mempty captionKey attrs'
format = fromMaybe (defaultSaveFormat config) $ join $ saveFormatFromString <$> Map.lookup saveFormatKey attrs'
dir = makeValid $ Map.findWithDefault (defaultDirectory config) directoryKey attrs'
dpi' = fromMaybe (defaultDPI config) $ read <$> Map.lookup dpiKey attrs'
blockAttrs' = (id', filter (/= "pyplot") cls, filteredAttrs)
return $ FigureSpec caption' fullScript format dir dpi' blockAttrs'
parseFigureSpec _ _ = return Nothing
runScriptIfNecessary :: Configuration -> FigureSpec -> IO ScriptResult
runScriptIfNecessary config spec = do
createDirectoryIfMissing True . takeDirectory $ figurePath spec
fileAlreadyExists <- doesFileExist $ figurePath spec
result <- if fileAlreadyExists
then return ScriptSuccess
else runTempPythonScript (interpreter config) (addPlotCapture spec)
case result of
ScriptFailure code -> return $ ScriptFailure code
ScriptSuccess -> T.writeFile (sourceCodePath spec) (script spec) >> return ScriptSuccess
makePlot' :: Configuration -> Block -> IO (Either PandocPyplotError Block)
makePlot' config block = do
parsed <- parseFigureSpec config block
case parsed of
Nothing -> return $ Right block
Just spec ->
if hasBlockingShowCall (script spec)
then return $ Left BlockingCallError
else handleResult spec <$> runScriptIfNecessary config spec
where
handleResult _ (ScriptFailure code) = Left $ ScriptError code
handleResult spec ScriptSuccess = Right $ toImage spec
makePlot :: Block -> IO Block
makePlot = makePlotWithConfig def
makePlotWithConfig :: Configuration -> Block -> IO Block
makePlotWithConfig config = makePlot' config >=> either (fail . show) return
plotTransform :: Pandoc -> IO Pandoc
plotTransform = walkM makePlot
plotTransformWithConfig :: Configuration -> Pandoc -> IO Pandoc
plotTransformWithConfig = walkM . makePlotWithConfig