ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/perl/background
(Generate patch)

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.10 by root, Tue Jun 5 14:53:16 2012 UTC vs.
Revision 1.31 by root, Thu Jun 7 13:48:15 2012 UTC

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

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines