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.40 by root, Tue Dec 19 04:58:04 2006 UTC vs.
Revision 1.71 by root, Mon May 28 03:47:44 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>
14 16
15#include <EventAPI.h> 17#include <EventAPI.h>
18#include <CoroAPI.h>
16 19
20#include "util.h"
21#include "keyword.h"
22#include "dynbuf.h"
17#include "callback.h" 23#include "callback.h"
24
25//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
18 26
19// optimisations/workaround for functions requiring my_perl in scope (anti-bloat) 27// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
20#undef localtime 28#undef localtime
21#undef srand48 29#undef srand48
22#undef drand48 30#undef drand48
28#undef strerror 36#undef strerror
29 37
30// same here, massive symbol spamming 38// same here, massive symbol spamming
31#undef do_open 39#undef do_open
32#undef do_close 40#undef do_close
41#undef ref
42#undef seed
33 43
34// perl bug #40256: perl does overwrite those with reentrant versions 44// perl bug #40256: perl does overwrite those with reentrant versions
35// but does not initialise their state structures. 45// but does not initialise their state structures.
36#undef random 46#undef random
37#undef crypt 47#undef crypt
38 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
39void cfperl_init (); 65void cfperl_init ();
40void 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;
41 75
42enum event_klass 76enum event_klass
43{ 77{
44 KLASS_NONE, 78 KLASS_NONE,
45 KLASS_GLOBAL, 79 KLASS_GLOBAL,
80 KLASS_ATTACHABLE,
46 KLASS_CLIENT, 81 KLASS_CLIENT,
47 KLASS_PLAYER, 82 KLASS_PLAYER,
48 KLASS_OBJECT, 83 KLASS_OBJECT,
49 KLASS_MAP, 84 KLASS_MAP,
50 KLASS_COMMAND, 85 KLASS_COMMAND,
56# include "eventinc.h" 91# include "eventinc.h"
57# undef def 92# undef def
58 NUM_EVENT_TYPES 93 NUM_EVENT_TYPES
59}; 94};
60 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
61#define ARG_AV(o) DT_AV , static_cast<AV *> (o) 100#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
62#define ARG_INT(v) DT_INT , static_cast<int> (v) 101#define ARG_INT(v) DT_INT , static_cast<int> (v)
63#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v) 102#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
64#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v) 103#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
65#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v) 104#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
66#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)
67#define ARG_OBJECT(o) DT_OBJECT, (void *)static_cast<object *> (o) 106#define ARG_OBJECT(o) DT_OBJECT, (void *)(static_cast<object *> (o))
68#define ARG_MAP(o) DT_MAP , (void *)static_cast<maptile *> (o) 107#define ARG_MAP(o) DT_MAP , (void *)(static_cast<maptile *> (o))
69#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<player *> (o) 108#define ARG_PLAYER(o) DT_PLAYER, (void *)(static_cast<player *> (o))
70#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))
71#define ARG_PARTY(o) DT_PARTY , (void *)static_cast<party *> (o) 111#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o))
72#define ARG_REGION(o) DT_REGION, (void *)static_cast<region *> (o) 112#define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o))
73#define ARG_CLIENT(o) DT_CLIENT, (void *)static_cast<client *> (o)
74 113
75// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension 114// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
76 115#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
77// all these return true when the normal event processing should be skipped (if any)
78#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
79
80#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
81#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__)
82#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__)
83#define INVOKE_CLIENT(event, ns, ...) INVOKE_(EVENT_ ## CLIENT ## _ ## event, ARG_CLIENT (ns), ## __VA_ARGS__) 119#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
84#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__)
85#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__)
86 122
87//TODO should index into @result 123//TODO should index into @result
88#define RESULT(idx,type) cfperl_result_ ## type (idx) 124#define RESULT(idx,type) cfperl_result_ ## type (idx)
89#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE) 125#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
90#define RESULT_INT(idx) RESULT(idx, INT) 126#define RESULT_INT(idx) RESULT(idx, INT)
91 127
92bool cfperl_invoke (event_type event, ...);
93double cfperl_result_DOUBLE (int idx); 128double cfperl_result_DOUBLE (int idx);
94int cfperl_result_INT (int idx); 129int cfperl_result_INT (int idx);
95 130
131//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
132
133INTERFACE_CLASS (attachable)
96struct attachable_base 134struct attachable
97{ 135{
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
98 SV *self; // CF+ perl self 173 HV *self; // CF+ perl self
99 AV *cb; // CF+ callbacks 174 AV *cb; // CF+ callbacks
100 shstr attach; // generic extension attachment information 175 shstr attach; // generic extension attachment information
101 176
102 void clear (); // called when free'ing objects 177 void sever_self (); // sever this object from its self, if it has one.
103 void optimise (); // possibly save some memory by destroying unneeded data 178 void optimise (); // possibly save some memory by destroying unneeded data
104 void instantiate (data_type type, void *obj);
105 179
106 void attachable_clear ()
107 {
108 self = 0;
109 cb = 0;
110 attach = 0;
111 }
112
113 attachable_base () 180 attachable ()
181 : flags (0), refcnt (0), self (0), cb (0), attach (0)
114 { 182 {
115 attachable_clear ();
116 } 183 }
117 184
118 ~attachable_base ()
119 {
120 clear ();
121 }
122
123 attachable_base (const attachable_base &src) 185 attachable (const attachable &src)
124 : self (0), cb (0), attach (src.attach) 186 : flags (0), refcnt (0), self (0), cb (0), attach (src.attach)
125 { 187 {
126 } 188 }
127 189
190 virtual ~attachable ();
191
128 attachable_base &operator =(const attachable_base &src) 192 attachable &operator =(const attachable &src);
129 {
130 clear ();
131 attach = src.attach;
132 return *this;
133 }
134};
135 193
136// objects attachable from perl (or any other extension) should include or 194 // used to _quickly_ device wether to shortcut the evaluation
137// derive using the curiously recurring template pattern, to avoid 195 bool should_invoke (event_type event)
138// virtual method calls etc. 196 {
139template<class subclass> 197 return ev_want_event [event] || cb;
140struct attachable : attachable_base 198 }
141{ 199
200 bool invoke (event_type event, ...);
201
142 void instantiate () 202 MTH void instantiate ();
143 { 203 void reattach ();
144 if (attach)
145 attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
146 }
147};
148 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
149struct object_freezer : dynbuf 223struct object_freezer : dynbuf_text
150{ 224{
151 AV *av; 225 AV *av;
152 226
153 object_freezer (); 227 object_freezer ();
154 ~object_freezer (); 228 ~object_freezer ();
155 229
156 void put (attachable_base *ext); 230 void put (attachable *ext);
157
158 template<class subclass>
159 void put (attachable<subclass> *obj)
160 {
161 put ((attachable_base *)obj);
162 }
163 231
164 // used only for user-defined key-value pairs 232 // used only for user-defined key-value pairs
165 void put (const shstr &k, const shstr &v) 233 void put (const shstr &k, const shstr &v)
166 { 234 {
167 add (k); 235 add (k);
168 236
169 if (v) 237 if (expect_true (v))
170 add (' '), add (v); 238 add (' '), add (v);
171 239
172 add ('\n');
173 }
174
175 //TODO//temporary, used only for saving body locations
176 void put (const char *k, int v)
177 {
178 add (k);
179 add (' ');
180 add (sint32 (v));
181 add ('\n'); 240 add ('\n');
182 } 241 }
183 242
184 template<typename T> 243 template<typename T>
185 void put_string (keyword k, const T &v) 244 void put_string (keyword k, const T &v)
189 248
190 char *p = (char *)alloc (klen + vlen + 1); 249 char *p = (char *)alloc (klen + vlen + 1);
191 250
192 memcpy (p, keyword_str [k], klen); p += klen; 251 memcpy (p, keyword_str [k], klen); p += klen;
193 252
194 if (v) 253 if (expect_true (v))
195 { 254 {
196 *p++ = ' '; vlen--; 255 *p++ = ' '; vlen--;
197 memcpy (p, v, vlen); p += vlen; 256 memcpy (p, v, vlen); p += vlen;
198 } 257 }
199 258
200 *p = '\n'; 259 *p = '\n';
201 } 260 }
202 261
203 void put (keyword k, const char *v) 262 void put (keyword k, const char *v = 0)
204 { 263 {
205 put_string (k, v); 264 put_string (k, v);
206 } 265 }
207 266
208 void put (keyword k, const shstr &v) 267 void put (keyword k, const shstr &v)
210 put_string (k, v); 269 put_string (k, v);
211 } 270 }
212 271
213 void put (keyword k, double v) 272 void put (keyword k, double v)
214 { 273 {
215 char buf [128]; 274 force (MAX_KEYWORD_LEN + 2 + 32);
216 275 fadd (keyword_str [k], keyword_len [k]);
217 snprintf (buf, 128, "%.7g", v); 276 fadd (' ');
218 277 falloc (sprintf (ptr, "%.7g", v));
219 put (k, (const char *)buf); 278 fadd ('\n');
220 } 279 }
221 280
222 void put_(keyword k, sint64 v) 281 void put_(keyword k, sint64 v)
223 { 282 {
283 force (MAX_KEYWORD_LEN + 2 + sint64_digits);
224 add (keyword_str [k], keyword_len [k]); 284 fadd (keyword_str [k], keyword_len [k]);
225 add (' '); 285 fadd (' ');
226 add (v); 286 add (v);
227 add ('\n'); 287 fadd ('\n');
228 } 288 }
229 289
230 void put_(keyword k, sint32 v) 290 void put_(keyword k, sint32 v)
231 { 291 {
292 force (MAX_KEYWORD_LEN + 2 + sint32_digits);
232 add (keyword_str [k], keyword_len [k]); 293 fadd (keyword_str [k], keyword_len [k]);
233 add (' '); 294 fadd (' ');
234 add (v); 295 add (v);
235 add ('\n'); 296 fadd ('\n');
236 } 297 }
237 298
238 void put (keyword kbeg, keyword kend, const shstr &v) 299 void put (keyword kbeg, keyword kend, const shstr &v)
239 { 300 {
301 force (MAX_KEYWORD_LEN + 1);
240 add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n'); 302 fadd (keyword_str [kbeg], keyword_len [kbeg]); fadd ('\n');
241 303
242 if (v) 304 if (expect_true (v))
243 { 305 {
244 add (v); 306 add (v);
245 add ('\n'); 307 add ('\n');
246 } 308 }
247 309
310 force (MAX_KEYWORD_LEN + 1);
248 add (keyword_str [kend], keyword_len [kend]); add ('\n'); 311 fadd (keyword_str [kend], keyword_len [kend]); fadd ('\n');
249 } 312 }
250 313
251 void put (keyword k, float v) { put (k, (double)v); } 314 void put (keyword k, float v) { put (k, (double)v); }
252 void put (keyword k, signed char v) { put_(k, (sint32)v); } 315 void put (keyword k, signed char v) { put_(k, (sint32)v); }
253 void put (keyword k, unsigned char v) { put_(k, (sint32)v); } 316 void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
261 void put (keyword k, unsigned long long v) { put_(k, (sint64)v); } 324 void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
262 325
263 template<typename T> 326 template<typename T>
264 void put (keyword k, const T *v) 327 void put (keyword k, const T *v)
265 { 328 {
266 if (v) 329 if (expect_true (v))
267 put (k, v->name); 330 put (k, v->name);
268 else 331 else
269 put (k, (const char *)0); 332 put (k, (const char *)0);
270 } 333 }
271 334
273 void put (keyword k, const refptr<T> &v) 336 void put (keyword k, const refptr<T> &v)
274 { 337 {
275 put (k, (T *)v); 338 put (k, (T *)v);
276 } 339 }
277 340
278 bool save (const char *filename); 341 bool save (const char *path);
279 char *as_string (); // like strdup 342 char *as_string (); // like strdup
280 343
281 operator bool () { return !!av; } 344 operator bool () { return !!av; }
282}; 345};
283 346
284// compatibility support, should be removed when no longer needed
285int fprintf (object_freezer &freezer, const char *format, ...);
286int fputs (const char *s, object_freezer &freezer);
287
288struct object_thawer 347struct object_thawer
289{ 348{
349 char *line; // current beginning of line
290 SV *text; // text part 350 SV *text; // text part
291 AV *av; // perl part 351 AV *av; // perl part
292 char *line; // current beginning of line 352 int linenum;
293 char *last_value; 353 keyword kw;
354 char *kw_str; // the keyword parsed, as string
355 char *value; // the value, or 0 if no value
356 char *value_nn; // the value, or the empty string if no value
357 const char *name;
294 358
295 operator bool () { return !!text; } 359 operator bool () { return !!text; }
296 360
297 object_thawer (const char *filename = 0); 361 object_thawer (const char *path = 0);
298 object_thawer (const char *data, AV *perlav); 362 object_thawer (const char *data, AV *perlav);
299 ~object_thawer (); 363 ~object_thawer ();
300 364
301 void get (data_type type, void *obj, attachable_base *ext, int oid);
302
303 template<class subclass>
304 void get (attachable<subclass> *obj, int oid) 365 void get (attachable *obj, int oid);
305 {
306 if (av)
307 get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
308 }
309 366
310 keyword get_kv (); // also parse value for later use 367 // parse next line
368 void next ();
369 // skip the current key-value (usually fetch next line, for
370 // multiline-fields, skips untilt he corresponding end-kw
371 void skip ();
311 372
373 //TODO: remove, deprecated
374 keyword get_kv ()
375 {
376 next ();
377 return kw;
378 }
379
312 const char *get_str () { return last_value; } // may be 0 380 char *get_str () { return value; } // may be 0
313
314 void get (shstr &sh) const;
315 void get_ornull (shstr &sh) const { sh = last_value; }
316 void get_ml (keyword kend, shstr &sh); 381 void get_ml (keyword kend, shstr &sh);
317 382
383 void get_ornull (shstr &sh) const { sh = value; }
384 void get (shstr &sh) const { sh = value; } // might want to check for non-null here
385
386 bool get_bool () const { return *value_nn == '1'; }
318 sint32 get_sint32 () const; 387 sint32 get_sint32 () const;
319 sint64 get_sint64 () const; 388 sint64 get_sint64 () const { return strtoll (value_nn, 0, 10); }
320 double get_double () const; 389 double get_double () const { return strtod (value_nn, 0); }
321 390
322 void get (float &v) { v = get_double (); } 391 void get (float &v) { v = get_double (); }
323 void get (double &v) { v = get_double (); } 392 void get (double &v) { v = get_double (); }
324 393
394 void get (bool &i) { i = get_bool (); }
325 void get (sint8 &i) { i = get_sint32 (); } 395 void get (sint8 &i) { i = get_sint32 (); }
326 void get (uint8 &i) { i = get_sint32 (); } 396 void get (uint8 &i) { i = get_sint32 (); }
327 void get (sint16 &i) { i = get_sint32 (); } 397 void get (sint16 &i) { i = get_sint32 (); }
328 void get (uint16 &i) { i = get_sint32 (); } 398 void get (uint16 &i) { i = get_sint32 (); }
329 void get (sint32 &i) { i = get_sint32 (); } 399 void get (sint32 &i) { i = get_sint32 (); }
330 400
331 void get (uint32 &i) { i = get_sint64 (); } 401 void get (uint32 &i) { i = get_sint64 (); }
332 void get (sint64 &i) { i = get_sint64 (); } 402 void get (sint64 &i) { i = get_sint64 (); }
333};
334 403
404 bool parse_error (const char *type = 0, const char *name = 0, bool skip = true);
405};
406
407//TODO: remove
335char *fgets (char *s, int n, object_thawer &thawer); 408char *fgets (char *s, int n, object_thawer &thawer);
409
410//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
411
412struct coroapi {
413 static struct CoroAPI *GCoroAPI;
414
415 static int nready () { return CORO_NREADY; }
416 static int cede () { return CORO_CEDE ; }
417
418 static double (*time)();
419 static double next_cede;
420 static int cede_counter;
421
422 static void do_cede_every ();
423 static void do_cede_to_tick ();
424 static void do_cede_to_tick_every ();
425
426 static void cede_every (int count)
427 {
428 if (expect_false (++cede_counter >= count))
429 do_cede_every ();
430 }
431
432 static void cede_to_tick ()
433 {
434 if (expect_false (time () >= next_cede))
435 do_cede_to_tick ();
436 }
437
438 static void cede_to_tick_every (int count)
439 {
440 if (expect_false (++cede_counter >= count))
441 cede_to_tick ();
442 }
443
444 static void wait_for_tick ();
445 static void wait_for_tick_begin ();
446};
336 447
337struct watcher_base 448struct watcher_base
338{ 449{
339 static struct EventAPI *GEventAPI; 450 static struct EventAPI *GEventAPI;
340}; 451};

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines