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.90 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.246 by root, Fri Dec 26 18:58:19 2014 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 and also default bindings for one or
47	arguments, which is very convenient, too, if your F<ls> supports	51	more actions it provides using so called META comments, described
48	C<--quoting-style=shell>.	52	below. Similarly to builtin resources, extension resources can also be
49		53	specified on the command line as long options (with C<.> replaced by
50	A double-click usually selects the word under the cursor, further clicks	54	C<->), in which case the corresponding extension is loaded
51	will enlarge the selection.	55	automatically. For this to work the extension B<must> define META
52		56	comments for its resources.
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	Of course, this can be modified to suit your needs and your editor :)
133
134	=item mark-urls
135
136	Uses per-line display filtering (C<on_line_update>) to underline urls and
137	make them clickable. When middle-clicked, the program specified in the
138	resource C<urlLauncher> (default C<x-www-browser>) will be started with
139	the URL as first argument.
140
141	=item block-graphics-to-ascii
142
143	A not very useful example of filtering all text output to the terminal,
144	by replacing all line-drawing characters (U+2500 .. U+259F) by a
145	similar-looking ascii character.
146
147	=item digital-clock
148
149	Displays a digital clock using the built-in overlay.
150
151	=item example-refresh-hooks
152
153	Displays a very simple digital clock in the upper right corner of the
154	window. Illustrates overwriting the refresh callbacks to create your own
155	overlays or changes.
156
157	=back
158		57
159	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
160		59
161	=head2 General API Considerations	60	=head2 General API Considerations
162		61
…		…
176		75
177	=over 4	76	=over 4
178		77
179	=item $text	78	=item $text
180		79
181	Rxvt-unicodes special way of encoding text, where one "unicode" character	80	Rxvt-unicode's special way of encoding text, where one "unicode" character
182	always represents one screen cell. See L<ROW_t> for a discussion of this format.	81	always represents one screen cell. See L<ROW_t> for a discussion of this format.
183		82
184	=item $string	83	=item $string
185		84
186	A perl text string, with an emphasis on I<text>. It can store all unicode	85	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
190	=item $octets	89	=item $octets
191		90
192	Either binary data or - more common - a text string encoded in a	91	Either binary data or - more common - a text string encoded in a
193	locale-specific way.	92	locale-specific way.
194		93
		94	=item $keysym
		95
		96	an integer that is a valid X11 keysym code. You can convert a string
		97	into a keysym and viceversa by using C<XStringToKeysym> and
		98	C<XKeysymToString>.
		99
195	=back	100	=back
196		101
197	=head2 Extension Objects	102	=head2 Extension Objects
198		103
199	Very perl extension is a perl class. A separate perl object is created	104	Every perl extension is a perl class. A separate perl object is created
200	for each terminal and each extension and passed as the first parameter to	105	for each terminal, and each terminal has its own set of extension objects,
201	hooks. So extensions can use their C<$self> object without having to think	106	which are passed as the first parameter to hooks. So extensions can use
202	about other extensions, with the exception of methods and members that	107	their C<$self> object without having to think about clashes with other
		108	extensions or other terminals, with the exception of methods and members
203	begin with an underscore character C<_>: these are reserved for internal	109	that begin with an underscore character C<_>: these are reserved for
204	use.	110	internal use.
205		111
206	Although it isn't a C<urxvt::term> object, you can call all methods of the	112	Although it isn't a C<urxvt::term> object, you can call all methods of the
207	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
208		114
209	It has the following methods and data members:	115	Additional methods only supported for extension objects are described in
		116	the C<urxvt::extension> section below.
		117
		118	=head2 META comments
		119
		120	rxvt-unicode recognizes special comments in extensions that define
		121	different types of metadata:
210		122
211	=over 4	123	=over 4
212		124
213	=item $urxvt_term = $self->{term}	125	=item #:META:RESOURCE:name:type:desc
214		126
215	Returns the C<urxvt::term> object associated with this instance of the	127	The RESOURCE comment defines a resource used by the extension, where
216	extension. This member I<must not> be changed in any way.	128	C<name> is the resource name, C<type> is the resource type, C<boolean>
		129	or C<string>, and C<desc> is the resource description.
217		130
218	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	131	=item #:META:BINDING:sym:action
219		132
220	Dynamically enable the given hooks (named without the C<on_> prefix) for	133	The BINDING comment defines a default binding for an action provided
221	this extension, replacing any previous hook. This is useful when you want	134	by the extension, where C<sym> is the key combination that triggers
222	to overwrite time-critical hooks only temporarily.	135	the action, whose format is defined in the description of the
223		136	B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
224	=item $self->disable ($hook_name[, $hook_name..])	137	of the action method.
225
226	Dynamically disable the given hooks.
227		138
228	=back	139	=back
229		140
230	=head2 Hooks	141	=head2 Hooks
231		142
232	The following subroutines can be declared in extension files, and will be	143	The following subroutines can be declared in extension files, and will be
233	called whenever the relevant event happens.	144	called whenever the relevant event happens.
234		145
235	The first argument passed to them is an extension oject as described in	146	The first argument passed to them is an extension object as described in
236	the in the C<Extension Objects> section.	147	the in the C<Extension Objects> section.
237		148
238	B<All> of these hooks must return a boolean value. If it is true, then the	149	B<All> of these hooks must return a boolean value. If any of the called
239	event counts as being I<consumed>, and the invocation of other hooks is	150	hooks returns true, then the event counts as being I<consumed>, and the
240	skipped, and the relevant action might not be carried out by the C++ code.	151	relevant action might not be carried out by the C++ code.
241		152
242	I<< When in doubt, return a false value (preferably C<()>). >>	153	I<< When in doubt, return a false value (preferably C<()>). >>
243		154
244	=over 4	155	=over 4
245		156
246	=item on_init $term	157	=item on_init $term
247		158
248	Called after a new terminal object has been initialized, but before	159	Called after a new terminal object has been initialized, but before
249	windows are created or the command gets run. Most methods are unsafe to	160	windows are created or the command gets run. Most methods are unsafe to
250	call or deliver senseless data, as terminal size and other characteristics	161	call or deliver senseless data, as terminal size and other characteristics
251	have not yet been determined. You can safely query and change resources,	162	have not yet been determined. You can safely query and change resources
252	though.	163	and options, though. For many purposes the C<on_start> hook is a better
		164	place.
		165
		166	=item on_start $term
		167
		168	Called at the very end of initialisation of a new terminal, just before
		169	trying to map (display) the toplevel and returning to the main loop.
		170
		171	=item on_destroy $term
		172
		173	Called whenever something tries to destroy terminal, when the terminal is
		174	still fully functional (not for long, though).
253		175
254	=item on_reset $term	176	=item on_reset $term
255		177
256	Called after the screen is "reset" for any reason, such as resizing or	178	Called after the screen is "reset" for any reason, such as resizing or
257	control sequences. Here is where you can react on changes to size-related	179	control sequences. Here is where you can react on changes to size-related
258	variables.	180	variables.
259		181
260	=item on_start $term	182	=item on_child_start $term, $pid
261		183
262	Called at the very end of initialisation of a new terminal, just before	184	Called just after the child process has been C<fork>ed.
263	returning to the mainloop.	185
		186	=item on_child_exit $term, $status
		187
		188	Called just after the child process has exited. C<$status> is the status
		189	from C<waitpid>.
264		190
265	=item on_sel_make $term, $eventtime	191	=item on_sel_make $term, $eventtime
266		192
267	Called whenever a selection has been made by the user, but before the	193	Called whenever a selection has been made by the user, but before the
268	selection text is copied, so changes to the beginning, end or type of the	194	selection text is copied, so changes to the beginning, end or type of the
…		…
275		201
276	Called whenever a selection has been copied, but before the selection is	202	Called whenever a selection has been copied, but before the selection is
277	requested from the server. The selection text can be queried and changed	203	requested from the server. The selection text can be queried and changed
278	by calling C<< $term->selection >>.	204	by calling C<< $term->selection >>.
279		205
280	Returning a true value aborts selection grabbing. It will still be hilighted.	206	Returning a true value aborts selection grabbing. It will still be highlighted.
281		207
282	=item on_sel_extend $term	208	=item on_sel_extend $term
283		209
284	Called whenever the user tries to extend the selection (e.g. with a double	210	Called whenever the user tries to extend the selection (e.g. with a double
285	click) and is either supposed to return false (normal operation), or	211	click) and is either supposed to return false (normal operation), or
286	should extend the selection itelf and return true to suppress the built-in	212	should extend the selection itself and return true to suppress the built-in
287	processing. This can happen multiple times, as long as the callback	213	processing. This can happen multiple times, as long as the callback
288	returns true, it will be called on every further click by the user and is	214	returns true, it will be called on every further click by the user and is
289	supposed to enlarge the selection more and more, if possible.	215	supposed to enlarge the selection more and more, if possible.
290		216
291	See the F<selection> example extension.	217	See the F<selection> example extension.
292		218
293	=item on_view_change $term, $offset	219	=item on_view_change $term, $offset
294		220
295	Called whenever the view offset changes, i..e the user or program	221	Called whenever the view offset changes, i.e. the user or program
296	scrolls. Offset C<0> means display the normal terminal, positive values	222	scrolls. Offset C<0> means display the normal terminal, positive values
297	show this many lines of scrollback.	223	show this many lines of scrollback.
298		224
299	=item on_scroll_back $term, $lines, $saved	225	=item on_scroll_back $term, $lines, $saved
300		226
…		…
304		230
305	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	231	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
306	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	232	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
307	number of lines that will be in the scrollback buffer.	233	number of lines that will be in the scrollback buffer.
308		234
309	=item on_osc_seq $term, $string	235	=item on_osc_seq $term, $op, $args, $resp
		236
		237	Called on every OSC sequence and can be used to suppress it or modify its
		238	behaviour. The default should be to return an empty list. A true value
		239	suppresses execution of the request completely. Make sure you don't get
		240	confused by recursive invocations when you output an OSC sequence within
		241	this callback.
		242
		243	C<on_osc_seq_perl> should be used for new behaviour.
		244
		245	=item on_osc_seq_perl $term, $args, $resp
310		246
311	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	247	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
312	operating system command) is processed. Cursor position and other state	248	operating system command) is processed. Cursor position and other state
313	information is up-to-date when this happens. For interoperability, the	249	information is up-to-date when this happens. For interoperability, the
314	string should start with the extension name and a colon, to distinguish	250	string should start with the extension name (sans -osc) and a semicolon,
315	it from commands for other extensions, and this might be enforced in the	251	to distinguish it from commands for other extensions, and this might be
316	future.	252	enforced in the future.
		253
		254	For example, C<overlay-osc> uses this:
		255
		256	sub on_osc_seq_perl {
		257	my ($self, $osc, $resp) = @_;
		258
		259	return unless $osc =~ s/^overlay;//;
		260
		261	... process remaining $osc string
		262	}
317		263
318	Be careful not ever to trust (in a security sense) the data you receive,	264	Be careful not ever to trust (in a security sense) the data you receive,
319	as its source can not easily be controleld (e-mail content, messages from	265	as its source can not easily be controlled (e-mail content, messages from
320	other users on the same system etc.).	266	other users on the same system etc.).
		267
		268	For responses, C<$resp> contains the end-of-args separator used by the
		269	sender.
321		270
322	=item on_add_lines $term, $string	271	=item on_add_lines $term, $string
323		272
324	Called whenever text is about to be output, with the text as argument. You	273	Called whenever text is about to be output, with the text as argument. You
325	can filter/change and output the text yourself by returning a true value	274	can filter/change and output the text yourself by returning a true value
…		…
330	=item on_tt_write $term, $octets	279	=item on_tt_write $term, $octets
331		280
332	Called whenever some data is written to the tty/pty and can be used to	281	Called whenever some data is written to the tty/pty and can be used to
333	suppress or filter tty input.	282	suppress or filter tty input.
334		283
		284	=item on_tt_paste $term, $octets
		285
		286	Called whenever text is about to be pasted, with the text as argument. You
		287	can filter/change and paste the text yourself by returning a true value
		288	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		289	locale-encoded.
		290
335	=item on_line_update $term, $row	291	=item on_line_update $term, $row
336		292
337	Called whenever a line was updated or changed. Can be used to filter	293	Called whenever a line was updated or changed. Can be used to filter
338	screen output (e.g. underline urls or other useless stuff). Only lines	294	screen output (e.g. underline urls or other useless stuff). Only lines
339	that are being shown will be filtered, and, due to performance reasons,	295	that are being shown will be filtered, and, due to performance reasons,
…		…
346	later with the already-modified line (e.g. if unrelated parts change), so	302	later with the already-modified line (e.g. if unrelated parts change), so
347	you cannot just toggle rendition bits, but only set them.	303	you cannot just toggle rendition bits, but only set them.
348		304
349	=item on_refresh_begin $term	305	=item on_refresh_begin $term
350		306
351	Called just before the screen gets redrawn. Can be used for overlay	307	Called just before the screen gets redrawn. Can be used for overlay or
352	or similar effects by modify terminal contents in refresh_begin, and	308	similar effects by modifying the terminal contents in refresh_begin, and
353	restoring them in refresh_end. The built-in overlay and selection display	309	restoring them in refresh_end. The built-in overlay and selection display
354	code is run after this hook, and takes precedence.	310	code is run after this hook, and takes precedence.
355		311
356	=item on_refresh_end $term	312	=item on_refresh_end $term
357		313
358	Called just after the screen gets redrawn. See C<on_refresh_begin>.	314	Called just after the screen gets redrawn. See C<on_refresh_begin>.
359		315
		316	=item on_action $term, $string
		317
		318	Called whenever an action is invoked for the corresponding extension
		319	(e.g. via a C<extension:string> builtin action bound to a key, see
		320	description of the B<keysym> resource in the urxvt(1) manpage). The
		321	event is simply the action string. Note that an action event is always
		322	associated to a single extension.
		323
360	=item on_keyboard_command $term, $string	324	=item on_user_command $term, $string *DEPRECATED*
361		325
362	Called whenever the user presses a key combination that has a	326	Called whenever a user-configured event is being activated (e.g. via
363	C<perl:string> action bound to it (see description of the B<keysym>	327	a C<perl:string> action bound to a key, see description of the B<keysym>
364	resource in the @@RXVT_NAME@@(1) manpage).	328	resource in the urxvt(1) manpage).
		329
		330	The event is simply the action string. This interface is going away in
		331	preference to the C<on_action> hook.
		332
		333	=item on_resize_all_windows $term, $new_width, $new_height
		334
		335	Called just after the new window size has been calculated, but before
		336	windows are actually being resized or hints are being set. If this hook
		337	returns a true value, setting of the window hints is being skipped.
		338
		339	=item on_x_event $term, $event
		340
		341	Called on every X event received on the vt window (and possibly other
		342	windows). Should only be used as a last resort. Most event structure
		343	members are not passed.
		344
		345	=item on_root_event $term, $event
		346
		347	Like C<on_x_event>, but is called for events on the root window.
365		348
366	=item on_focus_in $term	349	=item on_focus_in $term
367		350
368	Called whenever the window gets the keyboard focus, before rxvt-unicode	351	Called whenever the window gets the keyboard focus, before rxvt-unicode
369	does focus in processing.	352	does focus in processing.
370		353
371	=item on_focus_out $term	354	=item on_focus_out $term
372		355
373	Called wheneever the window loses keyboard focus, before rxvt-unicode does	356	Called whenever the window loses keyboard focus, before rxvt-unicode does
374	focus out processing.	357	focus out processing.
375		358
		359	=item on_configure_notify $term, $event
		360
		361	=item on_property_notify $term, $event
		362
376	=item on_key_press $term, $event, $keysym, $octets	363	=item on_key_press $term, $event, $keysym, $octets
377		364
378	=item on_key_release $term, $event, $keysym	365	=item on_key_release $term, $event, $keysym
379		366
380	=item on_button_press $term, $event	367	=item on_button_press $term, $event
…		…
385		372
386	=item on_map_notify $term, $event	373	=item on_map_notify $term, $event
387		374
388	=item on_unmap_notify $term, $event	375	=item on_unmap_notify $term, $event
389		376
390	Called whenever the corresponding X event is received for the terminal If	377	Called whenever the corresponding X event is received for the terminal. If
391	the hook returns true, then the even will be ignored by rxvt-unicode.	378	the hook returns true, then the event will be ignored by rxvt-unicode.
392		379
393	The event is a hash with most values as named by Xlib (see the XEvent	380	The event is a hash with most values as named by Xlib (see the XEvent
394	manpage), with the additional members C<row> and C<col>, which are the row	381	manpage), with the additional members C<row> and C<col>, which are the
395	and column under the mouse cursor.	382	(real, not screen-based) row and column under the mouse cursor.
396		383
397	C<on_key_press> additionally receives the string rxvt-unicode would	384	C<on_key_press> additionally receives the string rxvt-unicode would
398	output, if any, in locale-specific encoding.	385	output, if any, in locale-specific encoding.
399		386
400	subwindow.	387	=item on_client_message $term, $event
		388
		389	=item on_wm_protocols $term, $event
		390
		391	=item on_wm_delete_window $term, $event
		392
		393	Called when various types of ClientMessage events are received (all with
		394	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		395
		396	=item on_bell $term
		397
		398	Called on receipt of a bell character.
401		399
402	=back	400	=back
403		401
404	=cut	402	=cut
405		403
406	package urxvt;	404	package urxvt;
407		405
408	use utf8;	406	use utf8;
409	use strict;	407	use strict 'vars';
410	use Carp ();	408	use Carp ();
411	use Scalar::Util ();	409	use Scalar::Util ();
412	use List::Util ();	410	use List::Util ();
413		411
414	our $VERSION = 1;	412	our $VERSION = 1;
415	our $TERM;	413	our $TERM;
		414	our @TERM_INIT; # should go, prevents async I/O etc.
		415	our @TERM_EXT; # should go, prevents async I/O etc.
416	our @HOOKNAME;	416	our @HOOKNAME;
417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
418	our %OPTION;	418	our %OPTION;
419		419
420	our $LIBDIR;	420	our $LIBDIR;
421	our $RESNAME;	421	our $RESNAME;
422	our $RESCLASS;	422	our $RESCLASS;
423	our $RXVTNAME;	423	our $RXVTNAME;
424		424
		425	our $NOCHAR = chr 0xffff;
		426
425	=head2 Variables in the C<urxvt> Package	427	=head2 Variables in the C<urxvt> Package
426		428
427	=over 4	429	=over 4
428		430
429	=item $urxvt::LIBDIR	431	=item $urxvt::LIBDIR
…		…
442	=item $urxvt::TERM	444	=item $urxvt::TERM
443		445
444	The current terminal. This variable stores the current C<urxvt::term>	446	The current terminal. This variable stores the current C<urxvt::term>
445	object, whenever a callback/hook is executing.	447	object, whenever a callback/hook is executing.
446		448
		449	=item @urxvt::TERM_INIT
		450
		451	All code references in this array will be called as methods of the next newly
		452	created C<urxvt::term> object (during the C<on_init> phase). The array
		453	gets cleared before the code references that were in it are being executed,
		454	so references can push themselves onto it again if they so desire.
		455
		456	This complements to the perl-eval command line option, but gets executed
		457	first.
		458
		459	=item @urxvt::TERM_EXT
		460
		461	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		462	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		463	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		464
447	=back	465	=back
448		466
449	=head2 Functions in the C<urxvt> Package	467	=head2 Functions in the C<urxvt> Package
450		468
451	=over 4	469	=over 4
452		470
453	=item urxvt::fatal $errormessage	471	=item urxvt::fatal $errormessage
454		472
455	Fatally aborts execution with the given error message. Avoid at all	473	Fatally aborts execution with the given error message (which should
456	costs! The only time this is acceptable is when the terminal process	474	include a trailing newline). Avoid at all costs! The only time this
457	starts up.	475	is acceptable (and useful) is in the init hook, where it prevents the
		476	terminal from starting up.
458		477
459	=item urxvt::warn $string	478	=item urxvt::warn $string
460		479
461	Calls C<rxvt_warn> with the given string which should not include a	480	Calls C<rxvt_warn> with the given string which should include a trailing
462	newline. The module also overwrites the C<warn> builtin with a function	481	newline. The module also overwrites the C<warn> builtin with a function
463	that calls this function.	482	that calls this function.
464		483
465	Using this function has the advantage that its output ends up in the	484	Using this function has the advantage that its output ends up in the
466	correct place, e.g. on stderr of the connecting urxvtc client.	485	correct place, e.g. on stderr of the connecting urxvtc client.
467		486
468	Messages have a size limit of 1023 bytes currently.	487	Messages have a size limit of 1023 bytes currently.
469		488
470	=item $is_safe = urxvt::safe	489	=item @terms = urxvt::termlist
471		490
472	Returns true when it is safe to do potentially unsafe things, such as	491	Returns all urxvt::term objects that exist in this process, regardless of
473	evaluating perl code specified by the user. This is true when urxvt was	492	whether they are started, being destroyed etc., so be careful. Only term
474	started setuid or setgid.	493	objects that have perl extensions attached will be returned (because there
		494	is no urxvt::term object associated with others).
475		495
476	=item $time = urxvt::NOW	496	=item $time = urxvt::NOW
477		497
478	Returns the "current time" (as per the event loop).	498	Returns the "current time" (as per the event loop).
479		499
480	=item urxvt::CurrentTime	500	=item urxvt::CurrentTime
481		501
482	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	502	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	503	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484	Button4Mask, Button5Mask, AnyModifier	504	Button4Mask, Button5Mask, AnyModifier
		505
		506	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		507	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		508	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		509	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		510	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		511	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		512	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		513
		514	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		515	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		516	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		517	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		518	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		519	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		520	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
485		521
486	Various constants for use in X calls and event processing.	522	Various constants for use in X calls and event processing.
487		523
488	=back	524	=back
489		525
…		…
506		542
507	=item $rend = urxvt::OVERLAY_RSTYLE	543	=item $rend = urxvt::OVERLAY_RSTYLE
508		544
509	Return the rendition mask used for overlays by default.	545	Return the rendition mask used for overlays by default.
510		546
511	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	547	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		548	urxvt::RS_RVid, urxvt::RS_Uline
512		549
513	Return the bit that enabled bold, italic, blink, reverse-video and	550	Return the bit that enabled bold, italic, blink, reverse-video and
514	underline, respectively. To enable such a style, just logically OR it into	551	underline, respectively. To enable such a style, just logically OR it into
515	the bitset.	552	the bitset.
516		553
…		…
522		559
523	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	560	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
524		561
525	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	562	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
526		563
		564	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		565
527	Replace the foreground/background colour in the rendition mask with the	566	Replace the foreground/background colour in the rendition mask with the
528	specified one.	567	specified one.
529		568
530	=item $value = urxvt::GET_CUSTOM $rend	569	=item $value = urxvt::GET_CUSTOM $rend
531		570
…		…
540	=back	579	=back
541		580
542	=cut	581	=cut
543		582
544	BEGIN {	583	BEGIN {
545	urxvt->bootstrap;
546
547	# overwrite perl's warn	584	# overwrite perl's warn
548	*CORE::GLOBAL::warn = sub {	585	*CORE::GLOBAL::warn = sub {
549	my $msg = join "", @_;	586	my $msg = join "", @_;
550	$msg .= "\n"	587	$msg .= "\n"
551	unless $msg =~ /\n$/;	588	unless $msg =~ /\n$/;
552	urxvt::warn ($msg);	589	urxvt::warn ($msg);
553	};	590	};
554
555	# %ENV is the original startup environment
556	delete $ENV{IFS};
557	delete $ENV{CDPATH};
558	delete $ENV{BASH_ENV};
559	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
560	}	591	}
561		592
562	my @hook_count;	593	no warnings 'utf8';
		594
		595	sub parse_resource {
		596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		597
		598	$term->scan_extensions;
		599
		600	my $r = $term->{meta}{resource};
		601	keys %$r; # reset iterator
		602	while (my ($k, $v) = each %$r) {
		603	my $pattern = $k;
		604	$pattern =~ y/./-/ if $isarg;
		605	my $prefix = $name;
		606	my $suffix;
		607	if ($pattern =~ /\-$/) {
		608	$prefix = substr $name, 0, length $pattern;
		609	$suffix = substr $name, length $pattern;
		610	}
		611	if ($pattern eq $prefix) {
		612	$name = "$urxvt::RESCLASS.$k$suffix";
		613
		614	push @{ $term->{perl_ext_3} }, $v->[0];
		615
		616	if ($v->[1] eq "boolean") {
		617	$term->put_option_db ($name, $flag ? "true" : "false");
		618	return 1;
		619	} else {
		620	$term->put_option_db ($name, $value);
		621	return 1 + 2;
		622	}
		623	}
		624	}
		625
		626	0
		627	}
		628
		629	sub usage {
		630	my ($term, $usage_type) = @_;
		631
		632	$term->scan_extensions;
		633
		634	my $r = $term->{meta}{resource};
		635
		636	for my $pattern (sort keys %$r) {
		637	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		638
		639	$desc .= " (-pe $ext)";
		640
		641	if ($usage_type == 1) {
		642	$pattern =~ y/./-/;
		643	$pattern =~ s/-$/-.../g;
		644
		645	if ($type eq "boolean") {
		646	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		647	} else {
		648	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		649	}
		650	} else {
		651	$pattern =~ s/\.$/.*/g;
		652	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		653	}
		654	}
		655	}
		656
563	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	657	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564		658
565	sub verbose {	659	sub verbose {
566	my ($level, $msg) = @_;	660	my ($level, $msg) = @_;
567	warn "$msg\n" if $level <= $verbosity;	661	warn "$msg\n" if $level <= $verbosity;
568	}	662	}
569		663
570	my $extension_pkg = "extension0000";
571	my %extension_pkg;	664	my %extension_pkg;
572		665
573	# load a single script into its own package, once only	666	# load a single script into its own package, once only
574	sub extension_package($) {	667	sub extension_package($) {
575	my ($path) = @_;	668	my ($path) = @_;
576		669
577	$extension_pkg{$path} ||= do {	670	$extension_pkg{$path} ||= do {
578	my $pkg = "urxvt::" . ($extension_pkg++);	671	$path =~ /([^\/\\]+)$/;
		672	my $pkg = $1;
		673	$pkg =~ s/[^[:word:]]/_/g;
		674	$pkg = "urxvt::ext::$pkg";
579		675
580	verbose 3, "loading extension '$path' into package '$pkg'";	676	verbose 3, "loading extension '$path' into package '$pkg'";
		677
		678	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
581		679
582	open my $fh, "<:raw", $path	680	open my $fh, "<:raw", $path
583	or die "$path: $!";	681	or die "$path: $!";
584		682
585	my $source = untaint	683	my $source =
586	"package $pkg; use strict; use utf8;\n"	684	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
587	. "use base urxvt::term::extension::;\n"
588	. "#line 1 \"$path\"\n{\n"	685	. "#line 1 \"$path\"\n{\n"
589	. (do { local $/; <$fh> })	686	. (do { local $/; <$fh> })
590	. "\n};\n1";	687	. "\n};\n1";
591		688
592	eval $source	689	eval $source
…		…
601	# called by the rxvt core	698	# called by the rxvt core
602	sub invoke {	699	sub invoke {
603	local $TERM = shift;	700	local $TERM = shift;
604	my $htype = shift;	701	my $htype = shift;
605		702
606	if ($htype == 0) { # INIT	703	if ($htype == HOOK_INIT) {
607	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	704	my @dirs = $TERM->perl_libdirs;
608		705
		706	$TERM->scan_extensions;
		707
609	my %ext_arg;	708	my %ext_arg;
610		709
		710	{
		711	my @init = @TERM_INIT;
		712	@TERM_INIT = ();
		713	$_->($TERM) for @init;
		714	my @pkg = @TERM_EXT;
		715	@TERM_EXT = ();
		716	$TERM->register_package ($_) for @pkg;
		717	}
		718
		719	for (
611	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	720	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		721	@{ delete $TERM->{perl_ext_3} }
		722	) {
612	if ($_ eq "default") {	723	if ($_ eq "default") {
		724
		725	$ext_arg{$_} = []
		726	for
613	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	727	qw(selection option-popup selection-popup readline searchable-scrollback),
		728	map $_->[0], values %{ $TERM->{meta}{binding} };
		729
		730	for ($TERM->_keysym_resources) {
		731	next if /^(?:string|command|builtin|builtin-string|perl)/;
		732	next unless /^([A-Za-z0-9_\-]+):/;
		733
		734	my $ext = $1;
		735
		736	$ext_arg{$ext} = [];
		737	}
		738
614	} elsif (/^-(.*)$/) {	739	} elsif (/^-(.*)$/) {
615	delete $ext_arg{$1};	740	delete $ext_arg{$1};
		741
616	} elsif (/^([^<]+)<(.*)>$/) {	742	} elsif (/^([^<]+)<(.*)>$/) {
617	push @{ $ext_arg{$1} }, $2;	743	push @{ $ext_arg{$1} }, $2;
		744
618	} else {	745	} else {
619	$ext_arg{$_} ||= [];	746	$ext_arg{$_} ||= [];
620	}	747	}
621	}	748	}
622		749
623	while (my ($ext, $argv) = each %ext_arg) {	750	# now register default key bindings
		751	for my $ext (sort keys %ext_arg) {
		752	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		753	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
		754	}
		755	}
		756
		757	for my $ext (sort keys %ext_arg) {
624	my @files = grep -f $_, map "$_/$ext", @dirs;	758	my @files = grep -f $_, map "$_/$ext", @dirs;
625		759
626	if (@files) {	760	if (@files) {
627	$TERM->register_package (extension_package $files[0], $argv);	761	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
628	} else {	762	} else {
629	warn "perl extension '$ext' not found in perl library search path\n";	763	warn "perl extension '$ext' not found in perl library search path\n";
630	}	764	}
631	}	765	}
632		766
…		…
638		772
639	if (my $cb = $TERM->{_hook}[$htype]) {	773	if (my $cb = $TERM->{_hook}[$htype]) {
640	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	774	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
641	if $verbosity >= 10;	775	if $verbosity >= 10;
642		776
643	keys %$cb;	777	if ($htype == HOOK_ACTION) {
		778	# this hook is only sent to the extension with the name
		779	# matching the first arg
		780	my $pkg = shift;
		781	$pkg =~ y/-/_/;
		782	$pkg = "urxvt::ext::$pkg";
644		783
645	while (my ($pkg, $cb) = each %$cb) {	784	$cb = $cb->{$pkg}
		785	or return undef; #TODO: maybe warn user?
		786
		787	$cb = { $pkg => $cb };
		788	}
		789
		790	for my $pkg (keys %$cb) {
646	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	791	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
647	and last;	792	$retval ||= $retval_;
648		793
649	if ($@) {	794	if ($@) {
650	$TERM->ungrab; # better to lose the grab than the session	795	$TERM->ungrab; # better to lose the grab than the session
651	warn $@;	796	warn $@;
652	}	797	}
…		…
654		799
655	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656	if $verbosity >= 11;	801	if $verbosity >= 11;
657	}	802	}
658		803
659	if ($htype == 1) { # DESTROY	804	if ($htype == HOOK_DESTROY) {
660	if (my $hook = delete $TERM->{_hook}) {
661	for my $htype (0..$#$hook) {
662	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
663	or set_should_invoke $htype, 0;
664	}
665	}
666
667	# clear package objects	805	# clear package objects
668	%$_ = () for values %{ $TERM->{_pkg} };	806	%$_ = () for values %{ $TERM->{_pkg} };
669		807
670	# clear package	808	# clear package
671	%$TERM = ();	809	%$TERM = ();
672	}	810	}
673		811
674	$retval	812	$retval
675	}	813	}
676		814
677	sub exec_async(@) {	815	sub SET_COLOR($$$) {
678	my $pid = fork;	816	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
679
680	return
681	if !defined $pid or $pid;
682
683	%ENV = %{ $TERM->env };
684
685	exec @_;
686	_exit 255;
687	}	817	}
688		818
689	# urxvt::term::extension	819	sub rend2mask {
690		820	no strict 'refs';
691	package urxvt::term::extension;	821	my ($str, $mask) = (@_, 0);
692		822	my %color = ( fg => undef, bg => undef );
693	sub enable {	823	my @failed;
694	my ($self, %hook) = @_;	824	for my $spec ( split /\s+/, $str ) {
695	my $pkg = $self->{_pkg};	825	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
696		826	$color{lc($1)} = $2;
697	while (my ($name, $cb) = each %hook) {	827	} else {
698	my $htype = $HOOKTYPE{uc $name};	828	my $neg = $spec =~ s/^[-^]//;
699	defined $htype	829	unless ( exists &{"RS_$spec"} ) {
700	or Carp::croak "unsupported hook type '$name'";	830	push @failed, $spec;
701		831	next;
702	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
703	$hook_count[$htype]++
704	or urxvt::set_should_invoke $htype, 1;
705	}	832	}
706		833	my $cur = &{"RS_$spec"};
707	$self->{term}{_hook}[$htype]{$pkg} = $cb;	834	if ( $neg ) {
708	}	835	$mask &= ~$cur;
709	}	836	} else {
710		837	$mask |= $cur;
711	sub disable {	838	}
712	my ($self, @hook) = @_;
713	my $pkg = $self->{_pkg};
714
715	for my $name (@hook) {
716	my $htype = $HOOKTYPE{uc $name};
717	defined $htype
718	or Carp::croak "unsupported hook type '$name'";
719
720	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
721	--$hook_count[$htype]
722	or urxvt::set_should_invoke $htype, 0;
723	}	839	}
724	}	840	}
		841	($mask, @color{qw(fg bg)}, \@failed)
725	}	842	}
		843
		844	package urxvt::term::extension;
		845
		846	=head2 The C<urxvt::term::extension> class
		847
		848	Each extension attached to a terminal object is represented by
		849	a C<urxvt::term::extension> object.
		850
		851	You can use these objects, which are passed to all callbacks to store any
		852	state related to the terminal and extension instance.
		853
		854	The methods (And data members) documented below can be called on extension
		855	objects, in addition to call methods documented for the <urxvt::term>
		856	class.
		857
		858	=over 4
		859
		860	=item $urxvt_term = $self->{term}
		861
		862	Returns the C<urxvt::term> object associated with this instance of the
		863	extension. This member I<must not> be changed in any way.
		864
		865	=cut
726		866
727	our $AUTOLOAD;	867	our $AUTOLOAD;
728		868
729	sub AUTOLOAD {	869	sub AUTOLOAD {
730	$AUTOLOAD =~ /:([^:]+)$/	870	$AUTOLOAD =~ /:([^:]+)$/
…		…
743		883
744	sub DESTROY {	884	sub DESTROY {
745	# nop	885	# nop
746	}	886	}
747		887
748	# urxvt::destroy_hook	888	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
749		889
750	sub urxvt::destroy_hook::DESTROY {	890	sub urxvt::destroy_hook::DESTROY {
751	${$_[0]}->();	891	${$_[0]}->();
752	}	892	}
753		893
754	sub urxvt::destroy_hook(&) {	894	sub urxvt::destroy_hook(&) {
755	bless \shift, urxvt::destroy_hook::	895	bless \shift, urxvt::destroy_hook::
756	}	896	}
		897
		898	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		899
		900	Dynamically enable the given hooks (named without the C<on_> prefix) for
		901	this extension, replacing any hook previously installed via C<enable> in
		902	this extension.
		903
		904	This is useful when you want to overwrite time-critical hooks only
		905	temporarily.
		906
		907	To install additional callbacks for the same hook, you can use the C<on>
		908	method of the C<urxvt::term> class.
		909
		910	=item $self->disable ($hook_name[, $hook_name..])
		911
		912	Dynamically disable the given hooks.
		913
		914	=cut
		915
		916	sub enable {
		917	my ($self, %hook) = @_;
		918	my $pkg = $self->{_pkg};
		919
		920	while (my ($name, $cb) = each %hook) {
		921	my $htype = $HOOKTYPE{uc $name};
		922	defined $htype
		923	or Carp::croak "unsupported hook type '$name'";
		924
		925	$self->set_should_invoke ($htype, +1)
		926	unless exists $self->{term}{_hook}[$htype]{$pkg};
		927
		928	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		929	}
		930	}
		931
		932	sub disable {
		933	my ($self, @hook) = @_;
		934	my $pkg = $self->{_pkg};
		935
		936	for my $name (@hook) {
		937	my $htype = $HOOKTYPE{uc $name};
		938	defined $htype
		939	or Carp::croak "unsupported hook type '$name'";
		940
		941	$self->set_should_invoke ($htype, -1)
		942	if delete $self->{term}{_hook}[$htype]{$pkg};
		943	}
		944	}
		945
		946	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		947
		948	Similar to the C<enable> enable, but installs additional callbacks for
		949	the given hook(s) (that is, it doesn't replace existing callbacks), and
		950	returns a guard object. When the guard object is destroyed the callbacks
		951	are disabled again.
		952
		953	=cut
		954
		955	sub urxvt::extension::on_disable::DESTROY {
		956	my $disable = shift;
		957
		958	my $term = delete $disable->{""};
		959
		960	while (my ($htype, $id) = each %$disable) {
		961	delete $term->{_hook}[$htype]{$id};
		962	$term->set_should_invoke ($htype, -1);
		963	}
		964	}
		965
		966	sub on {
		967	my ($self, %hook) = @_;
		968
		969	my $term = $self->{term};
		970
		971	my %disable = ( "" => $term );
		972
		973	while (my ($name, $cb) = each %hook) {
		974	my $htype = $HOOKTYPE{uc $name};
		975	defined $htype
		976	or Carp::croak "unsupported hook type '$name'";
		977
		978	$term->set_should_invoke ($htype, +1);
		979	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		980	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		981	}
		982
		983	bless \%disable, "urxvt::extension::on_disable"
		984	}
		985
		986	=item $self->x_resource ($pattern)
		987
		988	=item $self->x_resource_boolean ($pattern)
		989
		990	These methods support an additional C<%> prefix when called on an
		991	extension object - see the description of these methods in the
		992	C<urxvt::term> class for details.
		993
		994	=cut
		995
		996	sub x_resource {
		997	my ($self, $name) = @_;
		998	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		999	$self->{term}->x_resource ($name)
		1000	}
		1001
		1002	sub x_resource_boolean {
		1003	my ($self, $name) = @_;
		1004	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1005	$self->{term}->x_resource_boolean ($name)
		1006	}
		1007
		1008	=back
		1009
		1010	=cut
757		1011
758	package urxvt::anyevent;	1012	package urxvt::anyevent;
759		1013
760	=head2 The C<urxvt::anyevent> Class	1014	=head2 The C<urxvt::anyevent> Class
761		1015
762	The sole purpose of this class is to deliver an interface to the	1016	The sole purpose of this class is to deliver an interface to the
763	C<AnyEvent> module - any module using it will work inside urxvt without	1017	C<AnyEvent> module - any module using it will work inside urxvt without
764	further programming. The only exception is that you cannot wait on	1018	further programming. The only exception is that you cannot wait on
765	condition variables, but non-blocking condvar use is ok. What this means	1019	condition variables, but non-blocking condvar use is ok.
766	is that you cannot use blocking APIs, but the non-blocking variant should
767	work.
768		1020
769	=cut	1021	In practical terms this means is that you cannot use blocking APIs, but
		1022	the non-blocking variant should work.
770		1023
		1024	=cut
		1025
771	our $VERSION = 1;	1026	our $VERSION = '5.23';
772		1027
773	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1028	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
774	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1029	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
775		1030
776	sub timer {	1031	sub timer {
…		…
778		1033
779	my $cb = $arg{cb};	1034	my $cb = $arg{cb};
780		1035
781	urxvt::timer	1036	urxvt::timer
782	->new	1037	->new
783	->start (urxvt::NOW + $arg{after})	1038	->after ($arg{after}, $arg{interval})
784	->cb (sub {	1039	->cb ($arg{interval} ? $cb : sub {
785	$_[0]->stop; # need to cancel manually	1040	$_[0]->stop; # need to cancel manually
786	$cb->();	1041	$cb->();
787	})	1042	})
788	}	1043	}
789		1044
790	sub io {	1045	sub io {
791	my ($class, %arg) = @_;	1046	my ($class, %arg) = @_;
792		1047
793	my $cb = $arg{cb};	1048	my $cb = $arg{cb};
		1049	my $fd = fileno $arg{fh};
		1050	defined $fd or $fd = $arg{fh};
794		1051
795	bless [$arg{fh}, urxvt::iow	1052	bless [$arg{fh}, urxvt::iow
796	->new	1053	->new
797	->fd (fileno $arg{fh})	1054	->fd ($fd)
798	->events (($arg{poll} =~ /r/ ? 1 : 0)	1055	->events (($arg{poll} =~ /r/ ? 1 : 0)
799	| ($arg{poll} =~ /w/ ? 2 : 0))	1056	| ($arg{poll} =~ /w/ ? 2 : 0))
800	->start	1057	->start
801	->cb (sub {	1058	->cb ($cb)
802	$cb->(($_[1] & 1 ? 'r' : '')
803	. ($_[1] & 2 ? 'w' : ''));
804	})],
805	urxvt::anyevent::	1059	], urxvt::anyevent::
		1060	}
		1061
		1062	sub idle {
		1063	my ($class, %arg) = @_;
		1064
		1065	my $cb = $arg{cb};
		1066
		1067	urxvt::iw
		1068	->new
		1069	->start
		1070	->cb ($cb)
		1071	}
		1072
		1073	sub child {
		1074	my ($class, %arg) = @_;
		1075
		1076	my $cb = $arg{cb};
		1077
		1078	urxvt::pw
		1079	->new
		1080	->start ($arg{pid})
		1081	->cb (sub {
		1082	$_[0]->stop; # need to cancel manually
		1083	$cb->($_[0]->rpid, $_[0]->rstatus);
		1084	})
806	}	1085	}
807		1086
808	sub DESTROY {	1087	sub DESTROY {
809	$_[0][1]->stop;	1088	$_[0][1]->stop;
810	}	1089	}
811		1090
812	sub condvar {	1091	# only needed for AnyEvent < 6 compatibility
813	bless \my $flag, urxvt::anyevent::condvar::	1092	sub one_event {
814	}
815
816	sub urxvt::anyevent::condvar::broadcast {
817	${$_[0]}++;
818	}
819
820	sub urxvt::anyevent::condvar::wait {
821	unless (${$_[0]}) {
822	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1093	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
823	}
824	}	1094	}
825		1095
826	package urxvt::term;	1096	package urxvt::term;
827		1097
828	=head2 The C<urxvt::term> Class	1098	=head2 The C<urxvt::term> Class
…		…
834	# find on_xxx subs in the package and register them	1104	# find on_xxx subs in the package and register them
835	# as hooks	1105	# as hooks
836	sub register_package {	1106	sub register_package {
837	my ($self, $pkg, $argv) = @_;	1107	my ($self, $pkg, $argv) = @_;
838		1108
		1109	no strict 'refs';
		1110
		1111	urxvt::verbose 6, "register package $pkg to $self";
		1112
		1113	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1114
839	my $proxy = bless {	1115	my $proxy = bless {
840	_pkg => $pkg,	1116	_pkg => $pkg,
		1117	_name => ${"$pkg\::_NAME"}, # hackish
841	argv => $argv,	1118	argv => $argv,
842	}, $pkg;	1119	}, $pkg;
843	Scalar::Util::weaken ($proxy->{term} = $self);	1120	Scalar::Util::weaken ($proxy->{term} = $self);
844		1121
845	$self->{_pkg}{$pkg} = $proxy;	1122	$self->{_pkg}{$pkg} = $proxy;
846		1123
…		…
849	$proxy->enable ($name => $ref);	1126	$proxy->enable ($name => $ref);
850	}	1127	}
851	}	1128	}
852	}	1129	}
853		1130
		1131	sub perl_libdirs {
		1132	map { split /:/ }
		1133	$_[0]->resource ("perl_lib"),
		1134	$ENV{URXVT_PERL_LIB},
		1135	"$ENV{HOME}/.urxvt/ext",
		1136	"$LIBDIR/perl"
		1137	}
		1138
		1139	# scan for available extensions and collect their metadata
		1140	sub scan_extensions {
		1141	my ($self) = @_;
		1142
		1143	return if exists $self->{meta};
		1144
		1145	my @libdirs = perl_libdirs $self;
		1146
		1147	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1148
		1149	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1150	$self->{meta} = \my %meta;
		1151
		1152	# first gather extensions
		1153	for my $dir (reverse @libdirs) {
		1154	opendir my $fh, $dir
		1155	or next;
		1156	for my $ext (readdir $fh) {
		1157	$ext !~ /^\./
		1158	and open my $fh, "<", "$dir/$ext"
		1159	or next;
		1160
		1161	my %ext = (dir => $dir);
		1162
		1163	while (<$fh>) {
		1164	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1165	my ($pattern, $type, $desc) = split /:/, $1;
		1166	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1167	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1168	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1169	} else {
		1170	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1171	}
		1172	} elsif (/^#:META:BINDING:(.*)/) {
		1173	my ($keysym, $action) = split /:/, $1;
		1174	$ext{binding}{$keysym} = [$ext, $action];
		1175	} elsif (/^\s*(?:#|$)/) {
		1176	# skip other comments and empty lines
		1177	} else {
		1178	last; # stop parsing on first non-empty non-comment line
		1179	}
		1180	}
		1181
		1182	$meta{ext}{$ext} = \%ext;
		1183	}
		1184	}
		1185
		1186	# and now merge resources and bindings
		1187	while (my ($k, $v) = each %{ $meta{ext} }) {
		1188	#TODO: should check for extensions overriding each other
		1189	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1190	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1191	}
		1192	}
		1193
854	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1194	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
855		1195
856	Creates a new terminal, very similar as if you had started it with system	1196	Creates a new terminal, very similar as if you had started it with system
857	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1197	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
858	hash which defines the environment of the new terminal.	1198	hash which defines the environment of the new terminal.
859		1199
860	Croaks (and probably outputs an error message) if the new instance	1200	Croaks (and probably outputs an error message) if the new instance
861	couldn't be created. Returns C<undef> if the new instance didn't	1201	couldn't be created. Returns C<undef> if the new instance didn't
862	initialise perl, and the terminal object otherwise. The C<init> and	1202	initialise perl, and the terminal object otherwise. The C<init> and
863	C<start> hooks will be called during this call.	1203	C<start> hooks will be called before this call returns, and are free to
		1204	refer to global data (which is race free).
864		1205
865	=cut	1206	=cut
866		1207
867	sub new {	1208	sub new {
868	my ($class, $env, @args) = @_;	1209	my ($class, $env, @args) = @_;
869		1210
		1211	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1212	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1213
870	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1214	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
871	}	1215	}
872		1216
873	=item $term->destroy	1217	=item $term->destroy
874		1218
875	Destroy the terminal object (close the window, free resources	1219	Destroy the terminal object (close the window, free resources
876	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1220	etc.). Please note that urxvt will not exit as long as any event
877	watchers (timers, io watchers) are still active.	1221	watchers (timers, io watchers) are still active.
		1222
		1223	=item $term->exec_async ($cmd[, @args])
		1224
		1225	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1226	("starts") programs in the background. This function takes care of setting
		1227	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1228	be preferred over explicit calls to C<exec> or C<system>.
		1229
		1230	Returns the pid of the subprocess or C<undef> on error.
		1231
		1232	=cut
		1233
		1234	sub exec_async {
		1235	my $self = shift;
		1236
		1237	my $pid = fork;
		1238
		1239	return $pid
		1240	if !defined $pid or $pid;
		1241
		1242	%ENV = %{ $self->env };
		1243
		1244	exec @_;
		1245	urxvt::_exit 255;
		1246	}
878		1247
879	=item $isset = $term->option ($optval[, $set])	1248	=item $isset = $term->option ($optval[, $set])
880		1249
881	Returns true if the option specified by C<$optval> is enabled, and	1250	Returns true if the option specified by C<$optval> is enabled, and
882	optionally change it. All option values are stored by name in the hash	1251	optionally change it. All option values are stored by name in the hash
883	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1252	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
884		1253
885	Here is a a likely non-exhaustive list of option names, please see the	1254	Here is a likely non-exhaustive list of option names, please see the
886	source file F</src/optinc.h> to see the actual list:	1255	source file F</src/optinc.h> to see the actual list:
887		1256
888	borderLess console cursorBlink cursorUnderline hold iconic insecure	1257	borderLess buffered console cursorBlink cursorUnderline hold iconic
889	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1258	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1259	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
890	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1260	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
891	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1261	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
892	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1262	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
893	tripleclickwords utmpInhibit visualBell	1263	urgentOnBell utmpInhibit visualBell
894		1264
895	=item $value = $term->resource ($name[, $newval])	1265	=item $value = $term->resource ($name[, $newval])
896		1266
897	Returns the current resource value associated with a given name and	1267	Returns the current resource value associated with a given name and
898	optionally sets a new value. Setting values is most useful in the C<init>	1268	optionally sets a new value. Setting values is most useful in the C<init>
…		…
907	likely change).	1277	likely change).
908		1278
909	Please note that resource strings will currently only be freed when the	1279	Please note that resource strings will currently only be freed when the
910	terminal is destroyed, so changing options frequently will eat memory.	1280	terminal is destroyed, so changing options frequently will eat memory.
911		1281
912	Here is a a likely non-exhaustive list of resource names, not all of which	1282	Here is a likely non-exhaustive list of resource names, not all of which
913	are supported in every build, please see the source file F</src/rsinc.h>	1283	are supported in every build, please see the source file F</src/rsinc.h>
914	to see the actual list:	1284	to see the actual list:
915		1285
916	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1286	answerbackstring backgroundPixmap backspace_key blurradius
917	borderLess color cursorBlink cursorUnderline cutchars delete_key	1287	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
918	display_name embed ext_bwidth fade font geometry hold iconName	1288	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
919	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1289	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1290	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
920	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1291	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
921	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1292	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
922	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1293	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
923	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1294	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
924	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1295	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
925	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1296	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
926	shade term_name title transparent transparent_all tripleclickwords	1297	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1298	term_name title transient_for transparent tripleclickwords urgentOnBell
927	utmpInhibit visualBell	1299	utmpInhibit visualBell
928		1300
929	=cut	1301	=cut
930		1302
931	sub resource($$;$) {	1303	sub resource($$;$) {
932	my ($self, $name) = (shift, shift);	1304	my ($self, $name) = (shift, shift);
933	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1305	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
934	&urxvt::term::_resource	1306	goto &urxvt::term::_resource
935	}	1307	}
936		1308
937	=item $value = $term->x_resource ($pattern)	1309	=item $value = $term->x_resource ($pattern)
938		1310
939	Returns the X-Resource for the given pattern, excluding the program or	1311	Returns the X-Resource for the given pattern, excluding the program or
940	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1312	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
941	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1313	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
942	resource with that pattern exists.	1314	resource with that pattern exists.
943		1315
		1316	Extensions that define extra resources also need to call this method
		1317	to access their values.
		1318
		1319	If the method is called on an extension object (basically, from an
		1320	extension), then the special prefix C<%.> will be replaced by the name of
		1321	the extension and a dot, and the lone string C<%> will be replaced by the
		1322	extension name itself. This makes it possible to code extensions so you
		1323	can rename them and get a new set of resources without having to change
		1324	the actual code.
		1325
944	This method should only be called during the C<on_start> hook, as there is	1326	This method should only be called during the C<on_start> hook, as there is
945	only one resource database per display, and later invocations might return	1327	only one resource database per display, and later invocations might return
946	the wrong resources.	1328	the wrong resources.
947		1329
948	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1330	=item $value = $term->x_resource_boolean ($pattern)
949		1331
		1332	Like C<x_resource>, above, but interprets the string value as a boolean
		1333	and returns C<1> for true values, C<0> for false values and C<undef> if
		1334	the resource or option isn't specified.
		1335
		1336	You should always use this method to parse boolean resources.
		1337
		1338	=cut
		1339
		1340	sub x_resource_boolean {
		1341	my $res = &x_resource;
		1342
		1343	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1344	}
		1345
		1346	=item $success = $term->bind_action ($key, $octets)
		1347
950	Adds a keymap translation exactly as specified via a resource. See the	1348	Adds a key binding exactly as specified via a C<keysym> resource. See the
951	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1349	C<keysym> resource in the urxvt(1) manpage.
952		1350
953	=item $rend = $term->rstyle ([$new_rstyle])	1351	=item $rend = $term->rstyle ([$new_rstyle])
954		1352
955	Return and optionally change the current rendition. Text that is output by	1353	Return and optionally change the current rendition. Text that is output by
956	the terminal application will use this style.	1354	the terminal application will use this style.
…		…
964		1362
965	=item ($row, $col) = $term->selection_beg ([$row, $col])	1363	=item ($row, $col) = $term->selection_beg ([$row, $col])
966		1364
967	=item ($row, $col) = $term->selection_end ([$row, $col])	1365	=item ($row, $col) = $term->selection_end ([$row, $col])
968		1366
969	Return the current values of the selection mark, begin or end positions,	1367	Return the current values of the selection mark, begin or end positions.
970	and optionally set them to new values.	1368
		1369	When arguments are given, then the selection coordinates are set to
		1370	C<$row> and C<$col>, and the selection screen is set to the current
		1371	screen.
		1372
		1373	=item $screen = $term->selection_screen ([$screen])
		1374
		1375	Returns the current selection screen, and then optionally sets it.
