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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.28 by root, Thu Jun 7 12:56:27 2012 UTC vs.
Revision 1.53 by root, Tue Jun 12 18:25: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 = 'border; 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
22	our $border;	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 gets 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 %_ONCE_CACHE;
		209	our $HOME;
23	our ($bgdsl_self, $old, $new);	210	our ($self, $old, $new);
24	our ($l, $t, $w, $h);	211	our ($x, $y, $w, $h);
25		212
26	# enforce at least this interval between updates	213	# enforce at least this interval between updates
27	our $MIN_INTERVAL = 1/100;	214	our $MIN_INTERVAL = 6/59.951;
28		215
29	{	216	{
30	package urxvt::bgdsl; # background language	217	package urxvt::bgdsl; # background language
31		218
32	# *repeat_empty = \&urxvt::RepeatNone;	219	use List::Util qw(min max sum shuffle);
33	# *repeat_tile = \&urxvt::RepeatNormal;
34	# *repeat_pad = \&urxvt::RepeatPad;
35	# *repeat_mirror = \&urxvt::RepeatReflect;
36		220
37	=head2 PROVIDERS/GENERATORS	221	=head2 PROVIDERS/GENERATORS
38		222
		223	These functions provide an image, by loading it from disk, grabbing it
		224	from the root screen or by simply generating it. They are used as starting
		225	points to get an image you can play with.
		226
39	=over 4	227	=over 4
40		228
41	=item load $path	229	=item load $path
		230
		231	Loads the image at the given C<$path>. The image is set to plane tiling
		232	mode.
		233
		234	Loaded images will be cached for one cycle.
42		235
43	=cut	236	=cut
44		237
45	sub load($) {	238	sub load($) {
46	my ($path) = @_;	239	my ($path) = @_;
47		240
48	$new->{load}{$path} = $old->{load}{$path} \|\| $bgdsl_self->new_img_from_file ($path);	241	$new->{load}{$path} = $old->{load}{$path} \|\| $self->new_img_from_file ($path);
49	}	242	}
		243
		244	=item root
		245
		246	Returns the root window pixmap, that is, hopefully, the background image
		247	of your screen. The image is set to extend mode.
		248
		249	This function makes your expression root sensitive, that means it will be
		250	reevaluated when the bg image changes.
		251
		252	=cut
50		253
51	sub root() {	254	sub root() {
52	$new->{rootpmap_sensitive} = 1;	255	$new->{rootpmap_sensitive} = 1;
53	die "root op not supported, exg, we need you";	256	$self->new_img_from_root
54	}	257	}
		258
		259	=item solid $colour
		260
		261	=item solid $width, $height, $colour
		262
		263	Creates a new image and completely fills it with the given colour. The
		264	image is set to tiling mode.
		265
		266	If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is
		267	useful for solid backgrounds or for use in filtering effects.
		268
		269	=cut
55		270
56	sub solid($;$$) {	271	sub solid($;$$) {
		272	my $colour = pop;
		273
57	my $img = $bgdsl_self->new_img (urxvt::PictStandardARGB32, $_[1] \|\| 1, $_[2] \|\| 1);	274	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);
58	$img->fill ($_[0]);	275	$img->fill ($colour);
59	$img	276	$img
60	}	277	}
61		278
62	=back	279	=item clone $img
63		280
64	=head2 VARIABLES	281	Returns an exact copy of the image. This is useful if you want to have
		282	multiple copies of the same image to apply different effects to.
65		283
66	=over 4
67
68	=cut	284	=cut
69		285
70	sub X() { $new->{position_sensitive} = 1; $l }
71	sub Y() { $new->{position_sensitive} = 1; $t }
72	sub W() { $new->{size_sensitive} = 1; $w }
73	sub H() { $new->{size_sensitive} = 1; $h }
74
75	sub now() { urxvt::NOW }
76
77	sub again($) {
78	$new->{again} = $_[0];
79	}
80
81	sub counter($) {	286	sub clone($) {
82	$new->{again} = $_[0];	287	$_[0]->clone
83	$bgdsl_self->{counter} + 0
84	}	288	}
85
86	=back
87		289
88	=head2 TILING MODES	290	=head2 TILING MODES
89		291
90	The following operators modify the tiling mode of an image, that is, the	292	The following operators modify the tiling mode of an image, that is, the
91	way that pixels outside the image area are painted when the image is used.	293	way that pixels outside the image area are painted when the image is used.
94		296
95	=item tile $img	297	=item tile $img
96		298
97	Tiles the whole plane with the image and returns this new image - or in	299	Tiles the whole plane with the image and returns this new image - or in
98	other words, it returns a copy of the image in plane tiling mode.	300	other words, it returns a copy of the image in plane tiling mode.
		301
		302	Example: load an image and tile it over the background, without
		303	resizing. The C<tile> call is superfluous because C<load> already defaults
		304	to tiling mode.
		305
		306	tile load "mybg.png"
99		307
100	=item mirror $img	308	=item mirror $img
101		309
102	Similar to tile, but reflects the image each time it uses a new copy, so	310	Similar to tile, but reflects the image each time it uses a new copy, so
103	that top edges always touch top edges, right edges always touch right	311	that top edges always touch top edges, right edges always touch right
104	edges and so on (with normal tiling, left edges always touch right edges	312	edges and so on (with normal tiling, left edges always touch right edges
105	and top always touch bottom edges).	313	and top always touch bottom edges).
106		314
		315	Example: load an image and mirror it over the background, avoiding sharp
		316	edges at the image borders at the expense of mirroring the image itself
		317
		318	mirror load "mybg.png"
		319
107	=item pad $img	320	=item pad $img
108		321
109	Takes an image and modifies it so that all pixels outside the image area	322	Takes an image and modifies it so that all pixels outside the image area
110	become transparent. This mode is most useful when you want to place an	323	become transparent. This mode is most useful when you want to place an
111	image over another image or the background colour while leaving all	324	image over another image or the background colour while leaving all
112	background pixels outside the image unchanged.	325	background pixels outside the image unchanged.
113		326
		327	Example: load an image and display it in the upper left corner. The rest
		328	of the space is left "empty" (transparent or whatever your compositor does
		329	in alpha mode, else background colour).
		330
		331	pad load "mybg.png"
		332
114	=item extend $img	333	=item extend $img
115		334
116	Extends the image over the whole plane, using the closest pixel in the	335	Extends the image over the whole plane, using the closest pixel in the
117	area outside the image. This mode is mostly useful when you more complex	336	area outside the image. This mode is mostly useful when you use more complex
118	filtering operations and want the pixels outside the image to have the	337	filtering operations and want the pixels outside the image to have the
119	same values as the pixels near the edge.	338	same values as the pixels near the edge.
		339
		340	Example: just for curiosity, how does this pixel extension stuff work?
		341
		342	extend move 50, 50, load "mybg.png"
120		343
121	=cut	344	=cut
122		345
123	sub pad($) {	346	sub pad($) {
124	my $img = $_[0]->clone;	347	my $img = $_[0]->clone;
…		…
144	$img	367	$img
145	}	368	}
146		369
147	=back	370	=back
148		371
149	=head2 PIXEL OPERATORS	372	=head2 VARIABLE VALUES
150		373
151	The following operators modify the image pixels in various ways.	374	The following functions provide variable data such as the terminal window
		375	dimensions. They are not (Perl-) variables, they just return stuff that
		376	varies. Most of them make your expression sensitive to some events, for
		377	example using C<TW> (terminal width) means your expression is evaluated
		378	again when the terminal is resized.
152		379
153	=over 4	380	=over 4
154		381
155	=item clone $img	382	=item TX
156		383
157	Returns an exact copy of the image.	384	=item TY
158		385
159	=cut	386	Return the X and Y coordinates of the terminal window (the terminal
		387	window is the full window by default, and the character area only when in
		388	border-respect mode).
160		389
		390	Using these functions make your expression sensitive to window moves.
		391
		392	These functions are mainly useful to align images to the root window.
		393
		394	Example: load an image and align it so it looks as if anchored to the
		395	background.
		396
		397	move -TX, -TY, load "mybg.png"
		398
		399	=item TW
		400
		401	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
		402	terminal window is the full window by default, and the character area only
		403	when in border-respect mode).
		404
		405	Using these functions make your expression sensitive to window resizes.
		406
		407	These functions are mainly useful to scale images, or to clip images to
		408	the window size to conserve memory.
		409
		410	Example: take the screen background, clip it to the window size, blur it a
		411	bit, align it to the window position and use it as background.
		412
		413	clip move -TX, -TY, blur 5, root
		414
		415	=cut
		416
		417	sub TX() { $new->{position_sensitive} = 1; $x }
		418	sub TY() { $new->{position_sensitive} = 1; $y }
		419	sub TW() { $new->{size_sensitive} = 1; $w }
		420	sub TH() { $new->{size_sensitive} = 1; $h }
		421
		422	=item now
		423
		424	Returns the current time as (fractional) seconds since the epoch.
		425
		426	Using this expression does I<not> make your expression sensitive to time,
		427	but the next two functions do.
		428
		429	=item again $seconds
		430
		431	When this function is used the expression will be reevaluated again in
		432	C<$seconds> seconds.
		433
		434	Example: load some image and rotate it according to the time of day (as if it were
		435	the hour pointer of a clock). Update this image every minute.
		436
		437	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
		438
		439	=item counter $seconds
		440
		441	Like C<again>, but also returns an increasing counter value, starting at
		442	0, which might be useful for some simple animation effects.
		443
		444	=cut
		445
		446	sub now() { urxvt::NOW }
		447
		448	sub again($) {
		449	$new->{again} = $_[0];
		450	}
		451
161	sub clone($) {	452	sub counter($) {
162	$_[0]->clone	453	$new->{again} = $_[0];
		454	$self->{counter} + 0
163	}	455	}
		456
		457	=back
		458
		459	=head2 SHAPE CHANGING OPERATORS
		460
		461	The following operators modify the shape, size or position of the image.
		462
		463	=over 4
164		464
165	=item clip $img	465	=item clip $img
166		466
167	=item clip $width, $height, $img	467	=item clip $width, $height, $img
168		468
…		…
185		485
186	=cut	486	=cut
187		487
188	sub clip($;$$;$$) {	488	sub clip($;$$;$$) {
189	my $img = pop;	489	my $img = pop;
190	my $h = pop \|\| H;	490	my $h = pop \|\| TH;
191	my $w = pop \|\| W;	491	my $w = pop \|\| TW;
192	$img->sub_rect ($_[0], $_[1], $w, $h)	492	$img->sub_rect ($_[0], $_[1], $w, $h)
193	}	493	}
194		494
195	=item scale $img	495	=item scale $img
196		496
197	=item scale $size_percent, $img	497	=item scale $size_factor, $img
198		498
199	=item scale $width_percent, $height_percent, $img	499	=item scale $width_factor, $height_factor, $img
200		500
201	Scales the image by the given percentages in horizontal	501	Scales the image by the given factors in horizontal
202	(C<$width_percent>) and vertical (C<$height_percent>) direction.	502	(C<$width>) and vertical (C<$height>) direction.
203		503
204	If only one percentage is give, it is used for both directions.	504	If only one factor is give, it is used for both directions.
205		505
206	If no percentages are given, scales the image to the window size without	506	If no factors are given, scales the image to the window size without
207	keeping aspect.	507	keeping aspect.
208		508
209	=item resize $width, $height, $img	509	=item resize $width, $height, $img
210		510
211	Resizes the image to exactly C<$width> times C<$height> pixels.	511	Resizes the image to exactly C<$width> times C<$height> pixels.
212		512
213	=cut	513	=item fit $img
214		514
215	#TODO: maximise, maximise_fill?	515	=item fit $width, $height, $img
216		516
		517	Fits the image into the given C<$width> and C<$height> without changing
		518	aspect, or the terminal size. That means it will be shrunk or grown until
		519	the whole image fits into the given area, possibly leaving borders.
		520
		521	=item cover $img
		522
		523	=item cover $width, $height, $img
		524
		525	Similar to C<fit>, but shrinks or grows until all of the area is covered
		526	by the image, so instead of potentially leaving borders, it will cut off
		527	image data that doesn't fit.
		528
		529	=cut
		530
217	sub scale($$$) {	531	sub scale($;$;$) {
218	my $img = pop;	532	my $img = pop;
219		533
220	@_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01)	534	@_ == 2 ? $img->scale ($_[0] * $img->w, $_[1] * $img->h)
221	: @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01)	535	: @_ ? $img->scale ($_[0] * $img->w, $_[0] * $img->h)
222	: $img->scale (W, H)	536	: $img->scale (TW, TH)
223	}	537	}
224		538
225	sub resize($$$) {	539	sub resize($$$) {
226	my $img = pop;	540	my $img = pop;
227	$img->scale ($_[0], $_[1])	541	$img->scale ($_[0], $_[1])
228	}	542	}
229		543
230	# TODO: ugly	544	sub fit($;$$) {
		545	my $img = pop;
		546	my $w = ($_[0] \|\| TW) / $img->w;
		547	my $h = ($_[1] \|\| TH) / $img->h;
		548	scale +(min $w, $h), $img
		549	}
		550
		551	sub cover($;$$) {
		552	my $img = pop;
		553	my $w = ($_[0] \|\| TW) / $img->w;
		554	my $h = ($_[1] \|\| TH) / $img->h;
		555	scale +(max $w, $h), $img
		556	}
		557
		558	=item move $dx, $dy, $img
		559
		560	Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in
		561	the vertical.
		562
		563	Example: move the image right by 20 pixels and down by 30.
		564
		565	move 20, 30, ...
		566
		567	=item align $xalign, $yalign, $img
		568
		569	Aligns the image according to a factor - C<0> means the image is moved to
		570	the left or top edge (for C<$xalign> or C<$yalign>), C<0.5> means it is
		571	exactly centered and C<1> means it touches the right or bottom edge.
		572
		573	Example: remove any visible border around an image, center it vertically but move
		574	it to the right hand side.
		575
		576	align 1, 0.5, pad $img
		577
		578	=item center $img
		579
		580	=item center $width, $height, $img
		581
		582	Centers the image, i.e. the center of the image is moved to the center of
		583	the terminal window (or the box specified by C<$width> and C<$height> if
		584	given).
		585
		586	Example: load an image and center it.
		587
		588	center pad load "mybg.png"
		589
		590	=item rootalign $img
		591
		592	Moves the image so that it appears glued to the screen as opposed to the
		593	window. This gives the illusion of a larger area behind the window. It is
		594	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
		595	top left of the screen.
		596
		597	Example: load a background image, put it in mirror mode and root align it.
		598
		599	rootalign mirror load "mybg.png"
		600
		601	Example: take the screen background and align it, giving the illusion of
		602	transparency as long as the window isn't in front of other windows.
		603
		604	rootalign root
		605
		606	=cut
		607
231	sub move($$;$) {	608	sub move($$;$) {
232	my $img = pop->clone;	609	my $img = pop->clone;
233	$img->move ($_[0], $_[1]);	610	$img->move ($_[0], $_[1]);
234	$img	611	$img
		612	}
		613
		614	sub align($;$$) {
235	# my $img = pop;	615	my $img = pop;
236	# $img->sub_rect (
237	# $_[0], $_[1],
238	# $img->w, $img->h,
239	# $_[2],
240	# )
241	}
242		616
		617	move $_[0] * (TW - $img->w),
		618	$_[1] * (TH - $img->h),
		619	$img
		620	}
		621
		622	sub center($;$$) {
		623	my $img = pop;
		624	my $w = $_[0] \|\| TW;
		625	my $h = $_[1] \|\| TH;
		626
		627	move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img
		628	}
		629
		630	sub rootalign($) {
		631	move -TX, -TY, $_[0]
		632	}
		633
		634	=item rotate $center_x, $center_y, $degrees
		635
		636	Rotates the image by C<$degrees> degrees, counter-clockwise, around the
		637	pointer at C<$center_x> and C<$center_y> (specified as factor of image
		638	width/height).
		639
		640	#TODO# new width, height, maybe more operators?
		641
		642	Example: rotate the image by 90 degrees
		643
		644	=cut
		645
243	sub rotate($$$$$$) {	646	sub rotate($$$$) {
244	my $img = pop;	647	my $img = pop;
245	$img->rotate (	648	$img->rotate (
246	$_[0],
247	$_[1],
248	$_[2] * $img->w * .01,	649	$_[0] * $img->w,
249	$_[3] * $img->h * .01,	650	$_[1] * $img->h,
250	$_[4] * (3.14159265 / 180),	651	$_[2] * (3.14159265 / 180),
251	)	652	)
252	}	653	}
253		654
254	sub blur($$;$) {	655	=back
255	my $img = pop;
256		656
257	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]);	657	=head2 COLOUR MODIFICATIONS
258	}	658
		659	The following operators change the pixels of the image.
		660
		661	=over 4
		662
		663	=item contrast $factor, $img
		664
		665	=item contrast $r, $g, $b, $img
		666
		667	=item contrast $r, $g, $b, $a, $img
		668
		669	Adjusts the I<contrast> of an image.
		670
		671	The first form applies a single C<$factor> to red, green and blue, the
		672	second form applies separate factors to each colour channel, and the last
		673	form includes the alpha channel.
		674
		675	Values from 0 to 1 lower the contrast, values higher than 1 increase the
		676	contrast.
		677
		678	Due to limitations in the underlying XRender extension, lowering contrast
		679	also reduces brightness, while increasing contrast currently also
		680	increases brightness.
		681
		682	=item brightness $bias, $img
		683
		684	=item brightness $r, $g, $b, $img
		685
		686	=item brightness $r, $g, $b, $a, $img
		687
		688	Adjusts the brightness of an image.
		689
		690	The first form applies a single C<$bias> to red, green and blue, the
		691	second form applies separate biases to each colour channel, and the last
		692	form includes the alpha channel.
		693
		694	Values less than 0 reduce brightness, while values larger than 0 increase
		695	it. Useful range is from -1 to 1 - the former results in a black, the
		696	latter in a white picture.
		697
		698	Due to idiosyncrasies in the underlying XRender extension, biases less
		699	than zero can be I<very> slow.
		700
		701	=cut
259		702
260	sub contrast($$;$$;$) {	703	sub contrast($$;$$;$) {
261	my $img = pop;	704	my $img = pop;
262	my ($r, $g, $b, $a) = @_;	705	my ($r, $g, $b, $a) = @_;
263		706
264	($g, $b) = ($r, $r) if @_ < 4;	707	($g, $b) = ($r, $r) if @_ < 3;
265	$a = 1 if @_ < 5;	708	$a = 1 if @_ < 4;
266		709
267	$img = $img->clone;	710	$img = $img->clone;
268	$img->contrast ($r, $g, $b, $a);	711	$img->contrast ($r, $g, $b, $a);
269	$img	712	$img
270	}	713	}
271		714
272	sub brightness($$;$$;$) {	715	sub brightness($$;$$;$) {
273	my $img = pop;	716	my $img = pop;
274	my ($r, $g, $b, $a) = @_;	717	my ($r, $g, $b, $a) = @_;
275		718
276	($g, $b) = ($r, $r) if @_ < 4;	719	($g, $b) = ($r, $r) if @_ < 3;
277	$a = 1 if @_ < 5;	720	$a = 1 if @_ < 4;
278		721
279	$img = $img->clone;	722	$img = $img->clone;
280	$img->brightness ($r, $g, $b, $a);	723	$img->brightness ($r, $g, $b, $a);
281	$img	724	$img
282	}	725	}
283		726
		727	=item blur $radius, $img
		728
		729	=item blur $radius_horz, $radius_vert, $img
		730
		731	Gaussian-blurs the image with (roughly) C<$radius> pixel radius. The radii
		732	can also be specified separately.
		733
		734	Blurring is often I<very> slow, at least compared or other
		735	operators. Larger blur radii are slower than smaller ones, too, so if you
		736	don't want to freeze your screen for long times, start experimenting with
		737	low values for radius (<5).
		738
		739	=cut
		740
		741	sub blur($$;$) {
		742	my $img = pop;
		743	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
		744	}
		745
284	=back	746	=back
285		747
286	=head2 SETTINGS	748	=head2 OTHER STUFF
		749
		750	Anything that didn't fit any of the other categories, even after appliyng
		751	force and closing our eyes.
287		752
288	=over 4	753	=over 4
289		754
290	=item border $respect_border=1	755	=item once { ... }
291		756
292	Sets whether the image should respect the terminal border (argument true	757	This function takes a code block as argument, that is, one or more
293	or missing), or whether it should fill the whole window (the default).	758	statements enclosed by braces.
294		759
295	By default, the image will cover the whole toplevel window. If C<border>	760	The trick is that this code block is only evaluated once - future calls
296	is enabled, then it will only fill the character area and leave a normal	761	will simply return the original image (yes, it should only be used with
297	border in the background colour around it and behind the scrollbar.	762	images).
298		763
299	=cut	764	This can be extremely useful to avoid redoign the same slow operations
		765	again and again- for example, if your background expression takes the root
		766	background, blurs it and then root-aligns it it would have to blur the
		767	root background on every window move or resize.
300		768
301	sub border {	769	Putting the blur into a C<once> block will make sure the blur is only done
302	$border = @_ ? $_[0] : 1;	770	once:
		771
		772	rootlign once { blur 10, root }
		773
		774	This leaves the question of how to force reevaluation of the block, in
		775	case the root background changes: Right now, all once blocks forget that
		776	they ahve been executed before each time the root background changes (if
		777	the expression is sensitive to that) or when C<once_again> is called.
		778
		779	=item once_again
		780
		781	Resets all C<once> block as if they had never been called, i.e. on the
		782	next call they will be reevaluated again.
		783
		784	=cut
		785
		786	sub once(&) {
		787	$_ONCE_CACHE{$_[0]+0} \|\|= $_[0]()
		788	}
		789
		790	sub once_again() {
		791	%_ONCE_CACHE = ();
303	}	792	}
304		793
305	=back	794	=back
306		795
307	=cut	796	=cut
…		…
322	$self->recalculate;	811	$self->recalculate;
323	}	812	}
324		813
325	# evaluate the current bg expression	814	# evaluate the current bg expression
326	sub recalculate {	815	sub recalculate {
327	my ($self) = @_;	816	my ($arg_self) = @_;
328		817
329	# rate limit evaluation	818	# rate limit evaluation
330		819
331	if ($self->{next_refresh} > urxvt::NOW) {	820	if ($arg_self->{next_refresh} > urxvt::NOW) {
332	$self->{next_refresh_timer} = urxvt::timer->new->after ($self->{next_refresh} - urxvt::NOW)->cb (sub {	821	$arg_self->{next_refresh_timer} = urxvt::timer->new->after ($arg_self->{next_refresh} - urxvt::NOW)->cb (sub {
333	$self->recalculate;	822	$arg_self->recalculate;
334	});	823	});
335	return;	824	return;
336	}	825	}
337		826
338	$self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	827	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
339		828
340	# set environment to evaluate user expression	829	# set environment to evaluate user expression
341		830
342	local $bgdsl_self = $self;	831	local $self = $arg_self;
343	local $border;
344		832
		833	local $HOME = $ENV{HOME};
345	local $old = $self->{state};	834	local $old = $self->{state};
346	local $new = my $state = $self->{state} = {};	835	local $new = my $state = $self->{state} = {};
347		836
348	($l, $t, $w, $h) =	837	($x, $y, $w, $h) =
349	$self->get_geometry;	838	$self->background_geometry ($self->{border});
350
351	warn "$l,$t,$w,$h\n";#d#
352		839
353	# evaluate user expression	840	# evaluate user expression
354		841
355	my $img = eval { $self->{expr}->() };	842	my $img = eval { $self->{expr}->() };
356	warn $@ if $@;#d#	843	warn $@ if $@;#d#
357	die if !UNIVERSAL::isa $img, "urxvt::img";	844	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
		845
		846	$state->{size_sensitive} = 1
		847	if $img->repeat_mode != urxvt::RepeatNormal;
358		848
359	# if the expression is sensitive to external events, prepare reevaluation then	849	# if the expression is sensitive to external events, prepare reevaluation then
360		850
361	my $repeat;	851	my $repeat;
362		852
363	if (my $again = $state->{again}) {	853	if (my $again = $state->{again}) {
364	$repeat = 1;	854	$repeat = 1;
		855	my $self = $self;
365	$state->{timer} = $again == $old->{again}	856	$state->{timer} = $again == $old->{again}
366	? $old->{timer}	857	? $old->{timer}
367	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	858	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
368	++$self->{counter};	859	++$self->{counter};
369	$self->recalculate	860	$self->recalculate
…		…
398	unless ($repeat) {	889	unless ($repeat) {
399	delete $self->{state};	890	delete $self->{state};
400	delete $self->{expr};	891	delete $self->{expr};
401	}	892	}
402		893
403	# prepare and set background pixmap	894	# set background pixmap
404		895
405	$img = $img->sub_rect (0, 0, $w, $h)
406	if $img->w != $w \|\| $img->h != $h;
407
408	$self->set_background ($img, $border);	896	$self->set_background ($img, $self->{border});
409	$self->scr_recolour (0);	897	$self->scr_recolour (0);
410	$self->want_refresh;	898	$self->want_refresh;
411	}	899	}
412		900
413	sub on_start {	901	sub on_start {
414	my ($self) = @_;	902	my ($self) = @_;
415		903
		904	my $expr = $self->x_resource ("%.expr")
		905	or return;
		906
		907	$self->has_render
		908	or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
		909
416	$self->set_expr (parse_expr $EXPR);	910	$self->set_expr (parse_expr $expr);
		911	$self->{border} = $self->x_resource_boolean ("%.border");
		912
		913	$MIN_INTERVAL = $self->x_resource ("%.interval");
417		914
418	()	915	()
419	}	916	}
420		917

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.28 by root, Thu Jun 7 12:56:27 2012 UTC vs. Revision 1.53 by root, Tue Jun 12 18:25:57 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.28 by root, Thu Jun 7 12:56:27 2012 UTC vs.
Revision 1.53 by root, Tue Jun 12 18:25:57 2012 UTC