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