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.17 by root, Thu Aug 31 06:23:19 2006 UTC vs.
Revision 1.76 by root, Mon Jun 4 12:19:08 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines