src/transform/calculate_array_length.h

// Copyright 2021 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_TRANSFORM_CALCULATE_ARRAY_LENGTH_H_
#define SRC_TRANSFORM_CALCULATE_ARRAY_LENGTH_H_

#include <string>

#include "src/ast/internal_attribute.h"
#include "src/transform/transform.h"

namespace tint {

// Forward declarations
class CloneContext;

namespace transform {

/// CalculateArrayLength is a transform used to replace calls to arrayLength()
/// with a value calculated from the size of the storage buffer.
///
/// @note Depends on the following transforms to have been run first:
/// * SimplifyPointers
class CalculateArrayLength : public Castable<CalculateArrayLength, Transform> {
 public:
  /// BufferSizeIntrinsic is an InternalAttribute that's applied to intrinsic
  /// functions used to obtain the runtime size of a storage buffer.
  class BufferSizeIntrinsic
      : public Castable<BufferSizeIntrinsic, ast::InternalAttribute> {
   public:
    /// Constructor
    /// @param program_id the identifier of the program that owns this node
    explicit BufferSizeIntrinsic(ProgramID program_id);
    /// Destructor
    ~BufferSizeIntrinsic() override;

    /// @return "buffer_size"
    std::string InternalName() const override;

    /// Performs a deep clone of this object using the CloneContext `ctx`.
    /// @param ctx the clone context
    /// @return the newly cloned object
    const BufferSizeIntrinsic* Clone(CloneContext* ctx) const override;
  };

  /// Constructor
  CalculateArrayLength();
  /// Destructor
  ~CalculateArrayLength() override;

  /// @param program the program to inspect
  /// @param data optional extra transform-specific input data
  /// @returns true if this transform should be run for the given program
  bool ShouldRun(const Program* program,
                 const DataMap& data = {}) const override;

 protected:
  /// Runs the transform using the CloneContext built for transforming a
  /// program. Run() is responsible for calling Clone() on the CloneContext.
  /// @param ctx the CloneContext primed with the input program and
  /// ProgramBuilder
  /// @param inputs optional extra transform-specific input data
  /// @param outputs optional extra transform-specific output data
  void Run(CloneContext& ctx,
           const DataMap& inputs,
           DataMap& outputs) const override;
};

}  // namespace transform
}  // namespace tint

#endif  // SRC_TRANSFORM_CALCULATE_ARRAY_LENGTH_H_