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.86 by root, Thu Jan 12 05:22:47 2006 UTC vs.
Revision 1.236 by root, Sat May 17 17:12:29 2014 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the 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 "vars"' 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 urxvtd, 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	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	=over 4	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	=item selection (enabled by default)	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	Extensions that add command line parameters or resources on their own are
45	when the user extends selections (double-click). Right now, it tries to	49	loaded automatically when used.
46	select urls and complete shell-quoted arguments, which is very convenient,
47	too, if your F<ls> supports C<--quoting-style=shell>.
48
49	It also offers the following bindable keyboard command:
50
51	=over 4
52
53	=item rot13
54
55	Rot-13 the selection when activated. Used via keyboard trigger:
56
57	URxvt.keysym.C-M-r: perl:selection:rot13
58
59	=back
60
61	=item option-popup (enabled by default)
62
63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.
65
66	=item selection-popup (enabled by default)
67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.
71
72	=item searchable-scrollback<hotkey> (enabled by default)
73
74	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
76	input/output is suspended.
77
78	C</> starts an incremental regex search, C<n> searches further, C<p> or
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
80	history, C<enter> leaves search mode at the current position and C<escape>
81	returns to the original position.
82
83	=item digital-clock
84
85	Displays a digital clock using the built-in overlay.
86
87	=item mark-urls
88
89	Uses per-line display filtering (C<on_line_update>) to underline urls and
90	make them clickable. When middle-clicked, the program specified in the
91	resource C<urlLauncher> (default C<x-www-browser>) will be started.
92
93	=item block-graphics-to-ascii
94
95	A not very useful example of filtering all text output to the terminal,
96	by replacing all line-drawing characters (U+2500 .. U+259F) by a
97	similar-looking ascii character.
98
99	=item example-refresh-hooks
100
101	Displays a very simple digital clock in the upper right corner of the
102	window. Illustrates overwriting the refresh callbacks to create your own
103	overlays or changes.
104
105	=back
106		50
107	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
108		52
109	=head2 General API Considerations	53	=head2 General API Considerations
110		54
…		…
124		68
125	=over 4	69	=over 4
126		70
127	=item $text	71	=item $text
128		72
129	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
130	always represents one screen cell. See L<ROW_t> for a discussion of this format.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
131		75
132	=item $string	76	=item $string
133		77
134	A perl text string, with an emphasis on I<text>. It can store all unicode	78	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
138	=item $octets	82	=item $octets
139		83
140	Either binary data or - more common - a text string encoded in a	84	Either binary data or - more common - a text string encoded in a
141	locale-specific way.	85	locale-specific way.
142		86
		87	=item $keysym
		88
		89	an integer that is a valid X11 keysym code. You can convert a string
		90	into a keysym and viceversa by using C<XStringToKeysym> and
		91	C<XKeysymToString>.
		92
143	=back	93	=back
144		94
145	=head2 Extension Objects	95	=head2 Extension Objects
146		96
147	Very perl extension is a perl class. A separate perl object is created	97	Every perl extension is a perl class. A separate perl object is created
148	for each terminal and each extension and passed as the first parameter to	98	for each terminal, and each terminal has its own set of extension objects,
149	hooks. So extensions can use their C<$self> object without having to think	99	which are passed as the first parameter to hooks. So extensions can use
150	about other extensions, with the exception of methods and members that	100	their C<$self> object without having to think about clashes with other
		101	extensions or other terminals, with the exception of methods and members
151	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
152	use.	103	internal use.
153		104
154	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
155	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
156		107
157	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
158		109	the C<urxvt::extension> section below.
159	=over 4
160
161	=item $urxvt_term = $self->{term}
162
163	Returns the C<urxvt::term> object associated with this instance of the
164	extension. This member I<must not> be changed in any way.
165
166	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
167
168	Dynamically enable the given hooks (named without the C<on_> prefix) for
169	this extension, replacing any previous hook. This is useful when you want
170	to overwrite time-critical hooks only temporarily.
171
172	=item $self->disable ($hook_name[, $hook_name..])
173
174	Dynamically disable the given hooks.
175
176	=back
177		110
178	=head2 Hooks	111	=head2 Hooks
179		112
180	The following subroutines can be declared in extension files, and will be	113	The following subroutines can be declared in extension files, and will be
181	called whenever the relevant event happens.	114	called whenever the relevant event happens.
182		115
183	The first argument passed to them is an extension oject as described in	116	The first argument passed to them is an extension object as described in
184	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
185		118
186	B<All> of these hooks must return a boolean value. If it is true, then the	119	B<All> of these hooks must return a boolean value. If any of the called
187	event counts as being I<consumed>, and the invocation of other hooks is	120	hooks returns true, then the event counts as being I<consumed>, and the
188	skipped, and the relevant action might not be carried out by the C++ code.	121	relevant action might not be carried out by the C++ code.
189		122
190	I<< When in doubt, return a false value (preferably C<()>). >>	123	I<< When in doubt, return a false value (preferably C<()>). >>
191		124
192	=over 4	125	=over 4
193		126
194	=item on_init $term	127	=item on_init $term
195		128
196	Called after a new terminal object has been initialized, but before	129	Called after a new terminal object has been initialized, but before
197	windows are created or the command gets run. Most methods are unsafe to	130	windows are created or the command gets run. Most methods are unsafe to
198	call or deliver senseless data, as terminal size and other characteristics	131	call or deliver senseless data, as terminal size and other characteristics
199	have not yet been determined. You can safely query and change resources,	132	have not yet been determined. You can safely query and change resources
200	though.	133	and options, though. For many purposes the C<on_start> hook is a better
		134	place.
		135
		136	=item on_start $term
		137
		138	Called at the very end of initialisation of a new terminal, just before
		139	trying to map (display) the toplevel and returning to the main loop.
		140
		141	=item on_destroy $term
		142
		143	Called whenever something tries to destroy terminal, when the terminal is
		144	still fully functional (not for long, though).
201		145
202	=item on_reset $term	146	=item on_reset $term
203		147
204	Called after the screen is "reset" for any reason, such as resizing or	148	Called after the screen is "reset" for any reason, such as resizing or
205	control sequences. Here is where you can react on changes to size-related	149	control sequences. Here is where you can react on changes to size-related
206	variables.	150	variables.
207		151
208	=item on_start $term	152	=item on_child_start $term, $pid
209		153
210	Called at the very end of initialisation of a new terminal, just before	154	Called just after the child process has been C<fork>ed.
211	returning to the mainloop.	155
		156	=item on_child_exit $term, $status
		157
		158	Called just after the child process has exited. C<$status> is the status
		159	from C<waitpid>.
212		160
213	=item on_sel_make $term, $eventtime	161	=item on_sel_make $term, $eventtime
214		162
215	Called whenever a selection has been made by the user, but before the	163	Called whenever a selection has been made by the user, but before the
216	selection text is copied, so changes to the beginning, end or type of the	164	selection text is copied, so changes to the beginning, end or type of the
…		…
223		171
224	Called whenever a selection has been copied, but before the selection is	172	Called whenever a selection has been copied, but before the selection is
225	requested from the server. The selection text can be queried and changed	173	requested from the server. The selection text can be queried and changed
226	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
227		175
228	Returning a true value aborts selection grabbing. It will still be hilighted.	176	Returning a true value aborts selection grabbing. It will still be highlighted.
229		177
230	=item on_sel_extend $term	178	=item on_sel_extend $term
231		179
232	Called whenever the user tries to extend the selection (e.g. with a double	180	Called whenever the user tries to extend the selection (e.g. with a double
233	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
234	should extend the selection itelf and return true to suppress the built-in	182	should extend the selection itself and return true to suppress the built-in
235	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
236	returns true, it will be called on every further click by the user and is	184	returns true, it will be called on every further click by the user and is
237	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
238		186
239	See the F<selection> example extension.	187	See the F<selection> example extension.
240		188
241	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
242		190
243	Called whenever the view offset changes, i..e the user or program	191	Called whenever the view offset changes, i.e. the user or program
244	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
245	show this many lines of scrollback.	193	show this many lines of scrollback.
246		194
247	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
248		196
…		…
252		200
253	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
254	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
255	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
256		204
257	=item on_osc_seq $term, $string	205	=item on_osc_seq $term, $op, $args, $resp
		206
		207	Called on every OSC sequence and can be used to suppress it or modify its
		208	behaviour. The default should be to return an empty list. A true value
		209	suppresses execution of the request completely. Make sure you don't get
		210	confused by recursive invocations when you output an OSC sequence within
		211	this callback.
		212
		213	C<on_osc_seq_perl> should be used for new behaviour.
		214
		215	=item on_osc_seq_perl $term, $args, $resp
258		216
259	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
260	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
261	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
262	string should start with the extension name and a colon, to distinguish	220	string should start with the extension name (sans -osc) and a semicolon,
263	it from commands for other extensions, and this might be enforced in the	221	to distinguish it from commands for other extensions, and this might be
264	future.	222	enforced in the future.
		223
		224	For example, C<overlay-osc> uses this:
		225
		226	sub on_osc_seq_perl {
		227	my ($self, $osc, $resp) = @_;
		228
		229	return unless $osc =~ s/^overlay;//;
		230
		231	... process remaining $osc string
		232	}
265		233
266	Be careful not ever to trust (in a security sense) the data you receive,	234	Be careful not ever to trust (in a security sense) the data you receive,
267	as its source can not easily be controleld (e-mail content, messages from	235	as its source can not easily be controlled (e-mail content, messages from
268	other users on the same system etc.).	236	other users on the same system etc.).
		237
		238	For responses, C<$resp> contains the end-of-args separator used by the
		239	sender.
269		240
270	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
271		242
272	Called whenever text is about to be output, with the text as argument. You	243	Called whenever text is about to be output, with the text as argument. You
273	can filter/change and output the text yourself by returning a true value	244	can filter/change and output the text yourself by returning a true value
…		…
278	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
279		250
280	Called whenever some data is written to the tty/pty and can be used to	251	Called whenever some data is written to the tty/pty and can be used to
281	suppress or filter tty input.	252	suppress or filter tty input.
282		253
		254	=item on_tt_paste $term, $octets
		255
		256	Called whenever text is about to be pasted, with the text as argument. You
		257	can filter/change and paste the text yourself by returning a true value
		258	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		259	locale-encoded.
		260
283	=item on_line_update $term, $row	261	=item on_line_update $term, $row
284		262
285	Called whenever a line was updated or changed. Can be used to filter	263	Called whenever a line was updated or changed. Can be used to filter
286	screen output (e.g. underline urls or other useless stuff). Only lines	264	screen output (e.g. underline urls or other useless stuff). Only lines
287	that are being shown will be filtered, and, due to performance reasons,	265	that are being shown will be filtered, and, due to performance reasons,
…		…
294	later with the already-modified line (e.g. if unrelated parts change), so	272	later with the already-modified line (e.g. if unrelated parts change), so
295	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
296		274
297	=item on_refresh_begin $term	275	=item on_refresh_begin $term
298		276
299	Called just before the screen gets redrawn. Can be used for overlay	277	Called just before the screen gets redrawn. Can be used for overlay or
300	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
301	restoring them in refresh_end. The built-in overlay and selection display	279	restoring them in refresh_end. The built-in overlay and selection display
302	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
303		281
304	=item on_refresh_end $term	282	=item on_refresh_end $term
305		283
306	Called just after the screen gets redrawn. See C<on_refresh_begin>.	284	Called just after the screen gets redrawn. See C<on_refresh_begin>.
307		285
308	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
309		287
310	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
311	C<perl:string> action bound to it (see description of the B<keysym>	289	a C<perl:string> action bound to a key, see description of the B<keysym>
312	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
		291
		292	The event is simply the action string. This interface is going away in
		293	preference to the C<on_action> hook.
		294
		295	=item on_resize_all_windows $term, $new_width, $new_height
		296
		297	Called just after the new window size has been calculated, but before
		298	windows are actually being resized or hints are being set. If this hook
		299	returns a true value, setting of the window hints is being skipped.
		300
		301	=item on_x_event $term, $event
		302
		303	Called on every X event received on the vt window (and possibly other
		304	windows). Should only be used as a last resort. Most event structure
		305	members are not passed.
		306
		307	=item on_root_event $term, $event
		308
		309	Like C<on_x_event>, but is called for events on the root window.
313		310
314	=item on_focus_in $term	311	=item on_focus_in $term
315		312
316	Called whenever the window gets the keyboard focus, before rxvt-unicode	313	Called whenever the window gets the keyboard focus, before rxvt-unicode
317	does focus in processing.	314	does focus in processing.
318		315
319	=item on_focus_out $term	316	=item on_focus_out $term
320		317
321	Called wheneever the window loses keyboard focus, before rxvt-unicode does	318	Called whenever the window loses keyboard focus, before rxvt-unicode does
322	focus out processing.	319	focus out processing.
323		320
		321	=item on_configure_notify $term, $event
		322
		323	=item on_property_notify $term, $event
		324
324	=item on_key_press $term, $event, $keysym, $octets	325	=item on_key_press $term, $event, $keysym, $octets
325		326
326	=item on_key_release $term, $event, $keysym	327	=item on_key_release $term, $event, $keysym
327		328
328	=item on_button_press $term, $event	329	=item on_button_press $term, $event
…		…
333		334
334	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
335		336
336	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
337		338
338	Called whenever the corresponding X event is received for the terminal If	339	Called whenever the corresponding X event is received for the terminal. If
339	the hook returns true, then the even will be ignored by rxvt-unicode.	340	the hook returns true, then the event will be ignored by rxvt-unicode.
340		341
341	The event is a hash with most values as named by Xlib (see the XEvent	342	The event is a hash with most values as named by Xlib (see the XEvent
342	manpage), with the additional members C<row> and C<col>, which are the row	343	manpage), with the additional members C<row> and C<col>, which are the
343	and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
344		345
345	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
346	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
347		348
348	subwindow.	349	=item on_client_message $term, $event
		350
		351	=item on_wm_protocols $term, $event
		352
		353	=item on_wm_delete_window $term, $event
		354
		355	Called when various types of ClientMessage events are received (all with
		356	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		357
		358	=item on_bell $term
		359
		360	Called on receipt of a bell character.
349		361
350	=back	362	=back
351		363
352	=cut	364	=cut
353		365
354	package urxvt;	366	package urxvt;
355		367
356	use utf8;	368	use utf8;
357	use strict;	369	use strict 'vars';
358	use Carp ();	370	use Carp ();
359	use Scalar::Util ();	371	use Scalar::Util ();
360	use List::Util ();	372	use List::Util ();
361		373
362	our $VERSION = 1;	374	our $VERSION = 1;
363	our $TERM;	375	our $TERM;
		376	our @TERM_INIT; # should go, prevents async I/O etc.
		377	our @TERM_EXT; # should go, prevents async I/O etc.
364	our @HOOKNAME;	378	our @HOOKNAME;
365	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
366	our %OPTION;	380	our %OPTION;
367		381
368	our $LIBDIR;	382	our $LIBDIR;
369	our $RESNAME;	383	our $RESNAME;
370	our $RESCLASS;	384	our $RESCLASS;
371	our $RXVTNAME;	385	our $RXVTNAME;
372		386
		387	our $NOCHAR = chr 0xffff;
		388
373	=head2 Variables in the C<urxvt> Package	389	=head2 Variables in the C<urxvt> Package
374		390
375	=over 4	391	=over 4
376		392
377	=item $urxvt::LIBDIR	393	=item $urxvt::LIBDIR
…		…
390	=item $urxvt::TERM	406	=item $urxvt::TERM
391		407
392	The current terminal. This variable stores the current C<urxvt::term>	408	The current terminal. This variable stores the current C<urxvt::term>
393	object, whenever a callback/hook is executing.	409	object, whenever a callback/hook is executing.
394		410
		411	=item @urxvt::TERM_INIT
		412
		413	All code references in this array will be called as methods of the next newly
		414	created C<urxvt::term> object (during the C<on_init> phase). The array
		415	gets cleared before the code references that were in it are being executed,
		416	so references can push themselves onto it again if they so desire.
		417
		418	This complements to the perl-eval command line option, but gets executed
		419	first.
		420
		421	=item @urxvt::TERM_EXT
		422
		423	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		424	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		425	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		426
395	=back	427	=back
396		428
397	=head2 Functions in the C<urxvt> Package	429	=head2 Functions in the C<urxvt> Package
398		430
399	=over 4	431	=over 4
400		432
401	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
402		434
403	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
404	costs! The only time this is acceptable is when the terminal process	436	include a trailing newline). Avoid at all costs! The only time this
405	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
406		439
407	=item urxvt::warn $string	440	=item urxvt::warn $string
408		441
409	Calls C<rxvt_warn> with the given string which should not include a	442	Calls C<rxvt_warn> with the given string which should include a trailing
410	newline. The module also overwrites the C<warn> builtin with a function	443	newline. The module also overwrites the C<warn> builtin with a function
411	that calls this function.	444	that calls this function.
412		445
413	Using this function has the advantage that its output ends up in the	446	Using this function has the advantage that its output ends up in the
414	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
415		448
416	Messages have a size limit of 1023 bytes currently.	449	Messages have a size limit of 1023 bytes currently.
417		450
418	=item $is_safe = urxvt::safe	451	=item @terms = urxvt::termlist
419		452
420	Returns true when it is safe to do potentially unsafe things, such as	453	Returns all urxvt::term objects that exist in this process, regardless of
421	evaluating perl code specified by the user. This is true when urxvt was	454	whether they are started, being destroyed etc., so be careful. Only term
422	started setuid or setgid.	455	objects that have perl extensions attached will be returned (because there
		456	is no urxvt::term object associated with others).
423		457
424	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
425		459
426	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
427		461
428	=item urxvt::CurrentTime	462	=item urxvt::CurrentTime
429		463
430	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	464	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
431	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	465	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
432	Button4Mask, Button5Mask, AnyModifier	466	Button4Mask, Button5Mask, AnyModifier
		467
		468	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		469	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		470	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		471	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		472	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		473	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		474	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		475
		476	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		477	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		478	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		479	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		480	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		481	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		482	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
433		483
434	Various constants for use in X calls and event processing.	484	Various constants for use in X calls and event processing.
435		485
436	=back	486	=back
437		487
…		…
454		504
455	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
456		506
457	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
458		508
459	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	509	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		510	urxvt::RS_RVid, urxvt::RS_Uline
460		511
461	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
462	underline, respectively. To enable such a style, just logically OR it into	513	underline, respectively. To enable such a style, just logically OR it into
463	the bitset.	514	the bitset.
464		515
…		…
470		521
471	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	522	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
472		523
473	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	524	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
474		525
		526	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		527
475	Replace the foreground/background colour in the rendition mask with the	528	Replace the foreground/background colour in the rendition mask with the
476	specified one.	529	specified one.
477		530
478	=item $value = urxvt::GET_CUSTOM $rend	531	=item $value = urxvt::GET_CUSTOM $rend
479		532
…		…
488	=back	541	=back
489		542
490	=cut	543	=cut
491		544
492	BEGIN {	545	BEGIN {
493	urxvt->bootstrap;
494
495	# overwrite perl's warn	546	# overwrite perl's warn
496	*CORE::GLOBAL::warn = sub {	547	*CORE::GLOBAL::warn = sub {
497	my $msg = join "", @_;	548	my $msg = join "", @_;
498	$msg .= "\n"	549	$msg .= "\n"
499	unless $msg =~ /\n$/;	550	unless $msg =~ /\n$/;
500	urxvt::warn ($msg);	551	urxvt::warn ($msg);
501	};	552	};
502
503	# %ENV is the original startup environment
504	delete $ENV{IFS};
505	delete $ENV{CDPATH};
506	delete $ENV{BASH_ENV};
507	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
508	}	553	}
509		554
510	my @hook_count;	555	no warnings 'utf8';
		556
		557	sub parse_resource {
		558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		559
		560	$name =~ y/-/./ if $isarg;
		561
		562	$term->scan_extensions;
		563
		564	my $r = $term->{meta}{resource};
		565	keys %$r; # reset iterator
		566	while (my ($pattern, $v) = each %$r) {
		567	if (
		568	$pattern =~ /\.$/
		569	? $pattern eq substr $name, 0, length $pattern
		570	: $pattern eq $name
		571	) {
		572	$name = "$urxvt::RESCLASS.$name";
		573
		574	push @{ $term->{perl_ext_3} }, $v->[0];
		575
		576	if ($v->[1] eq "boolean") {
		577	$term->put_option_db ($name, $flag ? "true" : "false");
		578	return 1;
		579	} else {
		580	$term->put_option_db ($name, $value);
		581	return 1 + 2;
		582	}
		583	}
		584	}
		585
		586	0
		587	}
		588
		589	sub usage {
		590	my ($term, $usage_type) = @_;
		591
		592	$term->scan_extensions;
		593
		594	my $r = $term->{meta}{resource};
		595
		596	for my $pattern (sort keys %$r) {
		597	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		598
		599	$desc .= " (-pe $ext)";
		600
		601	if ($usage_type == 1) {
		602	$pattern =~ y/./-/;
		603	$pattern =~ s/-$/-.../g;
		604
		605	if ($type eq "boolean") {
		606	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		607	} else {
		608	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		609	}
		610	} else {
		611	$pattern =~ s/\.$/.*/g;
		612	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		613	}
		614	}
		615	}
		616
511	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
512		618
513	sub verbose {	619	sub verbose {
514	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
515	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
516	}	622	}
517		623
518	my $extension_pkg = "extension0000";
519	my %extension_pkg;	624	my %extension_pkg;
520		625
521	# load a single script into its own package, once only	626	# load a single script into its own package, once only
522	sub extension_package($) {	627	sub extension_package($) {
523	my ($path) = @_;	628	my ($path) = @_;
524		629
525	$extension_pkg{$path} ||= do {	630	$extension_pkg{$path} ||= do {
526	my $pkg = "urxvt::" . ($extension_pkg++);	631	$path =~ /([^\/\\]+)$/;
		632	my $pkg = $1;
		633	$pkg =~ s/[^[:word:]]/_/g;
		634	$pkg = "urxvt::ext::$pkg";
527		635
528	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
529		639
530	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
531	or die "$path: $!";	641	or die "$path: $!";
532		642
533	my $source = untaint	643	my $source =
534	"package $pkg; use strict; use utf8;\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
535	. "use base urxvt::term::extension::;\n"
536	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
537	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
538	. "\n};\n1";	647	. "\n};\n1";
539		648
540	eval $source	649	eval $source
…		…
549	# called by the rxvt core	658	# called by the rxvt core
550	sub invoke {	659	sub invoke {
551	local $TERM = shift;	660	local $TERM = shift;
552	my $htype = shift;	661	my $htype = shift;
553		662
554	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
555	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
556		665
		666	$TERM->scan_extensions;
		667
557	my %ext_arg;	668	my %ext_arg;
558		669
		670	{
		671	my @init = @TERM_INIT;
		672	@TERM_INIT = ();
		673	$_->($TERM) for @init;
		674	my @pkg = @TERM_EXT;
		675	@TERM_EXT = ();
		676	$TERM->register_package ($_) for @pkg;
		677	}
		678
		679	for (
		680	@{ delete $TERM->{perl_ext_3} },
559	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	681	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		682	) {
560	if ($_ eq "default") {	683	if ($_ eq "default") {
561	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	684
		685	$ext_arg{$_} ||= []
		686	for
		687	qw(selection option-popup selection-popup readline),
		688	map $_->[0], values %{ $TERM->{meta}{binding} };
		689
562	} elsif (/^-(.*)$/) {	690	} elsif (/^-(.*)$/) {
563	delete $ext_arg{$1};	691	delete $ext_arg{$1};
		692
564	} elsif (/^([^<]+)<(.*)>$/) {	693	} elsif (/^([^<]+)<(.*)>$/) {
565	push @{ $ext_arg{$1} }, $2;	694	push @{ $ext_arg{$1} }, $2;
		695
566	} else {	696	} else {
567	$ext_arg{$_} ||= [];	697	$ext_arg{$_} ||= [];
568	}	698	}
569	}	699	}
570		700
571	while (my ($ext, $argv) = each %ext_arg) {	701	# now register default key bindings
		702	while (my ($k, $v) = each %{ $TERM->{meta}{binding} }) {
		703	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
		704	}
		705
		706	for my $ext (sort keys %ext_arg) {
572	my @files = grep -f $_, map "$_/$ext", @dirs;	707	my @files = grep -f $_, map "$_/$ext", @dirs;
573		708
574	if (@files) {	709	if (@files) {
575	$TERM->register_package (extension_package $files[0], $argv);	710	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
576	} else {	711	} else {
577	warn "perl extension '$ext' not found in perl library search path\n";	712	warn "perl extension '$ext' not found in perl library search path\n";
578	}	713	}
579	}	714	}
580		715
…		…
586		721
587	if (my $cb = $TERM->{_hook}[$htype]) {	722	if (my $cb = $TERM->{_hook}[$htype]) {
588	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	723	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
589	if $verbosity >= 10;	724	if $verbosity >= 10;
590		725
591	keys %$cb;	726	if ($htype == HOOK_ACTION) {
		727	# this hook is only sent to the extension with the name
		728	# matching the first arg
		729	my $pkg = shift;
		730	$pkg =~ y/-/_/;
		731	$pkg = "urxvt::ext::$pkg";
592		732
593	while (my ($pkg, $cb) = each %$cb) {	733	$cb = $cb->{$pkg}
		734	or return undef; #TODO: maybe warn user?
		735
		736	$cb = { $pkg => $cb };
		737	}
		738
		739	for my $pkg (keys %$cb) {
594	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
595	and last;	741	$retval ||= $retval_;
596		742
597	if ($@) {	743	if ($@) {
598	$TERM->ungrab; # better to lose the grab than the session	744	$TERM->ungrab; # better to lose the grab than the session
599	warn $@;	745	warn $@;
600	}	746	}
…		…
602		748
603	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
604	if $verbosity >= 11;	750	if $verbosity >= 11;
605	}	751	}
606		752
607	if ($htype == 1) { # DESTROY	753	if ($htype == HOOK_DESTROY) {
608	if (my $hook = delete $TERM->{_hook}) {
609	for my $htype (0..$#$hook) {
610	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
611	or set_should_invoke $htype, 0;
612	}
613	}
614
615	# clear package objects	754	# clear package objects
616	%$_ = () for values %{ $TERM->{_pkg} };	755	%$_ = () for values %{ $TERM->{_pkg} };
617		756
618	# clear package	757	# clear package
619	%$TERM = ();	758	%$TERM = ();
620	}	759	}
621		760
622	$retval	761	$retval
623	}	762	}
624		763
625	sub exec_async(@) {	764	sub SET_COLOR($$$) {
626	my $pid = fork;	765	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
627
628	return
629	if !defined $pid or $pid;
630
631	%ENV = %{ $TERM->env };
632
633	exec @_;
634	_exit 255;
635	}	766	}
636		767
637	# urxvt::term::extension	768	sub rend2mask {
638		769	no strict 'refs';
639	package urxvt::term::extension;	770	my ($str, $mask) = (@_, 0);
640		771	my %color = ( fg => undef, bg => undef );
641	sub enable {	772	my @failed;
642	my ($self, %hook) = @_;	773	for my $spec ( split /\s+/, $str ) {
643	my $pkg = $self->{_pkg};	774	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
644		775	$color{lc($1)} = $2;
645	while (my ($name, $cb) = each %hook) {	776	} else {
646	my $htype = $HOOKTYPE{uc $name};	777	my $neg = $spec =~ s/^[-^]//;
647	defined $htype	778	unless ( exists &{"RS_$spec"} ) {
648	or Carp::croak "unsupported hook type '$name'";	779	push @failed, $spec;
649		780	next;
650	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
651	$hook_count[$htype]++
652	or urxvt::set_should_invoke $htype, 1;
653	}	781	}
654		782	my $cur = &{"RS_$spec"};
655	$self->{term}{_hook}[$htype]{$pkg} = $cb;	783	if ( $neg ) {
656	}	784	$mask &= ~$cur;
657	}	785	} else {
658		786	$mask |= $cur;
659	sub disable {	787	}
660	my ($self, @hook) = @_;
661	my $pkg = $self->{_pkg};
662
663	for my $name (@hook) {
664	my $htype = $HOOKTYPE{uc $name};
665	defined $htype
666	or Carp::croak "unsupported hook type '$name'";
667
668	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
669	--$hook_count[$htype]
670	or urxvt::set_should_invoke $htype, 0;
671	}	788	}
672	}	789	}
		790	($mask, @color{qw(fg bg)}, \@failed)
673	}	791	}
		792
		793	package urxvt::term::extension;
		794
		795	=head2 The C<urxvt::term::extension> class
		796
		797	Each extension attached to a terminal object is represented by
		798	a C<urxvt::term::extension> object.
		799
		800	You can use these objects, which are passed to all callbacks to store any
		801	state related to the terminal and extension instance.
		802
		803	The methods (And data members) documented below can be called on extension
		804	objects, in addition to call methods documented for the <urxvt::term>
		805	class.
		806
		807	=over 4
		808
		809	=item $urxvt_term = $self->{term}
		810
		811	Returns the C<urxvt::term> object associated with this instance of the
		812	extension. This member I<must not> be changed in any way.
		813
		814	=cut
674		815
675	our $AUTOLOAD;	816	our $AUTOLOAD;
676		817
677	sub AUTOLOAD {	818	sub AUTOLOAD {
678	$AUTOLOAD =~ /:([^:]+)$/	819	$AUTOLOAD =~ /:([^:]+)$/
…		…
691		832
692	sub DESTROY {	833	sub DESTROY {
693	# nop	834	# nop
694	}	835	}
695		836
696	# urxvt::destroy_hook	837	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
697		838
698	sub urxvt::destroy_hook::DESTROY {	839	sub urxvt::destroy_hook::DESTROY {
699	${$_[0]}->();	840	${$_[0]}->();
700	}	841	}
701		842
702	sub urxvt::destroy_hook(&) {	843	sub urxvt::destroy_hook(&) {
703	bless \shift, urxvt::destroy_hook::	844	bless \shift, urxvt::destroy_hook::
704	}	845	}
		846
		847	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		848
		849	Dynamically enable the given hooks (named without the C<on_> prefix) for
		850	this extension, replacing any hook previously installed via C<enable> in
		851	this extension.
		852
		853	This is useful when you want to overwrite time-critical hooks only
		854	temporarily.
		855
		856	To install additional callbacks for the same hook, you can use the C<on>
		857	method of the C<urxvt::term> class.
		858
		859	=item $self->disable ($hook_name[, $hook_name..])
		860
		861	Dynamically disable the given hooks.
		862
		863	=cut
		864
		865	sub enable {
		866	my ($self, %hook) = @_;
		867	my $pkg = $self->{_pkg};
		868
		869	while (my ($name, $cb) = each %hook) {
		870	my $htype = $HOOKTYPE{uc $name};
		871	defined $htype
		872	or Carp::croak "unsupported hook type '$name'";
		873
		874	$self->set_should_invoke ($htype, +1)
		875	unless exists $self->{term}{_hook}[$htype]{$pkg};
		876
		877	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		878	}
		879	}
		880
		881	sub disable {
		882	my ($self, @hook) = @_;
		883	my $pkg = $self->{_pkg};
		884
		885	for my $name (@hook) {
		886	my $htype = $HOOKTYPE{uc $name};
		887	defined $htype
		888	or Carp::croak "unsupported hook type '$name'";
		889
		890	$self->set_should_invoke ($htype, -1)
		891	if delete $self->{term}{_hook}[$htype]{$pkg};
		892	}
		893	}
		894
		895	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		896
		897	Similar to the C<enable> enable, but installs additional callbacks for
		898	the given hook(s) (that is, it doesn't replace existing callbacks), and
		899	returns a guard object. When the guard object is destroyed the callbacks
		900	are disabled again.
		901
		902	=cut
		903
		904	sub urxvt::extension::on_disable::DESTROY {
		905	my $disable = shift;
		906
		907	my $term = delete $disable->{""};
		908
		909	while (my ($htype, $id) = each %$disable) {
		910	delete $term->{_hook}[$htype]{$id};
		911	$term->set_should_invoke ($htype, -1);
		912	}
		913	}
		914
		915	sub on {
		916	my ($self, %hook) = @_;
		917
		918	my $term = $self->{term};
		919
		920	my %disable = ( "" => $term );
		921
		922	while (my ($name, $cb) = each %hook) {
		923	my $htype = $HOOKTYPE{uc $name};
		924	defined $htype
		925	or Carp::croak "unsupported hook type '$name'";
		926
		927	$term->set_should_invoke ($htype, +1);
		928	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		929	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		930	}
		931
		932	bless \%disable, "urxvt::extension::on_disable"
		933	}
		934
		935	=item $self->x_resource ($pattern)
		936
		937	=item $self->x_resource_boolean ($pattern)
		938
		939	These methods support an additional C<%> prefix when called on an
		940	extension object - see the description of these methods in the
		941	C<urxvt::term> class for details.
		942
		943	=cut
		944
		945	sub x_resource {
		946	my ($self, $name) = @_;
		947	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		948	$self->{term}->x_resource ($name)
		949	}
		950
		951	sub x_resource_boolean {
		952	my ($self, $name) = @_;
		953	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		954	$self->{term}->x_resource_boolean ($name)
		955	}
		956
		957	=back
		958
		959	=cut
705		960
706	package urxvt::anyevent;	961	package urxvt::anyevent;
707		962
708	=head2 The C<urxvt::anyevent> Class	963	=head2 The C<urxvt::anyevent> Class
709		964
710	The sole purpose of this class is to deliver an interface to the	965	The sole purpose of this class is to deliver an interface to the
711	C<AnyEvent> module - any module using it will work inside urxvt without	966	C<AnyEvent> module - any module using it will work inside urxvt without
712	further programming. The only exception is that you cannot wait on	967	further programming. The only exception is that you cannot wait on
713	condition variables, but non-blocking condvar use is ok. What this means	968	condition variables, but non-blocking condvar use is ok.
714	is that you cannot use blocking APIs, but the non-blocking variant should
715	work.
716		969
717	=cut	970	In practical terms this means is that you cannot use blocking APIs, but
		971	the non-blocking variant should work.
718		972
		973	=cut
		974
719	our $VERSION = 1;	975	our $VERSION = '5.23';
720		976
721	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	977	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
722	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	978	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
723		979
724	sub timer {	980	sub timer {
…		…
726		982
727	my $cb = $arg{cb};	983	my $cb = $arg{cb};
728		984
729	urxvt::timer	985	urxvt::timer
730	->new	986	->new
731	->start (urxvt::NOW + $arg{after})	987	->after ($arg{after}, $arg{interval})
732	->cb (sub {	988	->cb ($arg{interval} ? $cb : sub {
733	$_[0]->stop; # need to cancel manually	989	$_[0]->stop; # need to cancel manually
734	$cb->();	990	$cb->();
735	})	991	})
736	}	992	}
737		993
738	sub io {	994	sub io {
739	my ($class, %arg) = @_;	995	my ($class, %arg) = @_;
740		996
741	my $cb = $arg{cb};	997	my $cb = $arg{cb};
		998	my $fd = fileno $arg{fh};
		999	defined $fd or $fd = $arg{fh};
742		1000
743	bless [$arg{fh}, urxvt::iow	1001	bless [$arg{fh}, urxvt::iow
744	->new	1002	->new
745	->fd (fileno $arg{fh})	1003	->fd ($fd)
746	->events (($arg{poll} =~ /r/ ? 1 : 0)	1004	->events (($arg{poll} =~ /r/ ? 1 : 0)
747	| ($arg{poll} =~ /w/ ? 2 : 0))	1005	| ($arg{poll} =~ /w/ ? 2 : 0))
748	->start	1006	->start
749	->cb (sub {	1007	->cb ($cb)
750	$cb->(($_[1] & 1 ? 'r' : '')
751	. ($_[1] & 2 ? 'w' : ''));
752	})],
753	urxvt::anyevent::	1008	], urxvt::anyevent::
		1009	}
		1010
		1011	sub idle {
		1012	my ($class, %arg) = @_;
		1013
		1014	my $cb = $arg{cb};
		1015
		1016	urxvt::iw
		1017	->new
		1018	->start
		1019	->cb ($cb)
		1020	}
		1021
		1022	sub child {
		1023	my ($class, %arg) = @_;
		1024
		1025	my $cb = $arg{cb};
		1026
		1027	urxvt::pw
		1028	->new
		1029	->start ($arg{pid})
		1030	->cb (sub {
		1031	$_[0]->stop; # need to cancel manually
		1032	$cb->($_[0]->rpid, $_[0]->rstatus);
		1033	})
754	}	1034	}
755		1035
756	sub DESTROY {	1036	sub DESTROY {
757	$_[0][1]->stop;	1037	$_[0][1]->stop;
758	}	1038	}
759		1039
760	sub condvar {	1040	# only needed for AnyEvent < 6 compatibility
761	bless \my $flag, urxvt::anyevent::condvar::	1041	sub one_event {
762	}
763
764	sub urxvt::anyevent::condvar::broadcast {
765	${$_[0]}++;
766	}
767
768	sub urxvt::anyevent::condvar::wait {
769	unless (${$_[0]}) {
770	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1042	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
771	}
772	}	1043	}
773		1044
774	package urxvt::term;	1045	package urxvt::term;
775		1046
776	=head2 The C<urxvt::term> Class	1047	=head2 The C<urxvt::term> Class
…		…
782	# find on_xxx subs in the package and register them	1053	# find on_xxx subs in the package and register them
783	# as hooks	1054	# as hooks
784	sub register_package {	1055	sub register_package {
785	my ($self, $pkg, $argv) = @_;	1056	my ($self, $pkg, $argv) = @_;
786		1057
		1058	no strict 'refs';
		1059
		1060	urxvt::verbose 6, "register package $pkg to $self";
		1061
		1062	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1063
787	my $proxy = bless {	1064	my $proxy = bless {
788	_pkg => $pkg,	1065	_pkg => $pkg,
		1066	_name => ${"$pkg\::_NAME"}, # hackish
789	argv => $argv,	1067	argv => $argv,
790	}, $pkg;	1068	}, $pkg;
791	Scalar::Util::weaken ($proxy->{term} = $self);	1069	Scalar::Util::weaken ($proxy->{term} = $self);
792		1070
793	$self->{_pkg}{$pkg} = $proxy;	1071	$self->{_pkg}{$pkg} = $proxy;
794		1072
…		…
797	$proxy->enable ($name => $ref);	1075	$proxy->enable ($name => $ref);
798	}	1076	}
799	}	1077	}
800	}	1078	}
801		1079
		1080	sub perl_libdirs {
		1081	map { split /:/ }
		1082	$_[0]->resource ("perl_lib"),
		1083	$ENV{URXVT_PERL_LIB},
		1084	"$ENV{HOME}/.urxvt/ext",
		1085	"$LIBDIR/perl"
		1086	}
		1087
		1088	# scan for available extensions and collect their metadata
		1089	sub scan_extensions {
		1090	my ($self) = @_;
		1091
		1092	return if exists $self->{meta};
		1093
		1094	my @libdirs = perl_libdirs $self;
		1095
		1096	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1097
		1098	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1099	$self->{meta} = \my %meta;
		1100
		1101	# first gather extensions
		1102	for my $dir (reverse @libdirs) {
		1103	opendir my $fh, $dir
		1104	or next;
		1105	for my $ext (readdir $fh) {
		1106	$ext !~ /^\./
		1107	and open my $fh, "<", "$dir/$ext"
		1108	or next;
		1109
		1110	my %ext = (dir => $dir);
		1111
		1112	while (<$fh>) {
		1113	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1114	my ($pattern, $type, $desc) = split /:/, $1;
		1115	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1116	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1117	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1118	} else {
		1119	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1120	}
		1121	} elsif (/^#:META:BINDING:(.*)/) {
		1122	my ($keysym, $action) = split /:/, $1;
		1123	$ext{binding}{$keysym} = [$ext, $action];
		1124	} elsif (/^\s*(?:#|$)/) {
		1125	# skip other comments and empty lines
		1126	} else {
		1127	last; # stop parsing on first non-empty non-comment line
		1128	}
		1129	}
		1130
		1131	$meta{ext}{$ext} = \%ext;
		1132	}
		1133	}
		1134
		1135	# and now merge resources and bindings
		1136	while (my ($k, $v) = each %{ $meta{ext} }) {
		1137	#TODO: should check for extensions overriding each other
		1138	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1139	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1140	}
		1141	}
		1142
802	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1143	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
803		1144
804	Creates a new terminal, very similar as if you had started it with system	1145	Creates a new terminal, very similar as if you had started it with system
805	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1146	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
806	hash which defines the environment of the new terminal.	1147	hash which defines the environment of the new terminal.
807		1148
808	Croaks (and probably outputs an error message) if the new instance	1149	Croaks (and probably outputs an error message) if the new instance
809	couldn't be created. Returns C<undef> if the new instance didn't	1150	couldn't be created. Returns C<undef> if the new instance didn't
810	initialise perl, and the terminal object otherwise. The C<init> and	1151	initialise perl, and the terminal object otherwise. The C<init> and
811	C<start> hooks will be called during this call.	1152	C<start> hooks will be called before this call returns, and are free to
		1153	refer to global data (which is race free).
812		1154
813	=cut	1155	=cut
814		1156
815	sub new {	1157	sub new {
816	my ($class, $env, @args) = @_;	1158	my ($class, $env, @args) = @_;
817		1159
		1160	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1161	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1162
818	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1163	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
819	}	1164	}
820		1165
821	=item $term->destroy	1166	=item $term->destroy
822		1167
823	Destroy the terminal object (close the window, free resources	1168	Destroy the terminal object (close the window, free resources
824	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1169	etc.). Please note that urxvt will not exit as long as any event
825	watchers (timers, io watchers) are still active.	1170	watchers (timers, io watchers) are still active.
		1171
		1172	=item $term->exec_async ($cmd[, @args])
		1173
		1174	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1175	("starts") programs in the background. This function takes care of setting
		1176	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1177	be preferred over explicit calls to C<exec> or C<system>.
		1178
		1179	Returns the pid of the subprocess or C<undef> on error.
		1180
		1181	=cut
		1182
		1183	sub exec_async {
		1184	my $self = shift;
		1185
		1186	my $pid = fork;
		1187
		1188	return $pid
		1189	if !defined $pid or $pid;
		1190
		1191	%ENV = %{ $self->env };
		1192
		1193	exec @_;
		1194	urxvt::_exit 255;
		1195	}
826		1196
827	=item $isset = $term->option ($optval[, $set])	1197	=item $isset = $term->option ($optval[, $set])
828		1198
829	Returns true if the option specified by C<$optval> is enabled, and	1199	Returns true if the option specified by C<$optval> is enabled, and
830	optionally change it. All option values are stored by name in the hash	1200	optionally change it. All option values are stored by name in the hash
831	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1201	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
832		1202
833	Here is a a likely non-exhaustive list of option names, please see the	1203	Here is a likely non-exhaustive list of option names, please see the
834	source file F</src/optinc.h> to see the actual list:	1204	source file F</src/optinc.h> to see the actual list:
835		1205
836	borderLess console cursorBlink cursorUnderline hold iconic insecure	1206	borderLess buffered console cursorBlink cursorUnderline hold iconic
837	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1207	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1208	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
838	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1209	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
839	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1210	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
840	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1211	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
841	tripleclickwords utmpInhibit visualBell	1212	urgentOnBell utmpInhibit visualBell
842		1213
843	=item $value = $term->resource ($name[, $newval])	1214	=item $value = $term->resource ($name[, $newval])
844		1215
845	Returns the current resource value associated with a given name and	1216	Returns the current resource value associated with a given name and
846	optionally sets a new value. Setting values is most useful in the C<init>	1217	optionally sets a new value. Setting values is most useful in the C<init>
…		…
855	likely change).	1226	likely change).
856		1227
857	Please note that resource strings will currently only be freed when the	1228	Please note that resource strings will currently only be freed when the
858	terminal is destroyed, so changing options frequently will eat memory.	1229	terminal is destroyed, so changing options frequently will eat memory.
859		1230
860	Here is a a likely non-exhaustive list of resource names, not all of which	1231	Here is a likely non-exhaustive list of resource names, not all of which
861	are supported in every build, please see the source file F</src/rsinc.h>	1232	are supported in every build, please see the source file F</src/rsinc.h>
862	to see the actual list:	1233	to see the actual list:
863		1234
864	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1235	answerbackstring backgroundPixmap backspace_key blurradius
865	borderLess color cursorBlink cursorUnderline cutchars delete_key	1236	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
866	display_name embed ext_bwidth fade font geometry hold iconName	1237	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
867	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1238	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1239	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
868	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1240	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
869	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1241	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
870	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1242	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
871	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1243	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
872	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1244	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
873	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1245	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
874	shade term_name title transparent transparent_all tripleclickwords	1246	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1247	term_name title transient_for transparent tripleclickwords urgentOnBell
875	utmpInhibit visualBell	1248	utmpInhibit visualBell
876		1249
877	=cut	1250	=cut
878		1251
879	sub resource($$;$) {	1252	sub resource($$;$) {
880	my ($self, $name) = (shift, shift);	1253	my ($self, $name) = (shift, shift);
881	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1254	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
882	&urxvt::term::_resource	1255	goto &urxvt::term::_resource
883	}	1256	}
884		1257
885	=item $value = $term->x_resource ($pattern)	1258	=item $value = $term->x_resource ($pattern)
886		1259
887	Returns the X-Resource for the given pattern, excluding the program or	1260	Returns the X-Resource for the given pattern, excluding the program or
888	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1261	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
889	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1262	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
890	resource with that pattern exists.	1263	resource with that pattern exists.
891		1264
		1265	Extensions that define extra resource or command line arguments also need
		1266	to call this method to access their values.
		1267
		1268	If the method is called on an extension object (basically, from an
		1269	extension), then the special prefix C<%.> will be replaced by the name of
		1270	the extension and a dot, and the lone string C<%> will be replaced by the
		1271	extension name itself. This makes it possible to code extensions so you
		1272	can rename them and get a new set of commandline switches and resources
		1273	without having to change the actual code.
		1274
892	This method should only be called during the C<on_start> hook, as there is	1275	This method should only be called during the C<on_start> hook, as there is
893	only one resource database per display, and later invocations might return	1276	only one resource database per display, and later invocations might return
894	the wrong resources.	1277	the wrong resources.
895		1278
896	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1279	=item $value = $term->x_resource_boolean ($pattern)
897		1280
		1281	Like C<x_resource>, above, but interprets the string value as a boolean
		1282	and returns C<1> for true values, C<0> for false values and C<undef> if
		1283	the resource or option isn't specified.
		1284
		1285	You should always use this method to parse boolean resources.
		1286
		1287	=cut
		1288
		1289	sub x_resource_boolean {
		1290	my $res = &x_resource;
		1291
		1292	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1293	}
		1294
		1295	=item $success = $term->bind_action ($key, $octets)
		1296
898	Adds a keymap translation exactly as specified via a resource. See the	1297	Adds a key binding exactly as specified via a C<keysym> resource. See the
899	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1298	C<keysym> resource in the urxvt(1) manpage.
900		1299
901	=item $rend = $term->rstyle ([$new_rstyle])	1300	=item $rend = $term->rstyle ([$new_rstyle])
902		1301
903	Return and optionally change the current rendition. Text that is output by	1302	Return and optionally change the current rendition. Text that is output by
904	the terminal application will use this style.	1303	the terminal application will use this style.
…		…
912		1311
913	=item ($row, $col) = $term->selection_beg ([$row, $col])	1312	=item ($row, $col) = $term->selection_beg ([$row, $col])
914		1313
915	=item ($row, $col) = $term->selection_end ([$row, $col])	1314	=item ($row, $col) = $term->selection_end ([$row, $col])
916		1315
917	Return the current values of the selection mark, begin or end positions,	1316	Return the current values of the selection mark, begin or end positions.
918	and optionally set them to new values.	1317
		1318	When arguments are given, then the selection coordinates are set to
		1319	C<$row> and C<$col>, and the selection screen is set to the current
		1320	screen.
		1321
		1322	=item $screen = $term->selection_screen ([$screen])
		1323
		1324	Returns the current selection screen, and then optionally sets it.
919		1325
920	=item $term->selection_make ($eventtime[, $rectangular])	1326	=item $term->selection_make ($eventtime[, $rectangular])
921		1327
922	Tries to make a selection as set by C<selection_beg> and	1328	Tries to make a selection as set by C<selection_beg> and
923	C<selection_end>. If C<$rectangular> is true (default: false), a	1329	C<selection_end>. If C<$rectangular> is true (default: false), a
924	rectangular selection will be made. This is the prefered function to make	1330	rectangular selection will be made. This is the preferred function to make
925	a selection.	1331	a selection.
926		1332
927	=item $success = $term->selection_grab ($eventtime)	1333	=item $success = $term->selection_grab ($eventtime[, $clipboard])
928		1334
929	Try to request the primary selection text from the server (for example, as	1335	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1336	true) selection from the server. The corresponding text can be set
930	set by the next method). No visual feedback will be given. This function	1337	with the next method. No visual feedback will be given. This function
931	is mostly useful from within C<on_sel_grab> hooks.	1338	is mostly useful from within C<on_sel_grab> hooks.
932		1339
933	=item $oldtext = $term->selection ([$newtext])	1340	=item $oldtext = $term->selection ([$newtext, $clipboard])
934		1341
935	Return the current selection text and optionally replace it by C<$newtext>.	1342	Return the current selection (clipboard if C<$clipboard> is true) text
		1343	and optionally replace it by C<$newtext>.
		1344
		1345	=item $term->selection_clear ([$clipboard])
		1346
		1347	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
936		1348
937	=item $term->overlay_simple ($x, $y, $text)	1349	=item $term->overlay_simple ($x, $y, $text)
938		1350
939	Create a simple multi-line overlay box. See the next method for details.	1351	Create a simple multi-line overlay box. See the next method for details.
940		1352
…		…
970		1382
971	The methods currently supported on C<urxvt::overlay> objects are:	1383	The methods currently supported on C<urxvt::overlay> objects are:
972		1384
973	=over 4	1385	=over 4
974		1386
975	=item $overlay->set ($x, $y, $text, $rend)	1387	=item $overlay->set ($x, $y, $text[, $rend])
976		1388
977	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1389	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
978	text in rxvt-unicode's special encoding and an array of rendition values	1390	text in rxvt-unicode's special encoding and an array of rendition values
979	at a specific position inside the overlay.	1391	at a specific position inside the overlay.
		1392
		1393	If C<$rend> is missing, then the rendition will not be changed.
980		1394
981	=item $overlay->hide	1395	=item $overlay->hide
982		1396
983	If visible, hide the overlay, but do not destroy it.	1397	If visible, hide the overlay, but do not destroy it.
984		1398
…		…
1054		1468
1055	Normally its not a good idea to use this function, as programs might be	1469	Normally its not a good idea to use this function, as programs might be
1056	confused by changes in cursor position or scrolling. Its useful inside a	1470	confused by changes in cursor position or scrolling. Its useful inside a
1057	C<on_add_lines> hook, though.	1471	C<on_add_lines> hook, though.
1058		1472
		1473	=item $term->scr_change_screen ($screen)
		1474
		1475	Switch to given screen - 0 primary, 1 secondary.
		1476
1059	=item $term->cmd_parse ($octets)	1477	=item $term->cmd_parse ($octets)
1060		1478
1061	Similar to C<scr_add_lines>, but the argument must be in the	1479	Similar to C<scr_add_lines>, but the argument must be in the
1062	locale-specific encoding of the terminal and can contain command sequences	1480	locale-specific encoding of the terminal and can contain command sequences
1063	(escape codes) that will be interpreted.	1481	(escape codes) that will be interpreted.
1064		1482
1065	=item $term->tt_write ($octets)	1483	=item $term->tt_write ($octets)
1066		1484
1067	Write the octets given in C<$data> to the tty (i.e. as program input). To	1485	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1068	pass characters instead of octets, you should convert your strings first	1486	pass characters instead of octets, you should convert your strings first
1069	to the locale-specific encoding using C<< $term->locale_encode >>.	1487	to the locale-specific encoding using C<< $term->locale_encode >>.
		1488
		1489	=item $term->tt_write_user_input ($octets)
		1490
		1491	Like C<tt_write>, but should be used when writing strings in response to
		1492	the user pressing a key, to invokes the additional actions requested by
		1493	the user for that case (C<tt_write> doesn't do that).
		1494
		1495	The typical use case would be inside C<on_action> hooks.
		1496
		1497	=item $term->tt_paste ($octets)
		1498
		1499	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1500	CR and bracketing the data with control sequences if bracketed paste mode
		1501	is set.
1070		1502
1071	=item $old_events = $term->pty_ev_events ([$new_events])	1503	=item $old_events = $term->pty_ev_events ([$new_events])
1072		1504
1073	Replaces the event mask of the pty watcher by the given event mask. Can	1505	Replaces the event mask of the pty watcher by the given event mask. Can
1074	be used to suppress input and output handling to the pty/tty. See the	1506	be used to suppress input and output handling to the pty/tty. See the
1075	description of C<< urxvt::timer->events >>. Make sure to always restore	1507	description of C<< urxvt::timer->events >>. Make sure to always restore
1076	the previous value.	1508	the previous value.
1077		1509
		1510	=item $fd = $term->pty_fd
		1511
		1512	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1513	is used.
		1514
1078	=item $windowid = $term->parent	1515	=item $windowid = $term->parent
1079		1516
1080	Return the window id of the toplevel window.	1517	Return the window id of the toplevel window.
1081		1518
1082	=item $windowid = $term->vt	1519	=item $windowid = $term->vt
1083		1520
1084	Return the window id of the terminal window.	1521	Return the window id of the terminal window.
1085		1522
		1523	=item $term->vt_emask_add ($x_event_mask)
		1524
		1525	Adds the specified events to the vt event mask. Useful e.g. when you want
		1526	to receive pointer events all the times:
		1527
		1528	$term->vt_emask_add (urxvt::PointerMotionMask);
		1529
		1530	=item $term->set_urgency ($set)
		1531
		1532	Enable/disable the urgency hint on the toplevel window.
		1533
		1534	=item $term->focus_in
		1535
		1536	=item $term->focus_out
		1537
		1538	=item $term->key_press ($state, $keycode[, $time])
		1539
		1540	=item $term->key_release ($state, $keycode[, $time])
		1541
		1542	Deliver various fake events to to terminal.
		1543
1086	=item $window_width = $term->width	1544	=item $window_width = $term->width
1087		1545
1088	=item $window_height = $term->height	1546	=item $window_height = $term->height
1089		1547
1090	=item $font_width = $term->fwidth	1548	=item $font_width = $term->fwidth
…		…
1103		1561
1104	=item $max_scrollback = $term->saveLines	1562	=item $max_scrollback = $term->saveLines
1105		1563
1106	=item $nrow_plus_saveLines = $term->total_rows	1564	=item $nrow_plus_saveLines = $term->total_rows
1107		1565
1108	=item $lines_in_scrollback = $term->nsaved	1566	=item $topmost_scrollback_row = $term->top_row
1109		1567
1110	Return various integers describing terminal characteristics.	1568	Return various integers describing terminal characteristics.
1111		1569
1112	=item $x_display = $term->display_id	1570	=item $x_display = $term->display_id
1113		1571
…		…
1120	=item $env = $term->env	1578	=item $env = $term->env
1121		1579
1122	Returns a copy of the environment in effect for the terminal as a hashref	1580	Returns a copy of the environment in effect for the terminal as a hashref
1123	similar to C<\%ENV>.	1581	similar to C<\%ENV>.
1124		1582
		1583	=item @envv = $term->envv
		1584
		1585	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1586
		1587	=item @argv = $term->argv
		1588
		1589	Return the argument vector as this terminal, similar to @ARGV, but
		1590	includes the program name as first element.
		1591
1125	=cut	1592	=cut
1126		1593
1127	sub env {	1594	sub env {
1128	if (my $env = $_[0]->_env) {
1129	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1595	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1130	} else {
1131	+{ %ENV }
1132	}
1133	}	1596	}
1134		1597
1135	=item $modifiermask = $term->ModLevel3Mask	1598	=item $modifiermask = $term->ModLevel3Mask
1136		1599
1137	=item $modifiermask = $term->ModMetaMask	1600	=item $modifiermask = $term->ModMetaMask
…		…
1139	=item $modifiermask = $term->ModNumLockMask	1602	=item $modifiermask = $term->ModNumLockMask
1140		1603
1141	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1604	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1142	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1605	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1143		1606
		1607	=item $screen = $term->current_screen
		1608
		1609	Returns the currently displayed screen (0 primary, 1 secondary).
		1610
		1611	=item $cursor_is_hidden = $term->hidden_cursor
		1612
		1613	Returns whether the cursor is currently hidden or not.
		1614
1144	=item $view_start = $term->view_start ([$newvalue])	1615	=item $view_start = $term->view_start ([$newvalue])
1145		1616
1146	Returns the negative row number of the topmost line. Minimum value is	1617	Returns the row number of the topmost displayed line. Maximum value is
1147	C<0>, which displays the normal terminal contents. Larger values scroll	1618	C<0>, which displays the normal terminal contents. Lower values scroll
1148	this many lines into the scrollback buffer.	1619	this many lines into the scrollback buffer.
1149		1620
1150	=item $term->want_refresh	1621	=item $term->want_refresh
1151		1622
1152	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1623	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1155		1626
1156	Used after changing terminal contents to display them.	1627	Used after changing terminal contents to display them.
1157		1628
1158	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1629	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1159		1630
1160	Returns the text of the entire row with number C<$row_number>. Row C<0>	1631	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1161	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1632	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1162	terminal line. The scrollback buffer starts at line C<-1> and extends to
1163	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1633	terminal line. Nothing will be returned if a nonexistent line
1164	is requested.	1634	is requested.
1165		1635
1166	If C<$new_text> is specified, it will replace characters in the current	1636	If C<$new_text> is specified, it will replace characters in the current
1167	line, starting at column C<$start_col> (default C<0>), which is useful	1637	line, starting at column C<$start_col> (default C<0>), which is useful
1168	to replace only parts of a line. The font index in the rendition will	1638	to replace only parts of a line. The font index in the rendition will
1169	automatically be updated.	1639	automatically be updated.
1170		1640
1171	C<$text> is in a special encoding: tabs and wide characters that use more	1641	C<$text> is in a special encoding: tabs and wide characters that use more
1172	than one cell when displayed are padded with urxvt::NOCHAR characters	1642	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1173	(C<chr 65535>). Characters with combining characters and other characters	1643	characters. Characters with combining characters and other characters that
1174	that do not fit into the normal tetx encoding will be replaced with	1644	do not fit into the normal text encoding will be replaced with characters
1175	characters in the private use area.	1645	in the private use area.
1176		1646
1177	You have to obey this encoding when changing text. The advantage is	1647	You have to obey this encoding when changing text. The advantage is
1178	that C<substr> and similar functions work on screen cells and not on	1648	that C<substr> and similar functions work on screen cells and not on
1179	characters.	1649	characters.
1180		1650
…		…
1264	}	1734	}
1265		1735
1266	sub urxvt::line::t {	1736	sub urxvt::line::t {
1267	my ($self) = @_;	1737	my ($self) = @_;
1268		1738
1269	if (@_ > 1)	1739	if (@_ > 1) {
1270	{
1271	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1740	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1272	for $self->{beg} .. $self->{end};	1741	for $self->{beg} .. $self->{end};
1273	}	1742	}
1274		1743
1275	defined wantarray &&	1744	defined wantarray &&
1276	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1745	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1277	0, $self->{len}	1746	0, $self->{len}
1278	}	1747	}
1279		1748
1280	sub urxvt::line::r {	1749	sub urxvt::line::r {
1281	my ($self) = @_;	1750	my ($self) = @_;
1282		1751
1283	if (@_ > 1)	1752	if (@_ > 1) {
1284	{
1285	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1753	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1286	for $self->{beg} .. $self->{end};	1754	for $self->{beg} .. $self->{end};
1287	}	1755	}
1288		1756
1289	if (defined wantarray) {	1757	if (defined wantarray) {
1290	my $rend = [	1758	my $rend = [
1291	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1759	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1292	];	1760	];
…		…
1324	where one character corresponds to one screen cell. See	1792	where one character corresponds to one screen cell. See
1325	C<< $term->ROW_t >> for details.	1793	C<< $term->ROW_t >> for details.
1326		1794
1327	=item $string = $term->special_decode $text	1795	=item $string = $term->special_decode $text
1328		1796
1329	Converts rxvt-unicodes text reprsentation into a perl string. See	1797	Converts rxvt-unicodes text representation into a perl string. See
1330	C<< $term->ROW_t >> for details.	1798	C<< $term->ROW_t >> for details.
1331		1799
1332	=item $success = $term->grab_button ($button, $modifiermask)	1800	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1333		1801
		1802	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1803
1334	Registers a synchronous button grab. See the XGrabButton manpage.	1804	Register/unregister a synchronous button grab. See the XGrabButton
		1805	manpage.
1335		1806
1336	=item $success = $term->grab ($eventtime[, $sync])	1807	=item $success = $term->grab ($eventtime[, $sync])
1337		1808
1338	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1809	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1339	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1810	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1340		1811
1341	=item $term->allow_events_async	1812	=item $term->allow_events_async
1342		1813
1343	Calls XAllowEvents with AsyncBoth for the most recent grab.	1814	Calls XAllowEvents with AsyncBoth for the most recent grab.
1344		1815
…		…
1351	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1822	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1352	recent grab.	1823	recent grab.
1353		1824
1354	=item $term->ungrab	1825	=item $term->ungrab
1355		1826
1356	Calls XUngrab for the most recent grab. Is called automatically on	1827	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1357	evaluation errors, as it is better to lose the grab in the error case as	1828	evaluation errors, as it is better to lose the grab in the error case as
1358	the session.	1829	the session.
		1830
		1831	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1832
		1833	=item $atom_name = $term->XGetAtomName ($atom)
		1834
		1835	=item @atoms = $term->XListProperties ($window)
		1836
		1837	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1838
		1839	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1840
		1841	=item $term->XDeleteProperty ($window, $property)
		1842
		1843	=item $window = $term->DefaultRootWindow
		1844
		1845	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1846
		1847	=item $term->XMapWindow ($window)
		1848
		1849	=item $term->XUnmapWindow ($window)
		1850
		1851	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1852
		1853	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1854
		1855	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1856
		1857	=item $keysym = $term->XStringToKeysym ($string)
		1858
		1859	=item $string = $term->XKeysymToString ($keysym)
		1860
		1861	Various X or X-related functions. The C<$term> object only serves as
		1862	the source of the display, otherwise those functions map more-or-less
		1863	directly onto the X functions of the same name.
1359		1864
1360	=back	1865	=back
1361		1866
1362	=cut	1867	=cut
1363		1868
…		…
1427	my ($self, $text, $cb) = @_;	1932	my ($self, $text, $cb) = @_;
1428		1933
1429	$self->add_item ({ type => "button", text => $text, activate => $cb});	1934	$self->add_item ({ type => "button", text => $text, activate => $cb});
1430	}	1935	}
1431		1936
1432	=item $popup->add_toggle ($text, $cb, $initial_value)	1937	=item $popup->add_toggle ($text, $initial_value, $cb)
1433		1938
1434	Adds a toggle/checkbox item to the popup. Teh callback gets called	1939	Adds a toggle/checkbox item to the popup. The callback gets called
1435	whenever it gets toggled, with a boolean indicating its value as its first	1940	whenever it gets toggled, with a boolean indicating its new value as its
1436	argument.	1941	first argument.
1437		1942
1438	=cut	1943	=cut
1439		1944
1440	sub add_toggle {	1945	sub add_toggle {
1441	my ($self, $text, $cb, $value) = @_;	1946	my ($self, $text, $value, $cb) = @_;
1442		1947
1443	my $item; $item = {	1948	my $item; $item = {
1444	type => "button",	1949	type => "button",
1445	text => " $text",	1950	text => " $text",
1446	value => $value,	1951	value => $value,
…		…
1465	my $env = $self->{term}->env;	1970	my $env = $self->{term}->env;
1466	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1971	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1467	delete $env->{LC_ALL};	1972	delete $env->{LC_ALL};
1468	$env->{LC_CTYPE} = $self->{term}->locale;	1973	$env->{LC_CTYPE} = $self->{term}->locale;
1469		1974
1470	urxvt::term->new ($env, $self->{term}->resource ("name"),	1975	my $term = urxvt::term->new (
1471	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1976	$env, "popup",
		1977	"--perl-lib" => "", "--perl-ext-common" => "",
		1978	"-pty-fd" => -1, "-sl" => 0,
		1979	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1472	"--transient-for" => $self->{term}->parent,	1980	"--transient-for" => $self->{term}->parent,
1473	"-display" => $self->{term}->display_id,	1981	"-display" => $self->{term}->display_id,
1474	"-pe" => "urxvt-popup")	1982	"-pe" => "urxvt-popup",
1475	or die "unable to create popup window\n";	1983	) or die "unable to create popup window\n";
		1984
		1985	unless (delete $term->{urxvt_popup_init_done}) {
		1986	$term->ungrab;
		1987	$term->destroy;
		1988	die "unable to initialise popup window\n";
		1989	}
1476	}	1990	}
1477		1991
1478	sub DESTROY {	1992	sub DESTROY {
1479	my ($self) = @_;	1993	my ($self) = @_;
1480		1994
1481	delete $self->{term}{_destroy}{$self};	1995	delete $self->{term}{_destroy}{$self};
1482	$self->{term}->ungrab;	1996	$self->{term}->ungrab;
1483	}	1997	}
1484		1998
1485	=back	1999	=back
		2000
		2001	=cut
		2002
		2003	package urxvt::watcher;
1486		2004
1487	=head2 The C<urxvt::timer> Class	2005	=head2 The C<urxvt::timer> Class
1488		2006
1489	This class implements timer watchers/events. Time is represented as a	2007	This class implements timer watchers/events. Time is represented as a
1490	fractional number of seconds since the epoch. Example:	2008	fractional number of seconds since the epoch. Example:
…		…
1494	->new	2012	->new
1495	->interval (1)	2013	->interval (1)
1496	->cb (sub {	2014	->cb (sub {
1497	$term->{overlay}->set (0, 0,	2015	$term->{overlay}->set (0, 0,
1498	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2016	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1499	});	2017	});
1500		2018
1501	=over 4	2019	=over 4
1502		2020
1503	=item $timer = new urxvt::timer	2021	=item $timer = new urxvt::timer
1504		2022
…		…
1507		2025
1508	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2026	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1509		2027
1510	Set the callback to be called when the timer triggers.	2028	Set the callback to be called when the timer triggers.
1511		2029
1512	=item $tstamp = $timer->at
1513
1514	Return the time this watcher will fire next.
1515
1516	=item $timer = $timer->set ($tstamp)	2030	=item $timer = $timer->set ($tstamp[, $interval])
1517		2031
1518	Set the time the event is generated to $tstamp.	2032	Set the time the event is generated to $tstamp (and optionally specifies a
		2033	new $interval).
1519		2034
1520	=item $timer = $timer->interval ($interval)	2035	=item $timer = $timer->interval ($interval)
1521		2036
1522	Normally (and when C<$interval> is C<0>), the timer will automatically	2037	By default (and when C<$interval> is C<0>), the timer will automatically
1523	stop after it has fired once. If C<$interval> is non-zero, then the timer	2038	stop after it has fired once. If C<$interval> is non-zero, then the timer
1524	is automatically rescheduled at the given intervals.	2039	is automatically rescheduled at the given intervals.
1525		2040
1526	=item $timer = $timer->start	2041	=item $timer = $timer->start
1527		2042
1528	Start the timer.	2043	Start the timer.
1529		2044
1530	=item $timer = $timer->start ($tstamp)	2045	=item $timer = $timer->start ($tstamp[, $interval])
1531		2046
1532	Set the event trigger time to C<$tstamp> and start the timer.	2047	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2048	also replaces the interval.
		2049
		2050	=item $timer = $timer->after ($delay[, $interval])
		2051
		2052	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1533		2053
1534	=item $timer = $timer->stop	2054	=item $timer = $timer->stop
1535		2055
1536	Stop the timer.	2056	Stop the timer.
1537		2057
…		…
1543		2063
1544	$term->{socket} = ...	2064	$term->{socket} = ...
1545	$term->{iow} = urxvt::iow	2065	$term->{iow} = urxvt::iow
1546	->new	2066	->new
1547	->fd (fileno $term->{socket})	2067	->fd (fileno $term->{socket})
1548	->events (urxvt::EVENT_READ)	2068	->events (urxvt::EV_READ)
1549	->start	2069	->start
1550	->cb (sub {	2070	->cb (sub {
1551	my ($iow, $revents) = @_;	2071	my ($iow, $revents) = @_;
1552	# $revents must be 1 here, no need to check	2072	# $revents must be 1 here, no need to check
1553	sysread $term->{socket}, my $buf, 8192	2073	sysread $term->{socket}, my $buf, 8192
…		…
1566	Set the callback to be called when io events are triggered. C<$reventmask>	2086	Set the callback to be called when io events are triggered. C<$reventmask>
1567	is a bitset as described in the C<events> method.	2087	is a bitset as described in the C<events> method.
1568		2088
1569	=item $iow = $iow->fd ($fd)	2089	=item $iow = $iow->fd ($fd)
1570		2090
1571	Set the filedescriptor (not handle) to watch.	2091	Set the file descriptor (not handle) to watch.
1572		2092
1573	=item $iow = $iow->events ($eventmask)	2093	=item $iow = $iow->events ($eventmask)
1574		2094
1575	Set the event mask to watch. The only allowed values are	2095	Set the event mask to watch. The only allowed values are
1576	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2096	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1577	together, or C<urxvt::EVENT_NONE>.	2097	together, or C<urxvt::EV_NONE>.
1578		2098
1579	=item $iow = $iow->start	2099	=item $iow = $iow->start
1580		2100
1581	Start watching for requested events on the given handle.	2101	Start watching for requested events on the given handle.
1582		2102
1583	=item $iow = $iow->stop	2103	=item $iow = $iow->stop
1584		2104
1585	Stop watching for events on the given filehandle.	2105	Stop watching for events on the given file handle.
		2106
		2107	=back
		2108
		2109	=head2 The C<urxvt::iw> Class
		2110
		2111	This class implements idle watchers, that get called automatically when
		2112	the process is idle. They should return as fast as possible, after doing
		2113	some useful work.
		2114
		2115	=over 4
		2116
		2117	=item $iw = new urxvt::iw
		2118
		2119	Create a new idle watcher object in stopped state.
		2120
		2121	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2122
		2123	Set the callback to be called when the watcher triggers.
		2124
		2125	=item $timer = $timer->start
		2126
		2127	Start the watcher.
		2128
		2129	=item $timer = $timer->stop
		2130
		2131	Stop the watcher.
		2132
		2133	=back
		2134
		2135	=head2 The C<urxvt::pw> Class
		2136
		2137	This class implements process watchers. They create an event whenever a
		2138	process exits, after which they stop automatically.
		2139
		2140	my $pid = fork;
		2141	...
		2142	$term->{pw} = urxvt::pw
		2143	->new
		2144	->start ($pid)
		2145	->cb (sub {
		2146	my ($pw, $exit_status) = @_;
		2147	...
		2148	});
		2149
		2150	=over 4
		2151
		2152	=item $pw = new urxvt::pw
		2153
		2154	Create a new process watcher in stopped state.
		2155
		2156	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2157
		2158	Set the callback to be called when the timer triggers.
		2159
		2160	=item $pw = $timer->start ($pid)
		2161
		2162	Tells the watcher to start watching for process C<$pid>.
		2163
		2164	=item $pw = $pw->stop
		2165
		2166	Stop the watcher.
1586		2167
1587	=back	2168	=back
1588		2169
1589	=head1 ENVIRONMENT	2170	=head1 ENVIRONMENT
1590		2171
…		…
1599		2180
1600	=item >= 3 - script loading and management	2181	=item >= 3 - script loading and management
1601		2182
1602	=item >=10 - all called hooks	2183	=item >=10 - all called hooks
1603		2184
1604	=item >=11 - hook reutrn values	2185	=item >=11 - hook return values
1605		2186
1606	=back	2187	=back
1607		2188
1608	=head1 AUTHOR	2189	=head1 AUTHOR
1609		2190
1610	Marc Lehmann <pcg@goof.com>	2191	Marc Lehmann <schmorp@schmorp.de>
1611	http://software.schmorp.de/pkg/rxvt-unicode	2192	http://software.schmorp.de/pkg/rxvt-unicode
1612		2193
1613	=cut	2194	=cut
1614		2195
1615	1	2196	1
		2197
		2198	# vim: sw=3:

Diff Legend

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