Set hints that remember the WM_WINDOW_ROLE and WM_CLASS properties for our users.
[dana/openbox.git] / openbox / screen.c
1 /* -*- indent-tabs-mode: nil; tab-width: 4; c-basic-offset: 4; -*-
2
3    screen.c for the Openbox window manager
4    Copyright (c) 2006        Mikael Magnusson
5    Copyright (c) 2003-2007   Dana Jansens
6
7    This program is free software; you can redistribute it and/or modify
8    it under the terms of the GNU General Public License as published by
9    the Free Software Foundation; either version 2 of the License, or
10    (at your option) any later version.
11
12    This program is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15    GNU General Public License for more details.
16
17    See the COPYING file for a copy of the GNU General Public License.
18 */
19
20 #include "debug.h"
21 #include "openbox.h"
22 #include "dock.h"
23 #include "xerror.h"
24 #include "prop.h"
25 #include "grab.h"
26 #include "startupnotify.h"
27 #include "moveresize.h"
28 #include "config.h"
29 #include "mainloop.h"
30 #include "screen.h"
31 #include "client.h"
32 #include "session.h"
33 #include "frame.h"
34 #include "event.h"
35 #include "focus.h"
36 #include "popup.h"
37 #include "extensions.h"
38 #include "render/render.h"
39 #include "gettext.h"
40
41 #include <X11/Xlib.h>
42 #ifdef HAVE_UNISTD_H
43 #  include <sys/types.h>
44 #  include <unistd.h>
45 #endif
46 #include <assert.h>
47
48 /*! The event mask to grab on the root window */
49 #define ROOT_EVENTMASK (StructureNotifyMask | PropertyChangeMask | \
50                         EnterWindowMask | LeaveWindowMask | \
51                         SubstructureRedirectMask | FocusChangeMask | \
52                         ButtonPressMask | ButtonReleaseMask)
53
54 static gboolean screen_validate_layout(ObDesktopLayout *l);
55 static gboolean replace_wm(void);
56 static void     screen_tell_ksplash(void);
57 static void     screen_fallback_focus(void);
58
59 guint           screen_num_desktops;
60 guint           screen_num_monitors;
61 guint           screen_desktop;
62 guint           screen_last_desktop;
63 gboolean        screen_showing_desktop;
64 ObDesktopLayout screen_desktop_layout;
65 gchar         **screen_desktop_names;
66 Window          screen_support_win;
67 Time            screen_desktop_user_time = CurrentTime;
68
69 static Size     screen_physical_size;
70 static guint    screen_old_desktop;
71 static gboolean screen_desktop_timeout = TRUE;
72 /*! An array of desktops, holding an array of areas per monitor */
73 static Rect  *monitor_area = NULL;
74 /*! An array of desktops, holding an array of struts */
75 static GSList *struts_top = NULL;
76 static GSList *struts_left = NULL;
77 static GSList *struts_right = NULL;
78 static GSList *struts_bottom = NULL;
79
80 static ObPagerPopup *desktop_popup;
81
82 /*! The number of microseconds that you need to be on a desktop before it will
83   replace the remembered "last desktop" */
84 #define REMEMBER_LAST_DESKTOP_TIME 750000
85
86 static gboolean replace_wm(void)
87 {
88     gchar *wm_sn;
89     Atom wm_sn_atom;
90     Window current_wm_sn_owner;
91     Time timestamp;
92
93     wm_sn = g_strdup_printf("WM_S%d", ob_screen);
94     wm_sn_atom = XInternAtom(ob_display, wm_sn, FALSE);
95     g_free(wm_sn);
96
97     current_wm_sn_owner = XGetSelectionOwner(ob_display, wm_sn_atom);
98     if (current_wm_sn_owner == screen_support_win)
99         current_wm_sn_owner = None;
100     if (current_wm_sn_owner) {
101         if (!ob_replace_wm) {
102             g_message(_("A window manager is already running on screen %d"),
103                       ob_screen);
104             return FALSE;
105         }
106         xerror_set_ignore(TRUE);
107         xerror_occured = FALSE;
108
109         /* We want to find out when the current selection owner dies */
110         XSelectInput(ob_display, current_wm_sn_owner, StructureNotifyMask);
111         XSync(ob_display, FALSE);
112
113         xerror_set_ignore(FALSE);
114         if (xerror_occured)
115             current_wm_sn_owner = None;
116     }
117
118     timestamp = event_get_server_time();
119
120     XSetSelectionOwner(ob_display, wm_sn_atom, screen_support_win,
121                        timestamp);
122
123     if (XGetSelectionOwner(ob_display, wm_sn_atom) != screen_support_win) {
124         g_message(_("Could not acquire window manager selection on screen %d"),
125                   ob_screen);
126         return FALSE;
127     }
128
129     /* Wait for old window manager to go away */
130     if (current_wm_sn_owner) {
131       XEvent event;
132       gulong wait = 0;
133       const gulong timeout = G_USEC_PER_SEC * 15; /* wait for 15s max */
134
135       while (wait < timeout) {
136           if (XCheckWindowEvent(ob_display, current_wm_sn_owner,
137                                 StructureNotifyMask, &event) &&
138               event.type == DestroyNotify)
139               break;
140           g_usleep(G_USEC_PER_SEC / 10);
141           wait += G_USEC_PER_SEC / 10;
142       }
143
144       if (wait >= timeout) {
145           g_message(_("The WM on screen %d is not exiting"), ob_screen);
146           return FALSE;
147       }
148     }
149
150     /* Send client message indicating that we are now the WM */
151     prop_message(RootWindow(ob_display, ob_screen), prop_atoms.manager,
152                  timestamp, wm_sn_atom, screen_support_win, 0,
153                  SubstructureNotifyMask);
154
155     return TRUE;
156 }
157
158 gboolean screen_annex(void)
159 {
160     XSetWindowAttributes attrib;
161     pid_t pid;
162     gint i, num_support;
163     Atom *prop_atoms_start, *wm_supported_pos;
164     gulong *supported;
165
166     /* create the netwm support window */
167     attrib.override_redirect = TRUE;
168     attrib.event_mask = PropertyChangeMask;
169     screen_support_win = XCreateWindow(ob_display,
170                                        RootWindow(ob_display, ob_screen),
171                                        -100, -100, 1, 1, 0,
172                                        CopyFromParent, InputOutput,
173                                        CopyFromParent,
174                                        CWEventMask | CWOverrideRedirect,
175                                        &attrib);
176     XMapWindow(ob_display, screen_support_win);
177     XLowerWindow(ob_display, screen_support_win);
178
179     if (!replace_wm()) {
180         XDestroyWindow(ob_display, screen_support_win);
181         return FALSE;
182     }
183
184     xerror_set_ignore(TRUE);
185     xerror_occured = FALSE;
186     XSelectInput(ob_display, RootWindow(ob_display, ob_screen),
187                  ROOT_EVENTMASK);
188     xerror_set_ignore(FALSE);
189     if (xerror_occured) {
190         g_message(_("A window manager is already running on screen %d"),
191                   ob_screen);
192
193         XDestroyWindow(ob_display, screen_support_win);
194         return FALSE;
195     }
196
197     screen_set_root_cursor();
198
199     /* set the OPENBOX_PID hint */
200     pid = getpid();
201     PROP_SET32(RootWindow(ob_display, ob_screen),
202                openbox_pid, cardinal, pid);
203
204     /* set supporting window */
205     PROP_SET32(RootWindow(ob_display, ob_screen),
206                net_supporting_wm_check, window, screen_support_win);
207
208     /* set properties on the supporting window */
209     PROP_SETS(screen_support_win, net_wm_name, "Openbox");
210     PROP_SET32(screen_support_win, net_supporting_wm_check,
211                window, screen_support_win);
212
213     /* set the _NET_SUPPORTED_ATOMS hint */
214
215     /* this is all the atoms after net_supported in the prop_atoms struct */
216     prop_atoms_start = (Atom*)&prop_atoms;
217     wm_supported_pos = (Atom*)&(prop_atoms.net_supported);
218     num_support = sizeof(prop_atoms) / sizeof(Atom) -
219         (wm_supported_pos - prop_atoms_start) - 1;
220     i = 0;
221     supported = g_new(gulong, num_support);
222     supported[i++] = prop_atoms.net_supporting_wm_check;
223     supported[i++] = prop_atoms.net_wm_full_placement;
224     supported[i++] = prop_atoms.net_current_desktop;
225     supported[i++] = prop_atoms.net_number_of_desktops;
226     supported[i++] = prop_atoms.net_desktop_geometry;
227     supported[i++] = prop_atoms.net_desktop_viewport;
228     supported[i++] = prop_atoms.net_active_window;
229     supported[i++] = prop_atoms.net_workarea;
230     supported[i++] = prop_atoms.net_client_list;
231     supported[i++] = prop_atoms.net_client_list_stacking;
232     supported[i++] = prop_atoms.net_desktop_names;
233     supported[i++] = prop_atoms.net_close_window;
234     supported[i++] = prop_atoms.net_desktop_layout;
235     supported[i++] = prop_atoms.net_showing_desktop;
236     supported[i++] = prop_atoms.net_wm_name;
237     supported[i++] = prop_atoms.net_wm_visible_name;
238     supported[i++] = prop_atoms.net_wm_icon_name;
239     supported[i++] = prop_atoms.net_wm_visible_icon_name;
240     supported[i++] = prop_atoms.net_wm_desktop;
241     supported[i++] = prop_atoms.net_wm_strut;
242     supported[i++] = prop_atoms.net_wm_strut_partial;
243     supported[i++] = prop_atoms.net_wm_icon;
244     supported[i++] = prop_atoms.net_wm_icon_geometry;
245     supported[i++] = prop_atoms.net_wm_window_type;
246     supported[i++] = prop_atoms.net_wm_window_type_desktop;
247     supported[i++] = prop_atoms.net_wm_window_type_dock;
248     supported[i++] = prop_atoms.net_wm_window_type_toolbar;
249     supported[i++] = prop_atoms.net_wm_window_type_menu;
250     supported[i++] = prop_atoms.net_wm_window_type_utility;
251     supported[i++] = prop_atoms.net_wm_window_type_splash;
252     supported[i++] = prop_atoms.net_wm_window_type_dialog;
253     supported[i++] = prop_atoms.net_wm_window_type_normal;
254     supported[i++] = prop_atoms.net_wm_allowed_actions;
255     supported[i++] = prop_atoms.net_wm_action_move;
256     supported[i++] = prop_atoms.net_wm_action_resize;
257     supported[i++] = prop_atoms.net_wm_action_minimize;
258     supported[i++] = prop_atoms.net_wm_action_shade;
259     supported[i++] = prop_atoms.net_wm_action_maximize_horz;
260     supported[i++] = prop_atoms.net_wm_action_maximize_vert;
261     supported[i++] = prop_atoms.net_wm_action_fullscreen;
262     supported[i++] = prop_atoms.net_wm_action_change_desktop;
263     supported[i++] = prop_atoms.net_wm_action_close;
264     supported[i++] = prop_atoms.net_wm_action_above;
265     supported[i++] = prop_atoms.net_wm_action_below;
266     supported[i++] = prop_atoms.net_wm_state;
267     supported[i++] = prop_atoms.net_wm_state_modal;
268     supported[i++] = prop_atoms.net_wm_state_maximized_vert;
269     supported[i++] = prop_atoms.net_wm_state_maximized_horz;
270     supported[i++] = prop_atoms.net_wm_state_shaded;
271     supported[i++] = prop_atoms.net_wm_state_skip_taskbar;
272     supported[i++] = prop_atoms.net_wm_state_skip_pager;
273     supported[i++] = prop_atoms.net_wm_state_hidden;
274     supported[i++] = prop_atoms.net_wm_state_fullscreen;
275     supported[i++] = prop_atoms.net_wm_state_above;
276     supported[i++] = prop_atoms.net_wm_state_below;
277     supported[i++] = prop_atoms.net_wm_state_demands_attention;
278     supported[i++] = prop_atoms.net_moveresize_window;
279     supported[i++] = prop_atoms.net_wm_moveresize;
280     supported[i++] = prop_atoms.net_wm_user_time;
281 /*
282     supported[i++] = prop_atoms.net_wm_user_time_window;
283 */
284     supported[i++] = prop_atoms.net_frame_extents;
285     supported[i++] = prop_atoms.net_request_frame_extents;
286     supported[i++] = prop_atoms.net_restack_window;
287     supported[i++] = prop_atoms.net_startup_id;
288 #ifdef SYNC
289     supported[i++] = prop_atoms.net_wm_sync_request;
290     supported[i++] = prop_atoms.net_wm_sync_request_counter;
291 #endif
292     supported[i++] = prop_atoms.net_wm_pid;
293     supported[i++] = prop_atoms.net_wm_ping;
294
295     supported[i++] = prop_atoms.kde_wm_change_state;
296     supported[i++] = prop_atoms.kde_net_wm_frame_strut;
297     supported[i++] = prop_atoms.kde_net_wm_window_type_override;
298
299     supported[i++] = prop_atoms.ob_wm_action_undecorate;
300     supported[i++] = prop_atoms.ob_wm_state_undecorated;
301     supported[i++] = prop_atoms.openbox_pid;
302     supported[i++] = prop_atoms.ob_theme;
303     supported[i++] = prop_atoms.ob_config_file;
304     supported[i++] = prop_atoms.ob_control;
305     supported[i++] = prop_atoms.ob_role;
306     supported[i++] = prop_atoms.ob_name;
307     supported[i++] = prop_atoms.ob_class;
308     g_assert(i == num_support);
309
310     PROP_SETA32(RootWindow(ob_display, ob_screen),
311                 net_supported, atom, supported, num_support);
312     g_free(supported);
313
314     screen_tell_ksplash();
315
316     return TRUE;
317 }
318
319 static void screen_tell_ksplash(void)
320 {
321     XEvent e;
322     char **argv;
323
324     argv = g_new(gchar*, 6);
325     argv[0] = g_strdup("dcop");
326     argv[1] = g_strdup("ksplash");
327     argv[2] = g_strdup("ksplash");
328     argv[3] = g_strdup("upAndRunning(QString)");
329     argv[4] = g_strdup("wm started");
330     argv[5] = NULL;
331
332     /* tell ksplash through the dcop server command line interface */
333     g_spawn_async(NULL, argv, NULL,
334                   G_SPAWN_SEARCH_PATH | G_SPAWN_DO_NOT_REAP_CHILD |
335                   G_SPAWN_STDERR_TO_DEV_NULL | G_SPAWN_STDOUT_TO_DEV_NULL,
336                   NULL, NULL, NULL, NULL);
337     g_strfreev(argv);
338
339     /* i'm not sure why we do this, kwin does it, but ksplash doesn't seem to
340        hear it anyways. perhaps it is for old ksplash. or new ksplash. or
341        something. oh well. */
342     e.xclient.type = ClientMessage;
343     e.xclient.display = ob_display;
344     e.xclient.window = RootWindow(ob_display, ob_screen);
345     e.xclient.message_type =
346         XInternAtom(ob_display, "_KDE_SPLASH_PROGRESS", False);
347     e.xclient.format = 8;
348     strcpy(e.xclient.data.b, "wm started");
349     XSendEvent(ob_display, RootWindow(ob_display, ob_screen),
350                False, SubstructureNotifyMask, &e );
351 }
352
353 void screen_startup(gboolean reconfig)
354 {
355     gchar **names = NULL;
356     guint32 d;
357     gboolean namesexist = FALSE;
358
359     desktop_popup = pager_popup_new();
360     pager_popup_height(desktop_popup, POPUP_HEIGHT);
361
362     if (reconfig) {
363         /* update the pager popup's width */
364         pager_popup_text_width_to_strings(desktop_popup,
365                                           screen_desktop_names,
366                                           screen_num_desktops);
367         return;
368     }
369
370     /* get the initial size */
371     screen_resize();
372
373     /* have names already been set for the desktops? */
374     if (PROP_GETSS(RootWindow(ob_display, ob_screen),
375                    net_desktop_names, utf8, &names))
376     {
377         g_strfreev(names);
378         namesexist = TRUE;
379     }
380
381     /* if names don't exist and we have session names, set those.
382        do this stuff BEFORE setting the number of desktops, because that
383        will create default names for them
384     */
385     if (!namesexist && session_desktop_names != NULL) {
386         guint i, numnames;
387         GSList *it;
388
389         /* get the desktop names */
390         numnames = g_slist_length(session_desktop_names);
391         names = g_new(gchar*, numnames + 1);
392         names[numnames] = NULL;
393         for (i = 0, it = session_desktop_names; it; ++i, it = g_slist_next(it))
394             names[i] = g_strdup(it->data);
395
396         /* set the root window property */
397         PROP_SETSS(RootWindow(ob_display, ob_screen), net_desktop_names,names);
398
399         g_strfreev(names);
400     }
401
402     /* set the number of desktops, if it's not already set.
403
404        this will also set the default names from the config file up for
405        desktops that don't have names yet */
406     screen_num_desktops = 0;
407     if (PROP_GET32(RootWindow(ob_display, ob_screen),
408                    net_number_of_desktops, cardinal, &d))
409     {
410         if (d != config_desktops_num) {
411             /* TRANSLATORS: If you need to specify a different order of the
412                arguments, you can use %1$d for the first one and %2$d for the
413                second one. For example,
414                "The current session has %2$d desktops, but Openbox is configured for %1$d ..." */
415             g_warning(ngettext("Openbox is configured for %d desktop, but the current session has %d.  Overriding the Openbox configuration.", "Openbox is configured for %d desktops, but the current session has %d.  Overriding the Openbox configuration.", config_desktops_num),
416                       config_desktops_num, d);
417         }
418         screen_set_num_desktops(d);
419     }
420     /* restore from session if possible */
421     else if (session_num_desktops)
422         screen_set_num_desktops(session_num_desktops);
423     else
424         screen_set_num_desktops(config_desktops_num);
425
426     screen_desktop = screen_num_desktops;  /* something invalid */
427     /* start on the current desktop when a wm was already running */
428     if (PROP_GET32(RootWindow(ob_display, ob_screen),
429                    net_current_desktop, cardinal, &d) &&
430         d < screen_num_desktops)
431     {
432         screen_set_desktop(d, FALSE);
433     } else if (session_desktop >= 0)
434         screen_set_desktop(MIN((guint)session_desktop,
435                                screen_num_desktops), FALSE);
436     else
437         screen_set_desktop(MIN(config_screen_firstdesk,
438                                screen_num_desktops) - 1, FALSE);
439     screen_last_desktop = screen_desktop;
440
441     /* don't start in showing-desktop mode */
442     screen_showing_desktop = FALSE;
443     PROP_SET32(RootWindow(ob_display, ob_screen),
444                net_showing_desktop, cardinal, screen_showing_desktop);
445
446     if (session_desktop_layout_present &&
447         screen_validate_layout(&session_desktop_layout))
448     {
449         screen_desktop_layout = session_desktop_layout;
450     }
451     else
452         screen_update_layout();
453 }
454
455 void screen_shutdown(gboolean reconfig)
456 {
457     pager_popup_free(desktop_popup);
458
459     if (reconfig)
460         return;
461
462     XSelectInput(ob_display, RootWindow(ob_display, ob_screen),
463                  NoEventMask);
464
465     /* we're not running here no more! */
466     PROP_ERASE(RootWindow(ob_display, ob_screen), openbox_pid);
467     /* not without us */
468     PROP_ERASE(RootWindow(ob_display, ob_screen), net_supported);
469     /* don't keep this mode */
470     PROP_ERASE(RootWindow(ob_display, ob_screen), net_showing_desktop);
471
472     XDestroyWindow(ob_display, screen_support_win);
473
474     g_strfreev(screen_desktop_names);
475     screen_desktop_names = NULL;
476 }
477
478 void screen_resize(void)
479 {
480     static gint oldw = 0, oldh = 0;
481     gint w, h;
482     GList *it;
483     gulong geometry[2];
484
485     w = WidthOfScreen(ScreenOfDisplay(ob_display, ob_screen));
486     h = HeightOfScreen(ScreenOfDisplay(ob_display, ob_screen));
487
488     if (w == oldw && h == oldh) return;
489
490     oldw = w; oldh = h;
491
492     /* Set the _NET_DESKTOP_GEOMETRY hint */
493     screen_physical_size.width = geometry[0] = w;
494     screen_physical_size.height = geometry[1] = h;
495     PROP_SETA32(RootWindow(ob_display, ob_screen),
496                 net_desktop_geometry, cardinal, geometry, 2);
497
498     if (ob_state() != OB_STATE_RUNNING)
499         return;
500
501     screen_update_areas();
502     dock_configure();
503
504     for (it = client_list; it; it = g_list_next(it))
505         client_move_onscreen(it->data, FALSE);
506 }
507
508 void screen_set_num_desktops(guint num)
509 {
510     guint old;
511     gulong *viewport;
512     GList *it, *stacking_copy;
513
514     g_assert(num > 0);
515
516     if (screen_num_desktops == num) return;
517
518     old = screen_num_desktops;
519     screen_num_desktops = num;
520     PROP_SET32(RootWindow(ob_display, ob_screen),
521                net_number_of_desktops, cardinal, num);
522
523     /* set the viewport hint */
524     viewport = g_new0(gulong, num * 2);
525     PROP_SETA32(RootWindow(ob_display, ob_screen),
526                 net_desktop_viewport, cardinal, viewport, num * 2);
527     g_free(viewport);
528
529     /* the number of rows/columns will differ */
530     screen_update_layout();
531
532     /* move windows on desktops that will no longer exist!
533        make a copy of the list cuz we're changing it */
534     stacking_copy = g_list_copy(stacking_list);
535     for (it = g_list_last(stacking_copy); it; it = g_list_previous(it)) {
536         if (WINDOW_IS_CLIENT(it->data)) {
537             ObClient *c = it->data;
538             if (c->desktop != DESKTOP_ALL && c->desktop >= num)
539                 client_set_desktop(c, num - 1, FALSE, TRUE);
540             /* raise all the windows that are on the current desktop which
541                is being merged */
542             else if (screen_desktop == num - 1 &&
543                      (c->desktop == DESKTOP_ALL ||
544                       c->desktop == screen_desktop))
545                 stacking_raise(CLIENT_AS_WINDOW(c));
546         }
547     }
548     g_list_free(stacking_copy);
549
550     /* change our struts/area to match (after moving windows) */
551     screen_update_areas();
552
553     /* may be some unnamed desktops that we need to fill in with names
554        (after updating the areas so the popup can resize) */
555     screen_update_desktop_names();
556
557     /* change our desktop if we're on one that no longer exists! */
558     if (screen_desktop >= screen_num_desktops)
559         screen_set_desktop(num - 1, TRUE);
560 }
561
562 static void screen_fallback_focus(void)
563 {
564     ObClient *c;
565     gboolean allow_omni;
566
567     /* only allow omnipresent windows to get focus on desktop change if
568        an omnipresent window is already focused (it'll keep focus probably, but
569        maybe not depending on mouse-focus options) */
570     allow_omni = focus_client && (client_normal(focus_client) &&
571                                   focus_client->desktop == DESKTOP_ALL);
572
573     /* the client moved there already so don't move focus. prevent flicker
574        on sendtodesktop + follow */
575     if (focus_client && focus_client->desktop == screen_desktop)
576         return;
577
578     /* have to try focus here because when you leave an empty desktop
579        there is no focus out to watch for. also, we have different rules
580        here. we always allow it to look under the mouse pointer if
581        config_focus_last is FALSE
582
583        do this before hiding the windows so if helper windows are coming
584        with us, they don't get hidden
585     */
586     if ((c = focus_fallback(TRUE, !config_focus_last, allow_omni,
587                             !allow_omni)))
588     {
589         /* only do the flicker reducing stuff ahead of time if we are going
590            to call xsetinputfocus on the window ourselves. otherwise there is
591            no guarantee the window will actually take focus.. */
592         if (c->can_focus) {
593             /* reduce flicker by hiliting now rather than waiting for the
594                server FocusIn event */
595             frame_adjust_focus(c->frame, TRUE);
596             /* do this here so that if you switch desktops to a window with
597                helper windows then the helper windows won't flash */
598             client_bring_helper_windows(c);
599         }
600     }
601 }
602
603 static gboolean last_desktop_func(gpointer data)
604 {
605     screen_desktop_timeout = TRUE;
606     return FALSE;
607 }
608
609 void screen_set_desktop(guint num, gboolean dofocus)
610 {
611     GList *it;
612     guint previous;
613     gulong ignore_start;
614
615     g_assert(num < screen_num_desktops);
616
617     previous = screen_desktop;
618     screen_desktop = num;
619
620     if (previous == num) return;
621
622     PROP_SET32(RootWindow(ob_display, ob_screen),
623                net_current_desktop, cardinal, num);
624
625     /* This whole thing decides when/how to save the screen_last_desktop so
626        that it can be restored later if you want */
627     if (screen_desktop_timeout) {
628         /* If screen_desktop_timeout is true, then we've been on this desktop
629            long enough and we can save it as the last desktop. */
630
631         if (screen_last_desktop == previous)
632             /* this is the startup state only */
633             screen_old_desktop = screen_desktop;
634         else {
635             /* save the "last desktop" as the "old desktop" */
636             screen_old_desktop = screen_last_desktop;
637             /* save the desktop we're coming from as the "last desktop" */
638             screen_last_desktop = previous;
639         }
640     }
641     else {
642         /* If screen_desktop_timeout is false, then we just got to this desktop
643            and we are moving away again. */
644
645         if (screen_desktop == screen_last_desktop) {
646             /* If we are moving to the "last desktop" .. */
647             if (previous == screen_old_desktop) {
648                 /* .. from the "old desktop", change the last desktop to
649                    be where we are coming from */
650                 screen_last_desktop = screen_old_desktop;
651             }
652             else if (screen_last_desktop == screen_old_desktop) {
653                 /* .. and also to the "old desktop", change the "last
654                    desktop" to be where we are coming from */
655                 screen_last_desktop = previous;
656             }
657             else {
658                 /* .. from some other desktop, then set the "last desktop" to
659                    be the saved "old desktop", i.e. where we were before the
660                    "last desktop" */
661                 screen_last_desktop = screen_old_desktop;
662             }
663         }
664         else {
665             /* If we are moving to any desktop besides the "last desktop"..
666                (this is the normal case) */
667             if (screen_desktop == screen_old_desktop) {
668                 /* If moving to the "old desktop", which is not the
669                    "last desktop", don't save anything */
670             }
671             else if (previous == screen_old_desktop) {
672                 /* If moving from the "old desktop", and not to the
673                    "last desktop", don't save anything */
674             }
675             else if (screen_last_desktop == screen_old_desktop) {
676                 /* If the "last desktop" is the same as "old desktop" and
677                    you're not moving to the "last desktop" then save where
678                    we're coming from as the "last desktop" */
679                 screen_last_desktop = previous;
680             }
681             else {
682                 /* If the "last desktop" is different from the "old desktop"
683                    and you're not moving to the "last desktop", then don't save
684                    anything */
685             }
686         }
687     }
688     screen_desktop_timeout = FALSE;
689     ob_main_loop_timeout_remove(ob_main_loop, last_desktop_func);
690     ob_main_loop_timeout_add(ob_main_loop, REMEMBER_LAST_DESKTOP_TIME,
691                              last_desktop_func, NULL, NULL, NULL);
692
693     ob_debug("Moving to desktop %d\n", num+1);
694
695     if (ob_state() == OB_STATE_RUNNING)
696         screen_show_desktop_popup(screen_desktop);
697
698     /* ignore enter events caused by the move */
699     ignore_start = event_start_ignore_all_enters();
700
701     if (moveresize_client)
702         client_set_desktop(moveresize_client, num, TRUE, FALSE);
703
704     /* show windows before hiding the rest to lessen the enter/leave events */
705
706     /* show windows from top to bottom */
707     for (it = stacking_list; it; it = g_list_next(it)) {
708         if (WINDOW_IS_CLIENT(it->data)) {
709             ObClient *c = it->data;
710             client_show(c);
711         }
712     }
713
714     if (dofocus) screen_fallback_focus();
715
716     /* hide windows from bottom to top */
717     for (it = g_list_last(stacking_list); it; it = g_list_previous(it)) {
718         if (WINDOW_IS_CLIENT(it->data)) {
719             ObClient *c = it->data;
720             client_hide(c);
721             if (c == focus_client) {
722                 /* c was focused and we didn't do fallback clearly so make sure
723                    openbox doesnt still consider the window focused.
724                    this happens when using NextWindow with allDesktops, since
725                    it doesnt want to move focus on desktop change, but the
726                    focus is not going to stay with the current window, which
727                    has now disappeared */
728                 focus_set_client(NULL);
729             }
730         }
731     }
732
733     event_end_ignore_all_enters(ignore_start);
734
735     if (event_curtime != CurrentTime)
736         screen_desktop_user_time = event_curtime;
737 }
738
739 void screen_add_desktop(gboolean current)
740 {
741     gulong ignore_start;
742
743     /* ignore enter events caused by this */
744     ignore_start = event_start_ignore_all_enters();
745
746     screen_set_num_desktops(screen_num_desktops+1);
747
748     /* move all the clients over */
749     if (current) {
750         GList *it;
751
752         for (it = client_list; it; it = g_list_next(it)) {
753             ObClient *c = it->data;
754             if (c->desktop != DESKTOP_ALL && c->desktop >= screen_desktop &&
755                 /* don't move direct children, they'll be moved with their
756                    parent - which will have to be on the same desktop */
757                 !client_direct_parent(c))
758             {
759                 ob_debug("moving window %s\n", c->title);
760                 client_set_desktop(c, c->desktop+1, FALSE, TRUE);
761             }
762         }
763     }
764
765     event_end_ignore_all_enters(ignore_start);
766 }
767
768 void screen_remove_desktop(gboolean current)
769 {
770     guint rmdesktop, movedesktop;
771     GList *it, *stacking_copy;
772     gulong ignore_start;
773
774     if (screen_num_desktops <= 1) return;
775
776     /* ignore enter events caused by this */
777     ignore_start = event_start_ignore_all_enters();
778
779     /* what desktop are we removing and moving to? */
780     if (current)
781         rmdesktop = screen_desktop;
782     else
783         rmdesktop = screen_num_desktops - 1;
784     if (rmdesktop < screen_num_desktops - 1)
785         movedesktop = rmdesktop + 1;
786     else
787         movedesktop = rmdesktop;
788
789     /* make a copy of the list cuz we're changing it */
790     stacking_copy = g_list_copy(stacking_list);
791     for (it = g_list_last(stacking_copy); it; it = g_list_previous(it)) {
792         if (WINDOW_IS_CLIENT(it->data)) {
793             ObClient *c = it->data;
794             guint d = c->desktop;
795             if (d != DESKTOP_ALL && d >= movedesktop &&
796                 /* don't move direct children, they'll be moved with their
797                    parent - which will have to be on the same desktop */
798                 !client_direct_parent(c))
799             {
800                 ob_debug("moving window %s\n", c->title);
801                 client_set_desktop(c, c->desktop - 1, TRUE, TRUE);
802             }
803             /* raise all the windows that are on the current desktop which
804                is being merged */
805             if ((screen_desktop == rmdesktop - 1 ||
806                  screen_desktop == rmdesktop) &&
807                 (d == DESKTOP_ALL || d == screen_desktop))
808             {
809                 stacking_raise(CLIENT_AS_WINDOW(c));
810                 ob_debug("raising window %s\n", c->title);
811             }
812         }
813     }
814     g_list_free(stacking_copy);
815
816     /* fallback focus like we're changing desktops */
817     if (screen_desktop < screen_num_desktops - 1) {
818         screen_fallback_focus();
819         ob_debug("fake desktop change\n");
820     }
821
822     screen_set_num_desktops(screen_num_desktops-1);
823
824     event_end_ignore_all_enters(ignore_start);
825 }
826
827 static void get_row_col(guint d, guint *r, guint *c)
828 {
829     switch (screen_desktop_layout.orientation) {
830     case OB_ORIENTATION_HORZ:
831         switch (screen_desktop_layout.start_corner) {
832         case OB_CORNER_TOPLEFT:
833             *r = d / screen_desktop_layout.columns;
834             *c = d % screen_desktop_layout.columns;
835             break;
836         case OB_CORNER_BOTTOMLEFT:
837             *r = screen_desktop_layout.rows - 1 -
838                 d / screen_desktop_layout.columns;
839             *c = d % screen_desktop_layout.columns;
840             break;
841         case OB_CORNER_TOPRIGHT:
842             *r = d / screen_desktop_layout.columns;
843             *c = screen_desktop_layout.columns - 1 -
844                 d % screen_desktop_layout.columns;
845             break;
846         case OB_CORNER_BOTTOMRIGHT:
847             *r = screen_desktop_layout.rows - 1 -
848                 d / screen_desktop_layout.columns;
849             *c = screen_desktop_layout.columns - 1 -
850                 d % screen_desktop_layout.columns;
851             break;
852         }
853         break;
854     case OB_ORIENTATION_VERT:
855         switch (screen_desktop_layout.start_corner) {
856         case OB_CORNER_TOPLEFT:
857             *r = d % screen_desktop_layout.rows;
858             *c = d / screen_desktop_layout.rows;
859             break;
860         case OB_CORNER_BOTTOMLEFT:
861             *r = screen_desktop_layout.rows - 1 -
862                 d % screen_desktop_layout.rows;
863             *c = d / screen_desktop_layout.rows;
864             break;
865         case OB_CORNER_TOPRIGHT:
866             *r = d % screen_desktop_layout.rows;
867             *c = screen_desktop_layout.columns - 1 -
868                 d / screen_desktop_layout.rows;
869             break;
870         case OB_CORNER_BOTTOMRIGHT:
871             *r = screen_desktop_layout.rows - 1 -
872                 d % screen_desktop_layout.rows;
873             *c = screen_desktop_layout.columns - 1 -
874                 d / screen_desktop_layout.rows;
875             break;
876         }
877         break;
878     }
879 }
880
881 static guint translate_row_col(guint r, guint c)
882 {
883     switch (screen_desktop_layout.orientation) {
884     case OB_ORIENTATION_HORZ:
885         switch (screen_desktop_layout.start_corner) {
886         case OB_CORNER_TOPLEFT:
887             return r % screen_desktop_layout.rows *
888                 screen_desktop_layout.columns +
889                 c % screen_desktop_layout.columns;
890         case OB_CORNER_BOTTOMLEFT:
891             return (screen_desktop_layout.rows - 1 -
892                     r % screen_desktop_layout.rows) *
893                 screen_desktop_layout.columns +
894                 c % screen_desktop_layout.columns;
895         case OB_CORNER_TOPRIGHT:
896             return r % screen_desktop_layout.rows *
897                 screen_desktop_layout.columns +
898                 (screen_desktop_layout.columns - 1 -
899                  c % screen_desktop_layout.columns);
900         case OB_CORNER_BOTTOMRIGHT:
901             return (screen_desktop_layout.rows - 1 -
902                     r % screen_desktop_layout.rows) *
903                 screen_desktop_layout.columns +
904                 (screen_desktop_layout.columns - 1 -
905                  c % screen_desktop_layout.columns);
906         }
907     case OB_ORIENTATION_VERT:
908         switch (screen_desktop_layout.start_corner) {
909         case OB_CORNER_TOPLEFT:
910             return c % screen_desktop_layout.columns *
911                 screen_desktop_layout.rows +
912                 r % screen_desktop_layout.rows;
913         case OB_CORNER_BOTTOMLEFT:
914             return c % screen_desktop_layout.columns *
915                 screen_desktop_layout.rows +
916                 (screen_desktop_layout.rows - 1 -
917                  r % screen_desktop_layout.rows);
918         case OB_CORNER_TOPRIGHT:
919             return (screen_desktop_layout.columns - 1 -
920                     c % screen_desktop_layout.columns) *
921                 screen_desktop_layout.rows +
922                 r % screen_desktop_layout.rows;
923         case OB_CORNER_BOTTOMRIGHT:
924             return (screen_desktop_layout.columns - 1 -
925                     c % screen_desktop_layout.columns) *
926                 screen_desktop_layout.rows +
927                 (screen_desktop_layout.rows - 1 -
928                  r % screen_desktop_layout.rows);
929         }
930     }
931     g_assert_not_reached();
932     return 0;
933 }
934
935 static gboolean hide_desktop_popup_func(gpointer data)
936 {
937     pager_popup_hide(desktop_popup);
938     return FALSE; /* don't repeat */
939 }
940
941 void screen_show_desktop_popup(guint d)
942 {
943     Rect *a;
944
945     /* 0 means don't show the popup */
946     if (!config_desktop_popup_time) return;
947
948     a = screen_physical_area_primary();
949     pager_popup_position(desktop_popup, CenterGravity,
950                          a->x + a->width / 2, a->y + a->height / 2);
951     pager_popup_icon_size_multiplier(desktop_popup,
952                                      (screen_desktop_layout.columns /
953                                       screen_desktop_layout.rows) / 2,
954                                      (screen_desktop_layout.rows/
955                                       screen_desktop_layout.columns) / 2);
956     pager_popup_max_width(desktop_popup,
957                           MAX(a->width/3, POPUP_WIDTH));
958     pager_popup_show(desktop_popup, screen_desktop_names[d], d);
959
960     ob_main_loop_timeout_remove(ob_main_loop, hide_desktop_popup_func);
961     ob_main_loop_timeout_add(ob_main_loop, config_desktop_popup_time * 1000,
962                              hide_desktop_popup_func, NULL, NULL, NULL);
963     g_free(a);
964 }
965
966 void screen_hide_desktop_popup(void)
967 {
968     ob_main_loop_timeout_remove(ob_main_loop, hide_desktop_popup_func);
969     pager_popup_hide(desktop_popup);
970 }
971
972 guint screen_find_desktop(guint from, ObDirection dir,
973                           gboolean wrap, gboolean linear)
974 {
975     guint r, c;
976     guint d;
977
978     d = from;
979     get_row_col(d, &r, &c);
980     if (linear) {
981         switch (dir) {
982         case OB_DIRECTION_EAST:
983             if (d < screen_num_desktops - 1)
984                 ++d;
985             else if (wrap)
986                 d = 0;
987             else
988                 return from;
989             break;
990         case OB_DIRECTION_WEST:
991             if (d > 0)
992                 --d;
993             else if (wrap)
994                 d = screen_num_desktops - 1;
995             else
996                 return from;
997             break;
998         default:
999             g_assert_not_reached();
1000             return from;
1001         }
1002     } else {
1003         switch (dir) {
1004         case OB_DIRECTION_EAST:
1005             ++c;
1006             if (c >= screen_desktop_layout.columns) {
1007                 if (wrap)
1008                     c = 0;
1009                 else
1010                     return from;
1011             }
1012             d = translate_row_col(r, c);
1013             if (d >= screen_num_desktops) {
1014                 if (wrap)
1015                     ++c;
1016                 else
1017                     return from;
1018             }
1019             break;
1020         case OB_DIRECTION_WEST:
1021             --c;
1022             if (c >= screen_desktop_layout.columns) {
1023                 if (wrap)
1024                     c = screen_desktop_layout.columns - 1;
1025                 else
1026                     return from;
1027             }
1028             d = translate_row_col(r, c);
1029             if (d >= screen_num_desktops) {
1030                 if (wrap)
1031                     --c;
1032                 else
1033                     return from;
1034             }
1035             break;
1036         case OB_DIRECTION_SOUTH:
1037             ++r;
1038             if (r >= screen_desktop_layout.rows) {
1039                 if (wrap)
1040                     r = 0;
1041                 else
1042                     return from;
1043             }
1044             d = translate_row_col(r, c);
1045             if (d >= screen_num_desktops) {
1046                 if (wrap)
1047                     ++r;
1048                 else
1049                     return from;
1050             }
1051             break;
1052         case OB_DIRECTION_NORTH:
1053             --r;
1054             if (r >= screen_desktop_layout.rows) {
1055                 if (wrap)
1056                     r = screen_desktop_layout.rows - 1;
1057                 else
1058                     return from;
1059             }
1060             d = translate_row_col(r, c);
1061             if (d >= screen_num_desktops) {
1062                 if (wrap)
1063                     --r;
1064                 else
1065                     return from;
1066             }
1067             break;
1068         default:
1069             g_assert_not_reached();
1070             return from;
1071         }
1072
1073         d = translate_row_col(r, c);
1074     }
1075     return d;
1076 }
1077
1078 static gboolean screen_validate_layout(ObDesktopLayout *l)
1079 {
1080     if (l->columns == 0 && l->rows == 0) /* both 0's is bad data.. */
1081         return FALSE;
1082
1083     /* fill in a zero rows/columns */
1084     if (l->columns == 0) {
1085         l->columns = screen_num_desktops / l->rows;
1086         if (l->rows * l->columns < screen_num_desktops)
1087             l->columns++;
1088         if (l->rows * l->columns >= screen_num_desktops + l->columns)
1089             l->rows--;
1090     } else if (l->rows == 0) {
1091         l->rows = screen_num_desktops / l->columns;
1092         if (l->columns * l->rows < screen_num_desktops)
1093             l->rows++;
1094         if (l->columns * l->rows >= screen_num_desktops + l->rows)
1095             l->columns--;
1096     }
1097
1098     /* bounds checking */
1099     if (l->orientation == OB_ORIENTATION_HORZ) {
1100         l->columns = MIN(screen_num_desktops, l->columns);
1101         l->rows = MIN(l->rows,
1102                       (screen_num_desktops + l->columns - 1) / l->columns);
1103         l->columns = screen_num_desktops / l->rows +
1104             !!(screen_num_desktops % l->rows);
1105     } else {
1106         l->rows = MIN(screen_num_desktops, l->rows);
1107         l->columns = MIN(l->columns,
1108                          (screen_num_desktops + l->rows - 1) / l->rows);
1109         l->rows = screen_num_desktops / l->columns +
1110             !!(screen_num_desktops % l->columns);
1111     }
1112     return TRUE;
1113 }
1114
1115 void screen_update_layout(void)
1116
1117 {
1118     ObDesktopLayout l;
1119     guint32 *data;
1120     guint num;
1121
1122     screen_desktop_layout.orientation = OB_ORIENTATION_HORZ;
1123     screen_desktop_layout.start_corner = OB_CORNER_TOPLEFT;
1124     screen_desktop_layout.rows = 1;
1125     screen_desktop_layout.columns = screen_num_desktops;
1126
1127     if (PROP_GETA32(RootWindow(ob_display, ob_screen),
1128                     net_desktop_layout, cardinal, &data, &num)) {
1129         if (num == 3 || num == 4) {
1130
1131             if (data[0] == prop_atoms.net_wm_orientation_vert)
1132                 l.orientation = OB_ORIENTATION_VERT;
1133             else if (data[0] == prop_atoms.net_wm_orientation_horz)
1134                 l.orientation = OB_ORIENTATION_HORZ;
1135             else
1136                 return;
1137
1138             if (num < 4)
1139                 l.start_corner = OB_CORNER_TOPLEFT;
1140             else {
1141                 if (data[3] == prop_atoms.net_wm_topleft)
1142                     l.start_corner = OB_CORNER_TOPLEFT;
1143                 else if (data[3] == prop_atoms.net_wm_topright)
1144                     l.start_corner = OB_CORNER_TOPRIGHT;
1145                 else if (data[3] == prop_atoms.net_wm_bottomright)
1146                     l.start_corner = OB_CORNER_BOTTOMRIGHT;
1147                 else if (data[3] == prop_atoms.net_wm_bottomleft)
1148                     l.start_corner = OB_CORNER_BOTTOMLEFT;
1149                 else
1150                     return;
1151             }
1152
1153             l.columns = data[1];
1154             l.rows = data[2];
1155
1156             if (screen_validate_layout(&l))
1157                 screen_desktop_layout = l;
1158
1159             g_free(data);
1160         }
1161     }
1162 }
1163
1164 void screen_update_desktop_names(void)
1165 {
1166     guint i;
1167
1168     /* empty the array */
1169     g_strfreev(screen_desktop_names);
1170     screen_desktop_names = NULL;
1171
1172     if (PROP_GETSS(RootWindow(ob_display, ob_screen),
1173                    net_desktop_names, utf8, &screen_desktop_names))
1174         for (i = 0; screen_desktop_names[i] && i < screen_num_desktops; ++i);
1175     else
1176         i = 0;
1177     if (i < screen_num_desktops) {
1178         GSList *it;
1179
1180         screen_desktop_names = g_renew(gchar*, screen_desktop_names,
1181                                        screen_num_desktops + 1);
1182         screen_desktop_names[screen_num_desktops] = NULL;
1183
1184         it = g_slist_nth(config_desktops_names, i);
1185
1186         for (; i < screen_num_desktops; ++i) {
1187             if (it && ((char*)it->data)[0]) /* not empty */
1188                 /* use the names from the config file when possible */
1189                 screen_desktop_names[i] = g_strdup(it->data);
1190             else
1191                 /* make up a nice name if it's not though */
1192                 screen_desktop_names[i] = g_strdup_printf(_("desktop %i"),
1193                                                           i + 1);
1194             if (it) it = g_slist_next(it);
1195         }
1196
1197         /* if we changed any names, then set the root property so we can
1198            all agree on the names */
1199         PROP_SETSS(RootWindow(ob_display, ob_screen), net_desktop_names,
1200                    screen_desktop_names);
1201     }
1202
1203     /* resize the pager for these names */
1204     pager_popup_text_width_to_strings(desktop_popup,
1205                                       screen_desktop_names,
1206                                       screen_num_desktops);
1207 }
1208
1209 void screen_show_desktop(gboolean show, ObClient *show_only)
1210 {
1211     GList *it;
1212
1213     if (show == screen_showing_desktop) return; /* no change */
1214
1215     screen_showing_desktop = show;
1216
1217     if (show) {
1218         /* hide windows bottom to top */
1219         for (it = g_list_last(stacking_list); it; it = g_list_previous(it)) {
1220             if (WINDOW_IS_CLIENT(it->data)) {
1221                 ObClient *client = it->data;
1222                 client_showhide(client);
1223             }
1224         }
1225     }
1226     else {
1227         /* restore windows top to bottom */
1228         for (it = stacking_list; it; it = g_list_next(it)) {
1229             if (WINDOW_IS_CLIENT(it->data)) {
1230                 ObClient *client = it->data;
1231                 if (client_should_show(client)) {
1232                     if (!show_only || client == show_only)
1233                         client_show(client);
1234                     else
1235                         client_iconify(client, TRUE, FALSE, TRUE);
1236                 }
1237             }
1238         }
1239     }
1240
1241     if (show) {
1242         /* focus the desktop */
1243         for (it = focus_order; it; it = g_list_next(it)) {
1244             ObClient *c = it->data;
1245             if (c->type == OB_CLIENT_TYPE_DESKTOP &&
1246                 (c->desktop == screen_desktop || c->desktop == DESKTOP_ALL) &&
1247                 client_focus(it->data))
1248                 break;
1249         }
1250     }
1251     else if (!show_only) {
1252         ObClient *c;
1253
1254         if ((c = focus_fallback(TRUE, FALSE, TRUE, FALSE))) {
1255             /* only do the flicker reducing stuff ahead of time if we are going
1256                to call xsetinputfocus on the window ourselves. otherwise there
1257                is no guarantee the window will actually take focus.. */
1258             if (c->can_focus) {
1259                 /* reduce flicker by hiliting now rather than waiting for the
1260                    server FocusIn event */
1261                 frame_adjust_focus(c->frame, TRUE);
1262             }
1263         }
1264     }
1265
1266     show = !!show; /* make it boolean */
1267     PROP_SET32(RootWindow(ob_display, ob_screen),
1268                net_showing_desktop, cardinal, show);
1269 }
1270
1271 void screen_install_colormap(ObClient *client, gboolean install)
1272 {
1273     if (client == NULL || client->colormap == None) {
1274         if (install)
1275             XInstallColormap(RrDisplay(ob_rr_inst), RrColormap(ob_rr_inst));
1276         else
1277             XUninstallColormap(RrDisplay(ob_rr_inst), RrColormap(ob_rr_inst));
1278     } else {
1279         xerror_set_ignore(TRUE);
1280         if (install)
1281             XInstallColormap(RrDisplay(ob_rr_inst), client->colormap);
1282         else
1283             XUninstallColormap(RrDisplay(ob_rr_inst), client->colormap);
1284         xerror_set_ignore(FALSE);
1285     }
1286 }
1287
1288 #define STRUT_LEFT_ON_MONITOR(s, i) \
1289     (RANGES_INTERSECT(s->left_start, s->left_end - s->left_start + 1, \
1290                       monitor_area[i].y, monitor_area[i].height))
1291 #define STRUT_RIGHT_ON_MONITOR(s, i) \
1292     (RANGES_INTERSECT(s->right_start, s->right_end - s->right_start + 1, \
1293                       monitor_area[i].y, monitor_area[i].height))
1294 #define STRUT_TOP_ON_MONITOR(s, i) \
1295     (RANGES_INTERSECT(s->top_start, s->top_end - s->top_start + 1, \
1296                       monitor_area[i].x, monitor_area[i].width))
1297 #define STRUT_BOTTOM_ON_MONITOR(s, i) \
1298     (RANGES_INTERSECT(s->bottom_start, s->bottom_end - s->bottom_start + 1, \
1299                       monitor_area[i].x, monitor_area[i].width))
1300
1301 typedef struct {
1302     guint desktop;
1303     StrutPartial *strut;
1304 } ObScreenStrut;
1305
1306 #define RESET_STRUT_LIST(sl) \
1307     (g_slist_free(sl), sl = NULL)
1308
1309 #define ADD_STRUT_TO_LIST(sl, d, s) \
1310 { \
1311     ObScreenStrut *ss = g_new(ObScreenStrut, 1); \
1312     ss->desktop = d; \
1313     ss->strut = s;  \
1314     sl = g_slist_prepend(sl, ss); \
1315 }
1316
1317 #define VALIDATE_STRUTS(sl, side, max) \
1318 { \
1319     GSList *it; \
1320     for (it = sl; it; it = g_slist_next(it)) { \
1321       ObScreenStrut *ss = it->data; \
1322       ss->strut->side = MIN(max, ss->strut->side); \
1323     } \
1324 }
1325
1326 void screen_update_areas(void)
1327 {
1328     guint i, j;
1329     gulong *dims;
1330     GList *it;
1331     GSList *sit;
1332
1333     g_free(monitor_area);
1334     extensions_xinerama_screens(&monitor_area, &screen_num_monitors);
1335
1336     /* set up the user-specified margins */
1337     config_margins.top_start = RECT_LEFT(monitor_area[screen_num_monitors]);
1338     config_margins.top_end = RECT_RIGHT(monitor_area[screen_num_monitors]);
1339     config_margins.bottom_start = RECT_LEFT(monitor_area[screen_num_monitors]);
1340     config_margins.bottom_end = RECT_RIGHT(monitor_area[screen_num_monitors]);
1341     config_margins.left_start = RECT_TOP(monitor_area[screen_num_monitors]);
1342     config_margins.left_end = RECT_BOTTOM(monitor_area[screen_num_monitors]);
1343     config_margins.right_start = RECT_TOP(monitor_area[screen_num_monitors]);
1344     config_margins.right_end = RECT_BOTTOM(monitor_area[screen_num_monitors]);
1345
1346     dims = g_new(gulong, 4 * screen_num_desktops * screen_num_monitors);
1347
1348     RESET_STRUT_LIST(struts_left);
1349     RESET_STRUT_LIST(struts_top);
1350     RESET_STRUT_LIST(struts_right);
1351     RESET_STRUT_LIST(struts_bottom);
1352
1353     /* collect the struts */
1354     for (it = client_list; it; it = g_list_next(it)) {
1355         ObClient *c = it->data;
1356         if (c->strut.left)
1357             ADD_STRUT_TO_LIST(struts_left, c->desktop, &c->strut);
1358         if (c->strut.top)
1359             ADD_STRUT_TO_LIST(struts_top, c->desktop, &c->strut);
1360         if (c->strut.right)
1361             ADD_STRUT_TO_LIST(struts_right, c->desktop, &c->strut);
1362         if (c->strut.bottom)
1363             ADD_STRUT_TO_LIST(struts_bottom, c->desktop, &c->strut);
1364     }
1365     if (dock_strut.left)
1366         ADD_STRUT_TO_LIST(struts_left, DESKTOP_ALL, &dock_strut);
1367     if (dock_strut.top)
1368         ADD_STRUT_TO_LIST(struts_top, DESKTOP_ALL, &dock_strut);
1369     if (dock_strut.right)
1370         ADD_STRUT_TO_LIST(struts_right, DESKTOP_ALL, &dock_strut);
1371     if (dock_strut.bottom)
1372         ADD_STRUT_TO_LIST(struts_bottom, DESKTOP_ALL, &dock_strut);
1373
1374     if (config_margins.left)
1375         ADD_STRUT_TO_LIST(struts_left, DESKTOP_ALL, &config_margins);
1376     if (config_margins.top)
1377         ADD_STRUT_TO_LIST(struts_top, DESKTOP_ALL, &config_margins);
1378     if (config_margins.right)
1379         ADD_STRUT_TO_LIST(struts_right, DESKTOP_ALL, &config_margins);
1380     if (config_margins.bottom)
1381         ADD_STRUT_TO_LIST(struts_bottom, DESKTOP_ALL, &config_margins);
1382
1383     VALIDATE_STRUTS(struts_left, left,
1384                     monitor_area[screen_num_monitors].width / 2);
1385     VALIDATE_STRUTS(struts_right, right,
1386                     monitor_area[screen_num_monitors].width / 2);
1387     VALIDATE_STRUTS(struts_top, top,
1388                     monitor_area[screen_num_monitors].height / 2);
1389     VALIDATE_STRUTS(struts_bottom, bottom,
1390                     monitor_area[screen_num_monitors].height / 2);
1391
1392     /* set up the work areas to be full screen */
1393     for (i = 0; i < screen_num_monitors; ++i)
1394         for (j = 0; j < screen_num_desktops; ++j) {
1395             dims[(i * screen_num_desktops + j) * 4+0] = monitor_area[i].x;
1396             dims[(i * screen_num_desktops + j) * 4+1] = monitor_area[i].y;
1397             dims[(i * screen_num_desktops + j) * 4+2] = monitor_area[i].width;
1398             dims[(i * screen_num_desktops + j) * 4+3] = monitor_area[i].height;
1399         }
1400
1401     /* calculate the work areas from the struts */
1402     for (i = 0; i < screen_num_monitors; ++i)
1403         for (j = 0; j < screen_num_desktops; ++j) {
1404             gint l = 0, r = 0, t = 0, b = 0;
1405
1406             /* only add the strut to the area if it touches the monitor */
1407
1408             for (sit = struts_left; sit; sit = g_slist_next(sit)) {
1409                 ObScreenStrut *s = sit->data;
1410                 if ((s->desktop == j || s->desktop == DESKTOP_ALL) &&
1411                     STRUT_LEFT_ON_MONITOR(s->strut, i))
1412                     l = MAX(l, s->strut->left);
1413             }
1414             for (sit = struts_top; sit; sit = g_slist_next(sit)) {
1415                 ObScreenStrut *s = sit->data;
1416                 if ((s->desktop == j || s->desktop == DESKTOP_ALL) &&
1417                     STRUT_TOP_ON_MONITOR(s->strut, i))
1418                     t = MAX(t, s->strut->top);
1419             }
1420             for (sit = struts_right; sit; sit = g_slist_next(sit)) {
1421                 ObScreenStrut *s = sit->data;
1422                 if ((s->desktop == j || s->desktop == DESKTOP_ALL) &&
1423                     STRUT_RIGHT_ON_MONITOR(s->strut, i))
1424                     r = MAX(r, s->strut->right);
1425             }
1426             for (sit = struts_bottom; sit; sit = g_slist_next(sit)) {
1427                 ObScreenStrut *s = sit->data;
1428                 if ((s->desktop == j || s->desktop == DESKTOP_ALL) &&
1429                     STRUT_BOTTOM_ON_MONITOR(s->strut, i))
1430                     b = MAX(b, s->strut->bottom);
1431             }
1432
1433             /* if the monitor is not against the edge of the root window,
1434                the struts will include the distance from the root window's edge
1435                to the monitor, so add that back into the monitor's work area */
1436             if (l) l += RECT_LEFT  (monitor_area[screen_num_monitors])
1437                         - RECT_LEFT  (monitor_area[i]);
1438             if (t) t += RECT_TOP   (monitor_area[screen_num_monitors])
1439                         - RECT_TOP   (monitor_area[i]);
1440             if (r) r -= RECT_RIGHT (monitor_area[screen_num_monitors])
1441                         - RECT_RIGHT (monitor_area[i]);
1442             if (b) b -= RECT_BOTTOM(monitor_area[screen_num_monitors])
1443                         - RECT_BOTTOM(monitor_area[i]);
1444
1445             /* based on these margins, set the work area for the
1446                monitor/desktop */
1447             dims[(i * screen_num_desktops + j) * 4 + 0] += l;
1448             dims[(i * screen_num_desktops + j) * 4 + 1] += t;
1449             dims[(i * screen_num_desktops + j) * 4 + 2] -= l + r;
1450             dims[(i * screen_num_desktops + j) * 4 + 3] -= t + b;
1451         }
1452
1453     /* all the work areas are not used here, only the ones for the first
1454        monitor are */
1455     PROP_SETA32(RootWindow(ob_display, ob_screen), net_workarea, cardinal,
1456                 dims, 4 * screen_num_desktops);
1457
1458     /* the area has changed, adjust all the windows if they need it */
1459     for (it = client_list; it; it = g_list_next(it))
1460         client_reconfigure(it->data, FALSE);
1461
1462     g_free(dims);
1463 }
1464
1465 #if 0
1466 Rect* screen_area_all_monitors(guint desktop)
1467 {
1468     guint i;
1469     Rect *a;
1470
1471     a = screen_area_monitor(desktop, 0);
1472
1473     /* combine all the monitors together */
1474     for (i = 1; i < screen_num_monitors; ++i) {
1475         Rect *m = screen_area_monitor(desktop, i);
1476         gint l, r, t, b;
1477
1478         l = MIN(RECT_LEFT(*a), RECT_LEFT(*m));
1479         t = MIN(RECT_TOP(*a), RECT_TOP(*m));
1480         r = MAX(RECT_RIGHT(*a), RECT_RIGHT(*m));
1481         b = MAX(RECT_BOTTOM(*a), RECT_BOTTOM(*m));
1482
1483         RECT_SET(*a, l, t, r - l + 1, b - t + 1);
1484
1485         g_free(m);
1486     }
1487
1488     return a;
1489 }
1490 #endif
1491
1492 #define STRUT_LEFT_IN_SEARCH(s, search) \
1493     (RANGES_INTERSECT(search->y, search->height, \
1494                       s->left_start, s->left_end - s->left_start + 1))
1495 #define STRUT_RIGHT_IN_SEARCH(s, search) \
1496     (RANGES_INTERSECT(search->y, search->height, \
1497                       s->right_start, s->right_end - s->right_start + 1))
1498 #define STRUT_TOP_IN_SEARCH(s, search) \
1499     (RANGES_INTERSECT(search->x, search->width, \
1500                       s->top_start, s->top_end - s->top_start + 1))
1501 #define STRUT_BOTTOM_IN_SEARCH(s, search) \
1502     (RANGES_INTERSECT(search->x, search->width, \
1503                       s->bottom_start, s->bottom_end - s->bottom_start + 1))
1504
1505 #define STRUT_LEFT_IGNORE(s, us, search) \
1506     (head == SCREEN_AREA_ALL_MONITORS && us && \
1507      RECT_LEFT(monitor_area[i]) + s->left > RECT_LEFT(*search))
1508 #define STRUT_RIGHT_IGNORE(s, us, search) \
1509     (head == SCREEN_AREA_ALL_MONITORS && us && \
1510      RECT_RIGHT(monitor_area[i]) - s->right < RECT_RIGHT(*search))
1511 #define STRUT_TOP_IGNORE(s, us, search) \
1512     (head == SCREEN_AREA_ALL_MONITORS && us && \
1513      RECT_TOP(monitor_area[i]) + s->top > RECT_TOP(*search))
1514 #define STRUT_BOTTOM_IGNORE(s, us, search) \
1515     (head == SCREEN_AREA_ALL_MONITORS && us && \
1516      RECT_BOTTOM(monitor_area[i]) - s->bottom < RECT_BOTTOM(*search))
1517
1518 Rect* screen_area(guint desktop, guint head, Rect *search)
1519 {
1520     Rect *a;
1521     GSList *it;
1522     gint l, r, t, b, al, ar, at, ab;
1523     guint i, d;
1524     gboolean us = search != NULL; /* user provided search */
1525
1526     g_assert(desktop < screen_num_desktops || desktop == DESKTOP_ALL);
1527     g_assert(head < screen_num_monitors || head == SCREEN_AREA_ONE_MONITOR ||
1528              head == SCREEN_AREA_ALL_MONITORS);
1529     g_assert(!(head == SCREEN_AREA_ONE_MONITOR && search == NULL));
1530
1531     /* find any struts for this monitor
1532        which will be affecting the search area.
1533     */
1534
1535     /* search everything if search is null */
1536     if (!search) {
1537         if (head < screen_num_monitors) search = &monitor_area[head];
1538         else search = &monitor_area[screen_num_monitors];
1539     }
1540     if (head == SCREEN_AREA_ONE_MONITOR) head = screen_find_monitor(search);
1541
1542     /* al is "all left" meaning the furthest left you can get, l is our
1543        "working left" meaning our current strut edge which we're calculating
1544     */
1545
1546     /* only include monitors which the search area lines up with */
1547     if (RECT_INTERSECTS_RECT(monitor_area[screen_num_monitors], *search)) {
1548         al = l = RECT_RIGHT(monitor_area[screen_num_monitors]);
1549         at = t = RECT_BOTTOM(monitor_area[screen_num_monitors]);
1550         ar = r = RECT_LEFT(monitor_area[screen_num_monitors]);
1551         ab = b = RECT_TOP(monitor_area[screen_num_monitors]);
1552         for (i = 0; i < screen_num_monitors; ++i) {
1553             /* add the monitor if applicable */
1554             if (RANGES_INTERSECT(search->x, search->width,
1555                                  monitor_area[i].x, monitor_area[i].width))
1556             {
1557                 at = t = MIN(t, RECT_TOP(monitor_area[i]));
1558                 ab = b = MAX(b, RECT_BOTTOM(monitor_area[i]));
1559             }
1560             if (RANGES_INTERSECT(search->y, search->height,
1561                                  monitor_area[i].y, monitor_area[i].height))
1562             {
1563                 al = l = MIN(l, RECT_LEFT(monitor_area[i]));
1564                 ar = r = MAX(r, RECT_RIGHT(monitor_area[i]));
1565             }
1566         }
1567     } else {
1568         al = l = RECT_LEFT(monitor_area[screen_num_monitors]);
1569         at = t = RECT_TOP(monitor_area[screen_num_monitors]);
1570         ar = r = RECT_RIGHT(monitor_area[screen_num_monitors]);
1571         ab = b = RECT_BOTTOM(monitor_area[screen_num_monitors]);
1572     }
1573
1574     for (d = 0; d < screen_num_desktops; ++d) {
1575         if (d != desktop && desktop != DESKTOP_ALL) continue;
1576
1577         for (i = 0; i < screen_num_monitors; ++i) {
1578             if (head != SCREEN_AREA_ALL_MONITORS && head != i) continue;
1579
1580             for (it = struts_left; it; it = g_slist_next(it)) {
1581                 ObScreenStrut *s = it->data;
1582                 if ((s->desktop == d || s->desktop == DESKTOP_ALL) &&
1583                     STRUT_LEFT_IN_SEARCH(s->strut, search) &&
1584                     !STRUT_LEFT_IGNORE(s->strut, us, search))
1585                     l = MAX(l, RECT_LEFT(monitor_area[screen_num_monitors])
1586                                + s->strut->left);
1587             }
1588             for (it = struts_top; it; it = g_slist_next(it)) {
1589                 ObScreenStrut *s = it->data;
1590                 if ((s->desktop == d || s->desktop == DESKTOP_ALL) &&
1591                     STRUT_TOP_IN_SEARCH(s->strut, search) &&
1592                     !STRUT_TOP_IGNORE(s->strut, us, search))
1593                     t = MAX(t, RECT_TOP(monitor_area[screen_num_monitors])
1594                                + s->strut->top);
1595             }
1596             for (it = struts_right; it; it = g_slist_next(it)) {
1597                 ObScreenStrut *s = it->data;
1598                 if ((s->desktop == d || s->desktop == DESKTOP_ALL) &&
1599                     STRUT_RIGHT_IN_SEARCH(s->strut, search) &&
1600                     !STRUT_RIGHT_IGNORE(s->strut, us, search))
1601                     r = MIN(r, RECT_RIGHT(monitor_area[screen_num_monitors])
1602                                - s->strut->right);
1603             }
1604             for (it = struts_bottom; it; it = g_slist_next(it)) {
1605                 ObScreenStrut *s = it->data;
1606                 if ((s->desktop == d || s->desktop == DESKTOP_ALL) &&
1607                     STRUT_BOTTOM_IN_SEARCH(s->strut, search) &&
1608                     !STRUT_BOTTOM_IGNORE(s->strut, us, search))
1609                     b = MIN(b, RECT_BOTTOM(monitor_area[screen_num_monitors])
1610                                - s->strut->bottom);
1611             }
1612
1613             /* limit to this monitor */
1614             if (head == i) {
1615                 l = MAX(l, RECT_LEFT(monitor_area[i]));
1616                 t = MAX(t, RECT_TOP(monitor_area[i]));
1617                 r = MIN(r, RECT_RIGHT(monitor_area[i]));
1618                 b = MIN(b, RECT_BOTTOM(monitor_area[i]));
1619             }
1620         }
1621     }
1622
1623     a = g_new(Rect, 1);
1624     a->x = l;
1625     a->y = t;
1626     a->width = r - l + 1;
1627     a->height = b - t + 1;
1628     return a;
1629 }
1630
1631 guint screen_find_monitor(Rect *search)
1632 {
1633     guint i;
1634     guint most = screen_num_monitors;
1635     guint mostv = 0;
1636
1637     for (i = 0; i < screen_num_monitors; ++i) {
1638         Rect *area = screen_physical_area_monitor(i);
1639         if (RECT_INTERSECTS_RECT(*area, *search)) {
1640             Rect r;
1641             guint v;
1642
1643             RECT_SET_INTERSECTION(r, *area, *search);
1644             v = r.width * r.height;
1645
1646             if (v > mostv) {
1647                 mostv = v;
1648                 most = i;
1649             }
1650         }
1651         g_free(area);
1652     }
1653     return most;
1654 }
1655
1656 Rect* screen_physical_area_all_monitors(void)
1657 {
1658     return screen_physical_area_monitor(screen_num_monitors);
1659 }
1660
1661 Rect* screen_physical_area_monitor(guint head)
1662 {
1663     Rect *a;
1664     g_assert(head <= screen_num_monitors);
1665
1666     a = g_new(Rect, 1);
1667     *a = monitor_area[head];
1668     return a;
1669 }
1670
1671 gboolean screen_physical_area_monitor_contains(guint head, Rect *search)
1672 {
1673     g_assert(head <= screen_num_monitors);
1674     g_assert(search);
1675     return RECT_INTERSECTS_RECT(monitor_area[head], *search);
1676 }
1677
1678 guint screen_monitor_active(void)
1679 {
1680     if (moveresize_client)
1681         return client_monitor(moveresize_client);
1682     else if (focus_client)
1683         return client_monitor(focus_client);
1684     else
1685         return screen_monitor_pointer();
1686 }
1687
1688 Rect* screen_physical_area_active(void)
1689 {
1690     return screen_physical_area_monitor(screen_monitor_active());
1691 }
1692
1693 guint screen_monitor_primary(void)
1694 {
1695     if (config_primary_monitor_index > 0) {
1696         if (config_primary_monitor_index-1 < screen_num_monitors)
1697             return config_primary_monitor_index - 1;
1698         else
1699             return 0;
1700     }
1701     else if (config_primary_monitor == OB_PLACE_MONITOR_ACTIVE)
1702         return screen_monitor_active();
1703     else /* config_primary_monitor == OB_PLACE_MONITOR_MOUSE */
1704         return screen_monitor_pointer();
1705 }
1706
1707 Rect *screen_physical_area_primary(void)
1708 {
1709     return screen_physical_area_monitor(screen_monitor_primary());
1710 }
1711
1712 void screen_set_root_cursor(void)
1713 {
1714     if (sn_app_starting())
1715         XDefineCursor(ob_display, RootWindow(ob_display, ob_screen),
1716                       ob_cursor(OB_CURSOR_BUSYPOINTER));
1717     else
1718         XDefineCursor(ob_display, RootWindow(ob_display, ob_screen),
1719                       ob_cursor(OB_CURSOR_POINTER));
1720 }
1721
1722 guint screen_monitor_pointer()
1723 {
1724     Rect mon;
1725     gint x, y;
1726     if (screen_pointer_pos(&x, &y))
1727         RECT_SET(mon, x, y, 1, 1);
1728     else
1729         RECT_SET(mon, 0, 0, 1, 1);
1730     return screen_find_monitor(&mon);
1731 }
1732
1733 gboolean screen_pointer_pos(gint *x, gint *y)
1734 {
1735     Window w;
1736     gint i;
1737     guint u;
1738     gboolean ret;
1739
1740     ret = !!XQueryPointer(ob_display, RootWindow(ob_display, ob_screen),
1741                           &w, &w, x, y, &i, &i, &u);
1742     if (!ret) {
1743         for (i = 0; i < ScreenCount(ob_display); ++i)
1744             if (i != ob_screen)
1745                 if (XQueryPointer(ob_display, RootWindow(ob_display, i),
1746                                   &w, &w, x, y, &i, &i, &u))
1747                     break;
1748     }
1749     return ret;
1750 }