pandoc-3.1.13: 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 #

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

Evaluate a PandocIO operation.

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

Extract media from the mediabag into a directory.

runIOorExplode :: PandocIO a -> IO a #

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

newtype PandocIO a #

Instances

Instances details
MonadIO PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

Methods

liftIO :: IO a -> 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 #

Functor PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

Methods

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

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

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 #

MonadCatch PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

Methods

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

MonadMask PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

Methods

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

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

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

MonadThrow PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

Methods

throwM :: (HasCallStack, Exception e) => e -> PandocIO a #

PandocMonad PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

MonadError PandocError PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

class (Functor m, Applicative m, Monad m, MonadError PandocError m) => PandocMonad (m :: Type -> Type) 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 PandocIO # 
Instance details

Defined in Text.Pandoc.Class.PandocIO

PandocMonad PandocPure # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

(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

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.

getPOSIXTime :: PandocMonad m => m POSIXTime #

Get the POSIX time. If SOURCE_DATE_EPOCH is set to a unix time, it is used instead of the current time.

getZonedTime :: PandocMonad m => m ZonedTime #

Get the zoned time. If SOURCE_DATE_EPOCH is set to a unix time, value (POSIX time), it is used instead of the current time.

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

Returns possible user data directory if the file path refers to a file or subdirectory within it.

getTimestamp :: PandocMonad m => m UTCTime #

Get the current UTC time. If the SOURCE_DATE_EPOCH environment variable is set to a unix time (number of seconds since midnight Jan 01 1970 UTC), it is used instead of the current time, to support reproducible builds.

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

Get the user data directory from common state.

makeCanonical :: FilePath -> FilePath #

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

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

Insert an item into the media bag.

findFileWithDataFallback #

Arguments

:: PandocMonad m 
=> FilePath

subdir

-> FilePath

fp

-> m (Maybe FilePath) 

Returns fp if the file exists in the current directory; otherwise searches for the data file relative to subdir. Returns Nothing if neither file exists.

getVerbosity :: PandocMonad m => m Verbosity #

Get the verbosity level.

toTextM :: PandocMonad m => FilePath -> ByteString -> m Text #

A variant of Text.Pandoc.UTF8.toText that takes a FilePath as well as the file's contents as parameter, and traps UTF8 decoding errors so it can issue a more informative PandocUTF8DecodingError with source position.

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

Retrieve the resource path searched by fetchItem.

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

Read file, checking in any number of directories.

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

Set the resource path searched by fetchItem.

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.

getMediaBag :: PandocMonad m => m MediaBag #

Retrieve the media bag.

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

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

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

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

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

Set the verbosity level.

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

Retrieve the input filenames.

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

Set the input filenames.

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

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

Initialize the media bag.

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

Set the user data directory in common state.

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

Retrieve the output filename.

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

Set the output filename.

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.

newtype PandocPure a #

Instances

Instances details
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 #

Functor PandocPure # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

Methods

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

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

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 #

PandocMonad PandocPure # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

MonadError PandocError PandocPure # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

runPure :: PandocPure a -> Either PandocError a #

Run a PandocPure operation.

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.

data FileTree #

Basis of the mock file system used by PandocPure.

Instances

Instances details
Monoid FileTree # 
Instance details

Defined in Text.Pandoc.Class.PandocPure

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

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.

data Translations #

Instances

Instances details
FromJSON Translations # 
Instance details

Defined in Text.Pandoc.Translations.Types

Monoid Translations # 
Instance details

Defined in Text.Pandoc.Translations.Types

Semigroup Translations # 
Instance details

Defined in Text.Pandoc.Translations.Types

Generic Translations # 
Instance details

Defined in Text.Pandoc.Translations.Types

Associated Types

type Rep Translations 
Instance details

Defined in Text.Pandoc.Translations.Types

type Rep Translations = D1 ('MetaData "Translations" "Text.Pandoc.Translations.Types" "pandoc-3.1.13-4z6Ggw740m1ARLbD77fK9I" 'True) (C1 ('MetaCons "Translations" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Term Text))))
Show Translations # 
Instance details

Defined in Text.Pandoc.Translations.Types

type Rep Translations # 
Instance details

Defined in Text.Pandoc.Translations.Types

type Rep Translations = D1 ('MetaData "Translations" "Text.Pandoc.Translations.Types" "pandoc-3.1.13-4z6Ggw740m1ARLbD77fK9I" 'True) (C1 ('MetaCons "Translations" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Term Text))))