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

Diff Legend

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