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.127 by root, Wed Jan 25 00:42:21 2006 UTC vs.
Revision 1.272 by root, Thu Dec 29 01:10:08 2022 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 some directory:
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 instance using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib path/to/somedirectory -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 qw(vars subs)' and 'use utf8'
26	thus must be encoded as UTF-8.	26	environment, and thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions may add additional resources and C<actions>, i.e., methods
45		49	which can be bound to a key and invoked by the user. An extension can
46	=item selection (enabled by default)	50	define the resources it support using so called META comments,
47		51	described below. Similarly to builtin resources, extension resources
48	(More) intelligent selection. This extension tries to be more intelligent	52	can also be specified on the command line as long options (with C<.>
49	when the user extends selections (double-click and further clicks). Right	53	replaced by C<->), in which case the corresponding extension is loaded
50	now, it tries to select words, urls and complete shell-quoted	54	automatically. For this to work the extension B<must> define META
51	arguments, which is very convenient, too, if your F<ls> supports	55	comments for its resources.
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	Another example: Programs I use often output "absolute path: " at the
73	beginning of a line when they process multiple files. The following
74	pattern matches the filename (note, there is a single space at the very
75	end):
76
77	URxvt.selection.pattern-0: ^(/[^:]+):\
78
79	You can look at the source of the selection extension to see more
80	interesting uses, such as parsing a line from beginning to end.
81
82	This extension also offers following bindable keyboard commands:
83
84	=over 4
85
86	=item rot13
87
88	Rot-13 the selection when activated. Used via keyboard trigger:
89
90	URxvt.keysym.C-M-r: perl:selection:rot13
91
92	=back
93
94	=item option-popup (enabled by default)
95
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.
98
99	=item selection-popup (enabled by default)
100
101	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
102	text into various other formats/action (such as uri unescaping, perl
103	evaluation, web-browser starting etc.), depending on content.
104
105	Other extensions can extend this popup menu by pushing a code reference
106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
107	popup is displayed.
108
109	It's sole argument is the popup menu, which can be modified. The selection
110	is in C<$_>, which can be used to decide wether to add something or not.
111	It should either return nothing or a string and a code reference. The
112	string will be used as button text and the code reference will be called
113	when the button gets activated and should transform C<$_>.
114
115	The following will add an entry C<a to b> that transforms all C<a>s in
116	the selection to C<b>s, but only if the selection currently contains any
117	C<a>s:
118
119	push @{ $self->{term}{selection_popup_hook} }, sub {
120	/a/ ? ("a to be" => sub { s/a/b/g }
121	: ()
122	};
123
124	=item searchable-scrollback<hotkey> (enabled by default)
125
126	Adds regex search functionality to the scrollback buffer, triggered
127	by a hotkey (default: C<M-s>). While in search mode, normal terminal
128	input/output is suspended and a regex is displayed at the bottom of the
129	screen.
130
131	Inputting characters appends them to the regex and continues incremental
132	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
133	search upwards/downwards in the scrollback buffer, C<End> jumps to the
134	bottom. C<Escape> leaves search mode and returns to the point where search
135	was started, while C<Enter> or C<Return> stay at the current position and
136	additionally stores the first match in the current line into the primary
137	selection.
138
139	=item readline (enabled by default)
140
141	A support package that tries to make editing with readline easier. At the
142	moment, it reacts to clicking with the left mouse button by trying to
143	move the text cursor to this position. It does so by generating as many
144	cursor-left or cursor-right keypresses as required (the this only works
145	for programs that correctly support wide characters).
146
147	To avoid too many false positives, this is only done when:
148
149	=over 4
150
151	=item - the tty is in ICANON state.
152
153	=item - the text cursor is visible.
154
155	=item - the primary screen is currently being displayed.
156
157	=item - the mouse is on the same (multi-row-) line as the text cursor.
158
159	=back
160
161	The normal selection mechanism isn't disabled, so quick successive clicks
162	might interfere with selection creation in harmless ways.
163
164	=item selection-autotransform
165
166	This selection allows you to do automatic transforms on a selection
167	whenever a selection is made.
168
169	It works by specifying perl snippets (most useful is a single C<s///>
170	operator) that modify C<$_> as resources:
171
172	URxvt.selection-autotransform.0: transform
173	URxvt.selection-autotransform.1: transform
174	...
175
176	For example, the following will transform selections of the form
177	C<filename:number>, often seen in compiler messages, into C<vi +$filename
178	$word>:
179
180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
181
182	And this example matches the same,but replaces it with vi-commands you can
183	paste directly into your (vi :) editor:
184
185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
186
187	Of course, this can be modified to suit your needs and your editor :)
188
189	To expand the example above to typical perl error messages ("XXX at
190	FILENAME line YYY."), you need a slightly more elaborate solution:
191
192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
194
195	The first line tells the selection code to treat the unchanging part of
196	every error message as a selection pattern, and the second line transforms
197	the message into vi commands to load the file.
198
199	=item tabbed
200
201	This transforms the terminal into a tabbar with additional terminals, that
202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204	button per tab.
205
206	Clicking a button will activate that tab. Pressing B<Shift-Left> and
207	B<Shift-Right> will switch to the tab left or right of the current one,
208	while B<Shift-Down> creates a new tab.
209
210	=item mark-urls
211
212	Uses per-line display filtering (C<on_line_update>) to underline urls and
213	make them clickable. When middle-clicked, the program specified in the
214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
215	the URL as first argument.
216
217	=item automove-background
218
219	This is basically a one-line extension that dynamically changes the background pixmap offset
220	to the window position, in effect creating the same effect as pseudo transparency with
221	a custom pixmap. No scaling is supported in this mode. Exmaple:
222
223	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
224
225	=item block-graphics-to-ascii
226
227	A not very useful example of filtering all text output to the terminal,
228	by replacing all line-drawing characters (U+2500 .. U+259F) by a
229	similar-looking ascii character.
230
231	=item digital-clock
232
233	Displays a digital clock using the built-in overlay.
234
235	=item example-refresh-hooks
236
237	Displays a very simple digital clock in the upper right corner of the
238	window. Illustrates overwriting the refresh callbacks to create your own
239	overlays or changes.
240
241	=item selection-pastebin
242
243	This is a little rarely useful extension that Uploads the selection as
244	textfile to a remote site (or does other things). (The implementation is
245	not currently secure for use in a multiuser environment as it writes to
246	F</tmp> directly.).
247
248	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
249	i.e.
250
251	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
252
253	Pressing this combination runs a command with C<%> replaced by the name of
254	the textfile. This command can be set via a resource:
255
256	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
257
258	And the default is likely not useful to anybody but the few people around
259	here :)
260
261	The name of the textfile is the hex encoded md5 sum of the selection, so
262	the same content should lead to the same filename.
263
264	After a successful upload the selection will be replaced by the text given
265	in the C<selection-pastebin-url> resource (again, the % is the placeholder
266	for the filename):
267
268	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
269
270	=back
271		56
272	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
273		58
274	=head2 General API Considerations	59	=head2 General API Considerations
275		60
…		…
285	terminal is destroyed.	70	terminal is destroyed.
286		71
287	Argument names also often indicate the type of a parameter. Here are some	72	Argument names also often indicate the type of a parameter. Here are some
288	hints on what they mean:	73	hints on what they mean:
289		74
290	=over 4	75	=over
291		76
292	=item $text	77	=item $text
293		78
294	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
295	always represents one screen cell. See L<ROW_t> for a discussion of this format.	80	always represents one screen cell. See L<ROW_t> for a discussion of this format.
296		81
297	=item $string	82	=item $string
298		83
299	A perl text string, with an emphasis on I<text>. It can store all unicode	84	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
303	=item $octets	88	=item $octets
304		89
305	Either binary data or - more common - a text string encoded in a	90	Either binary data or - more common - a text string encoded in a
306	locale-specific way.	91	locale-specific way.
307		92
		93	=item $keysym
		94
		95	an integer that is a valid X11 keysym code. You can convert a string
		96	into a keysym and viceversa by using C<XStringToKeysym> and
		97	C<XKeysymToString>.
		98
308	=back	99	=back
309		100
310	=head2 Extension Objects	101	=head2 Extension Objects
311		102
312	Very perl extension is a perl class. A separate perl object is created	103	Every perl extension is a perl class. A separate perl object is created
313	for each terminal and each extension and passed as the first parameter to	104	for each terminal, and each terminal has its own set of extension objects,
314	hooks. So extensions can use their C<$self> object without having to think	105	which are passed as the first parameter to hooks. So extensions can use
315	about other extensions, with the exception of methods and members that	106	their C<$self> object without having to think about clashes with other
		107	extensions or other terminals, with the exception of methods and members
316	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
317	use.	109	internal use.
318		110
319	Although it isn't a C<urxvt::term> object, you can call all methods of the	111	Although it isn't a C<urxvt::term> object, you can call all methods of the
320	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
321		113
322	It has the following methods and data members:	114	Additional methods only supported for extension objects are described in
		115	the C<urxvt::extension> section below.
323		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata. These comments are scanned whenever a
		121	terminal is created and are typically used to autoload extensions when
		122	their resources or command line parameters are used.
		123
		124	Currently, it recognises these comments below. Individual components are
		125	separated by colons (C<:>), and should not contain colons themselves -
		126	there is also currently no escaping mechanism provided for this.
		127
324	=over 4	128	=over
325		129
326	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
327		131
328	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
329	extension. This member I<must not> be changed in any way.	133	C<name> is the resource name, C<type> is the resource type, C<boolean>
		134	or C<string>, and C<desc> is the resource description.
330		135
331	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	136	The extension will be autoloaded when this resource is specified or used
		137	as a command line parameter.
332		138
333	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
334	this extension, replacing any previous hook. This is useful when you want	140	comment:
335	to overwrite time-critical hooks only temporarily.
336		141
337	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
338		143
339	Dynamically disable the given hooks.	144	Example: load this extension when the C<-tr> command line option or
		145	resource name is used.
		146
		147	#:META:RESOURCE:tr:boolean:set root pixmap as background
		148
		149	=item #:META:OSC:number:desc
		150
		151	The OSC comment specifies an OSC sequence, where C<number> is the
		152	numerical OSC code and C<desc> is a short description that is currently
		153	unused.
		154
		155	This will cause the extension to be autoloaded when the OSC sequence is
		156	used for the first time.
		157
		158	Note that autoloading carries some extra responsibilities with it:
		159	although the terminal cannot really protect itself against malicious
		160	sources of command sequences, therefore relying on the programs running
		161	I<inside> to sanitize data that they output, it is very common for
		162	programs to emit command sequences from untrusted sources.
		163
		164	While this means that extensions should, as a defense-in-depth mechanism,
		165	always consider whether OSC sequences are safe, autoloading automatically
		166	exposes any autoloaded extension in all terminal windows, so extra care
		167	should be taken.
		168
		169	Example: the background extension registers OSC C<20> like this:
		170
		171	#:META:OSC:20:change/query background image
		172
		173	=item #:META:OSC_PERL:prefix:desc
		174
		175	The same as the OSC comment, but for the Perl OSC sequence (C<777>). The
		176	C<prefix> should be unique among extensions, of course, which is most
		177	easily arranged by using the extension name, although this is not
		178	required.
		179
		180	Example: the overlay-osc extension registers its Perl OSC like this:
		181
		182	#:META:OSC_PERL:overlay:man overlay-osc
340		183
341	=back	184	=back
342		185
343	=head2 Hooks	186	=head2 Hooks
344		187
345	The following subroutines can be declared in extension files, and will be	188	The following subroutines can be declared in extension files, and will be
346	called whenever the relevant event happens.	189	called whenever the relevant event happens.
347		190
348	The first argument passed to them is an extension oject as described in	191	The first argument passed to them is an extension object as described in
349	the in the C<Extension Objects> section.	192	the in the C<Extension Objects> section.
350		193
351	B<All> of these hooks must return a boolean value. If any of the called	194	B<All> of these hooks must return a boolean value. If any of the called
352	hooks returns true, then the event counts as being I<consumed>, and the	195	hooks returns true, then the event counts as being I<consumed>, and the
353	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
354		197
355	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
356		199
357	=over 4	200	=over
		201
		202	=item on_attach $term
		203
		204	Called when an extension package is attached to a running terminal
		205	instance. Must return true in all cases, and runs with the same
		206	limitations as C<on_init>.
		207
		208	Unlike C<on_init> or C<on_start>, this is called when the extension is
		209	attached to a terminal, regardless of whether the extension is loaded
		210	before or after the terminal is started. Extensions that need to do
		211	something before they work can do it in this callback, as opposed to e.g.
		212	C<on_init>, which might not be called.
358		213
359	=item on_init $term	214	=item on_init $term
360		215
361	Called after a new terminal object has been initialized, but before	216	Called after a new terminal object has been initialized, but before
362	windows are created or the command gets run. Most methods are unsafe to	217	windows are created or the command gets run. Most methods are unsafe to
…		…
366	place.	221	place.
367		222
368	=item on_start $term	223	=item on_start $term
369		224
370	Called at the very end of initialisation of a new terminal, just before	225	Called at the very end of initialisation of a new terminal, just before
371	trying to map (display) the toplevel and returning to the mainloop.	226	trying to map (display) the toplevel and returning to the main loop.
372		227
373	=item on_destroy $term	228	=item on_destroy $term
374		229
375	Called whenever something tries to destroy terminal, when the terminal is	230	Called whenever something tries to destroy terminal, when the terminal is
376	still fully functional (not for long, though).	231	still fully functional (not for long, though).
…		…
403		258
404	Called whenever a selection has been copied, but before the selection is	259	Called whenever a selection has been copied, but before the selection is
405	requested from the server. The selection text can be queried and changed	260	requested from the server. The selection text can be queried and changed
406	by calling C<< $term->selection >>.	261	by calling C<< $term->selection >>.
407		262
408	Returning a true value aborts selection grabbing. It will still be hilighted.	263	Returning a true value aborts selection grabbing. It will still be highlighted.
409		264
410	=item on_sel_extend $term	265	=item on_sel_extend $term
411		266
412	Called whenever the user tries to extend the selection (e.g. with a double	267	Called whenever the user tries to extend the selection (e.g. with a double
413	click) and is either supposed to return false (normal operation), or	268	click) and is either supposed to return false (normal operation), or
414	should extend the selection itelf and return true to suppress the built-in	269	should extend the selection itself and return true to suppress the built-in
415	processing. This can happen multiple times, as long as the callback	270	processing. This can happen multiple times, as long as the callback
416	returns true, it will be called on every further click by the user and is	271	returns true, it will be called on every further click by the user and is
417	supposed to enlarge the selection more and more, if possible.	272	supposed to enlarge the selection more and more, if possible.
418		273
419	See the F<selection> example extension.	274	See the F<selection> example extension.
420		275
421	=item on_view_change $term, $offset	276	=item on_view_change $term, $offset
422		277
423	Called whenever the view offset changes, i..e the user or program	278	Called whenever the view offset changes, i.e. the user or program
424	scrolls. Offset C<0> means display the normal terminal, positive values	279	scrolls. Offset C<0> means display the normal terminal, positive values
425	show this many lines of scrollback.	280	show this many lines of scrollback.
426		281
427	=item on_scroll_back $term, $lines, $saved	282	=item on_scroll_back $term, $lines, $saved
428		283
…		…
432		287
433	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	288	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
434	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	289	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
435	number of lines that will be in the scrollback buffer.	290	number of lines that will be in the scrollback buffer.
436		291
437	=item on_osc_seq $term, $string	292	=item on_osc_seq $term, $op, $args, $resp
438		293
		294	Called on every OSC sequence and can be used to suppress it or modify its
		295	behaviour. The default should be to return an empty list. A true value
		296	suppresses execution of the request completely. Make sure you don't get
		297	confused by recursive invocations when you output an OSC sequence within
		298	this callback.
		299
		300	C<on_osc_seq_perl> should be used for new behaviour.
		301
		302	=item on_osc_seq_perl $term, $args, $resp
		303
439	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	304	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
440	operating system command) is processed. Cursor position and other state	305	(OSC = operating system command) is processed. Cursor position and other
441	information is up-to-date when this happens. For interoperability, the	306	state information is up-to-date when this happens. For interoperability,
442	string should start with the extension name and a colon, to distinguish	307	the argument should start with the extension name (sans -osc) or some
443	it from commands for other extensions, and this might be enforced in the	308	other suitable prefix, and a semicolon, to distinguish it from commands
444	future.	309	for other extensions.
		310
		311	For example, C<overlay-osc> uses this:
		312
		313	sub on_osc_seq_perl {
		314	my ($self, $osc, $resp) = @_;
		315
		316	return unless $osc =~ s/^overlay;//;
		317
		318	... process remaining $osc string
		319	}
445		320
446	Be careful not ever to trust (in a security sense) the data you receive,	321	Be careful not ever to trust (in a security sense) the data you receive,
447	as its source can not easily be controleld (e-mail content, messages from	322	as its source can not easily be controlled (e-mail content, messages from
448	other users on the same system etc.).	323	other users on the same system etc.).
		324
		325	For responses, C<$resp> contains the end-of-args separator used by the
		326	sender.
449		327
450	=item on_add_lines $term, $string	328	=item on_add_lines $term, $string
451		329
452	Called whenever text is about to be output, with the text as argument. You	330	Called whenever text is about to be output, with the text as argument. You
453	can filter/change and output the text yourself by returning a true value	331	can filter/change and output the text yourself by returning a true value
…		…
458	=item on_tt_write $term, $octets	336	=item on_tt_write $term, $octets
459		337
460	Called whenever some data is written to the tty/pty and can be used to	338	Called whenever some data is written to the tty/pty and can be used to
461	suppress or filter tty input.	339	suppress or filter tty input.
462		340
		341	=item on_tt_paste $term, $octets
		342
		343	Called whenever text is about to be pasted, with the text as argument. You
		344	can filter/change and paste the text yourself by returning a true value
		345	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		346	locale-encoded.
		347
463	=item on_line_update $term, $row	348	=item on_line_update $term, $row
464		349
465	Called whenever a line was updated or changed. Can be used to filter	350	Called whenever a line was updated or changed. Can be used to filter
466	screen output (e.g. underline urls or other useless stuff). Only lines	351	screen output (e.g. underline urls or other useless stuff). Only lines
467	that are being shown will be filtered, and, due to performance reasons,	352	that are being shown will be filtered, and, due to performance reasons,
…		…
474	later with the already-modified line (e.g. if unrelated parts change), so	359	later with the already-modified line (e.g. if unrelated parts change), so
475	you cannot just toggle rendition bits, but only set them.	360	you cannot just toggle rendition bits, but only set them.
476		361
477	=item on_refresh_begin $term	362	=item on_refresh_begin $term
478		363
479	Called just before the screen gets redrawn. Can be used for overlay	364	Called just before the screen gets redrawn. Can be used for overlay or
480	or similar effects by modify terminal contents in refresh_begin, and	365	similar effects by modifying the terminal contents in refresh_begin, and
481	restoring them in refresh_end. The built-in overlay and selection display	366	restoring them in refresh_end. The built-in overlay and selection display
482	code is run after this hook, and takes precedence.	367	code is run after this hook, and takes precedence.
483		368
484	=item on_refresh_end $term	369	=item on_refresh_end $term
485		370
486	Called just after the screen gets redrawn. See C<on_refresh_begin>.	371	Called just after the screen gets redrawn. See C<on_refresh_begin>.
487		372
		373	=item on_action $term, $string
		374
		375	Called whenever an action is invoked for the corresponding extension
		376	(e.g. via a C<extension:string> builtin action bound to a key, see
		377	description of the B<keysym> resource in the urxvt(1) manpage). The
		378	event is simply the action string. Note that an action event is always
		379	associated to a single extension.
		380
488	=item on_keyboard_command $term, $string	381	=item on_user_command $term, $string *DEPRECATED*
489		382
490	Called whenever the user presses a key combination that has a	383	Called whenever a user-configured event is being activated (e.g. via
491	C<perl:string> action bound to it (see description of the B<keysym>	384	a C<perl:string> action bound to a key, see description of the B<keysym>
492	resource in the @@RXVT_NAME@@(1) manpage).	385	resource in the urxvt(1) manpage).
		386
		387	The event is simply the action string. This interface is going away in
		388	preference to the C<on_action> hook.
		389
		390	=item on_resize_all_windows $term, $new_width, $new_height
		391
		392	Called just after the new window size has been calculated, but before
		393	windows are actually being resized or hints are being set. If this hook
		394	returns a true value, setting of the window hints is being skipped.
493		395
494	=item on_x_event $term, $event	396	=item on_x_event $term, $event
495		397
496	Called on every X event received on the vt window (and possibly other	398	Called on every X event received on the vt window (and possibly other
497	windows). Should only be used as a last resort. Most event structure	399	windows). Should only be used as a last resort. Most event structure
498	members are not passed.	400	members are not passed.
499		401
		402	=item on_root_event $term, $event
		403
		404	Like C<on_x_event>, but is called for events on the root window.
		405
500	=item on_focus_in $term	406	=item on_focus_in $term
501		407
502	Called whenever the window gets the keyboard focus, before rxvt-unicode	408	Called whenever the window gets the keyboard focus, before rxvt-unicode
503	does focus in processing.	409	does focus in processing.
504		410
505	=item on_focus_out $term	411	=item on_focus_out $term
506		412
507	Called wheneever the window loses keyboard focus, before rxvt-unicode does	413	Called whenever the window loses keyboard focus, before rxvt-unicode does
508	focus out processing.	414	focus out processing.
509		415
510	=item on_configure_notify $term, $event	416	=item on_configure_notify $term, $event
511		417
512	=item on_property_notify $term, $event	418	=item on_property_notify $term, $event
…		…
523		429
524	=item on_map_notify $term, $event	430	=item on_map_notify $term, $event
525		431
526	=item on_unmap_notify $term, $event	432	=item on_unmap_notify $term, $event
527		433
528	Called whenever the corresponding X event is received for the terminal If	434	Called whenever the corresponding X event is received for the terminal. If
529	the hook returns true, then the even will be ignored by rxvt-unicode.	435	the hook returns true, then the event will be ignored by rxvt-unicode.
530		436
531	The event is a hash with most values as named by Xlib (see the XEvent	437	The event is a hash with most values as named by Xlib (see the XEvent
532	manpage), with the additional members C<row> and C<col>, which are the	438	manpage), with the additional members C<row> and C<col>, which are the
533	(real, not screen-based) row and column under the mouse cursor.	439	(real, not screen-based) row and column under the mouse cursor.
534		440
535	C<on_key_press> additionally receives the string rxvt-unicode would	441	C<on_key_press> additionally receives the string rxvt-unicode would
536	output, if any, in locale-specific encoding.	442	output, if any, in locale-specific encoding.
537		443
538	subwindow.
539
540	=item on_client_message $term, $event	444	=item on_client_message $term, $event
541		445
542	=item on_wm_protocols $term, $event	446	=item on_wm_protocols $term, $event
543		447
544	=item on_wm_delete_window $term, $event	448	=item on_wm_delete_window $term, $event
545		449
546	Called when various types of ClientMessage events are received (all with	450	Called when various types of ClientMessage events are received (all with
547	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	451	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
548		452
		453	=item on_bell $term
		454
		455	Called on receipt of a bell character.
		456
549	=back	457	=back
550		458
551	=cut	459	=cut
552		460
553	package urxvt;	461	package urxvt;
554		462
555	use utf8;	463	use utf8;
556	use strict;	464	use strict qw(vars subs);
557	use Carp ();	465	use Carp ();
558	use Scalar::Util ();	466	use Scalar::Util ();
559	use List::Util ();	467	use List::Util ();
560		468
561	our $VERSION = 1;	469	our $VERSION = 1;
562	our $TERM;	470	our $TERM;
563	our @TERM_INIT;	471	our @TERM_INIT; # should go, prevents async I/O etc.
564	our @TERM_EXT;	472	our @TERM_EXT; # should go, prevents async I/O etc.
565	our @HOOKNAME;	473	our @HOOKNAME;
566	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	474	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
567	our %OPTION;	475	our %OPTION;
568		476
569	our $LIBDIR;	477	our $LIBDIR;
…		…
573		481
574	our $NOCHAR = chr 0xffff;	482	our $NOCHAR = chr 0xffff;
575		483
576	=head2 Variables in the C<urxvt> Package	484	=head2 Variables in the C<urxvt> Package
577		485
578	=over 4	486	=over
579		487
580	=item $urxvt::LIBDIR	488	=item $urxvt::LIBDIR
581		489
582	The rxvt-unicode library directory, where, among other things, the perl	490	The rxvt-unicode library directory, where, among other things, the perl
583	modules and scripts are stored.	491	modules and scripts are stored.
…		…
595	The current terminal. This variable stores the current C<urxvt::term>	503	The current terminal. This variable stores the current C<urxvt::term>
596	object, whenever a callback/hook is executing.	504	object, whenever a callback/hook is executing.
597		505
598	=item @urxvt::TERM_INIT	506	=item @urxvt::TERM_INIT
599		507
600	All coderefs in this array will be called as methods of the next newly	508	All code references in this array will be called as methods of the next newly
601	created C<urxvt::term> object (during the C<on_init> phase). The array	509	created C<urxvt::term> object (during the C<on_init> phase). The array
602	gets cleared before the codereferences that were in it are being executed,	510	gets cleared before the code references that were in it are being executed,
603	so coderefs can push themselves onto it again if they so desire.	511	so references can push themselves onto it again if they so desire.
604		512
605	This complements to the perl-eval commandline option, but gets executed	513	This complements to the perl-eval command line option, but gets executed
606	first.	514	first.
607		515
608	=item @urxvt::TERM_EXT	516	=item @urxvt::TERM_EXT
609		517
610	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	518	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
613		521
614	=back	522	=back
615		523
616	=head2 Functions in the C<urxvt> Package	524	=head2 Functions in the C<urxvt> Package
617		525
618	=over 4	526	=over
619		527
620	=item urxvt::fatal $errormessage	528	=item urxvt::fatal $errormessage
621		529
622	Fatally aborts execution with the given error message. Avoid at all	530	Fatally aborts execution with the given error message (which should
623	costs! The only time this is acceptable is when the terminal process	531	include a trailing newline). Avoid at all costs! The only time this
624	starts up.	532	is acceptable (and useful) is in the init hook, where it prevents the
		533	terminal from starting up.
625		534
626	=item urxvt::warn $string	535	=item urxvt::warn $string
627		536
628	Calls C<rxvt_warn> with the given string which should not include a	537	Calls C<rxvt_warn> with the given string which should include a trailing
629	newline. The module also overwrites the C<warn> builtin with a function	538	newline. The module also overwrites the C<warn> builtin with a function
630	that calls this function.	539	that calls this function.
631		540
632	Using this function has the advantage that its output ends up in the	541	Using this function has the advantage that its output ends up in the
633	correct place, e.g. on stderr of the connecting urxvtc client.	542	correct place, e.g. on stderr of the connecting urxvtc client.
634		543
635	Messages have a size limit of 1023 bytes currently.	544	Messages have a size limit of 1023 bytes currently.
		545
		546	=item @terms = urxvt::termlist
		547
		548	Returns all urxvt::term objects that exist in this process, regardless of
		549	whether they are started, being destroyed etc., so be careful. Only term
		550	objects that have perl extensions attached will be returned (because there
		551	is no urxvt::term object associated with others).
636		552
637	=item $time = urxvt::NOW	553	=item $time = urxvt::NOW
638		554
639	Returns the "current time" (as per the event loop).	555	Returns the "current time" (as per the event loop).
640		556
…		…
660	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	576	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
661	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	577	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
662		578
663	Various constants for use in X calls and event processing.	579	Various constants for use in X calls and event processing.
664		580
		581	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		582	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		583	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		584	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		585	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		586	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		587	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
		588	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		589	PrivMode_Default
		590
		591	Constants for checking DEC private modes.
		592
665	=back	593	=back
666		594
667	=head2 RENDITION	595	=head2 RENDITION
668		596
669	Rendition bitsets contain information about colour, font, font styles and	597	Rendition bitsets contain information about colour, font, font styles and
…		…
672	The following "macros" deal with changes in rendition sets. You should	600	The following "macros" deal with changes in rendition sets. You should
673	never just create a bitset, you should always modify an existing one,	601	never just create a bitset, you should always modify an existing one,
674	as they contain important information required for correct operation of	602	as they contain important information required for correct operation of
675	rxvt-unicode.	603	rxvt-unicode.
676		604
677	=over 4	605	=over
678		606
679	=item $rend = urxvt::DEFAULT_RSTYLE	607	=item $rend = urxvt::DEFAULT_RSTYLE
680		608
681	Returns the default rendition, as used when the terminal is starting up or	609	Returns the default rendition, as used when the terminal is starting up or
682	being reset. Useful as a base to start when creating renditions.	610	being reset. Useful as a base to start when creating renditions.
683		611
684	=item $rend = urxvt::OVERLAY_RSTYLE	612	=item $rend = urxvt::OVERLAY_RSTYLE
685		613
686	Return the rendition mask used for overlays by default.	614	Return the rendition mask used for overlays by default.
687		615
688	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	616	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		617	urxvt::RS_RVid, urxvt::RS_Uline
689		618
690	Return the bit that enabled bold, italic, blink, reverse-video and	619	Return the bit that enabled bold, italic, blink, reverse-video and
691	underline, respectively. To enable such a style, just logically OR it into	620	underline, respectively. To enable such a style, just logically OR it into
692	the bitset.	621	the bitset.
693		622
…		…
698	Return the foreground/background colour index, respectively.	627	Return the foreground/background colour index, respectively.
699		628
700	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	629	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
701		630
702	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	631	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		632
		633	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
703		634
704	Replace the foreground/background colour in the rendition mask with the	635	Replace the foreground/background colour in the rendition mask with the
705	specified one.	636	specified one.
706		637
707	=item $value = urxvt::GET_CUSTOM $rend	638	=item $value = urxvt::GET_CUSTOM $rend
…		…
728	};	659	};
729	}	660	}
730		661
731	no warnings 'utf8';	662	no warnings 'utf8';
732		663
		664	sub parse_resource {
		665	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		666
		667	$term->scan_extensions;
		668
		669	# iterating over all resources has quadratic time overhead
		670	# overall, maybe this could be optimised?
		671	my $r = $term->{meta}{resource};
		672	keys %$r; # reset iterator
		673	while (my ($k, $v) = each %$r) {
		674	my $pattern = $k;
		675	$pattern =~ y/./-/ if $isarg;
		676	my $prefix = $name;
		677	my $suffix;
		678	if ($pattern =~ /\-$/) {
		679	$prefix = substr $name, 0, length $pattern;
		680	$suffix = substr $name, length $pattern;
		681	}
		682	if ($pattern eq $prefix) {
		683	$name = "$urxvt::RESCLASS.$k$suffix";
		684
		685	push @{ $term->{perl_ext_3} }, $v->[0];
		686
		687	return 1 unless $isarg;
		688
		689	if ($v->[1] eq "boolean") {
		690	$term->put_option_db ($name, $flag ? "true" : "false");
		691	return 1;
		692	} else {
		693	$term->put_option_db ($name, $value);
		694	return 1 + 2;
		695	}
		696	}
		697	}
		698
		699	0
		700	}
		701
		702	sub usage {
		703	my ($term, $usage_type) = @_;
		704
		705	$term->scan_extensions;
		706
		707	my $r = $term->{meta}{resource};
		708
		709	for my $pattern (sort keys %$r) {
		710	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		711
		712	$desc .= " (-pe $ext)";
		713
		714	if ($usage_type == 1) {
		715	$pattern =~ y/./-/;
		716	$pattern =~ s/-$/-.../g;
		717
		718	if ($type eq "boolean") {
		719	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		720	} else {
		721	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		722	}
		723	} else {
		724	$pattern =~ s/\.$/.*/g;
		725	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		726	}
		727	}
		728	}
		729
733	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	730	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
734		731
735	sub verbose {	732	sub verbose {
736	my ($level, $msg) = @_;	733	my ($level, $msg) = @_;
737	warn "$msg\n" if $level <= $verbosity;	734	warn "$msg\n" if $level <= $verbosity;
738	}	735	}
…		…
749	$pkg =~ s/[^[:word:]]/_/g;	746	$pkg =~ s/[^[:word:]]/_/g;
750	$pkg = "urxvt::ext::$pkg";	747	$pkg = "urxvt::ext::$pkg";
751		748
752	verbose 3, "loading extension '$path' into package '$pkg'";	749	verbose 3, "loading extension '$path' into package '$pkg'";
753		750
		751	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		752
754	open my $fh, "<:raw", $path	753	open my $fh, "<:raw", $path
755	or die "$path: $!";	754	or die "$path: $!";
756		755
757	my $source =	756	my $source =
758	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	757	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
759	. "#line 1 \"$path\"\n{\n"	758	. "#line 1 \"$path\"\n{\n"
760	. (do { local $/; <$fh> })	759	. (do { local $/; <$fh> })
761	. "\n};\n1";	760	. "\n};\n1";
762		761
763	eval $source	762	eval $source
…		…
772	# called by the rxvt core	771	# called by the rxvt core
773	sub invoke {	772	sub invoke {
774	local $TERM = shift;	773	local $TERM = shift;
775	my $htype = shift;	774	my $htype = shift;
776		775
777	if ($htype == 0) { # INIT	776	if ($htype == HOOK_INIT) {
778	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	777	$TERM->scan_extensions;
779		778
780	my %ext_arg;	779	my %ext_arg;
781		780
782	{	781	{
783	my @init = @TERM_INIT;	782	my @init = @TERM_INIT;
784	@TERM_INIT = ();	783	@TERM_INIT = ();
…		…
786	my @pkg = @TERM_EXT;	785	my @pkg = @TERM_EXT;
787	@TERM_EXT = ();	786	@TERM_EXT = ();
788	$TERM->register_package ($_) for @pkg;	787	$TERM->register_package ($_) for @pkg;
789	}	788	}
790		789
		790	for (
		791	@{ delete $TERM->{perl_ext_3} },
791	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	792	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		793	) {
792	if ($_ eq "default") {	794	if ($_ eq "default") {
		795
		796	$ext_arg{$_} = []
793	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	797	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
		798
		799	for ($TERM->_keysym_resources) {
		800	next if /^(?:string|command|builtin|builtin-string|perl)/;
		801	next unless /^([A-Za-z0-9_\-]+):/;
		802
		803	my $ext = $1;
		804
		805	$ext_arg{$ext} = [];
		806	}
		807
794	} elsif (/^-(.*)$/) {	808	} elsif (/^-(.*)$/) { # remove from set
795	delete $ext_arg{$1};	809	delete $ext_arg{$1};
796	} elsif (/^([^<]+)<(.*)>$/) {	810
		811	} elsif (/^\/(.*)$/) { # prohibit loading
		812	undef $TERM->{ext_prohibit}{$1};
		813
		814	} elsif (/^([^<]+)(?:<(.*)>)?$/) { # add to set, clear prohibit status
		815	delete $TERM->{ext_prohibit}{$1};
797	push @{ $ext_arg{$1} }, $2;	816	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		817
798	} else {	818	} else {
799	$ext_arg{$_} ||= [];	819	verbose 2, "cannot parse extension specification '$_', ignoring.";
800	}	820	}
801	}	821	}
802		822
803	while (my ($ext, $argv) = each %ext_arg) {	823	$TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
804	my @files = grep -f $_, map "$_/$ext", @dirs;	824	$TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
805		825
806	if (@files) {	826	for my $ext (sort keys %ext_arg) {
807	$TERM->register_package (extension_package $files[0], $argv);	827	my $path = $TERM->extension_path ($ext);
		828
		829	if (defined $path) {
		830	$TERM->autoload_extension ($ext, $ext_arg{$ext});
808	} else {	831	} else {
809	warn "perl extension '$ext' not found in perl library search path\n";	832	verbose 2, "perl extension '$ext' not found in perl library search path";
810	}	833	}
811	}	834	}
812		835
813	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");	836	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
814	warn $@ if $@;	837	warn $@ if $@;
815	}	838	}
816		839
		840	if ($htype == HOOK_OSC_SEQ) {
		841	if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
		842	$TERM->autoload_extension ($_->[0]) for @$exts;
		843	}
		844	} elsif ($htype == HOOK_OSC_SEQ_PERL) {
		845	if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
		846	$TERM->autoload_extension ($_->[0]) for @$exts;
		847	}
		848	}
		849
817	$retval = undef;	850	$retval = undef;
818		851
819	if (my $cb = $TERM->{_hook}[$htype]) {	852	if (my $cb = $TERM->{_hook}[$htype]) {
820	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	853	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
821	if $verbosity >= 10;	854	if $verbosity >= 10;
822		855
823	keys %$cb;	856	if ($htype == HOOK_ACTION) {
		857	# this hook is only sent to the extension with the name
		858	# matching the first arg
		859	my $pkg = shift;
		860	$pkg =~ y/-/_/;
		861	$pkg = "urxvt::ext::$pkg";
824		862
825	while (my ($pkg, $cb) = each %$cb) {	863	$cb = $cb->{$pkg}
		864	or return undef; #TODO: maybe warn user?
		865
		866	$cb = { $pkg => $cb };
		867	}
		868
		869	for my $pkg (keys %$cb) {
826	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	870	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
827	$retval ||= $retval_;	871	$retval ||= $retval_;
828		872
829	if ($@) {	873	if ($@) {
830	$TERM->ungrab; # better to lose the grab than the session	874	$TERM->ungrab; # better to lose the grab than the session
831	warn $@;	875	warn $@;
…		…
834		878
835	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	879	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
836	if $verbosity >= 11;	880	if $verbosity >= 11;
837	}	881	}
838		882
839	if ($htype == 1) { # DESTROY	883	if ($htype == HOOK_DESTROY) {
840	# clear package objects	884	# clear package objects
841	%$_ = () for values %{ $TERM->{_pkg} };	885	%$_ = () for values %{ $TERM->{_pkg} };
842		886
843	# clear package	887	# clear package
844	%$TERM = ();	888	%$TERM = ();
845	}	889	}
846		890
847	$retval	891	$retval
848	}	892	}
849		893
850	# urxvt::term::extension	894	sub SET_COLOR($$$) {
		895	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		896	}
		897
		898	sub rend2mask {
		899	no strict 'refs';
		900	my ($str, $mask) = (@_, 0);
		901	my %color = ( fg => undef, bg => undef );
		902	my @failed;
		903	for my $spec ( split /\s+/, $str ) {
		904	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		905	$color{lc($1)} = $2;
		906	} else {
		907	my $neg = $spec =~ s/^[-^]//;
		908	unless ( exists &{"RS_$spec"} ) {
		909	push @failed, $spec;
		910	next;
		911	}
		912	my $cur = &{"RS_$spec"};
		913	if ( $neg ) {
		914	$mask &= ~$cur;
		915	} else {
		916	$mask |= $cur;
		917	}
		918	}
		919	}
		920	($mask, @color{qw(fg bg)}, \@failed)
		921	}
