node.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */
 
#pragma once
 
#include <libxml/tree.h>
 
#include <sal/types.h>
#include <rtl/ref.hxx>
#include <rtl/string.hxx>
#include <rtl/ustring.hxx>
 
#include <cppuhelper/implbase.hxx>
 
#include <sax/fastattribs.hxx>
 
#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/uno/Sequence.h>
#include <com/sun/star/xml/dom/XNode.hpp>
#include <com/sun/star/xml/dom/XNodeList.hpp>
#include <com/sun/star/xml/dom/XNamedNodeMap.hpp>
#include <com/sun/star/xml/dom/NodeType.hpp>
#include <com/sun/star/xml/dom/events/XEventTarget.hpp>
#include <com/sun/star/xml/dom/events/XEvent.hpp>
#include <com/sun/star/xml/sax/XDocumentHandler.hpp>
#include <com/sun/star/xml/sax/XFastDocumentHandler.hpp>
 
#include <unordered_map>
 
namespace DOM
{
    struct Context
    {
        Context( const css::uno::Reference< css::xml::sax::XFastDocumentHandler >& i_xHandler,
                 sax_fastparser::FastTokenHandlerBase* pTokenHandler ) :
            maNamespaces( 1, std::vector<Namespace>() ),
            maNamespaceMap(101),
            mxAttribList(new sax_fastparser::FastAttributeList(pTokenHandler)),
            mxCurrentHandler(i_xHandler),
            mxDocHandler(i_xHandler),
            mxTokenHandler(pTokenHandler)
        {}
 
        struct Namespace
        {
            OString     maPrefix;
            sal_Int32   mnToken;
 
            const OString& getPrefix() const { return maPrefix; }
        };
 
        typedef std::vector< std::vector<Namespace> > NamespaceVectorType;
        typedef std::unordered_map< OUString, sal_Int32 > NamespaceMapType;
 
        NamespaceVectorType                 maNamespaces;
        NamespaceMapType                    maNamespaceMap;
        ::rtl::Reference<sax_fastparser::FastAttributeList> mxAttribList;
        css::uno::Reference<css::xml::sax::XFastContextHandler>      mxCurrentHandler;
        css::uno::Reference<css::xml::sax::XFastDocumentHandler>     mxDocHandler;
        rtl::Reference<sax_fastparser::FastTokenHandlerBase>         mxTokenHandler;
    };
 
    void pushContext(Context& io_rContext);
    void popContext(Context& io_rContext);
 
    sal_Int32 getTokenWithPrefix( const Context& rContext, const char* xPrefix, const char* xName );
    sal_Int32 getToken( const Context& rContext, const char* xName );
 
    void addNamespaces(Context& io_rContext, xmlNodePtr pNode);
 
    class CDocument;
 
    class SAL_LOPLUGIN_ANNOTATE("crosscast") CNode
        : public cppu::WeakImplHelper< css::xml::dom::XNode, css::xml::dom::events::XEventTarget >
    {
        friend class CDocument;
        friend class CElement;
        friend class CAttributesMap;
 
    private:
        bool m_bUnlinked; 
 
    protected:
        css::xml::dom::NodeType const m_aNodeType;
        xmlNodePtr m_aNodePtr;
 
        ::rtl::Reference< CDocument > const m_xDocument;
        ::osl::Mutex & m_rMutex;
 
        // for initialization by classes derived through ImplInheritanceHelper
        CNode(CDocument const& rDocument, ::osl::Mutex const& rMutex,
                css::xml::dom::NodeType const& reNodeType, xmlNodePtr const& rpNode);
        void invalidate();
 
        void dispatchSubtreeModified();
 
        void checkNoParent(css::uno::Reference< css::xml::dom::XNode >const& xNode);
 
        static void checkNoParent(const xmlNodePtr pNode);
 
        void checkSameOwner(css::uno::Reference< css::xml::dom::XNode >const& xNode);
 
    public:
 
        virtual ~CNode() override;
 
        xmlNodePtr GetNodePtr() { return m_aNodePtr; }
 
        virtual CDocument & GetOwnerDocument();
 
        // recursively create SAX events
        virtual void saxify(const css::uno::Reference< css::xml::sax::XDocumentHandler >& i_xHandler);
 
        // recursively create SAX events
        virtual void fastSaxify( Context& io_rContext );
 
        // constrains child relationship between nodes based on type
        virtual bool IsChildTypeAllowed(css::xml::dom::NodeType nodeType,
                css::xml::dom::NodeType const* pReplacedNodeType);
 
        // ---- DOM interfaces
 
        virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL
            appendChild(css::uno::Reference< css::xml::dom::XNode > const& xNewChild) override;
 
        virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL cloneNode(sal_Bool deep) override;
 
        virtual css::uno::Reference< css::xml::dom::XNamedNodeMap > SAL_CALL getAttributes() override;
 
        virtual css::uno::Reference< css::xml::dom::XNodeList > SAL_CALL getChildNodes() override;
 
        virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL getFirstChild() override;
 
        virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL getLastChild() override;
 
        virtual OUString SAL_CALL getLocalName() override;
 
        virtual OUString SAL_CALL getNamespaceURI() override;
 
        virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL getNextSibling() override;
 
        virtual OUString SAL_CALL getNodeName() override;
 
        virtual css::xml::dom::NodeType SAL_CALL getNodeType() override;
 
        virtual OUString SAL_CALL getNodeValue() override;
 
        virtual css::uno::Reference< css::xml::dom::XDocument > SAL_CALL getOwnerDocument() override;
 
        virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL getParentNode() override;
 
        virtual OUString SAL_CALL getPrefix() override;
 
        virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL getPreviousSibling() override;
 
        virtual sal_Bool SAL_CALL hasAttributes() override;
 
        virtual sal_Bool SAL_CALL hasChildNodes() override;
 
        virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL insertBefore(
                const css::uno::Reference< css::xml::dom::XNode >& newChild, const css::uno::Reference< css::xml::dom::XNode >& refChild) override;
 
        virtual sal_Bool SAL_CALL isSupported(const OUString& feature, const OUString& ver) override;
 
        virtual void SAL_CALL normalize() override;
 
        virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL removeChild(const css::uno::Reference< css::xml::dom::XNode >& oldChild) override;
 
        virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL replaceChild(
                const css::uno::Reference< css::xml::dom::XNode >& newChild, const css::uno::Reference< css::xml::dom::XNode >& oldChild) override;
 
        virtual void SAL_CALL setNodeValue(const OUString& nodeValue) override;
 
        virtual void SAL_CALL setPrefix(const OUString& prefix) override;
 
 
        // --- XEventTarget
        virtual void SAL_CALL addEventListener(const OUString& eventType,
            const css::uno::Reference< css::xml::dom::events::XEventListener >& listener,
            sal_Bool useCapture) override;
 
        virtual void SAL_CALL removeEventListener(const OUString& eventType,
            const css::uno::Reference< css::xml::dom::events::XEventListener >& listener,
            sal_Bool useCapture) override;
 
        virtual sal_Bool SAL_CALL dispatchEvent(const css::uno::Reference< css::xml::dom::events::XEvent >& evt) override;
    };
 
    void nscleanup(const xmlNodePtr aNode, const xmlNodePtr aParent);
}
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */