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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.34 by root, Fri Jan 6 01:16:58 2006 UTC vs.
Revision 1.76 by root, Tue Jan 10 19:46:28 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.
		86
		87	=item mark-urls
		88
		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.
64		96
65	=item example-refresh-hooks	97	=item example-refresh-hooks
66		98
67	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
68	window. Illustrates overwriting the refresh callbacks to create your own	100	window. Illustrates overwriting the refresh callbacks to create your own
69	overlays or changes.	101	overlays or changes.
70		102
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
78	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
79		106
80	=head2 General API Considerations	107	=head2 General API Considerations
81		108
82	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
83	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
…		…
111	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
112	locale-specific way.	139	locale-specific way.
113		140
114	=back	141	=back
115		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
116	=head2 Hooks	176	=head2 Hooks
117		177
118	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
119	called whenever the relevant event happens.	179	called whenever the relevant event happens.
120		180
121	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
122	and extension package. You can call all C<urxvt::term> methods on it, but	182	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		183
127	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
128	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
129	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.
130		187
131	When in doubt, return a false value (preferably C<()>).	188	I<< When in doubt, return a false value (preferably C<()>). >>
132		189
133	=over 4	190	=over 4
134		191
135	=item on_init $term	192	=item on_init $term
136		193
137	Called after a new terminal object has been initialized, but before	194	Called after a new terminal object has been initialized, but before
138	windows are created or the command gets run.	195	windows are created or the command gets run. Most methods are unsafe to
		196	call or deliver senseless data, as terminal size and other characteristics
		197	have not yet been determined. You can safely query and change resources,
		198	though.
139		199
140	=item on_reset $term	200	=item on_reset $term
141		201
142	Called after the screen is "reset" for any reason, such as resizing or	202	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	203	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	232	should extend the selection itelf and return true to suppress the built-in
173	processing.	233	processing.
174		234
175	See the F<selection> example extension.	235	See the F<selection> example extension.
176		236
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	237	=item on_view_change $term, $offset
188		238
189	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
190	scrolls. Offset C<0> means display the normal terminal, positive values	240	scrolls. Offset C<0> means display the normal terminal, positive values
191	show this many lines of scrollback.	241	show this many lines of scrollback.
…		…
197	than the scroll back buffer or the terminal.	247	than the scroll back buffer or the terminal.
198		248
199	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,
200	$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
201	number of lines that will be in the scrollback buffer.	251	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		252
207	=item on_osc_seq $term, $string	253	=item on_osc_seq $term, $string
208		254
209	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
210	operating system command) is processed. Cursor position and other state	256	operating system command) is processed. Cursor position and other state
…		…
223	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
224	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
225	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
226	output.	272	output.
227		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
		279	=item on_line_update $term, $row
		280
		281	Called whenever a line was updated or changed. Can be used to filter
		282	screen output (e.g. underline urls or other useless stuff). Only lines
		283	that are being shown will be filtered, and, due to performance reasons,
		284	not always immediately.
		285
		286	The row number is always the topmost row of the line if the line spans
		287	multiple rows.
		288
		289	Please note that, if you change the line, then the hook might get called
		290	later with the already-modified line (e.g. if unrelated parts change), so
		291	you cannot just toggle rendition bits, but only set them.
		292
228	=item on_refresh_begin $term	293	=item on_refresh_begin $term
229		294
230	Called just before the screen gets redrawn. Can be used for overlay	295	Called just before the screen gets redrawn. Can be used for overlay
231	or similar effects by modify terminal contents in refresh_begin, and	296	or similar effects by modify terminal contents in refresh_begin, and
232	restoring them in refresh_end. The built-in overlay and selection display	297	restoring them in refresh_end. The built-in overlay and selection display
…		…
240		305
241	Called whenever the user presses a key combination that has a	306	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>	307	C<perl:string> action bound to it (see description of the B<keysym>
243	resource in the @@RXVT_NAME@@(1) manpage).	308	resource in the @@RXVT_NAME@@(1) manpage).
244		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
		320	=item on_key_press $term, $event, $keysym, $octets
		321
		322	=item on_key_release $term, $event, $keysym
		323
		324	=item on_button_press $term, $event
		325
		326	=item on_button_release $term, $event
		327
		328	=item on_motion_notify $term, $event
		329
		330	=item on_map_notify $term, $event
		331
		332	=item on_unmap_notify $term, $event
		333
		334	Called whenever the corresponding X event is received for the terminal If
		335	the hook returns true, then the even will be ignored by rxvt-unicode.
		336
		337	The event is a hash with most values as named by Xlib (see the XEvent
		338	manpage), with the additional members C<row> and C<col>, which are the row
		339	and column under the mouse cursor.
		340
		341	C<on_key_press> additionally receives the string rxvt-unicode would
		342	output, if any, in locale-specific encoding.
		343
		344	subwindow.
		345
245	=back	346	=back
246		347
247	=head2 Variables in the C<urxvt> Package	348	=head2 Variables in the C<urxvt> Package
248		349
249	=over 4	350	=over 4
250		351
		352	=item $urxvt::LIBDIR
		353
		354	The rxvt-unicode library directory, where, among other things, the perl
		355	modules and scripts are stored.
		356
		357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		358
		359	The resource class and name rxvt-unicode uses to look up X resources.
		360
		361	=item $urxvt::RXVTNAME
		362
		363	The basename of the installed binaries, usually C<urxvt>.
		364
251	=item $urxvt::TERM	365	=item $urxvt::TERM
252		366
253	The current terminal. Whenever a callback/Hook is bein executed, this	367	The current terminal. This variable stores the current C<urxvt::term>
254	variable stores the current C<urxvt::term> object.	368	object, whenever a callback/hook is executing.
		369
		370	=item
255		371
256	=back	372	=back
257		373
258	=head2 Functions in the C<urxvt> Package	374	=head2 Functions in the C<urxvt> Package
259		375
260	=over 4	376	=over 4
		377
		378	=item $term = new urxvt [arg...]
		379
		380	Creates a new terminal, very similar as if you had started it with
		381	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		382	if the new instance couldn't be created. Returns C<undef> if the new
		383	instance didn't initialise perl, and the terminal object otherwise. The
		384	C<init> and C<start> hooks will be called during the call.
261		385
262	=item urxvt::fatal $errormessage	386	=item urxvt::fatal $errormessage
263		387
264	Fatally aborts execution with the given error message. Avoid at all	388	Fatally aborts execution with the given error message. Avoid at all
265	costs! The only time this is acceptable is when the terminal process	389	costs! The only time this is acceptable is when the terminal process
…		…
272	that calls this function.	396	that calls this function.
273		397
274	Using this function has the advantage that its output ends up in the	398	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.	399	correct place, e.g. on stderr of the connecting urxvtc client.
276		400
		401	=item $is_safe = urxvt::safe
		402
		403	Returns true when it is safe to do potentially unsafe things, such as
		404	evaluating perl code specified by the user. This is true when urxvt was
		405	started setuid or setgid.
		406
277	=item $time = urxvt::NOW	407	=item $time = urxvt::NOW
278		408
279	Returns the "current time" (as per the event loop).	409	Returns the "current time" (as per the event loop).
		410
		411	=item urxvt::CurrentTime
		412
		413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		415	Button4Mask, Button5Mask, AnyModifier
		416
		417	Various constants for use in X calls and event processing.
280		418
281	=back	419	=back
282		420
283	=head2 RENDITION	421	=head2 RENDITION
284		422
…		…
311		449
312	=item $background = urxvt::GET_BASEBG $rend	450	=item $background = urxvt::GET_BASEBG $rend
313		451
314	Return the foreground/background colour index, respectively.	452	Return the foreground/background colour index, respectively.
315		453
316	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
317		455
318	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
319		457
320	Replace the foreground/background colour in the rendition mask with the	458	Replace the foreground/background colour in the rendition mask with the
321	specified one.	459	specified one.
322		460
323	=item $value = urxvt::GET_CUSTOM ($rend)	461	=item $value = urxvt::GET_CUSTOM $rend
324		462
325	Return the "custom" value: Every rendition has 5 bits for use by	463	Return the "custom" value: Every rendition has 5 bits for use by
326	extensions. They can be set and changed as you like and are initially	464	extensions. They can be set and changed as you like and are initially
327	zero.	465	zero.
328		466
329	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
330		468
331	Change the custom value.	469	Change the custom value.
332		470
333	=back	471	=back
334		472
335	=cut	473	=cut
336		474
337	package urxvt;	475	package urxvt;
338		476
		477	use utf8;
339	use strict;	478	use strict;
		479	use Carp ();
340	use Scalar::Util ();	480	use Scalar::Util ();
		481	use List::Util ();
341		482
		483	our $VERSION = 1;
342	our $TERM;	484	our $TERM;
343	our @HOOKNAME;	485	our @HOOKNAME;
		486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		487	our %OPTION;
		488
344	our $LIBDIR;	489	our $LIBDIR;
		490	our $RESNAME;
		491	our $RESCLASS;
		492	our $RXVTNAME;
345		493
346	BEGIN {	494	BEGIN {
347	urxvt->bootstrap;	495	urxvt->bootstrap;
348		496
349	# overwrite perl's warn	497	# overwrite perl's warn
…		…
351	my $msg = join "", @_;	499	my $msg = join "", @_;
352	$msg .= "\n"	500	$msg .= "\n"
353	unless $msg =~ /\n$/;	501	unless $msg =~ /\n$/;
354	urxvt::warn ($msg);	502	urxvt::warn ($msg);
355	};	503	};
		504
		505	delete $ENV{IFS};
		506	delete $ENV{CDPATH};
		507	delete $ENV{BASH_ENV};
		508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
356	}	509	}
357		510
358	my @hook_count;	511	my @hook_count;
359	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
360		513
361	sub verbose {	514	sub verbose {
362	my ($level, $msg) = @_;	515	my ($level, $msg) = @_;
363	warn "$msg\n" if $level <= $verbosity;	516	warn "$msg\n" if $level <= $verbosity;
364	}	517	}
365		518
366	# find on_xxx subs in the package and register them	519	my $extension_pkg = "extension0000";
367	# as hooks	520	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		521
386	# load a single script into its own package, once only	522	# load a single script into its own package, once only
387	sub script_package($) {	523	sub extension_package($) {
388	my ($path) = @_;	524	my ($path) = @_;
389		525
390	$script_pkg{$path} \|\|= do {	526	$extension_pkg{$path} \|\|= do {
391	my $pkg = "urxvt::" . ($script_pkg++);	527	my $pkg = "urxvt::" . ($extension_pkg++);
392		528
393	verbose 3, "loading script '$path' into package '$pkg'";	529	verbose 3, "loading extension '$path' into package '$pkg'";
394		530
395	open my $fh, "<:raw", $path	531	open my $fh, "<:raw", $path
396	or die "$path: $!";	532	or die "$path: $!";
397		533
		534	my $source = untaint
398	my $source = "package $pkg; use strict; use utf8;\n"	535	"package $pkg; use strict; use utf8;\n"
		536	. "use base urxvt::term::extension::;\n"
399	. "#line 1 \"$path\"\n{\n"	537	. "#line 1 \"$path\"\n{\n"
400	. (do { local $/; <$fh> })	538	. (do { local $/; <$fh> })
401	. "\n};\n1";	539	. "\n};\n1";
402		540
		541	eval $source
403	eval $source or die "$path: $@";	542	or die "$path: $@";
404		543
405	$pkg	544	$pkg
406	}	545	}
407	}	546	}
408		547
…		…
413	local $TERM = shift;	552	local $TERM = shift;
414	my $htype = shift;	553	my $htype = shift;
415		554
416	if ($htype == 0) { # INIT	555	if ($htype == 0) { # INIT
417	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		557
		558	my %ext_arg;
418		559
419	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		561	if ($_ eq "default") {
		562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		563	} elsif (/^-(.*)$/) {
		564	delete $ext_arg{$1};
		565	} elsif (/^([^<]+)<(.*)>$/) {
		566	push @{ $ext_arg{$1} }, $2;
		567	} else {
		568	$ext_arg{$_} \|\|= [];
		569	}
		570	}
		571
		572	while (my ($ext, $argv) = each %ext_arg) {
420	my @files = grep -f $_, map "$_/$ext", @dirs;	573	my @files = grep -f $_, map "$_/$ext", @dirs;
421		574
422	if (@files) {	575	if (@files) {
423	register_package script_package $files[0];	576	$TERM->register_package (extension_package $files[0], $argv);
424	} else {	577	} else {
425	warn "perl extension '$ext' not found in perl library search path\n";	578	warn "perl extension '$ext' not found in perl library search path\n";
426	}	579	}
427	}	580	}
		581
		582	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		583	warn $@ if $@;
