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.142 by root, Thu Jul 6 18:56:10 2006 UTC vs.
Revision 1.230 by root, Sat Apr 26 20:51:12 2014 UTC

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

Diff Legend

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