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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.48 by root, Sun Jun 10 15:01:14 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
		207	our %_IMG_CACHE;
209	our $HOME;	208	our $HOME;
210	our ($self, $old, $new);	209	our ($self, $old, $new);
211	our ($x, $y, $w, $h);	210	our ($x, $y, $w, $h);
212		211
213	# enforce at least this interval between updates	212	# enforce at least this interval between updates
…		…
229	=item load $path	228	=item load $path
230		229
231	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
232	mode.	231	mode.
233		232
234	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>).
235		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
236	=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	}
237		253
238	sub load($) {	254	sub load($) {
239	my ($path) = @_;	255	my ($path) = @_;
240		256
241	$new->{load}{$path} = $old->{load}{$path} \|\| $self->new_img_from_file ($path);	257	$new->{load}{$path} = $old->{load}{$path} \|\| load_uc $path;
242	}	258	}
243		259
244	=item root	260	=item root
245		261
246	Returns the root window pixmap, that is, hopefully, the background image	262	Returns the root window pixmap, that is, hopefully, the background image
…		…
250	reevaluated when the bg image changes.	266	reevaluated when the bg image changes.
251		267
252	=cut	268	=cut
253		269
254	sub root() {	270	sub root() {
255	$new->{rootpmap_sensitive} = 1;	271	$new->{again}{rootpmap} = 1;
256	die "root op not supported, exg, we need you";	272	$self->new_img_from_root
257	}	273	}
258		274
259	=item solid $colour	275	=item solid $colour
260		276
261	=item solid $width, $height, $colour	277	=item solid $width, $height, $colour
…		…
285		301
286	sub clone($) {	302	sub clone($) {
287	$_[0]->clone	303	$_[0]->clone
288	}	304	}
289		305
290	=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	}
291		315
292	=head2 TILING MODES	316	=head2 TILING MODES
293		317
294	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
295	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.
…		…
325	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
326	image over another image or the background colour while leaving all	350	image over another image or the background colour while leaving all
327	background pixels outside the image unchanged.	351	background pixels outside the image unchanged.
328		352
329	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
330	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
331	in alpha mode, else background colour).	355	in alpha mode, else background colour).
332		356
333	pad load "mybg.png"	357	pad load "mybg.png"
334		358
335	=item extend $img	359	=item extend $img
336		360
337	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
338	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
339	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
340	same values as the pixels near the edge.	364	same values as the pixels near the edge.
341		365
342	Example: just for curiosity, how does this pixel extension stuff work?	366	Example: just for curiosity, how does this pixel extension stuff work?
343		367
…		…
410	the window size to conserve memory.	434	the window size to conserve memory.
411		435
412	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
413	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.
414		438
415	clip move -TX, -TY, blur 5, root	439	clip move -TX, -TY, once { blur 5, root }
416		440
417	=cut	441	=cut
418		442
419	sub TX() { $new->{position_sensitive} = 1; $x }	443	sub TX() { $new->{again}{position} = 1; $x }
420	sub TY() { $new->{position_sensitive} = 1; $y }	444	sub TY() { $new->{again}{position} = 1; $y }
421	sub TW() { $new->{size_sensitive} = 1; $w }	445	sub TW() { $new->{again}{size} = 1; $w }
422	sub TH() { $new->{size_sensitive} = 1; $h }	446	sub TH() { $new->{again}{size} = 1; $h }
423		447
424	=item now	448	=item now
425		449
426	Returns the current time as (fractional) seconds since the epoch.	450	Returns the current time as (fractional) seconds since the epoch.
427		451
…		…
434	C<$seconds> seconds.	458	C<$seconds> seconds.
435		459
436	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
437	the hour pointer of a clock). Update this image every minute.	461	the hour pointer of a clock). Update this image every minute.
438		462
439	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"
440		464
441	=item counter $seconds	465	=item counter $seconds
442		466
443	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
444	0, which might be useful for some simple animation effects.	468	0, which might be useful for some simple animation effects.
…		…
446	=cut	470	=cut
447		471
448	sub now() { urxvt::NOW }	472	sub now() { urxvt::NOW }
449		473
450	sub again($) {	474	sub again($) {
451	$new->{again} = $_[0];	475	$new->{again}{time} = $_[0];
452	}	476	}
453		477
454	sub counter($) {	478	sub counter($) {
455	$new->{again} = $_[0];	479	$new->{again}{time} = $_[0];
456	$self->{counter} + 0	480	$self->{counter} + 0
457	}	481	}
458		482
459	=back	483	=back
460		484
…		…
631		655
632	sub rootalign($) {	656	sub rootalign($) {
633	move -TX, -TY, $_[0]	657	move -TX, -TY, $_[0]
634	}	658	}
635		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
636	=back	681	=back
637		682
638	=head2 COLOUR MODIFICATIONS	683	=head2 COLOUR MODIFICATIONS
639		684
640	The following operators change the pixels of the image.	685	The following operators change the pixels of the image.
…		…
674		719
675	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
676	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
677	latter in a white picture.	722	latter in a white picture.
678		723
679	Due to idiosynchrasies in the underlying XRender extension, biases less	724	Due to idiosyncrasies in the underlying XRender extension, biases less
680	than zero can be I<very> slow.	725	than zero can be I<very> slow.
681		726
682	=cut	727	=cut
683		728
684	sub contrast($$;$$;$) {	729	sub contrast($$;$$;$) {
685	my $img = pop;	730	my $img = pop;
686	my ($r, $g, $b, $a) = @_;	731	my ($r, $g, $b, $a) = @_;
687		732
688	($g, $b) = ($r, $r) if @_ < 4;	733	($g, $b) = ($r, $r) if @_ < 3;
689	$a = 1 if @_ < 5;	734	$a = 1 if @_ < 4;
690		735
691	$img = $img->clone;	736	$img = $img->clone;
692	$img->contrast ($r, $g, $b, $a);	737	$img->contrast ($r, $g, $b, $a);
693	$img	738	$img
694	}	739	}
695		740
696	sub brightness($$;$$;$) {	741	sub brightness($$;$$;$) {
697	my $img = pop;	742	my $img = pop;
698	my ($r, $g, $b, $a) = @_;	743	my ($r, $g, $b, $a) = @_;
699		744
700	($g, $b) = ($r, $r) if @_ < 4;	745	($g, $b) = ($r, $r) if @_ < 3;
701	$a = 1 if @_ < 5;	746	$a = 1 if @_ < 4;
702		747
703	$img = $img->clone;	748	$img = $img->clone;
704	$img->brightness ($r, $g, $b, $a);	749	$img->brightness ($r, $g, $b, $a);
705	$img	750	$img
706	}	751	}
…		…
722	sub blur($$;$) {	767	sub blur($$;$) {
723	my $img = pop;	768	my $img = pop;
724	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	769	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
725	}	770	}
726		771
727	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees	772	=back
728		773
729	Rotates the image by C<$degrees> degrees, counter-clockwise, around the	774	=head2 OTHER STUFF
730	pointer at C<$center_x> and C<$center_y> (specified as factor of image
731	width/height), generating a new image with width C<$new_width> and height
732	C<$new_height>.
733		775
734	#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.
735		778
736	Example: rotate the image by 90 degrees	779	=over 4
737		780
738	=cut	781	=item once { ... }
739		782
740	sub rotate($$$$$$) {	783	This function takes a code block as argument, that is, one or more
741	my $img = pop;	784	statements enclosed by braces.
742	$img->rotate (	785
743	$_[0],	786	The trick is that this code block is only evaluated once - future calls
744	$_[1],	787	will simply return the original image (yes, it should only be used with
745	$_[2] * $img->w,	788	images).
746	$_[3] * $img->h,	789
747	$_[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]
748	)	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};
749	}	833	}
750		834
751	=back	835	=back
752		836
753	=cut	837	=cut
…		…
798		882
799	my $img = eval { $self->{expr}->() };	883	my $img = eval { $self->{expr}->() };
800	warn $@ if $@;#d#	884	warn $@ if $@;#d#
801	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";
802		886
803	$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
804	if $img->repeat_mode != urxvt::RepeatNormal;	892	if $img->repeat_mode != urxvt::RepeatNormal;
805		893
806	# if the expression is sensitive to external events, prepare reevaluation then
807
808	my $repeat;
809
810	if (my $again = $state->{again}) {	894	if (my $again = $again->{time}) {
811	$repeat = 1;
812	my $self = $self;	895	my $self = $self;
813	$state->{timer} = $again == $old->{again}	896	$state->{timer} = $again == $old->{again}
814	? $old->{timer}	897	? $old->{timer}
815	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	898	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
816	++$self->{counter};	899	++$self->{counter};
817	$self->recalculate	900	$self->recalculate
818	});	901	});
819	}	902	}
820		903
821	if (delete $state->{position_sensitive}) {	904	if ($again->{position}) {
822	$repeat = 1;
823	$self->enable (position_change => sub { $_[0]->recalculate });	905	$self->enable (position_change => sub { $_[0]->recalculate });
824	} else {	906	} else {
825	$self->disable ("position_change");	907	$self->disable ("position_change");
826	}	908	}
827		909
828	if (delete $state->{size_sensitive}) {	910	if ($again->{size}) {
829	$repeat = 1;
830	$self->enable (size_change => sub { $_[0]->recalculate });	911	$self->enable (size_change => sub { $_[0]->recalculate });
831	} else {	912	} else {
832	$self->disable ("size_change");	913	$self->disable ("size_change");
833	}	914	}
834		915
835	if (delete $state->{rootpmap_sensitive}) {	916	if ($again->{rootpmap}) {
836	$repeat = 1;
837	$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	});
838	} else {	921	} else {
839	$self->disable ("rootpmap_change");	922	$self->disable ("rootpmap_change");
840	}	923	}
841		924
842	# clear stuff we no longer need	925	# clear stuff we no longer need
843		926
844	%$old = ();	927	%$old = ();
845		928
846	unless ($repeat) {	929	unless (%$again) {
847	delete $self->{state};	930	delete $self->{state};
848	delete $self->{expr};	931	delete $self->{expr};
849	}	932	}
850		933
851	# 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.48 by root, Sun Jun 10 15:01:14 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.48 by root, Sun Jun 10 15:01:14 2012 UTC vs.
Revision 1.56 by root, Thu Jun 14 17:06:57 2012 UTC