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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC vs.
Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC vs. Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC vs.
Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC