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.3 by root, Fri Aug 25 13:24:50 2006 UTC vs.
Revision 1.115 by root, Sat Jan 16 17:57:32 2010 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines