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.89 by root, Thu Jan 12 12:10:06 2006 UTC vs.
Revision 1.260 by root, Mon May 24 20:21:51 2021 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 the following bindable keyboard command:
72
73	=over 4
74
75	=item rot13
76
77	Rot-13 the selection when activated. Used via keyboard trigger:
78
79	URxvt.keysym.C-M-r: perl:selection:rot13
80
81	=back
82
83	=item option-popup (enabled by default)
84
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.
87
88	=item selection-popup (enabled by default)
89
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.
93
94	=item searchable-scrollback<hotkey> (enabled by default)
95
96	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
98	input/output is suspended and a regex is displayed at the bottom of the
99	screen.
100
101	Inputting characters appends them to the regex and continues incremental
102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
104	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary
107	selection.
108
109	=item selection-autotransform
110
111	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.
113
114	It works by specifying perl snippets (most useful is a single C<s///>
115	operator) that modify C<$_> as resources:
116
117	URxvt.selection-autotransform.0: transform
118	URxvt.selection-autotransform.1: transform
119	...
120
121	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:
124
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:
129
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131
132	=item mark-urls
133
134	Uses per-line display filtering (C<on_line_update>) to underline urls and
135	make them clickable. When middle-clicked, the program specified in the
136	resource C<urlLauncher> (default C<x-www-browser>) will be started with
137	the URL as first argument.
138
139	=item block-graphics-to-ascii
140
141	A not very useful example of filtering all text output to the terminal,
142	by replacing all line-drawing characters (U+2500 .. U+259F) by a
143	similar-looking ascii character.
144
145	=item digital-clock
146
147	Displays a digital clock using the built-in overlay.
148
149	=item example-refresh-hooks
150
151	Displays a very simple digital clock in the upper right corner of the
152	window. Illustrates overwriting the refresh callbacks to create your own
153	overlays or changes.
154
155	=back
156		56
157	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
158		58
159	=head2 General API Considerations	59	=head2 General API Considerations
160		60
…		…
174		74
175	=over 4	75	=over 4
176		76
177	=item $text	77	=item $text
178		78
179	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
180	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.
181		81
182	=item $string	82	=item $string
183		83
184	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
…		…
188	=item $octets	88	=item $octets
189		89
190	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
191	locale-specific way.	91	locale-specific way.
192		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
193	=back	99	=back
194		100
195	=head2 Extension Objects	101	=head2 Extension Objects
196		102
197	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
198	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,
199	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
200	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
201	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
202	use.	109	internal use.
203		110
204	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
205	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
206		113
207	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:
208		125
209	=over 4	126	=over 4
210		127
211	=item $urxvt_term = $self->{term}	128	=item #:META:RESOURCE:name:type:desc
212		129
213	Returns the C<urxvt::term> object associated with this instance of the	130	The RESOURCE comment defines a resource used by the extension, where
214	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.
215		133
216	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	134	The extension will be autoloaded when this resource is specified or used
217		135	as a command line parameter.
218	Dynamically enable the given hooks (named without the C<on_> prefix) for
219	this extension, replacing any previous hook. This is useful when you want
220	to overwrite time-critical hooks only temporarily.
221
222	=item $self->disable ($hook_name[, $hook_name..])
223
224	Dynamically disable the given hooks.
225		136
226	=back	137	=back
227		138
228	=head2 Hooks	139	=head2 Hooks
229		140
230	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
231	called whenever the relevant event happens.	142	called whenever the relevant event happens.
232		143
233	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
234	the in the C<Extension Objects> section.	145	the in the C<Extension Objects> section.
235		146
236	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
237	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
238	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.
239		150
240	I<< When in doubt, return a false value (preferably C<()>). >>	151	I<< When in doubt, return a false value (preferably C<()>). >>
241		152
242	=over 4	153	=over 4
243		154
244	=item on_init $term	155	=item on_init $term
245		156
246	Called after a new terminal object has been initialized, but before	157	Called after a new terminal object has been initialized, but before
247	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
248	call or deliver senseless data, as terminal size and other characteristics	159	call or deliver senseless data, as terminal size and other characteristics
249	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
250	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).
251		173
252	=item on_reset $term	174	=item on_reset $term
253		175
254	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
255	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
256	variables.	178	variables.
257		179
258	=item on_start $term	180	=item on_child_start $term, $pid
259		181
260	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.
261	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>.
262		188
263	=item on_sel_make $term, $eventtime	189	=item on_sel_make $term, $eventtime
264		190
265	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
266	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
…		…
273		199
274	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
275	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
276	by calling C<< $term->selection >>.	202	by calling C<< $term->selection >>.
277		203
278	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.
279		205
280	=item on_sel_extend $term	206	=item on_sel_extend $term
281		207
282	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
283	click) and is either supposed to return false (normal operation), or	209	click) and is either supposed to return false (normal operation), or
284	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
285	processing. This can happen multiple times, as long as the callback	211	processing. This can happen multiple times, as long as the callback
286	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
287	supposed to enlarge the selection more and more, if possible.	213	supposed to enlarge the selection more and more, if possible.
288		214
289	See the F<selection> example extension.	215	See the F<selection> example extension.
290		216
291	=item on_view_change $term, $offset	217	=item on_view_change $term, $offset
292		218
293	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
294	scrolls. Offset C<0> means display the normal terminal, positive values	220	scrolls. Offset C<0> means display the normal terminal, positive values
295	show this many lines of scrollback.	221	show this many lines of scrollback.
296		222
297	=item on_scroll_back $term, $lines, $saved	223	=item on_scroll_back $term, $lines, $saved
298		224
…		…
302		228
303	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,
304	$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
305	number of lines that will be in the scrollback buffer.	231	number of lines that will be in the scrollback buffer.
306		232
307	=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
308		244
309	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	245	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
310	operating system command) is processed. Cursor position and other state	246	operating system command) is processed. Cursor position and other state
311	information is up-to-date when this happens. For interoperability, the	247	information is up-to-date when this happens. For interoperability, the
312	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,
313	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
314	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	}
315		261
316	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,
317	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
318	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.
319		268
320	=item on_add_lines $term, $string	269	=item on_add_lines $term, $string
321		270
322	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
323	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
…		…
328	=item on_tt_write $term, $octets	277	=item on_tt_write $term, $octets
329		278
330	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
331	suppress or filter tty input.	280	suppress or filter tty input.
332		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
333	=item on_line_update $term, $row	289	=item on_line_update $term, $row
334		290
335	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
336	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
337	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,
…		…
344	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
345	you cannot just toggle rendition bits, but only set them.	301	you cannot just toggle rendition bits, but only set them.
346		302
347	=item on_refresh_begin $term	303	=item on_refresh_begin $term
348		304
349	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
350	or similar effects by modify terminal contents in refresh_begin, and	306	similar effects by modifying the terminal contents in refresh_begin, and
351	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
352	code is run after this hook, and takes precedence.	308	code is run after this hook, and takes precedence.
353		309
354	=item on_refresh_end $term	310	=item on_refresh_end $term
355		311
356	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>.
357		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
358	=item on_keyboard_command $term, $string	322	=item on_user_command $term, $string *DEPRECATED*
359		323
360	Called whenever the user presses a key combination that has a	324	Called whenever a user-configured event is being activated (e.g. via
361	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>
362	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.
		336
		337	=item on_x_event $term, $event
		338
		339	Called on every X event received on the vt window (and possibly other
		340	windows). Should only be used as a last resort. Most event structure
		341	members are not passed.
		342
		343	=item on_root_event $term, $event
		344
		345	Like C<on_x_event>, but is called for events on the root window.
363		346
364	=item on_focus_in $term	347	=item on_focus_in $term
365		348
366	Called whenever the window gets the keyboard focus, before rxvt-unicode	349	Called whenever the window gets the keyboard focus, before rxvt-unicode
367	does focus in processing.	350	does focus in processing.
368		351
369	=item on_focus_out $term	352	=item on_focus_out $term
370		353
371	Called wheneever the window loses keyboard focus, before rxvt-unicode does	354	Called whenever the window loses keyboard focus, before rxvt-unicode does
372	focus out processing.	355	focus out processing.
373		356
		357	=item on_configure_notify $term, $event
		358
		359	=item on_property_notify $term, $event
		360
374	=item on_key_press $term, $event, $keysym, $octets	361	=item on_key_press $term, $event, $keysym, $octets
375		362
376	=item on_key_release $term, $event, $keysym	363	=item on_key_release $term, $event, $keysym
377		364
378	=item on_button_press $term, $event	365	=item on_button_press $term, $event
…		…
383		370
384	=item on_map_notify $term, $event	371	=item on_map_notify $term, $event
385		372
386	=item on_unmap_notify $term, $event	373	=item on_unmap_notify $term, $event
387		374
388	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
389	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.
390		377
391	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
392	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
393	and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
394		381
395	C<on_key_press> additionally receives the string rxvt-unicode would	382	C<on_key_press> additionally receives the string rxvt-unicode would
396	output, if any, in locale-specific encoding.	383	output, if any, in locale-specific encoding.
397		384
398	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.
399		397
400	=back	398	=back
401		399
402	=cut	400	=cut
403		401
404	package urxvt;	402	package urxvt;
405		403
406	use utf8;	404	use utf8;
407	use strict;	405	use strict 'vars';
408	use Carp ();	406	use Carp ();
409	use Scalar::Util ();	407	use Scalar::Util ();
410	use List::Util ();	408	use List::Util ();
411		409
412	our $VERSION = 1;	410	our $VERSION = 1;
413	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.
414	our @HOOKNAME;	414	our @HOOKNAME;
415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
416	our %OPTION;	416	our %OPTION;
417		417
418	our $LIBDIR;	418	our $LIBDIR;
419	our $RESNAME;	419	our $RESNAME;
420	our $RESCLASS;	420	our $RESCLASS;
421	our $RXVTNAME;	421	our $RXVTNAME;
422		422
		423	our $NOCHAR = chr 0xffff;
		424
423	=head2 Variables in the C<urxvt> Package	425	=head2 Variables in the C<urxvt> Package
424		426
425	=over 4	427	=over 4
426		428
427	=item $urxvt::LIBDIR	429	=item $urxvt::LIBDIR
…		…
440	=item $urxvt::TERM	442	=item $urxvt::TERM
441		443
442	The current terminal. This variable stores the current C<urxvt::term>	444	The current terminal. This variable stores the current C<urxvt::term>
443	object, whenever a callback/hook is executing.	445	object, whenever a callback/hook is executing.
444		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
445	=back	463	=back
446		464
447	=head2 Functions in the C<urxvt> Package	465	=head2 Functions in the C<urxvt> Package
448		466
449	=over 4	467	=over 4
450		468
451	=item urxvt::fatal $errormessage	469	=item urxvt::fatal $errormessage
452		470
453	Fatally aborts execution with the given error message. Avoid at all	471	Fatally aborts execution with the given error message (which should
454	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
455	starts up.	473	is acceptable (and useful) is in the init hook, where it prevents the
		474	terminal from starting up.
456		475
457	=item urxvt::warn $string	476	=item urxvt::warn $string
458		477
459	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
460	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
461	that calls this function.	480	that calls this function.
462		481
463	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
464	correct place, e.g. on stderr of the connecting urxvtc client.	483	correct place, e.g. on stderr of the connecting urxvtc client.
465		484
466	Messages have a size limit of 1023 bytes currently.	485	Messages have a size limit of 1023 bytes currently.
467		486
468	=item $is_safe = urxvt::safe	487	=item @terms = urxvt::termlist
469		488
470	Returns true when it is safe to do potentially unsafe things, such as	489	Returns all urxvt::term objects that exist in this process, regardless of
471	evaluating perl code specified by the user. This is true when urxvt was	490	whether they are started, being destroyed etc., so be careful. Only term
472	started setuid or setgid.	491	objects that have perl extensions attached will be returned (because there
		492	is no urxvt::term object associated with others).
473		493
474	=item $time = urxvt::NOW	494	=item $time = urxvt::NOW
475		495
476	Returns the "current time" (as per the event loop).	496	Returns the "current time" (as per the event loop).
477		497
…		…
479		499
480	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	500	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
481	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	501	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
482	Button4Mask, Button5Mask, AnyModifier	502	Button4Mask, Button5Mask, AnyModifier
483		503
		504	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		505	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		506	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		507	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		508	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		509	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		510	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		511
		512	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		513	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		514	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		515	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		516	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		519
484	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
		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_ExtMouseUTF8,
		529	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		530	PrivMode_Default
		531
		532	Constants for checking DEC private modes.
485		533
486	=back	534	=back
487		535
488	=head2 RENDITION	536	=head2 RENDITION
489		537
…		…
504		552
505	=item $rend = urxvt::OVERLAY_RSTYLE	553	=item $rend = urxvt::OVERLAY_RSTYLE
506		554
507	Return the rendition mask used for overlays by default.	555	Return the rendition mask used for overlays by default.
508		556
509	=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
510		559
511	Return the bit that enabled bold, italic, blink, reverse-video and	560	Return the bit that enabled bold, italic, blink, reverse-video and
512	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
513	the bitset.	562	the bitset.
514		563
…		…
520		569
521	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	570	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
522		571
523	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	572	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
524		573
		574	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		575
525	Replace the foreground/background colour in the rendition mask with the	576	Replace the foreground/background colour in the rendition mask with the
526	specified one.	577	specified one.
527		578
528	=item $value = urxvt::GET_CUSTOM $rend	579	=item $value = urxvt::GET_CUSTOM $rend
529		580
…		…
538	=back	589	=back
539		590
540	=cut	591	=cut
541		592
542	BEGIN {	593	BEGIN {
543	urxvt->bootstrap;
544
545	# overwrite perl's warn	594	# overwrite perl's warn
546	*CORE::GLOBAL::warn = sub {	595	*CORE::GLOBAL::warn = sub {
547	my $msg = join "", @_;	596	my $msg = join "", @_;
548	$msg .= "\n"	597	$msg .= "\n"
549	unless $msg =~ /\n$/;	598	unless $msg =~ /\n$/;
550	urxvt::warn ($msg);	599	urxvt::warn ($msg);
551	};	600	};
552
553	# %ENV is the original startup environment
554	delete $ENV{IFS};
555	delete $ENV{CDPATH};
556	delete $ENV{BASH_ENV};
557	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
558	}	601	}
559		602
560	my @hook_count;	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
561	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	671	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
562		672
563	sub verbose {	673	sub verbose {
564	my ($level, $msg) = @_;	674	my ($level, $msg) = @_;
565	warn "$msg\n" if $level <= $verbosity;	675	warn "$msg\n" if $level <= $verbosity;
566	}	676	}
567		677
568	my $extension_pkg = "extension0000";
569	my %extension_pkg;	678	my %extension_pkg;
570		679
571	# load a single script into its own package, once only	680	# load a single script into its own package, once only
572	sub extension_package($) {	681	sub extension_package($) {
573	my ($path) = @_;	682	my ($path) = @_;
574		683
575	$extension_pkg{$path} ||= do {	684	$extension_pkg{$path} ||= do {
576	my $pkg = "urxvt::" . ($extension_pkg++);	685	$path =~ /([^\/\\]+)$/;
		686	my $pkg = $1;
		687	$pkg =~ s/[^[:word:]]/_/g;
		688	$pkg = "urxvt::ext::$pkg";
577		689
578	verbose 3, "loading extension '$path' into package '$pkg'";	690	verbose 3, "loading extension '$path' into package '$pkg'";
		691
		692	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
579		693
580	open my $fh, "<:raw", $path	694	open my $fh, "<:raw", $path
581	or die "$path: $!";	695	or die "$path: $!";
582		696
583	my $source = untaint	697	my $source =
584	"package $pkg; use strict; use utf8;\n"	698	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
585	. "use base urxvt::term::extension::;\n"
586	. "#line 1 \"$path\"\n{\n"	699	. "#line 1 \"$path\"\n{\n"
587	. (do { local $/; <$fh> })	700	. (do { local $/; <$fh> })
588	. "\n};\n1";	701	. "\n};\n1";
589		702
590	eval $source	703	eval $source
…		…
599	# called by the rxvt core	712	# called by the rxvt core
600	sub invoke {	713	sub invoke {
601	local $TERM = shift;	714	local $TERM = shift;
602	my $htype = shift;	715	my $htype = shift;
603		716
604	if ($htype == 0) { # INIT	717	if ($htype == HOOK_INIT) {
605	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	718	my @dirs = $TERM->perl_libdirs;
606		719
		720	$TERM->scan_extensions;
		721
607	my %ext_arg;	722	my %ext_arg;
608		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 (
		734	@{ delete $TERM->{perl_ext_3} },
609	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	735	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		736	) {
610	if ($_ eq "default") {	737	if ($_ eq "default") {
		738
		739	$ext_arg{$_} = []
611	$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
612	} elsif (/^-(.*)$/) {	751	} elsif (/^-(.*)$/) {
613	delete $ext_arg{$1};	752	delete $ext_arg{$1};
		753
614	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
615	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
		756
616	} else {	757	} else {
617	$ext_arg{$_} ||= [];	758	$ext_arg{$_} ||= [];
618	}	759	}
619	}	760	}
620		761
621	while (my ($ext, $argv) = each %ext_arg) {	762	for my $ext (sort keys %ext_arg) {
622	my @files = grep -f $_, map "$_/$ext", @dirs;	763	my @files = grep -f $_, map "$_/$ext", @dirs;
623		764
624	if (@files) {	765	if (@files) {
625	$TERM->register_package (extension_package $files[0], $argv);	766	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
626	} else {	767	} else {
627	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";
628	}	769	}
629	}	770	}
630		771
…		…
636		777
637	if (my $cb = $TERM->{_hook}[$htype]) {	778	if (my $cb = $TERM->{_hook}[$htype]) {
638	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	779	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
639	if $verbosity >= 10;	780	if $verbosity >= 10;
640		781
641	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";
642		788
643	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) {
644	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	796	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
645	and last;	797	$retval ||= $retval_;
646		798
647	if ($@) {	799	if ($@) {
648	$TERM->ungrab; # better to lose the grab than the session	800	$TERM->ungrab; # better to lose the grab than the session
649	warn $@;	801	warn $@;
650	}	802	}
…		…
652		804
653	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	805	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
654	if $verbosity >= 11;	806	if $verbosity >= 11;
655	}	807	}
656		808
657	if ($htype == 1) { # DESTROY	809	if ($htype == HOOK_DESTROY) {
658	if (my $hook = delete $TERM->{_hook}) {
659	for my $htype (0..$#$hook) {
660	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
661	or set_should_invoke $htype, 0;
662	}
663	}
664
665	# clear package objects	810	# clear package objects
666	%$_ = () for values %{ $TERM->{_pkg} };	811	%$_ = () for values %{ $TERM->{_pkg} };
667		812
668	# clear package	813	# clear package
669	%$TERM = ();	814	%$TERM = ();
670	}	815	}
671		816
672	$retval	817	$retval
673	}	818	}
674		819
675	sub exec_async(@) {	820	sub SET_COLOR($$$) {
676	my $pid = fork;	821	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
677
678	return
679	if !defined $pid or $pid;
680
681	%ENV = %{ $TERM->env };
682
683	exec @_;
684	_exit 255;
685	}	822	}
686		823
687	# urxvt::term::extension	824	sub rend2mask {
688		825	no strict 'refs';
689	package urxvt::term::extension;	826	my ($str, $mask) = (@_, 0);
690		827	my %color = ( fg => undef, bg => undef );
691	sub enable {	828	my @failed;
692	my ($self, %hook) = @_;	829	for my $spec ( split /\s+/, $str ) {
693	my $pkg = $self->{_pkg};	830	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
694		831	$color{lc($1)} = $2;
695	while (my ($name, $cb) = each %hook) {	832	} else {
696	my $htype = $HOOKTYPE{uc $name};	833	my $neg = $spec =~ s/^[-^]//;
697	defined $htype	834	unless ( exists &{"RS_$spec"} ) {
698	or Carp::croak "unsupported hook type '$name'";	835	push @failed, $spec;
699		836	next;
700	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
701	$hook_count[$htype]++
702	or urxvt::set_should_invoke $htype, 1;
703	}	837	}
704		838	my $cur = &{"RS_$spec"};
705	$self->{term}{_hook}[$htype]{$pkg} = $cb;	839	if ( $neg ) {
706	}	840	$mask &= ~$cur;
707	}	841	} else {
708		842	$mask |= $cur;
709	sub disable {	843	}
710	my ($self, @hook) = @_;
711	my $pkg = $self->{_pkg};
712
713	for my $name (@hook) {
714	my $htype = $HOOKTYPE{uc $name};
715	defined $htype
716	or Carp::croak "unsupported hook type '$name'";
717
718	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
719	--$hook_count[$htype]
720	or urxvt::set_should_invoke $htype, 0;
721	}	844	}
722	}	845	}
		846	($mask, @color{qw(fg bg)}, \@failed)
723	}	847	}
		848
		849	package urxvt::term::extension;
		850
		851	=head2 The C<urxvt::term::extension> class
		852
		853	Each extension attached to a terminal object is represented by
		854	a C<urxvt::term::extension> object.
		855
		856	You can use these objects, which are passed to all callbacks to store any
		857	state related to the terminal and extension instance.
		858
		859	The methods (And data members) documented below can be called on extension
		860	objects, in addition to call methods documented for the <urxvt::term>
		861	class.
		862
		863	=over 4
		864
		865	=item $urxvt_term = $self->{term}
		866
		867	Returns the C<urxvt::term> object associated with this instance of the
		868	extension. This member I<must not> be changed in any way.
		869
		870	=cut
724		871
725	our $AUTOLOAD;	872	our $AUTOLOAD;
726		873
727	sub AUTOLOAD {	874	sub AUTOLOAD {
728	$AUTOLOAD =~ /:([^:]+)$/	875	$AUTOLOAD =~ /:([^:]+)$/
…		…
741		888
742	sub DESTROY {	889	sub DESTROY {
743	# nop	890	# nop
744	}	891	}
745		892
746	# urxvt::destroy_hook	893	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
747		894
748	sub urxvt::destroy_hook::DESTROY {	895	sub urxvt::destroy_hook::DESTROY {
749	${$_[0]}->();	896	${$_[0]}->();
750	}	897	}
751		898
752	sub urxvt::destroy_hook(&) {	899	sub urxvt::destroy_hook(&) {
753	bless \shift, urxvt::destroy_hook::	900	bless \shift, urxvt::destroy_hook::
754	}	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
755		1025
756	package urxvt::anyevent;	1026	package urxvt::anyevent;
757		1027
758	=head2 The C<urxvt::anyevent> Class	1028	=head2 The C<urxvt::anyevent> Class
759		1029
760	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
761	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
762	further programming. The only exception is that you cannot wait on	1032	further programming. The only exception is that you cannot wait on
763	condition variables, but non-blocking condvar use is ok. What this means	1033	condition variables, but non-blocking condvar use is ok.
764	is that you cannot use blocking APIs, but the non-blocking variant should
765	work.
766		1034
767	=cut	1035	In practical terms this means is that you cannot use blocking APIs, but
		1036	the non-blocking variant should work.
768		1037
		1038	=cut
		1039
769	our $VERSION = 1;	1040	our $VERSION = '5.23';
770		1041
771	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1042	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
772	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1043	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
773		1044
774	sub timer {	1045	sub timer {
…		…
776		1047
777	my $cb = $arg{cb};	1048	my $cb = $arg{cb};
778		1049
779	urxvt::timer	1050	urxvt::timer
780	->new	1051	->new
781	->start (urxvt::NOW + $arg{after})	1052	->after ($arg{after}, $arg{interval})
782	->cb (sub {	1053	->cb ($arg{interval} ? $cb : sub {
783	$_[0]->stop; # need to cancel manually	1054	$_[0]->stop; # need to cancel manually
784	$cb->();	1055	$cb->();
785	})	1056	})
786	}	1057	}
787		1058
788	sub io {	1059	sub io {
789	my ($class, %arg) = @_;	1060	my ($class, %arg) = @_;
790		1061
791	my $cb = $arg{cb};	1062	my $cb = $arg{cb};
		1063	my $fd = fileno $arg{fh};
		1064	defined $fd or $fd = $arg{fh};
792		1065
793	bless [$arg{fh}, urxvt::iow	1066	bless [$arg{fh}, urxvt::iow
794	->new	1067	->new
795	->fd (fileno $arg{fh})	1068	->fd ($fd)
796	->events (($arg{poll} =~ /r/ ? 1 : 0)	1069	->events (($arg{poll} =~ /r/ ? 1 : 0)
797	| ($arg{poll} =~ /w/ ? 2 : 0))	1070	| ($arg{poll} =~ /w/ ? 2 : 0))
798	->start	1071	->start
799	->cb (sub {	1072	->cb ($cb)
800	$cb->(($_[1] & 1 ? 'r' : '')
801	. ($_[1] & 2 ? 'w' : ''));
802	})],
803	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	})
804	}	1099	}
805		1100
806	sub DESTROY {	1101	sub DESTROY {
807	$_[0][1]->stop;	1102	$_[0][1]->stop;
808	}	1103	}
809		1104
810	sub condvar {	1105	# only needed for AnyEvent < 6 compatibility
811	bless \my $flag, urxvt::anyevent::condvar::	1106	sub one_event {
812	}
813
814	sub urxvt::anyevent::condvar::broadcast {
815	${$_[0]}++;
816	}
817
818	sub urxvt::anyevent::condvar::wait {
819	unless (${$_[0]}) {
820	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";
821	}
822	}	1108	}
823		1109
824	package urxvt::term;	1110	package urxvt::term;
825		1111
826	=head2 The C<urxvt::term> Class	1112	=head2 The C<urxvt::term> Class
…		…
832	# find on_xxx subs in the package and register them	1118	# find on_xxx subs in the package and register them
833	# as hooks	1119	# as hooks
834	sub register_package {	1120	sub register_package {
835	my ($self, $pkg, $argv) = @_;	1121	my ($self, $pkg, $argv) = @_;
836		1122
		1123	no strict 'refs';
		1124
		1125	urxvt::verbose 6, "register package $pkg to $self";
		1126
		1127	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1128
837	my $proxy = bless {	1129	my $proxy = bless {
838	_pkg => $pkg,	1130	_pkg => $pkg,
		1131	_name => ${"$pkg\::_NAME"}, # hackish
839	argv => $argv,	1132	argv => $argv,
840	}, $pkg;	1133	}, $pkg;
841	Scalar::Util::weaken ($proxy->{term} = $self);	1134	Scalar::Util::weaken ($proxy->{term} = $self);
842		1135
843	$self->{_pkg}{$pkg} = $proxy;	1136	$self->{_pkg}{$pkg} = $proxy;
844		1137
…		…
847	$proxy->enable ($name => $ref);	1140	$proxy->enable ($name => $ref);
848	}	1141	}
849	}	1142	}
850	}	1143	}
851		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
852	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
853		1221
854	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
855	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
856	hash which defines the environment of the new terminal.	1224	hash which defines the environment of the new terminal.
857		1225
858	Croaks (and probably outputs an error message) if the new instance	1226	Croaks (and probably outputs an error message) if the new instance
859	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
860	initialise perl, and the terminal object otherwise. The C<init> and	1228	initialise perl, and the terminal object otherwise. The C<init> and
861	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).
862		1231
863	=cut	1232	=cut
864		1233
865	sub new {	1234	sub new {
866	my ($class, $env, @args) = @_;	1235	my ($class, $env, @args) = @_;
867		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
868	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1240	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
869	}	1241	}
870		1242
871	=item $term->destroy	1243	=item $term->destroy
872		1244
873	Destroy the terminal object (close the window, free resources	1245	Destroy the terminal object (close the window, free resources
874	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
875	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	}
876		1273
877	=item $isset = $term->option ($optval[, $set])	1274	=item $isset = $term->option ($optval[, $set])
878		1275
879	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
880	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
881	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.
882		1279
883	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
884	source file F</src/optinc.h> to see the actual list:	1281	source file F</src/optinc.h> to see the actual list:
885		1282
886	borderLess console cursorBlink cursorUnderline hold iconic insecure	1283	borderLess buffered console cursorBlink cursorUnderline hold iconic
887	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1284	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1285	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
888	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1286	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
889	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1287	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
890	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1288	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
891	tripleclickwords utmpInhibit visualBell	1289	urgentOnBell utmpInhibit visualBell
892		1290
893	=item $value = $term->resource ($name[, $newval])	1291	=item $value = $term->resource ($name[, $newval])
894		1292
895	Returns the current resource value associated with a given name and	1293	Returns the current resource value associated with a given name and
896	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>
…		…
905	likely change).	1303	likely change).
906		1304
907	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
908	terminal is destroyed, so changing options frequently will eat memory.	1306	terminal is destroyed, so changing options frequently will eat memory.
909		1307
910	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
911	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>
912	to see the actual list:	1310	to see the actual list:
913		1311
914	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1312	answerbackstring backgroundPixmap backspace_key blurradius
915	borderLess color cursorBlink cursorUnderline cutchars delete_key	1313	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
916	display_name embed ext_bwidth fade font geometry hold iconName	1314	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
917	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
918	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1317	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
919	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1318	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
920	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1319	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
921	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1320	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
922	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1321	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
923	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1322	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
924	shade term_name title transparent transparent_all tripleclickwords	1323	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1324	term_name title transient_for transparent tripleclickwords urgentOnBell
925	utmpInhibit visualBell	1325	utmpInhibit visualBell
926		1326
927	=cut	1327	=cut
928		1328
929	sub resource($$;$) {	1329	sub resource($$;$) {
930	my ($self, $name) = (shift, shift);	1330	my ($self, $name) = (shift, shift);
931	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1331	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
932	&urxvt::term::_resource	1332	goto &urxvt::term::_resource
933	}	1333	}
934		1334
935	=item $value = $term->x_resource ($pattern)	1335	=item $value = $term->x_resource ($pattern)
936		1336
937	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
938	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
939	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
940	resource with that pattern exists.	1340	resource with that pattern exists.
941		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
942	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
943	only one resource database per display, and later invocations might return	1353	only one resource database per display, and later invocations might return
944	the wrong resources.	1354	the wrong resources.
945		1355
946	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1356	=item $value = $term->x_resource_boolean ($pattern)
947		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
948	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
949	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	}
950		1396
951	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
952		1398
953	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
954	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
962		1408
963	=item ($row, $col) = $term->selection_beg ([$row, $col])	1409	=item ($row, $col) = $term->selection_beg ([$row, $col])
964		1410
965	=item ($row, $col) = $term->selection_end ([$row, $col])	1411	=item ($row, $col) = $term->selection_end ([$row, $col])
966		1412
967	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.
968	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.
969		1422
970	=item $term->selection_make ($eventtime[, $rectangular])	1423	=item $term->selection_make ($eventtime[, $rectangular])
971		1424
972	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
973	C<selection_end>. If C<$rectangular> is true (default: false), a	1426	C<selection_end>. If C<$rectangular> is true (default: false), a
974	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
975	a selection.	1428	a selection.
976		1429
977	=item $success = $term->selection_grab ($eventtime)	1430	=item $success = $term->selection_grab ($eventtime[, $clipboard])
978		1431
979	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
980	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
981	is mostly useful from within C<on_sel_grab> hooks.	1435	is mostly useful from within C<on_sel_grab> hooks.
982		1436
983	=item $oldtext = $term->selection ([$newtext])	1437	=item $oldtext = $term->selection ([$newtext, $clipboard])
984		1438
985	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.
986		1445
987	=item $term->overlay_simple ($x, $y, $text)	1446	=item $term->overlay_simple ($x, $y, $text)
988		1447
989	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.
990		1449
…		…
1020		1479
1021	The methods currently supported on C<urxvt::overlay> objects are:	1480	The methods currently supported on C<urxvt::overlay> objects are:
1022		1481
1023	=over 4	1482	=over 4
1024		1483
1025	=item $overlay->set ($x, $y, $text, $rend)	1484	=item $overlay->set ($x, $y, $text[, $rend])
1026		1485
1027	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
1028	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
1029	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.
1030		1491
1031	=item $overlay->hide	1492	=item $overlay->hide
1032		1493
1033	If visible, hide the overlay, but do not destroy it.	1494	If visible, hide the overlay, but do not destroy it.
1034		1495
…		…
1097		1558
1098	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1099		1560
1100	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
1101	running inside the terminal. It may not contain command sequences (escape	1562	running inside the terminal. It may not contain command sequences (escape
1102	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,
1103	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.
1104		1566
1105	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
1106	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
1107	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1108		1570
		1571	=item $term->scr_change_screen ($screen)
		1572
		1573	Switch to given screen - 0 primary, 1 secondary.
		1574
1109	=item $term->cmd_parse ($octets)	1575	=item $term->cmd_parse ($octets)
1110		1576
1111	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
1112	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1113	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1114		1580
1115	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1116		1582
1117	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
1118	pass characters instead of octets, you should convert your strings first	1585	characters instead of octets, you should convert your strings first to the
1119	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.
1120		1601
1121	=item $old_events = $term->pty_ev_events ([$new_events])	1602	=item $old_events = $term->pty_ev_events ([$new_events])
1122		1603
1123	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
1124	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
1125	description of C<< urxvt::timer->events >>. Make sure to always restore	1606	description of C<< urxvt::timer->events >>. Make sure to always restore
1126	the previous value.	1607	the previous value.
1127		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
1128	=item $windowid = $term->parent	1614	=item $windowid = $term->parent
1129		1615
1130	Return the window id of the toplevel window.	1616	Return the window id of the toplevel window.
1131		1617
1132	=item $windowid = $term->vt	1618	=item $windowid = $term->vt
1133		1619
1134	Return the window id of the terminal window.	1620	Return the window id of the terminal window.
1135		1621
		1622	=item $term->vt_emask_add ($x_event_mask)
		1623
		1624	Adds the specified events to the vt event mask. Useful e.g. when you want
		1625	to receive pointer events all the times:
		1626
		1627	$term->vt_emask_add (urxvt::PointerMotionMask);
		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
1136	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1137		1644
1138	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1139		1646
1140	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1141		1648
1142	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1143		1650
1144	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1145		1652
1146	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1147		1654
1148	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1149		1656
1150	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1151		1658
1152	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1153		1660
1154	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1155		1662
1156	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1157		1664
1158	=item $lines_in_scrollback = $term->nsaved	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1159		1666
1160	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.
1161		1669
1162	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1163		1671
1164	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1165		1673
…		…
1170	=item $env = $term->env	1678	=item $env = $term->env
1171		1679
1172	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
1173	similar to C<\%ENV>.	1681	similar to C<\%ENV>.
1174		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
1175	=cut	1692	=cut
1176		1693
1177	sub env {	1694	sub env {
1178	if (my $env = $_[0]->_env) {
1179	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1695	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1180	} else {
1181	+{ %ENV }
1182	}
1183	}	1696	}
1184		1697
1185	=item $modifiermask = $term->ModLevel3Mask	1698	=item $modifiermask = $term->ModLevel3Mask
1186		1699
1187	=item $modifiermask = $term->ModMetaMask	1700	=item $modifiermask = $term->ModMetaMask
…		…
1189	=item $modifiermask = $term->ModNumLockMask	1702	=item $modifiermask = $term->ModNumLockMask
1190		1703
1191	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
1192	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.
1193		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	}
		1724
1194	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1195		1726
1196	Returns the negative row number of the topmost line. Minimum value is	1727	Returns the row number of the topmost displayed line. Maximum value is
1197	C<0>, which displays the normal terminal contents. Larger values scroll	1728	C<0>, which displays the normal terminal contents. Lower values scroll
1198	this many lines into the scrollback buffer.	1729	this many lines into the scrollback buffer.
1199		1730
1200	=item $term->want_refresh	1731	=item $term->want_refresh
1201		1732
1202	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1733	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1203	compare the on-screen display with its stored representation. If they	1734	compare the on-screen display with its stored representation. If they
1204	differ, it redraws the differences.	1735	differ, it redraws the differences.
1205		1736
1206	Used after changing terminal contents to display them.	1737	Used after changing terminal contents to display them.
1207		1738
		1739	=item $term->refresh_check
		1740
		1741	Checks if a refresh has been requested and, if so, schedules one.
		1742
1208	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1743	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1209		1744
1210	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 >>
1211	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
1212	terminal line. The scrollback buffer starts at line C<-1> and extends to
1213	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1747	terminal line. Nothing will be returned if a nonexistent line
1214	is requested.	1748	is requested.
1215		1749
1216	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
1217	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
1218	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
1219	automatically be updated.	1753	automatically be updated.
1220		1754
1221	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
1222	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)
1223	(C<chr 65535>). Characters with combining characters and other characters	1757	characters. Characters with combining characters and other characters that
1224	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
1225	characters in the private use area.	1759	in the private use area.
1226		1760
1227	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
1228	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
1229	characters.	1763	characters.
1230		1764
…		…
1314	}	1848	}
1315		1849
1316	sub urxvt::line::t {	1850	sub urxvt::line::t {
1317	my ($self) = @_;	1851	my ($self) = @_;
1318		1852
1319	if (@_ > 1)	1853	if (@_ > 1) {
1320	{
1321	$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})
1322	for $self->{beg} .. $self->{end};	1855	for $self->{beg} .. $self->{end};
1323	}	1856	}
1324		1857
1325	defined wantarray &&	1858	defined wantarray &&
1326	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1859	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1327	0, $self->{len}	1860	0, $self->{len}
1328	}	1861	}
1329		1862
1330	sub urxvt::line::r {	1863	sub urxvt::line::r {
1331	my ($self) = @_;	1864	my ($self) = @_;
1332		1865
1333	if (@_ > 1)	1866	if (@_ > 1) {
1334	{
1335	$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})
1336	for $self->{beg} .. $self->{end};	1868	for $self->{beg} .. $self->{end};
1337	}	1869	}
1338		1870
1339	if (defined wantarray) {	1871	if (defined wantarray) {
1340	my $rend = [	1872	my $rend = [
1341	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1873	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1342	];	1874	];
…		…
1374	where one character corresponds to one screen cell. See	1906	where one character corresponds to one screen cell. See
1375	C<< $term->ROW_t >> for details.	1907	C<< $term->ROW_t >> for details.
1376		1908
1377	=item $string = $term->special_decode $text	1909	=item $string = $term->special_decode $text
1378		1910
1379	Converts rxvt-unicodes text reprsentation into a perl string. See	1911	Converts rxvt-unicodes text representation into a perl string. See
1380	C<< $term->ROW_t >> for details.	1912	C<< $term->ROW_t >> for details.
1381		1913
1382	=item $success = $term->grab_button ($button, $modifiermask)	1914	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1383		1915
		1916	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1917
1384	Registers a synchronous button grab. See the XGrabButton manpage.	1918	Register/unregister a synchronous button grab. See the XGrabButton
		1919	manpage.
1385		1920
1386	=item $success = $term->grab ($eventtime[, $sync])	1921	=item $success = $term->grab ($eventtime[, $sync])
1387		1922
1388	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1923	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1389	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1924	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1390		1925
1391	=item $term->allow_events_async	1926	=item $term->allow_events_async
1392		1927
1393	Calls XAllowEvents with AsyncBoth for the most recent grab.	1928	Calls XAllowEvents with AsyncBoth for the most recent grab.
1394		1929
…		…
1401	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1936	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1402	recent grab.	1937	recent grab.
1403		1938
1404	=item $term->ungrab	1939	=item $term->ungrab
1405		1940
1406	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
1407	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
1408	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.
1409		1978
1410	=back	1979	=back
1411		1980
1412	=cut	1981	=cut
1413		1982
…		…
1477	my ($self, $text, $cb) = @_;	2046	my ($self, $text, $cb) = @_;
1478		2047
1479	$self->add_item ({ type => "button", text => $text, activate => $cb});	2048	$self->add_item ({ type => "button", text => $text, activate => $cb});
1480	}	2049	}
1481		2050
1482	=item $popup->add_toggle ($text, $cb, $initial_value)	2051	=item $popup->add_toggle ($text, $initial_value, $cb)
1483		2052
1484	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
1485	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
1486	argument.	2055	first argument.
1487		2056
1488	=cut	2057	=cut
1489		2058
1490	sub add_toggle {	2059	sub add_toggle {
1491	my ($self, $text, $cb, $value) = @_;	2060	my ($self, $text, $value, $cb) = @_;
1492		2061
1493	my $item; $item = {	2062	my $item; $item = {
1494	type => "button",	2063	type => "button",
1495	text => " $text",	2064	text => " $text",
1496	value => $value,	2065	value => $value,
…		…
1515	my $env = $self->{term}->env;	2084	my $env = $self->{term}->env;
1516	# 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.
1517	delete $env->{LC_ALL};	2086	delete $env->{LC_ALL};
1518	$env->{LC_CTYPE} = $self->{term}->locale;	2087	$env->{LC_CTYPE} = $self->{term}->locale;
1519		2088
1520	urxvt::term->new ($env, $self->{term}->resource ("name"),	2089	my $term = urxvt::term->new (
1521	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2090	$env, "popup",
		2091	"--perl-lib" => "", "--perl-ext-common" => "",
		2092	"-pty-fd" => -1, "-sl" => 0,
		2093	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1522	"--transient-for" => $self->{term}->parent,	2094	"--transient-for" => $self->{term}->parent,
1523	"-display" => $self->{term}->display_id,	2095	"-display" => $self->{term}->display_id,
1524	"-pe" => "urxvt-popup")	2096	"-pe" => "urxvt-popup",
1525	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	}
1526	}	2104	}
1527		2105
1528	sub DESTROY {	2106	sub DESTROY {
1529	my ($self) = @_;	2107	my ($self) = @_;
1530		2108
1531	delete $self->{term}{_destroy}{$self};	2109	delete $self->{term}{_destroy}{$self};
1532	$self->{term}->ungrab;	2110	$self->{term}->ungrab;
1533	}	2111	}
1534		2112
1535	=back	2113	=back
		2114
		2115	=cut
		2116
		2117	package urxvt::watcher;
1536		2118
1537	=head2 The C<urxvt::timer> Class	2119	=head2 The C<urxvt::timer> Class
1538		2120
1539	This class implements timer watchers/events. Time is represented as a	2121	This class implements timer watchers/events. Time is represented as a
1540	fractional number of seconds since the epoch. Example:	2122	fractional number of seconds since the epoch. Example:
…		…
1544	->new	2126	->new
1545	->interval (1)	2127	->interval (1)
1546	->cb (sub {	2128	->cb (sub {
1547	$term->{overlay}->set (0, 0,	2129	$term->{overlay}->set (0, 0,
1548	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2130	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1549	});	2131	});
1550		2132
1551	=over 4	2133	=over 4
1552		2134
1553	=item $timer = new urxvt::timer	2135	=item $timer = new urxvt::timer
1554		2136
…		…
1557		2139
1558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2140	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1559		2141
1560	Set the callback to be called when the timer triggers.	2142	Set the callback to be called when the timer triggers.
1561		2143
1562	=item $tstamp = $timer->at
1563
1564	Return the time this watcher will fire next.
1565
1566	=item $timer = $timer->set ($tstamp)	2144	=item $timer = $timer->set ($tstamp[, $interval])
1567		2145
1568	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).
1569		2148
1570	=item $timer = $timer->interval ($interval)	2149	=item $timer = $timer->interval ($interval)
1571		2150
1572	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
1573	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
1574	is automatically rescheduled at the given intervals.	2153	is automatically rescheduled at the given intervals.
1575		2154
1576	=item $timer = $timer->start	2155	=item $timer = $timer->start
1577		2156
1578	Start the timer.	2157	Start the timer.
1579		2158
1580	=item $timer = $timer->start ($tstamp)	2159	=item $timer = $timer->start ($tstamp[, $interval])
1581		2160
1582	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.
		2163
		2164	=item $timer = $timer->after ($delay[, $interval])
		2165
		2166	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1583		2167
1584	=item $timer = $timer->stop	2168	=item $timer = $timer->stop
1585		2169
1586	Stop the timer.	2170	Stop the timer.
1587		2171
…		…
1593		2177
1594	$term->{socket} = ...	2178	$term->{socket} = ...
1595	$term->{iow} = urxvt::iow	2179	$term->{iow} = urxvt::iow
1596	->new	2180	->new
1597	->fd (fileno $term->{socket})	2181	->fd (fileno $term->{socket})
1598	->events (urxvt::EVENT_READ)	2182	->events (urxvt::EV_READ)
1599	->start	2183	->start
1600	->cb (sub {	2184	->cb (sub {
1601	my ($iow, $revents) = @_;	2185	my ($iow, $revents) = @_;
1602	# $revents must be 1 here, no need to check	2186	# $revents must be 1 here, no need to check
1603	sysread $term->{socket}, my $buf, 8192	2187	sysread $term->{socket}, my $buf, 8192
…		…
1616	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>
1617	is a bitset as described in the C<events> method.	2201	is a bitset as described in the C<events> method.
1618		2202
1619	=item $iow = $iow->fd ($fd)	2203	=item $iow = $iow->fd ($fd)
1620		2204
1621	Set the filedescriptor (not handle) to watch.	2205	Set the file descriptor (not handle) to watch.
1622		2206
1623	=item $iow = $iow->events ($eventmask)	2207	=item $iow = $iow->events ($eventmask)
1624		2208
1625	Set the event mask to watch. The only allowed values are	2209	Set the event mask to watch. The only allowed values are
1626	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
1627	together, or C<urxvt::EVENT_NONE>.	2211	together, or C<urxvt::EV_NONE>.
1628		2212
1629	=item $iow = $iow->start	2213	=item $iow = $iow->start
1630		2214
1631	Start watching for requested events on the given handle.	2215	Start watching for requested events on the given handle.
1632		2216
1633	=item $iow = $iow->stop	2217	=item $iow = $iow->stop
1634		2218
1635	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.
1636		2281
1637	=back	2282	=back
1638		2283
1639	=head1 ENVIRONMENT	2284	=head1 ENVIRONMENT
1640		2285
…		…
1649		2294
1650	=item >= 3 - script loading and management	2295	=item >= 3 - script loading and management
1651		2296
1652	=item >=10 - all called hooks	2297	=item >=10 - all called hooks
1653		2298
1654	=item >=11 - hook reutrn values	2299	=item >=11 - hook return values
1655		2300
1656	=back	2301	=back
1657		2302
1658	=head1 AUTHOR	2303	=head1 AUTHOR
1659		2304
1660	Marc Lehmann <pcg@goof.com>	2305	Marc Lehmann <schmorp@schmorp.de>
1661	http://software.schmorp.de/pkg/rxvt-unicode	2306	http://software.schmorp.de/pkg/rxvt-unicode
1662		2307
1663	=cut	2308	=cut
1664		2309
1665	1	2310	1
		2311
		2312	# vim: sw=3:

Diff Legend

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