[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.16 by root, Tue Jan 3 01:41:06 2006 UTC vs.
Revision 1.66 by root, Mon Jan 9 19:28:39 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
15		17
16	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
17		19
18	=head1 DESCRIPTION	20	=head1 DESCRIPTION
19		21
20	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
21	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
22		24
23	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
24	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
25		27
26	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
27	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
28		30
29	=head1 PACKAGED EXTENSIONS	31	=head2 Prepackaged Extensions
30		32
31	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensiosn delivered with this version. You can
32	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
33		35
34	You can activate them like this:	36	You can activate them like this:
35		37
36	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
37		39
38	=over 4	40	=over 4
39		41
40	=item selection	42	=item selection (enabled by default)
41		43
42	Miscellaneous selection modifications.	44	Intelligent selection. This extension tries to be more intelligent when
		45	the user extends selections (double-click). Right now, it tries to select
		46	urls and complete shell-quoted arguments, which is very convenient, too,
		47	if your F<ls> supports C<--quoting-style=shell>.
		48
		49	It also offers the following bindable event:
43		50
44	=over 4	51	=over 4
45		52
46	=item rot13	53	=item rot13
47		54
…		…
49		56
50	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
51		58
52	=back	59	=back
53		60
		61	=item option-popup (enabled by default)
		62
		63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		64	runtime.
		65
		66	=item selection-popup (enabled by default)
		67
		68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		69	text into various other formats/action.
		70
54	=item digital-clock	71	=item digital-clock
		72
		73	Displays a digital clock using the built-in overlay.
		74
		75	=item mark-urls
		76
		77	Uses per-line display filtering (C<on_line_update>) to underline urls.
		78
		79	=item block-graphics-to-ascii
		80
		81	A not very useful example of filtering all text output to the terminal,
		82	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		83	similar-looking ascii character.
		84
		85	=item example-refresh-hooks
55		86
56	Displays a very simple digital clock in the upper right corner of the	87	Displays a very simple digital clock in the upper right corner of the
57	window. Illustrates overwriting the refresh callbacks to create your own	88	window. Illustrates overwriting the refresh callbacks to create your own
58	overlays or changes.	89	overlays or changes.
59		90
60	=item simple-overlay-clock
61
62	Displays a digital clock using the built-in overlay (colorful, useless).
63
64	=back	91	=back
65		92
66	=head2 General API Considerations	93	=head2 General API Considerations
67		94
68	All objects (such as terminals, time watchers etc.) are typical	95	All objects (such as terminals, time watchers etc.) are typical
69	reference-to-hash objects. The hash can be used to store anything you	96	reference-to-hash objects. The hash can be used to store anything you
70	like. All members starting with an underscore (such as C<_ptr> or	97	like. All members starting with an underscore (such as C<_ptr> or
71	C<_hook>) are reserved for internal uses and must not be accessed or	98	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
72	modified).	99	modified).
73		100
74	When objects are destroyed on the C++ side, the perl object hashes are	101	When objects are destroyed on the C++ side, the perl object hashes are
75	emptied, so its best to store related objects such as time watchers and	102	emptied, so its best to store related objects such as time watchers and
76	the like inside the terminal object so they get destroyed as soon as the	103	the like inside the terminal object so they get destroyed as soon as the
77	terminal is destroyed.	104	terminal is destroyed.
78		105
		106	Argument names also often indicate the type of a parameter. Here are some
		107	hints on what they mean:
		108
		109	=over 4
		110
		111	=item $text
		112
		113	Rxvt-unicodes special way of encoding text, where one "unicode" character
		114	always represents one screen cell. See L<row_t> for a discussion of this format.
		115
		116	=item $string
		117
		118	A perl text string, with an emphasis on I<text>. It can store all unicode
		119	characters and is to be distinguished with text encoded in a specific
		120	encoding (often locale-specific) and binary data.
		121
		122	=item $octets
		123
		124	Either binary data or - more common - a text string encoded in a
		125	locale-specific way.
		126
		127	=back
		128
79	=head2 Hooks	129	=head2 Hooks
80		130
81	The following subroutines can be declared in loaded scripts, and will be called	131	The following subroutines can be declared in extension files, and will be
82	whenever the relevant event happens.	132	called whenever the relevant event happens.
		133
		134	The first argument passed to them is an object private to each terminal
		135	and extension package. You can call all C<urxvt::term> methods on it, but
		136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		137	object that is shared between all packages is stored in the C<term>
		138	member. It is, however, blessed intot he package of the extension script,
		139	so for all practical purposes you can treat an extension script as a class.
83		140
84	All of them must return a boolean value. If it is true, then the event	141	All of them must return a boolean value. If it is true, then the event
85	counts as being I<consumed>, and the invocation of other hooks is skipped,	142	counts as being I<consumed>, and the invocation of other hooks is skipped,
86	and the relevant action might not be carried out by the C++ code.	143	and the relevant action might not be carried out by the C++ code.
87		144
…		…
90	=over 4	147	=over 4
91		148
92	=item on_init $term	149	=item on_init $term
93		150
94	Called after a new terminal object has been initialized, but before	151	Called after a new terminal object has been initialized, but before
95	windows are created or the command gets run.	152	windows are created or the command gets run. Most methods are unsafe to
		153	call or deliver senseless data, as terminal size and other characteristics
		154	have not yet been determined. You can safely query and change resources,
		155	though.
96		156
97	=item on_reset $term	157	=item on_reset $term
98		158
99	Called after the screen is "reset" for any reason, such as resizing or	159	Called after the screen is "reset" for any reason, such as resizing or
100	control sequences. Here is where you can react on changes to size-related	160	control sequences. Here is where you can react on changes to size-related
…		…
120	requested from the server. The selection text can be queried and changed	180	requested from the server. The selection text can be queried and changed
121	by calling C<< $term->selection >>.	181	by calling C<< $term->selection >>.
122		182
123	Returning a true value aborts selection grabbing. It will still be hilighted.	183	Returning a true value aborts selection grabbing. It will still be hilighted.
124		184
125	=item on_focus_in $term	185	=item on_sel_extend $term
126		186
127	Called whenever the window gets the keyboard focus, before urxvt does	187	Called whenever the user tries to extend the selection (e.g. with a double
128	focus in processing.	188	click) and is either supposed to return false (normal operation), or
129		189	should extend the selection itelf and return true to suppress the built-in
130	=item on_focus_out $term
131
132	Called wheneever the window loses keyboard focus, before urxvt does focus
133	out processing.	190	processing.
		191
		192	See the F<selection> example extension.
134		193
135	=item on_view_change $term, $offset	194	=item on_view_change $term, $offset
136		195
137	Called whenever the view offset changes, i..e the user or program	196	Called whenever the view offset changes, i..e the user or program
138	scrolls. Offset C<0> means display the normal terminal, positive values	197	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
146		205
147	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
148	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	207	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
149	number of lines that will be in the scrollback buffer.	208	number of lines that will be in the scrollback buffer.
150		209
151	=item on_tty_activity $term NYI	210	=item on_osc_seq $term, $string
152		211
153	Called whenever the program(s) running in the urxvt window send output.	212	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		213	operating system command) is processed. Cursor position and other state
		214	information is up-to-date when this happens. For interoperability, the
		215	string should start with the extension name and a colon, to distinguish
		216	it from commands for other extensions, and this might be enforced in the
		217	future.
		218
		219	Be careful not ever to trust (in a security sense) the data you receive,
		220	as its source can not easily be controleld (e-mail content, messages from
		221	other users on the same system etc.).
		222
		223	=item on_add_lines $term, $string
		224
		225	Called whenever text is about to be output, with the text as argument. You
		226	can filter/change and output the text yourself by returning a true value
		227	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		228	might be very slow, however, as your hook is called for B<all> text being
		229	output.
		230
		231	=item on_line_update $term, $row
		232
		233	Called whenever a line was updated or changed. Can be used to filter
		234	screen output (e.g. underline urls or other useless stuff). Only lines
		235	that are being shown will be filtered, and, due to performance reasons,
		236	not always immediately.
		237
		238	The row number is always the topmost row of the line if the line spans
		239	multiple rows.
		240
		241	Please note that, if you change the line, then the hook might get called
		242	later with the already-modified line (e.g. if unrelated parts change), so
		243	you cannot just toggle rendition bits, but only set them.
154		244
155	=item on_refresh_begin $term	245	=item on_refresh_begin $term
156		246
157	Called just before the screen gets redrawn. Can be used for overlay	247	Called just before the screen gets redrawn. Can be used for overlay
158	or similar effects by modify terminal contents in refresh_begin, and	248	or similar effects by modify terminal contents in refresh_begin, and
…		…
167		257
168	Called whenever the user presses a key combination that has a	258	Called whenever the user presses a key combination that has a
169	C<perl:string> action bound to it (see description of the B<keysym>	259	C<perl:string> action bound to it (see description of the B<keysym>
170	resource in the @@RXVT_NAME@@(1) manpage).	260	resource in the @@RXVT_NAME@@(1) manpage).
171		261
		262	=item on_focus_in $term
		263
		264	Called whenever the window gets the keyboard focus, before rxvt-unicode
		265	does focus in processing.
		266
		267	=item on_focus_out $term
		268
		269	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		270	focus out processing.
		271
		272	=item on_key_press $term, $event, $octets
		273
		274	=item on_key_release $term, $event
		275
		276	=item on_button_press $term, $event
		277
		278	=item on_button_release $term, $event
		279
		280	=item on_motion_notify $term, $event
		281
		282	=item on_map_notify $term, $event
		283
		284	=item on_unmap_notify $term, $event
		285
		286	Called whenever the corresponding X event is received for the terminal If
		287	the hook returns true, then the even will be ignored by rxvt-unicode.
		288
		289	The event is a hash with most values as named by Xlib (see the XEvent
		290	manpage), with the additional members C<row> and C<col>, which are the row
		291	and column under the mouse cursor.
		292
		293	C<on_key_press> additionally receives the string rxvt-unicode would
		294	output, if any, in locale-specific encoding.
		295
		296	subwindow.
		297
172	=back	298	=back
173		299
		300	=head2 Variables in the C<urxvt> Package
		301
		302	=over 4
		303
		304	=item $urxvt::TERM
		305
		306	The current terminal. This variable stores the current C<urxvt::term>
		307	object, whenever a callback/hook is executing.
		308
		309	=back
		310
174	=head2 Functions in the C<urxvt> Package	311	=head2 Functions in the C<urxvt> Package
175		312
176	=over 4	313	=over 4
		314
		315	=item $term = new urxvt [arg...]
		316
		317	Creates a new terminal, very similar as if you had started it with
		318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		319	if the new instance couldn't be created. Returns C<undef> if the new
		320	instance didn't initialise perl, and the terminal object otherwise. The
		321	C<init> and C<start> hooks will be called during the call.
177		322
178	=item urxvt::fatal $errormessage	323	=item urxvt::fatal $errormessage
179		324
180	Fatally aborts execution with the given error message. Avoid at all	325	Fatally aborts execution with the given error message. Avoid at all
181	costs! The only time this is acceptable is when the terminal process	326	costs! The only time this is acceptable is when the terminal process
…		…
188	that calls this function.	333	that calls this function.
189		334
190	Using this function has the advantage that its output ends up in the	335	Using this function has the advantage that its output ends up in the
191	correct place, e.g. on stderr of the connecting urxvtc client.	336	correct place, e.g. on stderr of the connecting urxvtc client.
192		337
		338	=item $is_safe = urxvt::safe
		339
		340	Returns true when it is safe to do potentially unsafe things, such as
		341	evaluating perl code specified by the user. This is true when urxvt was
		342	started setuid or setgid.
		343
193	=item $time = urxvt::NOW	344	=item $time = urxvt::NOW
194		345
195	Returns the "current time" (as per the event loop).	346	Returns the "current time" (as per the event loop).
196		347
		348	=item urxvt::CurrentTime
		349
		350	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		351	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		352	Button4Mask, Button5Mask, AnyModifier
		353
		354	Various constants for use in X calls and event processing.
		355
		356	=back
		357
		358	=head2 RENDITION
		359
		360	Rendition bitsets contain information about colour, font, font styles and
		361	similar information for each screen cell.
		362
		363	The following "macros" deal with changes in rendition sets. You should
		364	never just create a bitset, you should always modify an existing one,
		365	as they contain important information required for correct operation of
		366	rxvt-unicode.
		367
		368	=over 4
		369
		370	=item $rend = urxvt::DEFAULT_RSTYLE
		371
		372	Returns the default rendition, as used when the terminal is starting up or
		373	being reset. Useful as a base to start when creating renditions.
		374
		375	=item $rend = urxvt::OVERLAY_RSTYLE
		376
		377	Return the rendition mask used for overlays by default.
		378
		379	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		380
		381	Return the bit that enabled bold, italic, blink, reverse-video and
		382	underline, respectively. To enable such a style, just logically OR it into
		383	the bitset.
		384
		385	=item $foreground = urxvt::GET_BASEFG $rend
		386
		387	=item $background = urxvt::GET_BASEBG $rend
		388
		389	Return the foreground/background colour index, respectively.
		390
		391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		392
		393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		394
		395	Replace the foreground/background colour in the rendition mask with the
		396	specified one.
		397
		398	=item $value = urxvt::GET_CUSTOM ($rend)
		399
		400	Return the "custom" value: Every rendition has 5 bits for use by
		401	extensions. They can be set and changed as you like and are initially
		402	zero.
		403
		404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		405
		406	Change the custom value.
		407
		408	=back
		409
197	=cut	410	=cut
198		411
199	package urxvt;	412	package urxvt;
200		413
		414	use utf8;
201	use strict;	415	use strict;
		416	use Scalar::Util ();
		417	use List::Util ();
202		418
203	our $term;	419	our $VERSION = 1;
		420	our $TERM;
204	our @HOOKNAME;	421	our @HOOKNAME;
		422	our %OPTION;
205	our $LIBDIR;	423	our $LIBDIR;
206		424
207	BEGIN {	425	BEGIN {
208	urxvt->bootstrap;	426	urxvt->bootstrap;
209		427
…		…
212	my $msg = join "", @_;	430	my $msg = join "", @_;
213	$msg .= "\n"	431	$msg .= "\n"
214	unless $msg =~ /\n$/;	432	unless $msg =~ /\n$/;
215	urxvt::warn ($msg);	433	urxvt::warn ($msg);
216	};	434	};
		435
		436	delete $ENV{IFS};
		437	delete $ENV{CDPATH};
		438	delete $ENV{BASH_ENV};
		439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
217	}	440	}
218		441
219	my @hook_count;	442	my @hook_count;
220	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
221		444
…		…
233	my $name = $HOOKNAME[$htype];	456	my $name = $HOOKNAME[$htype];
234		457
235	my $ref = $pkg->can ("on_" . lc $name)	458	my $ref = $pkg->can ("on_" . lc $name)
236	or next;	459	or next;
237		460
238	$term->{_hook}[$htype]{$ref*1} = $ref;	461	$TERM->{_hook}[$htype]{$pkg} = $ref;
239	$hook_count[$htype]++	462	$hook_count[$htype]++
240	or set_should_invoke $htype, 1;	463	or set_should_invoke $htype, 1;
241	}	464	}
242	}	465	}
243		466
244	my $script_pkg = "script0000";	467	my $extension_pkg = "extension0000";
245	my %script_pkg;	468	my %extension_pkg;
246		469
247	# load a single script into its own package, once only	470	# load a single script into its own package, once only
248	sub script_package($) {	471	sub extension_package($) {
249	my ($path) = @_;	472	my ($path) = @_;
250		473
251	$script_pkg{$path} \|\|= do {	474	$extension_pkg{$path} \|\|= do {
252	my $pkg = "urxvt::" . ($script_pkg++);	475	my $pkg = "urxvt::" . ($extension_pkg++);
253		476
254	verbose 3, "loading script '$path' into package '$pkg'";	477	verbose 3, "loading extension '$path' into package '$pkg'";
255		478
256	open my $fh, "<:raw", $path	479	open my $fh, "<:raw", $path
257	or die "$path: $!";	480	or die "$path: $!";
258		481
259	my $source = "package $pkg; use strict; use utf8;\n"	482	my $source = untaint "package $pkg; use strict; use utf8;\n"
		483	. "use base urxvt::term::proxy::;\n"
260	. "#line 1 \"$path\"\n{\n"	484	. "#line 1 \"$path\"\n{\n"
261	. (do { local $/; <$fh> })	485	. (do { local $/; <$fh> })
262	. "\n};\n1";	486	. "\n};\n1";
263		487
264	eval $source or die "$path: $@";	488	eval $source or die "$path: $@";
265		489
266	$pkg	490	$pkg
267	}	491	}
268	}	492	}
269		493
		494	our $retval; # return value for urxvt
		495
