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