weston/clients/window.h

756 lines
20 KiB
C
Raw Normal View History

/*
* Copyright © 2008 Kristian Høgsberg
*
* 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.
*/
#ifndef _WINDOW_H_
#define _WINDOW_H_
#include "config.h"
#include <stdint.h>
#include <time.h>
#include <xkbcommon/xkbcommon.h>
#include <wayland-client.h>
#include <cairo.h>
#include <libweston/config-parser.h>
#include <libweston/zalloc.h>
#include "shared/platform.h"
struct window;
struct widget;
struct display;
struct input;
2011-11-27 02:27:37 +04:00
struct output;
struct task {
void (*run)(struct task *task, uint32_t events);
struct wl_list link;
};
struct rectangle {
int32_t x;
int32_t y;
int32_t width;
int32_t height;
};
struct display *
display_create(int *argc, char *argv[]);
void
display_destroy(struct display *display);
void
display_set_user_data(struct display *display, void *data);
void *
display_get_user_data(struct display *display);
struct wl_display *
display_get_display(struct display *display);
int
display_has_subcompositor(struct display *display);
cairo_device_t *
display_get_cairo_device(struct display *display);
struct wl_compositor *
display_get_compositor(struct display *display);
2011-11-27 02:27:37 +04:00
struct output *
display_get_output(struct display *display);
uint32_t
display_get_serial(struct display *display);
typedef void (*display_global_handler_t)(struct display *display,
uint32_t name,
const char *interface,
uint32_t version, void *data);
void
display_set_global_handler(struct display *display,
display_global_handler_t handler);
void
display_set_global_handler_remove(struct display *display,
display_global_handler_t remove_handler);
void *
display_bind(struct display *display, uint32_t name,
const struct wl_interface *interface, uint32_t version);
typedef void (*display_output_handler_t)(struct output *output, void *data);
/*
* The output configure handler is called, when a new output is connected
* and we know its current mode, or when the current mode changes.
* Test and set the output user data in your handler to know, if the
* output is new. Note: 'data' in the configure handler is the display
* user data.
*/
void
display_set_output_configure_handler(struct display *display,
display_output_handler_t handler);
struct wl_data_source *
display_create_data_source(struct display *display);
#ifdef EGL_NO_DISPLAY
EGLDisplay
display_get_egl_display(struct display *d);
EGLConfig
display_get_argb_egl_config(struct display *d);
int
display_acquire_window_surface(struct display *display,
struct window *window,
EGLContext ctx);
void
display_release_window_surface(struct display *display,
struct window *window);
#endif
2011-05-13 21:45:17 +04:00
#define SURFACE_OPAQUE 0x01
#define SURFACE_SHM 0x02
2011-05-13 21:45:17 +04:00
#define SURFACE_HINT_RESIZE 0x10
#define SURFACE_HINT_RGB565 0x100
cairo_surface_t *
display_create_surface(struct display *display,
struct wl_surface *surface,
2011-05-13 21:45:17 +04:00
struct rectangle *rectangle,
uint32_t flags);
2010-08-18 23:28:04 +04:00
struct wl_buffer *
display_get_buffer_for_surface(struct display *display,
cairo_surface_t *surface);
struct wl_cursor_image *
display_get_pointer_image(struct display *display, int pointer);
2010-08-18 23:28:04 +04:00
void
display_defer(struct display *display, struct task *task);
void
display_watch_fd(struct display *display,
int fd, uint32_t events, struct task *task);
void
display_unwatch_fd(struct display *display, int fd);
void
display_run(struct display *d);
void
display_exit(struct display *d);
data-device: Implement DnD actions The policy in weston in order to determine the chosen DnD action is deliberately simple, and is probably the minimals that any compositor should be doing here. Besides honoring the set_actions requests on both wl_data_source and wl_data_offer, weston now will emit the newly added "action" events notifying both source and dest of the chosen action. The "dnd" client has been updated too (although minimally), so it notifies the compositor of a "move" action on both sides. Changes since v8: - Add back wl_data_offer.source_actions emission, gone during last code shuffling. Fix nits found in review. Changes since v7: - Fixes spotted during review. Add client-side version checks. Implement .action emission as specified in protocol patch v11. Changes since v6: - Emit errors as defined in DnD actions patch v10. Changes since v5: - Use enum types and values for not-a-bitfield stored values. handle errors when finding unexpected dnd_actions values. Changes since v4: - Added compositor-side version checks. Spaces vs tabs fixes. Fixed resource versioning. Initialized new weston_data_source/offer fields. Changes since v3: - Put data_source.action to use in the dnd client, now updates the dnd surface like data_source.target events do. Changes since v2: - Split from DnD progress notification changes. Changes since v1: - Updated to v2 of DnD actions protocol changes, implement wl_data_offer.source_actions. - Fixed coding style issues. Signed-off-by: Carlos Garnacho <carlosg@gnome.org> Reviewed-by: Michael Catanzaro <mcatanzaro@igalia.com> Reviewed-by: Jonas Ådahl <jadahl@gmail.com>
2016-01-19 01:52:12 +03:00
int
display_get_data_device_manager_version(struct display *d);
enum cursor_type {
CURSOR_BOTTOM_LEFT,
CURSOR_BOTTOM_RIGHT,
CURSOR_BOTTOM,
CURSOR_DRAGGING,
CURSOR_LEFT_PTR,
CURSOR_LEFT,
CURSOR_RIGHT,
CURSOR_TOP_LEFT,
CURSOR_TOP_RIGHT,
CURSOR_TOP,
CURSOR_IBEAM,
CURSOR_HAND1,
CURSOR_WATCH,
CURSOR_DND_MOVE,
CURSOR_DND_COPY,
CURSOR_DND_FORBIDDEN,
CURSOR_BLANK
2010-08-18 23:28:04 +04:00
};
typedef void (*window_key_handler_t)(struct window *window, struct input *input,
uint32_t time, uint32_t key, uint32_t unicode,
enum wl_keyboard_key_state state, void *data);
typedef void (*window_keyboard_focus_handler_t)(struct window *window,
struct input *device, void *data);
typedef void (*window_data_handler_t)(struct window *window,
struct input *input,
float x, float y,
const char **types,
void *data);
typedef void (*window_drop_handler_t)(struct window *window,
struct input *input,
int32_t x, int32_t y, void *data);
typedef void (*window_close_handler_t)(void *data);
typedef void (*window_fullscreen_handler_t)(struct window *window, void *data);
typedef void (*window_output_handler_t)(struct window *window, struct output *output,
int enter, void *data);
typedef void (*window_state_changed_handler_t)(struct window *window,
void *data);
typedef void (*window_locked_pointer_motion_handler_t)(struct window *window,
struct input *input,
uint32_t time,
float x, float y,
void *data);
typedef void (*locked_pointer_locked_handler_t)(struct window *window,
struct input *input,
void *data);
typedef void (*locked_pointer_unlocked_handler_t)(struct window *window,
struct input *input,
void *data);
typedef void (*confined_pointer_confined_handler_t)(struct window *window,
struct input *input,
void *data);
typedef void (*confined_pointer_unconfined_handler_t)(struct window *window,
struct input *input,
void *data);
typedef void (*widget_resize_handler_t)(struct widget *widget,
int32_t width, int32_t height,
void *data);
typedef void (*widget_redraw_handler_t)(struct widget *widget, void *data);
typedef int (*widget_enter_handler_t)(struct widget *widget,
struct input *input,
float x, float y, void *data);
typedef void (*widget_leave_handler_t)(struct widget *widget,
struct input *input, void *data);
2012-01-09 18:36:16 +04:00
typedef int (*widget_motion_handler_t)(struct widget *widget,
struct input *input, uint32_t time,
float x, float y, void *data);
2012-01-09 20:12:05 +04:00
typedef void (*widget_button_handler_t)(struct widget *widget,
struct input *input, uint32_t time,
uint32_t button,
enum wl_pointer_button_state state,
void *data);
typedef void (*widget_touch_down_handler_t)(struct widget *widget,
struct input *input,
uint32_t serial,
uint32_t time,
int32_t id,
float x,
float y,
void *data);
typedef void (*widget_touch_up_handler_t)(struct widget *widget,
struct input *input,
uint32_t serial,
uint32_t time,
int32_t id,
void *data);
typedef void (*widget_touch_motion_handler_t)(struct widget *widget,
struct input *input,
uint32_t time,
int32_t id,
float x,
float y,
void *data);
typedef void (*widget_touch_frame_handler_t)(struct widget *widget,
struct input *input, void *data);
typedef void (*widget_touch_cancel_handler_t)(struct widget *widget,
struct input *input, void *data);
2012-08-14 13:02:41 +04:00
typedef void (*widget_axis_handler_t)(struct widget *widget,
struct input *input, uint32_t time,
uint32_t axis,
wl_fixed_t value,
void *data);
typedef void (*widget_pointer_frame_handler_t)(struct widget *widget,
struct input *input,
void *data);
typedef void (*widget_axis_source_handler_t)(struct widget *widget,
struct input *input,
uint32_t source,
void *data);
typedef void (*widget_axis_stop_handler_t)(struct widget *widget,
struct input *input,
uint32_t time,
uint32_t axis,
void *data);
typedef void (*widget_axis_discrete_handler_t)(struct widget *widget,
struct input *input,
uint32_t axis,
int32_t discrete,
void *data);
struct window *
window_create(struct display *display);
struct window *
window_create_custom(struct display *display);
void
window_set_parent(struct window *window, struct window *parent_window);
struct window *
window_get_parent(struct window *window);
int
window_has_focus(struct window *window);
typedef void (*menu_func_t)(void *data, struct input *input, int index);
void
window_show_menu(struct display *display,
struct input *input, uint32_t time, struct window *parent,
int32_t x, int32_t y,
menu_func_t func, const char **entries, int count);
void
window_show_frame_menu(struct window *window,
struct input *input, uint32_t time);
int
window_get_buffer_transform(struct window *window);
void
window_set_buffer_transform(struct window *window,
enum wl_output_transform transform);
uint32_t
window_get_buffer_scale(struct window *window);
void
window_set_buffer_scale(struct window *window,
int32_t scale);
uint32_t
window_get_output_scale(struct window *window);
void
window_destroy(struct window *window);
struct widget *
window_add_widget(struct window *window, void *data);
enum subsurface_mode {
SUBSURFACE_SYNCHRONIZED,
SUBSURFACE_DESYNCHRONIZED
};
struct widget *
window_add_subsurface(struct window *window, void *data,
enum subsurface_mode default_mode);
typedef void (*data_func_t)(void *data, size_t len,
int32_t x, int32_t y, void *user_data);
struct display *
window_get_display(struct window *window);
void
window_move(struct window *window, struct input *input, uint32_t time);
void
window_get_allocation(struct window *window, struct rectangle *allocation);
2011-05-13 21:45:17 +04:00
void
window_schedule_redraw(struct window *window);
void
window_schedule_resize(struct window *window, int width, int height);
2010-06-08 22:08:30 +04:00
int
window_lock_pointer(struct window *window, struct input *input);
void
window_unlock_pointer(struct window *window);
void
widget_set_locked_pointer_cursor_hint(struct widget *widget,
float x, float y);
int
window_confine_pointer_to_rectangles(struct window *window,
struct input *input,
struct rectangle *rectangles,
int num_rectangles);
void
window_update_confine_rectangles(struct window *window,
struct rectangle *rectangles,
int num_rectangles);
int
window_confine_pointer_to_widget(struct window *window,
struct widget *widget,
struct input *input);
void
window_unconfine_pointer(struct window *window);
2010-06-08 22:08:30 +04:00
cairo_surface_t *
window_get_surface(struct window *window);
struct wl_surface *
window_get_wl_surface(struct window *window);
struct wl_subsurface *
widget_get_wl_subsurface(struct widget *widget);
enum window_buffer_type {
WINDOW_BUFFER_TYPE_EGL_WINDOW,
WINDOW_BUFFER_TYPE_SHM,
};
void
display_surface_damage(struct display *display, cairo_surface_t *cairo_surface,
int32_t x, int32_t y, int32_t width, int32_t height);
void
window_set_buffer_type(struct window *window, enum window_buffer_type type);
enum window_buffer_type
window_get_buffer_type(struct window *window);
int
window_is_fullscreen(struct window *window);
2008-12-22 20:14:50 +03:00
void
window_set_fullscreen(struct window *window, int fullscreen);
int
window_is_maximized(struct window *window);
2012-02-17 00:53:46 +04:00
void
window_set_maximized(struct window *window, int maximized);
int
window_is_resizing(struct window *window);
void
window_set_minimized(struct window *window);
void
window_set_user_data(struct window *window, void *data);
void *
window_get_user_data(struct window *window);
2008-12-08 08:01:36 +03:00
void
window_set_key_handler(struct window *window,
window_key_handler_t handler);
void
window_set_keyboard_focus_handler(struct window *window,
window_keyboard_focus_handler_t handler);
2010-06-08 22:08:30 +04:00
void
window_set_data_handler(struct window *window,
window_data_handler_t handler);
void
window_set_drop_handler(struct window *window,
window_drop_handler_t handler);
void
window_set_close_handler(struct window *window,
window_close_handler_t handler);
void
window_set_fullscreen_handler(struct window *window,
window_fullscreen_handler_t handler);
void
window_set_output_handler(struct window *window,
window_output_handler_t handler);
void
window_set_state_changed_handler(struct window *window,
window_state_changed_handler_t handler);
void
window_set_pointer_locked_handler(struct window *window,
locked_pointer_locked_handler_t locked,
locked_pointer_unlocked_handler_t unlocked);
void
window_set_pointer_confined_handler(struct window *window,
confined_pointer_confined_handler_t confined,
confined_pointer_unconfined_handler_t unconfined);
void
window_set_locked_pointer_motion_handler(
struct window *window, window_locked_pointer_motion_handler_t handler);
void
window_set_title(struct window *window, const char *title);
const char *
window_get_title(struct window *window);
void
window_set_text_cursor_position(struct window *window, int32_t x, int32_t y);
enum preferred_format {
WINDOW_PREFERRED_FORMAT_NONE,
WINDOW_PREFERRED_FORMAT_RGB565
};
void
window_set_preferred_format(struct window *window,
enum preferred_format format);
int
widget_set_tooltip(struct widget *parent, char *entry, float x, float y);
void
widget_destroy_tooltip(struct widget *parent);
struct widget *
widget_add_widget(struct widget *parent, void *data);
void
widget_destroy(struct widget *widget);
void
widget_set_default_cursor(struct widget *widget, int cursor);
void
widget_get_allocation(struct widget *widget, struct rectangle *allocation);
void
widget_set_allocation(struct widget *widget,
int32_t x, int32_t y, int32_t width, int32_t height);
void
widget_set_size(struct widget *widget, int32_t width, int32_t height);
void
widget_set_transparent(struct widget *widget, int transparent);
void
widget_schedule_resize(struct widget *widget, int32_t width, int32_t height);
void *
widget_get_user_data(struct widget *widget);
cairo_t *
widget_cairo_create(struct widget *widget);
clients: add subsurfaces demo Add a demo program with: - a main surface (green) - a Cairo-image sub-surface (red) - a raw GLESv2 widget (triangle) Sub-surface input region is set empty to avoid problems in toytoolkit. If Cairo links to libGL, then we will end up with also libGLESv2 linked to subsurfaces program, and both libs getting really used, which leads to disaster. Do not build subsurfaces demo, if Cairo links to libGL and cairo-egl is usable. The GL rendering loop is not tied to the toytoolkit or the widget, but runs directly from its own frame callback. Therefore it runs independent of the rest of the application. This also relies on one of two things: - eglSwapInterval(0) is implemented, and therefore eglSwapBuffers never blocks indefinitely, or - toytoolkit has a workaround, that guarantees that eglSwapBuffers will return soon, when we force a repaint on resize. Otherwise the demo will deadlock. The code is separated into three sections: 1. The library component, using only EGL, GLESv2, and libwayland-client APIs, and not aware of any toolkit details of the parent application. This runs independently until the parent application tells otherwise. 2. The glue code: a toytoolkit application widget, who has its own rendering machinery. 3. The application written in toytoolkit. This patch also adds new toytoolkit interfaces: - widget_get_wl_surface() - widget_get_last_time() - widget_input_region_add() Toytoolkit applications have not had a possibility to change the input region. The frame widget (decorations) set the input region on its own when used, otherwise the default input region of everything has been used. If a window does not have a frame widget, it can now use widget_input_region_add() to set a custom input region. These are not window methods, because a widget may lie on a different wl_surface (sub-surface) than the window. Changes in v3: - replace set_commit_mode with set_sync and set_desync Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
2013-04-25 14:57:50 +04:00
struct wl_surface *
widget_get_wl_surface(struct widget *widget);
uint32_t
widget_get_last_time(struct widget *widget);
void
widget_input_region_add(struct widget *widget, const struct rectangle *rect);
void
widget_set_redraw_handler(struct widget *widget,
widget_redraw_handler_t handler);
void
widget_set_resize_handler(struct widget *widget,
widget_resize_handler_t handler);
void
widget_set_enter_handler(struct widget *widget,
widget_enter_handler_t handler);
void
widget_set_leave_handler(struct widget *widget,
widget_leave_handler_t handler);
2012-01-09 18:36:16 +04:00
void
widget_set_motion_handler(struct widget *widget,
widget_motion_handler_t handler);
void
2012-01-09 20:12:05 +04:00
widget_set_button_handler(struct widget *widget,
widget_button_handler_t handler);
2012-08-14 13:02:41 +04:00
void
widget_set_touch_down_handler(struct widget *widget,
widget_touch_down_handler_t handler);
void
widget_set_touch_up_handler(struct widget *widget,
widget_touch_up_handler_t handler);
void
widget_set_touch_motion_handler(struct widget *widget,
widget_touch_motion_handler_t handler);
void
widget_set_touch_frame_handler(struct widget *widget,
widget_touch_frame_handler_t handler);
void
widget_set_touch_cancel_handler(struct widget *widget,
widget_touch_cancel_handler_t handler);
void
2012-08-14 13:02:41 +04:00
widget_set_axis_handler(struct widget *widget,
widget_axis_handler_t handler);
2012-01-09 20:12:05 +04:00
void
widget_set_pointer_frame_handler(struct widget *widget,
widget_pointer_frame_handler_t handler);
void
widget_set_axis_handlers(struct widget *widget,
widget_axis_handler_t axis_handler,
widget_axis_source_handler_t axis_source_handler,
widget_axis_stop_handler_t axis_stop_handler,
widget_axis_discrete_handler_t axis_discrete_handler);
clients: add a new touchscreen calibrator The new calibrator uses weston_touch_calibration protocol extension and provides the following features: - chooses the physical touch device to be calibrated by DEVPATH or by the output/head name; device enumeration provided - the compositor ensures the calibrator window is shown in the correct position and size - no matter how wrong the old calibration is, the touch events will always arrive in the application - the calibration is complete, not incremental; the received touch events are guaranteed to be unmodified - computes a libinput style calibration matrix directly, not the WL_CALIBRATION format - supports multiple touch devices: calibrate one device at a time, and show user feedback on touching a wrong device instead of recording bad data - uses four touch point samples: three to compute the calibration, and one to verify the calibration is roughly correct - consistent exit codes - upload the new calibration into the server after successful and verified calibration Due to using special touchscreen calibration protocol extension, this application cannot be tested without touch input from the compositor. Practically all of the above mentioned are unlike how the old calibrator client worked. Co-developed by Louis-Francis and Pekka. v2: - improve help() text - rename wrong_touch_handler() to invalid_touch_handler() - improve debug prints by adding sample number - reorganize code into sample funcs vs. touch funcs - add a state machine to properly process touch and related events Signed-off-by: Louis-Francis Ratté-Boulianne <lfrb@collabora.com> Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.co.uk> v1 Tested-by: Matt Hoosier <matt.hoosier@gmail.com> Reviewed-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-11-30 00:38:44 +03:00
void
window_inhibit_redraw(struct window *window);
void
window_uninhibit_redraw(struct window *window);
void
widget_schedule_redraw(struct widget *widget);
void
widget_set_use_cairo(struct widget *widget, int use_cairo);
/*
* Sets the viewport destination for the widget's surface
* return 0 on success and -1 on failure. Set width and height to
* -1 to reset the viewport.
*/
int
widget_set_viewport_destination(struct widget *widget, int width, int height);
struct widget *
window_frame_create(struct window *window, void *data);
void
window_frame_set_child_size(struct widget *widget, int child_width,
int child_height);
void
input_set_pointer_image(struct input *input, int pointer);
2010-08-18 23:28:04 +04:00
void
input_get_position(struct input *input, int32_t *x, int32_t *y);
int
input_get_touch(struct input *input, int32_t id, float *x, float *y);
#define MOD_SHIFT_MASK 0x01
#define MOD_ALT_MASK 0x02
#define MOD_CONTROL_MASK 0x04
uint32_t
input_get_modifiers(struct input *input);
void
touch_grab(struct input *input, int32_t touch_id);
void
touch_ungrab(struct input *input);
void
input_grab(struct input *input, struct widget *widget, uint32_t button);
void
input_ungrab(struct input *input);
struct widget *
input_get_focus_widget(struct input *input);
struct display *
input_get_display(struct input *input);
struct wl_seat *
input_get_seat(struct input *input);
struct wl_data_device *
input_get_data_device(struct input *input);
void
input_set_selection(struct input *input,
struct wl_data_source *source, uint32_t time);
void
input_accept(struct input *input, const char *type);
void
input_receive_drag_data(struct input *input, const char *mime_type,
data_func_t func, void *user_data);
2013-09-05 07:41:06 +04:00
int
input_receive_drag_data_to_fd(struct input *input,
const char *mime_type, int fd);
int
input_receive_selection_data(struct input *input, const char *mime_type,
data_func_t func, void *data);
int
input_receive_selection_data_to_fd(struct input *input,
const char *mime_type, int fd);
void
output_set_user_data(struct output *output, void *data);
void *
output_get_user_data(struct output *output);
void
output_set_destroy_handler(struct output *output,
display_output_handler_t handler);
2011-11-27 02:27:37 +04:00
void
output_get_allocation(struct output *output, struct rectangle *allocation);
struct wl_output *
output_get_wl_output(struct output *output);
2011-11-27 02:27:37 +04:00
enum wl_output_transform
output_get_transform(struct output *output);
2013-05-22 16:41:27 +04:00
uint32_t
output_get_scale(struct output *output);
const char *
output_get_make(struct output *output);
const char *
output_get_model(struct output *output);
void
keysym_modifiers_add(struct wl_array *modifiers_map,
const char *name);
xkb_mod_mask_t
keysym_modifiers_get_mask(struct wl_array *modifiers_map,
const char *name);
struct toytimer;
typedef void (*toytimer_cb)(struct toytimer *);
struct toytimer {
struct display *display;
struct task tsk;
int fd;
toytimer_cb callback;
};
void
toytimer_init(struct toytimer *tt, clockid_t clock, struct display *display,
toytimer_cb callback);
void
toytimer_fini(struct toytimer *tt);
void
toytimer_arm(struct toytimer *tt, const struct itimerspec *its);
void
toytimer_arm_once_usec(struct toytimer *tt, uint32_t usec);
void
toytimer_disarm(struct toytimer *tt);
#endif