unoxml/source/xpath/xpathapi.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 #ifndef XPATH_XPATHAPI_HXX
  21 #define XPATH_XPATHAPI_HXX
  22
  23 #include <map>
  24 #include <vector>
  25
  26 #include <sal/types.h>
  27
  28 #include <cppuhelper/implbase2.hxx>
  29
  30 #include <com/sun/star/uno/Reference.h>
  31 #include <com/sun/star/uno/Sequence.h>
  32
  33 #include <com/sun/star/uno/XInterface.hpp>
  34 #include <com/sun/star/uno/Exception.hpp>
  35 #include <com/sun/star/xml/xpath/XXPathAPI.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/xpath/XXPathObject.hpp>
  39 #include <com/sun/star/xml/xpath/XXPathExtension.hpp>
  40 #include <com/sun/star/xml/xpath/Libxml2ExtensionHandle.hpp>
  41 #include <com/sun/star/xml/xpath/XPathException.hpp>
  42 #include <com/sun/star/lang/XServiceInfo.hpp>
  43 #include <com/sun/star/lang/XSingleServiceFactory.hpp>
  44 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  45
  46 using namespace com::sun::star::uno;
  47 using namespace com::sun::star::xml::dom;
  48 using namespace com::sun::star::xml::xpath;
  49
  50 namespace XPath
  51 {
  52     typedef std::map<OUString, OUString> nsmap_t;
  53     typedef std::vector< Reference<XXPathExtension> > extensions_t;
  54
  55     typedef ::cppu::WeakImplHelper2
  56         <   XXPathAPI
  57         ,   ::com::sun::star::lang::XServiceInfo
  58         > CXPathAPI_Base;
  59
  60     class  CXPathAPI
  61         : public CXPathAPI_Base
  62     {
  63
  64     private:
  65         ::osl::Mutex m_Mutex;
  66         nsmap_t m_nsmap;
  67         const Reference< ::com::sun::star::lang::XMultiServiceFactory > m_aFactory;
  68         extensions_t m_extensions;
  69
  70     public:
  71         // ctor
  72         CXPathAPI(
  73             const Reference< ::com::sun::star::lang::XMultiServiceFactory >&
  74                 rSMgr);
  75
  76         // call for factory
  77         static Reference< XInterface > getInstance(
  78             const Reference < ::com::sun::star::lang::XMultiServiceFactory >&
  79                 xFactory);
  80
  81         // static helpers for service info and component management
  82         static const char* aImplementationName;
  83         static const char* aSupportedServiceNames[];
  84         static OUString _getImplementationName();
  85         static Sequence< OUString > _getSupportedServiceNames();
  86         static Reference< XInterface > _getInstance(
  87             const Reference< ::com::sun::star::lang::XMultiServiceFactory >&
  88                 rSMgr);
  89
  90         // XServiceInfo
  91         virtual OUString SAL_CALL getImplementationName()
  92             throw (RuntimeException);
  93         virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName)
  94             throw (RuntimeException);
  95         virtual Sequence< OUString > SAL_CALL getSupportedServiceNames ()
  96             throw (RuntimeException);
  97
  98
  99         // --- XXPathAPI ---
 100
 101         virtual void SAL_CALL registerNS(const OUString& aPrefix, const OUString& aURI)
 102             throw (RuntimeException);
 103
 104         virtual void SAL_CALL unregisterNS(const OUString& aPrefix, const OUString& aURI)
 105             throw (RuntimeException);
 106
 107         /**
 108         Use an XPath string to select a nodelist.
 109         */
 110         virtual Reference< XNodeList > SAL_CALL selectNodeList(const Reference< XNode >& contextNode, const OUString& str)
 111             throw (RuntimeException, XPathException);
 112
 113         /**
 114         Use an XPath string to select a nodelist.
 115         */
 116         virtual Reference< XNodeList > SAL_CALL selectNodeListNS(const Reference< XNode >& contextNode, const OUString& str, const Reference< XNode >&  namespaceNode)
 117             throw (RuntimeException, XPathException);
 118
 119         /**
 120         Use an XPath string to select a single node.
 121         */
 122         virtual Reference< XNode > SAL_CALL selectSingleNode(const Reference< XNode >& contextNode, const OUString& str)
 123             throw (RuntimeException, XPathException);
 124
 125         /**
 126         Use an XPath string to select a single node.
 127         */
 128         virtual Reference< XNode > SAL_CALL selectSingleNodeNS(const Reference< XNode >& contextNode, const OUString& str, const Reference< XNode >&  namespaceNode)
 129             throw (RuntimeException, XPathException);
 130
 131         virtual Reference< XXPathObject > SAL_CALL eval(const Reference< XNode >& contextNode, const OUString& str)
 132             throw (RuntimeException, XPathException);
 133
 134         virtual Reference< XXPathObject > SAL_CALL evalNS(const Reference< XNode >& contextNode, const OUString& str, const Reference< XNode >&  namespaceNode)
 135             throw (RuntimeException, XPathException);
 136
 137         virtual void SAL_CALL registerExtension(const OUString& aName) throw (RuntimeException);
 138         virtual void SAL_CALL registerExtensionInstance(const Reference< XXPathExtension>& aExtension) throw (RuntimeException);
 139
 140     };
 141 }
 142
 143 #endif
 144
 145 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */