ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/cfperl.h
Revision: 1.17
Committed: Thu Aug 31 06:23:19 2006 UTC (17 years, 8 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.16: +27 -16 lines
Log Message:
*** empty log message ***

File Contents

# 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 struct pl;
33 struct object;
34 struct mapstruct;
35
36 void cfperl_init ();
37 void cfperl_boot ();
38 void cfperl_main ();
39
40 // could have used templates, but a more traditional C api
41 // uses more explicit typing which is ok for this purpose.
42 enum data_type
43 {
44 DT_END, // no further arguments
45 DT_AV, // perl-only av that needs to be flattened out
46 DT_INT,
47 DT_INT64,
48 DT_DOUBLE,
49 DT_STRING, // 0-terminated string
50 DT_DATA, // string + length
51 DT_OBJECT,
52 DT_MAP,
53 DT_PLAYER,
54 DT_ARCH,
55 DT_PARTY,
56 DT_REGION,
57
58 NUM_DATA_TYPES
59 };
60
61 enum event_klass
62 {
63 KLASS_NONE,
64 KLASS_GLOBAL,
65 KLASS_PLAYER,
66 KLASS_OBJECT,
67 KLASS_MAP,
68 };
69
70 enum event_type
71 {
72 # define def(klass,name) EVENT_ ## klass ## _ ## name,
73 # include "eventinc.h"
74 # undef def
75 NUM_EVENT_TYPES
76 };
77
78 #define ARG_AV(o) DT_AV , static_cast<AV *> (o)
79 #define ARG_INT(v) DT_INT , static_cast<int> (v)
80 #define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
81 #define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
82 #define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
83 #define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), (l)
84 #define ARG_OBJECT(o) DT_OBJECT, (void *)static_cast<struct object *> (o)
85 #define ARG_MAP(o) DT_MAP , (void *)static_cast<struct mapstruct *> (o)
86 #define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<struct pl *> (o)
87 #define ARG_ARCH(o) DT_ARCH , (void *)static_cast<struct archetype *> (o)
88 #define ARG_PARTY(o) DT_PARTY , (void *)static_cast<struct party *> (o)
89 #define ARG_REGION(o) DT_REGION, (void *)static_cast<struct region *> (o)
90
91 // the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
92
93 // all these return true when the normal event processing should be skipped (if any)
94 #define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
95
96 #define INVOKE(klass, event, ...) INVOKE_(EVENT_ ## klass ## _ ## event, ## __VA_ARGS__)
97 #define INVOKE_GLOBAL(event, ...) INVOKE_(EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
98 #define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__)
99 #define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__)
100 #define INVOKE_MAP(event, map, ...) INVOKE_(EVENT_ ## MAP ## _ ## event, ARG_MAP (map) , ## __VA_ARGS__)
101
102 //TODO should index into @result
103 #define RESULT(idx,type) cfperl_result_ ## type (idx)
104 #define RESULT_INT(idx) RESULT(idx, INT)
105
106 bool cfperl_invoke (event_type event, ...);
107 int cfperl_result_INT (int idx);
108
109 struct attachable_base
110 {
111 SV *self;
112 AV *cb; // CF+ perl self and callback
113 const char *attach; // generic extension attachment information
114
115 void clear (); // called when free'ing objects
116 void optimise (); // possibly save some memory by destroying unneeded data
117 void instantiate (data_type type, void *obj);
118
119 void attachable_init ()
120 {
121 self = 0;
122 cb = 0;
123 attach = 0;
124 }
125 };
126
127 // objects attachable from perl (or any other extension) should include or
128 // derive using the curiously recurring template pattern, to avoid
129 // virtual method calls etc.
130 template<class subclass>
131 struct attachable : attachable_base
132 {
133 static data_type get_dt ()
134 {
135 return subclass::get_dt ();
136 }
137
138 void instantiate ()
139 {
140 if (attach)
141 attachable_base::instantiate (get_dt (), static_cast<subclass *>(this));
142 }
143 };
144
145 struct object_freezer
146 {
147 AV *av;
148 SV *text;
149
150 object_freezer ();
151 ~object_freezer ();
152
153 void put (attachable_base *ext);
154
155 template<class subclass>
156 void put (attachable<subclass> *obj)
157 {
158 put ((attachable_base *)obj);
159 }
160
161 bool save (const char *filename);
162
163 operator bool () { return !!av; }
164 };
165
166 // compatibility support, should be removed when no longer needed
167 int fprintf (object_freezer &freezer, const char *format, ...);
168 int fputs (const char *s, object_freezer &freezer);
169
170 // a single key-value line from a file
171 struct token {
172 keyword k;
173 const char *v;
174
175 token (keyword k, const char *v = 0) : k(k), v(v) { }
176 };
177
178 struct object_thawer
179 {
180 AV *av;
181 FILE *fp;
182 char line[1024];
183
184 object_thawer (const char *filename = 0);
185 ~object_thawer ();
186
187 void get (data_type type, void *obj, attachable_base *ext, int oid);
188
189 template<class subclass>
190 void get (attachable<subclass> *obj, int oid)
191 {
192 if (av)
193 get (subclass::get_dt (), (subclass *)obj, obj, oid);
194 }
195
196 token get_token ();
197
198 operator FILE *() { return fp; }
199 };
200
201 #endif
202