GTK4: Reduce the use of gtk_widget_destroy()
[geeqie.git] / src / fullscreen.cc
1 /*
2  * Copyright (C) 2004 John Ellis
3  * Copyright (C) 2008 - 2016 The Geeqie Team
4  *
5  * Author: John Ellis
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  * You should have received a copy of the GNU General Public License along
18  * with this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20  */
21
22 #include "main.h"
23 #include "fullscreen.h"
24
25 #include "image.h"
26 #include "misc.h"
27 #include "ui-fileops.h"
28 #include "ui-misc.h"
29 #include "window.h"
30 #include "image-load.h"
31
32 enum {
33         FULLSCREEN_CURSOR_HIDDEN = 1 << 0,
34         FULLSCREEN_CURSOR_NORMAL = 1 << 1,
35         FULLSCREEN_CURSOR_BUSY   = 1 << 2
36 };
37
38
39 /*
40  *----------------------------------------------------------------------------
41  * full screen functions
42  *----------------------------------------------------------------------------
43  */
44
45 static void clear_mouse_cursor(GtkWidget *widget, gint state)
46 {
47         GdkWindow *window = gtk_widget_get_window(widget);
48         GdkDisplay *display;
49
50         if (!window) return;
51
52         display = gdk_display_get_default();
53
54         if (state & FULLSCREEN_CURSOR_BUSY)
55                 {
56                 GdkCursor *cursor;
57
58                 cursor = gdk_cursor_new_for_display(display, GDK_WATCH);
59                 gdk_window_set_cursor(window, cursor);
60                 g_object_unref(G_OBJECT(cursor));
61                 }
62         else if (state & FULLSCREEN_CURSOR_NORMAL)
63                 {
64                 gdk_window_set_cursor(window, nullptr);
65                 }
66         else
67                 {
68                 GdkCursor *cursor;
69
70                 cursor = gdk_cursor_new_for_display(display, GDK_BLANK_CURSOR);
71                 gdk_window_set_cursor(window, cursor);
72                 g_object_unref(G_OBJECT(cursor));
73                 }
74 }
75
76 static gboolean fullscreen_hide_mouse_cb(gpointer data)
77 {
78         auto fs = static_cast<FullScreenData *>(data);
79
80         if (!fs->hide_mouse_id) return FALSE;
81
82         fs->cursor_state &= ~FULLSCREEN_CURSOR_NORMAL;
83         if (!(fs->cursor_state & FULLSCREEN_CURSOR_BUSY)) clear_mouse_cursor(fs->window, fs->cursor_state);
84
85         g_source_remove(fs->hide_mouse_id);
86         fs->hide_mouse_id = 0;
87         return FALSE;
88 }
89
90 static void fullscreen_hide_mouse_disable(FullScreenData *fs)
91 {
92         if (fs->hide_mouse_id)
93                 {
94                 g_source_remove(fs->hide_mouse_id);
95                 fs->hide_mouse_id = 0;
96                 }
97 }
98
99 static void fullscreen_hide_mouse_reset(FullScreenData *fs)
100 {
101         fullscreen_hide_mouse_disable(fs);
102         fs->hide_mouse_id = g_timeout_add(FULL_SCREEN_HIDE_MOUSE_DELAY, fullscreen_hide_mouse_cb, fs);
103 }
104
105 static gboolean fullscreen_mouse_moved(GtkWidget *, GdkEventMotion *, gpointer data)
106 {
107         auto fs = static_cast<FullScreenData *>(data);
108
109         if (!(fs->cursor_state & FULLSCREEN_CURSOR_NORMAL))
110                 {
111                 fs->cursor_state |= FULLSCREEN_CURSOR_NORMAL;
112                 if (!(fs->cursor_state & FULLSCREEN_CURSOR_BUSY)) clear_mouse_cursor(fs->window, fs->cursor_state);
113                 }
114         fullscreen_hide_mouse_reset(fs);
115
116         return FALSE;
117 }
118
119 static void fullscreen_busy_mouse_disable(FullScreenData *fs)
120 {
121         if (fs->busy_mouse_id)
122                 {
123                 g_source_remove(fs->busy_mouse_id);
124                 fs->busy_mouse_id = 0;
125                 }
126 }
127
128 static void fullscreen_mouse_set_busy(FullScreenData *fs, gboolean busy)
129 {
130         fullscreen_busy_mouse_disable(fs);
131
132         if (!!(fs->cursor_state & FULLSCREEN_CURSOR_BUSY) == (busy)) return;
133
134         if (busy)
135                 {
136                 fs->cursor_state |= FULLSCREEN_CURSOR_BUSY;
137                 }
138         else
139                 {
140                 fs->cursor_state &= ~FULLSCREEN_CURSOR_BUSY;
141                 }
142
143         clear_mouse_cursor(fs->window, fs->cursor_state);
144 }
145
146 static gboolean fullscreen_mouse_set_busy_cb(gpointer data)
147 {
148         auto fs = static_cast<FullScreenData *>(data);
149
150         fs->busy_mouse_id = 0;
151         fullscreen_mouse_set_busy(fs, TRUE);
152         return FALSE;
153 }
154
155 static void fullscreen_mouse_set_busy_idle(FullScreenData *fs)
156 {
157         if (!fs->busy_mouse_id)
158                 {
159                 fs->busy_mouse_id = g_timeout_add(FULL_SCREEN_BUSY_MOUSE_DELAY,
160                                                   fullscreen_mouse_set_busy_cb, fs);
161                 }
162 }
163
164 static void fullscreen_image_update_cb(ImageWindow *, gpointer data)
165 {
166         auto fs = static_cast<FullScreenData *>(data);
167
168         if (fs->imd->il &&
169             image_loader_get_pixbuf(fs->imd->il) != image_get_pixbuf(fs->imd))
170                 {
171                 fullscreen_mouse_set_busy_idle(fs);
172                 }
173 }
174
175 static void fullscreen_image_complete_cb(ImageWindow *, gboolean preload, gpointer data)
176 {
177         auto fs = static_cast<FullScreenData *>(data);
178
179         if (!preload) fullscreen_mouse_set_busy(fs, FALSE);
180 }
181
182 #define XSCREENSAVER_BINARY     "xscreensaver-command"
183 #define XSCREENSAVER_COMMAND    "xscreensaver-command -deactivate >&- 2>&- &"
184
185 static void fullscreen_saver_deactivate()
186 {
187         static gboolean checked = FALSE;
188         static gboolean found = FALSE;
189
190         if (!checked)
191                 {
192                 checked = TRUE;
193                 found = file_in_path(XSCREENSAVER_BINARY);
194                 }
195
196         if (found)
197                 {
198                 runcmd(XSCREENSAVER_COMMAND);
199                 }
200 }
201
202 static gboolean fullscreen_saver_block_cb(gpointer)
203 {
204         if (options->fullscreen.disable_saver)
205                 {
206                 fullscreen_saver_deactivate();
207                 }
208
209         return TRUE;
210 }
211
212 static gboolean fullscreen_delete_cb(GtkWidget *, GdkEventAny *, gpointer data)
213 {
214         auto fs = static_cast<FullScreenData *>(data);
215
216         fullscreen_stop(fs);
217         return TRUE;
218 }
219
220 FullScreenData *fullscreen_start(GtkWidget *window, ImageWindow *imd,
221                                  void (*stop_func)(FullScreenData *, gpointer), gpointer stop_data)
222 {
223         FullScreenData *fs;
224         GdkScreen *screen;
225         gint x, y;
226         gint w, h;
227         GdkGeometry geometry;
228
229         if (!window || !imd) return nullptr;
230
231         fs = g_new0(FullScreenData, 1);
232
233         fs->cursor_state = FULLSCREEN_CURSOR_HIDDEN;
234
235         fs->normal_window = window;
236         fs->normal_imd = imd;
237
238         fs->stop_func = stop_func;
239         fs->stop_data = stop_data;
240
241         DEBUG_1("full screen requests screen %d", options->fullscreen.screen);
242         fullscreen_prefs_get_geometry(options->fullscreen.screen, window, &x, &y, &w, &h,
243                                       &screen, &fs->same_region);
244
245         fs->window = window_new(GTK_WINDOW_TOPLEVEL, "fullscreen", nullptr, nullptr, _("Full screen"));
246         DEBUG_NAME(fs->window);
247
248         g_signal_connect(G_OBJECT(fs->window), "delete_event",
249                          G_CALLBACK(fullscreen_delete_cb), fs);
250
251         /* few cosmetic details */
252         gtk_window_set_decorated(GTK_WINDOW(fs->window), FALSE);
253         gtk_container_set_border_width(GTK_CONTAINER(fs->window), 0);
254
255         /* keep window above others, if requested */
256         if (options->fullscreen.above) {
257                 gq_gtk_window_set_keep_above(GTK_WINDOW(fs->window), TRUE);
258         }
259
260         /* set default size and position, so the window appears where it was before */
261         gtk_window_set_default_size(GTK_WINDOW(fs->window), w, h);
262         gtk_window_move(GTK_WINDOW(fs->window), x, y);
263
264         /* By setting USER_POS and USER_SIZE, most window managers will
265          * not request positioning of the full screen window (for example twm).
266          *
267          * In addition, setting gravity to STATIC will result in the
268          * decorations of twm to not effect the requested window position,
269          * the decorations will simply be off screen, except in multi monitor setups :-/
270          */
271         geometry.min_width = 1;
272         geometry.min_height = 1;
273         geometry.base_width = w;
274         geometry.base_height = h;
275         geometry.win_gravity = GDK_GRAVITY_STATIC;
276         gtk_window_set_geometry_hints(GTK_WINDOW(fs->window), fs->window, &geometry,
277                         static_cast<GdkWindowHints>(GDK_HINT_WIN_GRAVITY | GDK_HINT_USER_POS | GDK_HINT_USER_SIZE));
278
279         gtk_widget_realize(fs->window);
280
281         if ((options->fullscreen.screen % 100) == 0)
282                 {
283                 GdkWindow *gdkwin;
284                 gdkwin = gtk_widget_get_window(fs->window);
285                 if (gdkwin != nullptr)
286                         gdk_window_set_fullscreen_mode(gdkwin, GDK_FULLSCREEN_ON_ALL_MONITORS);
287                 }
288
289         /* make window fullscreen -- let Gtk do it's job, don't screw it in any way */
290         gtk_window_fullscreen(GTK_WINDOW(fs->window));
291
292         /* move it to requested screen */
293         if (options->fullscreen.screen >= 0)
294                 {
295                 gtk_window_set_screen(GTK_WINDOW(fs->window), screen);
296                 }
297
298         fs->imd = image_new(FALSE);
299
300         gtk_container_add(GTK_CONTAINER(fs->window), fs->imd->widget);
301
302         image_background_set_color_from_options(fs->imd, TRUE);
303         image_set_delay_flip(fs->imd, options->fullscreen.clean_flip);
304         image_auto_refresh_enable(fs->imd, fs->normal_imd->auto_refresh);
305
306         if (options->fullscreen.clean_flip)
307                 {
308                 image_set_update_func(fs->imd, fullscreen_image_update_cb, fs);
309                 image_set_complete_func(fs->imd, fullscreen_image_complete_cb, fs);
310                 }
311
312         gtk_widget_show(fs->imd->widget);
313
314         if (fs->same_region)
315                 {
316                 DEBUG_2("Original window is not visible, enabling std. fullscreen mode");
317                 image_move_from_image(fs->imd, fs->normal_imd);
318                 }
319         else
320                 {
321                 DEBUG_2("Original window is still visible, enabling presentation fullscreen mode");
322                 image_copy_from_image(fs->imd, fs->normal_imd);
323                 }
324
325         if (options->stereo.enable_fsmode) {
326                 image_stereo_set(fs->imd, options->stereo.fsmode);
327         }
328
329         gtk_widget_show(fs->window);
330
331         /* for hiding the mouse */
332         g_signal_connect(G_OBJECT(fs->imd->pr), "motion_notify_event",
333                            G_CALLBACK(fullscreen_mouse_moved), fs);
334         clear_mouse_cursor(fs->window, fs->cursor_state);
335
336         /* set timer to block screen saver */
337         fs->saver_block_id = g_timeout_add(60 * 1000, fullscreen_saver_block_cb, fs);
338
339         /* hide normal window */
340          /** @FIXME properly restore this window on show
341          */
342         if (fs->same_region)
343                 {
344                 if (options->hide_window_in_fullscreen)
345                         {
346                         gtk_widget_hide(fs->normal_window);
347                         }
348                 image_change_fd(fs->normal_imd, nullptr, image_zoom_get(fs->normal_imd));
349                 }
350
351         return fs;
352 }
353
354 void fullscreen_stop(FullScreenData *fs)
355 {
356         if (!fs) return;
357
358         if (fs->saver_block_id) g_source_remove(fs->saver_block_id);
359
360         fullscreen_hide_mouse_disable(fs);
361         fullscreen_busy_mouse_disable(fs);
362         gdk_keyboard_ungrab(GDK_CURRENT_TIME);
363
364         if (fs->same_region)
365                 {
366                 image_move_from_image(fs->normal_imd, fs->imd);
367                 if (options->hide_window_in_fullscreen)
368                         {
369                         gtk_widget_show(fs->normal_window);
370                         }
371                 if (options->stereo.enable_fsmode)
372                         {
373                         image_stereo_set(fs->normal_imd, options->stereo.mode);
374                         }
375                 }
376
377
378         if (fs->stop_func) fs->stop_func(fs, fs->stop_data);
379
380         gq_gtk_widget_destroy(fs->window);
381
382         gtk_window_present(GTK_WINDOW(fs->normal_window));
383
384         g_free(fs);
385 }
386
387
388 /*
389  *----------------------------------------------------------------------------
390  * full screen preferences and utils
391  *----------------------------------------------------------------------------
392  */
393
394 GList *fullscreen_prefs_list()
395 {
396         GList *list = nullptr;
397         GdkDisplay *display;
398         GdkScreen *screen;
399         gint monitors;
400         gint j;
401
402         display = gdk_display_get_default();
403         screen = gdk_display_get_default_screen(display);
404         monitors = gdk_display_get_n_monitors(display);
405
406         for (j = -1; j < monitors; j++)
407                 {
408                 ScreenData *sd;
409                 GdkRectangle rect;
410                 gchar *name;
411                 gchar *subname;
412
413                 name = gdk_screen_make_display_name(screen);
414
415                 if (j < 0)
416                         {
417                         rect.x = 0;
418                         rect.y = 0;
419                         rect.width = gdk_screen_get_width(screen);
420                         rect.height = gdk_screen_get_height(screen);
421                         subname = g_strdup(_("Full size"));
422                         }
423                 else
424                         {
425                         auto monitor = gdk_display_get_monitor(display, j);
426                         gdk_monitor_get_geometry(monitor, &rect);
427                         subname = g_strdup(gdk_monitor_get_model(monitor));
428                         if (subname == nullptr)
429                                 {
430                                 subname = g_strdup_printf("%s %d", _("Monitor"), j + 1);
431                                 }
432                         }
433
434                 sd = g_new0(ScreenData, 1);
435                 sd->number = 100 + j + 1;
436                 sd->description = g_strdup_printf("%s %s, %s", _("Screen"), name, subname);
437                 sd->x = rect.x;
438                 sd->y = rect.y;
439                 sd->width = rect.width;
440                 sd->height = rect.height;
441
442                 DEBUG_1("Screen %d %30s %4d,%4d (%4dx%4d)",
443                                 sd->number, sd->description, sd->x, sd->y, sd->width, sd->height);
444
445                 list = g_list_append(list, sd);
446
447                 g_free(name);
448                 g_free(subname);
449                 }
450
451         return list;
452 }
453
454 void screen_data_free(ScreenData *sd)
455 {
456         if (!sd) return;
457
458         g_free(sd->description);
459         g_free(sd);
460 }
461
462 ScreenData *fullscreen_prefs_list_find(GList *list, gint screen)
463 {
464         GList *work;
465
466         work = list;
467         while (work)
468                 {
469                 auto sd = static_cast<ScreenData *>(work->data);
470                 work = work->next;
471
472                 if (sd->number == screen) return sd;
473                 }
474
475         return nullptr;
476 }
477
478 /* screen is interpreted as such:
479  *  -1  window manager determines size and position, fallback is (1) active monitor
480  *   0  full size of screen containing widget
481  *   1  size of monitor containing widget
482  * 100  full size of screen 1 (screen, monitor counts start at 1)
483  * 101  size of monitor 1 on screen 1
484  * 203  size of monitor 3 on screen 2
485  * returns:
486  * dest_screen: screen to place widget [use gtk_window_set_screen()]
487  * same_region: the returned region will overlap the current location of widget.
488  */
489 void fullscreen_prefs_get_geometry(gint screen, GtkWidget *widget, gint *x, gint *y, gint *width, gint *height,
490                                    GdkScreen **dest_screen, gboolean *same_region)
491 {
492         GList *list;
493         ScreenData *sd;
494
495         list = fullscreen_prefs_list();
496         if (screen >= 100)
497                 {
498                 sd = fullscreen_prefs_list_find(list, screen);
499                 }
500         else
501                 {
502                 sd = nullptr;
503                 if (screen < 0) screen = 1;
504                 }
505
506         if (sd)
507                 {
508                 GdkDisplay *display;
509                 GdkScreen *screen;
510
511                 display = gdk_display_get_default();
512                 screen = gdk_display_get_default_screen(display);
513
514                 if (x) *x = sd->x;
515                 if (y) *y = sd->y;
516                 if (width) *width = sd->width;
517                 if (height) *height = sd->height;
518
519                 if (dest_screen) *dest_screen = screen;
520                 if (same_region) *same_region = (!widget || !gtk_widget_get_window(widget) ||
521                                         (screen == gtk_widget_get_screen(widget) &&
522                                          (sd->number%100 == 0 ||
523                                           sd->number%100 == gdk_screen_get_monitor_at_window(screen, gtk_widget_get_window(widget))+1)));
524
525                 }
526         else if (screen != 1 || !widget || !gtk_widget_get_window(widget))
527                 {
528                 GdkScreen *screen;
529
530                 if (widget)
531                         {
532                         screen = gtk_widget_get_screen(widget);
533                         }
534                 else
535                         {
536                         screen = gdk_screen_get_default();
537                         }
538
539                 if (x) *x = 0;
540                 if (y) *y = 0;
541                 if (width) *width = gdk_screen_get_width(screen);
542                 if (height) *height = gdk_screen_get_height(screen);
543
544                 if (dest_screen) *dest_screen = screen;
545                 if (same_region) *same_region = TRUE;
546                 }
547         else
548                 {
549                 GdkDisplay *display;
550                 GdkMonitor *monitor;
551                 GdkRectangle rect;
552
553                 display = gtk_widget_get_display(widget);
554                 monitor = gdk_display_get_monitor_at_window(display, gtk_widget_get_window(widget));
555
556                 gdk_monitor_get_geometry(monitor, &rect);
557
558                 if (x) *x = rect.x;
559                 if (y) *y = rect.y;
560                 if (width) *width = rect.width;
561                 if (height) *height = rect.height;
562
563                 if (dest_screen) *dest_screen = gtk_widget_get_screen(widget);
564                 if (same_region) *same_region = TRUE;
565                 }
566
567         g_list_free_full(list, reinterpret_cast<GDestroyNotify>(screen_data_free));
568 }
569
570 #pragma GCC diagnostic push
571 #pragma GCC diagnostic ignored "-Wunused-function"
572 gint fullscreen_prefs_find_screen_for_widget_unused(GtkWidget *widget)
573 {
574         GdkScreen *screen;
575         gint monitor;
576         gint n;
577
578         if (!widget || !gtk_widget_get_window(widget)) return 0;
579
580         screen = gtk_widget_get_screen(widget);
581         monitor = gdk_screen_get_monitor_at_window(screen, gtk_widget_get_window(widget));
582
583         n = 100 + monitor + 1;
584
585         DEBUG_1("Screen appears to be %d", n);
586
587         return n;
588 }
589 #pragma GCC diagnostic pop
590
591 enum {
592         FS_MENU_COLUMN_NAME = 0,
593         FS_MENU_COLUMN_VALUE
594 };
595
596 #define BUTTON_ABOVE_KEY  "button_above"
597
598 static void fullscreen_prefs_selection_cb(GtkWidget *combo, gpointer data)
599 {
600         auto value = static_cast<gint *>(data);
601         GtkTreeModel *store;
602         GtkTreeIter iter;
603         GtkWidget *button;
604
605         if (!value) return;
606
607         store = gtk_combo_box_get_model(GTK_COMBO_BOX(combo));
608         if (!gtk_combo_box_get_active_iter(GTK_COMBO_BOX(combo), &iter)) return;
609         gtk_tree_model_get(store, &iter, FS_MENU_COLUMN_VALUE, value, -1);
610
611         button = static_cast<GtkWidget *>(g_object_get_data(G_OBJECT(combo), BUTTON_ABOVE_KEY));
612         if (button)
613                 {
614                 gtk_widget_set_sensitive(button, *value != -1);
615                 }
616 }
617
618 static void fullscreen_prefs_selection_add(GtkListStore *store, const gchar *text, gint value)
619 {
620         GtkTreeIter iter;
621
622         gtk_list_store_append(store, &iter);
623         gtk_list_store_set(store, &iter, FS_MENU_COLUMN_NAME, text,
624                                          FS_MENU_COLUMN_VALUE, value, -1);
625 }
626
627 GtkWidget *fullscreen_prefs_selection_new(const gchar *text, gint *screen_value, gboolean *)
628 {
629         GtkWidget *vbox;
630         GtkWidget *hbox;
631         GtkWidget *combo;
632         GtkListStore *store;
633         GtkCellRenderer *renderer;
634         GList *list;
635         GList *work;
636         gint current = 0;
637         gint n;
638
639         if (!screen_value) return nullptr;
640
641         vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, PREF_PAD_GAP);
642         DEBUG_NAME(vbox);
643         hbox = pref_box_new(vbox, FALSE, GTK_ORIENTATION_HORIZONTAL, PREF_PAD_SPACE);
644         if (text) pref_label_new(hbox, text);
645
646         store = gtk_list_store_new(2, G_TYPE_STRING, G_TYPE_INT);
647         combo = gtk_combo_box_new_with_model(GTK_TREE_MODEL(store));
648         g_object_unref(store);
649
650         renderer = gtk_cell_renderer_text_new();
651         gtk_cell_layout_pack_start(GTK_CELL_LAYOUT(combo), renderer, TRUE);
652         gtk_cell_layout_set_attributes(GTK_CELL_LAYOUT(combo), renderer,
653                                        "text", FS_MENU_COLUMN_NAME, NULL);
654
655         fullscreen_prefs_selection_add(store, _("Determined by Window Manager"), -1);
656         fullscreen_prefs_selection_add(store, _("Active screen"), 0);
657         if (*screen_value == 0) current = 1;
658         fullscreen_prefs_selection_add(store, _("Active monitor"), 1);
659         if (*screen_value == 1) current = 2;
660
661         n = 3;
662         list = fullscreen_prefs_list();
663         work = list;
664         while (work)
665                 {
666                 auto sd = static_cast<ScreenData *>(work->data);
667
668                 fullscreen_prefs_selection_add(store, sd->description, sd->number);
669                 if (*screen_value == sd->number) current = n;
670
671                 work = work->next;
672                 n++;
673                 }
674         g_list_free_full(list, reinterpret_cast<GDestroyNotify>(screen_data_free));
675
676         gtk_combo_box_set_active(GTK_COMBO_BOX(combo), current);
677
678         gq_gtk_box_pack_start(GTK_BOX(hbox), combo, FALSE, FALSE, 0);
679         gtk_widget_show(combo);
680
681         g_signal_connect(G_OBJECT(combo), "changed",
682                          G_CALLBACK(fullscreen_prefs_selection_cb), screen_value);
683
684         return vbox;
685 }
686 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */