git.sur5r.net Git - i3/i3/blob - include/workspace.h

   1 /*
   2  * vim:ts=4:sw=4:expandtab
   3  *
   4  * i3 - an improved dynamic tiling window manager
   5  * © 2009 Michael Stapelberg and contributors (see also: LICENSE)
   6  *
   7  * workspace.c: Modifying workspaces, accessing them, moving containers to
   8  *              workspaces.
   9  *
  10  */
  11 #pragma once
  12
  13 #include <config.h>
  14
  15 #include "data.h"
  16 #include "tree.h"
  17 #include "randr.h"
  18
  19 /* We use NET_WM_DESKTOP_NONE for cases where we cannot determine the EWMH
  20  * desktop index for a window. We cannot use a negative value like -1 since we
  21  * need to use uint32_t as we actually need the full range of it. This is
  22  * technically dangerous, but it's safe to assume that we will never have more
  23  * than 4294967279 workspaces open at a time. */
  24 #define NET_WM_DESKTOP_NONE 0xFFFFFFF0
  25 #define NET_WM_DESKTOP_ALL 0xFFFFFFFF
  26
  27 /**
  28  * Returns the workspace with the given name or NULL if such a workspace does
  29  * not exist.
  30  *
  31  */
  32 Con *get_existing_workspace_by_name(const char *name);
  33
  34 /**
  35  * Returns the workspace with the given number or NULL if such a workspace does
  36  * not exist.
  37  *
  38  */
  39 Con *get_existing_workspace_by_num(int num);
  40
  41 /**
  42  * Returns true if the first output assigned to a workspace with the given
  43  * workspace assignment is the same as the given output.
  44  *
  45  */
  46 bool output_triggers_assignment(Output *output, struct Workspace_Assignment *assignment);
  47
  48 /**
  49  * Returns a pointer to the workspace with the given number (starting at 0),
  50  * creating the workspace if necessary (by allocating the necessary amount of
  51  * memory and initializing the data structures correctly).
  52  *
  53  * If created is not NULL, *created will be set to whether or not the
  54  * workspace has just been created.
  55  *
  56  */
  57 Con *workspace_get(const char *num, bool *created);
  58
  59 /**
  60  * Extracts workspace names from keybindings (e.g. “web” from “bindsym $mod+1
  61  * workspace web”), so that when an output needs a workspace, i3 can start with
  62  * the first configured one. Needs to be called before reorder_bindings() so
  63  * that the config-file order is used, not the i3-internal order.
  64  *
  65  */
  66 void extract_workspace_names_from_bindings(void);
  67
  68 /**
  69  * Returns a pointer to a new workspace in the given output. The workspace
  70  * is created attached to the tree hierarchy through the given content
  71  * container.
  72  *
  73  */
  74 Con *create_workspace_on_output(Output *output, Con *content);
  75
  76 /**
  77  * Returns true if the workspace is currently visible. Especially important for
  78  * multi-monitor environments, as they can have multiple currenlty active
  79  * workspaces.
  80  *
  81  */
  82 bool workspace_is_visible(Con *ws);
  83
  84 /**
  85  * Switches to the given workspace
  86  *
  87  */
  88 void workspace_show(Con *ws);
  89
  90 /**
  91  * Looks up the workspace by name and switches to it.
  92  *
  93  */
  94 void workspace_show_by_name(const char *num);
  95
  96 /**
  97  * Returns the next workspace.
  98  *
  99  */
 100 Con *workspace_next(void);
 101
 102 /**
 103  * Returns the previous workspace.
 104  *
 105  */
 106 Con *workspace_prev(void);
 107
 108 /**
 109  * Returns the next workspace on the same output
 110  *
 111  */
 112 Con *workspace_next_on_output(void);
 113
 114 /**
 115  * Returns the previous workspace on the same output
 116  *
 117  */
 118 Con *workspace_prev_on_output(void);
 119
 120 /**
 121  * Focuses the previously focused workspace.
 122  *
 123  */
 124 void workspace_back_and_forth(void);
 125
 126 /**
 127  * Returns the previously focused workspace con, or NULL if unavailable.
 128  *
 129  */
 130 Con *workspace_back_and_forth_get(void);
 131
 132 #if 0
 133 /**
 134  * Assigns the given workspace to the given screen by correctly updating its
 135  * state and reconfiguring all the clients on this workspace.
 136  *
 137  * This is called when initializing a screen and when re-assigning it to a
 138  * different screen which just got available (if you configured it to be on
 139  * screen 1 and you just plugged in screen 1).
 140  *
 141  */
 142 void workspace_assign_to(Workspace *ws, Output *screen, bool hide_it);
 143
 144 /**
 145  * Initializes the given workspace if it is not already initialized. The given
 146  * screen is to be understood as a fallback, if the workspace itself either
 147  * was not assigned to a particular screen or cannot be placed there because
 148  * the screen is not attached at the moment.
 149  *
 150  */
 151 void workspace_initialize(Workspace *ws, Output *screen, bool recheck);
 152
 153 /**
 154  * Gets the first unused workspace for the given screen, taking into account
 155  * the preferred_screen setting of every workspace (workspace assignments).
 156  *
 157  */
 158 Workspace *get_first_workspace_for_output(Output *screen);
 159
 160 /**
 161  * Unmaps all clients (and stack windows) of the given workspace.
 162  *
 163  * This needs to be called separately when temporarily rendering a workspace
 164  * which is not the active workspace to force reconfiguration of all clients,
 165  * like in src/xinerama.c when re-assigning a workspace to another screen.
 166  *
 167  */
 168 void workspace_unmap_clients(xcb_connection_t *conn, Workspace *u_ws);
 169
 170 /**
 171  * Maps all clients (and stack windows) of the given workspace.
 172  *
 173  */
 174 void workspace_map_clients(xcb_connection_t *conn, Workspace *ws);
 175 #endif
 176
 177 /**
 178  * Goes through all clients on the given workspace and updates the workspace’s
 179  * urgent flag accordingly.
 180  *
 181  */
 182 void workspace_update_urgent_flag(Con *ws);
 183
 184 /**
 185  * 'Forces' workspace orientation by moving all cons into a new split-con with
 186  * the same orientation as the workspace and then changing the workspace
 187  * orientation.
 188  *
 189  */
 190 void ws_force_orientation(Con *ws, orientation_t orientation);
 191
 192 /**
 193  * Called when a new con (with a window, not an empty or split con) should be
 194  * attached to the workspace (for example when managing a new window or when
 195  * moving an existing window to the workspace level).
 196  *
 197  * Depending on the workspace_layout setting, this function either returns the
 198  * workspace itself (default layout) or creates a new stacked/tabbed con and
 199  * returns that.
 200  *
 201  */
 202 Con *workspace_attach_to(Con *ws);
 203
 204 /**
 205  * Creates a new container and re-parents all of children from the given
 206  * workspace into it.
 207  *
 208  * The container inherits the layout from the workspace.
 209  */
 210 Con *workspace_encapsulate(Con *ws);
 211
 212 /**
 213  * Move the given workspace to the specified output.
 214  * This returns true if and only if moving the workspace was successful.
 215  *
 216  */
 217 bool workspace_move_to_output(Con *ws, Output *output);