ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/perl/background
Revision: 1.30
Committed: Thu Jun 7 13:22:06 2012 UTC (11 years, 11 months ago) by root
Branch: MAIN
Changes since 1.29: +9 -17 lines
Log Message:
*** empty log message ***

File Contents

# Content
1 #! perl
2
3 #:META:X_RESOURCE:%.expr:string:background expression
4 #:META:X_RESOURCE:%.enable:boolean:some boolean
5 #:META:X_RESOURCE:%.extra.:value:extra config
6
7 our $EXPR;
8 #$EXPR = 'move W * 0.1, -H * 0.1, resize W * 0.5, H * 0.5, repeat_none load "opensource.png"';
9 $EXPR = 'move -TX, -TY, load "argb.png"';
10 #$EXPR = '
11 # rotate W, H, 50, 50, counter 1/59.95, repeat_mirror,
12 # clip X, Y, W, H, repeat_mirror,
13 # load "/root/pix/das_fette_schwein.jpg"
14 #';
15 #$EXPR = 'solid "red"';
16 #$EXPR = 'blur root, 10, 10'
17 #$EXPR = 'blur move (root, -x, -y), 5, 5'
18 #resize load "/root/pix/das_fette_schwein.jpg", w, h
19
20 use Safe;
21
22 our ($bgdsl_self, $old, $new);
23 our ($x, $y, $w, $h);
24
25 # enforce at least this interval between updates
26 our $MIN_INTERVAL = 1/100;
27
28 {
29 package urxvt::bgdsl; # background language
30
31 =head2 PROVIDERS/GENERATORS
32
33 =over 4
34
35 =item load $path
36
37 Loads the image at the given C<$path>. The image is set to plane tiling
38 mode.
39
40
41
42 =cut
43
44 sub load($) {
45 my ($path) = @_;
46
47 $new->{load}{$path} = $old->{load}{$path} || $bgdsl_self->new_img_from_file ($path);
48 }
49
50 sub root() {
51 $new->{rootpmap_sensitive} = 1;
52 die "root op not supported, exg, we need you";
53 }
54
55 sub solid($;$$) {
56 my $img = $bgdsl_self->new_img (urxvt::PictStandardARGB32, $_[1] || 1, $_[2] || 1);
57 $img->fill ($_[0]);
58 $img
59 }
60
61 =back
62
63 =head2 VARIABLES
64
65 =over 4
66
67 =cut
68
69 sub TX() { $new->{position_sensitive} = 1; $x }
70 sub TY() { $new->{position_sensitive} = 1; $y }
71 sub TW() { $new->{size_sensitive} = 1; $w }
72 sub TH() { $new->{size_sensitive} = 1; $h }
73
74 sub now() { urxvt::NOW }
75
76 sub again($) {
77 $new->{again} = $_[0];
78 }
79
80 sub counter($) {
81 $new->{again} = $_[0];
82 $bgdsl_self->{counter} + 0
83 }
84
85 =back
86
87 =head2 TILING MODES
88
89 The following operators modify the tiling mode of an image, that is, the
90 way that pixels outside the image area are painted when the image is used.
91
92 =over 4
93
94 =item tile $img
95
96 Tiles the whole plane with the image and returns this new image - or in
97 other words, it returns a copy of the image in plane tiling mode.
98
99 =item mirror $img
100
101 Similar to tile, but reflects the image each time it uses a new copy, so
102 that top edges always touch top edges, right edges always touch right
103 edges and so on (with normal tiling, left edges always touch right edges
104 and top always touch bottom edges).
105
106 =item pad $img
107
108 Takes an image and modifies it so that all pixels outside the image area
109 become transparent. This mode is most useful when you want to place an
110 image over another image or the background colour while leaving all
111 background pixels outside the image unchanged.
112
113 =item extend $img
114
115 Extends the image over the whole plane, using the closest pixel in the
116 area outside the image. This mode is mostly useful when you more complex
117 filtering operations and want the pixels outside the image to have the
118 same values as the pixels near the edge.
119
120 =cut
121
122 sub pad($) {
123 my $img = $_[0]->clone;
124 $img->repeat_mode (urxvt::RepeatNone);
125 $img
126 }
127
128 sub tile($) {
129 my $img = $_[0]->clone;
130 $img->repeat_mode (urxvt::RepeatNormal);
131 $img
132 }
133
134 sub mirror($) {
135 my $img = $_[0]->clone;
136 $img->repeat_mode (urxvt::RepeatReflect);
137 $img
138 }
139
140 sub extend($) {
141 my $img = $_[0]->clone;
142 $img->repeat_mode (urxvt::RepeatPad);
143 $img
144 }
145
146 =back
147
148 =head2 PIXEL OPERATORS
149
150 The following operators modify the image pixels in various ways.
151
152 =over 4
153
154 =item clone $img
155
156 Returns an exact copy of the image.
157
158 =cut
159
160 sub clone($) {
161 $_[0]->clone
162 }
163
164 =item clip $img
165
166 =item clip $width, $height, $img
167
168 =item clip $x, $y, $width, $height, $img
169
170 Clips an image to the given rectangle. If the rectangle is outside the
171 image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is
172 larger than the image, then the tiling mode defines how the extra pixels
173 will be filled.
174
175 If C<$x> an C<$y> are missing, then C<0> is assumed for both.
176
177 If C<$width> and C<$height> are missing, then the window size will be
178 assumed.
179
180 Example: load an image, blur it, and clip it to the window size to save
181 memory.
182
183 clip blur 10, load "mybg.png"
184
185 =cut
186
187 sub clip($;$$;$$) {
188 my $img = pop;
189 my $h = pop || TH;
190 my $w = pop || TW;
191 $img->sub_rect ($_[0], $_[1], $w, $h)
192 }
193
194 =item scale $img
195
196 =item scale $size_percent, $img
197
198 =item scale $width_percent, $height_percent, $img
199
200 Scales the image by the given percentages in horizontal
201 (C<$width_percent>) and vertical (C<$height_percent>) direction.
202
203 If only one percentage is give, it is used for both directions.
204
205 If no percentages are given, scales the image to the window size without
206 keeping aspect.
207
208 =item resize $width, $height, $img
209
210 Resizes the image to exactly C<$width> times C<$height> pixels.
211
212 =cut
213
214 #TODO: maximise, maximise_fill?
215
216 sub scale($$$) {
217 my $img = pop;
218
219 @_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01)
220 : @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01)
221 : $img->scale (TW, TH)
222 }
223
224 sub resize($$$) {
225 my $img = pop;
226 $img->scale ($_[0], $_[1])
227 }
228
229 sub move($$;$) {
230 my $img = pop->clone;
231 $img->move ($_[0], $_[1]);
232 $img
233 }
234
235 sub rotate($$$$$$) {
236 my $img = pop;
237 $img->rotate (
238 $_[0],
239 $_[1],
240 $_[2] * $img->w * .01,
241 $_[3] * $img->h * .01,
242 $_[4] * (3.14159265 / 180),
243 )
244 }
245
246 sub blur($$;$) {
247 my $img = pop;
248 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
249 }
250
251 sub contrast($$;$$;$) {
252 my $img = pop;
253 my ($r, $g, $b, $a) = @_;
254
255 ($g, $b) = ($r, $r) if @_ < 4;
256 $a = 1 if @_ < 5;
257
258 $img = $img->clone;
259 $img->contrast ($r, $g, $b, $a);
260 $img
261 }
262
263 sub brightness($$;$$;$) {
264 my $img = pop;
265 my ($r, $g, $b, $a) = @_;
266
267 ($g, $b) = ($r, $r) if @_ < 4;
268 $a = 1 if @_ < 5;
269
270 $img = $img->clone;
271 $img->brightness ($r, $g, $b, $a);
272 $img
273 }
274
275 =back
276
277 =cut
278
279 }
280
281 sub parse_expr {
282 my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}";
283 die if $@;
284 $expr
285 }
286
287 # compiles a parsed expression
288 sub set_expr {
289 my ($self, $expr) = @_;
290
291 $self->{expr} = $expr;
292 $self->recalculate;
293 }
294
295 # evaluate the current bg expression
296 sub recalculate {
297 my ($self) = @_;
298
299 # rate limit evaluation
300
301 if ($self->{next_refresh} > urxvt::NOW) {
302 $self->{next_refresh_timer} = urxvt::timer->new->after ($self->{next_refresh} - urxvt::NOW)->cb (sub {
303 $self->recalculate;
304 });
305 return;
306 }
307
308 $self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
309
310 # set environment to evaluate user expression
311
312 local $bgdsl_self = $self;
313
314 local $old = $self->{state};
315 local $new = my $state = $self->{state} = {};
316
317 my $border = 0; #d#
318
319 ($x, $y, $w, $h) =
320 $self->background_geometry ($border);
321
322 # evaluate user expression
323
324 my $img = eval { $self->{expr}->() };
325 warn $@ if $@;#d#
326 die if !UNIVERSAL::isa $img, "urxvt::img";
327
328 # if the expression is sensitive to external events, prepare reevaluation then
329
330 my $repeat;
331
332 if (my $again = $state->{again}) {
333 $repeat = 1;
334 $state->{timer} = $again == $old->{again}
335 ? $old->{timer}
336 : urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
337 ++$self->{counter};
338 $self->recalculate
339 });
340 }
341
342 if (delete $state->{position_sensitive}) {
343 $repeat = 1;
344 $self->enable (position_change => sub { $_[0]->recalculate });
345 } else {
346 $self->disable ("position_change");
347 }
348
349 if (delete $state->{size_sensitive}) {
350 $repeat = 1;
351 $self->enable (size_change => sub { $_[0]->recalculate });
352 } else {
353 $self->disable ("size_change");
354 }
355
356 if (delete $state->{rootpmap_sensitive}) {
357 $repeat = 1;
358 $self->enable (rootpmap_change => sub { $_[0]->recalculate });
359 } else {
360 $self->disable ("rootpmap_change");
361 }
362
363 # clear stuff we no longer need
364
365 %$old = ();
366
367 unless ($repeat) {
368 delete $self->{state};
369 delete $self->{expr};
370 }
371
372 # prepare and set background pixmap
373
374 $img = $img->sub_rect (0, 0, $w, $h)
375 if $img->w != $w || $img->h != $h;
376
377 $self->set_background ($img, $border);
378 $self->scr_recolour (0);
379 $self->want_refresh;
380 }
381
382 sub on_start {
383 my ($self) = @_;
384
385 $self->set_expr (parse_expr $EXPR);
386
387 ()
388 }
389