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 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158
|
/*
* Copyright (C) 2021 Igalia S.L.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#pragma once
#if USE(ATSPI)
#include <wtf/CompletionHandler.h>
#include <wtf/FastMalloc.h>
#include <wtf/HashMap.h>
#include <wtf/ListHashSet.h>
#include <wtf/RunLoop.h>
#include <wtf/Vector.h>
#include <wtf/glib/GRefPtr.h>
#include <wtf/glib/GUniquePtr.h>
typedef struct _GDBusConnection GDBusConnection;
typedef struct _GDBusInterfaceInfo GDBusInterfaceInfo;
typedef struct _GDBusInterfaceVTable GDBusInterfaceVTable;
typedef struct _GDBusProxy GDBusProxy;
typedef struct _GVariant GVariant;
namespace WebCore {
class AccessibilityObjectAtspi;
class AccessibilityRootAtspi;
enum class AccessibilityRole : uint8_t;
DECLARE_ALLOCATOR_WITH_HEAP_IDENTIFIER(AccessibilityAtspi);
class AccessibilityAtspi {
WTF_MAKE_FAST_ALLOCATED_WITH_HEAP_IDENTIFIER(AccessibilityAtspi);
WTF_MAKE_NONCOPYABLE(AccessibilityAtspi);
friend NeverDestroyed<AccessibilityAtspi>;
public:
WEBCORE_EXPORT static AccessibilityAtspi& singleton();
// Do nothing since this is a singleton.
void ref() const { }
void deref() const { }
void connect(const String&, const String&);
const char* uniqueName() const;
GVariant* nullReference() const;
GVariant* applicationReference() const;
bool hasClients() const { return !m_clients.isEmpty(); }
void registerRoot(AccessibilityRootAtspi&, Vector<std::pair<GDBusInterfaceInfo*, GDBusInterfaceVTable*>>&&, CompletionHandler<void(const String&)>&&);
void unregisterRoot(AccessibilityRootAtspi&);
String registerObject(AccessibilityObjectAtspi&, Vector<std::pair<GDBusInterfaceInfo*, GDBusInterfaceVTable*>>&&);
void unregisterObject(AccessibilityObjectAtspi&);
String registerHyperlink(AccessibilityObjectAtspi&, Vector<std::pair<GDBusInterfaceInfo*, GDBusInterfaceVTable*>>&&);
void parentChanged(AccessibilityObjectAtspi&);
void parentChanged(AccessibilityRootAtspi&);
enum class ChildrenChanged { Added, Removed };
void childrenChanged(AccessibilityObjectAtspi&, AccessibilityObjectAtspi&, ChildrenChanged);
void childrenChanged(AccessibilityRootAtspi&, AccessibilityObjectAtspi&, ChildrenChanged);
void stateChanged(AccessibilityObjectAtspi&, const char*, bool);
void textChanged(AccessibilityObjectAtspi&, const char*, CString&&, unsigned, unsigned);
void textAttributesChanged(AccessibilityObjectAtspi&);
void textCaretMoved(AccessibilityObjectAtspi&, unsigned);
void textSelectionChanged(AccessibilityObjectAtspi&);
void valueChanged(AccessibilityObjectAtspi&, double);
void activeDescendantChanged(AccessibilityObjectAtspi&);
void selectionChanged(AccessibilityObjectAtspi&);
void loadEvent(AccessibilityObjectAtspi&, CString&&);
static const char* localizedRoleName(AccessibilityRole);
#if ENABLE(DEVELOPER_MODE)
using NotificationObserverParameter = std::variant<std::nullptr_t, String, bool, unsigned, Ref<AccessibilityObjectAtspi>>;
using NotificationObserver = Function<void(AccessibilityObjectAtspi&, const char*, NotificationObserverParameter)>;
WEBCORE_EXPORT void addNotificationObserver(void*, NotificationObserver&&);
WEBCORE_EXPORT void removeNotificationObserver(void*);
#endif
private:
AccessibilityAtspi();
struct PendingRootRegistration {
Ref<AccessibilityRootAtspi> root;
Vector<std::pair<GDBusInterfaceInfo*, GDBusInterfaceVTable*>> interfaces;
CompletionHandler<void(const String&)> completionHandler;
};
void didConnect(GRefPtr<GDBusConnection>&&);
void didOwnName();
void initializeRegistry();
void addEventListener(const char* dbusName, const char* eventName);
void removeEventListener(const char* dbusName, const char* eventName);
void addClient(const char* dbusName);
void removeClient(const char* dbusName);
void ensureCache();
void addToCacheIfNeeded(AccessibilityObjectAtspi&);
void cacheUpdateTimerFired();
void cacheClearTimerFired();
bool shouldEmitSignal(const char* interface, const char* name, const char* detail = "");
#if ENABLE(DEVELOPER_MODE)
void notify(AccessibilityObjectAtspi&, const char*, NotificationObserverParameter) const;
void notifyActiveDescendantChanged(AccessibilityObjectAtspi&) const;
void notifyStateChanged(AccessibilityObjectAtspi&, const char*, bool) const;
void notifySelectionChanged(AccessibilityObjectAtspi&) const;
void notifyMenuSelectionChanged(AccessibilityObjectAtspi&) const;
void notifyTextChanged(AccessibilityObjectAtspi&) const;
void notifyTextCaretMoved(AccessibilityObjectAtspi&, unsigned) const;
void notifyValueChanged(AccessibilityObjectAtspi&) const;
void notifyLoadEvent(AccessibilityObjectAtspi&, const CString&) const;
#endif
static GDBusInterfaceVTable s_cacheFunctions;
String m_busName;
bool m_isConnecting { false };
GRefPtr<GDBusConnection> m_connection;
GRefPtr<GDBusProxy> m_registry;
Vector<PendingRootRegistration> m_pendingRootRegistrations;
UncheckedKeyHashMap<CString, Vector<GUniquePtr<char*>>> m_eventListeners;
UncheckedKeyHashMap<AccessibilityRootAtspi*, Vector<unsigned, 3>> m_rootObjects;
UncheckedKeyHashMap<AccessibilityObjectAtspi*, Vector<unsigned, 7>> m_atspiObjects;
UncheckedKeyHashMap<AccessibilityObjectAtspi*, Vector<unsigned, 1>> m_atspiHyperlinks;
UncheckedKeyHashMap<CString, unsigned> m_clients;
unsigned m_cacheID { 0 };
UncheckedKeyHashMap<String, AccessibilityObjectAtspi*> m_cache;
ListHashSet<RefPtr<AccessibilityObjectAtspi>> m_cacheUpdateList;
RunLoop::Timer m_cacheUpdateTimer;
RunLoop::Timer m_cacheClearTimer;
#if ENABLE(DEVELOPER_MODE)
UncheckedKeyHashMap<void*, NotificationObserver> m_notificationObservers;
#endif
};
} // namespace WebCore
#endif // USE(ATSPI)
|