aboutsummaryrefslogtreecommitdiff
path: root/include/sway/container.h
blob: 08a98ed953c563a8ac15f76cdb65ca387706f070 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
#ifndef _SWAY_CONTAINER_H
#define _SWAY_CONTAINER_H
#include <stdint.h>
#include <sys/types.h>
#include <wlr/types/wlr_box.h>
#include "list.h"

typedef struct sway_container swayc_t;

extern swayc_t root_container;

struct sway_view;

/**
 * Different kinds of containers.
 *
 * This enum is in order. A container will never be inside of a container below
 * it on this list.
 */
enum swayc_types {
	C_ROOT,      /**< The root container. Only one of these ever exists. */
	C_OUTPUT,    /**< An output (aka monitor, head, etc). */
	C_WORKSPACE, /**< A workspace. */
	C_CONTAINER, /**< A manually created container. */
	C_VIEW,      /**< A view (aka window). */

	C_TYPES,
};

/**
 * Different ways to arrange a container.
 */
enum swayc_layouts {
	L_NONE,     /**< Used for containers that have no layout (views, root) */
	L_HORIZ,
	L_VERT,
	L_STACKED,
	L_TABBED,
	L_FLOATING, /**< A psuedo-container, removed from the tree, to hold floating windows */

	/* Awesome/Monad style auto layouts */
	L_AUTO_LEFT,
	L_AUTO_RIGHT,
	L_AUTO_TOP,
	L_AUTO_BOTTOM,

	L_AUTO_FIRST = L_AUTO_LEFT,
	L_AUTO_LAST = L_AUTO_BOTTOM,

	// Keep last
	L_LAYOUTS,
};

enum swayc_border_types {
	B_NONE,   /**< No border */
	B_PIXEL,  /**< 1px border */
	B_NORMAL, /**< Normal border with title bar */
};

struct sway_output;
struct sway_view;
struct wlr_output_layout;

/**
 * Stores information about a container.
 *
 * The tree is made of these. Views are containers that cannot have children.
 */
struct sway_container {
	union {
		// TODO: Encapsulate state for other node types as well like C_CONTAINER
		struct wlr_output_layout *output_layout; // C_ROOT
		struct sway_output *sway_output;         // C_OUTPUT
		struct sway_view *sway_view;             // C_VIEW
	};

	/**
	 * A unique ID to identify this container. Primarily used in the
	 * get_tree JSON output.
	 */
	size_t id;

	char *name;

	enum swayc_types type;
	enum swayc_layouts layout;
	enum swayc_layouts prev_layout;
	enum swayc_layouts workspace_layout;

	/**
	 * The coordinates that this view appear at, relative to the output they
	 * are located on (output containers have absolute coordinates).
	 */
	double x, y;

	/**
	 * Width and height of this container, without borders or gaps.
	 */
	double width, height;

	list_t *children;

	/**
	 * The parent of this container. NULL for the root container.
	 */
	struct sway_container *parent;
	/**
	 * Which of this container's children has focus.
	 */
	struct sway_container *focused;

	/**
	 * Number of master views in auto layouts.
	 */
	size_t nb_master;

	/**
	 * Number of slave groups (e.g. columns) in auto layouts.
	 */
	size_t nb_slave_groups;

	/**
	 * Marks applied to the container, list_t of char*.
	 */
	list_t *marks;
};

void swayc_descendants_of_type(swayc_t *root, enum swayc_types type,
		void (*func)(swayc_t *item, void *data), void *data);

swayc_t *new_output(struct sway_output *sway_output);
swayc_t *new_workspace(swayc_t *output, const char *name);
swayc_t *new_view(swayc_t *sibling, struct sway_view *sway_view);

swayc_t *destroy_view(swayc_t *view);

swayc_t *swayc_parent_by_type(swayc_t *container, enum swayc_types type);

#endif