971		1376
972	=item $term->selection_make ($eventtime[, $rectangular])	1377	=item $term->selection_make ($eventtime[, $rectangular])
973		1378
974	Tries to make a selection as set by C<selection_beg> and	1379	Tries to make a selection as set by C<selection_beg> and
975	C<selection_end>. If C<$rectangular> is true (default: false), a	1380	C<selection_end>. If C<$rectangular> is true (default: false), a
976	rectangular selection will be made. This is the prefered function to make	1381	rectangular selection will be made. This is the preferred function to make
977	a selection.	1382	a selection.
978		1383
979	=item $success = $term->selection_grab ($eventtime)	1384	=item $success = $term->selection_grab ($eventtime[, $clipboard])
980		1385
981	Try to request the primary selection text from the server (for example, as	1386	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1387	true) selection from the server. The corresponding text can be set
982	set by the next method). No visual feedback will be given. This function	1388	with the next method. No visual feedback will be given. This function
983	is mostly useful from within C<on_sel_grab> hooks.	1389	is mostly useful from within C<on_sel_grab> hooks.
984		1390
985	=item $oldtext = $term->selection ([$newtext])	1391	=item $oldtext = $term->selection ([$newtext, $clipboard])
986		1392
987	Return the current selection text and optionally replace it by C<$newtext>.	1393	Return the current selection (clipboard if C<$clipboard> is true) text
		1394	and optionally replace it by C<$newtext>.
		1395
		1396	=item $term->selection_clear ([$clipboard])
		1397
		1398	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
988		1399
989	=item $term->overlay_simple ($x, $y, $text)	1400	=item $term->overlay_simple ($x, $y, $text)
990		1401
991	Create a simple multi-line overlay box. See the next method for details.	1402	Create a simple multi-line overlay box. See the next method for details.
992		1403
…		…
1022		1433
1023	The methods currently supported on C<urxvt::overlay> objects are:	1434	The methods currently supported on C<urxvt::overlay> objects are:
1024		1435
1025	=over 4	1436	=over 4
1026		1437
1027	=item $overlay->set ($x, $y, $text, $rend)	1438	=item $overlay->set ($x, $y, $text[, $rend])
1028		1439
1029	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1440	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1030	text in rxvt-unicode's special encoding and an array of rendition values	1441	text in rxvt-unicode's special encoding and an array of rendition values
1031	at a specific position inside the overlay.	1442	at a specific position inside the overlay.
		1443
		1444	If C<$rend> is missing, then the rendition will not be changed.
1032		1445
1033	=item $overlay->hide	1446	=item $overlay->hide
1034		1447
1035	If visible, hide the overlay, but do not destroy it.	1448	If visible, hide the overlay, but do not destroy it.
1036		1449
…		…
1099		1512
1100	=item $term->scr_add_lines ($string)	1513	=item $term->scr_add_lines ($string)
1101		1514
1102	Write the given text string to the screen, as if output by the application	1515	Write the given text string to the screen, as if output by the application
1103	running inside the terminal. It may not contain command sequences (escape	1516	running inside the terminal. It may not contain command sequences (escape
1104	codes), but is free to use line feeds, carriage returns and tabs. The	1517	codes - see C<cmd_parse> for that), but is free to use line feeds,
1105	string is a normal text string, not in locale-dependent encoding.	1518	carriage returns and tabs. The string is a normal text string, not in
		1519	locale-dependent encoding.
1106		1520
1107	Normally its not a good idea to use this function, as programs might be	1521	Normally its not a good idea to use this function, as programs might be
1108	confused by changes in cursor position or scrolling. Its useful inside a	1522	confused by changes in cursor position or scrolling. Its useful inside a
1109	C<on_add_lines> hook, though.	1523	C<on_add_lines> hook, though.
1110		1524
		1525	=item $term->scr_change_screen ($screen)
		1526
		1527	Switch to given screen - 0 primary, 1 secondary.
		1528
1111	=item $term->cmd_parse ($octets)	1529	=item $term->cmd_parse ($octets)
1112		1530
1113	Similar to C<scr_add_lines>, but the argument must be in the	1531	Similar to C<scr_add_lines>, but the argument must be in the
1114	locale-specific encoding of the terminal and can contain command sequences	1532	locale-specific encoding of the terminal and can contain command sequences
1115	(escape codes) that will be interpreted.	1533	(escape codes) that will be interpreted.
1116		1534
1117	=item $term->tt_write ($octets)	1535	=item $term->tt_write ($octets)
1118		1536
1119	Write the octets given in C<$data> to the tty (i.e. as program input). To	1537	Write the octets given in C<$octets> to the tty (i.e. as user input
		1538	to the program, see C<cmd_parse> for the opposite direction). To pass
1120	pass characters instead of octets, you should convert your strings first	1539	characters instead of octets, you should convert your strings first to the
1121	to the locale-specific encoding using C<< $term->locale_encode >>.	1540	locale-specific encoding using C<< $term->locale_encode >>.
		1541
		1542	=item $term->tt_write_user_input ($octets)
		1543
		1544	Like C<tt_write>, but should be used when writing strings in response to
		1545	the user pressing a key, to invoke the additional actions requested by
		1546	the user for that case (C<tt_write> doesn't do that).
		1547
		1548	The typical use case would be inside C<on_action> hooks.
		1549
		1550	=item $term->tt_paste ($octets)
		1551
		1552	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1553	CR and bracketing the data with control sequences if bracketed paste mode
		1554	is set.
1122		1555
1123	=item $old_events = $term->pty_ev_events ([$new_events])	1556	=item $old_events = $term->pty_ev_events ([$new_events])
1124		1557
1125	Replaces the event mask of the pty watcher by the given event mask. Can	1558	Replaces the event mask of the pty watcher by the given event mask. Can
1126	be used to suppress input and output handling to the pty/tty. See the	1559	be used to suppress input and output handling to the pty/tty. See the
1127	description of C<< urxvt::timer->events >>. Make sure to always restore	1560	description of C<< urxvt::timer->events >>. Make sure to always restore
1128	the previous value.	1561	the previous value.
1129		1562
		1563	=item $fd = $term->pty_fd
		1564
		1565	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1566	is used.
		1567
1130	=item $windowid = $term->parent	1568	=item $windowid = $term->parent
1131		1569
1132	Return the window id of the toplevel window.	1570	Return the window id of the toplevel window.
1133		1571
1134	=item $windowid = $term->vt	1572	=item $windowid = $term->vt
1135		1573
1136	Return the window id of the terminal window.	1574	Return the window id of the terminal window.
1137		1575
		1576	=item $term->vt_emask_add ($x_event_mask)
		1577
		1578	Adds the specified events to the vt event mask. Useful e.g. when you want
		1579	to receive pointer events all the times:
		1580
		1581	$term->vt_emask_add (urxvt::PointerMotionMask);
		1582
		1583	=item $term->set_urgency ($set)
		1584
		1585	Enable/disable the urgency hint on the toplevel window.
		1586
		1587	=item $term->focus_in
		1588
		1589	=item $term->focus_out
		1590
		1591	=item $term->key_press ($state, $keycode[, $time])
		1592
		1593	=item $term->key_release ($state, $keycode[, $time])
		1594
		1595	Deliver various fake events to to terminal.
		1596
1138	=item $window_width = $term->width	1597	=item $window_width = $term->width
1139		1598
1140	=item $window_height = $term->height	1599	=item $window_height = $term->height
1141		1600
1142	=item $font_width = $term->fwidth	1601	=item $font_width = $term->fwidth
…		…
1155		1614
1156	=item $max_scrollback = $term->saveLines	1615	=item $max_scrollback = $term->saveLines
1157		1616
1158	=item $nrow_plus_saveLines = $term->total_rows	1617	=item $nrow_plus_saveLines = $term->total_rows
1159		1618
1160	=item $lines_in_scrollback = $term->nsaved	1619	=item $topmost_scrollback_row = $term->top_row
1161		1620
1162	Return various integers describing terminal characteristics.	1621	Return various integers describing terminal characteristics.
1163		1622
1164	=item $x_display = $term->display_id	1623	=item $x_display = $term->display_id
1165		1624
…		…
1172	=item $env = $term->env	1631	=item $env = $term->env
1173		1632
1174	Returns a copy of the environment in effect for the terminal as a hashref	1633	Returns a copy of the environment in effect for the terminal as a hashref
1175	similar to C<\%ENV>.	1634	similar to C<\%ENV>.
1176		1635
		1636	=item @envv = $term->envv
		1637
		1638	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1639
		1640	=item @argv = $term->argv
		1641
		1642	Return the argument vector as this terminal, similar to @ARGV, but
		1643	includes the program name as first element.
		1644
1177	=cut	1645	=cut
1178		1646
1179	sub env {	1647	sub env {
1180	if (my $env = $_[0]->_env) {
1181	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1648	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1182	} else {
1183	+{ %ENV }
1184	}
1185	}	1649	}
1186		1650
1187	=item $modifiermask = $term->ModLevel3Mask	1651	=item $modifiermask = $term->ModLevel3Mask
1188		1652
1189	=item $modifiermask = $term->ModMetaMask	1653	=item $modifiermask = $term->ModMetaMask
…		…
1191	=item $modifiermask = $term->ModNumLockMask	1655	=item $modifiermask = $term->ModNumLockMask
1192		1656
1193	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1657	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1658	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1195		1659
		1660	=item $screen = $term->current_screen
		1661
		1662	Returns the currently displayed screen (0 primary, 1 secondary).
		1663
		1664	=item $cursor_is_hidden = $term->hidden_cursor
		1665
		1666	Returns whether the cursor is currently hidden or not.
		1667
1196	=item $view_start = $term->view_start ([$newvalue])	1668	=item $view_start = $term->view_start ([$newvalue])
1197		1669
1198	Returns the negative row number of the topmost line. Minimum value is	1670	Returns the row number of the topmost displayed line. Maximum value is
1199	C<0>, which displays the normal terminal contents. Larger values scroll	1671	C<0>, which displays the normal terminal contents. Lower values scroll
1200	this many lines into the scrollback buffer.	1672	this many lines into the scrollback buffer.
1201		1673
1202	=item $term->want_refresh	1674	=item $term->want_refresh
1203		1675
1204	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1676	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1207		1679
1208	Used after changing terminal contents to display them.	1680	Used after changing terminal contents to display them.
1209		1681
1210	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1682	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1211		1683
1212	Returns the text of the entire row with number C<$row_number>. Row C<0>	1684	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1213	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1685	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1214	terminal line. The scrollback buffer starts at line C<-1> and extends to
1215	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1686	terminal line. Nothing will be returned if a nonexistent line
1216	is requested.	1687	is requested.
1217		1688
1218	If C<$new_text> is specified, it will replace characters in the current	1689	If C<$new_text> is specified, it will replace characters in the current
1219	line, starting at column C<$start_col> (default C<0>), which is useful	1690	line, starting at column C<$start_col> (default C<0>), which is useful
1220	to replace only parts of a line. The font index in the rendition will	1691	to replace only parts of a line. The font index in the rendition will
1221	automatically be updated.	1692	automatically be updated.
1222		1693
1223	C<$text> is in a special encoding: tabs and wide characters that use more	1694	C<$text> is in a special encoding: tabs and wide characters that use more
1224	than one cell when displayed are padded with urxvt::NOCHAR characters	1695	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1225	(C<chr 65535>). Characters with combining characters and other characters	1696	characters. Characters with combining characters and other characters that
1226	that do not fit into the normal tetx encoding will be replaced with	1697	do not fit into the normal text encoding will be replaced with characters
1227	characters in the private use area.	1698	in the private use area.
1228		1699
1229	You have to obey this encoding when changing text. The advantage is	1700	You have to obey this encoding when changing text. The advantage is
1230	that C<substr> and similar functions work on screen cells and not on	1701	that C<substr> and similar functions work on screen cells and not on
1231	characters.	1702	characters.
1232		1703
…		…
1316	}	1787	}
1317		1788
1318	sub urxvt::line::t {	1789	sub urxvt::line::t {
1319	my ($self) = @_;	1790	my ($self) = @_;
1320		1791
1321	if (@_ > 1)	1792	if (@_ > 1) {
1322	{
1323	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1793	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1324	for $self->{beg} .. $self->{end};	1794	for $self->{beg} .. $self->{end};
1325	}	1795	}
1326		1796
1327	defined wantarray &&	1797	defined wantarray &&
1328	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1798	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1329	0, $self->{len}	1799	0, $self->{len}
1330	}	1800	}
1331		1801
1332	sub urxvt::line::r {	1802	sub urxvt::line::r {
1333	my ($self) = @_;	1803	my ($self) = @_;
1334		1804
1335	if (@_ > 1)	1805	if (@_ > 1) {
1336	{
1337	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1806	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1338	for $self->{beg} .. $self->{end};	1807	for $self->{beg} .. $self->{end};
1339	}	1808	}
1340		1809
1341	if (defined wantarray) {	1810	if (defined wantarray) {
1342	my $rend = [	1811	my $rend = [
1343	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1812	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1344	];	1813	];
…		…
1376	where one character corresponds to one screen cell. See	1845	where one character corresponds to one screen cell. See
1377	C<< $term->ROW_t >> for details.	1846	C<< $term->ROW_t >> for details.
1378		1847
1379	=item $string = $term->special_decode $text	1848	=item $string = $term->special_decode $text
1380		1849
1381	Converts rxvt-unicodes text reprsentation into a perl string. See	1850	Converts rxvt-unicodes text representation into a perl string. See
1382	C<< $term->ROW_t >> for details.	1851	C<< $term->ROW_t >> for details.
1383		1852
1384	=item $success = $term->grab_button ($button, $modifiermask)	1853	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1385		1854
		1855	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1856
1386	Registers a synchronous button grab. See the XGrabButton manpage.	1857	Register/unregister a synchronous button grab. See the XGrabButton
		1858	manpage.
1387		1859
1388	=item $success = $term->grab ($eventtime[, $sync])	1860	=item $success = $term->grab ($eventtime[, $sync])
1389		1861
1390	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1862	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1391	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1863	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1392		1864
1393	=item $term->allow_events_async	1865	=item $term->allow_events_async
1394		1866
1395	Calls XAllowEvents with AsyncBoth for the most recent grab.	1867	Calls XAllowEvents with AsyncBoth for the most recent grab.
1396		1868
…		…
1403	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1875	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1404	recent grab.	1876	recent grab.
1405		1877
1406	=item $term->ungrab	1878	=item $term->ungrab
1407		1879
1408	Calls XUngrab for the most recent grab. Is called automatically on	1880	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1409	evaluation errors, as it is better to lose the grab in the error case as	1881	evaluation errors, as it is better to lose the grab in the error case as
1410	the session.	1882	the session.
		1883
		1884	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1885
		1886	=item $atom_name = $term->XGetAtomName ($atom)
		1887
		1888	=item @atoms = $term->XListProperties ($window)
		1889
		1890	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1891
		1892	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1893
		1894	=item $term->XDeleteProperty ($window, $property)
		1895
		1896	=item $window = $term->DefaultRootWindow
		1897
		1898	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1899
		1900	=item $term->XMapWindow ($window)
		1901
		1902	=item $term->XUnmapWindow ($window)
		1903
		1904	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1905
		1906	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1907
		1908	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1909
		1910	=item $keysym = $term->XStringToKeysym ($string)
		1911
		1912	=item $string = $term->XKeysymToString ($keysym)
		1913
		1914	Various X or X-related functions. The C<$term> object only serves as
		1915	the source of the display, otherwise those functions map more-or-less
		1916	directly onto the X functions of the same name.
1411		1917
1412	=back	1918	=back
1413		1919
1414	=cut	1920	=cut
1415		1921
…		…
1479	my ($self, $text, $cb) = @_;	1985	my ($self, $text, $cb) = @_;
1480		1986
1481	$self->add_item ({ type => "button", text => $text, activate => $cb});	1987	$self->add_item ({ type => "button", text => $text, activate => $cb});
1482	}	1988	}
1483		1989
1484	=item $popup->add_toggle ($text, $cb, $initial_value)	1990	=item $popup->add_toggle ($text, $initial_value, $cb)
1485		1991
1486	Adds a toggle/checkbox item to the popup. Teh callback gets called	1992	Adds a toggle/checkbox item to the popup. The callback gets called
1487	whenever it gets toggled, with a boolean indicating its value as its first	1993	whenever it gets toggled, with a boolean indicating its new value as its
1488	argument.	1994	first argument.
1489		1995
1490	=cut	1996	=cut
1491		1997
1492	sub add_toggle {	1998	sub add_toggle {
1493	my ($self, $text, $cb, $value) = @_;	1999	my ($self, $text, $value, $cb) = @_;
1494		2000
1495	my $item; $item = {	2001	my $item; $item = {
1496	type => "button",	2002	type => "button",
1497	text => " $text",	2003	text => " $text",
1498	value => $value,	2004	value => $value,
…		…
1517	my $env = $self->{term}->env;	2023	my $env = $self->{term}->env;
1518	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2024	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1519	delete $env->{LC_ALL};	2025	delete $env->{LC_ALL};
1520	$env->{LC_CTYPE} = $self->{term}->locale;	2026	$env->{LC_CTYPE} = $self->{term}->locale;
1521		2027
1522	urxvt::term->new ($env, $self->{term}->resource ("name"),	2028	my $term = urxvt::term->new (
1523	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2029	$env, "popup",
		2030	"--perl-lib" => "", "--perl-ext-common" => "",
		2031	"-pty-fd" => -1, "-sl" => 0,
		2032	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1524	"--transient-for" => $self->{term}->parent,	2033	"--transient-for" => $self->{term}->parent,
1525	"-display" => $self->{term}->display_id,	2034	"-display" => $self->{term}->display_id,
1526	"-pe" => "urxvt-popup")	2035	"-pe" => "urxvt-popup",
1527	or die "unable to create popup window\n";	2036	) or die "unable to create popup window\n";
		2037
		2038	unless (delete $term->{urxvt_popup_init_done}) {
		2039	$term->ungrab;
		2040	$term->destroy;
		2041	die "unable to initialise popup window\n";
		2042	}
1528	}	2043	}
1529		2044
1530	sub DESTROY {	2045	sub DESTROY {
1531	my ($self) = @_;	2046	my ($self) = @_;
1532		2047
1533	delete $self->{term}{_destroy}{$self};	2048	delete $self->{term}{_destroy}{$self};
1534	$self->{term}->ungrab;	2049	$self->{term}->ungrab;
1535	}	2050	}
1536		2051
1537	=back	2052	=back
		2053
		2054	=cut
		2055
		2056	package urxvt::watcher;
1538		2057
1539	=head2 The C<urxvt::timer> Class	2058	=head2 The C<urxvt::timer> Class
1540		2059
1541	This class implements timer watchers/events. Time is represented as a	2060	This class implements timer watchers/events. Time is represented as a
1542	fractional number of seconds since the epoch. Example:	2061	fractional number of seconds since the epoch. Example:
…		…
1546	->new	2065	->new
1547	->interval (1)	2066	->interval (1)
1548	->cb (sub {	2067	->cb (sub {
1549	$term->{overlay}->set (0, 0,	2068	$term->{overlay}->set (0, 0,
1550	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2069	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1551	});	2070	});
1552		2071
1553	=over 4	2072	=over 4
1554		2073
1555	=item $timer = new urxvt::timer	2074	=item $timer = new urxvt::timer
1556		2075
…		…
1559		2078
1560	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2079	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1561		2080
1562	Set the callback to be called when the timer triggers.	2081	Set the callback to be called when the timer triggers.
1563		2082
1564	=item $tstamp = $timer->at
1565
1566	Return the time this watcher will fire next.
1567
1568	=item $timer = $timer->set ($tstamp)	2083	=item $timer = $timer->set ($tstamp[, $interval])
1569		2084
1570	Set the time the event is generated to $tstamp.	2085	Set the time the event is generated to $tstamp (and optionally specifies a
		2086	new $interval).
1571		2087
1572	=item $timer = $timer->interval ($interval)	2088	=item $timer = $timer->interval ($interval)
1573		2089
1574	Normally (and when C<$interval> is C<0>), the timer will automatically	2090	By default (and when C<$interval> is C<0>), the timer will automatically
1575	stop after it has fired once. If C<$interval> is non-zero, then the timer	2091	stop after it has fired once. If C<$interval> is non-zero, then the timer
1576	is automatically rescheduled at the given intervals.	2092	is automatically rescheduled at the given intervals.
1577		2093
1578	=item $timer = $timer->start	2094	=item $timer = $timer->start
1579		2095
1580	Start the timer.	2096	Start the timer.
1581		2097
1582	=item $timer = $timer->start ($tstamp)	2098	=item $timer = $timer->start ($tstamp[, $interval])
1583		2099
1584	Set the event trigger time to C<$tstamp> and start the timer.	2100	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2101	also replaces the interval.
		2102
		2103	=item $timer = $timer->after ($delay[, $interval])
		2104
		2105	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1585		2106
1586	=item $timer = $timer->stop	2107	=item $timer = $timer->stop
1587		2108
1588	Stop the timer.	2109	Stop the timer.
1589		2110
…		…
1595		2116
1596	$term->{socket} = ...	2117	$term->{socket} = ...
1597	$term->{iow} = urxvt::iow	2118	$term->{iow} = urxvt::iow
1598	->new	2119	->new
1599	->fd (fileno $term->{socket})	2120	->fd (fileno $term->{socket})
1600	->events (urxvt::EVENT_READ)	2121	->events (urxvt::EV_READ)
1601	->start	2122	->start
1602	->cb (sub {	2123	->cb (sub {
1603	my ($iow, $revents) = @_;	2124	my ($iow, $revents) = @_;
1604	# $revents must be 1 here, no need to check	2125	# $revents must be 1 here, no need to check
1605	sysread $term->{socket}, my $buf, 8192	2126	sysread $term->{socket}, my $buf, 8192
…		…
1618	Set the callback to be called when io events are triggered. C<$reventmask>	2139	Set the callback to be called when io events are triggered. C<$reventmask>
1619	is a bitset as described in the C<events> method.	2140	is a bitset as described in the C<events> method.
1620		2141
1621	=item $iow = $iow->fd ($fd)	2142	=item $iow = $iow->fd ($fd)
1622		2143
1623	Set the filedescriptor (not handle) to watch.	2144	Set the file descriptor (not handle) to watch.
1624		2145
1625	=item $iow = $iow->events ($eventmask)	2146	=item $iow = $iow->events ($eventmask)
1626		2147
1627	Set the event mask to watch. The only allowed values are	2148	Set the event mask to watch. The only allowed values are
1628	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2149	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1629	together, or C<urxvt::EVENT_NONE>.	2150	together, or C<urxvt::EV_NONE>.
1630		2151
1631	=item $iow = $iow->start	2152	=item $iow = $iow->start
1632		2153
1633	Start watching for requested events on the given handle.	2154	Start watching for requested events on the given handle.
1634		2155
1635	=item $iow = $iow->stop	2156	=item $iow = $iow->stop
1636		2157
1637	Stop watching for events on the given filehandle.	2158	Stop watching for events on the given file handle.
		2159
		2160	=back
		2161
		2162	=head2 The C<urxvt::iw> Class
		2163
		2164	This class implements idle watchers, that get called automatically when
		2165	the process is idle. They should return as fast as possible, after doing
		2166	some useful work.
		2167
		2168	=over 4
		2169
		2170	=item $iw = new urxvt::iw
		2171
		2172	Create a new idle watcher object in stopped state.
		2173
		2174	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2175
		2176	Set the callback to be called when the watcher triggers.
		2177
		2178	=item $timer = $timer->start
		2179
		2180	Start the watcher.
		2181
		2182	=item $timer = $timer->stop
		2183
		2184	Stop the watcher.
		2185
		2186	=back
		2187
		2188	=head2 The C<urxvt::pw> Class
		2189
		2190	This class implements process watchers. They create an event whenever a
		2191	process exits, after which they stop automatically.
		2192
		2193	my $pid = fork;
		2194	...
		2195	$term->{pw} = urxvt::pw
		2196	->new
		2197	->start ($pid)
		2198	->cb (sub {
		2199	my ($pw, $exit_status) = @_;
		2200	...
		2201	});
		2202
		2203	=over 4
		2204
		2205	=item $pw = new urxvt::pw
		2206
		2207	Create a new process watcher in stopped state.
		2208
		2209	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2210
		2211	Set the callback to be called when the timer triggers.
		2212
		2213	=item $pw = $timer->start ($pid)
		2214
		2215	Tells the watcher to start watching for process C<$pid>.
		2216
		2217	=item $pw = $pw->stop
		2218
		2219	Stop the watcher.
1638		2220
1639	=back	2221	=back
1640		2222
1641	=head1 ENVIRONMENT	2223	=head1 ENVIRONMENT
1642		2224
…		…
1651		2233
1652	=item >= 3 - script loading and management	2234	=item >= 3 - script loading and management
1653		2235
1654	=item >=10 - all called hooks	2236	=item >=10 - all called hooks
1655		2237
1656	=item >=11 - hook reutrn values	2238	=item >=11 - hook return values
1657		2239
1658	=back	2240	=back
1659		2241
1660	=head1 AUTHOR	2242	=head1 AUTHOR
1661		2243
1662	Marc Lehmann <pcg@goof.com>	2244	Marc Lehmann <schmorp@schmorp.de>
1663	http://software.schmorp.de/pkg/rxvt-unicode	2245	http://software.schmorp.de/pkg/rxvt-unicode
1664		2246
1665	=cut	2247	=cut
1666		2248
1667	1	2249	1
		2250
		2251	# vim: sw=3:

Diff Legend

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