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

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.19 by root, Thu Aug 31 17:54:14 2006 UTC vs.
Revision 1.122 by root, Thu Apr 15 04:02:38 2010 UTC

		1	/*
		2	* This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	*
		4	* Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
		5	*
		6	* Deliantra is free software: you can redistribute it and/or modify it under
		7	* the terms of the Affero GNU General Public License as published by the
		8	* Free Software Foundation, either version 3 of the License, or (at your
		9	* option) any later version.
		10	*
		11	* This program is distributed in the hope that it will be useful,
		12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
		13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		14	* GNU General Public License for more details.
		15	*
		16	* You should have received a copy of the Affero GNU General Public License
		17	* and the GNU General Public License along with this program. If not, see
		18	* <http://www.gnu.org/licenses/>.
		19	*
		20	* The authors can be reached via e-mail to <support@deliantra.net>
		21	*/
		22
1	//	23	//
2	// cfperl.h perl interface	24	// cfperl.h perl interface
3	//	25	//
4	#ifndef CFPERL_H__	26	#ifndef CFPERL_H__
5	#define CFPERL_H__	27	#define CFPERL_H__
6		28
7	#include <cstdio>
8
9	using namespace std;	29	using namespace std;
10		30
11	#include <EXTERN.h>	31	#include <EXTERN.h>
12	#include <perl.h>	32	#include <perl.h>
		33	#include <XSUB.h>
		34
		35	#include <EVAPI.h>
		36	#include <CoroAPI.h>
		37
		38	#include "util.h"
		39	#include "keyword.h"
		40	#include "dynbuf.h"
		41	#include "callback.h"
		42
		43	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
13		44
14	// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)	45	// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
15	#undef localtime	46	#undef localtime
16	#undef srand48	47	#undef srand48
17	#undef drand48	48	#undef drand48
18	#undef srandom	49	#undef srandom
		50	#undef opendir
19	#undef readdir	51	#undef readdir
		52	#undef closedir
20	#undef getprotobyname	53	#undef getprotobyname
21	#undef gethostbyname	54	#undef gethostbyname
22	#undef ctime	55	#undef ctime
23	#undef strerror	56	#undef strerror
		57	#undef _
		58
		59	// same here, massive symbol spamming
		60	#undef do_open
		61	#undef do_close
		62	#undef ref
		63	#undef seed
24		64
25	// perl bug #40256: perl does overwrite those with reentrant versions	65	// perl bug #40256: perl does overwrite those with reentrant versions
26	// but does not initialise their state structures.	66	// but does not initialise their state structures.
27	#undef random	67	#undef random
28	#undef crypt	68	#undef crypt
29		69
		70	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		71
		72	#define _(msg) (msg)
		73	#define N_(msg) (msg)
		74
		75	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		76
		77	// some macros to simplify perl in-calls
		78
		79	#define CHECK_ERROR \
		80	if (SvTRUE (ERRSV)) \
		81	LOG (llevError, "runtime error in %s: %s", __func__, SvPVutf8_nolen (ERRSV));
		82
		83	inline int call_pvsv (const char *ob, I32 flags) { return call_pv (ob, flags); }
		84	inline int call_pvsv (SV *ob, I32 flags) { return call_sv (ob, flags); }
		85
		86	// TODO: temporarily enabled pushstack/popstack for all calls from the core, to maybe fix object memleak?
		87	#define CALL_PUSH PUSHSTACKi (PERLSI_UNKNOWN)
		88	#define CALL_POP PUTBACK; POPSTACK; SPAGAIN
		89	#define CALL_BEGIN(args) dSP; CALL_PUSH; ENTER; SAVETMPS; PUSHMARK (SP); EXTEND (SP, args)
		90	#define CALL_ARG_SV(sv) PUSHs (sv_2mortal (sv)) // separate because no refcount inc
		91	#define CALL_ARG(expr) PUSHs (sv_2mortal (to_sv (expr)))
		92	#define CALL_CALL(name, flags) PUTBACK; int count = call_pvsv (name, (flags) \| G_EVAL); SPAGAIN;
		93	#define CALL_END PUTBACK; CHECK_ERROR; FREETMPS; LEAVE; CALL_POP
		94
		95	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		96
30	void cfperl_init ();	97	void cfperl_init ();
31	void cfperl_boot ();
32	void cfperl_main ();	98	void cfperl_main ();
		99	void cfperl_tick ();
		100	void cfperl_emergency_save ();
		101	void cfperl_cleanup (int make_core);
		102	void cfperl_make_book (object *book, int level);
		103	void cfperl_send_msg (client *ns, int color, const_utf8_string type, const_utf8_string msg);
		104	int cfperl_can_merge (object ob1, object ob2);
		105	void cfperl_mapscript_activate (object ob, int state, object activator, object *originator = 0);
		106
		107	bool is_match_expr (const_utf8_string expr);
		108	// applies the match expression and returns true if it matches
		109	bool match (const_utf8_string expr, object ob, object self = 0, object source = 0, object originator = 0);
		110	// same as above, but returns the first object found, or 0
		111	object match_one (const_utf8_string expr, object ob, object self = 0, object source = 0, object *originator = 0);
		112
		113	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		114
		115	#if IVSIZE >= 8
		116	typedef IV val64;
		117	typedef IV uval64;
		118	# define newSVval64 newSViv
		119	# define SvVAL64 SvIV
		120	# define newSVuval64 newSVuv
		121	# define SvUVAL64 SvUV
		122	#else
		123	typedef double val64;
		124	typedef double uval64;
		125	# define newSVval64 newSVnv
		126	# define SvVAL64 SvNV
		127	# define newSVuval64 newSVnv
		128	# define SvUVAL64 SvNV
		129	#endif
		130
		131	extern tstamp runtime; // virtual server time, excluding time jumps and lag
		132	extern tstamp NOW; // real time of current server tick
33		133
34	enum event_klass	134	enum event_klass
35	{	135	{
36	KLASS_NONE,	136	KLASS_NONE,
37	KLASS_GLOBAL,	137	KLASS_GLOBAL,
		138	KLASS_ATTACHABLE,
		139	KLASS_CLIENT,
38	KLASS_PLAYER,	140	KLASS_PLAYER,
39	KLASS_OBJECT,	141	KLASS_OBJECT,
40	KLASS_MAP,	142	KLASS_MAP,
		143	KLASS_COMMAND,
41	};	144	};
42		145
43	enum event_type	146	enum event_type
44	{	147	{
45	# define def(klass,name) EVENT_ ## klass ## _ ## name,	148	# define def(klass,name) EVENT_ ## klass ## _ ## name,
46	# include "eventinc.h"	149	# include "eventinc.h"
47	# undef def	150	# undef def
48	NUM_EVENT_TYPES	151	NUM_EVENT_TYPES
49	};	152	};
50		153
		154	// in which global events or per-type events are we interested
		155	extern bitset<NUM_EVENT_TYPES> ev_want_event;
		156	extern bitset<NUM_TYPES> ev_want_type;
		157
51	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)	158	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
52	#define ARG_INT(v) DT_INT , static_cast<int> (v)	159	#define ARG_INT(v) DT_INT , static_cast<int> (v)
53	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)	160	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
54	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)	161	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
55	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)	162	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
56	#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), (l)	163	#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
57	#define ARG_OBJECT(o) DT_OBJECT, (void )static_cast<struct object > (o)	164	#define ARG_OBJECT(o) DT_OBJECT, (void )(static_cast<object > (o))
58	#define ARG_MAP(o) DT_MAP , (void )static_cast<struct mapstruct > (o)	165	#define ARG_MAP(o) DT_MAP , (void )(static_cast<maptile > (o))
59	#define ARG_PLAYER(o) DT_PLAYER, (void )static_cast<struct pl > (o)	166	#define ARG_PLAYER(o) DT_PLAYER, (void )(static_cast<player > (o))
60	#define ARG_ARCH(o) DT_ARCH , (void )static_cast<struct archetype > (o)	167	#define ARG_ARCH(o) DT_ARCH , (void )(static_cast<archetype > (o))
		168	#define ARG_CLIENT(o) DT_CLIENT, (void )(static_cast<client > (o))
61	#define ARG_PARTY(o) DT_PARTY , (void )static_cast<struct party > (o)	169	#define ARG_PARTY(o) DT_PARTY , (void )(static_cast<party > (o))
62	#define ARG_REGION(o) DT_REGION, (void )static_cast<struct region > (o)	170	#define ARG_REGION(o) DT_REGION, (void )(static_cast<region > (o))
63		171
64	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension	172	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
65		173	#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
66	// all these return true when the normal event processing should be skipped (if any)
67	#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
68
69	#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
70	#define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)	174	#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
		175	#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__)
71	#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__)	176	#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__)
		177	#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
72	#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__)	178	#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__)
73	#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__)	179	#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
74		180
75	//TODO should index into @result	181	//TODO should index into @result
76	#define RESULT(idx,type) cfperl_result_ ## type (idx)	182	#define RESULT(idx,type) cfperl_result_ ## type (idx)
		183	#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
77	#define RESULT_INT(idx) RESULT(idx, INT)	184	#define RESULT_INT(idx) RESULT(idx, INT)
78		185
79	bool cfperl_invoke (event_type event, ...);	186	double cfperl_result_DOUBLE (int idx);
80	int cfperl_result_INT (int idx);	187	int cfperl_result_INT (int idx);
81		188
		189	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		190
		191	INTERFACE_CLASS (attachable)
82	struct attachable_base	192	struct attachable : refcnt_base
83	{	193	{
84	SV *self;	194	static MGVTBL vtbl;
85	AV *cb; // CF+ perl self and callback
86	const char *attach; // generic extension attachment information
87		195
88	void clear (); // called when free'ing objects	196	enum {
89	void optimise (); // possibly save some memory by destroying unneeded data	197	F_DESTROYED = 0x01,
90	void instantiate (data_type type, void *obj);	198	F_DEBUG_TRACE = 0x02,
91
92	void attachable_init ()
93	{
94	self = 0;
95	cb = 0;
96	attach = 0;
97	}	199	};
98	};	200	uint8 ACC (RW, attachable_flags);
99		201
100	// objects attachable from perl (or any other extension) should include or	202	static unordered_vector<attachable *> mortals;
101	// derive using the curiously recurring template pattern, to avoid	203	MTH static void check_mortals ();
102	// virtual method calls etc.
103	template<class subclass>
104	struct attachable : attachable_base
105	{
106	void instantiate ()
107	{
108	if (attach)
109	attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
110	}
111	};
112		204
113	struct object_freezer : dynbuf	205	// object is delete'd after the refcount reaches 0
114	{	206	MTH int refcnt_cnt () const;
115	AV *av;	207	// check wether the object has died and destroy
		208	MTH void refcnt_chk () { if (expect_false (refcnt <= 0)) do_check (); }
116		209
117	object_freezer ();	210	// destroy the object unless it was already destroyed
118	~object_freezer ();	211	// this politely asks everybody interested the reduce
		212	// the refcount to 0 as soon as possible.
		213	MTH void destroy ();
119		214
120	void put (attachable_base *ext);	215	// return wether an object was destroyed already
		216	MTH bool destroyed () const { return attachable_flags & F_DESTROYED; }
121		217
122	template<class subclass>	218	// destruct and free the memory for this object
123	void put (attachable<subclass> *obj)	219	virtual void do_delete ();
124	{
125	put ((attachable_base *)obj);
126	}
127		220
128	void put (const char k, const char v); //TODO//temporary	221	virtual void gather_callbacks (AV *&callbacks, event_type event) const;
129	void put (const char *k, int v); //TODO//temporary
130		222
131	void put (keyword k, const char *v);	223	#if 0
132	void put (keyword k, double v);	224	private:
133	void put (keyword k, float v) { put (k, (double)v); }	225	static refcounted *rc_first;
134		226	refcounted *rc_next;
135	void put_ (keyword k, sint32 v);
136	void put_ (keyword k, sint64 v);
137
138	void put (keyword k, signed char v) { put_(k, (sint32)v); }
139	void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
140	void put (keyword k, signed short v) { put_(k, (sint32)v); }
141	void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
142	void put (keyword k, signed int v) { put_(k, (sint32)v); }
143	void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
144	void put (keyword k, signed long v) { put_(k, (sint64)v); }
145	void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
146	void put (keyword k, signed long long v) { put_(k, (sint64)v); }
147	void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
148
149	void put (keyword kbeg, keyword kend, const char *v); // multiline
150
151	template<typename T>
152	void put (keyword k, T *v)
153	{
154	put (k, v ? (const char *)v->name : 0);
155	}
156
157	bool save (const char *filename);
158
159	operator bool () { return !!av; }
160	};
161
162	// compatibility support, should be removed when no longer needed
163	int fprintf (object_freezer &freezer, const char *format, ...);
164	int fputs (const char *s, object_freezer &freezer);
165
166	// a single key-value line from a file
167	struct token {
168	keyword k;
169	const char *v;
170
171	token (keyword k, const char *v = 0) : k(k), v(v) { }
172	};
173
174	struct object_thawer
175	{
176	AV *av;
177	FILE *fp;
178	char line[1024];
179
180	object_thawer (const char *filename = 0);
181	~object_thawer ();
182
183	void get (data_type type, void obj, attachable_base ext, int oid);
184
185	template<class subclass>
186	void get (attachable<subclass> *obj, int oid)
187	{
188	if (av)
189	get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
190	}
191
192	token get_token ();
193
194	operator FILE *() { return fp; }
195	};
196
197	#endif	227	#endif
198		228
		229	HV *self; // CF+ perl self
		230	AV *cb; // CF+ callbacks
		231	shstr attach; // generic extension attachment information
		232
		233	void sever_self (); // sever this object from its self, if it has one.
		234	void optimise (); // possibly save some memory by destroying unneeded data
		235
		236	attachable ()
		237	: attachable_flags (0), self (0), cb (0), attach (0)
		238	{
		239	}
		240
		241	attachable (const attachable &src)
		242	: attachable_flags (0), self (0), cb (0), attach (src.attach)
		243	{
		244	}
		245
		246	// set a custom key to the given value, or delete it if value = 0
		247	void set_key (const_utf8_string key, const_utf8_string value = 0, bool is_utf8 = 0);
		248
		249	void set_key_text (const_utf8_string key, const_utf8_string value = 0)
		250	{
		251	set_key (key, value, 1);
		252	}
		253
		254	void set_key_data (const_utf8_string key, const_utf8_string value = 0)
		255	{
		256	set_key (key, value, 0);
		257	}
		258
		259	attachable &operator =(const attachable &src);
		260
		261	// used to _quickly_ decide wether to shortcut the evaluation
		262	bool should_invoke (event_type event)
		263	{
		264	return ev_want_event [event] \|\| cb;
		265	}
		266
		267	bool invoke (event_type event, ...);
		268
		269	MTH void instantiate ();
		270	void reattach ();
		271
		272	protected:
		273	// do the real refcount checking work
		274	void do_check ();
		275
		276	// the method that does the real destroy work
		277	virtual void do_destroy ();
		278
		279	// destructor is protected, should not be called by anybody
		280	virtual ~attachable ();
		281	};
		282
		283	// the global object is a pseudo object that cares for the global events
		284	struct global : attachable
		285	{
		286	void gather_callbacks (AV *&callbacks, event_type event) const;
		287	};
		288
		289	extern struct global gbl_ev;
		290
		291	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		292
		293	#include "freezethaw.h"
		294
		295	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		296
		297	struct coroapi {
		298	static struct CoroAPI *GCoroAPI;
		299
		300	static EV_ATOMIC_T cede_pending;
		301
		302	static int nready () { return CORO_NREADY; }
		303	static int cede () { cede_pending = 0; return CORO_CEDE ; }
		304
		305	static void do_cede_to_tick ();
		306
		307	// actually cede's far more often
		308	static bool cede_to_tick ()
		309	{
		310	if (expect_true (!cede_pending))
		311	return false;
		312
		313	do_cede_to_tick ();
		314	return true;
		315	}
		316
		317	static void wait_for_tick ();
		318	static void wait_for_tick_begin ();
		319	};
		320
		321	struct evapi
		322	{
		323	static struct EVAPI *GEVAPI;
		324	};
		325
		326	struct iow : ev_io, evapi, callback<void (iow &, int)>
		327	{
		328	static void thunk (EV_P_ struct ev_io *w_, int revents)
		329	{
		330	iow &w = static_cast<iow >(w_);
		331
		332	w (w, revents);
		333	}
		334
		335	template<class O, class M>
		336	iow (O object, M method)
		337	: callback<void (iow &, int)> (object, method)
		338	{
		339	ev_init ((ev_io *)this, thunk);
		340	}
		341
		342	void prio (int prio)
		343	{
		344	ev_set_priority ((ev_io *)this, prio);
		345	}
		346
		347	void set (int fd, int events)
		348	{
		349	ev_io_set ((ev_io *)this, fd, events);
		350	}
		351
		352	int poll () const { return events; }
		353
		354	void poll (int events);
		355
		356	void start ()
		357	{
		358	ev_io_start (EV_DEFAULT, (ev_io *)this);
		359	}
		360
		361	void stop ()
		362	{
		363	ev_io_stop (EV_DEFAULT, (ev_io *)this);
		364	}
		365
		366	~iow ()
		367	{
		368	stop ();
		369	}
		370	};
		371
		372	struct asyncw : ev_async, evapi, callback<void (ev_async &, int)>
		373	{
		374	static void thunk (EV_P_ struct ev_async *w_, int revents)
		375	{
		376	asyncw &w = static_cast<asyncw >(w_);
		377
		378	w (w, revents);
		379	}
		380
		381	template<class O, class M>
		382	asyncw (O object, M method)
		383	: callback<void (asyncw &, int)> (object, method)
		384	{
		385	ev_init ((ev_async *)this, thunk);
		386	}
		387
		388	void start ()
		389	{
		390	ev_async_start (EV_DEFAULT, (ev_async *)this);
		391	}
		392
		393	void stop ()
		394	{
		395	ev_async_stop (EV_DEFAULT, (ev_async *)this);
		396	}
		397
		398	~asyncw ()
		399	{
		400	stop ();
		401	}
		402	};
		403
		404	#endif
		405

Diff Legend

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

Comparing deliantra/server/include/cfperl.h (file contents): Revision 1.19 by root, Thu Aug 31 17:54:14 2006 UTC vs. Revision 1.122 by root, Thu Apr 15 04:02:38 2010 UTC

Diff Legend

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.19 by root, Thu Aug 31 17:54:14 2006 UTC vs.
Revision 1.122 by root, Thu Apr 15 04:02:38 2010 UTC