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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.44 by root, Sun Jun 10 11:31:22 2012 UTC vs.
Revision 1.62 by root, Sun Jun 17 21:58:18 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		5	#:META:X_RESOURCE:%.interval:seconds:minimum time between updates
6	#TODO: once, rootalign
7		6
8	=head1 NAME	7	=head1 NAME
9		8
10	background - manage terminal background	9	background - manage terminal background
11		10
12	=head1 SYNOPSIS	11	=head1 SYNOPSIS
13		12
14	urxvt --background-expr 'background expression'	13	urxvt --background-expr 'background expression'
15	--background-border	14	--background-border
		15	--background-interval seconds
16		16
17	=head1 DESCRIPTION	17	=head1 DESCRIPTION
18		18
19	This extension manages the terminal background by creating a picture that	19	This extension manages the terminal background by creating a picture that
20	is behind the text, replacing the normal background colour.	20	is behind the text, replacing the normal background colour.
57		57
58	For example, an expression such as C<scale load "$HOME/mybg.png"> scales the	58	For example, an expression such as C<scale load "$HOME/mybg.png"> scales the
59	image to the window size, so it relies on the window size and will	59	image to the window size, so it relies on the window size and will
60	be reevaluated each time it is changed, but not when it moves for	60	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	61	example. That ensures that the picture always fills the terminal, even
62	after it's size changes.	62	after its size changes.
63		63
64	=head2 EXPRESSIONS	64	=head2 EXPRESSIONS
65		65
66	Expressions are normal Perl expressions, in fact, they are Perl blocks -	66	Expressions are normal Perl expressions, in fact, they are Perl blocks -
67	which means you could use multiple lines and statements:	67	which means you could use multiple lines and statements:
…		…
71	return scale load "$HOME/weekday.png";	71	return scale load "$HOME/weekday.png";
72	} else {	72	} else {
73	return scale load "$HOME/sunday.png";	73	return scale load "$HOME/sunday.png";
74	}	74	}
75		75
76	This expression gets evaluated once per hour. It will set F<sunday.png> as	76	This expression is evaluated once per hour. It will set F<sunday.png> as
77	background on Sundays, and F<weekday.png> on all other days.	77	background on Sundays, and F<weekday.png> on all other days.
78		78
79	Fortunately, we expect that most expressions will be much simpler, with	79	Fortunately, we expect that most expressions will be much simpler, with
80	little Perl knowledge needed.	80	little Perl knowledge needed.
81		81
…		…
115	horizontal and vertical dimensions. For example, this halves the image	115	horizontal and vertical dimensions. For example, this halves the image
116	width and doubles the image height:	116	width and doubles the image height:
117		117
118	scale 0.5, 2, load "$HOME/mypic.png"	118	scale 0.5, 2, load "$HOME/mypic.png"
119		119
120	Other effects than scalign are also readily available, for exmaple, you can	120	Other effects than scaling are also readily available, for example, you can
121	tile the image to fill the whole window, instead of resizing it:	121	tile the image to fill the whole window, instead of resizing it:
122		122
123	tile load "$HOME/mypic.png"	123	tile load "$HOME/mypic.png"
124		124
125	In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator	125	In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator
…		…
151	This only works for one cycle though, so as long as you load the same	151	This only works for one cycle though, so as long as you load the same
152	image every time, it will always be cached, but when you load a different	152	image every time, it will always be cached, but when you load a different
153	image, it will forget about the first one.	153	image, it will forget about the first one.
154		154
155	This allows you to either speed things up by keeping multiple images in	155	This allows you to either speed things up by keeping multiple images in
156	memory, or comserve memory by loading images more often.	156	memory, or conserve memory by loading images more often.
157		157
158	For example, you can keep two images in memory and use a random one like	158	For example, you can keep two images in memory and use a random one like
159	this:	159	this:
160		160
161	my $img1 = load "img1.png";	161	my $img1 = load "img1.png";
…		…
189	overwriting borders and any other areas, such as the scrollbar.	189	overwriting borders and any other areas, such as the scrollbar.
190		190
191	Specifying this flag changes the behaviour, so that the image only	191	Specifying this flag changes the behaviour, so that the image only
192	replaces the background of the character area.	192	replaces the background of the character area.
193		193
		194	=item --background-interval seconds
		195
		196	Since some operations in the underlying XRender extension can effectively
		197	freeze your X-server for prolonged time, this extension enforces a minimum
		198	time between updates, which is normally about 0.1 seconds.
		199
		200	If you want to do updates more often, you can decrease this safety
		201	interval with this switch.
		202
194	=back	203	=back
195		204
196	=cut	205	=cut
197		206
		207	our %_IMG_CACHE;
198	our $HOME;	208	our $HOME;
199	our ($self, $old, $new);	209	our ($self, $old, $new);
200	our ($x, $y, $w, $h);	210	our ($x, $y, $w, $h);
201		211
202	# enforce at least this interval between updates	212	# enforce at least this interval between updates
203	our $MIN_INTERVAL = 1/100;	213	our $MIN_INTERVAL = 6/59.951;
204		214
205	{	215	{
206	package urxvt::bgdsl; # background language	216	package urxvt::bgdsl; # background language
207		217
208	use List::Util qw(min max sum shuffle);	218	use List::Util qw(min max sum shuffle);
…		…
218	=item load $path	228	=item load $path
219		229
220	Loads the image at the given C<$path>. The image is set to plane tiling	230	Loads the image at the given C<$path>. The image is set to plane tiling
221	mode.	231	mode.
222		232
223	Loaded images will be cached for one cycle.	233	Loaded images will be cached for one cycle, and shared between temrinals
		234	running in the same process (e.g. in C<urxvtd>).
224		235
		236	=item load_uc $path
		237
		238	Load uncached - same as load, but does not cache the image. This function
		239	is most useufl if you want to optimise a background expression in some
		240	way.
		241
225	=cut	242	=cut
		243
		244	sub load_uc($) {
		245	my ($path) = @_;
		246
		247	$_IMG_CACHE{$path} \|\| do {
		248	my $img = $self->new_img_from_file ($path);
		249	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
		250	$img
		251	}
		252	}
226		253
227	sub load($) {	254	sub load($) {
228	my ($path) = @_;	255	my ($path) = @_;
229		256
230	$new->{load}{$path} = $old->{load}{$path} \|\| $self->new_img_from_file ($path);	257	$new->{load}{$path} = $old->{load}{$path} \|\| load_uc $path;
231	}	258	}
232		259
233	=item root	260	=item root
234		261
235	Returns the root window pixmap, that is, hopefully, the background image	262	Returns the root window pixmap, that is, hopefully, the background image
236	of your screen. The image is set to extend mode.	263	of your screen.
237		264
238	This function makes your expression root sensitive, that means it will be	265	This function makes your expression root sensitive, that means it will be
239	reevaluated when the bg image changes.	266	reevaluated when the bg image changes.
240		267
241	=cut	268	=cut
242		269
243	sub root() {	270	sub root() {
244	$new->{rootpmap_sensitive} = 1;	271	$new->{again}{rootpmap} = 1;
245	die "root op not supported, exg, we need you";	272	$self->new_img_from_root
246	}	273	}
247		274
248	=item solid $colour	275	=item solid $colour
249		276
250	=item solid $width, $height, $colour	277	=item solid $width, $height, $colour
…		…
258	=cut	285	=cut
259		286
260	sub solid($;$$) {	287	sub solid($;$$) {
261	my $colour = pop;	288	my $colour = pop;
262		289
263	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);	290	my $img = $self->new_img (urxvt::PictStandardARGB32, 0, 0, $_[0] \|\| 1, $_[1] \|\| 1);
264	$img->fill ($colour);	291	$img->fill ($colour);
265	$img	292	$img
266	}	293	}
267		294
268	=back	295	=item clone $img
269		296
270	=head2 VARIABLES	297	Returns an exact copy of the image. This is useful if you want to have
		298	multiple copies of the same image to apply different effects to.
271		299
272	The following functions provide variable data such as the terminal window
273	dimensions. They are not (Perl-) variables, they jsut return stuff that
274	varies. Most of them make your expression sensitive to some events, for
275	example using C<TW> (terminal width) means your expression is evaluated
276	again when the terminal is resized.
277
278	=over 4
279
280	=item TX
281
282	=item TY
283
284	Return the X and Y coordinates of the terminal window (the terminal
285	window is the full window by default, and the character area only when in
286	border-respect mode).
287
288	Using these functions make your expression sensitive to window moves.
289
290	These functions are mainly useful to align images to the root window.
291
292	Example: load an image and align it so it looks as if anchored to the
293	background.
294
295	move -TX, -TY, load "mybg.png"
296
297	=item TW
298
299	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
300	terminal window is the full window by default, and the character area only
301	when in border-respect mode).
302
303	Using these functions make your expression sensitive to window resizes.
304
305	These functions are mainly useful to scale images, or to clip images to
306	the window size to conserve memory.
307
308	Example: take the screen background, clip it to the window size, blur it a
309	bit, align it to the window position and use it as background.
310
311	clip move -TX, -TY, blur 5, root
312
313	=cut	300	=cut
314		301
315	sub TX() { $new->{position_sensitive} = 1; $x }
316	sub TY() { $new->{position_sensitive} = 1; $y }
317	sub TW() { $new->{size_sensitive} = 1; $w }
318	sub TH() { $new->{size_sensitive} = 1; $h }
319
320	=item now
321
322	Returns the current time as (fractional) seconds since the epoch.
323
324	Using this expression does I<not> make your expression sensitive to time,
325	but the next two functions do.
326
327	=item again $seconds
328
329	When this function is used the expression will be reevaluated again in
330	C<$seconds> seconds.
331
332	Example: load some image and rotate it according to the time of day (as if it were
333	the hour pointer of a clock). Update this image every minute.
334
335	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
336
337	=item counter $seconds
338
339	Like C<again>, but also returns an increasing counter value, starting at
340	0, which might be useful for some simple animation effects.
341
342	=cut
343
344	sub now() { urxvt::NOW }
345
346	sub again($) {
347	$new->{again} = $_[0];
348	}
349
350	sub counter($) {	302	sub clone($) {
351	$new->{again} = $_[0];	303	$_[0]->clone
352	$self->{counter} + 0
353	}	304	}
354		305
355	=back	306	=item merge $img ...
		307
		308	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
		310	the tiling mdoe of the resulting image.
		311
		312	This function is called automatically when an expression returns multiple
		313	images.
		314
		315	=cut
		316
		317	sub merge(@) {
		318	return $_[0] unless $#_;
		319
		320	# rather annoyingly clumsy, but optimisation is for another time
		321
		322	my $x0 = +1e9;
		323	my $y0 = +1e9;
		324	my $x1 = -1e9;
		325	my $y1 = -1e9;
		326
		327	for (@_) {
		328	my ($x, $y, $w, $h) = $_->geometry;
		329
		330	$x0 = $x if $x0 > $x;
		331	$y0 = $y if $y0 > $y;
		332
		333	$x += $w;
		334	$y += $h;
		335
		336	$x1 = $x if $x1 < $x;
		337	$y1 = $y if $y1 < $y;
		338	}
		339
		340	my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
		341	$base->repeat_mode ($_[0]->repeat_mode);
		342	$base->fill ([0, 0, 0, 0]);
		343
		344	$base->draw ($_)
		345	for @_;
		346
		347	$base
		348	}
356		349
357	=head2 TILING MODES	350	=head2 TILING MODES
358		351
359	The following operators modify the tiling mode of an image, that is, the	352	The following operators modify the tiling mode of an image, that is, the
360	way that pixels outside the image area are painted when the image is used.	353	way that pixels outside the image area are painted when the image is used.
…		…
390	become transparent. This mode is most useful when you want to place an	383	become transparent. This mode is most useful when you want to place an
391	image over another image or the background colour while leaving all	384	image over another image or the background colour while leaving all
392	background pixels outside the image unchanged.	385	background pixels outside the image unchanged.
393		386
394	Example: load an image and display it in the upper left corner. The rest	387	Example: load an image and display it in the upper left corner. The rest
395	of the space is left "empty" (transparent or wahtever your compisotr does	388	of the space is left "empty" (transparent or whatever your compositor does
396	in alpha mode, else background colour).	389	in alpha mode, else background colour).
397		390
398	pad load "mybg.png"	391	pad load "mybg.png"
399		392
400	=item extend $img	393	=item extend $img
401		394
402	Extends the image over the whole plane, using the closest pixel in the	395	Extends the image over the whole plane, using the closest pixel in the
403	area outside the image. This mode is mostly useful when you more complex	396	area outside the image. This mode is mostly useful when you use more complex
404	filtering operations and want the pixels outside the image to have the	397	filtering operations and want the pixels outside the image to have the
405	same values as the pixels near the edge.	398	same values as the pixels near the edge.
406		399
407	Example: just for curiosity, how does this pixel extension stuff work?	400	Example: just for curiosity, how does this pixel extension stuff work?
408		401
…		…
434	$img	427	$img
435	}	428	}
436		429
437	=back	430	=back
438		431
439	=head2 PIXEL OPERATORS	432	=head2 VARIABLE VALUES
440		433
441	The following operators modify the image pixels in various ways.	434	The following functions provide variable data such as the terminal window
		435	dimensions. They are not (Perl-) variables, they just return stuff that
		436	varies. Most of them make your expression sensitive to some events, for
		437	example using C<TW> (terminal width) means your expression is evaluated
		438	again when the terminal is resized.
442		439
443	=over 4	440	=over 4
444		441
445	=item clone $img	442	=item TX
446		443
447	Returns an exact copy of the image.	444	=item TY
448		445
449	=cut	446	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
		448	border-respect mode).
450		449
		450	Using these functions make your expression sensitive to window moves.
		451
		452	These functions are mainly useful to align images to the root window.
		453
		454	Example: load an image and align it so it looks as if anchored to the
		455	background.
		456
		457	move -TX, -TY, load "mybg.png"
		458
		459	=item TW
		460
		461	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
		463	when in border-respect mode).
		464
		465	Using these functions make your expression sensitive to window resizes.
		466
		467	These functions are mainly useful to scale images, or to clip images to
		468	the window size to conserve memory.
		469
		470	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.
		472
		473	clip move -TX, -TY, once { blur 5, root }
		474
		475	=cut
		476
		477	sub TX() { $new->{again}{position} = 1; $x }
		478	sub TY() { $new->{again}{position} = 1; $y }
		479	sub TW() { $new->{again}{size} = 1; $w }
		480	sub TH() { $new->{again}{size} = 1; $h }
		481
		482	=item now
		483
		484	Returns the current time as (fractional) seconds since the epoch.
		485
		486	Using this expression does I<not> make your expression sensitive to time,
		487	but the next two functions do.
		488
		489	=item again $seconds
		490
		491	When this function is used the expression will be reevaluated again in
		492	C<$seconds> seconds.
		493
		494	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.
		496
		497	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
		498
		499	=item counter $seconds
		500
		501	Like C<again>, but also returns an increasing counter value, starting at
		502	0, which might be useful for some simple animation effects.
		503
		504	=cut
		505
		506	sub now() { urxvt::NOW }
		507
		508	sub again($) {
		509	$new->{again}{time} = $_[0];
		510	}
		511
451	sub clone($) {	512	sub counter($) {
452	$_[0]->clone	513	$new->{again}{time} = $_[0];
		514	$self->{counter} + 0
453	}	515	}
		516
		517	=back
		518
		519	=head2 SHAPE CHANGING OPERATORS
		520
		521	The following operators modify the shape, size or position of the image.
		522
		523	=over 4
454		524
455	=item clip $img	525	=item clip $img
456		526
457	=item clip $width, $height, $img	527	=item clip $width, $height, $img
458		528
…		…
552		622
553	Example: move the image right by 20 pixels and down by 30.	623	Example: move the image right by 20 pixels and down by 30.
554		624
555	move 20, 30, ...	625	move 20, 30, ...
556		626
		627	=item align $xalign, $yalign, $img
		628
		629	Aligns the image according to a factor - C<0> means the image is moved to
		630	the left or top edge (for C<$xalign> or C<$yalign>), C<0.5> means it is
		631	exactly centered and C<1> means it touches the right or bottom edge.
		632
		633	Example: remove any visible border around an image, center it vertically but move
		634	it to the right hand side.
		635
		636	align 1, 0.5, pad $img
		637
557	=item center $img	638	=item center $img
558		639
559	=item center $width, $height, $img	640	=item center $width, $height, $img
560		641
561	Centers the image, i.e. the center of the image is moved to the center of	642	Centers the image, i.e. the center of the image is moved to the center of
562	the terminal window (or the box specified by C<$width> and C<$height> if	643	the terminal window (or the box specified by C<$width> and C<$height> if
563	given).	644	given).
		645
		646	Example: load an image and center it.
		647
		648	center pad load "mybg.png"
564		649
565	=item rootalign $img	650	=item rootalign $img
566		651
567	Moves the image so that it appears glued to the screen as opposed to the	652	Moves the image so that it appears glued to the screen as opposed to the
568	window. This gives the illusion of a larger area behind the window. It is	653	window. This gives the illusion of a larger area behind the window. It is
…		…
574	rootalign mirror load "mybg.png"	659	rootalign mirror load "mybg.png"
575		660
576	Example: take the screen background and align it, giving the illusion of	661	Example: take the screen background and align it, giving the illusion of
577	transparency as long as the window isn't in front of other windows.	662	transparency as long as the window isn't in front of other windows.
578		663
579	rootalign root	664	rootalign root
580		665
581	=cut	666	=cut
582		667
583	sub move($$;$) {	668	sub move($$;$) {
584	my $img = pop->clone;	669	my $img = pop->clone;
585	$img->move ($_[0], $_[1]);	670	$img->move ($_[0], $_[1]);
586	$img	671	$img
587	}	672	}
588		673
		674	sub align($;$$) {
		675	my $img = pop;
		676
		677	move $_[0] * (TW - $img->w),
		678	$_[1] * (TH - $img->h),
		679	$img
		680	}
		681
589	sub center($;$$) {	682	sub center($;$$) {
590	my $img = pop;	683	my $img = pop;
591	my $w = $_[0] \|\| TW;	684	my $w = $_[0] \|\| TW;
592	my $h = $_[0] \|\| TH;	685	my $h = $_[1] \|\| TH;
593		686
594	move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img	687	move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img
595	}	688	}
596		689
597	sub rootalign($) {	690	sub rootalign($) {
598	move -TX, -TY, $_[0]	691	move -TX, -TY, $_[0]
599	}	692	}
600		693
		694	=item rotate $center_x, $center_y, $degrees
		695
		696	Rotates the image by C<$degrees> degrees, counter-clockwise, around the
		697	pointer at C<$center_x> and C<$center_y> (specified as factor of image
		698	width/height).
		699
		700	#TODO# new width, height, maybe more operators?
		701
		702	Example: rotate the image by 90 degrees
		703
		704	=cut
		705
		706	sub rotate($$$$) {
		707	my $img = pop;
		708	$img->rotate (
		709	$_[0] * ($img->w + $img->x),
		710	$_[1] * ($img->h + $img->y),
		711	$_[2] * (3.14159265 / 180),
		712	)
		713	}
		714
		715	=back
		716
		717	=head2 COLOUR MODIFICATIONS
		718
		719	The following operators change the pixels of the image.
		720
		721	=over 4
		722
601	=item contrast $factor, $img	723	=item contrast $factor, $img
602		724
603	=item contrast $r, $g, $b, $img	725	=item contrast $r, $g, $b, $img
604		726
605	=item contrast $r, $g, $b, $a, $img	727	=item contrast $r, $g, $b, $a, $img
606		728
607	Adjusts the I<contrast> of an image.	729	Adjusts the I<contrast> of an image.
608		730
609	#TODO#	731	The first form applies a single C<$factor> to red, green and blue, the
		732	second form applies separate factors to each colour channel, and the last
		733	form includes the alpha channel.
610		734
		735	Values from 0 to 1 lower the contrast, values higher than 1 increase the
		736	contrast.
		737
		738	Due to limitations in the underlying XRender extension, lowering contrast
		739	also reduces brightness, while increasing contrast currently also
		740	increases brightness.
		741
611	=item brightness $factor, $img	742	=item brightness $bias, $img
612		743
613	=item brightness $r, $g, $b, $img	744	=item brightness $r, $g, $b, $img
614		745
615	=item brightness $r, $g, $b, $a, $img	746	=item brightness $r, $g, $b, $a, $img
616		747
617	Adjusts the brightness of an image.	748	Adjusts the brightness of an image.
618		749
		750	The first form applies a single C<$bias> to red, green and blue, the
		751	second form applies separate biases to each colour channel, and the last
		752	form includes the alpha channel.
		753
		754	Values less than 0 reduce brightness, while values larger than 0 increase
		755	it. Useful range is from -1 to 1 - the former results in a black, the
		756	latter in a white picture.
		757
		758	Due to idiosyncrasies in the underlying XRender extension, biases less
		759	than zero can be I<very> slow.
		760
619	=cut	761	=cut
620		762
621	sub contrast($$;$$;$) {	763	sub contrast($$;$$;$) {
622	my $img = pop;	764	my $img = pop;
623	my ($r, $g, $b, $a) = @_;	765	my ($r, $g, $b, $a) = @_;
624		766
625	($g, $b) = ($r, $r) if @_ < 4;	767	($g, $b) = ($r, $r) if @_ < 3;
626	$a = 1 if @_ < 5;	768	$a = 1 if @_ < 4;
627		769
628	$img = $img->clone;	770	$img = $img->clone;
629	$img->contrast ($r, $g, $b, $a);	771	$img->contrast ($r, $g, $b, $a);
630	$img	772	$img
631	}	773	}
632		774
633	sub brightness($$;$$;$) {	775	sub brightness($$;$$;$) {
634	my $img = pop;	776	my $img = pop;
635	my ($r, $g, $b, $a) = @_;	777	my ($r, $g, $b, $a) = @_;
636		778
637	($g, $b) = ($r, $r) if @_ < 4;	779	($g, $b) = ($r, $r) if @_ < 3;
638	$a = 1 if @_ < 5;	780	$a = 1 if @_ < 4;
639		781
640	$img = $img->clone;	782	$img = $img->clone;
641	$img->brightness ($r, $g, $b, $a);	783	$img->brightness ($r, $g, $b, $a);
642	$img	784	$img
643	}	785	}
…		…
659	sub blur($$;$) {	801	sub blur($$;$) {
660	my $img = pop;	802	my $img = pop;
661	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	803	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
662	}	804	}
663		805
664	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees	806	=back
665		807
666	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	808	=head2 OTHER STUFF
667	pointer at C<$center_x> and C<$center_y> (specified as factor of image
668	width/height), generating a new image with width C<$new_width> and height
669	C<$new_height>.
670		809
671	#TODO# new width, height, maybe more operators?	810	Anything that didn't fit any of the other categories, even after applying
		811	force and closing our eyes.
672		812
673	Example: rotate the image by 90 degrees	813	=over 4
674		814
675	=cut	815	=item once { ... }
676		816
677	sub rotate($$$$$$) {	817	This function takes a code block as argument, that is, one or more
678	my $img = pop;	818	statements enclosed by braces.
679	$img->rotate (	819
680	$_[0],	820	The trick is that this code block is only evaluated once - future calls
681	$_[1],	821	will simply return the original image (yes, it should only be used with
682	$_[2] * $img->w,	822	images).
683	$_[3] * $img->h,	823
684	$_[4] * (3.14159265 / 180),	824	This can be extremely useful to avoid redoign the same slow operations
		825	again and again- for example, if your background expression takes the root
		826	background, blurs it and then root-aligns it it would have to blur the
		827	root background on every window move or resize.
		828
		829	Putting the blur into a C<once> block will make sure the blur is only done
		830	once:
		831
		832	rootlign once { blur 10, root }
		833
		834	This leaves the question of how to force reevaluation of the block, in
		835	case the root background changes: Right now, all once blocks forget that
		836	they ahve been executed before each time the root background changes (if
		837	the expression is sensitive to that) or when C<once_again> is called.
		838
		839	=item once_again
		840
		841	Resets all C<once> block as if they had never been called, i.e. on the
		842	next call they will be reevaluated again.
		843
		844	=cut
		845
		846	sub once(&) {
		847	my $once = $self->{once_cache}{$_[0]+0} \|\|= do {
		848	local $new->{again};
		849	my @res = $_[0]();
		850	[$new->{again}, \@res]
685	)	851	};
		852
		853	$new->{again} = {
		854	%{ $new->{again} },
		855	%{ $once->[0] }
		856	};
		857
		858	# in scalar context we always return the first original result, which
		859	# is not quite how perl works.
		860	wantarray
		861	? @{ $once->[1] }
		862	: $once->[1][0]
		863	}
		864
		865	sub once_again() {
		866	delete $self->{once_cache};
686	}	867	}
687		868
688	=back	869	=back
689		870
690	=cut	871	=cut
…		…
731	($x, $y, $w, $h) =	912	($x, $y, $w, $h) =
732	$self->background_geometry ($self->{border});	913	$self->background_geometry ($self->{border});
733		914
734	# evaluate user expression	915	# evaluate user expression
735		916
736	my $img = eval { $self->{expr}->() };	917	my $img = eval { urxvt::bgdsl::merge $self->{expr}->() };
737	warn $@ if $@;#d#	918	die $@ if $@;
738	die if !UNIVERSAL::isa $img, "urxvt::img";	919	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
739		920
740	$state->{size_sensitive} = 1	921	# if the expression is sensitive to external events, prepare reevaluation then
		922
		923	my $again = delete $state->{again};
		924
		925	$again->{size} = 1
741	if $img->repeat_mode != urxvt::RepeatNormal;	926	if $img->repeat_mode != urxvt::RepeatNormal;
742		927
743	# if the expression is sensitive to external events, prepare reevaluation then
744
745	my $repeat;
746
747	if (my $again = $state->{again}) {	928	if (my $again = $again->{time}) {
748	$repeat = 1;
749	my $self = $self;	929	my $self = $self;
750	$state->{timer} = $again == $old->{again}	930	$state->{timer} = $again == $old->{again}
751	? $old->{timer}	931	? $old->{timer}
752	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	932	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
753	++$self->{counter};	933	++$self->{counter};
754	$self->recalculate	934	$self->recalculate
755	});	935	});
756	}	936	}
757		937
758	if (delete $state->{position_sensitive}) {	938	if ($again->{position}) {
759	$repeat = 1;
760	$self->enable (position_change => sub { $_[0]->recalculate });	939	$self->enable (position_change => sub { $_[0]->recalculate });
761	} else {	940	} else {
762	$self->disable ("position_change");	941	$self->disable ("position_change");
763	}	942	}
764		943
765	if (delete $state->{size_sensitive}) {	944	if ($again->{size}) {
766	$repeat = 1;
767	$self->enable (size_change => sub { $_[0]->recalculate });	945	$self->enable (size_change => sub { $_[0]->recalculate });
768	} else {	946	} else {
769	$self->disable ("size_change");	947	$self->disable ("size_change");
770	}	948	}
771		949
772	if (delete $state->{rootpmap_sensitive}) {	950	if ($again->{rootpmap}) {
773	$repeat = 1;
774	$self->enable (rootpmap_change => sub { $_[0]->recalculate });	951	$self->enable (rootpmap_change => sub {
		952	delete $_[0]{once_cache}; # this will override once-block values from
		953	$_[0]->recalculate;
		954	});
775	} else {	955	} else {
776	$self->disable ("rootpmap_change");	956	$self->disable ("rootpmap_change");
777	}	957	}
778		958
779	# clear stuff we no longer need	959	# clear stuff we no longer need
780		960
781	%$old = ();	961	%$old = ();
782		962
783	unless ($repeat) {	963	unless (%$again) {
784	delete $self->{state};	964	delete $self->{state};
785	delete $self->{expr};	965	delete $self->{expr};
786	}	966	}
787		967
788	# set background pixmap	968	# set background pixmap
…		…
793	}	973	}
794		974
795	sub on_start {	975	sub on_start {
796	my ($self) = @_;	976	my ($self) = @_;
797		977
798	my $expr = $self->x_resource ("background.expr")	978	my $expr = $self->x_resource ("%.expr")
799	or return;	979	or return;
800		980
		981	$self->has_render
		982	or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
		983
801	$self->set_expr (parse_expr $expr);	984	$self->set_expr (parse_expr $expr);
802	$self->{border} = $self->x_resource_boolean ("background.border");	985	$self->{border} = $self->x_resource_boolean ("%.border");
		986
		987	$MIN_INTERVAL = $self->x_resource ("%.interval");
803		988
804	()	989	()
805	}	990	}
806		991

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.44 by root, Sun Jun 10 11:31:22 2012 UTC vs. Revision 1.62 by root, Sun Jun 17 21:58:18 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.44 by root, Sun Jun 10 11:31:22 2012 UTC vs.
Revision 1.62 by root, Sun Jun 17 21:58:18 2012 UTC