/ 
AnyEvent-Sway-v0.18.1
River stage zero No dependents
/ AnyEvent::Sway

NAME

AnyEvent::Sway - communicate with the Sway window manager

VERSION

Version 0.18.1

SYNOPSIS

This module connects to the Sway window manager using the UNIX socket based IPC interface it provides (if enabled in the configuration file). You can then subscribe to events or send messages and receive their replies.

use AnyEvent::Sway qw(:all);

my $sway = sway();

$sway->connect->recv or die "Error connecting";
say "Connected to Sway";

my $workspaces = $sway->message(TYPE_GET_WORKSPACES)->recv;
say "Currently, you use " . @{$workspaces} . " workspaces";

...or, using the sugar methods:

use AnyEvent::Sway;

my $workspaces = Sway->get_workspaces->recv;
say "Currently, you use " . @{$workspaces} . " workspaces";

A somewhat more involved example which dumps the Sway layout tree whenever there is a workspace event:

use Data::Dumper;
use AnyEvent;
use AnyEvent::Sway;

my $sway = sway();

$sway->connect->recv or die "Error connecting to Sway";

$sway->subscribe({
    workspace => sub {
        $sway->get_tree->cb(sub {
            my ($tree) = @_;
            say "tree: " . Dumper($tree);
        });
    }
})->recv->{success} or die "Error subscribing to events";

AE::cv->recv

EXPORT

$sway = sway([ $path ]);

Creates a new AnyEvent::Sway object and returns it.

path is an optional path of the UNIX socket to connect to. It is strongly advised to NOT specify this unless you're absolutely sure you need it. AnyEvent::Sway will automatically figure it out by querying the running Sway instance on the current DISPLAY which is almost always what you want.

SUBROUTINES/METHODS

$sway = AnyEvent::Sway->new([ $path ])

Creates a new AnyEvent::Sway object and returns it.

path is an optional path of the UNIX socket to connect to. It is strongly advised to NOT specify this unless you're absolutely sure you need it. AnyEvent::Sway will automatically figure it out by querying the running Sway instance on the current DISPLAY which is almost always what you want.

$sway->connect

Establishes the connection to Sway. Returns an AnyEvent::CondVar which will be triggered with a boolean (true if the connection was established) as soon as the connection has been established.

if ($sway->connect->recv) {
    say "Connected to Sway";
}

$sway->subscribe(\%callbacks)

Subscribes to the given event types. This function awaits a hashref with the key being the name of the event and the value being a callback.

my %callbacks = (
    workspace => sub { say "Workspaces changed" }
);

if ($sway->subscribe(\%callbacks)->recv->{success}) {
    say "Successfully subscribed";
}

The special callback with name _error is called when the connection to Sway is killed (because of a crash, exit or restart of Sway most likely). You can use it to print an appropriate message and exit cleanly or to try to reconnect.

my %callbacks = (
    _error => sub {
        my ($msg) = @_;
        say "I am sorry. I am so sorry: $msg";
        exit 1;
    }
);

$sway->subscribe(\%callbacks)->recv;

$sway->message($type, $content)

Sends a message of the specified type to Sway, possibly containing the data structure content (or content, encoded as utf8, if content is a scalar), if specified.

my $reply = $sway->message(TYPE_RUN_COMMAND, "reload")->recv;
if ($reply->{success}) {
    say "Configuration successfully reloaded";
}

SUGAR METHODS

These methods intend to make your scripts as beautiful as possible. All of them automatically establish a connection to Sway blockingly (if it does not already exist).

get_workspaces

Gets the current workspaces from Sway.

my $ws = sway->get_workspaces->recv;
say Dumper($ws);

get_outputs

Gets the current outputs from Sway.

my $outs = sway->get_outputs->recv;
say Dumper($outs);

get_tree

Gets the layout tree from Sway (>= v4.0).

my $tree = sway->get_tree->recv;
say Dumper($tree);

get_marks

Gets all the window identifier marks from Sway (>= v4.1).

my $marks = sway->get_marks->recv;
say Dumper($marks);

get_bar_config

Gets the bar configuration for the specific bar id from Sway (>= v4.1).

my $config = sway->get_bar_config($id)->recv;
say Dumper($config);

get_version

Gets the Sway version via IPC, with a fall-back that parses the output of Sway --version (for Sway < v4.3).

my $version = sway->get_version()->recv;
say "major: " . $version->{major} . ", minor = " . $version->{minor};

get_config

Gets the raw last read config from Sway. Requires Sway >= 4.14

send_tick

Sends a tick event. Requires Sway >= 4.15

sync

Sends an Sway sync event. Requires Sway >= 4.16

command($content)

Makes Sway execute the given command

my $reply = sway->command("reload")->recv;
die "command failed" unless $reply->{success};

AUTHOR

John Mertz, <git at john.me.tz>

BUGS

Please report any bugs or feature requests to bug-anyevent-sway at rt.cpan.org, or through the web interface at https://rt.cpan.org/NoAuth/ReportBug.html?Queue=AnyEvent-Sway. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc AnyEvent::Sway

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2024 (C) John Mertz

Forked from AnyEvent::I3 by Michael Stapelberg

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See https://dev.perl.org/licenses/ for more information.