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

Diff Legend

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