--- deliantra/server/include/cfperl.h	2006/08/31 09:19:34	1.18
+++ deliantra/server/include/cfperl.h	2007/07/01 05:00:18	1.81
@@ -1,17 +1,51 @@
+/*
+ * 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
@@ -24,22 +58,55 @@
 #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_boot ();
 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
@@ -50,133 +117,405 @@
   NUM_EVENT_TYPES
 };
 
-#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), (l)
-#define ARG_OBJECT(o) DT_OBJECT, (void *)static_cast<struct object *>    (o)
-#define ARG_MAP(o)    DT_MAP   , (void *)static_cast<struct mapstruct *> (o)
-#define ARG_PLAYER(o) DT_PLAYER, (void *)static_cast<struct pl *>        (o)
-#define ARG_ARCH(o)   DT_ARCH  , (void *)static_cast<struct archetype *> (o)
-#define ARG_PARTY(o)  DT_PARTY , (void *)static_cast<struct party *>     (o)
-#define ARG_REGION(o) DT_REGION, (void *)static_cast<struct region *>    (o)
+// 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
-
-// all these return true when the normal event processing should be skipped (if any)
-#define INVOKE_(event, ...) cfperl_invoke (event, ## __VA_ARGS__, DT_END)
-
-#define INVOKE(klass, event, ...)     INVOKE_(EVENT_ ## klass  ## _ ## event,                  ## __VA_ARGS__)
-#define INVOKE_GLOBAL(event, ...)     INVOKE_(EVENT_ ## GLOBAL ## _ ## event,                  ## __VA_ARGS__)
-#define INVOKE_OBJECT(event, op, ...) INVOKE_(EVENT_ ## OBJECT ## _ ## event, ARG_OBJECT (op), ## __VA_ARGS__)
-#define INVOKE_PLAYER(event, pl, ...) INVOKE_(EVENT_ ## PLAYER ## _ ## event, ARG_PLAYER (pl), ## __VA_ARGS__)
-#define INVOKE_MAP(event, map, ...)   INVOKE_(EVENT_ ## MAP    ## _ ## event, ARG_MAP (map)  , ## __VA_ARGS__)
+#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_INT(idx) RESULT(idx, INT)
+#define RESULT_DOUBLE(idx) RESULT(idx, DOUBLE)
+#define RESULT_INT(idx)    RESULT(idx, INT)
 
-bool cfperl_invoke (event_type event, ...);
+double cfperl_result_DOUBLE (int idx);
 int cfperl_result_INT (int idx);
 
-struct attachable_base
+//////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+INTERFACE_CLASS (attachable)
+struct attachable
 {
-  SV *self;
-  AV *cb;    // CF+ perl self and callback
-  const char *attach; // generic extension attachment information
+  static MGVTBL vtbl;
+
+  static unordered_vector<attachable *> mortals;
+  MTH static void check_mortals ();
 
-  void clear ();     // called when free'ing objects
-  void optimise ();  // possibly save some memory by destroying unneeded data
-  void instantiate (data_type type, void *obj);
+  enum {
+    F_DESTROYED   = 0x01,
+    F_DEBUG_TRACE = 0x02,
+  };
 
-  void attachable_init ()
+  // 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)
   {
-    self   = 0;
-    cb     = 0;
-    attach = 0;
   }
-};
 
-// objects attachable from perl (or any other extension) should include or
-// derive using the curiously recurring template pattern, to avoid
-// virtual method calls etc.
-template<class subclass>
-struct attachable : attachable_base
-{
-  void instantiate ()
+  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)
   {
-    if (attach)
-      attachable_base::instantiate ((data_type) cftype<subclass>::dt, static_cast<subclass *>(this));
+    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 ();
 };
 
-struct object_freezer
+// 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;
-  SV *text;
 
   object_freezer ();
   ~object_freezer ();
 
-  void put (attachable_base *ext);
+  void put (attachable *ext);
 
-  template<class subclass>
-  void put (attachable<subclass> *obj)
+  // used only for user-defined key-value pairs
+  void put (const shstr &k, const shstr &v)
   {
-    put ((attachable_base *)obj);
+    add (k);
+
+    if (expect_true (v))
+      add (' '), add (v);
+
+    add ('\n');
   }
 
-  void put (keyword k);
-  void put (const char *v);
-  void put (int v);
+  template<typename T>
+  void put_kw_string (keyword k, const T &v)
+  {
+    int klen = keyword_len [k];
+    int vlen = v ? strlen (v) + 1 : 0;
 
-  template<typename value>
-  void put (keyword k, value v)
+    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 (k);
-    put (v);
+    put_kw_string (k, v);
   }
 
-  bool save (const char *filename);
+  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');
+  }
 
-  operator bool () { return !!av; }
-};
+  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');
+  }
 
-// compatibility support, should be removed when no longer needed
-int fprintf (object_freezer &freezer, const char *format, ...);
-int fputs (const char *s, object_freezer &freezer);
-
-// a single key-value line from a file
-struct token {
-   keyword k;
-   const char *v;
+  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');
+  }
 
-   token (keyword k, const char *v = 0) : k(k), v(v) { }
+  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
 {
-  AV *av;
-  FILE *fp;
-  char line[1024];
+  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;
 
-  object_thawer (const char *filename = 0);
+  operator bool () { return !!text; }
+
+  object_thawer (const char *path = 0);
+  object_thawer (const char *data, AV *perlav);
   ~object_thawer ();
 
-  void get (data_type type, void *obj, attachable_base *ext, int oid);
+  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;
 
-  template<class subclass>
-  void get (attachable<subclass> *obj, int oid)
+  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)
   {
-    if (av)
-      get ((data_type) cftype<subclass>::dt, (subclass *)obj, obj, oid);
+    alloc ();
   }
 
-  token get_token ();
+  void fd (int fd);
+  int poll ();
+  void poll (int events);
 
-  operator FILE *() { return fp; }
+private:
+  void alloc ();
 };
 
 #endif