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.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs.
Revision 1.256 by sf-exg, Thu Jul 14 05:10:06 2016 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	The selection works by trying to match a number of regexes and displaying
54	them in increasing order of length. You can add your own regexes by
55	specifying resources of the form:
56
57	URxvt.selection.pattern-0: perl-regex
58	URxvt.selection.pattern-1: perl-regex
59	...
60
61	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:
65
66	URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.
70
71	This extension also offers following bindable keyboard commands:
72
73	=over 4
74
75	=item rot13
76
77	Rot-13 the selection when activated. Used via keyboard trigger:
78
79	URxvt.keysym.C-M-r: perl:selection:rot13
80
81	=item remote-pastebin
82
83	Upload the selection as textfile to a remote site.
84
85	URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87	To set the command to upload the file set this resource:
88
89	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92	md5 sum of the selection.
93	After an successful upload the selection will be replaced by the following url
94	(the % is the placeholder for the filename):
95
96	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
97
98	=back
99
100	=item option-popup (enabled by default)
101
102	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
103	runtime.
104
105	=item selection-popup (enabled by default)
106
107	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
108	text into various other formats/action (such as uri unescaping, perl
109	evalution, web-browser starting etc.), depending on content.
110
111	=item searchable-scrollback<hotkey> (enabled by default)
112
113	Adds regex search functionality to the scrollback buffer, triggered
114	by a hotkey (default: C<M-s>). While in search mode, normal terminal
115	input/output is suspended and a regex is displayed at the bottom of the
116	screen.
117
118	Inputting characters appends them to the regex and continues incremental
119	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
120	search upwards/downwards in the scrollback buffer, C<End> jumps to the
121	bottom. C<Escape> leaves search mode and returns to the point where search
122	was started, while C<Enter> or C<Return> stay at the current position and
123	additionally stores the first match in the current line into the primary
124	selection.
125
126	=item selection-autotransform
127
128	This selection allows you to do automatic transforms on a selection
129	whenever a selection is made.
130
131	It works by specifying perl snippets (most useful is a single C<s///>
132	operator) that modify C<$_> as resources:
133
134	URxvt.selection-autotransform.0: transform
135	URxvt.selection-autotransform.1: transform
136	...
137
138	For example, the following will transform selections of the form
139	C<filename:number>, often seen in compiler messages, into C<vi +$filename
140	$word>:
141
142	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
143
144	And this example matches the same,but replaces it with vi-commands you can
145	paste directly into your (vi :) editor:
146
147	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
148
149	Of course, this can be modified to suit your needs and your editor :)
150
151	To expand the example above to typical perl error messages ("XXX at
152	FILENAME line YYY."), you need a slightly more elaborate solution:
153
154	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
155	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
156
157	The first line tells the selection code to treat the unchanging part of
158	every error message as a selection pattern, and the second line transforms
159	the message into vi commands to load the file.
160
161	=item mark-urls
162
163	Uses per-line display filtering (C<on_line_update>) to underline urls and
164	make them clickable. When middle-clicked, the program specified in the
165	resource C<urlLauncher> (default C<x-www-browser>) will be started with
166	the URL as first argument.
167
168	=item block-graphics-to-ascii
169
170	A not very useful example of filtering all text output to the terminal,
171	by replacing all line-drawing characters (U+2500 .. U+259F) by a
172	similar-looking ascii character.
173
174	=item digital-clock
175
176	Displays a digital clock using the built-in overlay.
177
178	=item example-refresh-hooks
179
180	Displays a very simple digital clock in the upper right corner of the
181	window. Illustrates overwriting the refresh callbacks to create your own
182	overlays or changes.
183
184	=back
185		56
186	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
187		58
188	=head2 General API Considerations	59	=head2 General API Considerations
189		60
…		…
203		74
204	=over 4	75	=over 4
205		76
206	=item $text	77	=item $text
207		78
208	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
209	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.
210		81
211	=item $string	82	=item $string
212		83
213	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
…		…
217	=item $octets	88	=item $octets
218		89
219	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
220	locale-specific way.	91	locale-specific way.
221		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
222	=back	99	=back
223		100
224	=head2 Extension Objects	101	=head2 Extension Objects
225		102
226	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
227	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,
228	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
229	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
230	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
231	use.	109	internal use.
232		110
233	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
234	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
235		113
236	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:
237		123
238	=over 4	124	=over 4
239		125
240	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
241		127
242	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
243	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>
244		130	or C<string>, and C<desc> is the resource description.
245	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
246
247	Dynamically enable the given hooks (named without the C<on_> prefix) for
248	this extension, replacing any previous hook. This is useful when you want
249	to overwrite time-critical hooks only temporarily.
250
251	=item $self->disable ($hook_name[, $hook_name..])
252
253	Dynamically disable the given hooks.
254		131
255	=back	132	=back
256		133
257	=head2 Hooks	134	=head2 Hooks
258		135
259	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
260	called whenever the relevant event happens.	137	called whenever the relevant event happens.
261		138
262	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
263	the in the C<Extension Objects> section.	140	the in the C<Extension Objects> section.
264		141
265	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
266	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
267	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.
268		145
269	I<< When in doubt, return a false value (preferably C<()>). >>	146	I<< When in doubt, return a false value (preferably C<()>). >>
270		147
271	=over 4	148	=over 4
272		149
273	=item on_init $term	150	=item on_init $term
274		151
275	Called after a new terminal object has been initialized, but before	152	Called after a new terminal object has been initialized, but before
276	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
277	call or deliver senseless data, as terminal size and other characteristics	154	call or deliver senseless data, as terminal size and other characteristics
278	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
279	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).
280		168
281	=item on_reset $term	169	=item on_reset $term
282		170
283	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
284	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
285	variables.	173	variables.
286		174
287	=item on_start $term	175	=item on_child_start $term, $pid
288		176
289	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.
290	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>.
291		183
292	=item on_sel_make $term, $eventtime	184	=item on_sel_make $term, $eventtime
293		185
294	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
295	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
…		…
302		194
303	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
304	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
305	by calling C<< $term->selection >>.	197	by calling C<< $term->selection >>.
306		198
307	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.
308		200
309	=item on_sel_extend $term	201	=item on_sel_extend $term
310		202
311	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
312	click) and is either supposed to return false (normal operation), or	204	click) and is either supposed to return false (normal operation), or
313	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
314	processing. This can happen multiple times, as long as the callback	206	processing. This can happen multiple times, as long as the callback
315	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
316	supposed to enlarge the selection more and more, if possible.	208	supposed to enlarge the selection more and more, if possible.
317		209
318	See the F<selection> example extension.	210	See the F<selection> example extension.
319		211
320	=item on_view_change $term, $offset	212	=item on_view_change $term, $offset
321		213
322	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
323	scrolls. Offset C<0> means display the normal terminal, positive values	215	scrolls. Offset C<0> means display the normal terminal, positive values
324	show this many lines of scrollback.	216	show this many lines of scrollback.
325		217
326	=item on_scroll_back $term, $lines, $saved	218	=item on_scroll_back $term, $lines, $saved
327		219
…		…
331		223
332	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,
333	$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
334	number of lines that will be in the scrollback buffer.	226	number of lines that will be in the scrollback buffer.
335		227
336	=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
337		239
338	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	240	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
339	operating system command) is processed. Cursor position and other state	241	operating system command) is processed. Cursor position and other state
340	information is up-to-date when this happens. For interoperability, the	242	information is up-to-date when this happens. For interoperability, the
341	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,
342	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
343	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	}
344		256
345	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,
346	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
347	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.
348		263
349	=item on_add_lines $term, $string	264	=item on_add_lines $term, $string
350		265
351	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
352	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
…		…
357	=item on_tt_write $term, $octets	272	=item on_tt_write $term, $octets
358		273
359	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
360	suppress or filter tty input.	275	suppress or filter tty input.
361		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
362	=item on_line_update $term, $row	284	=item on_line_update $term, $row
363		285
364	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
365	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
366	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,
…		…
373	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
374	you cannot just toggle rendition bits, but only set them.	296	you cannot just toggle rendition bits, but only set them.
375		297
376	=item on_refresh_begin $term	298	=item on_refresh_begin $term
377		299
378	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
379	or similar effects by modify terminal contents in refresh_begin, and	301	similar effects by modifying the terminal contents in refresh_begin, and
380	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
381	code is run after this hook, and takes precedence.	303	code is run after this hook, and takes precedence.
382		304
383	=item on_refresh_end $term	305	=item on_refresh_end $term
384		306
385	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>.
386		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
387	=item on_keyboard_command $term, $string	317	=item on_user_command $term, $string *DEPRECATED*
388		318
389	Called whenever the user presses a key combination that has a	319	Called whenever a user-configured event is being activated (e.g. via
390	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>
391	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.
392		331
393	=item on_x_event $term, $event	332	=item on_x_event $term, $event
394		333
395	Called on every X event received on the vt window (and possibly other	334	Called on every X event received on the vt window (and possibly other
396	windows). Should only be used as a last resort. Most event structure	335	windows). Should only be used as a last resort. Most event structure
397	members are not passed.	336	members are not passed.
398		337
		338	=item on_root_event $term, $event
		339
		340	Like C<on_x_event>, but is called for events on the root window.
		341
399	=item on_focus_in $term	342	=item on_focus_in $term
400		343
401	Called whenever the window gets the keyboard focus, before rxvt-unicode	344	Called whenever the window gets the keyboard focus, before rxvt-unicode
402	does focus in processing.	345	does focus in processing.
403		346
404	=item on_focus_out $term	347	=item on_focus_out $term
405		348
406	Called wheneever the window loses keyboard focus, before rxvt-unicode does	349	Called whenever the window loses keyboard focus, before rxvt-unicode does
407	focus out processing.	350	focus out processing.
408		351
		352	=item on_configure_notify $term, $event
		353
		354	=item on_property_notify $term, $event
		355
409	=item on_key_press $term, $event, $keysym, $octets	356	=item on_key_press $term, $event, $keysym, $octets
410		357
411	=item on_key_release $term, $event, $keysym	358	=item on_key_release $term, $event, $keysym
412		359
413	=item on_button_press $term, $event	360	=item on_button_press $term, $event
…		…
418		365
419	=item on_map_notify $term, $event	366	=item on_map_notify $term, $event
420		367
421	=item on_unmap_notify $term, $event	368	=item on_unmap_notify $term, $event
422		369
423	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
424	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.
425		372
426	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
427	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
428	and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
429		376
430	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
431	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
432		379
433	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.
434		392
435	=back	393	=back
436		394
437	=cut	395	=cut
438		396
439	package urxvt;	397	package urxvt;
440		398
441	use utf8;	399	use utf8;
442	use strict;	400	use strict 'vars';
443	use Carp ();	401	use Carp ();
444	use Scalar::Util ();	402	use Scalar::Util ();
445	use List::Util ();	403	use List::Util ();
446		404
447	our $VERSION = 1;	405	our $VERSION = 1;
448	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.
449	our @HOOKNAME;	409	our @HOOKNAME;
450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	410	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451	our %OPTION;	411	our %OPTION;
452		412
453	our $LIBDIR;	413	our $LIBDIR;
454	our $RESNAME;	414	our $RESNAME;
455	our $RESCLASS;	415	our $RESCLASS;
456	our $RXVTNAME;	416	our $RXVTNAME;
457		417
		418	our $NOCHAR = chr 0xffff;
		419
458	=head2 Variables in the C<urxvt> Package	420	=head2 Variables in the C<urxvt> Package
459		421
460	=over 4	422	=over 4
461		423
462	=item $urxvt::LIBDIR	424	=item $urxvt::LIBDIR
…		…
475	=item $urxvt::TERM	437	=item $urxvt::TERM
476		438
477	The current terminal. This variable stores the current C<urxvt::term>	439	The current terminal. This variable stores the current C<urxvt::term>
478	object, whenever a callback/hook is executing.	440	object, whenever a callback/hook is executing.
479		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
480	=back	458	=back
481		459
482	=head2 Functions in the C<urxvt> Package	460	=head2 Functions in the C<urxvt> Package
483		461
484	=over 4	462	=over 4
485		463
486	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
487		465
488	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
489	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
490	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
491		470
492	=item urxvt::warn $string	471	=item urxvt::warn $string
493		472
494	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
495	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
496	that calls this function.	475	that calls this function.
497		476
498	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
499	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
500		479
501	Messages have a size limit of 1023 bytes currently.	480	Messages have a size limit of 1023 bytes currently.
502		481
503	=item $is_safe = urxvt::safe	482	=item @terms = urxvt::termlist
504		483
505	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
506	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
507	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).
508		488
509	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
510		490
511	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
512		492
…		…
555		535
556	=item $rend = urxvt::OVERLAY_RSTYLE	536	=item $rend = urxvt::OVERLAY_RSTYLE
557		537
558	Return the rendition mask used for overlays by default.	538	Return the rendition mask used for overlays by default.
559		539
560	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	540	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		541	urxvt::RS_RVid, urxvt::RS_Uline
561		542
562	Return the bit that enabled bold, italic, blink, reverse-video and	543	Return the bit that enabled bold, italic, blink, reverse-video and
563	underline, respectively. To enable such a style, just logically OR it into	544	underline, respectively. To enable such a style, just logically OR it into
564	the bitset.	545	the bitset.
565		546
…		…
571		552
572	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	553	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
573		554
574	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	555	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
575		556
		557	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		558
576	Replace the foreground/background colour in the rendition mask with the	559	Replace the foreground/background colour in the rendition mask with the
577	specified one.	560	specified one.
578		561
579	=item $value = urxvt::GET_CUSTOM $rend	562	=item $value = urxvt::GET_CUSTOM $rend
580		563
…		…
589	=back	572	=back
590		573
591	=cut	574	=cut
592		575
593	BEGIN {	576	BEGIN {
594	urxvt->bootstrap;
595
596	# overwrite perl's warn	577	# overwrite perl's warn
597	*CORE::GLOBAL::warn = sub {	578	*CORE::GLOBAL::warn = sub {
598	my $msg = join "", @_;	579	my $msg = join "", @_;
599	$msg .= "\n"	580	$msg .= "\n"
600	unless $msg =~ /\n$/;	581	unless $msg =~ /\n$/;
601	urxvt::warn ($msg);	582	urxvt::warn ($msg);
602	};	583	};
		584	}
603		585
604	# %ENV is the original startup environment	586	no warnings 'utf8';
605	delete $ENV{IFS};	587
606	delete $ENV{CDPATH};	588	sub parse_resource {
607	delete $ENV{BASH_ENV};	589	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
608	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	590
		591	$term->scan_extensions;
		592
		593	my $r = $term->{meta}{resource};
		594	keys %$r; # reset iterator
		595	while (my ($k, $v) = each %$r) {
		596	my $pattern = $k;
		597	$pattern =~ y/./-/ if $isarg;
		598	my $prefix = $name;
		599	my $suffix;
		600	if ($pattern =~ /\-$/) {
		601	$prefix = substr $name, 0, length $pattern;
		602	$suffix = substr $name, length $pattern;
		603	}
		604	if ($pattern eq $prefix) {
		605	$name = "$urxvt::RESCLASS.$k$suffix";
		606
		607	push @{ $term->{perl_ext_3} }, $v->[0];
		608
		609	return 1 unless $isarg;
		610
		611	if ($v->[1] eq "boolean") {
		612	$term->put_option_db ($name, $flag ? "true" : "false");
		613	return 1;
		614	} else {
		615	$term->put_option_db ($name, $value);
		616	return 1 + 2;
		617	}
		618	}
		619	}
		620
		621	0
		622	}
		623
		624	sub usage {
		625	my ($term, $usage_type) = @_;
		626
		627	$term->scan_extensions;
		628
		629	my $r = $term->{meta}{resource};
		630
		631	for my $pattern (sort keys %$r) {
		632	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		633
		634	$desc .= " (-pe $ext)";
		635
		636	if ($usage_type == 1) {
		637	$pattern =~ y/./-/;
		638	$pattern =~ s/-$/-.../g;
		639
		640	if ($type eq "boolean") {
		641	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		642	} else {
		643	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		644	}
		645	} else {
		646	$pattern =~ s/\.$/.*/g;
		647	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		648	}
		649	}
609	}	650	}
610		651
611	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	652	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
612		653
613	sub verbose {	654	sub verbose {
614	my ($level, $msg) = @_;	655	my ($level, $msg) = @_;
615	warn "$msg\n" if $level <= $verbosity;	656	warn "$msg\n" if $level <= $verbosity;
616	}	657	}
617		658
618	my $extension_pkg = "extension0000";
619	my %extension_pkg;	659	my %extension_pkg;
620		660
621	# load a single script into its own package, once only	661	# load a single script into its own package, once only
622	sub extension_package($) {	662	sub extension_package($) {
623	my ($path) = @_;	663	my ($path) = @_;
624		664
625	$extension_pkg{$path} ||= do {	665	$extension_pkg{$path} ||= do {
626	my $pkg = "urxvt::" . ($extension_pkg++);	666	$path =~ /([^\/\\]+)$/;
		667	my $pkg = $1;
		668	$pkg =~ s/[^[:word:]]/_/g;
		669	$pkg = "urxvt::ext::$pkg";
627		670
628	verbose 3, "loading extension '$path' into package '$pkg'";	671	verbose 3, "loading extension '$path' into package '$pkg'";
		672
		673	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
629		674
630	open my $fh, "<:raw", $path	675	open my $fh, "<:raw", $path
631	or die "$path: $!";	676	or die "$path: $!";
632		677
633	my $source = untaint	678	my $source =
634	"package $pkg; use strict; use utf8;\n"	679	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
635	. "use base urxvt::term::extension::;\n"
636	. "#line 1 \"$path\"\n{\n"	680	. "#line 1 \"$path\"\n{\n"
637	. (do { local $/; <$fh> })	681	. (do { local $/; <$fh> })
638	. "\n};\n1";	682	. "\n};\n1";
639		683
640	eval $source	684	eval $source
…		…
649	# called by the rxvt core	693	# called by the rxvt core
650	sub invoke {	694	sub invoke {
651	local $TERM = shift;	695	local $TERM = shift;
652	my $htype = shift;	696	my $htype = shift;
653		697
654	if ($htype == 0) { # INIT	698	if ($htype == HOOK_INIT) {
655	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	699	my @dirs = $TERM->perl_libdirs;
656		700
		701	$TERM->scan_extensions;
		702
657	my %ext_arg;	703	my %ext_arg;
658		704
		705	{
		706	my @init = @TERM_INIT;
		707	@TERM_INIT = ();
		708	$_->($TERM) for @init;
		709	my @pkg = @TERM_EXT;
		710	@TERM_EXT = ();
		711	$TERM->register_package ($_) for @pkg;
		712	}
		713
		714	for (
659	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	715	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		716	@{ delete $TERM->{perl_ext_3} }
		717	) {
660	if ($_ eq "default") {	718	if ($_ eq "default") {
		719
		720	$ext_arg{$_} = []
661	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	721	for qw(selection option-popup selection-popup readline searchable-scrollback);
		722
		723	for ($TERM->_keysym_resources) {
		724	next if /^(?:string|command|builtin|builtin-string|perl)/;
		725	next unless /^([A-Za-z0-9_\-]+):/;
		726
		727	my $ext = $1;
		728
		729	$ext_arg{$ext} = [];
		730	}
		731
662	} elsif (/^-(.*)$/) {	732	} elsif (/^-(.*)$/) {
663	delete $ext_arg{$1};	733	delete $ext_arg{$1};
		734
664	} elsif (/^([^<]+)<(.*)>$/) {	735	} elsif (/^([^<]+)<(.*)>$/) {
665	push @{ $ext_arg{$1} }, $2;	736	push @{ $ext_arg{$1} }, $2;
		737
666	} else {	738	} else {
667	$ext_arg{$_} ||= [];	739	$ext_arg{$_} ||= [];
668	}	740	}
669	}	741	}
670		742
671	while (my ($ext, $argv) = each %ext_arg) {	743	for my $ext (sort keys %ext_arg) {
672	my @files = grep -f $_, map "$_/$ext", @dirs;	744	my @files = grep -f $_, map "$_/$ext", @dirs;
673		745
674	if (@files) {	746	if (@files) {
675	$TERM->register_package (extension_package $files[0], $argv);	747	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
676	} else {	748	} else {
677	warn "perl extension '$ext' not found in perl library search path\n";	749	warn "perl extension '$ext' not found in perl library search path\n";
678	}	750	}
679	}	751	}
680		752
…		…
686		758
687	if (my $cb = $TERM->{_hook}[$htype]) {	759	if (my $cb = $TERM->{_hook}[$htype]) {
688	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	760	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
689	if $verbosity >= 10;	761	if $verbosity >= 10;
690		762
691	keys %$cb;	763	if ($htype == HOOK_ACTION) {
		764	# this hook is only sent to the extension with the name
		765	# matching the first arg
		766	my $pkg = shift;
		767	$pkg =~ y/-/_/;
		768	$pkg = "urxvt::ext::$pkg";
692		769
693	while (my ($pkg, $cb) = each %$cb) {	770	$cb = $cb->{$pkg}
		771	or return undef; #TODO: maybe warn user?
		772
		773	$cb = { $pkg => $cb };
		774	}
		775
		776	for my $pkg (keys %$cb) {
694	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	777	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
695	and last;	778	$retval ||= $retval_;
696		779
697	if ($@) {	780	if ($@) {
698	$TERM->ungrab; # better to lose the grab than the session	781	$TERM->ungrab; # better to lose the grab than the session
699	warn $@;	782	warn $@;
700	}	783	}
…		…
702		785
703	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	786	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
704	if $verbosity >= 11;	787	if $verbosity >= 11;
705	}	788	}
706		789
707	if ($htype == 1) { # DESTROY	790	if ($htype == HOOK_DESTROY) {
708	# clear package objects	791	# clear package objects
709	%$_ = () for values %{ $TERM->{_pkg} };	792	%$_ = () for values %{ $TERM->{_pkg} };
710		793
711	# clear package	794	# clear package
712	%$TERM = ();	795	%$TERM = ();
713	}	796	}
714		797
715	$retval	798	$retval
716	}	799	}
717		800
718	sub exec_async(@) {	801	sub SET_COLOR($$$) {
719	my $pid = fork;	802	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
720
721	return
722	if !defined $pid or $pid;
723
724	%ENV = %{ $TERM->env };
725
726	exec @_;
727	_exit 255;
728	}	803	}
729		804
730	# urxvt::term::extension	805	sub rend2mask {
		806	no strict 'refs';
		807	my ($str, $mask) = (@_, 0);
		808	my %color = ( fg => undef, bg => undef );
		809	my @failed;
		810	for my $spec ( split /\s+/, $str ) {
		811	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		812	$color{lc($1)} = $2;
		813	} else {
		814	my $neg = $spec =~ s/^[-^]//;
		815	unless ( exists &{"RS_$spec"} ) {
		816	push @failed, $spec;
		817	next;
		818	}
		819	my $cur = &{"RS_$spec"};
		820	if ( $neg ) {
		821	$mask &= ~$cur;
		822	} else {
		823	$mask |= $cur;
		824	}
		825	}
		826	}
		827	($mask, @color{qw(fg bg)}, \@failed)
		828	}
731		829
732	package urxvt::term::extension;	830	package urxvt::term::extension;
733		831
734	sub enable {	832	=head2 The C<urxvt::term::extension> class
735	my ($self, %hook) = @_;
736	my $pkg = $self->{_pkg};
737		833
738	while (my ($name, $cb) = each %hook) {	834	Each extension attached to a terminal object is represented by
739	my $htype = $HOOKTYPE{uc $name};	835	a C<urxvt::term::extension> object.
740	defined $htype
741	or Carp::croak "unsupported hook type '$name'";
742		836
743	$self->set_should_invoke ($htype, +1)	837	You can use these objects, which are passed to all callbacks to store any
744	unless exists $self->{term}{_hook}[$htype]{$pkg};	838	state related to the terminal and extension instance.
745		839
746	$self->{term}{_hook}[$htype]{$pkg} = $cb;	840	The methods (And data members) documented below can be called on extension
747	}	841	objects, in addition to call methods documented for the <urxvt::term>
748	}	842	class.
749		843
750	sub disable {	844	=over 4
751	my ($self, @hook) = @_;
752	my $pkg = $self->{_pkg};
753		845
754	for my $name (@hook) {	846	=item $urxvt_term = $self->{term}
755	my $htype = $HOOKTYPE{uc $name};
756	defined $htype
757	or Carp::croak "unsupported hook type '$name'";
758		847
759	$self->set_should_invoke ($htype, -1)	848	Returns the C<urxvt::term> object associated with this instance of the
760	if delete $self->{term}{_hook}[$htype]{$pkg};	849	extension. This member I<must not> be changed in any way.
761	}	850
762	}	851	=cut
763		852
764	our $AUTOLOAD;	853	our $AUTOLOAD;
765		854
766	sub AUTOLOAD {	855	sub AUTOLOAD {
767	$AUTOLOAD =~ /:([^:]+)$/	856	$AUTOLOAD =~ /:([^:]+)$/
…		…
780		869
781	sub DESTROY {	870	sub DESTROY {
782	# nop	871	# nop
783	}	872	}
784		873
785	# urxvt::destroy_hook	874	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
786		875
787	sub urxvt::destroy_hook::DESTROY {	876	sub urxvt::destroy_hook::DESTROY {
788	${$_[0]}->();	877	${$_[0]}->();
789	}	878	}
790		879
791	sub urxvt::destroy_hook(&) {	880	sub urxvt::destroy_hook(&) {
792	bless \shift, urxvt::destroy_hook::	881	bless \shift, urxvt::destroy_hook::
793	}	882	}
		883
		884	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		885
		886	Dynamically enable the given hooks (named without the C<on_> prefix) for
		887	this extension, replacing any hook previously installed via C<enable> in
		888	this extension.
		889
		890	This is useful when you want to overwrite time-critical hooks only
		891	temporarily.
		892
		893	To install additional callbacks for the same hook, you can use the C<on>
		894	method of the C<urxvt::term> class.
		895
		896	=item $self->disable ($hook_name[, $hook_name..])
		897
		898	Dynamically disable the given hooks.
		899
		900	=cut
		901
		902	sub enable {
		903	my ($self, %hook) = @_;
		904	my $pkg = $self->{_pkg};
		905
		906	while (my ($name, $cb) = each %hook) {
		907	my $htype = $HOOKTYPE{uc $name};
		908	defined $htype
		909	or Carp::croak "unsupported hook type '$name'";
		910
		911	$self->set_should_invoke ($htype, +1)
		912	unless exists $self->{term}{_hook}[$htype]{$pkg};
		913
		914	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		915	}
		916	}
		917
		918	sub disable {
		919	my ($self, @hook) = @_;
		920	my $pkg = $self->{_pkg};
		921
		922	for my $name (@hook) {
		923	my $htype = $HOOKTYPE{uc $name};
		924	defined $htype
		925	or Carp::croak "unsupported hook type '$name'";
		926
		927	$self->set_should_invoke ($htype, -1)
		928	if delete $self->{term}{_hook}[$htype]{$pkg};
		929	}
		930	}
		931
		932	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		933
		934	Similar to the C<enable> enable, but installs additional callbacks for
		935	the given hook(s) (that is, it doesn't replace existing callbacks), and
		936	returns a guard object. When the guard object is destroyed the callbacks
		937	are disabled again.
		938
		939	=cut
		940
		941	sub urxvt::extension::on_disable::DESTROY {
		942	my $disable = shift;
		943
		944	my $term = delete $disable->{""};
		945
		946	while (my ($htype, $id) = each %$disable) {
		947	delete $term->{_hook}[$htype]{$id};
		948	$term->set_should_invoke ($htype, -1);
		949	}
		950	}
		951
		952	sub on {
		953	my ($self, %hook) = @_;
		954
		955	my $term = $self->{term};
		956
		957	my %disable = ( "" => $term );
		958
		959	while (my ($name, $cb) = each %hook) {
		960	my $htype = $HOOKTYPE{uc $name};
		961	defined $htype
		962	or Carp::croak "unsupported hook type '$name'";
		963
		964	$term->set_should_invoke ($htype, +1);
		965	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		966	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		967	}
		968
		969	bless \%disable, "urxvt::extension::on_disable"
		970	}
		971
		972	=item $self->bind_action ($hotkey, $action)
		973
		974	=item $self->x_resource ($pattern)
		975
		976	=item $self->x_resource_boolean ($pattern)
		977
		978	These methods support an additional C<%> prefix for C<$action> or
		979	C<$pattern> when called on an extension object, compared to the
		980	C<urxvt::term> methods of the same name - see the description of these
		981	methods in the C<urxvt::term> class for details.
		982
		983	=cut
		984
		985	sub bind_action {
		986	my ($self, $hotkey, $action) = @_;
		987	$action =~ s/^%:/$_[0]{_name}:/;
		988	$self->{term}->bind_action ($hotkey, $action)
		989	}
		990
		991	sub x_resource {
		992	my ($self, $name) = @_;
		993	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		994	$self->{term}->x_resource ($name)
		995	}
		996
		997	sub x_resource_boolean {
		998	my ($self, $name) = @_;
		999	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1000	$self->{term}->x_resource_boolean ($name)
		1001	}
		1002
		1003	=back
		1004
		1005	=cut
794		1006
795	package urxvt::anyevent;	1007	package urxvt::anyevent;
796		1008
797	=head2 The C<urxvt::anyevent> Class	1009	=head2 The C<urxvt::anyevent> Class
798		1010
799	The sole purpose of this class is to deliver an interface to the	1011	The sole purpose of this class is to deliver an interface to the
800	C<AnyEvent> module - any module using it will work inside urxvt without	1012	C<AnyEvent> module - any module using it will work inside urxvt without
801	further programming. The only exception is that you cannot wait on	1013	further programming. The only exception is that you cannot wait on
802	condition variables, but non-blocking condvar use is ok. What this means	1014	condition variables, but non-blocking condvar use is ok.
803	is that you cannot use blocking APIs, but the non-blocking variant should
804	work.
805		1015
806	=cut	1016	In practical terms this means is that you cannot use blocking APIs, but
		1017	the non-blocking variant should work.
807		1018
		1019	=cut
		1020
808	our $VERSION = 1;	1021	our $VERSION = '5.23';
809		1022
810	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1023	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
811	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1024	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
812		1025
813	sub timer {	1026	sub timer {
…		…
815		1028
816	my $cb = $arg{cb};	1029	my $cb = $arg{cb};
817		1030
818	urxvt::timer	1031	urxvt::timer
819	->new	1032	->new
820	->start (urxvt::NOW + $arg{after})	1033	->after ($arg{after}, $arg{interval})
821	->cb (sub {	1034	->cb ($arg{interval} ? $cb : sub {
822	$_[0]->stop; # need to cancel manually	1035	$_[0]->stop; # need to cancel manually
823	$cb->();	1036	$cb->();
824	})	1037	})
825	}	1038	}
826		1039
827	sub io {	1040	sub io {
828	my ($class, %arg) = @_;	1041	my ($class, %arg) = @_;
829		1042
830	my $cb = $arg{cb};	1043	my $cb = $arg{cb};
		1044	my $fd = fileno $arg{fh};
		1045	defined $fd or $fd = $arg{fh};
831		1046
832	bless [$arg{fh}, urxvt::iow	1047	bless [$arg{fh}, urxvt::iow
833	->new	1048	->new
834	->fd (fileno $arg{fh})	1049	->fd ($fd)
835	->events (($arg{poll} =~ /r/ ? 1 : 0)	1050	->events (($arg{poll} =~ /r/ ? 1 : 0)
836	| ($arg{poll} =~ /w/ ? 2 : 0))	1051	| ($arg{poll} =~ /w/ ? 2 : 0))
837	->start	1052	->start
838	->cb (sub {	1053	->cb ($cb)
839	$cb->(($_[1] & 1 ? 'r' : '')
840	. ($_[1] & 2 ? 'w' : ''));
841	})],
842	urxvt::anyevent::	1054	], urxvt::anyevent::
		1055	}
		1056
		1057	sub idle {
		1058	my ($class, %arg) = @_;
		1059
		1060	my $cb = $arg{cb};
		1061
		1062	urxvt::iw
		1063	->new
		1064	->start
		1065	->cb ($cb)
		1066	}
		1067
		1068	sub child {
		1069	my ($class, %arg) = @_;
		1070
		1071	my $cb = $arg{cb};
		1072
		1073	urxvt::pw
		1074	->new
		1075	->start ($arg{pid})
		1076	->cb (sub {
		1077	$_[0]->stop; # need to cancel manually
		1078	$cb->($_[0]->rpid, $_[0]->rstatus);
		1079	})
843	}	1080	}
844		1081
845	sub DESTROY {	1082	sub DESTROY {
846	$_[0][1]->stop;	1083	$_[0][1]->stop;
847	}	1084	}
848		1085
849	sub condvar {	1086	# only needed for AnyEvent < 6 compatibility
850	bless \my $flag, urxvt::anyevent::condvar::	1087	sub one_event {
851	}
852
853	sub urxvt::anyevent::condvar::broadcast {
854	${$_[0]}++;
855	}
856
857	sub urxvt::anyevent::condvar::wait {
858	unless (${$_[0]}) {
859	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1088	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
860	}
861	}	1089	}
862		1090
863	package urxvt::term;	1091	package urxvt::term;
864		1092
865	=head2 The C<urxvt::term> Class	1093	=head2 The C<urxvt::term> Class
…		…
871	# find on_xxx subs in the package and register them	1099	# find on_xxx subs in the package and register them
872	# as hooks	1100	# as hooks
873	sub register_package {	1101	sub register_package {
874	my ($self, $pkg, $argv) = @_;	1102	my ($self, $pkg, $argv) = @_;
875		1103
		1104	no strict 'refs';
		1105
		1106	urxvt::verbose 6, "register package $pkg to $self";
		1107
		1108	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1109
876	my $proxy = bless {	1110	my $proxy = bless {
877	_pkg => $pkg,	1111	_pkg => $pkg,
		1112	_name => ${"$pkg\::_NAME"}, # hackish
878	argv => $argv,	1113	argv => $argv,
879	}, $pkg;	1114	}, $pkg;
880	Scalar::Util::weaken ($proxy->{term} = $self);	1115	Scalar::Util::weaken ($proxy->{term} = $self);
881		1116
882	$self->{_pkg}{$pkg} = $proxy;	1117	$self->{_pkg}{$pkg} = $proxy;
883		1118
…		…
886	$proxy->enable ($name => $ref);	1121	$proxy->enable ($name => $ref);
887	}	1122	}
888	}	1123	}
889	}	1124	}
890		1125
		1126	sub perl_libdirs {
		1127	map { split /:/ }
		1128	$_[0]->resource ("perl_lib"),
		1129	$ENV{URXVT_PERL_LIB},
		1130	"$ENV{HOME}/.urxvt/ext",
		1131	"$LIBDIR/perl"
		1132	}
		1133
		1134	# scan for available extensions and collect their metadata
		1135	sub scan_extensions {
		1136	my ($self) = @_;
		1137
		1138	return if exists $self->{meta};
		1139
		1140	my @urxvtdirs = perl_libdirs $self;
		1141	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1142
		1143	$self->{meta} = \my %meta;
		1144
		1145	# first gather extensions
		1146
		1147	my $gather = sub {
		1148	my ($dir, $core) = @_;
		1149
		1150	opendir my $fh, $dir
		1151	or return;
		1152
		1153	for my $ext (readdir $fh) {
		1154	$ext !~ /^\./
		1155	or next;
		1156
		1157	open my $fh, "<", "$dir/$ext"
		1158	or next;
		1159
		1160	-f $fh
		1161	or next;
		1162
		1163	$ext =~ s/\.uext$// or $core
		1164	or next;
		1165
		1166	my %ext = (dir => $dir);
		1167
		1168	while (<$fh>) {
		1169	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1170	my ($pattern, $type, $desc) = split /:/, $1;
		1171	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1172	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1173	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1174	} else {
		1175	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1176	}
		1177	} elsif (/^\s*(?:#|$)/) {
		1178	# skip other comments and empty lines
		1179	} else {
		1180	last; # stop parsing on first non-empty non-comment line
		1181	}
		1182	}
		1183
		1184	$meta{ext}{$ext} = \%ext;
		1185	}
		1186	};
		1187
		1188	# $gather->($_, 0) for @cpandirs;
		1189	$gather->($_, 1) for @urxvtdirs;
		1190
		1191	# and now merge resources
		1192
		1193	$meta{resource} = \my %resource;
		1194
		1195	while (my ($k, $v) = each %{ $meta{ext} }) {
		1196	#TODO: should check for extensions overriding each other
		1197	%resource = (%resource, %{ $v->{resource} });
		1198	}
		1199	}
		1200
891	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1201	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
892		1202
893	Creates a new terminal, very similar as if you had started it with system	1203	Creates a new terminal, very similar as if you had started it with system
894	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1204	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
895	hash which defines the environment of the new terminal.	1205	hash which defines the environment of the new terminal.
896		1206
897	Croaks (and probably outputs an error message) if the new instance	1207	Croaks (and probably outputs an error message) if the new instance
898	couldn't be created. Returns C<undef> if the new instance didn't	1208	couldn't be created. Returns C<undef> if the new instance didn't
899	initialise perl, and the terminal object otherwise. The C<init> and	1209	initialise perl, and the terminal object otherwise. The C<init> and
900	C<start> hooks will be called during this call.	1210	C<start> hooks will be called before this call returns, and are free to
		1211	refer to global data (which is race free).
901		1212
902	=cut	1213	=cut
903		1214
904	sub new {	1215	sub new {
905	my ($class, $env, @args) = @_;	1216	my ($class, $env, @args) = @_;
906		1217
		1218	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1219	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1220
907	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1221	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
908	}	1222	}
909		1223
910	=item $term->destroy	1224	=item $term->destroy
911		1225
912	Destroy the terminal object (close the window, free resources	1226	Destroy the terminal object (close the window, free resources
913	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1227	etc.). Please note that urxvt will not exit as long as any event
914	watchers (timers, io watchers) are still active.	1228	watchers (timers, io watchers) are still active.
		1229
		1230	=item $term->exec_async ($cmd[, @args])
		1231
		1232	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1233	("starts") programs in the background. This function takes care of setting
		1234	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1235	be preferred over explicit calls to C<exec> or C<system>.
		1236
		1237	Returns the pid of the subprocess or C<undef> on error.
		1238
		1239	=cut
		1240
		1241	sub exec_async {
		1242	my $self = shift;
		1243
		1244	my $pid = fork;
		1245
		1246	return $pid
		1247	if !defined $pid or $pid;
		1248
		1249	%ENV = %{ $self->env };
		1250
		1251	exec @_;
		1252	urxvt::_exit 255;
		1253	}
915		1254
916	=item $isset = $term->option ($optval[, $set])	1255	=item $isset = $term->option ($optval[, $set])
917		1256
918	Returns true if the option specified by C<$optval> is enabled, and	1257	Returns true if the option specified by C<$optval> is enabled, and
919	optionally change it. All option values are stored by name in the hash	1258	optionally change it. All option values are stored by name in the hash
920	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1259	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
921		1260
922	Here is a a likely non-exhaustive list of option names, please see the	1261	Here is a likely non-exhaustive list of option names, please see the
923	source file F</src/optinc.h> to see the actual list:	1262	source file F</src/optinc.h> to see the actual list:
924		1263
925	borderLess console cursorBlink cursorUnderline hold iconic insecure	1264	borderLess buffered console cursorBlink cursorUnderline hold iconic
926	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1265	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1266	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
927	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1267	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
928	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1268	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
929	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1269	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
930	tripleclickwords utmpInhibit visualBell	1270	urgentOnBell utmpInhibit visualBell
931		1271
932	=item $value = $term->resource ($name[, $newval])	1272	=item $value = $term->resource ($name[, $newval])
933		1273
934	Returns the current resource value associated with a given name and	1274	Returns the current resource value associated with a given name and
935	optionally sets a new value. Setting values is most useful in the C<init>	1275	optionally sets a new value. Setting values is most useful in the C<init>
…		…
944	likely change).	1284	likely change).
945		1285
946	Please note that resource strings will currently only be freed when the	1286	Please note that resource strings will currently only be freed when the
947	terminal is destroyed, so changing options frequently will eat memory.	1287	terminal is destroyed, so changing options frequently will eat memory.
948		1288
949	Here is a a likely non-exhaustive list of resource names, not all of which	1289	Here is a likely non-exhaustive list of resource names, not all of which
950	are supported in every build, please see the source file F</src/rsinc.h>	1290	are supported in every build, please see the source file F</src/rsinc.h>
951	to see the actual list:	1291	to see the actual list:
952		1292
953	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1293	answerbackstring backgroundPixmap backspace_key blurradius
954	borderLess color cursorBlink cursorUnderline cutchars delete_key	1294	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
955	display_name embed ext_bwidth fade font geometry hold iconName	1295	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
956	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1296	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1297	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
957	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1298	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
958	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1299	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
959	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1300	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
960	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1301	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
961	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1302	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
962	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1303	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
963	shade term_name title transparent transparent_all tripleclickwords	1304	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1305	term_name title transient_for transparent tripleclickwords urgentOnBell
964	utmpInhibit visualBell	1306	utmpInhibit visualBell
965		1307
966	=cut	1308	=cut
967		1309
968	sub resource($$;$) {	1310	sub resource($$;$) {
969	my ($self, $name) = (shift, shift);	1311	my ($self, $name) = (shift, shift);
970	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1312	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
971	&urxvt::term::_resource	1313	goto &urxvt::term::_resource
972	}	1314	}
973		1315
974	=item $value = $term->x_resource ($pattern)	1316	=item $value = $term->x_resource ($pattern)
975		1317
976	Returns the X-Resource for the given pattern, excluding the program or	1318	Returns the X-Resource for the given pattern, excluding the program or
977	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1319	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
978	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1320	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
979	resource with that pattern exists.	1321	resource with that pattern exists.
980		1322
		1323	Extensions that define extra resources also need to call this method
		1324	to access their values.
		1325
		1326	If the method is called on an extension object (basically, from an
		1327	extension), then the special prefix C<%.> will be replaced by the name of
		1328	the extension and a dot, and the lone string C<%> will be replaced by the
		1329	extension name itself. This makes it possible to code extensions so you
		1330	can rename them and get a new set of resources without having to change
		1331	the actual code.
		1332
981	This method should only be called during the C<on_start> hook, as there is	1333	This method should only be called during the C<on_start> hook, as there is
982	only one resource database per display, and later invocations might return	1334	only one resource database per display, and later invocations might return
983	the wrong resources.	1335	the wrong resources.
984		1336
985	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1337	=item $value = $term->x_resource_boolean ($pattern)
986		1338
		1339	Like C<x_resource>, above, but interprets the string value as a boolean
		1340	and returns C<1> for true values, C<0> for false values and C<undef> if
		1341	the resource or option isn't specified.
		1342
		1343	You should always use this method to parse boolean resources.
		1344
		1345	=cut
		1346
		1347	sub x_resource_boolean {
		1348	my $res = &x_resource;
		1349
		1350	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1351	}
		1352
		1353	=item $action = $term->lookup_keysym ($keysym, $state)
		1354
		1355	Returns the action bound to key combination C<($keysym, $state)>,
		1356	if a binding for it exists, and C<undef> otherwise.
		1357
		1358	=item $success = $term->bind_action ($key, $action)
		1359
987	Adds a keymap translation exactly as specified via a resource. See the	1360	Adds a key binding exactly as specified via a C<keysym> resource. See the
988	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1361	C<keysym> resource in the urxvt(1) manpage.
		1362
		1363	To add default bindings for actions, an extension should call C<<
		1364	->bind_action >> in its C<init> hook for every such binding. Doing it
		1365	in the C<init> hook allows users to override or remove the binding
		1366	again.
		1367
		1368	Example: the C<searchable-scrollback> by default binds itself
		1369	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1370	$term->bind_action >>.
		1371
		1372	sub init {
		1373	my ($self) = @_;
		1374
		1375	$self->bind_action ("M-s" => "%:start");
		1376	}
989		1377
990	=item $rend = $term->rstyle ([$new_rstyle])	1378	=item $rend = $term->rstyle ([$new_rstyle])
991		1379
992	Return and optionally change the current rendition. Text that is output by	1380	Return and optionally change the current rendition. Text that is output by
993	the terminal application will use this style.	1381	the terminal application will use this style.
…		…
1001		1389
1002	=item ($row, $col) = $term->selection_beg ([$row, $col])	1390	=item ($row, $col) = $term->selection_beg ([$row, $col])
1003		1391
1004	=item ($row, $col) = $term->selection_end ([$row, $col])	1392	=item ($row, $col) = $term->selection_end ([$row, $col])
1005		1393
1006	Return the current values of the selection mark, begin or end positions,	1394	Return the current values of the selection mark, begin or end positions.
1007	and optionally set them to new values.	1395
		1396	When arguments are given, then the selection coordinates are set to
		1397	C<$row> and C<$col>, and the selection screen is set to the current
		1398	screen.
		1399
		1400	=item $screen = $term->selection_screen ([$screen])
		1401
		1402	Returns the current selection screen, and then optionally sets it.
1008		1403
1009	=item $term->selection_make ($eventtime[, $rectangular])	1404	=item $term->selection_make ($eventtime[, $rectangular])
1010		1405
1011	Tries to make a selection as set by C<selection_beg> and	1406	Tries to make a selection as set by C<selection_beg> and
1012	C<selection_end>. If C<$rectangular> is true (default: false), a	1407	C<selection_end>. If C<$rectangular> is true (default: false), a
1013	rectangular selection will be made. This is the prefered function to make	1408	rectangular selection will be made. This is the preferred function to make
1014	a selection.	1409	a selection.
1015		1410
1016	=item $success = $term->selection_grab ($eventtime)	1411	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1017		1412
1018	Try to request the primary selection text from the server (for example, as	1413	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1414	true) selection from the server. The corresponding text can be set
1019	set by the next method). No visual feedback will be given. This function	1415	with the next method. No visual feedback will be given. This function
1020	is mostly useful from within C<on_sel_grab> hooks.	1416	is mostly useful from within C<on_sel_grab> hooks.
1021		1417
1022	=item $oldtext = $term->selection ([$newtext])	1418	=item $oldtext = $term->selection ([$newtext, $clipboard])
1023		1419
1024	Return the current selection text and optionally replace it by C<$newtext>.	1420	Return the current selection (clipboard if C<$clipboard> is true) text
		1421	and optionally replace it by C<$newtext>.
		1422
		1423	=item $term->selection_clear ([$clipboard])
		1424
		1425	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1025		1426
