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

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.51 by sf-exg, Sun Jun 10 19:01:03 2012 UTC vs.
Revision 1.63 by root, Tue Jun 19 18:17:56 2012 UTC

…		…
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
…		…
138	pseudo-transparency, as the image seems to be static while the window is	138	pseudo-transparency, as the image seems to be static while the window is
139	moved around.	139	moved around.
140		140
141	=head2 CYCLES AND CACHING	141	=head2 CYCLES AND CACHING
142		142
		143	=head3 C<load> et al.
		144
143	As has been mentioned before, the expression might be evaluated multiple	145	As has been mentioned before, the expression might be evaluated multiple
144	times. Each time the expression is reevaluated, a new cycle is said to	146	times. Each time the expression is reevaluated, a new cycle is said to
145	have begun. Many operators cache their results till the next cycle.	147	have begun. Many operators cache their results till the next cycle.
146		148
147	For example, the C<load> operator keeps a copy of the image. If it is	149	For example, the C<load> operator keeps a copy of the image. If it is
…		…
171		173
172	Here, a path is selected randomly, and load is only called for one image,	174	Here, a path is selected randomly, and load is only called for one image,
173	so keeps only one image in memory. If, on the next evaluation, luck	175	so keeps only one image in memory. If, on the next evaluation, luck
174	decides to use the other path, then it will have to load that image again.	176	decides to use the other path, then it will have to load that image again.
175		177
		178	=head3 C<once { ... }>
		179
		180	Another way to cache expensive operations is to use C<once { ... }>. The
		181	C<once> operator takes a block of multiple statements enclosed by C<{}>
		182	and evaluates it only.. once, returning any images the last statement
		183	returned. Further calls simply produce the values from the cache.
		184
		185	This is most useful for expensive operations, such as C<blur>:
		186
		187	rootalign once { blur 20, root }
		188
		189	This makes a blurred copy of the root background once, and on subsequent
		190	calls, just root-aligns it. Since C<blur> is usually quite slow and
		191	C<rootalign> is quite fast, this trades extra memory (For the cached
		192	blurred pixmap) with speed (blur only needs to be redone when root
		193	changes).
		194
176	=head1 REFERENCE	195	=head1 REFERENCE
177		196
178	=head2 COMMAND LINE SWITCHES	197	=head2 COMMAND LINE SWITCHES
179		198
180	=over 4	199	=over 4
…		…
202		221
203	=back	222	=back
204		223
205	=cut	224	=cut
206		225
207	our %_IMGCACHE;	226	our %_IMG_CACHE;
208	our $HOME;	227	our $HOME;
209	our ($self, $old, $new);	228	our ($self, $frame);
210	our ($x, $y, $w, $h);	229	our ($x, $y, $w, $h);
211		230
212	# enforce at least this interval between updates	231	# enforce at least this interval between updates
213	our $MIN_INTERVAL = 6/59.951;	232	our $MIN_INTERVAL = 6/59.951;
214		233
215	{	234	{
216	package urxvt::bgdsl; # background language	235	package urxvt::bgdsl; # background language
		236
		237	sub FR_PARENT() { 0 } # parent frame, if any - must be #0
		238	sub FR_CACHE () { 1 } # cached values
		239	sub FR_AGAIN () { 2 } # what this expr is sensitive to
		240	sub FR_STATE () { 3 } # watchers etc.
217		241
218	use List::Util qw(min max sum shuffle);	242	use List::Util qw(min max sum shuffle);
219		243
220	=head2 PROVIDERS/GENERATORS	244	=head2 PROVIDERS/GENERATORS
221		245
…		…
228	=item load $path	252	=item load $path
229		253
230	Loads the image at the given C<$path>. The image is set to plane tiling	254	Loads the image at the given C<$path>. The image is set to plane tiling
231	mode.	255	mode.
232		256
233	Loaded images will be cached for one cycle.	257	Loaded images will be cached for one cycle, and shared between temrinals
		258	running in the same process (e.g. in C<urxvtd>).
		259
		260	#=item load_uc $path
		261	#
		262	#Load uncached - same as load, but does not cache the image. This function
		263	#is most useufl if you want to optimise a background expression in some
		264	#way.
234		265
235	=cut	266	=cut
236		267
237	sub load($) {	268	sub load($) {
238	my ($path) = @_;	269	my ($path) = @_;
239		270
240	$new->{load}{$path} = $old->{load}{$path} \|\| $self->new_img_from_file ($path);	271	$_IMG_CACHE{$path} \|\| do {
		272	my $img = $self->new_img_from_file ($path);
		273	Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
		274	$img
		275	}
241	}	276	}
242		277
243	=item root	278	=item root
244		279
245	Returns the root window pixmap, that is, hopefully, the background image	280	Returns the root window pixmap, that is, hopefully, the background image
246	of your screen. The image is set to extend mode.	281	of your screen.
247		282
248	This function makes your expression root sensitive, that means it will be	283	This function makes your expression root sensitive, that means it will be
249	reevaluated when the bg image changes.	284	reevaluated when the bg image changes.
250		285
251	=cut	286	=cut
252		287
253	sub root() {	288	sub root() {
254	$new->{rootpmap_sensitive} = 1;	289	$frame->[FR_AGAIN]{rootpmap} = 1;
255	die "root op not supported, exg, we need you";	290	$self->new_img_from_root
256	}	291	}
257		292
258	=item solid $colour	293	=item solid $colour
259		294
260	=item solid $width, $height, $colour	295	=item solid $width, $height, $colour
…		…
268	=cut	303	=cut
269		304
270	sub solid($;$$) {	305	sub solid($;$$) {
271	my $colour = pop;	306	my $colour = pop;
272		307
273	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);	308	my $img = $self->new_img (urxvt::PictStandardARGB32, 0, 0, $_[0] \|\| 1, $_[1] \|\| 1);
274	$img->fill ($colour);	309	$img->fill ($colour);
275	$img	310	$img
276	}	311	}
277		312
278	=item clone $img	313	=item clone $img
…		…
284		319
285	sub clone($) {	320	sub clone($) {
286	$_[0]->clone	321	$_[0]->clone
287	}	322	}
288		323
289	=back	324	=item merge $img ...
		325
		326	Takes any number of images and merges them together, creating a single
		327	image containing them all. The tiling mode of the first image is used as
		328	the tiling mdoe of the resulting image.
		329
		330	This function is called automatically when an expression returns multiple
		331	images.
		332
		333	=cut
		334
		335	sub merge(@) {
		336	return $_[0] unless $#_;
		337
		338	# rather annoyingly clumsy, but optimisation is for another time
		339
		340	my $x0 = +1e9;
		341	my $y0 = +1e9;
		342	my $x1 = -1e9;
		343	my $y1 = -1e9;
		344
		345	for (@_) {
		346	my ($x, $y, $w, $h) = $_->geometry;
		347
		348	$x0 = $x if $x0 > $x;
		349	$y0 = $y if $y0 > $y;
		350
		351	$x += $w;
		352	$y += $h;
		353
		354	$x1 = $x if $x1 < $x;
		355	$y1 = $y if $y1 < $y;
		356	}
		357
		358	my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
		359	$base->repeat_mode ($_[0]->repeat_mode);
		360	$base->fill ([0, 0, 0, 0]);
		361
		362	$base->draw ($_)
		363	for @_;
		364
		365	$base
		366	}
290		367
291	=head2 TILING MODES	368	=head2 TILING MODES
292		369
293	The following operators modify the tiling mode of an image, that is, the	370	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.	371	way that pixels outside the image area are painted when the image is used.
…		…
409	the window size to conserve memory.	486	the window size to conserve memory.
410		487
411	Example: take the screen background, clip it to the window size, blur it a	488	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.	489	bit, align it to the window position and use it as background.
413		490
414	clip move -TX, -TY, blur 5, root	491	clip move -TX, -TY, once { blur 5, root }
415		492
416	=cut	493	=cut
417		494
418	sub TX() { $new->{position_sensitive} = 1; $x }	495	sub TX() { $frame->[FR_AGAIN]{position} = 1; $x }
419	sub TY() { $new->{position_sensitive} = 1; $y }	496	sub TY() { $frame->[FR_AGAIN]{position} = 1; $y }
420	sub TW() { $new->{size_sensitive} = 1; $w }	497	sub TW() { $frame->[FR_AGAIN]{size} = 1; $w }
421	sub TH() { $new->{size_sensitive} = 1; $h }	498	sub TH() { $frame->[FR_AGAIN]{size} = 1; $h }
422		499
423	=item now	500	=item now
424		501
425	Returns the current time as (fractional) seconds since the epoch.	502	Returns the current time as (fractional) seconds since the epoch.
426		503
…		…
433	C<$seconds> seconds.	510	C<$seconds> seconds.
434		511
435	Example: load some image and rotate it according to the time of day (as if it were	512	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.	513	the hour pointer of a clock). Update this image every minute.
437		514
438	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"	515	again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
439		516
440	=item counter $seconds	517	=item counter $seconds
441		518
442	Like C<again>, but also returns an increasing counter value, starting at	519	Like C<again>, but also returns an increasing counter value, starting at
443	0, which might be useful for some simple animation effects.	520	0, which might be useful for some simple animation effects.
…		…
445	=cut	522	=cut
446		523
447	sub now() { urxvt::NOW }	524	sub now() { urxvt::NOW }
448		525
449	sub again($) {	526	sub again($) {
450	$new->{again} = $_[0];	527	$frame->[FR_AGAIN]{time} = $_[0];
451	}	528	}
452		529
453	sub counter($) {	530	sub counter($) {
454	$new->{again} = $_[0];	531	$frame->[FR_AGAIN]{time} = $_[0];
455	$self->{counter} + 0	532	$frame->[FR_STATE]{counter} + 0
456	}	533	}
457		534
458	=back	535	=back
459		536
460	=head2 SHAPE CHANGING OPERATORS	537	=head2 SHAPE CHANGING OPERATORS
…		…
630		707
631	sub rootalign($) {	708	sub rootalign($) {
632	move -TX, -TY, $_[0]	709	move -TX, -TY, $_[0]
633	}	710	}
634		711
		712	=item rotate $center_x, $center_y, $degrees
		713
		714	Rotates the image by C<$degrees> degrees, counter-clockwise, around the
		715	pointer at C<$center_x> and C<$center_y> (specified as factor of image
		716	width/height).
		717
		718	#TODO# new width, height, maybe more operators?
		719
		720	Example: rotate the image by 90 degrees
		721
		722	=cut
		723
		724	sub rotate($$$$) {
		725	my $img = pop;
		726	$img->rotate (
		727	$_[0] * ($img->w + $img->x),
		728	$_[1] * ($img->h + $img->y),
		729	$_[2] * (3.14159265 / 180),
		730	)
		731	}
		732
635	=back	733	=back
636		734
637	=head2 COLOUR MODIFICATIONS	735	=head2 COLOUR MODIFICATIONS
638		736
639	The following operators change the pixels of the image.	737	The following operators change the pixels of the image.
…		…
721	sub blur($$;$) {	819	sub blur($$;$) {
722	my $img = pop;	820	my $img = pop;
723	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])	821	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
724	}	822	}
725		823
726	=item rotate $new_width, $new_height, $center_x, $center_y, $degrees
727
728	Rotates the image by C<$degrees> degrees, counter-clockwise, around the
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
733	#TODO# new width, height, maybe more operators?
734
735	Example: rotate the image by 90 degrees
736
737	=cut
738
739	sub rotate($$$$$$) {
740	my $img = pop;
741	$img->rotate (
742	$_[0],
743	$_[1],
744	$_[2] * $img->w,
745	$_[3] * $img->h,
746	$_[4] * (3.14159265 / 180),
747	)
748	}
749
750	=back	824	=back
751		825
		826	=head2 OTHER STUFF
		827
		828	Anything that didn't fit any of the other categories, even after applying
		829	force and closing our eyes.
		830
		831	=over 4
		832
		833	=item once { ... }
		834
		835	This function takes a code block as argument, that is, one or more
		836	statements enclosed by braces.
		837
		838	The trick is that this code block is only evaluated once - future calls
		839	will simply return the original image (yes, it should only be used with
		840	images).
		841
		842	This can be extremely useful to avoid redoing the same slow operations
		843	again and again- for example, if your background expression takes the root
		844	background, blurs it and then root-aligns it it would have to blur the
		845	root background on every window move or resize.
		846
		847	In fact, urxvt itself encloses the whole expression in some kind of
		848	C<once> block so it only is reevaluated as required.
		849
		850	Putting the blur into a C<once> block will make sure the blur is only done
		851	once:
		852
		853	rootlign once { blur 10, root }
		854
		855	This leaves the question of how to force reevaluation of the block,
		856	in case the root background changes: If expression inside the block
		857	is sensitive to some event (root background changes, window geometry
		858	changes), then it will be reevaluated automatically as needed.
		859
		860	=item once_again
		861
		862	Resets all C<once> block as if they had never been called, i.e. on the
		863	next call they will be reevaluated again.
		864
		865	=cut
		866
		867	sub once(&) {
		868	my $id = $_[0]+0;
		869
		870	local $frame = $self->{frame_cache}{$id} \|\|= [$frame];
		871
		872	unless ($frame->[FR_CACHE]) {
		873	$frame->[FR_CACHE] = [ $_[0]() ];
		874
		875	my $self = $self;
		876	my $frame = $frame;
		877	Scalar::Util::weaken $frame;
		878	$self->compile_frame ($frame, sub {
		879	# clear this frame cache, also for all parents
		880	for (my $frame = $frame; $frame; $frame = $frame->[0]) {
		881	undef $frame->[FR_CACHE];
		882	}
		883
		884	unless ($self->{term}) {
		885	use Data::Dump;
		886	ddx $frame;
		887	exit;
		888	}
		889
		890	$self->recalculate;
		891	});
		892	};
		893
		894	# in scalar context we always return the first original result, which
		895	# is not quite how perl works.
		896	wantarray
		897	? @{ $frame->[FR_CACHE] }
		898	: $frame->[FR_CACHE][0]
		899	}
		900
		901	sub once_again() {
		902	delete $self->{frame_cache};
		903	}
		904
		905	=back
		906
752	=cut	907	=cut
753		908
754	}	909	}
755		910
756	sub parse_expr {	911	sub parse_expr {
757	my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}";	912	my $expr = eval
		913	"sub {\n"
		914	. "package urxvt::bgdsl;\n"
		915	. "#line 0 'background expression'\n"
		916	. "$_[0]\n"
		917	. "}";
758	die if $@;	918	die if $@;
759	$expr	919	$expr
760	}	920	}
761		921
762	# compiles a parsed expression	922	# compiles a parsed expression
763	sub set_expr {	923	sub set_expr {
764	my ($self, $expr) = @_;	924	my ($self, $expr) = @_;
765		925
		926	$self->{root} = [];
766	$self->{expr} = $expr;	927	$self->{expr} = $expr;
767	$self->recalculate;	928	$self->recalculate;
		929	}
		930
		931	# takes a hash of sensitivity indicators and installs watchers
		932	sub compile_frame {
		933	my ($self, $frame, $cb) = @_;
		934
		935	my $state = $frame->[urxvt::bgdsl::FR_STATE] \|\|= {};
		936	my $again = $frame->[urxvt::bgdsl::FR_AGAIN];
		937
		938	# don't keep stuff alive
		939	Scalar::Util::weaken $state;
		940
		941	if ($again->{nested}) {
		942	$state->{nested} = 1;
		943	} else {
		944	delete $state->{nested};
		945	}
		946
		947	if (my $interval = $again->{time}) {
		948	$state->{time} = [$interval, urxvt::timer->new->after ($interval)->interval ($interval)]
		949	if $state->{time}[0] != $interval;
		950
		951	# callback might have changed, although we could just rule that out
		952	$state->{time}[1]->cb (sub {
		953	++$state->{counter};
		954	$cb->();
		955	});
		956	} else {
		957	delete $state->{time};
		958	}
		959
		960	if ($again->{position}) {
		961	$state->{position} = $self->on (position_change => $cb);
		962	} else {
		963	delete $state->{position};
		964	}
		965
		966	if ($again->{size}) {
		967	$state->{size} = $self->on (size_change => $cb);
		968	} else {
		969	delete $state->{size};
		970	}
		971
		972	if ($again->{rootpmap}) {
		973	$state->{rootpmap} = $self->on (rootpmap_change => $cb);
		974	} else {
		975	delete $state->{rootpmap};
		976	}
768	}	977	}
769		978
770	# evaluate the current bg expression	979	# evaluate the current bg expression
771	sub recalculate {	980	sub recalculate {
772	my ($arg_self) = @_;	981	my ($arg_self) = @_;
…		…
782		991
783	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	992	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
784		993
785	# set environment to evaluate user expression	994	# set environment to evaluate user expression
786		995
787	local $self = $arg_self;	996	local $self = $arg_self;
788
789	local $HOME = $ENV{HOME};	997	local $HOME = $ENV{HOME};
790	local $old = $self->{state};	998	local $frame = [];
791	local $new = my $state = $self->{state} = {};
792		999
793	($x, $y, $w, $h) =
794	$self->background_geometry ($self->{border});	1000	($x, $y, $w, $h) = $self->background_geometry ($self->{border});
795		1001
796	# evaluate user expression	1002	# evaluate user expression
797		1003
798	my $img = eval { $self->{expr}->() };	1004	my @img = eval { $self->{expr}->() };
799	warn $@ if $@;#d#	1005	die $@ if $@;
800	die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";	1006	die "background-expr did not return anything.\n" unless @img;
		1007	die "background-expr: expected image(s), got something else.\n"
		1008	if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;
801		1009
802	$state->{size_sensitive} = 1	1010	my $img = urxvt::bgdsl::merge @img;
		1011
		1012	$frame->[FR_AGAIN]{size} = 1
803	if $img->repeat_mode != urxvt::RepeatNormal;	1013	if $img->repeat_mode != urxvt::RepeatNormal;
804		1014
805	# if the expression is sensitive to external events, prepare reevaluation then	1015	# if the expression is sensitive to external events, prepare reevaluation then
806		1016	$self->compile_frame ($frame, sub { $arg_self->recalculate });
807	my $repeat;
808
809	if (my $again = $state->{again}) {
810	$repeat = 1;
811	my $self = $self;
812	$state->{timer} = $again == $old->{again}
813	? $old->{timer}
814	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
815	++$self->{counter};
816	$self->recalculate
817	});
818	}
819
820	if (delete $state->{position_sensitive}) {
821	$repeat = 1;
822	$self->enable (position_change => sub { $_[0]->recalculate });
823	} else {
824	$self->disable ("position_change");
825	}
826
827	if (delete $state->{size_sensitive}) {
828	$repeat = 1;
829	$self->enable (size_change => sub { $_[0]->recalculate });
830	} else {
831	$self->disable ("size_change");
832	}
833
834	if (delete $state->{rootpmap_sensitive}) {
835	$repeat = 1;
836	$self->enable (rootpmap_change => sub { $_[0]->recalculate });
837	} else {
838	$self->disable ("rootpmap_change");
839	}
840		1017
841	# clear stuff we no longer need	1018	# clear stuff we no longer need
842		1019
843	%$old = ();	1020	# unless (%{ $frame->[FR_STATE] }) {
844
845	unless ($repeat) {
846	delete $self->{state};	1021	# delete $self->{state};
847	delete $self->{expr};	1022	# delete $self->{expr};
848	}	1023	# }
849		1024
850	# set background pixmap	1025	# set background pixmap
851		1026
852	$self->set_background ($img, $self->{border});	1027	$self->set_background ($img, $self->{border});
853	$self->scr_recolour (0);	1028	$self->scr_recolour (0);

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.51 by sf-exg, Sun Jun 10 19:01:03 2012 UTC vs. Revision 1.63 by root, Tue Jun 19 18:17:56 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.51 by sf-exg, Sun Jun 10 19:01:03 2012 UTC vs.
Revision 1.63 by root, Tue Jun 19 18:17:56 2012 UTC