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

Diff Legend

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