1026	=item $term->overlay_simple ($x, $y, $text)	1427	=item $term->overlay_simple ($x, $y, $text)
1027		1428
1028	Create a simple multi-line overlay box. See the next method for details.	1429	Create a simple multi-line overlay box. See the next method for details.
1029		1430
…		…
1059		1460
1060	The methods currently supported on C<urxvt::overlay> objects are:	1461	The methods currently supported on C<urxvt::overlay> objects are:
1061		1462
1062	=over 4	1463	=over 4
1063		1464
1064	=item $overlay->set ($x, $y, $text, $rend)	1465	=item $overlay->set ($x, $y, $text[, $rend])
1065		1466
1066	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1467	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1067	text in rxvt-unicode's special encoding and an array of rendition values	1468	text in rxvt-unicode's special encoding and an array of rendition values
1068	at a specific position inside the overlay.	1469	at a specific position inside the overlay.
		1470
		1471	If C<$rend> is missing, then the rendition will not be changed.
1069		1472
1070	=item $overlay->hide	1473	=item $overlay->hide
1071		1474
1072	If visible, hide the overlay, but do not destroy it.	1475	If visible, hide the overlay, but do not destroy it.
1073		1476
…		…
1136		1539
1137	=item $term->scr_add_lines ($string)	1540	=item $term->scr_add_lines ($string)
1138		1541
1139	Write the given text string to the screen, as if output by the application	1542	Write the given text string to the screen, as if output by the application
1140	running inside the terminal. It may not contain command sequences (escape	1543	running inside the terminal. It may not contain command sequences (escape
1141	codes), but is free to use line feeds, carriage returns and tabs. The	1544	codes - see C<cmd_parse> for that), but is free to use line feeds,
1142	string is a normal text string, not in locale-dependent encoding.	1545	carriage returns and tabs. The string is a normal text string, not in
		1546	locale-dependent encoding.
1143		1547
1144	Normally its not a good idea to use this function, as programs might be	1548	Normally its not a good idea to use this function, as programs might be
1145	confused by changes in cursor position or scrolling. Its useful inside a	1549	confused by changes in cursor position or scrolling. Its useful inside a
1146	C<on_add_lines> hook, though.	1550	C<on_add_lines> hook, though.
1147		1551
		1552	=item $term->scr_change_screen ($screen)
		1553
		1554	Switch to given screen - 0 primary, 1 secondary.
		1555
1148	=item $term->cmd_parse ($octets)	1556	=item $term->cmd_parse ($octets)
1149		1557
1150	Similar to C<scr_add_lines>, but the argument must be in the	1558	Similar to C<scr_add_lines>, but the argument must be in the
1151	locale-specific encoding of the terminal and can contain command sequences	1559	locale-specific encoding of the terminal and can contain command sequences
1152	(escape codes) that will be interpreted.	1560	(escape codes) that will be interpreted.
1153		1561
1154	=item $term->tt_write ($octets)	1562	=item $term->tt_write ($octets)
1155		1563
1156	Write the octets given in C<$data> to the tty (i.e. as program input). To	1564	Write the octets given in C<$octets> to the tty (i.e. as user input
		1565	to the program, see C<cmd_parse> for the opposite direction). To pass
1157	pass characters instead of octets, you should convert your strings first	1566	characters instead of octets, you should convert your strings first to the
1158	to the locale-specific encoding using C<< $term->locale_encode >>.	1567	locale-specific encoding using C<< $term->locale_encode >>.
		1568
		1569	=item $term->tt_write_user_input ($octets)
		1570
		1571	Like C<tt_write>, but should be used when writing strings in response to
		1572	the user pressing a key, to invoke the additional actions requested by
		1573	the user for that case (C<tt_write> doesn't do that).
		1574
		1575	The typical use case would be inside C<on_action> hooks.
		1576
		1577	=item $term->tt_paste ($octets)
		1578
		1579	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1580	CR and bracketing the data with control sequences if bracketed paste mode
		1581	is set.
1159		1582
1160	=item $old_events = $term->pty_ev_events ([$new_events])	1583	=item $old_events = $term->pty_ev_events ([$new_events])
1161		1584
1162	Replaces the event mask of the pty watcher by the given event mask. Can	1585	Replaces the event mask of the pty watcher by the given event mask. Can
1163	be used to suppress input and output handling to the pty/tty. See the	1586	be used to suppress input and output handling to the pty/tty. See the
1164	description of C<< urxvt::timer->events >>. Make sure to always restore	1587	description of C<< urxvt::timer->events >>. Make sure to always restore
1165	the previous value.	1588	the previous value.
1166		1589
		1590	=item $fd = $term->pty_fd
		1591
		1592	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1593	is used.
		1594
1167	=item $windowid = $term->parent	1595	=item $windowid = $term->parent
1168		1596
1169	Return the window id of the toplevel window.	1597	Return the window id of the toplevel window.
1170		1598
1171	=item $windowid = $term->vt	1599	=item $windowid = $term->vt
…		…
1177	Adds the specified events to the vt event mask. Useful e.g. when you want	1605	Adds the specified events to the vt event mask. Useful e.g. when you want
1178	to receive pointer events all the times:	1606	to receive pointer events all the times:
1179		1607
1180	$term->vt_emask_add (urxvt::PointerMotionMask);	1608	$term->vt_emask_add (urxvt::PointerMotionMask);
1181		1609
		1610	=item $term->set_urgency ($set)
		1611
		1612	Enable/disable the urgency hint on the toplevel window.
		1613
		1614	=item $term->focus_in
		1615
		1616	=item $term->focus_out
		1617
		1618	=item $term->key_press ($state, $keycode[, $time])
		1619
		1620	=item $term->key_release ($state, $keycode[, $time])
		1621
		1622	Deliver various fake events to to terminal.
		1623
1182	=item $window_width = $term->width	1624	=item $window_width = $term->width ([$new_value])
1183		1625
1184	=item $window_height = $term->height	1626	=item $window_height = $term->height ([$new_value])
1185		1627
1186	=item $font_width = $term->fwidth	1628	=item $font_width = $term->fwidth ([$new_value])
1187		1629
1188	=item $font_height = $term->fheight	1630	=item $font_height = $term->fheight ([$new_value])
1189		1631
1190	=item $font_ascent = $term->fbase	1632	=item $font_ascent = $term->fbase ([$new_value])
1191		1633
1192	=item $terminal_rows = $term->nrow	1634	=item $terminal_rows = $term->nrow ([$new_value])
1193		1635
1194	=item $terminal_columns = $term->ncol	1636	=item $terminal_columns = $term->ncol ([$new_value])
1195		1637
1196	=item $has_focus = $term->focus	1638	=item $has_focus = $term->focus ([$new_value])
1197		1639
1198	=item $is_mapped = $term->mapped	1640	=item $is_mapped = $term->mapped ([$new_value])
1199		1641
1200	=item $max_scrollback = $term->saveLines	1642	=item $max_scrollback = $term->saveLines ([$new_value])
1201		1643
1202	=item $nrow_plus_saveLines = $term->total_rows	1644	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1203		1645
1204	=item $topmost_scrollback_row = $term->top_row	1646	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1205		1647
1206	Return various integers describing terminal characteristics.	1648	Return various integers describing terminal characteristics. If an
		1649	argument is given, changes the value and returns the previous one.
1207		1650
1208	=item $x_display = $term->display_id	1651	=item $x_display = $term->display_id
1209		1652
1210	Return the DISPLAY used by rxvt-unicode.	1653	Return the DISPLAY used by rxvt-unicode.
1211		1654
…		…
1216	=item $env = $term->env	1659	=item $env = $term->env
1217		1660
1218	Returns a copy of the environment in effect for the terminal as a hashref	1661	Returns a copy of the environment in effect for the terminal as a hashref
1219	similar to C<\%ENV>.	1662	similar to C<\%ENV>.
1220		1663
		1664	=item @envv = $term->envv
		1665
		1666	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1667
		1668	=item @argv = $term->argv
		1669
		1670	Return the argument vector as this terminal, similar to @ARGV, but
		1671	includes the program name as first element.
		1672
1221	=cut	1673	=cut
1222		1674
1223	sub env {	1675	sub env {
1224	if (my $env = $_[0]->_env) {
1225	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1676	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1226	} else {
1227	+{ %ENV }
1228	}
1229	}	1677	}
1230		1678
1231	=item $modifiermask = $term->ModLevel3Mask	1679	=item $modifiermask = $term->ModLevel3Mask
1232		1680
1233	=item $modifiermask = $term->ModMetaMask	1681	=item $modifiermask = $term->ModMetaMask
1234		1682
1235	=item $modifiermask = $term->ModNumLockMask	1683	=item $modifiermask = $term->ModNumLockMask
1236		1684
1237	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1685	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1238	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1686	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1687
		1688	=item $screen = $term->current_screen
		1689
		1690	Returns the currently displayed screen (0 primary, 1 secondary).
		1691
		1692	=item $cursor_is_hidden = $term->hidden_cursor
		1693
		1694	Returns whether the cursor is currently hidden or not.
1239		1695
1240	=item $view_start = $term->view_start ([$newvalue])	1696	=item $view_start = $term->view_start ([$newvalue])
1241		1697
1242	Returns the row number of the topmost displayed line. Maximum value is	1698	Returns the row number of the topmost displayed line. Maximum value is
1243	C<0>, which displays the normal terminal contents. Lower values scroll	1699	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1249	compare the on-screen display with its stored representation. If they	1705	compare the on-screen display with its stored representation. If they
1250	differ, it redraws the differences.	1706	differ, it redraws the differences.
1251		1707
1252	Used after changing terminal contents to display them.	1708	Used after changing terminal contents to display them.
1253		1709
		1710	=item $term->refresh_check
		1711
		1712	Checks if a refresh has been requested and, if so, schedules one.
		1713
1254	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1714	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1255		1715
1256	Returns the text of the entire row with number C<$row_number>. Row C<0>	1716	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1257	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1717	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1258	terminal line. The scrollback buffer starts at line C<-1> and extends to
1259	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1718	terminal line. Nothing will be returned if a nonexistent line
1260	is requested.	1719	is requested.
1261		1720
1262	If C<$new_text> is specified, it will replace characters in the current	1721	If C<$new_text> is specified, it will replace characters in the current
1263	line, starting at column C<$start_col> (default C<0>), which is useful	1722	line, starting at column C<$start_col> (default C<0>), which is useful
1264	to replace only parts of a line. The font index in the rendition will	1723	to replace only parts of a line. The font index in the rendition will
1265	automatically be updated.	1724	automatically be updated.
1266		1725
1267	C<$text> is in a special encoding: tabs and wide characters that use more	1726	C<$text> is in a special encoding: tabs and wide characters that use more
1268	than one cell when displayed are padded with urxvt::NOCHAR characters	1727	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1269	(C<chr 65535>). Characters with combining characters and other characters	1728	characters. Characters with combining characters and other characters that
1270	that do not fit into the normal tetx encoding will be replaced with	1729	do not fit into the normal text encoding will be replaced with characters
1271	characters in the private use area.	1730	in the private use area.
1272		1731
1273	You have to obey this encoding when changing text. The advantage is	1732	You have to obey this encoding when changing text. The advantage is
1274	that C<substr> and similar functions work on screen cells and not on	1733	that C<substr> and similar functions work on screen cells and not on
1275	characters.	1734	characters.
1276		1735
…		…
1360	}	1819	}
1361		1820
1362	sub urxvt::line::t {	1821	sub urxvt::line::t {
1363	my ($self) = @_;	1822	my ($self) = @_;
1364		1823
1365	if (@_ > 1)	1824	if (@_ > 1) {
1366	{
1367	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1825	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1368	for $self->{beg} .. $self->{end};	1826	for $self->{beg} .. $self->{end};
1369	}	1827	}
1370		1828
1371	defined wantarray &&	1829	defined wantarray &&
1372	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1830	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1373	0, $self->{len}	1831	0, $self->{len}
1374	}	1832	}
1375		1833
1376	sub urxvt::line::r {	1834	sub urxvt::line::r {
1377	my ($self) = @_;	1835	my ($self) = @_;
1378		1836
1379	if (@_ > 1)	1837	if (@_ > 1) {
1380	{
1381	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1838	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1382	for $self->{beg} .. $self->{end};	1839	for $self->{beg} .. $self->{end};
1383	}	1840	}
1384		1841
1385	if (defined wantarray) {	1842	if (defined wantarray) {
1386	my $rend = [	1843	my $rend = [
1387	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1844	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1388	];	1845	];
…		…
1420	where one character corresponds to one screen cell. See	1877	where one character corresponds to one screen cell. See
1421	C<< $term->ROW_t >> for details.	1878	C<< $term->ROW_t >> for details.
1422		1879
1423	=item $string = $term->special_decode $text	1880	=item $string = $term->special_decode $text
1424		1881
1425	Converts rxvt-unicodes text reprsentation into a perl string. See	1882	Converts rxvt-unicodes text representation into a perl string. See
1426	C<< $term->ROW_t >> for details.	1883	C<< $term->ROW_t >> for details.
1427		1884
1428	=item $success = $term->grab_button ($button, $modifiermask)	1885	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1429		1886
		1887	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1888
1430	Registers a synchronous button grab. See the XGrabButton manpage.	1889	Register/unregister a synchronous button grab. See the XGrabButton
		1890	manpage.
1431		1891
1432	=item $success = $term->grab ($eventtime[, $sync])	1892	=item $success = $term->grab ($eventtime[, $sync])
1433		1893
1434	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1894	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1435	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1895	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1436		1896
1437	=item $term->allow_events_async	1897	=item $term->allow_events_async
1438		1898
1439	Calls XAllowEvents with AsyncBoth for the most recent grab.	1899	Calls XAllowEvents with AsyncBoth for the most recent grab.
1440		1900
…		…
1447	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1907	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1448	recent grab.	1908	recent grab.
1449		1909
1450	=item $term->ungrab	1910	=item $term->ungrab
1451		1911
1452	Calls XUngrab for the most recent grab. Is called automatically on	1912	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1453	evaluation errors, as it is better to lose the grab in the error case as	1913	evaluation errors, as it is better to lose the grab in the error case as
1454	the session.	1914	the session.
		1915
		1916	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1917
		1918	=item $atom_name = $term->XGetAtomName ($atom)
		1919
		1920	=item @atoms = $term->XListProperties ($window)
		1921
		1922	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1923
		1924	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1925
		1926	=item $term->XDeleteProperty ($window, $property)
		1927
		1928	=item $window = $term->DefaultRootWindow
		1929
		1930	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1931
		1932	=item $term->XMapWindow ($window)
		1933
		1934	=item $term->XUnmapWindow ($window)
		1935
		1936	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1937
		1938	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1939
		1940	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1941
		1942	=item $keysym = $term->XStringToKeysym ($string)
		1943
		1944	=item $string = $term->XKeysymToString ($keysym)
		1945
		1946	Various X or X-related functions. The C<$term> object only serves as
		1947	the source of the display, otherwise those functions map more-or-less
		1948	directly onto the X functions of the same name.
1455		1949
1456	=back	1950	=back
1457		1951
1458	=cut	1952	=cut
1459		1953
…		…
1523	my ($self, $text, $cb) = @_;	2017	my ($self, $text, $cb) = @_;
1524		2018
1525	$self->add_item ({ type => "button", text => $text, activate => $cb});	2019	$self->add_item ({ type => "button", text => $text, activate => $cb});
1526	}	2020	}
1527		2021
1528	=item $popup->add_toggle ($text, $cb, $initial_value)	2022	=item $popup->add_toggle ($text, $initial_value, $cb)
1529		2023
1530	Adds a toggle/checkbox item to the popup. Teh callback gets called	2024	Adds a toggle/checkbox item to the popup. The callback gets called
1531	whenever it gets toggled, with a boolean indicating its value as its first	2025	whenever it gets toggled, with a boolean indicating its new value as its
1532	argument.	2026	first argument.
1533		2027
1534	=cut	2028	=cut
1535		2029
1536	sub add_toggle {	2030	sub add_toggle {
1537	my ($self, $text, $cb, $value) = @_;	2031	my ($self, $text, $value, $cb) = @_;
1538		2032
1539	my $item; $item = {	2033	my $item; $item = {
1540	type => "button",	2034	type => "button",
1541	text => " $text",	2035	text => " $text",
1542	value => $value,	2036	value => $value,
…		…
1561	my $env = $self->{term}->env;	2055	my $env = $self->{term}->env;
1562	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2056	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1563	delete $env->{LC_ALL};	2057	delete $env->{LC_ALL};
1564	$env->{LC_CTYPE} = $self->{term}->locale;	2058	$env->{LC_CTYPE} = $self->{term}->locale;
1565		2059
1566	urxvt::term->new ($env, $self->{term}->resource ("name"),	2060	my $term = urxvt::term->new (
1567	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2061	$env, "popup",
		2062	"--perl-lib" => "", "--perl-ext-common" => "",
		2063	"-pty-fd" => -1, "-sl" => 0,
		2064	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1568	"--transient-for" => $self->{term}->parent,	2065	"--transient-for" => $self->{term}->parent,
1569	"-display" => $self->{term}->display_id,	2066	"-display" => $self->{term}->display_id,
1570	"-pe" => "urxvt-popup")	2067	"-pe" => "urxvt-popup",
1571	or die "unable to create popup window\n";	2068	) or die "unable to create popup window\n";
		2069
		2070	unless (delete $term->{urxvt_popup_init_done}) {
		2071	$term->ungrab;
		2072	$term->destroy;
		2073	die "unable to initialise popup window\n";
		2074	}
1572	}	2075	}
1573		2076
1574	sub DESTROY {	2077	sub DESTROY {
1575	my ($self) = @_;	2078	my ($self) = @_;
1576		2079
1577	delete $self->{term}{_destroy}{$self};	2080	delete $self->{term}{_destroy}{$self};
1578	$self->{term}->ungrab;	2081	$self->{term}->ungrab;
1579	}	2082	}
1580		2083
1581	=back	2084	=back
		2085
		2086	=cut
		2087
		2088	package urxvt::watcher;
1582		2089
1583	=head2 The C<urxvt::timer> Class	2090	=head2 The C<urxvt::timer> Class
1584		2091
1585	This class implements timer watchers/events. Time is represented as a	2092	This class implements timer watchers/events. Time is represented as a
1586	fractional number of seconds since the epoch. Example:	2093	fractional number of seconds since the epoch. Example:
…		…
1590	->new	2097	->new
1591	->interval (1)	2098	->interval (1)
1592	->cb (sub {	2099	->cb (sub {
1593	$term->{overlay}->set (0, 0,	2100	$term->{overlay}->set (0, 0,
1594	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2101	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1595	});	2102	});
1596		2103
1597	=over 4	2104	=over 4
1598		2105
1599	=item $timer = new urxvt::timer	2106	=item $timer = new urxvt::timer
1600		2107
…		…
1603		2110
1604	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2111	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1605		2112
1606	Set the callback to be called when the timer triggers.	2113	Set the callback to be called when the timer triggers.
1607		2114
1608	=item $tstamp = $timer->at
1609
1610	Return the time this watcher will fire next.
1611
1612	=item $timer = $timer->set ($tstamp)	2115	=item $timer = $timer->set ($tstamp[, $interval])
1613		2116
1614	Set the time the event is generated to $tstamp.	2117	Set the time the event is generated to $tstamp (and optionally specifies a
		2118	new $interval).
1615		2119
1616	=item $timer = $timer->interval ($interval)	2120	=item $timer = $timer->interval ($interval)
1617		2121
1618	Normally (and when C<$interval> is C<0>), the timer will automatically	2122	By default (and when C<$interval> is C<0>), the timer will automatically
1619	stop after it has fired once. If C<$interval> is non-zero, then the timer	2123	stop after it has fired once. If C<$interval> is non-zero, then the timer
1620	is automatically rescheduled at the given intervals.	2124	is automatically rescheduled at the given intervals.
1621		2125
1622	=item $timer = $timer->start	2126	=item $timer = $timer->start
1623		2127
1624	Start the timer.	2128	Start the timer.
1625		2129
1626	=item $timer = $timer->start ($tstamp)	2130	=item $timer = $timer->start ($tstamp[, $interval])
1627		2131
1628	Set the event trigger time to C<$tstamp> and start the timer.	2132	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2133	also replaces the interval.
		2134
		2135	=item $timer = $timer->after ($delay[, $interval])
		2136
		2137	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1629		2138
1630	=item $timer = $timer->stop	2139	=item $timer = $timer->stop
1631		2140
1632	Stop the timer.	2141	Stop the timer.
1633		2142
…		…
1639		2148
1640	$term->{socket} = ...	2149	$term->{socket} = ...
1641	$term->{iow} = urxvt::iow	2150	$term->{iow} = urxvt::iow
1642	->new	2151	->new
1643	->fd (fileno $term->{socket})	2152	->fd (fileno $term->{socket})
1644	->events (urxvt::EVENT_READ)	2153	->events (urxvt::EV_READ)
1645	->start	2154	->start
1646	->cb (sub {	2155	->cb (sub {
1647	my ($iow, $revents) = @_;	2156	my ($iow, $revents) = @_;
1648	# $revents must be 1 here, no need to check	2157	# $revents must be 1 here, no need to check
1649	sysread $term->{socket}, my $buf, 8192	2158	sysread $term->{socket}, my $buf, 8192
…		…
1662	Set the callback to be called when io events are triggered. C<$reventmask>	2171	Set the callback to be called when io events are triggered. C<$reventmask>
1663	is a bitset as described in the C<events> method.	2172	is a bitset as described in the C<events> method.
1664		2173
1665	=item $iow = $iow->fd ($fd)	2174	=item $iow = $iow->fd ($fd)
1666		2175
1667	Set the filedescriptor (not handle) to watch.	2176	Set the file descriptor (not handle) to watch.
1668		2177
1669	=item $iow = $iow->events ($eventmask)	2178	=item $iow = $iow->events ($eventmask)
1670		2179
1671	Set the event mask to watch. The only allowed values are	2180	Set the event mask to watch. The only allowed values are
1672	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2181	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1673	together, or C<urxvt::EVENT_NONE>.	2182	together, or C<urxvt::EV_NONE>.
1674		2183
1675	=item $iow = $iow->start	2184	=item $iow = $iow->start
1676		2185
1677	Start watching for requested events on the given handle.	2186	Start watching for requested events on the given handle.
1678		2187
1679	=item $iow = $iow->stop	2188	=item $iow = $iow->stop
1680		2189
1681	Stop watching for events on the given filehandle.	2190	Stop watching for events on the given file handle.
		2191
		2192	=back
		2193
		2194	=head2 The C<urxvt::iw> Class
		2195
		2196	This class implements idle watchers, that get called automatically when
		2197	the process is idle. They should return as fast as possible, after doing
		2198	some useful work.
		2199
		2200	=over 4
		2201
		2202	=item $iw = new urxvt::iw
		2203
		2204	Create a new idle watcher object in stopped state.
		2205
		2206	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2207
		2208	Set the callback to be called when the watcher triggers.
		2209
		2210	=item $timer = $timer->start
		2211
		2212	Start the watcher.
		2213
		2214	=item $timer = $timer->stop
		2215
		2216	Stop the watcher.
		2217
		2218	=back
		2219
		2220	=head2 The C<urxvt::pw> Class
		2221
		2222	This class implements process watchers. They create an event whenever a
		2223	process exits, after which they stop automatically.
		2224
		2225	my $pid = fork;
		2226	...
		2227	$term->{pw} = urxvt::pw
		2228	->new
		2229	->start ($pid)
		2230	->cb (sub {
		2231	my ($pw, $exit_status) = @_;
		2232	...
		2233	});
		2234
		2235	=over 4
		2236
		2237	=item $pw = new urxvt::pw
		2238
		2239	Create a new process watcher in stopped state.
		2240
		2241	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2242
		2243	Set the callback to be called when the timer triggers.
		2244
		2245	=item $pw = $timer->start ($pid)
		2246
		2247	Tells the watcher to start watching for process C<$pid>.
		2248
		2249	=item $pw = $pw->stop
		2250
		2251	Stop the watcher.
1682		2252
1683	=back	2253	=back
1684		2254
1685	=head1 ENVIRONMENT	2255	=head1 ENVIRONMENT
1686		2256
…		…
1695		2265
1696	=item >= 3 - script loading and management	2266	=item >= 3 - script loading and management
1697		2267
1698	=item >=10 - all called hooks	2268	=item >=10 - all called hooks
1699		2269
1700	=item >=11 - hook reutrn values	2270	=item >=11 - hook return values
1701		2271
1702	=back	2272	=back
1703		2273
1704	=head1 AUTHOR	2274	=head1 AUTHOR
1705		2275
1706	Marc Lehmann <pcg@goof.com>	2276	Marc Lehmann <schmorp@schmorp.de>
1707	http://software.schmorp.de/pkg/rxvt-unicode	2277	http://software.schmorp.de/pkg/rxvt-unicode
1708		2278
1709	=cut	2279	=cut
1710		2280
1711	1	2281	1
		2282
		2283	# vim: sw=3:

Diff Legend

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