ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.15 by root, Tue Jan 3 01:39:17 2006 UTC vs.
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC

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

Diff Legend

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