//
// cfperl.h perl interface
//
#ifndef CFPERL_H__
#define CFPERL_H__

struct pl;
struct object;
struct mapstruct;

// could have used templates, but a more traditional C api
// uses more explicit typing which is ok for this purpose.
enum data_type
{
  DT_END,     // no further arguments
  DT_INT,
  DT_INT64,
  DT_DOUBLE,
  DT_STRING,  // 0-terminated string
  DT_DATA,    // string + length
  DT_OBJECT,
  DT_MAP,
  DT_PLAYER,
  DT_ARCH,
  DT_PARTY,
  DT_REGION,

  // following are only for cfapi-compatibility
  DT_INT_PTR,
  DT_INT64_PTR,
  DT_DOUBLE_PTR,
};

enum event_klass
{
  KLASS_GLOBAL,
  KLASS_PLAYER,
  KLASS_OBJECT,
  KLASS_MAP,
};

enum event_type
{
# define def(klass,name) EV_ ## klass ## _ ## name,
#  include "eventinc.h"
# undef def
  NUM_EVENT_TYPES
};

#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)

// 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(klass, event, ...) cfperl_invoke (EV_ ## klass ## _ ## event, ## __VA_ARGS__, DT_END)

#define INVOKE_GLOBAL(event, ...)     INVOKE (GLOBAL, event,                  ## __VA_ARGS__)
#define INVOKE_OBJECT(event, op, ...) INVOKE (OBJECT, event, ARG_OBJECT (op), ## __VA_ARGS__)
#define INVOKE_PLAYER(event, pl, ...) INVOKE (PLAYER, event, ARG_PLAYER (pl), ## __VA_ARGS__)
#define INVOKE_MAP(event, map, ...)   INVOKE (MAP   , event, ARG_MAP (map)  , ## __VA_ARGS__)

struct extendable_base
{
  void *self, *cb;    // CF+ perl self and callback
  const char *attach; // generic extension attachment information

  void clear ();                                 // called when free'ing objects
  void optimise ();                              // possibly save some memory by destroying unneeded data
  void reattach (data_type type, void *self);    // called after swapin
  void instantiate (data_type type, void *self); // called on first instantiation
  void clone (data_type type, void *self, void *dest);
};

// objects extendable 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 extendable : extendable_base
{
  void clear ()
  {
    if (self || cb)
      extendable_base::clear ();
  }
  void instantiate ()
  {
    if (attach)
      extendable_base::instantiate (
         static_cast<subclass *>(this)->get_dt (),
         static_cast<subclass *>(this)
      );
  }
  void reattach ()
  {
    if (attach)
      extendable_base::reattach (
         static_cast<subclass *>(this)->get_dt (),
         static_cast<subclass *>(this)
      );
  }
  void clone (subclass *destination)
  {
    if (self || cb)
      extendable_base::clone (
         static_cast<subclass *>(this)->get_dt (),
         static_cast<subclass *>(this),
         destination
      );
  }
};

bool cfperl_invoke (event_type event, ...);
void cfperl_free_ob (struct object *op);

void cfperl_init ();
void cfperl_main ();

#endif