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.106 by root, Sun Oct 11 18:18:03 2009 UTC

1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 *
4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 *
8 * Deliantra is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 *
21 * The authors can be reached via e-mail to <support@deliantra.net>
22 */
23
1// 24//
2// cfperl.h perl interface 25// cfperl.h perl interface
3// 26//
27#ifndef CFPERL_H__
28#define CFPERL_H__
4 29
30#include <cstdarg>
31#include <cstdio>
32#include <bitset>
33
34using namespace std;
35
36#include <EXTERN.h>
37#include <perl.h>
38#include <XSUB.h>
39
40#include <EVAPI.h>
41#include <CoroAPI.h>
42
43#include "util.h"
44#include "keyword.h"
45#include "dynbuf.h"
46#include "callback.h"
47
48//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
49
50// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
51#undef localtime
52#undef srand48
53#undef drand48
54#undef srandom
55#undef opendir
56#undef readdir
57#undef closedir
58#undef getprotobyname
59#undef gethostbyname
60#undef ctime
61#undef strerror
62#undef _
63
64// same here, massive symbol spamming
65#undef do_open
66#undef do_close
67#undef ref
68#undef seed
69
70// perl bug #40256: perl does overwrite those with reentrant versions
71// but does not initialise their state structures.
72#undef random
73#undef crypt
74
75//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
76
77#define _(msg) (msg)
78#define N_(msg) (msg)
79
80//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
81
82// some macros to simplify perl in-calls
83
84#define CHECK_ERROR \
85 if (SvTRUE (ERRSV)) \
86 LOG (llevError, "runtime error in %s: %s", __func__, SvPVutf8_nolen (ERRSV));
87
88#define CALL_BEGIN(args) dSP; ENTER; SAVETMPS; PUSHMARK (SP); EXTEND (SP, args)
89#define CALL_ARG_SV(sv) PUSHs (sv_2mortal (sv)) // separate because no refcount inc
90#define CALL_ARG(expr) PUSHs (sv_2mortal (to_sv (expr)))
91#define CALL_CALL(name, flags) PUTBACK; int count = call_pv (name, (flags) | G_EVAL); SPAGAIN;
92#define CALL_END PUTBACK; CHECK_ERROR; FREETMPS; LEAVE
93
94//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
95
96void cfperl_init ();
5void cfperl_main (); 97void cfperl_main ();
98void cfperl_tick ();
99void cfperl_emergency_save ();
100void cfperl_cleanup (int make_core);
101void cfperl_make_book (object *book, int level);
102void cfperl_send_msg (client *ns, int color, const char *type, const char *msg);
103int cfperl_can_merge (object *ob1, object *ob2);
104void cfperl_mapscript_activate (object *ob, int state, object *activator, object *originator = 0);
105
106bool is_match_expr (const char *expr);
107/* applies the match expression and returns true if it matches */
108bool match (const char *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, 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 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 : flags (0), self (0), cb (0), attach (0)
232 {
233 }
234
235 attachable (const attachable &src)
236 : 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 char *key, const char *value = 0, bool is_utf8 = 0);
242
243 void set_key_text (const char *key, const char *value = 0)
244 {
245 set_key (key, value, 1);
246 }
247
248 void set_key_data (const char *key, const char *value = 0)
249 {
250 set_key (key, value, 0);
251 }
252
253 attachable &operator =(const attachable &src);
254
255 // used to _quickly_ device 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
287INTERFACE_CLASS(object_freezer)
288struct object_freezer : dynbuf_text
289{
290 AV *av;
291
292 object_freezer ();
293 ~object_freezer ();
294
295 void put (attachable *ext);
296
297 // used only for user-defined key-value pairs
298 void put (shstr_tmp k, shstr_tmp v)
299 {
300 add (k);
301
302 if (expect_true (v))
303 add (' '), add (v);
304
305 add ('\n');
306 }
307
308 template<typename T>
309 void put_kw_string (keyword k, const T &v)
310 {
311 int klen = keyword_len [k];
312 int vlen = v ? strlen (v) + 1 : 0;
313
314 char *p = (char *)alloc (klen + vlen + 1);
315
316 memcpy (p, keyword_str [k], klen); p += klen;
317
318 if (expect_true (v))
319 {
320 *p++ = ' '; vlen--;
321 memcpy (p, v, vlen); p += vlen;
322 }
323
324 *p = '\n';
325 }
326
327 void put (keyword k, const char *v = 0)
328 {
329 put_kw_string (k, v);
330 }
331
332 void put (keyword k, shstr_tmp v)
333 {
334 put_kw_string (k, v);
335 }
336
337 void put (keyword k, double v)
338 {
339 force (MAX_KEYWORD_LEN + 2 + 32);
340 fadd (keyword_str [k], keyword_len [k]);
341 fadd (' ');
342 falloc (sprintf (ptr, "%.7g", v));
343 fadd ('\n');
344 }
345
346 void put_(keyword k, sint64 v)
347 {
348 force (MAX_KEYWORD_LEN + 2 + sint64_digits);
349 fadd (keyword_str [k], keyword_len [k]);
350 fadd (' ');
351 add (v);
352 fadd ('\n');
353 }
354
355 void put_(keyword k, sint32 v)
356 {
357 force (MAX_KEYWORD_LEN + 2 + sint32_digits);
358 fadd (keyword_str [k], keyword_len [k]);
359 fadd (' ');
360 add (v);
361 fadd ('\n');
362 }
363
364 void put (keyword k, float v) { put (k, (double)v); }
365 void put (keyword k, signed char v) { put_(k, (sint32)v); }
366 void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
367 void put (keyword k, signed short v) { put_(k, (sint32)v); }
368 void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
369 void put (keyword k, signed int v) { put_(k, (sint32)v); }
370 void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
371 void put (keyword k, signed long v) { put_(k, (sint64)v); }
372 void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
373 void put (keyword k, signed long long v) { put_(k, (sint64)v); }
374 void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
375
376 void put (keyword kbeg, keyword kend, shstr_tmp v)
377 {
378 force (MAX_KEYWORD_LEN + 1);
379 fadd (keyword_str [kbeg], keyword_len [kbeg]); fadd ('\n');
380
381 if (expect_true (v))
382 {
383 add (v);
384 add ('\n');
385 }
386
387 force (MAX_KEYWORD_LEN + 1);
388 fadd (keyword_str [kend], keyword_len [kend]); fadd ('\n');
389 }
390
391 void put (keyword k, archetype *v);
392 void put (keyword k, treasurelist *v);
393 void put (keyword k, faceinfo *v);
394
395 template<typename T>
396 void put (keyword k, const refptr<T> &v)
397 {
398 put (k, (T *)v);
399 }
400
401 MTH bool save (const_octet_string path);
402 char *as_string (); // like strdup
403
404 operator bool () { return !!av; }
405};
406
407INTERFACE_CLASS(object_thawer)
408struct object_thawer
409{
410 char *line; // current beginning of line
411 SV *text; // text part
412 AV *av; // perl part
413 int linenum;
414 keyword kw;
415 char *kw_str; // the keyword parsed, as string
416 char *value; // the value, or 0 if no value
417 const char *value_nn; // the value, or the empty string if no value
418 const char *name;
419
420 operator bool () const { return !!text; }
421
422 object_thawer (const char *path = 0);
423 object_thawer (const char *data, AV *perlav);
424 ~object_thawer ();
425
426 void get (attachable *obj, int oid);
427
428 // parse next line
429 MTH void next ();
430 // skip the current key-value (usually fetch next line, for
431 // multiline-fields, skips till the corresponding end-kw
432 MTH void skip ();
433 MTH void skip_block (); // skips till and over KW_end
434
435 char *get_str () { return value; } // may be 0
436 void get_ml (keyword kend, shstr &sh);
437
438 void get_ornull (shstr &sh) const { sh = value; }
439 void get (shstr &sh) const { sh = value; } // might want to check for non-null here
440
441 bool get_bool () const { return *value_nn == '1'; }
442 sint32 get_sint32 () const;
443 sint64 get_sint64 () const { return strtoll (value_nn, 0, 10); }
444 double get_double () const { return strtod (value_nn, 0); }
445
446 void get (float &v) { v = get_double (); }
447 void get (double &v) { v = get_double (); }
448
449 void get (bool &i) { i = get_bool (); }
450 void get (sint8 &i) { i = get_sint32 (); }
451 void get (uint8 &i) { i = get_sint32 (); }
452 void get (sint16 &i) { i = get_sint32 (); }
453 void get (uint16 &i) { i = get_sint32 (); }
454 void get (sint32 &i) { i = get_sint32 (); }
455
456 void get (uint32 &i) { i = get_sint64 (); }
457 void get (sint64 &i) { i = get_sint64 (); }
458
459 MTH void parse_warn (const char *msg);
460 MTH bool parse_error (const char *type = 0, const char *name = 0, bool skip = true);
461
462 struct delayed_ref {
463 attachable *op;
464 object_ptr *ptr;
465 const char *ref;
466 };
467 std::vector<delayed_ref> delrefs;
468
469 void delayed_deref (attachable *op, object_ptr &ptr, const char *ref);
470 MTH void resolve_delayed_derefs (bool deref = true);
471};
472
473//TODO: remove
474char *fgets (char *s, int n, object_thawer &thawer);
475
476//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
477
478struct coroapi {
479 static struct CoroAPI *GCoroAPI;
480
481 static EV_ATOMIC_T cede_pending;
482
483 static int nready () { return CORO_NREADY; }
484 static int cede () { cede_pending = 0; return CORO_CEDE ; }
485
486 static void do_cede_to_tick ();
487
488 // actually cede's far more often
489 static bool cede_to_tick ()
490 {
491 if (expect_true (!cede_pending))
492 return false;
493
494 do_cede_to_tick ();
495 return true;
496 }
497
498 static void wait_for_tick ();
499 static void wait_for_tick_begin ();
500};
501
502struct evapi
503{
504 static struct EVAPI *GEVAPI;
505};
506
507struct iow : ev_io, evapi, callback<void (iow &, int)>
508{
509 static void thunk (EV_P_ struct ev_io *w_, int revents)
510 {
511 iow &w = *static_cast<iow *>(w_);
512
513 w (w, revents);
514 }
515
516 template<class O, class M>
517 iow (O object, M method)
518 : callback<void (iow &, int)> (object, method)
519 {
520 ev_init ((ev_io *)this, thunk);
521 }
522
523 void prio (int prio)
524 {
525 ev_set_priority ((ev_io *)this, prio);
526 }
527
528 void set (int fd, int events)
529 {
530 ev_io_set ((ev_io *)this, fd, events);
531 }
532
533 int poll () const { return events; }
534
535 void poll (int events);
536
537 void start ()
538 {
539 ev_io_start (EV_DEFAULT, (ev_io *)this);
540 }
541
542 void stop ()
543 {
544 ev_io_stop (EV_DEFAULT, (ev_io *)this);
545 }
546
547 ~iow ()
548 {
549 stop ();
550 }
551};
552
553struct asyncw : ev_async, evapi, callback<void (ev_async &, int)>
554{
555 static void thunk (EV_P_ struct ev_async *w_, int revents)
556 {
557 asyncw &w = *static_cast<asyncw *>(w_);
558
559 w (w, revents);
560 }
561
562 template<class O, class M>
563 asyncw (O object, M method)
564 : callback<void (asyncw &, int)> (object, method)
565 {
566 ev_init ((ev_async *)this, thunk);
567 }
568
569 void start ()
570 {
571 ev_async_start (EV_DEFAULT, (ev_async *)this);
572 }
573
574 void stop ()
575 {
576 ev_async_stop (EV_DEFAULT, (ev_async *)this);
577 }
578
579 ~asyncw ()
580 {
581 stop ();
582 }
583};
584
585#endif
586

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines