ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/perl/background
(Generate patch)

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.71 by root, Mon Jul 2 01:40:41 2012 UTC vs.
Revision 1.94 by root, Tue Sep 17 17:15:29 2019 UTC

1#! perl 1#! perl
2 2
3#:META:X_RESOURCE:%.expr:string:background expression 3#:META:RESOURCE:%.expr:string:background expression
4#:META:X_RESOURCE:%.border:boolean:respect the terminal border 4#:META:RESOURCE:%.border:boolean:respect the terminal border
5#:META:X_RESOURCE:%.interval:seconds:minimum time between updates 5#:META:RESOURCE:%.interval:seconds:minimum time between updates
6#:META:RESOURCE:pixmap:file[;geom]:set image as background
7#:META:RESOURCE:backgroundPixmap:file[;geom]:set image as background
8#:META:RESOURCE:tr:boolean:set root pixmap as background
9#:META:RESOURCE:transparent:boolean:set root pixmap as background
10#:META:RESOURCE:tint:color:tint background with color
11#:META:RESOURCE:tintColor:color:tint background with color
12#:META:RESOURCE:sh:number:shade background by number %
13#:META:RESOURCE:shading:number:shade background by number %
14#:META:RESOURCE:blr:HxV:gaussian-blur background with radii
15#:META:RESOURCE:blurRadius:HxV:gaussian-blur background with radii
6 16
7=head1 NAME 17=head1 NAME
8 18
9 background - manage terminal background 19background - manage terminal background
10 20
11=head1 SYNOPSIS 21=head1 SYNOPSIS
12 22
13 urxvt --background-expr 'background expression' 23 urxvt --background-expr 'background expression'
14 --background-border 24 --background-border
15 --background-interval seconds 25 --background-interval seconds
16 26
27=head1 QUICK AND DIRTY CHEAT SHEET
28
29Just load a random jpeg image and tile the background with it without
30scaling or anything else:
31
32 load "/path/to/img.jpg"
33
34The same, but use mirroring/reflection instead of tiling:
35
36 mirror load "/path/to/img.jpg"
37
38Load an image and scale it to exactly fill the terminal window:
39
40 scale keep { load "/path/to/img.jpg" }
41
42Implement pseudo-transparency by using a suitably-aligned root pixmap
43as window background:
44
45 rootalign root
46
47Likewise, but keep a blurred copy:
48
49 rootalign keep { blur 10, root }
50
17=head1 DESCRIPTION 51=head1 DESCRIPTION
18 52
19This extension manages the terminal background by creating a picture that 53This extension manages the terminal background by creating a picture that
20is behind the text, replacing the normal background colour. 54is behind the text, replacing the normal background colour.
21 55
30 64
31 urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }' 65 urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }'
32 66
33Or specified as a X resource: 67Or specified as a X resource:
34 68
35 URxvt.background-expr: scale keep { load "/path/to/mybg.png" } 69 URxvt.background.expr: scale keep { load "/path/to/mybg.png" }
36 70
37=head1 THEORY OF OPERATION 71=head1 THEORY OF OPERATION
38 72
39At startup, just before the window is mapped for the first time, the 73At startup, just before the window is mapped for the first time, the
40expression is evaluated and must yield an image. The image is then 74expression is evaluated and must yield an image. The image is then
74 return load "$HOME/sunday.png"; 108 return load "$HOME/sunday.png";
75 } 109 }
76 } 110 }
77 111
78This inner expression is evaluated once per hour (and whenever the 112This inner expression is evaluated once per hour (and whenever the
79temrinal window is resized). It sets F<sunday.png> as background on 113terminal window is resized). It sets F<sunday.png> as background on
80Sundays, and F<weekday.png> on all other days. 114Sundays, and F<weekday.png> on all other days.
81 115
82Fortunately, we expect that most expressions will be much simpler, with 116Fortunately, we expect that most expressions will be much simpler, with
83little Perl knowledge needed. 117little Perl knowledge needed.
84 118
108get a percentage): 142get a percentage):
109 143
110 scale 2, load "$HOME/mypic.png" 144 scale 2, load "$HOME/mypic.png"
111 145
112This enlarges the image by a factor of 2 (200%). As you can see, C<scale> 146This enlarges the image by a factor of 2 (200%). As you can see, C<scale>
113has now two arguments, the C<200> and the C<load> expression, while 147has now two arguments, the C<2> and the C<load> expression, while
114C<load> only has one argument. Arguments are separated from each other by 148C<load> only has one argument. Arguments are separated from each other by
115commas. 149commas.
116 150
117Scale also accepts two arguments, which are then separate factors for both 151Scale also accepts two arguments, which are then separate factors for both
118horizontal and vertical dimensions. For example, this halves the image 152horizontal and vertical dimensions. For example, this halves the image
119width and doubles the image height: 153width and doubles the image height:
120 154
121 scale 0.5, 2, load "$HOME/mypic.png" 155 scale 0.5, 2, load "$HOME/mypic.png"
122 156
123IF you try out these expressions, you might suffer from some sluggishness, 157IF you try out these expressions, you might suffer from some sluggishness,
124because each time the terminal is resized, it loads the PNG image agin 158because each time the terminal is resized, it loads the PNG image again
125and scales it. Scaling is usually fast (and unavoidable), but loading the 159and scales it. Scaling is usually fast (and unavoidable), but loading the
126image can be quite time consuming. This is where C<keep> comes in handy: 160image can be quite time consuming. This is where C<keep> comes in handy:
127 161
128 scale 0.5, 2, keep { load "$HOME/mypic.png" } 162 scale 0.5, 2, keep { load "$HOME/mypic.png" }
129 163
159left corner of the terminal window)- the result is pseudo-transparency: 193left corner of the terminal window)- the result is pseudo-transparency:
160the image seems to be static while the window is moved around. 194the image seems to be static while the window is moved around.
161 195
162=head2 COLOUR SPECIFICATIONS 196=head2 COLOUR SPECIFICATIONS
163 197
164Whenever an oprator expects a "colour", then this can be specified in one 198Whenever an operator expects a "colour", then this can be specified in one
165of two ways: Either as string with an X11 colour specification, such as: 199of two ways: Either as string with an X11 colour specification, such as:
166 200
167 "red" # named colour 201 "red" # named colour
168 "#f00" # simple rgb 202 "#f00" # simple rgb
169 "[50]red" # red with 50% alpha 203 "[50]red" # red with 50% alpha
255=cut 289=cut
256 290
257our %_IMG_CACHE; 291our %_IMG_CACHE;
258our $HOME; 292our $HOME;
259our ($self, $frame); 293our ($self, $frame);
260our ($x, $y, $w, $h); 294our ($x, $y, $w, $h, $focus);
261 295
262# enforce at least this interval between updates 296# enforce at least this interval between updates
263our $MIN_INTERVAL = 6/59.951; 297our $MIN_INTERVAL = 6/59.951;
264 298
265{ 299{
284 318
285Loads the image at the given C<$path>. The image is set to plane tiling 319Loads the image at the given C<$path>. The image is set to plane tiling
286mode. 320mode.
287 321
288If the image is already in memory (e.g. because another terminal instance 322If the image is already in memory (e.g. because another terminal instance
289uses it), then the in-memory copy us returned instead. 323uses it), then the in-memory copy is returned instead.
290 324
291=item load_uc $path 325=item load_uc $path
292 326
293Load uncached - same as load, but does not cache the image, which means it 327Load uncached - same as load, but does not cache the image, which means it
294is I<always> loaded from the filesystem again. 328is I<always> loaded from the filesystem again, even if another copy of it
329is in memory at the time.
295 330
296=cut 331=cut
332
333 sub load_uc($) {
334 $self->new_img_from_file ($_[0])
335 }
297 336
298 sub load($) { 337 sub load($) {
299 my ($path) = @_; 338 my ($path) = @_;
300 339
301 $_IMG_CACHE{$path} || do { 340 $_IMG_CACHE{$path} || do {
302 my $img = $self->new_img_from_file ($path); 341 my $img = load_uc $path;
303 Scalar::Util::weaken ($_IMG_CACHE{$path} = $img); 342 Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
304 $img 343 $img
305 } 344 }
306 } 345 }
307 346
392 $base->draw ($_) 431 $base->draw ($_)
393 for @_; 432 for @_;
394 433
395 $base 434 $base
396 } 435 }
436
437=back
397 438
398=head2 TILING MODES 439=head2 TILING MODES
399 440
400The following operators modify the tiling mode of an image, that is, the 441The following operators modify the tiling mode of an image, that is, the
401way that pixels outside the image area are painted when the image is used. 442way that pixels outside the image area are painted when the image is used.
493 534
494Return the X and Y coordinates of the terminal window (the terminal 535Return the X and Y coordinates of the terminal window (the terminal
495window is the full window by default, and the character area only when in 536window is the full window by default, and the character area only when in
496border-respect mode). 537border-respect mode).
497 538
498Using these functions make your expression sensitive to window moves. 539Using these functions makes your expression sensitive to window moves.
499 540
500These functions are mainly useful to align images to the root window. 541These functions are mainly useful to align images to the root window.
501 542
502Example: load an image and align it so it looks as if anchored to the 543Example: load an image and align it so it looks as if anchored to the
503background (that's exactly what C<rootalign> does btw.): 544background (that's exactly what C<rootalign> does btw.):
504 545
505 move -TX, -TY, keep { load "mybg.png" } 546 move -TX, -TY, keep { load "mybg.png" }
506 547
507=item TW 548=item TW
549
550=item TH
508 551
509Return the width (C<TW>) and height (C<TH>) of the terminal window (the 552Return the width (C<TW>) and height (C<TH>) of the terminal window (the
510terminal window is the full window by default, and the character area only 553terminal window is the full window by default, and the character area only
511when in border-respect mode). 554when in border-respect mode).
512 555
513Using these functions make your expression sensitive to window resizes. 556Using these functions makes your expression sensitive to window resizes.
514 557
515These functions are mainly useful to scale images, or to clip images to 558These functions are mainly useful to scale images, or to clip images to
516the window size to conserve memory. 559the window size to conserve memory.
517 560
518Example: take the screen background, clip it to the window size, blur it a 561Example: take the screen background, clip it to the window size, blur it a
519bit, align it to the window position and use it as background. 562bit, align it to the window position and use it as background.
520 563
521 clip move -TX, -TY, keep { blur 5, root } 564 clip move -TX, -TY, keep { blur 5, root }
522 565
523=cut 566=item FOCUS
524 567
568Returns a boolean indicating whether the terminal window has keyboard
569focus, in which case it returns true.
570
571Using this function makes your expression sensitive to focus changes.
572
573A common use case is to fade the background image when the terminal loses
574focus, often together with the C<-fade> command line option. In fact,
575there is a special function for just that use case: C<focus_fade>.
576
577Example: use two entirely different background images, depending on
578whether the window has focus.
579
580 FOCUS ? keep { load "has_focus.jpg" } : keep { load "no_focus.jpg" }
581
582=cut
583
525 sub TX() { $frame->[FR_AGAIN]{position} = 1; $x } 584 sub TX () { $frame->[FR_AGAIN]{position} = 1; $x }
526 sub TY() { $frame->[FR_AGAIN]{position} = 1; $y } 585 sub TY () { $frame->[FR_AGAIN]{position} = 1; $y }
527 sub TW() { $frame->[FR_AGAIN]{size} = 1; $w } 586 sub TW () { $frame->[FR_AGAIN]{size} = 1; $w }
528 sub TH() { $frame->[FR_AGAIN]{size} = 1; $h } 587 sub TH () { $frame->[FR_AGAIN]{size} = 1; $h }
588 sub FOCUS() { $frame->[FR_AGAIN]{focus} = 1; $focus }
529 589
530=item now 590=item now
531 591
532Returns the current time as (fractional) seconds since the epoch. 592Returns the current time as (fractional) seconds since the epoch.
533 593
580Clips an image to the given rectangle. If the rectangle is outside the 640Clips an image to the given rectangle. If the rectangle is outside the
581image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is 641image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is
582larger than the image, then the tiling mode defines how the extra pixels 642larger than the image, then the tiling mode defines how the extra pixels
583will be filled. 643will be filled.
584 644
585If C<$x> an C<$y> are missing, then C<0> is assumed for both. 645If C<$x> and C<$y> are missing, then C<0> is assumed for both.
586 646
587If C<$width> and C<$height> are missing, then the window size will be 647If C<$width> and C<$height> are missing, then the window size will be
588assumed. 648assumed.
589 649
590Example: load an image, blur it, and clip it to the window size to save 650Example: load an image, blur it, and clip it to the window size to save
608=item scale $width_factor, $height_factor, $img 668=item scale $width_factor, $height_factor, $img
609 669
610Scales the image by the given factors in horizontal 670Scales the image by the given factors in horizontal
611(C<$width>) and vertical (C<$height>) direction. 671(C<$width>) and vertical (C<$height>) direction.
612 672
613If only one factor is give, it is used for both directions. 673If only one factor is given, it is used for both directions.
614 674
615If no factors are given, scales the image to the window size without 675If no factors are given, scales the image to the window size without
616keeping aspect. 676keeping aspect.
617 677
618=item resize $width, $height, $img 678=item resize $width, $height, $img
743=item rotate $center_x, $center_y, $degrees, $img 803=item rotate $center_x, $center_y, $degrees, $img
744 804
745Rotates the image clockwise by C<$degrees> degrees, around the point at 805Rotates the image clockwise by C<$degrees> degrees, around the point at
746C<$center_x> and C<$center_y> (specified as factor of image width/height). 806C<$center_x> and C<$center_y> (specified as factor of image width/height).
747 807
748Example: rotate the image by 90 degrees around it's center. 808Example: rotate the image by 90 degrees around its center.
749 809
750 rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" } 810 rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
751 811
752=cut 812=cut
753 813
784 844
785 sub tint($$) { 845 sub tint($$) {
786 $_[1]->tint ($_[0]) 846 $_[1]->tint ($_[0])
787 } 847 }
788 848
849=item shade $factor, $img
850
851Shade the image by the given factor.
852
853=cut
854
855 sub shade($$) {
856 $_[1]->shade ($_[0])
857 }
858
789=item contrast $factor, $img 859=item contrast $factor, $img
790 860
791=item contrast $r, $g, $b, $img 861=item contrast $r, $g, $b, $img
792 862
793=item contrast $r, $g, $b, $a, $img 863=item contrast $r, $g, $b, $a, $img
822latter in a white picture. 892latter in a white picture.
823 893
824Due to idiosyncrasies in the underlying XRender extension, biases less 894Due to idiosyncrasies in the underlying XRender extension, biases less
825than zero can be I<very> slow. 895than zero can be I<very> slow.
826 896
897You can also try the experimental(!) C<muladd> operator.
898
827=cut 899=cut
828 900
829 sub contrast($$;$$;$) { 901 sub contrast($$;$$;$) {
830 my $img = pop; 902 my $img = pop;
831 my ($r, $g, $b, $a) = @_; 903 my ($r, $g, $b, $a) = @_;
846 $a = 1 if @_ < 4; 918 $a = 1 if @_ < 4;
847 919
848 $img = $img->clone; 920 $img = $img->clone;
849 $img->brightness ($r, $g, $b, $a); 921 $img->brightness ($r, $g, $b, $a);
850 $img 922 $img
923 }
924
925=item muladd $mul, $add, $img # EXPERIMENTAL
926
927First multiplies the pixels by C<$mul>, then adds C<$add>. This can be used
928to implement brightness and contrast at the same time, with a wider value
929range than contrast and brightness operators.
930
931Due to numerous bugs in XRender implementations, it can also introduce a
932number of visual artifacts.
933
934Example: increase contrast by a factor of C<$c> without changing image
935brightness too much.
936
937 muladd $c, (1 - $c) * 0.5, $img
938
939=cut
940
941 sub muladd($$$) {
942 $_[2]->muladd ($_[0], $_[1])
851 } 943 }
852 944
853=item blur $radius, $img 945=item blur $radius, $img
854 946
855=item blur $radius_horz, $radius_vert, $img 947=item blur $radius_horz, $radius_vert, $img
865=cut 957=cut
866 958
867 sub blur($$;$) { 959 sub blur($$;$) {
868 my $img = pop; 960 my $img = pop;
869 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) 961 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
962 }
963
964=item focus_fade $img
965
966=item focus_fade $factor, $img
967
968=item focus_fade $factor, $color, $img
969
970Fades the image by the given factor (and colour) when focus is lost (the
971same as the C<-fade>/C<-fadecolor> command line options, which also supply
972the default values for C<factor> and C<$color>. Unlike with C<-fade>, the
973C<$factor> is a real value, not a percentage value (that is, 0..1, not
9740..100).
975
976Example: do the right thing when focus fading is requested.
977
978 focus_fade load "mybg.jpg";
979
980=cut
981
982 sub focus_fade($;$$) {
983 my $img = pop;
984
985 return $img
986 if FOCUS;
987
988 my $fade = @_ >= 1 ? $_[0] : defined $self->resource ("fade") ? $self->resource ("fade") * 0.01 : 0;
989 my $color = @_ >= 2 ? $_[1] : $self->resource ("color+" . urxvt::Color_fade);
990
991 $img = $img->tint ($color) if $color ne "rgb:00/00/00";
992 $img = $img->muladd (1 - $fade, 0) if $fade;
993
994 $img
870 } 995 }
871 996
872=back 997=back
873 998
874=head2 OTHER STUFF 999=head2 OTHER STUFF
900C<keep> block so it only is reevaluated as required. 1025C<keep> block so it only is reevaluated as required.
901 1026
902Putting the blur into a C<keep> block will make sure the blur is only done 1027Putting the blur into a C<keep> block will make sure the blur is only done
903once, while the C<rootalign> is still done each time the window moves. 1028once, while the C<rootalign> is still done each time the window moves.
904 1029
905 rootlign keep { blur 10, root } 1030 rootalign keep { blur 10, root }
906 1031
907This leaves the question of how to force reevaluation of the block, 1032This leaves the question of how to force reevaluation of the block,
908in case the root background changes: If expression inside the block 1033in case the root background changes: If expression inside the block
909is sensitive to some event (root background changes, window geometry 1034is sensitive to some event (root background changes, window geometry
910changes), then it will be reevaluated automatically as needed. 1035changes), then it will be reevaluated automatically as needed.
1036
1037=back
1038
1039=head1 OLD BACKGROUND IMAGE SETTINGS
1040
1041This extension also provides support for the old options/resources and
1042OSC sequences for setting a background image. These settings are
1043B<deprecated> and will be removed in future versions.
1044
1045=head2 OPTIONS AND RESOURCES
1046
1047=over 4
1048
1049=item B<-pixmap> I<file[;oplist]>
1050
1051=item B<backgroundPixmap:> I<file[;oplist]>
1052
1053Use the specified image file as the window's background and also
1054optionally specify a colon separated list of operations to modify it.
1055Note that you may need to quote the C<;> character when using the
1056command line option, as C<;> is usually a metacharacter in shells.
1057Supported operations are:
1058
1059=over 4
1060
1061=item B<WxH+X+Y>
1062
1063sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1064scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1065scale of 0 disables scaling.
1066
1067=item B<op=tile>
1068
1069enables tiling
1070
1071=item B<op=keep-aspect>
1072
1073maintain the image aspect ratio when scaling
1074
1075=item B<op=root-align>
1076
1077use the position of the terminal window relative to the root window as
1078the image offset, simulating a root window background
1079
1080=back
1081
1082The default scale and position setting is C<100x100+50+50>.
1083Alternatively, a predefined set of templates can be used to achieve
1084the most common setups:
1085
1086=over 4
1087
1088=item B<style=tiled>
1089
1090the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1091
1092=item B<style=aspect-stretched>
1093
1094the image is scaled to fill the whole window maintaining the aspect
1095ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1096
1097=item B<style=stretched>
1098
1099the image is scaled to fill the whole window. Equivalent to 100x100
1100
1101=item B<style=centered>
1102
1103the image is centered with no scaling. Equivalent to 0x0+50+50
1104
1105=item B<style=root-tiled>
1106
1107the image is tiled with no scaling and using 'root' positioning.
1108Equivalent to 0x0:op=tile:op=root-align
1109
1110=back
1111
1112If multiple templates are specified the last one wins. Note that a
1113template overrides all the scale, position and operations settings.
1114
1115If used in conjunction with pseudo-transparency, the specified image
1116will be blended over the transparent background using alpha-blending.
1117
1118=item B<-tr>|B<+tr>
1119
1120=item B<transparent:> I<boolean>
1121
1122Turn on/off pseudo-transparency by using the root pixmap as background.
1123
1124=item B<-tint> I<colour>
1125
1126=item B<tintColor:> I<colour>
1127
1128Tint the transparent background with the given colour. Note that a
1129black tint yields a completely black image while a white tint yields
1130the image unchanged.
1131
1132=item B<-sh> I<number>
1133
1134=item B<shading:> I<number>
1135
1136Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1137A value of 100 means no shading.
1138
1139=item B<-blr> I<HxV>
1140
1141=item B<blurRadius:> I<HxV>
1142
1143Apply gaussian blur with the specified radius to the transparent
1144background. If a single number is specified, the vertical and
1145horizontal radii are considered to be the same. Setting one of the
1146radii to 1 and the other to a large number creates interesting effects
1147on some backgrounds. The maximum radius value is 128. An horizontal or
1148vertical radius of 0 disables blurring.
1149
1150=back
1151
1152=head2 OSC sequences
1153
1154=over 4
1155
1156=item B<< C<ESC ] 705 ; Pt ST> >> Change transparent background tint colour to B<< C<Pt> >>.
1157
1158=item B<< C<ESC ] 20 ; Pt ST> >> Change/Query background image
1159parameters: the value of B<< C<Pt> >> can be one of the following
1160commands:
1161
1162=over 4
1163
1164=item B<< C<?> >>
1165
1166display scale and position in the title
1167
1168=item B<< C<;WxH+X+Y> >>
1169
1170change scale and/or position
1171
1172=item B<< C<FILE;WxH+X+Y> >>
1173
1174change background image
1175
1176=back
911 1177
912=cut 1178=cut
913 1179
914 sub keep(&) { 1180 sub keep(&) {
915 my $id = $_[0]+0; 1181 my $id = $_[0]+0;
962 1228
963# compiles a parsed expression 1229# compiles a parsed expression
964sub set_expr { 1230sub set_expr {
965 my ($self, $expr) = @_; 1231 my ($self, $expr) = @_;
966 1232
967 $self->{root} = []; 1233 $self->{root} = []; # the outermost frame
968 $self->{expr} = $expr; 1234 $self->{expr} = $expr;
969 $self->recalculate; 1235 $self->recalculate;
970} 1236}
971 1237
972# takes a hash of sensitivity indicators and installs watchers 1238# takes a hash of sensitivity indicators and installs watchers
1013 if ($again->{rootpmap}) { 1279 if ($again->{rootpmap}) {
1014 $state->{rootpmap} = $self->on (rootpmap_change => $cb); 1280 $state->{rootpmap} = $self->on (rootpmap_change => $cb);
1015 } else { 1281 } else {
1016 delete $state->{rootpmap}; 1282 delete $state->{rootpmap};
1017 } 1283 }
1284
1285 if ($again->{focus}) {
1286 $state->{focus} = $self->on (focus_in => $cb, focus_out => $cb);
1287 } else {
1288 delete $state->{focus};
1289 }
1018} 1290}
1019 1291
1020# evaluate the current bg expression 1292# evaluate the current bg expression
1021sub recalculate { 1293sub recalculate {
1022 my ($arg_self) = @_; 1294 my ($arg_self) = @_;
1034 1306
1035 # set environment to evaluate user expression 1307 # set environment to evaluate user expression
1036 1308
1037 local $self = $arg_self; 1309 local $self = $arg_self;
1038 local $HOME = $ENV{HOME}; 1310 local $HOME = $ENV{HOME};
1039 local $frame = []; 1311 local $frame = $self->{root};
1040 1312
1041 ($x, $y, $w, $h) = $self->background_geometry ($self->{border}); 1313 ($x, $y, $w, $h) = $self->background_geometry ($self->{border});
1314 $focus = $self->focus;
1042 1315
1043 # evaluate user expression 1316 # evaluate user expression
1044 1317
1045 my @img = eval { $self->{expr}->() }; 1318 my @img = eval { $self->{expr}->() };
1046 die $@ if $@; 1319 die $@ if $@;
1064# } 1337# }
1065 1338
1066 # set background pixmap 1339 # set background pixmap
1067 1340
1068 $self->set_background ($img, $self->{border}); 1341 $self->set_background ($img, $self->{border});
1069 $self->scr_recolour (0); 1342 $self->scr_recolor (0);
1070 $self->want_refresh; 1343 $self->want_refresh;
1071} 1344}
1072 1345
1346sub old_bg_opts {
1347 my ($self, $arg) = @_;
1348
1349 $arg or return;
1350
1351 my @str = split /;/, $arg;
1352
1353 return unless $str[0] or $self->{bg_opts}->{path};
1354
1355 my $bg_opts = $self->{bg_opts};
1356
1357 if ($str[0]) {
1358 $bg_opts->{tile} = 0;
1359 $bg_opts->{keep_aspect} = 0;
1360 $bg_opts->{root_align} = 0;
1361 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
1362 $bg_opts->{h_align} = $bg_opts->{v_align} = 50;
1363 $bg_opts->{path} = unpack "H*", $str[0];
1364 }
1365
1366 my @oplist = split /:/, $str[1];
1367
1368 for (@oplist) {
1369 if (/style=tiled/i) {
1370 $bg_opts->{tile} = 1;
1371 $bg_opts->{keep_aspect} = 0;
1372 $bg_opts->{root_align} = 0;
1373 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
1374 $bg_opts->{h_align} = $bg_opts->{v_align} = 0;
1375 } elsif (/style=aspect-stretched/i) {
1376 $bg_opts->{tile} = 0;
1377 $bg_opts->{keep_aspect} = 1;
1378 $bg_opts->{root_align} = 0;
1379 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
1380 $bg_opts->{h_align} = $bg_opts->{v_align} = 50;
1381 } elsif (/style=stretched/i) {
1382 $bg_opts->{tile} = 0;
1383 $bg_opts->{keep_aspect} = 0;
1384 $bg_opts->{root_align} = 0;
1385 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
1386 $bg_opts->{h_align} = $bg_opts->{v_align} = 50;
1387 } elsif (/style=centered/i) {
1388 $bg_opts->{tile} = 0;
1389 $bg_opts->{keep_aspect} = 0;
1390 $bg_opts->{root_align} = 0;
1391 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
1392 $bg_opts->{h_align} = $bg_opts->{v_align} = 50;
1393 } elsif (/style=root-tiled/i) {
1394 $bg_opts->{tile} = 1;
1395 $bg_opts->{keep_aspect} = 0;
1396 $bg_opts->{root_align} = 1;
1397 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
1398 $bg_opts->{h_align} = $bg_opts->{v_align} = 0;
1399 } elsif (/op=tile/i) {
1400 $bg_opts->{tile} = 1;
1401 } elsif (/op=keep-aspect/i) {
1402 $bg_opts->{keep_aspect} = 1;
1403 } elsif (/op=root-align/i) {
1404 $bg_opts->{root_align} = 1;
1405 } elsif (/^ =? ([0-9]+)? (?:[xX] ([0-9]+))? ([+-][0-9]+)? ([+-][0-9]+)? $/x) {
1406 my ($w, $h, $x, $y) = ($1, $2, $3, $4);
1407
1408 if ($str[0]) {
1409 $w = $h unless defined $w;
1410 $h = $w unless defined $h;
1411 $y = $x unless defined $y;
1412 }
1413
1414 $bg_opts->{h_scale} = $w if defined $w;
1415 $bg_opts->{v_scale} = $h if defined $h;
1416 $bg_opts->{h_align} = $x if defined $x;
1417 $bg_opts->{v_align} = $y if defined $y;
1418 }
1419 }
1420}
1421
1422sub old_bg_expr {
1423 my ($self) = @_;
1424
1425 my $expr;
1426
1427 my $bg_opts = $self->{bg_opts};
1428
1429 if ($bg_opts->{root} =~ /^\s*(?:true|yes|on|1)\s*$/i) {
1430 $expr .= "tile (";
1431
1432 my $shade = $bg_opts->{shade};
1433
1434 if ($shade) {
1435 $shade = List::Util::min $shade, 200;
1436 $shade = List::Util::max $shade, -100;
1437 $shade = 200 - (100 + $shade) if $shade < 0;
1438
1439 $shade = $shade * 0.01 - 1;
1440 $expr .= "shade $shade, ";
1441 }
1442
1443 my $tint = $bg_opts->{tint};
1444
1445 if ($tint) {
1446 $expr .= "tint $tint, ";
1447 }
1448
1449 my $blur = $bg_opts->{blur};
1450
1451 if ($blur and $blur =~ /^ =? ([0-9]+)? (?:[xX] ([0-9]+))? $/x) {
1452 my $hr = defined $1 ? $1 : 1;
1453 my $vr = defined $2 ? $2 : $hr;
1454
1455 if ($hr != 0 and $vr != 0) {
1456 $expr .= "blur $hr, $vr, ";
1457 }
1458 }
1459
1460 $expr .= "rootalign root)";
1461 }
1462
1463 if ($bg_opts->{path}) {
1464 my $file_expr;
1465 my $h_scale = $bg_opts->{h_scale} * 0.01;
1466 my $v_scale = $bg_opts->{v_scale} * 0.01;
1467 my $h_align = $bg_opts->{h_align} * 0.01;
1468 my $v_align = $bg_opts->{v_align} * 0.01;
1469
1470 if (!$bg_opts->{tile}) {
1471 $file_expr .= "pad (";
1472 } else {
1473 $file_expr .= "tile (";
1474 }
1475
1476 if ($bg_opts->{root_align}) {
1477 $file_expr .= "rootalign ";
1478 } else {
1479 $file_expr .= "align $h_align, $v_align, ";
1480 }
1481
1482 if ($h_scale != 0 and $v_scale != 0) {
1483 my $op = $bg_opts->{keep_aspect} ? "fit" : "resize";
1484 $file_expr .= "$op TW * $h_scale, TH * $v_scale, ";
1485 }
1486
1487 $file_expr .= "keep { load pack \"H*\", \"$bg_opts->{path}\" })";
1488
1489 if ($expr) {
1490 $expr .= ", tint (\"[50]white\", $file_expr)";
1491 } else {
1492 $expr = $file_expr;
1493 }
1494 }
1495
1496 $expr
1497}
1498
1499sub on_osc_seq {
1500 my ($self, $op, $arg) = @_;
1501
1502 $self->{bg_opts} or return;
1503
1504 $op =~ /^(20|705)$/ or return;
1505
1506 if ($op eq "20") {
1507 if ($arg eq "?") {
1508 my $h_scale = $self->{bg_opts}->{h_scale};
1509 my $v_scale = $self->{bg_opts}->{v_scale};
1510 my $h_align = $self->{bg_opts}->{h_align};
1511 my $v_align = $self->{bg_opts}->{v_align};
1512 $self->cmd_parse ("\033]2;[${h_scale}x${v_scale}+${h_align}+${v_align}]\007");
1513 } else {
1514 $self->old_bg_opts ($arg);
1515 my $expr = $self->old_bg_expr;
1516 $self->set_expr (parse_expr $expr) if $expr;
1517 }
1518 } elsif ($op eq "705") {
1519 $self->{bg_opts}->{tint} = $arg;
1520 my $expr = $self->old_bg_expr;
1521 $self->set_expr (parse_expr $expr) if $expr;
1522 }
1523
1524 1
1525}
1526
1527sub find_resource {
1528 my ($self, $res, $opt) = @_;
1529
1530 my $v = $self->x_resource ($opt);
1531 $v = $self->x_resource ($res) unless defined $v;
1532
1533 $v
1534}
1535
1073sub on_start { 1536sub on_start {
1074 my ($self) = @_; 1537 my ($self) = @_;
1075 1538
1076 my $expr = $self->x_resource ("%.expr") 1539 my $expr = $self->x_resource ("%.expr");
1540
1541 if (!$expr) {
1542 $self->{bg_opts} = { h_scale => 100, v_scale => 100,
1543 h_align => 50, v_align => 50 };
1544
1545 $self->{bg_opts}->{shade} = $self->find_resource ("shading", "sh");
1546 $self->{bg_opts}->{tint} = $self->find_resource ("tintColor", "tint");
1547 $self->{bg_opts}->{blur} = $self->find_resource ("blurRadius", "blr");
1548 $self->{bg_opts}->{root} = $self->find_resource ("transparent", "tr");
1549
1550 $self->old_bg_opts ($self->find_resource ("backgroundPixmap", "pixmap"));
1551 $expr = $self->old_bg_expr;
1552 }
1553
1077 or return; 1554 $expr or return;
1078 1555
1079 $self->has_render 1556 $self->has_render
1080 or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n"; 1557 or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
1081 1558
1082 $self->set_expr (parse_expr $expr); 1559 $self->set_expr (parse_expr $expr);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines