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.32 by sf-exg, Thu Jun 7 13:56:27 2012 UTC vs.
Revision 1.45 by root, Sun Jun 10 11:53:32 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:%.enable:boolean:some boolean 4#:META:X_RESOURCE:%.border.:boolean:respect the terminal border
5#:META:X_RESOURCE:%.extra.:value:extra config
6 5
7our $EXPR; 6#TODO: once, rootalign
8#$EXPR = 'move W * 0.1, -H * 0.1, resize W * 0.5, H * 0.5, repeat_none load "opensource.png"';
9$EXPR = 'move -TX, -TY, load "argb.png"';
10#$EXPR = '
11# rotate W, H, 50, 50, counter 1/59.95, repeat_mirror,
12# clip X, Y, W, H, repeat_mirror,
13# load "/root/pix/das_fette_schwein.jpg"
14#';
15#$EXPR = 'solid "red"';
16#$EXPR = 'blur root, 10, 10'
17#$EXPR = 'blur move (root, -x, -y), 5, 5'
18#resize load "/root/pix/das_fette_schwein.jpg", w, h
19 7
20use Safe; 8=head1 NAME
21 9
10 background - manage terminal background
11
12=head1 SYNOPSIS
13
14 urxvt --background-expr 'background expression'
15 --background-border
16
17=head1 DESCRIPTION
18
19This extension manages the terminal background by creating a picture that
20is behind the text, replacing the normal background colour.
21
22It does so by evaluating a Perl expression that I<calculates> the image on
23the fly, for example, by grabbing the root background or loading a file.
24
25While the full power of Perl is available, the operators have been design
26to be as simple as possible.
27
28For example, to load an image and scale it to the window size, you would
29use:
30
31 urxvt --background-expr 'scale load "/path/to/mybg.png"'
32
33Or specified as a X resource:
34
35 URxvt.background-expr: scale load "/path/to/mybg.png"
36
37=head1 THEORY OF OPERATION
38
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
41extended as necessary to cover the whole terminal window, and is set as a
42background pixmap.
43
44If the image contains an alpha channel, then it will be used as-is in
45visuals that support alpha channels (for example, for a compositing
46manager). In other visuals, the terminal background colour will be used to
47replace any transparency.
48
49When the expression relies, directly or indirectly, on the window size,
50position, the root pixmap, or a timer, then it will be remembered. If not,
51then it will be removed.
52
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
55pixmap is replaced by another one the root background changes; or when the
56timer elapses), then the expression will be evaluated again.
57
58For example, an expression such as C<scale load "$HOME/mybg.png"> scales the
59image to the window size, so it relies on the window size and will
60be reevaluated each time it is changed, but not when it moves for
61example. That ensures that the picture always fills the terminal, even
62after it's size changes.
63
64=head2 EXPRESSIONS
65
66Expressions are normal Perl expressions, in fact, they are Perl blocks -
67which means you could use multiple lines and statements:
68
69 again 3600;
70 if (localtime now)[6]) {
71 return scale load "$HOME/weekday.png";
72 } else {
73 return scale load "$HOME/sunday.png";
74 }
75
76This expression gets evaluated once per hour. It will set F<sunday.png> as
77background on Sundays, and F<weekday.png> on all other days.
78
79Fortunately, we expect that most expressions will be much simpler, with
80little Perl knowledge needed.
81
82Basically, you always start with a function that "generates" an image
83object, such as C<load>, which loads an image from disk, or C<root>, which
84returns the root window background image:
85
86 load "$HOME/mypic.png"
87
88The path is usually specified as a quoted string (the exact rules can be
89found in the L<perlop> manpage). The F<$HOME> at the beginning of the
90string is expanded to the home directory.
91
92Then you prepend one or more modifiers or filtering expressions, such as
93C<scale>:
94
95 scale load "$HOME/mypic.png"
96
97Just like a mathematical expression with functions, you should read these
98expressions from right to left, as the C<load> is evaluated first, and
99its result becomes the argument to the C<scale> function.
100
101Many operators also allow some parameters preceding the input image
102that modify its behaviour. For example, C<scale> without any additional
103arguments scales the image to size of the terminal window. If you specify
104an additional argument, it uses it as a scale factor (multiply by 100 to
105get a percentage):
106
107 scale 2, load "$HOME/mypic.png"
108
109This enlarges the image by a factor of 2 (200%). As you can see, C<scale>
110has now two arguments, the C<200> and the C<load> expression, while
111C<load> only has one argument. Arguments are separated from each other by
112commas.
113
114Scale also accepts two arguments, which are then separate factors for both
115horizontal and vertical dimensions. For example, this halves the image
116width and doubles the image height:
117
118 scale 0.5, 2, load "$HOME/mypic.png"
119
120Other effects than scalign are also readily available, for exmaple, you can
121tile the image to fill the whole window, instead of resizing it:
122
123 tile load "$HOME/mypic.png"
124
125In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator
126is kind of superfluous.
127
128Another common effect is to mirror the image, so that the same edges touch:
129
130 mirror load "$HOME/mypic.png"
131
132This is also a typical background expression:
133
134 rootalign root
135
136It first takes a snapshot of the screen background image, and then
137moves it to the upper left corner of the screen - the result is
138pseudo-transparency, as the image seems to be static while the window is
139moved around.
140
141=head2 CYCLES AND CACHING
142
143As has been mentioned before, the expression might be evaluated multiple
144times. Each time the expression is reevaluated, a new cycle is said to
145have begun. Many operators cache their results till the next cycle.
146
147For example, the C<load> operator keeps a copy of the image. If it is
148asked to load the same image on the next cycle it will not load it again,
149but return the cached copy.
150
151This only works for one cycle though, so as long as you load the same
152image every time, it will always be cached, but when you load a different
153image, it will forget about the first one.
154
155This allows you to either speed things up by keeping multiple images in
156memory, or comserve memory by loading images more often.
157
158For example, you can keep two images in memory and use a random one like
159this:
160
161 my $img1 = load "img1.png";
162 my $img2 = load "img2.png";
163 (0.5 > rand) ? $img1 : $img2
164
165Since both images are "loaded" every time the expression is evaluated,
166they are always kept in memory. Contrast this version:
167
168 my $path1 = "img1.png";
169 my $path2 = "img2.png";
170 load ((0.5 > rand) ? $path1 : $path2)
171
172Here, a path is selected randomly, and load is only called for one image,
173so keeps only one image in memory. If, on the next evaluation, luck
174decides to use the other path, then it will have to load that image again.
175
176=head1 REFERENCE
177
178=head2 COMMAND LINE SWITCHES
179
180=over 4
181
182=item --background-expr perl-expression
183
184Specifies the Perl expression to evaluate.
185
186=item --background-border
187
188By default, the expression creates an image that fills the full window,
189overwriting borders and any other areas, such as the scrollbar.
190
191Specifying this flag changes the behaviour, so that the image only
192replaces the background of the character area.
193
194=back
195
196=cut
197
198our $HOME;
22our ($bgdsl_self, $old, $new); 199our ($self, $old, $new);
23our ($x, $y, $w, $h); 200our ($x, $y, $w, $h);
24 201
25# enforce at least this interval between updates 202# enforce at least this interval between updates
26our $MIN_INTERVAL = 1/100; 203our $MIN_INTERVAL = 1/100;
27 204
28{ 205{
29 package urxvt::bgdsl; # background language 206 package urxvt::bgdsl; # background language
207
208 use List::Util qw(min max sum shuffle);
30 209
31=head2 PROVIDERS/GENERATORS 210=head2 PROVIDERS/GENERATORS
32 211
33These functions provide an image, by loading it from disk, grabbing it 212These functions provide an image, by loading it from disk, grabbing it
34from the root screen or by simply generating it. They are used as starting 213from the root screen or by simply generating it. They are used as starting
46=cut 225=cut
47 226
48 sub load($) { 227 sub load($) {
49 my ($path) = @_; 228 my ($path) = @_;
50 229
51 $new->{load}{$path} = $old->{load}{$path} || $bgdsl_self->new_img_from_file ($path); 230 $new->{load}{$path} = $old->{load}{$path} || $self->new_img_from_file ($path);
52 } 231 }
53 232
54=item root 233=item root
55 234
56Returns the root window pixmap, that is, hopefully, the background image 235Returns the root window pixmap, that is, hopefully, the background image
71=item solid $width, $height, $colour 250=item solid $width, $height, $colour
72 251
73Creates a new image and completely fills it with the given colour. The 252Creates a new image and completely fills it with the given colour. The
74image is set to tiling mode. 253image is set to tiling mode.
75 254
76If <$width> and C<$height> are omitted, it creates a 1x1 image, which is 255If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is
77useful for solid backgrounds or for use in filtering effects. 256useful for solid backgrounds or for use in filtering effects.
78 257
79=cut 258=cut
80 259
81 sub solid($$;$) { 260 sub solid($;$$) {
82 my $colour = pop; 261 my $colour = pop;
83 262
84 my $img = $bgdsl_self->new_img (urxvt::PictStandardARGB32, $_[0] || 1, $_[1] || 1); 263 my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] || 1, $_[1] || 1);
85 $img->fill ($colour); 264 $img->fill ($colour);
86 $img 265 $img
87 } 266 }
88 267
268=item clone $img
269
270Returns an exact copy of the image. This is useful if you want to have
271multiple copies of the same image to apply different effects to.
272
273=cut
274
275 sub clone($) {
276 $_[0]->clone
277 }
278
89=back 279=back
90 280
281=head2 TILING MODES
282
283The following operators modify the tiling mode of an image, that is, the
284way that pixels outside the image area are painted when the image is used.
285
286=over 4
287
288=item tile $img
289
290Tiles the whole plane with the image and returns this new image - or in
291other words, it returns a copy of the image in plane tiling mode.
292
293Example: load an image and tile it over the background, without
294resizing. The C<tile> call is superfluous because C<load> already defaults
295to tiling mode.
296
297 tile load "mybg.png"
298
299=item mirror $img
300
301Similar to tile, but reflects the image each time it uses a new copy, so
302that top edges always touch top edges, right edges always touch right
303edges and so on (with normal tiling, left edges always touch right edges
304and top always touch bottom edges).
305
306Example: load an image and mirror it over the background, avoiding sharp
307edges at the image borders at the expense of mirroring the image itself
308
309 mirror load "mybg.png"
310
311=item pad $img
312
313Takes an image and modifies it so that all pixels outside the image area
314become transparent. This mode is most useful when you want to place an
315image over another image or the background colour while leaving all
316background pixels outside the image unchanged.
317
318Example: load an image and display it in the upper left corner. The rest
319of the space is left "empty" (transparent or wahtever your compisotr does
320in alpha mode, else background colour).
321
322 pad load "mybg.png"
323
324=item extend $img
325
326Extends the image over the whole plane, using the closest pixel in the
327area outside the image. This mode is mostly useful when you more complex
328filtering operations and want the pixels outside the image to have the
329same values as the pixels near the edge.
330
331Example: just for curiosity, how does this pixel extension stuff work?
332
333 extend move 50, 50, load "mybg.png"
334
335=cut
336
337 sub pad($) {
338 my $img = $_[0]->clone;
339 $img->repeat_mode (urxvt::RepeatNone);
340 $img
341 }
342
343 sub tile($) {
344 my $img = $_[0]->clone;
345 $img->repeat_mode (urxvt::RepeatNormal);
346 $img
347 }
348
349 sub mirror($) {
350 my $img = $_[0]->clone;
351 $img->repeat_mode (urxvt::RepeatReflect);
352 $img
353 }
354
355 sub extend($) {
356 my $img = $_[0]->clone;
357 $img->repeat_mode (urxvt::RepeatPad);
358 $img
359 }
360
361=back
362
91=head2 VARIABLES 363=head2 VARIABLE VALUES
92 364
93The following functions provide variable data such as the terminal 365The following functions provide variable data such as the terminal window
366dimensions. They are not (Perl-) variables, they just return stuff that
94window dimensions. Most of them make your expression sensitive to some 367varies. Most of them make your expression sensitive to some events, for
95events, for example using C<TW> (terminal width) means your expression is 368example using C<TW> (terminal width) means your expression is evaluated
96evaluated again when the terminal is resized. 369again when the terminal is resized.
97 370
98=over 4 371=over 4
99 372
100=item TX 373=item TX
101 374
135 sub TX() { $new->{position_sensitive} = 1; $x } 408 sub TX() { $new->{position_sensitive} = 1; $x }
136 sub TY() { $new->{position_sensitive} = 1; $y } 409 sub TY() { $new->{position_sensitive} = 1; $y }
137 sub TW() { $new->{size_sensitive} = 1; $w } 410 sub TW() { $new->{size_sensitive} = 1; $w }
138 sub TH() { $new->{size_sensitive} = 1; $h } 411 sub TH() { $new->{size_sensitive} = 1; $h }
139 412
413=item now
414
415Returns the current time as (fractional) seconds since the epoch.
416
417Using this expression does I<not> make your expression sensitive to time,
418but the next two functions do.
419
420=item again $seconds
421
422When this function is used the expression will be reevaluated again in
423C<$seconds> seconds.
424
425Example: load some image and rotate it according to the time of day (as if it were
426the hour pointer of a clock). Update this image every minute.
427
428 again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
429
430=item counter $seconds
431
432Like C<again>, but also returns an increasing counter value, starting at
4330, which might be useful for some simple animation effects.
434
435=cut
436
140 sub now() { urxvt::NOW } 437 sub now() { urxvt::NOW }
141 438
142 sub again($) { 439 sub again($) {
143 $new->{again} = $_[0]; 440 $new->{again} = $_[0];
144 } 441 }
145 442
146 sub counter($) { 443 sub counter($) {
147 $new->{again} = $_[0]; 444 $new->{again} = $_[0];
148 $bgdsl_self->{counter} + 0 445 $self->{counter} + 0
149 } 446 }
150 447
151=back 448=back
152 449
153=head2 TILING MODES 450=head2 SHAPE CHANGING OPERATORS
154 451
155The following operators modify the tiling mode of an image, that is, the 452The following operators modify the shape, size or position of the image.
156way that pixels outside the image area are painted when the image is used.
157 453
158=over 4 454=over 4
159
160=item tile $img
161
162Tiles the whole plane with the image and returns this new image - or in
163other words, it returns a copy of the image in plane tiling mode.
164
165=item mirror $img
166
167Similar to tile, but reflects the image each time it uses a new copy, so
168that top edges always touch top edges, right edges always touch right
169edges and so on (with normal tiling, left edges always touch right edges
170and top always touch bottom edges).
171
172=item pad $img
173
174Takes an image and modifies it so that all pixels outside the image area
175become transparent. This mode is most useful when you want to place an
176image over another image or the background colour while leaving all
177background pixels outside the image unchanged.
178
179=item extend $img
180
181Extends the image over the whole plane, using the closest pixel in the
182area outside the image. This mode is mostly useful when you more complex
183filtering operations and want the pixels outside the image to have the
184same values as the pixels near the edge.
185
186=cut
187
188 sub pad($) {
189 my $img = $_[0]->clone;
190 $img->repeat_mode (urxvt::RepeatNone);
191 $img
192 }
193
194 sub tile($) {
195 my $img = $_[0]->clone;
196 $img->repeat_mode (urxvt::RepeatNormal);
197 $img
198 }
199
200 sub mirror($) {
201 my $img = $_[0]->clone;
202 $img->repeat_mode (urxvt::RepeatReflect);
203 $img
204 }
205
206 sub extend($) {
207 my $img = $_[0]->clone;
208 $img->repeat_mode (urxvt::RepeatPad);
209 $img
210 }
211
212=back
213
214=head2 PIXEL OPERATORS
215
216The following operators modify the image pixels in various ways.
217
218=over 4
219
220=item clone $img
221
222Returns an exact copy of the image.
223
224=cut
225
226 sub clone($) {
227 $_[0]->clone
228 }
229 455
230=item clip $img 456=item clip $img
231 457
232=item clip $width, $height, $img 458=item clip $width, $height, $img
233 459
257 $img->sub_rect ($_[0], $_[1], $w, $h) 483 $img->sub_rect ($_[0], $_[1], $w, $h)
258 } 484 }
259 485
260=item scale $img 486=item scale $img
261 487
262=item scale $size_percent, $img 488=item scale $size_factor, $img
263 489
264=item scale $width_percent, $height_percent, $img 490=item scale $width_factor, $height_factor, $img
265 491
266Scales the image by the given percentages in horizontal 492Scales the image by the given factors in horizontal
267(C<$width_percent>) and vertical (C<$height_percent>) direction. 493(C<$width>) and vertical (C<$height>) direction.
268 494
269If only one percentage is give, it is used for both directions. 495If only one factor is give, it is used for both directions.
270 496
271If no percentages are given, scales the image to the window size without 497If no factors are given, scales the image to the window size without
272keeping aspect. 498keeping aspect.
273 499
274=item resize $width, $height, $img 500=item resize $width, $height, $img
275 501
276Resizes the image to exactly C<$width> times C<$height> pixels. 502Resizes the image to exactly C<$width> times C<$height> pixels.
277 503
278=cut 504=item fit $img
279 505
280#TODO: maximise, maximise_fill? 506=item fit $width, $height, $img
281 507
508Fits the image into the given C<$width> and C<$height> without changing
509aspect, or the terminal size. That means it will be shrunk or grown until
510the whole image fits into the given area, possibly leaving borders.
511
512=item cover $img
513
514=item cover $width, $height, $img
515
516Similar to C<fit>, but shrinks or grows until all of the area is covered
517by the image, so instead of potentially leaving borders, it will cut off
518image data that doesn't fit.
519
520=cut
521
282 sub scale($$$) { 522 sub scale($;$;$) {
283 my $img = pop; 523 my $img = pop;
284 524
285 @_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01) 525 @_ == 2 ? $img->scale ($_[0] * $img->w, $_[1] * $img->h)
286 : @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01) 526 : @_ ? $img->scale ($_[0] * $img->w, $_[0] * $img->h)
287 : $img->scale (TW, TH) 527 : $img->scale (TW, TH)
288 } 528 }
289 529
290 sub resize($$$) { 530 sub resize($$$) {
291 my $img = pop; 531 my $img = pop;
292 $img->scale ($_[0], $_[1]) 532 $img->scale ($_[0], $_[1])
293 } 533 }
534
535 sub fit($;$$) {
536 my $img = pop;
537 my $w = ($_[0] || TW) / $img->w;
538 my $h = ($_[1] || TH) / $img->h;
539 scale +(min $w, $h), $img
540 }
541
542 sub cover($;$$) {
543 my $img = pop;
544 my $w = ($_[0] || TW) / $img->w;
545 my $h = ($_[1] || TH) / $img->h;
546 scale +(max $w, $h), $img
547 }
548
549=item move $dx, $dy, $img
550
551Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in
552the vertical.
553
554Example: move the image right by 20 pixels and down by 30.
555
556 move 20, 30, ...
557
558=item center $img
559
560=item center $width, $height, $img
561
562Centers the image, i.e. the center of the image is moved to the center of
563the terminal window (or the box specified by C<$width> and C<$height> if
564given).
565
566=item rootalign $img
567
568Moves the image so that it appears glued to the screen as opposed to the
569window. This gives the illusion of a larger area behind the window. It is
570exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
571top left of the screen.
572
573Example: load a background image, put it in mirror mode and root align it.
574
575 rootalign mirror load "mybg.png"
576
577Example: take the screen background and align it, giving the illusion of
578transparency as long as the window isn't in front of other windows.
579
580 rootalign root
581
582=cut
294 583
295 sub move($$;$) { 584 sub move($$;$) {
296 my $img = pop->clone; 585 my $img = pop->clone;
297 $img->move ($_[0], $_[1]); 586 $img->move ($_[0], $_[1]);
298 $img 587 $img
299 } 588 }
300 589
590 sub center($;$$) {
591 my $img = pop;
592 my $w = $_[0] || TW;
593 my $h = $_[0] || TH;
594
595 move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img
596 }
597
598 sub rootalign($) {
599 move -TX, -TY, $_[0]
600 }
601
602=back
603
604=head2 COLOUR MODIFICATIONS
605
606The following operators change the pixels of the image.
607
608=over 4
609
610=item contrast $factor, $img
611
612=item contrast $r, $g, $b, $img
613
614=item contrast $r, $g, $b, $a, $img
615
616Adjusts the I<contrast> of an image.
617
618The first form applies a single C<$factor> to red, green and blue, the
619second form applies separate factors to each colour channel, and the last
620form includes the alpha channel.
621
622Values from 0 to 1 lower the contrast, values higher than 1 increase the
623contrast.
624
625Due to limitations in the underlying XRender extension, lowering contrast
626also reduces brightness, while increasing contrast currently also
627increases brightness.
628
629=item brightness $bias, $img
630
631=item brightness $r, $g, $b, $img
632
633=item brightness $r, $g, $b, $a, $img
634
635Adjusts the brightness of an image.
636
637The first form applies a single C<$bias> to red, green and blue, the
638second form applies separate biases to each colour channel, and the last
639form includes the alpha channel.
640
641Values less than 0 reduce brightness, while values larger than 0 increase
642it. Useful range is from -1 to 1 - the former results in a black, the
643latter in a white picture.
644
645Due to idiosynchrasies in the underlying XRender extension, biases less
646than zero can be I<very> slow.
647
648=cut
649
650 sub contrast($$;$$;$) {
651 my $img = pop;
652 my ($r, $g, $b, $a) = @_;
653
654 ($g, $b) = ($r, $r) if @_ < 4;
655 $a = 1 if @_ < 5;
656
657 $img = $img->clone;
658 $img->contrast ($r, $g, $b, $a);
659 $img
660 }
661
662 sub brightness($$;$$;$) {
663 my $img = pop;
664 my ($r, $g, $b, $a) = @_;
665
666 ($g, $b) = ($r, $r) if @_ < 4;
667 $a = 1 if @_ < 5;
668
669 $img = $img->clone;
670 $img->brightness ($r, $g, $b, $a);
671 $img
672 }
673
674=item blur $radius, $img
675
676=item blur $radius_horz, $radius_vert, $img
677
678Gaussian-blurs the image with (roughly) C<$radius> pixel radius. The radii
679can also be specified separately.
680
681Blurring is often I<very> slow, at least compared or other
682operators. Larger blur radii are slower than smaller ones, too, so if you
683don't want to freeze your screen for long times, start experimenting with
684low values for radius (<5).
685
686=cut
687
688 sub blur($$;$) {
689 my $img = pop;
690 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
691 }
692
693=item rotate $new_width, $new_height, $center_x, $center_y, $degrees
694
695Rotates the image by C<$degrees> degrees, counter-clockwise, around the
696pointer at C<$center_x> and C<$center_y> (specified as factor of image
697width/height), generating a new image with width C<$new_width> and height
698C<$new_height>.
699
700#TODO# new width, height, maybe more operators?
701
702Example: rotate the image by 90 degrees
703
704=cut
705
301 sub rotate($$$$$$) { 706 sub rotate($$$$$$) {
302 my $img = pop; 707 my $img = pop;
303 $img->rotate ( 708 $img->rotate (
304 $_[0], 709 $_[0],
305 $_[1], 710 $_[1],
306 $_[2] * $img->w * .01, 711 $_[2] * $img->w,
307 $_[3] * $img->h * .01, 712 $_[3] * $img->h,
308 $_[4] * (3.14159265 / 180), 713 $_[4] * (3.14159265 / 180),
309 ) 714 )
310 }
311
312 sub blur($$;$) {
313 my $img = pop;
314 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
315 }
316
317 sub contrast($$;$$;$) {
318 my $img = pop;
319 my ($r, $g, $b, $a) = @_;
320
321 ($g, $b) = ($r, $r) if @_ < 4;
322 $a = 1 if @_ < 5;
323
324 $img = $img->clone;
325 $img->contrast ($r, $g, $b, $a);
326 $img
327 }
328
329 sub brightness($$;$$;$) {
330 my $img = pop;
331 my ($r, $g, $b, $a) = @_;
332
333 ($g, $b) = ($r, $r) if @_ < 4;
334 $a = 1 if @_ < 5;
335
336 $img = $img->clone;
337 $img->brightness ($r, $g, $b, $a);
338 $img
339 } 715 }
340 716
341=back 717=back
342 718
343=cut 719=cut
358 $self->recalculate; 734 $self->recalculate;
359} 735}
360 736
361# evaluate the current bg expression 737# evaluate the current bg expression
362sub recalculate { 738sub recalculate {
363 my ($self) = @_; 739 my ($arg_self) = @_;
364 740
365 # rate limit evaluation 741 # rate limit evaluation
366 742
367 if ($self->{next_refresh} > urxvt::NOW) { 743 if ($arg_self->{next_refresh} > urxvt::NOW) {
368 $self->{next_refresh_timer} = urxvt::timer->new->after ($self->{next_refresh} - urxvt::NOW)->cb (sub { 744 $arg_self->{next_refresh_timer} = urxvt::timer->new->after ($arg_self->{next_refresh} - urxvt::NOW)->cb (sub {
369 $self->recalculate; 745 $arg_self->recalculate;
370 }); 746 });
371 return; 747 return;
372 } 748 }
373 749
374 $self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; 750 $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
375 751
376 # set environment to evaluate user expression 752 # set environment to evaluate user expression
377 753
378 local $bgdsl_self = $self; 754 local $self = $arg_self;
379 755
756 local $HOME = $ENV{HOME};
380 local $old = $self->{state}; 757 local $old = $self->{state};
381 local $new = my $state = $self->{state} = {}; 758 local $new = my $state = $self->{state} = {};
382 759
383 my $border = 0; #d#
384
385 ($x, $y, $w, $h) = 760 ($x, $y, $w, $h) =
386 $self->background_geometry ($border); 761 $self->background_geometry ($self->{border});
387 762
388 # evaluate user expression 763 # evaluate user expression
389 764
390 my $img = eval { $self->{expr}->() }; 765 my $img = eval { $self->{expr}->() };
391 warn $@ if $@;#d# 766 warn $@ if $@;#d#
392 die if !UNIVERSAL::isa $img, "urxvt::img"; 767 die if !UNIVERSAL::isa $img, "urxvt::img";
393 768
769 $state->{size_sensitive} = 1
770 if $img->repeat_mode != urxvt::RepeatNormal;
771
394 # if the expression is sensitive to external events, prepare reevaluation then 772 # if the expression is sensitive to external events, prepare reevaluation then
395 773
396 my $repeat; 774 my $repeat;
397 775
398 if (my $again = $state->{again}) { 776 if (my $again = $state->{again}) {
399 $repeat = 1; 777 $repeat = 1;
778 my $self = $self;
400 $state->{timer} = $again == $old->{again} 779 $state->{timer} = $again == $old->{again}
401 ? $old->{timer} 780 ? $old->{timer}
402 : urxvt::timer->new->after ($again)->interval ($again)->cb (sub { 781 : urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
403 ++$self->{counter}; 782 ++$self->{counter};
404 $self->recalculate 783 $self->recalculate
433 unless ($repeat) { 812 unless ($repeat) {
434 delete $self->{state}; 813 delete $self->{state};
435 delete $self->{expr}; 814 delete $self->{expr};
436 } 815 }
437 816
438 # prepare and set background pixmap 817 # set background pixmap
439 818
440 $img = $img->sub_rect (0, 0, $w, $h)
441 if $img->w != $w || $img->h != $h;
442
443 $self->set_background ($img, $border); 819 $self->set_background ($img, $self->{border});
444 $self->scr_recolour (0); 820 $self->scr_recolour (0);
445 $self->want_refresh; 821 $self->want_refresh;
446} 822}
447 823
448sub on_start { 824sub on_start {
449 my ($self) = @_; 825 my ($self) = @_;
450 826
827 my $expr = $self->x_resource ("background.expr")
828 or return;
829
451 $self->set_expr (parse_expr $EXPR); 830 $self->set_expr (parse_expr $expr);
831 $self->{border} = $self->x_resource_boolean ("background.border");
452 832
453 () 833 ()
454} 834}
455 835

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines