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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.76 by root, Tue Aug 14 23:57:07 2012 UTC vs.
Revision 1.104 by root, Sat Dec 4 22:56:49 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
		16	#:META:OSC:20:change/query background image
		17	#:META:OSC:705:change transparent background tint colour
6		18
7	=head1 NAME	19	=head1 NAME
8		20
9	background - manage terminal background	21	background - manage terminal background
10		22
11	=head1 SYNOPSIS	23	=head1 SYNOPSIS
12		24
13	urxvt --background-expr 'background expression'	25	urxvt --background-expr 'background expression'
14	--background-border	26	--background-border
15	--background-interval seconds	27	--background-interval seconds
16		28
17	=head1 QUICK AND DIRTY CHEAT SHEET	29	=head1 QUICK AND DIRTY CHEAT SHEET
18		30
19	Just load a random jpeg image and tile the background with it without	31	Load a random jpeg image and tile the background with it without scaling
20	scaling or anything else:	32	or anything else:
21		33
22	load "/path/to/img.jpg"	34	load "/path/to/img.jpg"
23		35
24	The same, but use mirroring/reflection instead of tiling:	36	The same, but use mirroring/reflection instead of tiling:
25		37
44	is behind the text, replacing the normal background colour.	56	is behind the text, replacing the normal background colour.
45		57
46	It does so by evaluating a Perl expression that I<calculates> the image on	58	It does so by evaluating a Perl expression that I<calculates> the image on
47	the fly, for example, by grabbing the root background or loading a file.	59	the fly, for example, by grabbing the root background or loading a file.
48		60
49	While the full power of Perl is available, the operators have been design	61	While the full power of Perl is available, the operators have been
50	to be as simple as possible.	62	designed to be as simple as possible.
51		63
52	For example, to load an image and scale it to the window size, you would	64	For example, to load an image and scale it to the window size, you would
53	use:	65	use:
54		66
55	urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }'	67	urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }'
56		68
57	Or specified as a X resource:	69	Or specified as a X resource:
58		70
59	URxvt.background-expr: scale keep { load "/path/to/mybg.png" }	71	URxvt.background.expr: scale keep { load "/path/to/mybg.png" }
60		72
61	=head1 THEORY OF OPERATION	73	=head1 THEORY OF OPERATION
62		74
63	At startup, just before the window is mapped for the first time, the	75	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	76	expression is evaluated and must yield an image. The image is then
…		…
132	get a percentage):	144	get a percentage):
133		145
134	scale 2, load "$HOME/mypic.png"	146	scale 2, load "$HOME/mypic.png"
135		147
136	This enlarges the image by a factor of 2 (200%). As you can see, C<scale>	148	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	149	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	150	C<load> only has one argument. Arguments are separated from each other by
139	commas.	151	commas.
140		152
141	Scale also accepts two arguments, which are then separate factors for both	153	Scale also accepts two arguments, which are then separate factors for both
142	horizontal and vertical dimensions. For example, this halves the image	154	horizontal and vertical dimensions. For example, this halves the image
…		…
249		261
250	=head1 REFERENCE	262	=head1 REFERENCE
251		263
252	=head2 COMMAND LINE SWITCHES	264	=head2 COMMAND LINE SWITCHES
253		265
254	=over 4	266	=over
255		267
256	=item --background-expr perl-expression	268	=item --background-expr perl-expression
257		269
258	Specifies the Perl expression to evaluate.	270	Specifies the Perl expression to evaluate.
259		271
…		…
279	=cut	291	=cut
280		292
281	our %_IMG_CACHE;	293	our %_IMG_CACHE;
282	our $HOME;	294	our $HOME;
283	our ($self, $frame);	295	our ($self, $frame);
284	our ($x, $y, $w, $h);	296	our ($x, $y, $w, $h, $focus);
285		297
286	# enforce at least this interval between updates	298	# enforce at least this interval between updates
287	our $MIN_INTERVAL = 6/59.951;	299	our $MIN_INTERVAL = 6/59.951;
288		300
289	{	301	{
…		…
300		312
301	These functions provide an image, by loading it from disk, grabbing it	313	These functions provide an image, by loading it from disk, grabbing it
302	from the root screen or by simply generating it. They are used as starting	314	from the root screen or by simply generating it. They are used as starting
303	points to get an image you can play with.	315	points to get an image you can play with.
304		316
305	=over 4	317	=over
306		318
307	=item load $path	319	=item load $path
308		320
309	Loads the image at the given C<$path>. The image is set to plane tiling	321	Loads the image at the given C<$path>. The image is set to plane tiling
310	mode.	322	mode.
311		323
312	If the image is already in memory (e.g. because another terminal instance	324	If the image is already in memory (e.g. because another terminal instance
313	uses it), then the in-memory copy us returned instead.	325	uses it), then the in-memory copy is returned instead.
314		326
315	=item load_uc $path	327	=item load_uc $path
316		328
317	Load uncached - same as load, but does not cache the image, which means it	329	Load uncached - same as load, but does not cache the image, which means it
318	is I<always> loaded from the filesystem again, even if another copy of it	330	is I<always> loaded from the filesystem again, even if another copy of it
…		…
429	=head2 TILING MODES	441	=head2 TILING MODES
430		442
431	The following operators modify the tiling mode of an image, that is, the	443	The following operators modify the tiling mode of an image, that is, the
432	way that pixels outside the image area are painted when the image is used.	444	way that pixels outside the image area are painted when the image is used.
433		445
434	=over 4	446	=over
435		447
436	=item tile $img	448	=item tile $img
437		449
438	Tiles the whole plane with the image and returns this new image - or in	450	Tiles the whole plane with the image and returns this new image - or in
439	other words, it returns a copy of the image in plane tiling mode.	451	other words, it returns a copy of the image in plane tiling mode.
…		…
514	dimensions. They are not (Perl-) variables, they just return stuff that	526	dimensions. They are not (Perl-) variables, they just return stuff that
515	varies. Most of them make your expression sensitive to some events, for	527	varies. Most of them make your expression sensitive to some events, for
516	example using C<TW> (terminal width) means your expression is evaluated	528	example using C<TW> (terminal width) means your expression is evaluated
517	again when the terminal is resized.	529	again when the terminal is resized.
518		530
519	=over 4	531	=over
520		532
521	=item TX	533	=item TX
522		534
523	=item TY	535	=item TY
524		536
525	Return the X and Y coordinates of the terminal window (the terminal	537	Return the X and Y coordinates of the terminal window (the terminal
526	window is the full window by default, and the character area only when in	538	window is the full window by default, and the character area only when in
527	border-respect mode).	539	border-respect mode).
528		540
529	Using these functions make your expression sensitive to window moves.	541	Using these functions makes your expression sensitive to window moves.
530		542
531	These functions are mainly useful to align images to the root window.	543	These functions are mainly useful to align images to the root window.
532		544
533	Example: load an image and align it so it looks as if anchored to the	545	Example: load an image and align it so it looks as if anchored to the
534	background (that's exactly what C<rootalign> does btw.):	546	background (that's exactly what C<rootalign> does btw.):
535		547
536	move -TX, -TY, keep { load "mybg.png" }	548	move -TX, -TY, keep { load "mybg.png" }
537		549
538	=item TW	550	=item TW
		551
		552	=item TH
539		553
540	Return the width (C<TW>) and height (C<TH>) of the terminal window (the	554	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
541	terminal window is the full window by default, and the character area only	555	terminal window is the full window by default, and the character area only
542	when in border-respect mode).	556	when in border-respect mode).
543		557
544	Using these functions make your expression sensitive to window resizes.	558	Using these functions makes your expression sensitive to window resizes.
545		559
546	These functions are mainly useful to scale images, or to clip images to	560	These functions are mainly useful to scale images, or to clip images to
547	the window size to conserve memory.	561	the window size to conserve memory.
548		562
549	Example: take the screen background, clip it to the window size, blur it a	563	Example: take the screen background, clip it to the window size, blur it a
550	bit, align it to the window position and use it as background.	564	bit, align it to the window position and use it as background.
551		565
552	clip move -TX, -TY, keep { blur 5, root }	566	clip move -TX, -TY, keep { blur 5, root }
553		567
554	=cut	568	=item FOCUS
555		569
		570	Returns a boolean indicating whether the terminal window has keyboard
		571	focus, in which case it returns true.
		572
		573	Using this function makes your expression sensitive to focus changes.
		574
		575	A common use case is to fade the background image when the terminal loses
		576	focus, often together with the C<-fade> command line option. In fact,
		577	there is a special function for just that use case: C<focus_fade>.
		578
		579	Example: use two entirely different background images, depending on
		580	whether the window has focus.
		581
		582	FOCUS ? keep { load "has_focus.jpg" } : keep { load "no_focus.jpg" }
		583
		584	=cut
		585
556	sub TX() { $frame->[FR_AGAIN]{position} = 1; $x }	586	sub TX () { $frame->[FR_AGAIN]{position} = 1; $x }
557	sub TY() { $frame->[FR_AGAIN]{position} = 1; $y }	587	sub TY () { $frame->[FR_AGAIN]{position} = 1; $y }
558	sub TW() { $frame->[FR_AGAIN]{size} = 1; $w }	588	sub TW () { $frame->[FR_AGAIN]{size} = 1; $w }
559	sub TH() { $frame->[FR_AGAIN]{size} = 1; $h }	589	sub TH () { $frame->[FR_AGAIN]{size} = 1; $h }
		590	sub FOCUS() { $frame->[FR_AGAIN]{focus} = 1; $focus }
560		591
561	=item now	592	=item now
562		593
563	Returns the current time as (fractional) seconds since the epoch.	594	Returns the current time as (fractional) seconds since the epoch.
564		595
…		…
598		629
599	=head2 SHAPE CHANGING OPERATORS	630	=head2 SHAPE CHANGING OPERATORS
600		631
601	The following operators modify the shape, size or position of the image.	632	The following operators modify the shape, size or position of the image.
602		633
603	=over 4	634	=over
604		635
605	=item clip $img	636	=item clip $img
606		637
607	=item clip $width, $height, $img	638	=item clip $width, $height, $img
608		639
…		…
611	Clips an image to the given rectangle. If the rectangle is outside the	642	Clips an image to the given rectangle. If the rectangle is outside the
612	image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is	643	image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is
613	larger than the image, then the tiling mode defines how the extra pixels	644	larger than the image, then the tiling mode defines how the extra pixels
614	will be filled.	645	will be filled.
615		646
616	If C<$x> an C<$y> are missing, then C<0> is assumed for both.	647	If C<$x> and C<$y> are missing, then C<0> is assumed for both.
617		648
618	If C<$width> and C<$height> are missing, then the window size will be	649	If C<$width> and C<$height> are missing, then the window size will be
619	assumed.	650	assumed.
620		651
621	Example: load an image, blur it, and clip it to the window size to save	652	Example: load an image, blur it, and clip it to the window size to save
…		…
639	=item scale $width_factor, $height_factor, $img	670	=item scale $width_factor, $height_factor, $img
640		671
641	Scales the image by the given factors in horizontal	672	Scales the image by the given factors in horizontal
642	(C<$width>) and vertical (C<$height>) direction.	673	(C<$width>) and vertical (C<$height>) direction.
643		674
644	If only one factor is give, it is used for both directions.	675	If only one factor is given, it is used for both directions.
645		676
646	If no factors are given, scales the image to the window size without	677	If no factors are given, scales the image to the window size without
647	keeping aspect.	678	keeping aspect.
648		679
649	=item resize $width, $height, $img	680	=item resize $width, $height, $img
…		…
774	=item rotate $center_x, $center_y, $degrees, $img	805	=item rotate $center_x, $center_y, $degrees, $img
775		806
776	Rotates the image clockwise by C<$degrees> degrees, around the point at	807	Rotates the image clockwise by C<$degrees> degrees, around the point at
777	C<$center_x> and C<$center_y> (specified as factor of image width/height).	808	C<$center_x> and C<$center_y> (specified as factor of image width/height).
778		809
779	Example: rotate the image by 90 degrees around it's center.	810	Example: rotate the image by 90 degrees around its center.
780		811
781	rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }	812	rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
782		813
783	=cut	814	=cut
784		815
…		…
795		826
796	=head2 COLOUR MODIFICATIONS	827	=head2 COLOUR MODIFICATIONS
797		828
798	The following operators change the pixels of the image.	829	The following operators change the pixels of the image.
799		830
800	=over 4	831	=over
801		832
802	=item tint $color, $img	833	=item tint $color, $img
803		834
804	Tints the image in the given colour.	835	Tints the image in the given colour.
805		836
…		…
813		844
814	=cut	845	=cut
815		846
816	sub tint($$) {	847	sub tint($$) {
817	$_[1]->tint ($_[0])	848	$_[1]->tint ($_[0])
		849	}
		850
		851	=item shade $factor, $img
		852
		853	Shade the image by the given factor.
		854
		855	=cut
		856
		857	sub shade($$) {
		858	$_[1]->shade ($_[0])
818	}	859	}
819		860
820	=item contrast $factor, $img	861	=item contrast $factor, $img
821		862
822	=item contrast $r, $g, $b, $img	863	=item contrast $r, $g, $b, $img
…		…
883	$img	924	$img
884	}	925	}
885		926
886	=item muladd $mul, $add, $img # EXPERIMENTAL	927	=item muladd $mul, $add, $img # EXPERIMENTAL
887		928
888	First multipliesthe pixels by C<$mul>, then adds C<$add>. This cna be used	929	First multiplies the pixels by C<$mul>, then adds C<$add>. This can be used
889	to implement brightness and contrast at the same time, with a wider value	930	to implement brightness and contrast at the same time, with a wider value
890	range than contrast and brightness operators.	931	range than contrast and brightness operators.
891		932
892	Due to numerous bugs in XRender implementations, it can also introduce a	933	Due to numerous bugs in XRender implementations, it can also introduce a
893	number of visual artifacts.	934	number of visual artifacts.
…		…
920	sub blur($$;$) {	961	sub blur($$;$) {
921	my $img = pop;	962	my $img = pop;
922	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	963	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
923	}	964	}
924		965
		966	=item focus_fade $img
		967
		968	=item focus_fade $factor, $img
		969
		970	=item focus_fade $factor, $color, $img
		971
		972	Fades the image by the given factor (and colour) when focus is lost (the
		973	same as the C<-fade>/C<-fadecolor> command line options, which also supply
		974	the default values for C<factor> and C<$color>. Unlike with C<-fade>, the
		975	C<$factor> is a real value, not a percentage value (that is, 0..1, not
		976	0..100).
		977
		978	Example: do the right thing when focus fading is requested.
		979
		980	focus_fade load "mybg.jpg";
		981
		982	=cut
		983
		984	sub focus_fade($;$$) {
		985	my $img = pop;
		986
		987	return $img
		988	if FOCUS;
		989
		990	my $fade = @_ >= 1 ? $_[0] : defined $self->resource ("fade") ? $self->resource ("fade") * 0.01 : 0;
		991	my $color = @_ >= 2 ? $_[1] : $self->resource ("color+" . urxvt::Color_fade);
		992
		993	$img = $img->tint ($color) if $color ne "rgb:00/00/00";
		994	$img = $img->muladd (1 - $fade, 0) if $fade;
		995
		996	$img
		997	}
		998
925	=back	999	=back
926		1000
927	=head2 OTHER STUFF	1001	=head2 OTHER STUFF
928		1002
929	Anything that didn't fit any of the other categories, even after applying	1003	Anything that didn't fit any of the other categories, even after applying
930	force and closing our eyes.	1004	force and closing our eyes.
931		1005
932	=over 4	1006	=over
933		1007
934	=item keep { ... }	1008	=item keep { ... }
935		1009
936	This operator takes a code block as argument, that is, one or more	1010	This operator takes a code block as argument, that is, one or more
937	statements enclosed by braces.	1011	statements enclosed by braces.
…		…
959		1033
960	This leaves the question of how to force reevaluation of the block,	1034	This leaves the question of how to force reevaluation of the block,
961	in case the root background changes: If expression inside the block	1035	in case the root background changes: If expression inside the block
962	is sensitive to some event (root background changes, window geometry	1036	is sensitive to some event (root background changes, window geometry
963	changes), then it will be reevaluated automatically as needed.	1037	changes), then it will be reevaluated automatically as needed.
		1038
		1039	=back
		1040
		1041	=head1 OLD BACKGROUND IMAGE SETTINGS
		1042
		1043	This extension also provides support for the old options/resources and
		1044	OSC sequences for setting a background image. These settings are
		1045	B<deprecated> and will be removed in future versions.
		1046
		1047	=head2 OPTIONS AND RESOURCES
		1048
		1049	=over
		1050
		1051	=item B<-pixmap> I<file[;oplist]>
		1052
		1053	=item B<backgroundPixmap:> I<file[;oplist]>
		1054
		1055	Use the specified image file as the window's background and also
		1056	optionally specify a colon separated list of operations to modify it.
		1057	Note that you may need to quote the C<;> character when using the
		1058	command line option, as C<;> is usually a metacharacter in shells.
		1059	Supported operations are:
		1060
		1061	=over
		1062
		1063	=item B<WxH+X+Y>
		1064
		1065	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1066	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1067	scale of 0 disables scaling.
		1068
		1069	=item B<op=tile>
		1070
		1071	enables tiling
		1072
		1073	=item B<op=keep-aspect>
		1074
		1075	maintain the image aspect ratio when scaling
		1076
		1077	=item B<op=root-align>
		1078
		1079	use the position of the terminal window relative to the root window as
		1080	the image offset, simulating a root window background
		1081
		1082	=back
		1083
		1084	The default scale and position setting is C<100x100+50+50>.
		1085	Alternatively, a predefined set of templates can be used to achieve
		1086	the most common setups:
		1087
		1088	=over
		1089
		1090	=item B<style=tiled>
		1091
		1092	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1093
		1094	=item B<style=aspect-stretched>
		1095
		1096	the image is scaled to fill the whole window maintaining the aspect
		1097	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1098
		1099	=item B<style=stretched>
		1100
		1101	the image is scaled to fill the whole window. Equivalent to 100x100
		1102
		1103	=item B<style=centered>
		1104
		1105	the image is centered with no scaling. Equivalent to 0x0+50+50
		1106
		1107	=item B<style=root-tiled>
		1108
		1109	the image is tiled with no scaling and using 'root' positioning.
		1110	Equivalent to 0x0:op=tile:op=root-align
		1111
		1112	=back
		1113
		1114	If multiple templates are specified the last one wins. Note that a
		1115	template overrides all the scale, position and operations settings.
		1116
		1117	If used in conjunction with pseudo-transparency, the specified image
		1118	will be blended over the transparent background using alpha-blending.
		1119
		1120	=item B<-tr>\|B<+tr>
		1121
		1122	=item B<transparent:> I<boolean>
		1123
		1124	Turn on/off pseudo-transparency by using the root pixmap as background.
		1125
		1126	=item B<-tint> I<colour>
		1127
		1128	=item B<tintColor:> I<colour>
		1129
		1130	Tint the transparent background with the given colour. Note that a
		1131	black tint yields a completely black image while a white tint yields
		1132	the image unchanged.
		1133
		1134	=item B<-sh> I<number>
		1135
		1136	=item B<shading:> I<number>
		1137
		1138	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1139	A value of 100 means no shading.
		1140
		1141	=item B<-blr> I<HxV>
		1142
		1143	=item B<blurRadius:> I<HxV>
		1144
		1145	Apply gaussian blur with the specified radius to the transparent
		1146	background. If a single number is specified, the vertical and
		1147	horizontal radii are considered to be the same. Setting one of the
		1148	radii to 1 and the other to a large number creates interesting effects
		1149	on some backgrounds. The maximum radius value is 128. An horizontal or
		1150	vertical radius of 0 disables blurring.
		1151
		1152	=back
		1153
		1154	=head2 OSC sequences
		1155
		1156	This extension will react to the following OSC sequences. Note that
		1157	this extension will not be autoloaded when these are used currently,
		1158	so to make urxvt recognize them, you have to enable the C<background>
		1159	extension. One way to achieve that is to use the C<--background-expr ''>
		1160	command line argument or by specifying an empty C<URxvt.background.expr:>>
		1161	resource.
		1162
		1163	=over
		1164
		1165	=item B<< C<ESC ] 705 ; Pt ST> >> Change transparent background tint colour to B<< C<Pt> >>.
		1166
		1167	=item B<< C<ESC ] 20 ; Pt ST> >> Change/Query background image
		1168	parameters: the value of B<< C<Pt> >> can be one of the following
		1169	commands:
		1170
		1171	=over
		1172
		1173	=item B<< C<?> >>
		1174
		1175	display scale and position in the title
		1176
		1177	=item B<< C<;WxH+X+Y> >>
		1178
		1179	change scale and/or position
		1180
		1181	=item B<< C<FILE;WxH+X+Y> >>
		1182
		1183	change background image
		1184
		1185	=back
964		1186
965	=cut	1187	=cut
966		1188
967	sub keep(&) {	1189	sub keep(&) {
968	my $id = $_[0]+0;	1190	my $id = $_[0]+0;
…		…
1001	=cut	1223	=cut
1002		1224
1003	}	1225	}
1004		1226
1005	sub parse_expr {	1227	sub parse_expr {
		1228	my ($expr) = @_;
		1229
		1230	# an empty expression is valid and represents the default background
		1231	if ($expr !~ /\S/) {
		1232	$expr = sub {
		1233	undef
		1234	};
		1235	} else {
1006	my $expr = eval	1236	$expr = eval
1007	"sub {\n"	1237	"sub {\n"
1008	. "package urxvt::bgdsl;\n"	1238	. "package urxvt::bgdsl;\n"
1009	. "#line 0 'background expression'\n"	1239	. "#line 0 'background expression'\n"
1010	. "$_[0]\n"	1240	. "$expr\n"
1011	. "}";	1241	. "}";
1012	die if $@;	1242	die if $@;
		1243	}
		1244
1013	$expr	1245	$expr
1014	}	1246	}
1015		1247
1016	# compiles a parsed expression	1248	# compiles a parsed expression
1017	sub set_expr {	1249	sub set_expr {
…		…
1066	if ($again->{rootpmap}) {	1298	if ($again->{rootpmap}) {
1067	$state->{rootpmap} = $self->on (rootpmap_change => $cb);	1299	$state->{rootpmap} = $self->on (rootpmap_change => $cb);
1068	} else {	1300	} else {
1069	delete $state->{rootpmap};	1301	delete $state->{rootpmap};
1070	}	1302	}
		1303
		1304	if ($again->{focus}) {
		1305	$state->{focus} = $self->on (focus_in => $cb, focus_out => $cb);
		1306	} else {
		1307	delete $state->{focus};
		1308	}
1071	}	1309	}
1072		1310
1073	# evaluate the current bg expression	1311	# evaluate the current bg expression
1074	sub recalculate {	1312	sub recalculate {
1075	my ($arg_self) = @_;	1313	my ($arg_self) = @_;
…		…
1083	return;	1321	return;
1084	}	1322	}
1085		1323
1086	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	1324	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
1087		1325
		1326	unless ($arg_self->has_render) {
		1327	warn "background extension needs RENDER extension 0.11 or higher, ignoring background-expr.\n";
		1328	return;
		1329	}
		1330
1088	# set environment to evaluate user expression	1331	# set environment to evaluate user expression
1089		1332
1090	local $self = $arg_self;	1333	local $self = $arg_self;
1091	local $HOME = $ENV{HOME};	1334	local $HOME = $ENV{HOME};
1092	local $frame = $self->{root};	1335	local $frame = $self->{root};
1093		1336
1094	($x, $y, $w, $h) = $self->background_geometry ($self->{border});	1337	($x, $y, $w, $h) = $self->background_geometry ($self->{border});
		1338	$focus = $self->focus;
1095		1339
1096	# evaluate user expression	1340	# evaluate user expression
1097		1341
1098	my @img = eval { $self->{expr}->() };	1342	my @img = eval { $self->{expr}->() };
1099	die $@ if $@;	1343	die $@ if $@;
1100	die "background-expr did not return anything.\n" unless @img;	1344	die "background-expr did not return anything.\n" unless @img;
		1345
		1346	if ($img[0]) {
1101	die "background-expr: expected image(s), got something else.\n"	1347	die "background-expr: expected image(s), got something else.\n"
1102	if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;	1348	if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;
1103		1349
1104	my $img = urxvt::bgdsl::merge @img;	1350	my $img = urxvt::bgdsl::merge @img;
1105		1351
1106	$frame->[FR_AGAIN]{size} = 1	1352	$frame->[urxvt::bgdsl::FR_AGAIN]{size} = 1
1107	if $img->repeat_mode != urxvt::RepeatNormal;	1353	if $img->repeat_mode != urxvt::RepeatNormal;
1108		1354
1109	# if the expression is sensitive to external events, prepare reevaluation then	1355	# if the expression is sensitive to external events, prepare reevaluation then
1110	$self->compile_frame ($frame, sub { $arg_self->recalculate });	1356	$self->compile_frame ($frame, sub { $arg_self->recalculate });
1111		1357
1112	# clear stuff we no longer need	1358	# clear stuff we no longer need
1113		1359
1114	# unless (%{ $frame->[FR_STATE] }) {	1360	# unless (%{ $frame->[FR_STATE] }) {
1115	# delete $self->{state};	1361	# delete $self->{state};
1116	# delete $self->{expr};	1362	# delete $self->{expr};
1117	# }	1363	# }
1118		1364
1119	# set background pixmap	1365	# set background pixmap
1120		1366
1121	$self->set_background ($img, $self->{border});	1367	$self->set_background ($img, $self->{border});
		1368	} else {
		1369	$self->clr_background;
		1370	}
		1371
1122	$self->scr_recolour (0);	1372	$self->scr_recolor (0);
1123	$self->want_refresh;	1373	$self->want_refresh;
1124	}	1374	}
1125		1375
		1376	sub old_bg_opts {
		1377	my ($self, $arg) = @_;
		1378
		1379	$arg or return;
		1380
		1381	my @str = split /;/, $arg;
		1382
		1383	return unless $str[0] or $self->{bg_opts}->{path};
		1384
		1385	my $bg_opts = $self->{bg_opts};
		1386
		1387	if ($str[0]) {
		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} = 100;
		1392	$bg_opts->{h_align} = $bg_opts->{v_align} = 50;
		1393	$bg_opts->{path} = $str[0];
		1394	}
		1395
		1396	my @oplist = split /:/, $str[1];
		1397
		1398	for (@oplist) {
		1399	if (/style=tiled/i) {
		1400	$bg_opts->{tile} = 1;
		1401	$bg_opts->{keep_aspect} = 0;
		1402	$bg_opts->{root_align} = 0;
		1403	$bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
		1404	$bg_opts->{h_align} = $bg_opts->{v_align} = 0;
		1405	} elsif (/style=aspect-stretched/i) {
		1406	$bg_opts->{tile} = 0;
		1407	$bg_opts->{keep_aspect} = 1;
		1408	$bg_opts->{root_align} = 0;
		1409	$bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
		1410	$bg_opts->{h_align} = $bg_opts->{v_align} = 50;
		1411	} elsif (/style=stretched/i) {
		1412	$bg_opts->{tile} = 0;
		1413	$bg_opts->{keep_aspect} = 0;
		1414	$bg_opts->{root_align} = 0;
		1415	$bg_opts->{h_scale} = $bg_opts->{v_scale} = 100;
		1416	$bg_opts->{h_align} = $bg_opts->{v_align} = 50;
		1417	} elsif (/style=centered/i) {
		1418	$bg_opts->{tile} = 0;
		1419	$bg_opts->{keep_aspect} = 0;
		1420	$bg_opts->{root_align} = 0;
		1421	$bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
		1422	$bg_opts->{h_align} = $bg_opts->{v_align} = 50;
		1423	} elsif (/style=root-tiled/i) {
		1424	$bg_opts->{tile} = 1;
		1425	$bg_opts->{keep_aspect} = 0;
		1426	$bg_opts->{root_align} = 1;
		1427	$bg_opts->{h_scale} = $bg_opts->{v_scale} = 0;
		1428	$bg_opts->{h_align} = $bg_opts->{v_align} = 0;
		1429	} elsif (/op=tile/i) {
		1430	$bg_opts->{tile} = 1;
		1431	} elsif (/op=keep-aspect/i) {
		1432	$bg_opts->{keep_aspect} = 1;
		1433	} elsif (/op=root-align/i) {
		1434	$bg_opts->{root_align} = 1;
		1435	} elsif (/^ =? ([0-9]+)? (?:[xX] ([0-9]+))? ([+-][0-9]+)? ([+-][0-9]+)? $/x) {
		1436	my ($w, $h, $x, $y) = ($1, $2, $3, $4);
		1437
		1438	if ($str[0]) {
		1439	$w = $h unless defined $w;
		1440	$h = $w unless defined $h;
		1441	$y = $x unless defined $y;
		1442	}
		1443
		1444	$bg_opts->{h_scale} = $w if defined $w;
		1445	$bg_opts->{v_scale} = $h if defined $h;
		1446	$bg_opts->{h_align} = $x if defined $x;
		1447	$bg_opts->{v_align} = $y if defined $y;
		1448	}
		1449	}
		1450	}
		1451
		1452	# helper function, quote string as perl without allowing
		1453	# any code execution or other shenanigans. does not
		1454	# support binary NULs in string.
		1455	sub q0 {
		1456	(my $str = shift) =~ s/\x00//g; # make sure there really aren't any embedded NULs
		1457	"q\x00$str\x00"
		1458	}
		1459
		1460	sub old_bg_expr {
		1461	my ($self) = @_;
		1462
		1463	my $expr;
		1464
		1465	my $bg_opts = $self->{bg_opts};
		1466
		1467	if ($bg_opts->{root} =~ /^\s(?:true\|yes\|on\|1)\s$/i) {
		1468	$expr .= "tile (";
		1469
		1470	my $shade = $bg_opts->{shade};
		1471
		1472	if ($shade) {
		1473	$shade = List::Util::min $shade, 200;
		1474	$shade = List::Util::max $shade, -100;
		1475	$shade = 200 - (100 + $shade) if $shade < 0;
		1476
		1477	$shade = $shade * 0.01 - 1;
		1478	$expr .= "shade $shade, ";
		1479	}
		1480
		1481	my $tint = $bg_opts->{tint};
		1482
		1483	if ($tint) {
		1484	$tint = q0 $tint;
		1485	$expr .= "tint $tint,";
		1486	}
		1487
		1488	my $blur = $bg_opts->{blur};
		1489
		1490	if ($blur and $blur =~ /^ =? ([0-9]+)? (?:[xX] ([0-9]+))? $/x) {
		1491	my $hr = defined $1 ? $1 : 1;
		1492	my $vr = defined $2 ? $2 : $hr;
		1493
		1494	if ($hr != 0 and $vr != 0) {
		1495	$expr .= "blur $hr, $vr, ";
		1496	}
		1497	}
		1498
		1499	$expr .= "rootalign root)";
		1500	}
		1501
		1502	if ($bg_opts->{path}) {
		1503	my $file_expr;
		1504	my $h_scale = $bg_opts->{h_scale} * 0.01;
		1505	my $v_scale = $bg_opts->{v_scale} * 0.01;
		1506	my $h_align = $bg_opts->{h_align} * 0.01;
		1507	my $v_align = $bg_opts->{v_align} * 0.01;
		1508
		1509	if (!$bg_opts->{tile}) {
		1510	$file_expr .= "pad (";
		1511	} else {
		1512	$file_expr .= "tile (";
		1513	}
		1514
		1515	if ($bg_opts->{root_align}) {
		1516	$file_expr .= "rootalign ";
		1517	} else {
		1518	$file_expr .= "align $h_align, $v_align, ";
		1519	}
		1520
		1521	if ($h_scale != 0 and $v_scale != 0) {
		1522	my $op = $bg_opts->{keep_aspect} ? "fit" : "resize";
		1523	$file_expr .= "$op TW * $h_scale, TH * $v_scale, ";
		1524	}
		1525
		1526	my $path = q0 $bg_opts->{path};
		1527
		1528	$file_expr .= "keep { load $path })";
		1529
		1530	if ($expr) {
		1531	$expr .= ", tint (\"[50]white\", $file_expr)";
		1532	} else {
		1533	$expr = $file_expr;
		1534	}
		1535	}
		1536
		1537	$expr
		1538	}
		1539
		1540	sub find_resource {
		1541	my ($self, $res, $opt) = @_;
		1542
		1543	my $v = $self->x_resource ($opt);
		1544	$v = $self->x_resource ($res) unless defined $v;
		1545
		1546	$v
		1547	}
		1548
		1549	sub parse_bgopts {
		1550	my ($self) = @_;
		1551
		1552	my $expr = $self->x_resource ("%.expr");
		1553
		1554	if (!$expr) {
		1555	$self->{bg_opts} = { h_scale => 100, v_scale => 100,
		1556	h_align => 50, v_align => 50 };
		1557
		1558	$self->{bg_opts}{shade} = $self->find_resource ("shading", "sh");
		1559	$self->{bg_opts}{tint} = $self->find_resource ("tintColor", "tint");
		1560	$self->{bg_opts}{blur} = $self->find_resource ("blurRadius", "blr");
		1561	$self->{bg_opts}{root} = $self->find_resource ("transparent", "tr");
		1562
		1563	$self->old_bg_opts ($self->find_resource ("backgroundPixmap", "pixmap"));
		1564	$expr = $self->old_bg_expr;
		1565	}
		1566
		1567	$self->set_expr (parse_expr $expr);
		1568	$self->{border} = $self->x_resource_boolean ("%.border");
		1569
		1570	$MIN_INTERVAL = $self->x_resource ("%.interval");
		1571	}
		1572
1126	sub on_start {	1573	sub on_start {
1127	my ($self) = @_;	1574	my ($self) = @_;
1128		1575
1129	my $expr = $self->x_resource ("%.expr")	1576	$self->parse_bgopts;
1130	or return;
1131
1132	$self->has_render
1133	or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
1134
1135	$self->set_expr (parse_expr $expr);
1136	$self->{border} = $self->x_resource_boolean ("%.border");
1137
1138	$MIN_INTERVAL = $self->x_resource ("%.interval");
1139		1577
1140	()	1578	()
1141	}	1579	}
1142		1580
		1581	sub on_osc_seq {
		1582	my ($self, $op, $arg) = @_;
		1583
		1584	$op eq "20" or $op eq "706"
		1585	or return;
		1586
		1587	$self->{bg_opts}
		1588	or $self->parse_bgopts;
		1589
		1590	if ($op eq "20") {
		1591	if ($arg eq "?") {
		1592	my $h_scale = $self->{bg_opts}{h_scale};
		1593	my $v_scale = $self->{bg_opts}{v_scale};
		1594	my $h_align = $self->{bg_opts}{h_align};
		1595	my $v_align = $self->{bg_opts}{v_align};
		1596	$self->cmd_parse ("\033]2;[${h_scale}x${v_scale}+${h_align}+${v_align}]\007");
		1597	} else {
		1598	$self->old_bg_opts ($arg);
		1599	my $expr = $self->old_bg_expr;
		1600	$self->set_expr (parse_expr $expr) if $expr;
		1601	}
		1602	} elsif ($op eq "705") {
		1603	$self->{bg_opts}{tint} = $arg;
		1604	my $expr = $self->old_bg_expr;
		1605	$self->set_expr (parse_expr $expr) if $expr;
		1606	}
		1607
		1608	1
		1609	}
		1610

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.76 by root, Tue Aug 14 23:57:07 2012 UTC vs. Revision 1.104 by root, Sat Dec 4 22:56:49 2021 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.76 by root, Tue Aug 14 23:57:07 2012 UTC vs.
Revision 1.104 by root, Sat Dec 4 22:56:49 2021 UTC