From 469bbcf0701e1eb8a6670c23145b0da87357e178 Mon Sep 17 00:00:00 2001
From: Mike Buland <eichlan@xagasoft.com>
Date: Sun, 25 Mar 2012 20:00:08 +0000
Subject: Code is all reorganized.  We're about ready to release.  I should
 write up a little explenation of the arrangement.

---
 src/stable/singleton.h | 68 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 68 insertions(+)
 create mode 100644 src/stable/singleton.h

(limited to 'src/stable/singleton.h')

diff --git a/src/stable/singleton.h b/src/stable/singleton.h
new file mode 100644
index 0000000..13db01b
--- /dev/null
+++ b/src/stable/singleton.h
@@ -0,0 +1,68 @@
+/*
+ * Copyright (C) 2007-2011 Xagasoft, All rights reserved.
+ *
+ * This file is part of the libbu++ library and is released under the
+ * terms of the license contained in the file LICENSE.
+ */
+
+#ifndef BU_SINGLETON_H
+#define BU_SINGLETON_H
+
+#include <stdio.h>
+
+namespace Bu
+{
+	/**
+	 * Provides singleton functionality in a modular sort of way.  Make this the
+	 * base class of any other class and you immediately gain singleton
+	 * functionality.  Be sure to make your constructor and various functions use
+	 * intellegent scoping.  Cleanup and instantiation are performed automatically
+	 * for you at first use and program exit.  There are two things that you must
+	 * do when using this template, first is to inherit from it with the name of
+	 * your class filling in for T and then make this class a friend of your class.
+	 *@code
+	 * // Making the Single Singleton:
+	 * class Single : public Singleton<Single>
+	 * {
+	 * 		friend class Singleton<Single>;
+	 * 	protected:
+	 * 		Single();
+	 * 		...
+	 * };
+	 @endcode
+	 * You can still add public functions and variables to your new Singleton child
+	 * class, but your constructor should be protected (hence the need for the
+	 * friend decleration).
+	 */
+	template <class T>
+	class Singleton
+	{
+	protected:
+		/**
+		 * Private constructor.  This constructor is empty but has a body so that
+		 * you can make your own override of it.  Be sure that you're override is
+		 * also protected.
+		 */
+		Singleton() {};
+
+	private:
+		/**
+		 * Copy constructor, defined so that you could write your own as well.
+		 */
+		Singleton( const Singleton& );
+
+	public:
+		/**
+		 * Get a handle to the contained instance of the contained class.  It is
+		 * a reference.
+		 *@returns A reference to the contained object.
+		 */
+		static T &getInstance()
+		{
+			static T i;
+			return i;
+		}
+	};
+}
+
+#endif
-- 
cgit v1.2.3