xml-types-0.3.6/0000755000000000000000000000000012547130146011653 5ustar0000000000000000xml-types-0.3.6/Setup.hs0000644000000000000000000000005612547130146013310 0ustar0000000000000000import Distribution.Simple main = defaultMain xml-types-0.3.6/xml-types.cabal0000644000000000000000000000161112547130146014600 0ustar0000000000000000name: xml-types version: 0.3.6 synopsis: Basic types for representing XML license: MIT license-file: license.txt author: John Millikin maintainer: jmillikin@gmail.com build-type: Simple cabal-version: >= 1.6 category: Text, XML stability: experimental homepage: https://john-millikin.com/software/haskell-xml/ bug-reports: mailto:jmillikin@gmail.com source-repository head type: git location: https://john-millikin.com/code/haskell-xml-types/ source-repository this type: git location: https://john-millikin.com/code/haskell-xml-types/ tag: xml-types_0.3.6 library ghc-options: -Wall hs-source-dirs: lib if impl(ghc >= 7.2) extensions: DeriveGeneric, StandaloneDeriving if impl(ghc >= 7.2) && impl(ghc < 7.6) build-depends: ghc-prim build-depends: base >= 3.0 && < 5.0 , deepseq >= 1.1.0.0 , text exposed-modules: Data.XML.Types xml-types-0.3.6/license.txt0000644000000000000000000000204112547130146014033 0ustar0000000000000000Copyright (c) 2010 John Millikin Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. xml-types-0.3.6/lib/0000755000000000000000000000000012547130146012421 5ustar0000000000000000xml-types-0.3.6/lib/Data/0000755000000000000000000000000012547130146013272 5ustar0000000000000000xml-types-0.3.6/lib/Data/XML/0000755000000000000000000000000012547130146013732 5ustar0000000000000000xml-types-0.3.6/lib/Data/XML/Types.hs0000644000000000000000000002220712547130146015375 0ustar0000000000000000{-# LANGUAGE CPP #-} {-# LANGUAGE DeriveDataTypeable #-} -- if impl(ghc >= 7.2): -- extensions: DeriveGeneric, StandaloneDeriving -- | -- Module: Data.XML.Types -- Copyright: 2010-2011 John Millikin -- License: MIT -- -- Maintainer: jmillikin@gmail.com -- Portability: portable -- -- Basic types for representing XML. -- -- The idea is to have a full set of appropriate types, which various XML -- libraries can share. Instead of having equivalent-but-incompatible types -- for every binding, parser, or client, they all share the same types can -- can thus interoperate easily. -- -- This library contains complete types for most parts of an XML document, -- including the prologue, node tree, and doctype. Some basic combinators -- are included for common tasks, including traversing the node tree and -- filtering children. -- module Data.XML.Types ( -- * Types -- ** Document prologue Document (..) , Prologue (..) , Instruction (..) , Miscellaneous (..) -- ** Document body , Node (..) , Element (..) , Content (..) , Name (..) -- ** Doctypes , Doctype (..) , ExternalID (..) -- ** Incremental processing , Event (..) -- * Combinators -- ** Filters , isElement , isInstruction , isContent , isComment , isNamed -- ** Element traversal , elementChildren , elementContent , elementText -- ** Node traversal , nodeChildren , nodeContent , nodeText -- ** Attributes , hasAttribute , hasAttributeText , attributeContent , attributeText ) where import Control.Monad ((>=>)) import Data.Data (Data) import Data.Function (on) import Data.Maybe (isJust) import Data.String (IsString, fromString) import Data.Text (Text) import qualified Data.Text as T import Data.Typeable (Typeable) import Control.DeepSeq (NFData(rnf)) #if MIN_VERSION_base(4,4,0) import GHC.Generics (Generic) #endif data Document = Document { documentPrologue :: Prologue , documentRoot :: Element , documentEpilogue :: [Miscellaneous] } deriving (Data, Eq, Ord, Show, Typeable) instance NFData Document where rnf (Document a b c) = rnf a `seq` rnf b `seq` rnf c `seq` () #if MIN_VERSION_base(4,4,0) deriving instance Generic Document #endif data Prologue = Prologue { prologueBefore :: [Miscellaneous] , prologueDoctype :: Maybe Doctype , prologueAfter :: [Miscellaneous] } deriving (Data, Eq, Ord, Show, Typeable) instance NFData Prologue where rnf (Prologue a b c) = rnf a `seq` rnf b `seq` rnf c `seq` () #if MIN_VERSION_base(4,4,0) deriving instance Generic Prologue #endif data Instruction = Instruction { instructionTarget :: Text , instructionData :: Text } deriving (Data, Eq, Ord, Show, Typeable) instance NFData Instruction where rnf (Instruction a b) = rnf a `seq` rnf b `seq` () #if MIN_VERSION_base(4,4,0) deriving instance Generic Instruction #endif data Miscellaneous = MiscInstruction Instruction | MiscComment Text deriving (Data, Eq, Ord, Show, Typeable) instance NFData Miscellaneous where rnf (MiscInstruction a) = rnf a `seq` () rnf (MiscComment a) = rnf a `seq` () #if MIN_VERSION_base(4,4,0) deriving instance Generic Miscellaneous #endif data Node = NodeElement Element | NodeInstruction Instruction | NodeContent Content | NodeComment Text deriving (Data, Eq, Ord, Show, Typeable) instance NFData Node where rnf (NodeElement a) = rnf a `seq` () rnf (NodeInstruction a) = rnf a `seq` () rnf (NodeContent a) = rnf a `seq` () rnf (NodeComment a) = rnf a `seq` () #if MIN_VERSION_base(4,4,0) deriving instance Generic Node #endif data Element = Element { elementName :: Name , elementAttributes :: [(Name, [Content])] , elementNodes :: [Node] } deriving (Data, Eq, Ord, Show, Typeable) instance NFData Element where rnf (Element a b c) = rnf a `seq` rnf b `seq` rnf c `seq` () #if MIN_VERSION_base(4,4,0) deriving instance Generic Element #endif data Content = ContentText Text | ContentEntity Text -- ^ For pass-through parsing deriving (Data, Eq, Ord, Show, Typeable) instance NFData Content where rnf (ContentText a) = rnf a `seq` () rnf (ContentEntity a) = rnf a `seq` () #if MIN_VERSION_base(4,4,0) deriving instance Generic Content #endif -- | A fully qualified name. -- -- Prefixes are not semantically important; they are included only to -- simplify pass-through parsing. When comparing names with 'Eq' or 'Ord' -- methods, prefixes are ignored. -- -- The @IsString@ instance supports Clark notation; see -- and -- . Use -- the @OverloadedStrings@ language extension for very simple @Name@ -- construction: -- -- > myname :: Name -- > myname = "{http://example.com/ns/my-namespace}my-name" -- data Name = Name { nameLocalName :: Text , nameNamespace :: Maybe Text , namePrefix :: Maybe Text } deriving (Data, Show, Typeable) instance Eq Name where (==) = (==) `on` (\x -> (nameNamespace x, nameLocalName x)) instance Ord Name where compare = compare `on` (\x -> (nameNamespace x, nameLocalName x)) instance IsString Name where fromString "" = Name T.empty Nothing Nothing fromString full@('{':rest) = case break (== '}') rest of (_, "") -> error ("Invalid Clark notation: " ++ show full) (ns, local) -> Name (T.pack (drop 1 local)) (Just (T.pack ns)) Nothing fromString local = Name (T.pack local) Nothing Nothing instance NFData Name where rnf (Name a b c) = rnf a `seq` rnf b `seq` rnf c `seq` () #if MIN_VERSION_base(4,4,0) deriving instance Generic Name #endif -- | Note: due to the incredible complexity of DTDs, this type only supports -- external subsets. I've tried adding internal subset types, but they -- quickly gain more code than the rest of this module put together. -- -- It is possible that some future version of this library might support -- internal subsets, but I am no longer actively working on adding them. data Doctype = Doctype { doctypeName :: Text , doctypeID :: Maybe ExternalID } deriving (Data, Eq, Ord, Show, Typeable) instance NFData Doctype where rnf (Doctype a b) = rnf a `seq` rnf b `seq` () #if MIN_VERSION_base(4,4,0) deriving instance Generic Doctype #endif data ExternalID = SystemID Text | PublicID Text Text deriving (Data, Eq, Ord, Show, Typeable) instance NFData ExternalID where rnf (SystemID a) = rnf a `seq` () rnf (PublicID a b) = rnf a `seq` rnf b `seq` () #if MIN_VERSION_base(4,4,0) deriving instance Generic ExternalID #endif -- | Some XML processing tools are incremental, and work in terms of events -- rather than node trees. The 'Event' type allows a document to be fully -- specified as a sequence of events. -- -- Event-based XML libraries include: -- -- * -- -- * -- -- * -- data Event = EventBeginDocument | EventEndDocument | EventBeginDoctype Text (Maybe ExternalID) | EventEndDoctype | EventInstruction Instruction | EventBeginElement Name [(Name, [Content])] | EventEndElement Name | EventContent Content | EventComment Text | EventCDATA Text deriving (Data, Eq, Ord, Show, Typeable) instance NFData Event where rnf (EventBeginDoctype a b) = rnf a `seq` rnf b `seq` () rnf (EventInstruction a) = rnf a `seq` () rnf (EventBeginElement a b) = rnf a `seq` rnf b `seq` () rnf (EventEndElement a) = rnf a `seq` () rnf (EventContent a) = rnf a `seq` () rnf (EventComment a) = rnf a `seq` () rnf (EventCDATA a) = rnf a `seq` () rnf _ = () #if MIN_VERSION_base(4,4,0) deriving instance Generic Event #endif isElement :: Node -> [Element] isElement (NodeElement e) = [e] isElement _ = [] isInstruction :: Node -> [Instruction] isInstruction (NodeInstruction i) = [i] isInstruction _ = [] isContent :: Node -> [Content] isContent (NodeContent c) = [c] isContent _ = [] isComment :: Node -> [Text] isComment (NodeComment t) = [t] isComment _ = [] isNamed :: Name -> Element -> [Element] isNamed n e = [e | elementName e == n] elementChildren :: Element -> [Element] elementChildren = elementNodes >=> isElement elementContent :: Element -> [Content] elementContent = elementNodes >=> isContent elementText :: Element -> [Text] elementText = elementContent >=> contentText nodeChildren :: Node -> [Node] nodeChildren = isElement >=> elementNodes nodeContent :: Node -> [Content] nodeContent = nodeChildren >=> isContent nodeText :: Node -> [Text] nodeText = nodeContent >=> contentText hasAttribute :: Name -> Element -> [Element] hasAttribute name e = [e | isJust (attributeContent name e)] hasAttributeText :: Name -> (Text -> Bool) -> Element -> [Element] hasAttributeText name p e = [e | maybe False p (attributeText name e)] attributeContent :: Name -> Element -> Maybe [Content] attributeContent name e = lookup name (elementAttributes e) attributeText :: Name -> Element -> Maybe Text attributeText name e = fmap contentFlat (attributeContent name e) contentText :: Content -> [Text] contentText (ContentText t) = [t] contentText (ContentEntity entity) = [T.pack "&", entity, T.pack ";"] contentFlat :: [Content] -> Text contentFlat cs = T.concat (cs >>= contentText)