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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.35 by root, Fri Jun 8 08:06:38 2012 UTC vs.
Revision 1.73 by sf-exg, Thu Jul 5 20:05:19 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:%.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		6
6	#TODO: once, rootalign	7	=head1 NAME
7		8
8	=head1 background - manage terminal background	9	background - manage terminal background
9		10
10	=head2 SYNOPSIS	11	=head1 SYNOPSIS
11		12
12	rxvt -background-expr 'background expression'	13	urxvt --background-expr 'background expression'
13	-background-border	14	--background-border
		15	--background-interval seconds
14		16
15	=head2 DESCRIPTION	17	=head1 DESCRIPTION
16		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 keep { load "/path/to/mybg.png" }'
		32
		33	Or specified as a X resource:
		34
		35	URxvt.background-expr: scale keep { 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 keep { load "$HOME/mybg.png"
		59	}> scales the image to the window size, so it relies on the window size
		60	and will be reevaluated each time it is changed, but not when it moves for
		61	example. That ensures that the picture always fills the terminal, even
		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	scale keep {
		70	again 3600;
		71	if (localtime now)[6]) {
		72	return load "$HOME/weekday.png";
		73	} else {
		74	return load "$HOME/sunday.png";
		75	}
		76	}
		77
		78	This inner expression is evaluated once per hour (and whenever the
		79	terminal window is resized). It sets F<sunday.png> as background on
		80	Sundays, and F<weekday.png> on all other days.
		81
		82	Fortunately, we expect that most expressions will be much simpler, with
		83	little Perl knowledge needed.
		84
		85	Basically, you always start with a function that "generates" an image
		86	object, such as C<load>, which loads an image from disk, or C<root>, which
		87	returns the root window background image:
		88
		89	load "$HOME/mypic.png"
		90
		91	The path is usually specified as a quoted string (the exact rules can be
		92	found in the L<perlop> manpage). The F<$HOME> at the beginning of the
		93	string is expanded to the home directory.
		94
		95	Then you prepend one or more modifiers or filtering expressions, such as
		96	C<scale>:
		97
		98	scale load "$HOME/mypic.png"
		99
		100	Just like a mathematical expression with functions, you should read these
		101	expressions from right to left, as the C<load> is evaluated first, and
		102	its result becomes the argument to the C<scale> function.
		103
		104	Many operators also allow some parameters preceding the input image
		105	that modify its behaviour. For example, C<scale> without any additional
		106	arguments scales the image to size of the terminal window. If you specify
		107	an additional argument, it uses it as a scale factor (multiply by 100 to
		108	get a percentage):
		109
		110	scale 2, load "$HOME/mypic.png"
		111
		112	This enlarges the image by a factor of 2 (200%). As you can see, C<scale>
		113	has now two arguments, the C<200> and the C<load> expression, while
		114	C<load> only has one argument. Arguments are separated from each other by
		115	commas.
		116
		117	Scale also accepts two arguments, which are then separate factors for both
		118	horizontal and vertical dimensions. For example, this halves the image
		119	width and doubles the image height:
		120
		121	scale 0.5, 2, load "$HOME/mypic.png"
		122
		123	IF you try out these expressions, you might suffer from some sluggishness,
		124	because each time the terminal is resized, it loads the PNG image again
		125	and scales it. Scaling is usually fast (and unavoidable), but loading the
		126	image can be quite time consuming. This is where C<keep> comes in handy:
		127
		128	scale 0.5, 2, keep { load "$HOME/mypic.png" }
		129
		130	The C<keep> operator executes all the statements inside the braces only
		131	once, or when it thinks the outcome might change. In other cases it
		132	returns the last value computed by the brace block.
		133
		134	This means that the C<load> is only executed once, which makes it much
		135	faster, but also means that more memory is being used, because the loaded
		136	image must be kept in memory at all times. In this expression, the
		137	trade-off is likely worth it.
		138
		139	But back to effects: Other effects than scaling are also readily
		140	available, for example, you can tile the image to fill the whole window,
		141	instead of resizing it:
		142
		143	tile keep { load "$HOME/mypic.png" }
		144
		145	In fact, images returned by C<load> are in C<tile> mode by default, so the
		146	C<tile> operator is kind of superfluous.
		147
		148	Another common effect is to mirror the image, so that the same edges
		149	touch:
		150
		151	mirror keep { load "$HOME/mypic.png" }
		152
		153	Another common background expression is:
		154
		155	rootalign root
		156
		157	This one first takes a snapshot of the screen background image, and then
		158	moves it to the upper left corner of the screen (as opposed to the upper
		159	left corner of the terminal window)- the result is pseudo-transparency:
		160	the image seems to be static while the window is moved around.
		161
		162	=head2 COLOUR SPECIFICATIONS
		163
		164	Whenever an operator expects a "colour", then this can be specified in one
		165	of two ways: Either as string with an X11 colour specification, such as:
		166
		167	"red" # named colour
		168	"#f00" # simple rgb
		169	"[50]red" # red with 50% alpha
		170	"TekHVC:300/50/50" # anything goes
		171
		172	OR as an array reference with one, three or four components:
		173
		174	[0.5] # 50% gray, 100% alpha
		175	[0.5, 0, 0] # dark red, no green or blur, 100% alpha
		176	[0.5, 0, 0, 0.7] # same with explicit 70% alpha
		177
		178	=head2 CACHING AND SENSITIVITY
		179
		180	Since some operations (such as C<load> and C<blur>) can take a long time,
		181	caching results can be very important for a smooth operation. Caching can
		182	also be useful to reduce memory usage, though, for example, when an image
		183	is cached by C<load>, it could be shared by multiple terminal windows
		184	running inside urxvtd.
		185
		186	=head3 C<keep { ... }> caching
		187
		188	The most important way to cache expensive operations is to use C<keep {
		189	... }>. The C<keep> operator takes a block of multiple statements enclosed
		190	by C<{}> and keeps the return value in memory.
		191
		192	An expression can be "sensitive" to various external events, such as
		193	scaling or moving the window, root background changes and timers. Simply
		194	using an expression (such as C<scale> without parameters) that depends on
		195	certain changing values (called "variables"), or using those variables
		196	directly, will make an expression sensitive to these events - for example,
		197	using C<scale> or C<TW> will make the expression sensitive to the terminal
		198	size, and thus to resizing events.
		199
		200	When such an event happens, C<keep> will automatically trigger a
		201	reevaluation of the whole expression with the new value of the expression.
		202
		203	C<keep> is most useful for expensive operations, such as C<blur>:
		204
		205	rootalign keep { blur 20, root }
		206
		207	This makes a blurred copy of the root background once, and on subsequent
		208	calls, just root-aligns it. Since C<blur> is usually quite slow and
		209	C<rootalign> is quite fast, this trades extra memory (for the cached
		210	blurred pixmap) with speed (blur only needs to be redone when root
		211	changes).
		212
		213	=head3 C<load> caching
		214
		215	The C<load> operator itself does not keep images in memory, but as long as
		216	the image is still in memory, C<load> will use the in-memory image instead
		217	of loading it freshly from disk.
		218
		219	That means that this expression:
		220
		221	keep { load "$HOME/path..." }
		222
		223	Not only caches the image in memory, other terminal instances that try to
		224	C<load> it can reuse that in-memory copy.
		225
17	=head2 REFERENCE	226	=head1 REFERENCE
18		227
19	=cut	228	=head2 COMMAND LINE SWITCHES
20		229
21	our $EXPR;	230	=over 4
22	#$EXPR = 'move W * 0.1, -H * 0.1, resize W * 0.5, H * 0.5, repeat_none load "opensource.png"';
23	$EXPR = 'move -TX, -TY, load "argb.png"';
24	#$EXPR = '
25	# rotate W, H, 50, 50, counter 1/59.95, repeat_mirror,
26	# clip X, Y, W, H, repeat_mirror,
27	# load "/root/pix/das_fette_schwein.jpg"
28	#';
29	#$EXPR = 'solid "red"';
30	#$EXPR = 'blur root, 10, 10'
31	#$EXPR = 'blur move (root, -x, -y), 5, 5'
32	#resize load "/root/pix/das_fette_schwein.jpg", w, h
33		231
34	our ($self, $old, $new);	232	=item --background-expr perl-expression
		233
		234	Specifies the Perl expression to evaluate.
		235
		236	=item --background-border
		237
		238	By default, the expression creates an image that fills the full window,
		239	overwriting borders and any other areas, such as the scrollbar.
		240
		241	Specifying this flag changes the behaviour, so that the image only
		242	replaces the background of the character area.
		243
		244	=item --background-interval seconds
		245
		246	Since some operations in the underlying XRender extension can effectively
		247	freeze your X-server for prolonged time, this extension enforces a minimum
		248	time between updates, which is normally about 0.1 seconds.
		249
		250	If you want to do updates more often, you can decrease this safety
		251	interval with this switch.
		252
		253	=back
		254
		255	=cut
		256
		257	our %_IMG_CACHE;
		258	our $HOME;
		259	our ($self, $frame);
35	our ($x, $y, $w, $h);	260	our ($x, $y, $w, $h);
36		261
37	# enforce at least this interval between updates	262	# enforce at least this interval between updates
38	our $MIN_INTERVAL = 1/100;	263	our $MIN_INTERVAL = 6/59.951;
39		264
40	{	265	{
41	package urxvt::bgdsl; # background language	266	package urxvt::bgdsl; # background language
		267
		268	sub FR_PARENT() { 0 } # parent frame, if any - must be #0
		269	sub FR_CACHE () { 1 } # cached values
		270	sub FR_AGAIN () { 2 } # what this expr is sensitive to
		271	sub FR_STATE () { 3 } # watchers etc.
		272
		273	use List::Util qw(min max sum shuffle);
42		274
43	=head2 PROVIDERS/GENERATORS	275	=head2 PROVIDERS/GENERATORS
44		276
45	These functions provide an image, by loading it from disk, grabbing it	277	These functions provide an image, by loading it from disk, grabbing it
46	from the root screen or by simply generating it. They are used as starting	278	from the root screen or by simply generating it. They are used as starting
51	=item load $path	283	=item load $path
52		284
53	Loads the image at the given C<$path>. The image is set to plane tiling	285	Loads the image at the given C<$path>. The image is set to plane tiling
54	mode.	286	mode.
55		287
56	Loaded images will be cached for one cycle.	288	If the image is already in memory (e.g. because another terminal instance
		289	uses it), then the in-memory copy us returned instead.
57		290
		291	=item load_uc $path
		292
		293	Load uncached - same as load, but does not cache the image, which means it
		294	is I<always> loaded from the filesystem again, even if another copy of it
		295	is in memory at the time.
		296
58	=cut	297	=cut
		298
		299	sub load_uc($) {
		300	$self->new_img_from_file ($_[0])
		301	}
59		302
60	sub load($) {	303	sub load($) {
61	my ($path) = @_;	304	my ($path) = @_;
62		305
63	$new->{load}{$path} = $old->{load}{$path} \|\| $self->new_img_from_file ($path);	306	$_IMG_CACHE{$path} \|\| do {
		307	my $img = load_uc $path;
		308	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
		309	$img
		310	}
64	}	311	}
65		312
66	=item root	313	=item root
67		314
68	Returns the root window pixmap, that is, hopefully, the background image	315	Returns the root window pixmap, that is, hopefully, the background image
69	of your screen. The image is set to extend mode.	316	of your screen.
70		317
71	This function makes your expression root sensitive, that means it will be	318	This function makes your expression root sensitive, that means it will be
72	reevaluated when the bg image changes.	319	reevaluated when the bg image changes.
73		320
74	=cut	321	=cut
75		322
76	sub root() {	323	sub root() {
77	$new->{rootpmap_sensitive} = 1;	324	$frame->[FR_AGAIN]{rootpmap} = 1;
78	die "root op not supported, exg, we need you";	325	$self->new_img_from_root
79	}	326	}
80		327
81	=item solid $colour	328	=item solid $colour
82		329
83	=item solid $width, $height, $colour	330	=item solid $width, $height, $colour
84		331
85	Creates a new image and completely fills it with the given colour. The	332	Creates a new image and completely fills it with the given colour. The
86	image is set to tiling mode.	333	image is set to tiling mode.
87		334
88	If <$width> and C<$height> are omitted, it creates a 1x1 image, which is	335	If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is
89	useful for solid backgrounds or for use in filtering effects.	336	useful for solid backgrounds or for use in filtering effects.
90		337
91	=cut	338	=cut
92		339
93	sub solid($$;$) {	340	sub solid($;$$) {
94	my $colour = pop;	341	my $colour = pop;
95		342
96	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);	343	my $img = $self->new_img (urxvt::PictStandardARGB32, 0, 0, $_[0] \|\| 1, $_[1] \|\| 1);
97	$img->fill ($colour);	344	$img->fill ($colour);
98	$img	345	$img
99	}	346	}
100		347
101	=back	348	=item clone $img
102		349
103	=head2 VARIABLES	350	Returns an exact copy of the image. This is useful if you want to have
		351	multiple copies of the same image to apply different effects to.
104		352
105	The following functions provide variable data such as the terminal
106	window dimensions. Most of them make your expression sensitive to some
107	events, for example using C<TW> (terminal width) means your expression is
108	evaluated again when the terminal is resized.
109
110	=over 4
111
112	=item TX
113
114	=item TY
115
116	Return the X and Y coordinates of the terminal window (the terminal
117	window is the full window by default, and the character area only when in
118	border-respect mode).
119
120	Using these functions make your expression sensitive to window moves.
121
122	These functions are mainly useful to align images to the root window.
123
124	Example: load an image and align it so it looks as if anchored to the
125	background.
126
127	move -TX, -TY, load "mybg.png"
128
129	=item TW
130
131	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
132	terminal window is the full window by default, and the character area only
133	when in border-respect mode).
134
135	Using these functions make your expression sensitive to window resizes.
136
137	These functions are mainly useful to scale images, or to clip images to
138	the window size to conserve memory.
139
140	Example: take the screen background, clip it to the window size, blur it a
141	bit, align it to the window position and use it as background.
142
143	clip move -TX, -TY, blur 5, root
144
145	=cut	353	=cut
146		354
147	sub TX() { $new->{position_sensitive} = 1; $x }
148	sub TY() { $new->{position_sensitive} = 1; $y }
149	sub TW() { $new->{size_sensitive} = 1; $w }
150	sub TH() { $new->{size_sensitive} = 1; $h }
151
152	=item now
153
154	Returns the current time as (fractional) seconds since the epoch.
155
156	Using this expression does I<not> make your expression sensitive to time,
157	but the next two functions do.
158
159	=item again $seconds
160
161	When this function is used the expression will be reevaluated again in
162	C<$seconds> seconds.
163
164	Example: load some image and rotate it according to the time of day (as if it were
165	the hour pointer of a clock). update this image every minute.
166
167	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
168
169	=item counter $seconds
170
171	Like C<again>, but also returns an increasing counter value, starting at
172	0, which might be useful for some simple animation effects.
173
174	=cut
175
176	sub now() { urxvt::NOW }
177
178	sub again($) {
179	$new->{again} = $_[0];
180	}
181
182	sub counter($) {	355	sub clone($) {
183	$new->{again} = $_[0];	356	$_[0]->clone
184	$self->{counter} + 0
185	}	357	}
186		358
187	=back	359	=item merge $img ...
		360
		361	Takes any number of images and merges them together, creating a single
		362	image containing them all. The tiling mode of the first image is used as
		363	the tiling mode of the resulting image.
		364
		365	This function is called automatically when an expression returns multiple
		366	images.
		367
		368	=cut
		369
		370	sub merge(@) {
		371	return $_[0] unless $#_;
		372
		373	# rather annoyingly clumsy, but optimisation is for another time
		374
		375	my $x0 = +1e9;
		376	my $y0 = +1e9;
		377	my $x1 = -1e9;
		378	my $y1 = -1e9;
		379
		380	for (@_) {
		381	my ($x, $y, $w, $h) = $_->geometry;
		382
		383	$x0 = $x if $x0 > $x;
		384	$y0 = $y if $y0 > $y;
		385
		386	$x += $w;
		387	$y += $h;
		388
		389	$x1 = $x if $x1 < $x;
		390	$y1 = $y if $y1 < $y;
		391	}
		392
		393	my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
		394	$base->repeat_mode ($_[0]->repeat_mode);
		395	$base->fill ([0, 0, 0, 0]);
		396
		397	$base->draw ($_)
		398	for @_;
		399
		400	$base
		401	}
188		402
189	=head2 TILING MODES	403	=head2 TILING MODES
190		404
191	The following operators modify the tiling mode of an image, that is, the	405	The following operators modify the tiling mode of an image, that is, the
192	way that pixels outside the image area are painted when the image is used.	406	way that pixels outside the image area are painted when the image is used.
…		…
209	Similar to tile, but reflects the image each time it uses a new copy, so	423	Similar to tile, but reflects the image each time it uses a new copy, so
210	that top edges always touch top edges, right edges always touch right	424	that top edges always touch top edges, right edges always touch right
211	edges and so on (with normal tiling, left edges always touch right edges	425	edges and so on (with normal tiling, left edges always touch right edges
212	and top always touch bottom edges).	426	and top always touch bottom edges).
213		427
214	Exmaple: load an image and mirror it over the background, avoiding sharp	428	Example: load an image and mirror it over the background, avoiding sharp
215	edges at the image borders at the expense of mirroring the image itself	429	edges at the image borders at the expense of mirroring the image itself
216		430
217	mirror load "mybg.png"	431	mirror load "mybg.png"
218		432
219	=item pad $img	433	=item pad $img
…		…
221	Takes an image and modifies it so that all pixels outside the image area	435	Takes an image and modifies it so that all pixels outside the image area
222	become transparent. This mode is most useful when you want to place an	436	become transparent. This mode is most useful when you want to place an
223	image over another image or the background colour while leaving all	437	image over another image or the background colour while leaving all
224	background pixels outside the image unchanged.	438	background pixels outside the image unchanged.
225		439
226	Example: load an image and display it in the upper left corner. The rets	440	Example: load an image and display it in the upper left corner. The rest
227	of the space is left "empty" (transparent or wahtever your compisotr does	441	of the space is left "empty" (transparent or whatever your compositor does
228	in alpha mode, else background colour).	442	in alpha mode, else background colour).
229		443
230	pad load "mybg.png"	444	pad load "mybg.png"
231		445
232	=item extend $img	446	=item extend $img
233		447
234	Extends the image over the whole plane, using the closest pixel in the	448	Extends the image over the whole plane, using the closest pixel in the
235	area outside the image. This mode is mostly useful when you more complex	449	area outside the image. This mode is mostly useful when you use more complex
236	filtering operations and want the pixels outside the image to have the	450	filtering operations and want the pixels outside the image to have the
237	same values as the pixels near the edge.	451	same values as the pixels near the edge.
238		452
239	Example: just for curiosity, how does this pixel extension stuff work?	453	Example: just for curiosity, how does this pixel extension stuff work?
240		454
…		…
266	$img	480	$img
267	}	481	}
268		482
269	=back	483	=back
270		484
271	=head2 PIXEL OPERATORS	485	=head2 VARIABLE VALUES
272		486
273	The following operators modify the image pixels in various ways.	487	The following functions provide variable data such as the terminal window
		488	dimensions. They are not (Perl-) variables, they just return stuff that
		489	varies. Most of them make your expression sensitive to some events, for
		490	example using C<TW> (terminal width) means your expression is evaluated
		491	again when the terminal is resized.
274		492
275	=over 4	493	=over 4
276		494
277	=item clone $img	495	=item TX
278		496
279	Returns an exact copy of the image.	497	=item TY
280		498
281	=cut	499	Return the X and Y coordinates of the terminal window (the terminal
		500	window is the full window by default, and the character area only when in
		501	border-respect mode).
282		502
		503	Using these functions make your expression sensitive to window moves.
		504
		505	These functions are mainly useful to align images to the root window.
		506
		507	Example: load an image and align it so it looks as if anchored to the
		508	background (that's exactly what C<rootalign> does btw.):
		509
		510	move -TX, -TY, keep { load "mybg.png" }
		511
		512	=item TW
		513
		514	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
		515	terminal window is the full window by default, and the character area only
		516	when in border-respect mode).
		517
		518	Using these functions make your expression sensitive to window resizes.
		519
		520	These functions are mainly useful to scale images, or to clip images to
		521	the window size to conserve memory.
		522
		523	Example: take the screen background, clip it to the window size, blur it a
		524	bit, align it to the window position and use it as background.
		525
		526	clip move -TX, -TY, keep { blur 5, root }
		527
		528	=cut
		529
		530	sub TX() { $frame->[FR_AGAIN]{position} = 1; $x }
		531	sub TY() { $frame->[FR_AGAIN]{position} = 1; $y }
		532	sub TW() { $frame->[FR_AGAIN]{size} = 1; $w }
		533	sub TH() { $frame->[FR_AGAIN]{size} = 1; $h }
		534
		535	=item now
		536
		537	Returns the current time as (fractional) seconds since the epoch.
		538
		539	Using this expression does I<not> make your expression sensitive to time,
		540	but the next two functions do.
		541
		542	=item again $seconds
		543
		544	When this function is used the expression will be reevaluated again in
		545	C<$seconds> seconds.
		546
		547	Example: load some image and rotate it according to the time of day (as if it were
		548	the hour pointer of a clock). Update this image every minute.
		549
		550	again 60;
		551	rotate 50, 50, (now % 86400) * -72 / 8640, scale keep { load "myclock.png" }
		552
		553	=item counter $seconds
		554
		555	Like C<again>, but also returns an increasing counter value, starting at
		556	0, which might be useful for some simple animation effects.
		557
		558	=cut
		559
		560	sub now() { urxvt::NOW }
		561
		562	sub again($) {
		563	$frame->[FR_AGAIN]{time} = $_[0];
		564	}
		565
283	sub clone($) {	566	sub counter($) {
284	$_[0]->clone	567	$frame->[FR_AGAIN]{time} = $_[0];
		568	$frame->[FR_STATE]{counter} + 0
285	}	569	}
		570
		571	=back
		572
		573	=head2 SHAPE CHANGING OPERATORS
		574
		575	The following operators modify the shape, size or position of the image.
		576
		577	=over 4
286		578
287	=item clip $img	579	=item clip $img
288		580
289	=item clip $width, $height, $img	581	=item clip $width, $height, $img
290		582
…		…
301	assumed.	593	assumed.
302		594
303	Example: load an image, blur it, and clip it to the window size to save	595	Example: load an image, blur it, and clip it to the window size to save
304	memory.	596	memory.
305		597
306	clip blur 10, load "mybg.png"	598	clip keep { blur 10, load "mybg.png" }
307		599
308	=cut	600	=cut
309		601
310	sub clip($;$$;$$) {	602	sub clip($;$$;$$) {
311	my $img = pop;	603	my $img = pop;
…		…
314	$img->sub_rect ($_[0], $_[1], $w, $h)	606	$img->sub_rect ($_[0], $_[1], $w, $h)
315	}	607	}
316		608
317	=item scale $img	609	=item scale $img
318		610
319	=item scale $size_percent, $img	611	=item scale $size_factor, $img
320		612
321	=item scale $width_percent, $height_percent, $img	613	=item scale $width_factor, $height_factor, $img
322		614
323	Scales the image by the given percentages in horizontal	615	Scales the image by the given factors in horizontal
324	(C<$width_percent>) and vertical (C<$height_percent>) direction.	616	(C<$width>) and vertical (C<$height>) direction.
325		617
326	If only one percentage is give, it is used for both directions.	618	If only one factor is give, it is used for both directions.
327		619
328	If no percentages are given, scales the image to the window size without	620	If no factors are given, scales the image to the window size without
329	keeping aspect.	621	keeping aspect.
330		622
331	=item resize $width, $height, $img	623	=item resize $width, $height, $img
332		624
333	Resizes the image to exactly C<$width> times C<$height> pixels.	625	Resizes the image to exactly C<$width> times C<$height> pixels.
334		626
335	=cut	627	=item fit $img
336		628
337	#TODO: maximise, maximise_fill?	629	=item fit $width, $height, $img
		630
		631	Fits the image into the given C<$width> and C<$height> without changing
		632	aspect, or the terminal size. That means it will be shrunk or grown until
		633	the whole image fits into the given area, possibly leaving borders.
		634
		635	=item cover $img
		636
		637	=item cover $width, $height, $img
		638
		639	Similar to C<fit>, but shrinks or grows until all of the area is covered
		640	by the image, so instead of potentially leaving borders, it will cut off
		641	image data that doesn't fit.
		642
		643	=cut
338		644
339	sub scale($;$;$) {	645	sub scale($;$;$) {
340	my $img = pop;	646	my $img = pop;
341		647
342	@_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01)	648	@_ == 2 ? $img->scale ($_[0] * $img->w, $_[1] * $img->h)
343	: @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01)	649	: @_ ? $img->scale ($_[0] * $img->w, $_[0] * $img->h)
344	: $img->scale (TW, TH)	650	: $img->scale (TW, TH)
345	}	651	}
346		652
347	sub resize($$$) {	653	sub resize($$$) {
348	my $img = pop;	654	my $img = pop;
349	$img->scale ($_[0], $_[1])	655	$img->scale ($_[0], $_[1])
350	}	656	}
		657
		658	sub fit($;$$) {
		659	my $img = pop;
		660	my $w = ($_[0] \|\| TW) / $img->w;
		661	my $h = ($_[1] \|\| TH) / $img->h;
		662	scale +(min $w, $h), $img
		663	}
		664
		665	sub cover($;$$) {
		666	my $img = pop;
		667	my $w = ($_[0] \|\| TW) / $img->w;
		668	my $h = ($_[1] \|\| TH) / $img->h;
		669	scale +(max $w, $h), $img
		670	}
		671
		672	=item move $dx, $dy, $img
		673
		674	Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in
		675	the vertical.
		676
		677	Example: move the image right by 20 pixels and down by 30.
		678
		679	move 20, 30, ...
		680
		681	=item align $xalign, $yalign, $img
		682
		683	Aligns the image according to a factor - C<0> means the image is moved to
		684	the left or top edge (for C<$xalign> or C<$yalign>), C<0.5> means it is
		685	exactly centered and C<1> means it touches the right or bottom edge.
		686
		687	Example: remove any visible border around an image, center it vertically but move
		688	it to the right hand side.
		689
		690	align 1, 0.5, pad $img
		691
		692	=item center $img
		693
		694	=item center $width, $height, $img
		695
		696	Centers the image, i.e. the center of the image is moved to the center of
		697	the terminal window (or the box specified by C<$width> and C<$height> if
		698	given).
		699
		700	Example: load an image and center it.
		701
		702	center keep { pad load "mybg.png" }
		703
		704	=item rootalign $img
		705
		706	Moves the image so that it appears glued to the screen as opposed to the
		707	window. This gives the illusion of a larger area behind the window. It is
		708	exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
		709	top left of the screen.
		710
		711	Example: load a background image, put it in mirror mode and root align it.
		712
		713	rootalign keep { mirror load "mybg.png" }
		714
		715	Example: take the screen background and align it, giving the illusion of
		716	transparency as long as the window isn't in front of other windows.
		717
		718	rootalign root
		719
		720	=cut
351		721
352	sub move($$;$) {	722	sub move($$;$) {
353	my $img = pop->clone;	723	my $img = pop->clone;
354	$img->move ($_[0], $_[1]);	724	$img->move ($_[0], $_[1]);
355	$img	725	$img
356	}	726	}
357		727
		728	sub align($;$$) {
		729	my $img = pop;
		730
		731	move $_[0] * (TW - $img->w),
		732	$_[1] * (TH - $img->h),
		733	$img
		734	}
		735
		736	sub center($;$$) {
		737	my $img = pop;
		738	my $w = $_[0] \|\| TW;
		739	my $h = $_[1] \|\| TH;
		740
		741	move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img
		742	}
		743
		744	sub rootalign($) {
		745	move -TX, -TY, $_[0]
		746	}
		747
		748	=item rotate $center_x, $center_y, $degrees, $img
		749
		750	Rotates the image clockwise by C<$degrees> degrees, around the point at
		751	C<$center_x> and C<$center_y> (specified as factor of image width/height).
		752
		753	Example: rotate the image by 90 degrees around it's center.
		754
		755	rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
		756
		757	=cut
		758
358	sub rotate($$$$$$) {	759	sub rotate($$$$) {
359	my $img = pop;	760	my $img = pop;
360	$img->rotate (	761	$img->rotate (
361	$_[0],	762	$_[0] * ($img->w + $img->x),
362	$_[1],	763	$_[1] * ($img->h + $img->y),
363	$_[2] * $img->w * .01,
364	$_[3] * $img->h * .01,
365	$_[4] * (3.14159265 / 180),	764	$_[2] * (3.14159265 / 180),
366	)	765	)
367	}	766	}
		767
		768	=back
		769
		770	=head2 COLOUR MODIFICATIONS
		771
		772	The following operators change the pixels of the image.
		773
		774	=over 4
		775
		776	=item tint $color, $img
		777
		778	Tints the image in the given colour.
		779
		780	Example: tint the image red.
		781
		782	tint "red", load "rgb.png"
		783
		784	Example: the same, but specify the colour by component.
		785
		786	tint [1, 0, 0], load "rgb.png"
		787
		788	=cut
		789
		790	sub tint($$) {
		791	$_[1]->tint ($_[0])
		792	}
		793
		794	=item contrast $factor, $img
		795
		796	=item contrast $r, $g, $b, $img
		797
		798	=item contrast $r, $g, $b, $a, $img
		799
		800	Adjusts the I<contrast> of an image.
		801
		802	The first form applies a single C<$factor> to red, green and blue, the
		803	second form applies separate factors to each colour channel, and the last
		804	form includes the alpha channel.
		805
		806	Values from 0 to 1 lower the contrast, values higher than 1 increase the
		807	contrast.
		808
		809	Due to limitations in the underlying XRender extension, lowering contrast
		810	also reduces brightness, while increasing contrast currently also
		811	increases brightness.
		812
		813	=item brightness $bias, $img
		814
		815	=item brightness $r, $g, $b, $img
		816
		817	=item brightness $r, $g, $b, $a, $img
		818
		819	Adjusts the brightness of an image.
		820
		821	The first form applies a single C<$bias> to red, green and blue, the
		822	second form applies separate biases to each colour channel, and the last
		823	form includes the alpha channel.
		824
		825	Values less than 0 reduce brightness, while values larger than 0 increase
		826	it. Useful range is from -1 to 1 - the former results in a black, the
		827	latter in a white picture.
		828
		829	Due to idiosyncrasies in the underlying XRender extension, biases less
		830	than zero can be I<very> slow.
		831
		832	=cut
		833
		834	sub contrast($$;$$;$) {
		835	my $img = pop;
		836	my ($r, $g, $b, $a) = @_;
		837
		838	($g, $b) = ($r, $r) if @_ < 3;
		839	$a = 1 if @_ < 4;
		840
		841	$img = $img->clone;
		842	$img->contrast ($r, $g, $b, $a);
		843	$img
		844	}
		845
		846	sub brightness($$;$$;$) {
		847	my $img = pop;
		848	my ($r, $g, $b, $a) = @_;
		849
		850	($g, $b) = ($r, $r) if @_ < 3;
		851	$a = 1 if @_ < 4;
		852
		853	$img = $img->clone;
		854	$img->brightness ($r, $g, $b, $a);
		855	$img
		856	}
		857
		858	=item blur $radius, $img
		859
		860	=item blur $radius_horz, $radius_vert, $img
		861
		862	Gaussian-blurs the image with (roughly) C<$radius> pixel radius. The radii
		863	can also be specified separately.
		864
		865	Blurring is often I<very> slow, at least compared or other
		866	operators. Larger blur radii are slower than smaller ones, too, so if you
		867	don't want to freeze your screen for long times, start experimenting with
		868	low values for radius (<5).
		869
		870	=cut
368		871
369	sub blur($$;$) {	872	sub blur($$;$) {
370	my $img = pop;	873	my $img = pop;
371	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	874	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
372	}	875	}
373		876
374	sub contrast($$;$$;$) {
375	my $img = pop;
376	my ($r, $g, $b, $a) = @_;
377
378	($g, $b) = ($r, $r) if @_ < 4;
379	$a = 1 if @_ < 5;
380
381	$img = $img->clone;
382	$img->contrast ($r, $g, $b, $a);
383	$img
384	}
385
386	sub brightness($$;$$;$) {
387	my $img = pop;
388	my ($r, $g, $b, $a) = @_;
389
390	($g, $b) = ($r, $r) if @_ < 4;
391	$a = 1 if @_ < 5;
392
393	$img = $img->clone;
394	$img->brightness ($r, $g, $b, $a);
395	$img
396	}
397
398	=back	877	=back
399		878
		879	=head2 OTHER STUFF
		880
		881	Anything that didn't fit any of the other categories, even after applying
		882	force and closing our eyes.
		883
		884	=over 4
		885
		886	=item keep { ... }
		887
		888	This operator takes a code block as argument, that is, one or more
		889	statements enclosed by braces.
		890
		891	The trick is that this code block is only evaluated when the outcome
		892	changes - on other calls the C<keep> simply returns the image it computed
		893	previously (yes, it should only be used with images). Or in other words,
		894	C<keep> I<caches> the result of the code block so it doesn't need to be
		895	computed again.
		896
		897	This can be extremely useful to avoid redoing slow operations - for
		898	example, if your background expression takes the root background, blurs it
		899	and then root-aligns it it would have to blur the root background on every
		900	window move or resize.
		901
		902	Another example is C<load>, which can be quite slow.
		903
		904	In fact, urxvt itself encloses the whole expression in some kind of
		905	C<keep> block so it only is reevaluated as required.
		906
		907	Putting the blur into a C<keep> block will make sure the blur is only done
		908	once, while the C<rootalign> is still done each time the window moves.
		909
		910	rootalign keep { blur 10, root }
		911
		912	This leaves the question of how to force reevaluation of the block,
		913	in case the root background changes: If expression inside the block
		914	is sensitive to some event (root background changes, window geometry
		915	changes), then it will be reevaluated automatically as needed.
		916
		917	=cut
		918
		919	sub keep(&) {
		920	my $id = $_[0]+0;
		921
		922	local $frame = $self->{frame_cache}{$id} \|\|= [$frame];
		923
		924	unless ($frame->[FR_CACHE]) {
		925	$frame->[FR_CACHE] = [ $_[0]() ];
		926
		927	my $self = $self;
		928	my $frame = $frame;
		929	Scalar::Util::weaken $frame;
		930	$self->compile_frame ($frame, sub {
		931	# clear this frame cache, also for all parents
		932	for (my $frame = $frame; $frame; $frame = $frame->[0]) {
		933	undef $frame->[FR_CACHE];
		934	}
		935
		936	$self->recalculate;
		937	});
		938	};
		939
		940	# in scalar context we always return the first original result, which
		941	# is not quite how perl works.
		942	wantarray
		943	? @{ $frame->[FR_CACHE] }
		944	: $frame->[FR_CACHE][0]
		945	}
		946
		947	# sub keep_clear() {
		948	# delete $self->{frame_cache};
		949	# }
		950
		951	=back
		952
