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

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.69      paf         6:        Author: Alexander Petrosyan <paf@design.ru> (http://paf.design.ru)
1.27      paf         7: 
1.72    ! paf         8:        $Id: pa_pool.h,v 1.71 2001/11/16 11:51:32 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.66      parser     17: #include <memory>
1.55      parser     18: #include <XalanDOM/XalanDOMString.hpp>
                     19: #include <util/TransService.hpp>
1.59      parser     20: #endif
1.55      parser     21: 
                     22: // forwards
                     23: 
1.21      paf        24: class Exception;
1.55      parser     25: class String;
                     26: 
1.35      paf        27: /** 
1.34      paf        28:        Pool mechanizm allows users not to free up allocated memory,
                     29:        leaving that problem to 'pools'.
                     30: 
1.38      paf        31:        @see Pooled
1.34      paf        32: */
1.47      paf        33: 
1.1       paf        34: class Pool {
                     35: public:
1.18      paf        36: 
1.55      parser     37:        Pool(void *astorage);
1.56      parser     38:        ~Pool();
1.18      paf        39: 
1.70      paf        40:        ///{@ statistics
                     41:        size_t total_allocated() { return ftotal_allocated; }
                     42:        unsigned int total_times() { return ftotal_times; }
                     43:        ///}@
                     44: 
1.40      paf        45:        void set_context(void *acontext) { fcontext=acontext; }
1.64      parser     46:        void *get_context() { return fcontext; }
1.39      paf        47: 
1.34      paf        48:        /// allocates some bytes on pool
1.68      paf        49:        void *malloc(size_t size, int place=0) {
                     50:                return check(real_malloc(size, place), size);
1.18      paf        51:        }
1.34      paf        52:        /// allocates some bytes clearing them with zeros
1.18      paf        53:        void *calloc(size_t size) {
                     54:                return check(real_calloc(size), size);
                     55:        }
1.39      paf        56: 
1.53      parser     57:        /// registers a routine to clean up non-pooled allocations
1.54      parser     58:        void register_cleanup(void (*cleanup) (void *), void *data) {
                     59:                if(!real_register_cleanup(cleanup, data))
                     60:                        fail_register_cleanup();
                     61:        }
1.53      parser     62: 
1.60      parser     63:        /// resets transcoder if they change charset 
                     64:        void set_charset(const String &charset);
                     65:        /// returns current charset
                     66:        const String& get_charset() { return *charset; }
                     67: 
1.39      paf        68: private:
                     69: 
                     70:        void *fstorage;
1.40      paf        71:        void *fcontext;
1.60      parser     72:        const String *charset;
1.8       paf        73: 
1.50      parser     74: private: 
                     75:        
                     76:        //{
                     77:        /// @name implementation defined
1.68      paf        78:     void *real_malloc(size_t size, int place);
1.20      paf        79:     void *real_calloc(size_t size);
1.54      parser     80:        bool real_register_cleanup(void (*cleanup) (void *), void *data);
1.50      parser     81:        //}
1.17      paf        82: 
1.23      paf        83: private: 
1.17      paf        84: 
1.34      paf        85:        /// checks whether mem allocated OK. throws exception otherwise
1.23      paf        86:        void *check(void *ptr, size_t size) {
1.70      paf        87:                if(ptr) {
                     88:                        ftotal_allocated+=size;
                     89:                        ftotal_times++;
1.23      paf        90:                        return ptr;
1.70      paf        91:                }
1.23      paf        92: 
1.54      parser     93:                fail_alloc(size);
1.23      paf        94: 
                     95:                // never reached
                     96:                return 0;
                     97:        }
1.54      parser     98:        /// throws allocation exception
                     99:        void fail_alloc(size_t size) const;
                    100: 
                    101:        /// throws register cleanup exception
                    102:        void fail_register_cleanup() const;
1.23      paf       103: 
1.59      parser    104: #ifdef XML
                    105: 
                    106: public:
                    107:        /// converts Xalan string to char *
                    108:        const char *transcode_cstr(const XalanDOMString& s);
                    109:        /// converts Xalan string to parser String
                    110:        String& transcode(const XalanDOMString& s);
1.63      parser    111:        /// converts char * to Xalan string
1.67      parser    112:        std::auto_ptr<XalanDOMString> transcode_buf(const char *buf, size_t buf_size);
1.63      parser    113:        /// converts parser String to Xalan string
1.65      parser    114:        std::auto_ptr<XalanDOMString> transcode(const String& s);
1.59      parser    115: 
                    116: private:
                    117: 
                    118:        void update_transcoder();
                    119: 
                    120: private:
                    121: 
                    122:        XMLTranscoder *transcoder;
                    123: 
                    124: #endif
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.57      parser    171:        const char *transcode_cstr(const XalanDOMString& s) { return fpool->transcode_cstr(s); }
                    172:        String& transcode(const XalanDOMString& s) { return fpool->transcode(s); }
1.59      parser    173: #endif
1.57      parser    174:        //}
1.23      paf       175: };
1.34      paf       176: /// useful macro for creating objects on current Pooled object Pooled::pool()
1.23      paf       177: #define NEW new(pool())
1.1       paf       178: 
                    179: #endif

E-mail: