Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 : #include <sal/config.h>
21 :
22 : #include <boost/noncopyable.hpp>
23 : #include <svtools/contextmenuhelper.hxx>
24 : #include <svtools/menuoptions.hxx>
25 : #include <svtools/miscopt.hxx>
26 :
27 : #include <com/sun/star/frame/XDispatch.hpp>
28 : #include <com/sun/star/frame/XDispatchProvider.hpp>
29 : #include <com/sun/star/frame/ModuleManager.hpp>
30 : #include <com/sun/star/frame/XStatusListener.hpp>
31 : #include <com/sun/star/lang/XMultiServiceFactory.hpp>
32 : #include <com/sun/star/ui/XUIConfigurationManagerSupplier.hpp>
33 : #include <com/sun/star/ui/XUIConfigurationManager.hpp>
34 : #include <com/sun/star/ui/theModuleUIConfigurationManagerSupplier.hpp>
35 : #include <com/sun/star/ui/ImageType.hpp>
36 : #include <com/sun/star/frame/theUICommandDescription.hpp>
37 : #include <com/sun/star/util/URLTransformer.hpp>
38 : #include <com/sun/star/beans/PropertyValue.hpp>
39 :
40 : #include <osl/conditn.hxx>
41 : #include <cppuhelper/weak.hxx>
42 : #include <cppuhelper/queryinterface.hxx>
43 : #include <comphelper/processfactory.hxx>
44 : #include <osl/mutex.hxx>
45 : #include <vcl/svapp.hxx>
46 : #include <vcl/settings.hxx>
47 : #include <vcl/image.hxx>
48 : #include <toolkit/helper/vclunohelper.hxx>
49 : #include <toolkit/awt/vclxwindow.hxx>
50 : #include <toolkit/awt/vclxmenu.hxx>
51 :
52 : using namespace ::com::sun::star;
53 :
54 : namespace svt
55 : {
56 :
57 : // internal helper class to retrieve status updates
58 : class StateEventHelper : public ::com::sun::star::frame::XStatusListener,
59 : public ::cppu::OWeakObject,
60 : private boost::noncopyable
61 : {
62 : public:
63 : StateEventHelper( const uno::Reference< frame::XDispatchProvider >& xDispatchProvider,
64 : const uno::Reference< util::XURLTransformer >& xURLTransformer,
65 : const OUString& aCommandURL );
66 : virtual ~StateEventHelper();
67 :
68 : bool isCommandEnabled();
69 :
70 : // XInterface
71 : virtual uno::Any SAL_CALL queryInterface( const uno::Type& aType ) throw ( uno::RuntimeException, std::exception) SAL_OVERRIDE;
72 : virtual void SAL_CALL acquire() throw () SAL_OVERRIDE;
73 : virtual void SAL_CALL release() throw () SAL_OVERRIDE;
74 :
75 : // XEventListener
76 : virtual void SAL_CALL disposing(const lang::EventObject& Source) throw( uno::RuntimeException, std::exception ) SAL_OVERRIDE;
77 :
78 : // XStatusListener
79 : virtual void SAL_CALL statusChanged(const frame::FeatureStateEvent& Event) throw( uno::RuntimeException, std::exception ) SAL_OVERRIDE;
80 :
81 : private:
82 : bool m_bCurrentCommandEnabled;
83 : OUString m_aCommandURL;
84 : uno::Reference< frame::XDispatchProvider > m_xDispatchProvider;
85 : uno::Reference< util::XURLTransformer > m_xURLTransformer;
86 : osl::Condition m_aCondition;
87 : };
88 :
89 0 : StateEventHelper::StateEventHelper(
90 : const uno::Reference< frame::XDispatchProvider >& xDispatchProvider,
91 : const uno::Reference< util::XURLTransformer >& xURLTransformer,
92 : const OUString& rCommandURL ) :
93 : m_bCurrentCommandEnabled( true ),
94 : m_aCommandURL( rCommandURL ),
95 : m_xDispatchProvider( xDispatchProvider ),
96 0 : m_xURLTransformer( xURLTransformer )
97 : {
98 0 : m_aCondition.reset();
99 0 : }
100 :
101 0 : StateEventHelper::~StateEventHelper()
102 0 : {}
103 :
104 0 : uno::Any SAL_CALL StateEventHelper::queryInterface(
105 : const uno::Type& aType )
106 : throw ( uno::RuntimeException, std::exception )
107 : {
108 : uno::Any a = ::cppu::queryInterface(
109 : aType,
110 0 : (static_cast< XStatusListener* >(this)));
111 :
112 0 : if( a.hasValue() )
113 0 : return a;
114 :
115 0 : return ::cppu::OWeakObject::queryInterface( aType );
116 : }
117 :
118 0 : void SAL_CALL StateEventHelper::acquire()
119 : throw ()
120 : {
121 0 : ::cppu::OWeakObject::acquire();
122 0 : }
123 :
124 0 : void SAL_CALL StateEventHelper::release()
125 : throw ()
126 : {
127 0 : ::cppu::OWeakObject::release();
128 0 : }
129 :
130 0 : void SAL_CALL StateEventHelper::disposing(
131 : const lang::EventObject& )
132 : throw ( uno::RuntimeException, std::exception )
133 : {
134 0 : SolarMutexGuard aSolarGuard;
135 0 : m_xDispatchProvider.clear();
136 0 : m_xURLTransformer.clear();
137 0 : m_aCondition.set();
138 0 : }
139 :
140 0 : void SAL_CALL StateEventHelper::statusChanged(
141 : const frame::FeatureStateEvent& Event )
142 : throw ( uno::RuntimeException, std::exception )
143 : {
144 0 : SolarMutexGuard aSolarGuard;
145 0 : m_bCurrentCommandEnabled = Event.IsEnabled;
146 0 : m_aCondition.set();
147 0 : }
148 :
149 0 : bool StateEventHelper::isCommandEnabled()
150 : {
151 : // Be sure that we cannot die during condition wait
152 : uno::Reference< frame::XStatusListener > xSelf(
153 0 : (static_cast< frame::XStatusListener* >(this)));
154 :
155 0 : uno::Reference< frame::XDispatch > xDispatch;
156 0 : util::URL aTargetURL;
157 : {
158 0 : SolarMutexGuard aSolarGuard;
159 0 : if ( m_xDispatchProvider.is() && m_xURLTransformer.is() )
160 : {
161 0 : OUString aSelf( "_self" );
162 :
163 0 : aTargetURL.Complete = m_aCommandURL;
164 0 : m_xURLTransformer->parseStrict( aTargetURL );
165 :
166 : try
167 : {
168 0 : xDispatch = m_xDispatchProvider->queryDispatch( aTargetURL, aSelf, 0 );
169 : }
170 0 : catch ( uno::RuntimeException& )
171 : {
172 0 : throw;
173 : }
174 0 : catch ( uno::Exception& )
175 : {
176 0 : }
177 0 : }
178 : }
179 :
180 0 : bool bResult( false );
181 0 : if ( xDispatch.is() )
182 : {
183 : try
184 : {
185 : // add/remove ourself to retrieve status by callback
186 0 : xDispatch->addStatusListener( xSelf, aTargetURL );
187 0 : xDispatch->removeStatusListener( xSelf, aTargetURL );
188 :
189 : // wait for anwser
190 0 : m_aCondition.wait();
191 : }
192 0 : catch ( uno::RuntimeException& )
193 : {
194 0 : throw;
195 : }
196 0 : catch ( uno::Exception& )
197 : {
198 : }
199 :
200 0 : SolarMutexGuard aSolarGuard;
201 0 : bResult = m_bCurrentCommandEnabled;
202 : }
203 :
204 0 : return bResult;
205 : }
206 :
207 : /*************************************************************************/
208 :
209 0 : struct ExecuteInfo
210 : {
211 : uno::Reference< frame::XDispatch > xDispatch;
212 : util::URL aTargetURL;
213 : uno::Sequence< beans::PropertyValue > aArgs;
214 : };
215 :
216 0 : static const PopupMenu* lcl_FindPopupFromItemId( const PopupMenu* pPopupMenu, sal_uInt16 nItemId )
217 : {
218 0 : if ( pPopupMenu )
219 : {
220 0 : sal_uInt16 nCount = pPopupMenu->GetItemCount();
221 0 : for ( sal_uInt16 i = 0; i < nCount; i++ )
222 : {
223 0 : sal_uInt16 nId = pPopupMenu->GetItemId( i );
224 0 : if ( nId == nItemId )
225 0 : return pPopupMenu;
226 : else
227 : {
228 0 : const PopupMenu* pResult( 0 );
229 :
230 0 : const PopupMenu* pSubPopup = pPopupMenu->GetPopupMenu( i );
231 0 : if ( pPopupMenu )
232 0 : pResult = lcl_FindPopupFromItemId( pSubPopup, nItemId );
233 0 : if ( pResult != 0 )
234 0 : return pResult;
235 : }
236 : }
237 : }
238 :
239 0 : return NULL;
240 : }
241 :
242 0 : static OUString lcl_GetItemCommandRecursive( const PopupMenu* pPopupMenu, sal_uInt16 nItemId )
243 : {
244 0 : const PopupMenu* pPopup = lcl_FindPopupFromItemId( pPopupMenu, nItemId );
245 0 : if ( pPopup )
246 0 : return pPopup->GetItemCommand( nItemId );
247 : else
248 0 : return OUString();
249 : }
250 :
251 : /*************************************************************************/
252 :
253 0 : ContextMenuHelper::ContextMenuHelper(
254 : const uno::Reference< frame::XFrame >& xFrame,
255 : bool bAutoRefresh ) :
256 : m_xWeakFrame( xFrame ),
257 : m_aSelf( "_self" ),
258 : m_bAutoRefresh( bAutoRefresh ),
259 0 : m_bUICfgMgrAssociated( false )
260 : {
261 0 : }
262 :
263 0 : ContextMenuHelper::~ContextMenuHelper()
264 : {
265 0 : }
266 :
267 : void
268 0 : ContextMenuHelper::completeAndExecute(
269 : const Point& aPos,
270 : PopupMenu& rPopupMenu )
271 : {
272 0 : SolarMutexGuard aSolarGuard;
273 :
274 0 : associateUIConfigurationManagers();
275 0 : completeMenuProperties( &rPopupMenu );
276 0 : executePopupMenu( aPos, &rPopupMenu );
277 0 : resetAssociations();
278 0 : }
279 :
280 : void
281 0 : ContextMenuHelper::completeAndExecute(
282 : const Point& aPos,
283 : const uno::Reference< awt::XPopupMenu >& xPopupMenu )
284 : {
285 0 : SolarMutexGuard aSolarGuard;
286 :
287 0 : VCLXMenu* pXMenu = VCLXMenu::GetImplementation( xPopupMenu );
288 0 : if ( pXMenu )
289 : {
290 0 : PopupMenu* pPopupMenu = dynamic_cast< PopupMenu* >( pXMenu->GetMenu() );
291 : // as dynamic_cast can return zero check pointer
292 0 : if ( pPopupMenu )
293 : {
294 0 : associateUIConfigurationManagers();
295 0 : completeMenuProperties( pPopupMenu );
296 0 : executePopupMenu( aPos, pPopupMenu );
297 0 : resetAssociations();
298 : }
299 0 : }
300 0 : }
301 :
302 : // private member
303 :
304 : void
305 0 : ContextMenuHelper::executePopupMenu(
306 : const Point& rPos,
307 : PopupMenu* pMenu )
308 : {
309 0 : if ( pMenu )
310 : {
311 0 : uno::Reference< frame::XFrame > xFrame( m_xWeakFrame );
312 0 : if ( xFrame.is() )
313 : {
314 0 : uno::Reference< awt::XWindow > xWindow( xFrame->getContainerWindow() );
315 0 : if ( xWindow.is() )
316 : {
317 0 : vcl::Window* pParent = VCLUnoHelper::GetWindow( xWindow );
318 0 : sal_uInt16 nResult = pMenu->Execute( pParent, rPos );
319 :
320 0 : if ( nResult > 0 )
321 : {
322 0 : OUString aCommand = lcl_GetItemCommandRecursive( pMenu, nResult );
323 0 : if ( !aCommand.isEmpty() )
324 0 : dispatchCommand( xFrame, aCommand );
325 : }
326 0 : }
327 0 : }
328 : }
329 0 : }
330 :
331 : bool
332 0 : ContextMenuHelper::dispatchCommand(
333 : const uno::Reference< ::frame::XFrame >& rFrame,
334 : const OUString& aCommandURL )
335 : {
336 0 : if ( !m_xURLTransformer.is() )
337 : {
338 0 : m_xURLTransformer = util::URLTransformer::create( ::comphelper::getProcessComponentContext() );
339 : }
340 :
341 0 : util::URL aTargetURL;
342 0 : aTargetURL.Complete = aCommandURL;
343 0 : m_xURLTransformer->parseStrict( aTargetURL );
344 :
345 0 : uno::Reference< frame::XDispatch > xDispatch;
346 : uno::Reference< frame::XDispatchProvider > xDispatchProvider(
347 0 : rFrame, uno::UNO_QUERY );
348 0 : if ( xDispatchProvider.is() )
349 : {
350 : try
351 : {
352 0 : xDispatch = xDispatchProvider->queryDispatch( aTargetURL, m_aSelf, 0 );
353 : }
354 0 : catch ( uno::RuntimeException& )
355 : {
356 0 : throw;
357 : }
358 0 : catch ( uno::Exception& )
359 : {
360 : }
361 : }
362 :
363 0 : if ( xDispatch.is() )
364 : {
365 0 : ExecuteInfo* pExecuteInfo = new ExecuteInfo;
366 0 : pExecuteInfo->xDispatch = xDispatch;
367 0 : pExecuteInfo->aTargetURL = aTargetURL;
368 0 : pExecuteInfo->aArgs = m_aDefaultArgs;
369 :
370 0 : Application::PostUserEvent( LINK(0, ContextMenuHelper , ExecuteHdl_Impl), pExecuteInfo );
371 0 : return true;
372 : }
373 :
374 0 : return false;
375 : }
376 :
377 : // retrieves and stores references to our user-interface
378 : // configuration managers, like image manager, ui command
379 : // description manager.
380 : bool
381 0 : ContextMenuHelper::associateUIConfigurationManagers()
382 : {
383 0 : uno::Reference< frame::XFrame > xFrame( m_xWeakFrame );
384 0 : if ( !m_bUICfgMgrAssociated && xFrame.is() )
385 : {
386 : // clear current state
387 0 : m_xDocImageMgr.clear();
388 0 : m_xModuleImageMgr.clear();
389 0 : m_xUICommandLabels.clear();
390 :
391 : try
392 : {
393 0 : uno::Reference < frame::XController > xController;
394 0 : uno::Reference < frame::XModel > xModel;
395 0 : xController = xFrame->getController();
396 0 : if ( xController.is() )
397 0 : xModel = xController->getModel();
398 :
399 0 : if ( xModel.is() )
400 : {
401 : // retrieve document image manager form model
402 0 : uno::Reference< ui::XUIConfigurationManagerSupplier > xSupplier( xModel, uno::UNO_QUERY );
403 0 : if ( xSupplier.is() )
404 : {
405 : uno::Reference< ui::XUIConfigurationManager > xDocUICfgMgr(
406 0 : xSupplier->getUIConfigurationManager(), uno::UNO_QUERY );
407 0 : m_xDocImageMgr = uno::Reference< ui::XImageManager >(
408 0 : xDocUICfgMgr->getImageManager(), uno::UNO_QUERY );
409 0 : }
410 : }
411 :
412 : uno::Reference< frame::XModuleManager2 > xModuleManager(
413 0 : frame::ModuleManager::create( ::comphelper::getProcessComponentContext() ) );
414 :
415 0 : uno::Reference< ui::XImageManager > xModuleImageManager;
416 0 : OUString aModuleId;
417 : // retrieve module image manager
418 0 : aModuleId = xModuleManager->identify( xFrame );
419 :
420 : uno::Reference< ui::XModuleUIConfigurationManagerSupplier > xModuleCfgMgrSupplier(
421 : ui::theModuleUIConfigurationManagerSupplier::get(
422 0 : ::comphelper::getProcessComponentContext() ) );
423 : uno::Reference< ui::XUIConfigurationManager > xUICfgMgr(
424 0 : xModuleCfgMgrSupplier->getUIConfigurationManager( aModuleId ));
425 0 : if ( xUICfgMgr.is() )
426 : {
427 0 : m_xModuleImageMgr = uno::Reference< ui::XImageManager >(
428 0 : xUICfgMgr->getImageManager(), uno::UNO_QUERY );
429 : }
430 :
431 : uno::Reference< container::XNameAccess > xNameAccess(
432 : frame::theUICommandDescription::get(
433 : ::comphelper::getProcessComponentContext()),
434 0 : uno::UNO_QUERY_THROW );
435 : try
436 : {
437 0 : uno::Any a = xNameAccess->getByName( aModuleId );
438 0 : a >>= m_xUICommandLabels;
439 : }
440 0 : catch ( container::NoSuchElementException& )
441 : {
442 0 : }
443 : }
444 0 : catch ( uno::RuntimeException& )
445 : {
446 0 : throw;
447 : }
448 0 : catch ( uno::Exception& )
449 : {
450 0 : m_bUICfgMgrAssociated = true;
451 0 : return false;
452 : }
453 0 : m_bUICfgMgrAssociated = true;
454 : }
455 :
456 0 : return true;
457 : }
458 :
459 : Image
460 0 : ContextMenuHelper::getImageFromCommandURL( const OUString& aCmdURL ) const
461 : {
462 0 : Image aImage;
463 : sal_Int16 nImageType( ui::ImageType::COLOR_NORMAL|
464 0 : ui::ImageType::SIZE_DEFAULT );
465 :
466 0 : uno::Sequence< uno::Reference< graphic::XGraphic > > aGraphicSeq;
467 0 : uno::Sequence< OUString > aImageCmdSeq( 1 );
468 0 : aImageCmdSeq[0] = aCmdURL;
469 :
470 0 : if ( m_xDocImageMgr.is() )
471 : {
472 : try
473 : {
474 0 : aGraphicSeq = m_xDocImageMgr->getImages( nImageType, aImageCmdSeq );
475 0 : uno::Reference< graphic::XGraphic > xGraphic = aGraphicSeq[0];
476 0 : aImage = Image( xGraphic );
477 :
478 0 : if ( !!aImage )
479 0 : return aImage;
480 : }
481 0 : catch ( uno::RuntimeException& )
482 : {
483 0 : throw;
484 : }
485 0 : catch ( uno::Exception& )
486 : {
487 : }
488 : }
489 :
490 0 : if ( m_xModuleImageMgr.is() )
491 : {
492 : try
493 : {
494 0 : aGraphicSeq = m_xModuleImageMgr->getImages( nImageType, aImageCmdSeq );
495 0 : uno::Reference< ::com::sun::star::graphic::XGraphic > xGraphic = aGraphicSeq[0];
496 0 : aImage = Image( xGraphic );
497 :
498 0 : if ( !!aImage )
499 0 : return aImage;
500 : }
501 0 : catch ( uno::RuntimeException& )
502 : {
503 0 : throw;
504 : }
505 0 : catch ( uno::Exception& )
506 : {
507 : }
508 : }
509 :
510 0 : return aImage;
511 : }
512 :
513 : OUString
514 0 : ContextMenuHelper::getLabelFromCommandURL(
515 : const OUString& aCmdURL ) const
516 : {
517 0 : OUString aLabel;
518 :
519 0 : if ( m_xUICommandLabels.is() )
520 : {
521 : try
522 : {
523 0 : if ( !aCmdURL.isEmpty() )
524 : {
525 0 : OUString aStr;
526 0 : uno::Sequence< beans::PropertyValue > aPropSeq;
527 0 : uno::Any a( m_xUICommandLabels->getByName( aCmdURL ));
528 0 : if ( a >>= aPropSeq )
529 : {
530 0 : for ( sal_Int32 i = 0; i < aPropSeq.getLength(); i++ )
531 : {
532 0 : if ( aPropSeq[i].Name == "Label" )
533 : {
534 0 : aPropSeq[i].Value >>= aStr;
535 0 : break;
536 : }
537 : }
538 : }
539 0 : aLabel = aStr;
540 : }
541 : }
542 0 : catch ( uno::RuntimeException& )
543 : {
544 : }
545 0 : catch ( uno::Exception& )
546 : {
547 : }
548 : }
549 :
550 0 : return aLabel;
551 : }
552 :
553 : void
554 0 : ContextMenuHelper::completeMenuProperties(
555 : Menu* pMenu )
556 : {
557 : // Retrieve some settings necessary to display complete context
558 : // menu correctly.
559 0 : const StyleSettings& rSettings = Application::GetSettings().GetStyleSettings();
560 0 : bool bShowMenuImages( rSettings.GetUseImagesInMenus() );
561 :
562 0 : if ( pMenu )
563 : {
564 0 : uno::Reference< frame::XFrame > xFrame( m_xWeakFrame );
565 0 : uno::Reference< frame::XDispatchProvider > xDispatchProvider( xFrame, uno::UNO_QUERY );
566 :
567 0 : if ( !m_xURLTransformer.is() )
568 : {
569 0 : m_xURLTransformer = util::URLTransformer::create( ::comphelper::getProcessComponentContext() );
570 : }
571 :
572 0 : for ( sal_uInt16 nPos = 0; nPos < pMenu->GetItemCount(); nPos++ )
573 : {
574 0 : sal_uInt16 nId = pMenu->GetItemId( nPos );
575 0 : PopupMenu* pPopupMenu = pMenu->GetPopupMenu( nId );
576 0 : if ( pPopupMenu )
577 0 : completeMenuProperties( pPopupMenu );
578 0 : if ( pMenu->GetItemType( nPos ) != MenuItemType::SEPARATOR )
579 : {
580 0 : OUString aCmdURL( pMenu->GetItemCommand( nId ));
581 :
582 0 : if ( bShowMenuImages )
583 : {
584 0 : Image aImage;
585 0 : if ( !aCmdURL.isEmpty() )
586 0 : aImage = getImageFromCommandURL( aCmdURL );
587 0 : pMenu->SetItemImage( nId, aImage );
588 : }
589 : else
590 0 : pMenu->SetItemImage( nId, Image() );
591 :
592 0 : if (pMenu->GetItemText(nId).isEmpty())
593 : {
594 0 : OUString aLabel( getLabelFromCommandURL( aCmdURL ));
595 0 : pMenu->SetItemText( nId, aLabel );
596 : }
597 :
598 : // Use helper to retrieve state of the command URL
599 : StateEventHelper* pHelper = new StateEventHelper(
600 : xDispatchProvider,
601 : m_xURLTransformer,
602 0 : aCmdURL );
603 :
604 0 : uno::Reference< frame::XStatusListener > xHelper( pHelper );
605 0 : pMenu->EnableItem( nId, pHelper->isCommandEnabled() );
606 : }
607 0 : }
608 : }
609 0 : }
610 :
611 :
612 0 : IMPL_STATIC_LINK( ContextMenuHelper, ExecuteHdl_Impl, ExecuteInfo*, pExecuteInfo )
613 : {
614 : // Release solar mutex to prevent deadlocks with clipboard thread
615 0 : SolarMutexReleaser aReleaser;
616 : try
617 : {
618 : // Asynchronous execution as this can lead to our own destruction while we are
619 : // on the stack. Stack unwinding would access the destroyed context menu.
620 0 : pExecuteInfo->xDispatch->dispatch( pExecuteInfo->aTargetURL, pExecuteInfo->aArgs );
621 : }
622 0 : catch ( uno::Exception& )
623 : {
624 : }
625 :
626 0 : delete pExecuteInfo;
627 0 : return 0;
628 : }
629 :
630 : } // namespace svt
631 :
632 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
