2018-06-03 16:35:06 +10:00
|
|
|
#ifndef _SWAY_TRANSACTION_H
|
|
|
|
|
#define _SWAY_TRANSACTION_H
|
Implement type safe arguments and demote sway_container
This commit changes the meaning of sway_container so that it only refers
to layout containers and view containers. Workspaces, outputs and the
root are no longer known as containers. Instead, root, outputs,
workspaces and containers are all a type of node, and containers come in
two types: layout containers and view containers.
In addition to the above, this implements type safe variables. This
means we use specific types such as sway_output and sway_workspace
instead of generic containers or nodes. However, it's worth noting that
in a few places places (eg. seat focus and transactions) referring to
them in a generic way is unavoidable which is why we still use nodes in
some places.
If you want a TL;DR, look at node.h, as well as the struct definitions
for root, output, workspace and container. Note that sway_output now
contains a workspaces list, and workspaces now contain a tiling and
floating list, and containers now contain a pointer back to the
workspace.
There are now functions for seat_get_focused_workspace and
seat_get_focused_container. The latter will return NULL if a workspace
itself is focused. Most other seat functions like seat_get_focus and
seat_set_focus now accept and return nodes.
In the config->handler_context struct, current_container has been
replaced with three pointers: node, container and workspace. node is the
same as what current_container was, while workspace is the workspace
that the node resides on and container is the actual container, which
may be NULL if a workspace itself is focused.
The global root_container variable has been replaced with one simply
called root, which is a pointer to the sway_root instance.
The way outputs are created, enabled, disabled and destroyed has
changed. Previously we'd wrap the sway_output in a container when it is
enabled, but as we don't have containers any more it needs a different
approach. The output_create and output_destroy functions previously
created/destroyed the container, but now they create/destroy the
sway_output. There is a new function output_disable to disable an output
without destroying it.
Containers have a new view property. If this is populated then the
container is a view container, otherwise it's a layout container. Like
before, this property is immutable for the life of the container.
Containers have both a `sway_container *parent` and
`sway_workspace *workspace`. As we use specific types now, parent cannot
point to a workspace so it'll be NULL for containers which are direct
children of the workspace. The workspace property is set for all
containers, except those which are hidden in the scratchpad as they have
no workspace.
In some cases we need to refer to workspaces in a container-like way.
For example, workspaces have layout and children, but when using
specific types this makes it difficult. Likewise, it's difficult for a
container to get its parent's layout when the parent could be another
container or a workspace. To make it easier, some helper functions have
been created: container_parent_layout and container_get_siblings.
container_remove_child has been renamed to container_detach and
container_replace_child has been renamed to container_replace.
`container_handle_fullscreen_reparent(con, old_parent)` has had the
old_parent removed. We now unfullscreen the workspace when detaching the
container, so this function is simplified and only needs one argument
now.
container_notify_subtree_changed has been renamed to
container_update_representation. This is more descriptive of its
purpose. I also wanted to be able to call it with whatever container was
changed rather than the container's parent, which makes bubbling up to
the workspace easier.
There are now state structs per node thing. ie. sway_output_state,
sway_workspace_state and sway_container_state.
The focus, move and layout commands have been completely refactored to
work with the specific types. I considered making these a separate PR,
but I'd be backporting my changes only to replace them again, and it's
easier just to test everything at once.
2018-08-30 21:00:10 +10:00
|
|
|
#include <stdint.h>
|
2018-06-03 16:35:06 +10:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Transactions enable us to perform atomic layout updates.
|
|
|
|
|
*
|
2018-07-14 23:14:55 +10:00
|
|
|
* A transaction contains a list of containers and their new state.
|
2018-06-03 16:35:06 +10:00
|
|
|
* A state might contain a new size, or new border settings, or new parent/child
|
|
|
|
|
* relationships.
|
|
|
|
|
*
|
2018-07-14 23:14:55 +10:00
|
|
|
* Committing a transaction makes sway notify of all the affected clients with
|
|
|
|
|
* their new sizes. We then wait for all the views to respond with their new
|
|
|
|
|
* surface sizes. When all are ready, or when a timeout has passed, we apply the
|
|
|
|
|
* updates all at the same time.
|
|
|
|
|
*
|
|
|
|
|
* When we want to make adjustments to the layout, we change the pending state
|
|
|
|
|
* in containers, mark them as dirty and call transaction_commit_dirty(). This
|
|
|
|
|
* create and commits a transaction from the dirty containers.
|
2018-06-03 16:35:06 +10:00
|
|
|
*/
|
|
|
|
|
|
2018-08-15 10:03:55 +10:00
|
|
|
struct sway_transaction_instruction;
|
Implement type safe arguments and demote sway_container
This commit changes the meaning of sway_container so that it only refers
to layout containers and view containers. Workspaces, outputs and the
root are no longer known as containers. Instead, root, outputs,
workspaces and containers are all a type of node, and containers come in
two types: layout containers and view containers.
In addition to the above, this implements type safe variables. This
means we use specific types such as sway_output and sway_workspace
instead of generic containers or nodes. However, it's worth noting that
in a few places places (eg. seat focus and transactions) referring to
them in a generic way is unavoidable which is why we still use nodes in
some places.
If you want a TL;DR, look at node.h, as well as the struct definitions
for root, output, workspace and container. Note that sway_output now
contains a workspaces list, and workspaces now contain a tiling and
floating list, and containers now contain a pointer back to the
workspace.
There are now functions for seat_get_focused_workspace and
seat_get_focused_container. The latter will return NULL if a workspace
itself is focused. Most other seat functions like seat_get_focus and
seat_set_focus now accept and return nodes.
In the config->handler_context struct, current_container has been
replaced with three pointers: node, container and workspace. node is the
same as what current_container was, while workspace is the workspace
that the node resides on and container is the actual container, which
may be NULL if a workspace itself is focused.
The global root_container variable has been replaced with one simply
called root, which is a pointer to the sway_root instance.
The way outputs are created, enabled, disabled and destroyed has
changed. Previously we'd wrap the sway_output in a container when it is
enabled, but as we don't have containers any more it needs a different
approach. The output_create and output_destroy functions previously
created/destroyed the container, but now they create/destroy the
sway_output. There is a new function output_disable to disable an output
without destroying it.
Containers have a new view property. If this is populated then the
container is a view container, otherwise it's a layout container. Like
before, this property is immutable for the life of the container.
Containers have both a `sway_container *parent` and
`sway_workspace *workspace`. As we use specific types now, parent cannot
point to a workspace so it'll be NULL for containers which are direct
children of the workspace. The workspace property is set for all
containers, except those which are hidden in the scratchpad as they have
no workspace.
In some cases we need to refer to workspaces in a container-like way.
For example, workspaces have layout and children, but when using
specific types this makes it difficult. Likewise, it's difficult for a
container to get its parent's layout when the parent could be another
container or a workspace. To make it easier, some helper functions have
been created: container_parent_layout and container_get_siblings.
container_remove_child has been renamed to container_detach and
container_replace_child has been renamed to container_replace.
`container_handle_fullscreen_reparent(con, old_parent)` has had the
old_parent removed. We now unfullscreen the workspace when detaching the
container, so this function is simplified and only needs one argument
now.
container_notify_subtree_changed has been renamed to
container_update_representation. This is more descriptive of its
purpose. I also wanted to be able to call it with whatever container was
changed rather than the container's parent, which makes bubbling up to
the workspace easier.
There are now state structs per node thing. ie. sway_output_state,
sway_workspace_state and sway_container_state.
The focus, move and layout commands have been completely refactored to
work with the specific types. I considered making these a separate PR,
but I'd be backporting my changes only to replace them again, and it's
easier just to test everything at once.
2018-08-30 21:00:10 +10:00
|
|
|
struct sway_view;
|
2018-08-15 10:03:55 +10:00
|
|
|
|
2018-06-03 16:35:06 +10:00
|
|
|
/**
|
2018-07-14 23:14:55 +10:00
|
|
|
* Find all dirty containers, create and commit a transaction containing them,
|
|
|
|
|
* and unmark them as dirty.
|
2018-06-03 16:35:06 +10:00
|
|
|
*/
|
2018-07-14 23:14:55 +10:00
|
|
|
void transaction_commit_dirty(void);
|
2018-06-03 16:35:06 +10:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Notify the transaction system that a view is ready for the new layout.
|
|
|
|
|
*
|
|
|
|
|
* When all views in the transaction are ready, the layout will be applied.
|
|
|
|
|
*/
|
2018-08-15 10:03:55 +10:00
|
|
|
void transaction_notify_view_ready_by_serial(struct sway_view *view,
|
|
|
|
|
uint32_t serial);
|
2018-06-03 16:35:06 +10:00
|
|
|
|
2018-06-24 23:01:09 +10:00
|
|
|
/**
|
|
|
|
|
* Notify the transaction system that a view is ready for the new layout, but
|
|
|
|
|
* identifying the instruction by width and height rather than by serial.
|
|
|
|
|
*
|
|
|
|
|
* This is used by xwayland views, as they don't have serials.
|
|
|
|
|
*/
|
|
|
|
|
void transaction_notify_view_ready_by_size(struct sway_view *view,
|
|
|
|
|
int width, int height);
|
|
|
|
|
|
2018-06-03 16:35:06 +10:00
|
|
|
#endif
|