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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.46 by root, Sat Jan 7 20:29:28 2006 UTC vs.
Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.46 by root, Sat Jan 7 20:29:28 2006 UTC vs. Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.46 by root, Sat Jan 7 20:29:28 2006 UTC vs.
Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC