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