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.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.245 by root, Mon Dec 22 09:10:12 2014 UTC

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

Diff Legend

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