Used to build a tree of elements representing an XML document. More...
#include <juce_XmlElement.h>
Classes | |
struct | GetNextElement |
struct | GetNextElementWithTagName |
class | Iterator |
struct | TextFormat |
A struct containing options for formatting the text when representing an XML element as a string. More... | |
struct | XmlAttributeNode |
Public Member Functions | |
XmlElement (const char *tagName) | |
Creates an XmlElement with this tag name. More... | |
XmlElement (const Identifier &tagName) | |
Creates an XmlElement with this tag name. More... | |
XmlElement (const String &tagName) | |
Creates an XmlElement with this tag name. More... | |
XmlElement (const XmlElement &) | |
Creates a (deep) copy of another element. More... | |
XmlElement (String::CharPointerType tagNameBegin, String::CharPointerType tagNameEnd) | |
Creates an XmlElement with this tag name. More... | |
XmlElement (StringRef tagName) | |
Creates an XmlElement with this tag name. More... | |
XmlElement (XmlElement &&) noexcept | |
Move constructor. More... | |
~XmlElement () noexcept | |
Deleting an XmlElement will also delete all of its child elements. More... | |
void | addChildElement (XmlElement *newChildElement) noexcept |
Appends an element to this element's list of children. More... | |
void | addTextElement (const String &text) |
Appends a section of text to this element. More... | |
bool | compareAttribute (StringRef attributeName, StringRef stringToCompareAgainst, bool ignoreCase=false) const noexcept |
Compares the value of a named attribute with a value passed-in. More... | |
bool | containsChildElement (const XmlElement *possibleChild) const noexcept |
Returns true if the given element is a child of this one. More... | |
XmlElement * | createNewChildElement (StringRef tagName) |
Creates a new element with the given name and returns it, after adding it as a child element. More... | |
void | deleteAllChildElements () noexcept |
Deletes all the child elements in the element. More... | |
void | deleteAllChildElementsWithTagName (StringRef tagName) noexcept |
Deletes all the child elements with a given tag name. More... | |
void | deleteAllTextElements () noexcept |
Removes all the text elements from this element. More... | |
XmlElement * | findParentElementOf (const XmlElement *childToSearchFor) noexcept |
Recursively searches all sub-elements of this one, looking for an element which is the direct parent of the specified element. More... | |
String | getAllSubText () const |
Returns all the text from this element's child nodes. More... | |
const String & | getAttributeName (int attributeIndex) const noexcept |
Returns the name of one of the elements attributes. More... | |
const String & | getAttributeValue (int attributeIndex) const noexcept |
Returns the value of one of the elements attributes. More... | |
bool | getBoolAttribute (StringRef attributeName, bool defaultReturnValue=false) const |
Returns the value of a named attribute as a boolean. More... | |
XmlElement * | getChildByAttribute (StringRef attributeName, StringRef attributeValue) const noexcept |
Returns the first sub-element which has an attribute that matches the given value. More... | |
XmlElement * | getChildByName (StringRef tagNameToLookFor) const noexcept |
Returns the first sub-element with a given tag-name. More... | |
XmlElement * | getChildElement (int index) const noexcept |
Returns the sub-element at a certain index. More... | |
String | getChildElementAllSubText (StringRef childTagName, const String &defaultReturnValue) const |
Returns all the sub-text of a named child element. More... | |
Iterator< GetNextElement > | getChildIterator () const |
Allows iterating the children of an XmlElement using range-for syntax. More... | |
Iterator< GetNextElementWithTagName > | getChildWithTagNameIterator (StringRef name) const |
Allows iterating children of an XmlElement with a specific tag using range-for syntax. More... | |
double | getDoubleAttribute (StringRef attributeName, double defaultReturnValue=0.0) const |
Returns the value of a named attribute as floating-point. More... | |
XmlElement * | getFirstChildElement () const noexcept |
Returns the first of this element's sub-elements. More... | |
int | getIntAttribute (StringRef attributeName, int defaultReturnValue=0) const |
Returns the value of a named attribute as an integer. More... | |
String | getNamespace () const |
Returns the namespace portion of the tag-name, or an empty string if none is specified. More... | |
XmlElement * | getNextElement () const noexcept |
Returns the next of this element's siblings. More... | |
XmlElement * | getNextElementWithTagName (StringRef requiredTagName) const |
Returns the next of this element's siblings which has the specified tag name. More... | |
int | getNumAttributes () const noexcept |
Returns the number of XML attributes this element contains. More... | |
int | getNumChildElements () const noexcept |
Returns the number of sub-elements in this element. More... | |
const String & | getStringAttribute (StringRef attributeName) const noexcept |
Returns the value of a named attribute. More... | |
String | getStringAttribute (StringRef attributeName, const String &defaultReturnValue) const |
Returns the value of a named attribute. More... | |
const String & | getTagName () const noexcept |
Returns this element's tag type name. More... | |
String | getTagNameWithoutNamespace () const |
Returns the part of the tag-name that follows any namespace declaration. More... | |
const String & | getText () const noexcept |
Returns the text for a text element. More... | |
bool | hasAttribute (StringRef attributeName) const noexcept |
Checks whether the element contains an attribute with a certain name. More... | |
bool | hasTagName (StringRef possibleTagName) const noexcept |
Tests whether this element has a particular tag name. More... | |
bool | hasTagNameIgnoringNamespace (StringRef possibleTagName) const |
Tests whether this element has a particular tag name, ignoring any XML namespace prefix. More... | |
void | insertChildElement (XmlElement *newChildElement, int indexToInsertAt) noexcept |
Inserts an element into this element's list of children. More... | |
bool | isEquivalentTo (const XmlElement *other, bool ignoreOrderOfAttributes) const noexcept |
Compares two XmlElements to see if they contain the same text and attributes. More... | |
bool | isTextElement () const noexcept |
Returns true if this element is a section of text. More... | |
XmlElement & | operator= (const XmlElement &) |
Creates a (deep) copy of another element. More... | |
XmlElement & | operator= (XmlElement &&) noexcept |
Move assignment operator. More... | |
void | prependChildElement (XmlElement *newChildElement) noexcept |
Inserts an element at the beginning of this element's list of children. More... | |
void | removeAllAttributes () noexcept |
Removes all attributes from this element. More... | |
void | removeAttribute (const Identifier &attributeName) noexcept |
Removes a named attribute from the element. More... | |
void | removeChildElement (XmlElement *childToRemove, bool shouldDeleteTheChild) noexcept |
Removes a child element. More... | |
bool | replaceChildElement (XmlElement *currentChildElement, XmlElement *newChildNode) noexcept |
Replaces one of this element's children with another node. More... | |
void | setAttribute (const Identifier &attributeName, const String &newValue) |
Adds a named attribute to the element. More... | |
void | setAttribute (const Identifier &attributeName, double newValue) |
Adds a named attribute to the element, setting it to a floating-point value. More... | |
void | setAttribute (const Identifier &attributeName, int newValue) |
Adds a named attribute to the element, setting it to an integer value. More... | |
void | setTagName (StringRef newTagName) |
Changes this elements tag name. More... | |
void | setText (const String &newText) |
Sets the text in a text element. More... | |
template<class ElementComparator > | |
void | sortChildElements (ElementComparator &comparator, bool retainOrderOfEquivalentItems=false) |
Sorts the child elements using a comparator. More... | |
String | toString (const TextFormat &format={}) const |
Returns a text version of this XML element. More... | |
bool | writeTo (const File &destinationFile, const TextFormat &format={}) const |
Writes the document to a file as UTF-8. More... | |
void | writeTo (OutputStream &output, const TextFormat &format={}) const |
Writes the document to a stream as UTF-8. More... | |
Static Public Member Functions | |
static XmlElement * | createTextElement (const String &text) |
Creates a text element that can be added to a parent element. More... | |
static bool | isValidXmlName (StringRef possibleName) noexcept |
Checks if a given string is a valid XML name. More... | |
Private Member Functions | |
XmlElement (const wchar_t *)=delete | |
XmlElement (int) noexcept | |
void | copyChildrenAndAttributesFrom (const XmlElement &) |
XmlAttributeNode * | getAttribute (StringRef) const noexcept |
void | getChildElementsAsArray (XmlElement **) const noexcept |
void | reorderChildElements (XmlElement **, int) noexcept |
void | writeElementAsText (OutputStream &, int, int, const char *) const |
Private Attributes | |
LinkedListPointer< XmlAttributeNode > | attributes |
LinkedListPointer< XmlElement > | firstChildElement |
LinkedListPointer< XmlElement > | nextListItem |
String | tagName |
Friends | |
class | LinkedListPointer< XmlAttributeNode > |
class | LinkedListPointer< XmlElement > |
class | LinkedListPointer< XmlElement >::Appender |
class | NamedValueSet |
class | XmlDocument |
Used to build a tree of elements representing an XML document.
An XML document can be parsed into a tree of XmlElements, each of which represents an XML tag structure, and which may itself contain other nested elements.
An XmlElement can also be converted back into a text document, and has lots of useful methods for manipulating its attributes and sub-elements, so XmlElements can actually be used as a handy general-purpose data structure.
Here's an example of parsing some elements:
And here's an example of how to create an XML document from scratch:
@tags{Core}
|
explicit |
Creates an XmlElement with this tag name.
|
explicit |
Creates an XmlElement with this tag name.
|
explicit |
Creates an XmlElement with this tag name.
|
explicit |
Creates an XmlElement with this tag name.
juce::XmlElement::XmlElement | ( | String::CharPointerType | tagNameBegin, |
String::CharPointerType | tagNameEnd | ||
) |
Creates an XmlElement with this tag name.
juce::XmlElement::XmlElement | ( | const XmlElement & | ) |
Creates a (deep) copy of another element.
|
noexcept |
Move constructor.
|
noexcept |
Deleting an XmlElement will also delete all of its child elements.
|
privatenoexcept |
|
privatedelete |
|
noexcept |
Appends an element to this element's list of children.
Child elements are deleted automatically when their parent is deleted, so make sure the object that you pass in will not be deleted by anything else, and make sure it's not already the child of another element.
Note that due to the XmlElement using a singly-linked-list, prependChildElement() is an O(1) operation, but addChildElement() is an O(N) operation - so if you're adding large number of elements, you may prefer to do so in reverse order!
void juce::XmlElement::addTextElement | ( | const String & | text | ) |
Appends a section of text to this element.
|
noexcept |
Compares the value of a named attribute with a value passed-in.
attributeName | the name of the attribute to look up |
stringToCompareAgainst | the value to compare it with |
ignoreCase | whether the comparison should be case-insensitive |
|
noexcept |
Returns true if the given element is a child of this one.
|
private |
XmlElement* juce::XmlElement::createNewChildElement | ( | StringRef | tagName | ) |
Creates a new element with the given name and returns it, after adding it as a child element.
This is a handy method that means that instead of writing this:
..you could just write this:
|
static |
Creates a text element that can be added to a parent element.
|
noexcept |
Deletes all the child elements in the element.
|
noexcept |
Deletes all the child elements with a given tag name.
|
noexcept |
Removes all the text elements from this element.
|
noexcept |
Recursively searches all sub-elements of this one, looking for an element which is the direct parent of the specified element.
Because elements don't store a pointer to their parent, if you have one and need to find its parent, the only way to do so is to exhaustively search the whole tree for it.
If the given child is found somewhere in this element's hierarchy, then this method will return its parent. If not, it will return nullptr.
String juce::XmlElement::getAllSubText | ( | ) | const |
Returns all the text from this element's child nodes.
This iterates all the child elements and when it finds text elements, it concatenates their text into a big string which it returns.
E.g.
if you called getAllSubText on the "xyz" element, it'd return "hello there world".
Note that leading and trailing whitespace will be included in the string - to remove if, just call String::trim() on the result.
|
privatenoexcept |
Returns the name of one of the elements attributes.
E.g. for an element such as <MOOSE legs="4" antlers="2">, then getAttributeName(1) would return "antlers".
Returns the value of one of the elements attributes.
E.g. for an element such as <MOOSE legs="4" antlers="2">, then getAttributeName(1) would return "2".
bool juce::XmlElement::getBoolAttribute | ( | StringRef | attributeName, |
bool | defaultReturnValue = false |
||
) | const |
Returns the value of a named attribute as a boolean.
This will try to find the attribute and interpret it as a boolean. To do this, it'll return true if the value is "1", "true", "y", etc, or false for other values.
attributeName | the name of the attribute to look up |
defaultReturnValue | a value to return if the element doesn't have an attribute with this name |
|
noexcept |
Returns the first sub-element which has an attribute that matches the given value.
attributeName | the name of the attribute to check |
attributeValue | the target value of the attribute |
|
noexcept |
Returns the first sub-element with a given tag-name.
tagNameToLookFor | the tag name of the element you want to find |
|
noexcept |
Returns the sub-element at a certain index.
It's not very efficient to iterate the sub-elements by index - see getNextElement() for an example of how best to iterate.
String juce::XmlElement::getChildElementAllSubText | ( | StringRef | childTagName, |
const String & | defaultReturnValue | ||
) | const |
Returns all the sub-text of a named child element.
If there is a child element with the given tag name, this will return all of its sub-text (by calling getAllSubText() on it). If there is no such child element, this will return the default string passed-in.
|
privatenoexcept |
|
inline |
Allows iterating the children of an XmlElement using range-for syntax.
|
inline |
Allows iterating children of an XmlElement with a specific tag using range-for syntax.
References juce::gl::name.
double juce::XmlElement::getDoubleAttribute | ( | StringRef | attributeName, |
double | defaultReturnValue = 0.0 |
||
) | const |
Returns the value of a named attribute as floating-point.
This will try to find the attribute and convert it to a double (using the String::getDoubleValue() method).
attributeName | the name of the attribute to look up |
defaultReturnValue | a value to return if the element doesn't have an attribute with this name |
|
inlinenoexcept |
Returns the first of this element's sub-elements.
see getNextElement() for an example of how to iterate the sub-elements.
Returns the value of a named attribute as an integer.
This will try to find the attribute and convert it to an integer (using the String::getIntValue() method).
attributeName | the name of the attribute to look up |
defaultReturnValue | a value to return if the element doesn't have an attribute with this name |
String juce::XmlElement::getNamespace | ( | ) | const |
Returns the namespace portion of the tag-name, or an empty string if none is specified.
|
inlinenoexcept |
Returns the next of this element's siblings.
This can be used for iterating an element's sub-elements, e.g.
Note that when iterating the child elements, some of them might be text elements as well as XML tags - use isTextElement() to work this out.
Also, it's much easier and neater to use this method indirectly via the getChildIterator() method.
Referenced by juce::XmlElement::GetNextElement::getNext().
XmlElement* juce::XmlElement::getNextElementWithTagName | ( | StringRef | requiredTagName | ) | const |
Returns the next of this element's siblings which has the specified tag name.
This is like getNextElement(), but will scan through the list until it finds an element with the given tag name.
Referenced by juce::XmlElement::GetNextElementWithTagName::getNext().
|
noexcept |
Returns the number of XML attributes this element contains.
E.g. for an element such as <MOOSE legs="4" antlers="2">, this would return 2.
|
noexcept |
Returns the number of sub-elements in this element.
Returns the value of a named attribute.
attributeName | the name of the attribute to look up |
String juce::XmlElement::getStringAttribute | ( | StringRef | attributeName, |
const String & | defaultReturnValue | ||
) | const |
Returns the value of a named attribute.
attributeName | the name of the attribute to look up |
defaultReturnValue | a value to return if the element doesn't have an attribute with this name |
|
inlinenoexcept |
Returns this element's tag type name.
E.g. for an element such as <MOOSE legs="4" antlers="2">, this would return "MOOSE".
String juce::XmlElement::getTagNameWithoutNamespace | ( | ) | const |
Returns the part of the tag-name that follows any namespace declaration.
|
noexcept |
Returns the text for a text element.
Note that if you have an element like this:
then calling getText on the "xyz" element won't return "hello", because that is actually stored in a special text sub-element inside the xyz element. To get the "hello" string, you could either call getText on the (unnamed) sub-element, or use getAllSubText() to do this automatically.
Note that leading and trailing whitespace will be included in the string - to remove if, just call String::trim() on the result.
Checks whether the element contains an attribute with a certain name.
Tests whether this element has a particular tag name.
possibleTagName | the tag name you're comparing it with |
Tests whether this element has a particular tag name, ignoring any XML namespace prefix.
So a test for e.g. "xyz" will return true for "xyz" and also "foo:xyz", "bar::xyz", etc.
|
noexcept |
Inserts an element into this element's list of children.
Child elements are deleted automatically when their parent is deleted, so make sure the object that you pass in will not be deleted by anything else, and make sure it's not already the child of another element.
newChildElement | the element to add |
indexToInsertAt | the index at which to insert the new element - if this is below zero, it will be added to the end of the list |
|
noexcept |
Compares two XmlElements to see if they contain the same text and attributes.
The elements are only considered equivalent if they contain the same attributes with the same values, and have the same sub-nodes.
other | the other element to compare to |
ignoreOrderOfAttributes | if true, this means that two elements with the same attributes in a different order will be considered the same; if false, the attributes must be in the same order as well |
|
noexcept |
Returns true if this element is a section of text.
Elements can either be an XML tag element or a section of text, so this is used to find out what kind of element this one is.
Checks if a given string is a valid XML name.
XmlElement& juce::XmlElement::operator= | ( | const XmlElement & | ) |
Creates a (deep) copy of another element.
|
noexcept |
Move assignment operator.
|
noexcept |
Inserts an element at the beginning of this element's list of children.
Child elements are deleted automatically when their parent is deleted, so make sure the object that you pass in will not be deleted by anything else, and make sure it's not already the child of another element.
Note that due to the XmlElement using a singly-linked-list, prependChildElement() is an O(1) operation, but addChildElement() is an O(N) operation - so if you're adding large number of elements, you may prefer to do so in reverse order!
|
noexcept |
Removes all attributes from this element.
|
noexcept |
Removes a named attribute from the element.
attributeName | the name of the attribute to remove |
|
noexcept |
Removes a child element.
childToRemove | the child to look for and remove |
shouldDeleteTheChild | if true, the child will be deleted, if false it'll just remove it |
|
privatenoexcept |
|
noexcept |
Replaces one of this element's children with another node.
If the current element passed-in isn't actually a child of this element, this will return false and the new one won't be added. Otherwise, the existing element will be deleted, replaced with the new one, and it will return true.
void juce::XmlElement::setAttribute | ( | const Identifier & | attributeName, |
const String & | newValue | ||
) |
Adds a named attribute to the element.
If the element already contains an attribute with this name, it's value will be updated to the new value. If there's no such attribute yet, a new one will be added.
Note that there are other setAttribute() methods that take integers, doubles, etc. to make it easy to store numbers.
attributeName | the name of the attribute to set |
newValue | the value to set it to |
void juce::XmlElement::setAttribute | ( | const Identifier & | attributeName, |
double | newValue | ||
) |
Adds a named attribute to the element, setting it to a floating-point value.
If the element already contains an attribute with this name, it's value will be updated to the new value. If there's no such attribute yet, a new one will be added.
Note that there are other setAttribute() methods that take integers, doubles, etc. to make it easy to store numbers.
attributeName | the name of the attribute to set |
newValue | the value to set it to |
void juce::XmlElement::setAttribute | ( | const Identifier & | attributeName, |
int | newValue | ||
) |
Adds a named attribute to the element, setting it to an integer value.
If the element already contains an attribute with this name, it's value will be updated to the new value. If there's no such attribute yet, a new one will be added.
Note that there are other setAttribute() methods that take integers, doubles, etc. to make it easy to store numbers.
attributeName | the name of the attribute to set |
newValue | the value to set it to |
void juce::XmlElement::setTagName | ( | StringRef | newTagName | ) |
Changes this elements tag name.
void juce::XmlElement::setText | ( | const String & | newText | ) |
Sets the text in a text element.
Note that this is only a valid call if this element is a text element. If it's not, then no action will be performed. If you're trying to add text inside a normal element, you probably want to use addTextElement() instead.
|
inline |
Sorts the child elements using a comparator.
This will use a comparator object to sort the elements into order. The object passed must have a method of the form:
..and this method must return:
To improve performance, the compareElements() method can be declared as static or const.
comparator | the comparator to use for comparing elements. |
retainOrderOfEquivalentItems | if this is true, then items which the comparator says are equivalent will be kept in the order in which they currently appear in the array. This is slower to perform, but may be important in some cases. If it's false, a faster algorithm is used, but equivalent elements may be rearranged. |
References juce::gl::num, and juce::sortArray().
String juce::XmlElement::toString | ( | const TextFormat & | format = {} | ) | const |
|
private |
bool juce::XmlElement::writeTo | ( | const File & | destinationFile, |
const TextFormat & | format = {} |
||
) | const |
void juce::XmlElement::writeTo | ( | OutputStream & | output, |
const TextFormat & | format = {} |
||
) | const |
|
friend |
|
friend |
|
friend |
|
friend |
|
friend |
|
private |
|
private |
|
private |
|
private |