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