428	}	584	}
429		585
430	$retval = undef;	586	$retval = undef;
431		587
432	if (my $cb = $TERM->{_hook}[$htype]) {	588	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
434	if $verbosity >= 10;	590	if $verbosity >= 10;
435		591
436	keys %$cb;	592	keys %$cb;
437		593
438	while (my ($pkg, $cb) = each %$cb) {	594	while (my ($pkg, $cb) = each %$cb) {
439	$retval = $cb->(	595	$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;	596	and last;
		597
		598	if ($@) {
		599	$TERM->ungrab; # better to lose the grab than the session
		600	warn $@;
		601	}
447	}	602	}
448	}	603	}
449		604
450	if ($htype == 1) { # DESTROY	605	if ($htype == 1) { # DESTROY
451	# remove hooks if unused
452	if (my $hook = $TERM->{_hook}) {	606	if (my $hook = delete $TERM->{_hook}) {
453	for my $htype (0..$#$hook) {	607	for my $htype (0..$#$hook) {
454	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
455	or set_should_invoke $htype, 0;	609	or set_should_invoke $htype, 0;
456	}	610	}
457	}	611	}
…		…
464	}	618	}
465		619
466	$retval	620	$retval
467	}	621	}
468		622
469	sub urxvt::term::proxy::AUTOLOAD {	623	# urxvt::term::extension
470	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	624
		625	package urxvt::term::extension;
		626
		627	sub enable {
		628	my ($self, %hook) = @_;
		629	my $pkg = $self->{_pkg};
		630
		631	while (my ($name, $cb) = each %hook) {
		632	my $htype = $HOOKTYPE{uc $name};
		633	defined $htype
		634	or Carp::croak "unsupported hook type '$name'";
		635
		636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		637	$hook_count[$htype]++
		638	or urxvt::set_should_invoke $htype, 1;
		639	}
		640
		641	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		642	}
		643	}
		644
		645	sub disable {
		646	my ($self, @hook) = @_;
		647	my $pkg = $self->{_pkg};
		648
		649	for my $name (@hook) {
		650	my $htype = $HOOKTYPE{uc $name};
		651	defined $htype
		652	or Carp::croak "unsupported hook type '$name'";
		653
		654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		655	--$hook_count[$htype]
		656	or urxvt::set_should_invoke $htype, 0;
		657	}
		658	}
		659	}
		660
		661	our $AUTOLOAD;
		662
		663	sub AUTOLOAD {
		664	$AUTOLOAD =~ /:([^:]+)$/
471	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	665	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
472		666
473	eval qq{	667	eval qq{
474	sub $urxvt::term::proxy::AUTOLOAD {	668	sub $AUTOLOAD {
475	my \$proxy = shift;	669	my \$proxy = shift;
476	\$proxy->{term}->$1 (\@_)	670	\$proxy->{term}->$1 (\@_)
477	}	671	}
478	1	672	1
479	} or die "FATAL: unable to compile method forwarder: $@";	673	} or die "FATAL: unable to compile method forwarder: $@";
480		674
481	goto &$urxvt::term::proxy::AUTOLOAD;	675	goto &$AUTOLOAD;
482	}	676	}
		677
		678	sub DESTROY {
		679	# nop
		680	}
		681
		682	# urxvt::destroy_hook
		683
		684	sub urxvt::destroy_hook::DESTROY {
		685	${$_[0]}->();
		686	}
		687
		688	sub urxvt::destroy_hook(&) {
		689	bless \shift, urxvt::destroy_hook::
		690	}
		691
		692	package urxvt::anyevent;
		693
		694	=head2 The C<urxvt::anyevent> Class
		695
		696	The sole purpose of this class is to deliver an interface to the
		697	C<AnyEvent> module - any module using it will work inside urxvt without
		698	further programming. The only exception is that you cannot wait on
		699	condition variables, but non-blocking condvar use is ok. What this means
		700	is that you cannot use blocking APIs, but the non-blocking variant should
		701	work.
		702
		703	=cut
		704
		705	our $VERSION = 1;
		706
		707	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		708	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		709
		710	sub timer {
		711	my ($class, %arg) = @_;
		712
		713	my $cb = $arg{cb};
		714
		715	urxvt::timer
		716	->new
		717	->start (urxvt::NOW + $arg{after})
		718	->cb (sub {
		719	$_[0]->stop; # need to cancel manually
		720	$cb->();
		721	})
		722	}
		723
		724	sub io {
		725	my ($class, %arg) = @_;
		726
		727	my $cb = $arg{cb};
		728
		729	bless [$arg{fh}, urxvt::iow
		730	->new
		731	->fd (fileno $arg{fh})
		732	->events (($arg{poll} =~ /r/ ? 1 : 0)
		733	\| ($arg{poll} =~ /w/ ? 2 : 0))
		734	->start
		735	->cb (sub {
		736	$cb->(($_[1] & 1 ? 'r' : '')
		737	. ($_[1] & 2 ? 'w' : ''));
		738	})],
		739	urxvt::anyevent::
		740	}
		741
		742	sub DESTROY {
		743	$_[0][1]->stop;
		744	}
		745
		746	sub condvar {
		747	bless \my $flag, urxvt::anyevent::condvar::
		748	}
		749
		750	sub urxvt::anyevent::condvar::broadcast {
		751	${$_[0]}++;
		752	}
		753
		754	sub urxvt::anyevent::condvar::wait {
		755	unless (${$_[0]}) {
		756	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		757	}
		758	}
		759
		760	package urxvt::term;
483		761
484	=head2 The C<urxvt::term> Class	762	=head2 The C<urxvt::term> Class
485		763
486	=over 4	764	=over 4
		765
		766	=cut
		767
		768	# find on_xxx subs in the package and register them
		769	# as hooks
		770	sub register_package {
		771	my ($self, $pkg, $argv) = @_;
		772
		773	my $proxy = bless {
		774	_pkg => $pkg,
		775	argv => $argv,
		776	}, $pkg;
		777	Scalar::Util::weaken ($proxy->{term} = $self);
		778
		779	$self->{_pkg}{$pkg} = $proxy;
		780
		781	for my $name (@HOOKNAME) {
		782	if (my $ref = $pkg->can ("on_" . lc $name)) {
		783	$proxy->enable ($name => $ref);
		784	}
		785	}
		786	}
		787
		788	=item $term->destroy
		789
		790	Destroy the terminal object (close the window, free resources
		791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		792	watchers (timers, io watchers) are still active.
		793
		794	=item $isset = $term->option ($optval[, $set])
		795
		796	Returns true if the option specified by C<$optval> is enabled, and
		797	optionally change it. All option values are stored by name in the hash
		798	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		799
		800	Here is a a likely non-exhaustive list of option names, please see the
		801	source file F</src/optinc.h> to see the actual list:
		802
		803	borderLess console cursorBlink cursorUnderline hold iconic insecure
		804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		808	tripleclickwords utmpInhibit visualBell
487		809
488	=item $value = $term->resource ($name[, $newval])	810	=item $value = $term->resource ($name[, $newval])
489		811
490	Returns the current resource value associated with a given name and	812	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>	813	optionally sets a new value. Setting values is most useful in the C<init>
…		…
501		823
502	Please note that resource strings will currently only be freed when the	824	Please note that resource strings will currently only be freed when the
503	terminal is destroyed, so changing options frequently will eat memory.	825	terminal is destroyed, so changing options frequently will eat memory.
504		826
505	Here is a a likely non-exhaustive list of resource names, not all of which	827	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	828	are supported in every build, please see the source file F</src/rsinc.h>
507	list:	829	to see the actual list:
508		830
509	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
510	borderLess color cursorBlink cursorUnderline cutchars delete_key	832	borderLess color cursorBlink cursorUnderline cutchars delete_key
511	display_name embed ext_bwidth fade font geometry hold iconName	833	display_name embed ext_bwidth fade font geometry hold iconName
512	imFont imLocale inputMethod insecure int_bwidth intensityStyles	834	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
519	shade term_name title transparent transparent_all tripleclickwords	841	shade term_name title transparent transparent_all tripleclickwords
520	utmpInhibit visualBell	842	utmpInhibit visualBell
521		843
522	=cut	844	=cut
523		845
524	sub urxvt::term::resource($$;$) {	846	sub resource($$;$) {
525	my ($self, $name) = (shift, shift);	847	my ($self, $name) = (shift, shift);
526	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
527	goto &urxvt::term::_resource;	849	&urxvt::term::_resource
528	}	850	}
		851
		852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		853
		854	Adds a keymap translation exactly as specified via a resource. See the
		855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
529		856
530	=item $rend = $term->rstyle ([$new_rstyle])	857	=item $rend = $term->rstyle ([$new_rstyle])
531		858
532	Return and optionally change the current rendition. Text that is output by	859	Return and optionally change the current rendition. Text that is output by
533	the terminal application will use this style.	860	the terminal application will use this style.
…		…
553		880
554	=item $oldtext = $term->selection ([$newtext])	881	=item $oldtext = $term->selection ([$newtext])
555		882
556	Return the current selection text and optionally replace it by C<$newtext>.	883	Return the current selection text and optionally replace it by C<$newtext>.
557		884
558	#=item $term->overlay ($x, $y, $text)	885	=item $term->overlay_simple ($x, $y, $text)
559	#	886
560	#Create a simple multi-line overlay box. See the next method for details.	887	Create a simple multi-line overlay box. See the next method for details.
561	#	888
562	#=cut	889	=cut
563	#	890
564	#sub urxvt::term::scr_overlay {	891	sub overlay_simple {
565	# my ($self, $x, $y, $text) = @_;	892	my ($self, $x, $y, $text) = @_;
566	#	893
567	# my @lines = split /\n/, $text;	894	my @lines = split /\n/, $text;
568	#	895
569	# my $w = 0;	896	my $w = List::Util::max map $self->strwidth ($_), @lines;
570	# for (map $self->strwidth ($_), @lines) {	897
571	# $w = $_ if $w < $_;
572	# }
573	#
574	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	898	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
575	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	899	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
576	#}	900
		901	$overlay
		902	}
577		903
578	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	904	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
579		905
580	Create a new (empty) overlay at the given position with the given	906	Create a new (empty) overlay at the given position with the given
581	width/height. C<$rstyle> defines the initial rendition style	907	width/height. C<$rstyle> defines the initial rendition style
…		…
608		934
609	If hidden, display the overlay again.	935	If hidden, display the overlay again.
610		936
611	=back	937	=back
612		938
		939	=item $popup = $term->popup ($event)
		940
		941	Creates a new C<urxvt::popup> object that implements a popup menu. The
		942	C<$event> I<must> be the event causing the menu to pop up (a button event,
		943	currently).
		944
		945	=cut
		946
		947	sub popup {
		948	my ($self, $event) = @_;
		949
		950	$self->grab ($event->{time}, 1)
		951	or return;
		952
		953	my $popup = bless {
		954	term => $self,
		955	event => $event,
		956	}, urxvt::popup::;
		957
		958	Scalar::Util::weaken $popup->{term};
		959
		960	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		961	Scalar::Util::weaken $self->{_destroy}{$popup};
		962
		963	$popup
		964	}
		965
613	=item $cellwidth = $term->strwidth $string	966	=item $cellwidth = $term->strwidth ($string)
614		967
615	Returns the number of screen-cells this string would need. Correctly	968	Returns the number of screen-cells this string would need. Correctly
616	accounts for wide and combining characters.	969	accounts for wide and combining characters.
617		970
618	=item $octets = $term->locale_encode $string	971	=item $octets = $term->locale_encode ($string)
619		972
620	Convert the given text string into the corresponding locale encoding.	973	Convert the given text string into the corresponding locale encoding.
621		974
622	=item $string = $term->locale_decode $octets	975	=item $string = $term->locale_decode ($octets)
623		976
624	Convert the given locale-encoded octets into a perl string.	977	Convert the given locale-encoded octets into a perl string.
		978
		979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		980
		981	XORs the rendition values in the given span with the provided value
		982	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		983	to the selection.
		984
		985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		986
		987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		988	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		989	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		990	it instead.
		991
		992	=item $term->scr_bell
		993
		994	Ring the bell!
625		995
626	=item $term->scr_add_lines ($string)	996	=item $term->scr_add_lines ($string)
627		997
628	Write the given text string to the screen, as if output by the application	998	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	999	running inside the terminal. It may not contain command sequences (escape
…		…
632		1002
633	Normally its not a good idea to use this function, as programs might be	1003	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	1004	confused by changes in cursor position or scrolling. Its useful inside a
635	C<on_add_lines> hook, though.	1005	C<on_add_lines> hook, though.
636		1006
		1007	=item $term->cmd_parse ($octets)
		1008
		1009	Similar to C<scr_add_lines>, but the argument must be in the
		1010	locale-specific encoding of the terminal and can contain command sequences
		1011	(escape codes) that will be interpreted.
		1012
637	=item $term->tt_write ($octets)	1013	=item $term->tt_write ($octets)
638		1014
639	Write the octets given in C<$data> to the tty (i.e. as program input). To	1015	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	1016	pass characters instead of octets, you should convert your strings first
641	to the locale-specific encoding using C<< $term->locale_encode >>.	1017	to the locale-specific encoding using C<< $term->locale_encode >>.
642		1018
		1019	=item $old_events = $term->pty_ev_events ([$new_events])
		1020
		1021	Replaces the event mask of the pty watcher by the given event mask. Can
		1022	be used to suppress input and output handling to the pty/tty. See the
		1023	description of C<< urxvt::timer->events >>. Make sure to always restore
		1024	the previous value.
		1025
		1026	=item $windowid = $term->parent
		1027
		1028	Return the window id of the toplevel window.
		1029
		1030	=item $windowid = $term->vt
		1031
		1032	Return the window id of the terminal window.
		1033
643	=item $window_width = $term->width	1034	=item $window_width = $term->width
644		1035
645	=item $window_height = $term->height	1036	=item $window_height = $term->height
646		1037
647	=item $font_width = $term->fwidth	1038	=item $font_width = $term->fwidth
…		…
663	=item $nrow_plus_saveLines = $term->total_rows	1054	=item $nrow_plus_saveLines = $term->total_rows
664		1055
665	=item $lines_in_scrollback = $term->nsaved	1056	=item $lines_in_scrollback = $term->nsaved
666		1057
667	Return various integers describing terminal characteristics.	1058	Return various integers describing terminal characteristics.
		1059
		1060	=item $lc_ctype = $term->locale
		1061
		1062	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1063
		1064	=item $x_display = $term->display_id
		1065
		1066	Return the DISPLAY used by rxvt-unicode.
		1067
		1068	=item $modifiermask = $term->ModLevel3Mask
		1069
		1070	=item $modifiermask = $term->ModMetaMask
		1071
		1072	=item $modifiermask = $term->ModNumLockMask
		1073
		1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1075	AltGr), the meta key (often Alt) and the num lock key, if applicable.
668		1076
669	=item $view_start = $term->view_start ([$newvalue])	1077	=item $view_start = $term->view_start ([$newvalue])
670		1078
671	Returns the negative row number of the topmost line. Minimum value is	1079	Returns the negative row number of the topmost line. Minimum value is
672	C<0>, which displays the normal terminal contents. Larger values scroll	1080	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	1143	about the logical line that row C<$row_number> is part of. It supports the
736	following methods:	1144	following methods:
737		1145
738	=over 4	1146	=over 4
739		1147
740	=item $text = $line->t	1148	=item $text = $line->t ([$new_text])
741		1149
742	Returns the full text of the line, similar to C<ROW_t>	1150	Returns or replaces the full text of the line, similar to C<ROW_t>
743		1151
744	=item $rend = $line->r	1152	=item $rend = $line->r ([$new_rend])
745		1153
746	Returns the full rendition array of the line, similar to C<ROW_r>	1154	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
747		1155
748	=item $length = $line->l	1156	=item $length = $line->l
749		1157
750	Returns the length of the line in cells, similar to C<ROW_l>.	1158	Returns the length of the line in cells, similar to C<ROW_l>.
751		1159
…		…
766		1174
767	=back	1175	=back
768		1176
769	=cut	1177	=cut
770		1178
771	sub urxvt::term::line {	1179	sub line {
772	my ($self, $row) = @_;	1180	my ($self, $row) = @_;
773		1181
774	my $maxrow = $self->nrow - 1;	1182	my $maxrow = $self->nrow - 1;
775		1183
776	my ($beg, $end) = ($row, $row);	1184	my ($beg, $end) = ($row, $row);
…		…
840	$offset / $self->{ncol} + $self->{beg},	1248	$offset / $self->{ncol} + $self->{beg},
841	$offset % $self->{ncol}	1249	$offset % $self->{ncol}
842	)	1250	)
843	}	1251	}
844		1252
845	=item ($row, $col) = $line->coord_of ($offset)
846	=item $text = $term->special_encode $string	1253	=item $text = $term->special_encode $string
847		1254
848	Converts a perl string into the special encoding used by rxvt-unicode,	1255	Converts a perl string into the special encoding used by rxvt-unicode,
849	where one character corresponds to one screen cell. See	1256	where one character corresponds to one screen cell. See
850	C<< $term->ROW_t >> for details.	1257	C<< $term->ROW_t >> for details.
…		…
852	=item $string = $term->special_decode $text	1259	=item $string = $term->special_decode $text
853		1260
854	Converts rxvt-unicodes text reprsentation into a perl string. See	1261	Converts rxvt-unicodes text reprsentation into a perl string. See
855	C<< $term->ROW_t >> for details.	1262	C<< $term->ROW_t >> for details.
856		1263
		1264	=item $success = $term->grab_button ($button, $modifiermask)
		1265
		1266	Registers a synchronous button grab. See the XGrabButton manpage.
		1267
		1268	=item $success = $term->grab ($eventtime[, $sync])
		1269
		1270	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1271	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1272
		1273	=item $term->allow_events_async
		1274
		1275	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1276
		1277	=item $term->allow_events_sync
		1278
		1279	Calls XAllowEvents with SyncBoth for the most recent grab.
		1280
		1281	=item $term->allow_events_replay
		1282
		1283	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1284	recent grab.
		1285
		1286	=item $term->ungrab
		1287
		1288	Calls XUngrab for the most recent grab. Is called automatically on
		1289	evaluation errors, as it is better to lose the grab in the error case as
		1290	the session.
		1291
857	=back	1292	=back
		1293
		1294	=cut
		1295
		1296	package urxvt::popup;
		1297
		1298	=head2 The C<urxvt::popup> Class
		1299
		1300	=over 4
		1301
		1302	=cut
		1303
		1304	sub add_item {
		1305	my ($self, $item) = @_;
		1306
		1307	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1308	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1309	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1310
		1311	$item->{render} \|\|= sub { $_[0]{text} };
		1312
		1313	push @{ $self->{item} }, $item;
		1314	}
		1315
		1316	=item $popup->add_title ($title)
		1317
		1318	Adds a non-clickable title to the popup.
		1319
		1320	=cut
		1321
		1322	sub add_title {
		1323	my ($self, $title) = @_;
		1324
		1325	$self->add_item ({
		1326	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1327	text => $title,
		1328	activate => sub { },
		1329	});
		1330	}
		1331
		1332	=item $popup->add_separator ([$sepchr])
		1333
		1334	Creates a separator, optionally using the character given as C<$sepchr>.
		1335
		1336	=cut
		1337
		1338	sub add_separator {
		1339	my ($self, $sep) = @_;
		1340
		1341	$sep \|\|= "=";
		1342
		1343	$self->add_item ({
		1344	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1345	text => "",
		1346	render => sub { $sep x $self->{term}->ncol },
		1347	activate => sub { },
		1348	});
		1349	}
		1350
		1351	=item $popup->add_button ($text, $cb)
		1352
		1353	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1354	selected.
		1355
		1356	=cut
		1357
		1358	sub add_button {
		1359	my ($self, $text, $cb) = @_;
		1360
		1361	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1362	}
		1363
		1364	=item $popup->add_toggle ($text, $cb, $initial_value)
		1365
		1366	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1367	whenever it gets toggled, with a boolean indicating its value as its first
		1368	argument.
		1369
		1370	=cut
		1371
		1372	sub add_toggle {
		1373	my ($self, $text, $cb, $value) = @_;
		1374
		1375	my $item; $item = {
		1376	type => "button",
		1377	text => " $text",
		1378	value => $value,
		1379	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1380	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1381	};
		1382
		1383	$self->add_item ($item);
		1384	}
		1385
		1386	=item $popup->show
		1387
		1388	Displays the popup (which is initially hidden).
		1389
		1390	=cut
		1391
		1392	sub show {
		1393	my ($self) = @_;
		1394
		1395	local $urxvt::popup::self = $self;
		1396
		1397	local $ENV{LC_ALL} = $self->{term}->locale;
		1398
		1399	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1400	"--transient-for" => $self->{term}->parent,
		1401	"-display" => $self->{term}->display_id,
		1402	"-pe" => "urxvt-popup")
		1403	or die "unable to create popup window\n";
		1404	}
		1405
		1406	sub DESTROY {
		1407	my ($self) = @_;
		1408
		1409	delete $self->{term}{_destroy}{$self};
		1410	$self->{term}->ungrab;
		1411	}
858		1412
859	=head2 The C<urxvt::timer> Class	1413	=head2 The C<urxvt::timer> Class
860		1414
861	This class implements timer watchers/events. Time is represented as a	1415	This class implements timer watchers/events. Time is represented as a
862	fractional number of seconds since the epoch. Example:	1416	fractional number of seconds since the epoch. Example:
…		…
915		1469
916	$term->{socket} = ...	1470	$term->{socket} = ...
917	$term->{iow} = urxvt::iow	1471	$term->{iow} = urxvt::iow
918	->new	1472	->new
919	->fd (fileno $term->{socket})	1473	->fd (fileno $term->{socket})
920	->events (1) # wait for read data	1474	->events (urxvt::EVENT_READ)
921	->start	1475	->start
922	->cb (sub {	1476	->cb (sub {
923	my ($iow, $revents) = @_;	1477	my ($iow, $revents) = @_;
924	# $revents must be 1 here, no need to check	1478	# $revents must be 1 here, no need to check
925	sysread $term->{socket}, my $buf, 8192	1479	sysread $term->{socket}, my $buf, 8192
…		…
942		1496
943	Set the filedescriptor (not handle) to watch.	1497	Set the filedescriptor (not handle) to watch.
944		1498
945	=item $iow = $iow->events ($eventmask)	1499	=item $iow = $iow->events ($eventmask)
946		1500
947	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1501	Set the event mask to watch. The only allowed values are
948	data, Bit #1 (value C<2>) enables watching for write data.	1502	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1503	together, or C<urxvt::EVENT_NONE>.
949		1504
950	=item $iow = $iow->start	1505	=item $iow = $iow->start
951		1506
952	Start watching for requested events on the given handle.	1507	Start watching for requested events on the given handle.
953		1508
…		…
964	This variable controls the verbosity level of the perl extension. Higher	1519	This variable controls the verbosity level of the perl extension. Higher
965	numbers indicate more verbose output.	1520	numbers indicate more verbose output.
966		1521
967	=over 4	1522	=over 4
968		1523
969	=item =0 - only fatal messages	1524	=item == 0 - fatal messages
970		1525
971	=item =3 - script loading and management	1526	=item >= 3 - script loading and management
972		1527
973	=item =10 - all events received	1528	=item >=10 - all events received
974		1529
975	=back	1530	=back
976		1531
977	=head1 AUTHOR	1532	=head1 AUTHOR
978		1533

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.34 by root, Fri Jan 6 01:16:58 2006 UTC vs. Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.34 by root, Fri Jan 6 01:16:58 2006 UTC vs.
Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC