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.138 by root, Sat Mar 4 22:36:50 2006 UTC vs.
Revision 1.238 by root, Sun May 18 18:15:04 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
159	the moment, it reacts to clicking shift-left mouse button by trying to
160	move the text cursor to this position. It does so by generating as many
161	cursor-left or cursor-right keypresses as required (the this only works
162	for programs that correctly support wide characters).
163
164	To avoid too many false positives, this is only done when:
165
166	=over 4
167
168	=item - the tty is in ICANON state.
169
170	=item - the text cursor is visible.
171
172	=item - the primary screen is currently being displayed.
173
174	=item - the mouse is on the same (multi-row-) line as the text cursor.
175
176	=back
177
178	The normal selection mechanism isn't disabled, so quick successive clicks
179	might interfere with selection creation in harmless ways.
180
181	=item selection-autotransform
182
183	This selection allows you to do automatic transforms on a selection
184	whenever a selection is made.
185
186	It works by specifying perl snippets (most useful is a single C<s///>
187	operator) that modify C<$_> as resources:
188
189	URxvt.selection-autotransform.0: transform
190	URxvt.selection-autotransform.1: transform
191	...
192
193	For example, the following will transform selections of the form
194	C<filename:number>, often seen in compiler messages, into C<vi +$filename
195	$word>:
196
197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
198
199	And this example matches the same,but replaces it with vi-commands you can
200	paste directly into your (vi :) editor:
201
202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
203
204	Of course, this can be modified to suit your needs and your editor :)
205
206	To expand the example above to typical perl error messages ("XXX at
207	FILENAME line YYY."), you need a slightly more elaborate solution:
208
209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
211
212	The first line tells the selection code to treat the unchanging part of
213	every error message as a selection pattern, and the second line transforms
214	the message into vi commands to load the file.
215
216	=item tabbed
217
218	This transforms the terminal into a tabbar with additional terminals, that
219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
221	button per tab.
222
223	Clicking a button will activate that tab. Pressing B<Shift-Left> and
224	B<Shift-Right> will switch to the tab left or right of the current one,
225	while B<Shift-Down> creates a new tab.
226
227	The tabbar itself can be configured similarly to a normal terminal, but
228	with a resource class of C<URxvt.tabbed>. In addition, it supports the
229	following four resources (shown with defaults):
230
231	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
232	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
233	URxvt.tabbed.tab-fg: <colour-index, default 0>
234	URxvt.tabbed.tab-bg: <colour-index, default 1>
235
236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237	indices.
238
239	=item mark-urls
240
241	Uses per-line display filtering (C<on_line_update>) to underline urls and
242	make them clickable. When middle-clicked, the program specified in the
243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
244	the URL as first argument.
245
246	=item xim-onthespot
247
248	This (experimental) perl extension implements OnTheSpot editing. It does
249	not work perfectly, and some input methods don't seem to work well with
250	OnTheSpot editing in general, but it seems to work at leats for SCIM and
251	kinput2.
252
253	You enable it by specifying this extension and a preedit style of
254	C<OnTheSpot>, i.e.:
255
256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257
258	=item automove-background
259
260	This is basically a one-line extension that dynamically changes the background pixmap offset
261	to the window position, in effect creating the same effect as pseudo transparency with
262	a custom pixmap. No scaling is supported in this mode. Exmaple:
263
264	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
265
266	=item block-graphics-to-ascii
267
268	A not very useful example of filtering all text output to the terminal,
269	by replacing all line-drawing characters (U+2500 .. U+259F) by a
270	similar-looking ascii character.
271
272	=item digital-clock
273
274	Displays a digital clock using the built-in overlay.
275
276	=item remote-clipboard
277
278	Somewhat of a misnomer, this extension adds two menu entries to the
279	selection popup that allows one ti run external commands to store the
280	selection somewhere and fetch it again.
281
282	We use it to implement a "distributed selection mechanism", which just
283	means that one command uploads the file to a remote server, and another
284	reads it.
285
286	The commands can be set using the C<URxvt.remote-selection.store> and
287	C<URxvt.remote-selection.fetch> resources. The first should read the
288	selection to store from STDIN (always in UTF-8), the second should provide
289	the selection data on STDOUT (also in UTF-8).
290
291	The defaults (which are likely useless to you) use rsh and cat:
292
293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
295
296	=item selection-pastebin
297
298	This is a little rarely useful extension that Uploads the selection as
299	textfile to a remote site (or does other things). (The implementation is
300	not currently secure for use in a multiuser environment as it writes to
301	F</tmp> directly.).
302
303	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
304	i.e.
305
306	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
307
308	Pressing this combination runs a command with C<%> replaced by the name of
309	the textfile. This command can be set via a resource:
310
311	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
312
313	And the default is likely not useful to anybody but the few people around
314	here :)
315
316	The name of the textfile is the hex encoded md5 sum of the selection, so
317	the same content should lead to the same filename.
318
319	After a successful upload the selection will be replaced by the text given
320	in the C<selection-pastebin-url> resource (again, the % is the placeholder
321	for the filename):
322
323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
324
325	=item example-refresh-hooks
326
327	Displays a very simple digital clock in the upper right corner of the
328	window. Illustrates overwriting the refresh callbacks to create your own
329	overlays or changes.
330
331	=back
332		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, $op, $args	205	=item on_osc_seq $term, $op, $args, $resp
499		206
500	Called on every OSC sequence and can be used to suppress it or modify its	207	Called on every OSC sequence and can be used to suppress it or modify its
501	behaviour. The default should be to return an empty list. A true value	208	behaviour. The default should be to return an empty list. A true value
502	suppresses execution of the request completely. Make sure you don't get	209	suppresses execution of the request completely. Make sure you don't get
503	confused by recursive invocations when you output an osc sequence within	210	confused by recursive invocations when you output an OSC sequence within
504	this callback.	211	this callback.
505		212
506	C<on_osc_seq_perl> should be used for new behaviour.	213	C<on_osc_seq_perl> should be used for new behaviour.
507		214
508	=item on_osc_seq_perl $term, $string	215	=item on_osc_seq_perl $term, $args, $resp
509		216
510	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
511	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
512	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
513	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,
514	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
515	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	}
516		233
517	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,
518	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
519	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.
520		240
521	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
522		242
523	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
524	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
…		…
529	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
530		250
531	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
532	suppress or filter tty input.	252	suppress or filter tty input.
533		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
534	=item on_line_update $term, $row	261	=item on_line_update $term, $row
535		262
536	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
537	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
538	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,
…		…
545	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
546	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
547		274
548	=item on_refresh_begin $term	275	=item on_refresh_begin $term
549		276
550	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
551	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
552	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
553	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
554		281
555	=item on_refresh_end $term	282	=item on_refresh_end $term
556		283
557	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>.
558		285
559	=item on_user_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
560		287
561	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
562	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>
563	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
564		291
565	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
566	slightly in the future.	293	preference to the C<on_action> hook.
567		294
568	=item on_resize_all_windows $tern, $new_width, $new_height	295	=item on_resize_all_windows $term, $new_width, $new_height
569		296
570	Called just after the new window size has been calculcated, but before	297	Called just after the new window size has been calculated, but before
571	windows are actually being resized or hints are being set. If this hook	298	windows are actually being resized or hints are being set. If this hook
572	returns TRUE, setting of the window hints is being skipped.	299	returns a true value, setting of the window hints is being skipped.
573		300
574	=item on_x_event $term, $event	301	=item on_x_event $term, $event
575		302
576	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
577	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
578	members are not passed.	305	members are not passed.
579		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
580	=item on_focus_in $term	311	=item on_focus_in $term
581		312
582	Called whenever the window gets the keyboard focus, before rxvt-unicode	313	Called whenever the window gets the keyboard focus, before rxvt-unicode
583	does focus in processing.	314	does focus in processing.
584		315
585	=item on_focus_out $term	316	=item on_focus_out $term
586		317
587	Called wheneever the window loses keyboard focus, before rxvt-unicode does	318	Called whenever the window loses keyboard focus, before rxvt-unicode does
588	focus out processing.	319	focus out processing.
589		320
590	=item on_configure_notify $term, $event	321	=item on_configure_notify $term, $event
591		322
592	=item on_property_notify $term, $event	323	=item on_property_notify $term, $event
…		…
603		334
604	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
605		336
606	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
607		338
608	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
609	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.
610		341
611	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
612	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
613	(real, not screen-based) row and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
614		345
615	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
616	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
617		348
618	subwindow.
619
620	=item on_client_message $term, $event	349	=item on_client_message $term, $event
621		350
622	=item on_wm_protocols $term, $event	351	=item on_wm_protocols $term, $event
623		352
624	=item on_wm_delete_window $term, $event	353	=item on_wm_delete_window $term, $event
625		354
626	Called when various types of ClientMessage events are received (all with	355	Called when various types of ClientMessage events are received (all with
627	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	356	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
628		357
		358	=item on_bell $term
		359
		360	Called on receipt of a bell character.
		361
629	=back	362	=back
630		363
631	=cut	364	=cut
632		365
633	package urxvt;	366	package urxvt;
634		367
635	use utf8;	368	use utf8;
636	use strict;	369	use strict 'vars';
637	use Carp ();	370	use Carp ();
638	use Scalar::Util ();	371	use Scalar::Util ();
639	use List::Util ();	372	use List::Util ();
640		373
641	our $VERSION = 1;	374	our $VERSION = 1;
642	our $TERM;	375	our $TERM;
643	our @TERM_INIT;	376	our @TERM_INIT; # should go, prevents async I/O etc.
644	our @TERM_EXT;	377	our @TERM_EXT; # should go, prevents async I/O etc.
645	our @HOOKNAME;	378	our @HOOKNAME;
646	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
647	our %OPTION;	380	our %OPTION;
648		381
649	our $LIBDIR;	382	our $LIBDIR;
…		…
675	The current terminal. This variable stores the current C<urxvt::term>	408	The current terminal. This variable stores the current C<urxvt::term>
676	object, whenever a callback/hook is executing.	409	object, whenever a callback/hook is executing.
677		410
678	=item @urxvt::TERM_INIT	411	=item @urxvt::TERM_INIT
679		412
680	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
681	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
682	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,
683	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.
684		417
685	This complements to the perl-eval commandline option, but gets executed	418	This complements to the perl-eval command line option, but gets executed
686	first.	419	first.
687		420
688	=item @urxvt::TERM_EXT	421	=item @urxvt::TERM_EXT
689		422
690	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
…		…
697		430
698	=over 4	431	=over 4
699		432
700	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
701		434
702	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
703	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
704	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
705		439
706	=item urxvt::warn $string	440	=item urxvt::warn $string
707		441
708	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
709	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
710	that calls this function.	444	that calls this function.
711		445
712	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
713	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
715	Messages have a size limit of 1023 bytes currently.	449	Messages have a size limit of 1023 bytes currently.
716		450
717	=item @terms = urxvt::termlist	451	=item @terms = urxvt::termlist
718		452
719	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
720	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
721	objects that have perl extensions attached will be returned (because there	455	objects that have perl extensions attached will be returned (because there
722	is no urxvt::term objet associated with others).	456	is no urxvt::term object associated with others).
723		457
724	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
725		459
726	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
727		461
…		…
770		504
771	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
772		506
773	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
774		508
775	=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
776		511
777	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
778	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
779	the bitset.	514	the bitset.
780		515
…		…
817	};	552	};
818	}	553	}
819		554
820	no warnings 'utf8';	555	no warnings 'utf8';
821		556
		557	sub parse_resource {
		558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		559
		560	$name =~ y/-/./ if $isarg;
		561
		562	$term->scan_extensions;
		563
		564	my $r = $term->{meta}{resource};
		565	keys %$r; # reset iterator
		566	while (my ($pattern, $v) = each %$r) {
		567	if (
		568	$pattern =~ /\.$/
		569	? $pattern eq substr $name, 0, length $pattern
		570	: $pattern eq $name
		571	) {
		572	$name = "$urxvt::RESCLASS.$name";
		573
		574	push @{ $term->{perl_ext_3} }, $v->[0];
		575
		576	if ($v->[1] eq "boolean") {
		577	$term->put_option_db ($name, $flag ? "true" : "false");
		578	return 1;
		579	} else {
		580	$term->put_option_db ($name, $value);
		581	return 1 + 2;
		582	}
		583	}
		584	}
		585
		586	0
		587	}
		588
		589	sub usage {
		590	my ($term, $usage_type) = @_;
		591
		592	$term->scan_extensions;
		593
		594	my $r = $term->{meta}{resource};
		595
		596	for my $pattern (sort keys %$r) {
		597	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		598
		599	$desc .= " (-pe $ext)";
		600
		601	if ($usage_type == 1) {
		602	$pattern =~ y/./-/;
		603	$pattern =~ s/-$/-.../g;
		604
		605	if ($type eq "boolean") {
		606	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		607	} else {
		608	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		609	}
		610	} else {
		611	$pattern =~ s/\.$/.*/g;
		612	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		613	}
		614	}
		615	}
		616
822	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
823		618
824	sub verbose {	619	sub verbose {
825	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
826	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
…		…
838	$pkg =~ s/[^[:word:]]/_/g;	633	$pkg =~ s/[^[:word:]]/_/g;
839	$pkg = "urxvt::ext::$pkg";	634	$pkg = "urxvt::ext::$pkg";
840		635
841	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
842		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		639
843	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
844	or die "$path: $!";	641	or die "$path: $!";
845		642
846	my $source =	643	my $source =
847	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
848	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
849	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
850	. "\n};\n1";	647	. "\n};\n1";
851		648
852	eval $source	649	eval $source
…		…
861	# called by the rxvt core	658	# called by the rxvt core
862	sub invoke {	659	sub invoke {
863	local $TERM = shift;	660	local $TERM = shift;
864	my $htype = shift;	661	my $htype = shift;
865		662
866	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
867	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
868		665
		666	$TERM->scan_extensions;
		667
869	my %ext_arg;	668	my %ext_arg;
870		669
871	{	670	{
872	my @init = @TERM_INIT;	671	my @init = @TERM_INIT;
873	@TERM_INIT = ();	672	@TERM_INIT = ();
…		…
875	my @pkg = @TERM_EXT;	674	my @pkg = @TERM_EXT;
876	@TERM_EXT = ();	675	@TERM_EXT = ();
877	$TERM->register_package ($_) for @pkg;	676	$TERM->register_package ($_) for @pkg;
878	}	677	}
879		678
		679	for (
880	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	680	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		681	) {
881	if ($_ eq "default") {	682	if ($_ eq "default") {
882	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	683
		684	$ext_arg{$_} = []
		685	for
		686	qw(selection option-popup selection-popup readline),
		687	map $_->[0], values %{ $TERM->{meta}{binding} },
		688	@{ delete $TERM->{perl_ext_3} };
		689
		690	for ($TERM->_keysym_resources) {
		691	next if /^(?:string|command|builtin|builtin-string|perl)/;
		692	next unless /^([A-Za-z0-9_\-]+):/;
		693
		694	my $ext = $1;
		695	$ext =~ y/-/_/;
		696
		697	$ext_arg{$ext} = [];
		698	}
		699
883	} elsif (/^-(.*)$/) {	700	} elsif (/^-(.*)$/) {
884	delete $ext_arg{$1};	701	delete $ext_arg{$1};
		702
885	} elsif (/^([^<]+)<(.*)>$/) {	703	} elsif (/^([^<]+)<(.*)>$/) {
886	push @{ $ext_arg{$1} }, $2;	704	push @{ $ext_arg{$1} }, $2;
		705
887	} else {	706	} else {
888	$ext_arg{$_} ||= [];	707	$ext_arg{$_} ||= [];
		708	}
		709	}
		710
		711	# now register default key bindings
		712	for my $ext (sort keys %ext_arg) {
		713	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		714	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
889	}	715	}
890	}	716	}
891		717
892	for my $ext (sort keys %ext_arg) {	718	for my $ext (sort keys %ext_arg) {
893	my @files = grep -f $_, map "$_/$ext", @dirs;	719	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
907		733
908	if (my $cb = $TERM->{_hook}[$htype]) {	734	if (my $cb = $TERM->{_hook}[$htype]) {
909	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	735	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
910	if $verbosity >= 10;	736	if $verbosity >= 10;
911		737
		738	if ($htype == HOOK_ACTION) {
		739	# this hook is only sent to the extension with the name
		740	# matching the first arg
		741	my $pkg = shift;
		742	$pkg =~ y/-/_/;
		743	$pkg = "urxvt::ext::$pkg";
		744
		745	$cb = $cb->{$pkg}
		746	or return undef; #TODO: maybe warn user?
		747
		748	$cb = { $pkg => $cb };
		749	}
		750
912	for my $pkg (keys %$cb) {	751	for my $pkg (keys %$cb) {
913	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	752	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
914	$retval ||= $retval_;	753	$retval ||= $retval_;
915		754
916	if ($@) {	755	if ($@) {
917	$TERM->ungrab; # better to lose the grab than the session	756	$TERM->ungrab; # better to lose the grab than the session
918	warn $@;	757	warn $@;
…		…
921		760
922	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	761	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
923	if $verbosity >= 11;	762	if $verbosity >= 11;
924	}	763	}
925		764
926	if ($htype == 1) { # DESTROY	765	if ($htype == HOOK_DESTROY) {
927	# clear package objects	766	# clear package objects
928	%$_ = () for values %{ $TERM->{_pkg} };	767	%$_ = () for values %{ $TERM->{_pkg} };
929		768
930	# clear package	769	# clear package
931	%$TERM = ();	770	%$TERM = ();
…		…
936		775
937	sub SET_COLOR($$$) {	776	sub SET_COLOR($$$) {
938	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	777	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
939	}	778	}
940		779
941	# urxvt::term::extension	780	sub rend2mask {
		781	no strict 'refs';
		782	my ($str, $mask) = (@_, 0);
		783	my %color = ( fg => undef, bg => undef );
		784	my @failed;
		785	for my $spec ( split /\s+/, $str ) {
		786	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		787	$color{lc($1)} = $2;
		788	} else {
		789	my $neg = $spec =~ s/^[-^]//;
		790	unless ( exists &{"RS_$spec"} ) {
		791	push @failed, $spec;
		792	next;
		793	}
		794	my $cur = &{"RS_$spec"};
		795	if ( $neg ) {
		796	$mask &= ~$cur;
		797	} else {
		798	$mask |= $cur;
		799	}
		800	}
		801	}
		802	($mask, @color{qw(fg bg)}, \@failed)
		803	}
942		804
943	package urxvt::term::extension;	805	package urxvt::term::extension;
944		806
945	sub enable {	807	=head2 The C<urxvt::term::extension> class
946	my ($self, %hook) = @_;
947	my $pkg = $self->{_pkg};
948		808
949	while (my ($name, $cb) = each %hook) {	809	Each extension attached to a terminal object is represented by
950	my $htype = $HOOKTYPE{uc $name};	810	a C<urxvt::term::extension> object.
951	defined $htype
952	or Carp::croak "unsupported hook type '$name'";
953		811
954	$self->set_should_invoke ($htype, +1)	812	You can use these objects, which are passed to all callbacks to store any
955	unless exists $self->{term}{_hook}[$htype]{$pkg};	813	state related to the terminal and extension instance.
956		814
957	$self->{term}{_hook}[$htype]{$pkg} = $cb;	815	The methods (And data members) documented below can be called on extension
958	}	816	objects, in addition to call methods documented for the <urxvt::term>
959	}	817	class.
960		818
961	sub disable {	819	=over 4
962	my ($self, @hook) = @_;
963	my $pkg = $self->{_pkg};
964		820
965	for my $name (@hook) {	821	=item $urxvt_term = $self->{term}
966	my $htype = $HOOKTYPE{uc $name};
967	defined $htype
968	or Carp::croak "unsupported hook type '$name'";
969		822
970	$self->set_should_invoke ($htype, -1)	823	Returns the C<urxvt::term> object associated with this instance of the
971	if delete $self->{term}{_hook}[$htype]{$pkg};	824	extension. This member I<must not> be changed in any way.
972	}	825
973	}	826	=cut
974		827
975	our $AUTOLOAD;	828	our $AUTOLOAD;
976		829
977	sub AUTOLOAD {	830	sub AUTOLOAD {
978	$AUTOLOAD =~ /:([^:]+)$/	831	$AUTOLOAD =~ /:([^:]+)$/
…		…
991		844
992	sub DESTROY {	845	sub DESTROY {
993	# nop	846	# nop
994	}	847	}
995		848
996	# urxvt::destroy_hook	849	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
997		850
998	sub urxvt::destroy_hook::DESTROY {	851	sub urxvt::destroy_hook::DESTROY {
999	${$_[0]}->();	852	${$_[0]}->();
1000	}	853	}
1001		854
1002	sub urxvt::destroy_hook(&) {	855	sub urxvt::destroy_hook(&) {
1003	bless \shift, urxvt::destroy_hook::	856	bless \shift, urxvt::destroy_hook::
1004	}	857	}
		858
		859	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		860
		861	Dynamically enable the given hooks (named without the C<on_> prefix) for
		862	this extension, replacing any hook previously installed via C<enable> in
		863	this extension.
		864
		865	This is useful when you want to overwrite time-critical hooks only
		866	temporarily.
		867
		868	To install additional callbacks for the same hook, you can use the C<on>
		869	method of the C<urxvt::term> class.
		870
		871	=item $self->disable ($hook_name[, $hook_name..])
		872
		873	Dynamically disable the given hooks.
		874
		875	=cut
		876
		877	sub enable {
		878	my ($self, %hook) = @_;
		879	my $pkg = $self->{_pkg};
		880
		881	while (my ($name, $cb) = each %hook) {
		882	my $htype = $HOOKTYPE{uc $name};
		883	defined $htype
		884	or Carp::croak "unsupported hook type '$name'";
		885
		886	$self->set_should_invoke ($htype, +1)
		887	unless exists $self->{term}{_hook}[$htype]{$pkg};
		888
		889	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		890	}
		891	}
		892
		893	sub disable {
		894	my ($self, @hook) = @_;
		895	my $pkg = $self->{_pkg};
		896
		897	for my $name (@hook) {
		898	my $htype = $HOOKTYPE{uc $name};
		899	defined $htype
		900	or Carp::croak "unsupported hook type '$name'";
		901
		902	$self->set_should_invoke ($htype, -1)
		903	if delete $self->{term}{_hook}[$htype]{$pkg};
		904	}
		905	}
		906
		907	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		908
		909	Similar to the C<enable> enable, but installs additional callbacks for
		910	the given hook(s) (that is, it doesn't replace existing callbacks), and
		911	returns a guard object. When the guard object is destroyed the callbacks
		912	are disabled again.
		913
		914	=cut
		915
		916	sub urxvt::extension::on_disable::DESTROY {
		917	my $disable = shift;
		918
		919	my $term = delete $disable->{""};
		920
		921	while (my ($htype, $id) = each %$disable) {
		922	delete $term->{_hook}[$htype]{$id};
		923	$term->set_should_invoke ($htype, -1);
		924	}
		925	}
		926
		927	sub on {
		928	my ($self, %hook) = @_;
		929
		930	my $term = $self->{term};
		931
		932	my %disable = ( "" => $term );
		933
		934	while (my ($name, $cb) = each %hook) {
		935	my $htype = $HOOKTYPE{uc $name};
		936	defined $htype
		937	or Carp::croak "unsupported hook type '$name'";
		938
		939	$term->set_should_invoke ($htype, +1);
		940	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		941	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		942	}
		943
		944	bless \%disable, "urxvt::extension::on_disable"
		945	}
		946
		947	=item $self->x_resource ($pattern)
		948
		949	=item $self->x_resource_boolean ($pattern)
		950
		951	These methods support an additional C<%> prefix when called on an
		952	extension object - see the description of these methods in the
		953	C<urxvt::term> class for details.
		954
		955	=cut
		956
		957	sub x_resource {
		958	my ($self, $name) = @_;
		959	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		960	$self->{term}->x_resource ($name)
		961	}
		962
		963	sub x_resource_boolean {
		964	my ($self, $name) = @_;
		965	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		966	$self->{term}->x_resource_boolean ($name)
		967	}
		968
		969	=back
		970
		971	=cut
1005		972
1006	package urxvt::anyevent;	973	package urxvt::anyevent;
1007		974
1008	=head2 The C<urxvt::anyevent> Class	975	=head2 The C<urxvt::anyevent> Class
1009		976
1010	The sole purpose of this class is to deliver an interface to the	977	The sole purpose of this class is to deliver an interface to the
1011	C<AnyEvent> module - any module using it will work inside urxvt without	978	C<AnyEvent> module - any module using it will work inside urxvt without
1012	further programming. The only exception is that you cannot wait on	979	further programming. The only exception is that you cannot wait on
1013	condition variables, but non-blocking condvar use is ok. What this means	980	condition variables, but non-blocking condvar use is ok.
1014	is that you cannot use blocking APIs, but the non-blocking variant should
1015	work.
1016		981
1017	=cut	982	In practical terms this means is that you cannot use blocking APIs, but
		983	the non-blocking variant should work.
1018		984
		985	=cut
		986
1019	our $VERSION = 1;	987	our $VERSION = '5.23';
1020		988
1021	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	989	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1022	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	990	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1023		991
1024	sub timer {	992	sub timer {
…		…
1026		994
1027	my $cb = $arg{cb};	995	my $cb = $arg{cb};
1028		996
1029	urxvt::timer	997	urxvt::timer
1030	->new	998	->new
1031	->start (urxvt::NOW + $arg{after})	999	->after ($arg{after}, $arg{interval})
1032	->cb (sub {	1000	->cb ($arg{interval} ? $cb : sub {
1033	$_[0]->stop; # need to cancel manually	1001	$_[0]->stop; # need to cancel manually
1034	$cb->();	1002	$cb->();
1035	})	1003	})
1036	}	1004	}
1037		1005
1038	sub io {	1006	sub io {
1039	my ($class, %arg) = @_;	1007	my ($class, %arg) = @_;
1040		1008
1041	my $cb = $arg{cb};	1009	my $cb = $arg{cb};
		1010	my $fd = fileno $arg{fh};
		1011	defined $fd or $fd = $arg{fh};
1042		1012
1043	bless [$arg{fh}, urxvt::iow	1013	bless [$arg{fh}, urxvt::iow
1044	->new	1014	->new
1045	->fd (fileno $arg{fh})	1015	->fd ($fd)
1046	->events (($arg{poll} =~ /r/ ? 1 : 0)	1016	->events (($arg{poll} =~ /r/ ? 1 : 0)
1047	| ($arg{poll} =~ /w/ ? 2 : 0))	1017	| ($arg{poll} =~ /w/ ? 2 : 0))
1048	->start	1018	->start
1049	->cb (sub {	1019	->cb ($cb)
1050	$cb->(($_[1] & 1 ? 'r' : '')
1051	. ($_[1] & 2 ? 'w' : ''));
1052	})],
1053	urxvt::anyevent::	1020	], urxvt::anyevent::
		1021	}
		1022
		1023	sub idle {
		1024	my ($class, %arg) = @_;
		1025
		1026	my $cb = $arg{cb};
		1027
		1028	urxvt::iw
		1029	->new
		1030	->start
		1031	->cb ($cb)
		1032	}
		1033
		1034	sub child {
		1035	my ($class, %arg) = @_;
		1036
		1037	my $cb = $arg{cb};
		1038
		1039	urxvt::pw
		1040	->new
		1041	->start ($arg{pid})
		1042	->cb (sub {
		1043	$_[0]->stop; # need to cancel manually
		1044	$cb->($_[0]->rpid, $_[0]->rstatus);
		1045	})
1054	}	1046	}
1055		1047
1056	sub DESTROY {	1048	sub DESTROY {
1057	$_[0][1]->stop;	1049	$_[0][1]->stop;
1058	}	1050	}
1059		1051
1060	sub condvar {	1052	# only needed for AnyEvent < 6 compatibility
1061	bless \my $flag, urxvt::anyevent::condvar::	1053	sub one_event {
1062	}
1063
1064	sub urxvt::anyevent::condvar::broadcast {
1065	${$_[0]}++;
1066	}
1067
1068	sub urxvt::anyevent::condvar::wait {
1069	unless (${$_[0]}) {
1070	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1054	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1071	}
1072	}	1055	}
1073		1056
1074	package urxvt::term;	1057	package urxvt::term;
1075		1058
1076	=head2 The C<urxvt::term> Class	1059	=head2 The C<urxvt::term> Class
…		…
1089	urxvt::verbose 6, "register package $pkg to $self";	1072	urxvt::verbose 6, "register package $pkg to $self";
1090		1073
1091	@{"$pkg\::ISA"} = urxvt::term::extension::;	1074	@{"$pkg\::ISA"} = urxvt::term::extension::;
1092		1075
1093	my $proxy = bless {	1076	my $proxy = bless {
1094	_pkg => $pkg,	1077	_pkg => $pkg,
		1078	_name => ${"$pkg\::_NAME"}, # hackish
1095	argv => $argv,	1079	argv => $argv,
1096	}, $pkg;	1080	}, $pkg;
1097	Scalar::Util::weaken ($proxy->{term} = $self);	1081	Scalar::Util::weaken ($proxy->{term} = $self);
1098		1082
1099	$self->{_pkg}{$pkg} = $proxy;	1083	$self->{_pkg}{$pkg} = $proxy;
1100		1084
…		…
1103	$proxy->enable ($name => $ref);	1087	$proxy->enable ($name => $ref);
1104	}	1088	}
1105	}	1089	}
1106	}	1090	}
1107		1091
		1092	sub perl_libdirs {
		1093	map { split /:/ }
		1094	$_[0]->resource ("perl_lib"),
		1095	$ENV{URXVT_PERL_LIB},
		1096	"$ENV{HOME}/.urxvt/ext",
		1097	"$LIBDIR/perl"
		1098	}
		1099
		1100	# scan for available extensions and collect their metadata
		1101	sub scan_extensions {
		1102	my ($self) = @_;
		1103
		1104	return if exists $self->{meta};
		1105
		1106	my @libdirs = perl_libdirs $self;
		1107
		1108	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1109
		1110	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1111	$self->{meta} = \my %meta;
		1112
		1113	# first gather extensions
		1114	for my $dir (reverse @libdirs) {
		1115	opendir my $fh, $dir
		1116	or next;
		1117	for my $ext (readdir $fh) {
		1118	$ext !~ /^\./
		1119	and open my $fh, "<", "$dir/$ext"
		1120	or next;
		1121
		1122	my %ext = (dir => $dir);
		1123
		1124	while (<$fh>) {
		1125	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1126	my ($pattern, $type, $desc) = split /:/, $1;
		1127	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1128	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1129	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1130	} else {
		1131	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1132	}
		1133	} elsif (/^#:META:BINDING:(.*)/) {
		1134	my ($keysym, $action) = split /:/, $1;
		1135	$ext{binding}{$keysym} = [$ext, $action];
		1136	} elsif (/^\s*(?:#|$)/) {
		1137	# skip other comments and empty lines
		1138	} else {
		1139	last; # stop parsing on first non-empty non-comment line
		1140	}
		1141	}
		1142
		1143	$meta{ext}{$ext} = \%ext;
		1144	}
		1145	}
		1146
		1147	# and now merge resources and bindings
		1148	while (my ($k, $v) = each %{ $meta{ext} }) {
		1149	#TODO: should check for extensions overriding each other
		1150	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1151	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1152	}
		1153	}
		1154
1108	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1155	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1109		1156
1110	Creates a new terminal, very similar as if you had started it with system	1157	Creates a new terminal, very similar as if you had started it with system
1111	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1158	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1112	hash which defines the environment of the new terminal.	1159	hash which defines the environment of the new terminal.
…		…
1129	}	1176	}
1130		1177
1131	=item $term->destroy	1178	=item $term->destroy
1132		1179
1133	Destroy the terminal object (close the window, free resources	1180	Destroy the terminal object (close the window, free resources
1134	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1181	etc.). Please note that urxvt will not exit as long as any event
1135	watchers (timers, io watchers) are still active.	1182	watchers (timers, io watchers) are still active.
1136		1183
1137	=item $term->exec_async ($cmd[, @args])	1184	=item $term->exec_async ($cmd[, @args])
1138		1185
1139	Works like the combination of the C<fork>/C<exec> builtins, which executes	1186	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1163		1210
1164	Returns true if the option specified by C<$optval> is enabled, and	1211	Returns true if the option specified by C<$optval> is enabled, and
1165	optionally change it. All option values are stored by name in the hash	1212	optionally change it. All option values are stored by name in the hash
1166	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1213	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1167		1214
1168	Here is a a likely non-exhaustive list of option names, please see the	1215	Here is a likely non-exhaustive list of option names, please see the
1169	source file F</src/optinc.h> to see the actual list:	1216	source file F</src/optinc.h> to see the actual list:
1170		1217
1171	borderLess console cursorBlink cursorUnderline hold iconic insecure	1218	borderLess buffered console cursorBlink cursorUnderline hold iconic
1172	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1219	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1173	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1220	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1174	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1221	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1175	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1222	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1176	transparent tripleclickwords utmpInhibit visualBell	1223	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1224	urgentOnBell utmpInhibit visualBell
1177		1225
1178	=item $value = $term->resource ($name[, $newval])	1226	=item $value = $term->resource ($name[, $newval])
1179		1227
1180	Returns the current resource value associated with a given name and	1228	Returns the current resource value associated with a given name and
1181	optionally sets a new value. Setting values is most useful in the C<init>	1229	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1190	likely change).	1238	likely change).
1191		1239
1192	Please note that resource strings will currently only be freed when the	1240	Please note that resource strings will currently only be freed when the
1193	terminal is destroyed, so changing options frequently will eat memory.	1241	terminal is destroyed, so changing options frequently will eat memory.
1194		1242
1195	Here is a a likely non-exhaustive list of resource names, not all of which	1243	Here is a likely non-exhaustive list of resource names, not all of which
1196	are supported in every build, please see the source file F</src/rsinc.h>	1244	are supported in every build, please see the source file F</src/rsinc.h>
1197	to see the actual list:	1245	to see the actual list:
1198		1246
1199	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1247	answerbackstring backgroundPixmap backspace_key blurradius
1200	borderLess color cursorBlink cursorUnderline cutchars delete_key	1248	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1201	display_name embed ext_bwidth fade font geometry hold iconName	1249	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1202	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1250	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1251	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1203	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1252	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1204	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1253	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1205	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1254	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1206	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1255	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1207	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1256	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1208	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1257	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1209	secondaryScreen secondaryScroll selectstyle shade term_name title	1258	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1210	transient_for transparent transparent_all tripleclickwords utmpInhibit	1259	term_name title transient_for transparent tripleclickwords urgentOnBell
1211	visualBell	1260	utmpInhibit visualBell
1212		1261
1213	=cut	1262	=cut
1214		1263
1215	sub resource($$;$) {	1264	sub resource($$;$) {
1216	my ($self, $name) = (shift, shift);	1265	my ($self, $name) = (shift, shift);
1217	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1266	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1218	&urxvt::term::_resource	1267	goto &urxvt::term::_resource
1219	}	1268	}
1220		1269
1221	=item $value = $term->x_resource ($pattern)	1270	=item $value = $term->x_resource ($pattern)
1222		1271
1223	Returns the X-Resource for the given pattern, excluding the program or	1272	Returns the X-Resource for the given pattern, excluding the program or
1224	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1273	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1225	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1274	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1226	resource with that pattern exists.	1275	resource with that pattern exists.
1227		1276
		1277	Extensions that define extra resource or command line arguments also need
		1278	to call this method to access their values.
		1279
		1280	If the method is called on an extension object (basically, from an
		1281	extension), then the special prefix C<%.> will be replaced by the name of
		1282	the extension and a dot, and the lone string C<%> will be replaced by the
		1283	extension name itself. This makes it possible to code extensions so you
		1284	can rename them and get a new set of commandline switches and resources
		1285	without having to change the actual code.
		1286
