626172a16b
Source files in libcamera start by a comment block header, which
includes the file name and a one-line description of the file contents.
While the latter is useful to get a quick overview of the file contents
at a glance, the former is mostly a source of inconvenience. The name in
the comments can easily get out of sync with the file name when files
are renamed, and copy & paste during development have often lead to
incorrect names being used to start with.
Readers of the source code are expected to know which file they're
looking it. Drop the file name from the header comment block.
The change was generated with the following script:
----------------------------------------
dirs="include/libcamera src test utils"
declare -rA patterns=(
['c']=' \* '
['cpp']=' \* '
['h']=' \* '
['py']='# '
['sh']='# '
)
for ext in ${!patterns[@]} ; do
files=$(for dir in $dirs ; do find $dir -name "*.${ext}" ; done)
pattern=${patterns[${ext}]}
for file in $files ; do
name=$(basename ${file})
sed -i "s/^\(${pattern}\)${name} - /\1/" "$file"
done
done
----------------------------------------
This misses several files that are out of sync with the comment block
header. Those will be addressed separately and manually.
Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
136 lines
3.3 KiB
C++
136 lines
3.3 KiB
C++
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2018, Google Inc.
|
|
*
|
|
* Logging infrastructure
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <chrono>
|
|
#include <sstream>
|
|
|
|
#include <libcamera/base/private.h>
|
|
|
|
#include <libcamera/base/class.h>
|
|
#include <libcamera/base/utils.h>
|
|
|
|
namespace libcamera {
|
|
|
|
enum LogSeverity {
|
|
LogInvalid = -1,
|
|
LogDebug = 0,
|
|
LogInfo,
|
|
LogWarning,
|
|
LogError,
|
|
LogFatal,
|
|
};
|
|
|
|
class LogCategory
|
|
{
|
|
public:
|
|
static LogCategory *create(const char *name);
|
|
|
|
const std::string &name() const { return name_; }
|
|
LogSeverity severity() const { return severity_; }
|
|
void setSeverity(LogSeverity severity);
|
|
|
|
static const LogCategory &defaultCategory();
|
|
|
|
private:
|
|
explicit LogCategory(const char *name);
|
|
|
|
const std::string name_;
|
|
LogSeverity severity_;
|
|
};
|
|
|
|
#define LOG_DECLARE_CATEGORY(name) \
|
|
extern const LogCategory &_LOG_CATEGORY(name)();
|
|
|
|
#define LOG_DEFINE_CATEGORY(name) \
|
|
const LogCategory &_LOG_CATEGORY(name)() \
|
|
{ \
|
|
/* The instance will be deleted by the Logger destructor. */ \
|
|
static LogCategory *category = LogCategory::create(#name); \
|
|
return *category; \
|
|
}
|
|
|
|
class LogMessage
|
|
{
|
|
public:
|
|
LogMessage(const char *fileName, unsigned int line,
|
|
const LogCategory &category, LogSeverity severity,
|
|
const std::string &prefix = std::string());
|
|
|
|
LogMessage(LogMessage &&);
|
|
~LogMessage();
|
|
|
|
std::ostream &stream() { return msgStream_; }
|
|
|
|
const utils::time_point ×tamp() const { return timestamp_; }
|
|
LogSeverity severity() const { return severity_; }
|
|
const LogCategory &category() const { return category_; }
|
|
const std::string &fileInfo() const { return fileInfo_; }
|
|
const std::string &prefix() const { return prefix_; }
|
|
const std::string msg() const { return msgStream_.str(); }
|
|
|
|
private:
|
|
LIBCAMERA_DISABLE_COPY(LogMessage)
|
|
|
|
void init(const char *fileName, unsigned int line);
|
|
|
|
std::ostringstream msgStream_;
|
|
const LogCategory &category_;
|
|
LogSeverity severity_;
|
|
utils::time_point timestamp_;
|
|
std::string fileInfo_;
|
|
std::string prefix_;
|
|
};
|
|
|
|
class Loggable
|
|
{
|
|
public:
|
|
virtual ~Loggable();
|
|
|
|
protected:
|
|
virtual std::string logPrefix() const = 0;
|
|
|
|
LogMessage _log(const LogCategory *category, LogSeverity severity,
|
|
const char *fileName = __builtin_FILE(),
|
|
unsigned int line = __builtin_LINE()) const;
|
|
};
|
|
|
|
LogMessage _log(const LogCategory *category, LogSeverity severity,
|
|
const char *fileName = __builtin_FILE(),
|
|
unsigned int line = __builtin_LINE());
|
|
|
|
#ifndef __DOXYGEN__
|
|
#define _LOG_CATEGORY(name) logCategory##name
|
|
|
|
#define _LOG1(severity) \
|
|
_log(nullptr, Log##severity).stream()
|
|
#define _LOG2(category, severity) \
|
|
_log(&_LOG_CATEGORY(category)(), Log##severity).stream()
|
|
|
|
/*
|
|
* Expand the LOG() macro to _LOG1() or _LOG2() based on the number of
|
|
* arguments.
|
|
*/
|
|
#define _LOG_MACRO(_1, _2, NAME, ...) NAME
|
|
#define LOG(...) _LOG_MACRO(__VA_ARGS__, _LOG2, _LOG1)(__VA_ARGS__)
|
|
#else /* __DOXYGEN___ */
|
|
#define LOG(category, severity)
|
|
#endif /* __DOXYGEN__ */
|
|
|
|
#ifndef NDEBUG
|
|
#define ASSERT(condition) static_cast<void>(({ \
|
|
if (!(condition)) \
|
|
LOG(Fatal) << "assertion \"" #condition "\" failed in " \
|
|
<< __func__ << "()"; \
|
|
}))
|
|
#else
|
|
#define ASSERT(condition) static_cast<void>(false && (condition))
|
|
#endif
|
|
|
|
} /* namespace libcamera */
|