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

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.14 by root, Wed Aug 30 06:06:27 2006 UTC vs.
Revision 1.133 by root, Wed Dec 5 19:13:21 2018 UTC

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

Diff Legend

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

Comparing deliantra/server/include/cfperl.h (file contents): Revision 1.14 by root, Wed Aug 30 06:06:27 2006 UTC vs. Revision 1.133 by root, Wed Dec 5 19:13:21 2018 UTC

Diff Legend

Comparing deliantra/server/include/cfperl.h (file contents):
Revision 1.14 by root, Wed Aug 30 06:06:27 2006 UTC vs.
Revision 1.133 by root, Wed Dec 5 19:13:21 2018 UTC