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.124 by root, Sun Jan 22 11:57:06 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	evaluation, 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 readline (enabled by default)
133
134	A support package that tries to make editing with readline easier. At the
135	moment, it reacts to clicking with the left mouse button by trying to
136	move the text cursor to this position. It does so by generating as many
137	cursor-left or cursor-right keypresses as required (the this only works
138	for programs that correctly support wide characters).
139
140	To avoid too many false positives, this is only done when:
141
142	=over 4
143
144	=item - the mouse is on the same (multi-row-) line as the text cursor.
145
146	=item - the primary screen is currently being displayed.
147
148	=item - the text cursor is visible.
149
150	=back
151
152	The normal selection mechanism isn't disabled, so quick successive clicks
153	might interfere with selection creation in harmless ways.
154
155	=item selection-autotransform
156
157	This selection allows you to do automatic transforms on a selection
158	whenever a selection is made.
159
160	It works by specifying perl snippets (most useful is a single C<s///>
161	operator) that modify C<$_> as resources:
162
163	URxvt.selection-autotransform.0: transform
164	URxvt.selection-autotransform.1: transform
165	...
166
167	For example, the following will transform selections of the form
168	C<filename:number>, often seen in compiler messages, into C<vi +$filename
169	$word>:
170
171	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
172
173	And this example matches the same,but replaces it with vi-commands you can
174	paste directly into your (vi :) editor:
175
176	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
177
178	Of course, this can be modified to suit your needs and your editor :)
179
180	To expand the example above to typical perl error messages ("XXX at
181	FILENAME line YYY."), you need a slightly more elaborate solution:
182
183	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
184	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
185
186	The first line tells the selection code to treat the unchanging part of
187	every error message as a selection pattern, and the second line transforms
188	the message into vi commands to load the file.
189
190	=item tabbed
191
192	This transforms the terminal into a tabbar with additional terminals, that
193	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
194	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
195	button per tab.
196
197	Clicking a button will activate that tab. Pressing B<Shift-Left> and
198	B<Shift-Right> will switch to the tab left or right of the current one,
199	while B<Shift-Down> creates a new tab.
200
201	=item mark-urls
202
203	Uses per-line display filtering (C<on_line_update>) to underline urls and
204	make them clickable. When middle-clicked, the program specified in the
205	resource C<urlLauncher> (default C<x-www-browser>) will be started with
206	the URL as first argument.
207
208	=item automove-background
209
210	This is basically a one-line extension that dynamically changes the background pixmap offset
211	to the window position, in effect creating the same effect as pseudo transparency with
212	a custom pixmap. No scaling is supported in this mode. Exmaple:
213
214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
215
216	=item block-graphics-to-ascii
217
218	A not very useful example of filtering all text output to the terminal,
219	by replacing all line-drawing characters (U+2500 .. U+259F) by a
220	similar-looking ascii character.
221
222	=item digital-clock
223
224	Displays a digital clock using the built-in overlay.
225
226	=item example-refresh-hooks
227
228	Displays a very simple digital clock in the upper right corner of the
229	window. Illustrates overwriting the refresh callbacks to create your own
230	overlays or changes.
231
232	=item selection-pastebin
233
234	This is a little rarely useful extension that Uploads the selection as
235	textfile to a remote site (or does other things). (The implementation is
236	not currently secure for use in a multiuser environment as it writes to
237	F</tmp> directly.).
238
239	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
240	i.e.
241
242	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
243
244	Pressing this combination runs a command with C<%> replaced by the name of
245	the textfile. This command can be set via a resource:
246
247	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
248
249	And the default is likely not useful to anybody but the few people around
250	here :)
251
252	The name of the textfile is the hex encoded md5 sum of the selection, so
253	the same content should lead to the same filename.
254
255	After a successful upload the selection will be replaced by the text given
256	in the C<selection-pastebin-url> resource (again, the % is the placeholder
257	for the filename):
258
259	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
260
261	=back
262		57
263	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
264		59
265	=head2 General API Considerations	60	=head2 General API Considerations
266		61
…		…
280		75
281	=over 4	76	=over 4
282		77
283	=item $text	78	=item $text
284		79
285	Rxvt-unicodes special way of encoding text, where one "unicode" character	80	Rxvt-unicode's special way of encoding text, where one "unicode" character
286	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.
287		82
288	=item $string	83	=item $string
289		84
290	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
…		…
294	=item $octets	89	=item $octets
295		90
296	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
297	locale-specific way.	92	locale-specific way.
298		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
299	=back	100	=back
300		101
301	=head2 Extension Objects	102	=head2 Extension Objects
302		103
303	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
304	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,
305	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
306	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
307	begin with an underscore character C<_>: these are reserved for internal	109	that begin with an underscore character C<_>: these are reserved for
308	use.	110	internal use.
309		111
310	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
311	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
312		114
313	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:
314		124
315	=over 4	125	=over 4
316		126
317	=item $urxvt_term = $self->{term}	127	=item #:META:RESOURCE:name:type:desc
318		128
319	Returns the C<urxvt::term> object associated with this instance of the	129	The RESOURCE comment defines a resource used by the extension, where
320	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>
321		131	or C<string>, and C<desc> is the resource description.
322	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
323
324	Dynamically enable the given hooks (named without the C<on_> prefix) for
325	this extension, replacing any previous hook. This is useful when you want
326	to overwrite time-critical hooks only temporarily.
327
328	=item $self->disable ($hook_name[, $hook_name..])
329
330	Dynamically disable the given hooks.
331		132
332	=back	133	=back
333		134
334	=head2 Hooks	135	=head2 Hooks
335		136
336	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
337	called whenever the relevant event happens.	138	called whenever the relevant event happens.
338		139
339	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
340	the in the C<Extension Objects> section.	141	the in the C<Extension Objects> section.
341		142
342	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
343	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
344	relevant action might not be carried out by the C++ code.	145	relevant action might not be carried out by the C++ code.
…		…
357	place.	158	place.
358		159
359	=item on_start $term	160	=item on_start $term
360		161
361	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
362	trying to map (display) the toplevel and returning to the mainloop.	163	trying to map (display) the toplevel and returning to the main loop.
363		164
364	=item on_destroy $term	165	=item on_destroy $term
365		166
366	Called whenever something tries to destroy terminal, before doing anything	167	Called whenever something tries to destroy terminal, when the terminal is
367	yet. If this hook returns true, then destruction is skipped, but this is	168	still fully functional (not for long, though).
368	rarely a good idea.
369		169
370	=item on_reset $term	170	=item on_reset $term
371		171
372	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
373	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
…		…
395		195
396	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
397	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
398	by calling C<< $term->selection >>.	198	by calling C<< $term->selection >>.
399		199
400	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.
401		201
402	=item on_sel_extend $term	202	=item on_sel_extend $term
403		203
404	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
405	click) and is either supposed to return false (normal operation), or	205	click) and is either supposed to return false (normal operation), or
406	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
407	processing. This can happen multiple times, as long as the callback	207	processing. This can happen multiple times, as long as the callback
408	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
409	supposed to enlarge the selection more and more, if possible.	209	supposed to enlarge the selection more and more, if possible.
410		210
411	See the F<selection> example extension.	211	See the F<selection> example extension.
412		212
413	=item on_view_change $term, $offset	213	=item on_view_change $term, $offset
414		214
415	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
416	scrolls. Offset C<0> means display the normal terminal, positive values	216	scrolls. Offset C<0> means display the normal terminal, positive values
417	show this many lines of scrollback.	217	show this many lines of scrollback.
418		218
419	=item on_scroll_back $term, $lines, $saved	219	=item on_scroll_back $term, $lines, $saved
420		220
…		…
424		224
425	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,
426	$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
427	number of lines that will be in the scrollback buffer.	227	number of lines that will be in the scrollback buffer.
428		228
429	=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
430		240
431	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	241	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
432	operating system command) is processed. Cursor position and other state	242	operating system command) is processed. Cursor position and other state
433	information is up-to-date when this happens. For interoperability, the	243	information is up-to-date when this happens. For interoperability, the
434	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,
435	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
436	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	}
437		257
438	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,
439	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
440	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.
441		264
442	=item on_add_lines $term, $string	265	=item on_add_lines $term, $string
443		266
444	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
445	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
…		…
450	=item on_tt_write $term, $octets	273	=item on_tt_write $term, $octets
451		274
452	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
453	suppress or filter tty input.	276	suppress or filter tty input.
454		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
455	=item on_line_update $term, $row	285	=item on_line_update $term, $row
456		286
457	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
458	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
459	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,
…		…
466	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
467	you cannot just toggle rendition bits, but only set them.	297	you cannot just toggle rendition bits, but only set them.
468		298
469	=item on_refresh_begin $term	299	=item on_refresh_begin $term
470		300
471	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
472	or similar effects by modify terminal contents in refresh_begin, and	302	similar effects by modifying the terminal contents in refresh_begin, and
473	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
474	code is run after this hook, and takes precedence.	304	code is run after this hook, and takes precedence.
475		305
476	=item on_refresh_end $term	306	=item on_refresh_end $term
477		307
478	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>.
479		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
480	=item on_keyboard_command $term, $string	318	=item on_user_command $term, $string *DEPRECATED*
481		319
482	Called whenever the user presses a key combination that has a	320	Called whenever a user-configured event is being activated (e.g. via
483	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>
484	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.
485		332
486	=item on_x_event $term, $event	333	=item on_x_event $term, $event
487		334
488	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
489	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
490	members are not passed.	337	members are not passed.
491		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
492	=item on_focus_in $term	343	=item on_focus_in $term
493		344
494	Called whenever the window gets the keyboard focus, before rxvt-unicode	345	Called whenever the window gets the keyboard focus, before rxvt-unicode
495	does focus in processing.	346	does focus in processing.
496		347
497	=item on_focus_out $term	348	=item on_focus_out $term
498		349
499	Called wheneever the window loses keyboard focus, before rxvt-unicode does	350	Called whenever the window loses keyboard focus, before rxvt-unicode does
500	focus out processing.	351	focus out processing.
501		352
502	=item on_configure_notify $term, $event	353	=item on_configure_notify $term, $event
503		354
504	=item on_property_notify $term, $event	355	=item on_property_notify $term, $event
…		…
515		366
516	=item on_map_notify $term, $event	367	=item on_map_notify $term, $event
517		368
518	=item on_unmap_notify $term, $event	369	=item on_unmap_notify $term, $event
519		370
520	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
521	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.
522		373
523	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
524	manpage), with the additional members C<row> and C<col>, which are the	375	manpage), with the additional members C<row> and C<col>, which are the
525	(real, not screen-based) row and column under the mouse cursor.	376	(real, not screen-based) row and column under the mouse cursor.
526		377
527	C<on_key_press> additionally receives the string rxvt-unicode would	378	C<on_key_press> additionally receives the string rxvt-unicode would
528	output, if any, in locale-specific encoding.	379	output, if any, in locale-specific encoding.
529		380
530	subwindow.
531
532	=item on_client_message $term, $event	381	=item on_client_message $term, $event
533		382
534	=item on_wm_protocols $term, $event	383	=item on_wm_protocols $term, $event
535		384
536	=item on_wm_delete_window $term, $event	385	=item on_wm_delete_window $term, $event
537		386
538	Called when various types of ClientMessage events are received (all with	387	Called when various types of ClientMessage events are received (all with
539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	388	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
540		389
		390	=item on_bell $term
		391
		392	Called on receipt of a bell character.
		393
541	=back	394	=back
542		395
543	=cut	396	=cut
544		397
545	package urxvt;	398	package urxvt;
546		399
547	use utf8;	400	use utf8;
548	use strict;	401	use strict 'vars';
549	use Carp ();	402	use Carp ();
550	use Scalar::Util ();	403	use Scalar::Util ();
551	use List::Util ();	404	use List::Util ();
552		405
553	our $VERSION = 1;	406	our $VERSION = 1;
554	our $TERM;	407	our $TERM;
555	our @TERM_INIT;	408	our @TERM_INIT; # should go, prevents async I/O etc.
556	our @TERM_EXT;	409	our @TERM_EXT; # should go, prevents async I/O etc.
557	our @HOOKNAME;	410	our @HOOKNAME;
558	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	411	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
559	our %OPTION;	412	our %OPTION;
560		413
561	our $LIBDIR;	414	our $LIBDIR;
…		…
587	The current terminal. This variable stores the current C<urxvt::term>	440	The current terminal. This variable stores the current C<urxvt::term>
588	object, whenever a callback/hook is executing.	441	object, whenever a callback/hook is executing.
589		442
590	=item @urxvt::TERM_INIT	443	=item @urxvt::TERM_INIT
591		444
592	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
593	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
594	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,
595	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.
596		449
597	This complements to the perl-eval commandline option, but gets executed	450	This complements to the perl-eval command line option, but gets executed
598	first.	451	first.
599		452
600	=item @urxvt::TERM_EXT	453	=item @urxvt::TERM_EXT
601		454
602	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
…		…
609		462
610	=over 4	463	=over 4
611		464
612	=item urxvt::fatal $errormessage	465	=item urxvt::fatal $errormessage
613		466
614	Fatally aborts execution with the given error message. Avoid at all	467	Fatally aborts execution with the given error message (which should
615	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
616	starts up.	469	is acceptable (and useful) is in the init hook, where it prevents the
		470	terminal from starting up.
617		471
618	=item urxvt::warn $string	472	=item urxvt::warn $string
619		473
620	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
621	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
622	that calls this function.	476	that calls this function.
623		477
624	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
625	correct place, e.g. on stderr of the connecting urxvtc client.	479	correct place, e.g. on stderr of the connecting urxvtc client.
626		480
627	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).
628		489
629	=item $time = urxvt::NOW	490	=item $time = urxvt::NOW
630		491
631	Returns the "current time" (as per the event loop).	492	Returns the "current time" (as per the event loop).
632		493
…		…
675		536
676	=item $rend = urxvt::OVERLAY_RSTYLE	537	=item $rend = urxvt::OVERLAY_RSTYLE
677		538
678	Return the rendition mask used for overlays by default.	539	Return the rendition mask used for overlays by default.
679		540
680	=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
681		543
682	Return the bit that enabled bold, italic, blink, reverse-video and	544	Return the bit that enabled bold, italic, blink, reverse-video and
683	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
684	the bitset.	546	the bitset.
685		547
…		…
690	Return the foreground/background colour index, respectively.	552	Return the foreground/background colour index, respectively.
691		553
692	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	554	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
693		555
694	=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
695		559
696	Replace the foreground/background colour in the rendition mask with the	560	Replace the foreground/background colour in the rendition mask with the
697	specified one.	561	specified one.
698		562
699	=item $value = urxvt::GET_CUSTOM $rend	563	=item $value = urxvt::GET_CUSTOM $rend
…		…
720	};	584	};
721	}	585	}
722		586
723	no warnings 'utf8';	587	no warnings 'utf8';
724		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
725	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
726		652
727	sub verbose {	653	sub verbose {
728	my ($level, $msg) = @_;	654	my ($level, $msg) = @_;
729	warn "$msg\n" if $level <= $verbosity;	655	warn "$msg\n" if $level <= $verbosity;
…		…
741	$pkg =~ s/[^[:word:]]/_/g;	667	$pkg =~ s/[^[:word:]]/_/g;
742	$pkg = "urxvt::ext::$pkg";	668	$pkg = "urxvt::ext::$pkg";
743		669
744	verbose 3, "loading extension '$path' into package '$pkg'";	670	verbose 3, "loading extension '$path' into package '$pkg'";
745		671
		672	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		673
746	open my $fh, "<:raw", $path	674	open my $fh, "<:raw", $path
747	or die "$path: $!";	675	or die "$path: $!";
748		676
749	my $source =	677	my $source =
750	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	678	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
751	. "#line 1 \"$path\"\n{\n"	679	. "#line 1 \"$path\"\n{\n"
752	. (do { local $/; <$fh> })	680	. (do { local $/; <$fh> })
753	. "\n};\n1";	681	. "\n};\n1";
754		682
755	eval $source	683	eval $source
…		…
764	# called by the rxvt core	692	# called by the rxvt core
765	sub invoke {	693	sub invoke {
766	local $TERM = shift;	694	local $TERM = shift;
767	my $htype = shift;	695	my $htype = shift;
768		696
769	if ($htype == 0) { # INIT	697	if ($htype == HOOK_INIT) {
770	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	698	my @dirs = $TERM->perl_libdirs;
771		699
		700	$TERM->scan_extensions;
		701
772	my %ext_arg;	702	my %ext_arg;
773		703
774	{	704	{
775	my @init = @TERM_INIT;	705	my @init = @TERM_INIT;
776	@TERM_INIT = ();	706	@TERM_INIT = ();
…		…
778	my @pkg = @TERM_EXT;	708	my @pkg = @TERM_EXT;
779	@TERM_EXT = ();	709	@TERM_EXT = ();
780	$TERM->register_package ($_) for @pkg;	710	$TERM->register_package ($_) for @pkg;
781	}	711	}
782		712
		713	for (
783	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	) {
784	if ($_ eq "default") {	717	if ($_ eq "default") {
		718
		719	$ext_arg{$_} = []
785	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	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
786	} elsif (/^-(.*)$/) {	731	} elsif (/^-(.*)$/) {
787	delete $ext_arg{$1};	732	delete $ext_arg{$1};
		733
788	} elsif (/^([^<]+)<(.*)>$/) {	734	} elsif (/^([^<]+)<(.*)>$/) {
789	push @{ $ext_arg{$1} }, $2;	735	push @{ $ext_arg{$1} }, $2;
		736
790	} else {	737	} else {
791	$ext_arg{$_} ||= [];	738	$ext_arg{$_} ||= [];
792	}	739	}
793	}	740	}
794		741
795	while (my ($ext, $argv) = each %ext_arg) {	742	for my $ext (sort keys %ext_arg) {
796	my @files = grep -f $_, map "$_/$ext", @dirs;	743	my @files = grep -f $_, map "$_/$ext", @dirs;
797		744
798	if (@files) {	745	if (@files) {
799	$TERM->register_package (extension_package $files[0], $argv);	746	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
800	} else {	747	} else {
801	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";
802	}	749	}
803	}	750	}
804		751
…		…
810		757
811	if (my $cb = $TERM->{_hook}[$htype]) {	758	if (my $cb = $TERM->{_hook}[$htype]) {
812	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	759	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
813	if $verbosity >= 10;	760	if $verbosity >= 10;
814		761
815	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";
816		768
817	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) {
818	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	776	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
819	$retval ||= $retval_;	777	$retval ||= $retval_;
820		778
821	if ($@) {	779	if ($@) {
822	$TERM->ungrab; # better to lose the grab than the session	780	$TERM->ungrab; # better to lose the grab than the session
823	warn $@;	781	warn $@;
…		…
826		784
827	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	785	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
828	if $verbosity >= 11;	786	if $verbosity >= 11;
829	}	787	}
830		788
831	if ($htype == 1) { # DESTROY	789	if ($htype == HOOK_DESTROY) {
832	# clear package objects	790	# clear package objects
833	%$_ = () for values %{ $TERM->{_pkg} };	791	%$_ = () for values %{ $TERM->{_pkg} };
834		792
835	# clear package	793	# clear package
836	%$TERM = ();	794	%$TERM = ();
837	}	795	}
838		796
839	$retval	797	$retval
840	}	798	}
841		799
842	# 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	}
843		828
844	package urxvt::term::extension;	829	package urxvt::term::extension;
845		830
846	sub enable {	831	=head2 The C<urxvt::term::extension> class
847	my ($self, %hook) = @_;
848	my $pkg = $self->{_pkg};
849		832
850	while (my ($name, $cb) = each %hook) {	833	Each extension attached to a terminal object is represented by
851	my $htype = $HOOKTYPE{uc $name};	834	a C<urxvt::term::extension> object.
852	defined $htype
853	or Carp::croak "unsupported hook type '$name'";
854		835
855	$self->set_should_invoke ($htype, +1)	836	You can use these objects, which are passed to all callbacks to store any
856	unless exists $self->{term}{_hook}[$htype]{$pkg};	837	state related to the terminal and extension instance.
857		838
858	$self->{term}{_hook}[$htype]{$pkg} = $cb;	839	The methods (And data members) documented below can be called on extension
859	}	840	objects, in addition to call methods documented for the <urxvt::term>
860	}	841	class.
861		842
862	sub disable {	843	=over 4
863	my ($self, @hook) = @_;
864	my $pkg = $self->{_pkg};
865		844
866	for my $name (@hook) {	845	=item $urxvt_term = $self->{term}
867	my $htype = $HOOKTYPE{uc $name};
868	defined $htype
869	or Carp::croak "unsupported hook type '$name'";
870		846
871	$self->set_should_invoke ($htype, -1)	847	Returns the C<urxvt::term> object associated with this instance of the
872	if delete $self->{term}{_hook}[$htype]{$pkg};	848	extension. This member I<must not> be changed in any way.
873	}	849
874	}	850	=cut
875		851
876	our $AUTOLOAD;	852	our $AUTOLOAD;
877		853
878	sub AUTOLOAD {	854	sub AUTOLOAD {
879	$AUTOLOAD =~ /:([^:]+)$/	855	$AUTOLOAD =~ /:([^:]+)$/
…		…
892		868
893	sub DESTROY {	869	sub DESTROY {
894	# nop	870	# nop
895	}	871	}
896		872
897	# urxvt::destroy_hook	873	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
898		874
899	sub urxvt::destroy_hook::DESTROY {	875	sub urxvt::destroy_hook::DESTROY {
900	${$_[0]}->();	876	${$_[0]}->();
901	}	877	}
902		878
903	sub urxvt::destroy_hook(&) {	879	sub urxvt::destroy_hook(&) {
904	bless \shift, urxvt::destroy_hook::	880	bless \shift, urxvt::destroy_hook::
905	}	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
906		1005
907	package urxvt::anyevent;	1006	package urxvt::anyevent;
908		1007
909	=head2 The C<urxvt::anyevent> Class	1008	=head2 The C<urxvt::anyevent> Class
910		1009
911	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
912	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
913	further programming. The only exception is that you cannot wait on	1012	further programming. The only exception is that you cannot wait on
914	condition variables, but non-blocking condvar use is ok. What this means	1013	condition variables, but non-blocking condvar use is ok.
915	is that you cannot use blocking APIs, but the non-blocking variant should
916	work.
917		1014
918	=cut	1015	In practical terms this means is that you cannot use blocking APIs, but
		1016	the non-blocking variant should work.
919		1017
		1018	=cut
		1019
920	our $VERSION = 1;	1020	our $VERSION = '5.23';
921		1021
922	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1022	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
923	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1023	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
924		1024
925	sub timer {	1025	sub timer {
…		…
927		1027
928	my $cb = $arg{cb};	1028	my $cb = $arg{cb};
929		1029
930	urxvt::timer	1030	urxvt::timer
931	->new	1031	->new
932	->start (urxvt::NOW + $arg{after})	1032	->after ($arg{after}, $arg{interval})
933	->cb (sub {	1033	->cb ($arg{interval} ? $cb : sub {
934	$_[0]->stop; # need to cancel manually	1034	$_[0]->stop; # need to cancel manually
935	$cb->();	1035	$cb->();
936	})	1036	})
937	}	1037	}
938		1038
939	sub io {	1039	sub io {
940	my ($class, %arg) = @_;	1040	my ($class, %arg) = @_;
941		1041
942	my $cb = $arg{cb};	1042	my $cb = $arg{cb};
		1043	my $fd = fileno $arg{fh};
		1044	defined $fd or $fd = $arg{fh};
943		1045
944	bless [$arg{fh}, urxvt::iow	1046	bless [$arg{fh}, urxvt::iow
945	->new	1047	->new
946	->fd (fileno $arg{fh})	1048	->fd ($fd)
947	->events (($arg{poll} =~ /r/ ? 1 : 0)	1049	->events (($arg{poll} =~ /r/ ? 1 : 0)
948	| ($arg{poll} =~ /w/ ? 2 : 0))	1050	| ($arg{poll} =~ /w/ ? 2 : 0))
949	->start	1051	->start
950	->cb (sub {	1052	->cb ($cb)
951	$cb->(($_[1] & 1 ? 'r' : '')
952	. ($_[1] & 2 ? 'w' : ''));
953	})],
954	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	})
955	}	1079	}
956		1080
957	sub DESTROY {	1081	sub DESTROY {
958	$_[0][1]->stop;	1082	$_[0][1]->stop;
959	}	1083	}
960		1084
961	sub condvar {	1085	# only needed for AnyEvent < 6 compatibility
962	bless \my $flag, urxvt::anyevent::condvar::	1086	sub one_event {
963	}
964
965	sub urxvt::anyevent::condvar::broadcast {
966	${$_[0]}++;
967	}
968
969	sub urxvt::anyevent::condvar::wait {
970	unless (${$_[0]}) {
971	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";
972	}
973	}	1088	}
974		1089
975	package urxvt::term;	1090	package urxvt::term;
976		1091
977	=head2 The C<urxvt::term> Class	1092	=head2 The C<urxvt::term> Class
…		…
990	urxvt::verbose 6, "register package $pkg to $self";	1105	urxvt::verbose 6, "register package $pkg to $self";
991		1106
992	@{"$pkg\::ISA"} = urxvt::term::extension::;	1107	@{"$pkg\::ISA"} = urxvt::term::extension::;
993		1108
994	my $proxy = bless {	1109	my $proxy = bless {
995	_pkg => $pkg,	1110	_pkg => $pkg,
		1111	_name => ${"$pkg\::_NAME"}, # hackish
996	argv => $argv,	1112	argv => $argv,
997	}, $pkg;	1113	}, $pkg;
998	Scalar::Util::weaken ($proxy->{term} = $self);	1114	Scalar::Util::weaken ($proxy->{term} = $self);
999		1115
1000	$self->{_pkg}{$pkg} = $proxy;	1116	$self->{_pkg}{$pkg} = $proxy;
1001		1117
…		…
1004	$proxy->enable ($name => $ref);	1120	$proxy->enable ($name => $ref);
1005	}	1121	}
1006	}	1122	}
1007	}	1123	}
1008		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
1009	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1197	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1010		1198
1011	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
1012	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
1013	hash which defines the environment of the new terminal.	1201	hash which defines the environment of the new terminal.
1014		1202
1015	Croaks (and probably outputs an error message) if the new instance	1203	Croaks (and probably outputs an error message) if the new instance
1016	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
1017	initialise perl, and the terminal object otherwise. The C<init> and	1205	initialise perl, and the terminal object otherwise. The C<init> and
1018	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).
1019		1208
1020	=cut	1209	=cut
1021		1210
1022	sub new {	1211	sub new {
1023	my ($class, $env, @args) = @_;	1212	my ($class, $env, @args) = @_;
1024		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
1025	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1217	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1026	}	1218	}
1027		1219
1028	=item $term->destroy	1220	=item $term->destroy
1029		1221
1030	Destroy the terminal object (close the window, free resources	1222	Destroy the terminal object (close the window, free resources
1031	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
1032	watchers (timers, io watchers) are still active.	1224	watchers (timers, io watchers) are still active.
1033		1225
1034	=item $term->exec_async ($cmd[, @args])	1226	=item $term->exec_async ($cmd[, @args])
1035		1227
1036	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
…		…
1060		1252
1061	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
1062	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
1063	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.
1064		1256
1065	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
1066	source file F</src/optinc.h> to see the actual list:	1258	source file F</src/optinc.h> to see the actual list:
1067		1259
1068	borderLess console cursorBlink cursorUnderline hold iconic insecure	1260	borderLess buffered console cursorBlink cursorUnderline hold iconic
1069	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1261	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1070	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1262	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1071	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1263	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1072	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1264	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1073	transparent tripleclickwords utmpInhibit visualBell	1265	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1266	urgentOnBell utmpInhibit visualBell
1074		1267
1075	=item $value = $term->resource ($name[, $newval])	1268	=item $value = $term->resource ($name[, $newval])
1076		1269
1077	Returns the current resource value associated with a given name and	1270	Returns the current resource value associated with a given name and
1078	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>
…		…
1087	likely change).	1280	likely change).
1088		1281
1089	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
1090	terminal is destroyed, so changing options frequently will eat memory.	1283	terminal is destroyed, so changing options frequently will eat memory.
1091		1284
1092	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
1093	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>
1094	to see the actual list:	1287	to see the actual list:
1095		1288
1096	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1289	answerbackstring backgroundPixmap backspace_key blurradius
1097	borderLess color cursorBlink cursorUnderline cutchars delete_key	1290	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1098	display_name embed ext_bwidth fade font geometry hold iconName	1291	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1099	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
1100	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1294	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1101	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1295	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1102	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1296	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1103	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1297	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1104	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1298	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1105	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1299	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1106	secondaryScreen secondaryScroll selectstyle shade term_name title	1300	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1107	transient_for transparent transparent_all tripleclickwords utmpInhibit	1301	term_name title transient_for transparent tripleclickwords urgentOnBell
1108	visualBell	1302	utmpInhibit visualBell
1109		1303
1110	=cut	1304	=cut
1111		1305
1112	sub resource($$;$) {	1306	sub resource($$;$) {
1113	my ($self, $name) = (shift, shift);	1307	my ($self, $name) = (shift, shift);
1114	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1308	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1115	&urxvt::term::_resource	1309	goto &urxvt::term::_resource
1116	}	1310	}
1117		1311
1118	=item $value = $term->x_resource ($pattern)	1312	=item $value = $term->x_resource ($pattern)
1119		1313
1120	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
1121	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
1122	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
1123	resource with that pattern exists.	1317	resource with that pattern exists.
1124		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
1125	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
1126	only one resource database per display, and later invocations might return	1330	only one resource database per display, and later invocations might return
1127	the wrong resources.	1331	the wrong resources.
1128		1332
1129	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1333	=item $value = $term->x_resource_boolean ($pattern)
1130		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
1131	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
1132	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	}
1133		1368
1134	=item $rend = $term->rstyle ([$new_rstyle])	1369	=item $rend = $term->rstyle ([$new_rstyle])
1135		1370
1136	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
1137	the terminal application will use this style.	1372	the terminal application will use this style.
…		…
1145		1380
1146	=item ($row, $col) = $term->selection_beg ([$row, $col])	1381	=item ($row, $col) = $term->selection_beg ([$row, $col])
1147		1382
1148	=item ($row, $col) = $term->selection_end ([$row, $col])	1383	=item ($row, $col) = $term->selection_end ([$row, $col])
1149		1384
1150	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.
1151	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.
1152		1394
1153	=item $term->selection_make ($eventtime[, $rectangular])	1395	=item $term->selection_make ($eventtime[, $rectangular])
1154		1396
1155	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
1156	C<selection_end>. If C<$rectangular> is true (default: false), a	1398	C<selection_end>. If C<$rectangular> is true (default: false), a
1157	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
1158	a selection.	1400	a selection.
1159		1401
1160	=item $success = $term->selection_grab ($eventtime)	1402	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1161		1403
1162	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
1163	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
1164	is mostly useful from within C<on_sel_grab> hooks.	1407	is mostly useful from within C<on_sel_grab> hooks.
1165		1408
1166	=item $oldtext = $term->selection ([$newtext])	1409	=item $oldtext = $term->selection ([$newtext, $clipboard])
1167		1410
1168	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.
1169		1417
1170	=item $term->overlay_simple ($x, $y, $text)	1418	=item $term->overlay_simple ($x, $y, $text)
1171		1419
1172	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.
1173		1421
…		…
1203		1451
1204	The methods currently supported on C<urxvt::overlay> objects are:	1452	The methods currently supported on C<urxvt::overlay> objects are:
1205		1453
1206	=over 4	1454	=over 4
1207		1455
1208	=item $overlay->set ($x, $y, $text, $rend)	1456	=item $overlay->set ($x, $y, $text[, $rend])
1209		1457
1210	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
1211	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
1212	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.
1213		1463
1214	=item $overlay->hide	1464	=item $overlay->hide
1215		1465
1216	If visible, hide the overlay, but do not destroy it.	1466	If visible, hide the overlay, but do not destroy it.
1217		1467
…		…
1280		1530
1281	=item $term->scr_add_lines ($string)	1531	=item $term->scr_add_lines ($string)
1282		1532
1283	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
1284	running inside the terminal. It may not contain command sequences (escape	1534	running inside the terminal. It may not contain command sequences (escape
1285	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,
1286	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.
1287		1538
1288	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
1289	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
1290	C<on_add_lines> hook, though.	1541	C<on_add_lines> hook, though.
1291		1542
…		…
1299	locale-specific encoding of the terminal and can contain command sequences	1550	locale-specific encoding of the terminal and can contain command sequences
1300	(escape codes) that will be interpreted.	1551	(escape codes) that will be interpreted.
1301		1552
1302	=item $term->tt_write ($octets)	1553	=item $term->tt_write ($octets)
1303		1554
1304	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
1305	pass characters instead of octets, you should convert your strings first	1557	characters instead of octets, you should convert your strings first to the
1306	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.
1307		1573
1308	=item $old_events = $term->pty_ev_events ([$new_events])	1574	=item $old_events = $term->pty_ev_events ([$new_events])
1309		1575
1310	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
1311	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
1312	description of C<< urxvt::timer->events >>. Make sure to always restore	1578	description of C<< urxvt::timer->events >>. Make sure to always restore
1313	the previous value.	1579	the previous value.
1314		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
1315	=item $windowid = $term->parent	1586	=item $windowid = $term->parent
1316		1587
1317	Return the window id of the toplevel window.	1588	Return the window id of the toplevel window.
1318		1589
1319	=item $windowid = $term->vt	1590	=item $windowid = $term->vt
…		…
1325	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
1326	to receive pointer events all the times:	1597	to receive pointer events all the times:
1327		1598
1328	$term->vt_emask_add (urxvt::PointerMotionMask);	1599	$term->vt_emask_add (urxvt::PointerMotionMask);
1329		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
1330	=item $window_width = $term->width	1615	=item $window_width = $term->width
1331		1616
1332	=item $window_height = $term->height	1617	=item $window_height = $term->height
1333		1618
1334	=item $font_width = $term->fwidth	1619	=item $font_width = $term->fwidth
…		…
1364	=item $env = $term->env	1649	=item $env = $term->env
1365		1650
1366	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
1367	similar to C<\%ENV>.	1652	similar to C<\%ENV>.
1368		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
1369	=cut	1663	=cut
1370		1664
1371	sub env {	1665	sub env {
1372	if (my $env = $_[0]->_env) {
1373	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1666	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1374	} else {
1375	+{ %ENV }
1376	}
1377	}	1667	}
1378		1668
1379	=item $modifiermask = $term->ModLevel3Mask	1669	=item $modifiermask = $term->ModLevel3Mask
1380		1670
1381	=item $modifiermask = $term->ModMetaMask	1671	=item $modifiermask = $term->ModMetaMask
…		…
1389		1679
1390	Returns the currently displayed screen (0 primary, 1 secondary).	1680	Returns the currently displayed screen (0 primary, 1 secondary).
1391		1681
1392	=item $cursor_is_hidden = $term->hidden_cursor	1682	=item $cursor_is_hidden = $term->hidden_cursor
1393		1683
1394	Returns wether the cursor is currently hidden or not.	1684	Returns whether the cursor is currently hidden or not.
1395		1685
1396	=item $view_start = $term->view_start ([$newvalue])	1686	=item $view_start = $term->view_start ([$newvalue])
1397		1687
1398	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
1399	C<0>, which displays the normal terminal contents. Lower values scroll	1689	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1407		1697
1408	Used after changing terminal contents to display them.	1698	Used after changing terminal contents to display them.
1409		1699
1410	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1700	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1411		1701
1412	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 >>
1413	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
1414	terminal line. The scrollback buffer starts at line C<-1> and extends to
1415	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1704	terminal line. Nothing will be returned if a nonexistent line
1416	is requested.	1705	is requested.
1417		1706
1418	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
1419	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
1420	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
1421	automatically be updated.	1710	automatically be updated.
1422		1711
1423	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
1424	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1713	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1425	characters. Characters with combining characters and other characters that	1714	characters. Characters with combining characters and other characters that
1426	do not fit into the normal tetx encoding will be replaced with characters	1715	do not fit into the normal text encoding will be replaced with characters
1427	in the private use area.	1716	in the private use area.
1428		1717
1429	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
1430	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
1431	characters.	1720	characters.
…		…
1516	}	1805	}
1517		1806
1518	sub urxvt::line::t {	1807	sub urxvt::line::t {
1519	my ($self) = @_;	1808	my ($self) = @_;
1520		1809
1521	if (@_ > 1)	1810	if (@_ > 1) {
1522	{
1523	$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})
1524	for $self->{beg} .. $self->{end};	1812	for $self->{beg} .. $self->{end};
1525	}	1813	}
1526		1814
1527	defined wantarray &&	1815	defined wantarray &&
1528	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1816	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1529	0, $self->{len}	1817	0, $self->{len}
1530	}	1818	}
1531		1819
1532	sub urxvt::line::r {	1820	sub urxvt::line::r {
1533	my ($self) = @_;	1821	my ($self) = @_;
1534		1822
1535	if (@_ > 1)	1823	if (@_ > 1) {
1536	{
1537	$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})
1538	for $self->{beg} .. $self->{end};	1825	for $self->{beg} .. $self->{end};
1539	}	1826	}
1540		1827
1541	if (defined wantarray) {	1828	if (defined wantarray) {
1542	my $rend = [	1829	my $rend = [
1543	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1830	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1544	];	1831	];
…		…
1576	where one character corresponds to one screen cell. See	1863	where one character corresponds to one screen cell. See
1577	C<< $term->ROW_t >> for details.	1864	C<< $term->ROW_t >> for details.
1578		1865
1579	=item $string = $term->special_decode $text	1866	=item $string = $term->special_decode $text
1580		1867
1581	Converts rxvt-unicodes text reprsentation into a perl string. See	1868	Converts rxvt-unicodes text representation into a perl string. See
1582	C<< $term->ROW_t >> for details.	1869	C<< $term->ROW_t >> for details.
1583		1870
1584	=item $success = $term->grab_button ($button, $modifiermask)	1871	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1585		1872
		1873	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1874
1586	Registers a synchronous button grab. See the XGrabButton manpage.	1875	Register/unregister a synchronous button grab. See the XGrabButton
		1876	manpage.
1587		1877
1588	=item $success = $term->grab ($eventtime[, $sync])	1878	=item $success = $term->grab ($eventtime[, $sync])
1589		1879
1590	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1880	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1591	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1881	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1592		1882
1593	=item $term->allow_events_async	1883	=item $term->allow_events_async
1594		1884
1595	Calls XAllowEvents with AsyncBoth for the most recent grab.	1885	Calls XAllowEvents with AsyncBoth for the most recent grab.
1596		1886
…		…
1603	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1893	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1604	recent grab.	1894	recent grab.
1605		1895
1606	=item $term->ungrab	1896	=item $term->ungrab
1607		1897
1608	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
1609	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
1610	the session.	1900	the session.
1611		1901
1612	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1902	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1613		1903
…		…
1615		1905
1616	=item @atoms = $term->XListProperties ($window)	1906	=item @atoms = $term->XListProperties ($window)
1617		1907
1618	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1908	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1619		1909
1620	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1910	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1621		1911
1622	=item $term->XDeleteProperty ($window, $property)	1912	=item $term->XDeleteProperty ($window, $property)
1623		1913
1624	=item $window = $term->DefaultRootWindow	1914	=item $window = $term->DefaultRootWindow
1625		1915
…		…
1632	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1922	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1633		1923
1634	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1924	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1635		1925
1636	=item $term->XChangeInput ($window, $add_events[, $del_events])	1926	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1927
		1928	=item $keysym = $term->XStringToKeysym ($string)
		1929
		1930	=item $string = $term->XKeysymToString ($keysym)
1637		1931
1638	Various X or X-related functions. The C<$term> object only serves as	1932	Various X or X-related functions. The C<$term> object only serves as
1639	the source of the display, otherwise those functions map more-or-less	1933	the source of the display, otherwise those functions map more-or-less
1640	directory onto the X functions of the same name.	1934	directly onto the X functions of the same name.
1641		1935
1642	=back	1936	=back
1643		1937
1644	=cut	1938	=cut
1645		1939
…		…
1709	my ($self, $text, $cb) = @_;	2003	my ($self, $text, $cb) = @_;
1710		2004
1711	$self->add_item ({ type => "button", text => $text, activate => $cb});	2005	$self->add_item ({ type => "button", text => $text, activate => $cb});
1712	}	2006	}
1713		2007
1714	=item $popup->add_toggle ($text, $cb, $initial_value)	2008	=item $popup->add_toggle ($text, $initial_value, $cb)
1715		2009
1716	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
1717	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
1718	argument.	2012	first argument.
1719		2013
1720	=cut	2014	=cut
1721		2015
1722	sub add_toggle {	2016	sub add_toggle {
1723	my ($self, $text, $cb, $value) = @_;	2017	my ($self, $text, $value, $cb) = @_;
1724		2018
1725	my $item; $item = {	2019	my $item; $item = {
1726	type => "button",	2020	type => "button",
1727	text => " $text",	2021	text => " $text",
1728	value => $value,	2022	value => $value,
…		…
1747	my $env = $self->{term}->env;	2041	my $env = $self->{term}->env;
1748	# 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.
1749	delete $env->{LC_ALL};	2043	delete $env->{LC_ALL};
1750	$env->{LC_CTYPE} = $self->{term}->locale;	2044	$env->{LC_CTYPE} = $self->{term}->locale;
1751		2045
1752	urxvt::term->new ($env, "popup",	2046	my $term = urxvt::term->new (
		2047	$env, "popup",
1753	"--perl-lib" => "", "--perl-ext-common" => "",	2048	"--perl-lib" => "", "--perl-ext-common" => "",
1754	"-pty-fd" => -1, "-sl" => 0,	2049	"-pty-fd" => -1, "-sl" => 0,
1755	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2050	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1756	"--transient-for" => $self->{term}->parent,	2051	"--transient-for" => $self->{term}->parent,
1757	"-display" => $self->{term}->display_id,	2052	"-display" => $self->{term}->display_id,
1758	"-pe" => "urxvt-popup")	2053	"-pe" => "urxvt-popup",
1759	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	}
1760	}	2061	}
1761		2062
1762	sub DESTROY {	2063	sub DESTROY {
1763	my ($self) = @_;	2064	my ($self) = @_;
1764		2065
…		…
1769	=back	2070	=back
1770		2071
1771	=cut	2072	=cut
1772		2073
1773	package urxvt::watcher;	2074	package urxvt::watcher;
1774
1775	@urxvt::timer::ISA = __PACKAGE__;
1776	@urxvt::iow::ISA = __PACKAGE__;
1777	@urxvt::pw::ISA = __PACKAGE__;
1778	@urxvt::iw::ISA = __PACKAGE__;
1779		2075
1780	=head2 The C<urxvt::timer> Class	2076	=head2 The C<urxvt::timer> Class
1781		2077
1782	This class implements timer watchers/events. Time is represented as a	2078	This class implements timer watchers/events. Time is represented as a
1783	fractional number of seconds since the epoch. Example:	2079	fractional number of seconds since the epoch. Example:
…		…
1787	->new	2083	->new
1788	->interval (1)	2084	->interval (1)
1789	->cb (sub {	2085	->cb (sub {
1790	$term->{overlay}->set (0, 0,	2086	$term->{overlay}->set (0, 0,
1791	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2087	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1792	});	2088	});
1793		2089
1794	=over 4	2090	=over 4
1795		2091
1796	=item $timer = new urxvt::timer	2092	=item $timer = new urxvt::timer
1797		2093
…		…
1800		2096
1801	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2097	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1802		2098
1803	Set the callback to be called when the timer triggers.	2099	Set the callback to be called when the timer triggers.
1804		2100
1805	=item $tstamp = $timer->at
1806
1807	Return the time this watcher will fire next.
1808
1809	=item $timer = $timer->set ($tstamp)	2101	=item $timer = $timer->set ($tstamp[, $interval])
1810		2102
1811	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).
1812		2105
1813	=item $timer = $timer->interval ($interval)	2106	=item $timer = $timer->interval ($interval)
1814		2107
1815	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
1816	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
1817	is automatically rescheduled at the given intervals.	2110	is automatically rescheduled at the given intervals.
1818		2111
1819	=item $timer = $timer->start	2112	=item $timer = $timer->start
1820		2113
1821	Start the timer.	2114	Start the timer.
1822		2115
1823	=item $timer = $timer->start ($tstamp)	2116	=item $timer = $timer->start ($tstamp[, $interval])
1824		2117
1825	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.
1826		2120
1827	=item $timer = $timer->after ($delay)	2121	=item $timer = $timer->after ($delay[, $interval])
1828		2122
1829	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>.
1830		2124
1831	=item $timer = $timer->stop	2125	=item $timer = $timer->stop
1832		2126
…		…
1840		2134
1841	$term->{socket} = ...	2135	$term->{socket} = ...
1842	$term->{iow} = urxvt::iow	2136	$term->{iow} = urxvt::iow
1843	->new	2137	->new
1844	->fd (fileno $term->{socket})	2138	->fd (fileno $term->{socket})
1845	->events (urxvt::EVENT_READ)	2139	->events (urxvt::EV_READ)
1846	->start	2140	->start
1847	->cb (sub {	2141	->cb (sub {
1848	my ($iow, $revents) = @_;	2142	my ($iow, $revents) = @_;
1849	# $revents must be 1 here, no need to check	2143	# $revents must be 1 here, no need to check
1850	sysread $term->{socket}, my $buf, 8192	2144	sysread $term->{socket}, my $buf, 8192
…		…
1863	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>
1864	is a bitset as described in the C<events> method.	2158	is a bitset as described in the C<events> method.
1865		2159
1866	=item $iow = $iow->fd ($fd)	2160	=item $iow = $iow->fd ($fd)
1867		2161
1868	Set the filedescriptor (not handle) to watch.	2162	Set the file descriptor (not handle) to watch.
1869		2163
1870	=item $iow = $iow->events ($eventmask)	2164	=item $iow = $iow->events ($eventmask)
1871		2165
1872	Set the event mask to watch. The only allowed values are	2166	Set the event mask to watch. The only allowed values are
1873	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
1874	together, or C<urxvt::EVENT_NONE>.	2168	together, or C<urxvt::EV_NONE>.
1875		2169
1876	=item $iow = $iow->start	2170	=item $iow = $iow->start
1877		2171
1878	Start watching for requested events on the given handle.	2172	Start watching for requested events on the given handle.
1879		2173
1880	=item $iow = $iow->stop	2174	=item $iow = $iow->stop
1881		2175
1882	Stop watching for events on the given filehandle.	2176	Stop watching for events on the given file handle.
1883		2177
1884	=back	2178	=back
1885		2179
1886	=head2 The C<urxvt::iw> Class	2180	=head2 The C<urxvt::iw> Class
1887		2181
…		…
1920	->new	2214	->new
1921	->start ($pid)	2215	->start ($pid)
1922	->cb (sub {	2216	->cb (sub {
1923	my ($pw, $exit_status) = @_;	2217	my ($pw, $exit_status) = @_;
1924	...	2218	...
1925	});	2219	});
1926		2220
1927	=over 4	2221	=over 4
1928		2222
1929	=item $pw = new urxvt::pw	2223	=item $pw = new urxvt::pw
1930		2224
…		…
1934		2228
1935	Set the callback to be called when the timer triggers.	2229	Set the callback to be called when the timer triggers.
1936		2230
1937	=item $pw = $timer->start ($pid)	2231	=item $pw = $timer->start ($pid)
1938		2232
1939	Tells the wqtcher to start watching for process C<$pid>.	2233	Tells the watcher to start watching for process C<$pid>.
1940		2234
1941	=item $pw = $pw->stop	2235	=item $pw = $pw->stop
1942		2236
1943	Stop the watcher.	2237	Stop the watcher.
1944		2238
…		…
1957		2251
1958	=item >= 3 - script loading and management	2252	=item >= 3 - script loading and management
1959		2253
1960	=item >=10 - all called hooks	2254	=item >=10 - all called hooks
1961		2255
1962	=item >=11 - hook reutrn values	2256	=item >=11 - hook return values
1963		2257
1964	=back	2258	=back
1965		2259
1966	=head1 AUTHOR	2260	=head1 AUTHOR
1967		2261
1968	Marc Lehmann <pcg@goof.com>	2262	Marc Lehmann <schmorp@schmorp.de>
1969	http://software.schmorp.de/pkg/rxvt-unicode	2263	http://software.schmorp.de/pkg/rxvt-unicode
1970		2264
1971	=cut	2265	=cut
1972		2266
1973	1	2267	1
		2268
		2269	# vim: sw=3:

Diff Legend

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