juce_XmlElement.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the juce_core module of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission to use, copy, modify, and/or distribute this software for any purpose with
   or without fee is hereby granted, provided that the above copyright notice and this
   permission notice appear in all copies.
 
   THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
   NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
   DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
   IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
   CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
   ------------------------------------------------------------------------------
 
   NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
   All other JUCE modules are covered by a dual GPL/commercial license, so if you are
   using any other modules, be sure to check that you also comply with their license.
 
   For more details, visit www.juce.com
 
  ==============================================================================
*/
 
#ifndef JUCE_XMLELEMENT_H_INCLUDED
#define JUCE_XMLELEMENT_H_INCLUDED
 
 
//==============================================================================
#define forEachXmlChildElement(parentXmlElement, childElementVariableName) \
\
    for (juce::XmlElement* childElementVariableName = (parentXmlElement).getFirstChildElement(); \
         childElementVariableName != nullptr; \
         childElementVariableName = childElementVariableName->getNextElement())
 
#define forEachXmlChildElementWithTagName(parentXmlElement, childElementVariableName, requiredTagName) \
\
    for (juce::XmlElement* childElementVariableName = (parentXmlElement).getChildByName (requiredTagName); \
         childElementVariableName != nullptr; \
         childElementVariableName = childElementVariableName->getNextElementWithTagName (requiredTagName))
 
 
//==============================================================================
class JUCE_API  XmlElement
{
public:
    //==============================================================================
    explicit XmlElement (const String& tagName);
 
    explicit XmlElement (const char* tagName);
 
    explicit XmlElement (const Identifier& tagName);
 
    explicit XmlElement (StringRef tagName);
 
    XmlElement (String::CharPointerType tagNameBegin, String::CharPointerType tagNameEnd);
 
    XmlElement (const XmlElement&);
 
    XmlElement& operator= (const XmlElement&);
 
   #if JUCE_COMPILER_SUPPORTS_MOVE_SEMANTICS
    XmlElement (XmlElement&&) noexcept;
    XmlElement& operator= (XmlElement&&) noexcept;
   #endif
 
    ~XmlElement() noexcept;
 
    //==============================================================================
    bool isEquivalentTo (const XmlElement* other,
                         bool ignoreOrderOfAttributes) const noexcept;
 
    //==============================================================================
    String createDocument (StringRef dtdToUse,
                           bool allOnOneLine = false,
                           bool includeXmlHeader = true,
                           StringRef encodingType = "UTF-8",
                           int lineWrapLength = 60) const;
 
    void writeToStream (OutputStream& output,
                        StringRef dtdToUse,
                        bool allOnOneLine = false,
                        bool includeXmlHeader = true,
                        StringRef encodingType = "UTF-8",
                        int lineWrapLength = 60) const;
 
    bool writeToFile (const File& destinationFile,
                      StringRef dtdToUse,
                      StringRef encodingType = "UTF-8",
                      int lineWrapLength = 60) const;
 
    //==============================================================================
    const String& getTagName() const noexcept            { return tagName; }
 
    String getNamespace() const;
 
    String getTagNameWithoutNamespace() const;
 
    bool hasTagName (StringRef possibleTagName) const noexcept;
 
    bool hasTagNameIgnoringNamespace (StringRef possibleTagName) const;
 
    //==============================================================================
    int getNumAttributes() const noexcept;
 
    const String& getAttributeName (int attributeIndex) const noexcept;
 
    const String& getAttributeValue (int attributeIndex) const noexcept;
 
    //==============================================================================
    // Attribute-handling methods..
 
    bool hasAttribute (StringRef attributeName) const noexcept;
 
    const String& getStringAttribute (StringRef attributeName) const noexcept;
 
    String getStringAttribute (StringRef attributeName, const String& defaultReturnValue) const;
 
    bool compareAttribute (StringRef attributeName,
                           StringRef stringToCompareAgainst,
                           bool ignoreCase = false) const noexcept;
 
    int getIntAttribute (StringRef attributeName, int defaultReturnValue = 0) const;
 
    double getDoubleAttribute (StringRef attributeName, double defaultReturnValue = 0.0) const;
 
    bool getBoolAttribute (StringRef attributeName, bool defaultReturnValue = false) const;
 
    void setAttribute (const Identifier& attributeName, const String& newValue);
 
    void setAttribute (const Identifier& attributeName, int newValue);
 
    void setAttribute (const Identifier& attributeName, double newValue);
 
    void removeAttribute (const Identifier& attributeName) noexcept;
 
    void removeAllAttributes() noexcept;
 
    //==============================================================================
    // Child element methods..
 
    XmlElement* getFirstChildElement() const noexcept       { return firstChildElement; }
 
    inline XmlElement* getNextElement() const noexcept          { return nextListItem; }
 
    XmlElement* getNextElementWithTagName (StringRef requiredTagName) const;
 
    int getNumChildElements() const noexcept;
 
    XmlElement* getChildElement (int index) const noexcept;
 
    XmlElement* getChildByName (StringRef tagNameToLookFor) const noexcept;
 
    XmlElement* getChildByAttribute (StringRef attributeName,
                                     StringRef attributeValue) const noexcept;
 
    //==============================================================================
    void addChildElement (XmlElement* newChildElement) noexcept;
 
    void insertChildElement (XmlElement* newChildElement,
                             int indexToInsertAt) noexcept;
 
    void prependChildElement (XmlElement* newChildElement) noexcept;
 
    XmlElement* createNewChildElement (StringRef tagName);
 
    bool replaceChildElement (XmlElement* currentChildElement,
                              XmlElement* newChildNode) noexcept;
 
    void removeChildElement (XmlElement* childToRemove,
                             bool shouldDeleteTheChild) noexcept;
 
    void deleteAllChildElements() noexcept;
 
    void deleteAllChildElementsWithTagName (StringRef tagName) noexcept;
 
    bool containsChildElement (const XmlElement* possibleChild) const noexcept;
 
    XmlElement* findParentElementOf (const XmlElement* childToSearchFor) noexcept;
 
    //==============================================================================
    template <class ElementComparator>
    void sortChildElements (ElementComparator& comparator,
                            bool retainOrderOfEquivalentItems = false)
    {
        const int num = getNumChildElements();
 
        if (num > 1)
        {
            HeapBlock <XmlElement*> elems ((size_t) num);
            getChildElementsAsArray (elems);
            sortArray (comparator, (XmlElement**) elems, 0, num - 1, retainOrderOfEquivalentItems);
            reorderChildElements (elems, num);
        }
    }
 
    //==============================================================================
    bool isTextElement() const noexcept;
 
    const String& getText() const noexcept;
 
    void setText (const String& newText);
 
    String getAllSubText() const;
 
    String getChildElementAllSubText (StringRef childTagName,
                                      const String& defaultReturnValue) const;
 
    void addTextElement (const String& text);
 
    void deleteAllTextElements() noexcept;
 
    static XmlElement* createTextElement (const String& text);
 
    //==============================================================================
private:
    struct XmlAttributeNode
    {
        XmlAttributeNode (const XmlAttributeNode&) noexcept;
        XmlAttributeNode (const Identifier&, const String&) noexcept;
        XmlAttributeNode (String::CharPointerType, String::CharPointerType);
 
        LinkedListPointer<XmlAttributeNode> nextListItem;
        Identifier name;
        String value;
 
    private:
        XmlAttributeNode& operator= (const XmlAttributeNode&) JUCE_DELETED_FUNCTION;
    };
 
    friend class XmlDocument;
    friend class LinkedListPointer<XmlAttributeNode>;
    friend class LinkedListPointer<XmlElement>;
    friend class LinkedListPointer<XmlElement>::Appender;
    friend class NamedValueSet;
 
    LinkedListPointer<XmlElement> nextListItem;
    LinkedListPointer<XmlElement> firstChildElement;
    LinkedListPointer<XmlAttributeNode> attributes;
    String tagName;
 
    XmlElement (int) noexcept;
    void copyChildrenAndAttributesFrom (const XmlElement&);
    void writeElementAsText (OutputStream&, int indentationLevel, int lineWrapLength) const;
    void getChildElementsAsArray (XmlElement**) const noexcept;
    void reorderChildElements (XmlElement**, int) noexcept;
    XmlAttributeNode* getAttribute (StringRef) const noexcept;
 
    // Sigh.. L"" or _T("") string literals are problematic in general, and really inappropriate
    // for XML tags. Use a UTF-8 encoded literal instead, or if you're really determined to use
    // UTF-16, cast it to a String and use the other constructor.
    XmlElement (const wchar_t*) JUCE_DELETED_FUNCTION;
 
    JUCE_LEAK_DETECTOR (XmlElement)
};
 
 
#endif   // JUCE_XMLELEMENT_H_INCLUDED