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.16 by root, Wed Aug 30 16:30:37 2006 UTC vs.
Revision 1.69 by root, Sun May 27 23:49:49 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>
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//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
13 26
14// optimisations/workaround for functions requiring my_perl in scope (anti-bloat) 27// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
15#undef localtime 28#undef localtime
16#undef srand48 29#undef srand48
17#undef drand48 30#undef drand48
20#undef getprotobyname 33#undef getprotobyname
21#undef gethostbyname 34#undef gethostbyname
22#undef ctime 35#undef ctime
23#undef strerror 36#undef strerror
24 37
38// same here, massive symbol spamming
39#undef do_open
40#undef do_close
41#undef ref
42#undef seed
43
25// perl bug #40256: perl does overwrite those with reentrant versions 44// perl bug #40256: perl does overwrite those with reentrant versions
26// but does not initialise their state structures. 45// but does not initialise their state structures.
27#undef random 46#undef random
28#undef crypt 47#undef crypt
29 48
30struct pl; 49//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
31struct object; 50
32struct 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//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
33 64
34void cfperl_init (); 65void cfperl_init ();
35void cfperl_boot ();
36void cfperl_main (); 66void cfperl_main ();
67void cfperl_emergency_save ();
68void cfperl_cleanup (int make_core);
69void cfperl_make_book (object *book, int level);
37 70
38// could have used templates, but a more traditional C api 71//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
39// uses more explicit typing which is ok for this purpose.
40enum data_type
41{
42 DT_END, // no further arguments
43 DT_AV, // perl-only av that needs to be flattened out
44 DT_INT,
45 DT_INT64,
46 DT_DOUBLE,
47 DT_STRING, // 0-terminated string
48 DT_DATA, // string + length
49 DT_OBJECT,
50 DT_MAP,
51 DT_PLAYER,
52 DT_ARCH,
53 DT_PARTY,
54 DT_REGION,
55 72
56 NUM_DATA_TYPES 73// virtual server time, excluding time jumps and lag
57}; 74extern double runtime;
58 75
59enum event_klass 76enum event_klass
60{ 77{
61 KLASS_NONE, 78 KLASS_NONE,
62 KLASS_GLOBAL, 79 KLASS_GLOBAL,
80 KLASS_ATTACHABLE,
81 KLASS_CLIENT,
63 KLASS_PLAYER, 82 KLASS_PLAYER,
64 KLASS_OBJECT, 83 KLASS_OBJECT,
65 KLASS_MAP, 84 KLASS_MAP,
85 KLASS_COMMAND,
66}; 86};
67 87
68enum event_type 88enum event_type
69{ 89{
70# define def(klass,name) EVENT_ ## klass ## _ ## name, 90# define def(klass,name) EVENT_ ## klass ## _ ## name,
71# include "eventinc.h" 91# include "eventinc.h"
72# undef def 92# undef def
73 NUM_EVENT_TYPES 93 NUM_EVENT_TYPES
74}; 94};
75 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
76#define ARG_AV(o) DT_AV , static_cast<AV *> (o) 100#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
77#define ARG_INT(v) DT_INT , static_cast<int> (v) 101#define ARG_INT(v) DT_INT , static_cast<int> (v)
78#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v) 102#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
79#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v) 103#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
80#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v) 104#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
81#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)
82#define ARG_OBJECT(o) DT_OBJECT, (void *)static_cast<struct object *> (o) 106#define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o))
83#define ARG_MAP(o) DT_MAP , (void *)static_cast<struct mapstruct *> (o) 107#define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o))
84#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<struct pl *> (o) 108#define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (o))
85#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))
86#define ARG_PARTY(o) DT_PARTY , (void *)static_cast<struct party *> (o) 111#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o))
87#define ARG_REGION(o) DT_REGION, (void *)static_cast<struct region *> (o) 112#define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o))
88 113
89// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension 114// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
90 115#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
91// all these return true when the normal event processing should be skipped (if any)
92#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
93
94#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
95#define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__) 116#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
117#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__)
96#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__) 118#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__)
119#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
97#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__) 120#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__)
98#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__) 121#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
99 122
100//TODO should index into @result 123//TODO should index into @result
101#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)
102#define RESULT_INT(idx) RESULT(idx, INT) 126#define RESULT_INT(idx) RESULT(idx, INT)
103 127
104bool cfperl_invoke (event_type event, ...); 128double cfperl_result_DOUBLE (int idx);
105int cfperl_result_INT (int idx); 129int cfperl_result_INT (int idx);
106 130
131//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
132
133INTERFACE_CLASS (attachable)
107struct attachable_base 134struct attachable
108{ 135{
109 struct sv *self; 136 static MGVTBL vtbl;
110 struct av *cb; // CF+ perl self and callback 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
174 AV *cb; // CF+ callbacks
111 const char *attach; // generic extension attachment information 175 shstr attach; // generic extension attachment information
112 176
113 void clear (); // called when free'ing objects 177 void sever_self (); // sever this object from its self, if it has one.
114 void optimise (); // possibly save some memory by destroying unneeded data 178 void optimise (); // possibly save some memory by destroying unneeded data
115 void instantiate (data_type type, void *obj);
116 179
117 void attachable_init () 180 attachable ()
181 : flags (0), refcnt (0), self (0), cb (0), attach (0)
118 { 182 {
119 self = 0;
120 cb = 0;
121 attach = 0;
122 } 183 }
123};
124 184
125// objects attachable from perl (or any other extension) should include or 185 attachable (const attachable &src)
126// derive using the curiously recurring template pattern, to avoid 186 : flags (0), refcnt (0), self (0), cb (0), attach (src.attach)
127// virtual method calls etc.
128template<class subclass>
129struct attachable : attachable_base
130{
131 static data_type get_dt ()
132 { 187 {
133 return subclass::get_dt ();
134 } 188 }
135 189
190 virtual ~attachable ();
191
192 attachable &operator =(const attachable &src);
193
194 // used to _quickly_ device wether to shortcut the evaluation
195 bool should_invoke (event_type event)
196 {
197 return ev_want_event [event] || cb;
198 }
199
200 bool invoke (event_type event, ...);
201
136 void instantiate () 202 MTH void instantiate ();
137 { 203 void reattach ();
138 if (attach)
139 attachable_base::instantiate (get_dt (), static_cast<subclass *>(this));
140 }
141};
142 204
143struct object_freezethaw 205protected:
144{ 206 // do the real refcount checking work
145 struct av *av; 207 void do_check ();
146};
147 208
148struct object_freezer : object_freezethaw 209 // the method that does the real destroy work
149{ 210 virtual void do_destroy ();
150 struct sv *text; 211};
151 void *filename;
152 212
153 object_freezer (const char *filename); 213// the global object is a pseudo object that cares for the global events
214struct global : attachable
215{
216 void gather_callbacks (AV *&callbacks, event_type event) const;
217};
218
219extern struct global gbl_ev;
220
221//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
222
223struct object_freezer : dynbuf_text
224{
225 AV *av;
226
227 object_freezer ();
154 ~object_freezer (); 228 ~object_freezer ();
155 229
156 void put (attachable_base *ext); 230 void put (attachable *ext);
157 231
158 template<class subclass> 232 // used only for user-defined key-value pairs
159 void put (attachable<subclass> *obj) 233 void put (const shstr &k, const shstr &v)
160 { 234 {
161 put ((attachable_base *)obj); 235 add (k);
236
237 if (expect_true (v))
238 add (' '), add (v);
239
240 add ('\n');
162 } 241 }
242
243 //TODO//temporary, used only for saving body locations
244 void put (const char *k, int v)
245 {
246 add (k);
247 force (2 + sint32_digits);
248 fadd (' ');
249 add (sint32 (v));
250 fadd ('\n');
251 }
252
253 template<typename T>
254 void put_string (keyword k, const T &v)
255 {
256 int klen = keyword_len [k];
257 int vlen = v ? strlen (v) + 1 : 0;
258
259 char *p = (char *)alloc (klen + vlen + 1);
260
261 memcpy (p, keyword_str [k], klen); p += klen;
262
263 if (expect_true (v))
264 {
265 *p++ = ' '; vlen--;
266 memcpy (p, v, vlen); p += vlen;
267 }
268
269 *p = '\n';
270 }
271
272 void put (keyword k, const char *v = 0)
273 {
274 put_string (k, v);
275 }
276
277 void put (keyword k, const shstr &v)
278 {
279 put_string (k, v);
280 }
281
282 void put (keyword k, double v)
283 {
284 force (MAX_KEYWORD_LEN + 2 + 32);
285 fadd (keyword_str [k], keyword_len [k]);
286 fadd (' ');
287 falloc (sprintf (ptr, "%.7g", v));
288 fadd ('\n');
289 }
290
291 void put_(keyword k, sint64 v)
292 {
293 force (MAX_KEYWORD_LEN + 2 + sint64_digits);
294 fadd (keyword_str [k], keyword_len [k]);
295 fadd (' ');
296 add (v);
297 fadd ('\n');
298 }
299
300 void put_(keyword k, sint32 v)
301 {
302 force (MAX_KEYWORD_LEN + 2 + sint32_digits);
303 fadd (keyword_str [k], keyword_len [k]);
304 fadd (' ');
305 add (v);
306 fadd ('\n');
307 }
308
309 void put (keyword kbeg, keyword kend, const shstr &v)
310 {
311 force (MAX_KEYWORD_LEN + 1);
312 fadd (keyword_str [kbeg], keyword_len [kbeg]); fadd ('\n');
313
314 if (expect_true (v))
315 {
316 add (v);
317 add ('\n');
318 }
319
320 force (MAX_KEYWORD_LEN + 1);
321 fadd (keyword_str [kend], keyword_len [kend]); fadd ('\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 (expect_true (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
351 bool save (const char *path);
352 char *as_string (); // like strdup
163 353
164 operator bool () { return !!av; } 354 operator bool () { return !!av; }
165}; 355};
166 356
167struct object_thawer : object_freezethaw 357struct object_thawer
168{ 358{
169 FILE *fp; 359 char *line; // current beginning of line
360 SV *text; // text part
361 AV *av; // perl part
362 int linenum;
363 keyword kw;
364 char *kw_str; // the keyword parsed, as string
365 char *value; // the value, or 0 if no value
366 char *value_nn; // the value, or the empty string if no value
367 const char *name;
170 368
369 operator bool () { return !!text; }
370
171 object_thawer (const char *filename = 0); 371 object_thawer (const char *path = 0);
372 object_thawer (const char *data, AV *perlav);
172 ~object_thawer (); 373 ~object_thawer ();
173 374
174 void get (data_type type, void *obj, attachable_base *ext, int oid);
175
176 template<class subclass>
177 void get (attachable<subclass> *obj, int oid) 375 void get (attachable *obj, int oid);
178 {
179 if (av)
180 get (subclass::get_dt (), (subclass *)obj, obj, oid);
181 }
182 376
183 operator FILE *() { return fp; } 377 // parse next line
184}; 378 void next ();
379 // skip the current key-value (usually fetch next line, for
380 // multiline-fields, skips untilt he corresponding end-kw
381 void skip ();
185 382
186// compatibility support, should be removed when no longer needed 383 //TODO: remove, deprecated
187int fprintf (object_freezer &freezer, const char *format, ...); 384 keyword get_kv ()
188int fputs (const char *s, object_freezer &freezer); 385 {
386 next ();
387 return kw;
388 }
389
390 char *get_str () { return value; } // may be 0
391 void get_ml (keyword kend, shstr &sh);
392
393 void get_ornull (shstr &sh) const { sh = value; }
394 void get (shstr &sh) const { sh = value; } // might want to check for non-null here
395
396 bool get_bool () const { return *value_nn == '1'; }
397 sint32 get_sint32 () const;
398 sint64 get_sint64 () const { return atoll (value_nn); }
399 double get_double () const { return atof (value_nn); }
400
401 void get (float &v) { v = get_double (); }
402 void get (double &v) { v = get_double (); }
403
404 void get (bool &i) { i = get_bool (); }
405 void get (sint8 &i) { i = get_sint32 (); }
406 void get (uint8 &i) { i = get_sint32 (); }
407 void get (sint16 &i) { i = get_sint32 (); }
408 void get (uint16 &i) { i = get_sint32 (); }
409 void get (sint32 &i) { i = get_sint32 (); }
410
411 void get (uint32 &i) { i = get_sint64 (); }
412 void get (sint64 &i) { i = get_sint64 (); }
413
414 bool parse_error (const char *type = 0, const char *name = 0, bool skip = true);
415};
416
417//TODO: remove
418char *fgets (char *s, int n, object_thawer &thawer);
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 (expect_false (++cede_counter >= count))
439 do_cede_every ();
440 }
441
442 static void cede_to_tick ()
443 {
444 if (expect_false (time () >= next_cede))
445 do_cede_to_tick ();
446 }
447
448 static void cede_to_tick_every (int count)
449 {
450 if (expect_false (++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};
189 514
190#endif 515#endif
191 516

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines