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  * c: canvas
 184  */
 185
 186 struct sev_description {
 187     char *name;
 188     char *params;
 189     int offset;
 190 } event_table[] = {
 191       /* NOTE: Manually sorted in Alphabet order! */
 192
 193       /* Display events*/
 194       {"display_onidle", "d", offsetof(struct display, d_sev.onidle)},
 195       /* Global events */
 196       {"global_cmdexecuted", "sS", offsetof(struct gevents, cmdexecuted)},
 197       {"global_detached", "di", offsetof(struct gevents, detached)},
 198           /* The command "detach" triggers both 'cmdexecuted' and 'detached' events.
 199              However, we need the 'detached' event to trigger callbacks from remote detaches.
 200            */
 201       /* fore window changed to window w on display d. */
 202       {"global_forechanged", "dw", offsetof(struct gevents, forechanged)},
 203       {"global_onattach", "d", offsetof(struct gevents, onattach)},
 204       {"global_processcaption", "c", offsetof(struct gevents, processcaption)},
 205
 206       /* Window events */
 207       {"window_can_resize", "", offsetof(struct win, w_sev.canresize)},
 208       {"window_onactivity", "w", offsetof(struct win, w_sev.onactivity)},
 209       {"window_onclose", "w", offsetof(struct win, w_sev.onclose)},
 210       {"window_onfocus", "dw", offsetof(struct win, w_sev.onfocus)},
 211       /* last view of window w disappeared on display d. */
 212       {"window_onhide", "dw", offsetof(struct win, w_sev.onhide)},
 213       /* window w lost its focus on display d. */
 214       {"window_onleave", "dw", offsetof(struct win, w_sev.onleave)},
 215       {"window_onresize", "w", offsetof(struct win, w_sev.onresize)},
 216       /* window w first showed up on display d. When there are regions, it can
 217        * still be shown while losing focus. */
 218       {"window_onshow", "dw", offsetof(struct win, w_sev.onshow)},
 219       {"window_onsilent", "w", offsetof(struct win, w_sev.onsilent)},
 220 };
 221
 222 /* Get the event queue with the given name in the obj.  If the obj is NULL,
 223  * global events are searched.  If no event is found, a NULL is returned.
 224  */
 225 struct script_event *
 226 object_get_event(char *obj, const char *name)
 227 {
 228   int lo, hi, n, cmp;
 229   if (!obj)
 230     obj = (char *)&globalevents;
 231
 232   lo = 0;
 233   n = hi = sizeof(event_table) / sizeof(struct sev_description);
 234   while (lo < hi)
 235     {
 236       int half;
 237       half = (lo + hi) >> 1;
 238       cmp = strcmp(name, event_table[half].name);
 239       if (cmp > 0)
 240         lo = half + 1;
 241       else
 242         hi = half;
 243     }
 244
 245   if (lo >= n || strcmp(name, event_table[lo].name))
 246     return 0;
 247   else
 248     {
 249       /*found an entry.*/
 250       struct script_event *res;
 251       res = (struct script_event *) (obj + event_table[lo].offset);
 252       /*Setup the parameter record.*/
 253       res->params = event_table[lo].params;
 254       return res;
 255     }
 256 }
 257
 258 /* Put a listener in a proper position in the chain
 259  * according to the privlege.
 260  * Not insert duplicate entry. return zero if successful.*/
 261 int
 262 register_listener(struct script_event *ev, struct listener *l)
 263 {
 264   unsigned int priv = l->priv;
 265   struct listener *p, *iter = &ev->listeners;
 266
 267   while(iter->chain && priv >= iter->chain->priv)
 268     {
 269       iter = iter->chain;
 270     }
 271   p = iter;
 272
 273   l->chain = p->chain;
 274   l->prev = p;
 275   if (p->chain)
 276     p->chain->prev = l;
 277   p->chain = l;
 278   return 0;
 279 }
 280
 281 void
 282 unregister_listener(struct listener *l)
 283 {
 284   struct listener *p = l->prev;
 285   p->chain = l->chain;
 286   if (l->chain)
 287     l->chain->prev = p;
 288   l->chain = l->prev = 0;
 289   l->handler = 0;
 290   free(l);
 291 }
 292
 293 /* Trigger event with given parameters.*/
 294 int
 295 trigger_sevent(struct script_event *ev, VA_DOTS)
 296 {
 297   int res = 0;
 298   struct listener *chain;
 299   char *params;
 300   VA_LIST(va);
 301   /*invalid or un-registered event structure*/
 302   if (!ev || !ev->params)
 303     return 0;
 304
 305   /*process the chain in order, stop if any of the handler returns true.*/
 306   chain = ev->listeners.chain;
 307   params = ev->params;
 308   while (chain)
 309     {
 310       VA_START(va, ev);
 311       res = chain->bd->bd_dispatch(chain->handler, params, va);
 312       VA_END(va);
 313       if (res)
 314         break;
 315       chain = chain->chain;
 316     }
 317
 318   return res;
 319 }
 320
 321 #define ALL_SCRIPTS(fn, params, stop) do { \
 322   struct binding *iter; \
 323   for (iter = bindings; iter; iter = iter->b_next) \
 324     { \
 325       if (iter->fns && iter->fns->fn && (ret = (iter->fns->fn params)) && stop) \
 326         break; \
 327     } \
 328 } while (0)
 329
 330 /* Broker functions */
 331
 332 /* Broker hash */
 333 struct broker *b_hash[255];
 334
 335 #define DELETED ((struct broker*)1)
 336 #define BHASH(o) (((int)(o) >> sizeof(struct broker *)) & 255)
 337 struct broker **broker_from_obj(void *obj)
 338 {
 339   struct broker **bucket = b_hash + BHASH(obj);
 340   while (*bucket && (*bucket)->obj != obj)
 341     {
 342       bucket = &(*bucket)->b_next;
 343     }
 344   return bucket;
 345 }
 346
 347 struct broker *
 348 get_obj_broker(void *obj)
 349 {
 350   struct broker **bucket = broker_from_obj(obj);
 351   if (!obj)
 352     return NULL;
 353
 354   /* Not found, allocate a new one */
 355   if (!*bucket)
 356     {
 357       struct broker *tmp = (struct broker *)malloc(sizeof(struct broker));
 358       if (!tmp)
 359         return NULL;
 360
 361       *bucket = tmp;
 362       tmp->obj = obj;
 363       tmp->ref = 0;
 364       tmp->valid = 1;
 365       tmp->b_next = NULL;
 366     }
 367   else
 368     {
 369       /* Assertion */
 370       if (!(*bucket)->valid)
 371         exit(1);
 372     }
 373   (*bucket)->ref++;
 374
 375   return *bucket;
 376 }
 377
 378 void * get_broker_obj(struct broker **pbroker)
 379 {
 380   struct broker *broker = *pbroker;
 381   if (!broker)
 382     return NULL;
 383
 384   if (broker->valid)
 385     return broker->obj;
 386
 387   /* Clear the invalid reference, and decrease the ref-count. */
 388   broker_unref(pbroker);
 389   return NULL;
 390 }
 391
 392 void broker_inv_obj(void *obj)
 393 {
 394   struct broker *n, **b = broker_from_obj(obj);
 395   if (*b) {
 396     (*b)->valid = 0;
 397     /* Unplug the broker from the hash. */
 398     n = *b;
 399     *b = (*b)->b_next;
 400     n->b_next = 0;
 401   }
 402 }
 403
 404 void broker_unref(struct broker **pbroker)
 405 {
 406   struct broker *broker = *pbroker;
 407   *pbroker = NULL;
 408   if (--broker->ref == 0)
 409     {
 410       if (broker->valid) {
 411           struct broker *n, **b = broker_from_obj(broker->obj);
 412           if (*b) {
 413               n = (*b)->b_next;
 414               free(*b);
 415               *b = n;
 416           } else {
 417               /* FIXME:Should not happen! But act better.*/
 418               exit(1);
 419           }
 420       } else {
 421           /* It had been unplugged before. */
 422           free(broker);
 423       }
 424     }
 425 }