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>

// 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

// 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_SOCKET,
  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_SOCKET(o) DT_SOCKET, (void *)static_cast<client_socket *> (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_SOCKET(event, ns, ...)  INVOKE_(EVENT_ ## SOCKET  ## _ ## event, ARG_SOCKET (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);

#endif

Revision:	1.35
Committed:	Thu Dec 14 05:09:32 2006 UTC (17 years, 6 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.34:	+9 -6 lines
Log Message:	- remove some old socket mode cruft - preliminarily added attachable client_socket interface to perl (untested but also unreachable from perl code atm)
#	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	// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
16	#undef localtime
17	#undef srand48
18	#undef drand48
19	#undef srandom
20	#undef readdir
21	#undef getprotobyname
22	#undef gethostbyname
23	#undef ctime
24	#undef strerror
25
26	// perl bug #40256: perl does overwrite those with reentrant versions
27	// but does not initialise their state structures.
28	#undef random
29	#undef crypt
30
31	void cfperl_init ();
32	void cfperl_main ();
33
34	enum event_klass
35	{
36	KLASS_NONE,
37	KLASS_GLOBAL,
38	KLASS_SOCKET,
39	KLASS_PLAYER,
40	KLASS_OBJECT,
41	KLASS_MAP,
42	KLASS_COMMAND,
43	};
44
45	enum event_type
46	{
47	# define def(klass,name) EVENT_ ## klass ## _ ## name,
48	# include "eventinc.h"
49	# undef def
50	NUM_EVENT_TYPES
51	};
52
53	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
54	#define ARG_INT(v) DT_INT , static_cast<int> (v)
55	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
56	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
57	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
58	#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
59	#define ARG_OBJECT(o) DT_OBJECT, (void )static_cast<object > (o)
60	#define ARG_MAP(o) DT_MAP , (void )static_cast<maptile > (o)
61	#define ARG_PLAYER(o) DT_PLAYER, (void )static_cast<player > (o)
62	#define ARG_ARCH(o) DT_ARCH , (void )static_cast<archetype > (o)
63	#define ARG_PARTY(o) DT_PARTY , (void )static_cast<party > (o)
64	#define ARG_REGION(o) DT_REGION, (void )static_cast<region > (o)
65	#define ARG_SOCKET(o) DT_SOCKET, (void )static_cast<client_socket > (o)
66
67	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
68
69	// all these return true when the normal event processing should be skipped (if any)
70	#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
71
72	#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
73	#define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
74	#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__)
75	#define INVOKE_SOCKET(event, ns, ...) INVOKE_(EVENT_ ## SOCKET ## _ ## event, ARG_SOCKET (ns), ## __VA_ARGS__)
76	#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__)
77	#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__)
78
79	//TODO should index into @result
80	#define RESULT(idx,type) cfperl_result_ ## type (idx)
81	#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
82	#define RESULT_INT(idx) RESULT(idx, INT)
83
84	bool cfperl_invoke (event_type event, ...);
85	double cfperl_result_DOUBLE (int idx);
86	int cfperl_result_INT (int idx);
87
88	struct attachable_base
89	{
90	SV *self; // CF+ perl self
91	AV *cb; // CF+ callbacks
92	shstr attach; // generic extension attachment information
93
94	void clear (); // called when free'ing objects
95	void optimise (); // possibly save some memory by destroying unneeded data
96	void instantiate (data_type type, void *obj);
97
98	void attachable_clear ()
99	{
100	self = 0;
101	cb = 0;
102	attach = 0;
103	}
104
105	attachable_base ()
106	{
107	attachable_clear ();
108	}
109
110	~attachable_base ()
111	{
112	clear ();
113	}
114
115	attachable_base (const attachable_base &src)
116	: self (0), cb (0), attach (src.attach)
117	{
118	}
119
120	attachable_base &operator =(const attachable_base &src)
121	{
122	clear ();
123	attach = src.attach;
124	return *this;
125	}
126	};
127
128	// objects attachable from perl (or any other extension) should include or
129	// derive using the curiously recurring template pattern, to avoid
130	// virtual method calls etc.
131	template<class subclass>
132	struct attachable : attachable_base
133	{
134	void instantiate ()
135	{
136	if (attach)
137	attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
138	}
139	};
140
141	struct object_freezer : dynbuf
142	{
143	AV *av;
144
145	object_freezer ();
146	~object_freezer ();
147
148	void put (attachable_base *ext);
149
150	template<class subclass>
151	void put (attachable<subclass> *obj)
152	{
153	put ((attachable_base *)obj);
154	}
155
156	// used only for user-defined key-value pairs
157	void put (const shstr &k, const shstr &v)
158	{
159	add (k);
160
161	if (v)
162	add (' '), add (v);
163
164	add ('\n');
165	}
166
167	//TODO//temporary, used only for saving body locations
168	void put (const char *k, int v)
169	{
170	add (k);
171	add (' ');
172	add (sint32 (v));
173	add ('\n');
174	}
175
176	template<typename T>
177	void put_string (keyword k, const T &v)
178	{
179	int klen = keyword_len [k];
180	int vlen = v ? strlen (v) + 1 : 0;
181
182	char p = (char )alloc (klen + vlen + 1);
183
184	memcpy (p, keyword_str [k], klen); p += klen;
185
186	if (v)
187	{
188	*p++ = ' '; vlen--;
189	memcpy (p, v, vlen); p += vlen;
190	}
191
192	*p = '\n';
193	}
194
195	void put (keyword k, const char *v)
196	{
197	put_string (k, v);
198	}
199
200	void put (keyword k, const shstr &v)
201	{
202	put_string (k, v);
203	}
204
205	void put (keyword k, double v)
206	{
207	char buf [128];
208
209	snprintf (buf, 128, "%.7g", v);
210
211	put (k, (const char *)buf);
212	}
213
214	void put_(keyword k, sint64 v)
215	{
216	add (keyword_str [k], keyword_len [k]);
217	add (' ');
218	add (v);
219	add ('\n');
220	}
221
222	void put_(keyword k, sint32 v)
223	{
224	add (keyword_str [k], keyword_len [k]);
225	add (' ');
226	add (v);
227	add ('\n');
228	}
229
230	void put (keyword kbeg, keyword kend, const shstr &v)
231	{
232	add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
233
234	if (v)
235	{
236	add (v);
237	add ('\n');
238	}
239
240	add (keyword_str [kend], keyword_len [kend]); add ('\n');
241	}
242
243	void put (keyword k, float v) { put (k, (double)v); }
244	void put (keyword k, signed char v) { put_(k, (sint32)v); }
245	void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
246	void put (keyword k, signed short v) { put_(k, (sint32)v); }
247	void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
248	void put (keyword k, signed int v) { put_(k, (sint32)v); }
249	void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
250	void put (keyword k, signed long v) { put_(k, (sint64)v); }
251	void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
252	void put (keyword k, signed long long v) { put_(k, (sint64)v); }
253	void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
254
255	template<typename T>
256	void put (keyword k, const T *v)
257	{
258	if (v)
259	put (k, v->name);
260	else
261	put (k, (const char *)0);
262	}
263
264	template<typename T>
265	void put (keyword k, const refptr<T> &v)
266	{
267	put (k, (T *)v);
268	}
269
270	bool save (const char *filename);
271	char *as_string (); // like strdup
272
273	operator bool () { return !!av; }
274	};
275
276	// compatibility support, should be removed when no longer needed
277	int fprintf (object_freezer &freezer, const char *format, ...);
278	int fputs (const char *s, object_freezer &freezer);
279
280	struct object_thawer
281	{
282	SV *text; // text part
283	AV *av; // perl part
284	char *line; // current beginning of line
285	char *last_value;
286
287	operator bool () { return !!text; }
288
289	object_thawer (const char *filename = 0);
290	object_thawer (const char data, AV perlav);
291	~object_thawer ();
292
293	void get (data_type type, void obj, attachable_base ext, int oid);
294
295	template<class subclass>
296	void get (attachable<subclass> *obj, int oid)
297	{
298	if (av)
299	get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
300	}
301
302	keyword get_kv (); // also parse value for later use
303
304	const char *get_str () { return last_value; } // may be 0
305
306	void get (shstr &sh) const;
307	void get_ornull (shstr &sh) const { sh = last_value; }
308	void get_ml (keyword kend, shstr &sh);
309
310	sint32 get_sint32 () const;
311	sint64 get_sint64 () const;
312	double get_double () const;
313
314	void get (float &v) { v = get_double (); }
315	void get (double &v) { v = get_double (); }
316
317	void get (sint8 &i) { i = get_sint32 (); }
318	void get (uint8 &i) { i = get_sint32 (); }
319	void get (sint16 &i) { i = get_sint32 (); }
320	void get (uint16 &i) { i = get_sint32 (); }
321	void get (sint32 &i) { i = get_sint32 (); }
322
323	void get (uint32 &i) { i = get_sint64 (); }
324	void get (sint64 &i) { i = get_sint64 (); }
325	};
326
327	char fgets (char s, int n, object_thawer &thawer);
328
329	#endif
330