-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Postscript backend for diagrams drawing EDSL
--   
--   This package provides a modular backend for rendering diagrams created
--   with the diagrams EDSL using Postscript.
--   
--   <ul>
--   <li><a>Diagrams.Backend.Postscript.CmdLine</a> - Provides the
--   "mainWith" interface to render a diagram based on command line
--   options.</li>
--   <li><a>Diagrams.Backend.Postscript</a> - Provides the general API for
--   rendering diagrams using the Postscript backend.</li>
--   <li><a>Diagrams.Backend.CMYK</a> - Special support for CMYK color
--   attributes.</li>
--   </ul>
@package diagrams-postscript
@version 1.5


-- | Generic tools for generating Postscript files. There is some limited
--   support for tracking the state of the renderer when given a
--   side-effecting (in the Postscript) command. Only drawing operations
--   are supported, not general Postscript language generation.
--   
--   In the future the tracking of rendering state could lead to optimizing
--   output, but for now little optimization is attempted. Most systems are
--   equiped with tools to optimize Postscript such as <tt>eps2eps</tt>.
--   
--   For details on the PostScript language see the PostScript(R) Language
--   Reference:
--   <a>http://www.adobe.com/products/postscript/pdfs/PLRM.pdf</a>
module Graphics.Rendering.Postscript

-- | Type of the monad that tracks the state from side-effecting commands.
data Render m
data RenderState
drawState :: Lens' RenderState DrawState

-- | Abstraction of the drawing surface details.
data Surface

-- | Type for a monad that writes Postscript using the commands we will
--   define later.
--   
--   Type for a monad that writes Postscript using the commands we will
--   define later.
newtype PSWriter m
PSWriter :: State Builder m -> PSWriter m
[runPSWriter] :: PSWriter m -> State Builder m

-- | Handles opening and closing the file associated with the passed
--   <a>Surface</a> and renders the commands built up in the <a>Render</a>
--   argument.
renderWith :: MonadIO m => Surface -> Render a -> m a

-- | Renders multiple pages given as a list of <a>Render</a> actions to the
--   file associated with the <a>Surface</a> argument.
renderPagesWith :: MonadIO m => Surface -> [Render a] -> m [a]

-- | Pure variant of <a>renderWith</a>
renderBuilder :: Surface -> Render a -> (Builder, a)

-- | Pure variant of <a>renderPagesWith</a>
renderPagesBuilder :: Surface -> [Render a] -> (Builder, [a])

-- | Builds a surface and performs an action on that surface.
withEPSSurface :: String -> Int -> Int -> (Surface -> r) -> r

-- | Start a new path.
newPath :: Render ()

-- | Move the current point.
moveTo :: Double -> Double -> Render ()

-- | Add a line to the current path from the current point to the given
--   point. The current point is also moved with this command.
lineTo :: Double -> Double -> Render ()

-- | Add a cubic Bézier curve segment to the current path from the current
--   point. The current point is also moved with this command.
curveTo :: Double -> Double -> Double -> Double -> Double -> Double -> Render ()

-- | Add a line segment to the current path using relative coordinates.
relLineTo :: Double -> Double -> Render ()

-- | Add a cubic Bézier curve segment to the current path from the current
--   point using relative coordinates.
relCurveTo :: Double -> Double -> Double -> Double -> Double -> Double -> Render ()

-- | Draw an arc given a center, radius, start, and end angle.
arc :: Double -> Double -> Double -> Double -> Double -> Render ()

-- | Close the current path.
closePath :: Render ()

-- | Stroke the current path.
stroke :: Render ()
fill :: Render ()

-- | Fill the current path without affecting the graphics state.
fillPreserve :: Render ()

-- | Apply a transform matrix to the current transform.
transform :: Double -> Double -> Double -> Double -> Double -> Double -> Render ()

-- | Push the current state of the renderer onto the state stack.
save :: Render ()

-- | Replace the current state by popping the state stack.
restore :: Render ()

-- | Push the current graphics state.
gsave :: Render ()

-- | Pop the current graphics state.
grestore :: Render ()

-- | Push the current transform matrix onto the execution stack.
saveMatrix :: Render ()

-- | Set the current transform matrix to be the matrix found by popping the
--   execution stack.
restoreMatrix :: Render ()

-- | Translate the current transform matrix.
translate :: Double -> Double -> Render ()

-- | Scale the current transform matrix.
scale :: Double -> Double -> Render ()

-- | Rotate the current transform matrix.
rotate :: Double -> Render ()

-- | Set the color of the stroke. Ignore gradients.
strokeColor :: Texture n -> Render ()

-- | Set the color of the stroke.
strokeColorCMYK :: CMYK -> Render ()

-- | Set the color of the fill. Ignore gradients.
fillColor :: Texture n -> Render ()

-- | Set the color of the fill.
fillColorCMYK :: CMYK -> Render ()

-- | Set the line width.
lineWidth :: Double -> Render ()

-- | Set the line cap style.
lineCap :: LineCap -> Render ()

-- | Set the line join method.
lineJoin :: LineJoin -> Render ()

-- | Set the miter limit.
miterLimit :: Double -> Render ()

-- | Set the dash style.
setDash :: [Double] -> Double -> Render ()

-- | Draw a string at the current point.
showText :: String -> Render ()

-- | Draw a string by first measuring the width then offseting by half.
showTextCentered :: String -> Render ()

-- | Draw a string with offset factors from center relative to the width
--   and height.
showTextAlign :: Double -> Double -> String -> Render ()

-- | Draw a string uniformally scaling to fit within a bounding box.
showTextInBox :: (Double, Double) -> (Double, Double) -> String -> Render ()

-- | Clip with the current path.
clip :: Render ()
data FontSlant
FontSlantNormal :: FontSlant
FontSlantItalic :: FontSlant
FontSlantOblique :: FontSlant
FontSlant :: Double -> FontSlant
data FontWeight
FontWeightNormal :: FontWeight
FontWeightBold :: FontWeight
face :: Lens' PostscriptFont String
slant :: Lens' PostscriptFont FontSlant
weight :: Lens' PostscriptFont FontWeight
size :: Lens' PostscriptFont Double
isLocal :: Lens' PostscriptFont Bool
fillRule :: Lens' DrawState FillRule
font :: Lens' DrawState PostscriptFont
data CMYK
CMYK :: Double -> Double -> Double -> Double -> CMYK
[_cyan] :: CMYK -> Double
[_magenta] :: CMYK -> Double
[_yellow] :: CMYK -> Double
[_blacK] :: CMYK -> Double
cyan :: Lens' CMYK Double
magenta :: Lens' CMYK Double
yellow :: Lens' CMYK Double
blacK :: Lens' CMYK Double
instance Control.Monad.State.Class.MonadState Graphics.Rendering.Postscript.RenderState Graphics.Rendering.Postscript.Render
instance GHC.Base.Monad Graphics.Rendering.Postscript.Render
instance GHC.Base.Applicative Graphics.Rendering.Postscript.Render
instance GHC.Base.Functor Graphics.Rendering.Postscript.Render
instance Control.Monad.State.Class.MonadState Data.ByteString.Builder.Internal.Builder Graphics.Rendering.Postscript.PSWriter
instance GHC.Base.Monad Graphics.Rendering.Postscript.PSWriter
instance GHC.Base.Applicative Graphics.Rendering.Postscript.PSWriter
instance GHC.Base.Functor Graphics.Rendering.Postscript.PSWriter
instance GHC.Classes.Eq Graphics.Rendering.Postscript.DrawState
instance GHC.Show.Show Graphics.Rendering.Postscript.PostscriptFont
instance GHC.Classes.Eq Graphics.Rendering.Postscript.PostscriptFont
instance GHC.Classes.Eq Graphics.Rendering.Postscript.FontWeight
instance GHC.Show.Show Graphics.Rendering.Postscript.FontWeight
instance GHC.Classes.Eq Graphics.Rendering.Postscript.FontSlant
instance GHC.Show.Show Graphics.Rendering.Postscript.FontSlant
instance GHC.Classes.Eq Graphics.Rendering.Postscript.CMYK
instance GHC.Show.Show Graphics.Rendering.Postscript.CMYK


-- | Support for CMYK color attributes in the Postscript backend.
module Diagrams.Backend.Postscript.CMYK
data CMYK
CMYK :: Double -> Double -> Double -> Double -> CMYK
[_cyan] :: CMYK -> Double
[_magenta] :: CMYK -> Double
[_yellow] :: CMYK -> Double
[_blacK] :: CMYK -> Double

-- | The color with which lines (strokes) are drawn. Note that child colors
--   always override parent colors; that is, <tt><a>lineColorCMYK</a> c1 .
--   <a>lineColorCMYK</a> c2 $ d</tt> is equivalent to
--   <tt><a>lineColorCMYK</a> c2 $ d</tt>. More precisely, the semigroup
--   structure on line color attributes is that of <a>Last</a>.
data LineColorCMYK
getLineColorCMYK :: LineColorCMYK -> CMYK
mkLineColorCMYK :: CMYK -> LineColorCMYK
styleLineColorCMYK :: Setter' (Style v Double) CMYK

-- | Set the line (stroke) color.
lineColorCMYK :: HasStyle a => CMYK -> a -> a

-- | Apply a <a>lineColorCMYK</a> attribute.
lineColorCMYKA :: HasStyle a => LineColorCMYK -> a -> a

-- | A synonym for <a>lineColorCMYK</a>.
lcCMYK :: HasStyle a => CMYK -> a -> a

-- | The color with which shapes are filled. Note that child colors always
--   override parent colors; that is, <tt><a>fillColorCMYK</a> c1 .
--   <a>fillColorCMYK</a> c2 $ d</tt> is equivalent to
--   <tt><a>lineColorCMYK</a> c2 $ d</tt>. More precisely, the semigroup
--   structure on fill color attributes is that of <a>Last</a>.
data FillColorCMYK
getFillColorCMYK :: FillColorCMYK -> CMYK
mkFillColorCMYK :: CMYK -> FillColorCMYK
styleFillColorCMYK :: Setter' (Style v Double) CMYK

-- | Set a "recommended" fill color, to be used only if no explicit calls
--   to <tt>fillColor</tt> (or <tt>fc</tt>, or <tt>fcA</tt>) are used.
recommendFillColorCMYK :: HasStyle a => CMYK -> a -> a

-- | Set the fill color.
fillColorCMYK :: HasStyle a => CMYK -> a -> a

-- | A synonym for <a>fillColorCMYK</a>
fcCMYK :: HasStyle a => CMYK -> a -> a
instance GHC.Base.Semigroup Diagrams.Backend.Postscript.CMYK.FillColorCMYK
instance GHC.Base.Semigroup Diagrams.Backend.Postscript.CMYK.LineColorCMYK
instance Diagrams.Core.Style.AttributeClass Diagrams.Backend.Postscript.CMYK.FillColorCMYK
instance Data.Default.Class.Default Diagrams.Backend.Postscript.CMYK.FillColorCMYK
instance Diagrams.Core.Style.AttributeClass Diagrams.Backend.Postscript.CMYK.LineColorCMYK
instance Data.Default.Class.Default Diagrams.Backend.Postscript.CMYK.LineColorCMYK


-- | A Postscript rendering backend for diagrams.
--   
--   To build diagrams for Postscript rendering use the <tt>Postscript</tt>
--   type in the diagram type construction
--   
--   <pre>
--   d :: Diagram Postscript
--   d = ...
--   </pre>
--   
--   and render giving the <tt>Postscript</tt> token
--   
--   <pre>
--   renderDia Postscript (PostscriptOptions "file.eps" (Width 400) EPS) d
--   </pre>
--   
--   This IO action will write the specified file.
module Diagrams.Backend.Postscript

-- | This data declaration is simply used as a token to distinguish this
--   rendering engine.
data Postscript
Postscript :: Postscript
type B = Postscript

-- | Backend-specific rendering options.
data family Options b (v :: Type -> Type) n :: Type
psfileName :: Lens' (Options Postscript V2 Double) String
psSizeSpec :: Lens' (Options Postscript V2 Double) (SizeSpec V2 Double)
psOutputFormat :: Lens' (Options Postscript V2 Double) OutputFormat

-- | Postscript only supports EPS style output at the moment. Future
--   formats would each have their own associated properties that affect
--   the output.
data OutputFormat

-- | Encapsulated Postscript output.
EPS :: OutputFormat
renderDias :: (Semigroup m, Monoid m) => Options Postscript V2 Double -> [QDiagram Postscript V2 Double m] -> IO [()]
instance GHC.Show.Show (Diagrams.Core.Types.Options Diagrams.Backend.Postscript.Postscript Linear.V2.V2 GHC.Types.Double)
instance Diagrams.Core.Types.Backend Diagrams.Backend.Postscript.Postscript Linear.V2.V2 GHC.Types.Double
instance Data.Default.Class.Default Diagrams.Backend.Postscript.PostscriptState
instance GHC.Base.Semigroup (Diagrams.Core.Types.Render Diagrams.Backend.Postscript.Postscript Linear.V2.V2 GHC.Types.Double)
instance GHC.Base.Monoid (Diagrams.Core.Types.Render Diagrams.Backend.Postscript.Postscript Linear.V2.V2 GHC.Types.Double)
instance Data.Hashable.Class.Hashable (Diagrams.Core.Types.Options Diagrams.Backend.Postscript.Postscript Linear.V2.V2 GHC.Types.Double)
instance Diagrams.Core.Types.Renderable (Diagrams.Segment.Segment Diagrams.Segment.Closed Linear.V2.V2 GHC.Types.Double) Diagrams.Backend.Postscript.Postscript
instance Diagrams.Core.Types.Renderable (Diagrams.Trail.Trail Linear.V2.V2 GHC.Types.Double) Diagrams.Backend.Postscript.Postscript
instance Diagrams.Core.Types.Renderable (Diagrams.Path.Path Linear.V2.V2 GHC.Types.Double) Diagrams.Backend.Postscript.Postscript
instance Diagrams.Core.Types.Renderable (Diagrams.TwoD.Text.Text GHC.Types.Double) Diagrams.Backend.Postscript.Postscript
instance GHC.Generics.Generic Diagrams.Backend.Postscript.OutputFormat
instance GHC.Enum.Bounded Diagrams.Backend.Postscript.OutputFormat
instance GHC.Enum.Enum Diagrams.Backend.Postscript.OutputFormat
instance GHC.Show.Show Diagrams.Backend.Postscript.OutputFormat
instance GHC.Read.Read Diagrams.Backend.Postscript.OutputFormat
instance GHC.Classes.Ord Diagrams.Backend.Postscript.OutputFormat
instance GHC.Classes.Eq Diagrams.Backend.Postscript.OutputFormat
instance GHC.Show.Show Diagrams.Backend.Postscript.Postscript
instance GHC.Read.Read Diagrams.Backend.Postscript.Postscript
instance GHC.Classes.Ord Diagrams.Backend.Postscript.Postscript
instance GHC.Classes.Eq Diagrams.Backend.Postscript.Postscript
instance Data.Hashable.Class.Hashable Diagrams.Backend.Postscript.OutputFormat


-- | Convenient creation of command-line-driven executables for rendering
--   diagrams using the Postscript backend.
--   
--   <ul>
--   <li><a>defaultMain</a> creates an executable which can render a single
--   diagram at various options.</li>
--   <li><a>multiMain</a> is like <a>defaultMain</a> but allows for a list
--   of diagrams from which the user can choose one to render.</li>
--   <li><a>pagesMain</a> is like <a>defaultMain</a> but renders a list of
--   diagrams as pages in a single file.</li>
--   <li><a>animMain</a> renders an animation at a given frame rate into
--   separate files with an index number.</li>
--   <li><a>mainWith</a> is a generic form that does all of the above but
--   with a slightly scarier type. See <a>Diagrams.Backend.CmdLine</a>.
--   This form can also take a function type that has a subtable final
--   result (any of arguments to the above types) and <a>Parseable</a>
--   arguments.</li>
--   </ul>
--   
--   If you want to generate diagrams programmatically---<i>i.e.</i> if you
--   want to do anything more complex than what the below functions
--   provide---you have several options.
--   
--   <ul>
--   <li>Use a function with <a>mainWith</a>. This may require making
--   <a>Parseable</a> instances for custom argument types.</li>
--   <li>Make a new <a>Mainable</a> 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.</li>
--   <li>Build option records and pass them along with a diagram to
--   <a>mainRender</a> from <a>Diagrams.Backend.CmdLine</a>.</li>
--   <li>An even more flexible approach is to directly call
--   <a>renderDia</a>; see <a>Diagrams.Backend.Postscript</a> for more
--   information.</li>
--   </ul>
--   
--   For a tutorial on command-line diagram creation see
--   <a>http://projects.haskell.org/diagrams/doc/cmdline.html</a>.
module Diagrams.Backend.Postscript.CmdLine

-- | Main entry point for command-line diagram creation. This is the method
--   that users will call from their program <tt>main</tt>. For instance an
--   expected user program would take the following form.
--   
--   <pre>
--   import Diagrams.Prelude
--   import Diagrams.Backend.TheBestBackend.CmdLine
--   
--   d :: Diagram B R2
--   d = ...
--   
--   main = mainWith d
--   </pre>
--   
--   Most backends should be able to use the default implementation. A
--   different implementation should be used to handle more complex
--   interactions with the user.
mainWith :: Mainable d => d -> IO ()
defaultMain :: QDiagram Postscript V2 Double Any -> IO ()
multiMain :: [(String, QDiagram Postscript V2 Double Any)] -> IO ()
pagesMain :: [QDiagram Postscript V2 Double Any] -> IO ()

-- | <tt>animMain</tt> is like <a>defaultMain</a>, 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 <tt>foo/blah.eps</tt>, the frames will be saved in
--   <tt>foo/blah001.eps</tt>, <tt>foo/blah002.eps</tt>, 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, <i>e.g.</i> <tt>ffmpeg</tt>).
--   
--   Of course, this is a rather crude method of rendering animations; more
--   sophisticated methods will likely be added in the future.
--   
--   The <tt>--fpu</tt> option can be used to control how many frames will
--   be output for each second (unit time) of animation.
animMain :: Animation Postscript V2 Double -> IO ()

-- | This data declaration is simply used as a token to distinguish this
--   rendering engine.
data Postscript
type B = Postscript
instance Diagrams.Backend.CmdLine.Mainable (Diagrams.Core.Types.QDiagram Diagrams.Backend.Postscript.Postscript Linear.V2.V2 GHC.Types.Double Data.Semigroup.Internal.Any)
instance Diagrams.Backend.CmdLine.Mainable [(GHC.Base.String, Diagrams.Core.Types.QDiagram Diagrams.Backend.Postscript.Postscript Linear.V2.V2 GHC.Types.Double Data.Semigroup.Internal.Any)]
instance Diagrams.Backend.CmdLine.Mainable [Diagrams.Core.Types.QDiagram Diagrams.Backend.Postscript.Postscript Linear.V2.V2 GHC.Types.Double Data.Semigroup.Internal.Any]
instance Diagrams.Backend.CmdLine.Mainable (Diagrams.Animation.Animation Diagrams.Backend.Postscript.Postscript Linear.V2.V2 GHC.Types.Double)