Flaky IntersectionObserver web platform tests involving style updates
[WebKit-https.git] / Source / JavaScriptCore / assembler / Printer.h
1 /*
2  * Copyright (C) 2017 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/PrintStream.h>
29 #include <wtf/StringPrintStream.h>
30 #include <wtf/Vector.h>
31
32 namespace JSC {
33
34 namespace Probe {
35 class Context;
36 } // namespace Probe
37
38 namespace Printer {
39
40 struct Context;
41
42 union Data {
43     Data()
44     {
45         const intptr_t uninitialized = 0xdeadb0d0;
46         memcpy(&buffer, &uninitialized, sizeof(uninitialized));
47     }
48     Data(uintptr_t value)
49         : Data(&value, sizeof(value))
50     { }
51     Data(const void* pointer)
52         : Data(&pointer, sizeof(pointer))
53     { }
54     Data(void* src, size_t size)
55     {
56         RELEASE_ASSERT(size <= sizeof(buffer));
57         memcpy(&buffer, src, size);
58     }
59
60     template<typename T, typename = typename std::enable_if<std::is_integral<T>::value>::type>
61     T as() const
62     {
63         return static_cast<T>(value);
64     }
65
66     template<typename T, typename = typename std::enable_if<std::is_pointer<T>::value>::type>
67     const T as(int = 0) const
68     {
69         return reinterpret_cast<const T>(pointer);
70     }
71
72     template<typename T, typename = typename std::enable_if<!std::is_integral<T>::value && !std::is_pointer<T>::value>::type>
73     const T& as() const
74     {
75         static_assert(sizeof(T) <= sizeof(buffer), "size is not sane");
76         return *reinterpret_cast<const T*>(&buffer);
77     }
78
79     uintptr_t value;
80     const void* pointer;
81 #if USE(JSVALUE64)
82     UCPURegister buffer[4];
83 #elif USE(JSVALUE32_64)
84     UCPURegister buffer[6];
85 #endif
86 };
87
88 struct Context {
89     Context(Probe::Context& probeContext, Data& data)
90         : probeContext(probeContext)
91         , data(data)
92     { }
93
94     Probe::Context& probeContext;
95     Data& data;
96 };
97
98 typedef void (*Callback)(PrintStream&, Context&);
99
100 struct PrintRecord {
101     PrintRecord(Data data, Callback printer)
102         : data(data)
103         , printer(printer)
104     { }
105
106     PrintRecord(Callback printer)
107         : printer(printer)
108     { }
109
110     template<template<class> class Printer, typename T>
111     PrintRecord(const Printer<T>& other)
112     {
113         static_assert(std::is_base_of<PrintRecord, Printer<T>>::value, "Printer should extend PrintRecord");
114         static_assert(sizeof(PrintRecord) == sizeof(Printer<T>), "Printer should be the same size as PrintRecord");
115         data = other.data;
116         printer = other.printer;
117     }
118
119     Data data;
120     Callback printer;
121
122 protected:
123     PrintRecord() { }
124 };
125
126 template<typename T> struct Printer;
127
128 typedef Vector<PrintRecord> PrintRecordList;
129
130 inline void appendPrinter(PrintRecordList&) { }
131
132 template<typename First, typename... Arguments>
133 inline void appendPrinter(PrintRecordList& printRecordList, First first, Arguments&&... others)
134 {
135     printRecordList.append(Printer<First>(first));
136     appendPrinter(printRecordList, std::forward<Arguments>(others)...);
137 }
138
139 template<typename... Arguments>
140 inline PrintRecordList* makePrintRecordList(Arguments&&... arguments)
141 {
142     // FIXME: the current implementation intentionally leaks the PrintRecordList.
143     // We may want to fix this in the future if we want to use the print mechanism
144     // in tests that may compile a lot of prints.
145     // https://bugs.webkit.org/show_bug.cgi?id=171123
146     auto printRecordList = new PrintRecordList();
147     appendPrinter(*printRecordList, std::forward<Arguments>(arguments)...);
148     return printRecordList;
149 }
150
151 // Some utility functions for specializing printers.
152
153 void printConstCharString(PrintStream&, Context&);
154 void printIntptr(PrintStream&, Context&);
155 void printUintptr(PrintStream&, Context&);
156 void printPointer(PrintStream&, Context&);
157
158 void setPrinter(PrintRecord&, CString&&);
159
160 // Specialized printers.
161
162 template<>
163 struct Printer<const char*> : public PrintRecord {
164     Printer(const char* str)
165         : PrintRecord(str, printConstCharString)
166     { }
167 };
168
169 template<>
170 struct Printer<char*> : public Printer<const char*> {
171     Printer(char* str)
172         : Printer<const char*>(str)
173     { }
174 };
175
176 template<>
177 struct Printer<RawPointer> : public PrintRecord {
178     Printer(RawPointer rawPointer)
179         : PrintRecord(rawPointer.value(), printPointer)
180     { }
181 };
182
183 template<typename T, typename = typename std::enable_if_t<std::is_integral<T>::value && std::numeric_limits<T>::is_signed>>
184 void setPrinter(PrintRecord& record, T value, intptr_t = 0)
185 {
186     record.data.value = static_cast<uintptr_t>(value);
187     record.printer = printIntptr;
188 }
189
190 template<typename T, typename = typename std::enable_if_t<std::is_integral<T>::value && !std::numeric_limits<T>::is_signed>>
191 void setPrinter(PrintRecord& record, T value, uintptr_t = 0)
192 {
193     record.data.value = static_cast<uintptr_t>(value);
194     record.printer = printUintptr;
195 }
196
197 template<typename T>
198 struct Printer : public PrintRecord {
199     Printer(T value)
200     {
201         setPrinter(*this, value);
202     }
203 };
204
205 } // namespace Printer
206
207 } // namespace JSC