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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC vs.
Revision 1.70 by root, Mon Jan 9 23:00:07 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
…		…
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	Intelligent selection. This extension tries to be more intelligent when
45	the user extends selections (double-click). Right now, it tries to select	45	the user extends selections (double-click). Right now, it tries to select
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	urls and complete shell-quoted arguments, which is very convenient, too,
47	if your F<ls> supports C<--quoting-style=shell>.	47	if your F<ls> supports C<--quoting-style=shell>.
…		…
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.
		70
		71	=item searchable-scrollback (enabled by default)
		72
		73	Adds regex search functionality to the scrollback buffer, triggered by a
		74	hotkey (default: C<M-s>). When in search mode, terminal input/output is
		75	suspended, C</> starts an incremental regex search, C<n> searches further,
		76	C<p> jumps to the previous match. C<enter> leaves search mode at the
		77	current position and C<escape> returns to the original position.
		78
61	=item digital-clock	79	=item digital-clock
62		80
63	Displays a digital clock using the built-in overlay.	81	Displays a digital clock using the built-in overlay.
		82
		83	=item mark-urls
		84
		85	Uses per-line display filtering (C<on_line_update>) to underline urls.
		86
		87	=item block-graphics-to-ascii
		88
		89	A not very useful example of filtering all text output to the terminal,
		90	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		91	similar-looking ascii character.
64		92
65	=item example-refresh-hooks	93	=item example-refresh-hooks
66		94
67	Displays a very simple digital clock in the upper right corner of the	95	Displays a very simple digital clock in the upper right corner of the
68	window. Illustrates overwriting the refresh callbacks to create your own	96	window. Illustrates overwriting the refresh callbacks to create your own
69	overlays or changes.	97	overlays or changes.
70
71	=item mark-urls
72
73	A not very useful example of filtering all text output to the terminal, by
74	underlining all urls that matches a certain regex (i.e. some urls :). It
75	is not very useful because urls that are output in multiple steps (e.g.
76	when typing them) do not get marked.
77		98
78	=back	99	=back
79		100
80	=head2 General API Considerations	101	=head2 General API Considerations
81		102
…		…
111	Either binary data or - more common - a text string encoded in a	132	Either binary data or - more common - a text string encoded in a
112	locale-specific way.	133	locale-specific way.
113		134
114	=back	135	=back
115		136
		137	=head2 Extension Objects
		138
		139	Very perl extension is a perl class. A separate perl object is created
		140	for each terminal and each extension and passed as the first parameter to
		141	hooks. So extensions can use their C<$self> object without having to think
		142	about other extensions, with the exception of methods and members that
		143	begin with an underscore character C<_>: these are reserved for internal
		144	use.
		145
		146	Although it isn't a C<urxvt::term> object, you can call all methods of the
		147	C<urxvt::term> class on this object.
		148
		149	It has the following methods and data members:
		150
		151	=over 4
		152
		153	=item $urxvt_term = $self->{term}
		154
		155	Returns the C<urxvt::term> object associated with this instance of the
		156	extension. This member I<must not> be changed in any way.
		157
		158	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		159
		160	Dynamically enable the given hooks (named without the C<on_> prefix) for
		161	this extension, replacing any previous hook. This is useful when you want
		162	to overwrite time-critical hooks only temporarily.
		163
		164	=item $self->disable ($hook_name[, $hook_name..])
		165
		166	Dynamically disable the given hooks.
		167
		168	=back
		169
116	=head2 Hooks	170	=head2 Hooks
117		171
118	The following subroutines can be declared in loaded scripts, and will be	172	The following subroutines can be declared in extension files, and will be
119	called whenever the relevant event happens.	173	called whenever the relevant event happens.
120		174
121	The first argument passed to them is an object private to each terminal	175	The first argument passed to them is an extension oject as described in
122	and extension package. You can call all C<urxvt::term> methods on it, but	176	the in the C<Extension Objects> section.
123	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
124	object that is shared between all packages is stored in the C<term>
125	member.
126		177
127	All of them must return a boolean value. If it is true, then the event	178	B<All> of these hooks must return a boolean value. If it is true, then the
128	counts as being I<consumed>, and the invocation of other hooks is skipped,	179	event counts as being I<consumed>, and the invocation of other hooks is
129	and the relevant action might not be carried out by the C++ code.	180	skipped, and the relevant action might not be carried out by the C++ code.
130		181
131	When in doubt, return a false value (preferably C<()>).	182	I<< When in doubt, return a false value (preferably C<()>). >>
132		183
133	=over 4	184	=over 4
134		185
135	=item on_init $term	186	=item on_init $term
136		187
137	Called after a new terminal object has been initialized, but before	188	Called after a new terminal object has been initialized, but before
138	windows are created or the command gets run.	189	windows are created or the command gets run. Most methods are unsafe to
		190	call or deliver senseless data, as terminal size and other characteristics
		191	have not yet been determined. You can safely query and change resources,
		192	though.
139		193
140	=item on_reset $term	194	=item on_reset $term
141		195
142	Called after the screen is "reset" for any reason, such as resizing or	196	Called after the screen is "reset" for any reason, such as resizing or
143	control sequences. Here is where you can react on changes to size-related	197	control sequences. Here is where you can react on changes to size-related
…		…
172	should extend the selection itelf and return true to suppress the built-in	226	should extend the selection itelf and return true to suppress the built-in
173	processing.	227	processing.
174		228
175	See the F<selection> example extension.	229	See the F<selection> example extension.
176		230
177	=item on_focus_in $term
178
179	Called whenever the window gets the keyboard focus, before urxvt does
180	focus in processing.
181
182	=item on_focus_out $term
183
184	Called wheneever the window loses keyboard focus, before urxvt does focus
185	out processing.
186
187	=item on_view_change $term, $offset	231	=item on_view_change $term, $offset
188		232
189	Called whenever the view offset changes, i..e the user or program	233	Called whenever the view offset changes, i..e the user or program
190	scrolls. Offset C<0> means display the normal terminal, positive values	234	scrolls. Offset C<0> means display the normal terminal, positive values
191	show this many lines of scrollback.	235	show this many lines of scrollback.
…		…
197	than the scroll back buffer or the terminal.	241	than the scroll back buffer or the terminal.
198		242
199	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	243	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
200	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	244	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
201	number of lines that will be in the scrollback buffer.	245	number of lines that will be in the scrollback buffer.
202
203	=item on_tty_activity $term NYI
204
205	Called whenever the program(s) running in the urxvt window send output.
206		246
207	=item on_osc_seq $term, $string	247	=item on_osc_seq $term, $string
208		248
209	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	249	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
210	operating system command) is processed. Cursor position and other state	250	operating system command) is processed. Cursor position and other state
…		…
223	can filter/change and output the text yourself by returning a true value	263	can filter/change and output the text yourself by returning a true value
224	and calling C<< $term->scr_add_lines >> yourself. Please note that this	264	and calling C<< $term->scr_add_lines >> yourself. Please note that this
225	might be very slow, however, as your hook is called for B<all> text being	265	might be very slow, however, as your hook is called for B<all> text being
226	output.	266	output.
227		267
		268	=item on_line_update $term, $row
		269
		270	Called whenever a line was updated or changed. Can be used to filter
		271	screen output (e.g. underline urls or other useless stuff). Only lines
		272	that are being shown will be filtered, and, due to performance reasons,
		273	not always immediately.
		274
		275	The row number is always the topmost row of the line if the line spans
		276	multiple rows.
		277
		278	Please note that, if you change the line, then the hook might get called
		279	later with the already-modified line (e.g. if unrelated parts change), so
		280	you cannot just toggle rendition bits, but only set them.
		281
228	=item on_refresh_begin $term	282	=item on_refresh_begin $term
229		283
230	Called just before the screen gets redrawn. Can be used for overlay	284	Called just before the screen gets redrawn. Can be used for overlay
231	or similar effects by modify terminal contents in refresh_begin, and	285	or similar effects by modify terminal contents in refresh_begin, and
232	restoring them in refresh_end. The built-in overlay and selection display	286	restoring them in refresh_end. The built-in overlay and selection display
…		…
240		294
241	Called whenever the user presses a key combination that has a	295	Called whenever the user presses a key combination that has a
242	C<perl:string> action bound to it (see description of the B<keysym>	296	C<perl:string> action bound to it (see description of the B<keysym>
243	resource in the @@RXVT_NAME@@(1) manpage).	297	resource in the @@RXVT_NAME@@(1) manpage).
244		298
		299	=item on_focus_in $term
		300
		301	Called whenever the window gets the keyboard focus, before rxvt-unicode
		302	does focus in processing.
		303
		304	=item on_focus_out $term
		305
		306	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		307	focus out processing.
		308
		309	=item on_key_press $term, $event, $keysym, $octets
		310
		311	=item on_key_release $term, $event, $keysym
		312
		313	=item on_button_press $term, $event
		314
		315	=item on_button_release $term, $event
		316
		317	=item on_motion_notify $term, $event
		318
		319	=item on_map_notify $term, $event
		320
		321	=item on_unmap_notify $term, $event
		322
		323	Called whenever the corresponding X event is received for the terminal If
		324	the hook returns true, then the even will be ignored by rxvt-unicode.
		325
		326	The event is a hash with most values as named by Xlib (see the XEvent
		327	manpage), with the additional members C<row> and C<col>, which are the row
		328	and column under the mouse cursor.
		329
		330	C<on_key_press> additionally receives the string rxvt-unicode would
		331	output, if any, in locale-specific encoding.
		332
		333	subwindow.
		334
245	=back	335	=back
246		336
247	=head2 Variables in the C<urxvt> Package	337	=head2 Variables in the C<urxvt> Package
248		338
249	=over 4	339	=over 4
250		340
251	=item $urxvt::TERM	341	=item $urxvt::TERM
252		342
253	The current terminal. Whenever a callback/Hook is bein executed, this	343	The current terminal. This variable stores the current C<urxvt::term>
254	variable stores the current C<urxvt::term> object.	344	object, whenever a callback/hook is executing.
255		345
256	=back	346	=back
257		347
258	=head2 Functions in the C<urxvt> Package	348	=head2 Functions in the C<urxvt> Package
259		349
260	=over 4	350	=over 4
		351
		352	=item $term = new urxvt [arg...]
		353
		354	Creates a new terminal, very similar as if you had started it with
		355	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		356	if the new instance couldn't be created. Returns C<undef> if the new
		357	instance didn't initialise perl, and the terminal object otherwise. The
		358	C<init> and C<start> hooks will be called during the call.
261		359
262	=item urxvt::fatal $errormessage	360	=item urxvt::fatal $errormessage
263		361
264	Fatally aborts execution with the given error message. Avoid at all	362	Fatally aborts execution with the given error message. Avoid at all
265	costs! The only time this is acceptable is when the terminal process	363	costs! The only time this is acceptable is when the terminal process
…		…
272	that calls this function.	370	that calls this function.
273		371
274	Using this function has the advantage that its output ends up in the	372	Using this function has the advantage that its output ends up in the
275	correct place, e.g. on stderr of the connecting urxvtc client.	373	correct place, e.g. on stderr of the connecting urxvtc client.
276		374
		375	=item $is_safe = urxvt::safe
		376
		377	Returns true when it is safe to do potentially unsafe things, such as
		378	evaluating perl code specified by the user. This is true when urxvt was
		379	started setuid or setgid.
		380
277	=item $time = urxvt::NOW	381	=item $time = urxvt::NOW
278		382
279	Returns the "current time" (as per the event loop).	383	Returns the "current time" (as per the event loop).
		384
		385	=item urxvt::CurrentTime
		386
		387	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		388	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		389	Button4Mask, Button5Mask, AnyModifier
		390
		391	Various constants for use in X calls and event processing.
280		392
281	=back	393	=back
282		394
283	=head2 RENDITION	395	=head2 RENDITION
284		396
…		…
334		446
335	=cut	447	=cut
336		448
337	package urxvt;	449	package urxvt;
338		450
		451	use utf8;
339	use strict;	452	use strict;
		453	use Carp ();
340	use Scalar::Util ();	454	use Scalar::Util ();
		455	use List::Util ();
341		456
		457	our $VERSION = 1;
342	our $TERM;	458	our $TERM;
343	our @HOOKNAME;	459	our @HOOKNAME;
		460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		461	our %OPTION;
344	our $LIBDIR;	462	our $LIBDIR;
345		463
346	BEGIN {	464	BEGIN {
347	urxvt->bootstrap;	465	urxvt->bootstrap;
348		466
…		…
351	my $msg = join "", @_;	469	my $msg = join "", @_;
352	$msg .= "\n"	470	$msg .= "\n"
353	unless $msg =~ /\n$/;	471	unless $msg =~ /\n$/;
354	urxvt::warn ($msg);	472	urxvt::warn ($msg);
355	};	473	};
		474
		475	delete $ENV{IFS};
		476	delete $ENV{CDPATH};
		477	delete $ENV{BASH_ENV};
		478	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
356	}	479	}
357		480
358	my @hook_count;	481	my @hook_count;
359	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
360		483
361	sub verbose {	484	sub verbose {
362	my ($level, $msg) = @_;	485	my ($level, $msg) = @_;
363	warn "$msg\n" if $level <= $verbosity;	486	warn "$msg\n" if $level <= $verbosity;
364	}	487	}
365		488
366	# find on_xxx subs in the package and register them	489	my $extension_pkg = "extension0000";
367	# as hooks	490	my %extension_pkg;
368	sub register_package($) {
369	my ($pkg) = @_;
370
371	for my $htype (0.. $#HOOKNAME) {
372	my $name = $HOOKNAME[$htype];
373
374	my $ref = $pkg->can ("on_" . lc $name)
375	or next;
376
377	$TERM->{_hook}[$htype]{$pkg} = $ref;
378	$hook_count[$htype]++
379	or set_should_invoke $htype, 1;
380	}
381	}
382
383	my $script_pkg = "script0000";
384	my %script_pkg;
385		491
386	# load a single script into its own package, once only	492	# load a single script into its own package, once only
387	sub script_package($) {	493	sub extension_package($) {
388	my ($path) = @_;	494	my ($path) = @_;
389		495
390	$script_pkg{$path} \|\|= do {	496	$extension_pkg{$path} \|\|= do {
391	my $pkg = "urxvt::" . ($script_pkg++);	497	my $pkg = "urxvt::" . ($extension_pkg++);
392		498
393	verbose 3, "loading script '$path' into package '$pkg'";	499	verbose 3, "loading extension '$path' into package '$pkg'";
394		500
395	open my $fh, "<:raw", $path	501	open my $fh, "<:raw", $path
396	or die "$path: $!";	502	or die "$path: $!";
397		503
		504	my $source = untaint
398	my $source = "package $pkg; use strict; use utf8;\n"	505	"package $pkg; use strict; use utf8;\n"
		506	. "use base urxvt::term::proxy::;\n"
399	. "#line 1 \"$path\"\n{\n"	507	. "#line 1 \"$path\"\n{\n"
400	. (do { local $/; <$fh> })	508	. (do { local $/; <$fh> })
401	. "\n};\n1";	509	. "\n};\n1";
402		510
		511	eval $source
403	eval $source or die "$path: $@";	512	or die "$path: $@";
404		513
405	$pkg	514	$pkg
406	}	515	}
407	}	516	}
408		517
…		…
413	local $TERM = shift;	522	local $TERM = shift;
414	my $htype = shift;	523	my $htype = shift;
415		524
416	if ($htype == 0) { # INIT	525	if ($htype == 0) { # INIT
417	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		527
		528	my %ext_arg;
418		529
419	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	530	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		531	if ($_ eq "default") {
		532	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		533	} elsif (/^-(.*)$/) {
		534	delete $ext_arg{$1};
		535	} elsif (/^([^<]+)<(.*)>$/) {
		536	push @{ $ext_arg{$1} }, $2;
		537	} else {
		538	$ext_arg{$_} \|\|= [];
		539	}
		540	}
		541
		542	while (my ($ext, $argv) = each %ext_arg) {
420	my @files = grep -f $_, map "$_/$ext", @dirs;	543	my @files = grep -f $_, map "$_/$ext", @dirs;
421		544
422	if (@files) {	545	if (@files) {
423	register_package script_package $files[0];	546	$TERM->register_package (extension_package $files[0], $argv);
424	} else {	547	} else {
425	warn "perl extension '$ext' not found in perl library search path\n";	548	warn "perl extension '$ext' not found in perl library search path\n";
426	}	549	}
427	}	550	}
		551
		552	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		553	warn $@ if $@;
428	}	554	}
429		555
430	$retval = undef;	556	$retval = undef;
431		557
432	if (my $cb = $TERM->{_hook}[$htype]) {	558	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
434	if $verbosity >= 10;	560	if $verbosity >= 10;
435		561
436	keys %$cb;	562	keys %$cb;
437		563
438	while (my ($pkg, $cb) = each %$cb) {	564	while (my ($pkg, $cb) = each %$cb) {
439	$retval = $cb->(	565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
440	$TERM->{_pkg}{$pkg} \|\|= do {
441	my $proxy = bless { }, urxvt::term::proxy::;
442	Scalar::Util::weaken ($proxy->{term} = $TERM);
443	$proxy
444	},
445	@_,
446	) and last;	566	and last;
		567
		568	if ($@) {
		569	$TERM->ungrab; # better to lose the grab than the session
		570	warn $@;
		571	}
447	}	572	}
448	}	573	}
449		574
450	if ($htype == 1) { # DESTROY	575	if ($htype == 1) { # DESTROY
451	# remove hooks if unused
452	if (my $hook = $TERM->{_hook}) {	576	if (my $hook = delete $TERM->{_hook}) {
453	for my $htype (0..$#$hook) {	577	for my $htype (0..$#$hook) {
454	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	578	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
455	or set_should_invoke $htype, 0;	579	or set_should_invoke $htype, 0;
456	}	580	}
457	}	581	}
…		…
464	}	588	}
465		589
466	$retval	590	$retval
467	}	591	}
468		592
469	sub urxvt::term::proxy::AUTOLOAD {	593	# urxvt::term::proxy
470	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	594
		595	package urxvt::term::proxy;
		596
		597	sub enable {
		598	my ($self, %hook) = @_;
		599	my $pkg = $self->{_pkg};
		600
		601	while (my ($name, $cb) = each %hook) {
		602	my $htype = $HOOKTYPE{uc $name};
		603	defined $htype
		604	or Carp::croak "unsupported hook type '$name'";
		605
		606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		607	$hook_count[$htype]++
		608	or urxvt::set_should_invoke $htype, 1;
		609	}
		610
		611	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		612	}
		613	}
		614
		615	sub disable {
		616	my ($self, @hook) = @_;
		617	my $pkg = $self->{_pkg};
		618
		619	for my $name (@hook) {
		620	my $htype = $HOOKTYPE{uc $name};
		621	defined $htype
		622	or Carp::croak "unsupported hook type '$name'";
		623
		624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		625	--$hook_count[$htype]
		626	or urxvt::set_should_invoke $htype, 0;
		627	}
		628	}
		629	}
		630
		631	our $AUTOLOAD;
		632
		633	sub AUTOLOAD {
		634	$AUTOLOAD =~ /:([^:]+)$/
471	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	635	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
472		636
473	eval qq{	637	eval qq{
474	sub $urxvt::term::proxy::AUTOLOAD {	638	sub $AUTOLOAD {
475	my \$proxy = shift;	639	my \$proxy = shift;
476	\$proxy->{term}->$1 (\@_)	640	\$proxy->{term}->$1 (\@_)
477	}	641	}
478	1	642	1
479	} or die "FATAL: unable to compile method forwarder: $@";	643	} or die "FATAL: unable to compile method forwarder: $@";
480		644
481	goto &$urxvt::term::proxy::AUTOLOAD;	645	goto &$AUTOLOAD;
482	}	646	}
		647
		648	sub DESTROY {
		649	# nop
		650	}
		651
		652	# urxvt::destroy_hook
		653
		654	sub urxvt::destroy_hook::DESTROY {
		655	${$_[0]}->();
		656	}
		657
		658	sub urxvt::destroy_hook(&) {
		659	bless \shift, urxvt::destroy_hook::
		660	}
		661
		662	package urxvt::anyevent;
		663
		664	=head2 The C<urxvt::anyevent> Class
		665
		666	The sole purpose of this class is to deliver an interface to the
		667	C<AnyEvent> module - any module using it will work inside urxvt without
		668	further work. The only exception is that you cannot wait on condition
		669	variables, but non-blocking condvar use is ok. What this means is that you
		670	cannot use blocking APIs, but the non-blocking variant should work.
		671
		672	=cut
		673
		674	our $VERSION = 1;
		675
		676	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		677	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		678
		679	sub timer {
		680	my ($class, %arg) = @_;
		681
		682	my $cb = $arg{cb};
		683
		684	urxvt::timer
		685	->new
		686	->start (urxvt::NOW + $arg{after})
		687	->cb (sub {
		688	$_[0]->stop; # need to cancel manually
		689	$cb->();
		690	})
		691	}
		692
		693	sub io {
		694	my ($class, %arg) = @_;
		695
		696	my $cb = $arg{cb};
		697
		698	bless [$arg{fh}, urxvt::iow
		699	->new
		700	->fd (fileno $arg{fh})
		701	->events (($arg{poll} =~ /r/ ? 1 : 0)
		702	\| ($arg{poll} =~ /w/ ? 2 : 0))
		703	->start
		704	->cb (sub {
		705	$cb->(($_[1] & 1 ? 'r' : '')
		706	. ($_[1] & 2 ? 'w' : ''));
		707	})],
		708	urxvt::anyevent::
		709	}
		710
		711	sub DESTROY {
		712	$_[0][1]->stop;
		713	}
		714
		715	sub condvar {
		716	bless \my $flag, urxvt::anyevent::condvar::
		717	}
		718
		719	sub urxvt::anyevent::condvar::broadcast {
		720	${$_[0]}++;
		721	}
		722
		723	sub urxvt::anyevent::condvar::wait {
		724	unless (${$_[0]}) {
		725	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		726	}
		727	}
		728
		729	package urxvt::term;
483		730
484	=head2 The C<urxvt::term> Class	731	=head2 The C<urxvt::term> Class
485		732
486	=over 4	733	=over 4
		734
		735	=cut
		736
		737	# find on_xxx subs in the package and register them
		738	# as hooks
		739	sub register_package {
		740	my ($self, $pkg, $argv) = @_;
		741
		742	my $proxy = bless {
		743	_pkg => $pkg,
		744	argv => $argv,
		745	}, $pkg;
		746	Scalar::Util::weaken ($proxy->{term} = $self);
		747
		748	$self->{_pkg}{$pkg} = $proxy;
		749
		750	for my $name (@HOOKNAME) {
		751	if (my $ref = $pkg->can ("on_" . lc $name)) {
		752	$proxy->enable ($name => $ref);
		753	}
		754	}
		755	}
		756
		757	=item $term->destroy
		758
		759	Destroy the terminal object (close the window, free resources etc.).
		760
		761	=item $isset = $term->option ($optval[, $set])
		762
		763	Returns true if the option specified by C<$optval> is enabled, and
		764	optionally change it. All option values are stored by name in the hash
		765	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		766
		767	Here is a a likely non-exhaustive list of option names, please see the
		768	source file F</src/optinc.h> to see the actual list:
		769
		770	borderLess console cursorBlink cursorUnderline hold iconic insecure
		771	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		772	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		773	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		774	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		775	tripleclickwords utmpInhibit visualBell
487		776
488	=item $value = $term->resource ($name[, $newval])	777	=item $value = $term->resource ($name[, $newval])
489		778
490	Returns the current resource value associated with a given name and	779	Returns the current resource value associated with a given name and
491	optionally sets a new value. Setting values is most useful in the C<init>	780	optionally sets a new value. Setting values is most useful in the C<init>
…		…
501		790
502	Please note that resource strings will currently only be freed when the	791	Please note that resource strings will currently only be freed when the
503	terminal is destroyed, so changing options frequently will eat memory.	792	terminal is destroyed, so changing options frequently will eat memory.
504		793
505	Here is a a likely non-exhaustive list of resource names, not all of which	794	Here is a a likely non-exhaustive list of resource names, not all of which
506	are supported in every build, please see the source to see the actual	795	are supported in every build, please see the source file F</src/rsinc.h>
507	list:	796	to see the actual list:
508		797
509	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	798	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
510	borderLess color cursorBlink cursorUnderline cutchars delete_key	799	borderLess color cursorBlink cursorUnderline cutchars delete_key
511	display_name embed ext_bwidth fade font geometry hold iconName	800	display_name embed ext_bwidth fade font geometry hold iconName
512	imFont imLocale inputMethod insecure int_bwidth intensityStyles	801	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
519	shade term_name title transparent transparent_all tripleclickwords	808	shade term_name title transparent transparent_all tripleclickwords
520	utmpInhibit visualBell	809	utmpInhibit visualBell
521		810
522	=cut	811	=cut
523		812
524	sub urxvt::term::resource($$;$) {	813	sub resource($$;$) {
525	my ($self, $name) = (shift, shift);	814	my ($self, $name) = (shift, shift);
526	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
527	goto &urxvt::term::_resource;	816	&urxvt::term::_resource
528	}	817	}
		818
		819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		820
		821	Adds a keymap translation exactly as specified via a resource. See the
		822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
529		823
530	=item $rend = $term->rstyle ([$new_rstyle])	824	=item $rend = $term->rstyle ([$new_rstyle])
531		825
532	Return and optionally change the current rendition. Text that is output by	826	Return and optionally change the current rendition. Text that is output by
533	the terminal application will use this style.	827	the terminal application will use this style.
…		…
553		847
554	=item $oldtext = $term->selection ([$newtext])	848	=item $oldtext = $term->selection ([$newtext])
555		849
556	Return the current selection text and optionally replace it by C<$newtext>.	850	Return the current selection text and optionally replace it by C<$newtext>.
557		851
558	#=item $term->overlay ($x, $y, $text)	852	=item $term->overlay_simple ($x, $y, $text)
559	#	853
560	#Create a simple multi-line overlay box. See the next method for details.	854	Create a simple multi-line overlay box. See the next method for details.
561	#	855
562	#=cut	856	=cut
563	#	857
564	#sub urxvt::term::scr_overlay {	858	sub overlay_simple {
565	# my ($self, $x, $y, $text) = @_;	859	my ($self, $x, $y, $text) = @_;
566	#	860
567	# my @lines = split /\n/, $text;	861	my @lines = split /\n/, $text;
568	#	862
569	# my $w = 0;	863	my $w = List::Util::max map $self->strwidth ($_), @lines;
570	# for (map $self->strwidth ($_), @lines) {	864
571	# $w = $_ if $w < $_;
572	# }
573	#
574	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	865	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
575	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	866	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
576	#}	867
		868	$overlay
		869	}
577		870
578	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	871	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
579		872
580	Create a new (empty) overlay at the given position with the given	873	Create a new (empty) overlay at the given position with the given
581	width/height. C<$rstyle> defines the initial rendition style	874	width/height. C<$rstyle> defines the initial rendition style
…		…
608		901
609	If hidden, display the overlay again.	902	If hidden, display the overlay again.
610		903
611	=back	904	=back
612		905
		906	=item $popup = $term->popup ($event)
		907
		908	Creates a new C<urxvt::popup> object that implements a popup menu. The
		909	C<$event> I<must> be the event causing the menu to pop up (a button event,
		910	currently).
		911
		912	=cut
		913
		914	sub popup {
		915	my ($self, $event) = @_;
		916
		917	$self->grab ($event->{time}, 1)
		918	or return;
		919
		920	my $popup = bless {
		921	term => $self,
		922	event => $event,
		923	}, urxvt::popup::;
		924
		925	Scalar::Util::weaken $popup->{term};
		926
		927	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		928	Scalar::Util::weaken $self->{_destroy}{$popup};
		929
		930	$popup
		931	}
		932
613	=item $cellwidth = $term->strwidth $string	933	=item $cellwidth = $term->strwidth ($string)
614		934
615	Returns the number of screen-cells this string would need. Correctly	935	Returns the number of screen-cells this string would need. Correctly
616	accounts for wide and combining characters.	936	accounts for wide and combining characters.
617		937
618	=item $octets = $term->locale_encode $string	938	=item $octets = $term->locale_encode ($string)
619		939
620	Convert the given text string into the corresponding locale encoding.	940	Convert the given text string into the corresponding locale encoding.
621		941
622	=item $string = $term->locale_decode $octets	942	=item $string = $term->locale_decode ($octets)
623		943
624	Convert the given locale-encoded octets into a perl string.	944	Convert the given locale-encoded octets into a perl string.
		945
		946	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		947
		948	XORs the rendition values in the given span with the provided value
		949	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		950	to the selection.
		951
		952	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		953
		954	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		955	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		956	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		957	it instead.
		958
		959	=item $term->scr_bell
		960
		961	Ring the bell!
625		962
626	=item $term->scr_add_lines ($string)	963	=item $term->scr_add_lines ($string)
627		964
628	Write the given text string to the screen, as if output by the application	965	Write the given text string to the screen, as if output by the application
629	running inside the terminal. It may not contain command sequences (escape	966	running inside the terminal. It may not contain command sequences (escape
…		…
632		969
633	Normally its not a good idea to use this function, as programs might be	970	Normally its not a good idea to use this function, as programs might be
634	confused by changes in cursor position or scrolling. Its useful inside a	971	confused by changes in cursor position or scrolling. Its useful inside a
635	C<on_add_lines> hook, though.	972	C<on_add_lines> hook, though.
636		973
		974	=item $term->cmd_parse ($octets)
		975
		976	Similar to C<scr_add_lines>, but the argument must be in the
		977	locale-specific encoding of the terminal and can contain command sequences
		978	(escape codes) that will be interpreted.
		979
637	=item $term->tt_write ($octets)	980	=item $term->tt_write ($octets)
638		981
639	Write the octets given in C<$data> to the tty (i.e. as program input). To	982	Write the octets given in C<$data> to the tty (i.e. as program input). To
640	pass characters instead of octets, you should convert your strings first	983	pass characters instead of octets, you should convert your strings first
641	to the locale-specific encoding using C<< $term->locale_encode >>.	984	to the locale-specific encoding using C<< $term->locale_encode >>.
642		985
		986	=item $old_events = $term->pty_ev_events ([$new_events])
		987
		988	Replaces the event mask of the pty watcher by the given event mask. Can
		989	be used to suppress input and output handling to the pty/tty. See the
		990	description of C<< urxvt::timer->events >>. Make sure to always restore
		991	the previous value.
		992
		993	=item $windowid = $term->parent
		994
		995	Return the window id of the toplevel window.
		996
		997	=item $windowid = $term->vt
		998
		999	Return the window id of the terminal window.
		1000
643	=item $window_width = $term->width	1001	=item $window_width = $term->width
644		1002
645	=item $window_height = $term->height	1003	=item $window_height = $term->height
646		1004
647	=item $font_width = $term->fwidth	1005	=item $font_width = $term->fwidth
…		…
663	=item $nrow_plus_saveLines = $term->total_rows	1021	=item $nrow_plus_saveLines = $term->total_rows
664		1022
665	=item $lines_in_scrollback = $term->nsaved	1023	=item $lines_in_scrollback = $term->nsaved
666		1024
667	Return various integers describing terminal characteristics.	1025	Return various integers describing terminal characteristics.
		1026
		1027	=item $lc_ctype = $term->locale
		1028
		1029	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1030
		1031	=item $x_display = $term->display_id
		1032
		1033	Return the DISPLAY used by rxvt-unicode.
		1034
		1035	=item $modifiermask = $term->ModLevel3Mask
		1036
		1037	=item $modifiermask = $term->ModMetaMask
		1038
		1039	=item $modifiermask = $term->ModNumLockMask
		1040
		1041	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1042	AltGr), the meta key (often Alt) and the num lock key, if applicable.
668		1043
669	=item $view_start = $term->view_start ([$newvalue])	1044	=item $view_start = $term->view_start ([$newvalue])
670		1045
671	Returns the negative row number of the topmost line. Minimum value is	1046	Returns the negative row number of the topmost line. Minimum value is
672	C<0>, which displays the normal terminal contents. Larger values scroll	1047	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
735	about the logical line that row C<$row_number> is part of. It supports the	1110	about the logical line that row C<$row_number> is part of. It supports the
736	following methods:	1111	following methods:
737		1112
738	=over 4	1113	=over 4
739		1114
740	=item $text = $line->t	1115	=item $text = $line->t ([$new_text])
741		1116
742	Returns the full text of the line, similar to C<ROW_t>	1117	Returns or replaces the full text of the line, similar to C<ROW_t>
743		1118
744	=item $rend = $line->r	1119	=item $rend = $line->r ([$new_rend])
745		1120
746	Returns the full rendition array of the line, similar to C<ROW_r>	1121	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
747		1122
748	=item $length = $line->l	1123	=item $length = $line->l
749		1124
750	Returns the length of the line in cells, similar to C<ROW_l>.	1125	Returns the length of the line in cells, similar to C<ROW_l>.
751		1126
…		…
766		1141
767	=back	1142	=back
768		1143
769	=cut	1144	=cut
770		1145
771	sub urxvt::term::line {	1146	sub line {
772	my ($self, $row) = @_;	1147	my ($self, $row) = @_;
773		1148
774	my $maxrow = $self->nrow - 1;	1149	my $maxrow = $self->nrow - 1;
775		1150
776	my ($beg, $end) = ($row, $row);	1151	my ($beg, $end) = ($row, $row);
…		…
780		1155
781	bless {	1156	bless {
782	term => $self,	1157	term => $self,
783	beg => $beg,	1158	beg => $beg,
784	end => $end,	1159	end => $end,
		1160	ncol => $self->ncol,
785	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1161	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
786	}, urxvt::line::	1162	}, urxvt::line::
787	}	1163	}
788		1164
789	sub urxvt::line::t {	1165	sub urxvt::line::t {
790	my ($self) = @_;	1166	my ($self) = @_;
791		1167
		1168	if (@_ > 1)
		1169	{
		1170	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1171	for $self->{beg} .. $self->{end};
		1172	}
		1173
		1174	defined wantarray &&
792	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1175	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
793	0, $self->{len}	1176	0, $self->{len}
794	}	1177	}
795		1178
796	sub urxvt::line::r {	1179	sub urxvt::line::r {
797	my ($self) = @_;	1180	my ($self) = @_;
798		1181
		1182	if (@_ > 1)
		1183	{
		1184	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1185	for $self->{beg} .. $self->{end};
		1186	}
		1187
		1188	if (defined wantarray) {
799	my $rend = [	1189	my $rend = [
800	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1190	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
801	];	1191	];
802	$#$rend = $self->{len} - 1;	1192	$#$rend = $self->{len} - 1;
803	$rend	1193	return $rend;
		1194	}
		1195
		1196	()
804	}	1197	}
805		1198
806	sub urxvt::line::beg { $_[0]{beg} }	1199	sub urxvt::line::beg { $_[0]{beg} }
807	sub urxvt::line::end { $_[0]{end} }	1200	sub urxvt::line::end { $_[0]{end} }
808	sub urxvt::line::l { $_[0]{len} }	1201	sub urxvt::line::l { $_[0]{len} }
809		1202
810	sub urxvt::line::offset_of {	1203	sub urxvt::line::offset_of {
811	my ($self, $row, $col) = @_;	1204	my ($self, $row, $col) = @_;
812		1205
813	($row - $self->{beg}) * $self->{term}->ncol + $col	1206	($row - $self->{beg}) * $self->{ncol} + $col
814	}	1207	}
815		1208
816	sub urxvt::line::coord_of {	1209	sub urxvt::line::coord_of {
817	my ($self, $offset) = @_;	1210	my ($self, $offset) = @_;
818		1211
819	use integer;	1212	use integer;
820		1213
821	(	1214	(
822	$offset / $self->{term}->ncol + $self->{beg},	1215	$offset / $self->{ncol} + $self->{beg},
823	$offset % $self->{term}->ncol	1216	$offset % $self->{ncol}
824	)	1217	)
825	}	1218	}
826		1219
827	=item ($row, $col) = $line->coord_of ($offset)
828	=item $text = $term->special_encode $string	1220	=item $text = $term->special_encode $string
829		1221
830	Converts a perl string into the special encoding used by rxvt-unicode,	1222	Converts a perl string into the special encoding used by rxvt-unicode,
831	where one character corresponds to one screen cell. See	1223	where one character corresponds to one screen cell. See
832	C<< $term->ROW_t >> for details.	1224	C<< $term->ROW_t >> for details.
…		…
834	=item $string = $term->special_decode $text	1226	=item $string = $term->special_decode $text
835		1227
836	Converts rxvt-unicodes text reprsentation into a perl string. See	1228	Converts rxvt-unicodes text reprsentation into a perl string. See
837	C<< $term->ROW_t >> for details.	1229	C<< $term->ROW_t >> for details.
838		1230
		1231	=item $success = $term->grab_button ($button, $modifiermask)
		1232
		1233	Registers a synchronous button grab. See the XGrabButton manpage.
		1234
		1235	=item $success = $term->grab ($eventtime[, $sync])
		1236
		1237	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1238	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1239
		1240	=item $term->allow_events_async
		1241
		1242	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1243
		1244	=item $term->allow_events_sync
		1245
		1246	Calls XAllowEvents with SyncBoth for the most recent grab.
		1247
		1248	=item $term->allow_events_replay
		1249
		1250	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1251	recent grab.
		1252
		1253	=item $term->ungrab
		1254
		1255	Calls XUngrab for the most recent grab. Is called automatically on
		1256	evaluation errors, as it is better to lose the grab in the error case as
		1257	the session.
		1258
839	=back	1259	=back
		1260
		1261	=cut
		1262
		1263	package urxvt::popup;
		1264
		1265	=head2 The C<urxvt::popup> Class
		1266
		1267	=over 4
		1268
		1269	=cut
		1270
		1271	sub add_item {
		1272	my ($self, $item) = @_;
		1273
		1274	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1275	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1276	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1277
		1278	$item->{render} \|\|= sub { $_[0]{text} };
		1279
		1280	push @{ $self->{item} }, $item;
		1281	}
		1282
		1283	sub add_separator {
		1284	my ($self, $sep) = @_;
		1285
		1286	$sep \|\|= "=";
		1287
		1288	$self->add_item ({
		1289	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1290	text => "",
		1291	render => sub { $sep x $self->{term}->ncol },
		1292	activate => sub { },
		1293	});
		1294	}
		1295
		1296	sub add_title {
		1297	my ($self, $title) = @_;
		1298
		1299	$self->add_item ({
		1300	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1301	text => $title,
		1302	activate => sub { },
		1303	});
		1304	}
		1305
		1306	sub add_button {
		1307	my ($self, $text, $cb) = @_;
		1308
		1309	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1310	}
		1311
		1312	sub add_toggle {
		1313	my ($self, $text, $cb, $value) = @_;
		1314
		1315	my $item; $item = {
		1316	type => "button",
		1317	text => " $text",
		1318	value => $value,
		1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1321	};
		1322
		1323	$self->add_item ($item);
		1324	}
		1325
		1326	sub show {
		1327	my ($self) = @_;
		1328
		1329	local $urxvt::popup::self = $self;
		1330
		1331	local $ENV{LC_ALL} = $self->{term}->locale;
		1332
		1333	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1334	"--transient-for" => $self->{term}->parent,
		1335	"-display" => $self->{term}->display_id,
		1336	"-pe" => "urxvt-popup")
		1337	or die "unable to create popup window\n";
		1338	}
		1339
		1340	sub DESTROY {
		1341	my ($self) = @_;
		1342
		1343	delete $self->{term}{_destroy}{$self};
		1344	$self->{term}->ungrab;
		1345	}
840		1346
841	=head2 The C<urxvt::timer> Class	1347	=head2 The C<urxvt::timer> Class
842		1348
843	This class implements timer watchers/events. Time is represented as a	1349	This class implements timer watchers/events. Time is represented as a
844	fractional number of seconds since the epoch. Example:	1350	fractional number of seconds since the epoch. Example:
…		…
897		1403
898	$term->{socket} = ...	1404	$term->{socket} = ...
899	$term->{iow} = urxvt::iow	1405	$term->{iow} = urxvt::iow
900	->new	1406	->new
901	->fd (fileno $term->{socket})	1407	->fd (fileno $term->{socket})
902	->events (1) # wait for read data	1408	->events (urxvt::EVENT_READ)
903	->start	1409	->start
904	->cb (sub {	1410	->cb (sub {
905	my ($iow, $revents) = @_;	1411	my ($iow, $revents) = @_;
906	# $revents must be 1 here, no need to check	1412	# $revents must be 1 here, no need to check
907	sysread $term->{socket}, my $buf, 8192	1413	sysread $term->{socket}, my $buf, 8192
…		…
924		1430
925	Set the filedescriptor (not handle) to watch.	1431	Set the filedescriptor (not handle) to watch.
926		1432
927	=item $iow = $iow->events ($eventmask)	1433	=item $iow = $iow->events ($eventmask)
928		1434
929	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1435	Set the event mask to watch. The only allowed values are
930	data, Bit #1 (value C<2>) enables watching for write data.	1436	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1437	together, or C<urxvt::EVENT_NONE>.
931		1438
932	=item $iow = $iow->start	1439	=item $iow = $iow->start
933		1440
934	Start watching for requested events on the given handle.	1441	Start watching for requested events on the given handle.
935		1442
…		…
946	This variable controls the verbosity level of the perl extension. Higher	1453	This variable controls the verbosity level of the perl extension. Higher
947	numbers indicate more verbose output.	1454	numbers indicate more verbose output.
948		1455
949	=over 4	1456	=over 4
950		1457
951	=item =0 - only fatal messages	1458	=item == 0 - fatal messages
952		1459
953	=item =3 - script loading and management	1460	=item >= 3 - script loading and management
954		1461
955	=item =10 - all events received	1462	=item >=10 - all events received
956		1463
957	=back	1464	=back
958		1465
959	=head1 AUTHOR	1466	=head1 AUTHOR
960		1467

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC vs. Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC vs.
Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC