xml.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _LOG4CXX_HELPERS_XML_H
#define _LOG4CXX_HELPERS_XML_H

#if defined(_MSC_VER)
    #pragma warning ( push )
    #pragma warning ( disable: 4231 4251 4275 4786 )
#endif


#include <log4cxx/logstring.h>
#include <log4cxx/helpers/object.h>
#include <log4cxx/helpers/exception.h>

namespace log4cxx
{
class File;
namespace helpers
{
class XMLDOMNode;
typedef std::shared_ptr<XMLDOMNode> XMLDOMNodePtr;

class XMLDOMDocument;
typedef std::shared_ptr<XMLDOMDocument> XMLDOMDocumentPtr;

class XMLDOMNodeList;
typedef std::shared_ptr<XMLDOMNodeList> XMLDOMNodeListPtr;

class LOG4CXX_EXPORT DOMException : public RuntimeException
{
    public:
        DOMException() : RuntimeException(LOG4CXX_STR("DOM exception")) {}
};


class LOG4CXX_EXPORT XMLDOMNode : virtual public Object
{
    public:
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(XMLDOMNode)
        enum XMLDOMNodeType
        {
            NOT_IMPLEMENTED_NODE = 0,
            ELEMENT_NODE = 1,
            DOCUMENT_NODE = 9
        };

        virtual XMLDOMNodeListPtr getChildNodes() = 0;
        virtual XMLDOMNodeType getNodeType() = 0;
        virtual XMLDOMDocumentPtr getOwnerDocument() = 0;
};
LOG4CXX_PTR_DEF(XMLDOMNode);


class LOG4CXX_EXPORT XMLDOMElement : virtual public XMLDOMNode
{
    public:
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(XMLDOMElement)
        virtual LogString getTagName() = 0;
        virtual LogString getAttribute(const LogString& name) = 0;
};
LOG4CXX_PTR_DEF(XMLDOMElement);

class LOG4CXX_EXPORT XMLDOMDocument : virtual public XMLDOMNode
{
    public:
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(XMLDOMDocument)
        virtual void load(const File& fileName) = 0;
        virtual XMLDOMElementPtr getDocumentElement() = 0;
        virtual XMLDOMElementPtr getElementById(const LogString& tagName,
            const LogString& elementId) = 0;
};
LOG4CXX_PTR_DEF(XMLDOMDocument);

class LOG4CXX_EXPORT XMLDOMNodeList : virtual public Object
{
    public:
        DECLARE_ABSTRACT_LOG4CXX_OBJECT(XMLDOMNodeList)
        virtual int getLength() = 0;
        virtual XMLDOMNodePtr item(int index) = 0;
};
LOG4CXX_PTR_DEF(XMLDOMNodeList);
}  // namespace helpers
} // namespace log4cxx


#if defined(_MSC_VER)
    #pragma warning ( pop )
#endif

#endif // _LOG4CXX_HELPERS_XML_H