You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
99 lines
2.9 KiB
C
99 lines
2.9 KiB
C
/* See the end of this file for copyright and license terms. */
|
|
|
|
#pragma once
|
|
|
|
#include "neo/_toolchain.h"
|
|
#include "neo/_types.h"
|
|
|
|
/**
|
|
* @defgroup error Error Handling
|
|
*
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* @brief Throw an error. If `err` is `nil`, the program halts.
|
|
*
|
|
* Functions accepting an `error` object must call either `yeet()` or `neat()`
|
|
* on the object exactly once, or the behavior is undefined.
|
|
* If a function yeets an error, its return value is undefined.
|
|
*
|
|
* @param err The error pointer passed to the callee
|
|
* @param number An error number appropriate for the condition,
|
|
* usually one from `errno.h`
|
|
* @param fmt If non `nil`, a printf-style format string followed by
|
|
* the values to insert which will become the error message.
|
|
*/
|
|
void yeet(error *err, u32 number, const char *restrict fmt, ...)
|
|
__attribute__(( __format__(printf, 3, 4) ));
|
|
|
|
/**
|
|
* Indicate an operation has completed successfully.
|
|
* Functions accepting an `error` pointer must call either `yeet()` or `neat()`,
|
|
* or the begavior is undefined.
|
|
*
|
|
* @param err Error object
|
|
*/
|
|
void neat(error *err);
|
|
|
|
/**
|
|
* @brief Release any resources allocated for an error.
|
|
*
|
|
* This must always be called within the catch block of the outermost calling
|
|
* function, i.e. the one that declared the error variable (not the ones just
|
|
* accepting an `error *` argument and passing it through to further calls).
|
|
*
|
|
* Put another way, you probably need to call this if you had to put an `&`
|
|
* before the error variable for passing it into `catch()`.
|
|
*
|
|
* @param err Error object to destroy
|
|
*/
|
|
void errput(error *err);
|
|
|
|
/**
|
|
* @brief Catch an error.
|
|
*
|
|
* Execute the expression after this macro call if the error pointed to
|
|
* by `err` is an actual error, i.e. it has been `yeet()`ed to.
|
|
* Resources for the error must be released using `nput()`.
|
|
*/
|
|
#define ncatch(err) if ((err) != nil && (err)->_number != 0)
|
|
#ifndef __cplusplus
|
|
# define catch(err) ncatch(err)
|
|
#endif
|
|
|
|
/**
|
|
* @brief Get the error number.
|
|
*
|
|
* Must only be used within a catch block and before `errput()` is called.
|
|
*
|
|
* @param err `error *` to get the number of
|
|
* @returns The error number
|
|
*/
|
|
#define errnum(err) ((err) == nil ? 0 : (err)->_number)
|
|
|
|
/**
|
|
* @brief Get an optional error message, this may be `nil`.
|
|
*
|
|
* Must only be used within a catch block and before `errput()` is called.
|
|
*
|
|
* @param err `error *` to get the message of
|
|
* @returns The error message, may be `nil`
|
|
*/
|
|
#define errmsg(err) ((err) == nil ? (nstr_t *)nil : (err)->_message)
|
|
|
|
/** @} */
|
|
|
|
/*
|
|
* This file is part of libneo.
|
|
* Copyright (c) 2021 Fefie <owo@fef.moe>.
|
|
*
|
|
* libneo is non-violent software: you may only use, redistribute,
|
|
* and/or modify it under the terms of the CNPLv6+ as found in
|
|
* the LICENSE file in the source code root directory or at
|
|
* <https://git.pixie.town/thufie/CNPL>.
|
|
*
|
|
* libneo comes with ABSOLUTELY NO WARRANTY, to the extent
|
|
* permitted by applicable law. See the CNPLv6+ for details.
|
|
*/
|