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.82 by sf-exg, Sat Jan 19 10:04:34 2013 UTC vs.
Revision 1.100 by root, Sat Jul 24 09:48:43 2021 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
9background - manage terminal background 19background - manage terminal background
10 20
14 --background-border 24 --background-border
15 --background-interval seconds 25 --background-interval seconds
16 26
17=head1 QUICK AND DIRTY CHEAT SHEET 27=head1 QUICK AND DIRTY CHEAT SHEET
18 28
19Just load a random jpeg image and tile the background with it without 29Load a random jpeg image and tile the background with it without scaling
20scaling or anything else: 30or anything else:
21 31
22 load "/path/to/img.jpg" 32 load "/path/to/img.jpg"
23 33
24The same, but use mirroring/reflection instead of tiling: 34The same, but use mirroring/reflection instead of tiling:
25 35
54 64
55 urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }' 65 urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }'
56 66
57Or specified as a X resource: 67Or specified as a X resource:
58 68
59 URxvt.background-expr: scale keep { load "/path/to/mybg.png" } 69 URxvt.background.expr: scale keep { load "/path/to/mybg.png" }
60 70
61=head1 THEORY OF OPERATION 71=head1 THEORY OF OPERATION
62 72
63At 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
64expression is evaluated and must yield an image. The image is then 74expression is evaluated and must yield an image. The image is then
132get a percentage): 142get a percentage):
133 143
134 scale 2, load "$HOME/mypic.png" 144 scale 2, load "$HOME/mypic.png"
135 145
136This 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>
137has 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
138C<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
139commas. 149commas.
140 150
141Scale also accepts two arguments, which are then separate factors for both 151Scale also accepts two arguments, which are then separate factors for both
142horizontal and vertical dimensions. For example, this halves the image 152horizontal and vertical dimensions. For example, this halves the image
249 259
250=head1 REFERENCE 260=head1 REFERENCE
251 261
252=head2 COMMAND LINE SWITCHES 262=head2 COMMAND LINE SWITCHES
253 263
254=over 4 264=over
255 265
256=item --background-expr perl-expression 266=item --background-expr perl-expression
257 267
258Specifies the Perl expression to evaluate. 268Specifies the Perl expression to evaluate.
259 269
279=cut 289=cut
280 290
281our %_IMG_CACHE; 291our %_IMG_CACHE;
282our $HOME; 292our $HOME;
283our ($self, $frame); 293our ($self, $frame);
284our ($x, $y, $w, $h); 294our ($x, $y, $w, $h, $focus);
285 295
286# enforce at least this interval between updates 296# enforce at least this interval between updates
287our $MIN_INTERVAL = 6/59.951; 297our $MIN_INTERVAL = 6/59.951;
288 298
289{ 299{
300 310
301These functions provide an image, by loading it from disk, grabbing it 311These functions provide an image, by loading it from disk, grabbing it
302from the root screen or by simply generating it. They are used as starting 312from the root screen or by simply generating it. They are used as starting
303points to get an image you can play with. 313points to get an image you can play with.
304 314
305=over 4 315=over
306 316
307=item load $path 317=item load $path
308 318
309Loads 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
310mode. 320mode.
311 321
312If 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
313uses it), then the in-memory copy us returned instead. 323uses it), then the in-memory copy is returned instead.
314 324
315=item load_uc $path 325=item load_uc $path
316 326
317Load 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
318is I<always> loaded from the filesystem again, even if another copy of it 328is I<always> loaded from the filesystem again, even if another copy of it
429=head2 TILING MODES 439=head2 TILING MODES
430 440
431The 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
432way 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.
433 443
434=over 4 444=over
435 445
436=item tile $img 446=item tile $img
437 447
438Tiles the whole plane with the image and returns this new image - or in 448Tiles the whole plane with the image and returns this new image - or in
439other words, it returns a copy of the image in plane tiling mode. 449other words, it returns a copy of the image in plane tiling mode.
514dimensions. They are not (Perl-) variables, they just return stuff that 524dimensions. They are not (Perl-) variables, they just return stuff that
515varies. Most of them make your expression sensitive to some events, for 525varies. Most of them make your expression sensitive to some events, for
516example using C<TW> (terminal width) means your expression is evaluated 526example using C<TW> (terminal width) means your expression is evaluated
517again when the terminal is resized. 527again when the terminal is resized.
518 528
519=over 4 529=over
520 530
521=item TX 531=item TX
522 532
523=item TY 533=item TY
524 534
525Return the X and Y coordinates of the terminal window (the terminal 535Return the X and Y coordinates of the terminal window (the terminal
526window 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
527border-respect mode). 537border-respect mode).
528 538
529Using these functions make your expression sensitive to window moves. 539Using these functions makes your expression sensitive to window moves.
530 540
531These functions are mainly useful to align images to the root window. 541These functions are mainly useful to align images to the root window.
532 542
533Example: 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
534background (that's exactly what C<rootalign> does btw.): 544background (that's exactly what C<rootalign> does btw.):
541 551
542Return 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
543terminal 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
544when in border-respect mode). 554when in border-respect mode).
545 555
546Using these functions make your expression sensitive to window resizes. 556Using these functions makes your expression sensitive to window resizes.
547 557
548These 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
549the window size to conserve memory. 559the window size to conserve memory.
550 560
551Example: 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
552bit, align it to the window position and use it as background. 562bit, align it to the window position and use it as background.
553 563
554 clip move -TX, -TY, keep { blur 5, root } 564 clip move -TX, -TY, keep { blur 5, root }
555 565
556=cut 566=item FOCUS
557 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
558 sub TX() { $frame->[FR_AGAIN]{position} = 1; $x } 584 sub TX () { $frame->[FR_AGAIN]{position} = 1; $x }
559 sub TY() { $frame->[FR_AGAIN]{position} = 1; $y } 585 sub TY () { $frame->[FR_AGAIN]{position} = 1; $y }
560 sub TW() { $frame->[FR_AGAIN]{size} = 1; $w } 586 sub TW () { $frame->[FR_AGAIN]{size} = 1; $w }
561 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 }
562 589
563=item now 590=item now
564 591
565Returns the current time as (fractional) seconds since the epoch. 592Returns the current time as (fractional) seconds since the epoch.
566 593
600 627
601=head2 SHAPE CHANGING OPERATORS 628=head2 SHAPE CHANGING OPERATORS
602 629
603The following operators modify the shape, size or position of the image. 630The following operators modify the shape, size or position of the image.
604 631
605=over 4 632=over
606 633
607=item clip $img 634=item clip $img
608 635
609=item clip $width, $height, $img 636=item clip $width, $height, $img
610 637
797 824
798=head2 COLOUR MODIFICATIONS 825=head2 COLOUR MODIFICATIONS
799 826
800The following operators change the pixels of the image. 827The following operators change the pixels of the image.
801 828
802=over 4 829=over
803 830
804=item tint $color, $img 831=item tint $color, $img
805 832
806Tints the image in the given colour. 833Tints the image in the given colour.
807 834
932 sub blur($$;$) { 959 sub blur($$;$) {
933 my $img = pop; 960 my $img = pop;
934 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) 961 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
935 } 962 }
936 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
995 }
996
937=back 997=back
938 998
939=head2 OTHER STUFF 999=head2 OTHER STUFF
940 1000
941Anything that didn't fit any of the other categories, even after applying 1001Anything that didn't fit any of the other categories, even after applying
942force and closing our eyes. 1002force and closing our eyes.
943 1003
944=over 4 1004=over
945 1005
946=item keep { ... } 1006=item keep { ... }
947 1007
948This operator takes a code block as argument, that is, one or more 1008This operator takes a code block as argument, that is, one or more
949statements enclosed by braces. 1009statements enclosed by braces.
971 1031
972This leaves the question of how to force reevaluation of the block, 1032This leaves the question of how to force reevaluation of the block,
973in case the root background changes: If expression inside the block 1033in case the root background changes: If expression inside the block
974is sensitive to some event (root background changes, window geometry 1034is sensitive to some event (root background changes, window geometry
975changes), 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
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
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
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
1154This extension will react to the following OSC sequences. Note that
1155this extension will not be autoloaded when these are used currently,
1156so to make urxvt recognize them, you have to enable the C<background>
1157extension. One way to achieve that is to use the C<--background-expr ''>
1158command line argument or by specifying an empty C<URxvt.background.expr:>>
1159resource.
1160
1161=over
1162
1163=item B<< C<ESC ] 705 ; Pt ST> >> Change transparent background tint colour to B<< C<Pt> >>.
1164
1165=item B<< C<ESC ] 20 ; Pt ST> >> Change/Query background image
1166parameters: the value of B<< C<Pt> >> can be one of the following
1167commands:
1168
1169=over
1170
1171=item B<< C<?> >>
1172
1173display scale and position in the title
1174
1175=item B<< C<;WxH+X+Y> >>
1176
1177change scale and/or position
1178
1179=item B<< C<FILE;WxH+X+Y> >>
1180
1181change background image
1182
1183=back
976 1184
977=cut 1185=cut
978 1186
979 sub keep(&) { 1187 sub keep(&) {
980 my $id = $_[0]+0; 1188 my $id = $_[0]+0;
1013=cut 1221=cut
1014 1222
1015} 1223}
1016 1224
1017sub parse_expr { 1225sub parse_expr {
1226 my ($expr) = @_;
1227
1228 # an empty expression is valid and represents the default background
1229 if ($expr !~ /\S/) {
1230 $expr = sub {
1231 undef
1232 };
1233 } else {
1018 my $expr = eval 1234 $expr = eval
1019 "sub {\n" 1235 "sub {\n"
1020 . "package urxvt::bgdsl;\n" 1236 . "package urxvt::bgdsl;\n"
1021 . "#line 0 'background expression'\n" 1237 . "#line 0 'background expression'\n"
1022 . "$_[0]\n" 1238 . "$expr\n"
1023 . "}"; 1239 . "}";
1024 die if $@; 1240 die if $@;
1241 }
1242
1025 $expr 1243 $expr
1026} 1244}
1027 1245
1028# compiles a parsed expression 1246# compiles a parsed expression
1029sub set_expr { 1247sub set_expr {
1078 if ($again->{rootpmap}) { 1296 if ($again->{rootpmap}) {
1079 $state->{rootpmap} = $self->on (rootpmap_change => $cb); 1297 $state->{rootpmap} = $self->on (rootpmap_change => $cb);
1080 } else { 1298 } else {
1081 delete $state->{rootpmap}; 1299 delete $state->{rootpmap};
1082 } 1300 }
1301
1302 if ($again->{focus}) {
1303 $state->{focus} = $self->on (focus_in => $cb, focus_out => $cb);
1304 } else {
1305 delete $state->{focus};
1306 }
1083} 1307}
1084 1308
1085# evaluate the current bg expression 1309# evaluate the current bg expression
1086sub recalculate { 1310sub recalculate {
1087 my ($arg_self) = @_; 1311 my ($arg_self) = @_;
1095 return; 1319 return;
1096 } 1320 }
1097 1321
1098 $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; 1322 $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
1099 1323
1324 unless ($arg_self->has_render) {
1325 warn "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
1326 return;
1327 }
1328
1100 # set environment to evaluate user expression 1329 # set environment to evaluate user expression
1101 1330
1102 local $self = $arg_self; 1331 local $self = $arg_self;
1103 local $HOME = $ENV{HOME}; 1332 local $HOME = $ENV{HOME};
1104 local $frame = $self->{root}; 1333 local $frame = $self->{root};
1105 1334
1106 ($x, $y, $w, $h) = $self->background_geometry ($self->{border}); 1335 ($x, $y, $w, $h) = $self->background_geometry ($self->{border});
1336 $focus = $self->focus;
1107 1337
1108 # evaluate user expression 1338 # evaluate user expression
1109 1339
1110 my @img = eval { $self->{expr}->() }; 1340 my @img = eval { $self->{expr}->() };
1111 die $@ if $@; 1341 die $@ if $@;
1112 die "background-expr did not return anything.\n" unless @img; 1342 die "background-expr did not return anything.\n" unless @img;
1343
1344 if ($img[0]) {
1113 die "background-expr: expected image(s), got something else.\n" 1345 die "background-expr: expected image(s), got something else.\n"
1114 if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img; 1346 if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;
1115 1347
1116 my $img = urxvt::bgdsl::merge @img; 1348 my $img = urxvt::bgdsl::merge @img;
1117 1349
1118 $frame->[FR_AGAIN]{size} = 1 1350 $frame->[FR_AGAIN]{size} = 1
1119 if $img->repeat_mode != urxvt::RepeatNormal; 1351 if $img->repeat_mode != urxvt::RepeatNormal;
1120 1352
1121 # if the expression is sensitive to external events, prepare reevaluation then 1353 # if the expression is sensitive to external events, prepare reevaluation then
1122 $self->compile_frame ($frame, sub { $arg_self->recalculate }); 1354 $self->compile_frame ($frame, sub { $arg_self->recalculate });
1123 1355
1124 # clear stuff we no longer need 1356 # clear stuff we no longer need
1125 1357
1126# unless (%{ $frame->[FR_STATE] }) { 1358# unless (%{ $frame->[FR_STATE] }) {
1127# delete $self->{state}; 1359# delete $self->{state};
1128# delete $self->{expr}; 1360# delete $self->{expr};
1129# } 1361# }
1130 1362
1131 # set background pixmap 1363 # set background pixmap
1132 1364
1133 $self->set_background ($img, $self->{border}); 1365 $self->set_background ($img, $self->{border});
1366 } else {
1367 $self->clr_background;
1368 }
1369
1134 $self->scr_recolour (0); 1370 $self->scr_recolor (0);
1135 $self->want_refresh; 1371 $self->want_refresh;
1136} 1372}
1137 1373
1374sub old_bg_opts {
1375 my ($self, $arg) = @_;
1376
1377 $arg or return;
1378
1379 my @str = split /;/, $arg;
1380
1381 return unless $str[0] or $self->{bg_opts}->{path};
1382
1383 my $bg_opts = $self->{bg_opts};
1384
1385 if ($str[0]) {
1386 $bg_opts->{tile} = 0;
1387 $bg_opts->{keep_aspect} = 0;
1388 $bg_opts->{root_align} = 0;
1389 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
1390 $bg_opts->{h_align} = $bg_opts->{v_align} = 50;
1391 $bg_opts->{path} = $str[0];
1392 }
1393
1394 my @oplist = split /:/, $str[1];
1395
1396 for (@oplist) {
1397 if (/style=tiled/i) {
1398 $bg_opts->{tile} = 1;
1399 $bg_opts->{keep_aspect} = 0;
1400 $bg_opts->{root_align} = 0;
1401 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
1402 $bg_opts->{h_align} = $bg_opts->{v_align} = 0;
1403 } elsif (/style=aspect-stretched/i) {
1404 $bg_opts->{tile} = 0;
1405 $bg_opts->{keep_aspect} = 1;
1406 $bg_opts->{root_align} = 0;
1407 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
1408 $bg_opts->{h_align} = $bg_opts->{v_align} = 50;
1409 } elsif (/style=stretched/i) {
1410 $bg_opts->{tile} = 0;
1411 $bg_opts->{keep_aspect} = 0;
1412 $bg_opts->{root_align} = 0;
1413 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
1414 $bg_opts->{h_align} = $bg_opts->{v_align} = 50;
1415 } elsif (/style=centered/i) {
1416 $bg_opts->{tile} = 0;
1417 $bg_opts->{keep_aspect} = 0;
1418 $bg_opts->{root_align} = 0;
1419 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
1420 $bg_opts->{h_align} = $bg_opts->{v_align} = 50;
1421 } elsif (/style=root-tiled/i) {
1422 $bg_opts->{tile} = 1;
1423 $bg_opts->{keep_aspect} = 0;
1424 $bg_opts->{root_align} = 1;
1425 $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
1426 $bg_opts->{h_align} = $bg_opts->{v_align} = 0;
1427 } elsif (/op=tile/i) {
1428 $bg_opts->{tile} = 1;
1429 } elsif (/op=keep-aspect/i) {
1430 $bg_opts->{keep_aspect} = 1;
1431 } elsif (/op=root-align/i) {
1432 $bg_opts->{root_align} = 1;
1433 } elsif (/^ =? ([0-9]+)? (?:[xX] ([0-9]+))? ([+-][0-9]+)? ([+-][0-9]+)? $/x) {
1434 my ($w, $h, $x, $y) = ($1, $2, $3, $4);
1435
1436 if ($str[0]) {
1437 $w = $h unless defined $w;
1438 $h = $w unless defined $h;
1439 $y = $x unless defined $y;
1440 }
1441
1442 $bg_opts->{h_scale} = $w if defined $w;
1443 $bg_opts->{v_scale} = $h if defined $h;
1444 $bg_opts->{h_align} = $x if defined $x;
1445 $bg_opts->{v_align} = $y if defined $y;
1446 }
1447 }
1448}
1449
1450# helper function, quote string as perl without allowing
1451# any code execution or other shenanigans. does not
1452# support binary NULs in string.
1453sub q0 {
1454 (my $str = shift) =~ s/\x00//g; # make sure there really aren't any embedded NULs
1455 "q\x00$str\x00"
1456}
1457
1458sub old_bg_expr {
1459 my ($self) = @_;
1460
1461 my $expr;
1462
1463 my $bg_opts = $self->{bg_opts};
1464
1465 if ($bg_opts->{root} =~ /^\s*(?:true|yes|on|1)\s*$/i) {
1466 $expr .= "tile (";
1467
1468 my $shade = $bg_opts->{shade};
1469
1470 if ($shade) {
1471 $shade = List::Util::min $shade, 200;
1472 $shade = List::Util::max $shade, -100;
1473 $shade = 200 - (100 + $shade) if $shade < 0;
1474
1475 $shade = $shade * 0.01 - 1;
1476 $expr .= "shade $shade, ";
1477 }
1478
1479 my $tint = $bg_opts->{tint};
1480
1481 if ($tint) {
1482 $tint = q0 $tint;
1483 $expr .= "tint $tint,";
1484 }
1485
1486 my $blur = $bg_opts->{blur};
1487
1488 if ($blur and $blur =~ /^ =? ([0-9]+)? (?:[xX] ([0-9]+))? $/x) {
1489 my $hr = defined $1 ? $1 : 1;
1490 my $vr = defined $2 ? $2 : $hr;
1491
1492 if ($hr != 0 and $vr != 0) {
1493 $expr .= "blur $hr, $vr, ";
1494 }
1495 }
1496
1497 $expr .= "rootalign root)";
1498 }
1499
1500 if ($bg_opts->{path}) {
1501 my $file_expr;
1502 my $h_scale = $bg_opts->{h_scale} * 0.01;
1503 my $v_scale = $bg_opts->{v_scale} * 0.01;
1504 my $h_align = $bg_opts->{h_align} * 0.01;
1505 my $v_align = $bg_opts->{v_align} * 0.01;
1506
1507 if (!$bg_opts->{tile}) {
1508 $file_expr .= "pad (";
1509 } else {
1510 $file_expr .= "tile (";
1511 }
1512
1513 if ($bg_opts->{root_align}) {
1514 $file_expr .= "rootalign ";
1515 } else {
1516 $file_expr .= "align $h_align, $v_align, ";
1517 }
1518
1519 if ($h_scale != 0 and $v_scale != 0) {
1520 my $op = $bg_opts->{keep_aspect} ? "fit" : "resize";
1521 $file_expr .= "$op TW * $h_scale, TH * $v_scale, ";
1522 }
1523
1524 my $path = q0 $bg_opts->{path};
1525
1526 $file_expr .= "keep { load $path })";
1527
1528 if ($expr) {
1529 $expr .= ", tint (\"[50]white\", $file_expr)";
1530 } else {
1531 $expr = $file_expr;
1532 }
1533 }
1534
1535 $expr
1536}
1537
1538sub on_osc_seq {
1539 my ($self, $op, $arg) = @_;
1540
1541 $self->{bg_opts} or return;
1542
1543 $op =~ /^(?:20|705)$/ or return;
1544
1545 if ($op eq "20") {
1546 if ($arg eq "?") {
1547 my $h_scale = $self->{bg_opts}->{h_scale};
1548 my $v_scale = $self->{bg_opts}->{v_scale};
1549 my $h_align = $self->{bg_opts}->{h_align};
1550 my $v_align = $self->{bg_opts}->{v_align};
1551 $self->cmd_parse ("\033]2;[${h_scale}x${v_scale}+${h_align}+${v_align}]\007");
1552 } else {
1553 $self->old_bg_opts ($arg);
1554 my $expr = $self->old_bg_expr;
1555 $self->set_expr (parse_expr $expr) if $expr;
1556 }
1557 } elsif ($op eq "705") {
1558 $self->{bg_opts}->{tint} = $arg;
1559 my $expr = $self->old_bg_expr;
1560 $self->set_expr (parse_expr $expr) if $expr;
1561 }
1562
1563 1
1564}
1565
1566sub find_resource {
1567 my ($self, $res, $opt) = @_;
1568
1569 my $v = $self->x_resource ($opt);
1570 $v = $self->x_resource ($res) unless defined $v;
1571
1572 $v
1573}
1574
1138sub on_start { 1575sub on_start {
1139 my ($self) = @_; 1576 my ($self) = @_;
1140 1577
1141 my $expr = $self->x_resource ("%.expr") 1578 my $expr = $self->x_resource ("%.expr");
1142 or return;
1143 1579
1144 $self->has_render 1580 if (!$expr) {
1145 or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n"; 1581 $self->{bg_opts} = { h_scale => 100, v_scale => 100,
1582 h_align => 50, v_align => 50 };
1583
1584 $self->{bg_opts}{shade} = $self->find_resource ("shading", "sh");
1585 $self->{bg_opts}{tint} = $self->find_resource ("tintColor", "tint");
1586 $self->{bg_opts}{blur} = $self->find_resource ("blurRadius", "blr");
1587 $self->{bg_opts}{root} = $self->find_resource ("transparent", "tr");
1588
1589 $self->old_bg_opts ($self->find_resource ("backgroundPixmap", "pixmap"));
1590 $expr = $self->old_bg_expr;
1591 }
1146 1592
1147 $self->set_expr (parse_expr $expr); 1593 $self->set_expr (parse_expr $expr);
1148 $self->{border} = $self->x_resource_boolean ("%.border"); 1594 $self->{border} = $self->x_resource_boolean ("%.border");
1149 1595
1150 $MIN_INTERVAL = $self->x_resource ("%.interval"); 1596 $MIN_INTERVAL = $self->x_resource ("%.interval");

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines