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.7 by root, Mon Jan 2 19:05:05 2006 UTC vs.
Revision 1.85 by root, Thu Jan 12 03:32:56 2006 UTC

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

Diff Legend

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