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_PLAYER,
  KLASS_OBJECT,
  KLASS_MAP,
};

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), (l)
#define ARG_OBJECT(o) DT_OBJECT, (void *)static_cast<struct object *>    (o)
#define ARG_MAP(o)    DT_MAP   , (void *)static_cast<struct mapstruct *> (o)
#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<struct pl *>        (o)
#define ARG_ARCH(o)   DT_ARCH  , (void *)static_cast<struct archetype *> (o)
#define ARG_PARTY(o)  DT_PARTY , (void *)static_cast<struct party *>     (o)
#define ARG_REGION(o) DT_REGION, (void *)static_cast<struct region *>    (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_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_INT(idx) RESULT(idx, INT)

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

struct attachable_base
{
  SV *self;
  AV *cb;    // CF+ perl self and callback
  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)
  {
  }
};

// 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);
  }

  //TODO//temporary
  void put (const char *k, const char *v)
  {
    add (k);

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

    add ('\n');
  }

  //TODO//temporary
  void put (const char *k, int v)
  {
    add (k);
    add (' ');
    add (sint32 (v));
    add ('\n');
  }

#if 1
  void put (keyword k, const char *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--; //TODO//cf compatibility always add space
        memcpy (p, v, vlen); p += vlen;
      }

    *p = '\n';
  }
#endif

#if 0
  void put (keyword k, const shstr &v)
  {
    int klen = keyword_len [k];
    int vlen = v ? v.length () + 1 : 0;

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

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

    if (v)
      {
        *p++ = ' ';  vlen--; //TODO//cf compatibility always add space
        memcpy (p, v, vlen); p += vlen;
      }

    *p = '\n';
  }
#endif

  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, T *v)
  {
    if (v)
      put (k, v->name);
    else
      put (k, (const char *)0);
  }

  bool save (const char *filename);

  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 ();

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