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.132 by root, Mon Feb 6 05:40:15 2006 UTC vs.
Revision 1.268 by root, Sat Jul 24 13:07:56 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	Another example: Programs I use often output "absolute path: " at the
73	beginning of a line when they process multiple files. The following
74	pattern matches the filename (note, there is a single space at the very
75	end):
76
77	URxvt.selection.pattern-0: ^(/[^:]+):\
78
79	You can look at the source of the selection extension to see more
80	interesting uses, such as parsing a line from beginning to end.
81
82	This extension also offers following bindable keyboard commands:
83
84	=over 4
85
86	=item rot13
87
88	Rot-13 the selection when activated. Used via keyboard trigger:
89
90	URxvt.keysym.C-M-r: perl:selection:rot13
91
92	=back
93
94	=item option-popup (enabled by default)
95
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.
98
99	=item selection-popup (enabled by default)
100
101	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
102	text into various other formats/action (such as uri unescaping, perl
103	evaluation, web-browser starting etc.), depending on content.
104
105	Other extensions can extend this popup menu by pushing a code reference
106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
107	popup is displayed.
108
109	It's sole argument is the popup menu, which can be modified. The selection
110	is in C<$_>, which can be used to decide wether to add something or not.
111	It should either return nothing or a string and a code reference. The
112	string will be used as button text and the code reference will be called
113	when the button gets activated and should transform C<$_>.
114
115	The following will add an entry C<a to b> that transforms all C<a>s in
116	the selection to C<b>s, but only if the selection currently contains any
117	C<a>s:
118
119	push @{ $self->{term}{selection_popup_hook} }, sub {
120	/a/ ? ("a to be" => sub { s/a/b/g }
121	: ()
122	};
123
124	=item searchable-scrollback<hotkey> (enabled by default)
125
126	Adds regex search functionality to the scrollback buffer, triggered
127	by a hotkey (default: C<M-s>). While in search mode, normal terminal
128	input/output is suspended and a regex is displayed at the bottom of the
129	screen.
130
131	Inputting characters appends them to the regex and continues incremental
132	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
133	search upwards/downwards in the scrollback buffer, C<End> jumps to the
134	bottom. C<Escape> leaves search mode and returns to the point where search
135	was started, while C<Enter> or C<Return> stay at the current position and
136	additionally stores the first match in the current line into the primary
137	selection.
138
139	=item readline (enabled by default)
140
141	A support package that tries to make editing with readline easier. At the
142	moment, it reacts to clicking with the left mouse button by trying to
143	move the text cursor to this position. It does so by generating as many
144	cursor-left or cursor-right keypresses as required (the this only works
145	for programs that correctly support wide characters).
146
147	To avoid too many false positives, this is only done when:
148
149	=over 4
150
151	=item - the tty is in ICANON state.
152
153	=item - the text cursor is visible.
154
155	=item - the primary screen is currently being displayed.
156
157	=item - the mouse is on the same (multi-row-) line as the text cursor.
158
159	=back
160
161	The normal selection mechanism isn't disabled, so quick successive clicks
162	might interfere with selection creation in harmless ways.
163
164	=item selection-autotransform
165
166	This selection allows you to do automatic transforms on a selection
167	whenever a selection is made.
168
169	It works by specifying perl snippets (most useful is a single C<s///>
170	operator) that modify C<$_> as resources:
171
172	URxvt.selection-autotransform.0: transform
173	URxvt.selection-autotransform.1: transform
174	...
175
176	For example, the following will transform selections of the form
177	C<filename:number>, often seen in compiler messages, into C<vi +$filename
178	$word>:
179
180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
181
182	And this example matches the same,but replaces it with vi-commands you can
183	paste directly into your (vi :) editor:
184
185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
186
187	Of course, this can be modified to suit your needs and your editor :)
188
189	To expand the example above to typical perl error messages ("XXX at
190	FILENAME line YYY."), you need a slightly more elaborate solution:
191
192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
194
195	The first line tells the selection code to treat the unchanging part of
196	every error message as a selection pattern, and the second line transforms
197	the message into vi commands to load the file.
198
199	=item tabbed
200
201	This transforms the terminal into a tabbar with additional terminals, that
202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204	button per tab.
205
206	Clicking a button will activate that tab. Pressing B<Shift-Left> and
207	B<Shift-Right> will switch to the tab left or right of the current one,
208	while B<Shift-Down> creates a new tab.
209
210	The tabbar itself can be configured similarly to a normal terminal, but
211	with a resource class of C<URxvt.tabbed>. In addition, it supports the
212	following four resources (shown with defaults):
213
214	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
215	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
216	URxvt.tabbed.tab-fg: <colour-index, default 0>
217	URxvt.tabbed.tab-bg: <colour-index, default 1>
218
219	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
220	indices.
221
222	=item mark-urls
223
224	Uses per-line display filtering (C<on_line_update>) to underline urls and
225	make them clickable. When middle-clicked, the program specified in the
226	resource C<urlLauncher> (default C<x-www-browser>) will be started with
227	the URL as first argument.
228
229	=item xim-onthespot
230
231	This (experimental) perl extension implements OnTheSpot editing. It does
232	not work perfectly, and some input methods don't seem to work well with
233	OnTheSpot editing in general, but it seems to work at leats for SCIM and
234	kinput2.
235
236	You enable it by specifying this extension and a preedit style of
237	C<OnTheSpot>, i.e.:
238
239	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
240
241	=item automove-background
242
243	This is basically a one-line extension that dynamically changes the background pixmap offset
244	to the window position, in effect creating the same effect as pseudo transparency with
245	a custom pixmap. No scaling is supported in this mode. Exmaple:
246
247	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
248
249	=item block-graphics-to-ascii
250
251	A not very useful example of filtering all text output to the terminal,
252	by replacing all line-drawing characters (U+2500 .. U+259F) by a
253	similar-looking ascii character.
254
255	=item digital-clock
256
257	Displays a digital clock using the built-in overlay.
258
259	=item remote-clipboard
260
261	Somewhat of a misnomer, this extension adds two menu entries to the
262	selection popup that allows one ti run external commands to store the
263	selection somewhere and fetch it again.
264
265	We use it to implement a "distributed selection mechanism", which just
266	means that one command uploads the file to a remote server, and another
267	reads it.
268
269	The commands can be set using the C<URxvt.remote-selection.store> and
270	C<URxvt.remote-selection.fetch> resources. The first should read the
271	selection to store from STDIN (always in UTF-8), the second should provide
272	the selection data on STDOUT (also in UTF-8).
273
274	The defaults (which are likely useless to you) use rsh and cat:
275
276	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
277	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
278
279	=item selection-pastebin
280
281	This is a little rarely useful extension that Uploads the selection as
282	textfile to a remote site (or does other things). (The implementation is
283	not currently secure for use in a multiuser environment as it writes to
284	F</tmp> directly.).
285
286	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
287	i.e.
288
289	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
290
291	Pressing this combination runs a command with C<%> replaced by the name of
292	the textfile. This command can be set via a resource:
293
294	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
295
296	And the default is likely not useful to anybody but the few people around
297	here :)
298
299	The name of the textfile is the hex encoded md5 sum of the selection, so
300	the same content should lead to the same filename.
301
302	After a successful upload the selection will be replaced by the text given
303	in the C<selection-pastebin-url> resource (again, the % is the placeholder
304	for the filename):
305
306	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
307
308	=item example-refresh-hooks
309
310	Displays a very simple digital clock in the upper right corner of the
311	window. Illustrates overwriting the refresh callbacks to create your own
312	overlays or changes.
313
314	=back
315		56
316	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
317		58
318	=head2 General API Considerations	59	=head2 General API Considerations
319		60
…		…
329	terminal is destroyed.	70	terminal is destroyed.
330		71
331	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
332	hints on what they mean:	73	hints on what they mean:
333		74
334	=over 4	75	=over
335		76
336	=item $text	77	=item $text
337		78
338	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
339	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.
340		81
341	=item $string	82	=item $string
342		83
343	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
…		…
347	=item $octets	88	=item $octets
348		89
349	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
350	locale-specific way.	91	locale-specific way.
351		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
352	=back	99	=back
353		100
354	=head2 Extension Objects	101	=head2 Extension Objects
355		102
356	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
357	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,
358	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
359	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
360	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
361	use.	109	internal use.
362		110
363	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
364	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
365		113
366	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.
367		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
368	=over 4	128	=over
369		129
370	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
371		131
372	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
373	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.
374		135
375	=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.
376		138
377	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
378	this extension, replacing any previous hook. This is useful when you want	140	comment:
379	to overwrite time-critical hooks only temporarily.
380		141
381	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
382		143
383	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
384		183
385	=back	184	=back
386		185
387	=head2 Hooks	186	=head2 Hooks
388		187
389	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
390	called whenever the relevant event happens.	189	called whenever the relevant event happens.
391		190
392	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
393	the in the C<Extension Objects> section.	192	the in the C<Extension Objects> section.
394		193
395	B<All> of these hooks must return a boolean value. If any of the called	194	B<All> of these hooks must return a boolean value. If any of the called
396	hooks returns true, then the event counts as being I<consumed>, and the	195	hooks returns true, then the event counts as being I<consumed>, and the
397	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
398		197
399	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
400		199
401	=over 4	200	=over
402		201
403	=item on_init $term	202	=item on_init $term
404		203
405	Called after a new terminal object has been initialized, but before	204	Called after a new terminal object has been initialized, but before
406	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
…		…
410	place.	209	place.
411		210
412	=item on_start $term	211	=item on_start $term
413		212
414	Called at the very end of initialisation of a new terminal, just before	213	Called at the very end of initialisation of a new terminal, just before
415	trying to map (display) the toplevel and returning to the mainloop.	214	trying to map (display) the toplevel and returning to the main loop.
416		215
417	=item on_destroy $term	216	=item on_destroy $term
418		217
419	Called whenever something tries to destroy terminal, when the terminal is	218	Called whenever something tries to destroy terminal, when the terminal is
420	still fully functional (not for long, though).	219	still fully functional (not for long, though).
…		…
447		246
448	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
449	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
450	by calling C<< $term->selection >>.	249	by calling C<< $term->selection >>.
451		250
452	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.
453		252
454	=item on_sel_extend $term	253	=item on_sel_extend $term
455		254
456	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
457	click) and is either supposed to return false (normal operation), or	256	click) and is either supposed to return false (normal operation), or
458	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
459	processing. This can happen multiple times, as long as the callback	258	processing. This can happen multiple times, as long as the callback
460	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
461	supposed to enlarge the selection more and more, if possible.	260	supposed to enlarge the selection more and more, if possible.
462		261
463	See the F<selection> example extension.	262	See the F<selection> example extension.
464		263
465	=item on_view_change $term, $offset	264	=item on_view_change $term, $offset
466		265
467	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
468	scrolls. Offset C<0> means display the normal terminal, positive values	267	scrolls. Offset C<0> means display the normal terminal, positive values
469	show this many lines of scrollback.	268	show this many lines of scrollback.
470		269
471	=item on_scroll_back $term, $lines, $saved	270	=item on_scroll_back $term, $lines, $saved
472		271
…		…
476		275
477	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,
478	$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
479	number of lines that will be in the scrollback buffer.	278	number of lines that will be in the scrollback buffer.
480		279
481	=item on_osc_seq $term, $string	280	=item on_osc_seq $term, $op, $args, $resp
482		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
483	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	292	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
484	operating system command) is processed. Cursor position and other state	293	(OSC = operating system command) is processed. Cursor position and other
485	information is up-to-date when this happens. For interoperability, the	294	state information is up-to-date when this happens. For interoperability,
486	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
487	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
488	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	}
489		308
490	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,
491	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
492	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.
493		315
494	=item on_add_lines $term, $string	316	=item on_add_lines $term, $string
495		317
496	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
497	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
…		…
502	=item on_tt_write $term, $octets	324	=item on_tt_write $term, $octets
503		325
504	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
505	suppress or filter tty input.	327	suppress or filter tty input.
506		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
507	=item on_line_update $term, $row	336	=item on_line_update $term, $row
508		337
509	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
510	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
511	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,
…		…
518	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
519	you cannot just toggle rendition bits, but only set them.	348	you cannot just toggle rendition bits, but only set them.
520		349
521	=item on_refresh_begin $term	350	=item on_refresh_begin $term
522		351
523	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
524	or similar effects by modify terminal contents in refresh_begin, and	353	similar effects by modifying the terminal contents in refresh_begin, and
525	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
526	code is run after this hook, and takes precedence.	355	code is run after this hook, and takes precedence.
527		356
528	=item on_refresh_end $term	357	=item on_refresh_end $term
529		358
530	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>.
531		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
532	=item on_user_command $term, $string	369	=item on_user_command $term, $string *DEPRECATED*
533		370
534	Called whenever the a user-configured event is being activated (e.g. via	371	Called whenever a user-configured event is being activated (e.g. via
535	a C<perl:string> action bound to a key, see description of the B<keysym>	372	a C<perl:string> action bound to a key, see description of the B<keysym>
536	resource in the @@RXVT_NAME@@(1) manpage).	373	resource in the urxvt(1) manpage).
537		374
538	The event is simply the action string. This interface is assumed to change	375	The event is simply the action string. This interface is going away in
539	slightly in the future.	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.
540		383
541	=item on_x_event $term, $event	384	=item on_x_event $term, $event
542		385
543	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
544	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
545	members are not passed.	388	members are not passed.
546		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
547	=item on_focus_in $term	394	=item on_focus_in $term
548		395
549	Called whenever the window gets the keyboard focus, before rxvt-unicode	396	Called whenever the window gets the keyboard focus, before rxvt-unicode
550	does focus in processing.	397	does focus in processing.
551		398
552	=item on_focus_out $term	399	=item on_focus_out $term
553		400
554	Called wheneever the window loses keyboard focus, before rxvt-unicode does	401	Called whenever the window loses keyboard focus, before rxvt-unicode does
555	focus out processing.	402	focus out processing.
556		403
557	=item on_configure_notify $term, $event	404	=item on_configure_notify $term, $event
558		405
559	=item on_property_notify $term, $event	406	=item on_property_notify $term, $event
…		…
570		417
571	=item on_map_notify $term, $event	418	=item on_map_notify $term, $event
572		419
573	=item on_unmap_notify $term, $event	420	=item on_unmap_notify $term, $event
574		421
575	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
576	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.
577		424
578	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
579	manpage), with the additional members C<row> and C<col>, which are the	426	manpage), with the additional members C<row> and C<col>, which are the
580	(real, not screen-based) row and column under the mouse cursor.	427	(real, not screen-based) row and column under the mouse cursor.
581		428
582	C<on_key_press> additionally receives the string rxvt-unicode would	429	C<on_key_press> additionally receives the string rxvt-unicode would
583	output, if any, in locale-specific encoding.	430	output, if any, in locale-specific encoding.
584		431
585	subwindow.
586
587	=item on_client_message $term, $event	432	=item on_client_message $term, $event
588		433
589	=item on_wm_protocols $term, $event	434	=item on_wm_protocols $term, $event
590		435
591	=item on_wm_delete_window $term, $event	436	=item on_wm_delete_window $term, $event
592		437
593	Called when various types of ClientMessage events are received (all with	438	Called when various types of ClientMessage events are received (all with
594	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	439	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
595		440
		441	=item on_bell $term
		442
		443	Called on receipt of a bell character.
		444
596	=back	445	=back
597		446
598	=cut	447	=cut
599		448
600	package urxvt;	449	package urxvt;
601		450
602	use utf8;	451	use utf8;
603	use strict;	452	use strict qw(vars subs);
604	use Carp ();	453	use Carp ();
605	use Scalar::Util ();	454	use Scalar::Util ();
606	use List::Util ();	455	use List::Util ();
607		456
608	our $VERSION = 1;	457	our $VERSION = 1;
609	our $TERM;	458	our $TERM;
610	our @TERM_INIT;	459	our @TERM_INIT; # should go, prevents async I/O etc.
611	our @TERM_EXT;	460	our @TERM_EXT; # should go, prevents async I/O etc.
612	our @HOOKNAME;	461	our @HOOKNAME;
613	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
614	our %OPTION;	463	our %OPTION;
615		464
616	our $LIBDIR;	465	our $LIBDIR;
…		…
620		469
621	our $NOCHAR = chr 0xffff;	470	our $NOCHAR = chr 0xffff;
622		471
623	=head2 Variables in the C<urxvt> Package	472	=head2 Variables in the C<urxvt> Package
624		473
625	=over 4	474	=over
626		475
627	=item $urxvt::LIBDIR	476	=item $urxvt::LIBDIR
628		477
629	The rxvt-unicode library directory, where, among other things, the perl	478	The rxvt-unicode library directory, where, among other things, the perl
630	modules and scripts are stored.	479	modules and scripts are stored.
…		…
642	The current terminal. This variable stores the current C<urxvt::term>	491	The current terminal. This variable stores the current C<urxvt::term>
643	object, whenever a callback/hook is executing.	492	object, whenever a callback/hook is executing.
644		493
645	=item @urxvt::TERM_INIT	494	=item @urxvt::TERM_INIT
646		495
647	All coderefs in this array will be called as methods of the next newly	496	All code references in this array will be called as methods of the next newly
648	created C<urxvt::term> object (during the C<on_init> phase). The array	497	created C<urxvt::term> object (during the C<on_init> phase). The array
649	gets cleared before the codereferences that were in it are being executed,	498	gets cleared before the code references that were in it are being executed,
650	so coderefs can push themselves onto it again if they so desire.	499	so references can push themselves onto it again if they so desire.
651		500
652	This complements to the perl-eval commandline option, but gets executed	501	This complements to the perl-eval command line option, but gets executed
653	first.	502	first.
654		503
655	=item @urxvt::TERM_EXT	504	=item @urxvt::TERM_EXT
656		505
657	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	506	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
660		509
661	=back	510	=back
662		511
663	=head2 Functions in the C<urxvt> Package	512	=head2 Functions in the C<urxvt> Package
664		513
665	=over 4	514	=over
666		515
667	=item urxvt::fatal $errormessage	516	=item urxvt::fatal $errormessage
668		517
669	Fatally aborts execution with the given error message. Avoid at all	518	Fatally aborts execution with the given error message (which should
670	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
671	starts up.	520	is acceptable (and useful) is in the init hook, where it prevents the
		521	terminal from starting up.
672		522
673	=item urxvt::warn $string	523	=item urxvt::warn $string
674		524
675	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
676	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
677	that calls this function.	527	that calls this function.
678		528
679	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
680	correct place, e.g. on stderr of the connecting urxvtc client.	530	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
682	Messages have a size limit of 1023 bytes currently.	532	Messages have a size limit of 1023 bytes currently.
683		533
684	=item @terms = urxvt::termlist	534	=item @terms = urxvt::termlist
685		535
686	Returns all urxvt::term objects that exist in this process, regardless of	536	Returns all urxvt::term objects that exist in this process, regardless of
687	wether they are started, being destroyed etc., so be careful. Only term	537	whether they are started, being destroyed etc., so be careful. Only term
688	objects that have perl extensions attached will be returned (because there	538	objects that have perl extensions attached will be returned (because there
689	is no urxvt::term objet associated with others).	539	is no urxvt::term object associated with others).
690		540
691	=item $time = urxvt::NOW	541	=item $time = urxvt::NOW
692		542
693	Returns the "current time" (as per the event loop).	543	Returns the "current time" (as per the event loop).
694		544
…		…
714	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	564	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
715	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	565	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
716		566
717	Various constants for use in X calls and event processing.	567	Various constants for use in X calls and event processing.
718		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
719	=back	581	=back
720		582
721	=head2 RENDITION	583	=head2 RENDITION
722		584
723	Rendition bitsets contain information about colour, font, font styles and	585	Rendition bitsets contain information about colour, font, font styles and
…		…
726	The following "macros" deal with changes in rendition sets. You should	588	The following "macros" deal with changes in rendition sets. You should
727	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,
728	as they contain important information required for correct operation of	590	as they contain important information required for correct operation of
729	rxvt-unicode.	591	rxvt-unicode.
730		592
731	=over 4	593	=over
732		594
733	=item $rend = urxvt::DEFAULT_RSTYLE	595	=item $rend = urxvt::DEFAULT_RSTYLE
734		596
735	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
736	being reset. Useful as a base to start when creating renditions.	598	being reset. Useful as a base to start when creating renditions.
737		599
738	=item $rend = urxvt::OVERLAY_RSTYLE	600	=item $rend = urxvt::OVERLAY_RSTYLE
739		601
740	Return the rendition mask used for overlays by default.	602	Return the rendition mask used for overlays by default.
741		603
742	=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
743		606
744	Return the bit that enabled bold, italic, blink, reverse-video and	607	Return the bit that enabled bold, italic, blink, reverse-video and
745	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
746	the bitset.	609	the bitset.
747		610
…		…
784	};	647	};
785	}	648	}
786		649
787	no warnings 'utf8';	650	no warnings 'utf8';
788		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
789	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	718	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
790		719
791	sub verbose {	720	sub verbose {
792	my ($level, $msg) = @_;	721	my ($level, $msg) = @_;
793	warn "$msg\n" if $level <= $verbosity;	722	warn "$msg\n" if $level <= $verbosity;
794	}	723	}
…		…
805	$pkg =~ s/[^[:word:]]/_/g;	734	$pkg =~ s/[^[:word:]]/_/g;
806	$pkg = "urxvt::ext::$pkg";	735	$pkg = "urxvt::ext::$pkg";
807		736
808	verbose 3, "loading extension '$path' into package '$pkg'";	737	verbose 3, "loading extension '$path' into package '$pkg'";
809		738
		739	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		740
810	open my $fh, "<:raw", $path	741	open my $fh, "<:raw", $path
811	or die "$path: $!";	742	or die "$path: $!";
812		743
813	my $source =	744	my $source =
814	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	745	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
815	. "#line 1 \"$path\"\n{\n"	746	. "#line 1 \"$path\"\n{\n"
816	. (do { local $/; <$fh> })	747	. (do { local $/; <$fh> })
817	. "\n};\n1";	748	. "\n};\n1";
818		749
819	eval $source	750	eval $source
…		…
828	# called by the rxvt core	759	# called by the rxvt core
829	sub invoke {	760	sub invoke {
830	local $TERM = shift;	761	local $TERM = shift;
831	my $htype = shift;	762	my $htype = shift;
832		763
833	if ($htype == 0) { # INIT	764	if ($htype == HOOK_INIT) {
834	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	765	$TERM->scan_extensions;
835		766
836	my %ext_arg;	767	my %ext_arg;
837		768
838	{	769	{
839	my @init = @TERM_INIT;	770	my @init = @TERM_INIT;
840	@TERM_INIT = ();	771	@TERM_INIT = ();
…		…
842	my @pkg = @TERM_EXT;	773	my @pkg = @TERM_EXT;
843	@TERM_EXT = ();	774	@TERM_EXT = ();
844	$TERM->register_package ($_) for @pkg;	775	$TERM->register_package ($_) for @pkg;
845	}	776	}
846		777
		778	for (
		779	@{ delete $TERM->{perl_ext_3} },
847	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	780	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		781	) {
848	if ($_ eq "default") {	782	if ($_ eq "default") {
		783
		784	$ext_arg{$_} = []
849	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	785	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
		786
		787	for ($TERM->_keysym_resources) {
		788	next if /^(?:string|command|builtin|builtin-string|perl)/;
		789	next unless /^([A-Za-z0-9_\-]+):/;
		790
		791	my $ext = $1;
		792
		793	$ext_arg{$ext} = [];
		794	}
		795
850	} elsif (/^-(.*)$/) {	796	} elsif (/^-(.*)$/) { # remove from set
851	delete $ext_arg{$1};	797	delete $ext_arg{$1};
852	} 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};
853	push @{ $ext_arg{$1} }, $2;	804	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		805
854	} else {	806	} else {
855	$ext_arg{$_} ||= [];	807	verbose 2, "cannot parse extension specification '$_', ignoring.";
856	}	808	}
857	}	809	}
858		810
859	while (my ($ext, $argv) = each %ext_arg) {	811	$TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
860	my @files = grep -f $_, map "$_/$ext", @dirs;	812	$TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
861		813
862	if (@files) {	814	for my $ext (sort keys %ext_arg) {
863	$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});
864	} else {	819	} else {
865	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";
866	}	821	}
867	}	822	}
868		823
869	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");
870	warn $@ if $@;	825	warn $@ if $@;
871	}	826	}
872		827
		828	if ($htype == HOOK_OSC_SEQ) {
		829	if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
		830	$TERM->autoload_extension ($_->[0]) for @$exts;
		831	}
		832	} elsif ($htype == HOOK_OSC_SEQ_PERL) {
		833	if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
		834	$TERM->autoload_extension ($_->[0]) for @$exts;
		835	}
		836	}
		837
873	$retval = undef;	838	$retval = undef;
874		839
875	if (my $cb = $TERM->{_hook}[$htype]) {	840	if (my $cb = $TERM->{_hook}[$htype]) {
876	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	841	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
877	if $verbosity >= 10;	842	if $verbosity >= 10;
878		843
879	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";
880		850
881	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) {
882	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	858	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
883	$retval ||= $retval_;	859	$retval ||= $retval_;
884		860
885	if ($@) {	861	if ($@) {
886	$TERM->ungrab; # better to lose the grab than the session	862	$TERM->ungrab; # better to lose the grab than the session
887	warn $@;	863	warn $@;
…		…
890		866
891	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	867	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
892	if $verbosity >= 11;	868	if $verbosity >= 11;
893	}	869	}
894		870
895	if ($htype == 1) { # DESTROY	871	if ($htype == HOOK_DESTROY) {
896	# clear package objects	872	# clear package objects
897	%$_ = () for values %{ $TERM->{_pkg} };	873	%$_ = () for values %{ $TERM->{_pkg} };
898		874
899	# clear package	875	# clear package
900	%$TERM = ();	876	%$TERM = ();
…		…
905		881
906	sub SET_COLOR($$$) {	882	sub SET_COLOR($$$) {
907	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	883	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
908	}	884	}
909		885
910	# urxvt::term::extension	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	}
911		910
912	package urxvt::term::extension;	911	package urxvt::term::extension;
913		912
914	sub enable {	913	=head2 The C<urxvt::term::extension> class
915	my ($self, %hook) = @_;
916	my $pkg = $self->{_pkg};
917		914
918	while (my ($name, $cb) = each %hook) {	915	Each extension attached to a terminal object is represented by
919	my $htype = $HOOKTYPE{uc $name};	916	a C<urxvt::term::extension> object.
920	defined $htype
921	or Carp::croak "unsupported hook type '$name'";
922		917
923	$self->set_should_invoke ($htype, +1)	918	You can use these objects, which are passed to all callbacks to store any
924	unless exists $self->{term}{_hook}[$htype]{$pkg};	919	state related to the terminal and extension instance.
925		920
926	$self->{term}{_hook}[$htype]{$pkg} = $cb;	921	The methods (And data members) documented below can be called on extension
927	}	922	objects, in addition to call methods documented for the <urxvt::term>
928	}	923	class.
929		924
930	sub disable {	925	=over
931	my ($self, @hook) = @_;
932	my $pkg = $self->{_pkg};
933		926
934	for my $name (@hook) {	927	=item $urxvt_term = $self->{term}
935	my $htype = $HOOKTYPE{uc $name};
936	defined $htype
937	or Carp::croak "unsupported hook type '$name'";
938		928
939	$self->set_should_invoke ($htype, -1)	929	Returns the C<urxvt::term> object associated with this instance of the
940	if delete $self->{term}{_hook}[$htype]{$pkg};	930	extension. This member I<must not> be changed in any way.
941	}	931
942	}	932	=cut
943		933
944	our $AUTOLOAD;	934	our $AUTOLOAD;
945		935
946	sub AUTOLOAD {	936	sub AUTOLOAD {
947	$AUTOLOAD =~ /:([^:]+)$/	937	$AUTOLOAD =~ /:([^:]+)$/
…		…
960		950
961	sub DESTROY {	951	sub DESTROY {
962	# nop	952	# nop
963	}	953	}
964		954
965	# urxvt::destroy_hook	955	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
966		956
967	sub urxvt::destroy_hook::DESTROY {	957	sub urxvt::destroy_hook::DESTROY {
968	${$_[0]}->();	958	${$_[0]}->();
969	}	959	}
970		960
971	sub urxvt::destroy_hook(&) {	961	sub urxvt::destroy_hook(&) {
972	bless \shift, urxvt::destroy_hook::	962	bless \shift, urxvt::destroy_hook::
973	}	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
974		1087
975	package urxvt::anyevent;	1088	package urxvt::anyevent;
976		1089
977	=head2 The C<urxvt::anyevent> Class	1090	=head2 The C<urxvt::anyevent> Class
978		1091
979	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
980	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
981	further programming. The only exception is that you cannot wait on	1094	further programming. The only exception is that you cannot wait on
982	condition variables, but non-blocking condvar use is ok. What this means	1095	condition variables, but non-blocking condvar use is ok.
983	is that you cannot use blocking APIs, but the non-blocking variant should
984	work.
985		1096
986	=cut	1097	In practical terms this means is that you cannot use blocking APIs, but
		1098	the non-blocking variant should work.
987		1099
		1100	=cut
		1101
988	our $VERSION = 1;	1102	our $VERSION = '5.23';
989		1103
990	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1104	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
991	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1105	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
992		1106
993	sub timer {	1107	sub timer {
…		…
995		1109
996	my $cb = $arg{cb};	1110	my $cb = $arg{cb};
997		1111
998	urxvt::timer	1112	urxvt::timer
999	->new	1113	->new
1000	->start (urxvt::NOW + $arg{after})	1114	->after ($arg{after}, $arg{interval})
1001	->cb (sub {	1115	->cb ($arg{interval} ? $cb : sub {
1002	$_[0]->stop; # need to cancel manually	1116	$_[0]->stop; # need to cancel manually
1003	$cb->();	1117	$cb->();
1004	})	1118	})
1005	}	1119	}
1006		1120
1007	sub io {	1121	sub io {
1008	my ($class, %arg) = @_;	1122	my ($class, %arg) = @_;
1009		1123
1010	my $cb = $arg{cb};	1124	my $cb = $arg{cb};
		1125	my $fd = fileno $arg{fh};
		1126	defined $fd or $fd = $arg{fh};
1011		1127
1012	bless [$arg{fh}, urxvt::iow	1128	bless [$arg{fh}, urxvt::iow
1013	->new	1129	->new
1014	->fd (fileno $arg{fh})	1130	->fd ($fd)
1015	->events (($arg{poll} =~ /r/ ? 1 : 0)	1131	->events (($arg{poll} =~ /r/ ? 1 : 0)
1016	| ($arg{poll} =~ /w/ ? 2 : 0))	1132	| ($arg{poll} =~ /w/ ? 2 : 0))
1017	->start	1133	->start
1018	->cb (sub {	1134	->cb ($cb)
1019	$cb->(($_[1] & 1 ? 'r' : '')
1020	. ($_[1] & 2 ? 'w' : ''));
1021	})],
1022	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	})
1023	}	1161	}
1024		1162
1025	sub DESTROY {	1163	sub DESTROY {
1026	$_[0][1]->stop;	1164	$_[0][1]->stop;
1027	}	1165	}
1028		1166
1029	sub condvar {	1167	# only needed for AnyEvent < 6 compatibility
1030	bless \my $flag, urxvt::anyevent::condvar::	1168	sub one_event {
1031	}
1032
1033	sub urxvt::anyevent::condvar::broadcast {
1034	${$_[0]}++;
1035	}
1036
1037	sub urxvt::anyevent::condvar::wait {
1038	unless (${$_[0]}) {
1039	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";
1040	}
1041	}	1170	}
1042		1171
1043	package urxvt::term;	1172	package urxvt::term;
1044		1173
1045	=head2 The C<urxvt::term> Class	1174	=head2 The C<urxvt::term> Class
1046		1175
1047	=over 4	1176	=over
1048		1177
1049	=cut	1178	=cut
1050		1179
1051	# find on_xxx subs in the package and register them	1180	# find on_xxx subs in the package and register them
1052	# as hooks	1181	# as hooks
…		…
1058	urxvt::verbose 6, "register package $pkg to $self";	1187	urxvt::verbose 6, "register package $pkg to $self";
1059		1188
1060	@{"$pkg\::ISA"} = urxvt::term::extension::;	1189	@{"$pkg\::ISA"} = urxvt::term::extension::;
1061		1190
1062	my $proxy = bless {	1191	my $proxy = bless {
1063	_pkg => $pkg,	1192	_pkg => $pkg,
		1193	_name => ${"$pkg\::_NAME"}, # hackish
1064	argv => $argv,	1194	argv => $argv,
1065	}, $pkg;	1195	}, $pkg;
1066	Scalar::Util::weaken ($proxy->{term} = $self);	1196	Scalar::Util::weaken ($proxy->{term} = $self);
1067		1197
1068	$self->{_pkg}{$pkg} = $proxy;	1198	$self->{_pkg}{$pkg} = $proxy;
1069		1199
…		…
1072	$proxy->enable ($name => $ref);	1202	$proxy->enable ($name => $ref);
1073	}	1203	}
1074	}	1204	}
1075	}	1205	}
1076		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
1077	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1314	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1078		1315
1079	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
1080	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
1081	hash which defines the environment of the new terminal.	1318	hash which defines the environment of the new terminal.
…		…
1098	}	1335	}
1099		1336
1100	=item $term->destroy	1337	=item $term->destroy
1101		1338
1102	Destroy the terminal object (close the window, free resources	1339	Destroy the terminal object (close the window, free resources
1103	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
1104	watchers (timers, io watchers) are still active.	1341	watchers (timers, io watchers) are still active.
1105		1342
1106	=item $term->exec_async ($cmd[, @args])	1343	=item $term->exec_async ($cmd[, @args])
1107		1344
1108	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
…		…
1132		1369
1133	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
1134	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
1135	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.
1136		1373
1137	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
1138	source file F</src/optinc.h> to see the actual list:	1375	source file F</src/optinc.h> to see the actual list:
1139		1376
1140	borderLess console cursorBlink cursorUnderline hold iconic insecure	1377	borderLess buffered console cursorBlink cursorUnderline hold iconic
1141	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1378	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1142	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1379	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1143	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1380	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1144	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1381	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1145	transparent tripleclickwords utmpInhibit visualBell	1382	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1383	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1146		1384
1147	=item $value = $term->resource ($name[, $newval])	1385	=item $value = $term->resource ($name[, $newval])
1148		1386
1149	Returns the current resource value associated with a given name and	1387	Returns the current resource value associated with a given name and
1150	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>
…		…
1159	likely change).	1397	likely change).
1160		1398
1161	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
1162	terminal is destroyed, so changing options frequently will eat memory.	1400	terminal is destroyed, so changing options frequently will eat memory.
1163		1401
1164	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
1165	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>
1166	to see the actual list:	1404	to see the actual list:
1167		1405
1168	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1406	answerbackstring backgroundPixmap backspace_key blurradius
1169	borderLess color cursorBlink cursorUnderline cutchars delete_key	1407	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1170	display_name embed ext_bwidth fade font geometry hold iconName	1408	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1171	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
1172	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1411	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1173	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1412	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1174	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1413	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1175	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1414	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1176	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1415	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1177	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1416	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1178	secondaryScreen secondaryScroll selectstyle shade term_name title	1417	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1179	transient_for transparent transparent_all tripleclickwords utmpInhibit	1418	term_name title transient_for transparent tripleclickwords urgentOnBell
1180	visualBell	1419	utmpInhibit visualBell rewrapMode disablePasteBrackets
1181		1420
1182	=cut	1421	=cut
1183		1422
1184	sub resource($$;$) {	1423	sub resource($$;$) {
1185	my ($self, $name) = (shift, shift);	1424	my ($self, $name) = (shift, shift);
1186	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1425	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1187	&urxvt::term::_resource	1426	goto &urxvt::term::_resource
1188	}	1427	}
1189		1428
1190	=item $value = $term->x_resource ($pattern)	1429	=item $value = $term->x_resource ($pattern)
1191		1430
1192	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
1193	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
1194	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
1195	resource with that pattern exists.	1434	resource with that pattern exists.
1196		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
1197	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
1198	only one resource database per display, and later invocations might return	1447	only one resource database per display, and later invocations might return
1199	the wrong resources.	1448	the wrong resources.
1200		1449
1201	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1450	=item $value = $term->x_resource_boolean ($pattern)
1202		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
1203	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
1204	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	}
1205		1490
1206	=item $rend = $term->rstyle ([$new_rstyle])	1491	=item $rend = $term->rstyle ([$new_rstyle])
1207		1492
1208	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
1209	the terminal application will use this style.	1494	the terminal application will use this style.
…		…
1217		1502
1218	=item ($row, $col) = $term->selection_beg ([$row, $col])	1503	=item ($row, $col) = $term->selection_beg ([$row, $col])
1219		1504
1220	=item ($row, $col) = $term->selection_end ([$row, $col])	1505	=item ($row, $col) = $term->selection_end ([$row, $col])
1221		1506
1222	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.
1223	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.
1224		1516
1225	=item $term->selection_make ($eventtime[, $rectangular])	1517	=item $term->selection_make ($eventtime[, $rectangular])
1226		1518
1227	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
1228	C<selection_end>. If C<$rectangular> is true (default: false), a	1520	C<selection_end>. If C<$rectangular> is true (default: false), a
1229	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
1230	a selection.	1522	a selection.
1231		1523
1232	=item $success = $term->selection_grab ($eventtime)	1524	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1233		1525
1234	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
1235	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
1236	is mostly useful from within C<on_sel_grab> hooks.	1529	is mostly useful from within C<on_sel_grab> hooks.
1237		1530
1238	=item $oldtext = $term->selection ([$newtext])	1531	=item $oldtext = $term->selection ([$newtext, $clipboard])
1239		1532
1240	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.
1241		1539
1242	=item $term->overlay_simple ($x, $y, $text)	1540	=item $term->overlay_simple ($x, $y, $text)
1243		1541
1244	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.
1245		1543
…		…
1273	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
1274	as long as the perl object is referenced.	1572	as long as the perl object is referenced.
1275		1573
1276	The methods currently supported on C<urxvt::overlay> objects are:	1574	The methods currently supported on C<urxvt::overlay> objects are:
1277		1575
1278	=over 4	1576	=over
1279		1577
1280	=item $overlay->set ($x, $y, $text, $rend)	1578	=item $overlay->set ($x, $y, $text[, $rend])
1281		1579
1282	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
1283	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
1284	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.
1285		1585
1286	=item $overlay->hide	1586	=item $overlay->hide
1287		1587
1288	If visible, hide the overlay, but do not destroy it.	1588	If visible, hide the overlay, but do not destroy it.
1289		1589
…		…
1352		1652
1353	=item $term->scr_add_lines ($string)	1653	=item $term->scr_add_lines ($string)
1354		1654
1355	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
1356	running inside the terminal. It may not contain command sequences (escape	1656	running inside the terminal. It may not contain command sequences (escape
1357	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,
1358	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.
1359		1660
1360	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
1361	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
1362	C<on_add_lines> hook, though.	1663	C<on_add_lines> hook, though.
1363		1664
…		…
1371	locale-specific encoding of the terminal and can contain command sequences	1672	locale-specific encoding of the terminal and can contain command sequences
1372	(escape codes) that will be interpreted.	1673	(escape codes) that will be interpreted.
1373		1674
1374	=item $term->tt_write ($octets)	1675	=item $term->tt_write ($octets)
1375		1676
1376	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
1377	pass characters instead of octets, you should convert your strings first	1679	characters instead of octets, you should convert your strings first to the
1378	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.
1379		1695
1380	=item $old_events = $term->pty_ev_events ([$new_events])	1696	=item $old_events = $term->pty_ev_events ([$new_events])
1381		1697
1382	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
1383	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
…		…
1402	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
1403	to receive pointer events all the times:	1719	to receive pointer events all the times:
1404		1720
1405	$term->vt_emask_add (urxvt::PointerMotionMask);	1721	$term->vt_emask_add (urxvt::PointerMotionMask);
1406		1722
		1723	=item $term->set_urgency ($set)
		1724
		1725	Enable/disable the urgency hint on the toplevel window.
		1726
1407	=item $term->focus_in	1727	=item $term->focus_in
1408		1728
1409	=item $term->focus_out	1729	=item $term->focus_out
1410		1730
1411	=item $term->key_press ($state, $keycode[, $time])	1731	=item $term->key_press ($state, $keycode[, $time])
1412		1732
1413	=item $term->key_release ($state, $keycode[, $time])	1733	=item $term->key_release ($state, $keycode[, $time])
1414		1734
1415	Deliver various fake events to to terminal.	1735	Deliver various fake events to to terminal.
1416		1736
1417	=item $window_width = $term->width	1737	=item $window_width = $term->width ([$new_value])
1418		1738
1419	=item $window_height = $term->height	1739	=item $window_height = $term->height ([$new_value])
1420		1740
1421	=item $font_width = $term->fwidth	1741	=item $font_width = $term->fwidth ([$new_value])
1422		1742
1423	=item $font_height = $term->fheight	1743	=item $font_height = $term->fheight ([$new_value])
1424		1744
1425	=item $font_ascent = $term->fbase	1745	=item $font_ascent = $term->fbase ([$new_value])
1426		1746
1427	=item $terminal_rows = $term->nrow	1747	=item $terminal_rows = $term->nrow ([$new_value])
1428		1748
1429	=item $terminal_columns = $term->ncol	1749	=item $terminal_columns = $term->ncol ([$new_value])
1430		1750
1431	=item $has_focus = $term->focus	1751	=item $has_focus = $term->focus ([$new_value])
1432		1752
1433	=item $is_mapped = $term->mapped	1753	=item $is_mapped = $term->mapped ([$new_value])
1434		1754
1435	=item $max_scrollback = $term->saveLines	1755	=item $max_scrollback = $term->saveLines ([$new_value])
1436		1756
1437	=item $nrow_plus_saveLines = $term->total_rows	1757	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1438		1758
1439	=item $topmost_scrollback_row = $term->top_row	1759	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1440		1760
1441	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.
1442		1763
1443	=item $x_display = $term->display_id	1764	=item $x_display = $term->display_id
1444		1765
1445	Return the DISPLAY used by rxvt-unicode.	1766	Return the DISPLAY used by rxvt-unicode.
1446		1767
…		…
1451	=item $env = $term->env	1772	=item $env = $term->env
1452		1773
1453	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
1454	similar to C<\%ENV>.	1775	similar to C<\%ENV>.
1455		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
1456	=cut	1786	=cut
1457		1787
1458	sub env {	1788	sub env {
1459	if (my $env = $_[0]->_env) {
1460	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1789	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1461	} else {
1462	+{ %ENV }
1463	}
1464	}	1790	}
1465		1791
1466	=item $modifiermask = $term->ModLevel3Mask	1792	=item $modifiermask = $term->ModLevel3Mask
1467		1793
1468	=item $modifiermask = $term->ModMetaMask	1794	=item $modifiermask = $term->ModMetaMask
…		…
1476		1802
1477	Returns the currently displayed screen (0 primary, 1 secondary).	1803	Returns the currently displayed screen (0 primary, 1 secondary).
1478		1804
1479	=item $cursor_is_hidden = $term->hidden_cursor	1805	=item $cursor_is_hidden = $term->hidden_cursor
1480		1806
1481	Returns wether the cursor is currently hidden or not.	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	}
1482		1818
1483	=item $view_start = $term->view_start ([$newvalue])	1819	=item $view_start = $term->view_start ([$newvalue])
1484		1820
1485	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,
1486	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
1487	this many lines into the scrollback buffer.	1823	the terminal contents. Lower values scroll this many lines into the
		1824	scrollback buffer.
1488		1825
1489	=item $term->want_refresh	1826	=item $term->want_refresh
1490		1827
1491	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1828	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1492	compare the on-screen display with its stored representation. If they	1829	compare the on-screen display with its stored representation. If they
1493	differ, it redraws the differences.	1830	differ, it redraws the differences.
1494		1831
1495	Used after changing terminal contents to display them.	1832	Used after changing terminal contents to display them.
1496		1833
		1834	=item $term->refresh_check
		1835
		1836	Checks if a refresh has been requested and, if so, schedules one.
		1837
1497	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1838	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1498		1839
1499	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 >>
1500	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
1501	terminal line. The scrollback buffer starts at line C<-1> and extends to
1502	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1842	terminal line. Nothing will be returned if a nonexistent line
1503	is requested.	1843	is requested.
1504		1844
1505	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
1506	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
1507	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
1508	automatically be updated.	1848	automatically be updated.
1509		1849
1510	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
1511	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1851	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1512	characters. Characters with combining characters and other characters that	1852	characters. Characters with combining characters and other characters that
1513	do not fit into the normal tetx encoding will be replaced with characters	1853	do not fit into the normal text encoding will be replaced with characters
1514	in the private use area.	1854	in the private use area.
1515		1855
1516	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
1517	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
1518	characters.	1858	characters.
…		…
1547		1887
1548	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
1549	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
1550	following methods:	1890	following methods:
1551		1891
1552	=over 4	1892	=over
1553		1893
1554	=item $text = $line->t ([$new_text])	1894	=item $text = $line->t ([$new_text])
1555		1895
1556	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>
1557		1897
…		…
1603	}	1943	}
1604		1944
1605	sub urxvt::line::t {	1945	sub urxvt::line::t {
1606	my ($self) = @_;	1946	my ($self) = @_;
1607		1947
1608	if (@_ > 1)	1948	if (@_ > 1) {
1609	{
1610	$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})
1611	for $self->{beg} .. $self->{end};	1950	for $self->{beg} .. $self->{end};
1612	}	1951	}
1613		1952
1614	defined wantarray &&	1953	defined wantarray &&
1615	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1954	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1616	0, $self->{len}	1955	0, $self->{len}
1617	}	1956	}
1618		1957
1619	sub urxvt::line::r {	1958	sub urxvt::line::r {
1620	my ($self) = @_;	1959	my ($self) = @_;
1621		1960
1622	if (@_ > 1)	1961	if (@_ > 1) {
1623	{
1624	$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})
1625	for $self->{beg} .. $self->{end};	1963	for $self->{beg} .. $self->{end};
1626	}	1964	}
1627		1965
1628	if (defined wantarray) {	1966	if (defined wantarray) {
1629	my $rend = [	1967	my $rend = [
1630	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1968	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1631	];	1969	];
…		…
1663	where one character corresponds to one screen cell. See	2001	where one character corresponds to one screen cell. See
1664	C<< $term->ROW_t >> for details.	2002	C<< $term->ROW_t >> for details.
1665		2003
1666	=item $string = $term->special_decode $text	2004	=item $string = $term->special_decode $text
1667		2005
1668	Converts rxvt-unicodes text reprsentation into a perl string. See	2006	Converts rxvt-unicode's text representation into a perl string. See
1669	C<< $term->ROW_t >> for details.	2007	C<< $term->ROW_t >> for details.
1670		2008
1671	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	2009	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1672		2010
1673	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	2011	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1676	manpage.	2014	manpage.
1677		2015
1678	=item $success = $term->grab ($eventtime[, $sync])	2016	=item $success = $term->grab ($eventtime[, $sync])
1679		2017
1680	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2018	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1681	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2019	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1682		2020
1683	=item $term->allow_events_async	2021	=item $term->allow_events_async
1684		2022
1685	Calls XAllowEvents with AsyncBoth for the most recent grab.	2023	Calls XAllowEvents with AsyncBoth for the most recent grab.
1686		2024
…		…
1693	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2031	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1694	recent grab.	2032	recent grab.
1695		2033
1696	=item $term->ungrab	2034	=item $term->ungrab
1697		2035
1698	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
1699	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
1700	the session.	2038	the session.
1701		2039
1702	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2040	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1703		2041
…		…
1705		2043
1706	=item @atoms = $term->XListProperties ($window)	2044	=item @atoms = $term->XListProperties ($window)
1707		2045
1708	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2046	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1709		2047
1710	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2048	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1711		2049
1712	=item $term->XDeleteProperty ($window, $property)	2050	=item $term->XDeleteProperty ($window, $property)
1713		2051
1714	=item $window = $term->DefaultRootWindow	2052	=item $window = $term->DefaultRootWindow
1715		2053
…		…
1722	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2060	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1723		2061
1724	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2062	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1725		2063
1726	=item $term->XChangeInput ($window, $add_events[, $del_events])	2064	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2065
		2066	=item $keysym = $term->XStringToKeysym ($string)
		2067
		2068	=item $string = $term->XKeysymToString ($keysym)
1727		2069
1728	Various X or X-related functions. The C<$term> object only serves as	2070	Various X or X-related functions. The C<$term> object only serves as
1729	the source of the display, otherwise those functions map more-or-less	2071	the source of the display, otherwise those functions map more-or-less
1730	directory onto the X functions of the same name.	2072	directly onto the X functions of the same name.
1731		2073
1732	=back	2074	=back
1733		2075
1734	=cut	2076	=cut
1735		2077
1736	package urxvt::popup;	2078	package urxvt::popup;
1737		2079
1738	=head2 The C<urxvt::popup> Class	2080	=head2 The C<urxvt::popup> Class
1739		2081
1740	=over 4	2082	=over
1741		2083
1742	=cut	2084	=cut
1743		2085
1744	sub add_item {	2086	sub add_item {
1745	my ($self, $item) = @_;	2087	my ($self, $item) = @_;
…		…
1799	my ($self, $text, $cb) = @_;	2141	my ($self, $text, $cb) = @_;
1800		2142
1801	$self->add_item ({ type => "button", text => $text, activate => $cb});	2143	$self->add_item ({ type => "button", text => $text, activate => $cb});
1802	}	2144	}
1803		2145
1804	=item $popup->add_toggle ($text, $cb, $initial_value)	2146	=item $popup->add_toggle ($text, $initial_value, $cb)
1805		2147
1806	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
1807	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
1808	argument.	2150	first argument.
1809		2151
1810	=cut	2152	=cut
1811		2153
1812	sub add_toggle {	2154	sub add_toggle {
1813	my ($self, $text, $cb, $value) = @_;	2155	my ($self, $text, $value, $cb) = @_;
1814		2156
1815	my $item; $item = {	2157	my $item; $item = {
1816	type => "button",	2158	type => "button",
1817	text => " $text",	2159	text => " $text",
1818	value => $value,	2160	value => $value,
…		…
1837	my $env = $self->{term}->env;	2179	my $env = $self->{term}->env;
1838	# 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.
1839	delete $env->{LC_ALL};	2181	delete $env->{LC_ALL};
1840	$env->{LC_CTYPE} = $self->{term}->locale;	2182	$env->{LC_CTYPE} = $self->{term}->locale;
1841		2183
1842	urxvt::term->new ($env, "popup",	2184	my $term = urxvt::term->new (
		2185	$env, "popup",
1843	"--perl-lib" => "", "--perl-ext-common" => "",	2186	"--perl-lib" => "", "--perl-ext-common" => "",
1844	"-pty-fd" => -1, "-sl" => 0,	2187	"-pty-fd" => -1, "-sl" => 0,
1845	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2188	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1846	"--transient-for" => $self->{term}->parent,	2189	"--transient-for" => $self->{term}->parent,
1847	"-display" => $self->{term}->display_id,	2190	"-display" => $self->{term}->display_id,
1848	"-pe" => "urxvt-popup")	2191	"-pe" => "urxvt-popup",
1849	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	}
1850	}	2199	}
1851		2200
1852	sub DESTROY {	2201	sub DESTROY {
1853	my ($self) = @_;	2202	my ($self) = @_;
1854		2203
…		…
1859	=back	2208	=back
1860		2209
1861	=cut	2210	=cut
1862		2211
1863	package urxvt::watcher;	2212	package urxvt::watcher;
1864
1865	@urxvt::timer::ISA = __PACKAGE__;
1866	@urxvt::iow::ISA = __PACKAGE__;
1867	@urxvt::pw::ISA = __PACKAGE__;
1868	@urxvt::iw::ISA = __PACKAGE__;
1869		2213
1870	=head2 The C<urxvt::timer> Class	2214	=head2 The C<urxvt::timer> Class
1871		2215
1872	This class implements timer watchers/events. Time is represented as a	2216	This class implements timer watchers/events. Time is represented as a
1873	fractional number of seconds since the epoch. Example:	2217	fractional number of seconds since the epoch. Example:
…		…
1877	->new	2221	->new
1878	->interval (1)	2222	->interval (1)
1879	->cb (sub {	2223	->cb (sub {
1880	$term->{overlay}->set (0, 0,	2224	$term->{overlay}->set (0, 0,
1881	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2225	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1882	});	2226	});
1883		2227
1884	=over 4	2228	=over
1885		2229
1886	=item $timer = new urxvt::timer	2230	=item $timer = new urxvt::timer
1887		2231
1888	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
1889	immediately.	2233	immediately.
1890		2234
1891	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2235	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1892		2236
1893	Set the callback to be called when the timer triggers.	2237	Set the callback to be called when the timer triggers.
1894		2238
1895	=item $tstamp = $timer->at
1896
1897	Return the time this watcher will fire next.
1898
1899	=item $timer = $timer->set ($tstamp)	2239	=item $timer = $timer->set ($tstamp[, $interval])
1900		2240
1901	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).
1902		2243
1903	=item $timer = $timer->interval ($interval)	2244	=item $timer = $timer->interval ($interval)
1904		2245
1905	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
1906	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
1907	is automatically rescheduled at the given intervals.	2248	is automatically rescheduled at the given intervals.
1908		2249
1909	=item $timer = $timer->start	2250	=item $timer = $timer->start
1910		2251
1911	Start the timer.	2252	Start the timer.
1912		2253
1913	=item $timer = $timer->start ($tstamp)	2254	=item $timer = $timer->start ($tstamp[, $interval])
1914		2255
1915	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.
1916		2258
1917	=item $timer = $timer->after ($delay)	2259	=item $timer = $timer->after ($delay[, $interval])
1918		2260
1919	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>.
1920		2262
1921	=item $timer = $timer->stop	2263	=item $timer = $timer->stop
1922		2264
…		…
1930		2272
1931	$term->{socket} = ...	2273	$term->{socket} = ...
1932	$term->{iow} = urxvt::iow	2274	$term->{iow} = urxvt::iow
1933	->new	2275	->new
1934	->fd (fileno $term->{socket})	2276	->fd (fileno $term->{socket})
1935	->events (urxvt::EVENT_READ)	2277	->events (urxvt::EV_READ)
1936	->start	2278	->start
1937	->cb (sub {	2279	->cb (sub {
1938	my ($iow, $revents) = @_;	2280	my ($iow, $revents) = @_;
1939	# $revents must be 1 here, no need to check	2281	# $revents must be 1 here, no need to check
1940	sysread $term->{socket}, my $buf, 8192	2282	sysread $term->{socket}, my $buf, 8192
1941	or end-of-file;	2283	or end-of-file;
1942	});	2284	});
1943		2285
1944		2286
1945	=over 4	2287	=over
1946		2288
1947	=item $iow = new urxvt::iow	2289	=item $iow = new urxvt::iow
1948		2290
1949	Create a new io watcher object in stopped state.	2291	Create a new io watcher object in stopped state.
1950		2292
…		…
1953	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>
1954	is a bitset as described in the C<events> method.	2296	is a bitset as described in the C<events> method.
1955		2297
1956	=item $iow = $iow->fd ($fd)	2298	=item $iow = $iow->fd ($fd)
1957		2299
1958	Set the filedescriptor (not handle) to watch.	2300	Set the file descriptor (not handle) to watch.
1959		2301
1960	=item $iow = $iow->events ($eventmask)	2302	=item $iow = $iow->events ($eventmask)
1961		2303
1962	Set the event mask to watch. The only allowed values are	2304	Set the event mask to watch. The only allowed values are
1963	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
1964	together, or C<urxvt::EVENT_NONE>.	2306	together, or C<urxvt::EV_NONE>.
1965		2307
1966	=item $iow = $iow->start	2308	=item $iow = $iow->start
1967		2309
1968	Start watching for requested events on the given handle.	2310	Start watching for requested events on the given handle.
1969		2311
1970	=item $iow = $iow->stop	2312	=item $iow = $iow->stop
1971		2313
1972	Stop watching for events on the given filehandle.	2314	Stop watching for events on the given file handle.
1973		2315
1974	=back	2316	=back
1975		2317
1976	=head2 The C<urxvt::iw> Class	2318	=head2 The C<urxvt::iw> Class
1977		2319
1978	This class implements idle watchers, that get called automatically when	2320	This class implements idle watchers, that get called automatically when
1979	the process is idle. They should return as fast as possible, after doing	2321	the process is idle. They should return as fast as possible, after doing
1980	some useful work.	2322	some useful work.
1981		2323
1982	=over 4	2324	=over
1983		2325
1984	=item $iw = new urxvt::iw	2326	=item $iw = new urxvt::iw
1985		2327
1986	Create a new idle watcher object in stopped state.	2328	Create a new idle watcher object in stopped state.
1987		2329
…		…
2010	->new	2352	->new
2011	->start ($pid)	2353	->start ($pid)
2012	->cb (sub {	2354	->cb (sub {
2013	my ($pw, $exit_status) = @_;	2355	my ($pw, $exit_status) = @_;
2014	...	2356	...
2015	});	2357	});
2016		2358
2017	=over 4	2359	=over
2018		2360
2019	=item $pw = new urxvt::pw	2361	=item $pw = new urxvt::pw
2020		2362
2021	Create a new process watcher in stopped state.	2363	Create a new process watcher in stopped state.
2022		2364
…		…
2024		2366
2025	Set the callback to be called when the timer triggers.	2367	Set the callback to be called when the timer triggers.
2026		2368
2027	=item $pw = $timer->start ($pid)	2369	=item $pw = $timer->start ($pid)
2028		2370
2029	Tells the wqtcher to start watching for process C<$pid>.	2371	Tells the watcher to start watching for process C<$pid>.
2030		2372
2031	=item $pw = $pw->stop	2373	=item $pw = $pw->stop
2032		2374
2033	Stop the watcher.	2375	Stop the watcher.
2034		2376
…		…
2039	=head2 URXVT_PERL_VERBOSITY	2381	=head2 URXVT_PERL_VERBOSITY
2040		2382
2041	This variable controls the verbosity level of the perl extension. Higher	2383	This variable controls the verbosity level of the perl extension. Higher
2042	numbers indicate more verbose output.	2384	numbers indicate more verbose output.
2043		2385
2044	=over 4	2386	=over
2045		2387
2046	=item == 0 - fatal messages	2388	=item == 0 - fatal messages only
		2389
		2390	=item >= 2 - general warnings (default level)
2047		2391
2048	=item >= 3 - script loading and management	2392	=item >= 3 - script loading and management
2049		2393
2050	=item >=10 - all called hooks	2394	=item >=10 - all called hooks
2051		2395
2052	=item >=11 - hook reutrn values	2396	=item >=11 - hook return values
2053		2397
2054	=back	2398	=back
2055		2399
2056	=head1 AUTHOR	2400	=head1 AUTHOR
2057		2401
2058	Marc Lehmann <pcg@goof.com>	2402	Marc Lehmann <schmorp@schmorp.de>
2059	http://software.schmorp.de/pkg/rxvt-unicode	2403	http://software.schmorp.de/pkg/rxvt-unicode
2060		2404
2061	=cut	2405	=cut
2062		2406
2063	1	2407	1
		2408
		2409	# vim: sw=3:

Diff Legend

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