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

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.1       paf         7: */
                      8: 
                      9: #ifndef PA_POOL_H
                     10: #define PA_POOL_H
1.82      paf        11: 
1.84    ! paf        12: static const char* IDENT_POOL_H="$Date: 2002/08/01 11:41:15 $";
1.1       paf        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.84    ! paf        64:        //{@ helpers
        !            65:        void *copy(const void *buf, const size_t size);
        !            66:        char *copy(const char *cstr);
        !            67:        //}@
        !            68: 
1.79      paf        69:        //{@ source charset
1.73      paf        70:        void set_source_charset(Charset& acharset);
                     71:        Charset& get_source_charset();
1.79      paf        72:        //}@
1.73      paf        73: 
1.79      paf        74:        //{@ client charset
1.73      paf        75:        void set_client_charset(Charset& charset);
                     76:        Charset& get_client_charset();
1.79      paf        77:        //}@
1.73      paf        78: 
                     79: #ifdef XML
1.74      paf        80: 
1.76      paf        81:        /// @see Charset::transcode_cstr(xmlChar *s);
                     82:        const char *transcode_cstr(xmlChar *s);
                     83:        /// @see Charset::transcode(xmlChar *s);
                     84:        String& transcode(xmlChar *s);
                     85:        /// @see Charset::transcode_cstr(GdomeDOMString *s);
1.74      paf        86:        const char *transcode_cstr(GdomeDOMString *s);
1.76      paf        87:        /// @see Charset::transcode(GdomeDOMString *s);
1.74      paf        88:        String& transcode(GdomeDOMString *s);
1.81      paf        89:        /// @see Charset::transcode_cstr(const char *buf, size_t buf_size=0);
                     90:        xmlChar *transcode_buf2xchar(const char *buf, size_t buf_size=0);
1.73      paf        91:        /// @see Charset::transcode(const String& s)
1.75      paf        92:        GdomeDOMString_auto_ptr transcode(const String& s);
1.74      paf        93: 
1.73      paf        94: #endif
1.60      parser     95: 
1.39      paf        96: private:
                     97: 
                     98:        void *fstorage;
1.40      paf        99:        void *fcontext;
1.73      paf       100:        Charset *source_charset;
                    101:        Charset *client_charset;
1.8       paf       102: 
1.50      parser    103: private: 
                    104:        
                    105:        //{
                    106:        /// @name implementation defined
1.68      paf       107:     void *real_malloc(size_t size, int place);
1.20      paf       108:     void *real_calloc(size_t size);
1.54      parser    109:        bool real_register_cleanup(void (*cleanup) (void *), void *data);
1.50      parser    110:        //}
1.17      paf       111: 
1.23      paf       112: private: 
1.17      paf       113: 
1.34      paf       114:        /// checks whether mem allocated OK. throws exception otherwise
1.23      paf       115:        void *check(void *ptr, size_t size) {
1.70      paf       116:                if(ptr) {
                    117:                        ftotal_allocated+=size;
                    118:                        ftotal_times++;
1.23      paf       119:                        return ptr;
1.70      paf       120:                }
1.23      paf       121: 
1.54      parser    122:                fail_alloc(size);
1.23      paf       123: 
                    124:                // never reached
                    125:                return 0;
                    126:        }
1.54      parser    127:        /// throws allocation exception
                    128:        void fail_alloc(size_t size) const;
                    129: 
                    130:        /// throws register cleanup exception
                    131:        void fail_register_cleanup() const;
1.70      paf       132: 
                    133: private: // statistics
                    134:        
                    135:        size_t ftotal_allocated;
                    136:        unsigned int ftotal_times;
1.59      parser    137: 
1.8       paf       138: private: //disabled
                    139: 
1.64      parser    140:        Pool(const Pool&);
                    141:        Pool& operator= (const Pool&);
1.21      paf       142: };
                    143: 
1.35      paf       144: /** 
1.34      paf       145:        Base for all classes that are allocated in 'pools'.
                    146: 
                    147:        Holds Pool object. Contains useful wrappers to it's methods.
1.38      paf       148: 
1.64      parser    149:        @see NEW
1.34      paf       150: */
1.80      paf       151: 
                    152: // all classes that are members parents of packed class [String] 
                    153: // sould be packed also to avoid sparc odd st/lduh problem
                    154: #include "pa_pragma_pack_begin.h"
1.21      paf       155: class Pooled {
1.23      paf       156:        // the pool i'm allocated on
1.49      paf       157:        Pool *fpool;
1.21      paf       158: public:
1.37      paf       159: 
                    160:        /// the Pooled-sole: Pooled instances can be allocated in Pool rather then on heap
1.21      paf       161:        static void *operator new(size_t size, Pool& apool) { 
1.68      paf       162:                return apool.malloc(size, 1);
1.21      paf       163:        }
                    164: 
1.49      paf       165:        Pooled(Pool& apool) : fpool(&apool) {}
1.23      paf       166: 
1.34      paf       167:        /// my pool
1.49      paf       168:        Pool& pool() const { return *fpool; }
                    169: 
                    170:        /** used for moving objects from one pool to another. 
                    171:                in between object can have no pool and can not be used
                    172:                @see SQL_Driver_manager
                    173:        */
                    174:        void set_pool(Pool *apool) { fpool=apool; }
1.21      paf       175: 
1.57      parser    176:        //{
                    177:        /// @name useful wrapper around pool
1.68      paf       178:        void *malloc(size_t size, int place=0) const { return fpool->malloc(size, place); }
1.49      paf       179:        void *calloc(size_t size) const { return fpool->calloc(size); }
1.57      parser    180:        void register_cleanup(void (*cleanup) (void *), void *data) { fpool->register_cleanup(cleanup, data); }
1.84    ! paf       181:        void *copy(const void *buf, const size_t size) { return fpool->copy(buf, size); }
        !           182:        char *copy(const char *cstr) { return fpool->copy(cstr); }
1.59      parser    183: #ifdef XML
1.74      paf       184: 
                    185:        const char *transcode_cstr(GdomeDOMString *s) { return fpool->transcode_cstr(s); }
                    186:        String& transcode(GdomeDOMString *s) { return fpool->transcode(s); }
                    187: 
1.59      parser    188: #endif
1.57      parser    189:        //}
1.23      paf       190: };
1.80      paf       191: #include "pa_pragma_pack_end.h"
1.34      paf       192: /// useful macro for creating objects on current Pooled object Pooled::pool()
1.23      paf       193: #define NEW new(pool())
1.1       paf       194: 
                    195: #endif

E-mail: