unotools/source/config/xmlaccelcfg.cxx

   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
  21 #include <unotools/xmlaccelcfg.hxx>
  22
  23 #include <vector>
  24 #include <com/sun/star/xml/sax/XAttributeList.hpp>
  25 #include <cppuhelper/implbase1.hxx>
  26
  27 using namespace com::sun::star::uno;
  28 using namespace com::sun::star::xml::sax;
  29
  30
  31 #define ELEMENT_ACCELERATORLIST     "acceleratorlist"
  32 #define ELEMENT_ACCELERATORITEM     "item"
  33
  34 #define ATTRIBUTE_KEYCODE           "code"
  35 #define ATTRIBUTE_MODIFIER          "modifier"
  36 #define ATTRIBUTE_URL               "url"
  37
  38 #define ATTRIBUTE_TYPE_CDATA        "CDATA"
  39
  40 namespace {
  41
  42 struct AttributeListImpl_impl;
  43 class AttributeListImpl : public ::cppu::WeakImplHelper1< ::com::sun::star::xml::sax::XAttributeList >
  44 {
  45 protected:
  46     ~AttributeListImpl();
  47
  48 public:
  49     AttributeListImpl();
  50     AttributeListImpl( const AttributeListImpl & );
  51
  52 public:
  53     virtual sal_Int16 SAL_CALL getLength(void) throw (::com::sun::star::uno::RuntimeException);
  54     virtual OUString  SAL_CALL getNameByIndex(sal_Int16 i) throw (::com::sun::star::uno::RuntimeException);
  55     virtual OUString  SAL_CALL getTypeByIndex(sal_Int16 i) throw (::com::sun::star::uno::RuntimeException);
  56     virtual OUString  SAL_CALL getTypeByName(const OUString& aName) throw (::com::sun::star::uno::RuntimeException);
  57     virtual OUString  SAL_CALL getValueByIndex(sal_Int16 i) throw (::com::sun::star::uno::RuntimeException);
  58     virtual OUString  SAL_CALL getValueByName(const OUString& aName) throw (::com::sun::star::uno::RuntimeException);
  59
  60 public:
  61     void addAttribute( const OUString &sName , const OUString &sType , const OUString &sValue );
  62
  63 private:
  64     struct AttributeListImpl_impl *m_pImpl;
  65 };
  66
  67 struct TagAttribute
  68 {
  69     TagAttribute(){}
  70     TagAttribute( const OUString &aName, const OUString &aType , const OUString &aValue )
  71     {
  72         sName   = aName;
  73         sType   = aType;
  74         sValue  = aValue;
  75     }
  76
  77     OUString sName;
  78     OUString sType;
  79     OUString sValue;
  80 };
  81
  82 struct AttributeListImpl_impl
  83 {
  84     AttributeListImpl_impl()
  85     {
  86         // performance improvement during adding
  87         vecAttribute.reserve(20);
  88     }
  89     ::std::vector<struct TagAttribute> vecAttribute;
  90 };
  91
  92
  93
  94 sal_Int16 SAL_CALL AttributeListImpl::getLength(void) throw (RuntimeException)
  95 {
  96     return sal::static_int_cast< sal_Int16 >(m_pImpl->vecAttribute.size());
  97 }
  98
  99
 100 AttributeListImpl::AttributeListImpl( const AttributeListImpl &r ) :
 101     cppu::WeakImplHelper1<com::sun::star::xml::sax::XAttributeList>(r)
 102 {
 103     m_pImpl = new AttributeListImpl_impl;
 104     *m_pImpl = *(r.m_pImpl);
 105 }
 106
 107 OUString AttributeListImpl::getNameByIndex(sal_Int16 i) throw (RuntimeException)
 108 {
 109     if( i < sal::static_int_cast<sal_Int16>(m_pImpl->vecAttribute.size()) ) {
 110         return m_pImpl->vecAttribute[i].sName;
 111     }
 112     return OUString();
 113 }
 114
 115
 116 OUString AttributeListImpl::getTypeByIndex(sal_Int16 i) throw (RuntimeException)
 117 {
 118     if( i < sal::static_int_cast<sal_Int16>(m_pImpl->vecAttribute.size()) ) {
 119         return m_pImpl->vecAttribute[i].sType;
 120     }
 121     return OUString();
 122 }
 123
 124 OUString AttributeListImpl::getValueByIndex(sal_Int16 i) throw (RuntimeException)
 125 {
 126     if( i < sal::static_int_cast<sal_Int16>(m_pImpl->vecAttribute.size()) ) {
 127         return m_pImpl->vecAttribute[i].sValue;
 128     }
 129     return OUString();
 130
 131 }
 132
 133 OUString AttributeListImpl::getTypeByName( const OUString& sName ) throw (RuntimeException)
 134 {
 135     ::std::vector<struct TagAttribute>::iterator ii = m_pImpl->vecAttribute.begin();
 136
 137     for( ; ii != m_pImpl->vecAttribute.end() ; ++ii  ) {
 138         if( (*ii).sName == sName ) {
 139             return (*ii).sType;
 140         }
 141     }
 142     return OUString();
 143 }
 144
 145 OUString AttributeListImpl::getValueByName(const OUString& sName) throw (RuntimeException)
 146 {
 147     ::std::vector<struct TagAttribute>::iterator ii = m_pImpl->vecAttribute.begin();
 148
 149     for( ; ii != m_pImpl->vecAttribute.end() ; ++ii ) {
 150         if( (*ii).sName == sName ) {
 151             return (*ii).sValue;
 152         }
 153     }
 154     return OUString();
 155 }
 156
 157
 158 AttributeListImpl::AttributeListImpl()
 159 {
 160     m_pImpl = new AttributeListImpl_impl;
 161 }
 162
 163
 164
 165 AttributeListImpl::~AttributeListImpl()
 166 {
 167     delete m_pImpl;
 168 }
 169
 170
 171 void AttributeListImpl::addAttribute(   const OUString &sName ,
 172                                         const OUString &sType ,
 173                                         const OUString &sValue )
 174 {
 175     m_pImpl->vecAttribute.push_back( TagAttribute( sName , sType , sValue ) );
 176 }
 177
 178 } // anonymous namespace
 179
 180 Any SAL_CALL OReadAccelatorDocumentHandler::queryInterface( const Type & rType ) throw( RuntimeException )
 181 {
 182     Any a = ::cppu::queryInterface( rType ,(static_cast< XDocumentHandler* >(this)));
 183     if ( a.hasValue() )
 184         return a;
 185     else
 186         return OWeakObject::queryInterface( rType );
 187 }
 188
 189 void SAL_CALL OReadAccelatorDocumentHandler::ignorableWhitespace(
 190     const OUString& )
 191 throw( SAXException, RuntimeException )
 192 {
 193 }
 194
 195 void SAL_CALL OReadAccelatorDocumentHandler::processingInstruction(
 196     const OUString&, const OUString& )
 197 throw( SAXException, RuntimeException )
 198 {
 199 }
 200
 201 void SAL_CALL OReadAccelatorDocumentHandler::setDocumentLocator(
 202     const Reference< XLocator > &xLocator)
 203 throw(  SAXException, RuntimeException )
 204 {
 205     m_xLocator = xLocator;
 206 }
 207
 208 OUString OReadAccelatorDocumentHandler::getErrorLineString()
 209 {
 210     char buffer[32];
 211
 212     if ( m_xLocator.is() )
 213     {
 214         return OUString::createFromAscii( buffer );
 215     }
 216     else
 217         return OUString();
 218 }
 219
 220 void SAL_CALL OReadAccelatorDocumentHandler::startDocument(void)
 221     throw ( SAXException, RuntimeException )
 222 {
 223 }
 224
 225 void SAL_CALL OReadAccelatorDocumentHandler::endDocument(void)
 226     throw( SAXException, RuntimeException )
 227 {
 228     if ( m_nElementDepth > 0 )
 229     {
 230         OUString aErrorMessage = getErrorLineString();
 231         aErrorMessage += "A closing element is missing!";
 232         throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 233     }
 234 }
 235
 236
 237 void SAL_CALL OReadAccelatorDocumentHandler::startElement(
 238     const OUString& aElementName, const Reference< XAttributeList > &xAttrList )
 239 throw( SAXException, RuntimeException )
 240 {
 241     m_nElementDepth++;
 242
 243     if ( aElementName == ELEMENT_ACCELERATORLIST )
 244     {
 245         // acceleratorlist
 246         if ( m_bAcceleratorMode )
 247         {
 248             OUString aErrorMessage = getErrorLineString();
 249             aErrorMessage += "Accelerator list used twice!";
 250             throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 251         }
 252         else
 253             m_bAcceleratorMode = sal_True;
 254     }
 255     else if ( aElementName == ELEMENT_ACCELERATORITEM )
 256     {
 257         // accelerator item
 258         if ( !m_bAcceleratorMode )
 259         {
 260             OUString aErrorMessage = getErrorLineString();
 261             aErrorMessage += "Accelerator list element has to be used before!";
 262             throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 263         }
 264         else
 265         {
 266             // read accelerator item
 267             m_bItemCloseExpected = sal_True;
 268
 269             SvtAcceleratorConfigItem aItem;
 270
 271             // read attributes for accelerator
 272             for ( sal_Int16 i=0; i< xAttrList->getLength(); i++ )
 273             {
 274                 OUString aName = xAttrList->getNameByIndex( i );
 275                 OUString aValue = xAttrList->getValueByIndex( i );
 276
 277                 if ( aName == ATTRIBUTE_URL )
 278                     aItem.aCommand = aValue;
 279                 else if ( aName == ATTRIBUTE_MODIFIER )
 280                     aItem.nModifier = (sal_uInt16)aValue.toInt32();
 281                 else if ( aName == ATTRIBUTE_KEYCODE )
 282                     aItem.nCode = (sal_uInt16)aValue.toInt32();
 283             }
 284
 285             m_aReadAcceleratorList.push_back( aItem );
 286         }
 287     }
 288     else
 289     {
 290         OUString aErrorMessage = getErrorLineString();
 291         aErrorMessage += "Unknown element found!";
 292         throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 293     }
 294 }
 295
 296
 297 void SAL_CALL OReadAccelatorDocumentHandler::characters(const OUString&)
 298 throw(  SAXException, RuntimeException )
 299 {
 300 }
 301
 302
 303 void SAL_CALL OReadAccelatorDocumentHandler::endElement( const OUString& aName )
 304     throw( SAXException, RuntimeException )
 305 {
 306     m_nElementDepth--;
 307
 308     if ( aName == ELEMENT_ACCELERATORLIST )
 309     {
 310         // acceleratorlist
 311         if ( !m_bAcceleratorMode )
 312         {
 313             OUString aErrorMessage = getErrorLineString();
 314             aErrorMessage += "Accelerator list used twice!";
 315             throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 316         }
 317     }
 318     else if ( aName == ELEMENT_ACCELERATORITEM )
 319     {
 320         if ( !m_bItemCloseExpected )
 321         {
 322             OUString aErrorMessage = getErrorLineString();
 323             aErrorMessage += "Closing accelerator item element expected!";
 324             throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 325         }
 326     }
 327     else
 328     {
 329         OUString aErrorMessage = getErrorLineString();
 330         aErrorMessage += "Unknown closing element found!";
 331         throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 332     }
 333 }
 334
 335 // ------------------------------------------------------------------
 336
 337 OWriteAccelatorDocumentHandler::OWriteAccelatorDocumentHandler(
 338     const SvtAcceleratorItemList& aWriteAcceleratorList, Reference< XDocumentHandler > xDocumentHandler ) :
 339     m_xWriteDocumentHandler( xDocumentHandler ),
 340     m_aWriteAcceleratorList( aWriteAcceleratorList )
 341 {
 342     m_aAttributeType = OUString( ATTRIBUTE_TYPE_CDATA );
 343 }
 344
 345 OWriteAccelatorDocumentHandler::~OWriteAccelatorDocumentHandler()
 346 {
 347 }
 348
 349 void OWriteAccelatorDocumentHandler::WriteAcceleratorDocument()
 350     throw ( SAXException, RuntimeException )
 351 {
 352     AttributeListImpl* pList = new AttributeListImpl;
 353     Reference< XAttributeList > rList( (XAttributeList *)pList , UNO_QUERY );
 354
 355     m_xWriteDocumentHandler->startDocument();
 356     m_xWriteDocumentHandler->startElement( OUString( ELEMENT_ACCELERATORLIST ), rList );
 357     m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 358
 359     std::list< SvtAcceleratorConfigItem>::const_iterator p;
 360     for ( p = m_aWriteAcceleratorList.begin(); p != m_aWriteAcceleratorList.end(); ++p )
 361         WriteAcceleratorItem( *p );
 362
 363     m_xWriteDocumentHandler->endElement( OUString( ELEMENT_ACCELERATORLIST ) );
 364     m_xWriteDocumentHandler->endDocument();
 365 }
 366
 367 void OWriteAccelatorDocumentHandler::WriteAcceleratorItem(
 368     const SvtAcceleratorConfigItem& aAcceleratorItem )
 369     throw( SAXException, RuntimeException )
 370 {
 371     AttributeListImpl* pAcceleratorAttributes = new AttributeListImpl;
 372     Reference< XAttributeList > xAcceleratorAttrList( (XAttributeList *)pAcceleratorAttributes , UNO_QUERY );
 373
 374     // set attributes
 375     pAcceleratorAttributes->addAttribute(
 376         OUString( ATTRIBUTE_KEYCODE ),
 377         m_aAttributeType,
 378         OUString::valueOf( aAcceleratorItem.nCode ));
 379
 380     pAcceleratorAttributes->addAttribute(
 381         OUString( ATTRIBUTE_MODIFIER ),
 382         m_aAttributeType,
 383         OUString::valueOf( aAcceleratorItem.nModifier ));
 384
 385     pAcceleratorAttributes->addAttribute(
 386         OUString( ATTRIBUTE_URL ),
 387         m_aAttributeType,
 388         aAcceleratorItem.aCommand );
 389
 390     // write start element
 391     m_xWriteDocumentHandler->startElement(
 392         OUString( ELEMENT_ACCELERATORITEM ),
 393         xAcceleratorAttrList );
 394     m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 395     m_xWriteDocumentHandler->endElement( OUString( ELEMENT_ACCELERATORITEM ) );
 396 }
 397
 398 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */