// Copyright 2021 The Dawn & Tint Authors // // 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. // // 3. Neither the name of the copyright holder nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT HOLDER OR 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. #ifndef SRC_TINT_LANG_CORE_INTRINSIC_TABLE_H_ #define SRC_TINT_LANG_CORE_INTRINSIC_TABLE_H_ #include <memory> #include <string> #include <utility> #include "src/tint/lang/core/binary_op.h" #include "src/tint/lang/core/builtin_fn.h" #include "src/tint/lang/core/evaluation_stage.h" #include "src/tint/lang/core/intrinsic/ctor_conv.h" #include "src/tint/lang/core/intrinsic/table_data.h" #include "src/tint/lang/core/parameter_usage.h" #include "src/tint/lang/core/unary_op.h" #include "src/tint/utils/containers/vector.h" #include "src/tint/utils/text/string.h" #include "src/tint/utils/text/string_stream.h" #include "src/tint/utils/text/styled_text.h" // Forward declarations namespace tint::diag { class List; } // namespace tint::diag namespace tint::core::intrinsic { /// Overload describes a fully matched builtin function overload struct Overload { … }; /// The context data used to lookup intrinsic information struct Context { … }; /// Candidate holds information about an overload evaluated for resolution. struct Candidate { … }; // Prints the candidate overload for emitting diagnostics void PrintCandidate(StyledText& ss, Context& context, const Candidate& candidate, std::string_view intrinsic_name, VectorRef<const core::type::Type*> template_args, VectorRef<const core::type::Type*> args); /// Lookup looks for the builtin overload with the given signature, raising an error diagnostic /// if the builtin was not found. /// @param context the intrinsic context /// @param function_name the name of the function /// @param function_id the function identifier /// @param template_args the optional template arguments /// @param args the argument types passed to the builtin function /// @param earliest_eval_stage the the earliest evaluation stage that a call to /// the builtin can be made. This can alter the overloads considered. /// For example, if the earliest evaluation stage is `EvaluationStage::kRuntime`, then /// only overloads with concrete argument types will be considered, as all /// abstract-numerics will have been materialized after shader creation time /// (EvaluationStage::kConstant). /// @return the resolved builtin function overload Result<Overload, StyledText> LookupFn(Context& context, std::string_view function_name, size_t function_id, VectorRef<const core::type::Type*> template_args, VectorRef<const core::type::Type*> args, EvaluationStage earliest_eval_stage); /// Lookup looks for the member builtin overload with the given signature, raising an error /// diagnostic if the builtin was not found. /// @param context the intrinsic context /// @param function_name the name of the function /// @param function_id the function identifier /// @param template_args the optional template arguments /// @param args the argument types passed to the builtin function /// @param earliest_eval_stage the the earliest evaluation stage that a call to /// the builtin can be made. This can alter the overloads considered. /// For example, if the earliest evaluation stage is `EvaluationStage::kRuntime`, then /// only overloads with concrete argument types will be considered, as all /// abstract-numerics will have been materialized after shader creation time /// (EvaluationStage::kConstant). /// @return the resolved builtin function overload Result<Overload, StyledText> LookupMemberFn(Context& context, std::string_view function_name, size_t function_id, VectorRef<const core::type::Type*> template_args, VectorRef<const core::type::Type*> args, EvaluationStage earliest_eval_stage); /// Lookup looks for the unary op overload with the given signature, raising an error /// diagnostic if the operator was not found. /// @param context the intrinsic context /// @param op the unary operator /// @param arg the type of the expression passed to the operator /// @param earliest_eval_stage the the earliest evaluation stage that a call to /// the unary operator can be made. This can alter the overloads considered. /// For example, if the earliest evaluation stage is /// `EvaluationStage::kRuntime`, then only overloads with concrete argument types /// will be considered, as all abstract-numerics will have been materialized /// after shader creation time (EvaluationStage::kConstant). /// @return the resolved unary operator overload Result<Overload, StyledText> LookupUnary(Context& context, core::UnaryOp op, const core::type::Type* arg, EvaluationStage earliest_eval_stage); /// Lookup looks for the binary op overload with the given signature, raising an error /// diagnostic if the operator was not found. /// @param context the intrinsic context /// @param op the binary operator /// @param lhs the LHS value type passed to the operator /// @param rhs the RHS value type passed to the operator /// @param earliest_eval_stage the the earliest evaluation stage that a call to /// the binary operator can be made. This can alter the overloads considered. /// For example, if the earliest evaluation stage is /// `EvaluationStage::kRuntime`, then only overloads with concrete argument types /// will be considered, as all abstract-numerics will have been materialized /// after shader creation time (EvaluationStage::kConstant). /// @param is_compound true if the binary operator is being used as a compound assignment /// @return the resolved binary operator overload Result<Overload, StyledText> LookupBinary(Context& context, core::BinaryOp op, const core::type::Type* lhs, const core::type::Type* rhs, EvaluationStage earliest_eval_stage, bool is_compound); /// Lookup looks for the value constructor or conversion overload for the given CtorConv. /// @param context the intrinsic context /// @param type_name the name of the type being constructed or converted /// @param type_id the type identifier /// @param template_args the optional template arguments /// @param args the argument types passed to the constructor / conversion call /// @param earliest_eval_stage the the earliest evaluation stage that a call to /// the constructor or conversion can be made. This can alter the overloads considered. /// For example, if the earliest evaluation stage is /// `EvaluationStage::kRuntime`, then only overloads with concrete argument types /// will be considered, as all abstract-numerics will have been materialized /// after shader creation time (EvaluationStage::kConstant). /// @return the resolved type constructor or conversion function overload Result<Overload, StyledText> LookupCtorConv(Context& context, std::string_view type_name, size_t type_id, VectorRef<const core::type::Type*> template_args, VectorRef<const core::type::Type*> args, EvaluationStage earliest_eval_stage); /// Table is a wrapper around a dialect to provide type-safe interface to the intrinsic table. template <typename DIALECT> struct Table { … }; } // namespace tint::core::intrinsic namespace tint { /// Hasher specialization for core::intrinsic::Overload template <> struct Hasher<core::intrinsic::Overload> { … }; } // namespace tint #endif // SRC_TINT_LANG_CORE_INTRINSIC_TABLE_H_