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.143 by root, Thu Jul 6 23:48:11 2006 UTC vs.
Revision 1.254 by sf-exg, Tue Mar 17 09:23:08 2015 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions may add additional resources and C<actions>, i.e., methods
45		49	which can be bound to a key and invoked by the user. An extension can
46	=item selection (enabled by default)	50	define the resources it support using so called META comments,
47		51	described below. Similarly to builtin resources, extension resources
48	(More) intelligent selection. This extension tries to be more intelligent	52	can also be specified on the command line as long options (with C<.>
49	when the user extends selections (double-click and further clicks). Right	53	replaced by C<->), in which case the corresponding extension is loaded
50	now, it tries to select words, urls and complete shell-quoted	54	automatically. For this to work the extension B<must> define META
51	arguments, which is very convenient, too, if your F<ls> supports	55	comments for its resources.
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	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	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.
102
103	It's sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as
107	first argument.
108
109	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:
111
112	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};
115
116	=item selection-popup (enabled by default)
117
118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119	text into various other formats/action (such as uri unescaping, perl
120	evaluation, web-browser starting etc.), depending on content.
121
122	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.
125
126	It's sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide wether to add something or not.
128	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.
131
132	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:
135
136	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }
138	: ()
139	};
140
141	=item searchable-scrollback<hotkey> (enabled by default)
142
143	Adds regex search functionality to the scrollback buffer, triggered
144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
145	input/output is suspended and a regex is displayed at the bottom of the
146	screen.
147
148	Inputting characters appends them to the regex and continues incremental
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary
154	selection.
155
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.
159
160	See L<perlre> for more info about perl regular expression syntax.
161
162	=item readline (enabled by default)
163
164	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to
166	move the text cursor to this position. It does so by generating as many
167	cursor-left or cursor-right keypresses as required (the this only works
168	for programs that correctly support wide characters).
169
170	To avoid too many false positives, this is only done when:
171
172	=over 4
173
174	=item - the tty is in ICANON state.
175
176	=item - the text cursor is visible.
177
178	=item - the primary screen is currently being displayed.
179
180	=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182	=back
183
184	The normal selection mechanism isn't disabled, so quick successive clicks
185	might interfere with selection creation in harmless ways.
186
187	=item selection-autotransform
188
189	This selection allows you to do automatic transforms on a selection
190	whenever a selection is made.
191
192	It works by specifying perl snippets (most useful is a single C<s///>
193	operator) that modify C<$_> as resources:
194
195	URxvt.selection-autotransform.0: transform
196	URxvt.selection-autotransform.1: transform
197	...
198
199	For example, the following will transform selections of the form
200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
201	$word>:
202
203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
204
205	And this example matches the same,but replaces it with vi-commands you can
206	paste directly into your (vi :) editor:
207
208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
209
210	Of course, this can be modified to suit your needs and your editor :)
211
212	To expand the example above to typical perl error messages ("XXX at
213	FILENAME line YYY."), you need a slightly more elaborate solution:
214
215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
217
218	The first line tells the selection code to treat the unchanging part of
219	every error message as a selection pattern, and the second line transforms
220	the message into vi commands to load the file.
221
222	=item tabbed
223
224	This transforms the terminal into a tabbar with additional terminals, that
225	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227	button per tab.
228
229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
230	B<Shift-Right> will switch to the tab left or right of the current one,
231	while B<Shift-Down> creates a new tab.
232
233	The tabbar itself can be configured similarly to a normal terminal, but
234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
235	following four resources (shown with defaults):
236
237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239	URxvt.tabbed.tab-fg: <colour-index, default 0>
240	URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.
244
245	=item mark-urls
246
247	Uses per-line display filtering (C<on_line_update>) to underline urls and
248	make them clickable. When middle-clicked, the program specified in the
249	resource C<urlLauncher> (default C<x-www-browser>) will be started with
250	the URL as first argument.
251
252	=item xim-onthespot
253
254	This (experimental) perl extension implements OnTheSpot editing. It does
255	not work perfectly, and some input methods don't seem to work well with
256	OnTheSpot editing in general, but it seems to work at leats for SCIM and
257	kinput2.
258
259	You enable it by specifying this extension and a preedit style of
260	C<OnTheSpot>, i.e.:
261
262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263
264	=item kuake<hotkey>
265
266	A very primitive quake-console-like extension. It was inspired by a
267	description of how the programs C<kuake> and C<yakuake> work: Whenever the
268	user presses a global accelerator key (by default C<F10>), the terminal
269	will show or hide itself. Another press of the accelerator key will hide
270	or show it again.
271
272	Initially, the window will not be shown when using this extension.
273
274	This is useful if you need a single terminal thats not using any desktop
275	space most of the time but is quickly available at the press of a key.
276
277	The accelerator key is grabbed regardless of any modifers, so this
278	extension will actually grab a physical key just for this function.
279
280	If you want a quake-like animation, tell your window manager to do so
281	(fvwm can do it).
282
283	=item automove-background
284
285	This is basically a very small extension that dynamically changes the
286	background pixmap offset to the window position, in effect creating the
287	same effect as pseudo transparency with a custom pixmap. No scaling is
288	supported in this mode. Exmaple:
289
290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291
292	=item block-graphics-to-ascii
293
294	A not very useful example of filtering all text output to the terminal
295	by replacing all line-drawing characters (U+2500 .. U+259F) by a
296	similar-looking ascii character.
297
298	=item digital-clock
299
300	Displays a digital clock using the built-in overlay.
301
302	=item remote-clipboard
303
304	Somewhat of a misnomer, this extension adds two menu entries to the
305	selection popup that allows one ti run external commands to store the
306	selection somewhere and fetch it again.
307
308	We use it to implement a "distributed selection mechanism", which just
309	means that one command uploads the file to a remote server, and another
310	reads it.
311
312	The commands can be set using the C<URxvt.remote-selection.store> and
313	C<URxvt.remote-selection.fetch> resources. The first should read the
314	selection to store from STDIN (always in UTF-8), the second should provide
315	the selection data on STDOUT (also in UTF-8).
316
317	The defaults (which are likely useless to you) use rsh and cat:
318
319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321
322	=item selection-pastebin
323
324	This is a little rarely useful extension that Uploads the selection as
325	textfile to a remote site (or does other things). (The implementation is
326	not currently secure for use in a multiuser environment as it writes to
327	F</tmp> directly.).
328
329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
330	i.e.
331
332	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
333
334	Pressing this combination runs a command with C<%> replaced by the name of
335	the textfile. This command can be set via a resource:
336
337	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
338
339	And the default is likely not useful to anybody but the few people around
340	here :)
341
342	The name of the textfile is the hex encoded md5 sum of the selection, so
343	the same content should lead to the same filename.
344
345	After a successful upload the selection will be replaced by the text given
346	in the C<selection-pastebin-url> resource (again, the % is the placeholder
347	for the filename):
348
349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350
351	=item example-refresh-hooks
352
353	Displays a very simple digital clock in the upper right corner of the
354	window. Illustrates overwriting the refresh callbacks to create your own
355	overlays or changes.
356
357	=back
358		56
359	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
360		58
361	=head2 General API Considerations	59	=head2 General API Considerations
362		60
…		…
376		74
377	=over 4	75	=over 4
378		76
379	=item $text	77	=item $text
380		78
381	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
382	always represents one screen cell. See L<ROW_t> for a discussion of this format.	80	always represents one screen cell. See L<ROW_t> for a discussion of this format.
383		81
384	=item $string	82	=item $string
385		83
386	A perl text string, with an emphasis on I<text>. It can store all unicode	84	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
390	=item $octets	88	=item $octets
391		89
392	Either binary data or - more common - a text string encoded in a	90	Either binary data or - more common - a text string encoded in a
393	locale-specific way.	91	locale-specific way.
394		92
		93	=item $keysym
		94
		95	an integer that is a valid X11 keysym code. You can convert a string
		96	into a keysym and viceversa by using C<XStringToKeysym> and
		97	C<XKeysymToString>.
		98
395	=back	99	=back
396		100
397	=head2 Extension Objects	101	=head2 Extension Objects
398		102
399	Every perl extension is a perl class. A separate perl object is created	103	Every perl extension is a perl class. A separate perl object is created
400	for each terminal and each extension and passed as the first parameter to	104	for each terminal, and each terminal has its own set of extension objects,
401	hooks. So extensions can use their C<$self> object without having to think	105	which are passed as the first parameter to hooks. So extensions can use
402	about other extensions, with the exception of methods and members that	106	their C<$self> object without having to think about clashes with other
		107	extensions or other terminals, with the exception of methods and members
403	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
404	use.	109	internal use.
405		110
406	Although it isn't a C<urxvt::term> object, you can call all methods of the	111	Although it isn't a C<urxvt::term> object, you can call all methods of the
407	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
408		113
409	It has the following methods and data members:	114	Additional methods only supported for extension objects are described in
		115	the C<urxvt::extension> section below.
		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata.
		121
		122	Currently, it recognises only one such comment:
410		123
411	=over 4	124	=over 4
412		125
413	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
414		127
415	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
416	extension. This member I<must not> be changed in any way.	129	C<name> is the resource name, C<type> is the resource type, C<boolean>
417		130	or C<string>, and C<desc> is the resource description.
418	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
419
420	Dynamically enable the given hooks (named without the C<on_> prefix) for
421	this extension, replacing any previous hook. This is useful when you want
422	to overwrite time-critical hooks only temporarily.
423
424	=item $self->disable ($hook_name[, $hook_name..])
425
426	Dynamically disable the given hooks.
427		131
428	=back	132	=back
429		133
430	=head2 Hooks	134	=head2 Hooks
431		135
432	The following subroutines can be declared in extension files, and will be	136	The following subroutines can be declared in extension files, and will be
433	called whenever the relevant event happens.	137	called whenever the relevant event happens.
434		138
435	The first argument passed to them is an extension oject as described in	139	The first argument passed to them is an extension object as described in
436	the in the C<Extension Objects> section.	140	the in the C<Extension Objects> section.
437		141
438	B<All> of these hooks must return a boolean value. If any of the called	142	B<All> of these hooks must return a boolean value. If any of the called
439	hooks returns true, then the event counts as being I<consumed>, and the	143	hooks returns true, then the event counts as being I<consumed>, and the
440	relevant action might not be carried out by the C++ code.	144	relevant action might not be carried out by the C++ code.
…		…
453	place.	157	place.
454		158
455	=item on_start $term	159	=item on_start $term
456		160
457	Called at the very end of initialisation of a new terminal, just before	161	Called at the very end of initialisation of a new terminal, just before
458	trying to map (display) the toplevel and returning to the mainloop.	162	trying to map (display) the toplevel and returning to the main loop.
459		163
460	=item on_destroy $term	164	=item on_destroy $term
461		165
462	Called whenever something tries to destroy terminal, when the terminal is	166	Called whenever something tries to destroy terminal, when the terminal is
463	still fully functional (not for long, though).	167	still fully functional (not for long, though).
…		…
490		194
491	Called whenever a selection has been copied, but before the selection is	195	Called whenever a selection has been copied, but before the selection is
492	requested from the server. The selection text can be queried and changed	196	requested from the server. The selection text can be queried and changed
493	by calling C<< $term->selection >>.	197	by calling C<< $term->selection >>.
494		198
495	Returning a true value aborts selection grabbing. It will still be hilighted.	199	Returning a true value aborts selection grabbing. It will still be highlighted.
496		200
497	=item on_sel_extend $term	201	=item on_sel_extend $term
498		202
499	Called whenever the user tries to extend the selection (e.g. with a double	203	Called whenever the user tries to extend the selection (e.g. with a double
500	click) and is either supposed to return false (normal operation), or	204	click) and is either supposed to return false (normal operation), or
501	should extend the selection itelf and return true to suppress the built-in	205	should extend the selection itself and return true to suppress the built-in
502	processing. This can happen multiple times, as long as the callback	206	processing. This can happen multiple times, as long as the callback
503	returns true, it will be called on every further click by the user and is	207	returns true, it will be called on every further click by the user and is
504	supposed to enlarge the selection more and more, if possible.	208	supposed to enlarge the selection more and more, if possible.
505		209
506	See the F<selection> example extension.	210	See the F<selection> example extension.
507		211
508	=item on_view_change $term, $offset	212	=item on_view_change $term, $offset
509		213
510	Called whenever the view offset changes, i..e the user or program	214	Called whenever the view offset changes, i.e. the user or program
511	scrolls. Offset C<0> means display the normal terminal, positive values	215	scrolls. Offset C<0> means display the normal terminal, positive values
512	show this many lines of scrollback.	216	show this many lines of scrollback.
513		217
514	=item on_scroll_back $term, $lines, $saved	218	=item on_scroll_back $term, $lines, $saved
515		219
…		…
519		223
520	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	224	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
521	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	225	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
522	number of lines that will be in the scrollback buffer.	226	number of lines that will be in the scrollback buffer.
523		227
524	=item on_osc_seq $term, $op, $args	228	=item on_osc_seq $term, $op, $args, $resp
525		229
526	Called on every OSC sequence and can be used to suppress it or modify its	230	Called on every OSC sequence and can be used to suppress it or modify its
527	behaviour. The default should be to return an empty list. A true value	231	behaviour. The default should be to return an empty list. A true value
528	suppresses execution of the request completely. Make sure you don't get	232	suppresses execution of the request completely. Make sure you don't get
529	confused by recursive invocations when you output an osc sequence within	233	confused by recursive invocations when you output an OSC sequence within
530	this callback.	234	this callback.
531		235
532	C<on_osc_seq_perl> should be used for new behaviour.	236	C<on_osc_seq_perl> should be used for new behaviour.
533		237
534	=item on_osc_seq_perl $term, $string	238	=item on_osc_seq_perl $term, $args, $resp
535		239
536	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	240	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
537	operating system command) is processed. Cursor position and other state	241	operating system command) is processed. Cursor position and other state
538	information is up-to-date when this happens. For interoperability, the	242	information is up-to-date when this happens. For interoperability, the
539	string should start with the extension name and a colon, to distinguish	243	string should start with the extension name (sans -osc) and a semicolon,
540	it from commands for other extensions, and this might be enforced in the	244	to distinguish it from commands for other extensions, and this might be
541	future.	245	enforced in the future.
		246
		247	For example, C<overlay-osc> uses this:
		248
		249	sub on_osc_seq_perl {
		250	my ($self, $osc, $resp) = @_;
		251
		252	return unless $osc =~ s/^overlay;//;
		253
		254	... process remaining $osc string
		255	}
542		256
543	Be careful not ever to trust (in a security sense) the data you receive,	257	Be careful not ever to trust (in a security sense) the data you receive,
544	as its source can not easily be controleld (e-mail content, messages from	258	as its source can not easily be controlled (e-mail content, messages from
545	other users on the same system etc.).	259	other users on the same system etc.).
		260
		261	For responses, C<$resp> contains the end-of-args separator used by the
		262	sender.
546		263
547	=item on_add_lines $term, $string	264	=item on_add_lines $term, $string
548		265
549	Called whenever text is about to be output, with the text as argument. You	266	Called whenever text is about to be output, with the text as argument. You
550	can filter/change and output the text yourself by returning a true value	267	can filter/change and output the text yourself by returning a true value
…		…
555	=item on_tt_write $term, $octets	272	=item on_tt_write $term, $octets
556		273
557	Called whenever some data is written to the tty/pty and can be used to	274	Called whenever some data is written to the tty/pty and can be used to
558	suppress or filter tty input.	275	suppress or filter tty input.
559		276
		277	=item on_tt_paste $term, $octets
		278
		279	Called whenever text is about to be pasted, with the text as argument. You
		280	can filter/change and paste the text yourself by returning a true value
		281	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		282	locale-encoded.
		283
560	=item on_line_update $term, $row	284	=item on_line_update $term, $row
561		285
562	Called whenever a line was updated or changed. Can be used to filter	286	Called whenever a line was updated or changed. Can be used to filter
563	screen output (e.g. underline urls or other useless stuff). Only lines	287	screen output (e.g. underline urls or other useless stuff). Only lines
564	that are being shown will be filtered, and, due to performance reasons,	288	that are being shown will be filtered, and, due to performance reasons,
…		…
571	later with the already-modified line (e.g. if unrelated parts change), so	295	later with the already-modified line (e.g. if unrelated parts change), so
572	you cannot just toggle rendition bits, but only set them.	296	you cannot just toggle rendition bits, but only set them.
573		297
574	=item on_refresh_begin $term	298	=item on_refresh_begin $term
575		299
576	Called just before the screen gets redrawn. Can be used for overlay	300	Called just before the screen gets redrawn. Can be used for overlay or
577	or similar effects by modify terminal contents in refresh_begin, and	301	similar effects by modifying the terminal contents in refresh_begin, and
578	restoring them in refresh_end. The built-in overlay and selection display	302	restoring them in refresh_end. The built-in overlay and selection display
579	code is run after this hook, and takes precedence.	303	code is run after this hook, and takes precedence.
580		304
581	=item on_refresh_end $term	305	=item on_refresh_end $term
582		306
583	Called just after the screen gets redrawn. See C<on_refresh_begin>.	307	Called just after the screen gets redrawn. See C<on_refresh_begin>.
584		308
		309	=item on_action $term, $string
		310
		311	Called whenever an action is invoked for the corresponding extension
		312	(e.g. via a C<extension:string> builtin action bound to a key, see
		313	description of the B<keysym> resource in the urxvt(1) manpage). The
		314	event is simply the action string. Note that an action event is always
		315	associated to a single extension.
		316
585	=item on_user_command $term, $string	317	=item on_user_command $term, $string *DEPRECATED*
586		318
587	Called whenever the a user-configured event is being activated (e.g. via	319	Called whenever a user-configured event is being activated (e.g. via
588	a C<perl:string> action bound to a key, see description of the B<keysym>	320	a C<perl:string> action bound to a key, see description of the B<keysym>
589	resource in the @@RXVT_NAME@@(1) manpage).	321	resource in the urxvt(1) manpage).
590		322
591	The event is simply the action string. This interface is assumed to change	323	The event is simply the action string. This interface is going away in
592	slightly in the future.	324	preference to the C<on_action> hook.
593		325
594	=item on_resize_all_windows $tern, $new_width, $new_height	326	=item on_resize_all_windows $term, $new_width, $new_height
595		327
596	Called just after the new window size has been calculcated, but before	328	Called just after the new window size has been calculated, but before
597	windows are actually being resized or hints are being set. If this hook	329	windows are actually being resized or hints are being set. If this hook
598	returns TRUE, setting of the window hints is being skipped.	330	returns a true value, setting of the window hints is being skipped.
599		331
600	=item on_x_event $term, $event	332	=item on_x_event $term, $event
601		333
602	Called on every X event received on the vt window (and possibly other	334	Called on every X event received on the vt window (and possibly other
603	windows). Should only be used as a last resort. Most event structure	335	windows). Should only be used as a last resort. Most event structure
…		…
612	Called whenever the window gets the keyboard focus, before rxvt-unicode	344	Called whenever the window gets the keyboard focus, before rxvt-unicode
613	does focus in processing.	345	does focus in processing.
614		346
615	=item on_focus_out $term	347	=item on_focus_out $term
616		348
617	Called wheneever the window loses keyboard focus, before rxvt-unicode does	349	Called whenever the window loses keyboard focus, before rxvt-unicode does
618	focus out processing.	350	focus out processing.
619		351
620	=item on_configure_notify $term, $event	352	=item on_configure_notify $term, $event
621		353
622	=item on_property_notify $term, $event	354	=item on_property_notify $term, $event
…		…
633		365
634	=item on_map_notify $term, $event	366	=item on_map_notify $term, $event
635		367
636	=item on_unmap_notify $term, $event	368	=item on_unmap_notify $term, $event
637		369
638	Called whenever the corresponding X event is received for the terminal If	370	Called whenever the corresponding X event is received for the terminal. If
639	the hook returns true, then the even will be ignored by rxvt-unicode.	371	the hook returns true, then the event will be ignored by rxvt-unicode.
640		372
641	The event is a hash with most values as named by Xlib (see the XEvent	373	The event is a hash with most values as named by Xlib (see the XEvent
642	manpage), with the additional members C<row> and C<col>, which are the	374	manpage), with the additional members C<row> and C<col>, which are the
643	(real, not screen-based) row and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
644		376
645	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
646	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
647		379
648	subwindow.
649
650	=item on_client_message $term, $event	380	=item on_client_message $term, $event
651		381
652	=item on_wm_protocols $term, $event	382	=item on_wm_protocols $term, $event
653		383
654	=item on_wm_delete_window $term, $event	384	=item on_wm_delete_window $term, $event
655		385
656	Called when various types of ClientMessage events are received (all with	386	Called when various types of ClientMessage events are received (all with
657	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	387	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
658		388
		389	=item on_bell $term
		390
		391	Called on receipt of a bell character.
		392
659	=back	393	=back
660		394
661	=cut	395	=cut
662		396
663	package urxvt;	397	package urxvt;
664		398
665	use utf8;	399	use utf8;
666	use strict;	400	use strict 'vars';
667	use Carp ();	401	use Carp ();
668	use Scalar::Util ();	402	use Scalar::Util ();
669	use List::Util ();	403	use List::Util ();
670		404
671	our $VERSION = 1;	405	our $VERSION = 1;
672	our $TERM;	406	our $TERM;
673	our @TERM_INIT;	407	our @TERM_INIT; # should go, prevents async I/O etc.
674	our @TERM_EXT;	408	our @TERM_EXT; # should go, prevents async I/O etc.
675	our @HOOKNAME;	409	our @HOOKNAME;
676	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	410	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
677	our %OPTION;	411	our %OPTION;
678		412
679	our $LIBDIR;	413	our $LIBDIR;
…		…
705	The current terminal. This variable stores the current C<urxvt::term>	439	The current terminal. This variable stores the current C<urxvt::term>
706	object, whenever a callback/hook is executing.	440	object, whenever a callback/hook is executing.
707		441
708	=item @urxvt::TERM_INIT	442	=item @urxvt::TERM_INIT
709		443
710	All coderefs in this array will be called as methods of the next newly	444	All code references in this array will be called as methods of the next newly
711	created C<urxvt::term> object (during the C<on_init> phase). The array	445	created C<urxvt::term> object (during the C<on_init> phase). The array
712	gets cleared before the codereferences that were in it are being executed,	446	gets cleared before the code references that were in it are being executed,
713	so coderefs can push themselves onto it again if they so desire.	447	so references can push themselves onto it again if they so desire.
714		448
715	This complements to the perl-eval commandline option, but gets executed	449	This complements to the perl-eval command line option, but gets executed
716	first.	450	first.
717		451
718	=item @urxvt::TERM_EXT	452	=item @urxvt::TERM_EXT
719		453
720	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	454	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
727		461
728	=over 4	462	=over 4
729		463
730	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
731		465
732	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
733	costs! The only time this is acceptable is when the terminal process	467	include a trailing newline). Avoid at all costs! The only time this
734	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
735		470
736	=item urxvt::warn $string	471	=item urxvt::warn $string
737		472
738	Calls C<rxvt_warn> with the given string which should not include a	473	Calls C<rxvt_warn> with the given string which should include a trailing
739	newline. The module also overwrites the C<warn> builtin with a function	474	newline. The module also overwrites the C<warn> builtin with a function
740	that calls this function.	475	that calls this function.
741		476
742	Using this function has the advantage that its output ends up in the	477	Using this function has the advantage that its output ends up in the
743	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
745	Messages have a size limit of 1023 bytes currently.	480	Messages have a size limit of 1023 bytes currently.
746		481
747	=item @terms = urxvt::termlist	482	=item @terms = urxvt::termlist
748		483
749	Returns all urxvt::term objects that exist in this process, regardless of	484	Returns all urxvt::term objects that exist in this process, regardless of
750	wether they are started, being destroyed etc., so be careful. Only term	485	whether they are started, being destroyed etc., so be careful. Only term
751	objects that have perl extensions attached will be returned (because there	486	objects that have perl extensions attached will be returned (because there
752	is no urxvt::term objet associated with others).	487	is no urxvt::term object associated with others).
753		488
754	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
755		490
756	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
757		492
…		…
800		535
801	=item $rend = urxvt::OVERLAY_RSTYLE	536	=item $rend = urxvt::OVERLAY_RSTYLE
802		537
803	Return the rendition mask used for overlays by default.	538	Return the rendition mask used for overlays by default.
804		539
805	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	540	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		541	urxvt::RS_RVid, urxvt::RS_Uline
806		542
807	Return the bit that enabled bold, italic, blink, reverse-video and	543	Return the bit that enabled bold, italic, blink, reverse-video and
808	underline, respectively. To enable such a style, just logically OR it into	544	underline, respectively. To enable such a style, just logically OR it into
809	the bitset.	545	the bitset.
810		546
…		…
847	};	583	};
848	}	584	}
849		585
850	no warnings 'utf8';	586	no warnings 'utf8';
851		587
		588	sub parse_resource {
		589	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		590
		591	$term->scan_extensions;
		592
		593	my $r = $term->{meta}{resource};
		594	keys %$r; # reset iterator
		595	while (my ($k, $v) = each %$r) {
		596	my $pattern = $k;
		597	$pattern =~ y/./-/ if $isarg;
		598	my $prefix = $name;
		599	my $suffix;
		600	if ($pattern =~ /\-$/) {
		601	$prefix = substr $name, 0, length $pattern;
		602	$suffix = substr $name, length $pattern;
		603	}
		604	if ($pattern eq $prefix) {
		605	$name = "$urxvt::RESCLASS.$k$suffix";
		606
		607	push @{ $term->{perl_ext_3} }, $v->[0];
		608
		609	if ($v->[1] eq "boolean") {
		610	$term->put_option_db ($name, $flag ? "true" : "false");
		611	return 1;
		612	} else {
		613	$term->put_option_db ($name, $value);
		614	return 1 + 2;
		615	}
		616	}
		617	}
		618
		619	0
		620	}
		621
		622	sub usage {
		623	my ($term, $usage_type) = @_;
		624
		625	$term->scan_extensions;
		626
		627	my $r = $term->{meta}{resource};
		628
		629	for my $pattern (sort keys %$r) {
		630	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		631
		632	$desc .= " (-pe $ext)";
		633
		634	if ($usage_type == 1) {
		635	$pattern =~ y/./-/;
		636	$pattern =~ s/-$/-.../g;
		637
		638	if ($type eq "boolean") {
		639	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		640	} else {
		641	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		642	}
		643	} else {
		644	$pattern =~ s/\.$/.*/g;
		645	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		646	}
		647	}
		648	}
		649
852	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	650	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
853		651
854	sub verbose {	652	sub verbose {
855	my ($level, $msg) = @_;	653	my ($level, $msg) = @_;
856	warn "$msg\n" if $level <= $verbosity;	654	warn "$msg\n" if $level <= $verbosity;
…		…
868	$pkg =~ s/[^[:word:]]/_/g;	666	$pkg =~ s/[^[:word:]]/_/g;
869	$pkg = "urxvt::ext::$pkg";	667	$pkg = "urxvt::ext::$pkg";
870		668
871	verbose 3, "loading extension '$path' into package '$pkg'";	669	verbose 3, "loading extension '$path' into package '$pkg'";
872		670
		671	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		672
873	open my $fh, "<:raw", $path	673	open my $fh, "<:raw", $path
874	or die "$path: $!";	674	or die "$path: $!";
875		675
876	my $source =	676	my $source =
877	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	677	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
878	. "#line 1 \"$path\"\n{\n"	678	. "#line 1 \"$path\"\n{\n"
879	. (do { local $/; <$fh> })	679	. (do { local $/; <$fh> })
880	. "\n};\n1";	680	. "\n};\n1";
881		681
882	eval $source	682	eval $source
…		…
891	# called by the rxvt core	691	# called by the rxvt core
892	sub invoke {	692	sub invoke {
893	local $TERM = shift;	693	local $TERM = shift;
894	my $htype = shift;	694	my $htype = shift;
895		695
896	if ($htype == 0) { # INIT	696	if ($htype == HOOK_INIT) {
897	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	697	my @dirs = $TERM->perl_libdirs;
898		698
		699	$TERM->scan_extensions;
		700
899	my %ext_arg;	701	my %ext_arg;
900		702
901	{	703	{
902	my @init = @TERM_INIT;	704	my @init = @TERM_INIT;
903	@TERM_INIT = ();	705	@TERM_INIT = ();
…		…
905	my @pkg = @TERM_EXT;	707	my @pkg = @TERM_EXT;
906	@TERM_EXT = ();	708	@TERM_EXT = ();
907	$TERM->register_package ($_) for @pkg;	709	$TERM->register_package ($_) for @pkg;
908	}	710	}
909		711
		712	for (
910	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	713	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		714	@{ delete $TERM->{perl_ext_3} }
		715	) {
911	if ($_ eq "default") {	716	if ($_ eq "default") {
		717
		718	$ext_arg{$_} = []
912	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	719	for qw(selection option-popup selection-popup readline searchable-scrollback);
		720
		721	for ($TERM->_keysym_resources) {
		722	next if /^(?:string|command|builtin|builtin-string|perl)/;
		723	next unless /^([A-Za-z0-9_\-]+):/;
		724
		725	my $ext = $1;
		726
		727	$ext_arg{$ext} = [];
		728	}
		729
913	} elsif (/^-(.*)$/) {	730	} elsif (/^-(.*)$/) {
914	delete $ext_arg{$1};	731	delete $ext_arg{$1};
		732
915	} elsif (/^([^<]+)<(.*)>$/) {	733	} elsif (/^([^<]+)<(.*)>$/) {
916	push @{ $ext_arg{$1} }, $2;	734	push @{ $ext_arg{$1} }, $2;
		735
917	} else {	736	} else {
918	$ext_arg{$_} ||= [];	737	$ext_arg{$_} ||= [];
919	}	738	}
920	}	739	}
921		740
…		…
937		756
938	if (my $cb = $TERM->{_hook}[$htype]) {	757	if (my $cb = $TERM->{_hook}[$htype]) {
939	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	758	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
940	if $verbosity >= 10;	759	if $verbosity >= 10;
941		760
		761	if ($htype == HOOK_ACTION) {
		762	# this hook is only sent to the extension with the name
		763	# matching the first arg
		764	my $pkg = shift;
		765	$pkg =~ y/-/_/;
		766	$pkg = "urxvt::ext::$pkg";
		767
		768	$cb = $cb->{$pkg}
		769	or return undef; #TODO: maybe warn user?
		770
		771	$cb = { $pkg => $cb };
		772	}
		773
942	for my $pkg (keys %$cb) {	774	for my $pkg (keys %$cb) {
943	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	775	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
944	$retval ||= $retval_;	776	$retval ||= $retval_;
945		777
946	if ($@) {	778	if ($@) {
947	$TERM->ungrab; # better to lose the grab than the session	779	$TERM->ungrab; # better to lose the grab than the session
948	warn $@;	780	warn $@;
…		…
951		783
952	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	784	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
953	if $verbosity >= 11;	785	if $verbosity >= 11;
954	}	786	}
955		787
956	if ($htype == 1) { # DESTROY	788	if ($htype == HOOK_DESTROY) {
957	# clear package objects	789	# clear package objects
958	%$_ = () for values %{ $TERM->{_pkg} };	790	%$_ = () for values %{ $TERM->{_pkg} };
959		791
960	# clear package	792	# clear package
961	%$TERM = ();	793	%$TERM = ();
…		…
966		798
967	sub SET_COLOR($$$) {	799	sub SET_COLOR($$$) {
968	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	800	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
969	}	801	}
970		802
971	# urxvt::term::extension	803	sub rend2mask {
		804	no strict 'refs';
		805	my ($str, $mask) = (@_, 0);
		806	my %color = ( fg => undef, bg => undef );
		807	my @failed;
		808	for my $spec ( split /\s+/, $str ) {
		809	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		810	$color{lc($1)} = $2;
		811	} else {
		812	my $neg = $spec =~ s/^[-^]//;
		813	unless ( exists &{"RS_$spec"} ) {
		814	push @failed, $spec;
		815	next;
		816	}
		817	my $cur = &{"RS_$spec"};
		818	if ( $neg ) {
		819	$mask &= ~$cur;
		820	} else {
		821	$mask |= $cur;
		822	}
		823	}
		824	}
		825	($mask, @color{qw(fg bg)}, \@failed)
		826	}
972		827
973	package urxvt::term::extension;	828	package urxvt::term::extension;
974		829
975	sub enable {	830	=head2 The C<urxvt::term::extension> class
976	my ($self, %hook) = @_;
977	my $pkg = $self->{_pkg};
978		831
979	while (my ($name, $cb) = each %hook) {	832	Each extension attached to a terminal object is represented by
980	my $htype = $HOOKTYPE{uc $name};	833	a C<urxvt::term::extension> object.
981	defined $htype
982	or Carp::croak "unsupported hook type '$name'";
983		834
984	$self->set_should_invoke ($htype, +1)	835	You can use these objects, which are passed to all callbacks to store any
985	unless exists $self->{term}{_hook}[$htype]{$pkg};	836	state related to the terminal and extension instance.
986		837
987	$self->{term}{_hook}[$htype]{$pkg} = $cb;	838	The methods (And data members) documented below can be called on extension
988	}	839	objects, in addition to call methods documented for the <urxvt::term>
989	}	840	class.
990		841
991	sub disable {	842	=over 4
992	my ($self, @hook) = @_;
993	my $pkg = $self->{_pkg};
994		843
995	for my $name (@hook) {	844	=item $urxvt_term = $self->{term}
996	my $htype = $HOOKTYPE{uc $name};
997	defined $htype
998	or Carp::croak "unsupported hook type '$name'";
999		845
1000	$self->set_should_invoke ($htype, -1)	846	Returns the C<urxvt::term> object associated with this instance of the
1001	if delete $self->{term}{_hook}[$htype]{$pkg};	847	extension. This member I<must not> be changed in any way.
1002	}	848
1003	}	849	=cut
1004		850
1005	our $AUTOLOAD;	851	our $AUTOLOAD;
1006		852
1007	sub AUTOLOAD {	853	sub AUTOLOAD {
1008	$AUTOLOAD =~ /:([^:]+)$/	854	$AUTOLOAD =~ /:([^:]+)$/
…		…
1021		867
1022	sub DESTROY {	868	sub DESTROY {
1023	# nop	869	# nop
1024	}	870	}
1025		871
1026	# urxvt::destroy_hook	872	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1027		873
1028	sub urxvt::destroy_hook::DESTROY {	874	sub urxvt::destroy_hook::DESTROY {
1029	${$_[0]}->();	875	${$_[0]}->();
1030	}	876	}
1031		877
1032	sub urxvt::destroy_hook(&) {	878	sub urxvt::destroy_hook(&) {
1033	bless \shift, urxvt::destroy_hook::	879	bless \shift, urxvt::destroy_hook::
1034	}	880	}
		881
		882	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		883
		884	Dynamically enable the given hooks (named without the C<on_> prefix) for
		885	this extension, replacing any hook previously installed via C<enable> in
		886	this extension.
		887
		888	This is useful when you want to overwrite time-critical hooks only
		889	temporarily.
		890
		891	To install additional callbacks for the same hook, you can use the C<on>
		892	method of the C<urxvt::term> class.
		893
		894	=item $self->disable ($hook_name[, $hook_name..])
		895
		896	Dynamically disable the given hooks.
		897
		898	=cut
		899
		900	sub enable {
		901	my ($self, %hook) = @_;
		902	my $pkg = $self->{_pkg};
		903
		904	while (my ($name, $cb) = each %hook) {
		905	my $htype = $HOOKTYPE{uc $name};
		906	defined $htype
		907	or Carp::croak "unsupported hook type '$name'";
		908
		909	$self->set_should_invoke ($htype, +1)
		910	unless exists $self->{term}{_hook}[$htype]{$pkg};
		911
		912	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		913	}
		914	}
		915
		916	sub disable {
		917	my ($self, @hook) = @_;
		918	my $pkg = $self->{_pkg};
		919
		920	for my $name (@hook) {
		921	my $htype = $HOOKTYPE{uc $name};
		922	defined $htype
		923	or Carp::croak "unsupported hook type '$name'";
		924
		925	$self->set_should_invoke ($htype, -1)
		926	if delete $self->{term}{_hook}[$htype]{$pkg};
		927	}
		928	}
		929
		930	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		931
		932	Similar to the C<enable> enable, but installs additional callbacks for
		933	the given hook(s) (that is, it doesn't replace existing callbacks), and
		934	returns a guard object. When the guard object is destroyed the callbacks
		935	are disabled again.
		936
		937	=cut
		938
		939	sub urxvt::extension::on_disable::DESTROY {
		940	my $disable = shift;
		941
		942	my $term = delete $disable->{""};
		943
		944	while (my ($htype, $id) = each %$disable) {
		945	delete $term->{_hook}[$htype]{$id};
		946	$term->set_should_invoke ($htype, -1);
		947	}
		948	}
		949
		950	sub on {
		951	my ($self, %hook) = @_;
		952
		953	my $term = $self->{term};
		954
		955	my %disable = ( "" => $term );
		956
		957	while (my ($name, $cb) = each %hook) {
		958	my $htype = $HOOKTYPE{uc $name};
		959	defined $htype
		960	or Carp::croak "unsupported hook type '$name'";
		961
		962	$term->set_should_invoke ($htype, +1);
		963	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		964	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		965	}
		966
		967	bless \%disable, "urxvt::extension::on_disable"
		968	}
		969
		970	=item $self->bind_action ($hotkey, $action)
		971
		972	=item $self->x_resource ($pattern)
		973
		974	=item $self->x_resource_boolean ($pattern)
		975
		976	These methods support an additional C<%> prefix for C<$action> or
		977	C<$pattern> when called on an extension object, compared to the
		978	C<urxvt::term> methods of the same name - see the description of these
		979	methods in the C<urxvt::term> class for details.
		980
		981	=cut
		982
		983	sub bind_action {
		984	my ($self, $hotkey, $action) = @_;
		985	$action =~ s/^%:/$_[0]{_name}:/;
		986	$self->{term}->bind_action ($hotkey, $action)
		987	}
		988
		989	sub x_resource {
		990	my ($self, $name) = @_;
		991	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		992	$self->{term}->x_resource ($name)
		993	}
		994
		995	sub x_resource_boolean {
		996	my ($self, $name) = @_;
		997	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		998	$self->{term}->x_resource_boolean ($name)
		999	}
		1000
		1001	=back
		1002
		1003	=cut
1035		1004
1036	package urxvt::anyevent;	1005	package urxvt::anyevent;
1037		1006
1038	=head2 The C<urxvt::anyevent> Class	1007	=head2 The C<urxvt::anyevent> Class
1039		1008
1040	The sole purpose of this class is to deliver an interface to the	1009	The sole purpose of this class is to deliver an interface to the
1041	C<AnyEvent> module - any module using it will work inside urxvt without	1010	C<AnyEvent> module - any module using it will work inside urxvt without
1042	further programming. The only exception is that you cannot wait on	1011	further programming. The only exception is that you cannot wait on
1043	condition variables, but non-blocking condvar use is ok. What this means	1012	condition variables, but non-blocking condvar use is ok.
1044	is that you cannot use blocking APIs, but the non-blocking variant should
1045	work.
1046		1013
1047	=cut	1014	In practical terms this means is that you cannot use blocking APIs, but
		1015	the non-blocking variant should work.
1048		1016
		1017	=cut
		1018
1049	our $VERSION = 1;	1019	our $VERSION = '5.23';
1050		1020
1051	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1021	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1052	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1022	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1053		1023
1054	sub timer {	1024	sub timer {
…		…
1056		1026
1057	my $cb = $arg{cb};	1027	my $cb = $arg{cb};
1058		1028
1059	urxvt::timer	1029	urxvt::timer
1060	->new	1030	->new
1061	->start (urxvt::NOW + $arg{after})	1031	->after ($arg{after}, $arg{interval})
1062	->cb (sub {	1032	->cb ($arg{interval} ? $cb : sub {
1063	$_[0]->stop; # need to cancel manually	1033	$_[0]->stop; # need to cancel manually
1064	$cb->();	1034	$cb->();
1065	})	1035	})
1066	}	1036	}
1067		1037
1068	sub io {	1038	sub io {
1069	my ($class, %arg) = @_;	1039	my ($class, %arg) = @_;
1070		1040
1071	my $cb = $arg{cb};	1041	my $cb = $arg{cb};
		1042	my $fd = fileno $arg{fh};
		1043	defined $fd or $fd = $arg{fh};
1072		1044
1073	bless [$arg{fh}, urxvt::iow	1045	bless [$arg{fh}, urxvt::iow
1074	->new	1046	->new
1075	->fd (fileno $arg{fh})	1047	->fd ($fd)
1076	->events (($arg{poll} =~ /r/ ? 1 : 0)	1048	->events (($arg{poll} =~ /r/ ? 1 : 0)
1077	| ($arg{poll} =~ /w/ ? 2 : 0))	1049	| ($arg{poll} =~ /w/ ? 2 : 0))
1078	->start	1050	->start
1079	->cb (sub {	1051	->cb ($cb)
1080	$cb->(($_[1] & 1 ? 'r' : '')
1081	. ($_[1] & 2 ? 'w' : ''));
1082	})],
1083	urxvt::anyevent::	1052	], urxvt::anyevent::
		1053	}
		1054
		1055	sub idle {
		1056	my ($class, %arg) = @_;
		1057
		1058	my $cb = $arg{cb};
		1059
		1060	urxvt::iw
		1061	->new
		1062	->start
		1063	->cb ($cb)
		1064	}
		1065
		1066	sub child {
		1067	my ($class, %arg) = @_;
		1068
		1069	my $cb = $arg{cb};
		1070
		1071	urxvt::pw
		1072	->new
		1073	->start ($arg{pid})
		1074	->cb (sub {
		1075	$_[0]->stop; # need to cancel manually
		1076	$cb->($_[0]->rpid, $_[0]->rstatus);
		1077	})
1084	}	1078	}
1085		1079
1086	sub DESTROY {	1080	sub DESTROY {
1087	$_[0][1]->stop;	1081	$_[0][1]->stop;
1088	}	1082	}
1089		1083
1090	sub condvar {	1084	# only needed for AnyEvent < 6 compatibility
1091	bless \my $flag, urxvt::anyevent::condvar::	1085	sub one_event {
1092	}
1093
1094	sub urxvt::anyevent::condvar::broadcast {
1095	${$_[0]}++;
1096	}
1097
1098	sub urxvt::anyevent::condvar::wait {
1099	unless (${$_[0]}) {
1100	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1086	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1101	}
1102	}	1087	}
1103		1088
1104	package urxvt::term;	1089	package urxvt::term;
1105		1090
1106	=head2 The C<urxvt::term> Class	1091	=head2 The C<urxvt::term> Class
…		…
1119	urxvt::verbose 6, "register package $pkg to $self";	1104	urxvt::verbose 6, "register package $pkg to $self";
1120		1105
1121	@{"$pkg\::ISA"} = urxvt::term::extension::;	1106	@{"$pkg\::ISA"} = urxvt::term::extension::;
1122		1107
1123	my $proxy = bless {	1108	my $proxy = bless {
1124	_pkg => $pkg,	1109	_pkg => $pkg,
		1110	_name => ${"$pkg\::_NAME"}, # hackish
1125	argv => $argv,	1111	argv => $argv,
1126	}, $pkg;	1112	}, $pkg;
1127	Scalar::Util::weaken ($proxy->{term} = $self);	1113	Scalar::Util::weaken ($proxy->{term} = $self);
1128		1114
1129	$self->{_pkg}{$pkg} = $proxy;	1115	$self->{_pkg}{$pkg} = $proxy;
1130		1116
…		…
1133	$proxy->enable ($name => $ref);	1119	$proxy->enable ($name => $ref);
1134	}	1120	}
1135	}	1121	}
1136	}	1122	}
1137		1123
		1124	sub perl_libdirs {
		1125	map { split /:/ }
		1126	$_[0]->resource ("perl_lib"),
		1127	$ENV{URXVT_PERL_LIB},
		1128	"$ENV{HOME}/.urxvt/ext",
		1129	"$LIBDIR/perl"
		1130	}
		1131
		1132	# scan for available extensions and collect their metadata
		1133	sub scan_extensions {
		1134	my ($self) = @_;
		1135
		1136	return if exists $self->{meta};
		1137
		1138	my @urxvtdirs = perl_libdirs $self;
		1139	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1140
		1141	$self->{meta} = \my %meta;
		1142
		1143	# first gather extensions
		1144
		1145	my $gather = sub {
		1146	my ($dir, $core) = @_;
		1147
		1148	opendir my $fh, $dir
		1149	or return;
		1150
		1151	for my $ext (readdir $fh) {
		1152	$ext !~ /^\./
		1153	or next;
		1154
		1155	open my $fh, "<", "$dir/$ext"
		1156	or next;
		1157
		1158	-f $fh
		1159	or next;
		1160
		1161	$ext =~ s/\.uext$// or $core
		1162	or next;
		1163
		1164	my %ext = (dir => $dir);
		1165
		1166	while (<$fh>) {
		1167	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1168	my ($pattern, $type, $desc) = split /:/, $1;
		1169	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1170	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1171	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1172	} else {
		1173	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1174	}
		1175	} elsif (/^\s*(?:#|$)/) {
		1176	# skip other comments and empty lines
		1177	} else {
		1178	last; # stop parsing on first non-empty non-comment line
		1179	}
		1180	}
		1181
		1182	$meta{ext}{$ext} = \%ext;
		1183	}
		1184	};
		1185
		1186	# $gather->($_, 0) for @cpandirs;
		1187	$gather->($_, 1) for @urxvtdirs;
		1188
		1189	# and now merge resources
		1190
		1191	$meta{resource} = \my %resource;
		1192
		1193	while (my ($k, $v) = each %{ $meta{ext} }) {
		1194	#TODO: should check for extensions overriding each other
		1195	%resource = (%resource, %{ $v->{resource} });
		1196	}
		1197	}
		1198
1138	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1199	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1139		1200
1140	Creates a new terminal, very similar as if you had started it with system	1201	Creates a new terminal, very similar as if you had started it with system
1141	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1202	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1142	hash which defines the environment of the new terminal.	1203	hash which defines the environment of the new terminal.
…		…
1159	}	1220	}
1160		1221
1161	=item $term->destroy	1222	=item $term->destroy
1162		1223
1163	Destroy the terminal object (close the window, free resources	1224	Destroy the terminal object (close the window, free resources
1164	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1225	etc.). Please note that urxvt will not exit as long as any event
1165	watchers (timers, io watchers) are still active.	1226	watchers (timers, io watchers) are still active.
1166		1227
1167	=item $term->exec_async ($cmd[, @args])	1228	=item $term->exec_async ($cmd[, @args])
1168		1229
1169	Works like the combination of the C<fork>/C<exec> builtins, which executes	1230	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1193		1254
1194	Returns true if the option specified by C<$optval> is enabled, and	1255	Returns true if the option specified by C<$optval> is enabled, and
1195	optionally change it. All option values are stored by name in the hash	1256	optionally change it. All option values are stored by name in the hash
1196	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1257	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1197		1258
1198	Here is a a likely non-exhaustive list of option names, please see the	1259	Here is a likely non-exhaustive list of option names, please see the
1199	source file F</src/optinc.h> to see the actual list:	1260	source file F</src/optinc.h> to see the actual list:
1200		1261
1201	borderLess console cursorBlink cursorUnderline hold iconic insecure	1262	borderLess buffered console cursorBlink cursorUnderline hold iconic
1202	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1263	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1203	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1264	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1204	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1265	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1205	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1266	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1206	transparent tripleclickwords utmpInhibit visualBell	1267	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1268	urgentOnBell utmpInhibit visualBell
1207		1269
1208	=item $value = $term->resource ($name[, $newval])	1270	=item $value = $term->resource ($name[, $newval])
1209		1271
1210	Returns the current resource value associated with a given name and	1272	Returns the current resource value associated with a given name and
1211	optionally sets a new value. Setting values is most useful in the C<init>	1273	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1220	likely change).	1282	likely change).
1221		1283
1222	Please note that resource strings will currently only be freed when the	1284	Please note that resource strings will currently only be freed when the
1223	terminal is destroyed, so changing options frequently will eat memory.	1285	terminal is destroyed, so changing options frequently will eat memory.
1224		1286
1225	Here is a a likely non-exhaustive list of resource names, not all of which	1287	Here is a likely non-exhaustive list of resource names, not all of which
1226	are supported in every build, please see the source file F</src/rsinc.h>	1288	are supported in every build, please see the source file F</src/rsinc.h>
1227	to see the actual list:	1289	to see the actual list:
1228		1290
1229	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1291	answerbackstring backgroundPixmap backspace_key blurradius
1230	borderLess color cursorBlink cursorUnderline cutchars delete_key	1292	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1231	display_name embed ext_bwidth fade font geometry hold iconName	1293	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1232	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1294	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1295	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1233	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1296	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1234	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1297	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1235	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1298	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1236	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1299	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1237	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1300	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1238	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1301	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1239	secondaryScreen secondaryScroll selectstyle shade term_name title	1302	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1240	transient_for transparent transparent_all tripleclickwords utmpInhibit	1303	term_name title transient_for transparent tripleclickwords urgentOnBell
1241	visualBell	1304	utmpInhibit visualBell
1242		1305
1243	=cut	1306	=cut
1244		1307
1245	sub resource($$;$) {	1308	sub resource($$;$) {
1246	my ($self, $name) = (shift, shift);	1309	my ($self, $name) = (shift, shift);
1247	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1310	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1248	&urxvt::term::_resource	1311	goto &urxvt::term::_resource
1249	}	1312	}
1250		1313
1251	=item $value = $term->x_resource ($pattern)	1314	=item $value = $term->x_resource ($pattern)
1252		1315
1253	Returns the X-Resource for the given pattern, excluding the program or	1316	Returns the X-Resource for the given pattern, excluding the program or
1254	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1317	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1255	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1318	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1256	resource with that pattern exists.	1319	resource with that pattern exists.
1257		1320
		1321	Extensions that define extra resources also need to call this method
		1322	to access their values.
		1323
		1324	If the method is called on an extension object (basically, from an
		1325	extension), then the special prefix C<%.> will be replaced by the name of
		1326	the extension and a dot, and the lone string C<%> will be replaced by the
		1327	extension name itself. This makes it possible to code extensions so you
		1328	can rename them and get a new set of resources without having to change
		1329	the actual code.
		1330
1258	This method should only be called during the C<on_start> hook, as there is	1331	This method should only be called during the C<on_start> hook, as there is
1259	only one resource database per display, and later invocations might return	1332	only one resource database per display, and later invocations might return
1260	the wrong resources.	1333	the wrong resources.
1261		1334
1262	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1335	=item $value = $term->x_resource_boolean ($pattern)
1263		1336
		1337	Like C<x_resource>, above, but interprets the string value as a boolean
		1338	and returns C<1> for true values, C<0> for false values and C<undef> if
		1339	the resource or option isn't specified.
		1340
		1341	You should always use this method to parse boolean resources.
		1342
		1343	=cut
		1344
		1345	sub x_resource_boolean {
		1346	my $res = &x_resource;
		1347
		1348	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1349	}
		1350
		1351	=item $action = $term->lookup_keysym ($keysym, $state)
		1352
		1353	Returns the action bound to key combination C<($keysym, $state)>,
		1354	if a binding for it exists, and C<undef> otherwise.
		1355
		1356	=item $success = $term->bind_action ($key, $action)
		1357
1264	Adds a keymap translation exactly as specified via a resource. See the	1358	Adds a key binding exactly as specified via a C<keysym> resource. See the
1265	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1359	C<keysym> resource in the urxvt(1) manpage.
		1360
		1361	To add default bindings for actions, an extension should call C<<
		1362	->bind_action >> in its C<init> hook for every such binding. Doing it
		1363	in the C<init> hook allows users to override or remove the binding
		1364	again.
		1365
		1366	Example: the C<searchable-scrollback> by default binds itself
		1367	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1368	$term->bind_action >>.
		1369
		1370	sub init {
		1371	my ($self) = @_;
		1372
		1373	$self->bind_action ("M-s" => "%:start");
		1374	}
1266		1375
1267	=item $rend = $term->rstyle ([$new_rstyle])	1376	=item $rend = $term->rstyle ([$new_rstyle])
1268		1377
1269	Return and optionally change the current rendition. Text that is output by	1378	Return and optionally change the current rendition. Text that is output by
1270	the terminal application will use this style.	1379	the terminal application will use this style.
…		…
1278		1387
1279	=item ($row, $col) = $term->selection_beg ([$row, $col])	1388	=item ($row, $col) = $term->selection_beg ([$row, $col])
1280		1389
1281	=item ($row, $col) = $term->selection_end ([$row, $col])	1390	=item ($row, $col) = $term->selection_end ([$row, $col])
1282		1391
1283	Return the current values of the selection mark, begin or end positions,	1392	Return the current values of the selection mark, begin or end positions.
1284	and optionally set them to new values.	1393
		1394	When arguments are given, then the selection coordinates are set to
		1395	C<$row> and C<$col>, and the selection screen is set to the current
		1396	screen.
		1397
		1398	=item $screen = $term->selection_screen ([$screen])
		1399
		1400	Returns the current selection screen, and then optionally sets it.
1285		1401
1286	=item $term->selection_make ($eventtime[, $rectangular])	1402	=item $term->selection_make ($eventtime[, $rectangular])
1287		1403
1288	Tries to make a selection as set by C<selection_beg> and	1404	Tries to make a selection as set by C<selection_beg> and
1289	C<selection_end>. If C<$rectangular> is true (default: false), a	1405	C<selection_end>. If C<$rectangular> is true (default: false), a
1290	rectangular selection will be made. This is the prefered function to make	1406	rectangular selection will be made. This is the preferred function to make
1291	a selection.	1407	a selection.
1292		1408
1293	=item $success = $term->selection_grab ($eventtime)	1409	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1294		1410
1295	Try to request the primary selection text from the server (for example, as	1411	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1412	true) selection from the server. The corresponding text can be set
1296	set by the next method). No visual feedback will be given. This function	1413	with the next method. No visual feedback will be given. This function
1297	is mostly useful from within C<on_sel_grab> hooks.	1414	is mostly useful from within C<on_sel_grab> hooks.
1298		1415
1299	=item $oldtext = $term->selection ([$newtext])	1416	=item $oldtext = $term->selection ([$newtext, $clipboard])
1300		1417
1301	Return the current selection text and optionally replace it by C<$newtext>.	1418	Return the current selection (clipboard if C<$clipboard> is true) text
		1419	and optionally replace it by C<$newtext>.
		1420
		1421	=item $term->selection_clear ([$clipboard])
		1422
		1423	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1302		1424
1303	=item $term->overlay_simple ($x, $y, $text)	1425	=item $term->overlay_simple ($x, $y, $text)
1304		1426
1305	Create a simple multi-line overlay box. See the next method for details.	1427	Create a simple multi-line overlay box. See the next method for details.
1306		1428
…		…
1336		1458
1337	The methods currently supported on C<urxvt::overlay> objects are:	1459	The methods currently supported on C<urxvt::overlay> objects are:
1338		1460
1339	=over 4	1461	=over 4
1340		1462
1341	=item $overlay->set ($x, $y, $text, $rend)	1463	=item $overlay->set ($x, $y, $text[, $rend])
1342		1464
1343	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1465	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1344	text in rxvt-unicode's special encoding and an array of rendition values	1466	text in rxvt-unicode's special encoding and an array of rendition values
1345	at a specific position inside the overlay.	1467	at a specific position inside the overlay.
		1468
		1469	If C<$rend> is missing, then the rendition will not be changed.
1346		1470
1347	=item $overlay->hide	1471	=item $overlay->hide
1348		1472
1349	If visible, hide the overlay, but do not destroy it.	1473	If visible, hide the overlay, but do not destroy it.
1350		1474
…		…
1413		1537
1414	=item $term->scr_add_lines ($string)	1538	=item $term->scr_add_lines ($string)
1415		1539
1416	Write the given text string to the screen, as if output by the application	1540	Write the given text string to the screen, as if output by the application
1417	running inside the terminal. It may not contain command sequences (escape	1541	running inside the terminal. It may not contain command sequences (escape
1418	codes), but is free to use line feeds, carriage returns and tabs. The	1542	codes - see C<cmd_parse> for that), but is free to use line feeds,
1419	string is a normal text string, not in locale-dependent encoding.	1543	carriage returns and tabs. The string is a normal text string, not in
		1544	locale-dependent encoding.
1420		1545
1421	Normally its not a good idea to use this function, as programs might be	1546	Normally its not a good idea to use this function, as programs might be
1422	confused by changes in cursor position or scrolling. Its useful inside a	1547	confused by changes in cursor position or scrolling. Its useful inside a
1423	C<on_add_lines> hook, though.	1548	C<on_add_lines> hook, though.
1424		1549
…		…
1432	locale-specific encoding of the terminal and can contain command sequences	1557	locale-specific encoding of the terminal and can contain command sequences
1433	(escape codes) that will be interpreted.	1558	(escape codes) that will be interpreted.
1434		1559
1435	=item $term->tt_write ($octets)	1560	=item $term->tt_write ($octets)
1436		1561
1437	Write the octets given in C<$data> to the tty (i.e. as program input). To	1562	Write the octets given in C<$octets> to the tty (i.e. as user input
		1563	to the program, see C<cmd_parse> for the opposite direction). To pass
1438	pass characters instead of octets, you should convert your strings first	1564	characters instead of octets, you should convert your strings first to the
1439	to the locale-specific encoding using C<< $term->locale_encode >>.	1565	locale-specific encoding using C<< $term->locale_encode >>.
		1566
		1567	=item $term->tt_write_user_input ($octets)
		1568
		1569	Like C<tt_write>, but should be used when writing strings in response to
		1570	the user pressing a key, to invoke the additional actions requested by
		1571	the user for that case (C<tt_write> doesn't do that).
		1572
		1573	The typical use case would be inside C<on_action> hooks.
		1574
		1575	=item $term->tt_paste ($octets)
		1576
		1577	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1578	CR and bracketing the data with control sequences if bracketed paste mode
		1579	is set.
1440		1580
1441	=item $old_events = $term->pty_ev_events ([$new_events])	1581	=item $old_events = $term->pty_ev_events ([$new_events])
1442		1582
1443	Replaces the event mask of the pty watcher by the given event mask. Can	1583	Replaces the event mask of the pty watcher by the given event mask. Can
1444	be used to suppress input and output handling to the pty/tty. See the	1584	be used to suppress input and output handling to the pty/tty. See the
…		…
1463	Adds the specified events to the vt event mask. Useful e.g. when you want	1603	Adds the specified events to the vt event mask. Useful e.g. when you want
1464	to receive pointer events all the times:	1604	to receive pointer events all the times:
1465		1605
1466	$term->vt_emask_add (urxvt::PointerMotionMask);	1606	$term->vt_emask_add (urxvt::PointerMotionMask);
1467		1607
		1608	=item $term->set_urgency ($set)
		1609
		1610	Enable/disable the urgency hint on the toplevel window.
		1611
1468	=item $term->focus_in	1612	=item $term->focus_in
1469		1613
1470	=item $term->focus_out	1614	=item $term->focus_out
1471		1615
1472	=item $term->key_press ($state, $keycode[, $time])	1616	=item $term->key_press ($state, $keycode[, $time])
…		…
1542		1686
1543	Returns the currently displayed screen (0 primary, 1 secondary).	1687	Returns the currently displayed screen (0 primary, 1 secondary).
1544		1688
1545	=item $cursor_is_hidden = $term->hidden_cursor	1689	=item $cursor_is_hidden = $term->hidden_cursor
1546		1690
1547	Returns wether the cursor is currently hidden or not.	1691	Returns whether the cursor is currently hidden or not.
1548		1692
1549	=item $view_start = $term->view_start ([$newvalue])	1693	=item $view_start = $term->view_start ([$newvalue])
1550		1694
1551	Returns the row number of the topmost displayed line. Maximum value is	1695	Returns the row number of the topmost displayed line. Maximum value is
1552	C<0>, which displays the normal terminal contents. Lower values scroll	1696	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1558	compare the on-screen display with its stored representation. If they	1702	compare the on-screen display with its stored representation. If they
1559	differ, it redraws the differences.	1703	differ, it redraws the differences.
1560		1704
1561	Used after changing terminal contents to display them.	1705	Used after changing terminal contents to display them.
1562		1706
		1707	=item $term->refresh_check
		1708
		1709	Checks if a refresh has been requested and, if so, schedules one.
		1710
1563	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1711	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1564		1712
1565	Returns the text of the entire row with number C<$row_number>. Row C<0>	1713	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1566	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1714	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1567	terminal line. The scrollback buffer starts at line C<-1> and extends to
1568	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1715	terminal line. Nothing will be returned if a nonexistent line
1569	is requested.	1716	is requested.
1570		1717
1571	If C<$new_text> is specified, it will replace characters in the current	1718	If C<$new_text> is specified, it will replace characters in the current
1572	line, starting at column C<$start_col> (default C<0>), which is useful	1719	line, starting at column C<$start_col> (default C<0>), which is useful
1573	to replace only parts of a line. The font index in the rendition will	1720	to replace only parts of a line. The font index in the rendition will
1574	automatically be updated.	1721	automatically be updated.
1575		1722
1576	C<$text> is in a special encoding: tabs and wide characters that use more	1723	C<$text> is in a special encoding: tabs and wide characters that use more
1577	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1724	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1578	characters. Characters with combining characters and other characters that	1725	characters. Characters with combining characters and other characters that
1579	do not fit into the normal tetx encoding will be replaced with characters	1726	do not fit into the normal text encoding will be replaced with characters
1580	in the private use area.	1727	in the private use area.
1581		1728
1582	You have to obey this encoding when changing text. The advantage is	1729	You have to obey this encoding when changing text. The advantage is
1583	that C<substr> and similar functions work on screen cells and not on	1730	that C<substr> and similar functions work on screen cells and not on
1584	characters.	1731	characters.
…		…
1669	}	1816	}
1670		1817
1671	sub urxvt::line::t {	1818	sub urxvt::line::t {
1672	my ($self) = @_;	1819	my ($self) = @_;
1673		1820
1674	if (@_ > 1)	1821	if (@_ > 1) {
1675	{
1676	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1822	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1677	for $self->{beg} .. $self->{end};	1823	for $self->{beg} .. $self->{end};
1678	}	1824	}
1679		1825
1680	defined wantarray &&	1826	defined wantarray &&
1681	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1827	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1682	0, $self->{len}	1828	0, $self->{len}
1683	}	1829	}
1684		1830
1685	sub urxvt::line::r {	1831	sub urxvt::line::r {
1686	my ($self) = @_;	1832	my ($self) = @_;
1687		1833
1688	if (@_ > 1)	1834	if (@_ > 1) {
1689	{
1690	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1835	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1691	for $self->{beg} .. $self->{end};	1836	for $self->{beg} .. $self->{end};
1692	}	1837	}
1693		1838
1694	if (defined wantarray) {	1839	if (defined wantarray) {
1695	my $rend = [	1840	my $rend = [
1696	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1841	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1697	];	1842	];
…		…
1729	where one character corresponds to one screen cell. See	1874	where one character corresponds to one screen cell. See
1730	C<< $term->ROW_t >> for details.	1875	C<< $term->ROW_t >> for details.
1731		1876
1732	=item $string = $term->special_decode $text	1877	=item $string = $term->special_decode $text
1733		1878
1734	Converts rxvt-unicodes text reprsentation into a perl string. See	1879	Converts rxvt-unicodes text representation into a perl string. See
1735	C<< $term->ROW_t >> for details.	1880	C<< $term->ROW_t >> for details.
1736		1881
1737	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1882	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1738		1883
1739	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1884	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1742	manpage.	1887	manpage.
1743		1888
1744	=item $success = $term->grab ($eventtime[, $sync])	1889	=item $success = $term->grab ($eventtime[, $sync])
1745		1890
1746	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1891	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1747	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1892	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1748		1893
1749	=item $term->allow_events_async	1894	=item $term->allow_events_async
1750		1895
1751	Calls XAllowEvents with AsyncBoth for the most recent grab.	1896	Calls XAllowEvents with AsyncBoth for the most recent grab.
1752		1897
…		…
1759	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1904	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1760	recent grab.	1905	recent grab.
1761		1906
1762	=item $term->ungrab	1907	=item $term->ungrab
1763		1908
1764	Calls XUngrab for the most recent grab. Is called automatically on	1909	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1765	evaluation errors, as it is better to lose the grab in the error case as	1910	evaluation errors, as it is better to lose the grab in the error case as
1766	the session.	1911	the session.
1767		1912
1768	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1913	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1769		1914
…		…
1771		1916
1772	=item @atoms = $term->XListProperties ($window)	1917	=item @atoms = $term->XListProperties ($window)
1773		1918
1774	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1919	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1775		1920
1776	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1921	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1777		1922
1778	=item $term->XDeleteProperty ($window, $property)	1923	=item $term->XDeleteProperty ($window, $property)
1779		1924
1780	=item $window = $term->DefaultRootWindow	1925	=item $window = $term->DefaultRootWindow
1781		1926
…		…
1788	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1933	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1789		1934
1790	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1935	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1791		1936
1792	=item $term->XChangeInput ($window, $add_events[, $del_events])	1937	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1938
		1939	=item $keysym = $term->XStringToKeysym ($string)
		1940
		1941	=item $string = $term->XKeysymToString ($keysym)
1793		1942
1794	Various X or X-related functions. The C<$term> object only serves as	1943	Various X or X-related functions. The C<$term> object only serves as
1795	the source of the display, otherwise those functions map more-or-less	1944	the source of the display, otherwise those functions map more-or-less
1796	directory onto the X functions of the same name.	1945	directly onto the X functions of the same name.
1797		1946
1798	=back	1947	=back
1799		1948
1800	=cut	1949	=cut
1801		1950
…		…
1903	my $env = $self->{term}->env;	2052	my $env = $self->{term}->env;
1904	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2053	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1905	delete $env->{LC_ALL};	2054	delete $env->{LC_ALL};
1906	$env->{LC_CTYPE} = $self->{term}->locale;	2055	$env->{LC_CTYPE} = $self->{term}->locale;
1907		2056
1908	urxvt::term->new ($env, "popup",	2057	my $term = urxvt::term->new (
		2058	$env, "popup",
1909	"--perl-lib" => "", "--perl-ext-common" => "",	2059	"--perl-lib" => "", "--perl-ext-common" => "",
1910	"-pty-fd" => -1, "-sl" => 0,	2060	"-pty-fd" => -1, "-sl" => 0,
1911	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2061	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1912	"--transient-for" => $self->{term}->parent,	2062	"--transient-for" => $self->{term}->parent,
1913	"-display" => $self->{term}->display_id,	2063	"-display" => $self->{term}->display_id,
1914	"-pe" => "urxvt-popup")	2064	"-pe" => "urxvt-popup",
1915	or die "unable to create popup window\n";	2065	) or die "unable to create popup window\n";
		2066
		2067	unless (delete $term->{urxvt_popup_init_done}) {
		2068	$term->ungrab;
		2069	$term->destroy;
		2070	die "unable to initialise popup window\n";
		2071	}
1916	}	2072	}
1917		2073
1918	sub DESTROY {	2074	sub DESTROY {
1919	my ($self) = @_;	2075	my ($self) = @_;
1920		2076
…		…
1925	=back	2081	=back
1926		2082
1927	=cut	2083	=cut
1928		2084
1929	package urxvt::watcher;	2085	package urxvt::watcher;
1930
1931	@urxvt::timer::ISA = __PACKAGE__;
1932	@urxvt::iow::ISA = __PACKAGE__;
1933	@urxvt::pw::ISA = __PACKAGE__;
1934	@urxvt::iw::ISA = __PACKAGE__;
1935		2086
1936	=head2 The C<urxvt::timer> Class	2087	=head2 The C<urxvt::timer> Class
1937		2088
1938	This class implements timer watchers/events. Time is represented as a	2089	This class implements timer watchers/events. Time is represented as a
1939	fractional number of seconds since the epoch. Example:	2090	fractional number of seconds since the epoch. Example:
…		…
1943	->new	2094	->new
1944	->interval (1)	2095	->interval (1)
1945	->cb (sub {	2096	->cb (sub {
1946	$term->{overlay}->set (0, 0,	2097	$term->{overlay}->set (0, 0,
1947	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2098	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1948	});	2099	});
1949		2100
1950	=over 4	2101	=over 4
1951		2102
1952	=item $timer = new urxvt::timer	2103	=item $timer = new urxvt::timer
1953		2104
…		…
1956		2107
1957	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2108	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1958		2109
1959	Set the callback to be called when the timer triggers.	2110	Set the callback to be called when the timer triggers.
1960		2111
1961	=item $tstamp = $timer->at
1962
1963	Return the time this watcher will fire next.
1964
1965	=item $timer = $timer->set ($tstamp)	2112	=item $timer = $timer->set ($tstamp[, $interval])
1966		2113
1967	Set the time the event is generated to $tstamp.	2114	Set the time the event is generated to $tstamp (and optionally specifies a
		2115	new $interval).
1968		2116
1969	=item $timer = $timer->interval ($interval)	2117	=item $timer = $timer->interval ($interval)
1970		2118
1971	Normally (and when C<$interval> is C<0>), the timer will automatically	2119	By default (and when C<$interval> is C<0>), the timer will automatically
1972	stop after it has fired once. If C<$interval> is non-zero, then the timer	2120	stop after it has fired once. If C<$interval> is non-zero, then the timer
1973	is automatically rescheduled at the given intervals.	2121	is automatically rescheduled at the given intervals.
1974		2122
1975	=item $timer = $timer->start	2123	=item $timer = $timer->start
1976		2124
1977	Start the timer.	2125	Start the timer.
1978		2126
1979	=item $timer = $timer->start ($tstamp)	2127	=item $timer = $timer->start ($tstamp[, $interval])
1980		2128
1981	Set the event trigger time to C<$tstamp> and start the timer.	2129	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2130	also replaces the interval.
1982		2131
1983	=item $timer = $timer->after ($delay)	2132	=item $timer = $timer->after ($delay[, $interval])
1984		2133
1985	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2134	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1986		2135
1987	=item $timer = $timer->stop	2136	=item $timer = $timer->stop
1988		2137
…		…
1996		2145
1997	$term->{socket} = ...	2146	$term->{socket} = ...
1998	$term->{iow} = urxvt::iow	2147	$term->{iow} = urxvt::iow
1999	->new	2148	->new
2000	->fd (fileno $term->{socket})	2149	->fd (fileno $term->{socket})
2001	->events (urxvt::EVENT_READ)	2150	->events (urxvt::EV_READ)
2002	->start	2151	->start
2003	->cb (sub {	2152	->cb (sub {
2004	my ($iow, $revents) = @_;	2153	my ($iow, $revents) = @_;
2005	# $revents must be 1 here, no need to check	2154	# $revents must be 1 here, no need to check
2006	sysread $term->{socket}, my $buf, 8192	2155	sysread $term->{socket}, my $buf, 8192
…		…
2019	Set the callback to be called when io events are triggered. C<$reventmask>	2168	Set the callback to be called when io events are triggered. C<$reventmask>
2020	is a bitset as described in the C<events> method.	2169	is a bitset as described in the C<events> method.
2021		2170
2022	=item $iow = $iow->fd ($fd)	2171	=item $iow = $iow->fd ($fd)
2023		2172
2024	Set the filedescriptor (not handle) to watch.	2173	Set the file descriptor (not handle) to watch.
2025		2174
2026	=item $iow = $iow->events ($eventmask)	2175	=item $iow = $iow->events ($eventmask)
2027		2176
2028	Set the event mask to watch. The only allowed values are	2177	Set the event mask to watch. The only allowed values are
2029	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2178	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2030	together, or C<urxvt::EVENT_NONE>.	2179	together, or C<urxvt::EV_NONE>.
2031		2180
2032	=item $iow = $iow->start	2181	=item $iow = $iow->start
2033		2182
2034	Start watching for requested events on the given handle.	2183	Start watching for requested events on the given handle.
2035		2184
2036	=item $iow = $iow->stop	2185	=item $iow = $iow->stop
2037		2186
2038	Stop watching for events on the given filehandle.	2187	Stop watching for events on the given file handle.
2039		2188
2040	=back	2189	=back
2041		2190
2042	=head2 The C<urxvt::iw> Class	2191	=head2 The C<urxvt::iw> Class
2043		2192
…		…
2076	->new	2225	->new
2077	->start ($pid)	2226	->start ($pid)
2078	->cb (sub {	2227	->cb (sub {
2079	my ($pw, $exit_status) = @_;	2228	my ($pw, $exit_status) = @_;
2080	...	2229	...
2081	});	2230	});
2082		2231
2083	=over 4	2232	=over 4
2084		2233
2085	=item $pw = new urxvt::pw	2234	=item $pw = new urxvt::pw
2086		2235
…		…
2090		2239
2091	Set the callback to be called when the timer triggers.	2240	Set the callback to be called when the timer triggers.
2092		2241
2093	=item $pw = $timer->start ($pid)	2242	=item $pw = $timer->start ($pid)
2094		2243
2095	Tells the wqtcher to start watching for process C<$pid>.	2244	Tells the watcher to start watching for process C<$pid>.
2096		2245
2097	=item $pw = $pw->stop	2246	=item $pw = $pw->stop
2098		2247
2099	Stop the watcher.	2248	Stop the watcher.
2100		2249
…		…
2113		2262
2114	=item >= 3 - script loading and management	2263	=item >= 3 - script loading and management
2115		2264
2116	=item >=10 - all called hooks	2265	=item >=10 - all called hooks
2117		2266
2118	=item >=11 - hook reutrn values	2267	=item >=11 - hook return values
2119		2268
2120	=back	2269	=back
2121		2270
2122	=head1 AUTHOR	2271	=head1 AUTHOR
2123		2272
2124	Marc Lehmann <pcg@goof.com>	2273	Marc Lehmann <schmorp@schmorp.de>
2125	http://software.schmorp.de/pkg/rxvt-unicode	2274	http://software.schmorp.de/pkg/rxvt-unicode
2126		2275
2127	=cut	2276	=cut
2128		2277
2129	1	2278	1
		2279
		2280	# vim: sw=3:

Diff Legend

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