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