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.111 by root, Thu Jan 19 19:52:54 2006 UTC vs.
Revision 1.267 by sf-exg, Sat Jul 24 12:17:08 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	evalution, web-browser starting etc.), depending on content.
97
98	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100	popup is displayed.
101
102	It's sole argument is the popup menu, which can be modified. The selection
103	is in C<$_>, which can be used to decide wether to add something or not.
104	It should either return nothing or a string and a code reference. The
105	string will be used as button text and the code reference will be called
106	when the button gets activated and should transform C<$_>.
107
108	The following will add an entry C<a to b> that transforms all C<a>s in
109	the selection to C<b>s, but only if the selection currently contains any
110	C<a>s:
111
112	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }
114	: ()
115	};
116
117	=item searchable-scrollback<hotkey> (enabled by default)
118
119	Adds regex search functionality to the scrollback buffer, triggered
120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
121	input/output is suspended and a regex is displayed at the bottom of the
122	screen.
123
124	Inputting characters appends them to the regex and continues incremental
125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
127	bottom. C<Escape> leaves search mode and returns to the point where search
128	was started, while C<Enter> or C<Return> stay at the current position and
129	additionally stores the first match in the current line into the primary
130	selection.
131
132	=item selection-autotransform
133
134	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.
136
137	It works by specifying perl snippets (most useful is a single C<s///>
138	operator) that modify C<$_> as resources:
139
140	URxvt.selection-autotransform.0: transform
141	URxvt.selection-autotransform.1: transform
142	...
143
144	For example, the following will transform selections of the form
145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
146	$word>:
147
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150	And this example matches the same,but replaces it with vi-commands you can
151	paste directly into your (vi :) editor:
152
153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155	Of course, this can be modified to suit your needs and your editor :)
156
157	To expand the example above to typical perl error messages ("XXX at
158	FILENAME line YYY."), you need a slightly more elaborate solution:
159
160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163	The first line tells the selection code to treat the unchanging part of
164	every error message as a selection pattern, and the second line transforms
165	the message into vi commands to load the file.
166
167	=item mark-urls
168
169	Uses per-line display filtering (C<on_line_update>) to underline urls and
170	make them clickable. When middle-clicked, the program specified in the
171	resource C<urlLauncher> (default C<x-www-browser>) will be started with
172	the URL as first argument.
173
174	=item automove-background
175
176	This is basically a one-line extension that dynamically changes the background pixmap offset
177	to the window position, in effect creating the same effect as pseudo transparency with
178	a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
181
182	=item block-graphics-to-ascii
183
184	A not very useful example of filtering all text output to the terminal,
185	by replacing all line-drawing characters (U+2500 .. U+259F) by a
186	similar-looking ascii character.
187
188	=item digital-clock
189
190	Displays a digital clock using the built-in overlay.
191
192	=item example-refresh-hooks
193
194	Displays a very simple digital clock in the upper right corner of the
195	window. Illustrates overwriting the refresh callbacks to create your own
196	overlays or changes.
197
198	=item selection-pastebin
199
200	This is a little rarely useful extension that Uploads the selection as
201	textfile to a remote site (or does other things). (The implementation is
202	not currently secure for use in a multiuser environment as it writes to
203	F</tmp> directly.).
204
205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206	i.e.
207
208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209
210	Pressing this combination runs a command with C<%> replaced by the name of
211	the textfile. This command can be set via a resource:
212
213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215	And the default is likely not useful to anybody but the few people around
216	here :)
217
218	The name of the textfile is the hex encoded md5 sum of the selection, so
219	the same content should lead to the same filename.
220
221	After a successful upload the selection will be replaced by the text given
222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
223	for the filename):
224
225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
226
227	=back
228		56
229	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
230		58
231	=head2 General API Considerations	59	=head2 General API Considerations
232		60
…		…
242	terminal is destroyed.	70	terminal is destroyed.
243		71
244	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
245	hints on what they mean:	73	hints on what they mean:
246		74
247	=over 4	75	=over
248		76
249	=item $text	77	=item $text
250		78
251	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
252	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.
253		81
254	=item $string	82	=item $string
255		83
256	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
…		…
260	=item $octets	88	=item $octets
261		89
262	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
263	locale-specific way.	91	locale-specific way.
264		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
265	=back	99	=back
266		100
267	=head2 Extension Objects	101	=head2 Extension Objects
268		102
269	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
270	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,
271	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
272	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
273	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
274	use.	109	internal use.
275		110
276	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
277	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
278		113
279	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.
280		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
281	=over 4	128	=over
282		129
283	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
284		131
285	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
286	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.
287		135
288	=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.
289		138
290	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
291	this extension, replacing any previous hook. This is useful when you want	140	comment:
292	to overwrite time-critical hooks only temporarily.
293		141
294	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
295		143
296	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
297		183
298	=back	184	=back
299		185
300	=head2 Hooks	186	=head2 Hooks
301		187
302	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
303	called whenever the relevant event happens.	189	called whenever the relevant event happens.
304		190
305	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
306	the in the C<Extension Objects> section.	192	the in the C<Extension Objects> section.
307		193
308	B<All> of these hooks must return a boolean value. If it is true, then the	194	B<All> of these hooks must return a boolean value. If any of the called
309	event counts as being I<consumed>, and the invocation of other hooks is	195	hooks returns true, then the event counts as being I<consumed>, and the
310	skipped, and the relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
311		197
312	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
313		199
314	=over 4	200	=over
315		201
316	=item on_init $term	202	=item on_init $term
317		203
318	Called after a new terminal object has been initialized, but before	204	Called after a new terminal object has been initialized, but before
319	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
320	call or deliver senseless data, as terminal size and other characteristics	206	call or deliver senseless data, as terminal size and other characteristics
321	have not yet been determined. You can safely query and change resources,	207	have not yet been determined. You can safely query and change resources
322	though.	208	and options, though. For many purposes the C<on_start> hook is a better
		209	place.
		210
		211	=item on_start $term
		212
		213	Called at the very end of initialisation of a new terminal, just before
		214	trying to map (display) the toplevel and returning to the main loop.
		215
		216	=item on_destroy $term
		217
		218	Called whenever something tries to destroy terminal, when the terminal is
		219	still fully functional (not for long, though).
