server/include/cfperl.h

/*
 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
 * 
 * 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 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 <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
#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\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);
int cfperl_can_merge (object *ob1, object *ob2);

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

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;

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

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

  void parse_warn (const char *msg);
  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.88
Committed:	Thu Aug 30 07:28:25 2007 UTC (16 years, 9 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.87:	+11 -1 lines
Log Message:	fix text handling in region and map files - now utf-8 is expected for custom keys
#	Content
1	/*
2	* This file is part of Crossfire TRT, the Roguelike Realtime MORPG.
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
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 <crossfire@schmorp.de>
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 <EventAPI.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\n", __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_emergency_save ();
97	void cfperl_cleanup (int make_core);
98	void cfperl_make_book (object *book, int level);
99	void cfperl_send_msg (client ns, int color, const char type, const char *msg);
100	int cfperl_can_merge (object ob1, object ob2);
101
102	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
103
104	extern tstamp runtime; // virtual server time, excluding time jumps and lag
105	extern tstamp NOW; // real time of current server tick
106
107	enum event_klass
108	{
109	KLASS_NONE,
110	KLASS_GLOBAL,
111	KLASS_ATTACHABLE,
112	KLASS_CLIENT,
113	KLASS_PLAYER,
114	KLASS_OBJECT,
115	KLASS_MAP,
116	KLASS_COMMAND,
117	};
118
119	enum event_type
120	{
121	# define def(klass,name) EVENT_ ## klass ## _ ## name,
122	# include "eventinc.h"
123	# undef def
124	NUM_EVENT_TYPES
125	};
126
127	// in which global events or per-type events are we interested
128	extern bitset<NUM_EVENT_TYPES> ev_want_event;
129	extern bitset<NUM_TYPES> ev_want_type;
130
131	#define ARG_AV(o) DT_AV , static_cast<AV *> (o)
132	#define ARG_INT(v) DT_INT , static_cast<int> (v)
133	#define ARG_INT64(v) DT_INT64 , static_cast<sint64> (v)
134	#define ARG_DOUBLE(v) DT_DOUBLE, static_cast<double> (v)
135	#define ARG_STRING(v) DT_STRING, static_cast<const char *> (v)
136	#define ARG_DATA(s,l) DT_DATA , static_cast<const void *> (s), int (l)
137	#define ARG_OBJECT(o) DT_OBJECT, (void )(static_cast<object > (o))
138	#define ARG_MAP(o) DT_MAP , (void )(static_cast<maptile > (o))
139	#define ARG_PLAYER(o) DT_PLAYER, (void )(static_cast<player > (o))
140	#define ARG_ARCH(o) DT_ARCH , (void )(static_cast<archetype > (o))
141	#define ARG_CLIENT(o) DT_CLIENT, (void )(static_cast<client > (o))
142	#define ARG_PARTY(o) DT_PARTY , (void )(static_cast<party > (o))
143	#define ARG_REGION(o) DT_REGION, (void )(static_cast<region > (o))
144
145	// the ", ## __VA_ARGS" is, unfortunately, a gnu-cpp extension
146	#define INVOKE(obj,event, ...) (expect_false ((obj)->should_invoke (event)) ? (obj)->invoke (event, ## __VA_ARGS__, DT_END) : 0)
147	#define INVOKE_GLOBAL(event, ...) INVOKE (&gbl_ev, EVENT_ ## GLOBAL ## _ ## event, ## __VA_ARGS__)
148	#define INVOKE_ATTACHABLE(event, obj, ...) INVOKE (obj , EVENT_ ## ATTACHABLE ## _ ## event, ## __VA_ARGS__)
149	#define INVOKE_OBJECT(event, obj, ...) INVOKE (obj , EVENT_ ## OBJECT ## _ ## event, ## __VA_ARGS__)
150	#define INVOKE_CLIENT(event, obj, ...) INVOKE (obj , EVENT_ ## CLIENT ## _ ## event, ## __VA_ARGS__)
151	#define INVOKE_PLAYER(event, obj, ...) INVOKE (obj , EVENT_ ## PLAYER ## _ ## event, ## __VA_ARGS__)
152	#define INVOKE_MAP(event, obj, ...) INVOKE (obj , EVENT_ ## MAP ## _ ## event, ## __VA_ARGS__)
153
154	//TODO should index into @result
155	#define RESULT(idx,type) cfperl_result_ ## type (idx)
156	#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
157	#define RESULT_INT(idx) RESULT(idx, INT)
158
159	double cfperl_result_DOUBLE (int idx);
160	int cfperl_result_INT (int idx);
161
162	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
163
164	INTERFACE_CLASS (attachable)
165	struct attachable : refcnt_base
166	{
167	static MGVTBL vtbl;
168
169	static unordered_vector<attachable *> mortals;
170	MTH static void check_mortals ();
171
172	enum {
173	F_DESTROYED = 0x01,
174	F_DEBUG_TRACE = 0x02,
175	};
176	int ACC (RW, flags);
177
178	// object is delete'd after the refcount reaches 0
179	MTH int refcnt_cnt () const;
180	// check wether the object has died and destroy
181	MTH void refcnt_chk () { if (expect_false (refcnt <= 0)) do_check (); }
182
183	// destroy the object unless it was already destroyed
184	// this politely asks everybody interested the reduce
185	// the refcount to 0 as soon as possible.
186	MTH void destroy ();
187
188	// return wether an object was destroyed already
189	MTH bool destroyed () const { return flags & F_DESTROYED; }
190
191	virtual void gather_callbacks (AV *&callbacks, event_type event) const;
192
193	#if 0
194	private:
195	static refcounted *rc_first;
196	refcounted *rc_next;
197	#endif
198
199	HV *self; // CF+ perl self
200	AV *cb; // CF+ callbacks
201	shstr attach; // generic extension attachment information
202
203	void sever_self (); // sever this object from its self, if it has one.
204	void optimise (); // possibly save some memory by destroying unneeded data
205
206	attachable ()
207	: flags (0), self (0), cb (0), attach (0)
208	{
209	}
210
211	attachable (const attachable &src)
212	: flags (0), self (0), cb (0), attach (src.attach)
213	{
214	}
215
216	// set a custom key to the given value, or delete it if value = 0
217	void set_key (const char key, const char value = 0, bool is_utf8 = 0);
218
219	void set_key_text (const char key, const char value = 0)
220	{
221	set_key (key, value, 1);
222	}
223
224	void set_key_data (const char key, const char value = 0)
225	{
226	set_key (key, value, 0);
227	}
228
229	attachable &operator =(const attachable &src);
230
231	// used to _quickly_ device wether to shortcut the evaluation
232	bool should_invoke (event_type event)
233	{
234	return ev_want_event [event] \|\| cb;
235	}
236
237	bool invoke (event_type event, ...);
238
239	MTH void instantiate ();
240	void reattach ();
241
242	protected:
243	// do the real refcount checking work
244	void do_check ();
245
246	// the method that does the real destroy work
247	virtual void do_destroy ();
248
249	// destructor is protected, should not be called by anybody
250	virtual ~attachable ();
251	};
252
253	// the global object is a pseudo object that cares for the global events
254	struct global : attachable
255	{
256	void gather_callbacks (AV *&callbacks, event_type event) const;
257	};
258
259	extern struct global gbl_ev;
260
261	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
262
263	struct object_freezer : dynbuf_text
264	{
265	AV *av;
266
267	object_freezer ();
268	~object_freezer ();
269
270	void put (attachable *ext);
271
272	// used only for user-defined key-value pairs
273	void put (const shstr &k, const shstr &v)
274	{
275	add (k);
276
277	if (expect_true (v))
278	add (' '), add (v);
279
280	add ('\n');
281	}
282
283	template<typename T>
284	void put_kw_string (keyword k, const T &v)
285	{
286	int klen = keyword_len [k];
287	int vlen = v ? strlen (v) + 1 : 0;
288
289	char p = (char )alloc (klen + vlen + 1);
290
291	memcpy (p, keyword_str [k], klen); p += klen;
292
293	if (expect_true (v))
294	{
295	*p++ = ' '; vlen--;
296	memcpy (p, v, vlen); p += vlen;
297	}
298
299	*p = '\n';
300	}
301
302	void put (keyword k, const char *v = 0)
303	{
304	put_kw_string (k, v);
305	}
306
307	void put (keyword k, const shstr &v)
308	{
309	put_kw_string (k, v);
310	}
311
312	void put (keyword k, double v)
313	{
314	force (MAX_KEYWORD_LEN + 2 + 32);
315	fadd (keyword_str [k], keyword_len [k]);
316	fadd (' ');
317	falloc (sprintf (ptr, "%.7g", v));
318	fadd ('\n');
319	}
320
321	void put_(keyword k, sint64 v)
322	{
323	force (MAX_KEYWORD_LEN + 2 + sint64_digits);
324	fadd (keyword_str [k], keyword_len [k]);
325	fadd (' ');
326	add (v);
327	fadd ('\n');
328	}
329
330	void put_(keyword k, sint32 v)
331	{
332	force (MAX_KEYWORD_LEN + 2 + sint32_digits);
333	fadd (keyword_str [k], keyword_len [k]);
334	fadd (' ');
335	add (v);
336	fadd ('\n');
337	}
338
339	void put (keyword k, float v) { put (k, (double)v); }
340	void put (keyword k, signed char v) { put_(k, (sint32)v); }
341	void put (keyword k, unsigned char v) { put_(k, (sint32)v); }
342	void put (keyword k, signed short v) { put_(k, (sint32)v); }
343	void put (keyword k, unsigned short v) { put_(k, (sint32)v); }
344	void put (keyword k, signed int v) { put_(k, (sint32)v); }
345	void put (keyword k, unsigned int v) { put_(k, (sint64)v); }
346	void put (keyword k, signed long v) { put_(k, (sint64)v); }
347	void put (keyword k, unsigned long v) { put_(k, (sint64)v); }
348	void put (keyword k, signed long long v) { put_(k, (sint64)v); }
349	void put (keyword k, unsigned long long v) { put_(k, (sint64)v); }
350
351	void put (keyword kbeg, keyword kend, const shstr &v)
352	{
353	force (MAX_KEYWORD_LEN + 1);
354	fadd (keyword_str [kbeg], keyword_len [kbeg]); fadd ('\n');
355
356	if (expect_true (v))
357	{
358	add (v);
359	add ('\n');
360	}
361
362	force (MAX_KEYWORD_LEN + 1);
363	fadd (keyword_str [kend], keyword_len [kend]); fadd ('\n');
364	}
365
366	void put (keyword k, archetype *v);
367	void put (keyword k, treasurelist *v);
368	void put (keyword k, faceinfo *v);
369
370	template<typename T>
371	void put (keyword k, const refptr<T> &v)
372	{
373	put (k, (T *)v);
374	}
375
376	bool save (const char *path);
377	char *as_string (); // like strdup
378
379	operator bool () { return !!av; }
380	};
381
382	struct object_thawer
383	{
384	char *line; // current beginning of line
385	SV *text; // text part
386	AV *av; // perl part
387	int linenum;
388	keyword kw;
389	char *kw_str; // the keyword parsed, as string
390	char *value; // the value, or 0 if no value
391	char *value_nn; // the value, or the empty string if no value
392	const char *name;
393
394	operator bool () { return !!text; }
395
396	object_thawer (const char *path = 0);
397	object_thawer (const char data, AV perlav);
398	~object_thawer ();
399
400	void get (attachable *obj, int oid);
401
402	// parse next line
403	void next ();
404	// skip the current key-value (usually fetch next line, for
405	// multiline-fields, skips till the corresponding end-kw
406	void skip ();
407
408	char *get_str () { return value; } // may be 0
409	void get_ml (keyword kend, shstr &sh);
410
411	void get_ornull (shstr &sh) const { sh = value; }
412	void get (shstr &sh) const { sh = value; } // might want to check for non-null here
413
414	bool get_bool () const { return *value_nn == '1'; }
415	sint32 get_sint32 () const;
416	sint64 get_sint64 () const { return strtoll (value_nn, 0, 10); }
417	double get_double () const { return strtod (value_nn, 0); }
418
419	void get (float &v) { v = get_double (); }
420	void get (double &v) { v = get_double (); }
421
422	void get (bool &i) { i = get_bool (); }
423	void get (sint8 &i) { i = get_sint32 (); }
424	void get (uint8 &i) { i = get_sint32 (); }
425	void get (sint16 &i) { i = get_sint32 (); }
426	void get (uint16 &i) { i = get_sint32 (); }
427	void get (sint32 &i) { i = get_sint32 (); }
428
429	void get (uint32 &i) { i = get_sint64 (); }
430	void get (sint64 &i) { i = get_sint64 (); }
431
432	void parse_warn (const char *msg);
433	bool parse_error (const char type = 0, const char name = 0, bool skip = true);
434	};
435
436	//TODO: remove
437	char fgets (char s, int n, object_thawer &thawer);
438
439	//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
440
441	struct coroapi {
442	static struct CoroAPI *GCoroAPI;
443
444	static int nready () { return CORO_NREADY; }
445	static int cede () { return CORO_CEDE ; }
446
447	static tstamp next_cede;
448	static int cede_counter;
449
450	static void do_cede_every ();
451	static void do_cede_to_tick ();
452	static void do_cede_to_tick_every ();
453
454	static void cede_every (int count)
455	{
456	if (expect_false (++cede_counter >= count))
457	do_cede_every ();
458	}
459
460	static bool cede_to_tick ()
461	{
462	if (expect_true (now () < next_cede))
463	return false;
464
465	do_cede_to_tick ();
466	return true;
467	}
468
469	static bool cede_to_tick_every (int count)
470	{
471	if (expect_true (++cede_counter < count))
472	return false;
473
474	return cede_to_tick ();
475	}
476
477	static void wait_for_tick ();
478	static void wait_for_tick_begin ();
479	};
480
481	struct watcher_base
482	{
483	static struct EventAPI *GEventAPI;
484	};
485
486	template<class base>
487	struct watcher : watcher_base
488	{
489	base *pe;
490
491	void start (bool repeat = false) { GEventAPI->start ((pe_watcher *)pe, repeat); }
492	void stop (bool cancel_events = false) { GEventAPI->stop ((pe_watcher *)pe, cancel_events); }
493	void now () { GEventAPI->now ((pe_watcher *)pe); }
494	void suspend () { GEventAPI->suspend ((pe_watcher *)pe); }
495	void resume () { GEventAPI->resume ((pe_watcher *)pe); }
496
497	void prio (int new_prio) { ((pe_watcher *)pe)->prio = new_prio; }
498
499	~watcher ()
500	{
501	cancel ();
502	}
503
504	private:
505	void cancel () { GEventAPI->cancel ((pe_watcher *)pe); } // private
506	};
507
508	struct iw : watcher<pe_idle>, callback<void (iw &)>
509	{
510	template<class O, class M>
511	iw (O object, M method)
512	: callback<void (iw &)> (object, method)
513	{
514	alloc ();
515	}
516
517	private:
518	void alloc ();
519	};
520
521	struct iow : watcher<pe_io>, callback<void (iow &, int)>
522	{
523	template<class O, class M>
524	iow (O object, M method)
525	: callback<void (iow &, int)> (object, method)
526	{
527	alloc ();
528	}
529
530	void fd (int fd);
531	int poll ();
532	void poll (int events);
533
534	private:
535	void alloc ();
536	};
537
538	#endif
539