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

// 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_DOUBLE(idx) RESULT(idx, DOUBLE)
#define RESULT_INT(idx)    RESULT(idx, INT)

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

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