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

Diff Legend

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