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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.40 by root, Fri Jan 6 05:37:59 2006 UTC vs.
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
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 filtering (C<on_line_update>) to underline urls.	89	Uses per-line display filtering (C<on_line_update>) to underline urls.
		90
		91	=item block-graphics-to-ascii
		92
		93	A not very useful example of filtering all text output to the terminal,
		94	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		95	similar-looking ascii character.
68		96
69	=item example-refresh-hooks	97	=item example-refresh-hooks
70		98
71	Displays a very simple digital clock in the upper right corner of the	99	Displays a very simple digital clock in the upper right corner of the
72	window. Illustrates overwriting the refresh callbacks to create your own	100	window. Illustrates overwriting the refresh callbacks to create your own
73	overlays or changes.	101	overlays or changes.
74		102
75	=item example-filter-input
76
77	A not very useful example of filtering all text output to the terminal, by
78	underlining all urls that matches a certain regex (i.e. some urls :). It
79	is not very useful because urls that are output in multiple steps (e.g.
80	when typing them) do not get marked.
81
82	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
83		106
84	=head2 General API Considerations	107	=head2 General API Considerations
85		108
86	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
87	reference-to-hash objects. The hash can be used to store anything you	110	reference-to-hash objects. The hash can be used to store anything you
…		…
100	=over 4	123	=over 4
101		124
102	=item $text	125	=item $text
103		126
104	Rxvt-unicodes special way of encoding text, where one "unicode" character	127	Rxvt-unicodes special way of encoding text, where one "unicode" character
105	always represents one screen cell. See L<row_t> for a discussion of this format.	128	always represents one screen cell. See L<ROW_t> for a discussion of this format.
106		129
107	=item $string	130	=item $string
108		131
109	A perl text string, with an emphasis on I<text>. It can store all unicode	132	A perl text string, with an emphasis on I<text>. It can store all unicode
110	characters and is to be distinguished with text encoded in a specific	133	characters and is to be distinguished with text encoded in a specific
…		…
115	Either binary data or - more common - a text string encoded in a	138	Either binary data or - more common - a text string encoded in a
116	locale-specific way.	139	locale-specific way.
117		140
118	=back	141	=back
119		142
		143	=head2 Extension Objects
		144
		145	Very perl extension is a perl class. A separate perl object is created
		146	for each terminal and each extension and passed as the first parameter to
		147	hooks. So extensions can use their C<$self> object without having to think
		148	about other extensions, with the exception of methods and members that
		149	begin with an underscore character C<_>: these are reserved for internal
		150	use.
		151
		152	Although it isn't a C<urxvt::term> object, you can call all methods of the
		153	C<urxvt::term> class on this object.
		154
		155	It has the following methods and data members:
		156
		157	=over 4
		158
		159	=item $urxvt_term = $self->{term}
		160
		161	Returns the C<urxvt::term> object associated with this instance of the
		162	extension. This member I<must not> be changed in any way.
		163
		164	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		165
		166	Dynamically enable the given hooks (named without the C<on_> prefix) for
		167	this extension, replacing any previous hook. This is useful when you want
		168	to overwrite time-critical hooks only temporarily.
		169
		170	=item $self->disable ($hook_name[, $hook_name..])
		171
		172	Dynamically disable the given hooks.
		173
		174	=back
		175
120	=head2 Hooks	176	=head2 Hooks
121		177
122	The following subroutines can be declared in loaded scripts, and will be	178	The following subroutines can be declared in extension files, and will be
123	called whenever the relevant event happens.	179	called whenever the relevant event happens.
124		180
125	The first argument passed to them is an object private to each terminal	181	The first argument passed to them is an extension oject as described in
126	and extension package. You can call all C<urxvt::term> methods on it, but	182	the in the C<Extension Objects> section.
127	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
128	object that is shared between all packages is stored in the C<term>
129	member.
130		183
131	All of them must return a boolean value. If it is true, then the event	184	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,	185	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.	186	skipped, and the relevant action might not be carried out by the C++ code.
134		187
135	When in doubt, return a false value (preferably C<()>).	188	I<< When in doubt, return a false value (preferably C<()>). >>
136		189
137	=over 4	190	=over 4
138		191
139	=item on_init $term	192	=item on_init $term
140		193
…		…
179	should extend the selection itelf and return true to suppress the built-in	232	should extend the selection itelf and return true to suppress the built-in
180	processing.	233	processing.
181		234
182	See the F<selection> example extension.	235	See the F<selection> example extension.
183		236
184	=item on_focus_in $term
185
186	Called whenever the window gets the keyboard focus, before urxvt does
187	focus in processing.
188
189	=item on_focus_out $term
190
191	Called wheneever the window loses keyboard focus, before urxvt does focus
192	out processing.
193
194	=item on_view_change $term, $offset	237	=item on_view_change $term, $offset
195		238
196	Called whenever the view offset changes, i..e the user or program	239	Called whenever the view offset changes, i..e the user or program
197	scrolls. Offset C<0> means display the normal terminal, positive values	240	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	241	show this many lines of scrollback.
…		…
204	than the scroll back buffer or the terminal.	247	than the scroll back buffer or the terminal.
205		248
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	249	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
207	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	250	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208	number of lines that will be in the scrollback buffer.	251	number of lines that will be in the scrollback buffer.
209
210	=item on_tty_activity $term NYI
211
212	Called whenever the program(s) running in the urxvt window send output.
213		252
214	=item on_osc_seq $term, $string	253	=item on_osc_seq $term, $string
215		254
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	256	operating system command) is processed. Cursor position and other state
…		…
230	can filter/change and output the text yourself by returning a true value	269	can filter/change and output the text yourself by returning a true value
231	and calling C<< $term->scr_add_lines >> yourself. Please note that this	270	and calling C<< $term->scr_add_lines >> yourself. Please note that this
232	might be very slow, however, as your hook is called for B<all> text being	271	might be very slow, however, as your hook is called for B<all> text being
233	output.	272	output.
234		273
		274	=item on_tt_write $term, $octets
		275
		276	Called whenever some data is written to the tty/pty and can be used to
		277	suppress or filter tty input.
		278
