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

Diff Legend

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