framework/inc/classes/toolboxlayoutdocumenthandler.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: toolboxlayoutdocumenthandler.hxx,v $
  10  * $Revision: 1.7 $
  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_TOOLBOXLAYOUTDOCUMENTHANDLER_HXX_
  32 #define __FRAMEWORK_CLASSES_TOOLBOXLAYOUTDOCUMENTHANDLER_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 OReadToolBoxLayoutDocumentHandler : 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 ToolBoxLayout_XML_Entry
  71         {
  72             TBL_ELEMENT_TOOLBARLAYOUTS,
  73             TBL_ELEMENT_TOOLBARLAYOUT,
  74             TBL_ELEMENT_TOOLBARCONFIGITEMS,
  75             TBL_ELEMENT_TOOLBARCONFIGITEM,
  76             TBL_ATTRIBUTE_ID,
  77             TBL_ATTRIBUTE_TOOLBARNAME,
  78             TBL_ATTRIBUTE_CONTEXT,
  79             TBL_ATTRIBUTE_FLOATINGLINES,
  80             TBL_ATTRIBUTE_DOCKINGLINES,
  81             TBL_ATTRIBUTE_ALIGN,
  82             TBL_ATTRIBUTE_FLOATING,
  83             TBL_ATTRIBUTE_FLOATINGPOSLEFT,
  84             TBL_ATTRIBUTE_FLOATINGPOSTOP,
  85             TBL_ATTRIBUTE_VISIBLE,
  86             TBL_ATTRIBUTE_STYLE,
  87             TBL_ATTRIBUTE_USERDEFNAME,
  88             TBL_XML_ENTRY_COUNT
  89         };
  90
  91         enum ToolBox_XML_Namespace
  92         {
  93             TBL_NS_TOOLBAR,
  94             TBL_XML_NAMESPACES_COUNT
  95         };
  96
  97         OReadToolBoxLayoutDocumentHandler( ToolBoxLayoutDescriptor& aToolBoxLayoutItems );
  98         virtual ~OReadToolBoxLayoutDocumentHandler();
  99
 100         // XInterface
 101         virtual void SAL_CALL acquire() throw()
 102             { OWeakObject::acquire(); }
 103         virtual void SAL_CALL release() throw()
 104             { OWeakObject::release(); }
 105         virtual ::com::sun::star::uno::Any SAL_CALL queryInterface(
 106             const ::com::sun::star::uno::Type & rType ) throw( ::com::sun::star::uno::RuntimeException );
 107
 108         // XDocumentHandler
 109         virtual void SAL_CALL startDocument(void)
 110         throw ( ::com::sun::star::xml::sax::SAXException,
 111                 ::com::sun::star::uno::RuntimeException );
 112
 113         virtual void SAL_CALL endDocument(void)
 114         throw(  ::com::sun::star::xml::sax::SAXException,
 115                 ::com::sun::star::uno::RuntimeException );
 116
 117         virtual void SAL_CALL startElement(
 118             const rtl::OUString& aName,
 119             const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList > &xAttribs)
 120         throw(  ::com::sun::star::xml::sax::SAXException,
 121                 ::com::sun::star::uno::RuntimeException );
 122
 123         virtual void SAL_CALL endElement(const rtl::OUString& aName)
 124         throw(  ::com::sun::star::xml::sax::SAXException,
 125                 ::com::sun::star::uno::RuntimeException );
 126
 127         virtual void SAL_CALL characters(const rtl::OUString& aChars)
 128         throw(  ::com::sun::star::xml::sax::SAXException,
 129                 ::com::sun::star::uno::RuntimeException );
 130
 131         virtual void SAL_CALL ignorableWhitespace(const rtl::OUString& aWhitespaces)
 132         throw(  ::com::sun::star::xml::sax::SAXException,
 133                 ::com::sun::star::uno::RuntimeException );
 134
 135         virtual void SAL_CALL processingInstruction(const rtl::OUString& aTarget,
 136                                                     const rtl::OUString& aData)
 137         throw(  ::com::sun::star::xml::sax::SAXException,
 138                 ::com::sun::star::uno::RuntimeException );
 139
 140         virtual void SAL_CALL setDocumentLocator(
 141             const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XLocator > &xLocator)
 142         throw(  ::com::sun::star::xml::sax::SAXException,
 143                 ::com::sun::star::uno::RuntimeException );
 144
 145     private:
 146         ::rtl::OUString getErrorLineString();
 147
 148         class ToolBoxLayoutHashMap : public ::std::hash_map< ::rtl::OUString                            ,
 149                                                              ToolBoxLayout_XML_Entry            ,
 150                                                              OUStringHashCode                           ,
 151                                                              ::std::equal_to< ::rtl::OUString > >
 152         {
 153             public:
 154                 inline void free()
 155                 {
 156                     ToolBoxLayoutHashMap().swap( *this );
 157                 }
 158         };
 159
 160         sal_Bool                                                                                                                                        m_bToolBarLayoutsStartFound;
 161         sal_Bool                                                                                                                                        m_bToolBarLayoutsEndFound;
 162         sal_Bool                                                                                                                                        m_bToolBarLayoutStartFound;
 163         sal_Bool                                                                                                                                        m_bToolBarConfigListStartFound;
 164         sal_Bool                                                                                                                                        m_bToolBarConfigItemStartFound;
 165         ToolBoxLayoutHashMap                                                                                                            m_aToolBoxMap;
 166         ToolBoxLayoutDescriptor&                                                                                                        m_aToolBoxItems;
 167         ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XLocator >        m_xLocator;
 168 };
 169
 170 class OWriteToolBoxLayoutDocumentHandler : private ThreadHelpBase // Struct for right initalization of lock member! Must be first of baseclasses.
 171 {
 172     public:
 173         OWriteToolBoxLayoutDocumentHandler(
 174             const ToolBoxLayoutDescriptor& aToolBoxLayoutItems,
 175             ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XDocumentHandler > );
 176         virtual ~OWriteToolBoxLayoutDocumentHandler();
 177
 178         void WriteToolBoxLayoutDocument() throw
 179             ( ::com::sun::star::xml::sax::SAXException,
 180               ::com::sun::star::uno::RuntimeException );
 181
 182     protected:
 183         virtual void WriteToolBoxLayoutItem( const ToolBoxLayoutItemDescriptor* ) throw
 184             ( ::com::sun::star::xml::sax::SAXException,
 185               ::com::sun::star::uno::RuntimeException );
 186
 187         const ToolBoxLayoutDescriptor&                                                                                                          m_aToolBoxLayoutItems;
 188         ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XDocumentHandler >        m_xWriteDocumentHandler;
 189         ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >          m_xEmptyList;
 190         ::rtl::OUString                                                                                                                                         m_aXMLToolbarNS;
 191         ::rtl::OUString                                                                                                                                         m_aAttributeType;
 192         ::rtl::OUString                                                                                                                                         m_aTrueValue;
 193         ::rtl::OUString                                                                                                                                         m_aFalseValue;
 194 };
 195
 196 } // namespace framework
 197
 198 #endif