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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.36 by root, Fri Jun 8 20:23:09 2012 UTC vs.
Revision 1.74 by root, Sat Jul 14 08:42:54 2012 UTC

…		…
1	#! perl	1	#! perl
2		2
3	#:META:X_RESOURCE:%.expr:string:background expression	3	#:META:X_RESOURCE:%.expr:string:background expression
4	#:META:X_RESOURCE:%.border.:boolean:respect the terminal border	4	#:META:X_RESOURCE:%.border:boolean:respect the terminal border
		5	#:META:X_RESOURCE:%.interval:seconds:minimum time between updates
5		6
6	#TODO: once, rootalign	7	=head1 NAME
7		8
8	=head1 background - manage terminal background	9	background - manage terminal background
9		10
10	=head2 SYNOPSIS	11	=head1 SYNOPSIS
11		12
12	urxvt --background-expr 'background expression'	13	urxvt --background-expr 'background expression'
13	--background-border	14	--background-border
		15	--background-interval seconds
14		16
15	=head2 DESCRIPTION	17	=head1 DESCRIPTION
16		18
17	This extension manages the terminal background by creating a picture that	19	This extension manages the terminal background by creating a picture that
18	is behind the text, replacing the normal background colour.	20	is behind the text, replacing the normal background colour.
19		21
20	It does so by evaluating a Perl expression that I<calculates> the image on	22	It does so by evaluating a Perl expression that I<calculates> the image on
24	to be as simple as possible.	26	to be as simple as possible.
25		27
26	For example, to load an image and scale it to the window size, you would	28	For example, to load an image and scale it to the window size, you would
27	use:	29	use:
28		30
29	urxvt --background-expr 'scale load "/path/to/mybg.png"'	31	urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }'
30		32
31	Or specified as a X resource:	33	Or specified as a X resource:
32		34
33	URxvt.background-expr: scale load "/path/to/mybg.png"	35	URxvt.background-expr: scale keep { load "/path/to/mybg.png" }
34		36
35	=head2 THEORY OF OPERATION	37	=head1 THEORY OF OPERATION
36		38
37	At startup, just before the window is mapped for the first time, the	39	At startup, just before the window is mapped for the first time, the
38	expression is evaluated and must yield an image. The image is then	40	expression is evaluated and must yield an image. The image is then
39	extended as necessary to cover the whole terminal window, and is set as a	41	extended as necessary to cover the whole terminal window, and is set as a
40	background pixmap.	42	background pixmap.
…		…
51	If any of the parameters that the expression relies on changes (when the	53	If any of the parameters that the expression relies on changes (when the
52	window is moved or resized, its position or size changes; when the root	54	window is moved or resized, its position or size changes; when the root
53	pixmap is replaced by another one the root background changes; or when the	55	pixmap is replaced by another one the root background changes; or when the
54	timer elapses), then the expression will be evaluated again.	56	timer elapses), then the expression will be evaluated again.
55		57
56	For example, an expression such as C<scale load "$HOME/mybg.png"> scales the	58	For example, an expression such as C<scale keep { load "$HOME/mybg.png"
57	image to the window size, so it relies on the window size and will	59	}> scales the image to the window size, so it relies on the window size
58	be reevaluated each time it is changed, but not when it moves for	60	and will be reevaluated each time it is changed, but not when it moves for
59	example. That ensures that the picture always fills the terminal, even	61	example. That ensures that the picture always fills the terminal, even
60	after it's size changes.	62	after its size changes.
61		63
62	=head3 EXPRESSIONS	64	=head2 EXPRESSIONS
63		65
64	Expressions are normal Perl expressions, in fact, they are Perl blocks -	66	Expressions are normal Perl expressions, in fact, they are Perl blocks -
65	which means you could use multiple lines and statements:	67	which means you could use multiple lines and statements:
66		68
		69	scale keep {
67	again 3600;	70	again 3600;
68	if (localtime now)[6]) {	71	if (localtime now)[6]) {
69	return scale load "$HOME/weekday.png";	72	return load "$HOME/weekday.png";
70	} else {	73	} else {
71	return scale load "$HOME/sunday.png";	74	return load "$HOME/sunday.png";
		75	}
72	}	76	}
73		77
74	This expression gets evaluated once per hour. It will set F<sunday.png> as	78	This inner expression is evaluated once per hour (and whenever the
		79	terminal window is resized). It sets F<sunday.png> as background on
75	background on sundays, and F<weekday.png> on all other days.	80	Sundays, and F<weekday.png> on all other days.
76		81
77	Fortunately, we expect that most expressions will be much simpler, with	82	Fortunately, we expect that most expressions will be much simpler, with
78	little Perl knowledge needed.	83	little Perl knowledge needed.
79		84
80	Basically, you always start with a function that "generates" an image	85	Basically, you always start with a function that "generates" an image
…		…
97	its result becomes the argument to the C<scale> function.	102	its result becomes the argument to the C<scale> function.
98		103
99	Many operators also allow some parameters preceding the input image	104	Many operators also allow some parameters preceding the input image
100	that modify its behaviour. For example, C<scale> without any additional	105	that modify its behaviour. For example, C<scale> without any additional
101	arguments scales the image to size of the terminal window. If you specify	106	arguments scales the image to size of the terminal window. If you specify
102	an additional argument, it uses it as a percentage:	107	an additional argument, it uses it as a scale factor (multiply by 100 to
		108	get a percentage):
103		109
104	scale 200, load "$HOME/mypic.png"	110	scale 2, load "$HOME/mypic.png"
105		111
106	This enlarges the image by a factor of 2 (200%). As you can see, C<scale>	112	This enlarges the image by a factor of 2 (200%). As you can see, C<scale>
107	has now two arguments, the C<200> and the C<load> expression, while	113	has now two arguments, the C<200> and the C<load> expression, while
108	C<load> only has one argument. Arguments are separated from each other by	114	C<load> only has one argument. Arguments are separated from each other by
109	commas.	115	commas.
110		116
111	Scale also accepts two arguments, which are then separate factors for both	117	Scale also accepts two arguments, which are then separate factors for both
112	horizontal and vertical dimensions. For example, this halves the image	118	horizontal and vertical dimensions. For example, this halves the image
113	width and doubles the image height:	119	width and doubles the image height:
114		120
115	scale 50, 200, load "$HOME/mypic.png"	121	scale 0.5, 2, load "$HOME/mypic.png"
116		122
117	TODO	123	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 again
		125	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:
118		127
119	=head3 CYCLES AND CACHING	128	scale 0.5, 2, keep { load "$HOME/mypic.png" }
120		129
121	TODO	130	The C<keep> operator executes all the statements inside the braces only
		131	once, or when it thinks the outcome might change. In other cases it
		132	returns the last value computed by the brace block.
122		133
123	Each time the expression is reevaluated, a new cycle is said to have begun. Many operators	134	This means that the C<load> is only executed once, which makes it much
124	cache their results till the next cycle. For example	135	faster, but also means that more memory is being used, because the loaded
		136	image must be kept in memory at all times. In this expression, the
		137	trade-off is likely worth it.
125		138
		139	But back to effects: Other effects than scaling are also readily
		140	available, for example, you can tile the image to fill the whole window,
		141	instead of resizing it:
		142
		143	tile keep { load "$HOME/mypic.png" }
		144
		145	In fact, images returned by C<load> are in C<tile> mode by default, so the
		146	C<tile> operator is kind of superfluous.
		147
		148	Another common effect is to mirror the image, so that the same edges
		149	touch:
		150
		151	mirror keep { load "$HOME/mypic.png" }
		152
		153	Another common background expression is:
		154
		155	rootalign root
		156
		157	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
		159	left corner of the terminal window)- the result is pseudo-transparency:
		160	the image seems to be static while the window is moved around.
		161
		162	=head2 COLOUR SPECIFICATIONS
		163
		164	Whenever an operator expects a "colour", then this can be specified in one
		165	of two ways: Either as string with an X11 colour specification, such as:
		166
		167	"red" # named colour
		168	"#f00" # simple rgb
		169	"[50]red" # red with 50% alpha
		170	"TekHVC:300/50/50" # anything goes
		171
		172	OR as an array reference with one, three or four components:
		173
		174	[0.5] # 50% gray, 100% alpha
		175	[0.5, 0, 0] # dark red, no green or blur, 100% alpha
		176	[0.5, 0, 0, 0.7] # same with explicit 70% alpha
		177
		178	=head2 CACHING AND SENSITIVITY
		179
		180	Since some operations (such as C<load> and C<blur>) can take a long time,
		181	caching results can be very important for a smooth operation. Caching can
		182	also be useful to reduce memory usage, though, for example, when an image
		183	is cached by C<load>, it could be shared by multiple terminal windows
		184	running inside urxvtd.
		185
		186	=head3 C<keep { ... }> caching
		187
		188	The most important way to cache expensive operations is to use C<keep {
		189	... }>. The C<keep> operator takes a block of multiple statements enclosed
		190	by C<{}> and keeps the return value in memory.
		191
		192	An expression can be "sensitive" to various external events, such as
		193	scaling or moving the window, root background changes and timers. Simply
		194	using an expression (such as C<scale> without parameters) that depends on
		195	certain changing values (called "variables"), or using those variables
		196	directly, will make an expression sensitive to these events - for example,
		197	using C<scale> or C<TW> will make the expression sensitive to the terminal
		198	size, and thus to resizing events.
		199
		200	When such an event happens, C<keep> will automatically trigger a
		201	reevaluation of the whole expression with the new value of the expression.
		202
		203	C<keep> is most useful for expensive operations, such as C<blur>:
		204
		205	rootalign keep { blur 20, root }
		206
		207	This makes a blurred copy of the root background once, and on subsequent
		208	calls, just root-aligns it. Since C<blur> is usually quite slow and
		209	C<rootalign> is quite fast, this trades extra memory (for the cached
		210	blurred pixmap) with speed (blur only needs to be redone when root
		211	changes).
		212
		213	=head3 C<load> caching
		214
		215	The C<load> operator itself does not keep images in memory, but as long as
		216	the image is still in memory, C<load> will use the in-memory image instead
		217	of loading it freshly from disk.
		218
		219	That means that this expression:
		220
		221	keep { load "$HOME/path..." }
		222
		223	Not only caches the image in memory, other terminal instances that try to
		224	C<load> it can reuse that in-memory copy.
		225
126	=head2 REFERENCE	226	=head1 REFERENCE
127		227
128	=head3 COMMAND LINE SWITCHES	228	=head2 COMMAND LINE SWITCHES
129		229
130	=over 4	230	=over 4
131		231
132	=item --background-expr perl-expression	232	=item --background-expr perl-expression
133		233
…		…
139	overwriting borders and any other areas, such as the scrollbar.	239	overwriting borders and any other areas, such as the scrollbar.
140		240
141	Specifying this flag changes the behaviour, so that the image only	241	Specifying this flag changes the behaviour, so that the image only
142	replaces the background of the character area.	242	replaces the background of the character area.
143		243
		244	=item --background-interval seconds
		245
		246	Since some operations in the underlying XRender extension can effectively
		247	freeze your X-server for prolonged time, this extension enforces a minimum
		248	time between updates, which is normally about 0.1 seconds.
		249
		250	If you want to do updates more often, you can decrease this safety
		251	interval with this switch.
		252
144	=back	253	=back
145		254
146	=cut	255	=cut
147		256
148	our $EXPR;#d#	257	our %_IMG_CACHE;
149	#$EXPR = 'move W * 0.1, -H * 0.1, resize W * 0.5, H * 0.5, repeat_none load "opensource.png"';
150	$EXPR = 'move -TX, -TY, load "argb.png"';
151	#$EXPR = '
152	# rotate W, H, 50, 50, counter 1/59.95, repeat_mirror,
153	# clip X, Y, W, H, repeat_mirror,
154	# load "/root/pix/das_fette_schwein.jpg"
155	#';
156	#$EXPR = 'solid "red"';
157	#$EXPR = 'blur root, 10, 10'
158	#$EXPR = 'blur move (root, -x, -y), 5, 5'
159	#resize load "/root/pix/das_fette_schwein.jpg", w, h
160
161	our $HOME;	258	our $HOME;
162	our ($self, $old, $new);	259	our ($self, $frame);
163	our ($x, $y, $w, $h);	260	our ($x, $y, $w, $h);
164		261
165	# enforce at least this interval between updates	262	# enforce at least this interval between updates
166	our $MIN_INTERVAL = 1/100;	263	our $MIN_INTERVAL = 6/59.951;
167		264
168	{	265	{
169	package urxvt::bgdsl; # background language	266	package urxvt::bgdsl; # background language
		267
		268	sub FR_PARENT() { 0 } # parent frame, if any - must be #0
		269	sub FR_CACHE () { 1 } # cached values
		270	sub FR_AGAIN () { 2 } # what this expr is sensitive to
		271	sub FR_STATE () { 3 } # watchers etc.
		272
		273	use List::Util qw(min max sum shuffle);
170		274
171	=head2 PROVIDERS/GENERATORS	275	=head2 PROVIDERS/GENERATORS
172		276
173	These functions provide an image, by loading it from disk, grabbing it	277	These functions provide an image, by loading it from disk, grabbing it
174	from the root screen or by simply generating it. They are used as starting	278	from the root screen or by simply generating it. They are used as starting
…		…
179	=item load $path	283	=item load $path
180		284
181	Loads the image at the given C<$path>. The image is set to plane tiling	285	Loads the image at the given C<$path>. The image is set to plane tiling
182	mode.	286	mode.
183		287
184	Loaded images will be cached for one cycle.	288	If the image is already in memory (e.g. because another terminal instance
		289	uses it), then the in-memory copy us returned instead.
185		290
		291	=item load_uc $path
		292
		293	Load uncached - same as load, but does not cache the image, which means it
		294	is I<always> loaded from the filesystem again, even if another copy of it
		295	is in memory at the time.
		296
186	=cut	297	=cut
		298
		299	sub load_uc($) {
		300	$self->new_img_from_file ($_[0])
		301	}
187		302
188	sub load($) {	303	sub load($) {
189	my ($path) = @_;	304	my ($path) = @_;
190		305
191	$new->{load}{$path} = $old->{load}{$path} \|\| $self->new_img_from_file ($path);	306	$_IMG_CACHE{$path} \|\| do {
		307	my $img = load_uc $path;
		308	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
		309	$img
		310	}
192	}	311	}
193		312
194	=item root	313	=item root
195		314
196	Returns the root window pixmap, that is, hopefully, the background image	315	Returns the root window pixmap, that is, hopefully, the background image
197	of your screen. The image is set to extend mode.	316	of your screen.
198		317
199	This function makes your expression root sensitive, that means it will be	318	This function makes your expression root sensitive, that means it will be
200	reevaluated when the bg image changes.	319	reevaluated when the bg image changes.
201		320
202	=cut	321	=cut
203		322
204	sub root() {	323	sub root() {
205	$new->{rootpmap_sensitive} = 1;	324	$frame->[FR_AGAIN]{rootpmap} = 1;
206	die "root op not supported, exg, we need you";	325	$self->new_img_from_root
207	}	326	}
208		327
209	=item solid $colour	328	=item solid $colour
210		329
211	=item solid $width, $height, $colour	330	=item solid $width, $height, $colour
212		331
213	Creates a new image and completely fills it with the given colour. The	332	Creates a new image and completely fills it with the given colour. The
214	image is set to tiling mode.	333	image is set to tiling mode.
215		334
216	If <$width> and C<$height> are omitted, it creates a 1x1 image, which is	335	If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is
217	useful for solid backgrounds or for use in filtering effects.	336	useful for solid backgrounds or for use in filtering effects.
218		337
219	=cut	338	=cut
220		339
221	sub solid($$;$) {	340	sub solid($;$$) {
222	my $colour = pop;	341	my $colour = pop;
223		342
224	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);	343	my $img = $self->new_img (urxvt::PictStandardARGB32, 0, 0, $_[0] \|\| 1, $_[1] \|\| 1);
225	$img->fill ($colour);	344	$img->fill ($colour);
226	$img	345	$img
227	}	346	}
228		347
229	=back	348	=item clone $img
230		349
231	=head2 VARIABLES	350	Returns an exact copy of the image. This is useful if you want to have
		351	multiple copies of the same image to apply different effects to.
232		352
233	The following functions provide variable data such as the terminal
234	window dimensions. Most of them make your expression sensitive to some
235	events, for example using C<TW> (terminal width) means your expression is
236	evaluated again when the terminal is resized.
237
238	=over 4
239
240	=item TX
241
242	=item TY
243
244	Return the X and Y coordinates of the terminal window (the terminal
245	window is the full window by default, and the character area only when in
246	border-respect mode).
247
248	Using these functions make your expression sensitive to window moves.
249
250	These functions are mainly useful to align images to the root window.
251
252	Example: load an image and align it so it looks as if anchored to the
253	background.
254
255	move -TX, -TY, load "mybg.png"
256
257	=item TW
258
259	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
260	terminal window is the full window by default, and the character area only
261	when in border-respect mode).
262
263	Using these functions make your expression sensitive to window resizes.
264
265	These functions are mainly useful to scale images, or to clip images to
266	the window size to conserve memory.
267
268	Example: take the screen background, clip it to the window size, blur it a
269	bit, align it to the window position and use it as background.
270
271	clip move -TX, -TY, blur 5, root
272
273	=cut	353	=cut
274		354
275	sub TX() { $new->{position_sensitive} = 1; $x }
276	sub TY() { $new->{position_sensitive} = 1; $y }
277	sub TW() { $new->{size_sensitive} = 1; $w }
278	sub TH() { $new->{size_sensitive} = 1; $h }
279
280	=item now
281
282	Returns the current time as (fractional) seconds since the epoch.
283
284	Using this expression does I<not> make your expression sensitive to time,
285	but the next two functions do.
286
287	=item again $seconds
288
289	When this function is used the expression will be reevaluated again in
290	C<$seconds> seconds.
291
292	Example: load some image and rotate it according to the time of day (as if it were
293	the hour pointer of a clock). Update this image every minute.
294
295	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
296
297	=item counter $seconds
298
299	Like C<again>, but also returns an increasing counter value, starting at
300	0, which might be useful for some simple animation effects.
301
302	=cut
303
304	sub now() { urxvt::NOW }
305
306	sub again($) {
307	$new->{again} = $_[0];
308	}
309
310	sub counter($) {	355	sub clone($) {
311	$new->{again} = $_[0];	356	$_[0]->clone
312	$self->{counter} + 0
313	}	357	}
314		358
315	=back	359	=item merge $img ...
		360
		361	Takes any number of images and merges them together, creating a single
		362	image containing them all. The tiling mode of the first image is used as
		363	the tiling mode of the resulting image.
		364
		365	This function is called automatically when an expression returns multiple
		366	images.
		367
		368	=cut
		369
		370	sub merge(@) {
		371	return $_[0] unless $#_;
		372
		373	# rather annoyingly clumsy, but optimisation is for another time
		374
		375	my $x0 = +1e9;
		376	my $y0 = +1e9;
		377	my $x1 = -1e9;
		378	my $y1 = -1e9;
		379
		380	for (@_) {
		381	my ($x, $y, $w, $h) = $_->geometry;
		382
		383	$x0 = $x if $x0 > $x;
		384	$y0 = $y if $y0 > $y;
		385
		386	$x += $w;
		387	$y += $h;
		388
		389	$x1 = $x if $x1 < $x;
		390	$y1 = $y if $y1 < $y;
		391	}
		392
		393	my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
		394	$base->repeat_mode ($_[0]->repeat_mode);
		395	$base->fill ([0, 0, 0, 0]);
		396
		397	$base->draw ($_)
		398	for @_;
		399
		400	$base
		401	}
316		402
317	=head2 TILING MODES	403	=head2 TILING MODES
318		404
319	The following operators modify the tiling mode of an image, that is, the	405	The following operators modify the tiling mode of an image, that is, the
320	way that pixels outside the image area are painted when the image is used.	406	way that pixels outside the image area are painted when the image is used.
…		…
350	become transparent. This mode is most useful when you want to place an	436	become transparent. This mode is most useful when you want to place an
351	image over another image or the background colour while leaving all	437	image over another image or the background colour while leaving all
352	background pixels outside the image unchanged.	438	background pixels outside the image unchanged.
353		439
354	Example: load an image and display it in the upper left corner. The rest	440	Example: load an image and display it in the upper left corner. The rest
355	of the space is left "empty" (transparent or wahtever your compisotr does	441	of the space is left "empty" (transparent or whatever your compositor does
356	in alpha mode, else background colour).	442	in alpha mode, else background colour).
357		443
358	pad load "mybg.png"	444	pad load "mybg.png"
359		445
360	=item extend $img	446	=item extend $img
361		447
362	Extends the image over the whole plane, using the closest pixel in the	448	Extends the image over the whole plane, using the closest pixel in the
363	area outside the image. This mode is mostly useful when you more complex	449	area outside the image. This mode is mostly useful when you use more complex
364	filtering operations and want the pixels outside the image to have the	450	filtering operations and want the pixels outside the image to have the
365	same values as the pixels near the edge.	451	same values as the pixels near the edge.
366		452
367	Example: just for curiosity, how does this pixel extension stuff work?	453	Example: just for curiosity, how does this pixel extension stuff work?
368		454
…		…
394	$img	480	$img
395	}	481	}
396		482
397	=back	483	=back
398		484
399	=head2 PIXEL OPERATORS	485	=head2 VARIABLE VALUES
400		486
401	The following operators modify the image pixels in various ways.	487	The following functions provide variable data such as the terminal window
		488	dimensions. They are not (Perl-) variables, they just return stuff that
		489	varies. Most of them make your expression sensitive to some events, for
		490	example using C<TW> (terminal width) means your expression is evaluated
		491	again when the terminal is resized.
402		492
403	=over 4	493	=over 4
404		494
405	=item clone $img	495	=item TX
406		496
407	Returns an exact copy of the image.	497	=item TY
408		498
409	=cut	499	Return the X and Y coordinates of the terminal window (the terminal
		500	window is the full window by default, and the character area only when in
		501	border-respect mode).
410		502
		503	Using these functions make your expression sensitive to window moves.
		504
		505	These functions are mainly useful to align images to the root window.
		506
		507	Example: load an image and align it so it looks as if anchored to the
		508	background (that's exactly what C<rootalign> does btw.):
		509
		510	move -TX, -TY, keep { load "mybg.png" }
		511
		512	=item TW
		513
		514	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
		515	terminal window is the full window by default, and the character area only
		516	when in border-respect mode).
		517
		518	Using these functions make your expression sensitive to window resizes.
		519
		520	These functions are mainly useful to scale images, or to clip images to
		521	the window size to conserve memory.
		522
		523	Example: take the screen background, clip it to the window size, blur it a
		524	bit, align it to the window position and use it as background.
		525
		526	clip move -TX, -TY, keep { blur 5, root }
		527
		528	=cut
		529
		530	sub TX() { $frame->[FR_AGAIN]{position} = 1; $x }
		531	sub TY() { $frame->[FR_AGAIN]{position} = 1; $y }
		532	sub TW() { $frame->[FR_AGAIN]{size} = 1; $w }
		533	sub TH() { $frame->[FR_AGAIN]{size} = 1; $h }
		534
		535	=item now
		536
		537	Returns the current time as (fractional) seconds since the epoch.
		538
		539	Using this expression does I<not> make your expression sensitive to time,
		540	but the next two functions do.
		541
		542	=item again $seconds
		543
		544	When this function is used the expression will be reevaluated again in
		545	C<$seconds> seconds.
		546
		547	Example: load some image and rotate it according to the time of day (as if it were
		548	the hour pointer of a clock). Update this image every minute.
		549
		550	again 60;
		551	rotate 50, 50, (now % 86400) * -72 / 8640, scale keep { load "myclock.png" }
		552
		553	=item counter $seconds
		554
		555	Like C<again>, but also returns an increasing counter value, starting at
		556	0, which might be useful for some simple animation effects.
		557
		558	=cut
		559
		560	sub now() { urxvt::NOW }
		561
		562	sub again($) {
		563	$frame->[FR_AGAIN]{time} = $_[0];
		564	}
		565
411	sub clone($) {	566	sub counter($) {
412	$_[0]->clone	567	$frame->[FR_AGAIN]{time} = $_[0];
		568	$frame->[FR_STATE]{counter} + 0
413	}	569	}
		570
		571	=back
		572
		573	=head2 SHAPE CHANGING OPERATORS
		574
		575	The following operators modify the shape, size or position of the image.
		576
		577	=over 4
414		578
415	=item clip $img	579	=item clip $img
416		580
417	=item clip $width, $height, $img	581	=item clip $width, $height, $img
418		582
…		…
429	assumed.	593	assumed.
430		594
431	Example: load an image, blur it, and clip it to the window size to save	595	Example: load an image, blur it, and clip it to the window size to save
432	memory.	596	memory.
433		597
434	clip blur 10, load "mybg.png"	598	clip keep { blur 10, load "mybg.png" }
435		599
436	=cut	600	=cut
437		601
438	sub clip($;$$;$$) {	602	sub clip($;$$;$$) {
439	my $img = pop;	603	my $img = pop;
…		…
442	$img->sub_rect ($_[0], $_[1], $w, $h)	606	$img->sub_rect ($_[0], $_[1], $w, $h)
443	}	607	}
444		608
445	=item scale $img	609	=item scale $img
446		610
447	=item scale $size_percent, $img	611	=item scale $size_factor, $img
448		612
449	=item scale $width_percent, $height_percent, $img	613	=item scale $width_factor, $height_factor, $img
450		614
451	Scales the image by the given percentages in horizontal	615	Scales the image by the given factors in horizontal
452	(C<$width_percent>) and vertical (C<$height_percent>) direction.	616	(C<$width>) and vertical (C<$height>) direction.
453		617
454	If only one percentage is give, it is used for both directions.	618	If only one factor is give, it is used for both directions.
455		619
456	If no percentages are given, scales the image to the window size without	620	If no factors are given, scales the image to the window size without
457	keeping aspect.	621	keeping aspect.
458		622
459	=item resize $width, $height, $img	623	=item resize $width, $height, $img
460		624
461	Resizes the image to exactly C<$width> times C<$height> pixels.	625	Resizes the image to exactly C<$width> times C<$height> pixels.
462		626
463	=cut	627	=item fit $img
464		628
465	#TODO: maximise, maximise_fill?	629	=item fit $width, $height, $img
		630
		631	Fits the image into the given C<$width> and C<$height> without changing
		632	aspect, or the terminal size. That means it will be shrunk or grown until
		633	the whole image fits into the given area, possibly leaving borders.
		634
		635	=item cover $img
		636
		637	=item cover $width, $height, $img
		638
		639	Similar to C<fit>, but shrinks or grows until all of the area is covered
		640	by the image, so instead of potentially leaving borders, it will cut off
		641	image data that doesn't fit.
		642
		643	=cut
466		644
467	sub scale($;$;$) {	645	sub scale($;$;$) {
468	my $img = pop;	646	my $img = pop;
469		647
470	@_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01)	648	@_ == 2 ? $img->scale ($_[0] * $img->w, $_[1] * $img->h)
471	: @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01)	649	: @_ ? $img->scale ($_[0] * $img->w, $_[0] * $img->h)
472	: $img->scale (TW, TH)	650	: $img->scale (TW, TH)
473	}	651	}
474		652
475	sub resize($$$) {	653	sub resize($$$) {
476	my $img = pop;	654	my $img = pop;
477	$img->scale ($_[0], $_[1])	655	$img->scale ($_[0], $_[1])
478	}	656	}
479		657
		658	sub fit($;$$) {
		659	my $img = pop;
		660	my $w = ($_[0] \|\| TW) / $img->w;
		661	my $h = ($_[1] \|\| TH) / $img->h;
		662	scale +(min $w, $h), $img
		663	}
		664
		665	sub cover($;$$) {
		666	my $img = pop;
		667	my $w = ($_[0] \|\| TW) / $img->w;
		668	my $h = ($_[1] \|\| TH) / $img->h;
		669	scale +(max $w, $h), $img
		670	}
		671
480	=item move $dx, $dy, $img	672	=item move $dx, $dy, $img
481		673
482	Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in	674	Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in
483	the vertical.	675	the vertical.
484		676
485	Example: move the image right by 20 pixels and down by 30.	677	Example: move the image right by 20 pixels and down by 30.
486		678
487	move 20, 30, ...	679	move 20, 30, ...
		680
		681	=item align $xalign, $yalign, $img
		682
		683	Aligns the image according to a factor - C<0> means the image is moved to
		684	the left or top edge (for C<$xalign> or C<$yalign>), C<0.5> means it is
		685	exactly centered and C<1> means it touches the right or bottom edge.
		686
		687	Example: remove any visible border around an image, center it vertically but move
		688	it to the right hand side.
		689
		690	align 1, 0.5, pad $img
		691
		692	=item center $img
		693
		694	=item center $width, $height, $img
		695
		696	Centers the image, i.e. the center of the image is moved to the center of
		697	the terminal window (or the box specified by C<$width> and C<$height> if
		698	given).
		699
		700	Example: load an image and center it.
		701
		702	center keep { pad load "mybg.png" }
488		703
489	=item rootalign $img	704	=item rootalign $img
490		705
491	Moves the image so that it appears glued to the screen as opposed to the	706	Moves the image so that it appears glued to the screen as opposed to the
492	window. This gives the illusion of a larger area behind the window. It is	707	window. This gives the illusion of a larger area behind the window. It is
493	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the	708	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
494	top left of the screen.	709	top left of the screen.
495		710
496	Example: load a background image, put it in mirror mode and root align it.	711	Example: load a background image, put it in mirror mode and root align it.
497		712
498	rootalign mirror load "mybg.png"	713	rootalign keep { mirror load "mybg.png" }
499		714
500	Example: take the screen background and align it, giving the illusion of	715	Example: take the screen background and align it, giving the illusion of
501	transparency as long as the window isn't in front of other windows.	716	transparency as long as the window isn't in front of other windows.
502		717
503	rootalign root	718	rootalign root
504		719
505	=cut	720	=cut
506		721
507	sub move($$;$) {	722	sub move($$;$) {
508	my $img = pop->clone;	723	my $img = pop->clone;
509	$img->move ($_[0], $_[1]);	724	$img->move ($_[0], $_[1]);
510	$img	725	$img
511	}	726	}
512		727
		728	sub align($;$$) {
		729	my $img = pop;
		730
		731	move $_[0] * (TW - $img->w),
		732	$_[1] * (TH - $img->h),
		733	$img
		734	}
		735
		736	sub center($;$$) {
		737	my $img = pop;
		738	my $w = $_[0] \|\| TW;
		739	my $h = $_[1] \|\| TH;
		740
		741	move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img
		742	}
		743
513	sub rootalign($) {	744	sub rootalign($) {
514	move -TX, -TY, $_[0]	745	move -TX, -TY, $_[0]
515	}	746	}
516		747
		748	=item rotate $center_x, $center_y, $degrees, $img
		749
		750	Rotates the image clockwise by C<$degrees> degrees, around the point at
		751	C<$center_x> and C<$center_y> (specified as factor of image width/height).
		752
		753	Example: rotate the image by 90 degrees around it's center.
		754
		755	rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
		756
		757	=cut
		758
		759	sub rotate($$$$) {
		760	my $img = pop;
		761	$img->rotate (
		762	$_[0] * ($img->w + $img->x),
		763	$_[1] * ($img->h + $img->y),
		764	$_[2] * (3.14159265 / 180),
		765	)
		766	}
		767
		768	=back
		769
		770	=head2 COLOUR MODIFICATIONS
		771
		772	The following operators change the pixels of the image.
		773
		774	=over 4
		775
		776	=item tint $color, $img
		777
		778	Tints the image in the given colour.
		779
		780	Example: tint the image red.
		781
		782	tint "red", load "rgb.png"
		783
		784	Example: the same, but specify the colour by component.
		785
		786	tint [1, 0, 0], load "rgb.png"
		787
		788	=cut
		789
		790	sub tint($$) {
		791	$_[1]->tint ($_[0])
		792	}
		793
517	=item contrast $factor, $img	794	=item contrast $factor, $img
518		795
519	=item contrast $r, $g, $b, $img	796	=item contrast $r, $g, $b, $img
520		797
521	=item contrast $r, $g, $b, $a, $img	798	=item contrast $r, $g, $b, $a, $img
522		799
523	Adjusts the I<contrast> of an image.	800	Adjusts the I<contrast> of an image.
524		801
		802	The first form applies a single C<$factor> to red, green and blue, the
		803	second form applies separate factors to each colour channel, and the last
		804	form includes the alpha channel.
		805
		806	Values from 0 to 1 lower the contrast, values higher than 1 increase the
		807	contrast.
		808
		809	Due to limitations in the underlying XRender extension, lowering contrast
		810	also reduces brightness, while increasing contrast currently also
		811	increases brightness.
		812
525	=item brightness $factor, $img	813	=item brightness $bias, $img
526		814
527	=item brightness $r, $g, $b, $img	815	=item brightness $r, $g, $b, $img
528		816
529	=item brightness $r, $g, $b, $a, $img	817	=item brightness $r, $g, $b, $a, $img
		818
		819	Adjusts the brightness of an image.
		820
		821	The first form applies a single C<$bias> to red, green and blue, the
		822	second form applies separate biases to each colour channel, and the last
		823	form includes the alpha channel.
		824
		825	Values less than 0 reduce brightness, while values larger than 0 increase
		826	it. Useful range is from -1 to 1 - the former results in a black, the
		827	latter in a white picture.
		828
		829	Due to idiosyncrasies in the underlying XRender extension, biases less
		830	than zero can be I<very> slow.
530		831
531	=cut	832	=cut
532		833
533	sub contrast($$;$$;$) {	834	sub contrast($$;$$;$) {
534	my $img = pop;	835	my $img = pop;
535	my ($r, $g, $b, $a) = @_;	836	my ($r, $g, $b, $a) = @_;
536		837
537	($g, $b) = ($r, $r) if @_ < 4;	838	($g, $b) = ($r, $r) if @_ < 3;
538	$a = 1 if @_ < 5;	839	$a = 1 if @_ < 4;
539		840
540	$img = $img->clone;	841	$img = $img->clone;
541	# $img->contrast ($r, $g, $b, $a);	842	$img->contrast ($r, $g, $b, $a);
542	$img	843	$img
543	}	844	}
544		845
545	sub brightness($$;$$;$) {	846	sub brightness($$;$$;$) {
546	my $img = pop;	847	my $img = pop;
547	my ($r, $g, $b, $a) = @_;	848	my ($r, $g, $b, $a) = @_;
548		849
549	($g, $b) = ($r, $r) if @_ < 4;	850	($g, $b) = ($r, $r) if @_ < 3;
550	$a = 1 if @_ < 5;	851	$a = 1 if @_ < 4;
551		852
552	$img = $img->clone;	853	$img = $img->clone;
553	$img->brightness ($r, $g, $b, $a);	854	$img->brightness ($r, $g, $b, $a);
554	$img	855	$img
555	}	856	}
556		857
		858	=item blur $radius, $img
		859
		860	=item blur $radius_horz, $radius_vert, $img
		861
		862	Gaussian-blurs the image with (roughly) C<$radius> pixel radius. The radii
		863	can also be specified separately.
		864
		865	Blurring is often I<very> slow, at least compared or other
		866	operators. Larger blur radii are slower than smaller ones, too, so if you
		867	don't want to freeze your screen for long times, start experimenting with
		868	low values for radius (<5).
		869
		870	=cut
		871
557	sub blur($$;$) {	872	sub blur($$;$) {
558	my $img = pop;	873	my $img = pop;
559	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	874	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
560	}	875	}
561		876
562	sub rotate($$$$$$) {
563	my $img = pop;
564	$img->rotate (
565	$_[0],
566	$_[1],
567	$_[2] * $img->w * .01,
568	$_[3] * $img->h * .01,
569	$_[4] * (3.14159265 / 180),
570	)
571	}
572
573	=back	877	=back
574		878
		879	=head2 OTHER STUFF
		880
		881	Anything that didn't fit any of the other categories, even after applying
		882	force and closing our eyes.
		883
		884	=over 4
		885
		886	=item keep { ... }
		887
		888	This operator takes a code block as argument, that is, one or more
		889	statements enclosed by braces.
		890
		891	The trick is that this code block is only evaluated when the outcome
		892	changes - on other calls the C<keep> simply returns the image it computed
		893	previously (yes, it should only be used with images). Or in other words,
		894	C<keep> I<caches> the result of the code block so it doesn't need to be
		895	computed again.
		896
		897	This can be extremely useful to avoid redoing slow operations - for
		898	example, if your background expression takes the root background, blurs it
		899	and then root-aligns it it would have to blur the root background on every
		900	window move or resize.
		901
		902	Another example is C<load>, which can be quite slow.
		903
		904	In fact, urxvt itself encloses the whole expression in some kind of
		905	C<keep> block so it only is reevaluated as required.
		906
		907	Putting the blur into a C<keep> block will make sure the blur is only done
		908	once, while the C<rootalign> is still done each time the window moves.
		909
		910	rootalign keep { blur 10, root }
		911
		912	This leaves the question of how to force reevaluation of the block,
		913	in case the root background changes: If expression inside the block
		914	is sensitive to some event (root background changes, window geometry
		915	changes), then it will be reevaluated automatically as needed.
		916
		917	=cut
		918
		919	sub keep(&) {
		920	my $id = $_[0]+0;
		921
		922	local $frame = $self->{frame_cache}{$id} \|\|= [$frame];
		923
		924	unless ($frame->[FR_CACHE]) {
		925	$frame->[FR_CACHE] = [ $_[0]() ];
		926
		927	my $self = $self;
		928	my $frame = $frame;
		929	Scalar::Util::weaken $frame;
		930	$self->compile_frame ($frame, sub {
		931	# clear this frame cache, also for all parents
		932	for (my $frame = $frame; $frame; $frame = $frame->[0]) {
		933	undef $frame->[FR_CACHE];
		934	}
		935
		936	$self->recalculate;
		937	});
		938	};
		939
		940	# in scalar context we always return the first original result, which
		941	# is not quite how perl works.
		942	wantarray
		943	? @{ $frame->[FR_CACHE] }
		944	: $frame->[FR_CACHE][0]
		945	}
		946
		947	# sub keep_clear() {
		948	# delete $self->{frame_cache};
		949	# }
		950
		951	=back
		952
575	=cut	953	=cut
576		954
577	}	955	}
578		956
579	sub parse_expr {	957	sub parse_expr {
580	my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}";	958	my $expr = eval
		959	"sub {\n"
		960	. "package urxvt::bgdsl;\n"
		961	. "#line 0 'background expression'\n"
		962	. "$_[0]\n"
		963	. "}";
581	die if $@;	964	die if $@;
582	$expr	965	$expr
583	}	966	}
584		967
585	# compiles a parsed expression	968	# compiles a parsed expression
586	sub set_expr {	969	sub set_expr {
587	my ($self, $expr) = @_;	970	my ($self, $expr) = @_;
588		971
		972	$self->{root} = []; # the outermost frame
589	$self->{expr} = $expr;	973	$self->{expr} = $expr;
590	$self->recalculate;	974	$self->recalculate;
		975	}
		976
		977	# takes a hash of sensitivity indicators and installs watchers
		978	sub compile_frame {
		979	my ($self, $frame, $cb) = @_;
		980
		981	my $state = $frame->[urxvt::bgdsl::FR_STATE] \|\|= {};
		982	my $again = $frame->[urxvt::bgdsl::FR_AGAIN];
		983
		984	# don't keep stuff alive
		985	Scalar::Util::weaken $state;
		986
		987	if ($again->{nested}) {
		988	$state->{nested} = 1;
		989	} else {
		990	delete $state->{nested};
		991	}
		992
		993	if (my $interval = $again->{time}) {
		994	$state->{time} = [$interval, urxvt::timer->new->after ($interval)->interval ($interval)]
		995	if $state->{time}[0] != $interval;
		996
		997	# callback might have changed, although we could just rule that out
		998	$state->{time}[1]->cb (sub {
		999	++$state->{counter};
		1000	$cb->();
		1001	});
		1002	} else {
		1003	delete $state->{time};
		1004	}
		1005
		1006	if ($again->{position}) {
		1007	$state->{position} = $self->on (position_change => $cb);
		1008	} else {
		1009	delete $state->{position};
		1010	}
		1011
		1012	if ($again->{size}) {
		1013	$state->{size} = $self->on (size_change => $cb);
		1014	} else {
		1015	delete $state->{size};
		1016	}
		1017
		1018	if ($again->{rootpmap}) {
		1019	$state->{rootpmap} = $self->on (rootpmap_change => $cb);
		1020	} else {
		1021	delete $state->{rootpmap};
		1022	}
591	}	1023	}
592		1024
593	# evaluate the current bg expression	1025	# evaluate the current bg expression
594	sub recalculate {	1026	sub recalculate {
595	my ($arg_self) = @_;	1027	my ($arg_self) = @_;
…		…
605		1037
606	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	1038	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
607		1039
608	# set environment to evaluate user expression	1040	# set environment to evaluate user expression
609		1041
610	local $self = $arg_self;	1042	local $self = $arg_self;
611
612	local $HOME = $ENV{HOME};	1043	local $HOME = $ENV{HOME};
613	local $old = $self->{state};	1044	local $frame = $self->{root};
614	local $new = my $state = $self->{state} = {};
615		1045
616	($x, $y, $w, $h) =
617	$self->background_geometry ($self->{border});	1046	($x, $y, $w, $h) = $self->background_geometry ($self->{border});
618		1047
619	# evaluate user expression	1048	# evaluate user expression
620		1049
621	my $img = eval { $self->{expr}->() };	1050	my @img = eval { $self->{expr}->() };
622	warn $@ if $@;#d#	1051	die $@ if $@;
		1052	die "background-expr did not return anything.\n" unless @img;
		1053	die "background-expr: expected image(s), got something else.\n"
623	die if !UNIVERSAL::isa $img, "urxvt::img";	1054	if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;
624		1055
625	$state->{size_sensitive} = 1	1056	my $img = urxvt::bgdsl::merge @img;
		1057
		1058	$frame->[FR_AGAIN]{size} = 1
626	if $img->repeat_mode != urxvt::RepeatNormal;	1059	if $img->repeat_mode != urxvt::RepeatNormal;
627		1060
628	# if the expression is sensitive to external events, prepare reevaluation then	1061	# if the expression is sensitive to external events, prepare reevaluation then
629		1062	$self->compile_frame ($frame, sub { $arg_self->recalculate });
630	my $repeat;
631
632	if (my $again = $state->{again}) {
633	$repeat = 1;
634	my $self = $self;
635	$state->{timer} = $again == $old->{again}
636	? $old->{timer}
637	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
638	++$self->{counter};
639	$self->recalculate
640	});
641	}
642
643	if (delete $state->{position_sensitive}) {
644	$repeat = 1;
645	$self->enable (position_change => sub { $_[0]->recalculate });
646	} else {
647	$self->disable ("position_change");
648	}
649
650	if (delete $state->{size_sensitive}) {
651	$repeat = 1;
652	$self->enable (size_change => sub { $_[0]->recalculate });
653	} else {
654	$self->disable ("size_change");
655	}
656
657	if (delete $state->{rootpmap_sensitive}) {
658	$repeat = 1;
659	$self->enable (rootpmap_change => sub { $_[0]->recalculate });
660	} else {
661	$self->disable ("rootpmap_change");
662	}
663		1063
664	# clear stuff we no longer need	1064	# clear stuff we no longer need
665		1065
666	%$old = ();	1066	# unless (%{ $frame->[FR_STATE] }) {
667
668	unless ($repeat) {
669	delete $self->{state};	1067	# delete $self->{state};
670	delete $self->{expr};	1068	# delete $self->{expr};
671	}	1069	# }
672		1070
673	# set background pixmap	1071	# set background pixmap
674		1072
675	$self->set_background ($img, $self->{border});	1073	$self->set_background ($img, $self->{border});
676	$self->scr_recolour (0);	1074	$self->scr_recolour (0);
…		…
678	}	1076	}
679		1077
680	sub on_start {	1078	sub on_start {
681	my ($self) = @_;	1079	my ($self) = @_;
682		1080
683	my $expr = $self->x_resource ("background.expr")	1081	my $expr = $self->x_resource ("%.expr")
684	or return;	1082	or return;
685		1083
		1084	$self->has_render
		1085	or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
		1086
686	$self->set_expr (parse_expr $expr);	1087	$self->set_expr (parse_expr $expr);
687	$self->{border} = $self->x_resource_boolean ("background.border");	1088	$self->{border} = $self->x_resource_boolean ("%.border");
		1089
		1090	$MIN_INTERVAL = $self->x_resource ("%.interval");
688		1091
689	()	1092	()
690	}	1093	}
691		1094

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.36 by root, Fri Jun 8 20:23:09 2012 UTC vs. Revision 1.74 by root, Sat Jul 14 08:42:54 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.36 by root, Fri Jun 8 20:23:09 2012 UTC vs.
Revision 1.74 by root, Sat Jul 14 08:42:54 2012 UTC