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>

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

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

  void put (keyword k, const char *v);
  void put (keyword k, double v);
  void put (keyword k, float v) { put (k, (double)v); }

  void put_ (keyword k, sint32 v);
  void put_ (keyword k, sint64 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); }

  void put (keyword kbeg, keyword kend, const char *v); // multiline

  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.19
Committed:	Thu Aug 31 17:54:14 2006 UTC (17 years, 9 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.18:	+26 -11 lines
Log Message:	rewrote object serialiser, parser is next
#	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
14	// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
15	#undef localtime
16	#undef srand48
17	#undef drand48
18	#undef srandom
19	#undef readdir
20	#undef getprotobyname
21	#undef gethostbyname
22	#undef ctime
23	#undef strerror
24
25	// perl bug #40256: perl does overwrite those with reentrant versions
26	// but does not initialise their state structures.
27	#undef random
28	#undef crypt
29
30	void cfperl_init ();
31	void cfperl_boot ();
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	const char *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_init ()
93	{
94	self = 0;
95	cb = 0;
96	attach = 0;
97	}
98	};
99
100	// objects attachable from perl (or any other extension) should include or
101	// derive using the curiously recurring template pattern, to avoid
102	// virtual method calls etc.
103	template<class subclass>
104	struct attachable : attachable_base
105	{
106	void instantiate ()
107	{
108	if (attach)
109	attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
110	}
111	};
112
113	struct object_freezer : dynbuf
114	{
115	AV *av;
116
117	object_freezer ();
118	~object_freezer ();
119
120	void put (attachable_base *ext);
121
122	template<class subclass>
123	void put (attachable<subclass> *obj)
124	{
125	put ((attachable_base *)obj);
126	}
127
128	void put (const char k, const char v); //TODO//temporary
129	void put (const char *k, int v); //TODO//temporary
130
131	void put (keyword k, const char *v);
132	void put (keyword k, double v);
133	void put (keyword k, float v) { put (k, (double)v); }
134
135	void put_ (keyword k, sint32 v);
136	void put_ (keyword k, sint64 v);
137
138	void put (keyword k, signed char v) { put_(k, (sint32)v); }
139	void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
140	void put (keyword k, signed short v) { put_(k, (sint32)v); }
141	void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
142	void put (keyword k, signed int v) { put_(k, (sint32)v); }
143	void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
144	void put (keyword k, signed long v) { put_(k, (sint64)v); }
145	void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
146	void put (keyword k, signed long long v) { put_(k, (sint64)v); }
147	void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
148
149	void put (keyword kbeg, keyword kend, const char *v); // multiline
150
151	template<typename T>
152	void put (keyword k, T *v)
153	{
154	put (k, v ? (const char *)v->name : 0);
155	}
156
157	bool save (const char *filename);
158
159	operator bool () { return !!av; }
160	};
161
162	// compatibility support, should be removed when no longer needed
163	int fprintf (object_freezer &freezer, const char *format, ...);
164	int fputs (const char *s, object_freezer &freezer);
165
166	// a single key-value line from a file
167	struct token {
168	keyword k;
169	const char *v;
170
171	token (keyword k, const char *v = 0) : k(k), v(v) { }
172	};
173
174	struct object_thawer
175	{
176	AV *av;
177	FILE *fp;
178	char line[1024];
179
180	object_thawer (const char *filename = 0);
181	~object_thawer ();
182
183	void get (data_type type, void obj, attachable_base ext, int oid);
184
185	template<class subclass>
186	void get (attachable<subclass> *obj, int oid)
187	{
188	if (av)
189	get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
190	}
191
192	token get_token ();
193
194	operator FILE *() { return fp; }
195	};
196
197	#endif
198