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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.39 by root, Fri Jan 6 05:28:55 2006 UTC vs.
Revision 1.77 by root, Wed Jan 11 00:59:58 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
…		…
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.
		390
		391	=item
298		392
299	=back	393	=back
300		394
301	=head2 Functions in the C<urxvt> Package	395	=head2 Functions in the C<urxvt> Package
302		396
303	=over 4	397	=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		398
313	=item urxvt::fatal $errormessage	399	=item urxvt::fatal $errormessage
314		400
315	Fatally aborts execution with the given error message. Avoid at all	401	Fatally aborts execution with the given error message. Avoid at all
316	costs! The only time this is acceptable is when the terminal process	402	costs! The only time this is acceptable is when the terminal process
…		…
323	that calls this function.	409	that calls this function.
324		410
325	Using this function has the advantage that its output ends up in the	411	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.	412	correct place, e.g. on stderr of the connecting urxvtc client.
327		413
		414	Messages have a size limit of 1023 bytes currently.
		415
		416	=item $is_safe = urxvt::safe
		417
		418	Returns true when it is safe to do potentially unsafe things, such as
		419	evaluating perl code specified by the user. This is true when urxvt was
		420	started setuid or setgid.
		421
328	=item $time = urxvt::NOW	422	=item $time = urxvt::NOW
329		423
330	Returns the "current time" (as per the event loop).	424	Returns the "current time" (as per the event loop).
		425
		426	=item urxvt::CurrentTime
		427
		428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		430	Button4Mask, Button5Mask, AnyModifier
		431
		432	Various constants for use in X calls and event processing.
331		433
332	=back	434	=back
333		435
334	=head2 RENDITION	436	=head2 RENDITION
335		437
…		…
362		464
363	=item $background = urxvt::GET_BASEBG $rend	465	=item $background = urxvt::GET_BASEBG $rend
364		466
365	Return the foreground/background colour index, respectively.	467	Return the foreground/background colour index, respectively.
366		468
367	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
368		470
369	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
370		472
371	Replace the foreground/background colour in the rendition mask with the	473	Replace the foreground/background colour in the rendition mask with the
372	specified one.	474	specified one.
373		475
374	=item $value = urxvt::GET_CUSTOM ($rend)	476	=item $value = urxvt::GET_CUSTOM $rend
375		477
376	Return the "custom" value: Every rendition has 5 bits for use by	478	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	479	extensions. They can be set and changed as you like and are initially
378	zero.	480	zero.
379		481
380	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	482	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
381		483
382	Change the custom value.	484	Change the custom value.
383		485
384	=back	486	=back
385		487
386	=cut	488	=cut
387
388	package urxvt;
389
390	use strict;
391	use Scalar::Util ();
392
393	our $TERM;
394	our @HOOKNAME;
395	our $LIBDIR;
396		489
397	BEGIN {	490	BEGIN {
398	urxvt->bootstrap;	491	urxvt->bootstrap;
399		492
400	# overwrite perl's warn	493	# overwrite perl's warn
…		…
402	my $msg = join "", @_;	495	my $msg = join "", @_;
403	$msg .= "\n"	496	$msg .= "\n"
404	unless $msg =~ /\n$/;	497	unless $msg =~ /\n$/;
405	urxvt::warn ($msg);	498	urxvt::warn ($msg);
406	};	499	};
		500
		501	delete $ENV{IFS};
		502	delete $ENV{CDPATH};
		503	delete $ENV{BASH_ENV};
		504	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
407	}	505	}
408		506
409	my @hook_count;	507	my @hook_count;
410	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	508	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
411		509
412	sub verbose {	510	sub verbose {
413	my ($level, $msg) = @_;	511	my ($level, $msg) = @_;
414	warn "$msg\n" if $level <= $verbosity;	512	warn "$msg\n" if $level <= $verbosity;
415	}	513	}
416		514
417	# find on_xxx subs in the package and register them	515	my $extension_pkg = "extension0000";
418	# as hooks	516	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		517
437	# load a single script into its own package, once only	518	# load a single script into its own package, once only
438	sub script_package($) {	519	sub extension_package($) {
439	my ($path) = @_;	520	my ($path) = @_;
440		521
441	$script_pkg{$path} \|\|= do {	522	$extension_pkg{$path} \|\|= do {
442	my $pkg = "urxvt::" . ($script_pkg++);	523	my $pkg = "urxvt::" . ($extension_pkg++);
443		524
444	verbose 3, "loading script '$path' into package '$pkg'";	525	verbose 3, "loading extension '$path' into package '$pkg'";
445		526
446	open my $fh, "<:raw", $path	527	open my $fh, "<:raw", $path
447	or die "$path: $!";	528	or die "$path: $!";
448		529
		530	my $source = untaint
449	my $source = "package $pkg; use strict; use utf8;\n"	531	"package $pkg; use strict; use utf8;\n"
		532	. "use base urxvt::term::extension::;\n"
450	. "#line 1 \"$path\"\n{\n"	533	. "#line 1 \"$path\"\n{\n"
451	. (do { local $/; <$fh> })	534	. (do { local $/; <$fh> })
452	. "\n};\n1";	535	. "\n};\n1";
453		536
		537	eval $source
454	eval $source or die "$path: $@";	538	or die "$path: $@";
455		539
456	$pkg	540	$pkg
457	}	541	}
458	}	542	}
459		543
…		…
464	local $TERM = shift;	548	local $TERM = shift;
465	my $htype = shift;	549	my $htype = shift;
466		550
467	if ($htype == 0) { # INIT	551	if ($htype == 0) { # INIT
468	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	552	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		553
		554	my %ext_arg;
469		555
470	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	556	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		557	if ($_ eq "default") {
		558	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		559	} elsif (/^-(.*)$/) {
		560	delete $ext_arg{$1};
		561	} elsif (/^([^<]+)<(.*)>$/) {
		562	push @{ $ext_arg{$1} }, $2;
		563	} else {
		564	$ext_arg{$_} \|\|= [];
		565	}
		566	}
		567
		568	while (my ($ext, $argv) = each %ext_arg) {
471	my @files = grep -f $_, map "$_/$ext", @dirs;	569	my @files = grep -f $_, map "$_/$ext", @dirs;
472		570
473	if (@files) {	571	if (@files) {
474	register_package script_package $files[0];	572	$TERM->register_package (extension_package $files[0], $argv);
475	} else {	573	} else {
476	warn "perl extension '$ext' not found in perl library search path\n";	574	warn "perl extension '$ext' not found in perl library search path\n";
477	}	575	}
478	}	576	}
		577
		578	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		579	warn $@ if $@;
479	}	580	}
480		581
481	$retval = undef;	582	$retval = undef;
482		583
483	if (my $cb = $TERM->{_hook}[$htype]) {	584	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
485	if $verbosity >= 10;	586	if $verbosity >= 10;
486		587
487	keys %$cb;	588	keys %$cb;
488		589
489	while (my ($pkg, $cb) = each %$cb) {	590	while (my ($pkg, $cb) = each %$cb) {
490	$retval = $cb->(	591	$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;	592	and last;
		593
		594	if ($@) {
		595	$TERM->ungrab; # better to lose the grab than the session
		596	warn $@;
		597	}
498	}	598	}
499	}	599	}
500		600
501	if ($htype == 1) { # DESTROY	601	if ($htype == 1) { # DESTROY
502	# remove hooks if unused
503	if (my $hook = $TERM->{_hook}) {	602	if (my $hook = delete $TERM->{_hook}) {
504	for my $htype (0..$#$hook) {	603	for my $htype (0..$#$hook) {
505	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	604	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
506	or set_should_invoke $htype, 0;	605	or set_should_invoke $htype, 0;
507	}	606	}
508	}	607	}
…		…
515	}	614	}
516		615
517	$retval	616	$retval
518	}	617	}
519		618
520	sub urxvt::term::proxy::AUTOLOAD {	619	# urxvt::term::extension
521	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	620
		621	package urxvt::term::extension;
		622
		623	sub enable {
		624	my ($self, %hook) = @_;
		625	my $pkg = $self->{_pkg};
		626
		627	while (my ($name, $cb) = each %hook) {
		628	my $htype = $HOOKTYPE{uc $name};
		629	defined $htype
		630	or Carp::croak "unsupported hook type '$name'";
		631
		632	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		633	$hook_count[$htype]++
		634	or urxvt::set_should_invoke $htype, 1;
		635	}
		636
		637	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		638	}
		639	}
		640
		641	sub disable {
		642	my ($self, @hook) = @_;
		643	my $pkg = $self->{_pkg};
		644
		645	for my $name (@hook) {
		646	my $htype = $HOOKTYPE{uc $name};
		647	defined $htype
		648	or Carp::croak "unsupported hook type '$name'";
		649
		650	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		651	--$hook_count[$htype]
		652	or urxvt::set_should_invoke $htype, 0;
		653	}
		654	}
		655	}
		656
		657	our $AUTOLOAD;
		658
		659	sub AUTOLOAD {
		660	$AUTOLOAD =~ /:([^:]+)$/
522	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	661	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
523		662
524	eval qq{	663	eval qq{
525	sub $urxvt::term::proxy::AUTOLOAD {	664	sub $AUTOLOAD {
526	my \$proxy = shift;	665	my \$proxy = shift;
527	\$proxy->{term}->$1 (\@_)	666	\$proxy->{term}->$1 (\@_)
528	}	667	}
529	1	668	1
530	} or die "FATAL: unable to compile method forwarder: $@";	669	} or die "FATAL: unable to compile method forwarder: $@";
531		670
532	goto &$urxvt::term::proxy::AUTOLOAD;	671	goto &$AUTOLOAD;
533	}	672	}
		673
		674	sub DESTROY {
		675	# nop
		676	}
		677
		678	# urxvt::destroy_hook
		679
		680	sub urxvt::destroy_hook::DESTROY {
		681	${$_[0]}->();
		682	}
		683
		684	sub urxvt::destroy_hook(&) {
		685	bless \shift, urxvt::destroy_hook::
		686	}
		687
		688	package urxvt::anyevent;
		689
		690	=head2 The C<urxvt::anyevent> Class
		691
		692	The sole purpose of this class is to deliver an interface to the
		693	C<AnyEvent> module - any module using it will work inside urxvt without
		694	further programming. The only exception is that you cannot wait on
		695	condition variables, but non-blocking condvar use is ok. What this means
		696	is that you cannot use blocking APIs, but the non-blocking variant should
		697	work.
		698
		699	=cut
		700
		701	our $VERSION = 1;
		702
		703	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		704	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		705
		706	sub timer {
		707	my ($class, %arg) = @_;
		708
		709	my $cb = $arg{cb};
		710
		711	urxvt::timer
		712	->new
		713	->start (urxvt::NOW + $arg{after})
		714	->cb (sub {
		715	$_[0]->stop; # need to cancel manually
		716	$cb->();
		717	})
		718	}
		719
		720	sub io {
		721	my ($class, %arg) = @_;
		722
		723	my $cb = $arg{cb};
		724
		725	bless [$arg{fh}, urxvt::iow
		726	->new
		727	->fd (fileno $arg{fh})
		728	->events (($arg{poll} =~ /r/ ? 1 : 0)
		729	\| ($arg{poll} =~ /w/ ? 2 : 0))
		730	->start
		731	->cb (sub {
		732	$cb->(($_[1] & 1 ? 'r' : '')
		733	. ($_[1] & 2 ? 'w' : ''));
		734	})],
		735	urxvt::anyevent::
		736	}
		737
		738	sub DESTROY {
		739	$_[0][1]->stop;
		740	}
		741
		742	sub condvar {
		743	bless \my $flag, urxvt::anyevent::condvar::
		744	}
		745
		746	sub urxvt::anyevent::condvar::broadcast {
		747	${$_[0]}++;
		748	}
		749
		750	sub urxvt::anyevent::condvar::wait {
		751	unless (${$_[0]}) {
		752	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		753	}
		754	}
		755
		756	package urxvt::term;
534		757
535	=head2 The C<urxvt::term> Class	758	=head2 The C<urxvt::term> Class
536		759
537	=over 4	760	=over 4
538		761
		762	=cut
		763
		764	# find on_xxx subs in the package and register them
		765	# as hooks
		766	sub register_package {
		767	my ($self, $pkg, $argv) = @_;
		768
		769	my $proxy = bless {
		770	_pkg => $pkg,
		771	argv => $argv,
		772	}, $pkg;
		773	Scalar::Util::weaken ($proxy->{term} = $self);
		774
		775	$self->{_pkg}{$pkg} = $proxy;
		776
		777	for my $name (@HOOKNAME) {
		778	if (my $ref = $pkg->can ("on_" . lc $name)) {
		779	$proxy->enable ($name => $ref);
		780	}
		781	}
		782	}
		783
		784	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		785
		786	Creates a new terminal, very similar as if you had started it with system
		787	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a %ENV>-like
		788	C<hash which defines the environment of the new terminal.
		789
		790	Croaks (and probably outputs an error message) if the new instance
		791	couldn't be created. Returns C<undef> if the new instance didn't
		792	initialise perl, and the terminal object otherwise. The C<init> and
		793	C<start> hooks will be called during this call.
		794
		795	=cut
		796
		797	sub new {
		798	my ($class, $env, @args) = @_;
		799
		800	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		801	}
		802
539	=item $term->destroy	803	=item $term->destroy
540		804
541	Destroy the terminal object (close the window, free resources etc.).	805	Destroy the terminal object (close the window, free resources
		806	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		807	watchers (timers, io watchers) are still active.
		808
		809	=item $isset = $term->option ($optval[, $set])
		810
		811	Returns true if the option specified by C<$optval> is enabled, and
		812	optionally change it. All option values are stored by name in the hash
		813	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		814
		815	Here is a a likely non-exhaustive list of option names, please see the
		816	source file F</src/optinc.h> to see the actual list:
		817
		818	borderLess console cursorBlink cursorUnderline hold iconic insecure
		819	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		820	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		821	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		822	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		823	tripleclickwords utmpInhibit visualBell
542		824
543	=item $value = $term->resource ($name[, $newval])	825	=item $value = $term->resource ($name[, $newval])
544		826
545	Returns the current resource value associated with a given name and	827	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>	828	optionally sets a new value. Setting values is most useful in the C<init>
…		…
556		838
557	Please note that resource strings will currently only be freed when the	839	Please note that resource strings will currently only be freed when the
558	terminal is destroyed, so changing options frequently will eat memory.	840	terminal is destroyed, so changing options frequently will eat memory.
559		841
560	Here is a a likely non-exhaustive list of resource names, not all of which	842	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	843	are supported in every build, please see the source file F</src/rsinc.h>
562	list:	844	to see the actual list:
563		845
564	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	846	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
565	borderLess color cursorBlink cursorUnderline cutchars delete_key	847	borderLess color cursorBlink cursorUnderline cutchars delete_key
566	display_name embed ext_bwidth fade font geometry hold iconName	848	display_name embed ext_bwidth fade font geometry hold iconName
567	imFont imLocale inputMethod insecure int_bwidth intensityStyles	849	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
574	shade term_name title transparent transparent_all tripleclickwords	856	shade term_name title transparent transparent_all tripleclickwords
575	utmpInhibit visualBell	857	utmpInhibit visualBell
576		858
577	=cut	859	=cut
578		860
579	sub urxvt::term::resource($$;$) {	861	sub resource($$;$) {
580	my ($self, $name) = (shift, shift);	862	my ($self, $name) = (shift, shift);
581	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	863	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
582	goto &urxvt::term::_resource;	864	&urxvt::term::_resource
583	}	865	}
		866
		867	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		868
		869	Adds a keymap translation exactly as specified via a resource. See the
		870	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
584		871
585	=item $rend = $term->rstyle ([$new_rstyle])	872	=item $rend = $term->rstyle ([$new_rstyle])
586		873
587	Return and optionally change the current rendition. Text that is output by	874	Return and optionally change the current rendition. Text that is output by
588	the terminal application will use this style.	875	the terminal application will use this style.
…		…
608		895
609	=item $oldtext = $term->selection ([$newtext])	896	=item $oldtext = $term->selection ([$newtext])
610		897
611	Return the current selection text and optionally replace it by C<$newtext>.	898	Return the current selection text and optionally replace it by C<$newtext>.
612		899
613	#=item $term->overlay ($x, $y, $text)	900	=item $term->overlay_simple ($x, $y, $text)
614	#	901
615	#Create a simple multi-line overlay box. See the next method for details.	902	Create a simple multi-line overlay box. See the next method for details.
616	#	903
617	#=cut	904	=cut
618	#	905
619	#sub urxvt::term::scr_overlay {	906	sub overlay_simple {
620	# my ($self, $x, $y, $text) = @_;	907	my ($self, $x, $y, $text) = @_;
621	#	908
622	# my @lines = split /\n/, $text;	909	my @lines = split /\n/, $text;
623	#	910
624	# my $w = 0;	911	my $w = List::Util::max map $self->strwidth ($_), @lines;
625	# for (map $self->strwidth ($_), @lines) {	912
626	# $w = $_ if $w < $_;
627	# }
628	#
629	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	913	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
630	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	914	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
631	#}	915
		916	$overlay
		917	}
632		918
633	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	919	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
634		920
635	Create a new (empty) overlay at the given position with the given	921	Create a new (empty) overlay at the given position with the given
636	width/height. C<$rstyle> defines the initial rendition style	922	width/height. C<$rstyle> defines the initial rendition style
…		…
663		949
664	If hidden, display the overlay again.	950	If hidden, display the overlay again.
665		951
666	=back	952	=back
667		953
		954	=item $popup = $term->popup ($event)
		955
		956	Creates a new C<urxvt::popup> object that implements a popup menu. The
		957	C<$event> I<must> be the event causing the menu to pop up (a button event,
		958	currently).
		959
		960	=cut
		961
		962	sub popup {
		963	my ($self, $event) = @_;
		964
		965	$self->grab ($event->{time}, 1)
		966	or return;
		967
		968	my $popup = bless {
		969	term => $self,
		970	event => $event,
		971	}, urxvt::popup::;
		972
		973	Scalar::Util::weaken $popup->{term};
		974
		975	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		976	Scalar::Util::weaken $self->{_destroy}{$popup};
		977
		978	$popup
		979	}
		980
668	=item $cellwidth = $term->strwidth $string	981	=item $cellwidth = $term->strwidth ($string)
669		982
670	Returns the number of screen-cells this string would need. Correctly	983	Returns the number of screen-cells this string would need. Correctly
671	accounts for wide and combining characters.	984	accounts for wide and combining characters.
672		985
673	=item $octets = $term->locale_encode $string	986	=item $octets = $term->locale_encode ($string)
674		987
675	Convert the given text string into the corresponding locale encoding.	988	Convert the given text string into the corresponding locale encoding.
676		989
677	=item $string = $term->locale_decode $octets	990	=item $string = $term->locale_decode ($octets)
678		991
679	Convert the given locale-encoded octets into a perl string.	992	Convert the given locale-encoded octets into a perl string.
		993
		994	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		995
		996	XORs the rendition values in the given span with the provided value
		997	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		998	to the selection.
		999
		1000	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1001
		1002	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1003	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1004	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1005	it instead.
		1006
		1007	=item $term->scr_bell
		1008
		1009	Ring the bell!
680		1010
681	=item $term->scr_add_lines ($string)	1011	=item $term->scr_add_lines ($string)
682		1012
683	Write the given text string to the screen, as if output by the application	1013	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	1014	running inside the terminal. It may not contain command sequences (escape
…		…
699		1029
700	Write the octets given in C<$data> to the tty (i.e. as program input). To	1030	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	1031	pass characters instead of octets, you should convert your strings first
702	to the locale-specific encoding using C<< $term->locale_encode >>.	1032	to the locale-specific encoding using C<< $term->locale_encode >>.
703		1033
		1034	=item $old_events = $term->pty_ev_events ([$new_events])
		1035
		1036	Replaces the event mask of the pty watcher by the given event mask. Can
		1037	be used to suppress input and output handling to the pty/tty. See the
		1038	description of C<< urxvt::timer->events >>. Make sure to always restore
		1039	the previous value.
		1040
		1041	=item $windowid = $term->parent
		1042
		1043	Return the window id of the toplevel window.
		1044
		1045	=item $windowid = $term->vt
		1046
		1047	Return the window id of the terminal window.
		1048
704	=item $window_width = $term->width	1049	=item $window_width = $term->width
705		1050
706	=item $window_height = $term->height	1051	=item $window_height = $term->height
707		1052
708	=item $font_width = $term->fwidth	1053	=item $font_width = $term->fwidth
…		…
724	=item $nrow_plus_saveLines = $term->total_rows	1069	=item $nrow_plus_saveLines = $term->total_rows
725		1070
726	=item $lines_in_scrollback = $term->nsaved	1071	=item $lines_in_scrollback = $term->nsaved
727		1072
728	Return various integers describing terminal characteristics.	1073	Return various integers describing terminal characteristics.
		1074
		1075	=item $x_display = $term->display_id
		1076
		1077	Return the DISPLAY used by rxvt-unicode.
		1078
		1079	=item $lc_ctype = $term->locale
		1080
		1081	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1082
		1083	=item $env = $term->env
		1084
		1085	Returns a copy of the environment in effect for the terminal as a hashref
		1086	similar to C<\%ENV>.
		1087
		1088	=cut
		1089
		1090	sub env {
		1091	if (my $env = $_[0]->_env) {
		1092	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1093	} else {
		1094	+{ %ENV }
		1095	}
		1096	}
		1097
		1098	=item $modifiermask = $term->ModLevel3Mask
		1099
		1100	=item $modifiermask = $term->ModMetaMask
		1101
		1102	=item $modifiermask = $term->ModNumLockMask
		1103
		1104	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1105	AltGr), the meta key (often Alt) and the num lock key, if applicable.
729		1106
730	=item $view_start = $term->view_start ([$newvalue])	1107	=item $view_start = $term->view_start ([$newvalue])
731		1108
732	Returns the negative row number of the topmost line. Minimum value is	1109	Returns the negative row number of the topmost line. Minimum value is
733	C<0>, which displays the normal terminal contents. Larger values scroll	1110	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
827		1204
828	=back	1205	=back
829		1206
830	=cut	1207	=cut
831		1208
832	sub urxvt::term::line {	1209	sub line {
833	my ($self, $row) = @_;	1210	my ($self, $row) = @_;
834		1211
835	my $maxrow = $self->nrow - 1;	1212	my $maxrow = $self->nrow - 1;
836		1213
837	my ($beg, $end) = ($row, $row);	1214	my ($beg, $end) = ($row, $row);
…		…
901	$offset / $self->{ncol} + $self->{beg},	1278	$offset / $self->{ncol} + $self->{beg},
902	$offset % $self->{ncol}	1279	$offset % $self->{ncol}
903	)	1280	)
904	}	1281	}
905		1282
906	=item ($row, $col) = $line->coord_of ($offset)
907	=item $text = $term->special_encode $string	1283	=item $text = $term->special_encode $string
908		1284
909	Converts a perl string into the special encoding used by rxvt-unicode,	1285	Converts a perl string into the special encoding used by rxvt-unicode,
910	where one character corresponds to one screen cell. See	1286	where one character corresponds to one screen cell. See
911	C<< $term->ROW_t >> for details.	1287	C<< $term->ROW_t >> for details.
…		…
913	=item $string = $term->special_decode $text	1289	=item $string = $term->special_decode $text
914		1290
915	Converts rxvt-unicodes text reprsentation into a perl string. See	1291	Converts rxvt-unicodes text reprsentation into a perl string. See
916	C<< $term->ROW_t >> for details.	1292	C<< $term->ROW_t >> for details.
917		1293
		1294	=item $success = $term->grab_button ($button, $modifiermask)
		1295
		1296	Registers a synchronous button grab. See the XGrabButton manpage.
		1297
		1298	=item $success = $term->grab ($eventtime[, $sync])
		1299
		1300	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1301	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1302
		1303	=item $term->allow_events_async
		1304
		1305	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1306
		1307	=item $term->allow_events_sync
		1308
		1309	Calls XAllowEvents with SyncBoth for the most recent grab.
		1310
		1311	=item $term->allow_events_replay
		1312
		1313	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1314	recent grab.
		1315
		1316	=item $term->ungrab
		1317
		1318	Calls XUngrab for the most recent grab. Is called automatically on
		1319	evaluation errors, as it is better to lose the grab in the error case as
		1320	the session.
		1321
918	=back	1322	=back
		1323
		1324	=cut
		1325
		1326	package urxvt::popup;
		1327
		1328	=head2 The C<urxvt::popup> Class
		1329
		1330	=over 4
		1331
		1332	=cut
		1333
		1334	sub add_item {
		1335	my ($self, $item) = @_;
		1336
		1337	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1338	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1339	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1340
		1341	$item->{render} \|\|= sub { $_[0]{text} };
		1342
		1343	push @{ $self->{item} }, $item;
		1344	}
		1345
		1346	=item $popup->add_title ($title)
		1347
		1348	Adds a non-clickable title to the popup.
		1349
		1350	=cut
		1351
		1352	sub add_title {
		1353	my ($self, $title) = @_;
		1354
		1355	$self->add_item ({
		1356	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1357	text => $title,
		1358	activate => sub { },
		1359	});
		1360	}
		1361
		1362	=item $popup->add_separator ([$sepchr])
		1363
		1364	Creates a separator, optionally using the character given as C<$sepchr>.
		1365
		1366	=cut
		1367
		1368	sub add_separator {
		1369	my ($self, $sep) = @_;
		1370
		1371	$sep \|\|= "=";
		1372
		1373	$self->add_item ({
		1374	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1375	text => "",
		1376	render => sub { $sep x $self->{term}->ncol },
		1377	activate => sub { },
		1378	});
		1379	}
		1380
		1381	=item $popup->add_button ($text, $cb)
		1382
		1383	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1384	selected.
		1385
		1386	=cut
		1387
		1388	sub add_button {
		1389	my ($self, $text, $cb) = @_;
		1390
		1391	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1392	}
		1393
		1394	=item $popup->add_toggle ($text, $cb, $initial_value)
		1395
		1396	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1397	whenever it gets toggled, with a boolean indicating its value as its first
		1398	argument.
		1399
		1400	=cut
		1401
		1402	sub add_toggle {
		1403	my ($self, $text, $cb, $value) = @_;
		1404
		1405	my $item; $item = {
		1406	type => "button",
		1407	text => " $text",
		1408	value => $value,
		1409	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1410	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1411	};
		1412
		1413	$self->add_item ($item);
		1414	}
		1415
		1416	=item $popup->show
		1417
		1418	Displays the popup (which is initially hidden).
		1419
		1420	=cut
		1421
		1422	sub show {
		1423	my ($self) = @_;
		1424
		1425	local $urxvt::popup::self = $self;
		1426
		1427	my $env = $self->{term}->env;
		1428	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1429	delete $env->{LC_ALL};
		1430	$env->{LC_CTYPE} = $self->{term}->locale;
		1431
		1432	urxvt::term->new ($env, $self->{term}->resource ("name"),
		1433	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1434	"--transient-for" => $self->{term}->parent,
		1435	"-display" => $self->{term}->display_id,
		1436	"-pe" => "urxvt-popup")
		1437	or die "unable to create popup window\n";
		1438	}
		1439
		1440	sub DESTROY {
		1441	my ($self) = @_;
		1442
		1443	delete $self->{term}{_destroy}{$self};
		1444	$self->{term}->ungrab;
		1445	}
919		1446
920	=head2 The C<urxvt::timer> Class	1447	=head2 The C<urxvt::timer> Class
921		1448
922	This class implements timer watchers/events. Time is represented as a	1449	This class implements timer watchers/events. Time is represented as a
923	fractional number of seconds since the epoch. Example:	1450	fractional number of seconds since the epoch. Example:
…		…
976		1503
977	$term->{socket} = ...	1504	$term->{socket} = ...
978	$term->{iow} = urxvt::iow	1505	$term->{iow} = urxvt::iow
979	->new	1506	->new
980	->fd (fileno $term->{socket})	1507	->fd (fileno $term->{socket})
981	->events (1) # wait for read data	1508	->events (urxvt::EVENT_READ)
982	->start	1509	->start
983	->cb (sub {	1510	->cb (sub {
984	my ($iow, $revents) = @_;	1511	my ($iow, $revents) = @_;
985	# $revents must be 1 here, no need to check	1512	# $revents must be 1 here, no need to check
986	sysread $term->{socket}, my $buf, 8192	1513	sysread $term->{socket}, my $buf, 8192
…		…
1003		1530
1004	Set the filedescriptor (not handle) to watch.	1531	Set the filedescriptor (not handle) to watch.
1005		1532
1006	=item $iow = $iow->events ($eventmask)	1533	=item $iow = $iow->events ($eventmask)
1007		1534
1008	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
1009	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>.
1010		1538
1011	=item $iow = $iow->start	1539	=item $iow = $iow->start
1012		1540
1013	Start watching for requested events on the given handle.	1541	Start watching for requested events on the given handle.
1014		1542
…		…
1025	This variable controls the verbosity level of the perl extension. Higher	1553	This variable controls the verbosity level of the perl extension. Higher
1026	numbers indicate more verbose output.	1554	numbers indicate more verbose output.
1027		1555
1028	=over 4	1556	=over 4
1029		1557
1030	=item =0 - only fatal messages	1558	=item == 0 - fatal messages
1031		1559
1032	=item =3 - script loading and management	1560	=item >= 3 - script loading and management
1033		1561
1034	=item =10 - all events received	1562	=item >=10 - all events received
1035		1563
1036	=back	1564	=back
1037		1565
1038	=head1 AUTHOR	1566	=head1 AUTHOR
1039		1567

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.39 by root, Fri Jan 6 05:28:55 2006 UTC vs. Revision 1.77 by root, Wed Jan 11 00:59:58 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.39 by root, Fri Jan 6 05:28:55 2006 UTC vs.
Revision 1.77 by root, Wed Jan 11 00:59:58 2006 UTC