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.133 by root, Mon Feb 6 06:14:08 2006 UTC vs.
Revision 1.246 by root, Fri Dec 26 18:58:19 2014 UTC

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

Diff Legend

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