Jacques Lucke
433fb9326e
This adds a `BLI_assert_unreachable()` macro, that should be used instead of `BLI_assert(false)` in many places. * `BLI_assert_unreachable` provides more information than `BLI_assert(false)` to people reading the code. * `BLI_assert_unreachable` will print an error to `stderr` in a release build. This makes it more likely that we will get bug reports when the assumptions of a developer were wrong. Differential Revision: https://developer.blender.org/D10780
58 lines
1.8 KiB
C
58 lines
1.8 KiB
C
/*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
*/
|
|
|
|
/** \file
|
|
* \ingroup bli
|
|
*
|
|
* Helper functions for BLI_assert.h header.
|
|
*/
|
|
|
|
#include "BLI_assert.h" /* Own include. */
|
|
#include "BLI_system.h"
|
|
|
|
#include <stdio.h>
|
|
#include <stdlib.h>
|
|
|
|
void _BLI_assert_print_pos(const char *file, const int line, const char *function, const char *id)
|
|
{
|
|
fprintf(stderr, "BLI_assert failed: %s:%d, %s(), at \'%s\'\n", file, line, function, id);
|
|
}
|
|
|
|
void _BLI_assert_unreachable_print(const char *file, const int line, const char *function)
|
|
{
|
|
fprintf(stderr, "Code marked as unreachable has been executed. Please report this as a bug.\n");
|
|
fprintf(stderr, "Error found at %s:%d in %s.\n", file, line, function);
|
|
}
|
|
|
|
void _BLI_assert_print_backtrace(void)
|
|
{
|
|
#ifndef NDEBUG
|
|
BLI_system_backtrace(stderr);
|
|
#endif
|
|
}
|
|
|
|
/**
|
|
* Wrap to remove 'noreturn' attribute since this suppresses missing return statements,
|
|
* allowing changes to debug builds to accidentally to break release builds.
|
|
*
|
|
* For example `BLI_assert(0);` at the end of a function that returns a value,
|
|
* will hide that it's missing a return.
|
|
*/
|
|
void _BLI_assert_abort(void)
|
|
{
|
|
abort();
|
|
}
|