i3-compatible Wayland compositor
Go to file
Ryan Dwyer 7586f150c0 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-09-05 18:01:43 +10:00
assets Recompressed PNG files 2017-01-05 21:49:28 -05:00
client Change _XOPEN_SOURCE defines to _POSIX_C_SOURCE 2018-09-03 09:08:49 +02:00
common prevent ub caused by misaligned stores/loads 2018-09-02 17:07:12 -07:00
completions added untested files 2018-08-26 18:53:51 +03:00
contrib Move awesome config to contrib/ 2017-01-14 16:03:41 -05:00
include Implement type safe arguments and demote sway_container 2018-09-05 18:01:43 +10:00
protocols Swaylock: Allow per-output images 2018-05-20 22:54:09 +10:00
security.d delete references to swaygrab 2018-07-30 16:24:46 +01:00
sway Implement type safe arguments and demote sway_container 2018-09-05 18:01:43 +10:00
swaybar Change _XOPEN_SOURCE defines to _POSIX_C_SOURCE 2018-09-03 09:08:49 +02:00
swaybg Allow a fallback color to be specified for swaybg 2018-08-08 15:37:06 -04:00
swayidle delete references to swaygrab 2018-07-30 16:24:46 +01:00
swaylock Add FreeBSD-specific PAM configuration 2018-08-30 09:58:57 +02:00
swaymsg ipc: add tick event 2018-08-01 16:57:15 +01:00
swaynag Fix bad-free in swaynag 2018-08-20 15:06:12 -04:00
.build.yml Add scdoc to .build.yml 2018-05-11 21:40:52 -04:00
.clang-format Update .clang-format - not entirely usable yet 2017-01-10 23:30:34 -05:00
.editorconfig Create .editorconfig 2016-07-04 14:12:32 +02:00
.gitignore Add subprojects to gitignore 2018-03-28 12:22:28 -04:00
config.in config.in: nag user on exit 2018-08-02 15:42:43 +01:00
CONTRIBUTING.md Update for swaywm/wlroots#1126 2018-07-09 22:54:30 +01:00
HACKING.md Update for swaywm/wlroots#1126 2018-07-09 22:54:30 +01:00
LICENSE MIT license 2017-01-06 13:45:48 -05:00
meson.build Merge remote-tracking branch 'upstream/master' into fix-freebsd-build 2018-09-03 08:57:17 +02:00
meson_options.txt fix window_type with disabled xwayland support 2018-09-03 11:17:07 +02:00
README.bg.md spellcheck and help add. 2018-08-28 17:06:15 +03:00
README.de.md Remove setcap instructions 2018-08-08 11:40:33 -04:00
README.el.md Remove setcap instructions 2018-08-08 11:40:33 -04:00
README.fr.md Remove setcap instructions 2018-08-08 11:40:33 -04:00
README.it.md Remove setcap instructions 2018-08-08 11:40:33 -04:00
README.ja.md 私の日本語が上手じゃないですね 2018-08-08 11:53:11 -04:00
README.md added ref to bulgarian translation 2018-08-28 17:12:38 +03:00
README.pt.md delete references to swaygrab 2018-07-30 16:24:46 +01:00
README.ru.md delete references to swaygrab 2018-07-30 16:24:46 +01:00
README.uk.md delete references to swaygrab 2018-07-30 16:24:46 +01:00
sway.desktop Add Wayland and Xorg session files 2015-08-20 23:12:34 +02:00

sway

English - 日本語 - Deutsch - Ελληνικά - Français - Українська - Italiano - Português - Русский - Български

"SirCmpwn's Wayland compositor" is a work in progress i3-compatible Wayland compositor. Read the FAQ. Join the IRC channel (#sway on irc.freenode.net).

Notice: You are viewing the unstable and unsupported master branch of sway, where work is ongoing to port it to wlroots. The supported branch is the 0.15 branch, and end users are encouraged to use the stable releases cut from it.

If you'd like to support sway development, please contribute to SirCmpwn's Patreon page.

Release Signatures

Releases are signed with B22DA89A and published on GitHub.

Status

Installation

From Packages

Sway is available in many distributions. Try installing the "sway" package for yours. If it's not available, check out this wiki page for information on installation for your distributions.

If you're interested in packaging sway for your distribution, stop by the IRC channel or shoot an email to sir@cmpwn.com for advice.

Compiling from Source

Install dependencies:

  • meson
  • wlroots
  • wayland
  • xwayland
  • libinput >= 1.6.0
  • libcap
  • pcre
  • json-c >= 0.13
  • pango
  • cairo
  • gdk-pixbuf2 *
  • pam **
  • dbus >= 1.10 ***
  • scdoc (required for man pages)

*Only required for swaybar, swaybg, and swaylock

**Only required for swaylock

***Only required for tray support

Run these commands:

meson build
ninja -C build
sudo ninja -C build install

On systems without logind, you need to suid the sway binary:

sudo chmod a+s /usr/local/bin/sway

Sway will drop root permissions shortly after startup.

Configuration

If you already use i3, then copy your i3 config to ~/.config/sway/config and it'll work out of the box. Otherwise, copy the sample configuration file to ~/.config/sway/config. It is usually located at /etc/sway/config. Run man 5 sway for information on the configuration.

Running

Run sway from a TTY. Some display managers may work but are not supported by sway (gdm is known to work fairly well).