src/script.c

   1 /* Copyright (c) 2008 Sadrul Habib Chowdhury (sadrul@users.sf.net)
   2  * 2009 Rui Guo (firemeteor.guo@gmail.com)
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 3, or (at your option)
   7  * any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program (see the file COPYING); if not, write to the
  16  * Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  18  *
  19  ****************************************************************
  20  */
  21
  22 #include "config.h"
  23 #include "screen.h"
  24 #include <stddef.h>
  25
  26 /*Binding structure & functions*/
  27
  28 struct binding *bindings = NULL;
  29
  30 static void
  31 register_binding (struct binding *new_binding)
  32 {
  33   if (!new_binding->registered)
  34     {
  35       new_binding->b_next = bindings;
  36       bindings = new_binding;
  37       new_binding->registered = 1;
  38     }
  39 }
  40
  41 #ifdef LUA_BINDING
  42 extern struct binding lua_binding;
  43 #endif
  44
  45 void LoadBindings(void)
  46 {
  47 #ifdef LUA_BINDING
  48   register_binding(&lua_binding);
  49 #endif
  50 }
  51
  52 void
  53 FinalizeBindings (void)
  54 {
  55   struct binding *binding=bindings;
  56   while(binding)
  57     {
  58       if (binding->inited)
  59         binding->bd_Finit();
  60       binding = binding->b_next;
  61     }
  62 }
  63
  64 void
  65 ScriptSource(int argc, const char **argv)
  66 {
  67   int ret = 0;
  68   int async = 0;
  69   const char *bd_select = 0, *script;
  70   struct binding *binding = bindings;
  71
  72   /* Parse the commandline options
  73    * sourcescript [-async|-a] [-binding|-b <binding>] script
  74    */
  75   while (*argv && **argv == '-') {
  76       /* check for (-a | -async) */
  77       if ((*argv[1] == 'a' && !*argv[2])
  78           || strcmp(*argv, "-async") == 0)
  79         async = 1;
  80       /* check for (-b | -binding) */
  81       else if ((*argv[1] == 'b' && !*argv[2])
  82                || strcmp(*argv, "-binding") == 0) {
  83           argv++;
  84           bd_select = *argv;
  85       }
  86       argv++;
  87   }
  88   script = *argv;
  89
  90   while (binding) {
  91       if (!bd_select || strcmp(bd_select, binding->name) == 0) {
  92           /*dynamically initialize the binding*/
  93           if (!binding->inited)
  94             binding->bd_Init();
  95
  96           /*and source the script*/
  97           if (ret = binding->bd_Source(script, async))
  98             break;
  99       }
 100       binding = binding->b_next;
 101   }
 102   if (!ret)
 103     LMsg(1, "Could not source specified script %s", script);
 104 }
 105
 106 void
 107 ScriptCmd(int argc, const char **argv)
 108 {
 109   const char * sub = *argv;
 110   argv++;argc--;
 111   if (!strcmp(sub, "call"))
 112     LuaCall(argv);
 113   else if (!strcmp(sub, "source"))
 114     ScriptSource(argc, argv);
 115 }
 116
 117 /* Event notification handling */
 118
 119 struct gevents {
 120     struct script_event cmdexecuted;
 121     struct script_event detached;
 122 } globalevents;
 123
 124 /* To add a new event, introduce a field for that event to the object in
 125  * question, and don't forget to put an descriptor here.  NOTE: keep the
 126  * name field sorted in alphabet order, the searching relies on it.
 127  *
 128  * the params string specifies the expected parameters. The length of the
 129  * string equals to the number of parameters. Each char specifies the type of
 130  * the parameter, with its meaning similar to those in printf().
 131  *
 132  * s: string (char *)
 133  * S: string array (char **)
 134  * i: signed int
 135  *
 136  */
 137
 138 struct {
 139     char *name;
 140     char *params;
 141     int offset;
 142 } event_table[] = {
 143       {"global_cmdexecuted", "sSi", offsetof(struct gevents, cmdexecuted)},
 144       {"global_detached", "", offsetof(struct gevents, detached)},
 145       {"window_resize", "", offsetof(struct win, w_sev.resize)},
 146       {"window_can_resize", "", offsetof(struct win, w_sev.canresize)}
 147 };
 148
 149 /* Get the event queue with the given name in the obj.  If the obj is NULL,
 150  * global events are searched.  If no event is found, a NULL is returned.
 151  */
 152 struct script_event *
 153 object_get_event(char *obj, char *name) {
 154     int lo, hi, n, cmp;
 155     if (!obj)
 156       obj = (char *)&globalevents;
 157
 158     lo = 0;
 159     n = hi = sizeof(event_table);
 160     while (lo < hi) {
 161         int half;
 162         half = (lo + hi) >> 1;
 163         cmp = strcmp(name, event_table[half].name);
 164         if (cmp > 0)
 165           lo = half + 1;
 166         else
 167           hi = half;
 168     }
 169
 170     if (lo >= n || strcmp(name, event_table[lo].name))
 171       return 0;
 172     else {
 173         /*found an entry.*/
 174         struct script_event *res;
 175         res = (struct script_event *) (obj + event_table[lo].offset);
 176         /*Setup the parameter record.*/
 177         res->params = event_table[lo].params;
 178         return res;
 179     }
 180 }
 181
 182 /* Put a listener in a proper position in the chain
 183  * according to the privlege.*/
 184 #define PRIV_MIN  -31
 185 void
 186 register_listener(struct script_event *ev, struct listener *l)
 187 {
 188   int priv;
 189   struct listener head, *p;
 190   head.chain = ev->listeners;
 191   p = &head;
 192
 193   if (l->priv < PRIV_MIN)
 194     l->priv = PRIV_MIN;
 195   priv = l->priv;
 196
 197   while (p->chain && priv >= p->chain->priv)
 198     p = p->chain;
 199
 200   l->chain = p->chain;
 201   p->chain = l;
 202   ev->listeners = head.chain;
 203 }
 204
 205 /* Trigger event with given parameters.*/
 206 int
 207 trigger_sevent(struct script_event *ev, VA_DOTS)
 208 {
 209   int res = 0;
 210   struct listener *chain;
 211   char *params;
 212   VA_LIST(va);
 213   /*invalid or un-registered event structure*/
 214   if (!ev || !ev->params)
 215     return 0;
 216
 217   /*process the chain in order, stop if any of the handler returns true.*/
 218   chain = ev->listeners;
 219   params = ev->params;
 220   while (chain)
 221     {
 222       res = chain->dispatcher(chain->handler, params, va);
 223       if (res)
 224         break;
 225     }
 226
 227   return res;
 228 }
 229
 230 #define ALL_SCRIPTS(fn, params, stop) do { \
 231   struct binding *iter; \
 232   for (iter = bindings; iter; iter = iter->b_next) \
 233     { \
 234       if (iter->fns->fn && (ret = (iter->fns->fn params)) && stop) \
 235         break; \
 236     } \
 237 } while (0)
 238
 239 void ScriptForeWindowChanged(void)
 240 {
 241   int ret;
 242   ALL_SCRIPTS(sf_ForeWindowChanged, (), 0);
 243 }
 244
 245 int ScriptProcessCaption(const char *str, struct win *win, int len)
 246 {
 247   int ret = 0;
 248   ALL_SCRIPTS(sf_ProcessCaption, (str, win, len), 1);
 249   return ret;
 250 }
 251
 252 int ScriptCommandExecuted(const char *command, const char **args, int argc)
 253 {
 254   int ret = 0;
 255   ALL_SCRIPTS(sf_CommandExecuted, (command, args, argc), 0);
 256   return ret;
 257 }
 258