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

Diff Legend

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