server/include/cfperl.h

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