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.126 by root, Tue Jan 24 19:14:36 2006 UTC vs.
Revision 1.248 by root, Fri Dec 26 21:01:46 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	Another example: Programs I use often output "absolute path: " at the
73	beginning of a line when they process multiple files. The following
74	pattern matches the filename (note, there is a single space at the very
75	end):
76
77	URxvt.selection.pattern-0: ^(/[^:]+):\
78
79	You can look at the source of the selection extension to see more
80	interesting uses, such as parsing a line from beginning to end.
81
82	This extension also offers following bindable keyboard commands:
83
84	=over 4
85
86	=item rot13
87
88	Rot-13 the selection when activated. Used via keyboard trigger:
89
90	URxvt.keysym.C-M-r: perl:selection:rot13
91
92	=back
93
94	=item option-popup (enabled by default)
95
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.
98
99	=item selection-popup (enabled by default)
100
101	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
102	text into various other formats/action (such as uri unescaping, perl
103	evaluation, web-browser starting etc.), depending on content.
104
105	Other extensions can extend this popup menu by pushing a code reference
106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
107	popup is displayed.
108
109	It's sole argument is the popup menu, which can be modified. The selection
110	is in C<$_>, which can be used to decide wether to add something or not.
111	It should either return nothing or a string and a code reference. The
112	string will be used as button text and the code reference will be called
113	when the button gets activated and should transform C<$_>.
114
115	The following will add an entry C<a to b> that transforms all C<a>s in
116	the selection to C<b>s, but only if the selection currently contains any
117	C<a>s:
118
119	push @{ $self->{term}{selection_popup_hook} }, sub {
120	/a/ ? ("a to be" => sub { s/a/b/g }
121	: ()
122	};
123
124	=item searchable-scrollback<hotkey> (enabled by default)
125
126	Adds regex search functionality to the scrollback buffer, triggered
127	by a hotkey (default: C<M-s>). While in search mode, normal terminal
128	input/output is suspended and a regex is displayed at the bottom of the
129	screen.
130
131	Inputting characters appends them to the regex and continues incremental
132	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
133	search upwards/downwards in the scrollback buffer, C<End> jumps to the
134	bottom. C<Escape> leaves search mode and returns to the point where search
135	was started, while C<Enter> or C<Return> stay at the current position and
136	additionally stores the first match in the current line into the primary
137	selection.
138
139	=item readline (enabled by default)
140
141	A support package that tries to make editing with readline easier. At the
142	moment, it reacts to clicking with the left mouse button by trying to
143	move the text cursor to this position. It does so by generating as many
144	cursor-left or cursor-right keypresses as required (the this only works
145	for programs that correctly support wide characters).
146
147	To avoid too many false positives, this is only done when:
148
149	=over 4
150
151	=item - the tty is in ICANON state.
152
153	=item - the text cursor is visible.
154
155	=item - the primary screen is currently being displayed.
156
157	=item - the mouse is on the same (multi-row-) line as the text cursor.
158
159	=back
160
161	The normal selection mechanism isn't disabled, so quick successive clicks
162	might interfere with selection creation in harmless ways.
163
164	=item selection-autotransform
165
166	This selection allows you to do automatic transforms on a selection
167	whenever a selection is made.
168
169	It works by specifying perl snippets (most useful is a single C<s///>
170	operator) that modify C<$_> as resources:
171
172	URxvt.selection-autotransform.0: transform
173	URxvt.selection-autotransform.1: transform
174	...
175
176	For example, the following will transform selections of the form
177	C<filename:number>, often seen in compiler messages, into C<vi +$filename
178	$word>:
179
180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
181
182	And this example matches the same,but replaces it with vi-commands you can
183	paste directly into your (vi :) editor:
184
185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
186
187	Of course, this can be modified to suit your needs and your editor :)
188
189	To expand the example above to typical perl error messages ("XXX at
190	FILENAME line YYY."), you need a slightly more elaborate solution:
191
192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
194
195	The first line tells the selection code to treat the unchanging part of
196	every error message as a selection pattern, and the second line transforms
197	the message into vi commands to load the file.
198
199	=item tabbed
200
201	This transforms the terminal into a tabbar with additional terminals, that
202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204	button per tab.
205
206	Clicking a button will activate that tab. Pressing B<Shift-Left> and
207	B<Shift-Right> will switch to the tab left or right of the current one,
208	while B<Shift-Down> creates a new tab.
209
210	=item mark-urls
211
212	Uses per-line display filtering (C<on_line_update>) to underline urls and
213	make them clickable. When middle-clicked, the program specified in the
214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
215	the URL as first argument.
216
217	=item automove-background
218
219	This is basically a one-line extension that dynamically changes the background pixmap offset
220	to the window position, in effect creating the same effect as pseudo transparency with
221	a custom pixmap. No scaling is supported in this mode. Exmaple:
222
223	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
224
225	=item block-graphics-to-ascii
226
227	A not very useful example of filtering all text output to the terminal,
228	by replacing all line-drawing characters (U+2500 .. U+259F) by a
229	similar-looking ascii character.
230
231	=item digital-clock
232
233	Displays a digital clock using the built-in overlay.
234
235	=item example-refresh-hooks
236
237	Displays a very simple digital clock in the upper right corner of the
238	window. Illustrates overwriting the refresh callbacks to create your own
239	overlays or changes.
240
241	=item selection-pastebin
242
243	This is a little rarely useful extension that Uploads the selection as
244	textfile to a remote site (or does other things). (The implementation is
245	not currently secure for use in a multiuser environment as it writes to
246	F</tmp> directly.).
247
248	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
249	i.e.
250
251	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
252
253	Pressing this combination runs a command with C<%> replaced by the name of
254	the textfile. This command can be set via a resource:
255
256	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
257
258	And the default is likely not useful to anybody but the few people around
259	here :)
260
261	The name of the textfile is the hex encoded md5 sum of the selection, so
262	the same content should lead to the same filename.
263
264	After a successful upload the selection will be replaced by the text given
265	in the C<selection-pastebin-url> resource (again, the % is the placeholder
266	for the filename):
267
268	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
269
270	=back
271		57
272	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
273		59
274	=head2 General API Considerations	60	=head2 General API Considerations
275		61
…		…
289		75
290	=over 4	76	=over 4
291		77
292	=item $text	78	=item $text
293		79
294	Rxvt-unicodes special way of encoding text, where one "unicode" character	80	Rxvt-unicode's special way of encoding text, where one "unicode" character
295	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.
296		82
297	=item $string	83	=item $string
298		84
299	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
…		…
303	=item $octets	89	=item $octets
304		90
305	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
306	locale-specific way.	92	locale-specific way.
307		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
308	=back	100	=back
309		101
310	=head2 Extension Objects	102	=head2 Extension Objects
311		103
312	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
313	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,
314	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
315	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
316	begin with an underscore character C<_>: these are reserved for internal	109	that begin with an underscore character C<_>: these are reserved for
317	use.	110	internal use.
318		111
319	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
320	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
321		114
322	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:
323		124
324	=over 4	125	=over 4
325		126
326	=item $urxvt_term = $self->{term}	127	=item #:META:RESOURCE:name:type:desc
327		128
328	Returns the C<urxvt::term> object associated with this instance of the	129	The RESOURCE comment defines a resource used by the extension, where
329	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>
330		131	or C<string>, and C<desc> is the resource description.
331	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
332
333	Dynamically enable the given hooks (named without the C<on_> prefix) for
334	this extension, replacing any previous hook. This is useful when you want
335	to overwrite time-critical hooks only temporarily.
336
337	=item $self->disable ($hook_name[, $hook_name..])
338
339	Dynamically disable the given hooks.
340		132
341	=back	133	=back
342		134
343	=head2 Hooks	135	=head2 Hooks
344		136
345	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
346	called whenever the relevant event happens.	138	called whenever the relevant event happens.
347		139
348	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
349	the in the C<Extension Objects> section.	141	the in the C<Extension Objects> section.
350		142
351	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
352	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
353	relevant action might not be carried out by the C++ code.	145	relevant action might not be carried out by the C++ code.
…		…
366	place.	158	place.
367		159
368	=item on_start $term	160	=item on_start $term
369		161
370	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
371	trying to map (display) the toplevel and returning to the mainloop.	163	trying to map (display) the toplevel and returning to the main loop.
372		164
373	=item on_destroy $term	165	=item on_destroy $term
374		166
375	Called whenever something tries to destroy terminal, before doing anything	167	Called whenever something tries to destroy terminal, when the terminal is
376	yet. If this hook returns true, then destruction is skipped, but this is	168	still fully functional (not for long, though).
377	rarely a good idea.
378		169
379	=item on_reset $term	170	=item on_reset $term
380		171
381	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
382	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
…		…
404		195
405	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
406	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
407	by calling C<< $term->selection >>.	198	by calling C<< $term->selection >>.
408		199
409	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.
410		201
411	=item on_sel_extend $term	202	=item on_sel_extend $term
412		203
413	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
414	click) and is either supposed to return false (normal operation), or	205	click) and is either supposed to return false (normal operation), or
415	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
416	processing. This can happen multiple times, as long as the callback	207	processing. This can happen multiple times, as long as the callback
417	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
418	supposed to enlarge the selection more and more, if possible.	209	supposed to enlarge the selection more and more, if possible.
419		210
420	See the F<selection> example extension.	211	See the F<selection> example extension.
421		212
422	=item on_view_change $term, $offset	213	=item on_view_change $term, $offset
423		214
424	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
425	scrolls. Offset C<0> means display the normal terminal, positive values	216	scrolls. Offset C<0> means display the normal terminal, positive values
426	show this many lines of scrollback.	217	show this many lines of scrollback.
427		218
428	=item on_scroll_back $term, $lines, $saved	219	=item on_scroll_back $term, $lines, $saved
429		220
…		…
433		224
434	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,
435	$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
436	number of lines that will be in the scrollback buffer.	227	number of lines that will be in the scrollback buffer.
437		228
438	=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
439		240
440	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	241	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
441	operating system command) is processed. Cursor position and other state	242	operating system command) is processed. Cursor position and other state
442	information is up-to-date when this happens. For interoperability, the	243	information is up-to-date when this happens. For interoperability, the
443	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,
444	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
445	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	}
446		257
447	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,
448	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
449	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.
450		264
451	=item on_add_lines $term, $string	265	=item on_add_lines $term, $string
452		266
453	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
454	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
…		…
459	=item on_tt_write $term, $octets	273	=item on_tt_write $term, $octets
460		274
461	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
462	suppress or filter tty input.	276	suppress or filter tty input.
463		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
464	=item on_line_update $term, $row	285	=item on_line_update $term, $row
465		286
466	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
467	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
468	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,
…		…
475	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
476	you cannot just toggle rendition bits, but only set them.	297	you cannot just toggle rendition bits, but only set them.
477		298
478	=item on_refresh_begin $term	299	=item on_refresh_begin $term
479		300
480	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
481	or similar effects by modify terminal contents in refresh_begin, and	302	similar effects by modifying the terminal contents in refresh_begin, and
482	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
483	code is run after this hook, and takes precedence.	304	code is run after this hook, and takes precedence.
484		305
485	=item on_refresh_end $term	306	=item on_refresh_end $term
486		307
487	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>.
488		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
489	=item on_keyboard_command $term, $string	318	=item on_user_command $term, $string *DEPRECATED*
490		319
491	Called whenever the user presses a key combination that has a	320	Called whenever a user-configured event is being activated (e.g. via
492	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>
493	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.
494		332
495	=item on_x_event $term, $event	333	=item on_x_event $term, $event
496		334
497	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
498	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
499	members are not passed.	337	members are not passed.
500		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
501	=item on_focus_in $term	343	=item on_focus_in $term
502		344
503	Called whenever the window gets the keyboard focus, before rxvt-unicode	345	Called whenever the window gets the keyboard focus, before rxvt-unicode
504	does focus in processing.	346	does focus in processing.
505		347
506	=item on_focus_out $term	348	=item on_focus_out $term
507		349
508	Called wheneever the window loses keyboard focus, before rxvt-unicode does	350	Called whenever the window loses keyboard focus, before rxvt-unicode does
509	focus out processing.	351	focus out processing.
510		352
511	=item on_configure_notify $term, $event	353	=item on_configure_notify $term, $event
512		354
513	=item on_property_notify $term, $event	355	=item on_property_notify $term, $event
…		…
524		366
525	=item on_map_notify $term, $event	367	=item on_map_notify $term, $event
526		368
527	=item on_unmap_notify $term, $event	369	=item on_unmap_notify $term, $event
528		370
529	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
530	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.
531		373
532	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
533	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
534	(real, not screen-based) row and column under the mouse cursor.	376	(real, not screen-based) row and column under the mouse cursor.
535		377
536	C<on_key_press> additionally receives the string rxvt-unicode would	378	C<on_key_press> additionally receives the string rxvt-unicode would
537	output, if any, in locale-specific encoding.	379	output, if any, in locale-specific encoding.
538		380
539	subwindow.
540
541	=item on_client_message $term, $event	381	=item on_client_message $term, $event
542		382
543	=item on_wm_protocols $term, $event	383	=item on_wm_protocols $term, $event
544		384
545	=item on_wm_delete_window $term, $event	385	=item on_wm_delete_window $term, $event
546		386
547	Called when various types of ClientMessage events are received (all with	387	Called when various types of ClientMessage events are received (all with
548	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	388	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
549		389
		390	=item on_bell $term
		391
		392	Called on receipt of a bell character.
		393
550	=back	394	=back
551		395
552	=cut	396	=cut
553		397
554	package urxvt;	398	package urxvt;
555		399
556	use utf8;	400	use utf8;
557	use strict;	401	use strict 'vars';
558	use Carp ();	402	use Carp ();
559	use Scalar::Util ();	403	use Scalar::Util ();
560	use List::Util ();	404	use List::Util ();
561		405
562	our $VERSION = 1;	406	our $VERSION = 1;
563	our $TERM;	407	our $TERM;
564	our @TERM_INIT;	408	our @TERM_INIT; # should go, prevents async I/O etc.
565	our @TERM_EXT;	409	our @TERM_EXT; # should go, prevents async I/O etc.
566	our @HOOKNAME;	410	our @HOOKNAME;
567	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	411	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
568	our %OPTION;	412	our %OPTION;
569		413
570	our $LIBDIR;	414	our $LIBDIR;
…		…
596	The current terminal. This variable stores the current C<urxvt::term>	440	The current terminal. This variable stores the current C<urxvt::term>
597	object, whenever a callback/hook is executing.	441	object, whenever a callback/hook is executing.
598		442
599	=item @urxvt::TERM_INIT	443	=item @urxvt::TERM_INIT
600		444
601	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
602	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
603	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,
604	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.
605		449
606	This complements to the perl-eval commandline option, but gets executed	450	This complements to the perl-eval command line option, but gets executed
607	first.	451	first.
608		452
609	=item @urxvt::TERM_EXT	453	=item @urxvt::TERM_EXT
610		454
611	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
…		…
618		462
619	=over 4	463	=over 4
620		464
621	=item urxvt::fatal $errormessage	465	=item urxvt::fatal $errormessage
622		466
623	Fatally aborts execution with the given error message. Avoid at all	467	Fatally aborts execution with the given error message (which should
624	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
625	starts up.	469	is acceptable (and useful) is in the init hook, where it prevents the
		470	terminal from starting up.
626		471
627	=item urxvt::warn $string	472	=item urxvt::warn $string
628		473
629	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
630	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
631	that calls this function.	476	that calls this function.
632		477
633	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
634	correct place, e.g. on stderr of the connecting urxvtc client.	479	correct place, e.g. on stderr of the connecting urxvtc client.
635		480
636	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).
637		489
638	=item $time = urxvt::NOW	490	=item $time = urxvt::NOW
639		491
640	Returns the "current time" (as per the event loop).	492	Returns the "current time" (as per the event loop).
641		493
…		…
684		536
685	=item $rend = urxvt::OVERLAY_RSTYLE	537	=item $rend = urxvt::OVERLAY_RSTYLE
686		538
687	Return the rendition mask used for overlays by default.	539	Return the rendition mask used for overlays by default.
688		540
689	=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
690		543
691	Return the bit that enabled bold, italic, blink, reverse-video and	544	Return the bit that enabled bold, italic, blink, reverse-video and
692	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
693	the bitset.	546	the bitset.
694		547
…		…
699	Return the foreground/background colour index, respectively.	552	Return the foreground/background colour index, respectively.
700		553
701	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	554	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
702		555
703	=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
704		559
705	Replace the foreground/background colour in the rendition mask with the	560	Replace the foreground/background colour in the rendition mask with the
706	specified one.	561	specified one.
707		562
708	=item $value = urxvt::GET_CUSTOM $rend	563	=item $value = urxvt::GET_CUSTOM $rend
…		…
729	};	584	};
730	}	585	}
731		586
732	no warnings 'utf8';	587	no warnings 'utf8';
733		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
734	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
735		652
736	sub verbose {	653	sub verbose {
737	my ($level, $msg) = @_;	654	my ($level, $msg) = @_;
738	warn "$msg\n" if $level <= $verbosity;	655	warn "$msg\n" if $level <= $verbosity;
…		…
750	$pkg =~ s/[^[:word:]]/_/g;	667	$pkg =~ s/[^[:word:]]/_/g;
751	$pkg = "urxvt::ext::$pkg";	668	$pkg = "urxvt::ext::$pkg";
752		669
753	verbose 3, "loading extension '$path' into package '$pkg'";	670	verbose 3, "loading extension '$path' into package '$pkg'";
754		671
		672	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		673
755	open my $fh, "<:raw", $path	674	open my $fh, "<:raw", $path
756	or die "$path: $!";	675	or die "$path: $!";
757		676
758	my $source =	677	my $source =
759	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	678	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
760	. "#line 1 \"$path\"\n{\n"	679	. "#line 1 \"$path\"\n{\n"
761	. (do { local $/; <$fh> })	680	. (do { local $/; <$fh> })
762	. "\n};\n1";	681	. "\n};\n1";
763		682
764	eval $source	683	eval $source
…		…
773	# called by the rxvt core	692	# called by the rxvt core
774	sub invoke {	693	sub invoke {
775	local $TERM = shift;	694	local $TERM = shift;
776	my $htype = shift;	695	my $htype = shift;
777		696
778	if ($htype == 0) { # INIT	697	if ($htype == HOOK_INIT) {
779	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	698	my @dirs = $TERM->perl_libdirs;
780		699
		700	$TERM->scan_extensions;
		701
781	my %ext_arg;	702	my %ext_arg;
782		703
783	{	704	{
784	my @init = @TERM_INIT;	705	my @init = @TERM_INIT;
785	@TERM_INIT = ();	706	@TERM_INIT = ();
…		…
787	my @pkg = @TERM_EXT;	708	my @pkg = @TERM_EXT;
788	@TERM_EXT = ();	709	@TERM_EXT = ();
789	$TERM->register_package ($_) for @pkg;	710	$TERM->register_package ($_) for @pkg;
790	}	711	}
791		712
		713	for (
792	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	) {
793	if ($_ eq "default") {	717	if ($_ eq "default") {
		718
		719	$ext_arg{$_} = []
794	$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
795	} elsif (/^-(.*)$/) {	731	} elsif (/^-(.*)$/) {
796	delete $ext_arg{$1};	732	delete $ext_arg{$1};
		733
797	} elsif (/^([^<]+)<(.*)>$/) {	734	} elsif (/^([^<]+)<(.*)>$/) {
798	push @{ $ext_arg{$1} }, $2;	735	push @{ $ext_arg{$1} }, $2;
		736
799	} else {	737	} else {
800	$ext_arg{$_} ||= [];	738	$ext_arg{$_} ||= [];
801	}	739	}
802	}	740	}
803		741
804	while (my ($ext, $argv) = each %ext_arg) {	742	for my $ext (sort keys %ext_arg) {
805	my @files = grep -f $_, map "$_/$ext", @dirs;	743	my @files = grep -f $_, map "$_/$ext", @dirs;
806		744
807	if (@files) {	745	if (@files) {
808	$TERM->register_package (extension_package $files[0], $argv);	746	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
809	} else {	747	} else {
810	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";
811	}	749	}
812	}	750	}
813		751
…		…
819		757
820	if (my $cb = $TERM->{_hook}[$htype]) {	758	if (my $cb = $TERM->{_hook}[$htype]) {
821	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	759	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
822	if $verbosity >= 10;	760	if $verbosity >= 10;
823		761
824	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";
825		768
826	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) {
827	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	776	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
828	$retval ||= $retval_;	777	$retval ||= $retval_;
829		778
830	if ($@) {	779	if ($@) {
831	$TERM->ungrab; # better to lose the grab than the session	780	$TERM->ungrab; # better to lose the grab than the session
832	warn $@;	781	warn $@;
…		…
835		784
836	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	785	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
837	if $verbosity >= 11;	786	if $verbosity >= 11;
838	}	787	}
839		788
840	if ($htype == 1) { # DESTROY	789	if ($htype == HOOK_DESTROY) {
841	# clear package objects	790	# clear package objects
842	%$_ = () for values %{ $TERM->{_pkg} };	791	%$_ = () for values %{ $TERM->{_pkg} };
843		792
844	# clear package	793	# clear package
845	%$TERM = ();	794	%$TERM = ();
846	}	795	}
847		796
848	$retval	797	$retval
849	}	798	}
850		799
851	# 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	}
852		828
853	package urxvt::term::extension;	829	package urxvt::term::extension;
854		830
855	sub enable {	831	=head2 The C<urxvt::term::extension> class
856	my ($self, %hook) = @_;
857	my $pkg = $self->{_pkg};
858		832
859	while (my ($name, $cb) = each %hook) {	833	Each extension attached to a terminal object is represented by
860	my $htype = $HOOKTYPE{uc $name};	834	a C<urxvt::term::extension> object.
861	defined $htype
862	or Carp::croak "unsupported hook type '$name'";
863		835
864	$self->set_should_invoke ($htype, +1)	836	You can use these objects, which are passed to all callbacks to store any
865	unless exists $self->{term}{_hook}[$htype]{$pkg};	837	state related to the terminal and extension instance.
866		838
867	$self->{term}{_hook}[$htype]{$pkg} = $cb;	839	The methods (And data members) documented below can be called on extension
868	}	840	objects, in addition to call methods documented for the <urxvt::term>
869	}	841	class.
870		842
871	sub disable {	843	=over 4
872	my ($self, @hook) = @_;
873	my $pkg = $self->{_pkg};
874		844
875	for my $name (@hook) {	845	=item $urxvt_term = $self->{term}
876	my $htype = $HOOKTYPE{uc $name};
877	defined $htype
878	or Carp::croak "unsupported hook type '$name'";
879		846
880	$self->set_should_invoke ($htype, -1)	847	Returns the C<urxvt::term> object associated with this instance of the
881	if delete $self->{term}{_hook}[$htype]{$pkg};	848	extension. This member I<must not> be changed in any way.
882	}	849
883	}	850	=cut
884		851
885	our $AUTOLOAD;	852	our $AUTOLOAD;
886		853
887	sub AUTOLOAD {	854	sub AUTOLOAD {
888	$AUTOLOAD =~ /:([^:]+)$/	855	$AUTOLOAD =~ /:([^:]+)$/
…		…
901		868
902	sub DESTROY {	869	sub DESTROY {
903	# nop	870	# nop
904	}	871	}
905		872
906	# urxvt::destroy_hook	873	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
907		874
908	sub urxvt::destroy_hook::DESTROY {	875	sub urxvt::destroy_hook::DESTROY {
909	${$_[0]}->();	876	${$_[0]}->();
910	}	877	}
911		878
912	sub urxvt::destroy_hook(&) {	879	sub urxvt::destroy_hook(&) {
913	bless \shift, urxvt::destroy_hook::	880	bless \shift, urxvt::destroy_hook::
914	}	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
915		1005
916	package urxvt::anyevent;	1006	package urxvt::anyevent;
917		1007
918	=head2 The C<urxvt::anyevent> Class	1008	=head2 The C<urxvt::anyevent> Class
919		1009
920	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
921	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
922	further programming. The only exception is that you cannot wait on	1012	further programming. The only exception is that you cannot wait on
923	condition variables, but non-blocking condvar use is ok. What this means	1013	condition variables, but non-blocking condvar use is ok.
924	is that you cannot use blocking APIs, but the non-blocking variant should
925	work.
926		1014
927	=cut	1015	In practical terms this means is that you cannot use blocking APIs, but
		1016	the non-blocking variant should work.
928		1017
		1018	=cut
		1019
929	our $VERSION = 1;	1020	our $VERSION = '5.23';
930		1021
931	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1022	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
932	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1023	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
933		1024
934	sub timer {	1025	sub timer {
…		…
936		1027
937	my $cb = $arg{cb};	1028	my $cb = $arg{cb};
938		1029
939	urxvt::timer	1030	urxvt::timer
940	->new	1031	->new
941	->start (urxvt::NOW + $arg{after})	1032	->after ($arg{after}, $arg{interval})
942	->cb (sub {	1033	->cb ($arg{interval} ? $cb : sub {
943	$_[0]->stop; # need to cancel manually	1034	$_[0]->stop; # need to cancel manually
944	$cb->();	1035	$cb->();
945	})	1036	})
946	}	1037	}
947		1038
948	sub io {	1039	sub io {
949	my ($class, %arg) = @_;	1040	my ($class, %arg) = @_;
950		1041
951	my $cb = $arg{cb};	1042	my $cb = $arg{cb};
		1043	my $fd = fileno $arg{fh};
		1044	defined $fd or $fd = $arg{fh};
952		1045
953	bless [$arg{fh}, urxvt::iow	1046	bless [$arg{fh}, urxvt::iow
954	->new	1047	->new
955	->fd (fileno $arg{fh})	1048	->fd ($fd)
956	->events (($arg{poll} =~ /r/ ? 1 : 0)	1049	->events (($arg{poll} =~ /r/ ? 1 : 0)
957	| ($arg{poll} =~ /w/ ? 2 : 0))	1050	| ($arg{poll} =~ /w/ ? 2 : 0))
958	->start	1051	->start
959	->cb (sub {	1052	->cb ($cb)
960	$cb->(($_[1] & 1 ? 'r' : '')
961	. ($_[1] & 2 ? 'w' : ''));
962	})],
963	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	})
964	}	1079	}
965		1080
966	sub DESTROY {	1081	sub DESTROY {
967	$_[0][1]->stop;	1082	$_[0][1]->stop;
968	}	1083	}
969		1084
970	sub condvar {	1085	# only needed for AnyEvent < 6 compatibility
971	bless \my $flag, urxvt::anyevent::condvar::	1086	sub one_event {
972	}
973
974	sub urxvt::anyevent::condvar::broadcast {
975	${$_[0]}++;
976	}
977
978	sub urxvt::anyevent::condvar::wait {
979	unless (${$_[0]}) {
980	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";
981	}
982	}	1088	}
983		1089
984	package urxvt::term;	1090	package urxvt::term;
985		1091
986	=head2 The C<urxvt::term> Class	1092	=head2 The C<urxvt::term> Class
…		…
999	urxvt::verbose 6, "register package $pkg to $self";	1105	urxvt::verbose 6, "register package $pkg to $self";
1000		1106
1001	@{"$pkg\::ISA"} = urxvt::term::extension::;	1107	@{"$pkg\::ISA"} = urxvt::term::extension::;
1002		1108
1003	my $proxy = bless {	1109	my $proxy = bless {
1004	_pkg => $pkg,	1110	_pkg => $pkg,
		1111	_name => ${"$pkg\::_NAME"}, # hackish
1005	argv => $argv,	1112	argv => $argv,
1006	}, $pkg;	1113	}, $pkg;
1007	Scalar::Util::weaken ($proxy->{term} = $self);	1114	Scalar::Util::weaken ($proxy->{term} = $self);
1008		1115
1009	$self->{_pkg}{$pkg} = $proxy;	1116	$self->{_pkg}{$pkg} = $proxy;
1010		1117
…		…
1013	$proxy->enable ($name => $ref);	1120	$proxy->enable ($name => $ref);
1014	}	1121	}
1015	}	1122	}
1016	}	1123	}
1017		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 @libdirs = perl_libdirs $self;
		1140
		1141	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1142
		1143	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1144	$self->{meta} = \my %meta;
		1145
		1146	# first gather extensions
		1147	for my $dir (reverse @libdirs) {
		1148	opendir my $fh, $dir
		1149	or next;
		1150	for my $ext (readdir $fh) {
		1151	$ext !~ /^\./
		1152	and open my $fh, "<", "$dir/$ext"
		1153	or next;
		1154
		1155	my %ext = (dir => $dir);
		1156
		1157	while (<$fh>) {
		1158	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1159	my ($pattern, $type, $desc) = split /:/, $1;
		1160	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1161	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1162	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1163	} else {
		1164	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1165	}
		1166	} elsif (/^\s*(?:#|$)/) {
		1167	# skip other comments and empty lines
		1168	} else {
		1169	last; # stop parsing on first non-empty non-comment line
		1170	}
		1171	}
		1172
		1173	$meta{ext}{$ext} = \%ext;
		1174	}
		1175	}
		1176
		1177	# and now merge resources
		1178	while (my ($k, $v) = each %{ $meta{ext} }) {
		1179	#TODO: should check for extensions overriding each other
		1180	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1181	}
		1182	}
		1183
1018	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1184	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1019		1185
1020	Creates a new terminal, very similar as if you had started it with system	1186	Creates a new terminal, very similar as if you had started it with system
1021	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1187	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1022	hash which defines the environment of the new terminal.	1188	hash which defines the environment of the new terminal.
1023		1189
1024	Croaks (and probably outputs an error message) if the new instance	1190	Croaks (and probably outputs an error message) if the new instance
1025	couldn't be created. Returns C<undef> if the new instance didn't	1191	couldn't be created. Returns C<undef> if the new instance didn't
1026	initialise perl, and the terminal object otherwise. The C<init> and	1192	initialise perl, and the terminal object otherwise. The C<init> and
1027	C<start> hooks will be called during this call.	1193	C<start> hooks will be called before this call returns, and are free to
		1194	refer to global data (which is race free).
1028		1195
1029	=cut	1196	=cut
1030		1197
1031	sub new {	1198	sub new {
1032	my ($class, $env, @args) = @_;	1199	my ($class, $env, @args) = @_;
1033		1200
		1201	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1202	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1203
1034	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1204	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1035	}	1205	}
1036		1206
1037	=item $term->destroy	1207	=item $term->destroy
1038		1208
1039	Destroy the terminal object (close the window, free resources	1209	Destroy the terminal object (close the window, free resources
1040	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1210	etc.). Please note that urxvt will not exit as long as any event
1041	watchers (timers, io watchers) are still active.	1211	watchers (timers, io watchers) are still active.
1042		1212
1043	=item $term->exec_async ($cmd[, @args])	1213	=item $term->exec_async ($cmd[, @args])
1044		1214
1045	Works like the combination of the C<fork>/C<exec> builtins, which executes	1215	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1069		1239
1070	Returns true if the option specified by C<$optval> is enabled, and	1240	Returns true if the option specified by C<$optval> is enabled, and
1071	optionally change it. All option values are stored by name in the hash	1241	optionally change it. All option values are stored by name in the hash
1072	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1242	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1073		1243
1074	Here is a a likely non-exhaustive list of option names, please see the	1244	Here is a likely non-exhaustive list of option names, please see the
1075	source file F</src/optinc.h> to see the actual list:	1245	source file F</src/optinc.h> to see the actual list:
1076		1246
1077	borderLess console cursorBlink cursorUnderline hold iconic insecure	1247	borderLess buffered console cursorBlink cursorUnderline hold iconic
1078	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1248	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1079	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1249	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1080	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1250	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1081	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1251	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1082	transparent tripleclickwords utmpInhibit visualBell	1252	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1253	urgentOnBell utmpInhibit visualBell
1083		1254
1084	=item $value = $term->resource ($name[, $newval])	1255	=item $value = $term->resource ($name[, $newval])
1085		1256
1086	Returns the current resource value associated with a given name and	1257	Returns the current resource value associated with a given name and
1087	optionally sets a new value. Setting values is most useful in the C<init>	1258	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1096	likely change).	1267	likely change).
1097		1268
1098	Please note that resource strings will currently only be freed when the	1269	Please note that resource strings will currently only be freed when the
1099	terminal is destroyed, so changing options frequently will eat memory.	1270	terminal is destroyed, so changing options frequently will eat memory.
1100		1271
1101	Here is a a likely non-exhaustive list of resource names, not all of which	1272	Here is a likely non-exhaustive list of resource names, not all of which
1102	are supported in every build, please see the source file F</src/rsinc.h>	1273	are supported in every build, please see the source file F</src/rsinc.h>
1103	to see the actual list:	1274	to see the actual list:
1104		1275
1105	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1276	answerbackstring backgroundPixmap backspace_key blurradius
1106	borderLess color cursorBlink cursorUnderline cutchars delete_key	1277	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1107	display_name embed ext_bwidth fade font geometry hold iconName	1278	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1108	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1279	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1280	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1109	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1281	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1110	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1282	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1111	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1283	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1112	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1284	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1113	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1285	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1114	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1286	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1115	secondaryScreen secondaryScroll selectstyle shade term_name title	1287	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1116	transient_for transparent transparent_all tripleclickwords utmpInhibit	1288	term_name title transient_for transparent tripleclickwords urgentOnBell
1117	visualBell	1289	utmpInhibit visualBell
1118		1290
1119	=cut	1291	=cut
1120		1292
1121	sub resource($$;$) {	1293	sub resource($$;$) {
1122	my ($self, $name) = (shift, shift);	1294	my ($self, $name) = (shift, shift);
1123	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1295	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1124	&urxvt::term::_resource	1296	goto &urxvt::term::_resource
1125	}	1297	}
1126		1298
1127	=item $value = $term->x_resource ($pattern)	1299	=item $value = $term->x_resource ($pattern)
1128		1300
1129	Returns the X-Resource for the given pattern, excluding the program or	1301	Returns the X-Resource for the given pattern, excluding the program or
1130	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1302	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1131	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1303	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1132	resource with that pattern exists.	1304	resource with that pattern exists.
1133		1305
		1306	Extensions that define extra resources also need to call this method
		1307	to access their values.
		1308
		1309	If the method is called on an extension object (basically, from an
		1310	extension), then the special prefix C<%.> will be replaced by the name of
		1311	the extension and a dot, and the lone string C<%> will be replaced by the
		1312	extension name itself. This makes it possible to code extensions so you
		1313	can rename them and get a new set of resources without having to change
		1314	the actual code.
		1315
1134	This method should only be called during the C<on_start> hook, as there is	1316	This method should only be called during the C<on_start> hook, as there is
1135	only one resource database per display, and later invocations might return	1317	only one resource database per display, and later invocations might return
1136	the wrong resources.	1318	the wrong resources.
1137		1319
1138	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1320	=item $value = $term->x_resource_boolean ($pattern)
1139		1321
		1322	Like C<x_resource>, above, but interprets the string value as a boolean
		1323	and returns C<1> for true values, C<0> for false values and C<undef> if
		1324	the resource or option isn't specified.
		1325
		1326	You should always use this method to parse boolean resources.
		1327
		1328	=cut
		1329
		1330	sub x_resource_boolean {
		1331	my $res = &x_resource;
		1332
		1333	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1334	}
		1335
		1336	=item $success = $term->bind_action ($key, $action)
		1337
1140	Adds a keymap translation exactly as specified via a resource. See the	1338	Adds a key binding exactly as specified via a C<keysym> resource. See the
1141	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1339	C<keysym> resource in the urxvt(1) manpage.
		1340
		1341	To add default bindings for an extension, the extension should call C<<
		1342	->bind_action >> on it's C<init> hook for every such binding. Doing it
		1343	in the C<init> hook allows users the override or remove the the binding
		1344	again.
		1345
		1346	Example: the C<searchable-scrollback> by default binds itself
		1347	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1348	$term->bind_action >>.
		1349
		1350	sub init {
		1351	my ($self) = @_;
		1352
		1353	$self->bind_action ("M-s" => "%:start");
		1354	}
1142		1355
1143	=item $rend = $term->rstyle ([$new_rstyle])	1356	=item $rend = $term->rstyle ([$new_rstyle])
1144		1357
1145	Return and optionally change the current rendition. Text that is output by	1358	Return and optionally change the current rendition. Text that is output by
1146	the terminal application will use this style.	1359	the terminal application will use this style.
…		…
1154		1367
1155	=item ($row, $col) = $term->selection_beg ([$row, $col])	1368	=item ($row, $col) = $term->selection_beg ([$row, $col])
1156		1369
1157	=item ($row, $col) = $term->selection_end ([$row, $col])	1370	=item ($row, $col) = $term->selection_end ([$row, $col])
1158		1371
1159	Return the current values of the selection mark, begin or end positions,	1372	Return the current values of the selection mark, begin or end positions.
1160	and optionally set them to new values.	1373
		1374	When arguments are given, then the selection coordinates are set to
		1375	C<$row> and C<$col>, and the selection screen is set to the current
		1376	screen.
		1377
		1378	=item $screen = $term->selection_screen ([$screen])
		1379
		1380	Returns the current selection screen, and then optionally sets it.
1161		1381
1162	=item $term->selection_make ($eventtime[, $rectangular])	1382	=item $term->selection_make ($eventtime[, $rectangular])
1163		1383
1164	Tries to make a selection as set by C<selection_beg> and	1384	Tries to make a selection as set by C<selection_beg> and
1165	C<selection_end>. If C<$rectangular> is true (default: false), a	1385	C<selection_end>. If C<$rectangular> is true (default: false), a
1166	rectangular selection will be made. This is the prefered function to make	1386	rectangular selection will be made. This is the preferred function to make
1167	a selection.	1387	a selection.
1168		1388
1169	=item $success = $term->selection_grab ($eventtime)	1389	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1170		1390
1171	Try to request the primary selection text from the server (for example, as	1391	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1392	true) selection from the server. The corresponding text can be set
1172	set by the next method). No visual feedback will be given. This function	1393	with the next method. No visual feedback will be given. This function
1173	is mostly useful from within C<on_sel_grab> hooks.	1394	is mostly useful from within C<on_sel_grab> hooks.
1174		1395
1175	=item $oldtext = $term->selection ([$newtext])	1396	=item $oldtext = $term->selection ([$newtext, $clipboard])
1176		1397
1177	Return the current selection text and optionally replace it by C<$newtext>.	1398	Return the current selection (clipboard if C<$clipboard> is true) text
		1399	and optionally replace it by C<$newtext>.
		1400
		1401	=item $term->selection_clear ([$clipboard])
		1402
		1403	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1178		1404
1179	=item $term->overlay_simple ($x, $y, $text)	1405	=item $term->overlay_simple ($x, $y, $text)
1180		1406
1181	Create a simple multi-line overlay box. See the next method for details.	1407	Create a simple multi-line overlay box. See the next method for details.
1182		1408
…		…
1212		1438
1213	The methods currently supported on C<urxvt::overlay> objects are:	1439	The methods currently supported on C<urxvt::overlay> objects are:
1214		1440
1215	=over 4	1441	=over 4
1216		1442
1217	=item $overlay->set ($x, $y, $text, $rend)	1443	=item $overlay->set ($x, $y, $text[, $rend])
1218		1444
1219	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1445	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1220	text in rxvt-unicode's special encoding and an array of rendition values	1446	text in rxvt-unicode's special encoding and an array of rendition values
1221	at a specific position inside the overlay.	1447	at a specific position inside the overlay.
		1448
		1449	If C<$rend> is missing, then the rendition will not be changed.
1222		1450
1223	=item $overlay->hide	1451	=item $overlay->hide
1224		1452
1225	If visible, hide the overlay, but do not destroy it.	1453	If visible, hide the overlay, but do not destroy it.
1226		1454
…		…
1289		1517
1290	=item $term->scr_add_lines ($string)	1518	=item $term->scr_add_lines ($string)
1291		1519
1292	Write the given text string to the screen, as if output by the application	1520	Write the given text string to the screen, as if output by the application
1293	running inside the terminal. It may not contain command sequences (escape	1521	running inside the terminal. It may not contain command sequences (escape
1294	codes), but is free to use line feeds, carriage returns and tabs. The	1522	codes - see C<cmd_parse> for that), but is free to use line feeds,
1295	string is a normal text string, not in locale-dependent encoding.	1523	carriage returns and tabs. The string is a normal text string, not in
		1524	locale-dependent encoding.
1296		1525
1297	Normally its not a good idea to use this function, as programs might be	1526	Normally its not a good idea to use this function, as programs might be
1298	confused by changes in cursor position or scrolling. Its useful inside a	1527	confused by changes in cursor position or scrolling. Its useful inside a
1299	C<on_add_lines> hook, though.	1528	C<on_add_lines> hook, though.
1300		1529
…		…
1308	locale-specific encoding of the terminal and can contain command sequences	1537	locale-specific encoding of the terminal and can contain command sequences
1309	(escape codes) that will be interpreted.	1538	(escape codes) that will be interpreted.
1310		1539
1311	=item $term->tt_write ($octets)	1540	=item $term->tt_write ($octets)
1312		1541
1313	Write the octets given in C<$data> to the tty (i.e. as program input). To	1542	Write the octets given in C<$octets> to the tty (i.e. as user input
		1543	to the program, see C<cmd_parse> for the opposite direction). To pass
1314	pass characters instead of octets, you should convert your strings first	1544	characters instead of octets, you should convert your strings first to the
1315	to the locale-specific encoding using C<< $term->locale_encode >>.	1545	locale-specific encoding using C<< $term->locale_encode >>.
		1546
		1547	=item $term->tt_write_user_input ($octets)
		1548
		1549	Like C<tt_write>, but should be used when writing strings in response to
		1550	the user pressing a key, to invoke the additional actions requested by
		1551	the user for that case (C<tt_write> doesn't do that).
		1552
		1553	The typical use case would be inside C<on_action> hooks.
		1554
		1555	=item $term->tt_paste ($octets)
		1556
		1557	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1558	CR and bracketing the data with control sequences if bracketed paste mode
		1559	is set.
1316		1560
1317	=item $old_events = $term->pty_ev_events ([$new_events])	1561	=item $old_events = $term->pty_ev_events ([$new_events])
1318		1562
1319	Replaces the event mask of the pty watcher by the given event mask. Can	1563	Replaces the event mask of the pty watcher by the given event mask. Can
1320	be used to suppress input and output handling to the pty/tty. See the	1564	be used to suppress input and output handling to the pty/tty. See the
…		…
1339	Adds the specified events to the vt event mask. Useful e.g. when you want	1583	Adds the specified events to the vt event mask. Useful e.g. when you want
1340	to receive pointer events all the times:	1584	to receive pointer events all the times:
1341		1585
1342	$term->vt_emask_add (urxvt::PointerMotionMask);	1586	$term->vt_emask_add (urxvt::PointerMotionMask);
1343		1587
		1588	=item $term->set_urgency ($set)
		1589
		1590	Enable/disable the urgency hint on the toplevel window.
		1591
		1592	=item $term->focus_in
		1593
		1594	=item $term->focus_out
		1595
		1596	=item $term->key_press ($state, $keycode[, $time])
		1597
		1598	=item $term->key_release ($state, $keycode[, $time])
		1599
		1600	Deliver various fake events to to terminal.
		1601
1344	=item $window_width = $term->width	1602	=item $window_width = $term->width
1345		1603
1346	=item $window_height = $term->height	1604	=item $window_height = $term->height
1347		1605
1348	=item $font_width = $term->fwidth	1606	=item $font_width = $term->fwidth
…		…
1378	=item $env = $term->env	1636	=item $env = $term->env
1379		1637
1380	Returns a copy of the environment in effect for the terminal as a hashref	1638	Returns a copy of the environment in effect for the terminal as a hashref
1381	similar to C<\%ENV>.	1639	similar to C<\%ENV>.
1382		1640
		1641	=item @envv = $term->envv
		1642
		1643	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1644
		1645	=item @argv = $term->argv
		1646
		1647	Return the argument vector as this terminal, similar to @ARGV, but
		1648	includes the program name as first element.
		1649
1383	=cut	1650	=cut
1384		1651
1385	sub env {	1652	sub env {
1386	if (my $env = $_[0]->_env) {
1387	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1653	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1388	} else {
1389	+{ %ENV }
1390	}
1391	}	1654	}
1392		1655
1393	=item $modifiermask = $term->ModLevel3Mask	1656	=item $modifiermask = $term->ModLevel3Mask
1394		1657
1395	=item $modifiermask = $term->ModMetaMask	1658	=item $modifiermask = $term->ModMetaMask
…		…
1403		1666
1404	Returns the currently displayed screen (0 primary, 1 secondary).	1667	Returns the currently displayed screen (0 primary, 1 secondary).
1405		1668
1406	=item $cursor_is_hidden = $term->hidden_cursor	1669	=item $cursor_is_hidden = $term->hidden_cursor
1407		1670
1408	Returns wether the cursor is currently hidden or not.	1671	Returns whether the cursor is currently hidden or not.
1409		1672
1410	=item $view_start = $term->view_start ([$newvalue])	1673	=item $view_start = $term->view_start ([$newvalue])
1411		1674
1412	Returns the row number of the topmost displayed line. Maximum value is	1675	Returns the row number of the topmost displayed line. Maximum value is
1413	C<0>, which displays the normal terminal contents. Lower values scroll	1676	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1421		1684
1422	Used after changing terminal contents to display them.	1685	Used after changing terminal contents to display them.
1423		1686
1424	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1687	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1425		1688
1426	Returns the text of the entire row with number C<$row_number>. Row C<0>	1689	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1427	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1690	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1428	terminal line. The scrollback buffer starts at line C<-1> and extends to
1429	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1691	terminal line. Nothing will be returned if a nonexistent line
1430	is requested.	1692	is requested.
1431		1693
1432	If C<$new_text> is specified, it will replace characters in the current	1694	If C<$new_text> is specified, it will replace characters in the current
1433	line, starting at column C<$start_col> (default C<0>), which is useful	1695	line, starting at column C<$start_col> (default C<0>), which is useful
1434	to replace only parts of a line. The font index in the rendition will	1696	to replace only parts of a line. The font index in the rendition will
1435	automatically be updated.	1697	automatically be updated.
1436		1698
1437	C<$text> is in a special encoding: tabs and wide characters that use more	1699	C<$text> is in a special encoding: tabs and wide characters that use more
1438	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1700	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1439	characters. Characters with combining characters and other characters that	1701	characters. Characters with combining characters and other characters that
1440	do not fit into the normal tetx encoding will be replaced with characters	1702	do not fit into the normal text encoding will be replaced with characters
1441	in the private use area.	1703	in the private use area.
1442		1704
1443	You have to obey this encoding when changing text. The advantage is	1705	You have to obey this encoding when changing text. The advantage is
1444	that C<substr> and similar functions work on screen cells and not on	1706	that C<substr> and similar functions work on screen cells and not on
1445	characters.	1707	characters.
…		…
1530	}	1792	}
1531		1793
1532	sub urxvt::line::t {	1794	sub urxvt::line::t {
1533	my ($self) = @_;	1795	my ($self) = @_;
1534		1796
1535	if (@_ > 1)	1797	if (@_ > 1) {
1536	{
1537	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1798	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1538	for $self->{beg} .. $self->{end};	1799	for $self->{beg} .. $self->{end};
1539	}	1800	}
1540		1801
1541	defined wantarray &&	1802	defined wantarray &&
1542	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1803	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1543	0, $self->{len}	1804	0, $self->{len}
1544	}	1805	}
1545		1806
1546	sub urxvt::line::r {	1807	sub urxvt::line::r {
1547	my ($self) = @_;	1808	my ($self) = @_;
1548		1809
1549	if (@_ > 1)	1810	if (@_ > 1) {
1550	{
1551	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1811	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1552	for $self->{beg} .. $self->{end};	1812	for $self->{beg} .. $self->{end};
1553	}	1813	}
1554		1814
1555	if (defined wantarray) {	1815	if (defined wantarray) {
1556	my $rend = [	1816	my $rend = [
1557	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1817	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1558	];	1818	];
…		…
1590	where one character corresponds to one screen cell. See	1850	where one character corresponds to one screen cell. See
1591	C<< $term->ROW_t >> for details.	1851	C<< $term->ROW_t >> for details.
1592		1852
1593	=item $string = $term->special_decode $text	1853	=item $string = $term->special_decode $text
1594		1854
1595	Converts rxvt-unicodes text reprsentation into a perl string. See	1855	Converts rxvt-unicodes text representation into a perl string. See
1596	C<< $term->ROW_t >> for details.	1856	C<< $term->ROW_t >> for details.
1597		1857
1598	=item $success = $term->grab_button ($button, $modifiermask)	1858	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1599		1859
		1860	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1861
1600	Registers a synchronous button grab. See the XGrabButton manpage.	1862	Register/unregister a synchronous button grab. See the XGrabButton
		1863	manpage.
1601		1864
1602	=item $success = $term->grab ($eventtime[, $sync])	1865	=item $success = $term->grab ($eventtime[, $sync])
1603		1866
1604	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1867	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1605	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1868	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1606		1869
1607	=item $term->allow_events_async	1870	=item $term->allow_events_async
1608		1871
1609	Calls XAllowEvents with AsyncBoth for the most recent grab.	1872	Calls XAllowEvents with AsyncBoth for the most recent grab.
1610		1873
…		…
1617	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1880	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1618	recent grab.	1881	recent grab.
1619		1882
1620	=item $term->ungrab	1883	=item $term->ungrab
1621		1884
1622	Calls XUngrab for the most recent grab. Is called automatically on	1885	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1623	evaluation errors, as it is better to lose the grab in the error case as	1886	evaluation errors, as it is better to lose the grab in the error case as
1624	the session.	1887	the session.
1625		1888
1626	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1889	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1627		1890
…		…
1629		1892
1630	=item @atoms = $term->XListProperties ($window)	1893	=item @atoms = $term->XListProperties ($window)
1631		1894
1632	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1895	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1633		1896
1634	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1897	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1635		1898
1636	=item $term->XDeleteProperty ($window, $property)	1899	=item $term->XDeleteProperty ($window, $property)
1637		1900
1638	=item $window = $term->DefaultRootWindow	1901	=item $window = $term->DefaultRootWindow
1639		1902
…		…
1646	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1909	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1647		1910
1648	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1911	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1649		1912
1650	=item $term->XChangeInput ($window, $add_events[, $del_events])	1913	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1914
		1915	=item $keysym = $term->XStringToKeysym ($string)
		1916
		1917	=item $string = $term->XKeysymToString ($keysym)
1651		1918
1652	Various X or X-related functions. The C<$term> object only serves as	1919	Various X or X-related functions. The C<$term> object only serves as
1653	the source of the display, otherwise those functions map more-or-less	1920	the source of the display, otherwise those functions map more-or-less
1654	directory onto the X functions of the same name.	1921	directly onto the X functions of the same name.
1655		1922
1656	=back	1923	=back
1657		1924
1658	=cut	1925	=cut
1659		1926
…		…
1723	my ($self, $text, $cb) = @_;	1990	my ($self, $text, $cb) = @_;
1724		1991
1725	$self->add_item ({ type => "button", text => $text, activate => $cb});	1992	$self->add_item ({ type => "button", text => $text, activate => $cb});
1726	}	1993	}
1727		1994
1728	=item $popup->add_toggle ($text, $cb, $initial_value)	1995	=item $popup->add_toggle ($text, $initial_value, $cb)
1729		1996
1730	Adds a toggle/checkbox item to the popup. Teh callback gets called	1997	Adds a toggle/checkbox item to the popup. The callback gets called
1731	whenever it gets toggled, with a boolean indicating its value as its first	1998	whenever it gets toggled, with a boolean indicating its new value as its
1732	argument.	1999	first argument.
1733		2000
1734	=cut	2001	=cut
1735		2002
1736	sub add_toggle {	2003	sub add_toggle {
1737	my ($self, $text, $cb, $value) = @_;	2004	my ($self, $text, $value, $cb) = @_;
1738		2005
1739	my $item; $item = {	2006	my $item; $item = {
1740	type => "button",	2007	type => "button",
1741	text => " $text",	2008	text => " $text",
1742	value => $value,	2009	value => $value,
…		…
1761	my $env = $self->{term}->env;	2028	my $env = $self->{term}->env;
1762	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2029	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1763	delete $env->{LC_ALL};	2030	delete $env->{LC_ALL};
1764	$env->{LC_CTYPE} = $self->{term}->locale;	2031	$env->{LC_CTYPE} = $self->{term}->locale;
1765		2032
1766	urxvt::term->new ($env, "popup",	2033	my $term = urxvt::term->new (
		2034	$env, "popup",
1767	"--perl-lib" => "", "--perl-ext-common" => "",	2035	"--perl-lib" => "", "--perl-ext-common" => "",
1768	"-pty-fd" => -1, "-sl" => 0,	2036	"-pty-fd" => -1, "-sl" => 0,
1769	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2037	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1770	"--transient-for" => $self->{term}->parent,	2038	"--transient-for" => $self->{term}->parent,
1771	"-display" => $self->{term}->display_id,	2039	"-display" => $self->{term}->display_id,
1772	"-pe" => "urxvt-popup")	2040	"-pe" => "urxvt-popup",
1773	or die "unable to create popup window\n";	2041	) or die "unable to create popup window\n";
		2042
		2043	unless (delete $term->{urxvt_popup_init_done}) {
		2044	$term->ungrab;
		2045	$term->destroy;
		2046	die "unable to initialise popup window\n";
		2047	}
1774	}	2048	}
1775		2049
1776	sub DESTROY {	2050	sub DESTROY {
1777	my ($self) = @_;	2051	my ($self) = @_;
1778		2052
…		…
1783	=back	2057	=back
1784		2058
1785	=cut	2059	=cut
1786		2060
1787	package urxvt::watcher;	2061	package urxvt::watcher;
1788
1789	@urxvt::timer::ISA = __PACKAGE__;
1790	@urxvt::iow::ISA = __PACKAGE__;
1791	@urxvt::pw::ISA = __PACKAGE__;
1792	@urxvt::iw::ISA = __PACKAGE__;
1793		2062
1794	=head2 The C<urxvt::timer> Class	2063	=head2 The C<urxvt::timer> Class
1795		2064
1796	This class implements timer watchers/events. Time is represented as a	2065	This class implements timer watchers/events. Time is represented as a
1797	fractional number of seconds since the epoch. Example:	2066	fractional number of seconds since the epoch. Example:
…		…
1801	->new	2070	->new
1802	->interval (1)	2071	->interval (1)
1803	->cb (sub {	2072	->cb (sub {
1804	$term->{overlay}->set (0, 0,	2073	$term->{overlay}->set (0, 0,
1805	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2074	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1806	});	2075	});
1807		2076
1808	=over 4	2077	=over 4
1809		2078
1810	=item $timer = new urxvt::timer	2079	=item $timer = new urxvt::timer
1811		2080
…		…
1814		2083
1815	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2084	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1816		2085
1817	Set the callback to be called when the timer triggers.	2086	Set the callback to be called when the timer triggers.
1818		2087
1819	=item $tstamp = $timer->at
1820
1821	Return the time this watcher will fire next.
1822
1823	=item $timer = $timer->set ($tstamp)	2088	=item $timer = $timer->set ($tstamp[, $interval])
1824		2089
1825	Set the time the event is generated to $tstamp.	2090	Set the time the event is generated to $tstamp (and optionally specifies a
		2091	new $interval).
1826		2092
1827	=item $timer = $timer->interval ($interval)	2093	=item $timer = $timer->interval ($interval)
1828		2094
1829	Normally (and when C<$interval> is C<0>), the timer will automatically	2095	By default (and when C<$interval> is C<0>), the timer will automatically
1830	stop after it has fired once. If C<$interval> is non-zero, then the timer	2096	stop after it has fired once. If C<$interval> is non-zero, then the timer
1831	is automatically rescheduled at the given intervals.	2097	is automatically rescheduled at the given intervals.
1832		2098
1833	=item $timer = $timer->start	2099	=item $timer = $timer->start
1834		2100
1835	Start the timer.	2101	Start the timer.
1836		2102
1837	=item $timer = $timer->start ($tstamp)	2103	=item $timer = $timer->start ($tstamp[, $interval])
1838		2104
1839	Set the event trigger time to C<$tstamp> and start the timer.	2105	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2106	also replaces the interval.
1840		2107
1841	=item $timer = $timer->after ($delay)	2108	=item $timer = $timer->after ($delay[, $interval])
1842		2109
1843	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2110	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1844		2111
1845	=item $timer = $timer->stop	2112	=item $timer = $timer->stop
1846		2113
…		…
1854		2121
1855	$term->{socket} = ...	2122	$term->{socket} = ...
1856	$term->{iow} = urxvt::iow	2123	$term->{iow} = urxvt::iow
1857	->new	2124	->new
1858	->fd (fileno $term->{socket})	2125	->fd (fileno $term->{socket})
1859	->events (urxvt::EVENT_READ)	2126	->events (urxvt::EV_READ)
1860	->start	2127	->start
1861	->cb (sub {	2128	->cb (sub {
1862	my ($iow, $revents) = @_;	2129	my ($iow, $revents) = @_;
1863	# $revents must be 1 here, no need to check	2130	# $revents must be 1 here, no need to check
1864	sysread $term->{socket}, my $buf, 8192	2131	sysread $term->{socket}, my $buf, 8192
…		…
1877	Set the callback to be called when io events are triggered. C<$reventmask>	2144	Set the callback to be called when io events are triggered. C<$reventmask>
1878	is a bitset as described in the C<events> method.	2145	is a bitset as described in the C<events> method.
1879		2146
1880	=item $iow = $iow->fd ($fd)	2147	=item $iow = $iow->fd ($fd)
1881		2148
1882	Set the filedescriptor (not handle) to watch.	2149	Set the file descriptor (not handle) to watch.
1883		2150
1884	=item $iow = $iow->events ($eventmask)	2151	=item $iow = $iow->events ($eventmask)
1885		2152
1886	Set the event mask to watch. The only allowed values are	2153	Set the event mask to watch. The only allowed values are
1887	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2154	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1888	together, or C<urxvt::EVENT_NONE>.	2155	together, or C<urxvt::EV_NONE>.
1889		2156
1890	=item $iow = $iow->start	2157	=item $iow = $iow->start
1891		2158
1892	Start watching for requested events on the given handle.	2159	Start watching for requested events on the given handle.
1893		2160
1894	=item $iow = $iow->stop	2161	=item $iow = $iow->stop
1895		2162
1896	Stop watching for events on the given filehandle.	2163	Stop watching for events on the given file handle.
1897		2164
1898	=back	2165	=back
1899		2166
1900	=head2 The C<urxvt::iw> Class	2167	=head2 The C<urxvt::iw> Class
1901		2168
…		…
1934	->new	2201	->new
1935	->start ($pid)	2202	->start ($pid)
1936	->cb (sub {	2203	->cb (sub {
1937	my ($pw, $exit_status) = @_;	2204	my ($pw, $exit_status) = @_;
1938	...	2205	...
1939	});	2206	});
1940		2207
1941	=over 4	2208	=over 4
1942		2209
1943	=item $pw = new urxvt::pw	2210	=item $pw = new urxvt::pw
1944		2211
…		…
1948		2215
1949	Set the callback to be called when the timer triggers.	2216	Set the callback to be called when the timer triggers.
1950		2217
1951	=item $pw = $timer->start ($pid)	2218	=item $pw = $timer->start ($pid)
1952		2219
1953	Tells the wqtcher to start watching for process C<$pid>.	2220	Tells the watcher to start watching for process C<$pid>.
1954		2221
1955	=item $pw = $pw->stop	2222	=item $pw = $pw->stop
1956		2223
1957	Stop the watcher.	2224	Stop the watcher.
1958		2225
…		…
1971		2238
1972	=item >= 3 - script loading and management	2239	=item >= 3 - script loading and management
1973		2240
1974	=item >=10 - all called hooks	2241	=item >=10 - all called hooks
1975		2242
1976	=item >=11 - hook reutrn values	2243	=item >=11 - hook return values
1977		2244
1978	=back	2245	=back
1979		2246
1980	=head1 AUTHOR	2247	=head1 AUTHOR
1981		2248
1982	Marc Lehmann <pcg@goof.com>	2249	Marc Lehmann <schmorp@schmorp.de>
1983	http://software.schmorp.de/pkg/rxvt-unicode	2250	http://software.schmorp.de/pkg/rxvt-unicode
1984		2251
1985	=cut	2252	=cut
1986		2253
1987	1	2254	1
		2255
		2256	# vim: sw=3:

Diff Legend

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