server/include/cfperl.h

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

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

// virtual server time, excluding time jumps and lag
extern double runtime;

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

  //TODO//temporary, used only for saving body locations
  void put (const char *k, int v)
  {
    add (k);
    add (' ');
    add (sint32 (v));
    add ('\n');
  }

  template<typename T>
  void put_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_string (k, v);
  }

  void put (keyword k, const shstr &v)
  {
    put_string (k, v);
  }

  void put (keyword k, double v)
  {
    char buf [128];

    snprintf (buf, 128, "%.7g", v);

    put (k, (const char *)buf);
  }

  void put_(keyword k, sint64 v)
  {
    add (keyword_str [k], keyword_len [k]);
    add (' ');
    add (v);
    add ('\n');
  }

  void put_(keyword k, sint32 v)
  {
    add (keyword_str [k], keyword_len [k]);
    add (' ');
    add (v);
    add ('\n');
  }

  void put (keyword kbeg, keyword kend, const shstr &v)
  {
    add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');

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

    add (keyword_str [kend], keyword_len [kend]); add ('\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); }

  template<typename T>
  void put (keyword k, const T *v)
  {
    if (expect_true (v))
      put (k, v->name);
    else
      put (k, (const char *)0);
  }

  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 untilt he corresponding end-kw
  void skip ();

  //TODO: remove, deprecated
  keyword get_kv ()
  {
    next ();
    return kw;
  }

  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 atoll (value_nn); }
  double get_double () const { return atof  (value_nn); }

  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 double (*time)();
  static double 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 void cede_to_tick ()
  {
    if (expect_false (time () >= next_cede))
      do_cede_to_tick ();
  }

  static void cede_to_tick_every (int count)
  {
    if (expect_false (++cede_counter >= count))
      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.67
Committed:	Sun May 27 23:14:37 2007 UTC (17 years ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.66:	+0 -4 lines
Log Message:	remove remainign compatibility cruft
#	User	Rev	Content
1	root	1.1	//
2			// cfperl.h perl interface
3			//
4	root	1.2	#ifndef CFPERL_H__
5			#define CFPERL_H__
6
7	root	1.64	#include <cstdarg>
8	root	1.16	#include <cstdio>
9	root	1.64	#include <bitset>
10	root	1.16
11			using namespace std;
12
13			#include <EXTERN.h>
14			#include <perl.h>
15	root	1.20	#include <XSUB.h>
16	root	1.16
17	root	1.36	#include <EventAPI.h>
18	root	1.42	#include <CoroAPI.h>
19	root	1.36
20	root	1.42	#include "util.h"
21			#include "keyword.h"
22			#include "dynbuf.h"
23	root	1.36	#include "callback.h"
24
25	root	1.42	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
26
27	root	1.16	// optimisations/workaround for functions requiring my_perl in scope (anti-bloat)
28			#undef localtime
29			#undef srand48
30			#undef drand48
31			#undef srandom
32			#undef readdir
33			#undef getprotobyname
34			#undef gethostbyname
35			#undef ctime
36			#undef strerror
37
38	root	1.39	// same here, massive symbol spamming
39			#undef do_open
40			#undef do_close
41	root	1.42	#undef ref
42	root	1.44	#undef seed
43	root	1.39
44	root	1.16	// perl bug #40256: perl does overwrite those with reentrant versions
45			// but does not initialise their state structures.
46			#undef random
47			#undef crypt
48
49	root	1.42	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
50
51			// some macros to simplify perl in-calls
52
53			#define CHECK_ERROR \
54			if (SvTRUE (ERRSV)) \
55			LOG (llevError, "runtime error in %s: %s\n", __func__, SvPVutf8_nolen (ERRSV));
56
57			#define CALL_BEGIN(args) dSP; ENTER; SAVETMPS; PUSHMARK (SP); EXTEND (SP, args)
58			#define CALL_ARG_SV(sv) PUSHs (sv_2mortal (sv)) // separate because no refcount inc
59			#define CALL_ARG(expr) PUSHs (sv_2mortal (to_sv (expr)))
60			#define CALL_CALL(name, flags) PUTBACK; int count = call_pv (name, (flags) \| G_EVAL); SPAGAIN;
61			#define CALL_END CHECK_ERROR; FREETMPS; LEAVE
62
63			//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
64
65	root	1.7	void cfperl_init ();
66			void cfperl_main ();
67	root	1.50	void cfperl_emergency_save ();
68	root	1.55	void cfperl_cleanup (int make_core);
69	root	1.65	void cfperl_make_book (object *book, int level);
70	root	1.7
71	root	1.42	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
72
73			// virtual server time, excluding time jumps and lag
74			extern double runtime;
75
76	root	1.6	enum event_klass
77			{
78	root	1.11	KLASS_NONE,
79	root	1.3	KLASS_GLOBAL,
80	root	1.41	KLASS_ATTACHABLE,
81	root	1.40	KLASS_CLIENT,
82	root	1.3	KLASS_PLAYER,
83			KLASS_OBJECT,
84			KLASS_MAP,
85	root	1.33	KLASS_COMMAND,
86	root	1.3	};
87
88	root	1.6	enum event_type
89			{
90	root	1.7	# define def(klass,name) EVENT_ ## klass ## _ ## name,
91	root	1.2	# include "eventinc.h"
92			# undef def
93	root	1.4	NUM_EVENT_TYPES
94	root	1.2	};
95
96	root	1.64	// in which global events or per-type events are we interested
97			extern bitset<NUM_EVENT_TYPES> ev_want_event;
98			extern bitset<NUM_TYPES> ev_want_type;
99
100	root	1.41	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
101			#define ARG_INT(v) DT_INT , static_cast<int> (v)
102			#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
103			#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
104			#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
105			#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
106			#define ARG_OBJECT(o) DT_OBJECT, (void )(static_cast<object > (o))
107			#define ARG_MAP(o) DT_MAP , (void )(static_cast<maptile > (o))
108			#define ARG_PLAYER(o) DT_PLAYER, (void )(static_cast<player > (o))
109			#define ARG_ARCH(o) DT_ARCH , (void )(static_cast<archetype > (o))
110			#define ARG_CLIENT(o) DT_CLIENT, (void )(static_cast<client > (o))
111			#define ARG_PARTY(o) DT_PARTY , (void )(static_cast<party > (o))
112			#define ARG_REGION(o) DT_REGION, (void )(static_cast<region > (o))
113	root	1.3
114			// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
115	root	1.66	#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
116			#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
117			#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__)
118			#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__)
119			#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
120			#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__)
121			#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
122	root	1.3
123	root	1.7	//TODO should index into @result
124			#define RESULT(idx,type) cfperl_result_ ## type (idx)
125	root	1.33	#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
126			#define RESULT_INT(idx) RESULT(idx, INT)
127	root	1.7
128	root	1.34	double cfperl_result_DOUBLE (int idx);
129			int cfperl_result_INT (int idx);
130	root	1.7
131	root	1.42	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
132
133	root	1.47	INTERFACE_CLASS (attachable)
134	root	1.41	struct attachable
135	root	1.6	{
136	root	1.42	static MGVTBL vtbl;
137
138	root	1.41	static unordered_vector<attachable *> mortals;
139	root	1.47	MTH static void check_mortals ();
140	root	1.41
141			enum {
142	root	1.54	F_DESTROYED = 0x01,
143			F_DEBUG_TRACE = 0x02,
144	root	1.41	};
145
146			// object is delete'd after the refcount reaches 0
147	pippijn	1.58	int ACC (RW, flags);
148	root	1.47	mutable int ACC (RW, refcnt);
149	root	1.41
150	root	1.47	MTH void refcnt_inc () const { ++refcnt; }
151			MTH void refcnt_dec () const { --refcnt; }
152	root	1.41
153	root	1.49	MTH int refcnt_cnt () const;
154	root	1.41	// check wether the object has died and destroy
155	root	1.47	MTH void refcnt_chk () { if (refcnt <= 0) do_check (); }
156	root	1.41
157			// destroy the object unless it was already destroyed
158			// this politely asks everybody interested the reduce
159			// the refcount to 0 as soon as possible.
160	root	1.47	MTH void destroy ();
161	root	1.41
162			// return wether an object was destroyed already
163	root	1.47	MTH bool destroyed () const { return flags & F_DESTROYED; }
164	root	1.41
165			virtual void gather_callbacks (AV *&callbacks, event_type event) const;
166
167			#if 0
168			private:
169			static refcounted *rc_first;
170			refcounted *rc_next;
171			#endif
172
173			HV *self; // CF+ perl self
174	root	1.35	AV *cb; // CF+ callbacks
175	root	1.21	shstr attach; // generic extension attachment information
176	root	1.6
177	root	1.52	void sever_self (); // sever this object from its self, if it has one.
178			void optimise (); // possibly save some memory by destroying unneeded data
179	root	1.8
180	root	1.41	attachable ()
181			: flags (0), refcnt (0), self (0), cb (0), attach (0)
182	root	1.8	{
183			}
184	root	1.22
185	root	1.41	attachable (const attachable &src)
186			: flags (0), refcnt (0), self (0), cb (0), attach (src.attach)
187	root	1.22	{
188			}
189
190	root	1.41	virtual ~attachable ();
191
192			attachable &operator =(const attachable &src);
193
194	root	1.66	// used to _quickly_ device wether to shortcut the evaluation
195			bool should_invoke (event_type event)
196	root	1.64	{
197	root	1.66	return ev_want_event [event] \|\| cb;
198	root	1.64	}
199
200	root	1.66	bool invoke (event_type event, ...);
201
202	root	1.48	MTH void instantiate ();
203	root	1.41	void reattach ();
204	root	1.24
205	root	1.41	protected:
206			// do the real refcount checking work
207			void do_check ();
208	root	1.25
209	root	1.41	// the method that does the real destroy work
210			virtual void do_destroy ();
211	root	1.6	};
212
213	root	1.41	// the global object is a pseudo object that cares for the global events
214			struct global : attachable
215	root	1.6	{
216	root	1.41	void gather_callbacks (AV *&callbacks, event_type event) const;
217	root	1.6	};
218
219	root	1.41	extern struct global gbl_ev;
220
221	root	1.42	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
222
223	root	1.63	struct object_freezer : dynbuf_text
224	root	1.7	{
225	root	1.17	AV *av;
226	root	1.12
227	root	1.17	object_freezer ();
228	root	1.8	~object_freezer ();
229
230	root	1.41	void put (attachable *ext);
231	root	1.15
232	root	1.29	// used only for user-defined key-value pairs
233			void put (const shstr &k, const shstr &v)
234	root	1.20	{
235			add (k);
236
237	root	1.66	if (expect_true (v))
238	root	1.22	add (' '), add (v);
239	root	1.20
240			add ('\n');
241			}
242
243	root	1.29	//TODO//temporary, used only for saving body locations
244	root	1.20	void put (const char *k, int v)
245			{
246			add (k);
247			add (' ');
248			add (sint32 (v));
249			add ('\n');
250			}
251	root	1.19
252	root	1.29	template<typename T>
253			void put_string (keyword k, const T &v)
254	root	1.20	{
255			int klen = keyword_len [k];
256	root	1.22	int vlen = v ? strlen (v) + 1 : 0;
257
258			char p = (char )alloc (klen + vlen + 1);
259
260			memcpy (p, keyword_str [k], klen); p += klen;
261
262	root	1.66	if (expect_true (v))
263	root	1.22	{
264	root	1.29	*p++ = ' '; vlen--;
265	root	1.22	memcpy (p, v, vlen); p += vlen;
266			}
267
268			*p = '\n';
269			}
270
271	root	1.45	void put (keyword k, const char *v = 0)
272	root	1.29	{
273			put_string (k, v);
274			}
275
276	root	1.22	void put (keyword k, const shstr &v)
277			{
278	root	1.29	put_string (k, v);
279	root	1.20	}
280	root	1.19
281	root	1.20	void put (keyword k, double v)
282			{
283			char buf [128];
284
285			snprintf (buf, 128, "%.7g", v);
286
287			put (k, (const char *)buf);
288			}
289
290			void put_(keyword k, sint64 v)
291			{
292			add (keyword_str [k], keyword_len [k]);
293			add (' ');
294			add (v);
295			add ('\n');
296			}
297
298			void put_(keyword k, sint32 v)
299			{
300			add (keyword_str [k], keyword_len [k]);
301			add (' ');
302			add (v);
303			add ('\n');
304			}
305
306	root	1.23	void put (keyword kbeg, keyword kend, const shstr &v)
307	root	1.20	{
308			add (keyword_str [kbeg], keyword_len [kbeg]); add ('\n');
309
310	root	1.66	if (expect_true (v))
311	root	1.20	{
312			add (v);
313			add ('\n');
314			}
315
316			add (keyword_str [kend], keyword_len [kend]); add ('\n');
317			}
318
319			void put (keyword k, float v) { put (k, (double)v); }
320	root	1.19	void put (keyword k, signed char v) { put_(k, (sint32)v); }
321			void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
322			void put (keyword k, signed short v) { put_(k, (sint32)v); }
323			void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
324			void put (keyword k, signed int v) { put_(k, (sint32)v); }
325			void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
326			void put (keyword k, signed long v) { put_(k, (sint64)v); }
327			void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
328			void put (keyword k, signed long long v) { put_(k, (sint64)v); }
329			void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
330
331			template<typename T>
332	root	1.32	void put (keyword k, const T *v)
333	root	1.18	{
334	root	1.66	if (expect_true (v))
335	root	1.23	put (k, v->name);
336			else
337			put (k, (const char *)0);
338	root	1.18	}
339
340	root	1.32	template<typename T>
341			void put (keyword k, const refptr<T> &v)
342			{
343			put (k, (T *)v);
344			}
345
346	root	1.47	bool save (const char *path);
347	root	1.31	char *as_string (); // like strdup
348	root	1.17
349	root	1.16	operator bool () { return !!av; }
350	root	1.7	};
351
352	root	1.17	struct object_thawer
353	root	1.7	{
354	root	1.66	char *line; // current beginning of line
355	root	1.21	SV *text; // text part
356			AV *av; // perl part
357	root	1.53	int linenum;
358	root	1.56	keyword kw;
359	root	1.66	char *kw_str; // the keyword parsed, as string
360			char *value; // the value, or 0 if no value
361			char *value_nn; // the value, or the empty string if no value
362	root	1.47	const char *name;
363	root	1.21
364			operator bool () { return !!text; }
365	root	1.16
366	root	1.47	object_thawer (const char *path = 0);
367	root	1.30	object_thawer (const char data, AV perlav);
368	root	1.8	~object_thawer ();
369
370	root	1.41	void get (attachable *obj, int oid);
371	root	1.15
372	root	1.56	// parse next line
373	root	1.57	void next ();
374			// skip the current key-value (usually fetch next line, for
375			// multiline-fields, skips untilt he corresponding end-kw
376			void skip ();
377
378			//TODO: remove, deprecated
379	root	1.56	keyword get_kv ()
380			{
381	root	1.57	next ();
382	root	1.56	return kw;
383			}
384
385	root	1.57	char *get_str () { return value; } // may be 0
386	root	1.66	void get_ml (keyword kend, shstr &sh);
387	root	1.17
388	root	1.56	void get_ornull (shstr &sh) const { sh = value; }
389	root	1.66	void get (shstr &sh) const { sh = value; } // might want to check for non-null here
390	root	1.21
391	root	1.66	bool get_bool () const { return *value_nn == '1'; }
392	root	1.21	sint32 get_sint32 () const;
393	root	1.66	sint64 get_sint64 () const { return atoll (value_nn); }
394			double get_double () const { return atof (value_nn); }
395	root	1.21
396	root	1.42	void get (float &v) { v = get_double (); }
397	root	1.21	void get (double &v) { v = get_double (); }
398
399	root	1.66	void get (bool &i) { i = get_bool (); }
400	root	1.21	void get (sint8 &i) { i = get_sint32 (); }
401			void get (uint8 &i) { i = get_sint32 (); }
402			void get (sint16 &i) { i = get_sint32 (); }
403			void get (uint16 &i) { i = get_sint32 (); }
404			void get (sint32 &i) { i = get_sint32 (); }
405
406			void get (uint32 &i) { i = get_sint64 (); }
407			void get (sint64 &i) { i = get_sint64 (); }
408	root	1.53
409	root	1.56	bool parse_error (const char type = 0, const char name = 0, bool skip = true);
410	root	1.7	};
411	root	1.2
412	root	1.53	//TODO: remove
413	root	1.21	char fgets (char s, int n, object_thawer &thawer);
414
415	root	1.42	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
416
417			struct coroapi {
418			static struct CoroAPI *GCoroAPI;
419
420			static int nready () { return CORO_NREADY; }
421			static int cede () { return CORO_CEDE ; }
422	root	1.46
423	root	1.62	static double (*time)();
424			static double next_cede;
425	root	1.46	static int cede_counter;
426
427	root	1.62	static void do_cede_every ();
428			static void do_cede_to_tick ();
429			static void do_cede_to_tick_every ();
430
431	root	1.46	static void cede_every (int count)
432			{
433	root	1.66	if (expect_false (++cede_counter >= count))
434	root	1.62	do_cede_every ();
435			}
436	root	1.46
437	root	1.62	static void cede_to_tick ()
438			{
439	root	1.66	if (expect_false (time () >= next_cede))
440	root	1.62	do_cede_to_tick ();
441			}
442
443			static void cede_to_tick_every (int count)
444			{
445	root	1.66	if (expect_false (++cede_counter >= count))
446	root	1.62	cede_to_tick ();
447	root	1.46	}
448	root	1.61
449			static void wait_for_tick ();
450			static void wait_for_tick_begin ();
451	root	1.42	};
452
453	root	1.36	struct watcher_base
454			{
455			static struct EventAPI *GEventAPI;
456			};
457
458			template<class base>
459			struct watcher : watcher_base
460			{
461			base *pe;
462
463			void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); }
464			void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); }
465			void now () { GEventAPI->now ((pe_watcher *)pe); }
466			void suspend () { GEventAPI->suspend ((pe_watcher *)pe); }
467			void resume () { GEventAPI->resume ((pe_watcher *)pe); }
468
469			void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; }
470
471			~watcher ()
472			{
473			cancel ();
474			}
475
476			private:
477			void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private
478			};
479
480	root	1.38	struct iw : watcher<pe_idle>, callback<void (iw &)>
481			{
482			template<class O, class M>
483			iw (O object, M method)
484			: callback<void (iw &)> (object, method)
485			{
486			alloc ();
487			}
488
489			private:
490			void alloc ();
491			};
492
493	root	1.36	struct iow : watcher<pe_io>, callback<void (iow &, int)>
494			{
495			template<class O, class M>
496			iow (O object, M method)
497			: callback<void (iow &, int)> (object, method)
498			{
499			alloc ();
500			}
501
502	root	1.38	void fd (int fd);
503	root	1.36	int poll ();
504	root	1.38	void poll (int events);
505	root	1.36
506			private:
507			void alloc ();
508			};
509
510	root	1.2	#endif
511	root	1.3