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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.49 by root, Sun Jun 10 15:29:18 2012 UTC vs.
Revision 1.62 by root, Sun Jun 17 21:58:18 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
209	our %_IMGCACHE;	207	our %_IMG_CACHE;
210	our $HOME;	208	our $HOME;
211	our ($self, $old, $new);	209	our ($self, $old, $new);
212	our ($x, $y, $w, $h);	210	our ($x, $y, $w, $h);
213		211
214	# enforce at least this interval between updates	212	# enforce at least this interval between updates
…		…
230	=item load $path	228	=item load $path
231		229
232	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
233	mode.	231	mode.
234		232
235	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>).
236		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
237	=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	}
238		253
239	sub load($) {	254	sub load($) {
240	my ($path) = @_;	255	my ($path) = @_;
241		256
242	$new->{load}{$path} = $old->{load}{$path} \|\| $self->new_img_from_file ($path);	257	$new->{load}{$path} = $old->{load}{$path} \|\| load_uc $path;
243	}	258	}
244		259
245	=item root	260	=item root
246		261
247	Returns the root window pixmap, that is, hopefully, the background image	262	Returns the root window pixmap, that is, hopefully, the background image
248	of your screen. The image is set to extend mode.	263	of your screen.
249		264
250	This function makes your expression root sensitive, that means it will be	265	This function makes your expression root sensitive, that means it will be
251	reevaluated when the bg image changes.	266	reevaluated when the bg image changes.
252		267
253	=cut	268	=cut
254		269
255	sub root() {	270	sub root() {
256	$new->{rootpmap_sensitive} = 1;	271	$new->{again}{rootpmap} = 1;
257	die "root op not supported, exg, we need you";	272	$self->new_img_from_root
258	}	273	}
259		274
260	=item solid $colour	275	=item solid $colour
261		276
262	=item solid $width, $height, $colour	277	=item solid $width, $height, $colour
…		…
270	=cut	285	=cut
271		286
272	sub solid($;$$) {	287	sub solid($;$$) {
273	my $colour = pop;	288	my $colour = pop;
274		289
275	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);
276	$img->fill ($colour);	291	$img->fill ($colour);
277	$img	292	$img
278	}	293	}
279		294
280	=item clone $img	295	=item clone $img
…		…
286		301
287	sub clone($) {	302	sub clone($) {
288	$_[0]->clone	303	$_[0]->clone
289	}	304	}
290		305
291	=back	306	=item merge $img ...
		307
		308	Takes any number of images and merges them together, creating a single
		309	image containing them all. The tiling mode of the first image is used as
		310	the tiling mdoe of the resulting image.
		311
		312	This function is called automatically when an expression returns multiple
		313	images.
		314
		315	=cut
		316
		317	sub merge(@) {
		318	return $_[0] unless $#_;
		319
		320	# rather annoyingly clumsy, but optimisation is for another time
		321
		322	my $x0 = +1e9;
		323	my $y0 = +1e9;
		324	my $x1 = -1e9;
		325	my $y1 = -1e9;
		326
		327	for (@_) {
		328	my ($x, $y, $w, $h) = $_->geometry;
		329
		330	$x0 = $x if $x0 > $x;
		331	$y0 = $y if $y0 > $y;
		332
		333	$x += $w;
		334	$y += $h;
		335
		336	$x1 = $x if $x1 < $x;
		337	$y1 = $y if $y1 < $y;
		338	}
		339
		340	my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
		341	$base->repeat_mode ($_[0]->repeat_mode);
		342	$base->fill ([0, 0, 0, 0]);
		343
		344	$base->draw ($_)
		345	for @_;
		346
		347	$base
		348	}
292		349
293	=head2 TILING MODES	350	=head2 TILING MODES
294		351
295	The following operators modify the tiling mode of an image, that is, the	352	The following operators modify the tiling mode of an image, that is, the
296	way that pixels outside the image area are painted when the image is used.	353	way that pixels outside the image area are painted when the image is used.
…		…
326	become transparent. This mode is most useful when you want to place an	383	become transparent. This mode is most useful when you want to place an
327	image over another image or the background colour while leaving all	384	image over another image or the background colour while leaving all
328	background pixels outside the image unchanged.	385	background pixels outside the image unchanged.
329		386
330	Example: load an image and display it in the upper left corner. The rest	387	Example: load an image and display it in the upper left corner. The rest
331	of the space is left "empty" (transparent or wahtever your compisotr does	388	of the space is left "empty" (transparent or whatever your compositor does
332	in alpha mode, else background colour).	389	in alpha mode, else background colour).
333		390
334	pad load "mybg.png"	391	pad load "mybg.png"
335		392
336	=item extend $img	393	=item extend $img
337		394
338	Extends the image over the whole plane, using the closest pixel in the	395	Extends the image over the whole plane, using the closest pixel in the
339	area outside the image. This mode is mostly useful when you more complex	396	area outside the image. This mode is mostly useful when you use more complex
340	filtering operations and want the pixels outside the image to have the	397	filtering operations and want the pixels outside the image to have the
341	same values as the pixels near the edge.	398	same values as the pixels near the edge.
342		399
343	Example: just for curiosity, how does this pixel extension stuff work?	400	Example: just for curiosity, how does this pixel extension stuff work?
344		401
…		…
411	the window size to conserve memory.	468	the window size to conserve memory.
412		469
413	Example: take the screen background, clip it to the window size, blur it a	470	Example: take the screen background, clip it to the window size, blur it a
414	bit, align it to the window position and use it as background.	471	bit, align it to the window position and use it as background.
415		472
416	clip move -TX, -TY, blur 5, root	473	clip move -TX, -TY, once { blur 5, root }
417		474
418	=cut	475	=cut
419		476
420	sub TX() { $new->{position_sensitive} = 1; $x }	477	sub TX() { $new->{again}{position} = 1; $x }
421	sub TY() { $new->{position_sensitive} = 1; $y }	478	sub TY() { $new->{again}{position} = 1; $y }
422	sub TW() { $new->{size_sensitive} = 1; $w }	479	sub TW() { $new->{again}{size} = 1; $w }
423	sub TH() { $new->{size_sensitive} = 1; $h }	480	sub TH() { $new->{again}{size} = 1; $h }
424		481
425	=item now	482	=item now
426		483
427	Returns the current time as (fractional) seconds since the epoch.	484	Returns the current time as (fractional) seconds since the epoch.
428		485
…		…
435	C<$seconds> seconds.	492	C<$seconds> seconds.
436		493
437	Example: load some image and rotate it according to the time of day (as if it were	494	Example: load some image and rotate it according to the time of day (as if it were
438	the hour pointer of a clock). Update this image every minute.	495	the hour pointer of a clock). Update this image every minute.
439		496
440	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"	497	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
441		498
442	=item counter $seconds	499	=item counter $seconds
443		500
444	Like C<again>, but also returns an increasing counter value, starting at	501	Like C<again>, but also returns an increasing counter value, starting at
445	0, which might be useful for some simple animation effects.	502	0, which might be useful for some simple animation effects.
…		…
447	=cut	504	=cut
448		505
449	sub now() { urxvt::NOW }	506	sub now() { urxvt::NOW }
450		507
451	sub again($) {	508	sub again($) {
452	$new->{again} = $_[0];	509	$new->{again}{time} = $_[0];
453	}	510	}
454		511
455	sub counter($) {	512	sub counter($) {
456	$new->{again} = $_[0];	513	$new->{again}{time} = $_[0];
457	$self->{counter} + 0	514	$self->{counter} + 0
458	}	515	}
459		516
460	=back	517	=back
461		518
…		…
632		689
633	sub rootalign($) {	690	sub rootalign($) {
634	move -TX, -TY, $_[0]	691	move -TX, -TY, $_[0]
635	}	692	}
636		693
		694	=item rotate $center_x, $center_y, $degrees
		695
		696	Rotates the image by C<$degrees> degrees, counter-clockwise, around the
		697	pointer at C<$center_x> and C<$center_y> (specified as factor of image
		698	width/height).
		699
		700	#TODO# new width, height, maybe more operators?
		701
		702	Example: rotate the image by 90 degrees
		703
		704	=cut
		705
		706	sub rotate($$$$) {
		707	my $img = pop;
		708	$img->rotate (
		709	$_[0] * ($img->w + $img->x),
		710	$_[1] * ($img->h + $img->y),
		711	$_[2] * (3.14159265 / 180),
		712	)
		713	}
		714
637	=back	715	=back
638		716
639	=head2 COLOUR MODIFICATIONS	717	=head2 COLOUR MODIFICATIONS
640		718
641	The following operators change the pixels of the image.	719	The following operators change the pixels of the image.
…		…
675		753
676	Values less than 0 reduce brightness, while values larger than 0 increase	754	Values less than 0 reduce brightness, while values larger than 0 increase
677	it. Useful range is from -1 to 1 - the former results in a black, the	755	it. Useful range is from -1 to 1 - the former results in a black, the
678	latter in a white picture.	756	latter in a white picture.
679		757
680	Due to idiosynchrasies in the underlying XRender extension, biases less	758	Due to idiosyncrasies in the underlying XRender extension, biases less
681	than zero can be I<very> slow.	759	than zero can be I<very> slow.
682		760
683	=cut	761	=cut
684		762
685	sub contrast($$;$$;$) {	763	sub contrast($$;$$;$) {
…		…
723	sub blur($$;$) {	801	sub blur($$;$) {
724	my $img = pop;	802	my $img = pop;
725	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	803	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
726	}	804	}
727		805
728	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees	806	=back
729		807
730	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	808	=head2 OTHER STUFF
731	pointer at C<$center_x> and C<$center_y> (specified as factor of image
732	width/height), generating a new image with width C<$new_width> and height
733	C<$new_height>.
734		809
735	#TODO# new width, height, maybe more operators?	810	Anything that didn't fit any of the other categories, even after applying
		811	force and closing our eyes.
736		812
737	Example: rotate the image by 90 degrees	813	=over 4
738		814
739	=cut	815	=item once { ... }
740		816
741	sub rotate($$$$$$) {	817	This function takes a code block as argument, that is, one or more
742	my $img = pop;	818	statements enclosed by braces.
743	$img->rotate (	819
744	$_[0],	820	The trick is that this code block is only evaluated once - future calls
745	$_[1],	821	will simply return the original image (yes, it should only be used with
746	$_[2] * $img->w,	822	images).
747	$_[3] * $img->h,	823
748	$_[4] * (3.14159265 / 180),	824	This can be extremely useful to avoid redoign the same slow operations
		825	again and again- for example, if your background expression takes the root
		826	background, blurs it and then root-aligns it it would have to blur the
		827	root background on every window move or resize.
		828
		829	Putting the blur into a C<once> block will make sure the blur is only done
		830	once:
		831
		832	rootlign once { blur 10, root }
		833
		834	This leaves the question of how to force reevaluation of the block, in
		835	case the root background changes: Right now, all once blocks forget that
		836	they ahve been executed before each time the root background changes (if
		837	the expression is sensitive to that) or when C<once_again> is called.
		838
		839	=item once_again
		840
		841	Resets all C<once> block as if they had never been called, i.e. on the
		842	next call they will be reevaluated again.
		843
		844	=cut
		845
		846	sub once(&) {
		847	my $once = $self->{once_cache}{$_[0]+0} \|\|= do {
		848	local $new->{again};
		849	my @res = $_[0]();
		850	[$new->{again}, \@res]
749	)	851	};
		852
		853	$new->{again} = {
		854	%{ $new->{again} },
		855	%{ $once->[0] }
		856	};
		857
		858	# in scalar context we always return the first original result, which
		859	# is not quite how perl works.
		860	wantarray
		861	? @{ $once->[1] }
		862	: $once->[1][0]
		863	}
		864
		865	sub once_again() {
		866	delete $self->{once_cache};
750	}	867	}
751		868
752	=back	869	=back
753		870
754	=cut	871	=cut
…		…
795	($x, $y, $w, $h) =	912	($x, $y, $w, $h) =
796	$self->background_geometry ($self->{border});	913	$self->background_geometry ($self->{border});
797		914
798	# evaluate user expression	915	# evaluate user expression
799		916
800	my $img = eval { $self->{expr}->() };	917	my $img = eval { urxvt::bgdsl::merge $self->{expr}->() };
801	warn $@ if $@;#d#	918	die $@ if $@;
802	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";	919	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
803		920
804	$state->{size_sensitive} = 1	921	# if the expression is sensitive to external events, prepare reevaluation then
		922
		923	my $again = delete $state->{again};
		924
		925	$again->{size} = 1
805	if $img->repeat_mode != urxvt::RepeatNormal;	926	if $img->repeat_mode != urxvt::RepeatNormal;
806		927
807	# if the expression is sensitive to external events, prepare reevaluation then
808
809	my $repeat;
810
811	if (my $again = $state->{again}) {	928	if (my $again = $again->{time}) {
812	$repeat = 1;
813	my $self = $self;	929	my $self = $self;
814	$state->{timer} = $again == $old->{again}	930	$state->{timer} = $again == $old->{again}
815	? $old->{timer}	931	? $old->{timer}
816	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	932	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
817	++$self->{counter};	933	++$self->{counter};
818	$self->recalculate	934	$self->recalculate
819	});	935	});
820	}	936	}
821		937
822	if (delete $state->{position_sensitive}) {	938	if ($again->{position}) {
823	$repeat = 1;
824	$self->enable (position_change => sub { $_[0]->recalculate });	939	$self->enable (position_change => sub { $_[0]->recalculate });
825	} else {	940	} else {
826	$self->disable ("position_change");	941	$self->disable ("position_change");
827	}	942	}
828		943
829	if (delete $state->{size_sensitive}) {	944	if ($again->{size}) {
830	$repeat = 1;
831	$self->enable (size_change => sub { $_[0]->recalculate });	945	$self->enable (size_change => sub { $_[0]->recalculate });
832	} else {	946	} else {
833	$self->disable ("size_change");	947	$self->disable ("size_change");
834	}	948	}
835		949
836	if (delete $state->{rootpmap_sensitive}) {	950	if ($again->{rootpmap}) {
837	$repeat = 1;
838	$self->enable (rootpmap_change => sub { $_[0]->recalculate });	951	$self->enable (rootpmap_change => sub {
		952	delete $_[0]{once_cache}; # this will override once-block values from
		953	$_[0]->recalculate;
		954	});
839	} else {	955	} else {
840	$self->disable ("rootpmap_change");	956	$self->disable ("rootpmap_change");
841	}	957	}
842		958
843	# clear stuff we no longer need	959	# clear stuff we no longer need
844		960
845	%$old = ();	961	%$old = ();
846		962
847	unless ($repeat) {	963	unless (%$again) {
848	delete $self->{state};	964	delete $self->{state};
849	delete $self->{expr};	965	delete $self->{expr};
850	}	966	}
851		967
852	# set background pixmap	968	# set background pixmap

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.49 by root, Sun Jun 10 15:29:18 2012 UTC vs. Revision 1.62 by root, Sun Jun 17 21:58:18 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.49 by root, Sun Jun 10 15:29:18 2012 UTC vs.
Revision 1.62 by root, Sun Jun 17 21:58:18 2012 UTC