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