1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef _FRAMEWORK_XML_ACCELERATORCONFIGURATIONREADER_HXX_ 25*b1cdbd2cSJim Jagielski #define _FRAMEWORK_XML_ACCELERATORCONFIGURATIONREADER_HXX_ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski //_______________________________________________ 28*b1cdbd2cSJim Jagielski // own includes 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski #include <accelerators/acceleratorcache.hxx> 31*b1cdbd2cSJim Jagielski #include <accelerators/keymapping.hxx> 32*b1cdbd2cSJim Jagielski #include <macros/xinterface.hxx> 33*b1cdbd2cSJim Jagielski #include <threadhelp/threadhelpbase.hxx> 34*b1cdbd2cSJim Jagielski #include <general.h> 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski //_______________________________________________ 37*b1cdbd2cSJim Jagielski // interface includes 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski #ifndef __COM_SUN_STAR_XML_SAX_XDOCUMENTHANDLER_HPP_ 40*b1cdbd2cSJim Jagielski #include <com/sun/star/xml/sax/XDocumentHandler.hpp> 41*b1cdbd2cSJim Jagielski #endif 42*b1cdbd2cSJim Jagielski 43*b1cdbd2cSJim Jagielski #ifndef __COM_SUN_STAR_XML_SAX_XLOCATOR_HPP_ 44*b1cdbd2cSJim Jagielski #include <com/sun/star/xml/sax/XLocator.hpp> 45*b1cdbd2cSJim Jagielski #endif 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski //_______________________________________________ 48*b1cdbd2cSJim Jagielski // other includes 49*b1cdbd2cSJim Jagielski #include <salhelper/singletonref.hxx> 50*b1cdbd2cSJim Jagielski #include <cppuhelper/weak.hxx> 51*b1cdbd2cSJim Jagielski #include <rtl/ustring.hxx> 52*b1cdbd2cSJim Jagielski 53*b1cdbd2cSJim Jagielski namespace framework{ 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski class AcceleratorConfigurationReader : public css::xml::sax::XDocumentHandler 56*b1cdbd2cSJim Jagielski , private ThreadHelpBase 57*b1cdbd2cSJim Jagielski , public ::cppu::OWeakObject 58*b1cdbd2cSJim Jagielski { 59*b1cdbd2cSJim Jagielski //------------------------------------------- 60*b1cdbd2cSJim Jagielski // const, types 61*b1cdbd2cSJim Jagielski 62*b1cdbd2cSJim Jagielski private: 63*b1cdbd2cSJim Jagielski 64*b1cdbd2cSJim Jagielski //--------------------------------------- 65*b1cdbd2cSJim Jagielski /** @short classification of XML elements. */ 66*b1cdbd2cSJim Jagielski enum EXMLElement 67*b1cdbd2cSJim Jagielski { 68*b1cdbd2cSJim Jagielski E_ELEMENT_ACCELERATORLIST, 69*b1cdbd2cSJim Jagielski E_ELEMENT_ITEM 70*b1cdbd2cSJim Jagielski }; 71*b1cdbd2cSJim Jagielski 72*b1cdbd2cSJim Jagielski //--------------------------------------- 73*b1cdbd2cSJim Jagielski /** @short classification of XML attributes. */ 74*b1cdbd2cSJim Jagielski enum EXMLAttribute 75*b1cdbd2cSJim Jagielski { 76*b1cdbd2cSJim Jagielski E_ATTRIBUTE_KEYCODE, 77*b1cdbd2cSJim Jagielski E_ATTRIBUTE_MOD_SHIFT, 78*b1cdbd2cSJim Jagielski E_ATTRIBUTE_MOD_MOD1, 79*b1cdbd2cSJim Jagielski E_ATTRIBUTE_MOD_MOD2, 80*b1cdbd2cSJim Jagielski E_ATTRIBUTE_MOD_MOD3, 81*b1cdbd2cSJim Jagielski E_ATTRIBUTE_URL 82*b1cdbd2cSJim Jagielski }; 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski //--------------------------------------- 85*b1cdbd2cSJim Jagielski /** @short some namespace defines */ 86*b1cdbd2cSJim Jagielski enum EAcceleratorXMLNamespace 87*b1cdbd2cSJim Jagielski { 88*b1cdbd2cSJim Jagielski E_NAMESPACE_ACCEL, 89*b1cdbd2cSJim Jagielski E_NAMESPACE_XLINK 90*b1cdbd2cSJim Jagielski }; 91*b1cdbd2cSJim Jagielski 92*b1cdbd2cSJim Jagielski //------------------------------------------- 93*b1cdbd2cSJim Jagielski // member 94*b1cdbd2cSJim Jagielski 95*b1cdbd2cSJim Jagielski private: 96*b1cdbd2cSJim Jagielski 97*b1cdbd2cSJim Jagielski //--------------------------------------- 98*b1cdbd2cSJim Jagielski /** @short needed to read the xml configuration. */ 99*b1cdbd2cSJim Jagielski css::uno::Reference< css::xml::sax::XDocumentHandler > m_xReader; 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski //--------------------------------------- 102*b1cdbd2cSJim Jagielski /** @short reference to the outside container, where this 103*b1cdbd2cSJim Jagielski reader/writer must work on. */ 104*b1cdbd2cSJim Jagielski AcceleratorCache& m_rContainer; 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski //--------------------------------------- 107*b1cdbd2cSJim Jagielski /** @short used to detect if an accelerator list 108*b1cdbd2cSJim Jagielski occures recursive inside xml. */ 109*b1cdbd2cSJim Jagielski sal_Bool m_bInsideAcceleratorList; 110*b1cdbd2cSJim Jagielski 111*b1cdbd2cSJim Jagielski //--------------------------------------- 112*b1cdbd2cSJim Jagielski /** @short used to detect if an accelerator item 113*b1cdbd2cSJim Jagielski occures recursive inside xml. */ 114*b1cdbd2cSJim Jagielski sal_Bool m_bInsideAcceleratorItem; 115*b1cdbd2cSJim Jagielski 116*b1cdbd2cSJim Jagielski //--------------------------------------- 117*b1cdbd2cSJim Jagielski /** @short is used to map key codes to its 118*b1cdbd2cSJim Jagielski string representation. 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski @descr To perform this operatio is 121*b1cdbd2cSJim Jagielski created only one times and holded 122*b1cdbd2cSJim Jagielski alive forever ...*/ 123*b1cdbd2cSJim Jagielski ::salhelper::SingletonRef< KeyMapping > m_rKeyMapping; 124*b1cdbd2cSJim Jagielski 125*b1cdbd2cSJim Jagielski //--------------------------------------- 126*b1cdbd2cSJim Jagielski /** @short provide informations abou the parsing state. 127*b1cdbd2cSJim Jagielski 128*b1cdbd2cSJim Jagielski @descr We use it to find out the line and column, where 129*b1cdbd2cSJim Jagielski an error occure. 130*b1cdbd2cSJim Jagielski */ 131*b1cdbd2cSJim Jagielski css::uno::Reference< css::xml::sax::XLocator > m_xLocator; 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski /* SfxAcceleratorItemList& m_aReadAcceleratorList; 134*b1cdbd2cSJim Jagielski */ 135*b1cdbd2cSJim Jagielski 136*b1cdbd2cSJim Jagielski //------------------------------------------- 137*b1cdbd2cSJim Jagielski // interface 138*b1cdbd2cSJim Jagielski 139*b1cdbd2cSJim Jagielski public: 140*b1cdbd2cSJim Jagielski 141*b1cdbd2cSJim Jagielski //--------------------------------------- 142*b1cdbd2cSJim Jagielski /** @short connect this new reader/writer instance 143*b1cdbd2cSJim Jagielski to an outside container, which should be used 144*b1cdbd2cSJim Jagielski flushed to the underlying XML configuration or 145*b1cdbd2cSJim Jagielski filled from there. 146*b1cdbd2cSJim Jagielski 147*b1cdbd2cSJim Jagielski @param rContainer 148*b1cdbd2cSJim Jagielski a reference to the outside container. 149*b1cdbd2cSJim Jagielski */ 150*b1cdbd2cSJim Jagielski AcceleratorConfigurationReader(AcceleratorCache& rContainer); 151*b1cdbd2cSJim Jagielski 152*b1cdbd2cSJim Jagielski //--------------------------------------- 153*b1cdbd2cSJim Jagielski /** @short does nothing real ... */ 154*b1cdbd2cSJim Jagielski virtual ~AcceleratorConfigurationReader(); 155*b1cdbd2cSJim Jagielski 156*b1cdbd2cSJim Jagielski //--------------------------------------- 157*b1cdbd2cSJim Jagielski // XInterface 158*b1cdbd2cSJim Jagielski FWK_DECLARE_XINTERFACE 159*b1cdbd2cSJim Jagielski 160*b1cdbd2cSJim Jagielski //--------------------------------------- 161*b1cdbd2cSJim Jagielski // XDocumentHandler 162*b1cdbd2cSJim Jagielski virtual void SAL_CALL startDocument() 163*b1cdbd2cSJim Jagielski throw(css::xml::sax::SAXException, 164*b1cdbd2cSJim Jagielski css::uno::RuntimeException ); 165*b1cdbd2cSJim Jagielski 166*b1cdbd2cSJim Jagielski virtual void SAL_CALL endDocument() 167*b1cdbd2cSJim Jagielski throw(css::xml::sax::SAXException, 168*b1cdbd2cSJim Jagielski css::uno::RuntimeException ); 169*b1cdbd2cSJim Jagielski 170*b1cdbd2cSJim Jagielski virtual void SAL_CALL startElement(const ::rtl::OUString& sElement , 171*b1cdbd2cSJim Jagielski const css::uno::Reference< css::xml::sax::XAttributeList >& xAttributeList) 172*b1cdbd2cSJim Jagielski throw(css::xml::sax::SAXException, 173*b1cdbd2cSJim Jagielski css::uno::RuntimeException ); 174*b1cdbd2cSJim Jagielski 175*b1cdbd2cSJim Jagielski virtual void SAL_CALL endElement(const ::rtl::OUString& sElement) 176*b1cdbd2cSJim Jagielski throw(css::xml::sax::SAXException, 177*b1cdbd2cSJim Jagielski css::uno::RuntimeException ); 178*b1cdbd2cSJim Jagielski 179*b1cdbd2cSJim Jagielski virtual void SAL_CALL characters(const ::rtl::OUString& sChars) 180*b1cdbd2cSJim Jagielski throw(css::xml::sax::SAXException, 181*b1cdbd2cSJim Jagielski css::uno::RuntimeException ); 182*b1cdbd2cSJim Jagielski 183*b1cdbd2cSJim Jagielski virtual void SAL_CALL ignorableWhitespace(const ::rtl::OUString& sWhitespaces) 184*b1cdbd2cSJim Jagielski throw(css::xml::sax::SAXException, 185*b1cdbd2cSJim Jagielski css::uno::RuntimeException ); 186*b1cdbd2cSJim Jagielski 187*b1cdbd2cSJim Jagielski virtual void SAL_CALL processingInstruction(const ::rtl::OUString& sTarget, 188*b1cdbd2cSJim Jagielski const ::rtl::OUString& sData ) 189*b1cdbd2cSJim Jagielski throw(css::xml::sax::SAXException, 190*b1cdbd2cSJim Jagielski css::uno::RuntimeException ); 191*b1cdbd2cSJim Jagielski 192*b1cdbd2cSJim Jagielski virtual void SAL_CALL setDocumentLocator(const css::uno::Reference< css::xml::sax::XLocator >& xLocator) 193*b1cdbd2cSJim Jagielski throw(css::xml::sax::SAXException, 194*b1cdbd2cSJim Jagielski css::uno::RuntimeException ); 195*b1cdbd2cSJim Jagielski 196*b1cdbd2cSJim Jagielski //------------------------------------------- 197*b1cdbd2cSJim Jagielski // helper 198*b1cdbd2cSJim Jagielski 199*b1cdbd2cSJim Jagielski private: 200*b1cdbd2cSJim Jagielski 201*b1cdbd2cSJim Jagielski //--------------------------------------- 202*b1cdbd2cSJim Jagielski /** TODO document me */ 203*b1cdbd2cSJim Jagielski static EXMLElement implst_classifyElement(const ::rtl::OUString& sElement); 204*b1cdbd2cSJim Jagielski 205*b1cdbd2cSJim Jagielski //--------------------------------------- 206*b1cdbd2cSJim Jagielski /** TODO document me */ 207*b1cdbd2cSJim Jagielski static EXMLAttribute implst_classifyAttribute(const ::rtl::OUString& sAttribute); 208*b1cdbd2cSJim Jagielski 209*b1cdbd2cSJim Jagielski //--------------------------------------- 210*b1cdbd2cSJim Jagielski /** TODO document me */ 211*b1cdbd2cSJim Jagielski ::rtl::OUString implts_getErrorLineString(); 212*b1cdbd2cSJim Jagielski }; 213*b1cdbd2cSJim Jagielski 214*b1cdbd2cSJim Jagielski } // namespace framework 215*b1cdbd2cSJim Jagielski 216*b1cdbd2cSJim Jagielski #endif // _FRAMEWORK_XML_ACCELERATORCONFIGURATIONREADER_HXX_ 217