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.7 by root, Sat Aug 26 23:36:32 2006 UTC vs.
Revision 1.122 by root, Thu Apr 15 04:02:38 2010 UTC

1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 *
4 * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 *
6 * Deliantra is free software: you can redistribute it and/or modify it under
7 * the terms of the Affero GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the Affero GNU General Public License
17 * and the GNU General Public License along with this program. If not, see
18 * <http://www.gnu.org/licenses/>.
19 *
20 * The authors can be reached via e-mail to <support@deliantra.net>
21 */
22
1// 23//
2// cfperl.h perl interface 24// cfperl.h perl interface
3// 25//
4#ifndef CFPERL_H__ 26#ifndef CFPERL_H__
5#define CFPERL_H__ 27#define CFPERL_H__
6 28
7struct pl; 29using namespace std;
8struct object; 30
9struct mapstruct; 31#include <EXTERN.h>
32#include <perl.h>
33#include <XSUB.h>
34
35#include <EVAPI.h>
36#include <CoroAPI.h>
37
38#include "util.h"
39#include "keyword.h"
40#include "dynbuf.h"
41#include "callback.h"
42
43//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
44
45// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
46#undef localtime
47#undef srand48
48#undef drand48
49#undef srandom
50#undef opendir
51#undef readdir
52#undef closedir
53#undef getprotobyname
54#undef gethostbyname
55#undef ctime
56#undef strerror
57#undef _
58
59// same here, massive symbol spamming
60#undef do_open
61#undef do_close
62#undef ref
63#undef seed
64
65// perl bug #40256: perl does overwrite those with reentrant versions
66// but does not initialise their state structures.
67#undef random
68#undef crypt
69
70//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
71
72#define _(msg) (msg)
73#define N_(msg) (msg)
74
75//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
76
77// some macros to simplify perl in-calls
78
79#define CHECK_ERROR \
80 if (SvTRUE (ERRSV)) \
81 LOG (llevError, "runtime error in %s: %s", __func__, SvPVutf8_nolen (ERRSV));
82
83inline int call_pvsv (const char *ob, I32 flags) { return call_pv (ob, flags); }
84inline int call_pvsv (SV *ob, I32 flags) { return call_sv (ob, flags); }
85
86// TODO: temporarily enabled pushstack/popstack for all calls from the core, to maybe fix object memleak?
87#define CALL_PUSH PUSHSTACKi (PERLSI_UNKNOWN)
88#define CALL_POP PUTBACK; POPSTACK; SPAGAIN
89#define CALL_BEGIN(args) dSP; CALL_PUSH; ENTER; SAVETMPS; PUSHMARK (SP); EXTEND (SP, args)
90#define CALL_ARG_SV(sv) PUSHs (sv_2mortal (sv)) // separate because no refcount inc
91#define CALL_ARG(expr) PUSHs (sv_2mortal (to_sv (expr)))
92#define CALL_CALL(name, flags) PUTBACK; int count = call_pvsv (name, (flags) | G_EVAL); SPAGAIN;
93#define CALL_END PUTBACK; CHECK_ERROR; FREETMPS; LEAVE; CALL_POP
94
95//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
10 96
11void cfperl_init (); 97void cfperl_init ();
12void cfperl_main (); 98void cfperl_main ();
99void cfperl_tick ();
100void cfperl_emergency_save ();
101void cfperl_cleanup (int make_core);
102void cfperl_make_book (object *book, int level);
103void cfperl_send_msg (client *ns, int color, const_utf8_string type, const_utf8_string msg);
104int cfperl_can_merge (object *ob1, object *ob2);
105void cfperl_mapscript_activate (object *ob, int state, object *activator, object *originator = 0);
13 106
14// could have used templates, but a more traditional C api 107bool is_match_expr (const_utf8_string expr);
15// uses more explicit typing which is ok for this purpose. 108// applies the match expression and returns true if it matches
16enum data_type 109bool match (const_utf8_string expr, object *ob, object *self = 0, object *source = 0, object *originator = 0);
17{ 110// same as above, but returns the first object found, or 0
18 DT_END, // no further arguments 111object *match_one (const_utf8_string expr, object *ob, object *self = 0, object *source = 0, object *originator = 0);
19 DT_INT, 112
20 DT_INT64, 113//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
21 DT_DOUBLE, 114
22 DT_STRING, // 0-terminated string 115#if IVSIZE >= 8
23 DT_DATA, // string + length 116 typedef IV val64;
24 DT_OBJECT, 117 typedef IV uval64;
25 DT_MAP, 118# define newSVval64 newSViv
26 DT_PLAYER, 119# define SvVAL64 SvIV
27 DT_ARCH, 120# define newSVuval64 newSVuv
28 DT_PARTY, 121# define SvUVAL64 SvUV
29 DT_REGION, 122#else
30 DT_AV, // av that needs to be flattened out 123 typedef double val64;
31}; 124 typedef double uval64;
125# define newSVval64 newSVnv
126# define SvVAL64 SvNV
127# define newSVuval64 newSVnv
128# define SvUVAL64 SvNV
129#endif
130
131extern tstamp runtime; // virtual server time, excluding time jumps and lag
132extern tstamp NOW; // real time of current server tick
32 133
33enum event_klass 134enum event_klass
34{ 135{
136 KLASS_NONE,
35 KLASS_GLOBAL, 137 KLASS_GLOBAL,
138 KLASS_ATTACHABLE,
139 KLASS_CLIENT,
36 KLASS_PLAYER, 140 KLASS_PLAYER,
37 KLASS_OBJECT, 141 KLASS_OBJECT,
38 KLASS_MAP, 142 KLASS_MAP,
143 KLASS_COMMAND,
39}; 144};
40 145
41enum event_type 146enum event_type
42{ 147{
43# define def(klass,name) EVENT_ ## klass ## _ ## name, 148# define def(klass,name) EVENT_ ## klass ## _ ## name,
44# include "eventinc.h" 149# include "eventinc.h"
45# undef def 150# undef def
46 NUM_EVENT_TYPES 151 NUM_EVENT_TYPES
47}; 152};
48 153
154// in which global events or per-type events are we interested
155extern bitset<NUM_EVENT_TYPES> ev_want_event;
156extern bitset<NUM_TYPES> ev_want_type;
157
158#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
49#define ARG_INT(v) DT_INT , static_cast<int> (v) 159#define ARG_INT(v) DT_INT , static_cast<int> (v)
50#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v) 160#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
51#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v) 161#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
52#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v) 162#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
53#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), (l) 163#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
54#define ARG_OBJECT(o) DT_OBJECT, (void *)static_cast<struct object *> (o) 164#define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o))
55#define ARG_MAP(o) DT_MAP , (void *)static_cast<struct mapstruct *> (o) 165#define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o))
56#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<struct pl *> (o) 166#define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (o))
57#define ARG_ARCH(o) DT_ARCH , (void *)static_cast<struct archetype *> (o) 167#define ARG_ARCH(o) DT_ARCH , (void *)(static_cast<archetype *> (o))
168#define ARG_CLIENT(o) DT_CLIENT, (void *)(static_cast<client *> (o))
58#define ARG_PARTY(o) DT_PARTY , (void *)static_cast<struct party *> (o) 169#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o))
59#define ARG_REGION(o) DT_REGION, (void *)static_cast<struct region *> (o) 170#define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o))
60 171
61// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension 172// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
62 173#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
63// all these return true when the normal event processing should be skipped (if any) 174#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
64#define INVOKE(klass, event, ...) cfperl_invoke (EVENT_ ## klass ## _ ## event, ## __VA_ARGS__, DT_END) 175#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__)
65 176#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__)
66#define INVOKE_GLOBAL(event, ...) INVOKE (GLOBAL, event, ## __VA_ARGS__) 177#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
67#define INVOKE_OBJECT(event, op, ...) INVOKE (OBJECT, event, ARG_OBJECT (op), ## __VA_ARGS__) 178#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__)
68#define INVOKE_PLAYER(event, pl, ...) INVOKE (PLAYER, event, ARG_PLAYER (pl), ## __VA_ARGS__) 179#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
69#define INVOKE_MAP(event, map, ...) INVOKE (MAP , event, ARG_MAP (map) , ## __VA_ARGS__)
70 180
71//TODO should index into @result 181//TODO should index into @result
72#define RESULT(idx,type) cfperl_result_ ## type (idx) 182#define RESULT(idx,type) cfperl_result_ ## type (idx)
183#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
73#define RESULT_INT(idx) RESULT(idx, INT) 184#define RESULT_INT(idx) RESULT(idx, INT)
74 185
75bool cfperl_invoke (event_type event, ...); 186double cfperl_result_DOUBLE (int idx);
76int cfperl_result_INT (int idx); 187int cfperl_result_INT (int idx);
77 188
78struct extendable_base 189//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
79{
80 void *self, *cb; // CF+ perl self and callback
81 const char *attach; // generic extension attachment information
82 190
83 void clear (); // called when free'ing objects 191INTERFACE_CLASS (attachable)
84 void optimise (); // possibly save some memory by destroying unneeded data 192struct attachable : refcnt_base
85 void reattach (data_type type, void *self); // called after swapin
86};
87
88// objects extendable from perl (or any other extension) should include or
89// derive using the curiously recurring template pattern, to avoid
90// virtual method calls etc.
91template<class subclass>
92struct extendable : extendable_base
93{ 193{
94 void reattach () 194 static MGVTBL vtbl;
95 { 195
96 if (attach) 196 enum {
97 extendable_base::reattach ( 197 F_DESTROYED = 0x01,
98 static_cast<subclass *>(this)->get_dt (), 198 F_DEBUG_TRACE = 0x02,
99 static_cast<subclass *>(this)
100 );
101 } 199 };
102}; 200 uint8 ACC (RW, attachable_flags);
103 201
104struct object_freezer 202 static unordered_vector<attachable *> mortals;
105{ 203 MTH static void check_mortals ();
106 const char *filename;
107 void *av;
108 204
109 object_freezer (const char *filename) : filename (filename) { } 205 // object is delete'd after the refcount reaches 0
110 void put (extendable_base *object); 206 MTH int refcnt_cnt () const;
111 void finish (); 207 // check wether the object has died and destroy
112}; 208 MTH void refcnt_chk () { if (expect_false (refcnt <= 0)) do_check (); }
113 209
114struct object_thawer 210 // destroy the object unless it was already destroyed
115{ 211 // this politely asks everybody interested the reduce
116 void *av; 212 // the refcount to 0 as soon as possible.
213 MTH void destroy ();
117 214
118 object_thawer (const char *filename); 215 // return wether an object was destroyed already
119 void get (extendable_base *object); 216 MTH bool destroyed () const { return attachable_flags & F_DESTROYED; }
120 void finish ();
121};
122 217
218 // destruct and free the memory for this object
219 virtual void do_delete ();
220
221 virtual void gather_callbacks (AV *&callbacks, event_type event) const;
222
223#if 0
224private:
225 static refcounted *rc_first;
226 refcounted *rc_next;
123#endif 227#endif
124 228
229 HV *self; // CF+ perl self
230 AV *cb; // CF+ callbacks
231 shstr attach; // generic extension attachment information
232
233 void sever_self (); // sever this object from its self, if it has one.
234 void optimise (); // possibly save some memory by destroying unneeded data
235
236 attachable ()
237 : attachable_flags (0), self (0), cb (0), attach (0)
238 {
239 }
240
241 attachable (const attachable &src)
242 : attachable_flags (0), self (0), cb (0), attach (src.attach)
243 {
244 }
245
246 // set a custom key to the given value, or delete it if value = 0
247 void set_key (const_utf8_string key, const_utf8_string value = 0, bool is_utf8 = 0);
248
249 void set_key_text (const_utf8_string key, const_utf8_string value = 0)
250 {
251 set_key (key, value, 1);
252 }
253
254 void set_key_data (const_utf8_string key, const_utf8_string value = 0)
255 {
256 set_key (key, value, 0);
257 }
258
259 attachable &operator =(const attachable &src);
260
261 // used to _quickly_ decide wether to shortcut the evaluation
262 bool should_invoke (event_type event)
263 {
264 return ev_want_event [event] || cb;
265 }
266
267 bool invoke (event_type event, ...);
268
269 MTH void instantiate ();
270 void reattach ();
271
272protected:
273 // do the real refcount checking work
274 void do_check ();
275
276 // the method that does the real destroy work
277 virtual void do_destroy ();
278
279 // destructor is protected, should not be called by anybody
280 virtual ~attachable ();
281};
282
283// the global object is a pseudo object that cares for the global events
284struct global : attachable
285{
286 void gather_callbacks (AV *&callbacks, event_type event) const;
287};
288
289extern struct global gbl_ev;
290
291//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
292
293#include "freezethaw.h"
294
295//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
296
297struct coroapi {
298 static struct CoroAPI *GCoroAPI;
299
300 static EV_ATOMIC_T cede_pending;
301
302 static int nready () { return CORO_NREADY; }
303 static int cede () { cede_pending = 0; return CORO_CEDE ; }
304
305 static void do_cede_to_tick ();
306
307 // actually cede's far more often
308 static bool cede_to_tick ()
309 {
310 if (expect_true (!cede_pending))
311 return false;
312
313 do_cede_to_tick ();
314 return true;
315 }
316
317 static void wait_for_tick ();
318 static void wait_for_tick_begin ();
319};
320
321struct evapi
322{
323 static struct EVAPI *GEVAPI;
324};
325
326struct iow : ev_io, evapi, callback<void (iow &, int)>
327{
328 static void thunk (EV_P_ struct ev_io *w_, int revents)
329 {
330 iow &w = *static_cast<iow *>(w_);
331
332 w (w, revents);
333 }
334
335 template<class O, class M>
336 iow (O object, M method)
337 : callback<void (iow &, int)> (object, method)
338 {
339 ev_init ((ev_io *)this, thunk);
340 }
341
342 void prio (int prio)
343 {
344 ev_set_priority ((ev_io *)this, prio);
345 }
346
347 void set (int fd, int events)
348 {
349 ev_io_set ((ev_io *)this, fd, events);
350 }
351
352 int poll () const { return events; }
353
354 void poll (int events);
355
356 void start ()
357 {
358 ev_io_start (EV_DEFAULT, (ev_io *)this);
359 }
360
361 void stop ()
362 {
363 ev_io_stop (EV_DEFAULT, (ev_io *)this);
364 }
365
366 ~iow ()
367 {
368 stop ();
369 }
370};
371
372struct asyncw : ev_async, evapi, callback<void (ev_async &, int)>
373{
374 static void thunk (EV_P_ struct ev_async *w_, int revents)
375 {
376 asyncw &w = *static_cast<asyncw *>(w_);
377
378 w (w, revents);
379 }
380
381 template<class O, class M>
382 asyncw (O object, M method)
383 : callback<void (asyncw &, int)> (object, method)
384 {
385 ev_init ((ev_async *)this, thunk);
386 }
387
388 void start ()
389 {
390 ev_async_start (EV_DEFAULT, (ev_async *)this);
391 }
392
393 void stop ()
394 {
395 ev_async_stop (EV_DEFAULT, (ev_async *)this);
396 }
397
398 ~asyncw ()
399 {
400 stop ();
401 }
402};
403
404#endif
405

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines