another.im-ios/Monal/Classes/MLConstants.h

//
//  MLConstants.h
//  Monal
//
//  Created by Anurodh Pokharel on 7/13/13.
//
//

#import <Foundation/Foundation.h>
#import <TargetConditionals.h>
#import "MLHandler.h"

@import CocoaLumberjack;
#define LOG_FLAG_STDERR         (1 << 5)
#define LOG_FLAG_STDOUT         (1 << 6)
#define LOG_LEVEL_STDERR        (DDLogLevelVerbose | LOG_FLAG_STDERR)
#define LOG_LEVEL_STDOUT        (LOG_LEVEL_STDERR | LOG_FLAG_STDOUT)
//behave like DDLogError and flush log on DDLogStderr
#define DDLogStderr(frmt, ...)  do { LOG_MAYBE(NO,  ddLogLevel, LOG_FLAG_STDERR,  0, nil, __PRETTY_FUNCTION__, frmt, ##__VA_ARGS__); [DDLog flushLog]; } while(0)
#define DDLogStdout(frmt, ...)  LOG_MAYBE(NO,  ddLogLevel, LOG_FLAG_STDOUT,  0, nil, __PRETTY_FUNCTION__, frmt, ##__VA_ARGS__)
static const DDLogLevel ddLogLevel = LOG_LEVEL_STDOUT;
#import "MLLogFileManager.h"

@import PromiseKit;
#define PMKHangEnum(promise)                (((NSNumber*)PMKHang(promise)).integerValue)
#define PMKHangBool(promise)                (((NSNumber*)PMKHang(promise)).boolValue)
#define PMKHangInt(promise)                 (((NSNumber*)PMKHang(promise)).intValue)
#define PMKHangDouble(promise)              (((NSNumber*)PMKHang(promise)).doubleValue)

//configure app group constants
#ifdef IS_ALPHA
    #define kAppGroup @"group.monalalpha"
    #define kMonalOpenURL [NSURL URLWithString:@"monalAlphaOpen://"]
    #define kBackgroundProcessingTask @"im.monal.alpha.process"
    #define kBackgroundRefreshingTask @"im.monal.alpha.refresh"
#elif defined(IS_QUICKSY)
    #define kAppGroup @"group.quicksy"
    #define kMonalOpenURL [NSURL URLWithString:@"quicksyOpen://"]
    #define kBackgroundProcessingTask @"im.monal.process"
    #define kBackgroundRefreshingTask @"im.monal.refresh"
#else
    // fmodf: 19.11.24 - changed to actual another.im group
    // #define kAppGroup @"group.monal"
    #define kAppGroup @"group.another.im.test"
    #define kMonalOpenURL [NSURL URLWithString:@"monalOpen://"]
    #define kBackgroundProcessingTask @"im.monal.process"
    #define kBackgroundRefreshingTask @"im.monal.refresh"
#endif

#define kMonalKeychainName @"Monal"

//this is in seconds
#if TARGET_OS_MACCATALYST
	#define SHORT_PING 4.0
	#define LONG_PING 8.0
    #define MUC_PING 600
    #define BGFETCH_DEFAULT_INTERVAL 3600*1
#else
	#define SHORT_PING 4.0
	#define LONG_PING 8.0
    #define MUC_PING 3600
    #define BGFETCH_DEFAULT_INTERVAL 3600*3
#endif

// #define defineBlockType(name, returntype, ...) \
//     typedef returntype (^name)(__VA_ARGS__); \
//     name _Nonnull castTo_##name(id _Nonnull block) { return block; }
// 
// #ifndef blocktypes
//     defineBlockType(monal_new_void_block_t, void, void);
// #endif

@class MLContact;
@class MLDelayableTimer;

//some typedefs used throughout the project
typedef void (^contactCompletion)(MLContact* _Nonnull selectedContact) NS_SWIFT_UNAVAILABLE("To be redefined in swift.");
typedef void (^accountCompletion)(NSInteger accountRow) NS_SWIFT_UNAVAILABLE("To be redefined in swift.");
typedef void (^monal_void_block_t)(void) NS_SWIFT_UNAVAILABLE("To be redefined in swift.");
typedef void (^monal_id_block_t)(id _Nonnull) NS_SWIFT_UNAVAILABLE("To be redefined in swift.");
typedef id _Nullable (^monal_id_returning_void_block_t)(void) NS_SWIFT_UNAVAILABLE("To be redefined in swift.");
typedef id _Nullable (^monal_id_returning_id_block_t)(id _Nonnull) NS_SWIFT_UNAVAILABLE("To be redefined in swift.");
typedef void (^monal_upload_completion_t)(NSString* _Nullable url, NSString* _Nullable mimeType, NSNumber* _Nullable size, NSError* _Nullable error) NS_SWIFT_UNAVAILABLE("To be redefined in swift.");

typedef NS_ENUM(NSUInteger, MLAudioState) {
    MLAudioStateNormal,
    MLAudioStateCall,
};

//some useful macros
#define weakify(var)                        __weak __typeof__(var) AHKWeak_##var = var
#define strongify(var)                      _Pragma("clang diagnostic push") _Pragma("clang diagnostic ignored \"-Wshadow\"") __strong __typeof__(var) var = AHKWeak_##var; _Pragma("clang diagnostic pop")
#define nilWrapper(var)                     (var == nil ? (id)[NSNull null] : (id)var)
#define nilExtractor(var)                   ((id)var == [NSNull null] ? nil : var)
#define nilDefault(var, def)                (var == nil || (id)var == [NSNull null] ? def : var)
#define nilDefaultEnum(var, def)            (((NSNumber*)nilDefault(var, def)).integerValue)
#define nilDefaultBool(var, def)            (((NSNumber*)nilDefault(var, def)).boolValue)
#define nilDefaultInt(var, def)             (((NSNumber*)nilDefault(var, def)).intValue)
#define nilDefaultDouble(var, def)          (((NSNumber*)nilDefault(var, def)).doubleValue)
#define emptyDefault(var, eq, def)          (var == nil || (id)var == [NSNull null] || [var isEqual:eq] ? def : var)
#define updateIfIdNotEqual(a, b)            if(a != b && ![a isEqual:b]) a = b
#define updateIfPrimitiveNotEqual(a, b)     if(a != b) a = b
#define var                                 __auto_type 
#define let                                 const __auto_type
#define bool2str(b)                         (b ? @"YES" : @"NO")

#define min(a, b) \
    ({ __typeof__ (a) _a = (a); \
    __typeof__ (b) _b = (b); \
    _a < _b ? _a : _b; })
#define max(a, b) \
    ({ __typeof__ (a) _a = (a); \
    __typeof__ (b) _b = (b); \
    _a > _b ? _a : _b; })

//make sure we don't define this twice
#ifndef STRIP_PARENTHESES
    //see https://stackoverflow.com/a/62984543/3528174
    #define STRIP_PARENTHESES(X) __ESC(__ISH X)
    #define __ISH(...) __ISH __VA_ARGS__
    #define __ESC(...) __ESC_(__VA_ARGS__)
    #define __ESC_(...) __VAN ## __VA_ARGS__
    #define __VAN__ISH
#endif

// https://clang-analyzer.llvm.org/faq.html#unlocalized_string
__attribute__((annotate("returns_localized_nsstring")))
static inline NSString* _Nonnull LocalizationNotNeeded(NSString* _Nonnull s)
{
  return s;
}

#define kServerDoesNotFollowXep0440Error @"__incomplete XEP-0388 support, XEP-0440 MUST be implemented and this mandates that servers MUST at least implement tls-server-end-point__"

//some xmpp related constants
#define kId @"id"
#define kMessageId @"kMessageId"

#define kRegisterNameSpace @"jabber:iq:register"

//all other constants needed
#define kMonalConnectivityChange @"kMonalConnectivityChange"
#define kMonalCallRemoved @"kMonalCallRemoved"
#define kMonalCallAdded @"kMonalCallAdded"
#define kMonalIncomingJMIStanza @"kMonalIncomingJMIStanza"
#define kMonalIncomingVoipCall @"kMonalIncomingVoipCall"
#define kMonalIncomingSDP @"kMonalIncomingSDP"
#define kMonalIncomingICECandidate @"kMonalIncomingICECandidate"
#define kMonalWillBeFreezed @"kMonalWillBeFreezed"
#define kMonalIsFreezed @"kMonalIsFreezed"
#define kMonalNewMessageNotice @"kMonalNewMessageNotice"
#define kMonalMucSubjectChanged @"kMonalMucSubjectChanged"
#define kMonalDeletedMessageNotice @"kMonalDeletedMessageNotice"
#define kMonalDisplayedMessagesNotice @"kMonalDisplayedMessagesNotice"
#define kMonalHistoryMessagesNotice @"kMonalHistoryMessagesNotice"
#define kMLMessageSentToContact @"kMLMessageSentToContact"
#define kMonalSentMessageNotice @"kMonalSentMessageNotice"
#define kMonalMessageFiletransferUpdateNotice @"kMonalMessageFiletransferUpdateNotice"
#define kMonalAccountDiscoDone @"kMonalAccountDiscoDone"

#define kMonalNewPresenceNotice @"kMonalNewPresenceNotice"
#define kMonalLastInteractionUpdatedNotice @"kMonalLastInteractionUpdatedNotice"
#define kMonalMessageReceivedNotice @"kMonalMessageReceivedNotice"
#define kMonalMessageDisplayedNotice @"kMonalMessageDisplayedNotice"
#define kMonalMessageErrorNotice @"kMonalMessageErrorNotice"
#define kMonalReceivedMucInviteNotice @"kMonalReceivedMucInviteNotice"
#define kXMPPError @"kXMPPError"
#define kScheduleBackgroundTask @"kScheduleBackgroundTask"
#define kMonalUpdateUnread @"kMonalUpdateUnread"

#define kMLIsLoggedInNotice @"kMLIsLoggedInNotice"
#define kMLResourceBoundNotice @"kMLResourceBoundNotice"
#define kMonalFinishedCatchup @"kMonalFinishedCatchup"
#define kMonalFinishedOmemoBundleFetch @"kMonalFinishedOmemoBundleFetch"
#define kMonalOmemoStateUpdated @"kMonalOmemoStateUpdated"
#define kMonalUpdateBundleFetchStatus @"kMonalUpdateBundleFetchStatus"
#define kMonalOmemoFetchingStateUpdate @"kMonalOmemoFetchingStateUpdate"
#define kMonalIdle @"kMonalIdle"
#define kMonalFiletransfersIdle @"kMonalFiletransfersIdle"
#define kMonalNotIdle @"kMonalNotIdle"

#define kMonalBackgroundChanged @"kMonalBackgroundChanged"
#define kMLMAMPref @"kMLMAMPref"

#define kMonalAccountStatusChanged @"kMonalAccountStatusChanged"

#define kMonalRefresh @"kMonalRefresh"
#define kMonalContactRefresh @"kMonalContactRefresh"
#define kMonalXmppUserSoftWareVersionRefresh @"kMonalXmppUserSoftWareVersionRefresh"
#define kMonalBlockListRefresh @"kMonalBlockListRefresh"
#define kMonalContactRemoved @"kMonalContactRemoved"
#define kMonalMucParticipantsAndMembersUpdated @"kMonalMucParticipantsAndMembersUpdated"

#define kMucTypeGroup @"group"
#define kMucTypeChannel @"channel"

#define kMucRoleModerator @"moderator"
#define kMucRoleNone @"none"
#define kMucRoleParticipant @"participant"
#define kMucRoleVisitor @"visitor"

#define kMucAffiliationOwner @"owner"
#define kMucAffiliationAdmin @"admin"
#define kMucAffiliationMember @"member"
#define kMucAffiliationOutcast @"outcast"
#define kMucAffiliationNone @"none"
#define kMucActionShowProfile @"profile"
#define kMucActionReinvite @"reinvite"

// max count of char's in a single message (both: sending and receiving)
#define kMonalChatMaxAllowedTextLen 2048

#if TARGET_OS_MACCATALYST
#define kMonalBackscrollingMsgCount 75
#else
#define kMonalBackscrollingMsgCount 50
#endif

//contact cells
#define kusernameKey @"username"
#define kfullNameKey @"fullName"
#define kaccountIDKey @"accountID"
#define kstateKey @"state"
#define kstatusKey @"status"

//info cells
#define kaccountNameKey @"accountName"
#define kinfoTypeKey @"type"
#define kinfoStatusKey @"status"

//use this to completely disable omemo in build
//#ifndef DISABLE_OMEMO
//#define DISABLE_OMEMO 1
//#endif

//build MLXMLNode query statistics (will only optimize MLXMLNode queries if *not* defined)
//#define QueryStatistics 1

#define geoPattern  @"^geo:(-?(?:90|[1-8][0-9]|[0-9])(?:\\.[0-9]{1,32})?),(-?(?:180|1[0-7][0-9]|[0-9]{1,2})(?:\\.[0-9]{1,32})?)(;.*)?([?].*)?$"