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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.44 by root, Sun Jun 10 11:31:22 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:%.border.:boolean:respect the terminal border	4	#:META:X_RESOURCE:%.border:boolean:respect the terminal border
5		5	#:META:X_RESOURCE:%.interval:seconds:minimum time between updates
6	#TODO: once, rootalign
7		6
8	=head1 NAME	7	=head1 NAME
9		8
10	background - manage terminal background	9	background - manage terminal background
11		10
12	=head1 SYNOPSIS	11	=head1 SYNOPSIS
13		12
14	urxvt --background-expr 'background expression'	13	urxvt --background-expr 'background expression'
15	--background-border	14	--background-border
		15	--background-interval seconds
16		16
17	=head1 DESCRIPTION	17	=head1 DESCRIPTION
18		18
19	This extension manages the terminal background by creating a picture that	19	This extension manages the terminal background by creating a picture that
20	is behind the text, replacing the normal background colour.	20	is behind the text, replacing the normal background colour.
57		57
58	For example, an expression such as C<scale load "$HOME/mybg.png"> scales the	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	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	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	61	example. That ensures that the picture always fills the terminal, even
62	after it's size changes.	62	after its size changes.
63		63
64	=head2 EXPRESSIONS	64	=head2 EXPRESSIONS
65		65
66	Expressions are normal Perl expressions, in fact, they are Perl blocks -	66	Expressions are normal Perl expressions, in fact, they are Perl blocks -
67	which means you could use multiple lines and statements:	67	which means you could use multiple lines and statements:
…		…
115	horizontal and vertical dimensions. For example, this halves the image	115	horizontal and vertical dimensions. For example, this halves the image
116	width and doubles the image height:	116	width and doubles the image height:
117		117
118	scale 0.5, 2, load "$HOME/mypic.png"	118	scale 0.5, 2, load "$HOME/mypic.png"
119		119
120	Other effects than scalign are also readily available, for exmaple, you can	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:	121	tile the image to fill the whole window, instead of resizing it:
122		122
123	tile load "$HOME/mypic.png"	123	tile load "$HOME/mypic.png"
124		124
125	In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator	125	In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator
…		…
151	This only works for one cycle though, so as long as you load the same	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	152	image every time, it will always be cached, but when you load a different
153	image, it will forget about the first one.	153	image, it will forget about the first one.
154		154
155	This allows you to either speed things up by keeping multiple images in	155	This allows you to either speed things up by keeping multiple images in
156	memory, or comserve memory by loading images more often.	156	memory, or conserve memory by loading images more often.
157		157
158	For example, you can keep two images in memory and use a random one like	158	For example, you can keep two images in memory and use a random one like
159	this:	159	this:
160		160
161	my $img1 = load "img1.png";	161	my $img1 = load "img1.png";
…		…
189	overwriting borders and any other areas, such as the scrollbar.	189	overwriting borders and any other areas, such as the scrollbar.
190		190
191	Specifying this flag changes the behaviour, so that the image only	191	Specifying this flag changes the behaviour, so that the image only
192	replaces the background of the character area.	192	replaces the background of the character area.
193		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
194	=back	203	=back
195		204
196	=cut	205	=cut
197		206
		207	our %_IMG_CACHE;
		208	our %_ONCE_CACHE;
198	our $HOME;	209	our $HOME;
199	our ($self, $old, $new);	210	our ($self, $old, $new);
200	our ($x, $y, $w, $h);	211	our ($x, $y, $w, $h);
201		212
202	# enforce at least this interval between updates	213	# enforce at least this interval between updates
203	our $MIN_INTERVAL = 1/100;	214	our $MIN_INTERVAL = 6/59.951;
204		215
205	{	216	{
206	package urxvt::bgdsl; # background language	217	package urxvt::bgdsl; # background language
207		218
208	use List::Util qw(min max sum shuffle);	219	use List::Util qw(min max sum shuffle);
…		…
240		251
241	=cut	252	=cut
242		253
243	sub root() {	254	sub root() {
244	$new->{rootpmap_sensitive} = 1;	255	$new->{rootpmap_sensitive} = 1;
245	die "root op not supported, exg, we need you";	256	$self->new_img_from_root
246	}	257	}
247		258
248	=item solid $colour	259	=item solid $colour
249		260
250	=item solid $width, $height, $colour	261	=item solid $width, $height, $colour
…		…
263	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);	274	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);
264	$img->fill ($colour);	275	$img->fill ($colour);
265	$img	276	$img
266	}	277	}
267		278
		279	=item clone $img
		280
		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.
		283
		284	=cut
		285
		286	sub clone($) {
		287	$_[0]->clone
		288	}
		289
		290	=head2 TILING MODES
		291
		292	The following operators modify the tiling mode of an image, that is, the
		293	way that pixels outside the image area are painted when the image is used.
		294
		295	=over 4
		296
		297	=item tile $img
		298
		299	Tiles the whole plane with the image and returns this new image - or in
		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"
		307
		308	=item mirror $img
		309
		310	Similar to tile, but reflects the image each time it uses a new copy, so
		311	that top edges always touch top edges, right edges always touch right
		312	edges and so on (with normal tiling, left edges always touch right edges
		313	and top always touch bottom edges).
		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
		320	=item pad $img
		321
		322	Takes an image and modifies it so that all pixels outside the image area
		323	become transparent. This mode is most useful when you want to place an
		324	image over another image or the background colour while leaving all
		325	background pixels outside the image unchanged.
		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
		333	=item extend $img
		334
		335	Extends the image over the whole plane, using the closest pixel in the
		336	area outside the image. This mode is mostly useful when you use more complex
		337	filtering operations and want the pixels outside the image to have the
		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"
		343
		344	=cut
		345
		346	sub pad($) {
		347	my $img = $_[0]->clone;
		348	$img->repeat_mode (urxvt::RepeatNone);
		349	$img
		350	}
		351
		352	sub tile($) {
		353	my $img = $_[0]->clone;
		354	$img->repeat_mode (urxvt::RepeatNormal);
		355	$img
		356	}
		357
		358	sub mirror($) {
		359	my $img = $_[0]->clone;
		360	$img->repeat_mode (urxvt::RepeatReflect);
		361	$img
		362	}
		363
		364	sub extend($) {
		365	my $img = $_[0]->clone;
		366	$img->repeat_mode (urxvt::RepeatPad);
		367	$img
		368	}
		369
268	=back	370	=back
269		371
270	=head2 VARIABLES	372	=head2 VARIABLE VALUES
271		373
272	The following functions provide variable data such as the terminal window	374	The following functions provide variable data such as the terminal window
273	dimensions. They are not (Perl-) variables, they jsut return stuff that	375	dimensions. They are not (Perl-) variables, they just return stuff that
274	varies. Most of them make your expression sensitive to some events, for	376	varies. Most of them make your expression sensitive to some events, for
275	example using C<TW> (terminal width) means your expression is evaluated	377	example using C<TW> (terminal width) means your expression is evaluated
276	again when the terminal is resized.	378	again when the terminal is resized.
277		379
278	=over 4	380	=over 4
…		…
330	C<$seconds> seconds.	432	C<$seconds> seconds.
331		433
332	Example: load some image and rotate it according to the time of day (as if it were	434	Example: load some image and rotate it according to the time of day (as if it were
333	the hour pointer of a clock). Update this image every minute.	435	the hour pointer of a clock). Update this image every minute.
334		436
335	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"	437	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
336		438
337	=item counter $seconds	439	=item counter $seconds
338		440
339	Like C<again>, but also returns an increasing counter value, starting at	441	Like C<again>, but also returns an increasing counter value, starting at
340	0, which might be useful for some simple animation effects.	442	0, which might be useful for some simple animation effects.
…		…
352	$self->{counter} + 0	454	$self->{counter} + 0
353	}	455	}
354		456
355	=back	457	=back
356		458
357	=head2 TILING MODES	459	=head2 SHAPE CHANGING OPERATORS
358		460
359	The following operators modify the tiling mode of an image, that is, the	461	The following operators modify the shape, size or position of the image.
360	way that pixels outside the image area are painted when the image is used.
361		462
362	=over 4	463	=over 4
363
364	=item tile $img
365
366	Tiles the whole plane with the image and returns this new image - or in
367	other words, it returns a copy of the image in plane tiling mode.
368
369	Example: load an image and tile it over the background, without
370	resizing. The C<tile> call is superfluous because C<load> already defaults
371	to tiling mode.
372
373	tile load "mybg.png"
374
375	=item mirror $img
376
377	Similar to tile, but reflects the image each time it uses a new copy, so
378	that top edges always touch top edges, right edges always touch right
379	edges and so on (with normal tiling, left edges always touch right edges
380	and top always touch bottom edges).
381
382	Example: load an image and mirror it over the background, avoiding sharp
383	edges at the image borders at the expense of mirroring the image itself
384
385	mirror load "mybg.png"
386
387	=item pad $img
388
389	Takes an image and modifies it so that all pixels outside the image area
390	become transparent. This mode is most useful when you want to place an
391	image over another image or the background colour while leaving all
392	background pixels outside the image unchanged.
393
394	Example: load an image and display it in the upper left corner. The rest
395	of the space is left "empty" (transparent or wahtever your compisotr does
396	in alpha mode, else background colour).
397
398	pad load "mybg.png"
399
400	=item extend $img
401
402	Extends the image over the whole plane, using the closest pixel in the
403	area outside the image. This mode is mostly useful when you more complex
404	filtering operations and want the pixels outside the image to have the
405	same values as the pixels near the edge.
406
407	Example: just for curiosity, how does this pixel extension stuff work?
408
409	extend move 50, 50, load "mybg.png"
410
411	=cut
412
413	sub pad($) {
414	my $img = $_[0]->clone;
415	$img->repeat_mode (urxvt::RepeatNone);
416	$img
417	}
418
419	sub tile($) {
420	my $img = $_[0]->clone;
421	$img->repeat_mode (urxvt::RepeatNormal);
422	$img
423	}
424
425	sub mirror($) {
426	my $img = $_[0]->clone;
427	$img->repeat_mode (urxvt::RepeatReflect);
428	$img
429	}
430
431	sub extend($) {
432	my $img = $_[0]->clone;
433	$img->repeat_mode (urxvt::RepeatPad);
434	$img
435	}
436
437	=back
438
439	=head2 PIXEL OPERATORS
440
441	The following operators modify the image pixels in various ways.
442
443	=over 4
444
445	=item clone $img
446
447	Returns an exact copy of the image.
448
449	=cut
450
451	sub clone($) {
452	$_[0]->clone
453	}
454		464
455	=item clip $img	465	=item clip $img
456		466
457	=item clip $width, $height, $img	467	=item clip $width, $height, $img
458		468
…		…
552		562
553	Example: move the image right by 20 pixels and down by 30.	563	Example: move the image right by 20 pixels and down by 30.
554		564
555	move 20, 30, ...	565	move 20, 30, ...
556		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
557	=item center $img	578	=item center $img
558		579
559	=item center $width, $height, $img	580	=item center $width, $height, $img
560		581
561	Centers the image, i.e. the center of the image is moved to the center of	582	Centers the image, i.e. the center of the image is moved to the center of
562	the terminal window (or the box specified by C<$width> and C<$height> if	583	the terminal window (or the box specified by C<$width> and C<$height> if
563	given).	584	given).
		585
		586	Example: load an image and center it.
		587
		588	center pad load "mybg.png"
564		589
565	=item rootalign $img	590	=item rootalign $img
566		591
567	Moves the image so that it appears glued to the screen as opposed to the	592	Moves the image so that it appears glued to the screen as opposed to the
568	window. This gives the illusion of a larger area behind the window. It is	593	window. This gives the illusion of a larger area behind the window. It is
…		…
574	rootalign mirror load "mybg.png"	599	rootalign mirror load "mybg.png"
575		600
576	Example: take the screen background and align it, giving the illusion of	601	Example: take the screen background and align it, giving the illusion of
577	transparency as long as the window isn't in front of other windows.	602	transparency as long as the window isn't in front of other windows.
578		603
579	rootalign root	604	rootalign root
580		605
581	=cut	606	=cut
582		607
583	sub move($$;$) {	608	sub move($$;$) {
584	my $img = pop->clone;	609	my $img = pop->clone;
585	$img->move ($_[0], $_[1]);	610	$img->move ($_[0], $_[1]);
586	$img	611	$img
587	}	612	}
588		613
		614	sub align($;$$) {
		615	my $img = pop;
		616
		617	move $_[0] * (TW - $img->w),
		618	$_[1] * (TH - $img->h),
		619	$img
		620	}
		621
589	sub center($;$$) {	622	sub center($;$$) {
590	my $img = pop;	623	my $img = pop;
591	my $w = $_[0] \|\| TW;	624	my $w = $_[0] \|\| TW;
592	my $h = $_[0] \|\| TH;	625	my $h = $_[1] \|\| TH;
593		626
594	move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img	627	move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img
595	}	628	}
596		629
597	sub rootalign($) {	630	sub rootalign($) {
598	move -TX, -TY, $_[0]	631	move -TX, -TY, $_[0]
599	}	632	}
600		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
		646	sub rotate($$$$) {
		647	my $img = pop;
		648	$img->rotate (
		649	$_[0] * $img->w,
		650	$_[1] * $img->h,
		651	$_[2] * (3.14159265 / 180),
		652	)
		653	}
		654
		655	=back
		656
		657	=head2 COLOUR MODIFICATIONS
		658
		659	The following operators change the pixels of the image.
		660
		661	=over 4
		662
601	=item contrast $factor, $img	663	=item contrast $factor, $img
602		664
603	=item contrast $r, $g, $b, $img	665	=item contrast $r, $g, $b, $img
604		666
605	=item contrast $r, $g, $b, $a, $img	667	=item contrast $r, $g, $b, $a, $img
606		668
607	Adjusts the I<contrast> of an image.	669	Adjusts the I<contrast> of an image.
608		670
609	#TODO#	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.
610		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
611	=item brightness $factor, $img	682	=item brightness $bias, $img
612		683
613	=item brightness $r, $g, $b, $img	684	=item brightness $r, $g, $b, $img
614		685
615	=item brightness $r, $g, $b, $a, $img	686	=item brightness $r, $g, $b, $a, $img
616		687
617	Adjusts the brightness of an image.	688	Adjusts the brightness of an image.
618		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
619	=cut	701	=cut
620		702
621	sub contrast($$;$$;$) {	703	sub contrast($$;$$;$) {
622	my $img = pop;	704	my $img = pop;
623	my ($r, $g, $b, $a) = @_;	705	my ($r, $g, $b, $a) = @_;
624		706
625	($g, $b) = ($r, $r) if @_ < 4;	707	($g, $b) = ($r, $r) if @_ < 3;
626	$a = 1 if @_ < 5;	708	$a = 1 if @_ < 4;
627		709
628	$img = $img->clone;	710	$img = $img->clone;
629	$img->contrast ($r, $g, $b, $a);	711	$img->contrast ($r, $g, $b, $a);
630	$img	712	$img
631	}	713	}
632		714
633	sub brightness($$;$$;$) {	715	sub brightness($$;$$;$) {
634	my $img = pop;	716	my $img = pop;
635	my ($r, $g, $b, $a) = @_;	717	my ($r, $g, $b, $a) = @_;
636		718
637	($g, $b) = ($r, $r) if @_ < 4;	719	($g, $b) = ($r, $r) if @_ < 3;
638	$a = 1 if @_ < 5;	720	$a = 1 if @_ < 4;
639		721
640	$img = $img->clone;	722	$img = $img->clone;
641	$img->brightness ($r, $g, $b, $a);	723	$img->brightness ($r, $g, $b, $a);
642	$img	724	$img
643	}	725	}
…		…
659	sub blur($$;$) {	741	sub blur($$;$) {
660	my $img = pop;	742	my $img = pop;
661	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	743	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
662	}	744	}
663		745
664	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees	746	=back
665		747
666	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	748	=head2 OTHER STUFF
667	pointer at C<$center_x> and C<$center_y> (specified as factor of image
668	width/height), generating a new image with width C<$new_width> and height
669	C<$new_height>.
670		749
671	#TODO# new width, height, maybe more operators?	750	Anything that didn't fit any of the other categories, even after appliyng
		751	force and closing our eyes.
672		752
673	Example: rotate the image by 90 degrees	753	=over 4
674		754
675	=cut	755	=item once { ... }
676		756
677	sub rotate($$$$$$) {	757	This function takes a code block as argument, that is, one or more
678	my $img = pop;	758	statements enclosed by braces.
679	$img->rotate (	759
680	$_[0],	760	The trick is that this code block is only evaluated once - future calls
681	$_[1],	761	will simply return the original image (yes, it should only be used with
682	$_[2] * $img->w,	762	images).
683	$_[3] * $img->h,	763
684	$_[4] * (3.14159265 / 180),	764	This can be extremely useful to avoid redoign the same slow operations
685	)	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.
		768
		769	Putting the blur into a C<once> block will make sure the blur is only done
		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 = ();
686	}	792	}
687		793
688	=back	794	=back
689		795
690	=cut	796	=cut
…		…
733		839
734	# evaluate user expression	840	# evaluate user expression
735		841
736	my $img = eval { $self->{expr}->() };	842	my $img = eval { $self->{expr}->() };
737	warn $@ if $@;#d#	843	warn $@ if $@;#d#
738	die if !UNIVERSAL::isa $img, "urxvt::img";	844	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
739		845
740	$state->{size_sensitive} = 1	846	$state->{size_sensitive} = 1
741	if $img->repeat_mode != urxvt::RepeatNormal;	847	if $img->repeat_mode != urxvt::RepeatNormal;
742		848
743	# if the expression is sensitive to external events, prepare reevaluation then	849	# if the expression is sensitive to external events, prepare reevaluation then
…		…
793	}	899	}
794		900
795	sub on_start {	901	sub on_start {
796	my ($self) = @_;	902	my ($self) = @_;
797		903
798	my $expr = $self->x_resource ("background.expr")	904	my $expr = $self->x_resource ("%.expr")
799	or return;	905	or return;
800		906
		907	$self->has_render
		908	or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
		909
801	$self->set_expr (parse_expr $expr);	910	$self->set_expr (parse_expr $expr);
802	$self->{border} = $self->x_resource_boolean ("background.border");	911	$self->{border} = $self->x_resource_boolean ("%.border");
		912
		913	$MIN_INTERVAL = $self->x_resource ("%.interval");
803		914
804	()	915	()
805	}	916	}
806		917

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.44 by root, Sun Jun 10 11:31:22 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.44 by root, Sun Jun 10 11:31:22 2012 UTC vs.
Revision 1.53 by root, Tue Jun 12 18:25:57 2012 UTC