ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/cfperl.h
(Generate patch)

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.2 by root, Thu Aug 24 17:29:30 2006 UTC vs.
Revision 1.119 by root, Sun Apr 11 04:09:56 2010 UTC

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines