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.26 by root, Tue Jan 3 21:22:22 2006 UTC vs.
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC

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

Diff Legend

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