-/* $Id$
-
-This file is part of libmspcore
-Copyright © 2006-2008, 2011 Mikko Rasa, Mikkosoft Productions
-Distributed under the LGPL
-*/
-
#ifndef MSP_CORE_APPLICATION_H_
#define MSP_CORE_APPLICATION_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
{
protected:
class Starter
protected:
Starter();
public:
- virtual ~Starter() { }
+ virtual ~Starter() = default;
virtual Application *create_app(int, char **) = 0;
- virtual void usage(const char *, const char *, bool) = 0;
};
- bool done;
- int exit_code;
+ bool done = false;
+ int exit_code = 0;
private:
- static Starter *starter_;
- static Application *app_;
- static void *data_;
+ 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();
+ Application(const std::string & = std::string());
public:
- virtual ~Application() { }
+ virtual ~Application() = default;
+
+ /** 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 * = nullptr, void (*)(void *) = nullptr);
+
+ /** Sets application startup info, including argv[0] value and platform-
+ specific data.
- static int run(int, char **, void * =0);
- static void usage(const char *, const char *, bool);
- static void *get_data() { return 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);
+
+ /** Causes the application to exit gracefully with the given exit code. */
void exit(int);
+
virtual void tick() { }
virtual void sighandler(int) { }
+
private:
- static void sighandler_(int);
+ /** Static wrapper function to call a member function of the Application
+ instance. */
+ static void _sighandler(int);
};
+/**
+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
{
{
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); }
};
- static Starter starter_;
+ static Starter _starter;
protected:
- // Force the starter into existence
- RegisteredApplication() { (void)starter_; }
+ 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_;
+typename RegisteredApplication<T>::Starter RegisteredApplication<T>::_starter;
} // namespace Msp