Changeset 5924 for branches/newapi

Timestamp:

12/03/07 06:17:48 (12 months ago)

Author:

erijo

Message:

• Replaced static.cpp with a Globals class. This approach has the same advantage as static.cpp with regard to unit-tests. Globals also gives a well defined construct and destruct order of global objects.
• Dropped the {get,set}ThreadLog? idea. It wasn't so great after all. Replaced it with Globals::getDaemonLog() to avoid having to pass around the log to all classes within the daemon.
• Removed PluginManager::setPluginLogSink() since it was no longer needed. The Globals class makes it possible to pass the sink in the constructor.
• Replaced PluginManager::unloadAll() with Globals::cleanup().
• Minor refactoring of main().
• Made some interface dtors protected.

Location:

branches/newapi/licq

Files:

• licq/log.h (modified) (1 diff)
• src/CMakeLists.txt (modified) (1 diff)
• src/daemon.cpp (modified) (9 diffs)
• src/globals.cpp (added)
• src/globals.h (added)
• src/main.cpp (modified) (4 diffs)
• src/plugin/plugincacheimpl.cpp (modified) (2 diffs)
• src/plugin/plugininstanceimpl.cpp (modified) (1 diff)
• src/plugin/pluginlibrary.h (modified) (1 diff)
• src/plugin/pluginloader.h (modified) (1 diff)
• src/plugin/pluginmanager.h (modified) (2 diffs)
• src/plugin/pluginmanagerimpl.cpp (modified) (4 diffs)
• src/plugin/pluginmanagerimpl.h (modified) (3 diffs)
• src/plugin/test/pluginlibrarytest.cpp (modified) (2 diffs)
• src/static.cpp (deleted)
• src/test/log.cpp (modified) (1 diff)
• src/test/log.h (modified) (2 diffs)
• src/util/log.h (modified) (1 diff)

branches/newapi/licq/licq/log.h

@@ -33 +33 @@
 {
 public:
-  /**
-   * Get the calling thread's log. Can only be called from the
-   * daemon's or plugin's main thread (i.e. the thread executing
-   * Plugin::run()).
-   *
-   * @returns The calling thread's log instance.
-   */
-  static Log* getThreadLog();
-
   enum Level
   {

branches/newapi/licq/src/CMakeLists.txt

@@ -1 +1 @@
 set(daemon_SRCS
   daemon.cpp
+  globals.cpp
   main.cpp
-  static.cpp
 
 #   backgroundcodes.c

branches/newapi/licq/src/daemon.cpp

@@ -19 +19 @@
 
 #include "daemon.h"
+#include "globals.h"
 #include "licq/exception/invalidargumentexception.h"
 #include "licq/exception/runtimeexception.h"
@@ -38 +39 @@
 #include <sys/types.h>
 
+Licq::Daemon* Licq::Daemon::getInstance()
+{
+  return LicqDaemon::Globals::getDaemon();
+}
+
 static inline void printLicqVersion(std::ostream& os)
 {
@@ -78 +84 @@
 
 LicqDaemon::Daemon::Daemon()
-  : myLog(*Licq::Log::getThreadLog())
+  : myLog(Globals::getDaemonLog())
 {
   // Empty
@@ -165 +171 @@
   if (vm.count("plugin"))
   {
-    PluginManager* pluginManager = PluginManager::getInstance();
+    PluginManager* pluginManager = Globals::getPluginManager();
 
     std::vector<std::string>
@@ -182 +188 @@
 int LicqDaemon::Daemon::main()
 {
-  PluginManager::getInstance()->unloadAll();
   return 1;
 }
@@ -189 +194 @@
   std::vector< boost::shared_ptr<const Licq::Plugin::Information> >* info)
 {
-  PluginManager::getInstance()->getPluginInformation(info);
+  Globals::getPluginManager()->getPluginInformation(info);
 }
 
@@ -226 +231 @@
 void LicqDaemon::Daemon::setupDefaultPluginPaths(bool reload)
 {
-  PluginCache* cache = PluginManager::getInstance()->getPluginCache();
+  PluginCache* cache = Globals::getPluginManager()->getPluginCache();
   cache->addSearchPath(myBaseDir + ".plugins/");
 
@@ -237 +242 @@
   setupDefaultPluginPaths(false);
 
-  PluginCache* cache = PluginManager::getInstance()->getPluginCache();
+  PluginCache* cache = Globals::getPluginManager()->getPluginCache();
   for (std::vector<std::string>::const_iterator it = paths.begin();
        it != paths.end(); ++it)
@@ -249 +254 @@
 void LicqDaemon::Daemon::printAvailablePlugins(std::ostream& os) const
 {
-  PluginCache* cache = PluginManager::getInstance()->getPluginCache();
+  PluginCache* cache = Globals::getPluginManager()->getPluginCache();
 
   const size_t size = cache->getSize();

branches/newapi/licq/src/main.cpp

@@ -8 +8 @@
 
 #include "daemon.h"
+#include "globals.h"
 #include "licq/exception/exception.h"
 #include "licq/exception/invalidargumentexception.h"
+#include "licq/exception/runtimeexception.h"
+#include "licq/log.h"
 #include "plugin/pluginmanager.h"
-#include "util/log.h"
 #include "util/logdistributor.h"
 #include "util/tr.h"
@@ -20 +22 @@
 
 /*
-#ifdef HAVE_CONFIG_H
-#include "config.h"
-#endif
-
-#include <signal.h>
-#include <cstdlib>
-#include <cstring>
-
-#include <locale>
-
 #include "licq.h"
 #include "licq_sighandler.h"
@@ -40 +32 @@
 }
 #endif
-
-// Localization
-#include "gettext.h"
 */
-
-#include "licq_constants.h"
-
-// define a global variable for the base directory containing the data
-// and config subdirectories
-char BASE_DIR[MAX_FILENAME_LEN];
-char SHARE_DIR[MAX_FILENAME_LEN];
-char LIB_DIR[MAX_FILENAME_LEN];
-unsigned short DEBUG_LEVEL;
 
 int main(int argc, char** argv)
 {
-  // Set up logging
-  LicqDaemon::LogDistributor logDistributor;
-  LicqDaemon::Log::setThreadLog(new LicqDaemon::Log("licq", &logDistributor));
-  Licq::Log& log = *Licq::Log::getThreadLog();
+  int retval = EXIT_SUCCESS;
+
+  LicqDaemon::Globals globals;
+  Licq::Log& log = globals.getDaemonLog();
 
   // Enable logging to stderr
   LicqDaemon::StreamLogSink streamLogSink(std::cerr);
-  logDistributor.registerSink(&streamLogSink);
+  globals.getLogDistributor()->registerSink(&streamLogSink);
   if (!isatty(STDERR_FILENO))
     streamLogSink.setUseColors(false);
 
-  // Configure PluginManager
-  LicqDaemon::PluginManager::getInstance()->setPluginLogSink(&logDistributor);
-
-  // Fail if argv[0] isn't set
-  if (argc < 1)
-  {
-    log.fatal() << tr("Licq requires argv[0] to be set");
-    exit(EXIT_FAILURE);
-  }
-
-  int retval = 0;
   try
   {
     LicqDaemon::setupLocalization();
 
-    LicqDaemon::Daemon* daemon = LicqDaemon::Daemon::getInstance();
+    if (argc < 1)
+      throw Licq::RuntimeException(tr("Licq requires argv[0] to be set"));
+
+    LicqDaemon::Daemon* daemon = globals.getDaemon();
     daemon->installSignalHandlers();
 
+    bool continueAfterInit = false;
     try
     {
-      if (!daemon->init(argc, argv, streamLogSink))
-        exit(EXIT_SUCCESS);
+      continueAfterInit = daemon->init(argc, argv, streamLogSink);
+      if (!continueAfterInit)
+        retval = EXIT_SUCCESS;
     }
     catch (const Licq::InvalidArgumentException& ex)
@@ -94 +68 @@
       std::cerr << ex << "\n";
       std::cerr << tr("Try `%1% --help' for more information.") % argv[0] << "\n";
-      exit(EXIT_FAILURE);
+      retval = EXIT_FAILURE;
     }
 
-    retval = daemon->main();
+    if (continueAfterInit)
+      retval = daemon->main();
   }
   catch (const Licq::Exception& ex)
   {
     log.fatal() << ex;
-    exit(EXIT_FAILURE);
+    retval = EXIT_FAILURE;
   }
   catch (const std::exception& ex)
   {
     log.fatal() << tr("Caught std::exception: %1%") % ex.what();
-    exit(EXIT_FAILURE);
+    retval = EXIT_FAILURE;
   }
   catch (...)
   {
     log.fatal() << tr("Caught unknown exception");
-    exit(EXIT_FAILURE);
+    throw;
   }
 
-  if (retval != 0)
+  globals.cleanup();
+
+  if (retval != EXIT_SUCCESS)
     log.error(tr("Licq finished with exit code %1%") % retval);
 
-  logDistributor.unregisterSink(&streamLogSink);
+  globals.getLogDistributor()->unregisterSink(&streamLogSink);
   return retval;
 
   /*
-#if ENABLE_NLS
-  // prepare daemon localization
-  setlocale(LC_MESSAGES,"");
-  setlocale(LC_CTYPE,"");
-  bindtextdomain(PACKAGE, LOCALEDIR);
-  textdomain(PACKAGE);
-#endif
-
-// Make sure argv[0] is defined otherwise licq will crash if it is NULL
-  if (argv[0] == NULL)
-    argv[0] = strdup("licq");
 #ifdef USE_SOCKS5
    SOCKSinit(argv[0]);

branches/newapi/licq/src/plugin/plugincacheimpl.cpp

@@ -18 +18 @@
  */
 
+#include "globals.h"
 #include "licq/exception/invalidargumentexception.h"
 #include "licq/exception/runtimeexception.h"
@@ -117 +118 @@
 LicqDaemon::PluginCacheImpl::PluginCacheImpl(PluginLoader& loader,
                                              bool testMode)
-  : myLog(*Licq::Log::getThreadLog()),
+  : myLog(Globals::getDaemonLog()),
     myLoader(loader),
     myInTestMode(testMode)

branches/newapi/licq/src/plugin/plugininstanceimpl.cpp

@@ -57 +57 @@
 {
   delete myThread;
+
   myLibrary->destroyPlugin(myPlugin);
+  myPlugin = NULL;
 
   delete static_cast<Log*>(mySetup.log);

branches/newapi/licq/src/plugin/pluginlibrary.h

@@ -33 +33 @@
 {
 public:
-  virtual ~PluginLibrary() {}
-
   virtual unsigned int getPluginAbiVersion() = 0;
   virtual void getPluginInformation(Licq::Plugin::Information* info) = 0;
   virtual Licq::Plugin* createPlugin(const Licq::Plugin::Setup& setup) = 0;
   virtual void destroyPlugin(Licq::Plugin* plugin) = 0;
+
+protected:
+  virtual ~PluginLibrary() { /* Empty */ }
 };
 

branches/newapi/licq/src/plugin/pluginloader.h

@@ -35 +35 @@
 {
 public:
-  virtual ~PluginLoader() {}
+  virtual boost::shared_ptr<PluginLibrary> load(const std::string& filename) = 0;
 
-  virtual boost::shared_ptr<PluginLibrary> load(const std::string& filename) = 0;
+protected:
+  virtual ~PluginLoader() { /* Empty */ }
 };
 

branches/newapi/licq/src/plugin/pluginmanager.h

@@ -27 +27 @@
 #include <vector>
 
-namespace Licq
-{
-class LogSink;
-}
-
 namespace LicqDaemon
 {
@@ -44 +39 @@
 {
 public:
-  /**
-   * @returns The PluginManager singleton.
-   */
-  static PluginManager* getInstance();
-
-  virtual void unloadAll() = 0;
-
-  virtual void setPluginLogSink(Licq::LogSink* sink) = 0;
-
   virtual void getPluginInformation(
     std::vector< boost::shared_ptr<const Licq::Plugin::Information> >* info) = 0;

branches/newapi/licq/src/plugin/pluginmanagerimpl.cpp

@@ -22 +22 @@
 #include "plugin/pluginmanagerimpl.h"
 
-LicqDaemon::PluginManagerImpl::PluginManagerImpl(PluginCache& cache)
+LicqDaemon::PluginManagerImpl::PluginManagerImpl(PluginCache& cache,
+                                                 Licq::LogSink& sink)
   : myCache(cache),
-    myPluginLogSink(NULL)
+    myPluginLogSink(sink)
 {
   // Empty
@@ -32 +33 @@
 {
   // Empty
-}
-
-void LicqDaemon::PluginManagerImpl::unloadAll()
-{
-  myPlugins.clear();
-  myCache.clear();
-  myCache.unloadUnusedLibraries();
-}
-
-void LicqDaemon::PluginManagerImpl::setPluginLogSink(Licq::LogSink* sink)
-{
-  assert(myPluginLogSink == NULL);
-  myPluginLogSink = sink;
 }
 
@@ -61 +49 @@
 loadPlugin(const std::string& filename, int argc, char** argv)
 {
-  assert(myPluginLogSink != NULL);
-
   const size_t index = myCache.getIndex(filename);
 
@@ -71 +57 @@
 
   boost::shared_ptr<PluginInstance>
-      instance(new PluginInstanceImpl(info, lib, *myPluginLogSink));
+      instance(new PluginInstanceImpl(info, lib, myPluginLogSink));
 
   Licq::Plugin::Id id = instance->load(argc, argv);

branches/newapi/licq/src/plugin/pluginmanagerimpl.h

@@ -25 +25 @@
 #include <map>
 
+namespace Licq
+{
+class LogSink;
+}
+
 namespace LicqDaemon
 {
@@ -35 +40 @@
   /**
    * @param cache PluginCache to use.
+   * @param sink LogSink that plugins should use.
    */
-  explicit PluginManagerImpl(PluginCache& cache);
+  PluginManagerImpl(PluginCache& cache, Licq::LogSink& sink);
 
   ~PluginManagerImpl();
-
-  void unloadAll();
-
-  /**
-   * Set the LogSink that plugins will log to. This must have been
-   * called before the first call to loadPlugin().
-   */
-  void setPluginLogSink(Licq::LogSink* sink);
 
   void getPluginInformation(
@@ -61 +59 @@
 private:
   PluginCache& myCache;
-  Licq::LogSink* myPluginLogSink;
+  Licq::LogSink& myPluginLogSink;
   
   typedef std::map<Licq::Plugin::Id,

branches/newapi/licq/src/plugin/test/pluginlibrarytest.cpp

@@ -18 +18 @@
  */
 
+#include "globals.h"
 #include "licq/log.h"
 #include "plugin/pluginlibraryimpl.h"
@@ -108 +109 @@
 
   Licq::Plugin::Setup setup;
-  setup.log = Licq::Log::getThreadLog();
+  setup.log = &LicqDaemon::Globals::getDaemonLog();
   setup.argc = 1;
   setup.argv = (char**)argv;

branches/newapi/licq/src/test/log.cpp

@@ -18 +18 @@
  */
 
+#include "globals.h"
 #include "test/log.h"
 
-Licq::Log* Licq::Log::getThreadLog()
+Licq::Log& LicqDaemon::Globals::getDaemonLog()
 {
   static LicqTest::Log testLog;
-  return &testLog;
+  return testLog;
 }

branches/newapi/licq/src/test/log.h

@@ -30 +30 @@
 /**
  * A log for unit-tests that prints to std::clog. The single instance
- * of this class is returned from Licq::Log::getThreadLog().
+ * of this class is returned from LicqDaemon::Globals::getDaemonLog().
  */
 class Log : public Licq::Log
@@ -49 +49 @@
   ~Log() { /* Empty */ }
 
-  friend class Licq::Log;
+  friend class LicqDaemon::Globals;
 };
 

branches/newapi/licq/src/util/log.h

@@ -44 +44 @@
   Log(const std::string& owner, Licq::LogSink* sink);
 
-  /**
-   * Makes @a log the default log for the calling thread. @a log will
-   * be automatically deleted when the thread exits. This method may
-   * only be called once per thread.
-   *
-   * @see getThreadLog()
-   */
-  static void setThreadLog(const Log* log);
-
   // From Licq::Log
   void log(Level level, const std::string& msg);