libcamera v0.0.0+3240-f2a18172-dirty (2022-05-13T20:32:10+00:00)
Supporting cameras in Linux since 2019
log.h
Go to the documentation of this file.
1/* SPDX-License-Identifier: LGPL-2.1-or-later */
2/*
3 * Copyright (C) 2018, Google Inc.
4 *
5 * log.h - Logging infrastructure
6 */
7#ifndef __LIBCAMERA_BASE_LOG_H__
8#define __LIBCAMERA_BASE_LOG_H__
9
10#include <chrono>
11#include <sstream>
12
13#include <libcamera/base/private.h>
14
17
18namespace libcamera {
19
21 LogInvalid = -1,
27};
28
30{
31public:
32 explicit LogCategory(const char *name);
33
34 const char *name() const { return name_; }
35 LogSeverity severity() const { return severity_; }
37
38 static const LogCategory &defaultCategory();
39
40private:
41 const char *name_;
42 LogSeverity severity_;
43};
44
45#define LOG_DECLARE_CATEGORY(name) \
46extern const LogCategory &_LOG_CATEGORY(name)();
47
48#define LOG_DEFINE_CATEGORY(name) \
49const LogCategory &_LOG_CATEGORY(name)() \
50{ \
51 /* The instance will be deleted by the Logger destructor. */ \
52 static LogCategory *category = new LogCategory(#name); \
53 return *category; \
54}
55
57{
58public:
59 LogMessage(const char *fileName, unsigned int line,
61
64
65 std::ostream &stream() { return msgStream_; }
66
67 const utils::time_point &timestamp() const { return timestamp_; }
68 LogSeverity severity() const { return severity_; }
69 const LogCategory &category() const { return category_; }
70 const std::string &fileInfo() const { return fileInfo_; }
71 const std::string msg() const { return msgStream_.str(); }
72
73private:
75
76 void init(const char *fileName, unsigned int line);
77
78 std::ostringstream msgStream_;
79 const LogCategory &category_;
80 LogSeverity severity_;
81 utils::time_point timestamp_;
82 std::string fileInfo_;
83};
84
86{
87public:
88 virtual ~Loggable();
89
90protected:
91 virtual std::string logPrefix() const = 0;
92
93 LogMessage _log(const LogCategory *category, LogSeverity severity,
94 const char *fileName = __builtin_FILE(),
95 unsigned int line = __builtin_LINE()) const;
96};
97
98LogMessage _log(const LogCategory *category, LogSeverity severity,
99 const char *fileName = __builtin_FILE(),
100 unsigned int line = __builtin_LINE());
101
102#ifndef __DOXYGEN__
103#define _LOG_CATEGORY(name) logCategory##name
104
105#define _LOG1(severity) \
106 _log(nullptr, Log##severity).stream()
107#define _LOG2(category, severity) \
108 _log(&_LOG_CATEGORY(category)(), Log##severity).stream()
109
110/*
111 * Expand the LOG() macro to _LOG1() or _LOG2() based on the number of
112 * arguments.
113 */
114#define _LOG_MACRO(_1, _2, NAME, ...) NAME
115#define LOG(...) _LOG_MACRO(__VA_ARGS__, _LOG2, _LOG1)(__VA_ARGS__)
116#else /* __DOXYGEN___ */
117#define LOG(category, severity)
118#endif /* __DOXYGEN__ */
119
120#ifndef NDEBUG
121#define ASSERT(condition) static_cast<void>(({ \
122 if (!(condition)) \
123 LOG(Fatal) << "assertion \"" #condition "\" failed in " \
124 << __func__ << "()"; \
125}))
126#else
127#define ASSERT(condition) static_cast<void>(false && (condition))
128#endif
129
130} /* namespace libcamera */
131
132#endif /* __LIBCAMERA_BASE_LOG_H__ */
Utilities to help constructing class interfaces.
#define LIBCAMERA_DISABLE_COPY(klass)
Disable copy construction and assignment of the klass.
A category of log message.
Definition: log.h:30
const char * name() const
Retrieve the log category name.
Definition: log.h:34
LogSeverity severity() const
Retrieve the severity of the log category.
Definition: log.h:35
static const LogCategory & defaultCategory()
Retrieve the default log category.
Definition: log.cpp:740
LogCategory(const char *name)
Construct a log category.
Definition: log.cpp:702
void setSeverity(LogSeverity severity)
Set the severity of the log category.
Definition: log.cpp:727
Internal log message representation.
Definition: log.h:57
const LogCategory & category() const
Retrieve the category of the log message.
Definition: log.h:69
LogMessage(const char *fileName, unsigned int line, const LogCategory &category, LogSeverity severity)
Construct a log message for a given category.
Definition: log.cpp:768
const std::string msg() const
Retrieve the message text of the log message.
Definition: log.h:71
const std::string & fileInfo() const
Retrieve the file info of the log message.
Definition: log.h:70
const utils::time_point & timestamp() const
Retrieve the timestamp of the log message.
Definition: log.h:67
std::ostream & stream()
Definition: log.h:65
LogSeverity severity() const
Retrieve the severity of the log message.
Definition: log.h:68
Base class to support log message extensions.
Definition: log.h:86
virtual std::string logPrefix() const =0
Retrieve a string to be prefixed to the log message.
LogMessage _log(const LogCategory *category, LogSeverity severity, const char *fileName=__builtin_FILE(), unsigned int line=__builtin_LINE()) const
Create a temporary LogMessage object to log a message.
Definition: log.cpp:903
Top-level libcamera namespace.
Definition: backtrace.h:17
LogMessage _log(const LogCategory *category, LogSeverity severity, const char *fileName=__builtin_FILE(), unsigned int line=__builtin_LINE())
Create a temporary LogMessage object to log a message.
Definition: log.cpp:926
LogSeverity
Definition: log.h:20
@ LogWarning
Definition: log.h:24
@ LogFatal
Definition: log.h:26
@ LogError
Definition: log.h:25
@ LogDebug
Definition: log.h:22
@ LogInfo
Definition: log.h:23
Miscellaneous utility functions.
std::chrono::steady_clock::time_point time_point
The libcamera time point related to libcamera::utils::clock.
Definition: utils.h:73