ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/cfperl.h
Revision: 1.41
Committed: Mon Dec 25 11:25:49 2006 UTC (17 years, 5 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.40: +79 -71 lines
Log Message:
- small, but subtle, rewrite of object management
- perl will now keep attachable objects alive
- objects are now refcounted
- refcouts need to be tested explicitly (refcnt_chk)
- explicit destroy is required current
- explicit destroy asks "nicely" for the object to self destruct, if possible
- refcounts will be used during mortal killing
- minor bugfixes, optimisations etc.
- some former hacks removed.

File Contents

# User Rev Content
1 root 1.1 //
2     // cfperl.h perl interface
3     //
4 root 1.2 #ifndef CFPERL_H__
5     #define CFPERL_H__
6    
7 root 1.16 #include <cstdio>
8    
9     using namespace std;
10    
11     #include <EXTERN.h>
12     #include <perl.h>
13 root 1.20 #include <XSUB.h>
14 root 1.16
15 root 1.36 #include <EventAPI.h>
16    
17     #include "callback.h"
18    
19 root 1.16 // optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
20     #undef localtime
21     #undef srand48
22     #undef drand48
23     #undef srandom
24     #undef readdir
25     #undef getprotobyname
26     #undef gethostbyname
27     #undef ctime
28     #undef strerror
29    
30 root 1.39 // same here, massive symbol spamming
31     #undef do_open
32     #undef do_close
33    
34 root 1.16 // perl bug #40256: perl does overwrite those with reentrant versions
35     // but does not initialise their state structures.
36     #undef random
37     #undef crypt
38    
39 root 1.7 void cfperl_init ();
40     void cfperl_main ();
41    
42 root 1.6 enum event_klass
43     {
44 root 1.11 KLASS_NONE,
45 root 1.3 KLASS_GLOBAL,
46 root 1.41 KLASS_ATTACHABLE,
47 root 1.40 KLASS_CLIENT,
48 root 1.3 KLASS_PLAYER,
49     KLASS_OBJECT,
50     KLASS_MAP,
51 root 1.33 KLASS_COMMAND,
52 root 1.3 };
53    
54 root 1.6 enum event_type
55     {
56 root 1.7 # define def(klass,name) EVENT_ ## klass ## _ ## name,
57 root 1.2 # include "eventinc.h"
58     # undef def
59 root 1.4 NUM_EVENT_TYPES
60 root 1.2 };
61    
62 root 1.41 #define ARG_AV(o) DT_AV , static_cast<AV *> (o)
63     #define ARG_INT(v) DT_INT , static_cast<int> (v)
64     #define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
65     #define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
66     #define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
67     #define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
68     #define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o))
69     #define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o))
70     #define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (o))
71     #define ARG_ARCH(o) DT_ARCH , (void *)(static_cast<archetype *> (o))
72     #define ARG_CLIENT(o) DT_CLIENT, (void *)(static_cast<client *> (o))
73     #define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o))
74     #define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o))
75 root 1.3
76     // the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
77 root 1.2
78 root 1.4 // all these return true when the normal event processing should be skipped (if any)
79 root 1.41 #define INVOKE_GLOBAL(event, ...) gbl_ev.invoke (EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__, DT_END)
80     #define INVOKE_ATTACHABLE(event, obj, ...) (obj)->invoke (EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__, DT_END)
81     #define INVOKE_OBJECT(event, obj, ...) (obj)->invoke (EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__, DT_END)
82     #define INVOKE_CLIENT(event, obj, ...) (obj)->invoke (EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__, DT_END)
83     #define INVOKE_PLAYER(event, obj, ...) (obj)->invoke (EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__, DT_END)
84     #define INVOKE_MAP(event, obj, ...) (obj)->invoke (EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__, DT_END)
85 root 1.3
86 root 1.7 //TODO should index into @result
87     #define RESULT(idx,type) cfperl_result_ ## type (idx)
88 root 1.33 #define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
89     #define RESULT_INT(idx) RESULT(idx, INT)
90 root 1.7
91 root 1.34 double cfperl_result_DOUBLE (int idx);
92     int cfperl_result_INT (int idx);
93 root 1.7
94 root 1.41 struct attachable
95 root 1.6 {
96 root 1.41 static unordered_vector<attachable *> mortals;
97     static void check_mortals ();
98    
99     enum {
100     F_DESTROYED = 0x01,
101     F_BORROWED = 0x02,
102     };
103    
104     // object is delete'd after the refcount reaches 0
105     mutable int refcnt;
106     int flags;
107    
108     void refcnt_inc () const { ++refcnt; }
109     void refcnt_dec () const { --refcnt; }
110    
111     // check wether the object has died and destroy
112     void refcnt_chk () { if (refcnt <= 0) do_check (); }
113    
114     // destroy the object unless it was already destroyed
115     // this politely asks everybody interested the reduce
116     // the refcount to 0 as soon as possible.
117     void destroy ();
118    
119     // return wether an object was destroyed already
120     bool destroyed () const { return flags & F_DESTROYED; }
121    
122     virtual void gather_callbacks (AV *&callbacks, event_type event) const;
123    
124     #if 0
125     private:
126     static refcounted *rc_first;
127     refcounted *rc_next;
128     #endif
129    
130     HV *self; // CF+ perl self
131 root 1.35 AV *cb; // CF+ callbacks
132 root 1.21 shstr attach; // generic extension attachment information
133 root 1.6
134 root 1.13 void optimise (); // possibly save some memory by destroying unneeded data
135 root 1.8
136 root 1.41 attachable ()
137     : flags (0), refcnt (0), self (0), cb (0), attach (0)
138 root 1.8 {
139     }
140 root 1.22
141 root 1.41 attachable (const attachable &src)
142     : flags (0), refcnt (0), self (0), cb (0), attach (src.attach)
143 root 1.22 {
144     }
145    
146 root 1.41 virtual ~attachable ();
147    
148     attachable &operator =(const attachable &src);
149    
150     bool invoke (event_type event, ...);
151     void instantiate ();
152     void reattach ();
153 root 1.24
154 root 1.41 protected:
155     // do the real refcount checking work
156     void do_check ();
157 root 1.25
158 root 1.41 // the method that does the real destroy work
159     virtual void do_destroy ();
160 root 1.6 };
161    
162 root 1.41 // the global object is a pseudo object that cares for the global events
163     struct global : attachable
164 root 1.6 {
165 root 1.41 void gather_callbacks (AV *&callbacks, event_type event) const;
166 root 1.6 };
167    
168 root 1.41 extern struct global gbl_ev;
169    
170 root 1.19 struct object_freezer : dynbuf
171 root 1.7 {
172 root 1.17 AV *av;
173 root 1.12
174 root 1.17 object_freezer ();
175 root 1.8 ~object_freezer ();
176    
177 root 1.41 void put (attachable *ext);
178 root 1.15
179 root 1.29 // used only for user-defined key-value pairs
180     void put (const shstr &k, const shstr &v)
181 root 1.20 {
182     add (k);
183    
184     if (v)
185 root 1.22 add (' '), add (v);
186 root 1.20
187     add ('\n');
188     }
189    
190 root 1.29 //TODO//temporary, used only for saving body locations
191 root 1.20 void put (const char *k, int v)
192     {
193     add (k);
194     add (' ');
195     add (sint32 (v));
196     add ('\n');
197     }
198 root 1.19
199 root 1.29 template<typename T>
200     void put_string (keyword k, const T &v)
201 root 1.20 {
202     int klen = keyword_len [k];
203 root 1.22 int vlen = v ? strlen (v) + 1 : 0;
204    
205     char *p = (char *)alloc (klen + vlen + 1);
206    
207     memcpy (p, keyword_str [k], klen); p += klen;
208    
209     if (v)
210     {
211 root 1.29 *p++ = ' '; vlen--;
212 root 1.22 memcpy (p, v, vlen); p += vlen;
213     }
214    
215     *p = '\n';
216     }
217    
218 root 1.29 void put (keyword k, const char *v)
219     {
220     put_string (k, v);
221     }
222    
223 root 1.22 void put (keyword k, const shstr &v)
224     {
225 root 1.29 put_string (k, v);
226 root 1.20 }
227 root 1.19
228 root 1.20 void put (keyword k, double v)
229     {
230     char buf [128];
231    
232     snprintf (buf, 128, "%.7g", v);
233    
234     put (k, (const char *)buf);
235     }
236    
237     void put_(keyword k, sint64 v)
238     {
239     add (keyword_str [k], keyword_len [k]);
240     add (' ');
241     add (v);
242     add ('\n');
243     }
244    
245     void put_(keyword k, sint32 v)
246     {
247     add (keyword_str [k], keyword_len [k]);
248     add (' ');
249     add (v);
250     add ('\n');
251     }
252    
253 root 1.23 void put (keyword kbeg, keyword kend, const shstr &v)
254 root 1.20 {
255     add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
256    
257     if (v)
258     {
259     add (v);
260     add ('\n');
261     }
262    
263     add (keyword_str [kend], keyword_len [kend]); add ('\n');
264     }
265    
266     void put (keyword k, float v) { put (k, (double)v); }
267 root 1.19 void put (keyword k, signed char v) { put_(k, (sint32)v); }
268     void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
269     void put (keyword k, signed short v) { put_(k, (sint32)v); }
270     void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
271     void put (keyword k, signed int v) { put_(k, (sint32)v); }
272     void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
273     void put (keyword k, signed long v) { put_(k, (sint64)v); }
274     void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
275     void put (keyword k, signed long long v) { put_(k, (sint64)v); }
276     void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
277    
278     template<typename T>
279 root 1.32 void put (keyword k, const T *v)
280 root 1.18 {
281 root 1.23 if (v)
282     put (k, v->name);
283     else
284     put (k, (const char *)0);
285 root 1.18 }
286    
287 root 1.32 template<typename T>
288     void put (keyword k, const refptr<T> &v)
289     {
290     put (k, (T *)v);
291     }
292    
293 root 1.17 bool save (const char *filename);
294 root 1.31 char *as_string (); // like strdup
295 root 1.17
296 root 1.16 operator bool () { return !!av; }
297 root 1.7 };
298    
299 root 1.17 // compatibility support, should be removed when no longer needed
300     int fprintf (object_freezer &freezer, const char *format, ...);
301     int fputs (const char *s, object_freezer &freezer);
302    
303     struct object_thawer
304 root 1.7 {
305 root 1.21 SV *text; // text part
306     AV *av; // perl part
307     char *line; // current beginning of line
308     char *last_value;
309    
310     operator bool () { return !!text; }
311 root 1.16
312 root 1.14 object_thawer (const char *filename = 0);
313 root 1.30 object_thawer (const char *data, AV *perlav);
314 root 1.8 ~object_thawer ();
315    
316 root 1.41 void get (attachable *obj, int oid);
317 root 1.15
318 root 1.21 keyword get_kv (); // also parse value for later use
319    
320     const char *get_str () { return last_value; } // may be 0
321 root 1.17
322 root 1.21 void get (shstr &sh) const;
323     void get_ornull (shstr &sh) const { sh = last_value; }
324     void get_ml (keyword kend, shstr &sh);
325    
326     sint32 get_sint32 () const;
327     sint64 get_sint64 () const;
328     double get_double () const;
329    
330     void get (float &v) { v = get_double (); }
331     void get (double &v) { v = get_double (); }
332    
333     void get (sint8 &i) { i = get_sint32 (); }
334     void get (uint8 &i) { i = get_sint32 (); }
335     void get (sint16 &i) { i = get_sint32 (); }
336     void get (uint16 &i) { i = get_sint32 (); }
337     void get (sint32 &i) { i = get_sint32 (); }
338    
339     void get (uint32 &i) { i = get_sint64 (); }
340     void get (sint64 &i) { i = get_sint64 (); }
341 root 1.7 };
342 root 1.2
343 root 1.21 char *fgets (char *s, int n, object_thawer &thawer);
344    
345 root 1.36 struct watcher_base
346     {
347     static struct EventAPI *GEventAPI;
348     };
349    
350     template<class base>
351     struct watcher : watcher_base
352     {
353     base *pe;
354    
355     void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); }
356     void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); }
357     void now () { GEventAPI->now ((pe_watcher *)pe); }
358     void suspend () { GEventAPI->suspend ((pe_watcher *)pe); }
359     void resume () { GEventAPI->resume ((pe_watcher *)pe); }
360    
361     void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; }
362    
363     ~watcher ()
364     {
365     cancel ();
366     }
367    
368     private:
369     void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private
370     };
371    
372 root 1.38 struct iw : watcher<pe_idle>, callback<void (iw &)>
373     {
374     template<class O, class M>
375     iw (O object, M method)
376     : callback<void (iw &)> (object, method)
377     {
378     alloc ();
379     }
380    
381     private:
382     void alloc ();
383     };
384    
385 root 1.36 struct iow : watcher<pe_io>, callback<void (iow &, int)>
386     {
387     template<class O, class M>
388     iow (O object, M method)
389     : callback<void (iow &, int)> (object, method)
390     {
391     alloc ();
392     }
393    
394 root 1.38 void fd (int fd);
395 root 1.36 int poll ();
396 root 1.38 void poll (int events);
397 root 1.36
398     private:
399     void alloc ();
400     };
401    
402 root 1.2 #endif
403 root 1.3