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.70 by root, Mon Jan 9 23:00:07 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_line_update $term, $row
		269
		270	Called whenever a line was updated or changed. Can be used to filter
		271	screen output (e.g. underline urls or other useless stuff). Only lines
		272	that are being shown will be filtered, and, due to performance reasons,
		273	not always immediately.
		274
		275	The row number is always the topmost row of the line if the line spans
		276	multiple rows.
		277
		278	Please note that, if you change the line, then the hook might get called
		279	later with the already-modified line (e.g. if unrelated parts change), so
		280	you cannot just toggle rendition bits, but only set them.
154		281
155	=item on_refresh_begin $term	282	=item on_refresh_begin $term
156		283
157	Called just before the screen gets redrawn. Can be used for overlay	284	Called just before the screen gets redrawn. Can be used for overlay
158	or similar effects by modify terminal contents in refresh_begin, and	285	or similar effects by modify terminal contents in refresh_begin, and
…		…
167		294
168	Called whenever the user presses a key combination that has a	295	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>	296	C<perl:string> action bound to it (see description of the B<keysym>
170	resource in the @@RXVT_NAME@@(1) manpage).	297	resource in the @@RXVT_NAME@@(1) manpage).
171		298
		299	=item on_focus_in $term
		300
		301	Called whenever the window gets the keyboard focus, before rxvt-unicode
		302	does focus in processing.
		303
		304	=item on_focus_out $term
		305
		306	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		307	focus out processing.
		308
		309	=item on_key_press $term, $event, $keysym, $octets
		310
		311	=item on_key_release $term, $event, $keysym
		312
		313	=item on_button_press $term, $event
		314
		315	=item on_button_release $term, $event
		316
		317	=item on_motion_notify $term, $event
		318
		319	=item on_map_notify $term, $event
		320
		321	=item on_unmap_notify $term, $event
		322
		323	Called whenever the corresponding X event is received for the terminal If
		324	the hook returns true, then the even will be ignored by rxvt-unicode.
		325
		326	The event is a hash with most values as named by Xlib (see the XEvent
		327	manpage), with the additional members C<row> and C<col>, which are the row
		328	and column under the mouse cursor.
		329
		330	C<on_key_press> additionally receives the string rxvt-unicode would
		331	output, if any, in locale-specific encoding.
		332
		333	subwindow.
		334
172	=back	335	=back
173		336
		337	=head2 Variables in the C<urxvt> Package
		338
		339	=over 4
		340
		341	=item $urxvt::TERM
		342
		343	The current terminal. This variable stores the current C<urxvt::term>
		344	object, whenever a callback/hook is executing.
		345
		346	=back
		347
174	=head2 Functions in the C<urxvt> Package	348	=head2 Functions in the C<urxvt> Package
175		349
176	=over 4	350	=over 4
		351
		352	=item $term = new urxvt [arg...]
		353
		354	Creates a new terminal, very similar as if you had started it with
		355	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		356	if the new instance couldn't be created. Returns C<undef> if the new
		357	instance didn't initialise perl, and the terminal object otherwise. The
		358	C<init> and C<start> hooks will be called during the call.
177		359
178	=item urxvt::fatal $errormessage	360	=item urxvt::fatal $errormessage
179		361
180	Fatally aborts execution with the given error message. Avoid at all	362	Fatally aborts execution with the given error message. Avoid at all
181	costs! The only time this is acceptable is when the terminal process	363	costs! The only time this is acceptable is when the terminal process
…		…
188	that calls this function.	370	that calls this function.
189		371
190	Using this function has the advantage that its output ends up in the	372	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.	373	correct place, e.g. on stderr of the connecting urxvtc client.
192		374
		375	=item $is_safe = urxvt::safe
		376
		377	Returns true when it is safe to do potentially unsafe things, such as
		378	evaluating perl code specified by the user. This is true when urxvt was
		379	started setuid or setgid.
		380
193	=item $time = urxvt::NOW	381	=item $time = urxvt::NOW
194		382
195	Returns the "current time" (as per the event loop).	383	Returns the "current time" (as per the event loop).
196		384
		385	=item urxvt::CurrentTime
		386
		387	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		388	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		389	Button4Mask, Button5Mask, AnyModifier
		390
		391	Various constants for use in X calls and event processing.
		392
		393	=back
		394
		395	=head2 RENDITION
		396
		397	Rendition bitsets contain information about colour, font, font styles and
		398	similar information for each screen cell.
		399
		400	The following "macros" deal with changes in rendition sets. You should
		401	never just create a bitset, you should always modify an existing one,
		402	as they contain important information required for correct operation of
		403	rxvt-unicode.
		404
		405	=over 4
		406
		407	=item $rend = urxvt::DEFAULT_RSTYLE
		408
		409	Returns the default rendition, as used when the terminal is starting up or
		410	being reset. Useful as a base to start when creating renditions.
		411
		412	=item $rend = urxvt::OVERLAY_RSTYLE
		413
		414	Return the rendition mask used for overlays by default.
		415
		416	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		417
		418	Return the bit that enabled bold, italic, blink, reverse-video and
		419	underline, respectively. To enable such a style, just logically OR it into
		420	the bitset.
		421
		422	=item $foreground = urxvt::GET_BASEFG $rend
		423
		424	=item $background = urxvt::GET_BASEBG $rend
		425
		426	Return the foreground/background colour index, respectively.
		427
		428	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		429
		430	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		431
		432	Replace the foreground/background colour in the rendition mask with the
		433	specified one.
		434
		435	=item $value = urxvt::GET_CUSTOM ($rend)
		436
		437	Return the "custom" value: Every rendition has 5 bits for use by
		438	extensions. They can be set and changed as you like and are initially
		439	zero.
		440
		441	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		442
		443	Change the custom value.
		444
		445	=back
		446
197	=cut	447	=cut
198		448
199	package urxvt;	449	package urxvt;
200		450
		451	use utf8;
201	use strict;	452	use strict;
		453	use Carp ();
		454	use Scalar::Util ();
		455	use List::Util ();
202		456
203	our $term;	457	our $VERSION = 1;
		458	our $TERM;
204	our @HOOKNAME;	459	our @HOOKNAME;
		460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		461	our %OPTION;
205	our $LIBDIR;	462	our $LIBDIR;
206		463
207	BEGIN {	464	BEGIN {
208	urxvt->bootstrap;	465	urxvt->bootstrap;
209		466
…		…
212	my $msg = join "", @_;	469	my $msg = join "", @_;
213	$msg .= "\n"	470	$msg .= "\n"
214	unless $msg =~ /\n$/;	471	unless $msg =~ /\n$/;
215	urxvt::warn ($msg);	472	urxvt::warn ($msg);
216	};	473	};
		474
		475	delete $ENV{IFS};
		476	delete $ENV{CDPATH};
		477	delete $ENV{BASH_ENV};
		478	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
217	}	479	}
218		480
219	my @hook_count;	481	my @hook_count;
220	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
221		483
222	sub verbose {	484	sub verbose {
223	my ($level, $msg) = @_;	485	my ($level, $msg) = @_;
224	warn "$msg\n" if $level <= $verbosity;	486	warn "$msg\n" if $level <= $verbosity;
225	}	487	}
226		488
227	# find on_xxx subs in the package and register them	489	my $extension_pkg = "extension0000";
228	# as hooks	490	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		491
247	# load a single script into its own package, once only	492	# load a single script into its own package, once only
248	sub script_package($) {	493	sub extension_package($) {
249	my ($path) = @_;	494	my ($path) = @_;
250		495
251	$script_pkg{$path} ||= do {	496	$extension_pkg{$path} ||= do {
252	my $pkg = "urxvt::" . ($script_pkg++);	497	my $pkg = "urxvt::" . ($extension_pkg++);
253		498
254	verbose 3, "loading script '$path' into package '$pkg'";	499	verbose 3, "loading extension '$path' into package '$pkg'";
255		500
256	open my $fh, "<:raw", $path	501	open my $fh, "<:raw", $path
257	or die "$path: $!";	502	or die "$path: $!";
258		503
		504	my $source = untaint
259	my $source = "package $pkg; use strict; use utf8;\n"	505	"package $pkg; use strict; use utf8;\n"
		506	. "use base urxvt::term::proxy::;\n"
260	. "#line 1 \"$path\"\n{\n"	507	. "#line 1 \"$path\"\n{\n"
261	. (do { local $/; <$fh> })	508	. (do { local $/; <$fh> })
262	. "\n};\n1";	509	. "\n};\n1";
263		510
		511	eval $source
264	eval $source or die "$path: $@";	512	or die "$path: $@";
265		513
266	$pkg	514	$pkg
267	}	515	}
268	}	516	}
269		517
		518	our $retval; # return value for urxvt
		519
270	# called by the rxvt core	520	# called by the rxvt core
271	sub invoke {	521	sub invoke {
272	local $term = shift;	522	local $TERM = shift;
273	my $htype = shift;	523	my $htype = shift;
274		524
275	if ($htype == 0) { # INIT	525	if ($htype == 0) { # INIT
276	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		527
		528	my %ext_arg;
277		529
278	for my $ext (split /:/, $term->resource ("perl_ext")) {	530	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		531	if ($_ eq "default") {
		532	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
		533	} elsif (/^-(.*)$/) {
		534	delete $ext_arg{$1};
		535	} elsif (/^([^<]+)<(.*)>$/) {
		536	push @{ $ext_arg{$1} }, $2;
		537	} else {
		538	$ext_arg{$_} ||= [];
		539	}
		540	}
		541
		542	while (my ($ext, $argv) = each %ext_arg) {
279	my @files = grep -f $_, map "$_/$ext", @dirs;	543	my @files = grep -f $_, map "$_/$ext", @dirs;
280		544
281	if (@files) {	545	if (@files) {
282	register_package script_package $files[0];	546	$TERM->register_package (extension_package $files[0], $argv);
283	} else {	547	} else {
284	warn "perl extension '$ext' not found in perl library search path\n";	548	warn "perl extension '$ext' not found in perl library search path\n";
285	}	549	}
286	}	550	}
287		551
		552	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		553	warn $@ if $@;
		554	}
		555
		556	$retval = undef;
		557
		558	if (my $cb = $TERM->{_hook}[$htype]) {
		559	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		560	if $verbosity >= 10;
		561
		562	keys %$cb;
		563
		564	while (my ($pkg, $cb) = each %$cb) {
		565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
		566	and last;
		567
		568	if ($@) {
		569	$TERM->ungrab; # better to lose the grab than the session
		570	warn $@;
		571	}
		572	}
		573	}
		574
288	} elsif ($htype == 1) { # DESTROY	575	if ($htype == 1) { # DESTROY
289	if (my $hook = $term->{_hook}) {	576	if (my $hook = delete $TERM->{_hook}) {
290	for my $htype (0..$#$hook) {	577	for my $htype (0..$#$hook) {
291	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }	578	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
292	or set_should_invoke $htype, 0;	579	or set_should_invoke $htype, 0;
293	}	580	}
294	}	581	}
		582
		583	# clear package objects
		584	%$_ = () for values %{ $TERM->{_pkg} };
		585
		586	# clear package
		587	%$TERM = ();
295	}	588	}
296		589
297	my $cb = $term->{_hook}[$htype]	590	$retval
298	or return;	591	}
299		592
300	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	593	# urxvt::term::proxy
301	if $verbosity >= 10;
302		594
		595	package urxvt::term::proxy;
		596
		597	sub enable {
		598	my ($self, %hook) = @_;
		599	my $pkg = $self->{_pkg};
		600
303	while (my ($k, $v) = each %$cb) {	601	while (my ($name, $cb) = each %hook) {
304	return 1 if $v->($term, @_);	602	my $htype = $HOOKTYPE{uc $name};
		603	defined $htype
		604	or Carp::croak "unsupported hook type '$name'";
		605
		606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		607	$hook_count[$htype]++
		608	or urxvt::set_should_invoke $htype, 1;
		609	}
		610
		611	$self->{term}{_hook}[$htype]{$pkg} = $cb;
305	}	612	}
		613	}
306		614
		615	sub disable {
		616	my ($self, @hook) = @_;
		617	my $pkg = $self->{_pkg};
		618
		619	for my $name (@hook) {
		620	my $htype = $HOOKTYPE{uc $name};
		621	defined $htype
		622	or Carp::croak "unsupported hook type '$name'";
		623
		624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		625	--$hook_count[$htype]
		626	or urxvt::set_should_invoke $htype, 0;
		627	}
307	0	628	}
308	}	629	}
309		630
310	=back	631	our $AUTOLOAD;
		632
		633	sub AUTOLOAD {
		634	$AUTOLOAD =~ /:([^:]+)$/
		635	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
		636
		637	eval qq{
		638	sub $AUTOLOAD {
		639	my \$proxy = shift;
		640	\$proxy->{term}->$1 (\@_)
		641	}
		642	1
		643	} or die "FATAL: unable to compile method forwarder: $@";
		644
		645	goto &$AUTOLOAD;
		646	}
		647
		648	sub DESTROY {
		649	# nop
		650	}
		651
		652	# urxvt::destroy_hook
		653
		654	sub urxvt::destroy_hook::DESTROY {
		655	${$_[0]}->();
		656	}
		657
		658	sub urxvt::destroy_hook(&) {
		659	bless \shift, urxvt::destroy_hook::
		660	}
		661
		662	package urxvt::anyevent;
		663
		664	=head2 The C<urxvt::anyevent> Class
		665
		666	The sole purpose of this class is to deliver an interface to the
		667	C<AnyEvent> module - any module using it will work inside urxvt without
		668	further work. The only exception is that you cannot wait on condition
		669	variables, but non-blocking condvar use is ok. What this means is that you
		670	cannot use blocking APIs, but the non-blocking variant should work.
		671
		672	=cut
		673
		674	our $VERSION = 1;
		675
		676	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		677	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		678
		679	sub timer {
		680	my ($class, %arg) = @_;
		681
		682	my $cb = $arg{cb};
		683
		684	urxvt::timer
		685	->new
		686	->start (urxvt::NOW + $arg{after})
		687	->cb (sub {
		688	$_[0]->stop; # need to cancel manually
		689	$cb->();
		690	})
		691	}
		692
		693	sub io {
		694	my ($class, %arg) = @_;
		695
		696	my $cb = $arg{cb};
		697
		698	bless [$arg{fh}, urxvt::iow
		699	->new
		700	->fd (fileno $arg{fh})
		701	->events (($arg{poll} =~ /r/ ? 1 : 0)
		702	| ($arg{poll} =~ /w/ ? 2 : 0))
		703	->start
		704	->cb (sub {
		705	$cb->(($_[1] & 1 ? 'r' : '')
		706	. ($_[1] & 2 ? 'w' : ''));
		707	})],
		708	urxvt::anyevent::
		709	}
		710
		711	sub DESTROY {
		712	$_[0][1]->stop;
		713	}
		714
		715	sub condvar {
		716	bless \my $flag, urxvt::anyevent::condvar::
		717	}
		718
		719	sub urxvt::anyevent::condvar::broadcast {
		720	${$_[0]}++;
		721	}
		722
		723	sub urxvt::anyevent::condvar::wait {
		724	unless (${$_[0]}) {
		725	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		726	}
		727	}
		728
		729	package urxvt::term;
311		730
312	=head2 The C<urxvt::term> Class	731	=head2 The C<urxvt::term> Class
313		732
314	=over 4	733	=over 4
		734
		735	=cut
		736
		737	# find on_xxx subs in the package and register them
		738	# as hooks
		739	sub register_package {
		740	my ($self, $pkg, $argv) = @_;
		741
		742	my $proxy = bless {
		743	_pkg => $pkg,
		744	argv => $argv,
		745	}, $pkg;
		746	Scalar::Util::weaken ($proxy->{term} = $self);
		747
		748	$self->{_pkg}{$pkg} = $proxy;
		749
		750	for my $name (@HOOKNAME) {
		751	if (my $ref = $pkg->can ("on_" . lc $name)) {
		752	$proxy->enable ($name => $ref);
		753	}
		754	}
		755	}
		756
		757	=item $term->destroy
		758
		759	Destroy the terminal object (close the window, free resources etc.).
		760
		761	=item $isset = $term->option ($optval[, $set])
		762
		763	Returns true if the option specified by C<$optval> is enabled, and
		764	optionally change it. All option values are stored by name in the hash
		765	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		766
		767	Here is a a likely non-exhaustive list of option names, please see the
		768	source file F</src/optinc.h> to see the actual list:
		769
		770	borderLess console cursorBlink cursorUnderline hold iconic insecure
		771	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		772	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		773	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		774	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		775	tripleclickwords utmpInhibit visualBell
315		776
316	=item $value = $term->resource ($name[, $newval])	777	=item $value = $term->resource ($name[, $newval])
317		778
318	Returns the current resource value associated with a given name and	779	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>	780	optionally sets a new value. Setting values is most useful in the C<init>
…		…
329		790
330	Please note that resource strings will currently only be freed when the	791	Please note that resource strings will currently only be freed when the
331	terminal is destroyed, so changing options frequently will eat memory.	792	terminal is destroyed, so changing options frequently will eat memory.
332		793
333	Here is a a likely non-exhaustive list of resource names, not all of which	794	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	795	are supported in every build, please see the source file F</src/rsinc.h>
335	list:	796	to see the actual list:
336		797
337	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	798	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
338	borderLess color cursorBlink cursorUnderline cutchars delete_key	799	borderLess color cursorBlink cursorUnderline cutchars delete_key
339	display_name embed ext_bwidth fade font geometry hold iconName	800	display_name embed ext_bwidth fade font geometry hold iconName
340	imFont imLocale inputMethod insecure int_bwidth intensityStyles	801	imFont imLocale inputMethod insecure int_bwidth intensityStyles
341	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	802	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
342	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	803	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
343	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	804	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
344	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	805	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
345	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	806	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
346	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	807	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
347	shade term_name title transparent transparent_all tripleclickwords	808	shade term_name title transparent transparent_all tripleclickwords
348	utmpInhibit visualBell	809	utmpInhibit visualBell
349		810
350	=cut	811	=cut
351		812
352	sub urxvt::term::resource($$;$) {	813	sub resource($$;$) {
353	my ($self, $name) = (shift, shift);	814	my ($self, $name) = (shift, shift);
354	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	815	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
355	goto &urxvt::term::_resource;	816	&urxvt::term::_resource
356	}	817	}
		818
		819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		820
		821	Adds a keymap translation exactly as specified via a resource. See the
		822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		823
		824	=item $rend = $term->rstyle ([$new_rstyle])
		825
		826	Return and optionally change the current rendition. Text that is output by
		827	the terminal application will use this style.
		828
		829	=item ($row, $col) = $term->screen_cur ([$row, $col])
		830
		831	Return the current coordinates of the text cursor position and optionally
		832	set it (which is usually bad as applications don't expect that).
357		833
358	=item ($row, $col) = $term->selection_mark ([$row, $col])	834	=item ($row, $col) = $term->selection_mark ([$row, $col])
359		835
360	=item ($row, $col) = $term->selection_beg ([$row, $col])	836	=item ($row, $col) = $term->selection_beg ([$row, $col])
361		837
…		…
371		847
372	=item $oldtext = $term->selection ([$newtext])	848	=item $oldtext = $term->selection ([$newtext])
373		849
374	Return the current selection text and optionally replace it by C<$newtext>.	850	Return the current selection text and optionally replace it by C<$newtext>.
375		851
376	=item $term->scr_overlay ($x, $y, $text)	852	=item $term->overlay_simple ($x, $y, $text)
377		853
378	Create a simple multi-line overlay box. See the next method for details.	854	Create a simple multi-line overlay box. See the next method for details.
379		855
380	=cut	856	=cut
381		857
382	sub urxvt::term::scr_overlay {	858	sub overlay_simple {
383	my ($self, $x, $y, $text) = @_;	859	my ($self, $x, $y, $text) = @_;
384		860
385	my @lines = split /\n/, $text;	861	my @lines = split /\n/, $text;
386		862
387	my $w = 0;	863	my $w = List::Util::max map $self->strwidth ($_), @lines;
388	for (map $self->strwidth ($_), @lines) {
389	$w = $_ if $w < $_;
390	}
391		864
392	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	865	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
393	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	866	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
394	}
395		867
		868	$overlay
		869	}
		870
396	=item $term->scr_overlay_new ($x, $y, $width, $height)	871	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
397		872
398	Create a new (empty) overlay at the given position with the given	873	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	874	width/height. C<$rstyle> defines the initial rendition style
400	C<$y> is negative, then this is counted from the right/bottom side,	875	(default: C<OVERLAY_RSTYLE>).
401	respectively.
402		876
403	=item $term->scr_overlay_off	877	If C<$border> is C<2> (default), then a decorative border will be put
		878	around the box.
404		879
405	Switch the overlay off again.	880	If either C<$x> or C<$y> is negative, then this is counted from the
		881	right/bottom side, respectively.
406		882
407	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	883	This method returns an urxvt::overlay object. The overlay will be visible
		884	as long as the perl object is referenced.
408		885
409	Put a single character (specified numerically) at the given overlay	886	The methods currently supported on C<urxvt::overlay> objects are:
410	position.
411		887
		888	=over 4
		889
412	=item $term->scr_overlay_set ($x, $y, $text)	890	=item $overlay->set ($x, $y, $text, $rend)
413		891
414	Write a string at the given position into the overlay.	892	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		893	text in rxvt-unicode's special encoding and an array of rendition values
		894	at a specific position inside the overlay.
415		895
		896	=item $overlay->hide
		897
		898	If visible, hide the overlay, but do not destroy it.
		899
		900	=item $overlay->show
		901
		902	If hidden, display the overlay again.
		903
		904	=back
		905
		906	=item $popup = $term->popup ($event)
		907
		908	Creates a new C<urxvt::popup> object that implements a popup menu. The
		909	C<$event> I<must> be the event causing the menu to pop up (a button event,
		910	currently).
		911
		912	=cut
		913
		914	sub popup {
		915	my ($self, $event) = @_;
		916
		917	$self->grab ($event->{time}, 1)
		918	or return;
		919
		920	my $popup = bless {
		921	term => $self,
		922	event => $event,
		923	}, urxvt::popup::;
		924
		925	Scalar::Util::weaken $popup->{term};
		926
		927	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		928	Scalar::Util::weaken $self->{_destroy}{$popup};
		929
		930	$popup
		931	}
		932
416	=item $cellwidth = $term->strwidth $string	933	=item $cellwidth = $term->strwidth ($string)
417		934
418	Returns the number of screen-cells this string would need. Correctly	935	Returns the number of screen-cells this string would need. Correctly
419	accounts for wide and combining characters.	936	accounts for wide and combining characters.
420		937
421	=item $octets = $term->locale_encode $string	938	=item $octets = $term->locale_encode ($string)
422		939
423	Convert the given text string into the corresponding locale encoding.	940	Convert the given text string into the corresponding locale encoding.
424		941
425	=item $string = $term->locale_decode $octets	942	=item $string = $term->locale_decode ($octets)
426		943
427	Convert the given locale-encoded octets into a perl string.	944	Convert the given locale-encoded octets into a perl string.
		945
		946	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		947
		948	XORs the rendition values in the given span with the provided value
		949	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		950	to the selection.
		951
		952	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		953
		954	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		955	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		956	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		957	it instead.
		958
		959	=item $term->scr_bell
		960
		961	Ring the bell!
		962
		963	=item $term->scr_add_lines ($string)
		964
		965	Write the given text string to the screen, as if output by the application
		966	running inside the terminal. It may not contain command sequences (escape
		967	codes), but is free to use line feeds, carriage returns and tabs. The
		968	string is a normal text string, not in locale-dependent encoding.
		969
		970	Normally its not a good idea to use this function, as programs might be
		971	confused by changes in cursor position or scrolling. Its useful inside a
		972	C<on_add_lines> hook, though.
		973
		974	=item $term->cmd_parse ($octets)
		975
		976	Similar to C<scr_add_lines>, but the argument must be in the
		977	locale-specific encoding of the terminal and can contain command sequences
		978	(escape codes) that will be interpreted.
428		979
429	=item $term->tt_write ($octets)	980	=item $term->tt_write ($octets)
430		981
431	Write the octets given in C<$data> to the tty (i.e. as program input). To	982	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	983	pass characters instead of octets, you should convert your strings first
433	to the locale-specific encoding using C<< $term->locale_encode >>.	984	to the locale-specific encoding using C<< $term->locale_encode >>.
434		985
		986	=item $old_events = $term->pty_ev_events ([$new_events])
		987
		988	Replaces the event mask of the pty watcher by the given event mask. Can
		989	be used to suppress input and output handling to the pty/tty. See the
		990	description of C<< urxvt::timer->events >>. Make sure to always restore
		991	the previous value.
		992
		993	=item $windowid = $term->parent
		994
		995	Return the window id of the toplevel window.
		996
		997	=item $windowid = $term->vt
		998
		999	Return the window id of the terminal window.
		1000
		1001	=item $window_width = $term->width
		1002
		1003	=item $window_height = $term->height
		1004
		1005	=item $font_width = $term->fwidth
		1006
		1007	=item $font_height = $term->fheight
		1008
		1009	=item $font_ascent = $term->fbase
		1010
435	=item $nrow = $term->nrow	1011	=item $terminal_rows = $term->nrow
436		1012
437	=item $ncol = $term->ncol	1013	=item $terminal_columns = $term->ncol
438		1014
439	Return the number of rows/columns of the terminal window (i.e. as	1015	=item $has_focus = $term->focus
440	specified by C<-geometry>, excluding any scrollback).
441		1016
442	=item $nsaved = $term->nsaved	1017	=item $is_mapped = $term->mapped
443		1018
444	Returns the number of lines in the scrollback buffer.	1019	=item $max_scrollback = $term->saveLines
		1020
		1021	=item $nrow_plus_saveLines = $term->total_rows
		1022
		1023	=item $lines_in_scrollback = $term->nsaved
		1024
		1025	Return various integers describing terminal characteristics.
		1026
		1027	=item $lc_ctype = $term->locale
		1028
		1029	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1030
		1031	=item $x_display = $term->display_id
		1032
		1033	Return the DISPLAY used by rxvt-unicode.
		1034
		1035	=item $modifiermask = $term->ModLevel3Mask
		1036
		1037	=item $modifiermask = $term->ModMetaMask
		1038
		1039	=item $modifiermask = $term->ModNumLockMask
		1040
		1041	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1042	AltGr), the meta key (often Alt) and the num lock key, if applicable.
445		1043
446	=item $view_start = $term->view_start ([$newvalue])	1044	=item $view_start = $term->view_start ([$newvalue])
447		1045
448	Returns the negative row number of the topmost line. Minimum value is	1046	Returns the negative row number of the topmost line. Minimum value is
449	C<0>, which displays the normal terminal contents. Larger values scroll	1047	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
460	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1058	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
461		1059
462	Returns the text of the entire row with number C<$row_number>. Row C<0>	1060	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	1061	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	1062	terminal line. The scrollback buffer starts at line C<-1> and extends to
465	line C<< -$term->nsaved >>.	1063	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		1064	is requested.
466		1065
467	If C<$new_text> is specified, it will replace characters in the current	1066	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	1067	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	1068	to replace only parts of a line. The font index in the rendition will
470	automatically be updated.	1069	automatically be updated.
471		1070
472	C<$text> is in a special encoding: tabs and wide characters that use more	1071	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	1072	than one cell when displayed are padded with urxvt::NOCHAR characters
474	(C<chr 65535>). Characters with combining characters and other characters	1073	(C<chr 65535>). Characters with combining characters and other characters
…		…
488	bitsets. Rendition bitsets contain information about colour, font, font	1087	bitsets. Rendition bitsets contain information about colour, font, font
489	styles and similar information. See also C<< $term->ROW_t >>.	1088	styles and similar information. See also C<< $term->ROW_t >>.
490		1089
491	When setting rendition, the font mask will be ignored.	1090	When setting rendition, the font mask will be ignored.
492		1091
493	See the section on RENDITION, below.	1092	See the section on RENDITION, above.
494		1093
495	=item $length = $term->ROW_l ($row_number[, $new_length])	1094	=item $length = $term->ROW_l ($row_number[, $new_length])
496		1095
497	Returns the number of screen cells that are in use ("the line length"). If	1096	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	1097	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.	1098	line is joined with the following one.
		1099
		1100	=item $bool = $term->is_longer ($row_number)
		1101
		1102	Returns true if the row is part of a multiple-row logical "line" (i.e.
		1103	joined with the following row), which means all characters are in use
		1104	and it is continued on the next row (and possibly a continuation of the
		1105	previous row(s)).
		1106
		1107	=item $line = $term->line ($row_number)
		1108
		1109	Create and return a new C<urxvt::line> object that stores information
		1110	about the logical line that row C<$row_number> is part of. It supports the
		1111	following methods:
		1112
		1113	=over 4
		1114
		1115	=item $text = $line->t ([$new_text])
		1116
		1117	Returns or replaces the full text of the line, similar to C<ROW_t>
		1118
		1119	=item $rend = $line->r ([$new_rend])
		1120
		1121	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		1122
		1123	=item $length = $line->l
		1124
		1125	Returns the length of the line in cells, similar to C<ROW_l>.
		1126
		1127	=item $rownum = $line->beg
		1128
		1129	=item $rownum = $line->end
		1130
		1131	Return the row number of the first/last row of the line, respectively.
		1132
		1133	=item $offset = $line->offset_of ($row, $col)
		1134
		1135	Returns the character offset of the given row|col pair within the logical
		1136	line.
		1137
		1138	=item ($row, $col) = $line->coord_of ($offset)
		1139
		1140	Translates a string offset into terminal coordinates again.
		1141
		1142	=back
		1143
		1144	=cut
		1145
		1146	sub line {
		1147	my ($self, $row) = @_;
		1148
		1149	my $maxrow = $self->nrow - 1;
		1150
		1151	my ($beg, $end) = ($row, $row);
		1152
		1153	--$beg while $self->ROW_is_longer ($beg - 1);
		1154	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1155
		1156	bless {
		1157	term => $self,
		1158	beg => $beg,
		1159	end => $end,
		1160	ncol => $self->ncol,
		1161	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1162	}, urxvt::line::
		1163	}
		1164
		1165	sub urxvt::line::t {
		1166	my ($self) = @_;
		1167
		1168	if (@_ > 1)
		1169	{
		1170	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1171	for $self->{beg} .. $self->{end};
		1172	}
		1173
		1174	defined wantarray &&
		1175	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1176	0, $self->{len}
		1177	}
		1178
		1179	sub urxvt::line::r {
		1180	my ($self) = @_;
		1181
		1182	if (@_ > 1)
		1183	{
		1184	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1185	for $self->{beg} .. $self->{end};
		1186	}
		1187
		1188	if (defined wantarray) {
		1189	my $rend = [
		1190	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1191	];
		1192	$#$rend = $self->{len} - 1;
		1193	return $rend;
		1194	}
		1195
		1196	()
		1197	}
		1198
		1199	sub urxvt::line::beg { $_[0]{beg} }
		1200	sub urxvt::line::end { $_[0]{end} }
		1201	sub urxvt::line::l { $_[0]{len} }
		1202
		1203	sub urxvt::line::offset_of {
		1204	my ($self, $row, $col) = @_;
		1205
		1206	($row - $self->{beg}) * $self->{ncol} + $col
		1207	}
		1208
		1209	sub urxvt::line::coord_of {
		1210	my ($self, $offset) = @_;
		1211
		1212	use integer;
		1213
		1214	(
		1215	$offset / $self->{ncol} + $self->{beg},
		1216	$offset % $self->{ncol}
		1217	)
		1218	}
500		1219
501	=item $text = $term->special_encode $string	1220	=item $text = $term->special_encode $string
502		1221
503	Converts a perl string into the special encoding used by rxvt-unicode,	1222	Converts a perl string into the special encoding used by rxvt-unicode,
504	where one character corresponds to one screen cell. See	1223	where one character corresponds to one screen cell. See
…		…
507	=item $string = $term->special_decode $text	1226	=item $string = $term->special_decode $text
508		1227
509	Converts rxvt-unicodes text reprsentation into a perl string. See	1228	Converts rxvt-unicodes text reprsentation into a perl string. See
510	C<< $term->ROW_t >> for details.	1229	C<< $term->ROW_t >> for details.
511		1230
		1231	=item $success = $term->grab_button ($button, $modifiermask)
		1232
		1233	Registers a synchronous button grab. See the XGrabButton manpage.
		1234
		1235	=item $success = $term->grab ($eventtime[, $sync])
		1236
		1237	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1238	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1239
		1240	=item $term->allow_events_async
		1241
		1242	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1243
		1244	=item $term->allow_events_sync
		1245
		1246	Calls XAllowEvents with SyncBoth for the most recent grab.
		1247
		1248	=item $term->allow_events_replay
		1249
		1250	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1251	recent grab.
		1252
		1253	=item $term->ungrab
		1254
		1255	Calls XUngrab for the most recent grab. Is called automatically on
		1256	evaluation errors, as it is better to lose the grab in the error case as
		1257	the session.
		1258
512	=back	1259	=back
513		1260
514	=head2 RENDITION	1261	=cut
515		1262
516	Rendition bitsets contain information about colour, font, font styles and	1263	package urxvt::popup;
517	similar information for each screen cell.
518		1264
519	The following "macros" deal with changes in rendition sets. You should	1265	=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		1266
524	=over 4	1267	=over 4
525		1268
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	1269	=cut
		1270
		1271	sub add_item {
		1272	my ($self, $item) = @_;
		1273
		1274	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1275	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1276	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1277
		1278	$item->{render} ||= sub { $_[0]{text} };
		1279
		1280	push @{ $self->{item} }, $item;
		1281	}
		1282
		1283	sub add_separator {
		1284	my ($self, $sep) = @_;
		1285
		1286	$sep ||= "=";
		1287
		1288	$self->add_item ({
		1289	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1290	text => "",
		1291	render => sub { $sep x $self->{term}->ncol },
		1292	activate => sub { },
		1293	});
		1294	}
		1295
		1296	sub add_title {
		1297	my ($self, $title) = @_;
		1298
		1299	$self->add_item ({
		1300	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1301	text => $title,
		1302	activate => sub { },
		1303	});
		1304	}
		1305
		1306	sub add_button {
		1307	my ($self, $text, $cb) = @_;
		1308
		1309	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1310	}
		1311
		1312	sub add_toggle {
		1313	my ($self, $text, $cb, $value) = @_;
		1314
		1315	my $item; $item = {
		1316	type => "button",
		1317	text => " $text",
		1318	value => $value,
		1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1321	};
		1322
		1323	$self->add_item ($item);
		1324	}
		1325
		1326	sub show {
		1327	my ($self) = @_;
		1328
		1329	local $urxvt::popup::self = $self;
		1330
		1331	local $ENV{LC_ALL} = $self->{term}->locale;
		1332
		1333	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1334	"--transient-for" => $self->{term}->parent,
		1335	"-display" => $self->{term}->display_id,
		1336	"-pe" => "urxvt-popup")
		1337	or die "unable to create popup window\n";
		1338	}
		1339
		1340	sub DESTROY {
		1341	my ($self) = @_;
		1342
		1343	delete $self->{term}{_destroy}{$self};
		1344	$self->{term}->ungrab;
		1345	}
534		1346
535	=head2 The C<urxvt::timer> Class	1347	=head2 The C<urxvt::timer> Class
536		1348
537	This class implements timer watchers/events. Time is represented as a	1349	This class implements timer watchers/events. Time is represented as a
538	fractional number of seconds since the epoch. Example:	1350	fractional number of seconds since the epoch. Example:
539		1351
540	# create a digital clock display in upper right corner	1352	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
541	$term->{timer} = urxvt::timer	1353	$term->{timer} = urxvt::timer
542	->new	1354	->new
543	->start (urxvt::NOW)	1355	->interval (1)
544	->cb (sub {	1356	->cb (sub {
545	my ($timer) = @_;
546	my $time = $timer->at;
547	$timer->start ($time + 1);
548	$self->scr_overlay (-1, 0,	1357	$term->{overlay}->set (0, 0,
549	POSIX::strftime "%H:%M:%S", localtime $time);	1358	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
550	});	1359	});
551		1360
552	=over 4	1361	=over 4
553		1362
554	=item $timer = new urxvt::timer	1363	=item $timer = new urxvt::timer
555		1364
556	Create a new timer object in stopped state.	1365	Create a new timer object in started state. It is scheduled to fire
		1366	immediately.
557		1367
558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1368	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
559		1369
560	Set the callback to be called when the timer triggers.	1370	Set the callback to be called when the timer triggers.
561		1371
…		…
564	Return the time this watcher will fire next.	1374	Return the time this watcher will fire next.
565		1375
566	=item $timer = $timer->set ($tstamp)	1376	=item $timer = $timer->set ($tstamp)
567		1377
568	Set the time the event is generated to $tstamp.	1378	Set the time the event is generated to $tstamp.
		1379
		1380	=item $timer = $timer->interval ($interval)
		1381
		1382	Normally (and when C<$interval> is C<0>), the timer will automatically
		1383	stop after it has fired once. If C<$interval> is non-zero, then the timer
		1384	is automatically rescheduled at the given intervals.
569		1385
570	=item $timer = $timer->start	1386	=item $timer = $timer->start
571		1387
572	Start the timer.	1388	Start the timer.
573		1389
…		…
587		1403
588	$term->{socket} = ...	1404	$term->{socket} = ...
589	$term->{iow} = urxvt::iow	1405	$term->{iow} = urxvt::iow
590	->new	1406	->new
591	->fd (fileno $term->{socket})	1407	->fd (fileno $term->{socket})
592	->events (1) # wait for read data	1408	->events (urxvt::EVENT_READ)
593	->start	1409	->start
594	->cb (sub {	1410	->cb (sub {
595	my ($iow, $revents) = @_;	1411	my ($iow, $revents) = @_;
596	# $revents must be 1 here, no need to check	1412	# $revents must be 1 here, no need to check
597	sysread $term->{socket}, my $buf, 8192	1413	sysread $term->{socket}, my $buf, 8192
…		…
614		1430
615	Set the filedescriptor (not handle) to watch.	1431	Set the filedescriptor (not handle) to watch.
616		1432
617	=item $iow = $iow->events ($eventmask)	1433	=item $iow = $iow->events ($eventmask)
618		1434
619	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1435	Set the event mask to watch. The only allowed values are
620	data, Bit #1 (value C<2>) enables watching for write data.	1436	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1437	together, or C<urxvt::EVENT_NONE>.
621		1438
622	=item $iow = $iow->start	1439	=item $iow = $iow->start
623		1440
624	Start watching for requested events on the given handle.	1441	Start watching for requested events on the given handle.
625		1442
…		…
636	This variable controls the verbosity level of the perl extension. Higher	1453	This variable controls the verbosity level of the perl extension. Higher
637	numbers indicate more verbose output.	1454	numbers indicate more verbose output.
638		1455
639	=over 4	1456	=over 4
640		1457
641	=item 0 - only fatal messages	1458	=item == 0 - fatal messages
642		1459
643	=item 3 - script loading and management	1460	=item >= 3 - script loading and management
644		1461
645	=item 10 - all events received	1462	=item >=10 - all events received
646		1463
647	=back	1464	=back
648		1465
649	=head1 AUTHOR	1466	=head1 AUTHOR
650		1467

Diff Legend

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