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

Diff Legend

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