server/include/cfperl.h

//
// cfperl.h perl interface
//
#ifndef CFPERL_H__
#define CFPERL_H__

struct pl;
struct object;
struct mapstruct;

void cfperl_init ();
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
{
  void *self, *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 attachable_init ()
  {
    self = 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 ()
  {
    subclass::get_dt ();
  }
};

struct object_freezer
{
  const char *filename;
  void *av;

  object_freezer (const char *filename);
  ~object_freezer ();

  void put (FILE *fp, attachable_base *ext);

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

  void finish ();
};

struct object_thawer
{
  void *av;

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

  void finish ();
};

#endif

Revision:	1.11
Committed:	Mon Aug 28 07:07:41 2006 UTC (17 years, 8 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.10:	+9 -9 lines
Log Message:	better but more wasteful serialisation support, perl can invoke events, fixes
#	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.6	struct pl;
8			struct object;
9			struct mapstruct;
10
11	root	1.7	void cfperl_init ();
12			void cfperl_main ();
13
14	root	1.2	// could have used templates, but a more traditional C api
15			// uses more explicit typing which is ok for this purpose.
16	root	1.6	enum data_type
17			{
18	root	1.2	DT_END, // no further arguments
19	root	1.11	DT_AV, // perl-only av that needs to be flattened out
20	root	1.2	DT_INT,
21	root	1.5	DT_INT64,
22	root	1.2	DT_DOUBLE,
23			DT_STRING, // 0-terminated string
24			DT_DATA, // string + length
25			DT_OBJECT,
26			DT_MAP,
27			DT_PLAYER,
28			DT_ARCH,
29			DT_PARTY,
30			DT_REGION,
31	root	1.8
32			NUM_DATA_TYPES
33	root	1.2	};
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			void self, 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	root	1.8
91	root	1.10	void attachable_init ()
92	root	1.8	{
93			self = cb = 0;
94			attach = 0;
95			}
96	root	1.6	};
97
98	root	1.10	// objects attachable from perl (or any other extension) should include or
99	root	1.6	// derive using the curiously recurring template pattern, to avoid
100			// virtual method calls etc.
101			template<class subclass>
102	root	1.10	struct attachable : attachable_base
103	root	1.6	{
104	root	1.8	static data_type get_dt ()
105	root	1.6	{
106	root	1.8	subclass::get_dt ();
107	root	1.6	}
108			};
109
110	root	1.7	struct object_freezer
111			{
112			const char *filename;
113			void *av;
114	root	1.8
115			object_freezer (const char *filename);
116			~object_freezer ();
117
118	root	1.11	void put (FILE fp, attachable_base ext);
119	root	1.8
120			template<class subclass>
121	root	1.11	void put (FILE fp, attachable<subclass> obj)
122	root	1.8	{
123	root	1.11	put (fp, (attachable_base *)obj);
124	root	1.8	}
125	root	1.7
126			void finish ();
127			};
128
129			struct object_thawer
130			{
131			void *av;
132	root	1.8
133			object_thawer (const char *filename = 0);
134			~object_thawer ();
135
136	root	1.11	void get (data_type type, void obj, attachable_base ext, int oid);
137	root	1.8
138			template<class subclass>
139	root	1.11	void get (attachable<subclass> *obj, int oid)
140	root	1.8	{
141			if (av)
142	root	1.11	get (subclass::get_dt (), (subclass *)obj, obj, oid);
143	root	1.8	}
144	root	1.3
145	root	1.7	void finish ();
146			};
147	root	1.2
148			#endif
149	root	1.3