Merge branch 'release-4.16.1'

[i3/i3] / include / workspace.h

diff --git a/include/workspace.h b/include/workspace.h
index 8e682bb0298405504799c1652e590a8fbffb839b..28d9eb66cd18f8179bd373e5b8362d6ce0a7bd2f 100644 (file)
--- a/include/workspace.h
+++ b/include/workspace.h
@@ -2,19 +2,49 @@
  * vim:ts=4:sw=4:expandtab
  *
  * i3 - an improved dynamic tiling window manager
- * © 2009-2011 Michael Stapelberg and contributors (see also: LICENSE)
+ * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
  *
  * workspace.c: Modifying workspaces, accessing them, moving containers to
  *              workspaces.
  *
  */
-#ifndef _WORKSPACE_H
-#define _WORKSPACE_H
+#pragma once
+
+#include <config.h>
 
 #include "data.h"
 #include "tree.h"
 #include "randr.h"
 
+/* We use NET_WM_DESKTOP_NONE for cases where we cannot determine the EWMH
+ * desktop index for a window. We cannot use a negative value like -1 since we
+ * need to use uint32_t as we actually need the full range of it. This is
+ * technically dangerous, but it's safe to assume that we will never have more
+ * than 4294967279 workspaces open at a time. */
+#define NET_WM_DESKTOP_NONE 0xFFFFFFF0
+#define NET_WM_DESKTOP_ALL 0xFFFFFFFF
+
+/**
+ * Returns the workspace with the given name or NULL if such a workspace does
+ * not exist.
+ *
+ */
+Con *get_existing_workspace_by_name(const char *name);
+
+/**
+ * Returns the workspace with the given number or NULL if such a workspace does
+ * not exist.
+ *
+ */
+Con *get_existing_workspace_by_num(int num);
+
+/**
+ * Returns true if the first output assigned to a workspace with the given
+ * workspace assignment is the same as the given output.
+ *
+ */
+bool output_triggers_assignment(Output *output, struct Workspace_Assignment *assignment);
+
 /**
  * Returns a pointer to the workspace with the given number (starting at 0),
  * creating the workspace if necessary (by allocating the necessary amount of
@@ -26,24 +56,22 @@
  */
 Con *workspace_get(const char *num, bool *created);
 
-/*
- * Returns a pointer to a new workspace in the given output. The workspace
- * is created attached to the tree hierarchy through the given content
- * container.
+/**
+ * Extracts workspace names from keybindings (e.g. “web” from “bindsym $mod+1
+ * workspace web”), so that when an output needs a workspace, i3 can start with
+ * the first configured one. Needs to be called before reorder_bindings() so
+ * that the config-file order is used, not the i3-internal order.
  *
  */
-Con *create_workspace_on_output(Output *output, Con *content);
+void extract_workspace_names_from_bindings(void);
 
-#if 0
 /**
- * Sets the name (or just its number) for the given workspace. This has to
- * be called for every workspace as the rendering function
- * (render_internal_bar) relies on workspace->name and workspace->name_len
- * being ready-to-use.
+ * Returns a pointer to a new workspace in the given output. The workspace
+ * is created attached to the tree hierarchy through the given content
+ * container.
  *
  */
-void workspace_set_name(Workspace *ws, const char *name);
-#endif
+Con *create_workspace_on_output(Output *output, Con *content);
 
 /**
  * Returns true if the workspace is currently visible. Especially important for
@@ -69,32 +97,37 @@ void workspace_show_by_name(const char *num);
  * Returns the next workspace.
  *
  */
-Con* workspace_next();
+Con *workspace_next(void);
 
 /**
  * Returns the previous workspace.
  *
  */
-Con* workspace_prev();
+Con *workspace_prev(void);
 
 /**
  * Returns the next workspace on the same output
  *
  */
-Con* workspace_next_on_output();
+Con *workspace_next_on_output(void);
 
 /**
  * Returns the previous workspace on the same output
  *
  */
-Con* workspace_prev_on_output();
+Con *workspace_prev_on_output(void);
 
 /**
  * Focuses the previously focused workspace.
  *
  */
-void workspace_back_and_forth();
+void workspace_back_and_forth(void);
 
+/**
+ * Returns the previously focused workspace con, or NULL if unavailable.
+ *
+ */
+Con *workspace_back_and_forth_get(void);
 
 #if 0
 /**
@@ -168,4 +201,17 @@ void ws_force_orientation(Con *ws, orientation_t orientation);
  */
 Con *workspace_attach_to(Con *ws);
 
-#endif
+/**
+ * Creates a new container and re-parents all of children from the given
+ * workspace into it.
+ *
+ * The container inherits the layout from the workspace.
+ */
+Con *workspace_encapsulate(Con *ws);
+
+/**
+ * Move the given workspace to the specified output.
+ * This returns true if and only if moving the workspace was successful.
+ *
+ */
+bool workspace_move_to_output(Con *ws, Output *output);