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

Diff Legend

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