X-Git-Url: http://deadsoftware.ru/gitweb?p=odcread.git;a=blobdiff_plain;f=typeregister.h;h=52a542821a93877baf7cae8f9a4dbcaa7d4d58d1;hp=d647b5bc00f513be88743013156bfe10809cd2ae;hb=2466c23751f131a07432df964658c2de90315e7b;hpb=c71568094a35bbda781ac2070e50a59a3b5ac9f7

diff --git a/typeregister.h b/typeregister.h
index d647b5b..52a5428 100644
--- a/typeregister.h
+++ b/typeregister.h
@@ -9,6 +9,11 @@ namespace odc {
 	class Store;
 	class TypeProxyBase; // forward declaration
 
+	/**
+	 * Register of Oberon/BlackBox types.
+	 * Each type has a registered name, which refers to the full BlackBox type name (including any modules).
+	 * It also (optionally) has a supertype (also referred to by the full BlackBox type name).
+	 */
 	class TypeRegister {
 		static TypeRegister *s_instance;
 
@@ -19,28 +24,79 @@ namespace odc {
 		TypeRegister &operator=(const TypeRegister &other); // NI
 
 		public:
+		/**
+		 * Get an instance of the type register (singleton pattern).
+		 */
 		static TypeRegister &getInstance();
 
+		/**
+		 * Register a new type.
+		 */
 		void add(const std::string &name, TypeProxyBase *proxy);
+
+		/**
+		 * Get a type's proxy.
+		 */
 		const TypeProxyBase *get(const std::string &name);
 	};
 
+	/**
+	 * Proxy to represent a BlackBox type. Has a name and optional supertype name.
+	 * Can instantiate new instances of the type.
+	 */
 	class TypeProxyBase {
 		public:
+		/**
+		 * Create a new TypeProxy and register it with the TypeRegister.
+		 */
 		TypeProxyBase(const std::string &name);
+		/**
+		 * @return The full BlackBox type name (including modules).
+		 */
 		virtual const std::string &getName() const = 0;
+		/**
+		 * @return The full BlackBox type name of the supertype (if applicable, otherwise a 0-pointer).
+		 */
 		virtual const std::string *getSuper() const = 0;
+		/**
+		 * @return A new instance of the type, with the given ID.
+		 */
 		virtual Store *newInstance(INTEGER id) const = 0;
 	};
 
-	template <class T> class TypeProxy : public TypeProxyBase {
+	/**
+	 * Proxy for a toplevel type (no supertype).
+	 * T: the class to proxy for.
+	 * Requires T to have a static const std::string TYPENAME.
+	 */
+	template <class T> class TopTypeProxy : public TypeProxyBase {
+		public:
+		TopTypeProxy(): TypeProxyBase(T::TYPENAME) {}
+		virtual const std::string &getName() const {
+			return T::TYPENAME;
+		}
+		virtual const std::string *getSuper() const {
+			return 0;
+		}
+		virtual Store *newInstance(INTEGER id) const {
+			return new T(id);
+		}
+	};
+
+	/**
+	 * Proxy for a derived type (with supertype).
+	 * T: the class to proxy for.
+	 * S: the supertype.
+	 * Requires T, S to have a static const std::string TYPENAME.
+	 */
+	template <class T, class S> class TypeProxy : public TypeProxyBase {
 		public:
-		TypeProxy(): TypeProxyBase(T::getType()) {}
+		TypeProxy(): TypeProxyBase(T::TYPENAME) {}
 		virtual const std::string &getName() const {
-			return T::getType();
+			return T::TYPENAME;
 		}
 		virtual const std::string *getSuper() const {
-			return T::getSuper();
+			return &S::TYPENAME;
 		}
 		virtual Store *newInstance(INTEGER id) const {
 			return new T(id);