[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.59 by root, Thu Jun 14 19:31:17 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
…		…
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.
		310
		311	=cut
		312
		313	sub merge(@) {
		314	# rather annoyingly clumsy, but optimisation is for another time
		315
		316	my $x0 = +1e9;
		317	my $y0 = +1e9;
		318	my $x1 = -1e9;
		319	my $y1 = -1e9;
		320
		321	for (@_) {
		322	my ($x, $y, $w, $h) = $_->geometry;
		323
		324	$x0 = $x if $x0 > $x;
		325	$y0 = $y if $y0 > $y;
		326
		327	$x += $w;
		328	$y += $h;
		329
		330	$x1 = $x if $x1 < $x;
		331	$y1 = $y if $y1 < $y;
		332	}
		333
		334	my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
		335	$base->fill ([0, 0, 0, 0]);
		336
		337	$base->draw ($_)
		338	for @_;
		339
		340	$base
		341	}
292		342
293	=head2 TILING MODES	343	=head2 TILING MODES
294		344
295	The following operators modify the tiling mode of an image, that is, the	345	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.	346	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	376	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	377	image over another image or the background colour while leaving all
328	background pixels outside the image unchanged.	378	background pixels outside the image unchanged.
329		379
330	Example: load an image and display it in the upper left corner. The rest	380	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	381	of the space is left "empty" (transparent or whatever your compositor does
332	in alpha mode, else background colour).	382	in alpha mode, else background colour).
333		383
334	pad load "mybg.png"	384	pad load "mybg.png"
335		385
336	=item extend $img	386	=item extend $img
337		387
338	Extends the image over the whole plane, using the closest pixel in the	388	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	389	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	390	filtering operations and want the pixels outside the image to have the
341	same values as the pixels near the edge.	391	same values as the pixels near the edge.
342		392
343	Example: just for curiosity, how does this pixel extension stuff work?	393	Example: just for curiosity, how does this pixel extension stuff work?
344		394
…		…
411	the window size to conserve memory.	461	the window size to conserve memory.
412		462
413	Example: take the screen background, clip it to the window size, blur it a	463	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.	464	bit, align it to the window position and use it as background.
415		465
416	clip move -TX, -TY, blur 5, root	466	clip move -TX, -TY, once { blur 5, root }
417		467
418	=cut	468	=cut
419		469
420	sub TX() { $new->{position_sensitive} = 1; $x }	470	sub TX() { $new->{again}{position} = 1; $x }
421	sub TY() { $new->{position_sensitive} = 1; $y }	471	sub TY() { $new->{again}{position} = 1; $y }
422	sub TW() { $new->{size_sensitive} = 1; $w }	472	sub TW() { $new->{again}{size} = 1; $w }
423	sub TH() { $new->{size_sensitive} = 1; $h }	473	sub TH() { $new->{again}{size} = 1; $h }
424		474
425	=item now	475	=item now
426		476
427	Returns the current time as (fractional) seconds since the epoch.	477	Returns the current time as (fractional) seconds since the epoch.
428		478
…		…
435	C<$seconds> seconds.	485	C<$seconds> seconds.
436		486
437	Example: load some image and rotate it according to the time of day (as if it were	487	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.	488	the hour pointer of a clock). Update this image every minute.
439		489
440	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"	490	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
441		491
442	=item counter $seconds	492	=item counter $seconds
443		493
444	Like C<again>, but also returns an increasing counter value, starting at	494	Like C<again>, but also returns an increasing counter value, starting at
445	0, which might be useful for some simple animation effects.	495	0, which might be useful for some simple animation effects.
…		…
447	=cut	497	=cut
448		498
449	sub now() { urxvt::NOW }	499	sub now() { urxvt::NOW }
450		500
451	sub again($) {	501	sub again($) {
452	$new->{again} = $_[0];	502	$new->{again}{time} = $_[0];
453	}	503	}
454		504
455	sub counter($) {	505	sub counter($) {
456	$new->{again} = $_[0];	506	$new->{again}{time} = $_[0];
457	$self->{counter} + 0	507	$self->{counter} + 0
458	}	508	}
459		509
460	=back	510	=back
461		511
…		…
632		682
633	sub rootalign($) {	683	sub rootalign($) {
634	move -TX, -TY, $_[0]	684	move -TX, -TY, $_[0]
635	}	685	}
636		686
		687	=item rotate $center_x, $center_y, $degrees
		688
		689	Rotates the image by C<$degrees> degrees, counter-clockwise, around the
		690	pointer at C<$center_x> and C<$center_y> (specified as factor of image
		691	width/height).
		692
		693	#TODO# new width, height, maybe more operators?
		694
		695	Example: rotate the image by 90 degrees
		696
		697	=cut
		698
		699	sub rotate($$$$) {
		700	my $img = pop;
		701	$img->rotate (
		702	$_[0] * $img->w,
		703	$_[1] * $img->h,
		704	$_[2] * (3.14159265 / 180),
		705	)
		706	}
		707
637	=back	708	=back
638		709
639	=head2 COLOUR MODIFICATIONS	710	=head2 COLOUR MODIFICATIONS
640		711
641	The following operators change the pixels of the image.	712	The following operators change the pixels of the image.
…		…
675		746
676	Values less than 0 reduce brightness, while values larger than 0 increase	747	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	748	it. Useful range is from -1 to 1 - the former results in a black, the
678	latter in a white picture.	749	latter in a white picture.
679		750
680	Due to idiosynchrasies in the underlying XRender extension, biases less	751	Due to idiosyncrasies in the underlying XRender extension, biases less
681	than zero can be I<very> slow.	752	than zero can be I<very> slow.
682		753
683	=cut	754	=cut
684		755
685	sub contrast($$;$$;$) {	756	sub contrast($$;$$;$) {
…		…
723	sub blur($$;$) {	794	sub blur($$;$) {
724	my $img = pop;	795	my $img = pop;
725	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	796	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
726	}	797	}
727		798
728	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees	799	=back
729		800
730	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	801	=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		802
735	#TODO# new width, height, maybe more operators?	803	Anything that didn't fit any of the other categories, even after applying
		804	force and closing our eyes.
736		805
737	Example: rotate the image by 90 degrees	806	=over 4
738		807
739	=cut	808	=item once { ... }
740		809
741	sub rotate($$$$$$) {	810	This function takes a code block as argument, that is, one or more
742	my $img = pop;	811	statements enclosed by braces.
743	$img->rotate (	812
744	$_[0],	813	The trick is that this code block is only evaluated once - future calls
745	$_[1],	814	will simply return the original image (yes, it should only be used with
746	$_[2] * $img->w,	815	images).
747	$_[3] * $img->h,	816
748	$_[4] * (3.14159265 / 180),	817	This can be extremely useful to avoid redoign the same slow operations
		818	again and again- for example, if your background expression takes the root
		819	background, blurs it and then root-aligns it it would have to blur the
		820	root background on every window move or resize.
		821
		822	Putting the blur into a C<once> block will make sure the blur is only done
		823	once:
		824
		825	rootlign once { blur 10, root }
		826
		827	This leaves the question of how to force reevaluation of the block, in
		828	case the root background changes: Right now, all once blocks forget that
		829	they ahve been executed before each time the root background changes (if
		830	the expression is sensitive to that) or when C<once_again> is called.
		831
		832	=item once_again
		833
		834	Resets all C<once> block as if they had never been called, i.e. on the
		835	next call they will be reevaluated again.
		836
		837	=cut
		838
		839	sub once(&) {
		840	my $once = $self->{once_cache}{$_[0]+0} \|\|= do {
		841	local $new->{again};
		842	my @res = $_[0]();
		843	[$new->{again}, \@res]
749	)	844	};
		845
		846	$new->{again} = {
		847	%{ $new->{again} },
		848	%{ $once->[0] }
		849	};
		850
		851	# in scalar context we always return the first original result, which
		852	# is not quite how perl works.
		853	wantarray
		854	? @{ $once->[1] }
		855	: $once->[1][0]
		856	}
		857
		858	sub once_again() {
		859	delete $self->{once_cache};
750	}	860	}
751		861
752	=back	862	=back
753		863
754	=cut	864	=cut
…		…
799		909
800	my $img = eval { $self->{expr}->() };	910	my $img = eval { $self->{expr}->() };
801	warn $@ if $@;#d#	911	warn $@ if $@;#d#
802	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";	912	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
803		913
804	$state->{size_sensitive} = 1	914	# if the expression is sensitive to external events, prepare reevaluation then
		915
		916	my $again = delete $state->{again};
		917
		918	$again->{size} = 1
805	if $img->repeat_mode != urxvt::RepeatNormal;	919	if $img->repeat_mode != urxvt::RepeatNormal;
806		920
807	# if the expression is sensitive to external events, prepare reevaluation then
808
809	my $repeat;
810
811	if (my $again = $state->{again}) {	921	if (my $again = $again->{time}) {
812	$repeat = 1;
813	my $self = $self;	922	my $self = $self;
814	$state->{timer} = $again == $old->{again}	923	$state->{timer} = $again == $old->{again}
815	? $old->{timer}	924	? $old->{timer}
816	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	925	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
817	++$self->{counter};	926	++$self->{counter};
818	$self->recalculate	927	$self->recalculate
819	});	928	});
820	}	929	}
821		930
822	if (delete $state->{position_sensitive}) {	931	if ($again->{position}) {
823	$repeat = 1;
824	$self->enable (position_change => sub { $_[0]->recalculate });	932	$self->enable (position_change => sub { $_[0]->recalculate });
825	} else {	933	} else {
826	$self->disable ("position_change");	934	$self->disable ("position_change");
827	}	935	}
828		936
829	if (delete $state->{size_sensitive}) {	937	if ($again->{size}) {
830	$repeat = 1;
831	$self->enable (size_change => sub { $_[0]->recalculate });	938	$self->enable (size_change => sub { $_[0]->recalculate });
832	} else {	939	} else {
833	$self->disable ("size_change");	940	$self->disable ("size_change");
834	}	941	}
835		942
836	if (delete $state->{rootpmap_sensitive}) {	943	if ($again->{rootpmap}) {
837	$repeat = 1;
838	$self->enable (rootpmap_change => sub { $_[0]->recalculate });	944	$self->enable (rootpmap_change => sub {
		945	delete $_[0]{once_cache}; # this will override once-block values from
		946	$_[0]->recalculate;
		947	});
839	} else {	948	} else {
840	$self->disable ("rootpmap_change");	949	$self->disable ("rootpmap_change");
841	}	950	}
842		951
843	# clear stuff we no longer need	952	# clear stuff we no longer need
844		953
845	%$old = ();	954	%$old = ();
846		955
847	unless ($repeat) {	956	unless (%$again) {
848	delete $self->{state};	957	delete $self->{state};
849	delete $self->{expr};	958	delete $self->{expr};
850	}	959	}
851		960
852	# set background pixmap	961	# 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.59 by root, Thu Jun 14 19:31:17 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.59 by root, Thu Jun 14 19:31:17 2012 UTC