author | Joe Doyle (Ginto8) <ginto8@gmail.com> |
Sat, 01 Dec 2012 15:56:19 -0500 (2012-12-01) | |
changeset 8174 | df02c2ad4a2c |
parent 7482 | d70a5b0d1190 |
child 10017 | de822cd3df3a |
permissions | -rw-r--r-- |
7314
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
1 |
/* |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
2 |
* Hedgewars, a free turn based strategy game |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
3 |
* Copyright (C) 2012 Simeon Maxein <smaxein@googlemail.com> |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
4 |
* |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
5 |
* This program is free software; you can redistribute it and/or |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
6 |
* modify it under the terms of the GNU General Public License |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
7 |
* as published by the Free Software Foundation; either version 2 |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
8 |
* of the License, or (at your option) any later version. |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
9 |
* |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
10 |
* This program is distributed in the hope that it will be useful, |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
11 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
12 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
13 |
* GNU General Public License for more details. |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
14 |
* |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
15 |
* You should have received a copy of the GNU General Public License |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
16 |
* along with this program; if not, write to the Free Software |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
17 |
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
18 |
*/ |
6171f0bad318
frontlib: Fixes and improvements. Added a GPLv2+ license header to all frontlib
Medo <smaxein@googlemail.com>
parents:
7275
diff
changeset
|
19 |
|
7155
273ad375d64e
Started work on the frontend networking library
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
20 |
#ifndef LOGGING_H_ |
273ad375d64e
Started work on the frontend networking library
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
21 |
#define LOGGING_H_ |
273ad375d64e
Started work on the frontend networking library
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
22 |
|
7224
5143861c83bd
Cleanup, refactoring and generally more development in the frontlib
Medo <smaxein@googlemail.com>
parents:
7182
diff
changeset
|
23 |
#include <stdint.h> |
7182
076aba32abd3
Small improvements to the frontend lib for better debugging
Medo <smaxein@googlemail.com>
parents:
7179
diff
changeset
|
24 |
#include <stdio.h> |
7224
5143861c83bd
Cleanup, refactoring and generally more development in the frontlib
Medo <smaxein@googlemail.com>
parents:
7182
diff
changeset
|
25 |
#include <stdbool.h> |
7182
076aba32abd3
Small improvements to the frontend lib for better debugging
Medo <smaxein@googlemail.com>
parents:
7179
diff
changeset
|
26 |
|
076aba32abd3
Small improvements to the frontend lib for better debugging
Medo <smaxein@googlemail.com>
parents:
7179
diff
changeset
|
27 |
#define FLIB_LOGLEVEL_ALL -100 |
076aba32abd3
Small improvements to the frontend lib for better debugging
Medo <smaxein@googlemail.com>
parents:
7179
diff
changeset
|
28 |
#define FLIB_LOGLEVEL_DEBUG -1 |
076aba32abd3
Small improvements to the frontend lib for better debugging
Medo <smaxein@googlemail.com>
parents:
7179
diff
changeset
|
29 |
#define FLIB_LOGLEVEL_INFO 0 |
076aba32abd3
Small improvements to the frontend lib for better debugging
Medo <smaxein@googlemail.com>
parents:
7179
diff
changeset
|
30 |
#define FLIB_LOGLEVEL_WARNING 1 |
076aba32abd3
Small improvements to the frontend lib for better debugging
Medo <smaxein@googlemail.com>
parents:
7179
diff
changeset
|
31 |
#define FLIB_LOGLEVEL_ERROR 2 |
076aba32abd3
Small improvements to the frontend lib for better debugging
Medo <smaxein@googlemail.com>
parents:
7179
diff
changeset
|
32 |
#define FLIB_LOGLEVEL_NONE 100 |
7155
273ad375d64e
Started work on the frontend networking library
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
33 |
|
7224
5143861c83bd
Cleanup, refactoring and generally more development in the frontlib
Medo <smaxein@googlemail.com>
parents:
7182
diff
changeset
|
34 |
/** |
5143861c83bd
Cleanup, refactoring and generally more development in the frontlib
Medo <smaxein@googlemail.com>
parents:
7182
diff
changeset
|
35 |
* Returns a pointer to a static buffer, don't free or store. |
5143861c83bd
Cleanup, refactoring and generally more development in the frontlib
Medo <smaxein@googlemail.com>
parents:
7182
diff
changeset
|
36 |
*/ |
7155
273ad375d64e
Started work on the frontend networking library
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
37 |
char* flib_format_ip(uint32_t numip); |
273ad375d64e
Started work on the frontend networking library
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
38 |
|
7275
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
39 |
/** |
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
40 |
* Evaluates the expression cond. If it is true, a formatted error will be logged. |
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
41 |
* Returns true if an error is logged, false otherwise (i.e. the boolean value of the argument) |
7482 | 42 |
* Usage: log_e_if(errorHasHappened, "Format string", formatArg, ...); |
7275
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
43 |
*/ |
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
44 |
#define log_e_if(cond, ...) _flib_fassert(__func__, FLIB_LOGLEVEL_ERROR, !(bool)(cond), __VA_ARGS__) |
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
45 |
#define log_w_if(cond, ...) _flib_fassert(__func__, FLIB_LOGLEVEL_WARNING, !(bool)(cond), __VA_ARGS__) |
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
46 |
|
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
47 |
/** |
7316
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
48 |
* Helper macros for log_badargs_if |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
49 |
* The t parameters are the textual representation of the c parameters. They need to be passed |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
50 |
* explicitly, to prevent them from being expanded in prescan. |
7275
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
51 |
*/ |
7316
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
52 |
#define _flib_lbi(c1,t1) log_e_if(c1, "Invalid Argument (%s)", t1) |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
53 |
#define _flib_lbi2(c1,t1,c2,t2) (_flib_lbi(c1,t1) || _flib_lbi(c2,t2)) |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
54 |
#define _flib_lbi3(c1,t1,c2,t2,c3,t3) (_flib_lbi(c1,t1) || _flib_lbi2(c2,t2,c3,t3)) |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
55 |
#define _flib_lbi4(c1,t1,c2,t2,c3,t3,c4,t4) (_flib_lbi(c1,t1) || _flib_lbi3(c2,t2,c3,t3,c4,t4)) |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
56 |
#define _flib_lbi5(c1,t1,c2,t2,c3,t3,c4,t4,c5,t5) (_flib_lbi(c1,t1) || _flib_lbi4(c2,t2,c3,t3,c4,t4,c5,t5)) |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
57 |
#define _flib_lbi6(c1,t1,c2,t2,c3,t3,c4,t4,c5,t5,c6,t6) (_flib_lbi(c1,t1) || _flib_lbi5(c2,t2,c3,t3,c4,t4,c5,t5,c6,t6)) |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
58 |
|
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
59 |
/** |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
60 |
* These macros log an "Invalid Argument" error for the first of their arguments that evaluates to true. |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
61 |
* The text of the argument is included in the log message. |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
62 |
* The expression returns true if any of its arguments is true (i.e. if an argument error was logged). |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
63 |
* |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
64 |
* For example, log_badargs_if(x==NULL) will log "Invalid Argument (x==NULL)" and return true if x is NULL. |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
65 |
*/ |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
66 |
#define log_badargs_if(c1) _flib_lbi(c1,#c1) |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
67 |
#define log_badargs_if2(c1, c2) _flib_lbi2(c1,#c1,c2,#c2) |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
68 |
#define log_badargs_if3(c1, c2, c3) _flib_lbi3(c1,#c1,c2,#c2,c3,#c3) |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
69 |
#define log_badargs_if4(c1, c2, c3, c4) _flib_lbi4(c1,#c1,c2,#c2,c3,#c3,c4,#c4) |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
70 |
#define log_badargs_if5(c1, c2, c3, c4, c5) _flib_lbi5(c1,#c1,c2,#c2,c3,#c3,c4,#c4,c5,#c5) |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
71 |
#define log_badargs_if6(c1, c2, c3, c4, c5, c6) _flib_lbi6(c1,#c1,c2,#c2,c3,#c3,c4,#c4,c5,#c5,c6,#c6) |
f7b49b2c5d84
frontlib: Improved and unified parameter checking, moved the cmdlineClient out
Medo <smaxein@googlemail.com>
parents:
7314
diff
changeset
|
72 |
|
7275
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
73 |
#define log_oom_if(cond) log_e_if(cond, "Out of Memory") |
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
74 |
|
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
75 |
#define flib_log_e(...) _flib_flog(__func__, FLIB_LOGLEVEL_ERROR, __VA_ARGS__) |
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
76 |
#define flib_log_w(...) _flib_flog(__func__, FLIB_LOGLEVEL_WARNING, __VA_ARGS__) |
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
77 |
#define flib_log_i(...) _flib_flog(__func__, FLIB_LOGLEVEL_INFO, __VA_ARGS__) |
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
78 |
#define flib_log_d(...) _flib_flog(__func__, FLIB_LOGLEVEL_DEBUG, __VA_ARGS__) |
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
79 |
|
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
80 |
bool _flib_fassert(const char *func, int level, bool cond, const char *fmt, ...); |
15f722e0b96f
frontlib: Getting there :) Added commandline client for testing
Medo <smaxein@googlemail.com>
parents:
7224
diff
changeset
|
81 |
void _flib_flog(const char *func, int level, const char *fmt, ...); |
7182
076aba32abd3
Small improvements to the frontend lib for better debugging
Medo <smaxein@googlemail.com>
parents:
7179
diff
changeset
|
82 |
|
7482 | 83 |
/** |
84 |
* Only log messages that are at least the indicated level |
|
85 |
*/ |
|
7182
076aba32abd3
Small improvements to the frontend lib for better debugging
Medo <smaxein@googlemail.com>
parents:
7179
diff
changeset
|
86 |
void flib_log_setLevel(int level); |
7482 | 87 |
int flib_log_getLevel(); |
88 |
||
89 |
/** |
|
90 |
* Log to the indicated file. You can pass NULL to log to stdout. |
|
91 |
* This overrides setCallback and vice versa. |
|
92 |
*/ |
|
7182
076aba32abd3
Small improvements to the frontend lib for better debugging
Medo <smaxein@googlemail.com>
parents:
7179
diff
changeset
|
93 |
void flib_log_setFile(FILE *logfile); |
7482 | 94 |
|
95 |
/** |
|
96 |
* Returns whether messages of this level are logged at the moment. |
|
97 |
*/ |
|
7224
5143861c83bd
Cleanup, refactoring and generally more development in the frontlib
Medo <smaxein@googlemail.com>
parents:
7182
diff
changeset
|
98 |
bool flib_log_isActive(int level); |
7155
273ad375d64e
Started work on the frontend networking library
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
99 |
|
7338 | 100 |
/** |
101 |
* Allows logging through an arbitrary callback function. Useful for integrating into an |
|
102 |
* existing logging system. This overrides setFile and vice versa. |
|
103 |
*/ |
|
104 |
void flib_log_setCallback(void (*logCallback)(int level, const char *msg)); |
|
105 |
||
7155
273ad375d64e
Started work on the frontend networking library
Medo <smaxein@googlemail.com>
parents:
diff
changeset
|
106 |
#endif /* LOGGING_H_ */ |