src/ast/workgroup_decoration.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_AST_WORKGROUP_DECORATION_H_
#define SRC_AST_WORKGROUP_DECORATION_H_

#include <array>
#include <string>

#include "src/ast/decoration.h"

namespace tint {
namespace ast {

// Forward declaration
class Expression;

/// A workgroup decoration
class WorkgroupDecoration : public Castable<WorkgroupDecoration, Decoration> {
 public:
  /// constructor
  /// @param pid the identifier of the program that owns this node
  /// @param src the source of this node
  /// @param x the workgroup x dimension expression
  /// @param y the optional workgroup y dimension expression
  /// @param z the optional workgroup z dimension expression
  WorkgroupDecoration(ProgramID pid,
                      const Source& src,
                      const ast::Expression* x,
                      const ast::Expression* y = nullptr,
                      const ast::Expression* z = nullptr);

  ~WorkgroupDecoration() override;

  /// @returns the workgroup dimensions
  std::array<const ast::Expression*, 3> Values() const { return {x, y, z}; }

  /// @returns the WGSL name for the decoration
  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 WorkgroupDecoration* Clone(CloneContext* ctx) const override;

  /// The workgroup x dimension.
  const ast::Expression* const x;
  /// The optional workgroup y dimension. May be null.
  const ast::Expression* const y = nullptr;
  /// The optional workgroup z dimension. May be null.
  const ast::Expression* const z = nullptr;
};

}  // namespace ast
}  // namespace tint

#endif  // SRC_AST_WORKGROUP_DECORATION_H_