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

Diff Legend

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