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.11 by root, Mon Aug 28 07:07:41 2006 UTC vs.
Revision 1.43 by root, Sat Dec 30 15:07:59 2006 UTC

… …
2// cfperl.h perl interface 2// cfperl.h perl interface
3// 3//
4#ifndef CFPERL_H__ 4#ifndef CFPERL_H__
5#define CFPERL_H__ 5#define CFPERL_H__
6 6
7struct pl; 7#include <cstdio>
8struct object; 8
9struct mapstruct; 9using namespace std;
10
11#include <EXTERN.h>
12#include <perl.h>
13#include <XSUB.h>
14
15#include <EventAPI.h>
16#include <CoroAPI.h>
17
18#include "util.h"
19#include "keyword.h"
20#include "dynbuf.h"
21#include "callback.h"
22
23//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
24
25// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
26#undef localtime
27#undef srand48
28#undef drand48
29#undef srandom
30#undef readdir
31#undef getprotobyname
32#undef gethostbyname
33#undef ctime
34#undef strerror
35
36// same here, massive symbol spamming
37#undef do_open
38#undef do_close
39#undef ref
40
41// perl bug #40256: perl does overwrite those with reentrant versions
42// but does not initialise their state structures.
43#undef random
44#undef crypt
45
46//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
47
48// some macros to simplify perl in-calls
49
50#define CHECK_ERROR \
51 if (SvTRUE (ERRSV)) \
52 LOG (llevError, "runtime error in %s: %s\n", __func__, SvPVutf8_nolen (ERRSV));
53
54#define CALL_BEGIN(args) dSP; ENTER; SAVETMPS; PUSHMARK (SP); EXTEND (SP, args)
55#define CALL_ARG_SV(sv) PUSHs (sv_2mortal (sv)) // separate because no refcount inc
56#define CALL_ARG(expr) PUSHs (sv_2mortal (to_sv (expr)))
57#define CALL_CALL(name, flags) PUTBACK; int count = call_pv (name, (flags) | G_EVAL); SPAGAIN;
58#define CALL_END CHECK_ERROR; FREETMPS; LEAVE
59
60//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
10 61
11void cfperl_init (); 62void cfperl_init ();
12void cfperl_main (); 63void cfperl_main ();
13 64
14// could have used templates, but a more traditional C api 65//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
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 66
32 NUM_DATA_TYPES 67// virtual server time, excluding time jumps and lag
33}; 68extern double runtime;
34 69
35enum event_klass 70enum event_klass
36{ 71{
37 KLASS_NONE, 72 KLASS_NONE,
38 KLASS_GLOBAL, 73 KLASS_GLOBAL,
74 KLASS_ATTACHABLE,
75 KLASS_CLIENT,
39 KLASS_PLAYER, 76 KLASS_PLAYER,
40 KLASS_OBJECT, 77 KLASS_OBJECT,
41 KLASS_MAP, 78 KLASS_MAP,
79 KLASS_COMMAND,
42}; 80};
43 81
44enum event_type 82enum event_type
45{ 83{
46# define def(klass,name) EVENT_ ## klass ## _ ## name, 84# define def(klass,name) EVENT_ ## klass ## _ ## name,
47# include "eventinc.h" 85# include "eventinc.h"
48# undef def 86# undef def
49 NUM_EVENT_TYPES 87 NUM_EVENT_TYPES
50}; 88};
51 89
52#define ARG_AV(o) DT_AV , static_cast<AV *> (o) 90#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
53#define ARG_INT(v) DT_INT , static_cast<int> (v) 91#define ARG_INT(v) DT_INT , static_cast<int> (v)
54#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v) 92#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
55#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v) 93#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
56#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v) 94#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) 95#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) 96#define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o))
59#define ARG_MAP(o) DT_MAP , (void *)static_cast<struct mapstruct *> (o) 97#define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o))
60#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<struct pl *> (o) 98#define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (o))
61#define ARG_ARCH(o) DT_ARCH , (void *)static_cast<struct archetype *> (o) 99#define ARG_ARCH(o) DT_ARCH , (void *)(static_cast<archetype *> (o))
100#define ARG_CLIENT(o) DT_CLIENT, (void *)(static_cast<client *> (o))
62#define ARG_PARTY(o) DT_PARTY , (void *)static_cast<struct party *> (o) 101#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o))
63#define ARG_REGION(o) DT_REGION, (void *)static_cast<struct region *> (o) 102#define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o))
64 103
65// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension 104// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
66 105
67// all these return true when the normal event processing should be skipped (if any) 106// 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__) 107#define INVOKE_GLOBAL(event, ...) gbl_ev.invoke (EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__, DT_END)
72#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__) 108#define INVOKE_ATTACHABLE(event, obj, ...) (obj)->invoke (EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__, DT_END)
73#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__) 109#define INVOKE_OBJECT(event, obj, ...) (obj)->invoke (EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__, DT_END)
74#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__) 110#define INVOKE_CLIENT(event, obj, ...) (obj)->invoke (EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__, DT_END)
111#define INVOKE_PLAYER(event, obj, ...) (obj)->invoke (EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__, DT_END)
112#define INVOKE_MAP(event, obj, ...) (obj)->invoke (EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__, DT_END)
75 113
76//TODO should index into @result 114//TODO should index into @result
77#define RESULT(idx,type) cfperl_result_ ## type (idx) 115#define RESULT(idx,type) cfperl_result_ ## type (idx)
116#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
78#define RESULT_INT(idx) RESULT(idx, INT) 117#define RESULT_INT(idx) RESULT(idx, INT)
79 118
80bool cfperl_invoke (event_type event, ...); 119double cfperl_result_DOUBLE (int idx);
81int cfperl_result_INT (int idx); 120int cfperl_result_INT (int idx);
82 121
122//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
123
83struct attachable_base 124struct attachable
84{ 125{
85 void *self, *cb; // CF+ perl self and callback 126 static MGVTBL vtbl;
127
128 static unordered_vector<attachable *> mortals;
129 static void check_mortals ();
130
131 enum {
132 F_DESTROYED = 0x01,
133 F_BORROWED = 0x02,
134 };
135
136 // object is delete'd after the refcount reaches 0
137 mutable int refcnt;
138 int flags;
139
140 void refcnt_inc () const { ++refcnt; }
141 void refcnt_dec () const { --refcnt; }
142
143 // check wether the object has died and destroy
144 void refcnt_chk () { if (refcnt <= 0) do_check (); }
145
146 // destroy the object unless it was already destroyed
147 // this politely asks everybody interested the reduce
148 // the refcount to 0 as soon as possible.
149 void destroy ();
150
151 // return wether an object was destroyed already
152 bool destroyed () const { return flags & F_DESTROYED; }
153
154 virtual void gather_callbacks (AV *&callbacks, event_type event) const;
155
156#if 0
157private:
158 static refcounted *rc_first;
159 refcounted *rc_next;
160#endif
161
162 HV *self; // CF+ perl self
163 AV *cb; // CF+ callbacks
86 const char *attach; // generic extension attachment information 164 shstr attach; // generic extension attachment information
87 165
88 void clear (); // called when free'ing objects
89 void optimise (); // possibly save some memory by destroying unneeded data 166 void optimise (); // possibly save some memory by destroying unneeded data
90 167
91 void attachable_init () 168 attachable ()
169 : flags (0), refcnt (0), self (0), cb (0), attach (0)
92 { 170 {
93 self = cb = 0;
94 attach = 0;
95 } 171 }
96};
97 172
98// objects attachable from perl (or any other extension) should include or 173 attachable (const attachable &src)
99// derive using the curiously recurring template pattern, to avoid 174 : flags (0), refcnt (0), self (0), cb (0), attach (src.attach)
100// virtual method calls etc.
101template<class subclass>
102struct attachable : attachable_base
103{
104 static data_type get_dt ()
105 { 175 {
106 subclass::get_dt ();
107 } 176 }
108};
109 177
178 virtual ~attachable ();
179
180 attachable &operator =(const attachable &src);
181
182 bool invoke (event_type event, ...);
183 void instantiate ();
184 void reattach ();
185
186protected:
187 // do the real refcount checking work
188 void do_check ();
189
190 // the method that does the real destroy work
191 virtual void do_destroy ();
192};
193
194// the global object is a pseudo object that cares for the global events
195struct global : attachable
196{
197 void gather_callbacks (AV *&callbacks, event_type event) const;
198};
199
200extern struct global gbl_ev;
201
202//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
203
110struct object_freezer 204struct object_freezer : dynbuf
111{ 205{
112 const char *filename; 206 AV *av;
113 void *av;
114 207
115 object_freezer (const char *filename); 208 object_freezer ();
116 ~object_freezer (); 209 ~object_freezer ();
117 210
118 void put (FILE *fp, attachable_base *ext); 211 void put (attachable *ext);
119 212
120 template<class subclass> 213 // used only for user-defined key-value pairs
121 void put (FILE *fp, attachable<subclass> *obj) 214 void put (const shstr &k, const shstr &v)
122 { 215 {
123 put (fp, (attachable_base *)obj); 216 add (k);
124 }
125 217
126 void finish (); 218 if (v)
219 add (' '), add (v);
220
221 add ('\n');
222 }
223
224 //TODO//temporary, used only for saving body locations
225 void put (const char *k, int v)
226 {
227 add (k);
228 add (' ');
229 add (sint32 (v));
230 add ('\n');
231 }
232
233 template<typename T>
234 void put_string (keyword k, const T &v)
235 {
236 int klen = keyword_len [k];
237 int vlen = v ? strlen (v) + 1 : 0;
238
239 char *p = (char *)alloc (klen + vlen + 1);
240
241 memcpy (p, keyword_str [k], klen); p += klen;
242
243 if (v)
244 {
245 *p++ = ' '; vlen--;
246 memcpy (p, v, vlen); p += vlen;
247 }
248
249 *p = '\n';
250 }
251
252 void put (keyword k, const char *v)
253 {
254 put_string (k, v);
255 }
256
257 void put (keyword k, const shstr &v)
258 {
259 put_string (k, v);
260 }
261
262 void put (keyword k, double v)
263 {
264 char buf [128];
265
266 snprintf (buf, 128, "%.7g", v);
267
268 put (k, (const char *)buf);
269 }
270
271 void put_(keyword k, sint64 v)
272 {
273 add (keyword_str [k], keyword_len [k]);
274 add (' ');
275 add (v);
276 add ('\n');
277 }
278
279 void put_(keyword k, sint32 v)
280 {
281 add (keyword_str [k], keyword_len [k]);
282 add (' ');
283 add (v);
284 add ('\n');
285 }
286
287 void put (keyword kbeg, keyword kend, const shstr &v)
288 {
289 add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
290
291 if (v)
292 {
293 add (v);
294 add ('\n');
295 }
296
297 add (keyword_str [kend], keyword_len [kend]); add ('\n');
298 }
299
300 void put (keyword k, float v) { put (k, (double)v); }
301 void put (keyword k, signed char v) { put_(k, (sint32)v); }
302 void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
303 void put (keyword k, signed short v) { put_(k, (sint32)v); }
304 void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
305 void put (keyword k, signed int v) { put_(k, (sint32)v); }
306 void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
307 void put (keyword k, signed long v) { put_(k, (sint64)v); }
308 void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
309 void put (keyword k, signed long long v) { put_(k, (sint64)v); }
310 void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
311
312 template<typename T>
313 void put (keyword k, const T *v)
314 {
315 if (v)
316 put (k, v->name);
317 else
318 put (k, (const char *)0);
319 }
320
321 template<typename T>
322 void put (keyword k, const refptr<T> &v)
323 {
324 put (k, (T *)v);
325 }
326
327 bool save (const char *filename);
328 char *as_string (); // like strdup
329
330 operator bool () { return !!av; }
127}; 331};
332
333// compatibility support, should be removed when no longer needed
334int fprintf (object_freezer &freezer, const char *format, ...);
335int fputs (const char *s, object_freezer &freezer);
128 336
129struct object_thawer 337struct object_thawer
130{ 338{
131 void *av; 339 SV *text; // text part
340 AV *av; // perl part
341 char *line; // current beginning of line
342 char *last_keyword, *last_value;
343
344 operator bool () { return !!text; }
132 345
133 object_thawer (const char *filename = 0); 346 object_thawer (const char *filename = 0);
347 object_thawer (const char *data, AV *perlav);
134 ~object_thawer (); 348 ~object_thawer ();
135 349
136 void get (data_type type, void *obj, attachable_base *ext, int oid);
137
138 template<class subclass>
139 void get (attachable<subclass> *obj, int oid) 350 void get (attachable *obj, int oid);
140 {
141 if (av)
142 get (subclass::get_dt (), (subclass *)obj, obj, oid);
143 }
144 351
145 void finish (); 352 keyword get_kv (); // also parse value for later use
353 void skip_kv (keyword kw);
354
355 const char *get_str () { return last_value; } // may be 0
356
357 void get (shstr &sh) const;
358 void get_ornull (shstr &sh) const { sh = last_value; }
359 void get_ml (keyword kend, shstr &sh);
360
361 sint32 get_sint32 () const;
362 sint64 get_sint64 () const;
363 double get_double () const;
364
365 void get (float &v) { v = get_double (); }
366 void get (double &v) { v = get_double (); }
367
368 void get (bool &i) { i = get_sint32 (); }
369 void get (sint8 &i) { i = get_sint32 (); }
370 void get (uint8 &i) { i = get_sint32 (); }
371 void get (sint16 &i) { i = get_sint32 (); }
372 void get (uint16 &i) { i = get_sint32 (); }
373 void get (sint32 &i) { i = get_sint32 (); }
374
375 void get (uint32 &i) { i = get_sint64 (); }
376 void get (sint64 &i) { i = get_sint64 (); }
377};
378
379char *fgets (char *s, int n, object_thawer &thawer);
380
381//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
382
383struct coroapi {
384 static struct CoroAPI *GCoroAPI;
385
386 static int nready () { return CORO_NREADY; }
387 static int cede () { return CORO_CEDE ; }
388};
389
390struct watcher_base
391{
392 static struct EventAPI *GEventAPI;
393};
394
395template<class base>
396struct watcher : watcher_base
397{
398 base *pe;
399
400 void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); }
401 void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); }
402 void now () { GEventAPI->now ((pe_watcher *)pe); }
403 void suspend () { GEventAPI->suspend ((pe_watcher *)pe); }
404 void resume () { GEventAPI->resume ((pe_watcher *)pe); }
405
406 void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; }
407
408 ~watcher ()
409 {
410 cancel ();
411 }
412
413private:
414 void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private
415};
416
417struct iw : watcher<pe_idle>, callback<void (iw &)>
418{
419 template<class O, class M>
420 iw (O object, M method)
421 : callback<void (iw &)> (object, method)
422 {
423 alloc ();
424 }
425
426private:
427 void alloc ();
428};
429
430struct iow : watcher<pe_io>, callback<void (iow &, int)>
431{
432 template<class O, class M>
433 iow (O object, M method)
434 : callback<void (iow &, int)> (object, method)
435 {
436 alloc ();
437 }
438
439 void fd (int fd);
440 int poll ();
441 void poll (int events);
442
443private:
444 void alloc ();
146}; 445};
147 446
148#endif 447#endif
149 448

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines