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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.62 by root, Sun Jun 17 21:58:18 2012 UTC vs.
Revision 1.98 by root, Tue Sep 17 20:38: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
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
26	to be as simple as possible.	60	to be as simple as possible.
27		61
28	For example, to load an image and scale it to the window size, you would	62	For example, to load an image and scale it to the window size, you would
29	use:	63	use:
30		64
31	urxvt --background-expr 'scale 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 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
…		…
53	If any of the parameters that the expression relies on changes (when the	87	If any of the parameters that the expression relies on changes (when the
54	window is moved or resized, its position or size changes; when the root	88	window is moved or resized, its position or size changes; when the root
55	pixmap is replaced by another one the root background changes; or when the	89	pixmap is replaced by another one the root background changes; or when the
56	timer elapses), then the expression will be evaluated again.	90	timer elapses), then the expression will be evaluated again.
57		91
58	For example, an expression such as C<scale load "$HOME/mybg.png"> scales the	92	For example, an expression such as C<scale keep { load "$HOME/mybg.png"
59	image to the window size, so it relies on the window size and will	93	}> scales the image to the window size, so it relies on the window size
60	be reevaluated each time it is changed, but not when it moves for	94	and will be reevaluated each time it is changed, but not when it moves for
61	example. That ensures that the picture always fills the terminal, even	95	example. That ensures that the picture always fills the terminal, even
62	after its size changes.	96	after its size changes.
63		97
64	=head2 EXPRESSIONS	98	=head2 EXPRESSIONS
65		99
66	Expressions are normal Perl expressions, in fact, they are Perl blocks -	100	Expressions are normal Perl expressions, in fact, they are Perl blocks -
67	which means you could use multiple lines and statements:	101	which means you could use multiple lines and statements:
68		102
		103	scale keep {
69	again 3600;	104	again 3600;
70	if (localtime now)[6]) {	105	if (localtime now)[6]) {
71	return scale load "$HOME/weekday.png";	106	return load "$HOME/weekday.png";
72	} else {	107	} else {
73	return scale load "$HOME/sunday.png";	108	return load "$HOME/sunday.png";
		109	}
74	}	110	}
75		111
76	This expression is evaluated once per hour. It will set F<sunday.png> as	112	This inner expression is evaluated once per hour (and whenever the
		113	terminal window is resized). It sets F<sunday.png> as background on
77	background on Sundays, and F<weekday.png> on all other days.	114	Sundays, and F<weekday.png> on all other days.
78		115
79	Fortunately, we expect that most expressions will be much simpler, with	116	Fortunately, we expect that most expressions will be much simpler, with
80	little Perl knowledge needed.	117	little Perl knowledge needed.
81		118
82	Basically, you always start with a function that "generates" an image	119	Basically, you always start with a function that "generates" an image
…		…
105	get a percentage):	142	get a percentage):
106		143
107	scale 2, load "$HOME/mypic.png"	144	scale 2, load "$HOME/mypic.png"
108		145
109	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>
110	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
111	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
112	commas.	149	commas.
113		150
114	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
115	horizontal and vertical dimensions. For example, this halves the image	152	horizontal and vertical dimensions. For example, this halves the image
116	width and doubles the image height:	153	width and doubles the image height:
117		154
118	scale 0.5, 2, load "$HOME/mypic.png"	155	scale 0.5, 2, load "$HOME/mypic.png"
119		156
120	Other effects than scaling are also readily available, for example, you can	157	IF you try out these expressions, you might suffer from some sluggishness,
121	tile the image to fill the whole window, instead of resizing it:	158	because each time the terminal is resized, it loads the PNG image again
		159	and scales it. Scaling is usually fast (and unavoidable), but loading the
		160	image can be quite time consuming. This is where C<keep> comes in handy:
122		161
		162	scale 0.5, 2, keep { load "$HOME/mypic.png" }
		163
		164	The C<keep> operator executes all the statements inside the braces only
		165	once, or when it thinks the outcome might change. In other cases it
		166	returns the last value computed by the brace block.
		167
		168	This means that the C<load> is only executed once, which makes it much
		169	faster, but also means that more memory is being used, because the loaded
		170	image must be kept in memory at all times. In this expression, the
		171	trade-off is likely worth it.
		172
		173	But back to effects: Other effects than scaling are also readily
		174	available, for example, you can tile the image to fill the whole window,
		175	instead of resizing it:
		176
123	tile load "$HOME/mypic.png"	177	tile keep { load "$HOME/mypic.png" }
124		178
125	In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator	179	In fact, images returned by C<load> are in C<tile> mode by default, so the
126	is kind of superfluous.	180	C<tile> operator is kind of superfluous.
127		181
128	Another common effect is to mirror the image, so that the same edges touch:	182	Another common effect is to mirror the image, so that the same edges
		183	touch:
129		184
130	mirror load "$HOME/mypic.png"	185	mirror keep { load "$HOME/mypic.png" }
131		186
132	This is also a typical background expression:	187	Another common background expression is:
133		188
134	rootalign root	189	rootalign root
135		190
136	It 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
137	moves it to the upper left corner of the screen - the result is	192	moves it to the upper left corner of the screen (as opposed to the upper
138	pseudo-transparency, as the image seems to be static while the window is	193	left corner of the terminal window)- the result is pseudo-transparency:
139	moved around.	194	the image seems to be static while the window is moved around.
140		195
141	=head2 CYCLES AND CACHING	196	=head2 COLOUR SPECIFICATIONS
142		197
143	As has been mentioned before, the expression might be evaluated multiple	198	Whenever an operator expects a "colour", then this can be specified in one
144	times. Each time the expression is reevaluated, a new cycle is said to	199	of two ways: Either as string with an X11 colour specification, such as:
145	have begun. Many operators cache their results till the next cycle.
146		200
147	For example, the C<load> operator keeps a copy of the image. If it is	201	"red" # named colour
148	asked to load the same image on the next cycle it will not load it again,	202	"#f00" # simple rgb
149	but return the cached copy.	203	"[50]red" # red with 50% alpha
		204	"TekHVC:300/50/50" # anything goes
150		205
151	This only works for one cycle though, so as long as you load the same	206	OR as an array reference with one, three or four components:
152	image every time, it will always be cached, but when you load a different
153	image, it will forget about the first one.
154		207
155	This allows you to either speed things up by keeping multiple images in	208	[0.5] # 50% gray, 100% alpha
156	memory, or conserve memory by loading images more often.	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
157		211
158	For example, you can keep two images in memory and use a random one like	212	=head2 CACHING AND SENSITIVITY
159	this:
160		213
161	my $img1 = load "img1.png";	214	Since some operations (such as C<load> and C<blur>) can take a long time,
162	my $img2 = load "img2.png";	215	caching results can be very important for a smooth operation. Caching can
163	(0.5 > rand) ? $img1 : $img2	216	also be useful to reduce memory usage, though, for example, when an image
		217	is cached by C<load>, it could be shared by multiple terminal windows
		218	running inside urxvtd.
164		219
165	Since both images are "loaded" every time the expression is evaluated,	220	=head3 C<keep { ... }> caching
166	they are always kept in memory. Contrast this version:
167		221
168	my $path1 = "img1.png";	222	The most important way to cache expensive operations is to use C<keep {
169	my $path2 = "img2.png";	223	... }>. The C<keep> operator takes a block of multiple statements enclosed
170	load ((0.5 > rand) ? $path1 : $path2)	224	by C<{}> and keeps the return value in memory.
171		225
172	Here, a path is selected randomly, and load is only called for one image,	226	An expression can be "sensitive" to various external events, such as
173	so keeps only one image in memory. If, on the next evaluation, luck	227	scaling or moving the window, root background changes and timers. Simply
174	decides to use the other path, then it will have to load that image again.	228	using an expression (such as C<scale> without parameters) that depends on
		229	certain changing values (called "variables"), or using those variables
		230	directly, will make an expression sensitive to these events - for example,
		231	using C<scale> or C<TW> will make the expression sensitive to the terminal
		232	size, and thus to resizing events.
		233
		234	When such an event happens, C<keep> will automatically trigger a
		235	reevaluation of the whole expression with the new value of the expression.
		236
		237	C<keep> is most useful for expensive operations, such as C<blur>:
		238
		239	rootalign keep { blur 20, root }
		240
		241	This makes a blurred copy of the root background once, and on subsequent
		242	calls, just root-aligns it. Since C<blur> is usually quite slow and
		243	C<rootalign> is quite fast, this trades extra memory (for the cached
		244	blurred pixmap) with speed (blur only needs to be redone when root
		245	changes).
		246
		247	=head3 C<load> caching
		248
		249	The C<load> operator itself does not keep images in memory, but as long as
		250	the image is still in memory, C<load> will use the in-memory image instead
		251	of loading it freshly from disk.
		252
		253	That means that this expression:
		254
		255	keep { load "$HOME/path..." }
		256
		257	Not only caches the image in memory, other terminal instances that try to
		258	C<load> it can reuse that in-memory copy.
175		259
176	=head1 REFERENCE	260	=head1 REFERENCE
177		261
178	=head2 COMMAND LINE SWITCHES	262	=head2 COMMAND LINE SWITCHES
179		263
…		…
204		288
205	=cut	289	=cut
206		290
207	our %_IMG_CACHE;	291	our %_IMG_CACHE;
208	our $HOME;	292	our $HOME;
209	our ($self, $old, $new);	293	our ($self, $frame);
210	our ($x, $y, $w, $h);	294	our ($x, $y, $w, $h, $focus);
211		295
212	# enforce at least this interval between updates	296	# enforce at least this interval between updates
213	our $MIN_INTERVAL = 6/59.951;	297	our $MIN_INTERVAL = 6/59.951;
214		298
215	{	299	{
216	package urxvt::bgdsl; # background language	300	package urxvt::bgdsl; # background language
		301
		302	sub FR_PARENT() { 0 } # parent frame, if any - must be #0
		303	sub FR_CACHE () { 1 } # cached values
		304	sub FR_AGAIN () { 2 } # what this expr is sensitive to
		305	sub FR_STATE () { 3 } # watchers etc.
217		306
218	use List::Util qw(min max sum shuffle);	307	use List::Util qw(min max sum shuffle);
219		308
220	=head2 PROVIDERS/GENERATORS	309	=head2 PROVIDERS/GENERATORS
221		310
…		…
228	=item load $path	317	=item load $path
229		318
230	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
231	mode.	320	mode.
232		321
233	Loaded images will be cached for one cycle, and shared between temrinals	322	If the image is already in memory (e.g. because another terminal instance
234	running in the same process (e.g. in C<urxvtd>).	323	uses it), then the in-memory copy is returned instead.
235		324
236	=item load_uc $path	325	=item load_uc $path
237		326
238	Load uncached - same as load, but does not cache the image. This function	327	Load uncached - same as load, but does not cache the image, which means it
239	is most useufl if you want to optimise a background expression in some	328	is I<always> loaded from the filesystem again, even if another copy of it
240	way.	329	is in memory at the time.
241		330
242	=cut	331	=cut
243		332
244	sub load_uc($) {	333	sub load_uc($) {
		334	$self->new_img_from_file ($_[0])
		335	}
		336
		337	sub load($) {
245	my ($path) = @_;	338	my ($path) = @_;
246		339
247	$_IMG_CACHE{$path} \|\| do {	340	$_IMG_CACHE{$path} \|\| do {
248	my $img = $self->new_img_from_file ($path);	341	my $img = load_uc $path;
249	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);	342	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
250	$img	343	$img
251	}	344	}
252	}	345	}
253		346
254	sub load($) {
255	my ($path) = @_;
256
257	$new->{load}{$path} = $old->{load}{$path} \|\| load_uc $path;
258	}
259
260	=item root	347	=item root
261		348
262	Returns the root window pixmap, that is, hopefully, the background image	349	Returns the root window pixmap, that is, hopefully, the background image
263	of your screen.	350	of your screen.
264		351
…		…
266	reevaluated when the bg image changes.	353	reevaluated when the bg image changes.
267		354
268	=cut	355	=cut
269		356
270	sub root() {	357	sub root() {
271	$new->{again}{rootpmap} = 1;	358	$frame->[FR_AGAIN]{rootpmap} = 1;
272	$self->new_img_from_root	359	$self->new_img_from_root
273	}	360	}
274		361
275	=item solid $colour	362	=item solid $colour
276		363
…		…
305		392
306	=item merge $img ...	393	=item merge $img ...
307		394
308	Takes any number of images and merges them together, creating a single	395	Takes any number of images and merges them together, creating a single
309	image containing them all. The tiling mode of the first image is used as	396	image containing them all. The tiling mode of the first image is used as
310	the tiling mdoe of the resulting image.	397	the tiling mode of the resulting image.
311		398
312	This function is called automatically when an expression returns multiple	399	This function is called automatically when an expression returns multiple
313	images.	400	images.
314		401
315	=cut	402	=cut
…		…
344	$base->draw ($_)	431	$base->draw ($_)
345	for @_;	432	for @_;
346		433
347	$base	434	$base
348	}	435	}
		436
		437	=back
349		438
350	=head2 TILING MODES	439	=head2 TILING MODES
351		440
352	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
353	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.
…		…
445		534
446	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
447	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
448	border-respect mode).	537	border-respect mode).
449		538
450	Using these functions make your expression sensitive to window moves.	539	Using these functions makes your expression sensitive to window moves.
451		540
452	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.
453		542
454	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
455	background.	544	background (that's exactly what C<rootalign> does btw.):
456		545
457	move -TX, -TY, load "mybg.png"	546	move -TX, -TY, keep { load "mybg.png" }
458		547
459	=item TW	548	=item TW
		549
		550	=item TH
460		551
461	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
462	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
463	when in border-respect mode).	554	when in border-respect mode).
464		555
465	Using these functions make your expression sensitive to window resizes.	556	Using these functions makes your expression sensitive to window resizes.
466		557
467	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
468	the window size to conserve memory.	559	the window size to conserve memory.
469		560
470	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
471	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.
472		563
473	clip move -TX, -TY, once { blur 5, root }	564	clip move -TX, -TY, keep { blur 5, root }
474		565
475	=cut	566	=item FOCUS
476		567
477	sub TX() { $new->{again}{position} = 1; $x }	568	Returns a boolean indicating whether the terminal window has keyboard
478	sub TY() { $new->{again}{position} = 1; $y }	569	focus, in which case it returns true.
479	sub TW() { $new->{again}{size} = 1; $w }	570
480	sub TH() { $new->{again}{size} = 1; $h }	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
		584	sub TX () { $frame->[FR_AGAIN]{position} = 1; $x }
		585	sub TY () { $frame->[FR_AGAIN]{position} = 1; $y }
		586	sub TW () { $frame->[FR_AGAIN]{size} = 1; $w }
		587	sub TH () { $frame->[FR_AGAIN]{size} = 1; $h }
		588	sub FOCUS() { $frame->[FR_AGAIN]{focus} = 1; $focus }
481		589
482	=item now	590	=item now
483		591
484	Returns the current time as (fractional) seconds since the epoch.	592	Returns the current time as (fractional) seconds since the epoch.
485		593
…		…
492	C<$seconds> seconds.	600	C<$seconds> seconds.
493		601
494	Example: load some image and rotate it according to the time of day (as if it were	602	Example: load some image and rotate it according to the time of day (as if it were
495	the hour pointer of a clock). Update this image every minute.	603	the hour pointer of a clock). Update this image every minute.
496		604
		605	again 60;
497	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"	606	rotate 50, 50, (now % 86400) * -72 / 8640, scale keep { load "myclock.png" }
498		607
499	=item counter $seconds	608	=item counter $seconds
500		609
501	Like C<again>, but also returns an increasing counter value, starting at	610	Like C<again>, but also returns an increasing counter value, starting at
502	0, which might be useful for some simple animation effects.	611	0, which might be useful for some simple animation effects.
…		…
504	=cut	613	=cut
505		614
506	sub now() { urxvt::NOW }	615	sub now() { urxvt::NOW }
507		616
508	sub again($) {	617	sub again($) {
509	$new->{again}{time} = $_[0];	618	$frame->[FR_AGAIN]{time} = $_[0];
510	}	619	}
511		620
512	sub counter($) {	621	sub counter($) {
513	$new->{again}{time} = $_[0];	622	$frame->[FR_AGAIN]{time} = $_[0];
514	$self->{counter} + 0	623	$frame->[FR_STATE]{counter} + 0
515	}	624	}
516		625
517	=back	626	=back
518		627
519	=head2 SHAPE CHANGING OPERATORS	628	=head2 SHAPE CHANGING OPERATORS
…		…
531	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
532	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
533	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
534	will be filled.	643	will be filled.
535		644
536	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.
537		646
538	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
539	assumed.	648	assumed.
540		649
541	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
542	memory.	651	memory.
543		652
544	clip blur 10, load "mybg.png"	653	clip keep { blur 10, load "mybg.png" }
545		654
546	=cut	655	=cut
547		656
548	sub clip($;$$;$$) {	657	sub clip($;$$;$$) {
549	my $img = pop;	658	my $img = pop;
…		…
559	=item scale $width_factor, $height_factor, $img	668	=item scale $width_factor, $height_factor, $img
560		669
561	Scales the image by the given factors in horizontal	670	Scales the image by the given factors in horizontal
562	(C<$width>) and vertical (C<$height>) direction.	671	(C<$width>) and vertical (C<$height>) direction.
563		672
564	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.
565		674
566	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
567	keeping aspect.	676	keeping aspect.
568		677
569	=item resize $width, $height, $img	678	=item resize $width, $height, $img
…		…
643	the terminal window (or the box specified by C<$width> and C<$height> if	752	the terminal window (or the box specified by C<$width> and C<$height> if
644	given).	753	given).
645		754
646	Example: load an image and center it.	755	Example: load an image and center it.
647		756
648	center pad load "mybg.png"	757	center keep { pad load "mybg.png" }
649		758
650	=item rootalign $img	759	=item rootalign $img
651		760
652	Moves the image so that it appears glued to the screen as opposed to the	761	Moves the image so that it appears glued to the screen as opposed to the
653	window. This gives the illusion of a larger area behind the window. It is	762	window. This gives the illusion of a larger area behind the window. It is
654	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the	763	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
655	top left of the screen.	764	top left of the screen.
656		765
657	Example: load a background image, put it in mirror mode and root align it.	766	Example: load a background image, put it in mirror mode and root align it.
658		767
659	rootalign mirror load "mybg.png"	768	rootalign keep { mirror load "mybg.png" }
660		769
661	Example: take the screen background and align it, giving the illusion of	770	Example: take the screen background and align it, giving the illusion of
662	transparency as long as the window isn't in front of other windows.	771	transparency as long as the window isn't in front of other windows.
663		772
664	rootalign root	773	rootalign root
…		…
689		798
690	sub rootalign($) {	799	sub rootalign($) {
691	move -TX, -TY, $_[0]	800	move -TX, -TY, $_[0]
692	}	801	}
693		802
694	=item rotate $center_x, $center_y, $degrees	803	=item rotate $center_x, $center_y, $degrees, $img
695		804
696	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	805	Rotates the image clockwise by C<$degrees> degrees, around the point at
697	pointer at C<$center_x> and C<$center_y> (specified as factor of image	806	C<$center_x> and C<$center_y> (specified as factor of image width/height).
698	width/height).
699		807
700	#TODO# new width, height, maybe more operators?
701
702	Example: rotate the image by 90 degrees	808	Example: rotate the image by 90 degrees around its center.
		809
		810	rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
703		811
704	=cut	812	=cut
705		813
706	sub rotate($$$$) {	814	sub rotate($$$$) {
707	my $img = pop;	815	my $img = pop;
…		…
718		826
719	The following operators change the pixels of the image.	827	The following operators change the pixels of the image.
720		828
721	=over 4	829	=over 4
722		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
723	=item contrast $factor, $img	859	=item contrast $factor, $img
724		860
725	=item contrast $r, $g, $b, $img	861	=item contrast $r, $g, $b, $img
726		862
727	=item contrast $r, $g, $b, $a, $img	863	=item contrast $r, $g, $b, $a, $img
…		…
756	latter in a white picture.	892	latter in a white picture.
757		893
758	Due to idiosyncrasies in the underlying XRender extension, biases less	894	Due to idiosyncrasies in the underlying XRender extension, biases less
759	than zero can be I<very> slow.	895	than zero can be I<very> slow.
760		896
		897	You can also try the experimental(!) C<muladd> operator.
		898
761	=cut	899	=cut
762		900
763	sub contrast($$;$$;$) {	901	sub contrast($$;$$;$) {
764	my $img = pop;	902	my $img = pop;
765	my ($r, $g, $b, $a) = @_;	903	my ($r, $g, $b, $a) = @_;
…		…
780	$a = 1 if @_ < 4;	918	$a = 1 if @_ < 4;
781		919
782	$img = $img->clone;	920	$img = $img->clone;
783	$img->brightness ($r, $g, $b, $a);	921	$img->brightness ($r, $g, $b, $a);
784	$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])
785	}	943	}
786		944
787	=item blur $radius, $img	945	=item blur $radius, $img
788		946
789	=item blur $radius_horz, $radius_vert, $img	947	=item blur $radius_horz, $radius_vert, $img
…		…
801	sub blur($$;$) {	959	sub blur($$;$) {
802	my $img = pop;	960	my $img = pop;
803	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	961	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
804	}	962	}
805		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
		995	}
		996
806	=back	997	=back
807		998
808	=head2 OTHER STUFF	999	=head2 OTHER STUFF
809		1000
810	Anything that didn't fit any of the other categories, even after applying	1001	Anything that didn't fit any of the other categories, even after applying
811	force and closing our eyes.	1002	force and closing our eyes.
812		1003
813	=over 4	1004	=over 4
814		1005
815	=item once { ... }	1006	=item keep { ... }
816		1007
817	This function takes a code block as argument, that is, one or more	1008	This operator takes a code block as argument, that is, one or more
818	statements enclosed by braces.	1009	statements enclosed by braces.
819		1010
820	The trick is that this code block is only evaluated once - future calls	1011	The trick is that this code block is only evaluated when the outcome
821	will simply return the original image (yes, it should only be used with	1012	changes - on other calls the C<keep> simply returns the image it computed
822	images).	1013	previously (yes, it should only be used with images). Or in other words,
		1014	C<keep> I<caches> the result of the code block so it doesn't need to be
		1015	computed again.
823		1016
824	This can be extremely useful to avoid redoign the same slow operations	1017	This can be extremely useful to avoid redoing slow operations - for
825	again and again- for example, if your background expression takes the root	1018	example, if your background expression takes the root background, blurs it
826	background, blurs it and then root-aligns it it would have to blur the	1019	and then root-aligns it it would have to blur the root background on every
827	root background on every window move or resize.	1020	window move or resize.
828		1021
		1022	Another example is C<load>, which can be quite slow.
		1023
		1024	In fact, urxvt itself encloses the whole expression in some kind of
		1025	C<keep> block so it only is reevaluated as required.
		1026
829	Putting the blur into a C<once> 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
830	once:	1028	once, while the C<rootalign> is still done each time the window moves.
831		1029
832	rootlign once { blur 10, root }	1030	rootalign keep { blur 10, root }
833		1031
834	This leaves the question of how to force reevaluation of the block, in	1032	This leaves the question of how to force reevaluation of the block,
835	case the root background changes: Right now, all once blocks forget that	1033	in case the root background changes: If expression inside the block
836	they ahve been executed before each time the root background changes (if	1034	is sensitive to some event (root background changes, window geometry
837	the expression is sensitive to that) or when C<once_again> is called.	1035	changes), then it will be reevaluated automatically as needed.
838		1036
839	=item once_again	1037	=back
840		1038
841	Resets all C<once> block as if they had never been called, i.e. on the	1039	=head1 OLD BACKGROUND IMAGE SETTINGS
842	next call they will be reevaluated again.
843		1040
844	=cut	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.
845		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 currenmtly,
		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
		1184
		1185	=cut
		1186
846	sub once(&) {	1187	sub keep(&) {
847	my $once = $self->{once_cache}{$_[0]+0} \|\|= do {	1188	my $id = $_[0]+0;
848	local $new->{again};	1189
849	my @res = $_[0]();	1190	local $frame = $self->{frame_cache}{$id} \|\|= [$frame];
850	[$new->{again}, \@res]	1191
		1192	unless ($frame->[FR_CACHE]) {
		1193	$frame->[FR_CACHE] = [ $_[0]() ];
		1194
		1195	my $self = $self;
		1196	my $frame = $frame;
		1197	Scalar::Util::weaken $frame;
		1198	$self->compile_frame ($frame, sub {
		1199	# clear this frame cache, also for all parents
		1200	for (my $frame = $frame; $frame; $frame = $frame->[0]) {
		1201	undef $frame->[FR_CACHE];
		1202	}
		1203
		1204	$self->recalculate;
851	};	1205	});
852
853	$new->{again} = {
854	%{ $new->{again} },
855	%{ $once->[0] }
856	};	1206	};
857		1207
858	# in scalar context we always return the first original result, which	1208	# in scalar context we always return the first original result, which
859	# is not quite how perl works.	1209	# is not quite how perl works.
860	wantarray	1210	wantarray
861	? @{ $once->[1] }	1211	? @{ $frame->[FR_CACHE] }
862	: $once->[1][0]	1212	: $frame->[FR_CACHE][0]
		1213	}
		1214
		1215	# sub keep_clear() {
		1216	# delete $self->{frame_cache};
863	}	1217	# }
864
865	sub once_again() {
866	delete $self->{once_cache};
867	}
868		1218
869	=back	1219	=back
870		1220
871	=cut	1221	=cut
872		1222
873	}	1223	}
874		1224
875	sub parse_expr {	1225	sub parse_expr {
876	my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}";	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 {
		1234	$expr = eval
		1235	"sub {\n"
		1236	. "package urxvt::bgdsl;\n"
		1237	. "#line 0 'background expression'\n"
		1238	. "$expr\n"
		1239	. "}";
877	die if $@;	1240	die if $@;
		1241	}
		1242
878	$expr	1243	$expr
879	}	1244	}
880		1245
881	# compiles a parsed expression	1246	# compiles a parsed expression
882	sub set_expr {	1247	sub set_expr {
883	my ($self, $expr) = @_;	1248	my ($self, $expr) = @_;
884		1249
		1250	$self->{root} = []; # the outermost frame
885	$self->{expr} = $expr;	1251	$self->{expr} = $expr;
886	$self->recalculate;	1252	$self->recalculate;
		1253	}
		1254
		1255	# takes a hash of sensitivity indicators and installs watchers
		1256	sub compile_frame {
		1257	my ($self, $frame, $cb) = @_;
		1258
		1259	my $state = $frame->[urxvt::bgdsl::FR_STATE] \|\|= {};
		1260	my $again = $frame->[urxvt::bgdsl::FR_AGAIN];
		1261
		1262	# don't keep stuff alive
		1263	Scalar::Util::weaken $state;
		1264
		1265	if ($again->{nested}) {
		1266	$state->{nested} = 1;
		1267	} else {
		1268	delete $state->{nested};
		1269	}
		1270
		1271	if (my $interval = $again->{time}) {
		1272	$state->{time} = [$interval, urxvt::timer->new->after ($interval)->interval ($interval)]
		1273	if $state->{time}[0] != $interval;
		1274
		1275	# callback might have changed, although we could just rule that out
		1276	$state->{time}[1]->cb (sub {
		1277	++$state->{counter};
		1278	$cb->();
		1279	});
		1280	} else {
		1281	delete $state->{time};
		1282	}
		1283
		1284	if ($again->{position}) {
		1285	$state->{position} = $self->on (position_change => $cb);
		1286	} else {
		1287	delete $state->{position};
		1288	}
		1289
		1290	if ($again->{size}) {
		1291	$state->{size} = $self->on (size_change => $cb);
		1292	} else {
		1293	delete $state->{size};
		1294	}
		1295
		1296	if ($again->{rootpmap}) {
		1297	$state->{rootpmap} = $self->on (rootpmap_change => $cb);
		1298	} else {
		1299	delete $state->{rootpmap};
		1300	}
		1301
		1302	if ($again->{focus}) {
		1303	$state->{focus} = $self->on (focus_in => $cb, focus_out => $cb);
		1304	} else {
		1305	delete $state->{focus};
		1306	}
887	}	1307	}
888		1308
889	# evaluate the current bg expression	1309	# evaluate the current bg expression
890	sub recalculate {	1310	sub recalculate {
891	my ($arg_self) = @_;	1311	my ($arg_self) = @_;
…		…
899	return;	1319	return;
900	}	1320	}
901		1321
902	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	1322	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
903		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
904	# set environment to evaluate user expression	1329	# set environment to evaluate user expression
905		1330
906	local $self = $arg_self;	1331	local $self = $arg_self;
907
908	local $HOME = $ENV{HOME};	1332	local $HOME = $ENV{HOME};
909	local $old = $self->{state};	1333	local $frame = $self->{root};
910	local $new = my $state = $self->{state} = {};
911		1334
912	($x, $y, $w, $h) =
913	$self->background_geometry ($self->{border});	1335	($x, $y, $w, $h) = $self->background_geometry ($self->{border});
		1336	$focus = $self->focus;
914		1337
915	# evaluate user expression	1338	# evaluate user expression
916		1339
917	my $img = eval { urxvt::bgdsl::merge $self->{expr}->() };	1340	my @img = eval { $self->{expr}->() };
918	die $@ if $@;	1341	die $@ if $@;
919	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";	1342	die "background-expr did not return anything.\n" unless @img;
920		1343
		1344	if ($img[0]) {
		1345	die "background-expr: expected image(s), got something else.\n"
		1346	if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;
		1347
		1348	my $img = urxvt::bgdsl::merge @img;
		1349
		1350	$frame->[FR_AGAIN]{size} = 1
		1351	if $img->repeat_mode != urxvt::RepeatNormal;
		1352
921	# if the expression is sensitive to external events, prepare reevaluation then	1353	# if the expression is sensitive to external events, prepare reevaluation then
		1354	$self->compile_frame ($frame, sub { $arg_self->recalculate });
922		1355
923	my $again = delete $state->{again};	1356	# clear stuff we no longer need
924		1357
925	$again->{size} = 1	1358	# unless (%{ $frame->[FR_STATE] }) {
926	if $img->repeat_mode != urxvt::RepeatNormal;	1359	# delete $self->{state};
927		1360	# delete $self->{expr};
928	if (my $again = $again->{time}) {
929	my $self = $self;
930	$state->{timer} = $again == $old->{again}
931	? $old->{timer}
932	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
933	++$self->{counter};
934	$self->recalculate
935	});
936	}	1361	# }
937		1362
938	if ($again->{position}) {	1363	# set background pixmap
939	$self->enable (position_change => sub { $_[0]->recalculate });	1364
		1365	$self->set_background ($img, $self->{border});
940	} else {	1366	} else {
941	$self->disable ("position_change");	1367	$self->clr_background;
942	}	1368	}
943		1369
944	if ($again->{size}) {
945	$self->enable (size_change => sub { $_[0]->recalculate });
946	} else {
947	$self->disable ("size_change");
948	}
949
950	if ($again->{rootpmap}) {
951	$self->enable (rootpmap_change => sub {
952	delete $_[0]{once_cache}; # this will override once-block values from
953	$_[0]->recalculate;
954	});
955	} else {
956	$self->disable ("rootpmap_change");
957	}
958
959	# clear stuff we no longer need
960
961	%$old = ();
962
963	unless (%$again) {
964	delete $self->{state};
965	delete $self->{expr};
966	}
967
968	# set background pixmap
969
970	$self->set_background ($img, $self->{border});
971	$self->scr_recolour (0);	1370	$self->scr_recolor (0);
972	$self->want_refresh;	1371	$self->want_refresh;
973	}	1372	}
974		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
975	sub on_start {	1575	sub on_start {
976	my ($self) = @_;	1576	my ($self) = @_;
977		1577
978	my $expr = $self->x_resource ("%.expr")	1578	my $expr = $self->x_resource ("%.expr");
979	or return;
980		1579
981	$self->has_render	1580	if (!$expr) {
982	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	}
983		1592
984	$self->set_expr (parse_expr $expr);	1593	$self->set_expr (parse_expr $expr);
985	$self->{border} = $self->x_resource_boolean ("%.border");	1594	$self->{border} = $self->x_resource_boolean ("%.border");
986		1595
987	$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.62 by root, Sun Jun 17 21:58:18 2012 UTC vs. Revision 1.98 by root, Tue Sep 17 20:38:14 2019 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.62 by root, Sun Jun 17 21:58:18 2012 UTC vs.
Revision 1.98 by root, Tue Sep 17 20:38:14 2019 UTC