Annotation of parser3/src/include/pa_pool.h, revision 1.43

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.43    ! paf         8:        $Id: pa_pool.h,v 1.42 2001/03/22 17:13:43 paf Exp $
1.1       paf         9: */
                     10: 
                     11: #ifndef PA_POOL_H
                     12: #define PA_POOL_H
                     13: 
                     14: #include <stddef.h>
                     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: */
                     28: 
1.1       paf        29: class Pool {
1.25      paf        30:        friend Temp_exception;
1.1       paf        31: public:
1.18      paf        32: 
1.43    ! paf        33:        Pool(void *astorage) : fstorage(astorage), fcontext(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.34      paf        38:        /// current exception object of the pool
1.31      paf        39:        Exception& exception() const { return *fexception; }
1.18      paf        40: 
1.34      paf        41:        /// allocates some bytes on pool
1.18      paf        42:        void *malloc(size_t size) {
                     43:                return check(real_malloc(size), size);
                     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: 
                     50: private:
                     51: 
                     52:        void *fstorage;
1.40      paf        53:        void *fcontext;
1.8       paf        54: 
1.23      paf        55: private: // implementation defined
1.18      paf        56: 
1.20      paf        57:     void *real_malloc(size_t size);
                     58:     void *real_calloc(size_t size);
1.17      paf        59: 
1.23      paf        60: private: 
1.17      paf        61: 
1.34      paf        62:        /// checks whether mem allocated OK. throws exception otherwise
1.23      paf        63:        void *check(void *ptr, size_t size) {
                     64:                if(ptr)
                     65:                        return ptr;
                     66: 
                     67:                fail(size);
                     68: 
                     69:                // never reached
                     70:                return 0;
                     71:        }
1.34      paf        72:        /// throws proper exception
1.23      paf        73:        void fail(size_t size) const;
                     74: 
1.34      paf        75: private: // exception handling
1.17      paf        76: 
1.23      paf        77:        // exception replacement mechanism is 'protected' from direct usage
1.34      paf        78:        // Temp_exception object enforces paired set/restore
1.23      paf        79:        Exception *set_exception(Exception *e){
1.31      paf        80:                Exception *r=fexception;
                     81:                fexception=e;
1.23      paf        82:                return r;
                     83:        }
                     84:        void restore_exception(Exception *e) {
1.31      paf        85:                fexception=e;
1.23      paf        86:        }
                     87: 
                     88: private:
                     89: 
                     90:        // current request's exception object
1.31      paf        91:        Exception *fexception;
1.17      paf        92: 
1.8       paf        93: private: //disabled
                     94: 
1.18      paf        95:        // Pool(const Pool&) {}
1.16      paf        96:        Pool& operator = (const Pool&) { return *this; }
1.21      paf        97: };
                     98: 
1.35      paf        99: /** 
1.34      paf       100:        Base for all classes that are allocated in 'pools'.
                    101: 
                    102:        Holds Pool object. Contains useful wrappers to it's methods.
1.38      paf       103: 
                    104:        @see NEW, Temp_exception
1.34      paf       105: */
1.21      paf       106: class Pooled {
1.23      paf       107:        // the pool i'm allocated on
                    108:        Pool& fpool;
1.21      paf       109: public:
1.37      paf       110: 
                    111:        /// the Pooled-sole: Pooled instances can be allocated in Pool rather then on heap
1.21      paf       112:        static void *operator new(size_t size, Pool& apool) { 
                    113:                return apool.malloc(size);
                    114:        }
                    115: 
1.23      paf       116:        Pooled(Pool& apool) : fpool(apool) {
                    117:        }
                    118: 
1.34      paf       119:        /// my pool
1.22      paf       120:        Pool& pool() const { return fpool; }
1.21      paf       121: 
1.34      paf       122:        /// useful wrapper around pool
1.23      paf       123:        void *malloc(size_t size) const { return fpool.malloc(size); }
1.34      paf       124:        /// useful wrapper around pool
1.23      paf       125:        void *calloc(size_t size) const { return fpool.calloc(size); }
1.34      paf       126:        /// useful wrapper around pool
1.31      paf       127:        Exception& exception() const { return fpool.exception(); }
1.23      paf       128: };
1.34      paf       129: /// useful macro for creating objects on current Pooled object Pooled::pool()
1.23      paf       130: #define NEW new(pool())
                    131: 
1.35      paf       132: /** 
1.34      paf       133:        Auto-object used for temporary changing Pool's exception().
                    134: 
                    135:        Use by with these macros:
1.38      paf       136:        @code
1.34      paf       137:                TRY { 
1.38      paf       138:                        // ... 
1.34      paf       139:                        if(?) 
                    140:                                THROW(?); 
1.38      paf       141:                        // ...
1.34      paf       142:                } CATCH(e) { 
1.38      paf       143:                        // code, using e fields
                    144:                        // e.comment() 
1.34      paf       145:                }
                    146:                END_CATCH
1.38      paf       147:        @endcode
                    148: 
                    149:        @see TRY, THROW
1.34      paf       150: */
1.25      paf       151: class Temp_exception {
1.29      paf       152:        Pool& fpool;
1.23      paf       153:        Exception *saved_exception;
                    154: public:
1.25      paf       155:        Temp_exception(Pool& apool, Exception& exception) : 
1.29      paf       156:                fpool(apool),
1.23      paf       157:                saved_exception(apool.set_exception(&exception)) {
                    158:        }
1.25      paf       159:        ~Temp_exception() { 
1.29      paf       160:                fpool.restore_exception(saved_exception); 
1.23      paf       161:        }
1.1       paf       162: };
1.23      paf       163: 
1.33      paf       164: #define XTRY(pool) \
1.24      paf       165:        { \
                    166:                Exception temp_exception; \
1.33      paf       167:                Temp_exception le(pool, temp_exception); \
1.24      paf       168:                if(setjmp(temp_exception.mark)==0)
1.31      paf       169: 
1.33      paf       170: #define XTHROW(exception) exception._throw
                    171: #define XCATCH(e) \
1.24      paf       172:                else{ \
                    173:                        Exception& e=temp_exception;
1.31      paf       174: 
1.33      paf       175: #define XEND_CATCH \
1.24      paf       176:                } \
                    177:        }
1.33      paf       178: 
1.34      paf       179: //@{
                    180: /// @see Temp_exception 
1.33      paf       181: #define TRY XTRY(pool())
                    182: #define THROW XTHROW(exception())
                    183: #define CATCH(e) XCATCH(e)
                    184: #define END_CATCH XEND_CATCH 
                    185: 
                    186: #define PTRY XTRY(pool)
                    187: #define PTHROW XTHROW(pool.exception())
                    188: #define PCATCH(e) XCATCH(e)
                    189: #define PEND_CATCH XEND_CATCH 
                    190: 
                    191: #define RTHROW XTHROW(r.pool().exception())
1.34      paf       192: //@}
1.1       paf       193: 
                    194: #endif

E-mail: