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

1.34      paf         1: /** @file
1.36      paf         2:        Parser: pool class decl.
                      3: 
1.77      paf         4:        Copyright (c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com)
1.36      paf         5: 
1.78      paf         6:        Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.27      paf         7: 
1.79    ! paf         8:        $Id: pa_pool.h,v 1.78 2002/02/08 08:30:13 paf 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.59      parser     16: #ifdef XML
1.75      paf        17: #      include "gdome.h"
1.76      paf        18: // for xmlChar
                     19: #      include "libxml/tree.h"
1.59      parser     20: #endif
1.55      parser     21: 
                     22: // forwards
                     23: 
1.21      paf        24: class Exception;
1.55      parser     25: class String;
1.73      paf        26: class Charset;
1.75      paf        27: class GdomeDOMString_auto_ptr;
1.55      parser     28: 
1.35      paf        29: /** 
1.34      paf        30:        Pool mechanizm allows users not to free up allocated memory,
                     31:        leaving that problem to 'pools'.
                     32: 
1.38      paf        33:        @see Pooled
1.34      paf        34: */
1.47      paf        35: 
1.1       paf        36: class Pool {
                     37: public:
1.18      paf        38: 
1.55      parser     39:        Pool(void *astorage);
1.18      paf        40: 
1.79    ! paf        41:        //{@ statistics
1.70      paf        42:        size_t total_allocated() { return ftotal_allocated; }
                     43:        unsigned int total_times() { return ftotal_times; }
1.79    ! paf        44:        //}@
1.70      paf        45: 
1.40      paf        46:        void set_context(void *acontext) { fcontext=acontext; }
1.64      parser     47:        void *get_context() { return fcontext; }
1.39      paf        48: 
1.34      paf        49:        /// allocates some bytes on pool
1.68      paf        50:        void *malloc(size_t size, int place=0) {
                     51:                return check(real_malloc(size, place), size);
1.18      paf        52:        }
1.34      paf        53:        /// allocates some bytes clearing them with zeros
1.18      paf        54:        void *calloc(size_t size) {
                     55:                return check(real_calloc(size), size);
                     56:        }
1.39      paf        57: 
1.53      parser     58:        /// registers a routine to clean up non-pooled allocations
1.54      parser     59:        void register_cleanup(void (*cleanup) (void *), void *data) {
                     60:                if(!real_register_cleanup(cleanup, data))
                     61:                        fail_register_cleanup();
                     62:        }
1.53      parser     63: 
1.79    ! paf        64:        //{@ source charset
1.73      paf        65:        void set_source_charset(Charset& acharset);
                     66:        Charset& get_source_charset();
1.79    ! paf        67:        //}@
1.73      paf        68: 
1.79    ! paf        69:        //{@ client charset
1.73      paf        70:        void set_client_charset(Charset& charset);
                     71:        Charset& get_client_charset();
1.79    ! paf        72:        //}@
1.73      paf        73: 
                     74: #ifdef XML
1.74      paf        75: 
1.76      paf        76:        /// @see Charset::transcode_cstr(xmlChar *s);
                     77:        const char *transcode_cstr(xmlChar *s);
                     78:        /// @see Charset::transcode(xmlChar *s);
                     79:        String& transcode(xmlChar *s);
                     80:        /// @see Charset::transcode_cstr(GdomeDOMString *s);
1.74      paf        81:        const char *transcode_cstr(GdomeDOMString *s);
1.76      paf        82:        /// @see Charset::transcode(GdomeDOMString *s);
1.74      paf        83:        String& transcode(GdomeDOMString *s);
1.73      paf        84:        /// @see Charset::transcode(const String& s)
1.75      paf        85:        GdomeDOMString_auto_ptr transcode(const String& s);
1.74      paf        86: 
1.73      paf        87: #endif
1.60      parser     88: 
1.39      paf        89: private:
                     90: 
                     91:        void *fstorage;
1.40      paf        92:        void *fcontext;
1.73      paf        93:        Charset *source_charset;
                     94:        Charset *client_charset;
1.8       paf        95: 
1.50      parser     96: private: 
                     97:        
                     98:        //{
                     99:        /// @name implementation defined
1.68      paf       100:     void *real_malloc(size_t size, int place);
1.20      paf       101:     void *real_calloc(size_t size);
1.54      parser    102:        bool real_register_cleanup(void (*cleanup) (void *), void *data);
1.50      parser    103:        //}
1.17      paf       104: 
1.23      paf       105: private: 
1.17      paf       106: 
1.34      paf       107:        /// checks whether mem allocated OK. throws exception otherwise
1.23      paf       108:        void *check(void *ptr, size_t size) {
1.70      paf       109:                if(ptr) {
                    110:                        ftotal_allocated+=size;
                    111:                        ftotal_times++;
1.23      paf       112:                        return ptr;
1.70      paf       113:                }
1.23      paf       114: 
1.54      parser    115:                fail_alloc(size);
1.23      paf       116: 
                    117:                // never reached
                    118:                return 0;
                    119:        }
1.54      parser    120:        /// throws allocation exception
                    121:        void fail_alloc(size_t size) const;
                    122: 
                    123:        /// throws register cleanup exception
                    124:        void fail_register_cleanup() const;
1.70      paf       125: 
                    126: private: // statistics
                    127:        
                    128:        size_t ftotal_allocated;
                    129:        unsigned int ftotal_times;
1.59      parser    130: 
1.8       paf       131: private: //disabled
                    132: 
1.64      parser    133:        Pool(const Pool&);
                    134:        Pool& operator= (const Pool&);
1.21      paf       135: };
                    136: 
1.35      paf       137: /** 
1.34      paf       138:        Base for all classes that are allocated in 'pools'.
                    139: 
                    140:        Holds Pool object. Contains useful wrappers to it's methods.
1.38      paf       141: 
1.64      parser    142:        @see NEW
1.34      paf       143: */
1.21      paf       144: class Pooled {
1.23      paf       145:        // the pool i'm allocated on
1.49      paf       146:        Pool *fpool;
1.21      paf       147: public:
1.37      paf       148: 
                    149:        /// the Pooled-sole: Pooled instances can be allocated in Pool rather then on heap
1.21      paf       150:        static void *operator new(size_t size, Pool& apool) { 
1.68      paf       151:                return apool.malloc(size, 1);
1.21      paf       152:        }
                    153: 
1.49      paf       154:        Pooled(Pool& apool) : fpool(&apool) {}
1.23      paf       155: 
1.34      paf       156:        /// my pool
1.49      paf       157:        Pool& pool() const { return *fpool; }
                    158: 
                    159:        /** used for moving objects from one pool to another. 
                    160:                in between object can have no pool and can not be used
                    161:                @see SQL_Driver_manager
                    162:        */
                    163:        void set_pool(Pool *apool) { fpool=apool; }
1.21      paf       164: 
1.57      parser    165:        //{
                    166:        /// @name useful wrapper around pool
1.68      paf       167:        void *malloc(size_t size, int place=0) const { return fpool->malloc(size, place); }
1.49      paf       168:        void *calloc(size_t size) const { return fpool->calloc(size); }
1.57      parser    169:        void register_cleanup(void (*cleanup) (void *), void *data) { fpool->register_cleanup(cleanup, data); }
1.59      parser    170: #ifdef XML
1.74      paf       171: 
                    172:        const char *transcode_cstr(GdomeDOMString *s) { return fpool->transcode_cstr(s); }
                    173:        String& transcode(GdomeDOMString *s) { return fpool->transcode(s); }
                    174: 
1.59      parser    175: #endif
1.57      parser    176:        //}
1.23      paf       177: };
1.34      paf       178: /// useful macro for creating objects on current Pooled object Pooled::pool()
1.23      paf       179: #define NEW new(pool())
1.1       paf       180: 
                    181: #endif

E-mail: