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

Diff Legend

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