Welcome to mirror list, hosted at ThFree Co, Russian Federation.

Logger.h « Platform « src - github.com/Duet3D/RepRapFirmware.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: b2eee38b9b3d5ca0c62242c774b22114c94af330 (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
/*
 * Logger.h
 *
 *  Created on: 17 Sep 2017
 *      Author: David
 */

#ifndef SRC_LOGGER_H_
#define SRC_LOGGER_H_

#include <RepRapFirmware.h>

#if HAS_MASS_STORAGE

#include <ctime>
#include <Storage/FileData.h>

class OutputBuffer;

class Logger
{
public:
	Logger(LogLevel logLvl) noexcept;

	void Start(time_t time, const StringRef& file) noexcept;
	void Stop(time_t time) noexcept;
	void LogMessage(time_t time, const char *message, MessageType type) noexcept;
	void LogMessage(time_t time, OutputBuffer *buf, MessageType type) noexcept;
	void Flush(bool forced) noexcept;
	bool IsActive() const noexcept { return logFile.IsLive(); }
	const char *GetFileName() const noexcept { return (IsActive()) ? logFileName.c_str() : nullptr; }
	LogLevel GetLogLevel() const noexcept { return logLevel; }
	void SetLogLevel(LogLevel newLogLevel) noexcept;
#if 0 // Currently not needed but might be useful in the future
	bool IsLoggingEnabledFor(const MessageType mt) const noexcept;
	bool IsWarnEnabled() const noexcept { return logLevel >= LogLevel::warn; }
	bool IsInfoEnabled() const noexcept { return logLevel >= LogLevel::info; }
	bool IsDebugEnabled() const noexcept { return logLevel >= LogLevel::debug; }
#endif

private:
	NamedEnum(MessageLogLevel, uint8_t, debug, info, warn, off);
	MessageLogLevel GetMessageLogLevel(MessageType mt) const noexcept { return (MessageLogLevel) ((mt & MessageType::LogOff)>>30); }

	static const uint8_t LogEnabledThreshold = 3;

	bool WriteDateTimeAndLogLevelPrefix(time_t time, MessageLogLevel messageLogLevel) noexcept;
	void InternalLogMessage(time_t time, const char *message, const MessageLogLevel messageLogLevel) noexcept;
	bool IsLoggingEnabledFor(const MessageLogLevel mll) const noexcept { return (mll < MessageLogLevel::off) && (mll.ToBaseType() + logLevel.ToBaseType() >= LogEnabledThreshold); }
	void LogFirmwareInfo(time_t time) noexcept;
	bool IsEmptyMessage(const char * message) const noexcept { return message[0] == '\0' || (message[0] == '\n' && message[1] == '\0'); }

	String<MaxFilenameLength> logFileName;
	FileData logFile;
	uint32_t lastFlushTime;
	FilePosition lastFlushFileSize;
	bool dirty;
	bool inLogger;
	LogLevel logLevel;
};

#endif

#endif /* SRC_LOGGER_H_ */