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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines