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.65 by root, Thu May 24 03:33:29 2007 UTC vs.
Revision 1.88 by root, Thu Aug 30 07:28:25 2007 UTC

1/*
2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6 * Copyright (©) 1992,2007 Frank Tore Johansen
7 *
8 * Crossfire TRT is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 *
21 * The authors can be reached via e-mail to <crossfire@schmorp.de>
22 */
23
1// 24//
2// cfperl.h perl interface 25// cfperl.h perl interface
3// 26//
4#ifndef CFPERL_H__ 27#ifndef CFPERL_H__
5#define CFPERL_H__ 28#define CFPERL_H__
32#undef readdir 55#undef readdir
33#undef getprotobyname 56#undef getprotobyname
34#undef gethostbyname 57#undef gethostbyname
35#undef ctime 58#undef ctime
36#undef strerror 59#undef strerror
60#undef _
37 61
38// same here, massive symbol spamming 62// same here, massive symbol spamming
39#undef do_open 63#undef do_open
40#undef do_close 64#undef do_close
41#undef ref 65#undef ref
46#undef random 70#undef random
47#undef crypt 71#undef crypt
48 72
49////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// 73//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
50 74
75#define _(msg) (msg)
76#define N_(msg) (msg)
77
78//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
79
51// some macros to simplify perl in-calls 80// some macros to simplify perl in-calls
52 81
53#define CHECK_ERROR \ 82#define CHECK_ERROR \
54 if (SvTRUE (ERRSV)) \ 83 if (SvTRUE (ERRSV)) \
55 LOG (llevError, "runtime error in %s: %s\n", __func__, SvPVutf8_nolen (ERRSV)); 84 LOG (llevError, "runtime error in %s: %s\n", __func__, SvPVutf8_nolen (ERRSV));
65void cfperl_init (); 94void cfperl_init ();
66void cfperl_main (); 95void cfperl_main ();
67void cfperl_emergency_save (); 96void cfperl_emergency_save ();
68void cfperl_cleanup (int make_core); 97void cfperl_cleanup (int make_core);
69void cfperl_make_book (object *book, int level); 98void cfperl_make_book (object *book, int level);
99void cfperl_send_msg (client *ns, int color, const char *type, const char *msg);
100int cfperl_can_merge (object *ob1, object *ob2);
70 101
71////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// 102//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
72 103
73// virtual server time, excluding time jumps and lag 104extern tstamp runtime; // virtual server time, excluding time jumps and lag
74extern double runtime; 105extern tstamp NOW; // real time of current server tick
75 106
76enum event_klass 107enum event_klass
77{ 108{
78 KLASS_NONE, 109 KLASS_NONE,
79 KLASS_GLOBAL, 110 KLASS_GLOBAL,
110#define ARG_CLIENT(o) DT_CLIENT, (void *)(static_cast<client *> (o)) 141#define ARG_CLIENT(o) DT_CLIENT, (void *)(static_cast<client *> (o))
111#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o)) 142#define ARG_PARTY(o) DT_PARTY , (void *)(static_cast<party *> (o))
112#define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o)) 143#define ARG_REGION(o) DT_REGION, (void *)(static_cast<region *> (o))
113 144
114// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension 145// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
115 146#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
116// all these return true when the normal event processing should be skipped (if any)
117#define INVOKE_GLOBAL(event, ...) gbl_ev.invoke (EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__, DT_END) 147#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
118#define INVOKE_ATTACHABLE(event, obj, ...) (obj)->invoke (EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__, DT_END) 148#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__)
119#define INVOKE_OBJECT(event, obj, ...) (obj)->invoke (EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__, DT_END) 149#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__)
120#define INVOKE_CLIENT(event, obj, ...) (obj)->invoke (EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__, DT_END) 150#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
121#define INVOKE_PLAYER(event, obj, ...) (obj)->invoke (EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__, DT_END) 151#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__)
122#define INVOKE_MAP(event, obj, ...) (obj)->invoke (EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__, DT_END) 152#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
123 153
124//TODO should index into @result 154//TODO should index into @result
125#define RESULT(idx,type) cfperl_result_ ## type (idx) 155#define RESULT(idx,type) cfperl_result_ ## type (idx)
126#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE) 156#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
127#define RESULT_INT(idx) RESULT(idx, INT) 157#define RESULT_INT(idx) RESULT(idx, INT)
130int cfperl_result_INT (int idx); 160int cfperl_result_INT (int idx);
131 161
132////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// 162//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
133 163
134INTERFACE_CLASS (attachable) 164INTERFACE_CLASS (attachable)
135struct attachable 165struct attachable : refcnt_base
136{ 166{
137 static MGVTBL vtbl; 167 static MGVTBL vtbl;
138 168
139 static unordered_vector<attachable *> mortals; 169 static unordered_vector<attachable *> mortals;
140 MTH static void check_mortals (); 170 MTH static void check_mortals ();
141 171
142 enum { 172 enum {
143 F_DESTROYED = 0x01, 173 F_DESTROYED = 0x01,
144 F_DEBUG_TRACE = 0x02, 174 F_DEBUG_TRACE = 0x02,
145 }; 175 };
176 int ACC (RW, flags);
146 177
147 // object is delete'd after the refcount reaches 0 178 // object is delete'd after the refcount reaches 0
148 int ACC (RW, flags);
149 mutable int ACC (RW, refcnt);
150
151 MTH void refcnt_inc () const { ++refcnt; }
152 MTH void refcnt_dec () const { --refcnt; }
153
154 MTH int refcnt_cnt () const; 179 MTH int refcnt_cnt () const;
155 // check wether the object has died and destroy 180 // check wether the object has died and destroy
156 MTH void refcnt_chk () { if (refcnt <= 0) do_check (); } 181 MTH void refcnt_chk () { if (expect_false (refcnt <= 0)) do_check (); }
157 182
158 // destroy the object unless it was already destroyed 183 // destroy the object unless it was already destroyed
159 // this politely asks everybody interested the reduce 184 // this politely asks everybody interested the reduce
160 // the refcount to 0 as soon as possible. 185 // the refcount to 0 as soon as possible.
161 MTH void destroy (); 186 MTH void destroy ();
177 202
178 void sever_self (); // sever this object from its self, if it has one. 203 void sever_self (); // sever this object from its self, if it has one.
179 void optimise (); // possibly save some memory by destroying unneeded data 204 void optimise (); // possibly save some memory by destroying unneeded data
180 205
181 attachable () 206 attachable ()
182 : flags (0), refcnt (0), self (0), cb (0), attach (0) 207 : flags (0), self (0), cb (0), attach (0)
183 { 208 {
184 } 209 }
185 210
186 attachable (const attachable &src) 211 attachable (const attachable &src)
187 : flags (0), refcnt (0), self (0), cb (0), attach (src.attach) 212 : flags (0), self (0), cb (0), attach (src.attach)
188 { 213 {
189 } 214 }
190 215
191 virtual ~attachable (); 216 // set a custom key to the given value, or delete it if value = 0
217 void set_key (const char *key, const char *value = 0, bool is_utf8 = 0);
218
219 void set_key_text (const char *key, const char *value = 0)
220 {
221 set_key (key, value, 1);
222 }
223
224 void set_key_data (const char *key, const char *value = 0)
225 {
226 set_key (key, value, 0);
227 }
192 228
193 attachable &operator =(const attachable &src); 229 attachable &operator =(const attachable &src);
194 230
195 bool vinvoke (event_type event, va_list &ap); 231 // used to _quickly_ device wether to shortcut the evaluation
232 bool should_invoke (event_type event)
233 {
234 return ev_want_event [event] || cb;
235 }
236
196 bool invoke (event_type event, ...) 237 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 238
207 MTH void instantiate (); 239 MTH void instantiate ();
208 void reattach (); 240 void reattach ();
209 241
210protected: 242protected:
211 // do the real refcount checking work 243 // do the real refcount checking work
212 void do_check (); 244 void do_check ();
213 245
214 // the method that does the real destroy work 246 // the method that does the real destroy work
215 virtual void do_destroy (); 247 virtual void do_destroy ();
248
249 // destructor is protected, should not be called by anybody
250 virtual ~attachable ();
216}; 251};
217 252
218// the global object is a pseudo object that cares for the global events 253// the global object is a pseudo object that cares for the global events
219struct global : attachable 254struct global : attachable
220{ 255{
237 // used only for user-defined key-value pairs 272 // used only for user-defined key-value pairs
238 void put (const shstr &k, const shstr &v) 273 void put (const shstr &k, const shstr &v)
239 { 274 {
240 add (k); 275 add (k);
241 276
242 if (v) 277 if (expect_true (v))
243 add (' '), add (v); 278 add (' '), add (v);
244 279
245 add ('\n'); 280 add ('\n');
246 } 281 }
247 282
248 //TODO//temporary, used only for saving body locations
249 void put (const char *k, int v)
250 {
251 add (k);
252 add (' ');
253 add (sint32 (v));
254 add ('\n');
255 }
256
257 template<typename T> 283 template<typename T>
258 void put_string (keyword k, const T &v) 284 void put_kw_string (keyword k, const T &v)
259 { 285 {
260 int klen = keyword_len [k]; 286 int klen = keyword_len [k];
261 int vlen = v ? strlen (v) + 1 : 0; 287 int vlen = v ? strlen (v) + 1 : 0;
262 288
263 char *p = (char *)alloc (klen + vlen + 1); 289 char *p = (char *)alloc (klen + vlen + 1);
264 290
265 memcpy (p, keyword_str [k], klen); p += klen; 291 memcpy (p, keyword_str [k], klen); p += klen;
266 292
267 if (v) 293 if (expect_true (v))
268 { 294 {
269 *p++ = ' '; vlen--; 295 *p++ = ' '; vlen--;
270 memcpy (p, v, vlen); p += vlen; 296 memcpy (p, v, vlen); p += vlen;
271 } 297 }
272 298
273 *p = '\n'; 299 *p = '\n';
274 } 300 }
275 301
276 void put (keyword k, const char *v = 0) 302 void put (keyword k, const char *v = 0)
277 { 303 {
278 put_string (k, v); 304 put_kw_string (k, v);
279 } 305 }
280 306
281 void put (keyword k, const shstr &v) 307 void put (keyword k, const shstr &v)
282 { 308 {
283 put_string (k, v); 309 put_kw_string (k, v);
284 } 310 }
285 311
286 void put (keyword k, double v) 312 void put (keyword k, double v)
287 { 313 {
288 char buf [128]; 314 force (MAX_KEYWORD_LEN + 2 + 32);
289 315 fadd (keyword_str [k], keyword_len [k]);
290 snprintf (buf, 128, "%.7g", v); 316 fadd (' ');
291 317 falloc (sprintf (ptr, "%.7g", v));
292 put (k, (const char *)buf); 318 fadd ('\n');
293 } 319 }
294 320
295 void put_(keyword k, sint64 v) 321 void put_(keyword k, sint64 v)
296 { 322 {
323 force (MAX_KEYWORD_LEN + 2 + sint64_digits);
297 add (keyword_str [k], keyword_len [k]); 324 fadd (keyword_str [k], keyword_len [k]);
298 add (' '); 325 fadd (' ');
299 add (v); 326 add (v);
300 add ('\n'); 327 fadd ('\n');
301 } 328 }
302 329
303 void put_(keyword k, sint32 v) 330 void put_(keyword k, sint32 v)
304 { 331 {
332 force (MAX_KEYWORD_LEN + 2 + sint32_digits);
305 add (keyword_str [k], keyword_len [k]); 333 fadd (keyword_str [k], keyword_len [k]);
306 add (' '); 334 fadd (' ');
307 add (v); 335 add (v);
308 add ('\n'); 336 fadd ('\n');
309 }
310
311 void put (keyword kbeg, keyword kend, const shstr &v)
312 {
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 } 337 }
323 338
324 void put (keyword k, float v) { put (k, (double)v); } 339 void put (keyword k, float v) { put (k, (double)v); }
325 void put (keyword k, signed char v) { put_(k, (sint32)v); } 340 void put (keyword k, signed char v) { put_(k, (sint32)v); }
326 void put (keyword k, unsigned char v) { put_(k, (sint32)v); } 341 void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
331 void put (keyword k, signed long v) { put_(k, (sint64)v); } 346 void put (keyword k, signed long v) { put_(k, (sint64)v); }
332 void put (keyword k, unsigned long v) { put_(k, (sint64)v); } 347 void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
333 void put (keyword k, signed long long v) { put_(k, (sint64)v); } 348 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); } 349 void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
335 350
336 template<typename T> 351 void put (keyword kbeg, keyword kend, const shstr &v)
352 {
353 force (MAX_KEYWORD_LEN + 1);
354 fadd (keyword_str [kbeg], keyword_len [kbeg]); fadd ('\n');
355
356 if (expect_true (v))
357 {
358 add (v);
359 add ('\n');
360 }
361
362 force (MAX_KEYWORD_LEN + 1);
363 fadd (keyword_str [kend], keyword_len [kend]); fadd ('\n');
364 }
365
366 void put (keyword k, archetype *v);
367 void put (keyword k, treasurelist *v);
337 void put (keyword k, const T *v) 368 void put (keyword k, faceinfo *v);
338 {
339 if (v)
340 put (k, v->name);
341 else
342 put (k, (const char *)0);
343 }
344 369
345 template<typename T> 370 template<typename T>
346 void put (keyword k, const refptr<T> &v) 371 void put (keyword k, const refptr<T> &v)
347 { 372 {
348 put (k, (T *)v); 373 put (k, (T *)v);
352 char *as_string (); // like strdup 377 char *as_string (); // like strdup
353 378
354 operator bool () { return !!av; } 379 operator bool () { return !!av; }
355}; 380};
356 381
357// compatibility support, should be removed when no longer needed
358void fprintf (object_freezer &freezer, const char *format, ...);
359void fputs (const char *s, object_freezer &freezer);
360
361struct object_thawer 382struct object_thawer
362{ 383{
384 char *line; // current beginning of line
363 SV *text; // text part 385 SV *text; // text part
364 AV *av; // perl part 386 AV *av; // perl part
365 int linenum; 387 int linenum;
366 char *line; // current beginning of line
367 keyword kw; 388 keyword kw;
368 char *kw_str, *value; 389 char *kw_str; // the keyword parsed, as string
390 char *value; // the value, or 0 if no value
391 char *value_nn; // the value, or the empty string if no value
369 const char *name; 392 const char *name;
370 393
371 operator bool () { return !!text; } 394 operator bool () { return !!text; }
372 395
373 object_thawer (const char *path = 0); 396 object_thawer (const char *path = 0);
377 void get (attachable *obj, int oid); 400 void get (attachable *obj, int oid);
378 401
379 // parse next line 402 // parse next line
380 void next (); 403 void next ();
381 // skip the current key-value (usually fetch next line, for 404 // skip the current key-value (usually fetch next line, for
382 // multiline-fields, skips untilt he corresponding end-kw 405 // multiline-fields, skips till the corresponding end-kw
383 void skip (); 406 void skip ();
384 407
385 //TODO: remove, deprecated
386 keyword get_kv ()
387 {
388 next ();
389 return kw;
390 }
391
392 char *get_str () { return value; } // may be 0 408 char *get_str () { return value; } // may be 0
409 void get_ml (keyword kend, shstr &sh);
393 410
394 void get (shstr &sh) const;
395 void get_ornull (shstr &sh) const { sh = value; } 411 void get_ornull (shstr &sh) const { sh = value; }
396 void get_ml (keyword kend, shstr &sh); 412 void get (shstr &sh) const { sh = value; } // might want to check for non-null here
397 413
414 bool get_bool () const { return *value_nn == '1'; }
398 sint32 get_sint32 () const; 415 sint32 get_sint32 () const;
399 sint64 get_sint64 () const; 416 sint64 get_sint64 () const { return strtoll (value_nn, 0, 10); }
400 double get_double () const; 417 double get_double () const { return strtod (value_nn, 0); }
401 418
402 void get (float &v) { v = get_double (); } 419 void get (float &v) { v = get_double (); }
403 void get (double &v) { v = get_double (); } 420 void get (double &v) { v = get_double (); }
404 421
405 void get (bool &i) { i = get_sint32 (); } 422 void get (bool &i) { i = get_bool (); }
406 void get (sint8 &i) { i = get_sint32 (); } 423 void get (sint8 &i) { i = get_sint32 (); }
407 void get (uint8 &i) { i = get_sint32 (); } 424 void get (uint8 &i) { i = get_sint32 (); }
408 void get (sint16 &i) { i = get_sint32 (); } 425 void get (sint16 &i) { i = get_sint32 (); }
409 void get (uint16 &i) { i = get_sint32 (); } 426 void get (uint16 &i) { i = get_sint32 (); }
410 void get (sint32 &i) { i = get_sint32 (); } 427 void get (sint32 &i) { i = get_sint32 (); }
411 428
412 void get (uint32 &i) { i = get_sint64 (); } 429 void get (uint32 &i) { i = get_sint64 (); }
413 void get (sint64 &i) { i = get_sint64 (); } 430 void get (sint64 &i) { i = get_sint64 (); }
414 431
432 void parse_warn (const char *msg);
415 bool parse_error (const char *type = 0, const char *name = 0, bool skip = true); 433 bool parse_error (const char *type = 0, const char *name = 0, bool skip = true);
416}; 434};
417 435
418//TODO: remove 436//TODO: remove
419char *fgets (char *s, int n, object_thawer &thawer); 437char *fgets (char *s, int n, object_thawer &thawer);
424 static struct CoroAPI *GCoroAPI; 442 static struct CoroAPI *GCoroAPI;
425 443
426 static int nready () { return CORO_NREADY; } 444 static int nready () { return CORO_NREADY; }
427 static int cede () { return CORO_CEDE ; } 445 static int cede () { return CORO_CEDE ; }
428 446
429 static double (*time)();
430 static double next_cede; 447 static tstamp next_cede;
431 static int cede_counter; 448 static int cede_counter;
432 449
433 static void do_cede_every (); 450 static void do_cede_every ();
434 static void do_cede_to_tick (); 451 static void do_cede_to_tick ();
435 static void do_cede_to_tick_every (); 452 static void do_cede_to_tick_every ();
436 453
437 static void cede_every (int count) 454 static void cede_every (int count)
438 { 455 {
439 if (++cede_counter >= count) 456 if (expect_false (++cede_counter >= count))
440 do_cede_every (); 457 do_cede_every ();
441 } 458 }
442 459
443 static void cede_to_tick () 460 static bool cede_to_tick ()
444 { 461 {
445 if (time () >= next_cede) 462 if (expect_true (now () < next_cede))
463 return false;
464
446 do_cede_to_tick (); 465 do_cede_to_tick ();
466 return true;
447 } 467 }
448 468
449 static void cede_to_tick_every (int count) 469 static bool cede_to_tick_every (int count)
450 { 470 {
451 if (++cede_counter >= count) 471 if (expect_true (++cede_counter < count))
472 return false;
473
452 cede_to_tick (); 474 return cede_to_tick ();
453 } 475 }
454 476
455 static void wait_for_tick (); 477 static void wait_for_tick ();
456 static void wait_for_tick_begin (); 478 static void wait_for_tick_begin ();
457}; 479};

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines