[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.58 by root, Thu Jun 14 18:13:19 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
…		…
284		301
285	sub clone($) {	302	sub clone($) {
286	$_[0]->clone	303	$_[0]->clone
287	}	304	}
288		305
289	=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 ($x0, $y0, $x1 - $x0, $y1 - $y0);
		335	$base->fill ([0, 0, 0, 0]);
		336
		337	$base->blend (1., $_)
		338	for @_;
		339
		340	$base
		341	}
290		342
291	=head2 TILING MODES	343	=head2 TILING MODES
292		344
293	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
294	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.
…		…
324	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
325	image over another image or the background colour while leaving all	377	image over another image or the background colour while leaving all
326	background pixels outside the image unchanged.	378	background pixels outside the image unchanged.
327		379
328	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
329	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
330	in alpha mode, else background colour).	382	in alpha mode, else background colour).
331		383
332	pad load "mybg.png"	384	pad load "mybg.png"
333		385
334	=item extend $img	386	=item extend $img
335		387
336	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
337	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
338	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
339	same values as the pixels near the edge.	391	same values as the pixels near the edge.
340		392
341	Example: just for curiosity, how does this pixel extension stuff work?	393	Example: just for curiosity, how does this pixel extension stuff work?
342		394
…		…
409	the window size to conserve memory.	461	the window size to conserve memory.
410		462
411	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
412	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.
413		465
414	clip move -TX, -TY, blur 5, root	466	clip move -TX, -TY, once { blur 5, root }
415		467
416	=cut	468	=cut
417		469
418	sub TX() { $new->{position_sensitive} = 1; $x }	470	sub TX() { $new->{again}{position} = 1; $x }
419	sub TY() { $new->{position_sensitive} = 1; $y }	471	sub TY() { $new->{again}{position} = 1; $y }
420	sub TW() { $new->{size_sensitive} = 1; $w }	472	sub TW() { $new->{again}{size} = 1; $w }
421	sub TH() { $new->{size_sensitive} = 1; $h }	473	sub TH() { $new->{again}{size} = 1; $h }
422		474
423	=item now	475	=item now
424		476
425	Returns the current time as (fractional) seconds since the epoch.	477	Returns the current time as (fractional) seconds since the epoch.
426		478
…		…
433	C<$seconds> seconds.	485	C<$seconds> seconds.
434		486
435	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
436	the hour pointer of a clock). Update this image every minute.	488	the hour pointer of a clock). Update this image every minute.
437		489
438	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"
439		491
440	=item counter $seconds	492	=item counter $seconds
441		493
442	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
443	0, which might be useful for some simple animation effects.	495	0, which might be useful for some simple animation effects.
…		…
445	=cut	497	=cut
446		498
447	sub now() { urxvt::NOW }	499	sub now() { urxvt::NOW }
448		500
449	sub again($) {	501	sub again($) {
450	$new->{again} = $_[0];	502	$new->{again}{time} = $_[0];
451	}	503	}
452		504
453	sub counter($) {	505	sub counter($) {
454	$new->{again} = $_[0];	506	$new->{again}{time} = $_[0];
455	$self->{counter} + 0	507	$self->{counter} + 0
456	}	508	}
457		509
458	=back	510	=back
459		511
…		…
630		682
631	sub rootalign($) {	683	sub rootalign($) {
632	move -TX, -TY, $_[0]	684	move -TX, -TY, $_[0]
633	}	685	}
634		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
635	=back	708	=back
636		709
637	=head2 COLOUR MODIFICATIONS	710	=head2 COLOUR MODIFICATIONS
638		711
639	The following operators change the pixels of the image.	712	The following operators change the pixels of the image.
…		…
673		746
674	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
675	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
676	latter in a white picture.	749	latter in a white picture.
677		750
678	Due to idiosynchrasies in the underlying XRender extension, biases less	751	Due to idiosyncrasies in the underlying XRender extension, biases less
679	than zero can be I<very> slow.	752	than zero can be I<very> slow.
680		753
681	=cut	754	=cut
682		755
683	sub contrast($$;$$;$) {	756	sub contrast($$;$$;$) {
…		…
721	sub blur($$;$) {	794	sub blur($$;$) {
722	my $img = pop;	795	my $img = pop;
723	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	796	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
724	}	797	}
725		798
726	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees	799	=back
727		800
728	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	801	=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		802
733	#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.
734		805
735	Example: rotate the image by 90 degrees	806	=over 4
736		807
737	=cut	808	=item once { ... }
738		809
739	sub rotate($$$$$$) {	810	This function takes a code block as argument, that is, one or more
740	my $img = pop;	811	statements enclosed by braces.
741	$img->rotate (	812
742	$_[0],	813	The trick is that this code block is only evaluated once - future calls
743	$_[1],	814	will simply return the original image (yes, it should only be used with
744	$_[2] * $img->w,	815	images).
745	$_[3] * $img->h,	816
746	$_[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]
747	)	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};
748	}	860	}
749		861
750	=back	862	=back
751		863
752	=cut	864	=cut
…		…
797		909
798	my $img = eval { $self->{expr}->() };	910	my $img = eval { $self->{expr}->() };
799	warn $@ if $@;#d#	911	warn $@ if $@;#d#
800	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";
801		913
802	$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
803	if $img->repeat_mode != urxvt::RepeatNormal;	919	if $img->repeat_mode != urxvt::RepeatNormal;
804		920
805	# if the expression is sensitive to external events, prepare reevaluation then
806
807	my $repeat;
808
809	if (my $again = $state->{again}) {	921	if (my $again = $again->{time}) {
810	$repeat = 1;
811	my $self = $self;	922	my $self = $self;
812	$state->{timer} = $again == $old->{again}	923	$state->{timer} = $again == $old->{again}
813	? $old->{timer}	924	? $old->{timer}
814	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	925	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
815	++$self->{counter};	926	++$self->{counter};
816	$self->recalculate	927	$self->recalculate
817	});	928	});
818	}	929	}
819		930
820	if (delete $state->{position_sensitive}) {	931	if ($again->{position}) {
821	$repeat = 1;
822	$self->enable (position_change => sub { $_[0]->recalculate });	932	$self->enable (position_change => sub { $_[0]->recalculate });
823	} else {	933	} else {
824	$self->disable ("position_change");	934	$self->disable ("position_change");
825	}	935	}
826		936
827	if (delete $state->{size_sensitive}) {	937	if ($again->{size}) {
828	$repeat = 1;
829	$self->enable (size_change => sub { $_[0]->recalculate });	938	$self->enable (size_change => sub { $_[0]->recalculate });
830	} else {	939	} else {
831	$self->disable ("size_change");	940	$self->disable ("size_change");
832	}	941	}
833		942
834	if (delete $state->{rootpmap_sensitive}) {	943	if ($again->{rootpmap}) {
835	$repeat = 1;
836	$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	});
837	} else {	948	} else {
838	$self->disable ("rootpmap_change");	949	$self->disable ("rootpmap_change");
839	}	950	}
840		951
841	# clear stuff we no longer need	952	# clear stuff we no longer need
842		953
843	%$old = ();	954	%$old = ();
844		955
845	unless ($repeat) {	956	unless (%$again) {
846	delete $self->{state};	957	delete $self->{state};
847	delete $self->{expr};	958	delete $self->{expr};
848	}	959	}
849		960
850	# 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.50 by root, Sun Jun 10 17:31:53 2012 UTC vs. Revision 1.58 by root, Thu Jun 14 18:13:19 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.58 by root, Thu Jun 14 18:13:19 2012 UTC