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.136 by root, Mon Feb 20 20:44:22 2006 UTC vs.
Revision 1.255 by root, Wed Jun 17 11:59:37 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	=item readline (enabled by default)
157
158	A support package that tries to make editing with readline easier. At
159	the moment, it reacts to clicking shift-left mouse button by trying to
160	move the text cursor to this position. It does so by generating as many
161	cursor-left or cursor-right keypresses as required (the this only works
162	for programs that correctly support wide characters).
163
164	To avoid too many false positives, this is only done when:
165
166	=over 4
167
168	=item - the tty is in ICANON state.
169
170	=item - the text cursor is visible.
171
172	=item - the primary screen is currently being displayed.
173
174	=item - the mouse is on the same (multi-row-) line as the text cursor.
175
176	=back
177
178	The normal selection mechanism isn't disabled, so quick successive clicks
179	might interfere with selection creation in harmless ways.
180
181	=item selection-autotransform
182
183	This selection allows you to do automatic transforms on a selection
184	whenever a selection is made.
185
186	It works by specifying perl snippets (most useful is a single C<s///>
187	operator) that modify C<$_> as resources:
188
189	URxvt.selection-autotransform.0: transform
190	URxvt.selection-autotransform.1: transform
191	...
192
193	For example, the following will transform selections of the form
194	C<filename:number>, often seen in compiler messages, into C<vi +$filename
195	$word>:
196
197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
198
199	And this example matches the same,but replaces it with vi-commands you can
200	paste directly into your (vi :) editor:
201
202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
203
204	Of course, this can be modified to suit your needs and your editor :)
205
206	To expand the example above to typical perl error messages ("XXX at
207	FILENAME line YYY."), you need a slightly more elaborate solution:
208
209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
211
212	The first line tells the selection code to treat the unchanging part of
213	every error message as a selection pattern, and the second line transforms
214	the message into vi commands to load the file.
215
216	=item tabbed
217
218	This transforms the terminal into a tabbar with additional terminals, that
219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
221	button per tab.
222
223	Clicking a button will activate that tab. Pressing B<Shift-Left> and
224	B<Shift-Right> will switch to the tab left or right of the current one,
225	while B<Shift-Down> creates a new tab.
226
227	The tabbar itself can be configured similarly to a normal terminal, but
228	with a resource class of C<URxvt.tabbed>. In addition, it supports the
229	following four resources (shown with defaults):
230
231	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
232	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
233	URxvt.tabbed.tab-fg: <colour-index, default 0>
234	URxvt.tabbed.tab-bg: <colour-index, default 1>
235
236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237	indices.
238
239	=item mark-urls
240
241	Uses per-line display filtering (C<on_line_update>) to underline urls and
242	make them clickable. When middle-clicked, the program specified in the
243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
244	the URL as first argument.
245
246	=item xim-onthespot
247
248	This (experimental) perl extension implements OnTheSpot editing. It does
249	not work perfectly, and some input methods don't seem to work well with
250	OnTheSpot editing in general, but it seems to work at leats for SCIM and
251	kinput2.
252
253	You enable it by specifying this extension and a preedit style of
254	C<OnTheSpot>, i.e.:
255
256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257
258	=item automove-background
259
260	This is basically a one-line extension that dynamically changes the background pixmap offset
261	to the window position, in effect creating the same effect as pseudo transparency with
262	a custom pixmap. No scaling is supported in this mode. Exmaple:
263
264	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
265
266	=item block-graphics-to-ascii
267
268	A not very useful example of filtering all text output to the terminal,
269	by replacing all line-drawing characters (U+2500 .. U+259F) by a
270	similar-looking ascii character.
271
272	=item digital-clock
273
274	Displays a digital clock using the built-in overlay.
275
276	=item remote-clipboard
277
278	Somewhat of a misnomer, this extension adds two menu entries to the
279	selection popup that allows one ti run external commands to store the
280	selection somewhere and fetch it again.
281
282	We use it to implement a "distributed selection mechanism", which just
283	means that one command uploads the file to a remote server, and another
284	reads it.
285
286	The commands can be set using the C<URxvt.remote-selection.store> and
287	C<URxvt.remote-selection.fetch> resources. The first should read the
288	selection to store from STDIN (always in UTF-8), the second should provide
289	the selection data on STDOUT (also in UTF-8).
290
291	The defaults (which are likely useless to you) use rsh and cat:
292
293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
295
296	=item selection-pastebin
297
298	This is a little rarely useful extension that Uploads the selection as
299	textfile to a remote site (or does other things). (The implementation is
300	not currently secure for use in a multiuser environment as it writes to
301	F</tmp> directly.).
302
303	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
304	i.e.
305
306	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
307
308	Pressing this combination runs a command with C<%> replaced by the name of
309	the textfile. This command can be set via a resource:
310
311	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
312
313	And the default is likely not useful to anybody but the few people around
314	here :)
315
316	The name of the textfile is the hex encoded md5 sum of the selection, so
317	the same content should lead to the same filename.
318
319	After a successful upload the selection will be replaced by the text given
320	in the C<selection-pastebin-url> resource (again, the % is the placeholder
321	for the filename):
322
323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
324
325	=item example-refresh-hooks
326
327	Displays a very simple digital clock in the upper right corner of the
328	window. Illustrates overwriting the refresh callbacks to create your own
329	overlays or changes.
330
331	=back
332		56
333	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
334		58
335	=head2 General API Considerations	59	=head2 General API Considerations
336		60
…		…
350		74
351	=over 4	75	=over 4
352		76
353	=item $text	77	=item $text
354		78
355	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
356	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.
357		81
358	=item $string	82	=item $string
359		83
360	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
…		…
364	=item $octets	88	=item $octets
365		89
366	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
367	locale-specific way.	91	locale-specific way.
368		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
369	=back	99	=back
370		100
371	=head2 Extension Objects	101	=head2 Extension Objects
372		102
373	Very perl extension is a perl class. A separate perl object is created	103	Every perl extension is a perl class. A separate perl object is created
374	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,
375	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
376	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
377	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
378	use.	109	internal use.
379		110
380	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
381	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
382		113
383	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:
384		123
385	=over 4	124	=over 4
386		125
387	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
388		127
389	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
390	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>
391		130	or C<string>, and C<desc> is the resource description.
392	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
393
394	Dynamically enable the given hooks (named without the C<on_> prefix) for
395	this extension, replacing any previous hook. This is useful when you want
396	to overwrite time-critical hooks only temporarily.
397
398	=item $self->disable ($hook_name[, $hook_name..])
399
400	Dynamically disable the given hooks.
401		131
402	=back	132	=back
403		133
404	=head2 Hooks	134	=head2 Hooks
405		135
406	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
407	called whenever the relevant event happens.	137	called whenever the relevant event happens.
408		138
409	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
410	the in the C<Extension Objects> section.	140	the in the C<Extension Objects> section.
411		141
412	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
413	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
414	relevant action might not be carried out by the C++ code.	144	relevant action might not be carried out by the C++ code.
…		…
427	place.	157	place.
428		158
429	=item on_start $term	159	=item on_start $term
430		160
431	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
432	trying to map (display) the toplevel and returning to the mainloop.	162	trying to map (display) the toplevel and returning to the main loop.
433		163
434	=item on_destroy $term	164	=item on_destroy $term
435		165
436	Called whenever something tries to destroy terminal, when the terminal is	166	Called whenever something tries to destroy terminal, when the terminal is
437	still fully functional (not for long, though).	167	still fully functional (not for long, though).
…		…
464		194
465	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
466	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
467	by calling C<< $term->selection >>.	197	by calling C<< $term->selection >>.
468		198
469	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.
470		200
471	=item on_sel_extend $term	201	=item on_sel_extend $term
472		202
473	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
474	click) and is either supposed to return false (normal operation), or	204	click) and is either supposed to return false (normal operation), or
475	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
476	processing. This can happen multiple times, as long as the callback	206	processing. This can happen multiple times, as long as the callback
477	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
478	supposed to enlarge the selection more and more, if possible.	208	supposed to enlarge the selection more and more, if possible.
479		209
480	See the F<selection> example extension.	210	See the F<selection> example extension.
481		211
482	=item on_view_change $term, $offset	212	=item on_view_change $term, $offset
483		213
484	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
485	scrolls. Offset C<0> means display the normal terminal, positive values	215	scrolls. Offset C<0> means display the normal terminal, positive values
486	show this many lines of scrollback.	216	show this many lines of scrollback.
487		217
488	=item on_scroll_back $term, $lines, $saved	218	=item on_scroll_back $term, $lines, $saved
489		219
…		…
493		223
494	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,
495	$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
496	number of lines that will be in the scrollback buffer.	226	number of lines that will be in the scrollback buffer.
497		227
498	=item on_osc_seq $term, $string	228	=item on_osc_seq $term, $op, $args, $resp
		229
		230	Called on every OSC sequence and can be used to suppress it or modify its
		231	behaviour. The default should be to return an empty list. A true value
		232	suppresses execution of the request completely. Make sure you don't get
		233	confused by recursive invocations when you output an OSC sequence within
		234	this callback.
		235
		236	C<on_osc_seq_perl> should be used for new behaviour.
		237
		238	=item on_osc_seq_perl $term, $args, $resp
499		239
500	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	240	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
501	operating system command) is processed. Cursor position and other state	241	operating system command) is processed. Cursor position and other state
502	information is up-to-date when this happens. For interoperability, the	242	information is up-to-date when this happens. For interoperability, the
503	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,
504	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
505	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	}
506		256
507	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,
508	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
509	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.
510		263
511	=item on_add_lines $term, $string	264	=item on_add_lines $term, $string
512		265
513	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
514	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
…		…
519	=item on_tt_write $term, $octets	272	=item on_tt_write $term, $octets
520		273
521	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
522	suppress or filter tty input.	275	suppress or filter tty input.
523		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
524	=item on_line_update $term, $row	284	=item on_line_update $term, $row
525		285
526	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
527	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
528	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,
…		…
535	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
536	you cannot just toggle rendition bits, but only set them.	296	you cannot just toggle rendition bits, but only set them.
537		297
538	=item on_refresh_begin $term	298	=item on_refresh_begin $term
539		299
540	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
541	or similar effects by modify terminal contents in refresh_begin, and	301	similar effects by modifying the terminal contents in refresh_begin, and
542	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
543	code is run after this hook, and takes precedence.	303	code is run after this hook, and takes precedence.
544		304
545	=item on_refresh_end $term	305	=item on_refresh_end $term
546		306
547	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>.
548		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
549	=item on_user_command $term, $string	317	=item on_user_command $term, $string *DEPRECATED*
550		318
551	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
552	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>
553	resource in the @@RXVT_NAME@@(1) manpage).	321	resource in the urxvt(1) manpage).
554		322
555	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
556	slightly in the future.	324	preference to the C<on_action> hook.
557		325
558	=item on_resize_all_windows $tern, $new_width, $new_height	326	=item on_resize_all_windows $term, $new_width, $new_height
559		327
560	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
561	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
562	returns TRUE, setting of the window hints is being skipped.	330	returns a true value, setting of the window hints is being skipped.
563		331
564	=item on_x_event $term, $event	332	=item on_x_event $term, $event
565		333
566	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
567	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
568	members are not passed.	336	members are not passed.
569		337
		338	=item on_root_event $term, $event
		339
		340	Like C<on_x_event>, but is called for events on the root window.
		341
570	=item on_focus_in $term	342	=item on_focus_in $term
571		343
572	Called whenever the window gets the keyboard focus, before rxvt-unicode	344	Called whenever the window gets the keyboard focus, before rxvt-unicode
573	does focus in processing.	345	does focus in processing.
574		346
575	=item on_focus_out $term	347	=item on_focus_out $term
576		348
577	Called wheneever the window loses keyboard focus, before rxvt-unicode does	349	Called whenever the window loses keyboard focus, before rxvt-unicode does
578	focus out processing.	350	focus out processing.
579		351
580	=item on_configure_notify $term, $event	352	=item on_configure_notify $term, $event
581		353
582	=item on_property_notify $term, $event	354	=item on_property_notify $term, $event
…		…
593		365
594	=item on_map_notify $term, $event	366	=item on_map_notify $term, $event
595		367
596	=item on_unmap_notify $term, $event	368	=item on_unmap_notify $term, $event
597		369
598	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
599	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.
600		372
601	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
602	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
603	(real, not screen-based) row and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
604		376
605	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
606	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
607		379
608	subwindow.
609
610	=item on_client_message $term, $event	380	=item on_client_message $term, $event
611		381
612	=item on_wm_protocols $term, $event	382	=item on_wm_protocols $term, $event
613		383
614	=item on_wm_delete_window $term, $event	384	=item on_wm_delete_window $term, $event
615		385
616	Called when various types of ClientMessage events are received (all with	386	Called when various types of ClientMessage events are received (all with
617	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	387	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
618		388
		389	=item on_bell $term
		390
		391	Called on receipt of a bell character.
		392
619	=back	393	=back
620		394
621	=cut	395	=cut
622		396
623	package urxvt;	397	package urxvt;
624		398
625	use utf8;	399	use utf8;
626	use strict;	400	use strict 'vars';
627	use Carp ();	401	use Carp ();
628	use Scalar::Util ();	402	use Scalar::Util ();
629	use List::Util ();	403	use List::Util ();
630		404
631	our $VERSION = 1;	405	our $VERSION = 1;
632	our $TERM;	406	our $TERM;
633	our @TERM_INIT;	407	our @TERM_INIT; # should go, prevents async I/O etc.
634	our @TERM_EXT;	408	our @TERM_EXT; # should go, prevents async I/O etc.
635	our @HOOKNAME;	409	our @HOOKNAME;
636	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	410	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
637	our %OPTION;	411	our %OPTION;
638		412
639	our $LIBDIR;	413	our $LIBDIR;
…		…
665	The current terminal. This variable stores the current C<urxvt::term>	439	The current terminal. This variable stores the current C<urxvt::term>
666	object, whenever a callback/hook is executing.	440	object, whenever a callback/hook is executing.
667		441
668	=item @urxvt::TERM_INIT	442	=item @urxvt::TERM_INIT
669		443
670	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
671	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
672	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,
673	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.
674		448
675	This complements to the perl-eval commandline option, but gets executed	449	This complements to the perl-eval command line option, but gets executed
676	first.	450	first.
677		451
678	=item @urxvt::TERM_EXT	452	=item @urxvt::TERM_EXT
679		453
680	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
…		…
687		461
688	=over 4	462	=over 4
689		463
690	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
691		465
692	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
693	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
694	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
695		470
696	=item urxvt::warn $string	471	=item urxvt::warn $string
697		472
698	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
699	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
700	that calls this function.	475	that calls this function.
701		476
702	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
703	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
705	Messages have a size limit of 1023 bytes currently.	480	Messages have a size limit of 1023 bytes currently.
706		481
707	=item @terms = urxvt::termlist	482	=item @terms = urxvt::termlist
708		483
709	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
710	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
711	objects that have perl extensions attached will be returned (because there	486	objects that have perl extensions attached will be returned (because there
712	is no urxvt::term objet associated with others).	487	is no urxvt::term object associated with others).
713		488
714	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
715		490
716	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
717		492
…		…
760		535
761	=item $rend = urxvt::OVERLAY_RSTYLE	536	=item $rend = urxvt::OVERLAY_RSTYLE
762		537
763	Return the rendition mask used for overlays by default.	538	Return the rendition mask used for overlays by default.
764		539
765	=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
766		542
767	Return the bit that enabled bold, italic, blink, reverse-video and	543	Return the bit that enabled bold, italic, blink, reverse-video and
768	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
769	the bitset.	545	the bitset.
770		546
…		…
807	};	583	};
808	}	584	}
809		585
810	no warnings 'utf8';	586	no warnings 'utf8';
811		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
812	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	650	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
813		651
814	sub verbose {	652	sub verbose {
815	my ($level, $msg) = @_;	653	my ($level, $msg) = @_;
816	warn "$msg\n" if $level <= $verbosity;	654	warn "$msg\n" if $level <= $verbosity;
…		…
828	$pkg =~ s/[^[:word:]]/_/g;	666	$pkg =~ s/[^[:word:]]/_/g;
829	$pkg = "urxvt::ext::$pkg";	667	$pkg = "urxvt::ext::$pkg";
830		668
831	verbose 3, "loading extension '$path' into package '$pkg'";	669	verbose 3, "loading extension '$path' into package '$pkg'";
832		670
		671	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		672
833	open my $fh, "<:raw", $path	673	open my $fh, "<:raw", $path
834	or die "$path: $!";	674	or die "$path: $!";
835		675
836	my $source =	676	my $source =
837	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	677	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
838	. "#line 1 \"$path\"\n{\n"	678	. "#line 1 \"$path\"\n{\n"
839	. (do { local $/; <$fh> })	679	. (do { local $/; <$fh> })
840	. "\n};\n1";	680	. "\n};\n1";
841		681
842	eval $source	682	eval $source
…		…
851	# called by the rxvt core	691	# called by the rxvt core
852	sub invoke {	692	sub invoke {
853	local $TERM = shift;	693	local $TERM = shift;
854	my $htype = shift;	694	my $htype = shift;
855		695
856	if ($htype == 0) { # INIT	696	if ($htype == HOOK_INIT) {
857	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	697	my @dirs = $TERM->perl_libdirs;
858		698
		699	$TERM->scan_extensions;
		700
859	my %ext_arg;	701	my %ext_arg;
860		702
861	{	703	{
862	my @init = @TERM_INIT;	704	my @init = @TERM_INIT;
863	@TERM_INIT = ();	705	@TERM_INIT = ();
…		…
865	my @pkg = @TERM_EXT;	707	my @pkg = @TERM_EXT;
866	@TERM_EXT = ();	708	@TERM_EXT = ();
867	$TERM->register_package ($_) for @pkg;	709	$TERM->register_package ($_) for @pkg;
868	}	710	}
869		711
		712	for (
870	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	) {
871	if ($_ eq "default") {	716	if ($_ eq "default") {
		717
		718	$ext_arg{$_} = []
872	$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
873	} elsif (/^-(.*)$/) {	730	} elsif (/^-(.*)$/) {
874	delete $ext_arg{$1};	731	delete $ext_arg{$1};
		732
875	} elsif (/^([^<]+)<(.*)>$/) {	733	} elsif (/^([^<]+)<(.*)>$/) {
876	push @{ $ext_arg{$1} }, $2;	734	push @{ $ext_arg{$1} }, $2;
		735
877	} else {	736	} else {
878	$ext_arg{$_} ||= [];	737	$ext_arg{$_} ||= [];
879	}	738	}
880	}	739	}
881		740
…		…
897		756
898	if (my $cb = $TERM->{_hook}[$htype]) {	757	if (my $cb = $TERM->{_hook}[$htype]) {
899	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	758	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
900	if $verbosity >= 10;	759	if $verbosity >= 10;
901		760
902	keys %$cb;	761	if ($htype == HOOK_ACTION) {
		762	# this hook is only sent to the extension with the name
		763	# matching the first arg
		764	my $pkg = shift;
		765	$pkg =~ y/-/_/;
		766	$pkg = "urxvt::ext::$pkg";
903		767
904	while (my ($pkg, $cb) = each %$cb) {	768	$cb = $cb->{$pkg}
		769	or return undef; #TODO: maybe warn user?
		770
		771	$cb = { $pkg => $cb };
		772	}
		773
		774	for my $pkg (keys %$cb) {
905	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	775	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
906	$retval ||= $retval_;	776	$retval ||= $retval_;
907		777
908	if ($@) {	778	if ($@) {
909	$TERM->ungrab; # better to lose the grab than the session	779	$TERM->ungrab; # better to lose the grab than the session
910	warn $@;	780	warn $@;
…		…
913		783
914	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	784	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
915	if $verbosity >= 11;	785	if $verbosity >= 11;
916	}	786	}
917		787
918	if ($htype == 1) { # DESTROY	788	if ($htype == HOOK_DESTROY) {
919	# clear package objects	789	# clear package objects
920	%$_ = () for values %{ $TERM->{_pkg} };	790	%$_ = () for values %{ $TERM->{_pkg} };
921		791
922	# clear package	792	# clear package
923	%$TERM = ();	793	%$TERM = ();
…		…
928		798
929	sub SET_COLOR($$$) {	799	sub SET_COLOR($$$) {
930	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	800	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
931	}	801	}
932		802
933	# 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	}
934		827
935	package urxvt::term::extension;	828	package urxvt::term::extension;
936		829
937	sub enable {	830	=head2 The C<urxvt::term::extension> class
938	my ($self, %hook) = @_;
939	my $pkg = $self->{_pkg};
940		831
941	while (my ($name, $cb) = each %hook) {	832	Each extension attached to a terminal object is represented by
942	my $htype = $HOOKTYPE{uc $name};	833	a C<urxvt::term::extension> object.
943	defined $htype
944	or Carp::croak "unsupported hook type '$name'";
945		834
946	$self->set_should_invoke ($htype, +1)	835	You can use these objects, which are passed to all callbacks to store any
947	unless exists $self->{term}{_hook}[$htype]{$pkg};	836	state related to the terminal and extension instance.
948		837
949	$self->{term}{_hook}[$htype]{$pkg} = $cb;	838	The methods (And data members) documented below can be called on extension
950	}	839	objects, in addition to call methods documented for the <urxvt::term>
951	}	840	class.
952		841
953	sub disable {	842	=over 4
954	my ($self, @hook) = @_;
955	my $pkg = $self->{_pkg};
956		843
957	for my $name (@hook) {	844	=item $urxvt_term = $self->{term}
958	my $htype = $HOOKTYPE{uc $name};
959	defined $htype
960	or Carp::croak "unsupported hook type '$name'";
961		845
962	$self->set_should_invoke ($htype, -1)	846	Returns the C<urxvt::term> object associated with this instance of the
963	if delete $self->{term}{_hook}[$htype]{$pkg};	847	extension. This member I<must not> be changed in any way.
964	}	848
965	}	849	=cut
966		850
967	our $AUTOLOAD;	851	our $AUTOLOAD;
968		852
969	sub AUTOLOAD {	853	sub AUTOLOAD {
970	$AUTOLOAD =~ /:([^:]+)$/	854	$AUTOLOAD =~ /:([^:]+)$/
…		…
983		867
984	sub DESTROY {	868	sub DESTROY {
985	# nop	869	# nop
986	}	870	}
987		871
988	# urxvt::destroy_hook	872	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
989		873
990	sub urxvt::destroy_hook::DESTROY {	874	sub urxvt::destroy_hook::DESTROY {
991	${$_[0]}->();	875	${$_[0]}->();
992	}	876	}
993		877
994	sub urxvt::destroy_hook(&) {	878	sub urxvt::destroy_hook(&) {
995	bless \shift, urxvt::destroy_hook::	879	bless \shift, urxvt::destroy_hook::
996	}	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
997		1004
998	package urxvt::anyevent;	1005	package urxvt::anyevent;
999		1006
1000	=head2 The C<urxvt::anyevent> Class	1007	=head2 The C<urxvt::anyevent> Class
1001		1008
1002	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
1003	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
1004	further programming. The only exception is that you cannot wait on	1011	further programming. The only exception is that you cannot wait on
1005	condition variables, but non-blocking condvar use is ok. What this means	1012	condition variables, but non-blocking condvar use is ok.
1006	is that you cannot use blocking APIs, but the non-blocking variant should
1007	work.
1008		1013
1009	=cut	1014	In practical terms this means is that you cannot use blocking APIs, but
		1015	the non-blocking variant should work.
1010		1016
		1017	=cut
		1018
1011	our $VERSION = 1;	1019	our $VERSION = '5.23';
1012		1020
1013	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1021	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1014	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1022	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1015		1023
1016	sub timer {	1024	sub timer {
…		…
1018		1026
1019	my $cb = $arg{cb};	1027	my $cb = $arg{cb};
1020		1028
1021	urxvt::timer	1029	urxvt::timer
1022	->new	1030	->new
1023	->start (urxvt::NOW + $arg{after})	1031	->after ($arg{after}, $arg{interval})
1024	->cb (sub {	1032	->cb ($arg{interval} ? $cb : sub {
1025	$_[0]->stop; # need to cancel manually	1033	$_[0]->stop; # need to cancel manually
1026	$cb->();	1034	$cb->();
1027	})	1035	})
1028	}	1036	}
1029		1037
1030	sub io {	1038	sub io {
1031	my ($class, %arg) = @_;	1039	my ($class, %arg) = @_;
1032		1040
1033	my $cb = $arg{cb};	1041	my $cb = $arg{cb};
		1042	my $fd = fileno $arg{fh};
		1043	defined $fd or $fd = $arg{fh};
1034		1044
1035	bless [$arg{fh}, urxvt::iow	1045	bless [$arg{fh}, urxvt::iow
1036	->new	1046	->new
1037	->fd (fileno $arg{fh})	1047	->fd ($fd)
1038	->events (($arg{poll} =~ /r/ ? 1 : 0)	1048	->events (($arg{poll} =~ /r/ ? 1 : 0)
1039	| ($arg{poll} =~ /w/ ? 2 : 0))	1049	| ($arg{poll} =~ /w/ ? 2 : 0))
1040	->start	1050	->start
1041	->cb (sub {	1051	->cb ($cb)
1042	$cb->(($_[1] & 1 ? 'r' : '')
1043	. ($_[1] & 2 ? 'w' : ''));
1044	})],
1045	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	})
1046	}	1078	}
1047		1079
1048	sub DESTROY {	1080	sub DESTROY {
1049	$_[0][1]->stop;	1081	$_[0][1]->stop;
1050	}	1082	}
1051		1083
1052	sub condvar {	1084	# only needed for AnyEvent < 6 compatibility
1053	bless \my $flag, urxvt::anyevent::condvar::	1085	sub one_event {
1054	}
1055
1056	sub urxvt::anyevent::condvar::broadcast {
1057	${$_[0]}++;
1058	}
1059
1060	sub urxvt::anyevent::condvar::wait {
1061	unless (${$_[0]}) {
1062	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";
1063	}
1064	}	1087	}
1065		1088
1066	package urxvt::term;	1089	package urxvt::term;
1067		1090
1068	=head2 The C<urxvt::term> Class	1091	=head2 The C<urxvt::term> Class
…		…
1081	urxvt::verbose 6, "register package $pkg to $self";	1104	urxvt::verbose 6, "register package $pkg to $self";
1082		1105
1083	@{"$pkg\::ISA"} = urxvt::term::extension::;	1106	@{"$pkg\::ISA"} = urxvt::term::extension::;
1084		1107
1085	my $proxy = bless {	1108	my $proxy = bless {
1086	_pkg => $pkg,	1109	_pkg => $pkg,
		1110	_name => ${"$pkg\::_NAME"}, # hackish
1087	argv => $argv,	1111	argv => $argv,
1088	}, $pkg;	1112	}, $pkg;
1089	Scalar::Util::weaken ($proxy->{term} = $self);	1113	Scalar::Util::weaken ($proxy->{term} = $self);
1090		1114
1091	$self->{_pkg}{$pkg} = $proxy;	1115	$self->{_pkg}{$pkg} = $proxy;
1092		1116
…		…
1095	$proxy->enable ($name => $ref);	1119	$proxy->enable ($name => $ref);
1096	}	1120	}
1097	}	1121	}
1098	}	1122	}
1099		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
1100	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1199	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1101		1200
1102	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
1103	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
1104	hash which defines the environment of the new terminal.	1203	hash which defines the environment of the new terminal.
…		…
1121	}	1220	}
1122		1221
1123	=item $term->destroy	1222	=item $term->destroy
1124		1223
1125	Destroy the terminal object (close the window, free resources	1224	Destroy the terminal object (close the window, free resources
1126	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
1127	watchers (timers, io watchers) are still active.	1226	watchers (timers, io watchers) are still active.
1128		1227
1129	=item $term->exec_async ($cmd[, @args])	1228	=item $term->exec_async ($cmd[, @args])
1130		1229
1131	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
…		…
1155		1254
1156	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
1157	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
1158	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.
1159		1258
1160	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
1161	source file F</src/optinc.h> to see the actual list:	1260	source file F</src/optinc.h> to see the actual list:
1162		1261
1163	borderLess console cursorBlink cursorUnderline hold iconic insecure	1262	borderLess buffered console cursorBlink cursorUnderline hold iconic
1164	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1263	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1165	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1264	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1166	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1265	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1167	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1266	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1168	transparent tripleclickwords utmpInhibit visualBell	1267	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1268	urgentOnBell utmpInhibit visualBell
1169		1269
1170	=item $value = $term->resource ($name[, $newval])	1270	=item $value = $term->resource ($name[, $newval])
1171		1271
1172	Returns the current resource value associated with a given name and	1272	Returns the current resource value associated with a given name and
1173	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>
…		…
1182	likely change).	1282	likely change).
1183		1283
1184	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
1185	terminal is destroyed, so changing options frequently will eat memory.	1285	terminal is destroyed, so changing options frequently will eat memory.
1186		1286
1187	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
1188	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>
1189	to see the actual list:	1289	to see the actual list:
1190		1290
1191	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1291	answerbackstring backgroundPixmap backspace_key blurradius
1192	borderLess color cursorBlink cursorUnderline cutchars delete_key	1292	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1193	display_name embed ext_bwidth fade font geometry hold iconName	1293	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1194	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
1195	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1296	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1196	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1297	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1197	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1298	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1198	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1299	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1199	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1300	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1200	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1301	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1201	secondaryScreen secondaryScroll selectstyle shade term_name title	1302	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1202	transient_for transparent transparent_all tripleclickwords utmpInhibit	1303	term_name title transient_for transparent tripleclickwords urgentOnBell
1203	visualBell	1304	utmpInhibit visualBell
1204		1305
1205	=cut	1306	=cut
1206		1307
1207	sub resource($$;$) {	1308	sub resource($$;$) {
1208	my ($self, $name) = (shift, shift);	1309	my ($self, $name) = (shift, shift);
1209	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1310	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1210	&urxvt::term::_resource	1311	goto &urxvt::term::_resource
1211	}	1312	}
1212		1313
1213	=item $value = $term->x_resource ($pattern)	1314	=item $value = $term->x_resource ($pattern)
1214		1315
1215	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
1216	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
1217	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
1218	resource with that pattern exists.	1319	resource with that pattern exists.
1219		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
1220	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
1221	only one resource database per display, and later invocations might return	1332	only one resource database per display, and later invocations might return
1222	the wrong resources.	1333	the wrong resources.
1223		1334
1224	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1335	=item $value = $term->x_resource_boolean ($pattern)
1225		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
1226	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
1227	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	}
1228		1375
1229	=item $rend = $term->rstyle ([$new_rstyle])	1376	=item $rend = $term->rstyle ([$new_rstyle])
1230		1377
1231	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
1232	the terminal application will use this style.	1379	the terminal application will use this style.
…		…
1240		1387
1241	=item ($row, $col) = $term->selection_beg ([$row, $col])	1388	=item ($row, $col) = $term->selection_beg ([$row, $col])
1242		1389
1243	=item ($row, $col) = $term->selection_end ([$row, $col])	1390	=item ($row, $col) = $term->selection_end ([$row, $col])
1244		1391
1245	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.
1246	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.
1247		1401
1248	=item $term->selection_make ($eventtime[, $rectangular])	1402	=item $term->selection_make ($eventtime[, $rectangular])
1249		1403
1250	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
1251	C<selection_end>. If C<$rectangular> is true (default: false), a	1405	C<selection_end>. If C<$rectangular> is true (default: false), a
1252	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
1253	a selection.	1407	a selection.
1254		1408
1255	=item $success = $term->selection_grab ($eventtime)	1409	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1256		1410
1257	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
1258	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
1259	is mostly useful from within C<on_sel_grab> hooks.	1414	is mostly useful from within C<on_sel_grab> hooks.
1260		1415
1261	=item $oldtext = $term->selection ([$newtext])	1416	=item $oldtext = $term->selection ([$newtext, $clipboard])
1262		1417
1263	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.
1264		1424
1265	=item $term->overlay_simple ($x, $y, $text)	1425	=item $term->overlay_simple ($x, $y, $text)
1266		1426
1267	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.
1268		1428
…		…
1298		1458
1299	The methods currently supported on C<urxvt::overlay> objects are:	1459	The methods currently supported on C<urxvt::overlay> objects are:
1300		1460
1301	=over 4	1461	=over 4
1302		1462
1303	=item $overlay->set ($x, $y, $text, $rend)	1463	=item $overlay->set ($x, $y, $text[, $rend])
1304		1464
1305	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
1306	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
1307	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.
1308		1470
1309	=item $overlay->hide	1471	=item $overlay->hide
1310		1472
1311	If visible, hide the overlay, but do not destroy it.	1473	If visible, hide the overlay, but do not destroy it.
1312		1474
…		…
1375		1537
1376	=item $term->scr_add_lines ($string)	1538	=item $term->scr_add_lines ($string)
1377		1539
1378	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
1379	running inside the terminal. It may not contain command sequences (escape	1541	running inside the terminal. It may not contain command sequences (escape
1380	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,
1381	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.
1382		1545
1383	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
1384	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
1385	C<on_add_lines> hook, though.	1548	C<on_add_lines> hook, though.
1386		1549
…		…
1394	locale-specific encoding of the terminal and can contain command sequences	1557	locale-specific encoding of the terminal and can contain command sequences
1395	(escape codes) that will be interpreted.	1558	(escape codes) that will be interpreted.
1396		1559
1397	=item $term->tt_write ($octets)	1560	=item $term->tt_write ($octets)
1398		1561
1399	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
1400	pass characters instead of octets, you should convert your strings first	1564	characters instead of octets, you should convert your strings first to the
1401	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.
1402		1580
1403	=item $old_events = $term->pty_ev_events ([$new_events])	1581	=item $old_events = $term->pty_ev_events ([$new_events])
1404		1582
1405	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
1406	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
…		…
1425	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
1426	to receive pointer events all the times:	1604	to receive pointer events all the times:
1427		1605
1428	$term->vt_emask_add (urxvt::PointerMotionMask);	1606	$term->vt_emask_add (urxvt::PointerMotionMask);
1429		1607
		1608	=item $term->set_urgency ($set)
		1609
		1610	Enable/disable the urgency hint on the toplevel window.
		1611
1430	=item $term->focus_in	1612	=item $term->focus_in
1431		1613
1432	=item $term->focus_out	1614	=item $term->focus_out
1433		1615
1434	=item $term->key_press ($state, $keycode[, $time])	1616	=item $term->key_press ($state, $keycode[, $time])
1435		1617
1436	=item $term->key_release ($state, $keycode[, $time])	1618	=item $term->key_release ($state, $keycode[, $time])
1437		1619
1438	Deliver various fake events to to terminal.	1620	Deliver various fake events to to terminal.
1439		1621
1440	=item $window_width = $term->width	1622	=item $window_width = $term->width ([$new_value])
1441		1623
1442	=item $window_height = $term->height	1624	=item $window_height = $term->height ([$new_value])
1443		1625
1444	=item $font_width = $term->fwidth	1626	=item $font_width = $term->fwidth ([$new_value])
1445		1627
1446	=item $font_height = $term->fheight	1628	=item $font_height = $term->fheight ([$new_value])
1447		1629
1448	=item $font_ascent = $term->fbase	1630	=item $font_ascent = $term->fbase ([$new_value])
1449		1631
1450	=item $terminal_rows = $term->nrow	1632	=item $terminal_rows = $term->nrow ([$new_value])
1451		1633
1452	=item $terminal_columns = $term->ncol	1634	=item $terminal_columns = $term->ncol ([$new_value])
1453		1635
1454	=item $has_focus = $term->focus	1636	=item $has_focus = $term->focus ([$new_value])
1455		1637
1456	=item $is_mapped = $term->mapped	1638	=item $is_mapped = $term->mapped ([$new_value])
1457		1639
1458	=item $max_scrollback = $term->saveLines	1640	=item $max_scrollback = $term->saveLines ([$new_value])
1459		1641
1460	=item $nrow_plus_saveLines = $term->total_rows	1642	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1461		1643
1462	=item $topmost_scrollback_row = $term->top_row	1644	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1463		1645
1464	Return various integers describing terminal characteristics.	1646	Return various integers describing terminal characteristics. If an
		1647	argument is given, changes the value and returns the previous one.
1465		1648
1466	=item $x_display = $term->display_id	1649	=item $x_display = $term->display_id
1467		1650
1468	Return the DISPLAY used by rxvt-unicode.	1651	Return the DISPLAY used by rxvt-unicode.
1469		1652
…		…
1504		1687
1505	Returns the currently displayed screen (0 primary, 1 secondary).	1688	Returns the currently displayed screen (0 primary, 1 secondary).
1506		1689
1507	=item $cursor_is_hidden = $term->hidden_cursor	1690	=item $cursor_is_hidden = $term->hidden_cursor
1508		1691
1509	Returns wether the cursor is currently hidden or not.	1692	Returns whether the cursor is currently hidden or not.
1510		1693
1511	=item $view_start = $term->view_start ([$newvalue])	1694	=item $view_start = $term->view_start ([$newvalue])
1512		1695
1513	Returns the row number of the topmost displayed line. Maximum value is	1696	Returns the row number of the topmost displayed line. Maximum value is
1514	C<0>, which displays the normal terminal contents. Lower values scroll	1697	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1520	compare the on-screen display with its stored representation. If they	1703	compare the on-screen display with its stored representation. If they
1521	differ, it redraws the differences.	1704	differ, it redraws the differences.
1522		1705
1523	Used after changing terminal contents to display them.	1706	Used after changing terminal contents to display them.
1524		1707
		1708	=item $term->refresh_check
		1709
		1710	Checks if a refresh has been requested and, if so, schedules one.
		1711
1525	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1712	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1526		1713
1527	Returns the text of the entire row with number C<$row_number>. Row C<0>	1714	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1528	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1715	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1529	terminal line. The scrollback buffer starts at line C<-1> and extends to
1530	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1716	terminal line. Nothing will be returned if a nonexistent line
1531	is requested.	1717	is requested.
1532		1718
1533	If C<$new_text> is specified, it will replace characters in the current	1719	If C<$new_text> is specified, it will replace characters in the current
1534	line, starting at column C<$start_col> (default C<0>), which is useful	1720	line, starting at column C<$start_col> (default C<0>), which is useful
1535	to replace only parts of a line. The font index in the rendition will	1721	to replace only parts of a line. The font index in the rendition will
1536	automatically be updated.	1722	automatically be updated.
1537		1723
1538	C<$text> is in a special encoding: tabs and wide characters that use more	1724	C<$text> is in a special encoding: tabs and wide characters that use more
1539	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1725	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1540	characters. Characters with combining characters and other characters that	1726	characters. Characters with combining characters and other characters that
1541	do not fit into the normal tetx encoding will be replaced with characters	1727	do not fit into the normal text encoding will be replaced with characters
1542	in the private use area.	1728	in the private use area.
1543		1729
1544	You have to obey this encoding when changing text. The advantage is	1730	You have to obey this encoding when changing text. The advantage is
1545	that C<substr> and similar functions work on screen cells and not on	1731	that C<substr> and similar functions work on screen cells and not on
1546	characters.	1732	characters.
…		…
1631	}	1817	}
1632		1818
1633	sub urxvt::line::t {	1819	sub urxvt::line::t {
1634	my ($self) = @_;	1820	my ($self) = @_;
1635		1821
1636	if (@_ > 1)	1822	if (@_ > 1) {
1637	{
1638	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1823	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1639	for $self->{beg} .. $self->{end};	1824	for $self->{beg} .. $self->{end};
1640	}	1825	}
1641		1826
1642	defined wantarray &&	1827	defined wantarray &&
1643	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1828	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1644	0, $self->{len}	1829	0, $self->{len}
1645	}	1830	}
1646		1831
1647	sub urxvt::line::r {	1832	sub urxvt::line::r {
1648	my ($self) = @_;	1833	my ($self) = @_;
1649		1834
1650	if (@_ > 1)	1835	if (@_ > 1) {
1651	{
1652	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1836	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1653	for $self->{beg} .. $self->{end};	1837	for $self->{beg} .. $self->{end};
1654	}	1838	}
1655		1839
1656	if (defined wantarray) {	1840	if (defined wantarray) {
1657	my $rend = [	1841	my $rend = [
1658	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1842	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1659	];	1843	];
…		…
1691	where one character corresponds to one screen cell. See	1875	where one character corresponds to one screen cell. See
1692	C<< $term->ROW_t >> for details.	1876	C<< $term->ROW_t >> for details.
1693		1877
1694	=item $string = $term->special_decode $text	1878	=item $string = $term->special_decode $text
1695		1879
1696	Converts rxvt-unicodes text reprsentation into a perl string. See	1880	Converts rxvt-unicodes text representation into a perl string. See
1697	C<< $term->ROW_t >> for details.	1881	C<< $term->ROW_t >> for details.
1698		1882
1699	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1883	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1700		1884
1701	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1885	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1704	manpage.	1888	manpage.
1705		1889
1706	=item $success = $term->grab ($eventtime[, $sync])	1890	=item $success = $term->grab ($eventtime[, $sync])
1707		1891
1708	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1892	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1709	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1893	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1710		1894
1711	=item $term->allow_events_async	1895	=item $term->allow_events_async
1712		1896
1713	Calls XAllowEvents with AsyncBoth for the most recent grab.	1897	Calls XAllowEvents with AsyncBoth for the most recent grab.
1714		1898
…		…
1721	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1905	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1722	recent grab.	1906	recent grab.
1723		1907
1724	=item $term->ungrab	1908	=item $term->ungrab
1725		1909
1726	Calls XUngrab for the most recent grab. Is called automatically on	1910	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1727	evaluation errors, as it is better to lose the grab in the error case as	1911	evaluation errors, as it is better to lose the grab in the error case as
1728	the session.	1912	the session.
1729		1913
1730	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1914	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1731		1915
…		…
1733		1917
1734	=item @atoms = $term->XListProperties ($window)	1918	=item @atoms = $term->XListProperties ($window)
1735		1919
1736	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1920	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1737		1921
1738	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1922	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1739		1923
1740	=item $term->XDeleteProperty ($window, $property)	1924	=item $term->XDeleteProperty ($window, $property)
1741		1925
1742	=item $window = $term->DefaultRootWindow	1926	=item $window = $term->DefaultRootWindow
1743		1927
…		…
1750	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1934	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1751		1935
1752	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1936	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1753		1937
1754	=item $term->XChangeInput ($window, $add_events[, $del_events])	1938	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1939
		1940	=item $keysym = $term->XStringToKeysym ($string)
		1941
		1942	=item $string = $term->XKeysymToString ($keysym)
1755		1943
1756	Various X or X-related functions. The C<$term> object only serves as	1944	Various X or X-related functions. The C<$term> object only serves as
1757	the source of the display, otherwise those functions map more-or-less	1945	the source of the display, otherwise those functions map more-or-less
1758	directory onto the X functions of the same name.	1946	directly onto the X functions of the same name.
1759		1947
1760	=back	1948	=back
1761		1949
1762	=cut	1950	=cut
1763		1951
…		…
1865	my $env = $self->{term}->env;	2053	my $env = $self->{term}->env;
1866	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2054	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1867	delete $env->{LC_ALL};	2055	delete $env->{LC_ALL};
1868	$env->{LC_CTYPE} = $self->{term}->locale;	2056	$env->{LC_CTYPE} = $self->{term}->locale;
1869		2057
1870	urxvt::term->new ($env, "popup",	2058	my $term = urxvt::term->new (
		2059	$env, "popup",
1871	"--perl-lib" => "", "--perl-ext-common" => "",	2060	"--perl-lib" => "", "--perl-ext-common" => "",
1872	"-pty-fd" => -1, "-sl" => 0,	2061	"-pty-fd" => -1, "-sl" => 0,
1873	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2062	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1874	"--transient-for" => $self->{term}->parent,	2063	"--transient-for" => $self->{term}->parent,
1875	"-display" => $self->{term}->display_id,	2064	"-display" => $self->{term}->display_id,
1876	"-pe" => "urxvt-popup")	2065	"-pe" => "urxvt-popup",
1877	or die "unable to create popup window\n";	2066	) or die "unable to create popup window\n";
		2067
		2068	unless (delete $term->{urxvt_popup_init_done}) {
		2069	$term->ungrab;
		2070	$term->destroy;
		2071	die "unable to initialise popup window\n";
		2072	}
1878	}	2073	}
1879		2074
1880	sub DESTROY {	2075	sub DESTROY {
1881	my ($self) = @_;	2076	my ($self) = @_;
1882		2077
…		…
1887	=back	2082	=back
1888		2083
1889	=cut	2084	=cut
1890		2085
1891	package urxvt::watcher;	2086	package urxvt::watcher;
1892
1893	@urxvt::timer::ISA = __PACKAGE__;
1894	@urxvt::iow::ISA = __PACKAGE__;
1895	@urxvt::pw::ISA = __PACKAGE__;
1896	@urxvt::iw::ISA = __PACKAGE__;
1897		2087
1898	=head2 The C<urxvt::timer> Class	2088	=head2 The C<urxvt::timer> Class
1899		2089
1900	This class implements timer watchers/events. Time is represented as a	2090	This class implements timer watchers/events. Time is represented as a
1901	fractional number of seconds since the epoch. Example:	2091	fractional number of seconds since the epoch. Example:
…		…
1905	->new	2095	->new
1906	->interval (1)	2096	->interval (1)
1907	->cb (sub {	2097	->cb (sub {
1908	$term->{overlay}->set (0, 0,	2098	$term->{overlay}->set (0, 0,
1909	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2099	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1910	});	2100	});
1911		2101
1912	=over 4	2102	=over 4
1913		2103
1914	=item $timer = new urxvt::timer	2104	=item $timer = new urxvt::timer
1915		2105
…		…
1918		2108
1919	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2109	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1920		2110
1921	Set the callback to be called when the timer triggers.	2111	Set the callback to be called when the timer triggers.
1922		2112
1923	=item $tstamp = $timer->at
1924
1925	Return the time this watcher will fire next.
1926
1927	=item $timer = $timer->set ($tstamp)	2113	=item $timer = $timer->set ($tstamp[, $interval])
1928		2114
1929	Set the time the event is generated to $tstamp.	2115	Set the time the event is generated to $tstamp (and optionally specifies a
		2116	new $interval).
1930		2117
1931	=item $timer = $timer->interval ($interval)	2118	=item $timer = $timer->interval ($interval)
1932		2119
1933	Normally (and when C<$interval> is C<0>), the timer will automatically	2120	By default (and when C<$interval> is C<0>), the timer will automatically
1934	stop after it has fired once. If C<$interval> is non-zero, then the timer	2121	stop after it has fired once. If C<$interval> is non-zero, then the timer
1935	is automatically rescheduled at the given intervals.	2122	is automatically rescheduled at the given intervals.
1936		2123
1937	=item $timer = $timer->start	2124	=item $timer = $timer->start
1938		2125
1939	Start the timer.	2126	Start the timer.
1940		2127
1941	=item $timer = $timer->start ($tstamp)	2128	=item $timer = $timer->start ($tstamp[, $interval])
1942		2129
1943	Set the event trigger time to C<$tstamp> and start the timer.	2130	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2131	also replaces the interval.
1944		2132
1945	=item $timer = $timer->after ($delay)	2133	=item $timer = $timer->after ($delay[, $interval])
1946		2134
1947	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2135	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1948		2136
1949	=item $timer = $timer->stop	2137	=item $timer = $timer->stop
1950		2138
…		…
1958		2146
1959	$term->{socket} = ...	2147	$term->{socket} = ...
1960	$term->{iow} = urxvt::iow	2148	$term->{iow} = urxvt::iow
1961	->new	2149	->new
1962	->fd (fileno $term->{socket})	2150	->fd (fileno $term->{socket})
1963	->events (urxvt::EVENT_READ)	2151	->events (urxvt::EV_READ)
1964	->start	2152	->start
1965	->cb (sub {	2153	->cb (sub {
1966	my ($iow, $revents) = @_;	2154	my ($iow, $revents) = @_;
1967	# $revents must be 1 here, no need to check	2155	# $revents must be 1 here, no need to check
1968	sysread $term->{socket}, my $buf, 8192	2156	sysread $term->{socket}, my $buf, 8192
…		…
1981	Set the callback to be called when io events are triggered. C<$reventmask>	2169	Set the callback to be called when io events are triggered. C<$reventmask>
1982	is a bitset as described in the C<events> method.	2170	is a bitset as described in the C<events> method.
1983		2171
1984	=item $iow = $iow->fd ($fd)	2172	=item $iow = $iow->fd ($fd)
1985		2173
1986	Set the filedescriptor (not handle) to watch.	2174	Set the file descriptor (not handle) to watch.
1987		2175
1988	=item $iow = $iow->events ($eventmask)	2176	=item $iow = $iow->events ($eventmask)
1989		2177
1990	Set the event mask to watch. The only allowed values are	2178	Set the event mask to watch. The only allowed values are
1991	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2179	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1992	together, or C<urxvt::EVENT_NONE>.	2180	together, or C<urxvt::EV_NONE>.
1993		2181
1994	=item $iow = $iow->start	2182	=item $iow = $iow->start
1995		2183
1996	Start watching for requested events on the given handle.	2184	Start watching for requested events on the given handle.
1997		2185
1998	=item $iow = $iow->stop	2186	=item $iow = $iow->stop
1999		2187
2000	Stop watching for events on the given filehandle.	2188	Stop watching for events on the given file handle.
2001		2189
2002	=back	2190	=back
2003		2191
2004	=head2 The C<urxvt::iw> Class	2192	=head2 The C<urxvt::iw> Class
2005		2193
…		…
2038	->new	2226	->new
2039	->start ($pid)	2227	->start ($pid)
2040	->cb (sub {	2228	->cb (sub {
2041	my ($pw, $exit_status) = @_;	2229	my ($pw, $exit_status) = @_;
2042	...	2230	...
2043	});	2231	});
2044		2232
2045	=over 4	2233	=over 4
2046		2234
2047	=item $pw = new urxvt::pw	2235	=item $pw = new urxvt::pw
2048		2236
…		…
2052		2240
2053	Set the callback to be called when the timer triggers.	2241	Set the callback to be called when the timer triggers.
2054		2242
2055	=item $pw = $timer->start ($pid)	2243	=item $pw = $timer->start ($pid)
2056		2244
2057	Tells the wqtcher to start watching for process C<$pid>.	2245	Tells the watcher to start watching for process C<$pid>.
2058		2246
2059	=item $pw = $pw->stop	2247	=item $pw = $pw->stop
2060		2248
2061	Stop the watcher.	2249	Stop the watcher.
2062		2250
…		…
2075		2263
2076	=item >= 3 - script loading and management	2264	=item >= 3 - script loading and management
2077		2265
2078	=item >=10 - all called hooks	2266	=item >=10 - all called hooks
2079		2267
2080	=item >=11 - hook reutrn values	2268	=item >=11 - hook return values
2081		2269
2082	=back	2270	=back
2083		2271
2084	=head1 AUTHOR	2272	=head1 AUTHOR
2085		2273
2086	Marc Lehmann <pcg@goof.com>	2274	Marc Lehmann <schmorp@schmorp.de>
2087	http://software.schmorp.de/pkg/rxvt-unicode	2275	http://software.schmorp.de/pkg/rxvt-unicode
2088		2276
2089	=cut	2277	=cut
2090		2278
2091	1	2279	1
		2280
		2281	# vim: sw=3:

Diff Legend

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