1 | #! perl |
1 | #! perl |
2 | |
2 | |
3 | #:META:X_RESOURCE:%.expr:string:background expression |
3 | #:META:RESOURCE:%.expr:string:background expression |
4 | #:META:X_RESOURCE:%.border:boolean:respect the terminal border |
4 | #:META:RESOURCE:%.border:boolean:respect the terminal border |
5 | #:META:X_RESOURCE:%.interval:seconds:minimum time between updates |
5 | #:META:RESOURCE:%.interval:seconds:minimum time between updates |
|
|
6 | #:META:RESOURCE:pixmap:file[;geom]:set image as background |
|
|
7 | #:META:RESOURCE:backgroundPixmap:file[;geom]:set image as background |
|
|
8 | #:META:RESOURCE:tr:boolean:set root pixmap as background |
|
|
9 | #:META:RESOURCE:transparent:boolean:set root pixmap as background |
|
|
10 | #:META:RESOURCE:tint:color:tint background with color |
|
|
11 | #:META:RESOURCE:tintColor:color:tint background with color |
|
|
12 | #:META:RESOURCE:sh:number:shade background by number % |
|
|
13 | #:META:RESOURCE:shading:number:shade background by number % |
|
|
14 | #:META:RESOURCE:blr:HxV:gaussian-blur background with radii |
|
|
15 | #:META:RESOURCE:blurRadius:HxV:gaussian-blur background with radii |
|
|
16 | #:META:OSC:20:change/query background image |
|
|
17 | #:META:OSC:705:change transparent background tint colour |
6 | |
18 | |
7 | =head1 NAME |
19 | =head1 NAME |
8 | |
20 | |
9 | background - manage terminal background |
21 | background - manage terminal background |
10 | |
22 | |
11 | =head1 SYNOPSIS |
23 | =head1 SYNOPSIS |
12 | |
24 | |
13 | urxvt --background-expr 'background expression' |
25 | urxvt --background-expr 'background expression' |
14 | --background-border |
26 | --background-border |
15 | --background-interval seconds |
27 | --background-interval seconds |
16 | |
28 | |
|
|
29 | =head1 QUICK AND DIRTY CHEAT SHEET |
|
|
30 | |
|
|
31 | Load a random jpeg image and tile the background with it without scaling |
|
|
32 | or anything else: |
|
|
33 | |
|
|
34 | load "/path/to/img.jpg" |
|
|
35 | |
|
|
36 | The same, but use mirroring/reflection instead of tiling: |
|
|
37 | |
|
|
38 | mirror load "/path/to/img.jpg" |
|
|
39 | |
|
|
40 | Load an image and scale it to exactly fill the terminal window: |
|
|
41 | |
|
|
42 | scale keep { load "/path/to/img.jpg" } |
|
|
43 | |
|
|
44 | Implement pseudo-transparency by using a suitably-aligned root pixmap |
|
|
45 | as window background: |
|
|
46 | |
|
|
47 | rootalign root |
|
|
48 | |
|
|
49 | Likewise, but keep a blurred copy: |
|
|
50 | |
|
|
51 | rootalign keep { blur 10, root } |
|
|
52 | |
17 | =head1 DESCRIPTION |
53 | =head1 DESCRIPTION |
18 | |
54 | |
19 | This extension manages the terminal background by creating a picture that |
55 | This extension manages the terminal background by creating a picture that |
20 | is behind the text, replacing the normal background colour. |
56 | is behind the text, replacing the normal background colour. |
21 | |
57 | |
22 | It does so by evaluating a Perl expression that I<calculates> the image on |
58 | It does so by evaluating a Perl expression that I<calculates> the image on |
23 | the fly, for example, by grabbing the root background or loading a file. |
59 | the fly, for example, by grabbing the root background or loading a file. |
24 | |
60 | |
25 | While the full power of Perl is available, the operators have been design |
61 | While the full power of Perl is available, the operators have been |
26 | to be as simple as possible. |
62 | designed to be as simple as possible. |
27 | |
63 | |
28 | For example, to load an image and scale it to the window size, you would |
64 | For example, to load an image and scale it to the window size, you would |
29 | use: |
65 | use: |
30 | |
66 | |
31 | urxvt --background-expr 'scale load "/path/to/mybg.png"' |
67 | urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }' |
32 | |
68 | |
33 | Or specified as a X resource: |
69 | Or specified as a X resource: |
34 | |
70 | |
35 | URxvt.background-expr: scale load "/path/to/mybg.png" |
71 | URxvt.background.expr: scale keep { load "/path/to/mybg.png" } |
36 | |
72 | |
37 | =head1 THEORY OF OPERATION |
73 | =head1 THEORY OF OPERATION |
38 | |
74 | |
39 | At startup, just before the window is mapped for the first time, the |
75 | 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 |
76 | 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 |
89 | 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 |
90 | 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 |
91 | pixmap is replaced by another one the root background changes; or when the |
56 | timer elapses), then the expression will be evaluated again. |
92 | timer elapses), then the expression will be evaluated again. |
57 | |
93 | |
58 | For example, an expression such as C<scale load "$HOME/mybg.png"> scales the |
94 | 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 |
95 | }> 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 |
96 | 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 |
97 | example. That ensures that the picture always fills the terminal, even |
62 | after its size changes. |
98 | after its size changes. |
63 | |
99 | |
64 | =head2 EXPRESSIONS |
100 | =head2 EXPRESSIONS |
65 | |
101 | |
66 | Expressions are normal Perl expressions, in fact, they are Perl blocks - |
102 | Expressions are normal Perl expressions, in fact, they are Perl blocks - |
67 | which means you could use multiple lines and statements: |
103 | which means you could use multiple lines and statements: |
68 | |
104 | |
|
|
105 | scale keep { |
69 | again 3600; |
106 | again 3600; |
70 | if (localtime now)[6]) { |
107 | if (localtime now)[6]) { |
71 | return scale load "$HOME/weekday.png"; |
108 | return load "$HOME/weekday.png"; |
72 | } else { |
109 | } else { |
73 | return scale load "$HOME/sunday.png"; |
110 | return load "$HOME/sunday.png"; |
|
|
111 | } |
74 | } |
112 | } |
75 | |
113 | |
76 | This expression is evaluated once per hour. It will set F<sunday.png> as |
114 | This inner expression is evaluated once per hour (and whenever the |
|
|
115 | terminal window is resized). It sets F<sunday.png> as background on |
77 | background on Sundays, and F<weekday.png> on all other days. |
116 | Sundays, and F<weekday.png> on all other days. |
78 | |
117 | |
79 | Fortunately, we expect that most expressions will be much simpler, with |
118 | Fortunately, we expect that most expressions will be much simpler, with |
80 | little Perl knowledge needed. |
119 | little Perl knowledge needed. |
81 | |
120 | |
82 | Basically, you always start with a function that "generates" an image |
121 | Basically, you always start with a function that "generates" an image |
… | |
… | |
105 | get a percentage): |
144 | get a percentage): |
106 | |
145 | |
107 | scale 2, load "$HOME/mypic.png" |
146 | scale 2, load "$HOME/mypic.png" |
108 | |
147 | |
109 | This enlarges the image by a factor of 2 (200%). As you can see, C<scale> |
148 | This enlarges the image by a factor of 2 (200%). As you can see, C<scale> |
110 | has now two arguments, the C<200> and the C<load> expression, while |
149 | has now two arguments, the C<2> and the C<load> expression, while |
111 | C<load> only has one argument. Arguments are separated from each other by |
150 | C<load> only has one argument. Arguments are separated from each other by |
112 | commas. |
151 | commas. |
113 | |
152 | |
114 | Scale also accepts two arguments, which are then separate factors for both |
153 | Scale also accepts two arguments, which are then separate factors for both |
115 | horizontal and vertical dimensions. For example, this halves the image |
154 | horizontal and vertical dimensions. For example, this halves the image |
116 | width and doubles the image height: |
155 | width and doubles the image height: |
117 | |
156 | |
118 | scale 0.5, 2, load "$HOME/mypic.png" |
157 | scale 0.5, 2, load "$HOME/mypic.png" |
119 | |
158 | |
120 | Other effects than scaling are also readily available, for example, you can |
159 | 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: |
160 | because each time the terminal is resized, it loads the PNG image again |
|
|
161 | and scales it. Scaling is usually fast (and unavoidable), but loading the |
|
|
162 | image can be quite time consuming. This is where C<keep> comes in handy: |
122 | |
163 | |
|
|
164 | scale 0.5, 2, keep { load "$HOME/mypic.png" } |
|
|
165 | |
|
|
166 | The C<keep> operator executes all the statements inside the braces only |
|
|
167 | once, or when it thinks the outcome might change. In other cases it |
|
|
168 | returns the last value computed by the brace block. |
|
|
169 | |
|
|
170 | This means that the C<load> is only executed once, which makes it much |
|
|
171 | faster, but also means that more memory is being used, because the loaded |
|
|
172 | image must be kept in memory at all times. In this expression, the |
|
|
173 | trade-off is likely worth it. |
|
|
174 | |
|
|
175 | But back to effects: Other effects than scaling are also readily |
|
|
176 | available, for example, you can tile the image to fill the whole window, |
|
|
177 | instead of resizing it: |
|
|
178 | |
123 | tile load "$HOME/mypic.png" |
179 | tile keep { load "$HOME/mypic.png" } |
124 | |
180 | |
125 | In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator |
181 | In fact, images returned by C<load> are in C<tile> mode by default, so the |
126 | is kind of superfluous. |
182 | C<tile> operator is kind of superfluous. |
127 | |
183 | |
128 | Another common effect is to mirror the image, so that the same edges touch: |
184 | Another common effect is to mirror the image, so that the same edges |
|
|
185 | touch: |
129 | |
186 | |
130 | mirror load "$HOME/mypic.png" |
187 | mirror keep { load "$HOME/mypic.png" } |
131 | |
188 | |
132 | This is also a typical background expression: |
189 | Another common background expression is: |
133 | |
190 | |
134 | rootalign root |
191 | rootalign root |
135 | |
192 | |
136 | It first takes a snapshot of the screen background image, and then |
193 | 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 |
194 | 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 |
195 | left corner of the terminal window)- the result is pseudo-transparency: |
139 | moved around. |
196 | the image seems to be static while the window is moved around. |
140 | |
197 | |
141 | =head2 CYCLES AND CACHING |
198 | =head2 COLOUR SPECIFICATIONS |
142 | |
199 | |
143 | =head3 C<load> et al. |
200 | Whenever an operator expects a "colour", then this can be specified in one |
|
|
201 | of two ways: Either as string with an X11 colour specification, such as: |
144 | |
202 | |
145 | As has been mentioned before, the expression might be evaluated multiple |
203 | "red" # named colour |
146 | times. Each time the expression is reevaluated, a new cycle is said to |
204 | "#f00" # simple rgb |
147 | have begun. Many operators cache their results till the next cycle. |
205 | "[50]red" # red with 50% alpha |
|
|
206 | "TekHVC:300/50/50" # anything goes |
148 | |
207 | |
149 | For example, the C<load> operator keeps a copy of the image. If it is |
208 | OR as an array reference with one, three or four components: |
150 | asked to load the same image on the next cycle it will not load it again, |
|
|
151 | but return the cached copy. |
|
|
152 | |
209 | |
153 | This only works for one cycle though, so as long as you load the same |
210 | [0.5] # 50% gray, 100% alpha |
154 | image every time, it will always be cached, but when you load a different |
211 | [0.5, 0, 0] # dark red, no green or blur, 100% alpha |
155 | image, it will forget about the first one. |
212 | [0.5, 0, 0, 0.7] # same with explicit 70% alpha |
156 | |
213 | |
157 | This allows you to either speed things up by keeping multiple images in |
214 | =head2 CACHING AND SENSITIVITY |
158 | memory, or conserve memory by loading images more often. |
|
|
159 | |
215 | |
160 | For example, you can keep two images in memory and use a random one like |
216 | Since some operations (such as C<load> and C<blur>) can take a long time, |
161 | this: |
217 | caching results can be very important for a smooth operation. Caching can |
|
|
218 | also be useful to reduce memory usage, though, for example, when an image |
|
|
219 | is cached by C<load>, it could be shared by multiple terminal windows |
|
|
220 | running inside urxvtd. |
162 | |
221 | |
163 | my $img1 = load "img1.png"; |
222 | =head3 C<keep { ... }> caching |
164 | my $img2 = load "img2.png"; |
|
|
165 | (0.5 > rand) ? $img1 : $img2 |
|
|
166 | |
223 | |
167 | Since both images are "loaded" every time the expression is evaluated, |
224 | The most important way to cache expensive operations is to use C<keep { |
168 | they are always kept in memory. Contrast this version: |
|
|
169 | |
|
|
170 | my $path1 = "img1.png"; |
|
|
171 | my $path2 = "img2.png"; |
|
|
172 | load ((0.5 > rand) ? $path1 : $path2) |
|
|
173 | |
|
|
174 | Here, a path is selected randomly, and load is only called for one image, |
|
|
175 | so keeps only one image in memory. If, on the next evaluation, luck |
|
|
176 | decides to use the other path, then it will have to load that image again. |
|
|
177 | |
|
|
178 | =head3 C<once { ... }> |
|
|
179 | |
|
|
180 | Another way to cache expensive operations is to use C<once { ... }>. The |
|
|
181 | C<once> operator takes a block of multiple statements enclosed by C<{}> |
225 | ... }>. The C<keep> operator takes a block of multiple statements enclosed |
182 | and evaluates it only.. once, returning any images the last statement |
226 | by C<{}> and keeps the return value in memory. |
183 | returned. Further calls simply produce the values from the cache. |
|
|
184 | |
227 | |
|
|
228 | An expression can be "sensitive" to various external events, such as |
|
|
229 | scaling or moving the window, root background changes and timers. Simply |
|
|
230 | using an expression (such as C<scale> without parameters) that depends on |
|
|
231 | certain changing values (called "variables"), or using those variables |
|
|
232 | directly, will make an expression sensitive to these events - for example, |
|
|
233 | using C<scale> or C<TW> will make the expression sensitive to the terminal |
|
|
234 | size, and thus to resizing events. |
|
|
235 | |
|
|
236 | When such an event happens, C<keep> will automatically trigger a |
|
|
237 | reevaluation of the whole expression with the new value of the expression. |
|
|
238 | |
185 | This is most useful for expensive operations, such as C<blur>: |
239 | C<keep> is most useful for expensive operations, such as C<blur>: |
186 | |
240 | |
187 | rootalign once { blur 20, root } |
241 | rootalign keep { blur 20, root } |
188 | |
242 | |
189 | This makes a blurred copy of the root background once, and on subsequent |
243 | This makes a blurred copy of the root background once, and on subsequent |
190 | calls, just root-aligns it. Since C<blur> is usually quite slow and |
244 | calls, just root-aligns it. Since C<blur> is usually quite slow and |
191 | C<rootalign> is quite fast, this trades extra memory (For the cached |
245 | C<rootalign> is quite fast, this trades extra memory (for the cached |
192 | blurred pixmap) with speed (blur only needs to be redone when root |
246 | blurred pixmap) with speed (blur only needs to be redone when root |
193 | changes). |
247 | changes). |
194 | |
248 | |
|
|
249 | =head3 C<load> caching |
|
|
250 | |
|
|
251 | The C<load> operator itself does not keep images in memory, but as long as |
|
|
252 | the image is still in memory, C<load> will use the in-memory image instead |
|
|
253 | of loading it freshly from disk. |
|
|
254 | |
|
|
255 | That means that this expression: |
|
|
256 | |
|
|
257 | keep { load "$HOME/path..." } |
|
|
258 | |
|
|
259 | Not only caches the image in memory, other terminal instances that try to |
|
|
260 | C<load> it can reuse that in-memory copy. |
|
|
261 | |
195 | =head1 REFERENCE |
262 | =head1 REFERENCE |
196 | |
263 | |
197 | =head2 COMMAND LINE SWITCHES |
264 | =head2 COMMAND LINE SWITCHES |
198 | |
265 | |
199 | =over 4 |
266 | =over |
200 | |
267 | |
201 | =item --background-expr perl-expression |
268 | =item --background-expr perl-expression |
202 | |
269 | |
203 | Specifies the Perl expression to evaluate. |
270 | Specifies the Perl expression to evaluate. |
204 | |
271 | |
… | |
… | |
224 | =cut |
291 | =cut |
225 | |
292 | |
226 | our %_IMG_CACHE; |
293 | our %_IMG_CACHE; |
227 | our $HOME; |
294 | our $HOME; |
228 | our ($self, $frame); |
295 | our ($self, $frame); |
229 | our ($x, $y, $w, $h); |
296 | our ($x, $y, $w, $h, $focus); |
230 | |
297 | |
231 | # enforce at least this interval between updates |
298 | # enforce at least this interval between updates |
232 | our $MIN_INTERVAL = 6/59.951; |
299 | our $MIN_INTERVAL = 6/59.951; |
233 | |
300 | |
234 | { |
301 | { |
… | |
… | |
245 | |
312 | |
246 | These functions provide an image, by loading it from disk, grabbing it |
313 | These functions provide an image, by loading it from disk, grabbing it |
247 | from the root screen or by simply generating it. They are used as starting |
314 | from the root screen or by simply generating it. They are used as starting |
248 | points to get an image you can play with. |
315 | points to get an image you can play with. |
249 | |
316 | |
250 | =over 4 |
317 | =over |
251 | |
318 | |
252 | =item load $path |
319 | =item load $path |
253 | |
320 | |
254 | Loads the image at the given C<$path>. The image is set to plane tiling |
321 | Loads the image at the given C<$path>. The image is set to plane tiling |
255 | mode. |
322 | mode. |
256 | |
323 | |
257 | Loaded images will be cached for one cycle, and shared between temrinals |
324 | If the image is already in memory (e.g. because another terminal instance |
258 | running in the same process (e.g. in C<urxvtd>). |
325 | uses it), then the in-memory copy is returned instead. |
259 | |
326 | |
260 | #=item load_uc $path |
327 | =item load_uc $path |
261 | # |
328 | |
262 | #Load uncached - same as load, but does not cache the image. This function |
329 | Load uncached - same as load, but does not cache the image, which means it |
263 | #is most useufl if you want to optimise a background expression in some |
330 | is I<always> loaded from the filesystem again, even if another copy of it |
264 | #way. |
331 | is in memory at the time. |
265 | |
332 | |
266 | =cut |
333 | =cut |
|
|
334 | |
|
|
335 | sub load_uc($) { |
|
|
336 | $self->new_img_from_file ($_[0]) |
|
|
337 | } |
267 | |
338 | |
268 | sub load($) { |
339 | sub load($) { |
269 | my ($path) = @_; |
340 | my ($path) = @_; |
270 | |
341 | |
271 | $_IMG_CACHE{$path} || do { |
342 | $_IMG_CACHE{$path} || do { |
272 | my $img = $self->new_img_from_file ($path); |
343 | my $img = load_uc $path; |
273 | Scalar::Util::weaken ($_IMG_CACHE{$path} = $img); |
344 | Scalar::Util::weaken ($_IMG_CACHE{$path} = $img); |
274 | $img |
345 | $img |
275 | } |
346 | } |
276 | } |
347 | } |
277 | |
348 | |
… | |
… | |
323 | |
394 | |
324 | =item merge $img ... |
395 | =item merge $img ... |
325 | |
396 | |
326 | Takes any number of images and merges them together, creating a single |
397 | Takes any number of images and merges them together, creating a single |
327 | image containing them all. The tiling mode of the first image is used as |
398 | image containing them all. The tiling mode of the first image is used as |
328 | the tiling mdoe of the resulting image. |
399 | the tiling mode of the resulting image. |
329 | |
400 | |
330 | This function is called automatically when an expression returns multiple |
401 | This function is called automatically when an expression returns multiple |
331 | images. |
402 | images. |
332 | |
403 | |
333 | =cut |
404 | =cut |
… | |
… | |
363 | for @_; |
434 | for @_; |
364 | |
435 | |
365 | $base |
436 | $base |
366 | } |
437 | } |
367 | |
438 | |
|
|
439 | =back |
|
|
440 | |
368 | =head2 TILING MODES |
441 | =head2 TILING MODES |
369 | |
442 | |
370 | The following operators modify the tiling mode of an image, that is, the |
443 | The following operators modify the tiling mode of an image, that is, the |
371 | way that pixels outside the image area are painted when the image is used. |
444 | way that pixels outside the image area are painted when the image is used. |
372 | |
445 | |
373 | =over 4 |
446 | =over |
374 | |
447 | |
375 | =item tile $img |
448 | =item tile $img |
376 | |
449 | |
377 | Tiles the whole plane with the image and returns this new image - or in |
450 | Tiles the whole plane with the image and returns this new image - or in |
378 | other words, it returns a copy of the image in plane tiling mode. |
451 | other words, it returns a copy of the image in plane tiling mode. |
… | |
… | |
453 | dimensions. They are not (Perl-) variables, they just return stuff that |
526 | dimensions. They are not (Perl-) variables, they just return stuff that |
454 | varies. Most of them make your expression sensitive to some events, for |
527 | varies. Most of them make your expression sensitive to some events, for |
455 | example using C<TW> (terminal width) means your expression is evaluated |
528 | example using C<TW> (terminal width) means your expression is evaluated |
456 | again when the terminal is resized. |
529 | again when the terminal is resized. |
457 | |
530 | |
458 | =over 4 |
531 | =over |
459 | |
532 | |
460 | =item TX |
533 | =item TX |
461 | |
534 | |
462 | =item TY |
535 | =item TY |
463 | |
536 | |
464 | Return the X and Y coordinates of the terminal window (the terminal |
537 | Return the X and Y coordinates of the terminal window (the terminal |
465 | window is the full window by default, and the character area only when in |
538 | window is the full window by default, and the character area only when in |
466 | border-respect mode). |
539 | border-respect mode). |
467 | |
540 | |
468 | Using these functions make your expression sensitive to window moves. |
541 | Using these functions makes your expression sensitive to window moves. |
469 | |
542 | |
470 | These functions are mainly useful to align images to the root window. |
543 | These functions are mainly useful to align images to the root window. |
471 | |
544 | |
472 | Example: load an image and align it so it looks as if anchored to the |
545 | Example: load an image and align it so it looks as if anchored to the |
473 | background. |
546 | background (that's exactly what C<rootalign> does btw.): |
474 | |
547 | |
475 | move -TX, -TY, load "mybg.png" |
548 | move -TX, -TY, keep { load "mybg.png" } |
476 | |
549 | |
477 | =item TW |
550 | =item TW |
|
|
551 | |
|
|
552 | =item TH |
478 | |
553 | |
479 | Return the width (C<TW>) and height (C<TH>) of the terminal window (the |
554 | Return the width (C<TW>) and height (C<TH>) of the terminal window (the |
480 | terminal window is the full window by default, and the character area only |
555 | terminal window is the full window by default, and the character area only |
481 | when in border-respect mode). |
556 | when in border-respect mode). |
482 | |
557 | |
483 | Using these functions make your expression sensitive to window resizes. |
558 | Using these functions makes your expression sensitive to window resizes. |
484 | |
559 | |
485 | These functions are mainly useful to scale images, or to clip images to |
560 | These functions are mainly useful to scale images, or to clip images to |
486 | the window size to conserve memory. |
561 | the window size to conserve memory. |
487 | |
562 | |
488 | Example: take the screen background, clip it to the window size, blur it a |
563 | Example: take the screen background, clip it to the window size, blur it a |
489 | bit, align it to the window position and use it as background. |
564 | bit, align it to the window position and use it as background. |
490 | |
565 | |
491 | clip move -TX, -TY, once { blur 5, root } |
566 | clip move -TX, -TY, keep { blur 5, root } |
492 | |
567 | |
493 | =cut |
568 | =item FOCUS |
494 | |
569 | |
|
|
570 | Returns a boolean indicating whether the terminal window has keyboard |
|
|
571 | focus, in which case it returns true. |
|
|
572 | |
|
|
573 | Using this function makes your expression sensitive to focus changes. |
|
|
574 | |
|
|
575 | A common use case is to fade the background image when the terminal loses |
|
|
576 | focus, often together with the C<-fade> command line option. In fact, |
|
|
577 | there is a special function for just that use case: C<focus_fade>. |
|
|
578 | |
|
|
579 | Example: use two entirely different background images, depending on |
|
|
580 | whether the window has focus. |
|
|
581 | |
|
|
582 | FOCUS ? keep { load "has_focus.jpg" } : keep { load "no_focus.jpg" } |
|
|
583 | |
|
|
584 | =cut |
|
|
585 | |
495 | sub TX() { $frame->[FR_AGAIN]{position} = 1; $x } |
586 | sub TX () { $frame->[FR_AGAIN]{position} = 1; $x } |
496 | sub TY() { $frame->[FR_AGAIN]{position} = 1; $y } |
587 | sub TY () { $frame->[FR_AGAIN]{position} = 1; $y } |
497 | sub TW() { $frame->[FR_AGAIN]{size} = 1; $w } |
588 | sub TW () { $frame->[FR_AGAIN]{size} = 1; $w } |
498 | sub TH() { $frame->[FR_AGAIN]{size} = 1; $h } |
589 | sub TH () { $frame->[FR_AGAIN]{size} = 1; $h } |
|
|
590 | sub FOCUS() { $frame->[FR_AGAIN]{focus} = 1; $focus } |
499 | |
591 | |
500 | =item now |
592 | =item now |
501 | |
593 | |
502 | Returns the current time as (fractional) seconds since the epoch. |
594 | Returns the current time as (fractional) seconds since the epoch. |
503 | |
595 | |
… | |
… | |
510 | C<$seconds> seconds. |
602 | C<$seconds> seconds. |
511 | |
603 | |
512 | Example: load some image and rotate it according to the time of day (as if it were |
604 | Example: load some image and rotate it according to the time of day (as if it were |
513 | the hour pointer of a clock). Update this image every minute. |
605 | the hour pointer of a clock). Update this image every minute. |
514 | |
606 | |
|
|
607 | again 60; |
515 | again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png" |
608 | rotate 50, 50, (now % 86400) * -72 / 8640, scale keep { load "myclock.png" } |
516 | |
609 | |
517 | =item counter $seconds |
610 | =item counter $seconds |
518 | |
611 | |
519 | Like C<again>, but also returns an increasing counter value, starting at |
612 | Like C<again>, but also returns an increasing counter value, starting at |
520 | 0, which might be useful for some simple animation effects. |
613 | 0, which might be useful for some simple animation effects. |
… | |
… | |
536 | |
629 | |
537 | =head2 SHAPE CHANGING OPERATORS |
630 | =head2 SHAPE CHANGING OPERATORS |
538 | |
631 | |
539 | The following operators modify the shape, size or position of the image. |
632 | The following operators modify the shape, size or position of the image. |
540 | |
633 | |
541 | =over 4 |
634 | =over |
542 | |
635 | |
543 | =item clip $img |
636 | =item clip $img |
544 | |
637 | |
545 | =item clip $width, $height, $img |
638 | =item clip $width, $height, $img |
546 | |
639 | |
… | |
… | |
549 | Clips an image to the given rectangle. If the rectangle is outside the |
642 | Clips an image to the given rectangle. If the rectangle is outside the |
550 | image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is |
643 | image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is |
551 | larger than the image, then the tiling mode defines how the extra pixels |
644 | larger than the image, then the tiling mode defines how the extra pixels |
552 | will be filled. |
645 | will be filled. |
553 | |
646 | |
554 | If C<$x> an C<$y> are missing, then C<0> is assumed for both. |
647 | If C<$x> and C<$y> are missing, then C<0> is assumed for both. |
555 | |
648 | |
556 | If C<$width> and C<$height> are missing, then the window size will be |
649 | If C<$width> and C<$height> are missing, then the window size will be |
557 | assumed. |
650 | assumed. |
558 | |
651 | |
559 | Example: load an image, blur it, and clip it to the window size to save |
652 | Example: load an image, blur it, and clip it to the window size to save |
560 | memory. |
653 | memory. |
561 | |
654 | |
562 | clip blur 10, load "mybg.png" |
655 | clip keep { blur 10, load "mybg.png" } |
563 | |
656 | |
564 | =cut |
657 | =cut |
565 | |
658 | |
566 | sub clip($;$$;$$) { |
659 | sub clip($;$$;$$) { |
567 | my $img = pop; |
660 | my $img = pop; |
… | |
… | |
577 | =item scale $width_factor, $height_factor, $img |
670 | =item scale $width_factor, $height_factor, $img |
578 | |
671 | |
579 | Scales the image by the given factors in horizontal |
672 | Scales the image by the given factors in horizontal |
580 | (C<$width>) and vertical (C<$height>) direction. |
673 | (C<$width>) and vertical (C<$height>) direction. |
581 | |
674 | |
582 | If only one factor is give, it is used for both directions. |
675 | If only one factor is given, it is used for both directions. |
583 | |
676 | |
584 | If no factors are given, scales the image to the window size without |
677 | If no factors are given, scales the image to the window size without |
585 | keeping aspect. |
678 | keeping aspect. |
586 | |
679 | |
587 | =item resize $width, $height, $img |
680 | =item resize $width, $height, $img |
… | |
… | |
661 | the terminal window (or the box specified by C<$width> and C<$height> if |
754 | the terminal window (or the box specified by C<$width> and C<$height> if |
662 | given). |
755 | given). |
663 | |
756 | |
664 | Example: load an image and center it. |
757 | Example: load an image and center it. |
665 | |
758 | |
666 | center pad load "mybg.png" |
759 | center keep { pad load "mybg.png" } |
667 | |
760 | |
668 | =item rootalign $img |
761 | =item rootalign $img |
669 | |
762 | |
670 | Moves the image so that it appears glued to the screen as opposed to the |
763 | Moves the image so that it appears glued to the screen as opposed to the |
671 | window. This gives the illusion of a larger area behind the window. It is |
764 | window. This gives the illusion of a larger area behind the window. It is |
672 | exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the |
765 | exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the |
673 | top left of the screen. |
766 | top left of the screen. |
674 | |
767 | |
675 | Example: load a background image, put it in mirror mode and root align it. |
768 | Example: load a background image, put it in mirror mode and root align it. |
676 | |
769 | |
677 | rootalign mirror load "mybg.png" |
770 | rootalign keep { mirror load "mybg.png" } |
678 | |
771 | |
679 | Example: take the screen background and align it, giving the illusion of |
772 | Example: take the screen background and align it, giving the illusion of |
680 | transparency as long as the window isn't in front of other windows. |
773 | transparency as long as the window isn't in front of other windows. |
681 | |
774 | |
682 | rootalign root |
775 | rootalign root |
… | |
… | |
707 | |
800 | |
708 | sub rootalign($) { |
801 | sub rootalign($) { |
709 | move -TX, -TY, $_[0] |
802 | move -TX, -TY, $_[0] |
710 | } |
803 | } |
711 | |
804 | |
712 | =item rotate $center_x, $center_y, $degrees |
805 | =item rotate $center_x, $center_y, $degrees, $img |
713 | |
806 | |
714 | Rotates the image by C<$degrees> degrees, counter-clockwise, around the |
807 | Rotates the image clockwise by C<$degrees> degrees, around the point at |
715 | pointer at C<$center_x> and C<$center_y> (specified as factor of image |
808 | C<$center_x> and C<$center_y> (specified as factor of image width/height). |
716 | width/height). |
|
|
717 | |
809 | |
718 | #TODO# new width, height, maybe more operators? |
|
|
719 | |
|
|
720 | Example: rotate the image by 90 degrees |
810 | Example: rotate the image by 90 degrees around its center. |
|
|
811 | |
|
|
812 | rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" } |
721 | |
813 | |
722 | =cut |
814 | =cut |
723 | |
815 | |
724 | sub rotate($$$$) { |
816 | sub rotate($$$$) { |
725 | my $img = pop; |
817 | my $img = pop; |
… | |
… | |
734 | |
826 | |
735 | =head2 COLOUR MODIFICATIONS |
827 | =head2 COLOUR MODIFICATIONS |
736 | |
828 | |
737 | The following operators change the pixels of the image. |
829 | The following operators change the pixels of the image. |
738 | |
830 | |
739 | =over 4 |
831 | =over |
|
|
832 | |
|
|
833 | =item tint $color, $img |
|
|
834 | |
|
|
835 | Tints the image in the given colour. |
|
|
836 | |
|
|
837 | Example: tint the image red. |
|
|
838 | |
|
|
839 | tint "red", load "rgb.png" |
|
|
840 | |
|
|
841 | Example: the same, but specify the colour by component. |
|
|
842 | |
|
|
843 | tint [1, 0, 0], load "rgb.png" |
|
|
844 | |
|
|
845 | =cut |
|
|
846 | |
|
|
847 | sub tint($$) { |
|
|
848 | $_[1]->tint ($_[0]) |
|
|
849 | } |
|
|
850 | |
|
|
851 | =item shade $factor, $img |
|
|
852 | |
|
|
853 | Shade the image by the given factor. |
|
|
854 | |
|
|
855 | =cut |
|
|
856 | |
|
|
857 | sub shade($$) { |
|
|
858 | $_[1]->shade ($_[0]) |
|
|
859 | } |
740 | |
860 | |
741 | =item contrast $factor, $img |
861 | =item contrast $factor, $img |
742 | |
862 | |
743 | =item contrast $r, $g, $b, $img |
863 | =item contrast $r, $g, $b, $img |
744 | |
864 | |
… | |
… | |
774 | latter in a white picture. |
894 | latter in a white picture. |
775 | |
895 | |
776 | Due to idiosyncrasies in the underlying XRender extension, biases less |
896 | Due to idiosyncrasies in the underlying XRender extension, biases less |
777 | than zero can be I<very> slow. |
897 | than zero can be I<very> slow. |
778 | |
898 | |
|
|
899 | You can also try the experimental(!) C<muladd> operator. |
|
|
900 | |
779 | =cut |
901 | =cut |
780 | |
902 | |
781 | sub contrast($$;$$;$) { |
903 | sub contrast($$;$$;$) { |
782 | my $img = pop; |
904 | my $img = pop; |
783 | my ($r, $g, $b, $a) = @_; |
905 | my ($r, $g, $b, $a) = @_; |
… | |
… | |
798 | $a = 1 if @_ < 4; |
920 | $a = 1 if @_ < 4; |
799 | |
921 | |
800 | $img = $img->clone; |
922 | $img = $img->clone; |
801 | $img->brightness ($r, $g, $b, $a); |
923 | $img->brightness ($r, $g, $b, $a); |
802 | $img |
924 | $img |
|
|
925 | } |
|
|
926 | |
|
|
927 | =item muladd $mul, $add, $img # EXPERIMENTAL |
|
|
928 | |
|
|
929 | First multiplies the pixels by C<$mul>, then adds C<$add>. This can be used |
|
|
930 | to implement brightness and contrast at the same time, with a wider value |
|
|
931 | range than contrast and brightness operators. |
|
|
932 | |
|
|
933 | Due to numerous bugs in XRender implementations, it can also introduce a |
|
|
934 | number of visual artifacts. |
|
|
935 | |
|
|
936 | Example: increase contrast by a factor of C<$c> without changing image |
|
|
937 | brightness too much. |
|
|
938 | |
|
|
939 | muladd $c, (1 - $c) * 0.5, $img |
|
|
940 | |
|
|
941 | =cut |
|
|
942 | |
|
|
943 | sub muladd($$$) { |
|
|
944 | $_[2]->muladd ($_[0], $_[1]) |
803 | } |
945 | } |
804 | |
946 | |
805 | =item blur $radius, $img |
947 | =item blur $radius, $img |
806 | |
948 | |
807 | =item blur $radius_horz, $radius_vert, $img |
949 | =item blur $radius_horz, $radius_vert, $img |
… | |
… | |
819 | sub blur($$;$) { |
961 | sub blur($$;$) { |
820 | my $img = pop; |
962 | my $img = pop; |
821 | $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) |
963 | $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) |
822 | } |
964 | } |
823 | |
965 | |
|
|
966 | =item focus_fade $img |
|
|
967 | |
|
|
968 | =item focus_fade $factor, $img |
|
|
969 | |
|
|
970 | =item focus_fade $factor, $color, $img |
|
|
971 | |
|
|
972 | Fades the image by the given factor (and colour) when focus is lost (the |
|
|
973 | same as the C<-fade>/C<-fadecolor> command line options, which also supply |
|
|
974 | the default values for C<factor> and C<$color>. Unlike with C<-fade>, the |
|
|
975 | C<$factor> is a real value, not a percentage value (that is, 0..1, not |
|
|
976 | 0..100). |
|
|
977 | |
|
|
978 | Example: do the right thing when focus fading is requested. |
|
|
979 | |
|
|
980 | focus_fade load "mybg.jpg"; |
|
|
981 | |
|
|
982 | =cut |
|
|
983 | |
|
|
984 | sub focus_fade($;$$) { |
|
|
985 | my $img = pop; |
|
|
986 | |
|
|
987 | return $img |
|
|
988 | if FOCUS; |
|
|
989 | |
|
|
990 | my $fade = @_ >= 1 ? $_[0] : defined $self->resource ("fade") ? $self->resource ("fade") * 0.01 : 0; |
|
|
991 | my $color = @_ >= 2 ? $_[1] : $self->resource ("color+" . &urxvt::Color_fade ()); # Color_fade not always available |
|
|
992 | |
|
|
993 | $img = $img->tint ($color) if $color ne "rgb:00/00/00"; |
|
|
994 | $img = $img->muladd (1 - $fade, 0) if $fade; |
|
|
995 | |
|
|
996 | $img |
|
|
997 | } |
|
|
998 | |
824 | =back |
999 | =back |
825 | |
1000 | |
826 | =head2 OTHER STUFF |
1001 | =head2 OTHER STUFF |
827 | |
1002 | |
828 | Anything that didn't fit any of the other categories, even after applying |
1003 | Anything that didn't fit any of the other categories, even after applying |
829 | force and closing our eyes. |
1004 | force and closing our eyes. |
830 | |
1005 | |
831 | =over 4 |
1006 | =over |
832 | |
1007 | |
833 | =item once { ... } |
1008 | =item keep { ... } |
834 | |
1009 | |
835 | This function takes a code block as argument, that is, one or more |
1010 | This operator takes a code block as argument, that is, one or more |
836 | statements enclosed by braces. |
1011 | statements enclosed by braces. |
837 | |
1012 | |
838 | The trick is that this code block is only evaluated once - future calls |
1013 | The trick is that this code block is only evaluated when the outcome |
839 | will simply return the original image (yes, it should only be used with |
1014 | changes - on other calls the C<keep> simply returns the image it computed |
840 | images). |
1015 | previously (yes, it should only be used with images). Or in other words, |
|
|
1016 | C<keep> I<caches> the result of the code block so it doesn't need to be |
|
|
1017 | computed again. |
841 | |
1018 | |
842 | This can be extremely useful to avoid redoing the same slow operations |
1019 | This can be extremely useful to avoid redoing slow operations - for |
843 | again and again- for example, if your background expression takes the root |
1020 | example, if your background expression takes the root background, blurs it |
844 | background, blurs it and then root-aligns it it would have to blur the |
1021 | and then root-aligns it it would have to blur the root background on every |
845 | root background on every window move or resize. |
1022 | window move or resize. |
|
|
1023 | |
|
|
1024 | Another example is C<load>, which can be quite slow. |
846 | |
1025 | |
847 | In fact, urxvt itself encloses the whole expression in some kind of |
1026 | In fact, urxvt itself encloses the whole expression in some kind of |
848 | C<once> block so it only is reevaluated as required. |
1027 | C<keep> block so it only is reevaluated as required. |
849 | |
1028 | |
850 | Putting the blur into a C<once> block will make sure the blur is only done |
1029 | Putting the blur into a C<keep> block will make sure the blur is only done |
851 | once: |
1030 | once, while the C<rootalign> is still done each time the window moves. |
852 | |
1031 | |
853 | rootlign once { blur 10, root } |
1032 | rootalign keep { blur 10, root } |
854 | |
1033 | |
855 | This leaves the question of how to force reevaluation of the block, |
1034 | This leaves the question of how to force reevaluation of the block, |
856 | in case the root background changes: If expression inside the block |
1035 | in case the root background changes: If expression inside the block |
857 | is sensitive to some event (root background changes, window geometry |
1036 | is sensitive to some event (root background changes, window geometry |
858 | changes), then it will be reevaluated automatically as needed. |
1037 | changes), then it will be reevaluated automatically as needed. |
859 | |
1038 | |
860 | =item once_again |
1039 | =back |
861 | |
1040 | |
862 | Resets all C<once> block as if they had never been called, i.e. on the |
1041 | =head1 OLD BACKGROUND IMAGE SETTINGS |
863 | next call they will be reevaluated again. |
|
|
864 | |
1042 | |
865 | =cut |
1043 | This extension also provides support for the old options/resources and |
|
|
1044 | OSC sequences for setting a background image. These settings are |
|
|
1045 | B<deprecated> and will be removed in future versions. |
866 | |
1046 | |
|
|
1047 | =head2 OPTIONS AND RESOURCES |
|
|
1048 | |
|
|
1049 | =over |
|
|
1050 | |
|
|
1051 | =item B<-pixmap> I<file[;oplist]> |
|
|
1052 | |
|
|
1053 | =item B<backgroundPixmap:> I<file[;oplist]> |
|
|
1054 | |
|
|
1055 | Use the specified image file as the window's background and also |
|
|
1056 | optionally specify a colon separated list of operations to modify it. |
|
|
1057 | Note that you may need to quote the C<;> character when using the |
|
|
1058 | command line option, as C<;> is usually a metacharacter in shells. |
|
|
1059 | Supported operations are: |
|
|
1060 | |
|
|
1061 | =over |
|
|
1062 | |
|
|
1063 | =item B<WxH+X+Y> |
|
|
1064 | |
|
|
1065 | sets scale and position. B<"W" / "H"> specify the horizontal/vertical |
|
|
1066 | scale (percent), and B<"X" / "Y"> locate the image centre (percent). A |
|
|
1067 | scale of 0 disables scaling. |
|
|
1068 | |
|
|
1069 | =item B<op=tile> |
|
|
1070 | |
|
|
1071 | enables tiling |
|
|
1072 | |
|
|
1073 | =item B<op=keep-aspect> |
|
|
1074 | |
|
|
1075 | maintain the image aspect ratio when scaling |
|
|
1076 | |
|
|
1077 | =item B<op=root-align> |
|
|
1078 | |
|
|
1079 | use the position of the terminal window relative to the root window as |
|
|
1080 | the image offset, simulating a root window background |
|
|
1081 | |
|
|
1082 | =back |
|
|
1083 | |
|
|
1084 | The default scale and position setting is C<100x100+50+50>. |
|
|
1085 | Alternatively, a predefined set of templates can be used to achieve |
|
|
1086 | the most common setups: |
|
|
1087 | |
|
|
1088 | =over |
|
|
1089 | |
|
|
1090 | =item B<style=tiled> |
|
|
1091 | |
|
|
1092 | the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile |
|
|
1093 | |
|
|
1094 | =item B<style=aspect-stretched> |
|
|
1095 | |
|
|
1096 | the image is scaled to fill the whole window maintaining the aspect |
|
|
1097 | ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect |
|
|
1098 | |
|
|
1099 | =item B<style=stretched> |
|
|
1100 | |
|
|
1101 | the image is scaled to fill the whole window. Equivalent to 100x100 |
|
|
1102 | |
|
|
1103 | =item B<style=centered> |
|
|
1104 | |
|
|
1105 | the image is centered with no scaling. Equivalent to 0x0+50+50 |
|
|
1106 | |
|
|
1107 | =item B<style=root-tiled> |
|
|
1108 | |
|
|
1109 | the image is tiled with no scaling and using 'root' positioning. |
|
|
1110 | Equivalent to 0x0:op=tile:op=root-align |
|
|
1111 | |
|
|
1112 | =back |
|
|
1113 | |
|
|
1114 | If multiple templates are specified the last one wins. Note that a |
|
|
1115 | template overrides all the scale, position and operations settings. |
|
|
1116 | |
|
|
1117 | If used in conjunction with pseudo-transparency, the specified image |
|
|
1118 | will be blended over the transparent background using alpha-blending. |
|
|
1119 | |
|
|
1120 | =item B<-tr>|B<+tr> |
|
|
1121 | |
|
|
1122 | =item B<transparent:> I<boolean> |
|
|
1123 | |
|
|
1124 | Turn on/off pseudo-transparency by using the root pixmap as background. |
|
|
1125 | |
|
|
1126 | =item B<-tint> I<colour> |
|
|
1127 | |
|
|
1128 | =item B<tintColor:> I<colour> |
|
|
1129 | |
|
|
1130 | Tint the transparent background with the given colour. Note that a |
|
|
1131 | black tint yields a completely black image while a white tint yields |
|
|
1132 | the image unchanged. |
|
|
1133 | |
|
|
1134 | =item B<-sh> I<number> |
|
|
1135 | |
|
|
1136 | =item B<shading:> I<number> |
|
|
1137 | |
|
|
1138 | Darken (0 .. 99) or lighten (101 .. 200) the transparent background. |
|
|
1139 | A value of 100 means no shading. |
|
|
1140 | |
|
|
1141 | =item B<-blr> I<HxV> |
|
|
1142 | |
|
|
1143 | =item B<blurRadius:> I<HxV> |
|
|
1144 | |
|
|
1145 | Apply gaussian blur with the specified radius to the transparent |
|
|
1146 | background. If a single number is specified, the vertical and |
|
|
1147 | horizontal radii are considered to be the same. Setting one of the |
|
|
1148 | radii to 1 and the other to a large number creates interesting effects |
|
|
1149 | on some backgrounds. The maximum radius value is 128. An horizontal or |
|
|
1150 | vertical radius of 0 disables blurring. |
|
|
1151 | |
|
|
1152 | =back |
|
|
1153 | |
|
|
1154 | =head2 OSC sequences |
|
|
1155 | |
|
|
1156 | This extension will react to the following OSC sequences. Note that |
|
|
1157 | this extension will not be autoloaded when these are used currently, |
|
|
1158 | so to make urxvt recognize them, you have to enable the C<background> |
|
|
1159 | extension. One way to achieve that is to use the C<--background-expr ''> |
|
|
1160 | command line argument or by specifying an empty C<URxvt.background.expr:>> |
|
|
1161 | resource. |
|
|
1162 | |
|
|
1163 | =over |
|
|
1164 | |
|
|
1165 | =item B<< C<ESC ] 705 ; Pt ST> >> Change transparent background tint colour to B<< C<Pt> >>. |
|
|
1166 | |
|
|
1167 | =item B<< C<ESC ] 20 ; Pt ST> >> Change/Query background image |
|
|
1168 | parameters: the value of B<< C<Pt> >> can be one of the following |
|
|
1169 | commands: |
|
|
1170 | |
|
|
1171 | =over |
|
|
1172 | |
|
|
1173 | =item B<< C<?> >> |
|
|
1174 | |
|
|
1175 | display scale and position in the title |
|
|
1176 | |
|
|
1177 | =item B<< C<;WxH+X+Y> >> |
|
|
1178 | |
|
|
1179 | change scale and/or position |
|
|
1180 | |
|
|
1181 | =item B<< C<FILE;WxH+X+Y> >> |
|
|
1182 | |
|
|
1183 | change background image |
|
|
1184 | |
|
|
1185 | =back |
|
|
1186 | |
|
|
1187 | =cut |
|
|
1188 | |
867 | sub once(&) { |
1189 | sub keep(&) { |
868 | my $id = $_[0]+0; |
1190 | my $id = $_[0]+0; |
869 | |
1191 | |
870 | local $frame = $self->{frame_cache}{$id} ||= [$frame]; |
1192 | local $frame = $self->{frame_cache}{$id} ||= [$frame]; |
871 | |
1193 | |
872 | unless ($frame->[FR_CACHE]) { |
1194 | unless ($frame->[FR_CACHE]) { |
… | |
… | |
879 | # clear this frame cache, also for all parents |
1201 | # clear this frame cache, also for all parents |
880 | for (my $frame = $frame; $frame; $frame = $frame->[0]) { |
1202 | for (my $frame = $frame; $frame; $frame = $frame->[0]) { |
881 | undef $frame->[FR_CACHE]; |
1203 | undef $frame->[FR_CACHE]; |
882 | } |
1204 | } |
883 | |
1205 | |
884 | unless ($self->{term}) { |
|
|
885 | use Data::Dump; |
|
|
886 | ddx $frame; |
|
|
887 | exit; |
|
|
888 | } |
|
|
889 | |
|
|
890 | $self->recalculate; |
1206 | $self->recalculate; |
891 | }); |
1207 | }); |
892 | }; |
1208 | }; |
893 | |
1209 | |
894 | # in scalar context we always return the first original result, which |
1210 | # in scalar context we always return the first original result, which |
… | |
… | |
896 | wantarray |
1212 | wantarray |
897 | ? @{ $frame->[FR_CACHE] } |
1213 | ? @{ $frame->[FR_CACHE] } |
898 | : $frame->[FR_CACHE][0] |
1214 | : $frame->[FR_CACHE][0] |
899 | } |
1215 | } |
900 | |
1216 | |
901 | sub once_again() { |
1217 | # sub keep_clear() { |
902 | delete $self->{frame_cache}; |
1218 | # delete $self->{frame_cache}; |
903 | } |
1219 | # } |
904 | |
1220 | |
905 | =back |
1221 | =back |
906 | |
1222 | |
907 | =cut |
1223 | =cut |
908 | |
1224 | |
909 | } |
1225 | } |
910 | |
1226 | |
911 | sub parse_expr { |
1227 | sub parse_expr { |
|
|
1228 | my ($expr) = @_; |
|
|
1229 | |
|
|
1230 | # an empty expression is valid and represents the default background |
|
|
1231 | if ($expr !~ /\S/) { |
|
|
1232 | $expr = sub { |
|
|
1233 | undef |
|
|
1234 | }; |
|
|
1235 | } else { |
912 | my $expr = eval |
1236 | $expr = eval |
913 | "sub {\n" |
1237 | "sub {\n" |
914 | . "package urxvt::bgdsl;\n" |
1238 | . "package urxvt::bgdsl;\n" |
915 | . "#line 0 'background expression'\n" |
1239 | . "#line 0 'background expression'\n" |
916 | . "$_[0]\n" |
1240 | . "$expr\n" |
917 | . "}"; |
1241 | . "}"; |
918 | die if $@; |
1242 | die if $@; |
|
|
1243 | } |
|
|
1244 | |
919 | $expr |
1245 | $expr |
920 | } |
1246 | } |
921 | |
1247 | |
922 | # compiles a parsed expression |
1248 | # compiles a parsed expression |
923 | sub set_expr { |
1249 | sub set_expr { |
924 | my ($self, $expr) = @_; |
1250 | my ($self, $expr) = @_; |
925 | |
1251 | |
926 | $self->{root} = []; |
1252 | $self->{root} = []; # the outermost frame |
927 | $self->{expr} = $expr; |
1253 | $self->{expr} = $expr; |
928 | $self->recalculate; |
1254 | $self->recalculate; |
929 | } |
1255 | } |
930 | |
1256 | |
931 | # takes a hash of sensitivity indicators and installs watchers |
1257 | # takes a hash of sensitivity indicators and installs watchers |
… | |
… | |
972 | if ($again->{rootpmap}) { |
1298 | if ($again->{rootpmap}) { |
973 | $state->{rootpmap} = $self->on (rootpmap_change => $cb); |
1299 | $state->{rootpmap} = $self->on (rootpmap_change => $cb); |
974 | } else { |
1300 | } else { |
975 | delete $state->{rootpmap}; |
1301 | delete $state->{rootpmap}; |
976 | } |
1302 | } |
|
|
1303 | |
|
|
1304 | if ($again->{focus}) { |
|
|
1305 | $state->{focus} = $self->on (focus_in => $cb, focus_out => $cb); |
|
|
1306 | } else { |
|
|
1307 | delete $state->{focus}; |
|
|
1308 | } |
977 | } |
1309 | } |
978 | |
1310 | |
979 | # evaluate the current bg expression |
1311 | # evaluate the current bg expression |
980 | sub recalculate { |
1312 | sub recalculate { |
981 | my ($arg_self) = @_; |
1313 | my ($arg_self) = @_; |
… | |
… | |
989 | return; |
1321 | return; |
990 | } |
1322 | } |
991 | |
1323 | |
992 | $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; |
1324 | $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; |
993 | |
1325 | |
|
|
1326 | unless ($arg_self->has_render) { |
|
|
1327 | warn "background extension needs RENDER extension 0.11 or higher, ignoring background-expr.\n"; |
|
|
1328 | return; |
|
|
1329 | } |
|
|
1330 | |
994 | # set environment to evaluate user expression |
1331 | # set environment to evaluate user expression |
995 | |
1332 | |
996 | local $self = $arg_self; |
1333 | local $self = $arg_self; |
997 | local $HOME = $ENV{HOME}; |
1334 | local $HOME = $ENV{HOME}; |
998 | local $frame = []; |
1335 | local $frame = $self->{root}; |
999 | |
1336 | |
1000 | ($x, $y, $w, $h) = $self->background_geometry ($self->{border}); |
1337 | ($x, $y, $w, $h) = $self->background_geometry ($self->{border}); |
|
|
1338 | $focus = $self->focus; |
1001 | |
1339 | |
1002 | # evaluate user expression |
1340 | # evaluate user expression |
1003 | |
1341 | |
1004 | my @img = eval { $self->{expr}->() }; |
1342 | my @img = eval { $self->{expr}->() }; |
1005 | die $@ if $@; |
1343 | die $@ if $@; |
1006 | die "background-expr did not return anything.\n" unless @img; |
1344 | die "background-expr did not return anything.\n" unless @img; |
|
|
1345 | |
|
|
1346 | if ($img[0]) { |
1007 | die "background-expr: expected image(s), got something else.\n" |
1347 | die "background-expr: expected image(s), got something else.\n" |
1008 | if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img; |
1348 | if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img; |
1009 | |
1349 | |
1010 | my $img = urxvt::bgdsl::merge @img; |
1350 | my $img = urxvt::bgdsl::merge @img; |
1011 | |
1351 | |
1012 | $frame->[FR_AGAIN]{size} = 1 |
1352 | $frame->[urxvt::bgdsl::FR_AGAIN]{size} = 1 |
1013 | if $img->repeat_mode != urxvt::RepeatNormal; |
1353 | if $img->repeat_mode != urxvt::RepeatNormal; |
1014 | |
1354 | |
1015 | # if the expression is sensitive to external events, prepare reevaluation then |
1355 | # if the expression is sensitive to external events, prepare reevaluation then |
1016 | $self->compile_frame ($frame, sub { $arg_self->recalculate }); |
1356 | $self->compile_frame ($frame, sub { $arg_self->recalculate }); |
1017 | |
1357 | |
1018 | # clear stuff we no longer need |
1358 | # clear stuff we no longer need |
1019 | |
1359 | |
1020 | # unless (%{ $frame->[FR_STATE] }) { |
1360 | # unless (%{ $frame->[FR_STATE] }) { |
1021 | # delete $self->{state}; |
1361 | # delete $self->{state}; |
1022 | # delete $self->{expr}; |
1362 | # delete $self->{expr}; |
1023 | # } |
1363 | # } |
1024 | |
1364 | |
1025 | # set background pixmap |
1365 | # set background pixmap |
1026 | |
1366 | |
1027 | $self->set_background ($img, $self->{border}); |
1367 | $self->set_background ($img, $self->{border}); |
|
|
1368 | } else { |
|
|
1369 | $self->clr_background; |
|
|
1370 | } |
|
|
1371 | |
1028 | $self->scr_recolour (0); |
1372 | $self->scr_recolor (0); |
1029 | $self->want_refresh; |
1373 | $self->want_refresh; |
1030 | } |
1374 | } |
1031 | |
1375 | |
|
|
1376 | sub old_bg_opts { |
|
|
1377 | my ($self, $arg) = @_; |
|
|
1378 | |
|
|
1379 | $arg or return; |
|
|
1380 | |
|
|
1381 | my @str = split /;/, $arg; |
|
|
1382 | |
|
|
1383 | return unless $str[0] or $self->{bg_opts}->{path}; |
|
|
1384 | |
|
|
1385 | my $bg_opts = $self->{bg_opts}; |
|
|
1386 | |
|
|
1387 | if ($str[0]) { |
|
|
1388 | $bg_opts->{tile} = 0; |
|
|
1389 | $bg_opts->{keep_aspect} = 0; |
|
|
1390 | $bg_opts->{root_align} = 0; |
|
|
1391 | $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100; |
|
|
1392 | $bg_opts->{h_align} = $bg_opts->{v_align} = 50; |
|
|
1393 | $bg_opts->{path} = $str[0]; |
|
|
1394 | } |
|
|
1395 | |
|
|
1396 | my @oplist = split /:/, $str[1]; |
|
|
1397 | |
|
|
1398 | for (@oplist) { |
|
|
1399 | if (/style=tiled/i) { |
|
|
1400 | $bg_opts->{tile} = 1; |
|
|
1401 | $bg_opts->{keep_aspect} = 0; |
|
|
1402 | $bg_opts->{root_align} = 0; |
|
|
1403 | $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0; |
|
|
1404 | $bg_opts->{h_align} = $bg_opts->{v_align} = 0; |
|
|
1405 | } elsif (/style=aspect-stretched/i) { |
|
|
1406 | $bg_opts->{tile} = 0; |
|
|
1407 | $bg_opts->{keep_aspect} = 1; |
|
|
1408 | $bg_opts->{root_align} = 0; |
|
|
1409 | $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100; |
|
|
1410 | $bg_opts->{h_align} = $bg_opts->{v_align} = 50; |
|
|
1411 | } elsif (/style=stretched/i) { |
|
|
1412 | $bg_opts->{tile} = 0; |
|
|
1413 | $bg_opts->{keep_aspect} = 0; |
|
|
1414 | $bg_opts->{root_align} = 0; |
|
|
1415 | $bg_opts->{h_scale} = $bg_opts->{v_scale} = 100; |
|
|
1416 | $bg_opts->{h_align} = $bg_opts->{v_align} = 50; |
|
|
1417 | } elsif (/style=centered/i) { |
|
|
1418 | $bg_opts->{tile} = 0; |
|
|
1419 | $bg_opts->{keep_aspect} = 0; |
|
|
1420 | $bg_opts->{root_align} = 0; |
|
|
1421 | $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0; |
|
|
1422 | $bg_opts->{h_align} = $bg_opts->{v_align} = 50; |
|
|
1423 | } elsif (/style=root-tiled/i) { |
|
|
1424 | $bg_opts->{tile} = 1; |
|
|
1425 | $bg_opts->{keep_aspect} = 0; |
|
|
1426 | $bg_opts->{root_align} = 1; |
|
|
1427 | $bg_opts->{h_scale} = $bg_opts->{v_scale} = 0; |
|
|
1428 | $bg_opts->{h_align} = $bg_opts->{v_align} = 0; |
|
|
1429 | } elsif (/op=tile/i) { |
|
|
1430 | $bg_opts->{tile} = 1; |
|
|
1431 | } elsif (/op=keep-aspect/i) { |
|
|
1432 | $bg_opts->{keep_aspect} = 1; |
|
|
1433 | } elsif (/op=root-align/i) { |
|
|
1434 | $bg_opts->{root_align} = 1; |
|
|
1435 | } elsif (/^ =? ([0-9]+)? (?:[xX] ([0-9]+))? ([+-][0-9]+)? ([+-][0-9]+)? $/x) { |
|
|
1436 | my ($w, $h, $x, $y) = ($1, $2, $3, $4); |
|
|
1437 | |
|
|
1438 | if ($str[0]) { |
|
|
1439 | $w = $h unless defined $w; |
|
|
1440 | $h = $w unless defined $h; |
|
|
1441 | $y = $x unless defined $y; |
|
|
1442 | } |
|
|
1443 | |
|
|
1444 | $bg_opts->{h_scale} = $w if defined $w; |
|
|
1445 | $bg_opts->{v_scale} = $h if defined $h; |
|
|
1446 | $bg_opts->{h_align} = $x if defined $x; |
|
|
1447 | $bg_opts->{v_align} = $y if defined $y; |
|
|
1448 | } |
|
|
1449 | } |
|
|
1450 | } |
|
|
1451 | |
|
|
1452 | # helper function, quote string as perl without allowing |
|
|
1453 | # any code execution or other shenanigans. |
|
|
1454 | sub q0 { |
|
|
1455 | "qq\x00\Q$_[0]\E\x00" |
|
|
1456 | } |
|
|
1457 | |
|
|
1458 | sub old_bg_expr { |
|
|
1459 | my ($self) = @_; |
|
|
1460 | |
|
|
1461 | my $expr; |
|
|
1462 | |
|
|
1463 | my $bg_opts = $self->{bg_opts}; |
|
|
1464 | |
|
|
1465 | if ($bg_opts->{root} =~ /^\s*(?:true|yes|on|1)\s*$/i) { |
|
|
1466 | $expr .= "tile ("; |
|
|
1467 | |
|
|
1468 | my $shade = $bg_opts->{shade}; |
|
|
1469 | |
|
|
1470 | if ($shade) { |
|
|
1471 | $shade = List::Util::min $shade, 200; |
|
|
1472 | $shade = List::Util::max $shade, -100; |
|
|
1473 | $shade = 200 - (100 + $shade) if $shade < 0; |
|
|
1474 | |
|
|
1475 | $shade = $shade * 0.01 - 1; |
|
|
1476 | $expr .= "shade $shade, "; |
|
|
1477 | } |
|
|
1478 | |
|
|
1479 | my $tint = $bg_opts->{tint}; |
|
|
1480 | |
|
|
1481 | if ($tint) { |
|
|
1482 | $tint = q0 $tint; |
|
|
1483 | $expr .= "tint $tint,"; |
|
|
1484 | } |
|
|
1485 | |
|
|
1486 | my $blur = $bg_opts->{blur}; |
|
|
1487 | |
|
|
1488 | if ($blur and $blur =~ /^ =? ([0-9]+)? (?:[xX] ([0-9]+))? $/x) { |
|
|
1489 | my $hr = defined $1 ? $1 : 1; |
|
|
1490 | my $vr = defined $2 ? $2 : $hr; |
|
|
1491 | |
|
|
1492 | if ($hr != 0 and $vr != 0) { |
|
|
1493 | $expr .= "blur $hr, $vr, "; |
|
|
1494 | } |
|
|
1495 | } |
|
|
1496 | |
|
|
1497 | $expr .= "rootalign root)"; |
|
|
1498 | } |
|
|
1499 | |
|
|
1500 | if ($bg_opts->{path}) { |
|
|
1501 | my $file_expr; |
|
|
1502 | my $h_scale = $bg_opts->{h_scale} * 0.01; |
|
|
1503 | my $v_scale = $bg_opts->{v_scale} * 0.01; |
|
|
1504 | my $h_align = $bg_opts->{h_align} * 0.01; |
|
|
1505 | my $v_align = $bg_opts->{v_align} * 0.01; |
|
|
1506 | |
|
|
1507 | if (!$bg_opts->{tile}) { |
|
|
1508 | $file_expr .= "pad ("; |
|
|
1509 | } else { |
|
|
1510 | $file_expr .= "tile ("; |
|
|
1511 | } |
|
|
1512 | |
|
|
1513 | if ($bg_opts->{root_align}) { |
|
|
1514 | $file_expr .= "rootalign "; |
|
|
1515 | } else { |
|
|
1516 | $file_expr .= "align $h_align, $v_align, "; |
|
|
1517 | } |
|
|
1518 | |
|
|
1519 | if ($h_scale != 0 and $v_scale != 0) { |
|
|
1520 | my $op = $bg_opts->{keep_aspect} ? "fit" : "resize"; |
|
|
1521 | $file_expr .= "$op TW * $h_scale, TH * $v_scale, "; |
|
|
1522 | } |
|
|
1523 | |
|
|
1524 | my $path = q0 $bg_opts->{path}; |
|
|
1525 | |
|
|
1526 | $file_expr .= "keep { load $path })"; |
|
|
1527 | |
|
|
1528 | if ($expr) { |
|
|
1529 | $expr .= ", tint (\"[50]white\", $file_expr)"; |
|
|
1530 | } else { |
|
|
1531 | $expr = $file_expr; |
|
|
1532 | } |
|
|
1533 | } |
|
|
1534 | |
|
|
1535 | $expr |
|
|
1536 | } |
|
|
1537 | |
|
|
1538 | sub find_resource { |
|
|
1539 | my ($self, $res, $opt) = @_; |
|
|
1540 | |
|
|
1541 | my $v = $self->x_resource ($opt); |
|
|
1542 | $v = $self->x_resource ($res) unless defined $v; |
|
|
1543 | |
|
|
1544 | $v |
|
|
1545 | } |
|
|
1546 | |
|
|
1547 | sub parse_bgopts { |
|
|
1548 | my ($self) = @_; |
|
|
1549 | |
|
|
1550 | my $expr = $self->x_resource ("%.expr"); |
|
|
1551 | |
|
|
1552 | if (!$expr) { |
|
|
1553 | $self->{bg_opts} = { h_scale => 100, v_scale => 100, |
|
|
1554 | h_align => 50, v_align => 50 }; |
|
|
1555 | |
|
|
1556 | $self->{bg_opts}{shade} = $self->find_resource ("shading", "sh"); |
|
|
1557 | $self->{bg_opts}{tint} = $self->find_resource ("tintColor", "tint"); |
|
|
1558 | $self->{bg_opts}{blur} = $self->find_resource ("blurRadius", "blr"); |
|
|
1559 | $self->{bg_opts}{root} = $self->find_resource ("transparent", "tr"); |
|
|
1560 | |
|
|
1561 | $self->old_bg_opts ($self->find_resource ("backgroundPixmap", "pixmap")); |
|
|
1562 | $expr = $self->old_bg_expr; |
|
|
1563 | } |
|
|
1564 | |
|
|
1565 | $self->set_expr (parse_expr $expr); |
|
|
1566 | $self->{border} = $self->x_resource_boolean ("%.border"); |
|
|
1567 | |
|
|
1568 | $MIN_INTERVAL = $self->x_resource ("%.interval"); |
|
|
1569 | } |
|
|
1570 | |
1032 | sub on_start { |
1571 | sub on_start { |
1033 | my ($self) = @_; |
1572 | my ($self) = @_; |
1034 | |
1573 | |
1035 | my $expr = $self->x_resource ("%.expr") |
1574 | $self->parse_bgopts; |
1036 | or return; |
|
|
1037 | |
|
|
1038 | $self->has_render |
|
|
1039 | or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n"; |
|
|
1040 | |
|
|
1041 | $self->set_expr (parse_expr $expr); |
|
|
1042 | $self->{border} = $self->x_resource_boolean ("%.border"); |
|
|
1043 | |
|
|
1044 | $MIN_INTERVAL = $self->x_resource ("%.interval"); |
|
|
1045 | |
1575 | |
1046 | () |
1576 | () |
1047 | } |
1577 | } |
1048 | |
1578 | |
|
|
1579 | sub on_osc_seq { |
|
|
1580 | my ($self, $op, $arg) = @_; |
|
|
1581 | |
|
|
1582 | $op eq "20" or $op eq "705" |
|
|
1583 | or return; |
|
|
1584 | |
|
|
1585 | $self->{bg_opts} |
|
|
1586 | or $self->parse_bgopts; |
|
|
1587 | |
|
|
1588 | if ($op eq "20") { |
|
|
1589 | if ($arg eq "?") { |
|
|
1590 | my $h_scale = $self->{bg_opts}{h_scale}; |
|
|
1591 | my $v_scale = $self->{bg_opts}{v_scale}; |
|
|
1592 | my $h_align = $self->{bg_opts}{h_align}; |
|
|
1593 | my $v_align = $self->{bg_opts}{v_align}; |
|
|
1594 | $self->cmd_parse ("\033]2;[${h_scale}x${v_scale}+${h_align}+${v_align}]\007"); |
|
|
1595 | } else { |
|
|
1596 | $self->old_bg_opts ($arg); |
|
|
1597 | my $expr = $self->old_bg_expr; |
|
|
1598 | $self->set_expr (parse_expr $expr) if $expr; |
|
|
1599 | } |
|
|
1600 | } elsif ($op eq "705") { |
|
|
1601 | $self->{bg_opts}{tint} = $arg; |
|
|
1602 | my $expr = $self->old_bg_expr; |
|
|
1603 | $self->set_expr (parse_expr $expr) if $expr; |
|
|
1604 | } |
|
|
1605 | |
|
|
1606 | 1 |
|
|
1607 | } |
|
|
1608 | |