server/include/cfperl.h

//
// cfperl.h perl interface
//
#ifndef CFPERL_H__
#define CFPERL_H__

#include <cstdio>

using namespace std;

#include <EXTERN.h>
#include <perl.h>
#include <XSUB.h>

#include <EventAPI.h>

#include "callback.h"

// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
#undef localtime
#undef srand48
#undef drand48
#undef srandom
#undef readdir
#undef getprotobyname
#undef gethostbyname
#undef ctime
#undef strerror

// same here, massive symbol spamming
#undef do_open
#undef do_close

// perl bug #40256: perl does overwrite those with reentrant versions
// but does not initialise their state structures.
#undef random
#undef crypt

void cfperl_init ();
void cfperl_main ();

enum event_klass
{
  KLASS_NONE,
  KLASS_GLOBAL,
  KLASS_CLIENT,
  KLASS_PLAYER,
  KLASS_OBJECT,
  KLASS_MAP,
  KLASS_COMMAND,
};

enum event_type
{
# define def(klass,name) EVENT_ ## klass ## _ ## name,
#  include "eventinc.h"
# undef def
  NUM_EVENT_TYPES
};

#define ARG_AV(o)     DT_AV    , static_cast<AV *>   (o)
#define ARG_INT(v)    DT_INT   , static_cast<int>    (v)
#define ARG_INT64(v)  DT_INT64 , static_cast<sint64> (v)
#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
#define ARG_DATA(s,l) DT_DATA  , static_cast<const void *> (s), int (l)
#define ARG_OBJECT(o) DT_OBJECT, (void *)static_cast<object *>    (o)
#define ARG_MAP(o)    DT_MAP   , (void *)static_cast<maptile *>   (o)
#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<player *>    (o)
#define ARG_ARCH(o)   DT_ARCH  , (void *)static_cast<archetype *> (o)
#define ARG_PARTY(o)  DT_PARTY , (void *)static_cast<party *>     (o)
#define ARG_REGION(o) DT_REGION, (void *)static_cast<region *>    (o)
#define ARG_CLIENT(o) DT_CLIENT, (void *)static_cast<client *> (o)

// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension

// all these return true when the normal event processing should be skipped (if any)
#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)

#define INVOKE(klass, event, ...)      INVOKE_(EVENT_ ## klass   ## _ ## event,                  ## __VA_ARGS__)
#define INVOKE_GLOBAL(event, ...)      INVOKE_(EVENT_ ## GLOBAL  ## _ ## event,                  ## __VA_ARGS__)
#define INVOKE_OBJECT(event, op, ...)  INVOKE_(EVENT_ ## OBJECT  ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__)
#define INVOKE_CLIENT(event, ns, ...)  INVOKE_(EVENT_ ## CLIENT  ## _ ## event, ARG_CLIENT (ns), ## __VA_ARGS__)
#define INVOKE_PLAYER(event, pl, ...)  INVOKE_(EVENT_ ## PLAYER  ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__)
#define INVOKE_MAP(event, map, ...)    INVOKE_(EVENT_ ## MAP     ## _ ## event, ARG_MAP (map)  , ## __VA_ARGS__)

//TODO should index into @result
#define RESULT(idx,type) cfperl_result_ ## type (idx)
#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
#define RESULT_INT(idx)    RESULT(idx, INT)

bool cfperl_invoke (event_type event, ...);
double cfperl_result_DOUBLE (int idx);
int cfperl_result_INT (int idx);

struct attachable_base
{
  SV *self;     // CF+ perl self
  AV *cb;       // CF+ callbacks
  shstr attach; // generic extension attachment information

  void clear ();     // called when free'ing objects
  void optimise ();  // possibly save some memory by destroying unneeded data
  void instantiate (data_type type, void *obj);

  void attachable_clear ()
  {
    self   = 0;
    cb     = 0;
    attach = 0;
  }

  attachable_base ()
  {
    attachable_clear ();
  }

  ~attachable_base ()
  {
     clear ();
  }

  attachable_base (const attachable_base &src)
  : self (0), cb (0), attach (src.attach)
  {
  }

  attachable_base &operator =(const attachable_base &src)
  {
    clear ();
    attach = src.attach;
    return *this;
  }
};

// objects attachable from perl (or any other extension) should include or
// derive using the curiously recurring template pattern, to avoid
// virtual method calls etc.
template<class subclass>
struct attachable : attachable_base
{
  void instantiate ()
  {
    if (attach)
      attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
  }
};

struct object_freezer : dynbuf
{
  AV *av;

  object_freezer ();
  ~object_freezer ();

  void put (attachable_base *ext);

  template<class subclass>
  void put (attachable<subclass> *obj)
  {
    put ((attachable_base *)obj);
  }

  // used only for user-defined key-value pairs
  void put (const shstr &k, const shstr &v)
  {
    add (k);

    if (v)
      add (' '), add (v);

    add ('\n');
  }

  //TODO//temporary, used only for saving body locations
  void put (const char *k, int v)
  {
    add (k);
    add (' ');
    add (sint32 (v));
    add ('\n');
  }

  template<typename T>
  void put_string (keyword k, const T &v)
  {
    int klen = keyword_len [k];
    int vlen = v ? strlen (v) + 1 : 0;

    char *p = (char *)alloc (klen + vlen + 1);

    memcpy (p, keyword_str [k], klen); p += klen;

    if (v)
      {
        *p++ = ' ';  vlen--;
        memcpy (p, v, vlen); p += vlen;
      }

    *p = '\n';
  }

  void put (keyword k, const char *v)
  {
    put_string (k, v);
  }

  void put (keyword k, const shstr &v)
  {
    put_string (k, v);
  }

  void put (keyword k, double v)
  {
    char buf [128];

    snprintf (buf, 128, "%.7g", v);

    put (k, (const char *)buf);
  }

  void put_(keyword k, sint64 v)
  {
    add (keyword_str [k], keyword_len [k]);
    add (' ');
    add (v);
    add ('\n');
  }

  void put_(keyword k, sint32 v)
  {
    add (keyword_str [k], keyword_len [k]);
    add (' ');
    add (v);
    add ('\n');
  }

  void put (keyword kbeg, keyword kend, const shstr &v)
  {
    add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');

    if (v)
      {
        add (v);
        add ('\n');
      }

    add (keyword_str [kend], keyword_len [kend]); add ('\n');
  }

  void put (keyword k,          float     v) { put (k, (double)v); }
  void put (keyword k,   signed char      v) { put_(k, (sint32)v); }
  void put (keyword k, unsigned char      v) { put_(k, (sint32)v); }
  void put (keyword k,   signed short     v) { put_(k, (sint32)v); }
  void put (keyword k, unsigned short     v) { put_(k, (sint32)v); }
  void put (keyword k,   signed int       v) { put_(k, (sint32)v); }
  void put (keyword k, unsigned int       v) { put_(k, (sint64)v); }
  void put (keyword k,   signed long      v) { put_(k, (sint64)v); }
  void put (keyword k, unsigned long      v) { put_(k, (sint64)v); }
  void put (keyword k,   signed long long v) { put_(k, (sint64)v); }
  void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }

  template<typename T>
  void put (keyword k, const T *v)
  {
    if (v)
      put (k, v->name);
    else
      put (k, (const char *)0);
  }

  template<typename T>
  void put (keyword k, const refptr<T> &v)
  {
    put (k, (T *)v);
  }

  bool save (const char *filename);
  char *as_string (); // like strdup

  operator bool () { return !!av; }
};

// compatibility support, should be removed when no longer needed
int fprintf (object_freezer &freezer, const char *format, ...);
int fputs (const char *s, object_freezer &freezer);

struct object_thawer
{
  SV *text; // text part
  AV *av;   // perl part
  char *line; // current beginning of line
  char *last_value;

  operator bool () { return !!text; }

  object_thawer (const char *filename = 0);
  object_thawer (const char *data, AV *perlav);
  ~object_thawer ();

  void get (data_type type, void *obj, attachable_base *ext, int oid);

  template<class subclass>
  void get (attachable<subclass> *obj, int oid)
  {
    if (av)
      get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
  }

  keyword get_kv (); // also parse value for later use

  const char *get_str () { return last_value; } // may be 0

  void get (shstr &sh) const;
  void get_ornull (shstr &sh) const { sh = last_value; }
  void get_ml (keyword kend, shstr &sh);

  sint32 get_sint32 () const;
  sint64 get_sint64 () const;
  double get_double () const;

  void get (float &v)  { v = get_double (); }
  void get (double &v) { v = get_double (); }

  void get (sint8  &i) { i = get_sint32 (); }
  void get (uint8  &i) { i = get_sint32 (); }
  void get (sint16 &i) { i = get_sint32 (); }
  void get (uint16 &i) { i = get_sint32 (); }
  void get (sint32 &i) { i = get_sint32 (); }

  void get (uint32 &i) { i = get_sint64 (); }
  void get (sint64 &i) { i = get_sint64 (); }
};

char *fgets (char *s, int n, object_thawer &thawer);

struct watcher_base
{
  static struct EventAPI *GEventAPI;
};

template<class base>
struct watcher : watcher_base
{
  base *pe;

  void start   (bool repeat = false)        { GEventAPI->start   ((pe_watcher *)pe, repeat); }
  void stop    (bool cancel_events = false) { GEventAPI->stop    ((pe_watcher *)pe, cancel_events); }
  void now     ()                           { GEventAPI->now     ((pe_watcher *)pe); }
  void suspend ()                           { GEventAPI->suspend ((pe_watcher *)pe); }
  void resume  ()                           { GEventAPI->resume  ((pe_watcher *)pe); }

  void prio    (int new_prio)               { ((pe_watcher *)pe)->prio = new_prio; }

  ~watcher ()
  {
    cancel ();
  }

private:
  void cancel  ()                           { GEventAPI->cancel  ((pe_watcher *)pe); } // private
};

struct iw : watcher<pe_idle>, callback<void (iw &)>
{
  template<class O, class M>
  iw (O object, M method)
  : callback<void (iw &)> (object, method)
  {
    alloc ();
  }

private:
  void alloc ();
};

struct iow : watcher<pe_io>, callback<void (iow &, int)>
{
  template<class O, class M>
  iow (O object, M method)
  : callback<void (iow &, int)> (object, method)
  {
    alloc ();
  }

  void fd (int fd);
  int poll ();
  void poll (int events);

private:
  void alloc ();
};

#endif

Revision:	1.40
Committed:	Tue Dec 19 04:58:04 2006 UTC (17 years, 5 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.39:	+3 -3 lines
Log Message:	- separate all comamnds into immediate/socket-level and queued/player-level - clean up player command handling, handle up to 8 commands/tick
#	Content
1	//
2	// cfperl.h perl interface
3	//
4	#ifndef CFPERL_H__
5	#define CFPERL_H__
6
7	#include <cstdio>
8
9	using namespace std;
10
11	#include <EXTERN.h>
12	#include <perl.h>
13	#include <XSUB.h>
14
15	#include <EventAPI.h>
16
17	#include "callback.h"
18
19	// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
20	#undef localtime
21	#undef srand48
22	#undef drand48
23	#undef srandom
24	#undef readdir
25	#undef getprotobyname
26	#undef gethostbyname
27	#undef ctime
28	#undef strerror
29
30	// same here, massive symbol spamming
31	#undef do_open
32	#undef do_close
33
34	// perl bug #40256: perl does overwrite those with reentrant versions
35	// but does not initialise their state structures.
36	#undef random
37	#undef crypt
38
39	void cfperl_init ();
40	void cfperl_main ();
41
42	enum event_klass
43	{
44	KLASS_NONE,
45	KLASS_GLOBAL,
46	KLASS_CLIENT,
47	KLASS_PLAYER,
48	KLASS_OBJECT,
49	KLASS_MAP,
50	KLASS_COMMAND,
51	};
52
53	enum event_type
54	{
55	# define def(klass,name) EVENT_ ## klass ## _ ## name,
56	# include "eventinc.h"
57	# undef def
58	NUM_EVENT_TYPES
59	};
60
61	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
62	#define ARG_INT(v) DT_INT , static_cast<int> (v)
63	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
64	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
65	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
66	#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
67	#define ARG_OBJECT(o) DT_OBJECT, (void )static_cast<object > (o)
68	#define ARG_MAP(o) DT_MAP , (void )static_cast<maptile > (o)
69	#define ARG_PLAYER(o) DT_PLAYER, (void )static_cast<player > (o)
70	#define ARG_ARCH(o) DT_ARCH , (void )static_cast<archetype > (o)
71	#define ARG_PARTY(o) DT_PARTY , (void )static_cast<party > (o)
72	#define ARG_REGION(o) DT_REGION, (void )static_cast<region > (o)
73	#define ARG_CLIENT(o) DT_CLIENT, (void )static_cast<client > (o)
74
75	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
76
77	// all these return true when the normal event processing should be skipped (if any)
78	#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
79
80	#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
81	#define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
82	#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__)
83	#define INVOKE_CLIENT(event, ns, ...) INVOKE_(EVENT_ ## CLIENT ## _ ## event, ARG_CLIENT (ns), ## __VA_ARGS__)
84	#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__)
85	#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__)
86
87	//TODO should index into @result
88	#define RESULT(idx,type) cfperl_result_ ## type (idx)
89	#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
90	#define RESULT_INT(idx) RESULT(idx, INT)
91
92	bool cfperl_invoke (event_type event, ...);
93	double cfperl_result_DOUBLE (int idx);
94	int cfperl_result_INT (int idx);
95
96	struct attachable_base
97	{
98	SV *self; // CF+ perl self
99	AV *cb; // CF+ callbacks
100	shstr attach; // generic extension attachment information
101
102	void clear (); // called when free'ing objects
103	void optimise (); // possibly save some memory by destroying unneeded data
104	void instantiate (data_type type, void *obj);
105
106	void attachable_clear ()
107	{
108	self = 0;
109	cb = 0;
110	attach = 0;
111	}
112
113	attachable_base ()
114	{
115	attachable_clear ();
116	}
117
118	~attachable_base ()
119	{
120	clear ();
121	}
122
123	attachable_base (const attachable_base &src)
124	: self (0), cb (0), attach (src.attach)
125	{
126	}
127
128	attachable_base &operator =(const attachable_base &src)
129	{
130	clear ();
131	attach = src.attach;
132	return *this;
133	}
134	};
135
136	// objects attachable from perl (or any other extension) should include or
137	// derive using the curiously recurring template pattern, to avoid
138	// virtual method calls etc.
139	template<class subclass>
140	struct attachable : attachable_base
141	{
142	void instantiate ()
143	{
144	if (attach)
145	attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
146	}
147	};
148
149	struct object_freezer : dynbuf
150	{
151	AV *av;
152
153	object_freezer ();
154	~object_freezer ();
155
156	void put (attachable_base *ext);
157
158	template<class subclass>
159	void put (attachable<subclass> *obj)
160	{
161	put ((attachable_base *)obj);
162	}
163
164	// used only for user-defined key-value pairs
165	void put (const shstr &k, const shstr &v)
166	{
167	add (k);
168
169	if (v)
170	add (' '), add (v);
171
172	add ('\n');
173	}
174
175	//TODO//temporary, used only for saving body locations
176	void put (const char *k, int v)
177	{
178	add (k);
179	add (' ');
180	add (sint32 (v));
181	add ('\n');
182	}
183
184	template<typename T>
185	void put_string (keyword k, const T &v)
186	{
187	int klen = keyword_len [k];
188	int vlen = v ? strlen (v) + 1 : 0;
189
190	char p = (char )alloc (klen + vlen + 1);
191
192	memcpy (p, keyword_str [k], klen); p += klen;
193
194	if (v)
195	{
196	*p++ = ' '; vlen--;
197	memcpy (p, v, vlen); p += vlen;
198	}
199
200	*p = '\n';
201	}
202
203	void put (keyword k, const char *v)
204	{
205	put_string (k, v);
206	}
207
208	void put (keyword k, const shstr &v)
209	{
210	put_string (k, v);
211	}
212
213	void put (keyword k, double v)
214	{
215	char buf [128];
216
217	snprintf (buf, 128, "%.7g", v);
218
219	put (k, (const char *)buf);
220	}
221
222	void put_(keyword k, sint64 v)
223	{
224	add (keyword_str [k], keyword_len [k]);
225	add (' ');
226	add (v);
227	add ('\n');
228	}
229
230	void put_(keyword k, sint32 v)
231	{
232	add (keyword_str [k], keyword_len [k]);
233	add (' ');
234	add (v);
235	add ('\n');
236	}
237
238	void put (keyword kbeg, keyword kend, const shstr &v)
239	{
240	add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
241
242	if (v)
243	{
244	add (v);
245	add ('\n');
246	}
247
248	add (keyword_str [kend], keyword_len [kend]); add ('\n');
249	}
250
251	void put (keyword k, float v) { put (k, (double)v); }
252	void put (keyword k, signed char v) { put_(k, (sint32)v); }
253	void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
254	void put (keyword k, signed short v) { put_(k, (sint32)v); }
255	void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
256	void put (keyword k, signed int v) { put_(k, (sint32)v); }
257	void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
258	void put (keyword k, signed long v) { put_(k, (sint64)v); }
259	void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
260	void put (keyword k, signed long long v) { put_(k, (sint64)v); }
261	void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
262
263	template<typename T>
264	void put (keyword k, const T *v)
265	{
266	if (v)
267	put (k, v->name);
268	else
269	put (k, (const char *)0);
270	}
271
272	template<typename T>
273	void put (keyword k, const refptr<T> &v)
274	{
275	put (k, (T *)v);
276	}
277
278	bool save (const char *filename);
279	char *as_string (); // like strdup
280
281	operator bool () { return !!av; }
282	};
283
284	// compatibility support, should be removed when no longer needed
285	int fprintf (object_freezer &freezer, const char *format, ...);
286	int fputs (const char *s, object_freezer &freezer);
287
288	struct object_thawer
289	{
290	SV *text; // text part
291	AV *av; // perl part
292	char *line; // current beginning of line
293	char *last_value;
294
295	operator bool () { return !!text; }
296
297	object_thawer (const char *filename = 0);
298	object_thawer (const char data, AV perlav);
299	~object_thawer ();
300
301	void get (data_type type, void obj, attachable_base ext, int oid);
302
303	template<class subclass>
304	void get (attachable<subclass> *obj, int oid)
305	{
306	if (av)
307	get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
308	}
309
310	keyword get_kv (); // also parse value for later use
311
312	const char *get_str () { return last_value; } // may be 0
313
314	void get (shstr &sh) const;
315	void get_ornull (shstr &sh) const { sh = last_value; }
316	void get_ml (keyword kend, shstr &sh);
317
318	sint32 get_sint32 () const;
319	sint64 get_sint64 () const;
320	double get_double () const;
321
322	void get (float &v) { v = get_double (); }
323	void get (double &v) { v = get_double (); }
324
325	void get (sint8 &i) { i = get_sint32 (); }
326	void get (uint8 &i) { i = get_sint32 (); }
327	void get (sint16 &i) { i = get_sint32 (); }
328	void get (uint16 &i) { i = get_sint32 (); }
329	void get (sint32 &i) { i = get_sint32 (); }
330
331	void get (uint32 &i) { i = get_sint64 (); }
332	void get (sint64 &i) { i = get_sint64 (); }
333	};
334
335	char fgets (char s, int n, object_thawer &thawer);
336
337	struct watcher_base
338	{
339	static struct EventAPI *GEventAPI;
340	};
341
342	template<class base>
343	struct watcher : watcher_base
344	{
345	base *pe;
346
347	void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); }
348	void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); }
349	void now () { GEventAPI->now ((pe_watcher *)pe); }
350	void suspend () { GEventAPI->suspend ((pe_watcher *)pe); }
351	void resume () { GEventAPI->resume ((pe_watcher *)pe); }
352
353	void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; }
354
355	~watcher ()
356	{
357	cancel ();
358	}
359
360	private:
361	void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private
362	};
363
364	struct iw : watcher<pe_idle>, callback<void (iw &)>
365	{
366	template<class O, class M>
367	iw (O object, M method)
368	: callback<void (iw &)> (object, method)
369	{
370	alloc ();
371	}
372
373	private:
374	void alloc ();
375	};
376
377	struct iow : watcher<pe_io>, callback<void (iow &, int)>
378	{
379	template<class O, class M>
380	iow (O object, M method)
381	: callback<void (iow &, int)> (object, method)
382	{
383	alloc ();
384	}
385
386	void fd (int fd);
387	int poll ();
388	void poll (int events);
389
390	private:
391	void alloc ();
392	};
393
394	#endif
395