OBSDDLog+LOGV.h
3.99 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
// Software License Agreement (BSD License)
//
// Copyright (c) 2010-2016, Deusty, LLC
// All rights reserved.
//
// Redistribution and use of this software in source and binary forms,
// with or without modification, are permitted provided that the following conditions are met:
//
// *Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// *Neither the name of Deusty nor the names of its contributors may be used
// to endorse or promote products derived from this software without specific
// prior written permission of Deusty, LLC.
// Disable legacy macros
#ifndef OBSDD_LEGACY_MACROS
#define OBSDD_LEGACY_MACROS 0
#endif
#import "OBSDDLog.h"
/**
*The constant/variable/method responsible for controlling the current log level.
**/
#ifndef OBSLOG_LEVEL_DEF
#define OBSLOG_LEVEL_DEF obsddLogLevel
#endif
/**
*Whether async should be used by log messages, excluding error messages that are always sent sync.
**/
#ifndef OBSLOG_ASYNC_ENABLED
#define OBSLOG_ASYNC_ENABLED YES
#endif
/**
*This is the single macro that all other macros below compile into.
*This big multiline macro makes all the other macros easier to read.
**/
#define OBSLOGV_MACRO(isAsynchronous, lvl, flg, ctx, atag, fnct, frmt, avalist) \
[OBSDDLog log : isAsynchronous \
level : lvl \
flag : flg \
context : ctx \
file : __FILE__ \
function : fnct \
line : __LINE__ \
tag : atag \
format : frmt \
args : avalist]
/**
*Define version of the macro that only execute if the log level is above the threshold.
*The compiled versions essentially look like this:
*
*if (logFlagForThisLogMsg & obsddLogLevel) { execute log message }
*
*When OBSLOG_LEVEL_DEF is defined as obsddLogLevel.
*
*As shown further below, Lumberjack actually uses a bitmask as opposed to primitive log levels.
*This allows for a great amount of flexibility and some pretty advanced fine grained logging techniques.
*
*Note that when compiler optimizations are enabled (as they are for your release builds),
*the log messages above your logging threshold will automatically be compiled out.
*
*(If the compiler sees OBSLOG_LEVEL_DEF/obsddLogLevel declared as a constant, the compiler simply checks to see
* if the 'if' statement would execute, and if not it strips it from the binary.)
*
*We also define shorthand versions for asynchronous and synchronous logging.
**/
#define OBSLOGV_MAYBE(async, lvl, flg, ctx, tag, fnct, frmt, avalist) \
do { if(lvl & flg) LOGV_MACRO(async, lvl, flg, ctx, tag, fnct, frmt, avalist); } while(0)
/**
*Ready to use log macros with no context or tag.
**/
#define OBSDDLogVError(frmt, avalist) OBSLOGV_MAYBE(NO, OBSLOG_LEVEL_DEF, OBSDDLogFlagError, 0, nil, __PRETTY_FUNCTION__, frmt, avalist)
#define OBSDDLogVWarn(frmt, avalist) OBSLOGV_MAYBE(OBSLOG_ASYNC_ENABLED, OBSLOG_LEVEL_DEF, OBSDDLogFlagWarning, 0, nil, __PRETTY_FUNCTION__, frmt, avalist)
#define OBSDDLogVInfo(frmt, avalist) OBSLOGV_MAYBE(OBSLOG_ASYNC_ENABLED, OBSLOG_LEVEL_DEF, OBSDDLogFlagInfo, 0, nil, __PRETTY_FUNCTION__, frmt, avalist)
#define OBSDDLogVDebug(frmt, avalist) OBSLOGV_MAYBE(OBSLOG_ASYNC_ENABLED, OBSLOG_LEVEL_DEF, OBSDDLogFlagDebug, 0, nil, __PRETTY_FUNCTION__, frmt, avalist)
#define OBSDDLogVVerbose(frmt, avalist) OBSLOGV_MAYBE(OBSLOG_ASYNC_ENABLED, OBSLOG_LEVEL_DEF, OBSDDLogFlagVerbose, 0, nil, __PRETTY_FUNCTION__, frmt, avalist)