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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.55 by root, Sun Jan 8 05:50:27 2006 UTC vs.
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	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
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	47	arguments, which is very convenient, too, if your F<ls> supports
		48	C<--quoting-style=shell>.
48		49
49	It also offers the following bindable event:	50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
		53	The selection works by trying to match a number of regexes and displaying
		54	them in increasing order of length. You can add your own regexes by
		55	specifying resources of the form:
		56
		57	URxvt.selection.pattern-0: perl-regex
		58	URxvt.selection.pattern-1: perl-regex
		59	...
		60
		61	The index number (0, 1...) must not have any holes, and each regex must
		62	contain at least one pair of capturing parentheses, which will be used for
		63	the match. For example, the followign adds a regex that matches everything
		64	between two vertical bars:
		65
		66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		67
		68	You can look at the source of the selection extension to see more
		69	interesting uses, such as parsing a line from beginning to end.
		70
		71	This extension also offers the following bindable keyboard command:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
…		…
58		80
59	=back	81	=back
60		82
61	=item option-popup (enabled by default)	83	=item option-popup (enabled by default)
62		84
63	Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at	85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	86	runtime.
65		87
66	=item digital-clock	88	=item selection-popup (enabled by default)
67		89
68	Displays a digital clock using the built-in overlay.	90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
		93
		94	=item searchable-scrollback<hotkey> (enabled by default)
		95
		96	Adds regex search functionality to the scrollback buffer, triggered
		97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		98	input/output is suspended and a regex is displayed at the bottom of the
		99	screen.
		100
		101	Inputting characters appends them to the regex and continues incremental
		102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		104	bottom. C<Escape> leaves search mode and returns to the point where search
		105	was started, while C<Enter> or C<Return> stay at the current position and
		106	additionally stores the first match in the current line into the primary
		107	selection.
		108
		109	=item selection-autotransform
		110
		111	This selection allows you to do automatic transforms on a selection
		112	whenever a selection is made.
		113
		114	It works by specifying perl snippets (most useful is a single C<s///>
		115	operator) that modify C<$_> as resources:
		116
		117	URxvt.selection-autotransform.0: transform
		118	URxvt.selection-autotransform.1: transform
		119	...
		120
		121	For example, the following will transform selections of the form
		122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		123	$word>:
		124
		125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		126
		127	And this example matches the same,but replaces it with vi-commands you can
		128	paste directly into your (vi :) editor:
		129
		130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		131
		132	Of course, this can be modified to suit your needs and your editor :)
		133
		134	To expand the example above to typical perl error messages ("XXX at
		135	FILENAME line YYY."), you need a slightly more elaborate solution:
		136
		137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		139
		140	The first line tells the selection code to treat the unchanging part of
		141	every error message as a selection pattern, and the second line transforms
		142	the message into vi commands to load the file.
69		143
70	=item mark-urls	144	=item mark-urls
71		145
72	Uses per-line display filtering (C<on_line_update>) to underline urls.	146	Uses per-line display filtering (C<on_line_update>) to underline urls and
		147	make them clickable. When middle-clicked, the program specified in the
		148	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		149	the URL as first argument.
73		150
74	=item block-graphics-to-ascii	151	=item block-graphics-to-ascii
75		152
76	A not very useful example of filtering all text output to the terminal,	153	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	154	by replacing all line-drawing characters (U+2500 .. U+259F) by a
78	similar-looking ascii character.	155	similar-looking ascii character.
79		156
		157	=item digital-clock
		158
		159	Displays a digital clock using the built-in overlay.
		160
80	=item example-refresh-hooks	161	=item example-refresh-hooks
81		162
82	Displays a very simple digital clock in the upper right corner of the	163	Displays a very simple digital clock in the upper right corner of the
83	window. Illustrates overwriting the refresh callbacks to create your own	164	window. Illustrates overwriting the refresh callbacks to create your own
84	overlays or changes.	165	overlays or changes.
85		166
86	=back	167	=back
		168
		169	=head1 API DOCUMENTATION
87		170
88	=head2 General API Considerations	171	=head2 General API Considerations
89		172
90	All objects (such as terminals, time watchers etc.) are typical	173	All objects (such as terminals, time watchers etc.) are typical
91	reference-to-hash objects. The hash can be used to store anything you	174	reference-to-hash objects. The hash can be used to store anything you
…		…
104	=over 4	187	=over 4
105		188
106	=item $text	189	=item $text
107		190
108	Rxvt-unicodes special way of encoding text, where one "unicode" character	191	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.	192	always represents one screen cell. See L<ROW_t> for a discussion of this format.
110		193
111	=item $string	194	=item $string
112		195
113	A perl text string, with an emphasis on I<text>. It can store all unicode	196	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	197	characters and is to be distinguished with text encoded in a specific
…		…
119	Either binary data or - more common - a text string encoded in a	202	Either binary data or - more common - a text string encoded in a
120	locale-specific way.	203	locale-specific way.
121		204
122	=back	205	=back
123		206
		207	=head2 Extension Objects
		208
		209	Very perl extension is a perl class. A separate perl object is created
		210	for each terminal and each extension and passed as the first parameter to
		211	hooks. So extensions can use their C<$self> object without having to think
		212	about other extensions, with the exception of methods and members that
		213	begin with an underscore character C<_>: these are reserved for internal
		214	use.
		215
		216	Although it isn't a C<urxvt::term> object, you can call all methods of the
		217	C<urxvt::term> class on this object.
		218
		219	It has the following methods and data members:
		220
		221	=over 4
		222
		223	=item $urxvt_term = $self->{term}
		224
		225	Returns the C<urxvt::term> object associated with this instance of the
		226	extension. This member I<must not> be changed in any way.
		227
		228	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		229
		230	Dynamically enable the given hooks (named without the C<on_> prefix) for
		231	this extension, replacing any previous hook. This is useful when you want
		232	to overwrite time-critical hooks only temporarily.
		233
		234	=item $self->disable ($hook_name[, $hook_name..])
		235
		236	Dynamically disable the given hooks.
		237
		238	=back
		239
124	=head2 Hooks	240	=head2 Hooks
125		241
126	The following subroutines can be declared in extension files, and will be	242	The following subroutines can be declared in extension files, and will be
127	called whenever the relevant event happens.	243	called whenever the relevant event happens.
128		244
129	The first argument passed to them is an object private to each terminal	245	The first argument passed to them is an extension oject as described in
130	and extension package. You can call all C<urxvt::term> methods on it, but	246	the in the C<Extension Objects> section.
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.
135		247
136	All of them must return a boolean value. If it is true, then the event	248	B<All> of these hooks must return a boolean value. If it is true, then the
137	counts as being I<consumed>, and the invocation of other hooks is skipped,	249	event counts as being I<consumed>, and the invocation of other hooks is
138	and the relevant action might not be carried out by the C++ code.	250	skipped, and the relevant action might not be carried out by the C++ code.
139		251
140	When in doubt, return a false value (preferably C<()>).	252	I<< When in doubt, return a false value (preferably C<()>). >>
141		253
142	=over 4	254	=over 4
143		255
144	=item on_init $term	256	=item on_init $term
145		257
…		…
180	=item on_sel_extend $term	292	=item on_sel_extend $term
181		293
182	Called whenever the user tries to extend the selection (e.g. with a double	294	Called whenever the user tries to extend the selection (e.g. with a double
183	click) and is either supposed to return false (normal operation), or	295	click) and is either supposed to return false (normal operation), or
184	should extend the selection itelf and return true to suppress the built-in	296	should extend the selection itelf and return true to suppress the built-in
185	processing.	297	processing. This can happen multiple times, as long as the callback
		298	returns true, it will be called on every further click by the user and is
		299	supposed to enlarge the selection more and more, if possible.
186		300
187	See the F<selection> example extension.	301	See the F<selection> example extension.
188		302
189	=item on_view_change $term, $offset	303	=item on_view_change $term, $offset
190		304
…		…
199	than the scroll back buffer or the terminal.	313	than the scroll back buffer or the terminal.
200		314
201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	315	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	316	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
203	number of lines that will be in the scrollback buffer.	317	number of lines that will be in the scrollback buffer.
204
205	=item on_tty_activity $term NYI
206
207	Called whenever the program(s) running in the urxvt window send output.
208		318
209	=item on_osc_seq $term, $string	319	=item on_osc_seq $term, $string
210		320
211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	321	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212	operating system command) is processed. Cursor position and other state	322	operating system command) is processed. Cursor position and other state
…		…
225	can filter/change and output the text yourself by returning a true value	335	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	336	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	337	might be very slow, however, as your hook is called for B<all> text being
228	output.	338	output.
229		339
		340	=item on_tt_write $term, $octets
		341
		342	Called whenever some data is written to the tty/pty and can be used to
		343	suppress or filter tty input.
		344
230	=item on_line_update $term, $row	345	=item on_line_update $term, $row
231		346
232	Called whenever a line was updated or changed. Can be used to filter	347	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	348	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,	349	that are being shown will be filtered, and, due to performance reasons,
…		…
266	=item on_focus_out $term	381	=item on_focus_out $term
267		382
268	Called wheneever the window loses keyboard focus, before rxvt-unicode does	383	Called wheneever the window loses keyboard focus, before rxvt-unicode does
269	focus out processing.	384	focus out processing.
270		385
271	=item on_key_press $term, $event, $octets	386	=item on_key_press $term, $event, $keysym, $octets
272		387
273	=item on_key_release $term, $event	388	=item on_key_release $term, $event, $keysym
274		389
275	=item on_button_press $term, $event	390	=item on_button_press $term, $event
276		391
277	=item on_button_release $term, $event	392	=item on_button_release $term, $event
278		393
…		…
294		409
295	subwindow.	410	subwindow.
296		411
297	=back	412	=back
298		413
		414	=cut
		415
		416	package urxvt;
		417
		418	use utf8;
		419	use strict;
		420	use Carp ();
		421	use Scalar::Util ();
		422	use List::Util ();
		423
		424	our $VERSION = 1;
		425	our $TERM;
		426	our @HOOKNAME;
		427	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		428	our %OPTION;
		429
		430	our $LIBDIR;
		431	our $RESNAME;
		432	our $RESCLASS;
		433	our $RXVTNAME;
		434
299	=head2 Variables in the C<urxvt> Package	435	=head2 Variables in the C<urxvt> Package
300		436
301	=over 4	437	=over 4
		438
		439	=item $urxvt::LIBDIR
		440
		441	The rxvt-unicode library directory, where, among other things, the perl
		442	modules and scripts are stored.
		443
		444	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		445
		446	The resource class and name rxvt-unicode uses to look up X resources.
		447
		448	=item $urxvt::RXVTNAME
		449
		450	The basename of the installed binaries, usually C<urxvt>.
302		451
303	=item $urxvt::TERM	452	=item $urxvt::TERM
304		453
305	The current terminal. This variable stores the current C<urxvt::term>	454	The current terminal. This variable stores the current C<urxvt::term>
306	object, whenever a callback/hook is executing.	455	object, whenever a callback/hook is executing.
…		…
308	=back	457	=back
309		458
310	=head2 Functions in the C<urxvt> Package	459	=head2 Functions in the C<urxvt> Package
311		460
312	=over 4	461	=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.
321		462
322	=item urxvt::fatal $errormessage	463	=item urxvt::fatal $errormessage
323		464
324	Fatally aborts execution with the given error message. Avoid at all	465	Fatally aborts execution with the given error message. Avoid at all
325	costs! The only time this is acceptable is when the terminal process	466	costs! The only time this is acceptable is when the terminal process
…		…
331	newline. The module also overwrites the C<warn> builtin with a function	472	newline. The module also overwrites the C<warn> builtin with a function
332	that calls this function.	473	that calls this function.
333		474
334	Using this function has the advantage that its output ends up in the	475	Using this function has the advantage that its output ends up in the
335	correct place, e.g. on stderr of the connecting urxvtc client.	476	correct place, e.g. on stderr of the connecting urxvtc client.
		477
		478	Messages have a size limit of 1023 bytes currently.
		479
		480	=item $is_safe = urxvt::safe
		481
		482	Returns true when it is safe to do potentially unsafe things, such as
		483	evaluating perl code specified by the user. This is true when urxvt was
		484	started setuid or setgid.
336		485
337	=item $time = urxvt::NOW	486	=item $time = urxvt::NOW
338		487
339	Returns the "current time" (as per the event loop).	488	Returns the "current time" (as per the event loop).
340		489
…		…
379		528
380	=item $background = urxvt::GET_BASEBG $rend	529	=item $background = urxvt::GET_BASEBG $rend
381		530
382	Return the foreground/background colour index, respectively.	531	Return the foreground/background colour index, respectively.
383		532
384	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	533	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385		534
386	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	535	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
387		536
388	Replace the foreground/background colour in the rendition mask with the	537	Replace the foreground/background colour in the rendition mask with the
389	specified one.	538	specified one.
390		539
391	=item $value = urxvt::GET_CUSTOM ($rend)	540	=item $value = urxvt::GET_CUSTOM $rend
392		541
393	Return the "custom" value: Every rendition has 5 bits for use by	542	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	543	extensions. They can be set and changed as you like and are initially
395	zero.	544	zero.
396		545
397	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	546	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398		547
399	Change the custom value.	548	Change the custom value.
400		549
401	=back	550	=back
402		551
403	=cut	552	=cut
404
405	package urxvt;
406
407	use utf8;
408	use strict;
409	use Scalar::Util ();
410	use List::Util ();
411
412	our $VERSION = 1;
413	our $TERM;
414	our @HOOKNAME;
415	our %OPTION;
416	our $LIBDIR;
417		553
418	BEGIN {	554	BEGIN {
419	urxvt->bootstrap;	555	urxvt->bootstrap;
420		556
421	# overwrite perl's warn	557	# overwrite perl's warn
…		…
423	my $msg = join "", @_;	559	my $msg = join "", @_;
424	$msg .= "\n"	560	$msg .= "\n"
425	unless $msg =~ /\n$/;	561	unless $msg =~ /\n$/;
426	urxvt::warn ($msg);	562	urxvt::warn ($msg);
427	};	563	};
		564
		565	# %ENV is the original startup environment
		566	delete $ENV{IFS};
		567	delete $ENV{CDPATH};
		568	delete $ENV{BASH_ENV};
		569	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
428	}	570	}
429		571
430	my @hook_count;	572	my @hook_count;
431	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	573	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
432		574
433	sub verbose {	575	sub verbose {
434	my ($level, $msg) = @_;	576	my ($level, $msg) = @_;
435	warn "$msg\n" if $level <= $verbosity;	577	warn "$msg\n" if $level <= $verbosity;
436	}	578	}
437		579
438	# find on_xxx subs in the package and register them
439	# as hooks
440	sub register_package($) {
441	my ($pkg) = @_;
442
443	for my $htype (0.. $#HOOKNAME) {
444	my $name = $HOOKNAME[$htype];
445
446	my $ref = $pkg->can ("on_" . lc $name)
447	or next;
448
449	$TERM->{_hook}[$htype]{$pkg} = $ref;
450	$hook_count[$htype]++
451	or set_should_invoke $htype, 1;
452	}
453	}
454
455	my $extension_pkg = "extension0000";	580	my $extension_pkg = "extension0000";
456	my %extension_pkg;	581	my %extension_pkg;
457		582
458	# load a single script into its own package, once only	583	# load a single script into its own package, once only
459	sub extension_package($) {	584	sub extension_package($) {
…		…
465	verbose 3, "loading extension '$path' into package '$pkg'";	590	verbose 3, "loading extension '$path' into package '$pkg'";
466		591
467	open my $fh, "<:raw", $path	592	open my $fh, "<:raw", $path
468	or die "$path: $!";	593	or die "$path: $!";
469		594
		595	my $source = untaint
470	my $source = "package $pkg; use strict; use utf8;\n"	596	"package $pkg; use strict; use utf8;\n"
471	. "use base urxvt::term::proxy::;\n"	597	. "use base urxvt::term::extension::;\n"
472	. "#line 1 \"$path\"\n{\n"	598	. "#line 1 \"$path\"\n{\n"
473	. (do { local $/; <$fh> })	599	. (do { local $/; <$fh> })
474	. "\n};\n1";	600	. "\n};\n1";
475		601
		602	eval $source
476	eval $source or die "$path: $@";	603	or die "$path: $@";
477		604
478	$pkg	605	$pkg
479	}	606	}
480	}	607	}
481		608
…		…
487	my $htype = shift;	614	my $htype = shift;
488		615
489	if ($htype == 0) { # INIT	616	if ($htype == 0) { # INIT
490	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	617	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
491		618
492	my %want_ext;	619	my %ext_arg;
493		620
494	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	621	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
495	if ($_ eq "default") {	622	if ($_ eq "default") {
496	$want_ext{$_}++ for qw(selection option-popup);	623	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
497	} elsif (/^-(.*)$/) {	624	} elsif (/^-(.*)$/) {
498	delete $want_ext{$1};	625	delete $ext_arg{$1};
		626	} elsif (/^([^<]+)<(.*)>$/) {
		627	push @{ $ext_arg{$1} }, $2;
499	} else {	628	} else {
500	$want_ext{$_}++;	629	$ext_arg{$_} \|\|= [];
501	}	630	}
502	}	631	}
503		632
504	for my $ext (keys %want_ext) {	633	while (my ($ext, $argv) = each %ext_arg) {
505	my @files = grep -f $_, map "$_/$ext", @dirs;	634	my @files = grep -f $_, map "$_/$ext", @dirs;
506		635
507	if (@files) {	636	if (@files) {
508	register_package extension_package $files[0];	637	$TERM->register_package (extension_package $files[0], $argv);
509	} else {	638	} else {
510	warn "perl extension '$ext' not found in perl library search path\n";	639	warn "perl extension '$ext' not found in perl library search path\n";
511	}	640	}
512	}	641	}
513		642
…		…
522	if $verbosity >= 10;	651	if $verbosity >= 10;
523		652
524	keys %$cb;	653	keys %$cb;
525		654
526	while (my ($pkg, $cb) = each %$cb) {	655	while (my ($pkg, $cb) = each %$cb) {
527	eval {	656	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
528	$retval = $cb->(
529	$TERM->{_pkg}{$pkg} \|\|= do {
530	my $proxy = bless { }, $pkg;
531	Scalar::Util::weaken ($proxy->{term} = $TERM);
532	$proxy
533	},
534	@_,
535	) and last;	657	and last;
		658
		659	if ($@) {
		660	$TERM->ungrab; # better to lose the grab than the session
		661	warn $@;
536	};	662	}
537	warn $@ if $@;#d#
538	}	663	}
		664
		665	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		666	if $verbosity >= 11;
539	}	667	}
540		668
541	if ($htype == 1) { # DESTROY	669	if ($htype == 1) { # DESTROY
542	# remove hooks if unused
543	if (my $hook = $TERM->{_hook}) {	670	if (my $hook = delete $TERM->{_hook}) {
544	for my $htype (0..$#$hook) {	671	for my $htype (0..$#$hook) {
545	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	672	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
546	or set_should_invoke $htype, 0;	673	or set_should_invoke $htype, 0;
547	}	674	}
548	}	675	}
…		…
555	}	682	}
556		683
557	$retval	684	$retval
558	}	685	}
559		686
560	# urxvt::term::proxy	687	sub exec_async(@) {
		688	my $pid = fork;
561		689
562	sub urxvt::term::proxy::AUTOLOAD {	690	return
563	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	691	if !defined $pid or $pid;
		692
		693	%ENV = %{ $TERM->env };
		694
		695	exec @_;
		696	_exit 255;
		697	}
		698
		699	# urxvt::term::extension
		700
		701	package urxvt::term::extension;
		702
		703	sub enable {
		704	my ($self, %hook) = @_;
		705	my $pkg = $self->{_pkg};
		706
		707	while (my ($name, $cb) = each %hook) {
		708	my $htype = $HOOKTYPE{uc $name};
		709	defined $htype
		710	or Carp::croak "unsupported hook type '$name'";
		711
		712	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		713	$hook_count[$htype]++
		714	or urxvt::set_should_invoke $htype, 1;
		715	}
		716
		717	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		718	}
		719	}
		720
		721	sub disable {
		722	my ($self, @hook) = @_;
		723	my $pkg = $self->{_pkg};
		724
		725	for my $name (@hook) {
		726	my $htype = $HOOKTYPE{uc $name};
		727	defined $htype
		728	or Carp::croak "unsupported hook type '$name'";
		729
		730	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		731	--$hook_count[$htype]
		732	or urxvt::set_should_invoke $htype, 0;
		733	}
		734	}
		735	}
		736
		737	our $AUTOLOAD;
		738
		739	sub AUTOLOAD {
		740	$AUTOLOAD =~ /:([^:]+)$/
564	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	741	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
565		742
566	eval qq{	743	eval qq{
567	sub $urxvt::term::proxy::AUTOLOAD {	744	sub $AUTOLOAD {
568	my \$proxy = shift;	745	my \$proxy = shift;
569	\$proxy->{term}->$1 (\@_)	746	\$proxy->{term}->$1 (\@_)
570	}	747	}
571	1	748	1
572	} or die "FATAL: unable to compile method forwarder: $@";	749	} or die "FATAL: unable to compile method forwarder: $@";
573		750
574	goto &$urxvt::term::proxy::AUTOLOAD;	751	goto &$AUTOLOAD;
		752	}
		753
		754	sub DESTROY {
		755	# nop
575	}	756	}
576		757
577	# urxvt::destroy_hook	758	# urxvt::destroy_hook
578		759
579	sub urxvt::destroy_hook::DESTROY {	760	sub urxvt::destroy_hook::DESTROY {
…		…
582		763
583	sub urxvt::destroy_hook(&) {	764	sub urxvt::destroy_hook(&) {
584	bless \shift, urxvt::destroy_hook::	765	bless \shift, urxvt::destroy_hook::
585	}	766	}
586		767
587	# urxvt::anyevent
588
589	package urxvt::anyevent;	768	package urxvt::anyevent;
		769
		770	=head2 The C<urxvt::anyevent> Class
		771
		772	The sole purpose of this class is to deliver an interface to the
		773	C<AnyEvent> module - any module using it will work inside urxvt without
		774	further programming. The only exception is that you cannot wait on
		775	condition variables, but non-blocking condvar use is ok. What this means
		776	is that you cannot use blocking APIs, but the non-blocking variant should
		777	work.
		778
		779	=cut
590		780
591	our $VERSION = 1;	781	our $VERSION = 1;
592		782
593	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	783	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
594	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	784	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
…		…
637	${$_[0]}++;	827	${$_[0]}++;
638	}	828	}
639		829
640	sub urxvt::anyevent::condvar::wait {	830	sub urxvt::anyevent::condvar::wait {
641	unless (${$_[0]}) {	831	unless (${$_[0]}) {
642	require Carp;
643	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	832	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
644	}	833	}
645	}	834	}
646		835
647	package urxvt::term;	836	package urxvt::term;
648		837
649	=head2 The C<urxvt::term> Class	838	=head2 The C<urxvt::term> Class
650		839
651	=over 4	840	=over 4
652		841
		842	=cut
		843
		844	# find on_xxx subs in the package and register them
		845	# as hooks
		846	sub register_package {
		847	my ($self, $pkg, $argv) = @_;
		848
		849	my $proxy = bless {
		850	_pkg => $pkg,
		851	argv => $argv,
		852	}, $pkg;
		853	Scalar::Util::weaken ($proxy->{term} = $self);
		854
		855	$self->{_pkg}{$pkg} = $proxy;
		856
		857	for my $name (@HOOKNAME) {
		858	if (my $ref = $pkg->can ("on_" . lc $name)) {
		859	$proxy->enable ($name => $ref);
		860	}
		861	}
		862	}
		863
		864	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		865
		866	Creates a new terminal, very similar as if you had started it with system
		867	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		868	hash which defines the environment of the new terminal.
		869
		870	Croaks (and probably outputs an error message) if the new instance
		871	couldn't be created. Returns C<undef> if the new instance didn't
		872	initialise perl, and the terminal object otherwise. The C<init> and
		873	C<start> hooks will be called during this call.
		874
		875	=cut
		876
		877	sub new {
		878	my ($class, $env, @args) = @_;
		879
		880	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		881	}
		882
653	=item $term->destroy	883	=item $term->destroy
654		884
655	Destroy the terminal object (close the window, free resources etc.).	885	Destroy the terminal object (close the window, free resources
		886	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		887	watchers (timers, io watchers) are still active.
656		888
657	=item $isset = $term->option ($optval[, $set])	889	=item $isset = $term->option ($optval[, $set])
658		890
659	Returns true if the option specified by C<$optval> is enabled, and	891	Returns true if the option specified by C<$optval> is enabled, and
660	optionally change it. All option values are stored by name in the hash	892	optionally change it. All option values are stored by name in the hash
…		…
710	my ($self, $name) = (shift, shift);	942	my ($self, $name) = (shift, shift);
711	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	943	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
712	&urxvt::term::_resource	944	&urxvt::term::_resource
713	}	945	}
714		946
		947	=item $value = $term->x_resource ($pattern)
		948
		949	Returns the X-Resource for the given pattern, excluding the program or
		950	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		951	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		952	resource with that pattern exists.
		953
		954	This method should only be called during the C<on_start> hook, as there is
		955	only one resource database per display, and later invocations might return
		956	the wrong resources.
		957
		958	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		959
		960	Adds a keymap translation exactly as specified via a resource. See the
		961	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		962
715	=item $rend = $term->rstyle ([$new_rstyle])	963	=item $rend = $term->rstyle ([$new_rstyle])
716		964
717	Return and optionally change the current rendition. Text that is output by	965	Return and optionally change the current rendition. Text that is output by
718	the terminal application will use this style.	966	the terminal application will use this style.
719		967
…		…
729	=item ($row, $col) = $term->selection_end ([$row, $col])	977	=item ($row, $col) = $term->selection_end ([$row, $col])
730		978
731	Return the current values of the selection mark, begin or end positions,	979	Return the current values of the selection mark, begin or end positions,
732	and optionally set them to new values.	980	and optionally set them to new values.
733		981
		982	=item $term->selection_make ($eventtime[, $rectangular])
		983
		984	Tries to make a selection as set by C<selection_beg> and
		985	C<selection_end>. If C<$rectangular> is true (default: false), a
		986	rectangular selection will be made. This is the prefered function to make
		987	a selection.
		988
734	=item $success = $term->selection_grab ($eventtime)	989	=item $success = $term->selection_grab ($eventtime)
735		990
736	Try to request the primary selection from the server (for example, as set	991	Try to request the primary selection text from the server (for example, as
737	by the next method).	992	set by the next method). No visual feedback will be given. This function
		993	is mostly useful from within C<on_sel_grab> hooks.
738		994
739	=item $oldtext = $term->selection ([$newtext])	995	=item $oldtext = $term->selection ([$newtext])
740		996
741	Return the current selection text and optionally replace it by C<$newtext>.	997	Return the current selection text and optionally replace it by C<$newtext>.
742		998
743	#=item $term->overlay ($x, $y, $text)	999	=item $term->overlay_simple ($x, $y, $text)
744	#	1000
745	#Create a simple multi-line overlay box. See the next method for details.	1001	Create a simple multi-line overlay box. See the next method for details.
746	#	1002
747	#=cut	1003	=cut
748	#	1004
749	#sub urxvt::term::scr_overlay {	1005	sub overlay_simple {
750	# my ($self, $x, $y, $text) = @_;	1006	my ($self, $x, $y, $text) = @_;
751	#	1007
752	# my @lines = split /\n/, $text;	1008	my @lines = split /\n/, $text;
753	#	1009
754	# my $w = 0;	1010	my $w = List::Util::max map $self->strwidth ($_), @lines;
755	# for (map $self->strwidth ($_), @lines) {	1011
756	# $w = $_ if $w < $_;
757	# }
758	#
759	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1012	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
760	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1013	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
761	#}	1014
		1015	$overlay
		1016	}
762		1017
763	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1018	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
764		1019
765	Create a new (empty) overlay at the given position with the given	1020	Create a new (empty) overlay at the given position with the given
766	width/height. C<$rstyle> defines the initial rendition style	1021	width/height. C<$rstyle> defines the initial rendition style
…		…
833		1088
834	=item $string = $term->locale_decode ($octets)	1089	=item $string = $term->locale_decode ($octets)
835		1090
836	Convert the given locale-encoded octets into a perl string.	1091	Convert the given locale-encoded octets into a perl string.
837		1092
		1093	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1094
		1095	XORs the rendition values in the given span with the provided value
		1096	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1097	refresh hooks to provide effects similar to the selection.
		1098
		1099	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1100
		1101	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1102	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1103	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1104	it instead. Both styles I<MUST NOT> contain font styles.
		1105
		1106	=item $term->scr_bell
		1107
		1108	Ring the bell!
		1109
838	=item $term->scr_add_lines ($string)	1110	=item $term->scr_add_lines ($string)
839		1111
840	Write the given text string to the screen, as if output by the application	1112	Write the given text string to the screen, as if output by the application
841	running inside the terminal. It may not contain command sequences (escape	1113	running inside the terminal. It may not contain command sequences (escape
842	codes), but is free to use line feeds, carriage returns and tabs. The	1114	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
856		1128
857	Write the octets given in C<$data> to the tty (i.e. as program input). To	1129	Write the octets given in C<$data> to the tty (i.e. as program input). To
858	pass characters instead of octets, you should convert your strings first	1130	pass characters instead of octets, you should convert your strings first
859	to the locale-specific encoding using C<< $term->locale_encode >>.	1131	to the locale-specific encoding using C<< $term->locale_encode >>.
860		1132
		1133	=item $old_events = $term->pty_ev_events ([$new_events])
		1134
		1135	Replaces the event mask of the pty watcher by the given event mask. Can
		1136	be used to suppress input and output handling to the pty/tty. See the
		1137	description of C<< urxvt::timer->events >>. Make sure to always restore
		1138	the previous value.
		1139
861	=item $windowid = $term->parent	1140	=item $windowid = $term->parent
862		1141
863	Return the window id of the toplevel window.	1142	Return the window id of the toplevel window.
864		1143
865	=item $windowid = $term->vt	1144	=item $windowid = $term->vt
…		…
889	=item $nrow_plus_saveLines = $term->total_rows	1168	=item $nrow_plus_saveLines = $term->total_rows
890		1169
891	=item $lines_in_scrollback = $term->nsaved	1170	=item $lines_in_scrollback = $term->nsaved
892		1171
893	Return various integers describing terminal characteristics.	1172	Return various integers describing terminal characteristics.
		1173
		1174	=item $x_display = $term->display_id
		1175
		1176	Return the DISPLAY used by rxvt-unicode.
		1177
		1178	=item $lc_ctype = $term->locale
		1179
		1180	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1181
		1182	=item $env = $term->env
		1183
		1184	Returns a copy of the environment in effect for the terminal as a hashref
		1185	similar to C<\%ENV>.
		1186
		1187	=cut
		1188
		1189	sub env {
		1190	if (my $env = $_[0]->_env) {
		1191	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1192	} else {
		1193	+{ %ENV }
		1194	}
		1195	}
894		1196
895	=item $modifiermask = $term->ModLevel3Mask	1197	=item $modifiermask = $term->ModLevel3Mask
896		1198
897	=item $modifiermask = $term->ModMetaMask	1199	=item $modifiermask = $term->ModMetaMask
898		1200
…		…
991	Return the row number of the first/last row of the line, respectively.	1293	Return the row number of the first/last row of the line, respectively.
992		1294
993	=item $offset = $line->offset_of ($row, $col)	1295	=item $offset = $line->offset_of ($row, $col)
994		1296
995	Returns the character offset of the given row\|col pair within the logical	1297	Returns the character offset of the given row\|col pair within the logical
996	line.	1298	line. Works for rows outside the line, too, and returns corresponding
		1299	offsets outside the string.
997		1300
998	=item ($row, $col) = $line->coord_of ($offset)	1301	=item ($row, $col) = $line->coord_of ($offset)
999		1302
1000	Translates a string offset into terminal coordinates again.	1303	Translates a string offset into terminal coordinates again.
1001		1304
…		…
1075	$offset / $self->{ncol} + $self->{beg},	1378	$offset / $self->{ncol} + $self->{beg},
1076	$offset % $self->{ncol}	1379	$offset % $self->{ncol}
1077	)	1380	)
1078	}	1381	}
1079		1382
1080	=item ($row, $col) = $line->coord_of ($offset)
1081	=item $text = $term->special_encode $string	1383	=item $text = $term->special_encode $string
1082		1384
1083	Converts a perl string into the special encoding used by rxvt-unicode,	1385	Converts a perl string into the special encoding used by rxvt-unicode,
1084	where one character corresponds to one screen cell. See	1386	where one character corresponds to one screen cell. See
1085	C<< $term->ROW_t >> for details.	1387	C<< $term->ROW_t >> for details.
…		…
1087	=item $string = $term->special_decode $text	1389	=item $string = $term->special_decode $text
1088		1390
1089	Converts rxvt-unicodes text reprsentation into a perl string. See	1391	Converts rxvt-unicodes text reprsentation into a perl string. See
1090	C<< $term->ROW_t >> for details.	1392	C<< $term->ROW_t >> for details.
1091		1393
		1394	=item $success = $term->grab_button ($button, $modifiermask)
		1395
		1396	Registers a synchronous button grab. See the XGrabButton manpage.
		1397
		1398	=item $success = $term->grab ($eventtime[, $sync])
		1399
		1400	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1401	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1402
		1403	=item $term->allow_events_async
		1404
		1405	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1406
		1407	=item $term->allow_events_sync
		1408
		1409	Calls XAllowEvents with SyncBoth for the most recent grab.
		1410
		1411	=item $term->allow_events_replay
		1412
		1413	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1414	recent grab.
		1415
		1416	=item $term->ungrab
		1417
		1418	Calls XUngrab for the most recent grab. Is called automatically on
		1419	evaluation errors, as it is better to lose the grab in the error case as
		1420	the session.
		1421
1092	=back	1422	=back
1093		1423
1094	=cut	1424	=cut
1095		1425
1096	package urxvt::popup;	1426	package urxvt::popup;
…		…
1111	$item->{render} \|\|= sub { $_[0]{text} };	1441	$item->{render} \|\|= sub { $_[0]{text} };
1112		1442
1113	push @{ $self->{item} }, $item;	1443	push @{ $self->{item} }, $item;
1114	}	1444	}
1115		1445
1116	sub add_separator {	1446	=item $popup->add_title ($title)
1117	my ($self, $sep) = @_;
1118		1447
1119	$sep \|\|= "═";	1448	Adds a non-clickable title to the popup.
1120		1449
1121	$self->add_item ({	1450	=cut
1122	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1123	text => "",
1124	render => sub { $sep x $urxvt::TERM->ncol },
1125	activate => sub { },
1126	});
1127	}
1128		1451
1129	sub add_title {	1452	sub add_title {
1130	my ($self, $title) = @_;	1453	my ($self, $title) = @_;
1131		1454
1132	$self->add_item ({	1455	$self->add_item ({
…		…
1134	text => $title,	1457	text => $title,
1135	activate => sub { },	1458	activate => sub { },
1136	});	1459	});
1137	}	1460	}
1138		1461
		1462	=item $popup->add_separator ([$sepchr])
		1463
		1464	Creates a separator, optionally using the character given as C<$sepchr>.
		1465
		1466	=cut
		1467
		1468	sub add_separator {
		1469	my ($self, $sep) = @_;
		1470
		1471	$sep \|\|= "=";
		1472
		1473	$self->add_item ({
		1474	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1475	text => "",
		1476	render => sub { $sep x $self->{term}->ncol },
		1477	activate => sub { },
		1478	});
		1479	}
		1480
		1481	=item $popup->add_button ($text, $cb)
		1482
		1483	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1484	selected.
		1485
		1486	=cut
		1487
1139	sub add_button {	1488	sub add_button {
1140	my ($self, $text, $cb) = @_;	1489	my ($self, $text, $cb) = @_;
1141		1490
1142	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1491	$self->add_item ({ type => "button", text => $text, activate => $cb});
1143	}	1492	}
		1493
		1494	=item $popup->add_toggle ($text, $cb, $initial_value)
		1495
		1496	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1497	whenever it gets toggled, with a boolean indicating its value as its first
		1498	argument.
		1499
		1500	=cut
1144		1501
1145	sub add_toggle {	1502	sub add_toggle {
1146	my ($self, $text, $cb, $value) = @_;	1503	my ($self, $text, $cb, $value) = @_;
1147		1504
1148	my $item; $item = {	1505	my $item; $item = {
1149	type => "button",	1506	type => "button",
1150	text => " $text",	1507	text => " $text",
1151	value => $value,	1508	value => $value,
1152	render => sub { ($item->{value} ? "* " : " ") . $text },	1509	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1153	activate => sub { $cb->($item->{value} = !$item->{value}); },	1510	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1154	};	1511	};
1155		1512
1156	$self->add_item ($item);	1513	$self->add_item ($item);
1157	}	1514	}
		1515
		1516	=item $popup->show
		1517
		1518	Displays the popup (which is initially hidden).
		1519
		1520	=cut
1158		1521
1159	sub show {	1522	sub show {
1160	my ($self) = @_;	1523	my ($self) = @_;
1161		1524
1162	local $urxvt::popup::self = $self;	1525	local $urxvt::popup::self = $self;
1163		1526
		1527	my $env = $self->{term}->env;
		1528	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1529	delete $env->{LC_ALL};
		1530	$env->{LC_CTYPE} = $self->{term}->locale;
		1531
		1532	urxvt::term->new ($env, $self->{term}->resource ("name"),
1164	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1533	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1165	"--transient-for" => $self->{term}->parent,	1534	"--transient-for" => $self->{term}->parent,
		1535	"-display" => $self->{term}->display_id,
1166	"-pe" => "urxvt-popup")	1536	"-pe" => "urxvt-popup")
1167	or die "unable to create popup window\n";	1537	or die "unable to create popup window\n";
1168	}	1538	}
1169		1539
1170	sub DESTROY {	1540	sub DESTROY {
1171	my ($self) = @_;	1541	my ($self) = @_;
1172		1542
		1543	delete $self->{term}{_destroy}{$self};
1173	$self->{term}->ungrab;	1544	$self->{term}->ungrab;
1174	}	1545	}
		1546
		1547	=back
1175		1548
1176	=head2 The C<urxvt::timer> Class	1549	=head2 The C<urxvt::timer> Class
1177		1550
1178	This class implements timer watchers/events. Time is represented as a	1551	This class implements timer watchers/events. Time is represented as a
1179	fractional number of seconds since the epoch. Example:	1552	fractional number of seconds since the epoch. Example:
…		…
1232		1605
1233	$term->{socket} = ...	1606	$term->{socket} = ...
1234	$term->{iow} = urxvt::iow	1607	$term->{iow} = urxvt::iow
1235	->new	1608	->new
1236	->fd (fileno $term->{socket})	1609	->fd (fileno $term->{socket})
1237	->events (1) # wait for read data	1610	->events (urxvt::EVENT_READ)
1238	->start	1611	->start
1239	->cb (sub {	1612	->cb (sub {
1240	my ($iow, $revents) = @_;	1613	my ($iow, $revents) = @_;
1241	# $revents must be 1 here, no need to check	1614	# $revents must be 1 here, no need to check
1242	sysread $term->{socket}, my $buf, 8192	1615	sysread $term->{socket}, my $buf, 8192
…		…
1259		1632
1260	Set the filedescriptor (not handle) to watch.	1633	Set the filedescriptor (not handle) to watch.
1261		1634
1262	=item $iow = $iow->events ($eventmask)	1635	=item $iow = $iow->events ($eventmask)
1263		1636
1264	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1637	Set the event mask to watch. The only allowed values are
1265	data, Bit #1 (value C<2>) enables watching for write data.	1638	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1639	together, or C<urxvt::EVENT_NONE>.
1266		1640
1267	=item $iow = $iow->start	1641	=item $iow = $iow->start
1268		1642
1269	Start watching for requested events on the given handle.	1643	Start watching for requested events on the given handle.
1270		1644
…		…
1281	This variable controls the verbosity level of the perl extension. Higher	1655	This variable controls the verbosity level of the perl extension. Higher
1282	numbers indicate more verbose output.	1656	numbers indicate more verbose output.
1283		1657
1284	=over 4	1658	=over 4
1285		1659
1286	=item =0 - only fatal messages	1660	=item == 0 - fatal messages
1287		1661
1288	=item =3 - script loading and management	1662	=item >= 3 - script loading and management
1289		1663
1290	=item =10 - all events received	1664	=item >=10 - all called hooks
		1665
		1666	=item >=11 - hook reutrn values
1291		1667
1292	=back	1668	=back
1293		1669
1294	=head1 AUTHOR	1670	=head1 AUTHOR
1295		1671

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.55 by root, Sun Jan 8 05:50:27 2006 UTC vs. Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.55 by root, Sun Jan 8 05:50:27 2006 UTC vs.
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC