Text.XML.Basic.Character

All kinds of representations of a character in XML combined in one type. Note that an entity can in principle represent a large text, thus an "XML character" might actually be a text. However the standard entities consist of one character. In contrast to our representation, HaXml uses Unicode substrings instead of Unicode characters, which is certainly more efficient for common XML texts that contain mainly Unicode text and only few references. However our representation is unique, whereas HaXmls may represent a text as abc,def or abcdef.

Documentation

data T

Constructors

Unicode Char

CharRef Int

EntityRef String

Instances

Eq T

Show T

C T

toUnicode :: T -> Exceptional String Char

If a reference cannot be resolved then an Exception constructor with an error message is returned.

toUnicodeGen :: Map String Char -> T -> Exceptional String Char

toUnicodeOrFormat :: T -> ShowS

If a reference cannot be resolved then a reference string is returned.

toUnicodeOrFormatGen :: Map String Char -> T -> ShowS

fromUnicode :: Char -> T

fromCharRef :: Int -> T

fromEntityRef :: String -> T

maybeUnicode :: T -> Maybe Char

maybeCharRef :: T -> Maybe Int

maybeEntityRef :: T -> Maybe String

isUnicode :: T -> Bool

isCharRef :: T -> Bool

isEntityRef :: T -> Bool

isRef :: T -> Bool

unicode :: Char -> T

refC :: Int -> T

refE :: String -> T

asciiFromUnicode :: Char -> T

Convert unicode character to XML Char, where Unicode constructor is only used for ASCII characters. This is achieved by the following decision: If there is a entity reference, use this. If it is ASCII, represent it as Char. Otherwise use a character reference.

asciiFromUnicodeGen :: Map Char String -> Char -> T

minimalRefFromUnicode :: Char -> T

Generate XML character from Unicode character with minimal use of references. The only references used are the XML entity references ', ", &, <, >.

reduceRef :: T -> T

Reduce the use of references. Represent as much as possible characters as Unicode characters, that is, using the Unicode constructor.

reduceRefGen :: Map String Char -> T -> T

try to convert a References to equivalent Unicode characters

validCharRef :: Int -> Bool

switchUnicodeRuns :: (String -> a) -> (Int -> a) -> (String -> a) -> [T] -> [a]