Diagrams.Backend.PGF.Render

This is an internal module exposing internals for rendering a diagram. This is for advanced use only. PGF has enough for general use.

Documentation

data PGF

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

Constructors

PGF

Instances

Show PGF

Defined in Diagrams.Backend.PGF.Render

Methods

showsPrec :: Int -> PGF -> ShowS

show :: PGF -> String

showList :: [PGF] -> ShowS

TypeableFloat n => Backend PGF V2 n

Defined in Diagrams.Backend.PGF.Render

Associated Types

data Render PGF V2 n :: Type

type Result PGF V2 n :: Type

data Options PGF V2 n :: Type

Methods

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

renderRTree :: PGF -> Options PGF V2 n -> RTree PGF V2 n Annotation -> Result PGF V2 n

TypeableFloat n => Mainable [(String, QDiagram PGF V2 n Any)]

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

type MainOpts [(String, QDiagram PGF V2 n Any)] :: Type

Methods

mainArgs :: Parseable (MainOpts [(String, QDiagram PGF V2 n Any)]) => proxy [(String, QDiagram PGF V2 n Any)] -> IO (MainOpts [(String, QDiagram PGF V2 n Any)])

mainRender :: MainOpts [(String, QDiagram PGF V2 n Any)] -> [(String, QDiagram PGF V2 n Any)] -> IO ()

mainWith :: [(String, QDiagram PGF V2 n Any)] -> IO ()

TypeableFloat n => Mainable (OnlineTex (QDiagram PGF V2 n Any))

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

type MainOpts (OnlineTex (QDiagram PGF V2 n Any)) :: Type

Methods

mainArgs :: Parseable (MainOpts (OnlineTex (QDiagram PGF V2 n Any))) => proxy (OnlineTex (QDiagram PGF V2 n Any)) -> IO (MainOpts (OnlineTex (QDiagram PGF V2 n Any)))

mainRender :: MainOpts (OnlineTex (QDiagram PGF V2 n Any)) -> OnlineTex (QDiagram PGF V2 n Any) -> IO ()

mainWith :: OnlineTex (QDiagram PGF V2 n Any) -> IO ()

TypeableFloat n => Renderable (Text n) PGF

Does not support full alignment. Text is not escaped.

Defined in Diagrams.Backend.PGF.Render

Methods

render :: PGF -> Text n -> Render PGF (V (Text n)) (N (Text n))

TypeableFloat n => Renderable (Hbox n) PGF

Defined in Diagrams.Backend.PGF.Render

Methods

render :: PGF -> Hbox n -> Render PGF (V (Hbox n)) (N (Hbox n))

TypeableFloat n => Mainable (Surface, QDiagram PGF V2 n Any)

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

type MainOpts (Surface, QDiagram PGF V2 n Any) :: Type

Methods

mainArgs :: Parseable (MainOpts (Surface, QDiagram PGF V2 n Any)) => proxy (Surface, QDiagram PGF V2 n Any) -> IO (MainOpts (Surface, QDiagram PGF V2 n Any))

mainRender :: MainOpts (Surface, QDiagram PGF V2 n Any) -> (Surface, QDiagram PGF V2 n Any) -> IO ()

mainWith :: (Surface, QDiagram PGF V2 n Any) -> IO ()

TypeableFloat n => Mainable (Surface, OnlineTex (QDiagram PGF V2 n Any))

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

type MainOpts (Surface, OnlineTex (QDiagram PGF V2 n Any)) :: Type

Methods

mainArgs :: Parseable (MainOpts (Surface, OnlineTex (QDiagram PGF V2 n Any))) => proxy (Surface, OnlineTex (QDiagram PGF V2 n Any)) -> IO (MainOpts (Surface, OnlineTex (QDiagram PGF V2 n Any)))

mainRender :: MainOpts (Surface, OnlineTex (QDiagram PGF V2 n Any)) -> (Surface, OnlineTex (QDiagram PGF V2 n Any)) -> IO ()

