keejef
/
session-ios
mirror of https://github.com/oxen-io/session-ios
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Step 1/2 Prefer safer asserts

Browse Source
pull/1/head
Michael Kirk 7 years ago
parent 6f6b1d0aae
commit a54ed8b201
1 changed files with 44 additions and 16 deletions
Show Stats Download Patch File Download Diff File

60
SignalServiceKit/src/Util/OWSAsserts.h
Unescape Escape View File

@ -9,29 +9,29 @@ NS_ASSUME_NONNULL_BEGIN
#ifndef OWSAssert #ifndef OWSAssert
#define CONVERT_TO_STRING(X) #X
#define CONVERT_EXPR_TO_STRING(X) CONVERT_TO_STRING(X)
#ifdef DEBUG #ifdef DEBUG
#define USE_ASSERTS #define USE_ASSERTS
#define CONVERT_TO_STRING(X) #X // OWSAssertDebug() and OWSFailDebug() should be used in Obj-C methods.
#define CONVERT_EXPR_TO_STRING(X) CONVERT_TO_STRING(X) // OWSCAssertDebug() and OWSCFailDebug() should be used in free functions.
// OWSAssert() and OWSFailDebug() should be used in Obj-C methods.
// OWSCAssert() and OWSCFailDebug() should be used in free functions.
#define OWSAssert(X) \ #define OWSAssertDebug(X) \
do { \ do { \
if (!(X)) { \ if (!(X)) { \
OWSLogError(@"%s Assertion failed: %s", __PRETTY_FUNCTION__, CONVERT_EXPR_TO_STRING(X)); \ OWSLogError(@"Assertion failed: %s", CONVERT_EXPR_TO_STRING(X)); \
[DDLog flushLog]; \ [DDLog flushLog]; \
NSAssert(0, @"Assertion failed: %s", CONVERT_EXPR_TO_STRING(X)); \ NSAssert(0, @"Assertion failed: %s", CONVERT_EXPR_TO_STRING(X)); \
} \ } \
} while (NO) } while (NO)
#define OWSCAssert(X) \ #define OWSCAssertDebug(X) \
do { \ do { \
if (!(X)) { \ if (!(X)) { \
OWSLogError(@"%s Assertion failed: %s", __PRETTY_FUNCTION__, CONVERT_EXPR_TO_STRING(X)); \ OWSLogError(@"Assertion failed: %s", CONVERT_EXPR_TO_STRING(X)); \
[DDLog flushLog]; \ [DDLog flushLog]; \
NSCAssert(0, @"Assertion failed: %s", CONVERT_EXPR_TO_STRING(X)); \ NSCAssert(0, @"Assertion failed: %s", CONVERT_EXPR_TO_STRING(X)); \
} \ } \
@ -43,7 +43,6 @@ NS_ASSUME_NONNULL_BEGIN
NSAssert(0, formattedMessage); \ NSAssert(0, formattedMessage); \
} while (NO) } while (NO)
#define OWSCFailWithoutLogging(message, ...) \ #define OWSCFailWithoutLogging(message, ...) \
do { \ do { \
NSString *formattedMessage = [NSString stringWithFormat:message, ##__VA_ARGS__]; \ NSString *formattedMessage = [NSString stringWithFormat:message, ##__VA_ARGS__]; \
@ -66,8 +65,8 @@ NS_ASSUME_NONNULL_BEGIN
#else #else
#define OWSAssert(X) #define OWSAssertDebug(X)
#define OWSCAssert(X) #define OWSCAssertDebug(X)
#define OWSFailWithoutLogging(message, ...) #define OWSFailWithoutLogging(message, ...)
#define OWSCFailWithoutLogging(message, ...) #define OWSCFailWithoutLogging(message, ...)
#define OWSFailNoFormat(X) #define OWSFailNoFormat(X)
@ -77,7 +76,22 @@ NS_ASSUME_NONNULL_BEGIN
#endif #endif
#define OWSAbstractMethod() OWSFailDebug(@"%@ Method needs to be implemented by subclasses.", self.logTag) // Like OWSAssertDebug, but will fail in production, terminating the app
#define OWSAssert(X) \
do { \
if (!(X)) { \
OWSFail(@"Assertion failed: %s", CONVERT_EXPR_TO_STRING(X)); \
} \
} while (NO)
#define OWSCAssert(X) \
do { \
if (!(X)) { \
OWSCFail(@"Assertion failed: %s", CONVERT_EXPR_TO_STRING(X)); \
} \
} while (NO)
#define OWSAbstractMethod() OWSFail(@"Method needs to be implemented by subclasses.")
#pragma mark - Singleton Asserts #pragma mark - Singleton Asserts
@ -107,7 +121,7 @@ NS_ASSUME_NONNULL_BEGIN
@synchronized([self class]) \ @synchronized([self class]) \
{ \ { \
if (!CurrentAppContext().isRunningTests) { \ if (!CurrentAppContext().isRunningTests) { \
OWSAssert(!_isSingletonCreated); \ OWSAssertDebug(!_isSingletonCreated); \
_isSingletonCreated = YES; \ _isSingletonCreated = YES; \
} \ } \
} }
@ -123,7 +137,7 @@ NS_ASSUME_NONNULL_BEGIN
#endif #endif
// This macro is intended for use in Objective-C. // This macro is intended for use in Objective-C.
#define OWSAssertIsOnMainThread() OWSCAssert([NSThread isMainThread]) #define OWSAssertIsOnMainThread() OWSCAssertDebug([NSThread isMainThread])
#define OWSFailDebug(_messageFormat, ...) \ #define OWSFailDebug(_messageFormat, ...) \
do { \ do { \
@ -196,7 +210,7 @@ __attribute__((annotate("returns_localized_nsstring"))) static inline NSString *
#ifdef DEBUG_UI_JANK #ifdef DEBUG_UI_JANK
#define OWSJanksUI() \ #define OWSJanksUI() \
do { \ do { \
OWSAssert(![NSThread isMainThread]) \ OWSAssertDebug(![NSThread isMainThread]) \
} while (NO) } while (NO)
#endif #endif
#endif #endif
@ -205,4 +219,18 @@ __attribute__((annotate("returns_localized_nsstring"))) static inline NSString *
#define OWSJanksUI() #define OWSJanksUI()
#endif #endif
#pragma mark - Overflow Math
#define ows_add_overflow(a, b, resultRef) \
do { \
BOOL _didOverflow = __builtin_add_overflow(a, b, resultRef); \
OWSAssert(!_didOverflow); \
} while (NO)
#define ows_sub_overflow(a, b, resultRef) \
do { \
BOOL _didOverflow = __builtin_sub_overflow(a, b, resultRef); \
OWSAssert(!_didOverflow); \
} while (NO)
NS_ASSUME_NONNULL_END NS_ASSUME_NONNULL_END

Write Preview
Loading…
Cancel
Save