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 | |
5 | #:META:X_RESOURCE:%.interval:seconds:minimum time between updates |
6 | #TODO: once, rootalign |
|
|
7 | |
6 | |
8 | =head1 NAME |
7 | =head1 NAME |
9 | |
8 | |
10 | background - manage terminal background |
9 | background - manage terminal background |
11 | |
10 | |
12 | =head1 SYNOPSIS |
11 | =head1 SYNOPSIS |
13 | |
12 | |
14 | urxvt --background-expr 'background expression' |
13 | urxvt --background-expr 'background expression' |
15 | --background-border |
14 | --background-border |
|
|
15 | --background-interval seconds |
|
|
16 | |
|
|
17 | =head1 QUICK AND DIRTY CHEAT SHEET |
|
|
18 | |
|
|
19 | Just load a random jpeg image and tile the background with it without |
|
|
20 | scaling or anything else: |
|
|
21 | |
|
|
22 | load "/path/to/img.jpg" |
|
|
23 | |
|
|
24 | The same, but use mirroring/reflection instead of tiling: |
|
|
25 | |
|
|
26 | mirror load "/path/to/img.jpg" |
|
|
27 | |
|
|
28 | Load an image and scale it to exactly fill the terminal window: |
|
|
29 | |
|
|
30 | scale keep { load "/path/to/img.jpg" } |
|
|
31 | |
|
|
32 | Implement pseudo-transparency by using a suitably-aligned root pixmap |
|
|
33 | as window background: |
|
|
34 | |
|
|
35 | rootalign root |
|
|
36 | |
|
|
37 | Likewise, but keep a blurred copy: |
|
|
38 | |
|
|
39 | rootalign keep { blur 10, root } |
16 | |
40 | |
17 | =head1 DESCRIPTION |
41 | =head1 DESCRIPTION |
18 | |
42 | |
19 | This extension manages the terminal background by creating a picture that |
43 | This extension manages the terminal background by creating a picture that |
20 | is behind the text, replacing the normal background colour. |
44 | is behind the text, replacing the normal background colour. |
… | |
… | |
26 | to be as simple as possible. |
50 | to be as simple as possible. |
27 | |
51 | |
28 | For example, to load an image and scale it to the window size, you would |
52 | For example, to load an image and scale it to the window size, you would |
29 | use: |
53 | use: |
30 | |
54 | |
31 | urxvt --background-expr 'scale load "/path/to/mybg.png"' |
55 | urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }' |
32 | |
56 | |
33 | Or specified as a X resource: |
57 | Or specified as a X resource: |
34 | |
58 | |
35 | URxvt.background-expr: scale load "/path/to/mybg.png" |
59 | URxvt.background-expr: scale keep { load "/path/to/mybg.png" } |
36 | |
60 | |
37 | =head1 THEORY OF OPERATION |
61 | =head1 THEORY OF OPERATION |
38 | |
62 | |
39 | At startup, just before the window is mapped for the first time, the |
63 | At startup, just before the window is mapped for the first time, the |
40 | expression is evaluated and must yield an image. The image is then |
64 | expression is evaluated and must yield an image. The image is then |
… | |
… | |
53 | If any of the parameters that the expression relies on changes (when the |
77 | If any of the parameters that the expression relies on changes (when the |
54 | window is moved or resized, its position or size changes; when the root |
78 | window is moved or resized, its position or size changes; when the root |
55 | pixmap is replaced by another one the root background changes; or when the |
79 | pixmap is replaced by another one the root background changes; or when the |
56 | timer elapses), then the expression will be evaluated again. |
80 | timer elapses), then the expression will be evaluated again. |
57 | |
81 | |
58 | For example, an expression such as C<scale load "$HOME/mybg.png"> scales the |
82 | For example, an expression such as C<scale keep { load "$HOME/mybg.png" |
59 | image to the window size, so it relies on the window size and will |
83 | }> scales the image to the window size, so it relies on the window size |
60 | be reevaluated each time it is changed, but not when it moves for |
84 | and will be reevaluated each time it is changed, but not when it moves for |
61 | example. That ensures that the picture always fills the terminal, even |
85 | example. That ensures that the picture always fills the terminal, even |
62 | after it's size changes. |
86 | after its size changes. |
63 | |
87 | |
64 | =head2 EXPRESSIONS |
88 | =head2 EXPRESSIONS |
65 | |
89 | |
66 | Expressions are normal Perl expressions, in fact, they are Perl blocks - |
90 | Expressions are normal Perl expressions, in fact, they are Perl blocks - |
67 | which means you could use multiple lines and statements: |
91 | which means you could use multiple lines and statements: |
68 | |
92 | |
|
|
93 | scale keep { |
69 | again 3600; |
94 | again 3600; |
70 | if (localtime now)[6]) { |
95 | if (localtime now)[6]) { |
71 | return scale load "$HOME/weekday.png"; |
96 | return load "$HOME/weekday.png"; |
72 | } else { |
97 | } else { |
73 | return scale load "$HOME/sunday.png"; |
98 | return load "$HOME/sunday.png"; |
|
|
99 | } |
74 | } |
100 | } |
75 | |
101 | |
76 | This expression gets evaluated once per hour. It will set F<sunday.png> as |
102 | This inner expression is evaluated once per hour (and whenever the |
|
|
103 | terminal window is resized). It sets F<sunday.png> as background on |
77 | background on Sundays, and F<weekday.png> on all other days. |
104 | Sundays, and F<weekday.png> on all other days. |
78 | |
105 | |
79 | Fortunately, we expect that most expressions will be much simpler, with |
106 | Fortunately, we expect that most expressions will be much simpler, with |
80 | little Perl knowledge needed. |
107 | little Perl knowledge needed. |
81 | |
108 | |
82 | Basically, you always start with a function that "generates" an image |
109 | Basically, you always start with a function that "generates" an image |
… | |
… | |
115 | horizontal and vertical dimensions. For example, this halves the image |
142 | horizontal and vertical dimensions. For example, this halves the image |
116 | width and doubles the image height: |
143 | width and doubles the image height: |
117 | |
144 | |
118 | scale 0.5, 2, load "$HOME/mypic.png" |
145 | scale 0.5, 2, load "$HOME/mypic.png" |
119 | |
146 | |
120 | Other effects than scalign are also readily available, for exmaple, you can |
147 | IF you try out these expressions, you might suffer from some sluggishness, |
121 | tile the image to fill the whole window, instead of resizing it: |
148 | because each time the terminal is resized, it loads the PNG image again |
|
|
149 | and scales it. Scaling is usually fast (and unavoidable), but loading the |
|
|
150 | image can be quite time consuming. This is where C<keep> comes in handy: |
122 | |
151 | |
|
|
152 | scale 0.5, 2, keep { load "$HOME/mypic.png" } |
|
|
153 | |
|
|
154 | The C<keep> operator executes all the statements inside the braces only |
|
|
155 | once, or when it thinks the outcome might change. In other cases it |
|
|
156 | returns the last value computed by the brace block. |
|
|
157 | |
|
|
158 | This means that the C<load> is only executed once, which makes it much |
|
|
159 | faster, but also means that more memory is being used, because the loaded |
|
|
160 | image must be kept in memory at all times. In this expression, the |
|
|
161 | trade-off is likely worth it. |
|
|
162 | |
|
|
163 | But back to effects: Other effects than scaling are also readily |
|
|
164 | available, for example, you can tile the image to fill the whole window, |
|
|
165 | instead of resizing it: |
|
|
166 | |
123 | tile load "$HOME/mypic.png" |
167 | tile keep { load "$HOME/mypic.png" } |
124 | |
168 | |
125 | In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator |
169 | In fact, images returned by C<load> are in C<tile> mode by default, so the |
126 | is kind of superfluous. |
170 | C<tile> operator is kind of superfluous. |
127 | |
171 | |
128 | Another common effect is to mirror the image, so that the same edges touch: |
172 | Another common effect is to mirror the image, so that the same edges |
|
|
173 | touch: |
129 | |
174 | |
130 | mirror load "$HOME/mypic.png" |
175 | mirror keep { load "$HOME/mypic.png" } |
131 | |
176 | |
132 | This is also a typical background expression: |
177 | Another common background expression is: |
133 | |
178 | |
134 | rootalign root |
179 | rootalign root |
135 | |
180 | |
136 | It first takes a snapshot of the screen background image, and then |
181 | This one first takes a snapshot of the screen background image, and then |
137 | moves it to the upper left corner of the screen - the result is |
182 | moves it to the upper left corner of the screen (as opposed to the upper |
138 | pseudo-transparency, as the image seems to be static while the window is |
183 | left corner of the terminal window)- the result is pseudo-transparency: |
139 | moved around. |
184 | the image seems to be static while the window is moved around. |
140 | |
185 | |
141 | =head2 CYCLES AND CACHING |
186 | =head2 COLOUR SPECIFICATIONS |
142 | |
187 | |
143 | As has been mentioned before, the expression might be evaluated multiple |
188 | Whenever an operator expects a "colour", then this can be specified in one |
144 | times. Each time the expression is reevaluated, a new cycle is said to |
189 | of two ways: Either as string with an X11 colour specification, such as: |
145 | have begun. Many operators cache their results till the next cycle. |
|
|
146 | |
190 | |
147 | For example, the C<load> operator keeps a copy of the image. If it is |
191 | "red" # named colour |
148 | asked to load the same image on the next cycle it will not load it again, |
192 | "#f00" # simple rgb |
149 | but return the cached copy. |
193 | "[50]red" # red with 50% alpha |
|
|
194 | "TekHVC:300/50/50" # anything goes |
150 | |
195 | |
151 | This only works for one cycle though, so as long as you load the same |
196 | OR as an array reference with one, three or four components: |
152 | image every time, it will always be cached, but when you load a different |
|
|
153 | image, it will forget about the first one. |
|
|
154 | |
197 | |
155 | This allows you to either speed things up by keeping multiple images in |
198 | [0.5] # 50% gray, 100% alpha |
156 | memory, or comserve memory by loading images more often. |
199 | [0.5, 0, 0] # dark red, no green or blur, 100% alpha |
|
|
200 | [0.5, 0, 0, 0.7] # same with explicit 70% alpha |
157 | |
201 | |
158 | For example, you can keep two images in memory and use a random one like |
202 | =head2 CACHING AND SENSITIVITY |
159 | this: |
|
|
160 | |
203 | |
161 | my $img1 = load "img1.png"; |
204 | Since some operations (such as C<load> and C<blur>) can take a long time, |
162 | my $img2 = load "img2.png"; |
205 | caching results can be very important for a smooth operation. Caching can |
163 | (0.5 > rand) ? $img1 : $img2 |
206 | also be useful to reduce memory usage, though, for example, when an image |
|
|
207 | is cached by C<load>, it could be shared by multiple terminal windows |
|
|
208 | running inside urxvtd. |
164 | |
209 | |
165 | Since both images are "loaded" every time the expression is evaluated, |
210 | =head3 C<keep { ... }> caching |
166 | they are always kept in memory. Contrast this version: |
|
|
167 | |
211 | |
168 | my $path1 = "img1.png"; |
212 | The most important way to cache expensive operations is to use C<keep { |
169 | my $path2 = "img2.png"; |
213 | ... }>. The C<keep> operator takes a block of multiple statements enclosed |
170 | load ((0.5 > rand) ? $path1 : $path2) |
214 | by C<{}> and keeps the return value in memory. |
171 | |
215 | |
172 | Here, a path is selected randomly, and load is only called for one image, |
216 | An expression can be "sensitive" to various external events, such as |
173 | so keeps only one image in memory. If, on the next evaluation, luck |
217 | scaling or moving the window, root background changes and timers. Simply |
174 | decides to use the other path, then it will have to load that image again. |
218 | using an expression (such as C<scale> without parameters) that depends on |
|
|
219 | certain changing values (called "variables"), or using those variables |
|
|
220 | directly, will make an expression sensitive to these events - for example, |
|
|
221 | using C<scale> or C<TW> will make the expression sensitive to the terminal |
|
|
222 | size, and thus to resizing events. |
|
|
223 | |
|
|
224 | When such an event happens, C<keep> will automatically trigger a |
|
|
225 | reevaluation of the whole expression with the new value of the expression. |
|
|
226 | |
|
|
227 | C<keep> is most useful for expensive operations, such as C<blur>: |
|
|
228 | |
|
|
229 | rootalign keep { blur 20, root } |
|
|
230 | |
|
|
231 | This makes a blurred copy of the root background once, and on subsequent |
|
|
232 | calls, just root-aligns it. Since C<blur> is usually quite slow and |
|
|
233 | C<rootalign> is quite fast, this trades extra memory (for the cached |
|
|
234 | blurred pixmap) with speed (blur only needs to be redone when root |
|
|
235 | changes). |
|
|
236 | |
|
|
237 | =head3 C<load> caching |
|
|
238 | |
|
|
239 | The C<load> operator itself does not keep images in memory, but as long as |
|
|
240 | the image is still in memory, C<load> will use the in-memory image instead |
|
|
241 | of loading it freshly from disk. |
|
|
242 | |
|
|
243 | That means that this expression: |
|
|
244 | |
|
|
245 | keep { load "$HOME/path..." } |
|
|
246 | |
|
|
247 | Not only caches the image in memory, other terminal instances that try to |
|
|
248 | C<load> it can reuse that in-memory copy. |
175 | |
249 | |
176 | =head1 REFERENCE |
250 | =head1 REFERENCE |
177 | |
251 | |
178 | =head2 COMMAND LINE SWITCHES |
252 | =head2 COMMAND LINE SWITCHES |
179 | |
253 | |
… | |
… | |
189 | overwriting borders and any other areas, such as the scrollbar. |
263 | overwriting borders and any other areas, such as the scrollbar. |
190 | |
264 | |
191 | Specifying this flag changes the behaviour, so that the image only |
265 | Specifying this flag changes the behaviour, so that the image only |
192 | replaces the background of the character area. |
266 | replaces the background of the character area. |
193 | |
267 | |
|
|
268 | =item --background-interval seconds |
|
|
269 | |
|
|
270 | Since some operations in the underlying XRender extension can effectively |
|
|
271 | freeze your X-server for prolonged time, this extension enforces a minimum |
|
|
272 | time between updates, which is normally about 0.1 seconds. |
|
|
273 | |
|
|
274 | If you want to do updates more often, you can decrease this safety |
|
|
275 | interval with this switch. |
|
|
276 | |
194 | =back |
277 | =back |
195 | |
278 | |
196 | =cut |
279 | =cut |
197 | |
280 | |
|
|
281 | our %_IMG_CACHE; |
198 | our $HOME; |
282 | our $HOME; |
199 | our ($self, $old, $new); |
283 | our ($self, $frame); |
200 | our ($x, $y, $w, $h); |
284 | our ($x, $y, $w, $h); |
201 | |
285 | |
202 | # enforce at least this interval between updates |
286 | # enforce at least this interval between updates |
203 | our $MIN_INTERVAL = 1/100; |
287 | our $MIN_INTERVAL = 6/59.951; |
204 | |
288 | |
205 | { |
289 | { |
206 | package urxvt::bgdsl; # background language |
290 | package urxvt::bgdsl; # background language |
|
|
291 | |
|
|
292 | sub FR_PARENT() { 0 } # parent frame, if any - must be #0 |
|
|
293 | sub FR_CACHE () { 1 } # cached values |
|
|
294 | sub FR_AGAIN () { 2 } # what this expr is sensitive to |
|
|
295 | sub FR_STATE () { 3 } # watchers etc. |
207 | |
296 | |
208 | use List::Util qw(min max sum shuffle); |
297 | use List::Util qw(min max sum shuffle); |
209 | |
298 | |
210 | =head2 PROVIDERS/GENERATORS |
299 | =head2 PROVIDERS/GENERATORS |
211 | |
300 | |
… | |
… | |
218 | =item load $path |
307 | =item load $path |
219 | |
308 | |
220 | Loads the image at the given C<$path>. The image is set to plane tiling |
309 | Loads the image at the given C<$path>. The image is set to plane tiling |
221 | mode. |
310 | mode. |
222 | |
311 | |
223 | Loaded images will be cached for one cycle. |
312 | If the image is already in memory (e.g. because another terminal instance |
|
|
313 | uses it), then the in-memory copy is returned instead. |
224 | |
314 | |
|
|
315 | =item load_uc $path |
|
|
316 | |
|
|
317 | Load uncached - same as load, but does not cache the image, which means it |
|
|
318 | is I<always> loaded from the filesystem again, even if another copy of it |
|
|
319 | is in memory at the time. |
|
|
320 | |
225 | =cut |
321 | =cut |
|
|
322 | |
|
|
323 | sub load_uc($) { |
|
|
324 | $self->new_img_from_file ($_[0]) |
|
|
325 | } |
226 | |
326 | |
227 | sub load($) { |
327 | sub load($) { |
228 | my ($path) = @_; |
328 | my ($path) = @_; |
229 | |
329 | |
230 | $new->{load}{$path} = $old->{load}{$path} || $self->new_img_from_file ($path); |
330 | $_IMG_CACHE{$path} || do { |
|
|
331 | my $img = load_uc $path; |
|
|
332 | Scalar::Util::weaken ($_IMG_CACHE{$path} = $img); |
|
|
333 | $img |
|
|
334 | } |
231 | } |
335 | } |
232 | |
336 | |
233 | =item root |
337 | =item root |
234 | |
338 | |
235 | Returns the root window pixmap, that is, hopefully, the background image |
339 | Returns the root window pixmap, that is, hopefully, the background image |
236 | of your screen. The image is set to extend mode. |
340 | of your screen. |
237 | |
341 | |
238 | This function makes your expression root sensitive, that means it will be |
342 | This function makes your expression root sensitive, that means it will be |
239 | reevaluated when the bg image changes. |
343 | reevaluated when the bg image changes. |
240 | |
344 | |
241 | =cut |
345 | =cut |
242 | |
346 | |
243 | sub root() { |
347 | sub root() { |
244 | $new->{rootpmap_sensitive} = 1; |
348 | $frame->[FR_AGAIN]{rootpmap} = 1; |
245 | die "root op not supported, exg, we need you"; |
349 | $self->new_img_from_root |
246 | } |
350 | } |
247 | |
351 | |
248 | =item solid $colour |
352 | =item solid $colour |
249 | |
353 | |
250 | =item solid $width, $height, $colour |
354 | =item solid $width, $height, $colour |
… | |
… | |
258 | =cut |
362 | =cut |
259 | |
363 | |
260 | sub solid($;$$) { |
364 | sub solid($;$$) { |
261 | my $colour = pop; |
365 | my $colour = pop; |
262 | |
366 | |
263 | my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] || 1, $_[1] || 1); |
367 | my $img = $self->new_img (urxvt::PictStandardARGB32, 0, 0, $_[0] || 1, $_[1] || 1); |
264 | $img->fill ($colour); |
368 | $img->fill ($colour); |
265 | $img |
369 | $img |
266 | } |
370 | } |
267 | |
371 | |
268 | =back |
372 | =item clone $img |
269 | |
373 | |
270 | =head2 VARIABLES |
374 | Returns an exact copy of the image. This is useful if you want to have |
|
|
375 | multiple copies of the same image to apply different effects to. |
271 | |
376 | |
272 | The following functions provide variable data such as the terminal window |
|
|
273 | dimensions. They are not (Perl-) variables, they jsut return stuff that |
|
|
274 | varies. Most of them make your expression sensitive to some events, for |
|
|
275 | example using C<TW> (terminal width) means your expression is evaluated |
|
|
276 | again when the terminal is resized. |
|
|
277 | |
|
|
278 | =over 4 |
|
|
279 | |
|
|
280 | =item TX |
|
|
281 | |
|
|
282 | =item TY |
|
|
283 | |
|
|
284 | Return the X and Y coordinates of the terminal window (the terminal |
|
|
285 | window is the full window by default, and the character area only when in |
|
|
286 | border-respect mode). |
|
|
287 | |
|
|
288 | Using these functions make your expression sensitive to window moves. |
|
|
289 | |
|
|
290 | These functions are mainly useful to align images to the root window. |
|
|
291 | |
|
|
292 | Example: load an image and align it so it looks as if anchored to the |
|
|
293 | background. |
|
|
294 | |
|
|
295 | move -TX, -TY, load "mybg.png" |
|
|
296 | |
|
|
297 | =item TW |
|
|
298 | |
|
|
299 | Return the width (C<TW>) and height (C<TH>) of the terminal window (the |
|
|
300 | terminal window is the full window by default, and the character area only |
|
|
301 | when in border-respect mode). |
|
|
302 | |
|
|
303 | Using these functions make your expression sensitive to window resizes. |
|
|
304 | |
|
|
305 | These functions are mainly useful to scale images, or to clip images to |
|
|
306 | the window size to conserve memory. |
|
|
307 | |
|
|
308 | Example: take the screen background, clip it to the window size, blur it a |
|
|
309 | bit, align it to the window position and use it as background. |
|
|
310 | |
|
|
311 | clip move -TX, -TY, blur 5, root |
|
|
312 | |
|
|
313 | =cut |
377 | =cut |
314 | |
378 | |
315 | sub TX() { $new->{position_sensitive} = 1; $x } |
|
|
316 | sub TY() { $new->{position_sensitive} = 1; $y } |
|
|
317 | sub TW() { $new->{size_sensitive} = 1; $w } |
|
|
318 | sub TH() { $new->{size_sensitive} = 1; $h } |
|
|
319 | |
|
|
320 | =item now |
|
|
321 | |
|
|
322 | Returns the current time as (fractional) seconds since the epoch. |
|
|
323 | |
|
|
324 | Using this expression does I<not> make your expression sensitive to time, |
|
|
325 | but the next two functions do. |
|
|
326 | |
|
|
327 | =item again $seconds |
|
|
328 | |
|
|
329 | When this function is used the expression will be reevaluated again in |
|
|
330 | C<$seconds> seconds. |
|
|
331 | |
|
|
332 | Example: load some image and rotate it according to the time of day (as if it were |
|
|
333 | the hour pointer of a clock). Update this image every minute. |
|
|
334 | |
|
|
335 | again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png" |
|
|
336 | |
|
|
337 | =item counter $seconds |
|
|
338 | |
|
|
339 | Like C<again>, but also returns an increasing counter value, starting at |
|
|
340 | 0, which might be useful for some simple animation effects. |
|
|
341 | |
|
|
342 | =cut |
|
|
343 | |
|
|
344 | sub now() { urxvt::NOW } |
|
|
345 | |
|
|
346 | sub again($) { |
|
|
347 | $new->{again} = $_[0]; |
|
|
348 | } |
|
|
349 | |
|
|
350 | sub counter($) { |
379 | sub clone($) { |
351 | $new->{again} = $_[0]; |
380 | $_[0]->clone |
352 | $self->{counter} + 0 |
381 | } |
|
|
382 | |
|
|
383 | =item merge $img ... |
|
|
384 | |
|
|
385 | Takes any number of images and merges them together, creating a single |
|
|
386 | image containing them all. The tiling mode of the first image is used as |
|
|
387 | the tiling mode of the resulting image. |
|
|
388 | |
|
|
389 | This function is called automatically when an expression returns multiple |
|
|
390 | images. |
|
|
391 | |
|
|
392 | =cut |
|
|
393 | |
|
|
394 | sub merge(@) { |
|
|
395 | return $_[0] unless $#_; |
|
|
396 | |
|
|
397 | # rather annoyingly clumsy, but optimisation is for another time |
|
|
398 | |
|
|
399 | my $x0 = +1e9; |
|
|
400 | my $y0 = +1e9; |
|
|
401 | my $x1 = -1e9; |
|
|
402 | my $y1 = -1e9; |
|
|
403 | |
|
|
404 | for (@_) { |
|
|
405 | my ($x, $y, $w, $h) = $_->geometry; |
|
|
406 | |
|
|
407 | $x0 = $x if $x0 > $x; |
|
|
408 | $y0 = $y if $y0 > $y; |
|
|
409 | |
|
|
410 | $x += $w; |
|
|
411 | $y += $h; |
|
|
412 | |
|
|
413 | $x1 = $x if $x1 < $x; |
|
|
414 | $y1 = $y if $y1 < $y; |
|
|
415 | } |
|
|
416 | |
|
|
417 | my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0); |
|
|
418 | $base->repeat_mode ($_[0]->repeat_mode); |
|
|
419 | $base->fill ([0, 0, 0, 0]); |
|
|
420 | |
|
|
421 | $base->draw ($_) |
|
|
422 | for @_; |
|
|
423 | |
|
|
424 | $base |
353 | } |
425 | } |
354 | |
426 | |
355 | =back |
427 | =back |
356 | |
428 | |
357 | =head2 TILING MODES |
429 | =head2 TILING MODES |
… | |
… | |
390 | become transparent. This mode is most useful when you want to place an |
462 | become transparent. This mode is most useful when you want to place an |
391 | image over another image or the background colour while leaving all |
463 | image over another image or the background colour while leaving all |
392 | background pixels outside the image unchanged. |
464 | background pixels outside the image unchanged. |
393 | |
465 | |
394 | Example: load an image and display it in the upper left corner. The rest |
466 | Example: load an image and display it in the upper left corner. The rest |
395 | of the space is left "empty" (transparent or wahtever your compisotr does |
467 | of the space is left "empty" (transparent or whatever your compositor does |
396 | in alpha mode, else background colour). |
468 | in alpha mode, else background colour). |
397 | |
469 | |
398 | pad load "mybg.png" |
470 | pad load "mybg.png" |
399 | |
471 | |
400 | =item extend $img |
472 | =item extend $img |
401 | |
473 | |
402 | Extends the image over the whole plane, using the closest pixel in the |
474 | Extends the image over the whole plane, using the closest pixel in the |
403 | area outside the image. This mode is mostly useful when you more complex |
475 | area outside the image. This mode is mostly useful when you use more complex |
404 | filtering operations and want the pixels outside the image to have the |
476 | filtering operations and want the pixels outside the image to have the |
405 | same values as the pixels near the edge. |
477 | same values as the pixels near the edge. |
406 | |
478 | |
407 | Example: just for curiosity, how does this pixel extension stuff work? |
479 | Example: just for curiosity, how does this pixel extension stuff work? |
408 | |
480 | |
… | |
… | |
434 | $img |
506 | $img |
435 | } |
507 | } |
436 | |
508 | |
437 | =back |
509 | =back |
438 | |
510 | |
439 | =head2 PIXEL OPERATORS |
511 | =head2 VARIABLE VALUES |
440 | |
512 | |
441 | The following operators modify the image pixels in various ways. |
513 | The following functions provide variable data such as the terminal window |
|
|
514 | dimensions. They are not (Perl-) variables, they just return stuff that |
|
|
515 | varies. Most of them make your expression sensitive to some events, for |
|
|
516 | example using C<TW> (terminal width) means your expression is evaluated |
|
|
517 | again when the terminal is resized. |
442 | |
518 | |
443 | =over 4 |
519 | =over 4 |
444 | |
520 | |
445 | =item clone $img |
521 | =item TX |
446 | |
522 | |
447 | Returns an exact copy of the image. |
523 | =item TY |
448 | |
524 | |
449 | =cut |
525 | Return the X and Y coordinates of the terminal window (the terminal |
|
|
526 | window is the full window by default, and the character area only when in |
|
|
527 | border-respect mode). |
450 | |
528 | |
|
|
529 | Using these functions make your expression sensitive to window moves. |
|
|
530 | |
|
|
531 | These functions are mainly useful to align images to the root window. |
|
|
532 | |
|
|
533 | Example: load an image and align it so it looks as if anchored to the |
|
|
534 | background (that's exactly what C<rootalign> does btw.): |
|
|
535 | |
|
|
536 | move -TX, -TY, keep { load "mybg.png" } |
|
|
537 | |
|
|
538 | =item TW |
|
|
539 | |
|
|
540 | =item TH |
|
|
541 | |
|
|
542 | Return the width (C<TW>) and height (C<TH>) of the terminal window (the |
|
|
543 | terminal window is the full window by default, and the character area only |
|
|
544 | when in border-respect mode). |
|
|
545 | |
|
|
546 | Using these functions make your expression sensitive to window resizes. |
|
|
547 | |
|
|
548 | These functions are mainly useful to scale images, or to clip images to |
|
|
549 | the window size to conserve memory. |
|
|
550 | |
|
|
551 | Example: take the screen background, clip it to the window size, blur it a |
|
|
552 | bit, align it to the window position and use it as background. |
|
|
553 | |
|
|
554 | clip move -TX, -TY, keep { blur 5, root } |
|
|
555 | |
|
|
556 | =cut |
|
|
557 | |
|
|
558 | sub TX() { $frame->[FR_AGAIN]{position} = 1; $x } |
|
|
559 | sub TY() { $frame->[FR_AGAIN]{position} = 1; $y } |
|
|
560 | sub TW() { $frame->[FR_AGAIN]{size} = 1; $w } |
|
|
561 | sub TH() { $frame->[FR_AGAIN]{size} = 1; $h } |
|
|
562 | |
|
|
563 | =item now |
|
|
564 | |
|
|
565 | Returns the current time as (fractional) seconds since the epoch. |
|
|
566 | |
|
|
567 | Using this expression does I<not> make your expression sensitive to time, |
|
|
568 | but the next two functions do. |
|
|
569 | |
|
|
570 | =item again $seconds |
|
|
571 | |
|
|
572 | When this function is used the expression will be reevaluated again in |
|
|
573 | C<$seconds> seconds. |
|
|
574 | |
|
|
575 | Example: load some image and rotate it according to the time of day (as if it were |
|
|
576 | the hour pointer of a clock). Update this image every minute. |
|
|
577 | |
|
|
578 | again 60; |
|
|
579 | rotate 50, 50, (now % 86400) * -72 / 8640, scale keep { load "myclock.png" } |
|
|
580 | |
|
|
581 | =item counter $seconds |
|
|
582 | |
|
|
583 | Like C<again>, but also returns an increasing counter value, starting at |
|
|
584 | 0, which might be useful for some simple animation effects. |
|
|
585 | |
|
|
586 | =cut |
|
|
587 | |
|
|
588 | sub now() { urxvt::NOW } |
|
|
589 | |
|
|
590 | sub again($) { |
|
|
591 | $frame->[FR_AGAIN]{time} = $_[0]; |
|
|
592 | } |
|
|
593 | |
451 | sub clone($) { |
594 | sub counter($) { |
452 | $_[0]->clone |
595 | $frame->[FR_AGAIN]{time} = $_[0]; |
|
|
596 | $frame->[FR_STATE]{counter} + 0 |
453 | } |
597 | } |
|
|
598 | |
|
|
599 | =back |
|
|
600 | |
|
|
601 | =head2 SHAPE CHANGING OPERATORS |
|
|
602 | |
|
|
603 | The following operators modify the shape, size or position of the image. |
|
|
604 | |
|
|
605 | =over 4 |
454 | |
606 | |
455 | =item clip $img |
607 | =item clip $img |
456 | |
608 | |
457 | =item clip $width, $height, $img |
609 | =item clip $width, $height, $img |
458 | |
610 | |
… | |
… | |
461 | Clips an image to the given rectangle. If the rectangle is outside the |
613 | Clips an image to the given rectangle. If the rectangle is outside the |
462 | image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is |
614 | image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is |
463 | larger than the image, then the tiling mode defines how the extra pixels |
615 | larger than the image, then the tiling mode defines how the extra pixels |
464 | will be filled. |
616 | will be filled. |
465 | |
617 | |
466 | If C<$x> an C<$y> are missing, then C<0> is assumed for both. |
618 | If C<$x> and C<$y> are missing, then C<0> is assumed for both. |
467 | |
619 | |
468 | If C<$width> and C<$height> are missing, then the window size will be |
620 | If C<$width> and C<$height> are missing, then the window size will be |
469 | assumed. |
621 | assumed. |
470 | |
622 | |
471 | Example: load an image, blur it, and clip it to the window size to save |
623 | Example: load an image, blur it, and clip it to the window size to save |
472 | memory. |
624 | memory. |
473 | |
625 | |
474 | clip blur 10, load "mybg.png" |
626 | clip keep { blur 10, load "mybg.png" } |
475 | |
627 | |
476 | =cut |
628 | =cut |
477 | |
629 | |
478 | sub clip($;$$;$$) { |
630 | sub clip($;$$;$$) { |
479 | my $img = pop; |
631 | my $img = pop; |
… | |
… | |
489 | =item scale $width_factor, $height_factor, $img |
641 | =item scale $width_factor, $height_factor, $img |
490 | |
642 | |
491 | Scales the image by the given factors in horizontal |
643 | Scales the image by the given factors in horizontal |
492 | (C<$width>) and vertical (C<$height>) direction. |
644 | (C<$width>) and vertical (C<$height>) direction. |
493 | |
645 | |
494 | If only one factor is give, it is used for both directions. |
646 | If only one factor is given, it is used for both directions. |
495 | |
647 | |
496 | If no factors are given, scales the image to the window size without |
648 | If no factors are given, scales the image to the window size without |
497 | keeping aspect. |
649 | keeping aspect. |
498 | |
650 | |
499 | =item resize $width, $height, $img |
651 | =item resize $width, $height, $img |
… | |
… | |
552 | |
704 | |
553 | Example: move the image right by 20 pixels and down by 30. |
705 | Example: move the image right by 20 pixels and down by 30. |
554 | |
706 | |
555 | move 20, 30, ... |
707 | move 20, 30, ... |
556 | |
708 | |
|
|
709 | =item align $xalign, $yalign, $img |
|
|
710 | |
|
|
711 | Aligns the image according to a factor - C<0> means the image is moved to |
|
|
712 | the left or top edge (for C<$xalign> or C<$yalign>), C<0.5> means it is |
|
|
713 | exactly centered and C<1> means it touches the right or bottom edge. |
|
|
714 | |
|
|
715 | Example: remove any visible border around an image, center it vertically but move |
|
|
716 | it to the right hand side. |
|
|
717 | |
|
|
718 | align 1, 0.5, pad $img |
|
|
719 | |
|
|
720 | =item center $img |
|
|
721 | |
|
|
722 | =item center $width, $height, $img |
|
|
723 | |
|
|
724 | Centers the image, i.e. the center of the image is moved to the center of |
|
|
725 | the terminal window (or the box specified by C<$width> and C<$height> if |
|
|
726 | given). |
|
|
727 | |
|
|
728 | Example: load an image and center it. |
|
|
729 | |
|
|
730 | center keep { pad load "mybg.png" } |
|
|
731 | |
557 | =item rootalign $img |
732 | =item rootalign $img |
558 | |
733 | |
559 | Moves the image so that it appears glued to the screen as opposed to the |
734 | Moves the image so that it appears glued to the screen as opposed to the |
560 | window. This gives the illusion of a larger area behind the window. It is |
735 | window. This gives the illusion of a larger area behind the window. It is |
561 | exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the |
736 | exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the |
562 | top left of the screen. |
737 | top left of the screen. |
563 | |
738 | |
564 | Example: load a background image, put it in mirror mode and root align it. |
739 | Example: load a background image, put it in mirror mode and root align it. |
565 | |
740 | |
566 | rootalign mirror load "mybg.png" |
741 | rootalign keep { mirror load "mybg.png" } |
567 | |
742 | |
568 | Example: take the screen background and align it, giving the illusion of |
743 | Example: take the screen background and align it, giving the illusion of |
569 | transparency as long as the window isn't in front of other windows. |
744 | transparency as long as the window isn't in front of other windows. |
570 | |
745 | |
571 | rootalign root |
746 | rootalign root |
572 | |
747 | |
573 | =cut |
748 | =cut |
574 | |
749 | |
575 | sub move($$;$) { |
750 | sub move($$;$) { |
576 | my $img = pop->clone; |
751 | my $img = pop->clone; |
577 | $img->move ($_[0], $_[1]); |
752 | $img->move ($_[0], $_[1]); |
578 | $img |
753 | $img |
579 | } |
754 | } |
580 | |
755 | |
|
|
756 | sub align($;$$) { |
|
|
757 | my $img = pop; |
|
|
758 | |
|
|
759 | move $_[0] * (TW - $img->w), |
|
|
760 | $_[1] * (TH - $img->h), |
|
|
761 | $img |
|
|
762 | } |
|
|
763 | |
|
|
764 | sub center($;$$) { |
|
|
765 | my $img = pop; |
|
|
766 | my $w = $_[0] || TW; |
|
|
767 | my $h = $_[1] || TH; |
|
|
768 | |
|
|
769 | move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img |
|
|
770 | } |
|
|
771 | |
581 | sub rootalign($) { |
772 | sub rootalign($) { |
582 | move -TX, -TY, $_[0] |
773 | move -TX, -TY, $_[0] |
583 | } |
774 | } |
584 | |
775 | |
|
|
776 | =item rotate $center_x, $center_y, $degrees, $img |
|
|
777 | |
|
|
778 | Rotates the image clockwise by C<$degrees> degrees, around the point at |
|
|
779 | C<$center_x> and C<$center_y> (specified as factor of image width/height). |
|
|
780 | |
|
|
781 | Example: rotate the image by 90 degrees around its center. |
|
|
782 | |
|
|
783 | rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" } |
|
|
784 | |
|
|
785 | =cut |
|
|
786 | |
|
|
787 | sub rotate($$$$) { |
|
|
788 | my $img = pop; |
|
|
789 | $img->rotate ( |
|
|
790 | $_[0] * ($img->w + $img->x), |
|
|
791 | $_[1] * ($img->h + $img->y), |
|
|
792 | $_[2] * (3.14159265 / 180), |
|
|
793 | ) |
|
|
794 | } |
|
|
795 | |
|
|
796 | =back |
|
|
797 | |
|
|
798 | =head2 COLOUR MODIFICATIONS |
|
|
799 | |
|
|
800 | The following operators change the pixels of the image. |
|
|
801 | |
|
|
802 | =over 4 |
|
|
803 | |
|
|
804 | =item tint $color, $img |
|
|
805 | |
|
|
806 | Tints the image in the given colour. |
|
|
807 | |
|
|
808 | Example: tint the image red. |
|
|
809 | |
|
|
810 | tint "red", load "rgb.png" |
|
|
811 | |
|
|
812 | Example: the same, but specify the colour by component. |
|
|
813 | |
|
|
814 | tint [1, 0, 0], load "rgb.png" |
|
|
815 | |
|
|
816 | =cut |
|
|
817 | |
|
|
818 | sub tint($$) { |
|
|
819 | $_[1]->tint ($_[0]) |
|
|
820 | } |
|
|
821 | |
|
|
822 | =item shade $factor, $img |
|
|
823 | |
|
|
824 | Shade the image by the given factor. |
|
|
825 | |
|
|
826 | =cut |
|
|
827 | |
|
|
828 | sub shade($$) { |
|
|
829 | $_[1]->shade ($_[0]) |
|
|
830 | } |
|
|
831 | |
585 | =item contrast $factor, $img |
832 | =item contrast $factor, $img |
586 | |
833 | |
587 | =item contrast $r, $g, $b, $img |
834 | =item contrast $r, $g, $b, $img |
588 | |
835 | |
589 | =item contrast $r, $g, $b, $a, $img |
836 | =item contrast $r, $g, $b, $a, $img |
590 | |
837 | |
591 | Adjusts the I<contrast> of an image. |
838 | Adjusts the I<contrast> of an image. |
592 | |
839 | |
593 | #TODO# |
840 | The first form applies a single C<$factor> to red, green and blue, the |
|
|
841 | second form applies separate factors to each colour channel, and the last |
|
|
842 | form includes the alpha channel. |
594 | |
843 | |
|
|
844 | Values from 0 to 1 lower the contrast, values higher than 1 increase the |
|
|
845 | contrast. |
|
|
846 | |
|
|
847 | Due to limitations in the underlying XRender extension, lowering contrast |
|
|
848 | also reduces brightness, while increasing contrast currently also |
|
|
849 | increases brightness. |
|
|
850 | |
595 | =item brightness $factor, $img |
851 | =item brightness $bias, $img |
596 | |
852 | |
597 | =item brightness $r, $g, $b, $img |
853 | =item brightness $r, $g, $b, $img |
598 | |
854 | |
599 | =item brightness $r, $g, $b, $a, $img |
855 | =item brightness $r, $g, $b, $a, $img |
600 | |
856 | |
601 | Adjusts the brightness of an image. |
857 | Adjusts the brightness of an image. |
|
|
858 | |
|
|
859 | The first form applies a single C<$bias> to red, green and blue, the |
|
|
860 | second form applies separate biases to each colour channel, and the last |
|
|
861 | form includes the alpha channel. |
|
|
862 | |
|
|
863 | Values less than 0 reduce brightness, while values larger than 0 increase |
|
|
864 | it. Useful range is from -1 to 1 - the former results in a black, the |
|
|
865 | latter in a white picture. |
|
|
866 | |
|
|
867 | Due to idiosyncrasies in the underlying XRender extension, biases less |
|
|
868 | than zero can be I<very> slow. |
|
|
869 | |
|
|
870 | You can also try the experimental(!) C<muladd> operator. |
602 | |
871 | |
603 | =cut |
872 | =cut |
604 | |
873 | |
605 | sub contrast($$;$$;$) { |
874 | sub contrast($$;$$;$) { |
606 | my $img = pop; |
875 | my $img = pop; |
607 | my ($r, $g, $b, $a) = @_; |
876 | my ($r, $g, $b, $a) = @_; |
608 | |
877 | |
609 | ($g, $b) = ($r, $r) if @_ < 4; |
878 | ($g, $b) = ($r, $r) if @_ < 3; |
610 | $a = 1 if @_ < 5; |
879 | $a = 1 if @_ < 4; |
611 | |
880 | |
612 | $img = $img->clone; |
881 | $img = $img->clone; |
613 | $img->contrast ($r, $g, $b, $a); |
882 | $img->contrast ($r, $g, $b, $a); |
614 | $img |
883 | $img |
615 | } |
884 | } |
616 | |
885 | |
617 | sub brightness($$;$$;$) { |
886 | sub brightness($$;$$;$) { |
618 | my $img = pop; |
887 | my $img = pop; |
619 | my ($r, $g, $b, $a) = @_; |
888 | my ($r, $g, $b, $a) = @_; |
620 | |
889 | |
621 | ($g, $b) = ($r, $r) if @_ < 4; |
890 | ($g, $b) = ($r, $r) if @_ < 3; |
622 | $a = 1 if @_ < 5; |
891 | $a = 1 if @_ < 4; |
623 | |
892 | |
624 | $img = $img->clone; |
893 | $img = $img->clone; |
625 | $img->brightness ($r, $g, $b, $a); |
894 | $img->brightness ($r, $g, $b, $a); |
626 | $img |
895 | $img |
|
|
896 | } |
|
|
897 | |
|
|
898 | =item muladd $mul, $add, $img # EXPERIMENTAL |
|
|
899 | |
|
|
900 | First multiplies the pixels by C<$mul>, then adds C<$add>. This can be used |
|
|
901 | to implement brightness and contrast at the same time, with a wider value |
|
|
902 | range than contrast and brightness operators. |
|
|
903 | |
|
|
904 | Due to numerous bugs in XRender implementations, it can also introduce a |
|
|
905 | number of visual artifacts. |
|
|
906 | |
|
|
907 | Example: increase contrast by a factor of C<$c> without changing image |
|
|
908 | brightness too much. |
|
|
909 | |
|
|
910 | muladd $c, (1 - $c) * 0.5, $img |
|
|
911 | |
|
|
912 | =cut |
|
|
913 | |
|
|
914 | sub muladd($$$) { |
|
|
915 | $_[2]->muladd ($_[0], $_[1]) |
627 | } |
916 | } |
628 | |
917 | |
629 | =item blur $radius, $img |
918 | =item blur $radius, $img |
630 | |
919 | |
631 | =item blur $radius_horz, $radius_vert, $img |
920 | =item blur $radius_horz, $radius_vert, $img |
… | |
… | |
643 | sub blur($$;$) { |
932 | sub blur($$;$) { |
644 | my $img = pop; |
933 | my $img = pop; |
645 | $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) |
934 | $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) |
646 | } |
935 | } |
647 | |
936 | |
648 | =item rotate $new_width, $new_height, $center_x, $center_y, $degrees |
|
|
649 | |
|
|
650 | Rotates the image by C<$degrees> degrees, counter-clockwise, around the |
|
|
651 | pointer at C<$center_x> and C<$center_y> (specified as factor of image |
|
|
652 | width/height), generating a new image with width C<$new_width> and height |
|
|
653 | C<$new_height>. |
|
|
654 | |
|
|
655 | #TODO# new width, height, maybe more operators? |
|
|
656 | |
|
|
657 | Example: rotate the image by 90 degrees |
|
|
658 | |
|
|
659 | =cut |
|
|
660 | |
|
|
661 | sub rotate($$$$$$) { |
|
|
662 | my $img = pop; |
|
|
663 | $img->rotate ( |
|
|
664 | $_[0], |
|
|
665 | $_[1], |
|
|
666 | $_[2] * $img->w, |
|
|
667 | $_[3] * $img->h, |
|
|
668 | $_[4] * (3.14159265 / 180), |
|
|
669 | ) |
|
|
670 | } |
|
|
671 | |
|
|
672 | =back |
937 | =back |
673 | |
938 | |
|
|
939 | =head2 OTHER STUFF |
|
|
940 | |
|
|
941 | Anything that didn't fit any of the other categories, even after applying |
|
|
942 | force and closing our eyes. |
|
|
943 | |
|
|
944 | =over 4 |
|
|
945 | |
|
|
946 | =item keep { ... } |
|
|
947 | |
|
|
948 | This operator takes a code block as argument, that is, one or more |
|
|
949 | statements enclosed by braces. |
|
|
950 | |
|
|
951 | The trick is that this code block is only evaluated when the outcome |
|
|
952 | changes - on other calls the C<keep> simply returns the image it computed |
|
|
953 | previously (yes, it should only be used with images). Or in other words, |
|
|
954 | C<keep> I<caches> the result of the code block so it doesn't need to be |
|
|
955 | computed again. |
|
|
956 | |
|
|
957 | This can be extremely useful to avoid redoing slow operations - for |
|
|
958 | example, if your background expression takes the root background, blurs it |
|
|
959 | and then root-aligns it it would have to blur the root background on every |
|
|
960 | window move or resize. |
|
|
961 | |
|
|
962 | Another example is C<load>, which can be quite slow. |
|
|
963 | |
|
|
964 | In fact, urxvt itself encloses the whole expression in some kind of |
|
|
965 | C<keep> block so it only is reevaluated as required. |
|
|
966 | |
|
|
967 | Putting the blur into a C<keep> block will make sure the blur is only done |
|
|
968 | once, while the C<rootalign> is still done each time the window moves. |
|
|
969 | |
|
|
970 | rootalign keep { blur 10, root } |
|
|
971 | |
|
|
972 | This leaves the question of how to force reevaluation of the block, |
|
|
973 | in case the root background changes: If expression inside the block |
|
|
974 | is sensitive to some event (root background changes, window geometry |
|
|
975 | changes), then it will be reevaluated automatically as needed. |
|
|
976 | |
|
|
977 | =cut |
|
|
978 | |
|
|
979 | sub keep(&) { |
|
|
980 | my $id = $_[0]+0; |
|
|
981 | |
|
|
982 | local $frame = $self->{frame_cache}{$id} ||= [$frame]; |
|
|
983 | |
|
|
984 | unless ($frame->[FR_CACHE]) { |
|
|
985 | $frame->[FR_CACHE] = [ $_[0]() ]; |
|
|
986 | |
|
|
987 | my $self = $self; |
|
|
988 | my $frame = $frame; |
|
|
989 | Scalar::Util::weaken $frame; |
|
|
990 | $self->compile_frame ($frame, sub { |
|
|
991 | # clear this frame cache, also for all parents |
|
|
992 | for (my $frame = $frame; $frame; $frame = $frame->[0]) { |
|
|
993 | undef $frame->[FR_CACHE]; |
|
|
994 | } |
|
|
995 | |
|
|
996 | $self->recalculate; |
|
|
997 | }); |
|
|
998 | }; |
|
|
999 | |
|
|
1000 | # in scalar context we always return the first original result, which |
|
|
1001 | # is not quite how perl works. |
|
|
1002 | wantarray |
|
|
1003 | ? @{ $frame->[FR_CACHE] } |
|
|
1004 | : $frame->[FR_CACHE][0] |
|
|
1005 | } |
|
|
1006 | |
|
|
1007 | # sub keep_clear() { |
|
|
1008 | # delete $self->{frame_cache}; |
|
|
1009 | # } |
|
|
1010 | |
|
|
1011 | =back |
|
|
1012 | |
674 | =cut |
1013 | =cut |
675 | |
1014 | |
676 | } |
1015 | } |
677 | |
1016 | |
678 | sub parse_expr { |
1017 | sub parse_expr { |
679 | my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}"; |
1018 | my $expr = eval |
|
|
1019 | "sub {\n" |
|
|
1020 | . "package urxvt::bgdsl;\n" |
|
|
1021 | . "#line 0 'background expression'\n" |
|
|
1022 | . "$_[0]\n" |
|
|
1023 | . "}"; |
680 | die if $@; |
1024 | die if $@; |
681 | $expr |
1025 | $expr |
682 | } |
1026 | } |
683 | |
1027 | |
684 | # compiles a parsed expression |
1028 | # compiles a parsed expression |
685 | sub set_expr { |
1029 | sub set_expr { |
686 | my ($self, $expr) = @_; |
1030 | my ($self, $expr) = @_; |
687 | |
1031 | |
|
|
1032 | $self->{root} = []; # the outermost frame |
688 | $self->{expr} = $expr; |
1033 | $self->{expr} = $expr; |
689 | $self->recalculate; |
1034 | $self->recalculate; |
|
|
1035 | } |
|
|
1036 | |
|
|
1037 | # takes a hash of sensitivity indicators and installs watchers |
|
|
1038 | sub compile_frame { |
|
|
1039 | my ($self, $frame, $cb) = @_; |
|
|
1040 | |
|
|
1041 | my $state = $frame->[urxvt::bgdsl::FR_STATE] ||= {}; |
|
|
1042 | my $again = $frame->[urxvt::bgdsl::FR_AGAIN]; |
|
|
1043 | |
|
|
1044 | # don't keep stuff alive |
|
|
1045 | Scalar::Util::weaken $state; |
|
|
1046 | |
|
|
1047 | if ($again->{nested}) { |
|
|
1048 | $state->{nested} = 1; |
|
|
1049 | } else { |
|
|
1050 | delete $state->{nested}; |
|
|
1051 | } |
|
|
1052 | |
|
|
1053 | if (my $interval = $again->{time}) { |
|
|
1054 | $state->{time} = [$interval, urxvt::timer->new->after ($interval)->interval ($interval)] |
|
|
1055 | if $state->{time}[0] != $interval; |
|
|
1056 | |
|
|
1057 | # callback *might* have changed, although we could just rule that out |
|
|
1058 | $state->{time}[1]->cb (sub { |
|
|
1059 | ++$state->{counter}; |
|
|
1060 | $cb->(); |
|
|
1061 | }); |
|
|
1062 | } else { |
|
|
1063 | delete $state->{time}; |
|
|
1064 | } |
|
|
1065 | |
|
|
1066 | if ($again->{position}) { |
|
|
1067 | $state->{position} = $self->on (position_change => $cb); |
|
|
1068 | } else { |
|
|
1069 | delete $state->{position}; |
|
|
1070 | } |
|
|
1071 | |
|
|
1072 | if ($again->{size}) { |
|
|
1073 | $state->{size} = $self->on (size_change => $cb); |
|
|
1074 | } else { |
|
|
1075 | delete $state->{size}; |
|
|
1076 | } |
|
|
1077 | |
|
|
1078 | if ($again->{rootpmap}) { |
|
|
1079 | $state->{rootpmap} = $self->on (rootpmap_change => $cb); |
|
|
1080 | } else { |
|
|
1081 | delete $state->{rootpmap}; |
|
|
1082 | } |
690 | } |
1083 | } |
691 | |
1084 | |
692 | # evaluate the current bg expression |
1085 | # evaluate the current bg expression |
693 | sub recalculate { |
1086 | sub recalculate { |
694 | my ($arg_self) = @_; |
1087 | my ($arg_self) = @_; |
… | |
… | |
704 | |
1097 | |
705 | $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; |
1098 | $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; |
706 | |
1099 | |
707 | # set environment to evaluate user expression |
1100 | # set environment to evaluate user expression |
708 | |
1101 | |
709 | local $self = $arg_self; |
1102 | local $self = $arg_self; |
710 | |
|
|
711 | local $HOME = $ENV{HOME}; |
1103 | local $HOME = $ENV{HOME}; |
712 | local $old = $self->{state}; |
1104 | local $frame = $self->{root}; |
713 | local $new = my $state = $self->{state} = {}; |
|
|
714 | |
1105 | |
715 | ($x, $y, $w, $h) = |
|
|
716 | $self->background_geometry ($self->{border}); |
1106 | ($x, $y, $w, $h) = $self->background_geometry ($self->{border}); |
717 | |
1107 | |
718 | # evaluate user expression |
1108 | # evaluate user expression |
719 | |
1109 | |
720 | my $img = eval { $self->{expr}->() }; |
1110 | my @img = eval { $self->{expr}->() }; |
721 | warn $@ if $@;#d# |
1111 | die $@ if $@; |
|
|
1112 | die "background-expr did not return anything.\n" unless @img; |
|
|
1113 | die "background-expr: expected image(s), got something else.\n" |
722 | die if !UNIVERSAL::isa $img, "urxvt::img"; |
1114 | if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img; |
723 | |
1115 | |
724 | $state->{size_sensitive} = 1 |
1116 | my $img = urxvt::bgdsl::merge @img; |
|
|
1117 | |
|
|
1118 | $frame->[FR_AGAIN]{size} = 1 |
725 | if $img->repeat_mode != urxvt::RepeatNormal; |
1119 | if $img->repeat_mode != urxvt::RepeatNormal; |
726 | |
1120 | |
727 | # if the expression is sensitive to external events, prepare reevaluation then |
1121 | # if the expression is sensitive to external events, prepare reevaluation then |
728 | |
1122 | $self->compile_frame ($frame, sub { $arg_self->recalculate }); |
729 | my $repeat; |
|
|
730 | |
|
|
731 | if (my $again = $state->{again}) { |
|
|
732 | $repeat = 1; |
|
|
733 | my $self = $self; |
|
|
734 | $state->{timer} = $again == $old->{again} |
|
|
735 | ? $old->{timer} |
|
|
736 | : urxvt::timer->new->after ($again)->interval ($again)->cb (sub { |
|
|
737 | ++$self->{counter}; |
|
|
738 | $self->recalculate |
|
|
739 | }); |
|
|
740 | } |
|
|
741 | |
|
|
742 | if (delete $state->{position_sensitive}) { |
|
|
743 | $repeat = 1; |
|
|
744 | $self->enable (position_change => sub { $_[0]->recalculate }); |
|
|
745 | } else { |
|
|
746 | $self->disable ("position_change"); |
|
|
747 | } |
|
|
748 | |
|
|
749 | if (delete $state->{size_sensitive}) { |
|
|
750 | $repeat = 1; |
|
|
751 | $self->enable (size_change => sub { $_[0]->recalculate }); |
|
|
752 | } else { |
|
|
753 | $self->disable ("size_change"); |
|
|
754 | } |
|
|
755 | |
|
|
756 | if (delete $state->{rootpmap_sensitive}) { |
|
|
757 | $repeat = 1; |
|
|
758 | $self->enable (rootpmap_change => sub { $_[0]->recalculate }); |
|
|
759 | } else { |
|
|
760 | $self->disable ("rootpmap_change"); |
|
|
761 | } |
|
|
762 | |
1123 | |
763 | # clear stuff we no longer need |
1124 | # clear stuff we no longer need |
764 | |
1125 | |
765 | %$old = (); |
1126 | # unless (%{ $frame->[FR_STATE] }) { |
766 | |
|
|
767 | unless ($repeat) { |
|
|
768 | delete $self->{state}; |
1127 | # delete $self->{state}; |
769 | delete $self->{expr}; |
1128 | # delete $self->{expr}; |
770 | } |
1129 | # } |
771 | |
1130 | |
772 | # set background pixmap |
1131 | # set background pixmap |
773 | |
1132 | |
774 | $self->set_background ($img, $self->{border}); |
1133 | $self->set_background ($img, $self->{border}); |
775 | $self->scr_recolour (0); |
1134 | $self->scr_recolour (0); |
… | |
… | |
777 | } |
1136 | } |
778 | |
1137 | |
779 | sub on_start { |
1138 | sub on_start { |
780 | my ($self) = @_; |
1139 | my ($self) = @_; |
781 | |
1140 | |
782 | my $expr = $self->x_resource ("background.expr") |
1141 | my $expr = $self->x_resource ("%.expr") |
783 | or return; |
1142 | or return; |
784 | |
1143 | |
|
|
1144 | $self->has_render |
|
|
1145 | or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n"; |
|
|
1146 | |
785 | $self->set_expr (parse_expr $expr); |
1147 | $self->set_expr (parse_expr $expr); |
786 | $self->{border} = $self->x_resource_boolean ("background.border"); |
1148 | $self->{border} = $self->x_resource_boolean ("%.border"); |
|
|
1149 | |
|
|
1150 | $MIN_INTERVAL = $self->x_resource ("%.interval"); |
787 | |
1151 | |
788 | () |
1152 | () |
789 | } |
1153 | } |
790 | |
1154 | |