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

Diff Legend

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