1 |
// |
2 |
// cfperl.h perl interface |
3 |
// |
4 |
#ifndef CFPERL_H__ |
5 |
#define CFPERL_H__ |
6 |
|
7 |
#include <cstdarg> |
8 |
#include <cstdio> |
9 |
#include <bitset> |
10 |
|
11 |
using namespace std; |
12 |
|
13 |
#include <EXTERN.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 |
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// |
26 |
|
27 |
// optimisations/workaround for functions requiring my_perl in scope (anti-bloat) |
28 |
#undef localtime |
29 |
#undef srand48 |
30 |
#undef drand48 |
31 |
#undef srandom |
32 |
#undef readdir |
33 |
#undef getprotobyname |
34 |
#undef gethostbyname |
35 |
#undef ctime |
36 |
#undef strerror |
37 |
|
38 |
// same here, massive symbol spamming |
39 |
#undef do_open |
40 |
#undef do_close |
41 |
#undef ref |
42 |
#undef seed |
43 |
|
44 |
// perl bug #40256: perl does overwrite those with reentrant versions |
45 |
// but does not initialise their state structures. |
46 |
#undef random |
47 |
#undef crypt |
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 |
|
65 |
void cfperl_init (); |
66 |
void cfperl_main (); |
67 |
void cfperl_emergency_save (); |
68 |
void cfperl_cleanup (int make_core); |
69 |
void cfperl_make_book (object *book, int level); |
70 |
|
71 |
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// |
72 |
|
73 |
// virtual server time, excluding time jumps and lag |
74 |
extern double runtime; |
75 |
|
76 |
enum event_klass |
77 |
{ |
78 |
KLASS_NONE, |
79 |
KLASS_GLOBAL, |
80 |
KLASS_ATTACHABLE, |
81 |
KLASS_CLIENT, |
82 |
KLASS_PLAYER, |
83 |
KLASS_OBJECT, |
84 |
KLASS_MAP, |
85 |
KLASS_COMMAND, |
86 |
}; |
87 |
|
88 |
enum event_type |
89 |
{ |
90 |
# define def(klass,name) EVENT_ ## klass ## _ ## name, |
91 |
# include "eventinc.h" |
92 |
# undef def |
93 |
NUM_EVENT_TYPES |
94 |
}; |
95 |
|
96 |
// in which global events or per-type events are we interested |
97 |
extern bitset<NUM_EVENT_TYPES> ev_want_event; |
98 |
extern bitset<NUM_TYPES> ev_want_type; |
99 |
|
100 |
#define ARG_AV(o) DT_AV , static_cast<AV *> (o) |
101 |
#define ARG_INT(v) DT_INT , static_cast<int> (v) |
102 |
#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v) |
103 |
#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v) |
104 |
#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v) |
105 |
#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l) |
106 |
#define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o)) |
107 |
#define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o)) |
108 |
#define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (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)) |
111 |
#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o)) |
112 |
#define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o)) |
113 |
|
114 |
// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension |
115 |
#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0) |
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__) |
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__) |
120 |
#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__) |
121 |
#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__) |
122 |
|
123 |
//TODO should index into @result |
124 |
#define RESULT(idx,type) cfperl_result_ ## type (idx) |
125 |
#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE) |
126 |
#define RESULT_INT(idx) RESULT(idx, INT) |
127 |
|
128 |
double cfperl_result_DOUBLE (int idx); |
129 |
int cfperl_result_INT (int idx); |
130 |
|
131 |
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// |
132 |
|
133 |
INTERFACE_CLASS (attachable) |
134 |
struct attachable |
135 |
{ |
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 |
168 |
private: |
169 |
static refcounted *rc_first; |
170 |
refcounted *rc_next; |
171 |
#endif |
172 |
|
173 |
HV *self; // CF+ perl self |
174 |
AV *cb; // CF+ callbacks |
175 |
shstr attach; // generic extension attachment information |
176 |
|
177 |
void sever_self (); // sever this object from its self, if it has one. |
178 |
void optimise (); // possibly save some memory by destroying unneeded data |
179 |
|
180 |
attachable () |
181 |
: flags (0), refcnt (0), self (0), cb (0), attach (0) |
182 |
{ |
183 |
} |
184 |
|
185 |
attachable (const attachable &src) |
186 |
: flags (0), refcnt (0), self (0), cb (0), attach (src.attach) |
187 |
{ |
188 |
} |
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 |
|
202 |
MTH void instantiate (); |
203 |
void reattach (); |
204 |
|
205 |
protected: |
206 |
// do the real refcount checking work |
207 |
void do_check (); |
208 |
|
209 |
// the method that does the real destroy work |
210 |
virtual void do_destroy (); |
211 |
}; |
212 |
|
213 |
// the global object is a pseudo object that cares for the global events |
214 |
struct global : attachable |
215 |
{ |
216 |
void gather_callbacks (AV *&callbacks, event_type event) const; |
217 |
}; |
218 |
|
219 |
extern struct global gbl_ev; |
220 |
|
221 |
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// |
222 |
|
223 |
struct object_freezer : dynbuf_text |
224 |
{ |
225 |
AV *av; |
226 |
|
227 |
object_freezer (); |
228 |
~object_freezer (); |
229 |
|
230 |
void put (attachable *ext); |
231 |
|
232 |
// used only for user-defined key-value pairs |
233 |
void put (const shstr &k, const shstr &v) |
234 |
{ |
235 |
add (k); |
236 |
|
237 |
if (expect_true (v)) |
238 |
add (' '), add (v); |
239 |
|
240 |
add ('\n'); |
241 |
} |
242 |
|
243 |
//TODO//temporary, used only for saving body locations |
244 |
void put (const char *k, int v) |
245 |
{ |
246 |
add (k); |
247 |
add (' '); |
248 |
add (sint32 (v)); |
249 |
add ('\n'); |
250 |
} |
251 |
|
252 |
template<typename T> |
253 |
void put_string (keyword k, const T &v) |
254 |
{ |
255 |
int klen = keyword_len [k]; |
256 |
int vlen = v ? strlen (v) + 1 : 0; |
257 |
|
258 |
char *p = (char *)alloc (klen + vlen + 1); |
259 |
|
260 |
memcpy (p, keyword_str [k], klen); p += klen; |
261 |
|
262 |
if (expect_true (v)) |
263 |
{ |
264 |
*p++ = ' '; vlen--; |
265 |
memcpy (p, v, vlen); p += vlen; |
266 |
} |
267 |
|
268 |
*p = '\n'; |
269 |
} |
270 |
|
271 |
void put (keyword k, const char *v = 0) |
272 |
{ |
273 |
put_string (k, v); |
274 |
} |
275 |
|
276 |
void put (keyword k, const shstr &v) |
277 |
{ |
278 |
put_string (k, v); |
279 |
} |
280 |
|
281 |
void put (keyword k, double v) |
282 |
{ |
283 |
char buf [128]; |
284 |
|
285 |
snprintf (buf, 128, "%.7g", v); |
286 |
|
287 |
put (k, (const char *)buf); |
288 |
} |
289 |
|
290 |
void put_(keyword k, sint64 v) |
291 |
{ |
292 |
add (keyword_str [k], keyword_len [k]); |
293 |
add (' '); |
294 |
add (v); |
295 |
add ('\n'); |
296 |
} |
297 |
|
298 |
void put_(keyword k, sint32 v) |
299 |
{ |
300 |
add (keyword_str [k], keyword_len [k]); |
301 |
add (' '); |
302 |
add (v); |
303 |
add ('\n'); |
304 |
} |
305 |
|
306 |
void put (keyword kbeg, keyword kend, const shstr &v) |
307 |
{ |
308 |
add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n'); |
309 |
|
310 |
if (expect_true (v)) |
311 |
{ |
312 |
add (v); |
313 |
add ('\n'); |
314 |
} |
315 |
|
316 |
add (keyword_str [kend], keyword_len [kend]); add ('\n'); |
317 |
} |
318 |
|
319 |
void put (keyword k, float v) { put (k, (double)v); } |
320 |
void put (keyword k, signed char v) { put_(k, (sint32)v); } |
321 |
void put (keyword k, unsigned char v) { put_(k, (sint32)v); } |
322 |
void put (keyword k, signed short v) { put_(k, (sint32)v); } |
323 |
void put (keyword k, unsigned short v) { put_(k, (sint32)v); } |
324 |
void put (keyword k, signed int v) { put_(k, (sint32)v); } |
325 |
void put (keyword k, unsigned int v) { put_(k, (sint64)v); } |
326 |
void put (keyword k, signed long v) { put_(k, (sint64)v); } |
327 |
void put (keyword k, unsigned long v) { put_(k, (sint64)v); } |
328 |
void put (keyword k, signed long long v) { put_(k, (sint64)v); } |
329 |
void put (keyword k, unsigned long long v) { put_(k, (sint64)v); } |
330 |
|
331 |
template<typename T> |
332 |
void put (keyword k, const T *v) |
333 |
{ |
334 |
if (expect_true (v)) |
335 |
put (k, v->name); |
336 |
else |
337 |
put (k, (const char *)0); |
338 |
} |
339 |
|
340 |
template<typename T> |
341 |
void put (keyword k, const refptr<T> &v) |
342 |
{ |
343 |
put (k, (T *)v); |
344 |
} |
345 |
|
346 |
bool save (const char *path); |
347 |
char *as_string (); // like strdup |
348 |
|
349 |
operator bool () { return !!av; } |
350 |
}; |
351 |
|
352 |
// compatibility support, should be removed when no longer needed |
353 |
void fprintf (object_freezer &freezer, const char *format, ...); |
354 |
void fputs (const char *s, object_freezer &freezer); |
355 |
|
356 |
struct object_thawer |
357 |
{ |
358 |
char *line; // current beginning of line |
359 |
SV *text; // text part |
360 |
AV *av; // perl part |
361 |
int linenum; |
362 |
keyword kw; |
363 |
char *kw_str; // the keyword parsed, as string |
364 |
char *value; // the value, or 0 if no value |
365 |
char *value_nn; // the value, or the empty string if no value |
366 |
const char *name; |
367 |
|
368 |
operator bool () { return !!text; } |
369 |
|
370 |
object_thawer (const char *path = 0); |
371 |
object_thawer (const char *data, AV *perlav); |
372 |
~object_thawer (); |
373 |
|
374 |
void get (attachable *obj, int oid); |
375 |
|
376 |
// parse next line |
377 |
void next (); |
378 |
// skip the current key-value (usually fetch next line, for |
379 |
// multiline-fields, skips untilt he corresponding end-kw |
380 |
void skip (); |
381 |
|
382 |
//TODO: remove, deprecated |
383 |
keyword get_kv () |
384 |
{ |
385 |
next (); |
386 |
return kw; |
387 |
} |
388 |
|
389 |
char *get_str () { return value; } // may be 0 |
390 |
void get_ml (keyword kend, shstr &sh); |
391 |
|
392 |
void get_ornull (shstr &sh) const { sh = value; } |
393 |
void get (shstr &sh) const { sh = value; } // might want to check for non-null here |
394 |
|
395 |
bool get_bool () const { return *value_nn == '1'; } |
396 |
sint32 get_sint32 () const; |
397 |
sint64 get_sint64 () const { return atoll (value_nn); } |
398 |
double get_double () const { return atof (value_nn); } |
399 |
|
400 |
void get (float &v) { v = get_double (); } |
401 |
void get (double &v) { v = get_double (); } |
402 |
|
403 |
void get (bool &i) { i = get_bool (); } |
404 |
void get (sint8 &i) { i = get_sint32 (); } |
405 |
void get (uint8 &i) { i = get_sint32 (); } |
406 |
void get (sint16 &i) { i = get_sint32 (); } |
407 |
void get (uint16 &i) { i = get_sint32 (); } |
408 |
void get (sint32 &i) { i = get_sint32 (); } |
409 |
|
410 |
void get (uint32 &i) { i = get_sint64 (); } |
411 |
void get (sint64 &i) { i = get_sint64 (); } |
412 |
|
413 |
bool parse_error (const char *type = 0, const char *name = 0, bool skip = true); |
414 |
}; |
415 |
|
416 |
//TODO: remove |
417 |
char *fgets (char *s, int n, object_thawer &thawer); |
418 |
|
419 |
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// |
420 |
|
421 |
struct coroapi { |
422 |
static struct CoroAPI *GCoroAPI; |
423 |
|
424 |
static int nready () { return CORO_NREADY; } |
425 |
static int cede () { return CORO_CEDE ; } |
426 |
|
427 |
static double (*time)(); |
428 |
static double next_cede; |
429 |
static int cede_counter; |
430 |
|
431 |
static void do_cede_every (); |
432 |
static void do_cede_to_tick (); |
433 |
static void do_cede_to_tick_every (); |
434 |
|
435 |
static void cede_every (int count) |
436 |
{ |
437 |
if (expect_false (++cede_counter >= count)) |
438 |
do_cede_every (); |
439 |
} |
440 |
|
441 |
static void cede_to_tick () |
442 |
{ |
443 |
if (expect_false (time () >= next_cede)) |
444 |
do_cede_to_tick (); |
445 |
} |
446 |
|
447 |
static void cede_to_tick_every (int count) |
448 |
{ |
449 |
if (expect_false (++cede_counter >= count)) |
450 |
cede_to_tick (); |
451 |
} |
452 |
|
453 |
static void wait_for_tick (); |
454 |
static void wait_for_tick_begin (); |
455 |
}; |
456 |
|
457 |
struct watcher_base |
458 |
{ |
459 |
static struct EventAPI *GEventAPI; |
460 |
}; |
461 |
|
462 |
template<class base> |
463 |
struct watcher : watcher_base |
464 |
{ |
465 |
base *pe; |
466 |
|
467 |
void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); } |
468 |
void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); } |
469 |
void now () { GEventAPI->now ((pe_watcher *)pe); } |
470 |
void suspend () { GEventAPI->suspend ((pe_watcher *)pe); } |
471 |
void resume () { GEventAPI->resume ((pe_watcher *)pe); } |
472 |
|
473 |
void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; } |
474 |
|
475 |
~watcher () |
476 |
{ |
477 |
cancel (); |
478 |
} |
479 |
|
480 |
private: |
481 |
void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private |
482 |
}; |
483 |
|
484 |
struct iw : watcher<pe_idle>, callback<void (iw &)> |
485 |
{ |
486 |
template<class O, class M> |
487 |
iw (O object, M method) |
488 |
: callback<void (iw &)> (object, method) |
489 |
{ |
490 |
alloc (); |
491 |
} |
492 |
|
493 |
private: |
494 |
void alloc (); |
495 |
}; |
496 |
|
497 |
struct iow : watcher<pe_io>, callback<void (iow &, int)> |
498 |
{ |
499 |
template<class O, class M> |
500 |
iow (O object, M method) |
501 |
: callback<void (iow &, int)> (object, method) |
502 |
{ |
503 |
alloc (); |
504 |
} |
505 |
|
506 |
void fd (int fd); |
507 |
int poll (); |
508 |
void poll (int events); |
509 |
|
510 |
private: |
511 |
void alloc (); |
512 |
}; |
513 |
|
514 |
#endif |
515 |
|