Annotation of parser3/src/include/pa_pool.h, revision 1.86.4.2
1.34 paf 1: /** @file
1.36 paf 2: Parser: pool class decl.
3:
1.86 paf 4: Copyright (c) 2001, 2003 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.86.4.2! paf 12: static const char* IDENT_POOL_H="$Date: 2003/03/17 14:48:05 $";
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.86.4.1 paf 40: ~Pool();
41:
42: //{@ collector issues
43: void collect_garbage();
1.86.4.2! paf 44: void log_high_watermark(const char *msg);
1.86.4.1 paf 45: //}@
1.18 paf 46:
1.79 paf 47: //{@ statistics
1.70 paf 48: size_t total_allocated() { return ftotal_allocated; }
49: unsigned int total_times() { return ftotal_times; }
1.79 paf 50: //}@
1.70 paf 51:
1.40 paf 52: void set_context(void *acontext) { fcontext=acontext; }
1.64 parser 53: void *get_context() { return fcontext; }
1.39 paf 54:
1.34 paf 55: /// allocates some bytes on pool
1.86.4.1 paf 56: void *malloc_atomic(size_t size, int place=0) {
57: return check(real_malloc_atomic(size, place), size);
58: }
59:
60: /// allocates some bytes on pool
1.68 paf 61: void *malloc(size_t size, int place=0) {
62: return check(real_malloc(size, place), size);
1.18 paf 63: }
1.34 paf 64: /// allocates some bytes clearing them with zeros
1.18 paf 65: void *calloc(size_t size) {
66: return check(real_calloc(size), size);
67: }
1.39 paf 68:
1.53 parser 69: /// registers a routine to clean up non-pooled allocations
1.86.4.1 paf 70: void register_cleanup(void (*cleanup) (void *, void *), void *data) {
1.54 parser 71: if(!real_register_cleanup(cleanup, data))
72: fail_register_cleanup();
73: }
1.53 parser 74:
1.84 paf 75: //{@ helpers
76: void *copy(const void *buf, const size_t size);
77: char *copy(const char *cstr);
78: //}@
79:
1.79 paf 80: //{@ source charset
1.73 paf 81: void set_source_charset(Charset& acharset);
82: Charset& get_source_charset();
1.79 paf 83: //}@
1.73 paf 84:
1.79 paf 85: //{@ client charset
1.73 paf 86: void set_client_charset(Charset& charset);
87: Charset& get_client_charset();
1.79 paf 88: //}@
1.73 paf 89:
90: #ifdef XML
1.74 paf 91:
1.76 paf 92: /// @see Charset::transcode_cstr(xmlChar *s);
93: const char *transcode_cstr(xmlChar *s);
94: /// @see Charset::transcode(xmlChar *s);
1.85 paf 95: String& transcode(xmlChar *s
96: #ifndef NO_STRING_ORIGIN
97: , const String *origin
98: #endif
99: );
1.76 paf 100: /// @see Charset::transcode_cstr(GdomeDOMString *s);
1.74 paf 101: const char *transcode_cstr(GdomeDOMString *s);
1.76 paf 102: /// @see Charset::transcode(GdomeDOMString *s);
1.85 paf 103: String& transcode(GdomeDOMString *s
104: #ifndef NO_STRING_ORIGIN
105: , const String *origin
106: #endif
107: );
1.81 paf 108: /// @see Charset::transcode_cstr(const char *buf, size_t buf_size=0);
109: xmlChar *transcode_buf2xchar(const char *buf, size_t buf_size=0);
1.73 paf 110: /// @see Charset::transcode(const String& s)
1.75 paf 111: GdomeDOMString_auto_ptr transcode(const String& s);
1.74 paf 112:
1.73 paf 113: #endif
1.60 parser 114:
1.39 paf 115: private:
116:
117: void *fstorage;
1.40 paf 118: void *fcontext;
1.73 paf 119: Charset *source_charset;
120: Charset *client_charset;
1.8 paf 121:
1.50 parser 122: private:
123:
124: //{
125: /// @name implementation defined
1.86.4.1 paf 126: void real_init();
127: void real_finit();
1.68 paf 128: void *real_malloc(size_t size, int place);
1.86.4.1 paf 129: void *real_malloc_atomic(size_t size, int place);
1.20 paf 130: void *real_calloc(size_t size);
1.86.4.1 paf 131: bool real_register_cleanup(void (*cleanup) (void *,void *), void *data);
1.50 parser 132: //}
1.17 paf 133:
1.23 paf 134: private:
1.17 paf 135:
1.34 paf 136: /// checks whether mem allocated OK. throws exception otherwise
1.23 paf 137: void *check(void *ptr, size_t size) {
1.70 paf 138: if(ptr) {
139: ftotal_allocated+=size;
140: ftotal_times++;
1.23 paf 141: return ptr;
1.70 paf 142: }
1.23 paf 143:
1.54 parser 144: fail_alloc(size);
1.23 paf 145:
146: // never reached
147: return 0;
148: }
1.54 parser 149: /// throws allocation exception
150: void fail_alloc(size_t size) const;
151:
152: /// throws register cleanup exception
153: void fail_register_cleanup() const;
1.70 paf 154:
155: private: // statistics
156:
157: size_t ftotal_allocated;
158: unsigned int ftotal_times;
1.59 parser 159:
1.8 paf 160: private: //disabled
161:
1.64 parser 162: Pool(const Pool&);
163: Pool& operator= (const Pool&);
1.21 paf 164: };
165:
1.35 paf 166: /**
1.34 paf 167: Base for all classes that are allocated in 'pools'.
168:
169: Holds Pool object. Contains useful wrappers to it's methods.
1.38 paf 170:
1.64 parser 171: @see NEW
1.34 paf 172: */
1.80 paf 173:
1.86.4.1 paf 174: /**
175: @todo: try to remember the meaning of this old comment:
176: all classes that are members parents of packed class [String]
177: sould be packed also to avoid sparc odd st/lduh problem
178: [packing is unacceptable for garbage collector]
179: */
1.21 paf 180: class Pooled {
1.23 paf 181: // the pool i'm allocated on
1.49 paf 182: Pool *fpool;
1.21 paf 183: public:
1.37 paf 184:
185: /// the Pooled-sole: Pooled instances can be allocated in Pool rather then on heap
1.21 paf 186: static void *operator new(size_t size, Pool& apool) {
1.68 paf 187: return apool.malloc(size, 1);
1.21 paf 188: }
189:
1.49 paf 190: Pooled(Pool& apool) : fpool(&apool) {}
1.23 paf 191:
1.34 paf 192: /// my pool
1.49 paf 193: Pool& pool() const { return *fpool; }
194:
195: /** used for moving objects from one pool to another.
196: in between object can have no pool and can not be used
197: @see SQL_Driver_manager
198: */
199: void set_pool(Pool *apool) { fpool=apool; }
1.21 paf 200:
1.57 parser 201: //{
202: /// @name useful wrapper around pool
1.68 paf 203: void *malloc(size_t size, int place=0) const { return fpool->malloc(size, place); }
1.86.4.1 paf 204: void *malloc_atomic(size_t size, int place=0) const { return fpool->malloc_atomic(size, place); }
1.49 paf 205: void *calloc(size_t size) const { return fpool->calloc(size); }
1.86.4.1 paf 206: void register_cleanup(void (*cleanup) (void *, void *), void *data) { fpool->register_cleanup(cleanup, data); }
1.84 paf 207: void *copy(const void *buf, const size_t size) { return fpool->copy(buf, size); }
208: char *copy(const char *cstr) { return fpool->copy(cstr); }
1.59 parser 209: #ifdef XML
1.74 paf 210:
211: const char *transcode_cstr(GdomeDOMString *s) { return fpool->transcode_cstr(s); }
1.85 paf 212: String& transcode(GdomeDOMString *s
213: #ifndef NO_STRING_ORIGIN
214: , const String *origin
215: #endif
216: ) {
217: return fpool->transcode(s
218: #ifndef NO_STRING_ORIGIN
219: , origin
220: #endif
221: );
222: }
1.74 paf 223:
1.59 parser 224: #endif
1.57 parser 225: //}
1.23 paf 226: };
1.86.4.1 paf 227:
1.34 paf 228: /// useful macro for creating objects on current Pooled object Pooled::pool()
1.23 paf 229: #define NEW new(pool())
1.1 paf 230:
231: #endif
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to pa_pool.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3 / src / include