Disable outdated WritableStream API
[WebKit-https.git] / Source / WebCore / page / Performance.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2012 Intel Inc. All rights reserved.
4  * Copyright (C) 2016 Apple Inc. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are
8  * met:
9  *
10  *     * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  *     * Redistributions in binary form must reproduce the above
13  * copyright notice, this list of conditions and the following disclaimer
14  * in the documentation and/or other materials provided with the
15  * distribution.
16  *     * Neither the name of Google Inc. nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32
33 #pragma once
34
35 #if ENABLE(WEB_TIMING)
36
37 #include "ContextDestructionObserver.h"
38 #include "EventTarget.h"
39 #include "ExceptionOr.h"
40 #include "GenericTaskQueue.h"
41 #include <wtf/ListHashSet.h>
42
43 namespace WebCore {
44
45 class LoadTiming;
46 class PerformanceEntry;
47 class PerformanceNavigation;
48 class PerformanceObserver;
49 class PerformanceTiming;
50 class ResourceResponse;
51 class ResourceTiming;
52 class ScriptExecutionContext;
53 class URL;
54 class UserTiming;
55
56 class Performance final : public RefCounted<Performance>, public ContextDestructionObserver, public EventTargetWithInlineData {
57 public:
58     static Ref<Performance> create(ScriptExecutionContext& context, MonotonicTime timeOrigin) { return adoptRef(*new Performance(context, timeOrigin)); }
59     ~Performance();
60
61     double now() const;
62
63     PerformanceNavigation* navigation();
64     PerformanceTiming* timing();
65
66     Vector<RefPtr<PerformanceEntry>> getEntries() const;
67     Vector<RefPtr<PerformanceEntry>> getEntriesByType(const String& entryType) const;
68     Vector<RefPtr<PerformanceEntry>> getEntriesByName(const String& name, const String& entryType) const;
69
70     void clearResourceTimings();
71     void setResourceTimingBufferSize(unsigned);
72
73     ExceptionOr<void> mark(const String& markName);
74     void clearMarks(const String& markName);
75
76     ExceptionOr<void> measure(const String& measureName, const String& startMark, const String& endMark);
77     void clearMeasures(const String& measureName);
78
79     void addResourceTiming(ResourceTiming&&);
80
81     void registerPerformanceObserver(PerformanceObserver&);
82     void unregisterPerformanceObserver(PerformanceObserver&);
83
84     static Seconds reduceTimeResolution(Seconds);
85
86     ScriptExecutionContext* scriptExecutionContext() const final { return ContextDestructionObserver::scriptExecutionContext(); }
87
88     using RefCounted::ref;
89     using RefCounted::deref;
90
91 private:
92     Performance(ScriptExecutionContext&, MonotonicTime timeOrigin);
93
94     void contextDestroyed() override;
95
96     EventTargetInterface eventTargetInterface() const final { return PerformanceEventTargetInterfaceType; }
97
98     void refEventTarget() final { ref(); }
99     void derefEventTarget() final { deref(); }
100
101     bool isResourceTimingBufferFull() const;
102
103     void queueEntry(PerformanceEntry&);
104
105     mutable RefPtr<PerformanceNavigation> m_navigation;
106     mutable RefPtr<PerformanceTiming> m_timing;
107
108     // https://w3c.github.io/resource-timing/#extensions-performance-interface recommends size of 150.
109     Vector<RefPtr<PerformanceEntry>> m_resourceTimingBuffer;
110     unsigned m_resourceTimingBufferSize { 150 };
111
112     MonotonicTime m_timeOrigin;
113
114     std::unique_ptr<UserTiming> m_userTiming;
115
116     GenericTaskQueue<ScriptExecutionContext> m_performanceTimelineTaskQueue;
117     ListHashSet<RefPtr<PerformanceObserver>> m_observers;
118 };
119
120 }
121
122 #endif // ENABLE(WEB_TIMING)