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 "extern.h"
  25 #include <stddef.h>
  26
  27 /*Binding structure & functions*/
  28
  29 struct binding *bindings = NULL;
  30
  31 static void
  32 register_binding (struct binding *new_binding)
  33 {
  34   if (!new_binding->registered)
  35     {
  36       new_binding->b_next = bindings;
  37       bindings = new_binding;
  38       new_binding->registered = 1;
  39     }
  40 }
  41
  42 #ifdef LUA_BINDING
  43 extern struct binding lua_binding;
  44 #endif
  45
  46 void LoadBindings(void)
  47 {
  48 #ifdef LUA_BINDING
  49   register_binding(&lua_binding);
  50 #endif
  51 }
  52
  53 void
  54 FinalizeBindings (void)
  55 {
  56   struct binding *binding=bindings;
  57   while(binding)
  58     {
  59       if (binding->inited)
  60         binding->bd_Finit();
  61       binding = binding->b_next;
  62     }
  63 }
  64
  65 void
  66 ScriptSource(int argc, const char **argv)
  67 {
  68   int ret = 0;
  69   int async = 0;
  70   const char *bd_select = 0, *script;
  71   struct binding *binding = bindings;
  72
  73   /* Parse the commandline options
  74    * script source [-async|-a] [-binding|-b <binding>] script
  75    */
  76   while (*argv && **argv == '-')
  77     {
  78       /* check for (-a | -async) */
  79       const char *arg = *argv;
  80       if ((arg[1] == 'a' && !arg[2])
  81           || strcmp(arg, "-async") == 0)
  82         async = 1;
  83       /* check for (-b | -binding) */
  84       else if ((arg[1] == 'b' && !arg[2])
  85                || strcmp(arg, "-binding") == 0)
  86         {
  87           argv++;
  88           bd_select = *argv;
  89         }
  90       argv++;
  91     }
  92   script = *argv;
  93
  94   while (binding)
  95     {
  96       if (!bd_select || strcmp(bd_select, binding->name) == 0)
  97         {
  98           /*dynamically initialize the binding*/
  99           if (!binding->inited)
 100             {
 101               binding->bd_Init();
 102               binding->inited = 1;
 103             }
 104
 105           /*and source the script*/
 106           ret = binding->bd_Source(script, async);
 107           if (ret)
 108             break;
 109         }
 110       binding = binding->b_next;
 111     }
 112   if (!ret)
 113     LMsg(0, "Could not source specified script %s", script);
 114 }
 115
 116 int
 117 ScriptCall(int argc, const char **argv)
 118 {
 119   int ret = 0;
 120   struct binding *binding = bindings;
 121   const char *bd_select = 0, *func;
 122   /* Parse the commandline options
 123    * script call [-binding|-b <binding>] function
 124    */
 125   while (*argv && **argv == '-')
 126     {
 127       const char *arg = *argv;
 128       /* check for (-b | -binding) */
 129       if ((arg[1] == 'b' && !arg[2])
 130           || strcmp(arg, "-binding") == 0)
 131         {
 132           argv++;
 133           bd_select = *argv;
 134         }
 135       argv++;
 136     }
 137   func = *argv;
 138   argv++;
 139
 140   while (binding)
 141     {
 142       if (!bd_select || strcmp(bd_select, binding->name) == 0)
 143         {
 144           ret = binding->bd_call(func, argv);
 145           if (ret)
 146             break;
 147         }
 148       binding = binding->b_next;
 149     }
 150
 151   if (!ret)
 152     LMsg(0, "Failed to run specified script coummand '%s'", func);
 153   return ret;
 154 }
 155
 156 void
 157 ScriptCmd(int argc, const char **argv)
 158 {
 159   const char * sub = *argv;
 160   argv++;argc--;
 161   if (!strcmp(sub, "call"))
 162     ScriptCall(argc, argv);
 163   else if (!strcmp(sub, "source"))
 164     ScriptSource(argc, argv);
 165 }
 166
 167 /* Event notification handling */
 168
 169 struct gevents globalevents;
 170
 171 /* To add a new event, introduce a field for that event to the object in
 172  * question, and don't forget to put an descriptor here.  NOTE: keep the
 173  * name field sorted in alphabet order, the searching relies on it.
 174  *
 175  * the params string specifies the expected parameters. The length of the
 176  * string equals to the number of parameters. Each char specifies the type of
 177  * the parameter, with its meaning similar to those in printf().
 178  *
 179  * s: string (char *)
 180  * S: string array (char **)
 181  * i: signed int
 182  * d: display
 183  */
 184
 185 struct sev_description {
 186     char *name;
 187     char *params;
 188     int offset;
 189 } event_table[] = {
 190       /* Global events */
 191       {"global_cmdexecuted", "sS", offsetof(struct gevents, cmdexecuted)},
 192       {"global_detached", "di", offsetof(struct gevents, detached)},
 193           /* The command "detach" triggers both 'cmdexecuted' and 'detached' events.
 194              However, we need the 'detached' event to trigger callbacks from remote detaches.
 195            */
 196       {"global_forechanged", "dw", offsetof(struct gevents, forechanged)},
 197
 198       /* Window events */
 199       {"window_resize", "", offsetof(struct win, w_sev.resize)},
 200       {"window_can_resize", "", offsetof(struct win, w_sev.canresize)}
 201 };
 202
 203 /* Get the event queue with the given name in the obj.  If the obj is NULL,
 204  * global events are searched.  If no event is found, a NULL is returned.
 205  */
 206 struct script_event *
 207 object_get_event(char *obj, const char *name)
 208 {
 209   int lo, hi, n, cmp;
 210   if (!obj)
 211     obj = (char *)&globalevents;
 212
 213   lo = 0;
 214   n = hi = sizeof(event_table) / sizeof(struct sev_description);
 215   while (lo < hi)
 216     {
 217       int half;
 218       half = (lo + hi) >> 1;
 219       cmp = strcmp(name, event_table[half].name);
 220       if (cmp > 0)
 221         lo = half + 1;
 222       else
 223         hi = half;
 224     }
 225
 226   if (lo >= n || strcmp(name, event_table[lo].name))
 227     return 0;
 228   else
 229     {
 230       /*found an entry.*/
 231       struct script_event *res;
 232       res = (struct script_event *) (obj + event_table[lo].offset);
 233       /*Setup the parameter record.*/
 234       res->params = event_table[lo].params;
 235       return res;
 236     }
 237 }
 238
 239 /* Put a listener in a proper position in the chain
 240  * according to the privlege.
 241  * Not insert duplicate entry. return zero if successful.*/
 242 int
 243 register_listener(struct script_event *ev, struct listener *l)
 244 {
 245   unsigned int priv = l->priv;
 246   struct listener *p, *iter = &ev->listeners;
 247
 248   while(iter->chain && priv >= iter->chain->priv)
 249     {
 250       iter = iter->chain;
 251     }
 252   p = iter;
 253
 254   l->chain = p->chain;
 255   l->prev = p;
 256   if (p->chain)
 257     p->chain->prev = l;
 258   p->chain = l;
 259   return 0;
 260 }
 261
 262 void
 263 unregister_listener(struct listener *l)
 264 {
 265   struct listener *p = l->prev;
 266   p->chain = l->chain;
 267   if (l->chain)
 268     l->chain->prev = p;
 269   l->chain = l->prev = 0;
 270   l->handler = 0;
 271   free(l);
 272 }
 273
 274 /* Trigger event with given parameters.*/
 275 int
 276 trigger_sevent(struct script_event *ev, VA_DOTS)
 277 {
 278   int res = 0;
 279   struct listener *chain;
 280   char *params;
 281   VA_LIST(va);
 282   /*invalid or un-registered event structure*/
 283   if (!ev || !ev->params)
 284     return 0;
 285
 286   /*process the chain in order, stop if any of the handler returns true.*/
 287   chain = ev->listeners.chain;
 288   params = ev->params;
 289   while (chain)
 290     {
 291       VA_START(va, ev);
 292       res = chain->bd->bd_dispatch(chain->handler, params, va);
 293       VA_END(va);
 294       if (res)
 295         break;
 296       chain = chain->chain;
 297     }
 298
 299   return res;
 300 }
 301
 302 #define ALL_SCRIPTS(fn, params, stop) do { \
 303   struct binding *iter; \
 304   for (iter = bindings; iter; iter = iter->b_next) \
 305     { \
 306       if (iter->fns && iter->fns->fn && (ret = (iter->fns->fn params)) && stop) \
 307         break; \
 308     } \
 309 } while (0)
 310
 311 int ScriptProcessCaption(const char *str, struct win *win, int len)
 312 {
 313   int ret = 0;
 314   ALL_SCRIPTS(sf_ProcessCaption, (str, win, len), 1);
 315   return ret;
 316 }
 317