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

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

  void put (keyword k);
  void put (const char *v);
  void put (int v);

  template<typename value>
  void put (keyword k, value v)
  {
    put (k);
    put (v);
  }

  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.18
Committed:	Thu Aug 31 09:19:34 2006 UTC (17 years, 9 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.17:	+13 -32 lines
Log Message:	* empty log message *
#	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	#include "keyword.h"
15
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	void cfperl_init ();
33	void cfperl_boot ();
34	void cfperl_main ();
35
36	enum event_klass
37	{
38	KLASS_NONE,
39	KLASS_GLOBAL,
40	KLASS_PLAYER,
41	KLASS_OBJECT,
42	KLASS_MAP,
43	};
44
45	enum event_type
46	{
47	# define def(klass,name) EVENT_ ## klass ## _ ## name,
48	# include "eventinc.h"
49	# undef def
50	NUM_EVENT_TYPES
51	};
52
53	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
54	#define ARG_INT(v) DT_INT , static_cast<int> (v)
55	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
56	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
57	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
58	#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), (l)
59	#define ARG_OBJECT(o) DT_OBJECT, (void )static_cast<struct object > (o)
60	#define ARG_MAP(o) DT_MAP , (void )static_cast<struct mapstruct > (o)
61	#define ARG_PLAYER(o) DT_PLAYER, (void )static_cast<struct pl > (o)
62	#define ARG_ARCH(o) DT_ARCH , (void )static_cast<struct archetype > (o)
63	#define ARG_PARTY(o) DT_PARTY , (void )static_cast<struct party > (o)
64	#define ARG_REGION(o) DT_REGION, (void )static_cast<struct region > (o)
65
66	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
67
68	// all these return true when the normal event processing should be skipped (if any)
69	#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
70
71	#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
72	#define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
73	#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__)
74	#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__)
75	#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__)
76
77	//TODO should index into @result
78	#define RESULT(idx,type) cfperl_result_ ## type (idx)
79	#define RESULT_INT(idx) RESULT(idx, INT)
80
81	bool cfperl_invoke (event_type event, ...);
82	int cfperl_result_INT (int idx);
83
84	struct attachable_base
85	{
86	SV *self;
87	AV *cb; // CF+ perl self and callback
88	const char *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_init ()
95	{
96	self = 0;
97	cb = 0;
98	attach = 0;
99	}
100	};
101
102	// objects attachable from perl (or any other extension) should include or
103	// derive using the curiously recurring template pattern, to avoid
104	// virtual method calls etc.
105	template<class subclass>
106	struct attachable : attachable_base
107	{
108	void instantiate ()
109	{
110	if (attach)
111	attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
112	}
113	};
114
115	struct object_freezer
116	{
117	AV *av;
118	SV *text;
119
120	object_freezer ();
121	~object_freezer ();
122
123	void put (attachable_base *ext);
124
125	template<class subclass>
126	void put (attachable<subclass> *obj)
127	{
128	put ((attachable_base *)obj);
129	}
130
131	void put (keyword k);
132	void put (const char *v);
133	void put (int v);
134
135	template<typename value>
136	void put (keyword k, value v)
137	{
138	put (k);
139	put (v);
140	}
141
142	bool save (const char *filename);
143
144	operator bool () { return !!av; }
145	};
146
147	// compatibility support, should be removed when no longer needed
148	int fprintf (object_freezer &freezer, const char *format, ...);
149	int fputs (const char *s, object_freezer &freezer);
150
151	// a single key-value line from a file
152	struct token {
153	keyword k;
154	const char *v;
155
156	token (keyword k, const char *v = 0) : k(k), v(v) { }
157	};
158
159	struct object_thawer
160	{
161	AV *av;
162	FILE *fp;
163	char line[1024];
164
165	object_thawer (const char *filename = 0);
166	~object_thawer ();
167
168	void get (data_type type, void obj, attachable_base ext, int oid);
169
170	template<class subclass>
171	void get (attachable<subclass> *obj, int oid)
172	{
173	if (av)
174	get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
175	}
176
177	token get_token ();
178
179	operator FILE *() { return fp; }
180	};
181
182	#endif
183