Debian Codegraph @

Source/Logger/CLogger.h

raw
1 /*
2 * Copyright (C) 2013-2015, 2019 by the Konclude Developer Team.
3 *
4 * This file is part of the reasoning system Konclude.
5 * For details and support, see <http://konclude.com/>.
6 *
7 * Konclude is free software: you can redistribute it and/or modify
8 * it under the terms of version 3 of the GNU Lesser General Public
9 * License (LGPLv3) as published by the Free Software Foundation.
10 *
11 * Konclude is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU (Lesser) General Public License for more details.
15 *
16 * You should have received a copy of the GNU (Lesser) General Public
17 * License along with Konclude. If not, see <http://www.gnu.org/licenses/>.
18 *
19 */
20 #ifndef KONCLUDE_LOGGER_CLOGGER_H
21 #define KONCLUDE_LOGGER_CLOGGER_H
22
23
24
25
26 #include <QThread>
27 #include <QEvent>
28 #include <QLinkedList>
29 #include <QLinkedListIterator>
30 #include <QFile>
31 #include <QTimerEvent>
32 #include <QLinkedListIterator>
33 #include <QCoreApplication>
34 #include <QFile>
35 #include <QMutex>
36 #include <QDateTime>
37 #include <QStringList>
38
39
40 #include "Concurrent/CIntervalThread.h"
41 #include "Concurrent/Callback/CCallbackData.h"
42 #include "Concurrent/Callback/CBlockingCallbackData.h"
43
44
45 #include "CLogMessage.h"
46 #include "CLogDomain.h"
47 #include "CAbstractLogObserver.h"
48 #include "CCallbackRequestLogMessagesContext.h"
49 #include "LoggerSettings.h"
50
51
52 #include "Events/CLoggingEvent.h"
53 #include "Events/CRequestLogMessagesEvent.h"
54 #include "Events/CReleaseLogMessagesEvent.h"
55 #include "Events/CConfigureLoggerEvent.h"
56
57
58 using namespace std;
59
60
61
62 // define which messages are in fact logged
63 #ifdef LOGGER_DEBUG
64
65 #define LOGNOTICELEVEL(domain,message,object) if (Konclude::Logger::CLogger::getInstance()->hasMinLoggingLevel(20)) Konclude::Logger::CLogger::getInstance()->addLogMessage(message,20,domain,object);
66 #define LOGINFOLEVEL(domain,message,object) if (Konclude::Logger::CLogger::getInstance()->hasMinLoggingLevel(30)) Konclude::Logger::CLogger::getInstance()->addLogMessage(message,30,domain,object);
67 #define LOGWARNINGLEVEL(domain,message,object) if (Konclude::Logger::CLogger::getInstance()->hasMinLoggingLevel(60)) Konclude::Logger::CLogger::getInstance()->addLogMessage(message,60,domain,object);
68 #define LOGERRORLEVEL(domain,message,object) if (Konclude::Logger::CLogger::getInstance()->hasMinLoggingLevel(70)) Konclude::Logger::CLogger::getInstance()->addLogMessage(message,70,domain,object);
69 #define LOGEXCEPTIONLEVEL(domain,message,object) if (Konclude::Logger::CLogger::getInstance()->hasMinLoggingLevel(80)) Konclude::Logger::CLogger::getInstance()->addLogMessage(message,80,domain,object);
70 #define LOGCATASTROPHICLEVEL(domain,message,object) if (Konclude::Logger::CLogger::getInstance()->hasMinLoggingLevel(90)) Konclude::Logger::CLogger::getInstance()->addLogMessage(message,90,domain,object);
71
72 #else
73
74 #define LOGNOTICELEVEL(domain,message,object)
75 #define LOGINFOLEVEL(domain,message,object) if (Konclude::Logger::CLogger::getInstance()->hasMinLoggingLevel(30)) Konclude::Logger::CLogger::getInstance()->addLogMessage(message,30,domain,object);
76 #define LOGWARNINGLEVEL(domain,message,object) if (Konclude::Logger::CLogger::getInstance()->hasMinLoggingLevel(60)) Konclude::Logger::CLogger::getInstance()->addLogMessage(message,60,domain,object);
77 #define LOGERRORLEVEL(domain,message,object) if (Konclude::Logger::CLogger::getInstance()->hasMinLoggingLevel(70)) Konclude::Logger::CLogger::getInstance()->addLogMessage(message,70,domain,object);
78 #define LOGEXCEPTIONLEVEL(domain,message,object) if (Konclude::Logger::CLogger::getInstance()->hasMinLoggingLevel(80)) Konclude::Logger::CLogger::getInstance()->addLogMessage(message,80,domain,object);
79 #define LOGCATASTROPHICLEVEL(domain,message,object) if (Konclude::Logger::CLogger::getInstance()->hasMinLoggingLevel(90)) Konclude::Logger::CLogger::getInstance()->addLogMessage(message,90,domain,object);
80
81 #endif
82
83 #define LOGCUSTOMLEVEL(level,domain,message,object) if (Konclude::Logger::CLogger::getInstance()->hasMinLoggingLevel(level)) Konclude::Logger::CLogger::getInstance()->addLogMessage(message,level,domain,object);
84
85 // simplifications (only name mapping to previous defined)
86 #define LOGINFO(domain,message,object) LOGINFOLEVEL(domain,message,object)
87 #define LOGINFORMATION(domain,message,object) LOGINFOLEVEL(domain,message,object)
88 #define LOGNOTICE(domain,message,object) LOGNOTICELEVEL(domain,message,object)
89 #define LOGNOTE(domain,message,object) LOGNOTICELEVEL(domain,message,object)
90 #define LOGWARNING(domain,message,object) LOGWARNINGLEVEL(domain,message,object)
91 #define LOGWARN(domain,message,object) LOGWARNINGLEVEL(domain,message,object)
92 #define LOGERROR(domain,message,object) LOGERRORLEVEL(domain,message,object)
93 #define LOGERR(domain,message,object) LOGERRORLEVEL(domain,message,object)
94 #define LOGEXCEPTION(domain,message,object) LOGEXCEPTIONLEVEL(domain,message,object)
95 #define LOGEXC(domain,message,object) LOGEXCEPTIONLEVEL(domain,message,object)
96 #define LOGCATASTROPHIC(domain,message,object) LOGCATASTROPHICLEVEL(domain,message,object)
97 #define LOGCAT(domain,message,object) LOGCATASTROPHICLEVEL(domain,message,object)
98
99 // more simplifications (only name mapping to previous defined)
100 #define LOGLOGNOTICELEVEL(domain,message,object) LOGNOTICELEVEL(domain,message,object)
101 #define LOGLOGINFOLEVEL(domain,message,object) LOGINFOLEVEL(domain,message,object)
102 #define LOGLOGWARNINGLEVEL(domain,message,object) LOGWARNINGLEVEL(domain,message,object)
103 #define LOGLOGERRORLEVEL(domain,message,object) LOGERRORLEVEL(domain,message,object)
104 #define LOGLOGEXCEPTIONLEVEL(domain,message,object) LOGEXCEPTIONLEVEL(domain,message,object)
105 #define LOGLOGCATASTROPHICLEVEL(domain,message,object) LOGCATASTROPHICLEVEL(domain,message,object)
106 #define LOGLOGINFO(domain,message,object) LOGINFOLEVEL(domain,message,object)
107 #define LOGLOGINFORMATION(domain,message,object) LOGINFOLEVEL(domain,message,object)
108 #define LOGLOGNOTICE(domain,message,object) LOGNOTICELEVEL(domain,message,object)
109 #define LOGLOGNOTE(domain,message,object) LOGNOTICELEVEL(domain,message,object)
110 #define LOGLOGWARNING(domain,message,object) LOGWARNINGLEVEL(domain,message,object)
111 #define LOGLOGWARN(domain,message,object) LOGWARNINGLEVEL(domain,message,object)
112 #define LOGLOGERROR(domain,message,object) LOGERRORLEVEL(domain,message,object)
113 #define LOGLOGERR(domain,message,object) LOGERRORLEVEL(domain,message,object)
114 #define LOGLOGEXCEPTION(domain,message,object) LOGEXCEPTIONLEVEL(domain,message,object)
115 #define LOGLOGEXC(domain,message,object) LOGEXCEPTIONLEVEL(domain,message,object)
116 #define LOGLOGCATASTROPHIC(domain,message,object) LOGCATASTROPHICLEVEL(domain,message,object)
117 #define LOGLOGCAT(domain,message,object) LOGCATASTROPHICLEVEL(domain,message,object)
118
119 // more simplifications (only name mapping to previous defined)
120 #define LOG10(domain,message,object) LOGCUSTOMLEVEL(10,domain,message,object)
121 #define LOG20(domain,message,object) LOGINFOLEVEL(domain,message,object)
122 #define LOG30(domain,message,object) LOGNOTICELEVEL(domain,message,object)
123 #define LOG40(domain,message,object) LOGCUSTOMLEVEL(40,domain,message,object)
124 #define LOG50(domain,message,object) LOGCUSTOMLEVEL(50,domain,message,object)
125 #define LOG60(domain,message,object) LOGWARNINGLEVEL(domain,message,object)
126 #define LOG70(domain,message,object) LOGERRORLEVEL(domain,message,object)
127 #define LOG80(domain,message,object) LOGEXCEPTIONLEVEL(domain,message,object)
128 #define LOG90(domain,message,object) LOGCATASTROPHICLEVEL(domain,message,object)
129
130
131 /*!
132 Logs a message
133 \param LOGTYPE Identifies the logging level. With the LoggingSettings you are able to compile the program without Logs from specifics levels.
134 - Use NOTICE to writing information logging messages which are probably ignored if compiling not under Debug.
135 NOTE: This can be controlled in the LoggerSettings.
136 - Use INFO to log informations which should be always logged. E.g. program outputs.
137 - Use WARNING to log warning messages, what should mean that the program is still able to continue the execution, but something is not how it should.
138 - Use ERROR to log error messages, what should mean that the program can not continue the current operation.
139 - Use EXCEPTION to log exception messages, which is may also called from an exception constructor.
140 - Use CATASTROPHIC to log catastrophic messages, which should mean the program isn't able to continue the execution and a crash is probably unavoidable.
141 \param domain Identifies the log domain, the most global domain is '::'. Separate each domain with another '::'.
142 \param message The literal message which should be logged.
143 \param object Identifies the object where the log message is occurred. This may helps to tracking/monitor a faulty object.
144 */
145 #define LOG(LOGTYPE,domain,message,object) LOG##LOGTYPE(domain,message,object)
146
147 //! Log a message with a custom logging level
148 #define LOGC(level,domain,message,object) LOGCUSTOMLEVEL(level,domain,message,object)
149
150
151 QString logTr(const char *sourceText, const char *comment = 0, int n = -1);
152
153
154 namespace Konclude {
155
156 using namespace Concurrent;
157 using namespace Callback;
158
159 namespace Logger {
160
161 using namespace Events;
162
163
164 /*!
165 * \class CLogger
166 * \version 0.3
167 * \author Andreas Steigmiller
168 * \brief Logs messages and posts them to connected Log Observers. The Logger is running in an own Thread. Use LOG(...) to add log messages.
169 */
170 class CLogger : public CIntervalThread {
171
172 public:
173 //! returns the Instance of this Singleton-Class
174 static CLogger *getInstance();
175
176 void addLogObserver(CAbstractLogObserver *observer, double level = 0, QStringList domain = QStringList());
177 void removeObserverFromAllDomains(CAbstractLogObserver *observer);
178 void removeObserverFromDomains(CAbstractLogObserver *observer, QStringList domains);
179
180 void addLogMessage(QString message, double level = 0, QString domain = "::", void *object = 0);
181
182 void getLogMessages(CCallbackData *callback, qint64 messageIDBegin = 0, qint64 messageIDEnd = -1, double levelBegin = 0, double levelEnd = 0, QStringList domains = QStringList(), QLinkedList<void *> objects = QLinkedList<void *>());
183 CCallbackRequestLogMessagesContext *getLogMessages(qint64 messageIDBegin = 0, qint64 messageIDEnd = -1, double levelBegin = 0, double levelEnd = 0, QStringList domains = QStringList(), QLinkedList<void *> objects = QLinkedList<void *>());
184
185
186 void releaseLogMessages(QLinkedList<CLogMessage *> &logMessages);
187
188 static void shutdownLogger();
189
190 void configureLogger(qint64 maxLogMessages, double minLoggingLevel);
191 double getMinLoggingLevel();
192 bool hasMinLoggingLevel(double level);
193
194 protected:
195 virtual void threadStarted();
196 virtual void threadStopped();
197
198 virtual bool processCustomsEvents(QEvent::Type type, CCustomEvent *event);
199
200 virtual bool processTimer(qint64 timerID);
201
202 bool deleteOldLogMessages();
203
204 private:
205 CLogger();
206 virtual ~CLogger();
207
208 void propagateLogMessageToDomain(QString domain, CLogMessage *message);
209
210
211 void addObserverToDomains(CLogObserverData *obsData, QStringList domains);
212
213
214 private:
215 //! Singleton-Instance
216 static CLogger* mInstance;
217
218
219 QMutex observerSyncMutex;
220 QHash<CAbstractLogObserver*, CLogObserverData*> observerHash;
221 QHash<CLogObserverData*, CLogDomain*> observerDomainHash;
222
223
224 QHash<qint64,CLogMessage *> idMessageHash;
225
226
227 //! Log-Entry-List
228 QLinkedList<CLogMessage *> loglist;
229 QHash<QString,CLogDomain *> domainHash;
230
231 //! Filename for saving
232 QString saveFileName;
233
234 //! Necessary to not always save the complete list
235 QLinkedList<CLogMessage *>::const_iterator listSaveIt;
236
237
238 qint64 mCurrentLogMessageCount;
239 qint64 mMaxLogMessageCount;
240 qint64 mMinLoggingLevel;
241
242 qint64 unsavedMessagesCount;
243 qint64 savedMessageCount;
244 qint64 totalMessageCount;
245 qint64 lastInMemoryMessage;
246
247 qint64 nextMessageID;
248
249
250 static QMutex* mInstanceCreationMutex;
251
252 static const qint64 SAVETOFILETIMERID = 1;
253
254
255 };
256
257 }; // end namespace Logger
258
259 }; // end namespace Konclude
260
261 #endif // KONCLUDE_LOGGER_CLOGGER_H