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.133 by root, Mon Feb 6 06:14:08 2006 UTC vs.
Revision 1.243 by sf-exg, Sat Oct 11 22:02:50 2014 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions may add resources on their own. Similarly to builtin
45		49	resources, these resources can also be specified on the command line
46	=item selection (enabled by default)	50	as long options (with '.' replaced by '-'), in which case the
47		51	corresponding extension is loaded automatically.
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	=item readline (enabled by default)
157
158	A support package that tries to make editing with readline easier. At the
159	moment, it reacts to clicking with the 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		52
333	=head1 API DOCUMENTATION	53	=head1 API DOCUMENTATION
334		54
335	=head2 General API Considerations	55	=head2 General API Considerations
336		56
…		…
350		70
351	=over 4	71	=over 4
352		72
353	=item $text	73	=item $text
354		74
355	Rxvt-unicodes special way of encoding text, where one "unicode" character	75	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.	76	always represents one screen cell. See L<ROW_t> for a discussion of this format.
357		77
358	=item $string	78	=item $string
359		79
360	A perl text string, with an emphasis on I<text>. It can store all unicode	80	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
364	=item $octets	84	=item $octets
365		85
366	Either binary data or - more common - a text string encoded in a	86	Either binary data or - more common - a text string encoded in a
367	locale-specific way.	87	locale-specific way.
368		88
		89	=item $keysym
		90
		91	an integer that is a valid X11 keysym code. You can convert a string
		92	into a keysym and viceversa by using C<XStringToKeysym> and
		93	C<XKeysymToString>.
		94
369	=back	95	=back
370		96
371	=head2 Extension Objects	97	=head2 Extension Objects
372		98
373	Very perl extension is a perl class. A separate perl object is created	99	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	100	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	101	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	102	their C<$self> object without having to think about clashes with other
		103	extensions or other terminals, with the exception of methods and members
377	begin with an underscore character C<_>: these are reserved for internal	104	that begin with an underscore character C<_>: these are reserved for
378	use.	105	internal use.
379		106
380	Although it isn't a C<urxvt::term> object, you can call all methods of the	107	Although it isn't a C<urxvt::term> object, you can call all methods of the
381	C<urxvt::term> class on this object.	108	C<urxvt::term> class on this object.
382		109
383	It has the following methods and data members:	110	Additional methods only supported for extension objects are described in
384		111	the C<urxvt::extension> section below.
385	=over 4
386
387	=item $urxvt_term = $self->{term}
388
389	Returns the C<urxvt::term> object associated with this instance of the
390	extension. This member I<must not> be changed in any way.
391
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
402	=back
403		112
404	=head2 Hooks	113	=head2 Hooks
405		114
406	The following subroutines can be declared in extension files, and will be	115	The following subroutines can be declared in extension files, and will be
407	called whenever the relevant event happens.	116	called whenever the relevant event happens.
408		117
409	The first argument passed to them is an extension oject as described in	118	The first argument passed to them is an extension object as described in
410	the in the C<Extension Objects> section.	119	the in the C<Extension Objects> section.
411		120
412	B<All> of these hooks must return a boolean value. If any of the called	121	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	122	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.	123	relevant action might not be carried out by the C++ code.
…		…
427	place.	136	place.
428		137
429	=item on_start $term	138	=item on_start $term
430		139
431	Called at the very end of initialisation of a new terminal, just before	140	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.	141	trying to map (display) the toplevel and returning to the main loop.
433		142
434	=item on_destroy $term	143	=item on_destroy $term
435		144
436	Called whenever something tries to destroy terminal, when the terminal is	145	Called whenever something tries to destroy terminal, when the terminal is
437	still fully functional (not for long, though).	146	still fully functional (not for long, though).
…		…
464		173
465	Called whenever a selection has been copied, but before the selection is	174	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	175	requested from the server. The selection text can be queried and changed
467	by calling C<< $term->selection >>.	176	by calling C<< $term->selection >>.
468		177
469	Returning a true value aborts selection grabbing. It will still be hilighted.	178	Returning a true value aborts selection grabbing. It will still be highlighted.
470		179
471	=item on_sel_extend $term	180	=item on_sel_extend $term
472		181
473	Called whenever the user tries to extend the selection (e.g. with a double	182	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	183	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	184	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	185	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	186	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.	187	supposed to enlarge the selection more and more, if possible.
479		188
480	See the F<selection> example extension.	189	See the F<selection> example extension.
481		190
482	=item on_view_change $term, $offset	191	=item on_view_change $term, $offset
483		192
484	Called whenever the view offset changes, i..e the user or program	193	Called whenever the view offset changes, i.e. the user or program
485	scrolls. Offset C<0> means display the normal terminal, positive values	194	scrolls. Offset C<0> means display the normal terminal, positive values
486	show this many lines of scrollback.	195	show this many lines of scrollback.
487		196
488	=item on_scroll_back $term, $lines, $saved	197	=item on_scroll_back $term, $lines, $saved
489		198
…		…
493		202
494	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	203	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	204	$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.	205	number of lines that will be in the scrollback buffer.
497		206
498	=item on_osc_seq $term, $string	207	=item on_osc_seq $term, $op, $args, $resp
		208
		209	Called on every OSC sequence and can be used to suppress it or modify its
		210	behaviour. The default should be to return an empty list. A true value
		211	suppresses execution of the request completely. Make sure you don't get
		212	confused by recursive invocations when you output an OSC sequence within
		213	this callback.
		214
		215	C<on_osc_seq_perl> should be used for new behaviour.
		216
		217	=item on_osc_seq_perl $term, $args, $resp
499		218
500	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	219	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
501	operating system command) is processed. Cursor position and other state	220	operating system command) is processed. Cursor position and other state
502	information is up-to-date when this happens. For interoperability, the	221	information is up-to-date when this happens. For interoperability, the
503	string should start with the extension name and a colon, to distinguish	222	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	223	to distinguish it from commands for other extensions, and this might be
505	future.	224	enforced in the future.
		225
		226	For example, C<overlay-osc> uses this:
		227
		228	sub on_osc_seq_perl {
		229	my ($self, $osc, $resp) = @_;
		230
		231	return unless $osc =~ s/^overlay;//;
		232
		233	... process remaining $osc string
		234	}
506		235
507	Be careful not ever to trust (in a security sense) the data you receive,	236	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	237	as its source can not easily be controlled (e-mail content, messages from
509	other users on the same system etc.).	238	other users on the same system etc.).
		239
		240	For responses, C<$resp> contains the end-of-args separator used by the
		241	sender.
510		242
511	=item on_add_lines $term, $string	243	=item on_add_lines $term, $string
512		244
513	Called whenever text is about to be output, with the text as argument. You	245	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	246	can filter/change and output the text yourself by returning a true value
…		…
519	=item on_tt_write $term, $octets	251	=item on_tt_write $term, $octets
520		252
521	Called whenever some data is written to the tty/pty and can be used to	253	Called whenever some data is written to the tty/pty and can be used to
522	suppress or filter tty input.	254	suppress or filter tty input.
523		255
		256	=item on_tt_paste $term, $octets
		257
		258	Called whenever text is about to be pasted, with the text as argument. You
		259	can filter/change and paste the text yourself by returning a true value
		260	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		261	locale-encoded.
		262
524	=item on_line_update $term, $row	263	=item on_line_update $term, $row
525		264
526	Called whenever a line was updated or changed. Can be used to filter	265	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	266	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,	267	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	274	later with the already-modified line (e.g. if unrelated parts change), so
536	you cannot just toggle rendition bits, but only set them.	275	you cannot just toggle rendition bits, but only set them.
537		276
538	=item on_refresh_begin $term	277	=item on_refresh_begin $term
539		278
540	Called just before the screen gets redrawn. Can be used for overlay	279	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	280	similar effects by modifying the terminal contents in refresh_begin, and
542	restoring them in refresh_end. The built-in overlay and selection display	281	restoring them in refresh_end. The built-in overlay and selection display
543	code is run after this hook, and takes precedence.	282	code is run after this hook, and takes precedence.
544		283
545	=item on_refresh_end $term	284	=item on_refresh_end $term
546		285
547	Called just after the screen gets redrawn. See C<on_refresh_begin>.	286	Called just after the screen gets redrawn. See C<on_refresh_begin>.
548		287
549	=item on_user_command $term, $string	288	=item on_user_command $term, $string *DEPRECATED*
550		289
551	Called whenever the a user-configured event is being activated (e.g. via	290	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>	291	a C<perl:string> action bound to a key, see description of the B<keysym>
553	resource in the @@RXVT_NAME@@(1) manpage).	292	resource in the urxvt(1) manpage).
554		293
555	The event is simply the action string. This interface is assumed to change	294	The event is simply the action string. This interface is going away in
556	slightly in the future.	295	preference to the C<on_action> hook.
		296
		297	=item on_resize_all_windows $term, $new_width, $new_height
		298
		299	Called just after the new window size has been calculated, but before
		300	windows are actually being resized or hints are being set. If this hook
		301	returns a true value, setting of the window hints is being skipped.
557		302
558	=item on_x_event $term, $event	303	=item on_x_event $term, $event
559		304
560	Called on every X event received on the vt window (and possibly other	305	Called on every X event received on the vt window (and possibly other
561	windows). Should only be used as a last resort. Most event structure	306	windows). Should only be used as a last resort. Most event structure
562	members are not passed.	307	members are not passed.
563		308
		309	=item on_root_event $term, $event
		310
		311	Like C<on_x_event>, but is called for events on the root window.
		312
564	=item on_focus_in $term	313	=item on_focus_in $term
565		314
566	Called whenever the window gets the keyboard focus, before rxvt-unicode	315	Called whenever the window gets the keyboard focus, before rxvt-unicode
567	does focus in processing.	316	does focus in processing.
568		317
569	=item on_focus_out $term	318	=item on_focus_out $term
570		319
571	Called wheneever the window loses keyboard focus, before rxvt-unicode does	320	Called whenever the window loses keyboard focus, before rxvt-unicode does
572	focus out processing.	321	focus out processing.
573		322
574	=item on_configure_notify $term, $event	323	=item on_configure_notify $term, $event
575		324
576	=item on_property_notify $term, $event	325	=item on_property_notify $term, $event
…		…
587		336
588	=item on_map_notify $term, $event	337	=item on_map_notify $term, $event
589		338
590	=item on_unmap_notify $term, $event	339	=item on_unmap_notify $term, $event
591		340
592	Called whenever the corresponding X event is received for the terminal If	341	Called whenever the corresponding X event is received for the terminal. If
593	the hook returns true, then the even will be ignored by rxvt-unicode.	342	the hook returns true, then the event will be ignored by rxvt-unicode.
594		343
595	The event is a hash with most values as named by Xlib (see the XEvent	344	The event is a hash with most values as named by Xlib (see the XEvent
596	manpage), with the additional members C<row> and C<col>, which are the	345	manpage), with the additional members C<row> and C<col>, which are the
597	(real, not screen-based) row and column under the mouse cursor.	346	(real, not screen-based) row and column under the mouse cursor.
598		347
599	C<on_key_press> additionally receives the string rxvt-unicode would	348	C<on_key_press> additionally receives the string rxvt-unicode would
600	output, if any, in locale-specific encoding.	349	output, if any, in locale-specific encoding.
601		350
602	subwindow.
603
604	=item on_client_message $term, $event	351	=item on_client_message $term, $event
605		352
606	=item on_wm_protocols $term, $event	353	=item on_wm_protocols $term, $event
607		354
608	=item on_wm_delete_window $term, $event	355	=item on_wm_delete_window $term, $event
609		356
610	Called when various types of ClientMessage events are received (all with	357	Called when various types of ClientMessage events are received (all with
611	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	358	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
612		359
		360	=item on_bell $term
		361
		362	Called on receipt of a bell character.
		363
613	=back	364	=back
614		365
615	=cut	366	=cut
616		367
617	package urxvt;	368	package urxvt;
618		369
619	use utf8;	370	use utf8;
620	use strict;	371	use strict 'vars';
621	use Carp ();	372	use Carp ();
622	use Scalar::Util ();	373	use Scalar::Util ();
623	use List::Util ();	374	use List::Util ();
624		375
625	our $VERSION = 1;	376	our $VERSION = 1;
626	our $TERM;	377	our $TERM;
627	our @TERM_INIT;	378	our @TERM_INIT; # should go, prevents async I/O etc.
628	our @TERM_EXT;	379	our @TERM_EXT; # should go, prevents async I/O etc.
629	our @HOOKNAME;	380	our @HOOKNAME;
630	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	381	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
631	our %OPTION;	382	our %OPTION;
632		383
633	our $LIBDIR;	384	our $LIBDIR;
…		…
659	The current terminal. This variable stores the current C<urxvt::term>	410	The current terminal. This variable stores the current C<urxvt::term>
660	object, whenever a callback/hook is executing.	411	object, whenever a callback/hook is executing.
661		412
662	=item @urxvt::TERM_INIT	413	=item @urxvt::TERM_INIT
663		414
664	All coderefs in this array will be called as methods of the next newly	415	All code references in this array will be called as methods of the next newly
665	created C<urxvt::term> object (during the C<on_init> phase). The array	416	created C<urxvt::term> object (during the C<on_init> phase). The array
666	gets cleared before the codereferences that were in it are being executed,	417	gets cleared before the code references that were in it are being executed,
667	so coderefs can push themselves onto it again if they so desire.	418	so references can push themselves onto it again if they so desire.
668		419
669	This complements to the perl-eval commandline option, but gets executed	420	This complements to the perl-eval command line option, but gets executed
670	first.	421	first.
671		422
672	=item @urxvt::TERM_EXT	423	=item @urxvt::TERM_EXT
673		424
674	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	425	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
681		432
682	=over 4	433	=over 4
683		434
684	=item urxvt::fatal $errormessage	435	=item urxvt::fatal $errormessage
685		436
686	Fatally aborts execution with the given error message. Avoid at all	437	Fatally aborts execution with the given error message (which should
687	costs! The only time this is acceptable is when the terminal process	438	include a trailing newline). Avoid at all costs! The only time this
688	starts up.	439	is acceptable (and useful) is in the init hook, where it prevents the
		440	terminal from starting up.
689		441
690	=item urxvt::warn $string	442	=item urxvt::warn $string
691		443
692	Calls C<rxvt_warn> with the given string which should not include a	444	Calls C<rxvt_warn> with the given string which should include a trailing
693	newline. The module also overwrites the C<warn> builtin with a function	445	newline. The module also overwrites the C<warn> builtin with a function
694	that calls this function.	446	that calls this function.
695		447
696	Using this function has the advantage that its output ends up in the	448	Using this function has the advantage that its output ends up in the
697	correct place, e.g. on stderr of the connecting urxvtc client.	449	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
699	Messages have a size limit of 1023 bytes currently.	451	Messages have a size limit of 1023 bytes currently.
700		452
701	=item @terms = urxvt::termlist	453	=item @terms = urxvt::termlist
702		454
703	Returns all urxvt::term objects that exist in this process, regardless of	455	Returns all urxvt::term objects that exist in this process, regardless of
704	wether they are started, being destroyed etc., so be careful. Only term	456	whether they are started, being destroyed etc., so be careful. Only term
705	objects that have perl extensions attached will be returned (because there	457	objects that have perl extensions attached will be returned (because there
706	is no urxvt::term objet associated with others).	458	is no urxvt::term object associated with others).
707		459
708	=item $time = urxvt::NOW	460	=item $time = urxvt::NOW
709		461
710	Returns the "current time" (as per the event loop).	462	Returns the "current time" (as per the event loop).
711		463
…		…
754		506
755	=item $rend = urxvt::OVERLAY_RSTYLE	507	=item $rend = urxvt::OVERLAY_RSTYLE
756		508
757	Return the rendition mask used for overlays by default.	509	Return the rendition mask used for overlays by default.
758		510
759	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	511	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		512	urxvt::RS_RVid, urxvt::RS_Uline
760		513
761	Return the bit that enabled bold, italic, blink, reverse-video and	514	Return the bit that enabled bold, italic, blink, reverse-video and
762	underline, respectively. To enable such a style, just logically OR it into	515	underline, respectively. To enable such a style, just logically OR it into
763	the bitset.	516	the bitset.
764		517
…		…
801	};	554	};
802	}	555	}
803		556
804	no warnings 'utf8';	557	no warnings 'utf8';
805		558
		559	sub parse_resource {
		560	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		561
		562	$term->scan_extensions;
		563
		564	my $r = $term->{meta}{resource};
		565	keys %$r; # reset iterator
		566	while (my ($k, $v) = each %$r) {
		567	my $pattern = $k;
		568	$pattern =~ y/./-/ if $isarg;
		569	my $prefix = $name;
		570	my $suffix;
		571	if ($pattern =~ /\-$/) {
		572	$prefix = substr $name, 0, length $pattern;
		573	$suffix = substr $name, length $pattern;
		574	}
		575	if ($pattern eq $prefix) {
		576	$name = "$urxvt::RESCLASS.$k$suffix";
		577
		578	push @{ $term->{perl_ext_3} }, $v->[0];
		579
		580	if ($v->[1] eq "boolean") {
		581	$term->put_option_db ($name, $flag ? "true" : "false");
		582	return 1;
		583	} else {
		584	$term->put_option_db ($name, $value);
		585	return 1 + 2;
		586	}
		587	}
		588	}
		589
		590	0
		591	}
		592
		593	sub usage {
		594	my ($term, $usage_type) = @_;
		595
		596	$term->scan_extensions;
		597
		598	my $r = $term->{meta}{resource};
		599
		600	for my $pattern (sort keys %$r) {
		601	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		602
		603	$desc .= " (-pe $ext)";
		604
		605	if ($usage_type == 1) {
		606	$pattern =~ y/./-/;
		607	$pattern =~ s/-$/-.../g;
		608
		609	if ($type eq "boolean") {
		610	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		611	} else {
		612	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		613	}
		614	} else {
		615	$pattern =~ s/\.$/.*/g;
		616	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		617	}
		618	}
		619	}
		620
806	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	621	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
807		622
808	sub verbose {	623	sub verbose {
809	my ($level, $msg) = @_;	624	my ($level, $msg) = @_;
810	warn "$msg\n" if $level <= $verbosity;	625	warn "$msg\n" if $level <= $verbosity;
…		…
822	$pkg =~ s/[^[:word:]]/_/g;	637	$pkg =~ s/[^[:word:]]/_/g;
823	$pkg = "urxvt::ext::$pkg";	638	$pkg = "urxvt::ext::$pkg";
824		639
825	verbose 3, "loading extension '$path' into package '$pkg'";	640	verbose 3, "loading extension '$path' into package '$pkg'";
826		641
		642	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		643
827	open my $fh, "<:raw", $path	644	open my $fh, "<:raw", $path
828	or die "$path: $!";	645	or die "$path: $!";
829		646
830	my $source =	647	my $source =
831	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	648	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
832	. "#line 1 \"$path\"\n{\n"	649	. "#line 1 \"$path\"\n{\n"
833	. (do { local $/; <$fh> })	650	. (do { local $/; <$fh> })
834	. "\n};\n1";	651	. "\n};\n1";
835		652
836	eval $source	653	eval $source
…		…
845	# called by the rxvt core	662	# called by the rxvt core
846	sub invoke {	663	sub invoke {
847	local $TERM = shift;	664	local $TERM = shift;
848	my $htype = shift;	665	my $htype = shift;
849		666
850	if ($htype == 0) { # INIT	667	if ($htype == HOOK_INIT) {
851	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	668	my @dirs = $TERM->perl_libdirs;
852		669
		670	$TERM->scan_extensions;
		671
853	my %ext_arg;	672	my %ext_arg;
854		673
855	{	674	{
856	my @init = @TERM_INIT;	675	my @init = @TERM_INIT;
857	@TERM_INIT = ();	676	@TERM_INIT = ();
…		…
859	my @pkg = @TERM_EXT;	678	my @pkg = @TERM_EXT;
860	@TERM_EXT = ();	679	@TERM_EXT = ();
861	$TERM->register_package ($_) for @pkg;	680	$TERM->register_package ($_) for @pkg;
862	}	681	}
863		682
		683	for (
864	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	684	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		685	@{ delete $TERM->{perl_ext_3} }
		686	) {
865	if ($_ eq "default") {	687	if ($_ eq "default") {
866	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	688
		689	$ext_arg{$_} = []
		690	for
		691	qw(selection option-popup selection-popup readline),
		692	map $_->[0], values %{ $TERM->{meta}{binding} };
		693
		694	for ($TERM->_keysym_resources) {
		695	next if /^(?:string|command|builtin|builtin-string|perl)/;
		696	next unless /^([A-Za-z0-9_\-]+):/;
		697
		698	my $ext = $1;
		699
		700	$ext_arg{$ext} = [];
		701	}
		702
867	} elsif (/^-(.*)$/) {	703	} elsif (/^-(.*)$/) {
868	delete $ext_arg{$1};	704	delete $ext_arg{$1};
		705
869	} elsif (/^([^<]+)<(.*)>$/) {	706	} elsif (/^([^<]+)<(.*)>$/) {
870	push @{ $ext_arg{$1} }, $2;	707	push @{ $ext_arg{$1} }, $2;
		708
871	} else {	709	} else {
872	$ext_arg{$_} ||= [];	710	$ext_arg{$_} ||= [];
		711	}
		712	}
		713
		714	# now register default key bindings
		715	for my $ext (sort keys %ext_arg) {
		716	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		717	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
873	}	718	}
874	}	719	}
875		720
876	for my $ext (sort keys %ext_arg) {	721	for my $ext (sort keys %ext_arg) {
877	my @files = grep -f $_, map "$_/$ext", @dirs;	722	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
891		736
892	if (my $cb = $TERM->{_hook}[$htype]) {	737	if (my $cb = $TERM->{_hook}[$htype]) {
893	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	738	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
894	if $verbosity >= 10;	739	if $verbosity >= 10;
895		740
896	keys %$cb;	741	if ($htype == HOOK_ACTION) {
		742	# this hook is only sent to the extension with the name
		743	# matching the first arg
		744	my $pkg = shift;
		745	$pkg =~ y/-/_/;
		746	$pkg = "urxvt::ext::$pkg";
897		747
898	while (my ($pkg, $cb) = each %$cb) {	748	$cb = $cb->{$pkg}
		749	or return undef; #TODO: maybe warn user?
		750
		751	$cb = { $pkg => $cb };
		752	}
		753
		754	for my $pkg (keys %$cb) {
899	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	755	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
900	$retval ||= $retval_;	756	$retval ||= $retval_;
901		757
902	if ($@) {	758	if ($@) {
903	$TERM->ungrab; # better to lose the grab than the session	759	$TERM->ungrab; # better to lose the grab than the session
904	warn $@;	760	warn $@;
…		…
907		763
908	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	764	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
909	if $verbosity >= 11;	765	if $verbosity >= 11;
910	}	766	}
911		767
912	if ($htype == 1) { # DESTROY	768	if ($htype == HOOK_DESTROY) {
913	# clear package objects	769	# clear package objects
914	%$_ = () for values %{ $TERM->{_pkg} };	770	%$_ = () for values %{ $TERM->{_pkg} };
915		771
916	# clear package	772	# clear package
917	%$TERM = ();	773	%$TERM = ();
…		…
922		778
923	sub SET_COLOR($$$) {	779	sub SET_COLOR($$$) {
924	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	780	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
925	}	781	}
926		782
927	# urxvt::term::extension	783	sub rend2mask {
		784	no strict 'refs';
		785	my ($str, $mask) = (@_, 0);
		786	my %color = ( fg => undef, bg => undef );
		787	my @failed;
		788	for my $spec ( split /\s+/, $str ) {
		789	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		790	$color{lc($1)} = $2;
		791	} else {
		792	my $neg = $spec =~ s/^[-^]//;
		793	unless ( exists &{"RS_$spec"} ) {
		794	push @failed, $spec;
		795	next;
		796	}
		797	my $cur = &{"RS_$spec"};
		798	if ( $neg ) {
		799	$mask &= ~$cur;
		800	} else {
		801	$mask |= $cur;
		802	}
		803	}
		804	}
		805	($mask, @color{qw(fg bg)}, \@failed)
		806	}
928		807
929	package urxvt::term::extension;	808	package urxvt::term::extension;
930		809
931	sub enable {	810	=head2 The C<urxvt::term::extension> class
932	my ($self, %hook) = @_;
933	my $pkg = $self->{_pkg};
934		811
935	while (my ($name, $cb) = each %hook) {	812	Each extension attached to a terminal object is represented by
936	my $htype = $HOOKTYPE{uc $name};	813	a C<urxvt::term::extension> object.
937	defined $htype
938	or Carp::croak "unsupported hook type '$name'";
939		814
940	$self->set_should_invoke ($htype, +1)	815	You can use these objects, which are passed to all callbacks to store any
941	unless exists $self->{term}{_hook}[$htype]{$pkg};	816	state related to the terminal and extension instance.
942		817
943	$self->{term}{_hook}[$htype]{$pkg} = $cb;	818	The methods (And data members) documented below can be called on extension
944	}	819	objects, in addition to call methods documented for the <urxvt::term>
945	}	820	class.
946		821
947	sub disable {	822	=over 4
948	my ($self, @hook) = @_;
949	my $pkg = $self->{_pkg};
950		823
951	for my $name (@hook) {	824	=item $urxvt_term = $self->{term}
952	my $htype = $HOOKTYPE{uc $name};
953	defined $htype
954	or Carp::croak "unsupported hook type '$name'";
955		825
956	$self->set_should_invoke ($htype, -1)	826	Returns the C<urxvt::term> object associated with this instance of the
957	if delete $self->{term}{_hook}[$htype]{$pkg};	827	extension. This member I<must not> be changed in any way.
958	}	828
959	}	829	=cut
960		830
961	our $AUTOLOAD;	831	our $AUTOLOAD;
962		832
963	sub AUTOLOAD {	833	sub AUTOLOAD {
964	$AUTOLOAD =~ /:([^:]+)$/	834	$AUTOLOAD =~ /:([^:]+)$/
…		…
977		847
978	sub DESTROY {	848	sub DESTROY {
979	# nop	849	# nop
980	}	850	}
981		851
982	# urxvt::destroy_hook	852	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
983		853
984	sub urxvt::destroy_hook::DESTROY {	854	sub urxvt::destroy_hook::DESTROY {
985	${$_[0]}->();	855	${$_[0]}->();
986	}	856	}
987		857
988	sub urxvt::destroy_hook(&) {	858	sub urxvt::destroy_hook(&) {
989	bless \shift, urxvt::destroy_hook::	859	bless \shift, urxvt::destroy_hook::
990	}	860	}
		861
		862	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		863
		864	Dynamically enable the given hooks (named without the C<on_> prefix) for
		865	this extension, replacing any hook previously installed via C<enable> in
		866	this extension.
		867
		868	This is useful when you want to overwrite time-critical hooks only
		869	temporarily.
		870
		871	To install additional callbacks for the same hook, you can use the C<on>
		872	method of the C<urxvt::term> class.
		873
		874	=item $self->disable ($hook_name[, $hook_name..])
		875
		876	Dynamically disable the given hooks.
		877
		878	=cut
		879
		880	sub enable {
		881	my ($self, %hook) = @_;
		882	my $pkg = $self->{_pkg};
		883
		884	while (my ($name, $cb) = each %hook) {
		885	my $htype = $HOOKTYPE{uc $name};
		886	defined $htype
		887	or Carp::croak "unsupported hook type '$name'";
		888
		889	$self->set_should_invoke ($htype, +1)
		890	unless exists $self->{term}{_hook}[$htype]{$pkg};
		891
		892	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		893	}
		894	}
		895
		896	sub disable {
		897	my ($self, @hook) = @_;
		898	my $pkg = $self->{_pkg};
		899
		900	for my $name (@hook) {
		901	my $htype = $HOOKTYPE{uc $name};
		902	defined $htype
		903	or Carp::croak "unsupported hook type '$name'";
		904
		905	$self->set_should_invoke ($htype, -1)
		906	if delete $self->{term}{_hook}[$htype]{$pkg};
		907	}
		908	}
		909
		910	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		911
		912	Similar to the C<enable> enable, but installs additional callbacks for
		913	the given hook(s) (that is, it doesn't replace existing callbacks), and
		914	returns a guard object. When the guard object is destroyed the callbacks
		915	are disabled again.
		916
		917	=cut
		918
		919	sub urxvt::extension::on_disable::DESTROY {
		920	my $disable = shift;
		921
		922	my $term = delete $disable->{""};
		923
		924	while (my ($htype, $id) = each %$disable) {
		925	delete $term->{_hook}[$htype]{$id};
		926	$term->set_should_invoke ($htype, -1);
		927	}
		928	}
		929
		930	sub on {
		931	my ($self, %hook) = @_;
		932
		933	my $term = $self->{term};
		934
		935	my %disable = ( "" => $term );
		936
		937	while (my ($name, $cb) = each %hook) {
		938	my $htype = $HOOKTYPE{uc $name};
		939	defined $htype
		940	or Carp::croak "unsupported hook type '$name'";
		941
		942	$term->set_should_invoke ($htype, +1);
		943	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		944	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		945	}
		946
		947	bless \%disable, "urxvt::extension::on_disable"
		948	}
		949
		950	=item $self->x_resource ($pattern)
		951
		952	=item $self->x_resource_boolean ($pattern)
		953
		954	These methods support an additional C<%> prefix when called on an
		955	extension object - see the description of these methods in the
		956	C<urxvt::term> class for details.
		957
		958	=cut
		959
		960	sub x_resource {
		961	my ($self, $name) = @_;
		962	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		963	$self->{term}->x_resource ($name)
		964	}
		965
		966	sub x_resource_boolean {
		967	my ($self, $name) = @_;
		968	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		969	$self->{term}->x_resource_boolean ($name)
		970	}
		971
		972	=back
		973
		974	=cut
991		975
992	package urxvt::anyevent;	976	package urxvt::anyevent;
993		977
994	=head2 The C<urxvt::anyevent> Class	978	=head2 The C<urxvt::anyevent> Class
995		979
996	The sole purpose of this class is to deliver an interface to the	980	The sole purpose of this class is to deliver an interface to the
997	C<AnyEvent> module - any module using it will work inside urxvt without	981	C<AnyEvent> module - any module using it will work inside urxvt without
998	further programming. The only exception is that you cannot wait on	982	further programming. The only exception is that you cannot wait on
999	condition variables, but non-blocking condvar use is ok. What this means	983	condition variables, but non-blocking condvar use is ok.
1000	is that you cannot use blocking APIs, but the non-blocking variant should
1001	work.
1002		984
1003	=cut	985	In practical terms this means is that you cannot use blocking APIs, but
		986	the non-blocking variant should work.
1004		987
		988	=cut
		989
1005	our $VERSION = 1;	990	our $VERSION = '5.23';
1006		991
1007	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	992	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1008	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	993	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1009		994
1010	sub timer {	995	sub timer {
…		…
1012		997
1013	my $cb = $arg{cb};	998	my $cb = $arg{cb};
1014		999
1015	urxvt::timer	1000	urxvt::timer
1016	->new	1001	->new
1017	->start (urxvt::NOW + $arg{after})	1002	->after ($arg{after}, $arg{interval})
1018	->cb (sub {	1003	->cb ($arg{interval} ? $cb : sub {
1019	$_[0]->stop; # need to cancel manually	1004	$_[0]->stop; # need to cancel manually
1020	$cb->();	1005	$cb->();
1021	})	1006	})
1022	}	1007	}
1023		1008
1024	sub io {	1009	sub io {
1025	my ($class, %arg) = @_;	1010	my ($class, %arg) = @_;
1026		1011
1027	my $cb = $arg{cb};	1012	my $cb = $arg{cb};
		1013	my $fd = fileno $arg{fh};
		1014	defined $fd or $fd = $arg{fh};
1028		1015
1029	bless [$arg{fh}, urxvt::iow	1016	bless [$arg{fh}, urxvt::iow
1030	->new	1017	->new
1031	->fd (fileno $arg{fh})	1018	->fd ($fd)
1032	->events (($arg{poll} =~ /r/ ? 1 : 0)	1019	->events (($arg{poll} =~ /r/ ? 1 : 0)
1033	| ($arg{poll} =~ /w/ ? 2 : 0))	1020	| ($arg{poll} =~ /w/ ? 2 : 0))
1034	->start	1021	->start
1035	->cb (sub {	1022	->cb ($cb)
1036	$cb->(($_[1] & 1 ? 'r' : '')
1037	. ($_[1] & 2 ? 'w' : ''));
1038	})],
1039	urxvt::anyevent::	1023	], urxvt::anyevent::
		1024	}
		1025
		1026	sub idle {
		1027	my ($class, %arg) = @_;
		1028
		1029	my $cb = $arg{cb};
		1030
		1031	urxvt::iw
		1032	->new
		1033	->start
		1034	->cb ($cb)
		1035	}
		1036
		1037	sub child {
		1038	my ($class, %arg) = @_;
		1039
		1040	my $cb = $arg{cb};
		1041
		1042	urxvt::pw
		1043	->new
		1044	->start ($arg{pid})
		1045	->cb (sub {
		1046	$_[0]->stop; # need to cancel manually
		1047	$cb->($_[0]->rpid, $_[0]->rstatus);
		1048	})
1040	}	1049	}
1041		1050
1042	sub DESTROY {	1051	sub DESTROY {
1043	$_[0][1]->stop;	1052	$_[0][1]->stop;
1044	}	1053	}
1045		1054
1046	sub condvar {	1055	# only needed for AnyEvent < 6 compatibility
1047	bless \my $flag, urxvt::anyevent::condvar::	1056	sub one_event {
1048	}
1049
1050	sub urxvt::anyevent::condvar::broadcast {
1051	${$_[0]}++;
1052	}
1053
1054	sub urxvt::anyevent::condvar::wait {
1055	unless (${$_[0]}) {
1056	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1057	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1057	}
1058	}	1058	}
1059		1059
1060	package urxvt::term;	1060	package urxvt::term;
1061		1061
1062	=head2 The C<urxvt::term> Class	1062	=head2 The C<urxvt::term> Class
…		…
1075	urxvt::verbose 6, "register package $pkg to $self";	1075	urxvt::verbose 6, "register package $pkg to $self";
1076		1076
1077	@{"$pkg\::ISA"} = urxvt::term::extension::;	1077	@{"$pkg\::ISA"} = urxvt::term::extension::;
1078		1078
1079	my $proxy = bless {	1079	my $proxy = bless {
1080	_pkg => $pkg,	1080	_pkg => $pkg,
		1081	_name => ${"$pkg\::_NAME"}, # hackish
1081	argv => $argv,	1082	argv => $argv,
1082	}, $pkg;	1083	}, $pkg;
1083	Scalar::Util::weaken ($proxy->{term} = $self);	1084	Scalar::Util::weaken ($proxy->{term} = $self);
1084		1085
1085	$self->{_pkg}{$pkg} = $proxy;	1086	$self->{_pkg}{$pkg} = $proxy;
1086		1087
…		…
1089	$proxy->enable ($name => $ref);	1090	$proxy->enable ($name => $ref);
1090	}	1091	}
1091	}	1092	}
1092	}	1093	}
1093		1094
		1095	sub perl_libdirs {
		1096	map { split /:/ }
		1097	$_[0]->resource ("perl_lib"),
		1098	$ENV{URXVT_PERL_LIB},
		1099	"$ENV{HOME}/.urxvt/ext",
		1100	"$LIBDIR/perl"
		1101	}
		1102
		1103	# scan for available extensions and collect their metadata
		1104	sub scan_extensions {
		1105	my ($self) = @_;
		1106
		1107	return if exists $self->{meta};
		1108
		1109	my @libdirs = perl_libdirs $self;
		1110
		1111	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1112
		1113	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1114	$self->{meta} = \my %meta;
		1115
		1116	# first gather extensions
		1117	for my $dir (reverse @libdirs) {
		1118	opendir my $fh, $dir
		1119	or next;
		1120	for my $ext (readdir $fh) {
		1121	$ext !~ /^\./
		1122	and open my $fh, "<", "$dir/$ext"
		1123	or next;
		1124
		1125	my %ext = (dir => $dir);
		1126
		1127	while (<$fh>) {
		1128	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1129	my ($pattern, $type, $desc) = split /:/, $1;
		1130	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1131	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1132	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1133	} else {
		1134	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1135	}
		1136	} elsif (/^#:META:BINDING:(.*)/) {
		1137	my ($keysym, $action) = split /:/, $1;
		1138	$ext{binding}{$keysym} = [$ext, $action];
		1139	} elsif (/^\s*(?:#|$)/) {
		1140	# skip other comments and empty lines
		1141	} else {
		1142	last; # stop parsing on first non-empty non-comment line
		1143	}
		1144	}
		1145
		1146	$meta{ext}{$ext} = \%ext;
		1147	}
		1148	}
		1149
		1150	# and now merge resources and bindings
		1151	while (my ($k, $v) = each %{ $meta{ext} }) {
		1152	#TODO: should check for extensions overriding each other
		1153	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1154	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1155	}
		1156	}
		1157
1094	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1158	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1095		1159
1096	Creates a new terminal, very similar as if you had started it with system	1160	Creates a new terminal, very similar as if you had started it with system
1097	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1161	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1098	hash which defines the environment of the new terminal.	1162	hash which defines the environment of the new terminal.
…		…
1115	}	1179	}
1116		1180
1117	=item $term->destroy	1181	=item $term->destroy
1118		1182
1119	Destroy the terminal object (close the window, free resources	1183	Destroy the terminal object (close the window, free resources
1120	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1184	etc.). Please note that urxvt will not exit as long as any event
1121	watchers (timers, io watchers) are still active.	1185	watchers (timers, io watchers) are still active.
1122		1186
1123	=item $term->exec_async ($cmd[, @args])	1187	=item $term->exec_async ($cmd[, @args])
1124		1188
1125	Works like the combination of the C<fork>/C<exec> builtins, which executes	1189	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1149		1213
1150	Returns true if the option specified by C<$optval> is enabled, and	1214	Returns true if the option specified by C<$optval> is enabled, and
1151	optionally change it. All option values are stored by name in the hash	1215	optionally change it. All option values are stored by name in the hash
1152	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1216	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1153		1217
1154	Here is a a likely non-exhaustive list of option names, please see the	1218	Here is a likely non-exhaustive list of option names, please see the
1155	source file F</src/optinc.h> to see the actual list:	1219	source file F</src/optinc.h> to see the actual list:
1156		1220
1157	borderLess console cursorBlink cursorUnderline hold iconic insecure	1221	borderLess buffered console cursorBlink cursorUnderline hold iconic
1158	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1222	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1159	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1223	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1160	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1224	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1161	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1225	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1162	transparent tripleclickwords utmpInhibit visualBell	1226	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1227	urgentOnBell utmpInhibit visualBell
1163		1228
1164	=item $value = $term->resource ($name[, $newval])	1229	=item $value = $term->resource ($name[, $newval])
1165		1230
1166	Returns the current resource value associated with a given name and	1231	Returns the current resource value associated with a given name and
1167	optionally sets a new value. Setting values is most useful in the C<init>	1232	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1176	likely change).	1241	likely change).
1177		1242
1178	Please note that resource strings will currently only be freed when the	1243	Please note that resource strings will currently only be freed when the
1179	terminal is destroyed, so changing options frequently will eat memory.	1244	terminal is destroyed, so changing options frequently will eat memory.
1180		1245
1181	Here is a a likely non-exhaustive list of resource names, not all of which	1246	Here is a likely non-exhaustive list of resource names, not all of which
1182	are supported in every build, please see the source file F</src/rsinc.h>	1247	are supported in every build, please see the source file F</src/rsinc.h>
1183	to see the actual list:	1248	to see the actual list:
1184		1249
1185	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1250	answerbackstring backgroundPixmap backspace_key blurradius
1186	borderLess color cursorBlink cursorUnderline cutchars delete_key	1251	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1187	display_name embed ext_bwidth fade font geometry hold iconName	1252	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1188	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1253	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1254	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1189	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1255	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1190	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1256	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1191	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1257	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1192	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1258	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1193	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1259	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1194	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1260	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1195	secondaryScreen secondaryScroll selectstyle shade term_name title	1261	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1196	transient_for transparent transparent_all tripleclickwords utmpInhibit	1262	term_name title transient_for transparent tripleclickwords urgentOnBell
1197	visualBell	1263	utmpInhibit visualBell
1198		1264
1199	=cut	1265	=cut
1200		1266
1201	sub resource($$;$) {	1267	sub resource($$;$) {
1202	my ($self, $name) = (shift, shift);	1268	my ($self, $name) = (shift, shift);
1203	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1269	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1204	&urxvt::term::_resource	1270	goto &urxvt::term::_resource
1205	}	1271	}
1206		1272
1207	=item $value = $term->x_resource ($pattern)	1273	=item $value = $term->x_resource ($pattern)
1208		1274
1209	Returns the X-Resource for the given pattern, excluding the program or	1275	Returns the X-Resource for the given pattern, excluding the program or
1210	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1276	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1211	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1277	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1212	resource with that pattern exists.	1278	resource with that pattern exists.
1213		1279
		1280	Extensions that define extra resources also need to call this method
		1281	to access their values.
		1282
		1283	If the method is called on an extension object (basically, from an
		1284	extension), then the special prefix C<%.> will be replaced by the name of
		1285	the extension and a dot, and the lone string C<%> will be replaced by the
		1286	extension name itself. This makes it possible to code extensions so you
		1287	can rename them and get a new set of commandline switches and resources
		1288	without having to change the actual code.
		1289
1214	This method should only be called during the C<on_start> hook, as there is	1290	This method should only be called during the C<on_start> hook, as there is
1215	only one resource database per display, and later invocations might return	1291	only one resource database per display, and later invocations might return
1216	the wrong resources.	1292	the wrong resources.
1217		1293
1218	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1294	=item $value = $term->x_resource_boolean ($pattern)
1219		1295
		1296	Like C<x_resource>, above, but interprets the string value as a boolean
		1297	and returns C<1> for true values, C<0> for false values and C<undef> if
		1298	the resource or option isn't specified.
		1299
		1300	You should always use this method to parse boolean resources.
		1301
		1302	=cut
		1303
		1304	sub x_resource_boolean {
		1305	my $res = &x_resource;
		1306
		1307	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1308	}
		1309
		1310	=item $success = $term->bind_action ($key, $octets)
		1311
1220	Adds a keymap translation exactly as specified via a resource. See the	1312	Adds a key binding exactly as specified via a C<keysym> resource. See the
1221	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1313	C<keysym> resource in the urxvt(1) manpage.
1222		1314
1223	=item $rend = $term->rstyle ([$new_rstyle])	1315	=item $rend = $term->rstyle ([$new_rstyle])
1224		1316
1225	Return and optionally change the current rendition. Text that is output by	1317	Return and optionally change the current rendition. Text that is output by
1226	the terminal application will use this style.	1318	the terminal application will use this style.
…		…
1234		1326
1235	=item ($row, $col) = $term->selection_beg ([$row, $col])	1327	=item ($row, $col) = $term->selection_beg ([$row, $col])
1236		1328
1237	=item ($row, $col) = $term->selection_end ([$row, $col])	1329	=item ($row, $col) = $term->selection_end ([$row, $col])
1238		1330
1239	Return the current values of the selection mark, begin or end positions,	1331	Return the current values of the selection mark, begin or end positions.
1240	and optionally set them to new values.	1332
		1333	When arguments are given, then the selection coordinates are set to
		1334	C<$row> and C<$col>, and the selection screen is set to the current
		1335	screen.
		1336
		1337	=item $screen = $term->selection_screen ([$screen])
		1338
		1339	Returns the current selection screen, and then optionally sets it.
1241		1340
1242	=item $term->selection_make ($eventtime[, $rectangular])	1341	=item $term->selection_make ($eventtime[, $rectangular])
1243		1342
1244	Tries to make a selection as set by C<selection_beg> and	1343	Tries to make a selection as set by C<selection_beg> and
1245	C<selection_end>. If C<$rectangular> is true (default: false), a	1344	C<selection_end>. If C<$rectangular> is true (default: false), a
1246	rectangular selection will be made. This is the prefered function to make	1345	rectangular selection will be made. This is the preferred function to make
1247	a selection.	1346	a selection.
1248		1347
1249	=item $success = $term->selection_grab ($eventtime)	1348	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1250		1349
1251	Try to request the primary selection text from the server (for example, as	1350	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1351	true) selection from the server. The corresponding text can be set
1252	set by the next method). No visual feedback will be given. This function	1352	with the next method. No visual feedback will be given. This function
1253	is mostly useful from within C<on_sel_grab> hooks.	1353	is mostly useful from within C<on_sel_grab> hooks.
1254		1354
1255	=item $oldtext = $term->selection ([$newtext])	1355	=item $oldtext = $term->selection ([$newtext, $clipboard])
1256		1356
1257	Return the current selection text and optionally replace it by C<$newtext>.	1357	Return the current selection (clipboard if C<$clipboard> is true) text
		1358	and optionally replace it by C<$newtext>.
		1359
		1360	=item $term->selection_clear ([$clipboard])
		1361
		1362	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1258		1363
1259	=item $term->overlay_simple ($x, $y, $text)	1364	=item $term->overlay_simple ($x, $y, $text)
1260		1365
1261	Create a simple multi-line overlay box. See the next method for details.	1366	Create a simple multi-line overlay box. See the next method for details.
1262		1367
…		…
1292		1397
1293	The methods currently supported on C<urxvt::overlay> objects are:	1398	The methods currently supported on C<urxvt::overlay> objects are:
1294		1399
1295	=over 4	1400	=over 4
1296		1401
1297	=item $overlay->set ($x, $y, $text, $rend)	1402	=item $overlay->set ($x, $y, $text[, $rend])
1298		1403
1299	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1404	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1300	text in rxvt-unicode's special encoding and an array of rendition values	1405	text in rxvt-unicode's special encoding and an array of rendition values
1301	at a specific position inside the overlay.	1406	at a specific position inside the overlay.
		1407
		1408	If C<$rend> is missing, then the rendition will not be changed.
1302		1409
1303	=item $overlay->hide	1410	=item $overlay->hide
1304		1411
1305	If visible, hide the overlay, but do not destroy it.	1412	If visible, hide the overlay, but do not destroy it.
1306		1413
…		…
1388	locale-specific encoding of the terminal and can contain command sequences	1495	locale-specific encoding of the terminal and can contain command sequences
1389	(escape codes) that will be interpreted.	1496	(escape codes) that will be interpreted.
1390		1497
1391	=item $term->tt_write ($octets)	1498	=item $term->tt_write ($octets)
1392		1499
1393	Write the octets given in C<$data> to the tty (i.e. as program input). To	1500	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1394	pass characters instead of octets, you should convert your strings first	1501	pass characters instead of octets, you should convert your strings first
1395	to the locale-specific encoding using C<< $term->locale_encode >>.	1502	to the locale-specific encoding using C<< $term->locale_encode >>.
		1503
		1504	=item $term->tt_write_user_input ($octets)
		1505
		1506	Like C<tt_write>, but should be used when writing strings in response to
		1507	the user pressing a key, to invoke the additional actions requested by
		1508	the user for that case (C<tt_write> doesn't do that).
		1509
		1510	The typical use case would be inside C<on_action> hooks.
		1511
		1512	=item $term->tt_paste ($octets)
		1513
		1514	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1515	CR and bracketing the data with control sequences if bracketed paste mode
		1516	is set.
1396		1517
1397	=item $old_events = $term->pty_ev_events ([$new_events])	1518	=item $old_events = $term->pty_ev_events ([$new_events])
1398		1519
1399	Replaces the event mask of the pty watcher by the given event mask. Can	1520	Replaces the event mask of the pty watcher by the given event mask. Can
1400	be used to suppress input and output handling to the pty/tty. See the	1521	be used to suppress input and output handling to the pty/tty. See the
…		…
1419	Adds the specified events to the vt event mask. Useful e.g. when you want	1540	Adds the specified events to the vt event mask. Useful e.g. when you want
1420	to receive pointer events all the times:	1541	to receive pointer events all the times:
1421		1542
1422	$term->vt_emask_add (urxvt::PointerMotionMask);	1543	$term->vt_emask_add (urxvt::PointerMotionMask);
1423		1544
		1545	=item $term->set_urgency ($set)
		1546
		1547	Enable/disable the urgency hint on the toplevel window.
		1548
1424	=item $term->focus_in	1549	=item $term->focus_in
1425		1550
1426	=item $term->focus_out	1551	=item $term->focus_out
1427		1552
1428	=item $term->key_press ($state, $keycode[, $time])	1553	=item $term->key_press ($state, $keycode[, $time])
…		…
1468	=item $env = $term->env	1593	=item $env = $term->env
1469		1594
1470	Returns a copy of the environment in effect for the terminal as a hashref	1595	Returns a copy of the environment in effect for the terminal as a hashref
1471	similar to C<\%ENV>.	1596	similar to C<\%ENV>.
1472		1597
		1598	=item @envv = $term->envv
		1599
		1600	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1601
		1602	=item @argv = $term->argv
		1603
		1604	Return the argument vector as this terminal, similar to @ARGV, but
		1605	includes the program name as first element.
		1606
1473	=cut	1607	=cut
1474		1608
1475	sub env {	1609	sub env {
1476	if (my $env = $_[0]->_env) {
1477	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1610	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1478	} else {
1479	+{ %ENV }
1480	}
1481	}	1611	}
1482		1612
1483	=item $modifiermask = $term->ModLevel3Mask	1613	=item $modifiermask = $term->ModLevel3Mask
1484		1614
1485	=item $modifiermask = $term->ModMetaMask	1615	=item $modifiermask = $term->ModMetaMask
…		…
1493		1623
1494	Returns the currently displayed screen (0 primary, 1 secondary).	1624	Returns the currently displayed screen (0 primary, 1 secondary).
1495		1625
1496	=item $cursor_is_hidden = $term->hidden_cursor	1626	=item $cursor_is_hidden = $term->hidden_cursor
1497		1627
1498	Returns wether the cursor is currently hidden or not.	1628	Returns whether the cursor is currently hidden or not.
1499		1629
1500	=item $view_start = $term->view_start ([$newvalue])	1630	=item $view_start = $term->view_start ([$newvalue])
1501		1631
1502	Returns the row number of the topmost displayed line. Maximum value is	1632	Returns the row number of the topmost displayed line. Maximum value is
1503	C<0>, which displays the normal terminal contents. Lower values scroll	1633	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1511		1641
1512	Used after changing terminal contents to display them.	1642	Used after changing terminal contents to display them.
1513		1643
1514	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1644	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1515		1645
1516	Returns the text of the entire row with number C<$row_number>. Row C<0>	1646	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1517	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1647	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1518	terminal line. The scrollback buffer starts at line C<-1> and extends to
1519	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1648	terminal line. Nothing will be returned if a nonexistent line
1520	is requested.	1649	is requested.
1521		1650
1522	If C<$new_text> is specified, it will replace characters in the current	1651	If C<$new_text> is specified, it will replace characters in the current
1523	line, starting at column C<$start_col> (default C<0>), which is useful	1652	line, starting at column C<$start_col> (default C<0>), which is useful
1524	to replace only parts of a line. The font index in the rendition will	1653	to replace only parts of a line. The font index in the rendition will
1525	automatically be updated.	1654	automatically be updated.
1526		1655
1527	C<$text> is in a special encoding: tabs and wide characters that use more	1656	C<$text> is in a special encoding: tabs and wide characters that use more
1528	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1657	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1529	characters. Characters with combining characters and other characters that	1658	characters. Characters with combining characters and other characters that
1530	do not fit into the normal tetx encoding will be replaced with characters	1659	do not fit into the normal text encoding will be replaced with characters
1531	in the private use area.	1660	in the private use area.
1532		1661
1533	You have to obey this encoding when changing text. The advantage is	1662	You have to obey this encoding when changing text. The advantage is
1534	that C<substr> and similar functions work on screen cells and not on	1663	that C<substr> and similar functions work on screen cells and not on
1535	characters.	1664	characters.
…		…
1620	}	1749	}
1621		1750
1622	sub urxvt::line::t {	1751	sub urxvt::line::t {
1623	my ($self) = @_;	1752	my ($self) = @_;
1624		1753
1625	if (@_ > 1)	1754	if (@_ > 1) {
1626	{
1627	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1755	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1628	for $self->{beg} .. $self->{end};	1756	for $self->{beg} .. $self->{end};
1629	}	1757	}
1630		1758
1631	defined wantarray &&	1759	defined wantarray &&
1632	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1760	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1633	0, $self->{len}	1761	0, $self->{len}
1634	}	1762	}
1635		1763
1636	sub urxvt::line::r {	1764	sub urxvt::line::r {
1637	my ($self) = @_;	1765	my ($self) = @_;
1638		1766
1639	if (@_ > 1)	1767	if (@_ > 1) {
1640	{
1641	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1768	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1642	for $self->{beg} .. $self->{end};	1769	for $self->{beg} .. $self->{end};
1643	}	1770	}
1644		1771
1645	if (defined wantarray) {	1772	if (defined wantarray) {
1646	my $rend = [	1773	my $rend = [
1647	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1774	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1648	];	1775	];
…		…
1680	where one character corresponds to one screen cell. See	1807	where one character corresponds to one screen cell. See
1681	C<< $term->ROW_t >> for details.	1808	C<< $term->ROW_t >> for details.
1682		1809
1683	=item $string = $term->special_decode $text	1810	=item $string = $term->special_decode $text
1684		1811
1685	Converts rxvt-unicodes text reprsentation into a perl string. See	1812	Converts rxvt-unicodes text representation into a perl string. See
1686	C<< $term->ROW_t >> for details.	1813	C<< $term->ROW_t >> for details.
1687		1814
1688	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1815	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1689		1816
1690	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1817	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1693	manpage.	1820	manpage.
1694		1821
1695	=item $success = $term->grab ($eventtime[, $sync])	1822	=item $success = $term->grab ($eventtime[, $sync])
1696		1823
1697	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1824	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1698	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1825	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1699		1826
1700	=item $term->allow_events_async	1827	=item $term->allow_events_async
1701		1828
1702	Calls XAllowEvents with AsyncBoth for the most recent grab.	1829	Calls XAllowEvents with AsyncBoth for the most recent grab.
1703		1830
…		…
1710	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1837	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1711	recent grab.	1838	recent grab.
1712		1839
1713	=item $term->ungrab	1840	=item $term->ungrab
1714		1841
1715	Calls XUngrab for the most recent grab. Is called automatically on	1842	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1716	evaluation errors, as it is better to lose the grab in the error case as	1843	evaluation errors, as it is better to lose the grab in the error case as
1717	the session.	1844	the session.
1718		1845
1719	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1846	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1720		1847
…		…
1722		1849
1723	=item @atoms = $term->XListProperties ($window)	1850	=item @atoms = $term->XListProperties ($window)
1724		1851
1725	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1852	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1726		1853
1727	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1854	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1728		1855
1729	=item $term->XDeleteProperty ($window, $property)	1856	=item $term->XDeleteProperty ($window, $property)
1730		1857
1731	=item $window = $term->DefaultRootWindow	1858	=item $window = $term->DefaultRootWindow
1732		1859
…		…
1739	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1866	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1740		1867
1741	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1868	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1742		1869
1743	=item $term->XChangeInput ($window, $add_events[, $del_events])	1870	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1871
		1872	=item $keysym = $term->XStringToKeysym ($string)
		1873
		1874	=item $string = $term->XKeysymToString ($keysym)
1744		1875
1745	Various X or X-related functions. The C<$term> object only serves as	1876	Various X or X-related functions. The C<$term> object only serves as
1746	the source of the display, otherwise those functions map more-or-less	1877	the source of the display, otherwise those functions map more-or-less
1747	directory onto the X functions of the same name.	1878	directly onto the X functions of the same name.
1748		1879
1749	=back	1880	=back
1750		1881
1751	=cut	1882	=cut
1752		1883
…		…
1854	my $env = $self->{term}->env;	1985	my $env = $self->{term}->env;
1855	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1986	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1856	delete $env->{LC_ALL};	1987	delete $env->{LC_ALL};
1857	$env->{LC_CTYPE} = $self->{term}->locale;	1988	$env->{LC_CTYPE} = $self->{term}->locale;
1858		1989
1859	urxvt::term->new ($env, "popup",	1990	my $term = urxvt::term->new (
		1991	$env, "popup",
1860	"--perl-lib" => "", "--perl-ext-common" => "",	1992	"--perl-lib" => "", "--perl-ext-common" => "",
1861	"-pty-fd" => -1, "-sl" => 0,	1993	"-pty-fd" => -1, "-sl" => 0,
1862	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1994	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1863	"--transient-for" => $self->{term}->parent,	1995	"--transient-for" => $self->{term}->parent,
1864	"-display" => $self->{term}->display_id,	1996	"-display" => $self->{term}->display_id,
1865	"-pe" => "urxvt-popup")	1997	"-pe" => "urxvt-popup",
1866	or die "unable to create popup window\n";	1998	) or die "unable to create popup window\n";
		1999
		2000	unless (delete $term->{urxvt_popup_init_done}) {
		2001	$term->ungrab;
		2002	$term->destroy;
		2003	die "unable to initialise popup window\n";
		2004	}
1867	}	2005	}
1868		2006
1869	sub DESTROY {	2007	sub DESTROY {
1870	my ($self) = @_;	2008	my ($self) = @_;
1871		2009
…		…
1876	=back	2014	=back
1877		2015
1878	=cut	2016	=cut
1879		2017
1880	package urxvt::watcher;	2018	package urxvt::watcher;
1881
1882	@urxvt::timer::ISA = __PACKAGE__;
1883	@urxvt::iow::ISA = __PACKAGE__;
1884	@urxvt::pw::ISA = __PACKAGE__;
1885	@urxvt::iw::ISA = __PACKAGE__;
1886		2019
1887	=head2 The C<urxvt::timer> Class	2020	=head2 The C<urxvt::timer> Class
1888		2021
1889	This class implements timer watchers/events. Time is represented as a	2022	This class implements timer watchers/events. Time is represented as a
1890	fractional number of seconds since the epoch. Example:	2023	fractional number of seconds since the epoch. Example:
…		…
1894	->new	2027	->new
1895	->interval (1)	2028	->interval (1)
1896	->cb (sub {	2029	->cb (sub {
1897	$term->{overlay}->set (0, 0,	2030	$term->{overlay}->set (0, 0,
1898	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2031	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1899	});	2032	});
1900		2033
1901	=over 4	2034	=over 4
1902		2035
1903	=item $timer = new urxvt::timer	2036	=item $timer = new urxvt::timer
1904		2037
…		…
1907		2040
1908	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2041	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1909		2042
1910	Set the callback to be called when the timer triggers.	2043	Set the callback to be called when the timer triggers.
1911		2044
1912	=item $tstamp = $timer->at
1913
1914	Return the time this watcher will fire next.
1915
1916	=item $timer = $timer->set ($tstamp)	2045	=item $timer = $timer->set ($tstamp[, $interval])
1917		2046
1918	Set the time the event is generated to $tstamp.	2047	Set the time the event is generated to $tstamp (and optionally specifies a
		2048	new $interval).
1919		2049
1920	=item $timer = $timer->interval ($interval)	2050	=item $timer = $timer->interval ($interval)
1921		2051
1922	Normally (and when C<$interval> is C<0>), the timer will automatically	2052	By default (and when C<$interval> is C<0>), the timer will automatically
1923	stop after it has fired once. If C<$interval> is non-zero, then the timer	2053	stop after it has fired once. If C<$interval> is non-zero, then the timer
1924	is automatically rescheduled at the given intervals.	2054	is automatically rescheduled at the given intervals.
1925		2055
1926	=item $timer = $timer->start	2056	=item $timer = $timer->start
1927		2057
1928	Start the timer.	2058	Start the timer.
1929		2059
1930	=item $timer = $timer->start ($tstamp)	2060	=item $timer = $timer->start ($tstamp[, $interval])
1931		2061
1932	Set the event trigger time to C<$tstamp> and start the timer.	2062	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2063	also replaces the interval.
1933		2064
1934	=item $timer = $timer->after ($delay)	2065	=item $timer = $timer->after ($delay[, $interval])
1935		2066
1936	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2067	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1937		2068
1938	=item $timer = $timer->stop	2069	=item $timer = $timer->stop
1939		2070
…		…
1947		2078
1948	$term->{socket} = ...	2079	$term->{socket} = ...
1949	$term->{iow} = urxvt::iow	2080	$term->{iow} = urxvt::iow
1950	->new	2081	->new
1951	->fd (fileno $term->{socket})	2082	->fd (fileno $term->{socket})
1952	->events (urxvt::EVENT_READ)	2083	->events (urxvt::EV_READ)
1953	->start	2084	->start
1954	->cb (sub {	2085	->cb (sub {
1955	my ($iow, $revents) = @_;	2086	my ($iow, $revents) = @_;
1956	# $revents must be 1 here, no need to check	2087	# $revents must be 1 here, no need to check
1957	sysread $term->{socket}, my $buf, 8192	2088	sysread $term->{socket}, my $buf, 8192
…		…
1970	Set the callback to be called when io events are triggered. C<$reventmask>	2101	Set the callback to be called when io events are triggered. C<$reventmask>
1971	is a bitset as described in the C<events> method.	2102	is a bitset as described in the C<events> method.
1972		2103
1973	=item $iow = $iow->fd ($fd)	2104	=item $iow = $iow->fd ($fd)
1974		2105
1975	Set the filedescriptor (not handle) to watch.	2106	Set the file descriptor (not handle) to watch.
1976		2107
1977	=item $iow = $iow->events ($eventmask)	2108	=item $iow = $iow->events ($eventmask)
1978		2109
1979	Set the event mask to watch. The only allowed values are	2110	Set the event mask to watch. The only allowed values are
1980	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2111	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1981	together, or C<urxvt::EVENT_NONE>.	2112	together, or C<urxvt::EV_NONE>.
1982		2113
1983	=item $iow = $iow->start	2114	=item $iow = $iow->start
1984		2115
1985	Start watching for requested events on the given handle.	2116	Start watching for requested events on the given handle.
1986		2117
1987	=item $iow = $iow->stop	2118	=item $iow = $iow->stop
1988		2119
1989	Stop watching for events on the given filehandle.	2120	Stop watching for events on the given file handle.
1990		2121
1991	=back	2122	=back
1992		2123
1993	=head2 The C<urxvt::iw> Class	2124	=head2 The C<urxvt::iw> Class
1994		2125
…		…
2027	->new	2158	->new
2028	->start ($pid)	2159	->start ($pid)
2029	->cb (sub {	2160	->cb (sub {
2030	my ($pw, $exit_status) = @_;	2161	my ($pw, $exit_status) = @_;
2031	...	2162	...
2032	});	2163	});
2033		2164
2034	=over 4	2165	=over 4
2035		2166
2036	=item $pw = new urxvt::pw	2167	=item $pw = new urxvt::pw
2037		2168
…		…
2041		2172
2042	Set the callback to be called when the timer triggers.	2173	Set the callback to be called when the timer triggers.
2043		2174
2044	=item $pw = $timer->start ($pid)	2175	=item $pw = $timer->start ($pid)
2045		2176
2046	Tells the wqtcher to start watching for process C<$pid>.	2177	Tells the watcher to start watching for process C<$pid>.
2047		2178
2048	=item $pw = $pw->stop	2179	=item $pw = $pw->stop
2049		2180
2050	Stop the watcher.	2181	Stop the watcher.
2051		2182
…		…
2064		2195
2065	=item >= 3 - script loading and management	2196	=item >= 3 - script loading and management
2066		2197
2067	=item >=10 - all called hooks	2198	=item >=10 - all called hooks
2068		2199
2069	=item >=11 - hook reutrn values	2200	=item >=11 - hook return values
2070		2201
2071	=back	2202	=back
2072		2203
2073	=head1 AUTHOR	2204	=head1 AUTHOR
2074		2205
2075	Marc Lehmann <pcg@goof.com>	2206	Marc Lehmann <schmorp@schmorp.de>
2076	http://software.schmorp.de/pkg/rxvt-unicode	2207	http://software.schmorp.de/pkg/rxvt-unicode
2077		2208
2078	=cut	2209	=cut
2079		2210
2080	1	2211	1
		2212
		2213	# vim: sw=3:

Diff Legend

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