ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/cfperl.h
Revision: 1.53
Committed: Thu Feb 1 19:15:39 2007 UTC (17 years, 3 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.52: +4 -0 lines
Log Message:
- improve error messages from object_thawer to incldue line numbers
- provide geenric parse error handler
- finish basic design of generic object loader
- implement generic regions loader
- use it to load regions:
  loader_region loader;
  if (!loader.load (filename))
    error;
- regions should now be the very first filetype that could be reloaded at runtime

File Contents

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