Data.PropertyList.Xml

Documentation

data Plist

DtdToHaskell-generated type representing XML trees that match the PropertyList-1.0 dtd. This is an opaque representation of a structurally-sound property list which might still contain invalid data. End users should never need to use this type, but if they do, it can be manipulated with the constructors and deconstructors in Data.PropertyList.Algebra.

Instances

Eq Plist

Show Plist

XmlContent Plist

HTypeable Plist

PListCoalgebra f PlistItem => PListCoalgebra f Plist

PListAlgebra f PlistItem => PListAlgebra f Plist

readXmlPlist :: String -> Either String Plist

Try to parse a string as an XML property list.

showXmlPlist :: Plist -> String

Render a Plist to a String as an XML property list.

readXmlPlistFromFile :: FilePath -> IO (Either String Plist)

Try to parse a Plist from an XML property-list file.

writeXmlPlistToFile :: FilePath -> Plist -> IO ()

Try to write a Plist to an XML property-list file.

type PlistItem = OneOf9 Array Data Date Dict AReal AInteger AString True False

PlistItem is nearly equivalent to Plist - the difference is that it discards information about where in the tree the item is (a Plist represents the whole XML tree starting from the root). This is a "slightly-less-opaque" type, but still isn't really intended for consumption by end users.

plistToPlistItem :: Plist -> PlistItem

Convert a Plist to a PlistItem, discarding the root element and any attributes that element may have had.

plistItemToPlist :: PlistItem -> Plist

Convert a PlistItem to a Plist, giving it a root element with no attributes.

data UnparsedPlistItem

A representation of values that were structurally sound in the property list file but the contents of which couldn't be interpreted as what they claimed to be. The result of the initial parse phase will typically be a PartialPropertyList UnparsedPlistItem, and if the whole plist was parsed properly will contain no actual values of this type.

Constructors

UnparsedData String

UnparsedDate String

UnparsedInt String

UnparsedReal String

Instances

Eq UnparsedPlistItem

Ord UnparsedPlistItem

Read UnparsedPlistItem

Show UnparsedPlistItem

PListCoalgebra (Either UnparsedPlistItem) PlistItem

PListAlgebra (Either UnparsedPlistItem) PlistItem

unparsedPlistItemToPlistItem :: UnparsedPlistItem -> PlistItem

Take the unparsed data from an UnparsedPlistItem and wrap it in the appropriate PlistItem constructor.

readXmlPropertyList :: FilePath -> Either String PropertyList

Read a property list from a String in the xml1 format. If parsing fails, returns a description of the problem in the Left result.

readXmlPropertyListFromFile :: FilePath -> IO PropertyList

Read a property list from a file in the xml1 format. If parsing fails, calls fail.

readXmlPartialPropertyList :: (PListCoalgebra f PlistItem, TerminalPList f pl) => String -> Either String pl

Read an XML propertylist from a String in the xml1 plist format to a propertylist type which is terminal for the liftings supported by PlistItem (such as PartialPropertyList UnparsedPlistItem or PartialPropertyList PlistItem).

showXmlPropertyList :: (InitialPList f pl, PListAlgebra f PlistItem) => pl -> String

Render a propertylist to a String in the xml1 plist format from any initial propertylist type (which includes PropertyList, PartialPropertyList UnparsedPlistItem, and PartialPropertyList PlistItem).

readXmlPartialPropertyListFromFile :: (PListCoalgebra f PlistItem, TerminalPList f pl) => FilePath -> IO (Either String pl)

Read an XML propertylist from a file in the xml1 plist format to a propertylist type which is terminal for the liftings supported by PlistItem (such as PartialPropertyList UnparsedPlistItem or PartialPropertyList PlistItem).

writeXmlPropertyListToFile :: (InitialPList f pl, PListAlgebra f PlistItem) => FilePath -> pl -> IO ()

Output a propertylist to a file in the xml1 plist format from any initial propertylist type (which includes PropertyList, PartialPropertyList UnparsedPlistItem, and PartialPropertyList PlistItem).