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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.56 by root, Thu Jun 14 17:06:57 2012 UTC vs.
Revision 1.83 by sf-exg, Sun Jun 2 17:55:07 2013 UTC

…		…
4	#:META:X_RESOURCE:%.border:boolean:respect the terminal border	4	#:META:X_RESOURCE:%.border:boolean:respect the terminal border
5	#:META:X_RESOURCE:%.interval:seconds:minimum time between updates	5	#:META:X_RESOURCE:%.interval:seconds:minimum time between updates
6		6
7	=head1 NAME	7	=head1 NAME
8		8
9	background - manage terminal background	9	background - manage terminal background
10		10
11	=head1 SYNOPSIS	11	=head1 SYNOPSIS
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 is 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. The image is set to extend mode.	340	of your screen.
264		341
265	This function makes your expression root sensitive, that means it will be	342	This function makes your expression root sensitive, that means it will be
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
…		…
285	=cut	362	=cut
286		363
287	sub solid($;$$) {	364	sub solid($;$$) {
288	my $colour = pop;	365	my $colour = pop;
289		366
290	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);	367	my $img = $self->new_img (urxvt::PictStandardARGB32, 0, 0, $_[0] \|\| 1, $_[1] \|\| 1);
291	$img->fill ($colour);	368	$img->fill ($colour);
292	$img	369	$img
293	}	370	}
294		371
295	=item clone $img	372	=item clone $img
…		…
303	$_[0]->clone	380	$_[0]->clone
304	}	381	}
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 image containing them all.	385	Takes any number of images and merges them together, creating a single
		386	image containing them all. The tiling mode of the first image is used as
		387	the tiling mode of the resulting image.
		388
		389	This function is called automatically when an expression returns multiple
		390	images.
309		391
310	=cut	392	=cut
311		393
312	sub merge(@) {	394	sub merge(@) {
313	#TODO	395	return $_[0] unless $#_;
		396
		397	# rather annoyingly clumsy, but optimisation is for another time
		398
		399	my $x0 = +1e9;
		400	my $y0 = +1e9;
		401	my $x1 = -1e9;
		402	my $y1 = -1e9;
		403
		404	for (@_) {
		405	my ($x, $y, $w, $h) = $_->geometry;
		406
		407	$x0 = $x if $x0 > $x;
		408	$y0 = $y if $y0 > $y;
		409
		410	$x += $w;
		411	$y += $h;
		412
		413	$x1 = $x if $x1 < $x;
		414	$y1 = $y if $y1 < $y;
		415	}
		416
		417	my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
		418	$base->repeat_mode ($_[0]->repeat_mode);
		419	$base->fill ([0, 0, 0, 0]);
		420
		421	$base->draw ($_)
		422	for @_;
		423
		424	$base
314	}	425	}
		426
		427	=back
315		428
316	=head2 TILING MODES	429	=head2 TILING MODES
317		430
318	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
319	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.
…		…
416	Using these functions make your expression sensitive to window moves.	529	Using these functions make your expression sensitive to window moves.
417		530
418	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.
419		532
420	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
421	background.	534	background (that's exactly what C<rootalign> does btw.):
422		535
423	move -TX, -TY, load "mybg.png"	536	move -TX, -TY, keep { load "mybg.png" }
424		537
425	=item TW	538	=item TW
		539
		540	=item TH
426		541
427	Return the width (C<TW>) and height (C<TH>) of the terminal window (the	542	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
428	terminal window is the full window by default, and the character area only	543	terminal window is the full window by default, and the character area only
429	when in border-respect mode).	544	when in border-respect mode).
430		545
…		…
434	the window size to conserve memory.	549	the window size to conserve memory.
435		550
436	Example: take the screen background, clip it to the window size, blur it a	551	Example: take the screen background, clip it to the window size, blur it a
437	bit, align it to the window position and use it as background.	552	bit, align it to the window position and use it as background.
438		553
439	clip move -TX, -TY, once { blur 5, root }	554	clip move -TX, -TY, keep { blur 5, root }
440		555
441	=cut	556	=cut
442		557
443	sub TX() { $new->{again}{position} = 1; $x }	558	sub TX() { $frame->[FR_AGAIN]{position} = 1; $x }
444	sub TY() { $new->{again}{position} = 1; $y }	559	sub TY() { $frame->[FR_AGAIN]{position} = 1; $y }
445	sub TW() { $new->{again}{size} = 1; $w }	560	sub TW() { $frame->[FR_AGAIN]{size} = 1; $w }
446	sub TH() { $new->{again}{size} = 1; $h }	561	sub TH() { $frame->[FR_AGAIN]{size} = 1; $h }
447		562
448	=item now	563	=item now
449		564
450	Returns the current time as (fractional) seconds since the epoch.	565	Returns the current time as (fractional) seconds since the epoch.
451		566
…		…
458	C<$seconds> seconds.	573	C<$seconds> seconds.
459		574
460	Example: load some image and rotate it according to the time of day (as if it were	575	Example: load some image and rotate it according to the time of day (as if it were
461	the hour pointer of a clock). Update this image every minute.	576	the hour pointer of a clock). Update this image every minute.
462		577
		578	again 60;
463	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"	579	rotate 50, 50, (now % 86400) * -72 / 8640, scale keep { load "myclock.png" }
464		580
465	=item counter $seconds	581	=item counter $seconds
466		582
467	Like C<again>, but also returns an increasing counter value, starting at	583	Like C<again>, but also returns an increasing counter value, starting at
468	0, which might be useful for some simple animation effects.	584	0, which might be useful for some simple animation effects.
…		…
470	=cut	586	=cut
471		587
472	sub now() { urxvt::NOW }	588	sub now() { urxvt::NOW }
473		589
474	sub again($) {	590	sub again($) {
475	$new->{again}{time} = $_[0];	591	$frame->[FR_AGAIN]{time} = $_[0];
476	}	592	}
477		593
478	sub counter($) {	594	sub counter($) {
479	$new->{again}{time} = $_[0];	595	$frame->[FR_AGAIN]{time} = $_[0];
480	$self->{counter} + 0	596	$frame->[FR_STATE]{counter} + 0
481	}	597	}
482		598
483	=back	599	=back
484		600
485	=head2 SHAPE CHANGING OPERATORS	601	=head2 SHAPE CHANGING OPERATORS
…		…
497	Clips an image to the given rectangle. If the rectangle is outside the	613	Clips an image to the given rectangle. If the rectangle is outside the
498	image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is	614	image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is
499	larger than the image, then the tiling mode defines how the extra pixels	615	larger than the image, then the tiling mode defines how the extra pixels
500	will be filled.	616	will be filled.
501		617
502	If C<$x> an C<$y> are missing, then C<0> is assumed for both.	618	If C<$x> and C<$y> are missing, then C<0> is assumed for both.
503		619
504	If C<$width> and C<$height> are missing, then the window size will be	620	If C<$width> and C<$height> are missing, then the window size will be
505	assumed.	621	assumed.
506		622
507	Example: load an image, blur it, and clip it to the window size to save	623	Example: load an image, blur it, and clip it to the window size to save
508	memory.	624	memory.
509		625
510	clip blur 10, load "mybg.png"	626	clip keep { blur 10, load "mybg.png" }
511		627
512	=cut	628	=cut
513		629
514	sub clip($;$$;$$) {	630	sub clip($;$$;$$) {
515	my $img = pop;	631	my $img = pop;
…		…
525	=item scale $width_factor, $height_factor, $img	641	=item scale $width_factor, $height_factor, $img
526		642
527	Scales the image by the given factors in horizontal	643	Scales the image by the given factors in horizontal
528	(C<$width>) and vertical (C<$height>) direction.	644	(C<$width>) and vertical (C<$height>) direction.
529		645
530	If only one factor is give, it is used for both directions.	646	If only one factor is given, it is used for both directions.
531		647
532	If no factors are given, scales the image to the window size without	648	If no factors are given, scales the image to the window size without
533	keeping aspect.	649	keeping aspect.
534		650
535	=item resize $width, $height, $img	651	=item resize $width, $height, $img
…		…
609	the terminal window (or the box specified by C<$width> and C<$height> if	725	the terminal window (or the box specified by C<$width> and C<$height> if
610	given).	726	given).
611		727
612	Example: load an image and center it.	728	Example: load an image and center it.
613		729
614	center pad load "mybg.png"	730	center keep { pad load "mybg.png" }
615		731
616	=item rootalign $img	732	=item rootalign $img
617		733
618	Moves the image so that it appears glued to the screen as opposed to the	734	Moves the image so that it appears glued to the screen as opposed to the
619	window. This gives the illusion of a larger area behind the window. It is	735	window. This gives the illusion of a larger area behind the window. It is
620	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the	736	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
621	top left of the screen.	737	top left of the screen.
622		738
623	Example: load a background image, put it in mirror mode and root align it.	739	Example: load a background image, put it in mirror mode and root align it.
624		740
625	rootalign mirror load "mybg.png"	741	rootalign keep { mirror load "mybg.png" }
626		742
627	Example: take the screen background and align it, giving the illusion of	743	Example: take the screen background and align it, giving the illusion of
628	transparency as long as the window isn't in front of other windows.	744	transparency as long as the window isn't in front of other windows.
629		745
630	rootalign root	746	rootalign root
…		…
655		771
656	sub rootalign($) {	772	sub rootalign($) {
657	move -TX, -TY, $_[0]	773	move -TX, -TY, $_[0]
658	}	774	}
659		775
660	=item rotate $center_x, $center_y, $degrees	776	=item rotate $center_x, $center_y, $degrees, $img
661		777
662	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	778	Rotates the image clockwise by C<$degrees> degrees, around the point at
663	pointer at C<$center_x> and C<$center_y> (specified as factor of image	779	C<$center_x> and C<$center_y> (specified as factor of image width/height).
664	width/height).
665		780
666	#TODO# new width, height, maybe more operators?
667
668	Example: rotate the image by 90 degrees	781	Example: rotate the image by 90 degrees around its center.
		782
		783	rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
669		784
670	=cut	785	=cut
671		786
672	sub rotate($$$$) {	787	sub rotate($$$$) {
673	my $img = pop;	788	my $img = pop;
674	$img->rotate (	789	$img->rotate (
675	$_[0] * $img->w,	790	$_[0] * ($img->w + $img->x),
676	$_[1] * $img->h,	791	$_[1] * ($img->h + $img->y),
677	$_[2] * (3.14159265 / 180),	792	$_[2] * (3.14159265 / 180),
678	)	793	)
679	}	794	}
680		795
681	=back	796	=back
…		…
683	=head2 COLOUR MODIFICATIONS	798	=head2 COLOUR MODIFICATIONS
684		799
685	The following operators change the pixels of the image.	800	The following operators change the pixels of the image.
686		801
687	=over 4	802	=over 4
		803
		804	=item tint $color, $img
		805
		806	Tints the image in the given colour.
		807
		808	Example: tint the image red.
		809
		810	tint "red", load "rgb.png"
		811
		812	Example: the same, but specify the colour by component.
		813
		814	tint [1, 0, 0], load "rgb.png"
		815
		816	=cut
		817
		818	sub tint($$) {
		819	$_[1]->tint ($_[0])
		820	}
		821
		822	=item shade $factor, $img
		823
		824	Shade the image by the given factor.
		825
		826	=cut
		827
		828	sub shade($$) {
		829	$_[1]->shade ($_[0])
		830	}
688		831
689	=item contrast $factor, $img	832	=item contrast $factor, $img
690		833
691	=item contrast $r, $g, $b, $img	834	=item contrast $r, $g, $b, $img
692		835
…		…
722	latter in a white picture.	865	latter in a white picture.
723		866
724	Due to idiosyncrasies in the underlying XRender extension, biases less	867	Due to idiosyncrasies in the underlying XRender extension, biases less
725	than zero can be I<very> slow.	868	than zero can be I<very> slow.
726		869
		870	You can also try the experimental(!) C<muladd> operator.
		871
727	=cut	872	=cut
728		873
729	sub contrast($$;$$;$) {	874	sub contrast($$;$$;$) {
730	my $img = pop;	875	my $img = pop;
731	my ($r, $g, $b, $a) = @_;	876	my ($r, $g, $b, $a) = @_;
…		…
746	$a = 1 if @_ < 4;	891	$a = 1 if @_ < 4;
747		892
748	$img = $img->clone;	893	$img = $img->clone;
749	$img->brightness ($r, $g, $b, $a);	894	$img->brightness ($r, $g, $b, $a);
750	$img	895	$img
		896	}
		897
		898	=item muladd $mul, $add, $img # EXPERIMENTAL
		899
		900	First multiplies the pixels by C<$mul>, then adds C<$add>. This can be used
		901	to implement brightness and contrast at the same time, with a wider value
		902	range than contrast and brightness operators.
		903
		904	Due to numerous bugs in XRender implementations, it can also introduce a
		905	number of visual artifacts.
		906
		907	Example: increase contrast by a factor of C<$c> without changing image
		908	brightness too much.
		909
		910	muladd $c, (1 - $c) * 0.5, $img
		911
		912	=cut
		913
		914	sub muladd($$$) {
		915	$_[2]->muladd ($_[0], $_[1])
751	}	916	}
752		917
753	=item blur $radius, $img	918	=item blur $radius, $img
754		919
755	=item blur $radius_horz, $radius_vert, $img	920	=item blur $radius_horz, $radius_vert, $img
…		…
776	Anything that didn't fit any of the other categories, even after applying	941	Anything that didn't fit any of the other categories, even after applying
777	force and closing our eyes.	942	force and closing our eyes.
778		943
779	=over 4	944	=over 4
780		945
781	=item once { ... }	946	=item keep { ... }
782		947
783	This function takes a code block as argument, that is, one or more	948	This operator takes a code block as argument, that is, one or more
784	statements enclosed by braces.	949	statements enclosed by braces.
785		950
786	The trick is that this code block is only evaluated once - future calls	951	The trick is that this code block is only evaluated when the outcome
787	will simply return the original image (yes, it should only be used with	952	changes - on other calls the C<keep> simply returns the image it computed
788	images).	953	previously (yes, it should only be used with images). Or in other words,
		954	C<keep> I<caches> the result of the code block so it doesn't need to be
		955	computed again.
789		956
790	This can be extremely useful to avoid redoign the same slow operations	957	This can be extremely useful to avoid redoing slow operations - for
791	again and again- for example, if your background expression takes the root	958	example, if your background expression takes the root background, blurs it
792	background, blurs it and then root-aligns it it would have to blur the	959	and then root-aligns it it would have to blur the root background on every
793	root background on every window move or resize.	960	window move or resize.
794		961
		962	Another example is C<load>, which can be quite slow.
		963
		964	In fact, urxvt itself encloses the whole expression in some kind of
		965	C<keep> block so it only is reevaluated as required.
		966
795	Putting the blur into a C<once> block will make sure the blur is only done	967	Putting the blur into a C<keep> block will make sure the blur is only done
796	once:	968	once, while the C<rootalign> is still done each time the window moves.
797		969
798	rootlign once { blur 10, root }	970	rootalign keep { blur 10, root }
799		971
800	This leaves the question of how to force reevaluation of the block, in	972	This leaves the question of how to force reevaluation of the block,
801	case the root background changes: Right now, all once blocks forget that	973	in case the root background changes: If expression inside the block
802	they ahve been executed before each time the root background changes (if	974	is sensitive to some event (root background changes, window geometry
803	the expression is sensitive to that) or when C<once_again> is called.	975	changes), then it will be reevaluated automatically as needed.
804		976
805	=item once_again
806
807	Resets all C<once> block as if they had never been called, i.e. on the
808	next call they will be reevaluated again.
809
810	=cut	977	=cut
811		978
812	sub once(&) {	979	sub keep(&) {
813	my $once = $self->{once_cache}{$_[0]+0} \|\|= do {	980	my $id = $_[0]+0;
814	local $new->{again};	981
815	my @res = $_[0]();	982	local $frame = $self->{frame_cache}{$id} \|\|= [$frame];
816	[$new->{again}, \@res]	983
		984	unless ($frame->[FR_CACHE]) {
		985	$frame->[FR_CACHE] = [ $_[0]() ];
		986
		987	my $self = $self;
		988	my $frame = $frame;
		989	Scalar::Util::weaken $frame;
		990	$self->compile_frame ($frame, sub {
		991	# clear this frame cache, also for all parents
		992	for (my $frame = $frame; $frame; $frame = $frame->[0]) {
		993	undef $frame->[FR_CACHE];
		994	}
		995
		996	$self->recalculate;
817	};	997	});
818
819	$new->{again} = {
820	%{ $new->{again} },
821	%{ $once->[0] }
822	};	998	};
823		999
824	# in scalar context we always return the first original result, which	1000	# in scalar context we always return the first original result, which
825	# is not quite how perl works.	1001	# is not quite how perl works.
826	wantarray	1002	wantarray
827	? @{ $once->[1] }	1003	? @{ $frame->[FR_CACHE] }
828	: $once->[1][0]	1004	: $frame->[FR_CACHE][0]
		1005	}
		1006
		1007	# sub keep_clear() {
		1008	# delete $self->{frame_cache};
829	}	1009	# }
830
831	sub once_again() {
832	delete $self->{once_cache};
833	}
834		1010
835	=back	1011	=back
836		1012
837	=cut	1013	=cut
838		1014
839	}	1015	}
840		1016
841	sub parse_expr {	1017	sub parse_expr {
842	my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}";	1018	my $expr = eval
		1019	"sub {\n"
		1020	. "package urxvt::bgdsl;\n"
		1021	. "#line 0 'background expression'\n"
		1022	. "$_[0]\n"
		1023	. "}";
843	die if $@;	1024	die if $@;
844	$expr	1025	$expr
845	}	1026	}
846		1027
847	# compiles a parsed expression	1028	# compiles a parsed expression
848	sub set_expr {	1029	sub set_expr {
849	my ($self, $expr) = @_;	1030	my ($self, $expr) = @_;
850		1031
		1032	$self->{root} = []; # the outermost frame
851	$self->{expr} = $expr;	1033	$self->{expr} = $expr;
852	$self->recalculate;	1034	$self->recalculate;
		1035	}
		1036
		1037	# takes a hash of sensitivity indicators and installs watchers
		1038	sub compile_frame {
		1039	my ($self, $frame, $cb) = @_;
		1040
		1041	my $state = $frame->[urxvt::bgdsl::FR_STATE] \|\|= {};
		1042	my $again = $frame->[urxvt::bgdsl::FR_AGAIN];
		1043
		1044	# don't keep stuff alive
		1045	Scalar::Util::weaken $state;
		1046
		1047	if ($again->{nested}) {
		1048	$state->{nested} = 1;
		1049	} else {
		1050	delete $state->{nested};
		1051	}
		1052
		1053	if (my $interval = $again->{time}) {
		1054	$state->{time} = [$interval, urxvt::timer->new->after ($interval)->interval ($interval)]
		1055	if $state->{time}[0] != $interval;
		1056
		1057	# callback might have changed, although we could just rule that out
		1058	$state->{time}[1]->cb (sub {
		1059	++$state->{counter};
		1060	$cb->();
		1061	});
		1062	} else {
		1063	delete $state->{time};
		1064	}
		1065
		1066	if ($again->{position}) {
		1067	$state->{position} = $self->on (position_change => $cb);
		1068	} else {
		1069	delete $state->{position};
		1070	}
		1071
		1072	if ($again->{size}) {
		1073	$state->{size} = $self->on (size_change => $cb);
		1074	} else {
		1075	delete $state->{size};
		1076	}
		1077
		1078	if ($again->{rootpmap}) {
		1079	$state->{rootpmap} = $self->on (rootpmap_change => $cb);
		1080	} else {
		1081	delete $state->{rootpmap};
		1082	}
853	}	1083	}
854		1084
855	# evaluate the current bg expression	1085	# evaluate the current bg expression
856	sub recalculate {	1086	sub recalculate {
857	my ($arg_self) = @_;	1087	my ($arg_self) = @_;
…		…
867		1097
868	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	1098	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
869		1099
870	# set environment to evaluate user expression	1100	# set environment to evaluate user expression
871		1101
872	local $self = $arg_self;	1102	local $self = $arg_self;
873
874	local $HOME = $ENV{HOME};	1103	local $HOME = $ENV{HOME};
875	local $old = $self->{state};	1104	local $frame = $self->{root};
876	local $new = my $state = $self->{state} = {};
877		1105
878	($x, $y, $w, $h) =
879	$self->background_geometry ($self->{border});	1106	($x, $y, $w, $h) = $self->background_geometry ($self->{border});
880		1107
881	# evaluate user expression	1108	# evaluate user expression
882		1109
883	my $img = eval { $self->{expr}->() };	1110	my @img = eval { $self->{expr}->() };
884	warn $@ if $@;#d#	1111	die $@ if $@;
885	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";	1112	die "background-expr did not return anything.\n" unless @img;
		1113	die "background-expr: expected image(s), got something else.\n"
		1114	if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;
		1115
		1116	my $img = urxvt::bgdsl::merge @img;
		1117
		1118	$frame->[FR_AGAIN]{size} = 1
		1119	if $img->repeat_mode != urxvt::RepeatNormal;
886		1120
887	# if the expression is sensitive to external events, prepare reevaluation then	1121	# if the expression is sensitive to external events, prepare reevaluation then
888		1122	$self->compile_frame ($frame, sub { $arg_self->recalculate });
889	my $again = delete $state->{again};
890
891	$again->{size} = 1
892	if $img->repeat_mode != urxvt::RepeatNormal;
893
894	if (my $again = $again->{time}) {
895	my $self = $self;
896	$state->{timer} = $again == $old->{again}
897	? $old->{timer}
898	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
899	++$self->{counter};
900	$self->recalculate
901	});
902	}
903
904	if ($again->{position}) {
905	$self->enable (position_change => sub { $_[0]->recalculate });
906	} else {
907	$self->disable ("position_change");
908	}
909
910	if ($again->{size}) {
911	$self->enable (size_change => sub { $_[0]->recalculate });
912	} else {
913	$self->disable ("size_change");
914	}
915
916	if ($again->{rootpmap}) {
917	$self->enable (rootpmap_change => sub {
918	delete $_[0]{once_cache}; # this will override once-block values from
919	$_[0]->recalculate;
920	});
921	} else {
922	$self->disable ("rootpmap_change");
923	}
924		1123
925	# clear stuff we no longer need	1124	# clear stuff we no longer need
926		1125
927	%$old = ();	1126	# unless (%{ $frame->[FR_STATE] }) {
928
929	unless (%$again) {
930	delete $self->{state};	1127	# delete $self->{state};
931	delete $self->{expr};	1128	# delete $self->{expr};
932	}	1129	# }
933		1130
934	# set background pixmap	1131	# set background pixmap
935		1132
936	$self->set_background ($img, $self->{border});	1133	$self->set_background ($img, $self->{border});
937	$self->scr_recolour (0);	1134	$self->scr_recolour (0);

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.56 by root, Thu Jun 14 17:06:57 2012 UTC vs. Revision 1.83 by sf-exg, Sun Jun 2 17:55:07 2013 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.56 by root, Thu Jun 14 17:06:57 2012 UTC vs.
Revision 1.83 by sf-exg, Sun Jun 2 17:55:07 2013 UTC