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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.57 by root, Thu Jun 14 18:06:15 2012 UTC vs.
Revision 1.69 by root, Mon Jul 2 01:32:26 2012 UTC

…		…
26	to be as simple as possible.	26	to be as simple as possible.
27		27
28	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
29	use:	29	use:
30		30
31	urxvt --background-expr 'scale load "/path/to/mybg.png"'	31	urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }'
32		32
33	Or specified as a X resource:	33	Or specified as a X resource:
34		34
35	URxvt.background-expr: scale load "/path/to/mybg.png"	35	URxvt.background-expr: scale keep { load "/path/to/mybg.png" }
36		36
37	=head1 THEORY OF OPERATION	37	=head1 THEORY OF OPERATION
38		38
39	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
40	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
…		…
53	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
54	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
55	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
56	timer elapses), then the expression will be evaluated again.	56	timer elapses), then the expression will be evaluated again.
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 keep { load "$HOME/mybg.png"
59	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
60	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
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 its 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:
68		68
		69	scale keep {
69	again 3600;	70	again 3600;
70	if (localtime now)[6]) {	71	if (localtime now)[6]) {
71	return scale load "$HOME/weekday.png";	72	return load "$HOME/weekday.png";
72	} else {	73	} else {
73	return scale load "$HOME/sunday.png";	74	return load "$HOME/sunday.png";
		75	}
74	}	76	}
75		77
76	This expression is evaluated once per hour. It will set F<sunday.png> as	78	This inner expression is evaluated once per hour (and whenever the
		79	temrinal window is resized). It sets F<sunday.png> as background on
77	background on Sundays, and F<weekday.png> on all other days.	80	Sundays, and F<weekday.png> on all other days.
78		81
79	Fortunately, we expect that most expressions will be much simpler, with	82	Fortunately, we expect that most expressions will be much simpler, with
80	little Perl knowledge needed.	83	little Perl knowledge needed.
81		84
82	Basically, you always start with a function that "generates" an image	85	Basically, you always start with a function that "generates" an image
…		…
115	horizontal and vertical dimensions. For example, this halves the image	118	horizontal and vertical dimensions. For example, this halves the image
116	width and doubles the image height:	119	width and doubles the image height:
117		120
118	scale 0.5, 2, load "$HOME/mypic.png"	121	scale 0.5, 2, load "$HOME/mypic.png"
119		122
120	Other effects than scaling are also readily available, for example, you can	123	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:	124	because each time the terminal is resized, it loads the PNG image agin
		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:
122		127
		128	scale 0.5, 2, keep { load "$HOME/mypic.png" }
		129
		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.
		133
		134	This means that the C<load> is only executed once, which makes it much
		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.
		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
123	tile load "$HOME/mypic.png"	143	tile keep { load "$HOME/mypic.png" }
124		144
125	In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator	145	In fact, images returned by C<load> are in C<tile> mode by default, so the
126	is kind of superfluous.	146	C<tile> operator is kind of superfluous.
127		147
128	Another common effect is to mirror the image, so that the same edges touch:	148	Another common effect is to mirror the image, so that the same edges
		149	touch:
129		150
130	mirror load "$HOME/mypic.png"	151	mirror keep { load "$HOME/mypic.png" }
131		152
132	This is also a typical background expression:	153	Another common background expression is:
133		154
134	rootalign root	155	rootalign root
135		156
136	It first takes a snapshot of the screen background image, and then	157	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	158	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	159	left corner of the terminal window)- the result is pseudo-transparency:
139	moved around.	160	the image seems to be static while the window is moved around.
140		161
141	=head2 CYCLES AND CACHING	162	=head2 CACHING AND SENSITIVITY
142		163
143	As has been mentioned before, the expression might be evaluated multiple	164	Since some operations (such as C<load> and C<blur>) can take a long time,
144	times. Each time the expression is reevaluated, a new cycle is said to	165	caching results can be very important for a smooth operation. Caching can
145	have begun. Many operators cache their results till the next cycle.	166	also be useful to reduce memory usage, though, for example, when an image
		167	is cached by C<load>, it could be shared by multiple terminal windows
		168	running inside urxvtd.
146		169
147	For example, the C<load> operator keeps a copy of the image. If it is	170	=head3 C<keep { ... }> caching
148	asked to load the same image on the next cycle it will not load it again,
149	but return the cached copy.
150		171
151	This only works for one cycle though, so as long as you load the same	172	The most important way to cache expensive operations is to use C<keep {
152	image every time, it will always be cached, but when you load a different	173	... }>. The C<keep> operator takes a block of multiple statements enclosed
153	image, it will forget about the first one.	174	by C<{}> and keeps the return value in memory.
154		175
155	This allows you to either speed things up by keeping multiple images in	176	An expression can be "sensitive" to various external events, such as
156	memory, or conserve memory by loading images more often.	177	scaling or moving the window, root background changes and timers. Simply
		178	using an expression (such as C<scale> without parameters) that depends on
		179	certain changing values (called "variables"), or using those variables
		180	directly, will make an expression sensitive to these events - for example,
		181	using C<scale> or C<TW> will make the expression sensitive to the terminal
		182	size, and thus to resizing events.
157		183
158	For example, you can keep two images in memory and use a random one like	184	When such an event happens, C<keep> will automatically trigger a
159	this:	185	reevaluation of the whole expression with the new value of the expression.
160		186
161	my $img1 = load "img1.png";	187	C<keep> is most useful for expensive operations, such as C<blur>:
162	my $img2 = load "img2.png";
163	(0.5 > rand) ? $img1 : $img2
164		188
165	Since both images are "loaded" every time the expression is evaluated,	189	rootalign keep { blur 20, root }
166	they are always kept in memory. Contrast this version:
167		190
168	my $path1 = "img1.png";	191	This makes a blurred copy of the root background once, and on subsequent
169	my $path2 = "img2.png";	192	calls, just root-aligns it. Since C<blur> is usually quite slow and
170	load ((0.5 > rand) ? $path1 : $path2)	193	C<rootalign> is quite fast, this trades extra memory (for the cached
		194	blurred pixmap) with speed (blur only needs to be redone when root
		195	changes).
171		196
172	Here, a path is selected randomly, and load is only called for one image,	197	=head3 C<load> caching
173	so keeps only one image in memory. If, on the next evaluation, luck	198
174	decides to use the other path, then it will have to load that image again.	199	The C<load> operator itself does not keep images in memory, but as long as
		200	the image is still in memory, C<load> will use the in-memory image instead
		201	of loading it freshly from disk.
		202
		203	That means that this expression:
		204
		205	keep { load "$HOME/path..." }
		206
		207	Not only caches the image in memory, other terminal instances that try to
		208	C<load> it can reuse that in-memory copy.
175		209
176	=head1 REFERENCE	210	=head1 REFERENCE
177		211
178	=head2 COMMAND LINE SWITCHES	212	=head2 COMMAND LINE SWITCHES
179		213
…		…
204		238
205	=cut	239	=cut
206		240
207	our %_IMG_CACHE;	241	our %_IMG_CACHE;
208	our $HOME;	242	our $HOME;
209	our ($self, $old, $new);	243	our ($self, $frame);
210	our ($x, $y, $w, $h);	244	our ($x, $y, $w, $h);
211		245
212	# enforce at least this interval between updates	246	# enforce at least this interval between updates
213	our $MIN_INTERVAL = 6/59.951;	247	our $MIN_INTERVAL = 6/59.951;
214		248
215	{	249	{
216	package urxvt::bgdsl; # background language	250	package urxvt::bgdsl; # background language
		251
		252	sub FR_PARENT() { 0 } # parent frame, if any - must be #0
		253	sub FR_CACHE () { 1 } # cached values
		254	sub FR_AGAIN () { 2 } # what this expr is sensitive to
		255	sub FR_STATE () { 3 } # watchers etc.
217		256
218	use List::Util qw(min max sum shuffle);	257	use List::Util qw(min max sum shuffle);
219		258
220	=head2 PROVIDERS/GENERATORS	259	=head2 PROVIDERS/GENERATORS
221		260
…		…
228	=item load $path	267	=item load $path
229		268
230	Loads the image at the given C<$path>. The image is set to plane tiling	269	Loads the image at the given C<$path>. The image is set to plane tiling
231	mode.	270	mode.
232		271
233	Loaded images will be cached for one cycle, and shared between temrinals	272	If the image is already in memory (e.g. because another terminal instance
234	running in the same process (e.g. in C<urxvtd>).	273	uses it), then the in-memory copy us returned instead.
235		274
236	=item load_uc $path	275	=item load_uc $path
237		276
238	Load uncached - same as load, but does not cache the image. This function	277	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	278	is I<always> loaded from the filesystem again.
240	way.
241		279
242	=cut	280	=cut
243		281
244	sub load_uc($) {	282	sub load($) {
245	my ($path) = @_;	283	my ($path) = @_;
246		284
247	$_IMG_CACHE{$path} \|\| do {	285	$_IMG_CACHE{$path} \|\| do {
248	my $img = $self->new_img_from_file ($path);	286	my $img = $self->new_img_from_file ($path);
249	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);	287	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
250	$img	288	$img
251	}	289	}
252	}	290	}
253		291
254	sub load($) {
255	my ($path) = @_;
256
257	$new->{load}{$path} = $old->{load}{$path} \|\| load_uc $path;
258	}
259
260	=item root	292	=item root
261		293
262	Returns the root window pixmap, that is, hopefully, the background image	294	Returns the root window pixmap, that is, hopefully, the background image
263	of your screen. The image is set to extend mode.	295	of your screen.
264		296
265	This function makes your expression root sensitive, that means it will be	297	This function makes your expression root sensitive, that means it will be
266	reevaluated when the bg image changes.	298	reevaluated when the bg image changes.
267		299
268	=cut	300	=cut
269		301
270	sub root() {	302	sub root() {
271	$new->{again}{rootpmap} = 1;	303	$frame->[FR_AGAIN]{rootpmap} = 1;
272	$self->new_img_from_root	304	$self->new_img_from_root
273	}	305	}
274		306
275	=item solid $colour	307	=item solid $colour
276		308
…		…
285	=cut	317	=cut
286		318
287	sub solid($;$$) {	319	sub solid($;$$) {
288	my $colour = pop;	320	my $colour = pop;
289		321
290	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);	322	my $img = $self->new_img (urxvt::PictStandardARGB32, 0, 0, $_[0] \|\| 1, $_[1] \|\| 1);
291	$img->fill ($colour);	323	$img->fill ($colour);
292	$img	324	$img
293	}	325	}
294		326
295	=item clone $img	327	=item clone $img
…		…
304	}	336	}
305		337
306	=item merge $img ...	338	=item merge $img ...
307		339
308	Takes any number of images and merges them together, creating a single	340	Takes any number of images and merges them together, creating a single
309	image containing them all.	341	image containing them all. The tiling mode of the first image is used as
		342	the tiling mode of the resulting image.
		343
		344	This function is called automatically when an expression returns multiple
		345	images.
310		346
311	=cut	347	=cut
312		348
313	sub merge(@) {	349	sub merge(@) {
314	#TODO	350	return $_[0] unless $#_;
		351
		352	# rather annoyingly clumsy, but optimisation is for another time
		353
		354	my $x0 = +1e9;
		355	my $y0 = +1e9;
		356	my $x1 = -1e9;
		357	my $y1 = -1e9;
		358
		359	for (@_) {
		360	my ($x, $y, $w, $h) = $_->geometry;
		361
		362	$x0 = $x if $x0 > $x;
		363	$y0 = $y if $y0 > $y;
		364
		365	$x += $w;
		366	$y += $h;
		367
		368	$x1 = $x if $x1 < $x;
		369	$y1 = $y if $y1 < $y;
		370	}
		371
		372	my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
		373	$base->repeat_mode ($_[0]->repeat_mode);
		374	$base->fill ([0, 0, 0, 0]);
		375
		376	$base->draw ($_)
		377	for @_;
		378
		379	$base
315	}	380	}
316		381
317	=head2 TILING MODES	382	=head2 TILING MODES
318		383
319	The following operators modify the tiling mode of an image, that is, the	384	The following operators modify the tiling mode of an image, that is, the
…		…
417	Using these functions make your expression sensitive to window moves.	482	Using these functions make your expression sensitive to window moves.
418		483
419	These functions are mainly useful to align images to the root window.	484	These functions are mainly useful to align images to the root window.
420		485
421	Example: load an image and align it so it looks as if anchored to the	486	Example: load an image and align it so it looks as if anchored to the
422	background.	487	background (that's exactly what C<rootalign> does btw.):
423		488
424	move -TX, -TY, load "mybg.png"	489	move -TX, -TY, keep { load "mybg.png" }
425		490
426	=item TW	491	=item TW
427		492
428	Return the width (C<TW>) and height (C<TH>) of the terminal window (the	493	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
429	terminal window is the full window by default, and the character area only	494	terminal window is the full window by default, and the character area only
…		…
435	the window size to conserve memory.	500	the window size to conserve memory.
436		501
437	Example: take the screen background, clip it to the window size, blur it a	502	Example: take the screen background, clip it to the window size, blur it a
438	bit, align it to the window position and use it as background.	503	bit, align it to the window position and use it as background.
439		504
440	clip move -TX, -TY, once { blur 5, root }	505	clip move -TX, -TY, keep { blur 5, root }
441		506
442	=cut	507	=cut
443		508
444	sub TX() { $new->{again}{position} = 1; $x }	509	sub TX() { $frame->[FR_AGAIN]{position} = 1; $x }
445	sub TY() { $new->{again}{position} = 1; $y }	510	sub TY() { $frame->[FR_AGAIN]{position} = 1; $y }
446	sub TW() { $new->{again}{size} = 1; $w }	511	sub TW() { $frame->[FR_AGAIN]{size} = 1; $w }
447	sub TH() { $new->{again}{size} = 1; $h }	512	sub TH() { $frame->[FR_AGAIN]{size} = 1; $h }
448		513
449	=item now	514	=item now
450		515
451	Returns the current time as (fractional) seconds since the epoch.	516	Returns the current time as (fractional) seconds since the epoch.
452		517
…		…
459	C<$seconds> seconds.	524	C<$seconds> seconds.
460		525
461	Example: load some image and rotate it according to the time of day (as if it were	526	Example: load some image and rotate it according to the time of day (as if it were
462	the hour pointer of a clock). Update this image every minute.	527	the hour pointer of a clock). Update this image every minute.
463		528
		529	again 60;
464	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"	530	rotate 50, 50, (now % 86400) * -72 / 8640, scale keep { load "myclock.png" }
465		531
466	=item counter $seconds	532	=item counter $seconds
467		533
468	Like C<again>, but also returns an increasing counter value, starting at	534	Like C<again>, but also returns an increasing counter value, starting at
469	0, which might be useful for some simple animation effects.	535	0, which might be useful for some simple animation effects.
…		…
471	=cut	537	=cut
472		538
473	sub now() { urxvt::NOW }	539	sub now() { urxvt::NOW }
474		540
475	sub again($) {	541	sub again($) {
476	$new->{again}{time} = $_[0];	542	$frame->[FR_AGAIN]{time} = $_[0];
477	}	543	}
478		544
479	sub counter($) {	545	sub counter($) {
480	$new->{again}{time} = $_[0];	546	$frame->[FR_AGAIN]{time} = $_[0];
481	$self->{counter} + 0	547	$frame->[FR_STATE]{counter} + 0
482	}	548	}
483		549
484	=back	550	=back
485		551
486	=head2 SHAPE CHANGING OPERATORS	552	=head2 SHAPE CHANGING OPERATORS
…		…
506	assumed.	572	assumed.
507		573
508	Example: load an image, blur it, and clip it to the window size to save	574	Example: load an image, blur it, and clip it to the window size to save
509	memory.	575	memory.
510		576
511	clip blur 10, load "mybg.png"	577	clip keep { blur 10, load "mybg.png" }
512		578
513	=cut	579	=cut
514		580
515	sub clip($;$$;$$) {	581	sub clip($;$$;$$) {
516	my $img = pop;	582	my $img = pop;
…		…
610	the terminal window (or the box specified by C<$width> and C<$height> if	676	the terminal window (or the box specified by C<$width> and C<$height> if
611	given).	677	given).
612		678
613	Example: load an image and center it.	679	Example: load an image and center it.
614		680
615	center pad load "mybg.png"	681	center keep { pad load "mybg.png" }
616		682
617	=item rootalign $img	683	=item rootalign $img
618		684
619	Moves the image so that it appears glued to the screen as opposed to the	685	Moves the image so that it appears glued to the screen as opposed to the
620	window. This gives the illusion of a larger area behind the window. It is	686	window. This gives the illusion of a larger area behind the window. It is
621	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the	687	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
622	top left of the screen.	688	top left of the screen.
623		689
624	Example: load a background image, put it in mirror mode and root align it.	690	Example: load a background image, put it in mirror mode and root align it.
625		691
626	rootalign mirror load "mybg.png"	692	rootalign keep { mirror load "mybg.png" }
627		693
628	Example: take the screen background and align it, giving the illusion of	694	Example: take the screen background and align it, giving the illusion of
629	transparency as long as the window isn't in front of other windows.	695	transparency as long as the window isn't in front of other windows.
630		696
631	rootalign root	697	rootalign root
…		…
656		722
657	sub rootalign($) {	723	sub rootalign($) {
658	move -TX, -TY, $_[0]	724	move -TX, -TY, $_[0]
659	}	725	}
660		726
661	=item rotate $center_x, $center_y, $degrees	727	=item rotate $center_x, $center_y, $degrees, $img
662		728
663	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	729	Rotates the image clockwise by C<$degrees> degrees, around the point at
664	pointer at C<$center_x> and C<$center_y> (specified as factor of image	730	C<$center_x> and C<$center_y> (specified as factor of image width/height).
665	width/height).
666		731
667	#TODO# new width, height, maybe more operators?
668
669	Example: rotate the image by 90 degrees	732	Example: rotate the image by 90 degrees around it's center.
		733
		734	rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
670		735
671	=cut	736	=cut
672		737
673	sub rotate($$$$) {	738	sub rotate($$$$) {
674	my $img = pop;	739	my $img = pop;
675	$img->rotate (	740	$img->rotate (
676	$_[0] * $img->w,	741	$_[0] * ($img->w + $img->x),
677	$_[1] * $img->h,	742	$_[1] * ($img->h + $img->y),
678	$_[2] * (3.14159265 / 180),	743	$_[2] * (3.14159265 / 180),
679	)	744	)
680	}	745	}
681		746
682	=back	747	=back
…		…
777	Anything that didn't fit any of the other categories, even after applying	842	Anything that didn't fit any of the other categories, even after applying
778	force and closing our eyes.	843	force and closing our eyes.
779		844
780	=over 4	845	=over 4
781		846
782	=item once { ... }	847	=item keep { ... }
783		848
784	This function takes a code block as argument, that is, one or more	849	This operator takes a code block as argument, that is, one or more
785	statements enclosed by braces.	850	statements enclosed by braces.
786		851
787	The trick is that this code block is only evaluated once - future calls	852	The trick is that this code block is only evaluated when the outcome
788	will simply return the original image (yes, it should only be used with	853	changes - on other calls the C<keep> simply returns the image it computed
789	images).	854	previously (yes, it should only be used with images). Or in other words,
		855	C<keep> I<caches> the result of the code block so it doesn't need to be
		856	computed again.
790		857
791	This can be extremely useful to avoid redoign the same slow operations	858	This can be extremely useful to avoid redoing slow operations - for
792	again and again- for example, if your background expression takes the root	859	example, if your background expression takes the root background, blurs it
793	background, blurs it and then root-aligns it it would have to blur the	860	and then root-aligns it it would have to blur the root background on every
794	root background on every window move or resize.	861	window move or resize.
795		862
		863	Another example is C<load>, which can be quite slow.
		864
		865	In fact, urxvt itself encloses the whole expression in some kind of
		866	C<keep> block so it only is reevaluated as required.
		867
796	Putting the blur into a C<once> block will make sure the blur is only done	868	Putting the blur into a C<keep> block will make sure the blur is only done
797	once:	869	once, while the C<rootalign> is still done each time the window moves.
798		870
799	rootlign once { blur 10, root }	871	rootlign keep { blur 10, root }
800		872
801	This leaves the question of how to force reevaluation of the block, in	873	This leaves the question of how to force reevaluation of the block,
802	case the root background changes: Right now, all once blocks forget that	874	in case the root background changes: If expression inside the block
803	they ahve been executed before each time the root background changes (if	875	is sensitive to some event (root background changes, window geometry
804	the expression is sensitive to that) or when C<once_again> is called.	876	changes), then it will be reevaluated automatically as needed.
805		877
806	=item once_again
807
808	Resets all C<once> block as if they had never been called, i.e. on the
809	next call they will be reevaluated again.
810
811	=cut	878	=cut
812		879
813	sub once(&) {	880	sub keep(&) {
814	my $once = $self->{once_cache}{$_[0]+0} \|\|= do {	881	my $id = $_[0]+0;
815	local $new->{again};	882
816	my @res = $_[0]();	883	local $frame = $self->{frame_cache}{$id} \|\|= [$frame];
817	[$new->{again}, \@res]	884
		885	unless ($frame->[FR_CACHE]) {
		886	$frame->[FR_CACHE] = [ $_[0]() ];
		887
		888	my $self = $self;
		889	my $frame = $frame;
		890	Scalar::Util::weaken $frame;
		891	$self->compile_frame ($frame, sub {
		892	# clear this frame cache, also for all parents
		893	for (my $frame = $frame; $frame; $frame = $frame->[0]) {
		894	undef $frame->[FR_CACHE];
		895	}
		896
		897	$self->recalculate;
818	};	898	});
819
820	$new->{again} = {
821	%{ $new->{again} },
822	%{ $once->[0] }
823	};	899	};
824		900
825	# in scalar context we always return the first original result, which	901	# in scalar context we always return the first original result, which
826	# is not quite how perl works.	902	# is not quite how perl works.
827	wantarray	903	wantarray
828	? @{ $once->[1] }	904	? @{ $frame->[FR_CACHE] }
829	: $once->[1][0]	905	: $frame->[FR_CACHE][0]
		906	}
		907
		908	# sub keep_clear() {
		909	# delete $self->{frame_cache};
830	}	910	# }
831
832	sub once_again() {
833	delete $self->{once_cache};
834	}
835		911
836	=back	912	=back
837		913
838	=cut	914	=cut
839		915
840	}	916	}
841		917
842	sub parse_expr {	918	sub parse_expr {
843	my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}";	919	my $expr = eval
		920	"sub {\n"
		921	. "package urxvt::bgdsl;\n"
		922	. "#line 0 'background expression'\n"
		923	. "$_[0]\n"
		924	. "}";
844	die if $@;	925	die if $@;
845	$expr	926	$expr
846	}	927	}
847		928
848	# compiles a parsed expression	929	# compiles a parsed expression
849	sub set_expr {	930	sub set_expr {
850	my ($self, $expr) = @_;	931	my ($self, $expr) = @_;
851		932
		933	$self->{root} = [];
852	$self->{expr} = $expr;	934	$self->{expr} = $expr;
853	$self->recalculate;	935	$self->recalculate;
		936	}
		937
		938	# takes a hash of sensitivity indicators and installs watchers
		939	sub compile_frame {
		940	my ($self, $frame, $cb) = @_;
		941
		942	my $state = $frame->[urxvt::bgdsl::FR_STATE] \|\|= {};
		943	my $again = $frame->[urxvt::bgdsl::FR_AGAIN];
		944
		945	# don't keep stuff alive
		946	Scalar::Util::weaken $state;
		947
		948	if ($again->{nested}) {
		949	$state->{nested} = 1;
		950	} else {
		951	delete $state->{nested};
		952	}
		953
		954	if (my $interval = $again->{time}) {
		955	$state->{time} = [$interval, urxvt::timer->new->after ($interval)->interval ($interval)]
		956	if $state->{time}[0] != $interval;
		957
		958	# callback might have changed, although we could just rule that out
		959	$state->{time}[1]->cb (sub {
		960	++$state->{counter};
		961	$cb->();
		962	});
		963	} else {
		964	delete $state->{time};
		965	}
		966
		967	if ($again->{position}) {
		968	$state->{position} = $self->on (position_change => $cb);
		969	} else {
		970	delete $state->{position};
		971	}
		972
		973	if ($again->{size}) {
		974	$state->{size} = $self->on (size_change => $cb);
		975	} else {
		976	delete $state->{size};
		977	}
		978
		979	if ($again->{rootpmap}) {
		980	$state->{rootpmap} = $self->on (rootpmap_change => $cb);
		981	} else {
		982	delete $state->{rootpmap};
		983	}
854	}	984	}
855		985
856	# evaluate the current bg expression	986	# evaluate the current bg expression
857	sub recalculate {	987	sub recalculate {
858	my ($arg_self) = @_;	988	my ($arg_self) = @_;
…		…
868		998
869	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	999	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
870		1000
871	# set environment to evaluate user expression	1001	# set environment to evaluate user expression
872		1002
873	local $self = $arg_self;	1003	local $self = $arg_self;
874
875	local $HOME = $ENV{HOME};	1004	local $HOME = $ENV{HOME};
876	local $old = $self->{state};	1005	local $frame = [];
877	local $new = my $state = $self->{state} = {};
878		1006
879	($x, $y, $w, $h) =
880	$self->background_geometry ($self->{border});	1007	($x, $y, $w, $h) = $self->background_geometry ($self->{border});
881		1008
882	# evaluate user expression	1009	# evaluate user expression
883		1010
884	my $img = eval { $self->{expr}->() };	1011	my @img = eval { $self->{expr}->() };
885	warn $@ if $@;#d#	1012	die $@ if $@;
886	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";	1013	die "background-expr did not return anything.\n" unless @img;
		1014	die "background-expr: expected image(s), got something else.\n"
		1015	if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;
		1016
		1017	my $img = urxvt::bgdsl::merge @img;
		1018
		1019	$frame->[FR_AGAIN]{size} = 1
		1020	if $img->repeat_mode != urxvt::RepeatNormal;
887		1021
888	# if the expression is sensitive to external events, prepare reevaluation then	1022	# if the expression is sensitive to external events, prepare reevaluation then
889		1023	$self->compile_frame ($frame, sub { $arg_self->recalculate });
890	my $again = delete $state->{again};
891
892	$again->{size} = 1
893	if $img->repeat_mode != urxvt::RepeatNormal;
894
895	if (my $again = $again->{time}) {
896	my $self = $self;
897	$state->{timer} = $again == $old->{again}
898	? $old->{timer}
899	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
900	++$self->{counter};
901	$self->recalculate
902	});
903	}
904
905	if ($again->{position}) {
906	$self->enable (position_change => sub { $_[0]->recalculate });
907	} else {
908	$self->disable ("position_change");
909	}
910
911	if ($again->{size}) {
912	$self->enable (size_change => sub { $_[0]->recalculate });
913	} else {
914	$self->disable ("size_change");
915	}
916
917	if ($again->{rootpmap}) {
918	$self->enable (rootpmap_change => sub {
919	delete $_[0]{once_cache}; # this will override once-block values from
920	$_[0]->recalculate;
921	});
922	} else {
923	$self->disable ("rootpmap_change");
924	}
925		1024
926	# clear stuff we no longer need	1025	# clear stuff we no longer need
927		1026
928	%$old = ();	1027	# unless (%{ $frame->[FR_STATE] }) {
929
930	unless (%$again) {
931	delete $self->{state};	1028	# delete $self->{state};
932	delete $self->{expr};	1029	# delete $self->{expr};
933	}	1030	# }
934		1031
935	# set background pixmap	1032	# set background pixmap
936		1033
937	$self->set_background ($img, $self->{border});	1034	$self->set_background ($img, $self->{border});
938	$self->scr_recolour (0);	1035	$self->scr_recolour (0);

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.57 by root, Thu Jun 14 18:06:15 2012 UTC vs. Revision 1.69 by root, Mon Jul 2 01:32:26 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.57 by root, Thu Jun 14 18:06:15 2012 UTC vs.
Revision 1.69 by root, Mon Jul 2 01:32:26 2012 UTC