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_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,
  DT_AV,      // av that needs to be flattened out

  NUM_DATA_TYPES
};

enum event_klass
{
  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_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;
  int idx;

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

  void put (attachable_base *ext);

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

  void finish ();
};

struct object_thawer
{
  void *av;
  int idx;

  object_thawer (const char *filename = 0);
  ~object_thawer ();

  void get (data_type type, void *obj, attachable_base *ext);

  template<class subclass>
  void get (attachable<subclass> *obj)
  {
    if (av)
      get (subclass::get_dt (), (subclass *)obj, obj);
  }

  void finish ();
};

#endif

Revision:	1.10
Committed:	Sun Aug 27 17:59:26 2006 UTC (17 years, 9 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.9:	+9 -9 lines
Log Message:	fixes, objects on maps get instantiated properly
#	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			DT_INT,
20	root	1.5	DT_INT64,
21	root	1.2	DT_DOUBLE,
22			DT_STRING, // 0-terminated string
23			DT_DATA, // string + length
24			DT_OBJECT,
25			DT_MAP,
26			DT_PLAYER,
27			DT_ARCH,
28			DT_PARTY,
29			DT_REGION,
30	root	1.7	DT_AV, // av that needs to be flattened out
31	root	1.8
32			NUM_DATA_TYPES
33	root	1.2	};
34
35	root	1.6	enum event_klass
36			{
37	root	1.3	KLASS_GLOBAL,
38			KLASS_PLAYER,
39			KLASS_OBJECT,
40			KLASS_MAP,
41			};
42
43	root	1.6	enum event_type
44			{
45	root	1.7	# define def(klass,name) EVENT_ ## klass ## _ ## name,
46	root	1.2	# include "eventinc.h"
47			# undef def
48	root	1.4	NUM_EVENT_TYPES
49	root	1.2	};
50
51	root	1.3	#define ARG_INT(v) DT_INT , static_cast<int> (v)
52	root	1.5	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
53	root	1.3	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
54	root	1.5	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
55			#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), (l)
56	root	1.6	#define ARG_OBJECT(o) DT_OBJECT, (void )static_cast<struct object > (o)
57			#define ARG_MAP(o) DT_MAP , (void )static_cast<struct mapstruct > (o)
58			#define ARG_PLAYER(o) DT_PLAYER, (void )static_cast<struct pl > (o)
59			#define ARG_ARCH(o) DT_ARCH , (void )static_cast<struct archetype > (o)
60			#define ARG_PARTY(o) DT_PARTY , (void )static_cast<struct party > (o)
61			#define ARG_REGION(o) DT_REGION, (void )static_cast<struct region > (o)
62	root	1.3
63			// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
64	root	1.2
65	root	1.4	// all these return true when the normal event processing should be skipped (if any)
66	root	1.9	#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
67	root	1.1
68	root	1.9	#define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
69			#define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
70			#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__)
71			#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__)
72			#define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__)
73	root	1.3
74	root	1.7	//TODO should index into @result
75			#define RESULT(idx,type) cfperl_result_ ## type (idx)
76			#define RESULT_INT(idx) RESULT(idx, INT)
77
78			bool cfperl_invoke (event_type event, ...);
79			int cfperl_result_INT (int idx);
80
81	root	1.10	struct attachable_base
82	root	1.6	{
83			void self, cb; // CF+ perl self and callback
84			const char *attach; // generic extension attachment information
85
86			void clear (); // called when free'ing objects
87			void optimise (); // possibly save some memory by destroying unneeded data
88	root	1.8
89	root	1.10	void attachable_init ()
90	root	1.8	{
91			self = cb = 0;
92			attach = 0;
93			}
94	root	1.6	};
95
96	root	1.10	// objects attachable from perl (or any other extension) should include or
97	root	1.6	// derive using the curiously recurring template pattern, to avoid
98			// virtual method calls etc.
99			template<class subclass>
100	root	1.10	struct attachable : attachable_base
101	root	1.6	{
102	root	1.8	static data_type get_dt ()
103	root	1.6	{
104	root	1.8	subclass::get_dt ();
105	root	1.6	}
106			};
107
108	root	1.7	struct object_freezer
109			{
110			const char *filename;
111			void *av;
112	root	1.8	int idx;
113
114			object_freezer (const char *filename);
115			~object_freezer ();
116
117	root	1.10	void put (attachable_base *ext);
118	root	1.8
119			template<class subclass>
120	root	1.10	void put (attachable<subclass> *obj)
121	root	1.8	{
122	root	1.10	put ((attachable_base *)obj);
123	root	1.8	}
124	root	1.7
125			void finish ();
126			};
127
128			struct object_thawer
129			{
130			void *av;
131	root	1.8	int idx;
132
133			object_thawer (const char *filename = 0);
134			~object_thawer ();
135
136	root	1.10	void get (data_type type, void obj, attachable_base ext);
137	root	1.8
138			template<class subclass>
139	root	1.10	void get (attachable<subclass> *obj)
140	root	1.8	{
141			if (av)
142			get (subclass::get_dt (), (subclass *)obj, obj);
143			}
144	root	1.3
145	root	1.7	void finish ();
146			};
147	root	1.2
148			#endif
149	root	1.3