Documentation

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.

Evaluate a PandocIO operation.

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

Extract media from the mediabag into a directory.

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

Get the POSIX time.

Get the zoned time.

Read file, checking in any number of directories.

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.

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

Set request header to use in HTTP requests.

Determine whether certificate validation is disabled

Get the accumulated log messages (in temporal order).

Set the verbosity level.

Get the verbosity level.

Retrieve the media bag.

Initialize the media bag.

Insert an item into the media bag.

Set the user data directory in common state.

Get the user data directory from common state.

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

Retrieve the input filenames.

Set the input filenames.

Retrieve the output filename.

Set the output filename.

Set the resource path searched by fetchItem.

Retrieve the resource path searched by fetchItem.

Read file from from the default data files.

Read file from user data directory or, if not found there, from the default data files.

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

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

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.

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

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

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.

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

Retrieve the underlying state of the PandocPure type.

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

Set a new state for the PandocPure type.

Modify the underlying state of the PandocPure type.

Basis of the mock file system used by PandocPure.

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

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

Insert an ersatz file into the FileTree.

Run a PandocPure operation.

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.