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

Diff Legend

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