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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.50 by root, Sun Jun 10 17:31:53 2012 UTC vs.
Revision 1.55 by root, Thu Jun 14 16:48:57 2012 UTC

…		…
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:
…		…
71	return scale load "$HOME/weekday.png";	71	return scale load "$HOME/weekday.png";
72	} else {	72	} else {
73	return scale load "$HOME/sunday.png";	73	return scale load "$HOME/sunday.png";
74	}	74	}
75		75
76	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
77	background on Sundays, and F<weekday.png> on all other days.	77	background on Sundays, and F<weekday.png> on all other days.
78		78
79	Fortunately, we expect that most expressions will be much simpler, with	79	Fortunately, we expect that most expressions will be much simpler, with
80	little Perl knowledge needed.	80	little Perl knowledge needed.
81		81
…		…
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";
…		…
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	194	=item --background-interval seconds
195		195
196	Since some operations in the underlying XRender extension can effetively	196	Since some operations in the underlying XRender extension can effectively
197	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
198	time between updates, which is normally about 0.1 seconds.	198	time between updates, which is normally about 0.1 seconds.
199		199
200	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
201	interval with this switch.	201	interval with this switch.
202		202
203	=back	203	=back
204		204
205	=cut	205	=cut
206		206
207	our %_IMGCACHE;	207	our %_IMG_CACHE;
208	our $HOME;	208	our $HOME;
209	our ($self, $old, $new);	209	our ($self, $old, $new);
210	our ($x, $y, $w, $h);	210	our ($x, $y, $w, $h);
211		211
212	# enforce at least this interval between updates	212	# enforce at least this interval between updates
…		…
228	=item load $path	228	=item load $path
229		229
230	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
231	mode.	231	mode.
232		232
233	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>).
234		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
235	=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	}
236		253
237	sub load($) {	254	sub load($) {
238	my ($path) = @_;	255	my ($path) = @_;
239		256
240	$new->{load}{$path} = $old->{load}{$path} \|\| $self->new_img_from_file ($path);	257	$new->{load}{$path} = $old->{load}{$path} \|\| load_uc $path;
241	}	258	}
242		259
243	=item root	260	=item root
244		261
245	Returns the root window pixmap, that is, hopefully, the background image	262	Returns the root window pixmap, that is, hopefully, the background image
…		…
249	reevaluated when the bg image changes.	266	reevaluated when the bg image changes.
250		267
251	=cut	268	=cut
252		269
253	sub root() {	270	sub root() {
254	$new->{rootpmap_sensitive} = 1;	271	$new->{again}{rootpmap} = 1;
255	die "root op not supported, exg, we need you";	272	$self->new_img_from_root
256	}	273	}
257		274
258	=item solid $colour	275	=item solid $colour
259		276
260	=item solid $width, $height, $colour	277	=item solid $width, $height, $colour
…		…
283	=cut	300	=cut
284		301
285	sub clone($) {	302	sub clone($) {
286	$_[0]->clone	303	$_[0]->clone
287	}	304	}
288
289	=back
290		305
291	=head2 TILING MODES	306	=head2 TILING MODES
292		307
293	The following operators modify the tiling mode of an image, that is, the	308	The following operators modify the tiling mode of an image, that is, the
294	way that pixels outside the image area are painted when the image is used.	309	way that pixels outside the image area are painted when the image is used.
…		…
324	become transparent. This mode is most useful when you want to place an	339	become transparent. This mode is most useful when you want to place an
325	image over another image or the background colour while leaving all	340	image over another image or the background colour while leaving all
326	background pixels outside the image unchanged.	341	background pixels outside the image unchanged.
327		342
328	Example: load an image and display it in the upper left corner. The rest	343	Example: load an image and display it in the upper left corner. The rest
329	of the space is left "empty" (transparent or wahtever your compisotr does	344	of the space is left "empty" (transparent or whatever your compositor does
330	in alpha mode, else background colour).	345	in alpha mode, else background colour).
331		346
332	pad load "mybg.png"	347	pad load "mybg.png"
333		348
334	=item extend $img	349	=item extend $img
335		350
336	Extends the image over the whole plane, using the closest pixel in the	351	Extends the image over the whole plane, using the closest pixel in the
337	area outside the image. This mode is mostly useful when you more complex	352	area outside the image. This mode is mostly useful when you use more complex
338	filtering operations and want the pixels outside the image to have the	353	filtering operations and want the pixels outside the image to have the
339	same values as the pixels near the edge.	354	same values as the pixels near the edge.
340		355
341	Example: just for curiosity, how does this pixel extension stuff work?	356	Example: just for curiosity, how does this pixel extension stuff work?
342		357
…		…
409	the window size to conserve memory.	424	the window size to conserve memory.
410		425
411	Example: take the screen background, clip it to the window size, blur it a	426	Example: take the screen background, clip it to the window size, blur it a
412	bit, align it to the window position and use it as background.	427	bit, align it to the window position and use it as background.
413		428
414	clip move -TX, -TY, blur 5, root	429	clip move -TX, -TY, once { blur 5, root }
415		430
416	=cut	431	=cut
417		432
418	sub TX() { $new->{position_sensitive} = 1; $x }	433	sub TX() { $new->{again}{position} = 1; $x }
419	sub TY() { $new->{position_sensitive} = 1; $y }	434	sub TY() { $new->{again}{position} = 1; $y }
420	sub TW() { $new->{size_sensitive} = 1; $w }	435	sub TW() { $new->{again}{size} = 1; $w }
421	sub TH() { $new->{size_sensitive} = 1; $h }	436	sub TH() { $new->{again}{size} = 1; $h }
422		437
423	=item now	438	=item now
424		439
425	Returns the current time as (fractional) seconds since the epoch.	440	Returns the current time as (fractional) seconds since the epoch.
426		441
…		…
433	C<$seconds> seconds.	448	C<$seconds> seconds.
434		449
435	Example: load some image and rotate it according to the time of day (as if it were	450	Example: load some image and rotate it according to the time of day (as if it were
436	the hour pointer of a clock). Update this image every minute.	451	the hour pointer of a clock). Update this image every minute.
437		452
438	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"	453	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
439		454
440	=item counter $seconds	455	=item counter $seconds
441		456
442	Like C<again>, but also returns an increasing counter value, starting at	457	Like C<again>, but also returns an increasing counter value, starting at
443	0, which might be useful for some simple animation effects.	458	0, which might be useful for some simple animation effects.
…		…
445	=cut	460	=cut
446		461
447	sub now() { urxvt::NOW }	462	sub now() { urxvt::NOW }
448		463
449	sub again($) {	464	sub again($) {
450	$new->{again} = $_[0];	465	$new->{again}{time} = $_[0];
451	}	466	}
452		467
453	sub counter($) {	468	sub counter($) {
454	$new->{again} = $_[0];	469	$new->{again}{time} = $_[0];
455	$self->{counter} + 0	470	$self->{counter} + 0
456	}	471	}
457		472
458	=back	473	=back
459		474
…		…
630		645
631	sub rootalign($) {	646	sub rootalign($) {
632	move -TX, -TY, $_[0]	647	move -TX, -TY, $_[0]
633	}	648	}
634		649
		650	=item rotate $center_x, $center_y, $degrees
		651
		652	Rotates the image by C<$degrees> degrees, counter-clockwise, around the
		653	pointer at C<$center_x> and C<$center_y> (specified as factor of image
		654	width/height).
		655
		656	#TODO# new width, height, maybe more operators?
		657
		658	Example: rotate the image by 90 degrees
		659
		660	=cut
		661
		662	sub rotate($$$$) {
		663	my $img = pop;
		664	$img->rotate (
		665	$_[0] * $img->w,
		666	$_[1] * $img->h,
		667	$_[2] * (3.14159265 / 180),
		668	)
		669	}
		670
635	=back	671	=back
636		672
637	=head2 COLOUR MODIFICATIONS	673	=head2 COLOUR MODIFICATIONS
638		674
639	The following operators change the pixels of the image.	675	The following operators change the pixels of the image.
…		…
673		709
674	Values less than 0 reduce brightness, while values larger than 0 increase	710	Values less than 0 reduce brightness, while values larger than 0 increase
675	it. Useful range is from -1 to 1 - the former results in a black, the	711	it. Useful range is from -1 to 1 - the former results in a black, the
676	latter in a white picture.	712	latter in a white picture.
677		713
678	Due to idiosynchrasies in the underlying XRender extension, biases less	714	Due to idiosyncrasies in the underlying XRender extension, biases less
679	than zero can be I<very> slow.	715	than zero can be I<very> slow.
680		716
681	=cut	717	=cut
682		718
683	sub contrast($$;$$;$) {	719	sub contrast($$;$$;$) {
…		…
721	sub blur($$;$) {	757	sub blur($$;$) {
722	my $img = pop;	758	my $img = pop;
723	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	759	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
724	}	760	}
725		761
726	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees	762	=back
727		763
728	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	764	=head2 OTHER STUFF
729	pointer at C<$center_x> and C<$center_y> (specified as factor of image
730	width/height), generating a new image with width C<$new_width> and height
731	C<$new_height>.
732		765
733	#TODO# new width, height, maybe more operators?	766	Anything that didn't fit any of the other categories, even after appliyng
		767	force and closing our eyes.
734		768
735	Example: rotate the image by 90 degrees	769	=over 4
736		770
737	=cut	771	=item once { ... }
738		772
739	sub rotate($$$$$$) {	773	This function takes a code block as argument, that is, one or more
740	my $img = pop;	774	statements enclosed by braces.
741	$img->rotate (	775
742	$_[0],	776	The trick is that this code block is only evaluated once - future calls
743	$_[1],	777	will simply return the original image (yes, it should only be used with
744	$_[2] * $img->w,	778	images).
745	$_[3] * $img->h,	779
746	$_[4] * (3.14159265 / 180),	780	This can be extremely useful to avoid redoign the same slow operations
		781	again and again- for example, if your background expression takes the root
		782	background, blurs it and then root-aligns it it would have to blur the
		783	root background on every window move or resize.
		784
		785	Putting the blur into a C<once> block will make sure the blur is only done
		786	once:
		787
		788	rootlign once { blur 10, root }
		789
		790	This leaves the question of how to force reevaluation of the block, in
		791	case the root background changes: Right now, all once blocks forget that
		792	they ahve been executed before each time the root background changes (if
		793	the expression is sensitive to that) or when C<once_again> is called.
		794
		795	=item once_again
		796
		797	Resets all C<once> block as if they had never been called, i.e. on the
		798	next call they will be reevaluated again.
		799
		800	=cut
		801
		802	sub once(&) {
		803	my $once = $self->{once_cache}{$_[0]+0} \|\|= do {
		804	local $new->{again};
		805	my @res = $_[0]();
		806	[$new->{again}, \@res]
747	)	807	};
		808
		809	$new->{again} = {
		810	%{ $new->{again} },
		811	%{ $once->[0] }
		812	};
		813
		814	# in scalar context we always return the first original result, which
		815	# is not quite how perl works.
		816	wantarray
		817	? @{ $once->[1] }
		818	: $once->[1][0]
		819	}
		820
		821	sub once_again() {
		822	delete $self->{once_cache};
748	}	823	}
749		824
750	=back	825	=back
751		826
752	=cut	827	=cut
…		…
797		872
798	my $img = eval { $self->{expr}->() };	873	my $img = eval { $self->{expr}->() };
799	warn $@ if $@;#d#	874	warn $@ if $@;#d#
800	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";	875	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
801		876
802	$state->{size_sensitive} = 1	877	# if the expression is sensitive to external events, prepare reevaluation then
		878
		879	my $again = delete $state->{again};
		880
		881	$again->{size} = 1
803	if $img->repeat_mode != urxvt::RepeatNormal;	882	if $img->repeat_mode != urxvt::RepeatNormal;
804		883
805	# if the expression is sensitive to external events, prepare reevaluation then
806
807	my $repeat;
808
809	if (my $again = $state->{again}) {	884	if (my $again = $again->{time}) {
810	$repeat = 1;
811	my $self = $self;	885	my $self = $self;
812	$state->{timer} = $again == $old->{again}	886	$state->{timer} = $again == $old->{again}
813	? $old->{timer}	887	? $old->{timer}
814	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	888	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
815	++$self->{counter};	889	++$self->{counter};
816	$self->recalculate	890	$self->recalculate
817	});	891	});
818	}	892	}
819		893
820	if (delete $state->{position_sensitive}) {	894	if ($again->{position}) {
821	$repeat = 1;
822	$self->enable (position_change => sub { $_[0]->recalculate });	895	$self->enable (position_change => sub { $_[0]->recalculate });
823	} else {	896	} else {
824	$self->disable ("position_change");	897	$self->disable ("position_change");
825	}	898	}
826		899
827	if (delete $state->{size_sensitive}) {	900	if ($again->{size}) {
828	$repeat = 1;
829	$self->enable (size_change => sub { $_[0]->recalculate });	901	$self->enable (size_change => sub { $_[0]->recalculate });
830	} else {	902	} else {
831	$self->disable ("size_change");	903	$self->disable ("size_change");
832	}	904	}
833		905
834	if (delete $state->{rootpmap_sensitive}) {	906	if ($again->{rootpmap}) {
835	$repeat = 1;
836	$self->enable (rootpmap_change => sub { $_[0]->recalculate });	907	$self->enable (rootpmap_change => sub {
		908	delete $_[0]{once_cache}; # this will override once-block values from
		909	$_[0]->recalculate;
		910	});
837	} else {	911	} else {
838	$self->disable ("rootpmap_change");	912	$self->disable ("rootpmap_change");
839	}	913	}
840		914
841	# clear stuff we no longer need	915	# clear stuff we no longer need
842		916
843	%$old = ();	917	%$old = ();
844		918
845	unless ($repeat) {	919	unless (%$again) {
846	delete $self->{state};	920	delete $self->{state};
847	delete $self->{expr};	921	delete $self->{expr};
848	}	922	}
849		923
850	# set background pixmap	924	# set background pixmap

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.50 by root, Sun Jun 10 17:31:53 2012 UTC vs. Revision 1.55 by root, Thu Jun 14 16:48:57 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.50 by root, Sun Jun 10 17:31:53 2012 UTC vs.
Revision 1.55 by root, Thu Jun 14 16:48:57 2012 UTC