nlua_hook.c

Go to the documentation of this file.

/*
 * See Licensing and Copyright notice in naev.h
 */
#include <lauxlib.h>
#include <lua.h>
#include <math.h>
#include <stdio.h>
#include <stdlib.h>
 
#include "naev.h"
#include "nlua_hook.h"
 
#include "array.h"
#include "event.h"
#include "hook.h"
#include "log.h"
#include "mission.h"
#include "nlua_evt.h"
#include "nlua_misn.h"
#include "nlua_pilot.h"
#include "nlua_time.h"
#include "nluadef.h"
#include "nstring.h"
 
/* Hook methods. */
static int hookL_rm( lua_State *L );
static int hookL_load( lua_State *L );
static int hookL_land( lua_State *L );
static int hookL_info( lua_State *L );
static int hookL_takeoff( lua_State *L );
static int hookL_jumpout( lua_State *L );
static int hookL_jumpin( lua_State *L );
static int hookL_enter( lua_State *L );
static int hookL_hail( lua_State *L );
static int hookL_board( lua_State *L );
static int hookL_timer( lua_State *L );
static int hookL_date( lua_State *L );
static int hookL_commbuy( lua_State *L );
static int hookL_commsell( lua_State *L );
static int hookL_commjettison( lua_State *L );
static int hookL_gather( lua_State *L );
static int hookL_outfitbuy( lua_State *L );
static int hookL_outfitsell( lua_State *L );
static int hookL_shipbuy( lua_State *L );
static int hookL_shipsell( lua_State *L );
static int hookL_shipswap( lua_State *L );
static int hookL_equip( lua_State *L );
static int hookL_input( lua_State *L );
static int hookL_mouse( lua_State *L );
static int hookL_safe( lua_State *L );
static int hookL_update( lua_State *L );
static int hookL_renderbg( lua_State *L );
static int hookL_renderfg( lua_State *L );
static int hookL_rendertop( lua_State *L );
static int hookL_mission_done( lua_State *L );
static int hookL_standing( lua_State *L );
static int hookL_discover( lua_State *L );
static int hookL_asteroidScan( lua_State *L );
static int hookL_pay( lua_State *L );
static int hookL_custom( lua_State *L );
static int hookL_pilot( lua_State *L );
static const luaL_Reg hookL_methods[] = {
   { "rm", hookL_rm },
   { "load", hookL_load },
   { "land", hookL_land },
   { "info", hookL_info },
   { "takeoff", hookL_takeoff },
   { "jumpout", hookL_jumpout },
   { "jumpin", hookL_jumpin },
   { "enter", hookL_enter },
   { "hail", hookL_hail },
   { "board", hookL_board },
   { "timer", hookL_timer },
   { "date", hookL_date },
   { "gather", hookL_gather },
   { "comm_buy", hookL_commbuy },
   { "comm_sell", hookL_commsell },
   { "comm_jettison", hookL_commjettison },
   { "outfit_buy", hookL_outfitbuy },
   { "outfit_sell", hookL_outfitsell },
   { "equip", hookL_equip },
   { "ship_buy", hookL_shipbuy },
   { "ship_sell", hookL_shipsell },
   { "ship_swap", hookL_shipswap },
   { "input", hookL_input },
   { "mouse", hookL_mouse },
   { "safe", hookL_safe },
   { "update", hookL_update },
   { "renderbg", hookL_renderbg },
   { "renderfg", hookL_renderfg },
   { "rendertop", hookL_rendertop },
   { "mission_done", hookL_mission_done },
   { "standing", hookL_standing },
   { "discover", hookL_discover },
   { "asteroid_scan", hookL_asteroidScan },
   { "pay", hookL_pay },
   { "custom", hookL_custom },
   { "pilot", hookL_pilot },
   {0,0}
}; 
/*
 * Prototypes.
 */
static int hookL_setarg( unsigned int hook, int ind );
static unsigned int hookL_generic( lua_State *L, const char* stack, double ms, int pos, ntime_t date, int arg );
 
int nlua_loadHook( nlua_env env )
{
   nlua_register(env, "hook", hookL_methods, 0);
   return 0;
}
 
static int hookL_rm( lua_State *L )
{
   /* Remove the hook. */
   long h = luaL_optlong( L, 1, -1 );
   /* ... Or do a no-op if caller passes nil. */
   if (h < 0)
      return 0;
   hook_rm( (unsigned int) h );
   return 0;
}
 
static int hookL_setarg( unsigned int hook, int ind )
{
   nlua_env env = hook_env(hook);
 
   /* Create if necessary the actual hook argument table. */
   nlua_getenv(naevL, env, "mem");           /* t */
   lua_getfield(naevL, -1, "__hook_arg");    /* t, t */
   if (lua_isnil(naevL,-1)) {                /* t, nil */
      lua_pop( naevL, 1 );                   /* t */
      lua_newtable( naevL );                 /* t, t */
      lua_pushvalue( naevL, -1 );            /* t, t, t */
      lua_setfield(naevL, -3, "__hook_arg"); /* t, t */
   }
   lua_pushnumber( naevL, hook );            /*t, t, k */
   lua_pushvalue( naevL, ind );              /*t, t, k, v */
   lua_settable( naevL, -3 );                /*t, t */
   lua_pop( naevL, 2 );                      /* */
   return 0;
}
 
void hookL_unsetarg( unsigned int hook )
{
   nlua_env env = hook_env(hook);
 
   if (env == LUA_NOREF)
       return;
 
   nlua_getenv(naevL, env, "mem");        /* t */
   lua_getfield(naevL, -1, "__hook_arg"); /* t, t */
   if (!lua_isnil(naevL,-1)) {
      lua_pushnumber( naevL, hook );      /* t, h */
      lua_pushnil( naevL );               /* t, h, n */
      lua_settable( naevL, -3 );          /* t */
   }
   lua_pop( naevL, 2 );
}
 
int hookL_getarg( unsigned int hook )
{
   nlua_env env = hook_env(hook);
 
   if (env == LUA_NOREF)
       return 0;
 
   nlua_getenv(naevL, env, "mem");       /* t */
   lua_getfield(naevL, -1, "__hook_arg");/* t, t */
   if (!lua_isnil(naevL,-1)) {           /* t, t */
      lua_pushnumber( naevL, hook );     /* t, t, k */
      lua_gettable( naevL, -2 );         /* t, t, v */
      lua_remove( naevL, -2 );           /* t, v */
   }
   lua_remove( naevL, -2 );              /* v */
   return 1;
}
 
static unsigned int hookL_generic( lua_State *L, const char* stack, double sec, int pos, ntime_t date, int arg )
{
   const char *func;
   unsigned int h;
   Event_t *running_event;
   Mission *running_mission;
 
   /* Last parameter must be function to hook */
   func = luaL_checkstring(L,pos);
 
   /* Get stuff. */
   running_event = event_getFromLua(L);
   running_mission = misn_getFromLua(L);
 
   if (running_mission != NULL) {
      int i;
      /* make sure mission is a player mission */
      for (i=0; i<array_size(player_missions); i++)
         if (player_missions[i]->id == running_mission->id)
            break;
      if (i>=array_size(player_missions)) {
         WARN(_("Mission not in stack trying to hook, forgot to run misn.accept()?"));
         return 0;
      }
 
      if (stack != NULL)
         h = hook_addMisn( running_mission->id, func, stack );
      else if (date != 0)
         h = hook_addDateMisn( running_mission->id, func, date );
      else
         h = hook_addTimerMisn( running_mission->id, func, sec );
   }
   else if (running_event != NULL) {
      if (stack != NULL)
         h = hook_addEvent( running_event->id, func, stack );
      else if (date != 0)
         h = hook_addDateEvt( running_event->id, func, date );
      else
         h = hook_addTimerEvt( running_event->id, func, sec );
   }
   else {
      NLUA_ERROR(L,_("Attempting to set a hook outside of a mission or event."));
      return 0;
   }
 
   if (h == 0) {
      NLUA_ERROR(L,_("No hook target was set."));
      return 0;
   }
 
   /* Check parameter. */
   if (!lua_isnoneornil(L,arg))
      hookL_setarg( h, arg );
 
   return h;
}
 
