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.110 by root, Thu Jan 19 16:22:13 2006 UTC vs.
Revision 1.257 by root, Thu Jul 13 10:31:27 2017 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	=over 4	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	=item selection (enabled by default)	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	Extensions may add additional resources and C<actions>, i.e., methods
45	when the user extends selections (double-click and further clicks). Right	49	which can be bound to a key and invoked by the user. An extension can
46	now, it tries to select words, urls and complete shell-quoted	50	define the resources it support using so called META comments,
47	arguments, which is very convenient, too, if your F<ls> supports	51	described below. Similarly to builtin resources, extension resources
48	C<--quoting-style=shell>.	52	can also be specified on the command line as long options (with C<.>
49		53	replaced by C<->), in which case the corresponding extension is loaded
50	A double-click usually selects the word under the cursor, further clicks	54	automatically. For this to work the extension B<must> define META
51	will enlarge the selection.	55	comments for its resources.
52
53	The selection works by trying to match a number of regexes and displaying
54	them in increasing order of length. You can add your own regexes by
55	specifying resources of the form:
56
57	URxvt.selection.pattern-0: perl-regex
58	URxvt.selection.pattern-1: perl-regex
59	...
60
61	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:
65
66	URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.
70
71	This extension also offers following bindable keyboard commands:
72
73	=over 4
74
75	=item rot13
76
77	Rot-13 the selection when activated. Used via keyboard trigger:
78
79	URxvt.keysym.C-M-r: perl:selection:rot13
80
81	=back
82
83	=item option-popup (enabled by default)
84
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.
87
88	=item selection-popup (enabled by default)
89
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.
93
94	Other extensions can extend this popup menu by pushing a code reference
95	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
96	popup is displayed.
97
98	It's sole argument is the popup menu, which can be modified. The selection
99	is in C<$_>, which can be used to decide wether to add something or not.
100	It should either return nothing or a string and a code reference. The
101	string will be used as button text and the code reference will be called
102	when the button gets activated and should transform C<$_>.
103
104	The following will add an entry C<a to b> that transforms all C<a>s in
105	the selection to C<b>s, but only if the selection currently contains any
106	C<a>s:
107
108	push @{ $self->{term}{selection_popup_hook} }, sub {
109	/a/ ? ("a to be" => sub { s/a/b/g }
110	: ()
111	};
112
113	=item searchable-scrollback<hotkey> (enabled by default)
114
115	Adds regex search functionality to the scrollback buffer, triggered
116	by a hotkey (default: C<M-s>). While in search mode, normal terminal
117	input/output is suspended and a regex is displayed at the bottom of the
118	screen.
119
120	Inputting characters appends them to the regex and continues incremental
121	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
122	search upwards/downwards in the scrollback buffer, C<End> jumps to the
123	bottom. C<Escape> leaves search mode and returns to the point where search
124	was started, while C<Enter> or C<Return> stay at the current position and
125	additionally stores the first match in the current line into the primary
126	selection.
127
128	=item selection-autotransform
129
130	This selection allows you to do automatic transforms on a selection
131	whenever a selection is made.
132
133	It works by specifying perl snippets (most useful is a single C<s///>
134	operator) that modify C<$_> as resources:
135
136	URxvt.selection-autotransform.0: transform
137	URxvt.selection-autotransform.1: transform
138	...
139
140	For example, the following will transform selections of the form
141	C<filename:number>, often seen in compiler messages, into C<vi +$filename
142	$word>:
143
144	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
145
146	And this example matches the same,but replaces it with vi-commands you can
147	paste directly into your (vi :) editor:
148
149	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
150
151	Of course, this can be modified to suit your needs and your editor :)
152
153	To expand the example above to typical perl error messages ("XXX at
154	FILENAME line YYY."), you need a slightly more elaborate solution:
155
156	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
157	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
158
159	The first line tells the selection code to treat the unchanging part of
160	every error message as a selection pattern, and the second line transforms
161	the message into vi commands to load the file.
162
163	=item mark-urls
164
165	Uses per-line display filtering (C<on_line_update>) to underline urls and
166	make them clickable. When middle-clicked, the program specified in the
167	resource C<urlLauncher> (default C<x-www-browser>) will be started with
168	the URL as first argument.
169
170	=item automove-background
171
172	This is basically a one-line extension that dynamically changes the background pixmap offset
173	to the window position, in effect creating the same effect as pseudo transparency with
174	a custom pixmap. No scaling is supported in this mode. Exmaple:
175
176	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
177
178	=item block-graphics-to-ascii
179
180	A not very useful example of filtering all text output to the terminal,
181	by replacing all line-drawing characters (U+2500 .. U+259F) by a
182	similar-looking ascii character.
183
184	=item digital-clock
185
186	Displays a digital clock using the built-in overlay.
187
188	=item example-refresh-hooks
189
190	Displays a very simple digital clock in the upper right corner of the
191	window. Illustrates overwriting the refresh callbacks to create your own
192	overlays or changes.
193
194	=item selection-pastebin
195
196	This is a little rarely useful extension that Uploads the selection as
197	textfile to a remote site (or does other things). (The implementation is
198	not currently secure for use in a multiuser environment as it writes to
199	F</tmp> directly.).
200
201	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
202	i.e.
203
204	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
205
206	Pressing this combination runs a command with C<%> replaced by the name of
207	the textfile. This command can be set via a resource:
208
209	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
210
211	And the default is likely not useful to anybody but the few people around
212	here :)
213
214	The name of the textfile is the hex encoded md5 sum of the selection, so
215	the same content should lead to the same filename.
216
217	After a successful upload the selection will be replaced by the text given
218	in the C<selection-pastebin-url> resource (again, the % is the placeholder
219	for the filename):
220
221	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
222
223	=back
224		56
225	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
226		58
227	=head2 General API Considerations	59	=head2 General API Considerations
228		60
…		…
242		74
243	=over 4	75	=over 4
244		76
245	=item $text	77	=item $text
246		78
247	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
248	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.
249		81
250	=item $string	82	=item $string
251		83
252	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
…		…
256	=item $octets	88	=item $octets
257		89
258	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
259	locale-specific way.	91	locale-specific way.
260		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
261	=back	99	=back
262		100
263	=head2 Extension Objects	101	=head2 Extension Objects
264		102
265	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
266	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,
267	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
268	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
269	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
270	use.	109	internal use.
271		110
272	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
273	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
274		113
275	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:
276		123
277	=over 4	124	=over 4
278		125
279	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
280		127
281	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
282	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>
283		130	or C<string>, and C<desc> is the resource description.
284	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
285
286	Dynamically enable the given hooks (named without the C<on_> prefix) for
287	this extension, replacing any previous hook. This is useful when you want
288	to overwrite time-critical hooks only temporarily.
289
290	=item $self->disable ($hook_name[, $hook_name..])
291
292	Dynamically disable the given hooks.
293		131
294	=back	132	=back
295		133
296	=head2 Hooks	134	=head2 Hooks
297		135
298	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
299	called whenever the relevant event happens.	137	called whenever the relevant event happens.
300		138
301	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
302	the in the C<Extension Objects> section.	140	the in the C<Extension Objects> section.
303		141
304	B<All> of these hooks must return a boolean value. If it is true, then the	142	B<All> of these hooks must return a boolean value. If any of the called
305	event counts as being I<consumed>, and the invocation of other hooks is	143	hooks returns true, then the event counts as being I<consumed>, and the
306	skipped, and the relevant action might not be carried out by the C++ code.	144	relevant action might not be carried out by the C++ code.
307		145
308	I<< When in doubt, return a false value (preferably C<()>). >>	146	I<< When in doubt, return a false value (preferably C<()>). >>
309		147
310	=over 4	148	=over 4
311		149
312	=item on_init $term	150	=item on_init $term
313		151
314	Called after a new terminal object has been initialized, but before	152	Called after a new terminal object has been initialized, but before
315	windows are created or the command gets run. Most methods are unsafe to	153	windows are created or the command gets run. Most methods are unsafe to
316	call or deliver senseless data, as terminal size and other characteristics	154	call or deliver senseless data, as terminal size and other characteristics
317	have not yet been determined. You can safely query and change resources,	155	have not yet been determined. You can safely query and change resources
318	though.	156	and options, though. For many purposes the C<on_start> hook is a better
		157	place.
		158
		159	=item on_start $term
		160
		161	Called at the very end of initialisation of a new terminal, just before
		162	trying to map (display) the toplevel and returning to the main loop.
		163
		164	=item on_destroy $term
		165
		166	Called whenever something tries to destroy terminal, when the terminal is
		167	still fully functional (not for long, though).
319		168
320	=item on_reset $term	169	=item on_reset $term
321		170
322	Called after the screen is "reset" for any reason, such as resizing or	171	Called after the screen is "reset" for any reason, such as resizing or
323	control sequences. Here is where you can react on changes to size-related	172	control sequences. Here is where you can react on changes to size-related
324	variables.	173	variables.
325		174
326	=item on_start $term
327
328	Called at the very end of initialisation of a new terminal, just before
329	returning to the mainloop.
330
331	=item on_child_start $term, $pid	175	=item on_child_start $term, $pid
332		176
333	Called just after the child process has been C<fork>ed.	177	Called just after the child process has been C<fork>ed.
334		178
335	=item on_child_exit $term, $status	179	=item on_child_exit $term, $status
…		…
350		194
351	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
352	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
353	by calling C<< $term->selection >>.	197	by calling C<< $term->selection >>.
354		198
355	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.
356		200
357	=item on_sel_extend $term	201	=item on_sel_extend $term
358		202
359	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
360	click) and is either supposed to return false (normal operation), or	204	click) and is either supposed to return false (normal operation), or
361	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
362	processing. This can happen multiple times, as long as the callback	206	processing. This can happen multiple times, as long as the callback
363	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
364	supposed to enlarge the selection more and more, if possible.	208	supposed to enlarge the selection more and more, if possible.
365		209
366	See the F<selection> example extension.	210	See the F<selection> example extension.
367		211
368	=item on_view_change $term, $offset	212	=item on_view_change $term, $offset
369		213
370	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
371	scrolls. Offset C<0> means display the normal terminal, positive values	215	scrolls. Offset C<0> means display the normal terminal, positive values
372	show this many lines of scrollback.	216	show this many lines of scrollback.
373		217
374	=item on_scroll_back $term, $lines, $saved	218	=item on_scroll_back $term, $lines, $saved
375		219
…		…
379		223
380	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,
381	$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
382	number of lines that will be in the scrollback buffer.	226	number of lines that will be in the scrollback buffer.
383		227
384	=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
385		239
386	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	240	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
387	operating system command) is processed. Cursor position and other state	241	operating system command) is processed. Cursor position and other state
388	information is up-to-date when this happens. For interoperability, the	242	information is up-to-date when this happens. For interoperability, the
389	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,
390	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
391	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	}
392		256
393	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,
394	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
395	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.
396		263
397	=item on_add_lines $term, $string	264	=item on_add_lines $term, $string
398		265
399	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
400	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
…		…
405	=item on_tt_write $term, $octets	272	=item on_tt_write $term, $octets
406		273
407	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
408	suppress or filter tty input.	275	suppress or filter tty input.
409		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
410	=item on_line_update $term, $row	284	=item on_line_update $term, $row
411		285
412	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
413	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
414	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,
…		…
421	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
422	you cannot just toggle rendition bits, but only set them.	296	you cannot just toggle rendition bits, but only set them.
423		297
424	=item on_refresh_begin $term	298	=item on_refresh_begin $term
425		299
426	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
427	or similar effects by modify terminal contents in refresh_begin, and	301	similar effects by modifying the terminal contents in refresh_begin, and
428	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
429	code is run after this hook, and takes precedence.	303	code is run after this hook, and takes precedence.
430		304
431	=item on_refresh_end $term	305	=item on_refresh_end $term
432		306
433	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>.
434		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
435	=item on_keyboard_command $term, $string	317	=item on_user_command $term, $string *DEPRECATED*
436		318
437	Called whenever the user presses a key combination that has a	319	Called whenever a user-configured event is being activated (e.g. via
438	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>
439	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.
440		331
441	=item on_x_event $term, $event	332	=item on_x_event $term, $event
442		333
443	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
444	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
445	members are not passed.	336	members are not passed.
446		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
447	=item on_focus_in $term	342	=item on_focus_in $term
448		343
449	Called whenever the window gets the keyboard focus, before rxvt-unicode	344	Called whenever the window gets the keyboard focus, before rxvt-unicode
450	does focus in processing.	345	does focus in processing.
451		346
452	=item on_focus_out $term	347	=item on_focus_out $term
453		348
454	Called wheneever the window loses keyboard focus, before rxvt-unicode does	349	Called whenever the window loses keyboard focus, before rxvt-unicode does
455	focus out processing.	350	focus out processing.
456		351
457	=item on_configure_notify $term, $event	352	=item on_configure_notify $term, $event
458		353
		354	=item on_property_notify $term, $event
		355
459	=item on_key_press $term, $event, $keysym, $octets	356	=item on_key_press $term, $event, $keysym, $octets
460		357
461	=item on_key_release $term, $event, $keysym	358	=item on_key_release $term, $event, $keysym
462		359
463	=item on_button_press $term, $event	360	=item on_button_press $term, $event
…		…
468		365
469	=item on_map_notify $term, $event	366	=item on_map_notify $term, $event
470		367
471	=item on_unmap_notify $term, $event	368	=item on_unmap_notify $term, $event
472		369
473	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
474	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.
475		372
476	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
477	manpage), with the additional members C<row> and C<col>, which are the row	374	manpage), with the additional members C<row> and C<col>, which are the
478	and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
479		376
480	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
481	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
482		379
483	subwindow.	380	=item on_client_message $term, $event
		381
		382	=item on_wm_protocols $term, $event
		383
		384	=item on_wm_delete_window $term, $event
		385
		386	Called when various types of ClientMessage events are received (all with
		387	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		388
		389	=item on_bell $term
		390
		391	Called on receipt of a bell character.
484		392
485	=back	393	=back
486		394
487	=cut	395	=cut
488		396
489	package urxvt;	397	package urxvt;
490		398
491	use utf8;	399	use utf8;
492	use strict;	400	use strict 'vars';
493	use Carp ();	401	use Carp ();
494	use Scalar::Util ();	402	use Scalar::Util ();
495	use List::Util ();	403	use List::Util ();
496		404
497	our $VERSION = 1;	405	our $VERSION = 1;
498	our $TERM;	406	our $TERM;
		407	our @TERM_INIT; # should go, prevents async I/O etc.
		408	our @TERM_EXT; # should go, prevents async I/O etc.
499	our @HOOKNAME;	409	our @HOOKNAME;
500	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	410	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
501	our %OPTION;	411	our %OPTION;
502		412
503	our $LIBDIR;	413	our $LIBDIR;
504	our $RESNAME;	414	our $RESNAME;
505	our $RESCLASS;	415	our $RESCLASS;
506	our $RXVTNAME;	416	our $RXVTNAME;
507		417
		418	our $NOCHAR = chr 0xffff;
		419
508	=head2 Variables in the C<urxvt> Package	420	=head2 Variables in the C<urxvt> Package
509		421
510	=over 4	422	=over 4
511		423
512	=item $urxvt::LIBDIR	424	=item $urxvt::LIBDIR
…		…
525	=item $urxvt::TERM	437	=item $urxvt::TERM
526		438
527	The current terminal. This variable stores the current C<urxvt::term>	439	The current terminal. This variable stores the current C<urxvt::term>
528	object, whenever a callback/hook is executing.	440	object, whenever a callback/hook is executing.
529		441
		442	=item @urxvt::TERM_INIT
		443
		444	All code references in this array will be called as methods of the next newly
		445	created C<urxvt::term> object (during the C<on_init> phase). The array
		446	gets cleared before the code references that were in it are being executed,
		447	so references can push themselves onto it again if they so desire.
		448
		449	This complements to the perl-eval command line option, but gets executed
		450	first.
		451
		452	=item @urxvt::TERM_EXT
		453
		454	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		455	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		456	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		457
530	=back	458	=back
531		459
532	=head2 Functions in the C<urxvt> Package	460	=head2 Functions in the C<urxvt> Package
533		461
534	=over 4	462	=over 4
535		463
536	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
537		465
538	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
539	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
540	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
541		470
542	=item urxvt::warn $string	471	=item urxvt::warn $string
543		472
544	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
545	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
546	that calls this function.	475	that calls this function.
547		476
548	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
549	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
550		479
551	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).
552		488
553	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
554		490
555	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
556		492
…		…
576	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	512	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
577	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	513	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
578		514
579	Various constants for use in X calls and event processing.	515	Various constants for use in X calls and event processing.
580		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
581	=back	529	=back
582		530
583	=head2 RENDITION	531	=head2 RENDITION
584		532
585	Rendition bitsets contain information about colour, font, font styles and	533	Rendition bitsets contain information about colour, font, font styles and
…		…
599		547
600	=item $rend = urxvt::OVERLAY_RSTYLE	548	=item $rend = urxvt::OVERLAY_RSTYLE
601		549
602	Return the rendition mask used for overlays by default.	550	Return the rendition mask used for overlays by default.
603		551
604	=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
605		554
606	Return the bit that enabled bold, italic, blink, reverse-video and	555	Return the bit that enabled bold, italic, blink, reverse-video and
607	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
608	the bitset.	557	the bitset.
609		558
…		…
614	Return the foreground/background colour index, respectively.	563	Return the foreground/background colour index, respectively.
615		564
616	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	565	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
617		566
618	=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
619		570
620	Replace the foreground/background colour in the rendition mask with the	571	Replace the foreground/background colour in the rendition mask with the
621	specified one.	572	specified one.
622		573
623	=item $value = urxvt::GET_CUSTOM $rend	574	=item $value = urxvt::GET_CUSTOM $rend
…		…
642	unless $msg =~ /\n$/;	593	unless $msg =~ /\n$/;
643	urxvt::warn ($msg);	594	urxvt::warn ($msg);
644	};	595	};
645	}	596	}
646		597
		598	no warnings 'utf8';
		599
		600	sub parse_resource {
		601	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		602
		603	$term->scan_extensions;
		604
		605	my $r = $term->{meta}{resource};
		606	keys %$r; # reset iterator
		607	while (my ($k, $v) = each %$r) {
		608	my $pattern = $k;
		609	$pattern =~ y/./-/ if $isarg;
		610	my $prefix = $name;
		611	my $suffix;
		612	if ($pattern =~ /\-$/) {
		613	$prefix = substr $name, 0, length $pattern;
		614	$suffix = substr $name, length $pattern;
		615	}
		616	if ($pattern eq $prefix) {
		617	$name = "$urxvt::RESCLASS.$k$suffix";
		618
		619	push @{ $term->{perl_ext_3} }, $v->[0];
		620
		621	return 1 unless $isarg;
		622
		623	if ($v->[1] eq "boolean") {
		624	$term->put_option_db ($name, $flag ? "true" : "false");
		625	return 1;
		626	} else {
		627	$term->put_option_db ($name, $value);
		628	return 1 + 2;
		629	}
		630	}
		631	}
		632
		633	0
		634	}
		635
		636	sub usage {
		637	my ($term, $usage_type) = @_;
		638
		639	$term->scan_extensions;
		640
		641	my $r = $term->{meta}{resource};
		642
		643	for my $pattern (sort keys %$r) {
		644	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		645
		646	$desc .= " (-pe $ext)";
		647
		648	if ($usage_type == 1) {
		649	$pattern =~ y/./-/;
		650	$pattern =~ s/-$/-.../g;
		651
		652	if ($type eq "boolean") {
		653	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		654	} else {
		655	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		656	}
		657	} else {
		658	$pattern =~ s/\.$/.*/g;
		659	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		660	}
		661	}
		662	}
		663
647	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	664	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
648		665
649	sub verbose {	666	sub verbose {
650	my ($level, $msg) = @_;	667	my ($level, $msg) = @_;
651	warn "$msg\n" if $level <= $verbosity;	668	warn "$msg\n" if $level <= $verbosity;
…		…
654	my %extension_pkg;	671	my %extension_pkg;
655		672
656	# load a single script into its own package, once only	673	# load a single script into its own package, once only
657	sub extension_package($) {	674	sub extension_package($) {
658	my ($path) = @_;	675	my ($path) = @_;
659
660	no strict 'refs';
661		676
662	$extension_pkg{$path} ||= do {	677	$extension_pkg{$path} ||= do {
663	$path =~ /([^\/\\]+)$/;	678	$path =~ /([^\/\\]+)$/;
664	my $pkg = $1;	679	my $pkg = $1;
665	$pkg =~ s/[^[:word:]]/_/g;	680	$pkg =~ s/[^[:word:]]/_/g;
666	$pkg = "urxvt::ext::$pkg";	681	$pkg = "urxvt::ext::$pkg";
667		682
668	verbose 3, "loading extension '$path' into package '$pkg'";	683	verbose 3, "loading extension '$path' into package '$pkg'";
669		684
		685	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		686
670	open my $fh, "<:raw", $path	687	open my $fh, "<:raw", $path
671	or die "$path: $!";	688	or die "$path: $!";
672		689
673	@{"$pkg\::ISA"} = urxvt::term::extension::;
674
675	my $source =	690	my $source =
676	"package $pkg; use strict; use utf8;\n"	691	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
677	. "#line 1 \"$path\"\n{\n"	692	. "#line 1 \"$path\"\n{\n"
678	. (do { local $/; <$fh> })	693	. (do { local $/; <$fh> })
679	. "\n};\n1";	694	. "\n};\n1";
680		695
681	eval $source	696	eval $source
…		…
690	# called by the rxvt core	705	# called by the rxvt core
691	sub invoke {	706	sub invoke {
692	local $TERM = shift;	707	local $TERM = shift;
693	my $htype = shift;	708	my $htype = shift;
694		709
695	if ($htype == 0) { # INIT	710	if ($htype == HOOK_INIT) {
696	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	711	my @dirs = $TERM->perl_libdirs;
697		712
		713	$TERM->scan_extensions;
		714
698	my %ext_arg;	715	my %ext_arg;
699		716
		717	{
		718	my @init = @TERM_INIT;
		719	@TERM_INIT = ();
		720	$_->($TERM) for @init;
		721	my @pkg = @TERM_EXT;
		722	@TERM_EXT = ();
		723	$TERM->register_package ($_) for @pkg;
		724	}
		725
		726	for (
700	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	727	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		728	@{ delete $TERM->{perl_ext_3} }
		729	) {
701	if ($_ eq "default") {	730	if ($_ eq "default") {
		731
		732	$ext_arg{$_} = []
702	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	733	for qw(selection option-popup selection-popup readline searchable-scrollback);
		734
		735	for ($TERM->_keysym_resources) {
		736	next if /^(?:string|command|builtin|builtin-string|perl)/;
		737	next unless /^([A-Za-z0-9_\-]+):/;
		738
		739	my $ext = $1;
		740
		741	$ext_arg{$ext} = [];
		742	}
		743
703	} elsif (/^-(.*)$/) {	744	} elsif (/^-(.*)$/) {
704	delete $ext_arg{$1};	745	delete $ext_arg{$1};
		746
705	} elsif (/^([^<]+)<(.*)>$/) {	747	} elsif (/^([^<]+)<(.*)>$/) {
706	push @{ $ext_arg{$1} }, $2;	748	push @{ $ext_arg{$1} }, $2;
		749
707	} else {	750	} else {
708	$ext_arg{$_} ||= [];	751	$ext_arg{$_} ||= [];
709	}	752	}
710	}	753	}
711		754
712	while (my ($ext, $argv) = each %ext_arg) {	755	for my $ext (sort keys %ext_arg) {
713	my @files = grep -f $_, map "$_/$ext", @dirs;	756	my @files = grep -f $_, map "$_/$ext", @dirs;
714		757
715	if (@files) {	758	if (@files) {
716	$TERM->register_package (extension_package $files[0], $argv);	759	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
717	} else {	760	} else {
718	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";
719	}	762	}
720	}	763	}
721		764
…		…
727		770
728	if (my $cb = $TERM->{_hook}[$htype]) {	771	if (my $cb = $TERM->{_hook}[$htype]) {
729	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	772	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
730	if $verbosity >= 10;	773	if $verbosity >= 10;
731		774
732	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";
733		781
734	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) {
735	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	789	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
736	and last;	790	$retval ||= $retval_;
737		791
738	if ($@) {	792	if ($@) {
739	$TERM->ungrab; # better to lose the grab than the session	793	$TERM->ungrab; # better to lose the grab than the session
740	warn $@;	794	warn $@;
741	}	795	}
…		…
743		797
744	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	798	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
745	if $verbosity >= 11;	799	if $verbosity >= 11;
746	}	800	}
747		801
748	if ($htype == 1) { # DESTROY	802	if ($htype == HOOK_DESTROY) {
749	# clear package objects	803	# clear package objects
750	%$_ = () for values %{ $TERM->{_pkg} };	804	%$_ = () for values %{ $TERM->{_pkg} };
751		805
752	# clear package	806	# clear package
753	%$TERM = ();	807	%$TERM = ();
754	}	808	}
755		809
756	$retval	810	$retval
757	}	811	}
758		812
759	# 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	}
760		841
761	package urxvt::term::extension;	842	package urxvt::term::extension;
762		843
763	sub enable {	844	=head2 The C<urxvt::term::extension> class
764	my ($self, %hook) = @_;
765	my $pkg = $self->{_pkg};
766		845
767	while (my ($name, $cb) = each %hook) {	846	Each extension attached to a terminal object is represented by
768	my $htype = $HOOKTYPE{uc $name};	847	a C<urxvt::term::extension> object.
769	defined $htype
770	or Carp::croak "unsupported hook type '$name'";
771		848
772	$self->set_should_invoke ($htype, +1)	849	You can use these objects, which are passed to all callbacks to store any
773	unless exists $self->{term}{_hook}[$htype]{$pkg};	850	state related to the terminal and extension instance.
774		851
775	$self->{term}{_hook}[$htype]{$pkg} = $cb;	852	The methods (And data members) documented below can be called on extension
776	}	853	objects, in addition to call methods documented for the <urxvt::term>
777	}	854	class.
778		855
779	sub disable {	856	=over 4
780	my ($self, @hook) = @_;
781	my $pkg = $self->{_pkg};
782		857
783	for my $name (@hook) {	858	=item $urxvt_term = $self->{term}
784	my $htype = $HOOKTYPE{uc $name};
785	defined $htype
786	or Carp::croak "unsupported hook type '$name'";
787		859
788	$self->set_should_invoke ($htype, -1)	860	Returns the C<urxvt::term> object associated with this instance of the
789	if delete $self->{term}{_hook}[$htype]{$pkg};	861	extension. This member I<must not> be changed in any way.
790	}	862
791	}	863	=cut
792		864
793	our $AUTOLOAD;	865	our $AUTOLOAD;
794		866
795	sub AUTOLOAD {	867	sub AUTOLOAD {
796	$AUTOLOAD =~ /:([^:]+)$/	868	$AUTOLOAD =~ /:([^:]+)$/
…		…
809		881
810	sub DESTROY {	882	sub DESTROY {
811	# nop	883	# nop
812	}	884	}
813		885
814	# urxvt::destroy_hook	886	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
815		887
816	sub urxvt::destroy_hook::DESTROY {	888	sub urxvt::destroy_hook::DESTROY {
817	${$_[0]}->();	889	${$_[0]}->();
818	}	890	}
819		891
820	sub urxvt::destroy_hook(&) {	892	sub urxvt::destroy_hook(&) {
821	bless \shift, urxvt::destroy_hook::	893	bless \shift, urxvt::destroy_hook::
822	}	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
823		1018
824	package urxvt::anyevent;	1019	package urxvt::anyevent;
825		1020
826	=head2 The C<urxvt::anyevent> Class	1021	=head2 The C<urxvt::anyevent> Class
827		1022
828	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
829	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
830	further programming. The only exception is that you cannot wait on	1025	further programming. The only exception is that you cannot wait on
831	condition variables, but non-blocking condvar use is ok. What this means	1026	condition variables, but non-blocking condvar use is ok.
832	is that you cannot use blocking APIs, but the non-blocking variant should
833	work.
834		1027
835	=cut	1028	In practical terms this means is that you cannot use blocking APIs, but
		1029	the non-blocking variant should work.
836		1030
		1031	=cut
		1032
837	our $VERSION = 1;	1033	our $VERSION = '5.23';
838		1034
839	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1035	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
840	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1036	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
841		1037
842	sub timer {	1038	sub timer {
…		…
844		1040
845	my $cb = $arg{cb};	1041	my $cb = $arg{cb};
846		1042
847	urxvt::timer	1043	urxvt::timer
848	->new	1044	->new
849	->start (urxvt::NOW + $arg{after})	1045	->after ($arg{after}, $arg{interval})
850	->cb (sub {	1046	->cb ($arg{interval} ? $cb : sub {
851	$_[0]->stop; # need to cancel manually	1047	$_[0]->stop; # need to cancel manually
852	$cb->();	1048	$cb->();
853	})	1049	})
854	}	1050	}
855		1051
856	sub io {	1052	sub io {
857	my ($class, %arg) = @_;	1053	my ($class, %arg) = @_;
858		1054
859	my $cb = $arg{cb};	1055	my $cb = $arg{cb};
		1056	my $fd = fileno $arg{fh};
		1057	defined $fd or $fd = $arg{fh};
860		1058
861	bless [$arg{fh}, urxvt::iow	1059	bless [$arg{fh}, urxvt::iow
862	->new	1060	->new
863	->fd (fileno $arg{fh})	1061	->fd ($fd)
864	->events (($arg{poll} =~ /r/ ? 1 : 0)	1062	->events (($arg{poll} =~ /r/ ? 1 : 0)
865	| ($arg{poll} =~ /w/ ? 2 : 0))	1063	| ($arg{poll} =~ /w/ ? 2 : 0))
866	->start	1064	->start
867	->cb (sub {	1065	->cb ($cb)
868	$cb->(($_[1] & 1 ? 'r' : '')
869	. ($_[1] & 2 ? 'w' : ''));
870	})],
871	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	})
872	}	1092	}
873		1093
874	sub DESTROY {	1094	sub DESTROY {
875	$_[0][1]->stop;	1095	$_[0][1]->stop;
876	}	1096	}
877		1097
878	sub condvar {	1098	# only needed for AnyEvent < 6 compatibility
879	bless \my $flag, urxvt::anyevent::condvar::	1099	sub one_event {
880	}
881
882	sub urxvt::anyevent::condvar::broadcast {
883	${$_[0]}++;
884	}
885
886	sub urxvt::anyevent::condvar::wait {
887	unless (${$_[0]}) {
888	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";
889	}
890	}	1101	}
891		1102
892	package urxvt::term;	1103	package urxvt::term;
893		1104
894	=head2 The C<urxvt::term> Class	1105	=head2 The C<urxvt::term> Class
…		…
900	# find on_xxx subs in the package and register them	1111	# find on_xxx subs in the package and register them
901	# as hooks	1112	# as hooks
902	sub register_package {	1113	sub register_package {
903	my ($self, $pkg, $argv) = @_;	1114	my ($self, $pkg, $argv) = @_;
904		1115
		1116	no strict 'refs';
		1117
		1118	urxvt::verbose 6, "register package $pkg to $self";
		1119
		1120	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1121
905	my $proxy = bless {	1122	my $proxy = bless {
906	_pkg => $pkg,	1123	_pkg => $pkg,
		1124	_name => ${"$pkg\::_NAME"}, # hackish
907	argv => $argv,	1125	argv => $argv,
908	}, $pkg;	1126	}, $pkg;
909	Scalar::Util::weaken ($proxy->{term} = $self);	1127	Scalar::Util::weaken ($proxy->{term} = $self);
910		1128
911	$self->{_pkg}{$pkg} = $proxy;	1129	$self->{_pkg}{$pkg} = $proxy;
912		1130
…		…
915	$proxy->enable ($name => $ref);	1133	$proxy->enable ($name => $ref);
916	}	1134	}
917	}	1135	}
918	}	1136	}
919		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
920	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1213	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
921		1214
922	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
923	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
924	hash which defines the environment of the new terminal.	1217	hash which defines the environment of the new terminal.
925		1218
926	Croaks (and probably outputs an error message) if the new instance	1219	Croaks (and probably outputs an error message) if the new instance
927	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
928	initialise perl, and the terminal object otherwise. The C<init> and	1221	initialise perl, and the terminal object otherwise. The C<init> and
929	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).
930		1224
931	=cut	1225	=cut
932		1226
933	sub new {	1227	sub new {
934	my ($class, $env, @args) = @_;	1228	my ($class, $env, @args) = @_;
935		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
936	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1233	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
937	}	1234	}
938		1235
939	=item $term->destroy	1236	=item $term->destroy
940		1237
941	Destroy the terminal object (close the window, free resources	1238	Destroy the terminal object (close the window, free resources
942	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
943	watchers (timers, io watchers) are still active.	1240	watchers (timers, io watchers) are still active.
944		1241
945	=item $term->exec_async ($cmd[, @args])	1242	=item $term->exec_async ($cmd[, @args])
946		1243
947	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
…		…
971		1268
972	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
973	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
974	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.
975		1272
976	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
977	source file F</src/optinc.h> to see the actual list:	1274	source file F</src/optinc.h> to see the actual list:
978		1275
979	borderLess console cursorBlink cursorUnderline hold iconic insecure	1276	borderLess buffered console cursorBlink cursorUnderline hold iconic
980	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1277	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
981	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1278	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
982	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1279	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
983	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1280	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
984	transparent tripleclickwords utmpInhibit visualBell	1281	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1282	urgentOnBell utmpInhibit visualBell
985		1283
986	=item $value = $term->resource ($name[, $newval])	1284	=item $value = $term->resource ($name[, $newval])
987		1285
988	Returns the current resource value associated with a given name and	1286	Returns the current resource value associated with a given name and
989	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>
…		…
998	likely change).	1296	likely change).
999		1297
1000	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
1001	terminal is destroyed, so changing options frequently will eat memory.	1299	terminal is destroyed, so changing options frequently will eat memory.
1002		1300
1003	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
1004	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>
1005	to see the actual list:	1303	to see the actual list:
1006		1304
1007	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1305	answerbackstring backgroundPixmap backspace_key blurradius
1008	borderLess color cursorBlink cursorUnderline cutchars delete_key	1306	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1009	display_name embed ext_bwidth fade font geometry hold iconName	1307	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1010	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
1011	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1310	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1012	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1311	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1013	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1312	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1014	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1313	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1015	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1314	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1016	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1315	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1017	secondaryScreen secondaryScroll selectstyle shade term_name title	1316	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1018	transient_for transparent transparent_all tripleclickwords utmpInhibit	1317	term_name title transient_for transparent tripleclickwords urgentOnBell
1019	visualBell	1318	utmpInhibit visualBell
1020		1319
1021	=cut	1320	=cut
1022		1321
1023	sub resource($$;$) {	1322	sub resource($$;$) {
1024	my ($self, $name) = (shift, shift);	1323	my ($self, $name) = (shift, shift);
1025	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1324	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1026	&urxvt::term::_resource	1325	goto &urxvt::term::_resource
1027	}	1326	}
1028		1327
1029	=item $value = $term->x_resource ($pattern)	1328	=item $value = $term->x_resource ($pattern)
1030		1329
1031	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
1032	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
1033	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
1034	resource with that pattern exists.	1333	resource with that pattern exists.
1035		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
1036	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
1037	only one resource database per display, and later invocations might return	1346	only one resource database per display, and later invocations might return
1038	the wrong resources.	1347	the wrong resources.
1039		1348
1040	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1349	=item $value = $term->x_resource_boolean ($pattern)
1041		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
1042	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
1043	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	}
1044		1389
1045	=item $rend = $term->rstyle ([$new_rstyle])	1390	=item $rend = $term->rstyle ([$new_rstyle])
1046		1391
1047	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
1048	the terminal application will use this style.	1393	the terminal application will use this style.
…		…
1056		1401
1057	=item ($row, $col) = $term->selection_beg ([$row, $col])	1402	=item ($row, $col) = $term->selection_beg ([$row, $col])
1058		1403
1059	=item ($row, $col) = $term->selection_end ([$row, $col])	1404	=item ($row, $col) = $term->selection_end ([$row, $col])
1060		1405
1061	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.
1062	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.
1063		1415
1064	=item $term->selection_make ($eventtime[, $rectangular])	1416	=item $term->selection_make ($eventtime[, $rectangular])
1065		1417
1066	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
1067	C<selection_end>. If C<$rectangular> is true (default: false), a	1419	C<selection_end>. If C<$rectangular> is true (default: false), a
1068	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
1069	a selection.	1421	a selection.
1070		1422
1071	=item $success = $term->selection_grab ($eventtime)	1423	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1072		1424
1073	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
1074	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
1075	is mostly useful from within C<on_sel_grab> hooks.	1428	is mostly useful from within C<on_sel_grab> hooks.
1076		1429
1077	=item $oldtext = $term->selection ([$newtext])	1430	=item $oldtext = $term->selection ([$newtext, $clipboard])
1078		1431
1079	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.
1080		1438
1081	=item $term->overlay_simple ($x, $y, $text)	1439	=item $term->overlay_simple ($x, $y, $text)
1082		1440
1083	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.
1084		1442
…		…
1114		1472
1115	The methods currently supported on C<urxvt::overlay> objects are:	1473	The methods currently supported on C<urxvt::overlay> objects are:
1116		1474
1117	=over 4	1475	=over 4
1118		1476
1119	=item $overlay->set ($x, $y, $text, $rend)	1477	=item $overlay->set ($x, $y, $text[, $rend])
1120		1478
1121	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
1122	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
1123	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.
1124		1484
1125	=item $overlay->hide	1485	=item $overlay->hide
1126		1486
1127	If visible, hide the overlay, but do not destroy it.	1487	If visible, hide the overlay, but do not destroy it.
1128		1488
…		…
1191		1551
1192	=item $term->scr_add_lines ($string)	1552	=item $term->scr_add_lines ($string)
1193		1553
1194	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
1195	running inside the terminal. It may not contain command sequences (escape	1555	running inside the terminal. It may not contain command sequences (escape
1196	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,
1197	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.
1198		1559
1199	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
1200	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
1201	C<on_add_lines> hook, though.	1562	C<on_add_lines> hook, though.
1202		1563
		1564	=item $term->scr_change_screen ($screen)
		1565
		1566	Switch to given screen - 0 primary, 1 secondary.
		1567
1203	=item $term->cmd_parse ($octets)	1568	=item $term->cmd_parse ($octets)
1204		1569
1205	Similar to C<scr_add_lines>, but the argument must be in the	1570	Similar to C<scr_add_lines>, but the argument must be in the
1206	locale-specific encoding of the terminal and can contain command sequences	1571	locale-specific encoding of the terminal and can contain command sequences
1207	(escape codes) that will be interpreted.	1572	(escape codes) that will be interpreted.
1208		1573
1209	=item $term->tt_write ($octets)	1574	=item $term->tt_write ($octets)
1210		1575
1211	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
1212	pass characters instead of octets, you should convert your strings first	1578	characters instead of octets, you should convert your strings first to the
1213	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.
1214		1594
1215	=item $old_events = $term->pty_ev_events ([$new_events])	1595	=item $old_events = $term->pty_ev_events ([$new_events])
1216		1596
1217	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
1218	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
1219	description of C<< urxvt::timer->events >>. Make sure to always restore	1599	description of C<< urxvt::timer->events >>. Make sure to always restore
1220	the previous value.	1600	the previous value.
1221		1601
		1602	=item $fd = $term->pty_fd
		1603
		1604	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1605	is used.
		1606
1222	=item $windowid = $term->parent	1607	=item $windowid = $term->parent
1223		1608
1224	Return the window id of the toplevel window.	1609	Return the window id of the toplevel window.
1225		1610
1226	=item $windowid = $term->vt	1611	=item $windowid = $term->vt
…		…
1232	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
1233	to receive pointer events all the times:	1618	to receive pointer events all the times:
1234		1619
1235	$term->vt_emask_add (urxvt::PointerMotionMask);	1620	$term->vt_emask_add (urxvt::PointerMotionMask);
1236		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
1237	=item $window_width = $term->width	1636	=item $window_width = $term->width ([$new_value])
1238		1637
1239	=item $window_height = $term->height	1638	=item $window_height = $term->height ([$new_value])
1240		1639
1241	=item $font_width = $term->fwidth	1640	=item $font_width = $term->fwidth ([$new_value])
1242		1641
1243	=item $font_height = $term->fheight	1642	=item $font_height = $term->fheight ([$new_value])
1244		1643
1245	=item $font_ascent = $term->fbase	1644	=item $font_ascent = $term->fbase ([$new_value])
1246		1645
1247	=item $terminal_rows = $term->nrow	1646	=item $terminal_rows = $term->nrow ([$new_value])
1248		1647
1249	=item $terminal_columns = $term->ncol	1648	=item $terminal_columns = $term->ncol ([$new_value])
1250		1649
1251	=item $has_focus = $term->focus	1650	=item $has_focus = $term->focus ([$new_value])
1252		1651
1253	=item $is_mapped = $term->mapped	1652	=item $is_mapped = $term->mapped ([$new_value])
1254		1653
1255	=item $max_scrollback = $term->saveLines	1654	=item $max_scrollback = $term->saveLines ([$new_value])
1256		1655
1257	=item $nrow_plus_saveLines = $term->total_rows	1656	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1258		1657
1259	=item $topmost_scrollback_row = $term->top_row	1658	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1260		1659
1261	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.
1262		1662
1263	=item $x_display = $term->display_id	1663	=item $x_display = $term->display_id
1264		1664
1265	Return the DISPLAY used by rxvt-unicode.	1665	Return the DISPLAY used by rxvt-unicode.
1266		1666
…		…
1271	=item $env = $term->env	1671	=item $env = $term->env
1272		1672
1273	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
1274	similar to C<\%ENV>.	1674	similar to C<\%ENV>.
1275		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
1276	=cut	1685	=cut
1277		1686
1278	sub env {	1687	sub env {
1279	if (my $env = $_[0]->_env) {
1280	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1688	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1281	} else {
1282	+{ %ENV }
1283	}
1284	}	1689	}
1285		1690
1286	=item $modifiermask = $term->ModLevel3Mask	1691	=item $modifiermask = $term->ModLevel3Mask
1287		1692
1288	=item $modifiermask = $term->ModMetaMask	1693	=item $modifiermask = $term->ModMetaMask
1289		1694
1290	=item $modifiermask = $term->ModNumLockMask	1695	=item $modifiermask = $term->ModNumLockMask
1291		1696
1292	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1697	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1293	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1698	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1699
		1700	=item $screen = $term->current_screen
		1701
		1702	Returns the currently displayed screen (0 primary, 1 secondary).
		1703
		1704	=item $cursor_is_hidden = $term->hidden_cursor
		1705
		1706	Returns whether the cursor is currently hidden or not.
		1707
		1708	=item $priv_modes = $term->priv_modes
		1709
		1710	Returns a bitset with the state of DEC private modes.
		1711
		1712	Example:
		1713
		1714	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1715	# mouse reporting is turned on
		1716	}
1294		1717
1295	=item $view_start = $term->view_start ([$newvalue])	1718	=item $view_start = $term->view_start ([$newvalue])
1296		1719
1297	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
1298	C<0>, which displays the normal terminal contents. Lower values scroll	1721	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1304	compare the on-screen display with its stored representation. If they	1727	compare the on-screen display with its stored representation. If they
1305	differ, it redraws the differences.	1728	differ, it redraws the differences.
1306		1729
1307	Used after changing terminal contents to display them.	1730	Used after changing terminal contents to display them.
1308		1731
		1732	=item $term->refresh_check
		1733
		1734	Checks if a refresh has been requested and, if so, schedules one.
		1735
1309	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1736	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1310		1737
1311	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 >>
1312	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
1313	terminal line. The scrollback buffer starts at line C<-1> and extends to
1314	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1740	terminal line. Nothing will be returned if a nonexistent line
1315	is requested.	1741	is requested.
1316		1742
1317	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
1318	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
1319	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
1320	automatically be updated.	1746	automatically be updated.
1321		1747
1322	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
1323	than one cell when displayed are padded with urxvt::NOCHAR characters	1749	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1324	(C<chr 65535>). Characters with combining characters and other characters	1750	characters. Characters with combining characters and other characters that
1325	that do not fit into the normal tetx encoding will be replaced with	1751	do not fit into the normal text encoding will be replaced with characters
1326	characters in the private use area.	1752	in the private use area.
1327		1753
1328	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
1329	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
1330	characters.	1756	characters.
1331		1757
…		…
1415	}	1841	}
1416		1842
1417	sub urxvt::line::t {	1843	sub urxvt::line::t {
1418	my ($self) = @_;	1844	my ($self) = @_;
1419		1845
1420	if (@_ > 1)	1846	if (@_ > 1) {
1421	{
1422	$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})
1423	for $self->{beg} .. $self->{end};	1848	for $self->{beg} .. $self->{end};
1424	}	1849	}
1425		1850
1426	defined wantarray &&	1851	defined wantarray &&
1427	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1852	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1428	0, $self->{len}	1853	0, $self->{len}
1429	}	1854	}
1430		1855
1431	sub urxvt::line::r {	1856	sub urxvt::line::r {
1432	my ($self) = @_;	1857	my ($self) = @_;
1433		1858
1434	if (@_ > 1)	1859	if (@_ > 1) {
1435	{
1436	$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})
1437	for $self->{beg} .. $self->{end};	1861	for $self->{beg} .. $self->{end};
1438	}	1862	}
1439		1863
1440	if (defined wantarray) {	1864	if (defined wantarray) {
1441	my $rend = [	1865	my $rend = [
1442	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1866	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1443	];	1867	];
…		…
1475	where one character corresponds to one screen cell. See	1899	where one character corresponds to one screen cell. See
1476	C<< $term->ROW_t >> for details.	1900	C<< $term->ROW_t >> for details.
1477		1901
1478	=item $string = $term->special_decode $text	1902	=item $string = $term->special_decode $text
1479		1903
1480	Converts rxvt-unicodes text reprsentation into a perl string. See	1904	Converts rxvt-unicodes text representation into a perl string. See
1481	C<< $term->ROW_t >> for details.	1905	C<< $term->ROW_t >> for details.
1482		1906
1483	=item $success = $term->grab_button ($button, $modifiermask)	1907	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1484		1908
		1909	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1910
1485	Registers a synchronous button grab. See the XGrabButton manpage.	1911	Register/unregister a synchronous button grab. See the XGrabButton
		1912	manpage.
1486		1913
1487	=item $success = $term->grab ($eventtime[, $sync])	1914	=item $success = $term->grab ($eventtime[, $sync])
1488		1915
1489	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1916	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1490	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1917	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1491		1918
1492	=item $term->allow_events_async	1919	=item $term->allow_events_async
1493		1920
1494	Calls XAllowEvents with AsyncBoth for the most recent grab.	1921	Calls XAllowEvents with AsyncBoth for the most recent grab.
1495		1922
…		…
1502	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1929	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1503	recent grab.	1930	recent grab.
1504		1931
1505	=item $term->ungrab	1932	=item $term->ungrab
1506		1933
1507	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
1508	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
1509	the session.	1936	the session.
		1937
		1938	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1939
		1940	=item $atom_name = $term->XGetAtomName ($atom)
		1941
		1942	=item @atoms = $term->XListProperties ($window)
		1943
		1944	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1945
		1946	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1947
		1948	=item $term->XDeleteProperty ($window, $property)
		1949
		1950	=item $window = $term->DefaultRootWindow
		1951
		1952	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1953
		1954	=item $term->XMapWindow ($window)
		1955
		1956	=item $term->XUnmapWindow ($window)
		1957
		1958	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1959
		1960	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1961
		1962	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1963
		1964	=item $keysym = $term->XStringToKeysym ($string)
		1965
		1966	=item $string = $term->XKeysymToString ($keysym)
		1967
		1968	Various X or X-related functions. The C<$term> object only serves as
		1969	the source of the display, otherwise those functions map more-or-less
		1970	directly onto the X functions of the same name.
1510		1971
1511	=back	1972	=back
1512		1973
1513	=cut	1974	=cut
1514		1975
…		…
1578	my ($self, $text, $cb) = @_;	2039	my ($self, $text, $cb) = @_;
1579		2040
1580	$self->add_item ({ type => "button", text => $text, activate => $cb});	2041	$self->add_item ({ type => "button", text => $text, activate => $cb});
1581	}	2042	}
1582		2043
1583	=item $popup->add_toggle ($text, $cb, $initial_value)	2044	=item $popup->add_toggle ($text, $initial_value, $cb)
1584		2045
1585	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
1586	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
1587	argument.	2048	first argument.
1588		2049
1589	=cut	2050	=cut
1590		2051
1591	sub add_toggle {	2052	sub add_toggle {
1592	my ($self, $text, $cb, $value) = @_;	2053	my ($self, $text, $value, $cb) = @_;
1593		2054
1594	my $item; $item = {	2055	my $item; $item = {
1595	type => "button",	2056	type => "button",
1596	text => " $text",	2057	text => " $text",
1597	value => $value,	2058	value => $value,
…		…
1616	my $env = $self->{term}->env;	2077	my $env = $self->{term}->env;
1617	# 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.
1618	delete $env->{LC_ALL};	2079	delete $env->{LC_ALL};
1619	$env->{LC_CTYPE} = $self->{term}->locale;	2080	$env->{LC_CTYPE} = $self->{term}->locale;
1620		2081
1621	urxvt::term->new ($env, "popup",	2082	my $term = urxvt::term->new (
		2083	$env, "popup",
1622	"--perl-lib" => "", "--perl-ext-common" => "",	2084	"--perl-lib" => "", "--perl-ext-common" => "",
1623	"-pty-fd" => -1, "-sl" => 0,	2085	"-pty-fd" => -1, "-sl" => 0,
1624	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2086	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1625	"--transient-for" => $self->{term}->parent,	2087	"--transient-for" => $self->{term}->parent,
1626	"-display" => $self->{term}->display_id,	2088	"-display" => $self->{term}->display_id,
1627	"-pe" => "urxvt-popup")	2089	"-pe" => "urxvt-popup",
1628	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	}
1629	}	2097	}
1630		2098
1631	sub DESTROY {	2099	sub DESTROY {
1632	my ($self) = @_;	2100	my ($self) = @_;
1633		2101
1634	delete $self->{term}{_destroy}{$self};	2102	delete $self->{term}{_destroy}{$self};
1635	$self->{term}->ungrab;	2103	$self->{term}->ungrab;
1636	}	2104	}
1637		2105
1638	=back	2106	=back
		2107
		2108	=cut
		2109
		2110	package urxvt::watcher;
1639		2111
1640	=head2 The C<urxvt::timer> Class	2112	=head2 The C<urxvt::timer> Class
1641		2113
1642	This class implements timer watchers/events. Time is represented as a	2114	This class implements timer watchers/events. Time is represented as a
1643	fractional number of seconds since the epoch. Example:	2115	fractional number of seconds since the epoch. Example:
…		…
1647	->new	2119	->new
1648	->interval (1)	2120	->interval (1)
1649	->cb (sub {	2121	->cb (sub {
1650	$term->{overlay}->set (0, 0,	2122	$term->{overlay}->set (0, 0,
1651	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2123	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1652	});	2124	});
1653		2125
1654	=over 4	2126	=over 4
1655		2127
1656	=item $timer = new urxvt::timer	2128	=item $timer = new urxvt::timer
1657		2129
…		…
1660		2132
1661	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2133	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1662		2134
1663	Set the callback to be called when the timer triggers.	2135	Set the callback to be called when the timer triggers.
1664		2136
1665	=item $tstamp = $timer->at
1666
1667	Return the time this watcher will fire next.
1668
1669	=item $timer = $timer->set ($tstamp)	2137	=item $timer = $timer->set ($tstamp[, $interval])
1670		2138
1671	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).
1672		2141
1673	=item $timer = $timer->interval ($interval)	2142	=item $timer = $timer->interval ($interval)
1674		2143
1675	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
1676	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
1677	is automatically rescheduled at the given intervals.	2146	is automatically rescheduled at the given intervals.
1678		2147
1679	=item $timer = $timer->start	2148	=item $timer = $timer->start
1680		2149
1681	Start the timer.	2150	Start the timer.
1682		2151
1683	=item $timer = $timer->start ($tstamp)	2152	=item $timer = $timer->start ($tstamp[, $interval])
1684		2153
1685	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.
1686		2156
1687	=item $timer = $timer->after ($delay)	2157	=item $timer = $timer->after ($delay[, $interval])
1688		2158
1689	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>.
1690		2160
1691	=item $timer = $timer->stop	2161	=item $timer = $timer->stop
1692		2162
…		…
1700		2170
1701	$term->{socket} = ...	2171	$term->{socket} = ...
1702	$term->{iow} = urxvt::iow	2172	$term->{iow} = urxvt::iow
1703	->new	2173	->new
1704	->fd (fileno $term->{socket})	2174	->fd (fileno $term->{socket})
1705	->events (urxvt::EVENT_READ)	2175	->events (urxvt::EV_READ)
1706	->start	2176	->start
1707	->cb (sub {	2177	->cb (sub {
1708	my ($iow, $revents) = @_;	2178	my ($iow, $revents) = @_;
1709	# $revents must be 1 here, no need to check	2179	# $revents must be 1 here, no need to check
1710	sysread $term->{socket}, my $buf, 8192	2180	sysread $term->{socket}, my $buf, 8192
…		…
1723	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>
1724	is a bitset as described in the C<events> method.	2194	is a bitset as described in the C<events> method.
1725		2195
1726	=item $iow = $iow->fd ($fd)	2196	=item $iow = $iow->fd ($fd)
1727		2197
1728	Set the filedescriptor (not handle) to watch.	2198	Set the file descriptor (not handle) to watch.
1729		2199
1730	=item $iow = $iow->events ($eventmask)	2200	=item $iow = $iow->events ($eventmask)
1731		2201
1732	Set the event mask to watch. The only allowed values are	2202	Set the event mask to watch. The only allowed values are
1733	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
1734	together, or C<urxvt::EVENT_NONE>.	2204	together, or C<urxvt::EV_NONE>.
1735		2205
1736	=item $iow = $iow->start	2206	=item $iow = $iow->start
1737		2207
1738	Start watching for requested events on the given handle.	2208	Start watching for requested events on the given handle.
1739		2209
1740	=item $iow = $iow->stop	2210	=item $iow = $iow->stop
1741		2211
1742	Stop watching for events on the given filehandle.	2212	Stop watching for events on the given file handle.
		2213
		2214	=back
		2215
		2216	=head2 The C<urxvt::iw> Class
		2217
		2218	This class implements idle watchers, that get called automatically when
		2219	the process is idle. They should return as fast as possible, after doing
		2220	some useful work.
		2221
		2222	=over 4
		2223
		2224	=item $iw = new urxvt::iw
		2225
		2226	Create a new idle watcher object in stopped state.
		2227
		2228	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2229
		2230	Set the callback to be called when the watcher triggers.
		2231
		2232	=item $timer = $timer->start
		2233
		2234	Start the watcher.
		2235
		2236	=item $timer = $timer->stop
		2237
		2238	Stop the watcher.
		2239
		2240	=back
		2241
		2242	=head2 The C<urxvt::pw> Class
		2243
		2244	This class implements process watchers. They create an event whenever a
		2245	process exits, after which they stop automatically.
		2246
		2247	my $pid = fork;
		2248	...
		2249	$term->{pw} = urxvt::pw
		2250	->new
		2251	->start ($pid)
		2252	->cb (sub {
		2253	my ($pw, $exit_status) = @_;
		2254	...
		2255	});
		2256
		2257	=over 4
		2258
		2259	=item $pw = new urxvt::pw
		2260
		2261	Create a new process watcher in stopped state.
		2262
		2263	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2264
		2265	Set the callback to be called when the timer triggers.
		2266
		2267	=item $pw = $timer->start ($pid)
		2268
		2269	Tells the watcher to start watching for process C<$pid>.
		2270
		2271	=item $pw = $pw->stop
		2272
		2273	Stop the watcher.
1743		2274
1744	=back	2275	=back
1745		2276
1746	=head1 ENVIRONMENT	2277	=head1 ENVIRONMENT
1747		2278
…		…
1756		2287
1757	=item >= 3 - script loading and management	2288	=item >= 3 - script loading and management
1758		2289
1759	=item >=10 - all called hooks	2290	=item >=10 - all called hooks
1760		2291
1761	=item >=11 - hook reutrn values	2292	=item >=11 - hook return values
1762		2293
1763	=back	2294	=back
1764		2295
1765	=head1 AUTHOR	2296	=head1 AUTHOR
1766		2297
1767	Marc Lehmann <pcg@goof.com>	2298	Marc Lehmann <schmorp@schmorp.de>
1768	http://software.schmorp.de/pkg/rxvt-unicode	2299	http://software.schmorp.de/pkg/rxvt-unicode
1769		2300
1770	=cut	2301	=cut
1771		2302
1772	1	2303	1
		2304
		2305	# vim: sw=3:

Diff Legend

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