ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/cfperl.h
Revision: 1.65
Committed: Thu May 24 03:33:29 2007 UTC (17 years ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.64: +1 -0 lines
Log Message:
add books from books.pod via some most dire hacks

File Contents

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