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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.48 by root, Sun Jun 10 15:01:14 2012 UTC vs.
Revision 1.61 by root, Fri Jun 15 19:50:56 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	#:META:X_RESOURCE:%.interval:seconds:minimum time between updates
6
7	#TODO: once, rootalign
8		6
9	=head1 NAME	7	=head1 NAME
10		8
11	background - manage terminal background	9	background - manage terminal background
12		10
59		57
60	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
61	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
62	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
63	example. That ensures that the picture always fills the terminal, even	61	example. That ensures that the picture always fills the terminal, even
64	after it's size changes.	62	after its size changes.
65		63
66	=head2 EXPRESSIONS	64	=head2 EXPRESSIONS
67		65
68	Expressions are normal Perl expressions, in fact, they are Perl blocks -	66	Expressions are normal Perl expressions, in fact, they are Perl blocks -
69	which means you could use multiple lines and statements:	67	which means you could use multiple lines and statements:
…		…
73	return scale load "$HOME/weekday.png";	71	return scale load "$HOME/weekday.png";
74	} else {	72	} else {
75	return scale load "$HOME/sunday.png";	73	return scale load "$HOME/sunday.png";
76	}	74	}
77		75
78	This expression gets evaluated once per hour. It will set F<sunday.png> as	76	This expression is evaluated once per hour. It will set F<sunday.png> as
79	background on Sundays, and F<weekday.png> on all other days.	77	background on Sundays, and F<weekday.png> on all other days.
80		78
81	Fortunately, we expect that most expressions will be much simpler, with	79	Fortunately, we expect that most expressions will be much simpler, with
82	little Perl knowledge needed.	80	little Perl knowledge needed.
83		81
…		…
117	horizontal and vertical dimensions. For example, this halves the image	115	horizontal and vertical dimensions. For example, this halves the image
118	width and doubles the image height:	116	width and doubles the image height:
119		117
120	scale 0.5, 2, load "$HOME/mypic.png"	118	scale 0.5, 2, load "$HOME/mypic.png"
121		119
122	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
123	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:
124		122
125	tile load "$HOME/mypic.png"	123	tile load "$HOME/mypic.png"
126		124
127	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
…		…
153	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
154	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
155	image, it will forget about the first one.	153	image, it will forget about the first one.
156		154
157	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
158	memory, or comserve memory by loading images more often.	156	memory, or conserve memory by loading images more often.
159		157
160	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
161	this:	159	this:
162		160
163	my $img1 = load "img1.png";	161	my $img1 = load "img1.png";
…		…
193	Specifying this flag changes the behaviour, so that the image only	191	Specifying this flag changes the behaviour, so that the image only
194	replaces the background of the character area.	192	replaces the background of the character area.
195		193
196	=item --background-interval seconds	194	=item --background-interval seconds
197		195
198	Since some operations in the underlying XRender extension can effetively	196	Since some operations in the underlying XRender extension can effectively
199	freeze your X-server for prolonged time, this extension enforces a minimum	197	freeze your X-server for prolonged time, this extension enforces a minimum
200	time between updates, which is normally about 0.1 seconds.	198	time between updates, which is normally about 0.1 seconds.
201		199
202	If you want to do updates more often, you can decrease this safety	200	If you want to do updates more often, you can decrease this safety
203	interval with this switch.	201	interval with this switch.
204		202
205	=back	203	=back
206		204
207	=cut	205	=cut
208		206
		207	our %_IMG_CACHE;
209	our $HOME;	208	our $HOME;
210	our ($self, $old, $new);	209	our ($self, $old, $new);
211	our ($x, $y, $w, $h);	210	our ($x, $y, $w, $h);
212		211
213	# enforce at least this interval between updates	212	# enforce at least this interval between updates
…		…
229	=item load $path	228	=item load $path
230		229
231	Loads the image at the given C<$path>. The image is set to plane tiling	230	Loads the image at the given C<$path>. The image is set to plane tiling
232	mode.	231	mode.
233		232
234	Loaded images will be cached for one cycle.	233	Loaded images will be cached for one cycle, and shared between temrinals
		234	running in the same process (e.g. in C<urxvtd>).
235		235
		236	=item load_uc $path
		237
		238	Load uncached - same as load, but does not cache the image. This function
		239	is most useufl if you want to optimise a background expression in some
		240	way.
		241
236	=cut	242	=cut
		243
		244	sub load_uc($) {
		245	my ($path) = @_;
		246
		247	$_IMG_CACHE{$path} \|\| do {
		248	my $img = $self->new_img_from_file ($path);
		249	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
		250	$img
		251	}
		252	}
237		253
238	sub load($) {	254	sub load($) {
239	my ($path) = @_;	255	my ($path) = @_;
240		256
241	$new->{load}{$path} = $old->{load}{$path} \|\| $self->new_img_from_file ($path);	257	$new->{load}{$path} = $old->{load}{$path} \|\| load_uc $path;
242	}	258	}
243		259
244	=item root	260	=item root
245		261
246	Returns the root window pixmap, that is, hopefully, the background image	262	Returns the root window pixmap, that is, hopefully, the background image
…		…
250	reevaluated when the bg image changes.	266	reevaluated when the bg image changes.
251		267
252	=cut	268	=cut
253		269
254	sub root() {	270	sub root() {
255	$new->{rootpmap_sensitive} = 1;	271	$new->{again}{rootpmap} = 1;
256	die "root op not supported, exg, we need you";	272	$self->new_img_from_root
257	}	273	}
258		274
259	=item solid $colour	275	=item solid $colour
260		276
261	=item solid $width, $height, $colour	277	=item solid $width, $height, $colour
…		…
269	=cut	285	=cut
270		286
271	sub solid($;$$) {	287	sub solid($;$$) {
272	my $colour = pop;	288	my $colour = pop;
273		289
274	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);	290	my $img = $self->new_img (urxvt::PictStandardARGB32, 0, 0, $_[0] \|\| 1, $_[1] \|\| 1);
275	$img->fill ($colour);	291	$img->fill ($colour);
276	$img	292	$img
277	}	293	}
278		294
279	=item clone $img	295	=item clone $img
…		…
285		301
286	sub clone($) {	302	sub clone($) {
287	$_[0]->clone	303	$_[0]->clone
288	}	304	}
289		305
290	=back	306	=item merge $img ...
		307
		308	Takes any number of images and merges them together, creating a single
		309	image containing them all.
		310
		311	This function is called automatically when an expression returns multiple
		312	images.
		313
		314	=cut
		315
		316	sub merge(@) {
		317	return $_[0] unless $#_;
		318
		319	# rather annoyingly clumsy, but optimisation is for another time
		320
		321	my $x0 = +1e9;
		322	my $y0 = +1e9;
		323	my $x1 = -1e9;
		324	my $y1 = -1e9;
		325
		326	for (@_) {
		327	my ($x, $y, $w, $h) = $_->geometry;
		328
		329	$x0 = $x if $x0 > $x;
		330	$y0 = $y if $y0 > $y;
		331
		332	$x += $w;
		333	$y += $h;
		334
		335	$x1 = $x if $x1 < $x;
		336	$y1 = $y if $y1 < $y;
		337	}
		338
		339	my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
		340	$base->fill ([0, 0, 0, 0]);
		341
		342	$base->draw ($_)
		343	for @_;
		344
		345	$base
		346	}
291		347
292	=head2 TILING MODES	348	=head2 TILING MODES
293		349
294	The following operators modify the tiling mode of an image, that is, the	350	The following operators modify the tiling mode of an image, that is, the
295	way that pixels outside the image area are painted when the image is used.	351	way that pixels outside the image area are painted when the image is used.
…		…
325	become transparent. This mode is most useful when you want to place an	381	become transparent. This mode is most useful when you want to place an
326	image over another image or the background colour while leaving all	382	image over another image or the background colour while leaving all
327	background pixels outside the image unchanged.	383	background pixels outside the image unchanged.
328		384
329	Example: load an image and display it in the upper left corner. The rest	385	Example: load an image and display it in the upper left corner. The rest
330	of the space is left "empty" (transparent or wahtever your compisotr does	386	of the space is left "empty" (transparent or whatever your compositor does
331	in alpha mode, else background colour).	387	in alpha mode, else background colour).
332		388
333	pad load "mybg.png"	389	pad load "mybg.png"
334		390
335	=item extend $img	391	=item extend $img
336		392
337	Extends the image over the whole plane, using the closest pixel in the	393	Extends the image over the whole plane, using the closest pixel in the
338	area outside the image. This mode is mostly useful when you more complex	394	area outside the image. This mode is mostly useful when you use more complex
339	filtering operations and want the pixels outside the image to have the	395	filtering operations and want the pixels outside the image to have the
340	same values as the pixels near the edge.	396	same values as the pixels near the edge.
341		397
342	Example: just for curiosity, how does this pixel extension stuff work?	398	Example: just for curiosity, how does this pixel extension stuff work?
343		399
…		…
410	the window size to conserve memory.	466	the window size to conserve memory.
411		467
412	Example: take the screen background, clip it to the window size, blur it a	468	Example: take the screen background, clip it to the window size, blur it a
413	bit, align it to the window position and use it as background.	469	bit, align it to the window position and use it as background.
414		470
415	clip move -TX, -TY, blur 5, root	471	clip move -TX, -TY, once { blur 5, root }
416		472
417	=cut	473	=cut
418		474
419	sub TX() { $new->{position_sensitive} = 1; $x }	475	sub TX() { $new->{again}{position} = 1; $x }
420	sub TY() { $new->{position_sensitive} = 1; $y }	476	sub TY() { $new->{again}{position} = 1; $y }
421	sub TW() { $new->{size_sensitive} = 1; $w }	477	sub TW() { $new->{again}{size} = 1; $w }
422	sub TH() { $new->{size_sensitive} = 1; $h }	478	sub TH() { $new->{again}{size} = 1; $h }
423		479
424	=item now	480	=item now
425		481
426	Returns the current time as (fractional) seconds since the epoch.	482	Returns the current time as (fractional) seconds since the epoch.
427		483
…		…
434	C<$seconds> seconds.	490	C<$seconds> seconds.
435		491
436	Example: load some image and rotate it according to the time of day (as if it were	492	Example: load some image and rotate it according to the time of day (as if it were
437	the hour pointer of a clock). Update this image every minute.	493	the hour pointer of a clock). Update this image every minute.
438		494
439	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"	495	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
440		496
441	=item counter $seconds	497	=item counter $seconds
442		498
443	Like C<again>, but also returns an increasing counter value, starting at	499	Like C<again>, but also returns an increasing counter value, starting at
444	0, which might be useful for some simple animation effects.	500	0, which might be useful for some simple animation effects.
…		…
446	=cut	502	=cut
447		503
448	sub now() { urxvt::NOW }	504	sub now() { urxvt::NOW }
449		505
450	sub again($) {	506	sub again($) {
451	$new->{again} = $_[0];	507	$new->{again}{time} = $_[0];
452	}	508	}
453		509
454	sub counter($) {	510	sub counter($) {
455	$new->{again} = $_[0];	511	$new->{again}{time} = $_[0];
456	$self->{counter} + 0	512	$self->{counter} + 0
457	}	513	}
458		514
459	=back	515	=back
460		516
…		…
631		687
632	sub rootalign($) {	688	sub rootalign($) {
633	move -TX, -TY, $_[0]	689	move -TX, -TY, $_[0]
634	}	690	}
635		691
		692	=item rotate $center_x, $center_y, $degrees
		693
		694	Rotates the image by C<$degrees> degrees, counter-clockwise, around the
		695	pointer at C<$center_x> and C<$center_y> (specified as factor of image
		696	width/height).
		697
		698	#TODO# new width, height, maybe more operators?
		699
		700	Example: rotate the image by 90 degrees
		701
		702	=cut
		703
		704	sub rotate($$$$) {
		705	my $img = pop;
		706	$img->rotate (
		707	$_[0] * ($img->w + $img->x),
		708	$_[1] * ($img->h + $img->y),
		709	$_[2] * (3.14159265 / 180),
		710	)
		711	}
		712
636	=back	713	=back
637		714
638	=head2 COLOUR MODIFICATIONS	715	=head2 COLOUR MODIFICATIONS
639		716
640	The following operators change the pixels of the image.	717	The following operators change the pixels of the image.
…		…
674		751
675	Values less than 0 reduce brightness, while values larger than 0 increase	752	Values less than 0 reduce brightness, while values larger than 0 increase
676	it. Useful range is from -1 to 1 - the former results in a black, the	753	it. Useful range is from -1 to 1 - the former results in a black, the
677	latter in a white picture.	754	latter in a white picture.
678		755
679	Due to idiosynchrasies in the underlying XRender extension, biases less	756	Due to idiosyncrasies in the underlying XRender extension, biases less
680	than zero can be I<very> slow.	757	than zero can be I<very> slow.
681		758
682	=cut	759	=cut
683		760
684	sub contrast($$;$$;$) {	761	sub contrast($$;$$;$) {
685	my $img = pop;	762	my $img = pop;
686	my ($r, $g, $b, $a) = @_;	763	my ($r, $g, $b, $a) = @_;
687		764
688	($g, $b) = ($r, $r) if @_ < 4;	765	($g, $b) = ($r, $r) if @_ < 3;
689	$a = 1 if @_ < 5;	766	$a = 1 if @_ < 4;
690		767
691	$img = $img->clone;	768	$img = $img->clone;
692	$img->contrast ($r, $g, $b, $a);	769	$img->contrast ($r, $g, $b, $a);
693	$img	770	$img
694	}	771	}
695		772
696	sub brightness($$;$$;$) {	773	sub brightness($$;$$;$) {
697	my $img = pop;	774	my $img = pop;
698	my ($r, $g, $b, $a) = @_;	775	my ($r, $g, $b, $a) = @_;
699		776
700	($g, $b) = ($r, $r) if @_ < 4;	777	($g, $b) = ($r, $r) if @_ < 3;
701	$a = 1 if @_ < 5;	778	$a = 1 if @_ < 4;
702		779
703	$img = $img->clone;	780	$img = $img->clone;
704	$img->brightness ($r, $g, $b, $a);	781	$img->brightness ($r, $g, $b, $a);
705	$img	782	$img
706	}	783	}
…		…
722	sub blur($$;$) {	799	sub blur($$;$) {
723	my $img = pop;	800	my $img = pop;
724	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	801	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
725	}	802	}
726		803
727	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees	804	=back
728		805
729	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	806	=head2 OTHER STUFF
730	pointer at C<$center_x> and C<$center_y> (specified as factor of image
731	width/height), generating a new image with width C<$new_width> and height
732	C<$new_height>.
733		807
734	#TODO# new width, height, maybe more operators?	808	Anything that didn't fit any of the other categories, even after applying
		809	force and closing our eyes.
735		810
736	Example: rotate the image by 90 degrees	811	=over 4
737		812
738	=cut	813	=item once { ... }
739		814
740	sub rotate($$$$$$) {	815	This function takes a code block as argument, that is, one or more
741	my $img = pop;	816	statements enclosed by braces.
742	$img->rotate (	817
743	$_[0],	818	The trick is that this code block is only evaluated once - future calls
744	$_[1],	819	will simply return the original image (yes, it should only be used with
745	$_[2] * $img->w,	820	images).
746	$_[3] * $img->h,	821
747	$_[4] * (3.14159265 / 180),	822	This can be extremely useful to avoid redoign the same slow operations
		823	again and again- for example, if your background expression takes the root
		824	background, blurs it and then root-aligns it it would have to blur the
		825	root background on every window move or resize.
		826
		827	Putting the blur into a C<once> block will make sure the blur is only done
		828	once:
		829
		830	rootlign once { blur 10, root }
		831
		832	This leaves the question of how to force reevaluation of the block, in
		833	case the root background changes: Right now, all once blocks forget that
		834	they ahve been executed before each time the root background changes (if
		835	the expression is sensitive to that) or when C<once_again> is called.
		836
		837	=item once_again
		838
		839	Resets all C<once> block as if they had never been called, i.e. on the
		840	next call they will be reevaluated again.
		841
		842	=cut
		843
		844	sub once(&) {
		845	my $once = $self->{once_cache}{$_[0]+0} \|\|= do {
		846	local $new->{again};
		847	my @res = $_[0]();
		848	[$new->{again}, \@res]
748	)	849	};
		850
		851	$new->{again} = {
		852	%{ $new->{again} },
		853	%{ $once->[0] }
		854	};
		855
		856	# in scalar context we always return the first original result, which
		857	# is not quite how perl works.
		858	wantarray
		859	? @{ $once->[1] }
		860	: $once->[1][0]
		861	}
		862
		863	sub once_again() {
		864	delete $self->{once_cache};
749	}	865	}
750		866
751	=back	867	=back
752		868
753	=cut	869	=cut
…		…
794	($x, $y, $w, $h) =	910	($x, $y, $w, $h) =
795	$self->background_geometry ($self->{border});	911	$self->background_geometry ($self->{border});
796		912
797	# evaluate user expression	913	# evaluate user expression
798		914
799	my $img = eval { $self->{expr}->() };	915	my $img = eval { urxvt::bgdsl::merge $self->{expr}->() };
800	warn $@ if $@;#d#	916	die $@ if $@;
801	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";	917	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
802		918
803	$state->{size_sensitive} = 1	919	# if the expression is sensitive to external events, prepare reevaluation then
		920
		921	my $again = delete $state->{again};
		922
		923	$again->{size} = 1
804	if $img->repeat_mode != urxvt::RepeatNormal;	924	if $img->repeat_mode != urxvt::RepeatNormal;
805		925
806	# if the expression is sensitive to external events, prepare reevaluation then
807
808	my $repeat;
809
810	if (my $again = $state->{again}) {	926	if (my $again = $again->{time}) {
811	$repeat = 1;
812	my $self = $self;	927	my $self = $self;
813	$state->{timer} = $again == $old->{again}	928	$state->{timer} = $again == $old->{again}
814	? $old->{timer}	929	? $old->{timer}
815	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	930	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
816	++$self->{counter};	931	++$self->{counter};
817	$self->recalculate	932	$self->recalculate
818	});	933	});
819	}	934	}
820		935
821	if (delete $state->{position_sensitive}) {	936	if ($again->{position}) {
822	$repeat = 1;
823	$self->enable (position_change => sub { $_[0]->recalculate });	937	$self->enable (position_change => sub { $_[0]->recalculate });
824	} else {	938	} else {
825	$self->disable ("position_change");	939	$self->disable ("position_change");
826	}	940	}
827		941
828	if (delete $state->{size_sensitive}) {	942	if ($again->{size}) {
829	$repeat = 1;
830	$self->enable (size_change => sub { $_[0]->recalculate });	943	$self->enable (size_change => sub { $_[0]->recalculate });
831	} else {	944	} else {
832	$self->disable ("size_change");	945	$self->disable ("size_change");
833	}	946	}
834		947
835	if (delete $state->{rootpmap_sensitive}) {	948	if ($again->{rootpmap}) {
836	$repeat = 1;
837	$self->enable (rootpmap_change => sub { $_[0]->recalculate });	949	$self->enable (rootpmap_change => sub {
		950	delete $_[0]{once_cache}; # this will override once-block values from
		951	$_[0]->recalculate;
		952	});
838	} else {	953	} else {
839	$self->disable ("rootpmap_change");	954	$self->disable ("rootpmap_change");
840	}	955	}
841		956
842	# clear stuff we no longer need	957	# clear stuff we no longer need
843		958
844	%$old = ();	959	%$old = ();
845		960
846	unless ($repeat) {	961	unless (%$again) {
847	delete $self->{state};	962	delete $self->{state};
848	delete $self->{expr};	963	delete $self->{expr};
849	}	964	}
850		965
851	# set background pixmap	966	# set background pixmap

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.48 by root, Sun Jun 10 15:01:14 2012 UTC vs. Revision 1.61 by root, Fri Jun 15 19:50:56 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.48 by root, Sun Jun 10 15:01:14 2012 UTC vs.
Revision 1.61 by root, Fri Jun 15 19:50:56 2012 UTC