File: SimpleLog.h

package info (click to toggle)
spring 98.0%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 41,928 kB
  • ctags: 60,665
  • sloc: cpp: 356,167; ansic: 39,434; python: 12,228; java: 12,203; awk: 5,856; sh: 1,719; xml: 997; perl: 405; php: 253; objc: 194; makefile: 72; sed: 2
file content (73 lines) | stat: -rw-r--r-- 2,063 bytes parent folder | download
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
/*
	Copyright (c) 2008 Robin Vobruba <hoijui.quaero@gmail.com>

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef _LOG_H
#define _LOG_H

#ifdef __cplusplus
extern "C" {
#endif

enum SimpleLog_Level {
	SIMPLELOG_LEVEL_ERROR       = 1,
	SIMPLELOG_LEVEL_WARNING     = 3,
	SIMPLELOG_LEVEL_NORMAL      = 5,
	SIMPLELOG_LEVEL_FINE        = 8,
	SIMPLELOG_LEVEL_FINER       = 9,
	SIMPLELOG_LEVEL_FINEST      = 10
};

#include <stdbool.h> /* bool, true, false */

#define EXTERNAL_LOGGER(msg)   log(msg);

/**
 * Initializes the log.
 * @param logFileName   file to log to
 * @param useTimeStamps prefix each log entry with a timestamp
 * @param logLevel      see enum SimpleLog_Level
 * @param append        if true, previous content of the file is preserved
 */
void simpleLog_init(const char* logFileName, bool useTimeStamps,
		int logLevel, bool append);

/**
 * Logs a text message,
 * but only if level <= logLevel (see simpleLog_init()).
 * Works like printf(fmt, ...).
 * @param level see enum SimpleLog_Level
 * @param fmt   format of the logmessage, see man 3 printf
 */
void simpleLog_logL(int level, const char* fmt, ...);

/**
 * Logs a text message with SIMPLELOG_LEVEL_NORMAL.
 * Works like printf(fmt, ...).
 */
void simpleLog_log(const char* fmt, ...);

/**
 * Returns a string representation of a log level.
 * @param  logLevel   see enum SimpleLog_Level
 */
const char* simpleLog_levelToStr(int logLevel);

#ifdef __cplusplus
} // extern "C"
#endif

#endif /* _LOG_H */