]> git.tdb.fi Git - libs/core.git/blobdiff - source/core/application.h
Use vectors for storage in Poller
[libs/core.git] / source / core / application.h
index bd433aafcc3fb16dfd0e0d1bc51c435f6bf5adab..59d5bf110e9706425f113dd43d1d7d0ef2ca1019 100644 (file)
-/* $Id$
-
-This file is part of libmspcore
-Copyright © 2006 Mikko Rasa, Mikkosoft Productions
-Distributed under the LGPL
-*/
 #ifndef MSP_CORE_APPLICATION_H_
 #define MSP_CORE_APPLICATION_H_
 
-#include "semaphore.h"
+#include <stdexcept>
+#include <string>
+#include "noncopyable.h"
 
 namespace Msp {
 
 /**
-Base class for applications.  Inherit the main class from this and add a static
-member of type RegApp<MainClass>.
+Base class for applications.  See also RegisteredApplication.
 */
-class Application
+class Application: private NonCopyable
 {
-public:
-       virtual ~Application() { }
-
-       static int run(int, char **);
-       static void usage(const char *, const char *, bool);
 protected:
-       enum LoopMode
+       class Starter
        {
-               NONE,       /// No main loop - main() will just return
-               SLEEP,      /// Only sleep in the main loop - useful for servers
-               TICK_SLEEP, /// Call tick every iteration, with a short sleep in between
-               TICK_YIELD, /// Call tick every iteration, with sched_yield in between
-               TICK_BUSY   /// Call tick every iteration
-       };
-
-       class RegBase
-       {
-       public:
-               virtual Application *create_app(int, char **)=0;
-               virtual void usage(const char *, const char *, bool)=0;
-               virtual ~RegBase() { }
        protected:
-               RegBase();
-       };
-
-       template<typename T>
-       class RegApp: public RegBase
-       {
+               Starter();
        public:
-               Application *create_app(int argc, char **argv) { return new T(argc, argv); }
-               void usage(const char *r, const char *a, bool b) { T::usage(r, a, b); }
+               virtual ~Starter() { }
+
+               virtual Application *create_app(int, char **) = 0;
        };
 
        bool done;
-       int  exit_code;
+       int exit_code;
+
+private:
+       static Starter *starter_;
+       static Application *app_;
+       static const char *argv0_;
+       static std::string name_;
+       static void *data_;
+
+       Application(const Application &);
+       Application &operator=(const Application &);
+protected:
+       Application(const std::string & = std::string());
+public:
+       virtual ~Application() { }
+
+       /** Constructs an instance of the registered application class and runs it.
+       If the application throws a usage_error, a help message is printed.  The
+       GetOpt class will throw such exceptions automatically in error conditions.
+
+       This function can only be called once.  The global main() function provided
+       by the library normally does it automatically at program startup. */
+       static int run(int, char **, void * =0, void (*)(void *) = 0);
 
-       Application();
+       /** Sets application startup info, including argv[0] value and platform-
+       specific data.
+
+       This function can only be called once, and is normally called by
+       Application::run(). */
+       static void set_startup_info(const char *, void *);
+
+       static void *get_data() { return data_; }
+       static const char *get_argv0() { return argv0_; }
+       static const std::string &get_name() { return name_; }
+
+protected:
+       /** Default main loop.  Calls tick() repeatedly until exit() is called.  A
+       custom main loop should monitor the done member variable and return
+       exit_code. */
        virtual int main();
+
+       /** Sets the specified signal to be delivered to the sighandler member
+       function. */
        void catch_signal(int);
-       void set_loop_mode(LoopMode);
-       void induce_tick();
+
+       /** Causes the application to exit gracefully with the given exit code. */
        void exit(int);
+
        virtual void tick() { }
        virtual void sighandler(int) { }
+
 private:
-       LoopMode     loop_mode_;
-       Semaphore    sleep_sem_;
+       /** Static wrapper function to call a member function of the Application
+       instance. */
+       static void sighandler_(int);
+};
 
-       Application(const Application &);
-       Application &operator=(const Application &);
 
-       static RegBase     *reg_app_;
-       static Application *app_;
+/**
+Registers the class to be used for program startup.  The main application class
+should be derived from this.
+*/
+template<typename T>
+class RegisteredApplication: public Application
+{
+private:
+       class Starter: public Application::Starter
+       {
+       public:
+               Application *create_app(int argc, char **argv) { return new T(argc, argv); }
+       };
 
-       static void sighandler_(int);
-       static void sigalrm_(int) { }
+       static Starter starter_;
+
+protected:
+       RegisteredApplication(const std::string &n = std::string()):
+               Application(n)
+       { (void)starter_; }  // Force the starter into existence
 };
 
+template<typename T>
+typename RegisteredApplication<T>::Starter RegisteredApplication<T>::starter_;
+
 } // namespace Msp
 
 #endif