2 * client.c - client management
4 * Copyright © 2007-2008 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.
22 #include <xcb/xcb_atom.h>
32 #include "layouts/floating.h"
33 #include "common/markup.h"
34 #include "common/atoms.h"
36 extern awesome_t globalconf
;
38 DO_LUA_NEW(extern, client_t
, client
, "client", client_ref
)
39 DO_LUA_EQ(client_t
, client
, "client")
40 DO_LUA_GC(client_t
, client
, "client", client_unref
)
42 /** Load windows properties, restoring client's tag
43 * and floating state before awesome was restarted if any.
44 * \param c A client pointer.
45 * \param screen A virtual screen.
46 * \return True if client had property, false otherwise.
49 client_loadprops(client_t
* c
, screen_t
*screen
)
52 tag_array_t
*tags
= &screen
->tags
;
54 xcb_get_property_cookie_t floating_q
, fullscreen_q
;
55 xcb_get_property_reply_t
*reply
;
58 if(!xutil_text_prop_get(globalconf
.connection
, c
->win
, _AWESOME_TAGS
,
62 /* Send the GetProperty requests which will be processed later */
63 floating_q
= xcb_get_property_unchecked(globalconf
.connection
, false, c
->win
,
64 _AWESOME_FLOATING
, CARDINAL
, 0, 1);
66 fullscreen_q
= xcb_get_property_unchecked(globalconf
.connection
, false, c
->win
,
67 _AWESOME_FULLSCREEN
, CARDINAL
, 0, 1);
69 /* ignore property if the tag count isn't matching */
71 for(int i
= 0; i
< tags
->len
; i
++)
73 tag_client(c
, tags
->tab
[i
]);
75 untag_client(c
, tags
->tab
[i
]);
79 /* check for floating */
80 reply
= xcb_get_property_reply(globalconf
.connection
, floating_q
, NULL
);
82 if(reply
&& reply
->value_len
&& (data
= xcb_get_property_value(reply
)))
83 client_setfloating(c
, *(bool *) data
);
86 /* check for fullscreen */
87 reply
= xcb_get_property_reply(globalconf
.connection
, fullscreen_q
, NULL
);
89 if(reply
&& reply
->value_len
&& (data
= xcb_get_property_value(reply
)))
90 client_setfullscreen(c
, *(bool *) data
);
96 /** Check if client supports protocol a protocole in WM_PROTOCOL.
97 * \param win The window.
98 * \return True if client has the atom in protocol, false otherwise.
101 window_hasproto(xcb_window_t win
, xcb_atom_t atom
)
104 xcb_get_wm_protocols_reply_t protocols
;
107 if(xcb_get_wm_protocols_reply(globalconf
.connection
,
108 xcb_get_wm_protocols_unchecked(globalconf
.connection
,
112 for(i
= 0; !ret
&& i
< protocols
.atoms_len
; i
++)
113 if(protocols
.atoms
[i
] == atom
)
115 xcb_get_wm_protocols_reply_wipe(&protocols
);
120 /** Returns true if a client is tagged
121 * with one of the tags of the specified screen.
122 * \param c The client to check.
123 * \param screen Virtual screen number.
124 * \return true if the client is visible, false otherwise.
127 client_maybevisible(client_t
*c
, int screen
)
129 if(c
->screen
== screen
)
131 if(c
->issticky
|| c
->type
== WINDOW_TYPE_DESKTOP
)
134 tag_array_t
*tags
= &globalconf
.screens
[screen
].tags
;
136 for(int i
= 0; i
< tags
->len
; i
++)
137 if(tags
->tab
[i
]->selected
&& is_client_tagged(c
, tags
->tab
[i
]))
143 /** Get a client by its window.
144 * \param w The client window to find.
145 * \return A client pointer if found, NULL otherwise.
148 client_getbywin(xcb_window_t w
)
151 for(c
= globalconf
.clients
; c
&& c
->win
!= w
; c
= c
->next
);
155 /** Unfocus a client.
156 * \param c The client.
159 client_unfocus(client_t
*c
)
161 globalconf
.screens
[c
->phys_screen
].client_focus
= NULL
;
164 luaA_client_userdata_new(globalconf
.L
, c
);
165 luaA_dofunction(globalconf
.L
, globalconf
.hooks
.unfocus
, 1, 0);
167 ewmh_update_net_active_window(c
->phys_screen
);
170 /** Ban client and unmap it.
171 * \param c The client.
174 client_ban(client_t
*c
)
176 if(globalconf
.screen_focus
->client_focus
== c
)
178 xcb_unmap_window(globalconf
.connection
, c
->win
);
180 window_state_set(c
->win
, XCB_WM_STATE_ICONIC
);
182 window_state_set(c
->win
, XCB_WM_STATE_WITHDRAWN
);
184 xcb_unmap_window(globalconf
.connection
, c
->titlebar
->sw
.window
);
187 /** Give focus to client, or to first client if client is NULL.
188 * \param c The client or NULL.
189 * \return True if a window (even root) has received focus, false otherwise.
192 client_focus(client_t
*c
)
194 if(!client_maybevisible(c
, c
->screen
) || c
->nofocus
)
197 /* unfocus current selected client */
198 if(globalconf
.screen_focus
->client_focus
199 && c
!= globalconf
.screen_focus
->client_focus
)
200 client_unfocus(globalconf
.screen_focus
->client_focus
);
204 client_setminimized(c
, false);
206 /* unban the client before focusing or it will fail */
209 globalconf
.screen_focus
= &globalconf
.screens
[c
->phys_screen
];
210 globalconf
.screen_focus
->client_focus
= c
;
212 xcb_set_input_focus(globalconf
.connection
, XCB_INPUT_FOCUS_POINTER_ROOT
,
213 c
->win
, XCB_CURRENT_TIME
);
215 /* Some layouts use focused client differently, so call them back.
216 * And anyway, we have maybe unhidden */
217 client_need_arrange(c
);
220 luaA_client_userdata_new(globalconf
.L
, globalconf
.screen_focus
->client_focus
);
221 luaA_dofunction(globalconf
.L
, globalconf
.hooks
.focus
, 1, 0);
223 ewmh_update_net_active_window(c
->phys_screen
);
226 /** Stack a window below.
227 * \param c The client.
228 * \param previous The previous window on the stack.
229 * \param return The next-previous!
232 client_stack_above(client_t
*c
, xcb_window_t previous
)
234 uint32_t config_win_vals
[2];
236 config_win_vals
[0] = previous
;
237 config_win_vals
[1] = XCB_STACK_MODE_ABOVE
;
241 xcb_configure_window(globalconf
.connection
,
242 c
->titlebar
->sw
.window
,
243 XCB_CONFIG_WINDOW_SIBLING
| XCB_CONFIG_WINDOW_STACK_MODE
,
245 config_win_vals
[0] = c
->titlebar
->sw
.window
;
248 xcb_configure_window(globalconf
.connection
, c
->win
,
249 XCB_CONFIG_WINDOW_SIBLING
| XCB_CONFIG_WINDOW_STACK_MODE
,
254 /* stack transient window on top of their parents */
255 for(client_node_t
*node
= *client_node_list_last(&globalconf
.stack
);
256 node
; node
= node
->prev
)
257 if(node
->client
->transient_for
== c
)
259 client_stack_above(node
->client
,
261 previous
= node
->client
->win
;
267 /** Stacking layout layers */
270 /** This one is a special layer */
282 /** Get the real layer of a client according to its attribute (fullscreen, …)
283 * \param c The client.
284 * \return The real layer.
287 client_layer_translator(client_t
*c
)
291 else if(c
->isfullscreen
)
292 return LAYER_FULLSCREEN
;
295 else if(c
->isfloating
|| client_isfixed(c
))
297 else if(c
->transient_for
)
302 case WINDOW_TYPE_DOCK
:
304 case WINDOW_TYPE_DESKTOP
:
305 return LAYER_DESKTOP
;
306 case WINDOW_TYPE_DIALOG
:
314 * \todo It might be worth stopping to restack everyone and only stack `c'
315 * relatively to the first matching in the list.
320 uint32_t config_win_vals
[2];
321 client_node_t
*node
, *last
= *client_node_list_last(&globalconf
.stack
);
325 config_win_vals
[0] = XCB_NONE
;
326 config_win_vals
[1] = XCB_STACK_MODE_ABOVE
;
328 /* first stack not ontop wibox window */
329 for(screen
= 0; screen
< globalconf
.nscreen
; screen
++)
330 for(int i
= 0; i
< globalconf
.screens
[screen
].wiboxes
.len
; i
++)
332 wibox_t
*sb
= globalconf
.screens
[screen
].wiboxes
.tab
[i
];
335 xcb_configure_window(globalconf
.connection
,
337 XCB_CONFIG_WINDOW_SIBLING
| XCB_CONFIG_WINDOW_STACK_MODE
,
339 config_win_vals
[0] = sb
->sw
.window
;
343 /* stack bottom layers */
344 for(layer
= LAYER_DESKTOP
; layer
< LAYER_FULLSCREEN
; layer
++)
345 for(node
= last
; node
; node
= node
->prev
)
346 if(client_layer_translator(node
->client
) == layer
)
347 config_win_vals
[0] = client_stack_above(node
->client
,
350 /* then stack ontop wibox window */
351 for(screen
= 0; screen
< globalconf
.nscreen
; screen
++)
352 for(int i
= 0; i
< globalconf
.screens
[screen
].wiboxes
.len
; i
++)
354 wibox_t
*sb
= globalconf
.screens
[screen
].wiboxes
.tab
[i
];
357 xcb_configure_window(globalconf
.connection
,
359 XCB_CONFIG_WINDOW_SIBLING
| XCB_CONFIG_WINDOW_STACK_MODE
,
361 config_win_vals
[0] = sb
->sw
.window
;
365 /* finally stack ontop and fullscreen windows */
366 for(layer
= LAYER_FULLSCREEN
; layer
< LAYER_OUTOFSPACE
; layer
++)
367 for(node
= last
; node
; node
= node
->prev
)
368 if(client_layer_translator(node
->client
) == layer
)
369 config_win_vals
[0] = client_stack_above(node
->client
,
373 /** Manage a new client.
374 * \param w The window.
375 * \param wgeom Window geometry.
376 * \param phys_screen Physical screen number.
377 * \param screen Virtual screen number where to manage client.
380 client_manage(xcb_window_t w
, xcb_get_geometry_reply_t
*wgeom
, int phys_screen
, int screen
)
382 xcb_get_property_cookie_t ewmh_icon_cookie
;
385 const uint32_t select_input_val
[] =
387 XCB_EVENT_MASK_STRUCTURE_NOTIFY
388 | XCB_EVENT_MASK_PROPERTY_CHANGE
389 | XCB_EVENT_MASK_ENTER_WINDOW
392 /* Send request to get NET_WM_ICON property as soon as possible... */
393 ewmh_icon_cookie
= ewmh_window_icon_get_unchecked(w
);
394 xcb_change_window_attributes(globalconf
.connection
, w
, XCB_CW_EVENT_MASK
, select_input_val
);
396 if(systray_iskdedockapp(w
))
398 systray_request_handle(w
, phys_screen
, NULL
);
402 c
= p_new(client_t
, 1);
404 c
->screen
= screen_getbycoord(screen
, wgeom
->x
, wgeom
->y
);
406 c
->phys_screen
= phys_screen
;
410 c
->geometry
.x
= c
->f_geometry
.x
= c
->m_geometry
.x
= wgeom
->x
;
411 c
->geometry
.y
= c
->f_geometry
.y
= c
->m_geometry
.y
= wgeom
->y
;
412 c
->geometry
.width
= c
->f_geometry
.width
= c
->m_geometry
.width
= wgeom
->width
;
413 c
->geometry
.height
= c
->f_geometry
.height
= c
->m_geometry
.height
= wgeom
->height
;
414 client_setborder(c
, wgeom
->border_width
);
415 if((icon
= ewmh_window_icon_get_reply(ewmh_icon_cookie
)))
416 c
->icon
= image_ref(&icon
);
418 /* we honor size hints by default */
419 c
->honorsizehints
= true;
422 property_update_wm_normal_hints(c
, NULL
);
423 property_update_wm_hints(c
, NULL
);
424 property_update_wm_transient_for(c
, NULL
);
427 screen
= c
->transient_for
->screen
;
429 /* Try to load props if any */
430 client_loadprops(c
, &globalconf
.screens
[screen
]);
433 /* Then check clients hints */
434 ewmh_client_check_hints(c
);
436 /* move client to screen, but do not tag it for now */
437 screen_client_moveto(c
, screen
, false, true);
439 /* Check if client has been tagged by loading props, or maybe with its
441 * If not, we tag it with current selected ones.
442 * This could be done on Lua side, but it's a sane behaviour. */
446 tag_array_t
*tags
= &globalconf
.screens
[screen
].tags
;
447 for(i
= 0; i
< tags
->len
; i
++)
448 if(is_client_tagged(c
, tags
->tab
[i
]))
451 /* if no tag, set current selected */
453 for(i
= 0; i
< tags
->len
; i
++)
454 if(tags
->tab
[i
]->selected
)
455 tag_client(c
, tags
->tab
[i
]);
458 /* Push client in client list */
459 client_list_push(&globalconf
.clients
, client_ref(&c
));
461 /* Push client in stack */
464 /* update window title */
465 property_update_wm_name(c
);
466 property_update_wm_icon_name(c
);
469 ewmh_client_strut_update(c
, NULL
);
471 ewmh_update_net_client_list(c
->phys_screen
);
473 /* Call hook to notify list change */
474 luaA_dofunction(globalconf
.L
, globalconf
.hooks
.clients
, 0, 0);
477 luaA_client_userdata_new(globalconf
.L
, c
);
478 luaA_dofunction(globalconf
.L
, globalconf
.hooks
.manage
, 1, 0);
481 /** Compute client geometry with respect to its geometry hints.
482 * \param c The client.
483 * \param geometry The geometry that the client might receive.
484 * \return The geometry the client must take respecting its hints.
487 client_geometry_hints(client_t
*c
, area_t geometry
)
489 double dx
, dy
, max
, min
, ratio
;
491 if(c
->minay
> 0 && c
->maxay
> 0 && (geometry
.height
- c
->baseh
) > 0
492 && (geometry
.width
- c
->basew
) > 0)
494 dx
= (double) (geometry
.width
- c
->basew
);
495 dy
= (double) (geometry
.height
- c
->baseh
);
496 min
= (double) (c
->minax
) / (double) (c
->minay
);
497 max
= (double) (c
->maxax
) / (double) (c
->maxay
);
499 if(max
> 0 && min
> 0 && ratio
> 0)
503 dy
= (dx
* min
+ dy
) / (min
* min
+ 1);
505 geometry
.width
= (int) dx
+ c
->basew
;
506 geometry
.height
= (int) dy
+ c
->baseh
;
510 dy
= (dx
* min
+ dy
) / (max
* max
+ 1);
512 geometry
.width
= (int) dx
+ c
->basew
;
513 geometry
.height
= (int) dy
+ c
->baseh
;
517 if(c
->minw
&& geometry
.width
< c
->minw
)
518 geometry
.width
= c
->minw
;
519 if(c
->minh
&& geometry
.height
< c
->minh
)
520 geometry
.height
= c
->minh
;
521 if(c
->maxw
&& geometry
.width
> c
->maxw
)
522 geometry
.width
= c
->maxw
;
523 if(c
->maxh
&& geometry
.height
> c
->maxh
)
524 geometry
.height
= c
->maxh
;
526 geometry
.width
-= (geometry
.width
- c
->basew
) % c
->incw
;
528 geometry
.height
-= (geometry
.height
- c
->baseh
) % c
->inch
;
533 /** Resize client window.
534 * \param c Client to resize.
535 * \param geometry New window geometry.
536 * \param hints Use size hints.
539 client_resize(client_t
*c
, area_t geometry
, bool hints
)
543 layout_t
*layout
= layout_get_current(c
->screen
);
544 /* Values to configure a window is an array where values are
545 * stored according to 'value_mask' */
548 if(c
->titlebar
&& !c
->ismoving
&& !client_isfloating(c
) && layout
!= layout_floating
)
549 geometry
= titlebar_geometry_remove(c
->titlebar
, c
->border
, geometry
);
552 geometry
= client_geometry_hints(c
, geometry
);
554 if(geometry
.width
<= 0 || geometry
.height
<= 0)
557 /* offscreen appearance fixes */
558 area
= display_area_get(c
->phys_screen
, NULL
,
559 &globalconf
.screens
[c
->screen
].padding
);
561 if(geometry
.x
> area
.width
)
562 geometry
.x
= area
.width
- geometry
.width
- 2 * c
->border
;
563 if(geometry
.y
> area
.height
)
564 geometry
.y
= area
.height
- geometry
.height
- 2 * c
->border
;
565 if(geometry
.x
+ geometry
.width
+ 2 * c
->border
< 0)
567 if(geometry
.y
+ geometry
.height
+ 2 * c
->border
< 0)
570 if(c
->geometry
.x
!= geometry
.x
571 || c
->geometry
.y
!= geometry
.y
572 || c
->geometry
.width
!= geometry
.width
573 || c
->geometry
.height
!= geometry
.height
)
575 new_screen
= screen_getbycoord(c
->screen
, geometry
.x
, geometry
.y
);
577 c
->geometry
.x
= values
[0] = geometry
.x
;
578 c
->geometry
.width
= values
[2] = geometry
.width
;
579 c
->geometry
.y
= values
[1] = geometry
.y
;
580 c
->geometry
.height
= values
[3] = geometry
.height
;
581 values
[4] = c
->border
;
583 /* save the floating geometry if the window is floating but not
585 if(c
->ismoving
|| client_isfloating(c
)
586 || layout_get_current(new_screen
) == layout_floating
)
588 c
->f_geometry
= geometry
;
590 titlebar_update_geometry_floating(c
);
592 xcb_configure_window(globalconf
.connection
, c
->win
,
593 XCB_CONFIG_WINDOW_X
| XCB_CONFIG_WINDOW_Y
|
594 XCB_CONFIG_WINDOW_WIDTH
| XCB_CONFIG_WINDOW_HEIGHT
|
595 XCB_CONFIG_WINDOW_BORDER_WIDTH
,
597 window_configure(c
->win
, geometry
, c
->border
);
599 if(c
->screen
!= new_screen
)
600 screen_client_moveto(c
, new_screen
, true, false);
603 hooks_property(c
, "geometry");
607 /** Set a clinet floating.
608 * \param c The client.
609 * \param floating Set floating, or not.
610 * \param layer Layer to put the floating window onto.
613 client_setfloating(client_t
*c
, bool floating
)
615 if(c
->isfloating
!= floating
616 && (c
->type
== WINDOW_TYPE_NORMAL
))
618 if((c
->isfloating
= floating
))
620 client_resize(c
, c
->f_geometry
, false);
621 client_need_arrange(c
);
623 xcb_change_property(globalconf
.connection
,
624 XCB_PROP_MODE_REPLACE
,
625 c
->win
, _AWESOME_FLOATING
, CARDINAL
, 8, 1,
628 hooks_property(c
, "floating");
632 /** Set a client minimized, or not.
633 * \param c The client.
634 * \param s Set or not the client minimized.
637 client_setminimized(client_t
*c
, bool s
)
639 if(c
->isminimized
!= s
)
641 client_need_arrange(c
);
643 client_need_arrange(c
);
644 ewmh_client_update_hints(c
);
646 hooks_property(c
, "minimized");
650 /** Set a client sticky, or not.
651 * \param c The client.
652 * \param s Set or not the client sticky.
655 client_setsticky(client_t
*c
, bool s
)
659 client_need_arrange(c
);
661 client_need_arrange(c
);
662 ewmh_client_update_hints(c
);
663 hooks_property(c
, "sticky");
667 /** Set a client fullscreen, or not.
668 * \param c The client.
669 * \param s Set or not the client fullscreen.
672 client_setfullscreen(client_t
*c
, bool s
)
674 if(c
->isfullscreen
!= s
)
678 /* become fullscreen! */
679 if((c
->isfullscreen
= s
))
681 geometry
= screen_area_get(c
->screen
, NULL
, NULL
, false);
682 c
->m_geometry
= c
->geometry
;
683 c
->oldborder
= c
->border
;
684 client_setborder(c
, 0);
688 geometry
= c
->m_geometry
;
689 client_setborder(c
, c
->oldborder
);
690 client_resize(c
, c
->m_geometry
, false);
692 client_resize(c
, geometry
, false);
693 client_need_arrange(c
);
695 xcb_change_property(globalconf
.connection
,
696 XCB_PROP_MODE_REPLACE
,
697 c
->win
, _AWESOME_FULLSCREEN
, CARDINAL
, 8, 1,
699 ewmh_client_update_hints(c
);
700 hooks_property(c
, "fullscreen");
704 /** Set a client above, or not.
705 * \param c The client.
706 * \param s Set or not the client above.
709 client_setabove(client_t
*c
, bool s
)
715 ewmh_client_update_hints(c
);
717 hooks_property(c
, "above");
721 /** Set a client below, or not.
722 * \param c The client.
723 * \param s Set or not the client below.
726 client_setbelow(client_t
*c
, bool s
)
732 ewmh_client_update_hints(c
);
734 hooks_property(c
, "below");
738 /** Set a client modal, or not.
739 * \param c The client.
740 * \param s Set or not the client moda.
743 client_setmodal(client_t
*c
, bool s
)
749 ewmh_client_update_hints(c
);
751 hooks_property(c
, "modal");
755 /** Set a client ontop, or not.
756 * \param c The client.
757 * \param s Set or not the client moda.
760 client_setontop(client_t
*c
, bool s
)
767 hooks_property(c
, "ontop");
771 /** Save client properties as an X property.
772 * \param c The client.
775 client_saveprops_tags(client_t
*c
)
777 tag_array_t
*tags
= &globalconf
.screens
[c
->screen
].tags
;
778 unsigned char *prop
= p_alloca(unsigned char, tags
->len
+ 1);
781 for(i
= 0; i
< tags
->len
; i
++)
782 prop
[i
] = is_client_tagged(c
, tags
->tab
[i
]) ? '1' : '0';
784 xcb_change_property(globalconf
.connection
, XCB_PROP_MODE_REPLACE
, c
->win
, _AWESOME_TAGS
, STRING
, 8, i
, prop
);
788 * \param c The client.
791 client_unban(client_t
*c
)
793 xcb_map_window(globalconf
.connection
, c
->win
);
794 window_state_set(c
->win
, XCB_WM_STATE_NORMAL
);
797 if(c
->isfullscreen
|| !c
->titlebar
->isvisible
)
798 xcb_unmap_window(globalconf
.connection
, c
->titlebar
->sw
.window
);
800 xcb_map_window(globalconf
.connection
, c
->titlebar
->sw
.window
);
804 /** Unmanage a client.
805 * \param c The client.
808 client_unmanage(client_t
*c
)
810 tag_array_t
*tags
= &globalconf
.screens
[c
->screen
].tags
;
812 if(globalconf
.screens
[c
->phys_screen
].client_focus
== c
)
815 /* remove client everywhere */
816 client_list_detach(&globalconf
.clients
, c
);
817 stack_client_delete(c
);
818 for(int i
= 0; i
< tags
->len
; i
++)
819 untag_client(c
, tags
->tab
[i
]);
822 luaA_client_userdata_new(globalconf
.L
, c
);
823 luaA_dofunction(globalconf
.L
, globalconf
.hooks
.unmanage
, 1, 0);
825 /* Call hook to notify list change */
826 luaA_dofunction(globalconf
.L
, globalconf
.hooks
.clients
, 0, 0);
828 /* The server grab construct avoids race conditions. */
829 xcb_grab_server(globalconf
.connection
);
831 xcb_configure_window(globalconf
.connection
, c
->win
,
832 XCB_CONFIG_WINDOW_BORDER_WIDTH
,
833 (uint32_t *) &c
->oldborder
);
835 xcb_ungrab_button(globalconf
.connection
, XCB_BUTTON_INDEX_ANY
, c
->win
,
836 XCB_BUTTON_MASK_ANY
);
837 window_state_set(c
->win
, XCB_WM_STATE_WITHDRAWN
);
839 xcb_flush(globalconf
.connection
);
840 xcb_ungrab_server(globalconf
.connection
);
842 titlebar_client_detach(c
);
844 ewmh_update_net_client_list(c
->phys_screen
);
846 /* delete properties */
847 xcb_delete_property(globalconf
.connection
, c
->win
, _AWESOME_TAGS
);
848 xcb_delete_property(globalconf
.connection
, c
->win
, _AWESOME_FLOATING
);
850 if(client_hasstrut(c
))
851 /* All the wiboxes (may) need to be repositioned */
852 for(int screen
= 0; screen
< globalconf
.nscreen
; screen
++)
853 for(int i
= 0; i
< globalconf
.screens
[screen
].wiboxes
.len
; i
++)
855 wibox_t
*s
= globalconf
.screens
[screen
].wiboxes
.tab
[i
];
856 wibox_position_update(s
);
859 /* set client as invalid */
865 /** Kill a client via a WM_DELETE_WINDOW request or KillClient if not
867 * \param c The client to kill.
870 client_kill(client_t
*c
)
872 if(window_hasproto(c
->win
, WM_DELETE_WINDOW
))
874 xcb_client_message_event_t ev
;
876 /* Initialize all of event's fields first */
879 ev
.response_type
= XCB_CLIENT_MESSAGE
;
882 ev
.data
.data32
[1] = XCB_CURRENT_TIME
;
883 ev
.type
= WM_PROTOCOLS
;
884 ev
.data
.data32
[0] = WM_DELETE_WINDOW
;
886 xcb_send_event(globalconf
.connection
, false, c
->win
,
887 XCB_EVENT_MASK_NO_EVENT
, (char *) &ev
);
890 xcb_kill_client(globalconf
.connection
, c
->win
);
893 /** Get all clients into a table.
894 * \param L The Lua VM state.
895 * \return The number of elements pushed on stack.
897 * \lparam An optional screen nunmber.
898 * \lreturn A table with all clients.
901 luaA_client_get(lua_State
*L
)
906 screen
= luaL_optnumber(L
, 1, 0) - 1;
910 if(screen
== SCREEN_UNDEF
)
911 for(c
= globalconf
.clients
; c
; c
= c
->next
)
913 luaA_client_userdata_new(globalconf
.L
, c
);
914 lua_rawseti(L
, -2, i
++);
918 luaA_checkscreen(screen
);
919 for(c
= globalconf
.clients
; c
; c
= c
->next
)
920 if(c
->screen
== screen
)
922 luaA_client_userdata_new(globalconf
.L
, c
);
923 lua_rawseti(L
, -2, i
++);
930 /** Get only visible clients for a screen (DEPRECATED).
931 * \param L The Lua VM state.
932 * \return The number of elements pushed on stack.
934 * \lparam A screen number.
935 * \lreturn A table with all visible clients for this screen.
938 luaA_client_visible_get(lua_State
*L
)
942 int screen
= luaL_checknumber(L
, 1) - 1;
944 luaA_checkscreen(screen
);
946 deprecate(L
, "awful.client.visible()");
950 for(c
= globalconf
.clients
; c
; c
= c
->next
)
951 if(client_isvisible(c
, screen
))
953 luaA_client_userdata_new(L
, c
);
954 lua_rawseti(L
, -2, i
++);
960 /** Check if a client is visible on its screen.
961 * \param L The Lua VM state.
962 * \return The number of elements pushed on stack.
965 * \lreturn A boolean value, true if the client is visible, false otherwise.
968 luaA_client_isvisible(lua_State
*L
)
970 client_t
**c
= luaA_checkudata(L
, 1, "client");
971 lua_pushboolean(L
, client_isvisible(*c
, (*c
)->screen
));
975 /** Set client border width.
976 * \param c The client.
977 * \param width The border width.
980 client_setborder(client_t
*c
, int width
)
984 if(width
> 0 && (c
->type
== WINDOW_TYPE_DOCK
985 || c
->type
== WINDOW_TYPE_SPLASH
986 || c
->type
== WINDOW_TYPE_DESKTOP
990 if(width
== c
->border
|| width
< 0)
994 xcb_configure_window(globalconf
.connection
, c
->win
,
995 XCB_CONFIG_WINDOW_BORDER_WIDTH
, &w
);
997 if(client_isvisible(c
, c
->screen
))
999 if(client_isfloating(c
) || layout_get_current(c
->screen
) == layout_floating
)
1000 titlebar_update_geometry_floating(c
);
1002 globalconf
.screens
[c
->screen
].need_arrange
= true;
1005 hooks_property(c
, "border_width");
1009 * \param L The Lua VM state.
1015 luaA_client_kill(lua_State
*L
)
1017 client_t
**c
= luaA_checkudata(L
, 1, "client");
1022 /** Swap a client with another one.
1023 * \param L The Lua VM state.
1026 * \lparam A client to swap with.
1029 luaA_client_swap(lua_State
*L
)
1031 client_t
**c
= luaA_checkudata(L
, 1, "client");
1032 client_t
**swap
= luaA_checkudata(L
, 2, "client");
1033 client_list_swap(&globalconf
.clients
, *swap
, *c
);
1034 client_need_arrange(*c
);
1035 client_need_arrange(*swap
);
1037 /* Call hook to notify list change */
1038 luaA_dofunction(L
, globalconf
.hooks
.clients
, 0, 0);
1043 /** Access or set the client tags.
1044 * \param L The Lua VM state.
1045 * \return The number of elements pushed on stack.
1046 * \lparam A table with tags to set, or none to get the current tags table.
1047 * \return The clients tag.
1050 luaA_client_tags(lua_State
*L
)
1054 client_t
**c
= luaA_checkudata(L
, 1, "client");
1057 if(lua_gettop(L
) == 2)
1059 luaA_checktable(L
, 2);
1060 tags
= &globalconf
.screens
[(*c
)->screen
].tags
;
1061 for(int i
= 0; i
< tags
->len
; i
++)
1062 untag_client(*c
, tags
->tab
[i
]);
1064 while(lua_next(L
, 2))
1066 tag
= luaA_checkudata(L
, -1, "tag");
1067 tag_client(*c
, *tag
);
1073 tags
= &globalconf
.screens
[(*c
)->screen
].tags
;
1075 for(int i
= 0; i
< tags
->len
; i
++)
1076 if(is_client_tagged(*c
, tags
->tab
[i
]))
1078 luaA_tag_userdata_new(L
, tags
->tab
[i
]);
1079 lua_rawseti(L
, -2, ++j
);
1085 /** Raise a client on top of others which are on the same layer.
1086 * \param L The Lua VM state.
1091 luaA_client_raise(lua_State
*L
)
1093 client_t
**c
= luaA_checkudata(L
, 1, "client");
1098 /** Lower a client on bottom of others which are on the same layer.
1099 * \param L The Lua VM state.
1104 luaA_client_lower(lua_State
*L
)
1106 client_t
**c
= luaA_checkudata(L
, 1, "client");
1111 /** Redraw a client by unmapping and mapping it quickly.
1112 * \param L The Lua VM state.
1118 luaA_client_redraw(lua_State
*L
)
1120 client_t
**c
= luaA_checkudata(L
, 1, "client");
1122 xcb_unmap_window(globalconf
.connection
, (*c
)->win
);
1123 xcb_map_window(globalconf
.connection
, (*c
)->win
);
1125 /* Set the focus on the current window if the redraw has been
1126 performed on the window where the pointer is currently on
1127 because after the unmapping/mapping, the focus is lost */
1128 if(globalconf
.screen_focus
->client_focus
== *c
)
1129 xcb_set_input_focus(globalconf
.connection
, XCB_INPUT_FOCUS_POINTER_ROOT
,
1130 (*c
)->win
, XCB_CURRENT_TIME
);
1135 /** Stop managing a client.
1136 * \param L The Lua VM state.
1137 * \return The number of elements pushed on stack.
1142 luaA_client_unmanage(lua_State
*L
)
1144 client_t
**c
= luaA_checkudata(L
, 1, "client");
1145 client_unmanage(*c
);
1149 /** Return client geometry.
1150 * \param L The Lua VM state.
1151 * \param full Use titlebar also.
1152 * \return The number of elements pushed on stack.
1155 luaA_client_handlegeom(lua_State
*L
, bool full
)
1157 client_t
**c
= luaA_checkudata(L
, 1, "client");
1159 if(lua_gettop(L
) == 2)
1160 if(client_isfloating(*c
)
1161 || layout_get_current((*c
)->screen
) == layout_floating
)
1165 luaA_checktable(L
, 2);
1166 geometry
.x
= luaA_getopt_number(L
, 2, "x", (*c
)->geometry
.x
);
1167 geometry
.y
= luaA_getopt_number(L
, 2, "y", (*c
)->geometry
.y
);
1168 if(client_isfixed(*c
))
1170 geometry
.width
= (*c
)->geometry
.width
;
1171 geometry
.height
= (*c
)->geometry
.height
;
1175 geometry
.width
= luaA_getopt_number(L
, 2, "width", (*c
)->geometry
.width
);
1176 geometry
.height
= luaA_getopt_number(L
, 2, "height", (*c
)->geometry
.height
);
1179 geometry
= titlebar_geometry_remove((*c
)->titlebar
,
1182 client_resize(*c
, geometry
, false);
1186 return luaA_pusharea(L
, titlebar_geometry_add((*c
)->titlebar
,
1190 return luaA_pusharea(L
, (*c
)->geometry
);
1193 /** Return client geometry.
1194 * \param L The Lua VM state.
1195 * \return The number of elements pushed on stack.
1197 * \lparam A table with new coordinates, or none.
1198 * \lreturn A table with client coordinates.
1201 luaA_client_geometry(lua_State
*L
)
1203 return luaA_client_handlegeom(L
, false);
1207 luaA_client_coords(lua_State
*L
)
1209 deprecate(L
, "client:geometry()");
1210 return luaA_client_geometry(L
);
1213 /** Return client geometry, using also titlebar and border width.
1214 * \param L The Lua VM state.
1215 * \return The number of elements pushed on stack.
1217 * \lparam A table with new coordinates, or none.
1218 * \lreturn A table with client coordinates.
1221 luaA_client_fullgeometry(lua_State
*L
)
1223 return luaA_client_handlegeom(L
, true);
1227 luaA_client_fullcoords(lua_State
*L
)
1229 deprecate(L
, "client:fullgeometry()");
1230 return luaA_client_fullgeometry(L
);
1233 /** Client newindex.
1234 * \param L The Lua VM state.
1235 * \return The number of elements pushed on stack.
1238 luaA_client_newindex(lua_State
*L
)
1241 client_t
**c
= luaA_checkudata(L
, 1, "client");
1242 const char *buf
= luaL_checklstring(L
, 2, &len
);
1250 luaL_error(L
, "client is invalid\n");
1252 switch(a_tokenize(buf
, len
))
1255 if(globalconf
.xinerama_is_active
)
1257 i
= luaL_checknumber(L
, 3) - 1;
1258 luaA_checkscreen(i
);
1259 if(i
!= (*c
)->screen
)
1260 screen_client_moveto(*c
, i
, true, true);
1264 b
= luaA_checkboolean(L
, 3);
1265 if(b
!= (*c
)->ishidden
)
1267 client_need_arrange(*c
);
1269 client_need_arrange(*c
);
1273 client_setminimized(*c
, luaA_checkboolean(L
, 3));
1275 case A_TK_FULLSCREEN
:
1276 client_setfullscreen(*c
, luaA_checkboolean(L
, 3));
1279 image
= luaA_checkudata(L
, 3, "image");
1280 image_unref(&(*c
)->icon
);
1282 (*c
)->icon
= *image
;
1284 hooks_property(*c
, "icon");
1288 window_opacity_set((*c
)->win
, -1);
1291 d
= luaL_checknumber(L
, 3);
1292 if(d
>= 0 && d
<= 1)
1293 window_opacity_set((*c
)->win
, d
);
1297 client_setfloating(*c
, luaA_checkboolean(L
, 3));
1300 client_setsticky(*c
, luaA_checkboolean(L
, 3));
1302 case A_TK_HONORSIZEHINTS
:
1303 (*c
)->honorsizehints
= luaA_checkboolean(L
, 3);
1304 client_need_arrange(*c
);
1306 case A_TK_BORDER_WIDTH
:
1307 client_setborder(*c
, luaL_checknumber(L
, 3));
1310 client_setontop(*c
, luaA_checkboolean(L
, 3));
1312 case A_TK_BORDER_COLOR
:
1313 if((buf
= luaL_checklstring(L
, 3, &len
))
1314 && xcolor_init_reply(xcolor_init_unchecked(&(*c
)->border_color
, buf
, len
)))
1315 xcb_change_window_attributes(globalconf
.connection
, (*c
)->win
,
1316 XCB_CW_BORDER_PIXEL
, &(*c
)->border_color
.pixel
);
1320 titlebar_client_detach(*c
);
1323 t
= luaA_checkudata(L
, 3, "wibox");
1324 titlebar_client_attach(*c
, *t
);
1335 * \param L The Lua VM state.
1336 * \return The number of elements pushed on stack.
1338 * \lfield name The client title.
1339 * \lfield skip_taskbar True if the client does not want to be in taskbar.
1340 * \lfield type The window type (desktop, normal, dock, …).
1341 * \lfield class The client class.
1342 * \lfield instance The client instance.
1343 * \lfield pid The client PID, if available.
1344 * \lfield role The window role, if available.
1345 * \lfield machine The machine client is running on.
1346 * \lfield icon_name The client name when iconified.
1347 * \lfield screen Client screen number.
1348 * \lfield hide Define if the client must be hidden, i.e. never mapped,
1349 * invisible in taskbar.
1350 * \lfield minimize Define it the client must be iconify, i.e. only visible in
1352 * \lfield icon_path Path to the icon used to identify.
1353 * \lfield floating True always floating.
1354 * \lfield honorsizehints Honor size hints, i.e. respect size ratio.
1355 * \lfield border_width The client border width.
1356 * \lfield border_color The client border color.
1357 * \lfield titlebar The client titlebar.
1358 * \lfield urgent The client urgent state.
1359 * \lfield focus The focused client.
1360 * \lfield opacity The client opacity between 0 and 1.
1361 * \lfield ontop The client is on top of every other windows.
1362 * \lfield fullscreen The client is fullscreen or not.
1363 * \lfield transient_for Return the client the window is transient for.
1364 * \lfield size_hints A table with size hints of the client: user_position,
1365 * user_size, program_position and program_size.
1368 luaA_client_index(lua_State
*L
)
1372 client_t
**c
= luaA_checkudata(L
, 1, "client");
1373 const char *buf
= luaL_checklstring(L
, 2, &len
);
1376 xcb_get_wm_class_reply_t hint
;
1377 xcb_get_property_cookie_t prop_c
;
1378 xcb_get_property_reply_t
*prop_r
= NULL
;
1382 luaL_error(L
, "client is invalid\n");
1384 if(luaA_usemetatable(L
, 1, 2))
1387 switch(a_tokenize(buf
, len
))
1390 lua_pushstring(L
, (*c
)->name
);
1392 case A_TK_TRANSIENT_FOR
:
1393 if((*c
)->transient_for
)
1394 return luaA_client_userdata_new(L
, (*c
)->transient_for
);
1395 case A_TK_SKIP_TASKBAR
:
1396 lua_pushboolean(L
, (*c
)->skiptb
);
1401 case WINDOW_TYPE_DESKTOP
:
1402 lua_pushliteral(L
, "desktop");
1404 case WINDOW_TYPE_DOCK
:
1405 lua_pushliteral(L
, "dock");
1407 case WINDOW_TYPE_SPLASH
:
1408 lua_pushliteral(L
, "splash");
1410 case WINDOW_TYPE_DIALOG
:
1411 lua_pushliteral(L
, "dialog");
1414 lua_pushliteral(L
, "normal");
1419 if(!xcb_get_wm_class_reply(globalconf
.connection
,
1420 xcb_get_wm_class_unchecked(globalconf
.connection
, (*c
)->win
),
1423 lua_pushstring(L
, hint
.class);
1424 xcb_get_wm_class_reply_wipe(&hint
);
1427 if(!xcb_get_wm_class_reply(globalconf
.connection
,
1428 xcb_get_wm_class_unchecked(globalconf
.connection
, (*c
)->win
),
1431 lua_pushstring(L
, hint
.name
);
1432 xcb_get_wm_class_reply_wipe(&hint
);
1435 if(!xutil_text_prop_get(globalconf
.connection
, (*c
)->win
,
1436 WM_WINDOW_ROLE
, &value
, &slen
))
1438 lua_pushlstring(L
, value
, slen
);
1442 prop_c
= xcb_get_property_unchecked(globalconf
.connection
, false, (*c
)->win
, _NET_WM_PID
, CARDINAL
, 0L, 1L);
1443 prop_r
= xcb_get_property_reply(globalconf
.connection
, prop_c
, NULL
);
1445 if(prop_r
&& prop_r
->value_len
&& (data
= xcb_get_property_value(prop_r
)))
1446 lua_pushnumber(L
, *(uint32_t *)data
);
1454 if(!xutil_text_prop_get(globalconf
.connection
, (*c
)->win
,
1455 WM_CLIENT_MACHINE
, &value
, &slen
))
1457 lua_pushlstring(L
, value
, slen
);
1460 case A_TK_ICON_NAME
:
1461 lua_pushstring(L
, (*c
)->icon_name
);
1464 lua_pushnumber(L
, 1 + (*c
)->screen
);
1467 lua_pushboolean(L
, (*c
)->ishidden
);
1470 lua_pushboolean(L
, (*c
)->isminimized
);
1472 case A_TK_FULLSCREEN
:
1473 lua_pushboolean(L
, (*c
)->isfullscreen
);
1477 luaA_image_userdata_new(L
, (*c
)->icon
);
1482 if((d
= window_opacity_get((*c
)->win
)) >= 0)
1483 lua_pushnumber(L
, d
);
1488 lua_pushboolean(L
, client_isfloating(*c
));
1491 lua_pushboolean(L
, (*c
)->isontop
);
1494 lua_pushboolean(L
, (*c
)->issticky
);
1496 case A_TK_HONORSIZEHINTS
:
1497 lua_pushboolean(L
, (*c
)->honorsizehints
);
1499 case A_TK_BORDER_WIDTH
:
1500 lua_pushnumber(L
, (*c
)->border
);
1502 case A_TK_BORDER_COLOR
:
1503 luaA_pushcolor(L
, &(*c
)->border_color
);
1507 return luaA_wibox_userdata_new(L
, (*c
)->titlebar
);
1510 lua_pushboolean(L
, (*c
)->isurgent
);
1512 case A_TK_SIZE_HINTS
:
1514 lua_pushboolean(L
, (*c
)->size_hints
.flags
& XCB_SIZE_HINT_US_POSITION
);
1515 lua_setfield(L
, -2, "user_position");
1516 lua_pushboolean(L
, (*c
)->size_hints
.flags
& XCB_SIZE_HINT_US_SIZE
);
1517 lua_setfield(L
, -2, "user_size");
1518 lua_pushboolean(L
, (*c
)->size_hints
.flags
& XCB_SIZE_HINT_P_POSITION
);
1519 lua_setfield(L
, -2, "program_position");
1520 lua_pushboolean(L
, (*c
)->size_hints
.flags
& XCB_SIZE_HINT_P_SIZE
);
1521 lua_setfield(L
, -2, "program_size");
1530 /** Get or set mouse buttons bindings for a client.
1531 * \param L The Lua VM state.
1532 * \return The number of element pushed on stack.
1535 * \lparam An array of mouse button bindings objects, or nothing.
1536 * \return The array of mouse button bindings objects of this client.
1539 luaA_client_buttons(lua_State
*L
)
1541 client_t
**client
= luaA_checkudata(L
, 1, "client");
1542 button_array_t
*buttons
= &(*client
)->buttons
;
1544 if(lua_gettop(L
) == 2)
1545 luaA_button_array_set(L
, 2, buttons
);
1547 return luaA_button_array_get(L
, buttons
);
1551 * \param L The Lua VM state.
1552 * \return The number of pushed elements.
1555 luaA_client_module_index(lua_State
*L
)
1558 const char *buf
= luaL_checklstring(L
, 2, &len
);
1560 switch(a_tokenize(buf
, len
))
1563 if(globalconf
.screen_focus
->client_focus
)
1564 luaA_client_userdata_new(L
, globalconf
.screen_focus
->client_focus
);
1575 /* Client module new index.
1576 * \param L The Lua VM state.
1577 * \return The number of pushed elements.
1580 luaA_client_module_newindex(lua_State
*L
)
1583 const char *buf
= luaL_checklstring(L
, 2, &len
);
1586 switch(a_tokenize(buf
, len
))
1589 c
= luaA_checkudata(L
, 3, "client");
1599 const struct luaL_reg awesome_client_methods
[] =
1601 { "get", luaA_client_get
},
1602 { "visible_get", luaA_client_visible_get
},
1603 { "__index", luaA_client_module_index
},
1604 { "__newindex", luaA_client_module_newindex
},
1607 const struct luaL_reg awesome_client_meta
[] =
1609 { "isvisible", luaA_client_isvisible
},
1610 { "geometry", luaA_client_geometry
},
1611 { "fullgeometry", luaA_client_fullgeometry
},
1612 { "buttons", luaA_client_buttons
},
1613 { "tags", luaA_client_tags
},
1614 { "kill", luaA_client_kill
},
1615 { "swap", luaA_client_swap
},
1616 { "raise", luaA_client_raise
},
1617 { "lower", luaA_client_lower
},
1618 { "redraw", luaA_client_redraw
},
1619 { "mouse_resize", luaA_client_mouse_resize
},
1620 { "mouse_move", luaA_client_mouse_move
},
1621 { "unmanage", luaA_client_unmanage
},
1622 { "__index", luaA_client_index
},
1623 { "__newindex", luaA_client_newindex
},
1624 { "__eq", luaA_client_eq
},
1625 { "__gc", luaA_client_gc
},
1626 { "__tostring", luaA_client_tostring
},
1628 { "coords", luaA_client_coords
},
1629 { "fullcoords", luaA_client_fullcoords
},
1633 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80