235	=item on_line_update $term, $row	279	=item on_line_update $term, $row
236		280
237	Called whenever a line was updated or changed. Can be used to filter	281	Called whenever a line was updated or changed. Can be used to filter
238	screen output (e.g. underline urls or other useless stuff). Only lines	282	screen output (e.g. underline urls or other useless stuff). Only lines
239	that are being shown will be filtered, and, due to performance reasons,	283	that are being shown will be filtered, and, due to performance reasons,
…		…
261		305
262	Called whenever the user presses a key combination that has a	306	Called whenever the user presses a key combination that has a
263	C<perl:string> action bound to it (see description of the B<keysym>	307	C<perl:string> action bound to it (see description of the B<keysym>
264	resource in the @@RXVT_NAME@@(1) manpage).	308	resource in the @@RXVT_NAME@@(1) manpage).
265		309
		310	=item on_focus_in $term
		311
		312	Called whenever the window gets the keyboard focus, before rxvt-unicode
		313	does focus in processing.
		314
		315	=item on_focus_out $term
		316
		317	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		318	focus out processing.
		319
266	=item on_key_press $term, $event, $octets	320	=item on_key_press $term, $event, $keysym, $octets
267		321
268	=item on_key_release $term, $event	322	=item on_key_release $term, $event, $keysym
269		323
270	=item on_button_press $term, $event	324	=item on_button_press $term, $event
271		325
272	=item on_button_release $term, $event	326	=item on_button_release $term, $event
273		327
274	=item on_motion_notify $term, $event	328	=item on_motion_notify $term, $event
		329
		330	=item on_map_notify $term, $event
		331
		332	=item on_unmap_notify $term, $event
275		333
276	Called whenever the corresponding X event is received for the terminal If	334	Called whenever the corresponding X event is received for the terminal If
277	the hook returns true, then the even will be ignored by rxvt-unicode.	335	the hook returns true, then the even will be ignored by rxvt-unicode.
278		336
279	The event is a hash with most values as named by Xlib (see the XEvent	337	The event is a hash with most values as named by Xlib (see the XEvent
…		…
285		343
286	subwindow.	344	subwindow.
287		345
288	=back	346	=back
289		347
		348	=cut
		349
		350	package urxvt;
		351
		352	use utf8;
		353	use strict;
		354	use Carp ();
		355	use Scalar::Util ();
		356	use List::Util ();
		357
		358	our $VERSION = 1;
		359	our $TERM;
		360	our @HOOKNAME;
		361	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		362	our %OPTION;
		363
		364	our $LIBDIR;
		365	our $RESNAME;
		366	our $RESCLASS;
		367	our $RXVTNAME;
		368
290	=head2 Variables in the C<urxvt> Package	369	=head2 Variables in the C<urxvt> Package
291		370
292	=over 4	371	=over 4
293		372
		373	=item $urxvt::LIBDIR
		374
		375	The rxvt-unicode library directory, where, among other things, the perl
		376	modules and scripts are stored.
		377
		378	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		379
		380	The resource class and name rxvt-unicode uses to look up X resources.
		381
		382	=item $urxvt::RXVTNAME
		383
		384	The basename of the installed binaries, usually C<urxvt>.
		385
294	=item $urxvt::TERM	386	=item $urxvt::TERM
295		387
296	The current terminal. Whenever a callback/Hook is bein executed, this	388	The current terminal. This variable stores the current C<urxvt::term>
297	variable stores the current C<urxvt::term> object.	389	object, whenever a callback/hook is executing.
298		390
299	=back	391	=back
300		392
301	=head2 Functions in the C<urxvt> Package	393	=head2 Functions in the C<urxvt> Package
302		394
303	=over 4	395	=over 4
304
305	=item $term = new urxvt [arg...]
306
307	Creates a new terminal, very similar as if you had started it with
308	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
309	if the new instance couldn't be created. Returns C<undef> if the new
310	instance didn't initialise perl, and the terminal object otherwise. The
311	C<init> and C<start> hooks will be called during the call.
312		396
313	=item urxvt::fatal $errormessage	397	=item urxvt::fatal $errormessage
314		398
315	Fatally aborts execution with the given error message. Avoid at all	399	Fatally aborts execution with the given error message. Avoid at all
316	costs! The only time this is acceptable is when the terminal process	400	costs! The only time this is acceptable is when the terminal process
…		…
323	that calls this function.	407	that calls this function.
324		408
325	Using this function has the advantage that its output ends up in the	409	Using this function has the advantage that its output ends up in the
326	correct place, e.g. on stderr of the connecting urxvtc client.	410	correct place, e.g. on stderr of the connecting urxvtc client.
327		411
		412	Messages have a size limit of 1023 bytes currently.
		413
		414	=item $is_safe = urxvt::safe
		415
		416	Returns true when it is safe to do potentially unsafe things, such as
		417	evaluating perl code specified by the user. This is true when urxvt was
		418	started setuid or setgid.
		419
328	=item $time = urxvt::NOW	420	=item $time = urxvt::NOW
329		421
330	Returns the "current time" (as per the event loop).	422	Returns the "current time" (as per the event loop).
		423
		424	=item urxvt::CurrentTime
		425
		426	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		427	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		428	Button4Mask, Button5Mask, AnyModifier
		429
		430	Various constants for use in X calls and event processing.
331		431
332	=back	432	=back
333		433
334	=head2 RENDITION	434	=head2 RENDITION
335		435
…		…
362		462
363	=item $background = urxvt::GET_BASEBG $rend	463	=item $background = urxvt::GET_BASEBG $rend
364		464
365	Return the foreground/background colour index, respectively.	465	Return the foreground/background colour index, respectively.
366		466
367	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	467	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
368		468
369	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	469	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
370		470
371	Replace the foreground/background colour in the rendition mask with the	471	Replace the foreground/background colour in the rendition mask with the
372	specified one.	472	specified one.
373		473
374	=item $value = urxvt::GET_CUSTOM ($rend)	474	=item $value = urxvt::GET_CUSTOM $rend
375		475
376	Return the "custom" value: Every rendition has 5 bits for use by	476	Return the "custom" value: Every rendition has 5 bits for use by
377	extensions. They can be set and changed as you like and are initially	477	extensions. They can be set and changed as you like and are initially
378	zero.	478	zero.
379		479
380	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	480	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
381		481
382	Change the custom value.	482	Change the custom value.
383		483
384	=back	484	=back
385		485
386	=cut	486	=cut
387
388	package urxvt;
389
390	use strict;
391	use Scalar::Util ();
392
393	our $TERM;
394	our @HOOKNAME;
395	our $LIBDIR;
396		487
397	BEGIN {	488	BEGIN {
398	urxvt->bootstrap;	489	urxvt->bootstrap;
399		490
400	# overwrite perl's warn	491	# overwrite perl's warn
…		…
402	my $msg = join "", @_;	493	my $msg = join "", @_;
403	$msg .= "\n"	494	$msg .= "\n"
404	unless $msg =~ /\n$/;	495	unless $msg =~ /\n$/;
405	urxvt::warn ($msg);	496	urxvt::warn ($msg);
406	};	497	};
		498
		499	delete $ENV{IFS};
		500	delete $ENV{CDPATH};
		501	delete $ENV{BASH_ENV};
		502	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
407	}	503	}
408		504
409	my @hook_count;	505	my @hook_count;
410	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	506	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
411		507
412	sub verbose {	508	sub verbose {
413	my ($level, $msg) = @_;	509	my ($level, $msg) = @_;
414	warn "$msg\n" if $level <= $verbosity;	510	warn "$msg\n" if $level <= $verbosity;
415	}	511	}
416		512
417	# find on_xxx subs in the package and register them	513	my $extension_pkg = "extension0000";
418	# as hooks	514	my %extension_pkg;
419	sub register_package($) {
420	my ($pkg) = @_;
421
422	for my $htype (0.. $#HOOKNAME) {
423	my $name = $HOOKNAME[$htype];
424
425	my $ref = $pkg->can ("on_" . lc $name)
426	or next;
427
428	$TERM->{_hook}[$htype]{$pkg} = $ref;
429	$hook_count[$htype]++
430	or set_should_invoke $htype, 1;
431	}
432	}
433
434	my $script_pkg = "script0000";
435	my %script_pkg;
436		515
437	# load a single script into its own package, once only	516	# load a single script into its own package, once only
438	sub script_package($) {	517	sub extension_package($) {
439	my ($path) = @_;	518	my ($path) = @_;
440		519
441	$script_pkg{$path} \|\|= do {	520	$extension_pkg{$path} \|\|= do {
442	my $pkg = "urxvt::" . ($script_pkg++);	521	my $pkg = "urxvt::" . ($extension_pkg++);
443		522
444	verbose 3, "loading script '$path' into package '$pkg'";	523	verbose 3, "loading extension '$path' into package '$pkg'";
445		524
446	open my $fh, "<:raw", $path	525	open my $fh, "<:raw", $path
447	or die "$path: $!";	526	or die "$path: $!";
448		527
		528	my $source = untaint
449	my $source = "package $pkg; use strict; use utf8;\n"	529	"package $pkg; use strict; use utf8;\n"
		530	. "use base urxvt::term::extension::;\n"
450	. "#line 1 \"$path\"\n{\n"	531	. "#line 1 \"$path\"\n{\n"
451	. (do { local $/; <$fh> })	532	. (do { local $/; <$fh> })
452	. "\n};\n1";	533	. "\n};\n1";
453		534
		535	eval $source
454	eval $source or die "$path: $@";	536	or die "$path: $@";
455		537
456	$pkg	538	$pkg
457	}	539	}
458	}	540	}
459		541
…		…
464	local $TERM = shift;	546	local $TERM = shift;
465	my $htype = shift;	547	my $htype = shift;
466		548
467	if ($htype == 0) { # INIT	549	if ($htype == 0) { # INIT
468	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	550	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		551
		552	my %ext_arg;
469		553
470	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	554	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		555	if ($_ eq "default") {
		556	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		557	} elsif (/^-(.*)$/) {
		558	delete $ext_arg{$1};
		559	} elsif (/^([^<]+)<(.*)>$/) {
		560	push @{ $ext_arg{$1} }, $2;
		561	} else {
		562	$ext_arg{$_} \|\|= [];
		563	}
		564	}
		565
		566	while (my ($ext, $argv) = each %ext_arg) {
471	my @files = grep -f $_, map "$_/$ext", @dirs;	567	my @files = grep -f $_, map "$_/$ext", @dirs;
472		568
473	if (@files) {	569	if (@files) {
474	register_package script_package $files[0];	570	$TERM->register_package (extension_package $files[0], $argv);
475	} else {	571	} else {
476	warn "perl extension '$ext' not found in perl library search path\n";	572	warn "perl extension '$ext' not found in perl library search path\n";
477	}	573	}
478	}	574	}
		575
		576	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		577	warn $@ if $@;
479	}	578	}
480		579
481	$retval = undef;	580	$retval = undef;
482		581
483	if (my $cb = $TERM->{_hook}[$htype]) {	582	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
485	if $verbosity >= 10;	584	if $verbosity >= 10;
486		585
487	keys %$cb;	586	keys %$cb;
488		587
489	while (my ($pkg, $cb) = each %$cb) {	588	while (my ($pkg, $cb) = each %$cb) {
490	$retval = $cb->(	589	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
491	$TERM->{_pkg}{$pkg} \|\|= do {
492	my $proxy = bless { }, urxvt::term::proxy::;
493	Scalar::Util::weaken ($proxy->{term} = $TERM);
494	$proxy
495	},
496	@_,
497	) and last;	590	and last;
		591
		592	if ($@) {
		593	$TERM->ungrab; # better to lose the grab than the session
		594	warn $@;
		595	}
498	}	596	}
499	}	597	}
500		598
501	if ($htype == 1) { # DESTROY	599	if ($htype == 1) { # DESTROY
502	# remove hooks if unused
503	if (my $hook = $TERM->{_hook}) {	600	if (my $hook = delete $TERM->{_hook}) {
504	for my $htype (0..$#$hook) {	601	for my $htype (0..$#$hook) {
505	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	602	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
506	or set_should_invoke $htype, 0;	603	or set_should_invoke $htype, 0;
507	}	604	}
508	}	605	}
…		…
515	}	612	}
516		613
517	$retval	614	$retval
518	}	615	}
519		616
520	sub urxvt::term::proxy::AUTOLOAD {	617	# urxvt::term::extension
521	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	618
		619	package urxvt::term::extension;
		620
		621	sub enable {
		622	my ($self, %hook) = @_;
		623	my $pkg = $self->{_pkg};
		624
		625	while (my ($name, $cb) = each %hook) {
		626	my $htype = $HOOKTYPE{uc $name};
		627	defined $htype
		628	or Carp::croak "unsupported hook type '$name'";
		629
		630	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		631	$hook_count[$htype]++
		632	or urxvt::set_should_invoke $htype, 1;
		633	}
		634
		635	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		636	}
		637	}
		638
		639	sub disable {
		640	my ($self, @hook) = @_;
		641	my $pkg = $self->{_pkg};
		642
		643	for my $name (@hook) {
		644	my $htype = $HOOKTYPE{uc $name};
		645	defined $htype
		646	or Carp::croak "unsupported hook type '$name'";
		647
		648	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		649	--$hook_count[$htype]
		650	or urxvt::set_should_invoke $htype, 0;
		651	}
		652	}
		653	}
		654
		655	our $AUTOLOAD;
		656
		657	sub AUTOLOAD {
		658	$AUTOLOAD =~ /:([^:]+)$/
522	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	659	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
523		660
524	eval qq{	661	eval qq{
525	sub $urxvt::term::proxy::AUTOLOAD {	662	sub $AUTOLOAD {
526	my \$proxy = shift;	663	my \$proxy = shift;
527	\$proxy->{term}->$1 (\@_)	664	\$proxy->{term}->$1 (\@_)
528	}	665	}
529	1	666	1
530	} or die "FATAL: unable to compile method forwarder: $@";	667	} or die "FATAL: unable to compile method forwarder: $@";
531		668
532	goto &$urxvt::term::proxy::AUTOLOAD;	669	goto &$AUTOLOAD;
533	}	670	}
		671
		672	sub DESTROY {
		673	# nop
		674	}
		675
		676	# urxvt::destroy_hook
		677
		678	sub urxvt::destroy_hook::DESTROY {
		679	${$_[0]}->();
		680	}
		681
		682	sub urxvt::destroy_hook(&) {
		683	bless \shift, urxvt::destroy_hook::
		684	}
		685
		686	package urxvt::anyevent;
		687
		688	=head2 The C<urxvt::anyevent> Class
		689
		690	The sole purpose of this class is to deliver an interface to the
		691	C<AnyEvent> module - any module using it will work inside urxvt without
		692	further programming. The only exception is that you cannot wait on
		693	condition variables, but non-blocking condvar use is ok. What this means
		694	is that you cannot use blocking APIs, but the non-blocking variant should
		695	work.
		696
		697	=cut
		698
		699	our $VERSION = 1;
		700
		701	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		702	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		703
		704	sub timer {
		705	my ($class, %arg) = @_;
		706
		707	my $cb = $arg{cb};
		708
		709	urxvt::timer
		710	->new
		711	->start (urxvt::NOW + $arg{after})
		712	->cb (sub {
		713	$_[0]->stop; # need to cancel manually
		714	$cb->();
		715	})
		716	}
		717
		718	sub io {
		719	my ($class, %arg) = @_;
		720
		721	my $cb = $arg{cb};
		722
		723	bless [$arg{fh}, urxvt::iow
		724	->new
		725	->fd (fileno $arg{fh})
		726	->events (($arg{poll} =~ /r/ ? 1 : 0)
		727	\| ($arg{poll} =~ /w/ ? 2 : 0))
		728	->start
		729	->cb (sub {
		730	$cb->(($_[1] & 1 ? 'r' : '')
		731	. ($_[1] & 2 ? 'w' : ''));
		732	})],
		733	urxvt::anyevent::
		734	}
		735
		736	sub DESTROY {
		737	$_[0][1]->stop;
		738	}
		739
		740	sub condvar {
		741	bless \my $flag, urxvt::anyevent::condvar::
		742	}
		743
		744	sub urxvt::anyevent::condvar::broadcast {
		745	${$_[0]}++;
		746	}
		747
		748	sub urxvt::anyevent::condvar::wait {
		749	unless (${$_[0]}) {
		750	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		751	}
		752	}
		753
		754	package urxvt::term;
534		755
535	=head2 The C<urxvt::term> Class	756	=head2 The C<urxvt::term> Class
536		757
537	=over 4	758	=over 4
538		759
		760	=cut
		761
		762	# find on_xxx subs in the package and register them
		763	# as hooks
		764	sub register_package {
		765	my ($self, $pkg, $argv) = @_;
		766
		767	my $proxy = bless {
		768	_pkg => $pkg,
		769	argv => $argv,
		770	}, $pkg;
		771	Scalar::Util::weaken ($proxy->{term} = $self);
		772
		773	$self->{_pkg}{$pkg} = $proxy;
		774
		775	for my $name (@HOOKNAME) {
		776	if (my $ref = $pkg->can ("on_" . lc $name)) {
		777	$proxy->enable ($name => $ref);
		778	}
		779	}
		780	}
		781
		782	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		783
		784	Creates a new terminal, very similar as if you had started it with system
		785	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		786	hash which defines the environment of the new terminal.
		787
		788	Croaks (and probably outputs an error message) if the new instance
		789	couldn't be created. Returns C<undef> if the new instance didn't
		790	initialise perl, and the terminal object otherwise. The C<init> and
		791	C<start> hooks will be called during this call.
		792
		793	=cut
		794
		795	sub new {
		796	my ($class, $env, @args) = @_;
		797
		798	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		799	}
		800
539	=item $term->destroy	801	=item $term->destroy
540		802
541	Destroy the terminal object (close the window, free resources etc.).	803	Destroy the terminal object (close the window, free resources
		804	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		805	watchers (timers, io watchers) are still active.
		806
		807	=item $isset = $term->option ($optval[, $set])
		808
		809	Returns true if the option specified by C<$optval> is enabled, and
		810	optionally change it. All option values are stored by name in the hash
		811	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		812
		813	Here is a a likely non-exhaustive list of option names, please see the
		814	source file F</src/optinc.h> to see the actual list:
		815
		816	borderLess console cursorBlink cursorUnderline hold iconic insecure
		817	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		818	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		819	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		820	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		821	tripleclickwords utmpInhibit visualBell
542		822
543	=item $value = $term->resource ($name[, $newval])	823	=item $value = $term->resource ($name[, $newval])
544		824
545	Returns the current resource value associated with a given name and	825	Returns the current resource value associated with a given name and
546	optionally sets a new value. Setting values is most useful in the C<init>	826	optionally sets a new value. Setting values is most useful in the C<init>
…		…
556		836
557	Please note that resource strings will currently only be freed when the	837	Please note that resource strings will currently only be freed when the
558	terminal is destroyed, so changing options frequently will eat memory.	838	terminal is destroyed, so changing options frequently will eat memory.
559		839
560	Here is a a likely non-exhaustive list of resource names, not all of which	840	Here is a a likely non-exhaustive list of resource names, not all of which
561	are supported in every build, please see the source to see the actual	841	are supported in every build, please see the source file F</src/rsinc.h>
562	list:	842	to see the actual list:
563		843
564	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	844	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
565	borderLess color cursorBlink cursorUnderline cutchars delete_key	845	borderLess color cursorBlink cursorUnderline cutchars delete_key
566	display_name embed ext_bwidth fade font geometry hold iconName	846	display_name embed ext_bwidth fade font geometry hold iconName
567	imFont imLocale inputMethod insecure int_bwidth intensityStyles	847	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
574	shade term_name title transparent transparent_all tripleclickwords	854	shade term_name title transparent transparent_all tripleclickwords
575	utmpInhibit visualBell	855	utmpInhibit visualBell
576		856
577	=cut	857	=cut
578		858
579	sub urxvt::term::resource($$;$) {	859	sub resource($$;$) {
580	my ($self, $name) = (shift, shift);	860	my ($self, $name) = (shift, shift);
581	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	861	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
582	goto &urxvt::term::_resource;	862	&urxvt::term::_resource
583	}	863	}
		864
		865	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		866
		867	Adds a keymap translation exactly as specified via a resource. See the
		868	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
584		869
585	=item $rend = $term->rstyle ([$new_rstyle])	870	=item $rend = $term->rstyle ([$new_rstyle])
586		871
587	Return and optionally change the current rendition. Text that is output by	872	Return and optionally change the current rendition. Text that is output by
588	the terminal application will use this style.	873	the terminal application will use this style.
…		…
608		893
609	=item $oldtext = $term->selection ([$newtext])	894	=item $oldtext = $term->selection ([$newtext])
610		895
611	Return the current selection text and optionally replace it by C<$newtext>.	896	Return the current selection text and optionally replace it by C<$newtext>.
612		897
613	#=item $term->overlay ($x, $y, $text)	898	=item $term->overlay_simple ($x, $y, $text)
614	#	899
615	#Create a simple multi-line overlay box. See the next method for details.	900	Create a simple multi-line overlay box. See the next method for details.
616	#	901
617	#=cut	902	=cut
618	#	903
619	#sub urxvt::term::scr_overlay {	904	sub overlay_simple {
620	# my ($self, $x, $y, $text) = @_;	905	my ($self, $x, $y, $text) = @_;
621	#	906
622	# my @lines = split /\n/, $text;	907	my @lines = split /\n/, $text;
623	#	908
624	# my $w = 0;	909	my $w = List::Util::max map $self->strwidth ($_), @lines;
625	# for (map $self->strwidth ($_), @lines) {	910
626	# $w = $_ if $w < $_;
627	# }
628	#
629	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	911	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
630	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	912	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
631	#}	913
		914	$overlay
		915	}
632		916
633	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	917	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
634		918
635	Create a new (empty) overlay at the given position with the given	919	Create a new (empty) overlay at the given position with the given
636	width/height. C<$rstyle> defines the initial rendition style	920	width/height. C<$rstyle> defines the initial rendition style
…		…
663		947
664	If hidden, display the overlay again.	948	If hidden, display the overlay again.
665		949
666	=back	950	=back
667		951
		952	=item $popup = $term->popup ($event)
		953
		954	Creates a new C<urxvt::popup> object that implements a popup menu. The
		955	C<$event> I<must> be the event causing the menu to pop up (a button event,
		956	currently).
		957
		958	=cut
		959
		960	sub popup {
		961	my ($self, $event) = @_;
		962
		963	$self->grab ($event->{time}, 1)
		964	or return;
		965
		966	my $popup = bless {
		967	term => $self,
		968	event => $event,
		969	}, urxvt::popup::;
		970
		971	Scalar::Util::weaken $popup->{term};
		972
		973	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		974	Scalar::Util::weaken $self->{_destroy}{$popup};
		975
		976	$popup
		977	}
		978
668	=item $cellwidth = $term->strwidth ($string)	979	=item $cellwidth = $term->strwidth ($string)
669		980
670	Returns the number of screen-cells this string would need. Correctly	981	Returns the number of screen-cells this string would need. Correctly
671	accounts for wide and combining characters.	982	accounts for wide and combining characters.
672		983
…		…
675	Convert the given text string into the corresponding locale encoding.	986	Convert the given text string into the corresponding locale encoding.
676		987
677	=item $string = $term->locale_decode ($octets)	988	=item $string = $term->locale_decode ($octets)
678		989
679	Convert the given locale-encoded octets into a perl string.	990	Convert the given locale-encoded octets into a perl string.
		991
		992	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		993
		994	XORs the rendition values in the given span with the provided value
		995	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		996	to the selection.
		997
		998	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		999
		1000	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1001	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1002	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1003	it instead.
		1004
		1005	=item $term->scr_bell
		1006
		1007	Ring the bell!
680		1008
681	=item $term->scr_add_lines ($string)	1009	=item $term->scr_add_lines ($string)
682		1010
683	Write the given text string to the screen, as if output by the application	1011	Write the given text string to the screen, as if output by the application
684	running inside the terminal. It may not contain command sequences (escape	1012	running inside the terminal. It may not contain command sequences (escape
…		…
699		1027
700	Write the octets given in C<$data> to the tty (i.e. as program input). To	1028	Write the octets given in C<$data> to the tty (i.e. as program input). To
701	pass characters instead of octets, you should convert your strings first	1029	pass characters instead of octets, you should convert your strings first
702	to the locale-specific encoding using C<< $term->locale_encode >>.	1030	to the locale-specific encoding using C<< $term->locale_encode >>.
703		1031
		1032	=item $old_events = $term->pty_ev_events ([$new_events])
		1033
		1034	Replaces the event mask of the pty watcher by the given event mask. Can
		1035	be used to suppress input and output handling to the pty/tty. See the
		1036	description of C<< urxvt::timer->events >>. Make sure to always restore
		1037	the previous value.
		1038
704	=item $windowid = $term->parent	1039	=item $windowid = $term->parent
705		1040
706	Return the window id of the toplevel window.	1041	Return the window id of the toplevel window.
707		1042
708	=item $windowid = $term->vt	1043	=item $windowid = $term->vt
…		…
732	=item $nrow_plus_saveLines = $term->total_rows	1067	=item $nrow_plus_saveLines = $term->total_rows
733		1068
734	=item $lines_in_scrollback = $term->nsaved	1069	=item $lines_in_scrollback = $term->nsaved
735		1070
736	Return various integers describing terminal characteristics.	1071	Return various integers describing terminal characteristics.
		1072
		1073	=item $x_display = $term->display_id
		1074
		1075	Return the DISPLAY used by rxvt-unicode.
		1076
		1077	=item $lc_ctype = $term->locale
		1078
		1079	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1080
		1081	=item $env = $term->env
		1082
		1083	Returns a copy of the environment in effect for the terminal as a hashref
		1084	similar to C<\%ENV>.
		1085
		1086	=cut
		1087
		1088	sub env {
		1089	if (my $env = $_[0]->_env) {
		1090	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1091	} else {
		1092	+{ %ENV }
		1093	}
		1094	}
		1095
		1096	=item $modifiermask = $term->ModLevel3Mask
		1097
		1098	=item $modifiermask = $term->ModMetaMask
		1099
		1100	=item $modifiermask = $term->ModNumLockMask
		1101
		1102	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1103	AltGr), the meta key (often Alt) and the num lock key, if applicable.
737		1104
738	=item $view_start = $term->view_start ([$newvalue])	1105	=item $view_start = $term->view_start ([$newvalue])
739		1106
740	Returns the negative row number of the topmost line. Minimum value is	1107	Returns the negative row number of the topmost line. Minimum value is
741	C<0>, which displays the normal terminal contents. Larger values scroll	1108	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
835		1202
836	=back	1203	=back
837		1204
838	=cut	1205	=cut
839		1206
840	sub urxvt::term::line {	1207	sub line {
841	my ($self, $row) = @_;	1208	my ($self, $row) = @_;
842		1209
843	my $maxrow = $self->nrow - 1;	1210	my $maxrow = $self->nrow - 1;
844		1211
845	my ($beg, $end) = ($row, $row);	1212	my ($beg, $end) = ($row, $row);
…		…
909	$offset / $self->{ncol} + $self->{beg},	1276	$offset / $self->{ncol} + $self->{beg},
910	$offset % $self->{ncol}	1277	$offset % $self->{ncol}
911	)	1278	)
912	}	1279	}
913		1280
914	=item ($row, $col) = $line->coord_of ($offset)
915	=item $text = $term->special_encode $string	1281	=item $text = $term->special_encode $string
916		1282
917	Converts a perl string into the special encoding used by rxvt-unicode,	1283	Converts a perl string into the special encoding used by rxvt-unicode,
918	where one character corresponds to one screen cell. See	1284	where one character corresponds to one screen cell. See
919	C<< $term->ROW_t >> for details.	1285	C<< $term->ROW_t >> for details.
920		1286
921	=item $string = $term->special_decode $text	1287	=item $string = $term->special_decode $text
922		1288
923	Converts rxvt-unicodes text reprsentation into a perl string. See	1289	Converts rxvt-unicodes text reprsentation into a perl string. See
924	C<< $term->ROW_t >> for details.	1290	C<< $term->ROW_t >> for details.
		1291
		1292	=item $success = $term->grab_button ($button, $modifiermask)
		1293
		1294	Registers a synchronous button grab. See the XGrabButton manpage.
		1295
		1296	=item $success = $term->grab ($eventtime[, $sync])
		1297
		1298	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1299	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1300
		1301	=item $term->allow_events_async
		1302
		1303	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1304
		1305	=item $term->allow_events_sync
		1306
		1307	Calls XAllowEvents with SyncBoth for the most recent grab.
		1308
		1309	=item $term->allow_events_replay
		1310
		1311	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1312	recent grab.
		1313
		1314	=item $term->ungrab
		1315
		1316	Calls XUngrab for the most recent grab. Is called automatically on
		1317	evaluation errors, as it is better to lose the grab in the error case as
		1318	the session.
		1319
		1320	=back
		1321
		1322	=cut
		1323
		1324	package urxvt::popup;
		1325
		1326	=head2 The C<urxvt::popup> Class
		1327
		1328	=over 4
		1329
		1330	=cut
		1331
		1332	sub add_item {
		1333	my ($self, $item) = @_;
		1334
		1335	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1336	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1337	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1338
		1339	$item->{render} \|\|= sub { $_[0]{text} };
		1340
		1341	push @{ $self->{item} }, $item;
		1342	}
		1343
		1344	=item $popup->add_title ($title)
		1345
		1346	Adds a non-clickable title to the popup.
		1347
		1348	=cut
		1349
		1350	sub add_title {
		1351	my ($self, $title) = @_;
		1352
		1353	$self->add_item ({
		1354	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1355	text => $title,
		1356	activate => sub { },
		1357	});
		1358	}
		1359
		1360	=item $popup->add_separator ([$sepchr])
		1361
		1362	Creates a separator, optionally using the character given as C<$sepchr>.
		1363
		1364	=cut
		1365
		1366	sub add_separator {
		1367	my ($self, $sep) = @_;
		1368
		1369	$sep \|\|= "=";
		1370
		1371	$self->add_item ({
		1372	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1373	text => "",
		1374	render => sub { $sep x $self->{term}->ncol },
		1375	activate => sub { },
		1376	});
		1377	}
		1378
		1379	=item $popup->add_button ($text, $cb)
		1380
		1381	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1382	selected.
		1383
		1384	=cut
		1385
		1386	sub add_button {
		1387	my ($self, $text, $cb) = @_;
		1388
		1389	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1390	}
		1391
		1392	=item $popup->add_toggle ($text, $cb, $initial_value)
		1393
		1394	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1395	whenever it gets toggled, with a boolean indicating its value as its first
		1396	argument.
		1397
		1398	=cut
		1399
		1400	sub add_toggle {
		1401	my ($self, $text, $cb, $value) = @_;
		1402
		1403	my $item; $item = {
		1404	type => "button",
		1405	text => " $text",
		1406	value => $value,
		1407	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1408	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1409	};
		1410
		1411	$self->add_item ($item);
		1412	}
		1413
		1414	=item $popup->show
		1415
		1416	Displays the popup (which is initially hidden).
		1417
		1418	=cut
		1419
		1420	sub show {
		1421	my ($self) = @_;
		1422
		1423	local $urxvt::popup::self = $self;
		1424
		1425	my $env = $self->{term}->env;
		1426	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1427	delete $env->{LC_ALL};
		1428	$env->{LC_CTYPE} = $self->{term}->locale;
		1429
		1430	urxvt::term->new ($env, $self->{term}->resource ("name"),
		1431	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1432	"--transient-for" => $self->{term}->parent,
		1433	"-display" => $self->{term}->display_id,
		1434	"-pe" => "urxvt-popup")
		1435	or die "unable to create popup window\n";
		1436	}
		1437
		1438	sub DESTROY {
		1439	my ($self) = @_;
		1440
		1441	delete $self->{term}{_destroy}{$self};
		1442	$self->{term}->ungrab;
		1443	}
925		1444
926	=back	1445	=back
927		1446
928	=head2 The C<urxvt::timer> Class	1447	=head2 The C<urxvt::timer> Class
929		1448
…		…
984		1503
985	$term->{socket} = ...	1504	$term->{socket} = ...
986	$term->{iow} = urxvt::iow	1505	$term->{iow} = urxvt::iow
987	->new	1506	->new
988	->fd (fileno $term->{socket})	1507	->fd (fileno $term->{socket})
989	->events (1) # wait for read data	1508	->events (urxvt::EVENT_READ)
990	->start	1509	->start
991	->cb (sub {	1510	->cb (sub {
992	my ($iow, $revents) = @_;	1511	my ($iow, $revents) = @_;
993	# $revents must be 1 here, no need to check	1512	# $revents must be 1 here, no need to check
994	sysread $term->{socket}, my $buf, 8192	1513	sysread $term->{socket}, my $buf, 8192
…		…
1011		1530
1012	Set the filedescriptor (not handle) to watch.	1531	Set the filedescriptor (not handle) to watch.
1013		1532
1014	=item $iow = $iow->events ($eventmask)	1533	=item $iow = $iow->events ($eventmask)
1015		1534
1016	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1535	Set the event mask to watch. The only allowed values are
1017	data, Bit #1 (value C<2>) enables watching for write data.	1536	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1537	together, or C<urxvt::EVENT_NONE>.
1018		1538
1019	=item $iow = $iow->start	1539	=item $iow = $iow->start
1020		1540
1021	Start watching for requested events on the given handle.	1541	Start watching for requested events on the given handle.
1022		1542
…		…
1033	This variable controls the verbosity level of the perl extension. Higher	1553	This variable controls the verbosity level of the perl extension. Higher
1034	numbers indicate more verbose output.	1554	numbers indicate more verbose output.
1035		1555
1036	=over 4	1556	=over 4
1037		1557
1038	=item =0 - only fatal messages	1558	=item == 0 - fatal messages
1039		1559
1040	=item =3 - script loading and management	1560	=item >= 3 - script loading and management
1041		1561
1042	=item =10 - all events received	1562	=item >=10 - all events received
1043		1563
1044	=back	1564	=back
1045		1565
1046	=head1 AUTHOR	1566	=head1 AUTHOR
1047		1567

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.40 by root, Fri Jan 6 05:37:59 2006 UTC vs. Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.40 by root, Fri Jan 6 05:37:59 2006 UTC vs.
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC