Diagrams.Backend.Postscript.CmdLine

Convenient creation of command-line-driven executables for rendering diagrams using the Postscript backend.

• defaultMain creates an executable which can render a single diagram at various options.
• multiMain is like defaultMain but allows for a list of diagrams from which the user can choose one to render.
• pagesMain is like defaultMain but renders a list of diagrams as pages in a single file.
• animMain renders an animation at a given frame rate into separate files with an index number.
• mainWith is a generic form that does all of the above but with a slightly scarier type. See Diagrams.Backend.CmdLine. This form can also take a function type that has a subtable final result (any of arguments to the above types) and Parseable arguments.

If you want to generate diagrams programmatically---i.e. if you want to do anything more complex than what the below functions provide---you have several options.

• Use a function with mainWith. This may require making Parseable instances for custom argument types.
• Make a new Mainable instance. This may require a newtype wrapper on your diagram type to avoid the existing instances. This gives you more control over argument parsing, intervening steps, and diagram creation.
• Build option records and pass them along with a diagram to mainRender from Diagrams.Backend.CmdLine.
• An even more flexible approach is to directly call renderDia; see Diagrams.Backend.Postscript for more information.

For a tutorial on command-line diagram creation see http://projects.haskell.org/diagrams/doc/cmdline.html.

General form of main

The mainWith method unifies all of the other forms of main and is now the recommended way to build a command-line diagrams program. It works as a direct replacement for defaultMain, multiMain, pagesMain, or animMain as well as allowing more general arguments. For example, given a function that produces a diagram when given an Int and a Colour Double, mainWith will produce a program that looks for additional number and color arguments.

... definitions ...
f :: Int -> Colour Double -> QDiagram Postscript V2 Double Any
f i c = ...

main = mainWith f

We can run this program as follows:

$ ghc --make MyDiagram

# output image.eps built by `f 20 red`
$ ./MyDiagram -o image.eps -w 200 20 red

mainWith :: (Mainable d, Parseable (MainOpts d)) => d -> IO ()

Main entry point for command-line diagram creation. This is the method that users will call from their program main. For instance an expected user program would take the following form.

import Diagrams.Prelude
import Diagrams.Backend.TheBestBackend.CmdLine

d :: Diagram B R2
d = ...

main = mainWith d

Most backends should be able to use the default implementation. A different implementation should be used to handle more complex interactions with the user.

Supported forms of main

defaultMain :: QDiagram Postscript V2 Double Any -> IO ()

multiMain :: [(String, QDiagram Postscript V2 Double Any)] -> IO ()

pagesMain :: [QDiagram Postscript V2 Double Any] -> IO ()

animMain :: Animation Postscript V2 Double -> IO ()

animMain is like defaultMain, but renders an animation instead of a diagram. It takes as input an animation and produces a command-line program which will crudely "render" the animation by rendering one image for each frame, named by extending the given output file name by consecutive integers. For example if the given output file name is foo/blah.eps, the frames will be saved in foo/blah001.eps, foo/blah002.eps, and so on (the number of padding digits used depends on the total number of frames). It is up to the user to take these images and stitch them together into an actual animation format (using, e.g. ffmpeg).

Of course, this is a rather crude method of rendering animations; more sophisticated methods will likely be added in the future.

The --fpu option can be used to control how many frames will be output for each second (unit time) of animation.

Backend tokens

data Postscript

This data declaration is simply used as a token to distinguish this rendering engine.

Instances

Eq Postscript

Methods

(==) :: Postscript -> Postscript -> Bool

(/=) :: Postscript -> Postscript -> Bool

Ord Postscript

Methods

compare :: Postscript -> Postscript -> Ordering

(<) :: Postscript -> Postscript -> Bool

(<=) :: Postscript -> Postscript -> Bool

(>) :: Postscript -> Postscript -> Bool

(>=) :: Postscript -> Postscript -> Bool

max :: Postscript -> Postscript -> Postscript

min :: Postscript -> Postscript -> Postscript

Read Postscript

Methods

readsPrec :: Int -> ReadS Postscript

readList :: ReadS [Postscript]

readPrec :: ReadPrec Postscript

readListPrec :: ReadPrec [Postscript]

Show Postscript

Methods

showsPrec :: Int -> Postscript -> ShowS

show :: Postscript -> String

showList :: [Postscript] -> ShowS

Backend Postscript V2 Double

Associated Types

data Render Postscript (V2 :: * -> *) Double :: *

type Result Postscript (V2 :: * -> *) Double :: *

data Options Postscript (V2 :: * -> *) Double :: *

Methods

adjustDia :: (Additive V2, Monoid' m, Num Double) => Postscript -> Options Postscript V2 Double -> QDiagram Postscript V2 Double m -> (Options Postscript V2 Double, Transformation V2 Double, QDiagram Postscript V2 Double m)

renderRTree :: Postscript -> Options Postscript V2 Double -> RTree Postscript V2 Double Annotation -> Result Postscript V2 Double

Renderable (Text Double) Postscript

Methods

render :: Postscript -> Text Double -> Render Postscript (V (Text Double)) (N (Text Double))

Renderable (Path V2 Double) Postscript

Methods

render :: Postscript -> Path V2 Double -> Render Postscript (V (Path V2 Double)) (N (Path V2 Double))

Renderable (Trail V2 Double) Postscript

Methods

render :: Postscript -> Trail V2 Double -> Render Postscript (V (Trail V2 Double)) (N (Trail V2 Double))

Show (Options Postscript V2 Double)

Methods

showsPrec :: Int -> Options Postscript V2 Double -> ShowS

show :: Options Postscript V2 Double -> String

showList :: [Options Postscript V2 Double] -> ShowS

Monoid (Render Postscript V2 Double)

Methods

mempty :: Render Postscript V2 Double

mappend :: Render Postscript V2 Double -> Render Postscript V2 Double -> Render Postscript V2 Double

mconcat :: [Render Postscript V2 Double] -> Render Postscript V2 Double

Hashable (Options Postscript V2 Double)

Methods

hashWithSalt :: Int -> Options Postscript V2 Double -> Int

hash :: Options Postscript V2 Double -> Int

Renderable (Segment Closed V2 Double) Postscript

Methods

render :: Postscript -> Segment Closed V2 Double -> Render Postscript (V (Segment Closed V2 Double)) (N (Segment Closed V2 Double))

type V Postscript

type V Postscript = V2

type N Postscript

type N Postscript = Double

data Options Postscript V2 Double

data Options Postscript V2 Double = PostscriptOptions {

• _psfileName :: String
• _psSizeSpec :: SizeSpec V2 Double
• _psOutputFormat :: OutputFormat

}

type Result Postscript V2 Double

type Result Postscript V2 Double = IO ()

data Render Postscript V2 Double

data Render Postscript V2 Double = C (RenderM ())

type MainOpts [(String, QDiagram Postscript V2 Double Any)]

type MainOpts [(String, QDiagram Postscript V2 Double Any)] = (DiagramOpts, DiagramMultiOpts)

type MainOpts [QDiagram Postscript V2 Double Any]

type MainOpts [QDiagram Postscript V2 Double Any] = DiagramOpts

type MainOpts (Animation Postscript V2 Double)

type MainOpts (Animation Postscript V2 Double) = (DiagramOpts, DiagramAnimOpts)

type MainOpts (QDiagram Postscript V2 Double Any)

type MainOpts (QDiagram Postscript V2 Double Any) = DiagramOpts

type B = Postscript

Orphan instances

Mainable [(String, QDiagram Postscript V2 Double Any)]

Associated Types

type MainOpts [(String, QDiagram Postscript V2 Double Any)] :: *

Methods

mainArgs :: [(String, QDiagram Postscript V2 Double Any)] -> IO (MainOpts [(String, QDiagram Postscript V2 Double Any)])

mainRender :: MainOpts [(String, QDiagram Postscript V2 Double Any)] -> [(String, QDiagram Postscript V2 Double Any)] -> IO ()

mainWith :: [(String, QDiagram Postscript V2 Double Any)] -> IO ()

Mainable [QDiagram Postscript V2 Double Any]

Associated Types

type MainOpts [QDiagram Postscript V2 Double Any] :: *

Methods

mainArgs :: [QDiagram Postscript V2 Double Any] -> IO (MainOpts [QDiagram Postscript V2 Double Any])

mainRender :: MainOpts [QDiagram Postscript V2 Double Any] -> [QDiagram Postscript V2 Double Any] -> IO ()

mainWith :: [QDiagram Postscript V2 Double Any] -> IO ()

Mainable (Animation Postscript V2 Double)

Associated Types

type MainOpts (Animation Postscript V2 Double) :: *

Methods

mainArgs :: Animation Postscript V2 Double -> IO (MainOpts (Animation Postscript V2 Double))

mainRender :: MainOpts (Animation Postscript V2 Double) -> Animation Postscript V2 Double -> IO ()

mainWith :: Animation Postscript V2 Double -> IO ()

Mainable (QDiagram Postscript V2 Double Any)

Associated Types

type MainOpts (QDiagram Postscript V2 Double Any) :: *

Methods

mainArgs :: QDiagram Postscript V2 Double Any -> IO (MainOpts (QDiagram Postscript V2 Double Any))

mainRender :: MainOpts (QDiagram Postscript V2 Double Any) -> QDiagram Postscript V2 Double Any -> IO ()

mainWith :: QDiagram Postscript V2 Double Any -> IO ()