weston/include/libweston/shell-utils.h
Sergio Gómez cc837eea61 kiosk-shell: Redesign the function 'find_focus_successor()'
The function find_focus_successor() is called when destroying a surface to find
a successor to the current focus. It, however, has the following issues:

- Its first parameter is the weston layer from which to search for a successor.
  This is an unnecessary flexibility for our use, which only adds complexity to
  the user of the function by having to make a call for each layer. We know
  that we want to search for a successor first in the normal layer, and if that
  fails, then in the inactive layer. So we change the signature of
  find_focus_successor(), removing this first parameter.

- It includes logic to decide whether to do the search or not: if the destroyed
  surface is different from the surface that currently has focus, and if their
  outputs are the same, then abort and don't do the search. This returns NULL to
  the calling function. The problem is that the function also returns NULL if
  it does the search and finds no successor. The distinction for the failing
  reason is lost, and the user of the function needs to add more logic to know
  the reason for failure. To simplify, we take the logic out of
  find_focus_successor() and inside the caller.

- It returns the successor view, although it receives surfaces and the client
  has logic to retrieve the surface corresponding to the returned view. To
  simplify and maintain symmetry, we change the signature so that the function
  returns the surface corresponding to the successor view.

Fixes: #738

Signed-off-by: Sergio Gómez <sergio.g.delreal@gmail.com>
2023-07-27 10:13:48 +03:00

82 lines
2.6 KiB
C

/*
* Copyright 2021, 2022 Collabora, Ltd.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice (including the next
* paragraph) shall be included in all copies or substantial portions of the
* Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
*/
#pragma once
#include "config.h"
#include "shared/helpers.h"
#include <libweston/libweston.h>
#ifdef __cplusplus
extern "C" {
#endif
/* parameter for weston_curtain_create() */
struct weston_curtain_params {
int (*get_label)(struct weston_surface *es, char *buf, size_t len);
void (*surface_committed)(struct weston_surface *es,
struct weston_coord_surface new_origin);
void *surface_private;
float r, g, b, a;
int x, y, width, height;
bool capture_input;
};
struct weston_curtain {
struct weston_view *view;
struct weston_buffer_reference *buffer_ref;
};
struct weston_output *
weston_shell_utils_get_default_output(struct weston_compositor *compositor);
struct weston_output *
weston_shell_utils_get_focused_output(struct weston_compositor *compositor);
void
weston_shell_utils_center_on_output(struct weston_view *view,
struct weston_output *output);
void
weston_shell_utils_subsurfaces_boundingbox(struct weston_surface *surface,
int32_t *x, int32_t *y,
int32_t *w, int32_t *h);
int
weston_shell_utils_surface_get_label(struct weston_surface *surface,
char *buf, size_t len);
/* helper to create a view w/ a color */
struct weston_curtain *
weston_shell_utils_curtain_create(struct weston_compositor *compositor,
struct weston_curtain_params *params);
void
weston_shell_utils_curtain_destroy(struct weston_curtain *curtain);
enum weston_layer_position
weston_shell_utils_view_get_layer_position(struct weston_view *view);
#ifdef __cplusplus
}
#endif