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

Diff Legend

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