include/oox/core/contexthandler.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 OOX_CORE_CONTEXTHANDLER_HXX
  21 #define OOX_CORE_CONTEXTHANDLER_HXX
  22
  23 #include <com/sun/star/xml/sax/XFastContextHandler.hpp>
  24 #include <boost/shared_ptr.hpp>
  25 #include <cppuhelper/implbase1.hxx>
  26 #include <rtl/ref.hxx>
  27 #include "oox/token/namespaces.hxx"
  28 #include "oox/token/tokens.hxx"
  29 #include "oox/dllapi.h"
  30
  31 namespace com { namespace sun { namespace star {
  32     namespace xml { namespace sax { class XLocator; } }
  33 } } }
  34
  35 namespace oox { class SequenceInputStream; }
  36
  37 namespace oox {
  38 namespace core {
  39
  40 class XmlFilterBase;
  41 class FragmentHandler;
  42 struct Relation;
  43 class Relations;
  44
  45 // ============================================================================
  46
  47 class ContextHandler;
  48 typedef ::rtl::Reference< ContextHandler > ContextHandlerRef;
  49
  50 struct FragmentBaseData;
  51 typedef ::boost::shared_ptr< FragmentBaseData > FragmentBaseDataRef;
  52
  53 typedef ::cppu::WeakImplHelper1< ::com::sun::star::xml::sax::XFastContextHandler > ContextHandler_BASE;
  54
  55 class OOX_DLLPUBLIC ContextHandler : public ContextHandler_BASE
  56 {
  57 public:
  58     explicit            ContextHandler( const ContextHandler& rParent );
  59     virtual             ~ContextHandler();
  60
  61     /** Returns the filter instance. */
  62     XmlFilterBase&      getFilter() const;
  63     /** Returns the relations of the current fragment. */
  64     const Relations&    getRelations() const;
  65     /** Returns the full path of the current fragment. */
  66     const OUString& getFragmentPath() const;
  67
  68     /** Returns the full fragment path for the target of the passed relation. */
  69     OUString     getFragmentPathFromRelation( const Relation& rRelation ) const;
  70     /** Returns the full fragment path for the passed relation identifier. */
  71     OUString     getFragmentPathFromRelId( const OUString& rRelId ) const;
  72     /** Returns the full fragment path for the first relation of the passed type. */
  73     OUString     getFragmentPathFromFirstType( const OUString& rType ) const;
  74
  75     // com.sun.star.xml.sax.XFastContextHandler interface ---------------------
  76
  77     virtual void SAL_CALL startFastElement( ::sal_Int32 Element, const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XFastAttributeList >& Attribs ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException);
  78     virtual void SAL_CALL startUnknownElement( const OUString& Namespace, const OUString& Name, const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XFastAttributeList >& Attribs ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException);
  79     virtual void SAL_CALL endFastElement( ::sal_Int32 Element ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException);
  80     virtual void SAL_CALL endUnknownElement( const OUString& Namespace, const OUString& Name ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException);
  81     virtual ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XFastContextHandler > SAL_CALL createFastChildContext( ::sal_Int32 Element, const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XFastAttributeList >& Attribs ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException);
  82     virtual ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XFastContextHandler > SAL_CALL createUnknownChildContext( const OUString& Namespace, const OUString& Name, const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XFastAttributeList >& Attribs ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException);
  83     virtual void SAL_CALL characters( const OUString& aChars ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException);
  84     virtual void SAL_CALL ignorableWhitespace( const OUString& aWhitespaces ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException);
  85     virtual void SAL_CALL processingInstruction( const OUString& aTarget, const OUString& aData ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException);
  86
  87     // record context interface -----------------------------------------------
  88
  89     virtual ContextHandlerRef createRecordContext( sal_Int32 nRecId, SequenceInputStream& rStrm );
  90     virtual void        startRecord( sal_Int32 nRecId, SequenceInputStream& rStrm );
  91     virtual void        endRecord( sal_Int32 nRecId );
  92
  93 protected:
  94     /** Helper constructor for the FragmentHandler. */
  95     explicit            ContextHandler( const FragmentBaseDataRef& rxBaseData );
  96
  97     void                implSetLocator( const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XLocator >& rxLocator );
  98
  99 #ifdef _MSC_VER
 100     ContextHandler() {} // workaround
 101 #endif
 102
 103 private:
 104     ContextHandler&     operator=( const ContextHandler& );
 105
 106 private:
 107     FragmentBaseDataRef mxBaseData;         ///< Base data of the fragment.
 108 };
 109
 110 // ============================================================================
 111
 112 } // namespace core
 113 } // namespace oox
 114
 115 #endif
 116
 117 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */