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