Add an assertion to diagnose stress GC bots test failures
[WebKit-https.git] / Source / WebCore / dom / CustomElementReactionQueue.h
1 /*
2  * Copyright (C) 2015, 2016 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 #include <wtf/Forward.h>
29 #include <wtf/Noncopyable.h>
30 #include <wtf/Vector.h>
31
32 namespace WebCore {
33
34 class CustomElementReactionQueueItem;
35 class Document;
36 class Element;
37 class JSCustomElementInterface;
38 class QualifiedName;
39
40 class CustomElementReactionQueue {
41     WTF_MAKE_NONCOPYABLE(CustomElementReactionQueue);
42 public:
43     CustomElementReactionQueue(JSCustomElementInterface&);
44     ~CustomElementReactionQueue();
45
46     static void enqueueElementUpgrade(Element&);
47     static void enqueueElementUpgradeIfDefined(Element&);
48     static void enqueueConnectedCallbackIfNeeded(Element&);
49     static void enqueueDisconnectedCallbackIfNeeded(Element&);
50     static void enqueueAdoptedCallbackIfNeeded(Element&, Document& oldDocument, Document& newDocument);
51     static void enqueueAttributeChangedCallbackIfNeeded(Element&, const QualifiedName&, const AtomicString& oldValue, const AtomicString& newValue);
52     static void enqueuePostUpgradeReactions(Element&);
53
54     bool observesStyleAttribute() const;
55     void invokeAll(Element&);
56     void clear();
57
58 private:
59     Ref<JSCustomElementInterface> m_interface;
60     Vector<CustomElementReactionQueueItem> m_items;
61 };
62
63 class CustomElementReactionStack {
64 public:
65     CustomElementReactionStack()
66         : m_previousProcessingStack(s_currentProcessingStack)
67     {
68         s_currentProcessingStack = this;
69     }
70
71     ~CustomElementReactionStack()
72     {
73         if (UNLIKELY(m_queue))
74             processQueue();
75         s_currentProcessingStack = m_previousProcessingStack;
76     }
77
78     static CustomElementReactionQueue& ensureCurrentQueue(Element&);
79
80     static bool hasCurrentProcessingStack() { return s_currentProcessingStack; }
81
82     static void processBackupQueue();
83
84 private:
85     class ElementQueue {
86     public:
87         void add(Element&);
88         void invokeAll();
89
90     private:
91         Vector<Ref<Element>> m_elements;
92 #if !ASSERT_DISABLED
93         bool m_invoking { false };
94 #endif
95     };
96
97     WEBCORE_EXPORT void processQueue();
98
99     static ElementQueue& ensureBackupQueue();
100     static ElementQueue& backupElementQueue();
101
102     ElementQueue* m_queue { nullptr };
103     CustomElementReactionStack* m_previousProcessingStack;
104
105     WEBCORE_EXPORT static CustomElementReactionStack* s_currentProcessingStack;
106 };
107
108 }