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

Diff Legend

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