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.127 by root, Wed Jan 25 00:42:21 2006 UTC vs.
Revision 1.257 by root, Thu Jul 13 10:31:27 2017 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions may add additional resources and C<actions>, i.e., methods
45		49	which can be bound to a key and invoked by the user. An extension can
46	=item selection (enabled by default)	50	define the resources it support using so called META comments,
47		51	described below. Similarly to builtin resources, extension resources
48	(More) intelligent selection. This extension tries to be more intelligent	52	can also be specified on the command line as long options (with C<.>
49	when the user extends selections (double-click and further clicks). Right	53	replaced by C<->), in which case the corresponding extension is loaded
50	now, it tries to select words, urls and complete shell-quoted	54	automatically. For this to work the extension B<must> define META
51	arguments, which is very convenient, too, if your F<ls> supports	55	comments for its resources.
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	Another example: Programs I use often output "absolute path: " at the
73	beginning of a line when they process multiple files. The following
74	pattern matches the filename (note, there is a single space at the very
75	end):
76
77	URxvt.selection.pattern-0: ^(/[^:]+):\
78
79	You can look at the source of the selection extension to see more
80	interesting uses, such as parsing a line from beginning to end.
81
82	This extension also offers following bindable keyboard commands:
83
84	=over 4
85
86	=item rot13
87
88	Rot-13 the selection when activated. Used via keyboard trigger:
89
90	URxvt.keysym.C-M-r: perl:selection:rot13
91
92	=back
93
94	=item option-popup (enabled by default)
95
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.
98
99	=item selection-popup (enabled by default)
100
101	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
102	text into various other formats/action (such as uri unescaping, perl
103	evaluation, web-browser starting etc.), depending on content.
104
105	Other extensions can extend this popup menu by pushing a code reference
106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
107	popup is displayed.
108
109	It's sole argument is the popup menu, which can be modified. The selection
110	is in C<$_>, which can be used to decide wether to add something or not.
111	It should either return nothing or a string and a code reference. The
112	string will be used as button text and the code reference will be called
113	when the button gets activated and should transform C<$_>.
114
115	The following will add an entry C<a to b> that transforms all C<a>s in
116	the selection to C<b>s, but only if the selection currently contains any
117	C<a>s:
118
119	push @{ $self->{term}{selection_popup_hook} }, sub {
120	/a/ ? ("a to be" => sub { s/a/b/g }
121	: ()
122	};
123
124	=item searchable-scrollback<hotkey> (enabled by default)
125
126	Adds regex search functionality to the scrollback buffer, triggered
127	by a hotkey (default: C<M-s>). While in search mode, normal terminal
128	input/output is suspended and a regex is displayed at the bottom of the
129	screen.
130
131	Inputting characters appends them to the regex and continues incremental
132	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
133	search upwards/downwards in the scrollback buffer, C<End> jumps to the
134	bottom. C<Escape> leaves search mode and returns to the point where search
135	was started, while C<Enter> or C<Return> stay at the current position and
136	additionally stores the first match in the current line into the primary
137	selection.
138
139	=item readline (enabled by default)
140
141	A support package that tries to make editing with readline easier. At the
142	moment, it reacts to clicking with the left mouse button by trying to
143	move the text cursor to this position. It does so by generating as many
144	cursor-left or cursor-right keypresses as required (the this only works
145	for programs that correctly support wide characters).
146
147	To avoid too many false positives, this is only done when:
148
149	=over 4
150
151	=item - the tty is in ICANON state.
152
153	=item - the text cursor is visible.
154
155	=item - the primary screen is currently being displayed.
156
157	=item - the mouse is on the same (multi-row-) line as the text cursor.
158
159	=back
160
161	The normal selection mechanism isn't disabled, so quick successive clicks
162	might interfere with selection creation in harmless ways.
163
164	=item selection-autotransform
165
166	This selection allows you to do automatic transforms on a selection
167	whenever a selection is made.
168
169	It works by specifying perl snippets (most useful is a single C<s///>
170	operator) that modify C<$_> as resources:
171
172	URxvt.selection-autotransform.0: transform
173	URxvt.selection-autotransform.1: transform
174	...
175
176	For example, the following will transform selections of the form
177	C<filename:number>, often seen in compiler messages, into C<vi +$filename
178	$word>:
179
180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
181
182	And this example matches the same,but replaces it with vi-commands you can
183	paste directly into your (vi :) editor:
184
185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
186
187	Of course, this can be modified to suit your needs and your editor :)
188
189	To expand the example above to typical perl error messages ("XXX at
190	FILENAME line YYY."), you need a slightly more elaborate solution:
191
192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
194
195	The first line tells the selection code to treat the unchanging part of
196	every error message as a selection pattern, and the second line transforms
197	the message into vi commands to load the file.
198
199	=item tabbed
200
201	This transforms the terminal into a tabbar with additional terminals, that
202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204	button per tab.
205
206	Clicking a button will activate that tab. Pressing B<Shift-Left> and
207	B<Shift-Right> will switch to the tab left or right of the current one,
208	while B<Shift-Down> creates a new tab.
209
210	=item mark-urls
211
212	Uses per-line display filtering (C<on_line_update>) to underline urls and
213	make them clickable. When middle-clicked, the program specified in the
214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
215	the URL as first argument.
216
217	=item automove-background
218
219	This is basically a one-line extension that dynamically changes the background pixmap offset
220	to the window position, in effect creating the same effect as pseudo transparency with
221	a custom pixmap. No scaling is supported in this mode. Exmaple:
222
223	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
224
225	=item block-graphics-to-ascii
226
227	A not very useful example of filtering all text output to the terminal,
228	by replacing all line-drawing characters (U+2500 .. U+259F) by a
229	similar-looking ascii character.
230
231	=item digital-clock
232
233	Displays a digital clock using the built-in overlay.
234
235	=item example-refresh-hooks
236
237	Displays a very simple digital clock in the upper right corner of the
238	window. Illustrates overwriting the refresh callbacks to create your own
239	overlays or changes.
240
241	=item selection-pastebin
242
243	This is a little rarely useful extension that Uploads the selection as
244	textfile to a remote site (or does other things). (The implementation is
245	not currently secure for use in a multiuser environment as it writes to
246	F</tmp> directly.).
247
248	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
249	i.e.
250
251	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
252
253	Pressing this combination runs a command with C<%> replaced by the name of
254	the textfile. This command can be set via a resource:
255
256	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
257
258	And the default is likely not useful to anybody but the few people around
259	here :)
260
261	The name of the textfile is the hex encoded md5 sum of the selection, so
262	the same content should lead to the same filename.
263
264	After a successful upload the selection will be replaced by the text given
265	in the C<selection-pastebin-url> resource (again, the % is the placeholder
266	for the filename):
267
268	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
269
270	=back
271		56
272	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
273		58
274	=head2 General API Considerations	59	=head2 General API Considerations
275		60
…		…
289		74
290	=over 4	75	=over 4
291		76
292	=item $text	77	=item $text
293		78
294	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
295	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.
296		81
297	=item $string	82	=item $string
298		83
299	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
…		…
303	=item $octets	88	=item $octets
304		89
305	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
306	locale-specific way.	91	locale-specific way.
307		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
308	=back	99	=back
309		100
310	=head2 Extension Objects	101	=head2 Extension Objects
311		102
312	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
313	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,
314	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
315	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
316	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
317	use.	109	internal use.
318		110
319	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
320	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
321		113
322	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:
323		123
324	=over 4	124	=over 4
325		125
326	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
327		127
328	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
329	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>
330		130	or C<string>, and C<desc> is the resource description.
331	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
332
333	Dynamically enable the given hooks (named without the C<on_> prefix) for
334	this extension, replacing any previous hook. This is useful when you want
335	to overwrite time-critical hooks only temporarily.
336
337	=item $self->disable ($hook_name[, $hook_name..])
338
339	Dynamically disable the given hooks.
340		131
341	=back	132	=back
342		133
343	=head2 Hooks	134	=head2 Hooks
344		135
345	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
346	called whenever the relevant event happens.	137	called whenever the relevant event happens.
347		138
348	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
349	the in the C<Extension Objects> section.	140	the in the C<Extension Objects> section.
350		141
351	B<All> of these hooks must return a boolean value. If any of the called	142	B<All> of these hooks must return a boolean value. If any of the called
352	hooks returns true, then the event counts as being I<consumed>, and the	143	hooks returns true, then the event counts as being I<consumed>, and the
353	relevant action might not be carried out by the C++ code.	144	relevant action might not be carried out by the C++ code.
…		…
366	place.	157	place.
367		158
368	=item on_start $term	159	=item on_start $term
369		160
370	Called at the very end of initialisation of a new terminal, just before	161	Called at the very end of initialisation of a new terminal, just before
371	trying to map (display) the toplevel and returning to the mainloop.	162	trying to map (display) the toplevel and returning to the main loop.
372		163
373	=item on_destroy $term	164	=item on_destroy $term
374		165
375	Called whenever something tries to destroy terminal, when the terminal is	166	Called whenever something tries to destroy terminal, when the terminal is
376	still fully functional (not for long, though).	167	still fully functional (not for long, though).
…		…
403		194
404	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
405	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
406	by calling C<< $term->selection >>.	197	by calling C<< $term->selection >>.
407		198
408	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.
409		200
410	=item on_sel_extend $term	201	=item on_sel_extend $term
411		202
412	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
413	click) and is either supposed to return false (normal operation), or	204	click) and is either supposed to return false (normal operation), or
414	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
415	processing. This can happen multiple times, as long as the callback	206	processing. This can happen multiple times, as long as the callback
416	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
417	supposed to enlarge the selection more and more, if possible.	208	supposed to enlarge the selection more and more, if possible.
418		209
419	See the F<selection> example extension.	210	See the F<selection> example extension.
420		211
421	=item on_view_change $term, $offset	212	=item on_view_change $term, $offset
422		213
423	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
424	scrolls. Offset C<0> means display the normal terminal, positive values	215	scrolls. Offset C<0> means display the normal terminal, positive values
425	show this many lines of scrollback.	216	show this many lines of scrollback.
426		217
427	=item on_scroll_back $term, $lines, $saved	218	=item on_scroll_back $term, $lines, $saved
428		219
…		…
432		223
433	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,
434	$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
435	number of lines that will be in the scrollback buffer.	226	number of lines that will be in the scrollback buffer.
436		227
437	=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
438		239
439	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	240	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
440	operating system command) is processed. Cursor position and other state	241	operating system command) is processed. Cursor position and other state
441	information is up-to-date when this happens. For interoperability, the	242	information is up-to-date when this happens. For interoperability, the
442	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,
443	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
444	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	}
445		256
446	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,
447	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
448	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.
449		263
450	=item on_add_lines $term, $string	264	=item on_add_lines $term, $string
451		265
452	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
453	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
…		…
458	=item on_tt_write $term, $octets	272	=item on_tt_write $term, $octets
459		273
460	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
461	suppress or filter tty input.	275	suppress or filter tty input.
462		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
463	=item on_line_update $term, $row	284	=item on_line_update $term, $row
464		285
465	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
466	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
467	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,
…		…
474	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
475	you cannot just toggle rendition bits, but only set them.	296	you cannot just toggle rendition bits, but only set them.
476		297
477	=item on_refresh_begin $term	298	=item on_refresh_begin $term
478		299
479	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
480	or similar effects by modify terminal contents in refresh_begin, and	301	similar effects by modifying the terminal contents in refresh_begin, and
481	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
482	code is run after this hook, and takes precedence.	303	code is run after this hook, and takes precedence.
483		304
484	=item on_refresh_end $term	305	=item on_refresh_end $term
485		306
486	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>.
487		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
488	=item on_keyboard_command $term, $string	317	=item on_user_command $term, $string *DEPRECATED*
489		318
490	Called whenever the user presses a key combination that has a	319	Called whenever a user-configured event is being activated (e.g. via
491	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>
492	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.
493		331
494	=item on_x_event $term, $event	332	=item on_x_event $term, $event
495		333
496	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
497	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
498	members are not passed.	336	members are not passed.
499		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
500	=item on_focus_in $term	342	=item on_focus_in $term
501		343
502	Called whenever the window gets the keyboard focus, before rxvt-unicode	344	Called whenever the window gets the keyboard focus, before rxvt-unicode
503	does focus in processing.	345	does focus in processing.
504		346
505	=item on_focus_out $term	347	=item on_focus_out $term
506		348
507	Called wheneever the window loses keyboard focus, before rxvt-unicode does	349	Called whenever the window loses keyboard focus, before rxvt-unicode does
508	focus out processing.	350	focus out processing.
509		351
510	=item on_configure_notify $term, $event	352	=item on_configure_notify $term, $event
511		353
512	=item on_property_notify $term, $event	354	=item on_property_notify $term, $event
…		…
523		365
524	=item on_map_notify $term, $event	366	=item on_map_notify $term, $event
525		367
526	=item on_unmap_notify $term, $event	368	=item on_unmap_notify $term, $event
527		369
528	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
529	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.
530		372
531	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
532	manpage), with the additional members C<row> and C<col>, which are the	374	manpage), with the additional members C<row> and C<col>, which are the
533	(real, not screen-based) row and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
534		376
535	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
536	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
537		379
538	subwindow.
539
540	=item on_client_message $term, $event	380	=item on_client_message $term, $event
541		381
542	=item on_wm_protocols $term, $event	382	=item on_wm_protocols $term, $event
543		383
544	=item on_wm_delete_window $term, $event	384	=item on_wm_delete_window $term, $event
545		385
546	Called when various types of ClientMessage events are received (all with	386	Called when various types of ClientMessage events are received (all with
547	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	387	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
548		388
		389	=item on_bell $term
		390
		391	Called on receipt of a bell character.
		392
549	=back	393	=back
550		394
551	=cut	395	=cut
552		396
553	package urxvt;	397	package urxvt;
554		398
555	use utf8;	399	use utf8;
556	use strict;	400	use strict 'vars';
557	use Carp ();	401	use Carp ();
558	use Scalar::Util ();	402	use Scalar::Util ();
559	use List::Util ();	403	use List::Util ();
560		404
561	our $VERSION = 1;	405	our $VERSION = 1;
562	our $TERM;	406	our $TERM;
563	our @TERM_INIT;	407	our @TERM_INIT; # should go, prevents async I/O etc.
564	our @TERM_EXT;	408	our @TERM_EXT; # should go, prevents async I/O etc.
565	our @HOOKNAME;	409	our @HOOKNAME;
566	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	410	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
567	our %OPTION;	411	our %OPTION;
568		412
569	our $LIBDIR;	413	our $LIBDIR;
…		…
595	The current terminal. This variable stores the current C<urxvt::term>	439	The current terminal. This variable stores the current C<urxvt::term>
596	object, whenever a callback/hook is executing.	440	object, whenever a callback/hook is executing.
597		441
598	=item @urxvt::TERM_INIT	442	=item @urxvt::TERM_INIT
599		443
600	All coderefs in this array will be called as methods of the next newly	444	All code references in this array will be called as methods of the next newly
601	created C<urxvt::term> object (during the C<on_init> phase). The array	445	created C<urxvt::term> object (during the C<on_init> phase). The array
602	gets cleared before the codereferences that were in it are being executed,	446	gets cleared before the code references that were in it are being executed,
603	so coderefs can push themselves onto it again if they so desire.	447	so references can push themselves onto it again if they so desire.
604		448
605	This complements to the perl-eval commandline option, but gets executed	449	This complements to the perl-eval command line option, but gets executed
606	first.	450	first.
607		451
608	=item @urxvt::TERM_EXT	452	=item @urxvt::TERM_EXT
609		453
610	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	454	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
617		461
618	=over 4	462	=over 4
619		463
620	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
621		465
622	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
623	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
624	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
625		470
626	=item urxvt::warn $string	471	=item urxvt::warn $string
627		472
628	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
629	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
630	that calls this function.	475	that calls this function.
631		476
632	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
633	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
634		479
635	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).
636		488
637	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
638		490
639	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
640		492
…		…
660	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	512	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
661	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	513	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
662		514
663	Various constants for use in X calls and event processing.	515	Various constants for use in X calls and event processing.
664		516
		517	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		518	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		519	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		520	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		521	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		522	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		523	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtModeMouse,
		524	PrivMode_ExtMouseRight, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		525	PrivMode_Default
		526
		527	Constants for checking DEC private modes.
		528
665	=back	529	=back
666		530
667	=head2 RENDITION	531	=head2 RENDITION
668		532
669	Rendition bitsets contain information about colour, font, font styles and	533	Rendition bitsets contain information about colour, font, font styles and
…		…
683		547
684	=item $rend = urxvt::OVERLAY_RSTYLE	548	=item $rend = urxvt::OVERLAY_RSTYLE
685		549
686	Return the rendition mask used for overlays by default.	550	Return the rendition mask used for overlays by default.
687		551
688	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	552	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		553	urxvt::RS_RVid, urxvt::RS_Uline
689		554
690	Return the bit that enabled bold, italic, blink, reverse-video and	555	Return the bit that enabled bold, italic, blink, reverse-video and
691	underline, respectively. To enable such a style, just logically OR it into	556	underline, respectively. To enable such a style, just logically OR it into
692	the bitset.	557	the bitset.
693		558
…		…
698	Return the foreground/background colour index, respectively.	563	Return the foreground/background colour index, respectively.
699		564
700	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	565	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
701		566
702	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	567	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		568
		569	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
703		570
704	Replace the foreground/background colour in the rendition mask with the	571	Replace the foreground/background colour in the rendition mask with the
705	specified one.	572	specified one.
706		573
707	=item $value = urxvt::GET_CUSTOM $rend	574	=item $value = urxvt::GET_CUSTOM $rend
…		…
728	};	595	};
729	}	596	}
730		597
731	no warnings 'utf8';	598	no warnings 'utf8';
732		599
		600	sub parse_resource {
		601	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		602
		603	$term->scan_extensions;
		604
		605	my $r = $term->{meta}{resource};
		606	keys %$r; # reset iterator
		607	while (my ($k, $v) = each %$r) {
		608	my $pattern = $k;
		609	$pattern =~ y/./-/ if $isarg;
		610	my $prefix = $name;
		611	my $suffix;
		612	if ($pattern =~ /\-$/) {
		613	$prefix = substr $name, 0, length $pattern;
		614	$suffix = substr $name, length $pattern;
		615	}
		616	if ($pattern eq $prefix) {
		617	$name = "$urxvt::RESCLASS.$k$suffix";
		618
		619	push @{ $term->{perl_ext_3} }, $v->[0];
		620
		621	return 1 unless $isarg;
		622
		623	if ($v->[1] eq "boolean") {
		624	$term->put_option_db ($name, $flag ? "true" : "false");
		625	return 1;
		626	} else {
		627	$term->put_option_db ($name, $value);
		628	return 1 + 2;
		629	}
		630	}
		631	}
		632
		633	0
		634	}
		635
		636	sub usage {
		637	my ($term, $usage_type) = @_;
		638
		639	$term->scan_extensions;
		640
		641	my $r = $term->{meta}{resource};
		642
		643	for my $pattern (sort keys %$r) {
		644	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		645
		646	$desc .= " (-pe $ext)";
		647
		648	if ($usage_type == 1) {
		649	$pattern =~ y/./-/;
		650	$pattern =~ s/-$/-.../g;
		651
		652	if ($type eq "boolean") {
		653	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		654	} else {
		655	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		656	}
		657	} else {
		658	$pattern =~ s/\.$/.*/g;
		659	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		660	}
		661	}
		662	}
		663
733	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	664	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
734		665
735	sub verbose {	666	sub verbose {
736	my ($level, $msg) = @_;	667	my ($level, $msg) = @_;
737	warn "$msg\n" if $level <= $verbosity;	668	warn "$msg\n" if $level <= $verbosity;
…		…
749	$pkg =~ s/[^[:word:]]/_/g;	680	$pkg =~ s/[^[:word:]]/_/g;
750	$pkg = "urxvt::ext::$pkg";	681	$pkg = "urxvt::ext::$pkg";
751		682
752	verbose 3, "loading extension '$path' into package '$pkg'";	683	verbose 3, "loading extension '$path' into package '$pkg'";
753		684
		685	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		686
754	open my $fh, "<:raw", $path	687	open my $fh, "<:raw", $path
755	or die "$path: $!";	688	or die "$path: $!";
756		689
757	my $source =	690	my $source =
758	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	691	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
759	. "#line 1 \"$path\"\n{\n"	692	. "#line 1 \"$path\"\n{\n"
760	. (do { local $/; <$fh> })	693	. (do { local $/; <$fh> })
761	. "\n};\n1";	694	. "\n};\n1";
762		695
763	eval $source	696	eval $source
…		…
772	# called by the rxvt core	705	# called by the rxvt core
773	sub invoke {	706	sub invoke {
774	local $TERM = shift;	707	local $TERM = shift;
775	my $htype = shift;	708	my $htype = shift;
776		709
777	if ($htype == 0) { # INIT	710	if ($htype == HOOK_INIT) {
778	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	711	my @dirs = $TERM->perl_libdirs;
779		712
		713	$TERM->scan_extensions;
		714
780	my %ext_arg;	715	my %ext_arg;
781		716
782	{	717	{
783	my @init = @TERM_INIT;	718	my @init = @TERM_INIT;
784	@TERM_INIT = ();	719	@TERM_INIT = ();
…		…
786	my @pkg = @TERM_EXT;	721	my @pkg = @TERM_EXT;
787	@TERM_EXT = ();	722	@TERM_EXT = ();
788	$TERM->register_package ($_) for @pkg;	723	$TERM->register_package ($_) for @pkg;
789	}	724	}
790		725
		726	for (
791	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	727	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		728	@{ delete $TERM->{perl_ext_3} }
		729	) {
792	if ($_ eq "default") {	730	if ($_ eq "default") {
		731
		732	$ext_arg{$_} = []
793	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	733	for qw(selection option-popup selection-popup readline searchable-scrollback);
		734
		735	for ($TERM->_keysym_resources) {
		736	next if /^(?:string|command|builtin|builtin-string|perl)/;
		737	next unless /^([A-Za-z0-9_\-]+):/;
		738
		739	my $ext = $1;
		740
		741	$ext_arg{$ext} = [];
		742	}
		743
794	} elsif (/^-(.*)$/) {	744	} elsif (/^-(.*)$/) {
795	delete $ext_arg{$1};	745	delete $ext_arg{$1};
		746
796	} elsif (/^([^<]+)<(.*)>$/) {	747	} elsif (/^([^<]+)<(.*)>$/) {
797	push @{ $ext_arg{$1} }, $2;	748	push @{ $ext_arg{$1} }, $2;
		749
798	} else {	750	} else {
799	$ext_arg{$_} ||= [];	751	$ext_arg{$_} ||= [];
800	}	752	}
801	}	753	}
802		754
803	while (my ($ext, $argv) = each %ext_arg) {	755	for my $ext (sort keys %ext_arg) {
804	my @files = grep -f $_, map "$_/$ext", @dirs;	756	my @files = grep -f $_, map "$_/$ext", @dirs;
805		757
806	if (@files) {	758	if (@files) {
807	$TERM->register_package (extension_package $files[0], $argv);	759	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
808	} else {	760	} else {
809	warn "perl extension '$ext' not found in perl library search path\n";	761	warn "perl extension '$ext' not found in perl library search path\n";
810	}	762	}
811	}	763	}
812		764
…		…
818		770
819	if (my $cb = $TERM->{_hook}[$htype]) {	771	if (my $cb = $TERM->{_hook}[$htype]) {
820	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	772	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
821	if $verbosity >= 10;	773	if $verbosity >= 10;
822		774
823	keys %$cb;	775	if ($htype == HOOK_ACTION) {
		776	# this hook is only sent to the extension with the name
		777	# matching the first arg
		778	my $pkg = shift;
		779	$pkg =~ y/-/_/;
		780	$pkg = "urxvt::ext::$pkg";
824		781
825	while (my ($pkg, $cb) = each %$cb) {	782	$cb = $cb->{$pkg}
		783	or return undef; #TODO: maybe warn user?
		784
		785	$cb = { $pkg => $cb };
		786	}
		787
		788	for my $pkg (keys %$cb) {
826	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	789	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
827	$retval ||= $retval_;	790	$retval ||= $retval_;
828		791
829	if ($@) {	792	if ($@) {
830	$TERM->ungrab; # better to lose the grab than the session	793	$TERM->ungrab; # better to lose the grab than the session
831	warn $@;	794	warn $@;
…		…
834		797
835	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	798	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
836	if $verbosity >= 11;	799	if $verbosity >= 11;
837	}	800	}
838		801
839	if ($htype == 1) { # DESTROY	802	if ($htype == HOOK_DESTROY) {
840	# clear package objects	803	# clear package objects
841	%$_ = () for values %{ $TERM->{_pkg} };	804	%$_ = () for values %{ $TERM->{_pkg} };
842		805
843	# clear package	806	# clear package
844	%$TERM = ();	807	%$TERM = ();
845	}	808	}
846		809
847	$retval	810	$retval
848	}	811	}
849		812
850	# urxvt::term::extension	813	sub SET_COLOR($$$) {
		814	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		815	}
		816
		817	sub rend2mask {
		818	no strict 'refs';
		819	my ($str, $mask) = (@_, 0);
		820	my %color = ( fg => undef, bg => undef );
		821	my @failed;
		822	for my $spec ( split /\s+/, $str ) {
		823	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		824	$color{lc($1)} = $2;
		825	} else {
		826	my $neg = $spec =~ s/^[-^]//;
		827	unless ( exists &{"RS_$spec"} ) {
		828	push @failed, $spec;
		829	next;
		830	}
		831	my $cur = &{"RS_$spec"};
		832	if ( $neg ) {
		833	$mask &= ~$cur;
		834	} else {
		835	$mask |= $cur;
		836	}
		837	}
		838	}
		839	($mask, @color{qw(fg bg)}, \@failed)
		840	}
851		841
852	package urxvt::term::extension;	842	package urxvt::term::extension;
853		843
854	sub enable {	844	=head2 The C<urxvt::term::extension> class
855	my ($self, %hook) = @_;
856	my $pkg = $self->{_pkg};
857		845
858	while (my ($name, $cb) = each %hook) {	846	Each extension attached to a terminal object is represented by
859	my $htype = $HOOKTYPE{uc $name};	847	a C<urxvt::term::extension> object.
860	defined $htype
861	or Carp::croak "unsupported hook type '$name'";
862		848
863	$self->set_should_invoke ($htype, +1)	849	You can use these objects, which are passed to all callbacks to store any
864	unless exists $self->{term}{_hook}[$htype]{$pkg};	850	state related to the terminal and extension instance.
865		851
866	$self->{term}{_hook}[$htype]{$pkg} = $cb;	852	The methods (And data members) documented below can be called on extension
867	}	853	objects, in addition to call methods documented for the <urxvt::term>
868	}	854	class.
869		855
870	sub disable {	856	=over 4
871	my ($self, @hook) = @_;
872	my $pkg = $self->{_pkg};
873		857
874	for my $name (@hook) {	858	=item $urxvt_term = $self->{term}
875	my $htype = $HOOKTYPE{uc $name};
876	defined $htype
877	or Carp::croak "unsupported hook type '$name'";
878		859
879	$self->set_should_invoke ($htype, -1)	860	Returns the C<urxvt::term> object associated with this instance of the
880	if delete $self->{term}{_hook}[$htype]{$pkg};	861	extension. This member I<must not> be changed in any way.
881	}	862
882	}	863	=cut
883		864
884	our $AUTOLOAD;	865	our $AUTOLOAD;
885		866
886	sub AUTOLOAD {	867	sub AUTOLOAD {
887	$AUTOLOAD =~ /:([^:]+)$/	868	$AUTOLOAD =~ /:([^:]+)$/
…		…
900		881
901	sub DESTROY {	882	sub DESTROY {
902	# nop	883	# nop
903	}	884	}
904		885
905	# urxvt::destroy_hook	886	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
906		887
907	sub urxvt::destroy_hook::DESTROY {	888	sub urxvt::destroy_hook::DESTROY {
908	${$_[0]}->();	889	${$_[0]}->();
909	}	890	}
910		891
911	sub urxvt::destroy_hook(&) {	892	sub urxvt::destroy_hook(&) {
912	bless \shift, urxvt::destroy_hook::	893	bless \shift, urxvt::destroy_hook::
913	}	894	}
		895
		896	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		897
		898	Dynamically enable the given hooks (named without the C<on_> prefix) for
		899	this extension, replacing any hook previously installed via C<enable> in
		900	this extension.
		901
		902	This is useful when you want to overwrite time-critical hooks only
		903	temporarily.
		904
		905	To install additional callbacks for the same hook, you can use the C<on>
		906	method of the C<urxvt::term> class.
		907
		908	=item $self->disable ($hook_name[, $hook_name..])
		909
		910	Dynamically disable the given hooks.
		911
		912	=cut
		913
		914	sub enable {
		915	my ($self, %hook) = @_;
		916	my $pkg = $self->{_pkg};
		917
		918	while (my ($name, $cb) = each %hook) {
		919	my $htype = $HOOKTYPE{uc $name};
		920	defined $htype
		921	or Carp::croak "unsupported hook type '$name'";
		922
		923	$self->set_should_invoke ($htype, +1)
		924	unless exists $self->{term}{_hook}[$htype]{$pkg};
		925
		926	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		927	}
		928	}
		929
		930	sub disable {
		931	my ($self, @hook) = @_;
		932	my $pkg = $self->{_pkg};
		933
		934	for my $name (@hook) {
		935	my $htype = $HOOKTYPE{uc $name};
		936	defined $htype
		937	or Carp::croak "unsupported hook type '$name'";
		938
		939	$self->set_should_invoke ($htype, -1)
		940	if delete $self->{term}{_hook}[$htype]{$pkg};
		941	}
		942	}
		943
		944	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		945
		946	Similar to the C<enable> enable, but installs additional callbacks for
		947	the given hook(s) (that is, it doesn't replace existing callbacks), and
		948	returns a guard object. When the guard object is destroyed the callbacks
		949	are disabled again.
		950
		951	=cut
		952
		953	sub urxvt::extension::on_disable::DESTROY {
		954	my $disable = shift;
		955
		956	my $term = delete $disable->{""};
		957
		958	while (my ($htype, $id) = each %$disable) {
		959	delete $term->{_hook}[$htype]{$id};
		960	$term->set_should_invoke ($htype, -1);
		961	}
		962	}
		963
		964	sub on {
		965	my ($self, %hook) = @_;
		966
		967	my $term = $self->{term};
		968
		969	my %disable = ( "" => $term );
		970
		971	while (my ($name, $cb) = each %hook) {
		972	my $htype = $HOOKTYPE{uc $name};
		973	defined $htype
		974	or Carp::croak "unsupported hook type '$name'";
		975
		976	$term->set_should_invoke ($htype, +1);
		977	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		978	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		979	}
		980
		981	bless \%disable, "urxvt::extension::on_disable"
		982	}
		983
		984	=item $self->bind_action ($hotkey, $action)
		985
		986	=item $self->x_resource ($pattern)
		987
		988	=item $self->x_resource_boolean ($pattern)
		989
		990	These methods support an additional C<%> prefix for C<$action> or
		991	C<$pattern> when called on an extension object, compared to the
		992	C<urxvt::term> methods of the same name - see the description of these
		993	methods in the C<urxvt::term> class for details.
		994
		995	=cut
		996
		997	sub bind_action {
		998	my ($self, $hotkey, $action) = @_;
		999	$action =~ s/^%:/$_[0]{_name}:/;
		1000	$self->{term}->bind_action ($hotkey, $action)
		1001	}
		1002
		1003	sub x_resource {
		1004	my ($self, $name) = @_;
		1005	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1006	$self->{term}->x_resource ($name)
		1007	}
		1008
		1009	sub x_resource_boolean {
		1010	my ($self, $name) = @_;
		1011	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1012	$self->{term}->x_resource_boolean ($name)
		1013	}
		1014
		1015	=back
		1016
		1017	=cut
914		1018
915	package urxvt::anyevent;	1019	package urxvt::anyevent;
916		1020
917	=head2 The C<urxvt::anyevent> Class	1021	=head2 The C<urxvt::anyevent> Class
918		1022
919	The sole purpose of this class is to deliver an interface to the	1023	The sole purpose of this class is to deliver an interface to the
920	C<AnyEvent> module - any module using it will work inside urxvt without	1024	C<AnyEvent> module - any module using it will work inside urxvt without
921	further programming. The only exception is that you cannot wait on	1025	further programming. The only exception is that you cannot wait on
922	condition variables, but non-blocking condvar use is ok. What this means	1026	condition variables, but non-blocking condvar use is ok.
923	is that you cannot use blocking APIs, but the non-blocking variant should
924	work.
925		1027
926	=cut	1028	In practical terms this means is that you cannot use blocking APIs, but
		1029	the non-blocking variant should work.
927		1030
		1031	=cut
		1032
928	our $VERSION = 1;	1033	our $VERSION = '5.23';
929		1034
930	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1035	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
931	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1036	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
932		1037
933	sub timer {	1038	sub timer {
…		…
935		1040
936	my $cb = $arg{cb};	1041	my $cb = $arg{cb};
937		1042
938	urxvt::timer	1043	urxvt::timer
939	->new	1044	->new
940	->start (urxvt::NOW + $arg{after})	1045	->after ($arg{after}, $arg{interval})
941	->cb (sub {	1046	->cb ($arg{interval} ? $cb : sub {
942	$_[0]->stop; # need to cancel manually	1047	$_[0]->stop; # need to cancel manually
943	$cb->();	1048	$cb->();
944	})	1049	})
945	}	1050	}
946		1051
947	sub io {	1052	sub io {
948	my ($class, %arg) = @_;	1053	my ($class, %arg) = @_;
949		1054
950	my $cb = $arg{cb};	1055	my $cb = $arg{cb};
		1056	my $fd = fileno $arg{fh};
		1057	defined $fd or $fd = $arg{fh};
951		1058
952	bless [$arg{fh}, urxvt::iow	1059	bless [$arg{fh}, urxvt::iow
953	->new	1060	->new
954	->fd (fileno $arg{fh})	1061	->fd ($fd)
955	->events (($arg{poll} =~ /r/ ? 1 : 0)	1062	->events (($arg{poll} =~ /r/ ? 1 : 0)
956	| ($arg{poll} =~ /w/ ? 2 : 0))	1063	| ($arg{poll} =~ /w/ ? 2 : 0))
957	->start	1064	->start
958	->cb (sub {	1065	->cb ($cb)
959	$cb->(($_[1] & 1 ? 'r' : '')
960	. ($_[1] & 2 ? 'w' : ''));
961	})],
962	urxvt::anyevent::	1066	], urxvt::anyevent::
		1067	}
		1068
		1069	sub idle {
		1070	my ($class, %arg) = @_;
		1071
		1072	my $cb = $arg{cb};
		1073
		1074	urxvt::iw
		1075	->new
		1076	->start
		1077	->cb ($cb)
		1078	}
		1079
		1080	sub child {
		1081	my ($class, %arg) = @_;
		1082
		1083	my $cb = $arg{cb};
		1084
		1085	urxvt::pw
		1086	->new
		1087	->start ($arg{pid})
		1088	->cb (sub {
		1089	$_[0]->stop; # need to cancel manually
		1090	$cb->($_[0]->rpid, $_[0]->rstatus);
		1091	})
963	}	1092	}
964		1093
965	sub DESTROY {	1094	sub DESTROY {
966	$_[0][1]->stop;	1095	$_[0][1]->stop;
967	}	1096	}
968		1097
969	sub condvar {	1098	# only needed for AnyEvent < 6 compatibility
970	bless \my $flag, urxvt::anyevent::condvar::	1099	sub one_event {
971	}
972
973	sub urxvt::anyevent::condvar::broadcast {
974	${$_[0]}++;
975	}
976
977	sub urxvt::anyevent::condvar::wait {
978	unless (${$_[0]}) {
979	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1100	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
980	}
981	}	1101	}
982		1102
983	package urxvt::term;	1103	package urxvt::term;
984		1104
985	=head2 The C<urxvt::term> Class	1105	=head2 The C<urxvt::term> Class
…		…
998	urxvt::verbose 6, "register package $pkg to $self";	1118	urxvt::verbose 6, "register package $pkg to $self";
999		1119
1000	@{"$pkg\::ISA"} = urxvt::term::extension::;	1120	@{"$pkg\::ISA"} = urxvt::term::extension::;
1001		1121
1002	my $proxy = bless {	1122	my $proxy = bless {
1003	_pkg => $pkg,	1123	_pkg => $pkg,
		1124	_name => ${"$pkg\::_NAME"}, # hackish
1004	argv => $argv,	1125	argv => $argv,
1005	}, $pkg;	1126	}, $pkg;
1006	Scalar::Util::weaken ($proxy->{term} = $self);	1127	Scalar::Util::weaken ($proxy->{term} = $self);
1007		1128
1008	$self->{_pkg}{$pkg} = $proxy;	1129	$self->{_pkg}{$pkg} = $proxy;
1009		1130
…		…
1012	$proxy->enable ($name => $ref);	1133	$proxy->enable ($name => $ref);
1013	}	1134	}
1014	}	1135	}
1015	}	1136	}
1016		1137
		1138	sub perl_libdirs {
		1139	map { split /:/ }
		1140	$_[0]->resource ("perl_lib"),
		1141	$ENV{URXVT_PERL_LIB},
		1142	"$ENV{HOME}/.urxvt/ext",
		1143	"$LIBDIR/perl"
		1144	}
		1145
		1146	# scan for available extensions and collect their metadata
		1147	sub scan_extensions {
		1148	my ($self) = @_;
		1149
		1150	return if exists $self->{meta};
		1151
		1152	my @urxvtdirs = perl_libdirs $self;
		1153	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1154
		1155	$self->{meta} = \my %meta;
		1156
		1157	# first gather extensions
		1158
		1159	my $gather = sub {
		1160	my ($dir, $core) = @_;
		1161
		1162	opendir my $fh, $dir
		1163	or return;
		1164
		1165	for my $ext (readdir $fh) {
		1166	$ext !~ /^\./
		1167	or next;
		1168
		1169	open my $fh, "<", "$dir/$ext"
		1170	or next;
		1171
		1172	-f $fh
		1173	or next;
		1174
		1175	$ext =~ s/\.uext$// or $core
		1176	or next;
		1177
		1178	my %ext = (dir => $dir);
		1179
		1180	while (<$fh>) {
		1181	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1182	my ($pattern, $type, $desc) = split /:/, $1;
		1183	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1184	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1185	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1186	} else {
		1187	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1188	}
		1189	} elsif (/^\s*(?:#|$)/) {
		1190	# skip other comments and empty lines
		1191	} else {
		1192	last; # stop parsing on first non-empty non-comment line
		1193	}
		1194	}
		1195
		1196	$meta{ext}{$ext} = \%ext;
		1197	}
		1198	};
		1199
		1200	# $gather->($_, 0) for @cpandirs;
		1201	$gather->($_, 1) for @urxvtdirs;
		1202
		1203	# and now merge resources
		1204
		1205	$meta{resource} = \my %resource;
		1206
		1207	while (my ($k, $v) = each %{ $meta{ext} }) {
		1208	#TODO: should check for extensions overriding each other
		1209	%resource = (%resource, %{ $v->{resource} });
		1210	}
		1211	}
		1212
1017	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1213	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1018		1214
1019	Creates a new terminal, very similar as if you had started it with system	1215	Creates a new terminal, very similar as if you had started it with system
1020	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1216	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1021	hash which defines the environment of the new terminal.	1217	hash which defines the environment of the new terminal.
1022		1218
1023	Croaks (and probably outputs an error message) if the new instance	1219	Croaks (and probably outputs an error message) if the new instance
1024	couldn't be created. Returns C<undef> if the new instance didn't	1220	couldn't be created. Returns C<undef> if the new instance didn't
1025	initialise perl, and the terminal object otherwise. The C<init> and	1221	initialise perl, and the terminal object otherwise. The C<init> and
1026	C<start> hooks will be called during this call.	1222	C<start> hooks will be called before this call returns, and are free to
		1223	refer to global data (which is race free).
1027		1224
1028	=cut	1225	=cut
1029		1226
1030	sub new {	1227	sub new {
1031	my ($class, $env, @args) = @_;	1228	my ($class, $env, @args) = @_;
1032		1229
		1230	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1231	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1232
1033	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1233	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1034	}	1234	}
1035		1235
1036	=item $term->destroy	1236	=item $term->destroy
1037		1237
1038	Destroy the terminal object (close the window, free resources	1238	Destroy the terminal object (close the window, free resources
1039	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1239	etc.). Please note that urxvt will not exit as long as any event
1040	watchers (timers, io watchers) are still active.	1240	watchers (timers, io watchers) are still active.
1041		1241
1042	=item $term->exec_async ($cmd[, @args])	1242	=item $term->exec_async ($cmd[, @args])
1043		1243
1044	Works like the combination of the C<fork>/C<exec> builtins, which executes	1244	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1068		1268
1069	Returns true if the option specified by C<$optval> is enabled, and	1269	Returns true if the option specified by C<$optval> is enabled, and
1070	optionally change it. All option values are stored by name in the hash	1270	optionally change it. All option values are stored by name in the hash
1071	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1271	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1072		1272
1073	Here is a a likely non-exhaustive list of option names, please see the	1273	Here is a likely non-exhaustive list of option names, please see the
1074	source file F</src/optinc.h> to see the actual list:	1274	source file F</src/optinc.h> to see the actual list:
1075		1275
1076	borderLess console cursorBlink cursorUnderline hold iconic insecure	1276	borderLess buffered console cursorBlink cursorUnderline hold iconic
1077	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1277	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1078	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1278	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1079	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1279	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1080	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1280	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1081	transparent tripleclickwords utmpInhibit visualBell	1281	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1282	urgentOnBell utmpInhibit visualBell
1082		1283
1083	=item $value = $term->resource ($name[, $newval])	1284	=item $value = $term->resource ($name[, $newval])
1084		1285
1085	Returns the current resource value associated with a given name and	1286	Returns the current resource value associated with a given name and
1086	optionally sets a new value. Setting values is most useful in the C<init>	1287	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1095	likely change).	1296	likely change).
1096		1297
1097	Please note that resource strings will currently only be freed when the	1298	Please note that resource strings will currently only be freed when the
1098	terminal is destroyed, so changing options frequently will eat memory.	1299	terminal is destroyed, so changing options frequently will eat memory.
1099		1300
1100	Here is a a likely non-exhaustive list of resource names, not all of which	1301	Here is a likely non-exhaustive list of resource names, not all of which
1101	are supported in every build, please see the source file F</src/rsinc.h>	1302	are supported in every build, please see the source file F</src/rsinc.h>
1102	to see the actual list:	1303	to see the actual list:
1103		1304
1104	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1305	answerbackstring backgroundPixmap backspace_key blurradius
1105	borderLess color cursorBlink cursorUnderline cutchars delete_key	1306	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1106	display_name embed ext_bwidth fade font geometry hold iconName	1307	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1107	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1308	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1309	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1108	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1310	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1109	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1311	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1110	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1312	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1111	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1313	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1112	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1314	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1113	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1315	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1114	secondaryScreen secondaryScroll selectstyle shade term_name title	1316	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1115	transient_for transparent transparent_all tripleclickwords utmpInhibit	1317	term_name title transient_for transparent tripleclickwords urgentOnBell
1116	visualBell	1318	utmpInhibit visualBell
1117		1319
1118	=cut	1320	=cut
1119		1321
1120	sub resource($$;$) {	1322	sub resource($$;$) {
1121	my ($self, $name) = (shift, shift);	1323	my ($self, $name) = (shift, shift);
1122	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1324	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1123	&urxvt::term::_resource	1325	goto &urxvt::term::_resource
1124	}	1326	}
1125		1327
1126	=item $value = $term->x_resource ($pattern)	1328	=item $value = $term->x_resource ($pattern)
1127		1329
1128	Returns the X-Resource for the given pattern, excluding the program or	1330	Returns the X-Resource for the given pattern, excluding the program or
1129	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1331	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1130	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1332	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1131	resource with that pattern exists.	1333	resource with that pattern exists.
1132		1334
		1335	Extensions that define extra resources also need to call this method
		1336	to access their values.
		1337
		1338	If the method is called on an extension object (basically, from an
		1339	extension), then the special prefix C<%.> will be replaced by the name of
		1340	the extension and a dot, and the lone string C<%> will be replaced by the
		1341	extension name itself. This makes it possible to code extensions so you
		1342	can rename them and get a new set of resources without having to change
		1343	the actual code.
		1344
