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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines