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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.62 by root, Sun Jun 17 21:58:18 2012 UTC vs.
Revision 1.76 by root, Tue Aug 14 23:57:07 2012 UTC

…		…
12		12
13	urxvt --background-expr 'background expression'	13	urxvt --background-expr 'background expression'
14	--background-border	14	--background-border
15	--background-interval seconds	15	--background-interval seconds
16		16
		17	=head1 QUICK AND DIRTY CHEAT SHEET
		18
		19	Just load a random jpeg image and tile the background with it without
		20	scaling or anything else:
		21
		22	load "/path/to/img.jpg"
		23
		24	The same, but use mirroring/reflection instead of tiling:
		25
		26	mirror load "/path/to/img.jpg"
		27
		28	Load an image and scale it to exactly fill the terminal window:
		29
		30	scale keep { load "/path/to/img.jpg" }
		31
		32	Implement pseudo-transparency by using a suitably-aligned root pixmap
		33	as window background:
		34
		35	rootalign root
		36
		37	Likewise, but keep a blurred copy:
		38
		39	rootalign keep { blur 10, root }
		40
17	=head1 DESCRIPTION	41	=head1 DESCRIPTION
18		42
19	This extension manages the terminal background by creating a picture that	43	This extension manages the terminal background by creating a picture that
20	is behind the text, replacing the normal background colour.	44	is behind the text, replacing the normal background colour.
21		45
…		…
26	to be as simple as possible.	50	to be as simple as possible.
27		51
28	For example, to load an image and scale it to the window size, you would	52	For example, to load an image and scale it to the window size, you would
29	use:	53	use:
30		54
31	urxvt --background-expr 'scale load "/path/to/mybg.png"'	55	urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }'
32		56
33	Or specified as a X resource:	57	Or specified as a X resource:
34		58
35	URxvt.background-expr: scale load "/path/to/mybg.png"	59	URxvt.background-expr: scale keep { load "/path/to/mybg.png" }
36		60
37	=head1 THEORY OF OPERATION	61	=head1 THEORY OF OPERATION
38		62
39	At startup, just before the window is mapped for the first time, the	63	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	64	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	77	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	78	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	79	pixmap is replaced by another one the root background changes; or when the
56	timer elapses), then the expression will be evaluated again.	80	timer elapses), then the expression will be evaluated again.
57		81
58	For example, an expression such as C<scale load "$HOME/mybg.png"> scales the	82	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	83	}> 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	84	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	85	example. That ensures that the picture always fills the terminal, even
62	after its size changes.	86	after its size changes.
63		87
64	=head2 EXPRESSIONS	88	=head2 EXPRESSIONS
65		89
66	Expressions are normal Perl expressions, in fact, they are Perl blocks -	90	Expressions are normal Perl expressions, in fact, they are Perl blocks -
67	which means you could use multiple lines and statements:	91	which means you could use multiple lines and statements:
68		92
		93	scale keep {
69	again 3600;	94	again 3600;
70	if (localtime now)[6]) {	95	if (localtime now)[6]) {
71	return scale load "$HOME/weekday.png";	96	return load "$HOME/weekday.png";
72	} else {	97	} else {
73	return scale load "$HOME/sunday.png";	98	return load "$HOME/sunday.png";
		99	}
74	}	100	}
75		101
76	This expression is evaluated once per hour. It will set F<sunday.png> as	102	This inner expression is evaluated once per hour (and whenever the
		103	terminal window is resized). It sets F<sunday.png> as background on
77	background on Sundays, and F<weekday.png> on all other days.	104	Sundays, and F<weekday.png> on all other days.
78		105
79	Fortunately, we expect that most expressions will be much simpler, with	106	Fortunately, we expect that most expressions will be much simpler, with
80	little Perl knowledge needed.	107	little Perl knowledge needed.
81		108
82	Basically, you always start with a function that "generates" an image	109	Basically, you always start with a function that "generates" an image
…		…
115	horizontal and vertical dimensions. For example, this halves the image	142	horizontal and vertical dimensions. For example, this halves the image
116	width and doubles the image height:	143	width and doubles the image height:
117		144
118	scale 0.5, 2, load "$HOME/mypic.png"	145	scale 0.5, 2, load "$HOME/mypic.png"
119		146
120	Other effects than scaling are also readily available, for example, you can	147	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:	148	because each time the terminal is resized, it loads the PNG image again
		149	and scales it. Scaling is usually fast (and unavoidable), but loading the
		150	image can be quite time consuming. This is where C<keep> comes in handy:
122		151
		152	scale 0.5, 2, keep { load "$HOME/mypic.png" }
		153
		154	The C<keep> operator executes all the statements inside the braces only
		155	once, or when it thinks the outcome might change. In other cases it
		156	returns the last value computed by the brace block.
		157
		158	This means that the C<load> is only executed once, which makes it much
		159	faster, but also means that more memory is being used, because the loaded
		160	image must be kept in memory at all times. In this expression, the
		161	trade-off is likely worth it.
		162
		163	But back to effects: Other effects than scaling are also readily
		164	available, for example, you can tile the image to fill the whole window,
		165	instead of resizing it:
		166
123	tile load "$HOME/mypic.png"	167	tile keep { load "$HOME/mypic.png" }
124		168
125	In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator	169	In fact, images returned by C<load> are in C<tile> mode by default, so the
126	is kind of superfluous.	170	C<tile> operator is kind of superfluous.
127		171
128	Another common effect is to mirror the image, so that the same edges touch:	172	Another common effect is to mirror the image, so that the same edges
		173	touch:
129		174
130	mirror load "$HOME/mypic.png"	175	mirror keep { load "$HOME/mypic.png" }
131		176
132	This is also a typical background expression:	177	Another common background expression is:
133		178
134	rootalign root	179	rootalign root
135		180
136	It first takes a snapshot of the screen background image, and then	181	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	182	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	183	left corner of the terminal window)- the result is pseudo-transparency:
139	moved around.	184	the image seems to be static while the window is moved around.
140		185
141	=head2 CYCLES AND CACHING	186	=head2 COLOUR SPECIFICATIONS
142		187
143	As has been mentioned before, the expression might be evaluated multiple	188	Whenever an operator expects a "colour", then this can be specified in one
144	times. Each time the expression is reevaluated, a new cycle is said to	189	of two ways: Either as string with an X11 colour specification, such as:
145	have begun. Many operators cache their results till the next cycle.
146		190
147	For example, the C<load> operator keeps a copy of the image. If it is	191	"red" # named colour
148	asked to load the same image on the next cycle it will not load it again,	192	"#f00" # simple rgb
149	but return the cached copy.	193	"[50]red" # red with 50% alpha
		194	"TekHVC:300/50/50" # anything goes
150		195
151	This only works for one cycle though, so as long as you load the same	196	OR as an array reference with one, three or four components:
152	image every time, it will always be cached, but when you load a different
153	image, it will forget about the first one.
154		197
155	This allows you to either speed things up by keeping multiple images in	198	[0.5] # 50% gray, 100% alpha
156	memory, or conserve memory by loading images more often.	199	[0.5, 0, 0] # dark red, no green or blur, 100% alpha
		200	[0.5, 0, 0, 0.7] # same with explicit 70% alpha
157		201
158	For example, you can keep two images in memory and use a random one like	202	=head2 CACHING AND SENSITIVITY
159	this:
160		203
161	my $img1 = load "img1.png";	204	Since some operations (such as C<load> and C<blur>) can take a long time,
162	my $img2 = load "img2.png";	205	caching results can be very important for a smooth operation. Caching can
163	(0.5 > rand) ? $img1 : $img2	206	also be useful to reduce memory usage, though, for example, when an image
		207	is cached by C<load>, it could be shared by multiple terminal windows
		208	running inside urxvtd.
164		209
165	Since both images are "loaded" every time the expression is evaluated,	210	=head3 C<keep { ... }> caching
166	they are always kept in memory. Contrast this version:
167		211
168	my $path1 = "img1.png";	212	The most important way to cache expensive operations is to use C<keep {
169	my $path2 = "img2.png";	213	... }>. The C<keep> operator takes a block of multiple statements enclosed
170	load ((0.5 > rand) ? $path1 : $path2)	214	by C<{}> and keeps the return value in memory.
171		215
172	Here, a path is selected randomly, and load is only called for one image,	216	An expression can be "sensitive" to various external events, such as
173	so keeps only one image in memory. If, on the next evaluation, luck	217	scaling or moving the window, root background changes and timers. Simply
174	decides to use the other path, then it will have to load that image again.	218	using an expression (such as C<scale> without parameters) that depends on
		219	certain changing values (called "variables"), or using those variables
		220	directly, will make an expression sensitive to these events - for example,
		221	using C<scale> or C<TW> will make the expression sensitive to the terminal
		222	size, and thus to resizing events.
		223
		224	When such an event happens, C<keep> will automatically trigger a
		225	reevaluation of the whole expression with the new value of the expression.
		226
		227	C<keep> is most useful for expensive operations, such as C<blur>:
		228
		229	rootalign keep { blur 20, root }
		230
		231	This makes a blurred copy of the root background once, and on subsequent
		232	calls, just root-aligns it. Since C<blur> is usually quite slow and
		233	C<rootalign> is quite fast, this trades extra memory (for the cached
		234	blurred pixmap) with speed (blur only needs to be redone when root
		235	changes).
		236
		237	=head3 C<load> caching
		238
		239	The C<load> operator itself does not keep images in memory, but as long as
		240	the image is still in memory, C<load> will use the in-memory image instead
		241	of loading it freshly from disk.
		242
		243	That means that this expression:
		244
		245	keep { load "$HOME/path..." }
		246
		247	Not only caches the image in memory, other terminal instances that try to
		248	C<load> it can reuse that in-memory copy.
175		249
176	=head1 REFERENCE	250	=head1 REFERENCE
177		251
178	=head2 COMMAND LINE SWITCHES	252	=head2 COMMAND LINE SWITCHES
179		253
…		…
204		278
205	=cut	279	=cut
206		280
207	our %_IMG_CACHE;	281	our %_IMG_CACHE;
208	our $HOME;	282	our $HOME;
209	our ($self, $old, $new);	283	our ($self, $frame);
210	our ($x, $y, $w, $h);	284	our ($x, $y, $w, $h);
211		285
212	# enforce at least this interval between updates	286	# enforce at least this interval between updates
213	our $MIN_INTERVAL = 6/59.951;	287	our $MIN_INTERVAL = 6/59.951;
214		288
215	{	289	{
216	package urxvt::bgdsl; # background language	290	package urxvt::bgdsl; # background language
		291
		292	sub FR_PARENT() { 0 } # parent frame, if any - must be #0
		293	sub FR_CACHE () { 1 } # cached values
		294	sub FR_AGAIN () { 2 } # what this expr is sensitive to
		295	sub FR_STATE () { 3 } # watchers etc.
217		296
218	use List::Util qw(min max sum shuffle);	297	use List::Util qw(min max sum shuffle);
219		298
220	=head2 PROVIDERS/GENERATORS	299	=head2 PROVIDERS/GENERATORS
221		300
…		…
228	=item load $path	307	=item load $path
229		308
230	Loads the image at the given C<$path>. The image is set to plane tiling	309	Loads the image at the given C<$path>. The image is set to plane tiling
231	mode.	310	mode.
232		311
233	Loaded images will be cached for one cycle, and shared between temrinals	312	If the image is already in memory (e.g. because another terminal instance
234	running in the same process (e.g. in C<urxvtd>).	313	uses it), then the in-memory copy us returned instead.
235		314
236	=item load_uc $path	315	=item load_uc $path
237		316
238	Load uncached - same as load, but does not cache the image. This function	317	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	318	is I<always> loaded from the filesystem again, even if another copy of it
240	way.	319	is in memory at the time.
241		320
242	=cut	321	=cut
243		322
244	sub load_uc($) {	323	sub load_uc($) {
		324	$self->new_img_from_file ($_[0])
		325	}
		326
		327	sub load($) {
245	my ($path) = @_;	328	my ($path) = @_;
246		329
247	$_IMG_CACHE{$path} \|\| do {	330	$_IMG_CACHE{$path} \|\| do {
248	my $img = $self->new_img_from_file ($path);	331	my $img = load_uc $path;
249	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);	332	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
250	$img	333	$img
251	}	334	}
252	}	335	}
253		336
254	sub load($) {
255	my ($path) = @_;
256
257	$new->{load}{$path} = $old->{load}{$path} \|\| load_uc $path;
258	}
259
260	=item root	337	=item root
261		338
262	Returns the root window pixmap, that is, hopefully, the background image	339	Returns the root window pixmap, that is, hopefully, the background image
263	of your screen.	340	of your screen.
264		341
…		…
266	reevaluated when the bg image changes.	343	reevaluated when the bg image changes.
267		344
268	=cut	345	=cut
269		346
270	sub root() {	347	sub root() {
271	$new->{again}{rootpmap} = 1;	348	$frame->[FR_AGAIN]{rootpmap} = 1;
272	$self->new_img_from_root	349	$self->new_img_from_root
273	}	350	}
274		351
275	=item solid $colour	352	=item solid $colour
276		353
…		…
305		382
306	=item merge $img ...	383	=item merge $img ...
307		384
308	Takes any number of images and merges them together, creating a single	385	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	386	image containing them all. The tiling mode of the first image is used as
310	the tiling mdoe of the resulting image.	387	the tiling mode of the resulting image.
311		388
312	This function is called automatically when an expression returns multiple	389	This function is called automatically when an expression returns multiple
313	images.	390	images.
314		391
315	=cut	392	=cut
…		…
344	$base->draw ($_)	421	$base->draw ($_)
345	for @_;	422	for @_;
346		423
347	$base	424	$base
348	}	425	}
		426
		427	=back
349		428
350	=head2 TILING MODES	429	=head2 TILING MODES
351		430
352	The following operators modify the tiling mode of an image, that is, the	431	The following operators modify the tiling mode of an image, that is, the
353	way that pixels outside the image area are painted when the image is used.	432	way that pixels outside the image area are painted when the image is used.
…		…
450	Using these functions make your expression sensitive to window moves.	529	Using these functions make your expression sensitive to window moves.
451		530
452	These functions are mainly useful to align images to the root window.	531	These functions are mainly useful to align images to the root window.
453		532
454	Example: load an image and align it so it looks as if anchored to the	533	Example: load an image and align it so it looks as if anchored to the
455	background.	534	background (that's exactly what C<rootalign> does btw.):
456		535
457	move -TX, -TY, load "mybg.png"	536	move -TX, -TY, keep { load "mybg.png" }
458		537
459	=item TW	538	=item TW
460		539
461	Return the width (C<TW>) and height (C<TH>) of the terminal window (the	540	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	541	terminal window is the full window by default, and the character area only
…		…
468	the window size to conserve memory.	547	the window size to conserve memory.
469		548
470	Example: take the screen background, clip it to the window size, blur it a	549	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.	550	bit, align it to the window position and use it as background.
472		551
473	clip move -TX, -TY, once { blur 5, root }	552	clip move -TX, -TY, keep { blur 5, root }
474		553
475	=cut	554	=cut
476		555
477	sub TX() { $new->{again}{position} = 1; $x }	556	sub TX() { $frame->[FR_AGAIN]{position} = 1; $x }
478	sub TY() { $new->{again}{position} = 1; $y }	557	sub TY() { $frame->[FR_AGAIN]{position} = 1; $y }
479	sub TW() { $new->{again}{size} = 1; $w }	558	sub TW() { $frame->[FR_AGAIN]{size} = 1; $w }
480	sub TH() { $new->{again}{size} = 1; $h }	559	sub TH() { $frame->[FR_AGAIN]{size} = 1; $h }
481		560
482	=item now	561	=item now
483		562
484	Returns the current time as (fractional) seconds since the epoch.	563	Returns the current time as (fractional) seconds since the epoch.
485		564
…		…
492	C<$seconds> seconds.	571	C<$seconds> seconds.
493		572
494	Example: load some image and rotate it according to the time of day (as if it were	573	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.	574	the hour pointer of a clock). Update this image every minute.
496		575
		576	again 60;
497	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"	577	rotate 50, 50, (now % 86400) * -72 / 8640, scale keep { load "myclock.png" }
498		578
499	=item counter $seconds	579	=item counter $seconds
500		580
501	Like C<again>, but also returns an increasing counter value, starting at	581	Like C<again>, but also returns an increasing counter value, starting at
502	0, which might be useful for some simple animation effects.	582	0, which might be useful for some simple animation effects.
…		…
504	=cut	584	=cut
505		585
506	sub now() { urxvt::NOW }	586	sub now() { urxvt::NOW }
507		587
508	sub again($) {	588	sub again($) {
509	$new->{again}{time} = $_[0];	589	$frame->[FR_AGAIN]{time} = $_[0];
510	}	590	}
511		591
512	sub counter($) {	592	sub counter($) {
513	$new->{again}{time} = $_[0];	593	$frame->[FR_AGAIN]{time} = $_[0];
514	$self->{counter} + 0	594	$frame->[FR_STATE]{counter} + 0
515	}	595	}
516		596
517	=back	597	=back
518		598
519	=head2 SHAPE CHANGING OPERATORS	599	=head2 SHAPE CHANGING OPERATORS
…		…
539	assumed.	619	assumed.
540		620
541	Example: load an image, blur it, and clip it to the window size to save	621	Example: load an image, blur it, and clip it to the window size to save
542	memory.	622	memory.
543		623
544	clip blur 10, load "mybg.png"	624	clip keep { blur 10, load "mybg.png" }
545		625
546	=cut	626	=cut
547		627
548	sub clip($;$$;$$) {	628	sub clip($;$$;$$) {
549	my $img = pop;	629	my $img = pop;
…		…
643	the terminal window (or the box specified by C<$width> and C<$height> if	723	the terminal window (or the box specified by C<$width> and C<$height> if
644	given).	724	given).
645		725
646	Example: load an image and center it.	726	Example: load an image and center it.
647		727
648	center pad load "mybg.png"	728	center keep { pad load "mybg.png" }
649		729
650	=item rootalign $img	730	=item rootalign $img
651		731
652	Moves the image so that it appears glued to the screen as opposed to the	732	Moves the image so that it appears glued to the screen as opposed to the
653	window. This gives the illusion of a larger area behind the window. It is	733	window. This gives the illusion of a larger area behind the window. It is
654	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the	734	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
655	top left of the screen.	735	top left of the screen.
656		736
657	Example: load a background image, put it in mirror mode and root align it.	737	Example: load a background image, put it in mirror mode and root align it.
658		738
659	rootalign mirror load "mybg.png"	739	rootalign keep { mirror load "mybg.png" }
660		740
661	Example: take the screen background and align it, giving the illusion of	741	Example: take the screen background and align it, giving the illusion of
662	transparency as long as the window isn't in front of other windows.	742	transparency as long as the window isn't in front of other windows.
663		743
664	rootalign root	744	rootalign root
…		…
689		769
690	sub rootalign($) {	770	sub rootalign($) {
691	move -TX, -TY, $_[0]	771	move -TX, -TY, $_[0]
692	}	772	}
693		773
694	=item rotate $center_x, $center_y, $degrees	774	=item rotate $center_x, $center_y, $degrees, $img
695		775
696	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	776	Rotates the image clockwise by C<$degrees> degrees, around the point at
697	pointer at C<$center_x> and C<$center_y> (specified as factor of image	777	C<$center_x> and C<$center_y> (specified as factor of image width/height).
698	width/height).
699		778
700	#TODO# new width, height, maybe more operators?
701
702	Example: rotate the image by 90 degrees	779	Example: rotate the image by 90 degrees around it's center.
		780
		781	rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
703		782
704	=cut	783	=cut
705		784
706	sub rotate($$$$) {	785	sub rotate($$$$) {
707	my $img = pop;	786	my $img = pop;
…		…
718		797
719	The following operators change the pixels of the image.	798	The following operators change the pixels of the image.
720		799
721	=over 4	800	=over 4
722		801
		802	=item tint $color, $img
		803
		804	Tints the image in the given colour.
		805
		806	Example: tint the image red.
		807
		808	tint "red", load "rgb.png"
		809
		810	Example: the same, but specify the colour by component.
		811
		812	tint [1, 0, 0], load "rgb.png"
		813
		814	=cut
		815
		816	sub tint($$) {
		817	$_[1]->tint ($_[0])
		818	}
		819
723	=item contrast $factor, $img	820	=item contrast $factor, $img
724		821
725	=item contrast $r, $g, $b, $img	822	=item contrast $r, $g, $b, $img
726		823
727	=item contrast $r, $g, $b, $a, $img	824	=item contrast $r, $g, $b, $a, $img
…		…
756	latter in a white picture.	853	latter in a white picture.
757		854
758	Due to idiosyncrasies in the underlying XRender extension, biases less	855	Due to idiosyncrasies in the underlying XRender extension, biases less
759	than zero can be I<very> slow.	856	than zero can be I<very> slow.
760		857
		858	You can also try the experimental(!) C<muladd> operator.
		859
761	=cut	860	=cut
762		861
763	sub contrast($$;$$;$) {	862	sub contrast($$;$$;$) {
764	my $img = pop;	863	my $img = pop;
765	my ($r, $g, $b, $a) = @_;	864	my ($r, $g, $b, $a) = @_;
…		…
780	$a = 1 if @_ < 4;	879	$a = 1 if @_ < 4;
781		880
782	$img = $img->clone;	881	$img = $img->clone;
783	$img->brightness ($r, $g, $b, $a);	882	$img->brightness ($r, $g, $b, $a);
784	$img	883	$img
		884	}
		885
		886	=item muladd $mul, $add, $img # EXPERIMENTAL
		887
		888	First multipliesthe pixels by C<$mul>, then adds C<$add>. This cna be used
		889	to implement brightness and contrast at the same time, with a wider value
		890	range than contrast and brightness operators.
		891
		892	Due to numerous bugs in XRender implementations, it can also introduce a
		893	number of visual artifacts.
		894
		895	Example: increase contrast by a factor of C<$c> without changing image
		896	brightness too much.
		897
		898	muladd $c, (1 - $c) * 0.5, $img
		899
		900	=cut
		901
		902	sub muladd($$$) {
		903	$_[2]->muladd ($_[0], $_[1])
785	}	904	}
786		905
787	=item blur $radius, $img	906	=item blur $radius, $img
788		907
789	=item blur $radius_horz, $radius_vert, $img	908	=item blur $radius_horz, $radius_vert, $img
…		…
810	Anything that didn't fit any of the other categories, even after applying	929	Anything that didn't fit any of the other categories, even after applying
811	force and closing our eyes.	930	force and closing our eyes.
812		931
813	=over 4	932	=over 4
814		933
815	=item once { ... }	934	=item keep { ... }
816		935
817	This function takes a code block as argument, that is, one or more	936	This operator takes a code block as argument, that is, one or more
818	statements enclosed by braces.	937	statements enclosed by braces.
819		938
820	The trick is that this code block is only evaluated once - future calls	939	The trick is that this code block is only evaluated when the outcome
821	will simply return the original image (yes, it should only be used with	940	changes - on other calls the C<keep> simply returns the image it computed
822	images).	941	previously (yes, it should only be used with images). Or in other words,
		942	C<keep> I<caches> the result of the code block so it doesn't need to be
		943	computed again.
823		944
824	This can be extremely useful to avoid redoign the same slow operations	945	This can be extremely useful to avoid redoing slow operations - for
825	again and again- for example, if your background expression takes the root	946	example, if your background expression takes the root background, blurs it
826	background, blurs it and then root-aligns it it would have to blur the	947	and then root-aligns it it would have to blur the root background on every
827	root background on every window move or resize.	948	window move or resize.
828		949
		950	Another example is C<load>, which can be quite slow.
		951
		952	In fact, urxvt itself encloses the whole expression in some kind of
		953	C<keep> block so it only is reevaluated as required.
		954
829	Putting the blur into a C<once> block will make sure the blur is only done	955	Putting the blur into a C<keep> block will make sure the blur is only done
830	once:	956	once, while the C<rootalign> is still done each time the window moves.
831		957
832	rootlign once { blur 10, root }	958	rootalign keep { blur 10, root }
833		959
834	This leaves the question of how to force reevaluation of the block, in	960	This leaves the question of how to force reevaluation of the block,
835	case the root background changes: Right now, all once blocks forget that	961	in case the root background changes: If expression inside the block
836	they ahve been executed before each time the root background changes (if	962	is sensitive to some event (root background changes, window geometry
837	the expression is sensitive to that) or when C<once_again> is called.	963	changes), then it will be reevaluated automatically as needed.
838		964
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	965	=cut
845		966
846	sub once(&) {	967	sub keep(&) {
847	my $once = $self->{once_cache}{$_[0]+0} \|\|= do {	968	my $id = $_[0]+0;
848	local $new->{again};	969
849	my @res = $_[0]();	970	local $frame = $self->{frame_cache}{$id} \|\|= [$frame];
850	[$new->{again}, \@res]	971
		972	unless ($frame->[FR_CACHE]) {
		973	$frame->[FR_CACHE] = [ $_[0]() ];
		974
		975	my $self = $self;
		976	my $frame = $frame;
		977	Scalar::Util::weaken $frame;
		978	$self->compile_frame ($frame, sub {
		979	# clear this frame cache, also for all parents
		980	for (my $frame = $frame; $frame; $frame = $frame->[0]) {
		981	undef $frame->[FR_CACHE];
		982	}
		983
		984	$self->recalculate;
851	};	985	});
852
853	$new->{again} = {
854	%{ $new->{again} },
855	%{ $once->[0] }
856	};	986	};
857		987
858	# in scalar context we always return the first original result, which	988	# in scalar context we always return the first original result, which
859	# is not quite how perl works.	989	# is not quite how perl works.
860	wantarray	990	wantarray
861	? @{ $once->[1] }	991	? @{ $frame->[FR_CACHE] }
862	: $once->[1][0]	992	: $frame->[FR_CACHE][0]
		993	}
		994
		995	# sub keep_clear() {
		996	# delete $self->{frame_cache};
863	}	997	# }
864
865	sub once_again() {
866	delete $self->{once_cache};
867	}
868		998
869	=back	999	=back
870		1000
871	=cut	1001	=cut
872		1002
873	}	1003	}
874		1004
875	sub parse_expr {	1005	sub parse_expr {
876	my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}";	1006	my $expr = eval
		1007	"sub {\n"
		1008	. "package urxvt::bgdsl;\n"
		1009	. "#line 0 'background expression'\n"
		1010	. "$_[0]\n"
		1011	. "}";
877	die if $@;	1012	die if $@;
878	$expr	1013	$expr
879	}	1014	}
880		1015
881	# compiles a parsed expression	1016	# compiles a parsed expression
882	sub set_expr {	1017	sub set_expr {
883	my ($self, $expr) = @_;	1018	my ($self, $expr) = @_;
884		1019
		1020	$self->{root} = []; # the outermost frame
885	$self->{expr} = $expr;	1021	$self->{expr} = $expr;
886	$self->recalculate;	1022	$self->recalculate;
		1023	}
		1024
		1025	# takes a hash of sensitivity indicators and installs watchers
		1026	sub compile_frame {
		1027	my ($self, $frame, $cb) = @_;
		1028
		1029	my $state = $frame->[urxvt::bgdsl::FR_STATE] \|\|= {};
		1030	my $again = $frame->[urxvt::bgdsl::FR_AGAIN];
		1031
		1032	# don't keep stuff alive
		1033	Scalar::Util::weaken $state;
		1034
		1035	if ($again->{nested}) {
		1036	$state->{nested} = 1;
		1037	} else {
		1038	delete $state->{nested};
		1039	}
		1040
		1041	if (my $interval = $again->{time}) {
		1042	$state->{time} = [$interval, urxvt::timer->new->after ($interval)->interval ($interval)]
		1043	if $state->{time}[0] != $interval;
		1044
		1045	# callback might have changed, although we could just rule that out
		1046	$state->{time}[1]->cb (sub {
		1047	++$state->{counter};
		1048	$cb->();
		1049	});
		1050	} else {
		1051	delete $state->{time};
		1052	}
		1053
		1054	if ($again->{position}) {
		1055	$state->{position} = $self->on (position_change => $cb);
		1056	} else {
		1057	delete $state->{position};
		1058	}
		1059
		1060	if ($again->{size}) {
		1061	$state->{size} = $self->on (size_change => $cb);
		1062	} else {
		1063	delete $state->{size};
		1064	}
		1065
		1066	if ($again->{rootpmap}) {
		1067	$state->{rootpmap} = $self->on (rootpmap_change => $cb);
		1068	} else {
		1069	delete $state->{rootpmap};
		1070	}
887	}	1071	}
888		1072
889	# evaluate the current bg expression	1073	# evaluate the current bg expression
890	sub recalculate {	1074	sub recalculate {
891	my ($arg_self) = @_;	1075	my ($arg_self) = @_;
…		…
901		1085
902	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	1086	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
903		1087
904	# set environment to evaluate user expression	1088	# set environment to evaluate user expression
905		1089
906	local $self = $arg_self;	1090	local $self = $arg_self;
907
908	local $HOME = $ENV{HOME};	1091	local $HOME = $ENV{HOME};
909	local $old = $self->{state};	1092	local $frame = $self->{root};
910	local $new = my $state = $self->{state} = {};
911		1093
912	($x, $y, $w, $h) =
913	$self->background_geometry ($self->{border});	1094	($x, $y, $w, $h) = $self->background_geometry ($self->{border});
914		1095
915	# evaluate user expression	1096	# evaluate user expression
916		1097
917	my $img = eval { urxvt::bgdsl::merge $self->{expr}->() };	1098	my @img = eval { $self->{expr}->() };
918	die $@ if $@;	1099	die $@ if $@;
919	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";	1100	die "background-expr did not return anything.\n" unless @img;
		1101	die "background-expr: expected image(s), got something else.\n"
		1102	if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;
		1103
		1104	my $img = urxvt::bgdsl::merge @img;
		1105
		1106	$frame->[FR_AGAIN]{size} = 1
		1107	if $img->repeat_mode != urxvt::RepeatNormal;
920		1108
921	# if the expression is sensitive to external events, prepare reevaluation then	1109	# if the expression is sensitive to external events, prepare reevaluation then
922		1110	$self->compile_frame ($frame, sub { $arg_self->recalculate });
923	my $again = delete $state->{again};
924
925	$again->{size} = 1
926	if $img->repeat_mode != urxvt::RepeatNormal;
927
928	if (my $again = $again->{time}) {
929	my $self = $self;
930	$state->{timer} = $again == $old->{again}
931	? $old->{timer}
932	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
933	++$self->{counter};
934	$self->recalculate
935	});
936	}
937
938	if ($again->{position}) {
939	$self->enable (position_change => sub { $_[0]->recalculate });
940	} else {
941	$self->disable ("position_change");
942	}
943
944	if ($again->{size}) {
945	$self->enable (size_change => sub { $_[0]->recalculate });
946	} else {
947	$self->disable ("size_change");
948	}
949
950	if ($again->{rootpmap}) {
951	$self->enable (rootpmap_change => sub {
952	delete $_[0]{once_cache}; # this will override once-block values from
953	$_[0]->recalculate;
954	});
955	} else {
956	$self->disable ("rootpmap_change");
957	}
958		1111
959	# clear stuff we no longer need	1112	# clear stuff we no longer need
960		1113
961	%$old = ();	1114	# unless (%{ $frame->[FR_STATE] }) {
962
963	unless (%$again) {
964	delete $self->{state};	1115	# delete $self->{state};
965	delete $self->{expr};	1116	# delete $self->{expr};
966	}	1117	# }
967		1118
968	# set background pixmap	1119	# set background pixmap
969		1120
970	$self->set_background ($img, $self->{border});	1121	$self->set_background ($img, $self->{border});
971	$self->scr_recolour (0);	1122	$self->scr_recolour (0);

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.62 by root, Sun Jun 17 21:58:18 2012 UTC vs. Revision 1.76 by root, Tue Aug 14 23:57:07 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.62 by root, Sun Jun 17 21:58:18 2012 UTC vs.
Revision 1.76 by root, Tue Aug 14 23:57:07 2012 UTC