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