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

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

E-mail: