1 /****************************************************************************
2 **
3 ** Copyright (C) 2017 The Qt Company Ltd.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the plugins of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see https://www.qt.io/terms-conditions. For further
15 ** information use the contact form at https://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #include <QtGui/qtguiglobal.h>
41 #if QT_CONFIG(accessibility)
42 
43 #include "qwindowsuiaprovidercache.h"
44 #include "qwindowsuiautils.h"
45 #include "qwindowscontext.h"
46 
47 QT_BEGIN_NAMESPACE
48 
49 using namespace QWindowsUiAutomation;
50 
51 
52 // Private constructor
QWindowsUiaProviderCache()53 QWindowsUiaProviderCache::QWindowsUiaProviderCache()
54 {
55 }
56 
57 // shared instance
instance()58 QWindowsUiaProviderCache *QWindowsUiaProviderCache::instance()
59 {
60     static QWindowsUiaProviderCache providerCache;
61     return &providerCache;
62 }
63 
64 // Returns the provider instance associated with the ID, or nullptr.
providerForId(QAccessible::Id id) const65 QWindowsUiaBaseProvider *QWindowsUiaProviderCache::providerForId(QAccessible::Id id) const
66 {
67     return m_providerTable.value(id);
68 }
69 
70 // Inserts a provider in the cache and associates it with an accessibility ID.
insert(QAccessible::Id id,QWindowsUiaBaseProvider * provider)71 void QWindowsUiaProviderCache::insert(QAccessible::Id id, QWindowsUiaBaseProvider *provider)
72 {
73     remove(id);
74     if (provider) {
75         m_providerTable[id] = provider;
76         m_inverseTable[provider] = id;
77         // Connects the destroyed signal to our slot, to remove deleted objects from the cache.
78         QObject::connect(provider, &QObject::destroyed, this, &QWindowsUiaProviderCache::objectDestroyed);
79     }
80 }
81 
82 // Removes deleted provider objects from the cache.
objectDestroyed(QObject * obj)83 void QWindowsUiaProviderCache::objectDestroyed(QObject *obj)
84 {
85     // We have to use the inverse table to map the object address back to its ID,
86     // since at this point (called from QObject destructor), it has already been
87     // partially destroyed and we cannot treat it as a provider.
88     auto it = m_inverseTable.find(obj);
89     if (it != m_inverseTable.end()) {
90         m_providerTable.remove(*it);
91         m_inverseTable.remove(obj);
92     }
93 }
94 
95 // Removes a provider with a given id from the cache.
remove(QAccessible::Id id)96 void QWindowsUiaProviderCache::remove(QAccessible::Id id)
97 {
98     m_inverseTable.remove(m_providerTable.value(id));
99     m_providerTable.remove(id);
100 }
101 
102 QT_END_NAMESPACE
103 
104 #endif // QT_CONFIG(accessibility)
105