mainWith :: (Surface, OnlineTex (QDiagram PGF V2 n Any)) -> IO ()

RealFloat n => Renderable (DImage n Embedded) PGF

Supported: ImageRGB8. (Other types from DynamicImage will error)

Defined in Diagrams.Backend.PGF.Render

Methods

render :: PGF -> DImage n Embedded -> Render PGF (V (DImage n Embedded)) (N (DImage n Embedded))

RealFloat n => Renderable (DImage n External) PGF

Supported: .pdf, .jpg, .png.

Defined in Diagrams.Backend.PGF.Render

Methods

render :: PGF -> DImage n External -> Render PGF (V (DImage n External)) (N (DImage n External))

TypeableFloat n => Renderable (Path V2 n) PGF

Defined in Diagrams.Backend.PGF.Render

Methods

render :: PGF -> Path V2 n -> Render PGF (V (Path V2 n)) (N (Path V2 n))

Semigroup (Render PGF V2 n)

Defined in Diagrams.Backend.PGF.Render

Methods

(<>) :: Render PGF V2 n -> Render PGF V2 n -> Render PGF V2 n

sconcat :: NonEmpty (Render PGF V2 n) -> Render PGF V2 n

stimes :: Integral b => b -> Render PGF V2 n -> Render PGF V2 n

Monoid (Render PGF V2 n)

Defined in Diagrams.Backend.PGF.Render

Methods

mempty :: Render PGF V2 n

mappend :: Render PGF V2 n -> Render PGF V2 n -> Render PGF V2 n

mconcat :: [Render PGF V2 n] -> Render PGF V2 n

Fractional n => Default (Options PGF V2 n)

Defined in Diagrams.Backend.PGF.Render

Methods

def :: Options PGF V2 n

Hashable n => Hashable (Options PGF V2 n)

Defined in Diagrams.Backend.PGF.Render

Methods

hashWithSalt :: Int -> Options PGF V2 n -> Int

hash :: Options PGF V2 n -> Int

TypeableFloat n => Mainable (QDiagram PGF V2 n Any)

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

type MainOpts (QDiagram PGF V2 n Any) :: Type

Methods

mainArgs :: Parseable (MainOpts (QDiagram PGF V2 n Any)) => proxy (QDiagram PGF V2 n Any) -> IO (MainOpts (QDiagram PGF V2 n Any))

mainRender :: MainOpts (QDiagram PGF V2 n Any) -> QDiagram PGF V2 n Any -> IO ()

mainWith :: QDiagram PGF V2 n Any -> IO ()

type V PGF

Defined in Diagrams.Backend.PGF.Render

type V PGF = V2

type N PGF

Defined in Diagrams.Backend.PGF.Render

type N PGF = Double

data Options PGF V2 n

Defined in Diagrams.Backend.PGF.Render

data Options PGF V2 n = PGFOptions {

• _surface :: Surface
• _sizeSpec :: SizeSpec V2 n
• _readable :: Bool
• _standalone :: Bool

}

newtype Render PGF V2 n

Defined in Diagrams.Backend.PGF.Render

newtype Render PGF V2 n = R (Render n)

type Result PGF V2 n

Defined in Diagrams.Backend.PGF.Render

type Result PGF V2 n = Builder

type MainOpts [(String, QDiagram PGF V2 n Any)]

Defined in Diagrams.Backend.PGF.CmdLine

type MainOpts [(String, QDiagram PGF V2 n Any)] = (MainOpts (QDiagram PGF V2 n Any), DiagramMultiOpts)

type MainOpts (OnlineTex (QDiagram PGF V2 n Any))

Defined in Diagrams.Backend.PGF.CmdLine

type MainOpts (OnlineTex (QDiagram PGF V2 n Any))

type MainOpts (Surface, QDiagram PGF V2 n Any)

