#include <config.h>
#include "data.h"
#include "tree.h"
#include "randr.h"

Include dependency graph for workspace.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	NET_WM_DESKTOP_NONE 0xFFFFFFF0

#define	NET_WM_DESKTOP_ALL 0xFFFFFFFF

Functions
Con *	get_existing_workspace_by_name (const char *name)
	Returns the workspace with the given name or NULL if such a workspace does not exist. More...

Con *	get_existing_workspace_by_num (int num)
	Returns the workspace with the given number or NULL if such a workspace does not exist. More...

bool	output_triggers_assignment (Output output, struct Workspace_Assignment assignment)
	Returns true if the first output assigned to a workspace with the given workspace assignment is the same as the given output. More...

Con *	workspace_get (const char num, bool created)
	Returns a pointer to the workspace with the given number (starting at 0), creating the workspace if necessary (by allocating the necessary amount of memory and initializing the data structures correctly). More...

void	extract_workspace_names_from_bindings (void)
	Extracts workspace names from keybindings (e.g. More...

Con *	create_workspace_on_output (Output output, Con content)
	Returns a pointer to a new workspace in the given output. More...

bool	workspace_is_visible (Con *ws)
	Returns true if the workspace is currently visible. More...

void	workspace_show (Con *ws)
	Switches to the given workspace. More...

void	workspace_show_by_name (const char *num)
	Looks up the workspace by name and switches to it. More...

Con *	workspace_next (void)
	Returns the next workspace. More...

Con *	workspace_prev (void)
	Returns the previous workspace. More...

Con *	workspace_next_on_output (void)
	Returns the next workspace on the same output. More...

Con *	workspace_prev_on_output (void)
	Returns the previous workspace on the same output. More...

void	workspace_back_and_forth (void)
	Focuses the previously focused workspace. More...

Con *	workspace_back_and_forth_get (void)
	Returns the previously focused workspace con, or NULL if unavailable. More...

void	workspace_update_urgent_flag (Con *ws)
	Goes through all clients on the given workspace and updates the workspace’s urgent flag accordingly. More...

void	ws_force_orientation (Con *ws, orientation_t orientation)
	'Forces' workspace orientation by moving all cons into a new split-con with the same orientation as the workspace and then changing the workspace orientation. More...

Con *	workspace_attach_to (Con *ws)
	Called when a new con (with a window, not an empty or split con) should be attached to the workspace (for example when managing a new window or when moving an existing window to the workspace level). More...

Con *	workspace_encapsulate (Con *ws)
	Creates a new container and re-parents all of children from the given workspace into it. More...

void	workspace_move_to_output (Con ws, Output output)
	Move the given workspace to the specified output. More...

Variables
char *	previous_workspace_name
	Stores a copy of the name of the last used workspace for the workspace back-and-forth switching. More...

Macro Definition Documentation

◆ NET_WM_DESKTOP_ALL

#define NET_WM_DESKTOP_ALL 0xFFFFFFFF

Definition at line 25 of file workspace.h.

Referenced by ewmh_update_wm_desktop_recursively(), handle_client_message(), and manage_window().

◆ NET_WM_DESKTOP_NONE

#define NET_WM_DESKTOP_NONE 0xFFFFFFF0

Definition at line 24 of file workspace.h.

Referenced by ewmh_get_workspace_by_index(), ewmh_get_workspace_index(), ewmh_update_current_desktop(), ewmh_update_wm_desktop_recursively(), and manage_window().

Function Documentation

◆ create_workspace_on_output()

Con* create_workspace_on_output	(	Output *	output,
		Con *	content
	)

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.

Definition at line 235 of file workspace.c.

References _workspace_apply_default_orientation(), binding_workspace_names, CF_OUTPUT, con_attach(), con_new(), config, Config::default_layout, DLOG, Con::fullscreen_mode, get_assigned_output(), get_existing_workspace_by_name(), get_existing_workspace_by_num(), ipc_send_workspace_event(), LOG, Workspace_Assignment::name, Con::name, Con::num, Workspace_Assignment::output, sasprintf(), sstrdup(), Con::type, Con::workspace_layout, ws_name_to_number(), and x_set_name().

Referenced by init_ws_for_output(), and workspace_move_to_output().

Here is the call graph for this function:

◆ extract_workspace_names_from_bindings()

void extract_workspace_names_from_bindings ( void )

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.

Definition at line 181 of file workspace.c.

References binding_workspace_names, bindings, Binding::command, DLOG, FREE, LOG, parse_string(), srealloc(), and TAILQ_FOREACH.

Referenced by parse_file().

Here is the call graph for this function:

◆ get_existing_workspace_by_name()

Con* get_existing_workspace_by_name ( const char * name )

Returns the workspace with the given name or NULL if such a workspace does not exist.

Definition at line 30 of file workspace.c.

References croot, GREP_FIRST, Con::nodes_head, output_get_content(), and TAILQ_FOREACH.

Referenced by cmd_rename_workspace(), create_workspace_on_output(), init_ws_for_output(), json_end_map(), workspace_get(), and workspace_move_to_output().

Here is the call graph for this function:

◆ get_existing_workspace_by_num()

Con* get_existing_workspace_by_num ( int num )

Returns the workspace with the given number or NULL if such a workspace does not exist.

Definition at line 44 of file workspace.c.

References croot, GREP_FIRST, Con::nodes_head, Con::num, output_get_content(), and TAILQ_FOREACH.

Referenced by cmd_move_con_to_workspace_number(), cmd_workspace_number(), create_workspace_on_output(), and manage_window().

Here is the call graph for this function:

◆ output_triggers_assignment()

bool output_triggers_assignment	(	Output *	output,
		struct Workspace_Assignment *	assignment
	)

Returns true if the first output assigned to a workspace with the given workspace assignment is the same as the given output.

Definition at line 114 of file workspace.c.

References get_assigned_output(), Workspace_Assignment::name, and Workspace_Assignment::output.

Referenced by cmd_rename_workspace(), init_ws_for_output(), and workspace_move_to_output().

Here is the call graph for this function:

◆ workspace_attach_to()

Con* workspace_attach_to ( Con * ws )

Called when a new con (with a window, not an empty or split con) should be attached to the workspace (for example when managing a new window or when moving an existing window to the workspace level).

Depending on the workspace_layout setting, this function either returns the workspace itself (default layout) or creates a new stacked/tabbed con and returns that.

Definition at line 895 of file workspace.c.

References con_attach(), con_fix_percent(), con_new(), DLOG, L_DEFAULT, Con::layout, Con::name, and Con::workspace_layout.

Referenced by _con_attach(), and insert_con_into().

Here is the call graph for this function:

◆ workspace_back_and_forth()

void workspace_back_and_forth ( void )

Focuses the previously focused workspace.

Definition at line 795 of file workspace.c.

References DLOG, previous_workspace_name, and workspace_show_by_name().

Referenced by cmd_workspace_back_and_forth(), and maybe_back_and_forth().

Here is the call graph for this function:

◆ workspace_back_and_forth_get()

Con* workspace_back_and_forth_get ( void )

Returns the previously focused workspace con, or NULL if unavailable.

Definition at line 808 of file workspace.c.

References DLOG, previous_workspace_name, and workspace_get().

Referenced by cmd_move_con_to_workspace_back_and_forth(), and maybe_auto_back_and_forth_workspace().

Here is the call graph for this function:

◆ workspace_encapsulate()

Con* workspace_encapsulate ( Con * ws )

Creates a new container and re-parents all of children from the given workspace into it.

The container inherits the layout from the workspace.

Definition at line 927 of file workspace.c.

References con_attach(), con_detach(), con_new(), DLOG, ELOG, get_focus_order(), Con::layout, Con::name, Con::nodes_head, set_focus_order(), TAILQ_EMPTY, and TAILQ_FIRST.

Referenced by _con_move_to_con(), and tree_split().

Here is the call graph for this function:

◆ workspace_get()

Con* workspace_get	(	const char *	num,
		bool *	created
	)

Returns a pointer to the workspace with the given number (starting at 0), creating the workspace if necessary (by allocating the necessary amount of memory and initializing the data structures correctly).

If created is not NULL, *created will be set to whether or not the workspace has just been created.

Definition at line 125 of file workspace.c.

References _workspace_apply_default_orientation(), con_attach(), con_get_output(), con_new(), config, Config::default_layout, ewmh_update_desktop_properties(), focused, FREE, get_assigned_output(), get_existing_workspace_by_name(), ipc_send_workspace_event(), LOG, Workspace_Assignment::name, Con::name, Con::num, Workspace_Assignment::output, output_get_content(), Con::parent, sasprintf(), sstrdup(), Con::type, Con::workspace_layout, ws_name_to_number(), and x_set_name().

Referenced by cmd_focus(), cmd_move_con_to_workspace_name(), cmd_move_con_to_workspace_number(), handle_client_message(), manage_window(), scratchpad_fix_resolution(), scratchpad_move(), scratchpad_show(), workspace_back_and_forth_get(), workspace_move_to_output(), and workspace_show_by_name().

Here is the call graph for this function:

◆ workspace_is_visible()

bool workspace_is_visible ( Con * ws )

Returns true if the workspace is currently visible.

Especially important for multi-monitor environments, as they can have multiple currenlty active workspaces.

Definition at line 299 of file workspace.c.

References CF_OUTPUT, con_get_fullscreen_con(), con_get_output(), LOG, and Workspace_Assignment::output.

Referenced by _tree_next(), cmd_focus_output(), con_move_to_output(), con_on_remove_child(), handle_client_message(), handle_configure_request(), IPC_HANDLER(), manage_window(), move_to_output_directed(), output_push_sticky_windows(), workspace_move_to_output(), and workspace_show().

Here is the call graph for this function:

◆ workspace_move_to_output()

void workspace_move_to_output	(	Con *	ws,
		Output *	output
	)

Move the given workspace to the specified output.

Definition at line 959 of file workspace.c.

References CALL, con_attach(), con_detach(), con_num_children(), create_workspace_on_output(), DLOG, floating_fix_coordinates(), Con::floating_head, Con::focus_head, get_existing_workspace_by_name(), get_output_for_con(), ipc_send_workspace_event(), Workspace_Assignment::name, Con::name, Con::nodes_head, Workspace_Assignment::output, output_get_content(), output_primary_name(), output_triggers_assignment(), Con::parent, Con::rect, TAILQ_FIRST, TAILQ_FOREACH, workspace_get(), workspace_is_visible(), workspace_show(), and ws_assignments.

Referenced by cmd_move_workspace_to_output(), cmd_rename_workspace(), and init_ws_for_output().

Here is the call graph for this function:

◆ workspace_next()

Con* workspace_next ( void )

Returns the next workspace.

Definition at line 554 of file workspace.c.

References con_get_workspace(), con_is_internal(), croot, focused, NODES_FOREACH, Con::nodes_head, Con::num, Workspace_Assignment::output, output_get_content(), TAILQ_FOREACH, and TAILQ_NEXT.

Referenced by cmd_move_con_to_workspace(), and cmd_workspace().

Here is the call graph for this function:

◆ workspace_next_on_output()

Con* workspace_next_on_output ( void )

Returns the next workspace on the same output.

Definition at line 683 of file workspace.c.

References con_get_output(), con_get_workspace(), focused, NODES_FOREACH, Con::num, Workspace_Assignment::output, output_get_content(), and TAILQ_NEXT.

Referenced by cmd_move_con_to_workspace(), and cmd_workspace().

Here is the call graph for this function:

◆ workspace_prev()

Con* workspace_prev ( void )

Returns the previous workspace.

Definition at line 617 of file workspace.c.

References con_get_workspace(), con_is_internal(), croot, focused, NODES_FOREACH_REVERSE, Con::nodes_head, Con::num, Workspace_Assignment::output, output_get_content(), TAILQ_FOREACH_REVERSE, and TAILQ_PREV.

Referenced by cmd_move_con_to_workspace(), and cmd_workspace().

Here is the call graph for this function:

◆ workspace_prev_on_output()

Con* workspace_prev_on_output ( void )

Returns the previous workspace on the same output.

Definition at line 738 of file workspace.c.

References con_get_output(), con_get_workspace(), DLOG, focused, NODES_FOREACH_REVERSE, Con::num, Workspace_Assignment::output, output_get_content(), and TAILQ_PREV.

Referenced by cmd_move_con_to_workspace(), and cmd_workspace().

Here is the call graph for this function:

◆ workspace_show()

void workspace_show ( Con * ws )

Switches to the given workspace.

Definition at line 412 of file workspace.c.

References CF_NONE, CF_OUTPUT, con_descend_focused(), con_focus(), con_get_output(), con_get_workspace(), con_is_internal(), config, DLOG, DONT_KILL_WINDOW, ewmh_update_current_desktop(), ewmh_update_desktop_properties(), Con::floating_head, focused, FREE, Con::fullscreen_mode, ipc_marshal_workspace_event(), ipc_send_event(), ipc_send_workspace_event(), LOG, main_loop, Con::name, Con::nodes_head, output_push_sticky_windows(), Con::parent, previous_workspace_name, Con::rect, scalloc(), sstrdup(), TAILQ_EMPTY, TAILQ_FOREACH, tree_close_internal(), Con::urgency_timer, Con::urgent, workspace_defer_update_urgent_hint_cb(), workspace_is_visible(), workspace_reassign_sticky(), Config::workspace_urgency_timer, x_set_warp_to(), and y.

Referenced by _con_move_to_con(), _tree_next(), check_crossing_screen_boundary(), cmd_focus(), cmd_focus_output(), cmd_rename_workspace(), cmd_workspace(), cmd_workspace_number(), con_enable_fullscreen(), floating_maybe_reassign_ws(), handle_button_press(), handle_client_message(), handle_configure_request(), handle_enter_notify(), handle_focus_in(), init_ws_for_output(), move_to_output_directed(), randr_disable_output(), randr_query_outputs(), route_click(), scratchpad_show(), workspace_move_to_output(), and workspace_show_by_name().

Here is the call graph for this function:

◆ workspace_show_by_name()

void workspace_show_by_name ( const char * num )

Looks up the workspace by name and switches to it.

Definition at line 544 of file workspace.c.

References workspace_get(), and workspace_show().

Referenced by cmd_workspace_name(), cmd_workspace_number(), init_ws_for_output(), and workspace_back_and_forth().

Here is the call graph for this function:

◆ workspace_update_urgent_flag()

void workspace_update_urgent_flag ( Con * ws )

Goes through all clients on the given workspace and updates the workspace’s urgent flag accordingly.

Definition at line 838 of file workspace.c.

References DLOG, get_urgency_flag(), ipc_send_workspace_event(), and Con::urgent.

Referenced by _con_move_to_con(), con_focus(), con_set_urgency(), tree_close_internal(), and workspace_defer_update_urgent_hint_cb().

Here is the call graph for this function:

◆ ws_force_orientation()

void ws_force_orientation	(	Con *	ws,
		orientation_t	orientation
	)

'Forces' workspace orientation by moving all cons into a new split-con with the same orientation as the workspace and then changing the workspace orientation.

Definition at line 852 of file workspace.c.

References con_attach(), con_detach(), con_fix_percent(), con_new(), DLOG, get_focus_order(), HORIZ, L_SPLITH, L_SPLITV, Con::layout, Con::nodes_head, Con::parent, set_focus_order(), TAILQ_EMPTY, and TAILQ_FIRST.

Referenced by tree_move().

Here is the call graph for this function:

Variable Documentation

◆ previous_workspace_name

char* previous_workspace_name

Stores a copy of the name of the last used workspace for the workspace back-and-forth switching.

Definition at line 19 of file workspace.c.

Referenced by dump_node(), json_string(), workspace_back_and_forth(), workspace_back_and_forth_get(), and workspace_show().

Macros

Functions

Variables

Macro Definition Documentation

◆ NET_WM_DESKTOP_ALL

◆ NET_WM_DESKTOP_NONE

Function Documentation

◆ create_workspace_on_output()

◆ extract_workspace_names_from_bindings()

◆ get_existing_workspace_by_name()

◆ get_existing_workspace_by_num()

◆ output_triggers_assignment()

◆ workspace_attach_to()

◆ workspace_back_and_forth()

◆ workspace_back_and_forth_get()

◆ workspace_encapsulate()

◆ workspace_get()

◆ workspace_is_visible()

◆ workspace_move_to_output()

◆ workspace_next()

◆ workspace_next_on_output()

◆ workspace_prev()

◆ workspace_prev_on_output()

◆ workspace_show()

◆ workspace_show_by_name()

◆ workspace_update_urgent_flag()

◆ ws_force_orientation()

Variable Documentation

◆ previous_workspace_name