Improve use of NeverDestroyed
[WebKit-https.git] / Source / WebCore / dom / Microtasks.h
1 /*
2  * Copyright (C) 2014 Yoav Weiss (yoav@yoav.ws)
3  * Copyright (C) 2015 Akamai Technologies Inc. All rights reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  *
20  */
21
22 #pragma once
23
24 #include "Timer.h"
25 #include <wtf/Forward.h>
26 #include <wtf/Vector.h>
27
28 namespace WebCore {
29
30 class MicrotaskQueue;
31
32 class Microtask {
33 public:
34     virtual ~Microtask()
35     {
36     }
37
38     enum class Result {
39         Done,
40         KeepInQueue
41     };
42
43     virtual Result run() = 0;
44
45 protected:
46     void removeSelfFromQueue(MicrotaskQueue&);
47 };
48
49 class MicrotaskQueue {
50     friend NeverDestroyed<MicrotaskQueue>;
51     friend class Microtask;
52 public:
53     WEBCORE_EXPORT static MicrotaskQueue& mainThreadQueue();
54
55     WEBCORE_EXPORT MicrotaskQueue();
56     WEBCORE_EXPORT ~MicrotaskQueue();
57
58     WEBCORE_EXPORT void append(std::unique_ptr<Microtask>&&);
59     WEBCORE_EXPORT void performMicrotaskCheckpoint();
60
61 private:
62     WEBCORE_EXPORT void remove(const Microtask&);
63
64     void timerFired();
65
66     bool m_performingMicrotaskCheckpoint = false;
67     Vector<std::unique_ptr<Microtask>> m_microtaskQueue;
68
69     // FIXME: Instead of a Timer, we should have a centralized Event Loop that calls performMicrotaskCheckpoint()
70     // on every iteration, implementing https://html.spec.whatwg.org/multipage/webappapis.html#processing-model-9
71     Timer m_timer;
72 };
73
74 } // namespace WebCore