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

Diff Legend

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