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