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