source/core/application.h

   1 #ifndef MSP_CORE_APPLICATION_H_
   2 #define MSP_CORE_APPLICATION_H_
   3
   4 #include <stdexcept>
   5 #include <string>
   6 #include "noncopyable.h"
   7
   8 namespace Msp {
   9
  10 /**
  11 Base class for applications.  See also RegisteredApplication.
  12 */
  13 class Application: private NonCopyable
  14 {
  15 protected:
  16         class Starter
  17         {
  18         protected:
  19                 Starter();
  20         public:
  21                 virtual ~Starter() { }
  22
  23                 virtual Application *create_app(int, char **) = 0;
  24         };
  25
  26         bool done;
  27         int exit_code;
  28
  29 private:
  30         static Starter *starter_;
  31         static Application *app_;
  32         static const char *argv0_;
  33         static std::string name_;
  34         static void *data_;
  35
  36         Application(const Application &);
  37         Application &operator=(const Application &);
  38 protected:
  39         Application(const std::string & = std::string());
  40 public:
  41         virtual ~Application() { }
  42
  43         /** Constructs an instance of the registered application class and runs it.
  44         If the application throws a usage_error, a help message is printed.  The
  45         GetOpt class will throw such exceptions automatically in error conditions.
  46
  47         This function can only be called once.  The global main() function provided
  48         by the library normally does it automatically at program startup. */
  49         static int run(int, char **, void * = 0, void (*)(void *) = 0);
  50
  51         /** Sets application startup info, including argv[0] value and platform-
  52         specific data.
  53
  54         This function can only be called once, and is normally called by
  55         Application::run(). */
  56         static void set_startup_info(const char *, void *);
  57
  58         static void *get_data() { return data_; }
  59         static const char *get_argv0() { return argv0_; }
  60         static const std::string &get_name() { return name_; }
  61
  62 protected:
  63         /** Default main loop.  Calls tick() repeatedly until exit() is called.  A
  64         custom main loop should monitor the done member variable and return
  65         exit_code. */
  66         virtual int main();
  67
  68         /** Sets the specified signal to be delivered to the sighandler member
  69         function. */
  70         void catch_signal(int);
  71
  72         /** Causes the application to exit gracefully with the given exit code. */
  73         void exit(int);
  74
  75         virtual void tick() { }
  76         virtual void sighandler(int) { }
  77
  78 private:
  79         /** Static wrapper function to call a member function of the Application
  80         instance. */
  81         static void sighandler_(int);
  82 };
  83
  84
  85 /**
  86 Registers the class to be used for program startup.  The main application class
  87 should be derived from this.
  88 */
  89 template<typename T>
  90 class RegisteredApplication: public Application
  91 {
  92 private:
  93         class Starter: public Application::Starter
  94         {
  95         public:
  96                 Application *create_app(int argc, char **argv) { return new T(argc, argv); }
  97         };
  98
  99         static Starter starter_;
 100
 101 protected:
 102         RegisteredApplication(const std::string &n = std::string()):
 103                 Application(n)
 104         { (void)starter_; }  // Force the starter into existence
 105 };
 106
 107 template<typename T>
 108 typename RegisteredApplication<T>::Starter RegisteredApplication<T>::starter_;
 109
 110 } // namespace Msp
 111
 112 #endif