OpenShot Audio Library | OpenShotAudio 0.3.2
|
#include <juce_XmlElement.h>
Classes | |
struct | TextFormat |
Static Public Member Functions | |
static XmlElement * | createTextElement (const String &text) |
static bool | isValidXmlName (StringRef possibleName) noexcept |
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:
Definition at line 137 of file juce_XmlElement.h.
Creates an XmlElement with this tag name.
Definition at line 76 of file juce_XmlElement.cpp.
Creates an XmlElement with this tag name.
Definition at line 82 of file juce_XmlElement.cpp.
|
explicit |
Creates an XmlElement with this tag name.
Definition at line 94 of file juce_XmlElement.cpp.
|
explicit |
Creates an XmlElement with this tag name.
Definition at line 88 of file juce_XmlElement.cpp.
juce::XmlElement::XmlElement | ( | String::CharPointerType | tagNameBegin, |
String::CharPointerType | tagNameEnd | ||
) |
Creates an XmlElement with this tag name.
Definition at line 100 of file juce_XmlElement.cpp.
juce::XmlElement::XmlElement | ( | const XmlElement & | other | ) |
Creates a (deep) copy of another element.
Definition at line 110 of file juce_XmlElement.cpp.
|
noexcept |
Move constructor
Definition at line 129 of file juce_XmlElement.cpp.
|
noexcept |
Deleting an XmlElement will also delete all of its child elements.
Definition at line 161 of file juce_XmlElement.cpp.
|
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!
Definition at line 700 of file juce_XmlElement.cpp.
Referenced by addTextElement(), and createNewChildElement().
Appends a section of text to this element.
Definition at line 974 of file juce_XmlElement.cpp.
|
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 |
Definition at line 603 of file juce_XmlElement.cpp.
|
noexcept |
Returns true if the given element is a child of this one.
Definition at line 862 of file juce_XmlElement.cpp.
Referenced by removeChildElement().
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:
Definition at line 733 of file juce_XmlElement.cpp.
|
static |
Creates a text element that can be added to a parent element.
Definition at line 952 of file juce_XmlElement.cpp.
Referenced by addTextElement().
|
noexcept |
Deletes all the child elements in the element.
Definition at line 844 of file juce_XmlElement.cpp.
Referenced by operator=().
Deletes all the child elements with a given tag name.
Definition at line 849 of file juce_XmlElement.cpp.
|
noexcept |
Removes all the text elements from this element.
Definition at line 979 of file juce_XmlElement.cpp.
|
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.
Definition at line 867 of file juce_XmlElement.cpp.
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.
Definition at line 928 of file juce_XmlElement.cpp.
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".
Definition at line 524 of file juce_XmlElement.cpp.
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".
Definition at line 532 of file juce_XmlElement.cpp.
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 |
Definition at line 587 of file juce_XmlElement.cpp.
|
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 |
Definition at line 689 of file juce_XmlElement.cpp.
|
noexcept |
Returns the first sub-element with a given tag-name.
tagNameToLookFor | the tag name of the element you want to find |
Definition at line 678 of file juce_XmlElement.cpp.
Referenced by getChildElementAllSubText().
|
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.
Definition at line 673 of file juce_XmlElement.cpp.
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.
Definition at line 944 of file juce_XmlElement.cpp.
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 |
Definition at line 579 of file juce_XmlElement.cpp.
|
inlinenoexcept |
Returns the first of this element's sub-elements. see getNextElement() for an example of how to iterate the sub-elements.
Definition at line 405 of file juce_XmlElement.h.
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 |
Definition at line 571 of file juce_XmlElement.cpp.
String juce::XmlElement::getNamespace | ( | ) | const |
Returns the namespace portion of the tag-name, or an empty string if none is specified.
Definition at line 481 of file juce_XmlElement.cpp.
|
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 forEachXmlChildElement macro.
Definition at line 433 of file juce_XmlElement.h.
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.
Definition at line 496 of file juce_XmlElement.cpp.
|
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.
Definition at line 513 of file juce_XmlElement.cpp.
|
noexcept |
Returns the number of sub-elements in this element.
Definition at line 668 of file juce_XmlElement.cpp.
Referenced by getAllSubText().
Returns the value of a named attribute.
attributeName | the name of the attribute to look up |
Definition at line 555 of file juce_XmlElement.cpp.
Referenced by getText().
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 |
Definition at line 563 of file juce_XmlElement.cpp.
Returns this element's tag type name. E.g. for an element such as <MOOSE legs="4" antlers="2">, this would return "MOOSE".
Definition at line 228 of file juce_XmlElement.h.
Referenced by juce::ValueTree::fromXml().
String juce::XmlElement::getTagNameWithoutNamespace | ( | ) | const |
Returns the part of the tag-name that follows any namespace declaration.
Definition at line 486 of file juce_XmlElement.cpp.
Referenced by hasTagNameIgnoringNamespace().
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.
Definition at line 911 of file juce_XmlElement.cpp.
Referenced by getAllSubText().
Checks whether the element contains an attribute with a certain name.
Definition at line 549 of file juce_XmlElement.cpp.
Tests whether this element has a particular tag name.
possibleTagName | the tag name you're comparing it with |
Definition at line 470 of file juce_XmlElement.cpp.
Referenced by hasTagNameIgnoringNamespace(), and juce::AudioDeviceManager::initialise().
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.
Definition at line 491 of file juce_XmlElement.cpp.
|
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 |
Definition at line 711 of file juce_XmlElement.cpp.
|
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 |
Definition at line 771 of file juce_XmlElement.cpp.
|
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.
Definition at line 904 of file juce_XmlElement.cpp.
Referenced by juce::ValueTree::fromXml(), getAllSubText(), getText(), and setText().
Checks if a given string is a valid XML name
Definition at line 959 of file juce_XmlElement.cpp.
Referenced by setTagName(), XmlElement(), XmlElement(), XmlElement(), XmlElement(), and XmlElement().
juce::XmlElement::JUCE_DEPRECATED | ( | bool writeToFile(const File &destinationFile, StringRef dtdToUse, StringRef encodingType="UTF-8", int lineWrapLength=60) const | ) |
This has been deprecated in favour of the writeTo() method.
juce::XmlElement::JUCE_DEPRECATED | ( | String createDocument(StringRef dtdToUse, bool allOnOneLine=false, bool includeXmlHeader=true, StringRef encodingType="UTF-8", int lineWrapLength=60) const | ) |
This has been deprecated in favour of the toString() method.
juce::XmlElement::JUCE_DEPRECATED | ( | void writeToStream(OutputStream &output, StringRef dtdToUse, bool allOnOneLine=false, bool includeXmlHeader=true, StringRef encodingType="UTF-8", int lineWrapLength=60) const | ) |
This has been deprecated in favour of the writeTo() method.
XmlElement & juce::XmlElement::operator= | ( | const XmlElement & | other | ) |
Creates a (deep) copy of another element.
Definition at line 116 of file juce_XmlElement.cpp.
|
noexcept |
Move assignment operator
Definition at line 137 of file juce_XmlElement.cpp.
|
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!
Definition at line 722 of file juce_XmlElement.cpp.
|
noexcept |
Removes all attributes from this element.
Definition at line 662 of file juce_XmlElement.cpp.
Referenced by operator=().
|
noexcept |
Removes a named attribute from the element.
attributeName | the name of the attribute to remove |
Definition at line 650 of file juce_XmlElement.cpp.
|
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 |
Definition at line 757 of file juce_XmlElement.cpp.
Referenced by deleteAllChildElementsWithTagName(), and deleteAllTextElements().
|
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.
Definition at line 740 of file juce_XmlElement.cpp.
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 |
Definition at line 615 of file juce_XmlElement.cpp.
Referenced by juce::NetworkServiceDiscovery::Advertiser::Advertiser(), juce::NamedValueSet::copyToXmlAttributes(), setAttribute(), setAttribute(), and setText().
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 |
Definition at line 645 of file juce_XmlElement.cpp.
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 |
Definition at line 640 of file juce_XmlElement.cpp.
Changes this elements tag name.
Definition at line 506 of file juce_XmlElement.cpp.
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.
Definition at line 920 of file juce_XmlElement.cpp.
|
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. |
Definition at line 606 of file juce_XmlElement.h.
String juce::XmlElement::toString | ( | const TextFormat & | format = {} | ) | const |
Returns a text version of this XML element. If your intention is to write the XML to a file or stream, it's probably more efficient to use writeTo() instead of creating an intermediate string.
Definition at line 352 of file juce_XmlElement.cpp.
Referenced by juce::PropertySet::setValue().
bool juce::XmlElement::writeTo | ( | const File & | destinationFile, |
const TextFormat & | format = {} |
||
) | const |
Writes the document to a file as UTF-8.
Definition at line 407 of file juce_XmlElement.cpp.
void juce::XmlElement::writeTo | ( | OutputStream & | output, |
const TextFormat & | format = {} |
||
) | const |
Writes the document to a stream as UTF-8.
Definition at line 359 of file juce_XmlElement.cpp.
Referenced by toString(), and writeTo().