323		220
324	=item on_reset $term	221	=item on_reset $term
325		222
326	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
327	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
328	variables.	225	variables.
329		226
330	=item on_start $term
331
332	Called at the very end of initialisation of a new terminal, just before
333	returning to the mainloop.
334
335	=item on_child_start $term, $pid	227	=item on_child_start $term, $pid
336		228
337	Called just after the child process has been C<fork>ed.	229	Called just after the child process has been C<fork>ed.
338		230
339	=item on_child_exit $term, $status	231	=item on_child_exit $term, $status
…		…
354		246
355	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
356	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
357	by calling C<< $term->selection >>.	249	by calling C<< $term->selection >>.
358		250
359	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.
360		252
361	=item on_sel_extend $term	253	=item on_sel_extend $term
362		254
363	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
364	click) and is either supposed to return false (normal operation), or	256	click) and is either supposed to return false (normal operation), or
365	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
366	processing. This can happen multiple times, as long as the callback	258	processing. This can happen multiple times, as long as the callback
367	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
368	supposed to enlarge the selection more and more, if possible.	260	supposed to enlarge the selection more and more, if possible.
369		261
370	See the F<selection> example extension.	262	See the F<selection> example extension.
371		263
372	=item on_view_change $term, $offset	264	=item on_view_change $term, $offset
373		265
374	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
375	scrolls. Offset C<0> means display the normal terminal, positive values	267	scrolls. Offset C<0> means display the normal terminal, positive values
376	show this many lines of scrollback.	268	show this many lines of scrollback.
377		269
378	=item on_scroll_back $term, $lines, $saved	270	=item on_scroll_back $term, $lines, $saved
379		271
…		…
383		275
384	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,
385	$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
386	number of lines that will be in the scrollback buffer.	278	number of lines that will be in the scrollback buffer.
387		279
388	=item on_osc_seq $term, $string	280	=item on_osc_seq $term, $op, $args, $resp
389		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
390	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	292	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
391	operating system command) is processed. Cursor position and other state	293	(OSC = operating system command) is processed. Cursor position and other
392	information is up-to-date when this happens. For interoperability, the	294	state information is up-to-date when this happens. For interoperability,
393	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
394	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
395	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	}
396		308
397	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,
398	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
399	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.
400		315
401	=item on_add_lines $term, $string	316	=item on_add_lines $term, $string
402		317
403	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
404	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
…		…
409	=item on_tt_write $term, $octets	324	=item on_tt_write $term, $octets
410		325
411	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
412	suppress or filter tty input.	327	suppress or filter tty input.
413		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
414	=item on_line_update $term, $row	336	=item on_line_update $term, $row
415		337
416	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
417	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
418	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,
…		…
425	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
426	you cannot just toggle rendition bits, but only set them.	348	you cannot just toggle rendition bits, but only set them.
427		349
428	=item on_refresh_begin $term	350	=item on_refresh_begin $term
429		351
430	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
431	or similar effects by modify terminal contents in refresh_begin, and	353	similar effects by modifying the terminal contents in refresh_begin, and
432	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
433	code is run after this hook, and takes precedence.	355	code is run after this hook, and takes precedence.
434		356
435	=item on_refresh_end $term	357	=item on_refresh_end $term
436		358
437	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>.
438		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
439	=item on_keyboard_command $term, $string	369	=item on_user_command $term, $string *DEPRECATED*
440		370
441	Called whenever the user presses a key combination that has a	371	Called whenever a user-configured event is being activated (e.g. via
442	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>
443	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.
444		383
445	=item on_x_event $term, $event	384	=item on_x_event $term, $event
446		385
447	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
448	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
449	members are not passed.	388	members are not passed.
450		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
451	=item on_focus_in $term	394	=item on_focus_in $term
452		395
453	Called whenever the window gets the keyboard focus, before rxvt-unicode	396	Called whenever the window gets the keyboard focus, before rxvt-unicode
454	does focus in processing.	397	does focus in processing.
455		398
456	=item on_focus_out $term	399	=item on_focus_out $term
457		400
458	Called wheneever the window loses keyboard focus, before rxvt-unicode does	401	Called whenever the window loses keyboard focus, before rxvt-unicode does
459	focus out processing.	402	focus out processing.
460		403
461	=item on_configure_notify $term, $event	404	=item on_configure_notify $term, $event
462		405
		406	=item on_property_notify $term, $event
		407
463	=item on_key_press $term, $event, $keysym, $octets	408	=item on_key_press $term, $event, $keysym, $octets
464		409
465	=item on_key_release $term, $event, $keysym	410	=item on_key_release $term, $event, $keysym
466		411
467	=item on_button_press $term, $event	412	=item on_button_press $term, $event
…		…
472		417
473	=item on_map_notify $term, $event	418	=item on_map_notify $term, $event
474		419
475	=item on_unmap_notify $term, $event	420	=item on_unmap_notify $term, $event
476		421
477	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
478	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.
479		424
480	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
481	manpage), with the additional members C<row> and C<col>, which are the row	426	manpage), with the additional members C<row> and C<col>, which are the
482	and column under the mouse cursor.	427	(real, not screen-based) row and column under the mouse cursor.
483		428
484	C<on_key_press> additionally receives the string rxvt-unicode would	429	C<on_key_press> additionally receives the string rxvt-unicode would
485	output, if any, in locale-specific encoding.	430	output, if any, in locale-specific encoding.
486		431
487	subwindow.	432	=item on_client_message $term, $event
		433
		434	=item on_wm_protocols $term, $event
		435
		436	=item on_wm_delete_window $term, $event
		437
		438	Called when various types of ClientMessage events are received (all with
		439	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		440
		441	=item on_bell $term
		442
		443	Called on receipt of a bell character.
488		444
489	=back	445	=back
490		446
491	=cut	447	=cut
492		448
493	package urxvt;	449	package urxvt;
494		450
495	use utf8;	451	use utf8;
496	use strict;	452	use strict qw(vars subs);
497	use Carp ();	453	use Carp ();
498	use Scalar::Util ();	454	use Scalar::Util ();
499	use List::Util ();	455	use List::Util ();
500		456
501	our $VERSION = 1;	457	our $VERSION = 1;
502	our $TERM;	458	our $TERM;
		459	our @TERM_INIT; # should go, prevents async I/O etc.
		460	our @TERM_EXT; # should go, prevents async I/O etc.
503	our @HOOKNAME;	461	our @HOOKNAME;
504	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
505	our %OPTION;	463	our %OPTION;
506		464
507	our $LIBDIR;	465	our $LIBDIR;
508	our $RESNAME;	466	our $RESNAME;
509	our $RESCLASS;	467	our $RESCLASS;
510	our $RXVTNAME;	468	our $RXVTNAME;
511		469
		470	our $NOCHAR = chr 0xffff;
		471
512	=head2 Variables in the C<urxvt> Package	472	=head2 Variables in the C<urxvt> Package
513		473
514	=over 4	474	=over
515		475
516	=item $urxvt::LIBDIR	476	=item $urxvt::LIBDIR
517		477
518	The rxvt-unicode library directory, where, among other things, the perl	478	The rxvt-unicode library directory, where, among other things, the perl
519	modules and scripts are stored.	479	modules and scripts are stored.
…		…
529	=item $urxvt::TERM	489	=item $urxvt::TERM
530		490
531	The current terminal. This variable stores the current C<urxvt::term>	491	The current terminal. This variable stores the current C<urxvt::term>
532	object, whenever a callback/hook is executing.	492	object, whenever a callback/hook is executing.
533		493
		494	=item @urxvt::TERM_INIT
		495
		496	All code references in this array will be called as methods of the next newly
		497	created C<urxvt::term> object (during the C<on_init> phase). The array
		498	gets cleared before the code references that were in it are being executed,
		499	so references can push themselves onto it again if they so desire.
		500
		501	This complements to the perl-eval command line option, but gets executed
		502	first.
		503
		504	=item @urxvt::TERM_EXT
		505
		506	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		507	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		508	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		509
534	=back	510	=back
535		511
536	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
537		513
538	=over 4	514	=over
539		515
540	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
541		517
542	Fatally aborts execution with the given error message. Avoid at all	518	Fatally aborts execution with the given error message (which should
543	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
544	starts up.	520	is acceptable (and useful) is in the init hook, where it prevents the
		521	terminal from starting up.
545		522
546	=item urxvt::warn $string	523	=item urxvt::warn $string
547		524
548	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
549	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
550	that calls this function.	527	that calls this function.
551		528
552	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
553	correct place, e.g. on stderr of the connecting urxvtc client.	530	correct place, e.g. on stderr of the connecting urxvtc client.
554		531
555	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).
556		540
557	=item $time = urxvt::NOW	541	=item $time = urxvt::NOW
558		542
559	Returns the "current time" (as per the event loop).	543	Returns the "current time" (as per the event loop).
560		544
…		…
580	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	564	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
581	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	565	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
582		566
583	Various constants for use in X calls and event processing.	567	Various constants for use in X calls and event processing.
584		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
585	=back	581	=back
586		582
587	=head2 RENDITION	583	=head2 RENDITION
588		584
589	Rendition bitsets contain information about colour, font, font styles and	585	Rendition bitsets contain information about colour, font, font styles and
…		…
592	The following "macros" deal with changes in rendition sets. You should	588	The following "macros" deal with changes in rendition sets. You should
593	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,
594	as they contain important information required for correct operation of	590	as they contain important information required for correct operation of
595	rxvt-unicode.	591	rxvt-unicode.
596		592
597	=over 4	593	=over
598		594
599	=item $rend = urxvt::DEFAULT_RSTYLE	595	=item $rend = urxvt::DEFAULT_RSTYLE
600		596
601	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
602	being reset. Useful as a base to start when creating renditions.	598	being reset. Useful as a base to start when creating renditions.
603		599
604	=item $rend = urxvt::OVERLAY_RSTYLE	600	=item $rend = urxvt::OVERLAY_RSTYLE
605		601
606	Return the rendition mask used for overlays by default.	602	Return the rendition mask used for overlays by default.
607		603
608	=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
609		606
610	Return the bit that enabled bold, italic, blink, reverse-video and	607	Return the bit that enabled bold, italic, blink, reverse-video and
611	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
612	the bitset.	609	the bitset.
613		610
…		…
618	Return the foreground/background colour index, respectively.	615	Return the foreground/background colour index, respectively.
619		616
620	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	617	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
621		618
622	=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
623		622
624	Replace the foreground/background colour in the rendition mask with the	623	Replace the foreground/background colour in the rendition mask with the
625	specified one.	624	specified one.
626		625
627	=item $value = urxvt::GET_CUSTOM $rend	626	=item $value = urxvt::GET_CUSTOM $rend
…		…
646	unless $msg =~ /\n$/;	645	unless $msg =~ /\n$/;
647	urxvt::warn ($msg);	646	urxvt::warn ($msg);
648	};	647	};
649	}	648	}
650		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
651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	718	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
652		719
653	sub verbose {	720	sub verbose {
654	my ($level, $msg) = @_;	721	my ($level, $msg) = @_;
655	warn "$msg\n" if $level <= $verbosity;	722	warn "$msg\n" if $level <= $verbosity;
656	}	723	}
…		…
658	my %extension_pkg;	725	my %extension_pkg;
659		726
660	# load a single script into its own package, once only	727	# load a single script into its own package, once only
661	sub extension_package($) {	728	sub extension_package($) {
662	my ($path) = @_;	729	my ($path) = @_;
663
664	no strict 'refs';
665		730
666	$extension_pkg{$path} ||= do {	731	$extension_pkg{$path} ||= do {
667	$path =~ /([^\/\\]+)$/;	732	$path =~ /([^\/\\]+)$/;
668	my $pkg = $1;	733	my $pkg = $1;
669	$pkg =~ s/[^[:word:]]/_/g;	734	$pkg =~ s/[^[:word:]]/_/g;
670	$pkg = "urxvt::ext::$pkg";	735	$pkg = "urxvt::ext::$pkg";
671		736
672	verbose 3, "loading extension '$path' into package '$pkg'";	737	verbose 3, "loading extension '$path' into package '$pkg'";
673		738
		739	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		740
674	open my $fh, "<:raw", $path	741	open my $fh, "<:raw", $path
675	or die "$path: $!";	742	or die "$path: $!";
676		743
677	@{"$pkg\::ISA"} = urxvt::term::extension::;
678
679	my $source =	744	my $source =
680	"package $pkg; use strict; use utf8;\n"	745	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
681	. "#line 1 \"$path\"\n{\n"	746	. "#line 1 \"$path\"\n{\n"
682	. (do { local $/; <$fh> })	747	. (do { local $/; <$fh> })
683	. "\n};\n1";	748	. "\n};\n1";
684		749
685	eval $source	750	eval $source
…		…
694	# called by the rxvt core	759	# called by the rxvt core
695	sub invoke {	760	sub invoke {
696	local $TERM = shift;	761	local $TERM = shift;
697	my $htype = shift;	762	my $htype = shift;
698		763
699	if ($htype == 0) { # INIT	764	if ($htype == HOOK_INIT) {
700	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	765	$TERM->scan_extensions;
701		766
702	my %ext_arg;	767	my %ext_arg;
703		768
		769	{
		770	my @init = @TERM_INIT;
		771	@TERM_INIT = ();
		772	$_->($TERM) for @init;
		773	my @pkg = @TERM_EXT;
		774	@TERM_EXT = ();
		775	$TERM->register_package ($_) for @pkg;
		776	}
		777
		778	for (
		779	@{ delete $TERM->{perl_ext_3} },
704	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	780	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		781	) {
705	if ($_ eq "default") {	782	if ($_ eq "default") {
		783
		784	$ext_arg{$_} = []
706	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	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
707	} elsif (/^-(.*)$/) {	796	} elsif (/^-(.*)$/) { # remove from set
708	delete $ext_arg{$1};	797	delete $ext_arg{$1};
709	} 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};
710	push @{ $ext_arg{$1} }, $2;	804	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		805
711	} else {	806	} else {
712	$ext_arg{$_} ||= [];	807	verbose 2, "cannot parse extension specification '$_', ignoring.";
713	}	808	}
714	}	809	}
715		810
716	while (my ($ext, $argv) = each %ext_arg) {	811	$TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
717	my @files = grep -f $_, map "$_/$ext", @dirs;	812	$TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
718		813
719	if (@files) {	814	for my $ext (sort keys %ext_arg) {
720	$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});
721	} else {	819	} else {
722	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";
723	}	821	}
724	}	822	}
725		823
726	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");
727	warn $@ if $@;	825	warn $@ if $@;
728	}	826	}
729		827
730	$retval = undef;	828	$retval = undef;
731		829
		830	if ($htype == HOOK_OSC_SEQ) {
		831	if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
		832	$TERM->autoload_extension ($_->[0]) for @$exts;
		833	}
		834	} elsif ($htype == HOOK_OSC_SEQ_PERL) {
		835	if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
		836	$TERM->autoload_extension ($_->[0]) for @$exts;
		837	}
		838	}
		839
