--- parser3/src/include/pa_pool.h	2001/03/13 16:38:22	1.32
+++ parser3/src/include/pa_pool.h	2001/09/15 11:48:41	1.53
@@ -1,43 +1,75 @@
-/*
-	Parser
+/** @file
+	Parser: pool class decl.
+
 	Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
+
 	Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
 
-	$Id: pa_pool.h,v 1.32 2001/03/13 16:38:22 paf Exp $
+	$Id: pa_pool.h,v 1.53 2001/09/15 11:48:41 parser Exp $
 */
 
 #ifndef PA_POOL_H
 #define PA_POOL_H
 
-#include <stddef.h>
+#include "pa_config_includes.h"
 
 class Exception;
 class Temp_exception;
 
+/** 
+	Pool mechanizm allows users not to free up allocated memory,
+	leaving that problem to 'pools'.
+
+	Also holds Exception object, which can be temporary set using 
+	Temp_exception auto-object.
+
+	@see Pooled
+*/
+
 class Pool {
 	friend Temp_exception;
 public:
 
-	Pool() : fexception(0) {}
-	~Pool() {}
+	Pool(void *astorage) : fstorage(astorage), fcontext(0), ftag(0), fexception(0) {}
 
-	Exception& exception() const { return *fexception; }
+	void set_context(void *acontext) { fcontext=acontext; }
+	void *context() { return fcontext; }
 
-	void *malloc(size_t size) {
-		return check(real_malloc(size), size);
+	void set_tag(void *atag) { ftag=atag; }
+	void *tag() { return ftag; }
+
+	/// allocates some bytes on pool
+	void *malloc(size_t size/*, int place=0*/) {
+		return check(real_malloc(size/*, place*/), size);
 	}
+	/// allocates some bytes clearing them with zeros
 	void *calloc(size_t size) {
 		return check(real_calloc(size), size);
 	}
 
-private: // implementation defined
+	/// registers a routine to clean up non-pooled allocations
+	void register_cleanup(void (*cleanup) (void *), void *data);
+
+	/// current exception object of the pool
+	Exception& exception() const { return *fexception; }
 
-    void *real_malloc(size_t size);
+private:
+
+	void *fstorage;
+	void *fcontext;
+	void *ftag;
+
+private: 
+	
+	//{
+	/// @name implementation defined
+    void *real_malloc(size_t size/*, int place*/);
     void *real_calloc(size_t size);
+	//}
 
 private: 
 
-	// checks whether mem allocated OK. throws exception otherwise
+	/// checks whether mem allocated OK. throws exception otherwise
 	void *check(void *ptr, size_t size) {
 		if(ptr)
 			return ptr;
@@ -47,13 +79,13 @@ private:
 		// never reached
 		return 0;
 	}
-	// throws proper exception
+	/// throws proper exception
 	void fail(size_t size) const;
 
-protected: // exception handling
+private: // exception handling
 
-	// exception replacement mechanism is 'protected' from direct usage
-	// Temp_exception_change object enforces paired set/restore
+	// exception replacement mechanism is 'private'zed from direct usage
+	// Temp_exception object enforces paired set/restore
 	Exception *set_exception(Exception *e){
 		Exception *r=fexception;
 		fexception=e;
@@ -74,26 +106,67 @@ private: //disabled
 	Pool& operator = (const Pool&) { return *this; }
 };
 
+/** 
+	Base for all classes that are allocated in 'pools'.
+
+	Holds Pool object. Contains useful wrappers to it's methods.
+
+	@see NEW, Temp_exception
+*/
 class Pooled {
 	// the pool i'm allocated on
-	Pool& fpool;
+	Pool *fpool;
 public:
-	
+
+	/// the Pooled-sole: Pooled instances can be allocated in Pool rather then on heap
 	static void *operator new(size_t size, Pool& apool) { 
-		return apool.malloc(size);
+		return apool.malloc(size/*, 1*/);
 	}
 
-	Pooled(Pool& apool) : fpool(apool) {
-	}
+	Pooled(Pool& apool) : fpool(&apool) {}
 
-	Pool& pool() const { return fpool; }
+	/// my pool
+	Pool& pool() const { return *fpool; }
 
-	void *malloc(size_t size) const { return fpool.malloc(size); }
-	void *calloc(size_t size) const { return fpool.calloc(size); }
-	Exception& exception() const { return fpool.exception(); }
+	/** used for moving objects from one pool to another. 
+		in between object can have no pool and can not be used
+		@see SQL_Driver_manager
+	*/
+	void set_pool(Pool *apool) { fpool=apool; }
+
+	/// useful wrapper around pool
+	void *malloc(size_t size) const { return fpool->malloc(size); }
+	/// useful wrapper around pool
+	void *calloc(size_t size) const { return fpool->calloc(size); }
+	/// useful wrapper around pool
+	void register_cleanup(void (*cleanup) (void *), void *data) { 
+		fpool->register_cleanup(cleanup, data);
+	}
+	/// useful wrapper around pool
+	Exception& exception() const { return fpool->exception(); }
 };
+/// useful macro for creating objects on current Pooled object Pooled::pool()
 #define NEW new(pool())
 
+/** 
+	Auto-object used for temporary changing Pool's exception().
+
+	Use by with these macros:
+	@code
+		TRY { 
+			// ... 
+			if(?) 
+				THROW(?); 
+			// ...
+		} CATCH(e) { 
+			// code, using e fields
+			// e.comment() 
+		}
+		END_CATCH
+	@endcode
+
+	@see TRY, THROW
+*/
 class Temp_exception {
 	Pool& fpool;
 	Exception *saved_exception;
@@ -107,23 +180,32 @@ public:
 	}
 };
 
-#define TRY \
+#define XTRY(pool) \
 	{ \
 		Exception temp_exception; \
-		Temp_exception le(pool(), temp_exception); \
+		Temp_exception le(pool, temp_exception); \
 		if(setjmp(temp_exception.mark)==0)
 
-#define THROW exception()._throw
-#define PTHROW pool.exception()._throw
-#define RTHROW r.pool().exception()._throw
-#define CATCH(e) \
+#define XTHROW(exception) exception._throw
+#define XCATCH(e) \
 		else{ \
 			Exception& e=temp_exception;
 
-#define END_CATCH \
+#define XEND_CATCH \
 		} \
 	}
-// usage:
-//   TRY { ...; if(?) RAISE(?); ...; } CATCH(e) { catch-code e.comment() } END_CATCH
+
+//@{
+/// @see Temp_exception 
+#define TRY XTRY(pool())
+#define THROW XTHROW(exception())
+#define CATCH(e) XCATCH(e)
+#define END_CATCH XEND_CATCH 
+
+#define PTRY XTRY(pool)
+#define PTHROW XTHROW(pool.exception())
+#define PCATCH(e) XCATCH(e)
+#define PEND_CATCH XEND_CATCH 
+//@}
 
 #endif