path: root/src/script.c

/* Copyright (c) 2008 Sadrul Habib Chowdhury (sadrul@users.sf.net)
 * 2009 Rui Guo (firemeteor.guo@gmail.com)
 *
 * This program 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, 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 (see the file COPYING); if not, write to the
 * Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
 *
 ****************************************************************
 */

#include "config.h"
#include "screen.h"
#include <stddef.h>

/*Binding structure & functions*/

struct binding *bindings = NULL;

static void
register_binding (struct binding *new_binding)
{
  if (!new_binding->registered)
    {
      new_binding->b_next = bindings;
      bindings = new_binding;
      new_binding->registered = 1;
    }
}

#ifdef LUA_BINDING
extern struct binding lua_binding;
#endif

void LoadBindings(void)
{
#ifdef LUA_BINDING
  register_binding(&lua_binding);
#endif
}

void
FinalizeBindings (void)
{
  struct binding *binding=bindings;
  while(binding)
    {
      if (binding->inited)
        binding->bd_Finit();
      binding = binding->b_next;
    }
}

void
ScriptSource(int argc, const char **argv)
{
  int ret = 0;
  int async = 0;
  const char *bd_select = 0, *script;
  struct binding *binding = bindings;

  /* Parse the commandline options
   * sourcescript [-async|-a] [-binding|-b <binding>] script
   */
  while (*argv && **argv == '-')
    {
      /* check for (-a | -async) */
      const char *arg = *argv;
      if ((arg[1] == 'a' && !arg[2])
          || strcmp(arg, "-async") == 0)
        async = 1;
      /* check for (-b | -binding) */
      else if ((arg[1] == 'b' && !arg[2])
               || strcmp(arg, "-binding") == 0) {
          argv++;
          bd_select = *argv;
      }
      argv++;
  }
  script = *argv;

  while (binding) {
      if (!bd_select || strcmp(bd_select, binding->name) == 0) {
          /*dynamically initialize the binding*/
          if (!binding->inited)
	    {
	      binding->bd_Init();
	      binding->inited = 1;
	    }

          /*and source the script*/
          if (ret = binding->bd_Source(script, async))
            break;
      }
      binding = binding->b_next;
  }
  if (!ret)
    LMsg(1, "Could not source specified script %s", script);
}

int
ScriptCall(const char *func, const char **argv)
{
  /*TODO*/
  return LuaCall(func, argv);
}

void
ScriptCmd(int argc, const char **argv)
{
  const char * sub = *argv;
  argv++;argc--;
  if (!strcmp(sub, "call"))
    ScriptCall(*argv, argv+1);
  else if (!strcmp(sub, "source"))
    ScriptSource(argc, argv);
}

/* Event notification handling */

struct gevents globalevents;

/* To add a new event, introduce a field for that event to the object in
 * question, and don't forget to put an descriptor here.  NOTE: keep the
 * name field sorted in alphabet order, the searching relies on it.
 *
 * the params string specifies the expected parameters. The length of the
 * string equals to the number of parameters. Each char specifies the type of
 * the parameter, with its meaning similar to those in printf().
 *
 * s: string (char *)
 * S: string array (char **)
 * i: signed int
 * d: display
 */

struct sev_description {
    char *name;
    char *params;
    int offset;
} event_table[] = {
      /* Global events */
      {"global_cmdexecuted", "sS", offsetof(struct gevents, cmdexecuted)},
      {"global_detached", "di", offsetof(struct gevents, detached)},
	  /* The command "detach" triggers both 'cmdexecuted' and 'detached' events.
	     However, we need the 'detached' event to trigger callbacks from remote detaches.
	   */

      /* Window events */
      {"window_resize", "", offsetof(struct win, w_sev.resize)},
      {"window_can_resize", "", offsetof(struct win, w_sev.canresize)}
};

/* Get the event queue with the given name in the obj.  If the obj is NULL,
 * global events are searched.  If no event is found, a NULL is returned.
 */
struct script_event *
object_get_event(char *obj, const char *name) 
{
  int lo, hi, n, cmp;
  if (!obj)
    obj = (char *)&globalevents;

  lo = 0;
  n = hi = sizeof(event_table) / sizeof(struct sev_description);
  while (lo < hi) 
    {
      int half;
      half = (lo + hi) >> 1;
      cmp = strcmp(name, event_table[half].name);
      if (cmp > 0)
        lo = half + 1;
      else
        hi = half;
    }

  if (lo >= n || strcmp(name, event_table[lo].name))
    return 0;
  else 
    {
      /*found an entry.*/
      struct script_event *res;
      res = (struct script_event *) (obj + event_table[lo].offset);
      /*Setup the parameter record.*/
      res->params = event_table[lo].params;
      return res;
    }
}

/* Put a listener in a proper position in the chain 
 * according to the privlege.
 * Not insert duplicate entry. return zero if successful.*/
int
register_listener(struct script_event *ev, struct listener *l)
{
  unsigned int priv = l->priv;
  struct listener *p, *iter = &ev->listeners;

#if 0
  while(iter->chain && priv >= iter->chain->priv)
    {
      iter = iter->chain;
      /* return if duplicate found*/
      if (iter->handler == l->handler
          && iter->dispatcher == l->dispatcher)
        return 1;
    }
#endif
  p = iter;

  l->chain = p->chain;
  l->prev = p;
  if (p->chain)
    p->chain->prev = l;
  p->chain = l;
  return 0;
}

void
unregister_listener(struct listener *l)
{
  struct listener *p = l->prev;
  p->chain = l->chain;
  if (l->chain)
    l->chain->prev = p;
  l->chain = l->prev = 0;
  l->handler = 0;
  free(l);
}

/* Trigger event with given parameters.*/
int
trigger_sevent(struct script_event *ev, VA_DOTS)
{
  int res = 0;
  struct listener *chain;
  char *params;
  VA_LIST(va);
  /*invalid or un-registered event structure*/
  if (!ev || !ev->params)
    return 0;

  /*process the chain in order, stop if any of the handler returns true.*/
  chain = ev->listeners.chain;
  params = ev->params;
  while (chain)
    {
      VA_START(va, ev);
      res = chain->dispatcher(chain->handler, params, va);
      VA_END(va);
      if (res)
        break;
      chain = chain->chain;
    }

  return res;
}

#define ALL_SCRIPTS(fn, params, stop) do { \
  struct binding *iter; \
  for (iter = bindings; iter; iter = iter->b_next) \
    { \
      if (iter->fns && iter->fns->fn && (ret = (iter->fns->fn params)) && stop) \
	break; \
    } \
} while (0)

void ScriptForeWindowChanged(void)
{
  int ret;
  ALL_SCRIPTS(sf_ForeWindowChanged, (), 0);
}

int ScriptProcessCaption(const char *str, struct win *win, int len)
{
  int ret = 0;
  ALL_SCRIPTS(sf_ProcessCaption, (str, win, len), 1);
  return ret;
}