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.113 by root, Fri Jan 20 10:27:08 2006 UTC vs.
Revision 1.252 by root, Sat Dec 27 19:27:42 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	trying to map (display) the toplevel and returning to the mainloop.	162	trying to map (display) the toplevel and returning to the main loop.
329		163
330	=item on_destroy $term	164	=item on_destroy $term
331		165
332	Called whenever something tries to destroy terminal, before doing anything	166	Called whenever something tries to destroy terminal, when the terminal is
333	yet. If this hook returns true, then destruction is skipped, but this is	167	still fully functional (not for long, though).
334	rarely a good idea.
335		168
336	=item on_reset $term	169	=item on_reset $term
337		170
338	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
339	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
…		…
361		194
362	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
363	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
364	by calling C<< $term->selection >>.	197	by calling C<< $term->selection >>.
365		198
366	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.
367		200
368	=item on_sel_extend $term	201	=item on_sel_extend $term
369		202
370	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
371	click) and is either supposed to return false (normal operation), or	204	click) and is either supposed to return false (normal operation), or
372	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
373	processing. This can happen multiple times, as long as the callback	206	processing. This can happen multiple times, as long as the callback
374	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
375	supposed to enlarge the selection more and more, if possible.	208	supposed to enlarge the selection more and more, if possible.
376		209
377	See the F<selection> example extension.	210	See the F<selection> example extension.
378		211
379	=item on_view_change $term, $offset	212	=item on_view_change $term, $offset
380		213
381	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
382	scrolls. Offset C<0> means display the normal terminal, positive values	215	scrolls. Offset C<0> means display the normal terminal, positive values
383	show this many lines of scrollback.	216	show this many lines of scrollback.
384		217
385	=item on_scroll_back $term, $lines, $saved	218	=item on_scroll_back $term, $lines, $saved
386		219
…		…
390		223
391	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,
392	$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
393	number of lines that will be in the scrollback buffer.	226	number of lines that will be in the scrollback buffer.
394		227
395	=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
396		239
397	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	240	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
398	operating system command) is processed. Cursor position and other state	241	operating system command) is processed. Cursor position and other state
399	information is up-to-date when this happens. For interoperability, the	242	information is up-to-date when this happens. For interoperability, the
400	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,
401	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
402	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	}
403		256
404	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,
405	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
406	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.
407		263
408	=item on_add_lines $term, $string	264	=item on_add_lines $term, $string
409		265
410	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
411	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
…		…
416	=item on_tt_write $term, $octets	272	=item on_tt_write $term, $octets
417		273
418	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
419	suppress or filter tty input.	275	suppress or filter tty input.
420		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
421	=item on_line_update $term, $row	284	=item on_line_update $term, $row
422		285
423	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
424	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
425	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,
…		…
432	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
433	you cannot just toggle rendition bits, but only set them.	296	you cannot just toggle rendition bits, but only set them.
434		297
435	=item on_refresh_begin $term	298	=item on_refresh_begin $term
436		299
437	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
438	or similar effects by modify terminal contents in refresh_begin, and	301	similar effects by modifying the terminal contents in refresh_begin, and
439	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
440	code is run after this hook, and takes precedence.	303	code is run after this hook, and takes precedence.
441		304
442	=item on_refresh_end $term	305	=item on_refresh_end $term
443		306
444	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>.
445		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
446	=item on_keyboard_command $term, $string	317	=item on_user_command $term, $string *DEPRECATED*
447		318
448	Called whenever the user presses a key combination that has a	319	Called whenever a user-configured event is being activated (e.g. via
449	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>
450	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.
451		331
452	=item on_x_event $term, $event	332	=item on_x_event $term, $event
453		333
454	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
455	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
456	members are not passed.	336	members are not passed.
457		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
458	=item on_focus_in $term	342	=item on_focus_in $term
459		343
460	Called whenever the window gets the keyboard focus, before rxvt-unicode	344	Called whenever the window gets the keyboard focus, before rxvt-unicode
461	does focus in processing.	345	does focus in processing.
462		346
463	=item on_focus_out $term	347	=item on_focus_out $term
464		348
465	Called wheneever the window loses keyboard focus, before rxvt-unicode does	349	Called whenever the window loses keyboard focus, before rxvt-unicode does
466	focus out processing.	350	focus out processing.
467		351
468	=item on_configure_notify $term, $event	352	=item on_configure_notify $term, $event
469		353
		354	=item on_property_notify $term, $event
		355
470	=item on_key_press $term, $event, $keysym, $octets	356	=item on_key_press $term, $event, $keysym, $octets
471		357
472	=item on_key_release $term, $event, $keysym	358	=item on_key_release $term, $event, $keysym
473		359
474	=item on_button_press $term, $event	360	=item on_button_press $term, $event
…		…
479		365
480	=item on_map_notify $term, $event	366	=item on_map_notify $term, $event
481		367
482	=item on_unmap_notify $term, $event	368	=item on_unmap_notify $term, $event
483		369
484	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
485	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.
486		372
487	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
488	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
489	and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
490		376
491	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
492	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
493		379
494	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.
495		392
496	=back	393	=back
497		394
498	=cut	395	=cut
499		396
500	package urxvt;	397	package urxvt;
501		398
502	use utf8;	399	use utf8;
503	use strict;	400	use strict 'vars';
504	use Carp ();	401	use Carp ();
505	use Scalar::Util ();	402	use Scalar::Util ();
506	use List::Util ();	403	use List::Util ();
507		404
508	our $VERSION = 1;	405	our $VERSION = 1;
509	our $TERM;	406	our $TERM;
510	our @TERM_INIT;	407	our @TERM_INIT; # should go, prevents async I/O etc.
511	our @TERM_EXT;	408	our @TERM_EXT; # should go, prevents async I/O etc.
512	our @HOOKNAME;	409	our @HOOKNAME;
513	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	410	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
514	our %OPTION;	411	our %OPTION;
515		412
516	our $LIBDIR;	413	our $LIBDIR;
517	our $RESNAME;	414	our $RESNAME;
518	our $RESCLASS;	415	our $RESCLASS;
519	our $RXVTNAME;	416	our $RXVTNAME;
520		417
		418	our $NOCHAR = chr 0xffff;
		419
521	=head2 Variables in the C<urxvt> Package	420	=head2 Variables in the C<urxvt> Package
522		421
523	=over 4	422	=over 4
524		423
525	=item $urxvt::LIBDIR	424	=item $urxvt::LIBDIR
…		…
540	The current terminal. This variable stores the current C<urxvt::term>	439	The current terminal. This variable stores the current C<urxvt::term>
541	object, whenever a callback/hook is executing.	440	object, whenever a callback/hook is executing.
542		441
543	=item @urxvt::TERM_INIT	442	=item @urxvt::TERM_INIT
544		443
545	All coderefs in this array will be called as methods of the next newly	444	All code references in this array will be called as methods of the next newly
546	created C<urxvt::term> object (during the C<on_init> phase). The array	445	created C<urxvt::term> object (during the C<on_init> phase). The array
547	gets cleared before the codereferences that were in it are being executed,	446	gets cleared before the code references that were in it are being executed,
548	so coderefs can push themselves onto it again if they so desire.	447	so references can push themselves onto it again if they so desire.
549		448
550	This complements to the perl-eval commandline option, but gets executed	449	This complements to the perl-eval command line option, but gets executed
551	first.	450	first.
552		451
553	=item @urxvt::TERM_EXT	452	=item @urxvt::TERM_EXT
554		453
555	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	454	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
562		461
563	=over 4	462	=over 4
564		463
565	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
566		465
567	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
568	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
569	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
570		470
571	=item urxvt::warn $string	471	=item urxvt::warn $string
572		472
573	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
574	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
575	that calls this function.	475	that calls this function.
576		476
577	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
578	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
579		479
580	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).
581		488
582	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
583		490
584	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
585		492
…		…
628		535
629	=item $rend = urxvt::OVERLAY_RSTYLE	536	=item $rend = urxvt::OVERLAY_RSTYLE
630		537
631	Return the rendition mask used for overlays by default.	538	Return the rendition mask used for overlays by default.
632		539
633	=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
634		542
635	Return the bit that enabled bold, italic, blink, reverse-video and	543	Return the bit that enabled bold, italic, blink, reverse-video and
636	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
637	the bitset.	545	the bitset.
638		546
…		…
643	Return the foreground/background colour index, respectively.	551	Return the foreground/background colour index, respectively.
644		552
645	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	553	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
646		554
647	=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
648		558
649	Replace the foreground/background colour in the rendition mask with the	559	Replace the foreground/background colour in the rendition mask with the
650	specified one.	560	specified one.
651		561
652	=item $value = urxvt::GET_CUSTOM $rend	562	=item $value = urxvt::GET_CUSTOM $rend
…		…
671	unless $msg =~ /\n$/;	581	unless $msg =~ /\n$/;
672	urxvt::warn ($msg);	582	urxvt::warn ($msg);
673	};	583	};
674	}	584	}
675		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
676	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	650	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
677		651
678	sub verbose {	652	sub verbose {
679	my ($level, $msg) = @_;	653	my ($level, $msg) = @_;
680	warn "$msg\n" if $level <= $verbosity;	654	warn "$msg\n" if $level <= $verbosity;
…		…
692	$pkg =~ s/[^[:word:]]/_/g;	666	$pkg =~ s/[^[:word:]]/_/g;
693	$pkg = "urxvt::ext::$pkg";	667	$pkg = "urxvt::ext::$pkg";
694		668
695	verbose 3, "loading extension '$path' into package '$pkg'";	669	verbose 3, "loading extension '$path' into package '$pkg'";
696		670
		671	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		672
697	open my $fh, "<:raw", $path	673	open my $fh, "<:raw", $path
698	or die "$path: $!";	674	or die "$path: $!";
699		675
700	my $source =	676	my $source =
701	"package $pkg; use strict; use utf8;\n"	677	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
702	. "#line 1 \"$path\"\n{\n"	678	. "#line 1 \"$path\"\n{\n"
703	. (do { local $/; <$fh> })	679	. (do { local $/; <$fh> })
704	. "\n};\n1";	680	. "\n};\n1";
705		681
706	eval $source	682	eval $source
…		…
715	# called by the rxvt core	691	# called by the rxvt core
716	sub invoke {	692	sub invoke {
717	local $TERM = shift;	693	local $TERM = shift;
718	my $htype = shift;	694	my $htype = shift;
719		695
720	if ($htype == 0) { # INIT	696	if ($htype == HOOK_INIT) {
721	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	697	my @dirs = $TERM->perl_libdirs;
722		698
		699	$TERM->scan_extensions;
		700
723	my %ext_arg;	701	my %ext_arg;
724		702
725	{	703	{
726	my @init = @TERM_INIT;	704	my @init = @TERM_INIT;
727	@TERM_INIT = ();	705	@TERM_INIT = ();
…		…
729	my @pkg = @TERM_EXT;	707	my @pkg = @TERM_EXT;
730	@TERM_EXT = ();	708	@TERM_EXT = ();
731	$TERM->register_package ($_) for @pkg;	709	$TERM->register_package ($_) for @pkg;
732	}	710	}
733		711
		712	for (
734	for (grep $_, 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	) {
735	if ($_ eq "default") {	716	if ($_ eq "default") {
		717
		718	$ext_arg{$_} = []
736	$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
737	} elsif (/^-(.*)$/) {	730	} elsif (/^-(.*)$/) {
738	delete $ext_arg{$1};	731	delete $ext_arg{$1};
		732
739	} elsif (/^([^<]+)<(.*)>$/) {	733	} elsif (/^([^<]+)<(.*)>$/) {
740	push @{ $ext_arg{$1} }, $2;	734	push @{ $ext_arg{$1} }, $2;
		735
741	} else {	736	} else {
742	$ext_arg{$_} ||= [];	737	$ext_arg{$_} ||= [];
743	}	738	}
744	}	739	}
745		740
746	while (my ($ext, $argv) = each %ext_arg) {	741	for my $ext (sort keys %ext_arg) {
747	my @files = grep -f $_, map "$_/$ext", @dirs;	742	my @files = grep -f $_, map "$_/$ext", @dirs;
748		743
749	if (@files) {	744	if (@files) {
750	$TERM->register_package (extension_package $files[0], $argv);	745	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
751	} else {	746	} else {
752	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";
753	}	748	}
754	}	749	}
755		750
…		…
761		756
762	if (my $cb = $TERM->{_hook}[$htype]) {	757	if (my $cb = $TERM->{_hook}[$htype]) {
763	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	758	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
764	if $verbosity >= 10;	759	if $verbosity >= 10;
765		760
766	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";
767		767
768	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) {
769	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	775	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
770	$retval ||= $retval_;	776	$retval ||= $retval_;
771		777
772	if ($@) {	778	if ($@) {
773	$TERM->ungrab; # better to lose the grab than the session	779	$TERM->ungrab; # better to lose the grab than the session
774	warn $@;	780	warn $@;
…		…
777		783
778	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	784	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
779	if $verbosity >= 11;	785	if $verbosity >= 11;
780	}	786	}
781		787
782	if ($htype == 1) { # DESTROY	788	if ($htype == HOOK_DESTROY) {
783	# clear package objects	789	# clear package objects
784	%$_ = () for values %{ $TERM->{_pkg} };	790	%$_ = () for values %{ $TERM->{_pkg} };
785		791
786	# clear package	792	# clear package
787	%$TERM = ();	793	%$TERM = ();
788	}	794	}
789		795
790	$retval	796	$retval
791	}	797	}
792		798
793	# 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	}
794		827
795	package urxvt::term::extension;	828	package urxvt::term::extension;
796		829
797	sub enable {	830	=head2 The C<urxvt::term::extension> class
798	my ($self, %hook) = @_;
799	my $pkg = $self->{_pkg};
800		831
801	while (my ($name, $cb) = each %hook) {	832	Each extension attached to a terminal object is represented by
802	my $htype = $HOOKTYPE{uc $name};	833	a C<urxvt::term::extension> object.
803	defined $htype
804	or Carp::croak "unsupported hook type '$name'";
805		834
806	$self->set_should_invoke ($htype, +1)	835	You can use these objects, which are passed to all callbacks to store any
807	unless exists $self->{term}{_hook}[$htype]{$pkg};	836	state related to the terminal and extension instance.
808		837
809	$self->{term}{_hook}[$htype]{$pkg} = $cb;	838	The methods (And data members) documented below can be called on extension
810	}	839	objects, in addition to call methods documented for the <urxvt::term>
811	}	840	class.
812		841
813	sub disable {	842	=over 4
814	my ($self, @hook) = @_;
815	my $pkg = $self->{_pkg};
816		843
817	for my $name (@hook) {	844	=item $urxvt_term = $self->{term}
818	my $htype = $HOOKTYPE{uc $name};
819	defined $htype
820	or Carp::croak "unsupported hook type '$name'";
821		845
822	$self->set_should_invoke ($htype, -1)	846	Returns the C<urxvt::term> object associated with this instance of the
823	if delete $self->{term}{_hook}[$htype]{$pkg};	847	extension. This member I<must not> be changed in any way.
824	}	848
825	}	849	=cut
826		850
827	our $AUTOLOAD;	851	our $AUTOLOAD;
828		852
829	sub AUTOLOAD {	853	sub AUTOLOAD {
830	$AUTOLOAD =~ /:([^:]+)$/	854	$AUTOLOAD =~ /:([^:]+)$/
…		…
843		867
844	sub DESTROY {	868	sub DESTROY {
845	# nop	869	# nop
846	}	870	}
847		871
848	# urxvt::destroy_hook	872	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
849		873
850	sub urxvt::destroy_hook::DESTROY {	874	sub urxvt::destroy_hook::DESTROY {
851	${$_[0]}->();	875	${$_[0]}->();
852	}	876	}
853		877
854	sub urxvt::destroy_hook(&) {	878	sub urxvt::destroy_hook(&) {
855	bless \shift, urxvt::destroy_hook::	879	bless \shift, urxvt::destroy_hook::
856	}	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
857		1004
858	package urxvt::anyevent;	1005	package urxvt::anyevent;
859		1006
860	=head2 The C<urxvt::anyevent> Class	1007	=head2 The C<urxvt::anyevent> Class
861		1008
862	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
863	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
864	further programming. The only exception is that you cannot wait on	1011	further programming. The only exception is that you cannot wait on
865	condition variables, but non-blocking condvar use is ok. What this means	1012	condition variables, but non-blocking condvar use is ok.
866	is that you cannot use blocking APIs, but the non-blocking variant should
867	work.
868		1013
869	=cut	1014	In practical terms this means is that you cannot use blocking APIs, but
		1015	the non-blocking variant should work.
870		1016
		1017	=cut
		1018
871	our $VERSION = 1;	1019	our $VERSION = '5.23';
872		1020
873	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1021	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
874	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1022	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
875		1023
876	sub timer {	1024	sub timer {
…		…
878		1026
879	my $cb = $arg{cb};	1027	my $cb = $arg{cb};
880		1028
881	urxvt::timer	1029	urxvt::timer
882	->new	1030	->new
883	->start (urxvt::NOW + $arg{after})	1031	->after ($arg{after}, $arg{interval})
884	->cb (sub {	1032	->cb ($arg{interval} ? $cb : sub {
885	$_[0]->stop; # need to cancel manually	1033	$_[0]->stop; # need to cancel manually
886	$cb->();	1034	$cb->();
887	})	1035	})
888	}	1036	}
889		1037
890	sub io {	1038	sub io {
891	my ($class, %arg) = @_;	1039	my ($class, %arg) = @_;
892		1040
893	my $cb = $arg{cb};	1041	my $cb = $arg{cb};
		1042	my $fd = fileno $arg{fh};
		1043	defined $fd or $fd = $arg{fh};
894		1044
895	bless [$arg{fh}, urxvt::iow	1045	bless [$arg{fh}, urxvt::iow
896	->new	1046	->new
897	->fd (fileno $arg{fh})	1047	->fd ($fd)
898	->events (($arg{poll} =~ /r/ ? 1 : 0)	1048	->events (($arg{poll} =~ /r/ ? 1 : 0)
899	| ($arg{poll} =~ /w/ ? 2 : 0))	1049	| ($arg{poll} =~ /w/ ? 2 : 0))
900	->start	1050	->start
901	->cb (sub {	1051	->cb ($cb)
902	$cb->(($_[1] & 1 ? 'r' : '')
903	. ($_[1] & 2 ? 'w' : ''));
904	})],
905	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	})
906	}	1078	}
907		1079
908	sub DESTROY {	1080	sub DESTROY {
909	$_[0][1]->stop;	1081	$_[0][1]->stop;
910	}	1082	}
911		1083
912	sub condvar {	1084	# only needed for AnyEvent < 6 compatibility
913	bless \my $flag, urxvt::anyevent::condvar::	1085	sub one_event {
914	}
915
916	sub urxvt::anyevent::condvar::broadcast {
917	${$_[0]}++;
918	}
919
920	sub urxvt::anyevent::condvar::wait {
921	unless (${$_[0]}) {
922	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";
923	}
924	}	1087	}
925		1088
926	package urxvt::term;	1089	package urxvt::term;
927		1090
928	=head2 The C<urxvt::term> Class	1091	=head2 The C<urxvt::term> Class
…		…
941	urxvt::verbose 6, "register package $pkg to $self";	1104	urxvt::verbose 6, "register package $pkg to $self";
942		1105
943	@{"$pkg\::ISA"} = urxvt::term::extension::;	1106	@{"$pkg\::ISA"} = urxvt::term::extension::;
944		1107
945	my $proxy = bless {	1108	my $proxy = bless {
946	_pkg => $pkg,	1109	_pkg => $pkg,
		1110	_name => ${"$pkg\::_NAME"}, # hackish
947	argv => $argv,	1111	argv => $argv,
948	}, $pkg;	1112	}, $pkg;
949	Scalar::Util::weaken ($proxy->{term} = $self);	1113	Scalar::Util::weaken ($proxy->{term} = $self);
950		1114
951	$self->{_pkg}{$pkg} = $proxy;	1115	$self->{_pkg}{$pkg} = $proxy;
952		1116
…		…
955	$proxy->enable ($name => $ref);	1119	$proxy->enable ($name => $ref);
956	}	1120	}
957	}	1121	}
958	}	1122	}
959		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
		1191	$meta{resource} = \my %resource;
		1192
		1193	while (my ($k, $v) = each %{ $meta{ext} }) {
		1194	#TODO: should check for extensions overriding each other
		1195	%resource = (%resource, %{ $v->{resource} });
		1196	}
		1197	}
		1198
960	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1199	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
961		1200
962	Creates a new terminal, very similar as if you had started it with system	1201	Creates a new terminal, very similar as if you had started it with system
963	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1202	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
964	hash which defines the environment of the new terminal.	1203	hash which defines the environment of the new terminal.
965		1204
966	Croaks (and probably outputs an error message) if the new instance	1205	Croaks (and probably outputs an error message) if the new instance
967	couldn't be created. Returns C<undef> if the new instance didn't	1206	couldn't be created. Returns C<undef> if the new instance didn't
968	initialise perl, and the terminal object otherwise. The C<init> and	1207	initialise perl, and the terminal object otherwise. The C<init> and
969	C<start> hooks will be called during this call.	1208	C<start> hooks will be called before this call returns, and are free to
		1209	refer to global data (which is race free).
970		1210
971	=cut	1211	=cut
972		1212
973	sub new {	1213	sub new {
974	my ($class, $env, @args) = @_;	1214	my ($class, $env, @args) = @_;
975		1215
		1216	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1217	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1218
976	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1219	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
977	}	1220	}
978		1221
979	=item $term->destroy	1222	=item $term->destroy
980		1223
981	Destroy the terminal object (close the window, free resources	1224	Destroy the terminal object (close the window, free resources
982	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1225	etc.). Please note that urxvt will not exit as long as any event
983	watchers (timers, io watchers) are still active.	1226	watchers (timers, io watchers) are still active.
984		1227
985	=item $term->exec_async ($cmd[, @args])	1228	=item $term->exec_async ($cmd[, @args])
986		1229
987	Works like the combination of the C<fork>/C<exec> builtins, which executes	1230	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1011		1254
1012	Returns true if the option specified by C<$optval> is enabled, and	1255	Returns true if the option specified by C<$optval> is enabled, and
1013	optionally change it. All option values are stored by name in the hash	1256	optionally change it. All option values are stored by name in the hash
1014	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1257	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1015		1258
1016	Here is a a likely non-exhaustive list of option names, please see the	1259	Here is a likely non-exhaustive list of option names, please see the
1017	source file F</src/optinc.h> to see the actual list:	1260	source file F</src/optinc.h> to see the actual list:
1018		1261
1019	borderLess console cursorBlink cursorUnderline hold iconic insecure	1262	borderLess buffered console cursorBlink cursorUnderline hold iconic
1020	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1263	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1021	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1264	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1022	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1265	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1023	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1266	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1024	transparent tripleclickwords utmpInhibit visualBell	1267	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1268	urgentOnBell utmpInhibit visualBell
1025		1269
1026	=item $value = $term->resource ($name[, $newval])	1270	=item $value = $term->resource ($name[, $newval])
1027		1271
1028	Returns the current resource value associated with a given name and	1272	Returns the current resource value associated with a given name and
1029	optionally sets a new value. Setting values is most useful in the C<init>	1273	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1038	likely change).	1282	likely change).
1039		1283
1040	Please note that resource strings will currently only be freed when the	1284	Please note that resource strings will currently only be freed when the
1041	terminal is destroyed, so changing options frequently will eat memory.	1285	terminal is destroyed, so changing options frequently will eat memory.
1042		1286
1043	Here is a a likely non-exhaustive list of resource names, not all of which	1287	Here is a likely non-exhaustive list of resource names, not all of which
1044	are supported in every build, please see the source file F</src/rsinc.h>	1288	are supported in every build, please see the source file F</src/rsinc.h>
1045	to see the actual list:	1289	to see the actual list:
1046		1290
1047	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1291	answerbackstring backgroundPixmap backspace_key blurradius
1048	borderLess color cursorBlink cursorUnderline cutchars delete_key	1292	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1049	display_name embed ext_bwidth fade font geometry hold iconName	1293	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1050	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1294	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1295	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1051	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1296	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1052	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1297	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1053	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1298	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1054	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1299	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1055	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1300	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1056	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1301	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1057	secondaryScreen secondaryScroll selectstyle shade term_name title	1302	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1058	transient_for transparent transparent_all tripleclickwords utmpInhibit	1303	term_name title transient_for transparent tripleclickwords urgentOnBell
1059	visualBell	1304	utmpInhibit visualBell
1060		1305
1061	=cut	1306	=cut
1062		1307
1063	sub resource($$;$) {	1308	sub resource($$;$) {
1064	my ($self, $name) = (shift, shift);	1309	my ($self, $name) = (shift, shift);
1065	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1310	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1066	&urxvt::term::_resource	1311	goto &urxvt::term::_resource
1067	}	1312	}
1068		1313
1069	=item $value = $term->x_resource ($pattern)	1314	=item $value = $term->x_resource ($pattern)
1070		1315
1071	Returns the X-Resource for the given pattern, excluding the program or	1316	Returns the X-Resource for the given pattern, excluding the program or
1072	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1317	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1073	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1318	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1074	resource with that pattern exists.	1319	resource with that pattern exists.
1075		1320
		1321	Extensions that define extra resources also need to call this method
		1322	to access their values.
		1323
		1324	If the method is called on an extension object (basically, from an
		1325	extension), then the special prefix C<%.> will be replaced by the name of
		1326	the extension and a dot, and the lone string C<%> will be replaced by the
		1327	extension name itself. This makes it possible to code extensions so you
		1328	can rename them and get a new set of resources without having to change
		1329	the actual code.
		1330
