src/tint/lang/core/ir/builtin_call.h

// Copyright 2023 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_TINT_LANG_CORE_IR_BUILTIN_CALL_H_
#define SRC_TINT_LANG_CORE_IR_BUILTIN_CALL_H_

#include "src/tint/lang/core/intrinsic/table_data.h"
#include "src/tint/lang/core/ir/call.h"
#include "src/tint/utils/rtti/castable.h"

namespace tint::core::ir {

/// A builtin call instruction in the IR.
class BuiltinCall : public Castable<BuiltinCall, Call> {
  public:
    /// The base offset in Operands() for the args
    static constexpr size_t kArgsOperandOffset = 0;

    /// Constructor
    /// @param result the result value
    /// @param args the conversion arguments
    explicit BuiltinCall(InstructionResult* result, VectorRef<Value*> args = tint::Empty);
    ~BuiltinCall() override;

    /// @returns the identifier for the function
    virtual size_t FuncId() = 0;

    /// @returns the intrinsic name
    virtual const char* IntrinsicName() = 0;

    /// @returns the table data to validate this builtin
    virtual const core::intrinsic::TableData& TableData() = 0;
};

}  // namespace tint::core::ir

#endif  // SRC_TINT_LANG_CORE_IR_BUILTIN_CALL_H_