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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.29 by root, Thu Jun 7 13:12:08 2012 UTC vs.
Revision 1.55 by root, Thu Jun 14 16:48:57 2012 UTC

…		…
1	#! perl	1	#! perl
2		2
3	#:META:X_RESOURCE:%.expr:string:background expression	3	#:META:X_RESOURCE:%.expr:string:background expression
4	#:META:X_RESOURCE:%.enable:boolean:some boolean	4	#:META:X_RESOURCE:%.border:boolean:respect the terminal border
5	#:META:X_RESOURCE:%.extra.:value:extra config	5	#:META:X_RESOURCE:%.interval:seconds:minimum time between updates
6		6
7	our $EXPR;	7	=head1 NAME
8	#$EXPR = 'move W * 0.1, -H * 0.1, resize W * 0.5, H * 0.5, repeat_none load "opensource.png"';
9	$EXPR = 'move -X, -Y, load "argb.png"';
10	#$EXPR = '
11	# rotate W, H, 50, 50, counter 1/59.95, repeat_mirror,
12	# clip X, Y, W, H, repeat_mirror,
13	# load "/root/pix/das_fette_schwein.jpg"
14	#';
15	#$EXPR = 'solid "red"';
16	#$EXPR = 'blur root, 10, 10'
17	#$EXPR = 'blur move (root, -x, -y), 5, 5'
18	#resize load "/root/pix/das_fette_schwein.jpg", w, h
19		8
20	use Safe;	9	background - manage terminal background
21		10
		11	=head1 SYNOPSIS
		12
		13	urxvt --background-expr 'background expression'
		14	--background-border
		15	--background-interval seconds
		16
		17	=head1 DESCRIPTION
		18
		19	This extension manages the terminal background by creating a picture that
		20	is behind the text, replacing the normal background colour.
		21
		22	It does so by evaluating a Perl expression that I<calculates> the image on
		23	the fly, for example, by grabbing the root background or loading a file.
		24
		25	While the full power of Perl is available, the operators have been design
		26	to be as simple as possible.
		27
		28	For example, to load an image and scale it to the window size, you would
		29	use:
		30
		31	urxvt --background-expr 'scale load "/path/to/mybg.png"'
		32
		33	Or specified as a X resource:
		34
		35	URxvt.background-expr: scale load "/path/to/mybg.png"
		36
		37	=head1 THEORY OF OPERATION
		38
		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
		41	extended as necessary to cover the whole terminal window, and is set as a
		42	background pixmap.
		43
		44	If the image contains an alpha channel, then it will be used as-is in
		45	visuals that support alpha channels (for example, for a compositing
		46	manager). In other visuals, the terminal background colour will be used to
		47	replace any transparency.
		48
		49	When the expression relies, directly or indirectly, on the window size,
		50	position, the root pixmap, or a timer, then it will be remembered. If not,
		51	then it will be removed.
		52
		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
		55	pixmap is replaced by another one the root background changes; or when the
		56	timer elapses), then the expression will be evaluated again.
		57
		58	For example, an expression such as C<scale load "$HOME/mybg.png"> scales the
		59	image to the window size, so it relies on the window size and will
		60	be reevaluated each time it is changed, but not when it moves for
		61	example. That ensures that the picture always fills the terminal, even
		62	after its size changes.
		63
		64	=head2 EXPRESSIONS
		65
		66	Expressions are normal Perl expressions, in fact, they are Perl blocks -
		67	which means you could use multiple lines and statements:
		68
		69	again 3600;
		70	if (localtime now)[6]) {
		71	return scale load "$HOME/weekday.png";
		72	} else {
		73	return scale load "$HOME/sunday.png";
		74	}
		75
		76	This expression is evaluated once per hour. It will set F<sunday.png> as
		77	background on Sundays, and F<weekday.png> on all other days.
		78
		79	Fortunately, we expect that most expressions will be much simpler, with
		80	little Perl knowledge needed.
		81
		82	Basically, you always start with a function that "generates" an image
		83	object, such as C<load>, which loads an image from disk, or C<root>, which
		84	returns the root window background image:
		85
		86	load "$HOME/mypic.png"
		87
		88	The path is usually specified as a quoted string (the exact rules can be
		89	found in the L<perlop> manpage). The F<$HOME> at the beginning of the
		90	string is expanded to the home directory.
		91
		92	Then you prepend one or more modifiers or filtering expressions, such as
		93	C<scale>:
		94
		95	scale load "$HOME/mypic.png"
		96
		97	Just like a mathematical expression with functions, you should read these
		98	expressions from right to left, as the C<load> is evaluated first, and
		99	its result becomes the argument to the C<scale> function.
		100
		101	Many operators also allow some parameters preceding the input image
		102	that modify its behaviour. For example, C<scale> without any additional
		103	arguments scales the image to size of the terminal window. If you specify
		104	an additional argument, it uses it as a scale factor (multiply by 100 to
		105	get a percentage):
		106
		107	scale 2, load "$HOME/mypic.png"
		108
		109	This enlarges the image by a factor of 2 (200%). As you can see, C<scale>
		110	has now two arguments, the C<200> and the C<load> expression, while
		111	C<load> only has one argument. Arguments are separated from each other by
		112	commas.
		113
		114	Scale also accepts two arguments, which are then separate factors for both
		115	horizontal and vertical dimensions. For example, this halves the image
		116	width and doubles the image height:
		117
		118	scale 0.5, 2, load "$HOME/mypic.png"
		119
		120	Other effects than scaling are also readily available, for example, you can
		121	tile the image to fill the whole window, instead of resizing it:
		122
		123	tile load "$HOME/mypic.png"
		124
		125	In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator
		126	is kind of superfluous.
		127
		128	Another common effect is to mirror the image, so that the same edges touch:
		129
		130	mirror load "$HOME/mypic.png"
		131
		132	This is also a typical background expression:
		133
		134	rootalign root
		135
		136	It 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
		138	pseudo-transparency, as the image seems to be static while the window is
		139	moved around.
		140
		141	=head2 CYCLES AND CACHING
		142
		143	As has been mentioned before, the expression might be evaluated multiple
		144	times. Each time the expression is reevaluated, a new cycle is said to
		145	have begun. Many operators cache their results till the next cycle.
		146
		147	For example, the C<load> operator keeps a copy of the image. If it is
		148	asked to load the same image on the next cycle it will not load it again,
		149	but return the cached copy.
		150
		151	This only works for one cycle though, so as long as you load the same
		152	image every time, it will always be cached, but when you load a different
		153	image, it will forget about the first one.
		154
		155	This allows you to either speed things up by keeping multiple images in
		156	memory, or conserve memory by loading images more often.
		157
		158	For example, you can keep two images in memory and use a random one like
		159	this:
		160
		161	my $img1 = load "img1.png";
		162	my $img2 = load "img2.png";
		163	(0.5 > rand) ? $img1 : $img2
		164
		165	Since both images are "loaded" every time the expression is evaluated,
		166	they are always kept in memory. Contrast this version:
		167
		168	my $path1 = "img1.png";
		169	my $path2 = "img2.png";
		170	load ((0.5 > rand) ? $path1 : $path2)
		171
		172	Here, a path is selected randomly, and load is only called for one image,
		173	so keeps only one image in memory. If, on the next evaluation, luck
		174	decides to use the other path, then it will have to load that image again.
		175
		176	=head1 REFERENCE
		177
		178	=head2 COMMAND LINE SWITCHES
		179
		180	=over 4
		181
		182	=item --background-expr perl-expression
		183
		184	Specifies the Perl expression to evaluate.
		185
		186	=item --background-border
		187
		188	By default, the expression creates an image that fills the full window,
		189	overwriting borders and any other areas, such as the scrollbar.
		190
		191	Specifying this flag changes the behaviour, so that the image only
		192	replaces the background of the character area.
		193
		194	=item --background-interval seconds
		195
		196	Since some operations in the underlying XRender extension can effectively
		197	freeze your X-server for prolonged time, this extension enforces a minimum
		198	time between updates, which is normally about 0.1 seconds.
		199
		200	If you want to do updates more often, you can decrease this safety
		201	interval with this switch.
		202
		203	=back
		204
		205	=cut
		206
		207	our %_IMG_CACHE;
		208	our $HOME;
22	our ($bgdsl_self, $old, $new);	209	our ($self, $old, $new);
23	our ($x, $y, $w, $h);	210	our ($x, $y, $w, $h);
24		211
25	# enforce at least this interval between updates	212	# enforce at least this interval between updates
26	our $MIN_INTERVAL = 1/100;	213	our $MIN_INTERVAL = 6/59.951;
27		214
28	{	215	{
29	package urxvt::bgdsl; # background language	216	package urxvt::bgdsl; # background language
30		217
		218	use List::Util qw(min max sum shuffle);
		219
31	=head2 PROVIDERS/GENERATORS	220	=head2 PROVIDERS/GENERATORS
		221
		222	These functions provide an image, by loading it from disk, grabbing it
		223	from the root screen or by simply generating it. They are used as starting
		224	points to get an image you can play with.
32		225
33	=over 4	226	=over 4
34		227
35	=item load $path	228	=item load $path
36		229
37	Loads the image at the given C<$path>. The image is set to plane tiling	230	Loads the image at the given C<$path>. The image is set to plane tiling
38	mode.	231	mode.
39		232
		233	Loaded images will be cached for one cycle, and shared between temrinals
		234	running in the same process (e.g. in C<urxvtd>).
40		235
		236	=item load_uc $path
41		237
		238	Load uncached - same as load, but does not cache the image. This function
		239	is most useufl if you want to optimise a background expression in some
		240	way.
		241
42	=cut	242	=cut
		243
		244	sub load_uc($) {
		245	my ($path) = @_;
		246
		247	$_IMG_CACHE{$path} \|\| do {
		248	my $img = $self->new_img_from_file ($path);
		249	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
		250	$img
		251	}
		252	}
43		253
44	sub load($) {	254	sub load($) {
45	my ($path) = @_;	255	my ($path) = @_;
46		256
47	$new->{load}{$path} = $old->{load}{$path} \|\| $bgdsl_self->new_img_from_file ($path);	257	$new->{load}{$path} = $old->{load}{$path} \|\| load_uc $path;
48	}	258	}
		259
		260	=item root
		261
		262	Returns the root window pixmap, that is, hopefully, the background image
		263	of your screen. The image is set to extend mode.
		264
		265	This function makes your expression root sensitive, that means it will be
		266	reevaluated when the bg image changes.
		267
		268	=cut
49		269
50	sub root() {	270	sub root() {
51	$new->{rootpmap_sensitive} = 1;	271	$new->{again}{rootpmap} = 1;
52	die "root op not supported, exg, we need you";	272	$self->new_img_from_root
53	}	273	}
		274
		275	=item solid $colour
		276
		277	=item solid $width, $height, $colour
		278
		279	Creates a new image and completely fills it with the given colour. The
		280	image is set to tiling mode.
		281
		282	If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is
		283	useful for solid backgrounds or for use in filtering effects.
		284
		285	=cut
54		286
55	sub solid($;$$) {	287	sub solid($;$$) {
		288	my $colour = pop;
		289
56	my $img = $bgdsl_self->new_img (urxvt::PictStandardARGB32, $_[1] \|\| 1, $_[2] \|\| 1);	290	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);
57	$img->fill ($_[0]);	291	$img->fill ($colour);
58	$img	292	$img
59	}	293	}
60		294
61	=back	295	=item clone $img
62		296
63	=head2 VARIABLES	297	Returns an exact copy of the image. This is useful if you want to have
		298	multiple copies of the same image to apply different effects to.
64		299
65	=over 4
66
67	=cut	300	=cut
68		301
69	sub X() { $new->{position_sensitive} = 1; $x }
70	sub Y() { $new->{position_sensitive} = 1; $y }
71	sub W() { $new->{size_sensitive} = 1; $w }
72	sub H() { $new->{size_sensitive} = 1; $h }
73
74	sub now() { urxvt::NOW }
75
76	sub again($) {
77	$new->{again} = $_[0];
78	}
79
80	sub counter($) {	302	sub clone($) {
81	$new->{again} = $_[0];	303	$_[0]->clone
82	$bgdsl_self->{counter} + 0
83	}	304	}
84
85	=back
86		305
87	=head2 TILING MODES	306	=head2 TILING MODES
88		307
89	The following operators modify the tiling mode of an image, that is, the	308	The following operators modify the tiling mode of an image, that is, the
90	way that pixels outside the image area are painted when the image is used.	309	way that pixels outside the image area are painted when the image is used.
93		312
94	=item tile $img	313	=item tile $img
95		314
96	Tiles the whole plane with the image and returns this new image - or in	315	Tiles the whole plane with the image and returns this new image - or in
97	other words, it returns a copy of the image in plane tiling mode.	316	other words, it returns a copy of the image in plane tiling mode.
		317
		318	Example: load an image and tile it over the background, without
		319	resizing. The C<tile> call is superfluous because C<load> already defaults
		320	to tiling mode.
		321
		322	tile load "mybg.png"
98		323
99	=item mirror $img	324	=item mirror $img
100		325
101	Similar to tile, but reflects the image each time it uses a new copy, so	326	Similar to tile, but reflects the image each time it uses a new copy, so
102	that top edges always touch top edges, right edges always touch right	327	that top edges always touch top edges, right edges always touch right
103	edges and so on (with normal tiling, left edges always touch right edges	328	edges and so on (with normal tiling, left edges always touch right edges
104	and top always touch bottom edges).	329	and top always touch bottom edges).
105		330
		331	Example: load an image and mirror it over the background, avoiding sharp
		332	edges at the image borders at the expense of mirroring the image itself
		333
		334	mirror load "mybg.png"
		335
106	=item pad $img	336	=item pad $img
107		337
108	Takes an image and modifies it so that all pixels outside the image area	338	Takes an image and modifies it so that all pixels outside the image area
109	become transparent. This mode is most useful when you want to place an	339	become transparent. This mode is most useful when you want to place an
110	image over another image or the background colour while leaving all	340	image over another image or the background colour while leaving all
111	background pixels outside the image unchanged.	341	background pixels outside the image unchanged.
112		342
		343	Example: load an image and display it in the upper left corner. The rest
		344	of the space is left "empty" (transparent or whatever your compositor does
		345	in alpha mode, else background colour).
		346
		347	pad load "mybg.png"
		348
113	=item extend $img	349	=item extend $img
114		350
115	Extends the image over the whole plane, using the closest pixel in the	351	Extends the image over the whole plane, using the closest pixel in the
116	area outside the image. This mode is mostly useful when you more complex	352	area outside the image. This mode is mostly useful when you use more complex
117	filtering operations and want the pixels outside the image to have the	353	filtering operations and want the pixels outside the image to have the
118	same values as the pixels near the edge.	354	same values as the pixels near the edge.
		355
		356	Example: just for curiosity, how does this pixel extension stuff work?
		357
		358	extend move 50, 50, load "mybg.png"
119		359
120	=cut	360	=cut
121		361
122	sub pad($) {	362	sub pad($) {
123	my $img = $_[0]->clone;	363	my $img = $_[0]->clone;
…		…
143	$img	383	$img
144	}	384	}
145		385
146	=back	386	=back
147		387
148	=head2 PIXEL OPERATORS	388	=head2 VARIABLE VALUES
149		389
150	The following operators modify the image pixels in various ways.	390	The following functions provide variable data such as the terminal window
		391	dimensions. They are not (Perl-) variables, they just return stuff that
		392	varies. Most of them make your expression sensitive to some events, for
		393	example using C<TW> (terminal width) means your expression is evaluated
		394	again when the terminal is resized.
151		395
152	=over 4	396	=over 4
153		397
154	=item clone $img	398	=item TX
155		399
156	Returns an exact copy of the image.	400	=item TY
157		401
158	=cut	402	Return the X and Y coordinates of the terminal window (the terminal
		403	window is the full window by default, and the character area only when in
		404	border-respect mode).
159		405
		406	Using these functions make your expression sensitive to window moves.
		407
		408	These functions are mainly useful to align images to the root window.
		409
		410	Example: load an image and align it so it looks as if anchored to the
		411	background.
		412
		413	move -TX, -TY, load "mybg.png"
		414
		415	=item TW
		416
		417	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
		418	terminal window is the full window by default, and the character area only
		419	when in border-respect mode).
		420
		421	Using these functions make your expression sensitive to window resizes.
		422
		423	These functions are mainly useful to scale images, or to clip images to
		424	the window size to conserve memory.
		425
		426	Example: take the screen background, clip it to the window size, blur it a
		427	bit, align it to the window position and use it as background.
		428
		429	clip move -TX, -TY, once { blur 5, root }
		430
		431	=cut
		432
		433	sub TX() { $new->{again}{position} = 1; $x }
		434	sub TY() { $new->{again}{position} = 1; $y }
		435	sub TW() { $new->{again}{size} = 1; $w }
		436	sub TH() { $new->{again}{size} = 1; $h }
		437
		438	=item now
		439
		440	Returns the current time as (fractional) seconds since the epoch.
		441
		442	Using this expression does I<not> make your expression sensitive to time,
		443	but the next two functions do.
		444
		445	=item again $seconds
		446
		447	When this function is used the expression will be reevaluated again in
		448	C<$seconds> seconds.
		449
		450	Example: load some image and rotate it according to the time of day (as if it were
		451	the hour pointer of a clock). Update this image every minute.
		452
		453	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
		454
		455	=item counter $seconds
		456
		457	Like C<again>, but also returns an increasing counter value, starting at
		458	0, which might be useful for some simple animation effects.
		459
		460	=cut
		461
		462	sub now() { urxvt::NOW }
		463
		464	sub again($) {
		465	$new->{again}{time} = $_[0];
		466	}
		467
160	sub clone($) {	468	sub counter($) {
161	$_[0]->clone	469	$new->{again}{time} = $_[0];
		470	$self->{counter} + 0
162	}	471	}
		472
		473	=back
		474
		475	=head2 SHAPE CHANGING OPERATORS
		476
		477	The following operators modify the shape, size or position of the image.
		478
		479	=over 4
163		480
164	=item clip $img	481	=item clip $img
165		482
166	=item clip $width, $height, $img	483	=item clip $width, $height, $img
167		484
…		…
184		501
185	=cut	502	=cut
186		503
187	sub clip($;$$;$$) {	504	sub clip($;$$;$$) {
188	my $img = pop;	505	my $img = pop;
189	my $h = pop \|\| H;	506	my $h = pop \|\| TH;
190	my $w = pop \|\| W;	507	my $w = pop \|\| TW;
191	$img->sub_rect ($_[0], $_[1], $w, $h)	508	$img->sub_rect ($_[0], $_[1], $w, $h)
192	}	509	}
193		510
194	=item scale $img	511	=item scale $img
195		512
196	=item scale $size_percent, $img	513	=item scale $size_factor, $img
197		514
198	=item scale $width_percent, $height_percent, $img	515	=item scale $width_factor, $height_factor, $img
199		516
200	Scales the image by the given percentages in horizontal	517	Scales the image by the given factors in horizontal
201	(C<$width_percent>) and vertical (C<$height_percent>) direction.	518	(C<$width>) and vertical (C<$height>) direction.
202		519
203	If only one percentage is give, it is used for both directions.	520	If only one factor is give, it is used for both directions.
204		521
205	If no percentages are given, scales the image to the window size without	522	If no factors are given, scales the image to the window size without
206	keeping aspect.	523	keeping aspect.
207		524
208	=item resize $width, $height, $img	525	=item resize $width, $height, $img
209		526
210	Resizes the image to exactly C<$width> times C<$height> pixels.	527	Resizes the image to exactly C<$width> times C<$height> pixels.
211		528
212	=cut	529	=item fit $img
213		530
214	#TODO: maximise, maximise_fill?	531	=item fit $width, $height, $img
215		532
		533	Fits the image into the given C<$width> and C<$height> without changing
		534	aspect, or the terminal size. That means it will be shrunk or grown until
		535	the whole image fits into the given area, possibly leaving borders.
		536
		537	=item cover $img
		538
		539	=item cover $width, $height, $img
		540
		541	Similar to C<fit>, but shrinks or grows until all of the area is covered
		542	by the image, so instead of potentially leaving borders, it will cut off
		543	image data that doesn't fit.
		544
		545	=cut
		546
216	sub scale($$$) {	547	sub scale($;$;$) {
217	my $img = pop;	548	my $img = pop;
218		549
219	@_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01)	550	@_ == 2 ? $img->scale ($_[0] * $img->w, $_[1] * $img->h)
220	: @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01)	551	: @_ ? $img->scale ($_[0] * $img->w, $_[0] * $img->h)
221	: $img->scale (W, H)	552	: $img->scale (TW, TH)
222	}	553	}
223		554
224	sub resize($$$) {	555	sub resize($$$) {
225	my $img = pop;	556	my $img = pop;
226	$img->scale ($_[0], $_[1])	557	$img->scale ($_[0], $_[1])
227	}	558	}
228		559
229	# TODO: ugly	560	sub fit($;$$) {
		561	my $img = pop;
		562	my $w = ($_[0] \|\| TW) / $img->w;
		563	my $h = ($_[1] \|\| TH) / $img->h;
		564	scale +(min $w, $h), $img
		565	}
		566
		567	sub cover($;$$) {
		568	my $img = pop;
		569	my $w = ($_[0] \|\| TW) / $img->w;
		570	my $h = ($_[1] \|\| TH) / $img->h;
		571	scale +(max $w, $h), $img
		572	}
		573
		574	=item move $dx, $dy, $img
		575
		576	Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in
		577	the vertical.
		578
		579	Example: move the image right by 20 pixels and down by 30.
		580
		581	move 20, 30, ...
		582
		583	=item align $xalign, $yalign, $img
		584
		585	Aligns the image according to a factor - C<0> means the image is moved to
		586	the left or top edge (for C<$xalign> or C<$yalign>), C<0.5> means it is
		587	exactly centered and C<1> means it touches the right or bottom edge.
		588
		589	Example: remove any visible border around an image, center it vertically but move
		590	it to the right hand side.
		591
		592	align 1, 0.5, pad $img
		593
		594	=item center $img
		595
		596	=item center $width, $height, $img
		597
		598	Centers the image, i.e. the center of the image is moved to the center of
		599	the terminal window (or the box specified by C<$width> and C<$height> if
		600	given).
		601
		602	Example: load an image and center it.
		603
		604	center pad load "mybg.png"
		605
		606	=item rootalign $img
		607
		608	Moves the image so that it appears glued to the screen as opposed to the
		609	window. This gives the illusion of a larger area behind the window. It is
		610	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
		611	top left of the screen.
		612
		613	Example: load a background image, put it in mirror mode and root align it.
		614
		615	rootalign mirror load "mybg.png"
		616
		617	Example: take the screen background and align it, giving the illusion of
		618	transparency as long as the window isn't in front of other windows.
		619
		620	rootalign root
		621
		622	=cut
		623
230	sub move($$;$) {	624	sub move($$;$) {
231	my $img = pop->clone;	625	my $img = pop->clone;
232	$img->move ($_[0], $_[1]);	626	$img->move ($_[0], $_[1]);
233	$img	627	$img
		628	}
		629
		630	sub align($;$$) {
234	# my $img = pop;	631	my $img = pop;
235	# $img->sub_rect (
236	# $_[0], $_[1],
237	# $img->w, $img->h,
238	# $_[2],
239	# )
240	}
241		632
		633	move $_[0] * (TW - $img->w),
		634	$_[1] * (TH - $img->h),
		635	$img
		636	}
		637
		638	sub center($;$$) {
		639	my $img = pop;
		640	my $w = $_[0] \|\| TW;
		641	my $h = $_[1] \|\| TH;
		642
		643	move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img
		644	}
		645
		646	sub rootalign($) {
		647	move -TX, -TY, $_[0]
		648	}
		649
		650	=item rotate $center_x, $center_y, $degrees
		651
		652	Rotates the image by C<$degrees> degrees, counter-clockwise, around the
		653	pointer at C<$center_x> and C<$center_y> (specified as factor of image
		654	width/height).
		655
		656	#TODO# new width, height, maybe more operators?
		657
		658	Example: rotate the image by 90 degrees
		659
		660	=cut
		661
242	sub rotate($$$$$$) {	662	sub rotate($$$$) {
243	my $img = pop;	663	my $img = pop;
244	$img->rotate (	664	$img->rotate (
245	$_[0],
246	$_[1],
247	$_[2] * $img->w * .01,	665	$_[0] * $img->w,
248	$_[3] * $img->h * .01,	666	$_[1] * $img->h,
249	$_[4] * (3.14159265 / 180),	667	$_[2] * (3.14159265 / 180),
250	)	668	)
251	}	669	}
252		670
253	sub blur($$;$) {	671	=back
254	my $img = pop;
255		672
256	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]);	673	=head2 COLOUR MODIFICATIONS
257	}	674
		675	The following operators change the pixels of the image.
		676
		677	=over 4
		678
		679	=item contrast $factor, $img
		680
		681	=item contrast $r, $g, $b, $img
		682
		683	=item contrast $r, $g, $b, $a, $img
		684
		685	Adjusts the I<contrast> of an image.
		686
		687	The first form applies a single C<$factor> to red, green and blue, the
		688	second form applies separate factors to each colour channel, and the last
		689	form includes the alpha channel.
		690
		691	Values from 0 to 1 lower the contrast, values higher than 1 increase the
		692	contrast.
		693
		694	Due to limitations in the underlying XRender extension, lowering contrast
		695	also reduces brightness, while increasing contrast currently also
		696	increases brightness.
		697
		698	=item brightness $bias, $img
		699
		700	=item brightness $r, $g, $b, $img
		701
		702	=item brightness $r, $g, $b, $a, $img
		703
		704	Adjusts the brightness of an image.
		705
		706	The first form applies a single C<$bias> to red, green and blue, the
		707	second form applies separate biases to each colour channel, and the last
		708	form includes the alpha channel.
		709
		710	Values less than 0 reduce brightness, while values larger than 0 increase
		711	it. Useful range is from -1 to 1 - the former results in a black, the
		712	latter in a white picture.
		713
		714	Due to idiosyncrasies in the underlying XRender extension, biases less
		715	than zero can be I<very> slow.
		716
		717	=cut
258		718
259	sub contrast($$;$$;$) {	719	sub contrast($$;$$;$) {
260	my $img = pop;	720	my $img = pop;
261	my ($r, $g, $b, $a) = @_;	721	my ($r, $g, $b, $a) = @_;
262		722
263	($g, $b) = ($r, $r) if @_ < 4;	723	($g, $b) = ($r, $r) if @_ < 3;
264	$a = 1 if @_ < 5;	724	$a = 1 if @_ < 4;
265		725
266	$img = $img->clone;	726	$img = $img->clone;
267	$img->contrast ($r, $g, $b, $a);	727	$img->contrast ($r, $g, $b, $a);
268	$img	728	$img
269	}	729	}
270		730
271	sub brightness($$;$$;$) {	731	sub brightness($$;$$;$) {
272	my $img = pop;	732	my $img = pop;
273	my ($r, $g, $b, $a) = @_;	733	my ($r, $g, $b, $a) = @_;
274		734
275	($g, $b) = ($r, $r) if @_ < 4;	735	($g, $b) = ($r, $r) if @_ < 3;
276	$a = 1 if @_ < 5;	736	$a = 1 if @_ < 4;
277		737
278	$img = $img->clone;	738	$img = $img->clone;
279	$img->brightness ($r, $g, $b, $a);	739	$img->brightness ($r, $g, $b, $a);
280	$img	740	$img
		741	}
		742
		743	=item blur $radius, $img
		744
		745	=item blur $radius_horz, $radius_vert, $img
		746
		747	Gaussian-blurs the image with (roughly) C<$radius> pixel radius. The radii
		748	can also be specified separately.
		749
		750	Blurring is often I<very> slow, at least compared or other
		751	operators. Larger blur radii are slower than smaller ones, too, so if you
		752	don't want to freeze your screen for long times, start experimenting with
		753	low values for radius (<5).
		754
		755	=cut
		756
		757	sub blur($$;$) {
		758	my $img = pop;
		759	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
		760	}
		761
		762	=back
		763
		764	=head2 OTHER STUFF
		765
		766	Anything that didn't fit any of the other categories, even after appliyng
		767	force and closing our eyes.
		768
		769	=over 4
		770
		771	=item once { ... }
		772
		773	This function takes a code block as argument, that is, one or more
		774	statements enclosed by braces.
		775
		776	The trick is that this code block is only evaluated once - future calls
		777	will simply return the original image (yes, it should only be used with
		778	images).
		779
		780	This can be extremely useful to avoid redoign the same slow operations
		781	again and again- for example, if your background expression takes the root
		782	background, blurs it and then root-aligns it it would have to blur the
		783	root background on every window move or resize.
		784
		785	Putting the blur into a C<once> block will make sure the blur is only done
		786	once:
		787
		788	rootlign once { blur 10, root }
		789
		790	This leaves the question of how to force reevaluation of the block, in
		791	case the root background changes: Right now, all once blocks forget that
		792	they ahve been executed before each time the root background changes (if
		793	the expression is sensitive to that) or when C<once_again> is called.
		794
		795	=item once_again
		796
		797	Resets all C<once> block as if they had never been called, i.e. on the
		798	next call they will be reevaluated again.
		799
		800	=cut
		801
		802	sub once(&) {
		803	my $once = $self->{once_cache}{$_[0]+0} \|\|= do {
		804	local $new->{again};
		805	my @res = $_[0]();
		806	[$new->{again}, \@res]
		807	};
		808
		809	$new->{again} = {
		810	%{ $new->{again} },
		811	%{ $once->[0] }
		812	};
		813
		814	# in scalar context we always return the first original result, which
		815	# is not quite how perl works.
		816	wantarray
		817	? @{ $once->[1] }
		818	: $once->[1][0]
		819	}
		820
		821	sub once_again() {
		822	delete $self->{once_cache};
281	}	823	}
282		824
283	=back	825	=back
284		826
285	=cut	827	=cut
…		…
300	$self->recalculate;	842	$self->recalculate;
301	}	843	}
302		844
303	# evaluate the current bg expression	845	# evaluate the current bg expression
304	sub recalculate {	846	sub recalculate {
305	my ($self) = @_;	847	my ($arg_self) = @_;
306		848
307	# rate limit evaluation	849	# rate limit evaluation
308		850
309	if ($self->{next_refresh} > urxvt::NOW) {	851	if ($arg_self->{next_refresh} > urxvt::NOW) {
310	$self->{next_refresh_timer} = urxvt::timer->new->after ($self->{next_refresh} - urxvt::NOW)->cb (sub {	852	$arg_self->{next_refresh_timer} = urxvt::timer->new->after ($arg_self->{next_refresh} - urxvt::NOW)->cb (sub {
311	$self->recalculate;	853	$arg_self->recalculate;
312	});	854	});
313	return;	855	return;
314	}	856	}
315		857
316	$self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	858	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
317		859
318	# set environment to evaluate user expression	860	# set environment to evaluate user expression
319		861
320	local $bgdsl_self = $self;	862	local $self = $arg_self;
321		863
		864	local $HOME = $ENV{HOME};
322	local $old = $self->{state};	865	local $old = $self->{state};
323	local $new = my $state = $self->{state} = {};	866	local $new = my $state = $self->{state} = {};
324		867
325	my $border = 0; #d#
326
327	($x, $y, $w, $h) =	868	($x, $y, $w, $h) =
328	$self->background_geometry ($border);	869	$self->background_geometry ($self->{border});
329		870
330	# evaluate user expression	871	# evaluate user expression
331		872
332	my $img = eval { $self->{expr}->() };	873	my $img = eval { $self->{expr}->() };
333	warn $@ if $@;#d#	874	warn $@ if $@;#d#
334	die if !UNIVERSAL::isa $img, "urxvt::img";	875	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
335		876
336	# if the expression is sensitive to external events, prepare reevaluation then	877	# if the expression is sensitive to external events, prepare reevaluation then
337		878
338	my $repeat;
339
340	if (my $again = $state->{again}) {	879	my $again = delete $state->{again};
341	$repeat = 1;	880
		881	$again->{size} = 1
		882	if $img->repeat_mode != urxvt::RepeatNormal;
		883
		884	if (my $again = $again->{time}) {
		885	my $self = $self;
342	$state->{timer} = $again == $old->{again}	886	$state->{timer} = $again == $old->{again}
343	? $old->{timer}	887	? $old->{timer}
344	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	888	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
345	++$self->{counter};	889	++$self->{counter};
346	$self->recalculate	890	$self->recalculate
347	});	891	});
348	}	892	}
349		893
350	if (delete $state->{position_sensitive}) {	894	if ($again->{position}) {
351	$repeat = 1;
352	$self->enable (position_change => sub { $_[0]->recalculate });	895	$self->enable (position_change => sub { $_[0]->recalculate });
353	} else {	896	} else {
354	$self->disable ("position_change");	897	$self->disable ("position_change");
355	}	898	}
356		899
357	if (delete $state->{size_sensitive}) {	900	if ($again->{size}) {
358	$repeat = 1;
359	$self->enable (size_change => sub { $_[0]->recalculate });	901	$self->enable (size_change => sub { $_[0]->recalculate });
360	} else {	902	} else {
361	$self->disable ("size_change");	903	$self->disable ("size_change");
362	}	904	}
363		905
364	if (delete $state->{rootpmap_sensitive}) {	906	if ($again->{rootpmap}) {
365	$repeat = 1;
366	$self->enable (rootpmap_change => sub { $_[0]->recalculate });	907	$self->enable (rootpmap_change => sub {
		908	delete $_[0]{once_cache}; # this will override once-block values from
		909	$_[0]->recalculate;
		910	});
367	} else {	911	} else {
368	$self->disable ("rootpmap_change");	912	$self->disable ("rootpmap_change");
369	}	913	}
370		914
371	# clear stuff we no longer need	915	# clear stuff we no longer need
372		916
373	%$old = ();	917	%$old = ();
374		918
375	unless ($repeat) {	919	unless (%$again) {
376	delete $self->{state};	920	delete $self->{state};
377	delete $self->{expr};	921	delete $self->{expr};
378	}	922	}
379		923
380	# prepare and set background pixmap	924	# set background pixmap
381		925
382	$img = $img->sub_rect (0, 0, $w, $h)
383	if $img->w != $w \|\| $img->h != $h;
384
385	$self->set_background ($img, $border);	926	$self->set_background ($img, $self->{border});
386	$self->scr_recolour (0);	927	$self->scr_recolour (0);
387	$self->want_refresh;	928	$self->want_refresh;
388	}	929	}
389		930
390	sub on_start {	931	sub on_start {
391	my ($self) = @_;	932	my ($self) = @_;
392		933
		934	my $expr = $self->x_resource ("%.expr")
		935	or return;
		936
		937	$self->has_render
		938	or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
		939
393	$self->set_expr (parse_expr $EXPR);	940	$self->set_expr (parse_expr $expr);
		941	$self->{border} = $self->x_resource_boolean ("%.border");
		942
		943	$MIN_INTERVAL = $self->x_resource ("%.interval");
394		944
395	()	945	()
396	}	946	}
397		947

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.29 by root, Thu Jun 7 13:12:08 2012 UTC vs. Revision 1.55 by root, Thu Jun 14 16:48:57 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.29 by root, Thu Jun 7 13:12:08 2012 UTC vs.
Revision 1.55 by root, Thu Jun 14 16:48:57 2012 UTC