ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/cfperl.h
(Generate patch)

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.12 by root, Mon Aug 28 14:05:24 2006 UTC vs.
Revision 1.52 by root, Fri Jan 26 22:06:30 2007 UTC

… …
2// cfperl.h perl interface 2// cfperl.h perl interface
3// 3//
4#ifndef CFPERL_H__ 4#ifndef CFPERL_H__
5#define CFPERL_H__ 5#define CFPERL_H__
6 6
7struct pl; 7#include <cstdio>
8struct object; 8
9struct mapstruct; 9using namespace std;
10
11#include <EXTERN.h>
12#include <perl.h>
13#include <XSUB.h>
14
15#include <EventAPI.h>
16#include <CoroAPI.h>
17
18#include "util.h"
19#include "keyword.h"
20#include "dynbuf.h"
21#include "callback.h"
22
23//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
24
25// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
26#undef localtime
27#undef srand48
28#undef drand48
29#undef srandom
30#undef readdir
31#undef getprotobyname
32#undef gethostbyname
33#undef ctime
34#undef strerror
35
36// same here, massive symbol spamming
37#undef do_open
38#undef do_close
39#undef ref
40#undef seed
41
42// perl bug #40256: perl does overwrite those with reentrant versions
43// but does not initialise their state structures.
44#undef random
45#undef crypt
46
47//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
48
49// some macros to simplify perl in-calls
50
51#define CHECK_ERROR \
52 if (SvTRUE (ERRSV)) \
53 LOG (llevError, "runtime error in %s: %s\n", __func__, SvPVutf8_nolen (ERRSV));
54
55#define CALL_BEGIN(args) dSP; ENTER; SAVETMPS; PUSHMARK (SP); EXTEND (SP, args)
56#define CALL_ARG_SV(sv) PUSHs (sv_2mortal (sv)) // separate because no refcount inc
57#define CALL_ARG(expr) PUSHs (sv_2mortal (to_sv (expr)))
58#define CALL_CALL(name, flags) PUTBACK; int count = call_pv (name, (flags) | G_EVAL); SPAGAIN;
59#define CALL_END CHECK_ERROR; FREETMPS; LEAVE
60
61//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
10 62
11void cfperl_init (); 63void cfperl_init ();
12void cfperl_main (); 64void cfperl_main ();
65void cfperl_emergency_save ();
13 66
14// could have used templates, but a more traditional C api 67//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
15// uses more explicit typing which is ok for this purpose.
16enum data_type
17{
18 DT_END, // no further arguments
19 DT_AV, // perl-only av that needs to be flattened out
20 DT_INT,
21 DT_INT64,
22 DT_DOUBLE,
23 DT_STRING, // 0-terminated string
24 DT_DATA, // string + length
25 DT_OBJECT,
26 DT_MAP,
27 DT_PLAYER,
28 DT_ARCH,
29 DT_PARTY,
30 DT_REGION,
31 68
32 NUM_DATA_TYPES 69// virtual server time, excluding time jumps and lag
33}; 70extern double runtime;
34 71
35enum event_klass 72enum event_klass
36{ 73{
37 KLASS_NONE, 74 KLASS_NONE,
38 KLASS_GLOBAL, 75 KLASS_GLOBAL,
76 KLASS_ATTACHABLE,
77 KLASS_CLIENT,
39 KLASS_PLAYER, 78 KLASS_PLAYER,
40 KLASS_OBJECT, 79 KLASS_OBJECT,
41 KLASS_MAP, 80 KLASS_MAP,
81 KLASS_COMMAND,
42}; 82};
43 83
44enum event_type 84enum event_type
45{ 85{
46# define def(klass,name) EVENT_ ## klass ## _ ## name, 86# define def(klass,name) EVENT_ ## klass ## _ ## name,
47# include "eventinc.h" 87# include "eventinc.h"
48# undef def 88# undef def
49 NUM_EVENT_TYPES 89 NUM_EVENT_TYPES
50}; 90};
51 91
52#define ARG_AV(o) DT_AV , static_cast<AV *> (o) 92#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
53#define ARG_INT(v) DT_INT , static_cast<int> (v) 93#define ARG_INT(v) DT_INT , static_cast<int> (v)
54#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v) 94#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
55#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v) 95#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
56#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v) 96#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
57#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), (l) 97#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
58#define ARG_OBJECT(o) DT_OBJECT, (void *)static_cast<struct object *> (o) 98#define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o))
59#define ARG_MAP(o) DT_MAP , (void *)static_cast<struct mapstruct *> (o) 99#define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o))
60#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<struct pl *> (o) 100#define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (o))
61#define ARG_ARCH(o) DT_ARCH , (void *)static_cast<struct archetype *> (o) 101#define ARG_ARCH(o) DT_ARCH , (void *)(static_cast<archetype *> (o))
102#define ARG_CLIENT(o) DT_CLIENT, (void *)(static_cast<client *> (o))
62#define ARG_PARTY(o) DT_PARTY , (void *)static_cast<struct party *> (o) 103#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o))
63#define ARG_REGION(o) DT_REGION, (void *)static_cast<struct region *> (o) 104#define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o))
64 105
65// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension 106// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
66 107
67// all these return true when the normal event processing should be skipped (if any) 108// all these return true when the normal event processing should be skipped (if any)
68#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
69
70#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
71#define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__) 109#define INVOKE_GLOBAL(event, ...) gbl_ev.invoke (EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__, DT_END)
72#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__) 110#define INVOKE_ATTACHABLE(event, obj, ...) (obj)->invoke (EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__, DT_END)
73#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__) 111#define INVOKE_OBJECT(event, obj, ...) (obj)->invoke (EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__, DT_END)
74#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__) 112#define INVOKE_CLIENT(event, obj, ...) (obj)->invoke (EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__, DT_END)
113#define INVOKE_PLAYER(event, obj, ...) (obj)->invoke (EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__, DT_END)
114#define INVOKE_MAP(event, obj, ...) (obj)->invoke (EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__, DT_END)
75 115
76//TODO should index into @result 116//TODO should index into @result
77#define RESULT(idx,type) cfperl_result_ ## type (idx) 117#define RESULT(idx,type) cfperl_result_ ## type (idx)
118#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
78#define RESULT_INT(idx) RESULT(idx, INT) 119#define RESULT_INT(idx) RESULT(idx, INT)
79 120
80bool cfperl_invoke (event_type event, ...); 121double cfperl_result_DOUBLE (int idx);
81int cfperl_result_INT (int idx); 122int cfperl_result_INT (int idx);
82 123
124//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
125
126INTERFACE_CLASS (attachable)
83struct attachable_base 127struct attachable
84{ 128{
85 void *self, *cb; // CF+ perl self and callback 129 static MGVTBL vtbl;
130
131 static unordered_vector<attachable *> mortals;
132 MTH static void check_mortals ();
133
134 enum {
135 F_DESTROYED = 0x01,
136 };
137
138 // object is delete'd after the refcount reaches 0
139 mutable int ACC (RW, refcnt);
140 int ACC (RW, flags);
141
142 MTH void refcnt_inc () const { ++refcnt; }
143 MTH void refcnt_dec () const { --refcnt; }
144
145 MTH int refcnt_cnt () const;
146 // check wether the object has died and destroy
147 MTH void refcnt_chk () { if (refcnt <= 0) do_check (); }
148
149 // destroy the object unless it was already destroyed
150 // this politely asks everybody interested the reduce
151 // the refcount to 0 as soon as possible.
152 MTH void destroy ();
153
154 // return wether an object was destroyed already
155 MTH bool destroyed () const { return flags & F_DESTROYED; }
156
157 virtual void gather_callbacks (AV *&callbacks, event_type event) const;
158
159#if 0
160private:
161 static refcounted *rc_first;
162 refcounted *rc_next;
163#endif
164
165 HV *self; // CF+ perl self
166 AV *cb; // CF+ callbacks
86 const char *attach; // generic extension attachment information 167 shstr attach; // generic extension attachment information
87 168
88 void clear (); // called when free'ing objects 169 void sever_self (); // sever this object from its self, if it has one.
89 void optimise (); // possibly save some memory by destroying unneeded data 170 void optimise (); // possibly save some memory by destroying unneeded data
90 171
91 void attachable_init () 172 attachable ()
173 : flags (0), refcnt (0), self (0), cb (0), attach (0)
92 { 174 {
93 self = cb = 0;
94 attach = 0;
95 } 175 }
96};
97 176
98// objects attachable from perl (or any other extension) should include or 177 attachable (const attachable &src)
99// derive using the curiously recurring template pattern, to avoid 178 : flags (0), refcnt (0), self (0), cb (0), attach (src.attach)
100// virtual method calls etc.
101template<class subclass>
102struct attachable : attachable_base
103{
104 static data_type get_dt ()
105 { 179 {
106 subclass::get_dt ();
107 } 180 }
108};
109 181
110struct object_freezethaw 182 virtual ~attachable ();
111{
112 void *av;
113 FILE *fp;
114 183
115 operator FILE *() { return fp; } 184 attachable &operator =(const attachable &src);
116};
117 185
118struct object_freezer : object_freezethaw 186 bool invoke (event_type event, ...);
119{ 187 MTH void instantiate ();
120 void *filename; 188 void reattach ();
121 189
122 object_freezer (const char *filename); 190protected:
191 // do the real refcount checking work
192 void do_check ();
193
194 // the method that does the real destroy work
195 virtual void do_destroy ();
196};
197
198// the global object is a pseudo object that cares for the global events
199struct global : attachable
200{
201 void gather_callbacks (AV *&callbacks, event_type event) const;
202};
203
204extern struct global gbl_ev;
205
206//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
207
208struct object_freezer : dynbuf
209{
210 AV *av;
211
212 object_freezer ();
123 ~object_freezer (); 213 ~object_freezer ();
124 214
125 void put (attachable_base *ext); 215 void put (attachable *ext);
126 216
127 template<class subclass> 217 // used only for user-defined key-value pairs
128 void put (attachable<subclass> *obj) 218 void put (const shstr &k, const shstr &v)
129 { 219 {
130 put ((attachable_base *)obj); 220 add (k);
131 }
132};
133 221
134struct object_thawer : object_freezethaw 222 if (v)
223 add (' '), add (v);
224
225 add ('\n');
226 }
227
228 //TODO//temporary, used only for saving body locations
229 void put (const char *k, int v)
230 {
231 add (k);
232 add (' ');
233 add (sint32 (v));
234 add ('\n');
235 }
236
237 template<typename T>
238 void put_string (keyword k, const T &v)
239 {
240 int klen = keyword_len [k];
241 int vlen = v ? strlen (v) + 1 : 0;
242
243 char *p = (char *)alloc (klen + vlen + 1);
244
245 memcpy (p, keyword_str [k], klen); p += klen;
246
247 if (v)
248 {
249 *p++ = ' '; vlen--;
250 memcpy (p, v, vlen); p += vlen;
251 }
252
253 *p = '\n';
254 }
255
256 void put (keyword k, const char *v = 0)
257 {
258 put_string (k, v);
259 }
260
261 void put (keyword k, const shstr &v)
262 {
263 put_string (k, v);
264 }
265
266 void put (keyword k, double v)
267 {
268 char buf [128];
269
270 snprintf (buf, 128, "%.7g", v);
271
272 put (k, (const char *)buf);
273 }
274
275 void put_(keyword k, sint64 v)
276 {
277 add (keyword_str [k], keyword_len [k]);
278 add (' ');
279 add (v);
280 add ('\n');
281 }
282
283 void put_(keyword k, sint32 v)
284 {
285 add (keyword_str [k], keyword_len [k]);
286 add (' ');
287 add (v);
288 add ('\n');
289 }
290
291 void put (keyword kbeg, keyword kend, const shstr &v)
292 {
293 add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
294
295 if (v)
296 {
297 add (v);
298 add ('\n');
299 }
300
301 add (keyword_str [kend], keyword_len [kend]); add ('\n');
302 }
303
304 void put (keyword k, float v) { put (k, (double)v); }
305 void put (keyword k, signed char v) { put_(k, (sint32)v); }
306 void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
307 void put (keyword k, signed short v) { put_(k, (sint32)v); }
308 void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
309 void put (keyword k, signed int v) { put_(k, (sint32)v); }
310 void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
311 void put (keyword k, signed long v) { put_(k, (sint64)v); }
312 void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
313 void put (keyword k, signed long long v) { put_(k, (sint64)v); }
314 void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
315
316 template<typename T>
317 void put (keyword k, const T *v)
318 {
319 if (v)
320 put (k, v->name);
321 else
322 put (k, (const char *)0);
323 }
324
325 template<typename T>
326 void put (keyword k, const refptr<T> &v)
327 {
328 put (k, (T *)v);
329 }
330
331 bool save (const char *path);
332 char *as_string (); // like strdup
333
334 operator bool () { return !!av; }
335};
336
337// compatibility support, should be removed when no longer needed
338int fprintf (object_freezer &freezer, const char *format, ...);
339int fputs (const char *s, object_freezer &freezer);
340
341struct object_thawer
135{ 342{
343 SV *text; // text part
344 AV *av; // perl part
345 char *line; // current beginning of line
346 char *last_keyword, *last_value;
347 const char *name;
348
349 operator bool () { return !!text; }
350
136 object_thawer (FILE *fp, const char *filename = 0); 351 object_thawer (const char *path = 0);
352 object_thawer (const char *data, AV *perlav);
137 ~object_thawer (); 353 ~object_thawer ();
138 354
139 void get (data_type type, void *obj, attachable_base *ext, int oid);
140
141 template<class subclass>
142 void get (attachable<subclass> *obj, int oid) 355 void get (attachable *obj, int oid);
356
357 keyword get_kv (); // also parse value for later use
358 void skip_kv (keyword kw);
359
360 const char *get_str () { return last_value; } // may be 0
361
362 void get (shstr &sh) const;
363 void get_ornull (shstr &sh) const { sh = last_value; }
364 void get_ml (keyword kend, shstr &sh);
365
366 sint32 get_sint32 () const;
367 sint64 get_sint64 () const;
368 double get_double () const;
369
370 void get (float &v) { v = get_double (); }
371 void get (double &v) { v = get_double (); }
372
373 void get (bool &i) { i = get_sint32 (); }
374 void get (sint8 &i) { i = get_sint32 (); }
375 void get (uint8 &i) { i = get_sint32 (); }
376 void get (sint16 &i) { i = get_sint32 (); }
377 void get (uint16 &i) { i = get_sint32 (); }
378 void get (sint32 &i) { i = get_sint32 (); }
379
380 void get (uint32 &i) { i = get_sint64 (); }
381 void get (sint64 &i) { i = get_sint64 (); }
382};
383
384char *fgets (char *s, int n, object_thawer &thawer);
385
386//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
387
388struct coroapi {
389 static struct CoroAPI *GCoroAPI;
390
391 static int nready () { return CORO_NREADY; }
392 static int cede () { return CORO_CEDE ; }
393
394 static int cede_counter;
395
396 static void cede_every (int count)
143 { 397 {
144 if (av) 398 if (++cede_counter >= count)
145 get (subclass::get_dt (), (subclass *)obj, obj, oid); 399 {
400 cede_counter = 0;
401
402 if (coroapi::nready ())
403 coroapi::cede ();
404 }
146 } 405 }
406};
407
408struct watcher_base
409{
410 static struct EventAPI *GEventAPI;
411};
412
413template<class base>
414struct watcher : watcher_base
415{
416 base *pe;
417
418 void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); }
419 void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); }
420 void now () { GEventAPI->now ((pe_watcher *)pe); }
421 void suspend () { GEventAPI->suspend ((pe_watcher *)pe); }
422 void resume () { GEventAPI->resume ((pe_watcher *)pe); }
423
424 void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; }
425
426 ~watcher ()
427 {
428 cancel ();
429 }
430
431private:
432 void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private
433};
434
435struct iw : watcher<pe_idle>, callback<void (iw &)>
436{
437 template<class O, class M>
438 iw (O object, M method)
439 : callback<void (iw &)> (object, method)
440 {
441 alloc ();
442 }
443
444private:
445 void alloc ();
446};
447
448struct iow : watcher<pe_io>, callback<void (iow &, int)>
449{
450 template<class O, class M>
451 iow (O object, M method)
452 : callback<void (iow &, int)> (object, method)
453 {
454 alloc ();
455 }
456
457 void fd (int fd);
458 int poll ();
459 void poll (int events);
460
461private:
462 void alloc ();
147}; 463};
148 464
149#endif 465#endif
150 466

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines