Annotation of parser3/src/include/pa_pool.h, revision 1.54
1.34 paf 1: /** @file
1.36 paf 2: Parser: pool class decl.
3:
1.27 paf 4: Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
1.36 paf 5:
1.28 paf 6: Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
1.27 paf 7:
1.54 ! parser 8: $Id: pa_pool.h,v 1.53 2001/09/15 11:48:41 parser Exp $
1.1 paf 9: */
10:
11: #ifndef PA_POOL_H
12: #define PA_POOL_H
13:
1.52 parser 14: #include "pa_config_includes.h"
1.1 paf 15:
1.21 paf 16: class Exception;
1.25 paf 17: class Temp_exception;
1.1 paf 18:
1.35 paf 19: /**
1.34 paf 20: Pool mechanizm allows users not to free up allocated memory,
21: leaving that problem to 'pools'.
22:
23: Also holds Exception object, which can be temporary set using
24: Temp_exception auto-object.
1.38 paf 25:
26: @see Pooled
1.34 paf 27: */
1.47 paf 28:
1.1 paf 29: class Pool {
1.25 paf 30: friend Temp_exception;
1.1 paf 31: public:
1.18 paf 32:
1.47 paf 33: Pool(void *astorage) : fstorage(astorage), fcontext(0), ftag(0), fexception(0) {}
1.18 paf 34:
1.40 paf 35: void set_context(void *acontext) { fcontext=acontext; }
36: void *context() { return fcontext; }
1.39 paf 37:
1.47 paf 38: void set_tag(void *atag) { ftag=atag; }
39: void *tag() { return ftag; }
1.44 paf 40:
1.34 paf 41: /// allocates some bytes on pool
1.51 parser 42: void *malloc(size_t size/*, int place=0*/) {
43: return check(real_malloc(size/*, place*/), size);
1.18 paf 44: }
1.34 paf 45: /// allocates some bytes clearing them with zeros
1.18 paf 46: void *calloc(size_t size) {
47: return check(real_calloc(size), size);
48: }
1.39 paf 49:
1.53 parser 50: /// registers a routine to clean up non-pooled allocations
1.54 ! parser 51: void register_cleanup(void (*cleanup) (void *), void *data) {
! 52: if(!real_register_cleanup(cleanup, data))
! 53: fail_register_cleanup();
! 54: }
1.53 parser 55:
56: /// current exception object of the pool
57: Exception& exception() const { return *fexception; }
58:
1.39 paf 59: private:
60:
61: void *fstorage;
1.40 paf 62: void *fcontext;
1.47 paf 63: void *ftag;
1.8 paf 64:
1.50 parser 65: private:
66:
67: //{
68: /// @name implementation defined
1.51 parser 69: void *real_malloc(size_t size/*, int place*/);
1.20 paf 70: void *real_calloc(size_t size);
1.54 ! parser 71: bool real_register_cleanup(void (*cleanup) (void *), void *data);
1.50 parser 72: //}
1.17 paf 73:
1.23 paf 74: private:
1.17 paf 75:
1.34 paf 76: /// checks whether mem allocated OK. throws exception otherwise
1.23 paf 77: void *check(void *ptr, size_t size) {
78: if(ptr)
79: return ptr;
80:
1.54 ! parser 81: fail_alloc(size);
1.23 paf 82:
83: // never reached
84: return 0;
85: }
1.54 ! parser 86: /// throws allocation exception
! 87: void fail_alloc(size_t size) const;
! 88:
! 89: /// throws register cleanup exception
! 90: void fail_register_cleanup() const;
1.23 paf 91:
1.34 paf 92: private: // exception handling
1.17 paf 93:
1.45 paf 94: // exception replacement mechanism is 'private'zed from direct usage
1.34 paf 95: // Temp_exception object enforces paired set/restore
1.23 paf 96: Exception *set_exception(Exception *e){
1.31 paf 97: Exception *r=fexception;
98: fexception=e;
1.23 paf 99: return r;
100: }
101: void restore_exception(Exception *e) {
1.31 paf 102: fexception=e;
1.23 paf 103: }
104:
105: private:
106:
107: // current request's exception object
1.31 paf 108: Exception *fexception;
1.17 paf 109:
1.8 paf 110: private: //disabled
111:
1.18 paf 112: // Pool(const Pool&) {}
1.16 paf 113: Pool& operator = (const Pool&) { return *this; }
1.21 paf 114: };
115:
1.35 paf 116: /**
1.34 paf 117: Base for all classes that are allocated in 'pools'.
118:
119: Holds Pool object. Contains useful wrappers to it's methods.
1.38 paf 120:
121: @see NEW, Temp_exception
1.34 paf 122: */
1.21 paf 123: class Pooled {
1.23 paf 124: // the pool i'm allocated on
1.49 paf 125: Pool *fpool;
1.21 paf 126: public:
1.37 paf 127:
128: /// the Pooled-sole: Pooled instances can be allocated in Pool rather then on heap
1.21 paf 129: static void *operator new(size_t size, Pool& apool) {
1.51 parser 130: return apool.malloc(size/*, 1*/);
1.21 paf 131: }
132:
1.49 paf 133: Pooled(Pool& apool) : fpool(&apool) {}
1.23 paf 134:
1.34 paf 135: /// my pool
1.49 paf 136: Pool& pool() const { return *fpool; }
137:
138: /** used for moving objects from one pool to another.
139: in between object can have no pool and can not be used
140: @see SQL_Driver_manager
141: */
142: void set_pool(Pool *apool) { fpool=apool; }
1.21 paf 143:
1.34 paf 144: /// useful wrapper around pool
1.49 paf 145: void *malloc(size_t size) const { return fpool->malloc(size); }
1.34 paf 146: /// useful wrapper around pool
1.49 paf 147: void *calloc(size_t size) const { return fpool->calloc(size); }
1.53 parser 148: /// useful wrapper around pool
149: void register_cleanup(void (*cleanup) (void *), void *data) {
150: fpool->register_cleanup(cleanup, data);
151: }
1.34 paf 152: /// useful wrapper around pool
1.49 paf 153: Exception& exception() const { return fpool->exception(); }
1.23 paf 154: };
1.34 paf 155: /// useful macro for creating objects on current Pooled object Pooled::pool()
1.23 paf 156: #define NEW new(pool())
157:
1.35 paf 158: /**
1.34 paf 159: Auto-object used for temporary changing Pool's exception().
160:
161: Use by with these macros:
1.38 paf 162: @code
1.34 paf 163: TRY {
1.38 paf 164: // ...
1.34 paf 165: if(?)
166: THROW(?);
1.38 paf 167: // ...
1.34 paf 168: } CATCH(e) {
1.38 paf 169: // code, using e fields
170: // e.comment()
1.34 paf 171: }
172: END_CATCH
1.38 paf 173: @endcode
174:
175: @see TRY, THROW
1.34 paf 176: */
1.25 paf 177: class Temp_exception {
1.29 paf 178: Pool& fpool;
1.23 paf 179: Exception *saved_exception;
180: public:
1.25 paf 181: Temp_exception(Pool& apool, Exception& exception) :
1.29 paf 182: fpool(apool),
1.23 paf 183: saved_exception(apool.set_exception(&exception)) {
184: }
1.25 paf 185: ~Temp_exception() {
1.29 paf 186: fpool.restore_exception(saved_exception);
1.23 paf 187: }
1.1 paf 188: };
1.23 paf 189:
1.33 paf 190: #define XTRY(pool) \
1.24 paf 191: { \
192: Exception temp_exception; \
1.33 paf 193: Temp_exception le(pool, temp_exception); \
1.24 paf 194: if(setjmp(temp_exception.mark)==0)
1.31 paf 195:
1.33 paf 196: #define XTHROW(exception) exception._throw
197: #define XCATCH(e) \
1.24 paf 198: else{ \
199: Exception& e=temp_exception;
1.31 paf 200:
1.33 paf 201: #define XEND_CATCH \
1.24 paf 202: } \
203: }
1.33 paf 204:
1.34 paf 205: //@{
206: /// @see Temp_exception
1.33 paf 207: #define TRY XTRY(pool())
208: #define THROW XTHROW(exception())
209: #define CATCH(e) XCATCH(e)
210: #define END_CATCH XEND_CATCH
211:
212: #define PTRY XTRY(pool)
213: #define PTHROW XTHROW(pool.exception())
214: #define PCATCH(e) XCATCH(e)
215: #define PEND_CATCH XEND_CATCH
1.34 paf 216: //@}
1.1 paf 217:
218: #endif
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to pa_pool.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3 / src / include