mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-01-29 20:47:31 -03:00
42 lines
1.8 KiB
C
42 lines
1.8 KiB
C
|
// Copyright (c) 2019 The Bitcoin Core developers
|
||
|
// Distributed under the MIT software license, see the accompanying
|
||
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||
|
|
||
|
#ifndef BITCOIN_UTIL_CHECK_H
|
||
|
#define BITCOIN_UTIL_CHECK_H
|
||
|
|
||
|
#include <tinyformat.h>
|
||
|
|
||
|
#include <stdexcept>
|
||
|
|
||
|
class NonFatalCheckError : public std::runtime_error
|
||
|
{
|
||
|
using std::runtime_error::runtime_error;
|
||
|
};
|
||
|
|
||
|
/**
|
||
|
* Throw a NonFatalCheckError when the condition evaluates to false
|
||
|
*
|
||
|
* This should only be used
|
||
|
* - where the condition is assumed to be true, not for error handling or validating user input
|
||
|
* - where a failure to fulfill the condition is recoverable and does not abort the program
|
||
|
*
|
||
|
* For example in RPC code, where it is undersirable to crash the whole program, this can be generally used to replace
|
||
|
* asserts or recoverable logic errors. A NonFatalCheckError in RPC code is caught and passed as a string to the RPC
|
||
|
* caller, which can then report the issue to the developers.
|
||
|
*/
|
||
|
#define CHECK_NONFATAL(condition) \
|
||
|
do { \
|
||
|
if (!(condition)) { \
|
||
|
throw NonFatalCheckError( \
|
||
|
strprintf("%s:%d (%s)\n" \
|
||
|
"Internal bug detected: '%s'\n" \
|
||
|
"You may report this issue here: %s\n", \
|
||
|
__FILE__, __LINE__, __func__, \
|
||
|
(#condition), \
|
||
|
PACKAGE_BUGREPORT)); \
|
||
|
} \
|
||
|
} while (false)
|
||
|
|
||
|
#endif // BITCOIN_UTIL_CHECK_H
|