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

Diff Legend

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