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 <stddef.h>

#include <tuple>

#include "src/ast/function_decoration.h"

namespace tint {
namespace ast {

/// A workgroup decoration
class WorkgroupDecoration : public FunctionDecoration {
 public:
  /// The kind of decoration that this type represents
  static constexpr const DecorationKind Kind = DecorationKind::kWorkgroup;

  /// constructor
  /// @param x the workgroup x dimension size
  /// @param source the source of this decoration
  WorkgroupDecoration(uint32_t x, const Source& source);
  /// constructor
  /// @param x the workgroup x dimension size
  /// @param y the workgroup x dimension size
  /// @param source the source of this decoration
  WorkgroupDecoration(uint32_t x, uint32_t y, const Source& source);
  /// constructor
  /// @param x the workgroup x dimension size
  /// @param y the workgroup x dimension size
  /// @param z the workgroup x dimension size
  /// @param source the source of this decoration
  WorkgroupDecoration(uint32_t x, uint32_t y, uint32_t z, const Source& source);
  ~WorkgroupDecoration() override;

  /// @param kind the decoration kind
  /// @return true if this Decoration is of the (or derives from) the given
  /// kind.
  bool IsKind(DecorationKind kind) const override;

  /// @returns true if this is a workgroup decoration
  bool IsWorkgroup() const override;

  /// @returns the workgroup dimensions
  std::tuple<uint32_t, uint32_t, uint32_t> values() const {
    return {x_, y_, z_};
  }

  /// Outputs the decoration to the given stream
  /// @param out the stream to write to
  /// @param indent number of spaces to indent the node when writing
  void to_str(std::ostream& out, size_t indent) const override;

 private:
  uint32_t x_ = 1;
  uint32_t y_ = 1;
  uint32_t z_ = 1;
};

}  // namespace ast
}  // namespace tint

#endif  // SRC_AST_WORKGROUP_DECORATION_H_