ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.13 by root, Tue Jan 3 00:06:57 2006 UTC vs.
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC

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

Diff Legend

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