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), 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)

// 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)
#define RESULT_MAP(idx) RESULT(idx, MAP)

bool cfperl_invoke (event_type event, ...);
int cfperl_result_INT (int idx);
int cfperl_result_MAP (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)
  {
  }

  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.32
Committed:	Fri Nov 17 19:40:54 2006 UTC (17 years, 6 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.31:	+7 -1 lines
Log Message:	* remove arch.h * use refcounting for archetypes * cleanup * strat of generic garbage collector
#	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), int (l)
57	#define ARG_OBJECT(o) DT_OBJECT, (void )static_cast<object > (o)
58	#define ARG_MAP(o) DT_MAP , (void )static_cast<maptile > (o)
59	#define ARG_PLAYER(o) DT_PLAYER, (void )static_cast<player > (o)
60	#define ARG_ARCH(o) DT_ARCH , (void )static_cast<archetype > (o)
61	#define ARG_PARTY(o) DT_PARTY , (void )static_cast<party > (o)
62	#define ARG_REGION(o) DT_REGION, (void )static_cast<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	#define RESULT_MAP(idx) RESULT(idx, MAP)
79
80	bool cfperl_invoke (event_type event, ...);
81	int cfperl_result_INT (int idx);
82	int cfperl_result_MAP (int idx);
83
84	struct attachable_base
85	{
86	SV *self;
87	AV *cb; // CF+ perl self and callback
88	shstr attach; // generic extension attachment information
89
90	void clear (); // called when free'ing objects
91	void optimise (); // possibly save some memory by destroying unneeded data
92	void instantiate (data_type type, void *obj);
93
94	void attachable_clear ()
95	{
96	self = 0;
97	cb = 0;
98	attach = 0;
99	}
100
101	attachable_base ()
102	{
103	attachable_clear ();
104	}
105
106	~attachable_base ()
107	{
108	clear ();
109	}
110
111	attachable_base (const attachable_base &src)
112	: self (0), cb (0), attach (src.attach)
113	{
114	}
115
116	attachable_base &operator = (const attachable_base &src)
117	{
118	clear ();
119	attach = src.attach;
120	return *this;
121	}
122	};
123
124	// objects attachable from perl (or any other extension) should include or
125	// derive using the curiously recurring template pattern, to avoid
126	// virtual method calls etc.
127	template<class subclass>
128	struct attachable : attachable_base
129	{
130	void instantiate ()
131	{
132	if (attach)
133	attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
134	}
135	};
136
137	struct object_freezer : dynbuf
138	{
139	AV *av;
140
141	object_freezer ();
142	~object_freezer ();
143
144	void put (attachable_base *ext);
145
146	template<class subclass>
147	void put (attachable<subclass> *obj)
148	{
149	put ((attachable_base *)obj);
150	}
151
152	// used only for user-defined key-value pairs
153	void put (const shstr &k, const shstr &v)
154	{
155	add (k);
156
157	if (v)
158	add (' '), add (v);
159
160	add ('\n');
161	}
162
163	//TODO//temporary, used only for saving body locations
164	void put (const char *k, int v)
165	{
166	add (k);
167	add (' ');
168	add (sint32 (v));
169	add ('\n');
170	}
171
172	template<typename T>
173	void put_string (keyword k, const T &v)
174	{
175	int klen = keyword_len [k];
176	int vlen = v ? strlen (v) + 1 : 0;
177
178	char p = (char )alloc (klen + vlen + 1);
179
180	memcpy (p, keyword_str [k], klen); p += klen;
181
182	if (v)
183	{
184	*p++ = ' '; vlen--;
185	memcpy (p, v, vlen); p += vlen;
186	}
187
188	*p = '\n';
189	}
190
191	void put (keyword k, const char *v)
192	{
193	put_string (k, v);
194	}
195
196	void put (keyword k, const shstr &v)
197	{
198	put_string (k, v);
199	}
200
201	void put (keyword k, double v)
202	{
203	char buf [128];
204
205	snprintf (buf, 128, "%.7g", v);
206
207	put (k, (const char *)buf);
208	}
209
210	void put_(keyword k, sint64 v)
211	{
212	add (keyword_str [k], keyword_len [k]);
213	add (' ');
214	add (v);
215	add ('\n');
216	}
217
218	void put_(keyword k, sint32 v)
219	{
220	add (keyword_str [k], keyword_len [k]);
221	add (' ');
222	add (v);
223	add ('\n');
224	}
225
226	void put (keyword kbeg, keyword kend, const shstr &v)
227	{
228	add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
229
230	if (v)
231	{
232	add (v);
233	add ('\n');
234	}
235
236	add (keyword_str [kend], keyword_len [kend]); add ('\n');
237	}
238
239	void put (keyword k, float v) { put (k, (double)v); }
240	void put (keyword k, signed char v) { put_(k, (sint32)v); }
241	void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
242	void put (keyword k, signed short v) { put_(k, (sint32)v); }
243	void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
244	void put (keyword k, signed int v) { put_(k, (sint32)v); }
245	void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
246	void put (keyword k, signed long v) { put_(k, (sint64)v); }
247	void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
248	void put (keyword k, signed long long v) { put_(k, (sint64)v); }
249	void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
250
251	template<typename T>
252	void put (keyword k, const T *v)
253	{
254	if (v)
255	put (k, v->name);
256	else
257	put (k, (const char *)0);
258	}
259
260	template<typename T>
261	void put (keyword k, const refptr<T> &v)
262	{
263	put (k, (T *)v);
264	}
265
266	bool save (const char *filename);
267	char *as_string (); // like strdup
268
269	operator bool () { return !!av; }
270	};
271
272	// compatibility support, should be removed when no longer needed
273	int fprintf (object_freezer &freezer, const char *format, ...);
274	int fputs (const char *s, object_freezer &freezer);
275
276	struct object_thawer
277	{
278	SV *text; // text part
279	AV *av; // perl part
280	char *line; // current beginning of line
281	char *last_value;
282
283	operator bool () { return !!text; }
284
285	object_thawer (const char *filename = 0);
286	object_thawer (const char data, AV perlav);
287	~object_thawer ();
288
289	void get (data_type type, void obj, attachable_base ext, int oid);
290
291	template<class subclass>
292	void get (attachable<subclass> *obj, int oid)
293	{
294	if (av)
295	get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
296	}
297
298	keyword get_kv (); // also parse value for later use
299
300	const char *get_str () { return last_value; } // may be 0
301
302	void get (shstr &sh) const;
303	void get_ornull (shstr &sh) const { sh = last_value; }
304	void get_ml (keyword kend, shstr &sh);
305
306	sint32 get_sint32 () const;
307	sint64 get_sint64 () const;
308	double get_double () const;
309
310	void get (float &v) { v = get_double (); }
311	void get (double &v) { v = get_double (); }
312
313	void get (sint8 &i) { i = get_sint32 (); }
314	void get (uint8 &i) { i = get_sint32 (); }
315	void get (sint16 &i) { i = get_sint32 (); }
316	void get (uint16 &i) { i = get_sint32 (); }
317	void get (sint32 &i) { i = get_sint32 (); }
318
319	void get (uint32 &i) { i = get_sint64 (); }
320	void get (sint64 &i) { i = get_sint64 (); }
321	};
322
323	char fgets (char s, int n, object_thawer &thawer);
324
325	#endif
326