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

Diff Legend

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