mirrors/phobos
1
0
Fork 0
mirror of https://github.com/dlang/phobos.git synced 2025-04-28 06:00:35 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Remove documentation from std.xml due to deprecation in midterm.

Browse source
This commit is contained in:
berni44 2021-01-28 15:23:28 +01:00
parent 88fd21e736
commit ee67cd3eba
1 changed files with 127 additions and 125 deletions
Download patch file Download diff file Expand all files Collapse all files

252
std/xml.d
View file

@ -4,7 +4,9 @@
$(RED Warning: This module is considered out-dated and not up to Phobos' $(RED Warning: This module is considered out-dated and not up to Phobos'
current standards. It will be removed from Phobos in 2.101.0. current standards. It will be removed from Phobos in 2.101.0.
If you still need it, go to $(LINK https://github.com/DigitalMars/undeaD)) If you still need it, go to $(LINK https://github.com/DigitalMars/undeaD))
*/
/*
Classes and functions for creating and parsing XML Classes and functions for creating and parsing XML
The basic architecture of this module is that there are standalone functions, The basic architecture of this module is that there are standalone functions,
@ -128,7 +130,7 @@ module std.xml;
enum cdata = "<![CDATA["; enum cdata = "<![CDATA[";
/** /*
* Returns true if the character is a character according to the XML standard * Returns true if the character is a character according to the XML standard
* *
* Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0) * Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0)
@ -190,7 +192,7 @@ bool isChar(dchar c) @safe @nogc pure nothrow // rule 2
} }
} }
/** /*
* Returns true if the character is whitespace according to the XML standard * Returns true if the character is whitespace according to the XML standard
* *
* Only the following characters are considered whitespace in XML - space, tab, * Only the following characters are considered whitespace in XML - space, tab,
@ -206,7 +208,7 @@ bool isSpace(dchar c) @safe @nogc pure nothrow
return c == '\u0020' || c == '\u0009' || c == '\u000A' || c == '\u000D'; return c == '\u0020' || c == '\u0009' || c == '\u000A' || c == '\u000D';
} }
/** /*
* Returns true if the character is a digit according to the XML standard * Returns true if the character is a digit according to the XML standard
* *
* Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0) * Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0)
@ -231,7 +233,7 @@ bool isDigit(dchar c) @safe @nogc pure nothrow
} }
} }
/** /*
* Returns true if the character is a letter according to the XML standard * Returns true if the character is a letter according to the XML standard
* *
* Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0) * Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0)
@ -244,7 +246,7 @@ bool isLetter(dchar c) @safe @nogc nothrow pure // rule 84
return isIdeographic(c) || isBaseChar(c); return isIdeographic(c) || isBaseChar(c);
} }
/** /*
* Returns true if the character is an ideographic character according to the * Returns true if the character is an ideographic character according to the
* XML standard * XML standard
* *
@ -279,7 +281,7 @@ bool isIdeographic(dchar c) @safe @nogc nothrow pure
} }
} }
/** /*
* Returns true if the character is a base character according to the XML * Returns true if the character is a base character according to the XML
* standard * standard
* *
@ -293,7 +295,7 @@ bool isBaseChar(dchar c) @safe @nogc nothrow pure
return lookup(BaseCharTable,c); return lookup(BaseCharTable,c);
} }
/** /*
* Returns true if the character is a combining character according to the * Returns true if the character is a combining character according to the
* XML standard * XML standard
* *
@ -307,7 +309,7 @@ bool isCombiningChar(dchar c) @safe @nogc nothrow pure
return lookup(CombiningCharTable,c); return lookup(CombiningCharTable,c);
} }
/** /*
* Returns true if the character is an extender according to the XML standard * Returns true if the character is an extender according to the XML standard
* *
* Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0) * Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0)
@ -320,7 +322,7 @@ bool isExtender(dchar c) @safe @nogc nothrow pure
return lookup(ExtenderTable,c); return lookup(ExtenderTable,c);
} }
/** /*
* Encodes a string by replacing all characters which need to be escaped with * Encodes a string by replacing all characters which need to be escaped with
* appropriate predefined XML entities. * appropriate predefined XML entities.
* *
@ -385,7 +387,7 @@ S encode(S)(S s)
assert(encode("cat & dog") == "cat &amp; dog"); assert(encode("cat & dog") == "cat &amp; dog");
} }
/** /*
* Mode to use for decoding. * Mode to use for decoding.
* *
* $(DDOC_ENUM_MEMBERS NONE) Do not decode * $(DDOC_ENUM_MEMBERS NONE) Do not decode
@ -397,7 +399,7 @@ enum DecodeMode
NONE, LOOSE, STRICT NONE, LOOSE, STRICT
} }
/** /*
* Decodes a string by unescaping all predefined XML entities. * Decodes a string by unescaping all predefined XML entities.
* *
* encode() escapes certain characters (ampersand, quote, apostrophe, less-than * encode() escapes certain characters (ampersand, quote, apostrophe, less-than
@ -522,7 +524,7 @@ string decode(string s, DecodeMode mode=DecodeMode.LOOSE) @safe pure
assertNot("&#x2G;"); assertNot("&#x2G;");
} }
/** /*
* Class representing an XML document. * Class representing an XML document.
* *
* Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0) * Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0)
@ -530,18 +532,18 @@ string decode(string s, DecodeMode mode=DecodeMode.LOOSE) @safe pure
*/ */
class Document : Element class Document : Element
{ {
/** /*
* Contains all text which occurs before the root element. * Contains all text which occurs before the root element.
* Defaults to &lt;?xml version="1.0"?&gt; * Defaults to &lt;?xml version="1.0"?&gt;
*/ */
string prolog = "<?xml version=\"1.0\"?>"; string prolog = "<?xml version=\"1.0\"?>";
/** /*
* Contains all text which occurs after the root element. * Contains all text which occurs after the root element.
* Defaults to the empty string * Defaults to the empty string
*/ */
string epilog; string epilog;
/** /*
* Constructs a Document by parsing XML text. * Constructs a Document by parsing XML text.
* *
* This function creates a complete DOM (Document Object Model) tree. * This function creates a complete DOM (Document Object Model) tree.
@ -568,7 +570,7 @@ class Document : Element
epilog = *xml.s; epilog = *xml.s;
} }
/** /*
* Constructs a Document from a Tag. * Constructs a Document from a Tag.
* *
* Params: * Params:
@ -581,7 +583,7 @@ class Document : Element
const const
{ {
/** /*
* Compares two Documents for equality * Compares two Documents for equality
* *
* Example: * Example:
@ -598,7 +600,7 @@ class Document : Element
&& epilog == doc.epilog; && epilog == doc.epilog;
} }
/** /*
* Compares two Documents * Compares two Documents
* *
* You should rarely need to call this function. It exists so that * You should rarely need to call this function. It exists so that
@ -622,7 +624,7 @@ class Document : Element
return 0; return 0;
} }
/** /*
* Returns the hash of a Document * Returns the hash of a Document
* *
* You should rarely need to call this function. It exists so that * You should rarely need to call this function. It exists so that
@ -633,7 +635,7 @@ class Document : Element
return hash(prolog, hash(epilog, (cast() this).Element.toHash())); return hash(prolog, hash(epilog, (cast() this).Element.toHash()));
} }
/** /*
* Returns the string representation of a Document. (That is, the * Returns the string representation of a Document. (That is, the
* complete XML of a document). * complete XML of a document).
*/ */
@ -662,22 +664,22 @@ class Document : Element
assert(b > a); assert(b > a);
} }
/** /*
* Class representing an XML element. * Class representing an XML element.
* *
* Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0) * Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0)
*/ */
class Element : Item class Element : Item
{ {
Tag tag; /// The start tag of the element Tag tag; // The start tag of the element
Item[] items; /// The element's items Item[] items; // The element's items
Text[] texts; /// The element's text items Text[] texts; // The element's text items
CData[] cdatas; /// The element's CData items CData[] cdatas; // The element's CData items
Comment[] comments; /// The element's comments Comment[] comments; // The element's comments
ProcessingInstruction[] pis; /// The element's processing instructions ProcessingInstruction[] pis; // The element's processing instructions
Element[] elements; /// The element's child elements Element[] elements; // The element's child elements
/** /*
* Constructs an Element given a name and a string to be used as a Text * Constructs an Element given a name and a string to be used as a Text
* interior. * interior.
* *
@ -697,7 +699,7 @@ class Element : Item
if (interior.length != 0) opOpAssign!("~")(new Text(interior)); if (interior.length != 0) opOpAssign!("~")(new Text(interior));
} }
/** /*
* Constructs an Element from a Tag. * Constructs an Element from a Tag.
* *
* Params: * Params:
@ -711,7 +713,7 @@ class Element : Item
tag.tagString = tag_.tagString; tag.tagString = tag_.tagString;
} }
/** /*
* Append a text item to the interior of this element * Append a text item to the interior of this element
* *
* Params: * Params:
@ -730,7 +732,7 @@ class Element : Item
appendItem(item); appendItem(item);
} }
/** /*
* Append a CData item to the interior of this element * Append a CData item to the interior of this element
* *
* Params: * Params:
@ -749,7 +751,7 @@ class Element : Item
appendItem(item); appendItem(item);
} }
/** /*
* Append a comment to the interior of this element * Append a comment to the interior of this element
* *
* Params: * Params:
@ -768,7 +770,7 @@ class Element : Item
appendItem(item); appendItem(item);
} }
/** /*
* Append a processing instruction to the interior of this element * Append a processing instruction to the interior of this element
* *
* Params: * Params:
@ -787,7 +789,7 @@ class Element : Item
appendItem(item); appendItem(item);
} }
/** /*
* Append a complete element to the interior of this element * Append a complete element to the interior of this element
* *
* Params: * Params:
@ -832,7 +834,7 @@ class Element : Item
xml.parse(); xml.parse();
} }
/** /*
* Compares two Elements for equality * Compares two Elements for equality
* *
* Example: * Example:
@ -853,7 +855,7 @@ class Element : Item
return true; return true;
} }
/** /*
* Compares two Elements * Compares two Elements
* *
* You should rarely need to call this function. It exists so that Elements * You should rarely need to call this function. It exists so that Elements
@ -878,7 +880,7 @@ class Element : Item
} }
} }
/** /*
* Returns the hash of an Element * Returns the hash of an Element
* *
* You should rarely need to call this function. It exists so that Elements * You should rarely need to call this function. It exists so that Elements
@ -893,7 +895,7 @@ class Element : Item
const const
{ {
/** /*
* Returns the decoded interior of an element. * Returns the decoded interior of an element.
* *
* The element is assumed to contain text <i>only</i>. So, for * The element is assumed to contain text <i>only</i>. So, for
@ -917,7 +919,7 @@ class Element : Item
return buffer; return buffer;
} }
/** /*
* Returns an indented string representation of this item * Returns an indented string representation of this item
* *
* Params: * Params:
@ -953,7 +955,7 @@ class Element : Item
return a; return a;
} }
/** /*
* Returns the string representation of an Element * Returns the string representation of an Element
* *
* Example: * Example:
@ -976,7 +978,7 @@ class Element : Item
} }
} }
/** /*
* Tag types. * Tag types.
* *
* $(DDOC_ENUM_MEMBERS START) Used for start tags * $(DDOC_ENUM_MEMBERS START) Used for start tags
@ -986,7 +988,7 @@ class Element : Item
*/ */
enum TagType { START, END, EMPTY } enum TagType { START, END, EMPTY }
/** /*
* Class representing an XML tag. * Class representing an XML tag.
* *
* Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0) * Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0)
@ -1000,9 +1002,9 @@ enum TagType { START, END, EMPTY }
*/ */
class Tag class Tag
{ {
TagType type = TagType.START; /// Type of tag TagType type = TagType.START; // Type of tag
string name; /// Tag name string name; // Tag name
string[string] attr; /// Associative array of attributes string[string] attr; // Associative array of attributes
private string tagString; private string tagString;
invariant() invariant()
@ -1027,7 +1029,7 @@ class Tag
} }
} }
/** /*
* Constructs an instance of Tag with a specified name and type * Constructs an instance of Tag with a specified name and type
* *
* The constructor does not initialize the attributes. To initialize the * The constructor does not initialize the attributes. To initialize the
@ -1117,7 +1119,7 @@ class Tag
const const
{ {
/** /*
* Compares two Tags for equality * Compares two Tags for equality
* *
* You should rarely need to call this function. It exists so that Tags * You should rarely need to call this function. It exists so that Tags
@ -1139,7 +1141,7 @@ class Tag
true ))); true )));
} }
/** /*
* Compares two Tags * Compares two Tags
* *
* Example: * Example:
@ -1159,7 +1161,7 @@ class Tag
0 ))); 0 )));
} }
/** /*
* Returns the hash of a Tag * Returns the hash of a Tag
* *
* You should rarely need to call this function. It exists so that Tags * You should rarely need to call this function. It exists so that Tags
@ -1170,7 +1172,7 @@ class Tag
return .hashOf(name); return .hashOf(name);
} }
/** /*
* Returns the string representation of a Tag * Returns the string representation of a Tag
* *
* Example: * Example:
@ -1204,7 +1206,7 @@ class Tag
string toEmptyString() @safe { return toNonEndString() ~ " />"; } string toEmptyString() @safe { return toNonEndString() ~ " />"; }
} }
/** /*
* Returns true if the Tag is a start tag * Returns true if the Tag is a start tag
* *
* Example: * Example:
@ -1214,7 +1216,7 @@ class Tag
*/ */
@property bool isStart() @safe @nogc pure nothrow { return type == TagType.START; } @property bool isStart() @safe @nogc pure nothrow { return type == TagType.START; }
/** /*
* Returns true if the Tag is an end tag * Returns true if the Tag is an end tag
* *
* Example: * Example:
@ -1224,7 +1226,7 @@ class Tag
*/ */
@property bool isEnd() @safe @nogc pure nothrow { return type == TagType.END; } @property bool isEnd() @safe @nogc pure nothrow { return type == TagType.END; }
/** /*
* Returns true if the Tag is an empty tag * Returns true if the Tag is an empty tag
* *
* Example: * Example:
@ -1236,14 +1238,14 @@ class Tag
} }
} }
/** /*
* Class representing a comment * Class representing a comment
*/ */
class Comment : Item class Comment : Item
{ {
private string content; private string content;
/** /*
* Construct a comment * Construct a comment
* *
* Params: * Params:
@ -1267,7 +1269,7 @@ class Comment : Item
this.content = content; this.content = content;
} }
/** /*
* Compares two comments for equality * Compares two comments for equality
* *
* Example: * Example:
@ -1283,7 +1285,7 @@ class Comment : Item
return t !is null && content == t.content; return t !is null && content == t.content;
} }
/** /*
* Compares two comments * Compares two comments
* *
* You should rarely need to call this function. It exists so that Comments * You should rarely need to call this function. It exists so that Comments
@ -1303,7 +1305,7 @@ class Comment : Item
? (content < t.content ? -1 : 1 ) : 0 ); ? (content < t.content ? -1 : 1 ) : 0 );
} }
/** /*
* Returns the hash of a Comment * Returns the hash of a Comment
* *
* You should rarely need to call this function. It exists so that Comments * You should rarely need to call this function. It exists so that Comments
@ -1311,12 +1313,12 @@ class Comment : Item
*/ */
override size_t toHash() scope const nothrow { return hash(content); } override size_t toHash() scope const nothrow { return hash(content); }
/** /*
* Returns a string representation of this comment * Returns a string representation of this comment
*/ */
override string toString() scope const @safe pure nothrow { return "<!--" ~ content ~ "-->"; } override string toString() scope const @safe pure nothrow { return "<!--" ~ content ~ "-->"; }
override @property @safe @nogc pure nothrow scope bool isEmptyXML() const { return false; } /// Returns false always override @property @safe @nogc pure nothrow scope bool isEmptyXML() const { return false; } // Returns false always
} }
// https://issues.dlang.org/show_bug.cgi?id=16241 // https://issues.dlang.org/show_bug.cgi?id=16241
@ -1328,14 +1330,14 @@ class Comment : Item
assertThrown!CommentException(new Comment("--")); assertThrown!CommentException(new Comment("--"));
} }
/** /*
* Class representing a Character Data section * Class representing a Character Data section
*/ */
class CData : Item class CData : Item
{ {
private string content; private string content;
/** /*
* Construct a character data section * Construct a character data section
* *
* Params: * Params:
@ -1356,7 +1358,7 @@ class CData : Item
this.content = content; this.content = content;
} }
/** /*
* Compares two CDatas for equality * Compares two CDatas for equality
* *
* Example: * Example:
@ -1372,7 +1374,7 @@ class CData : Item
return t !is null && content == t.content; return t !is null && content == t.content;
} }
/** /*
* Compares two CDatas * Compares two CDatas
* *
* You should rarely need to call this function. It exists so that CDatas * You should rarely need to call this function. It exists so that CDatas
@ -1392,7 +1394,7 @@ class CData : Item
? (content < t.content ? -1 : 1 ) : 0 ); ? (content < t.content ? -1 : 1 ) : 0 );
} }
/** /*
* Returns the hash of a CData * Returns the hash of a CData
* *
* You should rarely need to call this function. It exists so that CDatas * You should rarely need to call this function. It exists so that CDatas
@ -1400,22 +1402,22 @@ class CData : Item
*/ */
override size_t toHash() scope const nothrow { return hash(content); } override size_t toHash() scope const nothrow { return hash(content); }
/** /*
* Returns a string representation of this CData section * Returns a string representation of this CData section
*/ */
override string toString() scope const @safe pure nothrow { return cdata ~ content ~ "]]>"; } override string toString() scope const @safe pure nothrow { return cdata ~ content ~ "]]>"; }
override @property @safe @nogc pure nothrow scope bool isEmptyXML() const { return false; } /// Returns false always override @property @safe @nogc pure nothrow scope bool isEmptyXML() const { return false; } // Returns false always
} }
/** /*
* Class representing a text (aka Parsed Character Data) section * Class representing a text (aka Parsed Character Data) section
*/ */
class Text : Item class Text : Item
{ {
private string content; private string content;
/** /*
* Construct a text (aka PCData) section * Construct a text (aka PCData) section
* *
* Params: * Params:
@ -1433,7 +1435,7 @@ class Text : Item
this.content = encode(content); this.content = encode(content);
} }
/** /*
* Compares two text sections for equality * Compares two text sections for equality
* *
* Example: * Example:
@ -1449,7 +1451,7 @@ class Text : Item
return t !is null && content == t.content; return t !is null && content == t.content;
} }
/** /*
* Compares two text sections * Compares two text sections
* *
* You should rarely need to call this function. It exists so that Texts * You should rarely need to call this function. It exists so that Texts
@ -1469,7 +1471,7 @@ class Text : Item
&& (content != t.content ? (content < t.content ? -1 : 1 ) : 0 ); && (content != t.content ? (content < t.content ? -1 : 1 ) : 0 );
} }
/** /*
* Returns the hash of a text section * Returns the hash of a text section
* *
* You should rarely need to call this function. It exists so that Texts * You should rarely need to call this function. It exists so that Texts
@ -1477,25 +1479,25 @@ class Text : Item
*/ */
override size_t toHash() scope const nothrow { return hash(content); } override size_t toHash() scope const nothrow { return hash(content); }
/** /*
* Returns a string representation of this Text section * Returns a string representation of this Text section
*/ */
override string toString() scope const @safe @nogc pure nothrow { return content; } override string toString() scope const @safe @nogc pure nothrow { return content; }
/** /*
* Returns true if the content is the empty string * Returns true if the content is the empty string
*/ */
override @property @safe @nogc pure nothrow scope bool isEmptyXML() const { return content.length == 0; } override @property @safe @nogc pure nothrow scope bool isEmptyXML() const { return content.length == 0; }
} }
/** /*
* Class representing an XML Instruction section * Class representing an XML Instruction section
*/ */
class XMLInstruction : Item class XMLInstruction : Item
{ {
private string content; private string content;
/** /*
* Construct an XML Instruction section * Construct an XML Instruction section
* *
* Params: * Params:
@ -1516,7 +1518,7 @@ class XMLInstruction : Item
this.content = content; this.content = content;
} }
/** /*
* Compares two XML instructions for equality * Compares two XML instructions for equality
* *
* Example: * Example:
@ -1532,7 +1534,7 @@ class XMLInstruction : Item
return t !is null && content == t.content; return t !is null && content == t.content;
} }
/** /*
* Compares two XML instructions * Compares two XML instructions
* *
* You should rarely need to call this function. It exists so that * You should rarely need to call this function. It exists so that
@ -1552,7 +1554,7 @@ class XMLInstruction : Item
&& (content != t.content ? (content < t.content ? -1 : 1 ) : 0 ); && (content != t.content ? (content < t.content ? -1 : 1 ) : 0 );
} }
/** /*
* Returns the hash of an XMLInstruction * Returns the hash of an XMLInstruction
* *
* You should rarely need to call this function. It exists so that * You should rarely need to call this function. It exists so that
@ -1560,22 +1562,22 @@ class XMLInstruction : Item
*/ */
override size_t toHash() scope const nothrow { return hash(content); } override size_t toHash() scope const nothrow { return hash(content); }
/** /*
* Returns a string representation of this XmlInstruction * Returns a string representation of this XmlInstruction
*/ */
override string toString() scope const @safe pure nothrow { return "<!" ~ content ~ ">"; } override string toString() scope const @safe pure nothrow { return "<!" ~ content ~ ">"; }
override @property @safe @nogc pure nothrow scope bool isEmptyXML() const { return false; } /// Returns false always override @property @safe @nogc pure nothrow scope bool isEmptyXML() const { return false; } // Returns false always
} }
/** /*
* Class representing a Processing Instruction section * Class representing a Processing Instruction section
*/ */
class ProcessingInstruction : Item class ProcessingInstruction : Item
{ {
private string content; private string content;
/** /*
* Construct a Processing Instruction section * Construct a Processing Instruction section
* *
* Params: * Params:
@ -1596,7 +1598,7 @@ class ProcessingInstruction : Item
this.content = content; this.content = content;
} }
/** /*
* Compares two processing instructions for equality * Compares two processing instructions for equality
* *
* Example: * Example:
@ -1612,7 +1614,7 @@ class ProcessingInstruction : Item
return t !is null && content == t.content; return t !is null && content == t.content;
} }
/** /*
* Compares two processing instructions * Compares two processing instructions
* *
* You should rarely need to call this function. It exists so that * You should rarely need to call this function. It exists so that
@ -1632,7 +1634,7 @@ class ProcessingInstruction : Item
&& (content != t.content ? (content < t.content ? -1 : 1 ) : 0 ); && (content != t.content ? (content < t.content ? -1 : 1 ) : 0 );
} }
/** /*
* Returns the hash of a ProcessingInstruction * Returns the hash of a ProcessingInstruction
* *
* You should rarely need to call this function. It exists so that * You should rarely need to call this function. It exists so that
@ -1640,32 +1642,32 @@ class ProcessingInstruction : Item
*/ */
override size_t toHash() scope const nothrow { return hash(content); } override size_t toHash() scope const nothrow { return hash(content); }
/** /*
* Returns a string representation of this ProcessingInstruction * Returns a string representation of this ProcessingInstruction
*/ */
override string toString() scope const @safe pure nothrow { return "<?" ~ content ~ "?>"; } override string toString() scope const @safe pure nothrow { return "<?" ~ content ~ "?>"; }
override @property @safe @nogc pure nothrow bool isEmptyXML() scope const { return false; } /// Returns false always override @property @safe @nogc pure nothrow bool isEmptyXML() scope const { return false; } // Returns false always
} }
/** /*
* Abstract base class for XML items * Abstract base class for XML items
*/ */
abstract class Item abstract class Item
{ {
/// Compares with another Item of same type for equality // Compares with another Item of same type for equality
abstract override bool opEquals(scope const Object o) @safe const; abstract override bool opEquals(scope const Object o) @safe const;
/// Compares with another Item of same type // Compares with another Item of same type
abstract override int opCmp(scope const Object o) @safe const; abstract override int opCmp(scope const Object o) @safe const;
/// Returns the hash of this item // Returns the hash of this item
abstract override size_t toHash() @safe scope const; abstract override size_t toHash() @safe scope const;
/// Returns a string representation of this item // Returns a string representation of this item
abstract override string toString() @safe scope const; abstract override string toString() @safe scope const;
/** /*
* Returns an indented string representation of this item * Returns an indented string representation of this item
* *
* Params: * Params:
@ -1678,11 +1680,11 @@ abstract class Item
return s.length == 0 ? [] : [ s ]; return s.length == 0 ? [] : [ s ];
} }
/// Returns true if the item represents empty XML text // Returns true if the item represents empty XML text
abstract @property @safe @nogc pure nothrow bool isEmptyXML() scope const; abstract @property @safe @nogc pure nothrow bool isEmptyXML() scope const;
} }
/** /*
* Class for parsing an XML Document. * Class for parsing an XML Document.
* *
* This is a subclass of ElementParser. Most of the useful functions are * This is a subclass of ElementParser. Most of the useful functions are
@ -1700,7 +1702,7 @@ class DocumentParser : ElementParser
{ {
string xmlText; string xmlText;
/** /*
* Constructs a DocumentParser. * Constructs a DocumentParser.
* *
* The input to this function MUST be valid XML. * The input to this function MUST be valid XML.
@ -1742,7 +1744,7 @@ class DocumentParser : ElementParser
assert(doc.items == doc.elements); assert(doc.items == doc.elements);
} }
/** /*
* Class for parsing an XML element. * Class for parsing an XML element.
* *
* Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0) * Standards: $(LINK2 http://www.w3.org/TR/1998/REC-xml-19980210, XML 1.0)
@ -1789,13 +1791,13 @@ class ElementParser
} }
} }
/** /*
* The Tag at the start of the element being parsed. You can read this to * The Tag at the start of the element being parsed. You can read this to
* determine the tag's name and attributes. * determine the tag's name and attributes.
*/ */
@property @safe @nogc pure nothrow const(Tag) tag() const { return tag_; } @property @safe @nogc pure nothrow const(Tag) tag() const { return tag_; }
/** /*
* Register a handler which will be called whenever a start tag is * Register a handler which will be called whenever a start tag is
* encountered which matches the specified name. You can also pass null as * encountered which matches the specified name. You can also pass null as
* the name, in which case the handler will be called for any unmatched * the name, in which case the handler will be called for any unmatched
@ -1831,7 +1833,7 @@ class ElementParser
*/ */
ParserHandler[string] onStartTag; ParserHandler[string] onStartTag;
/** /*
* Register a handler which will be called whenever an end tag is * Register a handler which will be called whenever an end tag is
* encountered which matches the specified name. You can also pass null as * encountered which matches the specified name. You can also pass null as
* the name, in which case the handler will be called for any unmatched * the name, in which case the handler will be called for any unmatched
@ -1867,7 +1869,7 @@ class ElementParser
elementStart = *s; elementStart = *s;
} }
/** /*
* Register a handler which will be called whenever text is encountered. * Register a handler which will be called whenever text is encountered.
* *
* Example: * Example:
@ -1887,7 +1889,7 @@ class ElementParser
*/ */
@property @safe @nogc pure nothrow void onText(Handler handler) { textHandler = handler; } @property @safe @nogc pure nothrow void onText(Handler handler) { textHandler = handler; }
/** /*
* Register an alternative handler which will be called whenever text * Register an alternative handler which will be called whenever text
* is encountered. This differs from onText in that onText will decode * is encountered. This differs from onText in that onText will decode
* the text, whereas onTextRaw will not. This allows you to make design * the text, whereas onTextRaw will not. This allows you to make design
@ -1913,7 +1915,7 @@ class ElementParser
*/ */
@safe @nogc pure nothrow void onTextRaw(Handler handler) { rawTextHandler = handler; } @safe @nogc pure nothrow void onTextRaw(Handler handler) { rawTextHandler = handler; }
/** /*
* Register a handler which will be called whenever a character data * Register a handler which will be called whenever a character data
* segment is encountered. * segment is encountered.
* *
@ -1934,7 +1936,7 @@ class ElementParser
*/ */
@property @safe @nogc pure nothrow void onCData(Handler handler) { cdataHandler = handler; } @property @safe @nogc pure nothrow void onCData(Handler handler) { cdataHandler = handler; }
/** /*
* Register a handler which will be called whenever a comment is * Register a handler which will be called whenever a comment is
* encountered. * encountered.
* *
@ -1955,7 +1957,7 @@ class ElementParser
*/ */
@property @safe @nogc pure nothrow void onComment(Handler handler) { commentHandler = handler; } @property @safe @nogc pure nothrow void onComment(Handler handler) { commentHandler = handler; }
/** /*
* Register a handler which will be called whenever a processing * Register a handler which will be called whenever a processing
* instruction is encountered. * instruction is encountered.
* *
@ -1976,7 +1978,7 @@ class ElementParser
*/ */
@property @safe @nogc pure nothrow void onPI(Handler handler) { piHandler = handler; } @property @safe @nogc pure nothrow void onPI(Handler handler) { piHandler = handler; }
/** /*
* Register a handler which will be called whenever an XML instruction is * Register a handler which will be called whenever an XML instruction is
* encountered. * encountered.
* *
@ -1999,7 +2001,7 @@ class ElementParser
*/ */
@property @safe @nogc pure nothrow void onXI(Handler handler) { xiHandler = handler; } @property @safe @nogc pure nothrow void onXI(Handler handler) { xiHandler = handler; }
/** /*
* Parse an XML element. * Parse an XML element.
* *
* Parsing will continue until the end of the current element. Any items * Parsing will continue until the end of the current element. Any items
@ -2137,7 +2139,7 @@ class ElementParser
} }
} }
/** /*
* Returns that part of the element which has already been parsed * Returns that part of the element which has already been parsed
*/ */
override string toString() const @nogc @safe pure nothrow override string toString() const @nogc @safe pure nothrow
@ -2723,7 +2725,7 @@ private
} }
} }
/** /*
* Check an entire XML document for well-formedness * Check an entire XML document for well-formedness
* *
* Params: * Params:
@ -2865,57 +2867,57 @@ EOS";
assert(doc.toString() == s); assert(doc.toString() == s);
} }
/** The base class for exceptions thrown by this module */ /* The base class for exceptions thrown by this module */
class XMLException : Exception { this(string msg) @safe pure { super(msg); } } class XMLException : Exception { this(string msg) @safe pure { super(msg); } }
// Other exceptions // Other exceptions
/// Thrown during Comment constructor // Thrown during Comment constructor
class CommentException : XMLException class CommentException : XMLException
{ private this(string msg) @safe pure { super(msg); } } { private this(string msg) @safe pure { super(msg); } }
/// Thrown during CData constructor // Thrown during CData constructor
class CDataException : XMLException class CDataException : XMLException
{ private this(string msg) @safe pure { super(msg); } } { private this(string msg) @safe pure { super(msg); } }
/// Thrown during XMLInstruction constructor // Thrown during XMLInstruction constructor
class XIException : XMLException class XIException : XMLException
{ private this(string msg) @safe pure { super(msg); } } { private this(string msg) @safe pure { super(msg); } }
/// Thrown during ProcessingInstruction constructor // Thrown during ProcessingInstruction constructor
class PIException : XMLException class PIException : XMLException
{ private this(string msg) @safe pure { super(msg); } } { private this(string msg) @safe pure { super(msg); } }
/// Thrown during Text constructor // Thrown during Text constructor
class TextException : XMLException class TextException : XMLException
{ private this(string msg) @safe pure { super(msg); } } { private this(string msg) @safe pure { super(msg); } }
/// Thrown during decode() // Thrown during decode()
class DecodeException : XMLException class DecodeException : XMLException
{ private this(string msg) @safe pure { super(msg); } } { private this(string msg) @safe pure { super(msg); } }
/// Thrown if comparing with wrong type // Thrown if comparing with wrong type
class InvalidTypeException : XMLException class InvalidTypeException : XMLException
{ private this(string msg) @safe pure { super(msg); } } { private this(string msg) @safe pure { super(msg); } }
/// Thrown when parsing for Tags // Thrown when parsing for Tags
class TagException : XMLException class TagException : XMLException
{ private this(string msg) @safe pure { super(msg); } } { private this(string msg) @safe pure { super(msg); } }
/** /*
* Thrown during check() * Thrown during check()
*/ */
class CheckException : XMLException class CheckException : XMLException
{ {
CheckException err; /// Parent in hierarchy CheckException err; // Parent in hierarchy
private string tail; private string tail;
/** /*
* Name of production rule which failed to parse, * Name of production rule which failed to parse,
* or specific error message * or specific error message
*/ */
string msg; string msg;
size_t line = 0; /// Line number at which parse failure occurred size_t line = 0; // Line number at which parse failure occurred
size_t column = 0; /// Column number at which parse failure occurred size_t column = 0; // Column number at which parse failure occurred
private this(string tail,string msg,Err err=null) @safe pure private this(string tail,string msg,Err err=null) @safe pure
{ {