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