framework/source/xml/toolboxdocumenthandler.cxx

   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: toolboxdocumenthandler.cxx,v $
  10  * $Revision: 1.17 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_framework.hxx"
  33
  34 #include <stdio.h>
  35
  36 //_________________________________________________________________________________________________________________
  37 //      my own includes
  38 //_________________________________________________________________________________________________________________
  39
  40 #include <threadhelp/resetableguard.hxx>
  41 #include <xml/toolboxdocumenthandler.hxx>
  42 #include <macros/debug.hxx>
  43 #include <xml/toolboxconfigurationdefines.hxx>
  44
  45 //_________________________________________________________________________________________________________________
  46 //      interface includes
  47 //_________________________________________________________________________________________________________________
  48 #include <com/sun/star/xml/sax/XExtendedDocumentHandler.hpp>
  49 #include <com/sun/star/ui/ItemType.hpp>
  50 #include <com/sun/star/ui/ItemStyle.hpp>
  51 #include <com/sun/star/beans/XPropertySet.hpp>
  52
  53 //_________________________________________________________________________________________________________________
  54 //      other includes
  55 //_________________________________________________________________________________________________________________
  56
  57 #include <sal/config.h>
  58 #include <vcl/svapp.hxx>
  59 #include <vcl/toolbox.hxx>
  60 #include <rtl/ustrbuf.hxx>
  61
  62 #include <comphelper/attributelist.hxx>
  63
  64 //_________________________________________________________________________________________________________________
  65 //      namespace
  66 //_________________________________________________________________________________________________________________
  67
  68 using namespace ::com::sun::star::uno;
  69 using namespace ::com::sun::star::beans;
  70 using namespace ::com::sun::star::container;
  71 using namespace ::com::sun::star::xml::sax;
  72
  73
  74 #define TOOLBAR_DOCTYPE                         "<!DOCTYPE toolbar:toolbar PUBLIC \"-//OpenOffice.org//DTD OfficeDocument 1.0//EN\" \"toolbar.dtd\">"
  75
  76 namespace framework
  77 {
  78
  79 // Property names of a menu/menu item ItemDescriptor
  80 static const char ITEM_DESCRIPTOR_COMMANDURL[]  = "CommandURL";
  81 static const char ITEM_DESCRIPTOR_HELPURL[]     = "HelpURL";
  82 static const char ITEM_DESCRIPTOR_LABEL[]       = "Label";
  83 static const char ITEM_DESCRIPTOR_TYPE[]        = "Type";
  84 static const char ITEM_DESCRIPTOR_STYLE[]       = "Style";
  85 static const char ITEM_DESCRIPTOR_VISIBLE[]     = "IsVisible";
  86 static const char ITEM_DESCRIPTOR_WIDTH[]       = "Width";
  87
  88 static void ExtractToolbarParameters( const Sequence< PropertyValue > rProp,
  89                                       ::rtl::OUString&                       rCommandURL,
  90                                       ::rtl::OUString&                       rLabel,
  91                                       ::rtl::OUString&                       rHelpURL,
  92                                       sal_Int16&                      rWidth,
  93                                       sal_Bool&                       rVisible,
  94                                       sal_Int16&                      rType )
  95 {
  96     for ( sal_Int32 i = 0; i < rProp.getLength(); i++ )
  97     {
  98         if ( rProp[i].Name.equalsAscii( ITEM_DESCRIPTOR_COMMANDURL ))
  99         {
 100             rProp[i].Value >>= rCommandURL;
 101             rCommandURL = rCommandURL.intern();
 102         }
 103         else if ( rProp[i].Name.equalsAscii( ITEM_DESCRIPTOR_HELPURL ))
 104             rProp[i].Value >>= rHelpURL;
 105         else if ( rProp[i].Name.equalsAscii( ITEM_DESCRIPTOR_LABEL ))
 106             rProp[i].Value >>= rLabel;
 107         else if ( rProp[i].Name.equalsAscii( ITEM_DESCRIPTOR_TYPE ))
 108             rProp[i].Value >>= rType;
 109         else if ( rProp[i].Name.equalsAscii( ITEM_DESCRIPTOR_VISIBLE ))
 110             rProp[i].Value >>= rVisible;
 111         else if ( rProp[i].Name.equalsAscii( ITEM_DESCRIPTOR_WIDTH ))
 112             rProp[i].Value >>= rWidth;
 113     }
 114 }
 115
 116 struct ToolBarEntryProperty
 117 {
 118     OReadToolBoxDocumentHandler::ToolBox_XML_Namespace  nNamespace;
 119     char                                                                                                aEntryName[20];
 120 };
 121
 122 ToolBarEntryProperty ToolBoxEntries[OReadToolBoxDocumentHandler::TB_XML_ENTRY_COUNT] =
 123 {
 124     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,       ELEMENT_TOOLBAR                         },
 125     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,       ELEMENT_TOOLBARITEM                     },
 126     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,       ELEMENT_TOOLBARSPACE            },
 127     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,       ELEMENT_TOOLBARBREAK            },
 128     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,       ELEMENT_TOOLBARSEPARATOR        },
 129     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,       ATTRIBUTE_TEXT                          },
 130     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,       ATTRIBUTE_BITMAP                        },
 131     { OReadToolBoxDocumentHandler::TB_NS_XLINK,         ATTRIBUTE_URL                           },
 132     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,       ATTRIBUTE_ITEMBITS                      },
 133     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,       ATTRIBUTE_VISIBLE                       },
 134     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,       ATTRIBUTE_WIDTH                         },
 135     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,       ATTRIBUTE_USER                          },
 136     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,       ATTRIBUTE_HELPID                        },
 137     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,       ATTRIBUTE_ITEMSTYLE                     },
 138     { OReadToolBoxDocumentHandler::TB_NS_TOOLBAR,   ATTRIBUTE_UINAME            }
 139 };
 140
 141 OReadToolBoxDocumentHandler::OReadToolBoxDocumentHandler( const Reference< XIndexContainer >& rItemContainer ) :
 142     ThreadHelpBase( &Application::GetSolarMutex() ),
 143     m_rItemContainer( rItemContainer ),
 144     m_aType( RTL_CONSTASCII_USTRINGPARAM( ITEM_DESCRIPTOR_TYPE )),
 145     m_aLabel( RTL_CONSTASCII_USTRINGPARAM( ITEM_DESCRIPTOR_LABEL )),
 146     m_aStyle( RTL_CONSTASCII_USTRINGPARAM( ITEM_DESCRIPTOR_STYLE )),
 147     m_aHelpURL( RTL_CONSTASCII_USTRINGPARAM( ITEM_DESCRIPTOR_HELPURL )),
 148     m_aIsVisible( RTL_CONSTASCII_USTRINGPARAM( ITEM_DESCRIPTOR_VISIBLE )),
 149     m_aCommandURL( RTL_CONSTASCII_USTRINGPARAM( ITEM_DESCRIPTOR_COMMANDURL ))
 150  {
 151     ::rtl::OUString aNamespaceToolBar( RTL_CONSTASCII_USTRINGPARAM( XMLNS_TOOLBAR ));
 152     ::rtl::OUString aNamespaceXLink( RTL_CONSTASCII_USTRINGPARAM( XMLNS_XLINK ));
 153     ::rtl::OUString aSeparator( RTL_CONSTASCII_USTRINGPARAM( XMLNS_FILTER_SEPARATOR ));
 154
 155     // create hash map
 156     for ( int i = 0; i < (int)TB_XML_ENTRY_COUNT; i++ )
 157     {
 158         if ( ToolBoxEntries[i].nNamespace == TB_NS_TOOLBAR )
 159         {
 160             ::rtl::OUString temp( aNamespaceToolBar );
 161             temp += aSeparator;
 162             temp += ::rtl::OUString::createFromAscii( ToolBoxEntries[i].aEntryName );
 163             m_aToolBoxMap.insert( ToolBoxHashMap::value_type( temp, (ToolBox_XML_Entry)i ) );
 164         }
 165         else
 166         {
 167             ::rtl::OUString temp( aNamespaceXLink );
 168             temp += aSeparator;
 169             temp += ::rtl::OUString::createFromAscii( ToolBoxEntries[i].aEntryName );
 170             m_aToolBoxMap.insert( ToolBoxHashMap::value_type( temp, (ToolBox_XML_Entry)i ) );
 171         }
 172     }
 173
 174     // pre-calculate a hash code for all style strings to speed up xml read process
 175     m_nHashCode_Style_Radio                 = ::rtl::OUString::createFromAscii( ATTRIBUTE_ITEMSTYLE_RADIO ).hashCode();
 176     m_nHashCode_Style_Auto                  = ::rtl::OUString::createFromAscii( ATTRIBUTE_ITEMSTYLE_AUTO ).hashCode();
 177     m_nHashCode_Style_Left                  = ::rtl::OUString::createFromAscii( ATTRIBUTE_ITEMSTYLE_LEFT ).hashCode();
 178     m_nHashCode_Style_AutoSize      = ::rtl::OUString::createFromAscii( ATTRIBUTE_ITEMSTYLE_AUTOSIZE ).hashCode();
 179     m_nHashCode_Style_DropDown      = ::rtl::OUString::createFromAscii( ATTRIBUTE_ITEMSTYLE_DROPDOWN ).hashCode();
 180     m_nHashCode_Style_Repeat        = ::rtl::OUString::createFromAscii( ATTRIBUTE_ITEMSTYLE_REPEAT ).hashCode();
 181     m_nHashCode_Style_DropDownOnly  = ::rtl::OUString::createFromAscii( ATTRIBUTE_ITEMSTYLE_DROPDOWNONLY ).hashCode();
 182
 183     m_bToolBarStartFound                        = sal_False;
 184     m_bToolBarEndFound                          = sal_False;
 185     m_bToolBarItemStartFound            = sal_False;
 186     m_bToolBarSpaceStartFound           = sal_False;
 187     m_bToolBarBreakStartFound           = sal_False;
 188     m_bToolBarSeparatorStartFound       = sal_False;
 189 }
 190
 191 OReadToolBoxDocumentHandler::~OReadToolBoxDocumentHandler()
 192 {
 193 }
 194
 195 // XDocumentHandler
 196 void SAL_CALL OReadToolBoxDocumentHandler::startDocument(void)
 197 throw ( SAXException, RuntimeException )
 198 {
 199 }
 200
 201 void SAL_CALL OReadToolBoxDocumentHandler::endDocument(void)
 202 throw(  SAXException, RuntimeException )
 203 {
 204     ResetableGuard aGuard( m_aLock );
 205
 206     if (( m_bToolBarStartFound && !m_bToolBarEndFound ) ||
 207         ( !m_bToolBarStartFound && m_bToolBarEndFound )         )
 208     {
 209         ::rtl::OUString aErrorMessage = getErrorLineString();
 210         aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "No matching start or end element 'toolbar' found!" ));
 211         throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 212     }
 213 }
 214
 215 void SAL_CALL OReadToolBoxDocumentHandler::startElement(
 216     const ::rtl::OUString& aName, const Reference< XAttributeList > &xAttribs )
 217 throw(  SAXException, RuntimeException )
 218 {
 219     ResetableGuard aGuard( m_aLock );
 220
 221     ToolBoxHashMap::const_iterator pToolBoxEntry = m_aToolBoxMap.find( aName ) ;
 222     if ( pToolBoxEntry != m_aToolBoxMap.end() )
 223     {
 224         switch ( pToolBoxEntry->second )
 225         {
 226             case TB_ELEMENT_TOOLBAR:
 227             {
 228                 if ( m_bToolBarStartFound )
 229                 {
 230                     ::rtl::OUString aErrorMessage = getErrorLineString();
 231                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element 'toolbar:toolbar' cannot be embeded into 'toolbar:toolbar'!" ));
 232                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 233                 }
 234                         else
 235                         {
 236                             // Check if we have a UI name set in our XML file
 237                             ::rtl::OUString aUIName;
 238                             for ( sal_Int16 n = 0; n < xAttribs->getLength(); n++ )
 239                       {
 240                         pToolBoxEntry = m_aToolBoxMap.find( xAttribs->getNameByIndex( n ) );
 241                         if ( pToolBoxEntry != m_aToolBoxMap.end() )
 242                         {
 243                                     switch ( pToolBoxEntry->second )
 244                                     {
 245                                         case TB_ATTRIBUTE_UINAME:
 246                                     aUIName = xAttribs->getValueByIndex( n );
 247                                             break;
 248                                         default:
 249                                             break;
 250                                     }
 251                                 }
 252                             }
 253
 254                             if ( aUIName.getLength() > 0 )
 255                             {
 256                                 // Try to set UI name as a container property
 257                                 Reference< XPropertySet > xPropSet( m_rItemContainer, UNO_QUERY );
 258                                 if ( xPropSet.is() )
 259                                 {
 260                                     try
 261                                     {
 262                                         xPropSet->setPropertyValue( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "UIName" )), makeAny( aUIName ) );
 263                                     }
 264                                     catch ( UnknownPropertyException& )
 265                                     {
 266                                     }
 267                                 }
 268                             }
 269                         }
 270
 271                 m_bToolBarStartFound = sal_True;
 272             }
 273             break;
 274
 275             case TB_ELEMENT_TOOLBARITEM:
 276             {
 277                 if ( !m_bToolBarStartFound )
 278                 {
 279                     ::rtl::OUString aErrorMessage = getErrorLineString();
 280                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element 'toolbar:toolbaritem' must be embeded into element 'toolbar:toolbar'!" ));
 281                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 282                 }
 283
 284                 if ( m_bToolBarSeparatorStartFound ||
 285                      m_bToolBarBreakStartFound ||
 286                      m_bToolBarSpaceStartFound ||
 287                      m_bToolBarItemStartFound )
 288                 {
 289                     ::rtl::OUString aErrorMessage = getErrorLineString();
 290                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element toolbar:toolbaritem is not a container!" ));
 291                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 292                 }
 293
 294                 ::rtl::OUString aAttribute;
 295                 sal_Bool bAttributeURL  = sal_False;
 296
 297                 m_bToolBarItemStartFound = sal_True;
 298                 ::rtl::OUString        aLabel;
 299                 ::rtl::OUString        aCommandURL;
 300                 ::rtl::OUString        aHelpURL;
 301                 ::rtl::OUString        aBitmapName;
 302                 sal_uInt16      nItemBits( 0 );
 303                 sal_uInt16      nWidth( 0 );
 304                 sal_uInt16      nUserDef( 0 );
 305                 sal_Bool        bVisible( sal_True );
 306
 307                 for ( sal_Int16 n = 0; n < xAttribs->getLength(); n++ )
 308                 {
 309                     pToolBoxEntry = m_aToolBoxMap.find( xAttribs->getNameByIndex( n ) );
 310                     if ( pToolBoxEntry != m_aToolBoxMap.end() )
 311                     {
 312                         switch ( pToolBoxEntry->second )
 313                         {
 314                             case TB_ATTRIBUTE_TEXT:
 315                             {
 316                                 aLabel = xAttribs->getValueByIndex( n );
 317                             }
 318                             break;
 319
 320                             case TB_ATTRIBUTE_BITMAP:
 321                             {
 322                                 aBitmapName = xAttribs->getValueByIndex( n );
 323                             }
 324                             break;
 325
 326                             case TB_ATTRIBUTE_URL:
 327                             {
 328                                 bAttributeURL   = sal_True;
 329                                 aCommandURL             = xAttribs->getValueByIndex( n ).intern();
 330                             }
 331                             break;
 332
 333                             case TB_ATTRIBUTE_ITEMBITS:
 334                             {
 335                                 nItemBits = (USHORT)(xAttribs->getValueByIndex( n ).toInt32());
 336                             }
 337                             break;
 338
 339                             case TB_ATTRIBUTE_VISIBLE:
 340                             {
 341                                 if ( xAttribs->getValueByIndex( n ).equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ATTRIBUTE_BOOLEAN_TRUE )) )
 342                                     bVisible = sal_True;
 343                                 else if ( xAttribs->getValueByIndex( n ).equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ATTRIBUTE_BOOLEAN_FALSE )) )
 344                                     bVisible = sal_False;
 345                                 else
 346                                 {
 347                                     ::rtl::OUString aErrorMessage = getErrorLineString();
 348                                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Attribute toolbar:visible must have value 'true' or 'false'!" ));
 349                                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 350                                 }
 351                             }
 352                             break;
 353
 354                             case TB_ATTRIBUTE_WIDTH:
 355                             {
 356                                 nWidth = (USHORT)(xAttribs->getValueByIndex( n ).toInt32());
 357                             }
 358                             break;
 359
 360                             case TB_ATTRIBUTE_USER:
 361                             {
 362                                 nUserDef = (USHORT)(xAttribs->getValueByIndex( n ).toInt32());
 363                             }
 364                             break;
 365
 366                             case TB_ATTRIBUTE_HELPID:
 367                             {
 368                                 aHelpURL = xAttribs->getValueByIndex( n );
 369                             }
 370                             break;
 371
 372                             case TB_ATTRIBUTE_STYLE:
 373                             {
 374                                 // read space seperated item style list
 375                                 ::rtl::OUString aTemp = xAttribs->getValueByIndex( n );
 376                                 sal_Int32 nIndex = 0;
 377
 378                                 do
 379                                 {
 380                                     ::rtl::OUString aToken      = aTemp.getToken( 0, ' ', nIndex );
 381                                     if ( aToken.getLength() > 0 )
 382                                     {
 383                                         sal_Int32 nHashCode = aToken.hashCode();
 384                                         if ( nHashCode == m_nHashCode_Style_Radio )
 385                                             nItemBits |= ::com::sun::star::ui::ItemStyle::RADIO_CHECK;
 386                                         else if ( nHashCode == m_nHashCode_Style_Left )
 387                                             nItemBits |= ::com::sun::star::ui::ItemStyle::ALIGN_LEFT;
 388                                         else if ( nHashCode == m_nHashCode_Style_AutoSize )
 389                                             nItemBits |= ::com::sun::star::ui::ItemStyle::AUTO_SIZE;
 390                                         else if ( nHashCode == m_nHashCode_Style_DropDown )
 391                                             nItemBits |= ::com::sun::star::ui::ItemStyle::DROP_DOWN;
 392                                         else if ( nHashCode == m_nHashCode_Style_Repeat )
 393                                             nItemBits |= ::com::sun::star::ui::ItemStyle::REPEAT;
 394                                         else if ( nHashCode == m_nHashCode_Style_DropDownOnly )
 395                                             nItemBits |= ::com::sun::star::ui::ItemStyle::DROPDOWN_ONLY;
 396                                     }
 397                                 }
 398                                 while ( nIndex >= 0 );
 399                             }
 400                             break;
 401
 402                                           default:
 403                                               break;
 404                         }
 405                     }
 406                 } // for
 407
 408                 if ( !bAttributeURL )
 409                 {
 410                     ::rtl::OUString aErrorMessage = getErrorLineString();
 411                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Required attribute toolbar:url must have a value!" ));
 412                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 413                 }
 414
 415                 if ( aCommandURL.getLength() > 0 )
 416                 {
 417                     Sequence< PropertyValue > aToolbarItemProp( 6 );
 418                     aToolbarItemProp[0].Name = m_aCommandURL;
 419                     aToolbarItemProp[1].Name = m_aHelpURL;
 420                     aToolbarItemProp[2].Name = m_aLabel;
 421                     aToolbarItemProp[3].Name = m_aType;
 422                     aToolbarItemProp[4].Name = m_aStyle;
 423                     aToolbarItemProp[5].Name = m_aIsVisible;
 424
 425                     aToolbarItemProp[0].Value <<= aCommandURL;
 426                     aToolbarItemProp[1].Value <<= aHelpURL;
 427                     aToolbarItemProp[2].Value <<= aLabel;
 428                     aToolbarItemProp[3].Value = makeAny( ::com::sun::star::ui::ItemType::DEFAULT );
 429                     aToolbarItemProp[4].Value <<= nItemBits;
 430                     aToolbarItemProp[5].Value <<= bVisible;
 431
 432                     m_rItemContainer->insertByIndex( m_rItemContainer->getCount(), makeAny( aToolbarItemProp ) );
 433                 }
 434             }
 435             break;
 436
 437             case TB_ELEMENT_TOOLBARSPACE:
 438             {
 439                 if ( m_bToolBarSeparatorStartFound ||
 440                      m_bToolBarBreakStartFound ||
 441                      m_bToolBarSpaceStartFound ||
 442                      m_bToolBarItemStartFound )
 443                 {
 444                     ::rtl::OUString aErrorMessage = getErrorLineString();
 445                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element toolbar:toolbarspace is not a container!" ));
 446                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 447                 }
 448
 449                 m_bToolBarSpaceStartFound = sal_True;
 450
 451                 Sequence< PropertyValue > aToolbarItemProp( 2 );
 452                 aToolbarItemProp[0].Name = m_aCommandURL;
 453                 aToolbarItemProp[1].Name = m_aType;
 454
 455                 aToolbarItemProp[0].Value <<= rtl::OUString();
 456                 aToolbarItemProp[1].Value <<= ::com::sun::star::ui::ItemType::SEPARATOR_SPACE;
 457
 458                 m_rItemContainer->insertByIndex( m_rItemContainer->getCount(), makeAny( aToolbarItemProp ) );
 459             }
 460             break;
 461
 462             case TB_ELEMENT_TOOLBARBREAK:
 463             {
 464                 if ( m_bToolBarSeparatorStartFound ||
 465                      m_bToolBarBreakStartFound ||
 466                      m_bToolBarSpaceStartFound ||
 467                      m_bToolBarItemStartFound )
 468                 {
 469                     ::rtl::OUString aErrorMessage = getErrorLineString();
 470                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element toolbar:toolbarbreak is not a container!" ));
 471                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 472                 }
 473
 474                 m_bToolBarBreakStartFound = sal_True;
 475
 476                 Sequence< PropertyValue > aToolbarItemProp( 2 );
 477                 aToolbarItemProp[0].Name = m_aCommandURL;
 478                 aToolbarItemProp[1].Name = m_aType;
 479
 480                 aToolbarItemProp[0].Value <<= rtl::OUString();
 481                 aToolbarItemProp[1].Value <<= ::com::sun::star::ui::ItemType::SEPARATOR_LINEBREAK;
 482
 483                 m_rItemContainer->insertByIndex( m_rItemContainer->getCount(), makeAny( aToolbarItemProp ) );
 484             }
 485             break;
 486
 487             case TB_ELEMENT_TOOLBARSEPARATOR:
 488             {
 489                 if ( m_bToolBarSeparatorStartFound ||
 490                      m_bToolBarBreakStartFound ||
 491                      m_bToolBarSpaceStartFound ||
 492                      m_bToolBarItemStartFound )
 493                 {
 494                     ::rtl::OUString aErrorMessage = getErrorLineString();
 495                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "Element toolbar:toolbarseparator is not a container!" ));
 496                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 497                 }
 498
 499                 m_bToolBarSeparatorStartFound = sal_True;
 500
 501                 Sequence< PropertyValue > aToolbarItemProp( 2 );
 502                 aToolbarItemProp[0].Name = m_aCommandURL;
 503                 aToolbarItemProp[1].Name = m_aType;
 504
 505                 aToolbarItemProp[0].Value <<= rtl::OUString();
 506                 aToolbarItemProp[1].Value <<= ::com::sun::star::ui::ItemType::SEPARATOR_LINE;
 507
 508                 m_rItemContainer->insertByIndex( m_rItemContainer->getCount(), makeAny( aToolbarItemProp ) );
 509             }
 510             break;
 511
 512                   default:
 513                       break;
 514         }
 515     }
 516 }
 517
 518 void SAL_CALL OReadToolBoxDocumentHandler::endElement(const ::rtl::OUString& aName)
 519 throw(  SAXException, RuntimeException )
 520 {
 521     ResetableGuard aGuard( m_aLock );
 522
 523     ToolBoxHashMap::const_iterator pToolBoxEntry = m_aToolBoxMap.find( aName ) ;
 524     if ( pToolBoxEntry != m_aToolBoxMap.end() )
 525     {
 526         switch ( pToolBoxEntry->second )
 527         {
 528             case TB_ELEMENT_TOOLBAR:
 529             {
 530                 if ( !m_bToolBarStartFound )
 531                 {
 532                     ::rtl::OUString aErrorMessage = getErrorLineString();
 533                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "End element 'toolbar' found, but no start element 'toolbar'" ));
 534                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 535                 }
 536
 537                 m_bToolBarStartFound = sal_False;
 538             }
 539             break;
 540
 541             case TB_ELEMENT_TOOLBARITEM:
 542             {
 543                 if ( !m_bToolBarItemStartFound )
 544                 {
 545                     ::rtl::OUString aErrorMessage = getErrorLineString();
 546                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "End element 'toolbar:toolbaritem' found, but no start element 'toolbar:toolbaritem'" ));
 547                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 548                 }
 549
 550                 m_bToolBarItemStartFound = sal_False;
 551             }
 552             break;
 553
 554             case TB_ELEMENT_TOOLBARBREAK:
 555             {
 556                 if ( !m_bToolBarBreakStartFound )
 557                 {
 558                     ::rtl::OUString aErrorMessage = getErrorLineString();
 559                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "End element 'toolbar:toolbarbreak' found, but no start element 'toolbar:toolbarbreak'" ));
 560                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 561                 }
 562
 563                 m_bToolBarBreakStartFound = sal_False;
 564             }
 565             break;
 566
 567             case TB_ELEMENT_TOOLBARSPACE:
 568             {
 569                 if ( !m_bToolBarSpaceStartFound )
 570                 {
 571                     ::rtl::OUString aErrorMessage = getErrorLineString();
 572                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "End element 'toolbar:toolbarspace' found, but no start element 'toolbar:toolbarspace'" ));
 573                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 574                 }
 575
 576                 m_bToolBarSpaceStartFound = sal_False;
 577             }
 578             break;
 579
 580             case TB_ELEMENT_TOOLBARSEPARATOR:
 581             {
 582                 if ( !m_bToolBarSeparatorStartFound )
 583                 {
 584                     ::rtl::OUString aErrorMessage = getErrorLineString();
 585                     aErrorMessage += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "End element 'toolbar:toolbarseparator' found, but no start element 'toolbar:toolbarseparator'" ));
 586                     throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 587                 }
 588
 589                 m_bToolBarSeparatorStartFound = sal_False;
 590             }
 591             break;
 592
 593                   default:
 594                       break;
 595         }
 596     }
 597 }
 598
 599 void SAL_CALL OReadToolBoxDocumentHandler::characters(const ::rtl::OUString&)
 600 throw(  SAXException, RuntimeException )
 601 {
 602 }
 603
 604 void SAL_CALL OReadToolBoxDocumentHandler::ignorableWhitespace(const ::rtl::OUString&)
 605 throw(  SAXException, RuntimeException )
 606 {
 607 }
 608
 609 void SAL_CALL OReadToolBoxDocumentHandler::processingInstruction(
 610     const ::rtl::OUString& /*aTarget*/, const ::rtl::OUString& /*aData*/ )
 611 throw(  SAXException, RuntimeException )
 612 {
 613 }
 614
 615 void SAL_CALL OReadToolBoxDocumentHandler::setDocumentLocator(
 616     const Reference< XLocator > &xLocator)
 617 throw(  SAXException, RuntimeException )
 618 {
 619     ResetableGuard aGuard( m_aLock );
 620
 621     m_xLocator = xLocator;
 622 }
 623
 624 ::rtl::OUString OReadToolBoxDocumentHandler::getErrorLineString()
 625 {
 626     ResetableGuard aGuard( m_aLock );
 627
 628     char buffer[32];
 629
 630     if ( m_xLocator.is() )
 631     {
 632         snprintf( buffer, sizeof(buffer), "Line: %ld - ", static_cast<long>( m_xLocator->getLineNumber() ));
 633         return ::rtl::OUString::createFromAscii( buffer );
 634     }
 635     else
 636         return ::rtl::OUString();
 637 }
 638
 639
 640 //_________________________________________________________________________________________________________________
 641 //      OWriteToolBoxDocumentHandler
 642 //_________________________________________________________________________________________________________________
 643
 644 OWriteToolBoxDocumentHandler::OWriteToolBoxDocumentHandler(
 645     const Reference< XIndexAccess >& rItemAccess,
 646     Reference< XDocumentHandler >& rWriteDocumentHandler ) :
 647     ThreadHelpBase( &Application::GetSolarMutex() ),
 648     m_xWriteDocumentHandler( rWriteDocumentHandler ),
 649     m_rItemAccess( rItemAccess )
 650 {
 651     ::comphelper::AttributeList* pList = new ::comphelper::AttributeList;
 652     m_xEmptyList                = Reference< XAttributeList >( (XAttributeList *) pList, UNO_QUERY );
 653     m_aAttributeType    = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_TYPE_CDATA ));
 654     m_aXMLXlinkNS               = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( XMLNS_XLINK_PREFIX ));
 655     m_aXMLToolbarNS             = ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( XMLNS_TOOLBAR_PREFIX ));
 656 }
 657
 658 OWriteToolBoxDocumentHandler::~OWriteToolBoxDocumentHandler()
 659 {
 660 }
 661
 662 void OWriteToolBoxDocumentHandler::WriteToolBoxDocument() throw
 663 ( SAXException, RuntimeException )
 664 {
 665     ResetableGuard aGuard( m_aLock );
 666
 667     m_xWriteDocumentHandler->startDocument();
 668
 669     // write DOCTYPE line!
 670     Reference< XExtendedDocumentHandler > xExtendedDocHandler( m_xWriteDocumentHandler, UNO_QUERY );
 671     if ( xExtendedDocHandler.is() )
 672     {
 673         xExtendedDocHandler->unknown( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( TOOLBAR_DOCTYPE )) );
 674         m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 675     }
 676
 677     ::rtl::OUString aUIName;
 678     Reference< XPropertySet > xPropSet( m_rItemAccess, UNO_QUERY );
 679     if ( xPropSet.is() )
 680     {
 681         try
 682         {
 683             xPropSet->getPropertyValue( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( "UIName" ))) >>= aUIName;
 684         }
 685         catch ( UnknownPropertyException& )
 686         {
 687         }
 688     }
 689
 690     ::comphelper::AttributeList* pList = new ::comphelper::AttributeList;
 691     Reference< XAttributeList > xList( (XAttributeList *) pList , UNO_QUERY );
 692
 693     pList->AddAttribute( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_XMLNS_TOOLBAR )),
 694                          m_aAttributeType,
 695                          ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( XMLNS_TOOLBAR )) );
 696
 697     pList->AddAttribute( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_XMLNS_XLINK )),
 698                          m_aAttributeType,
 699                          ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( XMLNS_XLINK )) );
 700
 701     if ( aUIName.getLength() > 0 )
 702         pList->AddAttribute( m_aXMLToolbarNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_UINAME )),
 703                              m_aAttributeType,
 704                              aUIName );
 705
 706     m_xWriteDocumentHandler->startElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_TOOLBAR )), pList );
 707     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 708
 709     sal_Int32  nItemCount = m_rItemAccess->getCount();
 710     Any        aAny;
 711
 712     for ( sal_Int32 nItemPos = 0; nItemPos < nItemCount; nItemPos++ )
 713     {
 714         Sequence< PropertyValue > aProps;
 715         aAny = m_rItemAccess->getByIndex( nItemPos );
 716         if ( aAny >>= aProps )
 717         {
 718             ::rtl::OUString    aCommandURL;
 719             ::rtl::OUString    aLabel;
 720             ::rtl::OUString    aHelpURL;
 721             sal_Bool    bVisible( sal_True );
 722             sal_Int16   nType( ::com::sun::star::ui::ItemType::DEFAULT );
 723             sal_Int16   nWidth( 0 );
 724
 725             ExtractToolbarParameters( aProps, aCommandURL, aLabel, aHelpURL, nWidth, bVisible, nType );
 726             if ( nType == ::com::sun::star::ui::ItemType::DEFAULT )
 727                 WriteToolBoxItem( aCommandURL, aLabel, aHelpURL, nWidth, bVisible );
 728             else if ( nType == ::com::sun::star::ui::ItemType::SEPARATOR_SPACE )
 729                 WriteToolBoxSpace();
 730             else if ( nType == ::com::sun::star::ui::ItemType::SEPARATOR_LINE )
 731                 WriteToolBoxSeparator();
 732             else if ( nType == ::com::sun::star::ui::ItemType::SEPARATOR_LINEBREAK )
 733                 WriteToolBoxBreak();
 734         }
 735     }
 736
 737     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 738     m_xWriteDocumentHandler->endElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_TOOLBAR )) );
 739     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 740     m_xWriteDocumentHandler->endDocument();
 741 }
 742
 743 //_________________________________________________________________________________________________________________
 744 //      protected member functions
 745 //_________________________________________________________________________________________________________________
 746
 747 void OWriteToolBoxDocumentHandler::WriteToolBoxItem(
 748     const ::rtl::OUString& rCommandURL,
 749     const ::rtl::OUString& rLabel,
 750     const ::rtl::OUString& rHelpURL,
 751     sal_Int16       nWidth,
 752     sal_Bool        bVisible )
 753 throw ( SAXException, RuntimeException )
 754 {
 755     ::comphelper::AttributeList* pList = new ::comphelper::AttributeList;
 756     Reference< XAttributeList > xList( (XAttributeList *) pList , UNO_QUERY );
 757
 758     if ( m_aAttributeURL.getLength() == 0 )
 759     {
 760         m_aAttributeURL = m_aXMLXlinkNS;
 761         m_aAttributeURL += ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_URL ));
 762     }
 763
 764     // save required attribute (URL)
 765     pList->AddAttribute( m_aAttributeURL, m_aAttributeType, rCommandURL );
 766
 767     if ( rLabel.getLength() > 0 )
 768     {
 769         pList->AddAttribute( m_aXMLToolbarNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_TEXT )),
 770                              m_aAttributeType,
 771                              rLabel );
 772     }
 773
 774     if ( bVisible == sal_False )
 775     {
 776         pList->AddAttribute( m_aXMLToolbarNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_VISIBLE )),
 777                              m_aAttributeType,
 778                              ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_BOOLEAN_FALSE )) );
 779     }
 780
 781     if ( rHelpURL.getLength() > 0 )
 782     {
 783         pList->AddAttribute( m_aXMLToolbarNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_HELPID )),
 784                              m_aAttributeType,
 785                              rHelpURL );
 786     }
 787
 788     if ( nWidth > 0 )
 789     {
 790         pList->AddAttribute( m_aXMLToolbarNS + ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_WIDTH )),
 791                              m_aAttributeType,
 792                              ::rtl::OUString::valueOf( sal_Int32( nWidth )) );
 793     }
 794
 795     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 796     m_xWriteDocumentHandler->startElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_TOOLBARITEM )), xList );
 797     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 798     m_xWriteDocumentHandler->endElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_TOOLBARITEM )) );
 799 }
 800
 801 void OWriteToolBoxDocumentHandler::WriteToolBoxSpace() throw
 802 ( SAXException, RuntimeException )
 803 {
 804     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 805     m_xWriteDocumentHandler->startElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_TOOLBARSPACE )), m_xEmptyList );
 806     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 807     m_xWriteDocumentHandler->endElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_TOOLBARSPACE )) );
 808 }
 809
 810 void OWriteToolBoxDocumentHandler::WriteToolBoxBreak() throw
 811 ( SAXException, RuntimeException )
 812 {
 813     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 814     m_xWriteDocumentHandler->startElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_TOOLBARBREAK )), m_xEmptyList );
 815     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 816     m_xWriteDocumentHandler->endElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_TOOLBARBREAK )) );
 817 }
 818
 819 void OWriteToolBoxDocumentHandler::WriteToolBoxSeparator() throw
 820 ( SAXException, RuntimeException )
 821 {
 822     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 823     m_xWriteDocumentHandler->startElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_TOOLBARSEPARATOR )), m_xEmptyList );
 824     m_xWriteDocumentHandler->ignorableWhitespace( ::rtl::OUString() );
 825     m_xWriteDocumentHandler->endElement( ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_TOOLBARSEPARATOR )) );
 826 }
 827
 828 } // namespace framework
 829