2 * widget.c - widget managing
4 * Copyright © 2007-2009 Julien Danjou <julien@danjou.info>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
25 #include <xcb/xcb_atom.h>
33 #include "common/atoms.h"
34 #include "common/xutil.h"
36 LUA_OBJECT_FUNCS(widget_class
, widget_t
, widget
);
38 /** Collect a widget structure.
39 * \param L The Lua VM state.
43 luaA_widget_gc(lua_State
*L
)
45 widget_t
*widget
= luaA_checkudata(L
, 1, &widget_class
);
46 if(widget
->destructor
)
47 widget
->destructor(widget
);
48 button_array_wipe(&widget
->buttons
);
49 return luaA_object_gc(L
);
52 /** Delete a widget node structure.
53 * \param node The node to destroy.
56 widget_node_delete(widget_node_t
*node
)
58 luaA_object_unref(globalconf
.L
, node
->widget
);
61 /** Get a widget node from a wibox by coords.
62 * \param orientation Wibox orientation.
63 * \param widgets The widget list.
64 * \param width The container width.
65 * \param height The container height.
66 * \param x X coordinate of the widget.
67 * \param y Y coordinate of the widget.
71 widget_getbycoords(orientation_t orientation
, widget_node_array_t
*widgets
,
72 int width
, int height
, int16_t *x
, int16_t *y
)
76 /* Need to transform coordinates like it was top/bottom */
93 if(w
->widget
->isvisible
94 && *x
>= w
->geometry
.x
&& *x
< w
->geometry
.x
+ w
->geometry
.width
95 && *y
>= w
->geometry
.y
&& *y
< w
->geometry
.y
+ w
->geometry
.height
)
101 /** Convert a Lua table to a list of widget nodet.
102 * \param L The Lua VM state.
103 * \param widgets The linked list of widget node.
106 luaA_table2widgets(lua_State
*L
, widget_node_array_t
*widgets
)
108 if(lua_istable(L
, -1))
111 while(luaA_next(L
, -2))
112 luaA_table2widgets(L
, widgets
);
113 /* remove the table */
118 widget_t
*widget
= luaA_toudata(L
, -1, &widget_class
);
123 w
.widget
= luaA_object_ref(L
, -1);
124 widget_node_array_append(widgets
, w
);
127 lua_pop(L
, 1); /* remove value */
131 /** Retrieve a list of widget geometries using a Lua layout function.
132 * a table which contains the geometries is then pushed onto the stack
133 * \param wibox The wibox.
134 * \return True is everything is ok, false otherwise.
137 widget_geometries(wibox_t
*wibox
)
139 /* get the layout field of the widget table */
140 if(wibox
->widgets_table
)
143 luaA_object_push(globalconf
.L
, wibox
);
144 /* push widgets table */
145 luaA_object_push_item(globalconf
.L
, -1, wibox
->widgets_table
);
147 lua_remove(globalconf
.L
, -2);
148 /* get layout field from the table */
149 lua_getfield(globalconf
.L
, -1, "layout");
150 /* remove the widget table */
151 lua_remove(globalconf
.L
, -2);
154 lua_pushnil(globalconf
.L
);
156 /* if the layout field is a function */
157 if(lua_isfunction(globalconf
.L
, -1))
159 /* Push 1st argument: wibox geometry */
160 area_t geometry
= wibox
->geometry
;
163 /* we need to exchange the width and height of the wibox window if it
164 * it is rotated, so the layout function doesn't need to care about that
166 if(wibox
->orientation
!= East
)
168 int i
= geometry
.height
;
169 geometry
.height
= geometry
.width
;
172 luaA_pusharea(globalconf
.L
, geometry
);
173 /* Push 2nd argument: widget table */
174 luaA_object_push(globalconf
.L
, wibox
);
175 luaA_object_push_item(globalconf
.L
, -1, wibox
->widgets_table
);
176 lua_remove(globalconf
.L
, -2);
177 /* Push 3rd argument: wibox screen */
178 lua_pushnumber(globalconf
.L
, screen_array_indexof(&globalconf
.screens
, wibox
->screen
));
179 /* Re-push the layout function */
180 lua_pushvalue(globalconf
.L
, -4);
181 /* call the layout function with 3 arguments (wibox geometry, widget
182 * table, screen) and wait for one result */
183 if(!luaA_dofunction(globalconf
.L
, 3, 1))
186 /* Remove the left over layout function */
187 lua_remove(globalconf
.L
, -2);
191 /* Remove the "nil function" */
192 lua_pop(globalconf
.L
, 1);
194 /* If no layout function has been specified, we just push a table with
195 * geometries onto the stack. These geometries are nothing fancy, they
196 * have x = y = 0 and their height and width set to the widgets demands
197 * or the wibox size, depending on which is less.
200 widget_node_array_t
*widgets
= &wibox
->widgets
;
201 widget_node_array_wipe(widgets
);
202 widget_node_array_init(widgets
);
205 luaA_object_push(globalconf
.L
, wibox
);
206 /* push widgets table */
207 luaA_object_push_item(globalconf
.L
, -1, wibox
->widgets_table
);
209 lua_remove(globalconf
.L
, -2);
210 luaA_table2widgets(globalconf
.L
, widgets
);
212 lua_newtable(globalconf
.L
);
213 for(int i
= 0; i
< widgets
->len
; i
++)
215 lua_pushnumber(globalconf
.L
, i
+ 1);
216 widget_t
*widget
= widgets
->tab
[i
].widget
;
217 lua_pushnumber(globalconf
.L
, screen_array_indexof(&globalconf
.screens
, wibox
->screen
));
218 area_t geometry
= widget
->extents(globalconf
.L
, widget
);
219 lua_pop(globalconf
.L
, 1);
220 geometry
.x
= geometry
.y
= 0;
221 geometry
.width
= MIN(wibox
->geometry
.width
, geometry
.width
);
222 geometry
.height
= MIN(wibox
->geometry
.height
, geometry
.height
);
224 luaA_pusharea(globalconf
.L
, geometry
);
226 lua_settable(globalconf
.L
, -3);
232 /** Render a list of widgets.
233 * \param wibox The wibox.
237 widget_render(wibox_t
*wibox
)
239 lua_State
*L
= globalconf
.L
;
240 draw_context_t
*ctx
= &wibox
->ctx
;
241 area_t rectangle
= { 0, 0, 0, 0 };
244 rectangle
.width
= ctx
->width
;
245 rectangle
.height
= ctx
->height
;
247 if (!widget_geometries(wibox
))
250 if(ctx
->bg
.alpha
!= 0xffff)
252 int x
= wibox
->geometry
.x
, y
= wibox
->geometry
.y
;
253 xcb_get_property_reply_t
*prop_r
;
255 xcb_pixmap_t rootpix
;
256 xcb_get_property_cookie_t prop_c
;
257 xcb_screen_t
*s
= xutil_screen_get(globalconf
.connection
, ctx
->phys_screen
);
258 prop_c
= xcb_get_property_unchecked(globalconf
.connection
, false, s
->root
, _XROOTPMAP_ID
,
260 if((prop_r
= xcb_get_property_reply(globalconf
.connection
, prop_c
, NULL
)))
263 && (data
= xcb_get_property_value(prop_r
))
264 && (rootpix
= *(xcb_pixmap_t
*) data
))
265 switch(wibox
->orientation
)
269 rootpix
, ctx
->pixmap
,
270 s
->width_in_pixels
, s
->height_in_pixels
,
271 ctx
->width
, ctx
->height
,
278 rootpix
, ctx
->pixmap
,
279 s
->width_in_pixels
, s
->height_in_pixels
,
280 ctx
->width
, ctx
->height
,
286 xcb_copy_area(globalconf
.connection
, rootpix
,
287 wibox
->pixmap
, wibox
->gc
,
290 ctx
->width
, ctx
->height
);
297 widget_node_array_t
*widgets
= &wibox
->widgets
;
299 widget_node_array_wipe(widgets
);
300 widget_node_array_init(widgets
);
302 luaA_object_push(globalconf
.L
, wibox
);
303 /* push widgets table */
304 luaA_object_push_item(globalconf
.L
, -1, wibox
->widgets_table
);
306 lua_remove(globalconf
.L
, -2);
307 luaA_table2widgets(L
, widgets
);
309 /* get computed geometries */
310 for(unsigned int i
= 0; i
< lua_objlen(L
, -1); i
++)
312 lua_pushnumber(L
, i
+ 1);
315 widgets
->tab
[i
].geometry
.x
= luaA_getopt_number(L
, -1, "x", wibox
->geometry
.x
);
316 widgets
->tab
[i
].geometry
.y
= luaA_getopt_number(L
, -1, "y", wibox
->geometry
.y
);
317 widgets
->tab
[i
].geometry
.width
= luaA_getopt_number(L
, -1, "width", 1);
318 widgets
->tab
[i
].geometry
.height
= luaA_getopt_number(L
, -1, "height", 1);
324 /* draw background image, only if the background color is not opaque */
325 if(wibox
->bg_image
&& ctx
->bg
.alpha
!= 0xffff)
326 draw_image(ctx
, 0, 0, 1.0, wibox
->bg_image
);
328 /* draw background color */
329 xcolor_to_color(&ctx
->bg
, &col
);
330 draw_rectangle(ctx
, rectangle
, 1.0, true, &col
);
332 /* draw everything! */
333 for(int i
= 0; i
< widgets
->len
; i
++)
334 if(widgets
->tab
[i
].widget
->isvisible
)
335 widgets
->tab
[i
].widget
->draw(widgets
->tab
[i
].widget
,
336 ctx
, widgets
->tab
[i
].geometry
, wibox
);
338 switch(wibox
->orientation
)
341 draw_rotate(ctx
, ctx
->pixmap
, wibox
->pixmap
,
342 ctx
->width
, ctx
->height
,
343 ctx
->height
, ctx
->width
,
344 M_PI_2
, ctx
->height
, 0);
347 draw_rotate(ctx
, ctx
->pixmap
, wibox
->pixmap
,
348 ctx
->width
, ctx
->height
,
349 ctx
->height
, ctx
->width
,
350 - M_PI_2
, 0, ctx
->width
);
357 /** Invalidate widgets which should be refresh depending on their types.
358 * \param type Widget type to invalidate.
361 widget_invalidate_bytype(widget_constructor_t
*type
)
363 foreach(wibox
, globalconf
.wiboxes
)
364 foreach(wnode
, (*wibox
)->widgets
)
365 if(wnode
->widget
->type
== type
)
367 (*wibox
)->need_update
= true;
372 /** Set a wibox needs update because it has widget, or redraw a titlebar.
373 * \param widget The widget to look for.
376 widget_invalidate_bywidget(widget_t
*widget
)
378 foreach(wibox
, globalconf
.wiboxes
)
379 if(!(*wibox
)->need_update
)
380 foreach(wnode
, (*wibox
)->widgets
)
381 if(wnode
->widget
== widget
)
383 (*wibox
)->need_update
= true;
387 foreach(_c
, globalconf
.clients
)
390 if(c
->titlebar
&& !c
->titlebar
->need_update
)
391 for(int j
= 0; j
< c
->titlebar
->widgets
.len
; j
++)
392 if(c
->titlebar
->widgets
.tab
[j
].widget
== widget
)
394 c
->titlebar
->need_update
= true;
400 /** Create a new widget.
401 * \param L The Lua VM state.
404 * \lparam A table with at least a type value.
405 * \lreturn A brand new widget.
408 luaA_widget_new(lua_State
*L
)
410 luaA_class_new(L
, &widget_class
);
412 widget_t
*w
= luaA_checkudata(L
, -1, &widget_class
);
413 /* Set visible by default. */
419 /** Get or set mouse buttons bindings to a widget.
420 * \param L The Lua VM state.
424 * \lparam An array of mouse button bindings objects, or nothing.
425 * \return The array of mouse button bindings objects of this widget.
428 luaA_widget_buttons(lua_State
*L
)
430 widget_t
*widget
= luaA_checkudata(L
, 1, &widget_class
);
432 if(lua_gettop(L
) == 2)
434 luaA_button_array_set(L
, 1, 2, &widget
->buttons
);
435 luaA_object_emit_signal(L
, 1, "property::buttons", 0);
439 return luaA_button_array_get(L
, 1, &widget
->buttons
);
443 * \param L The Lua VM state.
444 * \return The number of elements pushed on stack.
446 * \lfield visible The widget visibility.
447 * \lfield mouse_enter A function to execute when the mouse enter the widget.
448 * \lfield mouse_leave A function to execute when the mouse leave the widget.
451 luaA_widget_index(lua_State
*L
)
454 const char *prop
= luaL_checklstring(L
, 2, &len
);
455 awesome_token_t token
= a_tokenize(prop
, len
);
457 /* Try standard method */
458 if(luaA_class_index(L
))
461 /* Then call special widget index */
462 widget_t
*widget
= luaA_checkudata(L
, 1, &widget_class
);
463 return widget
->index
? widget
->index(L
, token
) : 0;
466 /** Generic widget newindex.
467 * \param L The Lua VM state.
468 * \return The number of elements pushed on stack.
471 luaA_widget_newindex(lua_State
*L
)
474 const char *prop
= luaL_checklstring(L
, 2, &len
);
475 awesome_token_t token
= a_tokenize(prop
, len
);
477 /* Try standard method */
478 luaA_class_newindex(L
);
480 /* Then call special widget newindex */
481 widget_t
*widget
= luaA_checkudata(L
, 1, &widget_class
);
482 return widget
->newindex
? widget
->newindex(L
, token
) : 0;
486 luaA_widget_extents(lua_State
*L
)
488 widget_t
*widget
= luaA_checkudata(L
, 1, &widget_class
);
497 g
= widget
->extents(L
, widget
);
500 lua_pushnumber(L
, g
.width
);
501 lua_setfield(L
, -2, "width");
502 lua_pushnumber(L
, g
.height
);
503 lua_setfield(L
, -2, "height");
509 luaA_widget_set_type(lua_State
*L
, widget_t
*w
)
512 const char *type
= luaL_checklstring(L
, -1, &len
);
513 widget_constructor_t
*wc
= NULL
;
515 switch(a_tokenize(type
, len
))
520 case A_TK_PROGRESSBAR
:
521 wc
= widget_progressbar
;
530 wc
= widget_imagebox
;
537 luaL_error(L
, "unkown widget type: %s", type
);
541 luaA_object_emit_signal(L
, -3, "property::type", 0);
547 luaA_widget_get_visible(lua_State
*L
, widget_t
*w
)
549 lua_pushboolean(L
, w
->isvisible
);
554 luaA_widget_set_visible(lua_State
*L
, widget_t
*w
)
556 w
->isvisible
= luaA_checkboolean(L
, -1);
557 widget_invalidate_bywidget(w
);
558 luaA_object_emit_signal(L
, -3, "property::visible", 0);
563 widget_class_setup(lua_State
*L
)
565 static const struct luaL_reg widget_methods
[] =
567 LUA_CLASS_METHODS(widget
)
568 { "__call", luaA_widget_new
},
572 static const struct luaL_reg widget_meta
[] =
574 LUA_OBJECT_META(widget
)
575 { "buttons", luaA_widget_buttons
},
576 { "extents", luaA_widget_extents
},
577 { "__index", luaA_widget_index
},
578 { "__newindex", luaA_widget_newindex
},
579 { "__gc", luaA_widget_gc
},
583 luaA_class_setup(L
, &widget_class
, "widget", (lua_class_allocator_t
) widget_new
,
585 widget_methods
, widget_meta
);
586 luaA_class_add_property(&widget_class
, A_TK_VISIBLE
,
587 (lua_class_propfunc_t
) luaA_widget_set_visible
,
588 (lua_class_propfunc_t
) luaA_widget_get_visible
,
589 (lua_class_propfunc_t
) luaA_widget_set_visible
);
590 luaA_class_add_property(&widget_class
, A_TK_TYPE
,
591 (lua_class_propfunc_t
) luaA_widget_set_type
,
596 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80