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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.48 by root, Sat Jan 7 21:43:17 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	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
…		…
56		78
57	URxvt.keysym.C-M-r: perl:selection:rot13	79	URxvt.keysym.C-M-r: perl:selection:rot13
58		80
59	=back	81	=back
60		82
61	=item digital-clock	83	=item option-popup (enabled by default)
62		84
63	Displays a digital clock using the built-in overlay.	85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		86	runtime.
		87
		88	=item selection-popup (enabled by default)
		89
		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/
64		131
65	=item mark-urls	132	=item mark-urls
66		133
67	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.
68		138
69	=item block-graphics-to-ascii	139	=item block-graphics-to-ascii
70		140
71	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,
72	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
73	similar-looking ascii character.	143	similar-looking ascii character.
74		144
		145	=item digital-clock
		146
		147	Displays a digital clock using the built-in overlay.
		148
75	=item example-refresh-hooks	149	=item example-refresh-hooks
76		150
77	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
78	window. Illustrates overwriting the refresh callbacks to create your own	152	window. Illustrates overwriting the refresh callbacks to create your own
79	overlays or changes.	153	overlays or changes.
80		154
81	=back	155	=back
		156
		157	=head1 API DOCUMENTATION
82		158
83	=head2 General API Considerations	159	=head2 General API Considerations
84		160
85	All objects (such as terminals, time watchers etc.) are typical	161	All objects (such as terminals, time watchers etc.) are typical
86	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
…		…
99	=over 4	175	=over 4
100		176
101	=item $text	177	=item $text
102		178
103	Rxvt-unicodes special way of encoding text, where one "unicode" character	179	Rxvt-unicodes special way of encoding text, where one "unicode" character
104	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.
105		181
106	=item $string	182	=item $string
107		183
108	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
109	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
…		…
114	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
115	locale-specific way.	191	locale-specific way.
116		192
117	=back	193	=back
118		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
119	=head2 Hooks	228	=head2 Hooks
120		229
121	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
122	called whenever the relevant event happens.	231	called whenever the relevant event happens.
123		232
124	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
125	and extension package. You can call all C<urxvt::term> methods on it, but	234	the in the C<Extension Objects> section.
126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127	object that is shared between all packages is stored in the C<term>
128	member. It is, however, blessed intot he package of the extension script,
129	so for all practical purposes you can treat an extension script as a class.
130		235
131	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
132	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
133	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.
134		239
135	When in doubt, return a false value (preferably C<()>).	240	I<< When in doubt, return a false value (preferably C<()>). >>
136		241
137	=over 4	242	=over 4
138		243
139	=item on_init $term	244	=item on_init $term
140		245
…		…
175	=item on_sel_extend $term	280	=item on_sel_extend $term
176		281
177	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
178	click) and is either supposed to return false (normal operation), or	283	click) and is either supposed to return false (normal operation), or
179	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
180	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.
181		288
182	See the F<selection> example extension.	289	See the F<selection> example extension.
183		290
184	=item on_view_change $term, $offset	291	=item on_view_change $term, $offset
185		292
…		…
194	than the scroll back buffer or the terminal.	301	than the scroll back buffer or the terminal.
195		302
196	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,
197	$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
198	number of lines that will be in the scrollback buffer.	305	number of lines that will be in the scrollback buffer.
199
200	=item on_tty_activity $term NYI
201
202	Called whenever the program(s) running in the urxvt window send output.
203		306
204	=item on_osc_seq $term, $string	307	=item on_osc_seq $term, $string
205		308
206	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	309	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207	operating system command) is processed. Cursor position and other state	310	operating system command) is processed. Cursor position and other state
…		…
220	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
221	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
222	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
223	output.	326	output.
224		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
225	=item on_line_update $term, $row	333	=item on_line_update $term, $row
226		334
227	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
228	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
229	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,
…		…
261	=item on_focus_out $term	369	=item on_focus_out $term
262		370
263	Called wheneever the window loses keyboard focus, before rxvt-unicode does	371	Called wheneever the window loses keyboard focus, before rxvt-unicode does
264	focus out processing.	372	focus out processing.
265		373
266	=item on_key_press $term, $event, $octets	374	=item on_key_press $term, $event, $keysym, $octets
267		375
268	=item on_key_release $term, $event	376	=item on_key_release $term, $event, $keysym
269		377
270	=item on_button_press $term, $event	378	=item on_button_press $term, $event
271		379
272	=item on_button_release $term, $event	380	=item on_button_release $term, $event
273		381
…		…
289		397
290	subwindow.	398	subwindow.
291		399
292	=back	400	=back
293		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
294	=head2 Variables in the C<urxvt> Package	423	=head2 Variables in the C<urxvt> Package
295		424
296	=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>.
297		439
298	=item $urxvt::TERM	440	=item $urxvt::TERM
299		441
300	The current terminal. This variable stores the current C<urxvt::term>	442	The current terminal. This variable stores the current C<urxvt::term>
301	object, whenever a callback/hook is executing.	443	object, whenever a callback/hook is executing.
…		…
303	=back	445	=back
304		446
305	=head2 Functions in the C<urxvt> Package	447	=head2 Functions in the C<urxvt> Package
306		448
307	=over 4	449	=over 4
308
309	=item $term = new urxvt [arg...]
310
311	Creates a new terminal, very similar as if you had started it with
312	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
313	if the new instance couldn't be created. Returns C<undef> if the new
314	instance didn't initialise perl, and the terminal object otherwise. The
315	C<init> and C<start> hooks will be called during the call.
316		450
317	=item urxvt::fatal $errormessage	451	=item urxvt::fatal $errormessage
318		452
319	Fatally aborts execution with the given error message. Avoid at all	453	Fatally aborts execution with the given error message. Avoid at all
320	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
…		…
327	that calls this function.	461	that calls this function.
328		462
329	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
330	correct place, e.g. on stderr of the connecting urxvtc client.	464	correct place, e.g. on stderr of the connecting urxvtc client.
331		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
332	=item $time = urxvt::NOW	474	=item $time = urxvt::NOW
333		475
334	Returns the "current time" (as per the event loop).	476	Returns the "current time" (as per the event loop).
335		477
336	=item urxvt::CurrentTime	478	=item urxvt::CurrentTime
337		479
338	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	480	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	481	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340	Button4Mask, Button5Mask, AnyModifier	482	Button4Mask, Button5Mask, AnyModifier
341		483
342	Various constants for use in X events.	484	Various constants for use in X calls and event processing.
343		485
344	=back	486	=back
345		487
346	=head2 RENDITION	488	=head2 RENDITION
347		489
…		…
374		516
375	=item $background = urxvt::GET_BASEBG $rend	517	=item $background = urxvt::GET_BASEBG $rend
376		518
377	Return the foreground/background colour index, respectively.	519	Return the foreground/background colour index, respectively.
378		520
379	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	521	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
380		522
381	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	523	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
382		524
383	Replace the foreground/background colour in the rendition mask with the	525	Replace the foreground/background colour in the rendition mask with the
384	specified one.	526	specified one.
385		527
386	=item $value = urxvt::GET_CUSTOM ($rend)	528	=item $value = urxvt::GET_CUSTOM $rend
387		529
388	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
389	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
390	zero.	532	zero.
391		533
392	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	534	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
393		535
394	Change the custom value.	536	Change the custom value.
395		537
396	=back	538	=back
397		539
398	=cut	540	=cut
399
400	package urxvt;
401
402	use utf8;
403	use strict;
404	use Scalar::Util ();
405	use List::Util ();
406
407	our $TERM;
408	our @HOOKNAME;
409	our $LIBDIR;
410		541
411	BEGIN {	542	BEGIN {
412	urxvt->bootstrap;	543	urxvt->bootstrap;
413		544
414	# overwrite perl's warn	545	# overwrite perl's warn
…		…
416	my $msg = join "", @_;	547	my $msg = join "", @_;
417	$msg .= "\n"	548	$msg .= "\n"
418	unless $msg =~ /\n$/;	549	unless $msg =~ /\n$/;
419	urxvt::warn ($msg);	550	urxvt::warn ($msg);
420	};	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";
421	}	558	}
422		559
423	my @hook_count;	560	my @hook_count;
424	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	561	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
425		562
426	sub verbose {	563	sub verbose {
427	my ($level, $msg) = @_;	564	my ($level, $msg) = @_;
428	warn "$msg\n" if $level <= $verbosity;	565	warn "$msg\n" if $level <= $verbosity;
429	}	566	}
430		567
431	# find on_xxx subs in the package and register them
432	# as hooks
433	sub register_package($) {
434	my ($pkg) = @_;
435
436	for my $htype (0.. $#HOOKNAME) {
437	my $name = $HOOKNAME[$htype];
438
439	my $ref = $pkg->can ("on_" . lc $name)
440	or next;
441
442	$TERM->{_hook}[$htype]{$pkg} = $ref;
443	$hook_count[$htype]++
444	or set_should_invoke $htype, 1;
445	}
446	}
447
448	my $extension_pkg = "extension0000";	568	my $extension_pkg = "extension0000";
449	my %extension_pkg;	569	my %extension_pkg;
450		570
451	# load a single script into its own package, once only	571	# load a single script into its own package, once only
452	sub extension_package($) {	572	sub extension_package($) {
…		…
458	verbose 3, "loading extension '$path' into package '$pkg'";	578	verbose 3, "loading extension '$path' into package '$pkg'";
459		579
460	open my $fh, "<:raw", $path	580	open my $fh, "<:raw", $path
461	or die "$path: $!";	581	or die "$path: $!";
462		582
		583	my $source = untaint
463	my $source = "package $pkg; use strict; use utf8;\n"	584	"package $pkg; use strict; use utf8;\n"
464	. "use base urxvt::term::proxy::;\n"	585	. "use base urxvt::term::extension::;\n"
465	. "#line 1 \"$path\"\n{\n"	586	. "#line 1 \"$path\"\n{\n"
466	. (do { local $/; <$fh> })	587	. (do { local $/; <$fh> })
467	. "\n};\n1";	588	. "\n};\n1";
468		589
		590	eval $source
469	eval $source or die "$path: $@";	591	or die "$path: $@";
470		592
471	$pkg	593	$pkg
472	}	594	}
473	}	595	}
474		596
…		…
479	local $TERM = shift;	601	local $TERM = shift;
480	my $htype = shift;	602	my $htype = shift;
481		603
482	if ($htype == 0) { # INIT	604	if ($htype == 0) { # INIT
483	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	605	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		606
		607	my %ext_arg;
484		608
485	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	609	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		610	if ($_ eq "default") {
		611	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		612	} elsif (/^-(.*)$/) {
		613	delete $ext_arg{$1};
		614	} elsif (/^([^<]+)<(.*)>$/) {
		615	push @{ $ext_arg{$1} }, $2;
		616	} else {
		617	$ext_arg{$_} \|\|= [];
		618	}
		619	}
		620
		621	while (my ($ext, $argv) = each %ext_arg) {
486	my @files = grep -f $_, map "$_/$ext", @dirs;	622	my @files = grep -f $_, map "$_/$ext", @dirs;
487		623
488	if (@files) {	624	if (@files) {
489	register_package extension_package $files[0];	625	$TERM->register_package (extension_package $files[0], $argv);
490	} else {	626	} else {
491	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";
492	}	628	}
493	}	629	}
		630
		631	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		632	warn $@ if $@;
494	}	633	}
495		634
496	$retval = undef;	635	$retval = undef;
497		636
498	if (my $cb = $TERM->{_hook}[$htype]) {	637	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
500	if $verbosity >= 10;	639	if $verbosity >= 10;
501		640
502	keys %$cb;	641	keys %$cb;
503		642
504	while (my ($pkg, $cb) = each %$cb) {	643	while (my ($pkg, $cb) = each %$cb) {
505	eval {	644	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
506	$retval = $cb->(
507	$TERM->{_pkg}{$pkg} \|\|= do {
508	my $proxy = bless { }, $pkg;
509	Scalar::Util::weaken ($proxy->{term} = $TERM);
510	$proxy
511	},
512	@_,
513	) and last;	645	and last;
		646
		647	if ($@) {
		648	$TERM->ungrab; # better to lose the grab than the session
		649	warn $@;
514	};	650	}
515	warn $@ if $@;#d#
516	}	651	}
		652
		653	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		654	if $verbosity >= 11;
517	}	655	}
518		656
519	if ($htype == 1) { # DESTROY	657	if ($htype == 1) { # DESTROY
520	# remove hooks if unused
521	if (my $hook = $TERM->{_hook}) {	658	if (my $hook = delete $TERM->{_hook}) {
522	for my $htype (0..$#$hook) {	659	for my $htype (0..$#$hook) {
523	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	660	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
524	or set_should_invoke $htype, 0;	661	or set_should_invoke $htype, 0;
525	}	662	}
526	}	663	}
…		…
533	}	670	}
534		671
535	$retval	672	$retval
536	}	673	}
537		674
538	sub urxvt::term::proxy::AUTOLOAD {	675	sub exec_async(@) {
539	$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 =~ /:([^:]+)$/
540	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	729	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
541		730
542	eval qq{	731	eval qq{
543	sub $urxvt::term::proxy::AUTOLOAD {	732	sub $AUTOLOAD {
544	my \$proxy = shift;	733	my \$proxy = shift;
545	\$proxy->{term}->$1 (\@_)	734	\$proxy->{term}->$1 (\@_)
546	}	735	}
547	1	736	1
548	} or die "FATAL: unable to compile method forwarder: $@";	737	} or die "FATAL: unable to compile method forwarder: $@";
549		738
550	goto &$urxvt::term::proxy::AUTOLOAD;	739	goto &$AUTOLOAD;
551	}	740	}
		741
		742	sub DESTROY {
		743	# nop
		744	}
		745
		746	# urxvt::destroy_hook
552		747
553	sub urxvt::destroy_hook::DESTROY {	748	sub urxvt::destroy_hook::DESTROY {
554	${$_[0]}->();	749	${$_[0]}->();
555	}	750	}
556		751
557	sub urxvt::destroy_hook(&) {	752	sub urxvt::destroy_hook(&) {
558	bless \shift, urxvt::destroy_hook::	753	bless \shift, urxvt::destroy_hook::
559	}	754	}
560		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
561	=head2 The C<urxvt::term> Class	826	=head2 The C<urxvt::term> Class
562		827
563	=over 4	828	=over 4
564		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
565	=item $term->destroy	871	=item $term->destroy
566		872
567	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.
		876
		877	=item $isset = $term->option ($optval[, $set])
		878
		879	Returns true if the option specified by C<$optval> is enabled, and
		880	optionally change it. All option values are stored by name in the hash
		881	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		882
		883	Here is a a likely non-exhaustive list of option names, please see the
		884	source file F</src/optinc.h> to see the actual list:
		885
		886	borderLess console cursorBlink cursorUnderline hold iconic insecure
		887	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		888	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		889	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		890	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		891	tripleclickwords utmpInhibit visualBell
568		892
569	=item $value = $term->resource ($name[, $newval])	893	=item $value = $term->resource ($name[, $newval])
570		894
571	Returns the current resource value associated with a given name and	895	Returns the current resource value associated with a given name and
572	optionally sets a new value. Setting values is most useful in the C<init>	896	optionally sets a new value. Setting values is most useful in the C<init>
…		…
582		906
583	Please note that resource strings will currently only be freed when the	907	Please note that resource strings will currently only be freed when the
584	terminal is destroyed, so changing options frequently will eat memory.	908	terminal is destroyed, so changing options frequently will eat memory.
585		909
586	Here is a a likely non-exhaustive list of resource names, not all of which	910	Here is a a likely non-exhaustive list of resource names, not all of which
587	are supported in every build, please see the source to see the actual	911	are supported in every build, please see the source file F</src/rsinc.h>
588	list:	912	to see the actual list:
589		913
590	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	914	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
591	borderLess color cursorBlink cursorUnderline cutchars delete_key	915	borderLess color cursorBlink cursorUnderline cutchars delete_key
592	display_name embed ext_bwidth fade font geometry hold iconName	916	display_name embed ext_bwidth fade font geometry hold iconName
593	imFont imLocale inputMethod insecure int_bwidth intensityStyles	917	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
600	shade term_name title transparent transparent_all tripleclickwords	924	shade term_name title transparent transparent_all tripleclickwords
601	utmpInhibit visualBell	925	utmpInhibit visualBell
602		926
603	=cut	927	=cut
604		928
605	sub urxvt::term::resource($$;$) {	929	sub resource($$;$) {
606	my ($self, $name) = (shift, shift);	930	my ($self, $name) = (shift, shift);
607	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	931	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
608	&urxvt::term::_resource	932	&urxvt::term::_resource
609	}	933	}
610		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
611	=item $rend = $term->rstyle ([$new_rstyle])	951	=item $rend = $term->rstyle ([$new_rstyle])
612		952
613	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
614	the terminal application will use this style.	954	the terminal application will use this style.
615		955
…		…
625	=item ($row, $col) = $term->selection_end ([$row, $col])	965	=item ($row, $col) = $term->selection_end ([$row, $col])
626		966
627	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,
628	and optionally set them to new values.	968	and optionally set them to new values.
629		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
630	=item $success = $term->selection_grab ($eventtime)	977	=item $success = $term->selection_grab ($eventtime)
631		978
632	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
633	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.
634		982
635	=item $oldtext = $term->selection ([$newtext])	983	=item $oldtext = $term->selection ([$newtext])
636		984
637	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>.
638		986
639	#=item $term->overlay ($x, $y, $text)	987	=item $term->overlay_simple ($x, $y, $text)
640	#	988
641	#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.
642	#	990
643	#=cut	991	=cut
644	#	992
645	#sub urxvt::term::scr_overlay {	993	sub overlay_simple {
646	# my ($self, $x, $y, $text) = @_;	994	my ($self, $x, $y, $text) = @_;
647	#	995
648	# my @lines = split /\n/, $text;	996	my @lines = split /\n/, $text;
649	#	997
650	# my $w = 0;	998	my $w = List::Util::max map $self->strwidth ($_), @lines;
651	# for (map $self->strwidth ($_), @lines) {	999
652	# $w = $_ if $w < $_;
653	# }
654	#
655	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1000	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
656	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1001	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
657	#}	1002
		1003	$overlay
		1004	}
658		1005
659	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1006	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
660		1007
661	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
662	width/height. C<$rstyle> defines the initial rendition style	1009	width/height. C<$rstyle> defines the initial rendition style
…		…
697	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,
698	currently).	1045	currently).
699		1046
700	=cut	1047	=cut
701		1048
702	sub urxvt::term::popup {	1049	sub popup {
703	my ($self, $event) = @_;	1050	my ($self, $event) = @_;
704		1051
705	$self->grab ($event->{time}, 1)	1052	$self->grab ($event->{time}, 1)
706	or return;	1053	or return;
707		1054
…		…
729		1076
730	=item $string = $term->locale_decode ($octets)	1077	=item $string = $term->locale_decode ($octets)
731		1078
732	Convert the given locale-encoded octets into a perl string.	1079	Convert the given locale-encoded octets into a perl string.
733		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
734	=item $term->scr_add_lines ($string)	1098	=item $term->scr_add_lines ($string)
735		1099
736	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
737	running inside the terminal. It may not contain command sequences (escape	1101	running inside the terminal. It may not contain command sequences (escape
738	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
…		…
752		1116
753	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
754	pass characters instead of octets, you should convert your strings first	1118	pass characters instead of octets, you should convert your strings first
755	to the locale-specific encoding using C<< $term->locale_encode >>.	1119	to the locale-specific encoding using C<< $term->locale_encode >>.
756		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
757	=item $windowid = $term->parent	1128	=item $windowid = $term->parent
758		1129
759	Return the window id of the toplevel window.	1130	Return the window id of the toplevel window.
760		1131
761	=item $windowid = $term->vt	1132	=item $windowid = $term->vt
…		…
785	=item $nrow_plus_saveLines = $term->total_rows	1156	=item $nrow_plus_saveLines = $term->total_rows
786		1157
787	=item $lines_in_scrollback = $term->nsaved	1158	=item $lines_in_scrollback = $term->nsaved
788		1159
789	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	}
790		1184
791	=item $modifiermask = $term->ModLevel3Mask	1185	=item $modifiermask = $term->ModLevel3Mask
792		1186
793	=item $modifiermask = $term->ModMetaMask	1187	=item $modifiermask = $term->ModMetaMask
794		1188
…		…
887	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.
888		1282
889	=item $offset = $line->offset_of ($row, $col)	1283	=item $offset = $line->offset_of ($row, $col)
890		1284
891	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
892	line.	1286	line. Works for rows outside the line, too, and returns corresponding
		1287	offsets outside the string.
893		1288
894	=item ($row, $col) = $line->coord_of ($offset)	1289	=item ($row, $col) = $line->coord_of ($offset)
895		1290
896	Translates a string offset into terminal coordinates again.	1291	Translates a string offset into terminal coordinates again.
897		1292
898	=back	1293	=back
899		1294
900	=cut	1295	=cut
901		1296
902	sub urxvt::term::line {	1297	sub line {
903	my ($self, $row) = @_;	1298	my ($self, $row) = @_;
904		1299
905	my $maxrow = $self->nrow - 1;	1300	my $maxrow = $self->nrow - 1;
906		1301
907	my ($beg, $end) = ($row, $row);	1302	my ($beg, $end) = ($row, $row);
…		…
971	$offset / $self->{ncol} + $self->{beg},	1366	$offset / $self->{ncol} + $self->{beg},
972	$offset % $self->{ncol}	1367	$offset % $self->{ncol}
973	)	1368	)
974	}	1369	}
975		1370
976	=item ($row, $col) = $line->coord_of ($offset)
977	=item $text = $term->special_encode $string	1371	=item $text = $term->special_encode $string
978		1372
979	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,
980	where one character corresponds to one screen cell. See	1374	where one character corresponds to one screen cell. See
981	C<< $term->ROW_t >> for details.	1375	C<< $term->ROW_t >> for details.
…		…
983	=item $string = $term->special_decode $text	1377	=item $string = $term->special_decode $text
984		1378
985	Converts rxvt-unicodes text reprsentation into a perl string. See	1379	Converts rxvt-unicodes text reprsentation into a perl string. See
986	C<< $term->ROW_t >> for details.	1380	C<< $term->ROW_t >> for details.
987		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
988	=back	1410	=back
989		1411
		1412	=cut
		1413
		1414	package urxvt::popup;
		1415
990	=head2 The C<urxvt::popup> Class	1416	=head2 The C<urxvt::popup> Class
991		1417
992	=over 4	1418	=over 4
993		1419
994	=cut	1420	=cut
995
996	package urxvt::popup;
997		1421
998	sub add_item {	1422	sub add_item {
999	my ($self, $item) = @_;	1423	my ($self, $item) = @_;
1000		1424
		1425	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1426	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1427	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1428
		1429	$item->{render} \|\|= sub { $_[0]{text} };
		1430
1001	push @{ $self->{item} }, $item;	1431	push @{ $self->{item} }, $item;
1002	}	1432	}
		1433
		1434	=item $popup->add_title ($title)
		1435
		1436	Adds a non-clickable title to the popup.
		1437
		1438	=cut
		1439
		1440	sub add_title {
		1441	my ($self, $title) = @_;
		1442
		1443	$self->add_item ({
		1444	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1445	text => $title,
		1446	activate => sub { },
		1447	});
		1448	}
		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
1003		1475
1004	sub add_button {	1476	sub add_button {
1005	my ($self, $text, $cb) = @_;	1477	my ($self, $text, $cb) = @_;
1006		1478
1007	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,	1479	$self->add_item ({ type => "button", text => $text, activate => $cb});
1008	render => sub { $_[0]{text} },
1009	});
1010	}	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
1011		1489
1012	sub add_toggle {	1490	sub add_toggle {
1013	my ($self, $text, $cb, $value) = @_;	1491	my ($self, $text, $cb, $value) = @_;
1014		1492
1015	$self->add_item ({ type => "button", text => " $text", value => $value,	1493	my $item; $item = {
		1494	type => "button",
		1495	text => " $text",
		1496	value => $value,
1016	render => sub { ($_[0]{value} ? "✔" : " ") . substr $_[0]{text}, 1 },	1497	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1017	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1498	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1018	});	1499	};
		1500
		1501	$self->add_item ($item);
1019	}	1502	}
		1503
		1504	=item $popup->show
		1505
		1506	Displays the popup (which is initially hidden).
		1507
		1508	=cut
1020		1509
1021	sub show {	1510	sub show {
1022	my ($self) = @_;	1511	my ($self) = @_;
1023		1512
1024	local $urxvt::popup::self = $self;	1513	local $urxvt::popup::self = $self;
1025		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"),
1026	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,
1027	"--transient-for" => $self->{term}->parent,	1522	"--transient-for" => $self->{term}->parent,
		1523	"-display" => $self->{term}->display_id,
1028	"-pe" => "urxvt-popup")	1524	"-pe" => "urxvt-popup")
1029	or die "unable to create popup window\n";	1525	or die "unable to create popup window\n";
1030	}	1526	}
1031		1527
1032	sub DESTROY {	1528	sub DESTROY {
1033	my ($self) = @_;	1529	my ($self) = @_;
1034		1530
		1531	delete $self->{term}{_destroy}{$self};
1035	$self->{term}->ungrab;	1532	$self->{term}->ungrab;
1036	}	1533	}
		1534
		1535	=back
1037		1536
1038	=head2 The C<urxvt::timer> Class	1537	=head2 The C<urxvt::timer> Class
1039		1538
1040	This class implements timer watchers/events. Time is represented as a	1539	This class implements timer watchers/events. Time is represented as a
1041	fractional number of seconds since the epoch. Example:	1540	fractional number of seconds since the epoch. Example:
…		…
1094		1593
1095	$term->{socket} = ...	1594	$term->{socket} = ...
1096	$term->{iow} = urxvt::iow	1595	$term->{iow} = urxvt::iow
1097	->new	1596	->new
1098	->fd (fileno $term->{socket})	1597	->fd (fileno $term->{socket})
1099	->events (1) # wait for read data	1598	->events (urxvt::EVENT_READ)
1100	->start	1599	->start
1101	->cb (sub {	1600	->cb (sub {
1102	my ($iow, $revents) = @_;	1601	my ($iow, $revents) = @_;
1103	# $revents must be 1 here, no need to check	1602	# $revents must be 1 here, no need to check
1104	sysread $term->{socket}, my $buf, 8192	1603	sysread $term->{socket}, my $buf, 8192
…		…
1121		1620
1122	Set the filedescriptor (not handle) to watch.	1621	Set the filedescriptor (not handle) to watch.
1123		1622
1124	=item $iow = $iow->events ($eventmask)	1623	=item $iow = $iow->events ($eventmask)
1125		1624
1126	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
1127	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>.
1128		1628
1129	=item $iow = $iow->start	1629	=item $iow = $iow->start
1130		1630
1131	Start watching for requested events on the given handle.	1631	Start watching for requested events on the given handle.
1132		1632
…		…
1143	This variable controls the verbosity level of the perl extension. Higher	1643	This variable controls the verbosity level of the perl extension. Higher
1144	numbers indicate more verbose output.	1644	numbers indicate more verbose output.
1145		1645
1146	=over 4	1646	=over 4
1147		1647
1148	=item =0 - only fatal messages	1648	=item == 0 - fatal messages
1149		1649
1150	=item =3 - script loading and management	1650	=item >= 3 - script loading and management
1151		1651
1152	=item =10 - all events received	1652	=item >=10 - all called hooks
		1653
		1654	=item >=11 - hook reutrn values
1153		1655
1154	=back	1656	=back
1155		1657
1156	=head1 AUTHOR	1658	=head1 AUTHOR
1157		1659

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.48 by root, Sat Jan 7 21:43:17 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.48 by root, Sat Jan 7 21:43:17 2006 UTC vs.
Revision 1.89 by root, Thu Jan 12 12:10:06 2006 UTC