// Copyright 2023 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.

////////////////////////////////////////////////////////////////////////////////
// File generated by 'tools/src/cmd/gen' using the template:
//   src/tint/lang/msl/builtin_fn.h.tmpl
//
// To regenerate run: './tools/run gen'
//
//                       Do not modify this file directly
////////////////////////////////////////////////////////////////////////////////

#ifndef SRC_TINT_LANG_MSL_BUILTIN_FN_H_
#define SRC_TINT_LANG_MSL_BUILTIN_FN_H_

// clang-format off

#include <cstdint>
#include <string>

#include "src/tint/utils/rtti/traits.h"
#include "src/tint/lang/core/ir/call.h"

// \cond DO_NOT_DOCUMENT
namespace tint::msl {

/// Enumerator of all builtin functions
enum class BuiltinFn : uint8_t {
    kAtomicCompareExchangeWeakExplicit,
    kAtomicExchangeExplicit,
    kAtomicFetchAddExplicit,
    kAtomicFetchAndExplicit,
    kAtomicFetchMaxExplicit,
    kAtomicFetchMinExplicit,
    kAtomicFetchOrExplicit,
    kAtomicFetchSubExplicit,
    kAtomicFetchXorExplicit,
    kAtomicLoadExplicit,
    kAtomicStoreExplicit,
    kAtomicMaxExplicit,
    kAtomicMinExplicit,
    kFence,
    kGather,
    kGatherCompare,
    kGetWidth,
    kGetHeight,
    kGetDepth,
    kGetArraySize,
    kGetNumMipLevels,
    kGetNumSamples,
    kRead,
    kSample,
    kSampleCompare,
    kWrite,
    kDistance,
    kDot,
    kFmod,
    kFrexp,
    kLength,
    kModf,
    kSign,
    kThreadgroupBarrier,
    kSimdBallot,
    kQuadShuffleXor,
    kConvert,
    kMakeFilledSimdgroupMatrix,
    kMakeDiagonalSimdgroupMatrix,
    kSimdgroupLoad,
    kSimdgroupStore,
    kSimdgroupMultiply,
    kSimdgroupMultiplyAccumulate,
    kOsLog,
    kPointerOffset,
    kNone,
};

/// @returns the name of the builtin function type.
const char* str(BuiltinFn i);

/// Emits the name of the builtin function type.
template <typename STREAM>
    requires(traits::IsOStream<STREAM>)
auto& operator<<(STREAM& o, BuiltinFn i) {
  return o << str(i);
}

/// @returns access restrictions for a function
tint::core::ir::Instruction::Accesses GetSideEffects(BuiltinFn fn);

}  // namespace tint::msl
// \endcond

// clang-format on

#endif  // SRC_TINT_LANG_MSL_BUILTIN_FN_H_
