--- rxvt-unicode/src/perl/background 2012/10/23 21:08:27 1.80 +++ rxvt-unicode/src/perl/background 2022/11/29 04:44:27 1.106 @@ -1,8 +1,20 @@ #! perl -#:META:X_RESOURCE:%.expr:string:background expression -#:META:X_RESOURCE:%.border:boolean:respect the terminal border -#:META:X_RESOURCE:%.interval:seconds:minimum time between updates +#:META:RESOURCE:%.expr:string:background expression +#:META:RESOURCE:%.border:boolean:respect the terminal border +#:META:RESOURCE:%.interval:seconds:minimum time between updates +#:META:RESOURCE:pixmap:file[;geom]:set image as background +#:META:RESOURCE:backgroundPixmap:file[;geom]:set image as background +#:META:RESOURCE:tr:boolean:set root pixmap as background +#:META:RESOURCE:transparent:boolean:set root pixmap as background +#:META:RESOURCE:tint:color:tint background with color +#:META:RESOURCE:tintColor:color:tint background with color +#:META:RESOURCE:sh:number:shade background by number % +#:META:RESOURCE:shading:number:shade background by number % +#:META:RESOURCE:blr:HxV:gaussian-blur background with radii +#:META:RESOURCE:blurRadius:HxV:gaussian-blur background with radii +#:META:OSC:20:change/query background image +#:META:OSC:705:change transparent background tint colour =head1 NAME @@ -16,8 +28,8 @@ =head1 QUICK AND DIRTY CHEAT SHEET -Just load a random jpeg image and tile the background with it without -scaling or anything else: +Load a random jpeg image and tile the background with it without scaling +or anything else: load "/path/to/img.jpg" @@ -46,8 +58,8 @@ It does so by evaluating a Perl expression that I the image on the fly, for example, by grabbing the root background or loading a file. -While the full power of Perl is available, the operators have been design -to be as simple as possible. +While the full power of Perl is available, the operators have been +designed to be as simple as possible. For example, to load an image and scale it to the window size, you would use: @@ -56,7 +68,7 @@ Or specified as a X resource: - URxvt.background-expr: scale keep { load "/path/to/mybg.png" } + URxvt.background.expr: scale keep { load "/path/to/mybg.png" } =head1 THEORY OF OPERATION @@ -134,7 +146,7 @@ scale 2, load "$HOME/mypic.png" This enlarges the image by a factor of 2 (200%). As you can see, C -has now two arguments, the C<200> and the C expression, while +has now two arguments, the C<2> and the C expression, while C only has one argument. Arguments are separated from each other by commas. @@ -251,7 +263,7 @@ =head2 COMMAND LINE SWITCHES -=over 4 +=over =item --background-expr perl-expression @@ -281,7 +293,7 @@ our %_IMG_CACHE; our $HOME; our ($self, $frame); -our ($x, $y, $w, $h); +our ($x, $y, $w, $h, $focus); # enforce at least this interval between updates our $MIN_INTERVAL = 6/59.951; @@ -302,7 +314,7 @@ from the root screen or by simply generating it. They are used as starting points to get an image you can play with. -=over 4 +=over =item load $path @@ -310,7 +322,7 @@ mode. If the image is already in memory (e.g. because another terminal instance -uses it), then the in-memory copy us returned instead. +uses it), then the in-memory copy is returned instead. =item load_uc $path @@ -431,7 +443,7 @@ The following operators modify the tiling mode of an image, that is, the way that pixels outside the image area are painted when the image is used. -=over 4 +=over =item tile $img @@ -516,7 +528,7 @@ example using C (terminal width) means your expression is evaluated again when the terminal is resized. -=over 4 +=over =item TX @@ -526,7 +538,7 @@ window is the full window by default, and the character area only when in border-respect mode). -Using these functions make your expression sensitive to window moves. +Using these functions makes your expression sensitive to window moves. These functions are mainly useful to align images to the root window. @@ -543,7 +555,7 @@ terminal window is the full window by default, and the character area only when in border-respect mode). -Using these functions make your expression sensitive to window resizes. +Using these functions makes your expression sensitive to window resizes. These functions are mainly useful to scale images, or to clip images to the window size to conserve memory. @@ -553,12 +565,29 @@ clip move -TX, -TY, keep { blur 5, root } +=item FOCUS + +Returns a boolean indicating whether the terminal window has keyboard +focus, in which case it returns true. + +Using this function makes your expression sensitive to focus changes. + +A common use case is to fade the background image when the terminal loses +focus, often together with the C<-fade> command line option. In fact, +there is a special function for just that use case: C. + +Example: use two entirely different background images, depending on +whether the window has focus. + + FOCUS ? keep { load "has_focus.jpg" } : keep { load "no_focus.jpg" } + =cut - sub TX() { $frame->[FR_AGAIN]{position} = 1; $x } - sub TY() { $frame->[FR_AGAIN]{position} = 1; $y } - sub TW() { $frame->[FR_AGAIN]{size} = 1; $w } - sub TH() { $frame->[FR_AGAIN]{size} = 1; $h } + sub TX () { $frame->[FR_AGAIN]{position} = 1; $x } + sub TY () { $frame->[FR_AGAIN]{position} = 1; $y } + sub TW () { $frame->[FR_AGAIN]{size} = 1; $w } + sub TH () { $frame->[FR_AGAIN]{size} = 1; $h } + sub FOCUS() { $frame->[FR_AGAIN]{focus} = 1; $focus } =item now @@ -602,7 +631,7 @@ The following operators modify the shape, size or position of the image. -=over 4 +=over =item clip $img @@ -643,7 +672,7 @@ Scales the image by the given factors in horizontal (C<$width>) and vertical (C<$height>) direction. -If only one factor is give, it is used for both directions. +If only one factor is given, it is used for both directions. If no factors are given, scales the image to the window size without keeping aspect. @@ -778,7 +807,7 @@ Rotates the image clockwise by C<$degrees> degrees, around the point at C<$center_x> and C<$center_y> (specified as factor of image width/height). -Example: rotate the image by 90 degrees around it's center. +Example: rotate the image by 90 degrees around its center. rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" } @@ -799,7 +828,7 @@ The following operators change the pixels of the image. -=over 4 +=over =item tint $color, $img @@ -819,6 +848,16 @@ $_[1]->tint ($_[0]) } +=item shade $factor, $img + +Shade the image by the given factor. + +=cut + + sub shade($$) { + $_[1]->shade ($_[0]) + } + =item contrast $factor, $img =item contrast $r, $g, $b, $img @@ -924,6 +963,39 @@ $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) } +=item focus_fade $img + +=item focus_fade $factor, $img + +=item focus_fade $factor, $color, $img + +Fades the image by the given factor (and colour) when focus is lost (the +same as the C<-fade>/C<-fadecolor> command line options, which also supply +the default values for C and C<$color>. Unlike with C<-fade>, the +C<$factor> is a real value, not a percentage value (that is, 0..1, not +0..100). + +Example: do the right thing when focus fading is requested. + + focus_fade load "mybg.jpg"; + +=cut + + sub focus_fade($;$$) { + my $img = pop; + + return $img + if FOCUS; + + my $fade = @_ >= 1 ? $_[0] : defined $self->resource ("fade") ? $self->resource ("fade") * 0.01 : 0; + my $color = @_ >= 2 ? $_[1] : $self->resource ("color+" . &urxvt::Color_fade ()); # Color_fade not always available + + $img = $img->tint ($color) if $color ne "rgb:00/00/00"; + $img = $img->muladd (1 - $fade, 0) if $fade; + + $img + } + =back =head2 OTHER STUFF @@ -931,7 +1003,7 @@ Anything that didn't fit any of the other categories, even after applying force and closing our eyes. -=over 4 +=over =item keep { ... } @@ -964,6 +1036,154 @@ is sensitive to some event (root background changes, window geometry changes), then it will be reevaluated automatically as needed. +=back + +=head1 OLD BACKGROUND IMAGE SETTINGS + +This extension also provides support for the old options/resources and +OSC sequences for setting a background image. These settings are +B and will be removed in future versions. + +=head2 OPTIONS AND RESOURCES + +=over + +=item B<-pixmap> I + +=item B I + +Use the specified image file as the window's background and also +optionally specify a colon separated list of operations to modify it. +Note that you may need to quote the C<;> character when using the +command line option, as C<;> is usually a metacharacter in shells. +Supported operations are: + +=over + +=item B + +sets scale and position. B<"W" / "H"> specify the horizontal/vertical +scale (percent), and B<"X" / "Y"> locate the image centre (percent). A +scale of 0 disables scaling. + +=item B + +enables tiling + +=item B + +maintain the image aspect ratio when scaling + +=item B + +use the position of the terminal window relative to the root window as +the image offset, simulating a root window background + +=back + +The default scale and position setting is C<100x100+50+50>. +Alternatively, a predefined set of templates can be used to achieve +the most common setups: + +=over + +=item B + +the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile + +=item B + +the image is scaled to fill the whole window maintaining the aspect +ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect + +=item B + +the image is scaled to fill the whole window. Equivalent to 100x100 + +=item B + +the image is centered with no scaling. Equivalent to 0x0+50+50 + +=item B + +the image is tiled with no scaling and using 'root' positioning. +Equivalent to 0x0:op=tile:op=root-align + +=back + +If multiple templates are specified the last one wins. Note that a +template overrides all the scale, position and operations settings. + +If used in conjunction with pseudo-transparency, the specified image +will be blended over the transparent background using alpha-blending. + +=item B<-tr>|B<+tr> + +=item B I + +Turn on/off pseudo-transparency by using the root pixmap as background. + +=item B<-tint> I + +=item B I + +Tint the transparent background with the given colour. Note that a +black tint yields a completely black image while a white tint yields +the image unchanged. + +=item B<-sh> I + +=item B I + +Darken (0 .. 99) or lighten (101 .. 200) the transparent background. +A value of 100 means no shading. + +=item B<-blr> I + +=item B I + +Apply gaussian blur with the specified radius to the transparent +background. If a single number is specified, the vertical and +horizontal radii are considered to be the same. Setting one of the +radii to 1 and the other to a large number creates interesting effects +on some backgrounds. The maximum radius value is 128. An horizontal or +vertical radius of 0 disables blurring. + +=back + +=head2 OSC sequences + +This extension will react to the following OSC sequences. Note that +this extension will not be autoloaded when these are used currently, +so to make urxvt recognize them, you have to enable the C +extension. One way to achieve that is to use the C<--background-expr ''> +command line argument or by specifying an empty C> +resource. + +=over + +=item B<< C >> Change transparent background tint colour to B<< C >>. + +=item B<< C >> Change/Query background image +parameters: the value of B<< C >> can be one of the following +commands: + +=over + +=item B<< C >> + +display scale and position in the title + +=item B<< C<;WxH+X+Y> >> + +change scale and/or position + +=item B<< C >> + +change background image + +=back + =cut sub keep(&) { @@ -1005,13 +1225,23 @@ } sub parse_expr { - my $expr = eval - "sub {\n" - . "package urxvt::bgdsl;\n" - . "#line 0 'background expression'\n" - . "$_[0]\n" - . "}"; - die if $@; + my ($expr) = @_; + + # an empty expression is valid and represents the default background + if ($expr !~ /\S/) { + $expr = sub { + undef + }; + } else { + $expr = eval + "sub {\n" + . "package urxvt::bgdsl;\n" + . "#line 0 'background expression'\n" + . "$expr\n" + . "}"; + die if $@; + } + $expr } @@ -1070,6 +1300,12 @@ } else { delete $state->{rootpmap}; } + + if ($again->{focus}) { + $state->{focus} = $self->on (focus_in => $cb, focus_out => $cb); + } else { + delete $state->{focus}; + } } # evaluate the current bg expression @@ -1087,6 +1323,11 @@ $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; + unless ($arg_self->has_render) { + warn "background extension needs RENDER extension 0.11 or higher, ignoring background-expr.\n"; + return; + } + # set environment to evaluate user expression local $self = $arg_self; @@ -1094,51 +1335,276 @@ local $frame = $self->{root}; ($x, $y, $w, $h) = $self->background_geometry ($self->{border}); + $focus = $self->focus; # evaluate user expression my @img = eval { $self->{expr}->() }; die $@ if $@; die "background-expr did not return anything.\n" unless @img; - die "background-expr: expected image(s), got something else.\n" - if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img; - my $img = urxvt::bgdsl::merge @img; + if ($img[0]) { + die "background-expr: expected image(s), got something else.\n" + if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img; + + my $img = urxvt::bgdsl::merge @img; - $frame->[FR_AGAIN]{size} = 1 - if $img->repeat_mode != urxvt::RepeatNormal; + $frame->[urxvt::bgdsl::FR_AGAIN]{size} = 1 + if $img->repeat_mode != urxvt::RepeatNormal; - # if the expression is sensitive to external events, prepare reevaluation then - $self->compile_frame ($frame, sub { $arg_self->recalculate }); + # if the expression is sensitive to external events, prepare reevaluation then + $self->compile_frame ($frame, sub { $arg_self->recalculate }); - # clear stuff we no longer need + # clear stuff we no longer need # unless (%{ $frame->[FR_STATE] }) { # delete $self->{state}; # delete $self->{expr}; # } - # set background pixmap + # set background pixmap - $self->set_background ($img, $self->{border}); - $self->scr_recolour (0); + $self->set_background ($img, $self->{border}); + } else { + $self->clr_background; + } + + $self->scr_recolor (0); $self->want_refresh; } -sub on_start { +sub old_bg_opts { + my ($self, $arg) = @_; + + $arg or return; + + my @str = split /;/, $arg; + + return unless $str[0] or $self->{bg_opts}->{path}; + + my $bg_opts = $self->{bg_opts}; + + if ($str[0]) { + $bg_opts->{tile} = 0; + $bg_opts->{keep_aspect} = 0; + $bg_opts->{root_align} = 0; + $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100; + $bg_opts->{h_align} = $bg_opts->{v_align} = 50; + $bg_opts->{path} = $str[0]; + } + + my @oplist = split /:/, $str[1]; + + for (@oplist) { + if (/style=tiled/i) { + $bg_opts->{tile} = 1; + $bg_opts->{keep_aspect} = 0; + $bg_opts->{root_align} = 0; + $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0; + $bg_opts->{h_align} = $bg_opts->{v_align} = 0; + } elsif (/style=aspect-stretched/i) { + $bg_opts->{tile} = 0; + $bg_opts->{keep_aspect} = 1; + $bg_opts->{root_align} = 0; + $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100; + $bg_opts->{h_align} = $bg_opts->{v_align} = 50; + } elsif (/style=stretched/i) { + $bg_opts->{tile} = 0; + $bg_opts->{keep_aspect} = 0; + $bg_opts->{root_align} = 0; + $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100; + $bg_opts->{h_align} = $bg_opts->{v_align} = 50; + } elsif (/style=centered/i) { + $bg_opts->{tile} = 0; + $bg_opts->{keep_aspect} = 0; + $bg_opts->{root_align} = 0; + $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0; + $bg_opts->{h_align} = $bg_opts->{v_align} = 50; + } elsif (/style=root-tiled/i) { + $bg_opts->{tile} = 1; + $bg_opts->{keep_aspect} = 0; + $bg_opts->{root_align} = 1; + $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0; + $bg_opts->{h_align} = $bg_opts->{v_align} = 0; + } elsif (/op=tile/i) { + $bg_opts->{tile} = 1; + } elsif (/op=keep-aspect/i) { + $bg_opts->{keep_aspect} = 1; + } elsif (/op=root-align/i) { + $bg_opts->{root_align} = 1; + } elsif (/^ =? ([0-9]+)? (?:[xX] ([0-9]+))? ([+-][0-9]+)? ([+-][0-9]+)? $/x) { + my ($w, $h, $x, $y) = ($1, $2, $3, $4); + + if ($str[0]) { + $w = $h unless defined $w; + $h = $w unless defined $h; + $y = $x unless defined $y; + } + + $bg_opts->{h_scale} = $w if defined $w; + $bg_opts->{v_scale} = $h if defined $h; + $bg_opts->{h_align} = $x if defined $x; + $bg_opts->{v_align} = $y if defined $y; + } + } +} + +# helper function, quote string as perl without allowing +# any code execution or other shenanigans. does not +# support binary NULs in string. +sub q0 { + (my $str = shift) =~ s/\x00//g; # make sure there really aren't any embedded NULs + "q\x00\Q$str\E\x00" +} + +sub old_bg_expr { my ($self) = @_; - my $expr = $self->x_resource ("%.expr") - or return; + my $expr; + + my $bg_opts = $self->{bg_opts}; + + if ($bg_opts->{root} =~ /^\s*(?:true|yes|on|1)\s*$/i) { + $expr .= "tile ("; - $self->has_render - or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n"; + my $shade = $bg_opts->{shade}; + + if ($shade) { + $shade = List::Util::min $shade, 200; + $shade = List::Util::max $shade, -100; + $shade = 200 - (100 + $shade) if $shade < 0; + + $shade = $shade * 0.01 - 1; + $expr .= "shade $shade, "; + } + + my $tint = $bg_opts->{tint}; + + if ($tint) { + $tint = q0 $tint; + $expr .= "tint $tint,"; + } + + my $blur = $bg_opts->{blur}; + + if ($blur and $blur =~ /^ =? ([0-9]+)? (?:[xX] ([0-9]+))? $/x) { + my $hr = defined $1 ? $1 : 1; + my $vr = defined $2 ? $2 : $hr; + + if ($hr != 0 and $vr != 0) { + $expr .= "blur $hr, $vr, "; + } + } + + $expr .= "rootalign root)"; + } + + if ($bg_opts->{path}) { + my $file_expr; + my $h_scale = $bg_opts->{h_scale} * 0.01; + my $v_scale = $bg_opts->{v_scale} * 0.01; + my $h_align = $bg_opts->{h_align} * 0.01; + my $v_align = $bg_opts->{v_align} * 0.01; + + if (!$bg_opts->{tile}) { + $file_expr .= "pad ("; + } else { + $file_expr .= "tile ("; + } + + if ($bg_opts->{root_align}) { + $file_expr .= "rootalign "; + } else { + $file_expr .= "align $h_align, $v_align, "; + } + + if ($h_scale != 0 and $v_scale != 0) { + my $op = $bg_opts->{keep_aspect} ? "fit" : "resize"; + $file_expr .= "$op TW * $h_scale, TH * $v_scale, "; + } + + my $path = q0 $bg_opts->{path}; + + $file_expr .= "keep { load $path })"; + + if ($expr) { + $expr .= ", tint (\"[50]white\", $file_expr)"; + } else { + $expr = $file_expr; + } + } + + $expr +} + +sub find_resource { + my ($self, $res, $opt) = @_; + + my $v = $self->x_resource ($opt); + $v = $self->x_resource ($res) unless defined $v; + + $v +} + +sub parse_bgopts { + my ($self) = @_; + + my $expr = $self->x_resource ("%.expr"); + + if (!$expr) { + $self->{bg_opts} = { h_scale => 100, v_scale => 100, + h_align => 50, v_align => 50 }; + + $self->{bg_opts}{shade} = $self->find_resource ("shading", "sh"); + $self->{bg_opts}{tint} = $self->find_resource ("tintColor", "tint"); + $self->{bg_opts}{blur} = $self->find_resource ("blurRadius", "blr"); + $self->{bg_opts}{root} = $self->find_resource ("transparent", "tr"); + + $self->old_bg_opts ($self->find_resource ("backgroundPixmap", "pixmap")); + $expr = $self->old_bg_expr; + } $self->set_expr (parse_expr $expr); $self->{border} = $self->x_resource_boolean ("%.border"); $MIN_INTERVAL = $self->x_resource ("%.interval"); +} + +sub on_start { + my ($self) = @_; + + $self->parse_bgopts; () } +sub on_osc_seq { + my ($self, $op, $arg) = @_; + + $op eq "20" or $op eq "706" + or return; + + $self->{bg_opts} + or $self->parse_bgopts; + + if ($op eq "20") { + if ($arg eq "?") { + my $h_scale = $self->{bg_opts}{h_scale}; + my $v_scale = $self->{bg_opts}{v_scale}; + my $h_align = $self->{bg_opts}{h_align}; + my $v_align = $self->{bg_opts}{v_align}; + $self->cmd_parse ("\033]2;[${h_scale}x${v_scale}+${h_align}+${v_align}]\007"); + } else { + $self->old_bg_opts ($arg); + my $expr = $self->old_bg_expr; + $self->set_expr (parse_expr $expr) if $expr; + } + } elsif ($op eq "705") { + $self->{bg_opts}{tint} = $arg; + my $expr = $self->old_bg_expr; + $self->set_expr (parse_expr $expr) if $expr; + } + + 1 +} +