blob: 54d0ee41f4c62424f057978b7ed0dfa3b3e29315 [file] [log] [blame]
// 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_NATIVE_ERRORSINK_H_
#define SRC_DAWN_NATIVE_ERRORSINK_H_
#include <memory>
#include <utility>
#include "dawn/native/Error.h"
#include "dawn/native/ErrorData.h"
namespace dawn::native {
class ErrorSink {
public:
virtual ~ErrorSink() = default;
// Variants of ConsumedError must use the returned boolean to handle failure cases since an
// error may cause a fatal error and further execution may be undefined. This is especially
// true for the ResultOrError variants.
[[nodiscard]] bool ConsumedError(
MaybeError maybeError,
InternalErrorType additionalAllowedErrors = InternalErrorType::None) {
if (DAWN_UNLIKELY(maybeError.IsError())) {
ConsumeError(maybeError.AcquireError(), additionalAllowedErrors);
return true;
}
return false;
}
template <typename... Args>
[[nodiscard]] bool ConsumedError(MaybeError maybeError,
InternalErrorType additionalAllowedErrors,
const char* formatStr,
const Args&... args) {
if (DAWN_UNLIKELY(maybeError.IsError())) {
std::unique_ptr<ErrorData> error = maybeError.AcquireError();
if (error->GetType() == InternalErrorType::Validation) {
error->AppendContext(formatStr, args...);
}
ConsumeError(std::move(error), additionalAllowedErrors);
return true;
}
return false;
}
template <typename... Args>
[[nodiscard]] bool ConsumedError(MaybeError maybeError,
const char* formatStr,
const Args&... args) {
return ConsumedError(std::move(maybeError), InternalErrorType::None, formatStr, args...);
}
template <typename T>
[[nodiscard]] bool ConsumedError(
ResultOrError<T> resultOrError,
T* result,
InternalErrorType additionalAllowedErrors = InternalErrorType::None) {
if (DAWN_UNLIKELY(resultOrError.IsError())) {
ConsumeError(resultOrError.AcquireError(), additionalAllowedErrors);
return true;
}
*result = resultOrError.AcquireSuccess();
return false;
}
template <typename T, typename... Args>
[[nodiscard]] bool ConsumedError(ResultOrError<T> resultOrError,
T* result,
InternalErrorType additionalAllowedErrors,
const char* formatStr,
const Args&... args) {
if (DAWN_UNLIKELY(resultOrError.IsError())) {
std::unique_ptr<ErrorData> error = resultOrError.AcquireError();
if (error->GetType() == InternalErrorType::Validation) {
error->AppendContext(formatStr, args...);
}
ConsumeError(std::move(error), additionalAllowedErrors);
return true;
}
*result = resultOrError.AcquireSuccess();
return false;
}
template <typename T, typename... Args>
[[nodiscard]] bool ConsumedError(ResultOrError<T> resultOrError,
T* result,
const char* formatStr,
const Args&... args) {
return ConsumedError(std::move(resultOrError), result, InternalErrorType::None, formatStr,
args...);
}
private:
virtual void ConsumeError(
std::unique_ptr<ErrorData> error,
InternalErrorType additionalAllowedErrors = InternalErrorType::None) = 0;
};
} // namespace dawn::native
#endif // SRC_DAWN_NATIVE_ERRORSINK_H_