framework/source/services/menudocumenthandler.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: menudocumenthandler.cxx,v $
  10  * $Revision: 1.14 $
  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 #include <services/menudocumenthandler.hxx>
  36 #include <classes/menuconfiguration.hxx>
  37 #include <classes/addonmenu.hxx>
  38
  39 #ifndef __FRAMEWORK_SERVICES_ATTRIBUTELIST_HXX_
  40 #include <services/attributelist.hxx>
  41 #endif
  42
  43 #ifndef __COM_SUN_STAR_XML_SAX_XEXTENDEDDOCUMENTHANDLER_HPP_
  44 #include <com/sun/star/xml/sax/XExtendedDocumentHandler.hpp>
  45 #endif
  46
  47
  48 using namespace ::rtl;
  49 using namespace ::com::sun::star::uno;
  50 using namespace ::com::sun::star::xml::sax;
  51
  52 const int ITEMID_START_VALUE = 1000;
  53
  54 #define XMLNS_MENU                              "http://openoffice.org/2001/menu"
  55 #define XMLNS_PREFIX                    "menu:"
  56
  57 #define ELEMENT_MENUBAR                 "http://openoffice.org/2001/menu^menubar"
  58 #define ELEMENT_MENU                    "http://openoffice.org/2001/menu^menu"
  59 #define ELEMENT_MENUPOPUP               "http://openoffice.org/2001/menu^menupopup"
  60 #define ELEMENT_MENUITEM                "http://openoffice.org/2001/menu^menuitem"
  61 #define ELEMENT_MENUSEPARATOR   "http://openoffice.org/2001/menu^menuseparator"
  62
  63 #define ELEMENT_NS_MENUBAR                      "menu:menubar"
  64 #define ELEMENT_NS_MENU                         "menu:menu"
  65 #define ELEMENT_NS_MENUPOPUP            "menu:menupopup"
  66 #define ELEMENT_NS_MENUITEM                     "menu:menuitem"
  67 #define ELEMENT_NS_MENUSEPARATOR        "menu:menuseparator"
  68
  69 #define ATTRIBUTE_ID                    "http://openoffice.org/2001/menu^id"
  70 #define ATTRIBUTE_LABEL                 "http://openoffice.org/2001/menu^label"
  71 #define ATTRIBUTE_HELPID                "http://openoffice.org/2001/menu^helpid"
  72 #define ATTRIBUTE_LINEBREAK             "http://openoffice.org/2001/menu^linebreak"
  73
  74 #define ATTRIBUTE_NS_ID                 "menu:id"
  75 #define ATTRIBUTE_NS_LABEL              "menu:label"
  76 #define ATTRIBUTE_NS_HELPID             "menu:helpid"
  77 #define ATTRIBUTE_NS_LINEBREAK  "menu:linebreak"
  78
  79 #define ATTRIBUTE_XMLNS_MENU    "xmlns:menu"
  80
  81 #define ATTRIBUTE_TYPE_CDATA    "CDATA"
  82
  83 #define MENUBAR_DOCTYPE                 "<!DOCTYPE menu:menubar PUBLIC \"-//OpenOffice.org//DTD OfficeDocument 1.0//EN\" \"menubar.dtd\">"
  84
  85
  86 // special popup menus (filled during runtime) must be saved as a menuitem!!!
  87 // same as in menumanager.cxx - you have to change both files!!!
  88 #define SID_SFX_START                   5000
  89 #define SID_NEWDOCDIRECT                (SID_SFX_START + 537)
  90 #define SID_AUTOPILOTMENU               (SID_SFX_START + 1381)
  91 #define SID_FORMATMENU          (SID_SFX_START + 780)
  92
  93 const ::rtl::OUString aSlotProtocol( RTL_CONSTASCII_USTRINGPARAM( "slot:" ));
  94 const ::rtl::OUString aSlotNewDocDirect( RTL_CONSTASCII_USTRINGPARAM( "slot:5537" ));
  95 const ::rtl::OUString aSlotAutoPilot( RTL_CONSTASCII_USTRINGPARAM( "slot:6381" ));
  96
  97 const ::rtl::OUString aSpecialFileMenu( RTL_CONSTASCII_USTRINGPARAM( "file" ));
  98 const ::rtl::OUString aSpecialWindowMenu( RTL_CONSTASCII_USTRINGPARAM( "window" ));
  99
 100 const ULONG  MENU_SAVE_LABEL                    = 0x00000001;
 101
 102 namespace framework
 103 {
 104
 105 // -----------------------------------------------------------------------------
 106 // Base class implementation
 107
 108 ReadMenuDocumentHandlerBase::ReadMenuDocumentHandlerBase() :
 109     m_xLocator( 0 ),
 110     m_xReader( 0 )
 111 {
 112 }
 113
 114 ReadMenuDocumentHandlerBase::~ReadMenuDocumentHandlerBase()
 115 {
 116 }
 117
 118 Any SAL_CALL ReadMenuDocumentHandlerBase::queryInterface(
 119     const Type & rType )
 120 throw( RuntimeException )
 121 {
 122     Any a = ::cppu::queryInterface(
 123                 rType ,
 124                 SAL_STATIC_CAST( XDocumentHandler*, this ));
 125     if ( a.hasValue() )
 126         return a;
 127
 128     return OWeakObject::queryInterface( rType );
 129 }
 130
 131 void SAL_CALL ReadMenuDocumentHandlerBase::ignorableWhitespace(
 132     const OUString& aWhitespaces )
 133 throw( SAXException, RuntimeException )
 134 {
 135 }
 136
 137 void SAL_CALL ReadMenuDocumentHandlerBase::processingInstruction(
 138     const OUString& aTarget, const OUString& aData )
 139 throw( SAXException, RuntimeException )
 140 {
 141 }
 142
 143 void SAL_CALL ReadMenuDocumentHandlerBase::setDocumentLocator(
 144     const Reference< XLocator > &xLocator)
 145 throw(  SAXException, RuntimeException )
 146 {
 147     m_xLocator = xLocator;
 148 }
 149
 150 ::rtl::OUString ReadMenuDocumentHandlerBase::getErrorLineString()
 151 {
 152     char buffer[32];
 153
 154     if ( m_xLocator.is() )
 155     {
 156         snprintf( buffer, sizeof(buffer), "Line: %ld - ", static_cast<long>( m_xLocator->getLineNumber() ));
 157         return OUString::createFromAscii( buffer );
 158     }
 159     else
 160         return OUString();
 161 }
 162
 163 // -----------------------------------------------------------------------------
 164
 165 // #110897#
 166 OReadMenuDocumentHandler::OReadMenuDocumentHandler(
 167     const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xServiceFactory,
 168     MenuBar* pMenuBar )
 169 :       // #110897#
 170     mxServiceFactory(xServiceFactory),
 171     m_pMenuBar( pMenuBar ),
 172     m_nElementDepth( 0 ),
 173     m_bMenuBarMode( sal_False ),
 174     m_nItemId( ITEMID_START_VALUE )
 175 {
 176 }
 177
 178 // #110897#
 179 const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& OReadMenuDocumentHandler::getServiceFactory()
 180 {
 181     // #110897#
 182     return mxServiceFactory;
 183 }
 184
 185 OReadMenuDocumentHandler::~OReadMenuDocumentHandler()
 186 {
 187 }
 188
 189
 190 void SAL_CALL OReadMenuDocumentHandler::startDocument(void)
 191     throw ( SAXException, RuntimeException )
 192 {
 193 }
 194
 195
 196 void SAL_CALL OReadMenuDocumentHandler::endDocument(void)
 197     throw( SAXException, RuntimeException )
 198 {
 199     if ( m_nElementDepth > 0 )
 200     {
 201         OUString aErrorMessage = getErrorLineString();
 202         aErrorMessage += OUString( RTL_CONSTASCII_USTRINGPARAM( "A closing element is missing!" ));
 203         throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 204     }
 205 }
 206
 207
 208 void SAL_CALL OReadMenuDocumentHandler::startElement(
 209     const OUString& aName, const Reference< XAttributeList > &xAttrList )
 210 throw( SAXException, RuntimeException )
 211 {
 212     if ( m_bMenuBarMode )
 213     {
 214         ++m_nElementDepth;
 215         m_xReader->startElement( aName, xAttrList );
 216     }
 217     else if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ELEMENT_MENUBAR )))
 218     {
 219         ++m_nElementDepth;
 220         m_bMenuBarMode = sal_True;
 221
 222         // #110897# m_xReader = Reference< XDocumentHandler >( new OReadMenuBarHandler( m_pMenuBar, &m_nItemId ));
 223         m_xReader = Reference< XDocumentHandler >( new OReadMenuBarHandler( getServiceFactory(), m_pMenuBar, &m_nItemId ));
 224
 225         m_xReader->startDocument();
 226     }
 227 }
 228
 229
 230 void SAL_CALL OReadMenuDocumentHandler::characters(const rtl::OUString& aChars)
 231 throw(  SAXException, RuntimeException )
 232 {
 233 }
 234
 235
 236 void SAL_CALL OReadMenuDocumentHandler::endElement( const OUString& aName )
 237     throw( SAXException, RuntimeException )
 238 {
 239     if ( m_bMenuBarMode )
 240     {
 241         --m_nElementDepth;
 242         m_xReader->endElement( aName );
 243         if ( 0 == m_nElementDepth )
 244         {
 245             m_xReader->endDocument();
 246             m_xReader = Reference< XDocumentHandler >();
 247             m_bMenuBarMode = sal_False;
 248             if ( !aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ELEMENT_MENUBAR )))
 249             {
 250                 OUString aErrorMessage = getErrorLineString();
 251                 aErrorMessage += OUString( RTL_CONSTASCII_USTRINGPARAM( "closing element menubar expected!" ));
 252                 throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 253             }
 254         }
 255     }
 256 }
 257
 258
 259 // -----------------------------------------------------------------------------
 260
 261
 262 // #110897#
 263 OReadMenuBarHandler::OReadMenuBarHandler(
 264     const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& xServiceFactory,
 265     MenuBar* pMenuBar, USHORT* pItemId )
 266 :       // #110897#
 267     mxServiceFactory( xServiceFactory ),
 268     m_pMenuBar( pMenuBar ),
 269     m_nElementDepth( 0 ),
 270     m_bMenuMode( sal_False ),
 271     m_pItemId( pItemId )
 272 {
 273 }
 274
 275 // #110897#
 276 const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& OReadMenuBarHandler::getServiceFactory()
 277 {
 278     // #110897#
 279     return mxServiceFactory;
 280 }
 281
 282 OReadMenuBarHandler::~OReadMenuBarHandler()
 283 {
 284 }
 285
 286
 287 void SAL_CALL OReadMenuBarHandler::startDocument(void)
 288     throw ( SAXException, RuntimeException )
 289 {
 290 }
 291
 292
 293 void SAL_CALL OReadMenuBarHandler::endDocument(void)
 294     throw( SAXException, RuntimeException )
 295 {
 296 }
 297
 298
 299 void SAL_CALL OReadMenuBarHandler::startElement(
 300     const OUString& aName, const Reference< XAttributeList > &xAttrList )
 301 throw( SAXException, RuntimeException )
 302 {
 303     if ( m_bMenuMode )
 304     {
 305         ++m_nElementDepth;
 306         m_xReader->startElement( aName, xAttrList );
 307     }
 308     else if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ELEMENT_MENU )))
 309     {
 310         ++m_nElementDepth;
 311
 312         ULONG    nHelpId = 0;
 313         OUString aCommandId;
 314         OUString aLabel;
 315
 316         m_bMenuMode = sal_True;
 317         PopupMenu* pMenu = new PopupMenu();
 318
 319         // read attributes for menu
 320         for ( int i=0; i< xAttrList->getLength(); i++ )
 321         {
 322             OUString aName = xAttrList->getNameByIndex( i );
 323             OUString aValue = xAttrList->getValueByIndex( i );
 324             if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ATTRIBUTE_ID )))
 325                 aCommandId = aValue;
 326             else if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ATTRIBUTE_LABEL )))
 327                 aLabel = aValue;
 328             else if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ATTRIBUTE_HELPID )))
 329                 nHelpId = aValue.toInt32();
 330         }
 331
 332         if ( aCommandId.getLength() > 0 )
 333         {
 334             USHORT nItemId;
 335             if ( aCommandId.compareTo( aSlotProtocol, aSlotProtocol.getLength() ) == 0 )
 336                 nItemId = (USHORT) aCommandId.copy( aSlotProtocol.getLength() ).toInt32();
 337             else
 338                 nItemId = ++(*m_pItemId);
 339
 340             m_pMenuBar->InsertItem( nItemId, String() );
 341             m_pMenuBar->SetPopupMenu( nItemId, pMenu );
 342             m_pMenuBar->SetItemCommand( nItemId, aCommandId );
 343             if ( nHelpId > 0 )
 344                 m_pMenuBar->SetHelpId( nItemId, nHelpId );
 345             if ( aLabel.getLength() > 0 )
 346             {
 347                 m_pMenuBar->SetItemText( nItemId, aLabel );
 348                 m_pMenuBar->SetUserValue( nItemId, MENU_SAVE_LABEL );
 349             }
 350             else
 351             {
 352                 m_pMenuBar->SetUserValue( nItemId, 0 );
 353             }
 354         }
 355         else
 356         {
 357             delete pMenu;
 358             OUString aErrorMessage = getErrorLineString();
 359             aErrorMessage += OUString( RTL_CONSTASCII_USTRINGPARAM( "attribute id for element menu required!" ));
 360             throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 361         }
 362
 363         m_xReader = Reference< XDocumentHandler >( new OReadMenuHandler( pMenu, m_pItemId ));
 364         m_xReader->startDocument();
 365     }
 366     else
 367     {
 368         OUString aErrorMessage = getErrorLineString();
 369         aErrorMessage += OUString( RTL_CONSTASCII_USTRINGPARAM( "element menu expected!" ));
 370         throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 371     }
 372 }
 373
 374
 375 void SAL_CALL OReadMenuBarHandler::characters(const rtl::OUString& aChars)
 376 throw(  SAXException, RuntimeException )
 377 {
 378 }
 379
 380
 381 void OReadMenuBarHandler::endElement( const OUString& aName )
 382     throw( SAXException, RuntimeException )
 383 {
 384     if ( m_bMenuMode )
 385     {
 386         --m_nElementDepth;
 387         if ( 0 == m_nElementDepth )
 388         {
 389             m_xReader->endDocument();
 390             m_xReader = Reference< XDocumentHandler >();
 391             m_bMenuMode = sal_False;
 392             if ( !aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ELEMENT_MENU )))
 393             {
 394                 OUString aErrorMessage = getErrorLineString();
 395                 aErrorMessage += OUString( RTL_CONSTASCII_USTRINGPARAM( "closing element menu expected!" ));
 396                 throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 397             }
 398         }
 399         else
 400             m_xReader->endElement( aName );
 401     }
 402 }
 403
 404
 405 // -----------------------------------------------------------------------------
 406
 407
 408 OReadMenuHandler::OReadMenuHandler( Menu* pMenu, USHORT* pItemId ) :
 409     m_pMenu( pMenu ),
 410     m_nElementDepth( 0 ),
 411     m_bMenuPopupMode( sal_False ),
 412     m_pItemId( pItemId )
 413 {
 414 }
 415
 416
 417 OReadMenuHandler::~OReadMenuHandler()
 418 {
 419 }
 420
 421
 422 void SAL_CALL OReadMenuHandler::startDocument(void)
 423     throw ( SAXException, RuntimeException )
 424 {
 425 }
 426
 427
 428 void SAL_CALL OReadMenuHandler::endDocument(void)
 429     throw( SAXException, RuntimeException)
 430 {
 431 }
 432
 433
 434 void SAL_CALL OReadMenuHandler::startElement(
 435     const OUString& aName, const Reference< XAttributeList > &xAttrList )
 436 throw( SAXException, RuntimeException )
 437 {
 438     if ( m_bMenuPopupMode )
 439     {
 440         ++m_nElementDepth;
 441         m_xReader->startElement( aName, xAttrList );
 442     }
 443     else if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ELEMENT_MENUPOPUP )))
 444     {
 445         ++m_nElementDepth;
 446         m_bMenuPopupMode = sal_True;
 447         m_xReader = Reference< XDocumentHandler >( new OReadMenuPopupHandler( m_pMenu, m_pItemId ));
 448         m_xReader->startDocument();
 449     }
 450     else
 451     {
 452         OUString aErrorMessage = getErrorLineString();
 453         aErrorMessage += OUString( RTL_CONSTASCII_USTRINGPARAM( "unknown element found!" ));
 454         throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 455     }
 456 }
 457
 458
 459 void SAL_CALL OReadMenuHandler::characters(const rtl::OUString& aChars)
 460 throw(  SAXException, RuntimeException )
 461 {
 462 }
 463
 464
 465 void SAL_CALL OReadMenuHandler::endElement( const OUString& aName )
 466     throw( SAXException, RuntimeException )
 467 {
 468     if ( m_bMenuPopupMode )
 469     {
 470         --m_nElementDepth;
 471         if ( 0 == m_nElementDepth )
 472         {
 473             m_xReader->endDocument();
 474             m_xReader = Reference< XDocumentHandler >();
 475             m_bMenuPopupMode = sal_False;
 476             if ( !aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ELEMENT_MENUPOPUP )))
 477             {
 478                 OUString aErrorMessage = getErrorLineString();
 479                 aErrorMessage += OUString( RTL_CONSTASCII_USTRINGPARAM( "closing element menupopup expected!" ));
 480                 throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 481             }
 482         }
 483         else
 484             m_xReader->endElement( aName );
 485     }
 486 }
 487
 488
 489 // -----------------------------------------------------------------------------
 490
 491
 492 OReadMenuPopupHandler::OReadMenuPopupHandler( Menu* pMenu, USHORT* pItemId ) :
 493     m_pMenu( pMenu ),
 494     m_nElementDepth( 0 ),
 495     m_bMenuMode( sal_False ),
 496     m_pItemId( pItemId ),
 497     m_nNextElementExpected( ELEM_CLOSE_NONE )
 498 {
 499 }
 500
 501
 502 OReadMenuPopupHandler::~OReadMenuPopupHandler()
 503 {
 504 }
 505
 506
 507 void SAL_CALL OReadMenuPopupHandler::startDocument(void)
 508     throw ( SAXException, RuntimeException )
 509 {
 510 }
 511
 512
 513 void SAL_CALL OReadMenuPopupHandler::endDocument(void)
 514     throw( SAXException, RuntimeException)
 515 {
 516 }
 517
 518
 519 void SAL_CALL OReadMenuPopupHandler::startElement(
 520     const OUString& aName, const Reference< XAttributeList > &xAttrList )
 521 throw( SAXException, RuntimeException )
 522 {
 523     ++m_nElementDepth;
 524
 525     if ( m_bMenuMode )
 526         m_xReader->startElement( aName, xAttrList );
 527     else if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ELEMENT_MENU )))
 528     {
 529         ULONG    nHelpId = 0;
 530         OUString aCommandId;
 531         OUString aLabel;
 532
 533         m_bMenuMode = sal_True;
 534         PopupMenu* pMenu = new PopupMenu();
 535
 536         // read attributes for menu
 537         for ( int i=0; i< xAttrList->getLength(); i++ )
 538         {
 539             OUString aName = xAttrList->getNameByIndex( i );
 540             OUString aValue = xAttrList->getValueByIndex( i );
 541             if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ATTRIBUTE_ID )))
 542                 aCommandId = aValue;
 543             else if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ATTRIBUTE_LABEL )))
 544                 aLabel = aValue;
 545             else if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ATTRIBUTE_HELPID )))
 546                 nHelpId = aValue.toInt32();
 547         }
 548
 549         if ( aCommandId.getLength() > 0 )
 550         {
 551             USHORT nItemId;
 552             if ( aCommandId.compareTo( aSlotProtocol, aSlotProtocol.getLength() ) == 0 )
 553                 nItemId = (USHORT) aCommandId.copy( aSlotProtocol.getLength() ).toInt32();
 554             else
 555                 nItemId = ++(*m_pItemId);
 556
 557             m_pMenu->InsertItem( nItemId, String() );
 558             m_pMenu->SetPopupMenu( nItemId, pMenu );
 559             m_pMenu->SetItemCommand( nItemId, aCommandId );
 560             if ( nHelpId > 0 )
 561                 m_pMenu->SetHelpId( nItemId, nHelpId );
 562             if ( aLabel.getLength() > 0 )
 563             {
 564                 m_pMenu->SetItemText( nItemId, aLabel );
 565                 m_pMenu->SetUserValue( nItemId, MENU_SAVE_LABEL );
 566             }
 567             else
 568             {
 569                 m_pMenu->SetUserValue( nItemId, 0 );
 570              }
 571         }
 572         else
 573         {
 574             delete pMenu;
 575             OUString aErrorMessage = getErrorLineString();
 576             aErrorMessage += OUString( RTL_CONSTASCII_USTRINGPARAM( "attribute id for element menu required!" ));
 577             throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 578         }
 579
 580         m_xReader = Reference< XDocumentHandler >( new OReadMenuHandler( pMenu, m_pItemId ));
 581         m_xReader->startDocument();
 582     }
 583     else if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ELEMENT_MENUITEM )))
 584     {
 585         ULONG    nHelpId = 0;
 586         OUString aCommandId;
 587         OUString aLabel;
 588
 589         // read attributes for menu item
 590         for ( int i=0; i< xAttrList->getLength(); i++ )
 591         {
 592             OUString aName = xAttrList->getNameByIndex( i );
 593             OUString aValue = xAttrList->getValueByIndex( i );
 594             if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ATTRIBUTE_ID )))
 595                 aCommandId = aValue;
 596             else if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ATTRIBUTE_LABEL )))
 597                 aLabel = aValue;
 598             else if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ATTRIBUTE_HELPID )))
 599                 nHelpId = aValue.toInt32();
 600         }
 601
 602         if ( aCommandId.getLength() > 0 )
 603         {
 604             USHORT nItemId;
 605             if ( aCommandId.compareTo( aSlotProtocol, aSlotProtocol.getLength() ) == 0 )
 606                 nItemId = (USHORT) aCommandId.copy( aSlotProtocol.getLength() ).toInt32();
 607             else
 608                 nItemId = ++(*m_pItemId);
 609
 610             m_pMenu->InsertItem( nItemId, String() );
 611             m_pMenu->SetItemCommand( nItemId, aCommandId );
 612             if ( nHelpId > 0 )
 613                 m_pMenu->SetHelpId( nItemId, nHelpId );
 614             if ( aLabel.getLength() > 0 )
 615             {
 616                 m_pMenu->SetItemText( nItemId, aLabel );
 617                 m_pMenu->SetUserValue( nItemId, MENU_SAVE_LABEL );
 618             }
 619             else
 620             {
 621                 m_pMenu->SetUserValue( nItemId, 0 );
 622             }
 623         }
 624
 625         m_nNextElementExpected = ELEM_CLOSE_MENUITEM;
 626     }
 627     else if ( aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ELEMENT_MENUSEPARATOR )))
 628     {
 629         m_pMenu->InsertSeparator();
 630         m_nNextElementExpected = ELEM_CLOSE_MENUSEPARATOR;
 631     }
 632     else
 633     {
 634         OUString aErrorMessage = getErrorLineString();
 635         aErrorMessage += OUString( RTL_CONSTASCII_USTRINGPARAM( "unknown element found!" ));
 636         throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 637     }
 638 }
 639
 640
 641 void SAL_CALL OReadMenuPopupHandler::characters(const rtl::OUString& aChars)
 642 throw(  SAXException, RuntimeException )
 643 {
 644 }
 645
 646
 647 void SAL_CALL OReadMenuPopupHandler::endElement( const OUString& aName )
 648     throw( SAXException, RuntimeException )
 649 {
 650     --m_nElementDepth;
 651     if ( m_bMenuMode )
 652     {
 653         if ( 0 == m_nElementDepth )
 654         {
 655             m_xReader->endDocument();
 656             m_xReader = Reference< XDocumentHandler >();
 657             m_bMenuMode = sal_False;
 658             if ( !aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ELEMENT_MENU )))
 659             {
 660                 OUString aErrorMessage = getErrorLineString();
 661                 aErrorMessage += OUString( RTL_CONSTASCII_USTRINGPARAM( "closing element menu expected!" ));
 662                 throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 663             }
 664         }
 665         else
 666             m_xReader->endElement( aName );
 667     }
 668     else
 669     {
 670         if ( m_nNextElementExpected == ELEM_CLOSE_MENUITEM )
 671         {
 672             if ( !aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ELEMENT_MENUITEM )))
 673             {
 674                 OUString aErrorMessage = getErrorLineString();
 675                 aErrorMessage += OUString( RTL_CONSTASCII_USTRINGPARAM( "closing element menuitem expected!" ));
 676                 throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 677             }
 678         }
 679         else if ( m_nNextElementExpected == ELEM_CLOSE_MENUSEPARATOR )
 680         {
 681             if ( !aName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM( ELEMENT_MENUSEPARATOR )))
 682             {
 683                 OUString aErrorMessage = getErrorLineString();
 684                 aErrorMessage += OUString( RTL_CONSTASCII_USTRINGPARAM( "closing element menuseparator expected!" ));
 685                 throw SAXException( aErrorMessage, Reference< XInterface >(), Any() );
 686             }
 687         }
 688
 689         m_nNextElementExpected = ELEM_CLOSE_NONE;
 690     }
 691 }
 692
 693
 694 // --------------------------------- Write XML ---------------------------------
 695
 696
 697 OWriteMenuDocumentHandler::OWriteMenuDocumentHandler( MenuBar* pMenu, Reference< XDocumentHandler > rxWriteDocumentHandler ) :
 698     m_pMenuBar( pMenu ),
 699     m_xWriteDocumentHandler( rxWriteDocumentHandler )
 700 {
 701     m_xEmptyList = Reference< XAttributeList >( (XAttributeList *)new AttributeListImpl, UNO_QUERY );
 702     m_aAttributeType =  OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_TYPE_CDATA ));
 703 }
 704
 705
 706 OWriteMenuDocumentHandler::~OWriteMenuDocumentHandler()
 707 {
 708 }
 709
 710
 711 void OWriteMenuDocumentHandler::WriteMenuDocument()
 712 throw ( SAXException, RuntimeException )
 713 {
 714     AttributeListImpl* pList = new AttributeListImpl;
 715     Reference< XAttributeList > rList( (XAttributeList *) pList , UNO_QUERY );
 716
 717     m_xWriteDocumentHandler->startDocument();
 718
 719     // write DOCTYPE line!
 720     Reference< XExtendedDocumentHandler > xExtendedDocHandler( m_xWriteDocumentHandler, UNO_QUERY );
 721     if ( xExtendedDocHandler.is() )
 722     {
 723         xExtendedDocHandler->unknown( OUString( RTL_CONSTASCII_USTRINGPARAM( MENUBAR_DOCTYPE )) );
 724         m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 725     }
 726
 727     pList->addAttribute( OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_XMLNS_MENU )),
 728                          m_aAttributeType,
 729                          OUString( RTL_CONSTASCII_USTRINGPARAM( XMLNS_MENU )) );
 730
 731     pList->addAttribute( OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_NS_ID )),
 732                          m_aAttributeType,
 733                          OUString( RTL_CONSTASCII_USTRINGPARAM( "menubar" )) );
 734
 735     m_xWriteDocumentHandler->startElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENUBAR )), pList );
 736     m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 737
 738     WriteMenu( m_pMenuBar );
 739
 740     m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 741     m_xWriteDocumentHandler->endElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENUBAR )) );
 742     m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 743     m_xWriteDocumentHandler->endDocument();
 744 }
 745
 746
 747 void OWriteMenuDocumentHandler::WriteMenu( Menu* pMenu )
 748 throw ( SAXException, RuntimeException )
 749 {
 750     USHORT  nItemCount = pMenu->GetItemCount();
 751     BOOL    bSeparator = FALSE;
 752
 753     for ( USHORT nItemPos = 0; nItemPos < nItemCount; nItemPos++ )
 754     {
 755         USHORT nItemId = pMenu->GetItemId( nItemPos );
 756
 757         PopupMenu* pPopupMenu = pMenu->GetPopupMenu( nItemId );
 758         if ( pPopupMenu )
 759         {
 760             OUString aItemCommand = pMenu->GetItemCommand( nItemId );
 761
 762             if ( nItemId == SID_NEWDOCDIRECT ||
 763                  nItemId == SID_AUTOPILOTMENU )
 764             {
 765                 // special popup menus (filled during runtime) must be saved as a menuitem!!!
 766                 WriteMenuItem( pMenu, nItemId );
 767                 bSeparator = FALSE;
 768             }
 769             else if ( nItemId == SID_FORMATMENU )
 770             {
 771                 // special popup menu - must be written as empty popup!
 772                 AttributeListImpl* pListMenu = new AttributeListImpl;
 773                 Reference< XAttributeList > xListMenu( (XAttributeList *)pListMenu , UNO_QUERY );
 774
 775                 String aCommand( pMenu->GetItemCommand( nItemId ) );
 776                 if ( !aCommand.Len() )
 777                 {
 778                     aCommand = String::CreateFromAscii("slot:");
 779                     aCommand += String::CreateFromInt32( nItemId );
 780                 }
 781
 782                 pListMenu->addAttribute( OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_NS_ID )),
 783                                          m_aAttributeType,
 784                                          aCommand );
 785
 786 //                if ( pMenu->GetUserValue( nItemId ) & MENU_SAVE_LABEL )
 787                 pListMenu->addAttribute( OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_NS_LABEL )),
 788                                             m_aAttributeType,
 789                                             pMenu->GetItemText( nItemId ) );
 790
 791                 m_xWriteDocumentHandler->startElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENU )), xListMenu );
 792                 m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 793                 m_xWriteDocumentHandler->startElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENUPOPUP )), m_xEmptyList );
 794                 m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 795                 m_xWriteDocumentHandler->endElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENUPOPUP )) );
 796                 m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 797                 m_xWriteDocumentHandler->endElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENU )) );
 798                 m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 799                 bSeparator = FALSE;
 800             }
 801             else if ( !AddonPopupMenu::IsCommandURLPrefix ( aItemCommand ))
 802             {
 803                 AttributeListImpl* pListMenu = new AttributeListImpl;
 804                 Reference< XAttributeList > xListMenu( (XAttributeList *)pListMenu , UNO_QUERY );
 805
 806                 String aCommand( pMenu->GetItemCommand( nItemId ) );
 807                 if ( !aCommand.Len() )
 808                 {
 809                     aCommand = String::CreateFromAscii("slot:");
 810                     aCommand += String::CreateFromInt32( nItemId );
 811                 }
 812
 813                 pListMenu->addAttribute( OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_NS_ID )),
 814                                          m_aAttributeType,
 815                                          aCommand );
 816
 817 //                if ( pMenu->GetUserValue( nItemId ) & MENU_SAVE_LABEL )
 818                     pListMenu->addAttribute( OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_NS_LABEL )),
 819                                              m_aAttributeType,
 820                                              pMenu->GetItemText( nItemId ) );
 821
 822                 m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 823                 m_xWriteDocumentHandler->startElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENU )), xListMenu );
 824                 m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 825                 m_xWriteDocumentHandler->startElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENUPOPUP )), m_xEmptyList );
 826                 m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 827
 828                 WriteMenu( pPopupMenu );
 829
 830                 m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 831                 m_xWriteDocumentHandler->endElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENUPOPUP )) );
 832                 m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 833                 m_xWriteDocumentHandler->endElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENU )) );
 834                 m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 835                 bSeparator = FALSE;
 836             }
 837         }
 838         else
 839         {
 840             if ( pMenu->GetItemType( nItemPos ) != MENUITEM_SEPARATOR )
 841             {
 842                 // don't save special menu items for (window list and pickup list, add-ons )
 843                 if ( !MenuConfiguration::IsPickListItemId( nItemId ) &&
 844                      !MenuConfiguration::IsWindowListItemId( nItemId ) &&
 845                      !AddonMenuManager::IsAddonMenuId( nItemId ))
 846                 {
 847                     bSeparator = FALSE;
 848                     WriteMenuItem( pMenu, nItemId );
 849                 }
 850             }
 851             else if ( !bSeparator )
 852             {
 853                 // Don't write two separators together
 854                 WriteMenuSeparator();
 855                 bSeparator = TRUE;
 856             }
 857         }
 858     }
 859 }
 860
 861
 862 void OWriteMenuDocumentHandler::WriteMenuItem( Menu* pMenu, USHORT nItemId )
 863 {
 864     AttributeListImpl* pList = new AttributeListImpl;
 865     Reference< XAttributeList > xList( (XAttributeList *) pList , UNO_QUERY );
 866
 867     String aCommand( pMenu->GetItemCommand( nItemId ) );
 868     if ( !aCommand.Len() )
 869     {
 870         aCommand = String::CreateFromAscii("slot:");
 871         aCommand += String::CreateFromInt32( nItemId );
 872     }
 873
 874     pList->addAttribute( OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_NS_ID )),
 875                                 m_aAttributeType,
 876                                 aCommand );
 877
 878     ULONG nHelpId = pMenu->GetHelpId( nItemId );
 879     if ( nHelpId > 0 )
 880     {
 881         pList->addAttribute( OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_NS_HELPID )),
 882                              m_aAttributeType,
 883                              OUString::valueOf( sal_Int64( nHelpId )) );
 884     }
 885
 886 //    if ( pMenu->GetUserValue( nItemId ) & MENU_SAVE_LABEL )
 887          pList->addAttribute( OUString( RTL_CONSTASCII_USTRINGPARAM( ATTRIBUTE_NS_LABEL )),
 888                              m_aAttributeType,
 889                              pMenu->GetItemText( nItemId ));
 890
 891     m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 892     m_xWriteDocumentHandler->startElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENUITEM )), xList );
 893     m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 894     m_xWriteDocumentHandler->endElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENUITEM )) );
 895 }
 896
 897
 898 void OWriteMenuDocumentHandler::WriteMenuSeparator()
 899 {
 900     m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 901     m_xWriteDocumentHandler->startElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENUSEPARATOR )), m_xEmptyList );
 902     m_xWriteDocumentHandler->ignorableWhitespace( OUString() );
 903     m_xWriteDocumentHandler->endElement( OUString( RTL_CONSTASCII_USTRINGPARAM( ELEMENT_NS_MENUSEPARATOR )) );
 904 }
 905
 906 } // namespace framework