Annotation of parser3/src/include/pa_pool.h, revision 1.86
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 ! paf 12: static const char* IDENT_POOL_H="$Date: 2002/10/15 15:12:57 $";
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.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.84 paf 64: //{@ helpers
65: void *copy(const void *buf, const size_t size);
66: char *copy(const char *cstr);
67: //}@
68:
1.79 paf 69: //{@ source charset
1.73 paf 70: void set_source_charset(Charset& acharset);
71: Charset& get_source_charset();
1.79 paf 72: //}@
1.73 paf 73:
1.79 paf 74: //{@ client charset
1.73 paf 75: void set_client_charset(Charset& charset);
76: Charset& get_client_charset();
1.79 paf 77: //}@
1.73 paf 78:
79: #ifdef XML
1.74 paf 80:
1.76 paf 81: /// @see Charset::transcode_cstr(xmlChar *s);
82: const char *transcode_cstr(xmlChar *s);
83: /// @see Charset::transcode(xmlChar *s);
1.85 paf 84: String& transcode(xmlChar *s
85: #ifndef NO_STRING_ORIGIN
86: , const String *origin
87: #endif
88: );
1.76 paf 89: /// @see Charset::transcode_cstr(GdomeDOMString *s);
1.74 paf 90: const char *transcode_cstr(GdomeDOMString *s);
1.76 paf 91: /// @see Charset::transcode(GdomeDOMString *s);
1.85 paf 92: String& transcode(GdomeDOMString *s
93: #ifndef NO_STRING_ORIGIN
94: , const String *origin
95: #endif
96: );
1.81 paf 97: /// @see Charset::transcode_cstr(const char *buf, size_t buf_size=0);
98: xmlChar *transcode_buf2xchar(const char *buf, size_t buf_size=0);
1.73 paf 99: /// @see Charset::transcode(const String& s)
1.75 paf 100: GdomeDOMString_auto_ptr transcode(const String& s);
1.74 paf 101:
1.73 paf 102: #endif
1.60 parser 103:
1.39 paf 104: private:
105:
106: void *fstorage;
1.40 paf 107: void *fcontext;
1.73 paf 108: Charset *source_charset;
109: Charset *client_charset;
1.8 paf 110:
1.50 parser 111: private:
112:
113: //{
114: /// @name implementation defined
1.68 paf 115: void *real_malloc(size_t size, int place);
1.20 paf 116: void *real_calloc(size_t size);
1.54 parser 117: bool real_register_cleanup(void (*cleanup) (void *), void *data);
1.50 parser 118: //}
1.17 paf 119:
1.23 paf 120: private:
1.17 paf 121:
1.34 paf 122: /// checks whether mem allocated OK. throws exception otherwise
1.23 paf 123: void *check(void *ptr, size_t size) {
1.70 paf 124: if(ptr) {
125: ftotal_allocated+=size;
126: ftotal_times++;
1.23 paf 127: return ptr;
1.70 paf 128: }
1.23 paf 129:
1.54 parser 130: fail_alloc(size);
1.23 paf 131:
132: // never reached
133: return 0;
134: }
1.54 parser 135: /// throws allocation exception
136: void fail_alloc(size_t size) const;
137:
138: /// throws register cleanup exception
139: void fail_register_cleanup() const;
1.70 paf 140:
141: private: // statistics
142:
143: size_t ftotal_allocated;
144: unsigned int ftotal_times;
1.59 parser 145:
1.8 paf 146: private: //disabled
147:
1.64 parser 148: Pool(const Pool&);
149: Pool& operator= (const Pool&);
1.21 paf 150: };
151:
1.35 paf 152: /**
1.34 paf 153: Base for all classes that are allocated in 'pools'.
154:
155: Holds Pool object. Contains useful wrappers to it's methods.
1.38 paf 156:
1.64 parser 157: @see NEW
1.34 paf 158: */
1.80 paf 159:
160: // all classes that are members parents of packed class [String]
161: // sould be packed also to avoid sparc odd st/lduh problem
162: #include "pa_pragma_pack_begin.h"
1.21 paf 163: class Pooled {
1.23 paf 164: // the pool i'm allocated on
1.49 paf 165: Pool *fpool;
1.21 paf 166: public:
1.37 paf 167:
168: /// the Pooled-sole: Pooled instances can be allocated in Pool rather then on heap
1.21 paf 169: static void *operator new(size_t size, Pool& apool) {
1.68 paf 170: return apool.malloc(size, 1);
1.21 paf 171: }
172:
1.49 paf 173: Pooled(Pool& apool) : fpool(&apool) {}
1.23 paf 174:
1.34 paf 175: /// my pool
1.49 paf 176: Pool& pool() const { return *fpool; }
177:
178: /** used for moving objects from one pool to another.
179: in between object can have no pool and can not be used
180: @see SQL_Driver_manager
181: */
182: void set_pool(Pool *apool) { fpool=apool; }
1.21 paf 183:
1.57 parser 184: //{
185: /// @name useful wrapper around pool
1.68 paf 186: void *malloc(size_t size, int place=0) const { return fpool->malloc(size, place); }
1.49 paf 187: void *calloc(size_t size) const { return fpool->calloc(size); }
1.57 parser 188: void register_cleanup(void (*cleanup) (void *), void *data) { fpool->register_cleanup(cleanup, data); }
1.84 paf 189: void *copy(const void *buf, const size_t size) { return fpool->copy(buf, size); }
190: char *copy(const char *cstr) { return fpool->copy(cstr); }
1.59 parser 191: #ifdef XML
1.74 paf 192:
193: const char *transcode_cstr(GdomeDOMString *s) { return fpool->transcode_cstr(s); }
1.85 paf 194: String& transcode(GdomeDOMString *s
195: #ifndef NO_STRING_ORIGIN
196: , const String *origin
197: #endif
198: ) {
199: return fpool->transcode(s
200: #ifndef NO_STRING_ORIGIN
201: , origin
202: #endif
203: );
204: }
1.74 paf 205:
1.59 parser 206: #endif
1.57 parser 207: //}
1.23 paf 208: };
1.80 paf 209: #include "pa_pragma_pack_end.h"
1.34 paf 210: /// useful macro for creating objects on current Pooled object Pooled::pool()
1.23 paf 211: #define NEW new(pool())
1.1 paf 212:
213: #endif
E-mail: