display-private.h 15.9 KB
Newer Older
1 2
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */

3
/* Mutter X display handler */
rhp's avatar
...  
rhp committed
4

Jasper St. Pierre's avatar
Jasper St. Pierre committed
5
/*
rhp's avatar
...  
rhp committed
6
 * Copyright (C) 2001 Havoc Pennington
7
 * Copyright (C) 2002 Red Hat, Inc.
8
 * Copyright (C) 2003 Rob Adams
9
 * Copyright (C) 2004-2006 Elijah Newren
Jasper St. Pierre's avatar
Jasper St. Pierre committed
10
 *
rhp's avatar
...  
rhp committed
11 12 13 14 15 16 17 18 19
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
Jasper St. Pierre's avatar
Jasper St. Pierre committed
20
 *
rhp's avatar
...  
rhp committed
21
 * You should have received a copy of the GNU General Public License
22
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
rhp's avatar
...  
rhp committed
23 24
 */

25 26
#ifndef META_DISPLAY_PRIVATE_H
#define META_DISPLAY_PRIVATE_H
rhp's avatar
...  
rhp committed
27

Havoc Pennington's avatar
Havoc Pennington committed
28 29 30 31
#ifndef PACKAGE
#error "config.h not included"
#endif

rhp's avatar
...  
rhp committed
32
#include <glib.h>
rhp's avatar
...  
rhp committed
33
#include <X11/Xlib.h>
34 35 36
#include <meta/common.h>
#include <meta/boxes.h>
#include <meta/display.h>
37
#include "keybindings-private.h"
38
#include "startup-notification-private.h"
39
#include "meta-gesture-tracker-private.h"
40
#include <meta/prefs.h>
41
#include <meta/barrier.h>
42
#include <clutter/clutter.h>
rhp's avatar
...  
rhp committed
43

44 45 46 47
#ifdef HAVE_STARTUP_NOTIFICATION
#include <libsn/sn.h>
#endif

48 49
#include <X11/extensions/sync.h>

50 51
typedef struct _MetaStack      MetaStack;
typedef struct _MetaUISlave    MetaUISlave;
rhp's avatar
...  
rhp committed
52

53 54
typedef struct MetaEdgeResistanceData MetaEdgeResistanceData;

55 56 57
typedef enum {
  META_LIST_DEFAULT                   = 0,      /* normal windows */
  META_LIST_INCLUDE_OVERRIDE_REDIRECT = 1 << 0, /* normal and O-R */
58
  META_LIST_SORTED                    = 1 << 1, /* sort list by mru */
59
} MetaListWindowsFlags;
60

rhp's avatar
...  
rhp committed
61 62 63 64
#define _NET_WM_STATE_REMOVE        0    /* remove/unset property */
#define _NET_WM_STATE_ADD           1    /* add/set property */
#define _NET_WM_STATE_TOGGLE        2    /* toggle property  */

65 66 67
/* This is basically a bogus number, just has to be large enough
 * to handle the expected case of the alt+tab operation, where
 * we want to ignore serials from UnmapNotify on the tab popup,
68 69 70
 * and the LeaveNotify/EnterNotify from the pointer ungrab. It
 * also has to be big enough to hold ignored serials from the point
 * where we reshape the stage to the point where we get events back.
71
 */
72
#define N_IGNORED_CROSSING_SERIALS  10
73

74 75 76 77 78 79 80
typedef enum {
  META_TILE_NONE,
  META_TILE_LEFT,
  META_TILE_RIGHT,
  META_TILE_MAXIMIZED
} MetaTileMode;

81 82 83 84 85
typedef enum {
  /* Normal interaction where you're interacting with windows.
   * Events go to windows normally. */
  META_EVENT_ROUTE_NORMAL,

86 87 88 89
  /* In a window operation like moving or resizing. All events
   * goes to MetaWindow, but not to the actual client window. */
  META_EVENT_ROUTE_WINDOW_OP,

90 91 92 93 94 95 96 97
  /* In a compositor grab operation. All events go to the
   * compositor plugin. */
  META_EVENT_ROUTE_COMPOSITOR_GRAB,

  /* A Wayland application has a popup open. All events go to
   * the Wayland application. */
  META_EVENT_ROUTE_WAYLAND_POPUP,

98 99
  /* The user is clicking on a window button. */
  META_EVENT_ROUTE_FRAME_BUTTON,
100 101
} MetaEventRoute;

102 103 104
typedef void (* MetaDisplayWindowFunc) (MetaWindow *window,
                                        gpointer    user_data);

rhp's avatar
...  
rhp committed
105 106
struct _MetaDisplay
{
107
  GObject parent_instance;
Jasper St. Pierre's avatar
Jasper St. Pierre committed
108

Armin Krezović's avatar
Armin Krezović committed
109 110
  MetaX11Display *x11_display;

111 112
  int clutter_event_filter;

rhp's avatar
...  
rhp committed
113
  Window leader_window;
114
  Window timestamp_pinging_window;
Colin Walters's avatar
Colin Walters committed
115

116 117 118 119 120 121 122 123
  /* The window and serial of the most recent FocusIn event. */
  Window server_focus_window;
  gulong server_focus_serial;

  /* Our best guess as to the "currently" focused window (that is, the
   * window that we expect will be focused at the point when the X
   * server processes our next request), and the serial of the request
   * or event that caused this.
rhp's avatar
...  
rhp committed
124 125
   */
  MetaWindow *focus_window;
126 127 128
  /* For windows we've focused that don't necessarily have an X window,
   * like the no_focus_window or the stage X window. */
  Window focus_xwindow;
129
  gulong focus_serial;
130

131
  /* last timestamp passed to XSetInputFocus */
132
  guint32 last_focus_time;
133

134
  /* last user interaction time in any app */
135
  guint32 last_user_time;
136

137 138 139 140 141
  /* whether we're using mousenav (only relevant for sloppy&mouse focus modes;
   * !mouse_mode means "keynav mode")
   */
  guint mouse_mode : 1;

142 143 144 145 146 147
  /* Helper var used when focus_new_windows setting is 'strict'; only
   * relevant in 'strict' mode and if the focus window is a terminal.
   * In that case, we don't allow new windows to take focus away from
   * a terminal, but if the user explicitly did something that should
   * allow a different window to gain focus (e.g. global keybinding or
   * clicking on a dock), then we will allow the transfer.
148 149 150
   */
  guint allow_terminal_deactivation : 1;

151 152 153 154 155 156 157
  /* If true, server->focus_serial refers to us changing the focus; in
   * this case, we can ignore focus events that have exactly focus_serial,
   * since we take care to make another request immediately afterwards.
   * But if focus is being changed by another client, we have to accept
   * multiple events with the same serial.
   */
  guint focused_by_us : 1;
Jasper St. Pierre's avatar
Jasper St. Pierre committed
158

rhp's avatar
...  
rhp committed
159
  /*< private-ish >*/
160
  MetaScreen *screen;
161
  GHashTable *stamps;
162
  GHashTable *wayland_windows;
163

164 165 166 167
  /* serials of leave/unmap events that may
   * correspond to an enter event we should
   * ignore
   */
168
  unsigned long ignored_crossing_serials[N_IGNORED_CROSSING_SERIALS];
Jasper St. Pierre's avatar
Jasper St. Pierre committed
169

170
  guint32 current_time;
171

172 173 174 175 176 177 178 179 180
  /* We maintain a sequence counter, incremented for each #MetaWindow
   * created.  This is exposed by meta_window_get_stable_sequence()
   * but is otherwise not used inside mutter.
   *
   * It can be useful to plugins which want to sort windows in a
   * stable fashion.
   */
  guint32 window_sequence_counter;

181
  /* Pings which we're waiting for a reply from */
182
  GSList     *pending_pings;
Havoc Pennington's avatar
Havoc Pennington committed
183

184 185 186
  /* Pending focus change */
  guint       focus_timeout_id;

Havoc Pennington's avatar
Havoc Pennington committed
187 188
  /* Pending autoraise */
  guint       autoraise_timeout_id;
189
  MetaWindow* autoraise_window;
190

191 192 193
  /* Event routing */
  MetaEventRoute event_route;

rhp's avatar
...  
rhp committed
194 195 196 197
  /* current window operation */
  MetaGrabOp  grab_op;
  MetaWindow *grab_window;
  int         grab_button;
198 199 200
  int         grab_anchor_root_x;
  int         grab_anchor_root_y;
  MetaRectangle grab_anchor_window_pos;
201 202
  MetaTileMode  grab_tile_mode;
  int           grab_tile_monitor_number;
203 204
  int         grab_latest_motion_x;
  int         grab_latest_motion_y;
rhp's avatar
...  
rhp committed
205 206
  guint       grab_have_pointer : 1;
  guint       grab_have_keyboard : 1;
207
  guint       grab_frame_action : 1;
rhp's avatar
...  
rhp committed
208
  MetaRectangle grab_initial_window_pos;
209 210
  int         grab_initial_x, grab_initial_y;  /* These are only relevant for */
  gboolean    grab_threshold_movement_reached; /* raise_on_click == FALSE.    */
211
  GTimeVal    grab_last_moveresize_time;
212
  MetaEdgeResistanceData *grab_edge_resistance_data;
213 214
  unsigned int grab_last_user_action_was_snap;

215 216 217 218 219
  /* we use property updates as sentinels for certain window focus events
   * to avoid some race conditions on EnterNotify events
   */
  int         sentinel_counter;

220
  int         xkb_base_event_type;
221
  guint32     last_bell_time;
222
  int	      grab_resize_timeout_id;
223

224
  MetaKeyBindingManager key_binding_manager;
Jasper St. Pierre's avatar
Jasper St. Pierre committed
225

226 227
  /* Monitor cache */
  unsigned int monitor_cache_invalidated : 1;
228

229 230 231
  /* Opening the display */
  unsigned int display_opening : 1;

232 233
  /* Closing down the display */
  int closing;
234

Havoc Pennington's avatar
Havoc Pennington committed
235 236
  /* Managed by compositor.c */
  MetaCompositor *compositor;
237

238
  MetaGestureTracker *gesture_tracker;
239
  ClutterEventSequence *pointer_emulating_sequence;
240

241 242
  ClutterActor *current_pad_osd;

243
  MetaStartupNotification *startup_notification;
244 245 246

  MetaRectangle rect;  /* Size of screen; rect.x & rect.y are always 0 */
  MetaCursor current_cursor;
rhp's avatar
...  
rhp committed
247 248
};

249 250 251 252 253
struct _MetaDisplayClass
{
  GObjectClass parent_class;
};

254
#define XSERVER_TIME_IS_BEFORE_ASSUMING_REAL_TIMESTAMPS(time1, time2) \
255 256
  ( (( (time1) < (time2) ) && ( (time2) - (time1) < ((guint32)-1)/2 )) ||     \
    (( (time1) > (time2) ) && ( (time1) - (time2) > ((guint32)-1)/2 ))        \
257
  )
258 259 260 261 262
/**
 * XSERVER_TIME_IS_BEFORE:
 *
 * See the docs for meta_display_xserver_time_is_before().
 */
263
#define XSERVER_TIME_IS_BEFORE(time1, time2)                          \
264
  ( (time1) == 0 ||                                                     \
265
    (XSERVER_TIME_IS_BEFORE_ASSUMING_REAL_TIMESTAMPS(time1, time2) && \
266
     (time2) != 0)                                                      \
267 268
  )

269
gboolean      meta_display_open                (void);
270 271
void          meta_display_close               (MetaDisplay *display,
                                                guint32      timestamp);
rhp's avatar
...  
rhp committed
272

273 274
void meta_display_unmanage_windows (MetaDisplay *display,
                                    guint32      timestamp);
Havoc Pennington's avatar
Havoc Pennington committed
275

276 277 278 279
/* Utility function to compare the stacking of two windows */
int           meta_display_stack_cmp           (const void *a,
                                                const void *b);

280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
/* Each MetaWindow is uniquely identified by a 64-bit "stamp"; unlike a
 * a MetaWindow *, a stamp will never be recycled
 */
MetaWindow* meta_display_lookup_stamp     (MetaDisplay *display,
                                           guint64      stamp);
void        meta_display_register_stamp   (MetaDisplay *display,
                                           guint64     *stampp,
                                           MetaWindow  *window);
void        meta_display_unregister_stamp (MetaDisplay *display,
                                           guint64      stamp);

/* A "stack id" is a XID or a stamp */

#define META_STACK_ID_IS_X11(id) ((id) < G_GUINT64_CONSTANT(0x100000000))
MetaWindow* meta_display_lookup_stack_id   (MetaDisplay *display,
                                            guint64      stack_id);

/* for debug logging only; returns a human-description of the stack
 * ID - a small number of buffers are recycled, so the result must
 * be used immediately or copied */
const char *meta_display_describe_stack_id (MetaDisplay *display,
                                            guint64      stack_id);

303 304 305 306 307
void        meta_display_register_wayland_window   (MetaDisplay *display,
                                                    MetaWindow  *window);
void        meta_display_unregister_wayland_window (MetaDisplay *display,
                                                    MetaWindow  *window);

308 309 310
void        meta_display_notify_window_created (MetaDisplay  *display,
                                                MetaWindow   *window);

311 312
GSList*     meta_display_list_windows        (MetaDisplay          *display,
                                              MetaListWindowsFlags  flags);
rhp's avatar
...  
rhp committed
313

rhp's avatar
...  
rhp committed
314
MetaDisplay* meta_display_for_x_display  (Display     *xdisplay);
315
MetaDisplay* meta_get_display            (void);
rhp's avatar
...  
rhp committed
316

317 318
void meta_display_reload_cursor (MetaDisplay *display);
void meta_display_update_cursor (MetaDisplay *display);
319

320 321 322
void    meta_display_check_threshold_reached (MetaDisplay *display,
                                              int          x,
                                              int          y);
rhp's avatar
...  
rhp committed
323 324 325 326
void     meta_display_grab_window_buttons    (MetaDisplay *display,
                                              Window       xwindow);
void     meta_display_ungrab_window_buttons  (MetaDisplay *display,
                                              Window       xwindow);
rhp's avatar
...  
rhp committed
327

328
void meta_display_grab_focus_window_button   (MetaDisplay *display,
329
                                              MetaWindow  *window);
330
void meta_display_ungrab_focus_window_button (MetaDisplay *display,
331
                                              MetaWindow  *window);
332

333 334
/* Next function is defined in edge-resistance.c */
void meta_display_cleanup_edges              (MetaDisplay *display);
335

336 337
/* make a request to ensure the event serial has changed */
void     meta_display_increment_event_serial (MetaDisplay *display);
rhp's avatar
...  
rhp committed
338

Havoc Pennington's avatar
Havoc Pennington committed
339 340
void     meta_display_update_active_window_hint (MetaDisplay *display);

341
/* utility goo */
342 343
const char* meta_event_mode_to_string   (int m);
const char* meta_event_detail_to_string (int d);
344

345 346 347
void meta_display_queue_retheme_all_windows (MetaDisplay *display);
void meta_display_retheme_all (void);

Jasper St. Pierre's avatar
Jasper St. Pierre committed
348 349 350 351
void meta_display_ping_window      (MetaWindow  *window,
                                    guint32      serial);
void meta_display_pong_for_serial  (MetaDisplay *display,
                                    guint32      serial);
352

353 354
int meta_resize_gravity_from_grab_op (MetaGrabOp op);

355 356
gboolean meta_grab_op_is_moving   (MetaGrabOp op);
gboolean meta_grab_op_is_resizing (MetaGrabOp op);
357
gboolean meta_grab_op_is_mouse    (MetaGrabOp op);
358
gboolean meta_grab_op_is_keyboard (MetaGrabOp op);
359

360 361 362 363
void meta_display_increment_focus_sentinel (MetaDisplay *display);
void meta_display_decrement_focus_sentinel (MetaDisplay *display);
gboolean meta_display_focus_sentinel_clear (MetaDisplay *display);

364 365 366 367
void meta_display_queue_autoraise_callback  (MetaDisplay *display,
                                             MetaWindow  *window);
void meta_display_remove_autoraise_callback (MetaDisplay *display);

368
void meta_display_overlay_key_activate (MetaDisplay *display);
369 370 371
void meta_display_accelerator_activate (MetaDisplay     *display,
                                        guint            action,
                                        ClutterKeyEvent *event);
372
gboolean meta_display_modifiers_accelerator_activate (MetaDisplay *display);
373

374 375 376 377
void meta_display_set_input_focus_xwindow (MetaDisplay *display,
                                           MetaScreen  *screen,
                                           Window       window,
                                           guint32      timestamp);
378

379
void meta_display_sync_wayland_input_focus (MetaDisplay *display);
380 381 382 383 384 385 386 387
void meta_display_update_focus_window (MetaDisplay *display,
                                       MetaWindow  *window,
                                       Window       xwindow,
                                       gulong       serial,
                                       gboolean     focused_by_us);

void meta_display_sanity_check_timestamps (MetaDisplay *display,
                                           guint32      timestamp);
388 389
gboolean meta_display_timestamp_too_old (MetaDisplay *display,
                                         guint32     *timestamp);
390

391 392 393
void meta_display_remove_pending_pings_for_window (MetaDisplay *display,
                                                   MetaWindow  *window);

394 395
MetaGestureTracker * meta_display_get_gesture_tracker (MetaDisplay *display);

396 397 398 399
gboolean meta_display_show_restart_message (MetaDisplay *display,
                                            const char  *message);
gboolean meta_display_request_restart      (MetaDisplay *display);

400 401 402 403 404 405
gboolean meta_display_show_resize_popup (MetaDisplay *display,
                                         gboolean show,
                                         MetaRectangle *rect,
                                         int display_w,
                                         int display_h);

406 407 408
void meta_restart_init (void);
void meta_restart_finish (void);

409 410
void meta_display_cancel_touch (MetaDisplay *display);

411 412
gboolean meta_display_windows_are_interactable (MetaDisplay *display);

413 414 415 416 417 418 419 420 421 422 423
void meta_display_show_tablet_mapping_notification (MetaDisplay        *display,
                                                    ClutterInputDevice *pad,
                                                    const gchar        *pretty_name);

void meta_display_notify_pad_group_switch (MetaDisplay        *display,
                                           ClutterInputDevice *pad,
                                           const gchar        *pretty_name,
                                           guint               n_group,
                                           guint               n_mode,
                                           guint               n_modes);

424 425 426 427 428
void meta_display_foreach_window (MetaDisplay           *display,
                                  MetaListWindowsFlags   flags,
                                  MetaDisplayWindowFunc  func,
                                  gpointer               data);

rhp's avatar
...  
rhp committed
429
#endif