Skip to content
Permalink
Browse files
[WebGPU] Make Parser class declaration visible to unit tests for testing
https://bugs.webkit.org/show_bug.cgi?id=241738

Patch by Kiet Ho <tho22@apple.com> on 2022-06-21
Reviewed by Myles C. Maxfield.

The existing parser interface (WGSL::parseLChar() and WGSL::parseUChar())
only accepts entirely valid shader module, which makes it difficult to
write unit tests targeting individual aspects of the parser (for example,
only testing the type declaration or unary expression parsing logic). This
commit moves the Parser class declaration from the .cpp file to a private
header file (ParserPrivate.h), and makes private methods that parse
individual grammar rules public. This gives unit tests access to those
methods to test them.

* Source/WebGPU/WGSL/Parser.cpp:
(WGSL::Parser::Parser): Deleted.
(WGSL::Parser::current): Deleted.
* Source/WebGPU/WGSL/ParserPrivate.h: Added.
(WGSL::Parser::Parser):
(WGSL::Parser::current):
* Source/WebGPU/WebGPU.xcodeproj/project.pbxproj:

Canonical link: https://commits.webkit.org/251717@main
git-svn-id: https://svn.webkit.org/repository/webkit/trunk@295712 268f45cc-cd09-0410-ab3c-d52691b4dbfc
  • Loading branch information
tuankiet65 authored and webkit-commit-queue committed Jun 22, 2022
1 parent 7d2f81b commit a62eb94e7f7a45e31b524e40a0e65edaa8c641f5
Showing 3 changed files with 92 additions and 52 deletions.
@@ -24,6 +24,8 @@
*/

#include "Parser.h"
#include "ParserPrivate.h"

#include "config.h"

#include "AST/Attribute.h"
@@ -107,58 +109,6 @@ namespace WGSL {
} \
} while (false)

template<typename Lexer>
class Parser {
public:
Parser(Lexer& lexer)
: m_lexer(lexer)
, m_current(lexer.lex())
{
}

Expected<AST::ShaderModule, Error> parseShader();

private:
// UniqueRef whenever it can return multiple types.
Expected<UniqueRef<AST::GlobalDecl>, Error> parseGlobalDecl();
Expected<AST::Attributes, Error> parseAttributes();
Expected<UniqueRef<AST::Attribute>, Error> parseAttribute();
Expected<AST::StructDecl, Error> parseStructDecl(AST::Attributes&&);
Expected<AST::StructMember, Error> parseStructMember();
Expected<UniqueRef<AST::TypeDecl>, Error> parseTypeDecl();
Expected<UniqueRef<AST::TypeDecl>, Error> parseTypeDeclAfterIdentifier(StringView&&, SourcePosition start);
Expected<AST::GlobalVariableDecl, Error> parseGlobalVariableDecl(AST::Attributes&&);
Expected<AST::VariableQualifier, Error> parseVariableQualifier();
Expected<AST::StorageClass, Error> parseStorageClass();
Expected<AST::AccessMode, Error> parseAccessMode();
Expected<AST::FunctionDecl, Error> parseFunctionDecl(AST::Attributes&&);
Expected<AST::Parameter, Error> parseParameter();
Expected<UniqueRef<AST::Statement>, Error> parseStatement();
Expected<AST::CompoundStatement, Error> parseCompoundStatement();
Expected<AST::ReturnStatement, Error> parseReturnStatement();
Expected<UniqueRef<AST::Expression>, Error> parseShortCircuitOrExpression();
Expected<UniqueRef<AST::Expression>, Error> parseRelationalExpression();
Expected<UniqueRef<AST::Expression>, Error> parseShiftExpression();
Expected<UniqueRef<AST::Expression>, Error> parseAdditiveExpression();
Expected<UniqueRef<AST::Expression>, Error> parseMultiplicativeExpression();
Expected<UniqueRef<AST::Expression>, Error> parseUnaryExpression();
Expected<UniqueRef<AST::Expression>, Error> parseSingularExpression();
Expected<UniqueRef<AST::Expression>, Error> parsePostfixExpression(UniqueRef<AST::Expression>&& base, SourcePosition startPosition);
Expected<UniqueRef<AST::Expression>, Error> parsePrimaryExpression();
Expected<UniqueRef<AST::Expression>, Error> parseExpression();
Expected<UniqueRef<AST::Expression>, Error> parseLHSExpression();
Expected<UniqueRef<AST::Expression>, Error> parseCoreLHSExpression();
Expected<Vector<UniqueRef<AST::Expression>>, Error> parseArgumentExpressionList();

Expected<Token, TokenType> consumeType(TokenType);
void consume();

Token& current() { return m_current; }

Lexer& m_lexer;
Token m_current;
};

template<typename Lexer>
Expected<AST::ShaderModule, Error> parse(const String& wgsl)
{
@@ -0,0 +1,86 @@
/*
* Copyright (C) 2022 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/

#pragma once

#include "AST/ShaderModule.h"
#include "AST/Statements/ReturnStatement.h"
#include "Lexer.h"

namespace WGSL {

template<typename Lexer>
class Parser {
public:
Parser(Lexer& lexer)
: m_lexer(lexer)
, m_current(lexer.lex())
{
}

Expected<AST::ShaderModule, Error> parseShader();

// UniqueRef whenever it can return multiple types.
Expected<UniqueRef<AST::GlobalDecl>, Error> parseGlobalDecl();
Expected<AST::Attributes, Error> parseAttributes();
Expected<UniqueRef<AST::Attribute>, Error> parseAttribute();
Expected<AST::StructDecl, Error> parseStructDecl(AST::Attributes&&);
Expected<AST::StructMember, Error> parseStructMember();
Expected<UniqueRef<AST::TypeDecl>, Error> parseTypeDecl();
Expected<UniqueRef<AST::TypeDecl>, Error> parseTypeDeclAfterIdentifier(StringView&&, SourcePosition start);
Expected<AST::GlobalVariableDecl, Error> parseGlobalVariableDecl(AST::Attributes&&);
Expected<AST::VariableQualifier, Error> parseVariableQualifier();
Expected<AST::StorageClass, Error> parseStorageClass();
Expected<AST::AccessMode, Error> parseAccessMode();
Expected<AST::FunctionDecl, Error> parseFunctionDecl(AST::Attributes&&);
Expected<AST::Parameter, Error> parseParameter();
Expected<UniqueRef<AST::Statement>, Error> parseStatement();
Expected<AST::CompoundStatement, Error> parseCompoundStatement();
Expected<AST::ReturnStatement, Error> parseReturnStatement();
Expected<UniqueRef<AST::Expression>, Error> parseShortCircuitOrExpression();
Expected<UniqueRef<AST::Expression>, Error> parseRelationalExpression();
Expected<UniqueRef<AST::Expression>, Error> parseShiftExpression();
Expected<UniqueRef<AST::Expression>, Error> parseAdditiveExpression();
Expected<UniqueRef<AST::Expression>, Error> parseMultiplicativeExpression();
Expected<UniqueRef<AST::Expression>, Error> parseUnaryExpression();
Expected<UniqueRef<AST::Expression>, Error> parseSingularExpression();
Expected<UniqueRef<AST::Expression>, Error> parsePostfixExpression(UniqueRef<AST::Expression>&& base, SourcePosition startPosition);
Expected<UniqueRef<AST::Expression>, Error> parsePrimaryExpression();
Expected<UniqueRef<AST::Expression>, Error> parseExpression();
Expected<UniqueRef<AST::Expression>, Error> parseLHSExpression();
Expected<UniqueRef<AST::Expression>, Error> parseCoreLHSExpression();
Expected<Vector<UniqueRef<AST::Expression>>, Error> parseArgumentExpressionList();

private:
Expected<Token, TokenType> consumeType(TokenType);
void consume();

Token& current() { return m_current; }

Lexer& m_lexer;
Token m_current;
};

} // namespace WGSL
@@ -79,6 +79,7 @@
33EA188427BC268600A1DD52 /* StructureAccess.h in Headers */ = {isa = PBXBuildFile; fileRef = 33EA188327BC268600A1DD52 /* StructureAccess.h */; };
33EA188627BC26DF00A1DD52 /* TypeConversion.h in Headers */ = {isa = PBXBuildFile; fileRef = 33EA188527BC26DF00A1DD52 /* TypeConversion.h */; };
33EA188827BC361E00A1DD52 /* LiteralExpressions.h in Headers */ = {isa = PBXBuildFile; fileRef = 33EA188727BC361E00A1DD52 /* LiteralExpressions.h */; };
66DC575528627E0B0014CABD /* ParserPrivate.h in Headers */ = {isa = PBXBuildFile; fileRef = 66DC575428627E0B0014CABD /* ParserPrivate.h */; };
DD05A35C27BF09C60096EFAB /* libWTF.a in Product Dependencies */ = {isa = PBXBuildFile; fileRef = 1CEBD8292716CAE700A5254D /* libWTF.a */; };
/* End PBXBuildFile section */

@@ -327,6 +328,7 @@
33EA188327BC268600A1DD52 /* StructureAccess.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = StructureAccess.h; sourceTree = "<group>"; };
33EA188527BC26DF00A1DD52 /* TypeConversion.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = TypeConversion.h; sourceTree = "<group>"; };
33EA188727BC361E00A1DD52 /* LiteralExpressions.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = LiteralExpressions.h; sourceTree = "<group>"; };
66DC575428627E0B0014CABD /* ParserPrivate.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = ParserPrivate.h; sourceTree = "<group>"; };
/* End PBXFileReference section */

/* Begin PBXFrameworksBuildPhase section */
@@ -634,6 +636,7 @@
338BB2D327B6B66C00E066AB /* Lexer.h */,
339B7B1A27D800090072BF9A /* Parser.cpp */,
339B7B1727D7FFA40072BF9A /* Parser.h */,
66DC575428627E0B0014CABD /* ParserPrivate.h */,
338BB2D127B6B63F00E066AB /* SourceSpan.h */,
338BB2CF27B6B61B00E066AB /* Token.cpp */,
338BB2CD27B6B60200E066AB /* Token.h */,
@@ -749,6 +752,7 @@
33EA188227BC25D000A1DD52 /* IdentifierExpression.h in Headers */,
338BB2D427B6B66C00E066AB /* Lexer.h in Headers */,
33EA188827BC361E00A1DD52 /* LiteralExpressions.h in Headers */,
66DC575528627E0B0014CABD /* ParserPrivate.h in Headers */,
339B7B1827D7FFA40072BF9A /* Parser.h in Headers */,
33EA187E27BC249000A1DD52 /* ReturnStatement.h in Headers */,
33EA187027BC1E8A00A1DD52 /* ShaderModule.h in Headers */,

0 comments on commit a62eb94

Please sign in to comment.