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.13 by root, Mon Aug 28 16:52:51 2006 UTC vs.
Revision 1.82 by root, Wed Jul 11 16:55:18 2007 UTC

1/*
2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 *
8 * Crossfire TRT 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 <crossfire@schmorp.de>
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
7struct pl; 30#include <cstdarg>
8struct object; 31#include <cstdio>
9struct mapstruct; 32#include <bitset>
33
34using namespace std;
35
36#include <EXTERN.h>
37#include <perl.h>
38#include <XSUB.h>
39
40#include <EventAPI.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 readdir
56#undef getprotobyname
57#undef gethostbyname
58#undef ctime
59#undef strerror
60
61// same here, massive symbol spamming
62#undef do_open
63#undef do_close
64#undef ref
65#undef seed
66
67// perl bug #40256: perl does overwrite those with reentrant versions
68// but does not initialise their state structures.
69#undef random
70#undef crypt
71
72//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
73
74// some macros to simplify perl in-calls
75
76#define CHECK_ERROR \
77 if (SvTRUE (ERRSV)) \
78 LOG (llevError, "runtime error in %s: %s\n", __func__, SvPVutf8_nolen (ERRSV));
79
80#define CALL_BEGIN(args) dSP; ENTER; SAVETMPS; PUSHMARK (SP); EXTEND (SP, args)
81#define CALL_ARG_SV(sv) PUSHs (sv_2mortal (sv)) // separate because no refcount inc
82#define CALL_ARG(expr) PUSHs (sv_2mortal (to_sv (expr)))
83#define CALL_CALL(name, flags) PUTBACK; int count = call_pv (name, (flags) | G_EVAL); SPAGAIN;
84#define CALL_END CHECK_ERROR; FREETMPS; LEAVE
85
86//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
10 87
11void cfperl_init (); 88void cfperl_init ();
12void cfperl_main (); 89void cfperl_main ();
90void cfperl_emergency_save ();
91void cfperl_cleanup (int make_core);
92void cfperl_make_book (object *book, int level);
93void cfperl_send_msg (client *ns, int color, const char *type, const char *msg);
13 94
14// could have used templates, but a more traditional C api 95//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
15// uses more explicit typing which is ok for this purpose.
16enum data_type
17{
18 DT_END, // no further arguments
19 DT_AV, // perl-only av that needs to be flattened out
20 DT_INT,
21 DT_INT64,
22 DT_DOUBLE,
23 DT_STRING, // 0-terminated string
24 DT_DATA, // string + length
25 DT_OBJECT,
26 DT_MAP,
27 DT_PLAYER,
28 DT_ARCH,
29 DT_PARTY,
30 DT_REGION,
31 96
32 NUM_DATA_TYPES 97extern tstamp runtime; // virtual server time, excluding time jumps and lag
33}; 98extern tstamp NOW; // real time of current server tick
34 99
35enum event_klass 100enum event_klass
36{ 101{
37 KLASS_NONE, 102 KLASS_NONE,
38 KLASS_GLOBAL, 103 KLASS_GLOBAL,
104 KLASS_ATTACHABLE,
105 KLASS_CLIENT,
39 KLASS_PLAYER, 106 KLASS_PLAYER,
40 KLASS_OBJECT, 107 KLASS_OBJECT,
41 KLASS_MAP, 108 KLASS_MAP,
109 KLASS_COMMAND,
42}; 110};
43 111
44enum event_type 112enum event_type
45{ 113{
46# define def(klass,name) EVENT_ ## klass ## _ ## name, 114# define def(klass,name) EVENT_ ## klass ## _ ## name,
47# include "eventinc.h" 115# include "eventinc.h"
48# undef def 116# undef def
49 NUM_EVENT_TYPES 117 NUM_EVENT_TYPES
50}; 118};
51 119
120// in which global events or per-type events are we interested
121extern bitset<NUM_EVENT_TYPES> ev_want_event;
122extern bitset<NUM_TYPES> ev_want_type;
123
52#define ARG_AV(o) DT_AV , static_cast<AV *> (o) 124#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
53#define ARG_INT(v) DT_INT , static_cast<int> (v) 125#define ARG_INT(v) DT_INT , static_cast<int> (v)
54#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v) 126#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
55#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v) 127#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
56#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v) 128#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
57#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), (l) 129#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
58#define ARG_OBJECT(o) DT_OBJECT, (void *)static_cast<struct object *> (o) 130#define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o))
59#define ARG_MAP(o) DT_MAP , (void *)static_cast<struct mapstruct *> (o) 131#define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o))
60#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<struct pl *> (o) 132#define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (o))
61#define ARG_ARCH(o) DT_ARCH , (void *)static_cast<struct archetype *> (o) 133#define ARG_ARCH(o) DT_ARCH , (void *)(static_cast<archetype *> (o))
134#define ARG_CLIENT(o) DT_CLIENT, (void *)(static_cast<client *> (o))
62#define ARG_PARTY(o) DT_PARTY , (void *)static_cast<struct party *> (o) 135#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o))
63#define ARG_REGION(o) DT_REGION, (void *)static_cast<struct region *> (o) 136#define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o))
64 137
65// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension 138// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
66 139#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
67// all these return true when the normal event processing should be skipped (if any)
68#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
69
70#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
71#define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__) 140#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
141#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__)
72#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__) 142#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__)
143#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
73#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__) 144#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__)
74#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__) 145#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
75 146
76//TODO should index into @result 147//TODO should index into @result
77#define RESULT(idx,type) cfperl_result_ ## type (idx) 148#define RESULT(idx,type) cfperl_result_ ## type (idx)
149#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
78#define RESULT_INT(idx) RESULT(idx, INT) 150#define RESULT_INT(idx) RESULT(idx, INT)
79 151
80bool cfperl_invoke (event_type event, ...); 152double cfperl_result_DOUBLE (int idx);
81int cfperl_result_INT (int idx); 153int cfperl_result_INT (int idx);
82 154
155//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
156
157INTERFACE_CLASS (attachable)
83struct attachable_base 158struct attachable
84{ 159{
85 void *self, *cb; // CF+ perl self and callback 160 static MGVTBL vtbl;
161
162 static unordered_vector<attachable *> mortals;
163 MTH static void check_mortals ();
164
165 enum {
166 F_DESTROYED = 0x01,
167 F_DEBUG_TRACE = 0x02,
168 };
169
170 // object is delete'd after the refcount reaches 0
171 int ACC (RW, flags);
172 mutable int ACC (RW, refcnt);
173
174 MTH void refcnt_inc () const { ++refcnt; }
175 MTH void refcnt_dec () const { --refcnt; }
176
177 MTH int refcnt_cnt () const;
178 // check wether the object has died and destroy
179 MTH void refcnt_chk () { if (expect_false (refcnt <= 0)) do_check (); }
180
181 // destroy the object unless it was already destroyed
182 // this politely asks everybody interested the reduce
183 // the refcount to 0 as soon as possible.
184 MTH void destroy ();
185
186 // return wether an object was destroyed already
187 MTH bool destroyed () const { return flags & F_DESTROYED; }
188
189 virtual void gather_callbacks (AV *&callbacks, event_type event) const;
190
191#if 0
192private:
193 static refcounted *rc_first;
194 refcounted *rc_next;
195#endif
196
197 HV *self; // CF+ perl self
198 AV *cb; // CF+ callbacks
86 const char *attach; // generic extension attachment information 199 shstr attach; // generic extension attachment information
87 200
88 void clear (); // called when free'ing objects 201 void sever_self (); // sever this object from its self, if it has one.
89 void optimise (); // possibly save some memory by destroying unneeded data 202 void optimise (); // possibly save some memory by destroying unneeded data
90 void instantiate (data_type type, void *obj);
91 203
92 void attachable_init () 204 attachable ()
205 : flags (0), refcnt (0), self (0), cb (0), attach (0)
93 { 206 {
94 self = cb = 0;
95 attach = 0;
96 } 207 }
97};
98 208
99// objects attachable from perl (or any other extension) should include or 209 attachable (const attachable &src)
100// derive using the curiously recurring template pattern, to avoid 210 : flags (0), refcnt (0), self (0), cb (0), attach (src.attach)
101// virtual method calls etc.
102template<class subclass>
103struct attachable : attachable_base
104{
105 static data_type get_dt ()
106 { 211 {
107 return subclass::get_dt ();
108 } 212 }
109 213
214 virtual ~attachable ();
215
216 // set a custom key to the given value, or delete it if value = 0
217 void set_key (const char *key, const char *value = 0);
218
219 attachable &operator =(const attachable &src);
220
221 // used to _quickly_ device wether to shortcut the evaluation
222 bool should_invoke (event_type event)
223 {
224 return ev_want_event [event] || cb;
225 }
226
227 bool invoke (event_type event, ...);
228
110 void instantiate () 229 MTH void instantiate ();
111 { 230 void reattach ();
112 if (attach)
113 attachable_base::instantiate (get_dt (), static_cast<subclass *>(this));
114 }
115};
116 231
117struct object_freezethaw 232protected:
118{ 233 // do the real refcount checking work
119 void *av; 234 void do_check ();
120 FILE *fp;
121 235
122 operator FILE *() { return fp; } 236 // the method that does the real destroy work
237 virtual void do_destroy ();
123}; 238};
124 239
125struct object_freezer : object_freezethaw 240// the global object is a pseudo object that cares for the global events
241struct global : attachable
126{ 242{
127 void *filename; 243 void gather_callbacks (AV *&callbacks, event_type event) const;
244};
128 245
129 object_freezer (const char *filename); 246extern struct global gbl_ev;
247
248//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
249
250struct object_freezer : dynbuf_text
251{
252 AV *av;
253
254 object_freezer ();
130 ~object_freezer (); 255 ~object_freezer ();
131 256
132 void put (attachable_base *ext); 257 void put (attachable *ext);
133 258
134 template<class subclass> 259 // used only for user-defined key-value pairs
135 void put (attachable<subclass> *obj) 260 void put (const shstr &k, const shstr &v)
136 { 261 {
137 put ((attachable_base *)obj); 262 add (k);
138 }
139};
140 263
141struct object_thawer : object_freezethaw 264 if (expect_true (v))
265 add (' '), add (v);
266
267 add ('\n');
268 }
269
270 template<typename T>
271 void put_kw_string (keyword k, const T &v)
272 {
273 int klen = keyword_len [k];
274 int vlen = v ? strlen (v) + 1 : 0;
275
276 char *p = (char *)alloc (klen + vlen + 1);
277
278 memcpy (p, keyword_str [k], klen); p += klen;
279
280 if (expect_true (v))
281 {
282 *p++ = ' '; vlen--;
283 memcpy (p, v, vlen); p += vlen;
284 }
285
286 *p = '\n';
287 }
288
289 void put (keyword k, const char *v = 0)
290 {
291 put_kw_string (k, v);
292 }
293
294 void put (keyword k, const shstr &v)
295 {
296 put_kw_string (k, v);
297 }
298
299 void put (keyword k, double v)
300 {
301 force (MAX_KEYWORD_LEN + 2 + 32);
302 fadd (keyword_str [k], keyword_len [k]);
303 fadd (' ');
304 falloc (sprintf (ptr, "%.7g", v));
305 fadd ('\n');
306 }
307
308 void put_(keyword k, sint64 v)
309 {
310 force (MAX_KEYWORD_LEN + 2 + sint64_digits);
311 fadd (keyword_str [k], keyword_len [k]);
312 fadd (' ');
313 add (v);
314 fadd ('\n');
315 }
316
317 void put_(keyword k, sint32 v)
318 {
319 force (MAX_KEYWORD_LEN + 2 + sint32_digits);
320 fadd (keyword_str [k], keyword_len [k]);
321 fadd (' ');
322 add (v);
323 fadd ('\n');
324 }
325
326 void put (keyword k, float v) { put (k, (double)v); }
327 void put (keyword k, signed char v) { put_(k, (sint32)v); }
328 void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
329 void put (keyword k, signed short v) { put_(k, (sint32)v); }
330 void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
331 void put (keyword k, signed int v) { put_(k, (sint32)v); }
332 void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
333 void put (keyword k, signed long v) { put_(k, (sint64)v); }
334 void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
335 void put (keyword k, signed long long v) { put_(k, (sint64)v); }
336 void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
337
338 void put (keyword kbeg, keyword kend, const shstr &v)
339 {
340 force (MAX_KEYWORD_LEN + 1);
341 fadd (keyword_str [kbeg], keyword_len [kbeg]); fadd ('\n');
342
343 if (expect_true (v))
344 {
345 add (v);
346 add ('\n');
347 }
348
349 force (MAX_KEYWORD_LEN + 1);
350 fadd (keyword_str [kend], keyword_len [kend]); fadd ('\n');
351 }
352
353 void put (keyword k, archetype *v);
354 void put (keyword k, treasurelist *v);
355 void put (keyword k, faceinfo *v);
356
357 template<typename T>
358 void put (keyword k, const refptr<T> &v)
359 {
360 put (k, (T *)v);
361 }
362
363 bool save (const char *path);
364 char *as_string (); // like strdup
365
366 operator bool () { return !!av; }
367};
368
369struct object_thawer
142{ 370{
371 char *line; // current beginning of line
372 SV *text; // text part
373 AV *av; // perl part
374 int linenum;
375 keyword kw;
376 char *kw_str; // the keyword parsed, as string
377 char *value; // the value, or 0 if no value
378 char *value_nn; // the value, or the empty string if no value
379 const char *name;
380
381 operator bool () { return !!text; }
382
143 object_thawer (FILE *fp, const char *filename = 0); 383 object_thawer (const char *path = 0);
384 object_thawer (const char *data, AV *perlav);
144 ~object_thawer (); 385 ~object_thawer ();
145 386
146 void get (data_type type, void *obj, attachable_base *ext, int oid);
147
148 template<class subclass>
149 void get (attachable<subclass> *obj, int oid) 387 void get (attachable *obj, int oid);
388
389 // parse next line
390 void next ();
391 // skip the current key-value (usually fetch next line, for
392 // multiline-fields, skips till the corresponding end-kw
393 void skip ();
394
395 char *get_str () { return value; } // may be 0
396 void get_ml (keyword kend, shstr &sh);
397
398 void get_ornull (shstr &sh) const { sh = value; }
399 void get (shstr &sh) const { sh = value; } // might want to check for non-null here
400
401 bool get_bool () const { return *value_nn == '1'; }
402 sint32 get_sint32 () const;
403 sint64 get_sint64 () const { return strtoll (value_nn, 0, 10); }
404 double get_double () const { return strtod (value_nn, 0); }
405
406 void get (float &v) { v = get_double (); }
407 void get (double &v) { v = get_double (); }
408
409 void get (bool &i) { i = get_bool (); }
410 void get (sint8 &i) { i = get_sint32 (); }
411 void get (uint8 &i) { i = get_sint32 (); }
412 void get (sint16 &i) { i = get_sint32 (); }
413 void get (uint16 &i) { i = get_sint32 (); }
414 void get (sint32 &i) { i = get_sint32 (); }
415
416 void get (uint32 &i) { i = get_sint64 (); }
417 void get (sint64 &i) { i = get_sint64 (); }
418
419 bool parse_error (const char *type = 0, const char *name = 0, bool skip = true);
420};
421
422//TODO: remove
423char *fgets (char *s, int n, object_thawer &thawer);
424
425//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
426
427struct coroapi {
428 static struct CoroAPI *GCoroAPI;
429
430 static int nready () { return CORO_NREADY; }
431 static int cede () { return CORO_CEDE ; }
432
433 static tstamp next_cede;
434 static int cede_counter;
435
436 static void do_cede_every ();
437 static void do_cede_to_tick ();
438 static void do_cede_to_tick_every ();
439
440 static void cede_every (int count)
150 { 441 {
151 if (av) 442 if (expect_false (++cede_counter >= count))
152 get (subclass::get_dt (), (subclass *)obj, obj, oid); 443 do_cede_every ();
153 } 444 }
445
446 static bool cede_to_tick ()
447 {
448 if (expect_true (now () < next_cede))
449 return false;
450
451 do_cede_to_tick ();
452 return true;
453 }
454
455 static bool cede_to_tick_every (int count)
456 {
457 if (expect_true (++cede_counter < count))
458 return false;
459
460 return cede_to_tick ();
461 }
462
463 static void wait_for_tick ();
464 static void wait_for_tick_begin ();
465};
466
467struct watcher_base
468{
469 static struct EventAPI *GEventAPI;
470};
471
472template<class base>
473struct watcher : watcher_base
474{
475 base *pe;
476
477 void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); }
478 void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); }
479 void now () { GEventAPI->now ((pe_watcher *)pe); }
480 void suspend () { GEventAPI->suspend ((pe_watcher *)pe); }
481 void resume () { GEventAPI->resume ((pe_watcher *)pe); }
482
483 void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; }
484
485 ~watcher ()
486 {
487 cancel ();
488 }
489
490private:
491 void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private
492};
493
494struct iw : watcher<pe_idle>, callback<void (iw &)>
495{
496 template<class O, class M>
497 iw (O object, M method)
498 : callback<void (iw &)> (object, method)
499 {
500 alloc ();
501 }
502
503private:
504 void alloc ();
505};
506
507struct iow : watcher<pe_io>, callback<void (iow &, int)>
508{
509 template<class O, class M>
510 iow (O object, M method)
511 : callback<void (iow &, int)> (object, method)
512 {
513 alloc ();
514 }
515
516 void fd (int fd);
517 int poll ();
518 void poll (int events);
519
520private:
521 void alloc ();
154}; 522};
155 523
156#endif 524#endif
157 525

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines