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.16 by root, Tue Jan 3 01:41:06 2006 UTC vs.
Revision 1.80 by root, Thu Jan 12 00:11:59 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 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
55		100
56	Displays a very simple digital clock in the upper right corner of the	101	Displays a very simple digital clock in the upper right corner of the
57	window. Illustrates overwriting the refresh callbacks to create your own	102	window. Illustrates overwriting the refresh callbacks to create your own
58	overlays or changes.	103	overlays or changes.
59		104
60	=item simple-overlay-clock
61
62	Displays a digital clock using the built-in overlay (colorful, useless).
63
64	=back	105	=back
		106
		107	=head1 API DOCUMENTATION
65		108
66	=head2 General API Considerations	109	=head2 General API Considerations
67		110
68	All objects (such as terminals, time watchers etc.) are typical	111	All objects (such as terminals, time watchers etc.) are typical
69	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
70	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
71	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
72	modified).	115	modified).
73		116
74	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
75	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
76	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
77	terminal is destroyed.	120	terminal is destroyed.
78		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
79	=head2 Hooks	178	=head2 Hooks
80		179
81	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
82	whenever the relevant event happens.	181	called whenever the relevant event happens.
83		182
		183	The first argument passed to them is an extension oject as described in
		184	the in the C<Extension Objects> section.
		185
84	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
85	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
86	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.
87		189
88	When in doubt, return a false value (preferably C<()>).	190	I<< When in doubt, return a false value (preferably C<()>). >>
89		191
90	=over 4	192	=over 4
91		193
92	=item on_init $term	194	=item on_init $term
93		195
94	Called after a new terminal object has been initialized, but before	196	Called after a new terminal object has been initialized, but before
95	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.
96		201
97	=item on_reset $term	202	=item on_reset $term
98		203
99	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
100	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
…		…
120	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
121	by calling C<< $term->selection >>.	226	by calling C<< $term->selection >>.
122		227
123	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.
124		229
125	=item on_focus_in $term	230	=item on_sel_extend $term
126		231
127	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
128	focus in processing.	233	click) and is either supposed to return false (normal operation), or
129		234	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.	235	processing.
		236
		237	See the F<selection> example extension.
134		238
135	=item on_view_change $term, $offset	239	=item on_view_change $term, $offset
136		240
137	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
138	scrolls. Offset C<0> means display the normal terminal, positive values	242	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
146		250
147	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,
148	$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
149	number of lines that will be in the scrollback buffer.	253	number of lines that will be in the scrollback buffer.
150		254
151	=item on_tty_activity $term *NYI*	255	=item on_osc_seq $term, $string
152		256
153	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.
154		294
155	=item on_refresh_begin $term	295	=item on_refresh_begin $term
156		296
157	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
158	or similar effects by modify terminal contents in refresh_begin, and	298	or similar effects by modify terminal contents in refresh_begin, and
…		…
167		307
168	Called whenever the user presses a key combination that has a	308	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>	309	C<perl:string> action bound to it (see description of the B<keysym>
170	resource in the @@RXVT_NAME@@(1) manpage).	310	resource in the @@RXVT_NAME@@(1) manpage).
171		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
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 C<%ENV>-like
		788	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 $value = $term->x_resource ($pattern)
		868
		869	Returns the X-Resource for the given pattern, excluding the program or
		870	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		871	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		872	resource with that pattern exists.
		873
		874	This method should only be called during the C<on_start> hook, as there is
		875	only one resource database per display, and later invocations might return
		876	the wrong resources.
		877
		878	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		879
		880	Adds a keymap translation exactly as specified via a resource. See the
		881	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		882
		883	=item $rend = $term->rstyle ([$new_rstyle])
		884
		885	Return and optionally change the current rendition. Text that is output by
		886	the terminal application will use this style.
		887
		888	=item ($row, $col) = $term->screen_cur ([$row, $col])
		889
		890	Return the current coordinates of the text cursor position and optionally
		891	set it (which is usually bad as applications don't expect that).
357		892
358	=item ($row, $col) = $term->selection_mark ([$row, $col])	893	=item ($row, $col) = $term->selection_mark ([$row, $col])
359		894
360	=item ($row, $col) = $term->selection_beg ([$row, $col])	895	=item ($row, $col) = $term->selection_beg ([$row, $col])
361		896
…		…
371		906
372	=item $oldtext = $term->selection ([$newtext])	907	=item $oldtext = $term->selection ([$newtext])
373		908
374	Return the current selection text and optionally replace it by C<$newtext>.	909	Return the current selection text and optionally replace it by C<$newtext>.
375		910
376	=item $term->scr_overlay ($x, $y, $text)	911	=item $term->overlay_simple ($x, $y, $text)
377		912
378	Create a simple multi-line overlay box. See the next method for details.	913	Create a simple multi-line overlay box. See the next method for details.
379		914
380	=cut	915	=cut
381		916
382	sub urxvt::term::scr_overlay {	917	sub overlay_simple {
383	my ($self, $x, $y, $text) = @_;	918	my ($self, $x, $y, $text) = @_;
384		919
385	my @lines = split /\n/, $text;	920	my @lines = split /\n/, $text;
386		921
387	my $w = 0;	922	my $w = List::Util::max map $self->strwidth ($_), @lines;
388	for (map $self->strwidth ($_), @lines) {
389	$w = $_ if $w < $_;
390	}
391		923
392	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	924	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
393	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	925	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
394	}
395		926
		927	$overlay
		928	}
		929
396	=item $term->scr_overlay_new ($x, $y, $width, $height)	930	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
397		931
398	Create a new (empty) overlay at the given position with the given	932	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	933	width/height. C<$rstyle> defines the initial rendition style
400	C<$y> is negative, then this is counted from the right/bottom side,	934	(default: C<OVERLAY_RSTYLE>).
401	respectively.
402		935
403	=item $term->scr_overlay_off	936	If C<$border> is C<2> (default), then a decorative border will be put
		937	around the box.
404		938
405	Switch the overlay off again.	939	If either C<$x> or C<$y> is negative, then this is counted from the
		940	right/bottom side, respectively.
406		941
407	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	942	This method returns an urxvt::overlay object. The overlay will be visible
		943	as long as the perl object is referenced.
408		944
409	Put a single character (specified numerically) at the given overlay	945	The methods currently supported on C<urxvt::overlay> objects are:
410	position.
411		946
		947	=over 4
		948
412	=item $term->scr_overlay_set ($x, $y, $text)	949	=item $overlay->set ($x, $y, $text, $rend)
413		950
414	Write a string at the given position into the overlay.	951	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		952	text in rxvt-unicode's special encoding and an array of rendition values
		953	at a specific position inside the overlay.
415		954
		955	=item $overlay->hide
		956
		957	If visible, hide the overlay, but do not destroy it.
		958
		959	=item $overlay->show
		960
		961	If hidden, display the overlay again.
		962
		963	=back
		964
		965	=item $popup = $term->popup ($event)
		966
		967	Creates a new C<urxvt::popup> object that implements a popup menu. The
		968	C<$event> I<must> be the event causing the menu to pop up (a button event,
		969	currently).
		970
		971	=cut
		972
		973	sub popup {
		974	my ($self, $event) = @_;
		975
		976	$self->grab ($event->{time}, 1)
		977	or return;
		978
		979	my $popup = bless {
		980	term => $self,
		981	event => $event,
		982	}, urxvt::popup::;
		983
		984	Scalar::Util::weaken $popup->{term};
		985
		986	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		987	Scalar::Util::weaken $self->{_destroy}{$popup};
		988
		989	$popup
		990	}
		991
416	=item $cellwidth = $term->strwidth $string	992	=item $cellwidth = $term->strwidth ($string)
417		993
418	Returns the number of screen-cells this string would need. Correctly	994	Returns the number of screen-cells this string would need. Correctly
419	accounts for wide and combining characters.	995	accounts for wide and combining characters.
420		996
421	=item $octets = $term->locale_encode $string	997	=item $octets = $term->locale_encode ($string)
422		998
423	Convert the given text string into the corresponding locale encoding.	999	Convert the given text string into the corresponding locale encoding.
424		1000
425	=item $string = $term->locale_decode $octets	1001	=item $string = $term->locale_decode ($octets)
426		1002
427	Convert the given locale-encoded octets into a perl string.	1003	Convert the given locale-encoded octets into a perl string.
		1004
		1005	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1006
		1007	XORs the rendition values in the given span with the provided value
		1008	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		1009	to the selection.
		1010
		1011	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1012
		1013	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1014	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1015	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1016	it instead.
		1017
		1018	=item $term->scr_bell
		1019
		1020	Ring the bell!
		1021
		1022	=item $term->scr_add_lines ($string)
		1023
		1024	Write the given text string to the screen, as if output by the application
		1025	running inside the terminal. It may not contain command sequences (escape
		1026	codes), but is free to use line feeds, carriage returns and tabs. The
		1027	string is a normal text string, not in locale-dependent encoding.
		1028
		1029	Normally its not a good idea to use this function, as programs might be
		1030	confused by changes in cursor position or scrolling. Its useful inside a
		1031	C<on_add_lines> hook, though.
		1032
		1033	=item $term->cmd_parse ($octets)
		1034
		1035	Similar to C<scr_add_lines>, but the argument must be in the
		1036	locale-specific encoding of the terminal and can contain command sequences
		1037	(escape codes) that will be interpreted.
428		1038
429	=item $term->tt_write ($octets)	1039	=item $term->tt_write ($octets)
430		1040
431	Write the octets given in C<$data> to the tty (i.e. as program input). To	1041	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	1042	pass characters instead of octets, you should convert your strings first
433	to the locale-specific encoding using C<< $term->locale_encode >>.	1043	to the locale-specific encoding using C<< $term->locale_encode >>.
434		1044
		1045	=item $old_events = $term->pty_ev_events ([$new_events])
		1046
		1047	Replaces the event mask of the pty watcher by the given event mask. Can
		1048	be used to suppress input and output handling to the pty/tty. See the
		1049	description of C<< urxvt::timer->events >>. Make sure to always restore
		1050	the previous value.
		1051
		1052	=item $windowid = $term->parent
		1053
		1054	Return the window id of the toplevel window.
		1055
		1056	=item $windowid = $term->vt
		1057
		1058	Return the window id of the terminal window.
		1059
		1060	=item $window_width = $term->width
		1061
		1062	=item $window_height = $term->height
		1063
		1064	=item $font_width = $term->fwidth
		1065
		1066	=item $font_height = $term->fheight
		1067
		1068	=item $font_ascent = $term->fbase
		1069
435	=item $nrow = $term->nrow	1070	=item $terminal_rows = $term->nrow
436		1071
437	=item $ncol = $term->ncol	1072	=item $terminal_columns = $term->ncol
438		1073
439	Return the number of rows/columns of the terminal window (i.e. as	1074	=item $has_focus = $term->focus
440	specified by C<-geometry>, excluding any scrollback).
441		1075
		1076	=item $is_mapped = $term->mapped
		1077
		1078	=item $max_scrollback = $term->saveLines
		1079
		1080	=item $nrow_plus_saveLines = $term->total_rows
		1081
		1082	=item $lines_in_scrollback = $term->nsaved
		1083
		1084	Return various integers describing terminal characteristics.
		1085
		1086	=item $x_display = $term->display_id
		1087
		1088	Return the DISPLAY used by rxvt-unicode.
		1089
		1090	=item $lc_ctype = $term->locale
		1091
		1092	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1093
442	=item $nsaved = $term->nsaved	1094	=item $env = $term->env
443		1095
444	Returns the number of lines in the scrollback buffer.	1096	Returns a copy of the environment in effect for the terminal as a hashref
		1097	similar to C<\%ENV>.
		1098
		1099	=cut
		1100
		1101	sub env {
		1102	if (my $env = $_[0]->_env) {
		1103	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1104	} else {
		1105	+{ %ENV }
		1106	}
		1107	}
		1108
		1109	=item $modifiermask = $term->ModLevel3Mask
		1110
		1111	=item $modifiermask = $term->ModMetaMask
		1112
		1113	=item $modifiermask = $term->ModNumLockMask
		1114
		1115	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1116	AltGr), the meta key (often Alt) and the num lock key, if applicable.
445		1117
446	=item $view_start = $term->view_start ([$newvalue])	1118	=item $view_start = $term->view_start ([$newvalue])
447		1119
448	Returns the negative row number of the topmost line. Minimum value is	1120	Returns the negative row number of the topmost line. Minimum value is
449	C<0>, which displays the normal terminal contents. Larger values scroll	1121	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
460	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1132	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
461		1133
462	Returns the text of the entire row with number C<$row_number>. Row C<0>	1134	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	1135	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	1136	terminal line. The scrollback buffer starts at line C<-1> and extends to
465	line C<< -$term->nsaved >>.	1137	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		1138	is requested.
466		1139
467	If C<$new_text> is specified, it will replace characters in the current	1140	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	1141	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	1142	to replace only parts of a line. The font index in the rendition will
470	automatically be updated.	1143	automatically be updated.
471		1144
472	C<$text> is in a special encoding: tabs and wide characters that use more	1145	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	1146	than one cell when displayed are padded with urxvt::NOCHAR characters
474	(C<chr 65535>). Characters with combining characters and other characters	1147	(C<chr 65535>). Characters with combining characters and other characters
…		…
488	bitsets. Rendition bitsets contain information about colour, font, font	1161	bitsets. Rendition bitsets contain information about colour, font, font
489	styles and similar information. See also C<< $term->ROW_t >>.	1162	styles and similar information. See also C<< $term->ROW_t >>.
490		1163
491	When setting rendition, the font mask will be ignored.	1164	When setting rendition, the font mask will be ignored.
492		1165
493	See the section on RENDITION, below.	1166	See the section on RENDITION, above.
494		1167
495	=item $length = $term->ROW_l ($row_number[, $new_length])	1168	=item $length = $term->ROW_l ($row_number[, $new_length])
496		1169
497	Returns the number of screen cells that are in use ("the line length"). If	1170	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	1171	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.	1172	line is joined with the following one.
		1173
		1174	=item $bool = $term->is_longer ($row_number)
		1175
		1176	Returns true if the row is part of a multiple-row logical "line" (i.e.
		1177	joined with the following row), which means all characters are in use
		1178	and it is continued on the next row (and possibly a continuation of the
		1179	previous row(s)).
		1180
		1181	=item $line = $term->line ($row_number)
		1182
		1183	Create and return a new C<urxvt::line> object that stores information
		1184	about the logical line that row C<$row_number> is part of. It supports the
		1185	following methods:
		1186
		1187	=over 4
		1188
		1189	=item $text = $line->t ([$new_text])
		1190
		1191	Returns or replaces the full text of the line, similar to C<ROW_t>
		1192
		1193	=item $rend = $line->r ([$new_rend])
		1194
		1195	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		1196
		1197	=item $length = $line->l
		1198
		1199	Returns the length of the line in cells, similar to C<ROW_l>.
		1200
		1201	=item $rownum = $line->beg
		1202
		1203	=item $rownum = $line->end
		1204
		1205	Return the row number of the first/last row of the line, respectively.
		1206
		1207	=item $offset = $line->offset_of ($row, $col)
		1208
		1209	Returns the character offset of the given row|col pair within the logical
		1210	line.
		1211
		1212	=item ($row, $col) = $line->coord_of ($offset)
		1213
		1214	Translates a string offset into terminal coordinates again.
		1215
		1216	=back
		1217
		1218	=cut
		1219
		1220	sub line {
		1221	my ($self, $row) = @_;
		1222
		1223	my $maxrow = $self->nrow - 1;
		1224
		1225	my ($beg, $end) = ($row, $row);
		1226
		1227	--$beg while $self->ROW_is_longer ($beg - 1);
		1228	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1229
		1230	bless {
		1231	term => $self,
		1232	beg => $beg,
		1233	end => $end,
		1234	ncol => $self->ncol,
		1235	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1236	}, urxvt::line::
		1237	}
		1238
		1239	sub urxvt::line::t {
		1240	my ($self) = @_;
		1241
		1242	if (@_ > 1)
		1243	{
		1244	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1245	for $self->{beg} .. $self->{end};
		1246	}
		1247
		1248	defined wantarray &&
		1249	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1250	0, $self->{len}
		1251	}
		1252
		1253	sub urxvt::line::r {
		1254	my ($self) = @_;
		1255
		1256	if (@_ > 1)
		1257	{
		1258	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1259	for $self->{beg} .. $self->{end};
		1260	}
		1261
		1262	if (defined wantarray) {
		1263	my $rend = [
		1264	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1265	];
		1266	$#$rend = $self->{len} - 1;
		1267	return $rend;
		1268	}
		1269
		1270	()
		1271	}
		1272
		1273	sub urxvt::line::beg { $_[0]{beg} }
		1274	sub urxvt::line::end { $_[0]{end} }
		1275	sub urxvt::line::l { $_[0]{len} }
		1276
		1277	sub urxvt::line::offset_of {
		1278	my ($self, $row, $col) = @_;
		1279
		1280	($row - $self->{beg}) * $self->{ncol} + $col
		1281	}
		1282
		1283	sub urxvt::line::coord_of {
		1284	my ($self, $offset) = @_;
		1285
		1286	use integer;
		1287
		1288	(
		1289	$offset / $self->{ncol} + $self->{beg},
		1290	$offset % $self->{ncol}
		1291	)
		1292	}
500		1293
501	=item $text = $term->special_encode $string	1294	=item $text = $term->special_encode $string
502		1295
503	Converts a perl string into the special encoding used by rxvt-unicode,	1296	Converts a perl string into the special encoding used by rxvt-unicode,
504	where one character corresponds to one screen cell. See	1297	where one character corresponds to one screen cell. See
…		…
507	=item $string = $term->special_decode $text	1300	=item $string = $term->special_decode $text
508		1301
509	Converts rxvt-unicodes text reprsentation into a perl string. See	1302	Converts rxvt-unicodes text reprsentation into a perl string. See
510	C<< $term->ROW_t >> for details.	1303	C<< $term->ROW_t >> for details.
511		1304
		1305	=item $success = $term->grab_button ($button, $modifiermask)
		1306
		1307	Registers a synchronous button grab. See the XGrabButton manpage.
		1308
		1309	=item $success = $term->grab ($eventtime[, $sync])
		1310
		1311	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1312	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1313
		1314	=item $term->allow_events_async
		1315
		1316	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1317
		1318	=item $term->allow_events_sync
		1319
		1320	Calls XAllowEvents with SyncBoth for the most recent grab.
		1321
		1322	=item $term->allow_events_replay
		1323
		1324	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1325	recent grab.
		1326
		1327	=item $term->ungrab
		1328
		1329	Calls XUngrab for the most recent grab. Is called automatically on
		1330	evaluation errors, as it is better to lose the grab in the error case as
		1331	the session.
		1332
