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

Diff Legend

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