Copyright	(c) Jonas Weber 2015
License	ISC
Safe Haskell	Safe-Inferred
Language	Haskell2010

Text.Pandoc.PlantUML.Filter.Types

Description

Synopsis

type ImageName = String
newtype DiagramSource = DiagramSource Text
type ImageFormat = Text
data ImageFileName = ImageFileName ImageName ImageFormat
class Monad m => ImageIO m where
- doesImageExist :: ImageFileName -> m Bool
- renderImage :: ImageFileName -> DiagramSource -> m ()

Documentation

type ImageName = String Source #

The name of an image, without extension, usually a hash

newtype DiagramSource Source #

The source of a diagram

Constructors

DiagramSource Text

Instances

Instances details

Eq DiagramSource Source #
Instance details Defined in Text.Pandoc.PlantUML.Filter.Types Methods (==) :: DiagramSource -> DiagramSource -> Bool # (/=) :: DiagramSource -> DiagramSource -> Bool #
Show DiagramSource Source #
Instance details Defined in Text.Pandoc.PlantUML.Filter.Types Methods showsPrec :: Int -> DiagramSource -> ShowS # show :: DiagramSource -> String # showList :: [DiagramSource] -> ShowS #

type ImageFormat = Text Source #

An image format, e.g. "eps"

data ImageFileName Source #

A filename of an image. It contains the basename (myawesomepicture) and the extension (jpg). It can be shown, which is basically "myawesomepicture.jpg"

Constructors

ImageFileName ImageName ImageFormat

Instances

Instances details

Eq ImageFileName Source #
Instance details Defined in Text.Pandoc.PlantUML.Filter.Types Methods (==) :: ImageFileName -> ImageFileName -> Bool # (/=) :: ImageFileName -> ImageFileName -> Bool #
Show ImageFileName Source #	Show the image file name by joining basename and extension with a dot, yielding picture.jpg
Instance details Defined in Text.Pandoc.PlantUML.Filter.Types Methods showsPrec :: Int -> ImageFileName -> ShowS # show :: ImageFileName -> String # showList :: [ImageFileName] -> ShowS #

class Monad m => ImageIO m where Source #

External impure actions are encapsulated in this monad.

Methods

doesImageExist :: ImageFileName -> m Bool Source #

Tells whether an image with the given file name is already present in the store (e.g., the filesystem).

renderImage :: ImageFileName -> DiagramSource -> m () Source #

Calls out to an external diagram processor (PlantUML) to render the source to the given image file name.

Instances

Instances details

ImageIO IO Source #
Instance details Defined in Text.Pandoc.PlantUML.Filter.IORender Methods doesImageExist :: ImageFileName -> IO Bool Source # renderImage :: ImageFileName -> DiagramSource -> IO () Source #