1228	This method should only be called during the C<on_start> hook, as there is	1287	This method should only be called during the C<on_start> hook, as there is
1229	only one resource database per display, and later invocations might return	1288	only one resource database per display, and later invocations might return
1230	the wrong resources.	1289	the wrong resources.
1231		1290
1232	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1291	=item $value = $term->x_resource_boolean ($pattern)
1233		1292
		1293	Like C<x_resource>, above, but interprets the string value as a boolean
		1294	and returns C<1> for true values, C<0> for false values and C<undef> if
		1295	the resource or option isn't specified.
		1296
		1297	You should always use this method to parse boolean resources.
		1298
		1299	=cut
		1300
		1301	sub x_resource_boolean {
		1302	my $res = &x_resource;
		1303
		1304	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1305	}
		1306
		1307	=item $success = $term->bind_action ($key, $octets)
		1308
1234	Adds a keymap translation exactly as specified via a resource. See the	1309	Adds a key binding exactly as specified via a C<keysym> resource. See the
1235	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1310	C<keysym> resource in the urxvt(1) manpage.
1236		1311
1237	=item $rend = $term->rstyle ([$new_rstyle])	1312	=item $rend = $term->rstyle ([$new_rstyle])
1238		1313
1239	Return and optionally change the current rendition. Text that is output by	1314	Return and optionally change the current rendition. Text that is output by
1240	the terminal application will use this style.	1315	the terminal application will use this style.
…		…
1248		1323
1249	=item ($row, $col) = $term->selection_beg ([$row, $col])	1324	=item ($row, $col) = $term->selection_beg ([$row, $col])
1250		1325
1251	=item ($row, $col) = $term->selection_end ([$row, $col])	1326	=item ($row, $col) = $term->selection_end ([$row, $col])
1252		1327
1253	Return the current values of the selection mark, begin or end positions,	1328	Return the current values of the selection mark, begin or end positions.
1254	and optionally set them to new values.	1329
		1330	When arguments are given, then the selection coordinates are set to
		1331	C<$row> and C<$col>, and the selection screen is set to the current
		1332	screen.
		1333
		1334	=item $screen = $term->selection_screen ([$screen])
		1335
		1336	Returns the current selection screen, and then optionally sets it.
1255		1337
1256	=item $term->selection_make ($eventtime[, $rectangular])	1338	=item $term->selection_make ($eventtime[, $rectangular])
1257		1339
1258	Tries to make a selection as set by C<selection_beg> and	1340	Tries to make a selection as set by C<selection_beg> and
1259	C<selection_end>. If C<$rectangular> is true (default: false), a	1341	C<selection_end>. If C<$rectangular> is true (default: false), a
1260	rectangular selection will be made. This is the prefered function to make	1342	rectangular selection will be made. This is the preferred function to make
1261	a selection.	1343	a selection.
1262		1344
1263	=item $success = $term->selection_grab ($eventtime)	1345	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1264		1346
1265	Try to request the primary selection text from the server (for example, as	1347	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1348	true) selection from the server. The corresponding text can be set
1266	set by the next method). No visual feedback will be given. This function	1349	with the next method. No visual feedback will be given. This function
1267	is mostly useful from within C<on_sel_grab> hooks.	1350	is mostly useful from within C<on_sel_grab> hooks.
1268		1351
1269	=item $oldtext = $term->selection ([$newtext])	1352	=item $oldtext = $term->selection ([$newtext, $clipboard])
1270		1353
1271	Return the current selection text and optionally replace it by C<$newtext>.	1354	Return the current selection (clipboard if C<$clipboard> is true) text
		1355	and optionally replace it by C<$newtext>.
		1356
		1357	=item $term->selection_clear ([$clipboard])
		1358
		1359	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1272		1360
1273	=item $term->overlay_simple ($x, $y, $text)	1361	=item $term->overlay_simple ($x, $y, $text)
1274		1362
1275	Create a simple multi-line overlay box. See the next method for details.	1363	Create a simple multi-line overlay box. See the next method for details.
1276		1364
…		…
1306		1394
1307	The methods currently supported on C<urxvt::overlay> objects are:	1395	The methods currently supported on C<urxvt::overlay> objects are:
1308		1396
1309	=over 4	1397	=over 4
1310		1398
1311	=item $overlay->set ($x, $y, $text, $rend)	1399	=item $overlay->set ($x, $y, $text[, $rend])
1312		1400
1313	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1401	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1314	text in rxvt-unicode's special encoding and an array of rendition values	1402	text in rxvt-unicode's special encoding and an array of rendition values
1315	at a specific position inside the overlay.	1403	at a specific position inside the overlay.
		1404
		1405	If C<$rend> is missing, then the rendition will not be changed.
1316		1406
1317	=item $overlay->hide	1407	=item $overlay->hide
1318		1408
1319	If visible, hide the overlay, but do not destroy it.	1409	If visible, hide the overlay, but do not destroy it.
1320		1410
…		…
1402	locale-specific encoding of the terminal and can contain command sequences	1492	locale-specific encoding of the terminal and can contain command sequences
1403	(escape codes) that will be interpreted.	1493	(escape codes) that will be interpreted.
1404		1494
1405	=item $term->tt_write ($octets)	1495	=item $term->tt_write ($octets)
1406		1496
1407	Write the octets given in C<$data> to the tty (i.e. as program input). To	1497	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1408	pass characters instead of octets, you should convert your strings first	1498	pass characters instead of octets, you should convert your strings first
1409	to the locale-specific encoding using C<< $term->locale_encode >>.	1499	to the locale-specific encoding using C<< $term->locale_encode >>.
		1500
		1501	=item $term->tt_write_user_input ($octets)
		1502
		1503	Like C<tt_write>, but should be used when writing strings in response to
		1504	the user pressing a key, to invokes the additional actions requested by
		1505	the user for that case (C<tt_write> doesn't do that).
		1506
		1507	The typical use case would be inside C<on_action> hooks.
		1508
		1509	=item $term->tt_paste ($octets)
		1510
		1511	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1512	CR and bracketing the data with control sequences if bracketed paste mode
		1513	is set.
1410		1514
1411	=item $old_events = $term->pty_ev_events ([$new_events])	1515	=item $old_events = $term->pty_ev_events ([$new_events])
1412		1516
1413	Replaces the event mask of the pty watcher by the given event mask. Can	1517	Replaces the event mask of the pty watcher by the given event mask. Can
1414	be used to suppress input and output handling to the pty/tty. See the	1518	be used to suppress input and output handling to the pty/tty. See the
…		…
1433	Adds the specified events to the vt event mask. Useful e.g. when you want	1537	Adds the specified events to the vt event mask. Useful e.g. when you want
1434	to receive pointer events all the times:	1538	to receive pointer events all the times:
1435		1539
1436	$term->vt_emask_add (urxvt::PointerMotionMask);	1540	$term->vt_emask_add (urxvt::PointerMotionMask);
1437		1541
		1542	=item $term->set_urgency ($set)
		1543
		1544	Enable/disable the urgency hint on the toplevel window.
		1545
1438	=item $term->focus_in	1546	=item $term->focus_in
1439		1547
1440	=item $term->focus_out	1548	=item $term->focus_out
1441		1549
1442	=item $term->key_press ($state, $keycode[, $time])	1550	=item $term->key_press ($state, $keycode[, $time])
…		…
1512		1620
1513	Returns the currently displayed screen (0 primary, 1 secondary).	1621	Returns the currently displayed screen (0 primary, 1 secondary).
1514		1622
1515	=item $cursor_is_hidden = $term->hidden_cursor	1623	=item $cursor_is_hidden = $term->hidden_cursor
1516		1624
1517	Returns wether the cursor is currently hidden or not.	1625	Returns whether the cursor is currently hidden or not.
1518		1626
1519	=item $view_start = $term->view_start ([$newvalue])	1627	=item $view_start = $term->view_start ([$newvalue])
1520		1628
1521	Returns the row number of the topmost displayed line. Maximum value is	1629	Returns the row number of the topmost displayed line. Maximum value is
1522	C<0>, which displays the normal terminal contents. Lower values scroll	1630	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1530		1638
1531	Used after changing terminal contents to display them.	1639	Used after changing terminal contents to display them.
1532		1640
1533	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1641	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1534		1642
1535	Returns the text of the entire row with number C<$row_number>. Row C<0>	1643	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1536	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1644	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1537	terminal line. The scrollback buffer starts at line C<-1> and extends to
1538	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1645	terminal line. Nothing will be returned if a nonexistent line
1539	is requested.	1646	is requested.
1540		1647
1541	If C<$new_text> is specified, it will replace characters in the current	1648	If C<$new_text> is specified, it will replace characters in the current
1542	line, starting at column C<$start_col> (default C<0>), which is useful	1649	line, starting at column C<$start_col> (default C<0>), which is useful
1543	to replace only parts of a line. The font index in the rendition will	1650	to replace only parts of a line. The font index in the rendition will
1544	automatically be updated.	1651	automatically be updated.
1545		1652
1546	C<$text> is in a special encoding: tabs and wide characters that use more	1653	C<$text> is in a special encoding: tabs and wide characters that use more
1547	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1654	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1548	characters. Characters with combining characters and other characters that	1655	characters. Characters with combining characters and other characters that
1549	do not fit into the normal tetx encoding will be replaced with characters	1656	do not fit into the normal text encoding will be replaced with characters
1550	in the private use area.	1657	in the private use area.
1551		1658
1552	You have to obey this encoding when changing text. The advantage is	1659	You have to obey this encoding when changing text. The advantage is
1553	that C<substr> and similar functions work on screen cells and not on	1660	that C<substr> and similar functions work on screen cells and not on
1554	characters.	1661	characters.
…		…
1639	}	1746	}
1640		1747
1641	sub urxvt::line::t {	1748	sub urxvt::line::t {
1642	my ($self) = @_;	1749	my ($self) = @_;
1643		1750
1644	if (@_ > 1)	1751	if (@_ > 1) {
1645	{
1646	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1752	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1647	for $self->{beg} .. $self->{end};	1753	for $self->{beg} .. $self->{end};
1648	}	1754	}
1649		1755
1650	defined wantarray &&	1756	defined wantarray &&
1651	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1757	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1652	0, $self->{len}	1758	0, $self->{len}
1653	}	1759	}
1654		1760
1655	sub urxvt::line::r {	1761	sub urxvt::line::r {
1656	my ($self) = @_;	1762	my ($self) = @_;
1657		1763
1658	if (@_ > 1)	1764	if (@_ > 1) {
1659	{
1660	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1765	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1661	for $self->{beg} .. $self->{end};	1766	for $self->{beg} .. $self->{end};
1662	}	1767	}
1663		1768
1664	if (defined wantarray) {	1769	if (defined wantarray) {
1665	my $rend = [	1770	my $rend = [
1666	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1771	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1667	];	1772	];
…		…
1699	where one character corresponds to one screen cell. See	1804	where one character corresponds to one screen cell. See
1700	C<< $term->ROW_t >> for details.	1805	C<< $term->ROW_t >> for details.
1701		1806
1702	=item $string = $term->special_decode $text	1807	=item $string = $term->special_decode $text
1703		1808
1704	Converts rxvt-unicodes text reprsentation into a perl string. See	1809	Converts rxvt-unicodes text representation into a perl string. See
1705	C<< $term->ROW_t >> for details.	1810	C<< $term->ROW_t >> for details.
1706		1811
1707	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1812	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1708		1813
1709	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1814	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1712	manpage.	1817	manpage.
1713		1818
1714	=item $success = $term->grab ($eventtime[, $sync])	1819	=item $success = $term->grab ($eventtime[, $sync])
1715		1820
1716	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1821	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1717	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1822	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1718		1823
1719	=item $term->allow_events_async	1824	=item $term->allow_events_async
1720		1825
1721	Calls XAllowEvents with AsyncBoth for the most recent grab.	1826	Calls XAllowEvents with AsyncBoth for the most recent grab.
1722		1827
…		…
1729	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1834	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1730	recent grab.	1835	recent grab.
1731		1836
1732	=item $term->ungrab	1837	=item $term->ungrab
1733		1838
1734	Calls XUngrab for the most recent grab. Is called automatically on	1839	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1735	evaluation errors, as it is better to lose the grab in the error case as	1840	evaluation errors, as it is better to lose the grab in the error case as
1736	the session.	1841	the session.
1737		1842
1738	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1843	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1739		1844
…		…
1741		1846
1742	=item @atoms = $term->XListProperties ($window)	1847	=item @atoms = $term->XListProperties ($window)
1743		1848
1744	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1849	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1745		1850
1746	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1851	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1747		1852
1748	=item $term->XDeleteProperty ($window, $property)	1853	=item $term->XDeleteProperty ($window, $property)
1749		1854
1750	=item $window = $term->DefaultRootWindow	1855	=item $window = $term->DefaultRootWindow
1751		1856
…		…
1758	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1863	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1759		1864
1760	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1865	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1761		1866
1762	=item $term->XChangeInput ($window, $add_events[, $del_events])	1867	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1868
		1869	=item $keysym = $term->XStringToKeysym ($string)
		1870
		1871	=item $string = $term->XKeysymToString ($keysym)
1763		1872
1764	Various X or X-related functions. The C<$term> object only serves as	1873	Various X or X-related functions. The C<$term> object only serves as
1765	the source of the display, otherwise those functions map more-or-less	1874	the source of the display, otherwise those functions map more-or-less
1766	directory onto the X functions of the same name.	1875	directly onto the X functions of the same name.
1767		1876
1768	=back	1877	=back
1769		1878
1770	=cut	1879	=cut
1771		1880
…		…
1873	my $env = $self->{term}->env;	1982	my $env = $self->{term}->env;
1874	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1983	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1875	delete $env->{LC_ALL};	1984	delete $env->{LC_ALL};
1876	$env->{LC_CTYPE} = $self->{term}->locale;	1985	$env->{LC_CTYPE} = $self->{term}->locale;
1877		1986
1878	urxvt::term->new ($env, "popup",	1987	my $term = urxvt::term->new (
		1988	$env, "popup",
1879	"--perl-lib" => "", "--perl-ext-common" => "",	1989	"--perl-lib" => "", "--perl-ext-common" => "",
1880	"-pty-fd" => -1, "-sl" => 0,	1990	"-pty-fd" => -1, "-sl" => 0,
1881	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1991	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1882	"--transient-for" => $self->{term}->parent,	1992	"--transient-for" => $self->{term}->parent,
1883	"-display" => $self->{term}->display_id,	1993	"-display" => $self->{term}->display_id,
1884	"-pe" => "urxvt-popup")	1994	"-pe" => "urxvt-popup",
1885	or die "unable to create popup window\n";	1995	) or die "unable to create popup window\n";
		1996
		1997	unless (delete $term->{urxvt_popup_init_done}) {
		1998	$term->ungrab;
		1999	$term->destroy;
		2000	die "unable to initialise popup window\n";
		2001	}
1886	}	2002	}
1887		2003
1888	sub DESTROY {	2004	sub DESTROY {
1889	my ($self) = @_;	2005	my ($self) = @_;
1890		2006
…		…
1895	=back	2011	=back
1896		2012
1897	=cut	2013	=cut
1898		2014
1899	package urxvt::watcher;	2015	package urxvt::watcher;
1900
1901	@urxvt::timer::ISA = __PACKAGE__;
1902	@urxvt::iow::ISA = __PACKAGE__;
1903	@urxvt::pw::ISA = __PACKAGE__;
1904	@urxvt::iw::ISA = __PACKAGE__;
1905		2016
1906	=head2 The C<urxvt::timer> Class	2017	=head2 The C<urxvt::timer> Class
1907		2018
1908	This class implements timer watchers/events. Time is represented as a	2019	This class implements timer watchers/events. Time is represented as a
1909	fractional number of seconds since the epoch. Example:	2020	fractional number of seconds since the epoch. Example:
…		…
1913	->new	2024	->new
1914	->interval (1)	2025	->interval (1)
1915	->cb (sub {	2026	->cb (sub {
1916	$term->{overlay}->set (0, 0,	2027	$term->{overlay}->set (0, 0,
1917	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2028	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1918	});	2029	});
1919		2030
1920	=over 4	2031	=over 4
1921		2032
1922	=item $timer = new urxvt::timer	2033	=item $timer = new urxvt::timer
1923		2034
…		…
1926		2037
1927	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2038	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1928		2039
1929	Set the callback to be called when the timer triggers.	2040	Set the callback to be called when the timer triggers.
1930		2041
1931	=item $tstamp = $timer->at
1932
1933	Return the time this watcher will fire next.
1934
1935	=item $timer = $timer->set ($tstamp)	2042	=item $timer = $timer->set ($tstamp[, $interval])
1936		2043
1937	Set the time the event is generated to $tstamp.	2044	Set the time the event is generated to $tstamp (and optionally specifies a
		2045	new $interval).
1938		2046
1939	=item $timer = $timer->interval ($interval)	2047	=item $timer = $timer->interval ($interval)
1940		2048
1941	Normally (and when C<$interval> is C<0>), the timer will automatically	2049	By default (and when C<$interval> is C<0>), the timer will automatically
1942	stop after it has fired once. If C<$interval> is non-zero, then the timer	2050	stop after it has fired once. If C<$interval> is non-zero, then the timer
1943	is automatically rescheduled at the given intervals.	2051	is automatically rescheduled at the given intervals.
1944		2052
1945	=item $timer = $timer->start	2053	=item $timer = $timer->start
1946		2054
1947	Start the timer.	2055	Start the timer.
1948		2056
1949	=item $timer = $timer->start ($tstamp)	2057	=item $timer = $timer->start ($tstamp[, $interval])
1950		2058
1951	Set the event trigger time to C<$tstamp> and start the timer.	2059	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2060	also replaces the interval.
1952		2061
1953	=item $timer = $timer->after ($delay)	2062	=item $timer = $timer->after ($delay[, $interval])
1954		2063
1955	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2064	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1956		2065
1957	=item $timer = $timer->stop	2066	=item $timer = $timer->stop
1958		2067
…		…
1966		2075
1967	$term->{socket} = ...	2076	$term->{socket} = ...
1968	$term->{iow} = urxvt::iow	2077	$term->{iow} = urxvt::iow
1969	->new	2078	->new
1970	->fd (fileno $term->{socket})	2079	->fd (fileno $term->{socket})
1971	->events (urxvt::EVENT_READ)	2080	->events (urxvt::EV_READ)
1972	->start	2081	->start
1973	->cb (sub {	2082	->cb (sub {
1974	my ($iow, $revents) = @_;	2083	my ($iow, $revents) = @_;
1975	# $revents must be 1 here, no need to check	2084	# $revents must be 1 here, no need to check
1976	sysread $term->{socket}, my $buf, 8192	2085	sysread $term->{socket}, my $buf, 8192
…		…
1989	Set the callback to be called when io events are triggered. C<$reventmask>	2098	Set the callback to be called when io events are triggered. C<$reventmask>
1990	is a bitset as described in the C<events> method.	2099	is a bitset as described in the C<events> method.
1991		2100
1992	=item $iow = $iow->fd ($fd)	2101	=item $iow = $iow->fd ($fd)
1993		2102
1994	Set the filedescriptor (not handle) to watch.	2103	Set the file descriptor (not handle) to watch.
1995		2104
1996	=item $iow = $iow->events ($eventmask)	2105	=item $iow = $iow->events ($eventmask)
1997		2106
1998	Set the event mask to watch. The only allowed values are	2107	Set the event mask to watch. The only allowed values are
1999	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2108	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2000	together, or C<urxvt::EVENT_NONE>.	2109	together, or C<urxvt::EV_NONE>.
2001		2110
2002	=item $iow = $iow->start	2111	=item $iow = $iow->start
2003		2112
2004	Start watching for requested events on the given handle.	2113	Start watching for requested events on the given handle.
2005		2114
2006	=item $iow = $iow->stop	2115	=item $iow = $iow->stop
2007		2116
2008	Stop watching for events on the given filehandle.	2117	Stop watching for events on the given file handle.
2009		2118
2010	=back	2119	=back
2011		2120
2012	=head2 The C<urxvt::iw> Class	2121	=head2 The C<urxvt::iw> Class
2013		2122
…		…
2046	->new	2155	->new
2047	->start ($pid)	2156	->start ($pid)
2048	->cb (sub {	2157	->cb (sub {
2049	my ($pw, $exit_status) = @_;	2158	my ($pw, $exit_status) = @_;
2050	...	2159	...
2051	});	2160	});
2052		2161
2053	=over 4	2162	=over 4
2054		2163
2055	=item $pw = new urxvt::pw	2164	=item $pw = new urxvt::pw
2056		2165
…		…
2060		2169
2061	Set the callback to be called when the timer triggers.	2170	Set the callback to be called when the timer triggers.
2062		2171
2063	=item $pw = $timer->start ($pid)	2172	=item $pw = $timer->start ($pid)
2064		2173
2065	Tells the wqtcher to start watching for process C<$pid>.	2174	Tells the watcher to start watching for process C<$pid>.
2066		2175
2067	=item $pw = $pw->stop	2176	=item $pw = $pw->stop
2068		2177
2069	Stop the watcher.	2178	Stop the watcher.
2070		2179
…		…
2083		2192
2084	=item >= 3 - script loading and management	2193	=item >= 3 - script loading and management
2085		2194
2086	=item >=10 - all called hooks	2195	=item >=10 - all called hooks
2087		2196
2088	=item >=11 - hook reutrn values	2197	=item >=11 - hook return values
2089		2198
2090	=back	2199	=back
2091		2200
2092	=head1 AUTHOR	2201	=head1 AUTHOR
2093		2202
2094	Marc Lehmann <pcg@goof.com>	2203	Marc Lehmann <schmorp@schmorp.de>
2095	http://software.schmorp.de/pkg/rxvt-unicode	2204	http://software.schmorp.de/pkg/rxvt-unicode
2096		2205
2097	=cut	2206	=cut
2098		2207
2099	1	2208	1
		2209
		2210	# vim: sw=3:

Diff Legend

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