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

Diff Legend

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