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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC vs.
Revision 1.89 by root, Thu Jan 12 12:10:06 2006 UTC

…		…
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 (enabled by default)	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 and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	47	arguments, which is very convenient, too, if your F<ls> supports
		48	C<--quoting-style=shell>.
48		49
49	It also offers the following bindable event:	50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
		53	The selection works by trying to match a number of regexes and displaying
		54	them in increasing order of length. You can add your own regexes by
		55	specifying resources of the form:
		56
		57	URxvt.selection.pattern-0: perl-regex
		58	URxvt.selection.pattern-1: perl-regex
		59	...
		60
		61	The index number (0, 1...) must not have any holes, and each regex must
		62	contain at least one pair of capturing parentheses, which will be used for
		63	the match. For example, the followign adds a regex that matches everything
		64	between two vertical bars:
		65
		66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		67
		68	You can look at the source of the selection extension to see more
		69	interesting uses, such as parsing a line from beginning to end.
		70
		71	This extension also offers the following bindable keyboard command:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
…		…
58		80
59	=back	81	=back
60		82
61	=item option-popup (enabled by default)	83	=item option-popup (enabled by default)
62		84
63	Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at	85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	86	runtime.
65		87
66	=item digital-clock	88	=item selection-popup (enabled by default)
67		89
68	Displays a digital clock using the built-in overlay.	90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
		93
		94	=item searchable-scrollback<hotkey> (enabled by default)
		95
		96	Adds regex search functionality to the scrollback buffer, triggered
		97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		98	input/output is suspended and a regex is displayed at the bottom of the
		99	screen.
		100
		101	Inputting characters appends them to the regex and continues incremental
		102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		104	bottom. C<Escape> leaves search mode and returns to the point where search
		105	was started, while C<Enter> or C<Return> stay at the current position and
		106	additionally stores the first match in the current line into the primary
		107	selection.
		108
		109	=item selection-autotransform
		110
		111	This selection allows you to do automatic transforms on a selection
		112	whenever a selection is made.
		113
		114	It works by specifying perl snippets (most useful is a single C<s///>
		115	operator) that modify C<$_> as resources:
		116
		117	URxvt.selection-autotransform.0: transform
		118	URxvt.selection-autotransform.1: transform
		119	...
		120
		121	For example, the following will transform selections of the form
		122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		123	$word>:
		124
		125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		126
		127	And this example matches the same,but replaces it with vi-commands you can
		128	paste directly into your (vi :) editor:
		129
		130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
69		131
70	=item mark-urls	132	=item mark-urls
71		133
72	Uses per-line display filtering (C<on_line_update>) to underline urls.	134	Uses per-line display filtering (C<on_line_update>) to underline urls and
		135	make them clickable. When middle-clicked, the program specified in the
		136	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		137	the URL as first argument.
73		138
74	=item block-graphics-to-ascii	139	=item block-graphics-to-ascii
75		140
76	A not very useful example of filtering all text output to the terminal,	141	A not very useful example of filtering all text output to the terminal,
77	by replacing all line-drawing characters (U+2500 .. U+259F) by a	142	by replacing all line-drawing characters (U+2500 .. U+259F) by a
78	similar-looking ascii character.	143	similar-looking ascii character.
79		144
		145	=item digital-clock
		146
		147	Displays a digital clock using the built-in overlay.
		148
80	=item example-refresh-hooks	149	=item example-refresh-hooks
81		150
82	Displays a very simple digital clock in the upper right corner of the	151	Displays a very simple digital clock in the upper right corner of the
83	window. Illustrates overwriting the refresh callbacks to create your own	152	window. Illustrates overwriting the refresh callbacks to create your own
84	overlays or changes.	153	overlays or changes.
85		154
86	=back	155	=back
		156
		157	=head1 API DOCUMENTATION
87		158
88	=head2 General API Considerations	159	=head2 General API Considerations
89		160
90	All objects (such as terminals, time watchers etc.) are typical	161	All objects (such as terminals, time watchers etc.) are typical
91	reference-to-hash objects. The hash can be used to store anything you	162	reference-to-hash objects. The hash can be used to store anything you
…		…
104	=over 4	175	=over 4
105		176
106	=item $text	177	=item $text
107		178
108	Rxvt-unicodes special way of encoding text, where one "unicode" character	179	Rxvt-unicodes special way of encoding text, where one "unicode" character
109	always represents one screen cell. See L<row_t> for a discussion of this format.	180	always represents one screen cell. See L<ROW_t> for a discussion of this format.
110		181
111	=item $string	182	=item $string
112		183
113	A perl text string, with an emphasis on I<text>. It can store all unicode	184	A perl text string, with an emphasis on I<text>. It can store all unicode
114	characters and is to be distinguished with text encoded in a specific	185	characters and is to be distinguished with text encoded in a specific
…		…
119	Either binary data or - more common - a text string encoded in a	190	Either binary data or - more common - a text string encoded in a
120	locale-specific way.	191	locale-specific way.
121		192
122	=back	193	=back
123		194
		195	=head2 Extension Objects
		196
		197	Very perl extension is a perl class. A separate perl object is created
		198	for each terminal and each extension and passed as the first parameter to
		199	hooks. So extensions can use their C<$self> object without having to think
		200	about other extensions, with the exception of methods and members that
		201	begin with an underscore character C<_>: these are reserved for internal
		202	use.
		203
		204	Although it isn't a C<urxvt::term> object, you can call all methods of the
		205	C<urxvt::term> class on this object.
		206
		207	It has the following methods and data members:
		208
		209	=over 4
		210
		211	=item $urxvt_term = $self->{term}
		212
		213	Returns the C<urxvt::term> object associated with this instance of the
		214	extension. This member I<must not> be changed in any way.
		215
		216	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		217
		218	Dynamically enable the given hooks (named without the C<on_> prefix) for
		219	this extension, replacing any previous hook. This is useful when you want
		220	to overwrite time-critical hooks only temporarily.
		221
		222	=item $self->disable ($hook_name[, $hook_name..])
		223
		224	Dynamically disable the given hooks.
		225
		226	=back
		227
124	=head2 Hooks	228	=head2 Hooks
125		229
126	The following subroutines can be declared in extension files, and will be	230	The following subroutines can be declared in extension files, and will be
127	called whenever the relevant event happens.	231	called whenever the relevant event happens.
128		232
129	The first argument passed to them is an object private to each terminal	233	The first argument passed to them is an extension oject as described in
130	and extension package. You can call all C<urxvt::term> methods on it, but	234	the in the C<Extension Objects> section.
131	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
132	object that is shared between all packages is stored in the C<term>
133	member. It is, however, blessed intot he package of the extension script,
134	so for all practical purposes you can treat an extension script as a class.
135		235
136	All of them must return a boolean value. If it is true, then the event	236	B<All> of these hooks must return a boolean value. If it is true, then the
137	counts as being I<consumed>, and the invocation of other hooks is skipped,	237	event counts as being I<consumed>, and the invocation of other hooks is
138	and the relevant action might not be carried out by the C++ code.	238	skipped, and the relevant action might not be carried out by the C++ code.
139		239
140	When in doubt, return a false value (preferably C<()>).	240	I<< When in doubt, return a false value (preferably C<()>). >>
141		241
142	=over 4	242	=over 4
143		243
144	=item on_init $term	244	=item on_init $term
145		245
…		…
180	=item on_sel_extend $term	280	=item on_sel_extend $term
181		281
182	Called whenever the user tries to extend the selection (e.g. with a double	282	Called whenever the user tries to extend the selection (e.g. with a double
183	click) and is either supposed to return false (normal operation), or	283	click) and is either supposed to return false (normal operation), or
184	should extend the selection itelf and return true to suppress the built-in	284	should extend the selection itelf and return true to suppress the built-in
185	processing.	285	processing. This can happen multiple times, as long as the callback
		286	returns true, it will be called on every further click by the user and is
		287	supposed to enlarge the selection more and more, if possible.
186		288
187	See the F<selection> example extension.	289	See the F<selection> example extension.
188		290
189	=item on_view_change $term, $offset	291	=item on_view_change $term, $offset
190		292
…		…
199	than the scroll back buffer or the terminal.	301	than the scroll back buffer or the terminal.
200		302
201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	303	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	304	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
203	number of lines that will be in the scrollback buffer.	305	number of lines that will be in the scrollback buffer.
204
205	=item on_tty_activity $term NYI
206
207	Called whenever the program(s) running in the urxvt window send output.
208		306
209	=item on_osc_seq $term, $string	307	=item on_osc_seq $term, $string
210		308
211	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	309	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212	operating system command) is processed. Cursor position and other state	310	operating system command) is processed. Cursor position and other state
…		…
225	can filter/change and output the text yourself by returning a true value	323	can filter/change and output the text yourself by returning a true value
226	and calling C<< $term->scr_add_lines >> yourself. Please note that this	324	and calling C<< $term->scr_add_lines >> yourself. Please note that this
227	might be very slow, however, as your hook is called for B<all> text being	325	might be very slow, however, as your hook is called for B<all> text being
228	output.	326	output.
229		327
		328	=item on_tt_write $term, $octets
		329
		330	Called whenever some data is written to the tty/pty and can be used to
		331	suppress or filter tty input.
		332
230	=item on_line_update $term, $row	333	=item on_line_update $term, $row
231		334
232	Called whenever a line was updated or changed. Can be used to filter	335	Called whenever a line was updated or changed. Can be used to filter
233	screen output (e.g. underline urls or other useless stuff). Only lines	336	screen output (e.g. underline urls or other useless stuff). Only lines
234	that are being shown will be filtered, and, due to performance reasons,	337	that are being shown will be filtered, and, due to performance reasons,
…		…
266	=item on_focus_out $term	369	=item on_focus_out $term
267		370
268	Called wheneever the window loses keyboard focus, before rxvt-unicode does	371	Called wheneever the window loses keyboard focus, before rxvt-unicode does
269	focus out processing.	372	focus out processing.
270		373
271	=item on_key_press $term, $event, $octets	374	=item on_key_press $term, $event, $keysym, $octets
272		375
273	=item on_key_release $term, $event	376	=item on_key_release $term, $event, $keysym
274		377
275	=item on_button_press $term, $event	378	=item on_button_press $term, $event
276		379
277	=item on_button_release $term, $event	380	=item on_button_release $term, $event
278		381
…		…
294		397
295	subwindow.	398	subwindow.
296		399
297	=back	400	=back
298		401
		402	=cut
		403
		404	package urxvt;
		405
		406	use utf8;
		407	use strict;
		408	use Carp ();
		409	use Scalar::Util ();
		410	use List::Util ();
		411
		412	our $VERSION = 1;
		413	our $TERM;
		414	our @HOOKNAME;
		415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		416	our %OPTION;
		417
		418	our $LIBDIR;
		419	our $RESNAME;
		420	our $RESCLASS;
		421	our $RXVTNAME;
		422
299	=head2 Variables in the C<urxvt> Package	423	=head2 Variables in the C<urxvt> Package
300		424
301	=over 4	425	=over 4
		426
		427	=item $urxvt::LIBDIR
		428
		429	The rxvt-unicode library directory, where, among other things, the perl
		430	modules and scripts are stored.
		431
		432	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		433
		434	The resource class and name rxvt-unicode uses to look up X resources.
		435
		436	=item $urxvt::RXVTNAME
		437
		438	The basename of the installed binaries, usually C<urxvt>.
302		439
303	=item $urxvt::TERM	440	=item $urxvt::TERM
304		441
305	The current terminal. This variable stores the current C<urxvt::term>	442	The current terminal. This variable stores the current C<urxvt::term>
306	object, whenever a callback/hook is executing.	443	object, whenever a callback/hook is executing.
…		…
308	=back	445	=back
309		446
310	=head2 Functions in the C<urxvt> Package	447	=head2 Functions in the C<urxvt> Package
311		448
312	=over 4	449	=over 4
313
314	=item $term = new urxvt [arg...]
315
316	Creates a new terminal, very similar as if you had started it with
317	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
318	if the new instance couldn't be created. Returns C<undef> if the new
319	instance didn't initialise perl, and the terminal object otherwise. The
320	C<init> and C<start> hooks will be called during the call.
321		450
322	=item urxvt::fatal $errormessage	451	=item urxvt::fatal $errormessage
323		452
324	Fatally aborts execution with the given error message. Avoid at all	453	Fatally aborts execution with the given error message. Avoid at all
325	costs! The only time this is acceptable is when the terminal process	454	costs! The only time this is acceptable is when the terminal process
…		…
332	that calls this function.	461	that calls this function.
333		462
334	Using this function has the advantage that its output ends up in the	463	Using this function has the advantage that its output ends up in the
335	correct place, e.g. on stderr of the connecting urxvtc client.	464	correct place, e.g. on stderr of the connecting urxvtc client.
336		465
		466	Messages have a size limit of 1023 bytes currently.
		467
		468	=item $is_safe = urxvt::safe
		469
		470	Returns true when it is safe to do potentially unsafe things, such as
		471	evaluating perl code specified by the user. This is true when urxvt was
		472	started setuid or setgid.
		473
337	=item $time = urxvt::NOW	474	=item $time = urxvt::NOW
338		475
339	Returns the "current time" (as per the event loop).	476	Returns the "current time" (as per the event loop).
340		477
341	=item urxvt::CurrentTime	478	=item urxvt::CurrentTime
342		479
343	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	480	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	481	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345	Button4Mask, Button5Mask, AnyModifier	482	Button4Mask, Button5Mask, AnyModifier
346		483
347	Various constants for use in X events.	484	Various constants for use in X calls and event processing.
348		485
349	=back	486	=back
350		487
351	=head2 RENDITION	488	=head2 RENDITION
352		489
…		…
379		516
380	=item $background = urxvt::GET_BASEBG $rend	517	=item $background = urxvt::GET_BASEBG $rend
381		518
382	Return the foreground/background colour index, respectively.	519	Return the foreground/background colour index, respectively.
383		520
384	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	521	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385		522
386	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	523	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
387		524
388	Replace the foreground/background colour in the rendition mask with the	525	Replace the foreground/background colour in the rendition mask with the
389	specified one.	526	specified one.
390		527
391	=item $value = urxvt::GET_CUSTOM ($rend)	528	=item $value = urxvt::GET_CUSTOM $rend
392		529
393	Return the "custom" value: Every rendition has 5 bits for use by	530	Return the "custom" value: Every rendition has 5 bits for use by
394	extensions. They can be set and changed as you like and are initially	531	extensions. They can be set and changed as you like and are initially
395	zero.	532	zero.
396		533
397	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	534	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398		535
399	Change the custom value.	536	Change the custom value.
400		537
401	=back	538	=back
402		539
403	=cut	540	=cut
404
405	package urxvt;
406
407	use utf8;
408	use strict;
409	use Scalar::Util ();
410	use List::Util ();
411
412	our $TERM;
413	our @HOOKNAME;
414	our %OPTION;
415	our $LIBDIR;
416		541
417	BEGIN {	542	BEGIN {
418	urxvt->bootstrap;	543	urxvt->bootstrap;
419		544
420	# overwrite perl's warn	545	# overwrite perl's warn
…		…
422	my $msg = join "", @_;	547	my $msg = join "", @_;
423	$msg .= "\n"	548	$msg .= "\n"
424	unless $msg =~ /\n$/;	549	unless $msg =~ /\n$/;
425	urxvt::warn ($msg);	550	urxvt::warn ($msg);
426	};	551	};
		552
		553	# %ENV is the original startup environment
		554	delete $ENV{IFS};
		555	delete $ENV{CDPATH};
		556	delete $ENV{BASH_ENV};
		557	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
427	}	558	}
428		559
429	my @hook_count;	560	my @hook_count;
430	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	561	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
431		562
432	sub verbose {	563	sub verbose {
433	my ($level, $msg) = @_;	564	my ($level, $msg) = @_;
434	warn "$msg\n" if $level <= $verbosity;	565	warn "$msg\n" if $level <= $verbosity;
435	}	566	}
436		567
437	# find on_xxx subs in the package and register them
438	# as hooks
439	sub register_package($) {
440	my ($pkg) = @_;
441
442	for my $htype (0.. $#HOOKNAME) {
443	my $name = $HOOKNAME[$htype];
444
445	my $ref = $pkg->can ("on_" . lc $name)
446	or next;
447
448	$TERM->{_hook}[$htype]{$pkg} = $ref;
449	$hook_count[$htype]++
450	or set_should_invoke $htype, 1;
451	}
452	}
453
454	my $extension_pkg = "extension0000";	568	my $extension_pkg = "extension0000";
455	my %extension_pkg;	569	my %extension_pkg;
456		570
457	# load a single script into its own package, once only	571	# load a single script into its own package, once only
458	sub extension_package($) {	572	sub extension_package($) {
…		…
464	verbose 3, "loading extension '$path' into package '$pkg'";	578	verbose 3, "loading extension '$path' into package '$pkg'";
465		579
466	open my $fh, "<:raw", $path	580	open my $fh, "<:raw", $path
467	or die "$path: $!";	581	or die "$path: $!";
468		582
		583	my $source = untaint
469	my $source = "package $pkg; use strict; use utf8;\n"	584	"package $pkg; use strict; use utf8;\n"
470	. "use base urxvt::term::proxy::;\n"	585	. "use base urxvt::term::extension::;\n"
471	. "#line 1 \"$path\"\n{\n"	586	. "#line 1 \"$path\"\n{\n"
472	. (do { local $/; <$fh> })	587	. (do { local $/; <$fh> })
473	. "\n};\n1";	588	. "\n};\n1";
474		589
		590	eval $source
475	eval $source or die "$path: $@";	591	or die "$path: $@";
476		592
477	$pkg	593	$pkg
478	}	594	}
479	}	595	}
480		596
…		…
486	my $htype = shift;	602	my $htype = shift;
487		603
488	if ($htype == 0) { # INIT	604	if ($htype == 0) { # INIT
489	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	605	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
490		606
491	my %want_ext;	607	my %ext_arg;
492		608
493	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	609	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
494	if ($_ eq "default") {	610	if ($_ eq "default") {
495	$want_ext{$_}++ for qw(selection option-popup);	611	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
496	} elsif (/^-(.*)$/) {	612	} elsif (/^-(.*)$/) {
497	delete $want_ext{$1};	613	delete $ext_arg{$1};
		614	} elsif (/^([^<]+)<(.*)>$/) {
		615	push @{ $ext_arg{$1} }, $2;
498	} else {	616	} else {
499	$want_ext{$_}++;	617	$ext_arg{$_} \|\|= [];
500	}	618	}
501	}	619	}
502		620
503	for my $ext (keys %want_ext) {	621	while (my ($ext, $argv) = each %ext_arg) {
504	my @files = grep -f $_, map "$_/$ext", @dirs;	622	my @files = grep -f $_, map "$_/$ext", @dirs;
505		623
506	if (@files) {	624	if (@files) {
507	register_package extension_package $files[0];	625	$TERM->register_package (extension_package $files[0], $argv);
508	} else {	626	} else {
509	warn "perl extension '$ext' not found in perl library search path\n";	627	warn "perl extension '$ext' not found in perl library search path\n";
510	}	628	}
511	}	629	}
		630
		631	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		632	warn $@ if $@;
512	}	633	}
513		634
514	$retval = undef;	635	$retval = undef;
515		636
516	if (my $cb = $TERM->{_hook}[$htype]) {	637	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
518	if $verbosity >= 10;	639	if $verbosity >= 10;
519		640
520	keys %$cb;	641	keys %$cb;
521		642
522	while (my ($pkg, $cb) = each %$cb) {	643	while (my ($pkg, $cb) = each %$cb) {
523	eval {	644	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
524	$retval = $cb->(
525	$TERM->{_pkg}{$pkg} \|\|= do {
526	my $proxy = bless { }, $pkg;
527	Scalar::Util::weaken ($proxy->{term} = $TERM);
528	$proxy
529	},
530	@_,
531	) and last;	645	and last;
		646
		647	if ($@) {
		648	$TERM->ungrab; # better to lose the grab than the session
		649	warn $@;
532	};	650	}
533	warn $@ if $@;#d#
534	}	651	}
		652
		653	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		654	if $verbosity >= 11;
535	}	655	}
536		656
537	if ($htype == 1) { # DESTROY	657	if ($htype == 1) { # DESTROY
538	# remove hooks if unused
539	if (my $hook = $TERM->{_hook}) {	658	if (my $hook = delete $TERM->{_hook}) {
540	for my $htype (0..$#$hook) {	659	for my $htype (0..$#$hook) {
541	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	660	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
542	or set_should_invoke $htype, 0;	661	or set_should_invoke $htype, 0;
543	}	662	}
544	}	663	}
…		…
551	}	670	}
552		671
553	$retval	672	$retval
554	}	673	}
555		674
556	sub urxvt::term::proxy::AUTOLOAD {	675	sub exec_async(@) {
557	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	676	my $pid = fork;
		677
		678	return
		679	if !defined $pid or $pid;
		680
		681	%ENV = %{ $TERM->env };
		682
		683	exec @_;
		684	_exit 255;
		685	}
		686
		687	# urxvt::term::extension
		688
		689	package urxvt::term::extension;
		690
		691	sub enable {
		692	my ($self, %hook) = @_;
		693	my $pkg = $self->{_pkg};
		694
		695	while (my ($name, $cb) = each %hook) {
		696	my $htype = $HOOKTYPE{uc $name};
		697	defined $htype
		698	or Carp::croak "unsupported hook type '$name'";
		699
		700	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		701	$hook_count[$htype]++
		702	or urxvt::set_should_invoke $htype, 1;
		703	}
		704
		705	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		706	}
		707	}
		708
		709	sub disable {
		710	my ($self, @hook) = @_;
		711	my $pkg = $self->{_pkg};
		712
		713	for my $name (@hook) {
		714	my $htype = $HOOKTYPE{uc $name};
		715	defined $htype
		716	or Carp::croak "unsupported hook type '$name'";
		717
		718	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		719	--$hook_count[$htype]
		720	or urxvt::set_should_invoke $htype, 0;
		721	}
		722	}
		723	}
		724
		725	our $AUTOLOAD;
		726
		727	sub AUTOLOAD {
		728	$AUTOLOAD =~ /:([^:]+)$/
558	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	729	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
559		730
560	eval qq{	731	eval qq{
561	sub $urxvt::term::proxy::AUTOLOAD {	732	sub $AUTOLOAD {
562	my \$proxy = shift;	733	my \$proxy = shift;
563	\$proxy->{term}->$1 (\@_)	734	\$proxy->{term}->$1 (\@_)
564	}	735	}
565	1	736	1
566	} or die "FATAL: unable to compile method forwarder: $@";	737	} or die "FATAL: unable to compile method forwarder: $@";
567		738
568	goto &$urxvt::term::proxy::AUTOLOAD;	739	goto &$AUTOLOAD;
569	}	740	}
		741
		742	sub DESTROY {
		743	# nop
		744	}
		745
		746	# urxvt::destroy_hook
570		747
571	sub urxvt::destroy_hook::DESTROY {	748	sub urxvt::destroy_hook::DESTROY {
572	${$_[0]}->();	749	${$_[0]}->();
573	}	750	}
574		751
575	sub urxvt::destroy_hook(&) {	752	sub urxvt::destroy_hook(&) {
576	bless \shift, urxvt::destroy_hook::	753	bless \shift, urxvt::destroy_hook::
577	}	754	}
578		755
		756	package urxvt::anyevent;
		757
		758	=head2 The C<urxvt::anyevent> Class
		759
		760	The sole purpose of this class is to deliver an interface to the
		761	C<AnyEvent> module - any module using it will work inside urxvt without
		762	further programming. The only exception is that you cannot wait on
		763	condition variables, but non-blocking condvar use is ok. What this means
		764	is that you cannot use blocking APIs, but the non-blocking variant should
		765	work.
		766
		767	=cut
		768
		769	our $VERSION = 1;
		770
		771	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		772	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		773
		774	sub timer {
		775	my ($class, %arg) = @_;
		776
		777	my $cb = $arg{cb};
		778
		779	urxvt::timer
		780	->new
		781	->start (urxvt::NOW + $arg{after})
		782	->cb (sub {
		783	$_[0]->stop; # need to cancel manually
		784	$cb->();
		785	})
		786	}
		787
		788	sub io {
		789	my ($class, %arg) = @_;
		790
		791	my $cb = $arg{cb};
		792
		793	bless [$arg{fh}, urxvt::iow
		794	->new
		795	->fd (fileno $arg{fh})
		796	->events (($arg{poll} =~ /r/ ? 1 : 0)
		797	\| ($arg{poll} =~ /w/ ? 2 : 0))
		798	->start
		799	->cb (sub {
		800	$cb->(($_[1] & 1 ? 'r' : '')
		801	. ($_[1] & 2 ? 'w' : ''));
		802	})],
		803	urxvt::anyevent::
		804	}
		805
		806	sub DESTROY {
		807	$_[0][1]->stop;
		808	}
		809
		810	sub condvar {
		811	bless \my $flag, urxvt::anyevent::condvar::
		812	}
		813
		814	sub urxvt::anyevent::condvar::broadcast {
		815	${$_[0]}++;
		816	}
		817
		818	sub urxvt::anyevent::condvar::wait {
		819	unless (${$_[0]}) {
		820	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		821	}
		822	}
		823
		824	package urxvt::term;
		825
579	=head2 The C<urxvt::term> Class	826	=head2 The C<urxvt::term> Class
580		827
581	=over 4	828	=over 4
582		829
		830	=cut
		831
		832	# find on_xxx subs in the package and register them
		833	# as hooks
		834	sub register_package {
		835	my ($self, $pkg, $argv) = @_;
		836
		837	my $proxy = bless {
		838	_pkg => $pkg,
		839	argv => $argv,
		840	}, $pkg;
		841	Scalar::Util::weaken ($proxy->{term} = $self);
		842
		843	$self->{_pkg}{$pkg} = $proxy;
		844
		845	for my $name (@HOOKNAME) {
		846	if (my $ref = $pkg->can ("on_" . lc $name)) {
		847	$proxy->enable ($name => $ref);
		848	}
		849	}
		850	}
		851
		852	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		853
		854	Creates a new terminal, very similar as if you had started it with system
		855	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		856	hash which defines the environment of the new terminal.
		857
		858	Croaks (and probably outputs an error message) if the new instance
		859	couldn't be created. Returns C<undef> if the new instance didn't
		860	initialise perl, and the terminal object otherwise. The C<init> and
		861	C<start> hooks will be called during this call.
		862
		863	=cut
		864
		865	sub new {
		866	my ($class, $env, @args) = @_;
		867
		868	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		869	}
		870
583	=item $term->destroy	871	=item $term->destroy
584		872
585	Destroy the terminal object (close the window, free resources etc.).	873	Destroy the terminal object (close the window, free resources
		874	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		875	watchers (timers, io watchers) are still active.
586		876
587	=item $isset = $term->option ($optval[, $set])	877	=item $isset = $term->option ($optval[, $set])
588		878
589	Returns true if the option specified by C<$optval> is enabled, and	879	Returns true if the option specified by C<$optval> is enabled, and
590	optionally change it. All option values are stored by name in the hash	880	optionally change it. All option values are stored by name in the hash
…		…
634	shade term_name title transparent transparent_all tripleclickwords	924	shade term_name title transparent transparent_all tripleclickwords
635	utmpInhibit visualBell	925	utmpInhibit visualBell
636		926
637	=cut	927	=cut
638		928
639	sub urxvt::term::resource($$;$) {	929	sub resource($$;$) {
640	my ($self, $name) = (shift, shift);	930	my ($self, $name) = (shift, shift);
641	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	931	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
642	&urxvt::term::_resource	932	&urxvt::term::_resource
643	}	933	}
644		934
		935	=item $value = $term->x_resource ($pattern)
		936
		937	Returns the X-Resource for the given pattern, excluding the program or
		938	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		939	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		940	resource with that pattern exists.
		941
		942	This method should only be called during the C<on_start> hook, as there is
		943	only one resource database per display, and later invocations might return
		944	the wrong resources.
		945
		946	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		947
		948	Adds a keymap translation exactly as specified via a resource. See the
		949	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		950
645	=item $rend = $term->rstyle ([$new_rstyle])	951	=item $rend = $term->rstyle ([$new_rstyle])
646		952
647	Return and optionally change the current rendition. Text that is output by	953	Return and optionally change the current rendition. Text that is output by
648	the terminal application will use this style.	954	the terminal application will use this style.
649		955
…		…
659	=item ($row, $col) = $term->selection_end ([$row, $col])	965	=item ($row, $col) = $term->selection_end ([$row, $col])
660		966
661	Return the current values of the selection mark, begin or end positions,	967	Return the current values of the selection mark, begin or end positions,
662	and optionally set them to new values.	968	and optionally set them to new values.
663		969
		970	=item $term->selection_make ($eventtime[, $rectangular])
		971
		972	Tries to make a selection as set by C<selection_beg> and
		973	C<selection_end>. If C<$rectangular> is true (default: false), a
		974	rectangular selection will be made. This is the prefered function to make
		975	a selection.
		976
664	=item $success = $term->selection_grab ($eventtime)	977	=item $success = $term->selection_grab ($eventtime)
665		978
666	Try to request the primary selection from the server (for example, as set	979	Try to request the primary selection text from the server (for example, as
667	by the next method).	980	set by the next method). No visual feedback will be given. This function
		981	is mostly useful from within C<on_sel_grab> hooks.
668		982
669	=item $oldtext = $term->selection ([$newtext])	983	=item $oldtext = $term->selection ([$newtext])
670		984
671	Return the current selection text and optionally replace it by C<$newtext>.	985	Return the current selection text and optionally replace it by C<$newtext>.
672		986
673	#=item $term->overlay ($x, $y, $text)	987	=item $term->overlay_simple ($x, $y, $text)
674	#	988
675	#Create a simple multi-line overlay box. See the next method for details.	989	Create a simple multi-line overlay box. See the next method for details.
676	#	990
677	#=cut	991	=cut
678	#	992
679	#sub urxvt::term::scr_overlay {	993	sub overlay_simple {
680	# my ($self, $x, $y, $text) = @_;	994	my ($self, $x, $y, $text) = @_;
681	#	995
682	# my @lines = split /\n/, $text;	996	my @lines = split /\n/, $text;
683	#	997
684	# my $w = 0;	998	my $w = List::Util::max map $self->strwidth ($_), @lines;
685	# for (map $self->strwidth ($_), @lines) {	999
686	# $w = $_ if $w < $_;
687	# }
688	#
689	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1000	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
690	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1001	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
691	#}	1002
		1003	$overlay
		1004	}
692		1005
693	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1006	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
694		1007
695	Create a new (empty) overlay at the given position with the given	1008	Create a new (empty) overlay at the given position with the given
696	width/height. C<$rstyle> defines the initial rendition style	1009	width/height. C<$rstyle> defines the initial rendition style
…		…
731	C<$event> I<must> be the event causing the menu to pop up (a button event,	1044	C<$event> I<must> be the event causing the menu to pop up (a button event,
732	currently).	1045	currently).
733		1046
734	=cut	1047	=cut
735		1048
736	sub urxvt::term::popup {	1049	sub popup {
737	my ($self, $event) = @_;	1050	my ($self, $event) = @_;
738		1051
739	$self->grab ($event->{time}, 1)	1052	$self->grab ($event->{time}, 1)
740	or return;	1053	or return;
741		1054
…		…
763		1076
764	=item $string = $term->locale_decode ($octets)	1077	=item $string = $term->locale_decode ($octets)
765		1078
766	Convert the given locale-encoded octets into a perl string.	1079	Convert the given locale-encoded octets into a perl string.
767		1080
		1081	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1082
		1083	XORs the rendition values in the given span with the provided value
		1084	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1085	refresh hooks to provide effects similar to the selection.
		1086
		1087	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1088
		1089	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1090	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1091	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1092	it instead. Both styles I<MUST NOT> contain font styles.
		1093
		1094	=item $term->scr_bell
		1095
		1096	Ring the bell!
		1097
768	=item $term->scr_add_lines ($string)	1098	=item $term->scr_add_lines ($string)
769		1099
770	Write the given text string to the screen, as if output by the application	1100	Write the given text string to the screen, as if output by the application
771	running inside the terminal. It may not contain command sequences (escape	1101	running inside the terminal. It may not contain command sequences (escape
772	codes), but is free to use line feeds, carriage returns and tabs. The	1102	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
786		1116
787	Write the octets given in C<$data> to the tty (i.e. as program input). To	1117	Write the octets given in C<$data> to the tty (i.e. as program input). To
788	pass characters instead of octets, you should convert your strings first	1118	pass characters instead of octets, you should convert your strings first
789	to the locale-specific encoding using C<< $term->locale_encode >>.	1119	to the locale-specific encoding using C<< $term->locale_encode >>.
790		1120
		1121	=item $old_events = $term->pty_ev_events ([$new_events])
		1122
		1123	Replaces the event mask of the pty watcher by the given event mask. Can
		1124	be used to suppress input and output handling to the pty/tty. See the
		1125	description of C<< urxvt::timer->events >>. Make sure to always restore
		1126	the previous value.
		1127
791	=item $windowid = $term->parent	1128	=item $windowid = $term->parent
792		1129
793	Return the window id of the toplevel window.	1130	Return the window id of the toplevel window.
794		1131
795	=item $windowid = $term->vt	1132	=item $windowid = $term->vt
…		…
819	=item $nrow_plus_saveLines = $term->total_rows	1156	=item $nrow_plus_saveLines = $term->total_rows
820		1157
821	=item $lines_in_scrollback = $term->nsaved	1158	=item $lines_in_scrollback = $term->nsaved
822		1159
823	Return various integers describing terminal characteristics.	1160	Return various integers describing terminal characteristics.
		1161
		1162	=item $x_display = $term->display_id
		1163
		1164	Return the DISPLAY used by rxvt-unicode.
		1165
		1166	=item $lc_ctype = $term->locale
		1167
		1168	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1169
		1170	=item $env = $term->env
		1171
		1172	Returns a copy of the environment in effect for the terminal as a hashref
		1173	similar to C<\%ENV>.
		1174
		1175	=cut
		1176
		1177	sub env {
		1178	if (my $env = $_[0]->_env) {
		1179	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1180	} else {
		1181	+{ %ENV }
		1182	}
		1183	}
824		1184
825	=item $modifiermask = $term->ModLevel3Mask	1185	=item $modifiermask = $term->ModLevel3Mask
826		1186
827	=item $modifiermask = $term->ModMetaMask	1187	=item $modifiermask = $term->ModMetaMask
828		1188
…		…
921	Return the row number of the first/last row of the line, respectively.	1281	Return the row number of the first/last row of the line, respectively.
922		1282
923	=item $offset = $line->offset_of ($row, $col)	1283	=item $offset = $line->offset_of ($row, $col)
924		1284
925	Returns the character offset of the given row\|col pair within the logical	1285	Returns the character offset of the given row\|col pair within the logical
926	line.	1286	line. Works for rows outside the line, too, and returns corresponding
		1287	offsets outside the string.
927		1288
928	=item ($row, $col) = $line->coord_of ($offset)	1289	=item ($row, $col) = $line->coord_of ($offset)
929		1290
930	Translates a string offset into terminal coordinates again.	1291	Translates a string offset into terminal coordinates again.
931		1292
932	=back	1293	=back
933		1294
934	=cut	1295	=cut
935		1296
936	sub urxvt::term::line {	1297	sub line {
937	my ($self, $row) = @_;	1298	my ($self, $row) = @_;
938		1299
939	my $maxrow = $self->nrow - 1;	1300	my $maxrow = $self->nrow - 1;
940		1301
941	my ($beg, $end) = ($row, $row);	1302	my ($beg, $end) = ($row, $row);
…		…
1005	$offset / $self->{ncol} + $self->{beg},	1366	$offset / $self->{ncol} + $self->{beg},
1006	$offset % $self->{ncol}	1367	$offset % $self->{ncol}
1007	)	1368	)
1008	}	1369	}
1009		1370
1010	=item ($row, $col) = $line->coord_of ($offset)
1011	=item $text = $term->special_encode $string	1371	=item $text = $term->special_encode $string
1012		1372
1013	Converts a perl string into the special encoding used by rxvt-unicode,	1373	Converts a perl string into the special encoding used by rxvt-unicode,
1014	where one character corresponds to one screen cell. See	1374	where one character corresponds to one screen cell. See
1015	C<< $term->ROW_t >> for details.	1375	C<< $term->ROW_t >> for details.
…		…
1017	=item $string = $term->special_decode $text	1377	=item $string = $term->special_decode $text
1018		1378
1019	Converts rxvt-unicodes text reprsentation into a perl string. See	1379	Converts rxvt-unicodes text reprsentation into a perl string. See
1020	C<< $term->ROW_t >> for details.	1380	C<< $term->ROW_t >> for details.
1021		1381
		1382	=item $success = $term->grab_button ($button, $modifiermask)
		1383
		1384	Registers a synchronous button grab. See the XGrabButton manpage.
		1385
		1386	=item $success = $term->grab ($eventtime[, $sync])
		1387
		1388	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1389	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1390
		1391	=item $term->allow_events_async
		1392
		1393	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1394
		1395	=item $term->allow_events_sync
		1396
		1397	Calls XAllowEvents with SyncBoth for the most recent grab.
		1398
		1399	=item $term->allow_events_replay
		1400
		1401	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1402	recent grab.
		1403
		1404	=item $term->ungrab
		1405
		1406	Calls XUngrab for the most recent grab. Is called automatically on
		1407	evaluation errors, as it is better to lose the grab in the error case as
		1408	the session.
		1409
1022	=back	1410	=back
1023		1411
		1412	=cut
		1413
		1414	package urxvt::popup;
		1415
1024	=head2 The C<urxvt::popup> Class	1416	=head2 The C<urxvt::popup> Class
1025		1417
1026	=over 4	1418	=over 4
1027		1419
1028	=cut	1420	=cut
1029
1030	package urxvt::popup;
1031		1421
1032	sub add_item {	1422	sub add_item {
1033	my ($self, $item) = @_;	1423	my ($self, $item) = @_;
1034		1424
1035	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};	1425	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
…		…
1039	$item->{render} \|\|= sub { $_[0]{text} };	1429	$item->{render} \|\|= sub { $_[0]{text} };
1040		1430
1041	push @{ $self->{item} }, $item;	1431	push @{ $self->{item} }, $item;
1042	}	1432	}
1043		1433
1044	sub add_separator {	1434	=item $popup->add_title ($title)
1045	my ($self, $sep) = @_;
1046		1435
1047	$sep \|\|= "═";	1436	Adds a non-clickable title to the popup.
1048		1437
1049	$self->add_item ({	1438	=cut
1050	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1051	text => "",
1052	render => sub { $sep x $urxvt::TERM->ncol },
1053	activate => sub { },
1054	});
1055	}
1056		1439
1057	sub add_title {	1440	sub add_title {
1058	my ($self, $title) = @_;	1441	my ($self, $title) = @_;
1059		1442
1060	$self->add_item ({	1443	$self->add_item ({
…		…
1062	text => $title,	1445	text => $title,
1063	activate => sub { },	1446	activate => sub { },
1064	});	1447	});
1065	}	1448	}
1066		1449
		1450	=item $popup->add_separator ([$sepchr])
		1451
		1452	Creates a separator, optionally using the character given as C<$sepchr>.
		1453
		1454	=cut
		1455
		1456	sub add_separator {
		1457	my ($self, $sep) = @_;
		1458
		1459	$sep \|\|= "=";
		1460
		1461	$self->add_item ({
		1462	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1463	text => "",
		1464	render => sub { $sep x $self->{term}->ncol },
		1465	activate => sub { },
		1466	});
		1467	}
		1468
		1469	=item $popup->add_button ($text, $cb)
		1470
		1471	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1472	selected.
		1473
		1474	=cut
		1475
1067	sub add_button {	1476	sub add_button {
1068	my ($self, $text, $cb) = @_;	1477	my ($self, $text, $cb) = @_;
1069		1478
1070	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1479	$self->add_item ({ type => "button", text => $text, activate => $cb});
1071	}	1480	}
		1481
		1482	=item $popup->add_toggle ($text, $cb, $initial_value)
		1483
		1484	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1485	whenever it gets toggled, with a boolean indicating its value as its first
		1486	argument.
		1487
		1488	=cut
1072		1489
1073	sub add_toggle {	1490	sub add_toggle {
1074	my ($self, $text, $cb, $value) = @_;	1491	my ($self, $text, $cb, $value) = @_;
1075		1492
1076	my $item; $item = {	1493	my $item; $item = {
1077	type => "button",	1494	type => "button",
1078	text => " $text",	1495	text => " $text",
1079	value => $value,	1496	value => $value,
1080	render => sub { ($item->{value} ? "* " : " ") . $text },	1497	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1081	activate => sub { $cb->($item->{value} = !$item->{value}); },	1498	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1082	};	1499	};
1083		1500
1084	$self->add_item ($item);	1501	$self->add_item ($item);
1085	}	1502	}
		1503
		1504	=item $popup->show
		1505
		1506	Displays the popup (which is initially hidden).
		1507
		1508	=cut
1086		1509
1087	sub show {	1510	sub show {
1088	my ($self) = @_;	1511	my ($self) = @_;
1089		1512
1090	local $urxvt::popup::self = $self;	1513	local $urxvt::popup::self = $self;
1091		1514
		1515	my $env = $self->{term}->env;
		1516	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1517	delete $env->{LC_ALL};
		1518	$env->{LC_CTYPE} = $self->{term}->locale;
		1519
		1520	urxvt::term->new ($env, $self->{term}->resource ("name"),
1092	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1521	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1093	"--transient-for" => $self->{term}->parent,	1522	"--transient-for" => $self->{term}->parent,
		1523	"-display" => $self->{term}->display_id,
1094	"-pe" => "urxvt-popup")	1524	"-pe" => "urxvt-popup")
1095	or die "unable to create popup window\n";	1525	or die "unable to create popup window\n";
1096	}	1526	}
1097		1527
1098	sub DESTROY {	1528	sub DESTROY {
1099	my ($self) = @_;	1529	my ($self) = @_;
1100		1530
		1531	delete $self->{term}{_destroy}{$self};
1101	$self->{term}->ungrab;	1532	$self->{term}->ungrab;
1102	}	1533	}
		1534
		1535	=back
1103		1536
1104	=head2 The C<urxvt::timer> Class	1537	=head2 The C<urxvt::timer> Class
1105		1538
1106	This class implements timer watchers/events. Time is represented as a	1539	This class implements timer watchers/events. Time is represented as a
1107	fractional number of seconds since the epoch. Example:	1540	fractional number of seconds since the epoch. Example:
…		…
1160		1593
1161	$term->{socket} = ...	1594	$term->{socket} = ...
1162	$term->{iow} = urxvt::iow	1595	$term->{iow} = urxvt::iow
1163	->new	1596	->new
1164	->fd (fileno $term->{socket})	1597	->fd (fileno $term->{socket})
1165	->events (1) # wait for read data	1598	->events (urxvt::EVENT_READ)
1166	->start	1599	->start
1167	->cb (sub {	1600	->cb (sub {
1168	my ($iow, $revents) = @_;	1601	my ($iow, $revents) = @_;
1169	# $revents must be 1 here, no need to check	1602	# $revents must be 1 here, no need to check
1170	sysread $term->{socket}, my $buf, 8192	1603	sysread $term->{socket}, my $buf, 8192
…		…
1187		1620
1188	Set the filedescriptor (not handle) to watch.	1621	Set the filedescriptor (not handle) to watch.
1189		1622
1190	=item $iow = $iow->events ($eventmask)	1623	=item $iow = $iow->events ($eventmask)
1191		1624
1192	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1625	Set the event mask to watch. The only allowed values are
1193	data, Bit #1 (value C<2>) enables watching for write data.	1626	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1627	together, or C<urxvt::EVENT_NONE>.
1194		1628
1195	=item $iow = $iow->start	1629	=item $iow = $iow->start
1196		1630
1197	Start watching for requested events on the given handle.	1631	Start watching for requested events on the given handle.
1198		1632
…		…
1209	This variable controls the verbosity level of the perl extension. Higher	1643	This variable controls the verbosity level of the perl extension. Higher
1210	numbers indicate more verbose output.	1644	numbers indicate more verbose output.
1211		1645
1212	=over 4	1646	=over 4
1213		1647
1214	=item =0 - only fatal messages	1648	=item == 0 - fatal messages
1215		1649
1216	=item =3 - script loading and management	1650	=item >= 3 - script loading and management
1217		1651
1218	=item =10 - all events received	1652	=item >=10 - all called hooks
		1653
		1654	=item >=11 - hook reutrn values
1219		1655
1220	=back	1656	=back
1221		1657
1222	=head1 AUTHOR	1658	=head1 AUTHOR
1223		1659

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC vs. Revision 1.89 by root, Thu Jan 12 12:10:06 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.54 by root, Sun Jan 8 01:59:29 2006 UTC vs.
Revision 1.89 by root, Thu Jan 12 12:10:06 2006 UTC