| Message ID | 20190208144540.15529-1-laurent.pinchart@ideasonboard.com |
|---|---|
| State | Accepted |
| Commit | 8a401ed4119aac4ca994f70cb5540bc1b2c6939a |
| Headers | show |
| Series |
|
| Related | show |
Hi Laurent, Thanks for your patch. On 2019-02-08 16:45:39 +0200, Laurent Pinchart wrote: > Introduce a base Loggable class that can be inherited from by other > classes to support adding per-instance information to the log messages. > > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> It's more complex but I like the end result and its ease of use :-) Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se> > --- > src/libcamera/include/log.h | 23 ++++++- > src/libcamera/log.cpp | 124 ++++++++++++++++++++++++++++++++++++ > 2 files changed, 145 insertions(+), 2 deletions(-) > > diff --git a/src/libcamera/include/log.h b/src/libcamera/include/log.h > index ad8f8452c333..8ea5a1eb673a 100644 > --- a/src/libcamera/include/log.h > +++ b/src/libcamera/include/log.h > @@ -54,6 +54,7 @@ public: > LogMessage(const char *fileName, unsigned int line, > const LogCategory &category, LogSeverity severity); > LogMessage(const LogMessage &) = delete; > + LogMessage(LogMessage &&); > ~LogMessage(); > > std::ostream &stream() { return msgStream_; } > @@ -66,13 +67,31 @@ private: > LogSeverity severity_; > }; > > +class Loggable > +{ > +public: > + virtual ~Loggable(); > + > +protected: > + virtual std::string logPrefix() const = 0; > + > + LogMessage _log(const char *file, unsigned int line, > + LogSeverity severity); > + LogMessage _log(const char *file, unsigned int line, > + const LogCategory &category, LogSeverity severity); > +}; > + > +LogMessage _log(const char *file, unsigned int line, LogSeverity severity); > +LogMessage _log(const char *file, unsigned int line, > + const LogCategory &category, LogSeverity severity); > + > #ifndef __DOXYGEN__ > #define _LOG_CATEGORY(name) logCategory##name > > #define _LOG1(severity) \ > - LogMessage(__FILE__, __LINE__, Log##severity).stream() > + _log(__FILE__, __LINE__, Log##severity).stream() > #define _LOG2(category, severity) \ > - LogMessage(__FILE__, __LINE__, _LOG_CATEGORY(category)(), Log##severity).stream() > + _log(__FILE__, __LINE__, _LOG_CATEGORY(category)(), Log##severity).stream() > > /* > * Expand the LOG() macro to _LOG1() or _LOG2() based on the number of > diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp > index edeb5eabb264..26ebf410a7a9 100644 > --- a/src/libcamera/log.cpp > +++ b/src/libcamera/log.cpp > @@ -405,6 +405,25 @@ LogMessage::LogMessage(const char *fileName, unsigned int line, > init(fileName, line); > } > > +/** > + * \brief Move-construct a log message > + * \param[in] other The other message > + * > + * The move constructor is meant to support the _log() functions. Thanks to copy > + * elision it will likely never be called, but C++11 only permits copy elision, > + * it doesn't enforce it unlike C++17. To avoid potential link errors depending > + * on the compiler type and version, and optimization level, the move > + * constructor is defined even if it will likely never be called, and ensures > + * that the destructor of the \a other message will not output anything to the > + * log by setting the severity to -1. > + */ > +LogMessage::LogMessage(LogMessage &&other) > + : msgStream_(std::move(other.msgStream_)), category_(other.category_), > + severity_(other.severity_) > +{ > + other.severity_ = static_cast<LogSeverity>(-1); > +} > + > void LogMessage::init(const char *fileName, unsigned int line) > { > /* Log the timestamp, severity and file information. */ > @@ -424,6 +443,10 @@ void LogMessage::init(const char *fileName, unsigned int line) > > LogMessage::~LogMessage() > { > + /* Don't print anything if we have been moved to another LogMessage. */ > + if (severity_ == -1) > + return; > + > msgStream_ << std::endl; > > if (severity_ >= category_.severity()) { > @@ -445,6 +468,107 @@ LogMessage::~LogMessage() > * \return A reference to the log message stream > */ > > +/** > + * \class Loggable > + * \brief Base class to support log message extensions > + * > + * The Loggable class allows classes to extend log messages without any change > + * to the way the LOG() macro is invoked. By inheriting from Loggable and > + * implementing the logPrefix() virtual method, a class can specify extra > + * information to be automatically added to messages logged from class member > + * methods. > + */ > + > +Loggable::~Loggable() > +{ > +} > + > +/** > + * \fn Loggable::logPrefix() > + * \brief Retrieve a string to be prefixed to the log message > + * > + * This method allows classes inheriting from the Loggable class to extend the > + * logger with an object-specific prefix output right before the log message > + * contents. > + * > + * \return A string to be prefixed to the log message > + */ > + > +/** > + * \brief Create a temporary LogMessage object to log a message > + * \param[in] fileName The file name where the message is logged from > + * \param[in] line The line number where the message is logged from > + * \param[in] severity The log message severity > + * > + * This method is used as a backeng by the LOG() macro to create a log message > + * for locations inheriting from the Loggable class. > + * > + * \return A log message > + */ > +LogMessage Loggable::_log(const char *fileName, unsigned int line, > + LogSeverity severity) > +{ > + LogMessage msg(fileName, line, severity); > + > + msg.stream() << logPrefix() << ": "; > + return msg; > +} > + > +/** > + * \brief Create a temporary LogMessage object to log a message > + * \param[in] fileName The file name where the message is logged from > + * \param[in] line The line number where the message is logged from > + * \param[in] category The log message category > + * \param[in] severity The log message severity > + * > + * This method is used as a backeng by the LOG() macro to create a log message > + * for locations inheriting from the Loggable class. > + * > + * \return A log message > + */ > +LogMessage Loggable::_log(const char *fileName, unsigned int line, > + const LogCategory &category, LogSeverity severity) > +{ > + LogMessage msg(fileName, line, category, severity); > + > + msg.stream() << logPrefix() << ": "; > + return msg; > +} > + > +/** > + * \brief Create a temporary LogMessage object to log a message > + * \param[in] fileName The file name where the message is logged from > + * \param[in] line The line number where the message is logged from > + * \param[in] severity The log message severity > + * > + * This function is used as a backeng by the LOG() macro to create a log > + * message for locations not inheriting from the Loggable class. > + * > + * \return A log message > + */ > +LogMessage _log(const char *fileName, unsigned int line, LogSeverity severity) > +{ > + return LogMessage(fileName, line, severity); > +} > + > +/** > + * \brief Create a temporary LogMessage object to log a message > + * \param[in] fileName The file name where the message is logged from > + * \param[in] line The line number where the message is logged from > + * \param[in] category The log message category > + * \param[in] severity The log message severity > + * > + * This function is used as a backeng by the LOG() macro to create a log > + * message for locations not inheriting from the Loggable class. > + * > + * \return A log message > + */ > +LogMessage _log(const char *fileName, unsigned int line, > + const LogCategory &category, LogSeverity severity) > +{ > + return LogMessage(fileName, line, category, severity); > +} > + > /** > * \def LOG_DECLARE_CATEGORY(name) > * \hideinitializer > -- > Regards, > > Laurent Pinchart > > _______________________________________________ > libcamera-devel mailing list > libcamera-devel@lists.libcamera.org > https://lists.libcamera.org/listinfo/libcamera-devel
Hi Laurent, On Fri, Feb 08, 2019 at 04:45:39PM +0200, Laurent Pinchart wrote: > Introduce a base Loggable class that can be inherited from by other > classes to support adding per-instance information to the log messages. > > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> I like then end result and the process that brought us there! No need for a tag, as Niklas supplied one already, but feel free to add my: Confused-by: Jacopo Mondi <jacopo@jmondi.org> Thanks j > --- > src/libcamera/include/log.h | 23 ++++++- > src/libcamera/log.cpp | 124 ++++++++++++++++++++++++++++++++++++ > 2 files changed, 145 insertions(+), 2 deletions(-) > > diff --git a/src/libcamera/include/log.h b/src/libcamera/include/log.h > index ad8f8452c333..8ea5a1eb673a 100644 > --- a/src/libcamera/include/log.h > +++ b/src/libcamera/include/log.h > @@ -54,6 +54,7 @@ public: > LogMessage(const char *fileName, unsigned int line, > const LogCategory &category, LogSeverity severity); > LogMessage(const LogMessage &) = delete; > + LogMessage(LogMessage &&); > ~LogMessage(); > > std::ostream &stream() { return msgStream_; } > @@ -66,13 +67,31 @@ private: > LogSeverity severity_; > }; > > +class Loggable > +{ > +public: > + virtual ~Loggable(); > + > +protected: > + virtual std::string logPrefix() const = 0; > + > + LogMessage _log(const char *file, unsigned int line, > + LogSeverity severity); > + LogMessage _log(const char *file, unsigned int line, > + const LogCategory &category, LogSeverity severity); > +}; > + > +LogMessage _log(const char *file, unsigned int line, LogSeverity severity); > +LogMessage _log(const char *file, unsigned int line, > + const LogCategory &category, LogSeverity severity); > + > #ifndef __DOXYGEN__ > #define _LOG_CATEGORY(name) logCategory##name > > #define _LOG1(severity) \ > - LogMessage(__FILE__, __LINE__, Log##severity).stream() > + _log(__FILE__, __LINE__, Log##severity).stream() > #define _LOG2(category, severity) \ > - LogMessage(__FILE__, __LINE__, _LOG_CATEGORY(category)(), Log##severity).stream() > + _log(__FILE__, __LINE__, _LOG_CATEGORY(category)(), Log##severity).stream() > > /* > * Expand the LOG() macro to _LOG1() or _LOG2() based on the number of > diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp > index edeb5eabb264..26ebf410a7a9 100644 > --- a/src/libcamera/log.cpp > +++ b/src/libcamera/log.cpp > @@ -405,6 +405,25 @@ LogMessage::LogMessage(const char *fileName, unsigned int line, > init(fileName, line); > } > > +/** > + * \brief Move-construct a log message > + * \param[in] other The other message > + * > + * The move constructor is meant to support the _log() functions. Thanks to copy > + * elision it will likely never be called, but C++11 only permits copy elision, > + * it doesn't enforce it unlike C++17. To avoid potential link errors depending > + * on the compiler type and version, and optimization level, the move > + * constructor is defined even if it will likely never be called, and ensures > + * that the destructor of the \a other message will not output anything to the > + * log by setting the severity to -1. > + */ > +LogMessage::LogMessage(LogMessage &&other) > + : msgStream_(std::move(other.msgStream_)), category_(other.category_), > + severity_(other.severity_) > +{ > + other.severity_ = static_cast<LogSeverity>(-1); > +} > + > void LogMessage::init(const char *fileName, unsigned int line) > { > /* Log the timestamp, severity and file information. */ > @@ -424,6 +443,10 @@ void LogMessage::init(const char *fileName, unsigned int line) > > LogMessage::~LogMessage() > { > + /* Don't print anything if we have been moved to another LogMessage. */ > + if (severity_ == -1) > + return; > + > msgStream_ << std::endl; > > if (severity_ >= category_.severity()) { > @@ -445,6 +468,107 @@ LogMessage::~LogMessage() > * \return A reference to the log message stream > */ > > +/** > + * \class Loggable > + * \brief Base class to support log message extensions > + * > + * The Loggable class allows classes to extend log messages without any change > + * to the way the LOG() macro is invoked. By inheriting from Loggable and > + * implementing the logPrefix() virtual method, a class can specify extra > + * information to be automatically added to messages logged from class member > + * methods. > + */ > + > +Loggable::~Loggable() > +{ > +} > + > +/** > + * \fn Loggable::logPrefix() > + * \brief Retrieve a string to be prefixed to the log message > + * > + * This method allows classes inheriting from the Loggable class to extend the > + * logger with an object-specific prefix output right before the log message > + * contents. > + * > + * \return A string to be prefixed to the log message > + */ > + > +/** > + * \brief Create a temporary LogMessage object to log a message > + * \param[in] fileName The file name where the message is logged from > + * \param[in] line The line number where the message is logged from > + * \param[in] severity The log message severity > + * > + * This method is used as a backeng by the LOG() macro to create a log message > + * for locations inheriting from the Loggable class. > + * > + * \return A log message > + */ > +LogMessage Loggable::_log(const char *fileName, unsigned int line, > + LogSeverity severity) > +{ > + LogMessage msg(fileName, line, severity); > + > + msg.stream() << logPrefix() << ": "; > + return msg; > +} > + > +/** > + * \brief Create a temporary LogMessage object to log a message > + * \param[in] fileName The file name where the message is logged from > + * \param[in] line The line number where the message is logged from > + * \param[in] category The log message category > + * \param[in] severity The log message severity > + * > + * This method is used as a backeng by the LOG() macro to create a log message > + * for locations inheriting from the Loggable class. > + * > + * \return A log message > + */ > +LogMessage Loggable::_log(const char *fileName, unsigned int line, > + const LogCategory &category, LogSeverity severity) > +{ > + LogMessage msg(fileName, line, category, severity); > + > + msg.stream() << logPrefix() << ": "; > + return msg; > +} > + > +/** > + * \brief Create a temporary LogMessage object to log a message > + * \param[in] fileName The file name where the message is logged from > + * \param[in] line The line number where the message is logged from > + * \param[in] severity The log message severity > + * > + * This function is used as a backeng by the LOG() macro to create a log > + * message for locations not inheriting from the Loggable class. > + * > + * \return A log message > + */ > +LogMessage _log(const char *fileName, unsigned int line, LogSeverity severity) > +{ > + return LogMessage(fileName, line, severity); > +} > + > +/** > + * \brief Create a temporary LogMessage object to log a message > + * \param[in] fileName The file name where the message is logged from > + * \param[in] line The line number where the message is logged from > + * \param[in] category The log message category > + * \param[in] severity The log message severity > + * > + * This function is used as a backeng by the LOG() macro to create a log > + * message for locations not inheriting from the Loggable class. > + * > + * \return A log message > + */ > +LogMessage _log(const char *fileName, unsigned int line, > + const LogCategory &category, LogSeverity severity) > +{ > + return LogMessage(fileName, line, category, severity); > +} > + > /** > * \def LOG_DECLARE_CATEGORY(name) > * \hideinitializer > -- > Regards, > > Laurent Pinchart > > _______________________________________________ > libcamera-devel mailing list > libcamera-devel@lists.libcamera.org > https://lists.libcamera.org/listinfo/libcamera-devel
diff --git a/src/libcamera/include/log.h b/src/libcamera/include/log.h index ad8f8452c333..8ea5a1eb673a 100644 --- a/src/libcamera/include/log.h +++ b/src/libcamera/include/log.h @@ -54,6 +54,7 @@ public: LogMessage(const char *fileName, unsigned int line, const LogCategory &category, LogSeverity severity); LogMessage(const LogMessage &) = delete; + LogMessage(LogMessage &&); ~LogMessage(); std::ostream &stream() { return msgStream_; } @@ -66,13 +67,31 @@ private: LogSeverity severity_; }; +class Loggable +{ +public: + virtual ~Loggable(); + +protected: + virtual std::string logPrefix() const = 0; + + LogMessage _log(const char *file, unsigned int line, + LogSeverity severity); + LogMessage _log(const char *file, unsigned int line, + const LogCategory &category, LogSeverity severity); +}; + +LogMessage _log(const char *file, unsigned int line, LogSeverity severity); +LogMessage _log(const char *file, unsigned int line, + const LogCategory &category, LogSeverity severity); + #ifndef __DOXYGEN__ #define _LOG_CATEGORY(name) logCategory##name #define _LOG1(severity) \ - LogMessage(__FILE__, __LINE__, Log##severity).stream() + _log(__FILE__, __LINE__, Log##severity).stream() #define _LOG2(category, severity) \ - LogMessage(__FILE__, __LINE__, _LOG_CATEGORY(category)(), Log##severity).stream() + _log(__FILE__, __LINE__, _LOG_CATEGORY(category)(), Log##severity).stream() /* * Expand the LOG() macro to _LOG1() or _LOG2() based on the number of diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp index edeb5eabb264..26ebf410a7a9 100644 --- a/src/libcamera/log.cpp +++ b/src/libcamera/log.cpp @@ -405,6 +405,25 @@ LogMessage::LogMessage(const char *fileName, unsigned int line, init(fileName, line); } +/** + * \brief Move-construct a log message + * \param[in] other The other message + * + * The move constructor is meant to support the _log() functions. Thanks to copy + * elision it will likely never be called, but C++11 only permits copy elision, + * it doesn't enforce it unlike C++17. To avoid potential link errors depending + * on the compiler type and version, and optimization level, the move + * constructor is defined even if it will likely never be called, and ensures + * that the destructor of the \a other message will not output anything to the + * log by setting the severity to -1. + */ +LogMessage::LogMessage(LogMessage &&other) + : msgStream_(std::move(other.msgStream_)), category_(other.category_), + severity_(other.severity_) +{ + other.severity_ = static_cast<LogSeverity>(-1); +} + void LogMessage::init(const char *fileName, unsigned int line) { /* Log the timestamp, severity and file information. */ @@ -424,6 +443,10 @@ void LogMessage::init(const char *fileName, unsigned int line) LogMessage::~LogMessage() { + /* Don't print anything if we have been moved to another LogMessage. */ + if (severity_ == -1) + return; + msgStream_ << std::endl; if (severity_ >= category_.severity()) { @@ -445,6 +468,107 @@ LogMessage::~LogMessage() * \return A reference to the log message stream */ +/** + * \class Loggable + * \brief Base class to support log message extensions + * + * The Loggable class allows classes to extend log messages without any change + * to the way the LOG() macro is invoked. By inheriting from Loggable and + * implementing the logPrefix() virtual method, a class can specify extra + * information to be automatically added to messages logged from class member + * methods. + */ + +Loggable::~Loggable() +{ +} + +/** + * \fn Loggable::logPrefix() + * \brief Retrieve a string to be prefixed to the log message + * + * This method allows classes inheriting from the Loggable class to extend the + * logger with an object-specific prefix output right before the log message + * contents. + * + * \return A string to be prefixed to the log message + */ + +/** + * \brief Create a temporary LogMessage object to log a message + * \param[in] fileName The file name where the message is logged from + * \param[in] line The line number where the message is logged from + * \param[in] severity The log message severity + * + * This method is used as a backeng by the LOG() macro to create a log message + * for locations inheriting from the Loggable class. + * + * \return A log message + */ +LogMessage Loggable::_log(const char *fileName, unsigned int line, + LogSeverity severity) +{ + LogMessage msg(fileName, line, severity); + + msg.stream() << logPrefix() << ": "; + return msg; +} + +/** + * \brief Create a temporary LogMessage object to log a message + * \param[in] fileName The file name where the message is logged from + * \param[in] line The line number where the message is logged from + * \param[in] category The log message category + * \param[in] severity The log message severity + * + * This method is used as a backeng by the LOG() macro to create a log message + * for locations inheriting from the Loggable class. + * + * \return A log message + */ +LogMessage Loggable::_log(const char *fileName, unsigned int line, + const LogCategory &category, LogSeverity severity) +{ + LogMessage msg(fileName, line, category, severity); + + msg.stream() << logPrefix() << ": "; + return msg; +} + +/** + * \brief Create a temporary LogMessage object to log a message + * \param[in] fileName The file name where the message is logged from + * \param[in] line The line number where the message is logged from + * \param[in] severity The log message severity + * + * This function is used as a backeng by the LOG() macro to create a log + * message for locations not inheriting from the Loggable class. + * + * \return A log message + */ +LogMessage _log(const char *fileName, unsigned int line, LogSeverity severity) +{ + return LogMessage(fileName, line, severity); +} + +/** + * \brief Create a temporary LogMessage object to log a message + * \param[in] fileName The file name where the message is logged from + * \param[in] line The line number where the message is logged from + * \param[in] category The log message category + * \param[in] severity The log message severity + * + * This function is used as a backeng by the LOG() macro to create a log + * message for locations not inheriting from the Loggable class. + * + * \return A log message + */ +LogMessage _log(const char *fileName, unsigned int line, + const LogCategory &category, LogSeverity severity) +{ + return LogMessage(fileName, line, category, severity); +} + /** * \def LOG_DECLARE_CATEGORY(name) * \hideinitializer
Introduce a base Loggable class that can be inherited from by other classes to support adding per-instance information to the log messages. Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com> --- src/libcamera/include/log.h | 23 ++++++- src/libcamera/log.cpp | 124 ++++++++++++++++++++++++++++++++++++ 2 files changed, 145 insertions(+), 2 deletions(-)