Safe Haskell	None
Language	Haskell2010

Diagrams.Backend.Braille.CmdLine

Contents

General form of main
Supported forms of main
Backend tokens
Orphan instances

Description

Convenient creation of command-line-driven executables for rendering diagrams to Braille.

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.

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

Synopsis

mainWith :: Mainable d => d -> IO ()
defaultMain :: Diagram B -> IO ()
multiMain :: [(String, Diagram B)] -> IO ()
data Braille
type B = Braille

General form of `main`

mainWith :: Mainable 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 :: Diagram B -> IO () Source #

mainWith specialised to Diagram Rasterific.

multiMain :: [(String, Diagram B)] -> IO () Source #

multiMain takes a list of diagrams paired with names as input. The generated executable then takes a --selection option specifying the name of the diagram that should be rendered. The list of available diagrams may also be printed by passing the option --list.

Backend tokens

data Braille Source #

Instances

Instances details

Eq Braille Source #
Instance details Defined in Diagrams.Backend.Braille Methods (==) :: Braille -> Braille -> Bool # (/=) :: Braille -> Braille -> Bool #
Ord Braille Source #
Instance details Defined in Diagrams.Backend.Braille Methods compare :: Braille -> Braille -> Ordering # (<) :: Braille -> Braille -> Bool # (<=) :: Braille -> Braille -> Bool # (>) :: Braille -> Braille -> Bool # (>=) :: Braille -> Braille -> Bool # max :: Braille -> Braille -> Braille # min :: Braille -> Braille -> Braille #
Read Braille Source #
Instance details Defined in Diagrams.Backend.Braille Methods readsPrec :: Int -> ReadS Braille # readList :: ReadS [Braille] # readPrec :: ReadPrec Braille # readListPrec :: ReadPrec [Braille] #
Show Braille Source #
Instance details Defined in Diagrams.Backend.Braille Methods showsPrec :: Int -> Braille -> ShowS # show :: Braille -> String # showList :: [Braille] -> ShowS #
TypeableFloat n => Backend Braille V2 n Source #
Instance details Defined in Diagrams.Backend.Braille Associated Types data Render Braille V2 n # type Result Braille V2 n # data Options Braille V2 n # Methods adjustDia :: (Additive V2, Monoid' m, Num n) => Braille -> Options Braille V2 n -> QDiagram Braille V2 n m -> (Options Braille V2 n, Transformation V2 n, QDiagram Braille V2 n m) # renderRTree :: Braille -> Options Braille V2 n -> RTree Braille V2 n Annotation -> Result Braille V2 n #
TypeableFloat n => Mainable [(String, QDiagram B V2 n Any)] Source #
Instance details Defined in Diagrams.Backend.Braille.CmdLine Associated Types type MainOpts [(String, QDiagram B V2 n Any)] # Methods mainArgs :: Parseable (MainOpts [(String, QDiagram B V2 n Any)]) => proxy [(String, QDiagram B V2 n Any)] -> IO (MainOpts [(String, QDiagram B V2 n Any)]) # mainRender :: MainOpts [(String, QDiagram B V2 n Any)] -> [(String, QDiagram B V2 n Any)] -> IO () # mainWith :: [(String, QDiagram B V2 n Any)] -> IO () #
TypeableFloat n => Renderable (Text n) Braille Source #
Instance details Defined in Diagrams.Backend.Braille Methods render :: Braille -> Text n -> Render Braille (V (Text n)) (N (Text n)) #
TypeableFloat n => Renderable (DImage n Embedded) Braille Source #
Instance details Defined in Diagrams.Backend.Braille Methods render :: Braille -> DImage n Embedded -> Render Braille (V (DImage n Embedded)) (N (DImage n Embedded)) #
TypeableFloat n => Renderable (Path V2 n) Braille Source #
Instance details Defined in Diagrams.Backend.Braille Methods render :: Braille -> Path V2 n -> Render Braille (V (Path V2 n)) (N (Path V2 n)) #
Eq n => Eq (Options Braille V2 n) Source #
Instance details Defined in Diagrams.Backend.Braille Methods (==) :: Options Braille V2 n -> Options Braille V2 n -> Bool # (/=) :: Options Braille V2 n -> Options Braille V2 n -> Bool #
Show n => Show (Options Braille V2 n) Source #
Instance details Defined in Diagrams.Backend.Braille Methods showsPrec :: Int -> Options Braille V2 n -> ShowS # show :: Options Braille V2 n -> String # showList :: [Options Braille V2 n] -> ShowS #
Semigroup (Render Braille V2 n) Source #
Instance details Defined in Diagrams.Backend.Braille Methods (<>) :: Render Braille V2 n -> Render Braille V2 n -> Render Braille V2 n # sconcat :: NonEmpty (Render Braille V2 n) -> Render Braille V2 n # stimes :: Integral b => b -> Render Braille V2 n -> Render Braille V2 n #
Monoid (Render Braille V2 n) Source #
Instance details Defined in Diagrams.Backend.Braille Methods mempty :: Render Braille V2 n # mappend :: Render Braille V2 n -> Render Braille V2 n -> Render Braille V2 n # mconcat :: [Render Braille V2 n] -> Render Braille V2 n #
Hashable n => Hashable (Options Braille V2 n) Source #
Instance details Defined in Diagrams.Backend.Braille Methods hashWithSalt :: Int -> Options Braille V2 n -> Int # hash :: Options Braille V2 n -> Int #
TypeableFloat n => Mainable (QDiagram B V2 n Any) Source #
Instance details Defined in Diagrams.Backend.Braille.CmdLine Associated Types type MainOpts (QDiagram B V2 n Any) # Methods mainArgs :: Parseable (MainOpts (QDiagram B V2 n Any)) => proxy (QDiagram B V2 n Any) -> IO (MainOpts (QDiagram B V2 n Any)) # mainRender :: MainOpts (QDiagram B V2 n Any) -> QDiagram B V2 n Any -> IO () # mainWith :: QDiagram B V2 n Any -> IO () #
type V Braille Source #
Instance details Defined in Diagrams.Backend.Braille type V Braille = V2
type N Braille Source #
Instance details Defined in Diagrams.Backend.Braille type N Braille = Double
data Options Braille V2 n Source #
Instance details Defined in Diagrams.Backend.Braille data Options Braille V2 n = BrailleOptions { _sizeSpec :: SizeSpec V2 n }
newtype Render Braille V2 n Source #
Instance details Defined in Diagrams.Backend.Braille newtype Render Braille V2 n = R (RenderM n ())
type Result Braille V2 n Source #
Instance details Defined in Diagrams.Backend.Braille type Result Braille V2 n = String
type MainOpts [(String, QDiagram B V2 n Any)] Source #
Instance details Defined in Diagrams.Backend.Braille.CmdLine type MainOpts [(String, QDiagram B V2 n Any)] = (MainOpts (QDiagram B V2 n Any), DiagramMultiOpts)
type MainOpts (QDiagram B V2 n Any) Source #
Instance details Defined in Diagrams.Backend.Braille.CmdLine type MainOpts (QDiagram B V2 n Any) = DiagramOpts

type B = Braille Source #

Orphan instances

TypeableFloat n => Mainable [(String, QDiagram B V2 n Any)] Source #
Instance details Associated Types type MainOpts [(String, QDiagram B V2 n Any)] # Methods mainArgs :: Parseable (MainOpts [(String, QDiagram B V2 n Any)]) => proxy [(String, QDiagram B V2 n Any)] -> IO (MainOpts [(String, QDiagram B V2 n Any)]) # mainRender :: MainOpts [(String, QDiagram B V2 n Any)] -> [(String, QDiagram B V2 n Any)] -> IO () # mainWith :: [(String, QDiagram B V2 n Any)] -> IO () #
TypeableFloat n => Mainable (QDiagram B V2 n Any) Source #
Instance details Associated Types type MainOpts (QDiagram B V2 n Any) # Methods mainArgs :: Parseable (MainOpts (QDiagram B V2 n Any)) => proxy (QDiagram B V2 n Any) -> IO (MainOpts (QDiagram B V2 n Any)) # mainRender :: MainOpts (QDiagram B V2 n Any) -> QDiagram B V2 n Any -> IO () # mainWith :: QDiagram B V2 n Any -> IO () #

General form of main

Supported forms of main

Backend tokens

Instances

Orphan instances

General form of `main`

Supported forms of `main`