JobCModuleRegistry.h

Go to the documentation of this file.

// $Id: JobCModuleRegistry.h,v 1.16 2009/02/28 21:46:13 gmieg Exp $
//
// Provide a single registry for all job modules
//
// messier@huhepl.harvard.edu
#ifndef JOBCMODULEREGISTRY_H
#define JOBCMODULEREGISTRY_H

#include <cassert>
#ifndef LIST
#include <list>
#define LIST
#endif
#ifndef MAP
#include <map>
#define MAP
#endif
#ifndef STRING
#include <string>
#define STRING
#endif
#ifndef JOBCMODULEPROXY_H
#include "JobControl/JobCModuleProxy.h"
#endif
#ifndef __CINT__ // CINT can't possibly understand this. Its C++!
# ifdef SITE_HAS_SIGC // temporary work around
#  ifndef SIGNAL_SYSTEM_H
#   include <sigc++/signal.h>
#   define SIGNAL_SYSTEM_H
#  endif
# endif
#endif

class JobCModule;

class JobCModuleRegistry
{
  friend std::ostream& operator<<(std::ostream& os, 
                                  const JobCModuleRegistry& jcr);
public:
  ~JobCModuleRegistry();

  static JobCModuleRegistry& Instance();

  void             Register(JobCModuleProxy *jobcModuleProxy);
  JobCModuleProxy* LookUp(const char *name, bool loadlibs=true);

private:
  // Singleton
  JobCModuleRegistry();
  JobCModuleRegistry(JobCModuleRegistry& /* jcmr */) { abort(); }
  JobCModuleRegistry& operator=(const JobCModuleRegistry& /* jcmr */ ) { 
    abort(); return *this;
  }
  int BuildModToLibMap();
  int CheckLibMap(const std::string& mod);
  struct Cleaner {
    void ClassIsUsed() { } // Dummy method to avoid compiler warnings
    ~Cleaner() {
      if (JobCModuleRegistry::fInstance!=0) {
        delete JobCModuleRegistry::fInstance;
        JobCModuleRegistry::fInstance = 0;
      }
    }
  };
  friend struct Cleaner;

#ifdef SITE_HAS_SIGC // temporary
# ifndef __CINT__
public:
  // Define a signal for when a new module is loaded. Send the
  // module's name
  SigC::Signal1<void,const char*> SigRegister;
# endif
#endif

private:
  static JobCModuleRegistry*        fInstance;   // The sole instance of class
  std::list<JobCModuleProxy*>       fModuleTable;// The set of proxies loaded
  std::map<std::string,std::string> fModLibMap;  // Module to library map
};


//
// Define a macro to allow users to register their modules
//
#define JOBMODULE(CLASS, NAME, FUNC)                              \
static class gs__Register__##CLASS##__ : public JobCModuleProxy { \
public:                                                           \
  gs__Register__##CLASS##__() {                                   \
    fName = NAME;                                                 \
    fFunc = FUNC;                                                 \
    JobCModuleRegistry::Instance().Register(this);                \
  }                                                               \
  JobCModule *CreateModule()       {                              \
    JobCModule* m = new CLASS();                                  \
    m->Init(NAME);                                                \
    return m;                                                     \
  }                                                               \
} gs__module__##CLASS##__proxy__

#endif // JOBCMODULEREGISTRY_H

---