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.119 by root, Fri Jan 20 18:59:31 2006 UTC vs.
Revision 1.229 by root, Sat Apr 26 18:53:51 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	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 selection-autotransform
133
134	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.
136
137	It works by specifying perl snippets (most useful is a single C<s///>
138	operator) that modify C<$_> as resources:
139
140	URxvt.selection-autotransform.0: transform
141	URxvt.selection-autotransform.1: transform
142	...
143
144	For example, the following will transform selections of the form
145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
146	$word>:
147
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150	And this example matches the same,but replaces it with vi-commands you can
151	paste directly into your (vi :) editor:
152
153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155	Of course, this can be modified to suit your needs and your editor :)
156
157	To expand the example above to typical perl error messages ("XXX at
158	FILENAME line YYY."), you need a slightly more elaborate solution:
159
160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163	The first line tells the selection code to treat the unchanging part of
164	every error message as a selection pattern, and the second line transforms
165	the message into vi commands to load the file.
166
167	=item tabbed
168
169	This transforms the terminal into a tabbar with additional terminals, that
170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
172	button per tab.
173
174	Clicking a button will activate that tab. Pressing B<Shift-Left> and
175	B<Shift-Right> will switch to the tab left or right of the current one,
176	while B<Shift-Down> creates a new tab.
177
178	=item mark-urls
179
180	Uses per-line display filtering (C<on_line_update>) to underline urls and
181	make them clickable. When middle-clicked, the program specified in the
182	resource C<urlLauncher> (default C<x-www-browser>) will be started with
183	the URL as first argument.
184
185	=item automove-background
186
187	This is basically a one-line extension that dynamically changes the background pixmap offset
188	to the window position, in effect creating the same effect as pseudo transparency with
189	a custom pixmap. No scaling is supported in this mode. Exmaple:
190
191	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
192
193	=item block-graphics-to-ascii
194
195	A not very useful example of filtering all text output to the terminal,
196	by replacing all line-drawing characters (U+2500 .. U+259F) by a
197	similar-looking ascii character.
198
199	=item digital-clock
200
201	Displays a digital clock using the built-in overlay.
202
203	=item example-refresh-hooks
204
205	Displays a very simple digital clock in the upper right corner of the
206	window. Illustrates overwriting the refresh callbacks to create your own
207	overlays or changes.
208
209	=item selection-pastebin
210
211	This is a little rarely useful extension that Uploads the selection as
212	textfile to a remote site (or does other things). (The implementation is
213	not currently secure for use in a multiuser environment as it writes to
214	F</tmp> directly.).
215
216	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
217	i.e.
218
219	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
220
221	Pressing this combination runs a command with C<%> replaced by the name of
222	the textfile. This command can be set via a resource:
223
224	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
225
226	And the default is likely not useful to anybody but the few people around
227	here :)
228
229	The name of the textfile is the hex encoded md5 sum of the selection, so
230	the same content should lead to the same filename.
231
232	After a successful upload the selection will be replaced by the text given
233	in the C<selection-pastebin-url> resource (again, the % is the placeholder
234	for the filename):
235
236	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
237
238	=back
239		50
240	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
241		52
242	=head2 General API Considerations	53	=head2 General API Considerations
243		54
…		…
257		68
258	=over 4	69	=over 4
259		70
260	=item $text	71	=item $text
261		72
262	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
263	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.
264		75
265	=item $string	76	=item $string
266		77
267	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
…		…
271	=item $octets	82	=item $octets
272		83
273	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
274	locale-specific way.	85	locale-specific way.
275		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
276	=back	93	=back
277		94
278	=head2 Extension Objects	95	=head2 Extension Objects
279		96
280	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
281	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,
282	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
283	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
284	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
285	use.	103	internal use.
286		104
287	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
288	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
289		107
290	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
291		109	the C<urxvt::extension> section below.
292	=over 4
293
294	=item $urxvt_term = $self->{term}
295
296	Returns the C<urxvt::term> object associated with this instance of the
297	extension. This member I<must not> be changed in any way.
298
299	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
300
301	Dynamically enable the given hooks (named without the C<on_> prefix) for
302	this extension, replacing any previous hook. This is useful when you want
303	to overwrite time-critical hooks only temporarily.
304
305	=item $self->disable ($hook_name[, $hook_name..])
306
307	Dynamically disable the given hooks.
308
309	=back
310		110
311	=head2 Hooks	111	=head2 Hooks
312		112
313	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
314	called whenever the relevant event happens.	114	called whenever the relevant event happens.
315		115
316	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
317	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
318		118
319	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
320	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
321	relevant action might not be carried out by the C++ code.	121	relevant action might not be carried out by the C++ code.
…		…
334	place.	134	place.
335		135
336	=item on_start $term	136	=item on_start $term
337		137
338	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
339	trying to map (display) the toplevel and returning to the mainloop.	139	trying to map (display) the toplevel and returning to the main loop.
340		140
341	=item on_destroy $term	141	=item on_destroy $term
342		142
343	Called whenever something tries to destroy terminal, before doing anything	143	Called whenever something tries to destroy terminal, when the terminal is
344	yet. If this hook returns true, then destruction is skipped, but this is	144	still fully functional (not for long, though).
345	rarely a good idea.
346		145
347	=item on_reset $term	146	=item on_reset $term
348		147
349	Called after the screen is "reset" for any reason, such as resizing or	148	Called after the screen is "reset" for any reason, such as resizing or
350	control sequences. Here is where you can react on changes to size-related	149	control sequences. Here is where you can react on changes to size-related
…		…
372		171
373	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
374	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
375	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
376		175
377	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.
378		177
379	=item on_sel_extend $term	178	=item on_sel_extend $term
380		179
381	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
382	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
383	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
384	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
385	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
386	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
387		186
388	See the F<selection> example extension.	187	See the F<selection> example extension.
389		188
390	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
391		190
392	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
393	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
394	show this many lines of scrollback.	193	show this many lines of scrollback.
395		194
396	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
397		196
…		…
401		200
402	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,
403	$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
404	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
405		204
406	=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
407		216
408	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
409	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
410	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
411	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,
412	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
413	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	}
414		233
415	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,
416	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
417	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.
418		240
419	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
420		242
421	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
422	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
…		…
427	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
428		250
429	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
430	suppress or filter tty input.	252	suppress or filter tty input.
431		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
432	=item on_line_update $term, $row	261	=item on_line_update $term, $row
433		262
434	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
435	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
436	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,
…		…
443	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
444	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
445		274
446	=item on_refresh_begin $term	275	=item on_refresh_begin $term
447		276
448	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
449	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
450	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
451	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
452		281
453	=item on_refresh_end $term	282	=item on_refresh_end $term
454		283
455	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>.
456		285
457	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
458		287
459	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
460	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>
461	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<< ->register_keysym_action >> method.
		294
		295	=item on_register_command $term, $keysym, $modifiermask, $string
		296
		297	Called after parsing a keysym resource but before registering the
		298	associated binding. If this hook returns a true value the binding
		299	is not registered. It can be used to modify a binding by calling
		300	C<register_command>.
		301
		302	=item on_resize_all_windows $term, $new_width, $new_height
		303
		304	Called just after the new window size has been calculated, but before
		305	windows are actually being resized or hints are being set. If this hook
		306	returns a true value, setting of the window hints is being skipped.
462		307
463	=item on_x_event $term, $event	308	=item on_x_event $term, $event
464		309
465	Called on every X event received on the vt window (and possibly other	310	Called on every X event received on the vt window (and possibly other
466	windows). Should only be used as a last resort. Most event structure	311	windows). Should only be used as a last resort. Most event structure
467	members are not passed.	312	members are not passed.
468		313
		314	=item on_root_event $term, $event
		315
		316	Like C<on_x_event>, but is called for events on the root window.
		317
469	=item on_focus_in $term	318	=item on_focus_in $term
470		319
471	Called whenever the window gets the keyboard focus, before rxvt-unicode	320	Called whenever the window gets the keyboard focus, before rxvt-unicode
472	does focus in processing.	321	does focus in processing.
473		322
474	=item on_focus_out $term	323	=item on_focus_out $term
475		324
476	Called wheneever the window loses keyboard focus, before rxvt-unicode does	325	Called whenever the window loses keyboard focus, before rxvt-unicode does
477	focus out processing.	326	focus out processing.
478		327
479	=item on_configure_notify $term, $event	328	=item on_configure_notify $term, $event
480		329
481	=item on_property_notify $term, $event	330	=item on_property_notify $term, $event
…		…
492		341
493	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
494		343
495	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
496		345
497	Called whenever the corresponding X event is received for the terminal If	346	Called whenever the corresponding X event is received for the terminal. If
498	the hook returns true, then the even will be ignored by rxvt-unicode.	347	the hook returns true, then the event will be ignored by rxvt-unicode.
499		348
500	The event is a hash with most values as named by Xlib (see the XEvent	349	The event is a hash with most values as named by Xlib (see the XEvent
501	manpage), with the additional members C<row> and C<col>, which are the row	350	manpage), with the additional members C<row> and C<col>, which are the
502	and column under the mouse cursor.	351	(real, not screen-based) row and column under the mouse cursor.
503		352
504	C<on_key_press> additionally receives the string rxvt-unicode would	353	C<on_key_press> additionally receives the string rxvt-unicode would
505	output, if any, in locale-specific encoding.	354	output, if any, in locale-specific encoding.
506		355
507	subwindow.	356	subwindow.
…		…
513	=item on_wm_delete_window $term, $event	362	=item on_wm_delete_window $term, $event
514		363
515	Called when various types of ClientMessage events are received (all with	364	Called when various types of ClientMessage events are received (all with
516	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	365	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
517		366
		367	=item on_bell $term
		368
		369	Called on receipt of a bell character.
		370
518	=back	371	=back
519		372
520	=cut	373	=cut
521		374
522	package urxvt;	375	package urxvt;
523		376
524	use utf8;	377	use utf8;
525	use strict;	378	use strict 'vars';
526	use Carp ();	379	use Carp ();
527	use Scalar::Util ();	380	use Scalar::Util ();
528	use List::Util ();	381	use List::Util ();
529		382
530	our $VERSION = 1;	383	our $VERSION = 1;
531	our $TERM;	384	our $TERM;
532	our @TERM_INIT;	385	our @TERM_INIT; # should go, prevents async I/O etc.
533	our @TERM_EXT;	386	our @TERM_EXT; # should go, prevents async I/O etc.
534	our @HOOKNAME;	387	our @HOOKNAME;
535	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
536	our %OPTION;	389	our %OPTION;
537		390
538	our $LIBDIR;	391	our $LIBDIR;
539	our $RESNAME;	392	our $RESNAME;
540	our $RESCLASS;	393	our $RESCLASS;
541	our $RXVTNAME;	394	our $RXVTNAME;
542		395
		396	our $NOCHAR = chr 0xffff;
		397
543	=head2 Variables in the C<urxvt> Package	398	=head2 Variables in the C<urxvt> Package
544		399
545	=over 4	400	=over 4
546		401
547	=item $urxvt::LIBDIR	402	=item $urxvt::LIBDIR
…		…
562	The current terminal. This variable stores the current C<urxvt::term>	417	The current terminal. This variable stores the current C<urxvt::term>
563	object, whenever a callback/hook is executing.	418	object, whenever a callback/hook is executing.
564		419
565	=item @urxvt::TERM_INIT	420	=item @urxvt::TERM_INIT
566		421
567	All coderefs in this array will be called as methods of the next newly	422	All code references in this array will be called as methods of the next newly
568	created C<urxvt::term> object (during the C<on_init> phase). The array	423	created C<urxvt::term> object (during the C<on_init> phase). The array
569	gets cleared before the codereferences that were in it are being executed,	424	gets cleared before the code references that were in it are being executed,
570	so coderefs can push themselves onto it again if they so desire.	425	so references can push themselves onto it again if they so desire.
571		426
572	This complements to the perl-eval commandline option, but gets executed	427	This complements to the perl-eval command line option, but gets executed
573	first.	428	first.
574		429
575	=item @urxvt::TERM_EXT	430	=item @urxvt::TERM_EXT
576		431
577	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	432	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
584		439
585	=over 4	440	=over 4
586		441
587	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
588		443
589	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
590	costs! The only time this is acceptable is when the terminal process	445	include a trailing newline). Avoid at all costs! The only time this
591	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
592		448
593	=item urxvt::warn $string	449	=item urxvt::warn $string
594		450
595	Calls C<rxvt_warn> with the given string which should not include a	451	Calls C<rxvt_warn> with the given string which should include a trailing
596	newline. The module also overwrites the C<warn> builtin with a function	452	newline. The module also overwrites the C<warn> builtin with a function
597	that calls this function.	453	that calls this function.
598		454
599	Using this function has the advantage that its output ends up in the	455	Using this function has the advantage that its output ends up in the
600	correct place, e.g. on stderr of the connecting urxvtc client.	456	correct place, e.g. on stderr of the connecting urxvtc client.
601		457
602	Messages have a size limit of 1023 bytes currently.	458	Messages have a size limit of 1023 bytes currently.
		459
		460	=item @terms = urxvt::termlist
		461
		462	Returns all urxvt::term objects that exist in this process, regardless of
		463	whether they are started, being destroyed etc., so be careful. Only term
		464	objects that have perl extensions attached will be returned (because there
		465	is no urxvt::term object associated with others).
603		466
604	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
605		468
606	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
607		470
…		…
650		513
651	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
652		515
653	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
654		517
655	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	518	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		519	urxvt::RS_RVid, urxvt::RS_Uline
656		520
657	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
658	underline, respectively. To enable such a style, just logically OR it into	522	underline, respectively. To enable such a style, just logically OR it into
659	the bitset.	523	the bitset.
660		524
…		…
665	Return the foreground/background colour index, respectively.	529	Return the foreground/background colour index, respectively.
666		530
667	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	531	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
668		532
669	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	533	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		534
		535	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
670		536
671	Replace the foreground/background colour in the rendition mask with the	537	Replace the foreground/background colour in the rendition mask with the
672	specified one.	538	specified one.
673		539
674	=item $value = urxvt::GET_CUSTOM $rend	540	=item $value = urxvt::GET_CUSTOM $rend
…		…
693	unless $msg =~ /\n$/;	559	unless $msg =~ /\n$/;
694	urxvt::warn ($msg);	560	urxvt::warn ($msg);
695	};	561	};
696	}	562	}
697		563
		564	no warnings 'utf8';
		565
		566	sub parse_resource {
		567	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		568
		569	$name =~ y/-/./ if $isarg;
		570
		571	$term->scan_meta;
		572
		573	my $r = $term->{meta}{resource};
		574	keys %$r; # reset iterator
		575	while (my ($pattern, $v) = each %$r) {
		576	if (
		577	$pattern =~ /\.$/
		578	? $pattern eq substr $name, 0, length $pattern
		579	: $pattern eq $name
		580	) {
		581	$name = "$urxvt::RESCLASS.$name";
		582
		583	push @{ $term->{perl_ext_3} }, $v->[0];
		584
		585	if ($v->[1] eq "boolean") {
		586	$term->put_option_db ($name, $flag ? "true" : "false");
		587	return 1;
		588	} else {
		589	$term->put_option_db ($name, $value);
		590	return 1 + 2;
		591	}
		592	}
		593	}
		594
		595	0
		596	}
		597
		598	sub usage {
		599	my ($term, $usage_type) = @_;
		600
		601	$term->scan_meta;
		602
		603	my $r = $term->{meta}{resource};
		604
		605	for my $pattern (sort keys %$r) {
		606	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		607
		608	$desc .= " (-pe $ext)";
		609
		610	if ($usage_type == 1) {
		611	$pattern =~ y/./-/;
		612	$pattern =~ s/-$/-.../g;
		613
		614	if ($type eq "boolean") {
		615	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		616	} else {
		617	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		618	}
		619	} else {
		620	$pattern =~ s/\.$/.*/g;
		621	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		622	}
		623	}
		624	}
		625
698	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
699		627
700	sub verbose {	628	sub verbose {
701	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
702	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
…		…
714	$pkg =~ s/[^[:word:]]/_/g;	642	$pkg =~ s/[^[:word:]]/_/g;
715	$pkg = "urxvt::ext::$pkg";	643	$pkg = "urxvt::ext::$pkg";
716		644
717	verbose 3, "loading extension '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
718		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		648
719	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
720	or die "$path: $!";	650	or die "$path: $!";
721		651
722	my $source =	652	my $source =
723	"package $pkg; use strict; use utf8;\n"	653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
724	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
725	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
726	. "\n};\n1";	656	. "\n};\n1";
727		657
728	eval $source	658	eval $source
…		…
738	sub invoke {	668	sub invoke {
739	local $TERM = shift;	669	local $TERM = shift;
740	my $htype = shift;	670	my $htype = shift;
741		671
742	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
743	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
744		674
745	my %ext_arg;	675	my %ext_arg;
746		676
747	{	677	{
748	my @init = @TERM_INIT;	678	my @init = @TERM_INIT;
749	@TERM_INIT = ();	679	@TERM_INIT = ();
…		…
751	my @pkg = @TERM_EXT;	681	my @pkg = @TERM_EXT;
752	@TERM_EXT = ();	682	@TERM_EXT = ();
753	$TERM->register_package ($_) for @pkg;	683	$TERM->register_package ($_) for @pkg;
754	}	684	}
755		685
		686	for (
		687	@{ delete $TERM->{perl_ext_3} },
756	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
757	if ($_ eq "default") {	690	if ($_ eq "default") {
758	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	691	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
759	} elsif (/^-(.*)$/) {	692	} elsif (/^-(.*)$/) {
760	delete $ext_arg{$1};	693	delete $ext_arg{$1};
761	} elsif (/^([^<]+)<(.*)>$/) {	694	} elsif (/^([^<]+)<(.*)>$/) {
762	push @{ $ext_arg{$1} }, $2;	695	push @{ $ext_arg{$1} }, $2;
763	} else {	696	} else {
764	$ext_arg{$_} ||= [];	697	$ext_arg{$_} ||= [];
765	}	698	}
766	}	699	}
767		700
768	while (my ($ext, $argv) = each %ext_arg) {	701	for my $ext (sort keys %ext_arg) {
769	my @files = grep -f $_, map "$_/$ext", @dirs;	702	my @files = grep -f $_, map "$_/$ext", @dirs;
770		703
771	if (@files) {	704	if (@files) {
772	$TERM->register_package (extension_package $files[0], $argv);	705	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
773	} else {	706	} else {
774	warn "perl extension '$ext' not found in perl library search path\n";	707	warn "perl extension '$ext' not found in perl library search path\n";
775	}	708	}
776	}	709	}
777		710
…		…
783		716
784	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
785	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
786	if $verbosity >= 10;	719	if $verbosity >= 10;
787		720
788	keys %$cb;	721	for my $pkg (keys %$cb) {
789
790	while (my ($pkg, $cb) = each %$cb) {
791	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
792	$retval ||= $retval_;	723	$retval ||= $retval_;
793		724
794	if ($@) {	725	if ($@) {
795	$TERM->ungrab; # better to lose the grab than the session	726	$TERM->ungrab; # better to lose the grab than the session
796	warn $@;	727	warn $@;
…		…
810	}	741	}
811		742
812	$retval	743	$retval
813	}	744	}
814		745
815	# urxvt::term::extension	746	sub SET_COLOR($$$) {
		747	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		748	}
		749
		750	sub rend2mask {
		751	no strict 'refs';
		752	my ($str, $mask) = (@_, 0);
		753	my %color = ( fg => undef, bg => undef );
		754	my @failed;
		755	for my $spec ( split /\s+/, $str ) {
		756	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		757	$color{lc($1)} = $2;
		758	} else {
		759	my $neg = $spec =~ s/^[-^]//;
		760	unless ( exists &{"RS_$spec"} ) {
		761	push @failed, $spec;
		762	next;
		763	}
		764	my $cur = &{"RS_$spec"};
		765	if ( $neg ) {
		766	$mask &= ~$cur;
		767	} else {
		768	$mask |= $cur;
		769	}
		770	}
		771	}
		772	($mask, @color{qw(fg bg)}, \@failed)
		773	}
816		774
817	package urxvt::term::extension;	775	package urxvt::term::extension;
818		776
819	sub enable {	777	=head2 The C<urxvt::term::extension> class
820	my ($self, %hook) = @_;
821	my $pkg = $self->{_pkg};
822		778
823	while (my ($name, $cb) = each %hook) {	779	Each extension attached to a terminal object is represented by
824	my $htype = $HOOKTYPE{uc $name};	780	a C<urxvt::term::extension> object.
825	defined $htype
826	or Carp::croak "unsupported hook type '$name'";
827		781
828	$self->set_should_invoke ($htype, +1)	782	You can use these objects, which are passed to all callbacks to store any
829	unless exists $self->{term}{_hook}[$htype]{$pkg};	783	state related to the terminal and extension instance.
830		784
831	$self->{term}{_hook}[$htype]{$pkg} = $cb;	785	The methods (And data members) documented below can be called on extension
832	}	786	objects, in addition to call methods documented for the <urxvt::term>
833	}	787	class.
834		788
835	sub disable {	789	=over 4
836	my ($self, @hook) = @_;
837	my $pkg = $self->{_pkg};
838		790
839	for my $name (@hook) {	791	=item $urxvt_term = $self->{term}
840	my $htype = $HOOKTYPE{uc $name};
841	defined $htype
842	or Carp::croak "unsupported hook type '$name'";
843		792
844	$self->set_should_invoke ($htype, -1)	793	Returns the C<urxvt::term> object associated with this instance of the
845	if delete $self->{term}{_hook}[$htype]{$pkg};	794	extension. This member I<must not> be changed in any way.
846	}	795
847	}	796	=cut
848		797
849	our $AUTOLOAD;	798	our $AUTOLOAD;
850		799
851	sub AUTOLOAD {	800	sub AUTOLOAD {
852	$AUTOLOAD =~ /:([^:]+)$/	801	$AUTOLOAD =~ /:([^:]+)$/
…		…
865		814
866	sub DESTROY {	815	sub DESTROY {
867	# nop	816	# nop
868	}	817	}
869		818
870	# urxvt::destroy_hook	819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
871		820
872	sub urxvt::destroy_hook::DESTROY {	821	sub urxvt::destroy_hook::DESTROY {
873	${$_[0]}->();	822	${$_[0]}->();
874	}	823	}
875		824
876	sub urxvt::destroy_hook(&) {	825	sub urxvt::destroy_hook(&) {
877	bless \shift, urxvt::destroy_hook::	826	bless \shift, urxvt::destroy_hook::
878	}	827	}
		828
		829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		830
		831	Dynamically enable the given hooks (named without the C<on_> prefix) for
		832	this extension, replacing any hook previously installed via C<enable> in
		833	this extension.
		834
		835	This is useful when you want to overwrite time-critical hooks only
		836	temporarily.
		837
		838	To install additional callbacks for the same hook, you can use the C<on>
		839	method of the C<urxvt::term> class.
		840
		841	=item $self->disable ($hook_name[, $hook_name..])
		842
		843	Dynamically disable the given hooks.
		844
		845	=cut
		846
		847	sub enable {
		848	my ($self, %hook) = @_;
		849	my $pkg = $self->{_pkg};
		850
		851	while (my ($name, $cb) = each %hook) {
		852	my $htype = $HOOKTYPE{uc $name};
		853	defined $htype
		854	or Carp::croak "unsupported hook type '$name'";
		855
		856	$self->set_should_invoke ($htype, +1)
		857	unless exists $self->{term}{_hook}[$htype]{$pkg};
		858
		859	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		860	}
		861	}
		862
		863	sub disable {
		864	my ($self, @hook) = @_;
		865	my $pkg = $self->{_pkg};
		866
		867	for my $name (@hook) {
		868	my $htype = $HOOKTYPE{uc $name};
		869	defined $htype
		870	or Carp::croak "unsupported hook type '$name'";
		871
		872	$self->set_should_invoke ($htype, -1)
		873	if delete $self->{term}{_hook}[$htype]{$pkg};
		874	}
		875	}
		876
		877	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		878
		879	Similar to the C<enable> enable, but installs additional callbacks for
		880	the given hook(s) (that is, it doesn't replace existing callbacks), and
		881	returns a guard object. When the guard object is destroyed the callbacks
		882	are disabled again.
		883
		884	=cut
		885
		886	sub urxvt::extension::on_disable::DESTROY {
		887	my $disable = shift;
		888
		889	my $term = delete $disable->{""};
		890
		891	while (my ($htype, $id) = each %$disable) {
		892	delete $term->{_hook}[$htype]{$id};
		893	$term->set_should_invoke ($htype, -1);
		894	}
		895	}
		896
		897	sub on {
		898	my ($self, %hook) = @_;
		899
		900	my $term = $self->{term};
		901
		902	my %disable = ( "" => $term );
		903
		904	while (my ($name, $cb) = each %hook) {
		905	my $htype = $HOOKTYPE{uc $name};
		906	defined $htype
		907	or Carp::croak "unsupported hook type '$name'";
		908
		909	$term->set_should_invoke ($htype, +1);
		910	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		911	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		912	}
		913
		914	bless \%disable, "urxvt::extension::on_disable"
		915	}
		916
		917	=item $self->x_resource ($pattern)
		918
		919	=item $self->x_resource_boolean ($pattern)
		920
		921	These methods support an additional C<%> prefix when called on an
		922	extension object - see the description of these methods in the
		923	C<urxvt::term> class for details.
		924
		925	=cut
		926
		927	sub x_resource {
		928	my ($self, $name) = @_;
		929	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		930	$self->{term}->x_resource ($name)
		931	}
		932
		933	sub x_resource_boolean {
		934	my ($self, $name) = @_;
		935	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		936	$self->{term}->x_resource_boolean ($name)
		937	}
		938
		939	=back
		940
		941	=cut
879		942
880	package urxvt::anyevent;	943	package urxvt::anyevent;
881		944
882	=head2 The C<urxvt::anyevent> Class	945	=head2 The C<urxvt::anyevent> Class
883		946
884	The sole purpose of this class is to deliver an interface to the	947	The sole purpose of this class is to deliver an interface to the
885	C<AnyEvent> module - any module using it will work inside urxvt without	948	C<AnyEvent> module - any module using it will work inside urxvt without
886	further programming. The only exception is that you cannot wait on	949	further programming. The only exception is that you cannot wait on
887	condition variables, but non-blocking condvar use is ok. What this means	950	condition variables, but non-blocking condvar use is ok.
888	is that you cannot use blocking APIs, but the non-blocking variant should
889	work.
890		951
891	=cut	952	In practical terms this means is that you cannot use blocking APIs, but
		953	the non-blocking variant should work.
892		954
		955	=cut
		956
893	our $VERSION = 1;	957	our $VERSION = '5.23';
894		958
895	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	959	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
896	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	960	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
897		961
898	sub timer {	962	sub timer {
…		…
900		964
901	my $cb = $arg{cb};	965	my $cb = $arg{cb};
902		966
903	urxvt::timer	967	urxvt::timer
904	->new	968	->new
905	->start (urxvt::NOW + $arg{after})	969	->after ($arg{after}, $arg{interval})
906	->cb (sub {	970	->cb ($arg{interval} ? $cb : sub {
907	$_[0]->stop; # need to cancel manually	971	$_[0]->stop; # need to cancel manually
908	$cb->();	972	$cb->();
909	})	973	})
910	}	974	}
911		975
912	sub io {	976	sub io {
913	my ($class, %arg) = @_;	977	my ($class, %arg) = @_;
914		978
915	my $cb = $arg{cb};	979	my $cb = $arg{cb};
		980	my $fd = fileno $arg{fh};
		981	defined $fd or $fd = $arg{fh};
916		982
917	bless [$arg{fh}, urxvt::iow	983	bless [$arg{fh}, urxvt::iow
918	->new	984	->new
919	->fd (fileno $arg{fh})	985	->fd ($fd)
920	->events (($arg{poll} =~ /r/ ? 1 : 0)	986	->events (($arg{poll} =~ /r/ ? 1 : 0)
921	| ($arg{poll} =~ /w/ ? 2 : 0))	987	| ($arg{poll} =~ /w/ ? 2 : 0))
922	->start	988	->start
923	->cb (sub {	989	->cb ($cb)
924	$cb->(($_[1] & 1 ? 'r' : '')
925	. ($_[1] & 2 ? 'w' : ''));
926	})],
927	urxvt::anyevent::	990	], urxvt::anyevent::
		991	}
		992
		993	sub idle {
		994	my ($class, %arg) = @_;
		995
		996	my $cb = $arg{cb};
		997
		998	urxvt::iw
		999	->new
		1000	->start
		1001	->cb ($cb)
		1002	}
		1003
		1004	sub child {
		1005	my ($class, %arg) = @_;
		1006
		1007	my $cb = $arg{cb};
		1008
		1009	urxvt::pw
		1010	->new
		1011	->start ($arg{pid})
		1012	->cb (sub {
		1013	$_[0]->stop; # need to cancel manually
		1014	$cb->($_[0]->rpid, $_[0]->rstatus);
		1015	})
928	}	1016	}
929		1017
930	sub DESTROY {	1018	sub DESTROY {
931	$_[0][1]->stop;	1019	$_[0][1]->stop;
932	}	1020	}
933		1021
934	sub condvar {	1022	# only needed for AnyEvent < 6 compatibility
935	bless \my $flag, urxvt::anyevent::condvar::	1023	sub one_event {
936	}
937
938	sub urxvt::anyevent::condvar::broadcast {
939	${$_[0]}++;
940	}
941
942	sub urxvt::anyevent::condvar::wait {
943	unless (${$_[0]}) {
944	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1024	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
945	}
946	}	1025	}
947		1026
948	package urxvt::term;	1027	package urxvt::term;
949		1028
950	=head2 The C<urxvt::term> Class	1029	=head2 The C<urxvt::term> Class
…		…
963	urxvt::verbose 6, "register package $pkg to $self";	1042	urxvt::verbose 6, "register package $pkg to $self";
964		1043
965	@{"$pkg\::ISA"} = urxvt::term::extension::;	1044	@{"$pkg\::ISA"} = urxvt::term::extension::;
966		1045
967	my $proxy = bless {	1046	my $proxy = bless {
968	_pkg => $pkg,	1047	_pkg => $pkg,
		1048	_name => ${"$pkg\::_NAME"}, # hackish
969	argv => $argv,	1049	argv => $argv,
970	}, $pkg;	1050	}, $pkg;
971	Scalar::Util::weaken ($proxy->{term} = $self);	1051	Scalar::Util::weaken ($proxy->{term} = $self);
972		1052
973	$self->{_pkg}{$pkg} = $proxy;	1053	$self->{_pkg}{$pkg} = $proxy;
974		1054
…		…
977	$proxy->enable ($name => $ref);	1057	$proxy->enable ($name => $ref);
978	}	1058	}
979	}	1059	}
980	}	1060	}
981		1061
		1062	sub perl_libdirs {
		1063	map { split /:/ }
		1064	$_[0]->resource ("perl_lib"),
		1065	$ENV{URXVT_PERL_LIB},
		1066	"$ENV{HOME}/.urxvt/ext",
		1067	"$LIBDIR/perl"
		1068	}
		1069
		1070	sub scan_meta {
		1071	my ($self) = @_;
		1072	my @libdirs = perl_libdirs $self;
		1073
		1074	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1075
		1076	my %meta;
		1077
		1078	$self->{meta_libdirs} = join "\x00", @libdirs;
		1079	$self->{meta} = \%meta;
		1080
		1081	for my $dir (reverse @libdirs) {
		1082	opendir my $fh, $dir
		1083	or next;
		1084	for my $ext (readdir $fh) {
		1085	$ext !~ /^\./
		1086	and open my $fh, "<", "$dir/$ext"
		1087	or next;
		1088
		1089	while (<$fh>) {
		1090	if (/^#:META:X_RESOURCE:(.*)/) {
		1091	my ($pattern, $type, $desc) = split /:/, $1;
		1092	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1093	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1094	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1095	} else {
		1096	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1097	}
		1098	} elsif (/^\s*(?:#|$)/) {
		1099	# skip other comments and empty lines
		1100	} else {
		1101	last; # stop parsing on first non-empty non-comment line
		1102	}
		1103	}
		1104	}
		1105	}
		1106	}
		1107
982	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1108	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
983		1109
984	Creates a new terminal, very similar as if you had started it with system	1110	Creates a new terminal, very similar as if you had started it with system
985	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1111	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
986	hash which defines the environment of the new terminal.	1112	hash which defines the environment of the new terminal.
987		1113
988	Croaks (and probably outputs an error message) if the new instance	1114	Croaks (and probably outputs an error message) if the new instance
989	couldn't be created. Returns C<undef> if the new instance didn't	1115	couldn't be created. Returns C<undef> if the new instance didn't
990	initialise perl, and the terminal object otherwise. The C<init> and	1116	initialise perl, and the terminal object otherwise. The C<init> and
991	C<start> hooks will be called during this call.	1117	C<start> hooks will be called before this call returns, and are free to
		1118	refer to global data (which is race free).
992		1119
993	=cut	1120	=cut
994		1121
995	sub new {	1122	sub new {
996	my ($class, $env, @args) = @_;	1123	my ($class, $env, @args) = @_;
997		1124
		1125	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1126	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1127
998	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1128	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
999	}	1129	}
1000		1130
1001	=item $term->destroy	1131	=item $term->destroy
1002		1132
1003	Destroy the terminal object (close the window, free resources	1133	Destroy the terminal object (close the window, free resources
1004	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1134	etc.). Please note that urxvt will not exit as long as any event
1005	watchers (timers, io watchers) are still active.	1135	watchers (timers, io watchers) are still active.
1006		1136
1007	=item $term->exec_async ($cmd[, @args])	1137	=item $term->exec_async ($cmd[, @args])
1008		1138
1009	Works like the combination of the C<fork>/C<exec> builtins, which executes	1139	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1033		1163
1034	Returns true if the option specified by C<$optval> is enabled, and	1164	Returns true if the option specified by C<$optval> is enabled, and
1035	optionally change it. All option values are stored by name in the hash	1165	optionally change it. All option values are stored by name in the hash
1036	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1166	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1037		1167
1038	Here is a a likely non-exhaustive list of option names, please see the	1168	Here is a likely non-exhaustive list of option names, please see the
1039	source file F</src/optinc.h> to see the actual list:	1169	source file F</src/optinc.h> to see the actual list:
1040		1170
1041	borderLess console cursorBlink cursorUnderline hold iconic insecure	1171	borderLess buffered console cursorBlink cursorUnderline hold iconic
1042	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1172	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1043	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1173	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1044	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1174	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1045	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1175	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1046	transparent tripleclickwords utmpInhibit visualBell	1176	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1177	urgentOnBell utmpInhibit visualBell
1047		1178
1048	=item $value = $term->resource ($name[, $newval])	1179	=item $value = $term->resource ($name[, $newval])
1049		1180
1050	Returns the current resource value associated with a given name and	1181	Returns the current resource value associated with a given name and
1051	optionally sets a new value. Setting values is most useful in the C<init>	1182	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1060	likely change).	1191	likely change).
1061		1192
1062	Please note that resource strings will currently only be freed when the	1193	Please note that resource strings will currently only be freed when the
1063	terminal is destroyed, so changing options frequently will eat memory.	1194	terminal is destroyed, so changing options frequently will eat memory.
1064		1195
1065	Here is a a likely non-exhaustive list of resource names, not all of which	1196	Here is a likely non-exhaustive list of resource names, not all of which
1066	are supported in every build, please see the source file F</src/rsinc.h>	1197	are supported in every build, please see the source file F</src/rsinc.h>
1067	to see the actual list:	1198	to see the actual list:
1068		1199
1069	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1200	answerbackstring backgroundPixmap backspace_key blurradius
1070	borderLess color cursorBlink cursorUnderline cutchars delete_key	1201	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1071	display_name embed ext_bwidth fade font geometry hold iconName	1202	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1072	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1203	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1204	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1073	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1205	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1074	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1206	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1075	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1207	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1076	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1208	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1077	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1209	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1078	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1210	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1079	secondaryScreen secondaryScroll selectstyle shade term_name title	1211	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1080	transient_for transparent transparent_all tripleclickwords utmpInhibit	1212	term_name title transient_for transparent tripleclickwords urgentOnBell
1081	visualBell	1213	utmpInhibit visualBell
1082		1214
1083	=cut	1215	=cut
1084		1216
1085	sub resource($$;$) {	1217	sub resource($$;$) {
1086	my ($self, $name) = (shift, shift);	1218	my ($self, $name) = (shift, shift);
1087	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1219	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1088	&urxvt::term::_resource	1220	goto &urxvt::term::_resource
1089	}	1221	}
1090		1222
1091	=item $value = $term->x_resource ($pattern)	1223	=item $value = $term->x_resource ($pattern)
1092		1224
1093	Returns the X-Resource for the given pattern, excluding the program or	1225	Returns the X-Resource for the given pattern, excluding the program or
1094	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1226	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1095	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1227	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1096	resource with that pattern exists.	1228	resource with that pattern exists.
1097		1229
		1230	Extensions that define extra resource or command line arguments also need
		1231	to call this method to access their values.
		1232
		1233	If the method is called on an extension object (basically, from an
		1234	extension), then the special prefix C<%.> will be replaced by the name of
		1235	the extension and a dot, and the lone string C<%> will be replaced by the
		1236	extension name itself. This makes it possible to code extensions so you
		1237	can rename them and get a new set of commandline switches and resources
		1238	without having to change the actual code.
		1239
1098	This method should only be called during the C<on_start> hook, as there is	1240	This method should only be called during the C<on_start> hook, as there is
1099	only one resource database per display, and later invocations might return	1241	only one resource database per display, and later invocations might return
1100	the wrong resources.	1242	the wrong resources.
1101		1243
1102	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1244	=item $value = $term->x_resource_boolean ($pattern)
1103		1245
		1246	Like C<x_resource>, above, but interprets the string value as a boolean
		1247	and returns C<1> for true values, C<0> for false values and C<undef> if
		1248	the resource or option isn't specified.
		1249
		1250	You should always use this method to parse boolean resources.
		1251
		1252	=cut
		1253
		1254	sub x_resource_boolean {
		1255	my $res = &x_resource;
		1256
		1257	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1258	}
		1259
		1260	=item $success = $term->parse_keysym ($key, $octets)
		1261
1104	Adds a keymap translation exactly as specified via a resource. See the	1262	Adds a key binding exactly as specified via a resource. See the
1105	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1263	C<keysym> resource in the urxvt(1) manpage.
		1264
		1265	=item $term->register_command ($keysym, $modifiermask, $string)
		1266
		1267	Adds a key binding. This is a lower level api compared to
		1268	C<parse_keysym>, as it expects a parsed key description, and can be
		1269	used only inside either the C<on_init> hook, to add a binding, or the
		1270	C<on_register_command> hook, to modify a parsed binding.
1106		1271
1107	=item $rend = $term->rstyle ([$new_rstyle])	1272	=item $rend = $term->rstyle ([$new_rstyle])
1108		1273
1109	Return and optionally change the current rendition. Text that is output by	1274	Return and optionally change the current rendition. Text that is output by
1110	the terminal application will use this style.	1275	the terminal application will use this style.
…		…
1118		1283
1119	=item ($row, $col) = $term->selection_beg ([$row, $col])	1284	=item ($row, $col) = $term->selection_beg ([$row, $col])
1120		1285
1121	=item ($row, $col) = $term->selection_end ([$row, $col])	1286	=item ($row, $col) = $term->selection_end ([$row, $col])
1122		1287
1123	Return the current values of the selection mark, begin or end positions,	1288	Return the current values of the selection mark, begin or end positions.
1124	and optionally set them to new values.	1289
		1290	When arguments are given, then the selection coordinates are set to
		1291	C<$row> and C<$col>, and the selection screen is set to the current
		1292	screen.
		1293
		1294	=item $screen = $term->selection_screen ([$screen])
		1295
		1296	Returns the current selection screen, and then optionally sets it.
1125		1297
1126	=item $term->selection_make ($eventtime[, $rectangular])	1298	=item $term->selection_make ($eventtime[, $rectangular])
1127		1299
1128	Tries to make a selection as set by C<selection_beg> and	1300	Tries to make a selection as set by C<selection_beg> and
1129	C<selection_end>. If C<$rectangular> is true (default: false), a	1301	C<selection_end>. If C<$rectangular> is true (default: false), a
1130	rectangular selection will be made. This is the prefered function to make	1302	rectangular selection will be made. This is the preferred function to make
1131	a selection.	1303	a selection.
1132		1304
1133	=item $success = $term->selection_grab ($eventtime)	1305	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1134		1306
1135	Try to request the primary selection text from the server (for example, as	1307	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1308	true) selection from the server. The corresponding text can be set
1136	set by the next method). No visual feedback will be given. This function	1309	with the next method. No visual feedback will be given. This function
1137	is mostly useful from within C<on_sel_grab> hooks.	1310	is mostly useful from within C<on_sel_grab> hooks.
1138		1311
1139	=item $oldtext = $term->selection ([$newtext])	1312	=item $oldtext = $term->selection ([$newtext, $clipboard])
1140		1313
1141	Return the current selection text and optionally replace it by C<$newtext>.	1314	Return the current selection (clipboard if C<$clipboard> is true) text
		1315	and optionally replace it by C<$newtext>.
		1316
		1317	=item $term->selection_clear ([$clipboard])
		1318
		1319	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1142		1320
1143	=item $term->overlay_simple ($x, $y, $text)	1321	=item $term->overlay_simple ($x, $y, $text)
1144		1322
1145	Create a simple multi-line overlay box. See the next method for details.	1323	Create a simple multi-line overlay box. See the next method for details.
1146		1324
…		…
1176		1354
1177	The methods currently supported on C<urxvt::overlay> objects are:	1355	The methods currently supported on C<urxvt::overlay> objects are:
1178		1356
1179	=over 4	1357	=over 4
1180		1358
1181	=item $overlay->set ($x, $y, $text, $rend)	1359	=item $overlay->set ($x, $y, $text[, $rend])
1182		1360
1183	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1361	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1184	text in rxvt-unicode's special encoding and an array of rendition values	1362	text in rxvt-unicode's special encoding and an array of rendition values
1185	at a specific position inside the overlay.	1363	at a specific position inside the overlay.
		1364
		1365	If C<$rend> is missing, then the rendition will not be changed.
1186		1366
1187	=item $overlay->hide	1367	=item $overlay->hide
1188		1368
1189	If visible, hide the overlay, but do not destroy it.	1369	If visible, hide the overlay, but do not destroy it.
1190		1370
…		…
1260		1440
1261	Normally its not a good idea to use this function, as programs might be	1441	Normally its not a good idea to use this function, as programs might be
1262	confused by changes in cursor position or scrolling. Its useful inside a	1442	confused by changes in cursor position or scrolling. Its useful inside a
1263	C<on_add_lines> hook, though.	1443	C<on_add_lines> hook, though.
1264		1444
		1445	=item $term->scr_change_screen ($screen)
		1446
		1447	Switch to given screen - 0 primary, 1 secondary.
		1448
1265	=item $term->cmd_parse ($octets)	1449	=item $term->cmd_parse ($octets)
1266		1450
1267	Similar to C<scr_add_lines>, but the argument must be in the	1451	Similar to C<scr_add_lines>, but the argument must be in the
1268	locale-specific encoding of the terminal and can contain command sequences	1452	locale-specific encoding of the terminal and can contain command sequences
1269	(escape codes) that will be interpreted.	1453	(escape codes) that will be interpreted.
1270		1454
1271	=item $term->tt_write ($octets)	1455	=item $term->tt_write ($octets)
1272		1456
1273	Write the octets given in C<$data> to the tty (i.e. as program input). To	1457	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1274	pass characters instead of octets, you should convert your strings first	1458	pass characters instead of octets, you should convert your strings first
1275	to the locale-specific encoding using C<< $term->locale_encode >>.	1459	to the locale-specific encoding using C<< $term->locale_encode >>.
		1460
		1461	=item $term->tt_paste ($octets)
		1462
		1463	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1464	CR and bracketing the data with control sequences if bracketed paste mode
		1465	is set.
1276		1466
1277	=item $old_events = $term->pty_ev_events ([$new_events])	1467	=item $old_events = $term->pty_ev_events ([$new_events])
1278		1468
1279	Replaces the event mask of the pty watcher by the given event mask. Can	1469	Replaces the event mask of the pty watcher by the given event mask. Can
1280	be used to suppress input and output handling to the pty/tty. See the	1470	be used to suppress input and output handling to the pty/tty. See the
1281	description of C<< urxvt::timer->events >>. Make sure to always restore	1471	description of C<< urxvt::timer->events >>. Make sure to always restore
1282	the previous value.	1472	the previous value.
1283		1473
		1474	=item $fd = $term->pty_fd
		1475
		1476	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1477	is used.
		1478
1284	=item $windowid = $term->parent	1479	=item $windowid = $term->parent
1285		1480
1286	Return the window id of the toplevel window.	1481	Return the window id of the toplevel window.
1287		1482
1288	=item $windowid = $term->vt	1483	=item $windowid = $term->vt
…		…
1294	Adds the specified events to the vt event mask. Useful e.g. when you want	1489	Adds the specified events to the vt event mask. Useful e.g. when you want
1295	to receive pointer events all the times:	1490	to receive pointer events all the times:
1296		1491
1297	$term->vt_emask_add (urxvt::PointerMotionMask);	1492	$term->vt_emask_add (urxvt::PointerMotionMask);
1298		1493
		1494	=item $term->set_urgency ($set)
		1495
		1496	Enable/disable the urgency hint on the toplevel window.
		1497
		1498	=item $term->focus_in
		1499
		1500	=item $term->focus_out
		1501
		1502	=item $term->key_press ($state, $keycode[, $time])
		1503
		1504	=item $term->key_release ($state, $keycode[, $time])
		1505
		1506	Deliver various fake events to to terminal.
		1507
1299	=item $window_width = $term->width	1508	=item $window_width = $term->width
1300		1509
1301	=item $window_height = $term->height	1510	=item $window_height = $term->height
1302		1511
1303	=item $font_width = $term->fwidth	1512	=item $font_width = $term->fwidth
…		…
1333	=item $env = $term->env	1542	=item $env = $term->env
1334		1543
1335	Returns a copy of the environment in effect for the terminal as a hashref	1544	Returns a copy of the environment in effect for the terminal as a hashref
1336	similar to C<\%ENV>.	1545	similar to C<\%ENV>.
1337		1546
		1547	=item @envv = $term->envv
		1548
		1549	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1550
		1551	=item @argv = $term->argv
		1552
		1553	Return the argument vector as this terminal, similar to @ARGV, but
		1554	includes the program name as first element.
		1555
1338	=cut	1556	=cut
1339		1557
1340	sub env {	1558	sub env {
1341	if (my $env = $_[0]->_env) {
1342	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1559	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1343	} else {
1344	+{ %ENV }
1345	}
1346	}	1560	}
1347		1561
1348	=item $modifiermask = $term->ModLevel3Mask	1562	=item $modifiermask = $term->ModLevel3Mask
1349		1563
1350	=item $modifiermask = $term->ModMetaMask	1564	=item $modifiermask = $term->ModMetaMask
1351		1565
1352	=item $modifiermask = $term->ModNumLockMask	1566	=item $modifiermask = $term->ModNumLockMask
1353		1567
1354	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1568	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1355	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1569	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1570
		1571	=item $screen = $term->current_screen
		1572
		1573	Returns the currently displayed screen (0 primary, 1 secondary).
		1574
		1575	=item $cursor_is_hidden = $term->hidden_cursor
		1576
		1577	Returns whether the cursor is currently hidden or not.
