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

Diff Legend

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