unoxml/inc/node.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <libxml/tree.h>
  23
  24 #include <sal/types.h>
  25 #include <rtl/ref.hxx>
  26 #include <rtl/string.hxx>
  27 #include <rtl/ustring.hxx>
  28
  29 #include <cppuhelper/implbase.hxx>
  30
  31 #include <sax/fastattribs.hxx>
  32
  33 #include <com/sun/star/uno/Reference.h>
  34 #include <com/sun/star/uno/Sequence.h>
  35 #include <com/sun/star/lang/XUnoTunnel.hpp>
  36 #include <com/sun/star/xml/dom/XNode.hpp>
  37 #include <com/sun/star/xml/dom/XNodeList.hpp>
  38 #include <com/sun/star/xml/dom/XNamedNodeMap.hpp>
  39 #include <com/sun/star/xml/dom/NodeType.hpp>
  40 #include <com/sun/star/xml/dom/events/XEventTarget.hpp>
  41 #include <com/sun/star/xml/dom/events/XEvent.hpp>
  42 #include <com/sun/star/xml/sax/XDocumentHandler.hpp>
  43 #include <com/sun/star/xml/sax/XFastDocumentHandler.hpp>
  44
  45 #include <unordered_map>
  46
  47 namespace DOM
  48 {
  49     struct Context
  50     {
  51         Context( const css::uno::Reference< css::xml::sax::XFastDocumentHandler >& i_xHandler,
  52                  sax_fastparser::FastTokenHandlerBase* pTokenHandler ) :
  53             maNamespaces( 1, std::vector<Namespace>() ),
  54             maNamespaceMap(101),
  55             mxAttribList(new sax_fastparser::FastAttributeList(pTokenHandler)),
  56             mxCurrentHandler(i_xHandler),
  57             mxDocHandler(i_xHandler),
  58             mxTokenHandler(pTokenHandler)
  59         {}
  60
  61         struct Namespace
  62         {
  63             OString     maPrefix;
  64             sal_Int32   mnToken;
  65
  66             const OString& getPrefix() const { return maPrefix; }
  67         };
  68
  69         typedef std::vector< std::vector<Namespace> > NamespaceVectorType;
  70         typedef std::unordered_map< OUString, sal_Int32 > NamespaceMapType;
  71
  72         /// outer vector: xml context; inner vector: current NS
  73         NamespaceVectorType                 maNamespaces;
  74         NamespaceMapType                    maNamespaceMap;
  75         ::rtl::Reference<sax_fastparser::FastAttributeList> mxAttribList;
  76         css::uno::Reference<css::xml::sax::XFastContextHandler>      mxCurrentHandler;
  77         css::uno::Reference<css::xml::sax::XFastDocumentHandler>     mxDocHandler;
  78         rtl::Reference<sax_fastparser::FastTokenHandlerBase>         mxTokenHandler;
  79     };
  80
  81     void pushContext(Context& io_rContext);
  82     void popContext(Context& io_rContext);
  83
  84     sal_Int32 getTokenWithPrefix( const Context& rContext, const char* xPrefix, const char* xName );
  85     sal_Int32 getToken( const Context& rContext, const char* xName );
  86
  87     /// add namespaces on this node to context
  88     void addNamespaces(Context& io_rContext, xmlNodePtr pNode);
  89
  90     class CDocument;
  91
  92     class CNode : public cppu::WeakImplHelper< css::xml::dom::XNode, css::lang::XUnoTunnel, css::xml::dom::events::XEventTarget >
  93     {
  94         friend class CDocument;
  95         friend class CElement;
  96         friend class CAttributesMap;
  97
  98     private:
  99         bool m_bUnlinked; /// node has been removed from document
 100
 101     protected:
 102         css::xml::dom::NodeType const m_aNodeType;
 103         /// libxml node; NB: not const, because invalidate may reset it to 0!
 104         xmlNodePtr m_aNodePtr;
 105
 106         ::rtl::Reference< CDocument > const m_xDocument;
 107         ::osl::Mutex & m_rMutex;
 108
 109         // for initialization by classes derived through ImplInheritanceHelper
 110         CNode(CDocument const& rDocument, ::osl::Mutex const& rMutex,
 111                 css::xml::dom::NodeType const& reNodeType, xmlNodePtr const& rpNode);
 112         void invalidate();
 113
 114         void dispatchSubtreeModified();
 115
 116     public:
 117
 118         virtual ~CNode() override;
 119
 120         static const css::uno::Sequence< sal_Int8 > & getUnoTunnelId() noexcept;
 121
 122         xmlNodePtr GetNodePtr() { return m_aNodePtr; }
 123
 124         virtual CDocument & GetOwnerDocument();
 125
 126         // recursively create SAX events
 127         virtual void saxify(const css::uno::Reference< css::xml::sax::XDocumentHandler >& i_xHandler);
 128
 129         // recursively create SAX events
 130         virtual void fastSaxify( Context& io_rContext );
 131
 132         // constrains child relationship between nodes based on type
 133         virtual bool IsChildTypeAllowed(css::xml::dom::NodeType const nodeType);
 134
 135         // ---- DOM interfaces
 136
 137         /**
 138         Adds the node newChild to the end of the list of children of this node.
 139         */
 140         virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL
 141             appendChild(css::uno::Reference< css::xml::dom::XNode > const& xNewChild) override;
 142
 143         /**
 144         Returns a duplicate of this node, i.e., serves as a generic copy
 145         constructor for nodes.
 146         */
 147         virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL cloneNode(sal_Bool deep) override;
 148
 149         /**
 150         A NamedNodeMap containing the attributes of this node
 151         (if it is an Element) or null otherwise.
 152         */
 153         virtual css::uno::Reference< css::xml::dom::XNamedNodeMap > SAL_CALL getAttributes() override;
 154
 155         /**
 156         A NodeList that contains all children of this node.
 157         */
 158         virtual css::uno::Reference< css::xml::dom::XNodeList > SAL_CALL getChildNodes() override;
 159
 160         /**
 161         The first child of this node.
 162         */
 163         virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL getFirstChild() override;
 164
 165         /**
 166         The last child of this node.
 167         */
 168         virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL getLastChild() override;
 169
 170         /**
 171         Returns the local part of the qualified name of this node.
 172         */
 173         virtual OUString SAL_CALL getLocalName() override;
 174
 175         /**
 176         The namespace URI of this node, or null if it is unspecified.
 177         */
 178         virtual OUString SAL_CALL getNamespaceURI() override;
 179
 180         /**
 181         The node immediately following this node.
 182         */
 183         virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL getNextSibling() override;
 184
 185         /**
 186         The name of this node, depending on its type; see the table above.
 187         -- virtual implemented by actual node types
 188         */
 189         virtual OUString SAL_CALL getNodeName() override;
 190
 191         /**
 192         A code representing the type of the underlying object, as defined above.
 193         */
 194         virtual css::xml::dom::NodeType SAL_CALL getNodeType() override;
 195
 196         /**
 197         The value of this node, depending on its type; see the table above.
 198         -- virtual implemented by actual node types
 199         */
 200         virtual OUString SAL_CALL getNodeValue() override;
 201
 202         /**
 203         The Document object associated with this node.
 204         */
 205         virtual css::uno::Reference< css::xml::dom::XDocument > SAL_CALL getOwnerDocument() override;
 206
 207         /**
 208         The parent of this node.
 209         */
 210         virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL getParentNode() override;
 211
 212         /**
 213         The namespace prefix of this node, or null if it is unspecified.
 214         */
 215         virtual OUString SAL_CALL getPrefix() override;
 216
 217         /**
 218         The node immediately preceding this node.
 219         */
 220         virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL getPreviousSibling() override;
 221
 222         /**
 223         Returns whether this node (if it is an element) has any attributes.
 224         */
 225         virtual sal_Bool SAL_CALL hasAttributes() override;
 226
 227         /**
 228         Returns whether this node has any children.
 229         */
 230         virtual sal_Bool SAL_CALL hasChildNodes() override;
 231
 232         /**
 233         Inserts the node newChild before the existing child node refChild.
 234         */
 235         virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL insertBefore(
 236                 const css::uno::Reference< css::xml::dom::XNode >& newChild, const css::uno::Reference< css::xml::dom::XNode >& refChild) override;
 237
 238         /**
 239         Tests whether the DOM implementation implements a specific feature and
 240         that feature is supported by this node.
 241         */
 242         virtual sal_Bool SAL_CALL isSupported(const OUString& feature, const OUString& ver) override;
 243
 244         /**
 245         Puts all Text nodes in the full depth of the sub-tree underneath this
 246         Node, including attribute nodes, into a "normal" form where only structure
 247         (e.g., elements, comments, processing instructions, CDATA sections, and
 248         entity references) separates Text nodes, i.e., there are neither adjacent
 249         Text nodes nor empty Text nodes.
 250         */
 251         virtual void SAL_CALL normalize() override;
 252
 253         /**
 254         Removes the child node indicated by oldChild from the list of children,
 255         and returns it.
 256         */
 257         virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL removeChild(const css::uno::Reference< css::xml::dom::XNode >& oldChild) override;
 258
 259         /**
 260         Replaces the child node oldChild with newChild in the list of children,
 261         and returns the oldChild node.
 262         */
 263         virtual css::uno::Reference< css::xml::dom::XNode > SAL_CALL replaceChild(
 264                 const css::uno::Reference< css::xml::dom::XNode >& newChild, const css::uno::Reference< css::xml::dom::XNode >& oldChild) override;
 265
 266         /**
 267         The value of this node, depending on its type; see the table above.
 268         */
 269         virtual void SAL_CALL setNodeValue(const OUString& nodeValue) override;
 270
 271         /**
 272         The namespace prefix of this node, or null if it is unspecified.
 273         */
 274         virtual void SAL_CALL setPrefix(const OUString& prefix) override;
 275
 276
 277         // --- XEventTarget
 278         virtual void SAL_CALL addEventListener(const OUString& eventType,
 279             const css::uno::Reference< css::xml::dom::events::XEventListener >& listener,
 280             sal_Bool useCapture) override;
 281
 282         virtual void SAL_CALL removeEventListener(const OUString& eventType,
 283             const css::uno::Reference< css::xml::dom::events::XEventListener >& listener,
 284             sal_Bool useCapture) override;
 285
 286         virtual sal_Bool SAL_CALL dispatchEvent(const css::uno::Reference< css::xml::dom::events::XEvent >& evt) override;
 287
 288         // --- XUnoTunnel
 289         virtual ::sal_Int64 SAL_CALL
 290             getSomething(css::uno::Sequence< ::sal_Int8 > const& rId) override;
 291     };
 292
 293     /// eliminate redundant namespace declarations
 294     void nscleanup(const xmlNodePtr aNode, const xmlNodePtr aParent);
 295 }
 296
 297 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */