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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.37 by root, Fri Jan 6 03:40:19 2006 UTC vs.
Revision 1.80 by root, Thu Jan 12 00:11:59 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.37 by root, Fri Jan 6 03:40:19 2006 UTC vs. Revision 1.80 by root, Thu Jan 12 00:11:59 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.37 by root, Fri Jan 6 03:40:19 2006 UTC vs.
Revision 1.80 by root, Thu Jan 12 00:11:59 2006 UTC