framework/inc/classes/toolboxdocumenthandler.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: toolboxdocumenthandler.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __FRAMEWORK_CLASSES_TOOLBOXDOCUMENTHANDLER_HXX_
  32 #define __FRAMEWORK_CLASSES_TOOLBOXDOCUMENTHANDLER_HXX_
  33
  34 #include <classes/toolboxconfiguration.hxx>
  35
  36 //_________________________________________________________________________________________________________________
  37 //      interface includes
  38 //_________________________________________________________________________________________________________________
  39
  40 #ifndef __COM_SUN_STAR_XML_SAX_XDOCUMENTHANDLER_HPP_
  41 #include <com/sun/star/xml/sax/XDocumentHandler.hpp>
  42 #endif
  43
  44 //_________________________________________________________________________________________________________________
  45 //      other includes
  46 //_________________________________________________________________________________________________________________
  47 #include <threadhelp/threadhelpbase.hxx>
  48 #include <rtl/ustring.hxx>
  49 #include <cppuhelper/weak.hxx>
  50
  51 #ifndef __SGI_STL_HASH_MAP
  52 #include <hash_map>
  53 #endif
  54 #include <stdtypes.h>
  55
  56 //_________________________________________________________________________________________________________________
  57 //      namespace
  58 //_________________________________________________________________________________________________________________
  59
  60 namespace framework{
  61
  62 //*****************************************************************************************************************
  63 // Hash code function for using in all hash maps of follow implementation.
  64
  65 class OReadToolBoxDocumentHandler : public ::com::sun::star::xml::sax::XDocumentHandler,
  66                                     private ThreadHelpBase,     // Struct for right initalization of lock member! Must be first of baseclasses.
  67                                     public ::cppu::OWeakObject
  68 {
  69     public:
  70         enum ToolBox_XML_Entry
  71         {
  72             TB_ELEMENT_TOOLBAR,
  73             TB_ELEMENT_TOOLBARITEM,
  74             TB_ELEMENT_TOOLBARSPACE,
  75             TB_ELEMENT_TOOLBARBREAK,
  76             TB_ELEMENT_TOOLBARSEPARATOR,
  77             TB_ATTRIBUTE_TEXT,
  78             TB_ATTRIBUTE_BITMAP,
  79             TB_ATTRIBUTE_URL,
  80             TB_ATTRIBUTE_ITEMBITS,
  81             TB_ATTRIBUTE_VISIBLE,
  82             TB_ATTRIBUTE_WIDTH,
  83             TB_ATTRIBUTE_USER,
  84             TB_ATTRIBUTE_HELPID,
  85             TB_ATTRIBUTE_STYLE,
  86             TB_XML_ENTRY_COUNT
  87         };
  88
  89         enum ToolBox_XML_Namespace
  90         {
  91             TB_NS_TOOLBAR,
  92             TB_NS_XLINK,
  93             TB_XML_NAMESPACES_COUNT
  94         };
  95
  96         OReadToolBoxDocumentHandler( ToolBoxDescriptor& aToolBoxItems );
  97         virtual ~OReadToolBoxDocumentHandler();
  98
  99         // XInterface
 100         virtual void SAL_CALL acquire() throw()
 101             { OWeakObject::acquire(); }
 102         virtual void SAL_CALL release() throw()
 103             { OWeakObject::release(); }
 104         virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
 105             const ::com::sun::star::uno::Type & rType ) throw( ::com::sun::star::uno::RuntimeException );
 106
 107         // XDocumentHandler
 108         virtual void SAL_CALL startDocument(void)
 109         throw ( ::com::sun::star::xml::sax::SAXException,
 110                 ::com::sun::star::uno::RuntimeException );
 111
 112         virtual void SAL_CALL endDocument(void)
 113         throw(  ::com::sun::star::xml::sax::SAXException,
 114                 ::com::sun::star::uno::RuntimeException );
 115
 116         virtual void SAL_CALL startElement(
 117             const rtl::OUString& aName,
 118             const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList > &xAttribs)
 119         throw(  ::com::sun::star::xml::sax::SAXException,
 120                 ::com::sun::star::uno::RuntimeException );
 121
 122         virtual void SAL_CALL endElement(const rtl::OUString& aName)
 123         throw(  ::com::sun::star::xml::sax::SAXException,
 124                 ::com::sun::star::uno::RuntimeException );
 125
 126         virtual void SAL_CALL characters(const rtl::OUString& aChars)
 127         throw(  ::com::sun::star::xml::sax::SAXException,
 128                 ::com::sun::star::uno::RuntimeException );
 129
 130         virtual void SAL_CALL ignorableWhitespace(const rtl::OUString& aWhitespaces)
 131         throw(  ::com::sun::star::xml::sax::SAXException,
 132                 ::com::sun::star::uno::RuntimeException );
 133
 134         virtual void SAL_CALL processingInstruction(const rtl::OUString& aTarget,
 135                                                     const rtl::OUString& aData)
 136         throw(  ::com::sun::star::xml::sax::SAXException,
 137                 ::com::sun::star::uno::RuntimeException );
 138
 139         virtual void SAL_CALL setDocumentLocator(
 140             const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XLocator > &xLocator)
 141         throw(  ::com::sun::star::xml::sax::SAXException,
 142                 ::com::sun::star::uno::RuntimeException );
 143
 144     private:
 145         ::rtl::OUString getErrorLineString();
 146
 147         class ToolBoxHashMap : public ::std::hash_map<  ::rtl::OUString                                 ,
 148                                                         ToolBox_XML_Entry                               ,
 149                                                         OUStringHashCode                                ,
 150                                                         ::std::equal_to< ::rtl::OUString >      >
 151         {
 152             public:
 153                 inline void free()
 154                 {
 155                     ToolBoxHashMap().swap( *this );
 156                 }
 157         };
 158
 159         sal_Bool                                                                                                                                        m_bToolBarStartFound;
 160         sal_Bool                                                                                                                                        m_bToolBarEndFound;
 161         sal_Bool                                                                                                                                        m_bToolBarItemStartFound;
 162         sal_Bool                                                                                                                                        m_bToolBarSpaceStartFound;
 163         sal_Bool                                                                                                                                        m_bToolBarBreakStartFound;
 164         sal_Bool                                                                                                                                        m_bToolBarSeparatorStartFound;
 165         ToolBoxHashMap                                                                                                                          m_aToolBoxMap;
 166         ToolBoxDescriptor&                                                                                                                      m_aToolBoxItems;
 167         ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XLocator >        m_xLocator;
 168
 169         sal_Int32                                                                                                                                       m_nHashCode_Style_Radio;
 170         sal_Int32                                                                                                                                       m_nHashCode_Style_Auto;
 171         sal_Int32                                                                                                                                       m_nHashCode_Style_Left;
 172         sal_Int32                                                                                                                                       m_nHashCode_Style_AutoSize;
 173         sal_Int32                                                                                                                                       m_nHashCode_Style_DropDown;
 174         sal_Int32                                                                                                                                       m_nHashCode_Style_Repeat;
 175 };
 176
 177 class OWriteToolBoxDocumentHandler : private ThreadHelpBase // Struct for right initalization of lock member! Must be first of baseclasses.
 178 {
 179     public:
 180         OWriteToolBoxDocumentHandler(
 181             const ToolBoxDescriptor& aToolBoxItems,
 182             ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XDocumentHandler > );
 183         virtual ~OWriteToolBoxDocumentHandler();
 184
 185         void WriteToolBoxDocument() throw
 186             ( ::com::sun::star::xml::sax::SAXException,
 187               ::com::sun::star::uno::RuntimeException );
 188
 189     protected:
 190         virtual void WriteToolBoxItem( const ToolBoxItemDescriptor* ) throw
 191             ( ::com::sun::star::xml::sax::SAXException,
 192               ::com::sun::star::uno::RuntimeException );
 193
 194         virtual void WriteToolBoxSpace() throw
 195             ( ::com::sun::star::xml::sax::SAXException,
 196               ::com::sun::star::uno::RuntimeException );
 197
 198         virtual void WriteToolBoxBreak() throw
 199             ( ::com::sun::star::xml::sax::SAXException,
 200               ::com::sun::star::uno::RuntimeException );
 201
 202         virtual void WriteToolBoxSeparator() throw
 203             ( ::com::sun::star::xml::sax::SAXException,
 204               ::com::sun::star::uno::RuntimeException );
 205
 206         const ToolBoxDescriptor&                                                                                                                        m_aToolBoxItems;
 207         ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XDocumentHandler >        m_xWriteDocumentHandler;
 208         ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >          m_xEmptyList;
 209         ::rtl::OUString                                                                                                                                         m_aXMLToolbarNS;
 210         ::rtl::OUString                                                                                                                                         m_aXMLXlinkNS;
 211         ::rtl::OUString                                                                                                                                         m_aAttributeType;
 212         ::rtl::OUString                                                                                                                                         m_aAttributeURL;
 213 };
 214
 215 } // namespace framework
 216
 217 #endif