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.44 by root, Sun Dec 31 10:28:36 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;
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 125struct attachable
85// derive using the curiously recurring template pattern, to avoid
86// virtual method calls etc.
87template<class subclass>
88struct extendable : extendable_base
89{ 126{
90 void clear () 127 static MGVTBL vtbl;
91 { 128
92 if (self || cb) 129 static unordered_vector<attachable *> mortals;
93 extendable_base::clear (); 130 static void check_mortals ();
131
132 enum {
133 F_DESTROYED = 0x01,
134 F_BORROWED = 0x02,
94 } 135 };
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 136
122bool cfperl_invoke (event_type event, ...); 137 // object is delete'd after the refcount reaches 0
123void cfperl_free_ob (struct object *op); 138 mutable int refcnt;
139 int flags;
124 140
125void cfperl_init (); 141 void refcnt_inc () const { ++refcnt; }
126void cfperl_main (); 142 void refcnt_dec () const { --refcnt; }
127 143
144 // check wether the object has died and destroy
145 void refcnt_chk () { if (refcnt <= 0) do_check (); }
146
147 // destroy the object unless it was already destroyed
148 // this politely asks everybody interested the reduce
149 // the refcount to 0 as soon as possible.
150 void destroy ();
151
152 // return wether an object was destroyed already
153 bool destroyed () const { return flags & F_DESTROYED; }
154
155 virtual void gather_callbacks (AV *&callbacks, event_type event) const;
156
157#if 0
158private:
159 static refcounted *rc_first;
160 refcounted *rc_next;
128#endif 161#endif
129 162
163 HV *self; // CF+ perl self
164 AV *cb; // CF+ callbacks
165 shstr attach; // generic extension attachment information
166
167 void optimise (); // possibly save some memory by destroying unneeded data
168
169 attachable ()
170 : flags (0), refcnt (0), self (0), cb (0), attach (0)
171 {
172 }
173
174 attachable (const attachable &src)
175 : flags (0), refcnt (0), self (0), cb (0), attach (src.attach)
176 {
177 }
178
179 virtual ~attachable ();
180
181 attachable &operator =(const attachable &src);
182
183 bool invoke (event_type event, ...);
184 void instantiate ();
185 void reattach ();
186
187protected:
188 // do the real refcount checking work
189 void do_check ();
190
191 // the method that does the real destroy work
192 virtual void do_destroy ();
193};
194
195// the global object is a pseudo object that cares for the global events
196struct global : attachable
197{
198 void gather_callbacks (AV *&callbacks, event_type event) const;
199};
200
201extern struct global gbl_ev;
202
203//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
204
205struct object_freezer : dynbuf
206{
207 AV *av;
208
209 object_freezer ();
210 ~object_freezer ();
211
212 void put (attachable *ext);
213
214 // used only for user-defined key-value pairs
215 void put (const shstr &k, const shstr &v)
216 {
217 add (k);
218
219 if (v)
220 add (' '), add (v);
221
222 add ('\n');
223 }
224
225 //TODO//temporary, used only for saving body locations
226 void put (const char *k, int v)
227 {
228 add (k);
229 add (' ');
230 add (sint32 (v));
231 add ('\n');
232 }
233
234 template<typename T>
235 void put_string (keyword k, const T &v)
236 {
237 int klen = keyword_len [k];
238 int vlen = v ? strlen (v) + 1 : 0;
239
240 char *p = (char *)alloc (klen + vlen + 1);
241
242 memcpy (p, keyword_str [k], klen); p += klen;
243
244 if (v)
245 {
246 *p++ = ' '; vlen--;
247 memcpy (p, v, vlen); p += vlen;
248 }
249
250 *p = '\n';
251 }
252
253 void put (keyword k, const char *v)
254 {
255 put_string (k, v);
256 }
257
258 void put (keyword k, const shstr &v)
259 {
260 put_string (k, v);
261 }
262
263 void put (keyword k, double v)
264 {
265 char buf [128];
266
267 snprintf (buf, 128, "%.7g", v);
268
269 put (k, (const char *)buf);
270 }
271
272 void put_(keyword k, sint64 v)
273 {
274 add (keyword_str [k], keyword_len [k]);
275 add (' ');
276 add (v);
277 add ('\n');
278 }
279
280 void put_(keyword k, sint32 v)
281 {
282 add (keyword_str [k], keyword_len [k]);
283 add (' ');
284 add (v);
285 add ('\n');
286 }
287
288 void put (keyword kbeg, keyword kend, const shstr &v)
289 {
290 add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
291
292 if (v)
293 {
294 add (v);
295 add ('\n');
296 }
297
298 add (keyword_str [kend], keyword_len [kend]); add ('\n');
299 }
300
301 void put (keyword k, float v) { put (k, (double)v); }
302 void put (keyword k, signed char v) { put_(k, (sint32)v); }
303 void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
304 void put (keyword k, signed short v) { put_(k, (sint32)v); }
305 void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
306 void put (keyword k, signed int v) { put_(k, (sint32)v); }
307 void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
308 void put (keyword k, signed long v) { put_(k, (sint64)v); }
309 void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
310 void put (keyword k, signed long long v) { put_(k, (sint64)v); }
311 void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
312
313 template<typename T>
314 void put (keyword k, const T *v)
315 {
316 if (v)
317 put (k, v->name);
318 else
319 put (k, (const char *)0);
320 }
321
322 template<typename T>
323 void put (keyword k, const refptr<T> &v)
324 {
325 put (k, (T *)v);
326 }
327
328 bool save (const char *filename);
329 char *as_string (); // like strdup
330
331 operator bool () { return !!av; }
332};
333
334// compatibility support, should be removed when no longer needed
335int fprintf (object_freezer &freezer, const char *format, ...);
336int fputs (const char *s, object_freezer &freezer);
337
338struct object_thawer
339{
340 SV *text; // text part
341 AV *av; // perl part
342 char *line; // current beginning of line
343 char *last_keyword, *last_value;
344
345 operator bool () { return !!text; }
346
347 object_thawer (const char *filename = 0);
348 object_thawer (const char *data, AV *perlav);
349 ~object_thawer ();
350
351 void get (attachable *obj, int oid);
352
353 keyword get_kv (); // also parse value for later use
354 void skip_kv (keyword kw);
355
356 const char *get_str () { return last_value; } // may be 0
357
358 void get (shstr &sh) const;
359 void get_ornull (shstr &sh) const { sh = last_value; }
360 void get_ml (keyword kend, shstr &sh);
361
362 sint32 get_sint32 () const;
363 sint64 get_sint64 () const;
364 double get_double () const;
365
366 void get (float &v) { v = get_double (); }
367 void get (double &v) { v = get_double (); }
368
369 void get (bool &i) { i = get_sint32 (); }
370 void get (sint8 &i) { i = get_sint32 (); }
371 void get (uint8 &i) { i = get_sint32 (); }
372 void get (sint16 &i) { i = get_sint32 (); }
373 void get (uint16 &i) { i = get_sint32 (); }
374 void get (sint32 &i) { i = get_sint32 (); }
375
376 void get (uint32 &i) { i = get_sint64 (); }
377 void get (sint64 &i) { i = get_sint64 (); }
378};
379
380char *fgets (char *s, int n, object_thawer &thawer);
381
382//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
383
384struct coroapi {
385 static struct CoroAPI *GCoroAPI;
386
387 static int nready () { return CORO_NREADY; }
388 static int cede () { return CORO_CEDE ; }
389};
390
391struct watcher_base
392{
393 static struct EventAPI *GEventAPI;
394};
395
396template<class base>
397struct watcher : watcher_base
398{
399 base *pe;
400
401 void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); }
402 void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); }
403 void now () { GEventAPI->now ((pe_watcher *)pe); }
404 void suspend () { GEventAPI->suspend ((pe_watcher *)pe); }
405 void resume () { GEventAPI->resume ((pe_watcher *)pe); }
406
407 void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; }
408
409 ~watcher ()
410 {
411 cancel ();
412 }
413
414private:
415 void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private
416};
417
418struct iw : watcher<pe_idle>, callback<void (iw &)>
419{
420 template<class O, class M>
421 iw (O object, M method)
422 : callback<void (iw &)> (object, method)
423 {
424 alloc ();
425 }
426
427private:
428 void alloc ();
429};
430
431struct iow : watcher<pe_io>, callback<void (iow &, int)>
432{
433 template<class O, class M>
434 iow (O object, M method)
435 : callback<void (iow &, int)> (object, method)
436 {
437 alloc ();
438 }
439
440 void fd (int fd);
441 int poll ();
442 void poll (int events);
443
444private:
445 void alloc ();
446};
447
448#endif
449

Diff Legend

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