alex/swayfx
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity
swayfx/sway/sway-ipc.7.scd
Erik Reider 94ebb45ee3
rebase: Sway 1.8 (#78) 
* build: bump wlroots dependency to 0.16.0

* swaymsg: replace if with switch in pretty_print

* swaymsg: add GET_TREE pretty-printing

* swaybar: fix errno handling in status_handle_readable

If getline fails once, it was not reset before the next getline
call. errno is only overwritten by getline on error.

* Add cairo_image_surface_create error handling

cairo_image_surface_create can fail, e.g. when running out of
memory or when the size is too big. Avoid crashing in this case.

Closes: https://github.com/swaywm/sway/issues/6531

* build: bump version to 1.8-dev

Historically we've been sticking with the last release number in
the master branch. However that's a bit confusing, people can't
easily figure out whether they're using a release or a work-in-progress
snapshot. Only the commit hash appended to the version number may
help, but that's not very explicit and disappears when using a
tarball.

We could bump the version in master to the next release number.
However during the RC cycle there would be a downgrade from 1.8 to
1.8-rc1. Also it would be hard to tell the difference between a
stable release and an old snapshot.

This patch introduces a new pre-release identifier, "dev". It's
alphabetically before "rc" so it should be correctly sorted by
semver comparisons. "dev" is upgraded to "rc" (and then to stable)
when doing a release. The master branch always uses a "dev"
version, only release branches use "rc" or stable versions.

* [IPC] Add repeat delay/rate info to keyboard

Closes #6735

wlroots already has the info in the struct so let's access it and print it out.

* input/seat: unset has_focus when focus_stack becomes empty

We currently track the focus of a seat in two ways: we use a list called
focus_stack to track the order in which nodes have been focused, with
the first node representing what's currently focused, and we use a
variable called has_focus to indicate whether anything has focus--i.e.
whether we should actually treat that first node as focused at any given
time.

In a number of places, we treat has_focus as implying that a focused
node exists. If it's true, we attempt to dereference the return value of
seat_get_focus(), our helper function for getting the first node in
focus_list, with no further checks. But this isn't quite correct with
the current implementation of seat_get_focus(): not only does it return
NULL when has_focus is false, it also returns NULL when focus_stack
contains no items.

In most cases, focus_stack never becomes empty and so this doesn't
matter at all. Since focus_stack stores a history of focused nodes, we
rarely remove nodes from it. The exception to this is when a node itself
goes away. In that case, we call seat_node_destroy() to remove it from
focus_stack and free it. But we don't unset has_focus if we've removed
the final node! This lets us get into a state where has_focus is true
but seat_get_focus() returns NULL, leading to a segfault when we try to
dereference it.

Fix the issue both by updating has_focus in seat_node_destroy() and by
adding an assertion in seat_get_focus() that ensures focus_stack and
has_focus are in sync, which will make it easier to track down similar
issues in the future.

Fixes #6395.

[1] There's some discussion in #1585 from when this was implemented
about whether has_focus is actually necessary; it's possible we could
remove it entirely, but for the moment this is the architecture we have.

* swaybar: fix tray_padding vs min-height re: scale

Co-authored-by: xdavidwu <xdavidwuph@gmail.com>

* swaybar: fix tray item icon scaling, positioning

* container: Fix crash when view unmaps + maps quickly

Followup on 4e4898e90f.

If a view quickly maps and unmaps repeatedly, there will be multiple
destroyed containers with same view in a single transaction. Each of
these containers will then try to destroy this view, resulting in use
after free.
The container should only destroy the view if the view still belongs
to the container.

Simple reproducer: couple XMapWindow + XUnmapWindow in a loop followed
by XDestroyWindow.

See #6605

* commands/move: Fix crash when pos_y is omitted

Fixes #6737

* Destroy sub-surfaces with parent layer-shell surface

Closes: https://github.com/swaywm/sway/issues/6337

* Add safety assert in parse_movement_unit

Let's add this just in case a caller passes argc == 0.

References: https://github.com/swaywm/sway/issues/6737#issuecomment-1008082540

* meson: check: false on run_command

Future meson releases will change the default and warns when the
implicit default is used, breaking builds.

Explicitly set check: false to maintain behavior and silence warnings.

* Print deprecation notice when running SUID

SUID privilege drop is needed for the "builtin"-backend of libseat,
which copied our old "direct" backend behavior for the sake of
compatibility and ease of transition.

libseat now has a better alternative in the form of seatd-launch. It
uses the normal seatd daemon and libseat backend and takes care of SUID
for us.

Add a soft deprecation warning to highlight our future intent of
removing this code. The deprecation cycle is needed to avoid surprises
when sway no longer drops privileges.

* xdg-shell: use toplevel geometry to adjust the popup box

`popup_unconstrain` uses view coordinates to init the output box for
popups. However wlroots expects the box to be set in a toplevel surface
coordinate system, which is not always equal to view. The difference
between those is a window geometry set via xdg-shell.

GTK4 reserves some space for client-side decoration and thus has a
window with top left corner not matching to (0, 0) of a surface. The box
calculated without taking that into account was slightly shifted
compared to the actual output and allowed to position part of the popup
off screen.

* build: fix building with basu

02b412a introduced the use of list for sdbus deps, however
it was assuming that all packages which were in a list has a version
higher than 239. That is true for libsystemd and libelogind, since they
use the same versions, however basu is using version numbers which are
way lower than what libsystemd/libelogind are using, so basu only build
is failing.

* Upgrade for wlroots surface refactoring

See [1] for details.

[1]: https://gitlab.freedesktop.org/wlroots/wlroots/-/merge_requests/3412

* commands/focus: drop trailing whitespace

* input/cursor: count pointer gestures as idle activity

Fixes https://github.com/swaywm/sway/issues/6765.

* input/cursor: treat swipe begin as idle activity too

Accidentally overlooked in fd53f80.

* treat fullscreen windows as 'tiled' for commands/focus

* transaction: destroying nodes aren't hidden

Commit 37d7bc6998 ("transaction: Only wait for ack from visible
views") introduced a check which uses view_is_visible() to check if a view
is still visible on the screen. However view_is_visible() will early
return in case the node is in the destroying state. This is incorrect
for transactions, since a destroying view which is visible will trigger
configure events for other clients. This bug was visible when repeatedly
opening and closing two views side by side, since we ignore the
destroying node we get a frame where the still open view is shown with
the old configure values and the rest is the desktop background. The
next frame is than correct again.

Fix this by considering destroying views as visible, we correctly wait
for them and send the configure events to other views in time, fixing
the background flicker.

Fixes #6473

* build: execute wlroots subproject before finding deps

wlroots often requires dependencies more recent than Sway's.
Executing the wlroots subproject first will give Meson a chance to
find these newer dependencies, possibly via subprojects.

The subproject will override the "wlroots" dependency when executed,
so we don't need to use get_variable anymore.

References: https://github.com/swaywm/sway/pull/6498#issuecomment-1001746017

* tray: do not render passive items

https://www.freedesktop.org/wiki/Specifications/StatusNotifierItem/StatusNotifierItem/#org.freedesktop.statusnotifieritem.status

* cmd/swap: error on swapping a container with itself

* input/cursor: pass through pointer hold gestures

This just follows swaywm/wlroots#3047, so `wl_pointer_gestures_v1`
clients can be notified of these events.

* swaynag: remove buffer destruction condition

An address of a variable can never be NULL, so checking it doesn't make
sense; and `destroy_buffer()` can operate on already destroyed buffers
anyway.

Fixes #6780

* Use bools for CLI flags

* xwayland: listen to `request_activate` event

When REAPER submenu is closed `XCB_CLIENT_MESSAGE` with type
`NET_ACTIVE_WINDOW` is sent to set focus to parent menu.

Closes: https://github.com/swaywm/sway/issues/6324

* chore: chase wlr_output_layout_get_box() update

https://gitlab.freedesktop.org/wlroots/wlroots/-/merge_requests/3439

* Chase wlroots xdg-shell refactor

* Minor update to focus_on_window_activation

Removed xwayland limitation since wayland clients are supported via xdg-activation.

* Translated README into Italian

* readme: add link to Italian translation

* readme: sort language list alphabetically

* readme: use relative links for translations

* xdg-shell: use wlr_xdg_toplevel in sway_view

Improved type safety.

Closes: https://github.com/swaywm/sway/issues/6813

* xdg-shell: use wlr_xdg_popup in sway_xdg_popup

Improved type safety.

* Fix snprintf compiler warning

* Remove all sprintf calls

Replace them with snprintf, which ensures buffer overflows won't
happen.

* sway/commands: add missing wlr_keyboard interface include in xkb_switch_layout

* sway/input: use wlr_input_device from input device base

* Remove some erroneous apostrophes in comments

* Don't enter seatop_move_floating when fullscreen

Currently, a floating window that's been fullscreened can send us
xdg_toplevel::move, and we'll enter seatop_move_floating, which lets us
drag the surface around while it's fullscreen. We don't want
this--fullscreen surfaces should always be aligned to the screen--so add
the same check that seatop_default already does when entering this mode.

Tested with Weston's weston-fullscreen demo, which sends a move request
if you click anywhere on its surface.

* swaynag: die on all allocation failures

* sway/input: don't pass possibly invalid modifiers pointer

active_keyboard may be NULL, in which case an invalid pointer could be
passed to wlr_input_method_keyboard_grab_v2_send_modifiers. This
procedure call is unnecessary since wlroots commit 372a52ec "input
method: send modifiers in set_keyboard", so the call can simply be
removed.

Fixes #6836.

* sway/input: destroy sway_switch properly

Fix: #6861
Added seat_device_destroy function to seat_device_destroy function.

* commands/focus: fix segfault when no container is already focused.

Fixes #6690.

* Remove WLR_SWITCH_STATE_TOGGLE usage

Ref [1].

[1]: 4792446ee8

* Replace pcre with pcre2

Closes: https://github.com/swaywm/sway/issues/6838

* swaybar: remove swaybar_output.input_region

No need to keep the region around, we can immediately destroy it
after the wl_surface.set_input_region request.

* swaybar: set opaque region

When the background color is fully opaque, set the surface's opaque
region to the whole surface.

* Updating criteria checking with PCRE2

* swaynag: allocate button_details with details

They are used together, so it doesn't make sense to allocate them
separately.

* swaynag: statically allocate button_close, and move declaration

Every swaynag has a close button, so it doesn't make sense to
allocate it dynamically. The declaration is moved later to when
it is actually needed.

* swaynag: remove unnecessary zero of swaynag struct

Global variables are initialized to 0.

* swaynag: remove redundant status variables in main

Instead, we just use `status` for all failures.

* remove unnecessary strlen call

* sway/input/cursor: take device mm size from wlr_tablet

* sway/input/seat: take output name from specialized input device

* sway/input: follow up wlroots input device events renaming

* sway/input: fix bad position of wlr_drag

* sway/input: wlr_seat_keyboard() now takes wlr_keyboard

* bash-completion: localize variables

* sway/main: move constants off the stack

This makes stack traces from gdb slightly easier to read.

* Fix farsi label

* Avoid format-truncation warning

The existing code gives this error when compiled with GCC 12:

../sway/server.c: In function ‘server_init’:
../sway/server.c:217:75: error: ‘%d’ directive output may be truncated writing between 1 and 11 bytes into a region of size 8 [-Werror=format-truncation=]
  217 |                 snprintf(name_candidate, sizeof(name_candidate), "wayland-%d", i);
      |                                                                           ^~
../sway/server.c:217:66: note: directive argument in the range [-2147483647, 32]
  217 |                 snprintf(name_candidate, sizeof(name_candidate), "wayland-%d", i);
      |                                                                  ^~~~~~~~~~~~
../sway/server.c:217:17: note: ‘snprintf’ output between 10 and 20 bytes into a destination of size 16
  217 |                 snprintf(name_candidate, sizeof(name_candidate), "wayland-%d", i);
      |                 ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Because i is never negative, this is a false positive, but it is easy to
change i to unsigned to silence the error.

* Shuffle variables to satisfy -Werror=restrict

This also fixes an invalid strlen invocation on uninitialized memory.

* layer_shell: keep output non-NULL wherever possible

Our layer shell implementation assigns every layer surface to an output
on creation. It tracks this output using the output field on the
underlying wlr_layer_surface_v1 structure. As such, much of the existing
code assumes that output is always non-NULL and omits NULL checks
accordingly.

However, there are currently two cases where we destroy a
sway_layer_surface and output is NULL. The first is when we can't find
an output to assign the surface to and destroy it immediately after
creation. The second is when we destroy a surface in response to its
output getting destroyed, as we set output to NULL in
handle_output_destroy() before we call wlr_layer_surface_v1_destroy(),
which is what calls the appropriate unmap and destroy callbacks.

The former case doesn't cause any problems, since we haven't even
allocated a sway_layer_surface at that point or registered any
callbacks. The latter case, however, currently triggers a crash (#6120)
if a popup is visible, since our popup_handle_unmap() implementation
can't handle a NULL output.

To fix this issue, keep output set until right before we free the
sway_layer_surface. All we need to do is remove some of the cleanup
logic from handle_output_destroy(), since as of commit c9060bcc12
("layer-shell: replace close() with destroy()") that same logic is
guaranteed to be happen later when wlroots calls handle_destroy() as
part of wlr_layer_surface_v1_destroy().

This lets us remove some NULL checks from other unmap/destroy callbacks,
which is nice. We also don't need to check that the wlr_output points to
a valid sway_output anymore, since we unset that pointer after disabling
the output as of commit a0bbe67076 ("Address emersions comments on
output re-enabling") Just to be safe, I've added assertions that the
wlr_output is non-NULL wherever we use it.

Fixes #6120.

* Chase wlroots X11 hints update

* Add Swedish README

* Support cursor capture in grimshot

Refactor argument parser

Bring back `sh` compatibility

Default to NOTIFY=no

* Update grimshot.1.scd

Fixed typo. The object is **files**, which is plural. **image** modifies files; it's not countable.

* xkb_switch_layout: fix relative layout switches

Fixes #6011

* Implement ext-session-lock-v1

* Avoid inspecting a NULL view in seat_set_focus

Fixes #6968

* swaynag: do error checking and rename read_from_stdin

read_from_stdin not only read from stdin, but trimming trailing
newlines, so rename it to reflect this.

* swaynag: improve robustness when loading config

* swaynag: combine consecutive declaration/assignments

* config: Remove unused mouse binding structure

Mouse bindings are handled alongside normal bindings. Remove the unused
separate data structure definition to avoid confusion.

Signed-off-by: Michael Weiser <michael.weiser@gmx.de>

* Replace strncpy with memcpy

strncpy is useless here, is dangerous because it doesn't guarantee
that the string is NUL-terminated and causes the following warning:

    ../sway/criteria.c: In function ‘criteria_parse’:
    ../sway/criteria.c:712:25: error: ‘strncpy’ destination unchanged after copying no bytes [-Werror=stringop-truncation]
      712 |                         strncpy(value, valuestart, head - valuestart);
          |                         ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Add descriptions for `stacking` and `tabbed` layouts

Resolves #5918

* man: Fix trailing spaces

* server: request xdg-shell v2

Wlroots does not yet support the newer xdg-shell versions and now
requires the compositor to set the supported xdg-shell version during
creation. Set this to v2 for sway as well.

Fixes https://github.com/swaywm/sway/issues/7001

* realtime: request SCHED_RR using CAP_SYS_NICE

Try to gain SCHED_RR (round-robin) realtime scheduling privileges before
starting the server. This requires CAP_SYS_NICE on Linux systems.
We additionally register a pthread_atfork callback which resets the
scheduling class back to SCHED_OTHER (the Linux system default).

Due to CAP_SYS_NICE, setting RLIMIT_RTPRIO has no effect on the process
as documented within man 7 sched (from Linux):

  Privileged (CAP_SYS_NICE) threads ignore the RLIMIT_RTPRIO limit;
  as with older kernels, they can make arbitrary changes to
  scheduling policy and priority. See getrlimit(2) for further
  information on RLIMIT_RTPRIO

Note that this requires the sway distribution packagers to set the
CAP_SYS_NICE capability on the sway binary.

Supersedes #6992

* ext-session-lock: disable direct scan-out when locked

* Polish the language in README.zh-CN.md & sync with English one

Co-Authored-By: Urey. Xue <urey.s.knowledge@gmail.com>

* De-duplicate IPC output descriptions

* Handle NULL output make/model/serial

* chore: chase wlroots xdg-shell update

* xdg-shell: schedule a configure on maximize request

This commit reverts 03879290dbee26127f6867ef60bc2a7f9a6c8c5f and
fc84bcb7fb0ffa29b1f9bed287762241a3473803.

* Add a Hindi (हिन्दी) translation to the README

Hindi is one of the most prominent languages of the Indian Subcontinent.
This commit adds the translation of the README into the Hindi language.
Some of the words are still written in English because there wasn't an
appropriate technical term of the word in the language.

Co-authored-by: Surendrajat <surendrajat@protonmail.com>

* sway: add bindgesture command

Co-authored-by: Michael Weiser <michael.weiser@gmx.de>

* build: link with -pthread

Fixes the following FreeBSD error:

    ld: error: undefined symbol: pthread_getschedparam
    >>> referenced by realtime.c:25 (../sway/realtime.c:25)
    >>>               sway/sway.p/realtime.c.o:(set_rr_scheduling)

Fixes: a3a82efbf6b5 ("realtime: request SCHED_RR using CAP_SYS_NICE")

* ipc: remove chatty debug log messages

These aren't particularly useful, and clobber the debug logs.

* Refuse to start when SUID is detected

This ensures that those surprised by the deprecation of SUID operation
receive an error rather than accidentally having sway run as root.

This detection will be removed in a future release.

* swaynag: move close_button up to fix SIGSEGV

When swaynag_parse_options encounters '--dismiss-button' (or its
shorthand '-s'), it sets the text of the first button in the
swaynag.buttons list, which is expected to exist and to be the dismiss
button, to the one passed by the user.

Commit 4780afb68b4ee2cdf0e4925f40cf885819f8a74a ("swaynag: statically
allocate button_close, and move declaration") moved the list
initialization to after swaynag_parse_options is called which made that
code fail.

For example, the command 'swaynag --dismiss-button Dismiss' crashes and
'swaynag --message Message --button Yes "" --dismiss-button Dismiss'
shows the wrong buttons.

Move it back to before swaynag_parse_options is called.

* config/output: use wlr_output_commit_state

This makes the code more robust because we don't potentially leave
bad state in wlr_output.pending behind anymore. This also fixes a
bug.

Closes: https://github.com/swaywm/sway/issues/7043
References: https://gitlab.freedesktop.org/wlroots/wlroots/-/merge_requests/3610

* Allocate enough space for `cmd_results->error`

* Remove access to wlr_input_device union

References: https://gitlab.freedesktop.org/wlroots/wlroots/-/merge_requests/3626
Closes: https://github.com/swaywm/sway/issues/7077

* Rename dpms output command to power

The "dpms" command refers to VESA Display Power Management
Signaling, a deprecated standard. It's superseded by VESA DPM.

Instead of tying out command name to a particular standard, use the
neutral term "power".

* Strip quotes in bindsym --input-device=...

If the input device is quoted, which is common when using variables in the
config file, those quotes must be ignored here, or the input device will be
ignored.

Fixes #7029.

* Avoid unecessary string copy

* Reject font values that are invalid for pango

Use pango to parse font configuration early, and reject the command as
invalid if the value is invalid for pango. Since we're already parsing
the font into a `PangoFontDescription`, keep that instance around and
avoid re-parsing the font each time we render text.

Fixes: https://github.com/swaywm/sway/issues/6805

* Reuse parsed PangoFontDescription

Avoids parsing the configured font each time text is rendered.

* ipc: add "power" to output reply

* config.in: switch to `output power`

* Remove internal references to DPMS

While at it, use an int for the config field, just like we do for
all other fields.

* fix: remove redundant empty statement in main.c

This semi-colon looks like a typo. Luckily, it has no effect on the code as it's treated as an empty statement leading the switch case.

Really straightforward nitpick change, was just something I was confused by when reading over the code.

* input: chase delta_discrete semantics change

* swaymsg: fix floating_nodes being ignored

Fix floating_nodes being ignored in pretty_print_tree.

* ipc: make get_deco_rect check config->hide_lone_tab

Without this, the `IPC_GET_TREE` ipc call would return false information
about the container's `deco_rect` and `rect` properties if
`hide_edge_borders --i3` was in effect.

* grimshot: fix tilde expansion within quotes

* Enable single-pixel-buffer-v1

References: https://gitlab.freedesktop.org/wlroots/wlroots/-/merge_requests/3428

* sway-output.5: improve display of parameter

Since "width" and "height" are separate parameters, show them as such.

* man: sway(5) move fixes

* ipc: drop WLR_OUTPUT_ADAPTIVE_SYNC_UNKNOWN case

This has been removed from wlroots.

* config/output: test adaptive sync

Required for [1].

[1]: https://gitlab.freedesktop.org/wlroots/wlroots/-/merge_requests/3637

* Fix crash in xdg_activation_v1.c

wlr_xdg_surface_from_wlr_surface() can return a NULL pointer, so check for NULL before dereferencing it.

* sway: Add non-desktop-output type

Currently, when encountering a non-desktop display, sway offers the
output for leasing and returns without storing it in a sway specific
output type like `struct sway_output`.  Additionally, running
`swaymsg -t get_outputs` doesn't show non-desktop outputs.

This commit stores the non-desktop outputs into a struct called
`sway_output_non_desktop`, and adds them to a list on `sway_root`

* sway: add non-desktop outputs to json when running `swaymsg -t get_outputs`

* swaymsg: show non-desktop property when pretty printing outputs

* man: Add XWayland information

* ipc: expose mode picture aspect ratio

* swaymsg: show mode picture aspect ratio

* build: simplify protocol paths

No need for arrays here.

* sway/commands/output: Add command for unplugging non-physical outputs

* Improve Japanese translation

* allow pointer_constraints on layer_shell surfaces

* check for NULL

* use seat directly

* Use keyboard_state.focused_surface directly

* input: focus floating container when clicked on border

Fixes #7209.

* input: focus container when scrolling on titlebar

Fixes #6503.

* Fix leaks in criteria_destroy()

* Avoid double free in criteria_destroy()

* Add support for ext-idle-notify-v1

References: https://gitlab.freedesktop.org/wlroots/wlroots/-/merge_requests/3753

* input: tweak focus behavior to allow focusing parent containers

Sway focuses the inactive child when focusing split containers. However,
there is currently no way to focus the parent container itself by mouse.
A user must use the keyboard to do so.

This commit maintains the current behavior, but makes it such that a
second click on the split container titlebar (i.e., after its children
are visible) focuses the split container itself.

* Fix keymap being NULL and segfaulting on dev add

Moved `libinput_config` to the callers of
`sway_input_configure_libinput_device` so that we send the event after
the added event.

* Rework session lock keyboard focus handling

When removing outputs, it is possible to end up in a situation where
none of the session lock client's surfaces have keyboard focus,
resulting in it not receiving keyboard events.  Track the focused
surface and update it as needed on surface destroy.

* Fix focus tracking when session lock is active

Remove the incorrect attempt to block focus changes when an input grab
is present and replace it with the same logic used for layer_shell-based
screen lockers: restore the focus after changing it.

This fixes a use-after-free of seat->workspace if outputs are destroyed
while a screen lock is enabled.

* container_floating_set_default_size: Store workspace size box on the stack

* Support libinput's 1.21 new dwtp option

Support the new dwtp (disable while trackpointing) option introduced in
libinput 1.21, allowing users to control whether the trackpoint (like
those in Thinkpads, but not only) should be disabled while using the
keyboard/touchpad.

See: https://gitlab.freedesktop.org/libinput/libinput/-/issues/731

* tree: support formatting null titles

Any windows that have never had a title set visually behave closer to
that of an empty title, but are unformattable, as the code bails out
early on a NULL title.

* criteria: allow matching on empty (NULL) titles

* criteria: allow matching for NULL string criteria

* ci: install hwdata

* Use wl_signal_emit_mutable()

This function fixes segfaults when emitting a signal potentially
removes arbitrary listeners.

* Use wlr_damage_ring

wlr_output_damage is to be replaced with wlr_damage_ring, so use that.

* lock: fix crash on output destroy

Closes: https://github.com/swaywm/sway/issues/7120

* container_get_siblings: handle NULL workspace

* ci: checkout wlroots 0.16.0

* workspace_create: Don't allow NULL name

(cherry picked from commit 34933bb84350fe805d82276ea02d5732546e9993)

* output: set damage ring bounds to pixel values

Fixes: https://github.com/swaywm/sway/issues/7254
(cherry picked from commit 85005b52fe5b832e4ea914fa28048b0c5c803769)

* Use shm_open instead of mkstemp

shm_open is more reliable because it does not require
a writeable filesystem folder, unlike mkstemp.

(cherry picked from commit e2bc8866f46701e9c825ad7fa5baac02b2e4898f)

* build: drop wayland-scanner fallback

(cherry picked from commit 366f6ef3d31688631dc453028e108f98a1d7ab57)

* build: unify server & client protocol generation

No need to make a difference here, let's just generate header
files for both.

(cherry picked from commit 5be5a038da8a3789a19945719f2a27233291445d)

* build: drop "server" from target name for protocol code

(cherry picked from commit e5475d9310941ce88ed016ce1515b36e3a440252)

* build: drop intermediate libraries for protocols

(cherry picked from commit af8a5a8918ef42336194fb1077b008a736de7af9)

* root: move the workspace matching code to its own file

This removes the pid_workspace bits from tree/root before it gets
too interesting.

No functional change.

(cherry picked from commit eb5021ef990fb29ff86544aea58d687ad62c757a)

* node: prettify node type names

(cherry picked from commit 1c4b94ae3ca94b972410c80a61404a347af1ee68)

* launcher: track workspaces by node

This removes the need to rename the pid_workspaces when a workspace
is renamed.

It also opens the possibility of tracking other node types. Tracking
containers would allow application to be placed correctly in the
container tree even if the user has moved their focus elsewhere since
it was launched.

(cherry picked from commit 3b49f2782e8faf68766269b9c7390b16e25ae824)

* launcher: use xdga tokens

This reuses wlroots token tracking for workspace matching. It doesn't
export any xdga tokens for clients yet.

(cherry picked from commit bd66f4943da1c96edc3ba49573e27b42b688c543)

* launcher: rename pid_workspace to launcher_ctx

Soon we will match views with more than just a pid.

(cherry picked from commit d75c9f9722389d441fd24bd490c5cf12c4bef39a)

* view: associate launch contexts with views

Views now maintain a reference to a launch context which, as a last
resort, is populated at map time with a context associated with its pid.
This opens the possibility of populating it before map via another
source, e.g. xdga-tokens or configuration.

(cherry picked from commit 864b3a9a18f236f92f1898bb44ab977ceaebfd68)

* launcher: initialize launcher_ctxs once on startup

(cherry picked from commit 66568508c06267445489d655c91c94a34d6d9ffe)

* launcher: fudge the interface a bit

We want to create a context before knowing the pid it will match with.

(cherry picked from commit bdeb9f95651f6c99cc2f4cfb59020ddee202cf36)

* launcher: export xdga tokens and use them for workspace matching

(cherry picked from commit 30ad4dc4a5a41ce7c7aa85096a6e18f374172983)

* launcher: export X startup ids and use them for workspace matching

(cherry picked from commit 28fda4c0d38907fab94dc7d82c9dcf0754748b4e)

* swaybar: Prioritize hotspot events to bar bindings

This is consistent with i3bar's behaviour, and for example, allows binding a
command to button1, while still being able to click on tray icons or other
zones on the bar's status line which may have their own bindings.

E.g., in Sway, without this commit, this config. makes tray icons unclickable:

    bar {
        # ...
        bindsym button1 exec swaynag -m You_clicked_the_tray._Want_some_help?
    }

But the same configuration in i3 (with i3-nagbar) keeps tray items clickable.

Signed-off-by: Joan Bruguera <joanbrugueram@gmail.com>
(cherry picked from commit 53f9dbd424dc173a85c9f4cd30802259d38b1ef4)

* swaybar: Make hotspots block bar release bindings

The previous commit prioritized hotspots before bar bindings for press events,
which matches i3's behaviour. However, since hotspots don't need to do any
processing on release events, those were not handled, and simply fell through
to `bindsym --release` bar bindings (if any).

This is counter-intuitive, and doesn't match i3's behaviour. Instead in case
a hotspot handles the press event, it should also handle the release event,
doing nothing, but blocking the event from triggering a --release bar binding.

E.g., in Sway, without this commit, this config. shows a text on tray clicks:

    bar {
        # ...
        bindsym --release button1 exec swaynag -m I_got_the_release_event.
    }

But the same configuration in i3 (with i3-nagbar) doesn't show the text.

Signed-off-by: Joan Bruguera <joanbrugueram@gmail.com>
(cherry picked from commit 94b69acf0d7b26ee5af2172300cb18473508da76)

* build: drop unused wayland-egl dependency

(cherry picked from commit 37e4a3d6370dc6ba2b0877d588845c06781e880e)

* build: bump version to 1.8-rc1

* Fix build on Debian Stable

(cherry picked from commit dca0bb5749bc16f91ab964fc1b06ebb9a453368f)

* build: fix have_xwayland when xcb-icccm is not found

xcb-icccm is required to build Xwayland support.

Backported from commit d41f11e6bd8cef80f02dda4c66d4a31611aed753.

* build: bump version to 1.8-rc2

* seat: Avoid sending redundant keymaps on reload

When we reload the config, we reset every input device and re-apply
configuration from the config file. This means that the keyboard keymap
is updated at least once during config reload, more if the config file
contains keyboard configuration.

When they keyboard keymap changes and is updated through wlr_seat, the
keymap ends up sent to every keyboard bound in every client, seemingly
multiple times. On an x230 of mine with a keyboard layout set in the
config file, I see 42 keymap events sent to foot on config reload.

Reduce events from keyboard configurations by skipping all but the
currently active keyboard for the seat, and by clearing the active
keyboard during input manager device reset. After this change, I only
see a single just-in-time keymap event.

Fixes: https://github.com/swaywm/sway/issues/6654

* criteria: be lenient on window_role and instance too

* build: bump version to 1.8-rc3

* commands/move: Warp cursor after moving workspace to another output

This makes sway's behavior consistent with i3 when `mouse_warping` is
set to any value besides `none`.

Fixes #7027.

(cherry picked from commit e3c63bf58d0744dfb436f0f38442ce3735e40f47)

* seat: Set keyboard if seat keyboard is NULL

sway sends wl_keyboard.enter on seat focus change and when a keyboard
active on a seat is configured. If all keyboards are removed and a
keyboard is added back without changing the focused client, no new
notify event would be sent despite having keyboard focus. This could
lead to key events without notify, which is a protocol violation.

As a quick fix, when configuring a keyboard on a seat where no keyboard
is currently active, activate the keyboard so that a focused surface
will receive a notify event.

Regressed by: e1b268af98edeb09e570e8855ef64f0719cbafe2
Closes: https://github.com/swaywm/sway/issues/7330

(cherry picked from commit 1ade0ce753dc5f588584f444ce80d27c3b1e4300)

* build: bump version to 1.8-rc4

* swaynag: fix NULL font description

The font description was only set if provided on the CLI. It was
left NULL for the defaults and when reading from the config file.

Closes: https://github.com/swaywm/sway/issues/7186
(cherry picked from commit fd0af78e43f4dd67a404f475c676b25ae38a4b82)

* build: bump version to 1.8

* Removed other README languages

* Fixed build issues

* Removed alpha from render_data struct

* Updated PKGBUILDs and COPR spec

* Update sway/desktop/render.c

Co-authored-by: Alexis Tacnet <alexistacnet@gmail.com>

* Fixed deco_data not being initialized properly

* Replaced wlr_egl_(make|unset)_current with eglMakeCurrent

* Added matrix_projection into fx_renderer

Signed-off-by: Michael Weiser <michael.weiser@gmx.de>
Co-authored-by: Sefa Eyeoglu <contact@scrumplex.net>
Co-authored-by: Simon Ser <contact@emersion.fr>
Co-authored-by: Seth Barberee <seth.barberee@gmail.com>
Co-authored-by: Thomas Hebb <tommyhebb@gmail.com>
Co-authored-by: Nathan Schulte <nmschulte@gmail.com>
Co-authored-by: xdavidwu <xdavidwuph@gmail.com>
Co-authored-by: David Rosca <nowrep@gmail.com>
Co-authored-by: David96 <david@hameipe.de>
Co-authored-by: Kenny Levinsen <kl@kl.wtf>
Co-authored-by: Aleksei Bavshin <alebastr89@gmail.com>
Co-authored-by: Kirill Chibisov <contact@kchibisov.com>
Co-authored-by: Tudor Brindus <me@tbrindus.ca>
Co-authored-by: Patrick Hilhorst <git@hilhorst.be>
Co-authored-by: Rouven Czerwinski <rouven@czerwinskis.de>
Co-authored-by: Tobias Bengfort <tobias.bengfort@posteo.de>
Co-authored-by: Ronan Pigott <rpigott@berkeley.edu>
Co-authored-by: Kirill Primak <vyivel@eclair.cafe>
Co-authored-by: Tuomas Yrjölä <mail@yrhki.fi>
Co-authored-by: Kirill Primak <vyivel@posteo.net>
Co-authored-by: Alexander Browne <elcste@users.noreply.github.com>
Co-authored-by: Marco Rubin <20150305+Rubo3@users.noreply.github.com>
Co-authored-by: Muhamed Hobi <woohoomoo2u@gmail.com>
Co-authored-by: Simon Zeni <simon@bl4ckb0ne.ca>
Co-authored-by: Nihal Jere <nihal@nihaljere.xyz>
Co-authored-by: Alexander Gramiak <agrambot@gmail.com>
Co-authored-by: Moon Sungjoon <sumoon@seoulsaram.org>
Co-authored-by: Nicolas Avrutin <nicolas@avrutin.net>
Co-authored-by: ndren <andreien@ctemplar.com>
Co-authored-by: Bill Li <billli11hkb@gmail.com>
Co-authored-by: Leonardo Hernández Hernández <leohdz172@protonmail.com>
Co-authored-by: Oğuz Ersen <oguz@ersen.moe>
Co-authored-by: Manuel Stoeckl <code@mstoeckl.com>
Co-authored-by: Yasin Silavi <59373143+sttatusx@users.noreply.github.com>
Co-authored-by: Daniel De Graaf <code@danieldg.net>
Co-authored-by: kraftwerk28 <kefirchik3@gmail.com>
Co-authored-by: Eskil <67291226+eschillus@users.noreply.github.com>
Co-authored-by: Alice Carroll <git@alice-carroll.pet>
Co-authored-by: Alan <51193876+Pound-Hash@users.noreply.github.com>
Co-authored-by: Victor Makarov <vitja.makarov@gmail.com>
Co-authored-by: Michael Weiser <michael.weiser@gmx.de>
Co-authored-by: -k <slowdive@me.com>
Co-authored-by: Hongyi <61831273+FrozenArcher@users.noreply.github.com>
Co-authored-by: Urey. Xue <urey.s.knowledge@gmail.com>
Co-authored-by: LordRishav <75823494+LordRishav@users.noreply.github.com>
Co-authored-by: Surendrajat <surendrajat@protonmail.com>
Co-authored-by: Florian Franzen <Florian.Franzen@gmail.com>
Co-authored-by: Greg Depoire--Ferrer <greg@gregdf.com>
Co-authored-by: Thomas Jost <schnouki@schnouki.net>
Co-authored-by: Hugo Osvaldo Barrera <hugo@barrera.io>
Co-authored-by: zkldi <ktchidev@gmail.com>
Co-authored-by: llyyr <llyyr.public@gmail.com>
Co-authored-by: Baltazár Radics <baltazar.radics@gmail.com>
Co-authored-by: Martin Michlmayr <tbm@cyrius.com>
Co-authored-by: Filip Szczepański <jazz2rulez@gmail.com>
Co-authored-by: Alex Maese <memaese@hotmail.com>
Co-authored-by: マリウス <marius@xn--gckvb8fzb.com>
Co-authored-by: Andri Yngvason <andri@yngvason.is>
Co-authored-by: ohno418 <yutaro.ono.418@gmail.com>
Co-authored-by: Ferdinand Schober <ferdinand.schober@fau.de>
Co-authored-by: cparm <armelcadetpetit@gmail.com>
Co-authored-by: Yaroslav de la Peña Smirnov <yps@yaroslavps.com>
Co-authored-by: Alexander Orzechowski <orzechowski.alexander@gmail.com>
Co-authored-by: pudiva chip líquida <pudiva@skylittlesystem.org>
Co-authored-by: Puck Meerburg <puck@puckipedia.com>
Co-authored-by: Callum Andrew <calcium@mailbox.org>
Co-authored-by: Ronan Pigott <ronan@rjp.ie>
Co-authored-by: Joan Bruguera <joanbrugueram@gmail.com>
Co-authored-by: nerdopolis <bluescreen_avenger@verizon.net>
Co-authored-by: Ankit Pandey <anpandey@protonmail.com>
Co-authored-by: Alexis Tacnet <alexistacnet@gmail.com>
2023-01-04 17:32:43 -05:00

1859 lines
41 KiB
Markdown
Raw Blame History

sway-ipc(7)
# NAME
sway-ipc - IPC protocol for sway
# DESCRIPTION
This details the interprocess communication (IPC) protocol for *sway*(1). This
IPC protocol can be used to control or obtain information from a sway process.
The IPC protocol uses a UNIX socket as the method of communication. The path
to the socket is stored in the environment variable _SWAYSOCK_ and, for
backwards compatibility with i3, _I3SOCK_. You can also retrieve the socket
path by calling _sway --get-socketpath_.
# MESSAGE AND REPLY FORMAT
The format for messages and replies is:
<magic-string> <payload-length> <payload-type> <payload>
Where++
<magic-string> is _i3-ipc_, for compatibility with i3++
<payload-length> is a 32-bit integer in native byte order++
<payload-type> is a 32-bit integer in native byte order
For example, sending the _exit_ command would look like the following hexdump:
```
00000000 | 69 33 2d 69 70 63 04 00 00 00 00 00 00 00 65 78 |i3-ipc........ex|
00000010 | 69 74 |it |
```
The payload for replies will be a valid serialized JSON data structure.
# MESSAGES AND REPLIES
The following message types and their corresponding reply types are currently
supported. *For all replies, any properties not listed are subject to removal.*
[- *TYPE NUMBER*
:- *MESSAGE NAME*
:- *PURPOSE*
|- 0
: RUN_COMMAND
:[ Runs the payload as sway commands
|- 1
: GET_WORKSPACES
: Get the list of current workspaces
|- 2
: SUBSCRIBE
: Subscribe the IPC connection to the events listed in the payload
|- 3
: GET_OUTPUTS
: Get the list of current outputs
|- 4
: GET_TREE
: Get the node layout tree
|- 5
: GET_MARKS
: Get the names of all the marks currently set
|- 6
: GET_BAR_CONFIG
: Get the specified bar config or a list of bar config names
|- 7
: GET_VERSION
: Get the version of sway that owns the IPC socket
|- 8
: GET_BINDING_MODES
: Get the list of binding mode names
|- 9
: GET_CONFIG
: Returns the config that was last loaded
|- 10
: SEND_TICK
: Sends a tick event with the specified payload
|- 11
: SYNC
: Replies failure object for i3 compatibility
|- 12
: GET_BINDING_STATE
: Request the current binding state, e.g. the currently active binding mode name.
|- 100
: GET_INPUTS
: Get the list of input devices
|- 101
: GET_SEATS
: Get the list of seats
## 0. RUN_COMMAND
*MESSAGE*++
Parses and runs the payload as sway commands
*REPLY*++
An array of objects corresponding to each command that was parsed. Each object
has the property _success_, which is a boolean indicating whether the command
was successful. The object may also contain the properties _error_ and _parse\_error_.
The _error_ property is a human readable error message while _parse\_error_ is a
boolean indicating whether the reason the command failed was because the command
was unknown or not able to be parsed.
*Example Reply:*
```
[
{
"success": true
},
{
"success": false,
"parse_error": true,
"error": "Invalid/unknown command"
}
]
```
## 1. GET_WORKSPACES
*MESSAGE*++
Retrieves the list of workspaces.
*REPLY*++
The reply is an array of objects corresponding to each workspace. Each object
has the following properties:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- num
: integer
:[ The workspace number or -1 for workspaces that do not start with a number
|- name
: string
: The name of the workspace
|- visible
: boolean
: Whether the workspace is currently visible on any output
|- focused
: boolean
: Whether the workspace is currently focused by the default seat (_seat0_)
|- urgent
: boolean
: Whether a view on the workspace has the urgent flag set
|- rect
: object
: The bounds of the workspace. It consists of _x_, _y_, _width_, and _height_
|- output
: string
: The name of the output that the workspace is on
*Example Reply:*
```
[
{
"num": 1,
"name": "1",
"visible": true,
"focused": true,
"rect": {
"x": 0,
"y": 23,
"width": 1920,
"height": 1057
},
"output": "eDP-1"
},
]
```
## 2. SUBSCRIBE
*MESSAGE*++
Subscribe this IPC connection to the event types specified in the message
payload. The payload should be a valid JSON array of events. See the _EVENTS_
section for the list of supported events.
*REPLY*++
A single object that contains the property _success_, which is a boolean value
indicating whether the subscription was successful or not.
*Example Reply:*
```
{
"success": true
}
```
## 3. GET_OUTPUTS
*MESSAGE*++
Retrieve the list of outputs
*REPLY*++
An array of objects corresponding to each output. Each object has the
following properties:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- name
: string
:[ The name of the output. On DRM, this is the connector
|- make
: string
: The make of the output
|- model
: string
: The model of the output
|- serial
: string
: The output's serial number as a hexadecimal string
|- active
: boolean
: Whether this output is active/enabled
|- dpms
: boolean
: (Deprecated, use _power_ instead) Whether this output is on/off (via DPMS)
|- power
: boolean
: Whether this output is on/off
|- primary
: boolean
: For i3 compatibility, this will be false. It does not make sense in Wayland
|- scale
: float
: The scale currently in use on the output or _-1_ for disabled outputs
|- subpixel_hinting
: string
: The subpixel hinting current in use on the output. This can be _rgb_, _bgr_, _vrgb_, _vbgr_, or _none_
|- transform
: string
: The transform currently in use for the output. This can be _normal_, _90_,
_180_, _270_, _flipped-90_, _flipped-180_, or _flipped-270_
|- current_workspace
: string
: The workspace currently visible on the output or _null_ for disabled outputs
|- modes
: array
: An array of supported mode objects. Each object contains _width_, _height_,
and _refresh_
|- current_mode
: object
: An object representing the current mode containing _width_, _height_, and
_refresh_
|- rect
: object
: The bounds for the output consisting of _x_, _y_, _width_, and _height_
*Example Reply:*
```
[
{
"name": "HDMI-A-2",
"make": "Unknown",
"model": "NS-19E310A13",
"serial": "0x00000001",
"active": true,
"primary": false,
"scale": 1.0,
"subpixel_hinting": "rgb",
"transform": "normal",
"current_workspace": "1",
"modes": [
{
"width": 640,
"height": 480,
"refresh": 59940
},
{
"width": 800,
"height": 600,
"refresh": 60317
},
{
"width": 1024,
"height": 768,
"refresh": 60004
},
{
"width": 1920,
"height": 1080,
"refresh": 60000
}
],
"current_mode": {
"width": 1920,
"height": 1080,
"refresh": 60000
}
}
]
```
## 4. GET_TREE
*MESSAGE*++
Retrieve a JSON representation of the tree
*REPLY*++
An array of objects that represent the current tree. Each object represents one
node and will have the following properties:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- id
: integer
:[ The internal unique ID for this node
|- name
: string
: The name of the node such as the output name or window title. For the
scratchpad, this will be _\_\_i3\_scratch_ for compatibility with i3.
|- type
: string
: The node type. It can be _root_, _output_, _workspace_, _con_, or
_floating\_con_
|- border
: string
: The border style for the node. It can be _normal_, _none_, _pixel_, or _csd_
|- current_border_width
: integer
: Number of pixels used for the border width
|- layout
: string
: The node's layout. It can either be _splith_, _splitv_, _stacked_,
_tabbed_, or _output_
|- orientation
: string
: The node's orientation. It can be _vertical_, _horizontal_, or _none_
|- percent
: float
: The percentage of the node's parent that it takes up or _null_ for the root
and other special nodes such as the scratchpad
|- rect
: object
: The absolute geometry of the node. The window decorations are excluded from
this, but borders are included.
|- window_rect
: object
: The geometry of the contents inside the node. The window decorations are
excluded from this calculation, but borders are included.
|- deco_rect
: object
: The geometry of the decorations for the node relative to the parent node
|- geometry
: object
: The natural geometry of the contents if it were to size itself
|- urgent
: boolean
: Whether the node or any of its descendants has the urgent hint set. Note:
This may not exist when compiled without _xwayland_ support
|- sticky
: boolean
: Whether the node is sticky (shows on all workspaces)
|- marks
: array
: List of marks assigned to the node
|- focused
: boolean
: Whether the node is currently focused by the default seat (_seat0_)
|- focus
: array
: Array of child node IDs in the current focus order
|- nodes
: array
: The tiling children nodes for the node
|- floating_nodes
: array
: The floating children nodes for the node
|- representation
: string
: (Only workspaces) A string representation of the layout of the workspace
that can be used as an aid in submitting reproduction steps for bug reports
|- fullscreen_mode
: integer
: (Only containers and views) The fullscreen mode of the node. 0 means none, 1 means
full workspace, and 2 means global fullscreen
|- app_id
: string
: (Only views) For an xdg-shell view, the name of the application, if set.
Otherwise, _null_
|- pid
: integer
: (Only views) The PID of the application that owns the view
|- visible
: boolean
: (Only views) Whether the node is visible
|- shell
: string
: (Only views) The shell of the view, such as _xdg\_shell_ or _xwayland_
|- inhibit_idle
: boolean
: (Only views) Whether the view is inhibiting the idle state
|- idle_inhibitors
: object
: (Only views) An object containing the state of the _application_ and _user_ idle inhibitors.
_application_ can be _enabled_ or _none_.
_user_ can be _focus_, _fullscreen_, _open_, _visible_ or _none_.
|- window
: integer
: (Only xwayland views) The X11 window ID for the xwayland view
|- window_properties
: object
: (Only xwayland views) An object containing the _title_, _class_, _instance_,
_window\_role_, _window\_type_, and _transient\_for_ for the view
*Example Reply:*
```
{
"id": 1,
"name": "root",
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"focused": false,
"focus": [
3
],
"border": "none",
"current_border_width": 0,
"layout": "splith",
"orientation": "horizontal",
"percent": null,
"window_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"deco_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"geometry": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"window": null,
"urgent": false,
"floating_nodes": [
],
"sticky": false,
"type": "root",
"nodes": [
{
"id": 2147483647,
"name": "__i3",
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"focused": false,
"focus": [
2147483646
],
"border": "none",
"current_border_width": 0,
"layout": "output",
"orientation": "horizontal",
"percent": null,
"window_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"deco_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"geometry": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"window": null,
"urgent": false,
"floating_nodes": [
],
"sticky": false,
"type": "output",
"nodes": [
{
"id": 2147483646,
"name": "__i3_scratch",
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"focused": false,
"focus": [
],
"border": "none",
"current_border_width": 0,
"layout": "splith",
"orientation": "horizontal",
"percent": null,
"window_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"deco_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"geometry": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"window": null,
"urgent": false,
"floating_nodes": [
],
"sticky": false,
"type": "workspace"
}
]
},
{
"id": 3,
"name": "eDP-1",
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"focused": false,
"focus": [
4
],
"border": "none",
"current_border_width": 0,
"layout": "output",
"orientation": "none",
"percent": 1.0,
"window_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"deco_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"geometry": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"window": null,
"urgent": false,
"floating_nodes": [
],
"sticky": false,
"type": "output",
"active": true,
"primary": false,
"make": "Unknown",
"model": "0x38ED",
"serial": "0x00000000",
"scale": 1.0,
"transform": "normal",
"current_workspace": "1",
"modes": [
{
"width": 1920,
"height": 1080,
"refresh": 60052
}
],
"current_mode": {
"width": 1920,
"height": 1080,
"refresh": 60052
},
"nodes": [
{
"id": 4,
"name": "1",
"rect": {
"x": 0,
"y": 23,
"width": 1920,
"height": 1057
},
"focused": false,
"focus": [
6,
5
],
"border": "none",
"current_border_width": 0,
"layout": "splith",
"orientation": "horizontal",
"percent": null,
"window_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"deco_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"geometry": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"window": null,
"urgent": false,
"floating_nodes": [
],
"sticky": false,
"num": 1,
"output": "eDP-1",
"type": "workspace",
"representation": "H[URxvt termite]",
"nodes": [
{
"id": 5,
"name": "urxvt",
"rect": {
"x": 0,
"y": 23,
"width": 960,
"height": 1057
},
"focused": false,
"focus": [
],
"border": "normal",
"current_border_width": 2,
"layout": "none",
"orientation": "none",
"percent": 0.5,
"window_rect": {
"x": 2,
"y": 0,
"width": 956,
"height": 1030
},
"deco_rect": {
"x": 0,
"y": 0,
"width": 960,
"height": 25
},
"geometry": {
"x": 0,
"y": 0,
"width": 1124,
"height": 422
},
"window": 4194313,
"urgent": false,
"floating_nodes": [
],
"sticky": false,
"type": "con",
"fullscreen_mode": 0,
"pid": 23959,
"app_id": null,
"visible": true,
"shell": "xwayland",
"inhibit_idle": true,
"idle_inhibitors": {
"application": "none",
"user": "visible",
},
"window_properties": {
"class": "URxvt",
"instance": "urxvt",
"title": "urxvt",
"transient_for": null
},
"nodes": [
]
},
{
"id": 6,
"name": "",
"rect": {
"x": 960,
"y": 23,
"width": 960,
"height": 1057
},
"focused": true,
"focus": [
],
"border": "normal",
"current_border_width": 2,
"layout": "none",
"orientation": "none",
"percent": 0.5,
"window_rect": {
"x": 2,
"y": 0,
"width": 956,
"height": 1030
},
"deco_rect": {
"x": 0,
"y": 0,
"width": 960,
"height": 25
},
"geometry": {
"x": 0,
"y": 0,
"width": 817,
"height": 458
},
"window": null,
"urgent": false,
"floating_nodes": [
],
"sticky": false,
"type": "con",
"fullscreen_mode": 0,
"pid": 25370,
"app_id": "termite",
"visible": true,
"shell": "xdg_shell",
"inhibit_idle": false,
"idle_inhibitors": {
"application": "none",
"user": "fullscreen",
},
"nodes": [
]
}
]
}
]
}
]
}
```
## 5. GET_MARKS
*MESSAGE*++
Retrieve the currently set marks
*REPLY*++
An array of marks current set. Since each mark can only be set for one
container, this is a set so each value is unique and the order is undefined.
*Example Reply:*
```
[
"one",
"test"
]
```
## 6. GET_BAR_CONFIG (WITHOUT A PAYLOAD)
*MESSAGE*++
When sending without a payload, this retrieves the list of configured bar IDs
*REPLY*++
An array of bar IDs, which are strings
*Example Reply:*
```
[
"bar-0",
"bar-1"
]
```
## 6. GET_BAR_CONFIG (WITH A PAYLOAD)
*MESSAGE*++
When sent with a bar ID as the payload, this retrieves the config associated
with the specified by the bar ID in the payload. This is used by swaybar, but
could also be used for third party bars
*REPLY*++
An object that represents the configuration for the bar with the bar ID sent as
the payload. The following properties exists and more information about what
their value mean can be found in *sway-bar*(5):
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- id
: string
:[ The bar ID
|- mode
: string
: The mode for the bar. It can be _dock_, _hide_, or _invisible_
|- position
: string
: The bar's position. It can currently either be _bottom_ or _top_
|- status_command
: string
: The command which should be run to generate the status line
|- font
: string
: The font to use for the text on the bar
|- workspace_buttons
: boolean
: Whether to display the workspace buttons on the bar
|- workspace_min_width
: integer
: Minimum width in px for the workspace buttons on the bar
|- binding_mode_indicator
: boolean
: Whether to display the current binding mode on the bar
|- verbose
: boolean
: For i3 compatibility, this will be the boolean value _false_.
|- colors
: object
: An object containing the _#RRGGBBAA_ colors to use for the bar. See below
for more information
|- gaps
: object
: An object representing the gaps for the bar consisting of _top_, _right_,
_bottom_, and _left_.
|- bar_height
: integer
: The absolute height to use for the bar or _0_ to automatically size based
on the font
|- status_padding
: integer
: The vertical padding to use for the status line
|- status_edge_padding
: integer
: The horizontal padding to use for the status line when at the end of an
output
The colors object contains the following properties, which are all strings
containing the _#RRGGBBAA_ representation of the color:
[- *PROPERTY*
:- *DESCRIPTION*
|- background
:[ The color to use for the bar background on unfocused outputs
|- statusline
: The color to use for the status line text on unfocused outputs
|- separator
: The color to use for the separator text on unfocused outputs
|- focused_background
: The color to use for the background of the bar on the focused output
|- focused_statusline
: The color to use for the status line text on the focused output
|- focused_separator
: The color to use for the separator text on the focused output
|- focused_workspace_text
: The color to use for the text of the focused workspace button
|- focused_workspace_bg
: The color to use for the background of the focused workspace button
|- focused_workspace_border
: The color to use for the border of the focused workspace button
|- active_workspace_text
: The color to use for the text of the workspace buttons for the visible
workspaces on unfocused outputs
|- active_workspace_bg
: The color to use for the background of the workspace buttons for the visible
workspaces on unfocused outputs
|- active_workspace_border
: The color to use for the border of the workspace buttons for the visible
workspaces on unfocused outputs
|- inactive_workspace_text
: The color to use for the text of the workspace buttons for workspaces that
are not visible
|- inactive_workspace_bg
: The color to use for the background of the workspace buttons for workspaces
that are not visible
|- inactive_workspace_border
: The color to use for the border of the workspace buttons for workspaces
that are not visible
|- urgent_workspace_text
: The color to use for the text of the workspace buttons for workspaces that
contain an urgent view
|- urgent_workspace_bg
: The color to use for the background of the workspace buttons for workspaces
that contain an urgent view
|- urgent_workspace_border
: The color to use for the border of the workspace buttons for workspaces that
contain an urgent view
|- binding_mode_text
: The color to use for the text of the binding mode indicator
|- binding_mode_bg
: The color to use for the background of the binding mode indicator
|- binding_mode_border
: The color to use for the border of the binding mode indicator
*Example Reply:*
```
{
"id": "bar-0",
"mode": "dock",
"position": "top",
"status_command": "while date +'%Y-%m-%d %l:%M:%S %p'; do sleep 1; done",
"font": "monospace 10",
"gaps": {
"top": 0,
"right": 0,
"bottom": 0,
"left": 0
},
"bar_height": 0,
"status_padding": 1,
"status_edge_padding": 3,
"workspace_buttons": true,
"workspace_min_width": 0,
"binding_mode_indicator": true,
"verbose": false,
"pango_markup": false,
"colors": {
"background": "#323232ff",
"statusline": "#ffffffff",
"separator": "#666666ff",
"focused_background": "#323232ff",
"focused_statusline": "#ffffffff",
"focused_separator": "#666666ff",
"focused_workspace_border": "#4c7899ff",
"focused_workspace_bg": "#285577ff",
"focused_workspace_text": "#ffffffff",
"inactive_workspace_border": "#32323200",
"inactive_workspace_bg": "#32323200",
"inactive_workspace_text": "#5c5c5cff",
"active_workspace_border": "#333333ff",
"active_workspace_bg": "#5f676aff",
"active_workspace_text": "#ffffffff",
"urgent_workspace_border": "#2f343aff",
"urgent_workspace_bg": "#900000ff",
"urgent_workspace_text": "#ffffffff",
"binding_mode_border": "#2f343aff",
"binding_mode_bg": "#900000ff",
"binding_mode_text": "#ffffffff"
},
}
```
## 7. GET_VERSION
*MESSAGE*++
Retrieve version information about the sway process
*REPLY*++
An object containing the following properties:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- major
: integer
:[ The major version of the sway process
|- minor
: integer
: The minor version of the sway process
|- patch
: integer
: The patch version of the sway process
|- human_readable
: string
: A human readable version string that will likely contain more useful
information such as the git commit short hash and git branch
|- loaded_config_file_name
: string
: The path to the loaded config file
*Example Reply:*
```
{
"human_readable": "1.0-rc1-117-g2f7247e0 (Feb 24 2019, branch 'master')",
"major": 1,
"minor": 0,
"patch": 0,
"loaded_config_file_name": "/home/redsoxfan/.config/sway/config"
}
```
## 8. GET_BINDING_MODES
*MESSAGE*++
Retrieve the list of binding modes that currently configured
*REPLY*++
An array of strings, with each string being the name of a binding mode. This
will always contain at least one mode (currently _default_), which is the
default binding mode
*Example Reply:*
```
[
"default",
"resize",
]
```
## 9. GET_CONFIG
*MESSAGE*++
Retrieve the contents of the config that was last loaded
*REPLY*++
An object with a single string property containing the contents of the config
*Example Reply:*
```
{
"config": "set $mod Mod4\nbindsym $mod+q exit\n"
}
```
## 10. SEND_TICK
*MESSAGE*++
Issues a _TICK_ event to all clients subscribing to the event to ensure that
all events prior to the tick were received. If a payload is given, it will be
included in the _TICK_ event
*REPLY*++
A single object contains the property _success_, which is a boolean value
indicating whether the _TICK_ event was sent.
*Example Reply:*
```
{
"success": true
}
```
## 11. SYNC
*MESSAGE*++
For i3 compatibility, this command will just return a failure object since it
does not make sense to implement in sway due to the X11 nature of the command.
If you are curious about what this IPC command does in i3, refer to the i3
documentation.
*REPLY*++
A single object that contains the property _success_, which is set to the
boolean value _false_.
*Exact Reply:*
```
{
"success": false
}
```
## 12. GET_BINDING_STATE
*MESSAGE*++
Returns the currently active binding mode.
*REPLY*++
A single object that contains the property _name_, which is set to the
currently active binding mode as a string.
*Exact Reply:*
```
{
"name": "default"
}
```
## 100. GET_INPUTS
*MESSAGE*++
Retrieve a list of the input devices currently available
*REPLY*++
An array of objects corresponding to each input device. Each object has the
following properties:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- identifier
: string
:[ The identifier for the input device
|- name
: string
: The human readable name for the device
|- vendor
: integer
: The vendor code for the input device
|- product
: integer
: The product code for the input device
|- type
: string
: The device type. Currently this can be _keyboard_, _pointer_, _touch_,
_tablet\_tool_, _tablet\_pad_, or _switch_
|- xkb_active_layout_name
: string
: (Only keyboards) The name of the active keyboard layout in use
|- xkb_layout_names
: array
: (Only keyboards) A list a layout names configured for the keyboard
|- xkb_active_layout_index
: integer
: (Only keyboards) The index of the active keyboard layout in use
|- scroll_factor
: floating
: (Only pointers) Multiplier applied on scroll event values.
|- libinput
: object
: (Only libinput devices) An object describing the current device settings.
See below for more information
The _libinput_ object describes the device configuration for libinput devices.
Only properties that are supported for the device will be added to the object.
In addition to the possible options listed, all string properties may also be
_unknown_, in the case that a new option is added to libinput. See
*sway-input*(5) for information on the meaning of the possible values. The
following properties will be included for devices that support them:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- send_events
: string
:[ Whether events are being sent by the device. It can be _enabled_,
_disabled_, or _disabled\_on\_external\_mouse_
|- tap
: string
: Whether tap to click is enabled. It can be _enabled_ or _disabled_
|- tap_button_map
: string
: The finger to button mapping in use. It can be _lmr_ or _lrm_
|- tap_drag
: string
: Whether tap-and-drag is enabled. It can be _enabled_ or _disabled_
|- tap_drag_lock
: string
: Whether drag-lock is enabled. It can be _enabled_ or _disabled_
|- accel_speed
: double
: The pointer-acceleration in use
|- accel_profile
: string
: The acceleration profile in use. It can be _none_, _flat_, or _adaptive_
|- natural_scroll
: string
: Whether natural scrolling is enabled. It can be _enabled_ or _disabled_
|- left_handed
: string
: Whether left-handed mode is enabled. It can be _enabled_ or _disabled_
|- click_method
: string
: The click method in use. It can be _none_, _button_areas_, or _clickfinger_
|- middle_emulation
: string
: Whether middle emulation is enabled. It can be _enabled_ or _disabled_
|- scroll_method
: string
: The scroll method in use. It can be _none_, _two_finger_, _edge_, or
_on_button_down_
|- scroll_button
: int
: The scroll button to use when _scroll_method_ is _on_button_down_. This
will be given as an input event code
|- dwt
: string
: Whether disable-while-typing is enabled. It can be _enabled_ or _disabled_
|- dwtp
: string
: Whether disable-while-trackpointing is enabled. It can be _enabled_ or
_disabled_
|- calibration_matrix
: array
: An array of 6 floats representing the calibration matrix for absolute
devices such as touchscreens
*Example Reply:*
```
[
{
"identifier": "1:1:AT_Translated_Set_2_keyboard",
"name": "AT Translated Set 2 keyboard",
"vendor": 1,
"product": 1,
"type": "keyboard",
"xkb_active_layout_name": "English (US)",
"libinput": {
"send_events": "enabled"
}
},
{
"identifier": "1267:5:Elan_Touchpad",
"name": "Elan Touchpad",
"vendor": 1267,
"product": 5,
"type": "pointer",
"libinput": {
"send_events": "enabled",
"tap": "enabled",
"tap_button_map": "lmr",
"tap_drag": "enabled",
"tap_drag_lock": "disabled",
"accel_speed": 0.0,
"accel_profile": "none",
"natural_scroll", "disabled",
"left_handed": "disabled",
"click_method": "button_areas",
"middle_emulation": "disabled",
"scroll_method": "edge",
"dwt": "enabled",
"dwtp": "enabled"
}
},
{
"identifier": "3034:22494:USB2.0_VGA_UVC_WebCam:_USB2.0_V",
"name": "USB2.0 VGA UVC WebCam: USB2.0 V",
"vendor": 3034,
"product": 22494,
"type": "keyboard",
"xkb_active_layout_name": "English (US)",
"libinput": {
"send_events": "enabled"
}
},
{
"identifier": "0:3:Sleep_Button",
"name": "Sleep Button",
"vendor": 0,
"product": 3,
"type": "keyboard",
"xkb_active_layout_name": "English (US)",
"libinput": {
"send_events": "enabled"
}
},
{
"identifier": "0:5:Lid_Switch",
"name": "Lid Switch",
"vendor": 0,
"product": 5,
"type": "switch",
"libinput": {
"send_events": "enabled"
}
},
{
"identifier": "0:6:Video_Bus",
"name": "Video Bus",
"vendor": 0,
"product": 6,
"type": "keyboard",
"xkb_active_layout_name": "English (US)",
"libinput": {
"send_events": "enabled"
}
},
{
"identifier": "0:1:Power_Button",
"name": "Power Button",
"vendor": 0,
"product": 1,
"type": "keyboard",
"xkb_active_layout_name": "English (US)",
"libinput": {
"send_events": "enabled"
}
}
]
```
## 101. GET_SEATS
*MESSAGE*++
Retrieve a list of the seats currently configured
*REPLY*++
An array of objects corresponding to each seat. There will always be at least
one seat. Each object has the following properties:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- name
: string
:] The unique name for the seat
|- capabilities
: integer
: The number of capabilities that the seat has
|- focus
: integer
: The id of the node currently focused by the seat or _0_ when the seat is
not currently focused by a node (i.e. a surface layer or xwayland unmanaged
has focus)
|- devices
: array
: An array of input devices that are attached to the seat. Currently, this
is an array of objects that are identical to those returned by _GET\_INPUTS_
*Example Reply:*
```
[
{
"name": "seat0",
"capabilities": 3,
"focus": 7,
"devices": [
{
"identifier": "1:1:AT_Translated_Set_2_keyboard",
"name": "AT Translated Set 2 keyboard",
"vendor": 1,
"product": 1,
"type": "keyboard",
"xkb_active_layout_name": "English (US)",
"libinput": {
"send_events": "enabled"
}
},
{
"identifier": "1267:5:Elan_Touchpad",
"name": "Elan Touchpad",
"vendor": 1267,
"product": 5,
"type": "pointer",
"libinput": {
"send_events": "enabled",
"tap": "enabled",
"tap_button_map": "lmr",
"tap_drag": "enabled",
"tap_drag_lock": "disabled",
"accel_speed": 0.0,
"accel_profile": "none",
"natural_scroll", "disabled",
"left_handed": "disabled",
"click_method": "button_areas",
"middle_emulation": "disabled",
"scroll_method": "edge",
"dwt": "enabled",
"dwtp": "enabled"
}
},
{
"identifier": "3034:22494:USB2.0_VGA_UVC_WebCam:_USB2.0_V",
"name": "USB2.0 VGA UVC WebCam: USB2.0 V",
"vendor": 3034,
"product": 22494,
"type": "keyboard",
"xkb_active_layout_name": "English (US)",
"libinput": {
"send_events": "enabled"
}
},
{
"identifier": "0:3:Sleep_Button",
"name": "Sleep Button",
"vendor": 0,
"product": 3,
"type": "keyboard",
"xkb_active_layout_name": "English (US)",
"libinput": {
"send_events": "enabled"
}
},
{
"identifier": "0:5:Lid_Switch",
"name": "Lid Switch",
"vendor": 0,
"product": 5,
"type": "switch",
"libinput": {
"send_events": "enabled"
}
},
{
"identifier": "0:6:Video_Bus",
"name": "Video Bus",
"vendor": 0,
"product": 6,
"type": "keyboard",
"xkb_active_layout_name": "English (US)",
"libinput": {
"send_events": "enabled"
}
},
{
"identifier": "0:1:Power_Button",
"name": "Power Button",
"vendor": 0,
"product": 1,
"type": "keyboard",
"xkb_active_layout_name": "English (US)",
"libinput": {
"send_events": "enabled"
}
}
]
}
]
```
# EVENTS
Events are a way for client to get notified of changes to sway. A client can
subscribe to any events it wants to be notified of changes for. The event is
sent in the same format as a reply. The following events are currently
available:
[- *EVENT TYPE*
:- *NAME*
:- *DESCRIPTION*
|- 0x80000000
: workspace
:[ Sent whenever an event involving a workspace occurs such as initialization
of a new workspace or a different workspace gains focus
|- 0x80000002
: mode
: Sent whenever the binding mode changes
|- 0x80000003
: window
: Sent whenever an event involving a view occurs such as being reparented,
focused, or closed
|- 0x80000004
: barconfig_update
: Sent whenever a bar config changes
|- 0x80000005
: binding
: Sent when a configured binding is executed
|- 0x80000006
: shutdown
: Sent when the ipc shuts down because sway is exiting
|- 0x80000007
: tick
: Sent when an ipc client sends a _SEND\_TICK_ message
|- 0x80000014
: bar_state_update
: Send when the visibility of a bar should change due to a modifier
|- 0x80000015
: input
: Sent when something related to input devices changes
## 0x80000000. WORKSPACE
Sent whenever a change involving a workspace occurs. The event consists of a
single object with the following properties:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- change
: string
:[ The type of change that occurred. See below for more information
|- current
: object
: An object representing the workspace effected or _null_ for _reload_ changes
|- old
: object
: For a _focus_ change, this is will be an object representing the workspace
being switched from. Otherwise, it is _null_
The following change types are currently available:
[- *TYPE*
:- *DESCRIPTION*
|- init
:[ The workspace was created
|- empty
: The workspace is empty and is being destroyed since it is not visible
|- focus
: The workspace was focused. See the _old_ property for the previous focus
|- move
: The workspace was moved to a different output
|- rename
: The workspace was renamed
|- urgent
: A view on the workspace has had their urgency hint set or all urgency hints
for views on the workspace have been cleared
|- reload
: The configuration file has been reloaded
*Example Event:*
```
{
"change": "init",
"old": null,
"current": {
"id": 10,
"name": "2",
"rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"focused": false,
"focus": [
],
"border": "none",
"current_border_width": 0,
"layout": "splith",
"percent": null,
"window_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"deco_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"geometry": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"window": null,
"urgent": false,
"floating_nodes": [
],
"num": 2,
"output": "eDP-1",
"type": "workspace",
"representation": null,
"nodes": [
]
}
}
```
## 0x80000002. MODE
Sent whenever the binding mode changes. The event consists of a single object
with the following properties:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- change
: string
:[ The binding mode that became active
|- pango_markup
: boolean
: Whether the mode should be parsed as pango markup
*Example Event:*
```
{
"change": "default",
"pango_markup": false
}
```
## 0x80000003. WINDOW
Sent whenever a change involving a view occurs. The event consists of a single
object with the following properties:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- change
: string
:[ The type of change that occurred. See below for more information
|- container
: object
: An object representing the view effected
The following change types are currently available:
[- *TYPE*
:- *DESCRIPTION*
|- new
:[ The view was created
|- close
: The view was closed
|- focus
: The view was focused
|- title
: The view's title has changed
|- fullscreen_mode
: The view's fullscreen mode has changed
|- move
: The view has been reparented in the tree
|- floating
: The view has become floating or is no longer floating
|- urgent
: The view's urgency hint has changed status
|- mark
: A mark has been added or removed from the view
*Example Event:*
```
{
"change": "new",
"container": {
"id": 12,
"name": null,
"rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"focused": false,
"focus": [
],
"border": "none",
"current_border_width": 0,
"layout": "none",
"percent": 0.0,
"window_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"deco_rect": {
"x": 0,
"y": 0,
"width": 0,
"height": 0
},
"geometry": {
"x": 0,
"y": 0,
"width": 1124,
"height": 422
},
"window": 4194313,
"urgent": false,
"floating_nodes": [
],
"type": "con",
"pid": 19787,
"app_id": null,
"window_properties": {
"class": "URxvt",
"instance": "urxvt",
"transient_for": null
},
"nodes": [
]
}
}
```
## 0x80000004. BARCONFIG_UPDATE
Sent whenever a config for a bar changes. The event is identical to that of
_GET_BAR_CONFIG_ when a bar ID is given as a payload. See _6. GET\_BAR\_CONFIG
(WITH A PAYLOAD)_ above for more information.
## 0x80000005. BINDING
Sent whenever a binding is executed. The event is a single object with the
following properties:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- change
: string
:[ The change that occurred for the binding. Currently this will only be _run_
|- command
: string
: The command associated with the binding
|- event_state_mask
: array
: An array of strings that correspond to each modifier key for the binding
|- input_code
: integer
: For keyboard bindcodes, this is the key code for the binding. For mouse
bindings, this is the X11 button number, if there is an equivalent. In all
other cases, this will be _0_.
|- symbol
: string
: For keyboard bindsyms, this is the bindsym for the binding. Otherwise, this
will be _null_
|- input_type
: string
: The input type that triggered the binding. This is either _keyboard_ or
_mouse_
*Example Event:*
```
{
"change": "run",
"binding": {
"command": "workspace 2",
"event_state_mask": [
"Mod4"
],
"input_code": 0,
"symbol": "2",
"input_type": "keyboard"
}
}
```
## 0x80000006. SHUTDOWN
Sent whenever the IPC is shutting down. The event is a single object with the
property _change_, which is a string containing the reason for the shutdown.
Currently, the only value for _change_ is _exit_, which is issued when sway is
exiting.
*Example Event:*
```
{
"change": "exit"
}
```
## 0x80000007. TICK
Sent when first subscribing to tick events or by a _SEND\_TICK_ message. The
event is a single object with the following properties:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- first
: boolean
: Whether this event was triggered by subscribing to the tick events
|- payload
: string
: The payload given with a _SEND\_TICK_ message, if any. Otherwise, an empty
string
*Example Event:*
```
{
"first": true
"payload": ""
}
```
## 0x80000014. BAR_STATE_UPDATE
Sent when the visibility of a bar changes due to a modifier being pressed. The
event is a single object with the following properties:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- id
: string
:[ The bar ID effected
|- visible_by_modifier
: boolean
: Whether the bar should be made visible due to a modifier being pressed
*Example Event:*
```
{
"id": "bar-0",
"visible_by_modifier": true
}
```
## 0x80000015. INPUT
Sent when something related to the input devices changes. The event is a single
object with the following properties:
[- *PROPERTY*
:- *DATA TYPE*
:- *DESCRIPTION*
|- change
: string
:[ What has changed
|- input
: object
: An object representing the input that is identical the ones GET_INPUTS gives
The following change types are currently available:
[- *TYPE*
:- *DESCRIPTION*
|- added
:[ The input device became available
|- removed
: The input device is no longer available
|- xkb_keymap
: (Keyboards only) The keymap for the keyboard has changed
|- xkb_layout
: (Keyboards only) The effective layout in the keymap has changed
|- libinput_config
: (libinput device only) A libinput config option for the device changed
*Example Event:*
```
{
"change": "xkb_layout",
"input": {
"identifier": "1:1:AT_Translated_Set_2_keyboard",
"name": "AT Translated Set 2 keyboard",
"vendor": 1,
"product": 1,
"type": "keyboard",
"xkb_layout_names": [
"English (US)",
"English (Dvorak)"
],
"xkb_active_layout_index": 1,
"xkb_active_layout_name": "English (Dvorak)",
"libinput": {
"send_events": "enabled"
}
}
}
```
# SEE ALSO
*sway*(1) *sway*(5) *sway-bar*(5) *swaymsg*(1) *sway-input*(5) *sway-output*(5)
Reference in a new issue View git blame Copy permalink