Data.Geometry.Ipe.Reader

Reading ipe Files

readRawIpeFile :: Coordinate r => FilePath -> IO (Either ConversionError (IpeFile r))

Given a file path, tries to read an ipe file

readIpeFile :: Coordinate r => FilePath -> IO (Either ConversionError (IpeFile r))

Given a file path, tries to read an ipe file. This function applies all matrices to objects.

readSinglePageFile :: Coordinate r => FilePath -> IO (Either ConversionError (IpePage r))

Since most Ipe file contain only one page, we provide a shortcut for that as well. This function applies all matrices.

type ConversionError = Text

Reading XML directly

fromIpeXML :: IpeRead (t r) => ByteString -> Either ConversionError (t r)

Given a Bytestring, try to parse the bytestring into anything that is IpeReadable, i.e. any of the Ipe elements.

readXML :: ByteString -> Either ConversionError (Node Text Text)

Reads the data from a Bytestring into a proper Node

Read classes

class IpeReadText t where

Reading an ipe elemtn from a Text value

Minimal complete definition

ipeReadText

Methods

ipeReadText :: Text -> Either ConversionError t

Instances

IpeReadText Int

Methods

ipeReadText :: Text -> Either ConversionError Int

IpeReadText Text

Methods

ipeReadText :: Text -> Either ConversionError Text

IpeReadText FillType

Methods

ipeReadText :: Text -> Either ConversionError FillType

IpeReadText IpeColor

Methods

ipeReadText :: Text -> Either ConversionError IpeColor

IpeReadText TransformationTypes

Methods

ipeReadText :: Text -> Either ConversionError TransformationTypes

IpeReadText PinType

Methods

ipeReadText :: Text -> Either ConversionError PinType

IpeReadText LayerName

Methods

ipeReadText :: Text -> Either ConversionError LayerName

Coordinate r => IpeReadText [Operation r]

Methods

ipeReadText :: Text -> Either ConversionError [Operation r]

Coordinate r => IpeReadText (NonEmpty (PathSegment r))

Methods

ipeReadText :: Text -> Either ConversionError (NonEmpty (PathSegment r))

Coordinate r => IpeReadText (IpeArrow r)

Methods

ipeReadText :: Text -> Either ConversionError (IpeArrow r)

Coordinate r => IpeReadText (IpeDash r)

Methods

ipeReadText :: Text -> Either ConversionError (IpeDash r)

Coordinate r => IpeReadText (IpePen r)

Methods

ipeReadText :: Text -> Either ConversionError (IpePen r)

Coordinate r => IpeReadText (IpeSize r)

Methods

ipeReadText :: Text -> Either ConversionError (IpeSize r)

Coordinate r => IpeReadText (Path r)

Methods

ipeReadText :: Text -> Either ConversionError (Path r)

Coordinate r => IpeReadText (Point 2 r)

Methods

ipeReadText :: Text -> Either ConversionError (Point 2 r)

Coordinate r => IpeReadText (Rectangle () r)

Methods

ipeReadText :: Text -> Either ConversionError (Rectangle () r)

Coordinate r => IpeReadText (Matrix 3 3 r)

Methods

ipeReadText :: Text -> Either ConversionError (Matrix 3 3 r)

Coordinate r => IpeReadText (PolyLine 2 () r)

Methods

ipeReadText :: Text -> Either ConversionError (PolyLine 2 () r)

class IpeRead t where

Reading an ipe lement from Xml

Minimal complete definition

ipeRead

Methods

ipeRead :: Node Text Text -> Either ConversionError t

Instances

IpeRead LayerName

Methods

ipeRead :: Node Text Text -> Either ConversionError LayerName

IpeRead View

Methods

ipeRead :: Node Text Text -> Either ConversionError View

Coordinate r => IpeRead (Image r)

Methods

ipeRead :: Node Text Text -> Either ConversionError (Image r)

Coordinate r => IpeRead (IpeSymbol r)

Ipe read instances

Methods

ipeRead :: Node Text Text -> Either ConversionError (IpeSymbol r)

Coordinate r => IpeRead (MiniPage r)

Methods

ipeRead :: Node Text Text -> Either ConversionError (MiniPage r)

Coordinate r => IpeRead (TextLabel r)

Methods

ipeRead :: Node Text Text -> Either ConversionError (TextLabel r)

Coordinate r => IpeRead (PathSegment r)

Methods

ipeRead :: Node Text Text -> Either ConversionError (PathSegment r)

Coordinate r => IpeRead (Path r)

Methods

ipeRead :: Node Text Text -> Either ConversionError (Path r)

Coordinate r => IpeRead (IpeObject r)

Methods

ipeRead :: Node Text Text -> Either ConversionError (IpeObject r)

Coordinate r => IpeRead (Group r)

Methods

ipeRead :: Node Text Text -> Either ConversionError (Group r)

Coordinate r => IpeRead (IpePage r)

Methods

ipeRead :: Node Text Text -> Either ConversionError (IpePage r)

Coordinate r => IpeRead (IpeFile r)

Methods

ipeRead :: Node Text Text -> Either ConversionError (IpeFile r)

Coordinate r => IpeRead (PolyLine 2 () r)

Methods

ipeRead :: Node Text Text -> Either ConversionError (PolyLine 2 () r)

class IpeReadAttr t where

Basically IpeReadText for attributes. This class is not really meant to be implemented directly. Just define an IpeReadText instance for the type (Apply f at), then the generic instance below takes care of looking up the name of the attribute, and calling the right ipeReadText value. This class is just so that reifyConstraint in ipeReadRec can select the right typeclass when building the rec.

Minimal complete definition

ipeReadAttr

Methods

ipeReadAttr :: Text -> Node Text Text -> Either ConversionError t

Instances

IpeReadText (Apply u * f at) => IpeReadAttr (Attr u f at)

Methods

ipeReadAttr :: Text -> Node Text Text -> Either ConversionError (Attr u f at)

Some low level implementation functions

ipeReadTextWith :: (Text -> Either t v) -> Text -> Either ConversionError (IpeValue v)

ipeReadObject :: (IpeRead (i r), f ~ AttrMapSym1 r, ats ~ AttributesOf i, RecApplicative ats, RecAll (Attr f) ats IpeReadAttr, AllSatisfy IpeAttrName ats) => Proxy i -> proxy r -> Node Text Text -> Either ConversionError (i r :+ IpeAttributes i r)

If we can ipeRead an ipe element, and we can ipeReadAttrs its attributes we can properly read an ipe object using ipeReadObject

ipeReadAttrs :: forall proxy proxy' i r f ats. (f ~ AttrMapSym1 r, ats ~ AttributesOf i, RecApplicative ats, RecAll (Attr f) ats IpeReadAttr, AllSatisfy IpeAttrName ats) => proxy i -> proxy' r -> Node Text Text -> Either ConversionError (IpeAttributes i r)

Reader for records. Given a proxy of some ipe type i, and a proxy of an coordinate type r, read the IpeAttributes for i from the xml node.

ipeReadRec :: forall f ats. (RecApplicative ats, RecAll (Attr f) ats IpeReadAttr, AllSatisfy IpeAttrName ats) => Proxy f -> Proxy ats -> Node Text Text -> Either ConversionError (Rec (Attr f) ats)

Reading the Attributes into a Rec (Attr f), all based on the types of f (the type family mapping labels to types), and a list of labels (ats).