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