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 <svtools/acceleratorexecute.hxx>
21 :
22 : #include <com/sun/star/frame/ModuleManager.hpp>
23 : #include <com/sun/star/frame/Desktop.hpp>
24 : #include <com/sun/star/ui/GlobalAcceleratorConfiguration.hpp>
25 : #include <com/sun/star/ui/XUIConfigurationManager.hpp>
26 : #include <com/sun/star/ui/theModuleUIConfigurationManagerSupplier.hpp>
27 : #include <com/sun/star/ui/XUIConfigurationManagerSupplier.hpp>
28 : #include <com/sun/star/awt/XTopWindow.hpp>
29 : #include <com/sun/star/awt/KeyModifier.hpp>
30 : #include <com/sun/star/uno/Sequence.hxx>
31 : #include <com/sun/star/beans/PropertyValue.hpp>
32 : #include <com/sun/star/lang/DisposedException.hpp>
33 : #include <com/sun/star/util/URLTransformer.hpp>
34 : #include <toolkit/helper/vclunohelper.hxx>
35 : #include <comphelper/processfactory.hxx>
36 :
37 : #include <vcl/window.hxx>
38 : #include <vcl/svapp.hxx>
39 : #include <osl/mutex.hxx>
40 :
41 :
42 : namespace svt
43 : {
44 :
45 :
46 :
47 0 : class SVT_DLLPRIVATE AsyncAccelExec
48 : {
49 : public:
50 :
51 : /** creates a new instance of this class, which can be used
52 : one times only!
53 :
54 : This instance can be forced to execute it's internal set request
55 : asynchronous. After that it deletes itself !
56 : */
57 : static AsyncAccelExec* createOnShotInstance(const css::uno::Reference< css::frame::XDispatch >& xDispatch,
58 : const css::util::URL& aURL );
59 :
60 : void execAsync();
61 :
62 : private:
63 :
64 : /** @short allow creation of instances of this class
65 : by using our factory only!
66 : */
67 : SVT_DLLPRIVATE AsyncAccelExec(const css::uno::Reference< css::frame::XDispatch >& xDispatch,
68 : const css::util::URL& aURL );
69 :
70 : DECL_DLLPRIVATE_LINK(impl_ts_asyncCallback, void*);
71 :
72 : private:
73 : ::vcl::EventPoster m_aAsyncCallback;
74 : css::uno::Reference< css::frame::XDispatch > m_xDispatch;
75 : css::util::URL m_aURL;
76 : };
77 :
78 :
79 18 : AcceleratorExecute::AcceleratorExecute()
80 : : TMutexInit ( )
81 18 : , m_aAsyncCallback(LINK(this, AcceleratorExecute, impl_ts_asyncCallback))
82 : {
83 18 : }
84 :
85 :
86 0 : AcceleratorExecute::AcceleratorExecute(const AcceleratorExecute&)
87 : : TMutexInit ( )
88 0 : , m_aAsyncCallback(LINK(this, AcceleratorExecute, impl_ts_asyncCallback))
89 : {
90 : // copy construction sint supported in real ...
91 : // but we need this ctor to init our async callback ...
92 0 : }
93 :
94 :
95 28 : AcceleratorExecute::~AcceleratorExecute()
96 : {
97 : // does nothing real
98 28 : }
99 :
100 :
101 18 : AcceleratorExecute* AcceleratorExecute::createAcceleratorHelper()
102 : {
103 18 : AcceleratorExecute* pNew = new AcceleratorExecute();
104 18 : return pNew;
105 : }
106 :
107 :
108 30 : void AcceleratorExecute::init(const css::uno::Reference< css::uno::XComponentContext >& rxContext,
109 : const css::uno::Reference< css::frame::XFrame >& xEnv )
110 : {
111 : // SAFE -> ----------------------------------
112 30 : ::osl::ResettableMutexGuard aLock(m_aLock);
113 :
114 : // take over the uno service manager
115 30 : m_xContext = rxContext;
116 :
117 : // specify our internal dispatch provider
118 : // frame or desktop?! => document or global config.
119 30 : bool bDesktopIsUsed = false;
120 30 : m_xDispatcher = css::uno::Reference< css::frame::XDispatchProvider >(xEnv, css::uno::UNO_QUERY);
121 30 : if (!m_xDispatcher.is())
122 : {
123 12 : aLock.clear();
124 : // <- SAFE ------------------------------
125 :
126 12 : css::uno::Reference< css::frame::XDispatchProvider > xDispatcher(css::frame::Desktop::create(rxContext), css::uno::UNO_QUERY_THROW);
127 :
128 : // SAFE -> ------------------------------
129 12 : aLock.reset();
130 :
131 12 : m_xDispatcher = xDispatcher;
132 12 : bDesktopIsUsed = true;
133 : }
134 :
135 30 : aLock.clear();
136 : // <- SAFE ----------------------------------
137 :
138 : // open all needed configuration objects
139 60 : css::uno::Reference< css::ui::XAcceleratorConfiguration > xGlobalCfg;
140 60 : css::uno::Reference< css::ui::XAcceleratorConfiguration > xModuleCfg;
141 60 : css::uno::Reference< css::ui::XAcceleratorConfiguration > xDocCfg ;
142 :
143 : // global cfg
144 30 : xGlobalCfg = css::ui::GlobalAcceleratorConfiguration::create(rxContext);
145 30 : if (!bDesktopIsUsed)
146 : {
147 : // module cfg
148 18 : xModuleCfg = AcceleratorExecute::st_openModuleConfig(rxContext, xEnv);
149 :
150 : // doc cfg
151 18 : css::uno::Reference< css::frame::XController > xController;
152 36 : css::uno::Reference< css::frame::XModel > xModel;
153 18 : xController = xEnv->getController();
154 18 : if (xController.is())
155 18 : xModel = xController->getModel();
156 18 : if (xModel.is())
157 34 : xDocCfg = AcceleratorExecute::st_openDocConfig(xModel);
158 : }
159 :
160 : // SAFE -> ------------------------------
161 30 : aLock.reset();
162 :
163 30 : m_xGlobalCfg = xGlobalCfg;
164 30 : m_xModuleCfg = xModuleCfg;
165 30 : m_xDocCfg = xDocCfg ;
166 :
167 60 : aLock.clear();
168 : // <- SAFE ----------------------------------
169 30 : }
170 :
171 :
172 0 : bool AcceleratorExecute::execute(const vcl::KeyCode& aVCLKey)
173 : {
174 0 : css::awt::KeyEvent aAWTKey = AcceleratorExecute::st_VCLKey2AWTKey(aVCLKey);
175 0 : return execute(aAWTKey);
176 : }
177 :
178 :
179 0 : bool AcceleratorExecute::execute(const css::awt::KeyEvent& aAWTKey)
180 : {
181 0 : OUString sCommand = impl_ts_findCommand(aAWTKey);
182 :
183 : // No Command found? Do nothing! User isnt interested on any error handling .-)
184 : // or for some reason m_xContext is NULL (which would crash impl_ts_getURLParser()
185 0 : if (sCommand.isEmpty() || !m_xContext.is())
186 : {
187 0 : return false;
188 : }
189 :
190 : // SAFE -> ----------------------------------
191 0 : ::osl::ResettableMutexGuard aLock(m_aLock);
192 :
193 0 : css::uno::Reference< css::frame::XDispatchProvider > xProvider = m_xDispatcher;
194 :
195 0 : aLock.clear();
196 : // <- SAFE ----------------------------------
197 :
198 : // convert command in URL structure
199 0 : css::uno::Reference< css::util::XURLTransformer > xParser = impl_ts_getURLParser();
200 0 : css::util::URL aURL;
201 0 : aURL.Complete = sCommand;
202 0 : xParser->parseStrict(aURL);
203 :
204 : // ask for dispatch object
205 0 : css::uno::Reference< css::frame::XDispatch > xDispatch = xProvider->queryDispatch(aURL, OUString(), 0);
206 0 : bool bRet = xDispatch.is();
207 0 : if ( bRet )
208 : {
209 : // Note: Such instance can be used one times only and destroy itself afterwards .-)
210 0 : AsyncAccelExec* pExec = AsyncAccelExec::createOnShotInstance(xDispatch, aURL);
211 0 : pExec->execAsync();
212 : }
213 :
214 0 : return bRet;
215 : }
216 :
217 :
218 0 : css::awt::KeyEvent AcceleratorExecute::st_VCLKey2AWTKey(const vcl::KeyCode& aVCLKey)
219 : {
220 0 : css::awt::KeyEvent aAWTKey;
221 0 : aAWTKey.Modifiers = 0;
222 0 : aAWTKey.KeyCode = (sal_Int16)aVCLKey.GetCode();
223 :
224 0 : if (aVCLKey.IsShift())
225 0 : aAWTKey.Modifiers |= css::awt::KeyModifier::SHIFT;
226 0 : if (aVCLKey.IsMod1())
227 0 : aAWTKey.Modifiers |= css::awt::KeyModifier::MOD1;
228 0 : if (aVCLKey.IsMod2())
229 0 : aAWTKey.Modifiers |= css::awt::KeyModifier::MOD2;
230 0 : if (aVCLKey.IsMod3())
231 0 : aAWTKey.Modifiers |= css::awt::KeyModifier::MOD3;
232 0 : return aAWTKey;
233 : }
234 :
235 :
236 89546 : vcl::KeyCode AcceleratorExecute::st_AWTKey2VCLKey(const css::awt::KeyEvent& aAWTKey)
237 : {
238 89546 : bool bShift = ((aAWTKey.Modifiers & css::awt::KeyModifier::SHIFT) == css::awt::KeyModifier::SHIFT );
239 89546 : bool bMod1 = ((aAWTKey.Modifiers & css::awt::KeyModifier::MOD1 ) == css::awt::KeyModifier::MOD1 );
240 89546 : bool bMod2 = ((aAWTKey.Modifiers & css::awt::KeyModifier::MOD2 ) == css::awt::KeyModifier::MOD2 );
241 89546 : bool bMod3 = ((aAWTKey.Modifiers & css::awt::KeyModifier::MOD3 ) == css::awt::KeyModifier::MOD3 );
242 89546 : sal_uInt16 nKey = (sal_uInt16)aAWTKey.KeyCode;
243 :
244 89546 : return vcl::KeyCode(nKey, bShift, bMod1, bMod2, bMod3);
245 : }
246 :
247 0 : OUString AcceleratorExecute::findCommand(const css::awt::KeyEvent& aKey)
248 : {
249 0 : return impl_ts_findCommand(aKey);
250 : }
251 :
252 0 : OUString AcceleratorExecute::impl_ts_findCommand(const css::awt::KeyEvent& aKey)
253 : {
254 : // SAFE -> ----------------------------------
255 0 : ::osl::ResettableMutexGuard aLock(m_aLock);
256 :
257 0 : css::uno::Reference< css::ui::XAcceleratorConfiguration > xGlobalCfg = m_xGlobalCfg;
258 0 : css::uno::Reference< css::ui::XAcceleratorConfiguration > xModuleCfg = m_xModuleCfg;
259 0 : css::uno::Reference< css::ui::XAcceleratorConfiguration > xDocCfg = m_xDocCfg ;
260 :
261 0 : aLock.clear();
262 : // <- SAFE ----------------------------------
263 :
264 0 : OUString sCommand;
265 :
266 : try
267 : {
268 0 : if (xDocCfg.is())
269 0 : sCommand = xDocCfg->getCommandByKeyEvent(aKey);
270 0 : if (!sCommand.isEmpty())
271 0 : return sCommand;
272 : }
273 0 : catch(const css::container::NoSuchElementException&)
274 : {}
275 :
276 : try
277 : {
278 0 : if (xModuleCfg.is())
279 0 : sCommand = xModuleCfg->getCommandByKeyEvent(aKey);
280 0 : if (!sCommand.isEmpty())
281 0 : return sCommand;
282 : }
283 0 : catch(const css::container::NoSuchElementException&)
284 : {}
285 :
286 : try
287 : {
288 0 : if (xGlobalCfg.is())
289 0 : sCommand = xGlobalCfg->getCommandByKeyEvent(aKey);
290 0 : if (!sCommand.isEmpty())
291 0 : return sCommand;
292 : }
293 0 : catch(const css::container::NoSuchElementException&)
294 : {}
295 :
296 : // fall back to functional key codes
297 0 : if( aKey.Modifiers == 0 )
298 : {
299 0 : switch( aKey.KeyCode )
300 : {
301 : case com::sun::star::awt::Key::DELETE_TO_BEGIN_OF_LINE:
302 0 : return OUString( ".uno:DelToStartOfLine" );
303 : case com::sun::star::awt::Key::DELETE_TO_END_OF_LINE:
304 0 : return OUString( ".uno:DelToEndOfLine" );
305 : case com::sun::star::awt::Key::DELETE_TO_BEGIN_OF_PARAGRAPH:
306 0 : return OUString( ".uno:DelToStartOfPara" );
307 : case com::sun::star::awt::Key::DELETE_TO_END_OF_PARAGRAPH:
308 0 : return OUString( ".uno:DelToEndOfPara" );
309 : case com::sun::star::awt::Key::DELETE_WORD_BACKWARD:
310 0 : return OUString( ".uno:DelToStartOfWord" );
311 : case com::sun::star::awt::Key::DELETE_WORD_FORWARD:
312 0 : return OUString( ".uno:DelToEndOfWord" );
313 : case com::sun::star::awt::Key::INSERT_LINEBREAK:
314 0 : return OUString( ".uno:InsertLinebreak" );
315 : case com::sun::star::awt::Key::INSERT_PARAGRAPH:
316 0 : return OUString( ".uno:InsertPara" );
317 : case com::sun::star::awt::Key::MOVE_WORD_BACKWARD:
318 0 : return OUString( ".uno:GoToPrevWord" );
319 : case com::sun::star::awt::Key::MOVE_WORD_FORWARD:
320 0 : return OUString( ".uno:GoToNextWord" );
321 : case com::sun::star::awt::Key::MOVE_TO_BEGIN_OF_LINE:
322 0 : return OUString( ".uno:GoToStartOfLine" );
323 : case com::sun::star::awt::Key::MOVE_TO_END_OF_LINE:
324 0 : return OUString( ".uno:GoToEndOfLine" );
325 : case com::sun::star::awt::Key::MOVE_TO_BEGIN_OF_PARAGRAPH:
326 0 : return OUString( ".uno:GoToStartOfPara" );
327 : case com::sun::star::awt::Key::MOVE_TO_END_OF_PARAGRAPH:
328 0 : return OUString( ".uno:GoToEndOfPara" );
329 : case com::sun::star::awt::Key::MOVE_TO_BEGIN_OF_DOCUMENT:
330 0 : return OUString( ".uno:GoToStartOfDoc" );
331 : case com::sun::star::awt::Key::MOVE_TO_END_OF_DOCUMENT:
332 0 : return OUString( ".uno:GoToEndOfDoc" );
333 : case com::sun::star::awt::Key::SELECT_BACKWARD:
334 0 : return OUString( ".uno:CharLeftSel" );
335 : case com::sun::star::awt::Key::SELECT_FORWARD:
336 0 : return OUString( ".uno:CharRightSel" );
337 : case com::sun::star::awt::Key::SELECT_WORD_BACKWARD:
338 0 : return OUString( ".uno:WordLeftSel" );
339 : case com::sun::star::awt::Key::SELECT_WORD_FORWARD:
340 0 : return OUString( ".uno:WordRightSel" );
341 : case com::sun::star::awt::Key::SELECT_WORD:
342 0 : return OUString( ".uno:SelectWord" );
343 : case com::sun::star::awt::Key::SELECT_LINE:
344 0 : return OUString();
345 : case com::sun::star::awt::Key::SELECT_PARAGRAPH:
346 0 : return OUString( ".uno:SelectText" );
347 : case com::sun::star::awt::Key::SELECT_TO_BEGIN_OF_LINE:
348 0 : return OUString( ".uno:StartOfLineSel" );
349 : case com::sun::star::awt::Key::SELECT_TO_END_OF_LINE:
350 0 : return OUString( ".uno:EndOfLineSel" );
351 : case com::sun::star::awt::Key::SELECT_TO_BEGIN_OF_PARAGRAPH:
352 0 : return OUString( ".uno:StartOfParaSel" );
353 : case com::sun::star::awt::Key::SELECT_TO_END_OF_PARAGRAPH:
354 0 : return OUString( ".uno:EndOfParaSel" );
355 : case com::sun::star::awt::Key::SELECT_TO_BEGIN_OF_DOCUMENT:
356 0 : return OUString( ".uno:StartOfDocumentSel" );
357 : case com::sun::star::awt::Key::SELECT_TO_END_OF_DOCUMENT:
358 0 : return OUString( ".uno:EndOfDocumentSel" );
359 : case com::sun::star::awt::Key::SELECT_ALL:
360 0 : return OUString( ".uno:SelectAll" );
361 : default:
362 0 : break;
363 : }
364 : }
365 :
366 0 : return OUString();
367 : }
368 :
369 :
370 18 : css::uno::Reference< css::ui::XAcceleratorConfiguration > AcceleratorExecute::st_openModuleConfig(const css::uno::Reference< css::uno::XComponentContext >& rxContext,
371 : const css::uno::Reference< css::frame::XFrame >& xFrame)
372 : {
373 : css::uno::Reference< css::frame::XModuleManager2 > xModuleDetection(
374 18 : css::frame::ModuleManager::create(rxContext));
375 :
376 36 : OUString sModule;
377 : try
378 : {
379 18 : sModule = xModuleDetection->identify(xFrame);
380 : }
381 0 : catch(const css::uno::RuntimeException&rEx)
382 0 : { (void) rEx; throw; }
383 0 : catch(const css::uno::Exception&)
384 0 : { return css::uno::Reference< css::ui::XAcceleratorConfiguration >(); }
385 :
386 : css::uno::Reference< css::ui::XModuleUIConfigurationManagerSupplier > xUISupplier(
387 36 : css::ui::theModuleUIConfigurationManagerSupplier::get(rxContext) );
388 :
389 36 : css::uno::Reference< css::ui::XAcceleratorConfiguration > xAccCfg;
390 : try
391 : {
392 18 : css::uno::Reference< css::ui::XUIConfigurationManager > xUIManager = xUISupplier->getUIConfigurationManager(sModule);
393 18 : xAccCfg = xUIManager->getShortCutManager();
394 : }
395 0 : catch(const css::container::NoSuchElementException&)
396 : {}
397 36 : return xAccCfg;
398 : }
399 :
400 :
401 16 : css::uno::Reference< css::ui::XAcceleratorConfiguration > AcceleratorExecute::st_openDocConfig(const css::uno::Reference< css::frame::XModel >& xModel)
402 : {
403 16 : css::uno::Reference< css::ui::XAcceleratorConfiguration > xAccCfg;
404 32 : css::uno::Reference< css::ui::XUIConfigurationManagerSupplier > xUISupplier(xModel, css::uno::UNO_QUERY);
405 16 : if (xUISupplier.is())
406 : {
407 16 : css::uno::Reference< css::ui::XUIConfigurationManager > xUIManager = xUISupplier->getUIConfigurationManager();
408 16 : xAccCfg = xUIManager->getShortCutManager();
409 : }
410 32 : return xAccCfg;
411 : }
412 :
413 :
414 0 : css::uno::Reference< css::util::XURLTransformer > AcceleratorExecute::impl_ts_getURLParser()
415 : {
416 : // SAFE -> ----------------------------------
417 0 : ::osl::ResettableMutexGuard aLock(m_aLock);
418 :
419 0 : if (m_xURLParser.is())
420 0 : return m_xURLParser;
421 0 : css::uno::Reference< css::uno::XComponentContext > xContext = m_xContext;
422 :
423 0 : aLock.clear();
424 : // <- SAFE ----------------------------------
425 :
426 0 : css::uno::Reference< css::util::XURLTransformer > xParser = css::util::URLTransformer::create( xContext );
427 :
428 : // SAFE -> ----------------------------------
429 0 : aLock.reset();
430 0 : m_xURLParser = xParser;
431 0 : aLock.clear();
432 : // <- SAFE ----------------------------------
433 :
434 0 : return xParser;
435 : }
436 :
437 :
438 0 : IMPL_LINK_NOARG(AcceleratorExecute, impl_ts_asyncCallback)
439 : {
440 : // replaced by AsyncAccelExec!
441 0 : return 0;
442 : }
443 :
444 :
445 0 : AsyncAccelExec::AsyncAccelExec(const css::uno::Reference< css::frame::XDispatch >& xDispatch,
446 : const css::util::URL& aURL )
447 : : m_aAsyncCallback(LINK(this, AsyncAccelExec, impl_ts_asyncCallback))
448 : , m_xDispatch (xDispatch )
449 0 : , m_aURL (aURL )
450 : {
451 0 : }
452 :
453 :
454 0 : AsyncAccelExec* AsyncAccelExec::createOnShotInstance(const css::uno::Reference< css::frame::XDispatch >& xDispatch,
455 : const css::util::URL& aURL )
456 : {
457 0 : AsyncAccelExec* pExec = new AsyncAccelExec(xDispatch, aURL);
458 0 : return pExec;
459 : }
460 :
461 :
462 0 : void AsyncAccelExec::execAsync()
463 : {
464 0 : m_aAsyncCallback.Post(0);
465 0 : }
466 :
467 :
468 0 : IMPL_LINK(AsyncAccelExec, impl_ts_asyncCallback, void*,)
469 : {
470 0 : if (! m_xDispatch.is())
471 0 : return 0;
472 :
473 : try
474 : {
475 0 : m_xDispatch->dispatch(m_aURL, css::uno::Sequence< css::beans::PropertyValue >());
476 : }
477 0 : catch(const css::lang::DisposedException&)
478 : {}
479 0 : catch(const css::uno::RuntimeException& )
480 0 : { throw; }
481 0 : catch(const css::uno::Exception&)
482 : {}
483 :
484 0 : delete this;
485 :
486 0 : return 0;
487 : }
488 :
489 1227 : } // namespace svt
490 :
491 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
