ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/perl/background
(Generate patch)

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.52 by root, Tue Jun 12 10:45:53 2012 UTC vs.
Revision 1.62 by root, Sun Jun 17 21:58:18 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
76This expression gets evaluated once per hour. It will set F<sunday.png> as 76This expression is evaluated once per hour. It will set F<sunday.png> as
77background on Sundays, and F<weekday.png> on all other days. 77background on Sundays, and F<weekday.png> on all other days.
78 78
79Fortunately, we expect that most expressions will be much simpler, with 79Fortunately, we expect that most expressions will be much simpler, with
80little Perl knowledge needed. 80little Perl knowledge needed.
81 81
203=back 203=back
204 204
205=cut 205=cut
206 206
207our %_IMG_CACHE; 207our %_IMG_CACHE;
208our %_ONCE_CACHE;
209our $HOME; 208our $HOME;
210our ($self, $old, $new); 209our ($self, $old, $new);
211our ($x, $y, $w, $h); 210our ($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
231Loads the image at the given C<$path>. The image is set to plane tiling 230Loads the image at the given C<$path>. The image is set to plane tiling
232mode. 231mode.
233 232
234Loaded images will be cached for one cycle. 233Loaded images will be cached for one cycle, and shared between temrinals
234running in the same process (e.g. in C<urxvtd>).
235 235
236=item load_uc $path
237
238Load uncached - same as load, but does not cache the image. This function
239is most useufl if you want to optimise a background expression in some
240way.
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
246Returns the root window pixmap, that is, hopefully, the background image 262Returns the root window pixmap, that is, hopefully, the background image
247of your screen. The image is set to extend mode. 263of your screen.
248 264
249This function makes your expression root sensitive, that means it will be 265This function makes your expression root sensitive, that means it will be
250reevaluated when the bg image changes. 266reevaluated 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 $self->new_img_from_root 272 $self->new_img_from_root
257 } 273 }
258 274
259=item solid $colour 275=item solid $colour
260 276
269=cut 285=cut
270 286
271 sub solid($;$$) { 287 sub solid($;$$) {
272 my $colour = pop; 288 my $colour = pop;
273 289
274 my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] || 1, $_[1] || 1); 290 my $img = $self->new_img (urxvt::PictStandardARGB32, 0, 0, $_[0] || 1, $_[1] || 1);
275 $img->fill ($colour); 291 $img->fill ($colour);
276 $img 292 $img
277 } 293 }
278 294
279=item clone $img 295=item clone $img
283 299
284=cut 300=cut
285 301
286 sub clone($) { 302 sub clone($) {
287 $_[0]->clone 303 $_[0]->clone
304 }
305
306=item merge $img ...
307
308Takes any number of images and merges them together, creating a single
309image containing them all. The tiling mode of the first image is used as
310the tiling mdoe of the resulting image.
311
312This function is called automatically when an expression returns multiple
313images.
314
315=cut
316
317 sub merge(@) {
318 return $_[0] unless $#_;
319
320 # rather annoyingly clumsy, but optimisation is for another time
321
322 my $x0 = +1e9;
323 my $y0 = +1e9;
324 my $x1 = -1e9;
325 my $y1 = -1e9;
326
327 for (@_) {
328 my ($x, $y, $w, $h) = $_->geometry;
329
330 $x0 = $x if $x0 > $x;
331 $y0 = $y if $y0 > $y;
332
333 $x += $w;
334 $y += $h;
335
336 $x1 = $x if $x1 < $x;
337 $y1 = $y if $y1 < $y;
338 }
339
340 my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
341 $base->repeat_mode ($_[0]->repeat_mode);
342 $base->fill ([0, 0, 0, 0]);
343
344 $base->draw ($_)
345 for @_;
346
347 $base
288 } 348 }
289 349
290=head2 TILING MODES 350=head2 TILING MODES
291 351
292The following operators modify the tiling mode of an image, that is, the 352The following operators modify the tiling mode of an image, that is, the
408the window size to conserve memory. 468the window size to conserve memory.
409 469
410Example: take the screen background, clip it to the window size, blur it a 470Example: take the screen background, clip it to the window size, blur it a
411bit, align it to the window position and use it as background. 471bit, align it to the window position and use it as background.
412 472
413 clip move -TX, -TY, blur 5, root 473 clip move -TX, -TY, once { blur 5, root }
414 474
415=cut 475=cut
416 476
417 sub TX() { $new->{position_sensitive} = 1; $x } 477 sub TX() { $new->{again}{position} = 1; $x }
418 sub TY() { $new->{position_sensitive} = 1; $y } 478 sub TY() { $new->{again}{position} = 1; $y }
419 sub TW() { $new->{size_sensitive} = 1; $w } 479 sub TW() { $new->{again}{size} = 1; $w }
420 sub TH() { $new->{size_sensitive} = 1; $h } 480 sub TH() { $new->{again}{size} = 1; $h }
421 481
422=item now 482=item now
423 483
424Returns the current time as (fractional) seconds since the epoch. 484Returns the current time as (fractional) seconds since the epoch.
425 485
432C<$seconds> seconds. 492C<$seconds> seconds.
433 493
434Example: load some image and rotate it according to the time of day (as if it were 494Example: load some image and rotate it according to the time of day (as if it were
435the hour pointer of a clock). Update this image every minute. 495the hour pointer of a clock). Update this image every minute.
436 496
437 again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png" 497 again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
438 498
439=item counter $seconds 499=item counter $seconds
440 500
441Like C<again>, but also returns an increasing counter value, starting at 501Like C<again>, but also returns an increasing counter value, starting at
4420, which might be useful for some simple animation effects. 5020, which might be useful for some simple animation effects.
444=cut 504=cut
445 505
446 sub now() { urxvt::NOW } 506 sub now() { urxvt::NOW }
447 507
448 sub again($) { 508 sub again($) {
449 $new->{again} = $_[0]; 509 $new->{again}{time} = $_[0];
450 } 510 }
451 511
452 sub counter($) { 512 sub counter($) {
453 $new->{again} = $_[0]; 513 $new->{again}{time} = $_[0];
454 $self->{counter} + 0 514 $self->{counter} + 0
455 } 515 }
456 516
457=back 517=back
458 518
629 689
630 sub rootalign($) { 690 sub rootalign($) {
631 move -TX, -TY, $_[0] 691 move -TX, -TY, $_[0]
632 } 692 }
633 693
634=item rotate $center_x, $center_y, $degrees, $new_width, $new_height 694=item rotate $center_x, $center_y, $degrees
635 695
636Rotates the image by C<$degrees> degrees, counter-clockwise, around the 696Rotates the image by C<$degrees> degrees, counter-clockwise, around the
637pointer at C<$center_x> and C<$center_y> (specified as factor of image 697pointer at C<$center_x> and C<$center_y> (specified as factor of image
638width/height), generating a new image with width C<$new_width> and height 698width/height).
639C<$new_height>.
640 699
641#TODO# new width, height, maybe more operators? 700#TODO# new width, height, maybe more operators?
642 701
643Example: rotate the image by 90 degrees 702Example: rotate the image by 90 degrees
644 703
645=cut 704=cut
646 705
647 sub rotate($$$$$$) { 706 sub rotate($$$$) {
648 my $img = pop; 707 my $img = pop;
649 $img->rotate ( 708 $img->rotate (
650 $_[0] * $img->w, 709 $_[0] * ($img->w + $img->x),
651 $_[1] * $img->h, 710 $_[1] * ($img->h + $img->y),
652 $_[2] * (3.14159265 / 180), 711 $_[2] * (3.14159265 / 180),
653 $_[3],
654 $_[4],
655 ) 712 )
656 } 713 }
657 714
658=back 715=back
659 716
748 805
749=back 806=back
750 807
751=head2 OTHER STUFF 808=head2 OTHER STUFF
752 809
753Anything that didn't fit any of the other categories, even after appliyng 810Anything that didn't fit any of the other categories, even after applying
754force and closing our eyes. 811force and closing our eyes.
755 812
756=over 4 813=over 4
757 814
758=item once { ... } 815=item once { ... }
785next call they will be reevaluated again. 842next call they will be reevaluated again.
786 843
787=cut 844=cut
788 845
789 sub once(&) { 846 sub once(&) {
790 $_ONCE_CACHE{$_[0]+0} ||= $_[0]() 847 my $once = $self->{once_cache}{$_[0]+0} ||= do {
848 local $new->{again};
849 my @res = $_[0]();
850 [$new->{again}, \@res]
851 };
852
853 $new->{again} = {
854 %{ $new->{again} },
855 %{ $once->[0] }
856 };
857
858 # in scalar context we always return the first original result, which
859 # is not quite how perl works.
860 wantarray
861 ? @{ $once->[1] }
862 : $once->[1][0]
791 } 863 }
792 864
793 sub once_again() { 865 sub once_again() {
794 %_ONCE_CACHE = (); 866 delete $self->{once_cache};
795 } 867 }
796 868
797=back 869=back
798 870
799=cut 871=cut
840 ($x, $y, $w, $h) = 912 ($x, $y, $w, $h) =
841 $self->background_geometry ($self->{border}); 913 $self->background_geometry ($self->{border});
842 914
843 # evaluate user expression 915 # evaluate user expression
844 916
845 my $img = eval { $self->{expr}->() }; 917 my $img = eval { urxvt::bgdsl::merge $self->{expr}->() };
846 warn $@ if $@;#d# 918 die $@ if $@;
847 die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img"; 919 die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
848 920
849 $state->{size_sensitive} = 1 921 # if the expression is sensitive to external events, prepare reevaluation then
922
923 my $again = delete $state->{again};
924
925 $again->{size} = 1
850 if $img->repeat_mode != urxvt::RepeatNormal; 926 if $img->repeat_mode != urxvt::RepeatNormal;
851 927
852 # if the expression is sensitive to external events, prepare reevaluation then
853
854 my $repeat;
855
856 if (my $again = $state->{again}) { 928 if (my $again = $again->{time}) {
857 $repeat = 1;
858 my $self = $self; 929 my $self = $self;
859 $state->{timer} = $again == $old->{again} 930 $state->{timer} = $again == $old->{again}
860 ? $old->{timer} 931 ? $old->{timer}
861 : urxvt::timer->new->after ($again)->interval ($again)->cb (sub { 932 : urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
862 ++$self->{counter}; 933 ++$self->{counter};
863 $self->recalculate 934 $self->recalculate
864 }); 935 });
865 } 936 }
866 937
867 if (delete $state->{position_sensitive}) { 938 if ($again->{position}) {
868 $repeat = 1;
869 $self->enable (position_change => sub { $_[0]->recalculate }); 939 $self->enable (position_change => sub { $_[0]->recalculate });
870 } else { 940 } else {
871 $self->disable ("position_change"); 941 $self->disable ("position_change");
872 } 942 }
873 943
874 if (delete $state->{size_sensitive}) { 944 if ($again->{size}) {
875 $repeat = 1;
876 $self->enable (size_change => sub { $_[0]->recalculate }); 945 $self->enable (size_change => sub { $_[0]->recalculate });
877 } else { 946 } else {
878 $self->disable ("size_change"); 947 $self->disable ("size_change");
879 } 948 }
880 949
881 if (delete $state->{rootpmap_sensitive}) { 950 if ($again->{rootpmap}) {
882 $repeat = 1;
883 $self->enable (rootpmap_change => sub { $_[0]->recalculate }); 951 $self->enable (rootpmap_change => sub {
952 delete $_[0]{once_cache}; # this will override once-block values from
953 $_[0]->recalculate;
954 });
884 } else { 955 } else {
885 $self->disable ("rootpmap_change"); 956 $self->disable ("rootpmap_change");
886 } 957 }
887 958
888 # clear stuff we no longer need 959 # clear stuff we no longer need
889 960
890 %$old = (); 961 %$old = ();
891 962
892 unless ($repeat) { 963 unless (%$again) {
893 delete $self->{state}; 964 delete $self->{state};
894 delete $self->{expr}; 965 delete $self->{expr};
895 } 966 }
896 967
897 # set background pixmap 968 # set background pixmap

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines