Hyprland/src/wlrunstable/wlr_ext_workspace_v1.hpp

/*
 * This an unstable interface of wlroots. No guarantees are made regarding the
 * future consistency of this API.
 */

#ifndef WLR_TYPES_WLR_WORKSPACE_V1_H
#define WLR_TYPES_WLR_WORKSPACE_V1_H

#include <wayland-server-core.h>
#include <wlr/types/wlr_output.h>

struct wlr_ext_workspace_manager_v1 {
	struct wl_event_loop *event_loop;
	struct wl_event_source *idle_source;

	struct wl_global *global;
	struct wl_list resources; // wl_resource_get_link
	struct wl_list groups; // wlr_ext_workspace_group_handle_v1::link

	struct wl_listener display_destroy;

	struct {
		struct wl_signal commit; // wlr_ext_workspace_manager_v1
		struct wl_signal destroy;
	} events;

	void *data;
};

struct wlr_ext_workspace_group_handle_v1 {
	struct wl_list link; // wlr_ext_workspace_manager_v1::groups
	struct wl_list resources; // wl_ext_resource_get_link

	struct wl_list workspaces; // wlr_ext_workspace_handle_v1::link
	struct wl_list outputs; // wlr_ext_workspace_group_handle_v1_output::link

	struct wlr_ext_workspace_manager_v1 *manager;

	struct {
		// wlr_ext_workspace_group_handle_v1_create_workspace_event
		struct wl_signal create_workspace_request;
		struct wl_signal destroy;
	} events;

	void *data;
};

struct wlr_ext_workspace_group_handle_v1_create_workspace_event {
	struct wlr_ext_workspace_group_handle_v1 *workspace_group;
	const char *name;
};

struct wlr_ext_workspace_group_handle_v1_output {
	struct wl_list link; // wlr_ext_workspace_group_handle_v1::outputs
	struct wl_listener output_bind;
	struct wl_listener output_destroy;
	struct wlr_output *output;

	struct wlr_ext_workspace_group_handle_v1 *group_handle;
};

enum wlr_ext_workspace_handle_v1_state
{
	WLR_EXT_WORKSPACE_HANDLE_V1_STATE_ACTIVE = 1 << 0,
	WLR_EXT_WORKSPACE_HANDLE_V1_STATE_URGENT = 1 << 1,
	WLR_EXT_WORKSPACE_HANDLE_V1_STATE_HIDDEN = 1 << 2,
};

struct wlr_ext_workspace_handle_v1 {
	struct wl_list link; // wlr_ext_workspace_group_handle_v1::workspaces
	struct wl_list resources;

	struct wlr_ext_workspace_group_handle_v1 *group;

	// request from the client
	uint32_t pending, current;

	// set by the compositor
	uint32_t server_state;

	char *name;
	struct wl_array coordinates;

	struct {
		struct wl_signal remove_request;
		struct wl_signal destroy;
	} events;

	void *data;
};

struct wlr_ext_workspace_manager_v1 *wlr_ext_workspace_manager_v1_create(
		struct wl_display *display);

struct wlr_ext_workspace_group_handle_v1 *wlr_ext_workspace_group_handle_v1_create(
		struct wlr_ext_workspace_manager_v1 *manager);

/**
 * Destroy the workspace group and all workspaces inside it.
 */
void wlr_ext_workspace_group_handle_v1_destroy(
	struct wlr_ext_workspace_group_handle_v1 *group);

/**
 * Create a new workspace in the workspace group.
 * Note that the compositor must set the workspace name immediately after
 * creating it.
 */
struct wlr_ext_workspace_handle_v1 *wlr_ext_workspace_handle_v1_create(
		struct wlr_ext_workspace_group_handle_v1 *group);

void wlr_ext_workspace_handle_v1_destroy(
	struct wlr_ext_workspace_handle_v1 *workspace);

void wlr_ext_workspace_group_handle_v1_output_enter(
		struct wlr_ext_workspace_group_handle_v1 *group, struct wlr_output *output);

void wlr_ext_workspace_group_handle_v1_output_leave(
		struct wlr_ext_workspace_group_handle_v1 *group, struct wlr_output *output);

void wlr_ext_workspace_handle_v1_set_name(
		struct wlr_ext_workspace_handle_v1 *workspace, const char* name);

void wlr_ext_workspace_handle_v1_set_coordinates(
		struct wlr_ext_workspace_handle_v1 *workspace, struct wl_array *coordinates);

void wlr_ext_workspace_handle_v1_set_active(
		struct wlr_ext_workspace_handle_v1 *workspace, bool active);

void wlr_ext_workspace_handle_v1_set_urgent(
		struct wlr_ext_workspace_handle_v1 *workspace, bool urgent);

void wlr_ext_workspace_handle_v1_set_hidden(
		struct wlr_ext_workspace_handle_v1 *workspace, bool hidden);

#endif