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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines