Update the Odds schema diagram.

[dead/htsn-import.git] / src / Xml.hs

diff --git a/src/Xml.hs b/src/Xml.hs
index 2e9c18bfad5fec0cd9599667c07ae7ed060aae0e..e7d47a12c319617d9a70c8e7d8f6a8cead7eae81 100644 (file)
--- a/src/Xml.hs
+++ b/src/Xml.hs
@@ -1,3 +1,4 @@
+{-# LANGUAGE FlexibleContexts #-}
 {-# LANGUAGE TypeFamilies #-}
 
 -- | General XML stuff.
@@ -6,29 +7,42 @@ module Xml (
   DtdName(..),
   FromXml(..),
   FromXmlFk(..),
+  ToDb(..),
   parse_opts,
   pickle_unpickle,
-  unpickleable )
+  unpickleable,
+  unsafe_read_document,
+  unsafe_unpickle )
 where
 
 -- System imports.
 import Control.Exception ( SomeException(..), catch )
-import Database.Groundhog.Core ( DefaultKey )
+import Database.Groundhog.Core ( PersistEntity(..) )
 import Text.XML.HXT.Core (
   (>>>),
   (/>),
   PU,
   SysConfigList,
+  XmlTree,
   isElem,
   no,
   readDocument,
   runX,
   withRemoveWS,
+  withSubstDTDEntities,
   withValidate,
   xpickleVal,
+  xunpickleDocument,
   xunpickleVal,
   yes )
 
+-- | Common associated type shared by 'FromXml' and 'FromXmlFk'. This
+--   basically just forces the client to define the \"database
+--   version\" of his type.
+--
+class ToDb a where
+  -- | Each instance @a@ must declare its associated database type @Db a@.
+  type Db a :: *
 
 -- | A typeclass for XML types that can be converted into an
 --   associated database type. The story behind this is long, but
@@ -41,11 +55,8 @@ import Text.XML.HXT.Core (
 --   to get the database type from the XML type that we have to define
 --   for HXT.
 --
-class FromXml a where
-  -- | Each instance @a@ must declare its associated database type @Db a@.
-  type Db a :: *
-
-  -- | And provide a function for getting a @Db a@ out of an @a@.
+class (ToDb a) => FromXml a where
+  -- | A function for getting a @Db a@ out of an @a@.
   from_xml :: a -> Db a
 
 
@@ -54,17 +65,15 @@ class FromXml a where
 --   first. Members of this class can be converted from an XML
 --   representation to a database representation in this manner.
 --
-class FromXmlFk a where
-  -- | Each instance @a@ must declare its associated database type @DbFk a@.
-  type DbFk a :: *
-
+class (ToDb a) => FromXmlFk a where
   -- | The type of our parent object, i.e. to the type to whom our
   --   foreign key will point.
   type Parent a :: *
 
-  -- | The function that produces a @DbFk a@ out of an @a@ and a foreign
-  --   key.
-  from_xml_fk :: a -> DefaultKey (Parent a) -> DbFk a
+  -- | The function that produces a @Db a@ out of a foreign key and an
+  --   @a@. The parameter order makes it easier to map this function
+  --   over a bunch of things.
+  from_xml_fk :: DefaultKey (Parent a) -> a -> Db a
 
 
 -- | Represents the DTD filename (\"SYSTEM\") part of the DOCTYPE
@@ -76,7 +85,9 @@ 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
@@ -136,3 +147,19 @@ unpickleable filepath unpickler = do
     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