ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.123 by root, Sat Jan 21 14:49:18 2006 UTC vs.
Revision 1.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	You can look at the source of the selection extension to see more
73	interesting uses, such as parsing a line from beginning to end.
74
75	This extension also offers following bindable keyboard commands:
76
77	=over 4
78
79	=item rot13
80
81	Rot-13 the selection when activated. Used via keyboard trigger:
82
83	URxvt.keysym.C-M-r: perl:selection:rot13
84
85	=back
86
87	=item option-popup (enabled by default)
88
89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90	runtime.
91
92	=item selection-popup (enabled by default)
93
94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95	text into various other formats/action (such as uri unescaping, perl
96	evaluation, web-browser starting etc.), depending on content.
97
98	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100	popup is displayed.
101
102	It's sole argument is the popup menu, which can be modified. The selection
103	is in C<$_>, which can be used to decide wether to add something or not.
104	It should either return nothing or a string and a code reference. The
105	string will be used as button text and the code reference will be called
106	when the button gets activated and should transform C<$_>.
107
108	The following will add an entry C<a to b> that transforms all C<a>s in
109	the selection to C<b>s, but only if the selection currently contains any
110	C<a>s:
111
112	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }
114	: ()
115	};
116
117	=item searchable-scrollback<hotkey> (enabled by default)
118
119	Adds regex search functionality to the scrollback buffer, triggered
120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
121	input/output is suspended and a regex is displayed at the bottom of the
122	screen.
123
124	Inputting characters appends them to the regex and continues incremental
125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
127	bottom. C<Escape> leaves search mode and returns to the point where search
128	was started, while C<Enter> or C<Return> stay at the current position and
129	additionally stores the first match in the current line into the primary
130	selection.
131
132	=item readline (enabled by default)
133
134	A support package that tries to make editing with readline easier. At the
135	moment, it reacts to clicking with the left mouse button by trying to
136	move the text cursor to this position. It does so by generating as many
137	cursor-left or cursor-right keypresses as required (the this only works
138	for programs that correctly support wide characters).
139
140	To avoid too many false positives, this is only done when:
141
142	=over 4
143
144	=item - the mouse is on the same (multi-row-) line as the text cursor.
145
146	=item - the primary screen is currently being displayed.
147
148	=item - the text cursor is visible.
149
150	=back
151
152	The normal selection mechanism isn't disabled, so quick successive clicks
153	might interfere with selection creation in harmless ways.
154
155	=item selection-autotransform
156
157	This selection allows you to do automatic transforms on a selection
158	whenever a selection is made.
159
160	It works by specifying perl snippets (most useful is a single C<s///>
161	operator) that modify C<$_> as resources:
162
163	URxvt.selection-autotransform.0: transform
164	URxvt.selection-autotransform.1: transform
165	...
166
167	For example, the following will transform selections of the form
168	C<filename:number>, often seen in compiler messages, into C<vi +$filename
169	$word>:
170
171	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
172
173	And this example matches the same,but replaces it with vi-commands you can
174	paste directly into your (vi :) editor:
175
176	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
177
178	Of course, this can be modified to suit your needs and your editor :)
179
180	To expand the example above to typical perl error messages ("XXX at
181	FILENAME line YYY."), you need a slightly more elaborate solution:
182
183	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
184	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
185
186	The first line tells the selection code to treat the unchanging part of
187	every error message as a selection pattern, and the second line transforms
188	the message into vi commands to load the file.
189
190	=item tabbed
191
192	This transforms the terminal into a tabbar with additional terminals, that
193	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
194	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
195	button per tab.
196
197	Clicking a button will activate that tab. Pressing B<Shift-Left> and
198	B<Shift-Right> will switch to the tab left or right of the current one,
199	while B<Shift-Down> creates a new tab.
200
201	=item mark-urls
202
203	Uses per-line display filtering (C<on_line_update>) to underline urls and
204	make them clickable. When middle-clicked, the program specified in the
205	resource C<urlLauncher> (default C<x-www-browser>) will be started with
206	the URL as first argument.
207
208	=item automove-background
209
210	This is basically a one-line extension that dynamically changes the background pixmap offset
211	to the window position, in effect creating the same effect as pseudo transparency with
212	a custom pixmap. No scaling is supported in this mode. Exmaple:
213
214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
215
216	=item block-graphics-to-ascii
217
218	A not very useful example of filtering all text output to the terminal,
219	by replacing all line-drawing characters (U+2500 .. U+259F) by a
220	similar-looking ascii character.
221
222	=item digital-clock
223
224	Displays a digital clock using the built-in overlay.
225
226	=item example-refresh-hooks
227
228	Displays a very simple digital clock in the upper right corner of the
229	window. Illustrates overwriting the refresh callbacks to create your own
230	overlays or changes.
231
232	=item selection-pastebin
233
234	This is a little rarely useful extension that Uploads the selection as
235	textfile to a remote site (or does other things). (The implementation is
236	not currently secure for use in a multiuser environment as it writes to
237	F</tmp> directly.).
238
239	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
240	i.e.
241
242	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
243
244	Pressing this combination runs a command with C<%> replaced by the name of
245	the textfile. This command can be set via a resource:
246
247	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
248
249	And the default is likely not useful to anybody but the few people around
250	here :)
251
252	The name of the textfile is the hex encoded md5 sum of the selection, so
253	the same content should lead to the same filename.
254
255	After a successful upload the selection will be replaced by the text given
256	in the C<selection-pastebin-url> resource (again, the % is the placeholder
257	for the filename):
258
259	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
260
261	=back
262		56
263	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
264		58
265	=head2 General API Considerations	59	=head2 General API Considerations
266		60
…		…
276	terminal is destroyed.	70	terminal is destroyed.
277		71
278	Argument names also often indicate the type of a parameter. Here are some	72	Argument names also often indicate the type of a parameter. Here are some
279	hints on what they mean:	73	hints on what they mean:
280		74
281	=over 4	75	=over
282		76
283	=item $text	77	=item $text
284		78
285	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
286	always represents one screen cell. See L<ROW_t> for a discussion of this format.	80	always represents one screen cell. See L<ROW_t> for a discussion of this format.
287		81
288	=item $string	82	=item $string
289		83
290	A perl text string, with an emphasis on I<text>. It can store all unicode	84	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
294	=item $octets	88	=item $octets
295		89
296	Either binary data or - more common - a text string encoded in a	90	Either binary data or - more common - a text string encoded in a
297	locale-specific way.	91	locale-specific way.
298		92
		93	=item $keysym
		94
		95	an integer that is a valid X11 keysym code. You can convert a string
		96	into a keysym and viceversa by using C<XStringToKeysym> and
		97	C<XKeysymToString>.
		98
299	=back	99	=back
300		100
301	=head2 Extension Objects	101	=head2 Extension Objects
302		102
303	Very perl extension is a perl class. A separate perl object is created	103	Every perl extension is a perl class. A separate perl object is created
304	for each terminal and each extension and passed as the first parameter to	104	for each terminal, and each terminal has its own set of extension objects,
305	hooks. So extensions can use their C<$self> object without having to think	105	which are passed as the first parameter to hooks. So extensions can use
306	about other extensions, with the exception of methods and members that	106	their C<$self> object without having to think about clashes with other
		107	extensions or other terminals, with the exception of methods and members
307	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
308	use.	109	internal use.
309		110
310	Although it isn't a C<urxvt::term> object, you can call all methods of the	111	Although it isn't a C<urxvt::term> object, you can call all methods of the
311	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
312		113
313	It has the following methods and data members:	114	Additional methods only supported for extension objects are described in
		115	the C<urxvt::extension> section below.
314		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata. These comments are scanned whenever a
		121	terminal is created and are typically used to autoload extensions when
		122	their resources or command line parameters are used.
		123
		124	Currently, it recognises these comments below. Individual components are
		125	separated by colons (C<:>), and should not contain colons themselves -
		126	there is also currently no escaping mechanism provided for this.
		127
315	=over 4	128	=over
316		129
317	=item $urxvt_term = $self->{term}	130	=item #:META:RESOURCE:name:type:desc
318		131
319	Returns the C<urxvt::term> object associated with this instance of the	132	The RESOURCE comment defines a resource used by the extension, where
320	extension. This member I<must not> be changed in any way.	133	C<name> is the resource name, C<type> is the resource type, C<boolean>
		134	or C<string>, and C<desc> is the resource description.
321		135
322	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	136	The extension will be autoloaded when this resource is specified or used
		137	as a command line parameter.
323		138
324	Dynamically enable the given hooks (named without the C<on_> prefix) for	139	Example: matcher provides the C<matcher.launcher> resource by having this
325	this extension, replacing any previous hook. This is useful when you want	140	comment:
326	to overwrite time-critical hooks only temporarily.
327		141
328	=item $self->disable ($hook_name[, $hook_name..])	142	#:META:RESOURCE:%.launcher:string:default launcher command
329		143
330	Dynamically disable the given hooks.	144	Example: load this extension when the C<-tr> command line option or
		145	resource name is used.
		146
		147	#:META:RESOURCE:tr:boolean:set root pixmap as background
		148
		149	=item #:META:OSC:number:desc
		150
		151	The OSC comment specifies an OSC sequence, where C<number> is the
		152	numerical OSC code and C<desc> is a short description that is currently
		153	unused.
		154
		155	This will cause the extension to be autoloaded when the OSC sequence is
		156	used for the first time.
		157
		158	Note that autoloading carries some extra responsibilities with it:
		159	although the terminal cannot really protect itself against malicious
		160	sources of command sequences, therefore relying on the programs running
		161	I<inside> to sanitize data that they output, it is very common for
		162	programs to emit command sequences from untrusted sources.
		163
		164	While this means that extensions should, as a defense-in-depth mechanism,
		165	always consider whether OSC sequences are safe, autoloading automatically
		166	exposes any autoloaded extension in all terminal windows, so extra care
		167	should be taken.
		168
		169	Example: the background extension registers OSC C<20> like this:
		170
		171	#:META:OSC:20:change/query background image
		172
		173	=item #:META:OSC_PERL:prefix:desc
		174
		175	The same as the OSC comment, but for the Perl OSC sequence (C<777>). The
		176	C<prefix> should be unique among extensions, of course, which is most
		177	easily arranged by using the extension name, although this is not
		178	required.
		179
		180	Example: the overlay-osc extension registers its Perl OSC like this:
		181
		182	#:META:OSC_PERL:overlay:man overlay-osc
331		183
332	=back	184	=back
333		185
334	=head2 Hooks	186	=head2 Hooks
335		187
336	The following subroutines can be declared in extension files, and will be	188	The following subroutines can be declared in extension files, and will be
337	called whenever the relevant event happens.	189	called whenever the relevant event happens.
338		190
339	The first argument passed to them is an extension oject as described in	191	The first argument passed to them is an extension object as described in
340	the in the C<Extension Objects> section.	192	the in the C<Extension Objects> section.
341		193
342	B<All> of these hooks must return a boolean value. If any of the called	194	B<All> of these hooks must return a boolean value. If any of the called
343	hooks returns true, then the event counts as being I<consumed>, and the	195	hooks returns true, then the event counts as being I<consumed>, and the
344	relevant action might not be carried out by the C++ code.	196	relevant action might not be carried out by the C++ code.
345		197
346	I<< When in doubt, return a false value (preferably C<()>). >>	198	I<< When in doubt, return a false value (preferably C<()>). >>
347		199
348	=over 4	200	=over
		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.
349		213
350	=item on_init $term	214	=item on_init $term
351		215
352	Called after a new terminal object has been initialized, but before	216	Called after a new terminal object has been initialized, but before
353	windows are created or the command gets run. Most methods are unsafe to	217	windows are created or the command gets run. Most methods are unsafe to
…		…
357	place.	221	place.
358		222
359	=item on_start $term	223	=item on_start $term
360		224
361	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
362	trying to map (display) the toplevel and returning to the mainloop.	226	trying to map (display) the toplevel and returning to the main loop.
363		227
364	=item on_destroy $term	228	=item on_destroy $term
365		229
366	Called whenever something tries to destroy terminal, before doing anything	230	Called whenever something tries to destroy terminal, when the terminal is
367	yet. If this hook returns true, then destruction is skipped, but this is	231	still fully functional (not for long, though).
368	rarely a good idea.
369		232
370	=item on_reset $term	233	=item on_reset $term
371		234
372	Called after the screen is "reset" for any reason, such as resizing or	235	Called after the screen is "reset" for any reason, such as resizing or
373	control sequences. Here is where you can react on changes to size-related	236	control sequences. Here is where you can react on changes to size-related
…		…
395		258
396	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
397	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
398	by calling C<< $term->selection >>.	261	by calling C<< $term->selection >>.
399		262
400	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.
401		264
402	=item on_sel_extend $term	265	=item on_sel_extend $term
403		266
404	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
405	click) and is either supposed to return false (normal operation), or	268	click) and is either supposed to return false (normal operation), or
406	should extend the selection itelf and return true to suppress the built-in	269	should extend the selection itself and return true to suppress the built-in
407	processing. This can happen multiple times, as long as the callback	270	processing. This can happen multiple times, as long as the callback
408	returns true, it will be called on every further click by the user and is	271	returns true, it will be called on every further click by the user and is
409	supposed to enlarge the selection more and more, if possible.	272	supposed to enlarge the selection more and more, if possible.
410		273
411	See the F<selection> example extension.	274	See the F<selection> example extension.
412		275
413	=item on_view_change $term, $offset	276	=item on_view_change $term, $offset
414		277
415	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
416	scrolls. Offset C<0> means display the normal terminal, positive values	279	scrolls. Offset C<0> means display the normal terminal, positive values
417	show this many lines of scrollback.	280	show this many lines of scrollback.
418		281
419	=item on_scroll_back $term, $lines, $saved	282	=item on_scroll_back $term, $lines, $saved
420		283
…		…
424		287
425	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,
426	$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
427	number of lines that will be in the scrollback buffer.	290	number of lines that will be in the scrollback buffer.
428		291
429	=item on_osc_seq $term, $string	292	=item on_osc_seq $term, $op, $args, $resp
430		293
		294	Called on every OSC sequence and can be used to suppress it or modify its
		295	behaviour. The default should be to return an empty list. A true value
		296	suppresses execution of the request completely. Make sure you don't get
		297	confused by recursive invocations when you output an OSC sequence within
		298	this callback.
		299
		300	C<on_osc_seq_perl> should be used for new behaviour.
		301
		302	=item on_osc_seq_perl $term, $args, $resp
		303
431	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	304	Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
432	operating system command) is processed. Cursor position and other state	305	(OSC = operating system command) is processed. Cursor position and other
433	information is up-to-date when this happens. For interoperability, the	306	state information is up-to-date when this happens. For interoperability,
434	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
435	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
436	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	}
437		320
438	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,
439	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
440	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.
441		327
442	=item on_add_lines $term, $string	328	=item on_add_lines $term, $string
443		329
444	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
445	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
…		…
450	=item on_tt_write $term, $octets	336	=item on_tt_write $term, $octets
451		337
452	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
453	suppress or filter tty input.	339	suppress or filter tty input.
454		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
455	=item on_line_update $term, $row	348	=item on_line_update $term, $row
456		349
457	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
458	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
459	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,
…		…
466	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
467	you cannot just toggle rendition bits, but only set them.	360	you cannot just toggle rendition bits, but only set them.
468		361
469	=item on_refresh_begin $term	362	=item on_refresh_begin $term
470		363
471	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
472	or similar effects by modify terminal contents in refresh_begin, and	365	similar effects by modifying the terminal contents in refresh_begin, and
473	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
474	code is run after this hook, and takes precedence.	367	code is run after this hook, and takes precedence.
475		368
476	=item on_refresh_end $term	369	=item on_refresh_end $term
477		370
478	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>.
479		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
480	=item on_keyboard_command $term, $string	381	=item on_user_command $term, $string *DEPRECATED*
481		382
482	Called whenever the user presses a key combination that has a	383	Called whenever a user-configured event is being activated (e.g. via
483	C<perl:string> action bound to it (see description of the B<keysym>	384	a C<perl:string> action bound to a key, see description of the B<keysym>
484	resource in the @@RXVT_NAME@@(1) manpage).	385	resource in the urxvt(1) manpage).
		386
		387	The event is simply the action string. This interface is going away in
		388	preference to the C<on_action> hook.
		389
		390	=item on_resize_all_windows $term, $new_width, $new_height
		391
		392	Called just after the new window size has been calculated, but before
		393	windows are actually being resized or hints are being set. If this hook
		394	returns a true value, setting of the window hints is being skipped.
