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

// Copyright 2024 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_IR_MEMBER_BUILTIN_CALL_H_
#define SRC_TINT_LANG_CORE_IR_MEMBER_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 {

/// The base class for member builtin call instructions in the IR.
class MemberBuiltinCall : public Castable<MemberBuiltinCall, Call> {
  public:
    /// The offset in Operands() for the object.
    static constexpr size_t kObjectOperandOffset = 0;

    /// The base offset in Operands() for the args
    static constexpr size_t kArgsOperandOffset = 1;

    /// The fixed number of results returned by this instruction
    static constexpr size_t kNumResults = 1;

    /// Constructor (no results, no operands)
    /// @param id the instruction id
    explicit MemberBuiltinCall(Id id);

    /// Constructor
    /// @param id the instruction id
    /// @param result the result value
    /// @param object the object
    /// @param args the call arguments
    MemberBuiltinCall(Id id,
                      InstructionResult* result,
                      Value* object,
                      VectorRef<Value*> args = tint::Empty);

    ~MemberBuiltinCall() override;

    /// @returns the offset of the arguments in Operands()
    size_t ArgsOperandOffset() const override { return kArgsOperandOffset; }

    /// @returns the object used for the call
    Value* Object() { return Operand(kObjectOperandOffset); }

    /// @returns the object used for the call
    const Value* Object() const { return Operand(kObjectOperandOffset); }

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

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

}  // namespace tint::core::ir

#endif  // SRC_TINT_LANG_CORE_IR_MEMBER_BUILTIN_CALL_H_