512	=back	1333	=back
513		1334
514	=head2 RENDITION	1335	=cut
515		1336
516	Rendition bitsets contain information about colour, font, font styles and	1337	package urxvt::popup;
517	similar information for each screen cell.
518		1338
519	The following "macros" deal with changes in rendition sets. You should	1339	=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		1340
524	=over 4	1341	=over 4
525		1342
526	=item $rend = urxvt::DEFAULT_RSTYLE	1343	=cut
527		1344
528	Returns the default rendition, as used when the terminal is starting up or	1345	sub add_item {
529	being reset. Useful as a base	1346	my ($self, $item) = @_;
		1347
		1348	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1349	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1350	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1351
		1352	$item->{render} ||= sub { $_[0]{text} };
		1353
		1354	push @{ $self->{item} }, $item;
		1355	}
		1356
		1357	=item $popup->add_title ($title)
		1358
		1359	Adds a non-clickable title to the popup.
		1360
		1361	=cut
		1362
		1363	sub add_title {
		1364	my ($self, $title) = @_;
		1365
		1366	$self->add_item ({
		1367	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1368	text => $title,
		1369	activate => sub { },
		1370	});
		1371	}
		1372
		1373	=item $popup->add_separator ([$sepchr])
		1374
		1375	Creates a separator, optionally using the character given as C<$sepchr>.
		1376
		1377	=cut
		1378
		1379	sub add_separator {
		1380	my ($self, $sep) = @_;
		1381
		1382	$sep ||= "=";
		1383
		1384	$self->add_item ({
		1385	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1386	text => "",
		1387	render => sub { $sep x $self->{term}->ncol },
		1388	activate => sub { },
		1389	});
		1390	}
		1391
		1392	=item $popup->add_button ($text, $cb)
		1393
		1394	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1395	selected.
		1396
		1397	=cut
		1398
		1399	sub add_button {
		1400	my ($self, $text, $cb) = @_;
		1401
		1402	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1403	}
		1404
		1405	=item $popup->add_toggle ($text, $cb, $initial_value)
		1406
		1407	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1408	whenever it gets toggled, with a boolean indicating its value as its first
		1409	argument.
		1410
		1411	=cut
		1412
		1413	sub add_toggle {
		1414	my ($self, $text, $cb, $value) = @_;
		1415
		1416	my $item; $item = {
		1417	type => "button",
		1418	text => " $text",
		1419	value => $value,
		1420	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1421	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1422	};
		1423
		1424	$self->add_item ($item);
		1425	}
		1426
		1427	=item $popup->show
		1428
		1429	Displays the popup (which is initially hidden).
		1430
		1431	=cut
		1432
		1433	sub show {
		1434	my ($self) = @_;
		1435
		1436	local $urxvt::popup::self = $self;
		1437
		1438	my $env = $self->{term}->env;
		1439	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1440	delete $env->{LC_ALL};
		1441	$env->{LC_CTYPE} = $self->{term}->locale;
		1442
		1443	urxvt::term->new ($env, $self->{term}->resource ("name"),
		1444	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1445	"--transient-for" => $self->{term}->parent,
		1446	"-display" => $self->{term}->display_id,
		1447	"-pe" => "urxvt-popup")
		1448	or die "unable to create popup window\n";
		1449	}
		1450
		1451	sub DESTROY {
		1452	my ($self) = @_;
		1453
		1454	delete $self->{term}{_destroy}{$self};
		1455	$self->{term}->ungrab;
		1456	}
530		1457
531	=back	1458	=back
532
533	=cut
534		1459
535	=head2 The C<urxvt::timer> Class	1460	=head2 The C<urxvt::timer> Class
536		1461
537	This class implements timer watchers/events. Time is represented as a	1462	This class implements timer watchers/events. Time is represented as a
538	fractional number of seconds since the epoch. Example:	1463	fractional number of seconds since the epoch. Example:
539		1464
540	# create a digital clock display in upper right corner	1465	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
541	$term->{timer} = urxvt::timer	1466	$term->{timer} = urxvt::timer
542	->new	1467	->new
543	->start (urxvt::NOW)	1468	->interval (1)
544	->cb (sub {	1469	->cb (sub {
545	my ($timer) = @_;
546	my $time = $timer->at;
547	$timer->start ($time + 1);
548	$self->scr_overlay (-1, 0,	1470	$term->{overlay}->set (0, 0,
549	POSIX::strftime "%H:%M:%S", localtime $time);	1471	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
550	});	1472	});
551		1473
552	=over 4	1474	=over 4
553		1475
554	=item $timer = new urxvt::timer	1476	=item $timer = new urxvt::timer
555		1477
556	Create a new timer object in stopped state.	1478	Create a new timer object in started state. It is scheduled to fire
		1479	immediately.
557		1480
558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1481	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
559		1482
560	Set the callback to be called when the timer triggers.	1483	Set the callback to be called when the timer triggers.
561		1484
…		…
564	Return the time this watcher will fire next.	1487	Return the time this watcher will fire next.
565		1488
566	=item $timer = $timer->set ($tstamp)	1489	=item $timer = $timer->set ($tstamp)
567		1490
568	Set the time the event is generated to $tstamp.	1491	Set the time the event is generated to $tstamp.
		1492
		1493	=item $timer = $timer->interval ($interval)
		1494
		1495	Normally (and when C<$interval> is C<0>), the timer will automatically
		1496	stop after it has fired once. If C<$interval> is non-zero, then the timer
		1497	is automatically rescheduled at the given intervals.
569		1498
570	=item $timer = $timer->start	1499	=item $timer = $timer->start
571		1500
572	Start the timer.	1501	Start the timer.
573		1502
…		…
587		1516
588	$term->{socket} = ...	1517	$term->{socket} = ...
589	$term->{iow} = urxvt::iow	1518	$term->{iow} = urxvt::iow
590	->new	1519	->new
591	->fd (fileno $term->{socket})	1520	->fd (fileno $term->{socket})
592	->events (1) # wait for read data	1521	->events (urxvt::EVENT_READ)
593	->start	1522	->start
594	->cb (sub {	1523	->cb (sub {
595	my ($iow, $revents) = @_;	1524	my ($iow, $revents) = @_;
596	# $revents must be 1 here, no need to check	1525	# $revents must be 1 here, no need to check
597	sysread $term->{socket}, my $buf, 8192	1526	sysread $term->{socket}, my $buf, 8192
…		…
614		1543
615	Set the filedescriptor (not handle) to watch.	1544	Set the filedescriptor (not handle) to watch.
616		1545
617	=item $iow = $iow->events ($eventmask)	1546	=item $iow = $iow->events ($eventmask)
618		1547
619	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1548	Set the event mask to watch. The only allowed values are
620	data, Bit #1 (value C<2>) enables watching for write data.	1549	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1550	together, or C<urxvt::EVENT_NONE>.
621		1551
622	=item $iow = $iow->start	1552	=item $iow = $iow->start
623		1553
624	Start watching for requested events on the given handle.	1554	Start watching for requested events on the given handle.
625		1555
…		…
636	This variable controls the verbosity level of the perl extension. Higher	1566	This variable controls the verbosity level of the perl extension. Higher
637	numbers indicate more verbose output.	1567	numbers indicate more verbose output.
638		1568
639	=over 4	1569	=over 4
640		1570
641	=item 0 - only fatal messages	1571	=item == 0 - fatal messages
642		1572
643	=item 3 - script loading and management	1573	=item >= 3 - script loading and management
644		1574
645	=item 10 - all events received	1575	=item >=10 - all events received
646		1576
647	=back	1577	=back
648		1578
649	=head1 AUTHOR	1579	=head1 AUTHOR
650		1580

Diff Legend

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