485		395
486	=item on_x_event $term, $event	396	=item on_x_event $term, $event
487		397
488	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
489	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
490	members are not passed.	400	members are not passed.
491		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
492	=item on_focus_in $term	406	=item on_focus_in $term
493		407
494	Called whenever the window gets the keyboard focus, before rxvt-unicode	408	Called whenever the window gets the keyboard focus, before rxvt-unicode
495	does focus in processing.	409	does focus in processing.
496		410
497	=item on_focus_out $term	411	=item on_focus_out $term
498		412
499	Called wheneever the window loses keyboard focus, before rxvt-unicode does	413	Called whenever the window loses keyboard focus, before rxvt-unicode does
500	focus out processing.	414	focus out processing.
501		415
502	=item on_configure_notify $term, $event	416	=item on_configure_notify $term, $event
503		417
504	=item on_property_notify $term, $event	418	=item on_property_notify $term, $event
…		…
515		429
516	=item on_map_notify $term, $event	430	=item on_map_notify $term, $event
517		431
518	=item on_unmap_notify $term, $event	432	=item on_unmap_notify $term, $event
519		433
520	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
521	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.
522		436
523	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
524	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
525	(real, not screen-based) row and column under the mouse cursor.	439	(real, not screen-based) row and column under the mouse cursor.
526		440
527	C<on_key_press> additionally receives the string rxvt-unicode would	441	C<on_key_press> additionally receives the string rxvt-unicode would
528	output, if any, in locale-specific encoding.	442	output, if any, in locale-specific encoding.
529		443
530	subwindow.
531
532	=item on_client_message $term, $event	444	=item on_client_message $term, $event
533		445
534	=item on_wm_protocols $term, $event	446	=item on_wm_protocols $term, $event
535		447
536	=item on_wm_delete_window $term, $event	448	=item on_wm_delete_window $term, $event
537		449
538	Called when various types of ClientMessage events are received (all with	450	Called when various types of ClientMessage events are received (all with
539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	451	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
540		452
		453	=item on_bell $term
		454
		455	Called on receipt of a bell character.
		456
541	=back	457	=back
542		458
543	=cut	459	=cut
544		460
545	package urxvt;	461	package urxvt;
546		462
547	use utf8;	463	use utf8;
548	use strict;	464	use strict qw(vars subs);
549	use Carp ();	465	use Carp ();
550	use Scalar::Util ();	466	use Scalar::Util ();
551	use List::Util ();	467	use List::Util ();
552		468
553	our $VERSION = 1;	469	our $VERSION = 1;
554	our $TERM;	470	our $TERM;
555	our @TERM_INIT;	471	our @TERM_INIT; # should go, prevents async I/O etc.
556	our @TERM_EXT;	472	our @TERM_EXT; # should go, prevents async I/O etc.
557	our @HOOKNAME;	473	our @HOOKNAME;
558	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	474	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
559	our %OPTION;	475	our %OPTION;
560		476
561	our $LIBDIR;	477	our $LIBDIR;
562	our $RESNAME;	478	our $RESNAME;
563	our $RESCLASS;	479	our $RESCLASS;
564	our $RXVTNAME;	480	our $RXVTNAME;
565		481
566	our $NOCHAR = chr 0xfffe;	482	our $NOCHAR = chr 0xffff;
567		483
568	=head2 Variables in the C<urxvt> Package	484	=head2 Variables in the C<urxvt> Package
569		485
570	=over 4	486	=over
571		487
572	=item $urxvt::LIBDIR	488	=item $urxvt::LIBDIR
573		489
574	The rxvt-unicode library directory, where, among other things, the perl	490	The rxvt-unicode library directory, where, among other things, the perl
575	modules and scripts are stored.	491	modules and scripts are stored.
…		…
587	The current terminal. This variable stores the current C<urxvt::term>	503	The current terminal. This variable stores the current C<urxvt::term>
588	object, whenever a callback/hook is executing.	504	object, whenever a callback/hook is executing.
589		505
590	=item @urxvt::TERM_INIT	506	=item @urxvt::TERM_INIT
591		507
592	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
593	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
594	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,
595	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.
596		512
597	This complements to the perl-eval commandline option, but gets executed	513	This complements to the perl-eval command line option, but gets executed
598	first.	514	first.
599		515
600	=item @urxvt::TERM_EXT	516	=item @urxvt::TERM_EXT
601		517
602	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
…		…
605		521
606	=back	522	=back
607		523
608	=head2 Functions in the C<urxvt> Package	524	=head2 Functions in the C<urxvt> Package
609		525
610	=over 4	526	=over
611		527
612	=item urxvt::fatal $errormessage	528	=item urxvt::fatal $errormessage
613		529
614	Fatally aborts execution with the given error message. Avoid at all	530	Fatally aborts execution with the given error message (which should
615	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
616	starts up.	532	is acceptable (and useful) is in the init hook, where it prevents the
		533	terminal from starting up.
617		534
618	=item urxvt::warn $string	535	=item urxvt::warn $string
619		536
620	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
621	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
622	that calls this function.	539	that calls this function.
623		540
624	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
625	correct place, e.g. on stderr of the connecting urxvtc client.	542	correct place, e.g. on stderr of the connecting urxvtc client.
626		543
627	Messages have a size limit of 1023 bytes currently.	544	Messages have a size limit of 1023 bytes currently.
		545
		546	=item @terms = urxvt::termlist
		547
		548	Returns all urxvt::term objects that exist in this process, regardless of
		549	whether they are started, being destroyed etc., so be careful. Only term
		550	objects that have perl extensions attached will be returned (because there
		551	is no urxvt::term object associated with others).
628		552
629	=item $time = urxvt::NOW	553	=item $time = urxvt::NOW
630		554
631	Returns the "current time" (as per the event loop).	555	Returns the "current time" (as per the event loop).
632		556
…		…
652	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	576	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
653	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	577	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
654		578
655	Various constants for use in X calls and event processing.	579	Various constants for use in X calls and event processing.
656		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
657	=back	593	=back
658		594
659	=head2 RENDITION	595	=head2 RENDITION
660		596
661	Rendition bitsets contain information about colour, font, font styles and	597	Rendition bitsets contain information about colour, font, font styles and
…		…
664	The following "macros" deal with changes in rendition sets. You should	600	The following "macros" deal with changes in rendition sets. You should
665	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,
666	as they contain important information required for correct operation of	602	as they contain important information required for correct operation of
667	rxvt-unicode.	603	rxvt-unicode.
668		604
669	=over 4	605	=over
670		606
671	=item $rend = urxvt::DEFAULT_RSTYLE	607	=item $rend = urxvt::DEFAULT_RSTYLE
672		608
673	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
674	being reset. Useful as a base to start when creating renditions.	610	being reset. Useful as a base to start when creating renditions.
675		611
676	=item $rend = urxvt::OVERLAY_RSTYLE	612	=item $rend = urxvt::OVERLAY_RSTYLE
677		613
678	Return the rendition mask used for overlays by default.	614	Return the rendition mask used for overlays by default.
679		615
680	=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
681		618
682	Return the bit that enabled bold, italic, blink, reverse-video and	619	Return the bit that enabled bold, italic, blink, reverse-video and
683	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
684	the bitset.	621	the bitset.
685		622
…		…
690	Return the foreground/background colour index, respectively.	627	Return the foreground/background colour index, respectively.
691		628
692	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	629	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
693		630
694	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	631	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		632
		633	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
695		634
696	Replace the foreground/background colour in the rendition mask with the	635	Replace the foreground/background colour in the rendition mask with the
697	specified one.	636	specified one.
698		637
699	=item $value = urxvt::GET_CUSTOM $rend	638	=item $value = urxvt::GET_CUSTOM $rend
…		…
718	unless $msg =~ /\n$/;	657	unless $msg =~ /\n$/;
719	urxvt::warn ($msg);	658	urxvt::warn ($msg);
720	};	659	};
721	}	660	}
722		661
		662	no warnings 'utf8';
		663
		664	sub parse_resource {
		665	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		666
		667	$term->scan_extensions;
		668
		669	# iterating over all resources has quadratic time overhead
		670	# overall, maybe this could be optimised?
		671	my $r = $term->{meta}{resource};
		672	keys %$r; # reset iterator
		673	while (my ($k, $v) = each %$r) {
		674	my $pattern = $k;
		675	$pattern =~ y/./-/ if $isarg;
		676	my $prefix = $name;
		677	my $suffix;
		678	if ($pattern =~ /\-$/) {
		679	$prefix = substr $name, 0, length $pattern;
		680	$suffix = substr $name, length $pattern;
		681	}
		682	if ($pattern eq $prefix) {
		683	$name = "$urxvt::RESCLASS.$k$suffix";
		684
		685	push @{ $term->{perl_ext_3} }, $v->[0];
		686
		687	return 1 unless $isarg;
		688
		689	if ($v->[1] eq "boolean") {
		690	$term->put_option_db ($name, $flag ? "true" : "false");
		691	return 1;
		692	} else {
		693	$term->put_option_db ($name, $value);
		694	return 1 + 2;
		695	}
		696	}
		697	}
		698
		699	0
		700	}
		701
		702	sub usage {
		703	my ($term, $usage_type) = @_;
		704
		705	$term->scan_extensions;
		706
		707	my $r = $term->{meta}{resource};
		708
		709	for my $pattern (sort keys %$r) {
		710	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		711
		712	$desc .= " (-pe $ext)";
		713
		714	if ($usage_type == 1) {
		715	$pattern =~ y/./-/;
		716	$pattern =~ s/-$/-.../g;
		717
		718	if ($type eq "boolean") {
		719	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		720	} else {
		721	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		722	}
		723	} else {
		724	$pattern =~ s/\.$/.*/g;
		725	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		726	}
		727	}
		728	}
		729
723	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	730	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
724		731
725	sub verbose {	732	sub verbose {
726	my ($level, $msg) = @_;	733	my ($level, $msg) = @_;
727	warn "$msg\n" if $level <= $verbosity;	734	warn "$msg\n" if $level <= $verbosity;
728	}	735	}
…		…
739	$pkg =~ s/[^[:word:]]/_/g;	746	$pkg =~ s/[^[:word:]]/_/g;
740	$pkg = "urxvt::ext::$pkg";	747	$pkg = "urxvt::ext::$pkg";
741		748
742	verbose 3, "loading extension '$path' into package '$pkg'";	749	verbose 3, "loading extension '$path' into package '$pkg'";
743		750
		751	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		752
744	open my $fh, "<:raw", $path	753	open my $fh, "<:raw", $path
745	or die "$path: $!";	754	or die "$path: $!";
746		755
747	my $source =	756	my $source =
748	"package $pkg; use strict; use utf8;\n"	757	"package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
749	. "#line 1 \"$path\"\n{\n"	758	. "#line 1 \"$path\"\n{\n"
750	. (do { local $/; <$fh> })	759	. (do { local $/; <$fh> })
751	. "\n};\n1";	760	. "\n};\n1";
752		761
753	eval $source	762	eval $source
…		…
762	# called by the rxvt core	771	# called by the rxvt core
763	sub invoke {	772	sub invoke {
764	local $TERM = shift;	773	local $TERM = shift;
765	my $htype = shift;	774	my $htype = shift;
766		775
767	if ($htype == 0) { # INIT	776	if ($htype == HOOK_INIT) {
768	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	777	$TERM->scan_extensions;
769		778
770	my %ext_arg;	779	my %ext_arg;
771		780
772	{	781	{
773	my @init = @TERM_INIT;	782	my @init = @TERM_INIT;
774	@TERM_INIT = ();	783	@TERM_INIT = ();
…		…
776	my @pkg = @TERM_EXT;	785	my @pkg = @TERM_EXT;
777	@TERM_EXT = ();	786	@TERM_EXT = ();
778	$TERM->register_package ($_) for @pkg;	787	$TERM->register_package ($_) for @pkg;
779	}	788	}
780		789
		790	for (
		791	@{ delete $TERM->{perl_ext_3} },
781	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	792	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		793	) {
782	if ($_ eq "default") {	794	if ($_ eq "default") {
		795
		796	$ext_arg{$_} = []
783	$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
784	} elsif (/^-(.*)$/) {	808	} elsif (/^-(.*)$/) { # remove from set
785	delete $ext_arg{$1};	809	delete $ext_arg{$1};
786	} 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};
787	push @{ $ext_arg{$1} }, $2;	816	push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
		817
788	} else {	818	} else {
789	$ext_arg{$_} ||= [];	819	verbose 2, "cannot parse extension specification '$_', ignoring.";
790	}	820	}
791	}	821	}
792		822
793	while (my ($ext, $argv) = each %ext_arg) {	823	$TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
794	my @files = grep -f $_, map "$_/$ext", @dirs;	824	$TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
795		825
796	if (@files) {	826	for my $ext (sort keys %ext_arg) {
797	$TERM->register_package (extension_package $files[0], $argv);	827	my $path = $TERM->extension_path ($ext);
		828
		829	if (defined $path) {
		830	$TERM->autoload_extension ($ext, $ext_arg{$ext});
798	} else {	831	} else {
799	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";
800	}	833	}
801	}	834	}
802		835
803	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");
804	warn $@ if $@;	837	warn $@ if $@;
805	}	838	}
806		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
807	$retval = undef;	850	$retval = undef;
808		851
809	if (my $cb = $TERM->{_hook}[$htype]) {	852	if (my $cb = $TERM->{_hook}[$htype]) {
810	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	853	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
811	if $verbosity >= 10;	854	if $verbosity >= 10;
812		855
813	keys %$cb;	856	if ($htype == HOOK_ACTION) {
		857	# this hook is only sent to the extension with the name
		858	# matching the first arg
		859	my $pkg = shift;
		860	$pkg =~ y/-/_/;
		861	$pkg = "urxvt::ext::$pkg";
814		862
815	while (my ($pkg, $cb) = each %$cb) {	863	$cb = $cb->{$pkg}
		864	or return undef; #TODO: maybe warn user?
		865
		866	$cb = { $pkg => $cb };
		867	}
		868
		869	for my $pkg (keys %$cb) {
816	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	870	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
817	$retval ||= $retval_;	871	$retval ||= $retval_;
818		872
819	if ($@) {	873	if ($@) {
820	$TERM->ungrab; # better to lose the grab than the session	874	$TERM->ungrab; # better to lose the grab than the session
821	warn $@;	875	warn $@;
…		…
824		878
825	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	879	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
826	if $verbosity >= 11;	880	if $verbosity >= 11;
827	}	881	}
828		882
829	if ($htype == 1) { # DESTROY	883	if ($htype == HOOK_DESTROY) {
830	# clear package objects	884	# clear package objects
831	%$_ = () for values %{ $TERM->{_pkg} };	885	%$_ = () for values %{ $TERM->{_pkg} };
832		886
833	# clear package	887	# clear package
834	%$TERM = ();	888	%$TERM = ();
835	}	889	}
836		890
837	$retval	891	$retval
838	}	892	}
839		893
840	# urxvt::term::extension	894	sub SET_COLOR($$$) {
		895	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		896	}
		897
		898	sub rend2mask {
		899	no strict 'refs';
		900	my ($str, $mask) = (@_, 0);
		901	my %color = ( fg => undef, bg => undef );
		902	my @failed;
		903	for my $spec ( split /\s+/, $str ) {
		904	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		905	$color{lc($1)} = $2;
		906	} else {
		907	my $neg = $spec =~ s/^[-^]//;
		908	unless ( exists &{"RS_$spec"} ) {
		909	push @failed, $spec;
		910	next;
		911	}
		912	my $cur = &{"RS_$spec"};
		913	if ( $neg ) {
		914	$mask &= ~$cur;
		915	} else {
		916	$mask |= $cur;
		917	}
		918	}
		919	}
		920	($mask, @color{qw(fg bg)}, \@failed)
		921	}
841		922
842	package urxvt::term::extension;	923	package urxvt::term::extension;
843		924
844	sub enable {	925	=head2 The C<urxvt::term::extension> class
845	my ($self, %hook) = @_;
846	my $pkg = $self->{_pkg};
847		926
848	while (my ($name, $cb) = each %hook) {	927	Each extension attached to a terminal object is represented by
849	my $htype = $HOOKTYPE{uc $name};	928	a C<urxvt::term::extension> object.
850	defined $htype
851	or Carp::croak "unsupported hook type '$name'";
852		929
853	$self->set_should_invoke ($htype, +1)	930	You can use these objects, which are passed to all callbacks to store any
854	unless exists $self->{term}{_hook}[$htype]{$pkg};	931	state related to the terminal and extension instance.
855		932
856	$self->{term}{_hook}[$htype]{$pkg} = $cb;	933	The methods (And data members) documented below can be called on extension
857	}	934	objects, in addition to call methods documented for the <urxvt::term>
858	}	935	class.
859		936
860	sub disable {	937	=over
861	my ($self, @hook) = @_;
862	my $pkg = $self->{_pkg};
863		938
864	for my $name (@hook) {	939	=item $urxvt_term = $self->{term}
865	my $htype = $HOOKTYPE{uc $name};
866	defined $htype
867	or Carp::croak "unsupported hook type '$name'";
868		940
869	$self->set_should_invoke ($htype, -1)	941	Returns the C<urxvt::term> object associated with this instance of the
870	if delete $self->{term}{_hook}[$htype]{$pkg};	942	extension. This member I<must not> be changed in any way.
871	}	943
872	}	944	=cut
873		945
874	our $AUTOLOAD;	946	our $AUTOLOAD;
875		947
876	sub AUTOLOAD {	948	sub AUTOLOAD {
877	$AUTOLOAD =~ /:([^:]+)$/	949	$AUTOLOAD =~ /:([^:]+)$/
…		…
890		962
891	sub DESTROY {	963	sub DESTROY {
892	# nop	964	# nop
893	}	965	}
894		966
895	# urxvt::destroy_hook	967	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
896		968
897	sub urxvt::destroy_hook::DESTROY {	969	sub urxvt::destroy_hook::DESTROY {
898	${$_[0]}->();	970	${$_[0]}->();
899	}	971	}
900		972
901	sub urxvt::destroy_hook(&) {	973	sub urxvt::destroy_hook(&) {
902	bless \shift, urxvt::destroy_hook::	974	bless \shift, urxvt::destroy_hook::
903	}	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
904		1099
905	package urxvt::anyevent;	1100	package urxvt::anyevent;
906		1101
907	=head2 The C<urxvt::anyevent> Class	1102	=head2 The C<urxvt::anyevent> Class
908		1103
909	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
910	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
911	further programming. The only exception is that you cannot wait on	1106	further programming. The only exception is that you cannot wait on
912	condition variables, but non-blocking condvar use is ok. What this means	1107	condition variables, but non-blocking condvar use is ok.
913	is that you cannot use blocking APIs, but the non-blocking variant should
914	work.
915		1108
916	=cut	1109	In practical terms this means is that you cannot use blocking APIs, but
		1110	the non-blocking variant should work.
917		1111
		1112	=cut
		1113
918	our $VERSION = 1;	1114	our $VERSION = '5.23';
919		1115
920	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1116	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
921	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1117	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
922		1118
923	sub timer {	1119	sub timer {
…		…
925		1121
926	my $cb = $arg{cb};	1122	my $cb = $arg{cb};
927		1123
928	urxvt::timer	1124	urxvt::timer
929	->new	1125	->new
930	->start (urxvt::NOW + $arg{after})	1126	->after ($arg{after}, $arg{interval})
931	->cb (sub {	1127	->cb ($arg{interval} ? $cb : sub {
932	$_[0]->stop; # need to cancel manually	1128	$_[0]->stop; # need to cancel manually
933	$cb->();	1129	$cb->();
934	})	1130	})
935	}	1131	}
936		1132
937	sub io {	1133	sub io {
938	my ($class, %arg) = @_;	1134	my ($class, %arg) = @_;
939		1135
940	my $cb = $arg{cb};	1136	my $cb = $arg{cb};
		1137	my $fd = fileno $arg{fh};
		1138	defined $fd or $fd = $arg{fh};
941		1139
942	bless [$arg{fh}, urxvt::iow	1140	bless [$arg{fh}, urxvt::iow
943	->new	1141	->new
944	->fd (fileno $arg{fh})	1142	->fd ($fd)
945	->events (($arg{poll} =~ /r/ ? 1 : 0)	1143	->events (($arg{poll} =~ /r/ ? 1 : 0)
946	| ($arg{poll} =~ /w/ ? 2 : 0))	1144	| ($arg{poll} =~ /w/ ? 2 : 0))
947	->start	1145	->start
948	->cb (sub {	1146	->cb ($cb)
949	$cb->(($_[1] & 1 ? 'r' : '')
950	. ($_[1] & 2 ? 'w' : ''));
951	})],
952	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	})
953	}	1173	}
954		1174
955	sub DESTROY {	1175	sub DESTROY {
956	$_[0][1]->stop;	1176	$_[0][1]->stop;
957	}	1177	}
958		1178
959	sub condvar {	1179	# only needed for AnyEvent < 6 compatibility
960	bless \my $flag, urxvt::anyevent::condvar::	1180	sub one_event {
961	}
962
963	sub urxvt::anyevent::condvar::broadcast {
964	${$_[0]}++;
965	}
966
967	sub urxvt::anyevent::condvar::wait {
968	unless (${$_[0]}) {
969	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1181	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
970	}
971	}	1182	}
972		1183
973	package urxvt::term;	1184	package urxvt::term;
974		1185
975	=head2 The C<urxvt::term> Class	1186	=head2 The C<urxvt::term> Class
976		1187
977	=over 4	1188	=over
978		1189
979	=cut	1190	=cut
980		1191
981	# find on_xxx subs in the package and register them	1192	# find on_xxx subs in the package and register them
982	# as hooks	1193	# as hooks
983	sub register_package {	1194	sub register_package {
984	my ($self, $pkg, $argv) = @_;	1195	my ($self, $pkg, $argv) = @_;
985		1196
		1197	return if $self->{_pkg}{$pkg};
		1198
986	no strict 'refs';	1199	no strict 'refs';
987		1200
988	urxvt::verbose 6, "register package $pkg to $self";	1201	urxvt::verbose 6, "register package $pkg to $self";
989		1202
990	@{"$pkg\::ISA"} = urxvt::term::extension::;	1203	@{"$pkg\::ISA"} = urxvt::term::extension::;
991		1204
992	my $proxy = bless {	1205	my $proxy = bless {
993	_pkg => $pkg,	1206	_pkg => $pkg,
		1207	_name => ${"$pkg\::_NAME"}, # hackish
994	argv => $argv,	1208	argv => $argv,
995	}, $pkg;	1209	}, $pkg;
996	Scalar::Util::weaken ($proxy->{term} = $self);	1210	Scalar::Util::weaken ($proxy->{term} = $self);
997		1211
998	$self->{_pkg}{$pkg} = $proxy;	1212	$self->{_pkg}{$pkg} = $proxy;
999		1213
1000	for my $name (@HOOKNAME) {	1214	for my $name (@HOOKNAME) {
1001	if (my $ref = $pkg->can ("on_" . lc $name)) {	1215	if (my $ref = $pkg->can ("on_" . lc $name)) {
1002	$proxy->enable ($name => $ref);	1216	$proxy->enable ($name => $ref);
1003	}	1217	}
1004	}	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	}
1005	}	1331	}
1006		1332
1007	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1333	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1008		1334
1009	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
…		…
1011	hash which defines the environment of the new terminal.	1337	hash which defines the environment of the new terminal.
1012		1338
1013	Croaks (and probably outputs an error message) if the new instance	1339	Croaks (and probably outputs an error message) if the new instance
1014	couldn't be created. Returns C<undef> if the new instance didn't	1340	couldn't be created. Returns C<undef> if the new instance didn't
1015	initialise perl, and the terminal object otherwise. The C<init> and	1341	initialise perl, and the terminal object otherwise. The C<init> and
1016	C<start> hooks will be called during this call.	1342	C<start> hooks will be called before this call returns, and are free to
		1343	refer to global data (which is race free).
1017		1344
1018	=cut	1345	=cut
1019		1346
1020	sub new {	1347	sub new {
1021	my ($class, $env, @args) = @_;	1348	my ($class, $env, @args) = @_;
1022		1349
		1350	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1351	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1352
1023	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1353	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1024	}	1354	}
1025		1355
1026	=item $term->destroy	1356	=item $term->destroy
1027		1357
1028	Destroy the terminal object (close the window, free resources	1358	Destroy the terminal object (close the window, free resources
1029	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
1030	watchers (timers, io watchers) are still active.	1360	watchers (timers, io watchers) are still active.
1031		1361
1032	=item $term->exec_async ($cmd[, @args])	1362	=item $term->exec_async ($cmd[, @args])
1033		1363
1034	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
1035	("starts") programs in the background. This function takes care of setting	1365	("starts") programs in the background. This function takes care of setting
1036	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
1037	be preferred over explicit calls to C<exec> or C<system>.	1367	be preferred over explicit calls to C<exec> or C<system>.
1038		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
1039	Returns the pid of the subprocess or C<undef> on error.	1373	Returns the pid of the subprocess or C<undef> on error.
1040		1374
1041	=cut	1375	=cut
1042		1376
1043	sub exec_async {	1377	sub exec_async {
…		…
1046	my $pid = fork;	1380	my $pid = fork;
1047		1381
1048	return $pid	1382	return $pid
1049	if !defined $pid or $pid;	1383	if !defined $pid or $pid;
1050		1384
		1385	%ENV = (
1051	%ENV = %{ $self->env };	1386	%{ $self->env },
		1387	URXVT_EXT_WINDOWID => $self->parent,
		1388	);
1052		1389
1053	exec @_;	1390	exec @_;
1054	urxvt::_exit 255;	1391	urxvt::_exit 255;
1055	}	1392	}
1056		1393
…		…
1058		1395
1059	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
1060	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
1061	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.
1062		1399
1063	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
1064	source file F</src/optinc.h> to see the actual list:	1401	source file F</src/optinc.h> to see the actual list:
1065		1402
1066	borderLess console cursorBlink cursorUnderline hold iconic insecure	1403	borderLess buffered console cursorBlink cursorUnderline hold iconic
1067	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1404	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1068	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1405	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1069	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1406	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1070	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1407	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1071	transparent tripleclickwords utmpInhibit visualBell	1408	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1409	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1072		1410
1073	=item $value = $term->resource ($name[, $newval])	1411	=item $value = $term->resource ($name[, $newval])
1074		1412
1075	Returns the current resource value associated with a given name and	1413	Returns the current resource value associated with a given name and
1076	optionally sets a new value. Setting values is most useful in the C<init>	1414	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1085	likely change).	1423	likely change).
1086		1424
1087	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
1088	terminal is destroyed, so changing options frequently will eat memory.	1426	terminal is destroyed, so changing options frequently will eat memory.
1089		1427
1090	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
1091	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>
1092	to see the actual list:	1430	to see the actual list:
1093		1431
1094	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1432	answerbackstring backgroundPixmap backspace_key blurradius
1095	borderLess color cursorBlink cursorUnderline cutchars delete_key	1433	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1096	display_name embed ext_bwidth fade font geometry hold iconName	1434	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1097	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
1098	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1437	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1099	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1438	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1100	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1439	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1101	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1440	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1102	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1441	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1103	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1442	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1104	secondaryScreen secondaryScroll selectstyle shade term_name title	1443	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1105	transient_for transparent transparent_all tripleclickwords utmpInhibit	1444	term_name title transient_for transparent tripleclickwords urgentOnBell
1106	visualBell	1445	utmpInhibit visualBell rewrapMode disablePasteBrackets
1107		1446
1108	=cut	1447	=cut
1109		1448
1110	sub resource($$;$) {	1449	sub resource($$;$) {
1111	my ($self, $name) = (shift, shift);	1450	my ($self, $name) = (shift, shift);
1112	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1451	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1113	&urxvt::term::_resource	1452	goto &urxvt::term::_resource
1114	}	1453	}
1115		1454
1116	=item $value = $term->x_resource ($pattern)	1455	=item $value = $term->x_resource ($pattern)
1117		1456
1118	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
1119	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
1120	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
1121	resource with that pattern exists.	1460	resource with that pattern exists.
1122		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
1123	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
1124	only one resource database per display, and later invocations might return	1473	only one resource database per display, and later invocations might return
1125	the wrong resources.	1474	the wrong resources.
1126		1475
1127	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1476	=item $value = $term->x_resource_boolean ($pattern)
1128		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
1129	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
1130	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	}
1131		1516
1132	=item $rend = $term->rstyle ([$new_rstyle])	1517	=item $rend = $term->rstyle ([$new_rstyle])
1133		1518
1134	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
1135	the terminal application will use this style.	1520	the terminal application will use this style.
…		…
1143		1528
1144	=item ($row, $col) = $term->selection_beg ([$row, $col])	1529	=item ($row, $col) = $term->selection_beg ([$row, $col])
1145		1530
1146	=item ($row, $col) = $term->selection_end ([$row, $col])	1531	=item ($row, $col) = $term->selection_end ([$row, $col])
1147		1532
1148	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.
1149	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.
1150		1542
1151	=item $term->selection_make ($eventtime[, $rectangular])	1543	=item $term->selection_make ($eventtime[, $rectangular])
1152		1544
1153	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
1154	C<selection_end>. If C<$rectangular> is true (default: false), a	1546	C<selection_end>. If C<$rectangular> is true (default: false), a
1155	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
1156	a selection.	1548	a selection.
1157		1549
1158	=item $success = $term->selection_grab ($eventtime)	1550	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1159		1551
1160	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
1161	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
1162	is mostly useful from within C<on_sel_grab> hooks.	1555	is mostly useful from within C<on_sel_grab> hooks.
1163		1556
1164	=item $oldtext = $term->selection ([$newtext])	1557	=item $oldtext = $term->selection ([$newtext, $clipboard])
1165		1558
1166	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.
1167		1565
1168	=item $term->overlay_simple ($x, $y, $text)	1566	=item $term->overlay_simple ($x, $y, $text)
1169		1567
1170	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.
1171		1569
…		…
1199	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
1200	as long as the perl object is referenced.	1598	as long as the perl object is referenced.
1201		1599
1202	The methods currently supported on C<urxvt::overlay> objects are:	1600	The methods currently supported on C<urxvt::overlay> objects are:
1203		1601
1204	=over 4	1602	=over
1205		1603
1206	=item $overlay->set ($x, $y, $text, $rend)	1604	=item $overlay->set ($x, $y, $text[, $rend])
1207		1605
1208	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
1209	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
1210	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.
1211		1611
1212	=item $overlay->hide	1612	=item $overlay->hide
1213		1613
1214	If visible, hide the overlay, but do not destroy it.	1614	If visible, hide the overlay, but do not destroy it.
1215		1615
…		…
1251	Returns the number of screen-cells this string would need. Correctly	1651	Returns the number of screen-cells this string would need. Correctly
1252	accounts for wide and combining characters.	1652	accounts for wide and combining characters.
1253		1653
1254	=item $octets = $term->locale_encode ($string)	1654	=item $octets = $term->locale_encode ($string)
1255		1655
1256	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>.
1257		1658
1258	=item $string = $term->locale_decode ($octets)	1659	=item $string = $term->locale_decode ($octets)
1259		1660
1260	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>.
1261		1663
1262	=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])
1263		1665
1264	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
1265	(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
…		…
1278		1680
1279	=item $term->scr_add_lines ($string)	1681	=item $term->scr_add_lines ($string)
1280		1682
1281	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
1282	running inside the terminal. It may not contain command sequences (escape	1684	running inside the terminal. It may not contain command sequences (escape
1283	codes), but is free to use line feeds, carriage returns and tabs. The	1685	codes - see C<cmd_parse> for that), but is free to use line feeds,
1284	string is a normal text string, not in locale-dependent encoding.	1686	carriage returns and tabs. The string is a normal text string, not in
		1687	locale-dependent encoding.
1285		1688
1286	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
1287	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
1288	C<on_add_lines> hook, though.	1691	C<on_add_lines> hook, though.
1289		1692
…		…
1297	locale-specific encoding of the terminal and can contain command sequences	1700	locale-specific encoding of the terminal and can contain command sequences
1298	(escape codes) that will be interpreted.	1701	(escape codes) that will be interpreted.
1299		1702
1300	=item $term->tt_write ($octets)	1703	=item $term->tt_write ($octets)
1301		1704
1302	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
1303	pass characters instead of octets, you should convert your strings first	1707	characters instead of octets, you should convert your strings first to the
1304	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.
1305		1723
1306	=item $old_events = $term->pty_ev_events ([$new_events])	1724	=item $old_events = $term->pty_ev_events ([$new_events])
1307		1725
1308	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
1309	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
1310	description of C<< urxvt::timer->events >>. Make sure to always restore	1728	description of C<< urxvt::timer->events >>. Make sure to always restore
1311	the previous value.	1729	the previous value.
1312		1730
		1731	=item $fd = $term->pty_fd
		1732
		1733	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1734	is used.
		1735
1313	=item $windowid = $term->parent	1736	=item $windowid = $term->parent
1314		1737
1315	Return the window id of the toplevel window.	1738	Return the window id of the toplevel window.
1316		1739
1317	=item $windowid = $term->vt	1740	=item $windowid = $term->vt
…		…
1323	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
1324	to receive pointer events all the times:	1747	to receive pointer events all the times:
1325		1748
1326	$term->vt_emask_add (urxvt::PointerMotionMask);	1749	$term->vt_emask_add (urxvt::PointerMotionMask);
1327		1750
		1751	=item $term->set_urgency ($set)
		1752
		1753	Enable/disable the urgency hint on the toplevel window.
		1754
		1755	=item $term->focus_in
		1756
		1757	=item $term->focus_out
		1758
		1759	=item $term->key_press ($state, $keycode[, $time])
		1760
		1761	=item $term->key_release ($state, $keycode[, $time])
		1762
		1763	Deliver various fake events to to terminal.
		1764
1328	=item $window_width = $term->width	1765	=item $window_width = $term->width ([$new_value])
1329		1766
1330	=item $window_height = $term->height	1767	=item $window_height = $term->height ([$new_value])
1331		1768
1332	=item $font_width = $term->fwidth	1769	=item $font_width = $term->fwidth ([$new_value])
1333		1770
1334	=item $font_height = $term->fheight	1771	=item $font_height = $term->fheight ([$new_value])
1335		1772
1336	=item $font_ascent = $term->fbase	1773	=item $font_ascent = $term->fbase ([$new_value])
1337		1774
1338	=item $terminal_rows = $term->nrow	1775	=item $terminal_rows = $term->nrow ([$new_value])
1339		1776
1340	=item $terminal_columns = $term->ncol	1777	=item $terminal_columns = $term->ncol ([$new_value])
1341		1778
1342	=item $has_focus = $term->focus	1779	=item $has_focus = $term->focus ([$new_value])
1343		1780
1344	=item $is_mapped = $term->mapped	1781	=item $is_mapped = $term->mapped ([$new_value])
1345		1782
1346	=item $max_scrollback = $term->saveLines	1783	=item $max_scrollback = $term->saveLines ([$new_value])
1347		1784
1348	=item $nrow_plus_saveLines = $term->total_rows	1785	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1349		1786
1350	=item $topmost_scrollback_row = $term->top_row	1787	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1351		1788
1352	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.
1353		1791
1354	=item $x_display = $term->display_id	1792	=item $x_display = $term->display_id
1355		1793
1356	Return the DISPLAY used by rxvt-unicode.	1794	Return the DISPLAY used by rxvt-unicode.
1357		1795
…		…
1362	=item $env = $term->env	1800	=item $env = $term->env
1363		1801
1364	Returns a copy of the environment in effect for the terminal as a hashref	1802	Returns a copy of the environment in effect for the terminal as a hashref
1365	similar to C<\%ENV>.	1803	similar to C<\%ENV>.
1366		1804
		1805	=item @envv = $term->envv
		1806
		1807	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1808
		1809	=item @argv = $term->argv
		1810
		1811	Return the argument vector as this terminal, similar to @ARGV, but
		1812	includes the program name as first element.
		1813
1367	=cut	1814	=cut
1368		1815
1369	sub env {	1816	sub env {
1370	if (my $env = $_[0]->_env) {
1371	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1817	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1372	} else {
1373	+{ %ENV }
1374	}
1375	}	1818	}
1376		1819
1377	=item $modifiermask = $term->ModLevel3Mask	1820	=item $modifiermask = $term->ModLevel3Mask
1378		1821
1379	=item $modifiermask = $term->ModMetaMask	1822	=item $modifiermask = $term->ModMetaMask
…		…
1387		1830
1388	Returns the currently displayed screen (0 primary, 1 secondary).	1831	Returns the currently displayed screen (0 primary, 1 secondary).
1389		1832
1390	=item $cursor_is_hidden = $term->hidden_cursor	1833	=item $cursor_is_hidden = $term->hidden_cursor
1391		1834
1392	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	}
1393		1846
1394	=item $view_start = $term->view_start ([$newvalue])	1847	=item $view_start = $term->view_start ([$newvalue])
1395		1848
1396	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,
1397	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
1398	this many lines into the scrollback buffer.	1851	the terminal contents. Lower values scroll this many lines into the
		1852	scrollback buffer.
1399		1853
1400	=item $term->want_refresh	1854	=item $term->want_refresh
1401		1855
1402	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1856	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1403	compare the on-screen display with its stored representation. If they	1857	compare the on-screen display with its stored representation. If they
1404	differ, it redraws the differences.	1858	differ, it redraws the differences.
1405		1859
1406	Used after changing terminal contents to display them.	1860	Used after changing terminal contents to display them.
1407		1861
		1862	=item $term->refresh_check
		1863
		1864	Checks if a refresh has been requested and, if so, schedules one.
		1865
1408	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1866	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1409		1867
1410	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 >>
1411	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
1412	terminal line. The scrollback buffer starts at line C<-1> and extends to
1413	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1870	terminal line. Nothing will be returned if a nonexistent line
1414	is requested.	1871	is requested.
1415		1872
1416	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
1417	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
1418	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
1419	automatically be updated.	1876	automatically be updated.
1420		1877
1421	C<$text> is in a special encoding: tabs and wide characters that use	1878	C<$text> is in a special encoding: tabs and wide characters that use more
1422	more than one cell when displayed are padded with C<$urxvt::NOCHAR>	1879	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1423	characters. Characters with combining characters and other characters that	1880	characters. Characters with combining characters and other characters that
1424	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
1425	in the private use area.	1882	in the private use area.
1426		1883
1427	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
1428	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
1429	characters.	1886	characters.
…		…
1458		1915
1459	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
1460	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
1461	following methods:	1918	following methods:
1462		1919
1463	=over 4	1920	=over
1464		1921
1465	=item $text = $line->t ([$new_text])	1922	=item $text = $line->t ([$new_text])
1466		1923
1467	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>
1468		1925
…		…
1514	}	1971	}
1515		1972
1516	sub urxvt::line::t {	1973	sub urxvt::line::t {
1517	my ($self) = @_;	1974	my ($self) = @_;
1518		1975
1519	if (@_ > 1)	1976	if (@_ > 1) {
1520	{
1521	$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})
1522	for $self->{beg} .. $self->{end};	1978	for $self->{beg} .. $self->{end};
1523	}	1979	}
1524		1980
1525	defined wantarray &&	1981	defined wantarray &&
1526	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1982	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1527	0, $self->{len}	1983	0, $self->{len}
1528	}	1984	}
1529		1985
1530	sub urxvt::line::r {	1986	sub urxvt::line::r {
1531	my ($self) = @_;	1987	my ($self) = @_;
1532		1988
1533	if (@_ > 1)	1989	if (@_ > 1) {
1534	{
1535	$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})
1536	for $self->{beg} .. $self->{end};	1991	for $self->{beg} .. $self->{end};
1537	}	1992	}
1538		1993
1539	if (defined wantarray) {	1994	if (defined wantarray) {
1540	my $rend = [	1995	my $rend = [
1541	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1996	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1542	];	1997	];
…		…
1574	where one character corresponds to one screen cell. See	2029	where one character corresponds to one screen cell. See
1575	C<< $term->ROW_t >> for details.	2030	C<< $term->ROW_t >> for details.
1576		2031
1577	=item $string = $term->special_decode $text	2032	=item $string = $term->special_decode $text
1578		2033
1579	Converts rxvt-unicodes text reprsentation into a perl string. See	2034	Converts rxvt-unicode's text representation into a perl string. See
1580	C<< $term->ROW_t >> for details.	2035	C<< $term->ROW_t >> for details.
1581		2036
1582	=item $success = $term->grab_button ($button, $modifiermask)	2037	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1583		2038
		2039	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2040
1584	Registers a synchronous button grab. See the XGrabButton manpage.	2041	Register/unregister a synchronous button grab. See the XGrabButton
		2042	manpage.
1585		2043
1586	=item $success = $term->grab ($eventtime[, $sync])	2044	=item $success = $term->grab ($eventtime[, $sync])
1587		2045
1588	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2046	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1589	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2047	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1590		2048
1591	=item $term->allow_events_async	2049	=item $term->allow_events_async
1592		2050
1593	Calls XAllowEvents with AsyncBoth for the most recent grab.	2051	Calls XAllowEvents with AsyncBoth for the most recent grab.
1594		2052
…		…
1601	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2059	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1602	recent grab.	2060	recent grab.
1603		2061
1604	=item $term->ungrab	2062	=item $term->ungrab
1605		2063
1606	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
1607	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
1608	the session.	2066	the session.
1609		2067
1610	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	2068	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1611		2069
…		…
1613		2071
1614	=item @atoms = $term->XListProperties ($window)	2072	=item @atoms = $term->XListProperties ($window)
1615		2073
1616	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	2074	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1617		2075
1618	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	2076	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1619		2077
1620	=item $term->XDeleteProperty ($window, $property)	2078	=item $term->XDeleteProperty ($window, $property)
1621		2079
1622	=item $window = $term->DefaultRootWindow	2080	=item $window = $term->DefaultRootWindow
1623		2081
…		…
1630	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2088	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1631		2089
1632	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2090	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1633		2091
1634	=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)
1635		2097
1636	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
1637	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
1638	directory onto the X functions of the same name.	2100	directly onto the X functions of the same name.
1639		2101
1640	=back	2102	=back
1641		2103
1642	=cut	2104	=cut
1643		2105
1644	package urxvt::popup;	2106	package urxvt::popup;
1645		2107
1646	=head2 The C<urxvt::popup> Class	2108	=head2 The C<urxvt::popup> Class
1647		2109
1648	=over 4	2110	=over
1649		2111
1650	=cut	2112	=cut
1651		2113
1652	sub add_item {	2114	sub add_item {
1653	my ($self, $item) = @_;	2115	my ($self, $item) = @_;
…		…
1707	my ($self, $text, $cb) = @_;	2169	my ($self, $text, $cb) = @_;
1708		2170
1709	$self->add_item ({ type => "button", text => $text, activate => $cb});	2171	$self->add_item ({ type => "button", text => $text, activate => $cb});
1710	}	2172	}
1711		2173
1712	=item $popup->add_toggle ($text, $cb, $initial_value)	2174	=item $popup->add_toggle ($text, $initial_value, $cb)
1713		2175
1714	Adds a toggle/checkbox item to the popup. Teh callback gets called	2176	Adds a toggle/checkbox item to the popup. The callback gets called
1715	whenever it gets toggled, with a boolean indicating its value as its first	2177	whenever it gets toggled, with a boolean indicating its new value as its
1716	argument.	2178	first argument.
1717		2179
1718	=cut	2180	=cut
1719		2181
1720	sub add_toggle {	2182	sub add_toggle {
1721	my ($self, $text, $cb, $value) = @_;	2183	my ($self, $text, $value, $cb) = @_;
1722		2184
1723	my $item; $item = {	2185	my $item; $item = {
1724	type => "button",	2186	type => "button",
1725	text => " $text",	2187	text => " $text",
1726	value => $value,	2188	value => $value,
…		…
1745	my $env = $self->{term}->env;	2207	my $env = $self->{term}->env;
1746	# 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.
1747	delete $env->{LC_ALL};	2209	delete $env->{LC_ALL};
1748	$env->{LC_CTYPE} = $self->{term}->locale;	2210	$env->{LC_CTYPE} = $self->{term}->locale;
1749		2211
1750	urxvt::term->new ($env, "popup",	2212	my $term = urxvt::term->new (
		2213	$env, "popup",
1751	"--perl-lib" => "", "--perl-ext-common" => "",	2214	"--perl-lib" => "", "--perl-ext-common" => "",
1752	"-pty-fd" => -1, "-sl" => 0,	2215	"-pty-fd" => -1, "-sl" => 0,
1753	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2216	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1754	"--transient-for" => $self->{term}->parent,	2217	"--transient-for" => $self->{term}->parent,
1755	"-display" => $self->{term}->display_id,	2218	"-display" => $self->{term}->display_id,
1756	"-pe" => "urxvt-popup")	2219	"-pe" => "urxvt-popup",
1757	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	}
1758	}	2227	}
1759		2228
1760	sub DESTROY {	2229	sub DESTROY {
1761	my ($self) = @_;	2230	my ($self) = @_;
1762		2231
…		…
1767	=back	2236	=back
1768		2237
1769	=cut	2238	=cut
1770		2239
1771	package urxvt::watcher;	2240	package urxvt::watcher;
1772
1773	@urxvt::timer::ISA = __PACKAGE__;
1774	@urxvt::iow::ISA = __PACKAGE__;
1775	@urxvt::pw::ISA = __PACKAGE__;
1776	@urxvt::iw::ISA = __PACKAGE__;
1777		2241
1778	=head2 The C<urxvt::timer> Class	2242	=head2 The C<urxvt::timer> Class
1779		2243
1780	This class implements timer watchers/events. Time is represented as a	2244	This class implements timer watchers/events. Time is represented as a
1781	fractional number of seconds since the epoch. Example:	2245	fractional number of seconds since the epoch. Example:
…		…
1785	->new	2249	->new
1786	->interval (1)	2250	->interval (1)
1787	->cb (sub {	2251	->cb (sub {
1788	$term->{overlay}->set (0, 0,	2252	$term->{overlay}->set (0, 0,
1789	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2253	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1790	});	2254	});
1791		2255
1792	=over 4	2256	=over
1793		2257
1794	=item $timer = new urxvt::timer	2258	=item $timer = new urxvt::timer
1795		2259
1796	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
1797	immediately.	2261	immediately.
1798		2262
1799	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2263	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1800		2264
1801	Set the callback to be called when the timer triggers.	2265	Set the callback to be called when the timer triggers.
1802		2266
1803	=item $tstamp = $timer->at
1804
1805	Return the time this watcher will fire next.
1806
1807	=item $timer = $timer->set ($tstamp)	2267	=item $timer = $timer->set ($tstamp[, $interval])
1808		2268
1809	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).
1810		2271
1811	=item $timer = $timer->interval ($interval)	2272	=item $timer = $timer->interval ($interval)
1812		2273
1813	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
1814	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
1815	is automatically rescheduled at the given intervals.	2276	is automatically rescheduled at the given intervals.
1816		2277
1817	=item $timer = $timer->start	2278	=item $timer = $timer->start
1818		2279
1819	Start the timer.	2280	Start the timer.
1820		2281
1821	=item $timer = $timer->start ($tstamp)	2282	=item $timer = $timer->start ($tstamp[, $interval])
1822		2283
1823	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.
1824		2286
1825	=item $timer = $timer->after ($delay)	2287	=item $timer = $timer->after ($delay[, $interval])
1826		2288
1827	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>.
1828		2290
1829	=item $timer = $timer->stop	2291	=item $timer = $timer->stop
1830		2292
…		…
1838		2300
1839	$term->{socket} = ...	2301	$term->{socket} = ...
1840	$term->{iow} = urxvt::iow	2302	$term->{iow} = urxvt::iow
1841	->new	2303	->new
1842	->fd (fileno $term->{socket})	2304	->fd (fileno $term->{socket})
1843	->events (urxvt::EVENT_READ)	2305	->events (urxvt::EV_READ)
1844	->start	2306	->start
1845	->cb (sub {	2307	->cb (sub {
1846	my ($iow, $revents) = @_;	2308	my ($iow, $revents) = @_;
1847	# $revents must be 1 here, no need to check	2309	# $revents must be 1 here, no need to check
1848	sysread $term->{socket}, my $buf, 8192	2310	sysread $term->{socket}, my $buf, 8192
1849	or end-of-file;	2311	or end-of-file;
1850	});	2312	});
1851		2313
1852		2314
1853	=over 4	2315	=over
1854		2316
1855	=item $iow = new urxvt::iow	2317	=item $iow = new urxvt::iow
1856		2318
1857	Create a new io watcher object in stopped state.	2319	Create a new io watcher object in stopped state.
1858		2320
…		…
1861	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>
1862	is a bitset as described in the C<events> method.	2324	is a bitset as described in the C<events> method.
1863		2325
1864	=item $iow = $iow->fd ($fd)	2326	=item $iow = $iow->fd ($fd)
1865		2327
1866	Set the filedescriptor (not handle) to watch.	2328	Set the file descriptor (not handle) to watch.
1867		2329
1868	=item $iow = $iow->events ($eventmask)	2330	=item $iow = $iow->events ($eventmask)
1869		2331
1870	Set the event mask to watch. The only allowed values are	2332	Set the event mask to watch. The only allowed values are
1871	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2333	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1872	together, or C<urxvt::EVENT_NONE>.	2334	together, or C<urxvt::EV_NONE>.
1873		2335
1874	=item $iow = $iow->start	2336	=item $iow = $iow->start
1875		2337
1876	Start watching for requested events on the given handle.	2338	Start watching for requested events on the given handle.
1877		2339
1878	=item $iow = $iow->stop	2340	=item $iow = $iow->stop
1879		2341
1880	Stop watching for events on the given filehandle.	2342	Stop watching for events on the given file handle.
1881		2343
1882	=back	2344	=back
1883		2345
1884	=head2 The C<urxvt::iw> Class	2346	=head2 The C<urxvt::iw> Class
1885		2347
1886	This class implements idle watchers, that get called automatically when	2348	This class implements idle watchers, that get called automatically when
1887	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
1888	some useful work.	2350	some useful work.
1889		2351
1890	=over 4	2352	=over
1891		2353
1892	=item $iw = new urxvt::iw	2354	=item $iw = new urxvt::iw
1893		2355
1894	Create a new idle watcher object in stopped state.	2356	Create a new idle watcher object in stopped state.
1895		2357
…		…
1918	->new	2380	->new
1919	->start ($pid)	2381	->start ($pid)
1920	->cb (sub {	2382	->cb (sub {
1921	my ($pw, $exit_status) = @_;	2383	my ($pw, $exit_status) = @_;
1922	...	2384	...
1923	});	2385	});
1924		2386
1925	=over 4	2387	=over
1926		2388
1927	=item $pw = new urxvt::pw	2389	=item $pw = new urxvt::pw
1928		2390
1929	Create a new process watcher in stopped state.	2391	Create a new process watcher in stopped state.
1930		2392
…		…
1932		2394
1933	Set the callback to be called when the timer triggers.	2395	Set the callback to be called when the timer triggers.
1934		2396
1935	=item $pw = $timer->start ($pid)	2397	=item $pw = $timer->start ($pid)
1936		2398
1937	Tells the wqtcher to start watching for process C<$pid>.	2399	Tells the watcher to start watching for process C<$pid>.
1938		2400
1939	=item $pw = $pw->stop	2401	=item $pw = $pw->stop
1940		2402
1941	Stop the watcher.	2403	Stop the watcher.
1942		2404
…		…
1947	=head2 URXVT_PERL_VERBOSITY	2409	=head2 URXVT_PERL_VERBOSITY
1948		2410
1949	This variable controls the verbosity level of the perl extension. Higher	2411	This variable controls the verbosity level of the perl extension. Higher
1950	numbers indicate more verbose output.	2412	numbers indicate more verbose output.
1951		2413
1952	=over 4	2414	=over
1953		2415
1954	=item == 0 - fatal messages	2416	=item == 0 - fatal messages only
		2417
		2418	=item >= 2 - general warnings (default level)
1955		2419
1956	=item >= 3 - script loading and management	2420	=item >= 3 - script loading and management
1957		2421
1958	=item >=10 - all called hooks	2422	=item >=10 - all called hooks
1959		2423
1960	=item >=11 - hook reutrn values	2424	=item >=11 - hook return values
1961		2425
1962	=back	2426	=back
1963		2427
1964	=head1 AUTHOR	2428	=head1 AUTHOR
1965		2429
1966	Marc Lehmann <pcg@goof.com>	2430	Marc Lehmann <schmorp@schmorp.de>
1967	http://software.schmorp.de/pkg/rxvt-unicode	2431	http://software.schmorp.de/pkg/rxvt-unicode
1968		2432
1969	=cut	2433	=cut
1970		2434
1971	1	2435	1
		2436
		2437	# vim: sw=3:

Diff Legend

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