src/tint/lang/core/ir/transform/substitute_overrides.h

// Copyright 2024 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef SRC_TINT_LANG_CORE_IR_TRANSFORM_SUBSTITUTE_OVERRIDES_H_
#define SRC_TINT_LANG_CORE_IR_TRANSFORM_SUBSTITUTE_OVERRIDES_H_

#include <unordered_map>

#include "src/tint/api/common/override_id.h"
#include "src/tint/lang/core/ir/validator.h"
#include "src/tint/utils/reflection.h"
#include "src/tint/utils/result.h"

// Forward declarations.
namespace tint::core::ir {
class Module;
}

namespace tint::core::ir::transform {

/// The capabilities that the transform can support.
const core::ir::Capabilities kSubstituteOverridesCapabilities{
    core::ir::Capability::kAllowOverrides,
};

/// Configuration options for the transform
struct SubstituteOverridesConfig {
    /// Constructor
    SubstituteOverridesConfig();

    /// Copy constructor
    SubstituteOverridesConfig(const SubstituteOverridesConfig&) = default;

    /// Destructor
    ~SubstituteOverridesConfig() = default;

    /// Assignment operator
    /// @returns this config
    SubstituteOverridesConfig& operator=(const SubstituteOverridesConfig&) = default;

    /// The map of override identifier to the override value.
    /// The value is always a double coming into the transform and will be
    /// converted to the correct type through and initializer.
    std::unordered_map<OverrideId, double> map;

    /// Reflect the fields of this class so that it can be used by tint::ForeachField()
    TINT_REFLECT(SubstituteOverridesConfig, map);
};

/// Substitute overrides to their constant values.
/// @param module the module to transform
/// @returns success or failure
Result<SuccessType> SubstituteOverrides(Module& module, const SubstituteOverridesConfig& cfg);

}  // namespace tint::core::ir::transform

#endif  // SRC_TINT_LANG_CORE_IR_TRANSFORM_SUBSTITUTE_OVERRIDES_H_