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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC vs.
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC vs. Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC vs.
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC