// 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_DAWN_COMMON_STACKALLOCATED_H_
#define SRC_DAWN_COMMON_STACKALLOCATED_H_

#include <cstddef>

namespace dawn {

#ifdef __clang__
#define STACK_ALLOCATED_IGNORE(reason) __attribute__((annotate("stack_allocated_ignore")))
#else  // __clang__
#define STACK_ALLOCATED_IGNORE(reason)
#endif  // __clang__

// If a class depends on the StackAllocated base class, then instances may not be allocated on the
// heap.
//
// This is similar to chromium's STACK_ALLOCATED() macro.
class StackAllocated {
  private:
    // This is a marker type used by several clang plugins to identify stack allocated types. It is
    // not used by the code itself.
    using IsStackAllocatedTypeMarker [[maybe_unused]] = int;

    void* operator new(size_t) = delete;
    void* operator new(size_t, void*) = delete;
};

}  // namespace dawn

#endif  // SRC_DAWN_COMMON_STACKALLOCATED_H_
