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.112 by root, Thu Jan 19 21:02:06 2006 UTC vs.
Revision 1.250 by sf-exg, Fri Dec 26 21:49:11 2014 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	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 mark-urls
168
169	Uses per-line display filtering (C<on_line_update>) to underline urls and
170	make them clickable. When middle-clicked, the program specified in the
171	resource C<urlLauncher> (default C<x-www-browser>) will be started with
172	the URL as first argument.
173
174	=item automove-background
175
176	This is basically a one-line extension that dynamically changes the background pixmap offset
177	to the window position, in effect creating the same effect as pseudo transparency with
178	a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
181
182	=item block-graphics-to-ascii
183
184	A not very useful example of filtering all text output to the terminal,
185	by replacing all line-drawing characters (U+2500 .. U+259F) by a
186	similar-looking ascii character.
187
188	=item digital-clock
189
190	Displays a digital clock using the built-in overlay.
191
192	=item example-refresh-hooks
193
194	Displays a very simple digital clock in the upper right corner of the
195	window. Illustrates overwriting the refresh callbacks to create your own
196	overlays or changes.
197
198	=item selection-pastebin
199
200	This is a little rarely useful extension that Uploads the selection as
201	textfile to a remote site (or does other things). (The implementation is
202	not currently secure for use in a multiuser environment as it writes to
203	F</tmp> directly.).
204
205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206	i.e.
207
208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209
210	Pressing this combination runs a command with C<%> replaced by the name of
211	the textfile. This command can be set via a resource:
212
213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215	And the default is likely not useful to anybody but the few people around
216	here :)
217
218	The name of the textfile is the hex encoded md5 sum of the selection, so
219	the same content should lead to the same filename.
220
221	After a successful upload the selection will be replaced by the text given
222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
223	for the filename):
224
225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
226
227	=back
228		56
229	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
230		58
231	=head2 General API Considerations	59	=head2 General API Considerations
232		60
…		…
246		74
247	=over 4	75	=over 4
248		76
249	=item $text	77	=item $text
250		78
251	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
252	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.
253		81
254	=item $string	82	=item $string
255		83
256	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
…		…
260	=item $octets	88	=item $octets
261		89
262	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
263	locale-specific way.	91	locale-specific way.
264		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
265	=back	99	=back
266		100
267	=head2 Extension Objects	101	=head2 Extension Objects
268		102
269	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
270	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,
271	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
272	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
273	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
274	use.	109	internal use.
275		110
276	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
277	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
278		113
279	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:
280		123
281	=over 4	124	=over 4
282		125
283	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
284		127
285	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
286	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>
287		130	or C<string>, and C<desc> is the resource description.
288	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
289
290	Dynamically enable the given hooks (named without the C<on_> prefix) for
291	this extension, replacing any previous hook. This is useful when you want
292	to overwrite time-critical hooks only temporarily.
293
294	=item $self->disable ($hook_name[, $hook_name..])
295
296	Dynamically disable the given hooks.
297		131
298	=back	132	=back
299		133
300	=head2 Hooks	134	=head2 Hooks
301		135
302	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
303	called whenever the relevant event happens.	137	called whenever the relevant event happens.
304		138
305	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
306	the in the C<Extension Objects> section.	140	the in the C<Extension Objects> section.
307		141
308	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
309	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
310	relevant action might not be carried out by the C++ code.	144	relevant action might not be carried out by the C++ code.
…		…
323	place.	157	place.
324		158
325	=item on_start $term	159	=item on_start $term
326		160
327	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
328	returning to the mainloop.	162	trying to map (display) the toplevel and returning to the main loop.
		163
		164	=item on_destroy $term
		165
		166	Called whenever something tries to destroy terminal, when the terminal is
		167	still fully functional (not for long, though).
329		168
330	=item on_reset $term	169	=item on_reset $term
331		170
332	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
333	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
…		…
355		194
356	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
357	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
358	by calling C<< $term->selection >>.	197	by calling C<< $term->selection >>.
359		198
360	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.
361		200
362	=item on_sel_extend $term	201	=item on_sel_extend $term
363		202
364	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
365	click) and is either supposed to return false (normal operation), or	204	click) and is either supposed to return false (normal operation), or
366	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
367	processing. This can happen multiple times, as long as the callback	206	processing. This can happen multiple times, as long as the callback
368	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
369	supposed to enlarge the selection more and more, if possible.	208	supposed to enlarge the selection more and more, if possible.
370		209
371	See the F<selection> example extension.	210	See the F<selection> example extension.
372		211
373	=item on_view_change $term, $offset	212	=item on_view_change $term, $offset
374		213
375	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
376	scrolls. Offset C<0> means display the normal terminal, positive values	215	scrolls. Offset C<0> means display the normal terminal, positive values
377	show this many lines of scrollback.	216	show this many lines of scrollback.
378		217
379	=item on_scroll_back $term, $lines, $saved	218	=item on_scroll_back $term, $lines, $saved
380		219
…		…
384		223
385	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,
386	$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
387	number of lines that will be in the scrollback buffer.	226	number of lines that will be in the scrollback buffer.
388		227
389	=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
390		239
391	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	240	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
392	operating system command) is processed. Cursor position and other state	241	operating system command) is processed. Cursor position and other state
393	information is up-to-date when this happens. For interoperability, the	242	information is up-to-date when this happens. For interoperability, the
394	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,
395	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
396	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	}
397		256
398	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,
399	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
400	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.
401		263
402	=item on_add_lines $term, $string	264	=item on_add_lines $term, $string
403		265
404	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
405	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
…		…
410	=item on_tt_write $term, $octets	272	=item on_tt_write $term, $octets
411		273
412	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
413	suppress or filter tty input.	275	suppress or filter tty input.
414		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
415	=item on_line_update $term, $row	284	=item on_line_update $term, $row
416		285
417	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
418	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
419	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,
…		…
426	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
427	you cannot just toggle rendition bits, but only set them.	296	you cannot just toggle rendition bits, but only set them.
428		297
429	=item on_refresh_begin $term	298	=item on_refresh_begin $term
430		299
431	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
432	or similar effects by modify terminal contents in refresh_begin, and	301	similar effects by modifying the terminal contents in refresh_begin, and
433	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
434	code is run after this hook, and takes precedence.	303	code is run after this hook, and takes precedence.
435		304
436	=item on_refresh_end $term	305	=item on_refresh_end $term
437		306
438	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>.
439		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
440	=item on_keyboard_command $term, $string	317	=item on_user_command $term, $string *DEPRECATED*
441		318
442	Called whenever the user presses a key combination that has a	319	Called whenever a user-configured event is being activated (e.g. via
443	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>
444	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.
445		331
446	=item on_x_event $term, $event	332	=item on_x_event $term, $event
447		333
448	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
449	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
450	members are not passed.	336	members are not passed.
451		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
452	=item on_focus_in $term	342	=item on_focus_in $term
453		343
454	Called whenever the window gets the keyboard focus, before rxvt-unicode	344	Called whenever the window gets the keyboard focus, before rxvt-unicode
455	does focus in processing.	345	does focus in processing.
456		346
457	=item on_focus_out $term	347	=item on_focus_out $term
458		348
459	Called wheneever the window loses keyboard focus, before rxvt-unicode does	349	Called whenever the window loses keyboard focus, before rxvt-unicode does
460	focus out processing.	350	focus out processing.
461		351
462	=item on_configure_notify $term, $event	352	=item on_configure_notify $term, $event
463		353
		354	=item on_property_notify $term, $event
		355
464	=item on_key_press $term, $event, $keysym, $octets	356	=item on_key_press $term, $event, $keysym, $octets
465		357
466	=item on_key_release $term, $event, $keysym	358	=item on_key_release $term, $event, $keysym
467		359
468	=item on_button_press $term, $event	360	=item on_button_press $term, $event
…		…
473		365
474	=item on_map_notify $term, $event	366	=item on_map_notify $term, $event
475		367
476	=item on_unmap_notify $term, $event	368	=item on_unmap_notify $term, $event
477		369
478	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
479	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.
480		372
481	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
482	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
483	and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
484		376
485	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
486	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
487		379
488	subwindow.	380	=item on_client_message $term, $event
		381
		382	=item on_wm_protocols $term, $event
		383
		384	=item on_wm_delete_window $term, $event
		385
		386	Called when various types of ClientMessage events are received (all with
		387	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		388
		389	=item on_bell $term
		390
		391	Called on receipt of a bell character.
489		392
490	=back	393	=back
491		394
492	=cut	395	=cut
493		396
494	package urxvt;	397	package urxvt;
495		398
496	use utf8;	399	use utf8;
497	use strict;	400	use strict 'vars';
498	use Carp ();	401	use Carp ();
499	use Scalar::Util ();	402	use Scalar::Util ();
500	use List::Util ();	403	use List::Util ();
501		404
502	our $VERSION = 1;	405	our $VERSION = 1;
503	our $TERM;	406	our $TERM;
		407	our @TERM_INIT; # should go, prevents async I/O etc.
		408	our @TERM_EXT; # should go, prevents async I/O etc.
504	our @HOOKNAME;	409	our @HOOKNAME;
505	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	410	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
506	our %OPTION;	411	our %OPTION;
507		412
508	our $LIBDIR;	413	our $LIBDIR;
509	our $RESNAME;	414	our $RESNAME;
510	our $RESCLASS;	415	our $RESCLASS;
511	our $RXVTNAME;	416	our $RXVTNAME;
512		417
		418	our $NOCHAR = chr 0xffff;
		419
513	=head2 Variables in the C<urxvt> Package	420	=head2 Variables in the C<urxvt> Package
514		421
515	=over 4	422	=over 4
516		423
517	=item $urxvt::LIBDIR	424	=item $urxvt::LIBDIR
…		…
530	=item $urxvt::TERM	437	=item $urxvt::TERM
531		438
532	The current terminal. This variable stores the current C<urxvt::term>	439	The current terminal. This variable stores the current C<urxvt::term>
533	object, whenever a callback/hook is executing.	440	object, whenever a callback/hook is executing.
534		441
		442	=item @urxvt::TERM_INIT
		443
		444	All code references in this array will be called as methods of the next newly
		445	created C<urxvt::term> object (during the C<on_init> phase). The array
		446	gets cleared before the code references that were in it are being executed,
		447	so references can push themselves onto it again if they so desire.
		448
		449	This complements to the perl-eval command line option, but gets executed
		450	first.
		451
		452	=item @urxvt::TERM_EXT
		453
		454	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		455	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		456	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		457
535	=back	458	=back
536		459
537	=head2 Functions in the C<urxvt> Package	460	=head2 Functions in the C<urxvt> Package
538		461
539	=over 4	462	=over 4
540		463
541	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
542		465
543	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
544	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
545	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
546		470
547	=item urxvt::warn $string	471	=item urxvt::warn $string
548		472
549	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
550	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
551	that calls this function.	475	that calls this function.
552		476
553	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
554	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
555		479
556	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).
557		488
558	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
559		490
560	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
561		492
…		…
604		535
605	=item $rend = urxvt::OVERLAY_RSTYLE	536	=item $rend = urxvt::OVERLAY_RSTYLE
606		537
607	Return the rendition mask used for overlays by default.	538	Return the rendition mask used for overlays by default.
608		539
609	=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
610		542
611	Return the bit that enabled bold, italic, blink, reverse-video and	543	Return the bit that enabled bold, italic, blink, reverse-video and
612	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
613	the bitset.	545	the bitset.
614		546
…		…
619	Return the foreground/background colour index, respectively.	551	Return the foreground/background colour index, respectively.
620		552
621	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	553	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
622		554
623	=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
624		558
625	Replace the foreground/background colour in the rendition mask with the	559	Replace the foreground/background colour in the rendition mask with the
626	specified one.	560	specified one.
627		561
628	=item $value = urxvt::GET_CUSTOM $rend	562	=item $value = urxvt::GET_CUSTOM $rend
…		…
647	unless $msg =~ /\n$/;	581	unless $msg =~ /\n$/;
648	urxvt::warn ($msg);	582	urxvt::warn ($msg);
649	};	583	};
650	}	584	}
651		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	if ($v->[1] eq "boolean") {
		610	$term->put_option_db ($name, $flag ? "true" : "false");
		611	return 1;
		612	} else {
		613	$term->put_option_db ($name, $value);
		614	return 1 + 2;
		615	}
		616	}
		617	}
		618
		619	0
		620	}
		621
		622	sub usage {
		623	my ($term, $usage_type) = @_;
		624
		625	$term->scan_extensions;
		626
		627	my $r = $term->{meta}{resource};
		628
		629	for my $pattern (sort keys %$r) {
		630	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		631
		632	$desc .= " (-pe $ext)";
		633
		634	if ($usage_type == 1) {
		635	$pattern =~ y/./-/;
		636	$pattern =~ s/-$/-.../g;
		637
		638	if ($type eq "boolean") {
		639	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		640	} else {
		641	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		642	}
		643	} else {
		644	$pattern =~ s/\.$/.*/g;
		645	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		646	}
		647	}
		648	}
		649
652	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	650	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
653		651
654	sub verbose {	652	sub verbose {
655	my ($level, $msg) = @_;	653	my ($level, $msg) = @_;
656	warn "$msg\n" if $level <= $verbosity;	654	warn "$msg\n" if $level <= $verbosity;
…		…
659	my %extension_pkg;	657	my %extension_pkg;
660		658
661	# load a single script into its own package, once only	659	# load a single script into its own package, once only
662	sub extension_package($) {	660	sub extension_package($) {
663	my ($path) = @_;	661	my ($path) = @_;
664
665	no strict 'refs';
666		662
667	$extension_pkg{$path} ||= do {	663	$extension_pkg{$path} ||= do {
668	$path =~ /([^\/\\]+)$/;	664	$path =~ /([^\/\\]+)$/;
669	my $pkg = $1;	665	my $pkg = $1;
670	$pkg =~ s/[^[:word:]]/_/g;	666	$pkg =~ s/[^[:word:]]/_/g;
671	$pkg = "urxvt::ext::$pkg";	667	$pkg = "urxvt::ext::$pkg";
672		668
673	verbose 3, "loading extension '$path' into package '$pkg'";	669	verbose 3, "loading extension '$path' into package '$pkg'";
674		670
		671	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		672
675	open my $fh, "<:raw", $path	673	open my $fh, "<:raw", $path
676	or die "$path: $!";	674	or die "$path: $!";
677		675
678	@{"$pkg\::ISA"} = urxvt::term::extension::;
679
680	my $source =	676	my $source =
681	"package $pkg; use strict; use utf8;\n"	677	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
682	. "#line 1 \"$path\"\n{\n"	678	. "#line 1 \"$path\"\n{\n"
683	. (do { local $/; <$fh> })	679	. (do { local $/; <$fh> })
684	. "\n};\n1";	680	. "\n};\n1";
685		681
686	eval $source	682	eval $source
…		…
695	# called by the rxvt core	691	# called by the rxvt core
696	sub invoke {	692	sub invoke {
697	local $TERM = shift;	693	local $TERM = shift;
698	my $htype = shift;	694	my $htype = shift;
699		695
700	if ($htype == 0) { # INIT	696	if ($htype == HOOK_INIT) {
701	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	697	my @dirs = $TERM->perl_libdirs;
702		698
		699	$TERM->scan_extensions;
		700
703	my %ext_arg;	701	my %ext_arg;
704		702
		703	{
		704	my @init = @TERM_INIT;
		705	@TERM_INIT = ();
		706	$_->($TERM) for @init;
		707	my @pkg = @TERM_EXT;
		708	@TERM_EXT = ();
		709	$TERM->register_package ($_) for @pkg;
		710	}
		711
		712	for (
705	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	713	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		714	@{ delete $TERM->{perl_ext_3} }
		715	) {
706	if ($_ eq "default") {	716	if ($_ eq "default") {
		717
		718	$ext_arg{$_} = []
707	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	719	for qw(selection option-popup selection-popup readline searchable-scrollback);
		720
		721	for ($TERM->_keysym_resources) {
		722	next if /^(?:string|command|builtin|builtin-string|perl)/;
		723	next unless /^([A-Za-z0-9_\-]+):/;
		724
		725	my $ext = $1;
		726
		727	$ext_arg{$ext} = [];
		728	}
		729
708	} elsif (/^-(.*)$/) {	730	} elsif (/^-(.*)$/) {
709	delete $ext_arg{$1};	731	delete $ext_arg{$1};
		732
710	} elsif (/^([^<]+)<(.*)>$/) {	733	} elsif (/^([^<]+)<(.*)>$/) {
711	push @{ $ext_arg{$1} }, $2;	734	push @{ $ext_arg{$1} }, $2;
		735
712	} else {	736	} else {
713	$ext_arg{$_} ||= [];	737	$ext_arg{$_} ||= [];
714	}	738	}
715	}	739	}
716		740
717	while (my ($ext, $argv) = each %ext_arg) {	741	for my $ext (sort keys %ext_arg) {
718	my @files = grep -f $_, map "$_/$ext", @dirs;	742	my @files = grep -f $_, map "$_/$ext", @dirs;
719		743
720	if (@files) {	744	if (@files) {
721	$TERM->register_package (extension_package $files[0], $argv);	745	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
722	} else {	746	} else {
723	warn "perl extension '$ext' not found in perl library search path\n";	747	warn "perl extension '$ext' not found in perl library search path\n";
724	}	748	}
725	}	749	}
726		750
…		…
732		756
733	if (my $cb = $TERM->{_hook}[$htype]) {	757	if (my $cb = $TERM->{_hook}[$htype]) {
734	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	758	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
735	if $verbosity >= 10;	759	if $verbosity >= 10;
736		760
737	keys %$cb;	761	if ($htype == HOOK_ACTION) {
		762	# this hook is only sent to the extension with the name
		763	# matching the first arg
		764	my $pkg = shift;
		765	$pkg =~ y/-/_/;
		766	$pkg = "urxvt::ext::$pkg";
738		767
739	while (my ($pkg, $cb) = each %$cb) {	768	$cb = $cb->{$pkg}
		769	or return undef; #TODO: maybe warn user?
		770
		771	$cb = { $pkg => $cb };
		772	}
		773
		774	for my $pkg (keys %$cb) {
740	$retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	775	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
		776	$retval ||= $retval_;
741		777
742	if ($@) {	778	if ($@) {
743	$TERM->ungrab; # better to lose the grab than the session	779	$TERM->ungrab; # better to lose the grab than the session
744	warn $@;	780	warn $@;
745	}	781	}
…		…
747		783
748	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	784	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
749	if $verbosity >= 11;	785	if $verbosity >= 11;
750	}	786	}
751		787
752	if ($htype == 1) { # DESTROY	788	if ($htype == HOOK_DESTROY) {
753	# clear package objects	789	# clear package objects
754	%$_ = () for values %{ $TERM->{_pkg} };	790	%$_ = () for values %{ $TERM->{_pkg} };
755		791
756	# clear package	792	# clear package
757	%$TERM = ();	793	%$TERM = ();
758	}	794	}
759		795
760	$retval	796	$retval
761	}	797	}
762		798
763	# urxvt::term::extension	799	sub SET_COLOR($$$) {
		800	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		801	}
		802
		803	sub rend2mask {
		804	no strict 'refs';
		805	my ($str, $mask) = (@_, 0);
		806	my %color = ( fg => undef, bg => undef );
		807	my @failed;
		808	for my $spec ( split /\s+/, $str ) {
		809	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		810	$color{lc($1)} = $2;
		811	} else {
		812	my $neg = $spec =~ s/^[-^]//;
		813	unless ( exists &{"RS_$spec"} ) {
		814	push @failed, $spec;
		815	next;
		816	}
		817	my $cur = &{"RS_$spec"};
		818	if ( $neg ) {
		819	$mask &= ~$cur;
		820	} else {
		821	$mask |= $cur;
		822	}
		823	}
		824	}
		825	($mask, @color{qw(fg bg)}, \@failed)
		826	}
764		827
765	package urxvt::term::extension;	828	package urxvt::term::extension;
766		829
767	sub enable {	830	=head2 The C<urxvt::term::extension> class
768	my ($self, %hook) = @_;
769	my $pkg = $self->{_pkg};
770		831
771	while (my ($name, $cb) = each %hook) {	832	Each extension attached to a terminal object is represented by
772	my $htype = $HOOKTYPE{uc $name};	833	a C<urxvt::term::extension> object.
773	defined $htype
774	or Carp::croak "unsupported hook type '$name'";
775		834
776	$self->set_should_invoke ($htype, +1)	835	You can use these objects, which are passed to all callbacks to store any
777	unless exists $self->{term}{_hook}[$htype]{$pkg};	836	state related to the terminal and extension instance.
778		837
779	$self->{term}{_hook}[$htype]{$pkg} = $cb;	838	The methods (And data members) documented below can be called on extension
780	}	839	objects, in addition to call methods documented for the <urxvt::term>
781	}	840	class.
782		841
783	sub disable {	842	=over 4
784	my ($self, @hook) = @_;
785	my $pkg = $self->{_pkg};
786		843
787	for my $name (@hook) {	844	=item $urxvt_term = $self->{term}
788	my $htype = $HOOKTYPE{uc $name};
789	defined $htype
790	or Carp::croak "unsupported hook type '$name'";
791		845
792	$self->set_should_invoke ($htype, -1)	846	Returns the C<urxvt::term> object associated with this instance of the
793	if delete $self->{term}{_hook}[$htype]{$pkg};	847	extension. This member I<must not> be changed in any way.
794	}	848
795	}	849	=cut
796		850
797	our $AUTOLOAD;	851	our $AUTOLOAD;
798		852
799	sub AUTOLOAD {	853	sub AUTOLOAD {
800	$AUTOLOAD =~ /:([^:]+)$/	854	$AUTOLOAD =~ /:([^:]+)$/
…		…
813		867
814	sub DESTROY {	868	sub DESTROY {
815	# nop	869	# nop
816	}	870	}
817		871
818	# urxvt::destroy_hook	872	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
819		873
820	sub urxvt::destroy_hook::DESTROY {	874	sub urxvt::destroy_hook::DESTROY {
821	${$_[0]}->();	875	${$_[0]}->();
822	}	876	}
823		877
824	sub urxvt::destroy_hook(&) {	878	sub urxvt::destroy_hook(&) {
825	bless \shift, urxvt::destroy_hook::	879	bless \shift, urxvt::destroy_hook::
826	}	880	}
		881
		882	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		883
		884	Dynamically enable the given hooks (named without the C<on_> prefix) for
		885	this extension, replacing any hook previously installed via C<enable> in
		886	this extension.
		887
		888	This is useful when you want to overwrite time-critical hooks only
		889	temporarily.
		890
		891	To install additional callbacks for the same hook, you can use the C<on>
		892	method of the C<urxvt::term> class.
		893
		894	=item $self->disable ($hook_name[, $hook_name..])
		895
		896	Dynamically disable the given hooks.
		897
		898	=cut
		899
		900	sub enable {
		901	my ($self, %hook) = @_;
		902	my $pkg = $self->{_pkg};
		903
		904	while (my ($name, $cb) = each %hook) {
		905	my $htype = $HOOKTYPE{uc $name};
		906	defined $htype
		907	or Carp::croak "unsupported hook type '$name'";
		908
		909	$self->set_should_invoke ($htype, +1)
		910	unless exists $self->{term}{_hook}[$htype]{$pkg};
		911
		912	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		913	}
		914	}
		915
		916	sub disable {
		917	my ($self, @hook) = @_;
		918	my $pkg = $self->{_pkg};
		919
		920	for my $name (@hook) {
		921	my $htype = $HOOKTYPE{uc $name};
		922	defined $htype
		923	or Carp::croak "unsupported hook type '$name'";
		924
		925	$self->set_should_invoke ($htype, -1)
		926	if delete $self->{term}{_hook}[$htype]{$pkg};
		927	}
		928	}
		929
		930	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		931
		932	Similar to the C<enable> enable, but installs additional callbacks for
		933	the given hook(s) (that is, it doesn't replace existing callbacks), and
		934	returns a guard object. When the guard object is destroyed the callbacks
		935	are disabled again.
		936
		937	=cut
		938
		939	sub urxvt::extension::on_disable::DESTROY {
		940	my $disable = shift;
		941
		942	my $term = delete $disable->{""};
		943
		944	while (my ($htype, $id) = each %$disable) {
		945	delete $term->{_hook}[$htype]{$id};
		946	$term->set_should_invoke ($htype, -1);
		947	}
		948	}
		949
		950	sub on {
		951	my ($self, %hook) = @_;
		952
		953	my $term = $self->{term};
		954
		955	my %disable = ( "" => $term );
		956
		957	while (my ($name, $cb) = each %hook) {
		958	my $htype = $HOOKTYPE{uc $name};
		959	defined $htype
		960	or Carp::croak "unsupported hook type '$name'";
		961
		962	$term->set_should_invoke ($htype, +1);
		963	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		964	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		965	}
		966
		967	bless \%disable, "urxvt::extension::on_disable"
		968	}
		969
		970	=item $self->bind_action ($hotkey, $action)
		971
		972	=item $self->x_resource ($pattern)
		973
		974	=item $self->x_resource_boolean ($pattern)
		975
		976	These methods support an additional C<%> prefix for C<$action> or
		977	C<$pattern> when called on an extension object, compared to the
		978	C<urxvt::term> methods of the same name - see the description of these
		979	methods in the C<urxvt::term> class for details.
		980
		981	=cut
		982
		983	sub bind_action {
		984	my ($self, $hotkey, $action) = @_;
		985	$action =~ s/^%:/$_[0]{_name}:/;
		986	$self->{term}->bind_action ($hotkey, $action)
		987	}
		988
		989	sub x_resource {
		990	my ($self, $name) = @_;
		991	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		992	$self->{term}->x_resource ($name)
		993	}
		994
		995	sub x_resource_boolean {
		996	my ($self, $name) = @_;
		997	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		998	$self->{term}->x_resource_boolean ($name)
		999	}
		1000
		1001	=back
		1002
		1003	=cut
827		1004
828	package urxvt::anyevent;	1005	package urxvt::anyevent;
829		1006
830	=head2 The C<urxvt::anyevent> Class	1007	=head2 The C<urxvt::anyevent> Class
831		1008
832	The sole purpose of this class is to deliver an interface to the	1009	The sole purpose of this class is to deliver an interface to the
833	C<AnyEvent> module - any module using it will work inside urxvt without	1010	C<AnyEvent> module - any module using it will work inside urxvt without
834	further programming. The only exception is that you cannot wait on	1011	further programming. The only exception is that you cannot wait on
835	condition variables, but non-blocking condvar use is ok. What this means	1012	condition variables, but non-blocking condvar use is ok.
836	is that you cannot use blocking APIs, but the non-blocking variant should
837	work.
838		1013
839	=cut	1014	In practical terms this means is that you cannot use blocking APIs, but
		1015	the non-blocking variant should work.
840		1016
		1017	=cut
		1018
841	our $VERSION = 1;	1019	our $VERSION = '5.23';
842		1020
843	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1021	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
844	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1022	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
845		1023
846	sub timer {	1024	sub timer {
…		…
848		1026
849	my $cb = $arg{cb};	1027	my $cb = $arg{cb};
850		1028
851	urxvt::timer	1029	urxvt::timer
852	->new	1030	->new
853	->start (urxvt::NOW + $arg{after})	1031	->after ($arg{after}, $arg{interval})
854	->cb (sub {	1032	->cb ($arg{interval} ? $cb : sub {
855	$_[0]->stop; # need to cancel manually	1033	$_[0]->stop; # need to cancel manually
856	$cb->();	1034	$cb->();
857	})	1035	})
858	}	1036	}
859		1037
860	sub io {	1038	sub io {
861	my ($class, %arg) = @_;	1039	my ($class, %arg) = @_;
862		1040
863	my $cb = $arg{cb};	1041	my $cb = $arg{cb};
		1042	my $fd = fileno $arg{fh};
		1043	defined $fd or $fd = $arg{fh};
864		1044
865	bless [$arg{fh}, urxvt::iow	1045	bless [$arg{fh}, urxvt::iow
866	->new	1046	->new
867	->fd (fileno $arg{fh})	1047	->fd ($fd)
868	->events (($arg{poll} =~ /r/ ? 1 : 0)	1048	->events (($arg{poll} =~ /r/ ? 1 : 0)
869	| ($arg{poll} =~ /w/ ? 2 : 0))	1049	| ($arg{poll} =~ /w/ ? 2 : 0))
870	->start	1050	->start
871	->cb (sub {	1051	->cb ($cb)
872	$cb->(($_[1] & 1 ? 'r' : '')
873	. ($_[1] & 2 ? 'w' : ''));
874	})],
875	urxvt::anyevent::	1052	], urxvt::anyevent::
		1053	}
		1054
		1055	sub idle {
		1056	my ($class, %arg) = @_;
		1057
		1058	my $cb = $arg{cb};
		1059
		1060	urxvt::iw
		1061	->new
		1062	->start
		1063	->cb ($cb)
		1064	}
		1065
		1066	sub child {
		1067	my ($class, %arg) = @_;
		1068
		1069	my $cb = $arg{cb};
		1070
		1071	urxvt::pw
		1072	->new
		1073	->start ($arg{pid})
		1074	->cb (sub {
		1075	$_[0]->stop; # need to cancel manually
		1076	$cb->($_[0]->rpid, $_[0]->rstatus);
		1077	})
876	}	1078	}
877		1079
878	sub DESTROY {	1080	sub DESTROY {
879	$_[0][1]->stop;	1081	$_[0][1]->stop;
880	}	1082	}
881		1083
882	sub condvar {	1084	# only needed for AnyEvent < 6 compatibility
883	bless \my $flag, urxvt::anyevent::condvar::	1085	sub one_event {
884	}
885
886	sub urxvt::anyevent::condvar::broadcast {
887	${$_[0]}++;
888	}
889
890	sub urxvt::anyevent::condvar::wait {
891	unless (${$_[0]}) {
892	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1086	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
893	}
894	}	1087	}
895		1088
896	package urxvt::term;	1089	package urxvt::term;
897		1090
898	=head2 The C<urxvt::term> Class	1091	=head2 The C<urxvt::term> Class
…		…
904	# find on_xxx subs in the package and register them	1097	# find on_xxx subs in the package and register them
905	# as hooks	1098	# as hooks
906	sub register_package {	1099	sub register_package {
907	my ($self, $pkg, $argv) = @_;	1100	my ($self, $pkg, $argv) = @_;
908		1101
		1102	no strict 'refs';
		1103
		1104	urxvt::verbose 6, "register package $pkg to $self";
		1105
		1106	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1107
909	my $proxy = bless {	1108	my $proxy = bless {
910	_pkg => $pkg,	1109	_pkg => $pkg,
		1110	_name => ${"$pkg\::_NAME"}, # hackish
911	argv => $argv,	1111	argv => $argv,
912	}, $pkg;	1112	}, $pkg;
913	Scalar::Util::weaken ($proxy->{term} = $self);	1113	Scalar::Util::weaken ($proxy->{term} = $self);
914		1114
915	$self->{_pkg}{$pkg} = $proxy;	1115	$self->{_pkg}{$pkg} = $proxy;
916		1116
…		…
919	$proxy->enable ($name => $ref);	1119	$proxy->enable ($name => $ref);
920	}	1120	}
921	}	1121	}
922	}	1122	}
923		1123
		1124	sub perl_libdirs {
		1125	map { split /:/ }
		1126	$_[0]->resource ("perl_lib"),
		1127	$ENV{URXVT_PERL_LIB},
		1128	"$ENV{HOME}/.urxvt/ext",
		1129	"$LIBDIR/perl"
		1130	}
		1131
		1132	# scan for available extensions and collect their metadata
		1133	sub scan_extensions {
		1134	my ($self) = @_;
		1135
		1136	return if exists $self->{meta};
		1137
		1138	my @urxvtdirs = perl_libdirs $self;
		1139	my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1140
		1141	$self->{meta} = \my %meta;
		1142
		1143	# first gather extensions
		1144
		1145	my $gather = sub {
		1146	my ($dir, $core) = @_;
		1147
		1148	opendir my $fh, $dir
		1149	or return;
		1150
		1151	for my $ext (readdir $fh) {
		1152	$ext !~ /^\./
		1153	or next;
		1154
		1155	open my $fh, "<", "$dir/$ext"
		1156	or next;
		1157
		1158	-f $fh
		1159	or next;
		1160
		1161	$ext =~ s/\.uext$// or $core
		1162	or next;
		1163
		1164	my %ext = (dir => $dir);
		1165
		1166	while (<$fh>) {
		1167	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1168	my ($pattern, $type, $desc) = split /:/, $1;
		1169	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1170	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1171	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1172	} else {
		1173	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1174	}
		1175	} elsif (/^\s*(?:#|$)/) {
		1176	# skip other comments and empty lines
		1177	} else {
		1178	last; # stop parsing on first non-empty non-comment line
		1179	}
		1180	}
		1181
		1182	$meta{ext}{$ext} = \%ext;
		1183	}
		1184	};
		1185
		1186	$gather->($_, 0) for @cpandirs;
		1187	$gather->($_, 1) for @urxvtdirs;
		1188
		1189	# and now merge resources
		1190	while (my ($k, $v) = each %{ $meta{ext} }) {
		1191	#TODO: should check for extensions overriding each other
		1192	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1193	}
		1194	}
		1195
924	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1196	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
925		1197
926	Creates a new terminal, very similar as if you had started it with system	1198	Creates a new terminal, very similar as if you had started it with system
927	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1199	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
928	hash which defines the environment of the new terminal.	1200	hash which defines the environment of the new terminal.
929		1201
930	Croaks (and probably outputs an error message) if the new instance	1202	Croaks (and probably outputs an error message) if the new instance
931	couldn't be created. Returns C<undef> if the new instance didn't	1203	couldn't be created. Returns C<undef> if the new instance didn't
932	initialise perl, and the terminal object otherwise. The C<init> and	1204	initialise perl, and the terminal object otherwise. The C<init> and
933	C<start> hooks will be called during this call.	1205	C<start> hooks will be called before this call returns, and are free to
		1206	refer to global data (which is race free).
934		1207
935	=cut	1208	=cut
936		1209
937	sub new {	1210	sub new {
938	my ($class, $env, @args) = @_;	1211	my ($class, $env, @args) = @_;
939		1212
		1213	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1214	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1215
940	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1216	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
941	}	1217	}
942		1218
943	=item $term->destroy	1219	=item $term->destroy
944		1220
945	Destroy the terminal object (close the window, free resources	1221	Destroy the terminal object (close the window, free resources
946	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1222	etc.). Please note that urxvt will not exit as long as any event
947	watchers (timers, io watchers) are still active.	1223	watchers (timers, io watchers) are still active.
948		1224
949	=item $term->exec_async ($cmd[, @args])	1225	=item $term->exec_async ($cmd[, @args])
950		1226
951	Works like the combination of the C<fork>/C<exec> builtins, which executes	1227	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
975		1251
976	Returns true if the option specified by C<$optval> is enabled, and	1252	Returns true if the option specified by C<$optval> is enabled, and
977	optionally change it. All option values are stored by name in the hash	1253	optionally change it. All option values are stored by name in the hash
978	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1254	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
979		1255
980	Here is a a likely non-exhaustive list of option names, please see the	1256	Here is a likely non-exhaustive list of option names, please see the
981	source file F</src/optinc.h> to see the actual list:	1257	source file F</src/optinc.h> to see the actual list:
982		1258
983	borderLess console cursorBlink cursorUnderline hold iconic insecure	1259	borderLess buffered console cursorBlink cursorUnderline hold iconic
984	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1260	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
985	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1261	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
986	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1262	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
987	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1263	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
988	transparent tripleclickwords utmpInhibit visualBell	1264	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1265	urgentOnBell utmpInhibit visualBell
989		1266
990	=item $value = $term->resource ($name[, $newval])	1267	=item $value = $term->resource ($name[, $newval])
991		1268
992	Returns the current resource value associated with a given name and	1269	Returns the current resource value associated with a given name and
993	optionally sets a new value. Setting values is most useful in the C<init>	1270	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1002	likely change).	1279	likely change).
1003		1280
1004	Please note that resource strings will currently only be freed when the	1281	Please note that resource strings will currently only be freed when the
1005	terminal is destroyed, so changing options frequently will eat memory.	1282	terminal is destroyed, so changing options frequently will eat memory.
1006		1283
1007	Here is a a likely non-exhaustive list of resource names, not all of which	1284	Here is a likely non-exhaustive list of resource names, not all of which
1008	are supported in every build, please see the source file F</src/rsinc.h>	1285	are supported in every build, please see the source file F</src/rsinc.h>
1009	to see the actual list:	1286	to see the actual list:
1010		1287
1011	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1288	answerbackstring backgroundPixmap backspace_key blurradius
1012	borderLess color cursorBlink cursorUnderline cutchars delete_key	1289	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1013	display_name embed ext_bwidth fade font geometry hold iconName	1290	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1014	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1291	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1292	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1015	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1293	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1016	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1294	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1017	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1295	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1018	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1296	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1019	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1297	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1020	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1298	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1021	secondaryScreen secondaryScroll selectstyle shade term_name title	1299	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1022	transient_for transparent transparent_all tripleclickwords utmpInhibit	1300	term_name title transient_for transparent tripleclickwords urgentOnBell
1023	visualBell	1301	utmpInhibit visualBell
1024		1302
1025	=cut	1303	=cut
1026		1304
1027	sub resource($$;$) {	1305	sub resource($$;$) {
1028	my ($self, $name) = (shift, shift);	1306	my ($self, $name) = (shift, shift);
1029	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1307	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1030	&urxvt::term::_resource	1308	goto &urxvt::term::_resource
1031	}	1309	}
1032		1310
1033	=item $value = $term->x_resource ($pattern)	1311	=item $value = $term->x_resource ($pattern)
1034		1312
1035	Returns the X-Resource for the given pattern, excluding the program or	1313	Returns the X-Resource for the given pattern, excluding the program or
1036	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1314	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1037	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1315	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1038	resource with that pattern exists.	1316	resource with that pattern exists.
1039		1317
		1318	Extensions that define extra resources also need to call this method
		1319	to access their values.
		1320
		1321	If the method is called on an extension object (basically, from an
		1322	extension), then the special prefix C<%.> will be replaced by the name of
		1323	the extension and a dot, and the lone string C<%> will be replaced by the
		1324	extension name itself. This makes it possible to code extensions so you
		1325	can rename them and get a new set of resources without having to change
		1326	the actual code.
		1327
1040	This method should only be called during the C<on_start> hook, as there is	1328	This method should only be called during the C<on_start> hook, as there is
1041	only one resource database per display, and later invocations might return	1329	only one resource database per display, and later invocations might return
1042	the wrong resources.	1330	the wrong resources.
1043		1331
1044	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1332	=item $value = $term->x_resource_boolean ($pattern)
1045		1333
		1334	Like C<x_resource>, above, but interprets the string value as a boolean
		1335	and returns C<1> for true values, C<0> for false values and C<undef> if
		1336	the resource or option isn't specified.
		1337
		1338	You should always use this method to parse boolean resources.
		1339
		1340	=cut
		1341
		1342	sub x_resource_boolean {
		1343	my $res = &x_resource;
		1344
		1345	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1346	}
		1347
		1348	=item $success = $term->bind_action ($key, $action)
		1349
1046	Adds a keymap translation exactly as specified via a resource. See the	1350	Adds a key binding exactly as specified via a C<keysym> resource. See the
1047	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1351	C<keysym> resource in the urxvt(1) manpage.
		1352
		1353	To add default bindings for actions, an extension should call C<<
		1354	->bind_action >> in its C<init> hook for every such binding. Doing it
		1355	in the C<init> hook allows users to override or remove the binding
		1356	again.
		1357
		1358	Example: the C<searchable-scrollback> by default binds itself
		1359	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1360	$term->bind_action >>.
		1361
		1362	sub init {
		1363	my ($self) = @_;
		1364
		1365	$self->bind_action ("M-s" => "%:start");
		1366	}
1048		1367
1049	=item $rend = $term->rstyle ([$new_rstyle])	1368	=item $rend = $term->rstyle ([$new_rstyle])
1050		1369
1051	Return and optionally change the current rendition. Text that is output by	1370	Return and optionally change the current rendition. Text that is output by
1052	the terminal application will use this style.	1371	the terminal application will use this style.
…		…
1060		1379
1061	=item ($row, $col) = $term->selection_beg ([$row, $col])	1380	=item ($row, $col) = $term->selection_beg ([$row, $col])
1062		1381
1063	=item ($row, $col) = $term->selection_end ([$row, $col])	1382	=item ($row, $col) = $term->selection_end ([$row, $col])
1064		1383
1065	Return the current values of the selection mark, begin or end positions,	1384	Return the current values of the selection mark, begin or end positions.
1066	and optionally set them to new values.	1385
		1386	When arguments are given, then the selection coordinates are set to
		1387	C<$row> and C<$col>, and the selection screen is set to the current
		1388	screen.
		1389
		1390	=item $screen = $term->selection_screen ([$screen])
		1391
		1392	Returns the current selection screen, and then optionally sets it.
1067		1393
1068	=item $term->selection_make ($eventtime[, $rectangular])	1394	=item $term->selection_make ($eventtime[, $rectangular])
1069		1395
1070	Tries to make a selection as set by C<selection_beg> and	1396	Tries to make a selection as set by C<selection_beg> and
1071	C<selection_end>. If C<$rectangular> is true (default: false), a	1397	C<selection_end>. If C<$rectangular> is true (default: false), a
1072	rectangular selection will be made. This is the prefered function to make	1398	rectangular selection will be made. This is the preferred function to make
1073	a selection.	1399	a selection.
1074		1400
1075	=item $success = $term->selection_grab ($eventtime)	1401	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1076		1402
1077	Try to request the primary selection text from the server (for example, as	1403	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1404	true) selection from the server. The corresponding text can be set
1078	set by the next method). No visual feedback will be given. This function	1405	with the next method. No visual feedback will be given. This function
1079	is mostly useful from within C<on_sel_grab> hooks.	1406	is mostly useful from within C<on_sel_grab> hooks.
1080		1407
1081	=item $oldtext = $term->selection ([$newtext])	1408	=item $oldtext = $term->selection ([$newtext, $clipboard])
1082		1409
1083	Return the current selection text and optionally replace it by C<$newtext>.	1410	Return the current selection (clipboard if C<$clipboard> is true) text
		1411	and optionally replace it by C<$newtext>.
		1412
		1413	=item $term->selection_clear ([$clipboard])
		1414
		1415	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1084		1416
1085	=item $term->overlay_simple ($x, $y, $text)	1417	=item $term->overlay_simple ($x, $y, $text)
1086		1418
1087	Create a simple multi-line overlay box. See the next method for details.	1419	Create a simple multi-line overlay box. See the next method for details.
1088		1420
…		…
1118		1450
1119	The methods currently supported on C<urxvt::overlay> objects are:	1451	The methods currently supported on C<urxvt::overlay> objects are:
1120		1452
1121	=over 4	1453	=over 4
1122		1454
1123	=item $overlay->set ($x, $y, $text, $rend)	1455	=item $overlay->set ($x, $y, $text[, $rend])
1124		1456
1125	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1457	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1126	text in rxvt-unicode's special encoding and an array of rendition values	1458	text in rxvt-unicode's special encoding and an array of rendition values
1127	at a specific position inside the overlay.	1459	at a specific position inside the overlay.
		1460
		1461	If C<$rend> is missing, then the rendition will not be changed.
1128		1462
1129	=item $overlay->hide	1463	=item $overlay->hide
1130		1464
1131	If visible, hide the overlay, but do not destroy it.	1465	If visible, hide the overlay, but do not destroy it.
1132		1466
…		…
1195		1529
1196	=item $term->scr_add_lines ($string)	1530	=item $term->scr_add_lines ($string)
1197		1531
1198	Write the given text string to the screen, as if output by the application	1532	Write the given text string to the screen, as if output by the application
1199	running inside the terminal. It may not contain command sequences (escape	1533	running inside the terminal. It may not contain command sequences (escape
1200	codes), but is free to use line feeds, carriage returns and tabs. The	1534	codes - see C<cmd_parse> for that), but is free to use line feeds,
1201	string is a normal text string, not in locale-dependent encoding.	1535	carriage returns and tabs. The string is a normal text string, not in
		1536	locale-dependent encoding.
1202		1537
1203	Normally its not a good idea to use this function, as programs might be	1538	Normally its not a good idea to use this function, as programs might be
1204	confused by changes in cursor position or scrolling. Its useful inside a	1539	confused by changes in cursor position or scrolling. Its useful inside a
1205	C<on_add_lines> hook, though.	1540	C<on_add_lines> hook, though.
1206		1541
		1542	=item $term->scr_change_screen ($screen)
		1543
		1544	Switch to given screen - 0 primary, 1 secondary.
		1545
1207	=item $term->cmd_parse ($octets)	1546	=item $term->cmd_parse ($octets)
1208		1547
1209	Similar to C<scr_add_lines>, but the argument must be in the	1548	Similar to C<scr_add_lines>, but the argument must be in the
1210	locale-specific encoding of the terminal and can contain command sequences	1549	locale-specific encoding of the terminal and can contain command sequences
1211	(escape codes) that will be interpreted.	1550	(escape codes) that will be interpreted.
1212		1551
1213	=item $term->tt_write ($octets)	1552	=item $term->tt_write ($octets)
1214		1553
1215	Write the octets given in C<$data> to the tty (i.e. as program input). To	1554	Write the octets given in C<$octets> to the tty (i.e. as user input
		1555	to the program, see C<cmd_parse> for the opposite direction). To pass
1216	pass characters instead of octets, you should convert your strings first	1556	characters instead of octets, you should convert your strings first to the
1217	to the locale-specific encoding using C<< $term->locale_encode >>.	1557	locale-specific encoding using C<< $term->locale_encode >>.
		1558
		1559	=item $term->tt_write_user_input ($octets)
		1560
		1561	Like C<tt_write>, but should be used when writing strings in response to
		1562	the user pressing a key, to invoke the additional actions requested by
		1563	the user for that case (C<tt_write> doesn't do that).
		1564
		1565	The typical use case would be inside C<on_action> hooks.
		1566
		1567	=item $term->tt_paste ($octets)
		1568
		1569	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1570	CR and bracketing the data with control sequences if bracketed paste mode
		1571	is set.
1218		1572
1219	=item $old_events = $term->pty_ev_events ([$new_events])	1573	=item $old_events = $term->pty_ev_events ([$new_events])
1220		1574
1221	Replaces the event mask of the pty watcher by the given event mask. Can	1575	Replaces the event mask of the pty watcher by the given event mask. Can
1222	be used to suppress input and output handling to the pty/tty. See the	1576	be used to suppress input and output handling to the pty/tty. See the
1223	description of C<< urxvt::timer->events >>. Make sure to always restore	1577	description of C<< urxvt::timer->events >>. Make sure to always restore
1224	the previous value.	1578	the previous value.
1225		1579
		1580	=item $fd = $term->pty_fd
		1581
		1582	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1583	is used.
		1584
1226	=item $windowid = $term->parent	1585	=item $windowid = $term->parent
1227		1586
1228	Return the window id of the toplevel window.	1587	Return the window id of the toplevel window.
1229		1588
1230	=item $windowid = $term->vt	1589	=item $windowid = $term->vt
…		…
1236	Adds the specified events to the vt event mask. Useful e.g. when you want	1595	Adds the specified events to the vt event mask. Useful e.g. when you want
1237	to receive pointer events all the times:	1596	to receive pointer events all the times:
1238		1597
1239	$term->vt_emask_add (urxvt::PointerMotionMask);	1598	$term->vt_emask_add (urxvt::PointerMotionMask);
1240		1599
		1600	=item $term->set_urgency ($set)
		1601
		1602	Enable/disable the urgency hint on the toplevel window.
		1603
		1604	=item $term->focus_in
		1605
		1606	=item $term->focus_out
		1607
		1608	=item $term->key_press ($state, $keycode[, $time])
		1609
		1610	=item $term->key_release ($state, $keycode[, $time])
		1611
		1612	Deliver various fake events to to terminal.
		1613
1241	=item $window_width = $term->width	1614	=item $window_width = $term->width
1242		1615
1243	=item $window_height = $term->height	1616	=item $window_height = $term->height
1244		1617
1245	=item $font_width = $term->fwidth	1618	=item $font_width = $term->fwidth
…		…
1275	=item $env = $term->env	1648	=item $env = $term->env
1276		1649
1277	Returns a copy of the environment in effect for the terminal as a hashref	1650	Returns a copy of the environment in effect for the terminal as a hashref
1278	similar to C<\%ENV>.	1651	similar to C<\%ENV>.
1279		1652
		1653	=item @envv = $term->envv
		1654
		1655	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1656
		1657	=item @argv = $term->argv
		1658
		1659	Return the argument vector as this terminal, similar to @ARGV, but
		1660	includes the program name as first element.
		1661
1280	=cut	1662	=cut
1281		1663
1282	sub env {	1664	sub env {
1283	if (my $env = $_[0]->_env) {
1284	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1665	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1285	} else {
1286	+{ %ENV }
1287	}
1288	}	1666	}
1289		1667
1290	=item $modifiermask = $term->ModLevel3Mask	1668	=item $modifiermask = $term->ModLevel3Mask
1291		1669
1292	=item $modifiermask = $term->ModMetaMask	1670	=item $modifiermask = $term->ModMetaMask
1293		1671
1294	=item $modifiermask = $term->ModNumLockMask	1672	=item $modifiermask = $term->ModNumLockMask
1295		1673
1296	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1674	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1297	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1675	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1676
		1677	=item $screen = $term->current_screen
		1678
		1679	Returns the currently displayed screen (0 primary, 1 secondary).
		1680
		1681	=item $cursor_is_hidden = $term->hidden_cursor
		1682
		1683	Returns whether the cursor is currently hidden or not.
1298		1684
1299	=item $view_start = $term->view_start ([$newvalue])	1685	=item $view_start = $term->view_start ([$newvalue])
1300		1686
1301	Returns the row number of the topmost displayed line. Maximum value is	1687	Returns the row number of the topmost displayed line. Maximum value is
1302	C<0>, which displays the normal terminal contents. Lower values scroll	1688	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1310		1696
1311	Used after changing terminal contents to display them.	1697	Used after changing terminal contents to display them.
1312		1698
1313	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1699	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1314		1700
1315	Returns the text of the entire row with number C<$row_number>. Row C<0>	1701	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1316	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1702	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1317	terminal line. The scrollback buffer starts at line C<-1> and extends to
1318	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1703	terminal line. Nothing will be returned if a nonexistent line
1319	is requested.	1704	is requested.
1320		1705
1321	If C<$new_text> is specified, it will replace characters in the current	1706	If C<$new_text> is specified, it will replace characters in the current
1322	line, starting at column C<$start_col> (default C<0>), which is useful	1707	line, starting at column C<$start_col> (default C<0>), which is useful
1323	to replace only parts of a line. The font index in the rendition will	1708	to replace only parts of a line. The font index in the rendition will
1324	automatically be updated.	1709	automatically be updated.
1325		1710
1326	C<$text> is in a special encoding: tabs and wide characters that use more	1711	C<$text> is in a special encoding: tabs and wide characters that use more
1327	than one cell when displayed are padded with urxvt::NOCHAR characters	1712	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1328	(C<chr 65535>). Characters with combining characters and other characters	1713	characters. Characters with combining characters and other characters that
1329	that do not fit into the normal tetx encoding will be replaced with	1714	do not fit into the normal text encoding will be replaced with characters
1330	characters in the private use area.	1715	in the private use area.
1331		1716
1332	You have to obey this encoding when changing text. The advantage is	1717	You have to obey this encoding when changing text. The advantage is
1333	that C<substr> and similar functions work on screen cells and not on	1718	that C<substr> and similar functions work on screen cells and not on
1334	characters.	1719	characters.
1335		1720
…		…
1419	}	1804	}
1420		1805
1421	sub urxvt::line::t {	1806	sub urxvt::line::t {
1422	my ($self) = @_;	1807	my ($self) = @_;
1423		1808
1424	if (@_ > 1)	1809	if (@_ > 1) {
1425	{
1426	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1810	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1427	for $self->{beg} .. $self->{end};	1811	for $self->{beg} .. $self->{end};
1428	}	1812	}
1429		1813
1430	defined wantarray &&	1814	defined wantarray &&
1431	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1815	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1432	0, $self->{len}	1816	0, $self->{len}
1433	}	1817	}
1434		1818
1435	sub urxvt::line::r {	1819	sub urxvt::line::r {
1436	my ($self) = @_;	1820	my ($self) = @_;
1437		1821
1438	if (@_ > 1)	1822	if (@_ > 1) {
1439	{
1440	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1823	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1441	for $self->{beg} .. $self->{end};	1824	for $self->{beg} .. $self->{end};
1442	}	1825	}
1443		1826
1444	if (defined wantarray) {	1827	if (defined wantarray) {
1445	my $rend = [	1828	my $rend = [
1446	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1829	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1447	];	1830	];
…		…
1479	where one character corresponds to one screen cell. See	1862	where one character corresponds to one screen cell. See
1480	C<< $term->ROW_t >> for details.	1863	C<< $term->ROW_t >> for details.
1481		1864
1482	=item $string = $term->special_decode $text	1865	=item $string = $term->special_decode $text
1483		1866
1484	Converts rxvt-unicodes text reprsentation into a perl string. See	1867	Converts rxvt-unicodes text representation into a perl string. See
1485	C<< $term->ROW_t >> for details.	1868	C<< $term->ROW_t >> for details.
1486		1869
1487	=item $success = $term->grab_button ($button, $modifiermask)	1870	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1488		1871
		1872	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1873
1489	Registers a synchronous button grab. See the XGrabButton manpage.	1874	Register/unregister a synchronous button grab. See the XGrabButton
		1875	manpage.
1490		1876
1491	=item $success = $term->grab ($eventtime[, $sync])	1877	=item $success = $term->grab ($eventtime[, $sync])
1492		1878
1493	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1879	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1494	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1880	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1495		1881
1496	=item $term->allow_events_async	1882	=item $term->allow_events_async
1497		1883
1498	Calls XAllowEvents with AsyncBoth for the most recent grab.	1884	Calls XAllowEvents with AsyncBoth for the most recent grab.
1499		1885
…		…
1506	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1892	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1507	recent grab.	1893	recent grab.
1508		1894
1509	=item $term->ungrab	1895	=item $term->ungrab
1510		1896
1511	Calls XUngrab for the most recent grab. Is called automatically on	1897	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1512	evaluation errors, as it is better to lose the grab in the error case as	1898	evaluation errors, as it is better to lose the grab in the error case as
1513	the session.	1899	the session.
		1900
		1901	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1902
		1903	=item $atom_name = $term->XGetAtomName ($atom)
		1904
		1905	=item @atoms = $term->XListProperties ($window)
		1906
		1907	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1908
		1909	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1910
		1911	=item $term->XDeleteProperty ($window, $property)
		1912
		1913	=item $window = $term->DefaultRootWindow
		1914
		1915	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1916
		1917	=item $term->XMapWindow ($window)
		1918
		1919	=item $term->XUnmapWindow ($window)
		1920
		1921	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1922
		1923	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1924
		1925	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1926
		1927	=item $keysym = $term->XStringToKeysym ($string)
		1928
		1929	=item $string = $term->XKeysymToString ($keysym)
		1930
		1931	Various X or X-related functions. The C<$term> object only serves as
		1932	the source of the display, otherwise those functions map more-or-less
		1933	directly onto the X functions of the same name.
1514		1934
1515	=back	1935	=back
1516		1936
1517	=cut	1937	=cut
1518		1938
…		…
1582	my ($self, $text, $cb) = @_;	2002	my ($self, $text, $cb) = @_;
1583		2003
1584	$self->add_item ({ type => "button", text => $text, activate => $cb});	2004	$self->add_item ({ type => "button", text => $text, activate => $cb});
1585	}	2005	}
1586		2006
1587	=item $popup->add_toggle ($text, $cb, $initial_value)	2007	=item $popup->add_toggle ($text, $initial_value, $cb)
1588		2008
1589	Adds a toggle/checkbox item to the popup. Teh callback gets called	2009	Adds a toggle/checkbox item to the popup. The callback gets called
1590	whenever it gets toggled, with a boolean indicating its value as its first	2010	whenever it gets toggled, with a boolean indicating its new value as its
1591	argument.	2011	first argument.
1592		2012
1593	=cut	2013	=cut
1594		2014
1595	sub add_toggle {	2015	sub add_toggle {
1596	my ($self, $text, $cb, $value) = @_;	2016	my ($self, $text, $value, $cb) = @_;
1597		2017
1598	my $item; $item = {	2018	my $item; $item = {
1599	type => "button",	2019	type => "button",
1600	text => " $text",	2020	text => " $text",
1601	value => $value,	2021	value => $value,
…		…
1620	my $env = $self->{term}->env;	2040	my $env = $self->{term}->env;
1621	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2041	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1622	delete $env->{LC_ALL};	2042	delete $env->{LC_ALL};
1623	$env->{LC_CTYPE} = $self->{term}->locale;	2043	$env->{LC_CTYPE} = $self->{term}->locale;
1624		2044
1625	urxvt::term->new ($env, "popup",	2045	my $term = urxvt::term->new (
		2046	$env, "popup",
1626	"--perl-lib" => "", "--perl-ext-common" => "",	2047	"--perl-lib" => "", "--perl-ext-common" => "",
1627	"-pty-fd" => -1, "-sl" => 0,	2048	"-pty-fd" => -1, "-sl" => 0,
1628	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2049	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1629	"--transient-for" => $self->{term}->parent,	2050	"--transient-for" => $self->{term}->parent,
1630	"-display" => $self->{term}->display_id,	2051	"-display" => $self->{term}->display_id,
1631	"-pe" => "urxvt-popup")	2052	"-pe" => "urxvt-popup",
1632	or die "unable to create popup window\n";	2053	) or die "unable to create popup window\n";
		2054
		2055	unless (delete $term->{urxvt_popup_init_done}) {
		2056	$term->ungrab;
		2057	$term->destroy;
		2058	die "unable to initialise popup window\n";
		2059	}
1633	}	2060	}
1634		2061
1635	sub DESTROY {	2062	sub DESTROY {
1636	my ($self) = @_;	2063	my ($self) = @_;
1637		2064
1638	delete $self->{term}{_destroy}{$self};	2065	delete $self->{term}{_destroy}{$self};
1639	$self->{term}->ungrab;	2066	$self->{term}->ungrab;
1640	}	2067	}
1641		2068
1642	=back	2069	=back
		2070
		2071	=cut
		2072
		2073	package urxvt::watcher;
1643		2074
1644	=head2 The C<urxvt::timer> Class	2075	=head2 The C<urxvt::timer> Class
1645		2076
1646	This class implements timer watchers/events. Time is represented as a	2077	This class implements timer watchers/events. Time is represented as a
1647	fractional number of seconds since the epoch. Example:	2078	fractional number of seconds since the epoch. Example:
…		…
1651	->new	2082	->new
1652	->interval (1)	2083	->interval (1)
1653	->cb (sub {	2084	->cb (sub {
1654	$term->{overlay}->set (0, 0,	2085	$term->{overlay}->set (0, 0,
1655	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2086	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1656	});	2087	});
1657		2088
1658	=over 4	2089	=over 4
1659		2090
1660	=item $timer = new urxvt::timer	2091	=item $timer = new urxvt::timer
1661		2092
…		…
1664		2095
1665	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2096	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1666		2097
1667	Set the callback to be called when the timer triggers.	2098	Set the callback to be called when the timer triggers.
1668		2099
1669	=item $tstamp = $timer->at
1670
1671	Return the time this watcher will fire next.
1672
1673	=item $timer = $timer->set ($tstamp)	2100	=item $timer = $timer->set ($tstamp[, $interval])
1674		2101
1675	Set the time the event is generated to $tstamp.	2102	Set the time the event is generated to $tstamp (and optionally specifies a
		2103	new $interval).
1676		2104
1677	=item $timer = $timer->interval ($interval)	2105	=item $timer = $timer->interval ($interval)
1678		2106
1679	Normally (and when C<$interval> is C<0>), the timer will automatically	2107	By default (and when C<$interval> is C<0>), the timer will automatically
1680	stop after it has fired once. If C<$interval> is non-zero, then the timer	2108	stop after it has fired once. If C<$interval> is non-zero, then the timer
1681	is automatically rescheduled at the given intervals.	2109	is automatically rescheduled at the given intervals.
1682		2110
1683	=item $timer = $timer->start	2111	=item $timer = $timer->start
1684		2112
1685	Start the timer.	2113	Start the timer.
1686		2114
1687	=item $timer = $timer->start ($tstamp)	2115	=item $timer = $timer->start ($tstamp[, $interval])
1688		2116
1689	Set the event trigger time to C<$tstamp> and start the timer.	2117	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2118	also replaces the interval.
1690		2119
1691	=item $timer = $timer->after ($delay)	2120	=item $timer = $timer->after ($delay[, $interval])
1692		2121
1693	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2122	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1694		2123
1695	=item $timer = $timer->stop	2124	=item $timer = $timer->stop
1696		2125
…		…
1704		2133
1705	$term->{socket} = ...	2134	$term->{socket} = ...
1706	$term->{iow} = urxvt::iow	2135	$term->{iow} = urxvt::iow
1707	->new	2136	->new
1708	->fd (fileno $term->{socket})	2137	->fd (fileno $term->{socket})
1709	->events (urxvt::EVENT_READ)	2138	->events (urxvt::EV_READ)
1710	->start	2139	->start
1711	->cb (sub {	2140	->cb (sub {
1712	my ($iow, $revents) = @_;	2141	my ($iow, $revents) = @_;
1713	# $revents must be 1 here, no need to check	2142	# $revents must be 1 here, no need to check
1714	sysread $term->{socket}, my $buf, 8192	2143	sysread $term->{socket}, my $buf, 8192
…		…
1727	Set the callback to be called when io events are triggered. C<$reventmask>	2156	Set the callback to be called when io events are triggered. C<$reventmask>
1728	is a bitset as described in the C<events> method.	2157	is a bitset as described in the C<events> method.
1729		2158
1730	=item $iow = $iow->fd ($fd)	2159	=item $iow = $iow->fd ($fd)
1731		2160
1732	Set the filedescriptor (not handle) to watch.	2161	Set the file descriptor (not handle) to watch.
1733		2162
1734	=item $iow = $iow->events ($eventmask)	2163	=item $iow = $iow->events ($eventmask)
1735		2164
1736	Set the event mask to watch. The only allowed values are	2165	Set the event mask to watch. The only allowed values are
1737	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2166	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1738	together, or C<urxvt::EVENT_NONE>.	2167	together, or C<urxvt::EV_NONE>.
1739		2168
1740	=item $iow = $iow->start	2169	=item $iow = $iow->start
1741		2170
1742	Start watching for requested events on the given handle.	2171	Start watching for requested events on the given handle.
1743		2172
1744	=item $iow = $iow->stop	2173	=item $iow = $iow->stop
1745		2174
1746	Stop watching for events on the given filehandle.	2175	Stop watching for events on the given file handle.
		2176
		2177	=back
		2178
		2179	=head2 The C<urxvt::iw> Class
		2180
		2181	This class implements idle watchers, that get called automatically when
		2182	the process is idle. They should return as fast as possible, after doing
		2183	some useful work.
		2184
		2185	=over 4
		2186
		2187	=item $iw = new urxvt::iw
		2188
		2189	Create a new idle watcher object in stopped state.
		2190
		2191	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2192
		2193	Set the callback to be called when the watcher triggers.
		2194
		2195	=item $timer = $timer->start
		2196
		2197	Start the watcher.
		2198
		2199	=item $timer = $timer->stop
		2200
		2201	Stop the watcher.
		2202
		2203	=back
		2204
		2205	=head2 The C<urxvt::pw> Class
		2206
		2207	This class implements process watchers. They create an event whenever a
		2208	process exits, after which they stop automatically.
		2209
		2210	my $pid = fork;
		2211	...
		2212	$term->{pw} = urxvt::pw
		2213	->new
		2214	->start ($pid)
		2215	->cb (sub {
		2216	my ($pw, $exit_status) = @_;
		2217	...
		2218	});
		2219
		2220	=over 4
		2221
		2222	=item $pw = new urxvt::pw
		2223
		2224	Create a new process watcher in stopped state.
		2225
		2226	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2227
		2228	Set the callback to be called when the timer triggers.
		2229
		2230	=item $pw = $timer->start ($pid)
		2231
		2232	Tells the watcher to start watching for process C<$pid>.
		2233
		2234	=item $pw = $pw->stop
		2235
		2236	Stop the watcher.
1747		2237
1748	=back	2238	=back
1749		2239
1750	=head1 ENVIRONMENT	2240	=head1 ENVIRONMENT
1751		2241
…		…
1760		2250
1761	=item >= 3 - script loading and management	2251	=item >= 3 - script loading and management
1762		2252
1763	=item >=10 - all called hooks	2253	=item >=10 - all called hooks
1764		2254
1765	=item >=11 - hook reutrn values	2255	=item >=11 - hook return values
1766		2256
1767	=back	2257	=back
1768		2258
1769	=head1 AUTHOR	2259	=head1 AUTHOR
1770		2260
1771	Marc Lehmann <pcg@goof.com>	2261	Marc Lehmann <schmorp@schmorp.de>
1772	http://software.schmorp.de/pkg/rxvt-unicode	2262	http://software.schmorp.de/pkg/rxvt-unicode
1773		2263
1774	=cut	2264	=cut
1775		2265
1776	1	2266	1
		2267
		2268	# vim: sw=3:

Diff Legend

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