summaryrefslogtreecommitdiffstats
path: root/include/astra/Logging.h
blob: 4970a377ce426cff87671499985cc35ed346c683 (plain)
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
/*
-----------------------------------------------------------------------
Copyright: 2010-2021, imec Vision Lab, University of Antwerp
           2014-2021, CWI, Amsterdam

Contact: astra@astra-toolbox.com
Website: http://www.astra-toolbox.com/

This file is part of the ASTRA Toolbox.


The ASTRA Toolbox 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 3 of the License, or
(at your option) any later version.

The ASTRA Toolbox 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 the ASTRA Toolbox. If not, see <http://www.gnu.org/licenses/>.

-----------------------------------------------------------------------
*/

#ifndef _INC_ASTRA_LOGGING
#define _INC_ASTRA_LOGGING

#include "astra/Globals.h"

#define ASTRA_DEBUG(...) astra::CLogger::debug(__FILE__,__LINE__, __VA_ARGS__)
#define ASTRA_INFO(...) astra::CLogger::info(__FILE__,__LINE__, __VA_ARGS__)
#define ASTRA_WARN(...) astra::CLogger::warn(__FILE__,__LINE__, __VA_ARGS__)
#define ASTRA_ERROR(...) astra::CLogger::error(__FILE__,__LINE__, __VA_ARGS__)

namespace astra
{

enum log_level {
    LOG_DEBUG,
    LOG_INFO,
    LOG_WARN,
    LOG_ERROR
};

class _AstraExport CLogger
{
	CLogger();
  ~CLogger();
  static bool m_bEnabledFile;
  static bool m_bEnabledScreen;
  static bool m_bFileProvided;
  static bool m_bInitialized;
  static void _assureIsInitialized();
  static void _setLevel(int id, log_level m_eLevel);

public:

	/**
	 * Writes a line to the log file (newline is added). Ignored if logging is turned off.
	 *
	 * @param sfile
   * The name of the source file making this log call (e.g. __FILE__).
   *
   * @param sline
   * The line number of the call in the source code (e.g. __LINE__).
   *
   * @param id
   * The id of the logger to write to.
   *
   * @param fmt
   * The format string for the message (printf formatting).
   *
   * @param ...
   * Any additional format arguments.
	 */
  static void debug(const char *sfile, int sline, const char *fmt, ...);
  static void info(const char *sfile, int sline, const char *fmt, ...);
  static void warn(const char *sfile, int sline, const char *fmt, ...);
  static void error(const char *sfile, int sline, const char *fmt, ...);

  /**
	 * Sets the file to log to, with logging level.
   *
   * @param filename
   * File to log to.
	 *
	 * @param m_eLevel
   * Logging level (LOG_DEBUG, LOG_WARN, LOG_INFO, LOG_ERROR).
   *
	 */
  static void setOutputFile(const char *filename, log_level m_eLevel);

  /**
	 * Sets the screen to log to, with logging level.
   *
   * @param screen_fd
   * Screen file descriptor (1 for stdout, 2 for stderr)
	 *
	 * @param m_eLevel
   * Logging level (LOG_DEBUG, LOG_WARN, LOG_INFO, LOG_ERROR).
   *
	 */
  static void setOutputScreen(int fd, log_level m_eLevel);
  
  /**
   * Set the format string for log messages.  Here are the substitutions you may
   * use:
   *
   *     %f: Source file name generating the log call.
   *     %n: Source line number where the log call was made.
   *     %m: The message text sent to the logger (after printf formatting).
   *     %d: The current date, formatted using the logger's date format.
   *     %t: The current time, formatted using the logger's time format.
   *     %l: The log level (one of "DEBUG", "INFO", "WARN", or "ERROR").
   *     %%: A literal percent sign.
   *
   * The default format string is "%d %t %f(%n): %l: %m\n".
   *
   * @param fmt
   * The new format string, which must be less than 256 bytes.
   * You probably will want to end this with a newline (\n).
   *
   */
  static void setFormatFile(const char *fmt);
  static void setFormatScreen(const char *fmt);


  /**
   * Enable logging.
   *
   */
  static void enable();
  static void enableScreen();
  static void enableFile();

  /**
   * Disable logging.
   *
   */
  static void disable();
  static void disableScreen();
  static void disableFile();

  /**
   * Set callback function for logging to screen.
   * @return whether callback was set succesfully.
   *
   */
  static bool setCallbackScreen(void (*cb)(const char *msg, size_t len));

};

}

#endif /* _INC_ASTRA_LOGGING */