[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.56 by root, Thu Jun 14 17:06: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	#: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
…		…
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 image containing them all.
		309
		310	=cut
		311
		312	sub merge(@) {
		313	#TODO
		314	}
292		315
293	=head2 TILING MODES	316	=head2 TILING MODES
294		317
295	The following operators modify the tiling mode of an image, that is, the	318	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.	319	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	349	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	350	image over another image or the background colour while leaving all
328	background pixels outside the image unchanged.	351	background pixels outside the image unchanged.
329		352
330	Example: load an image and display it in the upper left corner. The rest	353	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	354	of the space is left "empty" (transparent or whatever your compositor does
332	in alpha mode, else background colour).	355	in alpha mode, else background colour).
333		356
334	pad load "mybg.png"	357	pad load "mybg.png"
335		358
336	=item extend $img	359	=item extend $img
337		360
338	Extends the image over the whole plane, using the closest pixel in the	361	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	362	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	363	filtering operations and want the pixels outside the image to have the
341	same values as the pixels near the edge.	364	same values as the pixels near the edge.
342		365
343	Example: just for curiosity, how does this pixel extension stuff work?	366	Example: just for curiosity, how does this pixel extension stuff work?
344		367
…		…
411	the window size to conserve memory.	434	the window size to conserve memory.
412		435
413	Example: take the screen background, clip it to the window size, blur it a	436	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.	437	bit, align it to the window position and use it as background.
415		438
416	clip move -TX, -TY, blur 5, root	439	clip move -TX, -TY, once { blur 5, root }
417		440
418	=cut	441	=cut
419		442
420	sub TX() { $new->{position_sensitive} = 1; $x }	443	sub TX() { $new->{again}{position} = 1; $x }
421	sub TY() { $new->{position_sensitive} = 1; $y }	444	sub TY() { $new->{again}{position} = 1; $y }
422	sub TW() { $new->{size_sensitive} = 1; $w }	445	sub TW() { $new->{again}{size} = 1; $w }
423	sub TH() { $new->{size_sensitive} = 1; $h }	446	sub TH() { $new->{again}{size} = 1; $h }
424		447
425	=item now	448	=item now
426		449
427	Returns the current time as (fractional) seconds since the epoch.	450	Returns the current time as (fractional) seconds since the epoch.
428		451
…		…
435	C<$seconds> seconds.	458	C<$seconds> seconds.
436		459
437	Example: load some image and rotate it according to the time of day (as if it were	460	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.	461	the hour pointer of a clock). Update this image every minute.
439		462
440	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"	463	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
441		464
442	=item counter $seconds	465	=item counter $seconds
443		466
444	Like C<again>, but also returns an increasing counter value, starting at	467	Like C<again>, but also returns an increasing counter value, starting at
445	0, which might be useful for some simple animation effects.	468	0, which might be useful for some simple animation effects.
…		…
447	=cut	470	=cut
448		471
449	sub now() { urxvt::NOW }	472	sub now() { urxvt::NOW }
450		473
451	sub again($) {	474	sub again($) {
452	$new->{again} = $_[0];	475	$new->{again}{time} = $_[0];
453	}	476	}
454		477
455	sub counter($) {	478	sub counter($) {
456	$new->{again} = $_[0];	479	$new->{again}{time} = $_[0];
457	$self->{counter} + 0	480	$self->{counter} + 0
458	}	481	}
459		482
460	=back	483	=back
461		484
…		…
632		655
633	sub rootalign($) {	656	sub rootalign($) {
634	move -TX, -TY, $_[0]	657	move -TX, -TY, $_[0]
635	}	658	}
636		659
		660	=item rotate $center_x, $center_y, $degrees
		661
		662	Rotates the image by C<$degrees> degrees, counter-clockwise, around the
		663	pointer at C<$center_x> and C<$center_y> (specified as factor of image
		664	width/height).
		665
		666	#TODO# new width, height, maybe more operators?
		667
		668	Example: rotate the image by 90 degrees
		669
		670	=cut
		671
		672	sub rotate($$$$) {
		673	my $img = pop;
		674	$img->rotate (
		675	$_[0] * $img->w,
		676	$_[1] * $img->h,
		677	$_[2] * (3.14159265 / 180),
		678	)
		679	}
		680
637	=back	681	=back
638		682
639	=head2 COLOUR MODIFICATIONS	683	=head2 COLOUR MODIFICATIONS
640		684
641	The following operators change the pixels of the image.	685	The following operators change the pixels of the image.
…		…
675		719
676	Values less than 0 reduce brightness, while values larger than 0 increase	720	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	721	it. Useful range is from -1 to 1 - the former results in a black, the
678	latter in a white picture.	722	latter in a white picture.
679		723
680	Due to idiosynchrasies in the underlying XRender extension, biases less	724	Due to idiosyncrasies in the underlying XRender extension, biases less
681	than zero can be I<very> slow.	725	than zero can be I<very> slow.
682		726
683	=cut	727	=cut
684		728
685	sub contrast($$;$$;$) {	729	sub contrast($$;$$;$) {
…		…
723	sub blur($$;$) {	767	sub blur($$;$) {
724	my $img = pop;	768	my $img = pop;
725	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	769	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
726	}	770	}
727		771
728	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees	772	=back
729		773
730	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	774	=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		775
735	#TODO# new width, height, maybe more operators?	776	Anything that didn't fit any of the other categories, even after applying
		777	force and closing our eyes.
736		778
737	Example: rotate the image by 90 degrees	779	=over 4
738		780
739	=cut	781	=item once { ... }
740		782
741	sub rotate($$$$$$) {	783	This function takes a code block as argument, that is, one or more
742	my $img = pop;	784	statements enclosed by braces.
743	$img->rotate (	785
744	$_[0],	786	The trick is that this code block is only evaluated once - future calls
745	$_[1],	787	will simply return the original image (yes, it should only be used with
746	$_[2] * $img->w,	788	images).
747	$_[3] * $img->h,	789
748	$_[4] * (3.14159265 / 180),	790	This can be extremely useful to avoid redoign the same slow operations
		791	again and again- for example, if your background expression takes the root
		792	background, blurs it and then root-aligns it it would have to blur the
		793	root background on every window move or resize.
		794
		795	Putting the blur into a C<once> block will make sure the blur is only done
		796	once:
		797
		798	rootlign once { blur 10, root }
		799
		800	This leaves the question of how to force reevaluation of the block, in
		801	case the root background changes: Right now, all once blocks forget that
		802	they ahve been executed before each time the root background changes (if
		803	the expression is sensitive to that) or when C<once_again> is called.
		804
		805	=item once_again
		806
		807	Resets all C<once> block as if they had never been called, i.e. on the
		808	next call they will be reevaluated again.
		809
		810	=cut
		811
		812	sub once(&) {
		813	my $once = $self->{once_cache}{$_[0]+0} \|\|= do {
		814	local $new->{again};
		815	my @res = $_[0]();
		816	[$new->{again}, \@res]
749	)	817	};
		818
		819	$new->{again} = {
		820	%{ $new->{again} },
		821	%{ $once->[0] }
		822	};
		823
		824	# in scalar context we always return the first original result, which
		825	# is not quite how perl works.
		826	wantarray
		827	? @{ $once->[1] }
		828	: $once->[1][0]
		829	}
		830
		831	sub once_again() {
		832	delete $self->{once_cache};
750	}	833	}
751		834
752	=back	835	=back
753		836
754	=cut	837	=cut
…		…
799		882
800	my $img = eval { $self->{expr}->() };	883	my $img = eval { $self->{expr}->() };
801	warn $@ if $@;#d#	884	warn $@ if $@;#d#
802	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";	885	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
803		886
804	$state->{size_sensitive} = 1	887	# if the expression is sensitive to external events, prepare reevaluation then
		888
		889	my $again = delete $state->{again};
		890
		891	$again->{size} = 1
805	if $img->repeat_mode != urxvt::RepeatNormal;	892	if $img->repeat_mode != urxvt::RepeatNormal;
806		893
807	# if the expression is sensitive to external events, prepare reevaluation then
808
809	my $repeat;
810
811	if (my $again = $state->{again}) {	894	if (my $again = $again->{time}) {
812	$repeat = 1;
813	my $self = $self;	895	my $self = $self;
814	$state->{timer} = $again == $old->{again}	896	$state->{timer} = $again == $old->{again}
815	? $old->{timer}	897	? $old->{timer}
816	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	898	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
817	++$self->{counter};	899	++$self->{counter};
818	$self->recalculate	900	$self->recalculate
819	});	901	});
820	}	902	}
821		903
822	if (delete $state->{position_sensitive}) {	904	if ($again->{position}) {
823	$repeat = 1;
824	$self->enable (position_change => sub { $_[0]->recalculate });	905	$self->enable (position_change => sub { $_[0]->recalculate });
825	} else {	906	} else {
826	$self->disable ("position_change");	907	$self->disable ("position_change");
827	}	908	}
828		909
829	if (delete $state->{size_sensitive}) {	910	if ($again->{size}) {
830	$repeat = 1;
831	$self->enable (size_change => sub { $_[0]->recalculate });	911	$self->enable (size_change => sub { $_[0]->recalculate });
832	} else {	912	} else {
833	$self->disable ("size_change");	913	$self->disable ("size_change");
834	}	914	}
835		915
836	if (delete $state->{rootpmap_sensitive}) {	916	if ($again->{rootpmap}) {
837	$repeat = 1;
838	$self->enable (rootpmap_change => sub { $_[0]->recalculate });	917	$self->enable (rootpmap_change => sub {
		918	delete $_[0]{once_cache}; # this will override once-block values from
		919	$_[0]->recalculate;
		920	});
839	} else {	921	} else {
840	$self->disable ("rootpmap_change");	922	$self->disable ("rootpmap_change");
841	}	923	}
842		924
843	# clear stuff we no longer need	925	# clear stuff we no longer need
844		926
845	%$old = ();	927	%$old = ();
846		928
847	unless ($repeat) {	929	unless (%$again) {
848	delete $self->{state};	930	delete $self->{state};
849	delete $self->{expr};	931	delete $self->{expr};
850	}	932	}
851		933
852	# set background pixmap	934	# 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.56 by root, Thu Jun 14 17:06:57 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.56 by root, Thu Jun 14 17:06:57 2012 UTC