--- parser3/src/include/pa_pool.h 2001/03/13 11:15:03 1.30 +++ parser3/src/include/pa_pool.h 2001/05/17 10:22:24 1.52 @@ -1,57 +1,72 @@ -/* - Parser +/** @file + Parser: pool class decl. + Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com) + Author: Alexander Petrosyan (http://design.ru/paf) - $Id: pa_pool.h,v 1.30 2001/03/13 11:15:03 paf Exp $ + $Id: pa_pool.h,v 1.52 2001/05/17 10:22:24 parser Exp $ */ #ifndef PA_POOL_H #define PA_POOL_H -#include +#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_to_trhow(0), - fpending_exception(0) { - } - ~Pool() {} + Pool(void *astorage) : fstorage(astorage), fcontext(0), ftag(0), fexception(0) {} + + void set_context(void *acontext) { fcontext=acontext; } + void *context() { return fcontext; } - Exception& exception_to_throw() const { return *fexception_to_throw; } - //Exception *pending_exception() const { return fpending_exception; } + void set_tag(void *atag) { ftag=atag; } + void *tag() { return ftag; } - void *malloc(size_t size) { - return check(real_malloc(size), size); + /// current exception object of the pool + Exception& exception() const { return *fexception; } + + /// 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); } - void maybe_rethrow_pending_exception() { - if(fpending_exception) - fexception_to_throw._throw( - fpending_exception.type(), - fpending_exception.code(), - fpending_exception.problem_source(), - fpending_exception.comment() - ); - } +private: -private: // implementation defined + void *fstorage; + void *fcontext; + void *ftag; - void *real_malloc(size_t size); +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; @@ -61,30 +76,26 @@ 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_to_throw; - fexception_to_throw=e; + Exception *r=fexception; + fexception=e; return r; } void restore_exception(Exception *e) { - fpending_exception=fexception_to_throw.is_handled()?0:fexception_to_throw; - fexception_to_throw=e; + fexception=e; } private: // current request's exception object - Exception *fexception_to_throw; - - // just catched request's exception object - Exception *fpending_exception; + Exception *fexception; private: //disabled @@ -92,25 +103,63 @@ 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); } + /** 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 + 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; @@ -122,44 +171,34 @@ public: ~Temp_exception() { fpool.restore_exception(saved_exception); } -public: - bool triggered; }; -#define XTRY(p) \ +#define XTRY(pool) \ { \ Exception temp_exception; \ - Temp_exception le(p, temp_exception); \ + Temp_exception le(pool, temp_exception); \ if(setjmp(temp_exception.mark)==0) -#define XTHROW(p) p.exception_to_throw()._throw + +#define XTHROW(exception) exception._throw #define XCATCH(e) \ else{ \ Exception& e=temp_exception; -#define XFINALLY(p) \ + +#define XEND_CATCH \ } \ - p.maybe_rethrow_pending_exception(); -#define XEND_TRY \ } -// usage: -// TRY { ...; if(?) RAISE(?); ...; } CATCH(e) { catch-code e.comment() } END_TRY - +//@{ +/// @see Temp_exception #define TRY XTRY(pool()) -#define THROW XTHROW(pool()) +#define THROW XTHROW(exception()) #define CATCH(e) XCATCH(e) -#define FINALLY(p) XFINALLY(pool()) -#define END_TRY XEND_TRY +#define END_CATCH XEND_CATCH #define PTRY XTRY(pool) -#define PTHROW XTHROW(pool) +#define PTHROW XTHROW(pool.exception()) #define PCATCH(e) XCATCH(e) -#define PINALLY(p) XFINALLY(pool) -#define PEND_TRY XEND_TRY - -#define RTRY XTRY(r.pool()) -#define RTHROW XTHROW(r.pool()) -#define RCATCH(e) XCATCH(e) -#define RFINALLY(p) XFINALLY(r.pool()) -#define REND_TRY XEND_TRY +#define PEND_CATCH XEND_CATCH +//@} #endif