ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/plugins/cfperl/cfperl.xs
Revision: 1.5
Committed: Fri Feb 3 19:49:32 2006 UTC (18 years, 5 months ago) by root
Branch: MAIN
Changes since 1.4: +20 -5 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.1 /*****************************************************************************/
2     /* That code is placed under the GNU General Public Licence (GPL) */
3     /* (C)2001-2005 by Chachkoff Yann (Feel free to deliver your complaints) */
4     /*****************************************************************************/
5     /* CrossFire, A Multiplayer game for X-windows */
6     /* */
7     /* Copyright (C) 2000 Mark Wedel */
8     /* Copyright (C) 1992 Frank Tore Johansen */
9     /* Copyright (C) 2006 perl plugin by Marc Lehmann <cf@schmorpd.e> */
10     /* */
11     /* This program is free software; you can redistribute it and/or modify */
12     /* it under the terms of the GNU General Public License as published by */
13     /* the Free Software Foundation; either version 2 of the License, or */
14     /* (at your option) any later version. */
15     /* */
16     /* This program is distributed in the hope that it will be useful, */
17     /* but WITHOUT ANY WARRANTY; without even the implied warranty of */
18     /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
19     /* GNU General Public License for more details. */
20     /* */
21     /* You should have received a copy of the GNU General Public License */
22     /* along with this program; if not, write to the Free Software */
23     /* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */
24     /* */
25     /*****************************************************************************/
26    
27     #include <EXTERN.h>
28     #include <perl.h>
29     #include <XSUB.h>
30    
31     #undef save_long // clashes with libproto.h
32    
33     #define PLUGIN_NAME "cfperl"
34     #define PLUGIN_VERSION "cfperl 0.0"
35    
36     #ifndef __CEXTRACT__
37     #include <plugin.h>
38     #endif
39    
40     #undef MODULEAPI
41     #ifdef WIN32
42     #else
43     #define MODULEAPI
44     #endif
45    
46     #include <plugin_common.h>
47    
48     #include <stdarg.h>
49    
50     #include "perlxsi.c"
51    
52     static f_plug_api gethook;
53     static f_plug_api registerGlobalEvent;
54     static f_plug_api unregisterGlobalEvent;
55     static f_plug_api systemDirectory;
56    
57     typedef struct
58     {
59     object* who;
60     object* activator;
61     object* third;
62     char message[1024];
63     int fix;
64     int event_code;
65     char options[1024];
66     int returnvalue;
67     } CFPContext;
68    
69     //static int current_command = -999;
70    
71     static PerlInterpreter *perl;
72    
73     //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
74    
75     static SV *
76     newSVptr (void *ptr, const char *klass)
77     {
78     if (!ptr)
79     return &PL_sv_undef;
80    
81     HV *hv = newHV ();
82     sv_magic ((SV *)hv, 0, PERL_MAGIC_ext, (char *)ptr, 0);
83     return sv_bless (newRV_noinc ((SV *)hv), gv_stashpv (klass, 1));
84     }
85    
86     static void
87     clearSVptr (SV *sv)
88     {
89     if (SvROK (sv))
90     sv = SvRV (sv);
91    
92     hv_clear ((HV *)sv);
93     sv_unmagic (sv, PERL_MAGIC_ext);
94     }
95    
96     static long
97     SvPTR (SV *sv, const char *klass)
98     {
99     if (!sv_derived_from (sv, klass))
100     croak ("object of type %s expected", klass);
101    
102     MAGIC *mg = mg_find (SvRV (sv), PERL_MAGIC_ext);
103    
104     if (!mg)
105     croak ("perl code used %s object, but C object is already destroyed, caught", klass);
106    
107     return (long)mg->mg_ptr;
108     }
109    
110     SV *
111     newSVcfapi (int type, ...)
112     {
113     SV *sv;
114    
115     va_list args;
116     va_start (args, type);
117    
118     switch (type)
119     {
120     case CFAPI_INT:
121     sv = newSViv (*va_arg (args, int *));
122     break;
123    
124     case CFAPI_LONG:
125     sv = newSViv (*va_arg (args, long *));
126     break;
127    
128     case CFAPI_DOUBLE:
129     sv = newSViv (*va_arg (args, double *));
130     break;
131    
132     case CFAPI_STRING:
133     sv = newSVpv (va_arg (args, char *), 0);
134     break;
135    
136     case CFAPI_POBJECT:
137     {
138     object *obj = va_arg (args, object *);
139    
140     if (!obj)
141     sv = &PL_sv_undef;
142     else
143     switch (*(int *)cf_object_get_property (obj, CFAPI_OBJECT_PROP_TYPE))
144     {
145     case MAP:
146     sv = newSVptr (obj, "cf::object::map");
147     break;
148    
149     case PLAYER:
150     sv = newSVptr (obj, "cf::object::player");
151     break;
152    
153     default:
154     sv = newSVptr (obj, "cf::object");
155     break;
156     }
157     }
158     break;
159    
160     case CFAPI_PMAP:
161     sv = newSVptr (va_arg (args, object *), "cf::map");
162     break;
163    
164     case CFAPI_PPLAYER:
165     sv = newSVptr (va_arg (args, object *), "cf::player");
166     break;
167    
168     case CFAPI_PARCH:
169     sv = newSVptr (va_arg (args, object *), "cf::arch");
170     break;
171    
172     case CFAPI_PPARTY:
173     sv = newSVptr (va_arg (args, object *), "cf::party");
174     break;
175    
176     case CFAPI_PREGION:
177     sv = newSVptr (va_arg (args, object *), "cf::region");
178     break;
179    
180     default:
181     assert (("unhandled type in newSVcfapi", 0));
182     }
183    
184     va_end (args);
185    
186     return sv;
187     }
188    
189     /////////////////////////////////////////////////////////////////////////////
190    
191     void
192     inject_event (CFPContext *context)
193     {
194     dSP;
195    
196     ENTER;
197     SAVETMPS;
198    
199     PUSHMARK (SP);
200    
201     EXTEND (SP, 2);
202     //PUSHs (sv_2mortal (newSViv (type)));
203    
204     HV *hv = newHV ();
205     #define hv_context(type,addr,expr) hv_store (hv, #expr, sizeof (#expr) - 1, newSVcfapi (type, addr context->expr), 0)
206     hv_context (CFAPI_POBJECT, ,who);
207     hv_context (CFAPI_POBJECT, ,activator);
208     hv_context (CFAPI_POBJECT, ,third);
209     hv_context (CFAPI_STRING , ,message);
210     hv_context (CFAPI_INT ,&,fix);
211     hv_context (CFAPI_INT ,&,event_code);
212     hv_context (CFAPI_STRING , ,options);
213    
214     PUSHs (sv_2mortal (newRV_noinc ((SV *)hv)));
215    
216     PUTBACK;
217     int count = call_pv ("cf::inject_event", G_SCALAR | G_EVAL);
218     SPAGAIN;
219    
220     context->returnvalue = count > 0 ? POPi : 0;
221    
222     PUTBACK;
223     FREETMPS;
224     LEAVE;
225    
226     if (SvTRUE (ERRSV))
227     LOG (llevError, "event '%d' callback evaluation error: %s", context->event_code, SvPV_nolen (ERRSV));
228     }
229    
230     /////////////////////////////////////////////////////////////////////////////
231    
232     int
233     initPlugin (const char *iversion, f_plug_api gethooksptr)
234     {
235     gethook = gethooksptr;
236     printf (PLUGIN_VERSION " init\n");
237    
238     return 0;
239     }
240    
241     static CommArray_s rtn_cmd;
242    
243     int
244     runPluginCommand (object *obj, char *params)
245     {
246     dSP;
247    
248     ENTER;
249     SAVETMPS;
250    
251     PUSHMARK (SP);
252    
253     EXTEND (SP, 3);
254     PUSHs (sv_2mortal (newSVpv (rtn_cmd.name, 0)));
255     PUSHs (sv_2mortal (newSVcfapi (CFAPI_POBJECT, obj)));
256    
257     if (params)
258     PUSHs (sv_2mortal (newSVpv (params, 0)));
259    
260     PUTBACK;
261     int count = call_pv ("cf::inject_command", G_SCALAR | G_EVAL);
262     SPAGAIN;
263    
264     int returnvalue = count > 0 ? POPi : -1;
265    
266     PUTBACK;
267     FREETMPS;
268     LEAVE;
269    
270     if (SvTRUE (ERRSV))
271     LOG (llevError, "command '%s' callback evaluation error: %s", rtn_cmd.name, SvPV_nolen (ERRSV));
272    
273     return returnvalue;
274     }
275    
276     void *
277     getPluginProperty (int *type, ...)
278     {
279     va_list args;
280     char *propname;
281     int i;
282     va_start (args, type);
283     propname = va_arg (args, char *);
284     //printf ("Property name: %s\n", propname);
285 root 1.3
286 root 1.1 if (!strcmp (propname, "command?"))
287     {
288 root 1.3 if (!perl)
289     return NULL;
290    
291 root 1.1 const char *cmdname = va_arg (args, const char *);
292     HV *hv = get_hv ("cf::COMMAND", 1);
293     SV **svp = hv_fetch (hv, cmdname, strlen (cmdname) + 1, 0);
294    
295     va_end (args);
296    
297     if (svp)
298     {
299     // this is totaly broken, should stash it into %COMMAND
300     rtn_cmd.name = cmdname;
301     rtn_cmd.time = SvNV (*svp);
302     rtn_cmd.func = runPluginCommand;
303    
304     return &rtn_cmd;
305     }
306     }
307     else if (!strcmp (propname, "Identification"))
308     {
309     va_end (args);
310     return PLUGIN_NAME;
311     }
312     else if (!strcmp (propname, "FullName"))
313     {
314     va_end (args);
315     return PLUGIN_VERSION;
316     }
317     else
318     va_end (args);
319    
320     return NULL;
321     }
322    
323     void *globalEventListener (int *type, ...);
324    
325     int
326     postInitPlugin ()
327     {
328     int hooktype = 1;
329     int rtype = 0;
330    
331     printf (PLUGIN_VERSION " post init\n");
332    
333     registerGlobalEvent = gethook (&rtype, hooktype, "cfapi_system_register_global_event");
334     unregisterGlobalEvent = gethook (&rtype, hooktype, "cfapi_system_unregister_global_event");
335     systemDirectory = gethook (&rtype, hooktype, "cfapi_system_directory");
336     cf_init_plugin (gethook);
337    
338     /* Pick the global events you want to monitor from this plugin */
339     registerGlobalEvent (NULL, EVENT_BORN, PLUGIN_NAME, globalEventListener);
340     registerGlobalEvent (NULL, EVENT_CLOCK, PLUGIN_NAME, globalEventListener);
341     //registerGlobalEvent (NULL, EVENT_CRASH, PLUGIN_NAME, globalEventListener);
342     registerGlobalEvent (NULL, EVENT_PLAYER_DEATH, PLUGIN_NAME, globalEventListener);
343     registerGlobalEvent (NULL, EVENT_GKILL, PLUGIN_NAME, globalEventListener);
344     registerGlobalEvent (NULL, EVENT_LOGIN, PLUGIN_NAME, globalEventListener);
345     registerGlobalEvent (NULL, EVENT_LOGOUT, PLUGIN_NAME, globalEventListener);
346     registerGlobalEvent (NULL, EVENT_MAPENTER, PLUGIN_NAME, globalEventListener);
347     registerGlobalEvent (NULL, EVENT_MAPLEAVE, PLUGIN_NAME, globalEventListener);
348     registerGlobalEvent (NULL, EVENT_MAPRESET, PLUGIN_NAME, globalEventListener);
349     registerGlobalEvent (NULL, EVENT_REMOVE, PLUGIN_NAME, globalEventListener);
350     registerGlobalEvent (NULL, EVENT_SHOUT, PLUGIN_NAME, globalEventListener);
351     registerGlobalEvent (NULL, EVENT_TELL, PLUGIN_NAME, globalEventListener);
352     registerGlobalEvent (NULL, EVENT_MUZZLE, PLUGIN_NAME, globalEventListener);
353     registerGlobalEvent (NULL, EVENT_KICK, PLUGIN_NAME, globalEventListener);
354    
355     char *argv[] = {
356     "",
357     "-e"
358     "BEGIN {"
359     " cf->bootstrap;"
360 root 1.5 " unshift @INC, cf::datadir ();"
361 root 1.1 "}"
362     ""
363     "use cf;"
364     };
365    
366     perl = perl_alloc ();
367     perl_construct (perl);
368    
369 root 1.5 if (perl_parse (perl, xs_init, 2, argv, (char **)NULL) || perl_run (perl))
370 root 1.1 {
371     printf ("unable to initialize perl-interpreter, continuing without.\n");
372    
373     perl_destruct (perl);
374     perl_free (perl);
375     perl = 0;
376     }
377    
378     return 0;
379     }
380    
381     void *
382     globalEventListener (int *type, ...)
383     {
384     va_list args;
385     static int rv = 0;
386     CFPContext context;
387     char *buf;
388     player *pl;
389     object *op;
390    
391     if (!perl)
392     return;
393    
394     memset (&context, 0, sizeof (context));
395    
396     va_start (args, type);
397     context.event_code = va_arg (args, int);
398    
399     switch (context.event_code)
400     {
401     case EVENT_CRASH:
402     printf ("Unimplemented for now\n");
403     break;
404    
405     case EVENT_BORN:
406     context.activator = va_arg (args, object *);
407     break;
408    
409     case EVENT_PLAYER_DEATH:
410     context.who = va_arg (args, object *);
411     break;
412    
413     case EVENT_GKILL:
414     context.who = va_arg (args, object *);
415     context.activator = va_arg (args, object *);
416     break;
417    
418     case EVENT_LOGIN:
419     pl = va_arg (args, player *);
420     context.activator = pl->ob;
421     buf = va_arg (args, char *);
422     if (buf != 0)
423     strcpy (context.message, buf);
424     break;
425    
426     case EVENT_LOGOUT:
427     pl = va_arg (args, player *);
428     context.activator = pl->ob;
429     buf = va_arg (args, char *);
430     if (buf != 0)
431     strcpy (context.message, buf);
432     break;
433    
434     case EVENT_REMOVE:
435     context.activator = va_arg (args, object *);
436     break;
437    
438     case EVENT_SHOUT:
439     context.activator = va_arg (args, object *);
440     buf = va_arg (args, char *);
441     if (buf != 0)
442     strcpy (context.message, buf);
443     break;
444    
445     case EVENT_MUZZLE:
446     context.activator = va_arg (args, object *);
447     buf = va_arg (args, char *);
448     if (buf != 0)
449     strcpy (context.message, buf);
450     break;
451    
452     case EVENT_KICK:
453     context.activator = va_arg (args, object *);
454     buf = va_arg (args, char *);
455     if (buf != 0)
456     strcpy (context.message, buf);
457     break;
458    
459     case EVENT_MAPENTER:
460     context.activator = va_arg (args, object *);
461     break;
462    
463     case EVENT_MAPLEAVE:
464     context.activator = va_arg (args, object *);
465     break;
466    
467     case EVENT_CLOCK:
468     break;
469    
470     case EVENT_MAPRESET:
471     buf = va_arg (args, char *);
472     if (buf != 0)
473     strcpy (context.message, buf);
474     break;
475    
476     case EVENT_TELL:
477     break;
478     }
479    
480     va_end (args);
481    
482     inject_event (&context);
483    
484     rv = context.returnvalue;
485    
486     return &rv;
487     }
488    
489     void *
490     eventListener (int *type, ...)
491     {
492     static int rv = 0;
493     va_list args;
494     char *buf;
495     CFPContext context;
496    
497     if (!perl)
498     return;
499    
500     memset (&context, 0, sizeof (context));
501    
502     va_start (args, type);
503    
504     context.who = va_arg (args, object *);
505     context.event_code = va_arg (args, int);
506     context.activator = va_arg (args, object *);
507     context.third = va_arg (args, object *);
508     buf = va_arg (args, char *);
509    
510     if (buf != 0)
511     strcpy (context.message, buf);
512    
513     context.fix = va_arg (args, int);
514     strcpy (context.options, va_arg (args, char *));
515     context.returnvalue = 0;
516     va_end (args);
517    
518     inject_event (&context);
519    
520     rv = context.returnvalue;
521     return &rv;
522     }
523    
524     int
525     closePlugin ()
526     {
527     printf (PLUGIN_VERSION " closing\n");
528    
529     if (perl)
530     {
531     perl_destruct (perl);
532     perl_free (perl);
533     perl = 0;
534     }
535    
536     return 0;
537     }
538    
539     MODULE = cf PACKAGE = cf PREFIX = cf_
540    
541     BOOT:
542     {
543     HV *stash = gv_stashpv ("cf", 1);
544    
545     const struct {
546     const char *name;
547     IV iv;
548     } *civ, const_iv[] = {
549     # define const_iv(name) { # name, (IV)name },
550     const_iv (llevError)
551     const_iv (llevInfo)
552     const_iv (llevDebug)
553     const_iv (llevMonster)
554    
555     const_iv (PLAYER)
556     const_iv (ROD)
557     const_iv (TREASURE)
558     const_iv (POTION)
559     const_iv (FOOD)
560     const_iv (POISON)
561     const_iv (BOOK)
562     const_iv (CLOCK)
563     const_iv (LIGHTNING)
564     const_iv (ARROW)
565     const_iv (BOW)
566     const_iv (WEAPON)
567     const_iv (ARMOUR)
568     const_iv (PEDESTAL)
569     const_iv (ALTAR)
570     const_iv (CONFUSION)
571     const_iv (LOCKED_DOOR)
572     const_iv (SPECIAL_KEY)
573     const_iv (MAP)
574     const_iv (DOOR)
575     const_iv (KEY)
576     const_iv (TIMED_GATE)
577     const_iv (TRIGGER)
578     const_iv (GRIMREAPER)
579     const_iv (MAGIC_EAR)
580     const_iv (TRIGGER_BUTTON)
581     const_iv (TRIGGER_ALTAR)
582     const_iv (TRIGGER_PEDESTAL)
583     const_iv (SHIELD)
584     const_iv (HELMET)
585     const_iv (HORN)
586     const_iv (MONEY)
587     const_iv (CLASS)
588     const_iv (GRAVESTONE)
589     const_iv (AMULET)
590     const_iv (PLAYERMOVER)
591     const_iv (TELEPORTER)
592     const_iv (CREATOR)
593     const_iv (SKILL)
594     const_iv (EXPERIENCE)
595     const_iv (EARTHWALL)
596     const_iv (GOLEM)
597     const_iv (THROWN_OBJ)
598     const_iv (BLINDNESS)
599     const_iv (GOD)
600     const_iv (DETECTOR)
601     const_iv (TRIGGER_MARKER)
602     const_iv (DEAD_OBJECT)
603     const_iv (DRINK)
604     const_iv (MARKER)
605     const_iv (HOLY_ALTAR)
606     const_iv (PLAYER_CHANGER)
607     const_iv (BATTLEGROUND)
608     const_iv (PEACEMAKER)
609     const_iv (GEM)
610     const_iv (FIREWALL)
611     const_iv (ANVIL)
612     const_iv (CHECK_INV)
613     const_iv (MOOD_FLOOR)
614     const_iv (EXIT)
615     const_iv (ENCOUNTER)
616     const_iv (SHOP_FLOOR)
617     const_iv (SHOP_MAT)
618     const_iv (RING)
619     const_iv (FLOOR)
620     const_iv (FLESH)
621     const_iv (INORGANIC)
622     const_iv (SKILL_TOOL)
623     const_iv (LIGHTER)
624     const_iv (TRAP_PART)
625     const_iv (WALL)
626     const_iv (LIGHT_SOURCE)
627     const_iv (MISC_OBJECT)
628     const_iv (MONSTER)
629     const_iv (SPAWN_GENERATOR)
630     const_iv (LAMP)
631     const_iv (DUPLICATOR)
632     const_iv (TOOL)
633     const_iv (SPELLBOOK)
634     const_iv (BUILDFAC)
635     const_iv (CLOAK)
636     const_iv (SPINNER)
637     const_iv (GATE)
638     const_iv (BUTTON)
639     const_iv (CF_HANDLE)
640     const_iv (HOLE)
641     const_iv (TRAPDOOR)
642     const_iv (SIGN)
643     const_iv (BOOTS)
644     const_iv (GLOVES)
645     const_iv (SPELL)
646     const_iv (SPELL_EFFECT)
647     const_iv (CONVERTER)
648     const_iv (BRACERS)
649     const_iv (POISONING)
650     const_iv (SAVEBED)
651     const_iv (POISONCLOUD)
652     const_iv (FIREHOLES)
653     const_iv (WAND)
654     const_iv (SCROLL)
655     const_iv (DIRECTOR)
656     const_iv (GIRDLE)
657     const_iv (FORCE)
658     const_iv (POTION_EFFECT)
659     const_iv (EVENT_CONNECTOR)
660     const_iv (CLOSE_CON)
661     const_iv (CONTAINER)
662     const_iv (ARMOUR_IMPROVER)
663     const_iv (WEAPON_IMPROVER)
664     const_iv (SKILLSCROLL)
665     const_iv (DEEP_SWAMP)
666     const_iv (IDENTIFY_ALTAR)
667     const_iv (MENU)
668     const_iv (RUNE)
669     const_iv (TRAP)
670     const_iv (POWER_CRYSTAL)
671     const_iv (CORPSE)
672     const_iv (DISEASE)
673     const_iv (SYMPTOM)
674     const_iv (BUILDER)
675     const_iv (MATERIAL)
676     const_iv (ITEM_TRANSFORMER)
677     const_iv (QUEST)
678    
679     const_iv (ST_BD_BUILD)
680     const_iv (ST_BD_REMOVE)
681     const_iv (ST_MAT_FLOOR)
682     const_iv (ST_MAT_WALL)
683     const_iv (ST_MAT_ITEM)
684    
685     const_iv (QUEST_IN_PROGRESS)
686     const_iv (QUEST_DONE_QUEST)
687     const_iv (QUEST_DONE_TASK)
688     const_iv (QUEST_START_QUEST)
689     const_iv (QUEST_END_QUEST)
690     const_iv (QUEST_START_TASK)
691     const_iv (QUEST_END_TASK)
692     const_iv (QUEST_OVERRIDE)
693     const_iv (QUEST_ON_ACTIVATE)
694    
695     const_iv (WEAP_HIT)
696     const_iv (WEAP_SLASH)
697     const_iv (WEAP_PIERCE)
698     const_iv (WEAP_CLEAVE)
699     const_iv (WEAP_SLICE)
700     const_iv (WEAP_STAB)
701     const_iv (WEAP_WHIP)
702     const_iv (WEAP_CRUSH)
703     const_iv (WEAP_BLUD)
704    
705     const_iv (FLAG_ALIVE)
706     const_iv (FLAG_WIZ)
707     const_iv (FLAG_REMOVED)
708     const_iv (FLAG_FREED)
709     const_iv (FLAG_WAS_WIZ)
710     const_iv (FLAG_APPLIED)
711     const_iv (FLAG_UNPAID)
712     const_iv (FLAG_USE_SHIELD)
713     const_iv (FLAG_NO_PICK)
714     const_iv (FLAG_ANIMATE)
715     const_iv (FLAG_MONSTER)
716     const_iv (FLAG_FRIENDLY)
717     const_iv (FLAG_GENERATOR)
718     const_iv (FLAG_IS_THROWN)
719     const_iv (FLAG_AUTO_APPLY)
720     const_iv (FLAG_TREASURE)
721     const_iv (FLAG_PLAYER_SOLD)
722     const_iv (FLAG_SEE_INVISIBLE)
723     const_iv (FLAG_CAN_ROLL)
724     const_iv (FLAG_OVERLAY_FLOOR)
725     const_iv (FLAG_IS_TURNABLE)
726     const_iv (FLAG_IS_USED_UP)
727     const_iv (FLAG_IDENTIFIED)
728     const_iv (FLAG_REFLECTING)
729     const_iv (FLAG_CHANGING)
730     const_iv (FLAG_SPLITTING)
731     const_iv (FLAG_HITBACK)
732     const_iv (FLAG_STARTEQUIP)
733     const_iv (FLAG_BLOCKSVIEW)
734     const_iv (FLAG_UNDEAD)
735     const_iv (FLAG_SCARED)
736     const_iv (FLAG_UNAGGRESSIVE)
737     const_iv (FLAG_REFL_MISSILE)
738     const_iv (FLAG_REFL_SPELL)
739     const_iv (FLAG_NO_MAGIC)
740     const_iv (FLAG_NO_FIX_PLAYER)
741     const_iv (FLAG_IS_LIGHTABLE)
742     const_iv (FLAG_TEAR_DOWN)
743     const_iv (FLAG_RUN_AWAY)
744     const_iv (FLAG_PICK_UP)
745     const_iv (FLAG_UNIQUE)
746     const_iv (FLAG_NO_DROP)
747     const_iv (FLAG_WIZCAST)
748     const_iv (FLAG_CAST_SPELL)
749     const_iv (FLAG_USE_SCROLL)
750     const_iv (FLAG_USE_RANGE)
751     const_iv (FLAG_USE_BOW)
752     const_iv (FLAG_USE_ARMOUR)
753     const_iv (FLAG_USE_WEAPON)
754     const_iv (FLAG_USE_RING)
755     const_iv (FLAG_READY_RANGE)
756     const_iv (FLAG_READY_BOW)
757     const_iv (FLAG_XRAYS)
758     const_iv (FLAG_NO_APPLY)
759     const_iv (FLAG_IS_FLOOR)
760     const_iv (FLAG_LIFESAVE)
761     const_iv (FLAG_NO_STRENGTH)
762     const_iv (FLAG_SLEEP)
763     const_iv (FLAG_STAND_STILL)
764     const_iv (FLAG_RANDOM_MOVE)
765     const_iv (FLAG_ONLY_ATTACK)
766     const_iv (FLAG_CONFUSED)
767     const_iv (FLAG_STEALTH)
768     const_iv (FLAG_WIZPASS)
769     const_iv (FLAG_IS_LINKED)
770     const_iv (FLAG_CURSED)
771     const_iv (FLAG_DAMNED)
772     const_iv (FLAG_SEE_ANYWHERE)
773     const_iv (FLAG_KNOWN_MAGICAL)
774     const_iv (FLAG_KNOWN_CURSED)
775     const_iv (FLAG_CAN_USE_SKILL)
776     const_iv (FLAG_BEEN_APPLIED)
777     const_iv (FLAG_READY_SCROLL)
778     const_iv (FLAG_USE_ROD)
779     const_iv (FLAG_USE_HORN)
780     const_iv (FLAG_MAKE_INVIS)
781     const_iv (FLAG_INV_LOCKED)
782     const_iv (FLAG_IS_WOODED)
783     const_iv (FLAG_IS_HILLY)
784     const_iv (FLAG_READY_SKILL)
785     const_iv (FLAG_READY_WEAPON)
786     const_iv (FLAG_NO_SKILL_IDENT)
787     const_iv (FLAG_BLIND)
788     const_iv (FLAG_SEE_IN_DARK)
789     const_iv (FLAG_IS_CAULDRON)
790     const_iv (FLAG_NO_STEAL)
791     const_iv (FLAG_ONE_HIT)
792     const_iv (FLAG_CLIENT_SENT)
793     const_iv (FLAG_BERSERK)
794     const_iv (FLAG_NEUTRAL)
795     const_iv (FLAG_NO_ATTACK)
796     const_iv (FLAG_NO_DAMAGE)
797     const_iv (FLAG_OBJ_ORIGINAL)
798     const_iv (FLAG_OBJ_SAVE_ON_OVL)
799     const_iv (FLAG_ACTIVATE_ON_PUSH)
800     const_iv (FLAG_ACTIVATE_ON_RELEASE)
801     const_iv (FLAG_IS_WATER)
802     const_iv (FLAG_CONTENT_ON_GEN)
803     const_iv (FLAG_IS_A_TEMPLATE)
804     const_iv (FLAG_IS_BUILDABLE)
805     const_iv (FLAG_AFK)
806     };
807    
808     for (civ = const_iv + sizeof (const_iv) / sizeof (const_iv [0]); civ-- > const_iv; )
809     newCONSTSUB (stash, (char *)civ->name, newSViv (civ->iv));
810    
811     const struct {
812     const char *name;
813     IV iv;
814     } *event, event_list[] = {
815     # define const_event(name) { # name, (IV)EVENT_ ## name },
816     const_event (NONE)
817     const_event (APPLY)
818     const_event (ATTACK)
819     const_event (DEATH)
820     const_event (DROP)
821     const_event (PICKUP)
822     const_event (SAY)
823     const_event (STOP)
824     const_event (TIME)
825     const_event (THROW)
826     const_event (TRIGGER)
827     const_event (CLOSE)
828     const_event (TIMER)
829    
830     const_event (BORN)
831     const_event (CLOCK)
832     const_event (CRASH)
833     const_event (PLAYER_DEATH)
834     const_event (GKILL)
835     const_event (LOGIN)
836     const_event (LOGOUT)
837     const_event (MAPENTER)
838     const_event (MAPLEAVE)
839     const_event (MAPRESET)
840     const_event (REMOVE)
841     const_event (SHOUT)
842     const_event (TELL)
843     const_event (MUZZLE)
844     const_event (KICK)
845     };
846    
847     AV *av = get_av ("cf::EVENT", 1);
848    
849     for (event = event_list + sizeof (event_list) / sizeof (event_list [0]); event-- > event_list; )
850     av_store (av, event->iv, newSVpv ((char *)event->name, 0));
851    
852     const struct {
853     int dtype;
854     const char *name;
855     IV idx;
856     } *cprop, prop_table[] = {
857     # define prop(type, name) { type, # name, (IV) CFAPI_ ## name },
858     prop (CFAPI_INT, MAP_PROP_FLAGS)
859     prop (CFAPI_INT, MAP_PROP_DIFFICULTY)
860     prop (CFAPI_STRING, MAP_PROP_PATH)
861     prop (CFAPI_STRING, MAP_PROP_TMPNAME)
862     prop (CFAPI_STRING, MAP_PROP_NAME)
863     prop (CFAPI_INT, MAP_PROP_RESET_TIME)
864     prop (CFAPI_INT, MAP_PROP_RESET_TIMEOUT)
865     prop (CFAPI_INT, MAP_PROP_PLAYERS)
866     prop (CFAPI_INT, MAP_PROP_DARKNESS)
867     prop (CFAPI_INT, MAP_PROP_WIDTH)
868     prop (CFAPI_INT, MAP_PROP_HEIGHT)
869     prop (CFAPI_INT, MAP_PROP_ENTER_X)
870     prop (CFAPI_INT, MAP_PROP_ENTER_Y)
871     prop (CFAPI_INT, MAP_PROP_TEMPERATURE)
872     prop (CFAPI_INT, MAP_PROP_PRESSURE)
873     prop (CFAPI_INT, MAP_PROP_HUMIDITY)
874     prop (CFAPI_INT, MAP_PROP_WINDSPEED)
875     prop (CFAPI_INT, MAP_PROP_WINDDIR)
876     prop (CFAPI_INT, MAP_PROP_SKY)
877     prop (CFAPI_INT, MAP_PROP_WPARTX)
878     prop (CFAPI_INT, MAP_PROP_WPARTY)
879     prop (CFAPI_STRING, MAP_PROP_MESSAGE)
880     prop (CFAPI_PMAP, MAP_PROP_NEXT)
881     prop (CFAPI_PREGION, MAP_PROP_REGION)
882     prop (CFAPI_POBJECT, OBJECT_PROP_OB_ABOVE)
883     prop (CFAPI_POBJECT, OBJECT_PROP_OB_BELOW)
884     prop (CFAPI_POBJECT, OBJECT_PROP_NEXT_ACTIVE_OB)
885     prop (CFAPI_POBJECT, OBJECT_PROP_PREV_ACTIVE_OB)
886     prop (CFAPI_POBJECT, OBJECT_PROP_INVENTORY)
887     prop (CFAPI_POBJECT, OBJECT_PROP_ENVIRONMENT)
888     prop (CFAPI_POBJECT, OBJECT_PROP_HEAD)
889     prop (CFAPI_POBJECT, OBJECT_PROP_CONTAINER)
890     prop (CFAPI_PMAP, OBJECT_PROP_MAP)
891     prop (CFAPI_INT, OBJECT_PROP_COUNT)
892     prop (CFAPI_INT, OBJECT_PROP_REFCOUNT)
893     prop (CFAPI_STRING, OBJECT_PROP_NAME)
894     prop (CFAPI_STRING, OBJECT_PROP_NAME_PLURAL)
895     prop (CFAPI_STRING, OBJECT_PROP_TITLE)
896     prop (CFAPI_STRING, OBJECT_PROP_RACE)
897     prop (CFAPI_STRING, OBJECT_PROP_SLAYING)
898     prop (CFAPI_STRING, OBJECT_PROP_SKILL)
899     prop (CFAPI_STRING, OBJECT_PROP_MESSAGE)
900     prop (CFAPI_STRING, OBJECT_PROP_LORE)
901     prop (CFAPI_INT, OBJECT_PROP_X)
902     prop (CFAPI_INT, OBJECT_PROP_Y)
903     prop (CFAPI_DOUBLE, OBJECT_PROP_SPEED)
904     prop (CFAPI_DOUBLE, OBJECT_PROP_SPEED_LEFT)
905     prop (CFAPI_INT, OBJECT_PROP_NROF)
906     prop (CFAPI_INT, OBJECT_PROP_DIRECTION)
907     prop (CFAPI_INT, OBJECT_PROP_FACING)
908     prop (CFAPI_INT, OBJECT_PROP_TYPE)
909     prop (CFAPI_INT, OBJECT_PROP_SUBTYPE)
910     prop (CFAPI_INT, OBJECT_PROP_CLIENT_TYPE)
911     prop (CFAPI_INT, OBJECT_PROP_ATTACK_TYPE)
912     prop (CFAPI_INT, OBJECT_PROP_PATH_ATTUNED)
913     prop (CFAPI_INT, OBJECT_PROP_PATH_REPELLED)
914     prop (CFAPI_INT, OBJECT_PROP_PATH_DENIED)
915     prop (CFAPI_INT, OBJECT_PROP_MATERIAL)
916     prop (CFAPI_STRING, OBJECT_PROP_MATERIAL_NAME)
917     prop (CFAPI_INT, OBJECT_PROP_MAGIC)
918     prop (CFAPI_INT, OBJECT_PROP_VALUE)
919     prop (CFAPI_INT, OBJECT_PROP_LEVEL)
920     prop (CFAPI_INT, OBJECT_PROP_LAST_HEAL)
921     prop (CFAPI_INT, OBJECT_PROP_LAST_SP)
922     prop (CFAPI_INT, OBJECT_PROP_LAST_GRACE)
923     prop (CFAPI_INT, OBJECT_PROP_LAST_EAT)
924     prop (CFAPI_INT, OBJECT_PROP_INVISIBLE_TIME)
925     prop (CFAPI_INT, OBJECT_PROP_PICK_UP)
926     prop (CFAPI_INT, OBJECT_PROP_ITEM_POWER)
927     prop (CFAPI_INT, OBJECT_PROP_GEN_SP_ARMOUR)
928     prop (CFAPI_INT, OBJECT_PROP_WEIGHT)
929     prop (CFAPI_INT, OBJECT_PROP_WEIGHT_LIMIT)
930     prop (CFAPI_INT, OBJECT_PROP_CARRYING)
931     prop (CFAPI_INT, OBJECT_PROP_GLOW_RADIUS)
932     prop (CFAPI_LONG, OBJECT_PROP_PERM_EXP)
933     prop (CFAPI_POBJECT, OBJECT_PROP_CURRENT_WEAPON)
934     prop (CFAPI_POBJECT, OBJECT_PROP_ENEMY)
935     prop (CFAPI_POBJECT, OBJECT_PROP_ATTACKED_BY)
936     prop (CFAPI_INT, OBJECT_PROP_RUN_AWAY)
937     prop (CFAPI_POBJECT, OBJECT_PROP_CHOSEN_SKILL)
938     prop (CFAPI_INT, OBJECT_PROP_HIDDEN)
939     prop (CFAPI_INT, OBJECT_PROP_MOVE_STATUS)
940     prop (CFAPI_INT, OBJECT_PROP_MOVE_TYPE)
941     prop (CFAPI_POBJECT, OBJECT_PROP_SPELL_ITEM)
942     prop (CFAPI_DOUBLE, OBJECT_PROP_EXP_MULTIPLIER)
943     prop (CFAPI_PARCH, OBJECT_PROP_ARCHETYPE)
944     prop (CFAPI_PARCH, OBJECT_PROP_OTHER_ARCH)
945     prop (CFAPI_STRING, OBJECT_PROP_CUSTOM_NAME)
946     prop (CFAPI_INT, OBJECT_PROP_ANIM_SPEED)
947     prop (CFAPI_INT, OBJECT_PROP_FRIENDLY)
948     prop (CFAPI_STRING, OBJECT_PROP_SHORT_NAME)
949     prop (CFAPI_INT, OBJECT_PROP_MAGICAL)
950     prop (CFAPI_INT, OBJECT_PROP_LUCK)
951     prop (CFAPI_LONG, OBJECT_PROP_EXP)
952     prop (CFAPI_POBJECT, OBJECT_PROP_OWNER)
953     prop (CFAPI_POBJECT, OBJECT_PROP_PRESENT)
954     prop (CFAPI_INT, OBJECT_PROP_CHEATER)
955     prop (CFAPI_INT, OBJECT_PROP_MERGEABLE)
956     prop (CFAPI_INT, OBJECT_PROP_PICKABLE)
957     prop (CFAPI_INT, OBJECT_PROP_STR)
958     prop (CFAPI_INT, OBJECT_PROP_DEX)
959     prop (CFAPI_INT, OBJECT_PROP_CON)
960     prop (CFAPI_INT, OBJECT_PROP_WIS)
961     prop (CFAPI_INT, OBJECT_PROP_INT)
962     prop (CFAPI_INT, OBJECT_PROP_POW)
963     prop (CFAPI_INT, OBJECT_PROP_CHA)
964     prop (CFAPI_INT, OBJECT_PROP_WC)
965     prop (CFAPI_INT, OBJECT_PROP_AC)
966     prop (CFAPI_INT, OBJECT_PROP_HP)
967     prop (CFAPI_INT, OBJECT_PROP_SP)
968     prop (CFAPI_INT, OBJECT_PROP_GP)
969     prop (CFAPI_INT, OBJECT_PROP_FP)
970     prop (CFAPI_INT, OBJECT_PROP_MAXHP)
971     prop (CFAPI_INT, OBJECT_PROP_MAXSP)
972     prop (CFAPI_INT, OBJECT_PROP_MAXGP)
973     prop (CFAPI_INT, OBJECT_PROP_DAM)
974     prop (CFAPI_STRING, OBJECT_PROP_GOD)
975     prop (CFAPI_STRING, OBJECT_PROP_ARCH_NAME)
976     prop (CFAPI_INT, OBJECT_PROP_INVISIBLE)
977     prop (CFAPI_INT, OBJECT_PROP_FACE)
978     prop (CFAPI_STRING, PLAYER_PROP_IP)
979     prop (CFAPI_POBJECT, PLAYER_PROP_MARKED_ITEM)
980     prop (CFAPI_PPARTY, PLAYER_PROP_PARTY)
981     };
982    
983     HV *prop_type = get_hv ("cf::PROP_TYPE", 1);
984     HV *prop_idx = get_hv ("cf::PROP_IDX", 1);
985    
986     for (cprop = prop_table + sizeof (prop_table) / sizeof (prop_table [0]); cprop-- > prop_table; )
987     {
988     hv_store (prop_type, cprop->name, strlen (cprop->name), newSViv (cprop->dtype), 0);
989     hv_store (prop_idx, cprop->name, strlen (cprop->name), newSViv (cprop->idx ), 0);
990     }
991     }
992    
993     void
994     LOG (int level, char *msg)
995     C_ARGS: level, "%s", msg
996    
997     char *
998     cf_get_maps_directory (char *path)
999 root 1.2 ALIAS: maps_directory = 0
1000 root 1.1
1001 root 1.5 char *
1002     mapdir ()
1003     ALIAS:
1004     mapdir = 0
1005     uniquedir = 1
1006     tmpdir = 2
1007     confdir = 3
1008     localdir = 4
1009     playerdir = 5
1010     datadir = 6
1011     CODE:
1012     {
1013     int unused_type;
1014     RETVAL = (char *)systemDirectory (&unused_type, ix);
1015     }
1016     OUTPUT:
1017     RETVAL
1018    
1019 root 1.4 int
1020     cf_find_animation (char *text)
1021    
1022 root 1.1 MODULE = cf PACKAGE = cf::object PREFIX = cf_object_
1023    
1024     PROTOTYPES: DISABLE
1025    
1026     SV *
1027 root 1.4 get_property (object *obj, int type, int idx)
1028 root 1.1 CODE:
1029     RETVAL = newSVcfapi (type, cf_object_get_property (obj, idx));
1030     OUTPUT:
1031     RETVAL
1032    
1033 root 1.4 SV *
1034     set_property (object *obj, int type, int idx, SV *newval)
1035     CODE:
1036     switch (type)
1037     {
1038     case CFAPI_INT:
1039     cf_object_set_int_property (obj, idx, SvIV (newval));
1040     break;
1041     case CFAPI_LONG:
1042     cf_object_set_long_property (obj, idx, SvNV (newval));
1043     break;
1044     case CFAPI_STRING:
1045     cf_object_set_string_property (obj, idx, SvPV_nolen (newval));
1046     break;
1047     default:
1048     croak ("unhandled type '%d' in set_property '%d'", type, idx);
1049     }
1050    
1051 root 1.1 int cf_object_get_resistance (object *op, int rtype)
1052 root 1.2 ALIAS: resistance = 0
1053 root 1.1
1054     int cf_object_get_flag (object *op, int flag)
1055     ALIAS: flag = 0
1056    
1057     void cf_object_set_flag (object *op, int flag, int value)
1058    
1059     void cf_object_move (object *op, object *originator, int dir)
1060    
1061     void cf_object_apply (object *op, object *author, int flags)
1062    
1063     void cf_object_apply_below (object *op)
1064    
1065     void cf_object_remove (object *op)
1066    
1067     void cf_object_free (object *op)
1068    
1069     object *cf_object_present_archname_inside (object *op, char *whatstr)
1070    
1071     int cf_object_transfer (object *op, int x, int y, int r, object *orig)
1072    
1073     int cf_object_change_map (object *op, int x, int y, mapstruct *map)
1074    
1075     object *cf_object_clone (object *op, int clonetype)
1076    
1077     int cf_object_pay_item (object *op, object *buyer)
1078    
1079     int cf_object_pay_amount (object *op, double amount)
1080    
1081     int cf_object_cast_spell (object *caster, object *ctoo, int dir, object *sp_, char *flags)
1082    
1083     int cf_object_cast_ability (object *caster, object *ctoo, int dir, object *sp_, char *flags)
1084    
1085     void cf_object_learn_spell (object *op, object *sp)
1086    
1087     void cf_object_forget_spell (object *op, object *sp)
1088    
1089     object *cf_object_check_for_spell (object *op, char *spellname)
1090    
1091     int cf_object_query_money (object *op)
1092 root 1.2 ALIAS: money = 0
1093 root 1.1
1094     int cf_object_query_cost (object *op, object *who, int flags)
1095 root 1.2 ALIAS: cost = 0
1096 root 1.1
1097     void cf_object_activate_rune (object *op , object *victim)
1098    
1099     int cf_object_check_trigger (object *op, object *cause)
1100    
1101     int cf_object_out_of_map (object *op, int x, int y)
1102    
1103     void cf_object_drop (object *op, object *author)
1104    
1105     void cf_object_take (object *op, object *author)
1106    
1107     void cf_object_say (object *op, char *msg)
1108    
1109     void cf_object_speak (object *op, char *msg)
1110    
1111     object *cf_object_insert_object (object *op, object *container)
1112    
1113     const char *cf_object_get_msg (object *ob)
1114 root 1.2 ALIAS: msg = 0
1115 root 1.1
1116     object *cf_object_insert_in_ob (object *ob, object *where)
1117    
1118     int cf_object_teleport (object *op, mapstruct *map, int x, int y)
1119    
1120     void cf_object_update (object *op, int flags)
1121    
1122     void cf_object_pickup (object *op, object *what)
1123    
1124     char *cf_object_get_key (object *op, char *keyname)
1125 root 1.2 ALIAS: key = 0
1126 root 1.1
1127     void cf_object_set_key (object *op, char *keyname, char *value)
1128    
1129     char *
1130     base_name (object *ob, int plural)
1131     CODE:
1132     RETVAL = cf_query_base_name (ob, plural);
1133     OUTPUT:
1134     RETVAL
1135    
1136     MODULE = cf PACKAGE = cf::object PREFIX = cf_object_
1137    
1138     object *cf_create_object ()
1139 root 1.2 ALIAS: new = 0
1140 root 1.1
1141     object *cf_create_object_by_name (const char *name)
1142 root 1.2 ALIAS: new_from_name = 0
1143 root 1.1
1144     void cf_free_object (object *ob)
1145    
1146     void cf_fix_object (object *pl)
1147    
1148     object *cf_insert_ob_in_ob (object *ob, object *where)
1149    
1150    
1151     MODULE = cf PACKAGE = cf::object::player PREFIX = cf_player_
1152    
1153     player *player (object *op)
1154     CODE:
1155     RETVAL = cf_player_find (cf_query_name (op));
1156     OUTPUT:
1157     RETVAL
1158    
1159     void cf_player_message (object *obj, char *txt, int flags = 0)
1160    
1161     object *cf_player_send_inventory (object *op)
1162    
1163 root 1.4 void cf_player_set_marked_item(object *op, object *ob)
1164 root 1.1
1165 root 1.4 void cf_player_set_party(object *op, partylist *party)
1166 root 1.1
1167    
1168 root 1.4 MODULE = cf PACKAGE = cf::object::map PREFIX = cf_
1169 root 1.1
1170     MODULE = cf PACKAGE = cf::player PREFIX = cf_
1171    
1172     player *cf_player_find (char *name)
1173    
1174     void cf_player_move (player *pl, int dir)
1175    
1176    
1177     MODULE = cf PACKAGE = cf::map PREFIX = cf_
1178    
1179     SV *
1180     get_property (mapstruct *obj, int type, int idx)
1181     CODE:
1182     RETVAL = newSVcfapi (type, cf_map_get_property (obj, idx));
1183     OUTPUT:
1184     RETVAL
1185    
1186 root 1.4 SV *
1187     set_property (mapstruct *obj, int type, int idx, SV *newval)
1188     CODE:
1189     switch (type)
1190     {
1191     case CFAPI_INT:
1192     cf_map_set_int_property (obj, idx, SvIV (newval));
1193     break;
1194     default:
1195     croak ("unhandled type '%d' in set_property '%d'", type, idx);
1196     }
1197    
1198     mapstruct *cf_map_get_map (char *name)
1199     ALIAS: map = 0
1200    
1201     mapstruct *cf_map_get_first ()
1202     ALIAS: first = 0
1203    
1204     object *cf_map_insert_object_there (mapstruct *where, object *op, object *originator, int flags)
1205    
1206     object *cf_map_insert_object (mapstruct *where, object* op, int x, int y)
1207    
1208     object* cf_map_present_arch_by_name (mapstruct *map, const char* str, int nx, int ny)
1209     C_ARGS: str, map, nx, ny
1210    
1211     #int cf_map_get_flags (mapstruct* map, mapstruct** nmap, I16 x, I16 y, I16 *nx, I16 *ny)
1212    
1213    
1214 root 1.1
1215     MODULE = cf PACKAGE = cf::arch PREFIX = cf_archetype_
1216    
1217     archetype*cf_archetype_get_first()
1218 root 1.2 ALIAS: first = 0
1219 root 1.1
1220 root 1.2 archetype *cf_archetype_get_next (archetype *arch)
1221     ALIAS: next = 0
1222 root 1.1
1223 root 1.2 archetype *cf_archetype_get_head (archetype *arch)
1224     ALIAS: head = 0
1225 root 1.1
1226     archetype *cf_archetype_get_more (archetype *arch)
1227 root 1.2 ALIAS: more = 0
1228 root 1.1
1229 root 1.2 const char *cf_archetype_get_name (archetype *arch)
1230     ALIAS: name = 0
1231 root 1.1
1232     MODULE = cf PACKAGE = cf::party PREFIX = cf_party_
1233    
1234     const char *cf_party_get_name (partylist *party)
1235    
1236     partylist *cf_party_get_first ()
1237     ALIAS: first = 0
1238    
1239     partylist *cf_party_get_next (partylist *party)
1240     ALIAS: next = 0
1241    
1242     const char *cf_party_get_password (partylist *party)
1243     ALIAS: password = 0
1244    
1245     player *cf_party_get_first_player (partylist *party)
1246     ALIAS: first_player = 0
1247    
1248     player *cf_party_get_next_player (partylist *party, player *op)
1249     ALIAS: next_player = 0
1250    
1251    
1252     MODULE = cf PACKAGE = cf::region PREFIX = cf_region_
1253    
1254     region *cf_region_get_first ()
1255     ALIAS: first = 0
1256    
1257     const char *cf_region_get_name (region *reg)
1258     ALIAS: name = 0
1259    
1260     region *cf_region_get_next (region *reg)
1261     ALIAS: next = 0
1262    
1263     region *cf_region_get_parent (region *reg)
1264     ALIAS: parent = 0
1265    
1266     const char *cf_region_get_longname (region *reg)
1267     ALIAS: longname = 0
1268    
1269     const char *cf_region_get_message (region *reg)
1270     ALIAS: message = 0
1271    
1272