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.123 by root, Sat Jan 21 14:49:18 2006 UTC vs.
Revision 1.245 by root, Mon Dec 22 09:10:12 2014 UTC

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

Diff Legend

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