1356		1578
1357	=item $view_start = $term->view_start ([$newvalue])	1579	=item $view_start = $term->view_start ([$newvalue])
1358		1580
1359	Returns the row number of the topmost displayed line. Maximum value is	1581	Returns the row number of the topmost displayed line. Maximum value is
1360	C<0>, which displays the normal terminal contents. Lower values scroll	1582	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1368		1590
1369	Used after changing terminal contents to display them.	1591	Used after changing terminal contents to display them.
1370		1592
1371	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1593	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1372		1594
1373	Returns the text of the entire row with number C<$row_number>. Row C<0>	1595	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1374	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1596	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1375	terminal line. The scrollback buffer starts at line C<-1> and extends to
1376	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1597	terminal line. Nothing will be returned if a nonexistent line
1377	is requested.	1598	is requested.
1378		1599
1379	If C<$new_text> is specified, it will replace characters in the current	1600	If C<$new_text> is specified, it will replace characters in the current
1380	line, starting at column C<$start_col> (default C<0>), which is useful	1601	line, starting at column C<$start_col> (default C<0>), which is useful
1381	to replace only parts of a line. The font index in the rendition will	1602	to replace only parts of a line. The font index in the rendition will
1382	automatically be updated.	1603	automatically be updated.
1383		1604
1384	C<$text> is in a special encoding: tabs and wide characters that use more	1605	C<$text> is in a special encoding: tabs and wide characters that use more
1385	than one cell when displayed are padded with urxvt::NOCHAR characters	1606	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1386	(C<chr 65535>). Characters with combining characters and other characters	1607	characters. Characters with combining characters and other characters that
1387	that do not fit into the normal tetx encoding will be replaced with	1608	do not fit into the normal text encoding will be replaced with characters
1388	characters in the private use area.	1609	in the private use area.
1389		1610
1390	You have to obey this encoding when changing text. The advantage is	1611	You have to obey this encoding when changing text. The advantage is
1391	that C<substr> and similar functions work on screen cells and not on	1612	that C<substr> and similar functions work on screen cells and not on
1392	characters.	1613	characters.
1393		1614
…		…
1477	}	1698	}
1478		1699
1479	sub urxvt::line::t {	1700	sub urxvt::line::t {
1480	my ($self) = @_;	1701	my ($self) = @_;
1481		1702
1482	if (@_ > 1)	1703	if (@_ > 1) {
1483	{
1484	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1704	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1485	for $self->{beg} .. $self->{end};	1705	for $self->{beg} .. $self->{end};
1486	}	1706	}
1487		1707
1488	defined wantarray &&	1708	defined wantarray &&
1489	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1490	0, $self->{len}	1710	0, $self->{len}
1491	}	1711	}
1492		1712
1493	sub urxvt::line::r {	1713	sub urxvt::line::r {
1494	my ($self) = @_;	1714	my ($self) = @_;
1495		1715
1496	if (@_ > 1)	1716	if (@_ > 1) {
1497	{
1498	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1717	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1499	for $self->{beg} .. $self->{end};	1718	for $self->{beg} .. $self->{end};
1500	}	1719	}
1501		1720
1502	if (defined wantarray) {	1721	if (defined wantarray) {
1503	my $rend = [	1722	my $rend = [
1504	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1723	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1505	];	1724	];
…		…
1537	where one character corresponds to one screen cell. See	1756	where one character corresponds to one screen cell. See
1538	C<< $term->ROW_t >> for details.	1757	C<< $term->ROW_t >> for details.
1539		1758
1540	=item $string = $term->special_decode $text	1759	=item $string = $term->special_decode $text
1541		1760
1542	Converts rxvt-unicodes text reprsentation into a perl string. See	1761	Converts rxvt-unicodes text representation into a perl string. See
1543	C<< $term->ROW_t >> for details.	1762	C<< $term->ROW_t >> for details.
1544		1763
1545	=item $success = $term->grab_button ($button, $modifiermask)	1764	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1546		1765
		1766	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1767
1547	Registers a synchronous button grab. See the XGrabButton manpage.	1768	Register/unregister a synchronous button grab. See the XGrabButton
		1769	manpage.
1548		1770
1549	=item $success = $term->grab ($eventtime[, $sync])	1771	=item $success = $term->grab ($eventtime[, $sync])
1550		1772
1551	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1773	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1552	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1774	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1553		1775
1554	=item $term->allow_events_async	1776	=item $term->allow_events_async
1555		1777
1556	Calls XAllowEvents with AsyncBoth for the most recent grab.	1778	Calls XAllowEvents with AsyncBoth for the most recent grab.
1557		1779
…		…
1564	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1786	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1565	recent grab.	1787	recent grab.
1566		1788
1567	=item $term->ungrab	1789	=item $term->ungrab
1568		1790
1569	Calls XUngrab for the most recent grab. Is called automatically on	1791	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1570	evaluation errors, as it is better to lose the grab in the error case as	1792	evaluation errors, as it is better to lose the grab in the error case as
1571	the session.	1793	the session.
1572		1794
1573	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1795	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1574		1796
…		…
1576		1798
1577	=item @atoms = $term->XListProperties ($window)	1799	=item @atoms = $term->XListProperties ($window)
1578		1800
1579	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1801	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1580		1802
1581	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1803	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1582		1804
1583	=item $term->XDeleteProperty ($window, $property)	1805	=item $term->XDeleteProperty ($window, $property)
1584		1806
1585	=item $window = $term->DefaultRootWindow	1807	=item $window = $term->DefaultRootWindow
1586		1808
…		…
1593	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1815	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1594		1816
1595	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1817	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1596		1818
1597	=item $term->XChangeInput ($window, $add_events[, $del_events])	1819	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1820
		1821	=item $keysym = $term->XStringToKeysym ($string)
		1822
		1823	=item $string = $term->XKeysymToString ($keysym)
1598		1824
1599	Various X or X-related functions. The C<$term> object only serves as	1825	Various X or X-related functions. The C<$term> object only serves as
1600	the source of the display, otherwise those functions map more-or-less	1826	the source of the display, otherwise those functions map more-or-less
1601	directory onto the X functions of the same name.	1827	directly onto the X functions of the same name.
1602		1828
1603	=back	1829	=back
1604		1830
1605	=cut	1831	=cut
1606		1832
…		…
1670	my ($self, $text, $cb) = @_;	1896	my ($self, $text, $cb) = @_;
1671		1897
1672	$self->add_item ({ type => "button", text => $text, activate => $cb});	1898	$self->add_item ({ type => "button", text => $text, activate => $cb});
1673	}	1899	}
1674		1900
1675	=item $popup->add_toggle ($text, $cb, $initial_value)	1901	=item $popup->add_toggle ($text, $initial_value, $cb)
1676		1902
1677	Adds a toggle/checkbox item to the popup. Teh callback gets called	1903	Adds a toggle/checkbox item to the popup. The callback gets called
1678	whenever it gets toggled, with a boolean indicating its value as its first	1904	whenever it gets toggled, with a boolean indicating its new value as its
1679	argument.	1905	first argument.
1680		1906
1681	=cut	1907	=cut
1682		1908
1683	sub add_toggle {	1909	sub add_toggle {
1684	my ($self, $text, $cb, $value) = @_;	1910	my ($self, $text, $value, $cb) = @_;
1685		1911
1686	my $item; $item = {	1912	my $item; $item = {
1687	type => "button",	1913	type => "button",
1688	text => " $text",	1914	text => " $text",
1689	value => $value,	1915	value => $value,
…		…
1708	my $env = $self->{term}->env;	1934	my $env = $self->{term}->env;
1709	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1935	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1710	delete $env->{LC_ALL};	1936	delete $env->{LC_ALL};
1711	$env->{LC_CTYPE} = $self->{term}->locale;	1937	$env->{LC_CTYPE} = $self->{term}->locale;
1712		1938
1713	urxvt::term->new ($env, "popup",	1939	my $term = urxvt::term->new (
		1940	$env, "popup",
1714	"--perl-lib" => "", "--perl-ext-common" => "",	1941	"--perl-lib" => "", "--perl-ext-common" => "",
1715	"-pty-fd" => -1, "-sl" => 0,	1942	"-pty-fd" => -1, "-sl" => 0,
1716	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1943	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1717	"--transient-for" => $self->{term}->parent,	1944	"--transient-for" => $self->{term}->parent,
1718	"-display" => $self->{term}->display_id,	1945	"-display" => $self->{term}->display_id,
1719	"-pe" => "urxvt-popup")	1946	"-pe" => "urxvt-popup",
1720	or die "unable to create popup window\n";	1947	) or die "unable to create popup window\n";
		1948
		1949	unless (delete $term->{urxvt_popup_init_done}) {
		1950	$term->ungrab;
		1951	$term->destroy;
		1952	die "unable to initialise popup window\n";
		1953	}
1721	}	1954	}
1722		1955
1723	sub DESTROY {	1956	sub DESTROY {
1724	my ($self) = @_;	1957	my ($self) = @_;
1725		1958
…		…
1730	=back	1963	=back
1731		1964
1732	=cut	1965	=cut
1733		1966
1734	package urxvt::watcher;	1967	package urxvt::watcher;
1735
1736	@urxvt::timer::ISA = __PACKAGE__;
1737	@urxvt::iow::ISA = __PACKAGE__;
1738	@urxvt::pw::ISA = __PACKAGE__;
1739	@urxvt::iw::ISA = __PACKAGE__;
1740		1968
1741	=head2 The C<urxvt::timer> Class	1969	=head2 The C<urxvt::timer> Class
1742		1970
1743	This class implements timer watchers/events. Time is represented as a	1971	This class implements timer watchers/events. Time is represented as a
1744	fractional number of seconds since the epoch. Example:	1972	fractional number of seconds since the epoch. Example:
…		…
1748	->new	1976	->new
1749	->interval (1)	1977	->interval (1)
1750	->cb (sub {	1978	->cb (sub {
1751	$term->{overlay}->set (0, 0,	1979	$term->{overlay}->set (0, 0,
1752	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1980	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1753	});	1981	});
1754		1982
1755	=over 4	1983	=over 4
1756		1984
1757	=item $timer = new urxvt::timer	1985	=item $timer = new urxvt::timer
1758		1986
…		…
1761		1989
1762	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1990	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1763		1991
1764	Set the callback to be called when the timer triggers.	1992	Set the callback to be called when the timer triggers.
1765		1993
1766	=item $tstamp = $timer->at
1767
1768	Return the time this watcher will fire next.
1769
1770	=item $timer = $timer->set ($tstamp)	1994	=item $timer = $timer->set ($tstamp[, $interval])
1771		1995
1772	Set the time the event is generated to $tstamp.	1996	Set the time the event is generated to $tstamp (and optionally specifies a
		1997	new $interval).
1773		1998
1774	=item $timer = $timer->interval ($interval)	1999	=item $timer = $timer->interval ($interval)
1775		2000
1776	Normally (and when C<$interval> is C<0>), the timer will automatically	2001	By default (and when C<$interval> is C<0>), the timer will automatically
1777	stop after it has fired once. If C<$interval> is non-zero, then the timer	2002	stop after it has fired once. If C<$interval> is non-zero, then the timer
1778	is automatically rescheduled at the given intervals.	2003	is automatically rescheduled at the given intervals.
1779		2004
1780	=item $timer = $timer->start	2005	=item $timer = $timer->start
1781		2006
1782	Start the timer.	2007	Start the timer.
1783		2008
1784	=item $timer = $timer->start ($tstamp)	2009	=item $timer = $timer->start ($tstamp[, $interval])
1785		2010
1786	Set the event trigger time to C<$tstamp> and start the timer.	2011	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2012	also replaces the interval.
1787		2013
1788	=item $timer = $timer->after ($delay)	2014	=item $timer = $timer->after ($delay[, $interval])
1789		2015
1790	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2016	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1791		2017
1792	=item $timer = $timer->stop	2018	=item $timer = $timer->stop
1793		2019
…		…
1801		2027
1802	$term->{socket} = ...	2028	$term->{socket} = ...
1803	$term->{iow} = urxvt::iow	2029	$term->{iow} = urxvt::iow
1804	->new	2030	->new
1805	->fd (fileno $term->{socket})	2031	->fd (fileno $term->{socket})
1806	->events (urxvt::EVENT_READ)	2032	->events (urxvt::EV_READ)
1807	->start	2033	->start
1808	->cb (sub {	2034	->cb (sub {
1809	my ($iow, $revents) = @_;	2035	my ($iow, $revents) = @_;
1810	# $revents must be 1 here, no need to check	2036	# $revents must be 1 here, no need to check
1811	sysread $term->{socket}, my $buf, 8192	2037	sysread $term->{socket}, my $buf, 8192
…		…
1824	Set the callback to be called when io events are triggered. C<$reventmask>	2050	Set the callback to be called when io events are triggered. C<$reventmask>
1825	is a bitset as described in the C<events> method.	2051	is a bitset as described in the C<events> method.
1826		2052
1827	=item $iow = $iow->fd ($fd)	2053	=item $iow = $iow->fd ($fd)
1828		2054
1829	Set the filedescriptor (not handle) to watch.	2055	Set the file descriptor (not handle) to watch.
1830		2056
1831	=item $iow = $iow->events ($eventmask)	2057	=item $iow = $iow->events ($eventmask)
1832		2058
1833	Set the event mask to watch. The only allowed values are	2059	Set the event mask to watch. The only allowed values are
1834	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2060	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1835	together, or C<urxvt::EVENT_NONE>.	2061	together, or C<urxvt::EV_NONE>.
1836		2062
1837	=item $iow = $iow->start	2063	=item $iow = $iow->start
1838		2064
1839	Start watching for requested events on the given handle.	2065	Start watching for requested events on the given handle.
1840		2066
1841	=item $iow = $iow->stop	2067	=item $iow = $iow->stop
1842		2068
1843	Stop watching for events on the given filehandle.	2069	Stop watching for events on the given file handle.
1844		2070
1845	=back	2071	=back
1846		2072
1847	=head2 The C<urxvt::iw> Class	2073	=head2 The C<urxvt::iw> Class
1848		2074
…		…
1881	->new	2107	->new
1882	->start ($pid)	2108	->start ($pid)
1883	->cb (sub {	2109	->cb (sub {
1884	my ($pw, $exit_status) = @_;	2110	my ($pw, $exit_status) = @_;
1885	...	2111	...
1886	});	2112	});
1887		2113
1888	=over 4	2114	=over 4
1889		2115
1890	=item $pw = new urxvt::pw	2116	=item $pw = new urxvt::pw
1891		2117
…		…
1895		2121
1896	Set the callback to be called when the timer triggers.	2122	Set the callback to be called when the timer triggers.
1897		2123
1898	=item $pw = $timer->start ($pid)	2124	=item $pw = $timer->start ($pid)
1899		2125
1900	Tells the wqtcher to start watching for process C<$pid>.	2126	Tells the watcher to start watching for process C<$pid>.
1901		2127
1902	=item $pw = $pw->stop	2128	=item $pw = $pw->stop
1903		2129
1904	Stop the watcher.	2130	Stop the watcher.
1905		2131
…		…
1918		2144
1919	=item >= 3 - script loading and management	2145	=item >= 3 - script loading and management
1920		2146
1921	=item >=10 - all called hooks	2147	=item >=10 - all called hooks
1922		2148
1923	=item >=11 - hook reutrn values	2149	=item >=11 - hook return values
1924		2150
1925	=back	2151	=back
1926		2152
1927	=head1 AUTHOR	2153	=head1 AUTHOR
1928		2154
1929	Marc Lehmann <pcg@goof.com>	2155	Marc Lehmann <schmorp@schmorp.de>
1930	http://software.schmorp.de/pkg/rxvt-unicode	2156	http://software.schmorp.de/pkg/rxvt-unicode
1931		2157
1932	=cut	2158	=cut
1933		2159
1934	1	2160	1
		2161
		2162	# vim: sw=3:

Diff Legend

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