2 # vim:ts=4:sw=4:expandtab
14 AnyEvent::I3 - communicate with the i3 window manager
18 our $VERSION = '0.09';
26 This module connects to the i3 window manager using the UNIX socket based
27 IPC interface it provides (if enabled in the configuration file). You can
28 then subscribe to events or send messages and receive their replies.
30 use AnyEvent::I3 qw(:all);
32 my $i3 = i3("~/.i3/ipc.sock");
34 $i3->connect->recv or die "Error connecting";
35 say "Connected to i3";
37 my $workspaces = $i3->message(TYPE_GET_WORKSPACES)->recv;
38 say "Currently, you use " . @{$workspaces} . " workspaces";
40 ...or, using the sugar methods:
44 my $workspaces = i3->get_workspaces->recv;
45 say "Currently, you use " . @{$workspaces} . " workspaces";
49 =head2 $i3 = i3([ $path ]);
51 Creates a new C<AnyEvent::I3> object and returns it. C<path> is the path of
52 the UNIX socket to connect to.
54 =head1 SUBROUTINES/METHODS
58 use Exporter qw(import);
63 use constant TYPE_COMMAND => 0;
64 use constant TYPE_GET_WORKSPACES => 1;
65 use constant TYPE_SUBSCRIBE => 2;
66 use constant TYPE_GET_OUTPUTS => 3;
67 use constant TYPE_GET_TREE => 4;
68 use constant TYPE_GET_MARKS => 5;
69 use constant TYPE_GET_BAR_CONFIG => 6;
70 use constant TYPE_GET_LOG_MARKERS => 7;
72 our %EXPORT_TAGS = ( 'all' => [
73 qw(i3 TYPE_COMMAND TYPE_GET_WORKSPACES TYPE_SUBSCRIBE TYPE_GET_OUTPUTS
74 TYPE_GET_TREE TYPE_GET_MARKS TYPE_GET_BAR_CONFIG TYPE_GET_LOG_MARKERS)
77 our @EXPORT_OK = ( @{ $EXPORT_TAGS{all} } );
81 # TODO: auto-generate this from the header file? (i3/ipc.h)
82 my $event_mask = (1 << 31);
84 workspace => ($event_mask | 0),
85 output => ($event_mask | 1),
93 =head2 $i3 = AnyEvent::I3->new([ $path ])
95 Creates a new C<AnyEvent::I3> object and returns it. C<path> is the path of
96 the UNIX socket to connect to.
100 my ($class, $path) = @_;
102 $path ||= '~/.i3/ipc.sock';
104 # Check if we need to resolve ~
106 # We use getpwuid() instead of $ENV{HOME} because the latter is tainted
107 # and thus produces warnings when running tests with perl -T
108 my $home = (getpwuid($<))[7];
109 die "Could not get home directory" unless $home and -d $home;
110 $path =~ s/~/$home/g;
113 bless { path => $path } => $class;
118 Establishes the connection to i3. Returns an C<AnyEvent::CondVar> which will
119 be triggered with a boolean (true if the connection was established) as soon as
120 the connection has been established.
122 if ($i3->connect->recv) {
123 say "Connected to i3";
129 my $cv = AnyEvent->condvar;
131 tcp_connect "unix/", $self->{path}, sub {
134 return $cv->send(0) unless $fh;
136 $self->{ipchdl} = AnyEvent::Handle->new(
138 on_read => sub { my ($hdl) = @_; $self->_data_available($hdl) },
140 my ($hdl, $fatal, $msg) = @_;
141 delete $self->{ipchdl};
144 my $cb = $self->{callbacks};
146 # Trigger all one-time callbacks with undef
147 for my $type (keys %{$cb}) {
148 next if ($type & $event_mask) == $event_mask;
153 # Trigger _error callback, if set
154 my $type = $events{_error};
155 return unless defined($cb->{$type});
156 $cb->{$type}->($msg);
166 sub _data_available {
167 my ($self, $hdl) = @_;
170 chunk => length($magic) + 4 + 4,
173 # Unpack message length and read the payload
174 my ($len, $type) = unpack("LL", substr($header, length($magic)));
177 sub { $self->_handle_i3_message($type, $_[1]) }
183 sub _handle_i3_message {
184 my ($self, $type, $payload) = @_;
186 return unless defined($self->{callbacks}->{$type});
188 my $cb = $self->{callbacks}->{$type};
189 $cb->(decode_json $payload);
191 return if ($type & $event_mask) == $event_mask;
193 # If this was a one-time callback, we delete it
194 # (when connection is lost, all one-time callbacks get triggered)
195 delete $self->{callbacks}->{$type};
198 =head2 $i3->subscribe(\%callbacks)
200 Subscribes to the given event types. This function awaits a hashref with the
201 key being the name of the event and the value being a callback.
204 workspace => sub { say "Workspaces changed" }
207 if ($i3->subscribe(\%callbacks)->recv->{success})
208 say "Successfully subscribed";
211 The special callback with name C<_error> is called when the connection to i3
212 is killed (because of a crash, exit or restart of i3 most likely). You can
213 use it to print an appropriate message and exit cleanly or to try to reconnect.
218 say "I am sorry. I am so sorry: $msg";
223 $i3->subscribe(\%callbacks)->recv;
227 my ($self, $callbacks) = @_;
229 # Register callbacks for each message type
230 for my $key (keys %{$callbacks}) {
231 my $type = $events{$key};
232 $self->{callbacks}->{$type} = $callbacks->{$key};
235 $self->message(TYPE_SUBSCRIBE, [ keys %{$callbacks} ])
238 =head2 $i3->message($type, $content)
240 Sends a message of the specified C<type> to i3, possibly containing the data
241 structure C<content> (or C<content>, encoded as utf8, if C<content> is a
242 scalar), if specified.
244 my $reply = $i3->message(TYPE_COMMAND, "reload")->recv;
245 if ($reply->{success}) {
246 say "Configuration successfully reloaded";
251 my ($self, $type, $content) = @_;
253 die "No message type specified" unless defined($type);
255 die "No connection to i3" unless defined($self->{ipchdl});
259 if (not ref($content)) {
260 # Convert from Perl’s internal encoding to UTF8 octets
261 $payload = encode_utf8($content);
263 $payload = encode_json $content;
266 my $message = $magic . pack("LL", length($payload), $type) . $payload;
267 $self->{ipchdl}->push_write($message);
269 my $cv = AnyEvent->condvar;
271 # We don’t preserve the old callback as it makes no sense to
272 # have a callback on message reply types (only on events)
273 $self->{callbacks}->{$type} =
277 undef $self->{callbacks}->{$type};
285 These methods intend to make your scripts as beautiful as possible. All of
286 them automatically establish a connection to i3 blockingly (if it does not
291 sub _ensure_connection {
294 return if defined($self->{ipchdl});
296 $self->connect->recv or die "Unable to connect to i3"
299 =head2 get_workspaces
301 Gets the current workspaces from i3.
303 my $ws = i3->get_workspaces->recv;
310 $self->_ensure_connection;
312 $self->message(TYPE_GET_WORKSPACES)
317 Gets the current outputs from i3.
319 my $outs = i3->get_outputs->recv;
326 $self->_ensure_connection;
328 $self->message(TYPE_GET_OUTPUTS)
333 Gets the layout tree from i3 (>= v4.0).
335 my $tree = i3->get_tree->recv;
342 $self->_ensure_connection;
344 $self->message(TYPE_GET_TREE)
349 Gets all the window identifier marks from i3 (>= v4.1).
351 my $marks = i3->get_marks->recv;
358 $self->_ensure_connection;
360 $self->message(TYPE_GET_MARKS)
363 =head2 get_bar_config
365 Gets the bar configuration for the specific bar id from i3 (>= v4.1).
367 my $config = i3->get_bar_config($id)->recv;
372 my ($self, $id) = @_;
374 $self->_ensure_connection;
376 $self->message(TYPE_GET_BAR_CONFIG, $id)
379 =head2 get_log_markers
381 Gets the bar configuration for the specific bar id from i3 (>= v4.1).
383 my $markers = i3->get_log_markers()->recv;
384 say Dumper($markers);
387 sub get_log_markers {
390 $self->_ensure_connection;
392 $self->message(TYPE_GET_LOG_MARKERS)
396 =head2 command($content)
398 Makes i3 execute the given command
400 my $reply = i3->command("reload")->recv;
401 die "command failed" unless $reply->{success};
405 my ($self, $content) = @_;
407 $self->_ensure_connection;
409 $self->message(TYPE_COMMAND, $content)
414 Michael Stapelberg, C<< <michael at stapelberg.de> >>
418 Please report any bugs or feature requests to C<bug-anyevent-i3 at
419 rt.cpan.org>, or through the web interface at
420 L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=AnyEvent-I3>. I will be
421 notified, and then you'll automatically be notified of progress on your bug as
426 You can find documentation for this module with the perldoc command.
430 You can also look for information at:
434 =item * RT: CPAN's request tracker
436 L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=AnyEvent-I3>
438 =item * The i3 window manager website
440 L<http://i3.zekjur.net/>
445 =head1 ACKNOWLEDGEMENTS
448 =head1 LICENSE AND COPYRIGHT
450 Copyright 2010 Michael Stapelberg.
452 This program is free software; you can redistribute it and/or modify it
453 under the terms of either: the GNU General Public License as published
454 by the Free Software Foundation; or the Artistic License.
456 See http://dev.perl.org/licenses/ for more information.
461 1; # End of AnyEvent::I3