Copyright	(c) 2011-2014 Diagrams team (see LICENSE)
License	BSD-style (see LICENSE)
Maintainer	diagrams-discuss@googlegroups.com
Safe Haskell	None
Language	Haskell2010

Diagrams.Backend.Canvas.CmdLine

Contents

General form of main
Supported froms of main
Orphan instances

Description

Convenient creation of command-line-driven executables for rendering diagrams using the Canvas 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.
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 suitable 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.

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

Synopsis

General form of `main`

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 froms of `main`

defaultMain :: QDiagram Canvas V2 Double Any -> IO () Source #

multiMain :: [(String, QDiagram Canvas V2 Double Any)] -> IO () Source #

data Canvas Source #

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

Instances

Eq Canvas Source #
Methods (==) :: Canvas -> Canvas -> Bool # (/=) :: Canvas -> Canvas -> Bool #
Ord Canvas Source #
Methods compare :: Canvas -> Canvas -> Ordering # (<) :: Canvas -> Canvas -> Bool # (<=) :: Canvas -> Canvas -> Bool # (>) :: Canvas -> Canvas -> Bool # (>=) :: Canvas -> Canvas -> Bool # max :: Canvas -> Canvas -> Canvas # min :: Canvas -> Canvas -> Canvas #
Read Canvas Source #
Methods readsPrec :: Int -> ReadS Canvas # readList :: ReadS [Canvas] # readPrec :: ReadPrec Canvas # readListPrec :: ReadPrec [Canvas] #
Show Canvas Source #
Methods showsPrec :: Int -> Canvas -> ShowS # show :: Canvas -> String # showList :: [Canvas] -> ShowS #
Backend Canvas V2 Double Source #
Associated Types data Render Canvas (V2 :: * -> ) Double :: # type Result Canvas (V2 :: * -> ) Double :: # data Options Canvas (V2 :: * -> ) Double :: # Methods adjustDia :: (Additive V2, Monoid' m, Num Double) => Canvas -> Options Canvas V2 Double -> QDiagram Canvas V2 Double m -> (Options Canvas V2 Double, Transformation V2 Double, QDiagram Canvas V2 Double m) # renderRTree :: Canvas -> Options Canvas V2 Double -> RTree Canvas V2 Double Annotation -> Result Canvas V2 Double #
Renderable (Text Double) Canvas Source #
Methods render :: Canvas -> Text Double -> Render Canvas (V (Text Double)) (N (Text Double)) #
Renderable (DImage Double External) Canvas Source #
Methods render :: Canvas -> DImage Double External -> Render Canvas (V (DImage Double External)) (N (DImage Double External)) #
Renderable (Path V2 Double) Canvas Source #
Methods render :: Canvas -> Path V2 Double -> Render Canvas (V (Path V2 Double)) (N (Path V2 Double)) #
Renderable (Trail V2 Double) Canvas Source #
Methods render :: Canvas -> Trail V2 Double -> Render Canvas (V (Trail V2 Double)) (N (Trail V2 Double)) #
Monoid (Render Canvas V2 Double) Source #
Methods mempty :: Render Canvas V2 Double # mappend :: Render Canvas V2 Double -> Render Canvas V2 Double -> Render Canvas V2 Double # mconcat :: [Render Canvas V2 Double] -> Render Canvas V2 Double #
Renderable (Segment Closed V2 Double) Canvas Source #
Methods render :: Canvas -> Segment Closed V2 Double -> Render Canvas (V (Segment Closed V2 Double)) (N (Segment Closed V2 Double)) #
type V Canvas Source #
type V Canvas = V2
type N Canvas Source #
type N Canvas = Double
data Options Canvas V2 Double Source #
data Options Canvas V2 Double = CanvasOptions { _canvasSize :: SizeSpec V2 Double }
type Result Canvas V2 Double Source #
type Result Canvas V2 Double = Canvas ()
data Render Canvas V2 Double Source #
data Render Canvas V2 Double = C (RenderM ())
type MainOpts [(String, QDiagram Canvas V2 Double Any)] #
type MainOpts [(String, QDiagram Canvas V2 Double Any)] = (MainOpts (QDiagram Canvas V2 Double Any), DiagramMultiOpts)
type MainOpts (QDiagram Canvas V2 Double Any) #
type MainOpts (QDiagram Canvas V2 Double Any)

type B = Canvas Source #

Orphan instances

Mainable [(String, QDiagram Canvas V2 Double Any)] Source #
Associated Types type MainOpts [(String, QDiagram Canvas V2 Double Any)] :: * # Methods mainArgs :: [(String, QDiagram Canvas V2 Double Any)] -> IO (MainOpts [(String, QDiagram Canvas V2 Double Any)]) # mainRender :: MainOpts [(String, QDiagram Canvas V2 Double Any)] -> [(String, QDiagram Canvas V2 Double Any)] -> IO () # mainWith :: [(String, QDiagram Canvas V2 Double Any)] -> IO () #
Mainable (QDiagram Canvas V2 Double Any) Source #
Associated Types type MainOpts (QDiagram Canvas V2 Double Any) :: * # Methods mainArgs :: QDiagram Canvas V2 Double Any -> IO (MainOpts (QDiagram Canvas V2 Double Any)) # mainRender :: MainOpts (QDiagram Canvas V2 Double Any) -> QDiagram Canvas V2 Double Any -> IO () # mainWith :: QDiagram Canvas V2 Double Any -> IO () #

General form of main

Supported froms of main

Orphan instances

General form of `main`

Supported froms of `main`