diagrams-pgf-1.4.2.1: PGF backend for diagrams drawing EDSL.
Copyright(c) 2015 Christopher Chalmers
LicenseBSD-style (see LICENSE)
Maintainerdiagrams-discuss@googlegroups.com
Safe HaskellSafe-Inferred
LanguageHaskell2010

Diagrams.Backend.PGF

Description

A full-featured PGF backend for diagrams producing PGF code suitable for LaTeX, ConTeXt or plain TeX consumption.

To invoke the PGF backend, you have a number of options.

The Surface provides the necessary information for rendering PGF code and building a PDF using "texrunner". See Surface for more info.

Synopsis

Rendering token & options

data PGF Source #

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

Constructors

PGF 

Instances

Instances details
Show PGF Source # 
Instance details

Defined in Diagrams.Backend.PGF.Render

Methods

showsPrec :: Int -> PGF -> ShowS #

show :: PGF -> String #

showList :: [PGF] -> ShowS #

TypeableFloat n => Backend PGF V2 n Source # 
Instance details

Defined in Diagrams.Backend.PGF.Render

Associated Types

data Render PGF V2 n #

type Result PGF V2 n #

data Options PGF V2 n #

TypeableFloat n => Mainable (OnlineTex (QDiagram PGF V2 n Any)) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

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

TypeableFloat n => Mainable [(String, QDiagram PGF V2 n Any)] Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

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

TypeableFloat n => Renderable (Text n) PGF Source #

Does not support full alignment. Text is not escaped.

Instance details

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 Source # 
Instance details

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) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

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

TypeableFloat n => Mainable (Surface, OnlineTex (QDiagram PGF V2 n Any)) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

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

TypeableFloat n => Renderable (Path V2 n) PGF Source # 
Instance details

Defined in Diagrams.Backend.PGF.Render

Methods

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

RealFloat n => Renderable (DImage n Embedded) PGF Source #

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

Instance details

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 Source #

Supported: .pdf, .jpg, .png.

Instance details

Defined in Diagrams.Backend.PGF.Render

Methods

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

Monoid (Render PGF V2 n) Source # 
Instance details

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 #

Semigroup (Render PGF V2 n) Source # 
Instance details

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 #

Fractional n => Default (Options PGF V2 n) Source # 
Instance details

Defined in Diagrams.Backend.PGF.Render

Methods

def :: Options PGF V2 n #

Eq n => Eq (Options PGF V2 n) Source # 
Instance details

Defined in Diagrams.Backend.PGF.Render

Methods

(==) :: Options PGF V2 n -> Options PGF V2 n -> Bool #

(/=) :: Options PGF V2 n -> Options PGF V2 n -> Bool #

Hashable n => Hashable (Options PGF V2 n) Source # 
Instance details

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) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

type MainOpts (QDiagram PGF V2 n Any) #

type N PGF Source # 
Instance details

Defined in Diagrams.Backend.PGF.Render

type N PGF = Double
type V PGF Source # 
Instance details

Defined in Diagrams.Backend.PGF.Render

type V PGF = V2
data Options PGF V2 n Source # 
Instance details

Defined in Diagrams.Backend.PGF.Render

newtype Render PGF V2 n Source # 
Instance details

Defined in Diagrams.Backend.PGF.Render

newtype Render PGF V2 n = R (Render n)
type Result PGF V2 n Source # 
Instance details

Defined in Diagrams.Backend.PGF.Render

type Result PGF V2 n = Builder
type MainOpts (OnlineTex (QDiagram PGF V2 n Any)) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

type MainOpts [(String, QDiagram PGF V2 n Any)] Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

type MainOpts (Surface, QDiagram PGF V2 n Any) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

type MainOpts (Surface, OnlineTex (QDiagram PGF V2 n Any)) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

type MainOpts (QDiagram PGF V2 n Any) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

type B = PGF Source #

Rendering functions

renderPGF Source #

Arguments

:: (TypeableFloat n, Monoid' m) 
=> FilePath

path to output

-> SizeSpec V2 n

size of output

-> QDiagram PGF V2 n m

Diagram to render

-> IO () 

Render a pgf diagram and write it to the given filepath. Same as renderPGF' but uses the default options.

renderPGF' :: (TypeableFloat n, Monoid' m) => FilePath -> Options PGF V2 n -> QDiagram PGF V2 n m -> IO () Source #

Render a pgf diagram and write it to the given filepath. If the file has the extension .pdf, a PDF is generated in a temporary directory using options from the given surface, otherwise, the tex output is saved using the surface's TexFormat.

renderPGFSurf Source #

Arguments

:: (TypeableFloat n, Monoid' m) 
=> FilePath

path to output

-> SizeSpec V2 n

size of output

-> Surface

surface to render with

-> QDiagram PGF V2 n m

diagram to render

-> IO () 

Render a pgf diagram and write it to the given filepath. Same as renderPGF but takes a Surface.

Options

Options for changing how the diagram is rendered. Options PGF is an instance of Default:

def = PGFOptions {
  _surface    = latexSurface
  _sizeSpec   = absolute
  _readable   = True
  _standalone = False
  }

You can edit the default options using lenses.

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

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

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

Lens onto the SizeSpec2D.

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

Lens onto the surface used to render.

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

Lens onto whether a standalone TeX document should be produced.

Surfaces

These surfaces should be suitable for basic diagrams. For more complicated options see Surface.

data Surface Source #

Instances

Instances details
Default Surface Source #

Latex is the default surface.

Instance details

Defined in Diagrams.Backend.PGF.Surface

Methods

def :: Surface #

Eq Surface Source # 
Instance details

Defined in Diagrams.Backend.PGF.Surface

Methods

(==) :: Surface -> Surface -> Bool #

(/=) :: Surface -> Surface -> Bool #

Hashable Surface Source # 
Instance details

Defined in Diagrams.Backend.PGF.Surface

Methods

hashWithSalt :: Int -> Surface -> Int #

hash :: Surface -> Int #

TypeableFloat n => Mainable (Surface, QDiagram PGF V2 n Any) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

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

TypeableFloat n => Mainable (Surface, OnlineTex (QDiagram PGF V2 n Any)) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

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

type MainOpts (Surface, QDiagram PGF V2 n Any) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

type MainOpts (Surface, OnlineTex (QDiagram PGF V2 n Any)) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

surfOnlineTex :: Surface -> OnlineTex a -> a Source #

Get the result of an OnlineTex using the given surface.

Predefined surfaces

latexSurface :: Surface Source #

Default surface for latex files by calling pdflatex.

Sample output

Expand
command: pdflatex

% preamble
documentclass{article}
usepackage{pgfcore}
pagenumbering{gobble}

% pageSize
pdfpagewidth=100bp
pdfpageheight=80bp
textheight=80bp
pdfhorigin=-76.6bp
pdfvorigin=-52.8bp

% beginDoc
begin{document}

<Latex pgf code>

% endDoc
end{document}

contextSurface :: Surface Source #

Default surface for latex files by calling pdflatex.

Sample output

Expand
command: context --pipe --once

% preamble
usemodule[pgf]
setuppagenumbering[location=]

% pageSize
definepapersize[diagram][width=100bp,height=80bp]
setuppapersize[diagram][diagram]
setuplayout
  [ topspace=0bp
  , backspace=0bp
  , header=0bp
  , footer=0bp
  , width=100bp
  , height=80bp
  ]

% beginDoc
starttext

<Context pgf code>

% endDoc
stoptext

plaintexSurface :: Surface Source #

Default surface for latex files by calling pdflatex.

Sample output

Expand
command: pdftex

% preamble
input eplain
beginpackages
usepackage{color}
endpackages
input pgfcore
deffrac2{{begingroup #1endgroupover #2}}nopagenumbers

% pageSize
pdfpagewidth=100bp
pdfpageheight=80bp
pdfhorigin=-20bp
pdfvorigin=0bp

% beginDoc


pgf code

% endDoc
bye

Lenses

command :: Lens' Surface String Source #

System command to call for rendering PDFs for OnlineTex.

arguments :: Lens' Surface [String] Source #

List of arguments for the command.

preamble :: Lens' Surface String Source #

Preamble for the tex document. This should at least import pgfcore.

Online TeX

By using OnlineTex, diagrams is able to query tex for sizes of hboxs and give them the corresponding envelopes. These can then be used as any other diagram with the correct size.

Online diagrams use the Surface to run tex in online mode and get feedback for hbox sizes. To run it you can use renderOnlinePGF, renderOnlinePGF' or onlineMain from CmdLine.

See https://github.com/diagrams/diagrams-pgf/tree/master/examples for examples.

data OnlineTex a #

Type for dealing with Tex's piping interface; the current streams are available though the MonadReader instance.

Instances

Instances details
MonadIO OnlineTex 
Instance details

Defined in System.Texrunner.Online

Methods

liftIO :: IO a -> OnlineTex a #

Applicative OnlineTex 
Instance details

Defined in System.Texrunner.Online

Methods

pure :: a -> OnlineTex a #

(<*>) :: OnlineTex (a -> b) -> OnlineTex a -> OnlineTex b #

liftA2 :: (a -> b -> c) -> OnlineTex a -> OnlineTex b -> OnlineTex c #

(*>) :: OnlineTex a -> OnlineTex b -> OnlineTex b #

(<*) :: OnlineTex a -> OnlineTex b -> OnlineTex a #

Functor OnlineTex 
Instance details

Defined in System.Texrunner.Online

Methods

fmap :: (a -> b) -> OnlineTex a -> OnlineTex b #

(<$) :: a -> OnlineTex b -> OnlineTex a #

Monad OnlineTex 
Instance details

Defined in System.Texrunner.Online

Methods

(>>=) :: OnlineTex a -> (a -> OnlineTex b) -> OnlineTex b #

(>>) :: OnlineTex a -> OnlineTex b -> OnlineTex b #

return :: a -> OnlineTex a #

MonadReader TexStreams OnlineTex 
Instance details

Defined in System.Texrunner.Online

TypeableFloat n => Mainable (OnlineTex (QDiagram PGF V2 n Any)) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

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

ToResult d => ToResult (OnlineTex d) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

type Args (OnlineTex d) #

type ResultOf (OnlineTex d) #

Methods

toResult :: OnlineTex d -> Args (OnlineTex d) -> ResultOf (OnlineTex d) #

TypeableFloat n => Mainable (Surface, OnlineTex (QDiagram PGF V2 n Any)) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

Associated Types

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

type Args (OnlineTex d) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

type Args (OnlineTex d) = (Surface, Args d)
type MainOpts (OnlineTex (QDiagram PGF V2 n Any)) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

type ResultOf (OnlineTex d) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

type ResultOf (OnlineTex d) = IO (ResultOf d)
type MainOpts (Surface, OnlineTex (QDiagram PGF V2 n Any)) Source # 
Instance details

Defined in Diagrams.Backend.PGF.CmdLine

renderOnlinePGF :: (TypeableFloat n, Monoid' m) => FilePath -> SizeSpec V2 n -> OnlineTex (QDiagram PGF V2 n m) -> IO () Source #

Render an online PGF diagram and save it. Same as renderOnlinePGF' using default options.

renderOnlinePGF' :: (TypeableFloat n, Monoid' m) => FilePath -> Options PGF V2 n -> OnlineTex (QDiagram PGF V2 n m) -> IO () Source #

Same as renderOnlinePDF but takes Options PGF.

Hbox

data Hbox n Source #

Primitive for placing raw Tex commands in a hbox.

Instances

Instances details
Fractional n => Transformable (Hbox n) Source # 
Instance details

Defined in Diagrams.Backend.PGF.Hbox

Methods

transform :: Transformation (V (Hbox n)) (N (Hbox n)) -> Hbox n -> Hbox n #

Fractional n => Renderable (Hbox n) NullBackend Source # 
Instance details

Defined in Diagrams.Backend.PGF.Hbox

Methods

render :: NullBackend -> Hbox n -> Render NullBackend (V (Hbox n)) (N (Hbox n)) #

TypeableFloat n => Renderable (Hbox n) PGF Source # 
Instance details

Defined in Diagrams.Backend.PGF.Render

Methods

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

type N (Hbox n) Source # 
Instance details

Defined in Diagrams.Backend.PGF.Hbox

type N (Hbox n) = n
type V (Hbox n) Source # 
Instance details

Defined in Diagrams.Backend.PGF.Hbox

type V (Hbox n) = V2

hboxOnline :: (TypeableFloat n, Renderable (Hbox n) b) => String -> OnlineTex (QDiagram b V2 n Any) Source #

Hbox with bounding box envelope.

hboxPoint :: (OrderedField n, Typeable n, Renderable (Hbox n) b) => String -> QDiagram b V2 n Any Source #

Raw Tex commands in a hbox with no envelope. Transformations are applied normally. This primitive ignores FontSize.

hboxSurf :: (TypeableFloat n, Renderable (Hbox n) b) => Surface -> String -> QDiagram b V2 n Any Source #

Hbox with bounding box envelope. Note that each box requires a call to Tex. For multiple boxes consider using hboxOnline to get multiple boxes from a single call. (uses unsafePerformIO)