summaryrefslogtreecommitdiffstats
path: root/src/plugins/platforms/winrt/uiautomation/qwinrtuiametadatacache.cpp
blob: 442ff184a8a31ca362262ea138a509362736d8ed (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the plugins of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include <QtGui/qtguiglobal.h>
#if QT_CONFIG(accessibility)

#include "qwinrtuiametadatacache.h"
#include "qwinrtuiautils.h"

#include <QtCore/QLoggingCategory>
#include <QtCore/private/qeventdispatcher_winrt_p.h>

QT_BEGIN_NAMESPACE

using namespace QWinRTUiAutomation;

// Private constructor
QWinRTUiaMetadataCache::QWinRTUiaMetadataCache()
{
}

// shared instance
QWinRTUiaMetadataCache *QWinRTUiaMetadataCache::instance()
{
    static QWinRTUiaMetadataCache metadataCache;
    return &metadataCache;
}

// Returns the cached metadata associated with the ID, or an instance with default values.
QSharedPointer<QWinRTUiaControlMetadata> QWinRTUiaMetadataCache::metadataForId(QAccessible::Id id)
{
    QSharedPointer<QWinRTUiaControlMetadata> metadata;

    m_mutex.lock();
    if (m_metadataTable.contains(id))
        metadata = m_metadataTable[id];
    else
        metadata = QSharedPointer<QWinRTUiaControlMetadata>(new QWinRTUiaControlMetadata);
    m_mutex.unlock();
    return metadata;
}

// Caches metadata from the accessibility framework within the main thread.
bool QWinRTUiaMetadataCache::load(QAccessible::Id id)
{
    qCDebug(lcQpaUiAutomation) << __FUNCTION__;

    if (!SUCCEEDED(QEventDispatcherWinRT::runOnMainThread([id]() {
        QWinRTUiaMetadataCache::instance()->insert(id, QSharedPointer<QWinRTUiaControlMetadata>(new QWinRTUiaControlMetadata(id)));
        return S_OK;
    }))) {
        return false;
    }
    return true;
}

// Inserts metadata in the cache and associates it with an accessibility ID.
void QWinRTUiaMetadataCache::insert(QAccessible::Id id, const QSharedPointer<QWinRTUiaControlMetadata> &metadata)
{
    m_mutex.lock();
    m_metadataTable[id] = metadata;
    m_mutex.unlock();
}

// Removes metadata with a given id from the cache.
void QWinRTUiaMetadataCache::remove(QAccessible::Id id)
{
    m_mutex.lock();
    m_metadataTable.remove(id);
    m_mutex.unlock();
}

QT_END_NAMESPACE

#endif // QT_CONFIG(accessibility)