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

Diff Legend

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