dawn-cmake/src/ast/struct.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_STRUCT_H_
#define SRC_AST_STRUCT_H_

#include <string>
#include <utility>

#include "src/ast/decoration.h"
#include "src/ast/struct_member.h"
#include "src/ast/type.h"

namespace tint {
namespace ast {

/// A struct statement.
class Struct : public Castable<Struct, Type> {
 public:
  /// Create a new struct statement
  /// @param program_id the identifier of the program that owns this node
  /// @param source The input source for the import statement
  /// @param name The name of the structure
  /// @param members The struct members
  /// @param decorations The struct decorations
  Struct(ProgramID program_id,
         const Source& source,
         Symbol name,
         StructMemberList members,
         DecorationList decorations);
  /// Move constructor
  Struct(Struct&&);

  ~Struct() override;

  /// @returns the name of the structure
  Symbol name() const { return name_; }

  /// @returns the struct decorations
  const DecorationList& decorations() const { return decorations_; }

  /// @returns the members
  const StructMemberList& members() const { return members_; }

  /// Returns the struct member with the given symbol or nullptr if non exists.
  /// @param symbol the symbol of the member
  /// @returns the struct member or nullptr if not found
  StructMember* get_member(const Symbol& symbol) const;

  /// @returns true if the struct is block decorated
  bool IsBlockDecorated() const;

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

  /// Writes a representation of the node to the output stream
  /// @param sem the semantic info for the program
  /// @param out the stream to write to
  /// @param indent number of spaces to indent the node when writing
  void to_str(const sem::Info& sem,
              std::ostream& out,
              size_t indent) const override;

  /// @returns the name for the type
  std::string type_name() const override;

  /// @param symbols the program's symbol table
  /// @returns the name for this type that closely resembles how it would be
  /// declared in WGSL.
  std::string FriendlyName(const SymbolTable& symbols) const override;

 private:
  Struct(const Struct&) = delete;

  Symbol const name_;
  StructMemberList const members_;
  DecorationList const decorations_;
};

}  // namespace ast
}  // namespace tint

#endif  // SRC_AST_STRUCT_H_