DtdName(..),
FromXml(..),
FromXmlFk(..),
+ FromXmlFkTeams(..),
ToDb(..),
parse_opts,
pickle_unpickle,
- unpickleable )
+ unpickleable,
+ unsafe_read_document,
+ unsafe_unpickle )
where
-- System imports.
(/>),
PU,
SysConfigList,
+ XmlTree,
isElem,
no,
readDocument,
runX,
withRemoveWS,
+ withSubstDTDEntities,
withValidate,
xpickleVal,
+ xunpickleDocument,
xunpickleVal,
yes )
+
+-- Local imports.
+import TSN.Team ( Team(..) )
+
+
-- | Common associated type shared by 'FromXml' and 'FromXmlFk'. This
-- basically just forces the client to define the \"database
-- version\" of his type.
from_xml_fk :: DefaultKey (Parent a) -> a -> Db a
+-- | A further refinement of 'FromXmlFk'. These types need not only a
+-- foreign key to a parent in order to make the XML -> DB
+-- conversion, but also two foreign keys to away/home teams (as
+-- represented in "TSN.Team").
+--
+class (ToDb a) => FromXmlFkTeams a where
+ -- | The function that produces a @Db a@ out of a parent foreign
+ -- key, two team foreign keys, and an @a@. The parameter order makes
+ -- it easier to map this function over a bunch of things.
+ from_xml_fk_teams :: DefaultKey (Parent a)
+ -> DefaultKey Team -- ^ The away team FK
+ -> DefaultKey Team -- ^ The home team FK
+ -> a
+ -> Db a
+
+
-- | Represents the DTD filename (\"SYSTEM\") part of the DOCTYPE
-- definition.
newtype DtdName = DtdName String
-- would have to parse whitespace in each (un)pickler.
--
parse_opts :: SysConfigList
-parse_opts = [ withRemoveWS yes, withValidate no ]
+parse_opts = [ withRemoveWS yes,
+ withSubstDTDEntities no,
+ withValidate no ]
-- | Given an @unpickler@ and a @filepath@, attempt to unpickle the
try_unpickle = runX $ readDocument parse_opts filepath
>>>
xunpickleVal unpickler
+
+
+-- | Unpickle from a 'FilePath' using the given pickler. Explode if it
+-- doesn't work.
+--
+unsafe_unpickle :: FilePath -> PU a -> IO a
+unsafe_unpickle filepath unpickler =
+ fmap head $ runX $ xunpickleDocument unpickler parse_opts filepath
+
+
+-- | Read an XML document from a 'FilePath' into an XmlTree. Explode if it
+-- doesn't work.
+--
+unsafe_read_document :: FilePath -> IO XmlTree
+unsafe_read_document filepath =
+ fmap head $ runX $ readDocument parse_opts filepath