6eec26451984f8eba8884f59c5337ce526cd9a4e
[WebKit-https.git] / Source / WebCore / accessibility / isolatedtree / AXIsolatedTree.h
1 /*
2  * Copyright (C) 2019 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(ACCESSIBILITY_ISOLATED_TREE)
29
30 #include "AXIsolatedTreeNode.h"
31 #include "PageIdentifier.h"
32 #include <wtf/HashMap.h>
33 #include <wtf/RefPtr.h>
34 #include <wtf/ThreadSafeRefCounted.h>
35
36 namespace WebCore {
37
38 class Page;
39
40 class AXIsolatedTree : public ThreadSafeRefCounted<AXIsolatedTree>, public CanMakeWeakPtr<AXIsolatedTree> {
41     WTF_MAKE_NONCOPYABLE(AXIsolatedTree); WTF_MAKE_FAST_ALLOCATED;
42
43 public:
44     static Ref<AXIsolatedTree> create();
45     virtual ~AXIsolatedTree();
46
47     static Ref<AXIsolatedTree> createTreeForPageID(PageIdentifier);
48     WEBCORE_EXPORT static Ref<AXIsolatedTree> initializePageTreeForID(PageIdentifier, AXObjectCache&);
49     WEBCORE_EXPORT static RefPtr<AXIsolatedTree> treeForPageID(PageIdentifier);
50     WEBCORE_EXPORT static RefPtr<AXIsolatedTree> treeForID(AXIsolatedTreeID);
51
52     WEBCORE_EXPORT RefPtr<AXIsolatedTreeNode> rootNode();
53     WEBCORE_EXPORT RefPtr<AXIsolatedTreeNode> focusedUIElement();
54     RefPtr<AXIsolatedTreeNode> nodeForID(AXID) const;
55     static RefPtr<AXIsolatedTreeNode> nodeInTreeForID(AXIsolatedTreeID, AXID);
56
57     // Call on main thread
58     void appendNodeChanges(Vector<Ref<AXIsolatedTreeNode>>&);
59     void removeNode(AXID);
60
61     void setRootNodeID(AXID);
62     void setFocusedNodeID(AXID);
63     
64     // Call on AX thread
65     WEBCORE_EXPORT void applyPendingChanges();
66
67     WEBCORE_EXPORT void setInitialRequestInProgress(bool);
68     AXIsolatedTreeID treeIdentifier() const { return m_treeID; }
69
70 private:
71     AXIsolatedTree();
72
73     static HashMap<AXIsolatedTreeID, Ref<AXIsolatedTree>>& treeIDCache();
74     static HashMap<PageIdentifier, Ref<AXIsolatedTree>>& treePageCache();
75
76     // Only access on AX thread requesting data.
77     HashMap<AXID, Ref<AXIsolatedTreeNode>> m_readerThreadNodeMap;
78
79     // Written to by main thread under lock, accessed and applied by AX thread.
80     Vector<Ref<AXIsolatedTreeNode>> m_pendingAppends;
81     Vector<AXID> m_pendingRemovals;
82     AXID m_pendingFocusedNodeID;
83     AXID m_pendingRootNodeID;
84     Lock m_changeLogLock;
85
86     AXIsolatedTreeID m_treeID;
87     AXID m_rootNodeID { InvalidAXID };
88     AXID m_focusedNodeID { InvalidAXID };
89     bool m_initialRequestInProgress;
90 };
91
92 } // namespace WebCore
93
94 #endif