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


-- | Haskell Postscript
--   
--   Haskell library partially implementing the postscript drawing model.
@package hps
@version 0.11


-- | Matrix type and functions.
module Graphics.PS.Matrix

-- | Synonym for <a>Double</a>.
type R = Double

-- | Transformation matrix data type.
data Matrix
Matrix :: R -> R -> R -> R -> R -> R -> Matrix

-- | The identity matrix.
identity :: Matrix

-- | A translation matrix with independent x and y offsets.
translation :: R -> R -> Matrix

-- | A scaling matrix with independent x and y scalars.
scaling :: R -> R -> Matrix

-- | A rotation matrix through the indicated angle (in radians).
rotation :: R -> Matrix
instance Eq Matrix
instance Show Matrix
instance Num Matrix


-- | Unit definitions and conversions.
module Graphics.PS.Unit

-- | Convert degrees to radians.
radians :: Floating a => a -> a

-- | Convert millimeters to PS points.
mm_pt :: Floating a => a -> a


-- | Paper sizes. For ISO sizes see
--   <a>http://www.cl.cam.ac.uk/~mgk25/iso-paper.html</a>.
module Graphics.PS.Paper

-- | Paper size data type.
data Paper
Paper :: Int -> Int -> Paper
width :: Paper -> Int
height :: Paper -> Int

-- | BoundingBox for an EPSF file with an optional HiResBoundingBox
data BBox
BBox :: Int -> Int -> Int -> Int -> BBox

-- | lower left x (x-min)
llx :: BBox -> Int

-- | lower left y (y-min)
lly :: BBox -> Int

-- | upper right x (x-max)
urx :: BBox -> Int

-- | upper right y (y-max)
ury :: BBox -> Int
HRBBox :: Int -> Int -> Int -> Int -> Double -> Double -> Double -> Double -> BBox

-- | lower left x (x-min)
llx :: BBox -> Int

-- | lower left y (y-min)
lly :: BBox -> Int

-- | upper right x (x-max)
urx :: BBox -> Int

-- | upper right y (y-max)
ury :: BBox -> Int

-- | high resolution <a>llx</a>
hrllx :: BBox -> Double

-- | high resolution <a>lly</a>
hrlly :: BBox -> Double

-- | high resolution <a>urx</a>
hrurx :: BBox -> Double

-- | high resolution <a>ury</a>
hrury :: BBox -> Double

-- | Swap width and height of <a>Paper</a>.
landscape :: Paper -> Paper

-- | A <a>div</a> variant that rounds rather than truncates.
--   
--   <pre>
--   let f (Paper _ h) = h `div` 2 == h `divRound` 2
--   in all id (map f [b0,b1,b2,b3,b4,b5,b6,b7,b8,b9]) == False
--   </pre>
divRound :: Int -> Int -> Int

-- | ISO size downscaling, ie. from <tt>A0</tt> to <tt>A1</tt>.
--   
--   <pre>
--   iso_down_scale a4 == a5
--   </pre>
iso_down_scale :: Paper -> Paper

-- | ISO A sizes in millimeters.
--   
--   <pre>
--   a4 == Paper 210 297
--   </pre>
a0, a10, a9, a8, a7, a6, a5, a4, a3, a2, a1 :: Paper

-- | ISO B sizes in millimeters.
--   
--   <pre>
--   b4 == Paper 250 354
--   </pre>
b0, b10, b9, b8, b7, b6, b5, b4, b3, b2, b1 :: Paper

-- | ISO C sizes in millimeters.
--   
--   <pre>
--   c4 == Paper 229 324
--   </pre>
c0, c10, c9, c8, c7, c6, c5, c4, c3, c2, c1 :: Paper

-- | US Letter size in millimeters (ie <a>Paper</a> <tt>216 279</tt>).
usLetter :: Paper

-- | Newspaper sizes in millimeters. See
--   <a>http://www.papersizes.org/newspaper-sizes.htm</a>.
broadsheet, tabloid, berliner :: Paper

-- | Proportion of <a>Paper</a>.
--   
--   <pre>
--   proportion broadsheet == 1.25
--   map (round . (* 1e3) . proportion) [a0,b0,c0] == [1414,1414,1414]
--   map proportion [usLetter,berliner,tabloid]
--   </pre>
proportion :: Paper -> Double
instance Eq Paper
instance Show Paper
instance Eq BBox
instance Show BBox


-- | PS graphics state.
module Graphics.PS.GS

-- | Graphics state.
data GS
GS :: Color -> LineWidth -> LineCap -> LineJoin -> ([Int], Int) -> Double -> GS

-- | Line cap enumeration.
data LineCap
ButtCap :: LineCap
RoundCap :: LineCap
ProjectingSquareCap :: LineCap

-- | Line join enumeration.
data LineJoin
MiterJoin :: LineJoin
RoundJoin :: LineJoin
BevelJoin :: LineJoin

-- | Line width (real).
type LineWidth = Double

-- | Colour model.
data Color
RGB :: Double -> Double -> Double -> Color

-- | Default <a>GS</a> of indicated <a>Color</a>.
defaultGS :: Color -> GS

-- | Default <a>GS</a> of indicated shade of grey.
greyGS :: Double -> GS
instance Eq LineCap
instance Show LineCap
instance Enum LineCap
instance Eq LineJoin
instance Show LineJoin
instance Enum LineJoin
instance Eq Color
instance Show Color
instance Eq GS
instance Show GS


-- | Font type and functions.
module Graphics.PS.Font

-- | Font data type.
data Font
Font :: String -> Double -> Font
fontName :: Font -> String
fontSize :: Font -> Double
instance Eq Font
instance Show Font


-- | Glyph data type.
module Graphics.PS.Glyph

-- | Character data type.
type Glyph = Char


-- | Point type and associated functions.
module Graphics.PS.Pt

-- | Cartesian co-ordinate with real valued <i>x</i> and <i>y</i> fields.
data Pt
Pt :: Double -> Double -> Pt

-- | Convert from polar to rectangular co-ordinates.
polarToRectangular :: Pt -> Pt

-- | <a>Pt</a> at <i>x</i> and <i>y</i> minima of inputs.
ptMin :: Pt -> Pt -> Pt

-- | <a>Pt</a> at <i>x</i> and <i>y</i> maxima of inputs.
ptMax :: Pt -> Pt -> Pt

-- | <i>x</i> and <i>y</i> elements of a set of <a>Pt</a>s.
ptXYs :: [Pt] -> [Double]

-- | Origin, ie. (Pt 0 0).
origin :: Pt

-- | Apply a transformation matrix to a point.
ptTransform :: Matrix -> Pt -> Pt
instance Eq Pt
instance Show Pt
instance Ord Pt
instance Num Pt


-- | Bezier functions.
module Graphics.PS.Bezier

-- | Four-point bezier curve interpolation. The index <i>mu</i> is in the
--   range zero to one.
bezier4 :: Pt -> Pt -> Pt -> Pt -> Double -> Pt


-- | Path type and functions.
module Graphics.PS.Path

-- | Path data type,in cartesian space.
data Path
MoveTo :: Pt -> Path
LineTo :: Pt -> Path
CurveTo :: Pt -> Pt -> Pt -> Path
ClosePath :: Pt -> Path
Text :: Font -> [Glyph] -> Path
PTransform :: Matrix -> Path -> Path
Join :: Path -> Path -> Path

-- | Infix notation for <a>Join</a>.
(+++) :: Path -> Path -> Path

-- | Line segments though list of <a>Pt</a>.
line :: [Pt] -> Path

-- | Variant of <a>line</a> connecting the last <a>Pt</a> to the first.
polygon :: [Pt] -> Path

-- | Rectangle with lower left at <a>Pt</a> and of specified width and
--   height. Polygon is oredered anticlockwise from lower left.
rectangle :: Pt -> Double -> Double -> Path

-- | Arc given by a central point,a radius,and start and end angles.
arc :: Pt -> Double -> Double -> Double -> Path

-- | Negative arc.
arcNegative :: Pt -> Double -> Double -> Double -> Path

-- | Annular segment.
annular :: Pt -> Double -> Double -> Double -> Double -> Path

-- | Apply any transformations at path. The resulting path will not have
--   any <a>PTransform</a> nodes.
flatten :: Path -> Path

-- | Render each (p1,p2) as a distinct line.
renderLines :: [(Pt, Pt)] -> Path

-- | Collapse line sequences into a single line.
renderLines' :: [(Pt, Pt)] -> Path
instance Eq Path
instance Show Path


-- | Image type and functions.
module Graphics.PS.Image

-- | An image is a rendering of a graph of <a>Path</a>s.
data Image
Stroke :: GS -> Path -> Image
Fill :: GS -> Path -> Image
ITransform :: Matrix -> Image -> Image
Over :: Image -> Image -> Image
Empty :: Image

-- | Layer one <a>Image</a> over another.
over :: Image -> Image -> Image
instance Eq Image
instance Show Image


-- | <a>Path</a> statistics.
module Graphics.PS.Statistics

-- | Path statistics data type.
data Statistics
Statistics :: Integer -> Integer -> Integer -> Integer -> Integer -> Integer -> Statistics
nMoveTo :: Statistics -> Integer
nLineTo :: Statistics -> Integer
nCurveTo :: Statistics -> Integer
nClosePath :: Statistics -> Integer
nGlyph :: Statistics -> Integer
nTransform :: Statistics -> Integer

-- | Determine number of path components of each type.
pathStatistics :: Path -> Statistics


-- | Class and associated functions for <a>Matrix</a> transformations.
module Graphics.PS.Transform

-- | Values that can be transformed in relation to a <a>Matrix</a>.
class Transformable a

-- | Translation in <i>x</i> and <i>y</i>.
translate :: Transformable a => Double -> Double -> a -> a

-- | Scaling in <i>x</i> and <i>y</i>.
scale :: Transformable a => Double -> Double -> a -> a

-- | Rotation, in radians.
rotate :: Transformable a => Double -> a -> a
instance Transformable Pt
instance Transformable Path
instance Transformable Image


-- | <a>Path</a> query functions and related operations.
module Graphics.PS.Query

-- | Locate the starting point of the path, which must begin with a
--   <a>MoveTo</a> node.
startPt :: Path -> Maybe Pt

-- | Locate the end point of the path.
endPt :: Path -> Maybe Pt

-- | Ensure path begins with a <a>MoveTo</a> node.
mkValid :: Path -> Path

-- | Approximate curves as <i>n</i> straight line segments. That is replace
--   <a>CurveTo</a> nodes with <i>n</i> <a>LineTo</a> nodes calculated
--   using <a>bezier4</a>.
approx :: Double -> Path -> Path

-- | Append a <a>LineTo</a> the start point of <a>Path</a>.
close :: Path -> Path


-- | Postscript generator.
module Graphics.PS.PS

-- | Write a postscript file. The list of images are written one per page.
ps :: FilePath -> Paper -> [Image] -> IO ()

-- | Write an encapsulated postscript file. The single image is written.
eps :: String -> BBox -> Image -> IO ()

-- | Generate postscript data given <i>title</i>, page size, and a set of
--   page <tt>I.Images</tt>.
stringFromPS :: String -> Paper -> [Image] -> String
instance Monad m => Monoid (MonadMonoid m)


-- | Set of predefined <a>Path</a>s.
module Graphics.PS.Path.Graphs

-- | See
--   <a>ftp.scsh.net/pub/scsh/contrib/fps/doc/examples/fractal-sqr.html</a>
fractal_sqr_pt :: Pt -> Pt -> Int -> [(Pt, Pt)]

-- | <a>Path</a> of <a>fractal_sqr_pt</a> with inputs <tt>(250,250)</tt>,
--   <tt>(175,175)</tt>, <tt>12</tt>.
fractal_sqr :: Path

-- | <a>renderLines'</a> variant of <a>fractal_sqr</a>.
fractal_sqr' :: Path

-- | A <i>unit</i> arrow.
unitArrow :: Int -> Path

-- | See
--   <a>ftp.scsh.net/pub/scsh/contrib/fps/doc/examples/fractal-arrow.html</a>
fractalArrow :: Double -> Int -> Path

-- | Isosceles right angled triangle
erat :: Pt -> Double -> Path

-- | Sierpinski triangle.
sierpinski :: Pt -> Double -> Double -> Path


-- | Top-level module for <tt>hps</tt>.
module Graphics.PS