server/include/cfperl.h

/*
 * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
 * 
 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Crossfire TRT 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 2 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 Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 * 
 * The authors can be reached via e-mail to <crossfire@schmorp.de>
 */

//
// 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 <EventAPI.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

// 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

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

// some macros to simplify perl in-calls

#define CHECK_ERROR                     \
  if (SvTRUE (ERRSV))                   \
    LOG (llevError, "runtime error in %s: %s\n", __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_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);

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

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
{
  static MGVTBL vtbl;

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

  enum {
    F_DESTROYED   = 0x01,
    F_DEBUG_TRACE = 0x02,
  };

  // object is delete'd after the refcount reaches 0
  int ACC (RW, flags);
  mutable int ACC (RW, refcnt);

  MTH void refcnt_inc () const { ++refcnt; }
  MTH void refcnt_dec () const { --refcnt; }

  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), refcnt (0), self (0), cb (0), attach (0)
  {
  }

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

  virtual ~attachable ();

  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 ();
};

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

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

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);
  }

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

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

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
  char *value_nn; // the value, or the empty string if no value
  const char *name;

  operator bool () { 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
  void next ();
  // skip the current key-value (usually fetch next line, for
  // multiline-fields, skips till the corresponding end-kw
  void skip ();

  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 (); }

  bool parse_error (const char *type = 0, const char *name = 0, bool skip = true);
};

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

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

struct coroapi {
  static struct CoroAPI *GCoroAPI;

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

  static tstamp next_cede;
  static int cede_counter;

  static void do_cede_every ();
  static void do_cede_to_tick ();
  static void do_cede_to_tick_every ();

  static void cede_every (int count)
  {
    if (expect_false (++cede_counter >= count))
      do_cede_every ();
  }

  static bool cede_to_tick ()
  {
    if (expect_true (now () < next_cede))
      return false;

    do_cede_to_tick ();
    return true;
  }

  static bool cede_to_tick_every (int count)
  {
    if (expect_true (++cede_counter < count))
      return false;

    return cede_to_tick ();
  }

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

struct watcher_base
{
  static struct EventAPI *GEventAPI;
};

template<class base>
struct watcher : watcher_base
{
  base *pe;

  void start   (bool repeat = false)        { GEventAPI->start   ((pe_watcher *)pe, repeat); }
  void stop    (bool cancel_events = false) { GEventAPI->stop    ((pe_watcher *)pe, cancel_events); }
  void now     ()                           { GEventAPI->now     ((pe_watcher *)pe); }
  void suspend ()                           { GEventAPI->suspend ((pe_watcher *)pe); }
  void resume  ()                           { GEventAPI->resume  ((pe_watcher *)pe); }

  void prio    (int new_prio)               { ((pe_watcher *)pe)->prio = new_prio; }

  ~watcher ()
  {
    cancel ();
  }

private:
  void cancel  ()                           { GEventAPI->cancel  ((pe_watcher *)pe); } // private
};

struct iw : watcher<pe_idle>, callback<void (iw &)>
{
  template<class O, class M>
  iw (O object, M method)
  : callback<void (iw &)> (object, method)
  {
    alloc ();
  }

private:
  void alloc ();
};

struct iow : watcher<pe_io>, callback<void (iow &, int)>
{
  template<class O, class M>
  iow (O object, M method)
  : callback<void (iow &, int)> (object, method)
  {
    alloc ();
  }

  void fd (int fd);
  int poll ();
  void poll (int events);

private:
  void alloc ();
};

#endif

Revision:	1.80
Committed:	Sun Jun 24 04:09:29 2007 UTC (16 years, 11 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.79:	+1 -0 lines
Log Message:	first rough cut of msg rewriting, introducing cfpod, a haxored pod variant for crossfire messgaes. where will it end?
#	Content
1	/*
2	* This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
3	*
4	* Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5	* Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6	* Copyright (©) 1992,2007 Frank Tore Johansen
7	*
8	* Crossfire TRT is free software; you can redistribute it and/or modify it
9	* under the terms of the GNU General Public License as published by the Free
10	* Software Foundation; either version 2 of the License, or (at your option)
11	* any later version.
12	*
13	* This program is distributed in the hope that it will be useful, but
14	* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
15	* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16	* for more details.
17	*
18	* You should have received a copy of the GNU General Public License along
19	* with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
20	* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21	*
22	* The authors can be reached via e-mail to <crossfire@schmorp.de>
23	*/
24
25	//
26	// cfperl.h perl interface
27	//
28	#ifndef CFPERL_H__
29	#define CFPERL_H__
30
31	#include <cstdarg>
32	#include <cstdio>
33	#include <bitset>
34
35	using namespace std;
36
37	#include <EXTERN.h>
38	#include <perl.h>
39	#include <XSUB.h>
40
41	#include <EventAPI.h>
42	#include <CoroAPI.h>
43
44	#include "util.h"
45	#include "keyword.h"
46	#include "dynbuf.h"
47	#include "callback.h"
48
49	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
50
51	// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
52	#undef localtime
53	#undef srand48
54	#undef drand48
55	#undef srandom
56	#undef readdir
57	#undef getprotobyname
58	#undef gethostbyname
59	#undef ctime
60	#undef strerror
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	// some macros to simplify perl in-calls
76
77	#define CHECK_ERROR \
78	if (SvTRUE (ERRSV)) \
79	LOG (llevError, "runtime error in %s: %s\n", __func__, SvPVutf8_nolen (ERRSV));
80
81	#define CALL_BEGIN(args) dSP; ENTER; SAVETMPS; PUSHMARK (SP); EXTEND (SP, args)
82	#define CALL_ARG_SV(sv) PUSHs (sv_2mortal (sv)) // separate because no refcount inc
83	#define CALL_ARG(expr) PUSHs (sv_2mortal (to_sv (expr)))
84	#define CALL_CALL(name, flags) PUTBACK; int count = call_pv (name, (flags) \| G_EVAL); SPAGAIN;
85	#define CALL_END CHECK_ERROR; FREETMPS; LEAVE
86
87	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
88
89	void cfperl_init ();
90	void cfperl_main ();
91	void cfperl_emergency_save ();
92	void cfperl_cleanup (int make_core);
93	void cfperl_make_book (object *book, int level);
94	void cfperl_send_msg (client ns, int color, const char type, const char *msg);
95
96	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
97
98	extern tstamp runtime; // virtual server time, excluding time jumps and lag
99	extern tstamp NOW; // real time of current server tick
100
101	enum event_klass
102	{
103	KLASS_NONE,
104	KLASS_GLOBAL,
105	KLASS_ATTACHABLE,
106	KLASS_CLIENT,
107	KLASS_PLAYER,
108	KLASS_OBJECT,
109	KLASS_MAP,
110	KLASS_COMMAND,
111	};
112
113	enum event_type
114	{
115	# define def(klass,name) EVENT_ ## klass ## _ ## name,
116	# include "eventinc.h"
117	# undef def
118	NUM_EVENT_TYPES
119	};
120
121	// in which global events or per-type events are we interested
122	extern bitset<NUM_EVENT_TYPES> ev_want_event;
123	extern bitset<NUM_TYPES> ev_want_type;
124
125	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
126	#define ARG_INT(v) DT_INT , static_cast<int> (v)
127	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
128	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
129	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
130	#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
131	#define ARG_OBJECT(o) DT_OBJECT, (void )(static_cast<object > (o))
132	#define ARG_MAP(o) DT_MAP , (void )(static_cast<maptile > (o))
133	#define ARG_PLAYER(o) DT_PLAYER, (void )(static_cast<player > (o))
134	#define ARG_ARCH(o) DT_ARCH , (void )(static_cast<archetype > (o))
135	#define ARG_CLIENT(o) DT_CLIENT, (void )(static_cast<client > (o))
136	#define ARG_PARTY(o) DT_PARTY , (void )(static_cast<party > (o))
137	#define ARG_REGION(o) DT_REGION, (void )(static_cast<region > (o))
138
139	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
140	#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
141	#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
142	#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__)
143	#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__)
144	#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
145	#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__)
146	#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
147
148	//TODO should index into @result
149	#define RESULT(idx,type) cfperl_result_ ## type (idx)
150	#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
151	#define RESULT_INT(idx) RESULT(idx, INT)
152
153	double cfperl_result_DOUBLE (int idx);
154	int cfperl_result_INT (int idx);
155
156	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
157
158	INTERFACE_CLASS (attachable)
159	struct attachable
160	{
161	static MGVTBL vtbl;
162
163	static unordered_vector<attachable *> mortals;
164	MTH static void check_mortals ();
165
166	enum {
167	F_DESTROYED = 0x01,
168	F_DEBUG_TRACE = 0x02,
169	};
170
171	// object is delete'd after the refcount reaches 0
172	int ACC (RW, flags);
173	mutable int ACC (RW, refcnt);
174
175	MTH void refcnt_inc () const { ++refcnt; }
176	MTH void refcnt_dec () const { --refcnt; }
177
178	MTH int refcnt_cnt () const;
179	// check wether the object has died and destroy
180	MTH void refcnt_chk () { if (expect_false (refcnt <= 0)) do_check (); }
181
182	// destroy the object unless it was already destroyed
183	// this politely asks everybody interested the reduce
184	// the refcount to 0 as soon as possible.
185	MTH void destroy ();
186
187	// return wether an object was destroyed already
188	MTH bool destroyed () const { return flags & F_DESTROYED; }
189
190	virtual void gather_callbacks (AV *&callbacks, event_type event) const;
191
192	#if 0
193	private:
194	static refcounted *rc_first;
195	refcounted *rc_next;
196	#endif
197
198	HV *self; // CF+ perl self
199	AV *cb; // CF+ callbacks
200	shstr attach; // generic extension attachment information
201
202	void sever_self (); // sever this object from its self, if it has one.
203	void optimise (); // possibly save some memory by destroying unneeded data
204
205	attachable ()
206	: flags (0), refcnt (0), self (0), cb (0), attach (0)
207	{
208	}
209
210	attachable (const attachable &src)
211	: flags (0), refcnt (0), self (0), cb (0), attach (src.attach)
212	{
213	}
214
215	virtual ~attachable ();
216
217	attachable &operator =(const attachable &src);
218
219	// used to _quickly_ device wether to shortcut the evaluation
220	bool should_invoke (event_type event)
221	{
222	return ev_want_event [event] \|\| cb;
223	}
224
225	bool invoke (event_type event, ...);
226
227	MTH void instantiate ();
228	void reattach ();
229
230	protected:
231	// do the real refcount checking work
232	void do_check ();
233
234	// the method that does the real destroy work
235	virtual void do_destroy ();
236	};
237
238	// the global object is a pseudo object that cares for the global events
239	struct global : attachable
240	{
241	void gather_callbacks (AV *&callbacks, event_type event) const;
242	};
243
244	extern struct global gbl_ev;
245
246	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
247
248	struct object_freezer : dynbuf_text
249	{
250	AV *av;
251
252	object_freezer ();
253	~object_freezer ();
254
255	void put (attachable *ext);
256
257	// used only for user-defined key-value pairs
258	void put (const shstr &k, const shstr &v)
259	{
260	add (k);
261
262	if (expect_true (v))
263	add (' '), add (v);
264
265	add ('\n');
266	}
267
268	template<typename T>
269	void put_kw_string (keyword k, const T &v)
270	{
271	int klen = keyword_len [k];
272	int vlen = v ? strlen (v) + 1 : 0;
273
274	char p = (char )alloc (klen + vlen + 1);
275
276	memcpy (p, keyword_str [k], klen); p += klen;
277
278	if (expect_true (v))
279	{
280	*p++ = ' '; vlen--;
281	memcpy (p, v, vlen); p += vlen;
282	}
283
284	*p = '\n';
285	}
286
287	void put (keyword k, const char *v = 0)
288	{
289	put_kw_string (k, v);
290	}
291
292	void put (keyword k, const shstr &v)
293	{
294	put_kw_string (k, v);
295	}
296
297	void put (keyword k, double v)
298	{
299	force (MAX_KEYWORD_LEN + 2 + 32);
300	fadd (keyword_str [k], keyword_len [k]);
301	fadd (' ');
302	falloc (sprintf (ptr, "%.7g", v));
303	fadd ('\n');
304	}
305
306	void put_(keyword k, sint64 v)
307	{
308	force (MAX_KEYWORD_LEN + 2 + sint64_digits);
309	fadd (keyword_str [k], keyword_len [k]);
310	fadd (' ');
311	add (v);
312	fadd ('\n');
313	}
314
315	void put_(keyword k, sint32 v)
316	{
317	force (MAX_KEYWORD_LEN + 2 + sint32_digits);
318	fadd (keyword_str [k], keyword_len [k]);
319	fadd (' ');
320	add (v);
321	fadd ('\n');
322	}
323
324	void put (keyword k, float v) { put (k, (double)v); }
325	void put (keyword k, signed char v) { put_(k, (sint32)v); }
326	void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
327	void put (keyword k, signed short v) { put_(k, (sint32)v); }
328	void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
329	void put (keyword k, signed int v) { put_(k, (sint32)v); }
330	void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
331	void put (keyword k, signed long v) { put_(k, (sint64)v); }
332	void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
333	void put (keyword k, signed long long v) { put_(k, (sint64)v); }
334	void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
335
336	void put (keyword kbeg, keyword kend, const shstr &v)
337	{
338	force (MAX_KEYWORD_LEN + 1);
339	fadd (keyword_str [kbeg], keyword_len [kbeg]); fadd ('\n');
340
341	if (expect_true (v))
342	{
343	add (v);
344	add ('\n');
345	}
346
347	force (MAX_KEYWORD_LEN + 1);
348	fadd (keyword_str [kend], keyword_len [kend]); fadd ('\n');
349	}
350
351	void put (keyword k, archetype *v);
352	void put (keyword k, treasurelist *v);
353	void put (keyword k, faceinfo *v);
354
355	template<typename T>
356	void put (keyword k, const refptr<T> &v)
357	{
358	put (k, (T *)v);
359	}
360
361	bool save (const char *path);
362	char *as_string (); // like strdup
363
364	operator bool () { return !!av; }
365	};
366
367	struct object_thawer
368	{
369	char *line; // current beginning of line
370	SV *text; // text part
371	AV *av; // perl part
372	int linenum;
373	keyword kw;
374	char *kw_str; // the keyword parsed, as string
375	char *value; // the value, or 0 if no value
376	char *value_nn; // the value, or the empty string if no value
377	const char *name;
378
379	operator bool () { return !!text; }
380
381	object_thawer (const char *path = 0);
382	object_thawer (const char data, AV perlav);
383	~object_thawer ();
384
385	void get (attachable *obj, int oid);
386
387	// parse next line
388	void next ();
389	// skip the current key-value (usually fetch next line, for
390	// multiline-fields, skips till the corresponding end-kw
391	void skip ();
392
393	char *get_str () { return value; } // may be 0
394	void get_ml (keyword kend, shstr &sh);
395
396	void get_ornull (shstr &sh) const { sh = value; }
397	void get (shstr &sh) const { sh = value; } // might want to check for non-null here
398
399	bool get_bool () const { return *value_nn == '1'; }
400	sint32 get_sint32 () const;
401	sint64 get_sint64 () const { return strtoll (value_nn, 0, 10); }
402	double get_double () const { return strtod (value_nn, 0); }
403
404	void get (float &v) { v = get_double (); }
405	void get (double &v) { v = get_double (); }
406
407	void get (bool &i) { i = get_bool (); }
408	void get (sint8 &i) { i = get_sint32 (); }
409	void get (uint8 &i) { i = get_sint32 (); }
410	void get (sint16 &i) { i = get_sint32 (); }
411	void get (uint16 &i) { i = get_sint32 (); }
412	void get (sint32 &i) { i = get_sint32 (); }
413
414	void get (uint32 &i) { i = get_sint64 (); }
415	void get (sint64 &i) { i = get_sint64 (); }
416
417	bool parse_error (const char type = 0, const char name = 0, bool skip = true);
418	};
419
420	//TODO: remove
421	char fgets (char s, int n, object_thawer &thawer);
422
423	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
424
425	struct coroapi {
426	static struct CoroAPI *GCoroAPI;
427
428	static int nready () { return CORO_NREADY; }
429	static int cede () { return CORO_CEDE ; }
430
431	static tstamp next_cede;
432	static int cede_counter;
433
434	static void do_cede_every ();
435	static void do_cede_to_tick ();
436	static void do_cede_to_tick_every ();
437
438	static void cede_every (int count)
439	{
440	if (expect_false (++cede_counter >= count))
441	do_cede_every ();
442	}
443
444	static bool cede_to_tick ()
445	{
446	if (expect_true (now () < next_cede))
447	return false;
448
449	do_cede_to_tick ();
450	return true;
451	}
452
453	static bool cede_to_tick_every (int count)
454	{
455	if (expect_true (++cede_counter < count))
456	return false;
457
458	return cede_to_tick ();
459	}
460
461	static void wait_for_tick ();
462	static void wait_for_tick_begin ();
463	};
464
465	struct watcher_base
466	{
467	static struct EventAPI *GEventAPI;
468	};
469
470	template<class base>
471	struct watcher : watcher_base
472	{
473	base *pe;
474
475	void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); }
476	void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); }
477	void now () { GEventAPI->now ((pe_watcher *)pe); }
478	void suspend () { GEventAPI->suspend ((pe_watcher *)pe); }
479	void resume () { GEventAPI->resume ((pe_watcher *)pe); }
480
481	void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; }
482
483	~watcher ()
484	{
485	cancel ();
486	}
487
488	private:
489	void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private
490	};
491
492	struct iw : watcher<pe_idle>, callback<void (iw &)>
493	{
494	template<class O, class M>
495	iw (O object, M method)
496	: callback<void (iw &)> (object, method)
497	{
498	alloc ();
499	}
500
501	private:
502	void alloc ();
503	};
504
505	struct iow : watcher<pe_io>, callback<void (iow &, int)>
506	{
507	template<class O, class M>
508	iow (O object, M method)
509	: callback<void (iow &, int)> (object, method)
510	{
511	alloc ();
512	}
513
514	void fd (int fd);
515	int poll ();
516	void poll (int events);
517
518	private:
519	void alloc ();
520	};
521
522	#endif
523