src/tint/ast/matrix.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_AST_MATRIX_H_
#define SRC_TINT_AST_MATRIX_H_

#include <string>

#include "src/tint/ast/type.h"

namespace tint::ast {

/// A matrix type
class Matrix final : public Castable<Matrix, Type> {
  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 subtype the declared type of the matrix components. May be null for
    ///        matrix constructors, where the element type will be inferred from
    ///        the constructor arguments
    /// @param rows the number of rows in the matrix
    /// @param columns the number of columns in the matrix
    Matrix(ProgramID pid,
           NodeID nid,
           const Source& src,
           const Type* subtype,
           uint32_t rows,
           uint32_t columns);
    /// Move constructor
    Matrix(Matrix&&);
    ~Matrix() 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;

    /// Clones this type and all transitive types using the `CloneContext` `ctx`.
    /// @param ctx the clone context
    /// @return the newly cloned type
    const Matrix* Clone(CloneContext* ctx) const override;

    /// The declared type of the matrix components. May be null for matrix
    /// constructors, where the element type will be inferred from the constructor
    /// arguments
    const Type* const type;

    /// The number of rows in the matrix
    const uint32_t rows;

    /// The number of columns in the matrix
    const uint32_t columns;
};

}  // namespace tint::ast

#endif  // SRC_TINT_AST_MATRIX_H_