dom_node.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/


#pragma once

#include "../api_core.h"
#include "../System/sharedptr.h"
#include "dom_string.h"

class CL_DomElement;
class CL_DomAttr;
class CL_DomText;
class CL_DomCDATASection;
class CL_DomEntityReference;
class CL_DomEntity;
class CL_DomProcessingInstruction;
class CL_DomComment;
class CL_DomDocument;
class CL_DomDocumentType;
class CL_DomDocumentFragment;
class CL_DomNotation;
class CL_DomNodeList;
class CL_DomNamedNodeMap;
class CL_DomNode_Generic;

class CL_API_CORE CL_DomNode
{

public:
        CL_DomNode();

        CL_DomNode(const CL_DomNode &copy);

        ~CL_DomNode();


public:
        enum NodeType
        {
                NULL_NODE                     = 0,
                ELEMENT_NODE                  = 1,
                ATTRIBUTE_NODE                = 2,
                TEXT_NODE                     = 3,
                CDATA_SECTION_NODE            = 4,
                ENTITY_REFERENCE_NODE         = 5,
                ENTITY_NODE                   = 6,
                PROCESSING_INSTRUCTION_NODE   = 7,
                COMMENT_NODE                  = 8,
                DOCUMENT_NODE                 = 9,
                DOCUMENT_TYPE_NODE            = 10,
                DOCUMENT_FRAGMENT_NODE        = 11,
                NOTATION_NODE                 = 12
        };


        CL_DomString get_node_name() const;

        CL_DomString get_namespace_uri() const;


        CL_DomString get_prefix() const;


        void set_prefix(const CL_DomString &prefix);


        CL_DomString get_local_name() const;


        CL_DomString get_node_value() const;

        void set_node_value(const CL_DomString &value);

        unsigned short get_node_type() const;


        CL_DomNode get_parent_node() const;


        CL_DomNodeList get_child_nodes() const;


        CL_DomNode get_first_child() const;


        CL_DomNode get_last_child() const;


        CL_DomNode get_previous_sibling() const;


        CL_DomNode get_next_sibling() const;

        CL_DomNamedNodeMap get_attributes() const;


        CL_DomDocument get_owner_document() const;

        bool is_null() const;

        bool is_element() const;

        bool is_attr() const;

        bool is_text() const;

        bool is_cdata_section() const;

        bool is_entity_reference() const;

        bool is_entity() const;

        bool is_processing_instruction() const;

        bool is_comment() const;

        bool is_document() const;

        bool is_document_type() const;

        bool is_document_fragment() const;

        bool is_notation() const;

        bool is_supported(const CL_DomString &feature, const CL_DomString &version) const;

        bool has_attributes() const;

        bool has_child_nodes() const;


public:

        CL_DomNode &operator =(const CL_DomNode &copy);

        bool operator ==(const CL_DomNode &other) const;


        void normalize();


        CL_DomNode insert_before(CL_DomNode &new_child, CL_DomNode &ref_child);


        CL_DomNode replace_child(CL_DomNode &new_child, CL_DomNode &old_child);

        CL_DomNode remove_child(CL_DomNode &old_child);


        CL_DomNode append_child(CL_DomNode new_child);


        CL_DomNode clone_node(bool deep) const;


        CL_DomElement to_element() const;


        CL_DomAttr to_attr() const;


        CL_DomText to_text() const;


        CL_DomCDATASection to_cdata_section() const;


        CL_DomEntityReference to_entity_reference() const;


        CL_DomEntity to_entity() const;


        CL_DomProcessingInstruction to_processing_instruction() const;


        CL_DomComment to_comment() const;


        CL_DomDocument to_document() const;


        CL_DomDocumentType to_document_type() const;


        CL_DomDocumentFragment to_document_fragment() const;


        CL_DomNotation to_notation() const;


        CL_DomNode named_item(const CL_DomString &name) const;

        CL_DomNode named_item_ns(
                const CL_DomString &namespace_uri,
                const CL_DomString &local_name) const;

        CL_DomString find_namespace_uri(const CL_DomString &qualified_name) const;

        CL_DomString find_prefix(const CL_DomString &namespace_uri) const;

        std::vector<CL_DomNode> select_nodes(const CL_DomString &xpath_expression) const;

        CL_DomNode select_node(const CL_DomString &xpath_expression) const;

        CL_String select_string(const CL_DomString &xpath_expression) const;

        int select_int(const CL_DomString &xpath_expression) const;

        float select_float(const CL_DomString &xpath_expression) const;

        bool select_bool(const CL_DomString &xpath_expression) const;


protected:

        CL_DomNode(CL_DomDocument doc, unsigned short node_type);

        CL_DomNode(const CL_SharedPtr<CL_DomNode_Generic> &impl);

        CL_SharedPtr<CL_DomNode_Generic> impl;

        friend class CL_DomDocument;

        friend class CL_DomNamedNodeMap;
};

---