static int hookL_land( lua_State *L )
{
   unsigned int h;
 
   if (lua_isstring(L,2)) {
      const char *where = luaL_checkstring(L, 2);
      /* TODO validity checking? */
      h = hookL_generic( L, where, 0., 1, 0, 3 );
   }
   else
      h = hookL_generic( L, "land", 0., 1, 0, 2 );
 
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_info( lua_State *L )
{
   unsigned int h;
 
   if (lua_isstring(L,2)) {
      char buf[STRMAX_SHORT];
      const char *where = luaL_checkstring(L, 2);
      snprintf( buf, sizeof(buf), "info_%s", where );
      /* TODO validity checking? */
      h = hookL_generic( L, buf, 0., 1, 0, 3 );
   }
   else
      h = hookL_generic( L, "info", 0., 1, 0, 2 );
 
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_load( lua_State *L )
{
   unsigned int h = hookL_generic( L, "load", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_takeoff( lua_State *L )
{
   unsigned int h = hookL_generic( L, "takeoff", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_jumpout( lua_State *L )
{
   unsigned int h = hookL_generic( L, "jumpout", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_jumpin( lua_State *L )
{
   unsigned int h = hookL_generic( L, "jumpin", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_enter( lua_State *L )
{
   unsigned int h = hookL_generic( L, "enter", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_hail( lua_State *L )
{
   unsigned int h = hookL_generic( L, "hail", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_board( lua_State *L )
{
   unsigned int h = hookL_generic( L, "board", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_timer( lua_State *L )
{
   double s       = luaL_checknumber( L, 1 );
   unsigned int h = hookL_generic( L, NULL, s, 2, 0, 3 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_date( lua_State *L )
{
   ntime_t t      = luaL_validtime( L, 1 );
   unsigned int h = hookL_generic( L, NULL, 0., 2, t, 3 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_commbuy( lua_State *L )
{
   unsigned int h = hookL_generic( L, "comm_buy", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_commsell( lua_State *L )
{
   unsigned int h = hookL_generic( L, "comm_sell", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_commjettison( lua_State *L )
{
   unsigned int h = hookL_generic( L, "comm_jettison", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_gather( lua_State *L )
{
   unsigned int h = hookL_generic( L, "gather", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_outfitbuy( lua_State *L )
{
   unsigned int h = hookL_generic( L, "outfit_buy", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_outfitsell( lua_State *L )
{
   unsigned int h = hookL_generic( L, "outfit_sell", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_equip( lua_State *L )
{
   unsigned int h = hookL_generic( L, "equip", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_shipbuy( lua_State *L )
{
   unsigned int h = hookL_generic( L, "ship_buy", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_shipsell( lua_State *L )
{
   unsigned int h = hookL_generic( L, "ship_sell", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_shipswap( lua_State *L )
{
   unsigned int h = hookL_generic( L, "ship_swap", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_input( lua_State *L )
{
   unsigned int h = hookL_generic( L, "input", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_mouse( lua_State *L )
{
   unsigned int h = hookL_generic( L, "mouse", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_standing( lua_State *L )
{
   unsigned int h = hookL_generic( L, "standing", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_discover( lua_State *L )
{
   unsigned int h = hookL_generic( L, "discover", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_asteroidScan( lua_State *L )
{
   unsigned int h = hookL_generic( L, "asteroid_scan", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_pay( lua_State *L )
{
   unsigned int h = hookL_generic( L, "pay", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_safe( lua_State *L )
{
   unsigned int h = hookL_generic( L, "safe", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_update( lua_State *L )
{
   unsigned int h = hookL_generic( L, "update", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_renderbg( lua_State *L )
{
   unsigned int h = hookL_generic( L, "renderbg", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_renderfg( lua_State *L )
{
   unsigned int h = hookL_generic( L, "renderfg", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_rendertop( lua_State *L )
{
   unsigned int h = hookL_generic( L, "rendertop", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_mission_done( lua_State *L )
{
   unsigned int h = hookL_generic( L, "mission_done", 0., 1, 0, 2 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_custom( lua_State *L )
{
   const char *hookname = luaL_checkstring(L,1);
   unsigned int h       = hookL_generic( L, hookname, 0., 2, 0, 3 );
   lua_pushnumber( L, h );
   return 1;
}
 
static int hookL_pilot( lua_State *L )
{
   unsigned int h;
   LuaPilot p;
   int type;
   const char *hook_type;
   char buf[64]; /* Large enough buffer to hold any of the allowed hook-type names. */
 
   /* Parameters. */
   if (lua_ispilot(L,1))
      p  = luaL_checkpilot(L,1);
   else if (lua_isnil(L,1))
      p  = 0;
   else {
      NLUA_ERROR(L, _("Invalid parameter #1 for hook.pilot, expecting pilot or nil."));
      return 0;
   }
   hook_type   = luaL_checkstring(L,2);
 
   /* Check to see if hook_type is valid */
   if (strcmp(hook_type,"creation")==0)      type = PILOT_HOOK_CREATION;
   else if (strcmp(hook_type,"death")==0)    type = PILOT_HOOK_DEATH;
   else if (strcmp(hook_type,"exploded")==0) type = PILOT_HOOK_EXPLODED;
   else if (strcmp(hook_type,"boarding")==0) type = PILOT_HOOK_BOARDING;
   else if (strcmp(hook_type,"boardall")==0) type = PILOT_HOOK_BOARD_ALL;
   else if (strcmp(hook_type,"board")==0)    type = PILOT_HOOK_BOARD;
   else if (strcmp(hook_type,"disable")==0)  type = PILOT_HOOK_DISABLE;
   else if (strcmp(hook_type,"undisable")==0)type = PILOT_HOOK_UNDISABLE;
   else if (strcmp(hook_type,"jump")==0)     type = PILOT_HOOK_JUMP;
   else if (strcmp(hook_type,"hail")==0)     type = PILOT_HOOK_HAIL;
   else if (strcmp(hook_type,"land")==0)     type = PILOT_HOOK_LAND;
   else if (strcmp(hook_type,"attacked")==0) type = PILOT_HOOK_ATTACKED;
   else if (strcmp(hook_type,"discovered")==0)type = PILOT_HOOK_DISCOVERED;
   else if (strcmp(hook_type,"scan")==0)     type = PILOT_HOOK_SCAN;
   else if (strcmp(hook_type,"scanned")==0)  type = PILOT_HOOK_SCANNED;
   else if (strcmp(hook_type,"idle")==0)     type = PILOT_HOOK_IDLE;
   else if (strcmp(hook_type,"lockon")==0)   type = PILOT_HOOK_LOCKON;
   else if (strcmp(hook_type,"stealth")==0)  type = PILOT_HOOK_STEALTH;
   else { /* hook_type not valid */
      NLUA_ERROR(L, _("Invalid pilot hook type: '%s'"), hook_type);
      return 0;
   }
 
#ifdef DEBUGGING
   if ((type == PILOT_HOOK_CREATION) && (p!=0))
      NLUA_ERROR( L, _("'creation' pilot hook can not be set on a specific pilot, only globally.") );
#endif /* DEBUGGING */
 
   /* actually add the hook */
   snprintf( buf, sizeof(buf), "p_%s", hook_type );
   h = hookL_generic( L, buf, 0., 3, 0, 4 );
   if (p==0)
      pilots_addGlobalHook( type, h );
   else
      pilot_addHook( pilot_get(p), type, h );
 
   lua_pushnumber( L, h );
   return 1;
}