src/tint/lang/wgsl/ast/stride_attribute.h

// Copyright 2020 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_STRIDE_ATTRIBUTE_H_
#define SRC_TINT_LANG_WGSL_AST_STRIDE_ATTRIBUTE_H_

#include <string>

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

namespace tint::ast {

/// A stride attribute used by the SPIR-V reader for strided arrays and
/// matrices.
class StrideAttribute final : public utils::Castable<StrideAttribute, Attribute> {
  public:
    /// constructor
    /// @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 stride the stride value
    StrideAttribute(GenerationID pid, NodeID nid, const Source& src, uint32_t stride);
    ~StrideAttribute() 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 StrideAttribute* Clone(CloneContext* ctx) const override;

    /// The stride value
    const uint32_t stride;
};

}  // namespace tint::ast

#endif  // SRC_TINT_LANG_WGSL_AST_STRIDE_ATTRIBUTE_H_