1 /* Python scripting support
3 * Copyright (c) 2009 Sadrul Habib Chowdhury (sadrul@users.sf.net)
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3, or (at your option)
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program (see the file COPYING); if not, write to the
17 * Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
20 ****************************************************************
22 #include <sys/types.h>
38 #include <structmember.h>
40 #define RETURN_NONE do { Py_INCREF(Py_None); return Py_None; } while (0)
42 extern struct win
*windows
;
43 extern struct display
*display
, *displays
;
44 extern struct layer
*flayer
;
46 static PyObject
* SPy_Get(PyObject
*obj
, void *closure
);
47 static PyObject
* SPy_Set(PyObject
*obj
, PyObject
*value
, void *closure
);
48 static int PyDispatch(void *handler
, const char *params
, va_list va
);
49 static PyObject
* register_event_hook(PyObject
*self
, PyObject
*args
, PyObject
*kw
, void *object
);
54 struct listener
*listener
;
65 PyObject
* (*conv
)(void *);
69 #define compare_callback NULL
70 #define repr_callback NULL
72 #define REGISTER_TYPE(type, Type, closures, methods) \
74 register_##type(PyObject *module) \
76 static PyGetSetDef getsets[sizeof(closures)]; \
77 int i, count = sizeof(closures); \
78 for (i = 0; i < count; i++) \
80 getsets[i].name = closures[i].name; \
81 getsets[i].doc = closures[i].doc; \
82 getsets[i].closure = &closures[i]; \
83 getsets[i].get = SPy_Get; \
84 getsets[i].set = SPy_Set; \
86 PyType##Type.tp_base = &ScreenObjectType; \
87 PyType##Type.tp_getset = getsets; \
88 PyType##Type.tp_methods = methods; \
89 PyType##Type.tp_compare = compare_##type; \
90 PyType##Type.tp_repr = repr_##type; \
91 PyType_Ready(&PyType##Type); \
92 Py_INCREF(&PyType##Type); \
93 PyModule_AddObject(module, #Type, (PyObject *)&PyType##Type); \
97 #define DEFINE_TYPE(str, Type) \
100 ScreenObject __parent; \
104 static PyTypeObject PyType##Type = \
106 PyObject_HEAD_INIT(NULL) \
108 .tp_name = "screen." #Type, \
109 .tp_basicsize = sizeof(Py##Type), \
110 .tp_flags = Py_TPFLAGS_DEFAULT, \
111 .tp_doc = #Type " object", \
112 .tp_methods = NULL, \
117 PyObject_From##Type(str *_obj) \
119 Py##Type *obj = PyType##Type.tp_alloc(&PyType##Type, 0); \
121 return (PyObject *)obj; \
125 PyString_FromStringSafe(const char *str
)
128 return PyString_FromString(str
);
132 /** Generic Object {{{ */
140 object_hook(PyObject
*self
, PyObject
*args
, PyObject
*kw
)
143 object
= *(char **)((char *)self
+ sizeof(ScreenObject
)); /* ugliness */
144 return register_event_hook(self
, args
, kw
, object
);
147 static PyMethodDef omethods
[] = {
148 {"hook", (PyCFunction
)object_hook
, METH_VARARGS
| METH_KEYWORDS
, "Hook to an event on the object."},
152 static PyTypeObject ScreenObjectType
=
154 PyObject_HEAD_INIT(NULL
)
156 .tp_name
= "screen.Object",
157 .tp_basicsize
= sizeof(ScreenObject
),
158 .tp_flags
= Py_TPFLAGS_DEFAULT
| Py_TPFLAGS_BASETYPE
,
159 .tp_doc
= "Generic object",
160 .tp_methods
= omethods
,
165 register_object(PyObject
*module
)
167 PyType_Ready(&ScreenObjectType
);
168 Py_INCREF(&ScreenObjectType
);
169 PyModule_AddObject(module
, "Generic Object", (PyObject
*)&ScreenObjectType
);
175 DEFINE_TYPE(struct win
, Window
)
177 #define SPY_CLOSURE(name, doc, type, member, func) \
178 {name, doc, type, offsetof(PyWindow, _obj), offsetof(struct win, member), func}
179 static SPyClosure wclosures
[] =
181 SPY_CLOSURE("title", "Window title", T_STRING
, w_title
, NULL
),
182 SPY_CLOSURE("number", "Window number", T_INT
, w_number
, NULL
),
183 SPY_CLOSURE("dir", "Window directory", T_STRING
, w_dir
, NULL
),
184 SPY_CLOSURE("tty", "TTY belonging to the window", T_STRING_INPLACE
, w_tty
, NULL
),
185 SPY_CLOSURE("group", "The group the window belongs to", T_OBJECT_EX
, w_group
, PyObject_FromWindow
),
186 SPY_CLOSURE("pid", "Window pid", T_INT
, w_pid
, NULL
),
191 window_select(PyObject
*self
)
193 PyWindow
*win
= self
;
194 struct win
*w
= win
->_obj
;
195 SwitchWindow(w
->w_number
);
199 static PyMethodDef wmethods
[] = {
200 {"select", (PyCFunction
)window_select
, METH_NOARGS
, "Select the window."},
205 compare_window(PyWindow
*one
, PyWindow
*two
)
207 struct win
*wone
= one
->_obj
;
208 struct win
*wtwo
= two
->_obj
;
210 return wtwo
->w_number
- wone
->w_number
;
214 repr_window(PyObject
*obj
)
217 struct win
*win
= w
->_obj
;
218 return PyString_FromFormat("window (title: %s, number: %d)", win
->w_title
, win
->w_number
);
221 REGISTER_TYPE(window
, Window
, wclosures
, wmethods
)
226 DEFINE_TYPE(struct display
, Display
)
228 #define SPY_CLOSURE(name, doc, type, member, func) \
229 {name, doc, type, offsetof(PyDisplay, _obj), offsetof(struct display, member), func}
230 static SPyClosure dclosures
[] =
232 SPY_CLOSURE("tty", "Display TTY", T_STRING_INPLACE
, d_usertty
, NULL
),
233 SPY_CLOSURE("term", "Display Term", T_STRING_INPLACE
, d_termname
, NULL
),
234 SPY_CLOSURE("fore", "Foreground window of the display", T_OBJECT_EX
, d_fore
, PyObject_FromWindow
),
235 SPY_CLOSURE("width", "Display width", T_INT
, d_width
, NULL
),
236 SPY_CLOSURE("height", "Display height", T_INT
, d_height
, NULL
),
240 static PyMethodDef dmethods
[] =
246 compare_display(PyDisplay
*one
, PyDisplay
*two
)
248 struct display
*done
= one
->_obj
;
249 struct display
*dtwo
= two
->_obj
;
250 struct display
*iter
;
252 if (done
->d_userpid
== dtwo
->d_userpid
)
255 for (iter
= displays
; iter
; iter
= iter
->d_next
)
258 else if (iter
== dtwo
)
265 repr_display(PyObject
*obj
)
268 struct display
*disp
= d
->_obj
;
269 return PyString_FromFormat("display (term: %s, tty: %s)", disp
->d_termname
, disp
->d_usertty
);
272 REGISTER_TYPE(display
, Display
, dclosures
, dmethods
)
277 DEFINE_TYPE(SPyCallback
, Callback
)
278 static SPyClosure cclosures
[] = {{NULL
}};
281 FreeCallback(SPyCallback
*scallback
)
283 Py_XDECREF(scallback
->callback
);
288 callback_unhook(PyObject
*obj
)
290 PyCallback
*cb
= obj
;
291 SPyCallback
*scallback
= cb
->_obj
;
294 unregister_listener(scallback
->listener
);
295 FreeCallback(scallback
);
300 static PyMethodDef cmethods
[] = {
301 {"unhook", (PyCFunction
)callback_unhook
, METH_NOARGS
, "Unhook this event callback."},
304 REGISTER_TYPE(callback
, Callback
, cclosures
, cmethods
)
308 SPy_Get(PyObject
*obj
, void *closure
)
310 SPyClosure
*sc
= closure
;
311 char **first
= (char *)obj
+ sc
->offset1
;
312 char **second
= (char *)*first
+ sc
->offset2
;
313 PyObject
*(*cb
)(void *) = sc
->conv
;
314 void *data
= *second
;
321 cb
= PyString_FromStringSafe
;
324 case T_STRING_INPLACE
:
325 cb
= PyString_FromStringSafe
;
338 SPy_Set(PyObject
*obj
, PyObject
*value
, void *closure
)
344 PyDispatch(void *handler
, const char *params
, va_list va
)
346 PyCallback
*callback
= handler
;
347 PyObject
*args
, *ret
;
350 SPyCallback
*scallback
= callback
->_obj
;
352 for (count
= 0, p
= params
; *p
; p
++, count
++)
355 args
= PyTuple_New(count
);
359 for (count
= 0, p
= params
; *p
; p
++, count
++)
361 PyObject
*item
= NULL
;
365 item
= PyString_FromStringSafe(va_arg(va
, char *));
369 char **ls
= va_arg(va
, char **), **iter
;
371 for (iter
= ls
; iter
&& *iter
; iter
++, c
++)
375 item
= PyTuple_New(c
);
376 for (c
= 0, iter
= ls
; iter
&& *iter
; iter
++, c
++)
377 PyTuple_SetItem(item
, c
, PyString_FromStringSafe(*iter
));
381 item
= PyInt_FromLong(va_arg(va
, int));
384 item
= PyObject_FromDisplay(va_arg(va
, struct display
*));
393 PyTuple_SetItem(args
, count
, item
);
396 ret
= PyObject_CallObject(scallback
->callback
, args
);
401 retval
= (int)PyInt_AsLong(ret
);
407 register_event_hook(PyObject
*self
, PyObject
*args
, PyObject
*kw
, void *object
)
409 static char *kwlist
[] = {"event", "callback", NULL
};
414 struct script_event
*sev
;
416 SPyCallback
*scallback
;
418 if (!PyArg_ParseTupleAndKeywords(args
, kw
, "sO:screen.hook", kwlist
, &name
, &callback
))
419 return NULL
; /* Return Py_None instead? */
421 if (!PyCallable_Check(callback
))
423 PyErr_SetString(PyExc_TypeError
, "The event-callback functions must be callable.");
424 LMsg(0, "The event-callback functions must be callable.");
428 sev
= object_get_event(object
, name
);
431 LMsg(0, "No event named '%s'", name
);
435 l
= malloc(sizeof(struct listener
));
437 scallback
= malloc(sizeof(SPyCallback
));
438 scallback
->callback
= callback
;
439 scallback
->listener
= l
;
440 Py_INCREF(scallback
->callback
);
442 l
->handler
= PyObject_FromCallback(scallback
);
444 l
->dispatcher
= PyDispatch
;
445 if (register_listener(sev
, l
))
447 Py_DECREF((PyObject
*)l
->handler
);
448 FreeCallback(scallback
);
451 LMsg(0, "Hook could not be registered.");
456 Py_INCREF((PyObject
*)l
->handler
);
464 screen_display(PyObject
*self
)
470 return PyObject_FromDisplay(display
);
474 screen_displays(PyObject
*self
)
476 struct display
*d
= displays
;
478 for (; d
; d
= d
->d_next
)
480 PyObject
*tuple
= PyTuple_New(count
);
482 for (d
= displays
, count
= 0; d
; d
= d
->d_next
, ++count
)
483 PyTuple_SetItem(tuple
, count
, PyObject_FromDisplay(d
));
489 screen_windows(PyObject
*self
)
491 struct win
*w
= windows
;
493 for (; w
; w
= w
->w_next
)
495 PyObject
*tuple
= PyTuple_New(count
);
497 for (w
= windows
, count
= 0; w
; w
= w
->w_next
, ++count
)
498 PyTuple_SetItem(tuple
, count
, PyObject_FromWindow(w
));
504 hook_event(PyObject
*self
, PyObject
*args
, PyObject
*kw
)
506 return register_event_hook(self
, args
, kw
, NULL
);
510 screen_input_cb(char *buf
, int len
, char *p
)
512 PyObject
*callback
= p
;
513 PyObject
*str
= PyTuple_New(1);
514 PyTuple_SetItem(str
, 0, PyString_FromStringSafe(buf
));
515 PyObject_CallObject(callback
, str
);
521 screen_input(PyObject
*self
, PyObject
*args
, PyObject
*kw
)
523 static char *kwlist
[] = {"prompt", "callback", "value (optional)", NULL
};
524 char *prompt
, *pre
= NULL
;
527 if (!PyArg_ParseTupleAndKeywords(args
, kw
, "sO|s:screen.input", kwlist
, &prompt
, &callback
, &pre
))
529 LMsg(0, "Could not parse all the parameters to screen.input call.");
533 if (!PyCallable_Check(callback
))
535 LMsg(0, "Input callback must be a callable object.");
540 Input(prompt
, 100 /* huh? */,
541 INP_COOKED
, screen_input_cb
, callback
, 0);
545 int len
= strlen(pre
);
546 LayProcess(&pre
, &len
);
552 const PyMethodDef py_methods
[] = {
553 {"display", (PyCFunction
)screen_display
, METH_NOARGS
, "Get the current display."},
554 {"displays", (PyCFunction
)screen_displays
, METH_NOARGS
, "Get the list of displays."},
555 {"hook", (PyCFunction
)hook_event
, METH_VARARGS
|METH_KEYWORDS
, "Hook a callback to an event."},
556 {"input", (PyCFunction
)screen_input
, METH_VARARGS
|METH_KEYWORDS
, "Read user input interactively."},
557 {"windows", (PyCFunction
)screen_windows
, METH_NOARGS
, "Get the list of windows."},
558 {NULL
, NULL
, 0, NULL
}
569 m
= Py_InitModule3 ("screen", py_methods
, NULL
);
573 register_callback(m
);
586 SPySource(const char *file
, int async
)
588 FILE *f
= fopen(file
, "rb");
589 int ret
= PyRun_SimpleFile(f
, file
);
593 return 1; /* Success */
595 if (PyErr_Occurred())
604 struct binding py_binding
=