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

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.15 by root, Wed Aug 30 11:02:15 2006 UTC vs.
Revision 1.49 by root, Mon Jan 8 01:19:03 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 <cstdio>
8	struct object;	8
9	struct mapstruct;	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	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
10		62
11	void cfperl_init ();	63	void cfperl_init ();
12	void cfperl_main ();	64	void cfperl_main ();
13		65
14	// could have used templates, but a more traditional C api	66	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
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		67
32	NUM_DATA_TYPES	68	// virtual server time, excluding time jumps and lag
33	};	69	extern double runtime;
34		70
35	enum event_klass	71	enum event_klass
36	{	72	{
37	KLASS_NONE,	73	KLASS_NONE,
38	KLASS_GLOBAL,	74	KLASS_GLOBAL,
		75	KLASS_ATTACHABLE,
		76	KLASS_CLIENT,
39	KLASS_PLAYER,	77	KLASS_PLAYER,
40	KLASS_OBJECT,	78	KLASS_OBJECT,
41	KLASS_MAP,	79	KLASS_MAP,
		80	KLASS_COMMAND,
42	};	81	};
43		82
44	enum event_type	83	enum event_type
45	{	84	{
46	# define def(klass,name) EVENT_ ## klass ## _ ## name,	85	# define def(klass,name) EVENT_ ## klass ## _ ## name,
47	# include "eventinc.h"	86	# include "eventinc.h"
48	# undef def	87	# undef def
49	NUM_EVENT_TYPES	88	NUM_EVENT_TYPES
50	};	89	};
51		90
52	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)	91	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
53	#define ARG_INT(v) DT_INT , static_cast<int> (v)	92	#define ARG_INT(v) DT_INT , static_cast<int> (v)
54	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)	93	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
55	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)	94	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
56	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)	95	#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)	96	#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)	97	#define ARG_OBJECT(o) DT_OBJECT, (void )(static_cast<object > (o))
59	#define ARG_MAP(o) DT_MAP , (void )static_cast<struct mapstruct > (o)	98	#define ARG_MAP(o) DT_MAP , (void )(static_cast<maptile > (o))
60	#define ARG_PLAYER(o) DT_PLAYER, (void )static_cast<struct pl > (o)	99	#define ARG_PLAYER(o) DT_PLAYER, (void )(static_cast<player > (o))
61	#define ARG_ARCH(o) DT_ARCH , (void )static_cast<struct archetype > (o)	100	#define ARG_ARCH(o) DT_ARCH , (void )(static_cast<archetype > (o))
		101	#define ARG_CLIENT(o) DT_CLIENT, (void )(static_cast<client > (o))
62	#define ARG_PARTY(o) DT_PARTY , (void )static_cast<struct party > (o)	102	#define ARG_PARTY(o) DT_PARTY , (void )(static_cast<party > (o))
63	#define ARG_REGION(o) DT_REGION, (void )static_cast<struct region > (o)	103	#define ARG_REGION(o) DT_REGION, (void )(static_cast<region > (o))
64		104
65	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension	105	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
66		106
67	// all these return true when the normal event processing should be skipped (if any)	107	// 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__)	108	#define INVOKE_GLOBAL(event, ...) gbl_ev.invoke (EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__, DT_END)
72	#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__)	109	#define INVOKE_ATTACHABLE(event, obj, ...) (obj)->invoke (EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__, DT_END)
73	#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__)	110	#define INVOKE_OBJECT(event, obj, ...) (obj)->invoke (EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__, DT_END)
74	#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__)	111	#define INVOKE_CLIENT(event, obj, ...) (obj)->invoke (EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__, DT_END)
		112	#define INVOKE_PLAYER(event, obj, ...) (obj)->invoke (EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__, DT_END)
		113	#define INVOKE_MAP(event, obj, ...) (obj)->invoke (EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__, DT_END)
75		114
76	//TODO should index into @result	115	//TODO should index into @result
77	#define RESULT(idx,type) cfperl_result_ ## type (idx)	116	#define RESULT(idx,type) cfperl_result_ ## type (idx)
		117	#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
78	#define RESULT_INT(idx) RESULT(idx, INT)	118	#define RESULT_INT(idx) RESULT(idx, INT)
79		119
80	bool cfperl_invoke (event_type event, ...);	120	double cfperl_result_DOUBLE (int idx);
81	int cfperl_result_INT (int idx);	121	int cfperl_result_INT (int idx);
82		122
		123	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		124
		125	INTERFACE_CLASS (attachable)
83	struct attachable_base	126	struct attachable
84	{	127	{
85	void self, cb; // CF+ perl self and callback	128	static MGVTBL vtbl;
		129
		130	static unordered_vector<attachable *> mortals;
		131	MTH static void check_mortals ();
		132
		133	enum {
		134	F_DESTROYED = 0x01,
		135	F_BORROWED = 0x02,
		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
86	const char *attach; // generic extension attachment information	167	shstr attach; // generic extension attachment information
87		168
88	void clear (); // called when free'ing objects
89	void optimise (); // possibly save some memory by destroying unneeded data	169	void optimise (); // possibly save some memory by destroying unneeded data
90	void instantiate (data_type type, void *obj);
91		170
92	void attachable_init ()	171	attachable ()
		172	: flags (0), refcnt (0), self (0), cb (0), attach (0)
93	{	173	{
94	self = cb = 0;
95	attach = 0;
96	}	174	}
97	};
98		175
99	// objects attachable from perl (or any other extension) should include or	176	attachable (const attachable &src)
100	// derive using the curiously recurring template pattern, to avoid	177	: flags (0), refcnt (0), self (0), cb (0), attach (src.attach)
101	// virtual method calls etc.
102	template<class subclass>
103	struct attachable : attachable_base
104	{
105	static data_type get_dt ()
106	{	178	{
107	return subclass::get_dt ();
108	}	179	}
109		180
		181	virtual ~attachable ();
		182
		183	attachable &operator =(const attachable &src);
		184
		185	bool invoke (event_type event, ...);
110	void instantiate ()	186	MTH void instantiate ();
111	{	187	void reattach ();
112	if (attach)
113	attachable_base::instantiate (get_dt (), static_cast<subclass *>(this));
114	}
115	};
116		188
117	struct object_freezethaw	189	protected:
118	{	190	// do the real refcount checking work
119	void *av;	191	void do_check ();
120	FILE *fp;
121	};
122		192
123	struct object_freezer : object_freezethaw	193	// the method that does the real destroy work
124	{	194	virtual void do_destroy ();
125	void *filename;	195	};
126		196
127	object_freezer (const char *filename);	197	// the global object is a pseudo object that cares for the global events
		198	struct global : attachable
		199	{
		200	void gather_callbacks (AV *&callbacks, event_type event) const;
		201	};
		202
		203	extern struct global gbl_ev;
		204
		205	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		206
		207	struct object_freezer : dynbuf
		208	{
		209	AV *av;
		210
		211	object_freezer ();
128	~object_freezer ();	212	~object_freezer ();
129		213
130	void put (attachable_base *ext);	214	void put (attachable *ext);
131		215
132	template<class subclass>	216	// used only for user-defined key-value pairs
133	void put (attachable<subclass> *obj)	217	void put (const shstr &k, const shstr &v)
134	{	218	{
135	put ((attachable_base *)obj);	219	add (k);
136	}
137		220
138	operator bool () { return !!fp; }
139	};
140
141	struct object_thawer : object_freezethaw
142	{
143	object_thawer (const char *filename = 0);
144	~object_thawer ();
145
146	void get (data_type type, void obj, attachable_base ext, int oid);
147
148	template<class subclass>
149	void get (attachable<subclass> *obj, int oid)
150	{
151	if (av)	221	if (v)
152	get (subclass::get_dt (), (subclass *)obj, obj, oid);	222	add (' '), add (v);
153	}
154		223
		224	add ('\n');
		225	}
		226
		227	//TODO//temporary, used only for saving body locations
		228	void put (const char *k, int v)
		229	{
		230	add (k);
		231	add (' ');
		232	add (sint32 (v));
		233	add ('\n');
		234	}
		235
		236	template<typename T>
		237	void put_string (keyword k, const T &v)
		238	{
		239	int klen = keyword_len [k];
		240	int vlen = v ? strlen (v) + 1 : 0;
		241
		242	char p = (char )alloc (klen + vlen + 1);
		243
		244	memcpy (p, keyword_str [k], klen); p += klen;
		245
		246	if (v)
		247	{
		248	*p++ = ' '; vlen--;
		249	memcpy (p, v, vlen); p += vlen;
		250	}
		251
		252	*p = '\n';
		253	}
		254
		255	void put (keyword k, const char *v = 0)
		256	{
		257	put_string (k, v);
		258	}
		259
		260	void put (keyword k, const shstr &v)
		261	{
		262	put_string (k, v);
		263	}
		264
		265	void put (keyword k, double v)
		266	{
		267	char buf [128];
		268
		269	snprintf (buf, 128, "%.7g", v);
		270
		271	put (k, (const char *)buf);
		272	}
		273
		274	void put_(keyword k, sint64 v)
		275	{
		276	add (keyword_str [k], keyword_len [k]);
		277	add (' ');
		278	add (v);
		279	add ('\n');
		280	}
		281
		282	void put_(keyword k, sint32 v)
		283	{
		284	add (keyword_str [k], keyword_len [k]);
		285	add (' ');
		286	add (v);
		287	add ('\n');
		288	}
		289
		290	void put (keyword kbeg, keyword kend, const shstr &v)
		291	{
		292	add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
		293
		294	if (v)
		295	{
		296	add (v);
		297	add ('\n');
		298	}
		299
		300	add (keyword_str [kend], keyword_len [kend]); add ('\n');
		301	}
		302
		303	void put (keyword k, float v) { put (k, (double)v); }
		304	void put (keyword k, signed char v) { put_(k, (sint32)v); }
		305	void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
		306	void put (keyword k, signed short v) { put_(k, (sint32)v); }
		307	void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
		308	void put (keyword k, signed int v) { put_(k, (sint32)v); }
		309	void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
		310	void put (keyword k, signed long v) { put_(k, (sint64)v); }
		311	void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
		312	void put (keyword k, signed long long v) { put_(k, (sint64)v); }
		313	void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
		314
		315	template<typename T>
		316	void put (keyword k, const T *v)
		317	{
		318	if (v)
		319	put (k, v->name);
		320	else
		321	put (k, (const char *)0);
		322	}
		323
		324	template<typename T>
		325	void put (keyword k, const refptr<T> &v)
		326	{
		327	put (k, (T *)v);
		328	}
		329
		330	bool save (const char *path);
		331	char *as_string (); // like strdup
		332
155	operator FILE *() { return fp; }	333	operator bool () { return !!av; }
156	};	334	};
157		335
		336	// compatibility support, should be removed when no longer needed
158	int fprintf (object_freezer &freezer, const char *format, ...);	337	int fprintf (object_freezer &freezer, const char *format, ...);
159	int fputs (const char *s, object_freezer &freezer);	338	int fputs (const char *s, object_freezer &freezer);
160		339
		340	struct object_thawer
		341	{
		342	SV *text; // text part
		343	AV *av; // perl part
		344	char *line; // current beginning of line
		345	char last_keyword, last_value;
		346	const char *name;
		347
		348	operator bool () { return !!text; }
		349
		350	object_thawer (const char *path = 0);
		351	object_thawer (const char data, AV perlav);
		352	~object_thawer ();
		353
		354	void get (attachable *obj, int oid);
		355
		356	keyword get_kv (); // also parse value for later use
		357	void skip_kv (keyword kw);
		358
		359	const char *get_str () { return last_value; } // may be 0
		360
		361	void get (shstr &sh) const;
		362	void get_ornull (shstr &sh) const { sh = last_value; }
		363	void get_ml (keyword kend, shstr &sh);
		364
		365	sint32 get_sint32 () const;
		366	sint64 get_sint64 () const;
		367	double get_double () const;
		368
		369	void get (float &v) { v = get_double (); }
		370	void get (double &v) { v = get_double (); }
		371
		372	void get (bool &i) { i = get_sint32 (); }
		373	void get (sint8 &i) { i = get_sint32 (); }
		374	void get (uint8 &i) { i = get_sint32 (); }
		375	void get (sint16 &i) { i = get_sint32 (); }
		376	void get (uint16 &i) { i = get_sint32 (); }
		377	void get (sint32 &i) { i = get_sint32 (); }
		378
		379	void get (uint32 &i) { i = get_sint64 (); }
		380	void get (sint64 &i) { i = get_sint64 (); }
		381	};
		382
		383	char fgets (char s, int n, object_thawer &thawer);
		384
		385	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		386
		387	struct coroapi {
		388	static struct CoroAPI *GCoroAPI;
		389
		390	static int nready () { return CORO_NREADY; }
		391	static int cede () { return CORO_CEDE ; }
		392
		393	static int cede_counter;
		394
		395	static void cede_every (int count)
		396	{
		397	if (++cede_counter >= count)
		398	{
		399	cede_counter = 0;
		400
		401	if (coroapi::nready ())
		402	coroapi::cede ();
		403	}
		404	}
		405	};
		406
		407	struct watcher_base
		408	{
		409	static struct EventAPI *GEventAPI;
		410	};
		411
		412	template<class base>
		413	struct watcher : watcher_base
		414	{
		415	base *pe;
		416
		417	void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); }
		418	void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); }
		419	void now () { GEventAPI->now ((pe_watcher *)pe); }
		420	void suspend () { GEventAPI->suspend ((pe_watcher *)pe); }
		421	void resume () { GEventAPI->resume ((pe_watcher *)pe); }
		422
		423	void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; }
		424
		425	~watcher ()
		426	{
		427	cancel ();
		428	}
		429
		430	private:
		431	void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private
		432	};
		433
		434	struct iw : watcher<pe_idle>, callback<void (iw &)>
		435	{
		436	template<class O, class M>
		437	iw (O object, M method)
		438	: callback<void (iw &)> (object, method)
		439	{
		440	alloc ();
		441	}
		442
		443	private:
		444	void alloc ();
		445	};
		446
		447	struct iow : watcher<pe_io>, callback<void (iow &, int)>
		448	{
		449	template<class O, class M>
		450	iow (O object, M method)
		451	: callback<void (iow &, int)> (object, method)
		452	{
		453	alloc ();
		454	}
		455
		456	void fd (int fd);
		457	int poll ();
		458	void poll (int events);
		459
		460	private:
		461	void alloc ();
		462	};
		463
161	#endif	464	#endif
162		465

Diff Legend

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

Comparing deliantra/server/include/cfperl.h (file contents): Revision 1.15 by root, Wed Aug 30 11:02:15 2006 UTC vs. Revision 1.49 by root, Mon Jan 8 01:19:03 2007 UTC

Diff Legend

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.15 by root, Wed Aug 30 11:02:15 2006 UTC vs.
Revision 1.49 by root, Mon Jan 8 01:19:03 2007 UTC