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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.51 by root, Sun Jan 8 00:27:47 2006 UTC vs.
Revision 1.86 by root, Thu Jan 12 05:22:47 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	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). Right now, it tries to
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	select urls and complete shell-quoted arguments, which is very convenient,
47	if your F<ls> supports C<--quoting-style=shell>.	47	too, if your F<ls> supports C<--quoting-style=shell>.
48		48
49	It also offers the following bindable event:	49	It also offers the following bindable keyboard command:
50		50
51	=over 4	51	=over 4
52		52
53	=item rot13	53	=item rot13
54		54
…		…
56		56
57	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
58		58
59	=back	59	=back
60		60
		61	=item option-popup (enabled by default)
		62
		63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		64	runtime.
		65
		66	=item selection-popup (enabled by default)
		67
		68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		69	text into various other formats/action (such as uri unescaping, perl
		70	evalution, web-browser starting etc.), depending on content.
		71
		72	=item searchable-scrollback<hotkey> (enabled by default)
		73
		74	Adds regex search functionality to the scrollback buffer, triggered
		75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		76	input/output is suspended.
		77
		78	C</> starts an incremental regex search, C<n> searches further, C<p> or
		79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		80	history, C<enter> leaves search mode at the current position and C<escape>
		81	returns to the original position.
		82
61	=item digital-clock	83	=item digital-clock
62		84
63	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
64		86
65	=item mark-urls	87	=item mark-urls
66		88
67	Uses per-line display filtering (C<on_line_update>) to underline urls.	89	Uses per-line display filtering (C<on_line_update>) to underline urls and
		90	make them clickable. When middle-clicked, the program specified in the
		91	resource C<urlLauncher> (default C<x-www-browser>) will be started.
68		92
69	=item block-graphics-to-ascii	93	=item block-graphics-to-ascii
70		94
71	A not very useful example of filtering all text output to the terminal,	95	A not very useful example of filtering all text output to the terminal,
72	by replacing all line-drawing characters (U+2500 .. U+259F) by a	96	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
77	Displays a very simple digital clock in the upper right corner of the	101	Displays a very simple digital clock in the upper right corner of the
78	window. Illustrates overwriting the refresh callbacks to create your own	102	window. Illustrates overwriting the refresh callbacks to create your own
79	overlays or changes.	103	overlays or changes.
80		104
81	=back	105	=back
		106
		107	=head1 API DOCUMENTATION
82		108
83	=head2 General API Considerations	109	=head2 General API Considerations
84		110
85	All objects (such as terminals, time watchers etc.) are typical	111	All objects (such as terminals, time watchers etc.) are typical
86	reference-to-hash objects. The hash can be used to store anything you	112	reference-to-hash objects. The hash can be used to store anything you
…		…
99	=over 4	125	=over 4
100		126
101	=item $text	127	=item $text
102		128
103	Rxvt-unicodes special way of encoding text, where one "unicode" character	129	Rxvt-unicodes special way of encoding text, where one "unicode" character
104	always represents one screen cell. See L<row_t> for a discussion of this format.	130	always represents one screen cell. See L<ROW_t> for a discussion of this format.
105		131
106	=item $string	132	=item $string
107		133
108	A perl text string, with an emphasis on I<text>. It can store all unicode	134	A perl text string, with an emphasis on I<text>. It can store all unicode
109	characters and is to be distinguished with text encoded in a specific	135	characters and is to be distinguished with text encoded in a specific
…		…
114	Either binary data or - more common - a text string encoded in a	140	Either binary data or - more common - a text string encoded in a
115	locale-specific way.	141	locale-specific way.
116		142
117	=back	143	=back
118		144
		145	=head2 Extension Objects
		146
		147	Very perl extension is a perl class. A separate perl object is created
		148	for each terminal and each extension and passed as the first parameter to
		149	hooks. So extensions can use their C<$self> object without having to think
		150	about other extensions, with the exception of methods and members that
		151	begin with an underscore character C<_>: these are reserved for internal
		152	use.
		153
		154	Although it isn't a C<urxvt::term> object, you can call all methods of the
		155	C<urxvt::term> class on this object.
		156
		157	It has the following methods and data members:
		158
		159	=over 4
		160
		161	=item $urxvt_term = $self->{term}
		162
		163	Returns the C<urxvt::term> object associated with this instance of the
		164	extension. This member I<must not> be changed in any way.
		165
		166	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		167
		168	Dynamically enable the given hooks (named without the C<on_> prefix) for
		169	this extension, replacing any previous hook. This is useful when you want
		170	to overwrite time-critical hooks only temporarily.
		171
		172	=item $self->disable ($hook_name[, $hook_name..])
		173
		174	Dynamically disable the given hooks.
		175
		176	=back
		177
119	=head2 Hooks	178	=head2 Hooks
120		179
121	The following subroutines can be declared in extension files, and will be	180	The following subroutines can be declared in extension files, and will be
122	called whenever the relevant event happens.	181	called whenever the relevant event happens.
123		182
124	The first argument passed to them is an object private to each terminal	183	The first argument passed to them is an extension oject as described in
125	and extension package. You can call all C<urxvt::term> methods on it, but	184	the in the C<Extension Objects> section.
126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127	object that is shared between all packages is stored in the C<term>
128	member. It is, however, blessed intot he package of the extension script,
129	so for all practical purposes you can treat an extension script as a class.
130		185
131	All of them must return a boolean value. If it is true, then the event	186	B<All> of these hooks must return a boolean value. If it is true, then the
132	counts as being I<consumed>, and the invocation of other hooks is skipped,	187	event counts as being I<consumed>, and the invocation of other hooks is
133	and the relevant action might not be carried out by the C++ code.	188	skipped, and the relevant action might not be carried out by the C++ code.
134		189
135	When in doubt, return a false value (preferably C<()>).	190	I<< When in doubt, return a false value (preferably C<()>). >>
136		191
137	=over 4	192	=over 4
138		193
139	=item on_init $term	194	=item on_init $term
140		195
…		…
175	=item on_sel_extend $term	230	=item on_sel_extend $term
176		231
177	Called whenever the user tries to extend the selection (e.g. with a double	232	Called whenever the user tries to extend the selection (e.g. with a double
178	click) and is either supposed to return false (normal operation), or	233	click) and is either supposed to return false (normal operation), or
179	should extend the selection itelf and return true to suppress the built-in	234	should extend the selection itelf and return true to suppress the built-in
180	processing.	235	processing. This can happen multiple times, as long as the callback
		236	returns true, it will be called on every further click by the user and is
		237	supposed to enlarge the selection more and more, if possible.
181		238
182	See the F<selection> example extension.	239	See the F<selection> example extension.
183		240
184	=item on_view_change $term, $offset	241	=item on_view_change $term, $offset
185		242
…		…
194	than the scroll back buffer or the terminal.	251	than the scroll back buffer or the terminal.
195		252
196	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	253	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
197	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	254	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
198	number of lines that will be in the scrollback buffer.	255	number of lines that will be in the scrollback buffer.
199
200	=item on_tty_activity $term NYI
201
202	Called whenever the program(s) running in the urxvt window send output.
203		256
204	=item on_osc_seq $term, $string	257	=item on_osc_seq $term, $string
205		258
206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	259	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207	operating system command) is processed. Cursor position and other state	260	operating system command) is processed. Cursor position and other state
…		…
220	can filter/change and output the text yourself by returning a true value	273	can filter/change and output the text yourself by returning a true value
221	and calling C<< $term->scr_add_lines >> yourself. Please note that this	274	and calling C<< $term->scr_add_lines >> yourself. Please note that this
222	might be very slow, however, as your hook is called for B<all> text being	275	might be very slow, however, as your hook is called for B<all> text being
223	output.	276	output.
224		277
		278	=item on_tt_write $term, $octets
		279
		280	Called whenever some data is written to the tty/pty and can be used to
		281	suppress or filter tty input.
		282
225	=item on_line_update $term, $row	283	=item on_line_update $term, $row
226		284
227	Called whenever a line was updated or changed. Can be used to filter	285	Called whenever a line was updated or changed. Can be used to filter
228	screen output (e.g. underline urls or other useless stuff). Only lines	286	screen output (e.g. underline urls or other useless stuff). Only lines
229	that are being shown will be filtered, and, due to performance reasons,	287	that are being shown will be filtered, and, due to performance reasons,
…		…
261	=item on_focus_out $term	319	=item on_focus_out $term
262		320
263	Called wheneever the window loses keyboard focus, before rxvt-unicode does	321	Called wheneever the window loses keyboard focus, before rxvt-unicode does
264	focus out processing.	322	focus out processing.
265		323
266	=item on_key_press $term, $event, $octets	324	=item on_key_press $term, $event, $keysym, $octets
267		325
268	=item on_key_release $term, $event	326	=item on_key_release $term, $event, $keysym
269		327
270	=item on_button_press $term, $event	328	=item on_button_press $term, $event
271		329
272	=item on_button_release $term, $event	330	=item on_button_release $term, $event
273		331
…		…
289		347
290	subwindow.	348	subwindow.
291		349
292	=back	350	=back
293		351
		352	=cut
		353
		354	package urxvt;
		355
		356	use utf8;
		357	use strict;
		358	use Carp ();
		359	use Scalar::Util ();
		360	use List::Util ();
		361
		362	our $VERSION = 1;
		363	our $TERM;
		364	our @HOOKNAME;
		365	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		366	our %OPTION;
		367
		368	our $LIBDIR;
		369	our $RESNAME;
		370	our $RESCLASS;
		371	our $RXVTNAME;
		372
294	=head2 Variables in the C<urxvt> Package	373	=head2 Variables in the C<urxvt> Package
295		374
296	=over 4	375	=over 4
		376
		377	=item $urxvt::LIBDIR
		378
		379	The rxvt-unicode library directory, where, among other things, the perl
		380	modules and scripts are stored.
		381
		382	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		383
		384	The resource class and name rxvt-unicode uses to look up X resources.
		385
		386	=item $urxvt::RXVTNAME
		387
		388	The basename of the installed binaries, usually C<urxvt>.
297		389
298	=item $urxvt::TERM	390	=item $urxvt::TERM
299		391
300	The current terminal. This variable stores the current C<urxvt::term>	392	The current terminal. This variable stores the current C<urxvt::term>
301	object, whenever a callback/hook is executing.	393	object, whenever a callback/hook is executing.
…		…
303	=back	395	=back
304		396
305	=head2 Functions in the C<urxvt> Package	397	=head2 Functions in the C<urxvt> Package
306		398
307	=over 4	399	=over 4
308
309	=item $term = new urxvt [arg...]
310
311	Creates a new terminal, very similar as if you had started it with
312	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
313	if the new instance couldn't be created. Returns C<undef> if the new
314	instance didn't initialise perl, and the terminal object otherwise. The
315	C<init> and C<start> hooks will be called during the call.
316		400
317	=item urxvt::fatal $errormessage	401	=item urxvt::fatal $errormessage
318		402
319	Fatally aborts execution with the given error message. Avoid at all	403	Fatally aborts execution with the given error message. Avoid at all
320	costs! The only time this is acceptable is when the terminal process	404	costs! The only time this is acceptable is when the terminal process
…		…
327	that calls this function.	411	that calls this function.
328		412
329	Using this function has the advantage that its output ends up in the	413	Using this function has the advantage that its output ends up in the
330	correct place, e.g. on stderr of the connecting urxvtc client.	414	correct place, e.g. on stderr of the connecting urxvtc client.
331		415
		416	Messages have a size limit of 1023 bytes currently.
		417
		418	=item $is_safe = urxvt::safe
		419
		420	Returns true when it is safe to do potentially unsafe things, such as
		421	evaluating perl code specified by the user. This is true when urxvt was
		422	started setuid or setgid.
		423
332	=item $time = urxvt::NOW	424	=item $time = urxvt::NOW
333		425
334	Returns the "current time" (as per the event loop).	426	Returns the "current time" (as per the event loop).
335		427
336	=item urxvt::CurrentTime	428	=item urxvt::CurrentTime
337		429
338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	430	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	431	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340	Button4Mask, Button5Mask, AnyModifier	432	Button4Mask, Button5Mask, AnyModifier
341		433
342	Various constants for use in X events.	434	Various constants for use in X calls and event processing.
343		435
344	=back	436	=back
345		437
346	=head2 RENDITION	438	=head2 RENDITION
347		439
…		…
374		466
375	=item $background = urxvt::GET_BASEBG $rend	467	=item $background = urxvt::GET_BASEBG $rend
376		468
377	Return the foreground/background colour index, respectively.	469	Return the foreground/background colour index, respectively.
378		470
379	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	471	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
380		472
381	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	473	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
382		474
383	Replace the foreground/background colour in the rendition mask with the	475	Replace the foreground/background colour in the rendition mask with the
384	specified one.	476	specified one.
385		477
386	=item $value = urxvt::GET_CUSTOM ($rend)	478	=item $value = urxvt::GET_CUSTOM $rend
387		479
388	Return the "custom" value: Every rendition has 5 bits for use by	480	Return the "custom" value: Every rendition has 5 bits for use by
389	extensions. They can be set and changed as you like and are initially	481	extensions. They can be set and changed as you like and are initially
390	zero.	482	zero.
391		483
392	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	484	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
393		485
394	Change the custom value.	486	Change the custom value.
395		487
396	=back	488	=back
397		489
398	=cut	490	=cut
399
400	package urxvt;
401
402	use utf8;
403	use strict;
404	use Scalar::Util ();
405	use List::Util ();
406
407	our $TERM;
408	our @HOOKNAME;
409	our %OPTION;
410	our $LIBDIR;
411		491
412	BEGIN {	492	BEGIN {
413	urxvt->bootstrap;	493	urxvt->bootstrap;
414		494
415	# overwrite perl's warn	495	# overwrite perl's warn
…		…
417	my $msg = join "", @_;	497	my $msg = join "", @_;
418	$msg .= "\n"	498	$msg .= "\n"
419	unless $msg =~ /\n$/;	499	unless $msg =~ /\n$/;
420	urxvt::warn ($msg);	500	urxvt::warn ($msg);
421	};	501	};
		502
		503	# %ENV is the original startup environment
		504	delete $ENV{IFS};
		505	delete $ENV{CDPATH};
		506	delete $ENV{BASH_ENV};
		507	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
422	}	508	}
423		509
424	my @hook_count;	510	my @hook_count;
425	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	511	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
426		512
427	sub verbose {	513	sub verbose {
428	my ($level, $msg) = @_;	514	my ($level, $msg) = @_;
429	warn "$msg\n" if $level <= $verbosity;	515	warn "$msg\n" if $level <= $verbosity;
430	}	516	}
431		517
432	# find on_xxx subs in the package and register them
433	# as hooks
434	sub register_package($) {
435	my ($pkg) = @_;
436
437	for my $htype (0.. $#HOOKNAME) {
438	my $name = $HOOKNAME[$htype];
439
440	my $ref = $pkg->can ("on_" . lc $name)
441	or next;
442
443	$TERM->{_hook}[$htype]{$pkg} = $ref;
444	$hook_count[$htype]++
445	or set_should_invoke $htype, 1;
446	}
447	}
448
449	my $extension_pkg = "extension0000";	518	my $extension_pkg = "extension0000";
450	my %extension_pkg;	519	my %extension_pkg;
451		520
452	# load a single script into its own package, once only	521	# load a single script into its own package, once only
453	sub extension_package($) {	522	sub extension_package($) {
…		…
459	verbose 3, "loading extension '$path' into package '$pkg'";	528	verbose 3, "loading extension '$path' into package '$pkg'";
460		529
461	open my $fh, "<:raw", $path	530	open my $fh, "<:raw", $path
462	or die "$path: $!";	531	or die "$path: $!";
463		532
		533	my $source = untaint
464	my $source = "package $pkg; use strict; use utf8;\n"	534	"package $pkg; use strict; use utf8;\n"
465	. "use base urxvt::term::proxy::;\n"	535	. "use base urxvt::term::extension::;\n"
466	. "#line 1 \"$path\"\n{\n"	536	. "#line 1 \"$path\"\n{\n"
467	. (do { local $/; <$fh> })	537	. (do { local $/; <$fh> })
468	. "\n};\n1";	538	. "\n};\n1";
469		539
		540	eval $source
470	eval $source or die "$path: $@";	541	or die "$path: $@";
471		542
472	$pkg	543	$pkg
473	}	544	}
474	}	545	}
475		546
…		…
481	my $htype = shift;	552	my $htype = shift;
482		553
483	if ($htype == 0) { # INIT	554	if ($htype == 0) { # INIT
484	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	555	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
485		556
486	my %want_ext;	557	my %ext_arg;
487		558
488	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	559	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
489	if ($_ eq "default") {	560	if ($_ eq "default") {
490	$want_ext{$_}++ for qw(selection option-popup);	561	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
491	} elsif (/^-(.*)$/) {	562	} elsif (/^-(.*)$/) {
492	delete $want_ext{$1};	563	delete $ext_arg{$1};
		564	} elsif (/^([^<]+)<(.*)>$/) {
		565	push @{ $ext_arg{$1} }, $2;
493	} else {	566	} else {
494	$want_ext{$_}++;	567	$ext_arg{$_} \|\|= [];
495	}	568	}
496	}	569	}
497		570
498	for my $ext (keys %want_ext) {	571	while (my ($ext, $argv) = each %ext_arg) {
499	my @files = grep -f $_, map "$_/$ext", @dirs;	572	my @files = grep -f $_, map "$_/$ext", @dirs;
500		573
501	if (@files) {	574	if (@files) {
502	register_package extension_package $files[0];	575	$TERM->register_package (extension_package $files[0], $argv);
503	} else {	576	} else {
504	warn "perl extension '$ext' not found in perl library search path\n";	577	warn "perl extension '$ext' not found in perl library search path\n";
505	}	578	}
506	}	579	}
		580
		581	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		582	warn $@ if $@;
507	}	583	}
508		584
509	$retval = undef;	585	$retval = undef;
510		586
511	if (my $cb = $TERM->{_hook}[$htype]) {	587	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
513	if $verbosity >= 10;	589	if $verbosity >= 10;
514		590
515	keys %$cb;	591	keys %$cb;
516		592
517	while (my ($pkg, $cb) = each %$cb) {	593	while (my ($pkg, $cb) = each %$cb) {
518	eval {	594	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
519	$retval = $cb->(
520	$TERM->{_pkg}{$pkg} \|\|= do {
521	my $proxy = bless { }, $pkg;
522	Scalar::Util::weaken ($proxy->{term} = $TERM);
523	$proxy
524	},
525	@_,
526	) and last;	595	and last;
		596
		597	if ($@) {
		598	$TERM->ungrab; # better to lose the grab than the session
		599	warn $@;
527	};	600	}
528	warn $@ if $@;#d#
529	}	601	}
		602
		603	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		604	if $verbosity >= 11;
530	}	605	}
531		606
532	if ($htype == 1) { # DESTROY	607	if ($htype == 1) { # DESTROY
533	# remove hooks if unused
534	if (my $hook = $TERM->{_hook}) {	608	if (my $hook = delete $TERM->{_hook}) {
535	for my $htype (0..$#$hook) {	609	for my $htype (0..$#$hook) {
536	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	610	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
537	or set_should_invoke $htype, 0;	611	or set_should_invoke $htype, 0;
538	}	612	}
539	}	613	}
…		…
546	}	620	}
547		621
548	$retval	622	$retval
549	}	623	}
550		624
551	sub urxvt::term::proxy::AUTOLOAD {	625	sub exec_async(@) {
552	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	626	my $pid = fork;
		627
		628	return
		629	if !defined $pid or $pid;
		630
		631	%ENV = %{ $TERM->env };
		632
		633	exec @_;
		634	_exit 255;
		635	}
		636
		637	# urxvt::term::extension
		638
		639	package urxvt::term::extension;
		640
		641	sub enable {
		642	my ($self, %hook) = @_;
		643	my $pkg = $self->{_pkg};
		644
		645	while (my ($name, $cb) = each %hook) {
		646	my $htype = $HOOKTYPE{uc $name};
		647	defined $htype
		648	or Carp::croak "unsupported hook type '$name'";
		649
		650	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		651	$hook_count[$htype]++
		652	or urxvt::set_should_invoke $htype, 1;
		653	}
		654
		655	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		656	}
		657	}
		658
		659	sub disable {
		660	my ($self, @hook) = @_;
		661	my $pkg = $self->{_pkg};
		662
		663	for my $name (@hook) {
		664	my $htype = $HOOKTYPE{uc $name};
		665	defined $htype
		666	or Carp::croak "unsupported hook type '$name'";
		667
		668	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		669	--$hook_count[$htype]
		670	or urxvt::set_should_invoke $htype, 0;
		671	}
		672	}
		673	}
		674
		675	our $AUTOLOAD;
		676
		677	sub AUTOLOAD {
		678	$AUTOLOAD =~ /:([^:]+)$/
553	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	679	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
554		680
555	eval qq{	681	eval qq{
556	sub $urxvt::term::proxy::AUTOLOAD {	682	sub $AUTOLOAD {
557	my \$proxy = shift;	683	my \$proxy = shift;
558	\$proxy->{term}->$1 (\@_)	684	\$proxy->{term}->$1 (\@_)
559	}	685	}
560	1	686	1
561	} or die "FATAL: unable to compile method forwarder: $@";	687	} or die "FATAL: unable to compile method forwarder: $@";
562		688
563	goto &$urxvt::term::proxy::AUTOLOAD;	689	goto &$AUTOLOAD;
564	}	690	}
		691
		692	sub DESTROY {
		693	# nop
		694	}
		695
		696	# urxvt::destroy_hook
565		697
566	sub urxvt::destroy_hook::DESTROY {	698	sub urxvt::destroy_hook::DESTROY {
567	${$_[0]}->();	699	${$_[0]}->();
568	}	700	}
569		701
570	sub urxvt::destroy_hook(&) {	702	sub urxvt::destroy_hook(&) {
571	bless \shift, urxvt::destroy_hook::	703	bless \shift, urxvt::destroy_hook::
572	}	704	}
573		705
		706	package urxvt::anyevent;
		707
		708	=head2 The C<urxvt::anyevent> Class
		709
		710	The sole purpose of this class is to deliver an interface to the
		711	C<AnyEvent> module - any module using it will work inside urxvt without
		712	further programming. The only exception is that you cannot wait on
		713	condition variables, but non-blocking condvar use is ok. What this means
		714	is that you cannot use blocking APIs, but the non-blocking variant should
		715	work.
		716
		717	=cut
		718
		719	our $VERSION = 1;
		720
		721	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		722	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		723
		724	sub timer {
		725	my ($class, %arg) = @_;
		726
		727	my $cb = $arg{cb};
		728
		729	urxvt::timer
		730	->new
		731	->start (urxvt::NOW + $arg{after})
		732	->cb (sub {
		733	$_[0]->stop; # need to cancel manually
		734	$cb->();
		735	})
		736	}
		737
		738	sub io {
		739	my ($class, %arg) = @_;
		740
		741	my $cb = $arg{cb};
		742
		743	bless [$arg{fh}, urxvt::iow
		744	->new
		745	->fd (fileno $arg{fh})
		746	->events (($arg{poll} =~ /r/ ? 1 : 0)
		747	\| ($arg{poll} =~ /w/ ? 2 : 0))
		748	->start
		749	->cb (sub {
		750	$cb->(($_[1] & 1 ? 'r' : '')
		751	. ($_[1] & 2 ? 'w' : ''));
		752	})],
		753	urxvt::anyevent::
		754	}
		755
		756	sub DESTROY {
		757	$_[0][1]->stop;
		758	}
		759
		760	sub condvar {
		761	bless \my $flag, urxvt::anyevent::condvar::
		762	}
		763
		764	sub urxvt::anyevent::condvar::broadcast {
		765	${$_[0]}++;
		766	}
		767
		768	sub urxvt::anyevent::condvar::wait {
		769	unless (${$_[0]}) {
		770	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		771	}
		772	}
		773
		774	package urxvt::term;
		775
574	=head2 The C<urxvt::term> Class	776	=head2 The C<urxvt::term> Class
575		777
576	=over 4	778	=over 4
577		779
		780	=cut
		781
		782	# find on_xxx subs in the package and register them
		783	# as hooks
		784	sub register_package {
		785	my ($self, $pkg, $argv) = @_;
		786
		787	my $proxy = bless {
		788	_pkg => $pkg,
		789	argv => $argv,
		790	}, $pkg;
		791	Scalar::Util::weaken ($proxy->{term} = $self);
		792
		793	$self->{_pkg}{$pkg} = $proxy;
		794
		795	for my $name (@HOOKNAME) {
		796	if (my $ref = $pkg->can ("on_" . lc $name)) {
		797	$proxy->enable ($name => $ref);
		798	}
		799	}
		800	}
		801
		802	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		803
		804	Creates a new terminal, very similar as if you had started it with system
		805	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		806	hash which defines the environment of the new terminal.
		807
		808	Croaks (and probably outputs an error message) if the new instance
		809	couldn't be created. Returns C<undef> if the new instance didn't
		810	initialise perl, and the terminal object otherwise. The C<init> and
		811	C<start> hooks will be called during this call.
		812
		813	=cut
		814
		815	sub new {
		816	my ($class, $env, @args) = @_;
		817
		818	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		819	}
		820
578	=item $term->destroy	821	=item $term->destroy
579		822
580	Destroy the terminal object (close the window, free resources etc.).	823	Destroy the terminal object (close the window, free resources
		824	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		825	watchers (timers, io watchers) are still active.
581		826
582	=item $isset = $term->option ($optval[, $set])	827	=item $isset = $term->option ($optval[, $set])
583		828
584	Returns true if the option specified by C<$optval> is enabled, and	829	Returns true if the option specified by C<$optval> is enabled, and
585	optionally change it. All option values are stored by name in the hash	830	optionally change it. All option values are stored by name in the hash
…		…
629	shade term_name title transparent transparent_all tripleclickwords	874	shade term_name title transparent transparent_all tripleclickwords
630	utmpInhibit visualBell	875	utmpInhibit visualBell
631		876
632	=cut	877	=cut
633		878
634	sub urxvt::term::resource($$;$) {	879	sub resource($$;$) {
635	my ($self, $name) = (shift, shift);	880	my ($self, $name) = (shift, shift);
636	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	881	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
637	&urxvt::term::_resource	882	&urxvt::term::_resource
638	}	883	}
639		884
		885	=item $value = $term->x_resource ($pattern)
		886
		887	Returns the X-Resource for the given pattern, excluding the program or
		888	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		889	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		890	resource with that pattern exists.
		891
		892	This method should only be called during the C<on_start> hook, as there is
		893	only one resource database per display, and later invocations might return
		894	the wrong resources.
		895
		896	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		897
		898	Adds a keymap translation exactly as specified via a resource. See the
		899	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		900
640	=item $rend = $term->rstyle ([$new_rstyle])	901	=item $rend = $term->rstyle ([$new_rstyle])
641		902
642	Return and optionally change the current rendition. Text that is output by	903	Return and optionally change the current rendition. Text that is output by
643	the terminal application will use this style.	904	the terminal application will use this style.
644		905
…		…
654	=item ($row, $col) = $term->selection_end ([$row, $col])	915	=item ($row, $col) = $term->selection_end ([$row, $col])
655		916
656	Return the current values of the selection mark, begin or end positions,	917	Return the current values of the selection mark, begin or end positions,
657	and optionally set them to new values.	918	and optionally set them to new values.
658		919
		920	=item $term->selection_make ($eventtime[, $rectangular])
		921
		922	Tries to make a selection as set by C<selection_beg> and
		923	C<selection_end>. If C<$rectangular> is true (default: false), a
		924	rectangular selection will be made. This is the prefered function to make
		925	a selection.
		926
659	=item $success = $term->selection_grab ($eventtime)	927	=item $success = $term->selection_grab ($eventtime)
660		928
661	Try to request the primary selection from the server (for example, as set	929	Try to request the primary selection text from the server (for example, as
662	by the next method).	930	set by the next method). No visual feedback will be given. This function
		931	is mostly useful from within C<on_sel_grab> hooks.
663		932
664	=item $oldtext = $term->selection ([$newtext])	933	=item $oldtext = $term->selection ([$newtext])
665		934
666	Return the current selection text and optionally replace it by C<$newtext>.	935	Return the current selection text and optionally replace it by C<$newtext>.
667		936
668	#=item $term->overlay ($x, $y, $text)	937	=item $term->overlay_simple ($x, $y, $text)
669	#	938
670	#Create a simple multi-line overlay box. See the next method for details.	939	Create a simple multi-line overlay box. See the next method for details.
671	#	940
672	#=cut	941	=cut
673	#	942
674	#sub urxvt::term::scr_overlay {	943	sub overlay_simple {
675	# my ($self, $x, $y, $text) = @_;	944	my ($self, $x, $y, $text) = @_;
676	#	945
677	# my @lines = split /\n/, $text;	946	my @lines = split /\n/, $text;
678	#	947
679	# my $w = 0;	948	my $w = List::Util::max map $self->strwidth ($_), @lines;
680	# for (map $self->strwidth ($_), @lines) {	949
681	# $w = $_ if $w < $_;
682	# }
683	#
684	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	950	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
685	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	951	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
686	#}	952
		953	$overlay
		954	}
687		955
688	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	956	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
689		957
690	Create a new (empty) overlay at the given position with the given	958	Create a new (empty) overlay at the given position with the given
691	width/height. C<$rstyle> defines the initial rendition style	959	width/height. C<$rstyle> defines the initial rendition style
…		…
726	C<$event> I<must> be the event causing the menu to pop up (a button event,	994	C<$event> I<must> be the event causing the menu to pop up (a button event,
727	currently).	995	currently).
728		996
729	=cut	997	=cut
730		998
731	sub urxvt::term::popup {	999	sub popup {
732	my ($self, $event) = @_;	1000	my ($self, $event) = @_;
733		1001
734	$self->grab ($event->{time}, 1)	1002	$self->grab ($event->{time}, 1)
735	or return;	1003	or return;
736		1004
…		…
758		1026
759	=item $string = $term->locale_decode ($octets)	1027	=item $string = $term->locale_decode ($octets)
760		1028
761	Convert the given locale-encoded octets into a perl string.	1029	Convert the given locale-encoded octets into a perl string.
762		1030
		1031	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1032
		1033	XORs the rendition values in the given span with the provided value
		1034	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1035	refresh hooks to provide effects similar to the selection.
		1036
		1037	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1038
		1039	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1040	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1041	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1042	it instead. Both styles I<MUST NOT> contain font styles.
		1043
		1044	=item $term->scr_bell
		1045
		1046	Ring the bell!
		1047
763	=item $term->scr_add_lines ($string)	1048	=item $term->scr_add_lines ($string)
764		1049
765	Write the given text string to the screen, as if output by the application	1050	Write the given text string to the screen, as if output by the application
766	running inside the terminal. It may not contain command sequences (escape	1051	running inside the terminal. It may not contain command sequences (escape
767	codes), but is free to use line feeds, carriage returns and tabs. The	1052	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
781		1066
782	Write the octets given in C<$data> to the tty (i.e. as program input). To	1067	Write the octets given in C<$data> to the tty (i.e. as program input). To
783	pass characters instead of octets, you should convert your strings first	1068	pass characters instead of octets, you should convert your strings first
784	to the locale-specific encoding using C<< $term->locale_encode >>.	1069	to the locale-specific encoding using C<< $term->locale_encode >>.
785		1070
		1071	=item $old_events = $term->pty_ev_events ([$new_events])
		1072
		1073	Replaces the event mask of the pty watcher by the given event mask. Can
		1074	be used to suppress input and output handling to the pty/tty. See the
		1075	description of C<< urxvt::timer->events >>. Make sure to always restore
		1076	the previous value.
		1077
786	=item $windowid = $term->parent	1078	=item $windowid = $term->parent
787		1079
788	Return the window id of the toplevel window.	1080	Return the window id of the toplevel window.
789		1081
790	=item $windowid = $term->vt	1082	=item $windowid = $term->vt
…		…
814	=item $nrow_plus_saveLines = $term->total_rows	1106	=item $nrow_plus_saveLines = $term->total_rows
815		1107
816	=item $lines_in_scrollback = $term->nsaved	1108	=item $lines_in_scrollback = $term->nsaved
817		1109
818	Return various integers describing terminal characteristics.	1110	Return various integers describing terminal characteristics.
		1111
		1112	=item $x_display = $term->display_id
		1113
		1114	Return the DISPLAY used by rxvt-unicode.
		1115
		1116	=item $lc_ctype = $term->locale
		1117
		1118	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1119
		1120	=item $env = $term->env
		1121
		1122	Returns a copy of the environment in effect for the terminal as a hashref
		1123	similar to C<\%ENV>.
		1124
		1125	=cut
		1126
		1127	sub env {
		1128	if (my $env = $_[0]->_env) {
		1129	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1130	} else {
		1131	+{ %ENV }
		1132	}
		1133	}
819		1134
820	=item $modifiermask = $term->ModLevel3Mask	1135	=item $modifiermask = $term->ModLevel3Mask
821		1136
822	=item $modifiermask = $term->ModMetaMask	1137	=item $modifiermask = $term->ModMetaMask
823		1138
…		…
916	Return the row number of the first/last row of the line, respectively.	1231	Return the row number of the first/last row of the line, respectively.
917		1232
918	=item $offset = $line->offset_of ($row, $col)	1233	=item $offset = $line->offset_of ($row, $col)
919		1234
920	Returns the character offset of the given row\|col pair within the logical	1235	Returns the character offset of the given row\|col pair within the logical
921	line.	1236	line. Works for rows outside the line, too, and returns corresponding
		1237	offsets outside the string.
922		1238
923	=item ($row, $col) = $line->coord_of ($offset)	1239	=item ($row, $col) = $line->coord_of ($offset)
924		1240
925	Translates a string offset into terminal coordinates again.	1241	Translates a string offset into terminal coordinates again.
926		1242
927	=back	1243	=back
928		1244
929	=cut	1245	=cut
930		1246
931	sub urxvt::term::line {	1247	sub line {
932	my ($self, $row) = @_;	1248	my ($self, $row) = @_;
933		1249
934	my $maxrow = $self->nrow - 1;	1250	my $maxrow = $self->nrow - 1;
935		1251
936	my ($beg, $end) = ($row, $row);	1252	my ($beg, $end) = ($row, $row);
…		…
1000	$offset / $self->{ncol} + $self->{beg},	1316	$offset / $self->{ncol} + $self->{beg},
1001	$offset % $self->{ncol}	1317	$offset % $self->{ncol}
1002	)	1318	)
1003	}	1319	}
1004		1320
1005	=item ($row, $col) = $line->coord_of ($offset)
1006	=item $text = $term->special_encode $string	1321	=item $text = $term->special_encode $string
1007		1322
1008	Converts a perl string into the special encoding used by rxvt-unicode,	1323	Converts a perl string into the special encoding used by rxvt-unicode,
1009	where one character corresponds to one screen cell. See	1324	where one character corresponds to one screen cell. See
1010	C<< $term->ROW_t >> for details.	1325	C<< $term->ROW_t >> for details.
…		…
1012	=item $string = $term->special_decode $text	1327	=item $string = $term->special_decode $text
1013		1328
1014	Converts rxvt-unicodes text reprsentation into a perl string. See	1329	Converts rxvt-unicodes text reprsentation into a perl string. See
1015	C<< $term->ROW_t >> for details.	1330	C<< $term->ROW_t >> for details.
1016		1331
		1332	=item $success = $term->grab_button ($button, $modifiermask)
		1333
		1334	Registers a synchronous button grab. See the XGrabButton manpage.
		1335
		1336	=item $success = $term->grab ($eventtime[, $sync])
		1337
		1338	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1339	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1340
		1341	=item $term->allow_events_async
		1342
		1343	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1344
		1345	=item $term->allow_events_sync
		1346
		1347	Calls XAllowEvents with SyncBoth for the most recent grab.
		1348
		1349	=item $term->allow_events_replay
		1350
		1351	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1352	recent grab.
		1353
		1354	=item $term->ungrab
		1355
		1356	Calls XUngrab for the most recent grab. Is called automatically on
		1357	evaluation errors, as it is better to lose the grab in the error case as
		1358	the session.
		1359
1017	=back	1360	=back
1018		1361
		1362	=cut
		1363
		1364	package urxvt::popup;
		1365
1019	=head2 The C<urxvt::popup> Class	1366	=head2 The C<urxvt::popup> Class
1020		1367
1021	=over 4	1368	=over 4
1022		1369
1023	=cut	1370	=cut
1024
1025	package urxvt::popup;
1026		1371
1027	sub add_item {	1372	sub add_item {
1028	my ($self, $item) = @_;	1373	my ($self, $item) = @_;
1029		1374
		1375	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1376	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1377	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1378
		1379	$item->{render} \|\|= sub { $_[0]{text} };
		1380
1030	push @{ $self->{item} }, $item;	1381	push @{ $self->{item} }, $item;
1031	}	1382	}
		1383
		1384	=item $popup->add_title ($title)
		1385
		1386	Adds a non-clickable title to the popup.
		1387
		1388	=cut
		1389
		1390	sub add_title {
		1391	my ($self, $title) = @_;
		1392
		1393	$self->add_item ({
		1394	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1395	text => $title,
		1396	activate => sub { },
		1397	});
		1398	}
		1399
		1400	=item $popup->add_separator ([$sepchr])
		1401
		1402	Creates a separator, optionally using the character given as C<$sepchr>.
		1403
		1404	=cut
		1405
		1406	sub add_separator {
		1407	my ($self, $sep) = @_;
		1408
		1409	$sep \|\|= "=";
		1410
		1411	$self->add_item ({
		1412	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1413	text => "",
		1414	render => sub { $sep x $self->{term}->ncol },
		1415	activate => sub { },
		1416	});
		1417	}
		1418
		1419	=item $popup->add_button ($text, $cb)
		1420
		1421	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1422	selected.
		1423
		1424	=cut
1032		1425
1033	sub add_button {	1426	sub add_button {
1034	my ($self, $text, $cb) = @_;	1427	my ($self, $text, $cb) = @_;
1035		1428
1036	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,	1429	$self->add_item ({ type => "button", text => $text, activate => $cb});
1037	render => sub { $_[0]{text} },
1038	});
1039	}	1430	}
		1431
		1432	=item $popup->add_toggle ($text, $cb, $initial_value)
		1433
		1434	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1435	whenever it gets toggled, with a boolean indicating its value as its first
		1436	argument.
		1437
		1438	=cut
1040		1439
1041	sub add_toggle {	1440	sub add_toggle {
1042	my ($self, $text, $cb, $value) = @_;	1441	my ($self, $text, $cb, $value) = @_;
1043		1442
1044	my $item; $item = {	1443	my $item; $item = {
1045	type => "button",	1444	type => "button",
1046	text => " $text",	1445	text => " $text",
1047	value => $value,	1446	value => $value,
1048	render => sub { ($item->{value} ? "✔" : " ") . $text },	1447	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1049	activate => sub { $cb->($item->{value} = !$item->{value}); },	1448	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1050	};	1449	};
1051		1450
1052	$self->add_item ($item);	1451	$self->add_item ($item);
1053	}	1452	}
		1453
		1454	=item $popup->show
		1455
		1456	Displays the popup (which is initially hidden).
		1457
		1458	=cut
1054		1459
1055	sub show {	1460	sub show {
1056	my ($self) = @_;	1461	my ($self) = @_;
1057		1462
1058	local $urxvt::popup::self = $self;	1463	local $urxvt::popup::self = $self;
1059		1464
		1465	my $env = $self->{term}->env;
		1466	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1467	delete $env->{LC_ALL};
		1468	$env->{LC_CTYPE} = $self->{term}->locale;
		1469
		1470	urxvt::term->new ($env, $self->{term}->resource ("name"),
1060	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1471	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1061	"--transient-for" => $self->{term}->parent,	1472	"--transient-for" => $self->{term}->parent,
		1473	"-display" => $self->{term}->display_id,
1062	"-pe" => "urxvt-popup")	1474	"-pe" => "urxvt-popup")
1063	or die "unable to create popup window\n";	1475	or die "unable to create popup window\n";
1064	}	1476	}
1065		1477
1066	sub DESTROY {	1478	sub DESTROY {
1067	my ($self) = @_;	1479	my ($self) = @_;
1068		1480
		1481	delete $self->{term}{_destroy}{$self};
1069	$self->{term}->ungrab;	1482	$self->{term}->ungrab;
1070	}	1483	}
		1484
		1485	=back
1071		1486
1072	=head2 The C<urxvt::timer> Class	1487	=head2 The C<urxvt::timer> Class
1073		1488
1074	This class implements timer watchers/events. Time is represented as a	1489	This class implements timer watchers/events. Time is represented as a
1075	fractional number of seconds since the epoch. Example:	1490	fractional number of seconds since the epoch. Example:
…		…
1128		1543
1129	$term->{socket} = ...	1544	$term->{socket} = ...
1130	$term->{iow} = urxvt::iow	1545	$term->{iow} = urxvt::iow
1131	->new	1546	->new
1132	->fd (fileno $term->{socket})	1547	->fd (fileno $term->{socket})
1133	->events (1) # wait for read data	1548	->events (urxvt::EVENT_READ)
1134	->start	1549	->start
1135	->cb (sub {	1550	->cb (sub {
1136	my ($iow, $revents) = @_;	1551	my ($iow, $revents) = @_;
1137	# $revents must be 1 here, no need to check	1552	# $revents must be 1 here, no need to check
1138	sysread $term->{socket}, my $buf, 8192	1553	sysread $term->{socket}, my $buf, 8192
…		…
1155		1570
1156	Set the filedescriptor (not handle) to watch.	1571	Set the filedescriptor (not handle) to watch.
1157		1572
1158	=item $iow = $iow->events ($eventmask)	1573	=item $iow = $iow->events ($eventmask)
1159		1574
1160	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1575	Set the event mask to watch. The only allowed values are
1161	data, Bit #1 (value C<2>) enables watching for write data.	1576	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1577	together, or C<urxvt::EVENT_NONE>.
1162		1578
1163	=item $iow = $iow->start	1579	=item $iow = $iow->start
1164		1580
1165	Start watching for requested events on the given handle.	1581	Start watching for requested events on the given handle.
1166		1582
…		…
1177	This variable controls the verbosity level of the perl extension. Higher	1593	This variable controls the verbosity level of the perl extension. Higher
1178	numbers indicate more verbose output.	1594	numbers indicate more verbose output.
1179		1595
1180	=over 4	1596	=over 4
1181		1597
1182	=item =0 - only fatal messages	1598	=item == 0 - fatal messages
1183		1599
1184	=item =3 - script loading and management	1600	=item >= 3 - script loading and management
1185		1601
1186	=item =10 - all events received	1602	=item >=10 - all called hooks
		1603
		1604	=item >=11 - hook reutrn values
1187		1605
1188	=back	1606	=back
1189		1607
1190	=head1 AUTHOR	1608	=head1 AUTHOR
1191		1609

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.51 by root, Sun Jan 8 00:27:47 2006 UTC vs. Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.51 by root, Sun Jan 8 00:27:47 2006 UTC vs.
Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC