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.1 by root, Thu Aug 24 13:13:49 2006 UTC vs.
Revision 1.121 by root, Thu Apr 15 03:34:30 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//
26#ifndef CFPERL_H__
27#define CFPERL_H__
4 28
29using namespace std;
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 ();
5void cfperl_main (); 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
146enum event_type
147{
148# define def(klass,name) EVENT_ ## klass ## _ ## name,
149# include "eventinc.h"
150# undef def
151 NUM_EVENT_TYPES
152};
153
154// in which global events or per-type events are we interested
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)
161#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
162#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
163#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
164#define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o))
165#define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o))
166#define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (o))
167#define ARG_ARCH(o) DT_ARCH , (void *)(static_cast<archetype *> (o))
168#define ARG_CLIENT(o) DT_CLIENT, (void *)(static_cast<client *> (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))
171
172// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
173#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
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__)
180
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)
185
186double cfperl_result_DOUBLE (int idx);
187int cfperl_result_INT (int idx);
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 // destruct and free the memory for this object
219 virtual void do_delete ();
220
221 virtual void gather_callbacks (AV *&callbacks, event_type event) const;
222
223#if 0
224private:
225 static refcounted *rc_first;
226 refcounted *rc_next;
227#endif
228
229 HV *self; // CF+ perl self
230 AV *cb; // CF+ callbacks
231 shstr attach; // generic extension attachment information
232
233 void sever_self (); // sever this object from its self, if it has one.
234 void optimise (); // possibly save some memory by destroying unneeded data
235
236 attachable ()
237 : attachable_flags (0), self (0), cb (0), attach (0)
238 {
239 }
240
241 attachable (const attachable &src)
242 : attachable_flags (0), self (0), cb (0), attach (src.attach)
243 {
244 }
245
246 // set a custom key to the given value, or delete it if value = 0
247 void set_key (const_utf8_string key, const_utf8_string value = 0, bool is_utf8 = 0);
248
249 void set_key_text (const_utf8_string key, const_utf8_string value = 0)
250 {
251 set_key (key, value, 1);
252 }
253
254 void set_key_data (const_utf8_string key, const_utf8_string value = 0)
255 {
256 set_key (key, value, 0);
257 }
258
259 attachable &operator =(const attachable &src);
260
261 // used to _quickly_ decide wether to shortcut the evaluation
262 bool should_invoke (event_type event)
263 {
264 return ev_want_event [event] || cb;
265 }
266
267 bool invoke (event_type event, ...);
268
269 MTH void instantiate ();
270 void reattach ();
271
272protected:
273 // do the real refcount checking work
274 void do_check ();
275
276 // the method that does the real destroy work
277 virtual void do_destroy ();
278
279 // destructor is protected, should not be called by anybody
280 virtual ~attachable ();
281};
282
283// the global object is a pseudo object that cares for the global events
284struct global : attachable
285{
286 void gather_callbacks (AV *&callbacks, event_type event) const;
287};
288
289extern struct global gbl_ev;
290
291//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
292
293// a little dirty hack, maybe unify with something else at a later time
294// it is used to communicate as much info about the keyword string
295// to the consuemr as possible, for maximum performance.
296struct keyword_string
297{
298 const char *s;
299 const int l;
300
301 keyword_string (const char *s, int l)
302 : s(s), l(l)
303 { }
304
305 keyword_string (keyword kw)
306 : s(keyword_str [kw]), l(keyword_len [kw])
307 {
308 }
309
310 keyword_string (shstr_tmp sh)
311 : s(&sh), l(sh.length ())
312 {
313 }
314};
315
316#define CS(keyword) keyword_string (# keyword, sizeof (# keyword) - 1)
317#define KW(keyword) CS(keyword)
318
319INTERFACE_CLASS(object_freezer)
320struct object_freezer : dynbuf_text
321{
322 AV *av;
323
324 object_freezer ();
325 ~object_freezer ();
326
327 // serialise perl part
328 void put_ (attachable *ext);
329 void put (attachable *ext)
330 {
331 if (expect_false (ext->self))
332 put_ (ext);
333 }
334
335 // null value (== no space after keyword)
336 void put (const keyword_string k)
337 {
338 char *p = force (k.l + 1);
339 memcpy (p, k.s, k.l); p += k.l; *p++ = '\n';
340 alloc (p);
341 }
342
343 void put (const keyword_string k, const keyword_string v)
344 {
345 char *p = force (k.l + 1 + v.l + 1);
346 memcpy (p, k.s, k.l); p += k.l; *p++ = ' ';
347 memcpy (p, v.s, v.l); p += v.l; *p++ = '\n';
348 alloc (p);
349 }
350
351 void put (const keyword_string k, const_utf8_string v)
352 {
353 if (expect_true (v))
354 put (k, keyword_string (v, strlen (v)));
355 else
356 put (k);
357 }
358
359 void put (const keyword_string k, shstr_tmp v)
360 {
361 put (k, keyword_string (v));
362 }
363
364 void put (const keyword_string k, double v)
365 {
366 char *p = force (MAX_KEYWORD_LEN + 2 + 32);
367 memcpy (p, k.s, k.l); p += k.l; *p++ = ' ';
368 p += sprintf (p, "%.7g", v); *p++ = '\n';
369 alloc (p);
370 }
371
372 void put_(const keyword_string k, sint64 v)
373 {
374 force (MAX_KEYWORD_LEN + 2 + sint64_digits);
375 fadd (k.s, k.l);
376 fadd (' ');
377 add (v);
378 fadd ('\n');
379 }
380
381 void put_(const keyword_string k, sint32 v)
382 {
383 force (MAX_KEYWORD_LEN + 2 + sint32_digits);
384 fadd (k.s, k.l);
385 fadd (' ');
386 add (v);
387 fadd ('\n');
388 }
389
390 void put (const keyword_string k, float v) { put (k, (double)v); }
391 void put (const keyword_string k, signed char v) { put_(k, (sint32)v); }
392 void put (const keyword_string k, unsigned char v) { put_(k, (sint32)v); }
393 void put (const keyword_string k, signed short v) { put_(k, (sint32)v); }
394 void put (const keyword_string k, unsigned short v) { put_(k, (sint32)v); }
395 void put (const keyword_string k, signed int v) { put_(k, (sint32)v); }
396 void put (const keyword_string k, unsigned int v) { put_(k, (sint64)v); }
397 void put (const keyword_string k, signed long v) { put_(k, (sint64)v); }
398 void put (const keyword_string k, unsigned long v) { put_(k, (sint64)v); }
399 void put (const keyword_string k, signed long long v) { put_(k, (sint64)v); }
400 void put (const keyword_string k, unsigned long long v) { put_(k, (sint64)v); }
401
402 void put (const keyword_string kbeg, const keyword_string kend, shstr_tmp v)
403 {
404 force (MAX_KEYWORD_LEN + 1);
405 fadd (kbeg.s, kbeg.l); fadd ('\n');
406
407 if (expect_true (v))
408 {
409 add (v);
410 add ('\n');
411 }
412
413 force (MAX_KEYWORD_LEN + 1);
414 fadd (kend.s, kend.l); fadd ('\n');
415 }
416
417 void put (const keyword_string k, archetype *v);
418 void put (const keyword_string k, treasurelist *v);
419 void put (const keyword_string k, faceinfo *v);
420
421 template<typename T>
422 void put (const keyword_string k, const refptr<T> &v)
423 {
424 put (k, (T *)v);
425 }
426
427 MTH bool save (const_octet_string path);
428 utf8_string as_string (); // like strdup
429
430 operator bool () { return !!av; }
431};
432
433INTERFACE_CLASS(object_thawer)
434struct object_thawer
435{
436 char *line; // current beginning of line
437 SV *text; // text part
438 AV *av; // perl part
439 int linenum;
440 keyword kw;
441 char *kw_str; // the keyword parsed, as string
442 char *value; // the value, or 0 if no value
443 const char *value_nn; // the value, or the empty string if no value
444 const char *name;
445
446 operator bool () const { return !!text; }
447
448 object_thawer (const_utf8_string path = 0);
449 object_thawer (const_utf8_string data, AV *perlav);
450 ~object_thawer ();
451
452 void get (attachable *obj, int oid);
453
454 // parse next line
455 MTH void next ();
456 // skip the current key-value (usually fetch next line, for
457 // multiline-fields, skips till the corresponding end-kw
458 MTH void skip ();
459 MTH void skip_block (); // skips till and over KW_end
460
461 bool has_value () { return value; }
462 const_utf8_string get_str () { return value_nn; } // empty string when missing
463 void get_ml (keyword kend, shstr &sh);
464
465 void get_ornull (shstr &sh) const { sh = value; }
466 void get (shstr &sh) const { sh = value; } // might want to check for non-null here
467
468 bool get_bool () const { return *value_nn == '1'; }
469 sint32 get_sint32 () const;
470 sint64 get_sint64 () const { return strtoll (value_nn, 0, 10); }
471 double get_double () const { return strtod (value_nn, 0); }
472
473 void get (float &v) { v = get_double (); }
474 void get (double &v) { v = get_double (); }
475
476 void get (bool &i) { i = get_bool (); }
477 void get (sint8 &i) { i = get_sint32 (); }
478 void get (uint8 &i) { i = get_sint32 (); }
479 void get (sint16 &i) { i = get_sint32 (); }
480 void get (uint16 &i) { i = get_sint32 (); }
481 void get (sint32 &i) { i = get_sint32 (); }
482
483 void get (uint32 &i) { i = get_sint64 (); }
484 void get (sint64 &i) { i = get_sint64 (); }
485
486 MTH void parse_warn (const_utf8_string msg);
487 MTH bool parse_error (const_utf8_string type = 0, const_utf8_string name = 0, bool skip = true);
488
489 struct delayed_ref {
490 attachable *op;
491 object_ptr *ptr;
492 const_utf8_string ref;
493 };
494 std::vector<delayed_ref> delrefs;
495
496 void delayed_deref (attachable *op, object_ptr &ptr, const_utf8_string ref);
497 MTH void resolve_delayed_derefs (bool deref = true);
498};
499
500//TODO: remove
501char *fgets (char *s, int n, object_thawer &thawer);
502
503//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
504
505struct coroapi {
506 static struct CoroAPI *GCoroAPI;
507
508 static EV_ATOMIC_T cede_pending;
509
510 static int nready () { return CORO_NREADY; }
511 static int cede () { cede_pending = 0; return CORO_CEDE ; }
512
513 static void do_cede_to_tick ();
514
515 // actually cede's far more often
516 static bool cede_to_tick ()
517 {
518 if (expect_true (!cede_pending))
519 return false;
520
521 do_cede_to_tick ();
522 return true;
523 }
524
525 static void wait_for_tick ();
526 static void wait_for_tick_begin ();
527};
528
529struct evapi
530{
531 static struct EVAPI *GEVAPI;
532};
533
534struct iow : ev_io, evapi, callback<void (iow &, int)>
535{
536 static void thunk (EV_P_ struct ev_io *w_, int revents)
537 {
538 iow &w = *static_cast<iow *>(w_);
539
540 w (w, revents);
541 }
542
543 template<class O, class M>
544 iow (O object, M method)
545 : callback<void (iow &, int)> (object, method)
546 {
547 ev_init ((ev_io *)this, thunk);
548 }
549
550 void prio (int prio)
551 {
552 ev_set_priority ((ev_io *)this, prio);
553 }
554
555 void set (int fd, int events)
556 {
557 ev_io_set ((ev_io *)this, fd, events);
558 }
559
560 int poll () const { return events; }
561
562 void poll (int events);
563
564 void start ()
565 {
566 ev_io_start (EV_DEFAULT, (ev_io *)this);
567 }
568
569 void stop ()
570 {
571 ev_io_stop (EV_DEFAULT, (ev_io *)this);
572 }
573
574 ~iow ()
575 {
576 stop ();
577 }
578};
579
580struct asyncw : ev_async, evapi, callback<void (ev_async &, int)>
581{
582 static void thunk (EV_P_ struct ev_async *w_, int revents)
583 {
584 asyncw &w = *static_cast<asyncw *>(w_);
585
586 w (w, revents);
587 }
588
589 template<class O, class M>
590 asyncw (O object, M method)
591 : callback<void (asyncw &, int)> (object, method)
592 {
593 ev_init ((ev_async *)this, thunk);
594 }
595
596 void start ()
597 {
598 ev_async_start (EV_DEFAULT, (ev_async *)this);
599 }
600
601 void stop ()
602 {
603 ev_async_stop (EV_DEFAULT, (ev_async *)this);
604 }
605
606 ~asyncw ()
607 {
608 stop ();
609 }
610};
611
612#endif
613

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines