[ViewVC] Diff of: cvs/rxvt-unicode/src/perl/background

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.86 by sf-exg, Fri Oct 4 17:09:57 2013 UTC vs.
Revision 1.97 by root, Tue Sep 17 18:17:14 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	19	background - manage terminal background
10		20
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
57	Or specified as a X resource:	67	Or 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
63	At startup, just before the window is mapped for the first time, the	73	At startup, just before the window is mapped for the first time, the
64	expression is evaluated and must yield an image. The image is then	74	expression is evaluated and must yield an image. The image is then
…		…
132	get a percentage):	142	get a percentage):
133		143
134	scale 2, load "$HOME/mypic.png"	144	scale 2, load "$HOME/mypic.png"
135		145
136	This enlarges the image by a factor of 2 (200%). As you can see, C<scale>	146	This enlarges the image by a factor of 2 (200%). As you can see, C<scale>
137	has now two arguments, the C<200> and the C<load> expression, while	147	has now two arguments, the C<2> and the C<load> expression, while
138	C<load> only has one argument. Arguments are separated from each other by	148	C<load> only has one argument. Arguments are separated from each other by
139	commas.	149	commas.
140		150
141	Scale also accepts two arguments, which are then separate factors for both	151	Scale also accepts two arguments, which are then separate factors for both
142	horizontal and vertical dimensions. For example, this halves the image	152	horizontal and vertical dimensions. For example, this halves the image
…		…
958	=item focus_fade $factor, $color, $img	968	=item focus_fade $factor, $color, $img
959		969
960	Fades the image by the given factor (and colour) when focus is lost (the	970	Fades the image by the given factor (and colour) when focus is lost (the
961	same as the C<-fade>/C<-fadecolor> command line options, which also supply	971	same as the C<-fade>/C<-fadecolor> command line options, which also supply
962	the default values for C<factor> and C<$color>. Unlike with C<-fade>, the	972	the default values for C<factor> and C<$color>. Unlike with C<-fade>, the
963	C<$factor> is the real value, not a percentage value (that is, 0..1, not	973	C<$factor> is a real value, not a percentage value (that is, 0..1, not
964	0..100).	974	0..100).
965		975
966	Example: do the right thing when focus fading is requested.	976	Example: do the right thing when focus fading is requested.
967		977
968	focus_fade load "mybg.jpg";	978	focus_fade load "mybg.jpg";
…		…
1021		1031
1022	This leaves the question of how to force reevaluation of the block,	1032	This leaves the question of how to force reevaluation of the block,
1023	in case the root background changes: If expression inside the block	1033	in case the root background changes: If expression inside the block
1024	is sensitive to some event (root background changes, window geometry	1034	is sensitive to some event (root background changes, window geometry
1025	changes), then it will be reevaluated automatically as needed.	1035	changes), then it will be reevaluated automatically as needed.
		1036
		1037	=back
		1038
		1039	=head1 OLD BACKGROUND IMAGE SETTINGS
		1040
		1041	This extension also provides support for the old options/resources and
		1042	OSC sequences for setting a background image. These settings are
		1043	B<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
		1053	Use the specified image file as the window's background and also
		1054	optionally specify a colon separated list of operations to modify it.
		1055	Note that you may need to quote the C<;> character when using the
		1056	command line option, as C<;> is usually a metacharacter in shells.
		1057	Supported operations are:
		1058
		1059	=over 4
		1060
		1061	=item B<WxH+X+Y>
		1062
		1063	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1064	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1065	scale of 0 disables scaling.
		1066
		1067	=item B<op=tile>
		1068
		1069	enables tiling
		1070
		1071	=item B<op=keep-aspect>
		1072
		1073	maintain the image aspect ratio when scaling
		1074
		1075	=item B<op=root-align>
		1076
		1077	use the position of the terminal window relative to the root window as
		1078	the image offset, simulating a root window background
		1079
		1080	=back
		1081
		1082	The default scale and position setting is C<100x100+50+50>.
		1083	Alternatively, a predefined set of templates can be used to achieve
		1084	the most common setups:
		1085
		1086	=over 4
		1087
		1088	=item B<style=tiled>
		1089
		1090	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1091
		1092	=item B<style=aspect-stretched>
		1093
		1094	the image is scaled to fill the whole window maintaining the aspect
		1095	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1096
		1097	=item B<style=stretched>
		1098
		1099	the image is scaled to fill the whole window. Equivalent to 100x100
		1100
		1101	=item B<style=centered>
		1102
		1103	the image is centered with no scaling. Equivalent to 0x0+50+50
		1104
		1105	=item B<style=root-tiled>
		1106
		1107	the image is tiled with no scaling and using 'root' positioning.
		1108	Equivalent to 0x0:op=tile:op=root-align
		1109
		1110	=back
		1111
		1112	If multiple templates are specified the last one wins. Note that a
		1113	template overrides all the scale, position and operations settings.
		1114
		1115	If used in conjunction with pseudo-transparency, the specified image
		1116	will be blended over the transparent background using alpha-blending.
		1117
		1118	=item B<-tr>\|B<+tr>
		1119
		1120	=item B<transparent:> I<boolean>
		1121
		1122	Turn 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
		1128	Tint the transparent background with the given colour. Note that a
		1129	black tint yields a completely black image while a white tint yields
		1130	the image unchanged.
		1131
		1132	=item B<-sh> I<number>
		1133
		1134	=item B<shading:> I<number>
		1135
		1136	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1137	A value of 100 means no shading.
		1138
		1139	=item B<-blr> I<HxV>
		1140
		1141	=item B<blurRadius:> I<HxV>
		1142
		1143	Apply gaussian blur with the specified radius to the transparent
		1144	background. If a single number is specified, the vertical and
		1145	horizontal radii are considered to be the same. Setting one of the
		1146	radii to 1 and the other to a large number creates interesting effects
		1147	on some backgrounds. The maximum radius value is 128. An horizontal or
		1148	vertical 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
		1159	parameters: the value of B<< C<Pt> >> can be one of the following
		1160	commands:
		1161
		1162	=over 4
		1163
		1164	=item B<< C<?> >>
		1165
		1166	display scale and position in the title
		1167
		1168	=item B<< C<;WxH+X+Y> >>
		1169
		1170	change scale and/or position
		1171
		1172	=item B<< C<FILE;WxH+X+Y> >>
		1173
		1174	change background image
		1175
		1176	=back
1026		1177
1027	=cut	1178	=cut
1028		1179
1029	sub keep(&) {	1180	sub keep(&) {
1030	my $id = $_[0]+0;	1181	my $id = $_[0]+0;
…		…
1151	return;	1302	return;
1152	}	1303	}
1153		1304
1154	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	1305	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
1155		1306
		1307	unless ($arg_self->has_render) {
		1308	warn "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
		1309	return;
		1310	}
		1311
1156	# set environment to evaluate user expression	1312	# set environment to evaluate user expression
1157		1313
1158	local $self = $arg_self;	1314	local $self = $arg_self;
1159	local $HOME = $ENV{HOME};	1315	local $HOME = $ENV{HOME};
1160	local $frame = $self->{root};	1316	local $frame = $self->{root};
…		…
1186	# }	1342	# }
1187		1343
1188	# set background pixmap	1344	# set background pixmap
1189		1345
1190	$self->set_background ($img, $self->{border});	1346	$self->set_background ($img, $self->{border});
1191	$self->scr_recolour (0);	1347	$self->scr_recolor (0);
1192	$self->want_refresh;	1348	$self->want_refresh;
1193	}	1349	}
1194		1350
		1351	sub old_bg_opts {
		1352	my ($self, $arg) = @_;
		1353
		1354	$arg or return;
		1355
		1356	my @str = split /;/, $arg;
		1357
		1358	return unless $str[0] or $self->{bg_opts}->{path};
		1359
		1360	my $bg_opts = $self->{bg_opts};
		1361
		1362	if ($str[0]) {
		1363	$bg_opts->{tile} = 0;
		1364	$bg_opts->{keep_aspect} = 0;
		1365	$bg_opts->{root_align} = 0;
		1366	$bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
		1367	$bg_opts->{h_align} = $bg_opts->{v_align} = 50;
		1368	$bg_opts->{path} = $str[0];
		1369	}
		1370
		1371	my @oplist = split /:/, $str[1];
		1372
		1373	for (@oplist) {
		1374	if (/style=tiled/i) {
		1375	$bg_opts->{tile} = 1;
		1376	$bg_opts->{keep_aspect} = 0;
		1377	$bg_opts->{root_align} = 0;
		1378	$bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
		1379	$bg_opts->{h_align} = $bg_opts->{v_align} = 0;
		1380	} elsif (/style=aspect-stretched/i) {
		1381	$bg_opts->{tile} = 0;
		1382	$bg_opts->{keep_aspect} = 1;
		1383	$bg_opts->{root_align} = 0;
		1384	$bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
		1385	$bg_opts->{h_align} = $bg_opts->{v_align} = 50;
		1386	} elsif (/style=stretched/i) {
		1387	$bg_opts->{tile} = 0;
		1388	$bg_opts->{keep_aspect} = 0;
		1389	$bg_opts->{root_align} = 0;
		1390	$bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
		1391	$bg_opts->{h_align} = $bg_opts->{v_align} = 50;
		1392	} elsif (/style=centered/i) {
		1393	$bg_opts->{tile} = 0;
		1394	$bg_opts->{keep_aspect} = 0;
		1395	$bg_opts->{root_align} = 0;
		1396	$bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
		1397	$bg_opts->{h_align} = $bg_opts->{v_align} = 50;
		1398	} elsif (/style=root-tiled/i) {
		1399	$bg_opts->{tile} = 1;
		1400	$bg_opts->{keep_aspect} = 0;
		1401	$bg_opts->{root_align} = 1;
		1402	$bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
		1403	$bg_opts->{h_align} = $bg_opts->{v_align} = 0;
		1404	} elsif (/op=tile/i) {
		1405	$bg_opts->{tile} = 1;
		1406	} elsif (/op=keep-aspect/i) {
		1407	$bg_opts->{keep_aspect} = 1;
		1408	} elsif (/op=root-align/i) {
		1409	$bg_opts->{root_align} = 1;
		1410	} elsif (/^ =? ([0-9]+)? (?:[xX] ([0-9]+))? ([+-][0-9]+)? ([+-][0-9]+)? $/x) {
		1411	my ($w, $h, $x, $y) = ($1, $2, $3, $4);
		1412
		1413	if ($str[0]) {
		1414	$w = $h unless defined $w;
		1415	$h = $w unless defined $h;
		1416	$y = $x unless defined $y;
		1417	}
		1418
		1419	$bg_opts->{h_scale} = $w if defined $w;
		1420	$bg_opts->{v_scale} = $h if defined $h;
		1421	$bg_opts->{h_align} = $x if defined $x;
		1422	$bg_opts->{v_align} = $y if defined $y;
		1423	}
		1424	}
		1425	}
		1426
		1427	# helper function, quote string as perl without allowing
		1428	# any code execution or other shenanigans. does not
		1429	# support binary NULs in string.
		1430	sub q0 {
		1431	(my $str = shift) =~ s/\x00//g; # make sure there really aren't any embedded NULs
		1432	"q\x00$str\x00"
		1433	}
		1434
		1435	sub old_bg_expr {
		1436	my ($self) = @_;
		1437
		1438	my $expr;
		1439
		1440	my $bg_opts = $self->{bg_opts};
		1441
		1442	if ($bg_opts->{root} =~ /^\s(?:true\|yes\|on\|1)\s$/i) {
		1443	$expr .= "tile (";
		1444
		1445	my $shade = $bg_opts->{shade};
		1446
		1447	if ($shade) {
		1448	$shade = List::Util::min $shade, 200;
		1449	$shade = List::Util::max $shade, -100;
		1450	$shade = 200 - (100 + $shade) if $shade < 0;
		1451
		1452	$shade = $shade * 0.01 - 1;
		1453	$expr .= "shade $shade, ";
		1454	}
		1455
		1456	my $tint = $bg_opts->{tint};
		1457
		1458	if ($tint) {
		1459	$tint = q0 $tint;
		1460	$expr .= "tint $tint,";
		1461	}
		1462
		1463	my $blur = $bg_opts->{blur};
		1464
		1465	if ($blur and $blur =~ /^ =? ([0-9]+)? (?:[xX] ([0-9]+))? $/x) {
		1466	my $hr = defined $1 ? $1 : 1;
		1467	my $vr = defined $2 ? $2 : $hr;
		1468
		1469	if ($hr != 0 and $vr != 0) {
		1470	$expr .= "blur $hr, $vr, ";
		1471	}
		1472	}
		1473
		1474	$expr .= "rootalign root)";
		1475	}
		1476
		1477	if ($bg_opts->{path}) {
		1478	my $file_expr;
		1479	my $h_scale = $bg_opts->{h_scale} * 0.01;
		1480	my $v_scale = $bg_opts->{v_scale} * 0.01;
		1481	my $h_align = $bg_opts->{h_align} * 0.01;
		1482	my $v_align = $bg_opts->{v_align} * 0.01;
		1483
		1484	if (!$bg_opts->{tile}) {
		1485	$file_expr .= "pad (";
		1486	} else {
		1487	$file_expr .= "tile (";
		1488	}
		1489
		1490	if ($bg_opts->{root_align}) {
		1491	$file_expr .= "rootalign ";
		1492	} else {
		1493	$file_expr .= "align $h_align, $v_align, ";
		1494	}
		1495
		1496	if ($h_scale != 0 and $v_scale != 0) {
		1497	my $op = $bg_opts->{keep_aspect} ? "fit" : "resize";
		1498	$file_expr .= "$op TW * $h_scale, TH * $v_scale, ";
		1499	}
		1500
		1501	my $path = q0 $bg_opts->{path};
		1502
		1503	$file_expr .= "keep { load $path })";
		1504
		1505	if ($expr) {
		1506	$expr .= ", tint (\"[50]white\", $file_expr)";
		1507	} else {
		1508	$expr = $file_expr;
		1509	}
		1510	}
		1511
		1512	$expr
		1513	}
		1514
		1515	sub on_osc_seq {
		1516	my ($self, $op, $arg) = @_;
		1517
		1518	$self->{bg_opts} or return;
		1519
		1520	$op =~ /^(?:20\|705)$/ or return;
		1521
		1522	if ($op eq "20") {
		1523	if ($arg eq "?") {
		1524	my $h_scale = $self->{bg_opts}->{h_scale};
		1525	my $v_scale = $self->{bg_opts}->{v_scale};
		1526	my $h_align = $self->{bg_opts}->{h_align};
		1527	my $v_align = $self->{bg_opts}->{v_align};
		1528	$self->cmd_parse ("\033]2;[${h_scale}x${v_scale}+${h_align}+${v_align}]\007");
		1529	} else {
		1530	$self->old_bg_opts ($arg);
		1531	my $expr = $self->old_bg_expr;
		1532	$self->set_expr (parse_expr $expr) if $expr;
		1533	}
		1534	} elsif ($op eq "705") {
		1535	$self->{bg_opts}->{tint} = $arg;
		1536	my $expr = $self->old_bg_expr;
		1537	$self->set_expr (parse_expr $expr) if $expr;
		1538	}
		1539
		1540	1
		1541	}
		1542
		1543	sub find_resource {
		1544	my ($self, $res, $opt) = @_;
		1545
		1546	my $v = $self->x_resource ($opt);
		1547	$v = $self->x_resource ($res) unless defined $v;
		1548
		1549	$v
		1550	}
		1551
1195	sub on_start {	1552	sub on_start {
1196	my ($self) = @_;	1553	my ($self) = @_;
1197		1554
1198	my $expr = $self->x_resource ("%.expr")	1555	my $expr = $self->x_resource ("%.expr");
		1556
		1557	if (!$expr) {
		1558	$self->{bg_opts} = { h_scale => 100, v_scale => 100,
		1559	h_align => 50, v_align => 50 };
		1560
		1561	$self->{bg_opts}{shade} = $self->find_resource ("shading", "sh");
		1562	$self->{bg_opts}{tint} = $self->find_resource ("tintColor", "tint");
		1563	$self->{bg_opts}{blur} = $self->find_resource ("blurRadius", "blr");
		1564	$self->{bg_opts}{root} = $self->find_resource ("transparent", "tr");
		1565
		1566	$self->old_bg_opts ($self->find_resource ("backgroundPixmap", "pixmap"));
		1567	$expr = $self->old_bg_expr;
		1568	}
		1569
1199	or return;	1570	$expr or return;
1200
1201	$self->has_render
1202	or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
1203		1571
1204	$self->set_expr (parse_expr $expr);	1572	$self->set_expr (parse_expr $expr);
1205	$self->{border} = $self->x_resource_boolean ("%.border");	1573	$self->{border} = $self->x_resource_boolean ("%.border");
1206		1574
1207	$MIN_INTERVAL = $self->x_resource ("%.interval");	1575	$MIN_INTERVAL = $self->x_resource ("%.interval");

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.86 by sf-exg, Fri Oct 4 17:09:57 2013 UTC vs. Revision 1.97 by root, Tue Sep 17 18:17:14 2019 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.86 by sf-exg, Fri Oct 4 17:09:57 2013 UTC vs.
Revision 1.97 by root, Tue Sep 17 18:17:14 2019 UTC