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 instantiate (data_type type, void *obj);

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

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

struct object_freezethaw
{
  void *av;
  FILE *fp;
};

struct object_freezer : object_freezethaw
{
  void *filename;

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

  void put (attachable_base *ext);

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

  operator bool () { return !!fp; }
};

struct object_thawer : object_freezethaw
{
  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);
  }

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

int fprintf (object_freezer &freezer, const char *format, ...);
int fputs (const char *s, object_freezer &freezer);

#endif

Revision:	1.15
Committed:	Wed Aug 30 11:02:15 2006 UTC (17 years, 8 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.14:	+7 -2 lines
Log Message:	introduce overhead in the hope of decreasing it at some point
#	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_AV, // perl-only av that needs to be flattened out
20	DT_INT,
21	DT_INT64,
22	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
32	NUM_DATA_TYPES
33	};
34
35	enum event_klass
36	{
37	KLASS_NONE,
38	KLASS_GLOBAL,
39	KLASS_PLAYER,
40	KLASS_OBJECT,
41	KLASS_MAP,
42	};
43
44	enum event_type
45	{
46	# define def(klass,name) EVENT_ ## klass ## _ ## name,
47	# include "eventinc.h"
48	# undef def
49	NUM_EVENT_TYPES
50	};
51
52	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
53	#define ARG_INT(v) DT_INT , static_cast<int> (v)
54	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
55	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
56	#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	#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
65	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
66
67	// all these return true when the normal event processing should be skipped (if any)
68	#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
69
70	#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
76	//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	struct attachable_base
84	{
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	void instantiate (data_type type, void *obj);
91
92	void attachable_init ()
93	{
94	self = cb = 0;
95	attach = 0;
96	}
97	};
98
99	// objects attachable from perl (or any other extension) should include or
100	// derive using the curiously recurring template pattern, to avoid
101	// virtual method calls etc.
102	template<class subclass>
103	struct attachable : attachable_base
104	{
105	static data_type get_dt ()
106	{
107	return subclass::get_dt ();
108	}
109
110	void instantiate ()
111	{
112	if (attach)
113	attachable_base::instantiate (get_dt (), static_cast<subclass *>(this));
114	}
115	};
116
117	struct object_freezethaw
118	{
119	void *av;
120	FILE *fp;
121	};
122
123	struct object_freezer : object_freezethaw
124	{
125	void *filename;
126
127	object_freezer (const char *filename);
128	~object_freezer ();
129
130	void put (attachable_base *ext);
131
132	template<class subclass>
133	void put (attachable<subclass> *obj)
134	{
135	put ((attachable_base *)obj);
136	}
137
138	operator bool () { return !!fp; }
139	};
140
141	struct object_thawer : object_freezethaw
142	{
143	object_thawer (const char *filename = 0);
144	~object_thawer ();
145
146	void get (data_type type, void obj, attachable_base ext, int oid);
147
148	template<class subclass>
149	void get (attachable<subclass> *obj, int oid)
150	{
151	if (av)
152	get (subclass::get_dt (), (subclass *)obj, obj, oid);
153	}
154
155	operator FILE *() { return fp; }
156	};
157
158	int fprintf (object_freezer &freezer, const char *format, ...);
159	int fputs (const char *s, object_freezer &freezer);
160
161	#endif
162