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