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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.68 by root, Sun Jul 1 21:47:07 2012 UTC vs.
Revision 1.99 by sf-exg, Sat May 8 07:45:48 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
9	background - manage terminal background	19	background - 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
		29	Load a random jpeg image and tile the background with it without scaling
		30	or anything else:
		31
		32	load "/path/to/img.jpg"
		33
		34	The same, but use mirroring/reflection instead of tiling:
		35
		36	mirror load "/path/to/img.jpg"
		37
		38	Load an image and scale it to exactly fill the terminal window:
		39
		40	scale keep { load "/path/to/img.jpg" }
		41
		42	Implement pseudo-transparency by using a suitably-aligned root pixmap
		43	as window background:
		44
		45	rootalign root
		46
		47	Likewise, but keep a blurred copy:
		48
		49	rootalign keep { blur 10, root }
		50
17	=head1 DESCRIPTION	51	=head1 DESCRIPTION
18		52
19	This extension manages the terminal background by creating a picture that	53	This extension manages the terminal background by creating a picture that
20	is behind the text, replacing the normal background colour.	54	is 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
33	Or specified as a X resource:	67	Or 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
39	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
40	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
…		…
74	return load "$HOME/sunday.png";	108	return load "$HOME/sunday.png";
75	}	109	}
76	}	110	}
77		111
78	This inner expression is evaluated once per hour (and whenever the	112	This inner expression is evaluated once per hour (and whenever the
79	temrinal window is resized). It sets F<sunday.png> as background on	113	terminal window is resized). It sets F<sunday.png> as background on
80	Sundays, and F<weekday.png> on all other days.	114	Sundays, and F<weekday.png> on all other days.
81		115
82	Fortunately, we expect that most expressions will be much simpler, with	116	Fortunately, we expect that most expressions will be much simpler, with
83	little Perl knowledge needed.	117	little Perl knowledge needed.
84		118
…		…
108	get a percentage):	142	get a percentage):
109		143
110	scale 2, load "$HOME/mypic.png"	144	scale 2, load "$HOME/mypic.png"
111		145
112	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>
113	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
114	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
115	commas.	149	commas.
116		150
117	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
118	horizontal and vertical dimensions. For example, this halves the image	152	horizontal and vertical dimensions. For example, this halves the image
119	width and doubles the image height:	153	width 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
123	IF you try out these expressions, you might suffer from some sluggishness,	157	IF you try out these expressions, you might suffer from some sluggishness,
124	because each time the terminal is resized, it loads the PNG image agin	158	because each time the terminal is resized, it loads the PNG image again
125	and scales it. Scaling is usually fast (and unavoidable), but loading the	159	and scales it. Scaling is usually fast (and unavoidable), but loading the
126	image can be quite time consuming. This is where C<keep> comes in handy:	160	image 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
…		…
156		190
157	This one first takes a snapshot of the screen background image, and then	191	This one first takes a snapshot of the screen background image, and then
158	moves it to the upper left corner of the screen (as opposed to the upper	192	moves it to the upper left corner of the screen (as opposed to the upper
159	left corner of the terminal window)- the result is pseudo-transparency:	193	left corner of the terminal window)- the result is pseudo-transparency:
160	the image seems to be static while the window is moved around.	194	the image seems to be static while the window is moved around.
		195
		196	=head2 COLOUR SPECIFICATIONS
		197
		198	Whenever an operator expects a "colour", then this can be specified in one
		199	of two ways: Either as string with an X11 colour specification, such as:
		200
		201	"red" # named colour
		202	"#f00" # simple rgb
		203	"[50]red" # red with 50% alpha
		204	"TekHVC:300/50/50" # anything goes
		205
		206	OR as an array reference with one, three or four components:
		207
		208	[0.5] # 50% gray, 100% alpha
		209	[0.5, 0, 0] # dark red, no green or blur, 100% alpha
		210	[0.5, 0, 0, 0.7] # same with explicit 70% alpha
161		211
162	=head2 CACHING AND SENSITIVITY	212	=head2 CACHING AND SENSITIVITY
163		213
164	Since some operations (such as C<load> and C<blur>) can take a long time,	214	Since some operations (such as C<load> and C<blur>) can take a long time,
165	caching results can be very important for a smooth operation. Caching can	215	caching results can be very important for a smooth operation. Caching can
…		…
239	=cut	289	=cut
240		290
241	our %_IMG_CACHE;	291	our %_IMG_CACHE;
242	our $HOME;	292	our $HOME;
243	our ($self, $frame);	293	our ($self, $frame);
244	our ($x, $y, $w, $h);	294	our ($x, $y, $w, $h, $focus);
245		295
246	# enforce at least this interval between updates	296	# enforce at least this interval between updates
247	our $MIN_INTERVAL = 6/59.951;	297	our $MIN_INTERVAL = 6/59.951;
248		298
249	{	299	{
…		…
268		318
269	Loads the image at the given C<$path>. The image is set to plane tiling	319	Loads the image at the given C<$path>. The image is set to plane tiling
270	mode.	320	mode.
271		321
272	If the image is already in memory (e.g. because another terminal instance	322	If the image is already in memory (e.g. because another terminal instance
273	uses it), then the in-memory copy us returned instead.	323	uses it), then the in-memory copy is returned instead.
274		324
275	=item load_uc $path	325	=item load_uc $path
276		326
277	Load uncached - same as load, but does not cache the image, which means it	327	Load uncached - same as load, but does not cache the image, which means it
278	is I<always> loaded from the filesystem again.	328	is I<always> loaded from the filesystem again, even if another copy of it
		329	is in memory at the time.
279		330
280	=cut	331	=cut
281		332
282	sub load_uc($) {	333	sub load_uc($) {
283	$self->new_img_from_file ($path)	334	$self->new_img_from_file ($_[0])
284	}	335	}
285		336
286	sub load($) {	337	sub load($) {
287	my ($path) = @_;	338	my ($path) = @_;
288		339
…		…
381	for @_;	432	for @_;
382		433
383	$base	434	$base
384	}	435	}
385		436
		437	=back
		438
386	=head2 TILING MODES	439	=head2 TILING MODES
387		440
388	The following operators modify the tiling mode of an image, that is, the	441	The following operators modify the tiling mode of an image, that is, the
389	way that pixels outside the image area are painted when the image is used.	442	way that pixels outside the image area are painted when the image is used.
390		443
…		…
481		534
482	Return the X and Y coordinates of the terminal window (the terminal	535	Return the X and Y coordinates of the terminal window (the terminal
483	window is the full window by default, and the character area only when in	536	window is the full window by default, and the character area only when in
484	border-respect mode).	537	border-respect mode).
485		538
486	Using these functions make your expression sensitive to window moves.	539	Using these functions makes your expression sensitive to window moves.
487		540
488	These functions are mainly useful to align images to the root window.	541	These functions are mainly useful to align images to the root window.
489		542
490	Example: load an image and align it so it looks as if anchored to the	543	Example: load an image and align it so it looks as if anchored to the
491	background (that's exactly what C<rootalign> does btw.):	544	background (that's exactly what C<rootalign> does btw.):
492		545
493	move -TX, -TY, keep { load "mybg.png" }	546	move -TX, -TY, keep { load "mybg.png" }
494		547
495	=item TW	548	=item TW
		549
		550	=item TH
496		551
497	Return the width (C<TW>) and height (C<TH>) of the terminal window (the	552	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
498	terminal window is the full window by default, and the character area only	553	terminal window is the full window by default, and the character area only
499	when in border-respect mode).	554	when in border-respect mode).
500		555
501	Using these functions make your expression sensitive to window resizes.	556	Using these functions makes your expression sensitive to window resizes.
502		557
503	These functions are mainly useful to scale images, or to clip images to	558	These functions are mainly useful to scale images, or to clip images to
504	the window size to conserve memory.	559	the window size to conserve memory.
505		560
506	Example: take the screen background, clip it to the window size, blur it a	561	Example: take the screen background, clip it to the window size, blur it a
507	bit, align it to the window position and use it as background.	562	bit, align it to the window position and use it as background.
508		563
509	clip move -TX, -TY, keep { blur 5, root }	564	clip move -TX, -TY, keep { blur 5, root }
510		565
511	=cut	566	=item FOCUS
512		567
		568	Returns a boolean indicating whether the terminal window has keyboard
		569	focus, in which case it returns true.
		570
		571	Using this function makes your expression sensitive to focus changes.
		572
		573	A common use case is to fade the background image when the terminal loses
		574	focus, often together with the C<-fade> command line option. In fact,
		575	there is a special function for just that use case: C<focus_fade>.
		576
		577	Example: use two entirely different background images, depending on
		578	whether the window has focus.
		579
		580	FOCUS ? keep { load "has_focus.jpg" } : keep { load "no_focus.jpg" }
		581
		582	=cut
		583
513	sub TX() { $frame->[FR_AGAIN]{position} = 1; $x }	584	sub TX () { $frame->[FR_AGAIN]{position} = 1; $x }
514	sub TY() { $frame->[FR_AGAIN]{position} = 1; $y }	585	sub TY () { $frame->[FR_AGAIN]{position} = 1; $y }
515	sub TW() { $frame->[FR_AGAIN]{size} = 1; $w }	586	sub TW () { $frame->[FR_AGAIN]{size} = 1; $w }
516	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 }
517		589
518	=item now	590	=item now
519		591
520	Returns the current time as (fractional) seconds since the epoch.	592	Returns the current time as (fractional) seconds since the epoch.
521		593
…		…
568	Clips an image to the given rectangle. If the rectangle is outside the	640	Clips an image to the given rectangle. If the rectangle is outside the
569	image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is	641	image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is
570	larger than the image, then the tiling mode defines how the extra pixels	642	larger than the image, then the tiling mode defines how the extra pixels
571	will be filled.	643	will be filled.
572		644
573	If C<$x> an C<$y> are missing, then C<0> is assumed for both.	645	If C<$x> and C<$y> are missing, then C<0> is assumed for both.
574		646
575	If C<$width> and C<$height> are missing, then the window size will be	647	If C<$width> and C<$height> are missing, then the window size will be
576	assumed.	648	assumed.
577		649
578	Example: load an image, blur it, and clip it to the window size to save	650	Example: load an image, blur it, and clip it to the window size to save
…		…
596	=item scale $width_factor, $height_factor, $img	668	=item scale $width_factor, $height_factor, $img
597		669
598	Scales the image by the given factors in horizontal	670	Scales the image by the given factors in horizontal
599	(C<$width>) and vertical (C<$height>) direction.	671	(C<$width>) and vertical (C<$height>) direction.
600		672
601	If only one factor is give, it is used for both directions.	673	If only one factor is given, it is used for both directions.
602		674
603	If no factors are given, scales the image to the window size without	675	If no factors are given, scales the image to the window size without
604	keeping aspect.	676	keeping aspect.
605		677
606	=item resize $width, $height, $img	678	=item resize $width, $height, $img
…		…
731	=item rotate $center_x, $center_y, $degrees, $img	803	=item rotate $center_x, $center_y, $degrees, $img
732		804
733	Rotates the image clockwise by C<$degrees> degrees, around the point at	805	Rotates the image clockwise by C<$degrees> degrees, around the point at
734	C<$center_x> and C<$center_y> (specified as factor of image width/height).	806	C<$center_x> and C<$center_y> (specified as factor of image width/height).
735		807
736	Example: rotate the image by 90 degrees around it's center.	808	Example: rotate the image by 90 degrees around its center.
737		809
738	rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }	810	rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
739		811
740	=cut	812	=cut
741		813
…		…
754		826
755	The following operators change the pixels of the image.	827	The following operators change the pixels of the image.
756		828
757	=over 4	829	=over 4
758		830
		831	=item tint $color, $img
		832
		833	Tints the image in the given colour.
		834
		835	Example: tint the image red.
		836
		837	tint "red", load "rgb.png"
		838
		839	Example: the same, but specify the colour by component.
		840
		841	tint [1, 0, 0], load "rgb.png"
		842
		843	=cut
		844
		845	sub tint($$) {
		846	$_[1]->tint ($_[0])
		847	}
		848
		849	=item shade $factor, $img
		850
		851	Shade the image by the given factor.
		852
		853	=cut
		854
		855	sub shade($$) {
		856	$_[1]->shade ($_[0])
		857	}
		858
759	=item contrast $factor, $img	859	=item contrast $factor, $img
760		860
761	=item contrast $r, $g, $b, $img	861	=item contrast $r, $g, $b, $img
762		862
763	=item contrast $r, $g, $b, $a, $img	863	=item contrast $r, $g, $b, $a, $img
…		…
792	latter in a white picture.	892	latter in a white picture.
793		893
794	Due to idiosyncrasies in the underlying XRender extension, biases less	894	Due to idiosyncrasies in the underlying XRender extension, biases less
795	than zero can be I<very> slow.	895	than zero can be I<very> slow.
796		896
		897	You can also try the experimental(!) C<muladd> operator.
		898
797	=cut	899	=cut
798		900
799	sub contrast($$;$$;$) {	901	sub contrast($$;$$;$) {
800	my $img = pop;	902	my $img = pop;
801	my ($r, $g, $b, $a) = @_;	903	my ($r, $g, $b, $a) = @_;
…		…
816	$a = 1 if @_ < 4;	918	$a = 1 if @_ < 4;
817		919
818	$img = $img->clone;	920	$img = $img->clone;
819	$img->brightness ($r, $g, $b, $a);	921	$img->brightness ($r, $g, $b, $a);
820	$img	922	$img
		923	}
		924
		925	=item muladd $mul, $add, $img # EXPERIMENTAL
		926
		927	First multiplies the pixels by C<$mul>, then adds C<$add>. This can be used
		928	to implement brightness and contrast at the same time, with a wider value
		929	range than contrast and brightness operators.
		930
		931	Due to numerous bugs in XRender implementations, it can also introduce a
		932	number of visual artifacts.
		933
		934	Example: increase contrast by a factor of C<$c> without changing image
		935	brightness too much.
		936
		937	muladd $c, (1 - $c) * 0.5, $img
		938
		939	=cut
		940
		941	sub muladd($$$) {
		942	$_[2]->muladd ($_[0], $_[1])
821	}	943	}
822		944
823	=item blur $radius, $img	945	=item blur $radius, $img
824		946
825	=item blur $radius_horz, $radius_vert, $img	947	=item blur $radius_horz, $radius_vert, $img
…		…
835	=cut	957	=cut
836		958
837	sub blur($$;$) {	959	sub blur($$;$) {
838	my $img = pop;	960	my $img = pop;
839	$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
		970	Fades the image by the given factor (and colour) when focus is lost (the
		971	same as the C<-fade>/C<-fadecolor> command line options, which also supply
		972	the default values for C<factor> and C<$color>. Unlike with C<-fade>, the
		973	C<$factor> is a real value, not a percentage value (that is, 0..1, not
		974	0..100).
		975
		976	Example: 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
840	}	995	}
841		996
842	=back	997	=back
843		998
844	=head2 OTHER STUFF	999	=head2 OTHER STUFF
…		…
870	C<keep> block so it only is reevaluated as required.	1025	C<keep> block so it only is reevaluated as required.
871		1026
872	Putting the blur into a C<keep> block will make sure the blur is only done	1027	Putting the blur into a C<keep> block will make sure the blur is only done
873	once, while the C<rootalign> is still done each time the window moves.	1028	once, while the C<rootalign> is still done each time the window moves.
874		1029
875	rootlign keep { blur 10, root }	1030	rootalign keep { blur 10, root }
876		1031
877	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,
878	in case the root background changes: If expression inside the block	1033	in case the root background changes: If expression inside the block
879	is sensitive to some event (root background changes, window geometry	1034	is sensitive to some event (root background changes, window geometry
880	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	This extension will react to the following OSC sequences. Note that
		1155	this extension will not be autoloaded when these are used currently,
		1156	so to make urxvt recognize them, you have to enable the C<background>
		1157	extension. One way to achieve that is to use the C<--background-expr ''>
		1158	command line argument or by specifying an empty C<URxvt.background.expr:>>
		1159	resource.
		1160
		1161	=over 4
		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
		1166	parameters: the value of B<< C<Pt> >> can be one of the following
		1167	commands:
		1168
		1169	=over 4
		1170
		1171	=item B<< C<?> >>
		1172
		1173	display scale and position in the title
		1174
		1175	=item B<< C<;WxH+X+Y> >>
		1176
		1177	change scale and/or position
		1178
		1179	=item B<< C<FILE;WxH+X+Y> >>
		1180
		1181	change background image
		1182
		1183	=back
881		1184
882	=cut	1185	=cut
883		1186
884	sub keep(&) {	1187	sub keep(&) {
885	my $id = $_[0]+0;	1188	my $id = $_[0]+0;
…		…
918	=cut	1221	=cut
919		1222
920	}	1223	}
921		1224
922	sub parse_expr {	1225	sub 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 {
923	my $expr = eval	1234	$expr = eval
924	"sub {\n"	1235	"sub {\n"
925	. "package urxvt::bgdsl;\n"	1236	. "package urxvt::bgdsl;\n"
926	. "#line 0 'background expression'\n"	1237	. "#line 0 'background expression'\n"
927	. "$_[0]\n"	1238	. "$expr\n"
928	. "}";	1239	. "}";
929	die if $@;	1240	die if $@;
		1241	}
		1242
930	$expr	1243	$expr
931	}	1244	}
932		1245
933	# compiles a parsed expression	1246	# compiles a parsed expression
934	sub set_expr {	1247	sub set_expr {
935	my ($self, $expr) = @_;	1248	my ($self, $expr) = @_;
936		1249
937	$self->{root} = [];	1250	$self->{root} = []; # the outermost frame
938	$self->{expr} = $expr;	1251	$self->{expr} = $expr;
939	$self->recalculate;	1252	$self->recalculate;
940	}	1253	}
941		1254
942	# takes a hash of sensitivity indicators and installs watchers	1255	# takes a hash of sensitivity indicators and installs watchers
…		…
983	if ($again->{rootpmap}) {	1296	if ($again->{rootpmap}) {
984	$state->{rootpmap} = $self->on (rootpmap_change => $cb);	1297	$state->{rootpmap} = $self->on (rootpmap_change => $cb);
985	} else {	1298	} else {
986	delete $state->{rootpmap};	1299	delete $state->{rootpmap};
987	}	1300	}
		1301
		1302	if ($again->{focus}) {
		1303	$state->{focus} = $self->on (focus_in => $cb, focus_out => $cb);
		1304	} else {
		1305	delete $state->{focus};
		1306	}
988	}	1307	}
989		1308
990	# evaluate the current bg expression	1309	# evaluate the current bg expression
991	sub recalculate {	1310	sub recalculate {
992	my ($arg_self) = @_;	1311	my ($arg_self) = @_;
…		…
1000	return;	1319	return;
1001	}	1320	}
1002		1321
1003	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	1322	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
1004		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
1005	# set environment to evaluate user expression	1329	# set environment to evaluate user expression
1006		1330
1007	local $self = $arg_self;	1331	local $self = $arg_self;
1008	local $HOME = $ENV{HOME};	1332	local $HOME = $ENV{HOME};
1009	local $frame = [];	1333	local $frame = $self->{root};
1010		1334
1011	($x, $y, $w, $h) = $self->background_geometry ($self->{border});	1335	($x, $y, $w, $h) = $self->background_geometry ($self->{border});
		1336	$focus = $self->focus;
