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.119 by root, Fri Jan 20 18:59:31 2006 UTC vs.
Revision 1.270 by root, Fri Nov 26 18:49:47 2021 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	You can look at the source of the selection extension to see more
73	interesting uses, such as parsing a line from beginning to end.
74
75	This extension also offers following bindable keyboard commands:
76
77	=over 4
78
79	=item rot13
80
81	Rot-13 the selection when activated. Used via keyboard trigger:
82
83	URxvt.keysym.C-M-r: perl:selection:rot13
84
85	=back
86
87	=item option-popup (enabled by default)
88
89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90	runtime.
91
92	=item selection-popup (enabled by default)
93
94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95	text into various other formats/action (such as uri unescaping, perl
96	evaluation, web-browser starting etc.), depending on content.
97
98	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100	popup is displayed.
101
102	It's sole argument is the popup menu, which can be modified. The selection
103	is in C<$_>, which can be used to decide wether to add something or not.
104	It should either return nothing or a string and a code reference. The
105	string will be used as button text and the code reference will be called
106	when the button gets activated and should transform C<$_>.
107
108	The following will add an entry C<a to b> that transforms all C<a>s in
109	the selection to C<b>s, but only if the selection currently contains any
110	C<a>s:
111
112	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }
114	: ()
115	};
116
117	=item searchable-scrollback<hotkey> (enabled by default)
118
119	Adds regex search functionality to the scrollback buffer, triggered
120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
121	input/output is suspended and a regex is displayed at the bottom of the
122	screen.
123
124	Inputting characters appends them to the regex and continues incremental
125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
127	bottom. C<Escape> leaves search mode and returns to the point where search
128	was started, while C<Enter> or C<Return> stay at the current position and
129	additionally stores the first match in the current line into the primary
130	selection.
131
132	=item selection-autotransform
133
134	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.
136
137	It works by specifying perl snippets (most useful is a single C<s///>
138	operator) that modify C<$_> as resources:
139
140	URxvt.selection-autotransform.0: transform
141	URxvt.selection-autotransform.1: transform
142	...
143
144	For example, the following will transform selections of the form
145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
146	$word>:
147
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150	And this example matches the same,but replaces it with vi-commands you can
151	paste directly into your (vi :) editor:
152
153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155	Of course, this can be modified to suit your needs and your editor :)
156
157	To expand the example above to typical perl error messages ("XXX at
158	FILENAME line YYY."), you need a slightly more elaborate solution:
159
160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163	The first line tells the selection code to treat the unchanging part of
164	every error message as a selection pattern, and the second line transforms
165	the message into vi commands to load the file.
166
167	=item tabbed
168
169	This transforms the terminal into a tabbar with additional terminals, that
170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
172	button per tab.
173
174	Clicking a button will activate that tab. Pressing B<Shift-Left> and
175	B<Shift-Right> will switch to the tab left or right of the current one,
176	while B<Shift-Down> creates a new tab.
177
178	=item mark-urls
179
180	Uses per-line display filtering (C<on_line_update>) to underline urls and
181	make them clickable. When middle-clicked, the program specified in the
182	resource C<urlLauncher> (default C<x-www-browser>) will be started with
183	the URL as first argument.
184
185	=item automove-background
186
187	This is basically a one-line extension that dynamically changes the background pixmap offset
188	to the window position, in effect creating the same effect as pseudo transparency with
189	a custom pixmap. No scaling is supported in this mode. Exmaple:
190
191	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
192
193	=item block-graphics-to-ascii
194
195	A not very useful example of filtering all text output to the terminal,
196	by replacing all line-drawing characters (U+2500 .. U+259F) by a
197	similar-looking ascii character.
198
199	=item digital-clock
200
201	Displays a digital clock using the built-in overlay.
202
203	=item example-refresh-hooks
204
205	Displays a very simple digital clock in the upper right corner of the
206	window. Illustrates overwriting the refresh callbacks to create your own
207	overlays or changes.
208
209	=item selection-pastebin
210
211	This is a little rarely useful extension that Uploads the selection as
212	textfile to a remote site (or does other things). (The implementation is
213	not currently secure for use in a multiuser environment as it writes to
214	F</tmp> directly.).
215
216	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
217	i.e.
218
219	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
220
221	Pressing this combination runs a command with C<%> replaced by the name of
222	the textfile. This command can be set via a resource:
223
224	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
225
226	And the default is likely not useful to anybody but the few people around
227	here :)
228
229	The name of the textfile is the hex encoded md5 sum of the selection, so
230	the same content should lead to the same filename.
231
232	After a successful upload the selection will be replaced by the text given
233	in the C<selection-pastebin-url> resource (again, the % is the placeholder
234	for the filename):
235
236	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
237
238	=back
239		56
240	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
241		58
242	=head2 General API Considerations	59	=head2 General API Considerations
243		60
…		…
253	terminal is destroyed.	70	terminal is destroyed.
254		71
255	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
256	hints on what they mean:	73	hints on what they mean:
257		74
258	=over 4	75	=over
259		76
260	=item $text	77	=item $text
261		78
262	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
263	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.
264		81
265	=item $string	82	=item $string
266		83
267	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
…		…
271	=item $octets	88	=item $octets
272		89
273	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
274	locale-specific way.	91	locale-specific way.
275		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
276	=back	99	=back
277		100
278	=head2 Extension Objects	101	=head2 Extension Objects
279		102
280	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
281	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,
282	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
283	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
284	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
285	use.	109	internal use.
286		110
287	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
288	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
289		113
290	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.
291		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
292	=over 4	128	=over
293		129
294	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
295		131
296	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
297	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.
298		135
299	=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.
300		138
301	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
302	this extension, replacing any previous hook. This is useful when you want	140	comment:
303	to overwrite time-critical hooks only temporarily.
304		141
305	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
306		143
307	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
308		183
309	=back	184	=back
310		185
311	=head2 Hooks	186	=head2 Hooks
312		187
313	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
314	called whenever the relevant event happens.	189	called whenever the relevant event happens.
315		190
316	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
317	the in the C<Extension Objects> section.	192	the in the C<Extension Objects> section.
318		193
319	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
320	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
321	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
322		197
323	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
324		199
325	=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.
326		213
327	=item on_init $term	214	=item on_init $term
328		215
329	Called after a new terminal object has been initialized, but before	216	Called after a new terminal object has been initialized, but before
330	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
…		…
334	place.	221	place.
335		222
336	=item on_start $term	223	=item on_start $term
337		224
338	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
339	trying to map (display) the toplevel and returning to the mainloop.	226	trying to map (display) the toplevel and returning to the main loop.
340		227
341	=item on_destroy $term	228	=item on_destroy $term
342		229
343	Called whenever something tries to destroy terminal, before doing anything	230	Called whenever something tries to destroy terminal, when the terminal is
344	yet. If this hook returns true, then destruction is skipped, but this is	231	still fully functional (not for long, though).
345	rarely a good idea.
346		232
347	=item on_reset $term	233	=item on_reset $term
348		234
349	Called after the screen is "reset" for any reason, such as resizing or	235	Called after the screen is "reset" for any reason, such as resizing or
350	control sequences. Here is where you can react on changes to size-related	236	control sequences. Here is where you can react on changes to size-related
…		…
372		258
373	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
374	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
375	by calling C<< $term->selection >>.	261	by calling C<< $term->selection >>.
376		262
377	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.
378		264
379	=item on_sel_extend $term	265	=item on_sel_extend $term
380		266
381	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
382	click) and is either supposed to return false (normal operation), or	268	click) and is either supposed to return false (normal operation), or
383	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
384	processing. This can happen multiple times, as long as the callback	270	processing. This can happen multiple times, as long as the callback
385	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
386	supposed to enlarge the selection more and more, if possible.	272	supposed to enlarge the selection more and more, if possible.
387		273
388	See the F<selection> example extension.	274	See the F<selection> example extension.
389		275
390	=item on_view_change $term, $offset	276	=item on_view_change $term, $offset
391		277
392	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
393	scrolls. Offset C<0> means display the normal terminal, positive values	279	scrolls. Offset C<0> means display the normal terminal, positive values
394	show this many lines of scrollback.	280	show this many lines of scrollback.
395		281
396	=item on_scroll_back $term, $lines, $saved	282	=item on_scroll_back $term, $lines, $saved
397		283
…		…
401		287
402	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,
403	$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
404	number of lines that will be in the scrollback buffer.	290	number of lines that will be in the scrollback buffer.
405		291
406	=item on_osc_seq $term, $string	292	=item on_osc_seq $term, $op, $args, $resp
407		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
408	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	304	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
409	operating system command) is processed. Cursor position and other state	305	(OSC = operating system command) is processed. Cursor position and other
410	information is up-to-date when this happens. For interoperability, the	306	state information is up-to-date when this happens. For interoperability,
411	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
412	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
413	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	}
414		320
415	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,
416	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
417	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.
418		327
419	=item on_add_lines $term, $string	328	=item on_add_lines $term, $string
420		329
421	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
422	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
…		…
427	=item on_tt_write $term, $octets	336	=item on_tt_write $term, $octets
428		337
429	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
430	suppress or filter tty input.	339	suppress or filter tty input.
431		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
432	=item on_line_update $term, $row	348	=item on_line_update $term, $row
433		349
434	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
435	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
436	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,
…		…
443	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
444	you cannot just toggle rendition bits, but only set them.	360	you cannot just toggle rendition bits, but only set them.
445		361
446	=item on_refresh_begin $term	362	=item on_refresh_begin $term
447		363
448	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
449	or similar effects by modify terminal contents in refresh_begin, and	365	similar effects by modifying the terminal contents in refresh_begin, and
450	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
451	code is run after this hook, and takes precedence.	367	code is run after this hook, and takes precedence.
452		368
453	=item on_refresh_end $term	369	=item on_refresh_end $term
454		370
455	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>.
456		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
457	=item on_keyboard_command $term, $string	381	=item on_user_command $term, $string *DEPRECATED*
458		382
459	Called whenever the user presses a key combination that has a	383	Called whenever a user-configured event is being activated (e.g. via
460	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>
461	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.
462		395
463	=item on_x_event $term, $event	396	=item on_x_event $term, $event
464		397
465	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
466	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
467	members are not passed.	400	members are not passed.
468		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
469	=item on_focus_in $term	406	=item on_focus_in $term
470		407
471	Called whenever the window gets the keyboard focus, before rxvt-unicode	408	Called whenever the window gets the keyboard focus, before rxvt-unicode
472	does focus in processing.	409	does focus in processing.
473		410
474	=item on_focus_out $term	411	=item on_focus_out $term
475		412
476	Called wheneever the window loses keyboard focus, before rxvt-unicode does	413	Called whenever the window loses keyboard focus, before rxvt-unicode does
477	focus out processing.	414	focus out processing.
478		415
479	=item on_configure_notify $term, $event	416	=item on_configure_notify $term, $event
480		417
481	=item on_property_notify $term, $event	418	=item on_property_notify $term, $event
…		…
492		429
493	=item on_map_notify $term, $event	430	=item on_map_notify $term, $event
494		431
495	=item on_unmap_notify $term, $event	432	=item on_unmap_notify $term, $event
496		433
497	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
498	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.
499		436
500	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
501	manpage), with the additional members C<row> and C<col>, which are the row	438	manpage), with the additional members C<row> and C<col>, which are the
502	and column under the mouse cursor.	439	(real, not screen-based) row and column under the mouse cursor.
503		440
504	C<on_key_press> additionally receives the string rxvt-unicode would	441	C<on_key_press> additionally receives the string rxvt-unicode would
505	output, if any, in locale-specific encoding.	442	output, if any, in locale-specific encoding.
506		443
507	subwindow.
508
509	=item on_client_message $term, $event	444	=item on_client_message $term, $event
510		445
511	=item on_wm_protocols $term, $event	446	=item on_wm_protocols $term, $event
512		447
513	=item on_wm_delete_window $term, $event	448	=item on_wm_delete_window $term, $event
514		449
515	Called when various types of ClientMessage events are received (all with	450	Called when various types of ClientMessage events are received (all with
516	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	451	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
517		452
		453	=item on_bell $term
		454
		455	Called on receipt of a bell character.
		456
518	=back	457	=back
519		458
520	=cut	459	=cut
521		460
522	package urxvt;	461	package urxvt;
523		462
524	use utf8;	463	use utf8;
525	use strict;	464	use strict qw(vars subs);
526	use Carp ();	465	use Carp ();
527	use Scalar::Util ();	466	use Scalar::Util ();
528	use List::Util ();	467	use List::Util ();
529		468
530	our $VERSION = 1;	469	our $VERSION = 1;
531	our $TERM;	470	our $TERM;
532	our @TERM_INIT;	471	our @TERM_INIT; # should go, prevents async I/O etc.
533	our @TERM_EXT;	472	our @TERM_EXT; # should go, prevents async I/O etc.
534	our @HOOKNAME;	473	our @HOOKNAME;
535	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	474	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
536	our %OPTION;	475	our %OPTION;
537		476
538	our $LIBDIR;	477	our $LIBDIR;
539	our $RESNAME;	478	our $RESNAME;
540	our $RESCLASS;	479	our $RESCLASS;
541	our $RXVTNAME;	480	our $RXVTNAME;
542		481
		482	our $NOCHAR = chr 0xffff;
		483
543	=head2 Variables in the C<urxvt> Package	484	=head2 Variables in the C<urxvt> Package
544		485
545	=over 4	486	=over
546		487
547	=item $urxvt::LIBDIR	488	=item $urxvt::LIBDIR
548		489
549	The rxvt-unicode library directory, where, among other things, the perl	490	The rxvt-unicode library directory, where, among other things, the perl
550	modules and scripts are stored.	491	modules and scripts are stored.
…		…
562	The current terminal. This variable stores the current C<urxvt::term>	503	The current terminal. This variable stores the current C<urxvt::term>
563	object, whenever a callback/hook is executing.	504	object, whenever a callback/hook is executing.
564		505
565	=item @urxvt::TERM_INIT	506	=item @urxvt::TERM_INIT
566		507
567	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
568	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
569	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,
570	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.
571		512
572	This complements to the perl-eval commandline option, but gets executed	513	This complements to the perl-eval command line option, but gets executed
573	first.	514	first.
574		515
575	=item @urxvt::TERM_EXT	516	=item @urxvt::TERM_EXT
576		517
577	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
…		…
580		521
581	=back	522	=back
582		523
583	=head2 Functions in the C<urxvt> Package	524	=head2 Functions in the C<urxvt> Package
584		525
585	=over 4	526	=over
586		527
587	=item urxvt::fatal $errormessage	528	=item urxvt::fatal $errormessage
588		529
589	Fatally aborts execution with the given error message. Avoid at all	530	Fatally aborts execution with the given error message (which should
590	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
591	starts up.	532	is acceptable (and useful) is in the init hook, where it prevents the
		533	terminal from starting up.
592		534
593	=item urxvt::warn $string	535	=item urxvt::warn $string
594		536
595	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
596	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
597	that calls this function.	539	that calls this function.
598		540
599	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
600	correct place, e.g. on stderr of the connecting urxvtc client.	542	correct place, e.g. on stderr of the connecting urxvtc client.
601		543
602	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).
603		552
604	=item $time = urxvt::NOW	553	=item $time = urxvt::NOW
605		554
606	Returns the "current time" (as per the event loop).	555	Returns the "current time" (as per the event loop).
607		556
…		…
627	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	576	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
628	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	577	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
629		578
630	Various constants for use in X calls and event processing.	579	Various constants for use in X calls and event processing.
631		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
632	=back	593	=back
633		594
634	=head2 RENDITION	595	=head2 RENDITION
635		596
636	Rendition bitsets contain information about colour, font, font styles and	597	Rendition bitsets contain information about colour, font, font styles and
…		…
639	The following "macros" deal with changes in rendition sets. You should	600	The following "macros" deal with changes in rendition sets. You should
640	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,
641	as they contain important information required for correct operation of	602	as they contain important information required for correct operation of
642	rxvt-unicode.	603	rxvt-unicode.
643		604
644	=over 4	605	=over
645		606
646	=item $rend = urxvt::DEFAULT_RSTYLE	607	=item $rend = urxvt::DEFAULT_RSTYLE
647		608
648	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
649	being reset. Useful as a base to start when creating renditions.	610	being reset. Useful as a base to start when creating renditions.
650		611
651	=item $rend = urxvt::OVERLAY_RSTYLE	612	=item $rend = urxvt::OVERLAY_RSTYLE
652		613
653	Return the rendition mask used for overlays by default.	614	Return the rendition mask used for overlays by default.
654		615
655	=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
656		618
657	Return the bit that enabled bold, italic, blink, reverse-video and	619	Return the bit that enabled bold, italic, blink, reverse-video and
658	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
659	the bitset.	621	the bitset.
660		622
…		…
665	Return the foreground/background colour index, respectively.	627	Return the foreground/background colour index, respectively.
666		628
667	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	629	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
668		630
669	=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
670		634
671	Replace the foreground/background colour in the rendition mask with the	635	Replace the foreground/background colour in the rendition mask with the
672	specified one.	636	specified one.
673		637
674	=item $value = urxvt::GET_CUSTOM $rend	638	=item $value = urxvt::GET_CUSTOM $rend
…		…
693	unless $msg =~ /\n$/;	657	unless $msg =~ /\n$/;
694	urxvt::warn ($msg);	658	urxvt::warn ($msg);
695	};	659	};
696	}	660	}
697		661
		662	no warnings 'utf8';
		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
698	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	730	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
699		731
700	sub verbose {	732	sub verbose {
701	my ($level, $msg) = @_;	733	my ($level, $msg) = @_;
702	warn "$msg\n" if $level <= $verbosity;	734	warn "$msg\n" if $level <= $verbosity;
703	}	735	}
…		…
714	$pkg =~ s/[^[:word:]]/_/g;	746	$pkg =~ s/[^[:word:]]/_/g;
715	$pkg = "urxvt::ext::$pkg";	747	$pkg = "urxvt::ext::$pkg";
716		748
717	verbose 3, "loading extension '$path' into package '$pkg'";	749	verbose 3, "loading extension '$path' into package '$pkg'";
718		750
		751	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		752
719	open my $fh, "<:raw", $path	753	open my $fh, "<:raw", $path
720	or die "$path: $!";	754	or die "$path: $!";
721		755
722	my $source =	756	my $source =
723	"package $pkg; use strict; use utf8;\n"	757	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
724	. "#line 1 \"$path\"\n{\n"	758	. "#line 1 \"$path\"\n{\n"
725	. (do { local $/; <$fh> })	759	. (do { local $/; <$fh> })
726	. "\n};\n1";	760	. "\n};\n1";
727		761
728	eval $source	762	eval $source
…		…
737	# called by the rxvt core	771	# called by the rxvt core
738	sub invoke {	772	sub invoke {
739	local $TERM = shift;	773	local $TERM = shift;
740	my $htype = shift;	774	my $htype = shift;
741		775
742	if ($htype == 0) { # INIT	776	if ($htype == HOOK_INIT) {
743	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	777	$TERM->scan_extensions;
744		778
745	my %ext_arg;	779	my %ext_arg;
746		780
747	{	781	{
748	my @init = @TERM_INIT;	782	my @init = @TERM_INIT;
749	@TERM_INIT = ();	783	@TERM_INIT = ();
…		…
751	my @pkg = @TERM_EXT;	785	my @pkg = @TERM_EXT;
752	@TERM_EXT = ();	786	@TERM_EXT = ();
753	$TERM->register_package ($_) for @pkg;	787	$TERM->register_package ($_) for @pkg;
754	}	788	}
755		789
		790	for (
		791	@{ delete $TERM->{perl_ext_3} },
756	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	792	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		793	) {
757	if ($_ eq "default") {	794	if ($_ eq "default") {
		795
		796	$ext_arg{$_} = []
758	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	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
759	} elsif (/^-(.*)$/) {	808	} elsif (/^-(.*)$/) { # remove from set
760	delete $ext_arg{$1};	809	delete $ext_arg{$1};
761	} 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};
762	push @{ $ext_arg{$1} }, $2;	816	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		817
763	} else {	818	} else {
764	$ext_arg{$_} ||= [];	819	verbose 2, "cannot parse extension specification '$_', ignoring.";
765	}	820	}
766	}	821	}
767		822
768	while (my ($ext, $argv) = each %ext_arg) {	823	$TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
769	my @files = grep -f $_, map "$_/$ext", @dirs;	824	$TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
770		825
771	if (@files) {	826	for my $ext (sort keys %ext_arg) {
772	$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});
773	} else {	831	} else {
774	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";
775	}	833	}
776	}	834	}
777		835
778	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");
779	warn $@ if $@;	837	warn $@ if $@;
780	}	838	}
781		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
782	$retval = undef;	850	$retval = undef;
783		851
784	if (my $cb = $TERM->{_hook}[$htype]) {	852	if (my $cb = $TERM->{_hook}[$htype]) {
785	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	853	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
786	if $verbosity >= 10;	854	if $verbosity >= 10;
787		855
788	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";
789		862
790	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) {
791	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	870	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
792	$retval ||= $retval_;	871	$retval ||= $retval_;
793		872
794	if ($@) {	873	if ($@) {
795	$TERM->ungrab; # better to lose the grab than the session	874	$TERM->ungrab; # better to lose the grab than the session
796	warn $@;	875	warn $@;
…		…
799		878
800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	879	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
801	if $verbosity >= 11;	880	if $verbosity >= 11;
802	}	881	}
803		882
804	if ($htype == 1) { # DESTROY	883	if ($htype == HOOK_DESTROY) {
805	# clear package objects	884	# clear package objects
806	%$_ = () for values %{ $TERM->{_pkg} };	885	%$_ = () for values %{ $TERM->{_pkg} };
807		886
808	# clear package	887	# clear package
809	%$TERM = ();	888	%$TERM = ();
810	}	889	}
811		890
812	$retval	891	$retval
813	}	892	}
814		893
815	# 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	}
816		922
817	package urxvt::term::extension;	923	package urxvt::term::extension;
818		924
819	sub enable {	925	=head2 The C<urxvt::term::extension> class
820	my ($self, %hook) = @_;
821	my $pkg = $self->{_pkg};
822		926
823	while (my ($name, $cb) = each %hook) {	927	Each extension attached to a terminal object is represented by
824	my $htype = $HOOKTYPE{uc $name};	928	a C<urxvt::term::extension> object.
825	defined $htype
826	or Carp::croak "unsupported hook type '$name'";
827		929
828	$self->set_should_invoke ($htype, +1)	930	You can use these objects, which are passed to all callbacks to store any
829	unless exists $self->{term}{_hook}[$htype]{$pkg};	931	state related to the terminal and extension instance.
830		932
831	$self->{term}{_hook}[$htype]{$pkg} = $cb;	933	The methods (And data members) documented below can be called on extension
832	}	934	objects, in addition to call methods documented for the <urxvt::term>
833	}	935	class.
834		936
835	sub disable {	937	=over
836	my ($self, @hook) = @_;
837	my $pkg = $self->{_pkg};
838		938
839	for my $name (@hook) {	939	=item $urxvt_term = $self->{term}
840	my $htype = $HOOKTYPE{uc $name};
841	defined $htype
842	or Carp::croak "unsupported hook type '$name'";
843		940
844	$self->set_should_invoke ($htype, -1)	941	Returns the C<urxvt::term> object associated with this instance of the
845	if delete $self->{term}{_hook}[$htype]{$pkg};	942	extension. This member I<must not> be changed in any way.
846	}	943
847	}	944	=cut
848		945
849	our $AUTOLOAD;	946	our $AUTOLOAD;
850		947
851	sub AUTOLOAD {	948	sub AUTOLOAD {
852	$AUTOLOAD =~ /:([^:]+)$/	949	$AUTOLOAD =~ /:([^:]+)$/
…		…
865		962
866	sub DESTROY {	963	sub DESTROY {
867	# nop	964	# nop
868	}	965	}
869		966
870	# urxvt::destroy_hook	967	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
871		968
872	sub urxvt::destroy_hook::DESTROY {	969	sub urxvt::destroy_hook::DESTROY {
873	${$_[0]}->();	970	${$_[0]}->();
874	}	971	}
875		972
876	sub urxvt::destroy_hook(&) {	973	sub urxvt::destroy_hook(&) {
877	bless \shift, urxvt::destroy_hook::	974	bless \shift, urxvt::destroy_hook::
878	}	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
879		1099
880	package urxvt::anyevent;	1100	package urxvt::anyevent;
881		1101
882	=head2 The C<urxvt::anyevent> Class	1102	=head2 The C<urxvt::anyevent> Class
883		1103
884	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
885	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
886	further programming. The only exception is that you cannot wait on	1106	further programming. The only exception is that you cannot wait on
887	condition variables, but non-blocking condvar use is ok. What this means	1107	condition variables, but non-blocking condvar use is ok.
888	is that you cannot use blocking APIs, but the non-blocking variant should
889	work.
890		1108
891	=cut	1109	In practical terms this means is that you cannot use blocking APIs, but
		1110	the non-blocking variant should work.
892		1111
		1112	=cut
		1113
893	our $VERSION = 1;	1114	our $VERSION = '5.23';
894		1115
895	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1116	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
896	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1117	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
897		1118
898	sub timer {	1119	sub timer {
…		…
900		1121
901	my $cb = $arg{cb};	1122	my $cb = $arg{cb};
902		1123
903	urxvt::timer	1124	urxvt::timer
904	->new	1125	->new
905	->start (urxvt::NOW + $arg{after})	1126	->after ($arg{after}, $arg{interval})
906	->cb (sub {	1127	->cb ($arg{interval} ? $cb : sub {
907	$_[0]->stop; # need to cancel manually	1128	$_[0]->stop; # need to cancel manually
908	$cb->();	1129	$cb->();
909	})	1130	})
910	}	1131	}
911		1132
912	sub io {	1133	sub io {
913	my ($class, %arg) = @_;	1134	my ($class, %arg) = @_;
914		1135
915	my $cb = $arg{cb};	1136	my $cb = $arg{cb};
		1137	my $fd = fileno $arg{fh};
		1138	defined $fd or $fd = $arg{fh};
916		1139
917	bless [$arg{fh}, urxvt::iow	1140	bless [$arg{fh}, urxvt::iow
918	->new	1141	->new
919	->fd (fileno $arg{fh})	1142	->fd ($fd)
920	->events (($arg{poll} =~ /r/ ? 1 : 0)	1143	->events (($arg{poll} =~ /r/ ? 1 : 0)
921	| ($arg{poll} =~ /w/ ? 2 : 0))	1144	| ($arg{poll} =~ /w/ ? 2 : 0))
922	->start	1145	->start
923	->cb (sub {	1146	->cb ($cb)
924	$cb->(($_[1] & 1 ? 'r' : '')
925	. ($_[1] & 2 ? 'w' : ''));
926	})],
927	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	})
928	}	1173	}
929		1174
930	sub DESTROY {	1175	sub DESTROY {
931	$_[0][1]->stop;	1176	$_[0][1]->stop;
932	}	1177	}
933		1178
934	sub condvar {	1179	# only needed for AnyEvent < 6 compatibility
935	bless \my $flag, urxvt::anyevent::condvar::	1180	sub one_event {
936	}
937
938	sub urxvt::anyevent::condvar::broadcast {
939	${$_[0]}++;
940	}
941
942	sub urxvt::anyevent::condvar::wait {
943	unless (${$_[0]}) {
944	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";
945	}
946	}	1182	}
947		1183
948	package urxvt::term;	1184	package urxvt::term;
949		1185
950	=head2 The C<urxvt::term> Class	1186	=head2 The C<urxvt::term> Class
951		1187
952	=over 4	1188	=over
953		1189
954	=cut	1190	=cut
955		1191
956	# find on_xxx subs in the package and register them	1192	# find on_xxx subs in the package and register them
957	# as hooks	1193	# as hooks
958	sub register_package {	1194	sub register_package {
959	my ($self, $pkg, $argv) = @_;	1195	my ($self, $pkg, $argv) = @_;
960		1196
		1197	return if $self->{_pkg}{$pkg};
		1198
961	no strict 'refs';	1199	no strict 'refs';
962		1200
963	urxvt::verbose 6, "register package $pkg to $self";	1201	urxvt::verbose 6, "register package $pkg to $self";
964		1202
965	@{"$pkg\::ISA"} = urxvt::term::extension::;	1203	@{"$pkg\::ISA"} = urxvt::term::extension::;
966		1204
967	my $proxy = bless {	1205	my $proxy = bless {
968	_pkg => $pkg,	1206	_pkg => $pkg,
		1207	_name => ${"$pkg\::_NAME"}, # hackish
969	argv => $argv,	1208	argv => $argv,
970	}, $pkg;	1209	}, $pkg;
971	Scalar::Util::weaken ($proxy->{term} = $self);	1210	Scalar::Util::weaken ($proxy->{term} = $self);
972		1211
973	$self->{_pkg}{$pkg} = $proxy;	1212	$self->{_pkg}{$pkg} = $proxy;
974		1213
975	for my $name (@HOOKNAME) {	1214	for my $name (@HOOKNAME) {
976	if (my $ref = $pkg->can ("on_" . lc $name)) {	1215	if (my $ref = $pkg->can ("on_" . lc $name)) {
977	$proxy->enable ($name => $ref);	1216	$proxy->enable ($name => $ref);
978	}	1217	}
979	}	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	}
980	}	1331	}
981		1332
982	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1333	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
983		1334
984	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
…		…
986	hash which defines the environment of the new terminal.	1337	hash which defines the environment of the new terminal.
987		1338
988	Croaks (and probably outputs an error message) if the new instance	1339	Croaks (and probably outputs an error message) if the new instance
989	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
990	initialise perl, and the terminal object otherwise. The C<init> and	1341	initialise perl, and the terminal object otherwise. The C<init> and
991	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).
992		1344
993	=cut	1345	=cut
994		1346
995	sub new {	1347	sub new {
996	my ($class, $env, @args) = @_;	1348	my ($class, $env, @args) = @_;
997		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
998	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1353	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
999	}	1354	}
1000		1355
1001	=item $term->destroy	1356	=item $term->destroy
1002		1357
1003	Destroy the terminal object (close the window, free resources	1358	Destroy the terminal object (close the window, free resources
1004	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
1005	watchers (timers, io watchers) are still active.	1360	watchers (timers, io watchers) are still active.
1006		1361
1007	=item $term->exec_async ($cmd[, @args])	1362	=item $term->exec_async ($cmd[, @args])
1008		1363
1009	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
…		…
1033		1388
1034	Returns true if the option specified by C<$optval> is enabled, and	1389	Returns true if the option specified by C<$optval> is enabled, and
1035	optionally change it. All option values are stored by name in the hash	1390	optionally change it. All option values are stored by name in the hash
1036	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1391	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1037		1392
1038	Here is a a likely non-exhaustive list of option names, please see the	1393	Here is a likely non-exhaustive list of option names, please see the
1039	source file F</src/optinc.h> to see the actual list:	1394	source file F</src/optinc.h> to see the actual list:
1040		1395
1041	borderLess console cursorBlink cursorUnderline hold iconic insecure	1396	borderLess buffered console cursorBlink cursorUnderline hold iconic
1042	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1397	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1043	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1398	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1044	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1399	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1045	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1400	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1046	transparent tripleclickwords utmpInhibit visualBell	1401	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1402	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1047		1403
1048	=item $value = $term->resource ($name[, $newval])	1404	=item $value = $term->resource ($name[, $newval])
1049		1405
1050	Returns the current resource value associated with a given name and	1406	Returns the current resource value associated with a given name and
1051	optionally sets a new value. Setting values is most useful in the C<init>	1407	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1060	likely change).	1416	likely change).
1061		1417
1062	Please note that resource strings will currently only be freed when the	1418	Please note that resource strings will currently only be freed when the
1063	terminal is destroyed, so changing options frequently will eat memory.	1419	terminal is destroyed, so changing options frequently will eat memory.
1064		1420
1065	Here is a a likely non-exhaustive list of resource names, not all of which	1421	Here is a likely non-exhaustive list of resource names, not all of which
1066	are supported in every build, please see the source file F</src/rsinc.h>	1422	are supported in every build, please see the source file F</src/rsinc.h>
1067	to see the actual list:	1423	to see the actual list:
1068		1424
1069	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1425	answerbackstring backgroundPixmap backspace_key blurradius
1070	borderLess color cursorBlink cursorUnderline cutchars delete_key	1426	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1071	display_name embed ext_bwidth fade font geometry hold iconName	1427	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1072	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1428	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1429	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1073	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1430	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1074	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1431	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1075	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1432	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1076	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1433	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1077	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1434	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1078	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1435	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1079	secondaryScreen secondaryScroll selectstyle shade term_name title	1436	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1080	transient_for transparent transparent_all tripleclickwords utmpInhibit	1437	term_name title transient_for transparent tripleclickwords urgentOnBell
1081	visualBell	1438	utmpInhibit visualBell rewrapMode disablePasteBrackets
1082		1439
1083	=cut	1440	=cut
1084		1441
1085	sub resource($$;$) {	1442	sub resource($$;$) {
1086	my ($self, $name) = (shift, shift);	1443	my ($self, $name) = (shift, shift);
1087	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1444	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1088	&urxvt::term::_resource	1445	goto &urxvt::term::_resource
1089	}	1446	}
1090		1447
1091	=item $value = $term->x_resource ($pattern)	1448	=item $value = $term->x_resource ($pattern)
1092		1449
1093	Returns the X-Resource for the given pattern, excluding the program or	1450	Returns the X-Resource for the given pattern, excluding the program or
1094	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1451	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1095	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1452	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1096	resource with that pattern exists.	1453	resource with that pattern exists.
1097		1454
		1455	Extensions that define extra resources also need to call this method
		1456	to access their values.
		1457
		1458	If the method is called on an extension object (basically, from an
		1459	extension), then the special prefix C<%.> will be replaced by the name of
		1460	the extension and a dot, and the lone string C<%> will be replaced by the
		1461	extension name itself. This makes it possible to code extensions so you
		1462	can rename them and get a new set of resources without having to change
		1463	the actual code.
		1464
1098	This method should only be called during the C<on_start> hook, as there is	1465	This method should only be called during the C<on_start> hook, as there is
1099	only one resource database per display, and later invocations might return	1466	only one resource database per display, and later invocations might return
1100	the wrong resources.	1467	the wrong resources.
1101		1468
1102	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1469	=item $value = $term->x_resource_boolean ($pattern)
1103		1470
		1471	Like C<x_resource>, above, but interprets the string value as a boolean
		1472	and returns C<1> for true values, C<0> for false values and C<undef> if
		1473	the resource or option isn't specified.
		1474
		1475	You should always use this method to parse boolean resources.
		1476
		1477	=cut
		1478
		1479	sub x_resource_boolean {
		1480	my $res = &x_resource;
		1481
		1482	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1483	}
		1484
		1485	=item $action = $term->lookup_keysym ($keysym, $state)
		1486
		1487	Returns the action bound to key combination C<($keysym, $state)>,
		1488	if a binding for it exists, and C<undef> otherwise.
		1489
		1490	=item $success = $term->bind_action ($key, $action)
		1491
1104	Adds a keymap translation exactly as specified via a resource. See the	1492	Adds a key binding exactly as specified via a C<keysym> resource. See the
1105	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1493	C<keysym> resource in the urxvt(1) manpage.
		1494
		1495	To add default bindings for actions, an extension should call C<<
		1496	->bind_action >> in its C<init> hook for every such binding. Doing it
		1497	in the C<init> hook allows users to override or remove the binding
		1498	again.
		1499
		1500	Example: the C<searchable-scrollback> by default binds itself
		1501	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1502	$term->bind_action >>.
		1503
		1504	sub init {
		1505	my ($self) = @_;
		1506
		1507	$self->bind_action ("M-s" => "%:start");
		1508	}
1106		1509
1107	=item $rend = $term->rstyle ([$new_rstyle])	1510	=item $rend = $term->rstyle ([$new_rstyle])
1108		1511
1109	Return and optionally change the current rendition. Text that is output by	1512	Return and optionally change the current rendition. Text that is output by
1110	the terminal application will use this style.	1513	the terminal application will use this style.
…		…
1118		1521
1119	=item ($row, $col) = $term->selection_beg ([$row, $col])	1522	=item ($row, $col) = $term->selection_beg ([$row, $col])
1120		1523
1121	=item ($row, $col) = $term->selection_end ([$row, $col])	1524	=item ($row, $col) = $term->selection_end ([$row, $col])
1122		1525
1123	Return the current values of the selection mark, begin or end positions,	1526	Return the current values of the selection mark, begin or end positions.
1124	and optionally set them to new values.	1527
		1528	When arguments are given, then the selection coordinates are set to
		1529	C<$row> and C<$col>, and the selection screen is set to the current
		1530	screen.
		1531
		1532	=item $screen = $term->selection_screen ([$screen])
		1533
		1534	Returns the current selection screen, and then optionally sets it.
1125		1535
1126	=item $term->selection_make ($eventtime[, $rectangular])	1536	=item $term->selection_make ($eventtime[, $rectangular])
1127		1537
1128	Tries to make a selection as set by C<selection_beg> and	1538	Tries to make a selection as set by C<selection_beg> and
1129	C<selection_end>. If C<$rectangular> is true (default: false), a	1539	C<selection_end>. If C<$rectangular> is true (default: false), a
1130	rectangular selection will be made. This is the prefered function to make	1540	rectangular selection will be made. This is the preferred function to make
1131	a selection.	1541	a selection.
1132		1542
1133	=item $success = $term->selection_grab ($eventtime)	1543	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1134		1544
1135	Try to request the primary selection text from the server (for example, as	1545	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1546	true) selection from the server. The corresponding text can be set
1136	set by the next method). No visual feedback will be given. This function	1547	with the next method. No visual feedback will be given. This function
1137	is mostly useful from within C<on_sel_grab> hooks.	1548	is mostly useful from within C<on_sel_grab> hooks.
1138		1549
1139	=item $oldtext = $term->selection ([$newtext])	1550	=item $oldtext = $term->selection ([$newtext, $clipboard])
1140		1551
1141	Return the current selection text and optionally replace it by C<$newtext>.	1552	Return the current selection (clipboard if C<$clipboard> is true) text
		1553	and optionally replace it by C<$newtext>.
		1554
		1555	=item $term->selection_clear ([$clipboard])
		1556
		1557	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1142		1558
1143	=item $term->overlay_simple ($x, $y, $text)	1559	=item $term->overlay_simple ($x, $y, $text)
1144		1560
1145	Create a simple multi-line overlay box. See the next method for details.	1561	Create a simple multi-line overlay box. See the next method for details.
1146		1562
…		…
1174	This method returns an urxvt::overlay object. The overlay will be visible	1590	This method returns an urxvt::overlay object. The overlay will be visible
1175	as long as the perl object is referenced.	1591	as long as the perl object is referenced.
1176		1592
1177	The methods currently supported on C<urxvt::overlay> objects are:	1593	The methods currently supported on C<urxvt::overlay> objects are:
1178		1594
1179	=over 4	1595	=over
1180		1596
1181	=item $overlay->set ($x, $y, $text, $rend)	1597	=item $overlay->set ($x, $y, $text[, $rend])
1182		1598
1183	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1599	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1184	text in rxvt-unicode's special encoding and an array of rendition values	1600	text in rxvt-unicode's special encoding and an array of rendition values
1185	at a specific position inside the overlay.	1601	at a specific position inside the overlay.
		1602
		1603	If C<$rend> is missing, then the rendition will not be changed.
1186		1604
1187	=item $overlay->hide	1605	=item $overlay->hide
1188		1606
1189	If visible, hide the overlay, but do not destroy it.	1607	If visible, hide the overlay, but do not destroy it.
1190		1608
…		…
1226	Returns the number of screen-cells this string would need. Correctly	1644	Returns the number of screen-cells this string would need. Correctly
1227	accounts for wide and combining characters.	1645	accounts for wide and combining characters.
1228		1646
1229	=item $octets = $term->locale_encode ($string)	1647	=item $octets = $term->locale_encode ($string)
1230		1648
1231	Convert the given text string into the corresponding locale encoding.	1649	Convert the given text string into the corresponding locale
		1650	encoding. Returns C<undef> if C<$string> is C<undef>.
1232		1651
1233	=item $string = $term->locale_decode ($octets)	1652	=item $string = $term->locale_decode ($octets)
1234		1653
1235	Convert the given locale-encoded octets into a perl string.	1654	Convert the given locale-encoded octets into a perl string. Returns
		1655	C<undef> if C<$octets> is C<undef>.
1236		1656
1237	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1657	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1238		1658
1239	XORs the rendition values in the given span with the provided value	1659	XORs the rendition values in the given span with the provided value
1240	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in	1660	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
…		…
1253		1673
1254	=item $term->scr_add_lines ($string)	1674	=item $term->scr_add_lines ($string)
1255		1675
1256	Write the given text string to the screen, as if output by the application	1676	Write the given text string to the screen, as if output by the application
1257	running inside the terminal. It may not contain command sequences (escape	1677	running inside the terminal. It may not contain command sequences (escape
1258	codes), but is free to use line feeds, carriage returns and tabs. The	1678	codes - see C<cmd_parse> for that), but is free to use line feeds,
1259	string is a normal text string, not in locale-dependent encoding.	1679	carriage returns and tabs. The string is a normal text string, not in
		1680	locale-dependent encoding.
1260		1681
1261	Normally its not a good idea to use this function, as programs might be	1682	Normally its not a good idea to use this function, as programs might be
1262	confused by changes in cursor position or scrolling. Its useful inside a	1683	confused by changes in cursor position or scrolling. Its useful inside a
1263	C<on_add_lines> hook, though.	1684	C<on_add_lines> hook, though.
1264		1685
		1686	=item $term->scr_change_screen ($screen)
		1687
		1688	Switch to given screen - 0 primary, 1 secondary.
		1689
1265	=item $term->cmd_parse ($octets)	1690	=item $term->cmd_parse ($octets)
1266		1691
1267	Similar to C<scr_add_lines>, but the argument must be in the	1692	Similar to C<scr_add_lines>, but the argument must be in the
1268	locale-specific encoding of the terminal and can contain command sequences	1693	locale-specific encoding of the terminal and can contain command sequences
1269	(escape codes) that will be interpreted.	1694	(escape codes) that will be interpreted.
1270		1695
1271	=item $term->tt_write ($octets)	1696	=item $term->tt_write ($octets)
1272		1697
1273	Write the octets given in C<$data> to the tty (i.e. as program input). To	1698	Write the octets given in C<$octets> to the tty (i.e. as user input
		1699	to the program, see C<cmd_parse> for the opposite direction). To pass
1274	pass characters instead of octets, you should convert your strings first	1700	characters instead of octets, you should convert your strings first to the
1275	to the locale-specific encoding using C<< $term->locale_encode >>.	1701	locale-specific encoding using C<< $term->locale_encode >>.
		1702
		1703	=item $term->tt_write_user_input ($octets)
		1704
		1705	Like C<tt_write>, but should be used when writing strings in response to
		1706	the user pressing a key, to invoke the additional actions requested by
		1707	the user for that case (C<tt_write> doesn't do that).
		1708
		1709	The typical use case would be inside C<on_action> hooks.
		1710
		1711	=item $term->tt_paste ($octets)
		1712
		1713	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1714	CR and bracketing the data with control sequences if bracketed paste mode
		1715	is set.
1276		1716
1277	=item $old_events = $term->pty_ev_events ([$new_events])	1717	=item $old_events = $term->pty_ev_events ([$new_events])
1278		1718
1279	Replaces the event mask of the pty watcher by the given event mask. Can	1719	Replaces the event mask of the pty watcher by the given event mask. Can
1280	be used to suppress input and output handling to the pty/tty. See the	1720	be used to suppress input and output handling to the pty/tty. See the
1281	description of C<< urxvt::timer->events >>. Make sure to always restore	1721	description of C<< urxvt::timer->events >>. Make sure to always restore
1282	the previous value.	1722	the previous value.
1283		1723
		1724	=item $fd = $term->pty_fd
		1725
		1726	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1727	is used.
		1728
1284	=item $windowid = $term->parent	1729	=item $windowid = $term->parent
1285		1730
1286	Return the window id of the toplevel window.	1731	Return the window id of the toplevel window.
1287		1732
1288	=item $windowid = $term->vt	1733	=item $windowid = $term->vt
…		…
1294	Adds the specified events to the vt event mask. Useful e.g. when you want	1739	Adds the specified events to the vt event mask. Useful e.g. when you want
1295	to receive pointer events all the times:	1740	to receive pointer events all the times:
1296		1741
1297	$term->vt_emask_add (urxvt::PointerMotionMask);	1742	$term->vt_emask_add (urxvt::PointerMotionMask);
1298		1743
		1744	=item $term->set_urgency ($set)
		1745
		1746	Enable/disable the urgency hint on the toplevel window.
		1747
		1748	=item $term->focus_in
		1749
		1750	=item $term->focus_out
		1751
		1752	=item $term->key_press ($state, $keycode[, $time])
		1753
		1754	=item $term->key_release ($state, $keycode[, $time])
		1755
		1756	Deliver various fake events to to terminal.
		1757
1299	=item $window_width = $term->width	1758	=item $window_width = $term->width ([$new_value])
1300		1759
1301	=item $window_height = $term->height	1760	=item $window_height = $term->height ([$new_value])
1302		1761
1303	=item $font_width = $term->fwidth	1762	=item $font_width = $term->fwidth ([$new_value])
1304		1763
1305	=item $font_height = $term->fheight	1764	=item $font_height = $term->fheight ([$new_value])
1306		1765
1307	=item $font_ascent = $term->fbase	1766	=item $font_ascent = $term->fbase ([$new_value])
1308		1767
1309	=item $terminal_rows = $term->nrow	1768	=item $terminal_rows = $term->nrow ([$new_value])
1310		1769
1311	=item $terminal_columns = $term->ncol	1770	=item $terminal_columns = $term->ncol ([$new_value])
1312		1771
1313	=item $has_focus = $term->focus	1772	=item $has_focus = $term->focus ([$new_value])
1314		1773
1315	=item $is_mapped = $term->mapped	1774	=item $is_mapped = $term->mapped ([$new_value])
1316		1775
1317	=item $max_scrollback = $term->saveLines	1776	=item $max_scrollback = $term->saveLines ([$new_value])
1318		1777
1319	=item $nrow_plus_saveLines = $term->total_rows	1778	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1320		1779
1321	=item $topmost_scrollback_row = $term->top_row	1780	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1322		1781
1323	Return various integers describing terminal characteristics.	1782	Return various integers describing terminal characteristics. If an
		1783	argument is given, changes the value and returns the previous one.
1324		1784
1325	=item $x_display = $term->display_id	1785	=item $x_display = $term->display_id
1326		1786
1327	Return the DISPLAY used by rxvt-unicode.	1787	Return the DISPLAY used by rxvt-unicode.
1328		1788
…		…
1333	=item $env = $term->env	1793	=item $env = $term->env
1334		1794
1335	Returns a copy of the environment in effect for the terminal as a hashref	1795	Returns a copy of the environment in effect for the terminal as a hashref
1336	similar to C<\%ENV>.	1796	similar to C<\%ENV>.
1337		1797
		1798	=item @envv = $term->envv
		1799
		1800	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1801
		1802	=item @argv = $term->argv
		1803
		1804	Return the argument vector as this terminal, similar to @ARGV, but
		1805	includes the program name as first element.
		1806
1338	=cut	1807	=cut
1339		1808
1340	sub env {	1809	sub env {
1341	if (my $env = $_[0]->_env) {
1342	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1810	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1343	} else {
1344	+{ %ENV }
1345	}
1346	}	1811	}
1347		1812
1348	=item $modifiermask = $term->ModLevel3Mask	1813	=item $modifiermask = $term->ModLevel3Mask
1349		1814
1350	=item $modifiermask = $term->ModMetaMask	1815	=item $modifiermask = $term->ModMetaMask
…		…
1352	=item $modifiermask = $term->ModNumLockMask	1817	=item $modifiermask = $term->ModNumLockMask
1353		1818
1354	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1819	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1355	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1820	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1356		1821
		1822	=item $screen = $term->current_screen
		1823
		1824	Returns the currently displayed screen (0 primary, 1 secondary).
		1825
		1826	=item $cursor_is_hidden = $term->hidden_cursor
		1827
		1828	Returns whether the cursor is currently hidden or not.
		1829
		1830	=item $priv_modes = $term->priv_modes
		1831
		1832	Returns a bitset with the state of DEC private modes.
		1833
		1834	Example:
		1835
		1836	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1837	# mouse reporting is turned on
		1838	}
		1839
1357	=item $view_start = $term->view_start ([$newvalue])	1840	=item $view_start = $term->view_start ([$newvalue])
1358		1841
1359	Returns the row number of the topmost displayed line. Maximum value is	1842	Returns the row number of the topmost displayed line and changes it,
1360	C<0>, which displays the normal terminal contents. Lower values scroll	1843	if an argument is given. Values greater than or equal to C<0> display
1361	this many lines into the scrollback buffer.	1844	the terminal contents. Lower values scroll this many lines into the
		1845	scrollback buffer.
1362		1846
1363	=item $term->want_refresh	1847	=item $term->want_refresh
1364		1848
1365	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1849	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1366	compare the on-screen display with its stored representation. If they	1850	compare the on-screen display with its stored representation. If they
1367	differ, it redraws the differences.	1851	differ, it redraws the differences.
1368		1852
1369	Used after changing terminal contents to display them.	1853	Used after changing terminal contents to display them.
1370		1854
		1855	=item $term->refresh_check
		1856
		1857	Checks if a refresh has been requested and, if so, schedules one.
		1858
1371	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1859	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1372		1860
1373	Returns the text of the entire row with number C<$row_number>. Row C<0>	1861	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1374	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1862	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1375	terminal line. The scrollback buffer starts at line C<-1> and extends to
1376	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1863	terminal line. Nothing will be returned if a nonexistent line
1377	is requested.	1864	is requested.
1378		1865
1379	If C<$new_text> is specified, it will replace characters in the current	1866	If C<$new_text> is specified, it will replace characters in the current
1380	line, starting at column C<$start_col> (default C<0>), which is useful	1867	line, starting at column C<$start_col> (default C<0>), which is useful
1381	to replace only parts of a line. The font index in the rendition will	1868	to replace only parts of a line. The font index in the rendition will
1382	automatically be updated.	1869	automatically be updated.
1383		1870
1384	C<$text> is in a special encoding: tabs and wide characters that use more	1871	C<$text> is in a special encoding: tabs and wide characters that use more
1385	than one cell when displayed are padded with urxvt::NOCHAR characters	1872	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1386	(C<chr 65535>). Characters with combining characters and other characters	1873	characters. Characters with combining characters and other characters that
1387	that do not fit into the normal tetx encoding will be replaced with	1874	do not fit into the normal text encoding will be replaced with characters
1388	characters in the private use area.	1875	in the private use area.
1389		1876
1390	You have to obey this encoding when changing text. The advantage is	1877	You have to obey this encoding when changing text. The advantage is
1391	that C<substr> and similar functions work on screen cells and not on	1878	that C<substr> and similar functions work on screen cells and not on
1392	characters.	1879	characters.
1393		1880
…		…
1421		1908
1422	Create and return a new C<urxvt::line> object that stores information	1909	Create and return a new C<urxvt::line> object that stores information
1423	about the logical line that row C<$row_number> is part of. It supports the	1910	about the logical line that row C<$row_number> is part of. It supports the
1424	following methods:	1911	following methods:
1425		1912
1426	=over 4	1913	=over
1427		1914
1428	=item $text = $line->t ([$new_text])	1915	=item $text = $line->t ([$new_text])
1429		1916
1430	Returns or replaces the full text of the line, similar to C<ROW_t>	1917	Returns or replaces the full text of the line, similar to C<ROW_t>
1431		1918
…		…
1477	}	1964	}
1478		1965
1479	sub urxvt::line::t {	1966	sub urxvt::line::t {
1480	my ($self) = @_;	1967	my ($self) = @_;
1481		1968
1482	if (@_ > 1)	1969	if (@_ > 1) {
1483	{
1484	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1970	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1485	for $self->{beg} .. $self->{end};	1971	for $self->{beg} .. $self->{end};
1486	}	1972	}
1487		1973
1488	defined wantarray &&	1974	defined wantarray &&
1489	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1975	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1490	0, $self->{len}	1976	0, $self->{len}
1491	}	1977	}
1492		1978
1493	sub urxvt::line::r {	1979	sub urxvt::line::r {
1494	my ($self) = @_;	1980	my ($self) = @_;
1495		1981
1496	if (@_ > 1)	1982	if (@_ > 1) {
1497	{
1498	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1983	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1499	for $self->{beg} .. $self->{end};	1984	for $self->{beg} .. $self->{end};
1500	}	1985	}
1501		1986
1502	if (defined wantarray) {	1987	if (defined wantarray) {
1503	my $rend = [	1988	my $rend = [
1504	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1989	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1505	];	1990	];
…		…
1537	where one character corresponds to one screen cell. See	2022	where one character corresponds to one screen cell. See
1538	C<< $term->ROW_t >> for details.	2023	C<< $term->ROW_t >> for details.
1539		2024
1540	=item $string = $term->special_decode $text	2025	=item $string = $term->special_decode $text
1541		2026
1542	Converts rxvt-unicodes text reprsentation into a perl string. See	2027	Converts rxvt-unicode's text representation into a perl string. See
1543	C<< $term->ROW_t >> for details.	2028	C<< $term->ROW_t >> for details.
1544		2029
1545	=item $success = $term->grab_button ($button, $modifiermask)	2030	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1546		2031
		2032	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2033
1547	Registers a synchronous button grab. See the XGrabButton manpage.	2034	Register/unregister a synchronous button grab. See the XGrabButton
		2035	manpage.
1548		2036
1549	=item $success = $term->grab ($eventtime[, $sync])	2037	=item $success = $term->grab ($eventtime[, $sync])
1550		2038
1551	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2039	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1552	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2040	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1553		2041
1554	=item $term->allow_events_async	2042	=item $term->allow_events_async
1555		2043
1556	Calls XAllowEvents with AsyncBoth for the most recent grab.	2044	Calls XAllowEvents with AsyncBoth for the most recent grab.
1557		2045
…		…
1564	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2052	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1565	recent grab.	2053	recent grab.
1566		2054
1567	=item $term->ungrab	2055	=item $term->ungrab
1568		2056
1569	Calls XUngrab for the most recent grab. Is called automatically on	2057	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1570	evaluation errors, as it is better to lose the grab in the error case as	2058	evaluation errors, as it is better to lose the grab in the error case as
1571	the session.	2059	the session.
1572		2060
1573	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2061	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1574		2062
…		…
1576		2064
1577	=item @atoms = $term->XListProperties ($window)	2065	=item @atoms = $term->XListProperties ($window)
1578		2066
1579	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2067	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1580		2068
1581	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2069	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1582		2070
1583	=item $term->XDeleteProperty ($window, $property)	2071	=item $term->XDeleteProperty ($window, $property)
1584		2072
1585	=item $window = $term->DefaultRootWindow	2073	=item $window = $term->DefaultRootWindow
1586		2074
…		…
1593	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2081	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1594		2082
1595	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2083	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1596		2084
1597	=item $term->XChangeInput ($window, $add_events[, $del_events])	2085	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2086
		2087	=item $keysym = $term->XStringToKeysym ($string)
		2088
		2089	=item $string = $term->XKeysymToString ($keysym)
1598		2090
1599	Various X or X-related functions. The C<$term> object only serves as	2091	Various X or X-related functions. The C<$term> object only serves as
1600	the source of the display, otherwise those functions map more-or-less	2092	the source of the display, otherwise those functions map more-or-less
1601	directory onto the X functions of the same name.	2093	directly onto the X functions of the same name.
1602		2094
1603	=back	2095	=back
1604		2096
1605	=cut	2097	=cut
1606		2098
1607	package urxvt::popup;	2099	package urxvt::popup;
1608		2100
1609	=head2 The C<urxvt::popup> Class	2101	=head2 The C<urxvt::popup> Class
1610		2102
1611	=over 4	2103	=over
1612		2104
1613	=cut	2105	=cut
1614		2106
1615	sub add_item {	2107	sub add_item {
1616	my ($self, $item) = @_;	2108	my ($self, $item) = @_;
…		…
1670	my ($self, $text, $cb) = @_;	2162	my ($self, $text, $cb) = @_;
1671		2163
1672	$self->add_item ({ type => "button", text => $text, activate => $cb});	2164	$self->add_item ({ type => "button", text => $text, activate => $cb});
1673	}	2165	}
1674		2166
1675	=item $popup->add_toggle ($text, $cb, $initial_value)	2167	=item $popup->add_toggle ($text, $initial_value, $cb)
1676		2168
1677	Adds a toggle/checkbox item to the popup. Teh callback gets called	2169	Adds a toggle/checkbox item to the popup. The callback gets called
1678	whenever it gets toggled, with a boolean indicating its value as its first	2170	whenever it gets toggled, with a boolean indicating its new value as its
1679	argument.	2171	first argument.
1680		2172
1681	=cut	2173	=cut
1682		2174
1683	sub add_toggle {	2175	sub add_toggle {
1684	my ($self, $text, $cb, $value) = @_;	2176	my ($self, $text, $value, $cb) = @_;
1685		2177
1686	my $item; $item = {	2178	my $item; $item = {
1687	type => "button",	2179	type => "button",
1688	text => " $text",	2180	text => " $text",
1689	value => $value,	2181	value => $value,
…		…
1708	my $env = $self->{term}->env;	2200	my $env = $self->{term}->env;
1709	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2201	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1710	delete $env->{LC_ALL};	2202	delete $env->{LC_ALL};
1711	$env->{LC_CTYPE} = $self->{term}->locale;	2203	$env->{LC_CTYPE} = $self->{term}->locale;
1712		2204
1713	urxvt::term->new ($env, "popup",	2205	my $term = urxvt::term->new (
		2206	$env, "popup",
1714	"--perl-lib" => "", "--perl-ext-common" => "",	2207	"--perl-lib" => "", "--perl-ext-common" => "",
1715	"-pty-fd" => -1, "-sl" => 0,	2208	"-pty-fd" => -1, "-sl" => 0,
1716	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2209	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1717	"--transient-for" => $self->{term}->parent,	2210	"--transient-for" => $self->{term}->parent,
1718	"-display" => $self->{term}->display_id,	2211	"-display" => $self->{term}->display_id,
1719	"-pe" => "urxvt-popup")	2212	"-pe" => "urxvt-popup",
1720	or die "unable to create popup window\n";	2213	) or die "unable to create popup window\n";
		2214
		2215	unless (delete $term->{urxvt_popup_init_done}) {
		2216	$term->ungrab;
		2217	$term->destroy;
		2218	die "unable to initialise popup window\n";
		2219	}
1721	}	2220	}
1722		2221
1723	sub DESTROY {	2222	sub DESTROY {
1724	my ($self) = @_;	2223	my ($self) = @_;
1725		2224
…		…
1730	=back	2229	=back
1731		2230
1732	=cut	2231	=cut
1733		2232
1734	package urxvt::watcher;	2233	package urxvt::watcher;
1735
1736	@urxvt::timer::ISA = __PACKAGE__;
1737	@urxvt::iow::ISA = __PACKAGE__;
1738	@urxvt::pw::ISA = __PACKAGE__;
1739	@urxvt::iw::ISA = __PACKAGE__;
1740		2234
1741	=head2 The C<urxvt::timer> Class	2235	=head2 The C<urxvt::timer> Class
1742		2236
1743	This class implements timer watchers/events. Time is represented as a	2237	This class implements timer watchers/events. Time is represented as a
1744	fractional number of seconds since the epoch. Example:	2238	fractional number of seconds since the epoch. Example:
…		…
1748	->new	2242	->new
1749	->interval (1)	2243	->interval (1)
1750	->cb (sub {	2244	->cb (sub {
1751	$term->{overlay}->set (0, 0,	2245	$term->{overlay}->set (0, 0,
1752	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2246	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1753	});	2247	});
1754		2248
1755	=over 4	2249	=over
1756		2250
1757	=item $timer = new urxvt::timer	2251	=item $timer = new urxvt::timer
1758		2252
1759	Create a new timer object in started state. It is scheduled to fire	2253	Create a new timer object in started state. It is scheduled to fire
1760	immediately.	2254	immediately.
1761		2255
1762	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2256	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1763		2257
1764	Set the callback to be called when the timer triggers.	2258	Set the callback to be called when the timer triggers.
1765		2259
1766	=item $tstamp = $timer->at
1767
1768	Return the time this watcher will fire next.
1769
1770	=item $timer = $timer->set ($tstamp)	2260	=item $timer = $timer->set ($tstamp[, $interval])
1771		2261
1772	Set the time the event is generated to $tstamp.	2262	Set the time the event is generated to $tstamp (and optionally specifies a
		2263	new $interval).
1773		2264
1774	=item $timer = $timer->interval ($interval)	2265	=item $timer = $timer->interval ($interval)
1775		2266
1776	Normally (and when C<$interval> is C<0>), the timer will automatically	2267	By default (and when C<$interval> is C<0>), the timer will automatically
1777	stop after it has fired once. If C<$interval> is non-zero, then the timer	2268	stop after it has fired once. If C<$interval> is non-zero, then the timer
1778	is automatically rescheduled at the given intervals.	2269	is automatically rescheduled at the given intervals.
1779		2270
1780	=item $timer = $timer->start	2271	=item $timer = $timer->start
1781		2272
1782	Start the timer.	2273	Start the timer.
1783		2274
1784	=item $timer = $timer->start ($tstamp)	2275	=item $timer = $timer->start ($tstamp[, $interval])
1785		2276
1786	Set the event trigger time to C<$tstamp> and start the timer.	2277	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2278	also replaces the interval.
1787		2279
1788	=item $timer = $timer->after ($delay)	2280	=item $timer = $timer->after ($delay[, $interval])
1789		2281
1790	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2282	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1791		2283
1792	=item $timer = $timer->stop	2284	=item $timer = $timer->stop
1793		2285
…		…
1801		2293
1802	$term->{socket} = ...	2294	$term->{socket} = ...
1803	$term->{iow} = urxvt::iow	2295	$term->{iow} = urxvt::iow
1804	->new	2296	->new
1805	->fd (fileno $term->{socket})	2297	->fd (fileno $term->{socket})
1806	->events (urxvt::EVENT_READ)	2298	->events (urxvt::EV_READ)
1807	->start	2299	->start
1808	->cb (sub {	2300	->cb (sub {
1809	my ($iow, $revents) = @_;	2301	my ($iow, $revents) = @_;
1810	# $revents must be 1 here, no need to check	2302	# $revents must be 1 here, no need to check
1811	sysread $term->{socket}, my $buf, 8192	2303	sysread $term->{socket}, my $buf, 8192
1812	or end-of-file;	2304	or end-of-file;
1813	});	2305	});
1814		2306
1815		2307
1816	=over 4	2308	=over
1817		2309
1818	=item $iow = new urxvt::iow	2310	=item $iow = new urxvt::iow
1819		2311
1820	Create a new io watcher object in stopped state.	2312	Create a new io watcher object in stopped state.
1821		2313
…		…
1824	Set the callback to be called when io events are triggered. C<$reventmask>	2316	Set the callback to be called when io events are triggered. C<$reventmask>
1825	is a bitset as described in the C<events> method.	2317	is a bitset as described in the C<events> method.
1826		2318
1827	=item $iow = $iow->fd ($fd)	2319	=item $iow = $iow->fd ($fd)
1828		2320
1829	Set the filedescriptor (not handle) to watch.	2321	Set the file descriptor (not handle) to watch.
1830		2322
1831	=item $iow = $iow->events ($eventmask)	2323	=item $iow = $iow->events ($eventmask)
1832		2324
1833	Set the event mask to watch. The only allowed values are	2325	Set the event mask to watch. The only allowed values are
1834	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2326	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1835	together, or C<urxvt::EVENT_NONE>.	2327	together, or C<urxvt::EV_NONE>.
1836		2328
1837	=item $iow = $iow->start	2329	=item $iow = $iow->start
1838		2330
1839	Start watching for requested events on the given handle.	2331	Start watching for requested events on the given handle.
1840		2332
1841	=item $iow = $iow->stop	2333	=item $iow = $iow->stop
1842		2334
1843	Stop watching for events on the given filehandle.	2335	Stop watching for events on the given file handle.
1844		2336
1845	=back	2337	=back
1846		2338
1847	=head2 The C<urxvt::iw> Class	2339	=head2 The C<urxvt::iw> Class
1848		2340
1849	This class implements idle watchers, that get called automatically when	2341	This class implements idle watchers, that get called automatically when
1850	the process is idle. They should return as fast as possible, after doing	2342	the process is idle. They should return as fast as possible, after doing
1851	some useful work.	2343	some useful work.
1852		2344
1853	=over 4	2345	=over
1854		2346
1855	=item $iw = new urxvt::iw	2347	=item $iw = new urxvt::iw
1856		2348
1857	Create a new idle watcher object in stopped state.	2349	Create a new idle watcher object in stopped state.
1858		2350
…		…
1881	->new	2373	->new
1882	->start ($pid)	2374	->start ($pid)
1883	->cb (sub {	2375	->cb (sub {
1884	my ($pw, $exit_status) = @_;	2376	my ($pw, $exit_status) = @_;
1885	...	2377	...
1886	});	2378	});
1887		2379
1888	=over 4	2380	=over
1889		2381
1890	=item $pw = new urxvt::pw	2382	=item $pw = new urxvt::pw
1891		2383
1892	Create a new process watcher in stopped state.	2384	Create a new process watcher in stopped state.
1893		2385
…		…
1895		2387
1896	Set the callback to be called when the timer triggers.	2388	Set the callback to be called when the timer triggers.
1897		2389
1898	=item $pw = $timer->start ($pid)	2390	=item $pw = $timer->start ($pid)
1899		2391
1900	Tells the wqtcher to start watching for process C<$pid>.	2392	Tells the watcher to start watching for process C<$pid>.
1901		2393
1902	=item $pw = $pw->stop	2394	=item $pw = $pw->stop
1903		2395
1904	Stop the watcher.	2396	Stop the watcher.
1905		2397
…		…
1910	=head2 URXVT_PERL_VERBOSITY	2402	=head2 URXVT_PERL_VERBOSITY
1911		2403
1912	This variable controls the verbosity level of the perl extension. Higher	2404	This variable controls the verbosity level of the perl extension. Higher
1913	numbers indicate more verbose output.	2405	numbers indicate more verbose output.
1914		2406
1915	=over 4	2407	=over
1916		2408
1917	=item == 0 - fatal messages	2409	=item == 0 - fatal messages only
		2410
		2411	=item >= 2 - general warnings (default level)
1918		2412
1919	=item >= 3 - script loading and management	2413	=item >= 3 - script loading and management
1920		2414
1921	=item >=10 - all called hooks	2415	=item >=10 - all called hooks
1922		2416
1923	=item >=11 - hook reutrn values	2417	=item >=11 - hook return values
1924		2418
1925	=back	2419	=back
1926		2420
1927	=head1 AUTHOR	2421	=head1 AUTHOR
1928		2422
1929	Marc Lehmann <pcg@goof.com>	2423	Marc Lehmann <schmorp@schmorp.de>
1930	http://software.schmorp.de/pkg/rxvt-unicode	2424	http://software.schmorp.de/pkg/rxvt-unicode
1931		2425
1932	=cut	2426	=cut
1933		2427
1934	1	2428	1
		2429
		2430	# vim: sw=3:

Diff Legend

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