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

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.16 by root, Wed Aug 30 16:30:37 2006 UTC vs.
Revision 1.124 by root, Sat Apr 23 04:56:47 2011 UTC

		1	/*
		2	* This file is part of Deliantra, the Roguelike Realtime MMORPG.
		3	*
		4	* Copyright (©) 2005,2006,2007,2008,2009,2010,2011 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
30	struct pl;	70	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
31	struct object;	71
32	struct mapstruct;	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	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
33		96
34	void cfperl_init ();	97	void cfperl_init ();
35	void cfperl_boot ();
36	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);
37		106
38	// could have used templates, but a more traditional C api	107	bool is_match_expr (const_utf8_string expr);
39	// uses more explicit typing which is ok for this purpose.	108	// applies the match expression and returns true if it matches
40	enum data_type	109	bool match (const_utf8_string expr, object ob, object self = 0, object source = 0, object originator = 0);
41	{	110	// same as above, but returns the first object found, or 0
42	DT_END, // no further arguments	111	object match_one (const_utf8_string expr, object ob, object self = 0, object source = 0, object *originator = 0);
43	DT_AV, // perl-only av that needs to be flattened out
44	DT_INT,
45	DT_INT64,
46	DT_DOUBLE,
47	DT_STRING, // 0-terminated string
48	DT_DATA, // string + length
49	DT_OBJECT,
50	DT_MAP,
51	DT_PLAYER,
52	DT_ARCH,
53	DT_PARTY,
54	DT_REGION,
55		112
56	NUM_DATA_TYPES	113	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
57	};	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
		133
		134	noinline utf8_string cfSvPVutf8_nolen (SV *sv);
58		135
59	enum event_klass	136	enum event_klass
60	{	137	{
61	KLASS_NONE,	138	KLASS_NONE,
62	KLASS_GLOBAL,	139	KLASS_GLOBAL,
		140	KLASS_ATTACHABLE,
		141	KLASS_CLIENT,
63	KLASS_PLAYER,	142	KLASS_PLAYER,
64	KLASS_OBJECT,	143	KLASS_OBJECT,
65	KLASS_MAP,	144	KLASS_MAP,
		145	KLASS_COMMAND,
66	};	146	};
67		147
68	enum event_type	148	enum event_type
69	{	149	{
70	# define def(klass,name) EVENT_ ## klass ## _ ## name,	150	# define def(klass,name) EVENT_ ## klass ## _ ## name,
71	# include "eventinc.h"	151	# include "eventinc.h"
72	# undef def	152	# undef def
73	NUM_EVENT_TYPES	153	NUM_EVENT_TYPES
74	};	154	};
75		155
		156	// in which global events or per-type events are we interested
		157	extern bitset<NUM_EVENT_TYPES> ev_want_event;
		158	extern bitset<NUM_TYPES> ev_want_type;
		159
76	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)	160	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
77	#define ARG_INT(v) DT_INT , static_cast<int> (v)	161	#define ARG_INT(v) DT_INT , static_cast<int> (v)
78	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)	162	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
79	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)	163	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
80	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)	164	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
81	#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), (l)	165	#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
82	#define ARG_OBJECT(o) DT_OBJECT, (void )static_cast<struct object > (o)	166	#define ARG_OBJECT(o) DT_OBJECT, (void )(static_cast<object > (o))
83	#define ARG_MAP(o) DT_MAP , (void )static_cast<struct mapstruct > (o)	167	#define ARG_MAP(o) DT_MAP , (void )(static_cast<maptile > (o))
84	#define ARG_PLAYER(o) DT_PLAYER, (void )static_cast<struct pl > (o)	168	#define ARG_PLAYER(o) DT_PLAYER, (void )(static_cast<player > (o))
85	#define ARG_ARCH(o) DT_ARCH , (void )static_cast<struct archetype > (o)	169	#define ARG_ARCH(o) DT_ARCH , (void )(static_cast<archetype > (o))
		170	#define ARG_CLIENT(o) DT_CLIENT, (void )(static_cast<client > (o))
86	#define ARG_PARTY(o) DT_PARTY , (void )static_cast<struct party > (o)	171	#define ARG_PARTY(o) DT_PARTY , (void )(static_cast<party > (o))
87	#define ARG_REGION(o) DT_REGION, (void )static_cast<struct region > (o)	172	#define ARG_REGION(o) DT_REGION, (void )(static_cast<region > (o))
88		173
89	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension	174	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
90		175	#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
91	// all these return true when the normal event processing should be skipped (if any)
92	#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
93
94	#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
95	#define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)	176	#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
		177	#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__)
96	#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__)	178	#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__)
		179	#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
97	#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__)	180	#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__)
98	#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__)	181	#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
99		182
100	//TODO should index into @result	183	//TODO should index into @result
101	#define RESULT(idx,type) cfperl_result_ ## type (idx)	184	#define RESULT(idx,type) cfperl_result_ ## type (idx)
		185	#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
102	#define RESULT_INT(idx) RESULT(idx, INT)	186	#define RESULT_INT(idx) RESULT(idx, INT)
103		187
104	bool cfperl_invoke (event_type event, ...);	188	double cfperl_result_DOUBLE (int idx);
105	int cfperl_result_INT (int idx);	189	int cfperl_result_INT (int idx);
106		190
		191	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		192
		193	INTERFACE_CLASS (attachable)
107	struct attachable_base	194	struct attachable : refcnt_base
108	{	195	{
109	struct sv *self;	196	static MGVTBL vtbl;
110	struct av *cb; // CF+ perl self and callback
111	const char *attach; // generic extension attachment information
112		197
113	void clear (); // called when free'ing objects	198	enum {
114	void optimise (); // possibly save some memory by destroying unneeded data	199	F_DESTROYED = 0x01,
115	void instantiate (data_type type, void *obj);	200	F_DEBUG_TRACE = 0x02,
116
117	void attachable_init ()
118	{
119	self = 0;
120	cb = 0;
121	attach = 0;
122	}	201	};
123	};	202	uint8 ACC (RW, attachable_flags);
124		203
125	// objects attachable from perl (or any other extension) should include or	204	static unordered_vector<attachable *> mortals;
126	// derive using the curiously recurring template pattern, to avoid	205	MTH static void check_mortals ();
127	// virtual method calls etc.
128	template<class subclass>
129	struct attachable : attachable_base
130	{
131	static data_type get_dt ()
132	{
133	return subclass::get_dt ();
134	}
135		206
136	void instantiate ()	207	// object is delete'd after the refcount reaches 0
137	{	208	MTH int refcnt_cnt () const;
138	if (attach)	209	// check wether the object has died and destroy
139	attachable_base::instantiate (get_dt (), static_cast<subclass *>(this));	210	MTH void refcnt_chk () { if (expect_false (refcnt <= 0)) do_check (); }
140	}
141	};
142		211
143	struct object_freezethaw	212	// destroy the object unless it was already destroyed
144	{	213	// this politely asks everybody interested the reduce
145	struct av *av;	214	// the refcount to 0 as soon as possible.
146	};	215	MTH void destroy ();
147		216
148	struct object_freezer : object_freezethaw	217	// return wether an object was destroyed already
149	{	218	MTH bool destroyed () const { return attachable_flags & F_DESTROYED; }
150	struct sv *text;
151	void *filename;
152		219
153	object_freezer (const char *filename);	220	// destruct and free the memory for this object
154	~object_freezer ();	221	virtual void do_delete ();
155		222
156	void put (attachable_base *ext);	223	virtual void gather_callbacks (AV *&callbacks, event_type event) const;
157		224
158	template<class subclass>	225	#if 0
159	void put (attachable<subclass> *obj)	226	private:
160	{	227	static refcounted *rc_first;
161	put ((attachable_base *)obj);	228	refcounted *rc_next;
162	}
163
164	operator bool () { return !!av; }
165	};
166
167	struct object_thawer : object_freezethaw
168	{
169	FILE *fp;
170
171	object_thawer (const char *filename = 0);
172	~object_thawer ();
173
174	void get (data_type type, void obj, attachable_base ext, int oid);
175
176	template<class subclass>
177	void get (attachable<subclass> *obj, int oid)
178	{
179	if (av)
180	get (subclass::get_dt (), (subclass *)obj, obj, oid);
181	}
182
183	operator FILE *() { return fp; }
184	};
185
186	// compatibility support, should be removed when no longer needed
187	int fprintf (object_freezer &freezer, const char *format, ...);
188	int fputs (const char *s, object_freezer &freezer);
189
190	#endif	229	#endif
191		230
		231	HV *self; // CF+ perl self
		232	AV *cb; // CF+ callbacks
		233	shstr attach; // generic extension attachment information
		234
		235	void sever_self (); // sever this object from its self, if it has one.
		236	void optimise (); // possibly save some memory by destroying unneeded data
		237
		238	attachable ()
		239	: attachable_flags (0), self (0), cb (0), attach (0)
		240	{
		241	}
		242
		243	attachable (const attachable &src)
		244	: attachable_flags (0), self (0), cb (0), attach (src.attach)
		245	{
		246	}
		247
		248	// set a custom key to the given value, or delete it if value = 0
		249	void set_key (const_utf8_string key, const_utf8_string value = 0, bool is_utf8 = 0);
		250
		251	void set_key_text (const_utf8_string key, const_utf8_string value = 0)
		252	{
		253	set_key (key, value, 1);
		254	}
		255
		256	void set_key_data (const_utf8_string key, const_utf8_string value = 0)
		257	{
		258	set_key (key, value, 0);
		259	}
		260
		261	attachable &operator =(const attachable &src);
		262
		263	// used to _quickly_ decide wether to shortcut the evaluation
		264	bool should_invoke (event_type event)
		265	{
		266	return ev_want_event [event] \|\| cb;
		267	}
		268
		269	bool invoke (event_type event, ...);
		270
		271	MTH void instantiate ();
		272	void reattach ();
		273
		274	protected:
		275	// do the real refcount checking work
		276	void do_check ();
		277
		278	// the method that does the real destroy work
		279	virtual void do_destroy ();
		280
		281	// destructor is protected, should not be called by anybody
		282	virtual ~attachable ();
		283	};
		284
		285	// the global object is a pseudo object that cares for the global events
		286	struct global : attachable
		287	{
		288	void gather_callbacks (AV *&callbacks, event_type event) const;
		289	};
		290
		291	extern struct global gbl_ev;
		292
		293	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		294
		295	#include "freezethaw.h"
		296
		297	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
		298
		299	struct coroapi {
		300	static struct CoroAPI *GCoroAPI;
		301
		302	static EV_ATOMIC_T cede_pending;
		303
		304	static int nready () { return CORO_NREADY; }
		305	static int cede () { cede_pending = 0; return CORO_CEDE ; }
		306
		307	static void do_cede_to_tick ();
		308
		309	// actually cede's far more often
		310	static bool cede_to_tick ()
		311	{
		312	if (expect_true (!cede_pending))
		313	return false;
		314
		315	do_cede_to_tick ();
		316	return true;
		317	}
		318
		319	static void wait_for_tick ();
		320	static void wait_for_tick_begin ();
		321	};
		322
		323	struct evapi
		324	{
		325	static struct EVAPI *GEVAPI;
		326	};
		327
		328	struct iow : ev_io, evapi, callback<void (iow &, int)>
		329	{
		330	static void thunk (EV_P_ struct ev_io *w_, int revents)
		331	{
		332	iow &w = static_cast<iow >(w_);
		333
		334	w (w, revents);
		335	}
		336
		337	template<class O, class M>
		338	iow (O object, M method)
		339	: callback<void (iow &, int)> (object, method)
		340	{
		341	ev_init ((ev_io *)this, thunk);
		342	}
		343
		344	void prio (int prio)
		345	{
		346	ev_set_priority ((ev_io *)this, prio);
		347	}
		348
		349	void set (int fd, int events)
		350	{
		351	ev_io_set ((ev_io *)this, fd, events);
		352	}
		353
		354	int poll () const { return events; }
		355
		356	void poll (int events);
		357
		358	void start ()
		359	{
		360	ev_io_start (EV_DEFAULT, (ev_io *)this);
		361	}
		362
		363	void stop ()
		364	{
		365	ev_io_stop (EV_DEFAULT, (ev_io *)this);
		366	}
		367
		368	~iow ()
		369	{
		370	stop ();
		371	}
		372	};
		373
		374	struct asyncw : ev_async, evapi, callback<void (ev_async &, int)>
		375	{
		376	static void thunk (EV_P_ struct ev_async *w_, int revents)
		377	{
		378	asyncw &w = static_cast<asyncw >(w_);
		379
		380	w (w, revents);
		381	}
		382
		383	template<class O, class M>
		384	asyncw (O object, M method)
		385	: callback<void (asyncw &, int)> (object, method)
		386	{
		387	ev_init ((ev_async *)this, thunk);
		388	}
		389
		390	void start ()
		391	{
		392	ev_async_start (EV_DEFAULT, (ev_async *)this);
		393	}
		394
		395	void stop ()
		396	{
		397	ev_async_stop (EV_DEFAULT, (ev_async *)this);
		398	}
		399
		400	~asyncw ()
		401	{
		402	stop ();
		403	}
		404	};
		405
		406	#endif
		407

Diff Legend

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

Comparing deliantra/server/include/cfperl.h (file contents): Revision 1.16 by root, Wed Aug 30 16:30:37 2006 UTC vs. Revision 1.124 by root, Sat Apr 23 04:56:47 2011 UTC

Diff Legend

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.16 by root, Wed Aug 30 16:30:37 2006 UTC vs.
Revision 1.124 by root, Sat Apr 23 04:56:47 2011 UTC