Add some window events.
[screen-lua.git] / src / script.c
blob42f5ff22feaf95a9776fc138b305701a3f1cd68f
1 /* Copyright (c) 2008 Sadrul Habib Chowdhury (sadrul@users.sf.net)
2 * 2009 Rui Guo (firemeteor.guo@gmail.com)
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.
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.
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
19 ****************************************************************
22 #include "config.h"
23 #include "screen.h"
24 #include "extern.h"
25 #include <stddef.h>
27 /*Binding structure & functions*/
29 struct binding *bindings = NULL;
31 static void
32 register_binding (struct binding *new_binding)
34 if (!new_binding->registered)
36 new_binding->b_next = bindings;
37 bindings = new_binding;
38 new_binding->registered = 1;
42 #ifdef LUA_BINDING
43 extern struct binding lua_binding;
44 #endif
46 void LoadBindings(void)
48 #ifdef LUA_BINDING
49 register_binding(&lua_binding);
50 #endif
53 void
54 FinalizeBindings (void)
56 struct binding *binding=bindings;
57 while(binding)
59 if (binding->inited)
60 binding->bd_Finit();
61 binding = binding->b_next;
65 void
66 ScriptSource(int argc, const char **argv)
68 int ret = 0;
69 int async = 0;
70 const char *bd_select = 0, *script;
71 struct binding *binding = bindings;
73 /* Parse the commandline options
74 * script source [-async|-a] [-binding|-b <binding>] script
76 while (*argv && **argv == '-')
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)
87 argv++;
88 bd_select = *argv;
90 argv++;
92 script = *argv;
94 while (binding)
96 if (!bd_select || strcmp(bd_select, binding->name) == 0)
98 /*dynamically initialize the binding*/
99 if (!binding->inited)
101 binding->bd_Init();
102 binding->inited = 1;
105 /*and source the script*/
106 ret = binding->bd_Source(script, async);
107 if (ret)
108 break;
110 binding = binding->b_next;
112 if (!ret)
113 LMsg(0, "Could not source specified script %s", script);
117 ScriptCall(int argc, const char **argv)
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
125 while (*argv && **argv == '-')
127 const char *arg = *argv;
128 /* check for (-b | -binding) */
129 if ((arg[1] == 'b' && !arg[2])
130 || strcmp(arg, "-binding") == 0)
132 argv++;
133 bd_select = *argv;
135 argv++;
137 func = *argv;
138 argv++;
140 while (binding)
142 if (!bd_select || strcmp(bd_select, binding->name) == 0)
144 ret = binding->bd_call(func, argv);
145 if (ret)
146 break;
148 binding = binding->b_next;
151 if (!ret)
152 LMsg(0, "Failed to run specified script coummand '%s'", func);
153 return ret;
156 void
157 ScriptCmd(int argc, const char **argv)
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);
167 /* Event notification handling */
169 struct gevents globalevents;
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.
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().
179 * s: string (char *)
180 * S: string array (char **)
181 * i: signed int
182 * d: display
185 struct sev_description {
186 char *name;
187 char *params;
188 int offset;
189 } event_table[] = {
190 /* NOTE: Manually sorted in Alphabet order! */
192 /* Global events */
193 {"global_cmdexecuted", "sS", offsetof(struct gevents, cmdexecuted)},
194 {"global_detached", "di", offsetof(struct gevents, detached)},
195 /* The command "detach" triggers both 'cmdexecuted' and 'detached' events.
196 However, we need the 'detached' event to trigger callbacks from remote detaches.
198 /* fore window changed to window w on display d. */
199 {"global_forechanged", "dw", offsetof(struct gevents, forechanged)},
201 /* Window events */
202 {"window_can_resize", "", offsetof(struct win, w_sev.canresize)},
203 {"window_onfocus", "dw", offsetof(struct win, w_sev.onfocus)},
204 /* last view of window w disappeared on display d. */
205 {"window_onhide", "dw", offsetof(struct win, w_sev.onhide)},
206 /* window w lost its focus on display d. */
207 {"window_onleave", "dw", offsetof(struct win, w_sev.onleave)},
208 {"window_onresize", "", offsetof(struct win, w_sev.onresize)},
209 /* window w first showed up on display d. When there are regions, it can
210 * still be shown while losing focus. */
211 {"window_onshow", "dw", offsetof(struct win, w_sev.onshow)},
214 /* Get the event queue with the given name in the obj. If the obj is NULL,
215 * global events are searched. If no event is found, a NULL is returned.
217 struct script_event *
218 object_get_event(char *obj, const char *name)
220 int lo, hi, n, cmp;
221 if (!obj)
222 obj = (char *)&globalevents;
224 lo = 0;
225 n = hi = sizeof(event_table) / sizeof(struct sev_description);
226 while (lo < hi)
228 int half;
229 half = (lo + hi) >> 1;
230 cmp = strcmp(name, event_table[half].name);
231 if (cmp > 0)
232 lo = half + 1;
233 else
234 hi = half;
237 if (lo >= n || strcmp(name, event_table[lo].name))
238 return 0;
239 else
241 /*found an entry.*/
242 struct script_event *res;
243 res = (struct script_event *) (obj + event_table[lo].offset);
244 /*Setup the parameter record.*/
245 res->params = event_table[lo].params;
246 return res;
250 /* Put a listener in a proper position in the chain
251 * according to the privlege.
252 * Not insert duplicate entry. return zero if successful.*/
254 register_listener(struct script_event *ev, struct listener *l)
256 unsigned int priv = l->priv;
257 struct listener *p, *iter = &ev->listeners;
259 while(iter->chain && priv >= iter->chain->priv)
261 iter = iter->chain;
263 p = iter;
265 l->chain = p->chain;
266 l->prev = p;
267 if (p->chain)
268 p->chain->prev = l;
269 p->chain = l;
270 return 0;
273 void
274 unregister_listener(struct listener *l)
276 struct listener *p = l->prev;
277 p->chain = l->chain;
278 if (l->chain)
279 l->chain->prev = p;
280 l->chain = l->prev = 0;
281 l->handler = 0;
282 free(l);
285 /* Trigger event with given parameters.*/
287 trigger_sevent(struct script_event *ev, VA_DOTS)
289 int res = 0;
290 struct listener *chain;
291 char *params;
292 VA_LIST(va);
293 /*invalid or un-registered event structure*/
294 if (!ev || !ev->params)
295 return 0;
297 /*process the chain in order, stop if any of the handler returns true.*/
298 chain = ev->listeners.chain;
299 params = ev->params;
300 while (chain)
302 VA_START(va, ev);
303 res = chain->bd->bd_dispatch(chain->handler, params, va);
304 VA_END(va);
305 if (res)
306 break;
307 chain = chain->chain;
310 return res;
313 #define ALL_SCRIPTS(fn, params, stop) do { \
314 struct binding *iter; \
315 for (iter = bindings; iter; iter = iter->b_next) \
317 if (iter->fns && iter->fns->fn && (ret = (iter->fns->fn params)) && stop) \
318 break; \
320 } while (0)
322 int ScriptProcessCaption(const char *str, struct win *win, int len)
324 int ret = 0;
325 ALL_SCRIPTS(sf_ProcessCaption, (str, win, len), 1);
326 return ret;