1 /****************************************************************************
2 **
3 ** Copyright (C) 2018 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 "qwinrtuiametadatacache.h"
44 #include "qwinrtuiautils.h"
45 
46 #include <QtCore/QLoggingCategory>
47 #include <QtCore/private/qeventdispatcher_winrt_p.h>
48 
49 QT_BEGIN_NAMESPACE
50 
51 using namespace QWinRTUiAutomation;
52 
53 // Private constructor
QWinRTUiaMetadataCache()54 QWinRTUiaMetadataCache::QWinRTUiaMetadataCache()
55 {
56 }
57 
58 // shared instance
instance()59 QWinRTUiaMetadataCache *QWinRTUiaMetadataCache::instance()
60 {
61     static QWinRTUiaMetadataCache metadataCache;
62     return &metadataCache;
63 }
64 
65 // Returns the cached metadata associated with the ID, or an instance with default values.
metadataForId(QAccessible::Id id)66 QSharedPointer<QWinRTUiaControlMetadata> QWinRTUiaMetadataCache::metadataForId(QAccessible::Id id)
67 {
68     QSharedPointer<QWinRTUiaControlMetadata> metadata;
69 
70     m_mutex.lock();
71     if (m_metadataTable.contains(id))
72         metadata = m_metadataTable[id];
73     else
74         metadata = QSharedPointer<QWinRTUiaControlMetadata>(new QWinRTUiaControlMetadata);
75     m_mutex.unlock();
76     return metadata;
77 }
78 
79 // Caches metadata from the accessibility framework within the main thread.
load(QAccessible::Id id)80 bool QWinRTUiaMetadataCache::load(QAccessible::Id id)
81 {
82     qCDebug(lcQpaUiAutomation) << __FUNCTION__;
83 
84     if (!SUCCEEDED(QEventDispatcherWinRT::runOnMainThread([id]() {
85         QWinRTUiaMetadataCache::instance()->insert(id, QSharedPointer<QWinRTUiaControlMetadata>(new QWinRTUiaControlMetadata(id)));
86         return S_OK;
87     }))) {
88         return false;
89     }
90     return true;
91 }
92 
93 // Inserts metadata in the cache and associates it with an accessibility ID.
insert(QAccessible::Id id,const QSharedPointer<QWinRTUiaControlMetadata> & metadata)94 void QWinRTUiaMetadataCache::insert(QAccessible::Id id, const QSharedPointer<QWinRTUiaControlMetadata> &metadata)
95 {
96     m_mutex.lock();
97     m_metadataTable[id] = metadata;
98     m_mutex.unlock();
99 }
100 
101 // Removes metadata with a given id from the cache.
remove(QAccessible::Id id)102 void QWinRTUiaMetadataCache::remove(QAccessible::Id id)
103 {
104     m_mutex.lock();
105     m_metadataTable.remove(id);
106     m_mutex.unlock();
107 }
108 
109 QT_END_NAMESPACE
110 
111 #endif // QT_CONFIG(accessibility)
112 
113