732	if (my $cb = $TERM->{_hook}[$htype]) {	840	if (my $cb = $TERM->{_hook}[$htype]) {
733	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	841	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
734	if $verbosity >= 10;	842	if $verbosity >= 10;
735		843
736	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";
737		850
738	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) {
739	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	858	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
740	and last;	859	$retval ||= $retval_;
741		860
742	if ($@) {	861	if ($@) {
743	$TERM->ungrab; # better to lose the grab than the session	862	$TERM->ungrab; # better to lose the grab than the session
744	warn $@;	863	warn $@;
745	}	864	}
…		…
747		866
748	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	867	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
749	if $verbosity >= 11;	868	if $verbosity >= 11;
750	}	869	}
751		870
752	if ($htype == 1) { # DESTROY	871	if ($htype == HOOK_DESTROY) {
753	# clear package objects	872	# clear package objects
754	%$_ = () for values %{ $TERM->{_pkg} };	873	%$_ = () for values %{ $TERM->{_pkg} };
755		874
756	# clear package	875	# clear package
757	%$TERM = ();	876	%$TERM = ();
758	}	877	}
759		878
760	$retval	879	$retval
761	}	880	}
762		881
763	# 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	}
764		910
765	package urxvt::term::extension;	911	package urxvt::term::extension;
766		912
767	sub enable {	913	=head2 The C<urxvt::term::extension> class
768	my ($self, %hook) = @_;
769	my $pkg = $self->{_pkg};
770		914
771	while (my ($name, $cb) = each %hook) {	915	Each extension attached to a terminal object is represented by
772	my $htype = $HOOKTYPE{uc $name};	916	a C<urxvt::term::extension> object.
773	defined $htype
774	or Carp::croak "unsupported hook type '$name'";
775		917
776	$self->set_should_invoke ($htype, +1)	918	You can use these objects, which are passed to all callbacks to store any
777	unless exists $self->{term}{_hook}[$htype]{$pkg};	919	state related to the terminal and extension instance.
778		920
779	$self->{term}{_hook}[$htype]{$pkg} = $cb;	921	The methods (And data members) documented below can be called on extension
780	}	922	objects, in addition to call methods documented for the <urxvt::term>
781	}	923	class.
782		924
783	sub disable {	925	=over
784	my ($self, @hook) = @_;
785	my $pkg = $self->{_pkg};
786		926
787	for my $name (@hook) {	927	=item $urxvt_term = $self->{term}
788	my $htype = $HOOKTYPE{uc $name};
789	defined $htype
790	or Carp::croak "unsupported hook type '$name'";
791		928
792	$self->set_should_invoke ($htype, -1)	929	Returns the C<urxvt::term> object associated with this instance of the
793	if delete $self->{term}{_hook}[$htype]{$pkg};	930	extension. This member I<must not> be changed in any way.
794	}	931
795	}	932	=cut
796		933
797	our $AUTOLOAD;	934	our $AUTOLOAD;
798		935
799	sub AUTOLOAD {	936	sub AUTOLOAD {
800	$AUTOLOAD =~ /:([^:]+)$/	937	$AUTOLOAD =~ /:([^:]+)$/
…		…
813		950
814	sub DESTROY {	951	sub DESTROY {
815	# nop	952	# nop
816	}	953	}
817		954
818	# urxvt::destroy_hook	955	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
819		956
820	sub urxvt::destroy_hook::DESTROY {	957	sub urxvt::destroy_hook::DESTROY {
821	${$_[0]}->();	958	${$_[0]}->();
822	}	959	}
823		960
824	sub urxvt::destroy_hook(&) {	961	sub urxvt::destroy_hook(&) {
825	bless \shift, urxvt::destroy_hook::	962	bless \shift, urxvt::destroy_hook::
826	}	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
827		1087
828	package urxvt::anyevent;	1088	package urxvt::anyevent;
829		1089
830	=head2 The C<urxvt::anyevent> Class	1090	=head2 The C<urxvt::anyevent> Class
831		1091
832	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
833	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
834	further programming. The only exception is that you cannot wait on	1094	further programming. The only exception is that you cannot wait on
835	condition variables, but non-blocking condvar use is ok. What this means	1095	condition variables, but non-blocking condvar use is ok.
836	is that you cannot use blocking APIs, but the non-blocking variant should
837	work.
838		1096
839	=cut	1097	In practical terms this means is that you cannot use blocking APIs, but
		1098	the non-blocking variant should work.
840		1099
		1100	=cut
		1101
841	our $VERSION = 1;	1102	our $VERSION = '5.23';
842		1103
843	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1104	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
844	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1105	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
845		1106
846	sub timer {	1107	sub timer {
…		…
848		1109
849	my $cb = $arg{cb};	1110	my $cb = $arg{cb};
850		1111
851	urxvt::timer	1112	urxvt::timer
852	->new	1113	->new
853	->start (urxvt::NOW + $arg{after})	1114	->after ($arg{after}, $arg{interval})
854	->cb (sub {	1115	->cb ($arg{interval} ? $cb : sub {
855	$_[0]->stop; # need to cancel manually	1116	$_[0]->stop; # need to cancel manually
856	$cb->();	1117	$cb->();
857	})	1118	})
858	}	1119	}
859		1120
860	sub io {	1121	sub io {
861	my ($class, %arg) = @_;	1122	my ($class, %arg) = @_;
862		1123
863	my $cb = $arg{cb};	1124	my $cb = $arg{cb};
		1125	my $fd = fileno $arg{fh};
		1126	defined $fd or $fd = $arg{fh};
864		1127
865	bless [$arg{fh}, urxvt::iow	1128	bless [$arg{fh}, urxvt::iow
866	->new	1129	->new
867	->fd (fileno $arg{fh})	1130	->fd ($fd)
868	->events (($arg{poll} =~ /r/ ? 1 : 0)	1131	->events (($arg{poll} =~ /r/ ? 1 : 0)
869	| ($arg{poll} =~ /w/ ? 2 : 0))	1132	| ($arg{poll} =~ /w/ ? 2 : 0))
870	->start	1133	->start
871	->cb (sub {	1134	->cb ($cb)
872	$cb->(($_[1] & 1 ? 'r' : '')
873	. ($_[1] & 2 ? 'w' : ''));
874	})],
875	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	})
876	}	1161	}
877		1162
878	sub DESTROY {	1163	sub DESTROY {
879	$_[0][1]->stop;	1164	$_[0][1]->stop;
880	}	1165	}
881		1166
882	sub condvar {	1167	# only needed for AnyEvent < 6 compatibility
883	bless \my $flag, urxvt::anyevent::condvar::	1168	sub one_event {
884	}
885
886	sub urxvt::anyevent::condvar::broadcast {
887	${$_[0]}++;
888	}
889
890	sub urxvt::anyevent::condvar::wait {
891	unless (${$_[0]}) {
892	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";
893	}
894	}	1170	}
895		1171
896	package urxvt::term;	1172	package urxvt::term;
897		1173
898	=head2 The C<urxvt::term> Class	1174	=head2 The C<urxvt::term> Class
899		1175
900	=over 4	1176	=over
901		1177
902	=cut	1178	=cut
903		1179
904	# find on_xxx subs in the package and register them	1180	# find on_xxx subs in the package and register them
905	# as hooks	1181	# as hooks
906	sub register_package {	1182	sub register_package {
907	my ($self, $pkg, $argv) = @_;	1183	my ($self, $pkg, $argv) = @_;
908		1184
		1185	no strict 'refs';
		1186
		1187	urxvt::verbose 6, "register package $pkg to $self";
		1188
		1189	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1190
909	my $proxy = bless {	1191	my $proxy = bless {
910	_pkg => $pkg,	1192	_pkg => $pkg,
		1193	_name => ${"$pkg\::_NAME"}, # hackish
911	argv => $argv,	1194	argv => $argv,
912	}, $pkg;	1195	}, $pkg;
913	Scalar::Util::weaken ($proxy->{term} = $self);	1196	Scalar::Util::weaken ($proxy->{term} = $self);
914		1197
915	$self->{_pkg}{$pkg} = $proxy;	1198	$self->{_pkg}{$pkg} = $proxy;
916		1199
…		…
919	$proxy->enable ($name => $ref);	1202	$proxy->enable ($name => $ref);
920	}	1203	}
921	}	1204	}
922	}	1205	}
923		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
924	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1314	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
925		1315
926	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
927	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
928	hash which defines the environment of the new terminal.	1318	hash which defines the environment of the new terminal.
929		1319
930	Croaks (and probably outputs an error message) if the new instance	1320	Croaks (and probably outputs an error message) if the new instance
931	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
932	initialise perl, and the terminal object otherwise. The C<init> and	1322	initialise perl, and the terminal object otherwise. The C<init> and
933	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).
934		1325
935	=cut	1326	=cut
936		1327
937	sub new {	1328	sub new {
938	my ($class, $env, @args) = @_;	1329	my ($class, $env, @args) = @_;
939		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
940	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1334	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
941	}	1335	}
942		1336
943	=item $term->destroy	1337	=item $term->destroy
944		1338
945	Destroy the terminal object (close the window, free resources	1339	Destroy the terminal object (close the window, free resources
946	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
947	watchers (timers, io watchers) are still active.	1341	watchers (timers, io watchers) are still active.
948		1342
949	=item $term->exec_async ($cmd[, @args])	1343	=item $term->exec_async ($cmd[, @args])
950		1344
951	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
…		…
975		1369
976	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
977	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
978	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.
979		1373
980	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
981	source file F</src/optinc.h> to see the actual list:	1375	source file F</src/optinc.h> to see the actual list:
982		1376
983	borderLess console cursorBlink cursorUnderline hold iconic insecure	1377	borderLess buffered console cursorBlink cursorUnderline hold iconic
984	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1378	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
985	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1379	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
986	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1380	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
987	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1381	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
988	transparent tripleclickwords utmpInhibit visualBell	1382	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1383	urgentOnBell utmpInhibit visualBell disablePasteBrackets
989		1384
990	=item $value = $term->resource ($name[, $newval])	1385	=item $value = $term->resource ($name[, $newval])
991		1386
992	Returns the current resource value associated with a given name and	1387	Returns the current resource value associated with a given name and
993	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>
…		…
1002	likely change).	1397	likely change).
1003		1398
1004	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
1005	terminal is destroyed, so changing options frequently will eat memory.	1400	terminal is destroyed, so changing options frequently will eat memory.
1006		1401
1007	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
1008	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>
1009	to see the actual list:	1404	to see the actual list:
1010		1405
1011	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1406	answerbackstring backgroundPixmap backspace_key blurradius
1012	borderLess color cursorBlink cursorUnderline cutchars delete_key	1407	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1013	display_name embed ext_bwidth fade font geometry hold iconName	1408	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1014	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
1015	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1411	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1016	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1412	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1017	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1413	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1018	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1414	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1019	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1415	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1020	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1416	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1021	secondaryScreen secondaryScroll selectstyle shade term_name title	1417	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1022	transient_for transparent transparent_all tripleclickwords utmpInhibit	1418	term_name title transient_for transparent tripleclickwords urgentOnBell
1023	visualBell	1419	utmpInhibit visualBell rewrapMode disablePasteBrackets
1024		1420
1025	=cut	1421	=cut
1026		1422
1027	sub resource($$;$) {	1423	sub resource($$;$) {
1028	my ($self, $name) = (shift, shift);	1424	my ($self, $name) = (shift, shift);
1029	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1425	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1030	&urxvt::term::_resource	1426	goto &urxvt::term::_resource
1031	}	1427	}
1032		1428
1033	=item $value = $term->x_resource ($pattern)	1429	=item $value = $term->x_resource ($pattern)
1034		1430
1035	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
1036	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
1037	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
1038	resource with that pattern exists.	1434	resource with that pattern exists.
1039		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
1040	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
1041	only one resource database per display, and later invocations might return	1447	only one resource database per display, and later invocations might return
1042	the wrong resources.	1448	the wrong resources.
1043		1449
1044	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1450	=item $value = $term->x_resource_boolean ($pattern)
1045		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
1046	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
1047	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	}
1048		1490
1049	=item $rend = $term->rstyle ([$new_rstyle])	1491	=item $rend = $term->rstyle ([$new_rstyle])
1050		1492
1051	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
1052	the terminal application will use this style.	1494	the terminal application will use this style.
…		…
1060		1502
1061	=item ($row, $col) = $term->selection_beg ([$row, $col])	1503	=item ($row, $col) = $term->selection_beg ([$row, $col])
1062		1504
1063	=item ($row, $col) = $term->selection_end ([$row, $col])	1505	=item ($row, $col) = $term->selection_end ([$row, $col])
1064		1506
1065	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.
1066	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.
1067		1516
1068	=item $term->selection_make ($eventtime[, $rectangular])	1517	=item $term->selection_make ($eventtime[, $rectangular])
1069		1518
1070	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
1071	C<selection_end>. If C<$rectangular> is true (default: false), a	1520	C<selection_end>. If C<$rectangular> is true (default: false), a
1072	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
1073	a selection.	1522	a selection.
1074		1523
1075	=item $success = $term->selection_grab ($eventtime)	1524	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1076		1525
1077	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
1078	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
1079	is mostly useful from within C<on_sel_grab> hooks.	1529	is mostly useful from within C<on_sel_grab> hooks.
1080		1530
1081	=item $oldtext = $term->selection ([$newtext])	1531	=item $oldtext = $term->selection ([$newtext, $clipboard])
1082		1532
1083	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.
1084		1539
1085	=item $term->overlay_simple ($x, $y, $text)	1540	=item $term->overlay_simple ($x, $y, $text)
1086		1541
1087	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.
1088		1543
…		…
1116	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
1117	as long as the perl object is referenced.	1572	as long as the perl object is referenced.
1118		1573
1119	The methods currently supported on C<urxvt::overlay> objects are:	1574	The methods currently supported on C<urxvt::overlay> objects are:
1120		1575
1121	=over 4	1576	=over
1122		1577
1123	=item $overlay->set ($x, $y, $text, $rend)	1578	=item $overlay->set ($x, $y, $text[, $rend])
1124		1579
1125	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
1126	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
1127	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.
1128		1585
1129	=item $overlay->hide	1586	=item $overlay->hide
1130		1587
1131	If visible, hide the overlay, but do not destroy it.	1588	If visible, hide the overlay, but do not destroy it.
1132		1589
…		…
1195		1652
1196	=item $term->scr_add_lines ($string)	1653	=item $term->scr_add_lines ($string)
1197		1654
1198	Write the given text string to the screen, as if output by the application	1655	Write the given text string to the screen, as if output by the application
1199	running inside the terminal. It may not contain command sequences (escape	1656	running inside the terminal. It may not contain command sequences (escape
1200	codes), but is free to use line feeds, carriage returns and tabs. The	1657	codes - see C<cmd_parse> for that), but is free to use line feeds,
1201	string is a normal text string, not in locale-dependent encoding.	1658	carriage returns and tabs. The string is a normal text string, not in
		1659	locale-dependent encoding.
1202		1660
1203	Normally its not a good idea to use this function, as programs might be	1661	Normally its not a good idea to use this function, as programs might be
1204	confused by changes in cursor position or scrolling. Its useful inside a	1662	confused by changes in cursor position or scrolling. Its useful inside a
1205	C<on_add_lines> hook, though.	1663	C<on_add_lines> hook, though.
1206		1664
		1665	=item $term->scr_change_screen ($screen)
		1666
		1667	Switch to given screen - 0 primary, 1 secondary.
		1668
1207	=item $term->cmd_parse ($octets)	1669	=item $term->cmd_parse ($octets)
1208		1670
1209	Similar to C<scr_add_lines>, but the argument must be in the	1671	Similar to C<scr_add_lines>, but the argument must be in the
1210	locale-specific encoding of the terminal and can contain command sequences	1672	locale-specific encoding of the terminal and can contain command sequences
1211	(escape codes) that will be interpreted.	1673	(escape codes) that will be interpreted.
1212		1674
1213	=item $term->tt_write ($octets)	1675	=item $term->tt_write ($octets)
1214		1676
1215	Write the octets given in C<$data> to the tty (i.e. as program input). To	1677	Write the octets given in C<$octets> to the tty (i.e. as user input
		1678	to the program, see C<cmd_parse> for the opposite direction). To pass
1216	pass characters instead of octets, you should convert your strings first	1679	characters instead of octets, you should convert your strings first to the
1217	to the locale-specific encoding using C<< $term->locale_encode >>.	1680	locale-specific encoding using C<< $term->locale_encode >>.
		1681
		1682	=item $term->tt_write_user_input ($octets)
		1683
		1684	Like C<tt_write>, but should be used when writing strings in response to
		1685	the user pressing a key, to invoke the additional actions requested by
		1686	the user for that case (C<tt_write> doesn't do that).
		1687
		1688	The typical use case would be inside C<on_action> hooks.
		1689
		1690	=item $term->tt_paste ($octets)
		1691
		1692	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1693	CR and bracketing the data with control sequences if bracketed paste mode
		1694	is set.
1218		1695
1219	=item $old_events = $term->pty_ev_events ([$new_events])	1696	=item $old_events = $term->pty_ev_events ([$new_events])
1220		1697
1221	Replaces the event mask of the pty watcher by the given event mask. Can	1698	Replaces the event mask of the pty watcher by the given event mask. Can
1222	be used to suppress input and output handling to the pty/tty. See the	1699	be used to suppress input and output handling to the pty/tty. See the
1223	description of C<< urxvt::timer->events >>. Make sure to always restore	1700	description of C<< urxvt::timer->events >>. Make sure to always restore
1224	the previous value.	1701	the previous value.
1225		1702
		1703	=item $fd = $term->pty_fd
		1704
		1705	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1706	is used.
		1707
1226	=item $windowid = $term->parent	1708	=item $windowid = $term->parent
1227		1709
1228	Return the window id of the toplevel window.	1710	Return the window id of the toplevel window.
1229		1711
1230	=item $windowid = $term->vt	1712	=item $windowid = $term->vt
…		…
1236	Adds the specified events to the vt event mask. Useful e.g. when you want	1718	Adds the specified events to the vt event mask. Useful e.g. when you want
1237	to receive pointer events all the times:	1719	to receive pointer events all the times:
1238		1720
1239	$term->vt_emask_add (urxvt::PointerMotionMask);	1721	$term->vt_emask_add (urxvt::PointerMotionMask);
1240		1722
		1723	=item $term->set_urgency ($set)
		1724
		1725	Enable/disable the urgency hint on the toplevel window.
		1726
		1727	=item $term->focus_in
		1728
		1729	=item $term->focus_out
		1730
		1731	=item $term->key_press ($state, $keycode[, $time])
		1732
		1733	=item $term->key_release ($state, $keycode[, $time])
		1734
		1735	Deliver various fake events to to terminal.
		1736
1241	=item $window_width = $term->width	1737	=item $window_width = $term->width ([$new_value])
1242		1738
1243	=item $window_height = $term->height	1739	=item $window_height = $term->height ([$new_value])
1244		1740
1245	=item $font_width = $term->fwidth	1741	=item $font_width = $term->fwidth ([$new_value])
1246		1742
1247	=item $font_height = $term->fheight	1743	=item $font_height = $term->fheight ([$new_value])
1248		1744
1249	=item $font_ascent = $term->fbase	1745	=item $font_ascent = $term->fbase ([$new_value])
1250		1746
1251	=item $terminal_rows = $term->nrow	1747	=item $terminal_rows = $term->nrow ([$new_value])
1252		1748
1253	=item $terminal_columns = $term->ncol	1749	=item $terminal_columns = $term->ncol ([$new_value])
1254		1750
1255	=item $has_focus = $term->focus	1751	=item $has_focus = $term->focus ([$new_value])
1256		1752
1257	=item $is_mapped = $term->mapped	1753	=item $is_mapped = $term->mapped ([$new_value])
1258		1754
1259	=item $max_scrollback = $term->saveLines	1755	=item $max_scrollback = $term->saveLines ([$new_value])
1260		1756
1261	=item $nrow_plus_saveLines = $term->total_rows	1757	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1262		1758
1263	=item $topmost_scrollback_row = $term->top_row	1759	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1264		1760
1265	Return various integers describing terminal characteristics.	1761	Return various integers describing terminal characteristics. If an
		1762	argument is given, changes the value and returns the previous one.
1266		1763
1267	=item $x_display = $term->display_id	1764	=item $x_display = $term->display_id
1268		1765
1269	Return the DISPLAY used by rxvt-unicode.	1766	Return the DISPLAY used by rxvt-unicode.
1270		1767
…		…
1275	=item $env = $term->env	1772	=item $env = $term->env
1276		1773
1277	Returns a copy of the environment in effect for the terminal as a hashref	1774	Returns a copy of the environment in effect for the terminal as a hashref
1278	similar to C<\%ENV>.	1775	similar to C<\%ENV>.
1279		1776
		1777	=item @envv = $term->envv
		1778
		1779	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1780
		1781	=item @argv = $term->argv
		1782
		1783	Return the argument vector as this terminal, similar to @ARGV, but
		1784	includes the program name as first element.
		1785
1280	=cut	1786	=cut
1281		1787
1282	sub env {	1788	sub env {
1283	if (my $env = $_[0]->_env) {
1284	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1789	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1285	} else {
1286	+{ %ENV }
1287	}
1288	}	1790	}
1289		1791
1290	=item $modifiermask = $term->ModLevel3Mask	1792	=item $modifiermask = $term->ModLevel3Mask
1291		1793
1292	=item $modifiermask = $term->ModMetaMask	1794	=item $modifiermask = $term->ModMetaMask
…		…
1294	=item $modifiermask = $term->ModNumLockMask	1796	=item $modifiermask = $term->ModNumLockMask
1295		1797
1296	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1798	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1297	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1799	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1298		1800
		1801	=item $screen = $term->current_screen
		1802
		1803	Returns the currently displayed screen (0 primary, 1 secondary).
		1804
		1805	=item $cursor_is_hidden = $term->hidden_cursor
		1806
		1807	Returns whether the cursor is currently hidden or not.
		1808
		1809	=item $priv_modes = $term->priv_modes
		1810
		1811	Returns a bitset with the state of DEC private modes.
		1812
		1813	Example:
		1814
		1815	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1816	# mouse reporting is turned on
		1817	}
		1818
1299	=item $view_start = $term->view_start ([$newvalue])	1819	=item $view_start = $term->view_start ([$newvalue])
1300		1820
1301	Returns the row number of the topmost displayed line. Maximum value is	1821	Returns the row number of the topmost displayed line and changes it,
1302	C<0>, which displays the normal terminal contents. Lower values scroll	1822	if an argument is given. Values greater than or equal to C<0> display
1303	this many lines into the scrollback buffer.	1823	the terminal contents. Lower values scroll this many lines into the
		1824	scrollback buffer.
1304		1825
1305	=item $term->want_refresh	1826	=item $term->want_refresh
1306		1827
1307	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1828	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1308	compare the on-screen display with its stored representation. If they	1829	compare the on-screen display with its stored representation. If they
1309	differ, it redraws the differences.	1830	differ, it redraws the differences.
1310		1831
1311	Used after changing terminal contents to display them.	1832	Used after changing terminal contents to display them.
1312		1833
		1834	=item $term->refresh_check
		1835
		1836	Checks if a refresh has been requested and, if so, schedules one.
		1837
1313	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1838	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1314		1839
1315	Returns the text of the entire row with number C<$row_number>. Row C<0>	1840	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1316	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1841	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1317	terminal line. The scrollback buffer starts at line C<-1> and extends to
1318	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1842	terminal line. Nothing will be returned if a nonexistent line
1319	is requested.	1843	is requested.
1320		1844
1321	If C<$new_text> is specified, it will replace characters in the current	1845	If C<$new_text> is specified, it will replace characters in the current
1322	line, starting at column C<$start_col> (default C<0>), which is useful	1846	line, starting at column C<$start_col> (default C<0>), which is useful
1323	to replace only parts of a line. The font index in the rendition will	1847	to replace only parts of a line. The font index in the rendition will
1324	automatically be updated.	1848	automatically be updated.
1325		1849
1326	C<$text> is in a special encoding: tabs and wide characters that use more	1850	C<$text> is in a special encoding: tabs and wide characters that use more
1327	than one cell when displayed are padded with urxvt::NOCHAR characters	1851	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1328	(C<chr 65535>). Characters with combining characters and other characters	1852	characters. Characters with combining characters and other characters that
1329	that do not fit into the normal tetx encoding will be replaced with	1853	do not fit into the normal text encoding will be replaced with characters
1330	characters in the private use area.	1854	in the private use area.
1331		1855
1332	You have to obey this encoding when changing text. The advantage is	1856	You have to obey this encoding when changing text. The advantage is
1333	that C<substr> and similar functions work on screen cells and not on	1857	that C<substr> and similar functions work on screen cells and not on
1334	characters.	1858	characters.
1335		1859
…		…
1363		1887
1364	Create and return a new C<urxvt::line> object that stores information	1888	Create and return a new C<urxvt::line> object that stores information
1365	about the logical line that row C<$row_number> is part of. It supports the	1889	about the logical line that row C<$row_number> is part of. It supports the
1366	following methods:	1890	following methods:
1367		1891
1368	=over 4	1892	=over
1369		1893
1370	=item $text = $line->t ([$new_text])	1894	=item $text = $line->t ([$new_text])
1371		1895
1372	Returns or replaces the full text of the line, similar to C<ROW_t>	1896	Returns or replaces the full text of the line, similar to C<ROW_t>
1373		1897
…		…
1419	}	1943	}
1420		1944
1421	sub urxvt::line::t {	1945	sub urxvt::line::t {
1422	my ($self) = @_;	1946	my ($self) = @_;
1423		1947
1424	if (@_ > 1)	1948	if (@_ > 1) {
1425	{
1426	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1949	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1427	for $self->{beg} .. $self->{end};	1950	for $self->{beg} .. $self->{end};
1428	}	1951	}
1429		1952
1430	defined wantarray &&	1953	defined wantarray &&
1431	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1954	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1432	0, $self->{len}	1955	0, $self->{len}
1433	}	1956	}
1434		1957
1435	sub urxvt::line::r {	1958	sub urxvt::line::r {
1436	my ($self) = @_;	1959	my ($self) = @_;
1437		1960
1438	if (@_ > 1)	1961	if (@_ > 1) {
1439	{
1440	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1962	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1441	for $self->{beg} .. $self->{end};	1963	for $self->{beg} .. $self->{end};
1442	}	1964	}
1443		1965
1444	if (defined wantarray) {	1966	if (defined wantarray) {
1445	my $rend = [	1967	my $rend = [
1446	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1968	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1447	];	1969	];
…		…
1479	where one character corresponds to one screen cell. See	2001	where one character corresponds to one screen cell. See
1480	C<< $term->ROW_t >> for details.	2002	C<< $term->ROW_t >> for details.
1481		2003
1482	=item $string = $term->special_decode $text	2004	=item $string = $term->special_decode $text
1483		2005
1484	Converts rxvt-unicodes text reprsentation into a perl string. See	2006	Converts rxvt-unicode's text representation into a perl string. See
1485	C<< $term->ROW_t >> for details.	2007	C<< $term->ROW_t >> for details.
1486		2008
1487	=item $success = $term->grab_button ($button, $modifiermask)	2009	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1488		2010
		2011	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2012
1489	Registers a synchronous button grab. See the XGrabButton manpage.	2013	Register/unregister a synchronous button grab. See the XGrabButton
		2014	manpage.
1490		2015
1491	=item $success = $term->grab ($eventtime[, $sync])	2016	=item $success = $term->grab ($eventtime[, $sync])
1492		2017
1493	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2018	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1494	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2019	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1495		2020
1496	=item $term->allow_events_async	2021	=item $term->allow_events_async
1497		2022
1498	Calls XAllowEvents with AsyncBoth for the most recent grab.	2023	Calls XAllowEvents with AsyncBoth for the most recent grab.
1499		2024
…		…
1506	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2031	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1507	recent grab.	2032	recent grab.
1508		2033
1509	=item $term->ungrab	2034	=item $term->ungrab
1510		2035
1511	Calls XUngrab for the most recent grab. Is called automatically on	2036	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1512	evaluation errors, as it is better to lose the grab in the error case as	2037	evaluation errors, as it is better to lose the grab in the error case as
1513	the session.	2038	the session.
1514		2039
		2040	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2041
		2042	=item $atom_name = $term->XGetAtomName ($atom)
		2043
		2044	=item @atoms = $term->XListProperties ($window)
		2045
		2046	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2047
		2048	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2049
		2050	=item $term->XDeleteProperty ($window, $property)
		2051
		2052	=item $window = $term->DefaultRootWindow
		2053
		2054	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2055
		2056	=item $term->XMapWindow ($window)
		2057
		2058	=item $term->XUnmapWindow ($window)
		2059
		2060	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2061
		2062	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2063
		2064	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2065
		2066	=item $keysym = $term->XStringToKeysym ($string)
		2067
		2068	=item $string = $term->XKeysymToString ($keysym)
		2069
		2070	Various X or X-related functions. The C<$term> object only serves as
		2071	the source of the display, otherwise those functions map more-or-less
		2072	directly onto the X functions of the same name.
		2073
1515	=back	2074	=back
1516		2075
1517	=cut	2076	=cut
1518		2077
1519	package urxvt::popup;	2078	package urxvt::popup;
1520		2079
1521	=head2 The C<urxvt::popup> Class	2080	=head2 The C<urxvt::popup> Class
1522		2081
1523	=over 4	2082	=over
1524		2083
1525	=cut	2084	=cut
1526		2085
1527	sub add_item {	2086	sub add_item {
1528	my ($self, $item) = @_;	2087	my ($self, $item) = @_;
…		…
1582	my ($self, $text, $cb) = @_;	2141	my ($self, $text, $cb) = @_;
1583		2142
1584	$self->add_item ({ type => "button", text => $text, activate => $cb});	2143	$self->add_item ({ type => "button", text => $text, activate => $cb});
1585	}	2144	}
1586		2145
1587	=item $popup->add_toggle ($text, $cb, $initial_value)	2146	=item $popup->add_toggle ($text, $initial_value, $cb)
1588		2147
1589	Adds a toggle/checkbox item to the popup. Teh callback gets called	2148	Adds a toggle/checkbox item to the popup. The callback gets called
1590	whenever it gets toggled, with a boolean indicating its value as its first	2149	whenever it gets toggled, with a boolean indicating its new value as its
1591	argument.	2150	first argument.
1592		2151
1593	=cut	2152	=cut
1594		2153
1595	sub add_toggle {	2154	sub add_toggle {
1596	my ($self, $text, $cb, $value) = @_;	2155	my ($self, $text, $value, $cb) = @_;
1597		2156
1598	my $item; $item = {	2157	my $item; $item = {
1599	type => "button",	2158	type => "button",
1600	text => " $text",	2159	text => " $text",
1601	value => $value,	2160	value => $value,
…		…
1620	my $env = $self->{term}->env;	2179	my $env = $self->{term}->env;
1621	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2180	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1622	delete $env->{LC_ALL};	2181	delete $env->{LC_ALL};
1623	$env->{LC_CTYPE} = $self->{term}->locale;	2182	$env->{LC_CTYPE} = $self->{term}->locale;
1624		2183
1625	urxvt::term->new ($env, "popup",	2184	my $term = urxvt::term->new (
		2185	$env, "popup",
1626	"--perl-lib" => "", "--perl-ext-common" => "",	2186	"--perl-lib" => "", "--perl-ext-common" => "",
1627	"-pty-fd" => -1, "-sl" => 0,	2187	"-pty-fd" => -1, "-sl" => 0,
1628	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2188	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1629	"--transient-for" => $self->{term}->parent,	2189	"--transient-for" => $self->{term}->parent,
1630	"-display" => $self->{term}->display_id,	2190	"-display" => $self->{term}->display_id,
1631	"-pe" => "urxvt-popup")	2191	"-pe" => "urxvt-popup",
1632	or die "unable to create popup window\n";	2192	) or die "unable to create popup window\n";
		2193
		2194	unless (delete $term->{urxvt_popup_init_done}) {
		2195	$term->ungrab;
		2196	$term->destroy;
		2197	die "unable to initialise popup window\n";
		2198	}
1633	}	2199	}
1634		2200
1635	sub DESTROY {	2201	sub DESTROY {
1636	my ($self) = @_;	2202	my ($self) = @_;
1637		2203
1638	delete $self->{term}{_destroy}{$self};	2204	delete $self->{term}{_destroy}{$self};
1639	$self->{term}->ungrab;	2205	$self->{term}->ungrab;
1640	}	2206	}
1641		2207
1642	=back	2208	=back
		2209
		2210	=cut
		2211
		2212	package urxvt::watcher;
1643		2213
1644	=head2 The C<urxvt::timer> Class	2214	=head2 The C<urxvt::timer> Class
1645		2215
1646	This class implements timer watchers/events. Time is represented as a	2216	This class implements timer watchers/events. Time is represented as a
1647	fractional number of seconds since the epoch. Example:	2217	fractional number of seconds since the epoch. Example:
…		…
1651	->new	2221	->new
1652	->interval (1)	2222	->interval (1)
1653	->cb (sub {	2223	->cb (sub {
1654	$term->{overlay}->set (0, 0,	2224	$term->{overlay}->set (0, 0,
1655	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2225	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1656	});	2226	});
1657		2227
1658	=over 4	2228	=over
1659		2229
1660	=item $timer = new urxvt::timer	2230	=item $timer = new urxvt::timer
1661		2231
1662	Create a new timer object in started state. It is scheduled to fire	2232	Create a new timer object in started state. It is scheduled to fire
1663	immediately.	2233	immediately.
1664		2234
1665	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2235	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1666		2236
1667	Set the callback to be called when the timer triggers.	2237	Set the callback to be called when the timer triggers.
1668		2238
1669	=item $tstamp = $timer->at
1670
1671	Return the time this watcher will fire next.
1672
1673	=item $timer = $timer->set ($tstamp)	2239	=item $timer = $timer->set ($tstamp[, $interval])
1674		2240
1675	Set the time the event is generated to $tstamp.	2241	Set the time the event is generated to $tstamp (and optionally specifies a
		2242	new $interval).
1676		2243
1677	=item $timer = $timer->interval ($interval)	2244	=item $timer = $timer->interval ($interval)
1678		2245
1679	Normally (and when C<$interval> is C<0>), the timer will automatically	2246	By default (and when C<$interval> is C<0>), the timer will automatically
1680	stop after it has fired once. If C<$interval> is non-zero, then the timer	2247	stop after it has fired once. If C<$interval> is non-zero, then the timer
1681	is automatically rescheduled at the given intervals.	2248	is automatically rescheduled at the given intervals.
1682		2249
1683	=item $timer = $timer->start	2250	=item $timer = $timer->start
1684		2251
1685	Start the timer.	2252	Start the timer.
1686		2253
1687	=item $timer = $timer->start ($tstamp)	2254	=item $timer = $timer->start ($tstamp[, $interval])
1688		2255
1689	Set the event trigger time to C<$tstamp> and start the timer.	2256	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2257	also replaces the interval.
1690		2258
1691	=item $timer = $timer->after ($delay)	2259	=item $timer = $timer->after ($delay[, $interval])
1692		2260
1693	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2261	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1694		2262
1695	=item $timer = $timer->stop	2263	=item $timer = $timer->stop
1696		2264
…		…
1704		2272
1705	$term->{socket} = ...	2273	$term->{socket} = ...
1706	$term->{iow} = urxvt::iow	2274	$term->{iow} = urxvt::iow
1707	->new	2275	->new
1708	->fd (fileno $term->{socket})	2276	->fd (fileno $term->{socket})
1709	->events (urxvt::EVENT_READ)	2277	->events (urxvt::EV_READ)
1710	->start	2278	->start
1711	->cb (sub {	2279	->cb (sub {
1712	my ($iow, $revents) = @_;	2280	my ($iow, $revents) = @_;
1713	# $revents must be 1 here, no need to check	2281	# $revents must be 1 here, no need to check
1714	sysread $term->{socket}, my $buf, 8192	2282	sysread $term->{socket}, my $buf, 8192
1715	or end-of-file;	2283	or end-of-file;
1716	});	2284	});
1717		2285
1718		2286
1719	=over 4	2287	=over
1720		2288
1721	=item $iow = new urxvt::iow	2289	=item $iow = new urxvt::iow
1722		2290
1723	Create a new io watcher object in stopped state.	2291	Create a new io watcher object in stopped state.
1724		2292
…		…
1727	Set the callback to be called when io events are triggered. C<$reventmask>	2295	Set the callback to be called when io events are triggered. C<$reventmask>
1728	is a bitset as described in the C<events> method.	2296	is a bitset as described in the C<events> method.
1729		2297
1730	=item $iow = $iow->fd ($fd)	2298	=item $iow = $iow->fd ($fd)
1731		2299
1732	Set the filedescriptor (not handle) to watch.	2300	Set the file descriptor (not handle) to watch.
1733		2301
1734	=item $iow = $iow->events ($eventmask)	2302	=item $iow = $iow->events ($eventmask)
1735		2303
1736	Set the event mask to watch. The only allowed values are	2304	Set the event mask to watch. The only allowed values are
1737	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2305	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1738	together, or C<urxvt::EVENT_NONE>.	2306	together, or C<urxvt::EV_NONE>.
1739		2307
1740	=item $iow = $iow->start	2308	=item $iow = $iow->start
1741		2309
1742	Start watching for requested events on the given handle.	2310	Start watching for requested events on the given handle.
1743		2311
1744	=item $iow = $iow->stop	2312	=item $iow = $iow->stop
1745		2313
1746	Stop watching for events on the given filehandle.	2314	Stop watching for events on the given file handle.
		2315
		2316	=back
		2317
		2318	=head2 The C<urxvt::iw> Class
		2319
		2320	This class implements idle watchers, that get called automatically when
		2321	the process is idle. They should return as fast as possible, after doing
		2322	some useful work.
		2323
		2324	=over
		2325
		2326	=item $iw = new urxvt::iw
		2327
		2328	Create a new idle watcher object in stopped state.
		2329
		2330	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2331
		2332	Set the callback to be called when the watcher triggers.
		2333
		2334	=item $timer = $timer->start
		2335
		2336	Start the watcher.
		2337
		2338	=item $timer = $timer->stop
		2339
		2340	Stop the watcher.
		2341
		2342	=back
		2343
		2344	=head2 The C<urxvt::pw> Class
		2345
		2346	This class implements process watchers. They create an event whenever a
		2347	process exits, after which they stop automatically.
		2348
		2349	my $pid = fork;
		2350	...
		2351	$term->{pw} = urxvt::pw
		2352	->new
		2353	->start ($pid)
		2354	->cb (sub {
		2355	my ($pw, $exit_status) = @_;
		2356	...
		2357	});
		2358
		2359	=over
		2360
		2361	=item $pw = new urxvt::pw
		2362
		2363	Create a new process watcher in stopped state.
		2364
		2365	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2366
		2367	Set the callback to be called when the timer triggers.
		2368
		2369	=item $pw = $timer->start ($pid)
		2370
		2371	Tells the watcher to start watching for process C<$pid>.
		2372
		2373	=item $pw = $pw->stop
		2374
		2375	Stop the watcher.
1747		2376
1748	=back	2377	=back
1749		2378
1750	=head1 ENVIRONMENT	2379	=head1 ENVIRONMENT
1751		2380
1752	=head2 URXVT_PERL_VERBOSITY	2381	=head2 URXVT_PERL_VERBOSITY
1753		2382
1754	This variable controls the verbosity level of the perl extension. Higher	2383	This variable controls the verbosity level of the perl extension. Higher
1755	numbers indicate more verbose output.	2384	numbers indicate more verbose output.
1756		2385
1757	=over 4	2386	=over
1758		2387
1759	=item == 0 - fatal messages	2388	=item == 0 - fatal messages only
		2389
		2390	=item >= 2 - general warnings (default level)
1760		2391
1761	=item >= 3 - script loading and management	2392	=item >= 3 - script loading and management
1762		2393
1763	=item >=10 - all called hooks	2394	=item >=10 - all called hooks
1764		2395
1765	=item >=11 - hook reutrn values	2396	=item >=11 - hook return values
1766		2397
1767	=back	2398	=back
1768		2399
1769	=head1 AUTHOR	2400	=head1 AUTHOR
1770		2401
1771	Marc Lehmann <pcg@goof.com>	2402	Marc Lehmann <schmorp@schmorp.de>
1772	http://software.schmorp.de/pkg/rxvt-unicode	2403	http://software.schmorp.de/pkg/rxvt-unicode
1773		2404
1774	=cut	2405	=cut
1775		2406
1776	1	2407	1
		2408
		2409	# vim: sw=3:

Diff Legend

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