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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.45 by root, Sat Jan 7 20:23:52 2006 UTC vs. Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.45 by root, Sat Jan 7 20:23:52 2006 UTC vs.
Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC