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

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(klass, event, ...) cfperl_invoke (EVENT_ ## klass ## _ ## event, ## __VA_ARGS__, DT_END)

#define INVOKE_GLOBAL(event, ...)     INVOKE (GLOBAL, event,                  ## __VA_ARGS__)
#define INVOKE_OBJECT(event, op, ...) INVOKE (OBJECT, event, ARG_OBJECT (op), ## __VA_ARGS__)
#define INVOKE_PLAYER(event, pl, ...) INVOKE (PLAYER, event, ARG_PLAYER (pl), ## __VA_ARGS__)
#define INVOKE_MAP(event, map, ...)   INVOKE (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 extendable_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 reattach (data_type type, void *self);    // called after swapin
};

// objects extendable 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 extendable : extendable_base
{
  void reattach ()
  {
    if (attach)
      extendable_base::reattach (
         static_cast<subclass *>(this)->get_dt (),
         static_cast<subclass *>(this)
      );
  }
};

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

  object_freezer (const char *filename) : filename (filename) { }
  void put (extendable_base *object);
  void finish ();
};

struct object_thawer
{
  void *av;

  object_thawer (const char *filename);
  void get (extendable_base *object);
  void finish ();
};

#endif

Revision:	1.7
Committed:	Sat Aug 26 23:36:32 2006 UTC (17 years, 9 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.6:	+30 -35 lines
Log Message:	intermediate check-in, per-object events work
#	Content
1	//
2	// cfperl.h perl interface
3	//
4	#ifndef CFPERL_H__
5	#define CFPERL_H__
6
7	struct pl;
8	struct object;
9	struct mapstruct;
10
11	void cfperl_init ();
12	void cfperl_main ();
13
14	// could have used templates, but a more traditional C api
15	// uses more explicit typing which is ok for this purpose.
16	enum data_type
17	{
18	DT_END, // no further arguments
19	DT_INT,
20	DT_INT64,
21	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	DT_AV, // av that needs to be flattened out
31	};
32
33	enum event_klass
34	{
35	KLASS_GLOBAL,
36	KLASS_PLAYER,
37	KLASS_OBJECT,
38	KLASS_MAP,
39	};
40
41	enum event_type
42	{
43	# define def(klass,name) EVENT_ ## klass ## _ ## name,
44	# include "eventinc.h"
45	# undef def
46	NUM_EVENT_TYPES
47	};
48
49	#define ARG_INT(v) DT_INT , static_cast<int> (v)
50	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
51	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
52	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
53	#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), (l)
54	#define ARG_OBJECT(o) DT_OBJECT, (void )static_cast<struct object > (o)
55	#define ARG_MAP(o) DT_MAP , (void )static_cast<struct mapstruct > (o)
56	#define ARG_PLAYER(o) DT_PLAYER, (void )static_cast<struct pl > (o)
57	#define ARG_ARCH(o) DT_ARCH , (void )static_cast<struct archetype > (o)
58	#define ARG_PARTY(o) DT_PARTY , (void )static_cast<struct party > (o)
59	#define ARG_REGION(o) DT_REGION, (void )static_cast<struct region > (o)
60
61	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
62
63	// all these return true when the normal event processing should be skipped (if any)
64	#define INVOKE(klass, event, ...) cfperl_invoke (EVENT_ ## klass ## _ ## event, ## __VA_ARGS__, DT_END)
65
66	#define INVOKE_GLOBAL(event, ...) INVOKE (GLOBAL, event, ## __VA_ARGS__)
67	#define INVOKE_OBJECT(event, op, ...) INVOKE (OBJECT, event, ARG_OBJECT (op), ## __VA_ARGS__)
68	#define INVOKE_PLAYER(event, pl, ...) INVOKE (PLAYER, event, ARG_PLAYER (pl), ## __VA_ARGS__)
69	#define INVOKE_MAP(event, map, ...) INVOKE (MAP , event, ARG_MAP (map) , ## __VA_ARGS__)
70
71	//TODO should index into @result
72	#define RESULT(idx,type) cfperl_result_ ## type (idx)
73	#define RESULT_INT(idx) RESULT(idx, INT)
74
75	bool cfperl_invoke (event_type event, ...);
76	int cfperl_result_INT (int idx);
77
78	struct extendable_base
79	{
80	void self, cb; // CF+ perl self and callback
81	const char *attach; // generic extension attachment information
82
83	void clear (); // called when free'ing objects
84	void optimise (); // possibly save some memory by destroying unneeded data
85	void reattach (data_type type, void *self); // called after swapin
86	};
87
88	// objects extendable from perl (or any other extension) should include or
89	// derive using the curiously recurring template pattern, to avoid
90	// virtual method calls etc.
91	template<class subclass>
92	struct extendable : extendable_base
93	{
94	void reattach ()
95	{
96	if (attach)
97	extendable_base::reattach (
98	static_cast<subclass *>(this)->get_dt (),
99	static_cast<subclass *>(this)
100	);
101	}
102	};
103
104	struct object_freezer
105	{
106	const char *filename;
107	void *av;
108
109	object_freezer (const char *filename) : filename (filename) { }
110	void put (extendable_base *object);
111	void finish ();
112	};
113
114	struct object_thawer
115	{
116	void *av;
117
118	object_thawer (const char *filename);
119	void get (extendable_base *object);
120	void finish ();
121	};
122
123	#endif
124