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.116 by root, Fri Jan 20 16:18:07 2006 UTC vs.
Revision 1.256 by sf-exg, Thu Jul 14 05:10:06 2016 UTC

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

Diff Legend

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