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.1 by root, Mon Jan 2 15:35:43 2006 UTC vs.
Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC

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

Diff Legend

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