Skip to content

Instantly share code, notes, and snippets.

@d3x0r

d3x0r/README.md Secret

Created October 5, 2020 20:23
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save d3x0r/a1bf071d4031121baae7bca01d2a11f0 to your computer and use it in GitHub Desktop.
Save d3x0r/a1bf071d4031121baae7bca01d2a11f0 to your computer and use it in GitHub Desktop.
Download ZIP
Wayland crash
Raw
README.md

Please do not run this on a primary desktop.

./mk.sh
./a.out *crash*
Raw
mk.sh
gcc vidlib.wayland.c xdg-shell-protocol.c -lwayland-client
Raw
vidlib.wayland.c
// much core wayland interface code from...
// https://jan.newmarch.name/Wayland/ProgrammingClient/
// https://jan.newmarch.name/Wayland/WhenCanIDraw/
//
#define USE_IMAGE_INTERFACE wl.pii
#include <unistd.h>
#include <stdlib.h>
#include <sched.h>
#include <string.h>
#include <errno.h>
//#include <stdhdrs.h>
#include <sys/mman.h>
#include <fcntl.h>
#include <wayland-client.h>
#include "xdg-shell-client-protocol.h"
#include <xkbcommon/xkbcommon.h>
#include <linux/input-event-codes.h>
#define DebugBreak() (0)
#define lprintf(f,...) printf( f "\n",##__VA_ARGS__ )
#define New(n) ((n*)malloc(sizeof(n)))
typedef struct wvideo_tag* PRENDERER;
enum buttonRedefin {
MK_LBUTTON = 1,
MK_RBUTTON = 2,
MK_MBUTTON = 4,
KEY_CONTROL_DOWN = 8,
KEY_SHIFT_DOWN = 16,
KEY_ALT_DOWN = 32,
};
typedef struct wvideo_tag
{
struct {
uint32_t bShown : 1;
uint32_t bDestroy : 1;
uint32_t bFocused : 1;
uint32_t dirty : 1;
uint32_t canCommit : 1;
uint32_t wantDraw : 1;
uint32_t hidden : 1; // tracks whether the window is visible or not.
} flags;
int32_t x, y;
uint32_t w, h;
struct wvideo_tag* under; // this window is under this reference
struct wvideo_tag* above; // this window is above the one pointed here
struct wl_surface* surface;
struct wl_shell_surface *shell_surface;
struct wl_subsurface *sub_surface;
struct xdg_toplevel *xdg_toplevel;
uint32_t * shm_data;
struct wl_buffer *buff;
int curBuffer;
uint32_t bufw, bufh;
//enum sizeDisplayValues changedEdge; // when resized, this is how to copy the existing image.
int freeBuffer[2];
struct wl_buffer * buffers[2];
uint32_t *color_buffers[2];
size_t buffer_sizes[2];
struct wl_shm_pool *pool;
struct wl_callback *frame_callback; // request for WM_PAINT
} XPANEL, *PXPANEL;
struct pointer_data {
struct wl_surface *surface;
struct wl_buffer *buffer;
int32_t hot_spot_x;
int32_t hot_spot_y;
struct wl_surface *target_surface;
};
struct output_data {
struct wl_output *wl_output;
int x, y;
int w, h;
int w_mm, h_mm;
int32_t scale;
int32_t pending_scale;
};
enum WAYLAND_INTERFACE_STRING {
wis_compositor,
wis_output,
wis_subcompositor,
wis_shell,
wis_seat,
wis_shm,
wis_xdg_base,
wis_xdg_shell,
#ifdef ALLOW_KDE
wis_kde_shell,
#endif
max_interface_versions
};
struct wayland_local_tag
{
struct {
volatile uint32_t bInited : 1;
uint32_t bLogKeyEvent:1;
} flags;
int dirty;
int commit;
struct wl_event_queue* queue;
struct wl_display* display;
struct wl_compositor* compositor;
struct wl_subcompositor* subcompositor;
struct wl_shm *shm;
volatile int registering; // valid pixel format found.
int canDraw; // valid pixel format found.
struct wl_shell *shell;
struct xdg_wm_base *xdg_wm_base;
struct xdg_shell *xdg_shell;
struct wl_seat *seat;
struct wl_pointer *pointer;
int32_t mouseSerial;
struct pointer_data pointer_data ;
struct wl_keyboard *keyboard;
struct xkb_context *xkb_context;
struct xkb_keymap *keymap;
struct xkb_state *xkb_state;
int versions[max_interface_versions]; // reported versions
int screen_width;
int screen_height;
int screen_num;
/* these variables will be used to store the IDs of the black and white */
/* colors of the given screen. More on this will be explained later. */
unsigned long white_pixel;
unsigned long black_pixel;
//-------------- Global seat/input tracking
struct mouse {
int32_t x, y;
uint32_t b;
}mouse_;
int keyMods;
uint32_t utfKeyCode;
xkb_keysym_t keysym;
PXPANEL hVidFocused; // keyboard events go here
PXPANEL hCaptured; // send all mouse events here (probalby should-no-op this)
};
// these(name and version) should be merged into a struct.
//static int supportedVersions[max_interface_versions] = {4,1,1,1,7,1,1,1};
static struct interfaceVersionInfo {
char const *name;
int const version;
} interfaces [max_interface_versions] = {
[wis_compositor]={ "wl_compositor", 4 }
,[wis_output]={ "wl_output", 3 }
,[wis_subcompositor]={ "wl_subcompositor", 1 }
,[wis_shell]={ "wl_shell", 1 }
,[wis_seat]={ "wl_seat", 7 }
,[wis_shm]= { "wl_shm", 1 }
,[wis_xdg_shell]={ "zxdg_shell_v6", 1 }
,[ wis_xdg_base]={NULL,1 }
#ifdef ALLOW_KDE
,[wis_kde_shell]={ "org_kde_plasma_shell", 1 }
#endif
};
struct wayland_local_tag wl;
/*
wl_compositor id 1
wl_subcompositor id 2
wp_viewporter id 3
zxdg_output_manager_v1 id 4
wp_presentation id 5
zwp_relative_pointer_manager_v1 id 6
zwp_pointer_constraints_v1 id 7
zwp_input_timestamps_manager_v1 id 8
wl_data_device_manager id 9
wl_shm id 10
wl_drm id 11
wl_seat id 12
zwp_linux_dmabuf_v1 id 13
weston_direct_display_v1 id 14
zwp_linux_explicit_synchronization_v1 id 15
weston_content_protection id 16
wl_output id 17
wl_output id 18
zwp_input_panel_v1 id 19
zwp_input_method_v1 id 20
zwp_text_input_manager_v1 id 21
xdg_wm_base id 22
zxdg_shell_v6 id 23
wl_shell id 24
weston_desktop_shell id 25
weston_screenshooter id 26
*/
static void output_geometry(void *data, struct wl_output *wl_output, int32_t x,
int32_t y, int32_t physical_width, int32_t physical_height,
int32_t subpixel, const char *make, const char *model, int32_t transform)
{
struct output_data *output_data = wl_output_get_user_data(wl_output);
(void)data;
(void)wl_output;
(void)x;
(void)y;
(void)physical_width;
(void)physical_height;
(void)subpixel;
(void)make;
(void)model;
(void)transform;
lprintf( "Screen geometry: %d %d %d %d", x, y, physical_height, physical_width );
output_data->x = x;
output_data->y = y;
output_data->w_mm = physical_width;
output_data->h_mm = physical_height;
}
static void output_mode(void *data, struct wl_output *wl_output, uint32_t flags,
int32_t width, int32_t height, int32_t refresh)
{
struct output_data *output_data = wl_output_get_user_data(wl_output);
(void)data;
(void)wl_output;
(void)flags;
(void)width;
(void)height;
(void)refresh;
// refresh/1000 = hz
if( flags ) {
if( flags & WL_OUTPUT_MODE_CURRENT ) {
output_data->w = width;
output_data->h = height;
}
//lprintf( "Screen mode:%d %d %d %d ", flags, width, height, refresh );
}
}
static void output_done(void *data, struct wl_output *wl_output)
{
(void)data;
struct output_data *output_data = wl_output_get_user_data(wl_output);
output_data->scale = output_data->pending_scale;
}
static void output_scale(void *data, struct wl_output *wl_output, int32_t factor)
{
(void)data;
struct output_data *output_data = wl_output_get_user_data(wl_output);
output_data->pending_scale = factor;
lprintf( "Scale? %d", factor );
}
static void
shm_format(void *data, struct wl_shm *wl_shm, uint32_t format)
{
char *s;
switch (format) {
case WL_SHM_FORMAT_ARGB8888: s = "ARGB8888";
wl.canDraw = 1;
wl.registering = 0;
break;
case WL_SHM_FORMAT_XRGB8888: s = "XRGB8888"; break;
case WL_SHM_FORMAT_RGB565: s = "RGB565"; break;
default: s = "other format"; break;
}
//lprintf( "Possible shmem format %s", s);
}
static struct wl_shm_listener shm_listener = {
shm_format
};
static const struct wl_output_listener output_listener = {
.geometry = output_geometry,
.mode = output_mode,
.done = output_done,
.scale = output_scale,
};
static void pointer_enter(void *data,
struct wl_pointer *wl_pointer,
uint32_t serial, struct wl_surface *surface,
wl_fixed_t surface_x, wl_fixed_t surface_y)
{
struct pointer_data *pointer_data;
pointer_data = data;//wl_pointer_get_user_data(wl_pointer);
pointer_data->target_surface = surface;
/*
wl_surface_attach(pointer_data->surface,
pointer_data->buffer, 0, 0);
wl_surface_commit(pointer_data->surface);
*/
//wl_pointer_set_cursor(wl_pointer, serial,
// pointer_data->surface, pointer_data->hot_spot_x,
// pointer_data->hot_spot_y);
wl.mouse_.x = surface_x >> 8;
wl.mouse_.y = surface_y >> 8;
lprintf( "Mouse Enter" );
PXPANEL r = wl_surface_get_user_data(
pointer_data->target_surface);
}
static void pointer_leave(void *data,
struct wl_pointer *wl_pointer, uint32_t serial,
struct wl_surface *wl_surface) {
struct pointer_data* pointer_data = data;//wl_pointer_get_user_data(wl_pointer);
PXPANEL r = wl_surface_get_user_data(
pointer_data->target_surface);
lprintf( "Mouse Leave" );
}
static void pointer_motion(void *data,
struct wl_pointer *wl_pointer, uint32_t time,
wl_fixed_t surface_x, wl_fixed_t surface_y) {
struct pointer_data* pointer_data = data;//wl_pointer_get_user_data(wl_pointer);
wl.mouse_.x = surface_x>>8;
wl.mouse_.y = surface_y>>8;
lprintf( "mouse motion:%d %d", wl.mouse_.x, wl.mouse_.y );
PXPANEL r = wl_surface_get_user_data(
pointer_data->target_surface);
}
static void pointer_button(void *data,
struct wl_pointer *wl_pointer, uint32_t serial,
uint32_t time, uint32_t button, uint32_t state)
{
struct pointer_data *pointer_data;
PXPANEL r;
void (*callback)(uint32_t);
wl.mouseSerial = serial;
lprintf( "pointer button:%d %d", button, state);
pointer_data = data;//wl_pointer_get_user_data(wl_pointer);
if( button == BTN_LEFT ) {
if( state )
wl.mouse_.b |= MK_LBUTTON;
else
wl.mouse_.b &= ~MK_LBUTTON;
}
if( button == BTN_RIGHT ) {
if( state )
wl.mouse_.b |= MK_RBUTTON;
else
wl.mouse_.b &= ~MK_RBUTTON;
}
if( button == BTN_MIDDLE ) {
if( state )
wl.mouse_.b |= MK_MBUTTON;
else
wl.mouse_.b &= ~MK_MBUTTON;
}
r = wl_surface_get_user_data(
pointer_data->target_surface);
}
static void pointer_axis(void *data,
struct wl_pointer *wl_pointer, uint32_t time,
uint32_t axis, wl_fixed_t value) { }
static void pointer_frame( void *data,
struct wl_pointer *wl_pointer) { }
static void pointer_axis_source(void *data,
struct wl_pointer *wl_pointer,
uint32_t axis_source){}
static void pointer_axis_stop(void *data,
struct wl_pointer *wl_pointer,
uint32_t time,
uint32_t axis){}
static void pointer_axis_discrete(void *data,
struct wl_pointer *wl_pointer,
uint32_t axis,
int32_t discrete){}
static const struct wl_pointer_listener pointer_listener = {
.enter = pointer_enter,
.leave = pointer_leave,
.motion = pointer_motion,
.button = pointer_button,
.axis = pointer_axis,
.frame = pointer_frame,
.axis_source =pointer_axis_source,
.axis_stop =pointer_axis_stop,
.axis_discrete =pointer_axis_discrete,
//.release = pointer_release
};
static void keyboard_keymap(void *data,
struct wl_keyboard *wl_keyboard,
uint32_t format,
int32_t fd,
uint32_t size)
{
switch( format ) {
case WL_KEYBOARD_KEYMAP_FORMAT_NO_KEYMAP:
break;
case WL_KEYBOARD_KEYMAP_FORMAT_XKB_V1:
;
//lprintf( "Well here's a map...");
#if 0
char *keymap_string = mmap (NULL, size, PROT_READ, MAP_PRIVATE, fd, 0);
//lprintf( "mmap:%p %d", keymap_string, errno );
xkb_keymap_unref (wl.keymap);
wl.keymap = xkb_keymap_new_from_string (wl.xkb_context, keymap_string, XKB_KEYMAP_FORMAT_TEXT_V1, XKB_KEYMAP_COMPILE_NO_FLAGS);
munmap (keymap_string, size);
close (fd);
xkb_state_unref (wl.xkb_state);
wl.xkb_state = xkb_state_new (wl.keymap);
#endif
break;
}
}
static void keyboard_enter(void *data,
struct wl_keyboard *wl_keyboard,
uint32_t serial,
struct wl_surface *surface,
struct wl_array *keys)
{
PXPANEL r = (PXPANEL) wl_surface_get_user_data( surface );
}
static void keyboard_leave(void *data,
struct wl_keyboard *wl_keyboard,
uint32_t serial,
struct wl_surface *surface){
if( surface ) {
PXPANEL r = (PXPANEL) wl_surface_get_user_data( surface );
}
wl.hVidFocused = NULL;
}
static void keyboard_key(void *data,
struct wl_keyboard *wl_keyboard,
uint32_t serial,
uint32_t time,
uint32_t key,
uint32_t state)
{
PXPANEL r = wl.hVidFocused;
if( !r ) {
lprintf( "No focused window....");
return;
}
//lprintf( "KEY: %p %d %d %d %d", wl_keyboard, serial, time, key, state );
}
static void keyboard_modifiers(void *data,
struct wl_keyboard *wl_keyboard,
uint32_t serial,
uint32_t mods_depressed,
uint32_t mods_latched,
uint32_t mods_locked,
uint32_t group)
{
wl.keyMods = 0;
if( mods_depressed & 1 ) {
//wl.keyMods |= KEY_MOD_SHIFT;
wl.keyMods |= KEY_SHIFT_DOWN;
}
if( mods_depressed & 4 ) {
wl.keyMods |= KEY_CONTROL_DOWN;
}
if( mods_depressed & 8 ) {
wl.keyMods |= KEY_ALT_DOWN;
}
// I get an initial state of nil,0,0,0,N
//lprintf( "MOD: %p %d %x %x %d", mods_depressed, mods_latched, mods_locked, group );
}
static const char * sack_wayland_GetKeyText ( int key ){
static char buf[6];
lprintf( "assuming key was the one dispatched....");
return buf;
}
static void keyboard_repeat_info(void *data,
struct wl_keyboard *wl_keyboard,
int32_t rate,
int32_t delay){
lprintf( "Why do I care about the repeat? %d %d", rate, delay );
}
static const struct wl_keyboard_listener keyboard_listener = {
.keymap = keyboard_keymap,
.enter = keyboard_enter,
.leave = keyboard_leave,
.key = keyboard_key,
.modifiers = keyboard_modifiers,
.repeat_info = keyboard_repeat_info,
};
static void xdg_surface_configure ( void *data, struct xdg_surface* xdg_surface, uint32_t serial ){
PXPANEL r= (PXPANEL)data;
xdg_surface_ack_configure( xdg_surface, serial );
}
static struct xdg_surface_listener const xdg_surface_listener = {
.configure = xdg_surface_configure,
};
static void xdg_wm_base_ping( void*data, struct xdg_wm_base*base, uint32_t serial){
xdg_wm_base_pong( base,serial);
}
static struct xdg_wm_base_listener const xdg_wm_base_listener = {
.ping = xdg_wm_base_ping,
};
static void
global_registry_handler(void *data, struct wl_registry *registry, uint32_t id,
const char *interface, uint32_t version)
{
static volatile int processing;
while( processing ) sched_yield();
processing = 1;
int n;
for( n = 0; n < sizeof( interfaces )/sizeof(interfaces[0] ); n++ ){
if( strcmp( interface, interfaces[n].name ) == 0 ){
//lprintf( "Is: %s %s ", interface, interfaces[n]);
wl.versions[n] = version;
if( version < interfaces[n].version ){
lprintf( "Interface %d:%s is version %d and library expects %d",
n, interfaces[n].name, version, interfaces[n].version );
}
if( interfaces[n].version < version ){
lprintf( "Interface %d:%s is version %d and library only supports %d",
n, interfaces[n].name, version, interfaces[n].version );
version = interfaces[n].version;
}
break;
}
}
lprintf("Got a registry event for %s id %d %d", interface, id, n);
if( n == wis_compositor ) {
wl.compositor = wl_registry_bind(registry,
id,
&wl_compositor_interface,
version);
} else if( n == wis_subcompositor ) {
wl.subcompositor = wl_registry_bind(registry,
id,
&wl_subcompositor_interface,
version);
//} else if( n == wis_zwp_linux_dmabuf_v1] ) {
//lprintf( "Well, fancy that,we get DMA buffers?");
// can video fullscreen
} else if( n == wis_shell ) {
wl.shell = wl_registry_bind(registry, id,
&wl_shell_interface, version);
#ifdef ALLOW_KDE
} else if( n == wis_kde_shell ) {
wl.shell = wl_registry_bind(registry, id,
&org_kde_plasma_shell_interface, version);
#endif
} else if( n == wis_xdg_shell ) {
//wl.xdg_shell = wl_registry_bind(registry, id,
// &, version);
} else if( n == wis_xdg_base ) {
wl.xdg_wm_base = wl_registry_bind(registry, id,
&xdg_wm_base_interface, version);
xdg_wm_base_add_listener( wl.xdg_wm_base, &xdg_wm_base_listener, NULL );
} else if( n == wis_seat ) {
wl.seat = wl_registry_bind(registry, id,
&wl_seat_interface, version>2?version:version);
wl.pointer = wl_seat_get_pointer(wl.seat);
wl.pointer_data.surface = wl_compositor_create_surface(wl.compositor);
wl_pointer_add_listener(wl.pointer, &pointer_listener, &wl.pointer_data);
wl.keyboard = wl_seat_get_keyboard(wl.seat );
wl_keyboard_add_listener(wl.keyboard, &keyboard_listener, NULL );
} else if( n == wis_shm ) {
wl.shm = wl_registry_bind(registry, id,
&wl_shm_interface, version);
wl_shm_add_listener(wl.shm, &shm_listener, NULL);
}
processing = 0;
}
static void
global_registry_remover(void *data, struct wl_registry *registry, uint32_t id)
{
lprintf("Got a registry losing event for %d", id);
}
static const struct wl_registry_listener registry_listener = {
global_registry_handler,
global_registry_remover
};
static const struct wl_interface interface_listener = {
};
static void initConnections( void ) {
wl.display = wl_display_connect(NULL);
if (wl.display == NULL) {
lprintf( "Can't connect to display");
return;
}
//wl.queue = wl_display_create_queue( wl.display );
//wl_proxy_create( NULL, )
wl.flags.bInited = 1;
interfaces[wis_xdg_base].name = xdg_wm_base_interface.name;
}
static void finishInitConnections( void ) {
//wl.xkb_context = xkb_context_new (XKB_CONTEXT_NO_FLAGS);
wl.registering = 1;
struct wl_registry *registry = wl_display_get_registry(wl.display);
wl_registry_add_listener(registry, &registry_listener, NULL);
//wl_proxy_set_queue( (struct wl_proxy*)registry, wl.queue );
wl_display_roundtrip(wl.display);
//while( wl.registering )sched_yield(); // wait one more time, the last prior thing might take a bit.
wl_registry_destroy(registry);
//lprintf( "and we finish with %p %d", wl.compositor, wl.canDraw );
#if 0
/// dump all the versions found, so supportedVersions can be udpated.
{
int n;
for( n = 0; n < sizeof( interfaces )/sizeof(interfaces[0] ); n++ ){
lprintf( "interface %d %s v %d", n, interfaces[n], wl.versions[n] );
}
}
#endif
if( !wl.shell&& !wl.xdg_wm_base ){
lprintf( "Can't find wl_shell.");
//DebugBreak();
}
if (!wl.compositor || !wl.canDraw ) {
//DebugBreak();
lprintf( "Can't find compositor or no supported pixel format found.");
return;
} else {
//lprintf( "Found compositor");
}
wl.dirty = 0;
}
static int
set_cloexec_or_close(int fd)
{
long flags;
if (fd == -1)
return -1;
flags = fcntl(fd, F_GETFD);
if (flags == -1)
goto err;
if (fcntl(fd, F_SETFD, flags | FD_CLOEXEC) == -1)
goto err;
return fd;
err:
close(fd);
return -1;
}
static int
create_tmpfile_cloexec(char *tmpname)
{
int fd;
#ifdef HAVE_MKOSTEMP
fd = mkostemp(tmpname, O_CLOEXEC);
if (fd >= 0)
unlink(tmpname);
#else
fd = mkstemp(tmpname);
if (fd >= 0) {
fd = set_cloexec_or_close(fd);
unlink(tmpname);
}
#endif
return fd;
}
/*
* Create a new, unique, anonymous file of the given size, and
* return the file descriptor for it. The file descriptor is set
* CLOEXEC. The file is immediately suitable for mmap()'ing
* the given size at offset zero.
*
* The file should not have a permanent backing store like a disk,
* but may have if XDG_RUNTIME_DIR is not properly implemented in OS.
*
* The file name is deleted from the file system.
*
* The file is suitable for buffer sharing between processes by
* transmitting the file descriptor over Unix sockets using the
* SCM_RIGHTS methods.
*/
int os_create_anonymous_file(off_t size)
{
static const char template[] = "/weston-shared-XXXXXX";
const char *path;
char *name;
int fd;
path = getenv("XDG_RUNTIME_DIR");
if (!path) {
errno = ENOENT;
return -1;
}
name = malloc(strlen(path) + sizeof(template));
if (!name)
return -1;
strcpy(name, path);
strcat(name, template);
fd = create_tmpfile_cloexec(name);
free(name);
if (fd < 0)
return -1;
if (ftruncate(fd, size) < 0) {
close(fd);
return -1;
}
return fd;
}
static void redraw( void *data, struct wl_callback* callback, uint32_t time );
static const struct wl_callback_listener frame_listener = {
redraw
};
static void releaseBuffer( void*data, struct wl_buffer*wl_buffer );
static const struct wl_buffer_listener buffer_listener = {
.release = releaseBuffer,
};
static struct wl_buffer * allocateBuffer( PXPANEL r )
{
int stride = r->w * 4; // 4 bytes per pixel
int size = stride * r->h;
int fd;
fd = os_create_anonymous_file(size);
if (fd < 0) {
lprintf( "creating a buffer file for %d B failed: %m\n",
size);
return 0;
}
r->buffer_sizes[r->curBuffer] = size;
r->shm_data = mmap(NULL, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
if (r->shm_data == MAP_FAILED) {
lprintf( "mmap failed: %m\n");
close(fd);
return 0;
}
struct wl_shm_pool *pool = wl_shm_create_pool(wl.shm, fd, size);
r->buff = wl_shm_pool_create_buffer(pool, 0, /* starting offset */
r->w, r->h,
stride,
WL_SHM_FORMAT_ARGB8888);
wl_buffer_add_listener( r->buff, &buffer_listener, r );
wl_shm_pool_destroy(pool);
return r->buff;
}
static void clearBuffer( PXPANEL r ) {
//if( r->flags.hidden ) return;
wl_surface_attach( r->surface, NULL, 0, 0);
}
static struct wl_buffer * nextBuffer( PXPANEL r, int attach ) {
if( r->flags.hidden ) {
lprintf( "window is hidden... returning a fault.");
return NULL;
}
if( r->freeBuffer[r->curBuffer] && ( r->bufw == r->w && r->bufh == r->h ) ) {
//lprintf( "Can just use the current image... it's already attached", r->buff);
return r->buff;
}
r->curBuffer=1-r->curBuffer;
//lprintf( "using image to a new image.... %d",r->curBuffer );
if( r->bufw != r->w || r->bufh != r->h ) {
// if the buffer has to change size, we need a new one....
// maybe can keep this around to fill a copy of the prior window?
//lprintf( "Remove Old Buffer");
if( r->color_buffers[r->curBuffer] ) {
munmap( r->color_buffers[r->curBuffer], r->buffer_sizes[r->curBuffer] );
if( r->buffers[r->curBuffer] )
wl_buffer_destroy( r->buffers[r->curBuffer] );
}
r->w = r->bufw;
r->h = r->bufh;
r->buffers[r->curBuffer] = NULL;
r->color_buffers[r->curBuffer] = NULL;
}
// setup the current values to this buffer...
r->shm_data = r->color_buffers[r->curBuffer];
r->buff = r->buffers[r->curBuffer];
if( !r->buff ) {
//lprintf( "Allocate NEW buffer" );
// haven't actually allocated a bufer yet... so do so...
allocateBuffer(r);
r->buffers[r->curBuffer] = r->buff;
r->color_buffers[r->curBuffer] = r->shm_data;
r->freeBuffer[r->curBuffer] = 1;
}
wl_surface_attach( r->surface, r->buff, 0, 0);
return r->buff;
}
void redraw( void *data, struct wl_callback* callback, uint32_t time ) {
PXPANEL r = (PXPANEL)data;
if( r->frame_callback ) wl_callback_destroy( r->frame_callback );
if( !r->flags.bDestroy ) {
// schedule another callback.
r->frame_callback = wl_surface_frame( r->surface );
wl_callback_add_listener( r->frame_callback, &frame_listener, r );
//lprintf( "frame callback - check dirty %d %d %d", r->flags.dirty, r->flags.canCommit );
if( r->flags.dirty ){
r->flags.canCommit = 0;
r->flags.dirty = 0;
//lprintf( "Window is dirty, do commit");
struct wl_buffer *next = nextBuffer(r, 0);
wl_surface_commit( r->surface );
wl_surface_attach( r->surface, next, 0, 0 );
// wait until we actually NEED the buffer, maybe we can use the same one.
}else {
//lprintf( "Allow window to be commited at will.");
r->flags.canCommit = 1;
}
}else
r->flags.canCommit = 1;
}
static int InitializeDisplay( void ) {
return 1;
}
static void shutdownDisplay( void ) {
wl_display_disconnect(wl.display);
}
void DoDestroy (PRENDERER hVideo) {
}
static void
handle_ping(void *data, struct wl_shell_surface *shell_surface,
uint32_t serial)
{
//PXPANEL r = (PXPANEL)data;
wl_shell_surface_pong(shell_surface, serial);
//lprintf("Pinged and ponged");
}
static void sack_wayland_Redraw( PRENDERER renderer );
static void
handle_configure(void *data, struct wl_shell_surface *shell_surface,
uint32_t edges, int32_t width, int32_t height)
{
PXPANEL r = (PXPANEL)data;
r->bufw = width;
r->bufh = height;
sack_wayland_Redraw((PRENDERER)r);
//wl_surface_commit( r->surface );
//r->changedEdge = edges;
lprintf( "shell configure %d %d", width, height );
}
static void
handle_popup_done(void *data, struct wl_shell_surface *shell_surface)
{
PXPANEL r = (PXPANEL)data;
lprintf( "shell exit");
}
static const struct wl_shell_surface_listener shell_surface_listener = {
handle_ping,
handle_configure,
handle_popup_done,
};
void releaseBuffer( void*data, struct wl_buffer*wl_buffer ){
PXPANEL r = (PXPANEL)data;
int n;
for( n = 0; n < 2; n++ ) {
//lprintf( "is %p %p?", r->buffers[n] , wl_buffer );
if( r->buffers[n] == wl_buffer ) {
//lprintf( "Buffer %d is free again", n );
r->freeBuffer[n] = 1;
break;
}
}
if( n == 2 ) {
lprintf( "Released buffer isn't on this surface?");
}
//lprintf( "Buffer is released, you can draw now..." );
//if( !)
//r->surface
//wl_surface_attach(r->surface, r->buff, 0, 0);
}
int CreateWindowStuff(PXPANEL r, PXPANEL parent )
{
//lprintf( "-----Create WIndow Stuff----- %s %s", hVideo->flags.bLayeredWindow?"layered":"solid"
// , hVideo->flags.bChildWindow?"Child(tool)":"user-selectable" );
//DebugBreak();
if (r->x == -1 || r->y == -1 )
{
uint32_t w, h;
if( r->x == -1 )
r->x = w * 7 / 10;
if( r->y == -1 )
r->y = h * 7 / 10;
}
r->surface = wl_compositor_create_surface(wl.compositor);
if (r->surface == NULL) {
lprintf( "Can't create surface");
return 0;
}
wl_surface_set_user_data(r->surface, r);
if( parent ) {
r->sub_surface = wl_subcompositor_get_subsurface( wl.subcompositor, r->surface, parent->surface );
wl_subsurface_set_user_data(r->sub_surface, r);
} else {
if(wl.shell/* && !wl.xdg_wm_base*/) {
lprintf( "Attach wl_shell");
r->shell_surface = wl_shell_get_shell_surface(wl.shell, r->surface);
wl_shell_surface_add_listener( r->shell_surface, &shell_surface_listener, r );
wl_shell_surface_set_toplevel(r->shell_surface);
wl_shell_surface_set_user_data(r->shell_surface, r);
}
if(wl.xdg_wm_base) {
lprintf( "Attach xdg_shell");
r->shell_surface = (struct wl_shell_surface*)xdg_wm_base_get_xdg_surface( wl.xdg_wm_base, r->surface );
xdg_surface_add_listener( (struct xdg_surface*)r->shell_surface, &xdg_surface_listener, r );
r->xdg_toplevel = xdg_surface_get_toplevel( (struct xdg_surface*)r->shell_surface );
//xdg_toplevel_set_title( r->xdg_toplevel, "I DOn't want a title");
xdg_surface_set_user_data((struct xdg_surface*)r->shell_surface, r);
// must commit to get a config
wl_surface_commit( r->surface );
// must also wait to get config.
wl_display_roundtrip(wl.display);
}
if (r->shell_surface == NULL) {
lprintf("Can't create shell surface");
return 0;
}
}
return 1;
}
void ShutdownVideo( void )
{
if( wl.flags.bInited )
{
}
}
static void sack_wayland_Redraw( PRENDERER renderer ) {
PXPANEL r = (PXPANEL)renderer;
struct wl_buffer *b = nextBuffer(r,1);
//lprintf( "(get new buffer)Issue redraw on renderer %p %p", renderer, b );
if( !b )DebugBreak();
//wl_display_flush( wl.display );
wl_display_roundtrip(wl.display);
}
static void sack_wayland_SetApplicationTitle( char const *title ){
//xdg_toplevel_set_title( r->xdg_toplevel, "I DOn't want a title");
}
static PRENDERER sack_wayland_OpenDisplayAboveUnderSizedAt(uint32_t attr , uint32_t w, uint32_t h, int32_t x, int32_t y, PRENDERER above, PRENDERER under ){
struct wvideo_tag *rAbove = (struct wvideo_tag*)above;
struct wvideo_tag *rUnder = (struct wvideo_tag*)under;
struct wvideo_tag *r;
r = New( struct wvideo_tag );
memset( r, 0, sizeof( *r ) );
r->flags.canCommit = 1;
r->above = rAbove;
r->under = rUnder;
r->bufw = r->w = w;
r->bufh = r->h = h;
r->x = x;
r->y = y;
// eventually we'll need a commit callback.
while( !wl.flags.bInited ) {
lprintf( "Waiting for wayland setup...");
sched_yield();
}
if( !CreateWindowStuff( r, rAbove ) ) {
lprintf( "Failed to create drawing surface... falling back to offscreen rendering?");
}else {
r->frame_callback = wl_surface_frame( r->surface );
wl_callback_add_listener( r->frame_callback, &frame_listener, r );
}
return (PRENDERER)r;
}
static PRENDERER sack_wayland_OpenDisplayAboveSizedAt(uint32_t attr , uint32_t w, uint32_t h, int32_t x, int32_t y, PRENDERER above ){
return sack_wayland_OpenDisplayAboveUnderSizedAt( attr, w, h, x, y, above, NULL );
}
static PRENDERER sack_wayland_OpenDisplaySizedAt(uint32_t attr , uint32_t w, uint32_t h, int32_t x, int32_t y){
return sack_wayland_OpenDisplayAboveUnderSizedAt( attr, w, h, x, y, NULL, NULL );
}
static void sack_wayland_CloseDisplay( PRENDERER renderer ) {
struct wvideo_tag *r = (struct wvideo_tag*)renderer;
if( wl.hVidFocused == r ) wl.hVidFocused = NULL;
if( wl.hCaptured == r ) wl.hCaptured = NULL;
r->flags.bDestroy = 1;
if( r->sub_surface )
wl_subsurface_destroy( r->sub_surface );
if( r->shell_surface ) {
if( wl.xdg_wm_base ) {
if( r->xdg_toplevel )
xdg_toplevel_destroy( r->xdg_toplevel );
xdg_surface_destroy( (struct xdg_surface*)r->shell_surface );
}else
wl_shell_surface_destroy( r->shell_surface );
}
lprintf( "Destroy surface:%p %p", r, r->surface );
wl_surface_destroy( r->surface );
}
static void sack_wayland_UpdateDisplayPortionEx(PRENDERER renderer, int32_t x, int32_t y, uint32_t w, uint32_t h ){
struct wvideo_tag *r = (struct wvideo_tag*)renderer;
wl_surface_damage( r->surface, x, y, w, h );
if( r->flags.canCommit ){
//lprintf( "Updating now - getting new buffer, commit, flush, roundtrip, and attach the new buffer");
struct wl_buffer *next = nextBuffer(r, 0);
r->flags.canCommit = 0;
r->flags.dirty = 0; // don't need a commit.
wl_surface_commit( r->surface );
wl_display_flush( wl.display );
//if( wl.xdg_wm_base )
// wl_display_roundtrip_queue(wl.display, wl.queue);
wl_surface_attach( r->surface, next, 0, 0 );
}else {
//lprintf( "update portion, was not ready yet, wait for callback");
}
}
static void sack_wayland_UpdateDisplayEx( PRENDERER renderer ) {
struct wvideo_tag *r = (struct wvideo_tag*)renderer;
//lprintf( "Update whole surface %d %d", r->w, r->h );
wl_surface_damage_buffer( r->surface, 0, 0, r->w, r->h );
if( r->flags.canCommit ){
//lprintf( "Updating now - getting new buffer, commit, flush, roundtrip, and attach the new buffer");
struct wl_buffer *next = nextBuffer(r, 0);
r->flags.canCommit = 0;
r->flags.dirty = 0; // don't need a commit.
wl_surface_commit( r->surface );
wl_display_flush( wl.display );
wl_surface_attach( r->surface, next, 0, 0 );
}else {
r->flags.dirty = 1;
}
}
static void sack_wayland_GetDisplayPosition( PRENDERER renderer, int32_t* x, int32_t* y, uint32_t* w, uint32_t* h ){
struct wvideo_tag *r = (struct wvideo_tag*)renderer;
}
static void sack_wayland_MoveDisplay(PRENDERER renderer, int32_t x, int32_t y){
struct wvideo_tag *r = (struct wvideo_tag*)renderer;
//lprintf( "MOVE DISPLAY %d %d", x, y);
if( r->above ){
lprintf( "MOVE SUBSURFACE" );
wl_subsurface_set_position( r->sub_surface, x, y );
}
}
static void sack_wayland_MoveDisplayRel(PRENDERER renderer, int32_t dx, int32_t dy){
struct wvideo_tag *r = (struct wvideo_tag*)renderer;
lprintf( "MOVE DISPLAYREL %d %d", dx, dy);
}
static void sack_wayland_SizeDisplay(PRENDERER renderer, uint32_t w, uint32_t h){
struct wvideo_tag *r = (struct wvideo_tag*)renderer;
}
static void sack_wayland_SizeDisplayRel(PRENDERER renderer, int32_t dw, int32_t dh){
struct wvideo_tag *r = (struct wvideo_tag*)renderer;
}
static void sack_wayland_MoveSizeDisplayRel(PRENDERER renderer, int32_t dx, int32_t dy, int32_t dw, int32_t dh){
struct wvideo_tag *r = (struct wvideo_tag*)renderer;
lprintf( "MOVESIZE" );
}
static void sack_wayland_SetRendererTitle( PRENDERER render, char const* title ){
struct wvideo_tag *r = (struct wvideo_tag*)render;
xdg_toplevel_set_title( r->xdg_toplevel, title );
}
static void sack_wayland_RestoreDisplayEx( PRENDERER renderer ){
struct wvideo_tag *r = (struct wvideo_tag*)renderer;
if( r->flags.hidden ) {
r->flags.hidden = 0;
lprintf( "RESTORE AND REDRAW" );
nextBuffer(r, 1);
}
//lprintf( "REDRAW" );
sack_wayland_Redraw( renderer );
}
static void sack_wayland_RestoreDisplay( PRENDERER renderer ){
return sack_wayland_RestoreDisplayEx( renderer );
}
static void sack_wayland_HideDisplay( PRENDERER renderer ){
struct wvideo_tag *r = (struct wvideo_tag*)renderer;
if( !r->flags.hidden ) {
r->flags.hidden = 1;
clearBuffer(r);
}
}
static void sack_wayland_GetMouseState ( int32_t *x, int32_t *y, uint32_t *b ){
if( x ) x[0] = wl.mouse_.x;
if( y ) y[0] = wl.mouse_.y;
if( b ) b[0] = wl.mouse_.b;
}
static void sack_wayland_OwnMouseEx ( PRENDERER display, uint32_t bOwn ){
struct wvideo_tag *r = (struct wvideo_tag*)display;
if( !bOwn ) {
DebugBreak();
}
lprintf( "Own Mouse - probably for move/drag... %p %d", display, bOwn );
if( bOwn )
wl.hCaptured = r;
else if( wl.hCaptured == r || !r )
wl.hCaptured = NULL;
}
static void sack_wayland_ForceDisplayFocus( PRENDERER display ) {
struct wvideo_tag *r = (struct wvideo_tag*)display;
if( r->flags.bDestroy )
{
// in the process of being destroyed... don't focus it.
return;
}
wl.hVidFocused = (PXPANEL)display;
if( !r->flags.bFocused )
r->flags.bFocused = 1;
}
static void sack_wayland_SyncRender( PRENDERER r ) {
wl_display_flush( wl.display);
wl_display_roundtrip(wl.display);
}
static void sack_wayland_GetMousePosition ( int32_t *x, int32_t *y ){
(*x) = wl.mouse_.x;
(*y) = wl.mouse_.y;
}
static void sack_wayland_BeginMoveDisplay( PRENDERER renderer ) {
PXPANEL r = (PXPANEL)renderer;
lprintf( "Issue Mouse Move %d", wl.mouseSerial );
wl.mouse_.b &= ~MK_LBUTTON;
if( wl.xdg_wm_base )
xdg_toplevel_move( r->xdg_toplevel, wl.seat, wl.mouseSerial );
else
wl_shell_surface_move( r->shell_surface, wl.seat, wl.mouseSerial );
}
//static void sack_wayland_EndMoveDisplay( PRENDERER pRenderer )
static void sack_wayland_BeginSizeDisplay( PRENDERER renderer, int mode ) {
PXPANEL r = (PXPANEL)renderer;
wl.mouse_.b &= ~MK_LBUTTON;
lprintf( "Issue Mouse SizeBgin %d", wl.mouseSerial );
if( wl.xdg_wm_base )
xdg_toplevel_resize( r->xdg_toplevel, wl.seat, wl.mouseSerial, mode );
else
wl_shell_surface_resize( r->shell_surface, wl.seat, wl.mouseSerial, mode );
}
//static void sack_wayland_EndSizeDisplay( PRENDERER pRenderer )
int main( void ) {
initConnections();
finishInitConnections();
if( wl.display) {
lprintf( "No Display found.");
}
sack_wayland_OpenDisplayAboveUnderSizedAt( 0, 256, 256, 0, 0, NULL, NULL );
while( wl_display_dispatch(wl.display) != -1 ) {
}
lprintf( "Thread exiting?" );
//wl_event_queue_destroy( wl.queue );
wl_display_disconnect( wl.display );
}
Raw
xdg-shell-client-protocol.h
/* Generated by wayland-scanner 1.18.0 */
#ifndef XDG_SHELL_CLIENT_PROTOCOL_H
#define XDG_SHELL_CLIENT_PROTOCOL_H
#include <stdint.h>
#include <stddef.h>
#include "wayland-client.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @page page_xdg_shell The xdg_shell protocol
* @section page_ifaces_xdg_shell Interfaces
* - @subpage page_iface_xdg_wm_base - create desktop-style surfaces
* - @subpage page_iface_xdg_positioner - child surface positioner
* - @subpage page_iface_xdg_surface - desktop user interface surface base interface
* - @subpage page_iface_xdg_toplevel - toplevel surface
* - @subpage page_iface_xdg_popup - short-lived, popup surfaces for menus
* @section page_copyright_xdg_shell Copyright
* <pre>
*
* Copyright © 2008-2013 Kristian Høgsberg
* Copyright © 2013 Rafael Antognolli
* Copyright © 2013 Jasper St. Pierre
* Copyright © 2010-2013 Intel Corporation
* Copyright © 2015-2017 Samsung Electronics Co., Ltd
* Copyright © 2015-2017 Red Hat Inc.
*
* 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.
* </pre>
*/
struct wl_output;
struct wl_seat;
struct wl_surface;
struct xdg_popup;
struct xdg_positioner;
struct xdg_surface;
struct xdg_toplevel;
struct xdg_wm_base;
/**
* @page page_iface_xdg_wm_base xdg_wm_base
* @section page_iface_xdg_wm_base_desc Description
*
* The xdg_wm_base interface is exposed as a global object enabling clients
* to turn their wl_surfaces into windows in a desktop environment. It
* defines the basic functionality needed for clients and the compositor to
* create windows that can be dragged, resized, maximized, etc, as well as
* creating transient windows such as popup menus.
* @section page_iface_xdg_wm_base_api API
* See @ref iface_xdg_wm_base.
*/
/**
* @defgroup iface_xdg_wm_base The xdg_wm_base interface
*
* The xdg_wm_base interface is exposed as a global object enabling clients
* to turn their wl_surfaces into windows in a desktop environment. It
* defines the basic functionality needed for clients and the compositor to
* create windows that can be dragged, resized, maximized, etc, as well as
* creating transient windows such as popup menus.
*/
extern const struct wl_interface xdg_wm_base_interface;
/**
* @page page_iface_xdg_positioner xdg_positioner
* @section page_iface_xdg_positioner_desc Description
*
* The xdg_positioner provides a collection of rules for the placement of a
* child surface relative to a parent surface. Rules can be defined to ensure
* the child surface remains within the visible area's borders, and to
* specify how the child surface changes its position, such as sliding along
* an axis, or flipping around a rectangle. These positioner-created rules are
* constrained by the requirement that a child surface must intersect with or
* be at least partially adjacent to its parent surface.
*
* See the various requests for details about possible rules.
*
* At the time of the request, the compositor makes a copy of the rules
* specified by the xdg_positioner. Thus, after the request is complete the
* xdg_positioner object can be destroyed or reused; further changes to the
* object will have no effect on previous usages.
*
* For an xdg_positioner object to be considered complete, it must have a
* non-zero size set by set_size, and a non-zero anchor rectangle set by
* set_anchor_rect. Passing an incomplete xdg_positioner object when
* positioning a surface raises an error.
* @section page_iface_xdg_positioner_api API
* See @ref iface_xdg_positioner.
*/
/**
* @defgroup iface_xdg_positioner The xdg_positioner interface
*
* The xdg_positioner provides a collection of rules for the placement of a
* child surface relative to a parent surface. Rules can be defined to ensure
* the child surface remains within the visible area's borders, and to
* specify how the child surface changes its position, such as sliding along
* an axis, or flipping around a rectangle. These positioner-created rules are
* constrained by the requirement that a child surface must intersect with or
* be at least partially adjacent to its parent surface.
*
* See the various requests for details about possible rules.
*
* At the time of the request, the compositor makes a copy of the rules
* specified by the xdg_positioner. Thus, after the request is complete the
* xdg_positioner object can be destroyed or reused; further changes to the
* object will have no effect on previous usages.
*
* For an xdg_positioner object to be considered complete, it must have a
* non-zero size set by set_size, and a non-zero anchor rectangle set by
* set_anchor_rect. Passing an incomplete xdg_positioner object when
* positioning a surface raises an error.
*/
extern const struct wl_interface xdg_positioner_interface;
/**
* @page page_iface_xdg_surface xdg_surface
* @section page_iface_xdg_surface_desc Description
*
* An interface that may be implemented by a wl_surface, for
* implementations that provide a desktop-style user interface.
*
* It provides a base set of functionality required to construct user
* interface elements requiring management by the compositor, such as
* toplevel windows, menus, etc. The types of functionality are split into
* xdg_surface roles.
*
* Creating an xdg_surface does not set the role for a wl_surface. In order
* to map an xdg_surface, the client must create a role-specific object
* using, e.g., get_toplevel, get_popup. The wl_surface for any given
* xdg_surface can have at most one role, and may not be assigned any role
* not based on xdg_surface.
*
* A role must be assigned before any other requests are made to the
* xdg_surface object.
*
* The client must call wl_surface.commit on the corresponding wl_surface
* for the xdg_surface state to take effect.
*
* Creating an xdg_surface from a wl_surface which has a buffer attached or
* committed is a client error, and any attempts by a client to attach or
* manipulate a buffer prior to the first xdg_surface.configure call must
* also be treated as errors.
*
* Mapping an xdg_surface-based role surface is defined as making it
* possible for the surface to be shown by the compositor. Note that
* a mapped surface is not guaranteed to be visible once it is mapped.
*
* For an xdg_surface to be mapped by the compositor, the following
* conditions must be met:
* (1) the client has assigned an xdg_surface-based role to the surface
* (2) the client has set and committed the xdg_surface state and the
* role-dependent state to the surface
* (3) the client has committed a buffer to the surface
*
* A newly-unmapped surface is considered to have met condition (1) out
* of the 3 required conditions for mapping a surface if its role surface
* has not been destroyed.
* @section page_iface_xdg_surface_api API
* See @ref iface_xdg_surface.
*/
/**
* @defgroup iface_xdg_surface The xdg_surface interface
*
* An interface that may be implemented by a wl_surface, for
* implementations that provide a desktop-style user interface.
*
* It provides a base set of functionality required to construct user
* interface elements requiring management by the compositor, such as
* toplevel windows, menus, etc. The types of functionality are split into
* xdg_surface roles.
*
* Creating an xdg_surface does not set the role for a wl_surface. In order
* to map an xdg_surface, the client must create a role-specific object
* using, e.g., get_toplevel, get_popup. The wl_surface for any given
* xdg_surface can have at most one role, and may not be assigned any role
* not based on xdg_surface.
*
* A role must be assigned before any other requests are made to the
* xdg_surface object.
*
* The client must call wl_surface.commit on the corresponding wl_surface
* for the xdg_surface state to take effect.
*
* Creating an xdg_surface from a wl_surface which has a buffer attached or
* committed is a client error, and any attempts by a client to attach or
* manipulate a buffer prior to the first xdg_surface.configure call must
* also be treated as errors.
*
* Mapping an xdg_surface-based role surface is defined as making it
* possible for the surface to be shown by the compositor. Note that
* a mapped surface is not guaranteed to be visible once it is mapped.
*
* For an xdg_surface to be mapped by the compositor, the following
* conditions must be met:
* (1) the client has assigned an xdg_surface-based role to the surface
* (2) the client has set and committed the xdg_surface state and the
* role-dependent state to the surface
* (3) the client has committed a buffer to the surface
*
* A newly-unmapped surface is considered to have met condition (1) out
* of the 3 required conditions for mapping a surface if its role surface
* has not been destroyed.
*/
extern const struct wl_interface xdg_surface_interface;
/**
* @page page_iface_xdg_toplevel xdg_toplevel
* @section page_iface_xdg_toplevel_desc Description
*
* This interface defines an xdg_surface role which allows a surface to,
* among other things, set window-like properties such as maximize,
* fullscreen, and minimize, set application-specific metadata like title and
* id, and well as trigger user interactive operations such as interactive
* resize and move.
*
* Unmapping an xdg_toplevel means that the surface cannot be shown
* by the compositor until it is explicitly mapped again.
* All active operations (e.g., move, resize) are canceled and all
* attributes (e.g. title, state, stacking, ...) are discarded for
* an xdg_toplevel surface when it is unmapped.
*
* Attaching a null buffer to a toplevel unmaps the surface.
* @section page_iface_xdg_toplevel_api API
* See @ref iface_xdg_toplevel.
*/
/**
* @defgroup iface_xdg_toplevel The xdg_toplevel interface
*
* This interface defines an xdg_surface role which allows a surface to,
* among other things, set window-like properties such as maximize,
* fullscreen, and minimize, set application-specific metadata like title and
* id, and well as trigger user interactive operations such as interactive
* resize and move.
*
* Unmapping an xdg_toplevel means that the surface cannot be shown
* by the compositor until it is explicitly mapped again.
* All active operations (e.g., move, resize) are canceled and all
* attributes (e.g. title, state, stacking, ...) are discarded for
* an xdg_toplevel surface when it is unmapped.
*
* Attaching a null buffer to a toplevel unmaps the surface.
*/
extern const struct wl_interface xdg_toplevel_interface;
/**
* @page page_iface_xdg_popup xdg_popup
* @section page_iface_xdg_popup_desc Description
*
* A popup surface is a short-lived, temporary surface. It can be used to
* implement for example menus, popovers, tooltips and other similar user
* interface concepts.
*
* A popup can be made to take an explicit grab. See xdg_popup.grab for
* details.
*
* When the popup is dismissed, a popup_done event will be sent out, and at
* the same time the surface will be unmapped. See the xdg_popup.popup_done
* event for details.
*
* Explicitly destroying the xdg_popup object will also dismiss the popup and
* unmap the surface. Clients that want to dismiss the popup when another
* surface of their own is clicked should dismiss the popup using the destroy
* request.
*
* A newly created xdg_popup will be stacked on top of all previously created
* xdg_popup surfaces associated with the same xdg_toplevel.
*
* The parent of an xdg_popup must be mapped (see the xdg_surface
* description) before the xdg_popup itself.
*
* The client must call wl_surface.commit on the corresponding wl_surface
* for the xdg_popup state to take effect.
* @section page_iface_xdg_popup_api API
* See @ref iface_xdg_popup.
*/
/**
* @defgroup iface_xdg_popup The xdg_popup interface
*
* A popup surface is a short-lived, temporary surface. It can be used to
* implement for example menus, popovers, tooltips and other similar user
* interface concepts.
*
* A popup can be made to take an explicit grab. See xdg_popup.grab for
* details.
*
* When the popup is dismissed, a popup_done event will be sent out, and at
* the same time the surface will be unmapped. See the xdg_popup.popup_done
* event for details.
*
* Explicitly destroying the xdg_popup object will also dismiss the popup and
* unmap the surface. Clients that want to dismiss the popup when another
* surface of their own is clicked should dismiss the popup using the destroy
* request.
*
* A newly created xdg_popup will be stacked on top of all previously created
* xdg_popup surfaces associated with the same xdg_toplevel.
*
* The parent of an xdg_popup must be mapped (see the xdg_surface
* description) before the xdg_popup itself.
*
* The client must call wl_surface.commit on the corresponding wl_surface
* for the xdg_popup state to take effect.
*/
extern const struct wl_interface xdg_popup_interface;
#ifndef XDG_WM_BASE_ERROR_ENUM
#define XDG_WM_BASE_ERROR_ENUM
enum xdg_wm_base_error {
/**
* given wl_surface has another role
*/
XDG_WM_BASE_ERROR_ROLE = 0,
/**
* xdg_wm_base was destroyed before children
*/
XDG_WM_BASE_ERROR_DEFUNCT_SURFACES = 1,
/**
* the client tried to map or destroy a non-topmost popup
*/
XDG_WM_BASE_ERROR_NOT_THE_TOPMOST_POPUP = 2,
/**
* the client specified an invalid popup parent surface
*/
XDG_WM_BASE_ERROR_INVALID_POPUP_PARENT = 3,
/**
* the client provided an invalid surface state
*/
XDG_WM_BASE_ERROR_INVALID_SURFACE_STATE = 4,
/**
* the client provided an invalid positioner
*/
XDG_WM_BASE_ERROR_INVALID_POSITIONER = 5,
};
#endif /* XDG_WM_BASE_ERROR_ENUM */
/**
* @ingroup iface_xdg_wm_base
* @struct xdg_wm_base_listener
*/
struct xdg_wm_base_listener {
/**
* check if the client is alive
*
* The ping event asks the client if it's still alive. Pass the
* serial specified in the event back to the compositor by sending
* a "pong" request back with the specified serial. See
* xdg_wm_base.pong.
*
* Compositors can use this to determine if the client is still
* alive. It's unspecified what will happen if the client doesn't
* respond to the ping request, or in what timeframe. Clients
* should try to respond in a reasonable amount of time.
*
* A compositor is free to ping in any way it wants, but a client
* must always respond to any xdg_wm_base object it created.
* @param serial pass this to the pong request
*/
void (*ping)(void *data,
struct xdg_wm_base *xdg_wm_base,
uint32_t serial);
};
/**
* @ingroup iface_xdg_wm_base
*/
static inline int
xdg_wm_base_add_listener(struct xdg_wm_base *xdg_wm_base,
const struct xdg_wm_base_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) xdg_wm_base,
(void (**)(void)) listener, data);
}
#define XDG_WM_BASE_DESTROY 0
#define XDG_WM_BASE_CREATE_POSITIONER 1
#define XDG_WM_BASE_GET_XDG_SURFACE 2
#define XDG_WM_BASE_PONG 3
/**
* @ingroup iface_xdg_wm_base
*/
#define XDG_WM_BASE_PING_SINCE_VERSION 1
/**
* @ingroup iface_xdg_wm_base
*/
#define XDG_WM_BASE_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_xdg_wm_base
*/
#define XDG_WM_BASE_CREATE_POSITIONER_SINCE_VERSION 1
/**
* @ingroup iface_xdg_wm_base
*/
#define XDG_WM_BASE_GET_XDG_SURFACE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_wm_base
*/
#define XDG_WM_BASE_PONG_SINCE_VERSION 1
/** @ingroup iface_xdg_wm_base */
static inline void
xdg_wm_base_set_user_data(struct xdg_wm_base *xdg_wm_base, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) xdg_wm_base, user_data);
}
/** @ingroup iface_xdg_wm_base */
static inline void *
xdg_wm_base_get_user_data(struct xdg_wm_base *xdg_wm_base)
{
return wl_proxy_get_user_data((struct wl_proxy *) xdg_wm_base);
}
static inline uint32_t
xdg_wm_base_get_version(struct xdg_wm_base *xdg_wm_base)
{
return wl_proxy_get_version((struct wl_proxy *) xdg_wm_base);
}
/**
* @ingroup iface_xdg_wm_base
*
* Destroy this xdg_wm_base object.
*
* Destroying a bound xdg_wm_base object while there are surfaces
* still alive created by this xdg_wm_base object instance is illegal
* and will result in a protocol error.
*/
static inline void
xdg_wm_base_destroy(struct xdg_wm_base *xdg_wm_base)
{
wl_proxy_marshal((struct wl_proxy *) xdg_wm_base,
XDG_WM_BASE_DESTROY);
wl_proxy_destroy((struct wl_proxy *) xdg_wm_base);
}
/**
* @ingroup iface_xdg_wm_base
*
* Create a positioner object. A positioner object is used to position
* surfaces relative to some parent surface. See the interface description
* and xdg_surface.get_popup for details.
*/
static inline struct xdg_positioner *
xdg_wm_base_create_positioner(struct xdg_wm_base *xdg_wm_base)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) xdg_wm_base,
XDG_WM_BASE_CREATE_POSITIONER, &xdg_positioner_interface, NULL);
return (struct xdg_positioner *) id;
}
/**
* @ingroup iface_xdg_wm_base
*
* This creates an xdg_surface for the given surface. While xdg_surface
* itself is not a role, the corresponding surface may only be assigned
* a role extending xdg_surface, such as xdg_toplevel or xdg_popup.
*
* This creates an xdg_surface for the given surface. An xdg_surface is
* used as basis to define a role to a given surface, such as xdg_toplevel
* or xdg_popup. It also manages functionality shared between xdg_surface
* based surface roles.
*
* See the documentation of xdg_surface for more details about what an
* xdg_surface is and how it is used.
*/
static inline struct xdg_surface *
xdg_wm_base_get_xdg_surface(struct xdg_wm_base *xdg_wm_base, struct wl_surface *surface)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) xdg_wm_base,
XDG_WM_BASE_GET_XDG_SURFACE, &xdg_surface_interface, NULL, surface);
return (struct xdg_surface *) id;
}
/**
* @ingroup iface_xdg_wm_base
*
* A client must respond to a ping event with a pong request or
* the client may be deemed unresponsive. See xdg_wm_base.ping.
*/
static inline void
xdg_wm_base_pong(struct xdg_wm_base *xdg_wm_base, uint32_t serial)
{
wl_proxy_marshal((struct wl_proxy *) xdg_wm_base,
XDG_WM_BASE_PONG, serial);
}
#ifndef XDG_POSITIONER_ERROR_ENUM
#define XDG_POSITIONER_ERROR_ENUM
enum xdg_positioner_error {
/**
* invalid input provided
*/
XDG_POSITIONER_ERROR_INVALID_INPUT = 0,
};
#endif /* XDG_POSITIONER_ERROR_ENUM */
#ifndef XDG_POSITIONER_ANCHOR_ENUM
#define XDG_POSITIONER_ANCHOR_ENUM
enum xdg_positioner_anchor {
XDG_POSITIONER_ANCHOR_NONE = 0,
XDG_POSITIONER_ANCHOR_TOP = 1,
XDG_POSITIONER_ANCHOR_BOTTOM = 2,
XDG_POSITIONER_ANCHOR_LEFT = 3,
XDG_POSITIONER_ANCHOR_RIGHT = 4,
XDG_POSITIONER_ANCHOR_TOP_LEFT = 5,
XDG_POSITIONER_ANCHOR_BOTTOM_LEFT = 6,
XDG_POSITIONER_ANCHOR_TOP_RIGHT = 7,
XDG_POSITIONER_ANCHOR_BOTTOM_RIGHT = 8,
};
#endif /* XDG_POSITIONER_ANCHOR_ENUM */
#ifndef XDG_POSITIONER_GRAVITY_ENUM
#define XDG_POSITIONER_GRAVITY_ENUM
enum xdg_positioner_gravity {
XDG_POSITIONER_GRAVITY_NONE = 0,
XDG_POSITIONER_GRAVITY_TOP = 1,
XDG_POSITIONER_GRAVITY_BOTTOM = 2,
XDG_POSITIONER_GRAVITY_LEFT = 3,
XDG_POSITIONER_GRAVITY_RIGHT = 4,
XDG_POSITIONER_GRAVITY_TOP_LEFT = 5,
XDG_POSITIONER_GRAVITY_BOTTOM_LEFT = 6,
XDG_POSITIONER_GRAVITY_TOP_RIGHT = 7,
XDG_POSITIONER_GRAVITY_BOTTOM_RIGHT = 8,
};
#endif /* XDG_POSITIONER_GRAVITY_ENUM */
#ifndef XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_ENUM
#define XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_ENUM
/**
* @ingroup iface_xdg_positioner
* vertically resize the surface
*
* Resize the surface vertically so that it is completely unconstrained.
*/
enum xdg_positioner_constraint_adjustment {
XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_NONE = 0,
XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_SLIDE_X = 1,
XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_SLIDE_Y = 2,
XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_FLIP_X = 4,
XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_FLIP_Y = 8,
XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_RESIZE_X = 16,
XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_RESIZE_Y = 32,
};
#endif /* XDG_POSITIONER_CONSTRAINT_ADJUSTMENT_ENUM */
#define XDG_POSITIONER_DESTROY 0
#define XDG_POSITIONER_SET_SIZE 1
#define XDG_POSITIONER_SET_ANCHOR_RECT 2
#define XDG_POSITIONER_SET_ANCHOR 3
#define XDG_POSITIONER_SET_GRAVITY 4
#define XDG_POSITIONER_SET_CONSTRAINT_ADJUSTMENT 5
#define XDG_POSITIONER_SET_OFFSET 6
#define XDG_POSITIONER_SET_REACTIVE 7
#define XDG_POSITIONER_SET_PARENT_SIZE 8
#define XDG_POSITIONER_SET_PARENT_CONFIGURE 9
/**
* @ingroup iface_xdg_positioner
*/
#define XDG_POSITIONER_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_xdg_positioner
*/
#define XDG_POSITIONER_SET_SIZE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_positioner
*/
#define XDG_POSITIONER_SET_ANCHOR_RECT_SINCE_VERSION 1
/**
* @ingroup iface_xdg_positioner
*/
#define XDG_POSITIONER_SET_ANCHOR_SINCE_VERSION 1
/**
* @ingroup iface_xdg_positioner
*/
#define XDG_POSITIONER_SET_GRAVITY_SINCE_VERSION 1
/**
* @ingroup iface_xdg_positioner
*/
#define XDG_POSITIONER_SET_CONSTRAINT_ADJUSTMENT_SINCE_VERSION 1
/**
* @ingroup iface_xdg_positioner
*/
#define XDG_POSITIONER_SET_OFFSET_SINCE_VERSION 1
/**
* @ingroup iface_xdg_positioner
*/
#define XDG_POSITIONER_SET_REACTIVE_SINCE_VERSION 3
/**
* @ingroup iface_xdg_positioner
*/
#define XDG_POSITIONER_SET_PARENT_SIZE_SINCE_VERSION 3
/**
* @ingroup iface_xdg_positioner
*/
#define XDG_POSITIONER_SET_PARENT_CONFIGURE_SINCE_VERSION 3
/** @ingroup iface_xdg_positioner */
static inline void
xdg_positioner_set_user_data(struct xdg_positioner *xdg_positioner, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) xdg_positioner, user_data);
}
/** @ingroup iface_xdg_positioner */
static inline void *
xdg_positioner_get_user_data(struct xdg_positioner *xdg_positioner)
{
return wl_proxy_get_user_data((struct wl_proxy *) xdg_positioner);
}
static inline uint32_t
xdg_positioner_get_version(struct xdg_positioner *xdg_positioner)
{
return wl_proxy_get_version((struct wl_proxy *) xdg_positioner);
}
/**
* @ingroup iface_xdg_positioner
*
* Notify the compositor that the xdg_positioner will no longer be used.
*/
static inline void
xdg_positioner_destroy(struct xdg_positioner *xdg_positioner)
{
wl_proxy_marshal((struct wl_proxy *) xdg_positioner,
XDG_POSITIONER_DESTROY);
wl_proxy_destroy((struct wl_proxy *) xdg_positioner);
}
/**
* @ingroup iface_xdg_positioner
*
* Set the size of the surface that is to be positioned with the positioner
* object. The size is in surface-local coordinates and corresponds to the
* window geometry. See xdg_surface.set_window_geometry.
*
* If a zero or negative size is set the invalid_input error is raised.
*/
static inline void
xdg_positioner_set_size(struct xdg_positioner *xdg_positioner, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) xdg_positioner,
XDG_POSITIONER_SET_SIZE, width, height);
}
/**
* @ingroup iface_xdg_positioner
*
* Specify the anchor rectangle within the parent surface that the child
* surface will be placed relative to. The rectangle is relative to the
* window geometry as defined by xdg_surface.set_window_geometry of the
* parent surface.
*
* When the xdg_positioner object is used to position a child surface, the
* anchor rectangle may not extend outside the window geometry of the
* positioned child's parent surface.
*
* If a negative size is set the invalid_input error is raised.
*/
static inline void
xdg_positioner_set_anchor_rect(struct xdg_positioner *xdg_positioner, int32_t x, int32_t y, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) xdg_positioner,
XDG_POSITIONER_SET_ANCHOR_RECT, x, y, width, height);
}
/**
* @ingroup iface_xdg_positioner
*
* Defines the anchor point for the anchor rectangle. The specified anchor
* is used derive an anchor point that the child surface will be
* positioned relative to. If a corner anchor is set (e.g. 'top_left' or
* 'bottom_right'), the anchor point will be at the specified corner;
* otherwise, the derived anchor point will be centered on the specified
* edge, or in the center of the anchor rectangle if no edge is specified.
*/
static inline void
xdg_positioner_set_anchor(struct xdg_positioner *xdg_positioner, uint32_t anchor)
{
wl_proxy_marshal((struct wl_proxy *) xdg_positioner,
XDG_POSITIONER_SET_ANCHOR, anchor);
}
/**
* @ingroup iface_xdg_positioner
*
* Defines in what direction a surface should be positioned, relative to
* the anchor point of the parent surface. If a corner gravity is
* specified (e.g. 'bottom_right' or 'top_left'), then the child surface
* will be placed towards the specified gravity; otherwise, the child
* surface will be centered over the anchor point on any axis that had no
* gravity specified.
*/
static inline void
xdg_positioner_set_gravity(struct xdg_positioner *xdg_positioner, uint32_t gravity)
{
wl_proxy_marshal((struct wl_proxy *) xdg_positioner,
XDG_POSITIONER_SET_GRAVITY, gravity);
}
/**
* @ingroup iface_xdg_positioner
*
* Specify how the window should be positioned if the originally intended
* position caused the surface to be constrained, meaning at least
* partially outside positioning boundaries set by the compositor. The
* adjustment is set by constructing a bitmask describing the adjustment to
* be made when the surface is constrained on that axis.
*
* If no bit for one axis is set, the compositor will assume that the child
* surface should not change its position on that axis when constrained.
*
* If more than one bit for one axis is set, the order of how adjustments
* are applied is specified in the corresponding adjustment descriptions.
*
* The default adjustment is none.
*/
static inline void
xdg_positioner_set_constraint_adjustment(struct xdg_positioner *xdg_positioner, uint32_t constraint_adjustment)
{
wl_proxy_marshal((struct wl_proxy *) xdg_positioner,
XDG_POSITIONER_SET_CONSTRAINT_ADJUSTMENT, constraint_adjustment);
}
/**
* @ingroup iface_xdg_positioner
*
* Specify the surface position offset relative to the position of the
* anchor on the anchor rectangle and the anchor on the surface. For
* example if the anchor of the anchor rectangle is at (x, y), the surface
* has the gravity bottom|right, and the offset is (ox, oy), the calculated
* surface position will be (x + ox, y + oy). The offset position of the
* surface is the one used for constraint testing. See
* set_constraint_adjustment.
*
* An example use case is placing a popup menu on top of a user interface
* element, while aligning the user interface element of the parent surface
* with some user interface element placed somewhere in the popup surface.
*/
static inline void
xdg_positioner_set_offset(struct xdg_positioner *xdg_positioner, int32_t x, int32_t y)
{
wl_proxy_marshal((struct wl_proxy *) xdg_positioner,
XDG_POSITIONER_SET_OFFSET, x, y);
}
/**
* @ingroup iface_xdg_positioner
*
* When set reactive, the surface is reconstrained if the conditions used
* for constraining changed, e.g. the parent window moved.
*
* If the conditions changed and the popup was reconstrained, an
* xdg_popup.configure event is sent with updated geometry, followed by an
* xdg_surface.configure event.
*/
static inline void
xdg_positioner_set_reactive(struct xdg_positioner *xdg_positioner)
{
wl_proxy_marshal((struct wl_proxy *) xdg_positioner,
XDG_POSITIONER_SET_REACTIVE);
}
/**
* @ingroup iface_xdg_positioner
*
* Set the parent window geometry the compositor should use when
* positioning the popup. The compositor may use this information to
* determine the future state the popup should be constrained using. If
* this doesn't match the dimension of the parent the popup is eventually
* positioned against, the behavior is undefined.
*
* The arguments are given in the surface-local coordinate space.
*/
static inline void
xdg_positioner_set_parent_size(struct xdg_positioner *xdg_positioner, int32_t parent_width, int32_t parent_height)
{
wl_proxy_marshal((struct wl_proxy *) xdg_positioner,
XDG_POSITIONER_SET_PARENT_SIZE, parent_width, parent_height);
}
/**
* @ingroup iface_xdg_positioner
*
* Set the serial of a xdg_surface.configure event this positioner will be
* used in response to. The compositor may use this information together
* with set_parent_size to determine what future state the popup should be
* constrained using.
*/
static inline void
xdg_positioner_set_parent_configure(struct xdg_positioner *xdg_positioner, uint32_t serial)
{
wl_proxy_marshal((struct wl_proxy *) xdg_positioner,
XDG_POSITIONER_SET_PARENT_CONFIGURE, serial);
}
#ifndef XDG_SURFACE_ERROR_ENUM
#define XDG_SURFACE_ERROR_ENUM
enum xdg_surface_error {
XDG_SURFACE_ERROR_NOT_CONSTRUCTED = 1,
XDG_SURFACE_ERROR_ALREADY_CONSTRUCTED = 2,
XDG_SURFACE_ERROR_UNCONFIGURED_BUFFER = 3,
};
#endif /* XDG_SURFACE_ERROR_ENUM */
/**
* @ingroup iface_xdg_surface
* @struct xdg_surface_listener
*/
struct xdg_surface_listener {
/**
* suggest a surface change
*
* The configure event marks the end of a configure sequence. A
* configure sequence is a set of one or more events configuring
* the state of the xdg_surface, including the final
* xdg_surface.configure event.
*
* Where applicable, xdg_surface surface roles will during a
* configure sequence extend this event as a latched state sent as
* events before the xdg_surface.configure event. Such events
* should be considered to make up a set of atomically applied
* configuration states, where the xdg_surface.configure commits
* the accumulated state.
*
* Clients should arrange their surface for the new states, and
* then send an ack_configure request with the serial sent in this
* configure event at some point before committing the new surface.
*
* If the client receives multiple configure events before it can
* respond to one, it is free to discard all but the last event it
* received.
* @param serial serial of the configure event
*/
void (*configure)(void *data,
struct xdg_surface *xdg_surface,
uint32_t serial);
};
/**
* @ingroup iface_xdg_surface
*/
static inline int
xdg_surface_add_listener(struct xdg_surface *xdg_surface,
const struct xdg_surface_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) xdg_surface,
(void (**)(void)) listener, data);
}
#define XDG_SURFACE_DESTROY 0
#define XDG_SURFACE_GET_TOPLEVEL 1
#define XDG_SURFACE_GET_POPUP 2
#define XDG_SURFACE_SET_WINDOW_GEOMETRY 3
#define XDG_SURFACE_ACK_CONFIGURE 4
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_CONFIGURE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_GET_TOPLEVEL_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_GET_POPUP_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_SET_WINDOW_GEOMETRY_SINCE_VERSION 1
/**
* @ingroup iface_xdg_surface
*/
#define XDG_SURFACE_ACK_CONFIGURE_SINCE_VERSION 1
/** @ingroup iface_xdg_surface */
static inline void
xdg_surface_set_user_data(struct xdg_surface *xdg_surface, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) xdg_surface, user_data);
}
/** @ingroup iface_xdg_surface */
static inline void *
xdg_surface_get_user_data(struct xdg_surface *xdg_surface)
{
return wl_proxy_get_user_data((struct wl_proxy *) xdg_surface);
}
static inline uint32_t
xdg_surface_get_version(struct xdg_surface *xdg_surface)
{
return wl_proxy_get_version((struct wl_proxy *) xdg_surface);
}
/**
* @ingroup iface_xdg_surface
*
* Destroy the xdg_surface object. An xdg_surface must only be destroyed
* after its role object has been destroyed.
*/
static inline void
xdg_surface_destroy(struct xdg_surface *xdg_surface)
{
wl_proxy_marshal((struct wl_proxy *) xdg_surface,
XDG_SURFACE_DESTROY);
wl_proxy_destroy((struct wl_proxy *) xdg_surface);
}
/**
* @ingroup iface_xdg_surface
*
* This creates an xdg_toplevel object for the given xdg_surface and gives
* the associated wl_surface the xdg_toplevel role.
*
* See the documentation of xdg_toplevel for more details about what an
* xdg_toplevel is and how it is used.
*/
static inline struct xdg_toplevel *
xdg_surface_get_toplevel(struct xdg_surface *xdg_surface)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) xdg_surface,
XDG_SURFACE_GET_TOPLEVEL, &xdg_toplevel_interface, NULL);
return (struct xdg_toplevel *) id;
}
/**
* @ingroup iface_xdg_surface
*
* This creates an xdg_popup object for the given xdg_surface and gives
* the associated wl_surface the xdg_popup role.
*
* If null is passed as a parent, a parent surface must be specified using
* some other protocol, before committing the initial state.
*
* See the documentation of xdg_popup for more details about what an
* xdg_popup is and how it is used.
*/
static inline struct xdg_popup *
xdg_surface_get_popup(struct xdg_surface *xdg_surface, struct xdg_surface *parent, struct xdg_positioner *positioner)
{
struct wl_proxy *id;
id = wl_proxy_marshal_constructor((struct wl_proxy *) xdg_surface,
XDG_SURFACE_GET_POPUP, &xdg_popup_interface, NULL, parent, positioner);
return (struct xdg_popup *) id;
}
/**
* @ingroup iface_xdg_surface
*
* The window geometry of a surface is its "visible bounds" from the
* user's perspective. Client-side decorations often have invisible
* portions like drop-shadows which should be ignored for the
* purposes of aligning, placing and constraining windows.
*
* The window geometry is double buffered, and will be applied at the
* time wl_surface.commit of the corresponding wl_surface is called.
*
* When maintaining a position, the compositor should treat the (x, y)
* coordinate of the window geometry as the top left corner of the window.
* A client changing the (x, y) window geometry coordinate should in
* general not alter the position of the window.
*
* Once the window geometry of the surface is set, it is not possible to
* unset it, and it will remain the same until set_window_geometry is
* called again, even if a new subsurface or buffer is attached.
*
* If never set, the value is the full bounds of the surface,
* including any subsurfaces. This updates dynamically on every
* commit. This unset is meant for extremely simple clients.
*
* The arguments are given in the surface-local coordinate space of
* the wl_surface associated with this xdg_surface.
*
* The width and height must be greater than zero. Setting an invalid size
* will raise an error. When applied, the effective window geometry will be
* the set window geometry clamped to the bounding rectangle of the
* combined geometry of the surface of the xdg_surface and the associated
* subsurfaces.
*/
static inline void
xdg_surface_set_window_geometry(struct xdg_surface *xdg_surface, int32_t x, int32_t y, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) xdg_surface,
XDG_SURFACE_SET_WINDOW_GEOMETRY, x, y, width, height);
}
/**
* @ingroup iface_xdg_surface
*
* When a configure event is received, if a client commits the
* surface in response to the configure event, then the client
* must make an ack_configure request sometime before the commit
* request, passing along the serial of the configure event.
*
* For instance, for toplevel surfaces the compositor might use this
* information to move a surface to the top left only when the client has
* drawn itself for the maximized or fullscreen state.
*
* If the client receives multiple configure events before it
* can respond to one, it only has to ack the last configure event.
*
* A client is not required to commit immediately after sending
* an ack_configure request - it may even ack_configure several times
* before its next surface commit.
*
* A client may send multiple ack_configure requests before committing, but
* only the last request sent before a commit indicates which configure
* event the client really is responding to.
*/
static inline void
xdg_surface_ack_configure(struct xdg_surface *xdg_surface, uint32_t serial)
{
wl_proxy_marshal((struct wl_proxy *) xdg_surface,
XDG_SURFACE_ACK_CONFIGURE, serial);
}
#ifndef XDG_TOPLEVEL_RESIZE_EDGE_ENUM
#define XDG_TOPLEVEL_RESIZE_EDGE_ENUM
/**
* @ingroup iface_xdg_toplevel
* edge values for resizing
*
* These values are used to indicate which edge of a surface
* is being dragged in a resize operation.
*/
enum xdg_toplevel_resize_edge {
XDG_TOPLEVEL_RESIZE_EDGE_NONE = 0,
XDG_TOPLEVEL_RESIZE_EDGE_TOP = 1,
XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM = 2,
XDG_TOPLEVEL_RESIZE_EDGE_LEFT = 4,
XDG_TOPLEVEL_RESIZE_EDGE_TOP_LEFT = 5,
XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_LEFT = 6,
XDG_TOPLEVEL_RESIZE_EDGE_RIGHT = 8,
XDG_TOPLEVEL_RESIZE_EDGE_TOP_RIGHT = 9,
XDG_TOPLEVEL_RESIZE_EDGE_BOTTOM_RIGHT = 10,
};
#endif /* XDG_TOPLEVEL_RESIZE_EDGE_ENUM */
#ifndef XDG_TOPLEVEL_STATE_ENUM
#define XDG_TOPLEVEL_STATE_ENUM
/**
* @ingroup iface_xdg_toplevel
* the surface is tiled
*
* The window is currently in a tiled layout and the bottom edge is
* considered to be adjacent to another part of the tiling grid.
*/
enum xdg_toplevel_state {
/**
* the surface is maximized
*/
XDG_TOPLEVEL_STATE_MAXIMIZED = 1,
/**
* the surface is fullscreen
*/
XDG_TOPLEVEL_STATE_FULLSCREEN = 2,
/**
* the surface is being resized
*/
XDG_TOPLEVEL_STATE_RESIZING = 3,
/**
* the surface is now activated
*/
XDG_TOPLEVEL_STATE_ACTIVATED = 4,
/**
* @since 2
*/
XDG_TOPLEVEL_STATE_TILED_LEFT = 5,
/**
* @since 2
*/
XDG_TOPLEVEL_STATE_TILED_RIGHT = 6,
/**
* @since 2
*/
XDG_TOPLEVEL_STATE_TILED_TOP = 7,
/**
* @since 2
*/
XDG_TOPLEVEL_STATE_TILED_BOTTOM = 8,
};
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_STATE_TILED_LEFT_SINCE_VERSION 2
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_STATE_TILED_RIGHT_SINCE_VERSION 2
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_STATE_TILED_TOP_SINCE_VERSION 2
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_STATE_TILED_BOTTOM_SINCE_VERSION 2
#endif /* XDG_TOPLEVEL_STATE_ENUM */
/**
* @ingroup iface_xdg_toplevel
* @struct xdg_toplevel_listener
*/
struct xdg_toplevel_listener {
/**
* suggest a surface change
*
* This configure event asks the client to resize its toplevel
* surface or to change its state. The configured state should not
* be applied immediately. See xdg_surface.configure for details.
*
* The width and height arguments specify a hint to the window
* about how its surface should be resized in window geometry
* coordinates. See set_window_geometry.
*
* If the width or height arguments are zero, it means the client
* should decide its own window dimension. This may happen when the
* compositor needs to configure the state of the surface but
* doesn't have any information about any previous or expected
* dimension.
*
* The states listed in the event specify how the width/height
* arguments should be interpreted, and possibly how it should be
* drawn.
*
* Clients must send an ack_configure in response to this event.
* See xdg_surface.configure and xdg_surface.ack_configure for
* details.
*/
void (*configure)(void *data,
struct xdg_toplevel *xdg_toplevel,
int32_t width,
int32_t height,
struct wl_array *states);
/**
* surface wants to be closed
*
* The close event is sent by the compositor when the user wants
* the surface to be closed. This should be equivalent to the user
* clicking the close button in client-side decorations, if your
* application has any.
*
* This is only a request that the user intends to close the
* window. The client may choose to ignore this request, or show a
* dialog to ask the user to save their data, etc.
*/
void (*close)(void *data,
struct xdg_toplevel *xdg_toplevel);
};
/**
* @ingroup iface_xdg_toplevel
*/
static inline int
xdg_toplevel_add_listener(struct xdg_toplevel *xdg_toplevel,
const struct xdg_toplevel_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) xdg_toplevel,
(void (**)(void)) listener, data);
}
#define XDG_TOPLEVEL_DESTROY 0
#define XDG_TOPLEVEL_SET_PARENT 1
#define XDG_TOPLEVEL_SET_TITLE 2
#define XDG_TOPLEVEL_SET_APP_ID 3
#define XDG_TOPLEVEL_SHOW_WINDOW_MENU 4
#define XDG_TOPLEVEL_MOVE 5
#define XDG_TOPLEVEL_RESIZE 6
#define XDG_TOPLEVEL_SET_MAX_SIZE 7
#define XDG_TOPLEVEL_SET_MIN_SIZE 8
#define XDG_TOPLEVEL_SET_MAXIMIZED 9
#define XDG_TOPLEVEL_UNSET_MAXIMIZED 10
#define XDG_TOPLEVEL_SET_FULLSCREEN 11
#define XDG_TOPLEVEL_UNSET_FULLSCREEN 12
#define XDG_TOPLEVEL_SET_MINIMIZED 13
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_CONFIGURE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_CLOSE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_SET_PARENT_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_SET_TITLE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_SET_APP_ID_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_SHOW_WINDOW_MENU_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_MOVE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_RESIZE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_SET_MAX_SIZE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_SET_MIN_SIZE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_SET_MAXIMIZED_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_UNSET_MAXIMIZED_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_SET_FULLSCREEN_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_UNSET_FULLSCREEN_SINCE_VERSION 1
/**
* @ingroup iface_xdg_toplevel
*/
#define XDG_TOPLEVEL_SET_MINIMIZED_SINCE_VERSION 1
/** @ingroup iface_xdg_toplevel */
static inline void
xdg_toplevel_set_user_data(struct xdg_toplevel *xdg_toplevel, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) xdg_toplevel, user_data);
}
/** @ingroup iface_xdg_toplevel */
static inline void *
xdg_toplevel_get_user_data(struct xdg_toplevel *xdg_toplevel)
{
return wl_proxy_get_user_data((struct wl_proxy *) xdg_toplevel);
}
static inline uint32_t
xdg_toplevel_get_version(struct xdg_toplevel *xdg_toplevel)
{
return wl_proxy_get_version((struct wl_proxy *) xdg_toplevel);
}
/**
* @ingroup iface_xdg_toplevel
*
* This request destroys the role surface and unmaps the surface;
* see "Unmapping" behavior in interface section for details.
*/
static inline void
xdg_toplevel_destroy(struct xdg_toplevel *xdg_toplevel)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_DESTROY);
wl_proxy_destroy((struct wl_proxy *) xdg_toplevel);
}
/**
* @ingroup iface_xdg_toplevel
*
* Set the "parent" of this surface. This surface should be stacked
* above the parent surface and all other ancestor surfaces.
*
* Parent windows should be set on dialogs, toolboxes, or other
* "auxiliary" surfaces, so that the parent is raised when the dialog
* is raised.
*
* Setting a null parent for a child window removes any parent-child
* relationship for the child. Setting a null parent for a window which
* currently has no parent is a no-op.
*
* If the parent is unmapped then its children are managed as
* though the parent of the now-unmapped parent has become the
* parent of this surface. If no parent exists for the now-unmapped
* parent then the children are managed as though they have no
* parent surface.
*/
static inline void
xdg_toplevel_set_parent(struct xdg_toplevel *xdg_toplevel, struct xdg_toplevel *parent)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_SET_PARENT, parent);
}
/**
* @ingroup iface_xdg_toplevel
*
* Set a short title for the surface.
*
* This string may be used to identify the surface in a task bar,
* window list, or other user interface elements provided by the
* compositor.
*
* The string must be encoded in UTF-8.
*/
static inline void
xdg_toplevel_set_title(struct xdg_toplevel *xdg_toplevel, const char *title)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_SET_TITLE, title);
}
/**
* @ingroup iface_xdg_toplevel
*
* Set an application identifier for the surface.
*
* The app ID identifies the general class of applications to which
* the surface belongs. The compositor can use this to group multiple
* surfaces together, or to determine how to launch a new application.
*
* For D-Bus activatable applications, the app ID is used as the D-Bus
* service name.
*
* The compositor shell will try to group application surfaces together
* by their app ID. As a best practice, it is suggested to select app
* ID's that match the basename of the application's .desktop file.
* For example, "org.freedesktop.FooViewer" where the .desktop file is
* "org.freedesktop.FooViewer.desktop".
*
* Like other properties, a set_app_id request can be sent after the
* xdg_toplevel has been mapped to update the property.
*
* See the desktop-entry specification [0] for more details on
* application identifiers and how they relate to well-known D-Bus
* names and .desktop files.
*
* [0] http://standards.freedesktop.org/desktop-entry-spec/
*/
static inline void
xdg_toplevel_set_app_id(struct xdg_toplevel *xdg_toplevel, const char *app_id)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_SET_APP_ID, app_id);
}
/**
* @ingroup iface_xdg_toplevel
*
* Clients implementing client-side decorations might want to show
* a context menu when right-clicking on the decorations, giving the
* user a menu that they can use to maximize or minimize the window.
*
* This request asks the compositor to pop up such a window menu at
* the given position, relative to the local surface coordinates of
* the parent surface. There are no guarantees as to what menu items
* the window menu contains.
*
* This request must be used in response to some sort of user action
* like a button press, key press, or touch down event.
*/
static inline void
xdg_toplevel_show_window_menu(struct xdg_toplevel *xdg_toplevel, struct wl_seat *seat, uint32_t serial, int32_t x, int32_t y)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_SHOW_WINDOW_MENU, seat, serial, x, y);
}
/**
* @ingroup iface_xdg_toplevel
*
* Start an interactive, user-driven move of the surface.
*
* This request must be used in response to some sort of user action
* like a button press, key press, or touch down event. The passed
* serial is used to determine the type of interactive move (touch,
* pointer, etc).
*
* The server may ignore move requests depending on the state of
* the surface (e.g. fullscreen or maximized), or if the passed serial
* is no longer valid.
*
* If triggered, the surface will lose the focus of the device
* (wl_pointer, wl_touch, etc) used for the move. It is up to the
* compositor to visually indicate that the move is taking place, such as
* updating a pointer cursor, during the move. There is no guarantee
* that the device focus will return when the move is completed.
*/
static inline void
xdg_toplevel_move(struct xdg_toplevel *xdg_toplevel, struct wl_seat *seat, uint32_t serial)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_MOVE, seat, serial);
}
/**
* @ingroup iface_xdg_toplevel
*
* Start a user-driven, interactive resize of the surface.
*
* This request must be used in response to some sort of user action
* like a button press, key press, or touch down event. The passed
* serial is used to determine the type of interactive resize (touch,
* pointer, etc).
*
* The server may ignore resize requests depending on the state of
* the surface (e.g. fullscreen or maximized).
*
* If triggered, the client will receive configure events with the
* "resize" state enum value and the expected sizes. See the "resize"
* enum value for more details about what is required. The client
* must also acknowledge configure events using "ack_configure". After
* the resize is completed, the client will receive another "configure"
* event without the resize state.
*
* If triggered, the surface also will lose the focus of the device
* (wl_pointer, wl_touch, etc) used for the resize. It is up to the
* compositor to visually indicate that the resize is taking place,
* such as updating a pointer cursor, during the resize. There is no
* guarantee that the device focus will return when the resize is
* completed.
*
* The edges parameter specifies how the surface should be resized,
* and is one of the values of the resize_edge enum. The compositor
* may use this information to update the surface position for
* example when dragging the top left corner. The compositor may also
* use this information to adapt its behavior, e.g. choose an
* appropriate cursor image.
*/
static inline void
xdg_toplevel_resize(struct xdg_toplevel *xdg_toplevel, struct wl_seat *seat, uint32_t serial, uint32_t edges)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_RESIZE, seat, serial, edges);
}
/**
* @ingroup iface_xdg_toplevel
*
* Set a maximum size for the window.
*
* The client can specify a maximum size so that the compositor does
* not try to configure the window beyond this size.
*
* The width and height arguments are in window geometry coordinates.
* See xdg_surface.set_window_geometry.
*
* Values set in this way are double-buffered. They will get applied
* on the next commit.
*
* The compositor can use this information to allow or disallow
* different states like maximize or fullscreen and draw accurate
* animations.
*
* Similarly, a tiling window manager may use this information to
* place and resize client windows in a more effective way.
*
* The client should not rely on the compositor to obey the maximum
* size. The compositor may decide to ignore the values set by the
* client and request a larger size.
*
* If never set, or a value of zero in the request, means that the
* client has no expected maximum size in the given dimension.
* As a result, a client wishing to reset the maximum size
* to an unspecified state can use zero for width and height in the
* request.
*
* Requesting a maximum size to be smaller than the minimum size of
* a surface is illegal and will result in a protocol error.
*
* The width and height must be greater than or equal to zero. Using
* strictly negative values for width and height will result in a
* protocol error.
*/
static inline void
xdg_toplevel_set_max_size(struct xdg_toplevel *xdg_toplevel, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_SET_MAX_SIZE, width, height);
}
/**
* @ingroup iface_xdg_toplevel
*
* Set a minimum size for the window.
*
* The client can specify a minimum size so that the compositor does
* not try to configure the window below this size.
*
* The width and height arguments are in window geometry coordinates.
* See xdg_surface.set_window_geometry.
*
* Values set in this way are double-buffered. They will get applied
* on the next commit.
*
* The compositor can use this information to allow or disallow
* different states like maximize or fullscreen and draw accurate
* animations.
*
* Similarly, a tiling window manager may use this information to
* place and resize client windows in a more effective way.
*
* The client should not rely on the compositor to obey the minimum
* size. The compositor may decide to ignore the values set by the
* client and request a smaller size.
*
* If never set, or a value of zero in the request, means that the
* client has no expected minimum size in the given dimension.
* As a result, a client wishing to reset the minimum size
* to an unspecified state can use zero for width and height in the
* request.
*
* Requesting a minimum size to be larger than the maximum size of
* a surface is illegal and will result in a protocol error.
*
* The width and height must be greater than or equal to zero. Using
* strictly negative values for width and height will result in a
* protocol error.
*/
static inline void
xdg_toplevel_set_min_size(struct xdg_toplevel *xdg_toplevel, int32_t width, int32_t height)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_SET_MIN_SIZE, width, height);
}
/**
* @ingroup iface_xdg_toplevel
*
* Maximize the surface.
*
* After requesting that the surface should be maximized, the compositor
* will respond by emitting a configure event. Whether this configure
* actually sets the window maximized is subject to compositor policies.
* The client must then update its content, drawing in the configured
* state. The client must also acknowledge the configure when committing
* the new content (see ack_configure).
*
* It is up to the compositor to decide how and where to maximize the
* surface, for example which output and what region of the screen should
* be used.
*
* If the surface was already maximized, the compositor will still emit
* a configure event with the "maximized" state.
*
* If the surface is in a fullscreen state, this request has no direct
* effect. It may alter the state the surface is returned to when
* unmaximized unless overridden by the compositor.
*/
static inline void
xdg_toplevel_set_maximized(struct xdg_toplevel *xdg_toplevel)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_SET_MAXIMIZED);
}
/**
* @ingroup iface_xdg_toplevel
*
* Unmaximize the surface.
*
* After requesting that the surface should be unmaximized, the compositor
* will respond by emitting a configure event. Whether this actually
* un-maximizes the window is subject to compositor policies.
* If available and applicable, the compositor will include the window
* geometry dimensions the window had prior to being maximized in the
* configure event. The client must then update its content, drawing it in
* the configured state. The client must also acknowledge the configure
* when committing the new content (see ack_configure).
*
* It is up to the compositor to position the surface after it was
* unmaximized; usually the position the surface had before maximizing, if
* applicable.
*
* If the surface was already not maximized, the compositor will still
* emit a configure event without the "maximized" state.
*
* If the surface is in a fullscreen state, this request has no direct
* effect. It may alter the state the surface is returned to when
* unmaximized unless overridden by the compositor.
*/
static inline void
xdg_toplevel_unset_maximized(struct xdg_toplevel *xdg_toplevel)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_UNSET_MAXIMIZED);
}
/**
* @ingroup iface_xdg_toplevel
*
* Make the surface fullscreen.
*
* After requesting that the surface should be fullscreened, the
* compositor will respond by emitting a configure event. Whether the
* client is actually put into a fullscreen state is subject to compositor
* policies. The client must also acknowledge the configure when
* committing the new content (see ack_configure).
*
* The output passed by the request indicates the client's preference as
* to which display it should be set fullscreen on. If this value is NULL,
* it's up to the compositor to choose which display will be used to map
* this surface.
*
* If the surface doesn't cover the whole output, the compositor will
* position the surface in the center of the output and compensate with
* with border fill covering the rest of the output. The content of the
* border fill is undefined, but should be assumed to be in some way that
* attempts to blend into the surrounding area (e.g. solid black).
*
* If the fullscreened surface is not opaque, the compositor must make
* sure that other screen content not part of the same surface tree (made
* up of subsurfaces, popups or similarly coupled surfaces) are not
* visible below the fullscreened surface.
*/
static inline void
xdg_toplevel_set_fullscreen(struct xdg_toplevel *xdg_toplevel, struct wl_output *output)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_SET_FULLSCREEN, output);
}
/**
* @ingroup iface_xdg_toplevel
*
* Make the surface no longer fullscreen.
*
* After requesting that the surface should be unfullscreened, the
* compositor will respond by emitting a configure event.
* Whether this actually removes the fullscreen state of the client is
* subject to compositor policies.
*
* Making a surface unfullscreen sets states for the surface based on the following:
* * the state(s) it may have had before becoming fullscreen
* * any state(s) decided by the compositor
* * any state(s) requested by the client while the surface was fullscreen
*
* The compositor may include the previous window geometry dimensions in
* the configure event, if applicable.
*
* The client must also acknowledge the configure when committing the new
* content (see ack_configure).
*/
static inline void
xdg_toplevel_unset_fullscreen(struct xdg_toplevel *xdg_toplevel)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_UNSET_FULLSCREEN);
}
/**
* @ingroup iface_xdg_toplevel
*
* Request that the compositor minimize your surface. There is no
* way to know if the surface is currently minimized, nor is there
* any way to unset minimization on this surface.
*
* If you are looking to throttle redrawing when minimized, please
* instead use the wl_surface.frame event for this, as this will
* also work with live previews on windows in Alt-Tab, Expose or
* similar compositor features.
*/
static inline void
xdg_toplevel_set_minimized(struct xdg_toplevel *xdg_toplevel)
{
wl_proxy_marshal((struct wl_proxy *) xdg_toplevel,
XDG_TOPLEVEL_SET_MINIMIZED);
}
#ifndef XDG_POPUP_ERROR_ENUM
#define XDG_POPUP_ERROR_ENUM
enum xdg_popup_error {
/**
* tried to grab after being mapped
*/
XDG_POPUP_ERROR_INVALID_GRAB = 0,
};
#endif /* XDG_POPUP_ERROR_ENUM */
/**
* @ingroup iface_xdg_popup
* @struct xdg_popup_listener
*/
struct xdg_popup_listener {
/**
* configure the popup surface
*
* This event asks the popup surface to configure itself given
* the configuration. The configured state should not be applied
* immediately. See xdg_surface.configure for details.
*
* The x and y arguments represent the position the popup was
* placed at given the xdg_positioner rule, relative to the upper
* left corner of the window geometry of the parent surface.
*
* For version 2 or older, the configure event for an xdg_popup is
* only ever sent once for the initial configuration. Starting with
* version 3, it may be sent again if the popup is setup with an
* xdg_positioner with set_reactive requested, or in response to
* xdg_popup.reposition requests.
* @param x x position relative to parent surface window geometry
* @param y y position relative to parent surface window geometry
* @param width window geometry width
* @param height window geometry height
*/
void (*configure)(void *data,
struct xdg_popup *xdg_popup,
int32_t x,
int32_t y,
int32_t width,
int32_t height);
/**
* popup interaction is done
*
* The popup_done event is sent out when a popup is dismissed by
* the compositor. The client should destroy the xdg_popup object
* at this point.
*/
void (*popup_done)(void *data,
struct xdg_popup *xdg_popup);
/**
* signal the completion of a repositioned request
*
* The repositioned event is sent as part of a popup
* configuration sequence, together with xdg_popup.configure and
* lastly xdg_surface.configure to notify the completion of a
* reposition request.
*
* The repositioned event is to notify about the completion of a
* xdg_popup.reposition request. The token argument is the token
* passed in the xdg_popup.reposition request.
*
* Immediately after this event is emitted, xdg_popup.configure and
* xdg_surface.configure will be sent with the updated size and
* position, as well as a new configure serial.
*
* The client should optionally update the content of the popup,
* but must acknowledge the new popup configuration for the new
* position to take effect. See xdg_surface.ack_configure for
* details.
* @param token reposition request token
* @since 3
*/
void (*repositioned)(void *data,
struct xdg_popup *xdg_popup,
uint32_t token);
};
/**
* @ingroup iface_xdg_popup
*/
static inline int
xdg_popup_add_listener(struct xdg_popup *xdg_popup,
const struct xdg_popup_listener *listener, void *data)
{
return wl_proxy_add_listener((struct wl_proxy *) xdg_popup,
(void (**)(void)) listener, data);
}
#define XDG_POPUP_DESTROY 0
#define XDG_POPUP_GRAB 1
#define XDG_POPUP_REPOSITION 2
/**
* @ingroup iface_xdg_popup
*/
#define XDG_POPUP_CONFIGURE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_popup
*/
#define XDG_POPUP_POPUP_DONE_SINCE_VERSION 1
/**
* @ingroup iface_xdg_popup
*/
#define XDG_POPUP_REPOSITIONED_SINCE_VERSION 3
/**
* @ingroup iface_xdg_popup
*/
#define XDG_POPUP_DESTROY_SINCE_VERSION 1
/**
* @ingroup iface_xdg_popup
*/
#define XDG_POPUP_GRAB_SINCE_VERSION 1
/**
* @ingroup iface_xdg_popup
*/
#define XDG_POPUP_REPOSITION_SINCE_VERSION 3
/** @ingroup iface_xdg_popup */
static inline void
xdg_popup_set_user_data(struct xdg_popup *xdg_popup, void *user_data)
{
wl_proxy_set_user_data((struct wl_proxy *) xdg_popup, user_data);
}
/** @ingroup iface_xdg_popup */
static inline void *
xdg_popup_get_user_data(struct xdg_popup *xdg_popup)
{
return wl_proxy_get_user_data((struct wl_proxy *) xdg_popup);
}
static inline uint32_t
xdg_popup_get_version(struct xdg_popup *xdg_popup)
{
return wl_proxy_get_version((struct wl_proxy *) xdg_popup);
}
/**
* @ingroup iface_xdg_popup
*
* This destroys the popup. Explicitly destroying the xdg_popup
* object will also dismiss the popup, and unmap the surface.
*
* If this xdg_popup is not the "topmost" popup, a protocol error
* will be sent.
*/
static inline void
xdg_popup_destroy(struct xdg_popup *xdg_popup)
{
wl_proxy_marshal((struct wl_proxy *) xdg_popup,
XDG_POPUP_DESTROY);
wl_proxy_destroy((struct wl_proxy *) xdg_popup);
}
/**
* @ingroup iface_xdg_popup
*
* This request makes the created popup take an explicit grab. An explicit
* grab will be dismissed when the user dismisses the popup, or when the
* client destroys the xdg_popup. This can be done by the user clicking
* outside the surface, using the keyboard, or even locking the screen
* through closing the lid or a timeout.
*
* If the compositor denies the grab, the popup will be immediately
* dismissed.
*
* This request must be used in response to some sort of user action like a
* button press, key press, or touch down event. The serial number of the
* event should be passed as 'serial'.
*
* The parent of a grabbing popup must either be an xdg_toplevel surface or
* another xdg_popup with an explicit grab. If the parent is another
* xdg_popup it means that the popups are nested, with this popup now being
* the topmost popup.
*
* Nested popups must be destroyed in the reverse order they were created
* in, e.g. the only popup you are allowed to destroy at all times is the
* topmost one.
*
* When compositors choose to dismiss a popup, they may dismiss every
* nested grabbing popup as well. When a compositor dismisses popups, it
* will follow the same dismissing order as required from the client.
*
* The parent of a grabbing popup must either be another xdg_popup with an
* active explicit grab, or an xdg_popup or xdg_toplevel, if there are no
* explicit grabs already taken.
*
* If the topmost grabbing popup is destroyed, the grab will be returned to
* the parent of the popup, if that parent previously had an explicit grab.
*
* If the parent is a grabbing popup which has already been dismissed, this
* popup will be immediately dismissed. If the parent is a popup that did
* not take an explicit grab, an error will be raised.
*
* During a popup grab, the client owning the grab will receive pointer
* and touch events for all their surfaces as normal (similar to an
* "owner-events" grab in X11 parlance), while the top most grabbing popup
* will always have keyboard focus.
*/
static inline void
xdg_popup_grab(struct xdg_popup *xdg_popup, struct wl_seat *seat, uint32_t serial)
{
wl_proxy_marshal((struct wl_proxy *) xdg_popup,
XDG_POPUP_GRAB, seat, serial);
}
/**
* @ingroup iface_xdg_popup
*
* Reposition an already-mapped popup. The popup will be placed given the
* details in the passed xdg_positioner object, and a
* xdg_popup.repositioned followed by xdg_popup.configure and
* xdg_surface.configure will be emitted in response. Any parameters set
* by the previous positioner will be discarded.
*
* The passed token will be sent in the corresponding
* xdg_popup.repositioned event. The new popup position will not take
* effect until the corresponding configure event is acknowledged by the
* client. See xdg_popup.repositioned for details. The token itself is
* opaque, and has no other special meaning.
*
* If multiple reposition requests are sent, the compositor may skip all
* but the last one.
*
* If the popup is repositioned in response to a configure event for its
* parent, the client should send an xdg_positioner.set_parent_configure
* and possibly a xdg_positioner.set_parent_size request to allow the
* compositor to properly constrain the popup.
*
* If the popup is repositioned together with a parent that is being
* resized, but not in response to a configure event, the client should
* send a xdg_positioner.set_parent_size request.
*/
static inline void
xdg_popup_reposition(struct xdg_popup *xdg_popup, struct xdg_positioner *positioner, uint32_t token)
{
wl_proxy_marshal((struct wl_proxy *) xdg_popup,
XDG_POPUP_REPOSITION, positioner, token);
}
#ifdef __cplusplus
}
#endif
#endif
Raw
xdg-shell-protocol.c
/* Generated by wayland-scanner 1.18.0 */
/*
* Copyright © 2008-2013 Kristian Høgsberg
* Copyright © 2013 Rafael Antognolli
* Copyright © 2013 Jasper St. Pierre
* Copyright © 2010-2013 Intel Corporation
* Copyright © 2015-2017 Samsung Electronics Co., Ltd
* Copyright © 2015-2017 Red Hat Inc.
*
* 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.
*/
#include <stdlib.h>
#include <stdint.h>
#include "wayland-util.h"
#ifndef __has_attribute
# define __has_attribute(x) 0 /* Compatibility with non-clang compilers. */
#endif
#if (__has_attribute(visibility) || defined(__GNUC__) && __GNUC__ >= 4)
#define WL_PRIVATE __attribute__ ((visibility("hidden")))
#else
#define WL_PRIVATE
#endif
extern const struct wl_interface wl_output_interface;
extern const struct wl_interface wl_seat_interface;
extern const struct wl_interface wl_surface_interface;
extern const struct wl_interface xdg_popup_interface;
extern const struct wl_interface xdg_positioner_interface;
extern const struct wl_interface xdg_surface_interface;
extern const struct wl_interface xdg_toplevel_interface;
static const struct wl_interface *xdg_shell_types[] = {
NULL,
NULL,
NULL,
NULL,
&xdg_positioner_interface,
&xdg_surface_interface,
&wl_surface_interface,
&xdg_toplevel_interface,
&xdg_popup_interface,
&xdg_surface_interface,
&xdg_positioner_interface,
&xdg_toplevel_interface,
&wl_seat_interface,
NULL,
NULL,
NULL,
&wl_seat_interface,
NULL,
&wl_seat_interface,
NULL,
NULL,
&wl_output_interface,
&wl_seat_interface,
NULL,
&xdg_positioner_interface,
NULL,
};
static const struct wl_message xdg_wm_base_requests[] = {
{ "destroy", "", xdg_shell_types + 0 },
{ "create_positioner", "n", xdg_shell_types + 4 },
{ "get_xdg_surface", "no", xdg_shell_types + 5 },
{ "pong", "u", xdg_shell_types + 0 },
};
static const struct wl_message xdg_wm_base_events[] = {
{ "ping", "u", xdg_shell_types + 0 },
};
WL_PRIVATE const struct wl_interface xdg_wm_base_interface = {
"xdg_wm_base", 3,
4, xdg_wm_base_requests,
1, xdg_wm_base_events,
};
static const struct wl_message xdg_positioner_requests[] = {
{ "destroy", "", xdg_shell_types + 0 },
{ "set_size", "ii", xdg_shell_types + 0 },
{ "set_anchor_rect", "iiii", xdg_shell_types + 0 },
{ "set_anchor", "u", xdg_shell_types + 0 },
{ "set_gravity", "u", xdg_shell_types + 0 },
{ "set_constraint_adjustment", "u", xdg_shell_types + 0 },
{ "set_offset", "ii", xdg_shell_types + 0 },
{ "set_reactive", "3", xdg_shell_types + 0 },
{ "set_parent_size", "3ii", xdg_shell_types + 0 },
{ "set_parent_configure", "3u", xdg_shell_types + 0 },
};
WL_PRIVATE const struct wl_interface xdg_positioner_interface = {
"xdg_positioner", 3,
10, xdg_positioner_requests,
0, NULL,
};
static const struct wl_message xdg_surface_requests[] = {
{ "destroy", "", xdg_shell_types + 0 },
{ "get_toplevel", "n", xdg_shell_types + 7 },
{ "get_popup", "n?oo", xdg_shell_types + 8 },
{ "set_window_geometry", "iiii", xdg_shell_types + 0 },
{ "ack_configure", "u", xdg_shell_types + 0 },
};
static const struct wl_message xdg_surface_events[] = {
{ "configure", "u", xdg_shell_types + 0 },
};
WL_PRIVATE const struct wl_interface xdg_surface_interface = {
"xdg_surface", 3,
5, xdg_surface_requests,
1, xdg_surface_events,
};
static const struct wl_message xdg_toplevel_requests[] = {
{ "destroy", "", xdg_shell_types + 0 },
{ "set_parent", "?o", xdg_shell_types + 11 },
{ "set_title", "s", xdg_shell_types + 0 },
{ "set_app_id", "s", xdg_shell_types + 0 },
{ "show_window_menu", "ouii", xdg_shell_types + 12 },
{ "move", "ou", xdg_shell_types + 16 },
{ "resize", "ouu", xdg_shell_types + 18 },
{ "set_max_size", "ii", xdg_shell_types + 0 },
{ "set_min_size", "ii", xdg_shell_types + 0 },
{ "set_maximized", "", xdg_shell_types + 0 },
{ "unset_maximized", "", xdg_shell_types + 0 },
{ "set_fullscreen", "?o", xdg_shell_types + 21 },
{ "unset_fullscreen", "", xdg_shell_types + 0 },
{ "set_minimized", "", xdg_shell_types + 0 },
};
static const struct wl_message xdg_toplevel_events[] = {
{ "configure", "iia", xdg_shell_types + 0 },
{ "close", "", xdg_shell_types + 0 },
};
WL_PRIVATE const struct wl_interface xdg_toplevel_interface = {
"xdg_toplevel", 3,
14, xdg_toplevel_requests,
2, xdg_toplevel_events,
};
static const struct wl_message xdg_popup_requests[] = {
{ "destroy", "", xdg_shell_types + 0 },
{ "grab", "ou", xdg_shell_types + 22 },
{ "reposition", "3ou", xdg_shell_types + 24 },
};
static const struct wl_message xdg_popup_events[] = {
{ "configure", "iiii", xdg_shell_types + 0 },
{ "popup_done", "", xdg_shell_types + 0 },
{ "repositioned", "3u", xdg_shell_types + 0 },
};
WL_PRIVATE const struct wl_interface xdg_popup_interface = {
"xdg_popup", 3,
3, xdg_popup_requests,
3, xdg_popup_events,
};
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment