use AnyEvent::Socket;
use AnyEvent;
use Encode;
+use Scalar::Util qw(tainted);
=head1 NAME
=cut
-our $VERSION = '0.04';
+our $VERSION = '0.17';
=head1 VERSION
-Version 0.04
+Version 0.17
=head1 SYNOPSIS
use AnyEvent::I3 qw(:all);
- my $i3 = i3("~/.i3/ipc.sock");
+ my $i3 = i3();
$i3->connect->recv or die "Error connecting";
say "Connected to i3";
use AnyEvent::I3;
- my $workspaces = i3->workspaces->recv;
+ my $workspaces = i3->get_workspaces->recv;
say "Currently, you use " . @{$workspaces} . " workspaces";
+A somewhat more involved example which dumps the i3 layout tree whenever there
+is a workspace event:
+
+ use Data::Dumper;
+ use AnyEvent;
+ use AnyEvent::I3;
+
+ my $i3 = i3();
+
+ $i3->connect->recv or die "Error connecting to i3";
+
+ $i3->subscribe({
+ workspace => sub {
+ $i3->get_tree->cb(sub {
+ my ($tree) = @_;
+ say "tree: " . Dumper($tree);
+ });
+ }
+ })->recv->{success} or die "Error subscribing to events";
+
+ AE::cv->recv
+
=head1 EXPORT
=head2 $i3 = i3([ $path ]);
-Creates a new C<AnyEvent::I3> object and returns it. C<path> is the path of
-the UNIX socket to connect to.
+Creates a new C<AnyEvent::I3> object and returns it.
+
+C<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.
+C<AnyEvent::I3> will automatically figure it out by querying the running i3
+instance on the current DISPLAY which is almost always what you want.
=head1 SUBROUTINES/METHODS
use constant TYPE_GET_WORKSPACES => 1;
use constant TYPE_SUBSCRIBE => 2;
use constant TYPE_GET_OUTPUTS => 3;
+use constant TYPE_GET_TREE => 4;
+use constant TYPE_GET_MARKS => 5;
+use constant TYPE_GET_BAR_CONFIG => 6;
+use constant TYPE_GET_VERSION => 7;
our %EXPORT_TAGS = ( 'all' => [
- qw(i3 TYPE_COMMAND TYPE_GET_WORKSPACES TYPE_SUBSCRIBE TYPE_GET_OUTPUTS)
+ qw(i3 TYPE_COMMAND TYPE_GET_WORKSPACES TYPE_SUBSCRIBE TYPE_GET_OUTPUTS
+ TYPE_GET_TREE TYPE_GET_MARKS TYPE_GET_BAR_CONFIG TYPE_GET_VERSION)
] );
our @EXPORT_OK = ( @{ $EXPORT_TAGS{all} } );
my %events = (
workspace => ($event_mask | 0),
output => ($event_mask | 1),
+ mode => ($event_mask | 2),
+ window => ($event_mask | 3),
+ barconfig_update => ($event_mask | 4),
+ binding => ($event_mask | 5),
+ shutdown => ($event_mask | 6),
_error => 0xFFFFFFFF,
);
AnyEvent::I3->new(@_)
}
+# Calls i3, even when running in taint mode.
+sub _call_i3 {
+ my ($args) = @_;
+
+ my $path_tainted = tainted($ENV{PATH});
+ # This effectively circumvents taint mode checking for $ENV{PATH}. We
+ # do this because users might specify PATH explicitly to call i3 in a
+ # custom location (think ~/.bin/).
+ (local $ENV{PATH}) = ($ENV{PATH} =~ /(.*)/);
+
+ # In taint mode, we also need to remove all relative directories from
+ # PATH (like . or ../bin). We only do this in taint mode and warn the
+ # user, since this might break a real-world use case for some people.
+ if ($path_tainted) {
+ my @dirs = split /:/, $ENV{PATH};
+ my @filtered = grep !/^\./, @dirs;
+ if (scalar @dirs != scalar @filtered) {
+ $ENV{PATH} = join ':', @filtered;
+ warn qq|Removed relative directories from PATH because you | .
+ qq|are running Perl with taint mode enabled. Remove -T | .
+ qq|to be able to use relative directories in PATH. | .
+ qq|New PATH is "$ENV{PATH}"|;
+ }
+ }
+ # Otherwise the qx() operator wont work:
+ delete @ENV{'IFS', 'CDPATH', 'ENV', 'BASH_ENV'};
+ chomp(my $result = qx(i3 $args));
+ # Circumventing taint mode again: the socket can be anywhere on the
+ # system and that’s okay.
+ if ($result =~ /^([^\0]+)$/) {
+ return $1;
+ }
+
+ warn "Calling i3 $args failed. Is DISPLAY set and is i3 in your PATH?";
+ return undef;
+}
+
=head2 $i3 = AnyEvent::I3->new([ $path ])
-Creates a new C<AnyEvent::I3> object and returns it. C<path> is the path of
-the UNIX socket to connect to.
+Creates a new C<AnyEvent::I3> object and returns it.
+
+C<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.
+C<AnyEvent::I3> will automatically figure it out by querying the running i3
+instance on the current DISPLAY which is almost always what you want.
=cut
sub new {
my ($class, $path) = @_;
+ $path = _call_i3('--get-socketpath') unless $path;
+
+ # This is the old default path (v3.*). This fallback line can be removed in
+ # a year from now. -- Michael, 2012-07-09
$path ||= '~/.i3/ipc.sock';
- bless { path => glob($path) } => $class;
+ # Check if we need to resolve ~
+ if ($path =~ /~/) {
+ # We use getpwuid() instead of $ENV{HOME} because the latter is tainted
+ # and thus produces warnings when running tests with perl -T
+ my $home = (getpwuid($<))[7];
+ die "Could not get home directory" unless $home and -d $home;
+ $path =~ s/~/$home/g;
+ }
+
+ bless { path => $path } => $class;
}
=head2 $i3->connect
for my $type (keys %{$cb}) {
next if ($type & $event_mask) == $event_mask;
$cb->{$type}->();
+ delete $cb->{$type};
}
# Trigger _error callback, if set
workspace => sub { say "Workspaces changed" }
);
- if ($i3->subscribe(\%callbacks)->recv->{success})
+ if ($i3->subscribe(\%callbacks)->recv->{success}) {
say "Successfully subscribed";
}
return if defined($self->{ipchdl});
- $self->connect->recv or die "Unable to connect to i3"
+ $self->connect->recv or die "Unable to connect to i3 (socket path " . $self->{path} . ")";
}
=head2 get_workspaces
$self->message(TYPE_GET_OUTPUTS)
}
+=head2 get_tree
+
+Gets the layout tree from i3 (>= v4.0).
+
+ my $tree = i3->get_tree->recv;
+ say Dumper($tree);
+
+=cut
+sub get_tree {
+ my ($self) = @_;
+
+ $self->_ensure_connection;
+
+ $self->message(TYPE_GET_TREE)
+}
+
+=head2 get_marks
+
+Gets all the window identifier marks from i3 (>= v4.1).
+
+ my $marks = i3->get_marks->recv;
+ say Dumper($marks);
+
+=cut
+sub get_marks {
+ my ($self) = @_;
+
+ $self->_ensure_connection;
+
+ $self->message(TYPE_GET_MARKS)
+}
+
+=head2 get_bar_config
+
+Gets the bar configuration for the specific bar id from i3 (>= v4.1).
+
+ my $config = i3->get_bar_config($id)->recv;
+ say Dumper($config);
+
+=cut
+sub get_bar_config {
+ my ($self, $id) = @_;
+
+ $self->_ensure_connection;
+
+ $self->message(TYPE_GET_BAR_CONFIG, $id)
+}
+
+=head2 get_version
+
+Gets the i3 version via IPC, with a fall-back that parses the output of i3
+--version (for i3 < v4.3).
+
+ my $version = i3->get_version()->recv;
+ say "major: " . $version->{major} . ", minor = " . $version->{minor};
+
+=cut
+sub get_version {
+ my ($self) = @_;
+
+ $self->_ensure_connection;
+
+ my $cv = AnyEvent->condvar;
+
+ my $version_cv = $self->message(TYPE_GET_VERSION);
+ my $timeout;
+ $timeout = AnyEvent->timer(
+ after => 1,
+ cb => sub {
+ warn "Falling back to i3 --version since the running i3 doesn’t support GET_VERSION yet.";
+ my $version = _call_i3('--version');
+ $version =~ s/^i3 version //;
+ my $patch = 0;
+ my ($major, $minor) = ($version =~ /^([0-9]+)\.([0-9]+)/);
+ if ($version =~ /^[0-9]+\.[0-9]+\.([0-9]+)/) {
+ $patch = $1;
+ }
+ # Strip everything from the © sign on.
+ $version =~ s/ ©.*$//g;
+ $cv->send({
+ major => int($major),
+ minor => int($minor),
+ patch => int($patch),
+ human_readable => $version,
+ });
+ undef $timeout;
+ },
+ );
+ $version_cv->cb(sub {
+ undef $timeout;
+ $cv->send($version_cv->recv);
+ });
+
+ return $cv;
+}
+
=head2 command($content)
Makes i3 execute the given command
=head1 AUTHOR
-Michael Stapelberg, C<< <michael at stapelberg.de> >>
+Michael Stapelberg, C<< <michael at i3wm.org> >>
=head1 BUGS
=item * The i3 window manager website
-L<http://i3.zekjur.net/>
+L<http://i3wm.org>
=back
=head1 LICENSE AND COPYRIGHT
-Copyright 2010 Michael Stapelberg.
+Copyright 2010-2012 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
projects / i3 / i3 / blobdiff