7ea1b65817e3b20498940d39c45a756f57ccb720
[WebKit-https.git] / Source / WebCore / Modules / webgpu / WHLSL / WHLSLASTDumper.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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #if ENABLE(WEBGPU)
29
30 #include "WHLSLVisitor.h"
31
32 #include <wtf/DataLog.h>
33 #include <wtf/SetForScope.h>
34 #include <wtf/StringPrintStream.h>
35
36 namespace WebCore {
37
38 namespace WHLSL {
39
40 class ASTDumper : Visitor {
41     using Base = Visitor;
42 public:
43     void visit(Program&) override;
44
45     String toString() { return m_out.toString(); }
46
47 private:
48     void visit(AST::UnnamedType&) override;
49     void visit(AST::NamedType&) override;
50     void visit(AST::TypeDefinition&) override;
51     void visit(AST::StructureDefinition&) override;
52     void visit(AST::EnumerationDefinition&) override;
53     void visit(AST::FunctionDefinition&) override;
54     void visit(AST::NativeFunctionDeclaration&) override;
55     void visit(AST::NativeTypeDeclaration&) override;
56     void visit(AST::TypeReference&) override;
57     void visit(AST::PointerType&) override;
58     void visit(AST::ArrayReferenceType&) override;
59     void visit(AST::ArrayType&) override;
60     void visit(AST::StructureElement&) override;
61     void visit(AST::EnumerationMember&) override;
62     void visit(AST::FunctionDeclaration&) override;
63     void visit(AST::TypeArgument&) override;
64     void visit(AST::ReferenceType&) override;
65     void visit(AST::Semantic&) override;
66     void visit(AST::ConstantExpression&) override;
67     void visit(AST::AttributeBlock&) override;
68     void visit(AST::BuiltInSemantic&) override;
69     void visit(AST::ResourceSemantic&) override;
70     void visit(AST::SpecializationConstantSemantic&) override;
71     void visit(AST::StageInOutSemantic&) override;
72     void visit(AST::IntegerLiteral&) override;
73     void visit(AST::UnsignedIntegerLiteral&) override;
74     void visit(AST::FloatLiteral&) override;
75     void visit(AST::NullLiteral&) override;
76     void visit(AST::BooleanLiteral&) override;
77     void visit(AST::IntegerLiteralType&) override;
78     void visit(AST::UnsignedIntegerLiteralType&) override;
79     void visit(AST::FloatLiteralType&) override;
80     void visit(AST::NullLiteralType&) override;
81     void visit(AST::EnumerationMemberLiteral&) override;
82     void visit(AST::FunctionAttribute&) override;
83     void visit(AST::NumThreadsFunctionAttribute&) override;
84     void visit(AST::Block&) override;
85     void visit(AST::Statement&) override;
86     void visit(AST::Break&) override;
87     void visit(AST::Continue&) override;
88     void visit(AST::DoWhileLoop&) override;
89     void visit(AST::Expression&) override;
90     void visit(AST::DotExpression&) override;
91     void visit(AST::IndexExpression&) override;
92     void visit(AST::PropertyAccessExpression&) override;
93     void visit(AST::EffectfulExpressionStatement&) override;
94     void visit(AST::Fallthrough&) override;
95     void visit(AST::ForLoop&) override;
96     void visit(AST::IfStatement&) override;
97     void visit(AST::Return&) override;
98     void visit(AST::SwitchCase&) override;
99     void visit(AST::SwitchStatement&) override;
100     void visit(AST::Trap&) override;
101     void visit(AST::VariableDeclarationsStatement&) override;
102     void visit(AST::WhileLoop&) override;
103     void visit(AST::VariableDeclaration&) override;
104     void visit(AST::AssignmentExpression&) override;
105     void visit(AST::CallExpression&) override;
106     void visit(AST::CommaExpression&) override;
107     void visit(AST::DereferenceExpression&) override;
108     void visit(AST::LogicalExpression&) override;
109     void visit(AST::LogicalNotExpression&) override;
110     void visit(AST::MakeArrayReferenceExpression&) override;
111     void visit(AST::MakePointerExpression&) override;
112     void visit(AST::ReadModifyWriteExpression&) override;
113     void visit(AST::TernaryExpression&) override;
114     void visit(AST::VariableReference&) override;
115
116     struct Indent {
117         Indent(ASTDumper& dumper)
118             : m_scope(dumper.m_indent, dumper.m_indent + "   ")
119         { }
120         SetForScope<String> m_scope;
121     };
122
123     Indent bumpIndent() { return Indent(*this); }
124
125     friend struct Indent;
126
127     StringPrintStream m_out;
128     String m_indent;
129 };
130
131 static ALWAYS_INLINE String toString(Program& program)
132 {
133     ASTDumper dumper;
134     dumper.visit(program);
135     return dumper.toString();
136 }
137
138 static ALWAYS_INLINE void dumpAST(Program& program)
139 {
140     dataLogLn(toString(program));
141 }
142
143 } // namespace WHLSL
144
145 } // namespace WebCore
146
147 #endif // ENABLE(WEBGPU)