titlebar.c

   1 /*
   2  * titlebar.c - titlebar management
   3  *
   4  * Copyright © 2008 Julien Danjou <julien@danjou.info>
   5  *
   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.
  10  *
  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.
  15  *
  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.
  19  *
  20  */
  21
  22 #include <xcb/xcb.h>
  23
  24 #include "titlebar.h"
  25 #include "client.h"
  26 #include "widget.h"
  27 #include "wibox.h"
  28 #include "screen.h"
  29
  30 /** Get a client by its titlebar.
  31  * \param titlebar The titlebar.
  32  * \return A client.
  33  */
  34 client_t *
  35 client_getbytitlebar(wibox_t *titlebar)
  36 {
  37     foreach(c, globalconf.clients)
  38         if((*c)->titlebar == titlebar)
  39             return *c;
  40
  41     return NULL;
  42 }
  43
  44 /** Get a client by its titlebar window.
  45  * \param win The window.
  46  * \return A client.
  47  */
  48 client_t *
  49 client_getbytitlebarwin(xcb_window_t win)
  50 {
  51     foreach(c, globalconf.clients)
  52         if((*c)->titlebar && (*c)->titlebar->sw.window == win)
  53             return *c;
  54
  55     return NULL;
  56 }
  57
  58 /** Move a titlebar out of the viewport.
  59  * \param titlebar The titlebar.
  60  */
  61 void
  62 titlebar_ban(wibox_t *titlebar)
  63 {
  64     /* Do it manually because client geometry remains unchanged. */
  65     if(titlebar && !titlebar->isbanned)
  66     {
  67         client_t *c;
  68         simple_window_t *sw = &titlebar->sw;
  69
  70         if(sw->window)
  71             xcb_unmap_window(globalconf.connection, sw->window);
  72
  73         /* Remove titlebar geometry from client. */
  74         if((c = client_getbytitlebar(titlebar)))
  75             c->geometry = titlebar_geometry_remove(titlebar, 0, c->geometry);
  76
  77         titlebar->isbanned = true;
  78     }
  79 }
  80
  81 /** Move a titlebar on top of its client.
  82  * \param titlebar The titlebar.
  83  */
  84 void
  85 titlebar_unban(wibox_t *titlebar)
  86 {
  87     /* Do this manually because the system doesn't know we moved the toolbar.
  88      * Note that !isvisible titlebars are unmapped and for fullscreen it'll
  89      * end up offscreen anyway. */
  90     if(titlebar && titlebar->isbanned)
  91     {
  92         client_t *c;
  93         simple_window_t *sw = &titlebar->sw;
  94
  95         if(sw->window)
  96             xcb_map_window(globalconf.connection, sw->window);
  97
  98         titlebar->isbanned = false;
  99
 100         /* Add titlebar geometry from client. */
 101         if((c = client_getbytitlebar(titlebar)))
 102             c->geometry = titlebar_geometry_add(titlebar, 0, c->geometry);
 103     }
 104 }
 105
 106 /** Get titlebar area.
 107  * \param c The client
 108  * \param geometry The client geometry including borders, excluding titlebars.
 109  * \param res Pointer to area of titlebar, must be allocated already.
 110  */
 111 void
 112 titlebar_geometry_compute(client_t *c, area_t geometry, area_t *res)
 113 {
 114     int height, width, x_offset = 0, y_offset = 0;
 115
 116     switch(c->titlebar->position)
 117     {
 118       default:
 119         return;
 120       case Top:
 121         width = MAX(1, geometry.width);
 122         switch(c->titlebar->align)
 123         {
 124           default:
 125             break;
 126           case AlignRight:
 127             x_offset = geometry.width - width;
 128             break;
 129           case AlignCenter:
 130             x_offset = (geometry.width - width) / 2;
 131             break;
 132         }
 133         res->x = geometry.x + x_offset;
 134         res->y = geometry.y - c->titlebar->sw.geometry.height;
 135         res->width = width;
 136         res->height = c->titlebar->sw.geometry.height;
 137         break;
 138       case Bottom:
 139         width = MAX(1, geometry.width);
 140         switch(c->titlebar->align)
 141         {
 142           default:
 143             break;
 144           case AlignRight:
 145             x_offset = geometry.width - width;
 146             break;
 147           case AlignCenter:
 148             x_offset = (geometry.width - width) / 2;
 149             break;
 150         }
 151         res->x = geometry.x + x_offset;
 152         res->y = geometry.y + geometry.height;
 153         res->width = width;
 154         res->height = c->titlebar->sw.geometry.height;
 155         break;
 156       case Left:
 157         height = MAX(1, geometry.height);
 158         switch(c->titlebar->align)
 159         {
 160           default:
 161             break;
 162           case AlignRight:
 163             y_offset = geometry.height - height;
 164             break;
 165           case AlignCenter:
 166             y_offset = (geometry.height - height) / 2;
 167             break;
 168         }
 169         res->x = geometry.x - c->titlebar->sw.geometry.width;
 170         res->y = geometry.y + y_offset;
 171         res->width = c->titlebar->sw.geometry.width;
 172         res->height = height;
 173         break;
 174       case Right:
 175         height = MAX(1, geometry.height);
 176         switch(c->titlebar->align)
 177         {
 178           default:
 179             break;
 180           case AlignRight:
 181             y_offset = geometry.height - height;
 182             break;
 183           case AlignCenter:
 184             y_offset = (geometry.height - height) / 2;
 185             break;
 186         }
 187         res->x = geometry.x + geometry.width;
 188         res->y = geometry.y + y_offset;
 189         res->width = c->titlebar->sw.geometry.width;
 190         res->height = height;
 191         break;
 192     }
 193 }
 194
 195 /** Detach a wibox titlebar from its client.
 196  * \param c The client.
 197  */
 198 void
 199 titlebar_client_detach(client_t *c)
 200 {
 201     /* If client has a titlebar, kick it out. */
 202     if(c && c->titlebar)
 203     {
 204         /* Update client geometry to exclude the titlebar. */
 205         c->geometry = titlebar_geometry_remove(c->titlebar, 0, c->geometry);
 206         simplewindow_wipe(&c->titlebar->sw);
 207         c->titlebar->type = WIBOX_TYPE_NORMAL;
 208         c->titlebar->screen = NULL;
 209
 210         wibox_unref(globalconf.L, c->titlebar);
 211         c->titlebar = NULL;
 212
 213         hook_property(client, c, "titlebar");
 214         client_stack();
 215     }
 216 }
 217
 218 /** Attach a wibox to a client as its titlebar.
 219  * \param c The client.
 220  * \param ud The index of the wibox on the stack.
 221  */
 222 void
 223 titlebar_client_attach(client_t *c)
 224 {
 225     /* check if we can register the object */
 226     wibox_t *t = wibox_ref(globalconf.L, -1);
 227
 228     titlebar_client_detach(c);
 229
 230     /* check if titlebar is already on a client */
 231     titlebar_client_detach(client_getbytitlebar(t));
 232
 233     /* check if client already has a titlebar. */
 234     titlebar_client_detach(c);
 235
 236     /* set the object as new client's titlebar */
 237     c->titlebar = t;
 238
 239     t->type = WIBOX_TYPE_TITLEBAR;
 240     t->screen = c->screen;
 241
 242     switch(t->position)
 243     {
 244       case Top:
 245       case Bottom:
 246         if(!t->sw.geometry.height)
 247             t->sw.geometry.height = 1.5 * globalconf.font->height;
 248         break;
 249       case Left:
 250       case Right:
 251         if(!t->sw.geometry.width)
 252             t->sw.geometry.width = 1.5 * globalconf.font->height;
 253         break;
 254     }
 255
 256     /* Update client geometry to include the titlebar. */
 257     c->geometry = titlebar_geometry_add(c->titlebar, 0, c->geometry);
 258
 259     /* Client geometry without titlebar, but including borders, since that is always consistent. */
 260     area_t wingeom;
 261     titlebar_geometry_compute(c, titlebar_geometry_remove(c->titlebar, 0, c->geometry), &wingeom);
 262
 263     simplewindow_init(&t->sw, c->phys_screen,
 264                       wingeom, 0, &t->sw.border.color,
 265                       t->sw.orientation, &t->sw.ctx.fg, &t->sw.ctx.bg);
 266
 267     t->need_update = true;
 268
 269     /* Call update geometry. This will move the wibox to the right place,
 270      * which might be the same as `wingeom', but then it will ban the
 271      * titlebar if needed. */
 272     titlebar_update_geometry(c);
 273
 274     xcb_map_window(globalconf.connection, t->sw.window);
 275
 276     hook_property(client, c, "titlebar");
 277     client_stack();
 278 }
 279
 280 /** Map or unmap a titlebar wibox.
 281  * \param t The wibox/titlebar.
 282  * \param visible The new state of the titlebar.
 283  */
 284 void
 285 titlebar_set_visible(wibox_t *t, bool visible)
 286 {
 287     if(visible != t->isvisible)
 288     {
 289         if((t->isvisible = visible))
 290             titlebar_unban(t);
 291         else
 292             titlebar_ban(t);
 293
 294         hook_property(wibox, t, "visible");
 295         client_stack();
 296     }
 297 }
 298
 299 /** Titlebar newindex.
 300  * \param L The Lua VM state.
 301  * \param titlebar The wibox titlebar.
 302  * \param tok The attribute token.
 303  * \return The number of elements pushed on stack.
 304  */
 305 int
 306 luaA_titlebar_newindex(lua_State *L, wibox_t *titlebar, awesome_token_t tok)
 307 {
 308     client_t *c = NULL;
 309
 310     switch(tok)
 311     {
 312         position_t position;
 313         int i;
 314         size_t len;
 315         const char *buf;
 316
 317       case A_TK_ALIGN:
 318         if((buf = luaL_checklstring(L, 3, &len)))
 319             titlebar->align = draw_align_fromstr(buf, len);
 320         else
 321             return 0;
 322         break;
 323       case A_TK_BORDER_WIDTH:
 324         if((i = luaL_checknumber(L, 3)) >= 0)
 325             simplewindow_border_width_set(&titlebar->sw, i);
 326         else
 327             return 0;
 328         break;
 329       case A_TK_BORDER_COLOR:
 330         if((buf = luaL_checklstring(L, 3, &len)))
 331             if(xcolor_init_reply(xcolor_init_unchecked(&titlebar->sw.border.color, buf, len)))
 332                 simplewindow_border_color_set(&titlebar->sw, &titlebar->sw.border.color);
 333         return 0;
 334       case A_TK_POSITION:
 335         buf = luaL_checklstring(L, 3, &len);
 336         position = position_fromstr(buf, len);
 337         if(position != titlebar->position)
 338         {
 339             switch(position)
 340             {
 341               case Left:
 342                 switch(titlebar->position)
 343                 {
 344                     int tmp;
 345                   case Left:
 346                   case Right:
 347                     break;
 348                   case Top:
 349                   case Bottom:
 350                     tmp = titlebar->sw.geometry.width;
 351                     titlebar->sw.geometry.width = titlebar->sw.geometry.height;
 352                     titlebar->sw.geometry.height = tmp;
 353                     break;
 354                 }
 355                 simplewindow_orientation_set(&titlebar->sw, North);
 356                 break;
 357               case Right:
 358                 switch(titlebar->position)
 359                 {
 360                     int tmp;
 361                   case Left:
 362                   case Right:
 363                     break;
 364                   case Top:
 365                   case Bottom:
 366                     tmp = titlebar->sw.geometry.width;
 367                     titlebar->sw.geometry.width = titlebar->sw.geometry.height;
 368                     titlebar->sw.geometry.height = tmp;
 369                     break;
 370                 }
 371                 simplewindow_orientation_set(&titlebar->sw, South);
 372                 break;
 373               case Top:
 374               case Bottom:
 375                 switch(titlebar->position)
 376                 {
 377                     int tmp;
 378                   case Left:
 379                   case Right:
 380                     tmp = titlebar->sw.geometry.width;
 381                     titlebar->sw.geometry.width = titlebar->sw.geometry.height;
 382                     titlebar->sw.geometry.height = tmp;
 383                     break;
 384                   case Top:
 385                   case Bottom:
 386                     break;
 387                 }
 388                 simplewindow_orientation_set(&titlebar->sw, East);
 389                 break;
 390             }
 391             titlebar->position = position;
 392             if((c = client_getbytitlebar(titlebar)))
 393             {
 394                 titlebar_update_geometry(c);
 395                 /* call geometry hook for client because some like to
 396                  * set titlebar width in that hook, which make sense */
 397                 hook_property(client, c, "geometry");
 398             }
 399         }
 400         break;
 401       default:
 402         return 0;
 403     }
 404
 405     return 0;
 406 }
 407
 408 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80