src/tint/lang/wgsl/ast/index_attribute.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_WGSL_AST_INDEX_ATTRIBUTE_H_
#define SRC_TINT_LANG_WGSL_AST_INDEX_ATTRIBUTE_H_

#include <string>

#include "src/tint/lang/wgsl/ast/attribute.h"
#include "src/tint/lang/wgsl/ast/expression.h"

namespace tint::ast {

/// An id attribute for pipeline-overridable constants
class IndexAttribute final : public Castable<IndexAttribute, Attribute> {
  public:
    /// Create an index attribute.
    /// @param pid the identifier of the program that owns this node
    /// @param nid the unique node identifier
    /// @param src the source of this node
    /// @param expr the numeric id expression
    IndexAttribute(GenerationID pid, NodeID nid, const Source& src, const Expression* expr);
    ~IndexAttribute() override;

    /// @returns the WGSL name for the attribute
    std::string Name() const override;

    /// Clones this node and all transitive child nodes using the `CloneContext`
    /// `ctx`.
    /// @param ctx the clone context
    /// @return the newly cloned node
    const IndexAttribute* Clone(CloneContext& ctx) const override;

    /// The id expression
    const Expression* const expr;
};

}  // namespace tint::ast

#endif  // SRC_TINT_LANG_WGSL_AST_INDEX_ATTRIBUTE_H_