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 "keyword.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

struct pl;
struct object;
struct mapstruct;

void cfperl_init ();
void cfperl_boot ();
void cfperl_main ();

// could have used templates, but a more traditional C api
// uses more explicit typing which is ok for this purpose.
enum data_type
{
  DT_END,     // no further arguments
  DT_AV,      // perl-only av that needs to be flattened out
  DT_INT,
  DT_INT64,
  DT_DOUBLE,
  DT_STRING,  // 0-terminated string
  DT_DATA,    // string + length
  DT_OBJECT,
  DT_MAP,
  DT_PLAYER,
  DT_ARCH,
  DT_PARTY,
  DT_REGION,

  NUM_DATA_TYPES
};

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
{
  static data_type get_dt ()
  {
    return subclass::get_dt ();
  }

  void instantiate ()
  {
    if (attach)
      attachable_base::instantiate (get_dt (), static_cast<subclass *>(this));
  }
};

struct object_freezer
{
  AV *av;
  SV *text;

  object_freezer ();
  ~object_freezer ();

  void put (attachable_base *ext);

  template<class subclass>
  void put (attachable<subclass> *obj)
  {
    put ((attachable_base *)obj);
  }

  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 (subclass::get_dt (), (subclass *)obj, obj, oid);
  }

  token get_token ();

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

#endif

Revision:	1.17
Committed:	Thu Aug 31 06:23:19 2006 UTC (17 years, 8 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.16:	+27 -16 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
14	root	1.17	#include "keyword.h"
15
16	root	1.16	// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
17			#undef localtime
18			#undef srand48
19			#undef drand48
20			#undef srandom
21			#undef readdir
22			#undef getprotobyname
23			#undef gethostbyname
24			#undef ctime
25			#undef strerror
26
27			// perl bug #40256: perl does overwrite those with reentrant versions
28			// but does not initialise their state structures.
29			#undef random
30			#undef crypt
31
32	root	1.6	struct pl;
33			struct object;
34			struct mapstruct;
35
36	root	1.7	void cfperl_init ();
37	root	1.16	void cfperl_boot ();
38	root	1.7	void cfperl_main ();
39
40	root	1.2	// could have used templates, but a more traditional C api
41			// uses more explicit typing which is ok for this purpose.
42	root	1.6	enum data_type
43			{
44	root	1.2	DT_END, // no further arguments
45	root	1.11	DT_AV, // perl-only av that needs to be flattened out
46	root	1.2	DT_INT,
47	root	1.5	DT_INT64,
48	root	1.2	DT_DOUBLE,
49			DT_STRING, // 0-terminated string
50			DT_DATA, // string + length
51			DT_OBJECT,
52			DT_MAP,
53			DT_PLAYER,
54			DT_ARCH,
55			DT_PARTY,
56			DT_REGION,
57	root	1.8
58			NUM_DATA_TYPES
59	root	1.2	};
60
61	root	1.6	enum event_klass
62			{
63	root	1.11	KLASS_NONE,
64	root	1.3	KLASS_GLOBAL,
65			KLASS_PLAYER,
66			KLASS_OBJECT,
67			KLASS_MAP,
68			};
69
70	root	1.6	enum event_type
71			{
72	root	1.7	# define def(klass,name) EVENT_ ## klass ## _ ## name,
73	root	1.2	# include "eventinc.h"
74			# undef def
75	root	1.4	NUM_EVENT_TYPES
76	root	1.2	};
77
78	root	1.11	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
79	root	1.3	#define ARG_INT(v) DT_INT , static_cast<int> (v)
80	root	1.5	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
81	root	1.3	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
82	root	1.5	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
83			#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), (l)
84	root	1.6	#define ARG_OBJECT(o) DT_OBJECT, (void )static_cast<struct object > (o)
85			#define ARG_MAP(o) DT_MAP , (void )static_cast<struct mapstruct > (o)
86			#define ARG_PLAYER(o) DT_PLAYER, (void )static_cast<struct pl > (o)
87			#define ARG_ARCH(o) DT_ARCH , (void )static_cast<struct archetype > (o)
88			#define ARG_PARTY(o) DT_PARTY , (void )static_cast<struct party > (o)
89			#define ARG_REGION(o) DT_REGION, (void )static_cast<struct region > (o)
90	root	1.3
91			// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
92	root	1.2
93	root	1.4	// all these return true when the normal event processing should be skipped (if any)
94	root	1.9	#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
95	root	1.1
96	root	1.9	#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
97			#define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
98			#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__)
99			#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__)
100			#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__)
101	root	1.3
102	root	1.7	//TODO should index into @result
103			#define RESULT(idx,type) cfperl_result_ ## type (idx)
104			#define RESULT_INT(idx) RESULT(idx, INT)
105
106			bool cfperl_invoke (event_type event, ...);
107			int cfperl_result_INT (int idx);
108
109	root	1.10	struct attachable_base
110	root	1.6	{
111	root	1.17	SV *self;
112			AV *cb; // CF+ perl self and callback
113	root	1.6	const char *attach; // generic extension attachment information
114
115	root	1.13	void clear (); // called when free'ing objects
116			void optimise (); // possibly save some memory by destroying unneeded data
117			void instantiate (data_type type, void *obj);
118	root	1.8
119	root	1.10	void attachable_init ()
120	root	1.8	{
121	root	1.16	self = 0;
122			cb = 0;
123	root	1.8	attach = 0;
124			}
125	root	1.6	};
126
127	root	1.10	// objects attachable from perl (or any other extension) should include or
128	root	1.6	// derive using the curiously recurring template pattern, to avoid
129			// virtual method calls etc.
130			template<class subclass>
131	root	1.10	struct attachable : attachable_base
132	root	1.6	{
133	root	1.8	static data_type get_dt ()
134	root	1.6	{
135	root	1.13	return subclass::get_dt ();
136			}
137
138			void instantiate ()
139			{
140			if (attach)
141			attachable_base::instantiate (get_dt (), static_cast<subclass *>(this));
142	root	1.6	}
143			};
144
145	root	1.17	struct object_freezer
146	root	1.7	{
147	root	1.17	AV *av;
148			SV *text;
149	root	1.12
150	root	1.17	object_freezer ();
151	root	1.8	~object_freezer ();
152
153	root	1.12	void put (attachable_base *ext);
154	root	1.8
155			template<class subclass>
156	root	1.12	void put (attachable<subclass> *obj)
157	root	1.8	{
158	root	1.12	put ((attachable_base *)obj);
159	root	1.8	}
160	root	1.15
161	root	1.17	bool save (const char *filename);
162
163	root	1.16	operator bool () { return !!av; }
164	root	1.7	};
165
166	root	1.17	// compatibility support, should be removed when no longer needed
167			int fprintf (object_freezer &freezer, const char *format, ...);
168			int fputs (const char *s, object_freezer &freezer);
169
170			// a single key-value line from a file
171			struct token {
172			keyword k;
173			const char *v;
174
175			token (keyword k, const char *v = 0) : k(k), v(v) { }
176			};
177
178			struct object_thawer
179	root	1.7	{
180	root	1.17	AV *av;
181	root	1.16	FILE *fp;
182	root	1.17	char line[1024];
183	root	1.16
184	root	1.14	object_thawer (const char *filename = 0);
185	root	1.8	~object_thawer ();
186
187	root	1.11	void get (data_type type, void obj, attachable_base ext, int oid);
188	root	1.8
189			template<class subclass>
190	root	1.11	void get (attachable<subclass> *obj, int oid)
191	root	1.8	{
192			if (av)
193	root	1.11	get (subclass::get_dt (), (subclass *)obj, obj, oid);
194	root	1.8	}
195	root	1.15
196	root	1.17	token get_token ();
197
198	root	1.15	operator FILE *() { return fp; }
199	root	1.7	};
200	root	1.2
201			#endif
202	root	1.3