framework/inc/xml/acceleratorconfigurationreader.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: acceleratorconfigurationreader.hxx,v $
  10  * $Revision: 1.5 $
  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_XML_ACCELERATORCONFIGURATIONREADER_HXX_
  32 #define _FRAMEWORK_XML_ACCELERATORCONFIGURATIONREADER_HXX_
  33
  34 //_______________________________________________
  35 // own includes
  36
  37 #include <accelerators/acceleratorcache.hxx>
  38 #include <accelerators/keymapping.hxx>
  39 #include <macros/xinterface.hxx>
  40 #include <threadhelp/threadhelpbase.hxx>
  41 #include <general.h>
  42
  43 //_______________________________________________
  44 // interface includes
  45
  46 #ifndef __COM_SUN_STAR_XML_SAX_XDOCUMENTHANDLER_HPP_
  47 #include <com/sun/star/xml/sax/XDocumentHandler.hpp>
  48 #endif
  49
  50 #ifndef __COM_SUN_STAR_XML_SAX_XLOCATOR_HPP_
  51 #include <com/sun/star/xml/sax/XLocator.hpp>
  52 #endif
  53
  54 //_______________________________________________
  55 // other includes
  56 #include <salhelper/singletonref.hxx>
  57 #include <cppuhelper/weak.hxx>
  58 #include <rtl/ustring.hxx>
  59
  60 namespace framework{
  61
  62 class AcceleratorConfigurationReader : public  css::xml::sax::XDocumentHandler
  63                                      , private ThreadHelpBase
  64                                      , public  ::cppu::OWeakObject
  65 {
  66     //-------------------------------------------
  67     // const, types
  68
  69     private:
  70
  71         //---------------------------------------
  72         /** @short  classification of XML elements. */
  73         enum EXMLElement
  74         {
  75             E_ELEMENT_ACCELERATORLIST,
  76             E_ELEMENT_ITEM
  77         };
  78
  79         //---------------------------------------
  80         /** @short  classification of XML attributes. */
  81         enum EXMLAttribute
  82         {
  83             E_ATTRIBUTE_KEYCODE,
  84             E_ATTRIBUTE_MOD_SHIFT,
  85             E_ATTRIBUTE_MOD_MOD1,
  86             E_ATTRIBUTE_MOD_MOD2,
  87                         E_ATTRIBUTE_MOD_MOD3,
  88             E_ATTRIBUTE_URL
  89         };
  90
  91         //---------------------------------------
  92         /** @short  some namespace defines */
  93         enum EAcceleratorXMLNamespace
  94         {
  95             E_NAMESPACE_ACCEL,
  96             E_NAMESPACE_XLINK
  97         };
  98
  99     //-------------------------------------------
 100     // member
 101
 102     private:
 103
 104         //---------------------------------------
 105         /** @short  needed to read the xml configuration. */
 106         css::uno::Reference< css::xml::sax::XDocumentHandler > m_xReader;
 107
 108         //---------------------------------------
 109         /** @short  reference to the outside container, where this
 110                     reader/writer must work on. */
 111         AcceleratorCache& m_rContainer;
 112
 113         //---------------------------------------
 114         /** @short  used to detect if an accelerator list
 115                     occures recursive inside xml. */
 116         sal_Bool m_bInsideAcceleratorList;
 117
 118         //---------------------------------------
 119         /** @short  used to detect if an accelerator item
 120                     occures recursive inside xml. */
 121         sal_Bool m_bInsideAcceleratorItem;
 122
 123         //---------------------------------------
 124         /** @short  is used to map key codes to its
 125                     string representation.
 126
 127             @descr  To perform this operatio is
 128                     created only one times and holded
 129                     alive forever ...*/
 130         ::salhelper::SingletonRef< KeyMapping > m_rKeyMapping;
 131
 132         //---------------------------------------
 133         /** @short  provide informations abou the parsing state.
 134
 135             @descr  We use it to find out the line and column, where
 136                     an error occure.
 137           */
 138         css::uno::Reference< css::xml::sax::XLocator > m_xLocator;
 139
 140 /*        SfxAcceleratorItemList& m_aReadAcceleratorList;
 141 */
 142
 143     //-------------------------------------------
 144     // interface
 145
 146     public:
 147
 148         //---------------------------------------
 149         /** @short  connect this new reader/writer instance
 150                     to an outside container, which should be used
 151                     flushed to the underlying XML configuration or
 152                     filled from there.
 153
 154             @param  rContainer
 155                     a reference to the outside container.
 156           */
 157         AcceleratorConfigurationReader(AcceleratorCache& rContainer);
 158
 159         //---------------------------------------
 160         /** @short  does nothing real ... */
 161         virtual ~AcceleratorConfigurationReader();
 162
 163         //---------------------------------------
 164         // XInterface
 165         FWK_DECLARE_XINTERFACE
 166
 167         //---------------------------------------
 168         // XDocumentHandler
 169         virtual void SAL_CALL startDocument()
 170             throw(css::xml::sax::SAXException,
 171                   css::uno::RuntimeException );
 172
 173         virtual void SAL_CALL endDocument()
 174             throw(css::xml::sax::SAXException,
 175                   css::uno::RuntimeException );
 176
 177         virtual void SAL_CALL startElement(const ::rtl::OUString&                                      sElement      ,
 178                                            const css::uno::Reference< css::xml::sax::XAttributeList >& xAttributeList)
 179             throw(css::xml::sax::SAXException,
 180                   css::uno::RuntimeException );
 181
 182         virtual void SAL_CALL endElement(const ::rtl::OUString& sElement)
 183             throw(css::xml::sax::SAXException,
 184                   css::uno::RuntimeException );
 185
 186         virtual void SAL_CALL characters(const ::rtl::OUString& sChars)
 187             throw(css::xml::sax::SAXException,
 188                   css::uno::RuntimeException );
 189
 190         virtual void SAL_CALL ignorableWhitespace(const ::rtl::OUString& sWhitespaces)
 191             throw(css::xml::sax::SAXException,
 192                   css::uno::RuntimeException );
 193
 194         virtual void SAL_CALL processingInstruction(const ::rtl::OUString& sTarget,
 195                                                     const ::rtl::OUString& sData  )
 196             throw(css::xml::sax::SAXException,
 197                   css::uno::RuntimeException );
 198
 199         virtual void SAL_CALL setDocumentLocator(const css::uno::Reference< css::xml::sax::XLocator >& xLocator)
 200             throw(css::xml::sax::SAXException,
 201                   css::uno::RuntimeException );
 202
 203     //-------------------------------------------
 204     // helper
 205
 206     private:
 207
 208         //---------------------------------------
 209         /** TODO document me */
 210         static EXMLElement implst_classifyElement(const ::rtl::OUString& sElement);
 211
 212         //---------------------------------------
 213         /** TODO document me */
 214         static EXMLAttribute implst_classifyAttribute(const ::rtl::OUString& sAttribute);
 215
 216         //---------------------------------------
 217         /** TODO document me */
 218         ::rtl::OUString implts_getErrorLineString();
 219 };
 220
 221 } // namespace framework
 222
 223 #endif // _FRAMEWORK_XML_ACCELERATORCONFIGURATIONREADER_HXX_