Eclipse SUMO - Simulation of Urban MObility
Loading...
Searching...
No Matches
MsgHandler.h
Go to the documentation of this file.
1/****************************************************************************/
2// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
3// Copyright (C) 2003-2023 German Aerospace Center (DLR) and others.
4// This program and the accompanying materials are made available under the
5// terms of the Eclipse Public License 2.0 which is available at
6// https://www.eclipse.org/legal/epl-2.0/
7// This Source Code may also be made available under the following Secondary
8// Licenses when the conditions for such availability set forth in the Eclipse
9// Public License 2.0 are satisfied: GNU General Public License, version 2
10// or later which is available at
11// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
12// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
13/****************************************************************************/
21// Retrieves messages about the process and gives them further to output
22/****************************************************************************/
23#pragma once
24#include <config.h>
25#include <string>
26#include <vector>
27#include <map>
31
32
33// ===========================================================================
34// class definitions
35// ===========================================================================
40public:
46 enum class MsgType {
57 };
58
59private:
60 typedef MsgHandler* (*Factory)(MsgType);
61
62public:
64 static void setFactory(Factory func) {
65 // clean old instances
67 myFactory = func;
68 }
69
72
75
78
81
84
86 static void enableDebugMessages(bool enable);
87
89 static void enableDebugGLMessages(bool enable);
90
92 static inline bool writeDebugMessages() {
94 }
95
97 static inline bool writeDebugGLMessages() {
99 }
100
102 static std::string insertLineBreaks(std::string msg, int lineWidth);
103
106
108 static void setupI18n(const std::string& locale = "");
109
111 static void initOutputOptions();
112
114 static void cleanupOnEnd();
115
117 virtual void inform(std::string msg, bool addType = true);
118
120 // variadic function
121 template<typename T, typename... Targs>
122 void informf(const std::string& format, T value, Targs... Fargs) {
123 if (!aggregationThresholdReached(format)) {
124 inform(StringUtils::format(format, value, Fargs...), true);
125 }
126 }
127
135 virtual void beginProcessMsg(std::string msg, bool addType = true);
136
138 virtual void endProcessMsg2(bool success, long duration = -1);
139
141 virtual void endProcessMsg(std::string msg);
142
144 virtual void clear(bool resetInformed = true);
145
147 virtual void addRetriever(OutputDevice* retriever);
148
150 virtual void removeRetriever(OutputDevice* retriever);
151
153 bool isRetriever(OutputDevice* retriever) const;
154
156 bool wasInformed() const;
157
161 template <class T>
162 MsgHandler& operator<<(const T& t) {
163 // inform all other receivers
164 for (OutputDevice* o : myRetrievers) {
165 (*o) << t;
166 }
167 return *this;
168 }
169
170protected:
172 inline std::string build(const std::string& msg, bool addType) {
173 if (addType) {
174 switch (myType) {
176 break;
178 return "Warning: " + msg;
179 break;
181 return "Error: " + msg;
182 break;
184 return "Debug: " + msg;
185 break;
187 return "GLDebug: " + msg;
188 break;
189 default:
190 break;
191 }
192 }
193 return msg;
194 }
195
196 virtual bool aggregationThresholdReached(const std::string& format) {
198 }
199
200 void setAggregationThreshold(const int thresh) {
201 myAggregationThreshold = thresh;
202 }
203
205 MsgHandler(MsgType type);
206
208 virtual ~MsgHandler();
209
210private:
213
216
219
222
225
228
231
232private:
235
238
241
243 std::map<const std::string, int> myAggregationCount;
244
246 std::vector<OutputDevice*> myRetrievers;
247
249 std::vector<std::string> myInitialMessages;
250
251private:
253 MsgHandler(const MsgHandler& s) = delete;
254
256 MsgHandler& operator=(const MsgHandler& s) = delete;
257
264};
265
266
267// ===========================================================================
268// global definitions
269// ===========================================================================
270#define WRITE_WARNING(msg) MsgHandler::getWarningInstance()->inform(msg);
271#define WRITE_WARNINGF(...) MsgHandler::getWarningInstance()->informf(__VA_ARGS__);
272#define WRITE_MESSAGE(msg) MsgHandler::getMessageInstance()->inform(msg);
273#define WRITE_MESSAGEF(...) MsgHandler::getMessageInstance()->informf(__VA_ARGS__);
274#define PROGRESS_BEGIN_MESSAGE(msg) MsgHandler::getMessageInstance()->beginProcessMsg((msg) + std::string(" ..."));
275#define PROGRESS_DONE_MESSAGE() MsgHandler::getMessageInstance()->endProcessMsg2(true);
276#define PROGRESS_BEGIN_TIME_MESSAGE(msg) SysUtils::getCurrentMillis(); MsgHandler::getMessageInstance()->beginProcessMsg((msg) + std::string(" ..."));
277#define PROGRESS_TIME_MESSAGE(before) MsgHandler::getMessageInstance()->endProcessMsg2(true, SysUtils::getCurrentMillis() - before);
278#define PROGRESS_FAILED_MESSAGE() MsgHandler::getMessageInstance()->endProcessMsg2(false);
279#define WRITE_ERROR(msg) MsgHandler::getErrorInstance()->inform(msg);
280#define WRITE_ERRORF(...) MsgHandler::getErrorInstance()->informf(__VA_ARGS__);
281#define WRITE_DEBUG(msg) if(MsgHandler::writeDebugMessages()){MsgHandler::getDebugInstance()->inform(msg);};
282#define WRITE_GLDEBUG(msg) if(MsgHandler::writeDebugGLMessages()){MsgHandler::getGLDebugInstance()->inform(msg);};
283#ifdef HAVE_INTL
284#define TL(string) gettext(string)
285#define TLF(string, ...) StringUtils::format(gettext(string), __VA_ARGS__)
286#else
287#define TL(string) (string)
288#define TLF(string, ...) StringUtils::format(string, __VA_ARGS__)
289#endif
virtual void addRetriever(OutputDevice *retriever)
Adds a further retriever to the instance responsible for a certain msg type.
std::vector< std::string > myInitialMessages
storage for initial messages
Definition MsgHandler.h:249
static MsgHandler * getGLDebugInstance()
Returns the instance to add GLdebug to.
bool wasInformed() const
Returns the information whether any messages were added.
MsgType myType
The type of the instance.
Definition MsgHandler.h:234
static MsgHandler * getErrorInstance()
Returns the instance to add errors to.
virtual void inform(std::string msg, bool addType=true)
adds a new error to the list
static void enableDebugGLMessages(bool enable)
enable/disable gl-debug messages
static MsgHandler * myGLDebugInstance
The instance to handle glDebug.
Definition MsgHandler.h:218
MsgHandler & operator=(const MsgHandler &s)=delete
invalid assignment operator
static std::string insertLineBreaks(std::string msg, int lineWidth)
reformats a long string to contain newline after a certain line length in px (depending on the curren...
virtual void endProcessMsg(std::string msg)
Ends a process information.
std::string build(const std::string &msg, bool addType)
Builds the string which includes the mml-message type.
Definition MsgHandler.h:172
virtual bool aggregationThresholdReached(const std::string &format)
Definition MsgHandler.h:196
static Factory myFactory
The function to call for new MsgHandlers, nullptr means use default constructor.
Definition MsgHandler.h:212
bool myWasInformed
information whether an output occurred at all
Definition MsgHandler.h:237
static void setupI18n(const std::string &locale="")
set up gettext stuff
static void initOutputOptions()
init output options
static MsgHandler * myErrorInstance
The instance to handle errors.
Definition MsgHandler.h:221
static MsgHandler * getDebugInstance()
Returns the instance to add debug to.
static MsgHandler * myMessageInstance
The instance to handle normal messages.
Definition MsgHandler.h:227
static bool writeDebugGLMessages()
check whether to enable/disable gl-debug messages
Definition MsgHandler.h:97
bool isRetriever(OutputDevice *retriever) const
Returns whether the given output device retrieves messages from the handler.
static MsgHandler * getWarningInstance()
Returns the instance to add warnings to.
static void setFactory(Factory func)
Sets the factory function to use for new MsgHandlers.
Definition MsgHandler.h:64
std::map< const std::string, int > myAggregationCount
count for messages of the same type
Definition MsgHandler.h:243
static void enableDebugMessages(bool enable)
enable/disable debug messages
static bool myAmProcessingProcess
Information whether a process information is printed to cout.
Definition MsgHandler.h:230
std::vector< OutputDevice * > myRetrievers
The list of retrievers that shall be informed about new messages or errors.
Definition MsgHandler.h:246
MsgHandler(const MsgHandler &s)=delete
invalid copy constructor
MsgHandler *(* Factory)(MsgType)
Definition MsgHandler.h:60
virtual ~MsgHandler()
destructor
virtual void clear(bool resetInformed=true)
Clears information whether an error occurred previously and print aggregated message summary.
static MsgHandler * myDebugInstance
The instance to handle debug.
Definition MsgHandler.h:215
void setAggregationThreshold(const int thresh)
Definition MsgHandler.h:200
static bool writeDebugMessages()
check whether to enable/disable debug messages
Definition MsgHandler.h:92
MsgHandler & operator<<(const T &t)
Generic output operator.
Definition MsgHandler.h:162
static MsgHandler * myWarningInstance
The instance to handle warnings.
Definition MsgHandler.h:224
virtual void endProcessMsg2(bool success, long duration=-1)
Ends a process information with predefined messages.
virtual void beginProcessMsg(std::string msg, bool addType=true)
Begins a process information.
static bool myWriteDebugMessages
Flag to enable or disable debug GL Functions.
Definition MsgHandler.h:262
static bool myWriteDebugGLMessages
Definition MsgHandler.h:263
void informf(const std::string &format, T value, Targs... Fargs)
adds a new formatted message
Definition MsgHandler.h:122
static void cleanupOnEnd()
Removes pending handler.
static void removeRetrieverFromAllInstances(OutputDevice *out)
ensure that that given output device is no longer used as retriever by any instance
virtual void removeRetriever(OutputDevice *retriever)
Removes the retriever from the handler.
int myAggregationThreshold
do not output more messages of the same type if the count exceeds this threshold
Definition MsgHandler.h:240
@ MT_GLDEBUG
The message is GL debug output.
@ MT_DEBUG
The message is debug output.
@ MT_MESSAGE
The message is only something to show.
@ MT_ERROR
The message is an error.
@ MT_WARNING
The message is a warning.
static MsgHandler * getMessageInstance()
Returns the instance to add normal messages to.
Static storage of an output device and its base (abstract) implementation.
static const std::string format(const std::string &format, T value, Targs... Fargs)
adds a new formatted message