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 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 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 readdir
#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));

#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_pv (name, (flags) | G_EVAL); SPAGAIN;
#define CALL_END 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_expand_cfpod (player *pl, std::string &msg);
void cfperl_send_msg (client *ns, int color, const char *type, const char *msg);
int cfperl_can_merge (object *ob1, object *ob2);

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

#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;

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

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

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