[ViewVC] Diff of: cvs/deliantra/server/include/cfperl.h

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.11 by root, Mon Aug 28 07:07:41 2006 UTC vs.
Revision 1.67 by root, Sun May 27 23:14:37 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	struct pl;	7	#include <cstdarg>
8	struct object;	8	#include <cstdio>
9	struct mapstruct;	9	#include <bitset>
		10
		11	using namespace std;
		12
		13	#include <EXTERN.h>
		14	#include <perl.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	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		26
		27	// 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	// same here, massive symbol spamming
		39	#undef do_open
		40	#undef do_close
		41	#undef ref
		42	#undef seed
		43
		44	// 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	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		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	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
10		64
11	void cfperl_init ();	65	void cfperl_init ();
12	void cfperl_main ();	66	void cfperl_main ();
		67	void cfperl_emergency_save ();
		68	void cfperl_cleanup (int make_core);
		69	void cfperl_make_book (object *book, int level);
13		70
14	// could have used templates, but a more traditional C api	71	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
15	// uses more explicit typing which is ok for this purpose.
16	enum data_type
17	{
18	DT_END, // no further arguments
19	DT_AV, // perl-only av that needs to be flattened out
20	DT_INT,
21	DT_INT64,
22	DT_DOUBLE,
23	DT_STRING, // 0-terminated string
24	DT_DATA, // string + length
25	DT_OBJECT,
26	DT_MAP,
27	DT_PLAYER,
28	DT_ARCH,
29	DT_PARTY,
30	DT_REGION,
31		72
32	NUM_DATA_TYPES	73	// virtual server time, excluding time jumps and lag
33	};	74	extern double runtime;
34		75
35	enum event_klass	76	enum event_klass
36	{	77	{
37	KLASS_NONE,	78	KLASS_NONE,
38	KLASS_GLOBAL,	79	KLASS_GLOBAL,
		80	KLASS_ATTACHABLE,
		81	KLASS_CLIENT,
39	KLASS_PLAYER,	82	KLASS_PLAYER,
40	KLASS_OBJECT,	83	KLASS_OBJECT,
41	KLASS_MAP,	84	KLASS_MAP,
		85	KLASS_COMMAND,
42	};	86	};
43		87
44	enum event_type	88	enum event_type
45	{	89	{
46	# define def(klass,name) EVENT_ ## klass ## _ ## name,	90	# define def(klass,name) EVENT_ ## klass ## _ ## name,
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
		97	extern bitset<NUM_EVENT_TYPES> ev_want_event;
		98	extern 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), (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<struct object > (o)	106	#define ARG_OBJECT(o) DT_OBJECT, (void )(static_cast<object > (o))
59	#define ARG_MAP(o) DT_MAP , (void )static_cast<struct mapstruct > (o)	107	#define ARG_MAP(o) DT_MAP , (void )(static_cast<maptile > (o))
60	#define ARG_PLAYER(o) DT_PLAYER, (void )static_cast<struct pl > (o)	108	#define ARG_PLAYER(o) DT_PLAYER, (void )(static_cast<player > (o))
61	#define ARG_ARCH(o) DT_ARCH , (void )static_cast<struct 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<struct party > (o)	111	#define ARG_PARTY(o) DT_PARTY , (void )(static_cast<party > (o))
63	#define ARG_REGION(o) DT_REGION, (void )static_cast<struct 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)
		125	#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
78	#define RESULT_INT(idx) RESULT(idx, INT)	126	#define RESULT_INT(idx) RESULT(idx, INT)
79		127
80	bool cfperl_invoke (event_type event, ...);	128	double cfperl_result_DOUBLE (int idx);
81	int cfperl_result_INT (int idx);	129	int cfperl_result_INT (int idx);
82		130
		131	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		132
		133	INTERFACE_CLASS (attachable)
83	struct attachable_base	134	struct attachable
84	{	135	{
85	void self, cb; // CF+ perl self and callback	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
		168	private:
		169	static refcounted *rc_first;
		170	refcounted *rc_next;
		171	#endif
		172
		173	HV *self; // CF+ perl self
		174	AV *cb; // CF+ callbacks
86	const char *attach; // generic extension attachment information	175	shstr attach; // generic extension attachment information
87		176
88	void clear (); // called when free'ing objects	177	void sever_self (); // sever this object from its self, if it has one.
89	void optimise (); // possibly save some memory by destroying unneeded data	178	void optimise (); // possibly save some memory by destroying unneeded data
90		179
91	void attachable_init ()	180	attachable ()
		181	: flags (0), refcnt (0), self (0), cb (0), attach (0)
92	{	182	{
93	self = cb = 0;
94	attach = 0;
95	}	183	}
96	};
97		184
98	// objects attachable from perl (or any other extension) should include or	185	attachable (const attachable &src)
99	// derive using the curiously recurring template pattern, to avoid	186	: flags (0), refcnt (0), self (0), cb (0), attach (src.attach)
100	// virtual method calls etc.
101	template<class subclass>
102	struct attachable : attachable_base
103	{
104	static data_type get_dt ()
105	{	187	{
106	subclass::get_dt ();
107	}	188	}
108	};
109		189
		190	virtual ~attachable ();
		191
		192	attachable &operator =(const attachable &src);
		193
		194	// used to _quickly_ device wether to shortcut the evaluation
		195	bool should_invoke (event_type event)
		196	{
		197	return ev_want_event [event] \|\| cb;
		198	}
		199
		200	bool invoke (event_type event, ...);
		201
		202	MTH void instantiate ();
		203	void reattach ();
		204
		205	protected:
		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
		214	struct global : attachable
		215	{
		216	void gather_callbacks (AV *&callbacks, event_type event) const;
		217	};
		218
		219	extern struct global gbl_ev;
		220
		221	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		222
110	struct object_freezer	223	struct object_freezer : dynbuf_text
111	{	224	{
112	const char *filename;	225	AV *av;
113	void *av;
114		226
115	object_freezer (const char *filename);	227	object_freezer ();
116	~object_freezer ();	228	~object_freezer ();
117		229
118	void put (FILE fp, attachable_base ext);	230	void put (attachable *ext);
119		231
120	template<class subclass>	232	// used only for user-defined key-value pairs
121	void put (FILE fp, attachable<subclass> obj)	233	void put (const shstr &k, const shstr &v)
122	{	234	{
123	put (fp, (attachable_base *)obj);	235	add (k);
124	}
125		236
126	void finish ();	237	if (expect_true (v))
		238	add (' '), add (v);
		239
		240	add ('\n');
		241	}
		242
		243	//TODO//temporary, used only for saving body locations
		244	void put (const char *k, int v)
		245	{
		246	add (k);
		247	add (' ');
		248	add (sint32 (v));
		249	add ('\n');
		250	}
		251
		252	template<typename T>
		253	void put_string (keyword k, const T &v)
		254	{
		255	int klen = keyword_len [k];
		256	int vlen = v ? strlen (v) + 1 : 0;
		257
		258	char p = (char )alloc (klen + vlen + 1);
		259
		260	memcpy (p, keyword_str [k], klen); p += klen;
		261
		262	if (expect_true (v))
		263	{
		264	*p++ = ' '; vlen--;
		265	memcpy (p, v, vlen); p += vlen;
		266	}
		267
		268	*p = '\n';
		269	}
		270
		271	void put (keyword k, const char *v = 0)
		272	{
		273	put_string (k, v);
		274	}
		275
		276	void put (keyword k, const shstr &v)
		277	{
		278	put_string (k, v);
		279	}
		280
		281	void put (keyword k, double v)
		282	{
		283	char buf [128];
		284
		285	snprintf (buf, 128, "%.7g", v);
		286
		287	put (k, (const char *)buf);
		288	}
		289
		290	void put_(keyword k, sint64 v)
		291	{
		292	add (keyword_str [k], keyword_len [k]);
		293	add (' ');
		294	add (v);
		295	add ('\n');
		296	}
		297
		298	void put_(keyword k, sint32 v)
		299	{
		300	add (keyword_str [k], keyword_len [k]);
		301	add (' ');
		302	add (v);
		303	add ('\n');
		304	}
		305
		306	void put (keyword kbeg, keyword kend, const shstr &v)
		307	{
		308	add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
		309
		310	if (expect_true (v))
		311	{
		312	add (v);
		313	add ('\n');
		314	}
		315
		316	add (keyword_str [kend], keyword_len [kend]); add ('\n');
		317	}
		318
		319	void put (keyword k, float v) { put (k, (double)v); }
		320	void put (keyword k, signed char v) { put_(k, (sint32)v); }
		321	void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
		322	void put (keyword k, signed short v) { put_(k, (sint32)v); }
		323	void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
		324	void put (keyword k, signed int v) { put_(k, (sint32)v); }
		325	void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
		326	void put (keyword k, signed long v) { put_(k, (sint64)v); }
		327	void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
		328	void put (keyword k, signed long long v) { put_(k, (sint64)v); }
		329	void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
		330
		331	template<typename T>
		332	void put (keyword k, const T *v)
		333	{
		334	if (expect_true (v))
		335	put (k, v->name);
		336	else
		337	put (k, (const char *)0);
		338	}
		339
		340	template<typename T>
		341	void put (keyword k, const refptr<T> &v)
		342	{
		343	put (k, (T *)v);
		344	}
		345
		346	bool save (const char *path);
		347	char *as_string (); // like strdup
		348
		349	operator bool () { return !!av; }
127	};	350	};
128		351
129	struct object_thawer	352	struct object_thawer
130	{	353	{
131	void *av;	354	char *line; // current beginning of line
		355	SV *text; // text part
		356	AV *av; // perl part
		357	int linenum;
		358	keyword kw;
		359	char *kw_str; // the keyword parsed, as string
		360	char *value; // the value, or 0 if no value
		361	char *value_nn; // the value, or the empty string if no value
		362	const char *name;
132		363
		364	operator bool () { return !!text; }
		365
133	object_thawer (const char *filename = 0);	366	object_thawer (const char *path = 0);
		367	object_thawer (const char data, AV perlav);
134	~object_thawer ();	368	~object_thawer ();
135		369
136	void get (data_type type, void obj, attachable_base ext, int oid);
137
138	template<class subclass>
139	void get (attachable<subclass> *obj, int oid)	370	void get (attachable *obj, int oid);
140	{
141	if (av)
142	get (subclass::get_dt (), (subclass *)obj, obj, oid);
143	}
144		371
		372	// parse next line
145	void finish ();	373	void next ();
		374	// skip the current key-value (usually fetch next line, for
		375	// multiline-fields, skips untilt he corresponding end-kw
		376	void skip ();
		377
		378	//TODO: remove, deprecated
		379	keyword get_kv ()
		380	{
		381	next ();
		382	return kw;
		383	}
		384
		385	char *get_str () { return value; } // may be 0
		386	void get_ml (keyword kend, shstr &sh);
		387
		388	void get_ornull (shstr &sh) const { sh = value; }
		389	void get (shstr &sh) const { sh = value; } // might want to check for non-null here
		390
		391	bool get_bool () const { return *value_nn == '1'; }
		392	sint32 get_sint32 () const;
		393	sint64 get_sint64 () const { return atoll (value_nn); }
		394	double get_double () const { return atof (value_nn); }
		395
		396	void get (float &v) { v = get_double (); }
		397	void get (double &v) { v = get_double (); }
		398
		399	void get (bool &i) { i = get_bool (); }
		400	void get (sint8 &i) { i = get_sint32 (); }
		401	void get (uint8 &i) { i = get_sint32 (); }
		402	void get (sint16 &i) { i = get_sint32 (); }
		403	void get (uint16 &i) { i = get_sint32 (); }
		404	void get (sint32 &i) { i = get_sint32 (); }
		405
		406	void get (uint32 &i) { i = get_sint64 (); }
		407	void get (sint64 &i) { i = get_sint64 (); }
		408
		409	bool parse_error (const char type = 0, const char name = 0, bool skip = true);
		410	};
		411
		412	//TODO: remove
		413	char fgets (char s, int n, object_thawer &thawer);
		414
		415	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		416
		417	struct coroapi {
		418	static struct CoroAPI *GCoroAPI;
		419
		420	static int nready () { return CORO_NREADY; }
		421	static int cede () { return CORO_CEDE ; }
		422
		423	static double (*time)();
		424	static double next_cede;
		425	static int cede_counter;
		426
		427	static void do_cede_every ();
		428	static void do_cede_to_tick ();
		429	static void do_cede_to_tick_every ();
		430
		431	static void cede_every (int count)
		432	{
		433	if (expect_false (++cede_counter >= count))
		434	do_cede_every ();
		435	}
		436
		437	static void cede_to_tick ()
		438	{
		439	if (expect_false (time () >= next_cede))
		440	do_cede_to_tick ();
		441	}
		442
		443	static void cede_to_tick_every (int count)
		444	{
		445	if (expect_false (++cede_counter >= count))
		446	cede_to_tick ();
		447	}
		448
		449	static void wait_for_tick ();
		450	static void wait_for_tick_begin ();
		451	};
		452
		453	struct watcher_base
		454	{
		455	static struct EventAPI *GEventAPI;
		456	};
		457
		458	template<class base>
		459	struct watcher : watcher_base
		460	{
		461	base *pe;
		462
		463	void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); }
		464	void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); }
		465	void now () { GEventAPI->now ((pe_watcher *)pe); }
		466	void suspend () { GEventAPI->suspend ((pe_watcher *)pe); }
		467	void resume () { GEventAPI->resume ((pe_watcher *)pe); }
		468
		469	void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; }
		470
		471	~watcher ()
		472	{
		473	cancel ();
		474	}
		475
		476	private:
		477	void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private
		478	};
		479
		480	struct iw : watcher<pe_idle>, callback<void (iw &)>
		481	{
		482	template<class O, class M>
		483	iw (O object, M method)
		484	: callback<void (iw &)> (object, method)
		485	{
		486	alloc ();
		487	}
		488
		489	private:
		490	void alloc ();
		491	};
		492
		493	struct iow : watcher<pe_io>, callback<void (iow &, int)>
		494	{
		495	template<class O, class M>
		496	iow (O object, M method)
		497	: callback<void (iow &, int)> (object, method)
		498	{
		499	alloc ();
		500	}
		501
		502	void fd (int fd);
		503	int poll ();
		504	void poll (int events);
		505
		506	private:
		507	void alloc ();
146	};	508	};
147		509
148	#endif	510	#endif
149		511

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing deliantra/server/include/cfperl.h (file contents): Revision 1.11 by root, Mon Aug 28 07:07:41 2006 UTC vs. Revision 1.67 by root, Sun May 27 23:14:37 2007 UTC

Diff Legend

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.11 by root, Mon Aug 28 07:07:41 2006 UTC vs.
Revision 1.67 by root, Sun May 27 23:14:37 2007 UTC