2 # vim:ts=4:sw=4:expandtab
3 use strict; use warnings;
5 use File::Temp qw(tmpnam tempfile tempdir);
11 use List::Util qw(first);
12 use Time::HiRes qw(sleep);
14 use Scalar::Util qw(blessed);
45 my $tester = Test::Builder->new();
46 my $_cached_socket_path = undef;
47 my $_sync_window = undef;
48 my $tmp_socket_path = undef;
55 return $window_count++;
63 my $test_more_args = @_ ? "qw(@_)" : "";
67 use Test::More $test_more_args;
70 use Time::HiRes qw(sleep);
72 $tester->bail_out("$@") if $@;
73 feature->import(":5.10");
77 $x ||= i3test::X11->new;
79 goto \&Exporter::import;
83 # Waits for the next event and calls the given callback for every event to
84 # determine if this is the event we are waiting for.
86 # Can be used to wait until a window is mapped, until a ClientMessage is
89 # wait_for_event $x, 0.25, sub { $_[0]->{response_type} == MAP_NOTIFY };
92 my ($timeout, $cb) = @_;
98 # unfortunately, there is no constant for this
101 my $guard = AE::io $x->get_file_descriptor, $ae_read, sub {
102 while (defined(my $event = $x->poll_for_event)) {
110 # Trigger timeout after $timeout seconds (can be fractional)
111 my $t = AE::timer $timeout, 0, sub { warn "timeout ($timeout secs)"; $cv->send(0) };
113 my $result = $cv->recv;
119 # thin wrapper around wait_for_event which waits for MAP_NOTIFY
120 # make sure to include 'structure_notify' in the window’s event_mask attribute
123 my $id = (blessed($win) && $win->isa('X11::XCB::Window')) ? $win->id : $win;
124 wait_for_event 2, sub {
125 $_[0]->{response_type} == MAP_NOTIFY and $_[0]->{window} == $id
129 # Wrapper around wait_for_event which waits for UNMAP_NOTIFY. Also calls
130 # sync_with_i3 to make sure i3 also picked up and processed the UnmapNotify
134 # my $id = (blessed($win) && $win->isa('X11::XCB::Window')) ? $win->id : $win;
135 wait_for_event 2, sub {
136 $_[0]->{response_type} == UNMAP_NOTIFY # and $_[0]->{window} == $id
142 # Opens a new window (see X11::XCB::Window), maps it, waits until it got mapped
143 # and synchronizes with i3.
145 # set dont_map to a true value to avoid mapping
147 # if you want to change aspects of your window before it would be mapped,
148 # set before_map to a coderef. $window gets passed as $_ and as first argument.
150 # if you set both dont_map and before_map, the coderef will be called nevertheless
154 # class => WINDOW_CLASS_INPUT_OUTPUT
155 # rect => [ 0, 0, 30, 30 ]
156 # background_color => '#c0c0c0'
157 # event_mask => [ 'structure_notify' ]
158 # name => 'Window <n>'
161 my %args = @_ == 1 ? %{$_[0]} : @_;
163 my $dont_map = delete $args{dont_map};
164 my $before_map = delete $args{before_map};
166 $args{class} //= WINDOW_CLASS_INPUT_OUTPUT;
167 $args{rect} //= [ 0, 0, 30, 30 ];
168 $args{background_color} //= '#c0c0c0';
169 $args{event_mask} //= [ 'structure_notify' ];
170 $args{name} //= 'Window ' . counter_window();
172 my $window = $x->root->create_child(%args);
175 # TODO: investigate why _create is not needed
177 $before_map->($window) for $window;
180 return $window if $dont_map;
183 wait_for_map($window);
187 # Thin wrapper around open_window which sets window_type to
188 # _NET_WM_WINDOW_TYPE_UTILITY to make the window floating.
189 sub open_floating_window {
190 my %args = @_ == 1 ? %{$_[0]} : @_;
192 $args{window_type} = $x->atom(name => '_NET_WM_WINDOW_TYPE_UTILITY');
194 return open_window(\%args);
200 my $reply = $i3->command('open')->recv;
204 sub get_workspace_names {
205 my $i3 = i3(get_socket_path());
206 my $tree = $i3->get_tree->recv;
207 my @outputs = @{$tree->{nodes}};
209 for my $output (@outputs) {
210 # get the first CT_CON of each output
211 my $content = first { $_->{type} == 2 } @{$output->{nodes}};
212 @cons = (@cons, @{$content->{nodes}});
214 [ map { $_->{name} } @cons ]
217 sub get_unused_workspace {
218 my @names = get_workspace_names();
220 do { $tmp = tmpnam() } while ($tmp ~~ @names);
224 sub fresh_workspace {
225 my $unused = get_unused_workspace;
226 cmd("workspace $unused");
232 my $i3 = i3(get_socket_path());
233 my $tree = $i3->get_tree->recv;
235 my @outputs = @{$tree->{nodes}};
237 for my $output (@outputs) {
238 # get the first CT_CON of each output
239 my $content = first { $_->{type} == 2 } @{$output->{nodes}};
240 @workspaces = (@workspaces, @{$content->{nodes}});
243 # as there can only be one workspace with this name, we can safely
244 # return the first entry
245 return first { $_->{name} eq $name } @workspaces;
249 # returns the content (== tree, starting from the node of a workspace)
250 # of a workspace. If called in array context, also includes the focus
251 # stack of the workspace
255 my $con = get_ws($name);
256 return wantarray ? ($con->{nodes}, $con->{focus}) : $con->{nodes};
261 my $con = get_ws($ws);
263 my @focused = @{$con->{focus}};
265 while (@focused > 0) {
267 last unless defined($con->{focus});
268 @focused = @{$con->{focus}};
269 my @cons = grep { $_->{id} == $lf } (@{$con->{nodes}}, @{$con->{'floating_nodes'}});
276 sub get_dock_clients {
279 my $tree = i3(get_socket_path())->get_tree->recv;
280 my @outputs = @{$tree->{nodes}};
281 # Children of all dockareas
283 for my $output (@outputs) {
284 if (!defined($which)) {
285 @docked = (@docked, map { @{$_->{nodes}} }
286 grep { $_->{type} == 5 }
287 @{$output->{nodes}});
288 } elsif ($which eq 'top') {
289 my $first = first { $_->{type} == 5 } @{$output->{nodes}};
290 @docked = (@docked, @{$first->{nodes}});
291 } elsif ($which eq 'bottom') {
292 my @matching = grep { $_->{type} == 5 } @{$output->{nodes}};
293 my $last = $matching[-1];
294 @docked = (@docked, @{$last->{nodes}});
301 i3(get_socket_path())->command(@_)->recv
304 sub workspace_exists {
306 ($name ~~ @{get_workspace_names()})
310 my $i3 = i3(get_socket_path());
311 my $tree = $i3->get_tree->recv;
312 my @outputs = @{$tree->{nodes}};
314 for my $output (@outputs) {
315 # get the first CT_CON of each output
316 my $content = first { $_->{type} == 2 } @{$output->{nodes}};
317 my $first = first { $_->{fullscreen_mode} == 1 } @{$content->{nodes}};
318 return $first->{name}
323 # Sends an I3_SYNC ClientMessage with a random value to the root window.
324 # i3 will reply with the same value, but, due to the order of events it
325 # processes, only after all other events are done.
327 # This can be used to ensure the results of a cmd 'focus left' are pushed to
328 # X11 and that $x->input_focus returns the correct value afterwards.
330 # See also docs/testsuite for a long explanation
333 # Since we need a (mapped) window for receiving a ClientMessage, we create
334 # one on the first call of sync_with_i3. It will be re-used in all
336 if (!defined($_sync_window)) {
337 $_sync_window = open_window(
338 rect => [ -15, -15, 10, 10 ],
339 override_redirect => 1,
343 my $root = $x->get_root_window();
344 # Generate a random number to identify this particular ClientMessage.
345 my $myrnd = int(rand(255)) + 1;
347 # Generate a ClientMessage, see xcb_client_message_t
348 my $msg = pack "CCSLLLLLLL",
349 CLIENT_MESSAGE, # response_type
352 $root, # destination window
353 $x->atom(name => 'I3_SYNC')->id,
355 $_sync_window->id, # data[0]: our own window id
356 $myrnd, # data[1]: a random value to identify the request
361 # Send it to the root window -- since i3 uses the SubstructureRedirect
362 # event mask, it will get the ClientMessage.
363 $x->send_event(0, $root, EVENT_MASK_SUBSTRUCTURE_REDIRECT, $msg);
365 # now wait until the reply is here
366 return wait_for_event 2, sub {
369 return 0 unless $event->{response_type} == 161;
371 my ($win, $rnd) = unpack "LL", $event->{data};
372 return ($rnd == $myrnd);
377 my $tree = i3(get_socket_path())->get_tree->recv;
378 my @nodes = @{$tree->{nodes}};
379 my $ok = (@nodes > 0);
380 $tester->ok($ok, 'i3 still lives');
384 # Tries to exit i3 gracefully (with the 'exit' cmd) or kills the PID if that fails
385 sub exit_gracefully {
386 my ($pid, $socketpath) = @_;
387 $socketpath ||= get_socket_path();
391 say "Exiting i3 cleanly...";
392 i3($socketpath)->command('exit')->recv;
397 kill(9, $pid) or die "could not kill i3";
400 if ($socketpath =~ m,^/tmp/i3-test-socket-,) {
405 # Gets the socket path from the I3_SOCKET_PATH atom stored on the X11 root window
406 sub get_socket_path {
410 if ($cache && defined($_cached_socket_path)) {
411 return $_cached_socket_path;
414 my $atom = $x->atom(name => 'I3_SOCKET_PATH');
415 my $cookie = $x->get_property(0, $x->get_root_window(), $atom->id, GET_PROPERTY_TYPE_ANY, 0, 256);
416 my $reply = $x->get_property_reply($cookie->{sequence});
417 my $socketpath = $reply->{value};
418 $_cached_socket_path = $socketpath;
423 # launches a new i3 process with the given string as configuration file.
424 # useful for tests which test specific config file directives.
426 # be sure to use !NO_I3_INSTANCE! somewhere in the file to signal
427 # complete-run.pl that it should not create an instance of i3
429 sub launch_with_config {
430 my ($config, $dont_add_socket_path) = @_;
432 $dont_add_socket_path //= 0;
434 if (!defined($tmp_socket_path)) {
435 $tmp_socket_path = File::Temp::tempnam('/tmp', 'i3-test-socket-');
438 my ($fh, $tmpfile) = tempfile('/tmp/i3-test-config-XXXXX', UNLINK => 1);
440 say $fh "ipc-socket $tmp_socket_path" unless $dont_add_socket_path;
443 my $cv = AnyEvent->condvar;
444 my $pid = activate_i3(
445 unix_socket_path => "$tmp_socket_path-activation",
446 display => $ENV{DISPLAY},
447 configfile => $tmpfile,
448 outdir => $ENV{OUTDIR},
449 testname => $ENV{TESTNAME},
450 valgrind => $ENV{VALGRIND},
451 strace => $ENV{STRACE},
455 # blockingly wait until i3 is ready
458 # force update of the cached socket path in lib/i3test
465 use parent 'X11::XCB::Connection';
469 i3test::sync_with_i3();
471 return $self->SUPER::input_focus(@_);