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.61 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 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	=head2 Prepackaged Extensions	31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
32		33
33	This section describes the extensiosn delivered with this version. You can	34	=head1 PREPACKAGED EXTENSIONS
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	35
		36	A number of extensions are delivered with this release. You can find them
		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	Intelligent selection. This extension tries to be more intelligent when	48	Extensions that add command line parameters or resources on their own are
45	the user extends selections (double-click). Right now, it tries to select	49	loaded automatically when used.
46	urls and complete shell-quoted arguments, which is very convenient, too,
47	if your F<ls> supports C<--quoting-style=shell>.
48		50
49	It also offers the following bindable event:	51	=head1 API DOCUMENTATION
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.
70
71	=item digital-clock
72
73	Displays a digital clock using the built-in overlay.
74
75	=item mark-urls
76
77	Uses per-line display filtering (C<on_line_update>) to underline urls.
78
79	=item block-graphics-to-ascii
80
81	A not very useful example of filtering all text output to the terminal,
82	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.
84
85	=item example-refresh-hooks
86
87	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.
90
91	=back
92		52
93	=head2 General API Considerations	53	=head2 General API Considerations
94		54
95	All objects (such as terminals, time watchers etc.) are typical	55	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	56	reference-to-hash objects. The hash can be used to store anything you
…		…
108		68
109	=over 4	69	=over 4
110		70
111	=item $text	71	=item $text
112		72
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
114	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.
115		75
116	=item $string	76	=item $string
117		77
118	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
119	characters and is to be distinguished with text encoded in a specific	79	characters and is to be distinguished with text encoded in a specific
…		…
122	=item $octets	82	=item $octets
123		83
124	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
125	locale-specific way.	85	locale-specific way.
126		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
127	=back	93	=back
		94
		95	=head2 Extension Objects
		96
		97	Every perl extension is a perl class. A separate perl object is created
		98	for each terminal, and each terminal has its own set of extension objects,
		99	which are passed as the first parameter to hooks. So extensions can use
		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
		102	that begin with an underscore character C<_>: these are reserved for
		103	internal use.
		104
		105	Although it isn't a C<urxvt::term> object, you can call all methods of the
		106	C<urxvt::term> class on this object.
		107
		108	Additional methods only supported for extension objects are described in
		109	the C<urxvt::extension> section below.
128		110
129	=head2 Hooks	111	=head2 Hooks
130		112
131	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
132	called whenever the relevant event happens.	114	called whenever the relevant event happens.
133		115
134	The first argument passed to them is an object private to each terminal	116	The first argument passed to them is an extension object as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	117	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		118
141	All of them must return a boolean value. If it is true, then the event	119	B<All> of these hooks must return a boolean value. If any of the called
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	120	hooks returns true, then the event counts as being I<consumed>, and the
143	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.
144		122
145	When in doubt, return a false value (preferably C<()>).	123	I<< When in doubt, return a false value (preferably C<()>). >>
146		124
147	=over 4	125	=over 4
148		126
149	=item on_init $term	127	=item on_init $term
150		128
151	Called after a new terminal object has been initialized, but before	129	Called after a new terminal object has been initialized, but before
152	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
153	call or deliver senseless data, as terminal size and other characteristics	131	call or deliver senseless data, as terminal size and other characteristics
154	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
155	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).
156		145
157	=item on_reset $term	146	=item on_reset $term
158		147
159	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
160	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
161	variables.	150	variables.
162		151
163	=item on_start $term	152	=item on_child_start $term, $pid
164		153
165	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.
166	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>.
167		160
168	=item on_sel_make $term, $eventtime	161	=item on_sel_make $term, $eventtime
169		162
170	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
171	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
…		…
178		171
179	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
180	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
181	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
182		175
183	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.
184		177
185	=item on_sel_extend $term	178	=item on_sel_extend $term
186		179
187	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
188	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
189	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
190	processing.	183	processing. This can happen multiple times, as long as the callback
		184	returns true, it will be called on every further click by the user and is
		185	supposed to enlarge the selection more and more, if possible.
191		186
192	See the F<selection> example extension.	187	See the F<selection> example extension.
193		188
194	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
195		190
196	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
197	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	193	show this many lines of scrollback.
199		194
200	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
201		196
…		…
205		200
206	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,
207	$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
208	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
209		204
210	=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
211		216
212	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
213	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
214	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
215	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,
216	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
217	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	}
218		233
219	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,
220	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
221	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.
222		240
223	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
224		242
225	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
226	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
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	245	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	246	might be very slow, however, as your hook is called for B<all> text being
229	output.	247	output.
230		248
		249	=item on_tt_write $term, $octets
		250
		251	Called whenever some data is written to the tty/pty and can be used to
		252	suppress or filter tty input.
		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
231	=item on_line_update $term, $row	261	=item on_line_update $term, $row
232		262
233	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
234	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
235	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,
…		…
242	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
243	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
244		274
245	=item on_refresh_begin $term	275	=item on_refresh_begin $term
246		276
247	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
248	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
249	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
250	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
251		281
252	=item on_refresh_end $term	282	=item on_refresh_end $term
253		283
254	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>.
255		285
256	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
257		287
258	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
259	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>
260	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.
261		310
262	=item on_focus_in $term	311	=item on_focus_in $term
263		312
264	Called whenever the window gets the keyboard focus, before rxvt-unicode	313	Called whenever the window gets the keyboard focus, before rxvt-unicode
265	does focus in processing.	314	does focus in processing.
266		315
267	=item on_focus_out $term	316	=item on_focus_out $term
268		317
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	318	Called whenever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	319	focus out processing.
271		320
		321	=item on_configure_notify $term, $event
		322
		323	=item on_property_notify $term, $event
		324
272	=item on_key_press $term, $event, $octets	325	=item on_key_press $term, $event, $keysym, $octets
273		326
274	=item on_key_release $term, $event	327	=item on_key_release $term, $event, $keysym
275		328
276	=item on_button_press $term, $event	329	=item on_button_press $term, $event
277		330
278	=item on_button_release $term, $event	331	=item on_button_release $term, $event
279		332
…		…
281		334
282	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
283		336
284	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
285		338
286	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
287	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.
288		341
289	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
290	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
291	and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
292		345
293	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
294	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
295		348
296	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.
297		361
298	=back	362	=back
299		363
		364	=cut
		365
		366	package urxvt;
		367
		368	use utf8;
		369	use strict 'vars';
		370	use Carp ();
		371	use Scalar::Util ();
		372	use List::Util ();
		373
		374	our $VERSION = 1;
		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.
		378	our @HOOKNAME;
		379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		380	our %OPTION;
		381
		382	our $LIBDIR;
		383	our $RESNAME;
		384	our $RESCLASS;
		385	our $RXVTNAME;
		386
		387	our $NOCHAR = chr 0xffff;
		388
300	=head2 Variables in the C<urxvt> Package	389	=head2 Variables in the C<urxvt> Package
301		390
302	=over 4	391	=over 4
		392
		393	=item $urxvt::LIBDIR
		394
		395	The rxvt-unicode library directory, where, among other things, the perl
		396	modules and scripts are stored.
		397
		398	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		399
		400	The resource class and name rxvt-unicode uses to look up X resources.
		401
		402	=item $urxvt::RXVTNAME
		403
		404	The basename of the installed binaries, usually C<urxvt>.
303		405
304	=item $urxvt::TERM	406	=item $urxvt::TERM
305		407
306	The current terminal. This variable stores the current C<urxvt::term>	408	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	409	object, whenever a callback/hook is executing.
308		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
309	=back	427	=back
310		428
311	=head2 Functions in the C<urxvt> Package	429	=head2 Functions in the C<urxvt> Package
312		430
313	=over 4	431	=over 4
314		432
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322
323	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
324		434
325	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
326	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
327	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
328		439
329	=item urxvt::warn $string	440	=item urxvt::warn $string
330		441
331	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
332	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
333	that calls this function.	444	that calls this function.
334		445
335	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
336	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
		448
		449	Messages have a size limit of 1023 bytes currently.
		450
		451	=item @terms = urxvt::termlist
		452
		453	Returns all urxvt::term objects that exist in this process, regardless of
		454	whether they are started, being destroyed etc., so be careful. Only term
		455	objects that have perl extensions attached will be returned (because there
		456	is no urxvt::term object associated with others).
337		457
338	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
339		459
340	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
341		461
342	=item urxvt::CurrentTime	462	=item urxvt::CurrentTime
343		463
344	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	464	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
345	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	465	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
346	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
347		483
348	Various constants for use in X calls and event processing.	484	Various constants for use in X calls and event processing.
349		485
350	=back	486	=back
351		487
…		…
368		504
369	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
370		506
371	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
372		508
373	=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
374		511
375	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
376	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
377	the bitset.	514	the bitset.
378		515
…		…
380		517
381	=item $background = urxvt::GET_BASEBG $rend	518	=item $background = urxvt::GET_BASEBG $rend
382		519
383	Return the foreground/background colour index, respectively.	520	Return the foreground/background colour index, respectively.
384		521
385	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	522	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
386		523
387	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	524	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		525
		526	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
388		527
389	Replace the foreground/background colour in the rendition mask with the	528	Replace the foreground/background colour in the rendition mask with the
390	specified one.	529	specified one.
391		530
392	=item $value = urxvt::GET_CUSTOM ($rend)	531	=item $value = urxvt::GET_CUSTOM $rend
393		532
394	Return the "custom" value: Every rendition has 5 bits for use by	533	Return the "custom" value: Every rendition has 5 bits for use by
395	extensions. They can be set and changed as you like and are initially	534	extensions. They can be set and changed as you like and are initially
396	zero.	535	zero.
397		536
398	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	537	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
399		538
400	Change the custom value.	539	Change the custom value.
401		540
402	=back	541	=back
403		542
404	=cut	543	=cut
405		544
406	package urxvt;
407
408	use utf8;
409	use strict;
410	use Scalar::Util ();
411	use List::Util ();
412
413	our $VERSION = 1;
414	our $TERM;
415	our @HOOKNAME;
416	our %OPTION;
417	our $LIBDIR;
418
419	BEGIN {	545	BEGIN {
420	urxvt->bootstrap;
421
422	# overwrite perl's warn	546	# overwrite perl's warn
423	*CORE::GLOBAL::warn = sub {	547	*CORE::GLOBAL::warn = sub {
424	my $msg = join "", @_;	548	my $msg = join "", @_;
425	$msg .= "\n"	549	$msg .= "\n"
426	unless $msg =~ /\n$/;	550	unless $msg =~ /\n$/;
427	urxvt::warn ($msg);	551	urxvt::warn ($msg);
428	};	552	};
429
430	delete $ENV{IFS};
431	delete $ENV{CDPATH};
432	delete $ENV{BASH_ENV};
433	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
434	}	553	}
435		554
436	my @hook_count;	555	no warnings 'utf8';
		556
		557	sub parse_resource {
		558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		559
		560	$term->scan_extensions;
		561
		562	my $r = $term->{meta}{resource};
		563	keys %$r; # reset iterator
		564	while (my ($k, $v) = each %$r) {
		565	my $pattern = $k;
		566	$pattern =~ y/./-/ if $isarg;
		567	my $prefix = $name;
		568	my $suffix;
		569	if ($pattern =~ /\-$/) {
		570	$prefix = substr $name, 0, length $pattern;
		571	$suffix = substr $name, length $pattern;
		572	}
		573	if ($pattern eq $prefix) {
		574	$name = "$urxvt::RESCLASS.$k$suffix";
		575
		576	push @{ $term->{perl_ext_3} }, $v->[0];
		577
		578	if ($v->[1] eq "boolean") {
		579	$term->put_option_db ($name, $flag ? "true" : "false");
		580	return 1;
		581	} else {
		582	$term->put_option_db ($name, $value);
		583	return 1 + 2;
		584	}
		585	}
		586	}
		587
		588	0
		589	}
		590
		591	sub usage {
		592	my ($term, $usage_type) = @_;
		593
		594	$term->scan_extensions;
		595
		596	my $r = $term->{meta}{resource};
		597
		598	for my $pattern (sort keys %$r) {
		599	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		600
		601	$desc .= " (-pe $ext)";
		602
		603	if ($usage_type == 1) {
		604	$pattern =~ y/./-/;
		605	$pattern =~ s/-$/-.../g;
		606
		607	if ($type eq "boolean") {
		608	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		609	} else {
		610	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		611	}
		612	} else {
		613	$pattern =~ s/\.$/.*/g;
		614	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		615	}
		616	}
		617	}
		618
437	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	619	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
438		620
439	sub verbose {	621	sub verbose {
440	my ($level, $msg) = @_;	622	my ($level, $msg) = @_;
441	warn "$msg\n" if $level <= $verbosity;	623	warn "$msg\n" if $level <= $verbosity;
442	}	624	}
443		625
444	# find on_xxx subs in the package and register them
445	# as hooks
446	sub register_package($) {
447	my ($pkg) = @_;
448
449	for my $htype (0.. $#HOOKNAME) {
450	my $name = $HOOKNAME[$htype];
451
452	my $ref = $pkg->can ("on_" . lc $name)
453	or next;
454
455	$TERM->{_hook}[$htype]{$pkg} = $ref;
456	$hook_count[$htype]++
457	or set_should_invoke $htype, 1;
458	}
459	}
460
461	my $extension_pkg = "extension0000";
462	my %extension_pkg;	626	my %extension_pkg;
463		627
464	# load a single script into its own package, once only	628	# load a single script into its own package, once only
465	sub extension_package($) {	629	sub extension_package($) {
466	my ($path) = @_;	630	my ($path) = @_;
467		631
468	$extension_pkg{$path} ||= do {	632	$extension_pkg{$path} ||= do {
469	my $pkg = "urxvt::" . ($extension_pkg++);	633	$path =~ /([^\/\\]+)$/;
		634	my $pkg = $1;
		635	$pkg =~ s/[^[:word:]]/_/g;
		636	$pkg = "urxvt::ext::$pkg";
470		637
471	verbose 3, "loading extension '$path' into package '$pkg'";	638	verbose 3, "loading extension '$path' into package '$pkg'";
		639
		640	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
472		641
473	open my $fh, "<:raw", $path	642	open my $fh, "<:raw", $path
474	or die "$path: $!";	643	or die "$path: $!";
475		644
476	my $source = untaint "package $pkg; use strict; use utf8;\n"	645	my $source =
477	. "use base urxvt::term::proxy::;\n"	646	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
478	. "#line 1 \"$path\"\n{\n"	647	. "#line 1 \"$path\"\n{\n"
479	. (do { local $/; <$fh> })	648	. (do { local $/; <$fh> })
480	. "\n};\n1";	649	. "\n};\n1";
481		650
		651	eval $source
482	eval $source or die "$path: $@";	652	or die "$path: $@";
483		653
484	$pkg	654	$pkg
485	}	655	}
486	}	656	}
487		657
…		…
490	# called by the rxvt core	660	# called by the rxvt core
491	sub invoke {	661	sub invoke {
492	local $TERM = shift;	662	local $TERM = shift;
493	my $htype = shift;	663	my $htype = shift;
494		664
495	if ($htype == 0) { # INIT	665	if ($htype == HOOK_INIT) {
496	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	666	my @dirs = $TERM->perl_libdirs;
		667
		668	$TERM->scan_extensions;
		669
		670	my %ext_arg;
		671
497		672	{
498	my %want_ext;	673	my @init = @TERM_INIT;
		674	@TERM_INIT = ();
		675	$_->($TERM) for @init;
		676	my @pkg = @TERM_EXT;
		677	@TERM_EXT = ();
		678	$TERM->register_package ($_) for @pkg;
		679	}
499		680
		681	for (
500	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	682	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		683	) {
501	if ($_ eq "default") {	684	if ($_ eq "default") {
		685
		686	$ext_arg{$_} = []
		687	for
502	$want_ext{$_}++ for qw(selection option-popup selection-popup);	688	qw(selection option-popup selection-popup readline),
		689	@{ delete $TERM->{perl_ext_3} },
		690	map $_->[0], values %{ $TERM->{meta}{binding} };
		691
		692	for ($TERM->_keysym_resources) {
		693	next if /^(?:string|command|builtin|builtin-string|perl)/;
		694	next unless /^([A-Za-z0-9_\-]+):/;
		695
		696	my $ext = $1;
		697
		698	$ext_arg{$ext} = [];
		699	}
		700
503	} elsif (/^-(.*)$/) {	701	} elsif (/^-(.*)$/) {
504	delete $want_ext{$1};	702	delete $ext_arg{$1};
		703
		704	} elsif (/^([^<]+)<(.*)>$/) {
		705	push @{ $ext_arg{$1} }, $2;
		706
505	} else {	707	} else {
506	$want_ext{$_}++;	708	$ext_arg{$_} ||= [];
507	}	709	}
508	}	710	}
509		711
		712	# now register default key bindings
510	for my $ext (keys %want_ext) {	713	for my $ext (sort keys %ext_arg) {
		714	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		715	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
		716	}
		717	}
		718
		719	for my $ext (sort keys %ext_arg) {
511	my @files = grep -f $_, map "$_/$ext", @dirs;	720	my @files = grep -f $_, map "$_/$ext", @dirs;
512		721
513	if (@files) {	722	if (@files) {
514	register_package extension_package $files[0];	723	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
515	} else {	724	} else {
516	warn "perl extension '$ext' not found in perl library search path\n";	725	warn "perl extension '$ext' not found in perl library search path\n";
517	}	726	}
518	}	727	}
519		728
…		…
525		734
526	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
527	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
528	if $verbosity >= 10;	737	if $verbosity >= 10;
529		738
530	keys %$cb;	739	if ($htype == HOOK_ACTION) {
		740	# this hook is only sent to the extension with the name
		741	# matching the first arg
		742	my $pkg = shift;
		743	$pkg =~ y/-/_/;
		744	$pkg = "urxvt::ext::$pkg";
531		745
532	while (my ($pkg, $cb) = each %$cb) {	746	$cb = $cb->{$pkg}
533	eval {	747	or return undef; #TODO: maybe warn user?
534	$retval = $cb->(	748
535	$TERM->{_pkg}{$pkg} ||= do {	749	$cb = { $pkg => $cb };
536	my $proxy = bless { }, $pkg;
537	Scalar::Util::weaken ($proxy->{term} = $TERM);
538	$proxy
539	},
540	@_,
541	) and last;
542	};	750	}
		751
		752	for my $pkg (keys %$cb) {
		753	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
		754	$retval ||= $retval_;
		755
543	if ($@) {	756	if ($@) {
544	$TERM->ungrab; # better to lose the grab than the session	757	$TERM->ungrab; # better to lose the grab than the session
545	warn $@;	758	warn $@;
546	}	759	}
547	}	760	}
		761
		762	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		763	if $verbosity >= 11;
548	}	764	}
549		765
550	if ($htype == 1) { # DESTROY	766	if ($htype == HOOK_DESTROY) {
551	# remove hooks if unused
552	if (my $hook = $TERM->{_hook}) {
553	for my $htype (0..$#$hook) {
554	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
555	or set_should_invoke $htype, 0;
556	}
557	}
558
559	# clear package objects	767	# clear package objects
560	%$_ = () for values %{ $TERM->{_pkg} };	768	%$_ = () for values %{ $TERM->{_pkg} };
561		769
562	# clear package	770	# clear package
563	%$TERM = ();	771	%$TERM = ();
564	}	772	}
565		773
566	$retval	774	$retval
567	}	775	}
568		776
569	# urxvt::term::proxy	777	sub SET_COLOR($$$) {
		778	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		779	}
570		780
571	sub urxvt::term::proxy::AUTOLOAD {	781	sub rend2mask {
572	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	782	no strict 'refs';
		783	my ($str, $mask) = (@_, 0);
		784	my %color = ( fg => undef, bg => undef );
		785	my @failed;
		786	for my $spec ( split /\s+/, $str ) {
		787	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		788	$color{lc($1)} = $2;
		789	} else {
		790	my $neg = $spec =~ s/^[-^]//;
		791	unless ( exists &{"RS_$spec"} ) {
		792	push @failed, $spec;
		793	next;
		794	}
		795	my $cur = &{"RS_$spec"};
		796	if ( $neg ) {
		797	$mask &= ~$cur;
		798	} else {
		799	$mask |= $cur;
		800	}
		801	}
		802	}
		803	($mask, @color{qw(fg bg)}, \@failed)
		804	}
		805
		806	package urxvt::term::extension;
		807
		808	=head2 The C<urxvt::term::extension> class
		809
		810	Each extension attached to a terminal object is represented by
		811	a C<urxvt::term::extension> object.
		812
		813	You can use these objects, which are passed to all callbacks to store any
		814	state related to the terminal and extension instance.
		815
		816	The methods (And data members) documented below can be called on extension
		817	objects, in addition to call methods documented for the <urxvt::term>
		818	class.
		819
		820	=over 4
		821
		822	=item $urxvt_term = $self->{term}
		823
		824	Returns the C<urxvt::term> object associated with this instance of the
		825	extension. This member I<must not> be changed in any way.
		826
		827	=cut
		828
		829	our $AUTOLOAD;
		830
		831	sub AUTOLOAD {
		832	$AUTOLOAD =~ /:([^:]+)$/
573	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	833	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
574		834
575	eval qq{	835	eval qq{
576	sub $urxvt::term::proxy::AUTOLOAD {	836	sub $AUTOLOAD {
577	my \$proxy = shift;	837	my \$proxy = shift;
578	\$proxy->{term}->$1 (\@_)	838	\$proxy->{term}->$1 (\@_)
579	}	839	}
580	1	840	1
581	} or die "FATAL: unable to compile method forwarder: $@";	841	} or die "FATAL: unable to compile method forwarder: $@";
582		842
583	goto &$urxvt::term::proxy::AUTOLOAD;	843	goto &$AUTOLOAD;
584	}	844	}
585		845
586	sub urxvt::term::proxy::DESTROY {	846	sub DESTROY {
587	# nop	847	# nop
588	}	848	}
589		849
590	# urxvt::destroy_hook	850	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
591		851
592	sub urxvt::destroy_hook::DESTROY {	852	sub urxvt::destroy_hook::DESTROY {
593	${$_[0]}->();	853	${$_[0]}->();
594	}	854	}
595		855
596	sub urxvt::destroy_hook(&) {	856	sub urxvt::destroy_hook(&) {
597	bless \shift, urxvt::destroy_hook::	857	bless \shift, urxvt::destroy_hook::
598	}	858	}
599		859
		860	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		861
		862	Dynamically enable the given hooks (named without the C<on_> prefix) for
		863	this extension, replacing any hook previously installed via C<enable> in
		864	this extension.
		865
		866	This is useful when you want to overwrite time-critical hooks only
		867	temporarily.
		868
		869	To install additional callbacks for the same hook, you can use the C<on>
		870	method of the C<urxvt::term> class.
		871
		872	=item $self->disable ($hook_name[, $hook_name..])
		873
		874	Dynamically disable the given hooks.
		875
		876	=cut
		877
		878	sub enable {
		879	my ($self, %hook) = @_;
		880	my $pkg = $self->{_pkg};
		881
		882	while (my ($name, $cb) = each %hook) {
		883	my $htype = $HOOKTYPE{uc $name};
		884	defined $htype
		885	or Carp::croak "unsupported hook type '$name'";
		886
		887	$self->set_should_invoke ($htype, +1)
		888	unless exists $self->{term}{_hook}[$htype]{$pkg};
		889
		890	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		891	}
		892	}
		893
		894	sub disable {
		895	my ($self, @hook) = @_;
		896	my $pkg = $self->{_pkg};
		897
		898	for my $name (@hook) {
		899	my $htype = $HOOKTYPE{uc $name};
		900	defined $htype
		901	or Carp::croak "unsupported hook type '$name'";
		902
		903	$self->set_should_invoke ($htype, -1)
		904	if delete $self->{term}{_hook}[$htype]{$pkg};
		905	}
		906	}
		907
		908	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		909
		910	Similar to the C<enable> enable, but installs additional callbacks for
		911	the given hook(s) (that is, it doesn't replace existing callbacks), and
		912	returns a guard object. When the guard object is destroyed the callbacks
		913	are disabled again.
		914
		915	=cut
		916
		917	sub urxvt::extension::on_disable::DESTROY {
		918	my $disable = shift;
		919
		920	my $term = delete $disable->{""};
		921
		922	while (my ($htype, $id) = each %$disable) {
		923	delete $term->{_hook}[$htype]{$id};
		924	$term->set_should_invoke ($htype, -1);
		925	}
		926	}
		927
		928	sub on {
		929	my ($self, %hook) = @_;
		930
		931	my $term = $self->{term};
		932
		933	my %disable = ( "" => $term );
		934
		935	while (my ($name, $cb) = each %hook) {
		936	my $htype = $HOOKTYPE{uc $name};
		937	defined $htype
		938	or Carp::croak "unsupported hook type '$name'";
		939
		940	$term->set_should_invoke ($htype, +1);
		941	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		942	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		943	}
		944
		945	bless \%disable, "urxvt::extension::on_disable"
		946	}
		947
		948	=item $self->x_resource ($pattern)
		949
		950	=item $self->x_resource_boolean ($pattern)
		951
		952	These methods support an additional C<%> prefix when called on an
		953	extension object - see the description of these methods in the
		954	C<urxvt::term> class for details.
		955
		956	=cut
		957
		958	sub x_resource {
		959	my ($self, $name) = @_;
		960	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		961	$self->{term}->x_resource ($name)
		962	}
		963
		964	sub x_resource_boolean {
		965	my ($self, $name) = @_;
		966	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		967	$self->{term}->x_resource_boolean ($name)
		968	}
		969
		970	=back
		971
		972	=cut
		973
600	package urxvt::anyevent;	974	package urxvt::anyevent;
601		975
602	=head2 The C<urxvt::anyevent> Class	976	=head2 The C<urxvt::anyevent> Class
603		977
604	The sole purpose of this class is to deliver an interface to the	978	The sole purpose of this class is to deliver an interface to the
605	C<AnyEvent> module - any module using it will work inside urxvt without	979	C<AnyEvent> module - any module using it will work inside urxvt without
606	further work. The only exception is that you cannot wait on condition	980	further programming. The only exception is that you cannot wait on
607	variables, but non-blocking condvar use is ok. What this means is that you	981	condition variables, but non-blocking condvar use is ok.
608	cannot use blocking APIs, but the non-blocking variant should work.
609		982
610	=cut	983	In practical terms this means is that you cannot use blocking APIs, but
		984	the non-blocking variant should work.
611		985
		986	=cut
		987
612	our $VERSION = 1;	988	our $VERSION = '5.23';
613		989
614	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	990	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
615	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	991	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
616		992
617	sub timer {	993	sub timer {
…		…
619		995
620	my $cb = $arg{cb};	996	my $cb = $arg{cb};
621		997
622	urxvt::timer	998	urxvt::timer
623	->new	999	->new
624	->start (urxvt::NOW + $arg{after})	1000	->after ($arg{after}, $arg{interval})
625	->cb (sub {	1001	->cb ($arg{interval} ? $cb : sub {
626	$_[0]->stop; # need to cancel manually	1002	$_[0]->stop; # need to cancel manually
627	$cb->();	1003	$cb->();
628	})	1004	})
629	}	1005	}
630		1006
631	sub io {	1007	sub io {
632	my ($class, %arg) = @_;	1008	my ($class, %arg) = @_;
633		1009
634	my $cb = $arg{cb};	1010	my $cb = $arg{cb};
		1011	my $fd = fileno $arg{fh};
		1012	defined $fd or $fd = $arg{fh};
635		1013
636	bless [$arg{fh}, urxvt::iow	1014	bless [$arg{fh}, urxvt::iow
637	->new	1015	->new
638	->fd (fileno $arg{fh})	1016	->fd ($fd)
639	->events (($arg{poll} =~ /r/ ? 1 : 0)	1017	->events (($arg{poll} =~ /r/ ? 1 : 0)
640	| ($arg{poll} =~ /w/ ? 2 : 0))	1018	| ($arg{poll} =~ /w/ ? 2 : 0))
641	->start	1019	->start
642	->cb (sub {	1020	->cb ($cb)
643	$cb->(($_[1] & 1 ? 'r' : '')
644	. ($_[1] & 2 ? 'w' : ''));
645	})],
646	urxvt::anyevent::	1021	], urxvt::anyevent::
		1022	}
		1023
		1024	sub idle {
		1025	my ($class, %arg) = @_;
		1026
		1027	my $cb = $arg{cb};
		1028
		1029	urxvt::iw
		1030	->new
		1031	->start
		1032	->cb ($cb)
		1033	}
		1034
		1035	sub child {
		1036	my ($class, %arg) = @_;
		1037
		1038	my $cb = $arg{cb};
		1039
		1040	urxvt::pw
		1041	->new
		1042	->start ($arg{pid})
		1043	->cb (sub {
		1044	$_[0]->stop; # need to cancel manually
		1045	$cb->($_[0]->rpid, $_[0]->rstatus);
		1046	})
647	}	1047	}
648		1048
649	sub DESTROY {	1049	sub DESTROY {
650	$_[0][1]->stop;	1050	$_[0][1]->stop;
651	}	1051	}
652		1052
653	sub condvar {	1053	# only needed for AnyEvent < 6 compatibility
654	bless \my $flag, urxvt::anyevent::condvar::	1054	sub one_event {
655	}
656
657	sub urxvt::anyevent::condvar::broadcast {
658	${$_[0]}++;
659	}
660
661	sub urxvt::anyevent::condvar::wait {
662	unless (${$_[0]}) {
663	require Carp;
664	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	1055	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1056	}
		1057
		1058	package urxvt::term;
		1059
		1060	=head2 The C<urxvt::term> Class
		1061
		1062	=over 4
		1063
		1064	=cut
		1065
		1066	# find on_xxx subs in the package and register them
		1067	# as hooks
		1068	sub register_package {
		1069	my ($self, $pkg, $argv) = @_;
		1070
		1071	no strict 'refs';
		1072
		1073	urxvt::verbose 6, "register package $pkg to $self";
		1074
		1075	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1076
		1077	my $proxy = bless {
		1078	_pkg => $pkg,
		1079	_name => ${"$pkg\::_NAME"}, # hackish
		1080	argv => $argv,
		1081	}, $pkg;
		1082	Scalar::Util::weaken ($proxy->{term} = $self);
		1083
		1084	$self->{_pkg}{$pkg} = $proxy;
		1085
		1086	for my $name (@HOOKNAME) {
		1087	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1088	$proxy->enable ($name => $ref);
		1089	}
665	}	1090	}
666	}	1091	}
667		1092
668	package urxvt::term;	1093	sub perl_libdirs {
		1094	map { split /:/ }
		1095	$_[0]->resource ("perl_lib"),
		1096	$ENV{URXVT_PERL_LIB},
		1097	"$ENV{HOME}/.urxvt/ext",
		1098	"$LIBDIR/perl"
		1099	}
669		1100
670	=head2 The C<urxvt::term> Class	1101	# scan for available extensions and collect their metadata
		1102	sub scan_extensions {
		1103	my ($self) = @_;
671		1104
672	=over 4	1105	return if exists $self->{meta};
		1106
		1107	my @libdirs = perl_libdirs $self;
		1108
		1109	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1110
		1111	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1112	$self->{meta} = \my %meta;
		1113
		1114	# first gather extensions
		1115	for my $dir (reverse @libdirs) {
		1116	opendir my $fh, $dir
		1117	or next;
		1118	for my $ext (readdir $fh) {
		1119	$ext !~ /^\./
		1120	and open my $fh, "<", "$dir/$ext"
		1121	or next;
		1122
		1123	my %ext = (dir => $dir);
		1124
		1125	while (<$fh>) {
		1126	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1127	my ($pattern, $type, $desc) = split /:/, $1;
		1128	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1129	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1130	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1131	} else {
		1132	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1133	}
		1134	} elsif (/^#:META:BINDING:(.*)/) {
		1135	my ($keysym, $action) = split /:/, $1;
		1136	$ext{binding}{$keysym} = [$ext, $action];
		1137	} elsif (/^\s*(?:#|$)/) {
		1138	# skip other comments and empty lines
		1139	} else {
		1140	last; # stop parsing on first non-empty non-comment line
		1141	}
		1142	}
		1143
		1144	$meta{ext}{$ext} = \%ext;
		1145	}
		1146	}
		1147
		1148	# and now merge resources and bindings
		1149	while (my ($k, $v) = each %{ $meta{ext} }) {
		1150	#TODO: should check for extensions overriding each other
		1151	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1152	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1153	}
		1154	}
		1155
		1156	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1157
		1158	Creates a new terminal, very similar as if you had started it with system
		1159	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1160	hash which defines the environment of the new terminal.
		1161
		1162	Croaks (and probably outputs an error message) if the new instance
		1163	couldn't be created. Returns C<undef> if the new instance didn't
		1164	initialise perl, and the terminal object otherwise. The C<init> and
		1165	C<start> hooks will be called before this call returns, and are free to
		1166	refer to global data (which is race free).
		1167
		1168	=cut
		1169
		1170	sub new {
		1171	my ($class, $env, @args) = @_;
		1172
		1173	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1174	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1175
		1176	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1177	}
673		1178
674	=item $term->destroy	1179	=item $term->destroy
675		1180
676	Destroy the terminal object (close the window, free resources etc.).	1181	Destroy the terminal object (close the window, free resources
		1182	etc.). Please note that urxvt will not exit as long as any event
		1183	watchers (timers, io watchers) are still active.
		1184
		1185	=item $term->exec_async ($cmd[, @args])
		1186
		1187	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1188	("starts") programs in the background. This function takes care of setting
		1189	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1190	be preferred over explicit calls to C<exec> or C<system>.
		1191
		1192	Returns the pid of the subprocess or C<undef> on error.
		1193
		1194	=cut
		1195
		1196	sub exec_async {
		1197	my $self = shift;
		1198
		1199	my $pid = fork;
		1200
		1201	return $pid
		1202	if !defined $pid or $pid;
		1203
		1204	%ENV = %{ $self->env };
		1205
		1206	exec @_;
		1207	urxvt::_exit 255;
		1208	}
677		1209
678	=item $isset = $term->option ($optval[, $set])	1210	=item $isset = $term->option ($optval[, $set])
679		1211
680	Returns true if the option specified by C<$optval> is enabled, and	1212	Returns true if the option specified by C<$optval> is enabled, and
681	optionally change it. All option values are stored by name in the hash	1213	optionally change it. All option values are stored by name in the hash
682	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1214	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
683		1215
684	Here is a a likely non-exhaustive list of option names, please see the	1216	Here is a likely non-exhaustive list of option names, please see the
685	source file F</src/optinc.h> to see the actual list:	1217	source file F</src/optinc.h> to see the actual list:
686		1218
687	borderLess console cursorBlink cursorUnderline hold iconic insecure	1219	borderLess buffered console cursorBlink cursorUnderline hold iconic
688	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1220	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1221	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
689	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1222	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
690	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1223	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
691	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1224	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
692	tripleclickwords utmpInhibit visualBell	1225	urgentOnBell utmpInhibit visualBell
693		1226
694	=item $value = $term->resource ($name[, $newval])	1227	=item $value = $term->resource ($name[, $newval])
695		1228
696	Returns the current resource value associated with a given name and	1229	Returns the current resource value associated with a given name and
697	optionally sets a new value. Setting values is most useful in the C<init>	1230	optionally sets a new value. Setting values is most useful in the C<init>
…		…
706	likely change).	1239	likely change).
707		1240
708	Please note that resource strings will currently only be freed when the	1241	Please note that resource strings will currently only be freed when the
709	terminal is destroyed, so changing options frequently will eat memory.	1242	terminal is destroyed, so changing options frequently will eat memory.
710		1243
711	Here is a a likely non-exhaustive list of resource names, not all of which	1244	Here is a likely non-exhaustive list of resource names, not all of which
712	are supported in every build, please see the source file F</src/rsinc.h>	1245	are supported in every build, please see the source file F</src/rsinc.h>
713	to see the actual list:	1246	to see the actual list:
714		1247
715	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1248	answerbackstring backgroundPixmap backspace_key blurradius
716	borderLess color cursorBlink cursorUnderline cutchars delete_key	1249	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
717	display_name embed ext_bwidth fade font geometry hold iconName	1250	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
718	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1251	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1252	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
719	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1253	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
720	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1254	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
721	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1255	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
722	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1256	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
723	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1257	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
724	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1258	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
725	shade term_name title transparent transparent_all tripleclickwords	1259	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1260	term_name title transient_for transparent tripleclickwords urgentOnBell
726	utmpInhibit visualBell	1261	utmpInhibit visualBell
727		1262
728	=cut	1263	=cut
729		1264
730	sub resource($$;$) {	1265	sub resource($$;$) {
731	my ($self, $name) = (shift, shift);	1266	my ($self, $name) = (shift, shift);
732	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1267	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
733	&urxvt::term::_resource	1268	goto &urxvt::term::_resource
734	}	1269	}
		1270
		1271	=item $value = $term->x_resource ($pattern)
		1272
		1273	Returns the X-Resource for the given pattern, excluding the program or
		1274	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1275	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1276	resource with that pattern exists.
		1277
		1278	Extensions that define extra resource or command line arguments also need
		1279	to call this method to access their values.
		1280
		1281	If the method is called on an extension object (basically, from an
		1282	extension), then the special prefix C<%.> will be replaced by the name of
		1283	the extension and a dot, and the lone string C<%> will be replaced by the
		1284	extension name itself. This makes it possible to code extensions so you
		1285	can rename them and get a new set of commandline switches and resources
		1286	without having to change the actual code.
		1287
		1288	This method should only be called during the C<on_start> hook, as there is
		1289	only one resource database per display, and later invocations might return
		1290	the wrong resources.
		1291
		1292	=item $value = $term->x_resource_boolean ($pattern)
		1293
		1294	Like C<x_resource>, above, but interprets the string value as a boolean
		1295	and returns C<1> for true values, C<0> for false values and C<undef> if
		1296	the resource or option isn't specified.
		1297
		1298	You should always use this method to parse boolean resources.
		1299
		1300	=cut
		1301
		1302	sub x_resource_boolean {
		1303	my $res = &x_resource;
		1304
		1305	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1306	}
		1307
		1308	=item $success = $term->bind_action ($key, $octets)
		1309
		1310	Adds a key binding exactly as specified via a C<keysym> resource. See the
		1311	C<keysym> resource in the urxvt(1) manpage.
735		1312
736	=item $rend = $term->rstyle ([$new_rstyle])	1313	=item $rend = $term->rstyle ([$new_rstyle])
737		1314
738	Return and optionally change the current rendition. Text that is output by	1315	Return and optionally change the current rendition. Text that is output by
739	the terminal application will use this style.	1316	the terminal application will use this style.
…		…
747		1324
748	=item ($row, $col) = $term->selection_beg ([$row, $col])	1325	=item ($row, $col) = $term->selection_beg ([$row, $col])
749		1326
750	=item ($row, $col) = $term->selection_end ([$row, $col])	1327	=item ($row, $col) = $term->selection_end ([$row, $col])
751		1328
752	Return the current values of the selection mark, begin or end positions,	1329	Return the current values of the selection mark, begin or end positions.
753	and optionally set them to new values.
754		1330
		1331	When arguments are given, then the selection coordinates are set to
		1332	C<$row> and C<$col>, and the selection screen is set to the current
		1333	screen.
		1334
		1335	=item $screen = $term->selection_screen ([$screen])
		1336
		1337	Returns the current selection screen, and then optionally sets it.
		1338
		1339	=item $term->selection_make ($eventtime[, $rectangular])
		1340
		1341	Tries to make a selection as set by C<selection_beg> and
		1342	C<selection_end>. If C<$rectangular> is true (default: false), a
		1343	rectangular selection will be made. This is the preferred function to make
		1344	a selection.
		1345
755	=item $success = $term->selection_grab ($eventtime)	1346	=item $success = $term->selection_grab ($eventtime[, $clipboard])
756		1347
757	Try to request the primary selection from the server (for example, as set	1348	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
758	by the next method).	1349	true) selection from the server. The corresponding text can be set
		1350	with the next method. No visual feedback will be given. This function
		1351	is mostly useful from within C<on_sel_grab> hooks.
759		1352
760	=item $oldtext = $term->selection ([$newtext])	1353	=item $oldtext = $term->selection ([$newtext, $clipboard])
761		1354
762	Return the current selection text and optionally replace it by C<$newtext>.	1355	Return the current selection (clipboard if C<$clipboard> is true) text
		1356	and optionally replace it by C<$newtext>.
763		1357
		1358	=item $term->selection_clear ([$clipboard])
		1359
		1360	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1361
764	#=item $term->overlay ($x, $y, $text)	1362	=item $term->overlay_simple ($x, $y, $text)
765	#	1363
766	#Create a simple multi-line overlay box. See the next method for details.	1364	Create a simple multi-line overlay box. See the next method for details.
767	#	1365
768	#=cut	1366	=cut
769	#	1367
770	#sub urxvt::term::scr_overlay {	1368	sub overlay_simple {
771	# my ($self, $x, $y, $text) = @_;	1369	my ($self, $x, $y, $text) = @_;
772	#	1370
773	# my @lines = split /\n/, $text;	1371	my @lines = split /\n/, $text;
774	#	1372
775	# my $w = 0;	1373	my $w = List::Util::max map $self->strwidth ($_), @lines;
776	# for (map $self->strwidth ($_), @lines) {	1374
777	# $w = $_ if $w < $_;
778	# }
779	#
780	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1375	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
781	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1376	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
782	#}	1377
		1378	$overlay
		1379	}
783		1380
784	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1381	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
785		1382
786	Create a new (empty) overlay at the given position with the given	1383	Create a new (empty) overlay at the given position with the given
787	width/height. C<$rstyle> defines the initial rendition style	1384	width/height. C<$rstyle> defines the initial rendition style
…		…
798		1395
799	The methods currently supported on C<urxvt::overlay> objects are:	1396	The methods currently supported on C<urxvt::overlay> objects are:
800		1397
801	=over 4	1398	=over 4
802		1399
803	=item $overlay->set ($x, $y, $text, $rend)	1400	=item $overlay->set ($x, $y, $text[, $rend])
804		1401
805	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1402	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
806	text in rxvt-unicode's special encoding and an array of rendition values	1403	text in rxvt-unicode's special encoding and an array of rendition values
807	at a specific position inside the overlay.	1404	at a specific position inside the overlay.
		1405
		1406	If C<$rend> is missing, then the rendition will not be changed.
808		1407
809	=item $overlay->hide	1408	=item $overlay->hide
810		1409
811	If visible, hide the overlay, but do not destroy it.	1410	If visible, hide the overlay, but do not destroy it.
812		1411
…		…
854		1453
855	=item $string = $term->locale_decode ($octets)	1454	=item $string = $term->locale_decode ($octets)
856		1455
857	Convert the given locale-encoded octets into a perl string.	1456	Convert the given locale-encoded octets into a perl string.
858		1457
		1458	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1459
		1460	XORs the rendition values in the given span with the provided value
		1461	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1462	refresh hooks to provide effects similar to the selection.
		1463
		1464	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1465
		1466	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1467	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1468	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1469	it instead. Both styles I<MUST NOT> contain font styles.
		1470
		1471	=item $term->scr_bell
		1472
		1473	Ring the bell!
		1474
859	=item $term->scr_add_lines ($string)	1475	=item $term->scr_add_lines ($string)
860		1476
861	Write the given text string to the screen, as if output by the application	1477	Write the given text string to the screen, as if output by the application
862	running inside the terminal. It may not contain command sequences (escape	1478	running inside the terminal. It may not contain command sequences (escape
863	codes), but is free to use line feeds, carriage returns and tabs. The	1479	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
865		1481
866	Normally its not a good idea to use this function, as programs might be	1482	Normally its not a good idea to use this function, as programs might be
867	confused by changes in cursor position or scrolling. Its useful inside a	1483	confused by changes in cursor position or scrolling. Its useful inside a
868	C<on_add_lines> hook, though.	1484	C<on_add_lines> hook, though.
869		1485
		1486	=item $term->scr_change_screen ($screen)
		1487
		1488	Switch to given screen - 0 primary, 1 secondary.
		1489
870	=item $term->cmd_parse ($octets)	1490	=item $term->cmd_parse ($octets)
871		1491
872	Similar to C<scr_add_lines>, but the argument must be in the	1492	Similar to C<scr_add_lines>, but the argument must be in the
873	locale-specific encoding of the terminal and can contain command sequences	1493	locale-specific encoding of the terminal and can contain command sequences
874	(escape codes) that will be interpreted.	1494	(escape codes) that will be interpreted.
875		1495
876	=item $term->tt_write ($octets)	1496	=item $term->tt_write ($octets)
877		1497
878	Write the octets given in C<$data> to the tty (i.e. as program input). To	1498	Write the octets given in C<$octets> to the tty (i.e. as program input). To
879	pass characters instead of octets, you should convert your strings first	1499	pass characters instead of octets, you should convert your strings first
880	to the locale-specific encoding using C<< $term->locale_encode >>.	1500	to the locale-specific encoding using C<< $term->locale_encode >>.
881		1501
		1502	=item $term->tt_write_user_input ($octets)
		1503
		1504	Like C<tt_write>, but should be used when writing strings in response to
		1505	the user pressing a key, to invoke the additional actions requested by
		1506	the user for that case (C<tt_write> doesn't do that).
		1507
		1508	The typical use case would be inside C<on_action> hooks.
		1509
		1510	=item $term->tt_paste ($octets)
		1511
		1512	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1513	CR and bracketing the data with control sequences if bracketed paste mode
		1514	is set.
		1515
		1516	=item $old_events = $term->pty_ev_events ([$new_events])
		1517
		1518	Replaces the event mask of the pty watcher by the given event mask. Can
		1519	be used to suppress input and output handling to the pty/tty. See the
		1520	description of C<< urxvt::timer->events >>. Make sure to always restore
		1521	the previous value.
		1522
		1523	=item $fd = $term->pty_fd
		1524
		1525	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1526	is used.
		1527
882	=item $windowid = $term->parent	1528	=item $windowid = $term->parent
883		1529
884	Return the window id of the toplevel window.	1530	Return the window id of the toplevel window.
885		1531
886	=item $windowid = $term->vt	1532	=item $windowid = $term->vt
887		1533
888	Return the window id of the terminal window.	1534	Return the window id of the terminal window.
889		1535
		1536	=item $term->vt_emask_add ($x_event_mask)
		1537
		1538	Adds the specified events to the vt event mask. Useful e.g. when you want
		1539	to receive pointer events all the times:
		1540
		1541	$term->vt_emask_add (urxvt::PointerMotionMask);
		1542
		1543	=item $term->set_urgency ($set)
		1544
		1545	Enable/disable the urgency hint on the toplevel window.
		1546
		1547	=item $term->focus_in
		1548
		1549	=item $term->focus_out
		1550
		1551	=item $term->key_press ($state, $keycode[, $time])
		1552
		1553	=item $term->key_release ($state, $keycode[, $time])
		1554
		1555	Deliver various fake events to to terminal.
		1556
890	=item $window_width = $term->width	1557	=item $window_width = $term->width
891		1558
892	=item $window_height = $term->height	1559	=item $window_height = $term->height
893		1560
894	=item $font_width = $term->fwidth	1561	=item $font_width = $term->fwidth
…		…
907		1574
908	=item $max_scrollback = $term->saveLines	1575	=item $max_scrollback = $term->saveLines
909		1576
910	=item $nrow_plus_saveLines = $term->total_rows	1577	=item $nrow_plus_saveLines = $term->total_rows
911		1578
912	=item $lines_in_scrollback = $term->nsaved	1579	=item $topmost_scrollback_row = $term->top_row
913		1580
914	Return various integers describing terminal characteristics.	1581	Return various integers describing terminal characteristics.
		1582
		1583	=item $x_display = $term->display_id
		1584
		1585	Return the DISPLAY used by rxvt-unicode.
		1586
		1587	=item $lc_ctype = $term->locale
		1588
		1589	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1590
		1591	=item $env = $term->env
		1592
		1593	Returns a copy of the environment in effect for the terminal as a hashref
		1594	similar to C<\%ENV>.
		1595
		1596	=item @envv = $term->envv
		1597
		1598	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1599
		1600	=item @argv = $term->argv
		1601
		1602	Return the argument vector as this terminal, similar to @ARGV, but
		1603	includes the program name as first element.
		1604
		1605	=cut
		1606
		1607	sub env {
		1608	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1609	}
915		1610
916	=item $modifiermask = $term->ModLevel3Mask	1611	=item $modifiermask = $term->ModLevel3Mask
917		1612
918	=item $modifiermask = $term->ModMetaMask	1613	=item $modifiermask = $term->ModMetaMask
919		1614
920	=item $modifiermask = $term->ModNumLockMask	1615	=item $modifiermask = $term->ModNumLockMask
921		1616
922	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1617	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
923	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1618	AltGr), the meta key (often Alt) and the num lock key, if applicable.
924		1619
		1620	=item $screen = $term->current_screen
		1621
		1622	Returns the currently displayed screen (0 primary, 1 secondary).
		1623
		1624	=item $cursor_is_hidden = $term->hidden_cursor
		1625
		1626	Returns whether the cursor is currently hidden or not.
		1627
925	=item $view_start = $term->view_start ([$newvalue])	1628	=item $view_start = $term->view_start ([$newvalue])
926		1629
927	Returns the negative row number of the topmost line. Minimum value is	1630	Returns the row number of the topmost displayed line. Maximum value is
928	C<0>, which displays the normal terminal contents. Larger values scroll	1631	C<0>, which displays the normal terminal contents. Lower values scroll
929	this many lines into the scrollback buffer.	1632	this many lines into the scrollback buffer.
930		1633
931	=item $term->want_refresh	1634	=item $term->want_refresh
932		1635
933	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1636	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
936		1639
937	Used after changing terminal contents to display them.	1640	Used after changing terminal contents to display them.
938		1641
939	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1642	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
940		1643
941	Returns the text of the entire row with number C<$row_number>. Row C<0>	1644	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
942	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1645	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
943	terminal line. The scrollback buffer starts at line C<-1> and extends to
944	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1646	terminal line. Nothing will be returned if a nonexistent line
945	is requested.	1647	is requested.
946		1648
947	If C<$new_text> is specified, it will replace characters in the current	1649	If C<$new_text> is specified, it will replace characters in the current
948	line, starting at column C<$start_col> (default C<0>), which is useful	1650	line, starting at column C<$start_col> (default C<0>), which is useful
949	to replace only parts of a line. The font index in the rendition will	1651	to replace only parts of a line. The font index in the rendition will
950	automatically be updated.	1652	automatically be updated.
951		1653
952	C<$text> is in a special encoding: tabs and wide characters that use more	1654	C<$text> is in a special encoding: tabs and wide characters that use more
953	than one cell when displayed are padded with urxvt::NOCHAR characters	1655	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
954	(C<chr 65535>). Characters with combining characters and other characters	1656	characters. Characters with combining characters and other characters that
955	that do not fit into the normal tetx encoding will be replaced with	1657	do not fit into the normal text encoding will be replaced with characters
956	characters in the private use area.	1658	in the private use area.
957		1659
958	You have to obey this encoding when changing text. The advantage is	1660	You have to obey this encoding when changing text. The advantage is
959	that C<substr> and similar functions work on screen cells and not on	1661	that C<substr> and similar functions work on screen cells and not on
960	characters.	1662	characters.
961		1663
…		…
1012	Return the row number of the first/last row of the line, respectively.	1714	Return the row number of the first/last row of the line, respectively.
1013		1715
1014	=item $offset = $line->offset_of ($row, $col)	1716	=item $offset = $line->offset_of ($row, $col)
1015		1717
1016	Returns the character offset of the given row|col pair within the logical	1718	Returns the character offset of the given row|col pair within the logical
1017	line.	1719	line. Works for rows outside the line, too, and returns corresponding
		1720	offsets outside the string.
1018		1721
1019	=item ($row, $col) = $line->coord_of ($offset)	1722	=item ($row, $col) = $line->coord_of ($offset)
1020		1723
1021	Translates a string offset into terminal coordinates again.	1724	Translates a string offset into terminal coordinates again.
1022		1725
…		…
1044	}	1747	}
1045		1748
1046	sub urxvt::line::t {	1749	sub urxvt::line::t {
1047	my ($self) = @_;	1750	my ($self) = @_;
1048		1751
1049	if (@_ > 1)	1752	if (@_ > 1) {
1050	{
1051	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1753	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1052	for $self->{beg} .. $self->{end};	1754	for $self->{beg} .. $self->{end};
1053	}	1755	}
1054		1756
1055	defined wantarray &&	1757	defined wantarray &&
1056	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1758	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1057	0, $self->{len}	1759	0, $self->{len}
1058	}	1760	}
1059		1761
1060	sub urxvt::line::r {	1762	sub urxvt::line::r {
1061	my ($self) = @_;	1763	my ($self) = @_;
1062		1764
1063	if (@_ > 1)	1765	if (@_ > 1) {
1064	{
1065	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1766	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1066	for $self->{beg} .. $self->{end};	1767	for $self->{beg} .. $self->{end};
1067	}	1768	}
1068		1769
1069	if (defined wantarray) {	1770	if (defined wantarray) {
1070	my $rend = [	1771	my $rend = [
1071	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1772	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1072	];	1773	];
…		…
1104	where one character corresponds to one screen cell. See	1805	where one character corresponds to one screen cell. See
1105	C<< $term->ROW_t >> for details.	1806	C<< $term->ROW_t >> for details.
1106		1807
1107	=item $string = $term->special_decode $text	1808	=item $string = $term->special_decode $text
1108		1809
1109	Converts rxvt-unicodes text reprsentation into a perl string. See	1810	Converts rxvt-unicodes text representation into a perl string. See
1110	C<< $term->ROW_t >> for details.	1811	C<< $term->ROW_t >> for details.
1111		1812
1112	=item $success = $term->grab_button ($button, $modifiermask)	1813	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1113		1814
		1815	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1816
1114	Registers a synchronous button grab. See XGrabButton.	1817	Register/unregister a synchronous button grab. See the XGrabButton
		1818	manpage.
1115		1819
1116	=item $success = $term->grab ($eventtime[, $sync])	1820	=item $success = $term->grab ($eventtime[, $sync])
1117		1821
1118	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1822	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1119	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1823	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1120		1824
1121	=item $term->allow_events_async	1825	=item $term->allow_events_async
1122		1826
1123	Calls XAllowEvents with AsyncBoth for the most recent grab.	1827	Calls XAllowEvents with AsyncBoth for the most recent grab.
1124		1828
…		…
1131	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1835	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1132	recent grab.	1836	recent grab.
1133		1837
1134	=item $term->ungrab	1838	=item $term->ungrab
1135		1839
1136	Calls XUngrab for the most recent grab. Is called automatically on	1840	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1137	evaluation errors, as it is better to lose the grab in the error case as	1841	evaluation errors, as it is better to lose the grab in the error case as
1138	the session.	1842	the session.
		1843
		1844	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1845
		1846	=item $atom_name = $term->XGetAtomName ($atom)
		1847
		1848	=item @atoms = $term->XListProperties ($window)
		1849
		1850	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1851
		1852	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1853
		1854	=item $term->XDeleteProperty ($window, $property)
		1855
		1856	=item $window = $term->DefaultRootWindow
		1857
		1858	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1859
		1860	=item $term->XMapWindow ($window)
		1861
		1862	=item $term->XUnmapWindow ($window)
		1863
		1864	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1865
		1866	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1867
		1868	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1869
		1870	=item $keysym = $term->XStringToKeysym ($string)
		1871
		1872	=item $string = $term->XKeysymToString ($keysym)
		1873
		1874	Various X or X-related functions. The C<$term> object only serves as
		1875	the source of the display, otherwise those functions map more-or-less
		1876	directly onto the X functions of the same name.
1139		1877
1140	=back	1878	=back
1141		1879
1142	=cut	1880	=cut
1143		1881
…		…
1159	$item->{render} ||= sub { $_[0]{text} };	1897	$item->{render} ||= sub { $_[0]{text} };
1160		1898
1161	push @{ $self->{item} }, $item;	1899	push @{ $self->{item} }, $item;
1162	}	1900	}
1163		1901
1164	sub add_separator {	1902	=item $popup->add_title ($title)
1165	my ($self, $sep) = @_;
1166		1903
1167	$sep ||= "═";	1904	Adds a non-clickable title to the popup.
1168		1905
1169	$self->add_item ({	1906	=cut
1170	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1171	text => "",
1172	render => sub { $sep x $urxvt::TERM->ncol },
1173	activate => sub { },
1174	});
1175	}
1176		1907
1177	sub add_title {	1908	sub add_title {
1178	my ($self, $title) = @_;	1909	my ($self, $title) = @_;
1179		1910
1180	$self->add_item ({	1911	$self->add_item ({
…		…
1182	text => $title,	1913	text => $title,
1183	activate => sub { },	1914	activate => sub { },
1184	});	1915	});
1185	}	1916	}
1186		1917
		1918	=item $popup->add_separator ([$sepchr])
		1919
		1920	Creates a separator, optionally using the character given as C<$sepchr>.
		1921
		1922	=cut
		1923
		1924	sub add_separator {
		1925	my ($self, $sep) = @_;
		1926
		1927	$sep ||= "=";
		1928
		1929	$self->add_item ({
		1930	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1931	text => "",
		1932	render => sub { $sep x $self->{term}->ncol },
		1933	activate => sub { },
		1934	});
		1935	}
		1936
		1937	=item $popup->add_button ($text, $cb)
		1938
		1939	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1940	selected.
		1941
		1942	=cut
		1943
1187	sub add_button {	1944	sub add_button {
1188	my ($self, $text, $cb) = @_;	1945	my ($self, $text, $cb) = @_;
1189		1946
1190	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1947	$self->add_item ({ type => "button", text => $text, activate => $cb});
1191	}	1948	}
		1949
		1950	=item $popup->add_toggle ($text, $initial_value, $cb)
		1951
		1952	Adds a toggle/checkbox item to the popup. The callback gets called
		1953	whenever it gets toggled, with a boolean indicating its new value as its
		1954	first argument.
		1955
		1956	=cut
1192		1957
1193	sub add_toggle {	1958	sub add_toggle {
1194	my ($self, $text, $cb, $value) = @_;	1959	my ($self, $text, $value, $cb) = @_;
1195		1960
1196	my $item; $item = {	1961	my $item; $item = {
1197	type => "button",	1962	type => "button",
1198	text => " $text",	1963	text => " $text",
1199	value => $value,	1964	value => $value,
1200	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1965	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1201	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1966	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1202	};	1967	};
1203		1968
1204	$self->add_item ($item);	1969	$self->add_item ($item);
1205	}	1970	}
		1971
		1972	=item $popup->show
		1973
		1974	Displays the popup (which is initially hidden).
		1975
		1976	=cut
1206		1977
1207	sub show {	1978	sub show {
1208	my ($self) = @_;	1979	my ($self) = @_;
1209		1980
1210	local $urxvt::popup::self = $self;	1981	local $urxvt::popup::self = $self;
1211		1982
1212	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1983	my $env = $self->{term}->env;
		1984	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1985	delete $env->{LC_ALL};
		1986	$env->{LC_CTYPE} = $self->{term}->locale;
		1987
		1988	my $term = urxvt::term->new (
		1989	$env, "popup",
		1990	"--perl-lib" => "", "--perl-ext-common" => "",
		1991	"-pty-fd" => -1, "-sl" => 0,
		1992	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1213	"--transient-for" => $self->{term}->parent,	1993	"--transient-for" => $self->{term}->parent,
		1994	"-display" => $self->{term}->display_id,
1214	"-pe" => "urxvt-popup")	1995	"-pe" => "urxvt-popup",
1215	or die "unable to create popup window\n";	1996	) or die "unable to create popup window\n";
		1997
		1998	unless (delete $term->{urxvt_popup_init_done}) {
		1999	$term->ungrab;
		2000	$term->destroy;
		2001	die "unable to initialise popup window\n";
		2002	}
1216	}	2003	}
1217		2004
1218	sub DESTROY {	2005	sub DESTROY {
1219	my ($self) = @_;	2006	my ($self) = @_;
1220		2007
1221	delete $self->{term}{_destroy}{$self};	2008	delete $self->{term}{_destroy}{$self};
1222	$self->{term}->ungrab;	2009	$self->{term}->ungrab;
1223	}	2010	}
		2011
		2012	=back
		2013
		2014	=cut
		2015
		2016	package urxvt::watcher;
1224		2017
1225	=head2 The C<urxvt::timer> Class	2018	=head2 The C<urxvt::timer> Class
1226		2019
1227	This class implements timer watchers/events. Time is represented as a	2020	This class implements timer watchers/events. Time is represented as a
1228	fractional number of seconds since the epoch. Example:	2021	fractional number of seconds since the epoch. Example:
…		…
1232	->new	2025	->new
1233	->interval (1)	2026	->interval (1)
1234	->cb (sub {	2027	->cb (sub {
1235	$term->{overlay}->set (0, 0,	2028	$term->{overlay}->set (0, 0,
1236	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2029	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1237	});	2030	});
1238		2031
1239	=over 4	2032	=over 4
1240		2033
1241	=item $timer = new urxvt::timer	2034	=item $timer = new urxvt::timer
1242		2035
…		…
1245		2038
1246	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2039	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1247		2040
1248	Set the callback to be called when the timer triggers.	2041	Set the callback to be called when the timer triggers.
1249		2042
1250	=item $tstamp = $timer->at
1251
1252	Return the time this watcher will fire next.
1253
1254	=item $timer = $timer->set ($tstamp)	2043	=item $timer = $timer->set ($tstamp[, $interval])
1255		2044
1256	Set the time the event is generated to $tstamp.	2045	Set the time the event is generated to $tstamp (and optionally specifies a
		2046	new $interval).
1257		2047
1258	=item $timer = $timer->interval ($interval)	2048	=item $timer = $timer->interval ($interval)
1259		2049
1260	Normally (and when C<$interval> is C<0>), the timer will automatically	2050	By default (and when C<$interval> is C<0>), the timer will automatically
1261	stop after it has fired once. If C<$interval> is non-zero, then the timer	2051	stop after it has fired once. If C<$interval> is non-zero, then the timer
1262	is automatically rescheduled at the given intervals.	2052	is automatically rescheduled at the given intervals.
1263		2053
1264	=item $timer = $timer->start	2054	=item $timer = $timer->start
1265		2055
1266	Start the timer.	2056	Start the timer.
1267		2057
1268	=item $timer = $timer->start ($tstamp)	2058	=item $timer = $timer->start ($tstamp[, $interval])
1269		2059
1270	Set the event trigger time to C<$tstamp> and start the timer.	2060	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2061	also replaces the interval.
		2062
		2063	=item $timer = $timer->after ($delay[, $interval])
		2064
		2065	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1271		2066
1272	=item $timer = $timer->stop	2067	=item $timer = $timer->stop
1273		2068
1274	Stop the timer.	2069	Stop the timer.
1275		2070
…		…
1281		2076
1282	$term->{socket} = ...	2077	$term->{socket} = ...
1283	$term->{iow} = urxvt::iow	2078	$term->{iow} = urxvt::iow
1284	->new	2079	->new
1285	->fd (fileno $term->{socket})	2080	->fd (fileno $term->{socket})
1286	->events (1) # wait for read data	2081	->events (urxvt::EV_READ)
1287	->start	2082	->start
1288	->cb (sub {	2083	->cb (sub {
1289	my ($iow, $revents) = @_;	2084	my ($iow, $revents) = @_;
1290	# $revents must be 1 here, no need to check	2085	# $revents must be 1 here, no need to check
1291	sysread $term->{socket}, my $buf, 8192	2086	sysread $term->{socket}, my $buf, 8192
…		…
1304	Set the callback to be called when io events are triggered. C<$reventmask>	2099	Set the callback to be called when io events are triggered. C<$reventmask>
1305	is a bitset as described in the C<events> method.	2100	is a bitset as described in the C<events> method.
1306		2101
1307	=item $iow = $iow->fd ($fd)	2102	=item $iow = $iow->fd ($fd)
1308		2103
1309	Set the filedescriptor (not handle) to watch.	2104	Set the file descriptor (not handle) to watch.
1310		2105
1311	=item $iow = $iow->events ($eventmask)	2106	=item $iow = $iow->events ($eventmask)
1312		2107
1313	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2108	Set the event mask to watch. The only allowed values are
1314	data, Bit #1 (value C<2>) enables watching for write data.	2109	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		2110	together, or C<urxvt::EV_NONE>.
1315		2111
1316	=item $iow = $iow->start	2112	=item $iow = $iow->start
1317		2113
1318	Start watching for requested events on the given handle.	2114	Start watching for requested events on the given handle.
1319		2115
1320	=item $iow = $iow->stop	2116	=item $iow = $iow->stop
1321		2117
1322	Stop watching for events on the given filehandle.	2118	Stop watching for events on the given file handle.
		2119
		2120	=back
		2121
		2122	=head2 The C<urxvt::iw> Class
		2123
		2124	This class implements idle watchers, that get called automatically when
		2125	the process is idle. They should return as fast as possible, after doing
		2126	some useful work.
		2127
		2128	=over 4
		2129
		2130	=item $iw = new urxvt::iw
		2131
		2132	Create a new idle watcher object in stopped state.
		2133
		2134	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2135
		2136	Set the callback to be called when the watcher triggers.
		2137
		2138	=item $timer = $timer->start
		2139
		2140	Start the watcher.
		2141
		2142	=item $timer = $timer->stop
		2143
		2144	Stop the watcher.
		2145
		2146	=back
		2147
		2148	=head2 The C<urxvt::pw> Class
		2149
		2150	This class implements process watchers. They create an event whenever a
		2151	process exits, after which they stop automatically.
		2152
		2153	my $pid = fork;
		2154	...
		2155	$term->{pw} = urxvt::pw
		2156	->new
		2157	->start ($pid)
		2158	->cb (sub {
		2159	my ($pw, $exit_status) = @_;
		2160	...
		2161	});
		2162
		2163	=over 4
		2164
		2165	=item $pw = new urxvt::pw
		2166
		2167	Create a new process watcher in stopped state.
		2168
		2169	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2170
		2171	Set the callback to be called when the timer triggers.
		2172
		2173	=item $pw = $timer->start ($pid)
		2174
		2175	Tells the watcher to start watching for process C<$pid>.
		2176
		2177	=item $pw = $pw->stop
		2178
		2179	Stop the watcher.
1323		2180
1324	=back	2181	=back
1325		2182
1326	=head1 ENVIRONMENT	2183	=head1 ENVIRONMENT
1327		2184
…		…
1334		2191
1335	=item == 0 - fatal messages	2192	=item == 0 - fatal messages
1336		2193
1337	=item >= 3 - script loading and management	2194	=item >= 3 - script loading and management
1338		2195
1339	=item >=10 - all events received	2196	=item >=10 - all called hooks
		2197
		2198	=item >=11 - hook return values
1340		2199
1341	=back	2200	=back
1342		2201
1343	=head1 AUTHOR	2202	=head1 AUTHOR
1344		2203
1345	Marc Lehmann <pcg@goof.com>	2204	Marc Lehmann <schmorp@schmorp.de>
1346	http://software.schmorp.de/pkg/rxvt-unicode	2205	http://software.schmorp.de/pkg/rxvt-unicode
1347		2206
1348	=cut	2207	=cut
1349		2208
1350	1	2209	1
		2210
		2211	# vim: sw=3:

Diff Legend

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