1012		1337
1013	# evaluate user expression	1338	# evaluate user expression
1014		1339
1015	my @img = eval { $self->{expr}->() };	1340	my @img = eval { $self->{expr}->() };
1016	die $@ if $@;	1341	die $@ if $@;
1017	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]) {
1018	die "background-expr: expected image(s), got something else.\n"	1345	die "background-expr: expected image(s), got something else.\n"
1019	if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;	1346	if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;
1020		1347
1021	my $img = urxvt::bgdsl::merge @img;	1348	my $img = urxvt::bgdsl::merge @img;
1022		1349
1023	$frame->[FR_AGAIN]{size} = 1	1350	$frame->[FR_AGAIN]{size} = 1
1024	if $img->repeat_mode != urxvt::RepeatNormal;	1351	if $img->repeat_mode != urxvt::RepeatNormal;
1025		1352
1026	# if the expression is sensitive to external events, prepare reevaluation then	1353	# if the expression is sensitive to external events, prepare reevaluation then
1027	$self->compile_frame ($frame, sub { $arg_self->recalculate });	1354	$self->compile_frame ($frame, sub { $arg_self->recalculate });
1028		1355
1029	# clear stuff we no longer need	1356	# clear stuff we no longer need
1030		1357
1031	# unless (%{ $frame->[FR_STATE] }) {	1358	# unless (%{ $frame->[FR_STATE] }) {
1032	# delete $self->{state};	1359	# delete $self->{state};
1033	# delete $self->{expr};	1360	# delete $self->{expr};
1034	# }	1361	# }
1035		1362
1036	# set background pixmap	1363	# set background pixmap
1037		1364
1038	$self->set_background ($img, $self->{border});	1365	$self->set_background ($img, $self->{border});
		1366	} else {
		1367	$self->clr_background;
		1368	}
		1369
1039	$self->scr_recolour (0);	1370	$self->scr_recolor (0);
1040	$self->want_refresh;	1371	$self->want_refresh;
1041	}	1372	}
1042		1373
		1374	sub 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.
		1453	sub q0 {
		1454	(my $str = shift) =~ s/\x00//g; # make sure there really aren't any embedded NULs
		1455	"q\x00$str\x00"
		1456	}
		1457
		1458	sub 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
		1538	sub 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
		1566	sub 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
1043	sub on_start {	1575	sub on_start {
1044	my ($self) = @_;	1576	my ($self) = @_;
1045		1577
1046	my $expr = $self->x_resource ("%.expr")	1578	my $expr = $self->x_resource ("%.expr");
1047	or return;
1048		1579
1049	$self->has_render	1580	if (!$expr) {
1050	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	}
1051		1592
1052	$self->set_expr (parse_expr $expr);	1593	$self->set_expr (parse_expr $expr);
1053	$self->{border} = $self->x_resource_boolean ("%.border");	1594	$self->{border} = $self->x_resource_boolean ("%.border");
1054		1595
1055	$MIN_INTERVAL = $self->x_resource ("%.interval");	1596	$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.68 by root, Sun Jul 1 21:47:07 2012 UTC vs. Revision 1.99 by sf-exg, Sat May 8 07:45:48 2021 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.68 by root, Sun Jul 1 21:47:07 2012 UTC vs.
Revision 1.99 by sf-exg, Sat May 8 07:45:48 2021 UTC