Defined in Diagrams.Backend.PGF.CmdLine

type MainOpts (Surface, QDiagram PGF V2 n Any)

type MainOpts (Surface, OnlineTex (QDiagram PGF V2 n Any))

Defined in Diagrams.Backend.PGF.CmdLine

type MainOpts (Surface, OnlineTex (QDiagram PGF V2 n Any))

type MainOpts (QDiagram PGF V2 n Any)

Defined in Diagrams.Backend.PGF.CmdLine

type MainOpts (QDiagram PGF V2 n Any)

data family Options b (v :: Type -> Type) n :: Type

Backend-specific rendering options.

Instances

Fractional n => Default (Options PGF V2 n)

Defined in Diagrams.Backend.PGF.Render

Methods

def :: Options PGF V2 n

Hashable n => Hashable (Options PGF V2 n)

Defined in Diagrams.Backend.PGF.Render

Methods

hashWithSalt :: Int -> Options PGF V2 n -> Int

hash :: Options PGF V2 n -> Int

data Options NullBackend v n

Defined in Diagrams.Core.Types

data Options NullBackend v n

data Options PGF V2 n

Defined in Diagrams.Backend.PGF.Render

data Options PGF V2 n = PGFOptions {

• _surface :: Surface
• _sizeSpec :: SizeSpec V2 n
• _readable :: Bool
• _standalone :: Bool

}

data family Render b (v :: Type -> Type) n :: Type

An intermediate representation used for rendering primitives. (Typically, this will be some sort of monad, but it need not be.) The Renderable class guarantees that a backend will be able to convert primitives into this type; how these rendered primitives are combined into an ultimate Result is completely up to the backend.

Instances

Semigroup (Render NullBackend v n)

Defined in Diagrams.Core.Types

Methods

(<>) :: Render NullBackend v n -> Render NullBackend v n -> Render NullBackend v n

sconcat :: NonEmpty (Render NullBackend v n) -> Render NullBackend v n

stimes :: Integral b => b -> Render NullBackend v n -> Render NullBackend v n

Semigroup (Render PGF V2 n)

Defined in Diagrams.Backend.PGF.Render

Methods

(<>) :: Render PGF V2 n -> Render PGF V2 n -> Render PGF V2 n

sconcat :: NonEmpty (Render PGF V2 n) -> Render PGF V2 n

stimes :: Integral b => b -> Render PGF V2 n -> Render PGF V2 n

Monoid (Render NullBackend v n)

Defined in Diagrams.Core.Types

Methods

mempty :: Render NullBackend v n

mappend :: Render NullBackend v n -> Render NullBackend v n -> Render NullBackend v n

mconcat :: [Render NullBackend v n] -> Render NullBackend v n

Monoid (Render PGF V2 n)

Defined in Diagrams.Backend.PGF.Render

Methods

mempty :: Render PGF V2 n

mappend :: Render PGF V2 n -> Render PGF V2 n -> Render PGF V2 n

mconcat :: [Render PGF V2 n] -> Render PGF V2 n

data Render NullBackend v n

Defined in Diagrams.Core.Types

data Render NullBackend v n = NullBackendRender

newtype Render PGF V2 n

Defined in Diagrams.Backend.PGF.Render

newtype Render PGF V2 n = R (Render n)

Lenses

surface :: Lens' (Options PGF V2 n) Surface

Lens onto the surface used to render.

sizeSpec :: Lens' (Options PGF V2 n) (SizeSpec V2 n)

Lens onto the SizeSpec2D.

readable :: Lens' (Options PGF V2 n) Bool

Lens onto whether the lines of the TeX output are indented.

standalone :: Lens' (Options PGF V2 n) Bool

Lens onto whether a standalone TeX document should be produced.

Utilities

escapeString :: String -> String

Escapes some common characters in a string. Note that this does not mean the string can't create an error; it merely escapes common characters.