Convert to a global static logger

xlz · xlz · commit 40248978873b · 2015-09-03T13:01:30.000-04:00
Before this commit, logger pointers get passed around through
inheritance and manually constructed dependency assignment lists.
The manual management is hard to scale with logging calls which
can appear anywhere in the code.

This commit implements a single global static logger for all
Freenect2 contexts. It still can be replaced by different
loggers, but only one at a time.

Now it is the responsibility of each logging point to include
libfreenect2/logging.h, which is not automatically included.
diff --git a/examples/protonect/Protonect.cpp b/examples/protonect/Protonect.cpp
@@ -33,6 +33,7 @@
 #include <libfreenect2/threading.h>
 #include <libfreenect2/registration.h>
 #include <libfreenect2/packet_pipeline.h>
+#include <libfreenect2/logging.h>
 #ifdef LIBFREENECT2_WITH_OPENGL_SUPPORT
 #include "viewer.h"
 #endif
@@ -59,7 +60,7 @@ int main(int argc, char *argv[])
 
   libfreenect2::Freenect2 freenect2;
   // create a console logger with debug level (default is console logger with info level)
-  freenect2.setLogger(libfreenect2::createConsoleLogger(libfreenect2::Logger::Debug));
+  libfreenect2::setGlobalLogger(libfreenect2::createConsoleLogger(libfreenect2::Logger::Debug));
 
   libfreenect2::Freenect2Device *dev = 0;
   libfreenect2::PacketPipeline *pipeline = 0;
diff --git a/examples/protonect/include/libfreenect2/depth_packet_stream_parser.h b/examples/protonect/include/libfreenect2/depth_packet_stream_parser.h
@@ -31,7 +31,6 @@
 #include <stdint.h>
 
 #include <libfreenect2/config.h>
-#include <libfreenect2/logging.h>
 
 #include <libfreenect2/double_buffer.h>
 #include <libfreenect2/depth_packet_processor.h>
@@ -52,7 +51,7 @@ LIBFREENECT2_PACK(struct LIBFREENECT2_API DepthSubPacketFooter
   uint32_t fields[32];
 });
 
-class LIBFREENECT2_API DepthPacketStreamParser : public DataCallback, public WithLoggerImpl
+class LIBFREENECT2_API DepthPacketStreamParser : public DataCallback
 {
 public:
   DepthPacketStreamParser();
diff --git a/examples/protonect/include/libfreenect2/libfreenect2.hpp b/examples/protonect/include/libfreenect2/libfreenect2.hpp
@@ -29,7 +29,6 @@
 
 #include <libfreenect2/config.h>
 #include <libfreenect2/frame_listener.hpp>
-#include <libfreenect2/logging.h>
 
 namespace libfreenect2
 {
@@ -96,15 +95,12 @@ class LIBFREENECT2_API Freenect2Device
 
 class Freenect2Impl;
 
-class LIBFREENECT2_API Freenect2 : public WithLogger
+class LIBFREENECT2_API Freenect2
 {
 public:
   Freenect2(void *usb_context = 0);
   virtual ~Freenect2();
 
-  virtual void setLogger(Logger *logger);
-  virtual Logger *logger();
-
   int enumerateDevices();
 
   std::string getDeviceSerialNumber(int idx);
diff --git a/examples/protonect/include/libfreenect2/logging.h b/examples/protonect/include/libfreenect2/logging.h
@@ -60,6 +60,10 @@ LIBFREENECT2_API Logger *createConsoleLogger(Logger::Level level);
 LIBFREENECT2_API Logger *createConsoleLoggerWithDefaultLevel();
 LIBFREENECT2_API Logger *createNoopLogger();
 
+//libfreenect2 frees the memory of the logger passed in.
+LIBFREENECT2_API Logger *getGlobalLogger();
+LIBFREENECT2_API void setGlobalLogger(Logger *logger);
+
 class LIBFREENECT2_API LogMessage
 {
 private:
@@ -73,50 +77,22 @@ class LIBFREENECT2_API LogMessage
   std::ostream &stream();
 };
 
-class LIBFREENECT2_API WithLogger
-{
-public:
-  virtual ~WithLogger();
-  virtual void setLogger(Logger *logger) = 0;
-  virtual Logger *logger() = 0;
-};
-
-template<class T>
-void trySetLogger(T *obj, Logger *logger)
-{
-  WithLogger *obj_with_logger = dynamic_cast<WithLogger *>(obj);
-  if(obj_with_logger != 0)
-  {
-    obj_with_logger->setLogger(logger);
-  }
-}
-
-class LIBFREENECT2_API WithLoggerImpl : public WithLogger
-{
-protected:
-  Logger *logger_;
-
-  virtual void onLoggerChanged(Logger *logger);
-public:
-  WithLoggerImpl();
-  virtual ~WithLoggerImpl();
-  virtual void setLogger(Logger *logger);
-  virtual Logger *logger();
-};
+std::string getShortName(const char *func);
 
 } /* namespace libfreenect2 */
 
 #if defined(__GNUC__) or defined(__clang__)
-#define LIBFREENECT2_LOG_SOURCE __PRETTY_FUNCTION__
+#define LIBFREENECT2_LOG_SOURCE ::libfreenect2::getShortName(__PRETTY_FUNCTION__)
 #elif defined(_MSC_VER)
-#define LIBFREENECT2_LOG_SOURCE __FUNCSIG__
+#define LIBFREENECT2_LOG_SOURCE ::libfreenect2::getShortName(__FUNCSIG__)
 #else
 #define LIBFREENECT2_LOG_SOURCE ""
 #endif
 
-#define LOG_DEBUG (::libfreenect2::LogMessage(logger(), ::libfreenect2::Logger::Debug).stream() << "[" << LIBFREENECT2_LOG_SOURCE << "] ")
-#define LOG_INFO (::libfreenect2::LogMessage(logger(), ::libfreenect2::Logger::Info).stream() << "[" << LIBFREENECT2_LOG_SOURCE << "] ")
-#define LOG_WARNING (::libfreenect2::LogMessage(logger(), ::libfreenect2::Logger::Warning).stream() << "[" << LIBFREENECT2_LOG_SOURCE << "] ")
-#define LOG_ERROR (::libfreenect2::LogMessage(logger(), ::libfreenect2::Logger::Error).stream() << "[" << LIBFREENECT2_LOG_SOURCE << "] ")
+#define LOG(LEVEL) (::libfreenect2::LogMessage(::libfreenect2::getGlobalLogger(), ::libfreenect2::Logger::LEVEL).stream() << "[" << LIBFREENECT2_LOG_SOURCE << "] ")
+#define LOG_DEBUG LOG(Debug)
+#define LOG_INFO LOG(Info)
+#define LOG_WARNING LOG(Warning)
+#define LOG_ERROR LOG(Error)
 
 #endif /* LOGGING_H_ */
diff --git a/examples/protonect/include/libfreenect2/packet_pipeline.h b/examples/protonect/include/libfreenect2/packet_pipeline.h
@@ -28,7 +28,6 @@
 #define PACKET_PIPELINE_H_
 
 #include <libfreenect2/config.h>
-#include <libfreenect2/logging.h>
 #include <libfreenect2/data_callback.h>
 #include <libfreenect2/rgb_packet_stream_parser.h>
 #include <libfreenect2/depth_packet_stream_parser.h>
@@ -51,7 +50,7 @@ class LIBFREENECT2_API PacketPipeline
   virtual DepthPacketProcessor *getDepthPacketProcessor() const = 0;
 };
 
-class LIBFREENECT2_API BasePacketPipeline : public PacketPipeline, public WithLoggerImpl
+class LIBFREENECT2_API BasePacketPipeline : public PacketPipeline
 {
 protected:
   RgbPacketStreamParser *rgb_parser_;
@@ -64,8 +63,6 @@ class LIBFREENECT2_API BasePacketPipeline : public PacketPipeline, public WithLo
 
   virtual void initialize();
   virtual DepthPacketProcessor *createDepthPacketProcessor() = 0;
-
-  virtual void onLoggerChanged(Logger *logger);
 public:
   virtual ~BasePacketPipeline();
 
diff --git a/examples/protonect/include/libfreenect2/protocol/command_transaction.h b/examples/protonect/include/libfreenect2/protocol/command_transaction.h
@@ -28,15 +28,14 @@
 #define COMMAND_TRANSACTION_H_
 
 #include <libusb.h>
-#include <libfreenect2/logging.h>
 #include <libfreenect2/protocol/command.h>
 
 namespace libfreenect2
 {
 namespace protocol
 {
 
-class CommandTransaction : public WithLoggerImpl
+class CommandTransaction
 {
 public:
   static const int ResponseCompleteLength = 16;
@@ -64,7 +63,7 @@ class CommandTransaction : public WithLoggerImpl
   };
 
   CommandTransaction(libusb_device_handle *handle, int inbound_endpoint, int outbound_endpoint);
-  virtual ~CommandTransaction();
+  ~CommandTransaction();
 
   void execute(const CommandBase& command, Result& result);
 private:
diff --git a/examples/protonect/include/libfreenect2/protocol/usb_control.h b/examples/protonect/include/libfreenect2/protocol/usb_control.h
@@ -28,7 +28,6 @@
 #define USB_CONTROL_H_
 
 #include <libusb.h>
-#include <libfreenect2/logging.h>
 
 namespace libfreenect2
 {
@@ -62,7 +61,7 @@ namespace protocol
  *
  * The 2. interface can be enabled/disabled by changing its alternate setting to 1/0
  */
-class UsbControl : public WithLoggerImpl
+class UsbControl
 {
 public:
   UsbControl(libusb_device_handle *handle);
diff --git a/examples/protonect/include/libfreenect2/rgb_packet_stream_parser.h b/examples/protonect/include/libfreenect2/rgb_packet_stream_parser.h
@@ -30,7 +30,6 @@
 #include <stddef.h>
 
 #include <libfreenect2/config.h>
-#include <libfreenect2/logging.h>
 #include <libfreenect2/double_buffer.h>
 #include <libfreenect2/rgb_packet_processor.h>
 
@@ -39,7 +38,7 @@
 namespace libfreenect2
 {
 
-class LIBFREENECT2_API RgbPacketStreamParser : public DataCallback, public WithLoggerImpl
+class LIBFREENECT2_API RgbPacketStreamParser : public DataCallback
 {
 public:
   RgbPacketStreamParser();
diff --git a/examples/protonect/include/libfreenect2/usb/transfer_pool.h b/examples/protonect/include/libfreenect2/usb/transfer_pool.h
@@ -30,7 +30,6 @@
 #include <vector>
 #include <libusb.h>
 
-#include <libfreenect2/logging.h>
 #include <libfreenect2/data_callback.h>
 #include <libfreenect2/threading.h>
 
@@ -40,7 +39,7 @@ namespace libfreenect2
 namespace usb
 {
 
-class TransferPool : public WithLoggerImpl
+class TransferPool
 {
 public:
   TransferPool(libusb_device_handle *device_handle, unsigned char device_endpoint);
diff --git a/examples/protonect/src/command_transaction.cpp b/examples/protonect/src/command_transaction.cpp
@@ -25,6 +25,7 @@
  */
 
 #include <libfreenect2/protocol/command_transaction.h>
+#include <libfreenect2/logging.h>
 
 #include <stdint.h>
 
diff --git a/examples/protonect/src/depth_packet_stream_parser.cpp b/examples/protonect/src/depth_packet_stream_parser.cpp
@@ -25,6 +25,7 @@
  */
 
 #include <libfreenect2/depth_packet_stream_parser.h>
+#include <libfreenect2/logging.h>
 #include <memory.h>
 
 namespace libfreenect2
diff --git a/examples/protonect/src/libfreenect2.cpp b/examples/protonect/src/libfreenect2.cpp
@@ -38,14 +38,15 @@
 #include <libfreenect2/protocol/command.h>
 #include <libfreenect2/protocol/response.h>
 #include <libfreenect2/protocol/command_transaction.h>
+#include <libfreenect2/logging.h>
 
 namespace libfreenect2
 {
 using namespace libfreenect2;
 using namespace libfreenect2::usb;
 using namespace libfreenect2::protocol;
 
-class Freenect2DeviceImpl : public Freenect2Device, public WithLoggerImpl
+class Freenect2DeviceImpl : public Freenect2Device
 {
 private:
   enum State
@@ -74,8 +75,6 @@ class Freenect2DeviceImpl : public Freenect2Device, public WithLoggerImpl
   std::string serial_, firmware_;
   Freenect2Device::IrCameraParams ir_camera_params_;
   Freenect2Device::ColorCameraParams rgb_camera_params_;
-protected:
-  virtual void onLoggerChanged(Logger *logger);
 public:
   Freenect2DeviceImpl(Freenect2Impl *context, const PacketPipeline *pipeline, libusb_device *usb_device, libusb_device_handle *usb_device_handle, const std::string &serial);
   virtual ~Freenect2DeviceImpl();
@@ -112,7 +111,7 @@ std::ostream &operator<<(std::ostream &out, const PrintBusAndDevice& dev)
   return out;
 }
 
-class Freenect2Impl : public WithLoggerImpl
+class Freenect2Impl
 {
 private:
   bool managed_usb_context_;
@@ -136,8 +135,6 @@ class Freenect2Impl : public WithLoggerImpl
     usb_context_(reinterpret_cast<libusb_context *>(usb_context)),
     has_device_enumeration_(false)
   {
-    logger_ = createConsoleLoggerWithDefaultLevel();
-
     if(managed_usb_context_)
     {
       int r = libusb_init(&usb_context_);
@@ -151,7 +148,7 @@ class Freenect2Impl : public WithLoggerImpl
     usb_event_loop_.start(usb_context_);
   }
 
-  virtual ~Freenect2Impl()
+  ~Freenect2Impl()
   {
     clearDevices();
     clearDeviceEnumeration();
@@ -164,32 +161,10 @@ class Freenect2Impl : public WithLoggerImpl
       usb_context_ = 0;
     }
 
-    setLoggerInternal(0);
-  }
-
-  void setLoggerInternal(Logger *logger)
-  {
-    Logger *old_logger = logger_;
-    WithLoggerImpl::setLogger(logger);
-    delete old_logger;
-  }
-
-  virtual void setLogger(Logger *logger)
-  {
-    setLoggerInternal(logger != 0 ? logger : createNoopLogger());
-  }
-
-  virtual void onLoggerChanged(Logger *logger)
-  {
-    for(DeviceVector::iterator it = devices_.begin(); it != devices_.end(); ++it)
-    {
-      (*it)->setLogger(logger);
-    }
   }
 
   void addDevice(Freenect2DeviceImpl *device)
   {
-    device->setLogger(logger_);
     devices_.push_back(device);
   }
 
@@ -200,7 +175,6 @@ class Freenect2Impl : public WithLoggerImpl
     if(it != devices_.end())
     {
       devices_.erase(it);
-      device->setLogger(0);
     }
     else
     {
@@ -366,17 +340,6 @@ Freenect2DeviceImpl::~Freenect2DeviceImpl()
   delete pipeline_;
 }
 
-void Freenect2DeviceImpl::onLoggerChanged(Logger *logger)
-{
-  rgb_transfer_pool_.setLogger(logger);
-  ir_transfer_pool_.setLogger(logger);
-  usb_control_.setLogger(logger);
-  command_tx_.setLogger(logger);
-
-  // TODO: is this ok?
-  trySetLogger(const_cast<PacketPipeline *>(pipeline_), logger);
-}
-
 int Freenect2DeviceImpl::nextCommandSeq()
 {
   return command_seq_++;
@@ -686,16 +649,6 @@ Freenect2::~Freenect2()
   delete impl_;
 }
 
-void Freenect2::setLogger(Logger *logger)
-{
-  impl_->setLogger(logger);
-}
-
-Logger *Freenect2::logger()
-{
-  return impl_->logger();
-}
-
 int Freenect2::enumerateDevices()
 {
   impl_->clearDeviceEnumeration();
diff --git a/examples/protonect/src/logging.cpp b/examples/protonect/src/logging.cpp
diff --git a/examples/protonect/src/packet_pipeline.cpp b/examples/protonect/src/packet_pipeline.cpp
diff --git a/examples/protonect/src/rgb_packet_stream_parser.cpp b/examples/protonect/src/rgb_packet_stream_parser.cpp
diff --git a/examples/protonect/src/transfer_pool.cpp b/examples/protonect/src/transfer_pool.cpp
diff --git a/examples/protonect/src/usb_control.cpp b/examples/protonect/src/usb_control.cpp

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,6 @@`
`28`	`28`	`#define USB_CONTROL_H_`
`29`	`29`
`30`	`30`	`#include <libusb.h>`
`31`		`-#include <libfreenect2/logging.h>`
`32`	`31`
`33`	`32`	`namespace libfreenect2`
`34`	`33`	`{`
`@@ -62,7 +61,7 @@ namespace protocol`
`62`	`61`	`*`
`63`	`62`	`* The 2. interface can be enabled/disabled by changing its alternate setting to 1/0`
`64`	`63`	`*/`
`65`		`-class UsbControl : public WithLoggerImpl`
	`64`	`+class UsbControl`
`66`	`65`	`{`
`67`	`66`	`public:`
`68`	`67`	`UsbControl(libusb_device_handle *handle);`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,6 @@`
`30`	`30`	`#include <stddef.h>`
`31`	`31`
`32`	`32`	`#include <libfreenect2/config.h>`
`33`		`-#include <libfreenect2/logging.h>`
`34`	`33`	`#include <libfreenect2/double_buffer.h>`
`35`	`34`	`#include <libfreenect2/rgb_packet_processor.h>`
`36`	`35`
`@@ -39,7 +38,7 @@`
`39`	`38`	`namespace libfreenect2`
`40`	`39`	`{`
`41`	`40`
`42`		`-class LIBFREENECT2_API RgbPacketStreamParser : public DataCallback, public WithLoggerImpl`
	`41`	`+class LIBFREENECT2_API RgbPacketStreamParser : public DataCallback`
`43`	`42`	`{`
`44`	`43`	`public:`
`45`	`44`	`RgbPacketStreamParser();`