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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs. Revision 1.58 by root, Sun Jan 8 22:58:13 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.58 by root, Sun Jan 8 22:58:13 2006 UTC