1076	This method should only be called during the C<on_start> hook, as there is	1331	This method should only be called during the C<on_start> hook, as there is
1077	only one resource database per display, and later invocations might return	1332	only one resource database per display, and later invocations might return
1078	the wrong resources.	1333	the wrong resources.
1079		1334
1080	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1335	=item $value = $term->x_resource_boolean ($pattern)
1081		1336
		1337	Like C<x_resource>, above, but interprets the string value as a boolean
		1338	and returns C<1> for true values, C<0> for false values and C<undef> if
		1339	the resource or option isn't specified.
		1340
		1341	You should always use this method to parse boolean resources.
		1342
		1343	=cut
		1344
		1345	sub x_resource_boolean {
		1346	my $res = &x_resource;
		1347
		1348	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1349	}
		1350
		1351	=item $success = $term->bind_action ($key, $action)
		1352
1082	Adds a keymap translation exactly as specified via a resource. See the	1353	Adds a key binding exactly as specified via a C<keysym> resource. See the
1083	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1354	C<keysym> resource in the urxvt(1) manpage.
		1355
		1356	To add default bindings for actions, an extension should call C<<
		1357	->bind_action >> in its C<init> hook for every such binding. Doing it
		1358	in the C<init> hook allows users to override or remove the binding
		1359	again.
		1360
		1361	Example: the C<searchable-scrollback> by default binds itself
		1362	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1363	$term->bind_action >>.
		1364
		1365	sub init {
		1366	my ($self) = @_;
		1367
		1368	$self->bind_action ("M-s" => "%:start");
		1369	}
1084		1370
1085	=item $rend = $term->rstyle ([$new_rstyle])	1371	=item $rend = $term->rstyle ([$new_rstyle])
1086		1372
1087	Return and optionally change the current rendition. Text that is output by	1373	Return and optionally change the current rendition. Text that is output by
1088	the terminal application will use this style.	1374	the terminal application will use this style.
…		…
1096		1382
1097	=item ($row, $col) = $term->selection_beg ([$row, $col])	1383	=item ($row, $col) = $term->selection_beg ([$row, $col])
1098		1384
1099	=item ($row, $col) = $term->selection_end ([$row, $col])	1385	=item ($row, $col) = $term->selection_end ([$row, $col])
1100		1386
1101	Return the current values of the selection mark, begin or end positions,	1387	Return the current values of the selection mark, begin or end positions.
1102	and optionally set them to new values.	1388
		1389	When arguments are given, then the selection coordinates are set to
		1390	C<$row> and C<$col>, and the selection screen is set to the current
		1391	screen.
		1392
		1393	=item $screen = $term->selection_screen ([$screen])
		1394
		1395	Returns the current selection screen, and then optionally sets it.
1103		1396
1104	=item $term->selection_make ($eventtime[, $rectangular])	1397	=item $term->selection_make ($eventtime[, $rectangular])
1105		1398
1106	Tries to make a selection as set by C<selection_beg> and	1399	Tries to make a selection as set by C<selection_beg> and
1107	C<selection_end>. If C<$rectangular> is true (default: false), a	1400	C<selection_end>. If C<$rectangular> is true (default: false), a
1108	rectangular selection will be made. This is the prefered function to make	1401	rectangular selection will be made. This is the preferred function to make
1109	a selection.	1402	a selection.
1110		1403
1111	=item $success = $term->selection_grab ($eventtime)	1404	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1112		1405
1113	Try to request the primary selection text from the server (for example, as	1406	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1407	true) selection from the server. The corresponding text can be set
1114	set by the next method). No visual feedback will be given. This function	1408	with the next method. No visual feedback will be given. This function
1115	is mostly useful from within C<on_sel_grab> hooks.	1409	is mostly useful from within C<on_sel_grab> hooks.
1116		1410
1117	=item $oldtext = $term->selection ([$newtext])	1411	=item $oldtext = $term->selection ([$newtext, $clipboard])
1118		1412
1119	Return the current selection text and optionally replace it by C<$newtext>.	1413	Return the current selection (clipboard if C<$clipboard> is true) text
		1414	and optionally replace it by C<$newtext>.
		1415
		1416	=item $term->selection_clear ([$clipboard])
		1417
		1418	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1120		1419
1121	=item $term->overlay_simple ($x, $y, $text)	1420	=item $term->overlay_simple ($x, $y, $text)
1122		1421
1123	Create a simple multi-line overlay box. See the next method for details.	1422	Create a simple multi-line overlay box. See the next method for details.
1124		1423
…		…
1154		1453
1155	The methods currently supported on C<urxvt::overlay> objects are:	1454	The methods currently supported on C<urxvt::overlay> objects are:
1156		1455
1157	=over 4	1456	=over 4
1158		1457
1159	=item $overlay->set ($x, $y, $text, $rend)	1458	=item $overlay->set ($x, $y, $text[, $rend])
1160		1459
1161	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1460	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1162	text in rxvt-unicode's special encoding and an array of rendition values	1461	text in rxvt-unicode's special encoding and an array of rendition values
1163	at a specific position inside the overlay.	1462	at a specific position inside the overlay.
		1463
		1464	If C<$rend> is missing, then the rendition will not be changed.
1164		1465
1165	=item $overlay->hide	1466	=item $overlay->hide
1166		1467
1167	If visible, hide the overlay, but do not destroy it.	1468	If visible, hide the overlay, but do not destroy it.
1168		1469
…		…
1231		1532
1232	=item $term->scr_add_lines ($string)	1533	=item $term->scr_add_lines ($string)
1233		1534
1234	Write the given text string to the screen, as if output by the application	1535	Write the given text string to the screen, as if output by the application
1235	running inside the terminal. It may not contain command sequences (escape	1536	running inside the terminal. It may not contain command sequences (escape
1236	codes), but is free to use line feeds, carriage returns and tabs. The	1537	codes - see C<cmd_parse> for that), but is free to use line feeds,
1237	string is a normal text string, not in locale-dependent encoding.	1538	carriage returns and tabs. The string is a normal text string, not in
		1539	locale-dependent encoding.
1238		1540
1239	Normally its not a good idea to use this function, as programs might be	1541	Normally its not a good idea to use this function, as programs might be
1240	confused by changes in cursor position or scrolling. Its useful inside a	1542	confused by changes in cursor position or scrolling. Its useful inside a
1241	C<on_add_lines> hook, though.	1543	C<on_add_lines> hook, though.
1242		1544
		1545	=item $term->scr_change_screen ($screen)
		1546
		1547	Switch to given screen - 0 primary, 1 secondary.
		1548
1243	=item $term->cmd_parse ($octets)	1549	=item $term->cmd_parse ($octets)
1244		1550
1245	Similar to C<scr_add_lines>, but the argument must be in the	1551	Similar to C<scr_add_lines>, but the argument must be in the
1246	locale-specific encoding of the terminal and can contain command sequences	1552	locale-specific encoding of the terminal and can contain command sequences
1247	(escape codes) that will be interpreted.	1553	(escape codes) that will be interpreted.
1248		1554
1249	=item $term->tt_write ($octets)	1555	=item $term->tt_write ($octets)
1250		1556
1251	Write the octets given in C<$data> to the tty (i.e. as program input). To	1557	Write the octets given in C<$octets> to the tty (i.e. as user input
		1558	to the program, see C<cmd_parse> for the opposite direction). To pass
1252	pass characters instead of octets, you should convert your strings first	1559	characters instead of octets, you should convert your strings first to the
1253	to the locale-specific encoding using C<< $term->locale_encode >>.	1560	locale-specific encoding using C<< $term->locale_encode >>.
		1561
		1562	=item $term->tt_write_user_input ($octets)
		1563
		1564	Like C<tt_write>, but should be used when writing strings in response to
		1565	the user pressing a key, to invoke the additional actions requested by
		1566	the user for that case (C<tt_write> doesn't do that).
		1567
		1568	The typical use case would be inside C<on_action> hooks.
		1569
		1570	=item $term->tt_paste ($octets)
		1571
		1572	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1573	CR and bracketing the data with control sequences if bracketed paste mode
		1574	is set.
1254		1575
1255	=item $old_events = $term->pty_ev_events ([$new_events])	1576	=item $old_events = $term->pty_ev_events ([$new_events])
1256		1577
1257	Replaces the event mask of the pty watcher by the given event mask. Can	1578	Replaces the event mask of the pty watcher by the given event mask. Can
1258	be used to suppress input and output handling to the pty/tty. See the	1579	be used to suppress input and output handling to the pty/tty. See the
1259	description of C<< urxvt::timer->events >>. Make sure to always restore	1580	description of C<< urxvt::timer->events >>. Make sure to always restore
1260	the previous value.	1581	the previous value.
1261		1582
		1583	=item $fd = $term->pty_fd
		1584
		1585	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1586	is used.
		1587
1262	=item $windowid = $term->parent	1588	=item $windowid = $term->parent
1263		1589
1264	Return the window id of the toplevel window.	1590	Return the window id of the toplevel window.
1265		1591
1266	=item $windowid = $term->vt	1592	=item $windowid = $term->vt
…		…
1272	Adds the specified events to the vt event mask. Useful e.g. when you want	1598	Adds the specified events to the vt event mask. Useful e.g. when you want
1273	to receive pointer events all the times:	1599	to receive pointer events all the times:
1274		1600
1275	$term->vt_emask_add (urxvt::PointerMotionMask);	1601	$term->vt_emask_add (urxvt::PointerMotionMask);
1276		1602
		1603	=item $term->set_urgency ($set)
		1604
		1605	Enable/disable the urgency hint on the toplevel window.
		1606
		1607	=item $term->focus_in
		1608
		1609	=item $term->focus_out
		1610
		1611	=item $term->key_press ($state, $keycode[, $time])
		1612
		1613	=item $term->key_release ($state, $keycode[, $time])
		1614
		1615	Deliver various fake events to to terminal.
		1616
1277	=item $window_width = $term->width	1617	=item $window_width = $term->width
1278		1618
1279	=item $window_height = $term->height	1619	=item $window_height = $term->height
1280		1620
1281	=item $font_width = $term->fwidth	1621	=item $font_width = $term->fwidth
…		…
1311	=item $env = $term->env	1651	=item $env = $term->env
1312		1652
1313	Returns a copy of the environment in effect for the terminal as a hashref	1653	Returns a copy of the environment in effect for the terminal as a hashref
1314	similar to C<\%ENV>.	1654	similar to C<\%ENV>.
1315		1655
		1656	=item @envv = $term->envv
		1657
		1658	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1659
		1660	=item @argv = $term->argv
		1661
		1662	Return the argument vector as this terminal, similar to @ARGV, but
		1663	includes the program name as first element.
		1664
1316	=cut	1665	=cut
1317		1666
1318	sub env {	1667	sub env {
1319	if (my $env = $_[0]->_env) {
1320	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1668	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1321	} else {
1322	+{ %ENV }
1323	}
1324	}	1669	}
1325		1670
1326	=item $modifiermask = $term->ModLevel3Mask	1671	=item $modifiermask = $term->ModLevel3Mask
1327		1672
1328	=item $modifiermask = $term->ModMetaMask	1673	=item $modifiermask = $term->ModMetaMask
1329		1674
1330	=item $modifiermask = $term->ModNumLockMask	1675	=item $modifiermask = $term->ModNumLockMask
1331		1676
1332	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1677	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1333	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1678	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1679
		1680	=item $screen = $term->current_screen
		1681
		1682	Returns the currently displayed screen (0 primary, 1 secondary).
		1683
		1684	=item $cursor_is_hidden = $term->hidden_cursor
		1685
		1686	Returns whether the cursor is currently hidden or not.
1334		1687
1335	=item $view_start = $term->view_start ([$newvalue])	1688	=item $view_start = $term->view_start ([$newvalue])
1336		1689
1337	Returns the row number of the topmost displayed line. Maximum value is	1690	Returns the row number of the topmost displayed line. Maximum value is
1338	C<0>, which displays the normal terminal contents. Lower values scroll	1691	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1346		1699
1347	Used after changing terminal contents to display them.	1700	Used after changing terminal contents to display them.
1348		1701
1349	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1702	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1350		1703
1351	Returns the text of the entire row with number C<$row_number>. Row C<0>	1704	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1352	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1705	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1353	terminal line. The scrollback buffer starts at line C<-1> and extends to
1354	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1706	terminal line. Nothing will be returned if a nonexistent line
1355	is requested.	1707	is requested.
1356		1708
1357	If C<$new_text> is specified, it will replace characters in the current	1709	If C<$new_text> is specified, it will replace characters in the current
1358	line, starting at column C<$start_col> (default C<0>), which is useful	1710	line, starting at column C<$start_col> (default C<0>), which is useful
1359	to replace only parts of a line. The font index in the rendition will	1711	to replace only parts of a line. The font index in the rendition will
1360	automatically be updated.	1712	automatically be updated.
1361		1713
1362	C<$text> is in a special encoding: tabs and wide characters that use more	1714	C<$text> is in a special encoding: tabs and wide characters that use more
1363	than one cell when displayed are padded with urxvt::NOCHAR characters	1715	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1364	(C<chr 65535>). Characters with combining characters and other characters	1716	characters. Characters with combining characters and other characters that
1365	that do not fit into the normal tetx encoding will be replaced with	1717	do not fit into the normal text encoding will be replaced with characters
1366	characters in the private use area.	1718	in the private use area.
1367		1719
1368	You have to obey this encoding when changing text. The advantage is	1720	You have to obey this encoding when changing text. The advantage is
1369	that C<substr> and similar functions work on screen cells and not on	1721	that C<substr> and similar functions work on screen cells and not on
1370	characters.	1722	characters.
1371		1723
…		…
1455	}	1807	}
1456		1808
1457	sub urxvt::line::t {	1809	sub urxvt::line::t {
1458	my ($self) = @_;	1810	my ($self) = @_;
1459		1811
1460	if (@_ > 1)	1812	if (@_ > 1) {
1461	{
1462	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1813	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1463	for $self->{beg} .. $self->{end};	1814	for $self->{beg} .. $self->{end};
1464	}	1815	}
1465		1816
1466	defined wantarray &&	1817	defined wantarray &&
1467	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1818	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1468	0, $self->{len}	1819	0, $self->{len}
1469	}	1820	}
1470		1821
1471	sub urxvt::line::r {	1822	sub urxvt::line::r {
1472	my ($self) = @_;	1823	my ($self) = @_;
1473		1824
1474	if (@_ > 1)	1825	if (@_ > 1) {
1475	{
1476	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1826	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1477	for $self->{beg} .. $self->{end};	1827	for $self->{beg} .. $self->{end};
1478	}	1828	}
1479		1829
1480	if (defined wantarray) {	1830	if (defined wantarray) {
1481	my $rend = [	1831	my $rend = [
1482	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1832	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1483	];	1833	];
…		…
1515	where one character corresponds to one screen cell. See	1865	where one character corresponds to one screen cell. See
1516	C<< $term->ROW_t >> for details.	1866	C<< $term->ROW_t >> for details.
1517		1867
1518	=item $string = $term->special_decode $text	1868	=item $string = $term->special_decode $text
1519		1869
1520	Converts rxvt-unicodes text reprsentation into a perl string. See	1870	Converts rxvt-unicodes text representation into a perl string. See
1521	C<< $term->ROW_t >> for details.	1871	C<< $term->ROW_t >> for details.
1522		1872
1523	=item $success = $term->grab_button ($button, $modifiermask)	1873	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1524		1874
		1875	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1876
1525	Registers a synchronous button grab. See the XGrabButton manpage.	1877	Register/unregister a synchronous button grab. See the XGrabButton
		1878	manpage.
1526		1879
1527	=item $success = $term->grab ($eventtime[, $sync])	1880	=item $success = $term->grab ($eventtime[, $sync])
1528		1881
1529	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1882	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1530	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1883	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1531		1884
1532	=item $term->allow_events_async	1885	=item $term->allow_events_async
1533		1886
1534	Calls XAllowEvents with AsyncBoth for the most recent grab.	1887	Calls XAllowEvents with AsyncBoth for the most recent grab.
1535		1888
…		…
1542	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1895	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1543	recent grab.	1896	recent grab.
1544		1897
1545	=item $term->ungrab	1898	=item $term->ungrab
1546		1899
1547	Calls XUngrab for the most recent grab. Is called automatically on	1900	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1548	evaluation errors, as it is better to lose the grab in the error case as	1901	evaluation errors, as it is better to lose the grab in the error case as
1549	the session.	1902	the session.
		1903
		1904	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1905
		1906	=item $atom_name = $term->XGetAtomName ($atom)
		1907
		1908	=item @atoms = $term->XListProperties ($window)
		1909
		1910	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1911
		1912	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1913
		1914	=item $term->XDeleteProperty ($window, $property)
		1915
		1916	=item $window = $term->DefaultRootWindow
		1917
		1918	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1919
		1920	=item $term->XMapWindow ($window)
		1921
		1922	=item $term->XUnmapWindow ($window)
		1923
		1924	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1925
		1926	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1927
		1928	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1929
		1930	=item $keysym = $term->XStringToKeysym ($string)
		1931
		1932	=item $string = $term->XKeysymToString ($keysym)
		1933
		1934	Various X or X-related functions. The C<$term> object only serves as
		1935	the source of the display, otherwise those functions map more-or-less
		1936	directly onto the X functions of the same name.
1550		1937
1551	=back	1938	=back
1552		1939
1553	=cut	1940	=cut
1554		1941
…		…
1618	my ($self, $text, $cb) = @_;	2005	my ($self, $text, $cb) = @_;
1619		2006
1620	$self->add_item ({ type => "button", text => $text, activate => $cb});	2007	$self->add_item ({ type => "button", text => $text, activate => $cb});
1621	}	2008	}
1622		2009
1623	=item $popup->add_toggle ($text, $cb, $initial_value)	2010	=item $popup->add_toggle ($text, $initial_value, $cb)
1624		2011
1625	Adds a toggle/checkbox item to the popup. Teh callback gets called	2012	Adds a toggle/checkbox item to the popup. The callback gets called
1626	whenever it gets toggled, with a boolean indicating its value as its first	2013	whenever it gets toggled, with a boolean indicating its new value as its
1627	argument.	2014	first argument.
1628		2015
1629	=cut	2016	=cut
1630		2017
1631	sub add_toggle {	2018	sub add_toggle {
1632	my ($self, $text, $cb, $value) = @_;	2019	my ($self, $text, $value, $cb) = @_;
1633		2020
1634	my $item; $item = {	2021	my $item; $item = {
1635	type => "button",	2022	type => "button",
1636	text => " $text",	2023	text => " $text",
1637	value => $value,	2024	value => $value,
…		…
1656	my $env = $self->{term}->env;	2043	my $env = $self->{term}->env;
1657	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2044	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1658	delete $env->{LC_ALL};	2045	delete $env->{LC_ALL};
1659	$env->{LC_CTYPE} = $self->{term}->locale;	2046	$env->{LC_CTYPE} = $self->{term}->locale;
1660		2047
1661	urxvt::term->new ($env, "popup",	2048	my $term = urxvt::term->new (
		2049	$env, "popup",
1662	"--perl-lib" => "", "--perl-ext-common" => "",	2050	"--perl-lib" => "", "--perl-ext-common" => "",
1663	"-pty-fd" => -1, "-sl" => 0,	2051	"-pty-fd" => -1, "-sl" => 0,
1664	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2052	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1665	"--transient-for" => $self->{term}->parent,	2053	"--transient-for" => $self->{term}->parent,
1666	"-display" => $self->{term}->display_id,	2054	"-display" => $self->{term}->display_id,
1667	"-pe" => "urxvt-popup")	2055	"-pe" => "urxvt-popup",
1668	or die "unable to create popup window\n";	2056	) or die "unable to create popup window\n";
		2057
		2058	unless (delete $term->{urxvt_popup_init_done}) {
		2059	$term->ungrab;
		2060	$term->destroy;
		2061	die "unable to initialise popup window\n";
		2062	}
1669	}	2063	}
1670		2064
1671	sub DESTROY {	2065	sub DESTROY {
1672	my ($self) = @_;	2066	my ($self) = @_;
1673		2067
…		…
1678	=back	2072	=back
1679		2073
1680	=cut	2074	=cut
1681		2075
1682	package urxvt::watcher;	2076	package urxvt::watcher;
1683
1684	@urxvt::timer::ISA = __PACKAGE__;
1685	@urxvt::iow::ISA = __PACKAGE__;
1686	@urxvt::pw::ISA = __PACKAGE__;
1687	@urxvt::iw::ISA = __PACKAGE__;
1688		2077
1689	=head2 The C<urxvt::timer> Class	2078	=head2 The C<urxvt::timer> Class
1690		2079
1691	This class implements timer watchers/events. Time is represented as a	2080	This class implements timer watchers/events. Time is represented as a
1692	fractional number of seconds since the epoch. Example:	2081	fractional number of seconds since the epoch. Example:
…		…
1696	->new	2085	->new
1697	->interval (1)	2086	->interval (1)
1698	->cb (sub {	2087	->cb (sub {
1699	$term->{overlay}->set (0, 0,	2088	$term->{overlay}->set (0, 0,
1700	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2089	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1701	});	2090	});
1702		2091
1703	=over 4	2092	=over 4
1704		2093
1705	=item $timer = new urxvt::timer	2094	=item $timer = new urxvt::timer
1706		2095
…		…
1709		2098
1710	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2099	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1711		2100
1712	Set the callback to be called when the timer triggers.	2101	Set the callback to be called when the timer triggers.
1713		2102
1714	=item $tstamp = $timer->at
1715
1716	Return the time this watcher will fire next.
1717
1718	=item $timer = $timer->set ($tstamp)	2103	=item $timer = $timer->set ($tstamp[, $interval])
1719		2104
1720	Set the time the event is generated to $tstamp.	2105	Set the time the event is generated to $tstamp (and optionally specifies a
		2106	new $interval).
1721		2107
1722	=item $timer = $timer->interval ($interval)	2108	=item $timer = $timer->interval ($interval)
1723		2109
1724	Normally (and when C<$interval> is C<0>), the timer will automatically	2110	By default (and when C<$interval> is C<0>), the timer will automatically
1725	stop after it has fired once. If C<$interval> is non-zero, then the timer	2111	stop after it has fired once. If C<$interval> is non-zero, then the timer
1726	is automatically rescheduled at the given intervals.	2112	is automatically rescheduled at the given intervals.
1727		2113
1728	=item $timer = $timer->start	2114	=item $timer = $timer->start
1729		2115
1730	Start the timer.	2116	Start the timer.
1731		2117
1732	=item $timer = $timer->start ($tstamp)	2118	=item $timer = $timer->start ($tstamp[, $interval])
1733		2119
1734	Set the event trigger time to C<$tstamp> and start the timer.	2120	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2121	also replaces the interval.
1735		2122
1736	=item $timer = $timer->after ($delay)	2123	=item $timer = $timer->after ($delay[, $interval])
1737		2124
1738	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2125	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1739		2126
1740	=item $timer = $timer->stop	2127	=item $timer = $timer->stop
1741		2128
…		…
1749		2136
1750	$term->{socket} = ...	2137	$term->{socket} = ...
1751	$term->{iow} = urxvt::iow	2138	$term->{iow} = urxvt::iow
1752	->new	2139	->new
1753	->fd (fileno $term->{socket})	2140	->fd (fileno $term->{socket})
1754	->events (urxvt::EVENT_READ)	2141	->events (urxvt::EV_READ)
1755	->start	2142	->start
1756	->cb (sub {	2143	->cb (sub {
1757	my ($iow, $revents) = @_;	2144	my ($iow, $revents) = @_;
1758	# $revents must be 1 here, no need to check	2145	# $revents must be 1 here, no need to check
1759	sysread $term->{socket}, my $buf, 8192	2146	sysread $term->{socket}, my $buf, 8192
…		…
1772	Set the callback to be called when io events are triggered. C<$reventmask>	2159	Set the callback to be called when io events are triggered. C<$reventmask>
1773	is a bitset as described in the C<events> method.	2160	is a bitset as described in the C<events> method.
1774		2161
1775	=item $iow = $iow->fd ($fd)	2162	=item $iow = $iow->fd ($fd)
1776		2163
1777	Set the filedescriptor (not handle) to watch.	2164	Set the file descriptor (not handle) to watch.
1778		2165
1779	=item $iow = $iow->events ($eventmask)	2166	=item $iow = $iow->events ($eventmask)
1780		2167
1781	Set the event mask to watch. The only allowed values are	2168	Set the event mask to watch. The only allowed values are
1782	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2169	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1783	together, or C<urxvt::EVENT_NONE>.	2170	together, or C<urxvt::EV_NONE>.
1784		2171
1785	=item $iow = $iow->start	2172	=item $iow = $iow->start
1786		2173
1787	Start watching for requested events on the given handle.	2174	Start watching for requested events on the given handle.
1788		2175
1789	=item $iow = $iow->stop	2176	=item $iow = $iow->stop
1790		2177
1791	Stop watching for events on the given filehandle.	2178	Stop watching for events on the given file handle.
		2179
		2180	=back
		2181
		2182	=head2 The C<urxvt::iw> Class
		2183
		2184	This class implements idle watchers, that get called automatically when
		2185	the process is idle. They should return as fast as possible, after doing
		2186	some useful work.
		2187
		2188	=over 4
		2189
		2190	=item $iw = new urxvt::iw
		2191
		2192	Create a new idle watcher object in stopped state.
		2193
		2194	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2195
		2196	Set the callback to be called when the watcher triggers.
		2197
		2198	=item $timer = $timer->start
		2199
		2200	Start the watcher.
		2201
		2202	=item $timer = $timer->stop
		2203
		2204	Stop the watcher.
		2205
		2206	=back
		2207
		2208	=head2 The C<urxvt::pw> Class
		2209
		2210	This class implements process watchers. They create an event whenever a
		2211	process exits, after which they stop automatically.
		2212
		2213	my $pid = fork;
		2214	...
		2215	$term->{pw} = urxvt::pw
		2216	->new
		2217	->start ($pid)
		2218	->cb (sub {
		2219	my ($pw, $exit_status) = @_;
		2220	...
		2221	});
		2222
		2223	=over 4
		2224
		2225	=item $pw = new urxvt::pw
		2226
		2227	Create a new process watcher in stopped state.
		2228
		2229	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2230
		2231	Set the callback to be called when the timer triggers.
		2232
		2233	=item $pw = $timer->start ($pid)
		2234
		2235	Tells the watcher to start watching for process C<$pid>.
		2236
		2237	=item $pw = $pw->stop
		2238
		2239	Stop the watcher.
1792		2240
1793	=back	2241	=back
1794		2242
1795	=head1 ENVIRONMENT	2243	=head1 ENVIRONMENT
1796		2244
…		…
1805		2253
1806	=item >= 3 - script loading and management	2254	=item >= 3 - script loading and management
1807		2255
1808	=item >=10 - all called hooks	2256	=item >=10 - all called hooks
1809		2257
1810	=item >=11 - hook reutrn values	2258	=item >=11 - hook return values
1811		2259
1812	=back	2260	=back
1813		2261
1814	=head1 AUTHOR	2262	=head1 AUTHOR
1815		2263
1816	Marc Lehmann <pcg@goof.com>	2264	Marc Lehmann <schmorp@schmorp.de>
1817	http://software.schmorp.de/pkg/rxvt-unicode	2265	http://software.schmorp.de/pkg/rxvt-unicode
1818		2266
1819	=cut	2267	=cut
1820		2268
1821	1	2269	1
		2270
		2271	# vim: sw=3:

Diff Legend

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