2 # vim:ts=4:sw=4:expandtab
11 use Scalar::Util qw(tainted);
15 AnyEvent::I3 - communicate with the i3 window manager
19 our $VERSION = '0.17';
27 This module connects to the i3 window manager using the UNIX socket based
28 IPC interface it provides (if enabled in the configuration file). You can
29 then subscribe to events or send messages and receive their replies.
31 use AnyEvent::I3 qw(:all);
35 $i3->connect->recv or die "Error connecting";
36 say "Connected to i3";
38 my $workspaces = $i3->message(TYPE_GET_WORKSPACES)->recv;
39 say "Currently, you use " . @{$workspaces} . " workspaces";
41 ...or, using the sugar methods:
45 my $workspaces = i3->get_workspaces->recv;
46 say "Currently, you use " . @{$workspaces} . " workspaces";
48 A somewhat more involved example which dumps the i3 layout tree whenever there
57 $i3->connect->recv or die "Error connecting to i3";
61 $i3->get_tree->cb(sub {
63 say "tree: " . Dumper($tree);
66 })->recv->{success} or die "Error subscribing to events";
72 =head2 $i3 = i3([ $path ]);
74 Creates a new C<AnyEvent::I3> object and returns it.
76 C<path> is an optional path of the UNIX socket to connect to. It is strongly
77 advised to NOT specify this unless you're absolutely sure you need it.
78 C<AnyEvent::I3> will automatically figure it out by querying the running i3
79 instance on the current DISPLAY which is almost always what you want.
81 =head1 SUBROUTINES/METHODS
85 use Exporter qw(import);
90 use constant TYPE_COMMAND => 0;
91 use constant TYPE_GET_WORKSPACES => 1;
92 use constant TYPE_SUBSCRIBE => 2;
93 use constant TYPE_GET_OUTPUTS => 3;
94 use constant TYPE_GET_TREE => 4;
95 use constant TYPE_GET_MARKS => 5;
96 use constant TYPE_GET_BAR_CONFIG => 6;
97 use constant TYPE_GET_VERSION => 7;
99 our %EXPORT_TAGS = ( 'all' => [
100 qw(i3 TYPE_COMMAND TYPE_GET_WORKSPACES TYPE_SUBSCRIBE TYPE_GET_OUTPUTS
101 TYPE_GET_TREE TYPE_GET_MARKS TYPE_GET_BAR_CONFIG TYPE_GET_VERSION)
104 our @EXPORT_OK = ( @{ $EXPORT_TAGS{all} } );
106 my $magic = "i3-ipc";
108 # TODO: auto-generate this from the header file? (i3/ipc.h)
109 my $event_mask = (1 << 31);
111 workspace => ($event_mask | 0),
112 output => ($event_mask | 1),
113 mode => ($event_mask | 2),
114 window => ($event_mask | 3),
115 barconfig_update => ($event_mask | 4),
116 binding => ($event_mask | 5),
117 shutdown => ($event_mask | 6),
118 _error => 0xFFFFFFFF,
122 AnyEvent::I3->new(@_)
125 # Calls i3, even when running in taint mode.
129 my $path_tainted = tainted($ENV{PATH});
130 # This effectively circumvents taint mode checking for $ENV{PATH}. We
131 # do this because users might specify PATH explicitly to call i3 in a
132 # custom location (think ~/.bin/).
133 (local $ENV{PATH}) = ($ENV{PATH} =~ /(.*)/);
135 # In taint mode, we also need to remove all relative directories from
136 # PATH (like . or ../bin). We only do this in taint mode and warn the
137 # user, since this might break a real-world use case for some people.
139 my @dirs = split /:/, $ENV{PATH};
140 my @filtered = grep !/^\./, @dirs;
141 if (scalar @dirs != scalar @filtered) {
142 $ENV{PATH} = join ':', @filtered;
143 warn qq|Removed relative directories from PATH because you | .
144 qq|are running Perl with taint mode enabled. Remove -T | .
145 qq|to be able to use relative directories in PATH. | .
146 qq|New PATH is "$ENV{PATH}"|;
149 # Otherwise the qx() operator wont work:
150 delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};
151 chomp(my $result = qx(i3 $args));
152 # Circumventing taint mode again: the socket can be anywhere on the
153 # system and that’s okay.
154 if ($result =~ /^([^\0]+)$/) {
158 warn "Calling i3 $args failed. Is DISPLAY set and is i3 in your PATH?";
162 =head2 $i3 = AnyEvent::I3->new([ $path ])
164 Creates a new C<AnyEvent::I3> object and returns it.
166 C<path> is an optional path of the UNIX socket to connect to. It is strongly
167 advised to NOT specify this unless you're absolutely sure you need it.
168 C<AnyEvent::I3> will automatically figure it out by querying the running i3
169 instance on the current DISPLAY which is almost always what you want.
173 my ($class, $path) = @_;
175 $path = _call_i3('--get-socketpath') unless $path;
177 # This is the old default path (v3.*). This fallback line can be removed in
178 # a year from now. -- Michael, 2012-07-09
179 $path ||= '~/.i3/ipc.sock';
181 # Check if we need to resolve ~
183 # We use getpwuid() instead of $ENV{HOME} because the latter is tainted
184 # and thus produces warnings when running tests with perl -T
185 my $home = (getpwuid($<))[7];
186 die "Could not get home directory" unless $home and -d $home;
187 $path =~ s/~/$home/g;
190 bless { path => $path } => $class;
195 Establishes the connection to i3. Returns an C<AnyEvent::CondVar> which will
196 be triggered with a boolean (true if the connection was established) as soon as
197 the connection has been established.
199 if ($i3->connect->recv) {
200 say "Connected to i3";
206 my $cv = AnyEvent->condvar;
208 tcp_connect "unix/", $self->{path}, sub {
211 return $cv->send(0) unless $fh;
213 $self->{ipchdl} = AnyEvent::Handle->new(
215 on_read => sub { my ($hdl) = @_; $self->_data_available($hdl) },
217 my ($hdl, $fatal, $msg) = @_;
218 delete $self->{ipchdl};
221 my $cb = $self->{callbacks};
223 # Trigger all one-time callbacks with undef
224 for my $type (keys %{$cb}) {
225 next if ($type & $event_mask) == $event_mask;
230 # Trigger _error callback, if set
231 my $type = $events{_error};
232 return unless defined($cb->{$type});
233 $cb->{$type}->($msg);
243 sub _data_available {
244 my ($self, $hdl) = @_;
247 chunk => length($magic) + 4 + 4,
250 # Unpack message length and read the payload
251 my ($len, $type) = unpack("LL", substr($header, length($magic)));
254 sub { $self->_handle_i3_message($type, $_[1]) }
260 sub _handle_i3_message {
261 my ($self, $type, $payload) = @_;
263 return unless defined($self->{callbacks}->{$type});
265 my $cb = $self->{callbacks}->{$type};
266 $cb->(decode_json $payload);
268 return if ($type & $event_mask) == $event_mask;
270 # If this was a one-time callback, we delete it
271 # (when connection is lost, all one-time callbacks get triggered)
272 delete $self->{callbacks}->{$type};
275 =head2 $i3->subscribe(\%callbacks)
277 Subscribes to the given event types. This function awaits a hashref with the
278 key being the name of the event and the value being a callback.
281 workspace => sub { say "Workspaces changed" }
284 if ($i3->subscribe(\%callbacks)->recv->{success}) {
285 say "Successfully subscribed";
288 The special callback with name C<_error> is called when the connection to i3
289 is killed (because of a crash, exit or restart of i3 most likely). You can
290 use it to print an appropriate message and exit cleanly or to try to reconnect.
295 say "I am sorry. I am so sorry: $msg";
300 $i3->subscribe(\%callbacks)->recv;
304 my ($self, $callbacks) = @_;
306 # Register callbacks for each message type
307 for my $key (keys %{$callbacks}) {
308 my $type = $events{$key};
309 $self->{callbacks}->{$type} = $callbacks->{$key};
312 $self->message(TYPE_SUBSCRIBE, [ keys %{$callbacks} ])
315 =head2 $i3->message($type, $content)
317 Sends a message of the specified C<type> to i3, possibly containing the data
318 structure C<content> (or C<content>, encoded as utf8, if C<content> is a
319 scalar), if specified.
321 my $reply = $i3->message(TYPE_COMMAND, "reload")->recv;
322 if ($reply->{success}) {
323 say "Configuration successfully reloaded";
328 my ($self, $type, $content) = @_;
330 die "No message type specified" unless defined($type);
332 die "No connection to i3" unless defined($self->{ipchdl});
336 if (not ref($content)) {
337 # Convert from Perl’s internal encoding to UTF8 octets
338 $payload = encode_utf8($content);
340 $payload = encode_json $content;
343 my $message = $magic . pack("LL", length($payload), $type) . $payload;
344 $self->{ipchdl}->push_write($message);
346 my $cv = AnyEvent->condvar;
348 # We don’t preserve the old callback as it makes no sense to
349 # have a callback on message reply types (only on events)
350 $self->{callbacks}->{$type} =
354 undef $self->{callbacks}->{$type};
362 These methods intend to make your scripts as beautiful as possible. All of
363 them automatically establish a connection to i3 blockingly (if it does not
368 sub _ensure_connection {
371 return if defined($self->{ipchdl});
373 $self->connect->recv or die "Unable to connect to i3 (socket path " . $self->{path} . ")";
376 =head2 get_workspaces
378 Gets the current workspaces from i3.
380 my $ws = i3->get_workspaces->recv;
387 $self->_ensure_connection;
389 $self->message(TYPE_GET_WORKSPACES)
394 Gets the current outputs from i3.
396 my $outs = i3->get_outputs->recv;
403 $self->_ensure_connection;
405 $self->message(TYPE_GET_OUTPUTS)
410 Gets the layout tree from i3 (>= v4.0).
412 my $tree = i3->get_tree->recv;
419 $self->_ensure_connection;
421 $self->message(TYPE_GET_TREE)
426 Gets all the window identifier marks from i3 (>= v4.1).
428 my $marks = i3->get_marks->recv;
435 $self->_ensure_connection;
437 $self->message(TYPE_GET_MARKS)
440 =head2 get_bar_config
442 Gets the bar configuration for the specific bar id from i3 (>= v4.1).
444 my $config = i3->get_bar_config($id)->recv;
449 my ($self, $id) = @_;
451 $self->_ensure_connection;
453 $self->message(TYPE_GET_BAR_CONFIG, $id)
458 Gets the i3 version via IPC, with a fall-back that parses the output of i3
459 --version (for i3 < v4.3).
461 my $version = i3->get_version()->recv;
462 say "major: " . $version->{major} . ", minor = " . $version->{minor};
468 $self->_ensure_connection;
470 my $cv = AnyEvent->condvar;
472 my $version_cv = $self->message(TYPE_GET_VERSION);
474 $timeout = AnyEvent->timer(
477 warn "Falling back to i3 --version since the running i3 doesn’t support GET_VERSION yet.";
478 my $version = _call_i3('--version');
479 $version =~ s/^i3 version //;
481 my ($major, $minor) = ($version =~ /^([0-9]+)\.([0-9]+)/);
482 if ($version =~ /^[0-9]+\.[0-9]+\.([0-9]+)/) {
485 # Strip everything from the © sign on.
486 $version =~ s/ ©.*$//g;
488 major => int($major),
489 minor => int($minor),
490 patch => int($patch),
491 human_readable => $version,
496 $version_cv->cb(sub {
498 $cv->send($version_cv->recv);
504 =head2 command($content)
506 Makes i3 execute the given command
508 my $reply = i3->command("reload")->recv;
509 die "command failed" unless $reply->{success};
513 my ($self, $content) = @_;
515 $self->_ensure_connection;
517 $self->message(TYPE_COMMAND, $content)
522 Michael Stapelberg, C<< <michael at i3wm.org> >>
526 Please report any bugs or feature requests to C<bug-anyevent-i3 at
527 rt.cpan.org>, or through the web interface at
528 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=AnyEvent-I3>. I will be
529 notified, and then you'll automatically be notified of progress on your bug as
534 You can find documentation for this module with the perldoc command.
538 You can also look for information at:
542 =item * RT: CPAN's request tracker
544 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=AnyEvent-I3>
546 =item * The i3 window manager website
553 =head1 ACKNOWLEDGEMENTS
556 =head1 LICENSE AND COPYRIGHT
558 Copyright 2010-2012 Michael Stapelberg.
560 This program is free software; you can redistribute it and/or modify it
561 under the terms of either: the GNU General Public License as published
562 by the Free Software Foundation; or the Artistic License.
564 See http://dev.perl.org/licenses/ for more information.
569 1; # End of AnyEvent::I3