desktop-shell/shell.h

   1 /*
   2  * Copyright © 2010-2012 Intel Corporation
   3  * Copyright © 2011-2012 Collabora, Ltd.
   4  * Copyright © 2013 Raspberry Pi Foundation
   5  *
   6  * Permission to use, copy, modify, distribute, and sell this software and
   7  * its documentation for any purpose is hereby granted without fee, provided
   8  * that the above copyright notice appear in all copies and that both that
   9  * copyright notice and this permission notice appear in supporting
  10  * documentation, and that the name of the copyright holders not be used in
  11  * advertising or publicity pertaining to distribution of the software
  12  * without specific, written prior permission.  The copyright holders make
  13  * no representations about the suitability of this software for any
  14  * purpose.  It is provided "as is" without express or implied warranty.
  15  *
  16  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
  17  * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
  18  * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
  19  * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER
  20  * RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF
  21  * CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  22  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  23  */
  24
  25 #include <stdbool.h>
  26
  27 #include "compositor.h"
  28
  29 #include "desktop-shell-server-protocol.h"
  30
  31 enum animation_type {
  32         ANIMATION_NONE,
  33
  34         ANIMATION_ZOOM,
  35         ANIMATION_FADE,
  36         ANIMATION_DIM_LAYER,
  37 };
  38
  39 enum fade_type {
  40         FADE_IN,
  41         FADE_OUT
  42 };
  43
  44 enum exposay_target_state {
  45         EXPOSAY_TARGET_OVERVIEW, /* show all windows */
  46         EXPOSAY_TARGET_CANCEL, /* return to normal, same focus */
  47         EXPOSAY_TARGET_SWITCH, /* return to normal, switch focus */
  48 };
  49
  50 enum exposay_layout_state {
  51         EXPOSAY_LAYOUT_INACTIVE = 0, /* normal desktop */
  52         EXPOSAY_LAYOUT_ANIMATE_TO_INACTIVE, /* in transition to normal */
  53         EXPOSAY_LAYOUT_OVERVIEW, /* show all windows */
  54         EXPOSAY_LAYOUT_ANIMATE_TO_OVERVIEW, /* in transition to all windows */
  55 };
  56
  57 struct exposay_output {
  58         int num_surfaces;
  59         int grid_size;
  60         int surface_size;
  61
  62         int hpadding_outer;
  63         int vpadding_outer;
  64         int padding_inner;
  65 };
  66
  67 struct exposay {
  68         /* XXX: Make these exposay_surfaces. */
  69         struct weston_view *focus_prev;
  70         struct weston_view *focus_current;
  71         struct weston_view *clicked;
  72         struct workspace *workspace;
  73         struct weston_seat *seat;
  74
  75         struct wl_list surface_list;
  76
  77         struct weston_keyboard_grab grab_kbd;
  78         struct weston_pointer_grab grab_ptr;
  79
  80         enum exposay_target_state state_target;
  81         enum exposay_layout_state state_cur;
  82         int in_flight; /* number of animations still running */
  83
  84         int row_current;
  85         int column_current;
  86         struct exposay_output *cur_output;
  87
  88         bool mod_pressed;
  89         bool mod_invalid;
  90 };
  91
  92 struct focus_surface {
  93         struct weston_surface *surface;
  94         struct weston_view *view;
  95         struct weston_transform workspace_transform;
  96 };
  97
  98 struct workspace {
  99         struct weston_layer layer;
 100
 101         struct wl_list focus_list;
 102         struct wl_listener seat_destroyed_listener;
 103
 104         struct focus_surface *fsurf_front;
 105         struct focus_surface *fsurf_back;
 106         struct weston_view_animation *focus_animation;
 107 };
 108
 109 struct shell_output {
 110         struct desktop_shell  *shell;
 111         struct weston_output  *output;
 112         struct exposay_output eoutput;
 113         struct wl_listener    destroy_listener;
 114         struct wl_list        link;
 115 };
 116
 117 struct desktop_shell {
 118         struct weston_compositor *compositor;
 119
 120         struct wl_listener idle_listener;
 121         struct wl_listener wake_listener;
 122         struct wl_listener destroy_listener;
 123         struct wl_listener show_input_panel_listener;
 124         struct wl_listener hide_input_panel_listener;
 125         struct wl_listener update_input_panel_listener;
 126
 127         struct weston_layer fullscreen_layer;
 128         struct weston_layer panel_layer;
 129         struct weston_layer background_layer;
 130         struct weston_layer lock_layer;
 131         struct weston_layer input_panel_layer;
 132
 133         struct wl_listener pointer_focus_listener;
 134         struct weston_surface *grab_surface;
 135
 136         struct {
 137                 struct weston_process process;
 138                 struct wl_client *client;
 139                 struct wl_resource *desktop_shell;
 140                 struct wl_listener client_destroy_listener;
 141
 142                 unsigned deathcount;
 143                 uint32_t deathstamp;
 144         } child;
 145
 146         bool locked;
 147         bool showing_input_panels;
 148         bool prepare_event_sent;
 149
 150         struct {
 151                 struct weston_surface *surface;
 152                 pixman_box32_t cursor_rectangle;
 153         } text_input;
 154
 155         struct weston_surface *lock_surface;
 156         struct wl_listener lock_surface_listener;
 157
 158         struct {
 159                 struct wl_array array;
 160                 unsigned int current;
 161                 unsigned int num;
 162
 163                 struct wl_list client_list;
 164
 165                 struct weston_animation animation;
 166                 struct wl_list anim_sticky_list;
 167                 int anim_dir;
 168                 uint32_t anim_timestamp;
 169                 double anim_current;
 170                 struct workspace *anim_from;
 171                 struct workspace *anim_to;
 172         } workspaces;
 173
 174         struct {
 175                 char *path;
 176                 int duration;
 177                 struct wl_resource *binding;
 178                 struct weston_process process;
 179                 struct wl_event_source *timer;
 180         } screensaver;
 181
 182         struct {
 183                 struct wl_resource *binding;
 184                 struct wl_list surfaces;
 185         } input_panel;
 186
 187         struct {
 188                 struct weston_view *view;
 189                 struct weston_view_animation *animation;
 190                 enum fade_type type;
 191                 struct wl_event_source *startup_timer;
 192         } fade;
 193
 194         struct exposay exposay;
 195
 196         uint32_t binding_modifier;
 197         uint32_t exposay_modifier;
 198         enum animation_type win_animation_type;
 199         enum animation_type win_close_animation_type;
 200         enum animation_type startup_animation_type;
 201         enum animation_type focus_animation_type;
 202
 203         struct weston_layer minimized_layer;
 204
 205         struct wl_listener seat_create_listener;
 206         struct wl_listener output_create_listener;
 207         struct wl_listener output_move_listener;
 208         struct wl_list output_list;
 209
 210         enum desktop_shell_panel_position panel_position;
 211
 212         char *client;
 213 };
 214
 215 struct weston_output *
 216 get_default_output(struct weston_compositor *compositor);
 217
 218 struct weston_view *
 219 get_default_view(struct weston_surface *surface);
 220
 221 struct shell_surface *
 222 get_shell_surface(struct weston_surface *surface);
 223
 224 struct workspace *
 225 get_current_workspace(struct desktop_shell *shell);
 226
 227 void
 228 lower_fullscreen_layer(struct desktop_shell *shell);
 229
 230 void
 231 activate(struct desktop_shell *shell, struct weston_surface *es,
 232          struct weston_seat *seat, bool configure);
 233
 234 void
 235 exposay_binding(struct weston_seat *seat,
 236                 enum weston_keyboard_modifier modifier,
 237                 void *data);
 238 int
 239 input_panel_setup(struct desktop_shell *shell);
 240 void
 241 input_panel_destroy(struct desktop_shell *shell);
 242
 243 typedef void (*shell_for_each_layer_func_t)(struct desktop_shell *,
 244                                             struct weston_layer *, void *);
 245
 246 void
 247 shell_for_each_layer(struct desktop_shell *shell,
 248                      shell_for_each_layer_func_t func,
 249                      void *data);