src/tint/type/reference.h

// Copyright 2022 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_TYPE_REFERENCE_H_
#define SRC_TINT_TYPE_REFERENCE_H_

#include <string>

#include "src/tint/builtin/access.h"
#include "src/tint/builtin/address_space.h"
#include "src/tint/type/type.h"

namespace tint::type {

/// A reference type.
class Reference final : public Castable<Reference, Type> {
  public:
    /// Constructor
    /// @param subtype the pointee type
    /// @param address_space the address space of the reference
    /// @param access the resolved access control of the reference
    Reference(const Type* subtype, builtin::AddressSpace address_space, builtin::Access access);

    /// Destructor
    ~Reference() override;

    /// @param other the other node to compare against
    /// @returns true if the this type is equal to @p other
    bool Equals(const UniqueNode& other) const override;

    /// @returns the pointee type
    const Type* StoreType() const { return subtype_; }

    /// @returns the address space of the reference
    builtin::AddressSpace AddressSpace() const { return address_space_; }

    /// @returns the resolved access control of the reference.
    builtin::Access Access() const { return access_; }

    /// @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;

    /// @param ctx the clone context
    /// @returns a clone of this type
    Reference* Clone(CloneContext& ctx) const override;

  private:
    Type const* const subtype_;
    builtin::AddressSpace const address_space_;
    builtin::Access const access_;
};

}  // namespace tint::type

#endif  // SRC_TINT_TYPE_REFERENCE_H_