1 files changed, 312 insertions, 0 deletions
diff --git a/include/sway/container.h b/include/sway/container.h
new file mode 100644
index 00000000..4dd7f3a0
--- /dev/null
+++ b/include/sway/container.h
@@ -0,0 +1,312 @@
+#ifndef _SWAY_CONTAINER_H
+#define _SWAY_CONTAINER_H
+#include <sys/types.h>
+#include <wlc/wlc.h>
+
+#include "list.h"
+
+typedef struct sway_container swayc_t;
+
+extern swayc_t root_container;
+
+/**
+ * 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). */
+	// Keep last
+	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 */
+	// Keep last
+	L_LAYOUTS,
+};
+
+enum swayc_border_types {
+	B_NONE,             /**< No border */
+	B_PIXEL,            /**< 1px border */
+	B_NORMAL            /**< Normal border with title bar */
+};
+
+/**
+ * Stores information about a container.
+ *
+ * The tree is made of these. Views are containers that cannot have children.
+ */
+struct sway_container {
+	/**
+	 * If this container maps to a WLC object, this is set to that object's
+	 * handle. Otherwise, NULL.
+	 */
+	wlc_handle handle;
+
+	enum swayc_types type;
+	enum swayc_layouts layout;
+	enum swayc_layouts prev_layout;
+
+	/**
+	 * Width and height of this container, without borders or gaps.
+	 */
+	double width, height;
+
+	/**
+	 * Views may request geometry, which is stored in this and ignored until
+	 * the views are floated.
+	 */
+	int desired_width, desired_height;
+
+	/**
+	 * The coordinates that this view appear at, relative to the output they
+	 * are located on (output containers have absolute coordinates).
+	 */
+	double x, y;
+
+	/**
+	 * Cached geometry used to store view/container geometry when switching
+	 * between tabbed/stacked and horizontal/vertical layouts.
+	 */
+	struct wlc_geometry cached_geometry;
+
+	/**
+	 * False if this view is invisible. It could be in the scratchpad or on a
+	 * workspace that is not shown.
+	 */
+	bool visible;
+	bool is_floating;
+	bool is_focused;
+	bool sticky; // floating view always visible on its output
+
+	// Attributes that mostly views have.
+	char *name;
+	char *class;
+	char *app_id;
+
+	// Used by output containers to keep track of swaybg child processes.
+	pid_t bg_pid;
+
+	int gaps;
+
+	list_t *children;
+	/**
+	 * Children of this container that are floated.
+	 */
+	list_t *floating;
+	/**
+	 * Unmanaged view handles in this container.
+	 */
+	list_t *unmanaged;
+
+	/**
+	 * 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;
+	/**
+	 * If this container's children include a fullscreen view, this is that view.
+	 */
+	struct sway_container *fullscreen;
+	/**
+	 * If this container is a view, this may be set to the window's decoration
+	 * buffer (or NULL).
+	 */
+	struct border *border;
+	enum swayc_border_types border_type;
+	struct wlc_geometry border_geometry;
+	struct wlc_geometry title_bar_geometry;
+	struct wlc_geometry actual_geometry;
+	int border_thickness;
+};
+
+enum visibility_mask {
+	VISIBLE = true
+} visible;
+
+/**
+ * Allocates a new output container.
+ */
+swayc_t *new_output(wlc_handle handle);
+/**
+ * Allocates a new workspace container.
+ */
+swayc_t *new_workspace(swayc_t *output, const char *name);
+/**
+ * Allocates a new container and places a child into it.
+ *
+ * This is used from the split command, which creates a new container with the
+ * requested layout and replaces the focused container in the tree with the new
+ * one. Then the removed container is added as a child of the new container.
+ */
+swayc_t *new_container(swayc_t *child, enum swayc_layouts layout);
+/**
+ * Allocates a new view container.
+ *
+ * Pass in a sibling view, or a workspace to become this container's parent.
+ */
+swayc_t *new_view(swayc_t *sibling, wlc_handle handle);
+/**
+ * Allocates a new floating view in the active workspace.
+ */
+swayc_t *new_floating_view(wlc_handle handle);
+
+void floating_view_sane_size(swayc_t *view);
+
+/**
+ * Frees an output's container.
+ */
+swayc_t *destroy_output(swayc_t *output);
+/**
+ * Destroys a workspace container and returns the parent pointer, or NULL.
+ */
+swayc_t *destroy_workspace(swayc_t *workspace);
+/**
+ * Destroys a container and all empty parents. Returns the topmost non-empty
+ * parent container, or NULL.
+ */
+swayc_t *destroy_container(swayc_t *container);
+/**
+ * Destroys a view container and all empty parents. Returns the topmost
+ * non-empty parent container, or NULL.
+ */
+swayc_t *destroy_view(swayc_t *view);
+
+/**
+ * Finds a container based on test criteria. Returns the first container that
+ * passes the test.
+ */
+swayc_t *swayc_by_test(swayc_t *container, bool (*test)(swayc_t *view, void *data), void *data);
+/**
+ * Finds a parent container with the given swayc_type.
+ */
+swayc_t *swayc_parent_by_type(swayc_t *container, enum swayc_types);
+/**
+ * Finds a parent with the given swayc_layout.
+ */
+swayc_t *swayc_parent_by_layout(swayc_t *container, enum swayc_layouts);
+/**
+ * Finds the bottom-most focused container of a type.
+ */
+swayc_t *swayc_focus_by_type(swayc_t *container, enum swayc_types);
+/**
+ * Finds the bottom-most focused container of a layout.
+ */
+swayc_t *swayc_focus_by_layout(swayc_t *container, enum swayc_layouts);
+
+/**
+ * Gets the swayc_t associated with a wlc_handle.
+ */
+swayc_t *swayc_by_handle(wlc_handle handle);
+/**
+ * Gets the named swayc_t.
+ */
+swayc_t *swayc_by_name(const char *name);
+/**
+ * Gets the active output's container.
+ */
+swayc_t *swayc_active_output(void);
+/**
+ * Gets the active workspace's container.
+ */
+swayc_t *swayc_active_workspace(void);
+/**
+ * Gets the workspace for the given view container.
+ */
+swayc_t *swayc_active_workspace_for(swayc_t *view);
+/**
+ * Finds the container currently underneath the pointer.
+ */
+swayc_t *container_under_pointer(void);
+
+/**
+ * Returns true if a container is fullscreen.
+ */
+bool swayc_is_fullscreen(swayc_t *view);
+/**
+ * Returns true if this view is focused.
+ */
+bool swayc_is_active(swayc_t *view);
+/**
+ * Returns true if the parent is an ancestor of the child.
+ */
+bool swayc_is_parent_of(swayc_t *parent, swayc_t *child);
+/**
+ * Returns true if the child is a desecendant of the parent.
+ */
+bool swayc_is_child_of(swayc_t *child, swayc_t *parent);
+
+/**
+ * Returns true if this container is an empty workspace.
+ */
+bool swayc_is_empty_workspace(swayc_t *container);
+
+/**
+ * Returns the top most tabbed or stacked parent container. Returns NULL if
+ * view is not in a tabbed/stacked layout.
+ */
+swayc_t *swayc_tabbed_stacked_ancestor(swayc_t *view);
+
+/**
+ * Returns the immediate tabbed or stacked parent container. Returns NULL if
+ * view is not directly in a tabbed/stacked layout.
+ */
+swayc_t *swayc_tabbed_stacked_parent(swayc_t *view);
+
+/**
+ * Returns the gap (padding) of the container.
+ *
+ * This returns the inner gaps for a view, the outer gaps for a workspace, and
+ * 0 otherwise.
+ */
+int swayc_gap(swayc_t *container);
+
+/**
+ * Maps a container's children over a function.
+ */
+void container_map(swayc_t *, void (*f)(swayc_t *, void *), void *);
+
+/**
+ * Set a view as visible or invisible.
+ *
+ * This will perform the required wlc calls as well; it is not sufficient to
+ * simply toggle the boolean in swayc_t.
+ */
+void set_view_visibility(swayc_t *view, void *data);
+/**
+ * Set the gaps value for a view.
+ */
+void set_gaps(swayc_t *view, void *amount);
+/**
+ * Add to the gaps value for a view.
+ */
+void add_gaps(swayc_t *view, void *amount);
+
+/**
+ * Issue wlc calls to make the visibility of a container consistent.
+ */
+void update_visibility(swayc_t *container);
+
+/**
+ * Close all child views of container
+ */
+void close_views(swayc_t *container);
+
+#endif