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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines