Julian Eisel
280dac323c
It always bothered me that we'd do the `BLI_assert(... || !"message")` trick to
print a message alongside the assert, while it should be trivial to have a way
to pass an extra string as additional argument.
This adds `BLI_assert_msg()` with a second argument for a message. E.g.:
```
BLI_assert_msg(
params->rename_id == NULL,
"File rename handling should immediately clear rename_id when done, because otherwise it will keep taking precedence over renamefile.");
```
On failure this will print like this:
```
0 Blender 0x00000001140647a3 BLI_system_backtrace + 291
[...]
13 Blender 0x00000001092647a6 main + 3814
14 libdyld.dylib 0x00007fff203d8f5d start + 1
BLI_assert failed: source/blender/editors/space_file/file_ops.c:2352, file_directory_new_exec(), at 'params->rename_id == ((void*)0)'
File rename handling should immediately clear rename_id when done, because otherwise it will keep taking precedence over renamefile.
```
Reviewed by: Sybren Stüvel, Jacques Lucke, Sergey Sharybin, Campbell Barton
Differential Revision: https://developer.blender.org/D11827
63 lines
1.9 KiB
C
63 lines
1.9 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_print_extra(const char *str)
|
|
{
|
|
fprintf(stderr, " %s\n", str);
|
|
}
|
|
|
|
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();
|
|
}
|