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