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_boot ();
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
  const char *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_init ()
  {
    self   = 0;
    cb     = 0;
    attach = 0;
  }
};

// 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 (' '); //TODO//cf compatibility always add space
    if (v)
      add (v);

    add ('\n');
  }

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

  void put (keyword k, const char *v)
  {
    int klen = keyword_len [k];
    int vlen = v ? strlen (v) : 0;

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

    memcpy (p, keyword_str [k], klen); p += klen;
    *p++ = ' ';  //TODO//cf compatibility always add space
    memcpy (p, v, vlen); p += vlen;
    *p = '\n';
  }

  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 char *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)
  {
    put (k, v ? (const char *)v->name : 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);

// a single key-value line from a file
struct token {
   keyword k;
   const char *v;

   token (keyword k, const char *v = 0) : k(k), v(v) { }
};

struct object_thawer
{
  AV *av;
  FILE *fp;
  char line[1024];

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

  token get_token ();

  operator FILE *() { return fp; }
};

#endif

Revision:	1.20
Committed:	Thu Aug 31 18:59:24 2006 UTC (17 years, 9 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.19:	+72 -9 lines
Log Message:	* empty log message *
#	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	root	1.16	void cfperl_boot ();
33	root	1.7	void cfperl_main ();
34
35	root	1.6	enum event_klass
36			{
37	root	1.11	KLASS_NONE,
38	root	1.3	KLASS_GLOBAL,
39			KLASS_PLAYER,
40			KLASS_OBJECT,
41			KLASS_MAP,
42			};
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			#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), (l)
58	root	1.6	#define ARG_OBJECT(o) DT_OBJECT, (void )static_cast<struct object > (o)
59			#define ARG_MAP(o) DT_MAP , (void )static_cast<struct mapstruct > (o)
60			#define ARG_PLAYER(o) DT_PLAYER, (void )static_cast<struct pl > (o)
61			#define ARG_ARCH(o) DT_ARCH , (void )static_cast<struct archetype > (o)
62			#define ARG_PARTY(o) DT_PARTY , (void )static_cast<struct party > (o)
63			#define ARG_REGION(o) DT_REGION, (void )static_cast<struct 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.9	#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			#define RESULT_INT(idx) RESULT(idx, INT)
79
80			bool cfperl_invoke (event_type event, ...);
81			int cfperl_result_INT (int idx);
82
83	root	1.10	struct attachable_base
84	root	1.6	{
85	root	1.17	SV *self;
86			AV *cb; // CF+ perl self and callback
87	root	1.6	const char *attach; // generic extension attachment information
88
89	root	1.13	void clear (); // called when free'ing objects
90			void optimise (); // possibly save some memory by destroying unneeded data
91			void instantiate (data_type type, void *obj);
92	root	1.8
93	root	1.10	void attachable_init ()
94	root	1.8	{
95	root	1.16	self = 0;
96			cb = 0;
97	root	1.8	attach = 0;
98			}
99	root	1.6	};
100
101	root	1.10	// objects attachable from perl (or any other extension) should include or
102	root	1.6	// derive using the curiously recurring template pattern, to avoid
103			// virtual method calls etc.
104			template<class subclass>
105	root	1.10	struct attachable : attachable_base
106	root	1.6	{
107	root	1.13	void instantiate ()
108			{
109			if (attach)
110	root	1.18	attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
111	root	1.6	}
112			};
113
114	root	1.19	struct object_freezer : dynbuf
115	root	1.7	{
116	root	1.17	AV *av;
117	root	1.12
118	root	1.17	object_freezer ();
119	root	1.8	~object_freezer ();
120
121	root	1.12	void put (attachable_base *ext);
122	root	1.8
123			template<class subclass>
124	root	1.12	void put (attachable<subclass> *obj)
125	root	1.8	{
126	root	1.12	put ((attachable_base *)obj);
127	root	1.8	}
128	root	1.15
129	root	1.20	//TODO//temporary
130			void put (const char k, const char v)
131			{
132			add (k);
133
134			//if (v)
135			add (' '); //TODO//cf compatibility always add space
136			if (v)
137			add (v);
138
139			add ('\n');
140			}
141
142			//TODO//temporary
143			void put (const char *k, int v)
144			{
145			add (k);
146			add (' ');
147			add (sint32 (v));
148			add ('\n');
149			}
150	root	1.19
151	root	1.20	void put (keyword k, const char *v)
152			{
153			int klen = keyword_len [k];
154			int vlen = v ? strlen (v) : 0;
155
156			char p = (char )alloc (klen + 1 + vlen + 1);
157	root	1.19
158	root	1.20	memcpy (p, keyword_str [k], klen); p += klen;
159			*p++ = ' '; //TODO//cf compatibility always add space
160			memcpy (p, v, vlen); p += vlen;
161			*p = '\n';
162			}
163	root	1.19
164	root	1.20	void put (keyword k, double v)
165			{
166			char buf [128];
167
168			snprintf (buf, 128, "%.7g", v);
169
170			put (k, (const char *)buf);
171			}
172
173			void put_(keyword k, sint64 v)
174			{
175			add (keyword_str [k], keyword_len [k]);
176			add (' ');
177			add (v);
178			add ('\n');
179			}
180
181			void put_(keyword k, sint32 v)
182			{
183			add (keyword_str [k], keyword_len [k]);
184			add (' ');
185			add (v);
186			add ('\n');
187			}
188
189			void put (keyword kbeg, keyword kend, const char *v)
190			{
191			add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
192
193			if (v)
194			{
195			add (v);
196			add ('\n');
197			}
198
199			add (keyword_str [kend], keyword_len [kend]); add ('\n');
200			}
201
202			void put (keyword k, float v) { put (k, (double)v); }
203	root	1.19	void put (keyword k, signed char v) { put_(k, (sint32)v); }
204			void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
205			void put (keyword k, signed short v) { put_(k, (sint32)v); }
206			void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
207			void put (keyword k, signed int v) { put_(k, (sint32)v); }
208			void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
209			void put (keyword k, signed long v) { put_(k, (sint64)v); }
210			void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
211			void put (keyword k, signed long long v) { put_(k, (sint64)v); }
212			void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
213
214			template<typename T>
215			void put (keyword k, T *v)
216	root	1.18	{
217	root	1.19	put (k, v ? (const char *)v->name : 0);
218	root	1.18	}
219
220	root	1.17	bool save (const char *filename);
221
222	root	1.16	operator bool () { return !!av; }
223	root	1.7	};
224
225	root	1.17	// compatibility support, should be removed when no longer needed
226			int fprintf (object_freezer &freezer, const char *format, ...);
227			int fputs (const char *s, object_freezer &freezer);
228
229			// a single key-value line from a file
230			struct token {
231			keyword k;
232			const char *v;
233
234			token (keyword k, const char *v = 0) : k(k), v(v) { }
235			};
236
237			struct object_thawer
238	root	1.7	{
239	root	1.17	AV *av;
240	root	1.16	FILE *fp;
241	root	1.17	char line[1024];
242	root	1.16
243	root	1.14	object_thawer (const char *filename = 0);
244	root	1.8	~object_thawer ();
245
246	root	1.11	void get (data_type type, void obj, attachable_base ext, int oid);
247	root	1.8
248			template<class subclass>
249	root	1.11	void get (attachable<subclass> *obj, int oid)
250	root	1.8	{
251			if (av)
252	root	1.18	get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
253	root	1.8	}
254	root	1.15
255	root	1.17	token get_token ();
256
257	root	1.15	operator FILE *() { return fp; }
258	root	1.7	};
259	root	1.2
260			#endif
261	root	1.3