home/src/assert.hh

#ifndef assert_hh_INCLUDED
#define assert_hh_INCLUDED

namespace Kakoune
{

class StringView;

// return true if user asked to ignore the error
bool notify_fatal_error(StringView message);

void on_assert_failed(const char* message);

}

#define STRINGIFY(X) #X
#define TOSTRING(X) STRINGIFY(X)

#ifdef KAK_DEBUG
    #define kak_assert(...) do { \
        if (not (__VA_ARGS__)) \
            on_assert_failed("assert failed \"" #__VA_ARGS__ \
                             "\" at " __FILE__ ":" TOSTRING(__LINE__)); \
    } while (false)

    #define kak_expect_throw(exception_type, ...) try {\
        __VA_ARGS__; \
        on_assert_failed("expression \"" #__VA_ARGS__ \
                         "\" did not throw \"" #exception_type \
                         "\" at " __FILE__ ":" TOSTRING(__LINE__)); \
    } catch (exception_type &err) {}
#else
    #define kak_assert(...) do { (void)sizeof(__VA_ARGS__); } while(false)
    #define kak_expect_throw(_, ...) do { (void)sizeof(__VA_ARGS__); } while(false)
#endif


#endif // assert_hh_INCLUDED
assert: custom implementation 2011-09-09 21:24:18 +02:00			`#ifndef assert_hh_INCLUDED`
			`#define assert_hh_INCLUDED`

			`namespace Kakoune`
			`{`

Use a StringView in notify_fatal_error 2016-02-29 23:15:36 +01:00			`class StringView;`
Extract xmessage/MessageBox support in a notify_fatal_error function 2015-05-29 14:35:09 +02:00
			`// return true if user asked to ignore the error`
Use a StringView in notify_fatal_error 2016-02-29 23:15:36 +01:00			`bool notify_fatal_error(StringView message);`
Extract xmessage/MessageBox support in a notify_fatal_error function 2015-05-29 14:35:09 +02:00
assert: simplify header 2012-10-17 17:01:08 +02:00			`void on_assert_failed(const char* message);`
assert: use xmessage to block on assert failed 2012-10-16 16:16:32 +02:00
assert: custom implementation 2011-09-09 21:24:18 +02:00			`}`

			`#define STRINGIFY(X) #X`
			`#define TOSTRING(X) STRINGIFY(X)`

Add a debug option to Makefile, and use KAK_DEBUG define to remove debug code 2013-02-27 19:02:01 +01:00			`#ifdef KAK_DEBUG`
Properly wrap `kak_assert` into a do-while scope Expanding the `kak_assert` macro to either an `if` statement or nothing leads to issues when the macro is used in a conditional statement that doesn't use braces. Example: ncurses_ui.cc:476, in non debug mode, the macro will expand to an empty line, resulting in the `ungetch` call not being executed if the `ioctl` call succeeds (line 448). 2017-02-19 15:37:32 +01:00			`#define kak_assert(...) do { \`
Use variadic macros for kak_assert to remove the need for COMMA 2016-05-17 20:39:55 +02:00			`if (not (__VA_ARGS__)) \`
			`on_assert_failed("assert failed \"" #__VA_ARGS__ \`
Properly wrap `kak_assert` into a do-while scope Expanding the `kak_assert` macro to either an `if` statement or nothing leads to issues when the macro is used in a conditional statement that doesn't use braces. Example: ncurses_ui.cc:476, in non debug mode, the macro will expand to an empty line, resulting in the `ungetch` call not being executed if the `ioctl` call succeeds (line 448). 2017-02-19 15:37:32 +01:00			`"\" at " __FILE__ ":" TOSTRING(__LINE__)); \`
Use false instead of 0 in the kak_assert do while 2017-02-23 00:00:54 +01:00			`} while (false)`
Add support for the shift modifier. Because keyboard layouts vary, the shift-modifier `<s-…>` is only supported for special keys (like `<up>` and `<home>`) and for ASCII lowercase where we assume the shift-modifier just produces the matching uppercase character. Even that's not universally true, since in Turkish `i` and `I` are not an uppercase/lowercase pair, but Kakoune's default keyboard mappings already assume en-US mappings for mnemonic purposes. Mappings of the form `<s-x>` are normalized to `<X>` when `x` is an ASCII character. `<backtab>` is removed, since we can now say `<s-tab>`. 2018-03-15 13:02:27 +01:00
			`#define kak_expect_throw(exception_type, ...) try {\`
			`__VA_ARGS__; \`
			`on_assert_failed("expression \"" #__VA_ARGS__ \`
			`"\" did not throw \"" #exception_type \`
			`"\" at " __FILE__ ":" TOSTRING(__LINE__)); \`
			`} catch (exception_type &err) {}`
Add a debug option to Makefile, and use KAK_DEBUG define to remove debug code 2013-02-27 19:02:01 +01:00			`#else`
Avoid some warnings in optimized builds 2017-10-19 22:20:44 +02:00			`#define kak_assert(...) do { (void)sizeof(__VA_ARGS__); } while(false)`
Add support for the shift modifier. Because keyboard layouts vary, the shift-modifier `<s-…>` is only supported for special keys (like `<up>` and `<home>`) and for ASCII lowercase where we assume the shift-modifier just produces the matching uppercase character. Even that's not universally true, since in Turkish `i` and `I` are not an uppercase/lowercase pair, but Kakoune's default keyboard mappings already assume en-US mappings for mnemonic purposes. Mappings of the form `<s-x>` are normalized to `<X>` when `x` is an ASCII character. `<backtab>` is removed, since we can now say `<s-tab>`. 2018-03-15 13:02:27 +01:00			`#define kak_expect_throw(_, ...) do { (void)sizeof(__VA_ARGS__); } while(false)`
Add a debug option to Makefile, and use KAK_DEBUG define to remove debug code 2013-02-27 19:02:01 +01:00			`#endif`

assert: custom implementation 2011-09-09 21:24:18 +02:00
			`#endif // assert_hh_INCLUDED`