1133	This method should only be called during the C<on_start> hook, as there is	1345	This method should only be called during the C<on_start> hook, as there is
1134	only one resource database per display, and later invocations might return	1346	only one resource database per display, and later invocations might return
1135	the wrong resources.	1347	the wrong resources.
1136		1348
1137	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1349	=item $value = $term->x_resource_boolean ($pattern)
1138		1350
		1351	Like C<x_resource>, above, but interprets the string value as a boolean
		1352	and returns C<1> for true values, C<0> for false values and C<undef> if
		1353	the resource or option isn't specified.
		1354
		1355	You should always use this method to parse boolean resources.
		1356
		1357	=cut
		1358
		1359	sub x_resource_boolean {
		1360	my $res = &x_resource;
		1361
		1362	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1363	}
		1364
		1365	=item $action = $term->lookup_keysym ($keysym, $state)
		1366
		1367	Returns the action bound to key combination C<($keysym, $state)>,
		1368	if a binding for it exists, and C<undef> otherwise.
		1369
		1370	=item $success = $term->bind_action ($key, $action)
		1371
1139	Adds a keymap translation exactly as specified via a resource. See the	1372	Adds a key binding exactly as specified via a C<keysym> resource. See the
1140	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1373	C<keysym> resource in the urxvt(1) manpage.
		1374
		1375	To add default bindings for actions, an extension should call C<<
		1376	->bind_action >> in its C<init> hook for every such binding. Doing it
		1377	in the C<init> hook allows users to override or remove the binding
		1378	again.
		1379
		1380	Example: the C<searchable-scrollback> by default binds itself
		1381	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1382	$term->bind_action >>.
		1383
		1384	sub init {
		1385	my ($self) = @_;
		1386
		1387	$self->bind_action ("M-s" => "%:start");
		1388	}
1141		1389
1142	=item $rend = $term->rstyle ([$new_rstyle])	1390	=item $rend = $term->rstyle ([$new_rstyle])
1143		1391
1144	Return and optionally change the current rendition. Text that is output by	1392	Return and optionally change the current rendition. Text that is output by
1145	the terminal application will use this style.	1393	the terminal application will use this style.
…		…
1153		1401
1154	=item ($row, $col) = $term->selection_beg ([$row, $col])	1402	=item ($row, $col) = $term->selection_beg ([$row, $col])
1155		1403
1156	=item ($row, $col) = $term->selection_end ([$row, $col])	1404	=item ($row, $col) = $term->selection_end ([$row, $col])
1157		1405
1158	Return the current values of the selection mark, begin or end positions,	1406	Return the current values of the selection mark, begin or end positions.
1159	and optionally set them to new values.	1407
		1408	When arguments are given, then the selection coordinates are set to
		1409	C<$row> and C<$col>, and the selection screen is set to the current
		1410	screen.
		1411
		1412	=item $screen = $term->selection_screen ([$screen])
		1413
		1414	Returns the current selection screen, and then optionally sets it.
1160		1415
1161	=item $term->selection_make ($eventtime[, $rectangular])	1416	=item $term->selection_make ($eventtime[, $rectangular])
1162		1417
1163	Tries to make a selection as set by C<selection_beg> and	1418	Tries to make a selection as set by C<selection_beg> and
1164	C<selection_end>. If C<$rectangular> is true (default: false), a	1419	C<selection_end>. If C<$rectangular> is true (default: false), a
1165	rectangular selection will be made. This is the prefered function to make	1420	rectangular selection will be made. This is the preferred function to make
1166	a selection.	1421	a selection.
1167		1422
1168	=item $success = $term->selection_grab ($eventtime)	1423	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1169		1424
1170	Try to request the primary selection text from the server (for example, as	1425	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1426	true) selection from the server. The corresponding text can be set
1171	set by the next method). No visual feedback will be given. This function	1427	with the next method. No visual feedback will be given. This function
1172	is mostly useful from within C<on_sel_grab> hooks.	1428	is mostly useful from within C<on_sel_grab> hooks.
1173		1429
1174	=item $oldtext = $term->selection ([$newtext])	1430	=item $oldtext = $term->selection ([$newtext, $clipboard])
1175		1431
1176	Return the current selection text and optionally replace it by C<$newtext>.	1432	Return the current selection (clipboard if C<$clipboard> is true) text
		1433	and optionally replace it by C<$newtext>.
		1434
		1435	=item $term->selection_clear ([$clipboard])
		1436
		1437	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1177		1438
1178	=item $term->overlay_simple ($x, $y, $text)	1439	=item $term->overlay_simple ($x, $y, $text)
1179		1440
1180	Create a simple multi-line overlay box. See the next method for details.	1441	Create a simple multi-line overlay box. See the next method for details.
1181		1442
…		…
1211		1472
1212	The methods currently supported on C<urxvt::overlay> objects are:	1473	The methods currently supported on C<urxvt::overlay> objects are:
1213		1474
1214	=over 4	1475	=over 4
1215		1476
1216	=item $overlay->set ($x, $y, $text, $rend)	1477	=item $overlay->set ($x, $y, $text[, $rend])
1217		1478
1218	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1479	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1219	text in rxvt-unicode's special encoding and an array of rendition values	1480	text in rxvt-unicode's special encoding and an array of rendition values
1220	at a specific position inside the overlay.	1481	at a specific position inside the overlay.
		1482
		1483	If C<$rend> is missing, then the rendition will not be changed.
1221		1484
1222	=item $overlay->hide	1485	=item $overlay->hide
1223		1486
1224	If visible, hide the overlay, but do not destroy it.	1487	If visible, hide the overlay, but do not destroy it.
1225		1488
…		…
1288		1551
1289	=item $term->scr_add_lines ($string)	1552	=item $term->scr_add_lines ($string)
1290		1553
1291	Write the given text string to the screen, as if output by the application	1554	Write the given text string to the screen, as if output by the application
1292	running inside the terminal. It may not contain command sequences (escape	1555	running inside the terminal. It may not contain command sequences (escape
1293	codes), but is free to use line feeds, carriage returns and tabs. The	1556	codes - see C<cmd_parse> for that), but is free to use line feeds,
1294	string is a normal text string, not in locale-dependent encoding.	1557	carriage returns and tabs. The string is a normal text string, not in
		1558	locale-dependent encoding.
1295		1559
1296	Normally its not a good idea to use this function, as programs might be	1560	Normally its not a good idea to use this function, as programs might be
1297	confused by changes in cursor position or scrolling. Its useful inside a	1561	confused by changes in cursor position or scrolling. Its useful inside a
1298	C<on_add_lines> hook, though.	1562	C<on_add_lines> hook, though.
1299		1563
…		…
1307	locale-specific encoding of the terminal and can contain command sequences	1571	locale-specific encoding of the terminal and can contain command sequences
1308	(escape codes) that will be interpreted.	1572	(escape codes) that will be interpreted.
1309		1573
1310	=item $term->tt_write ($octets)	1574	=item $term->tt_write ($octets)
1311		1575
1312	Write the octets given in C<$data> to the tty (i.e. as program input). To	1576	Write the octets given in C<$octets> to the tty (i.e. as user input
		1577	to the program, see C<cmd_parse> for the opposite direction). To pass
1313	pass characters instead of octets, you should convert your strings first	1578	characters instead of octets, you should convert your strings first to the
1314	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_write_user_input ($octets)
		1582
		1583	Like C<tt_write>, but should be used when writing strings in response to
		1584	the user pressing a key, to invoke the additional actions requested by
		1585	the user for that case (C<tt_write> doesn't do that).
		1586
		1587	The typical use case would be inside C<on_action> hooks.
		1588
		1589	=item $term->tt_paste ($octets)
		1590
		1591	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1592	CR and bracketing the data with control sequences if bracketed paste mode
		1593	is set.
1315		1594
1316	=item $old_events = $term->pty_ev_events ([$new_events])	1595	=item $old_events = $term->pty_ev_events ([$new_events])
1317		1596
1318	Replaces the event mask of the pty watcher by the given event mask. Can	1597	Replaces the event mask of the pty watcher by the given event mask. Can
1319	be used to suppress input and output handling to the pty/tty. See the	1598	be used to suppress input and output handling to the pty/tty. See the
…		…
1338	Adds the specified events to the vt event mask. Useful e.g. when you want	1617	Adds the specified events to the vt event mask. Useful e.g. when you want
1339	to receive pointer events all the times:	1618	to receive pointer events all the times:
1340		1619
1341	$term->vt_emask_add (urxvt::PointerMotionMask);	1620	$term->vt_emask_add (urxvt::PointerMotionMask);
1342		1621
		1622	=item $term->set_urgency ($set)
		1623
		1624	Enable/disable the urgency hint on the toplevel window.
		1625
		1626	=item $term->focus_in
		1627
		1628	=item $term->focus_out
		1629
		1630	=item $term->key_press ($state, $keycode[, $time])
		1631
		1632	=item $term->key_release ($state, $keycode[, $time])
		1633
		1634	Deliver various fake events to to terminal.
		1635
1343	=item $window_width = $term->width	1636	=item $window_width = $term->width ([$new_value])
1344		1637
1345	=item $window_height = $term->height	1638	=item $window_height = $term->height ([$new_value])
1346		1639
1347	=item $font_width = $term->fwidth	1640	=item $font_width = $term->fwidth ([$new_value])
1348		1641
1349	=item $font_height = $term->fheight	1642	=item $font_height = $term->fheight ([$new_value])
1350		1643
1351	=item $font_ascent = $term->fbase	1644	=item $font_ascent = $term->fbase ([$new_value])
1352		1645
1353	=item $terminal_rows = $term->nrow	1646	=item $terminal_rows = $term->nrow ([$new_value])
1354		1647
1355	=item $terminal_columns = $term->ncol	1648	=item $terminal_columns = $term->ncol ([$new_value])
1356		1649
1357	=item $has_focus = $term->focus	1650	=item $has_focus = $term->focus ([$new_value])
1358		1651
1359	=item $is_mapped = $term->mapped	1652	=item $is_mapped = $term->mapped ([$new_value])
1360		1653
1361	=item $max_scrollback = $term->saveLines	1654	=item $max_scrollback = $term->saveLines ([$new_value])
1362		1655
1363	=item $nrow_plus_saveLines = $term->total_rows	1656	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1364		1657
1365	=item $topmost_scrollback_row = $term->top_row	1658	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1366		1659
1367	Return various integers describing terminal characteristics.	1660	Return various integers describing terminal characteristics. If an
		1661	argument is given, changes the value and returns the previous one.
1368		1662
1369	=item $x_display = $term->display_id	1663	=item $x_display = $term->display_id
1370		1664
1371	Return the DISPLAY used by rxvt-unicode.	1665	Return the DISPLAY used by rxvt-unicode.
1372		1666
…		…
1377	=item $env = $term->env	1671	=item $env = $term->env
1378		1672
1379	Returns a copy of the environment in effect for the terminal as a hashref	1673	Returns a copy of the environment in effect for the terminal as a hashref
1380	similar to C<\%ENV>.	1674	similar to C<\%ENV>.
1381		1675
		1676	=item @envv = $term->envv
		1677
		1678	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1679
		1680	=item @argv = $term->argv
		1681
		1682	Return the argument vector as this terminal, similar to @ARGV, but
		1683	includes the program name as first element.
		1684
1382	=cut	1685	=cut
1383		1686
1384	sub env {	1687	sub env {
1385	if (my $env = $_[0]->_env) {
1386	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1688	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1387	} else {
1388	+{ %ENV }
1389	}
1390	}	1689	}
1391		1690
1392	=item $modifiermask = $term->ModLevel3Mask	1691	=item $modifiermask = $term->ModLevel3Mask
1393		1692
1394	=item $modifiermask = $term->ModMetaMask	1693	=item $modifiermask = $term->ModMetaMask
…		…
1402		1701
1403	Returns the currently displayed screen (0 primary, 1 secondary).	1702	Returns the currently displayed screen (0 primary, 1 secondary).
1404		1703
1405	=item $cursor_is_hidden = $term->hidden_cursor	1704	=item $cursor_is_hidden = $term->hidden_cursor
1406		1705
1407	Returns wether the cursor is currently hidden or not.	1706	Returns whether the cursor is currently hidden or not.
		1707
		1708	=item $priv_modes = $term->priv_modes
		1709
		1710	Returns a bitset with the state of DEC private modes.
		1711
		1712	Example:
		1713
		1714	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1715	# mouse reporting is turned on
		1716	}
1408		1717
1409	=item $view_start = $term->view_start ([$newvalue])	1718	=item $view_start = $term->view_start ([$newvalue])
1410		1719
1411	Returns the row number of the topmost displayed line. Maximum value is	1720	Returns the row number of the topmost displayed line. Maximum value is
1412	C<0>, which displays the normal terminal contents. Lower values scroll	1721	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1418	compare the on-screen display with its stored representation. If they	1727	compare the on-screen display with its stored representation. If they
1419	differ, it redraws the differences.	1728	differ, it redraws the differences.
1420		1729
1421	Used after changing terminal contents to display them.	1730	Used after changing terminal contents to display them.
1422		1731
		1732	=item $term->refresh_check
		1733
		1734	Checks if a refresh has been requested and, if so, schedules one.
		1735
1423	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1736	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1424		1737
1425	Returns the text of the entire row with number C<$row_number>. Row C<0>	1738	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1426	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1739	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1427	terminal line. The scrollback buffer starts at line C<-1> and extends to
1428	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1740	terminal line. Nothing will be returned if a nonexistent line
1429	is requested.	1741	is requested.
1430		1742
1431	If C<$new_text> is specified, it will replace characters in the current	1743	If C<$new_text> is specified, it will replace characters in the current
1432	line, starting at column C<$start_col> (default C<0>), which is useful	1744	line, starting at column C<$start_col> (default C<0>), which is useful
1433	to replace only parts of a line. The font index in the rendition will	1745	to replace only parts of a line. The font index in the rendition will
1434	automatically be updated.	1746	automatically be updated.
1435		1747
1436	C<$text> is in a special encoding: tabs and wide characters that use more	1748	C<$text> is in a special encoding: tabs and wide characters that use more
1437	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1749	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1438	characters. Characters with combining characters and other characters that	1750	characters. Characters with combining characters and other characters that
1439	do not fit into the normal tetx encoding will be replaced with characters	1751	do not fit into the normal text encoding will be replaced with characters
1440	in the private use area.	1752	in the private use area.
1441		1753
1442	You have to obey this encoding when changing text. The advantage is	1754	You have to obey this encoding when changing text. The advantage is
1443	that C<substr> and similar functions work on screen cells and not on	1755	that C<substr> and similar functions work on screen cells and not on
1444	characters.	1756	characters.
…		…
1529	}	1841	}
1530		1842
1531	sub urxvt::line::t {	1843	sub urxvt::line::t {
1532	my ($self) = @_;	1844	my ($self) = @_;
1533		1845
1534	if (@_ > 1)	1846	if (@_ > 1) {
1535	{
1536	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1847	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1537	for $self->{beg} .. $self->{end};	1848	for $self->{beg} .. $self->{end};
1538	}	1849	}
1539		1850
1540	defined wantarray &&	1851	defined wantarray &&
1541	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1852	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1542	0, $self->{len}	1853	0, $self->{len}
1543	}	1854	}
1544		1855
1545	sub urxvt::line::r {	1856	sub urxvt::line::r {
1546	my ($self) = @_;	1857	my ($self) = @_;
1547		1858
1548	if (@_ > 1)	1859	if (@_ > 1) {
1549	{
1550	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1860	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1551	for $self->{beg} .. $self->{end};	1861	for $self->{beg} .. $self->{end};
1552	}	1862	}
1553		1863
1554	if (defined wantarray) {	1864	if (defined wantarray) {
1555	my $rend = [	1865	my $rend = [
1556	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1866	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1557	];	1867	];
…		…
1589	where one character corresponds to one screen cell. See	1899	where one character corresponds to one screen cell. See
1590	C<< $term->ROW_t >> for details.	1900	C<< $term->ROW_t >> for details.
1591		1901
1592	=item $string = $term->special_decode $text	1902	=item $string = $term->special_decode $text
1593		1903
1594	Converts rxvt-unicodes text reprsentation into a perl string. See	1904	Converts rxvt-unicodes text representation into a perl string. See
1595	C<< $term->ROW_t >> for details.	1905	C<< $term->ROW_t >> for details.
1596		1906
1597	=item $success = $term->grab_button ($button, $modifiermask)	1907	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1598		1908
		1909	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1910
1599	Registers a synchronous button grab. See the XGrabButton manpage.	1911	Register/unregister a synchronous button grab. See the XGrabButton
		1912	manpage.
1600		1913
1601	=item $success = $term->grab ($eventtime[, $sync])	1914	=item $success = $term->grab ($eventtime[, $sync])
1602		1915
1603	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1916	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1604	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1917	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1605		1918
1606	=item $term->allow_events_async	1919	=item $term->allow_events_async
1607		1920
1608	Calls XAllowEvents with AsyncBoth for the most recent grab.	1921	Calls XAllowEvents with AsyncBoth for the most recent grab.
1609		1922
…		…
1616	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1929	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1617	recent grab.	1930	recent grab.
1618		1931
1619	=item $term->ungrab	1932	=item $term->ungrab
1620		1933
1621	Calls XUngrab for the most recent grab. Is called automatically on	1934	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1622	evaluation errors, as it is better to lose the grab in the error case as	1935	evaluation errors, as it is better to lose the grab in the error case as
1623	the session.	1936	the session.
1624		1937
1625	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1938	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1626		1939
…		…
1628		1941
1629	=item @atoms = $term->XListProperties ($window)	1942	=item @atoms = $term->XListProperties ($window)
1630		1943
1631	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1944	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1632		1945
1633	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1946	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1634		1947
1635	=item $term->XDeleteProperty ($window, $property)	1948	=item $term->XDeleteProperty ($window, $property)
1636		1949
1637	=item $window = $term->DefaultRootWindow	1950	=item $window = $term->DefaultRootWindow
1638		1951
…		…
1645	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1958	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1646		1959
1647	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1960	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1648		1961
1649	=item $term->XChangeInput ($window, $add_events[, $del_events])	1962	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1963
		1964	=item $keysym = $term->XStringToKeysym ($string)
		1965
		1966	=item $string = $term->XKeysymToString ($keysym)
1650		1967
1651	Various X or X-related functions. The C<$term> object only serves as	1968	Various X or X-related functions. The C<$term> object only serves as
1652	the source of the display, otherwise those functions map more-or-less	1969	the source of the display, otherwise those functions map more-or-less
1653	directory onto the X functions of the same name.	1970	directly onto the X functions of the same name.
1654		1971
1655	=back	1972	=back
1656		1973
1657	=cut	1974	=cut
1658		1975
…		…
1722	my ($self, $text, $cb) = @_;	2039	my ($self, $text, $cb) = @_;
1723		2040
1724	$self->add_item ({ type => "button", text => $text, activate => $cb});	2041	$self->add_item ({ type => "button", text => $text, activate => $cb});
1725	}	2042	}
1726		2043
1727	=item $popup->add_toggle ($text, $cb, $initial_value)	2044	=item $popup->add_toggle ($text, $initial_value, $cb)
1728		2045
1729	Adds a toggle/checkbox item to the popup. Teh callback gets called	2046	Adds a toggle/checkbox item to the popup. The callback gets called
1730	whenever it gets toggled, with a boolean indicating its value as its first	2047	whenever it gets toggled, with a boolean indicating its new value as its
1731	argument.	2048	first argument.
1732		2049
1733	=cut	2050	=cut
1734		2051
1735	sub add_toggle {	2052	sub add_toggle {
1736	my ($self, $text, $cb, $value) = @_;	2053	my ($self, $text, $value, $cb) = @_;
1737		2054
1738	my $item; $item = {	2055	my $item; $item = {
1739	type => "button",	2056	type => "button",
1740	text => " $text",	2057	text => " $text",
1741	value => $value,	2058	value => $value,
…		…
1760	my $env = $self->{term}->env;	2077	my $env = $self->{term}->env;
1761	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2078	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1762	delete $env->{LC_ALL};	2079	delete $env->{LC_ALL};
1763	$env->{LC_CTYPE} = $self->{term}->locale;	2080	$env->{LC_CTYPE} = $self->{term}->locale;
1764		2081
1765	urxvt::term->new ($env, "popup",	2082	my $term = urxvt::term->new (
		2083	$env, "popup",
1766	"--perl-lib" => "", "--perl-ext-common" => "",	2084	"--perl-lib" => "", "--perl-ext-common" => "",
1767	"-pty-fd" => -1, "-sl" => 0,	2085	"-pty-fd" => -1, "-sl" => 0,
1768	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2086	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1769	"--transient-for" => $self->{term}->parent,	2087	"--transient-for" => $self->{term}->parent,
1770	"-display" => $self->{term}->display_id,	2088	"-display" => $self->{term}->display_id,
1771	"-pe" => "urxvt-popup")	2089	"-pe" => "urxvt-popup",
1772	or die "unable to create popup window\n";	2090	) or die "unable to create popup window\n";
		2091
		2092	unless (delete $term->{urxvt_popup_init_done}) {
		2093	$term->ungrab;
		2094	$term->destroy;
		2095	die "unable to initialise popup window\n";
		2096	}
1773	}	2097	}
1774		2098
1775	sub DESTROY {	2099	sub DESTROY {
1776	my ($self) = @_;	2100	my ($self) = @_;
1777		2101
…		…
1782	=back	2106	=back
1783		2107
1784	=cut	2108	=cut
1785		2109
1786	package urxvt::watcher;	2110	package urxvt::watcher;
1787
1788	@urxvt::timer::ISA = __PACKAGE__;
1789	@urxvt::iow::ISA = __PACKAGE__;
1790	@urxvt::pw::ISA = __PACKAGE__;
1791	@urxvt::iw::ISA = __PACKAGE__;
1792		2111
1793	=head2 The C<urxvt::timer> Class	2112	=head2 The C<urxvt::timer> Class
1794		2113
1795	This class implements timer watchers/events. Time is represented as a	2114	This class implements timer watchers/events. Time is represented as a
1796	fractional number of seconds since the epoch. Example:	2115	fractional number of seconds since the epoch. Example:
…		…
1800	->new	2119	->new
1801	->interval (1)	2120	->interval (1)
1802	->cb (sub {	2121	->cb (sub {
1803	$term->{overlay}->set (0, 0,	2122	$term->{overlay}->set (0, 0,
1804	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2123	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1805	});	2124	});
1806		2125
1807	=over 4	2126	=over 4
1808		2127
1809	=item $timer = new urxvt::timer	2128	=item $timer = new urxvt::timer
1810		2129
…		…
1813		2132
1814	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2133	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1815		2134
1816	Set the callback to be called when the timer triggers.	2135	Set the callback to be called when the timer triggers.
1817		2136
1818	=item $tstamp = $timer->at
1819
1820	Return the time this watcher will fire next.
1821
1822	=item $timer = $timer->set ($tstamp)	2137	=item $timer = $timer->set ($tstamp[, $interval])
1823		2138
1824	Set the time the event is generated to $tstamp.	2139	Set the time the event is generated to $tstamp (and optionally specifies a
		2140	new $interval).
1825		2141
1826	=item $timer = $timer->interval ($interval)	2142	=item $timer = $timer->interval ($interval)
1827		2143
1828	Normally (and when C<$interval> is C<0>), the timer will automatically	2144	By default (and when C<$interval> is C<0>), the timer will automatically
1829	stop after it has fired once. If C<$interval> is non-zero, then the timer	2145	stop after it has fired once. If C<$interval> is non-zero, then the timer
1830	is automatically rescheduled at the given intervals.	2146	is automatically rescheduled at the given intervals.
1831		2147
1832	=item $timer = $timer->start	2148	=item $timer = $timer->start
1833		2149
1834	Start the timer.	2150	Start the timer.
1835		2151
1836	=item $timer = $timer->start ($tstamp)	2152	=item $timer = $timer->start ($tstamp[, $interval])
1837		2153
1838	Set the event trigger time to C<$tstamp> and start the timer.	2154	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2155	also replaces the interval.
1839		2156
1840	=item $timer = $timer->after ($delay)	2157	=item $timer = $timer->after ($delay[, $interval])
1841		2158
1842	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2159	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1843		2160
1844	=item $timer = $timer->stop	2161	=item $timer = $timer->stop
1845		2162
…		…
1853		2170
1854	$term->{socket} = ...	2171	$term->{socket} = ...
1855	$term->{iow} = urxvt::iow	2172	$term->{iow} = urxvt::iow
1856	->new	2173	->new
1857	->fd (fileno $term->{socket})	2174	->fd (fileno $term->{socket})
1858	->events (urxvt::EVENT_READ)	2175	->events (urxvt::EV_READ)
1859	->start	2176	->start
1860	->cb (sub {	2177	->cb (sub {
1861	my ($iow, $revents) = @_;	2178	my ($iow, $revents) = @_;
1862	# $revents must be 1 here, no need to check	2179	# $revents must be 1 here, no need to check
1863	sysread $term->{socket}, my $buf, 8192	2180	sysread $term->{socket}, my $buf, 8192
…		…
1876	Set the callback to be called when io events are triggered. C<$reventmask>	2193	Set the callback to be called when io events are triggered. C<$reventmask>
1877	is a bitset as described in the C<events> method.	2194	is a bitset as described in the C<events> method.
1878		2195
1879	=item $iow = $iow->fd ($fd)	2196	=item $iow = $iow->fd ($fd)
1880		2197
1881	Set the filedescriptor (not handle) to watch.	2198	Set the file descriptor (not handle) to watch.
1882		2199
1883	=item $iow = $iow->events ($eventmask)	2200	=item $iow = $iow->events ($eventmask)
1884		2201
1885	Set the event mask to watch. The only allowed values are	2202	Set the event mask to watch. The only allowed values are
1886	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2203	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1887	together, or C<urxvt::EVENT_NONE>.	2204	together, or C<urxvt::EV_NONE>.
1888		2205
1889	=item $iow = $iow->start	2206	=item $iow = $iow->start
1890		2207
1891	Start watching for requested events on the given handle.	2208	Start watching for requested events on the given handle.
1892		2209
1893	=item $iow = $iow->stop	2210	=item $iow = $iow->stop
1894		2211
1895	Stop watching for events on the given filehandle.	2212	Stop watching for events on the given file handle.
1896		2213
1897	=back	2214	=back
1898		2215
1899	=head2 The C<urxvt::iw> Class	2216	=head2 The C<urxvt::iw> Class
1900		2217
…		…
1933	->new	2250	->new
1934	->start ($pid)	2251	->start ($pid)
1935	->cb (sub {	2252	->cb (sub {
1936	my ($pw, $exit_status) = @_;	2253	my ($pw, $exit_status) = @_;
1937	...	2254	...
1938	});	2255	});
1939		2256
1940	=over 4	2257	=over 4
1941		2258
1942	=item $pw = new urxvt::pw	2259	=item $pw = new urxvt::pw
1943		2260
…		…
1947		2264
1948	Set the callback to be called when the timer triggers.	2265	Set the callback to be called when the timer triggers.
1949		2266
1950	=item $pw = $timer->start ($pid)	2267	=item $pw = $timer->start ($pid)
1951		2268
1952	Tells the wqtcher to start watching for process C<$pid>.	2269	Tells the watcher to start watching for process C<$pid>.
1953		2270
1954	=item $pw = $pw->stop	2271	=item $pw = $pw->stop
1955		2272
1956	Stop the watcher.	2273	Stop the watcher.
1957		2274
…		…
1970		2287
1971	=item >= 3 - script loading and management	2288	=item >= 3 - script loading and management
1972		2289
1973	=item >=10 - all called hooks	2290	=item >=10 - all called hooks
1974		2291
1975	=item >=11 - hook reutrn values	2292	=item >=11 - hook return values
1976		2293
1977	=back	2294	=back
1978		2295
1979	=head1 AUTHOR	2296	=head1 AUTHOR
1980		2297
1981	Marc Lehmann <pcg@goof.com>	2298	Marc Lehmann <schmorp@schmorp.de>
1982	http://software.schmorp.de/pkg/rxvt-unicode	2299	http://software.schmorp.de/pkg/rxvt-unicode
1983		2300
1984	=cut	2301	=cut
1985		2302
1986	1	2303	1
		2304
		2305	# vim: sw=3:

Diff Legend

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