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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines