// Copyright 2021 The Tint Authors. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #ifndef SRC_PROGRAM_BUILDER_H_ #define SRC_PROGRAM_BUILDER_H_ #include #include #include "src/ast/array_accessor_expression.h" #include "src/ast/assignment_statement.h" #include "src/ast/binary_expression.h" #include "src/ast/bool.h" #include "src/ast/bool_literal.h" #include "src/ast/call_expression.h" #include "src/ast/case_statement.h" #include "src/ast/f32.h" #include "src/ast/float_literal.h" #include "src/ast/i32.h" #include "src/ast/if_statement.h" #include "src/ast/loop_statement.h" #include "src/ast/member_accessor_expression.h" #include "src/ast/module.h" #include "src/ast/return_statement.h" #include "src/ast/scalar_constructor_expression.h" #include "src/ast/sint_literal.h" #include "src/ast/stage_decoration.h" #include "src/ast/stride_decoration.h" #include "src/ast/struct_member_align_decoration.h" #include "src/ast/struct_member_offset_decoration.h" #include "src/ast/struct_member_size_decoration.h" #include "src/ast/switch_statement.h" #include "src/ast/type_constructor_expression.h" #include "src/ast/u32.h" #include "src/ast/uint_literal.h" #include "src/ast/variable_decl_statement.h" #include "src/ast/void.h" #include "src/program.h" #include "src/program_id.h" #include "src/sem/access_control_type.h" #include "src/sem/alias_type.h" #include "src/sem/array_type.h" #include "src/sem/bool_type.h" #include "src/sem/f32_type.h" #include "src/sem/i32_type.h" #include "src/sem/matrix_type.h" #include "src/sem/pointer_type.h" #include "src/sem/struct_type.h" #include "src/sem/u32_type.h" #include "src/sem/vector_type.h" #include "src/sem/void_type.h" #include "src/typepair.h" namespace tint { // Forward declarations namespace ast { class VariableDeclStatement; } // namespace ast class CloneContext; /// ProgramBuilder is a mutable builder for a Program. /// To construct a Program, populate the builder and then `std::move` it to a /// Program. class ProgramBuilder { public: /// ASTNodeAllocator is an alias to BlockAllocator using ASTNodeAllocator = BlockAllocator; /// SemNodeAllocator is an alias to BlockAllocator using SemNodeAllocator = BlockAllocator; /// `i32` is a type alias to `int`. /// Useful for passing to template methods such as `vec2()` to imitate /// WGSL syntax. /// Note: this is intentionally not aliased to uint32_t as we want integer /// literals passed to the builder to match WGSL's integer literal types. using i32 = decltype(1); /// `u32` is a type alias to `unsigned int`. /// Useful for passing to template methods such as `vec2()` to imitate /// WGSL syntax. /// Note: this is intentionally not aliased to uint32_t as we want integer /// literals passed to the builder to match WGSL's integer literal types. using u32 = decltype(1u); /// `f32` is a type alias to `float` /// Useful for passing to template methods such as `vec2()` to imitate /// WGSL syntax. using f32 = float; /// Constructor ProgramBuilder(); /// Move constructor /// @param rhs the builder to move ProgramBuilder(ProgramBuilder&& rhs); /// Destructor virtual ~ProgramBuilder(); /// Move assignment operator /// @param rhs the builder to move /// @return this builder ProgramBuilder& operator=(ProgramBuilder&& rhs); /// Wrap returns a new ProgramBuilder wrapping the Program `program` without /// making a deep clone of the Program contents. /// ProgramBuilder returned by Wrap() is intended to temporarily extend an /// existing immutable program. /// As the returned ProgramBuilder wraps `program`, `program` must not be /// destructed or assigned while using the returned ProgramBuilder. /// TODO(bclayton) - Evaluate whether there are safer alternatives to this /// function. See crbug.com/tint/460. /// @param program the immutable Program to wrap /// @return the ProgramBuilder that wraps `program` static ProgramBuilder Wrap(const Program* program); /// @returns the unique identifier for this program ProgramID ID() const { return id_; } /// @returns a reference to the program's types sem::Manager& Types() { AssertNotMoved(); return types_; } /// @returns a reference to the program's types const sem::Manager& Types() const { AssertNotMoved(); return types_; } /// @returns a reference to the program's AST nodes storage ASTNodeAllocator& ASTNodes() { AssertNotMoved(); return ast_nodes_; } /// @returns a reference to the program's AST nodes storage const ASTNodeAllocator& ASTNodes() const { AssertNotMoved(); return ast_nodes_; } /// @returns a reference to the program's semantic nodes storage SemNodeAllocator& SemNodes() { AssertNotMoved(); return sem_nodes_; } /// @returns a reference to the program's semantic nodes storage const SemNodeAllocator& SemNodes() const { AssertNotMoved(); return sem_nodes_; } /// @returns a reference to the program's AST root Module ast::Module& AST() { AssertNotMoved(); return *ast_; } /// @returns a reference to the program's AST root Module const ast::Module& AST() const { AssertNotMoved(); return *ast_; } /// @returns a reference to the program's semantic info sem::Info& Sem() { AssertNotMoved(); return sem_; } /// @returns a reference to the program's semantic info const sem::Info& Sem() const { AssertNotMoved(); return sem_; } /// @returns a reference to the program's SymbolTable SymbolTable& Symbols() { AssertNotMoved(); return symbols_; } /// @returns a reference to the program's SymbolTable const SymbolTable& Symbols() const { AssertNotMoved(); return symbols_; } /// @returns a reference to the program's diagnostics diag::List& Diagnostics() { AssertNotMoved(); return diagnostics_; } /// @returns a reference to the program's diagnostics const diag::List& Diagnostics() const { AssertNotMoved(); return diagnostics_; } /// Controls whether the Resolver will be run on the program when it is built. /// @param enable the new flag value (defaults to true) void SetResolveOnBuild(bool enable) { resolve_on_build_ = enable; } /// @return true if the Resolver will be run on the program when it is /// built. bool ResolveOnBuild() const { return resolve_on_build_; } /// @returns true if the program has no error diagnostics and is not missing /// information bool IsValid() const; /// Writes a representation of the node to the output stream /// @note unlike str(), to_str() does not automatically demangle the string. /// @param node the AST node /// @param out the stream to write to /// @param indent number of spaces to indent the node when writing void to_str(const ast::Node* node, std::ostream& out, size_t indent) const { node->to_str(Sem(), out, indent); } /// Returns a demangled, string representation of `node`. /// @param node the AST node /// @returns a string representation of the node std::string str(const ast::Node* node) const; /// Creates a new ast::Node owned by the ProgramBuilder. When the /// ProgramBuilder is destructed, the ast::Node will also be destructed. /// @param source the Source of the node /// @param args the arguments to pass to the type constructor /// @returns the node pointer template traits::EnableIfIsType* create(const Source& source, ARGS&&... args) { AssertNotMoved(); return ast_nodes_.Create(id_, source, std::forward(args)...); } /// Creates a new ast::Node owned by the ProgramBuilder, injecting the current /// Source as set by the last call to SetSource() as the only argument to the /// constructor. /// When the ProgramBuilder is destructed, the ast::Node will also be /// destructed. /// @returns the node pointer template traits::EnableIfIsType* create() { AssertNotMoved(); return ast_nodes_.Create(id_, source_); } /// Creates a new ast::Node owned by the ProgramBuilder, injecting the current /// Source as set by the last call to SetSource() as the first argument to the /// constructor. /// When the ProgramBuilder is destructed, the ast::Node will also be /// destructed. /// @param arg0 the first arguments to pass to the type constructor /// @param args the remaining arguments to pass to the type constructor /// @returns the node pointer template traits::EnableIf::value && !traits::IsTypeOrDerived::value, T>* create(ARG0&& arg0, ARGS&&... args) { AssertNotMoved(); return ast_nodes_.Create(id_, source_, std::forward(arg0), std::forward(args)...); } /// Creates a new sem::Node owned by the ProgramBuilder. /// When the ProgramBuilder is destructed, the sem::Node will also be /// destructed. /// @param args the arguments to pass to the type constructor /// @returns the node pointer template traits::EnableIfIsType* create(ARGS&&... args) { AssertNotMoved(); return sem_nodes_.Create(std::forward(args)...); } /// Creates a new sem::Type owned by the ProgramBuilder. /// When the ProgramBuilder is destructed, owned ProgramBuilder and the /// returned`Type` will also be destructed. /// Types are unique (de-aliased), and so calling create() for the same `T` /// and arguments will return the same pointer. /// @warning Use this method to acquire a type only if all of its type /// information is provided in the constructor arguments `args`.
/// If the type requires additional configuration after construction that /// affect its fundamental type, build the type with `std::make_unique`, make /// any necessary alterations and then call unique_type() instead. /// @param args the arguments to pass to the type constructor /// @returns the de-aliased type pointer template traits::EnableIfIsType* create(ARGS&&... args) { static_assert(std::is_base_of::value, "T does not derive from sem::Type"); AssertNotMoved(); return types_.Get(std::forward(args)...); } /// Marks this builder as moved, preventing any further use of the builder. void MarkAsMoved(); ////////////////////////////////////////////////////////////////////////////// // TypesBuilder ////////////////////////////////////////////////////////////////////////////// /// TypesBuilder holds basic `tint` types and methods for constructing /// complex types. class TypesBuilder { public: /// Constructor /// @param builder the program builder explicit TypesBuilder(ProgramBuilder* builder); /// @return the tint AST type for the C type `T`. template sem::Type* Of() const { return CToAST::get(this); } /// @returns a boolean type typ::Bool bool_() const { return {builder->create(), builder->create()}; } /// @returns a f32 type typ::F32 f32() const { return {builder->create(), builder->create()}; } /// @returns a i32 type typ::I32 i32() const { return {builder->create(), builder->create()}; } /// @returns a u32 type typ::U32 u32() const { return {builder->create(), builder->create()}; } /// @returns a void type typ::Void void_() const { return {builder->create(), builder->create()}; } /// @param type vector subtype /// @return the tint AST type for a 2-element vector of `type`. sem::Vector* vec2(sem::Type* type) const { return builder->create(type, 2u); } /// @param type vector subtype /// @return the tint AST type for a 3-element vector of `type`. sem::Vector* vec3(sem::Type* type) const { return builder->create(type, 3u); } /// @param type vector subtype /// @return the tint AST type for a 4-element vector of `type`. sem::Type* vec4(sem::Type* type) const { return builder->create(type, 4u); } /// @return the tint AST type for a 2-element vector of the C type `T`. template sem::Vector* vec2() const { return vec2(Of()); } /// @return the tint AST type for a 3-element vector of the C type `T`. template sem::Vector* vec3() const { return vec3(Of()); } /// @return the tint AST type for a 4-element vector of the C type `T`. template sem::Type* vec4() const { return vec4(Of()); } /// @param type matrix subtype /// @return the tint AST type for a 2x3 matrix of `type`. sem::Matrix* mat2x2(sem::Type* type) const { return builder->create(type, 2u, 2u); } /// @param type matrix subtype /// @return the tint AST type for a 2x3 matrix of `type`. sem::Matrix* mat2x3(sem::Type* type) const { return builder->create(type, 3u, 2u); } /// @param type matrix subtype /// @return the tint AST type for a 2x4 matrix of `type`. sem::Matrix* mat2x4(sem::Type* type) const { return builder->create(type, 4u, 2u); } /// @param type matrix subtype /// @return the tint AST type for a 3x2 matrix of `type`. sem::Matrix* mat3x2(sem::Type* type) const { return builder->create(type, 2u, 3u); } /// @param type matrix subtype /// @return the tint AST type for a 3x3 matrix of `type`. sem::Matrix* mat3x3(sem::Type* type) const { return builder->create(type, 3u, 3u); } /// @param type matrix subtype /// @return the tint AST type for a 3x4 matrix of `type`. sem::Matrix* mat3x4(sem::Type* type) const { return builder->create(type, 4u, 3u); } /// @param type matrix subtype /// @return the tint AST type for a 4x2 matrix of `type`. sem::Matrix* mat4x2(sem::Type* type) const { return builder->create(type, 2u, 4u); } /// @param type matrix subtype /// @return the tint AST type for a 4x3 matrix of `type`. sem::Matrix* mat4x3(sem::Type* type) const { return builder->create(type, 3u, 4u); } /// @param type matrix subtype /// @return the tint AST type for a 4x4 matrix of `type`. sem::Matrix* mat4x4(sem::Type* type) const { return builder->create(type, 4u, 4u); } /// @return the tint AST type for a 2x3 matrix of the C type `T`. template sem::Matrix* mat2x2() const { return mat2x2(Of()); } /// @return the tint AST type for a 2x3 matrix of the C type `T`. template sem::Matrix* mat2x3() const { return mat2x3(Of()); } /// @return the tint AST type for a 2x4 matrix of the C type `T`. template sem::Matrix* mat2x4() const { return mat2x4(Of()); } /// @return the tint AST type for a 3x2 matrix of the C type `T`. template sem::Matrix* mat3x2() const { return mat3x2(Of()); } /// @return the tint AST type for a 3x3 matrix of the C type `T`. template sem::Matrix* mat3x3() const { return mat3x3(Of()); } /// @return the tint AST type for a 3x4 matrix of the C type `T`. template sem::Matrix* mat3x4() const { return mat3x4(Of()); } /// @return the tint AST type for a 4x2 matrix of the C type `T`. template sem::Matrix* mat4x2() const { return mat4x2(Of()); } /// @return the tint AST type for a 4x3 matrix of the C type `T`. template sem::Matrix* mat4x3() const { return mat4x3(Of()); } /// @return the tint AST type for a 4x4 matrix of the C type `T`. template sem::Matrix* mat4x4() const { return mat4x4(Of()); } /// @param subtype the array element type /// @param n the array size. 0 represents a runtime-array. /// @return the tint AST type for a array of size `n` of type `T` sem::ArrayType* array(sem::Type* subtype, uint32_t n = 0) const { return builder->create(subtype, n, ast::DecorationList{}); } /// @param subtype the array element type /// @param n the array size. 0 represents a runtime-array. /// @param stride the array stride. /// @return the tint AST type for a array of size `n` of type `T` sem::ArrayType* array(sem::Type* subtype, uint32_t n, uint32_t stride) const { return builder->create( subtype, n, ast::DecorationList{ builder->create(stride), }); } /// @return the tint AST type for an array of size `N` of type `T` template sem::ArrayType* array() const { return array(Of(), N); } /// @param stride the array stride /// @return the tint AST type for an array of size `N` of type `T` template sem::ArrayType* array(uint32_t stride) const { return array(Of(), N, stride); } /// Creates an alias type /// @param name the alias name /// @param type the alias type /// @returns the alias pointer template sem::Alias* alias(NAME&& name, sem::Type* type) const { return builder->create(builder->Sym(std::forward(name)), type); } /// Creates an access control qualifier type /// @param access the access control /// @param type the inner type /// @returns the access control qualifier type sem::AccessControl* access(ast::AccessControl::Access access, sem::Type* type) const { return builder->create(access, type); } /// @return the tint AST pointer to `type` with the given ast::StorageClass /// @param type the type of the pointer /// @param storage_class the storage class of the pointer sem::Pointer* pointer(sem::Type* type, ast::StorageClass storage_class) const { return builder->create(type, storage_class); } /// @return the tint AST pointer to type `T` with the given /// ast::StorageClass. /// @param storage_class the storage class of the pointer template sem::Pointer* pointer(ast::StorageClass storage_class) const { return pointer(Of(), storage_class); } /// @param impl the struct implementation /// @returns a struct pointer sem::StructType* struct_(ast::Struct* impl) const { return builder->create(impl); } private: /// CToAST is specialized for various `T` types and each specialization /// contains a single static `get()` method for obtaining the corresponding /// AST type for the C type `T`. /// `get()` has the signature: /// `static sem::Type* get(Types* t)` template struct CToAST {}; ProgramBuilder* const builder; }; ////////////////////////////////////////////////////////////////////////////// // AST helper methods ////////////////////////////////////////////////////////////////////////////// /// @param name the symbol string /// @return a Symbol with the given name Symbol Sym(const std::string& name) { return Symbols().Register(name); } /// @param sym the symbol /// @return `sym` Symbol Sym(Symbol sym) { return sym; } /// @param expr the expression /// @return expr template traits::EnableIfIsType* Expr(T* expr) { return expr; } /// Passthrough for nullptr /// @return nullptr ast::IdentifierExpression* Expr(std::nullptr_t) { return nullptr; } /// @param name the identifier name /// @return an ast::IdentifierExpression with the given name ast::IdentifierExpression* Expr(const std::string& name) { return create(Symbols().Register(name)); } /// @param symbol the identifier symbol /// @return an ast::IdentifierExpression with the given symbol ast::IdentifierExpression* Expr(Symbol symbol) { return create(symbol); } /// @param variable the AST variable /// @return an ast::IdentifierExpression with the variable's symbol ast::IdentifierExpression* Expr(ast::Variable* variable) { return create(variable->symbol()); } /// @param source the source information /// @param name the identifier name /// @return an ast::IdentifierExpression with the given name ast::IdentifierExpression* Expr(const Source& source, const std::string& name) { return create(source, Symbols().Register(name)); } /// @param name the identifier name /// @return an ast::IdentifierExpression with the given name ast::IdentifierExpression* Expr(const char* name) { return create(Symbols().Register(name)); } /// @param value the boolean value /// @return a Scalar constructor for the given value ast::ScalarConstructorExpression* Expr(bool value) { return create(Literal(value)); } /// @param value the float value /// @return a Scalar constructor for the given value ast::ScalarConstructorExpression* Expr(f32 value) { return create(Literal(value)); } /// @param value the integer value /// @return a Scalar constructor for the given value ast::ScalarConstructorExpression* Expr(i32 value) { return create(Literal(value)); } /// @param value the unsigned int value /// @return a Scalar constructor for the given value ast::ScalarConstructorExpression* Expr(u32 value) { return create(Literal(value)); } /// Converts `arg` to an `ast::Expression` using `Expr()`, then appends it to /// `list`. /// @param list the list to append too /// @param arg the arg to create template void Append(ast::ExpressionList& list, ARG&& arg) { list.emplace_back(Expr(std::forward(arg))); } /// Converts `arg0` and `args` to `ast::Expression`s using `Expr()`, /// then appends them to `list`. /// @param list the list to append too /// @param arg0 the first argument /// @param args the rest of the arguments template void Append(ast::ExpressionList& list, ARG0&& arg0, ARGS&&... args) { Append(list, std::forward(arg0)); Append(list, std::forward(args)...); } /// @return an empty list of expressions ast::ExpressionList ExprList() { return {}; } /// @param args the list of expressions /// @return the list of expressions converted to `ast::Expression`s using /// `Expr()`, template ast::ExpressionList ExprList(ARGS&&... args) { ast::ExpressionList list; list.reserve(sizeof...(args)); Append(list, std::forward(args)...); return list; } /// @param list the list of expressions /// @return `list` ast::ExpressionList ExprList(ast::ExpressionList list) { return list; } /// @param val the boolan value /// @return a boolean literal with the given value ast::BoolLiteral* Literal(bool val) { return create(ty.bool_(), val); } /// @param val the float value /// @return a float literal with the given value ast::FloatLiteral* Literal(f32 val) { return create(ty.f32(), val); } /// @param val the unsigned int value /// @return a ast::UintLiteral with the given value ast::UintLiteral* Literal(u32 val) { return create(ty.u32(), val); } /// @param val the integer value /// @return the ast::SintLiteral with the given value ast::SintLiteral* Literal(i32 val) { return create(ty.i32(), val); } /// @param args the arguments for the type constructor /// @return an `ast::TypeConstructorExpression` of type `ty`, with the values /// of `args` converted to `ast::Expression`s using `Expr()` template ast::TypeConstructorExpression* Construct(ARGS&&... args) { return create( ty.Of(), ExprList(std::forward(args)...)); } /// @param type the type to construct /// @param args the arguments for the constructor /// @return an `ast::TypeConstructorExpression` of `type` constructed with the /// values `args`. template ast::TypeConstructorExpression* Construct(sem::Type* type, ARGS&&... args) { return create( type, ExprList(std::forward(args)...)); } /// Creates a constructor expression that constructs an object of /// `type` filled with `elem_value`. For example, /// ConstructValueFilledWith(ty.mat3x4(), 5) returns a /// TypeConstructorExpression for a Mat3x4 filled with 5.0f values. /// @param type the type to construct /// @param elem_value the initial or element value (for vec and mat) to /// construct with /// @return the constructor expression ast::ConstructorExpression* ConstructValueFilledWith(sem::Type* type, int elem_value = 0); /// @param args the arguments for the vector constructor /// @return an `ast::TypeConstructorExpression` of a 2-element vector of type /// `T`, constructed with the values `args`. template ast::TypeConstructorExpression* vec2(ARGS&&... args) { return create( ty.vec2(), ExprList(std::forward(args)...)); } /// @param args the arguments for the vector constructor /// @return an `ast::TypeConstructorExpression` of a 3-element vector of type /// `T`, constructed with the values `args`. template ast::TypeConstructorExpression* vec3(ARGS&&... args) { return create( ty.vec3(), ExprList(std::forward(args)...)); } /// @param args the arguments for the vector constructor /// @return an `ast::TypeConstructorExpression` of a 4-element vector of type /// `T`, constructed with the values `args`. template ast::TypeConstructorExpression* vec4(ARGS&&... args) { return create( ty.vec4(), ExprList(std::forward(args)...)); } /// @param args the arguments for the matrix constructor /// @return an `ast::TypeConstructorExpression` of a 2x2 matrix of type /// `T`, constructed with the values `args`. template ast::TypeConstructorExpression* mat2x2(ARGS&&... args) { return create( ty.mat2x2(), ExprList(std::forward(args)...)); } /// @param args the arguments for the matrix constructor /// @return an `ast::TypeConstructorExpression` of a 2x3 matrix of type /// `T`, constructed with the values `args`. template ast::TypeConstructorExpression* mat2x3(ARGS&&... args) { return create( ty.mat2x3(), ExprList(std::forward(args)...)); } /// @param args the arguments for the matrix constructor /// @return an `ast::TypeConstructorExpression` of a 2x4 matrix of type /// `T`, constructed with the values `args`. template ast::TypeConstructorExpression* mat2x4(ARGS&&... args) { return create( ty.mat2x4(), ExprList(std::forward(args)...)); } /// @param args the arguments for the matrix constructor /// @return an `ast::TypeConstructorExpression` of a 3x2 matrix of type /// `T`, constructed with the values `args`. template ast::TypeConstructorExpression* mat3x2(ARGS&&... args) { return create( ty.mat3x2(), ExprList(std::forward(args)...)); } /// @param args the arguments for the matrix constructor /// @return an `ast::TypeConstructorExpression` of a 3x3 matrix of type /// `T`, constructed with the values `args`. template ast::TypeConstructorExpression* mat3x3(ARGS&&... args) { return create( ty.mat3x3(), ExprList(std::forward(args)...)); } /// @param args the arguments for the matrix constructor /// @return an `ast::TypeConstructorExpression` of a 3x4 matrix of type /// `T`, constructed with the values `args`. template ast::TypeConstructorExpression* mat3x4(ARGS&&... args) { return create( ty.mat3x4(), ExprList(std::forward(args)...)); } /// @param args the arguments for the matrix constructor /// @return an `ast::TypeConstructorExpression` of a 4x2 matrix of type /// `T`, constructed with the values `args`. template ast::TypeConstructorExpression* mat4x2(ARGS&&... args) { return create( ty.mat4x2(), ExprList(std::forward(args)...)); } /// @param args the arguments for the matrix constructor /// @return an `ast::TypeConstructorExpression` of a 4x3 matrix of type /// `T`, constructed with the values `args`. template ast::TypeConstructorExpression* mat4x3(ARGS&&... args) { return create( ty.mat4x3(), ExprList(std::forward(args)...)); } /// @param args the arguments for the matrix constructor /// @return an `ast::TypeConstructorExpression` of a 4x4 matrix of type /// `T`, constructed with the values `args`. template ast::TypeConstructorExpression* mat4x4(ARGS&&... args) { return create( ty.mat4x4(), ExprList(std::forward(args)...)); } /// @param args the arguments for the array constructor /// @return an `ast::TypeConstructorExpression` of an array with element type /// `T`, constructed with the values `args`. template ast::TypeConstructorExpression* array(ARGS&&... args) { return create( ty.array(), ExprList(std::forward(args)...)); } /// @param subtype the array element type /// @param n the array size. 0 represents a runtime-array. /// @param args the arguments for the array constructor /// @return an `ast::TypeConstructorExpression` of an array with element type /// `subtype`, constructed with the values `args`. template ast::TypeConstructorExpression* array(sem::Type* subtype, uint32_t n, ARGS&&... args) { return create( ty.array(subtype, n), ExprList(std::forward(args)...)); } /// @param name the variable name /// @param type the variable type /// @param storage the variable storage class /// @param constructor constructor expression /// @param decorations variable decorations /// @returns a `ast::Variable` with the given name, storage and type template ast::Variable* Var(NAME&& name, sem::Type* type, ast::StorageClass storage, ast::Expression* constructor = nullptr, ast::DecorationList decorations = {}) { return create(Sym(std::forward(name)), storage, type, false, constructor, decorations); } /// @param source the variable source /// @param name the variable name /// @param type the variable type /// @param storage the variable storage class /// @param constructor constructor expression /// @param decorations variable decorations /// @returns a `ast::Variable` with the given name, storage and type template ast::Variable* Var(const Source& source, NAME&& name, sem::Type* type, ast::StorageClass storage, ast::Expression* constructor = nullptr, ast::DecorationList decorations = {}) { return create(source, Sym(std::forward(name)), storage, type, false, constructor, decorations); } /// @param name the variable name /// @param type the variable type /// @param constructor optional constructor expression /// @param decorations optional variable decorations /// @returns a constant `ast::Variable` with the given name and type template ast::Variable* Const(NAME&& name, sem::Type* type, ast::Expression* constructor = nullptr, ast::DecorationList decorations = {}) { return create(Sym(std::forward(name)), ast::StorageClass::kNone, type, true, constructor, decorations); } /// @param source the variable source /// @param name the variable name /// @param type the variable type /// @param constructor optional constructor expression /// @param decorations optional variable decorations /// @returns a constant `ast::Variable` with the given name and type template ast::Variable* Const(const Source& source, NAME&& name, sem::Type* type, ast::Expression* constructor = nullptr, ast::DecorationList decorations = {}) { return create(source, Sym(std::forward(name)), ast::StorageClass::kNone, type, true, constructor, decorations); } /// @param name the parameter name /// @param type the parameter type /// @param decorations optional parameter decorations /// @returns a constant `ast::Variable` with the given name and type template ast::Variable* Param(NAME&& name, sem::Type* type, ast::DecorationList decorations = {}) { return create(Sym(std::forward(name)), ast::StorageClass::kNone, type, true, nullptr, decorations); } /// @param source the parameter source /// @param name the parameter name /// @param type the parameter type /// @param decorations optional parameter decorations /// @returns a constant `ast::Variable` with the given name and type template ast::Variable* Param(const Source& source, NAME&& name, sem::Type* type, ast::DecorationList decorations = {}) { return create(source, Sym(std::forward(name)), ast::StorageClass::kNone, type, true, nullptr, decorations); } /// @param name the variable name /// @param type the variable type /// @param storage the variable storage class /// @param constructor constructor expression /// @param decorations variable decorations /// @returns a new `ast::Variable`, which is automatically registered as a /// global variable with the ast::Module. template ast::Variable* Global(NAME&& name, sem::Type* type, ast::StorageClass storage, ast::Expression* constructor = nullptr, ast::DecorationList decorations = {}) { auto* var = Var(std::forward(name), type, storage, constructor, decorations); AST().AddGlobalVariable(var); return var; } /// @param source the variable source /// @param name the variable name /// @param type the variable type /// @param storage the variable storage class /// @param constructor constructor expression /// @param decorations variable decorations /// @returns a new `ast::Variable`, which is automatically registered as a /// global variable with the ast::Module. template ast::Variable* Global(const Source& source, NAME&& name, sem::Type* type, ast::StorageClass storage, ast::Expression* constructor = nullptr, ast::DecorationList decorations = {}) { auto* var = Var(source, std::forward(name), type, storage, constructor, decorations); AST().AddGlobalVariable(var); return var; } /// @param args the arguments to pass to Const() /// @returns a const `ast::Variable` constructed by calling Var() with the /// arguments of `args`, which is automatically registered as a global /// variable with the ast::Module. template ast::Variable* GlobalConst(ARGS&&... args) { auto* var = Const(std::forward(args)...); AST().AddGlobalVariable(var); return var; } /// @param func the function name /// @param args the function call arguments /// @returns a `ast::CallExpression` to the function `func`, with the /// arguments of `args` converted to `ast::Expression`s using `Expr()`. template ast::CallExpression* Call(NAME&& func, ARGS&&... args) { return create(Expr(func), ExprList(std::forward(args)...)); } /// @param lhs the left hand argument to the addition operation /// @param rhs the right hand argument to the addition operation /// @returns a `ast::BinaryExpression` summing the arguments `lhs` and `rhs` template ast::BinaryExpression* Add(LHS&& lhs, RHS&& rhs) { return create(ast::BinaryOp::kAdd, Expr(std::forward(lhs)), Expr(std::forward(rhs))); } /// @param lhs the left hand argument to the subtraction operation /// @param rhs the right hand argument to the subtraction operation /// @returns a `ast::BinaryExpression` subtracting `rhs` from `lhs` template ast::BinaryExpression* Sub(LHS&& lhs, RHS&& rhs) { return create(ast::BinaryOp::kSubtract, Expr(std::forward(lhs)), Expr(std::forward(rhs))); } /// @param lhs the left hand argument to the multiplication operation /// @param rhs the right hand argument to the multiplication operation /// @returns a `ast::BinaryExpression` multiplying `rhs` from `lhs` template ast::BinaryExpression* Mul(LHS&& lhs, RHS&& rhs) { return create(ast::BinaryOp::kMultiply, Expr(std::forward(lhs)), Expr(std::forward(rhs))); } /// @param source the source information /// @param lhs the left hand argument to the multiplication operation /// @param rhs the right hand argument to the multiplication operation /// @returns a `ast::BinaryExpression` multiplying `rhs` from `lhs` template ast::BinaryExpression* Mul(const Source& source, LHS&& lhs, RHS&& rhs) { return create(source, ast::BinaryOp::kMultiply, Expr(std::forward(lhs)), Expr(std::forward(rhs))); } /// @param lhs the left hand argument to the division operation /// @param rhs the right hand argument to the division operation /// @returns a `ast::BinaryExpression` dividing `lhs` by `rhs` template ast::Expression* Div(LHS&& lhs, RHS&& rhs) { return create(ast::BinaryOp::kDivide, Expr(std::forward(lhs)), Expr(std::forward(rhs))); } /// @param arr the array argument for the array accessor expression /// @param idx the index argument for the array accessor expression /// @returns a `ast::ArrayAccessorExpression` that indexes `arr` with `idx` template ast::ArrayAccessorExpression* IndexAccessor(ARR&& arr, IDX&& idx) { return create(Expr(std::forward(arr)), Expr(std::forward(idx))); } /// @param obj the object for the member accessor expression /// @param idx the index argument for the array accessor expression /// @returns a `ast::MemberAccessorExpression` that indexes `obj` with `idx` template ast::MemberAccessorExpression* MemberAccessor(OBJ&& obj, IDX&& idx) { return create(Expr(std::forward(obj)), Expr(std::forward(idx))); } /// Creates a ast::StructMemberOffsetDecoration /// @param val the offset value /// @returns the offset decoration pointer ast::StructMemberOffsetDecoration* MemberOffset(uint32_t val) { return create(source_, val); } /// Creates a ast::StructMemberSizeDecoration /// @param source the source information /// @param val the size value /// @returns the size decoration pointer ast::StructMemberSizeDecoration* MemberSize(const Source& source, uint32_t val) { return create(source, val); } /// Creates a ast::StructMemberSizeDecoration /// @param val the size value /// @returns the size decoration pointer ast::StructMemberSizeDecoration* MemberSize(uint32_t val) { return create(source_, val); } /// Creates a ast::StructMemberAlignDecoration /// @param source the source information /// @param val the align value /// @returns the align decoration pointer ast::StructMemberAlignDecoration* MemberAlign(const Source& source, uint32_t val) { return create(source, val); } /// Creates a ast::StructMemberAlignDecoration /// @param val the align value /// @returns the align decoration pointer ast::StructMemberAlignDecoration* MemberAlign(uint32_t val) { return create(source_, val); } /// Creates an ast::Function and registers it with the ast::Module. /// @param source the source information /// @param name the function name /// @param params the function parameters /// @param type the function return type /// @param body the function body /// @param decorations the optional function decorations /// @param return_type_decorations the optional function return type /// decorations /// @returns the function pointer template ast::Function* Func(const Source& source, NAME&& name, ast::VariableList params, sem::Type* type, ast::StatementList body, ast::DecorationList decorations = {}, ast::DecorationList return_type_decorations = {}) { auto* func = create(source, Sym(std::forward(name)), params, type, create(body), decorations, return_type_decorations); AST().AddFunction(func); return func; } /// Creates an ast::Function and registers it with the ast::Module. /// @param name the function name /// @param params the function parameters /// @param type the function return type /// @param body the function body /// @param decorations the optional function decorations /// @param return_type_decorations the optional function return type /// decorations /// @returns the function pointer template ast::Function* Func(NAME&& name, ast::VariableList params, sem::Type* type, ast::StatementList body, ast::DecorationList decorations = {}, ast::DecorationList return_type_decorations = {}) { auto* func = create(Sym(std::forward(name)), params, type, create(body), decorations, return_type_decorations); AST().AddFunction(func); return func; } /// Creates an ast::ReturnStatement with no return value /// @returns the return statement pointer ast::ReturnStatement* Return() { return create(); } /// Creates an ast::ReturnStatement with the given return value /// @param val the return value /// @returns the return statement pointer template ast::ReturnStatement* Return(EXPR&& val) { return create(Expr(std::forward(val))); } /// Creates a ast::Struct and sem::StructType, registering the /// sem::StructType with the AST().ConstructedTypes(). /// @param source the source information /// @param name the struct name /// @param members the struct members /// @param decorations the optional struct decorations /// @returns the struct type template sem::StructType* Structure(const Source& source, NAME&& name, ast::StructMemberList members, ast::DecorationList decorations = {}) { auto sym = Sym(std::forward(name)); auto* impl = create(source, sym, std::move(members), std::move(decorations)); auto* type = ty.struct_(impl); AST().AddConstructedType(type); return type; } /// Creates a ast::Struct and sem::StructType, registering the /// sem::StructType with the AST().ConstructedTypes(). /// @param name the struct name /// @param members the struct members /// @param decorations the optional struct decorations /// @returns the struct type template sem::StructType* Structure(NAME&& name, ast::StructMemberList members, ast::DecorationList decorations = {}) { auto sym = Sym(std::forward(name)); auto* impl = create(sym, std::move(members), std::move(decorations)); auto* type = ty.struct_(impl); AST().AddConstructedType(type); return type; } /// Creates a ast::StructMember /// @param source the source information /// @param name the struct member name /// @param type the struct member type /// @param decorations the optional struct member decorations /// @returns the struct member pointer template ast::StructMember* Member(const Source& source, NAME&& name, sem::Type* type, ast::DecorationList decorations = {}) { return create(source, Sym(std::forward(name)), type, std::move(decorations)); } /// Creates a ast::StructMember /// @param name the struct member name /// @param type the struct member type /// @param decorations the optional struct member decorations /// @returns the struct member pointer template ast::StructMember* Member(NAME&& name, sem::Type* type, ast::DecorationList decorations = {}) { return create(source_, Sym(std::forward(name)), type, std::move(decorations)); } /// Creates a ast::StructMember with the given byte offset /// @param offset the offset to use in the StructMemberOffsetDecoration /// @param name the struct member name /// @param type the struct member type /// @returns the struct member pointer template ast::StructMember* Member(uint32_t offset, NAME&& name, sem::Type* type) { return create( source_, Sym(std::forward(name)), type, ast::DecorationList{ create(offset), }); } /// Creates a ast::BlockStatement with input statements /// @param statements statements of block /// @returns the block statement pointer template ast::BlockStatement* Block(Statements&&... statements) { return create( ast::StatementList{std::forward(statements)...}); } /// Creates a ast::ElseStatement with input condition and body /// @param condition the else condition expression /// @param body the else body /// @returns the else statement pointer template ast::ElseStatement* Else(CONDITION&& condition, ast::BlockStatement* body) { return create(Expr(std::forward(condition)), body); } /// Creates a ast::IfStatement with input condition, body, and optional /// variadic else statements /// @param condition the if statement condition expression /// @param body the if statement body /// @param elseStatements optional variadic else statements /// @returns the if statement pointer template ast::IfStatement* If(CONDITION&& condition, ast::BlockStatement* body, ELSE_STATEMENTS&&... elseStatements) { return create( Expr(std::forward(condition)), body, ast::ElseStatementList{ std::forward(elseStatements)...}); } /// Creates a ast::AssignmentStatement with input lhs and rhs expressions /// @param lhs the left hand side expression initializer /// @param rhs the right hand side expression initializer /// @returns the assignment statement pointer template ast::AssignmentStatement* Assign(LhsExpressionInit&& lhs, RhsExpressionInit&& rhs) { return create( Expr(std::forward(lhs)), Expr(std::forward(rhs))); } /// Creates a ast::LoopStatement with input body and optional continuing /// @param body the loop body /// @param continuing the optional continuing block /// @returns the loop statement pointer ast::LoopStatement* Loop(ast::BlockStatement* body, ast::BlockStatement* continuing = nullptr) { return create(body, continuing); } /// Creates a ast::VariableDeclStatement for the input variable /// @param var the variable to wrap in a decl statement /// @returns the variable decl statement pointer ast::VariableDeclStatement* Decl(ast::Variable* var) { return create(var); } /// Creates a ast::SwitchStatement with input expression and cases /// @param condition the condition expression initializer /// @param cases case statements /// @returns the switch statement pointer template ast::SwitchStatement* Switch(ExpressionInit&& condition, Cases&&... cases) { return create( Expr(std::forward(condition)), ast::CaseStatementList{std::forward(cases)...}); } /// Creates a ast::CaseStatement with input list of selectors, and body /// @param selectors list of selectors /// @param body the case body /// @returns the case statement pointer ast::CaseStatement* Case(ast::CaseSelectorList selectors, ast::BlockStatement* body = nullptr) { return create(std::move(selectors), body ? body : Block()); } /// Convenient overload that takes a single selector /// @param selector a single case selector /// @param body the case body /// @returns the case statement pointer ast::CaseStatement* Case(ast::IntLiteral* selector, ast::BlockStatement* body = nullptr) { return Case(ast::CaseSelectorList{selector}, body); } /// Convenience function that creates a 'default' ast::CaseStatement /// @param body the case body /// @returns the case statement pointer ast::CaseStatement* DefaultCase(ast::BlockStatement* body = nullptr) { return Case(ast::CaseSelectorList{}, body); } /// Creates an ast::BuiltinDecoration /// @param source the source information /// @param builtin the builtin value /// @returns the builtin decoration pointer ast::BuiltinDecoration* Builtin(const Source& source, ast::Builtin builtin) { return create(source, builtin); } /// Creates an ast::BuiltinDecoration /// @param builtin the builtin value /// @returns the builtin decoration pointer ast::BuiltinDecoration* Builtin(ast::Builtin builtin) { return create(source_, builtin); } /// Creates an ast::LocationDecoration /// @param source the source information /// @param location the location value /// @returns the location decoration pointer ast::LocationDecoration* Location(const Source& source, uint32_t location) { return create(source, location); } /// Creates an ast::LocationDecoration /// @param location the location value /// @returns the location decoration pointer ast::LocationDecoration* Location(uint32_t location) { return create(source_, location); } /// Creates an ast::StageDecoration /// @param source the source information /// @param stage the pipeline stage /// @returns the stage decoration pointer ast::StageDecoration* Stage(const Source& source, ast::PipelineStage stage) { return create(source, stage); } /// Creates an ast::StageDecoration /// @param stage the pipeline stage /// @returns the stage decoration pointer ast::StageDecoration* Stage(ast::PipelineStage stage) { return create(source_, stage); } /// Sets the current builder source to `src` /// @param src the Source used for future create() calls void SetSource(const Source& src) { AssertNotMoved(); source_ = src; } /// Sets the current builder source to `loc` /// @param loc the Source used for future create() calls void SetSource(const Source::Location& loc) { AssertNotMoved(); source_ = Source(loc); } /// Helper for returning the resolved semantic type of the expression `expr`. /// @note As the Resolver is run when the Program is built, this will only be /// useful for the Resolver itself and tests that use their own Resolver. /// @param expr the AST expression /// @return the resolved semantic type for the expression, or nullptr if the /// expression has no resolved type. sem::Type* TypeOf(ast::Expression* expr) const; /// Wraps the ast::Literal in a statement. This is used by tests that /// construct a partial AST and require the Resolver to reach these /// nodes. /// @param lit the ast::Literal to be wrapped by an ast::Statement /// @return the ast::Statement that wraps the ast::Statement ast::Statement* WrapInStatement(ast::Literal* lit); /// Wraps the ast::Expression in a statement. This is used by tests that /// construct a partial AST and require the Resolver to reach these /// nodes. /// @param expr the ast::Expression to be wrapped by an ast::Statement /// @return the ast::Statement that wraps the ast::Expression ast::Statement* WrapInStatement(ast::Expression* expr); /// Wraps the ast::Variable in a ast::VariableDeclStatement. This is used by /// tests that construct a partial AST and require the Resolver to reach /// these nodes. /// @param v the ast::Variable to be wrapped by an ast::VariableDeclStatement /// @return the ast::VariableDeclStatement that wraps the ast::Variable ast::VariableDeclStatement* WrapInStatement(ast::Variable* v); /// Returns the statement argument. Used as a passthrough-overload by /// WrapInFunction(). /// @param stmt the ast::Statement /// @return `stmt` ast::Statement* WrapInStatement(ast::Statement* stmt); /// Wraps the list of arguments in a simple function so that each is reachable /// by the Resolver. /// @param args a mix of ast::Expression, ast::Statement, ast::Variables. /// @returns the function template ast::Function* WrapInFunction(ARGS&&... args) { ast::StatementList stmts{WrapInStatement(std::forward(args))...}; return WrapInFunction(std::move(stmts)); } /// @param stmts a list of ast::Statement that will be wrapped by a function, /// so that each statement is reachable by the Resolver. /// @returns the function ast::Function* WrapInFunction(ast::StatementList stmts); /// The builder types TypesBuilder const ty{this}; protected: /// Asserts that the builder has not been moved. void AssertNotMoved() const; private: ProgramID id_; sem::Manager types_; ASTNodeAllocator ast_nodes_; SemNodeAllocator sem_nodes_; ast::Module* ast_; sem::Info sem_; SymbolTable symbols_{id_}; diag::List diagnostics_; /// The source to use when creating AST nodes without providing a Source as /// the first argument. Source source_; /// Set by SetResolveOnBuild(). If set, the Resolver will be run on the /// program when built. bool resolve_on_build_ = true; /// Set by MarkAsMoved(). Once set, no methods may be called on this builder. bool moved_ = false; }; //! @cond Doxygen_Suppress // Various template specializations for ProgramBuilder::TypesBuilder::CToAST. template <> struct ProgramBuilder::TypesBuilder::CToAST { static sem::Type* get(const ProgramBuilder::TypesBuilder* t) { return t->i32(); } }; template <> struct ProgramBuilder::TypesBuilder::CToAST { static sem::Type* get(const ProgramBuilder::TypesBuilder* t) { return t->u32(); } }; template <> struct ProgramBuilder::TypesBuilder::CToAST { static sem::Type* get(const ProgramBuilder::TypesBuilder* t) { return t->f32(); } }; template <> struct ProgramBuilder::TypesBuilder::CToAST { static sem::Type* get(const ProgramBuilder::TypesBuilder* t) { return t->bool_(); } }; template <> struct ProgramBuilder::TypesBuilder::CToAST { static sem::Type* get(const ProgramBuilder::TypesBuilder* t) { return t->void_(); } }; //! @endcond /// @param builder the ProgramBuilder /// @returns the ProgramID of the ProgramBuilder inline ProgramID ProgramIDOf(const ProgramBuilder* builder) { return builder->ID(); } } // namespace tint #endif // SRC_PROGRAM_BUILDER_H_