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.126 by root, Tue Jan 24 19:14:36 2006 UTC vs.
Revision 1.251 by root, Fri Dec 26 22:52:23 2014 UTC

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

Diff Legend

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