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

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.8 by root, Sun Aug 27 16:15:12 2006 UTC vs.
Revision 1.129 by root, Wed Nov 16 23:42:00 2016 UTC

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

Diff Legend

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

Comparing deliantra/server/include/cfperl.h (file contents): Revision 1.8 by root, Sun Aug 27 16:15:12 2006 UTC vs. Revision 1.129 by root, Wed Nov 16 23:42:00 2016 UTC

Diff Legend

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.8 by root, Sun Aug 27 16:15:12 2006 UTC vs.
Revision 1.129 by root, Wed Nov 16 23:42:00 2016 UTC