beenull/ladybird
1
0
Fork 0
mirror of https://github.com/LadybirdBrowser/ladybird.git synced 2024-11-25 00:50:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7
ladybird/AK/Error.h

143 lines
3.4 KiB
C
Raw Normal View History

AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
/*
* Copyright (c) 2021, Andreas Kling <kling@serenityos.org>
*
* SPDX-License-Identifier: BSD-2-Clause
*/
#pragma once
#include <AK/Optional.h>
#include <AK/StringView.h>
AK: Make Error.h pull in Try.h Users of this API will want TRY().
2021-11-07 23:35:58 +00:00
#include <AK/Try.h>
AK+Tests: Use less space in ErrorOr
2021-12-14 22:02:23 +00:00
#include <AK/Variant.h>
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
#if defined(__serenity__) && defined(KERNEL)
Kernel+LibC: Move errno definitions to Kernel/API/POSIX This fixes at least half of our LibC includes in the kernel. The source of truth for errno codes and their description strings now lives in Kernel/API/POSIX/errno.h as an enumeration, which LibC includes.
2021-09-12 11:29:28 +00:00
# include <LibC/errno_codes.h>
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
#else
# include <errno.h>
AK+LibMain: Improve formatter for AK::Error in userspace Print the full associated string metadata by default (if available.)
2021-12-20 10:55:32 +00:00
# include <string.h>
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
#endif
namespace AK {
class Error {
public:
static Error from_errno(int code) { return Error(code); }
AK+LibSystem+LibMain: Add Error::from_syscall() for syscall failures This creates an error that contains the name of the syscall that failed. This allows error handlers to print out the name of the call if they want to. :^)
2021-11-22 15:00:53 +00:00
static Error from_syscall(StringView syscall_name, int rc) { return Error(syscall_name, rc); }
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
static Error from_string_literal(StringView string_literal) { return Error(string_literal); }
AK: Add Error::operator==(Error const&)
2022-06-08 13:56:21 +00:00
bool operator==(Error const& other) const
{
return m_code == other.m_code && m_string_literal == other.m_string_literal && m_syscall == other.m_syscall;
}
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
bool is_errno() const { return m_code != 0; }
AK+LibSystem+LibMain: Add Error::from_syscall() for syscall failures This creates an error that contains the name of the syscall that failed. This allows error handlers to print out the name of the call if they want to. :^)
2021-11-22 15:00:53 +00:00
bool is_syscall() const { return m_syscall; }
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
int code() const { return m_code; }
StringView string_literal() const { return m_string_literal; }
AK: Allow subclassing Error
2021-11-07 00:30:35 +00:00
protected:
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
Error(int code)
: m_code(code)
{
}
AK: Allow subclassing Error
2021-11-07 00:30:35 +00:00
private:
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
Error(StringView string_literal)
: m_string_literal(string_literal)
{
}
AK+LibSystem+LibMain: Add Error::from_syscall() for syscall failures This creates an error that contains the name of the syscall that failed. This allows error handlers to print out the name of the call if they want to. :^)
2021-11-22 15:00:53 +00:00
Error(StringView syscall_name, int rc)
: m_code(-rc)
, m_string_literal(syscall_name)
, m_syscall(true)
{
}
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
int m_code { 0 };
StringView m_string_literal;
AK+LibSystem+LibMain: Add Error::from_syscall() for syscall failures This creates an error that contains the name of the syscall that failed. This allows error handlers to print out the name of the call if they want to. :^)
2021-11-22 15:00:53 +00:00
bool m_syscall { false };
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
};
AK: Forward declare Error and ErrorOr in AK/Forward.h
2021-11-15 23:41:28 +00:00
template<typename T, typename ErrorType>
AK+Tests: Use less space in ErrorOr
2021-12-14 22:02:23 +00:00
class [[nodiscard]] ErrorOr final : public Variant<T, ErrorType> {
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
public:
AK+Tests: Use less space in ErrorOr
2021-12-14 22:02:23 +00:00
using Variant<T, ErrorType>::Variant;
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
AK: Add some more ways to construct Error and ErrorOr<T> This is preparation for using Error in the kernel instead of KResult.
2021-11-07 23:36:35 +00:00
template<typename U>
ALWAYS_INLINE ErrorOr(U&& value) requires(!IsSame<RemoveCVReference<U>, ErrorOr<T>>)
AK+Tests: Use less space in ErrorOr
2021-12-14 22:02:23 +00:00
: Variant<T, ErrorType>(forward<U>(value))
AK: Add some more ways to construct Error and ErrorOr<T> This is preparation for using Error in the kernel instead of KResult.
2021-11-07 23:36:35 +00:00
{
}
AK: Make Error and ErrorOr<T> work in Lagom as well :^) ErrnoCode is not a thing outside __serenity__, so let's not make assumptions about it existing.
2021-11-06 21:16:50 +00:00
#ifdef __serenity__
ErrorOr(ErrnoCode code)
AK+Tests: Use less space in ErrorOr
2021-12-14 22:02:23 +00:00
: Variant<T, ErrorType>(Error::from_errno(code))
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
{
}
AK: Make Error and ErrorOr<T> work in Lagom as well :^) ErrnoCode is not a thing outside __serenity__, so let's not make assumptions about it existing.
2021-11-06 21:16:50 +00:00
#endif
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
AK+Tests: Use less space in ErrorOr
2021-12-14 22:02:23 +00:00
T& value()
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
{
AK+Tests: Use less space in ErrorOr
2021-12-14 22:02:23 +00:00
return this->template get<T>();
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
}
AK+Tests: Use less space in ErrorOr
2021-12-14 22:02:23 +00:00
T const& value() const { return this->template get<T>(); }
ErrorType& error() { return this->template get<ErrorType>(); }
ErrorType const& error() const { return this->template get<ErrorType>(); }
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
AK+Tests: Use less space in ErrorOr
2021-12-14 22:02:23 +00:00
bool is_error() const { return this->template has<ErrorType>(); }
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
AK+Tests: Use less space in ErrorOr
2021-12-14 22:02:23 +00:00
T release_value() { return move(value()); }
ErrorType release_error() { return move(error()); }
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
AK: VERIFY inside release_value_but_fixme_should_propagate_errors() While the code did already VERIFY that the ErrorOr holds a value, this was done by Variant, so the error message was just that `has<T>()` is false. This is less helpful than I would like, especially if backtraces are not working and this is all you have to go on. Adding this extra VERIFY means the assertion message (`!is_error()`) is easier to understand.
2022-02-06 12:49:51 +00:00
T release_value_but_fixme_should_propagate_errors()
{
VERIFY(!is_error());
return release_value();
}
AK: Add ErrorOr<T>::release_value_but_fixme_should_propagate_errors() This is an alternative to ErrorOr<T>::release_value() that can be used when converting code to signal that we're releasing the value without error propagation as a way to move forward now. This makes these cases much easier to find later on, once more paths for error propagation are available.
2021-11-06 10:29:32 +00:00
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
private:
AK+Tests: Use less space in ErrorOr
2021-12-14 22:02:23 +00:00
// 'downcast' is fishy in this context. Let's hide it by making it private.
using Variant<T, ErrorType>::downcast;
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
};
// Partial specialization for void value type
AK: Allow subclassing Error
2021-11-07 00:30:35 +00:00
template<typename ErrorType>
class [[nodiscard]] ErrorOr<void, ErrorType> {
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
public:
AK: Allow subclassing Error
2021-11-07 00:30:35 +00:00
ErrorOr(ErrorType error)
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
: m_error(move(error))
{
}
AK: Add some more ways to construct Error and ErrorOr<T> This is preparation for using Error in the kernel instead of KResult.
2021-11-07 23:36:35 +00:00
#ifdef __serenity__
ErrorOr(ErrnoCode code)
: m_error(Error::from_errno(code))
{
}
#endif
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
ErrorOr() = default;
ErrorOr(ErrorOr&& other) = default;
AK: Add some more ways to construct Error and ErrorOr<T> This is preparation for using Error in the kernel instead of KResult.
2021-11-07 23:36:35 +00:00
ErrorOr(ErrorOr const& other) = default;
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
~ErrorOr() = default;
AK: Add some more ways to construct Error and ErrorOr<T> This is preparation for using Error in the kernel instead of KResult.
2021-11-07 23:36:35 +00:00
ErrorOr& operator=(ErrorOr&& other) = default;
ErrorOr& operator=(ErrorOr const& other) = default;
AK: Allow subclassing Error
2021-11-07 00:30:35 +00:00
ErrorType& error() { return m_error.value(); }
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
bool is_error() const { return m_error.has_value(); }
AK: Allow subclassing Error
2021-11-07 00:30:35 +00:00
ErrorType release_error() { return m_error.release_value(); }
void release_value() { }
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
private:
AK: Allow subclassing Error
2021-11-07 00:30:35 +00:00
Optional<ErrorType> m_error;
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
};
}
AK: Bring AK::Error into the global namespace
2021-11-06 09:34:14 +00:00
using AK::Error;
AK: Add Error and ErrorOr<T> The goal with these is to eventually replace AK::Result, KResult and KResultOr<T> with something that works (and makes sense) in both kernel and userspace. This first cut of Error can be made from an errno code, or from a string literal (StringView)
2021-11-06 00:18:43 +00:00
using AK::ErrorOr;
Reference in a new issue Copy permalink