src/script.h

   1 /* Copyright (c) 2008 Sadrul Habib Chowdhury (sadrul@users.sf.net)
   2  *
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 3, or (at your option)
   6  * any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program (see the file COPYING); if not, write to the
  15  * Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  17  *
  18  ****************************************************************
  19  * $Id$ FAU
  20  */
  21 #ifndef SCRIPT_H
  22 #define SCRIPT_H
  23 struct win;
  24
  25 /*Obsolete*/
  26 struct ScriptFuncs
  27 {
  28   int (*sf_ForeWindowChanged) __P((void));
  29   int (*sf_ProcessCaption) __P((const char *, struct win *, int len));
  30 };
  31
  32 /***Language binding***/
  33 struct binding
  34 {
  35   char * name;
  36   int inited;
  37   int registered;
  38   int (*bd_Init) __P((void));
  39   int (*bd_Finit) __P((void));
  40   int (*bd_call) __P((char *func, char **argv));
  41   /*Returns zero on failure, non zero on success*/
  42   int (*bd_Source) __P((const char *, int));
  43   struct binding *b_next;
  44   struct ScriptFuncs *fns;
  45 };
  46
  47 void LoadBindings(void);
  48 void FinializeBindings(void);
  49 void ScriptCmd __P((int argc, const char **argv));
  50
  51 /***Script events***/
  52
  53 struct script_event;
  54 /* Script event listener */
  55 struct listener
  56 {
  57   /*Binding dependent event handler data*/
  58   void *handler;
  59
  60   /* dispatcher provided by the binding.
  61    * The return value is significant:
  62    * a non-zero value will stop further
  63    * notification to the rest of the chain.*/
  64   int (*dispatcher) __P((void *handler, const char *params, va_list va));
  65
  66   /* smaller means higher privilege.*/
  67   unsigned int priv;
  68   struct listener *chain;
  69   struct listener *prev;
  70 };
  71
  72 /* the script_event structure needs to be zeroed before using.
  73  * embeding this structure directly into screen objects will do the job, as
  74  * long as the objects are created from calloc() call.*/
  75 struct script_event
  76 {
  77   /* expected parameter description of this event. */
  78   char *params;
  79   struct listener listeners;
  80 };
  81 struct script_event* object_get_event __P((char *obj, const char *name));
  82 int trigger_sevent(struct script_event *ev, VA_DOTS);
  83 int register_listener(struct script_event *ev, struct listener *l);
  84 void unregister_listener(struct listener *l);
  85
  86 struct gevents {
  87     struct script_event cmdexecuted;
  88     struct script_event detached;
  89 };
  90 extern struct gevents globalevents;
  91 #endif