blob: b02de3a97c5f2682db3c1396ed601be04ae88460 [file] [log] [blame]
// Copyright 2023 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_LET_H_
#define SRC_TINT_LANG_CORE_IR_LET_H_
#include <string>
#include "src/tint/lang/core/ir/operand_instruction.h"
namespace tint::core::ir {
/// A no-op instruction in the IR, used to position and name a value
class Let final : public Castable<Let, OperandInstruction<1, 1>> {
public:
/// The offset in Operands() for the value
static constexpr size_t kValueOperandOffset = 0;
/// Constructor (no result, no operands)
Let();
/// Constructor
/// @param result the result value
/// @param value the let's value
Let(InstructionResult* result, Value* value);
~Let() override;
/// @copydoc Instruction::Clone()
Let* Clone(CloneContext& ctx) override;
/// @param value the new let value
void SetValue(ir::Value* value) { SetOperand(kValueOperandOffset, value); }
/// @returns the value
ir::Value* Value() { return Operand(kValueOperandOffset); }
/// @returns the value
const ir::Value* Value() const { return Operand(kValueOperandOffset); }
/// @returns the friendly name for the instruction
std::string FriendlyName() const override { return "let"; }
};
} // namespace tint::core::ir
#endif // SRC_TINT_LANG_CORE_IR_LET_H_