270	# called by the rxvt core	496	# called by the rxvt core
271	sub invoke {	497	sub invoke {
272	local $term = shift;	498	local $TERM = shift;
273	my $htype = shift;	499	my $htype = shift;
274		500
275	if ($htype == 0) { # INIT	501	if ($htype == 0) { # INIT
276	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		503
		504	my %want_ext;
277		505
278	for my $ext (split /:/, $term->resource ("perl_ext")) {	506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		507	if ($_ eq "default") {
		508	$want_ext{$_}++ for qw(selection option-popup selection-popup);
		509	} elsif (/^-(.*)$/) {
		510	delete $want_ext{$1};
		511	} else {
		512	$want_ext{$_}++;
		513	}
		514	}
		515
		516	for my $ext (keys %want_ext) {
279	my @files = grep -f $_, map "$_/$ext", @dirs;	517	my @files = grep -f $_, map "$_/$ext", @dirs;
280		518
281	if (@files) {	519	if (@files) {
282	register_package script_package $files[0];	520	register_package extension_package $files[0];
283	} else {	521	} else {
284	warn "perl extension '$ext' not found in perl library search path\n";	522	warn "perl extension '$ext' not found in perl library search path\n";
285	}	523	}
286	}	524	}
287		525
		526	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		527	warn $@ if $@;
		528	}
		529
		530	$retval = undef;
		531
		532	if (my $cb = $TERM->{_hook}[$htype]) {
		533	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		534	if $verbosity >= 10;
		535
		536	keys %$cb;
		537
		538	while (my ($pkg, $cb) = each %$cb) {
		539	eval {
		540	$retval = $cb->(
		541	$TERM->{_pkg}{$pkg} \|\|= do {
		542	my $proxy = bless { }, $pkg;
		543	Scalar::Util::weaken ($proxy->{term} = $TERM);
		544	$proxy
		545	},
		546	@_,
		547	) and last;
		548	};
		549	if ($@) {
		550	$TERM->ungrab; # better to lose the grab than the session
		551	warn $@;
		552	}
		553	}
		554	}
		555
288	} elsif ($htype == 1) { # DESTROY	556	if ($htype == 1) { # DESTROY
		557	# remove hooks if unused
289	if (my $hook = $term->{_hook}) {	558	if (my $hook = $TERM->{_hook}) {
290	for my $htype (0..$#$hook) {	559	for my $htype (0..$#$hook) {
291	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
292	or set_should_invoke $htype, 0;	561	or set_should_invoke $htype, 0;
293	}	562	}
294	}	563	}
		564
		565	# clear package objects
		566	%$_ = () for values %{ $TERM->{_pkg} };
		567
		568	# clear package
		569	%$TERM = ();
295	}	570	}
296		571
297	my $cb = $term->{_hook}[$htype]	572	$retval
298	or return;	573	}
299		574
300	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	575	# urxvt::term::proxy
301	if $verbosity >= 10;
302		576
303	while (my ($k, $v) = each %$cb) {	577	sub urxvt::term::proxy::AUTOLOAD {
304	return 1 if $v->($term, @_);	578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		580
		581	eval qq{
		582	sub $urxvt::term::proxy::AUTOLOAD {
		583	my \$proxy = shift;
		584	\$proxy->{term}->$1 (\@_)
		585	}
		586	1
		587	} or die "FATAL: unable to compile method forwarder: $@";
		588
		589	goto &$urxvt::term::proxy::AUTOLOAD;
		590	}
		591
		592	sub urxvt::term::proxy::DESTROY {
		593	# nop
		594	}
		595
		596	# urxvt::destroy_hook
		597
		598	sub urxvt::destroy_hook::DESTROY {
		599	${$_[0]}->();
		600	}
		601
		602	sub urxvt::destroy_hook(&) {
		603	bless \shift, urxvt::destroy_hook::
		604	}
		605
		606	package urxvt::anyevent;
		607
		608	=head2 The C<urxvt::anyevent> Class
		609
		610	The sole purpose of this class is to deliver an interface to the
		611	C<AnyEvent> module - any module using it will work inside urxvt without
		612	further work. The only exception is that you cannot wait on condition
		613	variables, but non-blocking condvar use is ok. What this means is that you
		614	cannot use blocking APIs, but the non-blocking variant should work.
		615
		616	=cut
		617
		618	our $VERSION = 1;
		619
		620	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		621	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		622
		623	sub timer {
		624	my ($class, %arg) = @_;
		625
		626	my $cb = $arg{cb};
		627
		628	urxvt::timer
		629	->new
		630	->start (urxvt::NOW + $arg{after})
		631	->cb (sub {
		632	$_[0]->stop; # need to cancel manually
		633	$cb->();
		634	})
		635	}
		636
		637	sub io {
		638	my ($class, %arg) = @_;
		639
		640	my $cb = $arg{cb};
		641
		642	bless [$arg{fh}, urxvt::iow
		643	->new
		644	->fd (fileno $arg{fh})
		645	->events (($arg{poll} =~ /r/ ? 1 : 0)
		646	\| ($arg{poll} =~ /w/ ? 2 : 0))
		647	->start
		648	->cb (sub {
		649	$cb->(($_[1] & 1 ? 'r' : '')
		650	. ($_[1] & 2 ? 'w' : ''));
		651	})],
		652	urxvt::anyevent::
		653	}
		654
		655	sub DESTROY {
		656	$_[0][1]->stop;
		657	}
		658
		659	sub condvar {
		660	bless \my $flag, urxvt::anyevent::condvar::
		661	}
		662
		663	sub urxvt::anyevent::condvar::broadcast {
		664	${$_[0]}++;
		665	}
		666
		667	sub urxvt::anyevent::condvar::wait {
		668	unless (${$_[0]}) {
		669	require Carp;
		670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
305	}	671	}
306
307	0
308	}	672	}
309		673
310	=back	674	package urxvt::term;
311		675
312	=head2 The C<urxvt::term> Class	676	=head2 The C<urxvt::term> Class
313		677
314	=over 4	678	=over 4
		679
		680	=item $term->destroy
		681
		682	Destroy the terminal object (close the window, free resources etc.).
		683
		684	=item $isset = $term->option ($optval[, $set])
		685
		686	Returns true if the option specified by C<$optval> is enabled, and
		687	optionally change it. All option values are stored by name in the hash
		688	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		689
		690	Here is a a likely non-exhaustive list of option names, please see the
		691	source file F</src/optinc.h> to see the actual list:
		692
		693	borderLess console cursorBlink cursorUnderline hold iconic insecure
		694	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		695	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		696	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		697	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		698	tripleclickwords utmpInhibit visualBell
315		699
316	=item $value = $term->resource ($name[, $newval])	700	=item $value = $term->resource ($name[, $newval])
317		701
318	Returns the current resource value associated with a given name and	702	Returns the current resource value associated with a given name and
319	optionally sets a new value. Setting values is most useful in the C<init>	703	optionally sets a new value. Setting values is most useful in the C<init>
…		…
329		713
330	Please note that resource strings will currently only be freed when the	714	Please note that resource strings will currently only be freed when the
331	terminal is destroyed, so changing options frequently will eat memory.	715	terminal is destroyed, so changing options frequently will eat memory.
332		716
333	Here is a a likely non-exhaustive list of resource names, not all of which	717	Here is a a likely non-exhaustive list of resource names, not all of which
334	are supported in every build, please see the source to see the actual	718	are supported in every build, please see the source file F</src/rsinc.h>
335	list:	719	to see the actual list:
336		720
337	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	721	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
338	borderLess color cursorBlink cursorUnderline cutchars delete_key	722	borderLess color cursorBlink cursorUnderline cutchars delete_key
339	display_name embed ext_bwidth fade font geometry hold iconName	723	display_name embed ext_bwidth fade font geometry hold iconName
340	imFont imLocale inputMethod insecure int_bwidth intensityStyles	724	imFont imLocale inputMethod insecure int_bwidth intensityStyles
341	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	725	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
342	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	726	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
343	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	727	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
344	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	728	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
345	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	729	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
346	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	730	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
347	shade term_name title transparent transparent_all tripleclickwords	731	shade term_name title transparent transparent_all tripleclickwords
348	utmpInhibit visualBell	732	utmpInhibit visualBell
349		733
350	=cut	734	=cut
351		735
352	sub urxvt::term::resource($$;$) {	736	sub resource($$;$) {
353	my ($self, $name) = (shift, shift);	737	my ($self, $name) = (shift, shift);
354	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
355	goto &urxvt::term::_resource;	739	&urxvt::term::_resource
356	}	740	}
		741
		742	=item $rend = $term->rstyle ([$new_rstyle])
		743
		744	Return and optionally change the current rendition. Text that is output by
		745	the terminal application will use this style.
		746
		747	=item ($row, $col) = $term->screen_cur ([$row, $col])
		748
		749	Return the current coordinates of the text cursor position and optionally
		750	set it (which is usually bad as applications don't expect that).
357		751
358	=item ($row, $col) = $term->selection_mark ([$row, $col])	752	=item ($row, $col) = $term->selection_mark ([$row, $col])
359		753
360	=item ($row, $col) = $term->selection_beg ([$row, $col])	754	=item ($row, $col) = $term->selection_beg ([$row, $col])
361		755
…		…
371		765
372	=item $oldtext = $term->selection ([$newtext])	766	=item $oldtext = $term->selection ([$newtext])
373		767
374	Return the current selection text and optionally replace it by C<$newtext>.	768	Return the current selection text and optionally replace it by C<$newtext>.
375		769
376	=item $term->scr_overlay ($x, $y, $text)	770	#=item $term->overlay ($x, $y, $text)
377		771	#
378	Create a simple multi-line overlay box. See the next method for details.	772	#Create a simple multi-line overlay box. See the next method for details.
		773	#
		774	#=cut
		775	#
		776	#sub urxvt::term::scr_overlay {
		777	# my ($self, $x, $y, $text) = @_;
		778	#
		779	# my @lines = split /\n/, $text;
		780	#
		781	# my $w = 0;
		782	# for (map $self->strwidth ($_), @lines) {
		783	# $w = $_ if $w < $_;
		784	# }
		785	#
		786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
		787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
		788	#}
		789
		790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
		791
		792	Create a new (empty) overlay at the given position with the given
		793	width/height. C<$rstyle> defines the initial rendition style
		794	(default: C<OVERLAY_RSTYLE>).
		795
		796	If C<$border> is C<2> (default), then a decorative border will be put
		797	around the box.
		798
		799	If either C<$x> or C<$y> is negative, then this is counted from the
		800	right/bottom side, respectively.
		801
		802	This method returns an urxvt::overlay object. The overlay will be visible
		803	as long as the perl object is referenced.
		804
		805	The methods currently supported on C<urxvt::overlay> objects are:
		806
		807	=over 4
		808
		809	=item $overlay->set ($x, $y, $text, $rend)
		810
		811	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		812	text in rxvt-unicode's special encoding and an array of rendition values
		813	at a specific position inside the overlay.
		814
		815	=item $overlay->hide
		816
		817	If visible, hide the overlay, but do not destroy it.
		818
		819	=item $overlay->show
		820
		821	If hidden, display the overlay again.
		822
		823	=back
		824
		825	=item $popup = $term->popup ($event)
		826
		827	Creates a new C<urxvt::popup> object that implements a popup menu. The
		828	C<$event> I<must> be the event causing the menu to pop up (a button event,
		829	currently).
379		830
380	=cut	831	=cut
381		832
382	sub urxvt::term::scr_overlay {	833	sub popup {
383	my ($self, $x, $y, $text) = @_;	834	my ($self, $event) = @_;
384		835
385	my @lines = split /\n/, $text;	836	$self->grab ($event->{time}, 1)
		837	or return;
386		838
387	my $w = 0;	839	my $popup = bless {
388	for (map $self->strwidth ($_), @lines) {	840	term => $self,
389	$w = $_ if $w < $_;	841	event => $event,
390	}	842	}, urxvt::popup::;
391		843
392	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	844	Scalar::Util::weaken $popup->{term};
393	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
394	}
395		845
396	=item $term->scr_overlay_new ($x, $y, $width, $height)	846	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		847	Scalar::Util::weaken $self->{_destroy}{$popup};
397		848
398	Create a new (empty) overlay at the given position with the given	849	$popup
399	width/height. A border will be put around the box. If either C<$x> or	850	}
400	C<$y> is negative, then this is counted from the right/bottom side,
401	respectively.
402		851
403	=item $term->scr_overlay_off
404
405	Switch the overlay off again.
406
407	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)
408
409	Put a single character (specified numerically) at the given overlay
410	position.
411
412	=item $term->scr_overlay_set ($x, $y, $text)
413
414	Write a string at the given position into the overlay.
415
416	=item $cellwidth = $term->strwidth $string	852	=item $cellwidth = $term->strwidth ($string)
417		853
418	Returns the number of screen-cells this string would need. Correctly	854	Returns the number of screen-cells this string would need. Correctly
419	accounts for wide and combining characters.	855	accounts for wide and combining characters.
420		856
421	=item $octets = $term->locale_encode $string	857	=item $octets = $term->locale_encode ($string)
422		858
423	Convert the given text string into the corresponding locale encoding.	859	Convert the given text string into the corresponding locale encoding.
424		860
425	=item $string = $term->locale_decode $octets	861	=item $string = $term->locale_decode ($octets)
426		862
427	Convert the given locale-encoded octets into a perl string.	863	Convert the given locale-encoded octets into a perl string.
		864
		865	=item $term->scr_add_lines ($string)
		866
		867	Write the given text string to the screen, as if output by the application
		868	running inside the terminal. It may not contain command sequences (escape
		869	codes), but is free to use line feeds, carriage returns and tabs. The
		870	string is a normal text string, not in locale-dependent encoding.
		871
		872	Normally its not a good idea to use this function, as programs might be
		873	confused by changes in cursor position or scrolling. Its useful inside a
		874	C<on_add_lines> hook, though.
		875
		876	=item $term->cmd_parse ($octets)
		877
		878	Similar to C<scr_add_lines>, but the argument must be in the
		879	locale-specific encoding of the terminal and can contain command sequences
		880	(escape codes) that will be interpreted.
428		881
429	=item $term->tt_write ($octets)	882	=item $term->tt_write ($octets)
430		883
431	Write the octets given in C<$data> to the tty (i.e. as program input). To	884	Write the octets given in C<$data> to the tty (i.e. as program input). To
432	pass characters instead of octets, you should convert your strings first	885	pass characters instead of octets, you should convert your strings first
433	to the locale-specific encoding using C<< $term->locale_encode >>.	886	to the locale-specific encoding using C<< $term->locale_encode >>.
434		887
		888	=item $windowid = $term->parent
		889
		890	Return the window id of the toplevel window.
		891
		892	=item $windowid = $term->vt
		893
		894	Return the window id of the terminal window.
		895
		896	=item $window_width = $term->width
		897
		898	=item $window_height = $term->height
		899
		900	=item $font_width = $term->fwidth
		901
		902	=item $font_height = $term->fheight
		903
		904	=item $font_ascent = $term->fbase
		905
435	=item $nrow = $term->nrow	906	=item $terminal_rows = $term->nrow
436		907
437	=item $ncol = $term->ncol	908	=item $terminal_columns = $term->ncol
438		909
439	Return the number of rows/columns of the terminal window (i.e. as	910	=item $has_focus = $term->focus
440	specified by C<-geometry>, excluding any scrollback).
441		911
442	=item $nsaved = $term->nsaved	912	=item $is_mapped = $term->mapped
443		913
444	Returns the number of lines in the scrollback buffer.	914	=item $max_scrollback = $term->saveLines
		915
		916	=item $nrow_plus_saveLines = $term->total_rows
		917
		918	=item $lines_in_scrollback = $term->nsaved
		919
		920	Return various integers describing terminal characteristics.
		921
		922	=item $lc_ctype = $term->locale
		923
		924	Returns the LC_CTYPE category string used by this rxvt-unicode.
		925
		926	=item $x_display = $term->display_id
		927
		928	Return the DISPLAY used by rxvt-unicode.
		929
		930	=item $modifiermask = $term->ModLevel3Mask
		931
		932	=item $modifiermask = $term->ModMetaMask
		933
		934	=item $modifiermask = $term->ModNumLockMask
		935
		936	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		937	AltGr), the meta key (often Alt) and the num lock key, if applicable.
445		938
446	=item $view_start = $term->view_start ([$newvalue])	939	=item $view_start = $term->view_start ([$newvalue])
447		940
448	Returns the negative row number of the topmost line. Minimum value is	941	Returns the negative row number of the topmost line. Minimum value is
449	C<0>, which displays the normal terminal contents. Larger values scroll	942	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
460	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	953	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
461		954
462	Returns the text of the entire row with number C<$row_number>. Row C<0>	955	Returns the text of the entire row with number C<$row_number>. Row C<0>
463	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	956	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
464	terminal line. The scrollback buffer starts at line C<-1> and extends to	957	terminal line. The scrollback buffer starts at line C<-1> and extends to
465	line C<< -$term->nsaved >>.	958	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		959	is requested.
466		960
467	If C<$new_text> is specified, it will replace characters in the current	961	If C<$new_text> is specified, it will replace characters in the current
468	line, starting at column C<$start_col> (default C<0>), which is useful	962	line, starting at column C<$start_col> (default C<0>), which is useful
469	to replace only parts of a line. The font iindex in the rendition will	963	to replace only parts of a line. The font index in the rendition will
470	automatically be updated.	964	automatically be updated.
471		965
472	C<$text> is in a special encoding: tabs and wide characters that use more	966	C<$text> is in a special encoding: tabs and wide characters that use more
473	than one cell when displayed are padded with urxvt::NOCHAR characters	967	than one cell when displayed are padded with urxvt::NOCHAR characters
474	(C<chr 65535>). Characters with combining characters and other characters	968	(C<chr 65535>). Characters with combining characters and other characters
…		…
488	bitsets. Rendition bitsets contain information about colour, font, font	982	bitsets. Rendition bitsets contain information about colour, font, font
489	styles and similar information. See also C<< $term->ROW_t >>.	983	styles and similar information. See also C<< $term->ROW_t >>.
490		984
491	When setting rendition, the font mask will be ignored.	985	When setting rendition, the font mask will be ignored.
492		986
493	See the section on RENDITION, below.	987	See the section on RENDITION, above.
494		988
495	=item $length = $term->ROW_l ($row_number[, $new_length])	989	=item $length = $term->ROW_l ($row_number[, $new_length])
496		990
497	Returns the number of screen cells that are in use ("the line length"). If	991	Returns the number of screen cells that are in use ("the line
498	it is C<-1>, then the line is part of a multiple-row logical "line", which	992	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
499	means all characters are in use and it is continued on the next row.	993	line is joined with the following one.
		994
		995	=item $bool = $term->is_longer ($row_number)
		996
		997	Returns true if the row is part of a multiple-row logical "line" (i.e.
		998	joined with the following row), which means all characters are in use
		999	and it is continued on the next row (and possibly a continuation of the
		1000	previous row(s)).
		1001
		1002	=item $line = $term->line ($row_number)
		1003
		1004	Create and return a new C<urxvt::line> object that stores information
		1005	about the logical line that row C<$row_number> is part of. It supports the
		1006	following methods:
		1007
		1008	=over 4
		1009
		1010	=item $text = $line->t ([$new_text])
		1011
		1012	Returns or replaces the full text of the line, similar to C<ROW_t>
		1013
		1014	=item $rend = $line->r ([$new_rend])
		1015
		1016	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		1017
		1018	=item $length = $line->l
		1019
		1020	Returns the length of the line in cells, similar to C<ROW_l>.
		1021
		1022	=item $rownum = $line->beg
		1023
		1024	=item $rownum = $line->end
		1025
		1026	Return the row number of the first/last row of the line, respectively.
		1027
		1028	=item $offset = $line->offset_of ($row, $col)
		1029
		1030	Returns the character offset of the given row\|col pair within the logical
		1031	line.
		1032
		1033	=item ($row, $col) = $line->coord_of ($offset)
		1034
		1035	Translates a string offset into terminal coordinates again.
		1036
		1037	=back
		1038
		1039	=cut
		1040
		1041	sub line {
		1042	my ($self, $row) = @_;
		1043
		1044	my $maxrow = $self->nrow - 1;
		1045
		1046	my ($beg, $end) = ($row, $row);
		1047
		1048	--$beg while $self->ROW_is_longer ($beg - 1);
		1049	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1050
		1051	bless {
		1052	term => $self,
		1053	beg => $beg,
		1054	end => $end,
		1055	ncol => $self->ncol,
		1056	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1057	}, urxvt::line::
		1058	}
		1059
		1060	sub urxvt::line::t {
		1061	my ($self) = @_;
		1062
		1063	if (@_ > 1)
		1064	{
		1065	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1066	for $self->{beg} .. $self->{end};
		1067	}
		1068
		1069	defined wantarray &&
		1070	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1071	0, $self->{len}
		1072	}
		1073
		1074	sub urxvt::line::r {
		1075	my ($self) = @_;
		1076
		1077	if (@_ > 1)
		1078	{
		1079	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1080	for $self->{beg} .. $self->{end};
		1081	}
		1082
		1083	if (defined wantarray) {
		1084	my $rend = [
		1085	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1086	];
		1087	$#$rend = $self->{len} - 1;
		1088	return $rend;
		1089	}
		1090
		1091	()
		1092	}
		1093
		1094	sub urxvt::line::beg { $_[0]{beg} }
		1095	sub urxvt::line::end { $_[0]{end} }
		1096	sub urxvt::line::l { $_[0]{len} }
		1097
		1098	sub urxvt::line::offset_of {
		1099	my ($self, $row, $col) = @_;
		1100
		1101	($row - $self->{beg}) * $self->{ncol} + $col
		1102	}
		1103
		1104	sub urxvt::line::coord_of {
		1105	my ($self, $offset) = @_;
		1106
		1107	use integer;
		1108
		1109	(
		1110	$offset / $self->{ncol} + $self->{beg},
		1111	$offset % $self->{ncol}
		1112	)
		1113	}
500		1114
501	=item $text = $term->special_encode $string	1115	=item $text = $term->special_encode $string
502		1116
503	Converts a perl string into the special encoding used by rxvt-unicode,	1117	Converts a perl string into the special encoding used by rxvt-unicode,
504	where one character corresponds to one screen cell. See	1118	where one character corresponds to one screen cell. See
…		…
507	=item $string = $term->special_decode $text	1121	=item $string = $term->special_decode $text
508		1122
509	Converts rxvt-unicodes text reprsentation into a perl string. See	1123	Converts rxvt-unicodes text reprsentation into a perl string. See
510	C<< $term->ROW_t >> for details.	1124	C<< $term->ROW_t >> for details.
511		1125
		1126	=item $success = $term->grab_button ($button, $modifiermask)
		1127
		1128	Registers a synchronous button grab. See the XGrabButton manpage.
		1129
		1130	=item $success = $term->grab ($eventtime[, $sync])
		1131
		1132	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1133	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1134
		1135	=item $term->allow_events_async
		1136
		1137	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1138
		1139	=item $term->allow_events_sync
		1140
		1141	Calls XAllowEvents with SyncBoth for the most recent grab.
		1142
		1143	=item $term->allow_events_replay
		1144
		1145	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1146	recent grab.
		1147
		1148	=item $term->ungrab
		1149
		1150	Calls XUngrab for the most recent grab. Is called automatically on
		1151	evaluation errors, as it is better to lose the grab in the error case as
		1152	the session.
		1153
512	=back	1154	=back
513		1155
514	=head2 RENDITION	1156	=cut
515		1157
516	Rendition bitsets contain information about colour, font, font styles and	1158	package urxvt::popup;
517	similar information for each screen cell.
518		1159
519	The following "macros" deal with changes in rendition sets. You should	1160	=head2 The C<urxvt::popup> Class
520	never just create a bitset, you should always modify an existing one,
521	as they contain important information required for correct operation of
522	rxvt-unicode.
523		1161
524	=over 4	1162	=over 4
525		1163
526	=item $rend = urxvt::DEFAULT_RSTYLE
527
528	Returns the default rendition, as used when the terminal is starting up or
529	being reset. Useful as a base
530
531	=back
532
533	=cut	1164	=cut
		1165
		1166	sub add_item {
		1167	my ($self, $item) = @_;
		1168
		1169	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1170	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1171	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1172
		1173	$item->{render} \|\|= sub { $_[0]{text} };
		1174
		1175	push @{ $self->{item} }, $item;
		1176	}
		1177
		1178	sub add_separator {
		1179	my ($self, $sep) = @_;
		1180
		1181	$sep \|\|= "═";
		1182
		1183	$self->add_item ({
		1184	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1185	text => "",
		1186	render => sub { $sep x $self->{term}->ncol },
		1187	activate => sub { },
		1188	});
		1189	}
		1190
		1191	sub add_title {
		1192	my ($self, $title) = @_;
		1193
		1194	$self->add_item ({
		1195	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1196	text => $title,
		1197	activate => sub { },
		1198	});
		1199	}
		1200
		1201	sub add_button {
		1202	my ($self, $text, $cb) = @_;
		1203
		1204	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1205	}
		1206
		1207	sub add_toggle {
		1208	my ($self, $text, $cb, $value) = @_;
		1209
		1210	my $item; $item = {
		1211	type => "button",
		1212	text => " $text",
		1213	value => $value,
		1214	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1215	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1216	};
		1217
		1218	$self->add_item ($item);
		1219	}
		1220
		1221	sub show {
		1222	my ($self) = @_;
		1223
		1224	local $urxvt::popup::self = $self;
		1225
		1226	local $ENV{LC_ALL} = $self->{term}->locale;
		1227
		1228	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1229	"--transient-for" => $self->{term}->parent,
		1230	"-display" => $self->{term}->display_id,
		1231	"-pe" => "urxvt-popup")
		1232	or die "unable to create popup window\n";
		1233	}
		1234
		1235	sub DESTROY {
		1236	my ($self) = @_;
		1237
		1238	delete $self->{term}{_destroy}{$self};
		1239	$self->{term}->ungrab;
		1240	}
534		1241
535	=head2 The C<urxvt::timer> Class	1242	=head2 The C<urxvt::timer> Class
536		1243
537	This class implements timer watchers/events. Time is represented as a	1244	This class implements timer watchers/events. Time is represented as a
538	fractional number of seconds since the epoch. Example:	1245	fractional number of seconds since the epoch. Example:
539		1246
540	# create a digital clock display in upper right corner	1247	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
541	$term->{timer} = urxvt::timer	1248	$term->{timer} = urxvt::timer
542	->new	1249	->new
543	->start (urxvt::NOW)	1250	->interval (1)
544	->cb (sub {	1251	->cb (sub {
545	my ($timer) = @_;
546	my $time = $timer->at;
547	$timer->start ($time + 1);
548	$self->scr_overlay (-1, 0,	1252	$term->{overlay}->set (0, 0,
549	POSIX::strftime "%H:%M:%S", localtime $time);	1253	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
550	});	1254	});
551		1255
552	=over 4	1256	=over 4
553		1257
554	=item $timer = new urxvt::timer	1258	=item $timer = new urxvt::timer
555		1259
556	Create a new timer object in stopped state.	1260	Create a new timer object in started state. It is scheduled to fire
		1261	immediately.
557		1262
558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1263	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
559		1264
560	Set the callback to be called when the timer triggers.	1265	Set the callback to be called when the timer triggers.
561		1266
…		…
564	Return the time this watcher will fire next.	1269	Return the time this watcher will fire next.
565		1270
566	=item $timer = $timer->set ($tstamp)	1271	=item $timer = $timer->set ($tstamp)
567		1272
568	Set the time the event is generated to $tstamp.	1273	Set the time the event is generated to $tstamp.
		1274
		1275	=item $timer = $timer->interval ($interval)
		1276
		1277	Normally (and when C<$interval> is C<0>), the timer will automatically
		1278	stop after it has fired once. If C<$interval> is non-zero, then the timer
		1279	is automatically rescheduled at the given intervals.
569		1280
570	=item $timer = $timer->start	1281	=item $timer = $timer->start
571		1282
572	Start the timer.	1283	Start the timer.
573		1284
…		…
636	This variable controls the verbosity level of the perl extension. Higher	1347	This variable controls the verbosity level of the perl extension. Higher
637	numbers indicate more verbose output.	1348	numbers indicate more verbose output.
638		1349
639	=over 4	1350	=over 4
640		1351
641	=item 0 - only fatal messages	1352	=item == 0 - fatal messages
642		1353
643	=item 3 - script loading and management	1354	=item >= 3 - script loading and management
644		1355
645	=item 10 - all events received	1356	=item >=10 - all events received
646		1357
647	=back	1358	=back
648		1359
649	=head1 AUTHOR	1360	=head1 AUTHOR
650		1361

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.16 by root, Tue Jan 3 01:41:06 2006 UTC vs. Revision 1.66 by root, Mon Jan 9 19:28:39 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.16 by root, Tue Jan 3 01:41:06 2006 UTC vs.
Revision 1.66 by root, Mon Jan 9 19:28:39 2006 UTC