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.60 by root, Fri Jun 15 13:21:59 2012 UTC vs.
Revision 1.64 by root, Tue Jun 19 20:49:53 2012 UTC

26to be as simple as possible. 26to be as simple as possible.
27 27
28For example, to load an image and scale it to the window size, you would 28For example, to load an image and scale it to the window size, you would
29use: 29use:
30 30
31 urxvt --background-expr 'scale load "/path/to/mybg.png"' 31 urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }'
32 32
33Or specified as a X resource: 33Or specified as a X resource:
34 34
35 URxvt.background-expr: scale load "/path/to/mybg.png" 35 URxvt.background-expr: scale keep { load "/path/to/mybg.png" }
36 36
37=head1 THEORY OF OPERATION 37=head1 THEORY OF OPERATION
38 38
39At startup, just before the window is mapped for the first time, the 39At startup, just before the window is mapped for the first time, the
40expression is evaluated and must yield an image. The image is then 40expression is evaluated and must yield an image. The image is then
53If any of the parameters that the expression relies on changes (when the 53If any of the parameters that the expression relies on changes (when the
54window is moved or resized, its position or size changes; when the root 54window is moved or resized, its position or size changes; when the root
55pixmap is replaced by another one the root background changes; or when the 55pixmap is replaced by another one the root background changes; or when the
56timer elapses), then the expression will be evaluated again. 56timer elapses), then the expression will be evaluated again.
57 57
58For example, an expression such as C<scale load "$HOME/mybg.png"> scales the 58For example, an expression such as C<scale keep { load "$HOME/mybg.png"
59image to the window size, so it relies on the window size and will 59}> scales the image to the window size, so it relies on the window size
60be reevaluated each time it is changed, but not when it moves for 60and will be reevaluated each time it is changed, but not when it moves for
61example. That ensures that the picture always fills the terminal, even 61example. That ensures that the picture always fills the terminal, even
62after its size changes. 62after its size changes.
63 63
64=head2 EXPRESSIONS 64=head2 EXPRESSIONS
65 65
66Expressions are normal Perl expressions, in fact, they are Perl blocks - 66Expressions are normal Perl expressions, in fact, they are Perl blocks -
67which means you could use multiple lines and statements: 67which means you could use multiple lines and statements:
68 68
69 scale keep {
69 again 3600; 70 again 3600;
70 if (localtime now)[6]) { 71 if (localtime now)[6]) {
71 return scale load "$HOME/weekday.png"; 72 return load "$HOME/weekday.png";
72 } else { 73 } else {
73 return scale load "$HOME/sunday.png"; 74 return load "$HOME/sunday.png";
75 }
74 } 76 }
75 77
76This expression is evaluated once per hour. It will set F<sunday.png> as 78This expression is evaluated once per hour. It will set F<sunday.png> as
77background on Sundays, and F<weekday.png> on all other days. 79background on Sundays, and F<weekday.png> on all other days.
78 80
115horizontal and vertical dimensions. For example, this halves the image 117horizontal and vertical dimensions. For example, this halves the image
116width and doubles the image height: 118width and doubles the image height:
117 119
118 scale 0.5, 2, load "$HOME/mypic.png" 120 scale 0.5, 2, load "$HOME/mypic.png"
119 121
120Other effects than scaling are also readily available, for example, you can 122IF you try out these expressions, you might suffer from sluggishness,
121tile the image to fill the whole window, instead of resizing it: 123because each time the terminal is resized, it again loads the PNG image
124and scales it. Scaling is usually fats, but loading the image can be quite
125time consuming. This is where C<keep> comes in handy:
122 126
127 scale 0.5, 2, keep { load "$HOME/mypic.png" }
128
129The C<keep> operator executes all the statements inside the braces only
130once, or when it thinks the outcome might change. In other cases it
131returns the last value computed by the brace block.
132
133This means that the C<load> is only executed once, which makes it much
134faster, but alos means that more memory is being used, because the loaded
135image must be kept in memory at all times. In this expression, the
136trade-off is likely worth it.
137
138But back to effects: Other effects than scaling are also readily
139available, for example, you can tile the image to fill the whole window,
140instead of resizing it:
141
123 tile load "$HOME/mypic.png" 142 tile keep { load "$HOME/mypic.png" }
124 143
125In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator 144In fact, images returned by C<load> are in C<tile> mode by default, so the
126is kind of superfluous. 145C<tile> operator is kind of superfluous.
127 146
128Another common effect is to mirror the image, so that the same edges touch: 147Another common effect is to mirror the image, so that the same edges
148touch:
129 149
130 mirror load "$HOME/mypic.png" 150 mirror keep { load "$HOME/mypic.png" }
131 151
132This is also a typical background expression: 152Another common background expression is:
133 153
134 rootalign root 154 rootalign root
135 155
136It first takes a snapshot of the screen background image, and then 156This one first takes a snapshot of the screen background image, and then
137moves it to the upper left corner of the screen - the result is 157moves it to the upper left corner of the screen (as opposed to the upepr
138pseudo-transparency, as the image seems to be static while the window is 158left corner of the terminal window)- the result is pseudo-transparency:
139moved around. 159the image seems to be static while the window is moved around.
140 160
141=head2 CYCLES AND CACHING 161=head2 CACHING AND SENSITIVITY
142 162
143As has been mentioned before, the expression might be evaluated multiple 163Since some operations (such as C<load> and C<blur>) can take a long time,
144times. Each time the expression is reevaluated, a new cycle is said to 164caching results can be very important for a smooth operation. Caching can
145have begun. Many operators cache their results till the next cycle. 165also be useful to reduce memory usage, though, for example, when an image
166is cached by C<load>, it could be shared by multiple terminal windows
167running inside urxvtd.
146 168
147For example, the C<load> operator keeps a copy of the image. If it is 169=head3 C<keep { ... }> caching
148asked to load the same image on the next cycle it will not load it again,
149but return the cached copy.
150 170
151This only works for one cycle though, so as long as you load the same 171The most important way to cache expensive operations is to use C<keep {
152image every time, it will always be cached, but when you load a different 172... }>. The C<keep> operator takes a block of multiple statements enclosed
153image, it will forget about the first one. 173by C<{}> and keeps the return value in memory.
154 174
155This allows you to either speed things up by keeping multiple images in 175An expression can be "sensitive" to various external events, such as
156memory, or conserve memory by loading images more often. 176scaling or moving the window, root backgorund changes and timers. Simply
177using an expression (such as C<scale> without parameters) that depend on
178certain changing values (called "variables"), or using those variables
179directly, will make an expression sensitive to these events - for example,
180using C<scale> or C<TW> will make the expression sensitive to the terminal
181size, and thus to resizing events.
157 182
158For example, you can keep two images in memory and use a random one like 183When such an event happens, C<keep> will automatically trigger a
159this: 184reevaluation of the whole expression with the new value of the expression.
160 185
161 my $img1 = load "img1.png"; 186C<keep> is most useful for expensive operations, such as C<blur>:
162 my $img2 = load "img2.png";
163 (0.5 > rand) ? $img1 : $img2
164 187
165Since both images are "loaded" every time the expression is evaluated, 188 rootalign once { blur 20, root }
166they are always kept in memory. Contrast this version:
167 189
168 my $path1 = "img1.png"; 190This makes a blurred copy of the root background once, and on subsequent
169 my $path2 = "img2.png"; 191calls, just root-aligns it. Since C<blur> is usually quite slow and
170 load ((0.5 > rand) ? $path1 : $path2) 192C<rootalign> is quite fast, this trades extra memory (for the cached
193blurred pixmap) with speed (blur only needs to be redone when root
194changes).
171 195
172Here, a path is selected randomly, and load is only called for one image, 196=head3 C<load> caching
173so keeps only one image in memory. If, on the next evaluation, luck 197
174decides to use the other path, then it will have to load that image again. 198The C<load> operator itself does not keep images in memory, but as long as
199the image is still in memory, C<load> will use the in-memory image instead
200of loading it freshly from disk.
201
202That means that this expression:
203
204 keep { load "$HOME/path..." }
205
206Not only caches the image in memory, other terminal instances that try to
207C<load> it can reuse that in-memory copy.
175 208
176=head1 REFERENCE 209=head1 REFERENCE
177 210
178=head2 COMMAND LINE SWITCHES 211=head2 COMMAND LINE SWITCHES
179 212
204 237
205=cut 238=cut
206 239
207our %_IMG_CACHE; 240our %_IMG_CACHE;
208our $HOME; 241our $HOME;
209our ($self, $old, $new); 242our ($self, $frame);
210our ($x, $y, $w, $h); 243our ($x, $y, $w, $h);
211 244
212# enforce at least this interval between updates 245# enforce at least this interval between updates
213our $MIN_INTERVAL = 6/59.951; 246our $MIN_INTERVAL = 6/59.951;
214 247
215{ 248{
216 package urxvt::bgdsl; # background language 249 package urxvt::bgdsl; # background language
250
251 sub FR_PARENT() { 0 } # parent frame, if any - must be #0
252 sub FR_CACHE () { 1 } # cached values
253 sub FR_AGAIN () { 2 } # what this expr is sensitive to
254 sub FR_STATE () { 3 } # watchers etc.
217 255
218 use List::Util qw(min max sum shuffle); 256 use List::Util qw(min max sum shuffle);
219 257
220=head2 PROVIDERS/GENERATORS 258=head2 PROVIDERS/GENERATORS
221 259
228=item load $path 266=item load $path
229 267
230Loads the image at the given C<$path>. The image is set to plane tiling 268Loads the image at the given C<$path>. The image is set to plane tiling
231mode. 269mode.
232 270
233Loaded images will be cached for one cycle, and shared between temrinals 271If the image is already in memory (e.g. because another temrinal instance
234running in the same process (e.g. in C<urxvtd>). 272uses it), then the in-memory copy us returned instead.
235 273
236=item load_uc $path 274=item load_uc $path
237 275
238Load uncached - same as load, but does not cache the image. This function 276Load uncached - same as load, but does not cache the image, which means it
239is most useufl if you want to optimise a background expression in some 277is I<always> loaded from the filesystem again.
240way.
241 278
242=cut 279=cut
243 280
244 sub load_uc($) { 281 sub load_uc($) {
282 $self->new_img_from_file ($path)
283 }
284
285 sub load($) {
245 my ($path) = @_; 286 my ($path) = @_;
246 287
247 $_IMG_CACHE{$path} || do { 288 $_IMG_CACHE{$path} || do {
248 my $img = $self->new_img_from_file ($path); 289 my $img = load_uc $path;
249 Scalar::Util::weaken ($_IMG_CACHE{$path} = $img); 290 Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
250 $img 291 $img
251 } 292 }
252 } 293 }
253 294
254 sub load($) {
255 my ($path) = @_;
256
257 $new->{load}{$path} = $old->{load}{$path} || load_uc $path;
258 }
259
260=item root 295=item root
261 296
262Returns the root window pixmap, that is, hopefully, the background image 297Returns the root window pixmap, that is, hopefully, the background image
263of your screen. The image is set to extend mode. 298of your screen.
264 299
265This function makes your expression root sensitive, that means it will be 300This function makes your expression root sensitive, that means it will be
266reevaluated when the bg image changes. 301reevaluated when the bg image changes.
267 302
268=cut 303=cut
269 304
270 sub root() { 305 sub root() {
271 $new->{again}{rootpmap} = 1; 306 $frame->[FR_AGAIN]{rootpmap} = 1;
272 $self->new_img_from_root 307 $self->new_img_from_root
273 } 308 }
274 309
275=item solid $colour 310=item solid $colour
276 311
304 } 339 }
305 340
306=item merge $img ... 341=item merge $img ...
307 342
308Takes any number of images and merges them together, creating a single 343Takes any number of images and merges them together, creating a single
309image containing them all. 344image containing them all. The tiling mode of the first image is used as
345the tiling mdoe of the resulting image.
346
347This function is called automatically when an expression returns multiple
348images.
310 349
311=cut 350=cut
312 351
313 sub merge(@) { 352 sub merge(@) {
353 return $_[0] unless $#_;
354
314 # rather annoyingly clumsy, but optimisation is for another time 355 # rather annoyingly clumsy, but optimisation is for another time
315 356
316 my $x0 = +1e9; 357 my $x0 = +1e9;
317 my $y0 = +1e9; 358 my $y0 = +1e9;
318 my $x1 = -1e9; 359 my $x1 = -1e9;
330 $x1 = $x if $x1 < $x; 371 $x1 = $x if $x1 < $x;
331 $y1 = $y if $y1 < $y; 372 $y1 = $y if $y1 < $y;
332 } 373 }
333 374
334 my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0); 375 my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
376 $base->repeat_mode ($_[0]->repeat_mode);
335 $base->fill ([0, 0, 0, 0]); 377 $base->fill ([0, 0, 0, 0]);
336 378
337 $base->draw ($_) 379 $base->draw ($_)
338 for @_; 380 for @_;
339 381
443Using these functions make your expression sensitive to window moves. 485Using these functions make your expression sensitive to window moves.
444 486
445These functions are mainly useful to align images to the root window. 487These functions are mainly useful to align images to the root window.
446 488
447Example: load an image and align it so it looks as if anchored to the 489Example: load an image and align it so it looks as if anchored to the
448background. 490background (that's exactly what C<rootalign> does btw.):
449 491
450 move -TX, -TY, load "mybg.png" 492 move -TX, -TY, keep { load "mybg.png" }
451 493
452=item TW 494=item TW
453 495
454Return the width (C<TW>) and height (C<TH>) of the terminal window (the 496Return the width (C<TW>) and height (C<TH>) of the terminal window (the
455terminal window is the full window by default, and the character area only 497terminal window is the full window by default, and the character area only
461the window size to conserve memory. 503the window size to conserve memory.
462 504
463Example: take the screen background, clip it to the window size, blur it a 505Example: take the screen background, clip it to the window size, blur it a
464bit, align it to the window position and use it as background. 506bit, align it to the window position and use it as background.
465 507
466 clip move -TX, -TY, once { blur 5, root } 508 clip move -TX, -TY, keep { blur 5, root }
467 509
468=cut 510=cut
469 511
470 sub TX() { $new->{again}{position} = 1; $x } 512 sub TX() { $frame->[FR_AGAIN]{position} = 1; $x }
471 sub TY() { $new->{again}{position} = 1; $y } 513 sub TY() { $frame->[FR_AGAIN]{position} = 1; $y }
472 sub TW() { $new->{again}{size} = 1; $w } 514 sub TW() { $frame->[FR_AGAIN]{size} = 1; $w }
473 sub TH() { $new->{again}{size} = 1; $h } 515 sub TH() { $frame->[FR_AGAIN]{size} = 1; $h }
474 516
475=item now 517=item now
476 518
477Returns the current time as (fractional) seconds since the epoch. 519Returns the current time as (fractional) seconds since the epoch.
478 520
485C<$seconds> seconds. 527C<$seconds> seconds.
486 528
487Example: load some image and rotate it according to the time of day (as if it were 529Example: load some image and rotate it according to the time of day (as if it were
488the hour pointer of a clock). Update this image every minute. 530the hour pointer of a clock). Update this image every minute.
489 531
532 again 60;
490 again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png" 533 rotate 50, 50, (now % 86400) * -72 / 8640, scale keep { load "myclock.png" }
491 534
492=item counter $seconds 535=item counter $seconds
493 536
494Like C<again>, but also returns an increasing counter value, starting at 537Like C<again>, but also returns an increasing counter value, starting at
4950, which might be useful for some simple animation effects. 5380, which might be useful for some simple animation effects.
497=cut 540=cut
498 541
499 sub now() { urxvt::NOW } 542 sub now() { urxvt::NOW }
500 543
501 sub again($) { 544 sub again($) {
502 $new->{again}{time} = $_[0]; 545 $frame->[FR_AGAIN]{time} = $_[0];
503 } 546 }
504 547
505 sub counter($) { 548 sub counter($) {
506 $new->{again}{time} = $_[0]; 549 $frame->[FR_AGAIN]{time} = $_[0];
507 $self->{counter} + 0 550 $frame->[FR_STATE]{counter} + 0
508 } 551 }
509 552
510=back 553=back
511 554
512=head2 SHAPE CHANGING OPERATORS 555=head2 SHAPE CHANGING OPERATORS
532assumed. 575assumed.
533 576
534Example: load an image, blur it, and clip it to the window size to save 577Example: load an image, blur it, and clip it to the window size to save
535memory. 578memory.
536 579
537 clip blur 10, load "mybg.png" 580 clip keep { blur 10, load "mybg.png" }
538 581
539=cut 582=cut
540 583
541 sub clip($;$$;$$) { 584 sub clip($;$$;$$) {
542 my $img = pop; 585 my $img = pop;
636the terminal window (or the box specified by C<$width> and C<$height> if 679the terminal window (or the box specified by C<$width> and C<$height> if
637given). 680given).
638 681
639Example: load an image and center it. 682Example: load an image and center it.
640 683
641 center pad load "mybg.png" 684 center keep { pad load "mybg.png" }
642 685
643=item rootalign $img 686=item rootalign $img
644 687
645Moves the image so that it appears glued to the screen as opposed to the 688Moves the image so that it appears glued to the screen as opposed to the
646window. This gives the illusion of a larger area behind the window. It is 689window. This gives the illusion of a larger area behind the window. It is
647exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the 690exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
648top left of the screen. 691top left of the screen.
649 692
650Example: load a background image, put it in mirror mode and root align it. 693Example: load a background image, put it in mirror mode and root align it.
651 694
652 rootalign mirror load "mybg.png" 695 rootalign keep { mirror load "mybg.png" }
653 696
654Example: take the screen background and align it, giving the illusion of 697Example: take the screen background and align it, giving the illusion of
655transparency as long as the window isn't in front of other windows. 698transparency as long as the window isn't in front of other windows.
656 699
657 rootalign root 700 rootalign root
682 725
683 sub rootalign($) { 726 sub rootalign($) {
684 move -TX, -TY, $_[0] 727 move -TX, -TY, $_[0]
685 } 728 }
686 729
687=item rotate $center_x, $center_y, $degrees 730=item rotate $center_x, $center_y, $degrees, $img
688 731
689Rotates the image by C<$degrees> degrees, counter-clockwise, around the 732Rotates the image clockwise by C<$degrees> degrees, around the point at
690pointer at C<$center_x> and C<$center_y> (specified as factor of image 733C<$center_x> and C<$center_y> (specified as factor of image width/height).
691width/height).
692 734
693#TODO# new width, height, maybe more operators?
694
695Example: rotate the image by 90 degrees 735Example: rotate the image by 90 degrees around it's center.
736
737 rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
696 738
697=cut 739=cut
698 740
699 sub rotate($$$$) { 741 sub rotate($$$$) {
700 my $img = pop; 742 my $img = pop;
812 854
813The trick is that this code block is only evaluated once - future calls 855The trick is that this code block is only evaluated once - future calls
814will simply return the original image (yes, it should only be used with 856will simply return the original image (yes, it should only be used with
815images). 857images).
816 858
817This can be extremely useful to avoid redoign the same slow operations 859This can be extremely useful to avoid redoing the same slow operations
818again and again- for example, if your background expression takes the root 860again and again- for example, if your background expression takes the root
819background, blurs it and then root-aligns it it would have to blur the 861background, blurs it and then root-aligns it it would have to blur the
820root background on every window move or resize. 862root background on every window move or resize.
821 863
864In fact, urxvt itself encloses the whole expression in some kind of
865C<once> block so it only is reevaluated as required.
866
822Putting the blur into a C<once> block will make sure the blur is only done 867Putting the blur into a C<once> block will make sure the blur is only done
823once: 868once:
824 869
825 rootlign once { blur 10, root } 870 rootlign once { blur 10, root }
826 871
827This leaves the question of how to force reevaluation of the block, in 872This leaves the question of how to force reevaluation of the block,
828case the root background changes: Right now, all once blocks forget that 873in case the root background changes: If expression inside the block
829they ahve been executed before each time the root background changes (if 874is sensitive to some event (root background changes, window geometry
830the expression is sensitive to that) or when C<once_again> is called. 875changes), then it will be reevaluated automatically as needed.
831 876
832=item once_again 877=item once_again
833 878
834Resets all C<once> block as if they had never been called, i.e. on the 879Resets all C<once> block as if they had never been called, i.e. on the
835next call they will be reevaluated again. 880next call they will be reevaluated again.
836 881
837=cut 882=cut
838 883
839 sub once(&) { 884 sub once(&) {
840 my $once = $self->{once_cache}{$_[0]+0} ||= do { 885 my $id = $_[0]+0;
841 local $new->{again}; 886
842 my @res = $_[0](); 887 local $frame = $self->{frame_cache}{$id} ||= [$frame];
843 [$new->{again}, \@res] 888
889 unless ($frame->[FR_CACHE]) {
890 $frame->[FR_CACHE] = [ $_[0]() ];
891
892 my $self = $self;
893 my $frame = $frame;
894 Scalar::Util::weaken $frame;
895 $self->compile_frame ($frame, sub {
896 # clear this frame cache, also for all parents
897 for (my $frame = $frame; $frame; $frame = $frame->[0]) {
898 undef $frame->[FR_CACHE];
899 }
900
901 $self->recalculate;
844 }; 902 });
845
846 $new->{again} = {
847 %{ $new->{again} },
848 %{ $once->[0] }
849 }; 903 };
850 904
851 # in scalar context we always return the first original result, which 905 # in scalar context we always return the first original result, which
852 # is not quite how perl works. 906 # is not quite how perl works.
853 wantarray 907 wantarray
854 ? @{ $once->[1] } 908 ? @{ $frame->[FR_CACHE] }
855 : $once->[1][0] 909 : $frame->[FR_CACHE][0]
856 } 910 }
857 911
858 sub once_again() { 912 sub once_again() {
859 delete $self->{once_cache}; 913 delete $self->{frame_cache};
860 } 914 }
861 915
862=back 916=back
863 917
864=cut 918=cut
865 919
866} 920}
867 921
868sub parse_expr { 922sub parse_expr {
869 my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}"; 923 my $expr = eval
924 "sub {\n"
925 . "package urxvt::bgdsl;\n"
926 . "#line 0 'background expression'\n"
927 . "$_[0]\n"
928 . "}";
870 die if $@; 929 die if $@;
871 $expr 930 $expr
872} 931}
873 932
874# compiles a parsed expression 933# compiles a parsed expression
875sub set_expr { 934sub set_expr {
876 my ($self, $expr) = @_; 935 my ($self, $expr) = @_;
877 936
937 $self->{root} = [];
878 $self->{expr} = $expr; 938 $self->{expr} = $expr;
879 $self->recalculate; 939 $self->recalculate;
940}
941
942# takes a hash of sensitivity indicators and installs watchers
943sub compile_frame {
944 my ($self, $frame, $cb) = @_;
945
946 my $state = $frame->[urxvt::bgdsl::FR_STATE] ||= {};
947 my $again = $frame->[urxvt::bgdsl::FR_AGAIN];
948
949 # don't keep stuff alive
950 Scalar::Util::weaken $state;
951
952 if ($again->{nested}) {
953 $state->{nested} = 1;
954 } else {
955 delete $state->{nested};
956 }
957
958 if (my $interval = $again->{time}) {
959 $state->{time} = [$interval, urxvt::timer->new->after ($interval)->interval ($interval)]
960 if $state->{time}[0] != $interval;
961
962 # callback *might* have changed, although we could just rule that out
963 $state->{time}[1]->cb (sub {
964 ++$state->{counter};
965 $cb->();
966 });
967 } else {
968 delete $state->{time};
969 }
970
971 if ($again->{position}) {
972 $state->{position} = $self->on (position_change => $cb);
973 } else {
974 delete $state->{position};
975 }
976
977 if ($again->{size}) {
978 $state->{size} = $self->on (size_change => $cb);
979 } else {
980 delete $state->{size};
981 }
982
983 if ($again->{rootpmap}) {
984 $state->{rootpmap} = $self->on (rootpmap_change => $cb);
985 } else {
986 delete $state->{rootpmap};
987 }
880} 988}
881 989
882# evaluate the current bg expression 990# evaluate the current bg expression
883sub recalculate { 991sub recalculate {
884 my ($arg_self) = @_; 992 my ($arg_self) = @_;
894 1002
895 $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; 1003 $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
896 1004
897 # set environment to evaluate user expression 1005 # set environment to evaluate user expression
898 1006
899 local $self = $arg_self; 1007 local $self = $arg_self;
900
901 local $HOME = $ENV{HOME}; 1008 local $HOME = $ENV{HOME};
902 local $old = $self->{state}; 1009 local $frame = [];
903 local $new = my $state = $self->{state} = {};
904 1010
905 ($x, $y, $w, $h) =
906 $self->background_geometry ($self->{border}); 1011 ($x, $y, $w, $h) = $self->background_geometry ($self->{border});
907 1012
908 # evaluate user expression 1013 # evaluate user expression
909 1014
910 my $img = eval { $self->{expr}->() }; 1015 my @img = eval { $self->{expr}->() };
911 warn $@ if $@;#d# 1016 die $@ if $@;
912 die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img"; 1017 die "background-expr did not return anything.\n" unless @img;
1018 die "background-expr: expected image(s), got something else.\n"
1019 if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;
1020
1021 my $img = urxvt::bgdsl::merge @img;
1022
1023 $frame->[FR_AGAIN]{size} = 1
1024 if $img->repeat_mode != urxvt::RepeatNormal;
913 1025
914 # if the expression is sensitive to external events, prepare reevaluation then 1026 # if the expression is sensitive to external events, prepare reevaluation then
915 1027 $self->compile_frame ($frame, sub { $arg_self->recalculate });
916 my $again = delete $state->{again};
917
918 $again->{size} = 1
919 if $img->repeat_mode != urxvt::RepeatNormal;
920
921 if (my $again = $again->{time}) {
922 my $self = $self;
923 $state->{timer} = $again == $old->{again}
924 ? $old->{timer}
925 : urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
926 ++$self->{counter};
927 $self->recalculate
928 });
929 }
930
931 if ($again->{position}) {
932 $self->enable (position_change => sub { $_[0]->recalculate });
933 } else {
934 $self->disable ("position_change");
935 }
936
937 if ($again->{size}) {
938 $self->enable (size_change => sub { $_[0]->recalculate });
939 } else {
940 $self->disable ("size_change");
941 }
942
943 if ($again->{rootpmap}) {
944 $self->enable (rootpmap_change => sub {
945 delete $_[0]{once_cache}; # this will override once-block values from
946 $_[0]->recalculate;
947 });
948 } else {
949 $self->disable ("rootpmap_change");
950 }
951 1028
952 # clear stuff we no longer need 1029 # clear stuff we no longer need
953 1030
954 %$old = (); 1031# unless (%{ $frame->[FR_STATE] }) {
955
956 unless (%$again) {
957 delete $self->{state}; 1032# delete $self->{state};
958 delete $self->{expr}; 1033# delete $self->{expr};
959 } 1034# }
960 1035
961 # set background pixmap 1036 # set background pixmap
962 1037
963 $self->set_background ($img, $self->{border}); 1038 $self->set_background ($img, $self->{border});
964 $self->scr_recolour (0); 1039 $self->scr_recolour (0);

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines