pandoc-2.17.1.1: Conversion between markup formats
CopyrightCopyright (C) 2016-2020 Jesse Rosenthal John MacFarlane
LicenseGNU GPL, version 2 or above
MaintainerJesse Rosenthal <jrosenthal@jhu.edu>
Stabilityalpha
Portabilityportable
Safe HaskellNone
LanguageHaskell2010

Text.Pandoc.Class

Description

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).

Synopsis

Documentation

data CommonState #

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.

Constructors

CommonState 

Fields

Instances

Instances details
Default CommonState # 
Instance details

Defined in Text.Pandoc.Class.CommonState

Methods

def :: CommonState #

newtype PandocIO a #

Instances

Instances details
Monad PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

Methods

(>>=) :: PandocIO a -> (a -> PandocIO b) -> PandocIO b #

(>>) :: PandocIO a -> PandocIO b -> PandocIO b #

return :: a -> PandocIO a #

Functor PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

Methods

fmap :: (a -> b) -> PandocIO a -> PandocIO b #

(<$) :: a -> PandocIO b -> PandocIO a #

Applicative PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

Methods

pure :: a -> PandocIO a #

(<*>) :: PandocIO (a -> b) -> PandocIO a -> PandocIO b #

liftA2 :: (a -> b -> c) -> PandocIO a -> PandocIO b -> PandocIO c #

(*>) :: PandocIO a -> PandocIO b -> PandocIO b #

(<*) :: PandocIO a -> PandocIO b -> PandocIO a #

MonadIO PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

Methods

liftIO :: IO a -> PandocIO a #

MonadThrow PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

Methods

throwM :: Exception e => e -> PandocIO a #

MonadCatch PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

Methods

catch :: Exception e => PandocIO a -> (e -> PandocIO a) -> PandocIO a #

MonadMask PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

Methods

mask :: ((forall a. PandocIO a -> PandocIO a) -> PandocIO b) -> PandocIO b #

uninterruptibleMask :: ((forall a. PandocIO a -> PandocIO a) -> PandocIO b) -> PandocIO b #

generalBracket :: PandocIO a -> (a -> ExitCase b -> PandocIO c) -> (a -> PandocIO b) -> PandocIO (b, c) #

PandocMonad PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

MonadError PandocError PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

runIO :: PandocIO a -> IO (Either PandocError a) #

Evaluate a PandocIO operation.

runIOorExplode :: PandocIO a -> IO a #

Evaluate a PandocIO operation, handling any errors by exiting with an appropriate message and error status.

extractMedia :: (PandocMonad m, MonadIO m) => FilePath -> Pandoc -> m Pandoc #

Extract media from the mediabag into a directory.

class (Functor m, Applicative m, Monad m, MonadError PandocError m) => PandocMonad m where #

The PandocMonad typeclass contains all the potentially IO-related functions used in pandoc's readers and writers. Instances of this typeclass may implement these functions in IO (as in PandocIO) or using an internal state that represents a file system, time, and so on (as in PandocPure).

Methods

lookupEnv :: Text -> m (Maybe Text) #

Lookup an environment variable.

getCurrentTime :: m UTCTime #

Get the current (UTC) time.

getCurrentTimeZone :: m TimeZone #

Get the locale's time zone.

newStdGen :: m StdGen #

Return a new generator for random numbers.

newUniqueHash :: m Int #

Return a new unique integer.

openURL :: Text -> m (ByteString, Maybe MimeType) #

Retrieve contents and mime type from a URL, raising an error on failure.

readFileLazy :: FilePath -> m ByteString #

Read the lazy ByteString contents from a file path, raising an error on failure.

readFileStrict :: FilePath -> m ByteString #

Read the strict ByteString contents from a file path, raising an error on failure.

readStdinStrict :: m ByteString #

Read the contents of stdin as a strict ByteString, raising an error on failure.

glob :: String -> m [FilePath] #

Return a list of paths that match a glob, relative to the working directory. See Glob for the glob syntax.

fileExists :: FilePath -> m Bool #

Returns True if file exists.

getDataFileName :: FilePath -> m FilePath #

Returns the path of data file.

getModificationTime :: FilePath -> m UTCTime #

Return the modification time of a file.

getCommonState :: m CommonState #

Get the value of the CommonState used by all instances of PandocMonad.

putCommonState :: CommonState -> m () #

Set the value of the CommonState used by all instances of PandocMonad. | Get the value of a specific field of CommonState.

getsCommonState :: (CommonState -> a) -> m a #

Get the value of a specific field of CommonState.

modifyCommonState :: (CommonState -> CommonState) -> m () #

Modify the CommonState.

logOutput :: LogMessage -> m () #

Output a log message.

trace :: Text -> m () #

Output a debug message to sterr, using trace, if tracing is enabled. Note: this writes to stderr even in pure instances.

Instances

Instances details
PandocMonad PandocPure # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

PandocMonad PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

(MonadTrans t, PandocMonad m, Functor (t m), MonadError PandocError (t m), Monad (t m), Applicative (t m)) => PandocMonad (t m) # 
Instance details

Defined in Text.Pandoc.Class.PandocMonad

PandocMonad m => PandocMonad (ParsecT s st m) # 
Instance details

Defined in Text.Pandoc.Class.PandocMonad

getPOSIXTime :: PandocMonad m => m POSIXTime #

Get the POSIX time.

getZonedTime :: PandocMonad m => m ZonedTime #

Get the zoned time.

readFileFromDirs :: PandocMonad m => [FilePath] -> FilePath -> m (Maybe Text) #

Read file, checking in any number of directories.

report :: PandocMonad m => LogMessage -> m () #

Log a message using logOutput. Note that logOutput is called only if the verbosity level exceeds the level of the message, but the message is added to the list of log messages that will be retrieved by getLog regardless of its verbosity level.

setTrace :: PandocMonad m => Bool -> m () #

Determine whether tracing is enabled. This affects the behavior of trace. If tracing is not enabled, trace does nothing.

setRequestHeader #

Arguments

:: PandocMonad m 
=> Text

Header name

-> Text

Value

-> m () 

Set request header to use in HTTP requests.

setNoCheckCertificate :: PandocMonad m => Bool -> m () #

Determine whether certificate validation is disabled

getLog :: PandocMonad m => m [LogMessage] #

Get the accumulated log messages (in temporal order).

setVerbosity :: PandocMonad m => Verbosity -> m () #

Set the verbosity level.

getVerbosity :: PandocMonad m => m Verbosity #

Get the verbosity level.

getMediaBag :: PandocMonad m => m MediaBag #

Retrieve the media bag.

setMediaBag :: PandocMonad m => MediaBag -> m () #

Initialize the media bag.

insertMedia :: PandocMonad m => FilePath -> Maybe MimeType -> ByteString -> m () #

Insert an item into the media bag.

setUserDataDir :: PandocMonad m => Maybe FilePath -> m () #

Set the user data directory in common state.

getUserDataDir :: PandocMonad m => m (Maybe FilePath) #

Get the user data directory from common state.

fetchItem :: PandocMonad m => Text -> m (ByteString, Maybe MimeType) #

Fetch an image or other item from the local filesystem or the net. Returns raw content and maybe mime type.

getInputFiles :: PandocMonad m => m [FilePath] #

Retrieve the input filenames.

setInputFiles :: PandocMonad m => [FilePath] -> m () #

Set the input filenames.

getOutputFile :: PandocMonad m => m (Maybe FilePath) #

Retrieve the output filename.

setOutputFile :: PandocMonad m => Maybe FilePath -> m () #

Set the output filename.

setResourcePath :: PandocMonad m => [FilePath] -> m () #

Set the resource path searched by fetchItem.

getResourcePath :: PandocMonad m => m [FilePath] #

Retrieve the resource path searched by fetchItem.

readDefaultDataFile :: PandocMonad m => FilePath -> m ByteString #

Read file from from the default data files.

readMetadataFile :: PandocMonad m => FilePath -> m ByteString #

Read metadata file from the working directory or, if not found there, from the metadata subdirectory of the user data directory.

fillMediaBag :: PandocMonad m => Pandoc -> m Pandoc #

Traverse tree, filling media bag for any images that aren't already in the media bag.

toLang :: PandocMonad m => Maybe Text -> m (Maybe Lang) #

Convert BCP47 string to a Lang, issuing warning if there are problems.

setTranslations :: PandocMonad m => Lang -> m () #

Select the language to use with translateTerm. Note that this does not read a translation file; that is only done the first time translateTerm is used.

translateTerm :: PandocMonad m => Term -> m Text #

Get a translation from the current term map. Issue a warning if the term is not defined.

makeCanonical :: FilePath -> FilePath #

Canonicalizes a file path by removing redundant . and ...

getTimestamp :: PandocMonad m => m UTCTime #

Get the time from the SOURCE_DATE_EPOCH environment variable. The variable should contain a unix time stamp, the number of seconds since midnight Jan 01 1970 UTC. If the variable is not set or cannot be parsed as a unix time stamp, the current time is returned. This function is designed to make possible reproducible builds in formats that include a creation timestamp.

data PureState #

The PureState contains ersatz representations of things that would normally be obtained through IO.

Constructors

PureState 

Fields

Instances

Instances details
Default PureState # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

Methods

def :: PureState #

getPureState :: PandocPure PureState #

Retrieve the underlying state of the PandocPure type.

getsPureState :: (PureState -> a) -> PandocPure a #

Retrieve a value from the underlying state of the PandocPure type.

putPureState :: PureState -> PandocPure () #

Set a new state for the PandocPure type.

modifyPureState :: (PureState -> PureState) -> PandocPure () #

Modify the underlying state of the PandocPure type.

newtype PandocPure a #

Instances

Instances details
Monad PandocPure # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

Methods

(>>=) :: PandocPure a -> (a -> PandocPure b) -> PandocPure b #

(>>) :: PandocPure a -> PandocPure b -> PandocPure b #

return :: a -> PandocPure a #

Functor PandocPure # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

Methods

fmap :: (a -> b) -> PandocPure a -> PandocPure b #

(<$) :: a -> PandocPure b -> PandocPure a #

Applicative PandocPure # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

Methods

pure :: a -> PandocPure a #

(<*>) :: PandocPure (a -> b) -> PandocPure a -> PandocPure b #

liftA2 :: (a -> b -> c) -> PandocPure a -> PandocPure b -> PandocPure c #

(*>) :: PandocPure a -> PandocPure b -> PandocPure b #

(<*) :: PandocPure a -> PandocPure b -> PandocPure a #

PandocMonad PandocPure # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

MonadError PandocError PandocPure # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

data FileTree #

Basis of the mock file system used by PandocPure.

Instances

Instances details
Semigroup FileTree # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

Monoid FileTree # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

data FileInfo #

Captures all file-level information necessary for a PandocMonad conforming mock file system.

addToFileTree :: FileTree -> FilePath -> IO FileTree #

Add the specified file to the FileTree. If file is a directory, add its contents recursively.

insertInFileTree :: FilePath -> FileInfo -> FileTree -> FileTree #

Insert an ersatz file into the FileTree.

runPure :: PandocPure a -> Either PandocError a #

Run a PandocPure operation.

sandbox :: (PandocMonad m, MonadIO m) => [FilePath] -> PandocPure a -> m a #

Lift a PandocPure action into any instance of PandocMonad. The main computation is done purely, but CommonState is preserved continuously, and warnings are emitted after the action completes. The parameter is a list of FilePaths which will be added to the ersatz file system and be available for reading.