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 int
 107 ScriptCall(const char *func, const char **argv)
 108 {
 109   /*TODO*/
 110   return LuaCall(func, argv);
 111 }
 112
 113 void
 114 ScriptCmd(int argc, const char **argv)
 115 {
 116   const char * sub = *argv;
 117   argv++;argc--;
 118   if (!strcmp(sub, "call"))
 119     ScriptCall(*argv, argv+1);
 120   else if (!strcmp(sub, "source"))
 121     ScriptSource(argc, argv);
 122 }
 123
 124 /* Event notification handling */
 125
 126 struct gevents {
 127     struct script_event cmdexecuted;
 128     struct script_event detached;
 129 } globalevents;
 130
 131 /* To add a new event, introduce a field for that event to the object in
 132  * question, and don't forget to put an descriptor here.  NOTE: keep the
 133  * name field sorted in alphabet order, the searching relies on it.
 134  *
 135  * the params string specifies the expected parameters. The length of the
 136  * string equals to the number of parameters. Each char specifies the type of
 137  * the parameter, with its meaning similar to those in printf().
 138  *
 139  * s: string (char *)
 140  * S: string array (char **)
 141  * i: signed int
 142  *
 143  */
 144
 145 struct {
 146     char *name;
 147     char *params;
 148     int offset;
 149 } event_table[] = {
 150       {"global_cmdexecuted", "sSi", offsetof(struct gevents, cmdexecuted)},
 151       {"global_detached", "", offsetof(struct gevents, detached)},
 152       {"window_resize", "", offsetof(struct win, w_sev.resize)},
 153       {"window_can_resize", "", offsetof(struct win, w_sev.canresize)}
 154 };
 155
 156 /* Get the event queue with the given name in the obj.  If the obj is NULL,
 157  * global events are searched.  If no event is found, a NULL is returned.
 158  */
 159 struct script_event *
 160 object_get_event(char *obj, char *name) {
 161     int lo, hi, n, cmp;
 162     if (!obj)
 163       obj = (char *)&globalevents;
 164
 165     lo = 0;
 166     n = hi = sizeof(event_table);
 167     while (lo < hi) {
 168         int half;
 169         half = (lo + hi) >> 1;
 170         cmp = strcmp(name, event_table[half].name);
 171         if (cmp > 0)
 172           lo = half + 1;
 173         else
 174           hi = half;
 175     }
 176
 177     if (lo >= n || strcmp(name, event_table[lo].name))
 178       return 0;
 179     else {
 180         /*found an entry.*/
 181         struct script_event *res;
 182         res = (struct script_event *) (obj + event_table[lo].offset);
 183         /*Setup the parameter record.*/
 184         res->params = event_table[lo].params;
 185         return res;
 186     }
 187 }
 188
 189 /* Put a listener in a proper position in the chain
 190  * according to the privlege.*/
 191 #define PRIV_MIN  -31
 192 void
 193 register_listener(struct script_event *ev, struct listener *l)
 194 {
 195   int priv;
 196   struct listener head, *p;
 197   head.chain = ev->listeners;
 198   p = &head;
 199
 200   if (l->priv < PRIV_MIN)
 201     l->priv = PRIV_MIN;
 202   priv = l->priv;
 203
 204   while (p->chain && priv >= p->chain->priv)
 205     p = p->chain;
 206
 207   l->chain = p->chain;
 208   p->chain = l;
 209   ev->listeners = head.chain;
 210 }
 211
 212 /* Trigger event with given parameters.*/
 213 int
 214 trigger_sevent(struct script_event *ev, VA_DOTS)
 215 {
 216   int res = 0;
 217   struct listener *chain;
 218   char *params;
 219   VA_LIST(va);
 220   /*invalid or un-registered event structure*/
 221   if (!ev || !ev->params)
 222     return 0;
 223
 224   /*process the chain in order, stop if any of the handler returns true.*/
 225   chain = ev->listeners;
 226   params = ev->params;
 227   while (chain)
 228     {
 229       VA_START(va, ev);
 230       res = chain->dispatcher(chain->handler, params, va);
 231       VA_END(va);
 232       if (res)
 233         break;
 234     }
 235
 236   return res;
 237 }
 238
 239 #define ALL_SCRIPTS(fn, params, stop) do { \
 240   struct binding *iter; \
 241   for (iter = bindings; iter; iter = iter->b_next) \
 242     { \
 243       if (iter->fns->fn && (ret = (iter->fns->fn params)) && stop) \
 244         break; \
 245     } \
 246 } while (0)
 247
 248 void ScriptForeWindowChanged(void)
 249 {
 250   int ret;
 251   ALL_SCRIPTS(sf_ForeWindowChanged, (), 0);
 252 }
 253
 254 int ScriptProcessCaption(const char *str, struct win *win, int len)
 255 {
 256   int ret = 0;
 257   ALL_SCRIPTS(sf_ProcessCaption, (str, win, len), 1);
 258   return ret;
 259 }
 260
 261 int ScriptCommandExecuted(const char *command, const char **args, int argc)
 262 {
 263   int ret = 0;
 264   ALL_SCRIPTS(sf_CommandExecuted, (command, args, argc), 0);
 265   return ret;
 266 }
 267