X-Git-Url: http://git.tdb.fi/?a=blobdiff_plain;f=source%2Fcore%2Fapplication.h;h=8ff286f3e2cc3202de01d85247a3126191128cbf;hb=99b9121e2158603372c7313400283b622e6754d8;hp=4ae8c5614250819ec6aa28ed83c7cc6461f7ee69;hpb=c2eeec205dbf17f6ca38fda2671c6aaf2d1c505f;p=libs%2Fcore.git

diff --git a/source/core/application.h b/source/core/application.h
index 4ae8c56..8ff286f 100644
--- a/source/core/application.h
+++ b/source/core/application.h
@@ -1,20 +1,16 @@
-/* $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
@@ -22,40 +18,74 @@ protected:
 	protected:
 		Starter();
 	public:
-		virtual ~Starter() { }
+		virtual ~Starter() = default;
 
 		virtual Application *create_app(int, char **) = 0;
 	};
 
-	bool done;
-	int exit_code;
+	bool done = false;
+	int exit_code = 0;
 
 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();
+	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 * = 0, void (*)(void *) = 0);
+
+	/** 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 int run(int, char **, void * =0);
 	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 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
 {
@@ -69,8 +99,9 @@ private:
 	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>