[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.56 by root, Thu Jun 14 17:06: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
…		…
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 image containing them all.
		309
		310	=cut
		311
		312	sub merge(@) {
		313	#TODO
		314	}
290		315
291	=head2 TILING MODES	316	=head2 TILING MODES
292		317
293	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
294	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.
…		…
324	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
325	image over another image or the background colour while leaving all	350	image over another image or the background colour while leaving all
326	background pixels outside the image unchanged.	351	background pixels outside the image unchanged.
327		352
328	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
329	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
330	in alpha mode, else background colour).	355	in alpha mode, else background colour).
331		356
332	pad load "mybg.png"	357	pad load "mybg.png"
333		358
334	=item extend $img	359	=item extend $img
335		360
336	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
337	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
338	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
339	same values as the pixels near the edge.	364	same values as the pixels near the edge.
340		365
341	Example: just for curiosity, how does this pixel extension stuff work?	366	Example: just for curiosity, how does this pixel extension stuff work?
342		367
…		…
409	the window size to conserve memory.	434	the window size to conserve memory.
410		435
411	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
412	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.
413		438
414	clip move -TX, -TY, blur 5, root	439	clip move -TX, -TY, once { blur 5, root }
415		440
416	=cut	441	=cut
417		442
418	sub TX() { $new->{position_sensitive} = 1; $x }	443	sub TX() { $new->{again}{position} = 1; $x }
419	sub TY() { $new->{position_sensitive} = 1; $y }	444	sub TY() { $new->{again}{position} = 1; $y }
420	sub TW() { $new->{size_sensitive} = 1; $w }	445	sub TW() { $new->{again}{size} = 1; $w }
421	sub TH() { $new->{size_sensitive} = 1; $h }	446	sub TH() { $new->{again}{size} = 1; $h }
422		447
423	=item now	448	=item now
424		449
425	Returns the current time as (fractional) seconds since the epoch.	450	Returns the current time as (fractional) seconds since the epoch.
426		451
…		…
433	C<$seconds> seconds.	458	C<$seconds> seconds.
434		459
435	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
436	the hour pointer of a clock). Update this image every minute.	461	the hour pointer of a clock). Update this image every minute.
437		462
438	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"
439		464
440	=item counter $seconds	465	=item counter $seconds
441		466
442	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
443	0, which might be useful for some simple animation effects.	468	0, which might be useful for some simple animation effects.
…		…
445	=cut	470	=cut
446		471
447	sub now() { urxvt::NOW }	472	sub now() { urxvt::NOW }
448		473
449	sub again($) {	474	sub again($) {
450	$new->{again} = $_[0];	475	$new->{again}{time} = $_[0];
451	}	476	}
452		477
453	sub counter($) {	478	sub counter($) {
454	$new->{again} = $_[0];	479	$new->{again}{time} = $_[0];
455	$self->{counter} + 0	480	$self->{counter} + 0
456	}	481	}
457		482
458	=back	483	=back
459		484
…		…
630		655
631	sub rootalign($) {	656	sub rootalign($) {
632	move -TX, -TY, $_[0]	657	move -TX, -TY, $_[0]
633	}	658	}
634		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
635	=back	681	=back
636		682
637	=head2 COLOUR MODIFICATIONS	683	=head2 COLOUR MODIFICATIONS
638		684
639	The following operators change the pixels of the image.	685	The following operators change the pixels of the image.
…		…
673		719
674	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
675	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
676	latter in a white picture.	722	latter in a white picture.
677		723
678	Due to idiosynchrasies in the underlying XRender extension, biases less	724	Due to idiosyncrasies in the underlying XRender extension, biases less
679	than zero can be I<very> slow.	725	than zero can be I<very> slow.
680		726
681	=cut	727	=cut
682		728
683	sub contrast($$;$$;$) {	729	sub contrast($$;$$;$) {
…		…
721	sub blur($$;$) {	767	sub blur($$;$) {
722	my $img = pop;	768	my $img = pop;
723	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	769	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
724	}	770	}
725		771
726	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees	772	=back
727		773
728	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	774	=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		775
733	#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.
734		778
735	Example: rotate the image by 90 degrees	779	=over 4
736		780
737	=cut	781	=item once { ... }
738		782
739	sub rotate($$$$$$) {	783	This function takes a code block as argument, that is, one or more
740	my $img = pop;	784	statements enclosed by braces.
741	$img->rotate (	785
742	$_[0],	786	The trick is that this code block is only evaluated once - future calls
743	$_[1],	787	will simply return the original image (yes, it should only be used with
744	$_[2] * $img->w,	788	images).
745	$_[3] * $img->h,	789
746	$_[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]
747	)	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};
748	}	833	}
749		834
750	=back	835	=back
751		836
752	=cut	837	=cut
…		…
797		882
798	my $img = eval { $self->{expr}->() };	883	my $img = eval { $self->{expr}->() };
799	warn $@ if $@;#d#	884	warn $@ if $@;#d#
800	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";
801		886
802	$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
803	if $img->repeat_mode != urxvt::RepeatNormal;	892	if $img->repeat_mode != urxvt::RepeatNormal;
804		893
805	# if the expression is sensitive to external events, prepare reevaluation then
806
807	my $repeat;
808
809	if (my $again = $state->{again}) {	894	if (my $again = $again->{time}) {
810	$repeat = 1;
811	my $self = $self;	895	my $self = $self;
812	$state->{timer} = $again == $old->{again}	896	$state->{timer} = $again == $old->{again}
813	? $old->{timer}	897	? $old->{timer}
814	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	898	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
815	++$self->{counter};	899	++$self->{counter};
816	$self->recalculate	900	$self->recalculate
817	});	901	});
818	}	902	}
819		903
820	if (delete $state->{position_sensitive}) {	904	if ($again->{position}) {
821	$repeat = 1;
822	$self->enable (position_change => sub { $_[0]->recalculate });	905	$self->enable (position_change => sub { $_[0]->recalculate });
823	} else {	906	} else {
824	$self->disable ("position_change");	907	$self->disable ("position_change");
825	}	908	}
826		909
827	if (delete $state->{size_sensitive}) {	910	if ($again->{size}) {
828	$repeat = 1;
829	$self->enable (size_change => sub { $_[0]->recalculate });	911	$self->enable (size_change => sub { $_[0]->recalculate });
830	} else {	912	} else {
831	$self->disable ("size_change");	913	$self->disable ("size_change");
832	}	914	}
833		915
834	if (delete $state->{rootpmap_sensitive}) {	916	if ($again->{rootpmap}) {
835	$repeat = 1;
836	$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	});
837	} else {	921	} else {
838	$self->disable ("rootpmap_change");	922	$self->disable ("rootpmap_change");
839	}	923	}
840		924
841	# clear stuff we no longer need	925	# clear stuff we no longer need
842		926
843	%$old = ();	927	%$old = ();
844		928
845	unless ($repeat) {	929	unless (%$again) {
846	delete $self->{state};	930	delete $self->{state};
847	delete $self->{expr};	931	delete $self->{expr};
848	}	932	}
849		933
850	# 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.50 by root, Sun Jun 10 17:31:53 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.50 by root, Sun Jun 10 17:31:53 2012 UTC vs.
Revision 1.56 by root, Thu Jun 14 17:06:57 2012 UTC