// Copyright (C) 2022 Jérôme "Lynix" Leclercq (lynix680@gmail.com) // This file is part of the "Nazara Engine - Shader module" // For conditions of distribution and use, see copyright notice in Config.hpp #include #include #include #include #include #include #include namespace Nz::ShaderLang { namespace NAZARA_ANONYMOUS_NAMESPACE { std::unordered_map s_depthWriteModes = { { "greater", ShaderAst::DepthWriteMode::Greater }, { "less", ShaderAst::DepthWriteMode::Less }, { "replace", ShaderAst::DepthWriteMode::Replace }, { "unchanged", ShaderAst::DepthWriteMode::Unchanged }, }; std::unordered_map s_identifierToAttributeType = { { "binding", ShaderAst::AttributeType::Binding }, { "builtin", ShaderAst::AttributeType::Builtin }, { "cond", ShaderAst::AttributeType::Cond }, { "depth_write", ShaderAst::AttributeType::DepthWrite }, { "early_fragment_tests", ShaderAst::AttributeType::EarlyFragmentTests }, { "entry", ShaderAst::AttributeType::Entry }, { "export", ShaderAst::AttributeType::Export }, { "layout", ShaderAst::AttributeType::Layout }, { "location", ShaderAst::AttributeType::Location }, { "nzsl_version", ShaderAst::AttributeType::LangVersion }, { "set", ShaderAst::AttributeType::Set }, { "unroll", ShaderAst::AttributeType::Unroll }, { "uuid", ShaderAst::AttributeType::Uuid }, }; std::unordered_map s_entryPoints = { { "frag", ShaderStageType::Fragment }, { "vert", ShaderStageType::Vertex }, }; std::unordered_map s_builtinMapping = { { "fragcoord", ShaderAst::BuiltinEntry::FragCoord }, { "fragdepth", ShaderAst::BuiltinEntry::FragDepth }, { "position", ShaderAst::BuiltinEntry::VertexPosition } }; std::unordered_map s_layoutMapping = { { "std140", StructLayout::Std140 } }; std::unordered_map s_unrollModes = { { "always", ShaderAst::LoopUnroll::Always }, { "hint", ShaderAst::LoopUnroll::Hint }, { "never", ShaderAst::LoopUnroll::Never } }; template void HandleUniqueAttribute(const std::string_view& attributeName, ShaderAst::ExpressionValue& targetAttribute, ShaderAst::ExprValue::Param&& param) { if (targetAttribute.HasValue()) throw AttributeError{ "attribute " + std::string(attributeName) + " must be present once" }; if (param) targetAttribute = std::move(*param); else throw AttributeError{ "attribute " + std::string(attributeName) + " requires a parameter" }; } template void HandleUniqueAttribute(const std::string_view& attributeName, ShaderAst::ExpressionValue& targetAttribute, ShaderAst::ExprValue::Param&& param, T defaultValue) { if (targetAttribute.HasValue()) throw AttributeError{ "attribute " + std::string(attributeName) + " must be present once" }; if (param) targetAttribute = std::move(*param); else targetAttribute = std::move(defaultValue); } template void HandleUniqueStringAttribute(const std::string_view& attributeName, const std::unordered_map& map, ShaderAst::ExpressionValue& targetAttribute, ShaderAst::ExprValue::Param&& param, std::optional defaultValue = {}) { if (targetAttribute.HasValue()) throw AttributeError{ "attribute " + std::string(attributeName) + " must be present once" }; //FIXME: This should be handled with global values at sanitization stage if (param) { const ShaderAst::ExpressionPtr& expr = *param; if (expr->GetType() != ShaderAst::NodeType::IdentifierExpression) throw AttributeError{ "attribute " + std::string(attributeName) + " can only be an identifier for now" }; const std::string& exprStr = static_cast(*expr).identifier; auto it = map.find(exprStr); if (it == map.end()) throw AttributeError{ ("invalid parameter " + exprStr + " for " + std::string(attributeName) + " attribute").c_str() }; targetAttribute = it->second; } else { if (!defaultValue) throw AttributeError{ "attribute " + std::string(attributeName) + " requires a value" }; targetAttribute = defaultValue.value(); } } } ShaderAst::ModulePtr Parser::Parse(const std::vector& tokens) { Context context; context.tokenCount = tokens.size(); context.tokens = tokens.data(); m_context = &context; std::vector attributes; for (;;) { ShaderAst::StatementPtr statement = ParseRootStatement(); if (!m_context->module) throw UnexpectedToken{}; //< "unexpected token before module declaration" if (!statement) break; m_context->module->rootNode->statements.push_back(std::move(statement)); } return std::move(context.module); } const Token& Parser::Advance() { const Token& token = Peek(); m_context->tokenIndex++; return token; } void Parser::Consume(std::size_t count) { assert(m_context->tokenIndex + count < m_context->tokenCount); m_context->tokenIndex += count; } const Token& Parser::Expect(const Token& token, TokenType type) { if (token.type != type) throw ExpectedToken{}; return token; } const Token& Parser::ExpectNot(const Token& token, TokenType type) { if (token.type == type) throw ExpectedToken{}; return token; } const Token& Parser::Expect(TokenType type) { const Token& token = Peek(); Expect(token, type); return token; } const Token& Parser::Peek(std::size_t advance) { assert(m_context->tokenIndex + advance < m_context->tokenCount); return m_context->tokens[m_context->tokenIndex + advance]; } std::vector Parser::ParseAttributes() { std::vector attributes; Expect(Advance(), TokenType::OpenSquareBracket); bool expectComma = false; for (;;) { const Token& t = Peek(); ExpectNot(t, TokenType::EndOfStream); if (t.type == TokenType::ClosingSquareBracket) { // Parse [attribute1] [attribute2] the same as [attribute1, attribute2] if (Peek(1).type == TokenType::OpenSquareBracket) { Consume(2); expectComma = false; continue; } break; } if (expectComma) Expect(Advance(), TokenType::Comma); ShaderAst::AttributeType attributeType = ParseIdentifierAsAttributeType(); ShaderAst::ExprValue::Param arg; if (Peek().type == TokenType::OpenParenthesis) { Consume(); arg = ParseExpression(); Expect(Advance(), TokenType::ClosingParenthesis); } expectComma = true; attributes.push_back({ attributeType, std::move(arg) }); } Expect(Advance(), TokenType::ClosingSquareBracket); return attributes; } void Parser::ParseModuleStatement(std::vector attributes) { if (m_context->parsingImportedModule) throw UnexpectedToken{}; Expect(Advance(), TokenType::Module); std::optional moduleVersion; std::optional moduleId; for (auto&& [attributeType, arg] : attributes) { switch (attributeType) { case ShaderAst::AttributeType::LangVersion: { // Version parsing if (moduleVersion.has_value()) throw AttributeError{ "attribute " + std::string("nzsl_version") + " must be present once" }; if (!arg) throw AttributeError{ "attribute " + std::string("nzsl_version") + " requires a parameter"}; const ShaderAst::ExpressionPtr& expr = *arg; if (expr->GetType() != ShaderAst::NodeType::ConstantValueExpression) throw AttributeError{ "attribute " + std::string("nzsl_version") + " expect a single string parameter" }; auto& constantValue = SafeCast(*expr); if (ShaderAst::GetExpressionType(constantValue.value) != ShaderAst::ExpressionType{ ShaderAst::PrimitiveType::String }) throw AttributeError{ "attribute " + std::string("nzsl_version") + " expect a single string parameter" }; const std::string& versionStr = std::get(constantValue.value); std::regex versionRegex(R"(^(\d+)(\.(\d+)(\.(\d+))?)?$)", std::regex::ECMAScript); std::smatch versionMatch; if (!std::regex_match(versionStr, versionMatch, versionRegex)) throw AttributeError("invalid version for attribute nzsl"); assert(versionMatch.size() == 6); std::uint32_t version = 0; version += std::stoi(versionMatch[1]) * 100; if (versionMatch.length(3) > 0) version += std::stoi(versionMatch[3]) * 10; if (versionMatch.length(5) > 0) version += std::stoi(versionMatch[5]) * 1; moduleVersion = version; break; } case ShaderAst::AttributeType::Uuid: { if (moduleId.has_value()) throw AttributeError{ "attribute" + std::string("uuid") + " can only be present once" }; if (!arg) throw AttributeError{ "attribute " + std::string("uuid") + " requires a parameter" }; const ShaderAst::ExpressionPtr& expr = *arg; if (expr->GetType() != ShaderAst::NodeType::ConstantValueExpression) throw AttributeError{ "attribute " + std::string("uuid") + " expect a single string parameter" }; auto& constantValue = SafeCast(*expr); if (ShaderAst::GetExpressionType(constantValue.value) != ShaderAst::ExpressionType{ ShaderAst::PrimitiveType::String }) throw AttributeError{ "attribute " + std::string("uuid") + " expect a single string parameter" }; const std::string& uuidStr = std::get(constantValue.value); Uuid uuid = Uuid::FromString(uuidStr); if (uuid.IsNull()) throw AttributeError{ "attribute " + std::string("uuid") + " value is not a valid UUID" }; moduleId = uuid; break; } default: throw AttributeError{ "unhandled attribute for module" }; } } if (!moduleVersion.has_value()) throw AttributeError{ "missing module version" }; if (!moduleId) moduleId = Uuid::Generate(); if (m_context->module) { std::string moduleName = ParseModuleName(); auto module = std::make_shared(*moduleVersion, std::move(moduleName), *moduleId); // Imported module Expect(Advance(), TokenType::OpenCurlyBracket); m_context->parsingImportedModule = true; while (Peek().type != TokenType::ClosingCurlyBracket) { ShaderAst::StatementPtr statement = ParseRootStatement(); if (!statement) throw UnexpectedToken{}; //< "unexpected end of file" module->rootNode->statements.push_back(std::move(statement)); } Consume(); //< Consume ClosingCurlyBracket m_context->parsingImportedModule = false; auto& importedModule = m_context->module->importedModules.emplace_back(); importedModule.module = std::move(module); importedModule.identifier = importedModule.module->metadata->moduleName; } else { std::string moduleName; if (Peek().type == TokenType::Identifier) moduleName = ParseModuleName(); auto module = std::make_shared(*moduleVersion, std::move(moduleName), *moduleId); // First declaration Expect(Advance(), TokenType::Semicolon); if (m_context->module) throw DuplicateModule{ "you must set one module statement per file" }; m_context->module = std::move(module); } } void Parser::ParseVariableDeclaration(std::string& name, ShaderAst::ExpressionValue& type, ShaderAst::ExpressionPtr& initialValue) { name = ParseIdentifierAsName(); if (Peek().type == TokenType::Colon) { Expect(Advance(), TokenType::Colon); type = ParseType(); } if (!type.HasValue() || Peek().type == TokenType::Assign) { Expect(Advance(), TokenType::Assign); initialValue = ParseExpression(); } Expect(Advance(), TokenType::Semicolon); } ShaderAst::StatementPtr Parser::ParseAliasDeclaration() { Expect(Advance(), TokenType::Alias); std::string name = ParseIdentifierAsName(); Expect(Advance(), TokenType::Assign); ShaderAst::ExpressionPtr expr = ParseExpression(); Expect(Advance(), TokenType::Semicolon); return ShaderBuilder::DeclareAlias(std::move(name), std::move(expr)); } ShaderAst::StatementPtr Parser::ParseBranchStatement() { std::unique_ptr branch = std::make_unique(); bool first = true; for (;;) { if (!first) Expect(Advance(), TokenType::Else); first = false; Expect(Advance(), TokenType::If); auto& condStatement = branch->condStatements.emplace_back(); Expect(Advance(), TokenType::OpenParenthesis); condStatement.condition = ParseExpression(); Expect(Advance(), TokenType::ClosingParenthesis); condStatement.statement = ParseStatement(); if (Peek().type != TokenType::Else || Peek(1).type != TokenType::If) break; } if (Peek().type == TokenType::Else) { Consume(); branch->elseStatement = ParseStatement(); } return branch; } ShaderAst::StatementPtr Parser::ParseConstStatement() { Expect(Advance(), TokenType::Const); switch (Peek().type) { case TokenType::Identifier: { std::string constName; ShaderAst::ExpressionValue constType; ShaderAst::ExpressionPtr initialValue; ParseVariableDeclaration(constName, constType, initialValue); return ShaderBuilder::DeclareConst(std::move(constName), std::move(constType), std::move(initialValue)); } case TokenType::If: { auto branch = ParseBranchStatement(); SafeCast(*branch).isConst = true; return branch; } default: throw UnexpectedToken{}; } } ShaderAst::StatementPtr Parser::ParseDiscardStatement() { Expect(Advance(), TokenType::Discard); Expect(Advance(), TokenType::Semicolon); return ShaderBuilder::Discard(); } ShaderAst::StatementPtr Parser::ParseExternalBlock(std::vector attributes) { NAZARA_USE_ANONYMOUS_NAMESPACE Expect(Advance(), TokenType::External); Expect(Advance(), TokenType::OpenCurlyBracket); std::unique_ptr externalStatement = std::make_unique(); ShaderAst::ExpressionValue condition; for (auto&& [attributeType, arg] : attributes) { switch (attributeType) { case ShaderAst::AttributeType::Cond: HandleUniqueAttribute("cond", condition, std::move(arg)); break; case ShaderAst::AttributeType::Set: HandleUniqueAttribute("set", externalStatement->bindingSet, std::move(arg)); break; default: throw AttributeError{ "unhandled attribute for external block" }; } } bool first = true; for (;;) { if (!first) { const Token& nextToken = Peek(); if (nextToken.type == TokenType::Comma) Consume(); else { Expect(nextToken, TokenType::ClosingCurlyBracket); break; } } first = false; const Token& token = Peek(); if (token.type == TokenType::ClosingCurlyBracket) break; auto& extVar = externalStatement->externalVars.emplace_back(); if (token.type == TokenType::OpenSquareBracket) { for (auto&& [attributeType, arg] : ParseAttributes()) { switch (attributeType) { case ShaderAst::AttributeType::Binding: HandleUniqueAttribute("binding", extVar.bindingIndex, std::move(arg)); break; case ShaderAst::AttributeType::Set: HandleUniqueAttribute("set", extVar.bindingSet, std::move(arg)); break; default: throw AttributeError{ "unhandled attribute for external variable" }; } } } extVar.name = ParseIdentifierAsName(); Expect(Advance(), TokenType::Colon); extVar.type = ParseType(); } Expect(Advance(), TokenType::ClosingCurlyBracket); if (condition.HasValue()) return ShaderBuilder::ConditionalStatement(std::move(condition).GetExpression(), std::move(externalStatement)); else return externalStatement; } ShaderAst::StatementPtr Parser::ParseForDeclaration(std::vector attributes) { NAZARA_USE_ANONYMOUS_NAMESPACE Expect(Advance(), TokenType::For); std::string varName = ParseIdentifierAsName(); Expect(Advance(), TokenType::In); ShaderAst::ExpressionPtr expr = ParseExpression(); if (Peek().type == TokenType::Arrow) { // Numerical for Consume(); ShaderAst::ExpressionPtr toExpr = ParseExpression(); ShaderAst::ExpressionPtr stepExpr; if (Peek().type == TokenType::Colon) { Consume(); stepExpr = ParseExpression(); } ShaderAst::StatementPtr statement = ParseStatement(); auto forNode = ShaderBuilder::For(std::move(varName), std::move(expr), std::move(toExpr), std::move(stepExpr), std::move(statement)); // TODO: Deduplicate code for (auto&& [attributeType, arg] : attributes) { switch (attributeType) { case ShaderAst::AttributeType::Unroll: HandleUniqueStringAttribute("unroll", s_unrollModes, forNode->unroll, std::move(arg), std::make_optional(ShaderAst::LoopUnroll::Always)); break; default: throw AttributeError{ "unhandled attribute for numerical for" }; } } return forNode; } else { // For each ShaderAst::StatementPtr statement = ParseStatement(); auto forEachNode = ShaderBuilder::ForEach(std::move(varName), std::move(expr), std::move(statement)); // TODO: Deduplicate code for (auto&& [attributeType, arg] : attributes) { switch (attributeType) { case ShaderAst::AttributeType::Unroll: HandleUniqueStringAttribute("unroll", s_unrollModes, forEachNode->unroll, std::move(arg), std::make_optional(ShaderAst::LoopUnroll::Always)); break; default: throw AttributeError{ "unhandled attribute for for-each" }; } } return forEachNode; } } std::vector Parser::ParseFunctionBody() { return ParseStatementList(); } ShaderAst::StatementPtr Parser::ParseFunctionDeclaration(std::vector attributes) { NAZARA_USE_ANONYMOUS_NAMESPACE Expect(Advance(), TokenType::FunctionDeclaration); std::string functionName = ParseIdentifierAsName(); Expect(Advance(), TokenType::OpenParenthesis); std::vector parameters; bool firstParameter = true; for (;;) { const Token& t = Peek(); ExpectNot(t, TokenType::EndOfStream); if (t.type == TokenType::ClosingParenthesis) break; if (!firstParameter) Expect(Advance(), TokenType::Comma); parameters.push_back(ParseFunctionParameter()); firstParameter = false; } Expect(Advance(), TokenType::ClosingParenthesis); ShaderAst::ExpressionValue returnType; if (Peek().type == TokenType::Arrow) { Consume(); returnType = ParseType(); } std::vector functionBody = ParseFunctionBody(); auto func = ShaderBuilder::DeclareFunction(std::move(functionName), std::move(parameters), std::move(functionBody), std::move(returnType)); ShaderAst::ExpressionValue condition; for (auto&& [attributeType, attributeParam] : attributes) { switch (attributeType) { case ShaderAst::AttributeType::Cond: HandleUniqueAttribute("cond", condition, std::move(attributeParam)); break; case ShaderAst::AttributeType::Entry: HandleUniqueStringAttribute("entry", s_entryPoints, func->entryStage, std::move(attributeParam)); break; case ShaderAst::AttributeType::Export: HandleUniqueAttribute("export", func->isExported, std::move(attributeParam), true); break; case ShaderAst::AttributeType::DepthWrite: HandleUniqueStringAttribute("depth_write", s_depthWriteModes, func->depthWrite, std::move(attributeParam)); break; case ShaderAst::AttributeType::EarlyFragmentTests: HandleUniqueAttribute("early_fragment_tests", func->earlyFragmentTests, std::move(attributeParam), true); break; default: throw AttributeError{ "unhandled attribute for function" }; } } if (condition.HasValue()) return ShaderBuilder::ConditionalStatement(std::move(condition).GetExpression(), std::move(func)); else return func; } ShaderAst::DeclareFunctionStatement::Parameter Parser::ParseFunctionParameter() { ShaderAst::DeclareFunctionStatement::Parameter parameter; parameter.name = ParseIdentifierAsName(); Expect(Advance(), TokenType::Colon); parameter.type = ParseType(); return parameter; } ShaderAst::StatementPtr Parser::ParseImportStatement() { Expect(Advance(), TokenType::Import); std::string moduleName = ParseModuleName(); Expect(Advance(), TokenType::Semicolon); return ShaderBuilder::Import(std::move(moduleName)); } ShaderAst::StatementPtr Parser::ParseOptionDeclaration() { Expect(Advance(), TokenType::Option); std::string optionName = ParseIdentifierAsName(); Expect(Advance(), TokenType::Colon); ShaderAst::ExpressionPtr optionType = ParseType(); ShaderAst::ExpressionPtr initialValue; if (Peek().type == TokenType::Assign) { Consume(); initialValue = ParseExpression(); } Expect(Advance(), TokenType::Semicolon); return ShaderBuilder::DeclareOption(std::move(optionName), std::move(optionType), std::move(initialValue)); } ShaderAst::StatementPtr Parser::ParseReturnStatement() { Expect(Advance(), TokenType::Return); ShaderAst::ExpressionPtr expr; if (Peek().type != TokenType::Semicolon) expr = ParseExpression(); Expect(Advance(), TokenType::Semicolon); return ShaderBuilder::Return(std::move(expr)); } ShaderAst::StatementPtr Parser::ParseRootStatement(std::vector attributes) { const Token& nextToken = Peek(); switch (nextToken.type) { case TokenType::Alias: if (!attributes.empty()) throw UnexpectedToken{}; return ParseAliasDeclaration(); case TokenType::Const: if (!attributes.empty()) throw UnexpectedToken{}; return ParseConstStatement(); case TokenType::EndOfStream: if (!attributes.empty()) throw UnexpectedToken{}; return {}; case TokenType::External: return ParseExternalBlock(std::move(attributes)); case TokenType::Import: if (!attributes.empty()) throw UnexpectedToken{}; return ParseImportStatement(); case TokenType::OpenSquareBracket: assert(attributes.empty()); return ParseRootStatement(ParseAttributes()); case TokenType::Module: ParseModuleStatement(std::move(attributes)); return ParseRootStatement(); case TokenType::Option: { if (!attributes.empty()) throw UnexpectedToken{}; return ParseOptionDeclaration(); } case TokenType::FunctionDeclaration: return ParseFunctionDeclaration(std::move(attributes)); case TokenType::Struct: return ParseStructDeclaration(std::move(attributes)); default: throw UnexpectedToken{}; } } ShaderAst::StatementPtr Parser::ParseSingleStatement() { std::vector attributes; ShaderAst::StatementPtr statement; do { const Token& token = Peek(); switch (token.type) { case TokenType::Const: if (!attributes.empty()) throw UnexpectedToken{}; statement = ParseConstStatement(); break; case TokenType::Discard: if (!attributes.empty()) throw UnexpectedToken{}; statement = ParseDiscardStatement(); break; case TokenType::For: statement = ParseForDeclaration(std::move(attributes)); attributes.clear(); break; case TokenType::Let: if (!attributes.empty()) throw UnexpectedToken{}; statement = ParseVariableDeclaration(); break; case TokenType::Identifier: if (!attributes.empty()) throw UnexpectedToken{}; statement = ShaderBuilder::ExpressionStatement(ParseVariableAssignation()); Expect(Advance(), TokenType::Semicolon); break; case TokenType::If: if (!attributes.empty()) throw UnexpectedToken{}; statement = ParseBranchStatement(); break; case TokenType::OpenSquareBracket: assert(attributes.empty()); attributes = ParseAttributes(); break; case TokenType::Return: if (!attributes.empty()) throw UnexpectedToken{}; statement = ParseReturnStatement(); break; case TokenType::While: statement = ParseWhileStatement(std::move(attributes)); attributes.clear(); break; default: throw UnexpectedToken{}; } } while (!statement); //< small trick to repeat parsing once we got attributes return statement; } ShaderAst::StatementPtr Parser::ParseStatement() { if (Peek().type == TokenType::OpenCurlyBracket) return ShaderBuilder::Scoped(ShaderBuilder::MultiStatement(ParseStatementList())); else return ParseSingleStatement(); } std::vector Parser::ParseStatementList() { Expect(Advance(), TokenType::OpenCurlyBracket); std::vector statements; while (Peek().type != TokenType::ClosingCurlyBracket) { ExpectNot(Peek(), TokenType::EndOfStream); statements.push_back(ParseStatement()); } Consume(); //< Consume closing curly bracket return statements; } ShaderAst::StatementPtr Parser::ParseStructDeclaration(std::vector attributes) { NAZARA_USE_ANONYMOUS_NAMESPACE Expect(Advance(), TokenType::Struct); ShaderAst::StructDescription description; description.name = ParseIdentifierAsName(); ShaderAst::ExpressionValue condition; ShaderAst::ExpressionValue exported; for (auto&& [attributeType, attributeParam] : attributes) { switch (attributeType) { case ShaderAst::AttributeType::Cond: HandleUniqueAttribute("cond", condition, std::move(attributeParam)); break; case ShaderAst::AttributeType::Export: HandleUniqueAttribute("export", exported, std::move(attributeParam), true); break; case ShaderAst::AttributeType::Layout: HandleUniqueStringAttribute("layout", s_layoutMapping, description.layout, std::move(attributeParam)); break; default: throw AttributeError{ "unexpected attribute" }; } } Expect(Advance(), TokenType::OpenCurlyBracket); bool first = true; for (;;) { if (!first) { const Token& nextToken = Peek(); if (nextToken.type == TokenType::Comma) Consume(); else { Expect(nextToken, TokenType::ClosingCurlyBracket); break; } } first = false; const Token& token = Peek(); if (token.type == TokenType::ClosingCurlyBracket) break; auto& structField = description.members.emplace_back(); if (token.type == TokenType::OpenSquareBracket) { for (auto&& [attributeType, arg] : ParseAttributes()) { switch (attributeType) { case ShaderAst::AttributeType::Builtin: HandleUniqueStringAttribute("builtin", s_builtinMapping, structField.builtin, std::move(arg)); break; case ShaderAst::AttributeType::Cond: HandleUniqueAttribute("cond", structField.cond, std::move(arg)); break; case ShaderAst::AttributeType::Location: HandleUniqueAttribute("location", structField.locationIndex, std::move(arg)); break; default: throw AttributeError{ "unexpected attribute" }; } } if (structField.builtin.HasValue() && structField.locationIndex.HasValue()) throw AttributeError{ "A struct field cannot have both builtin and location attributes" }; } structField.name = ParseIdentifierAsName(); Expect(Advance(), TokenType::Colon); structField.type = ParseType(); } Expect(Advance(), TokenType::ClosingCurlyBracket); if (condition.HasValue()) return ShaderBuilder::ConditionalStatement(std::move(condition).GetExpression(), ShaderBuilder::DeclareStruct(std::move(description), std::move(exported))); else return ShaderBuilder::DeclareStruct(std::move(description), std::move(exported)); } ShaderAst::ExpressionPtr Parser::ParseVariableAssignation() { // Variable expression ShaderAst::ExpressionPtr left = ParseExpression(); // Assignation type ShaderAst::AssignType assignType; switch (Peek().type) { case TokenType::Assign: assignType = ShaderAst::AssignType::Simple; break; case TokenType::DivideAssign: assignType = ShaderAst::AssignType::CompoundDivide; break; case TokenType::LogicalAndAssign: assignType = ShaderAst::AssignType::CompoundLogicalAnd; break; case TokenType::LogicalOrAssign: assignType = ShaderAst::AssignType::CompoundLogicalOr; break; case TokenType::MultiplyAssign: assignType = ShaderAst::AssignType::CompoundMultiply; break; case TokenType::MinusAssign: assignType = ShaderAst::AssignType::CompoundSubtract; break; case TokenType::PlusAssign: assignType = ShaderAst::AssignType::CompoundAdd; break; default: throw UnexpectedToken{}; } Consume(); // Value expression ShaderAst::ExpressionPtr right = ParseExpression(); return ShaderBuilder::Assign(assignType, std::move(left), std::move(right)); } ShaderAst::StatementPtr Parser::ParseVariableDeclaration() { Expect(Advance(), TokenType::Let); std::string variableName; ShaderAst::ExpressionValue variableType; ShaderAst::ExpressionPtr expression; ParseVariableDeclaration(variableName, variableType, expression); return ShaderBuilder::DeclareVariable(std::move(variableName), std::move(variableType), std::move(expression)); } ShaderAst::StatementPtr Parser::ParseWhileStatement(std::vector attributes) { NAZARA_USE_ANONYMOUS_NAMESPACE Expect(Advance(), TokenType::While); Expect(Advance(), TokenType::OpenParenthesis); ShaderAst::ExpressionPtr condition = ParseExpression(); Expect(Advance(), TokenType::ClosingParenthesis); ShaderAst::StatementPtr body = ParseStatement(); auto whileStatement = ShaderBuilder::While(std::move(condition), std::move(body)); for (auto&& [attributeType, arg] : attributes) { switch (attributeType) { case ShaderAst::AttributeType::Unroll: HandleUniqueStringAttribute("unroll", s_unrollModes, whileStatement->unroll, std::move(arg), std::make_optional(ShaderAst::LoopUnroll::Always)); break; default: throw AttributeError{ "unhandled attribute for while" }; } } return whileStatement; } ShaderAst::ExpressionPtr Parser::ParseBinOpRhs(int exprPrecedence, ShaderAst::ExpressionPtr lhs) { for (;;) { TokenType currentTokenType = Peek().type; if (currentTokenType == TokenType::EndOfStream) throw UnexpectedToken{}; int tokenPrecedence = GetTokenPrecedence(currentTokenType); if (tokenPrecedence < exprPrecedence) return lhs; bool c = false; while (currentTokenType == TokenType::Dot || currentTokenType == TokenType::OpenSquareBracket) { c = true; if (currentTokenType == TokenType::Dot) { std::unique_ptr accessMemberNode = std::make_unique(); accessMemberNode->expr = std::move(lhs); do { Consume(); accessMemberNode->identifiers.push_back(ParseIdentifierAsName()); } while (Peek().type == TokenType::Dot); lhs = std::move(accessMemberNode); } else { assert(currentTokenType == TokenType::OpenSquareBracket); std::unique_ptr indexNode = std::make_unique(); indexNode->expr = std::move(lhs); do { Consume(); indexNode->indices.push_back(ParseExpression()); } while (Peek().type == TokenType::Comma); Expect(Advance(), TokenType::ClosingSquareBracket); lhs = std::move(indexNode); } currentTokenType = Peek().type; } if (currentTokenType == TokenType::OpenParenthesis) { // Function call auto parameters = ParseParameters(); lhs = ShaderBuilder::CallFunction(std::move(lhs), std::move(parameters)); c = true; } if (c) continue; Consume(); ShaderAst::ExpressionPtr rhs = ParsePrimaryExpression(); const Token& nextOp = Peek(); int nextTokenPrecedence = GetTokenPrecedence(nextOp.type); if (tokenPrecedence < nextTokenPrecedence) rhs = ParseBinOpRhs(tokenPrecedence + 1, std::move(rhs)); ShaderAst::BinaryType binaryType; { switch (currentTokenType) { case TokenType::Divide: binaryType = ShaderAst::BinaryType::Divide; break; case TokenType::Equal: binaryType = ShaderAst::BinaryType::CompEq; break; case TokenType::LessThan: binaryType = ShaderAst::BinaryType::CompLt; break; case TokenType::LessThanEqual: binaryType = ShaderAst::BinaryType::CompLe; break; case TokenType::LogicalAnd: binaryType = ShaderAst::BinaryType::LogicalAnd; break; case TokenType::LogicalOr: binaryType = ShaderAst::BinaryType::LogicalOr; break; case TokenType::GreaterThan: binaryType = ShaderAst::BinaryType::CompGt; break; case TokenType::GreaterThanEqual: binaryType = ShaderAst::BinaryType::CompGe; break; case TokenType::Minus: binaryType = ShaderAst::BinaryType::Subtract; break; case TokenType::Multiply: binaryType = ShaderAst::BinaryType::Multiply; break; case TokenType::NotEqual: binaryType = ShaderAst::BinaryType::CompNe; break; case TokenType::Plus: binaryType = ShaderAst::BinaryType::Add; break; default: throw UnexpectedToken{}; } } lhs = ShaderBuilder::Binary(binaryType, std::move(lhs), std::move(rhs)); } } ShaderAst::ExpressionPtr Parser::ParseConstSelectExpression() { Expect(Advance(), TokenType::ConstSelect); Expect(Advance(), TokenType::OpenParenthesis); ShaderAst::ExpressionPtr cond = ParseExpression(); Expect(Advance(), TokenType::Comma); ShaderAst::ExpressionPtr trueExpr = ParseExpression(); Expect(Advance(), TokenType::Comma); ShaderAst::ExpressionPtr falseExpr = ParseExpression(); Expect(Advance(), TokenType::ClosingParenthesis); return ShaderBuilder::ConditionalExpression(std::move(cond), std::move(trueExpr), std::move(falseExpr)); } ShaderAst::ExpressionPtr Parser::ParseExpression() { return ParseBinOpRhs(0, ParsePrimaryExpression()); } ShaderAst::ExpressionPtr Parser::ParseFloatingPointExpression() { const Token& floatingPointToken = Expect(Advance(), TokenType::FloatingPointValue); return ShaderBuilder::Constant(float(std::get(floatingPointToken.data))); //< FIXME } ShaderAst::ExpressionPtr Parser::ParseIdentifier() { const Token& identifierToken = Expect(Advance(), TokenType::Identifier); const std::string& identifier = std::get(identifierToken.data); return ShaderBuilder::Identifier(identifier); } ShaderAst::ExpressionPtr Parser::ParseIntegerExpression() { const Token& integerToken = Expect(Advance(), TokenType::IntegerValue); return ShaderBuilder::Constant(SafeCast(std::get(integerToken.data))); //< FIXME } std::vector Parser::ParseParameters() { Expect(Advance(), TokenType::OpenParenthesis); std::vector parameters; bool first = true; while (Peek().type != TokenType::ClosingParenthesis) { if (!first) Expect(Advance(), TokenType::Comma); first = false; parameters.push_back(ParseExpression()); } Expect(Advance(), TokenType::ClosingParenthesis); return parameters; } ShaderAst::ExpressionPtr Parser::ParseParenthesisExpression() { Expect(Advance(), TokenType::OpenParenthesis); ShaderAst::ExpressionPtr expression = ParseExpression(); Expect(Advance(), TokenType::ClosingParenthesis); return expression; } ShaderAst::ExpressionPtr Parser::ParsePrimaryExpression() { const Token& token = Peek(); switch (token.type) { case TokenType::BoolFalse: Consume(); return ShaderBuilder::Constant(false); case TokenType::BoolTrue: Consume(); return ShaderBuilder::Constant(true); case TokenType::ConstSelect: return ParseConstSelectExpression(); case TokenType::FloatingPointValue: return ParseFloatingPointExpression(); case TokenType::Identifier: return ParseIdentifier(); case TokenType::IntegerValue: return ParseIntegerExpression(); case TokenType::Minus: { Consume(); ShaderAst::ExpressionPtr expr = ParsePrimaryExpression(); return ShaderBuilder::Unary(ShaderAst::UnaryType::Minus, std::move(expr)); } case TokenType::Plus: { Consume(); ShaderAst::ExpressionPtr expr = ParsePrimaryExpression(); return ShaderBuilder::Unary(ShaderAst::UnaryType::Plus, std::move(expr)); } case TokenType::Not: { Consume(); ShaderAst::ExpressionPtr expr = ParsePrimaryExpression(); return ShaderBuilder::Unary(ShaderAst::UnaryType::LogicalNot, std::move(expr)); } case TokenType::OpenParenthesis: return ParseParenthesisExpression(); case TokenType::StringValue: return ParseStringExpression(); default: throw UnexpectedToken{}; } } ShaderAst::ExpressionPtr Parser::ParseStringExpression() { const Token& litteralToken = Expect(Advance(), TokenType::StringValue); return ShaderBuilder::Constant(std::get(litteralToken.data)); } ShaderAst::AttributeType Parser::ParseIdentifierAsAttributeType() { NAZARA_USE_ANONYMOUS_NAMESPACE const Token& identifierToken = Expect(Advance(), TokenType::Identifier); const std::string& identifier = std::get(identifierToken.data); auto it = s_identifierToAttributeType.find(identifier); if (it == s_identifierToAttributeType.end()) throw UnknownAttribute{}; return it->second; } const std::string& Parser::ParseIdentifierAsName() { const Token& identifierToken = Expect(Advance(), TokenType::Identifier); return std::get(identifierToken.data); } std::string Parser::ParseModuleName() { std::string moduleName = ParseIdentifierAsName(); while (Peek().type == TokenType::Dot) { Consume(); moduleName += '.'; moduleName += ParseIdentifierAsName(); } return moduleName; } ShaderAst::ExpressionPtr Parser::ParseType() { // Handle () as no type if (Peek().type == TokenType::OpenParenthesis) { Consume(); Expect(Advance(), TokenType::ClosingParenthesis); return ShaderBuilder::Constant(ShaderAst::NoValue{}); } return ParseExpression(); } int Parser::GetTokenPrecedence(TokenType token) { switch (token) { case TokenType::Divide: return 80; case TokenType::Dot: return 100; case TokenType::Equal: return 50; case TokenType::LessThan: return 40; case TokenType::LessThanEqual: return 40; case TokenType::LogicalAnd: return 120; case TokenType::LogicalOr: return 140; case TokenType::GreaterThan: return 40; case TokenType::GreaterThanEqual: return 40; case TokenType::Multiply: return 80; case TokenType::Minus: return 60; case TokenType::NotEqual: return 50; case TokenType::Plus: return 60; case TokenType::OpenSquareBracket: return 100; case TokenType::OpenParenthesis: return 100; default: return -1; } } ShaderAst::ModulePtr ParseFromFile(const std::filesystem::path& sourcePath) { File file(sourcePath); if (!file.Open(OpenMode::ReadOnly | OpenMode::Text)) { NazaraError("Failed to open \"" + sourcePath.generic_u8string() + '"'); return {}; } std::size_t length = static_cast(file.GetSize()); if (length == 0) return {}; std::vector source(length); if (file.Read(&source[0], length) != length) { NazaraError("Failed to read shader file"); return {}; } return Parse(std::string_view(reinterpret_cast(source.data()), source.size())); } }