851		922
852	package urxvt::term::extension;	923	package urxvt::term::extension;
853		924
854	sub enable {	925	=head2 The C<urxvt::term::extension> class
855	my ($self, %hook) = @_;
856	my $pkg = $self->{_pkg};
857		926
858	while (my ($name, $cb) = each %hook) {	927	Each extension attached to a terminal object is represented by
859	my $htype = $HOOKTYPE{uc $name};	928	a C<urxvt::term::extension> object.
860	defined $htype
861	or Carp::croak "unsupported hook type '$name'";
862		929
863	$self->set_should_invoke ($htype, +1)	930	You can use these objects, which are passed to all callbacks to store any
864	unless exists $self->{term}{_hook}[$htype]{$pkg};	931	state related to the terminal and extension instance.
865		932
866	$self->{term}{_hook}[$htype]{$pkg} = $cb;	933	The methods (And data members) documented below can be called on extension
867	}	934	objects, in addition to call methods documented for the <urxvt::term>
868	}	935	class.
869		936
870	sub disable {	937	=over
871	my ($self, @hook) = @_;
872	my $pkg = $self->{_pkg};
873		938
874	for my $name (@hook) {	939	=item $urxvt_term = $self->{term}
875	my $htype = $HOOKTYPE{uc $name};
876	defined $htype
877	or Carp::croak "unsupported hook type '$name'";
878		940
879	$self->set_should_invoke ($htype, -1)	941	Returns the C<urxvt::term> object associated with this instance of the
880	if delete $self->{term}{_hook}[$htype]{$pkg};	942	extension. This member I<must not> be changed in any way.
881	}	943
882	}	944	=cut
883		945
884	our $AUTOLOAD;	946	our $AUTOLOAD;
885		947
886	sub AUTOLOAD {	948	sub AUTOLOAD {
887	$AUTOLOAD =~ /:([^:]+)$/	949	$AUTOLOAD =~ /:([^:]+)$/
…		…
900		962
901	sub DESTROY {	963	sub DESTROY {
902	# nop	964	# nop
903	}	965	}
904		966
905	# urxvt::destroy_hook	967	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
906		968
907	sub urxvt::destroy_hook::DESTROY {	969	sub urxvt::destroy_hook::DESTROY {
908	${$_[0]}->();	970	${$_[0]}->();
909	}	971	}
910		972
911	sub urxvt::destroy_hook(&) {	973	sub urxvt::destroy_hook(&) {
912	bless \shift, urxvt::destroy_hook::	974	bless \shift, urxvt::destroy_hook::
913	}	975	}
		976
		977	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		978
		979	Dynamically enable the given hooks (named without the C<on_> prefix) for
		980	this extension, replacing any hook previously installed via C<enable> in
		981	this extension.
		982
		983	This is useful when you want to overwrite time-critical hooks only
		984	temporarily.
		985
		986	To install additional callbacks for the same hook, you can use the C<on>
		987	method of the C<urxvt::term> class.
		988
		989	=item $self->disable ($hook_name[, $hook_name..])
		990
		991	Dynamically disable the given hooks.
		992
		993	=cut
		994
		995	sub enable {
		996	my ($self, %hook) = @_;
		997	my $pkg = $self->{_pkg};
		998
		999	while (my ($name, $cb) = each %hook) {
		1000	my $htype = $HOOKTYPE{uc $name};
		1001	defined $htype
		1002	or Carp::croak "unsupported hook type '$name'";
		1003
		1004	$self->set_should_invoke ($htype, +1)
		1005	unless exists $self->{term}{_hook}[$htype]{$pkg};
		1006
		1007	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		1008	}
		1009	}
		1010
		1011	sub disable {
		1012	my ($self, @hook) = @_;
		1013	my $pkg = $self->{_pkg};
		1014
		1015	for my $name (@hook) {
		1016	my $htype = $HOOKTYPE{uc $name};
		1017	defined $htype
		1018	or Carp::croak "unsupported hook type '$name'";
		1019
		1020	$self->set_should_invoke ($htype, -1)
		1021	if delete $self->{term}{_hook}[$htype]{$pkg};
		1022	}
		1023	}
		1024
		1025	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		1026
		1027	Similar to the C<enable> enable, but installs additional callbacks for
		1028	the given hook(s) (that is, it doesn't replace existing callbacks), and
		1029	returns a guard object. When the guard object is destroyed the callbacks
		1030	are disabled again.
		1031
		1032	=cut
		1033
		1034	sub urxvt::extension::on_disable::DESTROY {
		1035	my $disable = shift;
		1036
		1037	my $term = delete $disable->{""};
		1038
		1039	while (my ($htype, $id) = each %$disable) {
		1040	delete $term->{_hook}[$htype]{$id};
		1041	$term->set_should_invoke ($htype, -1);
		1042	}
		1043	}
		1044
		1045	sub on {
		1046	my ($self, %hook) = @_;
		1047
		1048	my $term = $self->{term};
		1049
		1050	my %disable = ( "" => $term );
		1051
		1052	while (my ($name, $cb) = each %hook) {
		1053	my $htype = $HOOKTYPE{uc $name};
		1054	defined $htype
		1055	or Carp::croak "unsupported hook type '$name'";
		1056
		1057	$term->set_should_invoke ($htype, +1);
		1058	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		1059	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		1060	}
		1061
		1062	bless \%disable, "urxvt::extension::on_disable"
		1063	}
		1064
		1065	=item $self->bind_action ($hotkey, $action)
		1066
		1067	=item $self->x_resource ($pattern)
		1068
		1069	=item $self->x_resource_boolean ($pattern)
		1070
		1071	These methods support an additional C<%> prefix for C<$action> or
		1072	C<$pattern> when called on an extension object, compared to the
		1073	C<urxvt::term> methods of the same name - see the description of these
		1074	methods in the C<urxvt::term> class for details.
		1075
		1076	=cut
		1077
		1078	sub bind_action {
		1079	my ($self, $hotkey, $action) = @_;
		1080	$action =~ s/^%:/$_[0]{_name}:/;
		1081	$self->{term}->bind_action ($hotkey, $action)
		1082	}
		1083
		1084	sub x_resource {
		1085	my ($self, $name) = @_;
		1086	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1087	$self->{term}->x_resource ($name)
		1088	}
		1089
		1090	sub x_resource_boolean {
		1091	my ($self, $name) = @_;
		1092	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1093	$self->{term}->x_resource_boolean ($name)
		1094	}
		1095
		1096	=back
		1097
		1098	=cut
914		1099
915	package urxvt::anyevent;	1100	package urxvt::anyevent;
916		1101
917	=head2 The C<urxvt::anyevent> Class	1102	=head2 The C<urxvt::anyevent> Class
918		1103
919	The sole purpose of this class is to deliver an interface to the	1104	The sole purpose of this class is to deliver an interface to the
920	C<AnyEvent> module - any module using it will work inside urxvt without	1105	C<AnyEvent> module - any module using it will work inside urxvt without
921	further programming. The only exception is that you cannot wait on	1106	further programming. The only exception is that you cannot wait on
922	condition variables, but non-blocking condvar use is ok. What this means	1107	condition variables, but non-blocking condvar use is ok.
923	is that you cannot use blocking APIs, but the non-blocking variant should
924	work.
925		1108
926	=cut	1109	In practical terms this means is that you cannot use blocking APIs, but
		1110	the non-blocking variant should work.
927		1111
		1112	=cut
		1113
928	our $VERSION = 1;	1114	our $VERSION = '5.23';
929		1115
930	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1116	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
931	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1117	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
932		1118
933	sub timer {	1119	sub timer {
…		…
935		1121
936	my $cb = $arg{cb};	1122	my $cb = $arg{cb};
937		1123
938	urxvt::timer	1124	urxvt::timer
939	->new	1125	->new
940	->start (urxvt::NOW + $arg{after})	1126	->after ($arg{after}, $arg{interval})
941	->cb (sub {	1127	->cb ($arg{interval} ? $cb : sub {
942	$_[0]->stop; # need to cancel manually	1128	$_[0]->stop; # need to cancel manually
943	$cb->();	1129	$cb->();
944	})	1130	})
945	}	1131	}
946		1132
947	sub io {	1133	sub io {
948	my ($class, %arg) = @_;	1134	my ($class, %arg) = @_;
949		1135
950	my $cb = $arg{cb};	1136	my $cb = $arg{cb};
		1137	my $fd = fileno $arg{fh};
		1138	defined $fd or $fd = $arg{fh};
951		1139
952	bless [$arg{fh}, urxvt::iow	1140	bless [$arg{fh}, urxvt::iow
953	->new	1141	->new
954	->fd (fileno $arg{fh})	1142	->fd ($fd)
955	->events (($arg{poll} =~ /r/ ? 1 : 0)	1143	->events (($arg{poll} =~ /r/ ? 1 : 0)
956	| ($arg{poll} =~ /w/ ? 2 : 0))	1144	| ($arg{poll} =~ /w/ ? 2 : 0))
957	->start	1145	->start
958	->cb (sub {	1146	->cb ($cb)
959	$cb->(($_[1] & 1 ? 'r' : '')
960	. ($_[1] & 2 ? 'w' : ''));
961	})],
962	urxvt::anyevent::	1147	], urxvt::anyevent::
		1148	}
		1149
		1150	sub idle {
		1151	my ($class, %arg) = @_;
		1152
		1153	my $cb = $arg{cb};
		1154
		1155	urxvt::iw
		1156	->new
		1157	->start
		1158	->cb ($cb)
		1159	}
		1160
		1161	sub child {
		1162	my ($class, %arg) = @_;
		1163
		1164	my $cb = $arg{cb};
		1165
		1166	urxvt::pw
		1167	->new
		1168	->start ($arg{pid})
		1169	->cb (sub {
		1170	$_[0]->stop; # need to cancel manually
		1171	$cb->($_[0]->rpid, $_[0]->rstatus);
		1172	})
963	}	1173	}
964		1174
965	sub DESTROY {	1175	sub DESTROY {
966	$_[0][1]->stop;	1176	$_[0][1]->stop;
967	}	1177	}
968		1178
969	sub condvar {	1179	# only needed for AnyEvent < 6 compatibility
970	bless \my $flag, urxvt::anyevent::condvar::	1180	sub one_event {
971	}
972
973	sub urxvt::anyevent::condvar::broadcast {
974	${$_[0]}++;
975	}
976
977	sub urxvt::anyevent::condvar::wait {
978	unless (${$_[0]}) {
979	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1181	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
980	}
981	}	1182	}
982		1183
983	package urxvt::term;	1184	package urxvt::term;
984		1185
985	=head2 The C<urxvt::term> Class	1186	=head2 The C<urxvt::term> Class
986		1187
987	=over 4	1188	=over
988		1189
989	=cut	1190	=cut
990		1191
991	# find on_xxx subs in the package and register them	1192	# find on_xxx subs in the package and register them
992	# as hooks	1193	# as hooks
993	sub register_package {	1194	sub register_package {
994	my ($self, $pkg, $argv) = @_;	1195	my ($self, $pkg, $argv) = @_;
995		1196
		1197	return if $self->{_pkg}{$pkg};
		1198
996	no strict 'refs';	1199	no strict 'refs';
997		1200
998	urxvt::verbose 6, "register package $pkg to $self";	1201	urxvt::verbose 6, "register package $pkg to $self";
999		1202
1000	@{"$pkg\::ISA"} = urxvt::term::extension::;	1203	@{"$pkg\::ISA"} = urxvt::term::extension::;
1001		1204
1002	my $proxy = bless {	1205	my $proxy = bless {
1003	_pkg => $pkg,	1206	_pkg => $pkg,
		1207	_name => ${"$pkg\::_NAME"}, # hackish
1004	argv => $argv,	1208	argv => $argv,
1005	}, $pkg;	1209	}, $pkg;
1006	Scalar::Util::weaken ($proxy->{term} = $self);	1210	Scalar::Util::weaken ($proxy->{term} = $self);
1007		1211
1008	$self->{_pkg}{$pkg} = $proxy;	1212	$self->{_pkg}{$pkg} = $proxy;
1009		1213
1010	for my $name (@HOOKNAME) {	1214	for my $name (@HOOKNAME) {
1011	if (my $ref = $pkg->can ("on_" . lc $name)) {	1215	if (my $ref = $pkg->can ("on_" . lc $name)) {
1012	$proxy->enable ($name => $ref);	1216	$proxy->enable ($name => $ref);
1013	}	1217	}
1014	}	1218	}
		1219
		1220	if (my $attach_hook = $pkg->can ("on_attach")) {
		1221	$attach_hook->($proxy)
		1222	or urxvt::verbose 1, "$pkg->on_attach returned false, extension failed to attach";
		1223	}
		1224	}
		1225
		1226	# map extension name to filesystem path
		1227	sub extension_path {
		1228	(grep -f $_, map "$_/$_[1]", $_[0]->perl_libdirs)[0]
		1229	}
		1230
		1231	# load an extension by name
		1232	sub load_extension_file {
		1233	my ($self, $path, $argv) = @_;
		1234
		1235	$self->register_package (urxvt::extension_package $path, $argv);
		1236	}
		1237
		1238	# autoload an extension unless loading it is prohibited
		1239	sub autoload_extension {
		1240	my ($self, $name, $argv) = @_;
		1241
		1242	return if exists $self->{ext_prohibit}{$name};
		1243
		1244	my $path = $self->extension_path ($name)
		1245	// return urxvt::verbose 2, "perl extension '$name' not found in perl library search path (during autoload)";
		1246
		1247	$self->load_extension_file ($path, $argv);
		1248	}
		1249
		1250	sub perl_libdirs {
		1251	map { split /:/ }
		1252	$_[0]->resource ("perl_lib"),
		1253	$ENV{URXVT_PERL_LIB},
		1254	"$ENV{HOME}/.urxvt/ext",
		1255	"$LIBDIR/perl"
		1256	}
		1257
		1258	# scan for available extensions and collect their metadata
		1259	sub scan_extensions {
		1260	my ($self) = @_;
		1261
		1262	return if exists $self->{meta};
		1263
		1264	my @urxvtdirs = perl_libdirs $self;
		1265	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1266
		1267	$self->{meta} = \my %allmeta;
		1268
		1269	# first gather extensions
		1270
		1271	my $gather = sub {
		1272	my ($dir, $core) = @_;
		1273
		1274	opendir my $fh, $dir
		1275	or return;
		1276
		1277	for my $ext (readdir $fh) {
		1278	$ext !~ /^\./
		1279	or next;
		1280
		1281	open my $fh, "<", "$dir/$ext"
		1282	or next;
		1283
		1284	-f $fh
		1285	or next;
		1286
		1287	$ext =~ s/\.uext$// or $core
		1288	or next;
		1289
		1290	my %meta = (dir => $dir);
		1291
		1292	while (<$fh>) {
		1293	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1294	my ($pattern, $type, $desc) = split /:/, $1;
		1295	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1296	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1297	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1298	} else {
		1299	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1300	}
		1301
		1302	} elsif (/^#:META:OSC:([0-9]+):(.*)/) {
		1303	push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
		1304
		1305	} elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
		1306	push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
		1307
		1308	} elsif (/^\s*(?:#|$)/) {
		1309	# skip other comments and empty lines
		1310
		1311	} else {
		1312	last; # stop parsing on first non-empty non-comment line
		1313	}
		1314	}
		1315
		1316	$allmeta{ext}{$ext} = \%meta;
		1317	}
		1318	};
		1319
		1320	# $gather->($_, 0) for @cpandirs;
		1321	$gather->($_, 1) for @urxvtdirs;
		1322
		1323	# and now merge resources
		1324
		1325	$allmeta{resource} = \my %resource;
		1326
		1327	while (my ($k, $v) = each %{ $allmeta{ext} }) {
		1328	#TODO: should check for extensions overriding each other
		1329	%resource = (%resource, %{ $v->{resource} });
		1330	}
1015	}	1331	}
1016		1332
1017	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1333	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1018		1334
1019	Creates a new terminal, very similar as if you had started it with system	1335	Creates a new terminal, very similar as if you had started it with system
…		…
1021	hash which defines the environment of the new terminal.	1337	hash which defines the environment of the new terminal.
1022		1338
1023	Croaks (and probably outputs an error message) if the new instance	1339	Croaks (and probably outputs an error message) if the new instance
1024	couldn't be created. Returns C<undef> if the new instance didn't	1340	couldn't be created. Returns C<undef> if the new instance didn't
1025	initialise perl, and the terminal object otherwise. The C<init> and	1341	initialise perl, and the terminal object otherwise. The C<init> and
1026	C<start> hooks will be called during this call.	1342	C<start> hooks will be called before this call returns, and are free to
		1343	refer to global data (which is race free).
1027		1344
1028	=cut	1345	=cut
1029		1346
1030	sub new {	1347	sub new {
1031	my ($class, $env, @args) = @_;	1348	my ($class, $env, @args) = @_;
1032		1349
		1350	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1351	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1352
1033	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1353	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1034	}	1354	}
1035		1355
1036	=item $term->destroy	1356	=item $term->destroy
1037		1357
1038	Destroy the terminal object (close the window, free resources	1358	Destroy the terminal object (close the window, free resources
1039	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1359	etc.). Please note that urxvt will not exit as long as any event
1040	watchers (timers, io watchers) are still active.	1360	watchers (timers, io watchers) are still active.
1041		1361
1042	=item $term->exec_async ($cmd[, @args])	1362	=item $term->exec_async ($cmd[, @args])
1043		1363
1044	Works like the combination of the C<fork>/C<exec> builtins, which executes	1364	Works like the combination of the C<fork>/C<exec> builtins, which executes
1045	("starts") programs in the background. This function takes care of setting	1365	("starts") programs in the background. This function takes care of setting
1046	the user environment before exec'ing the command (e.g. C<PATH>) and should	1366	the user environment before exec'ing the command (e.g. C<PATH>) and should
1047	be preferred over explicit calls to C<exec> or C<system>.	1367	be preferred over explicit calls to C<exec> or C<system>.
1048		1368
		1369	It also sets the C<URXVT_EXT_WINDOWID> environment variable to the window
		1370	ID of the terminal (C<< $self->parent >>), similar to the C<WINDOWID>
		1371	variable set for the process spawned inside the terminal.
		1372
1049	Returns the pid of the subprocess or C<undef> on error.	1373	Returns the pid of the subprocess or C<undef> on error.
1050		1374
1051	=cut	1375	=cut
1052		1376
1053	sub exec_async {	1377	sub exec_async {
…		…
1056	my $pid = fork;	1380	my $pid = fork;
1057		1381
1058	return $pid	1382	return $pid
1059	if !defined $pid or $pid;	1383	if !defined $pid or $pid;
1060		1384
		1385	%ENV = (
1061	%ENV = %{ $self->env };	1386	%{ $self->env },
		1387	URXVT_EXT_WINDOWID => $self->parent,
		1388	);
1062		1389
1063	exec @_;	1390	exec @_;
1064	urxvt::_exit 255;	1391	urxvt::_exit 255;
1065	}	1392	}
1066		1393
…		…
1068		1395
1069	Returns true if the option specified by C<$optval> is enabled, and	1396	Returns true if the option specified by C<$optval> is enabled, and
1070	optionally change it. All option values are stored by name in the hash	1397	optionally change it. All option values are stored by name in the hash
1071	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1398	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1072		1399
1073	Here is a a likely non-exhaustive list of option names, please see the	1400	Here is a likely non-exhaustive list of option names, please see the
1074	source file F</src/optinc.h> to see the actual list:	1401	source file F</src/optinc.h> to see the actual list:
1075		1402
1076	borderLess console cursorBlink cursorUnderline hold iconic insecure	1403	borderLess buffered console cursorBlink cursorUnderline hold iconic
1077	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1404	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1078	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1405	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1079	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1406	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1080	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1407	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1081	transparent tripleclickwords utmpInhibit visualBell	1408	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1409	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1082		1410
1083	=item $value = $term->resource ($name[, $newval])	1411	=item $value = $term->resource ($name[, $newval])
1084		1412
1085	Returns the current resource value associated with a given name and	1413	Returns the current resource value associated with a given name and
1086	optionally sets a new value. Setting values is most useful in the C<init>	1414	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1095	likely change).	1423	likely change).
1096		1424
1097	Please note that resource strings will currently only be freed when the	1425	Please note that resource strings will currently only be freed when the
1098	terminal is destroyed, so changing options frequently will eat memory.	1426	terminal is destroyed, so changing options frequently will eat memory.
1099		1427
1100	Here is a a likely non-exhaustive list of resource names, not all of which	1428	Here is a likely non-exhaustive list of resource names, not all of which
1101	are supported in every build, please see the source file F</src/rsinc.h>	1429	are supported in every build, please see the source file F</src/rsinc.h>
1102	to see the actual list:	1430	to see the actual list:
1103		1431
1104	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1432	answerbackstring backgroundPixmap backspace_key blurradius
1105	borderLess color cursorBlink cursorUnderline cutchars delete_key	1433	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1106	display_name embed ext_bwidth fade font geometry hold iconName	1434	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1107	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1435	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1436	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1108	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1437	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1109	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1438	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1110	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1439	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1111	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1440	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1112	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1441	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1113	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1442	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1114	secondaryScreen secondaryScroll selectstyle shade term_name title	1443	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1115	transient_for transparent transparent_all tripleclickwords utmpInhibit	1444	term_name title transient_for transparent tripleclickwords urgentOnBell
1116	visualBell	1445	utmpInhibit visualBell rewrapMode disablePasteBrackets
1117		1446
1118	=cut	1447	=cut
1119		1448
1120	sub resource($$;$) {	1449	sub resource($$;$) {
1121	my ($self, $name) = (shift, shift);	1450	my ($self, $name) = (shift, shift);
1122	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1451	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1123	&urxvt::term::_resource	1452	goto &urxvt::term::_resource
1124	}	1453	}
1125		1454
1126	=item $value = $term->x_resource ($pattern)	1455	=item $value = $term->x_resource ($pattern)
1127		1456
1128	Returns the X-Resource for the given pattern, excluding the program or	1457	Returns the X-Resource for the given pattern, excluding the program or
1129	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1458	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1130	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1459	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1131	resource with that pattern exists.	1460	resource with that pattern exists.
1132		1461
		1462	Extensions that define extra resources also need to call this method
		1463	to access their values.
		1464
		1465	If the method is called on an extension object (basically, from an
		1466	extension), then the special prefix C<%.> will be replaced by the name of
		1467	the extension and a dot, and the lone string C<%> will be replaced by the
		1468	extension name itself. This makes it possible to code extensions so you
		1469	can rename them and get a new set of resources without having to change
		1470	the actual code.
		1471
1133	This method should only be called during the C<on_start> hook, as there is	1472	This method should only be called during the C<on_start> hook, as there is
1134	only one resource database per display, and later invocations might return	1473	only one resource database per display, and later invocations might return
1135	the wrong resources.	1474	the wrong resources.
1136		1475
1137	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1476	=item $value = $term->x_resource_boolean ($pattern)
1138		1477
		1478	Like C<x_resource>, above, but interprets the string value as a boolean
		1479	and returns C<1> for true values, C<0> for false values and C<undef> if
		1480	the resource or option isn't specified.
		1481
		1482	You should always use this method to parse boolean resources.
		1483
		1484	=cut
		1485
		1486	sub x_resource_boolean {
		1487	my $res = &x_resource;
		1488
		1489	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1490	}
		1491
		1492	=item $action = $term->lookup_keysym ($keysym, $state)
		1493
		1494	Returns the action bound to key combination C<($keysym, $state)>,
		1495	if a binding for it exists, and C<undef> otherwise.
		1496
		1497	=item $success = $term->bind_action ($key, $action)
		1498
1139	Adds a keymap translation exactly as specified via a resource. See the	1499	Adds a key binding exactly as specified via a C<keysym> resource. See the
1140	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1500	C<keysym> resource in the urxvt(1) manpage.
		1501
		1502	To add default bindings for actions, an extension should call C<<
		1503	->bind_action >> in its C<init> hook for every such binding. Doing it
		1504	in the C<init> hook allows users to override or remove the binding
		1505	again.
		1506
		1507	Example: the C<searchable-scrollback> by default binds itself
		1508	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1509	$term->bind_action >>.
		1510
		1511	sub init {
		1512	my ($self) = @_;
		1513
		1514	$self->bind_action ("M-s" => "%:start");
		1515	}
1141		1516
1142	=item $rend = $term->rstyle ([$new_rstyle])	1517	=item $rend = $term->rstyle ([$new_rstyle])
1143		1518
1144	Return and optionally change the current rendition. Text that is output by	1519	Return and optionally change the current rendition. Text that is output by
1145	the terminal application will use this style.	1520	the terminal application will use this style.
…		…
1153		1528
1154	=item ($row, $col) = $term->selection_beg ([$row, $col])	1529	=item ($row, $col) = $term->selection_beg ([$row, $col])
1155		1530
1156	=item ($row, $col) = $term->selection_end ([$row, $col])	1531	=item ($row, $col) = $term->selection_end ([$row, $col])
1157		1532
1158	Return the current values of the selection mark, begin or end positions,	1533	Return the current values of the selection mark, begin or end positions.
1159	and optionally set them to new values.	1534
		1535	When arguments are given, then the selection coordinates are set to
		1536	C<$row> and C<$col>, and the selection screen is set to the current
		1537	screen.
		1538
		1539	=item $screen = $term->selection_screen ([$screen])
		1540
		1541	Returns the current selection screen, and then optionally sets it.
1160		1542
1161	=item $term->selection_make ($eventtime[, $rectangular])	1543	=item $term->selection_make ($eventtime[, $rectangular])
1162		1544
1163	Tries to make a selection as set by C<selection_beg> and	1545	Tries to make a selection as set by C<selection_beg> and
1164	C<selection_end>. If C<$rectangular> is true (default: false), a	1546	C<selection_end>. If C<$rectangular> is true (default: false), a
1165	rectangular selection will be made. This is the prefered function to make	1547	rectangular selection will be made. This is the preferred function to make
1166	a selection.	1548	a selection.
1167		1549
1168	=item $success = $term->selection_grab ($eventtime)	1550	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1169		1551
1170	Try to request the primary selection text from the server (for example, as	1552	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1553	true) selection from the server. The corresponding text can be set
1171	set by the next method). No visual feedback will be given. This function	1554	with the next method. No visual feedback will be given. This function
1172	is mostly useful from within C<on_sel_grab> hooks.	1555	is mostly useful from within C<on_sel_grab> hooks.
1173		1556
1174	=item $oldtext = $term->selection ([$newtext])	1557	=item $oldtext = $term->selection ([$newtext, $clipboard])
1175		1558
1176	Return the current selection text and optionally replace it by C<$newtext>.	1559	Return the current selection (clipboard if C<$clipboard> is true) text
		1560	and optionally replace it by C<$newtext>.
		1561
		1562	=item $term->selection_clear ([$clipboard])
		1563
		1564	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1177		1565
1178	=item $term->overlay_simple ($x, $y, $text)	1566	=item $term->overlay_simple ($x, $y, $text)
1179		1567
1180	Create a simple multi-line overlay box. See the next method for details.	1568	Create a simple multi-line overlay box. See the next method for details.
1181		1569
…		…
1209	This method returns an urxvt::overlay object. The overlay will be visible	1597	This method returns an urxvt::overlay object. The overlay will be visible
1210	as long as the perl object is referenced.	1598	as long as the perl object is referenced.
1211		1599
1212	The methods currently supported on C<urxvt::overlay> objects are:	1600	The methods currently supported on C<urxvt::overlay> objects are:
1213		1601
1214	=over 4	1602	=over
1215		1603
1216	=item $overlay->set ($x, $y, $text, $rend)	1604	=item $overlay->set ($x, $y, $text[, $rend])
1217		1605
1218	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1606	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1219	text in rxvt-unicode's special encoding and an array of rendition values	1607	text in rxvt-unicode's special encoding and an array of rendition values
1220	at a specific position inside the overlay.	1608	at a specific position inside the overlay.
		1609
		1610	If C<$rend> is missing, then the rendition will not be changed.
1221		1611
1222	=item $overlay->hide	1612	=item $overlay->hide
1223		1613
1224	If visible, hide the overlay, but do not destroy it.	1614	If visible, hide the overlay, but do not destroy it.
1225		1615
…		…
1261	Returns the number of screen-cells this string would need. Correctly	1651	Returns the number of screen-cells this string would need. Correctly
1262	accounts for wide and combining characters.	1652	accounts for wide and combining characters.
1263		1653
1264	=item $octets = $term->locale_encode ($string)	1654	=item $octets = $term->locale_encode ($string)
1265		1655
1266	Convert the given text string into the corresponding locale encoding.	1656	Convert the given text string into the corresponding locale
		1657	encoding. Returns C<undef> if C<$string> is C<undef>.
1267		1658
1268	=item $string = $term->locale_decode ($octets)	1659	=item $string = $term->locale_decode ($octets)
1269		1660
1270	Convert the given locale-encoded octets into a perl string.	1661	Convert the given locale-encoded octets into a perl string. Returns
		1662	C<undef> if C<$octets> is C<undef>.
1271		1663
1272	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1664	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1273		1665
1274	XORs the rendition values in the given span with the provided value	1666	XORs the rendition values in the given span with the provided value
1275	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in	1667	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
…		…
1288		1680
1289	=item $term->scr_add_lines ($string)	1681	=item $term->scr_add_lines ($string)
1290		1682
1291	Write the given text string to the screen, as if output by the application	1683	Write the given text string to the screen, as if output by the application
1292	running inside the terminal. It may not contain command sequences (escape	1684	running inside the terminal. It may not contain command sequences (escape
1293	codes), but is free to use line feeds, carriage returns and tabs. The	1685	codes - see C<cmd_parse> for that), but is free to use line feeds,
1294	string is a normal text string, not in locale-dependent encoding.	1686	carriage returns and tabs. The string is a normal text string, not in
		1687	locale-dependent encoding.
1295		1688
1296	Normally its not a good idea to use this function, as programs might be	1689	Normally its not a good idea to use this function, as programs might be
1297	confused by changes in cursor position or scrolling. Its useful inside a	1690	confused by changes in cursor position or scrolling. Its useful inside a
1298	C<on_add_lines> hook, though.	1691	C<on_add_lines> hook, though.
1299		1692
…		…
1307	locale-specific encoding of the terminal and can contain command sequences	1700	locale-specific encoding of the terminal and can contain command sequences
1308	(escape codes) that will be interpreted.	1701	(escape codes) that will be interpreted.
1309		1702
1310	=item $term->tt_write ($octets)	1703	=item $term->tt_write ($octets)
1311		1704
1312	Write the octets given in C<$data> to the tty (i.e. as program input). To	1705	Write the octets given in C<$octets> to the tty (i.e. as user input
		1706	to the program, see C<cmd_parse> for the opposite direction). To pass
1313	pass characters instead of octets, you should convert your strings first	1707	characters instead of octets, you should convert your strings first to the
1314	to the locale-specific encoding using C<< $term->locale_encode >>.	1708	locale-specific encoding using C<< $term->locale_encode >>.
		1709
		1710	=item $term->tt_write_user_input ($octets)
		1711
		1712	Like C<tt_write>, but should be used when writing strings in response to
		1713	the user pressing a key, to invoke the additional actions requested by
		1714	the user for that case (C<tt_write> doesn't do that).
		1715
		1716	The typical use case would be inside C<on_action> hooks.
		1717
		1718	=item $term->tt_paste ($octets)
		1719
		1720	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1721	CR and bracketing the data with control sequences if bracketed paste mode
		1722	is set.
1315		1723
1316	=item $old_events = $term->pty_ev_events ([$new_events])	1724	=item $old_events = $term->pty_ev_events ([$new_events])
1317		1725
1318	Replaces the event mask of the pty watcher by the given event mask. Can	1726	Replaces the event mask of the pty watcher by the given event mask. Can
1319	be used to suppress input and output handling to the pty/tty. See the	1727	be used to suppress input and output handling to the pty/tty. See the
…		…
1338	Adds the specified events to the vt event mask. Useful e.g. when you want	1746	Adds the specified events to the vt event mask. Useful e.g. when you want
1339	to receive pointer events all the times:	1747	to receive pointer events all the times:
1340		1748
1341	$term->vt_emask_add (urxvt::PointerMotionMask);	1749	$term->vt_emask_add (urxvt::PointerMotionMask);
1342		1750
		1751	=item $term->set_urgency ($set)
		1752
		1753	Enable/disable the urgency hint on the toplevel window.
		1754
		1755	=item $term->focus_in
		1756
		1757	=item $term->focus_out
		1758
		1759	=item $term->key_press ($state, $keycode[, $time])
		1760
		1761	=item $term->key_release ($state, $keycode[, $time])
		1762
		1763	Deliver various fake events to to terminal.
		1764
1343	=item $window_width = $term->width	1765	=item $window_width = $term->width ([$new_value])
1344		1766
1345	=item $window_height = $term->height	1767	=item $window_height = $term->height ([$new_value])
1346		1768
1347	=item $font_width = $term->fwidth	1769	=item $font_width = $term->fwidth ([$new_value])
1348		1770
1349	=item $font_height = $term->fheight	1771	=item $font_height = $term->fheight ([$new_value])
1350		1772
1351	=item $font_ascent = $term->fbase	1773	=item $font_ascent = $term->fbase ([$new_value])
1352		1774
1353	=item $terminal_rows = $term->nrow	1775	=item $terminal_rows = $term->nrow ([$new_value])
1354		1776
1355	=item $terminal_columns = $term->ncol	1777	=item $terminal_columns = $term->ncol ([$new_value])
1356		1778
1357	=item $has_focus = $term->focus	1779	=item $has_focus = $term->focus ([$new_value])
1358		1780
1359	=item $is_mapped = $term->mapped	1781	=item $is_mapped = $term->mapped ([$new_value])
1360		1782
1361	=item $max_scrollback = $term->saveLines	1783	=item $max_scrollback = $term->saveLines ([$new_value])
1362		1784
1363	=item $nrow_plus_saveLines = $term->total_rows	1785	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1364		1786
1365	=item $topmost_scrollback_row = $term->top_row	1787	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1366		1788
1367	Return various integers describing terminal characteristics.	1789	Return various integers describing terminal characteristics. If an
		1790	argument is given, changes the value and returns the previous one.
1368		1791
1369	=item $x_display = $term->display_id	1792	=item $x_display = $term->display_id
1370		1793
1371	Return the DISPLAY used by rxvt-unicode.	1794	Return the DISPLAY used by rxvt-unicode.
1372		1795
…		…
1377	=item $env = $term->env	1800	=item $env = $term->env
1378		1801
1379	Returns a copy of the environment in effect for the terminal as a hashref	1802	Returns a copy of the environment in effect for the terminal as a hashref
1380	similar to C<\%ENV>.	1803	similar to C<\%ENV>.
1381		1804
		1805	=item @envv = $term->envv
		1806
		1807	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1808
		1809	=item @argv = $term->argv
		1810
		1811	Return the argument vector as this terminal, similar to @ARGV, but
		1812	includes the program name as first element.
		1813
1382	=cut	1814	=cut
1383		1815
1384	sub env {	1816	sub env {
1385	if (my $env = $_[0]->_env) {
1386	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1817	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1387	} else {
1388	+{ %ENV }
1389	}
1390	}	1818	}
1391		1819
1392	=item $modifiermask = $term->ModLevel3Mask	1820	=item $modifiermask = $term->ModLevel3Mask
1393		1821
1394	=item $modifiermask = $term->ModMetaMask	1822	=item $modifiermask = $term->ModMetaMask
…		…
1402		1830
1403	Returns the currently displayed screen (0 primary, 1 secondary).	1831	Returns the currently displayed screen (0 primary, 1 secondary).
1404		1832
1405	=item $cursor_is_hidden = $term->hidden_cursor	1833	=item $cursor_is_hidden = $term->hidden_cursor
1406		1834
1407	Returns wether the cursor is currently hidden or not.	1835	Returns whether the cursor is currently hidden or not.
		1836
		1837	=item $priv_modes = $term->priv_modes
		1838
		1839	Returns a bitset with the state of DEC private modes.
		1840
		1841	Example:
		1842
		1843	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1844	# mouse reporting is turned on
		1845	}
1408		1846
1409	=item $view_start = $term->view_start ([$newvalue])	1847	=item $view_start = $term->view_start ([$newvalue])
1410		1848
1411	Returns the row number of the topmost displayed line. Maximum value is	1849	Returns the row number of the topmost displayed line and changes it,
1412	C<0>, which displays the normal terminal contents. Lower values scroll	1850	if an argument is given. Values greater than or equal to C<0> display
1413	this many lines into the scrollback buffer.	1851	the terminal contents. Lower values scroll this many lines into the
		1852	scrollback buffer.
1414		1853
1415	=item $term->want_refresh	1854	=item $term->want_refresh
1416		1855
1417	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1856	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1418	compare the on-screen display with its stored representation. If they	1857	compare the on-screen display with its stored representation. If they
1419	differ, it redraws the differences.	1858	differ, it redraws the differences.
1420		1859
1421	Used after changing terminal contents to display them.	1860	Used after changing terminal contents to display them.
1422		1861
		1862	=item $term->refresh_check
		1863
		1864	Checks if a refresh has been requested and, if so, schedules one.
		1865
1423	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1866	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1424		1867
1425	Returns the text of the entire row with number C<$row_number>. Row C<0>	1868	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1426	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1869	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1427	terminal line. The scrollback buffer starts at line C<-1> and extends to
1428	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1870	terminal line. Nothing will be returned if a nonexistent line
1429	is requested.	1871	is requested.
1430		1872
1431	If C<$new_text> is specified, it will replace characters in the current	1873	If C<$new_text> is specified, it will replace characters in the current
1432	line, starting at column C<$start_col> (default C<0>), which is useful	1874	line, starting at column C<$start_col> (default C<0>), which is useful
1433	to replace only parts of a line. The font index in the rendition will	1875	to replace only parts of a line. The font index in the rendition will
1434	automatically be updated.	1876	automatically be updated.
1435		1877
1436	C<$text> is in a special encoding: tabs and wide characters that use more	1878	C<$text> is in a special encoding: tabs and wide characters that use more
1437	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1879	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1438	characters. Characters with combining characters and other characters that	1880	characters. Characters with combining characters and other characters that
1439	do not fit into the normal tetx encoding will be replaced with characters	1881	do not fit into the normal text encoding will be replaced with characters
1440	in the private use area.	1882	in the private use area.
1441		1883
1442	You have to obey this encoding when changing text. The advantage is	1884	You have to obey this encoding when changing text. The advantage is
1443	that C<substr> and similar functions work on screen cells and not on	1885	that C<substr> and similar functions work on screen cells and not on
1444	characters.	1886	characters.
…		…
1473		1915
1474	Create and return a new C<urxvt::line> object that stores information	1916	Create and return a new C<urxvt::line> object that stores information
1475	about the logical line that row C<$row_number> is part of. It supports the	1917	about the logical line that row C<$row_number> is part of. It supports the
1476	following methods:	1918	following methods:
1477		1919
1478	=over 4	1920	=over
1479		1921
1480	=item $text = $line->t ([$new_text])	1922	=item $text = $line->t ([$new_text])
1481		1923
1482	Returns or replaces the full text of the line, similar to C<ROW_t>	1924	Returns or replaces the full text of the line, similar to C<ROW_t>
1483		1925
…		…
1529	}	1971	}
1530		1972
1531	sub urxvt::line::t {	1973	sub urxvt::line::t {
1532	my ($self) = @_;	1974	my ($self) = @_;
1533		1975
1534	if (@_ > 1)	1976	if (@_ > 1) {
1535	{
1536	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1977	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1537	for $self->{beg} .. $self->{end};	1978	for $self->{beg} .. $self->{end};
1538	}	1979	}
1539		1980
1540	defined wantarray &&	1981	defined wantarray &&
1541	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1982	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1542	0, $self->{len}	1983	0, $self->{len}
1543	}	1984	}
1544		1985
1545	sub urxvt::line::r {	1986	sub urxvt::line::r {
1546	my ($self) = @_;	1987	my ($self) = @_;
1547		1988
1548	if (@_ > 1)	1989	if (@_ > 1) {
1549	{
1550	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1990	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1551	for $self->{beg} .. $self->{end};	1991	for $self->{beg} .. $self->{end};
1552	}	1992	}
1553		1993
1554	if (defined wantarray) {	1994	if (defined wantarray) {
1555	my $rend = [	1995	my $rend = [
1556	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1996	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1557	];	1997	];
…		…
1581	$offset / $self->{ncol} + $self->{beg},	2021	$offset / $self->{ncol} + $self->{beg},
1582	$offset % $self->{ncol}	2022	$offset % $self->{ncol}
1583	)	2023	)
1584	}	2024	}
1585		2025
1586	=item $text = $term->special_encode $string	2026	=item $text = $term->special_encode ($string)
1587		2027
1588	Converts a perl string into the special encoding used by rxvt-unicode,	2028	Converts a perl string into the special encoding used by rxvt-unicode,
1589	where one character corresponds to one screen cell. See	2029	where one character corresponds to one screen cell. See
1590	C<< $term->ROW_t >> for details.	2030	C<< $term->ROW_t >> for details.
1591		2031
1592	=item $string = $term->special_decode $text	2032	=item $string = $term->special_decode ($text)
1593		2033
1594	Converts rxvt-unicodes text reprsentation into a perl string. See	2034	Converts rxvt-unicode's text representation into a perl string. See
1595	C<< $term->ROW_t >> for details.	2035	C<< $term->ROW_t >> for details.
1596		2036
1597	=item $success = $term->grab_button ($button, $modifiermask)	2037	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1598		2038
		2039	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2040
1599	Registers a synchronous button grab. See the XGrabButton manpage.	2041	Register/unregister a synchronous button grab. See the XGrabButton
		2042	manpage.
1600		2043
1601	=item $success = $term->grab ($eventtime[, $sync])	2044	=item $success = $term->grab ($eventtime[, $sync])
1602		2045
1603	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2046	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1604	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2047	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1605		2048
1606	=item $term->allow_events_async	2049	=item $term->allow_events_async
1607		2050
1608	Calls XAllowEvents with AsyncBoth for the most recent grab.	2051	Calls XAllowEvents with AsyncBoth for the most recent grab.
1609		2052
…		…
1616	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2059	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1617	recent grab.	2060	recent grab.
1618		2061
1619	=item $term->ungrab	2062	=item $term->ungrab
1620		2063
1621	Calls XUngrab for the most recent grab. Is called automatically on	2064	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1622	evaluation errors, as it is better to lose the grab in the error case as	2065	evaluation errors, as it is better to lose the grab in the error case as
1623	the session.	2066	the session.
1624		2067
1625	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2068	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1626		2069
…		…
1628		2071
1629	=item @atoms = $term->XListProperties ($window)	2072	=item @atoms = $term->XListProperties ($window)
1630		2073
1631	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2074	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1632		2075
1633	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2076	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1634		2077
1635	=item $term->XDeleteProperty ($window, $property)	2078	=item $term->XDeleteProperty ($window, $property)
1636		2079
1637	=item $window = $term->DefaultRootWindow	2080	=item $window = $term->DefaultRootWindow
1638		2081
…		…
1645	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2088	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1646		2089
1647	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2090	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1648		2091
1649	=item $term->XChangeInput ($window, $add_events[, $del_events])	2092	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2093
		2094	=item $keysym = $term->XStringToKeysym ($string)
		2095
		2096	=item $string = $term->XKeysymToString ($keysym)
1650		2097
1651	Various X or X-related functions. The C<$term> object only serves as	2098	Various X or X-related functions. The C<$term> object only serves as
1652	the source of the display, otherwise those functions map more-or-less	2099	the source of the display, otherwise those functions map more-or-less
1653	directory onto the X functions of the same name.	2100	directly onto the X functions of the same name.
1654		2101
1655	=back	2102	=back
1656		2103
1657	=cut	2104	=cut
1658		2105
1659	package urxvt::popup;	2106	package urxvt::popup;
1660		2107
1661	=head2 The C<urxvt::popup> Class	2108	=head2 The C<urxvt::popup> Class
1662		2109
1663	=over 4	2110	=over
1664		2111
1665	=cut	2112	=cut
1666		2113
1667	sub add_item {	2114	sub add_item {
1668	my ($self, $item) = @_;	2115	my ($self, $item) = @_;
…		…
1722	my ($self, $text, $cb) = @_;	2169	my ($self, $text, $cb) = @_;
1723		2170
1724	$self->add_item ({ type => "button", text => $text, activate => $cb});	2171	$self->add_item ({ type => "button", text => $text, activate => $cb});
1725	}	2172	}
1726		2173
1727	=item $popup->add_toggle ($text, $cb, $initial_value)	2174	=item $popup->add_toggle ($text, $initial_value, $cb)
1728		2175
1729	Adds a toggle/checkbox item to the popup. Teh callback gets called	2176	Adds a toggle/checkbox item to the popup. The callback gets called
1730	whenever it gets toggled, with a boolean indicating its value as its first	2177	whenever it gets toggled, with a boolean indicating its new value as its
1731	argument.	2178	first argument.
1732		2179
1733	=cut	2180	=cut
1734		2181
1735	sub add_toggle {	2182	sub add_toggle {
1736	my ($self, $text, $cb, $value) = @_;	2183	my ($self, $text, $value, $cb) = @_;
1737		2184
1738	my $item; $item = {	2185	my $item; $item = {
1739	type => "button",	2186	type => "button",
1740	text => " $text",	2187	text => " $text",
1741	value => $value,	2188	value => $value,
…		…
1760	my $env = $self->{term}->env;	2207	my $env = $self->{term}->env;
1761	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2208	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1762	delete $env->{LC_ALL};	2209	delete $env->{LC_ALL};
1763	$env->{LC_CTYPE} = $self->{term}->locale;	2210	$env->{LC_CTYPE} = $self->{term}->locale;
1764		2211
1765	urxvt::term->new ($env, "popup",	2212	my $term = urxvt::term->new (
		2213	$env, "popup",
1766	"--perl-lib" => "", "--perl-ext-common" => "",	2214	"--perl-lib" => "", "--perl-ext-common" => "",
1767	"-pty-fd" => -1, "-sl" => 0,	2215	"-pty-fd" => -1, "-sl" => 0,
1768	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2216	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1769	"--transient-for" => $self->{term}->parent,	2217	"--transient-for" => $self->{term}->parent,
1770	"-display" => $self->{term}->display_id,	2218	"-display" => $self->{term}->display_id,
1771	"-pe" => "urxvt-popup")	2219	"-pe" => "urxvt-popup",
1772	or die "unable to create popup window\n";	2220	) or die "unable to create popup window\n";
		2221
		2222	unless (delete $term->{urxvt_popup_init_done}) {
		2223	$term->ungrab;
		2224	$term->destroy;
		2225	die "unable to initialise popup window\n";
		2226	}
1773	}	2227	}
1774		2228
1775	sub DESTROY {	2229	sub DESTROY {
1776	my ($self) = @_;	2230	my ($self) = @_;
1777		2231
…		…
1782	=back	2236	=back
1783		2237
1784	=cut	2238	=cut
1785		2239
1786	package urxvt::watcher;	2240	package urxvt::watcher;
1787
1788	@urxvt::timer::ISA = __PACKAGE__;
1789	@urxvt::iow::ISA = __PACKAGE__;
1790	@urxvt::pw::ISA = __PACKAGE__;
1791	@urxvt::iw::ISA = __PACKAGE__;
1792		2241
1793	=head2 The C<urxvt::timer> Class	2242	=head2 The C<urxvt::timer> Class
1794		2243
1795	This class implements timer watchers/events. Time is represented as a	2244	This class implements timer watchers/events. Time is represented as a
1796	fractional number of seconds since the epoch. Example:	2245	fractional number of seconds since the epoch. Example:
…		…
1800	->new	2249	->new
1801	->interval (1)	2250	->interval (1)
1802	->cb (sub {	2251	->cb (sub {
1803	$term->{overlay}->set (0, 0,	2252	$term->{overlay}->set (0, 0,
1804	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2253	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1805	});	2254	});
1806		2255
1807	=over 4	2256	=over
1808		2257
1809	=item $timer = new urxvt::timer	2258	=item $timer = new urxvt::timer
1810		2259
1811	Create a new timer object in started state. It is scheduled to fire	2260	Create a new timer object in started state. It is scheduled to fire
1812	immediately.	2261	immediately.
1813		2262
1814	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2263	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1815		2264
1816	Set the callback to be called when the timer triggers.	2265	Set the callback to be called when the timer triggers.
1817		2266
1818	=item $tstamp = $timer->at
1819
1820	Return the time this watcher will fire next.
1821
1822	=item $timer = $timer->set ($tstamp)	2267	=item $timer = $timer->set ($tstamp[, $interval])
1823		2268
1824	Set the time the event is generated to $tstamp.	2269	Set the time the event is generated to $tstamp (and optionally specifies a
		2270	new $interval).
1825		2271
1826	=item $timer = $timer->interval ($interval)	2272	=item $timer = $timer->interval ($interval)
1827		2273
1828	Normally (and when C<$interval> is C<0>), the timer will automatically	2274	By default (and when C<$interval> is C<0>), the timer will automatically
1829	stop after it has fired once. If C<$interval> is non-zero, then the timer	2275	stop after it has fired once. If C<$interval> is non-zero, then the timer
1830	is automatically rescheduled at the given intervals.	2276	is automatically rescheduled at the given intervals.
1831		2277
1832	=item $timer = $timer->start	2278	=item $timer = $timer->start
1833		2279
1834	Start the timer.	2280	Start the timer.
1835		2281
1836	=item $timer = $timer->start ($tstamp)	2282	=item $timer = $timer->start ($tstamp[, $interval])
1837		2283
1838	Set the event trigger time to C<$tstamp> and start the timer.	2284	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2285	also replaces the interval.
1839		2286
1840	=item $timer = $timer->after ($delay)	2287	=item $timer = $timer->after ($delay[, $interval])
1841		2288
1842	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2289	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1843		2290
1844	=item $timer = $timer->stop	2291	=item $timer = $timer->stop
1845		2292
…		…
1853		2300
1854	$term->{socket} = ...	2301	$term->{socket} = ...
1855	$term->{iow} = urxvt::iow	2302	$term->{iow} = urxvt::iow
1856	->new	2303	->new
1857	->fd (fileno $term->{socket})	2304	->fd (fileno $term->{socket})
1858	->events (urxvt::EVENT_READ)	2305	->events (urxvt::EV_READ)
1859	->start	2306	->start
1860	->cb (sub {	2307	->cb (sub {
1861	my ($iow, $revents) = @_;	2308	my ($iow, $revents) = @_;
1862	# $revents must be 1 here, no need to check	2309	# $revents must be 1 here, no need to check
1863	sysread $term->{socket}, my $buf, 8192	2310	sysread $term->{socket}, my $buf, 8192
1864	or end-of-file;	2311	or end-of-file;
1865	});	2312	});
1866		2313
1867		2314
1868	=over 4	2315	=over
1869		2316
1870	=item $iow = new urxvt::iow	2317	=item $iow = new urxvt::iow
1871		2318
1872	Create a new io watcher object in stopped state.	2319	Create a new io watcher object in stopped state.
1873		2320
…		…
1876	Set the callback to be called when io events are triggered. C<$reventmask>	2323	Set the callback to be called when io events are triggered. C<$reventmask>
1877	is a bitset as described in the C<events> method.	2324	is a bitset as described in the C<events> method.
1878		2325
1879	=item $iow = $iow->fd ($fd)	2326	=item $iow = $iow->fd ($fd)
1880		2327
1881	Set the filedescriptor (not handle) to watch.	2328	Set the file descriptor (not handle) to watch.
1882		2329
1883	=item $iow = $iow->events ($eventmask)	2330	=item $iow = $iow->events ($eventmask)
1884		2331
1885	Set the event mask to watch. The only allowed values are	2332	Set the event mask to watch. The only allowed values are
1886	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2333	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1887	together, or C<urxvt::EVENT_NONE>.	2334	together, or C<urxvt::EV_NONE>.
1888		2335
1889	=item $iow = $iow->start	2336	=item $iow = $iow->start
1890		2337
1891	Start watching for requested events on the given handle.	2338	Start watching for requested events on the given handle.
1892		2339
1893	=item $iow = $iow->stop	2340	=item $iow = $iow->stop
1894		2341
1895	Stop watching for events on the given filehandle.	2342	Stop watching for events on the given file handle.
1896		2343
1897	=back	2344	=back
1898		2345
1899	=head2 The C<urxvt::iw> Class	2346	=head2 The C<urxvt::iw> Class
1900		2347
1901	This class implements idle watchers, that get called automatically when	2348	This class implements idle watchers, that get called automatically when
1902	the process is idle. They should return as fast as possible, after doing	2349	the process is idle. They should return as fast as possible, after doing
1903	some useful work.	2350	some useful work.
1904		2351
1905	=over 4	2352	=over
1906		2353
1907	=item $iw = new urxvt::iw	2354	=item $iw = new urxvt::iw
1908		2355
1909	Create a new idle watcher object in stopped state.	2356	Create a new idle watcher object in stopped state.
1910		2357
…		…
1933	->new	2380	->new
1934	->start ($pid)	2381	->start ($pid)
1935	->cb (sub {	2382	->cb (sub {
1936	my ($pw, $exit_status) = @_;	2383	my ($pw, $exit_status) = @_;
1937	...	2384	...
1938	});	2385	});
1939		2386
1940	=over 4	2387	=over
1941		2388
1942	=item $pw = new urxvt::pw	2389	=item $pw = new urxvt::pw
1943		2390
1944	Create a new process watcher in stopped state.	2391	Create a new process watcher in stopped state.
1945		2392
…		…
1947		2394
1948	Set the callback to be called when the timer triggers.	2395	Set the callback to be called when the timer triggers.
1949		2396
1950	=item $pw = $timer->start ($pid)	2397	=item $pw = $timer->start ($pid)
1951		2398
1952	Tells the wqtcher to start watching for process C<$pid>.	2399	Tells the watcher to start watching for process C<$pid>.
1953		2400
1954	=item $pw = $pw->stop	2401	=item $pw = $pw->stop
1955		2402
1956	Stop the watcher.	2403	Stop the watcher.
1957		2404
…		…
1962	=head2 URXVT_PERL_VERBOSITY	2409	=head2 URXVT_PERL_VERBOSITY
1963		2410
1964	This variable controls the verbosity level of the perl extension. Higher	2411	This variable controls the verbosity level of the perl extension. Higher
1965	numbers indicate more verbose output.	2412	numbers indicate more verbose output.
1966		2413
1967	=over 4	2414	=over
1968		2415
1969	=item == 0 - fatal messages	2416	=item == 0 - fatal messages only
		2417
		2418	=item >= 2 - general warnings (default level)
1970		2419
1971	=item >= 3 - script loading and management	2420	=item >= 3 - script loading and management
1972		2421
1973	=item >=10 - all called hooks	2422	=item >=10 - all called hooks
1974		2423
1975	=item >=11 - hook reutrn values	2424	=item >=11 - hook return values
1976		2425
1977	=back	2426	=back
1978		2427
1979	=head1 AUTHOR	2428	=head1 AUTHOR
1980		2429
1981	Marc Lehmann <pcg@goof.com>	2430	Marc Lehmann <schmorp@schmorp.de>
1982	http://software.schmorp.de/pkg/rxvt-unicode	2431	http://software.schmorp.de/pkg/rxvt-unicode
1983		2432
1984	=cut	2433	=cut
1985		2434
1986	1	2435	1
		2436
		2437	# vim: sw=3:

Diff Legend

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