400	=cut	953	=cut
401		954
402	}	955	}
403		956
404	sub parse_expr {	957	sub parse_expr {
405	my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}";	958	my $expr = eval
		959	"sub {\n"
		960	. "package urxvt::bgdsl;\n"
		961	. "#line 0 'background expression'\n"
		962	. "$_[0]\n"
		963	. "}";
406	die if $@;	964	die if $@;
407	$expr	965	$expr
408	}	966	}
409		967
410	# compiles a parsed expression	968	# compiles a parsed expression
411	sub set_expr {	969	sub set_expr {
412	my ($self, $expr) = @_;	970	my ($self, $expr) = @_;
413		971
		972	$self->{root} = [];
414	$self->{expr} = $expr;	973	$self->{expr} = $expr;
415	$self->recalculate;	974	$self->recalculate;
		975	}
		976
		977	# takes a hash of sensitivity indicators and installs watchers
		978	sub compile_frame {
		979	my ($self, $frame, $cb) = @_;
		980
		981	my $state = $frame->[urxvt::bgdsl::FR_STATE] \|\|= {};
		982	my $again = $frame->[urxvt::bgdsl::FR_AGAIN];
		983
		984	# don't keep stuff alive
		985	Scalar::Util::weaken $state;
		986
		987	if ($again->{nested}) {
		988	$state->{nested} = 1;
		989	} else {
		990	delete $state->{nested};
		991	}
		992
		993	if (my $interval = $again->{time}) {
		994	$state->{time} = [$interval, urxvt::timer->new->after ($interval)->interval ($interval)]
		995	if $state->{time}[0] != $interval;
		996
		997	# callback might have changed, although we could just rule that out
		998	$state->{time}[1]->cb (sub {
		999	++$state->{counter};
		1000	$cb->();
		1001	});
		1002	} else {
		1003	delete $state->{time};
		1004	}
		1005
		1006	if ($again->{position}) {
		1007	$state->{position} = $self->on (position_change => $cb);
		1008	} else {
		1009	delete $state->{position};
		1010	}
		1011
		1012	if ($again->{size}) {
		1013	$state->{size} = $self->on (size_change => $cb);
		1014	} else {
		1015	delete $state->{size};
		1016	}
		1017
		1018	if ($again->{rootpmap}) {
		1019	$state->{rootpmap} = $self->on (rootpmap_change => $cb);
		1020	} else {
		1021	delete $state->{rootpmap};
		1022	}
416	}	1023	}
417		1024
418	# evaluate the current bg expression	1025	# evaluate the current bg expression
419	sub recalculate {	1026	sub recalculate {
420	my ($arg_self) = @_;	1027	my ($arg_self) = @_;
…		…
430		1037
431	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	1038	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
432		1039
433	# set environment to evaluate user expression	1040	# set environment to evaluate user expression
434		1041
435	local $self = $arg_self;	1042	local $self = $arg_self;
		1043	local $HOME = $ENV{HOME};
		1044	local $frame = [];
436		1045
437	local $old = $self->{state};
438	local $new = my $state = $self->{state} = {};
439
440	($x, $y, $w, $h) =
441	$self->background_geometry ($self->{border});	1046	($x, $y, $w, $h) = $self->background_geometry ($self->{border});
442		1047
443	# evaluate user expression	1048	# evaluate user expression
444		1049
445	my $img = eval { $self->{expr}->() };	1050	my @img = eval { $self->{expr}->() };
446	warn $@ if $@;#d#	1051	die $@ if $@;
		1052	die "background-expr did not return anything.\n" unless @img;
		1053	die "background-expr: expected image(s), got something else.\n"
447	die if !UNIVERSAL::isa $img, "urxvt::img";	1054	if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;
448		1055
449	$state->{size_sensitive} = 1	1056	my $img = urxvt::bgdsl::merge @img;
		1057
		1058	$frame->[FR_AGAIN]{size} = 1
450	if $img->repeat_mode != urxvt::RepeatNormal;	1059	if $img->repeat_mode != urxvt::RepeatNormal;
451		1060
452	# if the expression is sensitive to external events, prepare reevaluation then	1061	# if the expression is sensitive to external events, prepare reevaluation then
453		1062	$self->compile_frame ($frame, sub { $arg_self->recalculate });
454	my $repeat;
455
456	if (my $again = $state->{again}) {
457	$repeat = 1;
458	my $self = $self;
459	$state->{timer} = $again == $old->{again}
460	? $old->{timer}
461	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
462	++$self->{counter};
463	$self->recalculate
464	});
465	}
466
467	if (delete $state->{position_sensitive}) {
468	$repeat = 1;
469	$self->enable (position_change => sub { $_[0]->recalculate });
470	} else {
471	$self->disable ("position_change");
472	}
473
474	if (delete $state->{size_sensitive}) {
475	$repeat = 1;
476	$self->enable (size_change => sub { $_[0]->recalculate });
477	} else {
478	$self->disable ("size_change");
479	}
480
481	if (delete $state->{rootpmap_sensitive}) {
482	$repeat = 1;
483	$self->enable (rootpmap_change => sub { $_[0]->recalculate });
484	} else {
485	$self->disable ("rootpmap_change");
486	}
487		1063
488	# clear stuff we no longer need	1064	# clear stuff we no longer need
489		1065
490	%$old = ();	1066	# unless (%{ $frame->[FR_STATE] }) {
491
492	unless ($repeat) {
493	delete $self->{state};	1067	# delete $self->{state};
494	delete $self->{expr};	1068	# delete $self->{expr};
495	}	1069	# }
496		1070
497	# set background pixmap	1071	# set background pixmap
498		1072
499	$self->set_background ($img, $self->{border});	1073	$self->set_background ($img, $self->{border});
500	$self->scr_recolour (0);	1074	$self->scr_recolour (0);
…		…
502	}	1076	}
503		1077
504	sub on_start {	1078	sub on_start {
505	my ($self) = @_;	1079	my ($self) = @_;
506		1080
507	my $expr = $self->x_resource ("background.expr")	1081	my $expr = $self->x_resource ("%.expr")
508	or return;	1082	or return;
509		1083
		1084	$self->has_render
		1085	or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
		1086
510	$self->set_expr (parse_expr $expr);	1087	$self->set_expr (parse_expr $expr);
511	$self->{border} = $self->x_resource_boolean ("background.border");	1088	$self->{border} = $self->x_resource_boolean ("%.border");
		1089
		1090	$MIN_INTERVAL = $self->x_resource ("%.interval");
512		1091
513	()	1092	()
514	}	1093	}
515		1094

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.35 by root, Fri Jun 8 08:06:38 2012 UTC vs. Revision 1.73 by sf-exg, Thu Jul 5 20:05:19 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.35 by root, Fri Jun 8 08:06:38 2012 UTC vs.
Revision 1.73 by sf-exg, Thu Jul 5 20:05:19 2012 UTC