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