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.142 by root, Thu Jul 6 18:56:10 2006 UTC vs.
Revision 1.271 by root, Fri Dec 9 05:06:46 2022 UTC

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

Diff Legend

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