[ViewVC] Diff of: cvs/rxvt-unicode/src/perl/background

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.20 by root, Wed Jun 6 22:01:45 2012 UTC vs.
Revision 1.35 by root, Fri Jun 8 08:06:38 2012 UTC

…		…
1	#! perl	1	#! perl
2		2
3	#:META:X_RESOURCE:%.expr:string:background expression	3	#:META:X_RESOURCE:%.expr:string:background expression
4	#:META:X_RESOURCE:%.enable:boolean:some boolean	4	#:META:X_RESOURCE:%.border.:boolean:respect the terminal border
5	#:META:X_RESOURCE:%.extra.:value:extra config
6		5
		6	#TODO: once, rootalign
		7
		8	=head1 background - manage terminal background
		9
		10	=head2 SYNOPSIS
		11
		12	rxvt -background-expr 'background expression'
		13	-background-border
		14
		15	=head2 DESCRIPTION
		16
		17	=head2 REFERENCE
		18
		19	=cut
		20
		21	our $EXPR;
		22	#$EXPR = 'move W * 0.1, -H * 0.1, resize W * 0.5, H * 0.5, repeat_none load "opensource.png"';
7	our $EXPR = 'move X, Y, load "MagnoliaAlpha.png"';	23	$EXPR = 'move -TX, -TY, load "argb.png"';
8	#$EXPR = '	24	#$EXPR = '
9	# rotate W, H, 50, 50, counter 1/59.95, repeat_mirror,	25	# rotate W, H, 50, 50, counter 1/59.95, repeat_mirror,
10	# clip X, Y, W, H, repeat_mirror,	26	# clip X, Y, W, H, repeat_mirror,
11	# load "/root/pix/das_fette_schwein.jpg"	27	# load "/root/pix/das_fette_schwein.jpg"
12	#';	28	#';
13	#$EXPR = 'solid "red"';	29	#$EXPR = 'solid "red"';
14	#$EXPR = 'blur root, 10, 10'	30	#$EXPR = 'blur root, 10, 10'
15	#$EXPR = 'blur move (root, -x, -y), 5, 5'	31	#$EXPR = 'blur move (root, -x, -y), 5, 5'
16	#resize load "/root/pix/das_fette_schwein.jpg", w, h	32	#resize load "/root/pix/das_fette_schwein.jpg", w, h
17		33
18	use Safe;
19
20	our ($bgdsl_self, $old, $new);	34	our ($self, $old, $new);
21	our ($l, $t, $w, $h);	35	our ($x, $y, $w, $h);
22		36
23	# enforce at least this interval between updates	37	# enforce at least this interval between updates
24	our $MIN_INTERVAL = 1/100;	38	our $MIN_INTERVAL = 1/100;
25		39
26	{	40	{
27	package urxvt::bgdsl; # background language	41	package urxvt::bgdsl; # background language
28		42
29	# *repeat_empty = \&urxvt::RepeatNone;
30	# *repeat_tile = \&urxvt::RepeatNormal;
31	# *repeat_pad = \&urxvt::RepeatPad;
32	# *repeat_mirror = \&urxvt::RepeatReflect;
33
34	=head2 PROVIDERS/GENERATORS	43	=head2 PROVIDERS/GENERATORS
35		44
		45	These functions provide an image, by loading it from disk, grabbing it
		46	from the root screen or by simply generating it. They are used as starting
		47	points to get an image you can play with.
		48
36	=over 4	49	=over 4
37		50
38	=item load $path	51	=item load $path
		52
		53	Loads the image at the given C<$path>. The image is set to plane tiling
		54	mode.
		55
		56	Loaded images will be cached for one cycle.
39		57
40	=cut	58	=cut
41		59
42	sub load($) {	60	sub load($) {
43	my ($path) = @_;	61	my ($path) = @_;
44		62
45	$new->{load}{$path} = $old->{load}{$path} \|\| $bgdsl_self->new_img_from_file ($path);	63	$new->{load}{$path} = $old->{load}{$path} \|\| $self->new_img_from_file ($path);
46	}	64	}
		65
		66	=item root
		67
		68	Returns the root window pixmap, that is, hopefully, the background image
		69	of your screen. The image is set to extend mode.
		70
		71	This function makes your expression root sensitive, that means it will be
		72	reevaluated when the bg image changes.
		73
		74	=cut
47		75
48	sub root() {	76	sub root() {
49	$new->{rootpmap_sensitive} = 1;	77	$new->{rootpmap_sensitive} = 1;
50	die "root op not supported, exg, we need you";	78	die "root op not supported, exg, we need you";
51	}	79	}
52		80
		81	=item solid $colour
		82
		83	=item solid $width, $height, $colour
		84
		85	Creates a new image and completely fills it with the given colour. The
		86	image is set to tiling mode.
		87
		88	If <$width> and C<$height> are omitted, it creates a 1x1 image, which is
		89	useful for solid backgrounds or for use in filtering effects.
		90
		91	=cut
		92
53	sub solid($;$$) {	93	sub solid($$;$) {
		94	my $colour = pop;
		95
54	my $img = $bgdsl_self->new_img (urxvt::PictStandardARGB32, $_[1] \|\| 1, $_[2] \|\| 1);	96	my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] \|\| 1, $_[1] \|\| 1);
55	$img->fill ($_[0]);	97	$img->fill ($colour);
56	$img	98	$img
57	}	99	}
58		100
59	=back	101	=back
60		102
61	=head2 VARIABLES	103	=head2 VARIABLES
62		104
		105	The following functions provide variable data such as the terminal
		106	window dimensions. Most of them make your expression sensitive to some
		107	events, for example using C<TW> (terminal width) means your expression is
		108	evaluated again when the terminal is resized.
		109
63	=over 4	110	=over 4
64		111
65	=cut	112	=item TX
66		113
		114	=item TY
		115
		116	Return the X and Y coordinates of the terminal window (the terminal
		117	window is the full window by default, and the character area only when in
		118	border-respect mode).
		119
		120	Using these functions make your expression sensitive to window moves.
		121
		122	These functions are mainly useful to align images to the root window.
		123
		124	Example: load an image and align it so it looks as if anchored to the
		125	background.
		126
		127	move -TX, -TY, load "mybg.png"
		128
		129	=item TW
		130
		131	Return the width (C<TW>) and height (C<TH>) of the terminal window (the
		132	terminal window is the full window by default, and the character area only
		133	when in border-respect mode).
		134
		135	Using these functions make your expression sensitive to window resizes.
		136
		137	These functions are mainly useful to scale images, or to clip images to
		138	the window size to conserve memory.
		139
		140	Example: take the screen background, clip it to the window size, blur it a
		141	bit, align it to the window position and use it as background.
		142
		143	clip move -TX, -TY, blur 5, root
		144
		145	=cut
		146
67	sub X() { $new->{position_sensitive} = 1; $l }	147	sub TX() { $new->{position_sensitive} = 1; $x }
68	sub Y() { $new->{position_sensitive} = 1; $t }	148	sub TY() { $new->{position_sensitive} = 1; $y }
69	sub W() { $new->{size_sensitive} = 1; $w }	149	sub TW() { $new->{size_sensitive} = 1; $w }
70	sub H() { $new->{size_sensitive} = 1; $h }	150	sub TH() { $new->{size_sensitive} = 1; $h }
		151
		152	=item now
		153
		154	Returns the current time as (fractional) seconds since the epoch.
		155
		156	Using this expression does I<not> make your expression sensitive to time,
		157	but the next two functions do.
		158
		159	=item again $seconds
		160
		161	When this function is used the expression will be reevaluated again in
		162	C<$seconds> seconds.
		163
		164	Example: load some image and rotate it according to the time of day (as if it were
		165	the hour pointer of a clock). update this image every minute.
		166
		167	again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
		168
		169	=item counter $seconds
		170
		171	Like C<again>, but also returns an increasing counter value, starting at
		172	0, which might be useful for some simple animation effects.
		173
		174	=cut
71		175
72	sub now() { urxvt::NOW }	176	sub now() { urxvt::NOW }
73		177
74	sub again($) {	178	sub again($) {
75	$new->{again} = $_[0];	179	$new->{again} = $_[0];
76	}	180	}
77		181
78	sub counter($) {	182	sub counter($) {
79	$new->{again} = $_[0];	183	$new->{again} = $_[0];
80	$bgdsl_self->{counter} + 0	184	$self->{counter} + 0
81	}	185	}
82		186
83	=back	187	=back
84		188
85	=head2 OPERATORS	189	=head2 TILING MODES
		190
		191	The following operators modify the tiling mode of an image, that is, the
		192	way that pixels outside the image area are painted when the image is used.
86		193
87	=over 4	194	=over 4
88		195
89	=cut	196	=item tile $img
90		197
		198	Tiles the whole plane with the image and returns this new image - or in
		199	other words, it returns a copy of the image in plane tiling mode.
		200
		201	Example: load an image and tile it over the background, without
		202	resizing. The C<tile> call is superfluous because C<load> already defaults
		203	to tiling mode.
		204
		205	tile load "mybg.png"
		206
		207	=item mirror $img
		208
		209	Similar to tile, but reflects the image each time it uses a new copy, so
		210	that top edges always touch top edges, right edges always touch right
		211	edges and so on (with normal tiling, left edges always touch right edges
		212	and top always touch bottom edges).
		213
		214	Exmaple: load an image and mirror it over the background, avoiding sharp
		215	edges at the image borders at the expense of mirroring the image itself
		216
		217	mirror load "mybg.png"
		218
		219	=item pad $img
		220
		221	Takes an image and modifies it so that all pixels outside the image area
		222	become transparent. This mode is most useful when you want to place an
		223	image over another image or the background colour while leaving all
		224	background pixels outside the image unchanged.
		225
		226	Example: load an image and display it in the upper left corner. The rets
		227	of the space is left "empty" (transparent or wahtever your compisotr does
		228	in alpha mode, else background colour).
		229
		230	pad load "mybg.png"
		231
		232	=item extend $img
		233
		234	Extends the image over the whole plane, using the closest pixel in the
		235	area outside the image. This mode is mostly useful when you more complex
		236	filtering operations and want the pixels outside the image to have the
		237	same values as the pixels near the edge.
		238
		239	Example: just for curiosity, how does this pixel extension stuff work?
		240
		241	extend move 50, 50, load "mybg.png"
		242
		243	=cut
		244
		245	sub pad($) {
		246	my $img = $_[0]->clone;
		247	$img->repeat_mode (urxvt::RepeatNone);
		248	$img
		249	}
		250
		251	sub tile($) {
		252	my $img = $_[0]->clone;
		253	$img->repeat_mode (urxvt::RepeatNormal);
		254	$img
		255	}
		256
		257	sub mirror($) {
		258	my $img = $_[0]->clone;
		259	$img->repeat_mode (urxvt::RepeatReflect);
		260	$img
		261	}
		262
		263	sub extend($) {
		264	my $img = $_[0]->clone;
		265	$img->repeat_mode (urxvt::RepeatPad);
		266	$img
		267	}
		268
		269	=back
		270
		271	=head2 PIXEL OPERATORS
		272
		273	The following operators modify the image pixels in various ways.
		274
		275	=over 4
		276
		277	=item clone $img
		278
		279	Returns an exact copy of the image.
		280
		281	=cut
		282
91	# sub clone($) {	283	sub clone($) {
92	# $_[0]->clone	284	$_[0]->clone
93	# }	285	}
		286
		287	=item clip $img
		288
		289	=item clip $width, $height, $img
		290
		291	=item clip $x, $y, $width, $height, $img
		292
		293	Clips an image to the given rectangle. If the rectangle is outside the
		294	image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is
		295	larger than the image, then the tiling mode defines how the extra pixels
		296	will be filled.
		297
		298	If C<$x> an C<$y> are missing, then C<0> is assumed for both.
		299
		300	If C<$width> and C<$height> are missing, then the window size will be
		301	assumed.
		302
		303	Example: load an image, blur it, and clip it to the window size to save
		304	memory.
		305
		306	clip blur 10, load "mybg.png"
		307
		308	=cut
94		309
95	sub clip($;$$;$$) {	310	sub clip($;$$;$$) {
96	my $img = pop;	311	my $img = pop;
		312	my $h = pop \|\| TH;
		313	my $w = pop \|\| TW;
97	$img->sub_rect ($_[0], $_[1], $_[2] \|\| W, $_[3] \|\| H)	314	$img->sub_rect ($_[0], $_[1], $w, $h)
		315	}
		316
		317	=item scale $img
		318
		319	=item scale $size_percent, $img
		320
		321	=item scale $width_percent, $height_percent, $img
		322
		323	Scales the image by the given percentages in horizontal
		324	(C<$width_percent>) and vertical (C<$height_percent>) direction.
		325
		326	If only one percentage is give, it is used for both directions.
		327
		328	If no percentages are given, scales the image to the window size without
		329	keeping aspect.
		330
		331	=item resize $width, $height, $img
		332
		333	Resizes the image to exactly C<$width> times C<$height> pixels.
		334
		335	=cut
		336
		337	#TODO: maximise, maximise_fill?
		338
		339	sub scale($;$;$) {
		340	my $img = pop;
		341
		342	@_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01)
		343	: @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01)
		344	: $img->scale (TW, TH)
98	}	345	}
99		346
100	sub resize($$$) {	347	sub resize($$$) {
101	my $img = pop;	348	my $img = pop;
102	$img->scale ($_[0], $_[1])	349	$img->scale ($_[0], $_[1])
103	}	350	}
104		351
105	# TODO: ugly
106	sub move($$;$) {	352	sub move($$;$) {
107	my $img = pop->clone;	353	my $img = pop->clone;
108	$img->move ($_[0], $_[1]);	354	$img->move ($_[0], $_[1]);
109	$img	355	$img
110	# my $img = pop;
111	# $img->sub_rect (
112	# $_[0], $_[1],
113	# $img->w, $img->h,
114	# $_[2],
115	# )
116	}	356	}
117		357
118	sub rotate($$$$$$) {	358	sub rotate($$$$$$) {
119	my $img = pop;	359	my $img = pop;
120	$img->rotate (	360	$img->rotate (
124	$_[3] * $img->h * .01,	364	$_[3] * $img->h * .01,
125	$_[4] * (3.14159265 / 180),	365	$_[4] * (3.14159265 / 180),
126	)	366	)
127	}	367	}
128		368
129	sub blur($$$) {	369	sub blur($$;$) {
130	my ($rh, $rv, $img) = @_;	370	my $img = pop;
131		371	$img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
132	$img->blur ($rh, $rv);
133	}	372	}
134		373
135	sub contrast($$;$$;$) {	374	sub contrast($$;$$;$) {
136	my $img = pop;	375	my $img = pop;
137	my ($r, $g, $b, $a) = @_;	376	my ($r, $g, $b, $a) = @_;
…		…
176	$self->recalculate;	415	$self->recalculate;
177	}	416	}
178		417
179	# evaluate the current bg expression	418	# evaluate the current bg expression
180	sub recalculate {	419	sub recalculate {
181	my ($self) = @_;	420	my ($arg_self) = @_;
182		421
183	# rate limit evaluation	422	# rate limit evaluation
184		423
185	if ($self->{next_refresh} > urxvt::NOW) {	424	if ($arg_self->{next_refresh} > urxvt::NOW) {
186	$self->{next_refresh_timer} = urxvt::timer->new->after ($self->{next_refresh} - urxvt::NOW)->cb (sub {	425	$arg_self->{next_refresh_timer} = urxvt::timer->new->after ($arg_self->{next_refresh} - urxvt::NOW)->cb (sub {
187	$self->recalculate;	426	$arg_self->recalculate;
188	});	427	});
189	return;	428	return;
190	}	429	}
191		430
192	$self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;	431	$arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
193		432
194	# set environment to evaluate user expression	433	# set environment to evaluate user expression
195		434
196	local $bgdsl_self = $self;	435	local $self = $arg_self;
197		436
198	local $old = $self->{state};	437	local $old = $self->{state};
199	local $new = my $state = $self->{state} = {};	438	local $new = my $state = $self->{state} = {};
200		439
201	($l, $t, $w, $h) =	440	($x, $y, $w, $h) =
202	$self->get_geometry;	441	$self->background_geometry ($self->{border});
203		442
204	# evaluate user expression	443	# evaluate user expression
205		444
206	my $img = eval { $self->{expr}->() };	445	my $img = eval { $self->{expr}->() };
207	warn $@ if $@;#d#	446	warn $@ if $@;#d#
208	die if !UNIVERSAL::isa $img, "urxvt::img";	447	die if !UNIVERSAL::isa $img, "urxvt::img";
209		448
		449	$state->{size_sensitive} = 1
		450	if $img->repeat_mode != urxvt::RepeatNormal;
		451
210	# if the expression is sensitive to external events, prepare reevaluation then	452	# if the expression is sensitive to external events, prepare reevaluation then
211		453
212	my $repeat;	454	my $repeat;
213		455
214	if (my $again = $state->{again}) {	456	if (my $again = $state->{again}) {
215	$repeat = 1;	457	$repeat = 1;
		458	my $self = $self;
216	$state->{timer} = $again == $old->{again}	459	$state->{timer} = $again == $old->{again}
217	? $old->{timer}	460	? $old->{timer}
218	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {	461	: urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
219	++$self->{counter};	462	++$self->{counter};
220	$self->recalculate	463	$self->recalculate
…		…
249	unless ($repeat) {	492	unless ($repeat) {
250	delete $self->{state};	493	delete $self->{state};
251	delete $self->{expr};	494	delete $self->{expr};
252	}	495	}
253		496
254	# prepare and set background pixmap	497	# set background pixmap
255		498
256	$img = $img->sub_rect (0, 0, $w, $h)
257	if $img->w != $w \|\| $img->h != $h;
258
259	$self->set_background ($img);	499	$self->set_background ($img, $self->{border});
260	$self->scr_recolour (0);	500	$self->scr_recolour (0);
261	$self->want_refresh;	501	$self->want_refresh;
262	}	502	}
263		503
264	sub on_start {	504	sub on_start {
265	my ($self) = @_;	505	my ($self) = @_;
266		506
		507	my $expr = $self->x_resource ("background.expr")
		508	or return;
		509
267	$self->set_expr (parse_expr $EXPR);	510	$self->set_expr (parse_expr $expr);
		511	$self->{border} = $self->x_resource_boolean ("background.border");
268		512
269	()	513	()
270	}	514	}
271		515

Diff Legend

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

Comparing rxvt-unicode/src/perl/background (file contents): Revision 1.20 by root, Wed Jun 6 22:01:45 2012 UTC vs. Revision 1.35 by root, Fri Jun 8 08:06:38 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.20 by root, Wed Jun 6 22:01:45 2012 UTC vs.
Revision 1.35 by root, Fri Jun 8 08:06:38 2012 UTC