server/include/cfperl.h

/*
 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
 * 
 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Deliantra is free software: you can redistribute it and/or modify it under
 * the terms of the Affero GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the Affero GNU General Public License
 * and the GNU General Public License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 * 
 * The authors can be reached via e-mail to <support@deliantra.net>
 */

//
// cfperl.h perl interface
//
#ifndef CFPERL_H__
#define CFPERL_H__

#include <cstdarg>
#include <cstdio>
#include <bitset>

using namespace std;

#include <EXTERN.h>
#include <perl.h>
#include <XSUB.h>

#include <EVAPI.h>
#include <CoroAPI.h>

#include "util.h"
#include "keyword.h"
#include "dynbuf.h"
#include "callback.h"

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
#undef localtime
#undef srand48
#undef drand48
#undef srandom
#undef opendir
#undef readdir
#undef closedir
#undef getprotobyname
#undef gethostbyname
#undef ctime
#undef strerror
#undef _

// same here, massive symbol spamming
#undef do_open
#undef do_close
#undef ref
#undef seed

// perl bug #40256: perl does overwrite those with reentrant versions
// but does not initialise their state structures.
#undef random
#undef crypt

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

#define _(msg)  (msg)
#define N_(msg) (msg)

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

// some macros to simplify perl in-calls

#define CHECK_ERROR                     \
  if (SvTRUE (ERRSV))                   \
    LOG (llevError, "runtime error in %s: %s", __func__, SvPVutf8_nolen (ERRSV));

inline int call_pvsv (const char *ob, I32 flags) { return call_pv (ob, flags); }
inline int call_pvsv (SV         *ob, I32 flags) { return call_sv (ob, flags); }

#define CALL_BEGIN(args) dSP; ENTER; SAVETMPS; PUSHMARK (SP); EXTEND (SP, args)
#define CALL_ARG_SV(sv) PUSHs (sv_2mortal (sv)) // separate because no refcount inc
#define CALL_ARG(expr) PUSHs (sv_2mortal (to_sv (expr)))
#define CALL_CALL(name, flags) PUTBACK; int count = call_pvsv (name, (flags) | G_EVAL); SPAGAIN;
#define CALL_END PUTBACK; CHECK_ERROR; FREETMPS; LEAVE

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

void cfperl_init ();
void cfperl_main ();
void cfperl_tick ();
void cfperl_emergency_save ();
void cfperl_cleanup (int make_core);
void cfperl_make_book (object *book, int level);
void cfperl_send_msg (client *ns, int color, const char *type, const char *msg);
int cfperl_can_merge (object *ob1, object *ob2);
void cfperl_mapscript_activate (object *ob, int state, object *activator, object *originator = 0);

bool is_match_expr (const char *expr);
/* applies the match expression and returns true if it matches */
bool match (const char *expr, object *ob, object *self = 0, object *source = 0, object *originator = 0);

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

#if IVSIZE >= 8
  typedef IV val64;
  typedef IV uval64;
# define newSVval64 newSViv
# define SvVAL64 SvIV
# define newSVuval64 newSVuv
# define SvUVAL64 SvUV
#else
  typedef double val64;
  typedef double uval64;
# define newSVval64 newSVnv
# define SvVAL64 SvNV
# define newSVuval64 newSVnv
# define SvUVAL64 SvNV
#endif

extern tstamp runtime; // virtual server time, excluding time jumps and lag
extern tstamp NOW;     // real time of current server tick

enum event_klass
{
  KLASS_NONE,
  KLASS_GLOBAL,
  KLASS_ATTACHABLE,
  KLASS_CLIENT,
  KLASS_PLAYER,
  KLASS_OBJECT,
  KLASS_MAP,
  KLASS_COMMAND,
};

enum event_type
{
# define def(klass,name) EVENT_ ## klass ## _ ## name,
#  include "eventinc.h"
# undef def
  NUM_EVENT_TYPES
};

// in which global events or per-type events are we interested
extern bitset<NUM_EVENT_TYPES> ev_want_event;
extern bitset<NUM_TYPES>       ev_want_type;

#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), int (l)
#define ARG_OBJECT(o)     DT_OBJECT, (void *)(static_cast<object *>    (o))
#define ARG_MAP(o)        DT_MAP   , (void *)(static_cast<maptile *>   (o))
#define ARG_PLAYER(o)     DT_PLAYER, (void *)(static_cast<player *>    (o))
#define ARG_ARCH(o)       DT_ARCH  , (void *)(static_cast<archetype *> (o))
#define ARG_CLIENT(o)     DT_CLIENT, (void *)(static_cast<client *>    (o))
#define ARG_PARTY(o)      DT_PARTY , (void *)(static_cast<party *>     (o))
#define ARG_REGION(o)     DT_REGION, (void *)(static_cast<region *>    (o))

// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
#define INVOKE_GLOBAL(event, ...)          INVOKE (&gbl_ev, EVENT_ ## GLOBAL     ## _ ## event, ## __VA_ARGS__)
#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj    , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__)
#define INVOKE_OBJECT(event, obj, ...)     INVOKE (obj    , EVENT_ ## OBJECT     ## _ ## event, ## __VA_ARGS__)
#define INVOKE_CLIENT(event, obj, ...)     INVOKE (obj    , EVENT_ ## CLIENT     ## _ ## event, ## __VA_ARGS__)
#define INVOKE_PLAYER(event, obj, ...)     INVOKE (obj    , EVENT_ ## PLAYER     ## _ ## event, ## __VA_ARGS__)
#define INVOKE_MAP(event, obj, ...)        INVOKE (obj    , EVENT_ ## MAP        ## _ ## event, ## __VA_ARGS__)

//TODO should index into @result
#define RESULT(idx,type) cfperl_result_ ## type (idx)
#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
#define RESULT_INT(idx)    RESULT(idx, INT)

double cfperl_result_DOUBLE (int idx);
int cfperl_result_INT (int idx);

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

INTERFACE_CLASS (attachable)
struct attachable : refcnt_base
{
  static MGVTBL vtbl;

  enum {
    F_DESTROYED   = 0x01,
    F_DEBUG_TRACE = 0x02,
  };
  uint8 ACC (RW, flags);

  static unordered_vector<attachable *> mortals;
  MTH static void check_mortals ();

  // object is delete'd after the refcount reaches 0
  MTH int refcnt_cnt () const;
  // check wether the object has died and destroy
  MTH void refcnt_chk () { if (expect_false (refcnt <= 0)) do_check (); }

  // destroy the object unless it was already destroyed
  // this politely asks everybody interested the reduce
  // the refcount to 0 as soon as possible.
  MTH void destroy ();

  // return wether an object was destroyed already
  MTH bool destroyed () const { return flags & F_DESTROYED; }

  virtual void gather_callbacks (AV *&callbacks, event_type event) const;

#if 0
private:
  static refcounted *rc_first;
  refcounted *rc_next;
#endif

  HV *self;     // CF+ perl self
  AV *cb;       // CF+ callbacks
  shstr attach; // generic extension attachment information

  void sever_self (); // sever this object from its self, if it has one.
  void optimise ();   // possibly save some memory by destroying unneeded data

  attachable ()
  : flags (0), self (0), cb (0), attach (0)
  {
  }

  attachable (const attachable &src)
  : flags (0), self (0), cb (0), attach (src.attach)
  {
  }

  // set a custom key to the given value, or delete it if value = 0
  void set_key (const char *key, const char *value = 0, bool is_utf8 = 0);

  void set_key_text (const char *key, const char *value = 0)
  {
    set_key (key, value, 1);
  }

  void set_key_data (const char *key, const char *value = 0)
  {
    set_key (key, value, 0);
  }

  attachable &operator =(const attachable &src);

  // used to _quickly_ device wether to shortcut the evaluation
  bool should_invoke (event_type event)
  {
    return ev_want_event [event] || cb;
  }

  bool invoke (event_type event, ...);

  MTH void instantiate ();
  void reattach ();

protected:
  // do the real refcount checking work
  void do_check ();

  // the method that does the real destroy work
  virtual void do_destroy ();

  // destructor is protected, should not be called by anybody
  virtual ~attachable ();
};

// the global object is a pseudo object that cares for the global events
struct global : attachable
{
  void gather_callbacks (AV *&callbacks, event_type event) const;
};

extern struct global gbl_ev;

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

INTERFACE_CLASS(object_freezer)
struct object_freezer : dynbuf_text
{
  AV *av;

  object_freezer ();
  ~object_freezer ();

  void put (attachable *ext);

  // used only for user-defined key-value pairs
  void put (shstr_tmp k, shstr_tmp v)
  {
    add (k);

    if (expect_true (v))
      add (' '), add (v);

    add ('\n');
  }

  template<typename T>
  void put_kw_string (keyword k, const T &v)
  {
    int klen = keyword_len [k];
    int vlen = v ? strlen (v) + 1 : 0;

    char *p = (char *)alloc (klen + vlen + 1);

    memcpy (p, keyword_str [k], klen); p += klen;

    if (expect_true (v))
      {
        *p++ = ' ';  vlen--;
        memcpy (p, v, vlen); p += vlen;
      }

    *p = '\n';
  }

  void put (keyword k, const char *v = 0)
  {
    put_kw_string (k, v);
  }

  void put (keyword k, shstr_tmp v)
  {
    put_kw_string (k, v);
  }

  void put (keyword k, double v)
  {
    force (MAX_KEYWORD_LEN + 2 + 32);
    fadd (keyword_str [k], keyword_len [k]);
    fadd (' ');
    falloc (sprintf (ptr, "%.7g", v));
    fadd ('\n');
  }

  void put_(keyword k, sint64 v)
  {
    force (MAX_KEYWORD_LEN + 2 + sint64_digits);
    fadd (keyword_str [k], keyword_len [k]);
    fadd (' ');
    add (v);
    fadd ('\n');
  }

  void put_(keyword k, sint32 v)
  {
    force (MAX_KEYWORD_LEN + 2 + sint32_digits);
    fadd (keyword_str [k], keyword_len [k]);
    fadd (' ');
    add (v);
    fadd ('\n');
  }

  void put (keyword k,          float     v) { put (k, (double)v); }
  void put (keyword k,   signed char      v) { put_(k, (sint32)v); }
  void put (keyword k, unsigned char      v) { put_(k, (sint32)v); }
  void put (keyword k,   signed short     v) { put_(k, (sint32)v); }
  void put (keyword k, unsigned short     v) { put_(k, (sint32)v); }
  void put (keyword k,   signed int       v) { put_(k, (sint32)v); }
  void put (keyword k, unsigned int       v) { put_(k, (sint64)v); }
  void put (keyword k,   signed long      v) { put_(k, (sint64)v); }
  void put (keyword k, unsigned long      v) { put_(k, (sint64)v); }
  void put (keyword k,   signed long long v) { put_(k, (sint64)v); }
  void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }

  void put (keyword kbeg, keyword kend, shstr_tmp v)
  {
    force (MAX_KEYWORD_LEN + 1);
    fadd (keyword_str [kbeg], keyword_len [kbeg]); fadd ('\n');

    if (expect_true (v))
      {
        add (v);
        add ('\n');
      }

    force (MAX_KEYWORD_LEN + 1);
    fadd (keyword_str [kend], keyword_len [kend]); fadd ('\n');
  }

  void put (keyword k, archetype *v);
  void put (keyword k, treasurelist *v);
  void put (keyword k, faceinfo *v);

  template<typename T>
  void put (keyword k, const refptr<T> &v)
  {
    put (k, (T *)v);
  }

  MTH bool save (const_octet_string path);
  char *as_string (); // like strdup

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

INTERFACE_CLASS(object_thawer)
struct object_thawer
{
  char *line; // current beginning of line
  SV *text; // text part
  AV *av;   // perl part
  int linenum;
  keyword kw;
  char *kw_str; // the keyword parsed, as string
  char *value;  // the value, or 0 if no value
  const char *value_nn; // the value, or the empty string if no value
  const char *name;

  operator bool () const { return !!text; }

  object_thawer (const char *path = 0);
  object_thawer (const char *data, AV *perlav);
  ~object_thawer ();

  void get (attachable *obj, int oid);

  // parse next line
  MTH void next ();
  // skip the current key-value (usually fetch next line, for
  // multiline-fields, skips till the corresponding end-kw
  MTH void skip ();
  MTH void skip_block (); // skips till and over KW_end

  char *get_str () { return value; } // may be 0
  void get_ml (keyword kend, shstr &sh);

  void get_ornull (shstr &sh) const { sh = value; }
  void get (shstr &sh)        const { sh = value; } // might want to check for non-null here

  bool   get_bool   () const { return *value_nn == '1'; }
  sint32 get_sint32 () const;
  sint64 get_sint64 () const { return strtoll (value_nn, 0, 10); }
  double get_double () const { return strtod  (value_nn, 0); }

  void get (float  &v) { v = get_double (); }
  void get (double &v) { v = get_double (); }

  void get (bool   &i) { i = get_bool   (); }
  void get (sint8  &i) { i = get_sint32 (); }
  void get (uint8  &i) { i = get_sint32 (); }
  void get (sint16 &i) { i = get_sint32 (); }
  void get (uint16 &i) { i = get_sint32 (); }
  void get (sint32 &i) { i = get_sint32 (); }

  void get (uint32 &i) { i = get_sint64 (); }
  void get (sint64 &i) { i = get_sint64 (); }

  MTH void parse_warn (const char *msg);
  MTH bool parse_error (const char *type = 0, const char *name = 0, bool skip = true);

  struct delayed_ref {
    attachable *op;
    object_ptr *ptr;
    const char *ref;
  };
  std::vector<delayed_ref> delrefs;

  void delayed_deref (attachable *op, object_ptr &ptr, const char *ref);
  MTH void resolve_delayed_derefs (bool deref = true);
};

//TODO: remove
char *fgets (char *s, int n, object_thawer &thawer);

//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

struct coroapi {
  static struct CoroAPI *GCoroAPI;

  static EV_ATOMIC_T cede_pending;

  static int nready () {                   return CORO_NREADY; }
  static int cede   () { cede_pending = 0; return CORO_CEDE  ; }

  static void do_cede_to_tick ();

  // actually cede's far more often
  static bool cede_to_tick ()
  {
    if (expect_true (!cede_pending))
      return false;

    do_cede_to_tick ();
    return true;
  }

  static void wait_for_tick ();
  static void wait_for_tick_begin ();
};

struct evapi
{
  static struct EVAPI *GEVAPI;
};

struct iow : ev_io, evapi, callback<void (iow &, int)>
{
  static void thunk (EV_P_ struct ev_io *w_, int revents)
  {
    iow &w = *static_cast<iow *>(w_);
    
    w (w, revents);
  }

  template<class O, class M>
  iow (O object, M method)
  : callback<void (iow &, int)> (object, method)
  {
    ev_init ((ev_io *)this, thunk);
  }

  void prio (int prio)
  {
    ev_set_priority ((ev_io *)this, prio);
  }

  void set (int fd, int events)
  {
    ev_io_set ((ev_io *)this, fd, events);
  }

  int poll () const { return events; }

  void poll (int events);

  void start ()
  {
    ev_io_start (EV_DEFAULT, (ev_io *)this);
  }

  void stop ()
  {
    ev_io_stop (EV_DEFAULT, (ev_io *)this);
  }

  ~iow ()
  {
    stop ();
  }
};

struct asyncw : ev_async, evapi, callback<void (ev_async &, int)>
{
  static void thunk (EV_P_ struct ev_async *w_, int revents)
  {
    asyncw &w = *static_cast<asyncw *>(w_);
    
    w (w, revents);
  }

  template<class O, class M>
  asyncw (O object, M method)
  : callback<void (asyncw &, int)> (object, method)
  {
    ev_init ((ev_async *)this, thunk);
  }

  void start ()
  {
    ev_async_start (EV_DEFAULT, (ev_async *)this);
  }

  void stop ()
  {
    ev_async_stop (EV_DEFAULT, (ev_async *)this);
  }

  ~asyncw ()
  {
    stop ();
  }
};

#endif

Revision:	1.108
Committed:	Mon Oct 12 14:00:58 2009 UTC (14 years, 7 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-2_82, rel-2_81
Changes since 1.107:	+7 -6 lines
Log Message:	clarify license
#	Content
1	/*
2	* This file is part of Deliantra, the Roguelike Realtime MMORPG.
3	*
4	* Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5	* Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6	* Copyright (©) 1992,2007 Frank Tore Johansen
7	*
8	* Deliantra is free software: you can redistribute it and/or modify it under
9	* the terms of the Affero GNU General Public License as published by the
10	* Free Software Foundation, either version 3 of the License, or (at your
11	* option) any later version.
12	*
13	* This program is distributed in the hope that it will be useful,
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16	* GNU General Public License for more details.
17	*
18	* You should have received a copy of the Affero GNU General Public License
19	* and the GNU General Public License along with this program. If not, see
20	* <http://www.gnu.org/licenses/>.
21	*
22	* The authors can be reached via e-mail to <support@deliantra.net>
23	*/
24
25	//
26	// cfperl.h perl interface
27	//
28	#ifndef CFPERL_H__
29	#define CFPERL_H__
30
31	#include <cstdarg>
32	#include <cstdio>
33	#include <bitset>
34
35	using namespace std;
36
37	#include <EXTERN.h>
38	#include <perl.h>
39	#include <XSUB.h>
40
41	#include <EVAPI.h>
42	#include <CoroAPI.h>
43
44	#include "util.h"
45	#include "keyword.h"
46	#include "dynbuf.h"
47	#include "callback.h"
48
49	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
50
51	// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
52	#undef localtime
53	#undef srand48
54	#undef drand48
55	#undef srandom
56	#undef opendir
57	#undef readdir
58	#undef closedir
59	#undef getprotobyname
60	#undef gethostbyname
61	#undef ctime
62	#undef strerror
63	#undef _
64
65	// same here, massive symbol spamming
66	#undef do_open
67	#undef do_close
68	#undef ref
69	#undef seed
70
71	// perl bug #40256: perl does overwrite those with reentrant versions
72	// but does not initialise their state structures.
73	#undef random
74	#undef crypt
75
76	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
77
78	#define _(msg) (msg)
79	#define N_(msg) (msg)
80
81	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
82
83	// some macros to simplify perl in-calls
84
85	#define CHECK_ERROR \
86	if (SvTRUE (ERRSV)) \
87	LOG (llevError, "runtime error in %s: %s", __func__, SvPVutf8_nolen (ERRSV));
88
89	inline int call_pvsv (const char *ob, I32 flags) { return call_pv (ob, flags); }
90	inline int call_pvsv (SV *ob, I32 flags) { return call_sv (ob, flags); }
91
92	#define CALL_BEGIN(args) dSP; ENTER; SAVETMPS; PUSHMARK (SP); EXTEND (SP, args)
93	#define CALL_ARG_SV(sv) PUSHs (sv_2mortal (sv)) // separate because no refcount inc
94	#define CALL_ARG(expr) PUSHs (sv_2mortal (to_sv (expr)))
95	#define CALL_CALL(name, flags) PUTBACK; int count = call_pvsv (name, (flags) \| G_EVAL); SPAGAIN;
96	#define CALL_END PUTBACK; CHECK_ERROR; FREETMPS; LEAVE
97
98	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
99
100	void cfperl_init ();
101	void cfperl_main ();
102	void cfperl_tick ();
103	void cfperl_emergency_save ();
104	void cfperl_cleanup (int make_core);
105	void cfperl_make_book (object *book, int level);
106	void cfperl_send_msg (client ns, int color, const char type, const char *msg);
107	int cfperl_can_merge (object ob1, object ob2);
108	void cfperl_mapscript_activate (object ob, int state, object activator, object *originator = 0);
109
110	bool is_match_expr (const char *expr);
111	/* applies the match expression and returns true if it matches */
112	bool match (const char expr, object ob, object self = 0, object source = 0, object *originator = 0);
113
114	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
115
116	#if IVSIZE >= 8
117	typedef IV val64;
118	typedef IV uval64;
119	# define newSVval64 newSViv
120	# define SvVAL64 SvIV
121	# define newSVuval64 newSVuv
122	# define SvUVAL64 SvUV
123	#else
124	typedef double val64;
125	typedef double uval64;
126	# define newSVval64 newSVnv
127	# define SvVAL64 SvNV
128	# define newSVuval64 newSVnv
129	# define SvUVAL64 SvNV
130	#endif
131
132	extern tstamp runtime; // virtual server time, excluding time jumps and lag
133	extern tstamp NOW; // real time of current server tick
134
135	enum event_klass
136	{
137	KLASS_NONE,
138	KLASS_GLOBAL,
139	KLASS_ATTACHABLE,
140	KLASS_CLIENT,
141	KLASS_PLAYER,
142	KLASS_OBJECT,
143	KLASS_MAP,
144	KLASS_COMMAND,
145	};
146
147	enum event_type
148	{
149	# define def(klass,name) EVENT_ ## klass ## _ ## name,
150	# include "eventinc.h"
151	# undef def
152	NUM_EVENT_TYPES
153	};
154
155	// in which global events or per-type events are we interested
156	extern bitset<NUM_EVENT_TYPES> ev_want_event;
157	extern bitset<NUM_TYPES> ev_want_type;
158
159	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
160	#define ARG_INT(v) DT_INT , static_cast<int> (v)
161	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
162	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
163	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
164	#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
165	#define ARG_OBJECT(o) DT_OBJECT, (void )(static_cast<object > (o))
166	#define ARG_MAP(o) DT_MAP , (void )(static_cast<maptile > (o))
167	#define ARG_PLAYER(o) DT_PLAYER, (void )(static_cast<player > (o))
168	#define ARG_ARCH(o) DT_ARCH , (void )(static_cast<archetype > (o))
169	#define ARG_CLIENT(o) DT_CLIENT, (void )(static_cast<client > (o))
170	#define ARG_PARTY(o) DT_PARTY , (void )(static_cast<party > (o))
171	#define ARG_REGION(o) DT_REGION, (void )(static_cast<region > (o))
172
173	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
174	#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
175	#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
176	#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__)
177	#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__)
178	#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
179	#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__)
180	#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
181
182	//TODO should index into @result
183	#define RESULT(idx,type) cfperl_result_ ## type (idx)
184	#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
185	#define RESULT_INT(idx) RESULT(idx, INT)
186
187	double cfperl_result_DOUBLE (int idx);
188	int cfperl_result_INT (int idx);
189
190	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
191
192	INTERFACE_CLASS (attachable)
193	struct attachable : refcnt_base
194	{
195	static MGVTBL vtbl;
196
197	enum {
198	F_DESTROYED = 0x01,
199	F_DEBUG_TRACE = 0x02,
200	};
201	uint8 ACC (RW, flags);
202
203	static unordered_vector<attachable *> mortals;
204	MTH static void check_mortals ();
205
206	// object is delete'd after the refcount reaches 0
207	MTH int refcnt_cnt () const;
208	// check wether the object has died and destroy
209	MTH void refcnt_chk () { if (expect_false (refcnt <= 0)) do_check (); }
210
211	// destroy the object unless it was already destroyed
212	// this politely asks everybody interested the reduce
213	// the refcount to 0 as soon as possible.
214	MTH void destroy ();
215
216	// return wether an object was destroyed already
217	MTH bool destroyed () const { return flags & F_DESTROYED; }
218
219	virtual void gather_callbacks (AV *&callbacks, event_type event) const;
220
221	#if 0
222	private:
223	static refcounted *rc_first;
224	refcounted *rc_next;
225	#endif
226
227	HV *self; // CF+ perl self
228	AV *cb; // CF+ callbacks
229	shstr attach; // generic extension attachment information
230
231	void sever_self (); // sever this object from its self, if it has one.
232	void optimise (); // possibly save some memory by destroying unneeded data
233
234	attachable ()
235	: flags (0), self (0), cb (0), attach (0)
236	{
237	}
238
239	attachable (const attachable &src)
240	: flags (0), self (0), cb (0), attach (src.attach)
241	{
242	}
243
244	// set a custom key to the given value, or delete it if value = 0
245	void set_key (const char key, const char value = 0, bool is_utf8 = 0);
246
247	void set_key_text (const char key, const char value = 0)
248	{
249	set_key (key, value, 1);
250	}
251
252	void set_key_data (const char key, const char value = 0)
253	{
254	set_key (key, value, 0);
255	}
256
257	attachable &operator =(const attachable &src);
258
259	// used to _quickly_ device wether to shortcut the evaluation
260	bool should_invoke (event_type event)
261	{
262	return ev_want_event [event] \|\| cb;
263	}
264
265	bool invoke (event_type event, ...);
266
267	MTH void instantiate ();
268	void reattach ();
269
270	protected:
271	// do the real refcount checking work
272	void do_check ();
273
274	// the method that does the real destroy work
275	virtual void do_destroy ();
276
277	// destructor is protected, should not be called by anybody
278	virtual ~attachable ();
279	};
280
281	// the global object is a pseudo object that cares for the global events
282	struct global : attachable
283	{
284	void gather_callbacks (AV *&callbacks, event_type event) const;
285	};
286
287	extern struct global gbl_ev;
288
289	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
290
291	INTERFACE_CLASS(object_freezer)
292	struct object_freezer : dynbuf_text
293	{
294	AV *av;
295
296	object_freezer ();
297	~object_freezer ();
298
299	void put (attachable *ext);
300
301	// used only for user-defined key-value pairs
302	void put (shstr_tmp k, shstr_tmp v)
303	{
304	add (k);
305
306	if (expect_true (v))
307	add (' '), add (v);
308
309	add ('\n');
310	}
311
312	template<typename T>
313	void put_kw_string (keyword k, const T &v)
314	{
315	int klen = keyword_len [k];
316	int vlen = v ? strlen (v) + 1 : 0;
317
318	char p = (char )alloc (klen + vlen + 1);
319
320	memcpy (p, keyword_str [k], klen); p += klen;
321
322	if (expect_true (v))
323	{
324	*p++ = ' '; vlen--;
325	memcpy (p, v, vlen); p += vlen;
326	}
327
328	*p = '\n';
329	}
330
331	void put (keyword k, const char *v = 0)
332	{
333	put_kw_string (k, v);
334	}
335
336	void put (keyword k, shstr_tmp v)
337	{
338	put_kw_string (k, v);
339	}
340
341	void put (keyword k, double v)
342	{
343	force (MAX_KEYWORD_LEN + 2 + 32);
344	fadd (keyword_str [k], keyword_len [k]);
345	fadd (' ');
346	falloc (sprintf (ptr, "%.7g", v));
347	fadd ('\n');
348	}
349
350	void put_(keyword k, sint64 v)
351	{
352	force (MAX_KEYWORD_LEN + 2 + sint64_digits);
353	fadd (keyword_str [k], keyword_len [k]);
354	fadd (' ');
355	add (v);
356	fadd ('\n');
357	}
358
359	void put_(keyword k, sint32 v)
360	{
361	force (MAX_KEYWORD_LEN + 2 + sint32_digits);
362	fadd (keyword_str [k], keyword_len [k]);
363	fadd (' ');
364	add (v);
365	fadd ('\n');
366	}
367
368	void put (keyword k, float v) { put (k, (double)v); }
369	void put (keyword k, signed char v) { put_(k, (sint32)v); }
370	void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
371	void put (keyword k, signed short v) { put_(k, (sint32)v); }
372	void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
373	void put (keyword k, signed int v) { put_(k, (sint32)v); }
374	void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
375	void put (keyword k, signed long v) { put_(k, (sint64)v); }
376	void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
377	void put (keyword k, signed long long v) { put_(k, (sint64)v); }
378	void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
379
380	void put (keyword kbeg, keyword kend, shstr_tmp v)
381	{
382	force (MAX_KEYWORD_LEN + 1);
383	fadd (keyword_str [kbeg], keyword_len [kbeg]); fadd ('\n');
384
385	if (expect_true (v))
386	{
387	add (v);
388	add ('\n');
389	}
390
391	force (MAX_KEYWORD_LEN + 1);
392	fadd (keyword_str [kend], keyword_len [kend]); fadd ('\n');
393	}
394
395	void put (keyword k, archetype *v);
396	void put (keyword k, treasurelist *v);
397	void put (keyword k, faceinfo *v);
398
399	template<typename T>
400	void put (keyword k, const refptr<T> &v)
401	{
402	put (k, (T *)v);
403	}
404
405	MTH bool save (const_octet_string path);
406	char *as_string (); // like strdup
407
408	operator bool () { return !!av; }
409	};
410
411	INTERFACE_CLASS(object_thawer)
412	struct object_thawer
413	{
414	char *line; // current beginning of line
415	SV *text; // text part
416	AV *av; // perl part
417	int linenum;
418	keyword kw;
419	char *kw_str; // the keyword parsed, as string
420	char *value; // the value, or 0 if no value
421	const char *value_nn; // the value, or the empty string if no value
422	const char *name;
423
424	operator bool () const { return !!text; }
425
426	object_thawer (const char *path = 0);
427	object_thawer (const char data, AV perlav);
428	~object_thawer ();
429
430	void get (attachable *obj, int oid);
431
432	// parse next line
433	MTH void next ();
434	// skip the current key-value (usually fetch next line, for
435	// multiline-fields, skips till the corresponding end-kw
436	MTH void skip ();
437	MTH void skip_block (); // skips till and over KW_end
438
439	char *get_str () { return value; } // may be 0
440	void get_ml (keyword kend, shstr &sh);
441
442	void get_ornull (shstr &sh) const { sh = value; }
443	void get (shstr &sh) const { sh = value; } // might want to check for non-null here
444
445	bool get_bool () const { return *value_nn == '1'; }
446	sint32 get_sint32 () const;
447	sint64 get_sint64 () const { return strtoll (value_nn, 0, 10); }
448	double get_double () const { return strtod (value_nn, 0); }
449
450	void get (float &v) { v = get_double (); }
451	void get (double &v) { v = get_double (); }
452
453	void get (bool &i) { i = get_bool (); }
454	void get (sint8 &i) { i = get_sint32 (); }
455	void get (uint8 &i) { i = get_sint32 (); }
456	void get (sint16 &i) { i = get_sint32 (); }
457	void get (uint16 &i) { i = get_sint32 (); }
458	void get (sint32 &i) { i = get_sint32 (); }
459
460	void get (uint32 &i) { i = get_sint64 (); }
461	void get (sint64 &i) { i = get_sint64 (); }
462
463	MTH void parse_warn (const char *msg);
464	MTH bool parse_error (const char type = 0, const char name = 0, bool skip = true);
465
466	struct delayed_ref {
467	attachable *op;
468	object_ptr *ptr;
469	const char *ref;
470	};
471	std::vector<delayed_ref> delrefs;
472
473	void delayed_deref (attachable op, object_ptr &ptr, const char ref);
474	MTH void resolve_delayed_derefs (bool deref = true);
475	};
476
477	//TODO: remove
478	char fgets (char s, int n, object_thawer &thawer);
479
480	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
481
482	struct coroapi {
483	static struct CoroAPI *GCoroAPI;
484
485	static EV_ATOMIC_T cede_pending;
486
487	static int nready () { return CORO_NREADY; }
488	static int cede () { cede_pending = 0; return CORO_CEDE ; }
489
490	static void do_cede_to_tick ();
491
492	// actually cede's far more often
493	static bool cede_to_tick ()
494	{
495	if (expect_true (!cede_pending))
496	return false;
497
498	do_cede_to_tick ();
499	return true;
500	}
501
502	static void wait_for_tick ();
503	static void wait_for_tick_begin ();
504	};
505
506	struct evapi
507	{
508	static struct EVAPI *GEVAPI;
509	};
510
511	struct iow : ev_io, evapi, callback<void (iow &, int)>
512	{
513	static void thunk (EV_P_ struct ev_io *w_, int revents)
514	{
515	iow &w = static_cast<iow >(w_);
516
517	w (w, revents);
518	}
519
520	template<class O, class M>
521	iow (O object, M method)
522	: callback<void (iow &, int)> (object, method)
523	{
524	ev_init ((ev_io *)this, thunk);
525	}
526
527	void prio (int prio)
528	{
529	ev_set_priority ((ev_io *)this, prio);
530	}
531
532	void set (int fd, int events)
533	{
534	ev_io_set ((ev_io *)this, fd, events);
535	}
536
537	int poll () const { return events; }
538
539	void poll (int events);
540
541	void start ()
542	{
543	ev_io_start (EV_DEFAULT, (ev_io *)this);
544	}
545
546	void stop ()
547	{
548	ev_io_stop (EV_DEFAULT, (ev_io *)this);
549	}
550
551	~iow ()
552	{
553	stop ();
554	}
555	};
556
557	struct asyncw : ev_async, evapi, callback<void (ev_async &, int)>
558	{
559	static void thunk (EV_P_ struct ev_async *w_, int revents)
560	{
561	asyncw &w = static_cast<asyncw >(w_);
562
563	w (w, revents);
564	}
565
566	template<class O, class M>
567	asyncw (O object, M method)
568	: callback<void (asyncw &, int)> (object, method)
569	{
570	ev_init ((ev_async *)this, thunk);
571	}
572
573	void start ()
574	{
575	ev_async_start (EV_DEFAULT, (ev_async *)this);
576	}
577
578	void stop ()
579	{
580	ev_async_stop (EV_DEFAULT, (ev_async *)this);
581	}
582
583	~asyncw ()
584	{
585	stop ();
586	}
587	};
588
589	#endif
590