1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir // MARKER(update_precomp.py): autogen include statement, do not remove 29*cdf0e10cSrcweir #include "precompiled_framework.hxx" 30*cdf0e10cSrcweir #include <accelerators/acceleratorcache.hxx> 31*cdf0e10cSrcweir 32*cdf0e10cSrcweir //_______________________________________________ 33*cdf0e10cSrcweir // own includes 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir #ifndef __FRAMEWORK_XML_ACCELERATORCONFIGURATIONREADER_HXX_ 36*cdf0e10cSrcweir #include <xml/acceleratorconfigurationreader.hxx> 37*cdf0e10cSrcweir #endif 38*cdf0e10cSrcweir #include <threadhelp/readguard.hxx> 39*cdf0e10cSrcweir #include <threadhelp/writeguard.hxx> 40*cdf0e10cSrcweir 41*cdf0e10cSrcweir //_______________________________________________ 42*cdf0e10cSrcweir // interface includes 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir #ifndef __COM_SUN_STAR_CONTAINER_ELEMENTEXISTEXCEPTION_HPP_ 45*cdf0e10cSrcweir #include <com/sun/star/container/ElementExistException.hpp> 46*cdf0e10cSrcweir #endif 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir #ifndef __COM_SUN_STAR_CONTAINER_NOSUCHELEMENTEXCEPTION_HPP_ 49*cdf0e10cSrcweir #include <com/sun/star/container/NoSuchElementException.hpp> 50*cdf0e10cSrcweir #endif 51*cdf0e10cSrcweir 52*cdf0e10cSrcweir //_______________________________________________ 53*cdf0e10cSrcweir // other includes 54*cdf0e10cSrcweir #include <vcl/svapp.hxx> 55*cdf0e10cSrcweir 56*cdf0e10cSrcweir namespace framework 57*cdf0e10cSrcweir { 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir //----------------------------------------------- 60*cdf0e10cSrcweir AcceleratorCache::AcceleratorCache() 61*cdf0e10cSrcweir : ThreadHelpBase(&Application::GetSolarMutex()) 62*cdf0e10cSrcweir { 63*cdf0e10cSrcweir } 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir //----------------------------------------------- 66*cdf0e10cSrcweir AcceleratorCache::AcceleratorCache(const AcceleratorCache& rCopy) 67*cdf0e10cSrcweir : ThreadHelpBase(&Application::GetSolarMutex()) 68*cdf0e10cSrcweir { 69*cdf0e10cSrcweir m_lCommand2Keys = rCopy.m_lCommand2Keys; 70*cdf0e10cSrcweir m_lKey2Commands = rCopy.m_lKey2Commands; 71*cdf0e10cSrcweir } 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir //----------------------------------------------- 74*cdf0e10cSrcweir AcceleratorCache::~AcceleratorCache() 75*cdf0e10cSrcweir { 76*cdf0e10cSrcweir // Dont save anything automaticly here. 77*cdf0e10cSrcweir // The user has to do that explicitly! 78*cdf0e10cSrcweir } 79*cdf0e10cSrcweir 80*cdf0e10cSrcweir //----------------------------------------------- 81*cdf0e10cSrcweir void AcceleratorCache::takeOver(const AcceleratorCache& rCopy) 82*cdf0e10cSrcweir { 83*cdf0e10cSrcweir // SAFE -> ---------------------------------- 84*cdf0e10cSrcweir WriteGuard aWriteLock(m_aLock); 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir m_lCommand2Keys = rCopy.m_lCommand2Keys; 87*cdf0e10cSrcweir m_lKey2Commands = rCopy.m_lKey2Commands; 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir aWriteLock.unlock(); 90*cdf0e10cSrcweir // <- SAFE ---------------------------------- 91*cdf0e10cSrcweir } 92*cdf0e10cSrcweir 93*cdf0e10cSrcweir //----------------------------------------------- 94*cdf0e10cSrcweir AcceleratorCache& AcceleratorCache::operator=(const AcceleratorCache& rCopy) 95*cdf0e10cSrcweir { 96*cdf0e10cSrcweir takeOver(rCopy); 97*cdf0e10cSrcweir return *this; 98*cdf0e10cSrcweir } 99*cdf0e10cSrcweir 100*cdf0e10cSrcweir //----------------------------------------------- 101*cdf0e10cSrcweir sal_Bool AcceleratorCache::hasKey(const css::awt::KeyEvent& aKey) const 102*cdf0e10cSrcweir { 103*cdf0e10cSrcweir // SAFE -> ---------------------------------- 104*cdf0e10cSrcweir ReadGuard aReadLock(m_aLock); 105*cdf0e10cSrcweir 106*cdf0e10cSrcweir return (m_lKey2Commands.find(aKey) != m_lKey2Commands.end()); 107*cdf0e10cSrcweir // <- SAFE ---------------------------------- 108*cdf0e10cSrcweir } 109*cdf0e10cSrcweir 110*cdf0e10cSrcweir //----------------------------------------------- 111*cdf0e10cSrcweir sal_Bool AcceleratorCache::hasCommand(const ::rtl::OUString& sCommand) const 112*cdf0e10cSrcweir { 113*cdf0e10cSrcweir // SAFE -> ---------------------------------- 114*cdf0e10cSrcweir ReadGuard aReadLock(m_aLock); 115*cdf0e10cSrcweir 116*cdf0e10cSrcweir return (m_lCommand2Keys.find(sCommand) != m_lCommand2Keys.end()); 117*cdf0e10cSrcweir // <- SAFE ---------------------------------- 118*cdf0e10cSrcweir } 119*cdf0e10cSrcweir 120*cdf0e10cSrcweir //----------------------------------------------- 121*cdf0e10cSrcweir AcceleratorCache::TKeyList AcceleratorCache::getAllKeys() const 122*cdf0e10cSrcweir { 123*cdf0e10cSrcweir TKeyList lKeys; 124*cdf0e10cSrcweir 125*cdf0e10cSrcweir // SAFE -> ---------------------------------- 126*cdf0e10cSrcweir ReadGuard aReadLock(m_aLock); 127*cdf0e10cSrcweir lKeys.reserve(m_lKey2Commands.size()); 128*cdf0e10cSrcweir 129*cdf0e10cSrcweir TKey2Commands::const_iterator pIt; 130*cdf0e10cSrcweir TKey2Commands::const_iterator pEnd = m_lKey2Commands.end(); 131*cdf0e10cSrcweir for ( pIt = m_lKey2Commands.begin(); 132*cdf0e10cSrcweir pIt != pEnd ; 133*cdf0e10cSrcweir ++pIt ) 134*cdf0e10cSrcweir { 135*cdf0e10cSrcweir lKeys.push_back(pIt->first); 136*cdf0e10cSrcweir } 137*cdf0e10cSrcweir 138*cdf0e10cSrcweir aReadLock.unlock(); 139*cdf0e10cSrcweir // <- SAFE ---------------------------------- 140*cdf0e10cSrcweir 141*cdf0e10cSrcweir return lKeys; 142*cdf0e10cSrcweir } 143*cdf0e10cSrcweir 144*cdf0e10cSrcweir //----------------------------------------------- 145*cdf0e10cSrcweir void AcceleratorCache::setKeyCommandPair(const css::awt::KeyEvent& aKey , 146*cdf0e10cSrcweir const ::rtl::OUString& sCommand) 147*cdf0e10cSrcweir { 148*cdf0e10cSrcweir // SAFE -> ---------------------------------- 149*cdf0e10cSrcweir WriteGuard aWriteLock(m_aLock); 150*cdf0e10cSrcweir 151*cdf0e10cSrcweir // register command for the specified key 152*cdf0e10cSrcweir m_lKey2Commands[aKey] = sCommand; 153*cdf0e10cSrcweir 154*cdf0e10cSrcweir // update optimized structure to bind multiple keys to one command 155*cdf0e10cSrcweir TKeyList& rKeyList = m_lCommand2Keys[sCommand]; 156*cdf0e10cSrcweir rKeyList.push_back(aKey); 157*cdf0e10cSrcweir 158*cdf0e10cSrcweir aWriteLock.unlock(); 159*cdf0e10cSrcweir // <- SAFE ---------------------------------- 160*cdf0e10cSrcweir } 161*cdf0e10cSrcweir 162*cdf0e10cSrcweir //----------------------------------------------- 163*cdf0e10cSrcweir AcceleratorCache::TKeyList AcceleratorCache::getKeysByCommand(const ::rtl::OUString& sCommand) const 164*cdf0e10cSrcweir { 165*cdf0e10cSrcweir TKeyList lKeys; 166*cdf0e10cSrcweir 167*cdf0e10cSrcweir // SAFE -> ---------------------------------- 168*cdf0e10cSrcweir ReadGuard aReadLock(m_aLock); 169*cdf0e10cSrcweir 170*cdf0e10cSrcweir TCommand2Keys::const_iterator pCommand = m_lCommand2Keys.find(sCommand); 171*cdf0e10cSrcweir if (pCommand == m_lCommand2Keys.end()) 172*cdf0e10cSrcweir throw css::container::NoSuchElementException( 173*cdf0e10cSrcweir ::rtl::OUString(), css::uno::Reference< css::uno::XInterface >()); 174*cdf0e10cSrcweir lKeys = pCommand->second; 175*cdf0e10cSrcweir 176*cdf0e10cSrcweir aReadLock.unlock(); 177*cdf0e10cSrcweir // <- SAFE ---------------------------------- 178*cdf0e10cSrcweir 179*cdf0e10cSrcweir return lKeys; 180*cdf0e10cSrcweir } 181*cdf0e10cSrcweir 182*cdf0e10cSrcweir //----------------------------------------------- 183*cdf0e10cSrcweir ::rtl::OUString AcceleratorCache::getCommandByKey(const css::awt::KeyEvent& aKey) const 184*cdf0e10cSrcweir { 185*cdf0e10cSrcweir ::rtl::OUString sCommand; 186*cdf0e10cSrcweir 187*cdf0e10cSrcweir // SAFE -> ---------------------------------- 188*cdf0e10cSrcweir ReadGuard aReadLock(m_aLock); 189*cdf0e10cSrcweir 190*cdf0e10cSrcweir TKey2Commands::const_iterator pKey = m_lKey2Commands.find(aKey); 191*cdf0e10cSrcweir if (pKey == m_lKey2Commands.end()) 192*cdf0e10cSrcweir throw css::container::NoSuchElementException( 193*cdf0e10cSrcweir ::rtl::OUString(), css::uno::Reference< css::uno::XInterface >()); 194*cdf0e10cSrcweir sCommand = pKey->second; 195*cdf0e10cSrcweir 196*cdf0e10cSrcweir aReadLock.unlock(); 197*cdf0e10cSrcweir // <- SAFE ---------------------------------- 198*cdf0e10cSrcweir 199*cdf0e10cSrcweir return sCommand; 200*cdf0e10cSrcweir } 201*cdf0e10cSrcweir 202*cdf0e10cSrcweir //----------------------------------------------- 203*cdf0e10cSrcweir void AcceleratorCache::removeKey(const css::awt::KeyEvent& aKey) 204*cdf0e10cSrcweir { 205*cdf0e10cSrcweir // SAFE -> ---------------------------------- 206*cdf0e10cSrcweir WriteGuard aWriteLock(m_aLock); 207*cdf0e10cSrcweir 208*cdf0e10cSrcweir // check if key exists 209*cdf0e10cSrcweir TKey2Commands::const_iterator pKey = m_lKey2Commands.find(aKey); 210*cdf0e10cSrcweir if (pKey == m_lKey2Commands.end()) 211*cdf0e10cSrcweir return; 212*cdf0e10cSrcweir 213*cdf0e10cSrcweir // get its registered command 214*cdf0e10cSrcweir // Because we must know its place inside the optimized 215*cdf0e10cSrcweir // structure, which bind keys to commands, too! 216*cdf0e10cSrcweir ::rtl::OUString sCommand = pKey->second; 217*cdf0e10cSrcweir pKey = m_lKey2Commands.end(); // nobody should use an undefined value .-) 218*cdf0e10cSrcweir 219*cdf0e10cSrcweir // remove key from primary list 220*cdf0e10cSrcweir m_lKey2Commands.erase(aKey); 221*cdf0e10cSrcweir 222*cdf0e10cSrcweir // remove key from optimized command list 223*cdf0e10cSrcweir m_lCommand2Keys.erase(sCommand); 224*cdf0e10cSrcweir 225*cdf0e10cSrcweir aWriteLock.unlock(); 226*cdf0e10cSrcweir // <- SAFE ---------------------------------- 227*cdf0e10cSrcweir } 228*cdf0e10cSrcweir 229*cdf0e10cSrcweir //----------------------------------------------- 230*cdf0e10cSrcweir void AcceleratorCache::removeCommand(const ::rtl::OUString& sCommand) 231*cdf0e10cSrcweir { 232*cdf0e10cSrcweir // SAFE -> ---------------------------------- 233*cdf0e10cSrcweir WriteGuard aWriteLock(m_aLock); 234*cdf0e10cSrcweir 235*cdf0e10cSrcweir const TKeyList& lKeys = getKeysByCommand(sCommand); 236*cdf0e10cSrcweir AcceleratorCache::TKeyList::const_iterator pKey ; 237*cdf0e10cSrcweir for ( pKey = lKeys.begin(); 238*cdf0e10cSrcweir pKey != lKeys.end() ; 239*cdf0e10cSrcweir ++pKey ) 240*cdf0e10cSrcweir { 241*cdf0e10cSrcweir const css::awt::KeyEvent& rKey = *pKey; 242*cdf0e10cSrcweir removeKey(rKey); 243*cdf0e10cSrcweir } 244*cdf0e10cSrcweir m_lCommand2Keys.erase(sCommand); 245*cdf0e10cSrcweir 246*cdf0e10cSrcweir aWriteLock.unlock(); 247*cdf0e10cSrcweir // <- SAFE ---------------------------------- 248*cdf0e10cSrcweir } 249*cdf0e10cSrcweir 250*cdf0e10cSrcweir } // namespace framework 251