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

Diff Legend

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