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.90 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.234 by root, Sat May 17 15:25:04 2014 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	=over 4	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	=item selection (enabled by default)	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	Extensions that add command line parameters or resources on their own are
45	when the user extends selections (double-click and further clicks). Right	49	loaded automatically when used.
46	now, it tries to select words, urls and complete shell-quoted
47	arguments, which is very convenient, too, if your F<ls> supports
48	C<--quoting-style=shell>.
49
50	A double-click usually selects the word under the cursor, further clicks
51	will enlarge the selection.
52
53	The selection works by trying to match a number of regexes and displaying
54	them in increasing order of length. You can add your own regexes by
55	specifying resources of the form:
56
57	URxvt.selection.pattern-0: perl-regex
58	URxvt.selection.pattern-1: perl-regex
59	...
60
61	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:
65
66	URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.
70
71	This extension also offers the following bindable keyboard command:
72
73	=over 4
74
75	=item rot13
76
77	Rot-13 the selection when activated. Used via keyboard trigger:
78
79	URxvt.keysym.C-M-r: perl:selection:rot13
80
81	=back
82
83	=item option-popup (enabled by default)
84
85	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86	runtime.
87
88	=item selection-popup (enabled by default)
89
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.
93
94	=item searchable-scrollback<hotkey> (enabled by default)
95
96	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
98	input/output is suspended and a regex is displayed at the bottom of the
99	screen.
100
101	Inputting characters appends them to the regex and continues incremental
102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
104	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary
107	selection.
108
109	=item selection-autotransform
110
111	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.
113
114	It works by specifying perl snippets (most useful is a single C<s///>
115	operator) that modify C<$_> as resources:
116
117	URxvt.selection-autotransform.0: transform
118	URxvt.selection-autotransform.1: transform
119	...
120
121	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:
124
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:
129
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131
132	Of course, this can be modified to suit your needs and your editor :)
133
134	=item mark-urls
135
136	Uses per-line display filtering (C<on_line_update>) to underline urls and
137	make them clickable. When middle-clicked, the program specified in the
138	resource C<urlLauncher> (default C<x-www-browser>) will be started with
139	the URL as first argument.
140
141	=item block-graphics-to-ascii
142
143	A not very useful example of filtering all text output to the terminal,
144	by replacing all line-drawing characters (U+2500 .. U+259F) by a
145	similar-looking ascii character.
146
147	=item digital-clock
148
149	Displays a digital clock using the built-in overlay.
150
151	=item example-refresh-hooks
152
153	Displays a very simple digital clock in the upper right corner of the
154	window. Illustrates overwriting the refresh callbacks to create your own
155	overlays or changes.
156
157	=back
158		50
159	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
160		52
161	=head2 General API Considerations	53	=head2 General API Considerations
162		54
…		…
176		68
177	=over 4	69	=over 4
178		70
179	=item $text	71	=item $text
180		72
181	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
182	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.
183		75
184	=item $string	76	=item $string
185		77
186	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
…		…
190	=item $octets	82	=item $octets
191		83
192	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
193	locale-specific way.	85	locale-specific way.
194		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
195	=back	93	=back
196		94
197	=head2 Extension Objects	95	=head2 Extension Objects
198		96
199	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
200	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,
201	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
202	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
203	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
204	use.	103	internal use.
205		104
206	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
207	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
208		107
209	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
210		109	the C<urxvt::extension> section below.
211	=over 4
212
213	=item $urxvt_term = $self->{term}
214
215	Returns the C<urxvt::term> object associated with this instance of the
216	extension. This member I<must not> be changed in any way.
217
218	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
219
220	Dynamically enable the given hooks (named without the C<on_> prefix) for
221	this extension, replacing any previous hook. This is useful when you want
222	to overwrite time-critical hooks only temporarily.
223
224	=item $self->disable ($hook_name[, $hook_name..])
225
226	Dynamically disable the given hooks.
227
228	=back
229		110
230	=head2 Hooks	111	=head2 Hooks
231		112
232	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
233	called whenever the relevant event happens.	114	called whenever the relevant event happens.
234		115
235	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
236	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
237		118
238	B<All> of these hooks must return a boolean value. If it is true, then the	119	B<All> of these hooks must return a boolean value. If any of the called
239	event counts as being I<consumed>, and the invocation of other hooks is	120	hooks returns true, then the event counts as being I<consumed>, and the
240	skipped, and the relevant action might not be carried out by the C++ code.	121	relevant action might not be carried out by the C++ code.
241		122
242	I<< When in doubt, return a false value (preferably C<()>). >>	123	I<< When in doubt, return a false value (preferably C<()>). >>
243		124
244	=over 4	125	=over 4
245		126
246	=item on_init $term	127	=item on_init $term
247		128
248	Called after a new terminal object has been initialized, but before	129	Called after a new terminal object has been initialized, but before
249	windows are created or the command gets run. Most methods are unsafe to	130	windows are created or the command gets run. Most methods are unsafe to
250	call or deliver senseless data, as terminal size and other characteristics	131	call or deliver senseless data, as terminal size and other characteristics
251	have not yet been determined. You can safely query and change resources,	132	have not yet been determined. You can safely query and change resources
252	though.	133	and options, though. For many purposes the C<on_start> hook is a better
		134	place.
		135
		136	=item on_start $term
		137
		138	Called at the very end of initialisation of a new terminal, just before
		139	trying to map (display) the toplevel and returning to the main loop.
		140
		141	=item on_destroy $term
		142
		143	Called whenever something tries to destroy terminal, when the terminal is
		144	still fully functional (not for long, though).
253		145
254	=item on_reset $term	146	=item on_reset $term
255		147
256	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
257	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
258	variables.	150	variables.
259		151
260	=item on_start $term	152	=item on_child_start $term, $pid
261		153
262	Called at the very end of initialisation of a new terminal, just before	154	Called just after the child process has been C<fork>ed.
263	returning to the mainloop.	155
		156	=item on_child_exit $term, $status
		157
		158	Called just after the child process has exited. C<$status> is the status
		159	from C<waitpid>.
264		160
265	=item on_sel_make $term, $eventtime	161	=item on_sel_make $term, $eventtime
266		162
267	Called whenever a selection has been made by the user, but before the	163	Called whenever a selection has been made by the user, but before the
268	selection text is copied, so changes to the beginning, end or type of the	164	selection text is copied, so changes to the beginning, end or type of the
…		…
275		171
276	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
277	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
278	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
279		175
280	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.
281		177
282	=item on_sel_extend $term	178	=item on_sel_extend $term
283		179
284	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
285	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
286	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
287	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
288	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
289	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
290		186
291	See the F<selection> example extension.	187	See the F<selection> example extension.
292		188
293	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
294		190
295	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
296	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
297	show this many lines of scrollback.	193	show this many lines of scrollback.
298		194
299	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
300		196
…		…
304		200
305	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,
306	$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
307	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
308		204
309	=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
310		216
311	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
312	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
313	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
314	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,
315	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
316	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	}
317		233
318	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,
319	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
320	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.
321		240
322	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
323		242
324	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
325	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
…		…
330	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
331		250
332	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
333	suppress or filter tty input.	252	suppress or filter tty input.
334		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
335	=item on_line_update $term, $row	261	=item on_line_update $term, $row
336		262
337	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
338	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
339	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,
…		…
346	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
347	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
348		274
349	=item on_refresh_begin $term	275	=item on_refresh_begin $term
350		276
351	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
352	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
353	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
354	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
355		281
356	=item on_refresh_end $term	282	=item on_refresh_end $term
357		283
358	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>.
359		285
360	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
361		287
362	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
363	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>
364	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_resize_all_windows $term, $new_width, $new_height
		296
		297	Called just after the new window size has been calculated, but before
		298	windows are actually being resized or hints are being set. If this hook
		299	returns a true value, setting of the window hints is being skipped.
		300
		301	=item on_x_event $term, $event
		302
		303	Called on every X event received on the vt window (and possibly other
		304	windows). Should only be used as a last resort. Most event structure
		305	members are not passed.
		306
		307	=item on_root_event $term, $event
		308
		309	Like C<on_x_event>, but is called for events on the root window.
365		310
366	=item on_focus_in $term	311	=item on_focus_in $term
367		312
368	Called whenever the window gets the keyboard focus, before rxvt-unicode	313	Called whenever the window gets the keyboard focus, before rxvt-unicode
369	does focus in processing.	314	does focus in processing.
370		315
371	=item on_focus_out $term	316	=item on_focus_out $term
372		317
373	Called wheneever the window loses keyboard focus, before rxvt-unicode does	318	Called whenever the window loses keyboard focus, before rxvt-unicode does
374	focus out processing.	319	focus out processing.
375		320
		321	=item on_configure_notify $term, $event
		322
		323	=item on_property_notify $term, $event
		324
376	=item on_key_press $term, $event, $keysym, $octets	325	=item on_key_press $term, $event, $keysym, $octets
377		326
378	=item on_key_release $term, $event, $keysym	327	=item on_key_release $term, $event, $keysym
379		328
380	=item on_button_press $term, $event	329	=item on_button_press $term, $event
…		…
385		334
386	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
387		336
388	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
389		338
390	Called whenever the corresponding X event is received for the terminal If	339	Called whenever the corresponding X event is received for the terminal. If
391	the hook returns true, then the even will be ignored by rxvt-unicode.	340	the hook returns true, then the event will be ignored by rxvt-unicode.
392		341
393	The event is a hash with most values as named by Xlib (see the XEvent	342	The event is a hash with most values as named by Xlib (see the XEvent
394	manpage), with the additional members C<row> and C<col>, which are the row	343	manpage), with the additional members C<row> and C<col>, which are the
395	and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
396		345
397	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
398	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
399		348
400	subwindow.	349	=item on_client_message $term, $event
		350
		351	=item on_wm_protocols $term, $event
		352
		353	=item on_wm_delete_window $term, $event
		354
		355	Called when various types of ClientMessage events are received (all with
		356	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		357
		358	=item on_bell $term
		359
		360	Called on receipt of a bell character.
401		361
402	=back	362	=back
403		363
404	=cut	364	=cut
405		365
406	package urxvt;	366	package urxvt;
407		367
408	use utf8;	368	use utf8;
409	use strict;	369	use strict 'vars';
410	use Carp ();	370	use Carp ();
411	use Scalar::Util ();	371	use Scalar::Util ();
412	use List::Util ();	372	use List::Util ();
413		373
414	our $VERSION = 1;	374	our $VERSION = 1;
415	our $TERM;	375	our $TERM;
		376	our @TERM_INIT; # should go, prevents async I/O etc.
		377	our @TERM_EXT; # should go, prevents async I/O etc.
416	our @HOOKNAME;	378	our @HOOKNAME;
417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
418	our %OPTION;	380	our %OPTION;
419		381
420	our $LIBDIR;	382	our $LIBDIR;
421	our $RESNAME;	383	our $RESNAME;
422	our $RESCLASS;	384	our $RESCLASS;
423	our $RXVTNAME;	385	our $RXVTNAME;
424		386
		387	our $NOCHAR = chr 0xffff;
		388
425	=head2 Variables in the C<urxvt> Package	389	=head2 Variables in the C<urxvt> Package
426		390
427	=over 4	391	=over 4
428		392
429	=item $urxvt::LIBDIR	393	=item $urxvt::LIBDIR
…		…
442	=item $urxvt::TERM	406	=item $urxvt::TERM
443		407
444	The current terminal. This variable stores the current C<urxvt::term>	408	The current terminal. This variable stores the current C<urxvt::term>
445	object, whenever a callback/hook is executing.	409	object, whenever a callback/hook is executing.
446		410
		411	=item @urxvt::TERM_INIT
		412
		413	All code references in this array will be called as methods of the next newly
		414	created C<urxvt::term> object (during the C<on_init> phase). The array
		415	gets cleared before the code references that were in it are being executed,
		416	so references can push themselves onto it again if they so desire.
		417
		418	This complements to the perl-eval command line option, but gets executed
		419	first.
		420
		421	=item @urxvt::TERM_EXT
		422
		423	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		424	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		425	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		426
447	=back	427	=back
448		428
449	=head2 Functions in the C<urxvt> Package	429	=head2 Functions in the C<urxvt> Package
450		430
451	=over 4	431	=over 4
452		432
453	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
454		434
455	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
456	costs! The only time this is acceptable is when the terminal process	436	include a trailing newline). Avoid at all costs! The only time this
457	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
458		439
459	=item urxvt::warn $string	440	=item urxvt::warn $string
460		441
461	Calls C<rxvt_warn> with the given string which should not include a	442	Calls C<rxvt_warn> with the given string which should include a trailing
462	newline. The module also overwrites the C<warn> builtin with a function	443	newline. The module also overwrites the C<warn> builtin with a function
463	that calls this function.	444	that calls this function.
464		445
465	Using this function has the advantage that its output ends up in the	446	Using this function has the advantage that its output ends up in the
466	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
467		448
468	Messages have a size limit of 1023 bytes currently.	449	Messages have a size limit of 1023 bytes currently.
469		450
470	=item $is_safe = urxvt::safe	451	=item @terms = urxvt::termlist
471		452
472	Returns true when it is safe to do potentially unsafe things, such as	453	Returns all urxvt::term objects that exist in this process, regardless of
473	evaluating perl code specified by the user. This is true when urxvt was	454	whether they are started, being destroyed etc., so be careful. Only term
474	started setuid or setgid.	455	objects that have perl extensions attached will be returned (because there
		456	is no urxvt::term object associated with others).
475		457
476	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
477		459
478	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
479		461
480	=item urxvt::CurrentTime	462	=item urxvt::CurrentTime
481		463
482	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	464	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	465	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484	Button4Mask, Button5Mask, AnyModifier	466	Button4Mask, Button5Mask, AnyModifier
		467
		468	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		469	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		470	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		471	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		472	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		473	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		474	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		475
		476	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		477	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		478	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		479	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		480	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		481	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		482	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
485		483
486	Various constants for use in X calls and event processing.	484	Various constants for use in X calls and event processing.
487		485
488	=back	486	=back
489		487
…		…
506		504
507	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
508		506
509	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
510		508
511	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	509	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		510	urxvt::RS_RVid, urxvt::RS_Uline
512		511
513	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
514	underline, respectively. To enable such a style, just logically OR it into	513	underline, respectively. To enable such a style, just logically OR it into
515	the bitset.	514	the bitset.
516		515
…		…
522		521
523	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	522	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
524		523
525	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	524	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
526		525
		526	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		527
527	Replace the foreground/background colour in the rendition mask with the	528	Replace the foreground/background colour in the rendition mask with the
528	specified one.	529	specified one.
529		530
530	=item $value = urxvt::GET_CUSTOM $rend	531	=item $value = urxvt::GET_CUSTOM $rend
531		532
…		…
540	=back	541	=back
541		542
542	=cut	543	=cut
543		544
544	BEGIN {	545	BEGIN {
545	urxvt->bootstrap;
546
547	# overwrite perl's warn	546	# overwrite perl's warn
548	*CORE::GLOBAL::warn = sub {	547	*CORE::GLOBAL::warn = sub {
549	my $msg = join "", @_;	548	my $msg = join "", @_;
550	$msg .= "\n"	549	$msg .= "\n"
551	unless $msg =~ /\n$/;	550	unless $msg =~ /\n$/;
552	urxvt::warn ($msg);	551	urxvt::warn ($msg);
553	};	552	};
554
555	# %ENV is the original startup environment
556	delete $ENV{IFS};
557	delete $ENV{CDPATH};
558	delete $ENV{BASH_ENV};
559	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
560	}	553	}
561		554
562	my @hook_count;	555	no warnings 'utf8';
		556
		557	sub parse_resource {
		558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		559
		560	$name =~ y/-/./ if $isarg;
		561
		562	$term->scan_extensions;
		563
		564	my $r = $term->{meta}{resource};
		565	keys %$r; # reset iterator
		566	while (my ($pattern, $v) = each %$r) {
		567	if (
		568	$pattern =~ /\.$/
		569	? $pattern eq substr $name, 0, length $pattern
		570	: $pattern eq $name
		571	) {
		572	$name = "$urxvt::RESCLASS.$name";
		573
		574	push @{ $term->{perl_ext_3} }, $v->[0];
		575
		576	if ($v->[1] eq "boolean") {
		577	$term->put_option_db ($name, $flag ? "true" : "false");
		578	return 1;
		579	} else {
		580	$term->put_option_db ($name, $value);
		581	return 1 + 2;
		582	}
		583	}
		584	}
		585
		586	0
		587	}
		588
		589	sub usage {
		590	my ($term, $usage_type) = @_;
		591
		592	$term->scan_extensions;
		593
		594	my $r = $term->{meta}{resource};
		595
		596	for my $pattern (sort keys %$r) {
		597	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		598
		599	$desc .= " (-pe $ext)";
		600
		601	if ($usage_type == 1) {
		602	$pattern =~ y/./-/;
		603	$pattern =~ s/-$/-.../g;
		604
		605	if ($type eq "boolean") {
		606	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		607	} else {
		608	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		609	}
		610	} else {
		611	$pattern =~ s/\.$/.*/g;
		612	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		613	}
		614	}
		615	}
		616
563	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564		618
565	sub verbose {	619	sub verbose {
566	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
567	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
568	}	622	}
569		623
570	my $extension_pkg = "extension0000";
571	my %extension_pkg;	624	my %extension_pkg;
572		625
573	# load a single script into its own package, once only	626	# load a single script into its own package, once only
574	sub extension_package($) {	627	sub extension_package($) {
575	my ($path) = @_;	628	my ($path) = @_;
576		629
577	$extension_pkg{$path} ||= do {	630	$extension_pkg{$path} ||= do {
578	my $pkg = "urxvt::" . ($extension_pkg++);	631	$path =~ /([^\/\\]+)$/;
		632	my $pkg = $1;
		633	$pkg =~ s/[^[:word:]]/_/g;
		634	$pkg = "urxvt::ext::$pkg";
579		635
580	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
581		639
582	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
583	or die "$path: $!";	641	or die "$path: $!";
584		642
585	my $source = untaint	643	my $source =
586	"package $pkg; use strict; use utf8;\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
587	. "use base urxvt::term::extension::;\n"
588	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
589	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
590	. "\n};\n1";	647	. "\n};\n1";
591		648
592	eval $source	649	eval $source
…		…
601	# called by the rxvt core	658	# called by the rxvt core
602	sub invoke {	659	sub invoke {
603	local $TERM = shift;	660	local $TERM = shift;
604	my $htype = shift;	661	my $htype = shift;
605		662
606	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
607	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
608		665
		666	$TERM->scan_extensions;
		667
609	my %ext_arg;	668	my %ext_arg;
610		669
		670	{
		671	my @init = @TERM_INIT;
		672	@TERM_INIT = ();
		673	$_->($TERM) for @init;
		674	my @pkg = @TERM_EXT;
		675	@TERM_EXT = ();
		676	$TERM->register_package ($_) for @pkg;
		677	}
		678
		679	for (
		680	@{ delete $TERM->{perl_ext_3} },
611	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	681	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		682	) {
612	if ($_ eq "default") {	683	if ($_ eq "default") {
613	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	684	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
614	} elsif (/^-(.*)$/) {	685	} elsif (/^-(.*)$/) {
615	delete $ext_arg{$1};	686	delete $ext_arg{$1};
616	} elsif (/^([^<]+)<(.*)>$/) {	687	} elsif (/^([^<]+)<(.*)>$/) {
617	push @{ $ext_arg{$1} }, $2;	688	push @{ $ext_arg{$1} }, $2;
618	} else {	689	} else {
619	$ext_arg{$_} ||= [];	690	$ext_arg{$_} ||= [];
620	}	691	}
621	}	692	}
622		693
623	while (my ($ext, $argv) = each %ext_arg) {	694	for my $ext (sort keys %ext_arg) {
624	my @files = grep -f $_, map "$_/$ext", @dirs;	695	my @files = grep -f $_, map "$_/$ext", @dirs;
625		696
626	if (@files) {	697	if (@files) {
627	$TERM->register_package (extension_package $files[0], $argv);	698	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
628	} else {	699	} else {
629	warn "perl extension '$ext' not found in perl library search path\n";	700	warn "perl extension '$ext' not found in perl library search path\n";
630	}	701	}
631	}	702	}
632		703
…		…
638		709
639	if (my $cb = $TERM->{_hook}[$htype]) {	710	if (my $cb = $TERM->{_hook}[$htype]) {
640	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	711	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
641	if $verbosity >= 10;	712	if $verbosity >= 10;
642		713
643	keys %$cb;	714	if ($htype == HOOK_ACTION) {
		715	# this hook is only sent to the extension with the name
		716	# matching the first arg
		717	my $pkg = shift;
		718	$pkg =~ y/-/_/;
		719	$pkg = "urxvt::ext::$pkg";
644		720
645	while (my ($pkg, $cb) = each %$cb) {	721	$cb = $cb->{$pkg}
		722	or return undef; #TODO: maybe warn user?
		723
		724	$cb = { $pkg => $cb };
		725	}
		726
		727	for my $pkg (keys %$cb) {
646	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	728	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
647	and last;	729	$retval ||= $retval_;
648		730
649	if ($@) {	731	if ($@) {
650	$TERM->ungrab; # better to lose the grab than the session	732	$TERM->ungrab; # better to lose the grab than the session
651	warn $@;	733	warn $@;
652	}	734	}
…		…
654		736
655	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	737	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656	if $verbosity >= 11;	738	if $verbosity >= 11;
657	}	739	}
658		740
659	if ($htype == 1) { # DESTROY	741	if ($htype == HOOK_DESTROY) {
660	if (my $hook = delete $TERM->{_hook}) {
661	for my $htype (0..$#$hook) {
662	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
663	or set_should_invoke $htype, 0;
664	}
665	}
666
667	# clear package objects	742	# clear package objects
668	%$_ = () for values %{ $TERM->{_pkg} };	743	%$_ = () for values %{ $TERM->{_pkg} };
669		744
670	# clear package	745	# clear package
671	%$TERM = ();	746	%$TERM = ();
672	}	747	}
673		748
674	$retval	749	$retval
675	}	750	}
676		751
677	sub exec_async(@) {	752	sub SET_COLOR($$$) {
678	my $pid = fork;	753	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
679
680	return
681	if !defined $pid or $pid;
682
683	%ENV = %{ $TERM->env };
684
685	exec @_;
686	_exit 255;
687	}	754	}
688		755
689	# urxvt::term::extension	756	sub rend2mask {
690		757	no strict 'refs';
691	package urxvt::term::extension;	758	my ($str, $mask) = (@_, 0);
692		759	my %color = ( fg => undef, bg => undef );
693	sub enable {	760	my @failed;
694	my ($self, %hook) = @_;	761	for my $spec ( split /\s+/, $str ) {
695	my $pkg = $self->{_pkg};	762	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
696		763	$color{lc($1)} = $2;
697	while (my ($name, $cb) = each %hook) {	764	} else {
698	my $htype = $HOOKTYPE{uc $name};	765	my $neg = $spec =~ s/^[-^]//;
699	defined $htype	766	unless ( exists &{"RS_$spec"} ) {
700	or Carp::croak "unsupported hook type '$name'";	767	push @failed, $spec;
701		768	next;
702	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
703	$hook_count[$htype]++
704	or urxvt::set_should_invoke $htype, 1;
705	}	769	}
706		770	my $cur = &{"RS_$spec"};
707	$self->{term}{_hook}[$htype]{$pkg} = $cb;	771	if ( $neg ) {
708	}	772	$mask &= ~$cur;
709	}	773	} else {
710		774	$mask |= $cur;
711	sub disable {	775	}
712	my ($self, @hook) = @_;
713	my $pkg = $self->{_pkg};
714
715	for my $name (@hook) {
716	my $htype = $HOOKTYPE{uc $name};
717	defined $htype
718	or Carp::croak "unsupported hook type '$name'";
719
720	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
721	--$hook_count[$htype]
722	or urxvt::set_should_invoke $htype, 0;
723	}	776	}
724	}	777	}
		778	($mask, @color{qw(fg bg)}, \@failed)
725	}	779	}
		780
		781	package urxvt::term::extension;
		782
		783	=head2 The C<urxvt::term::extension> class
		784
		785	Each extension attached to a terminal object is represented by
		786	a C<urxvt::term::extension> object.
		787
		788	You can use these objects, which are passed to all callbacks to store any
		789	state related to the terminal and extension instance.
		790
		791	The methods (And data members) documented below can be called on extension
		792	objects, in addition to call methods documented for the <urxvt::term>
		793	class.
		794
		795	=over 4
		796
		797	=item $urxvt_term = $self->{term}
		798
		799	Returns the C<urxvt::term> object associated with this instance of the
		800	extension. This member I<must not> be changed in any way.
		801
		802	=cut
726		803
727	our $AUTOLOAD;	804	our $AUTOLOAD;
728		805
729	sub AUTOLOAD {	806	sub AUTOLOAD {
730	$AUTOLOAD =~ /:([^:]+)$/	807	$AUTOLOAD =~ /:([^:]+)$/
…		…
743		820
744	sub DESTROY {	821	sub DESTROY {
745	# nop	822	# nop
746	}	823	}
747		824
748	# urxvt::destroy_hook	825	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
749		826
750	sub urxvt::destroy_hook::DESTROY {	827	sub urxvt::destroy_hook::DESTROY {
751	${$_[0]}->();	828	${$_[0]}->();
752	}	829	}
753		830
754	sub urxvt::destroy_hook(&) {	831	sub urxvt::destroy_hook(&) {
755	bless \shift, urxvt::destroy_hook::	832	bless \shift, urxvt::destroy_hook::
756	}	833	}
		834
		835	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		836
		837	Dynamically enable the given hooks (named without the C<on_> prefix) for
		838	this extension, replacing any hook previously installed via C<enable> in
		839	this extension.
		840
		841	This is useful when you want to overwrite time-critical hooks only
		842	temporarily.
		843
		844	To install additional callbacks for the same hook, you can use the C<on>
		845	method of the C<urxvt::term> class.
		846
		847	=item $self->disable ($hook_name[, $hook_name..])
		848
		849	Dynamically disable the given hooks.
		850
		851	=cut
		852
		853	sub enable {
		854	my ($self, %hook) = @_;
		855	my $pkg = $self->{_pkg};
		856
		857	while (my ($name, $cb) = each %hook) {
		858	my $htype = $HOOKTYPE{uc $name};
		859	defined $htype
		860	or Carp::croak "unsupported hook type '$name'";
		861
		862	$self->set_should_invoke ($htype, +1)
		863	unless exists $self->{term}{_hook}[$htype]{$pkg};
		864
		865	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		866	}
		867	}
		868
		869	sub disable {
		870	my ($self, @hook) = @_;
		871	my $pkg = $self->{_pkg};
		872
		873	for my $name (@hook) {
		874	my $htype = $HOOKTYPE{uc $name};
		875	defined $htype
		876	or Carp::croak "unsupported hook type '$name'";
		877
		878	$self->set_should_invoke ($htype, -1)
		879	if delete $self->{term}{_hook}[$htype]{$pkg};
		880	}
		881	}
		882
		883	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		884
		885	Similar to the C<enable> enable, but installs additional callbacks for
		886	the given hook(s) (that is, it doesn't replace existing callbacks), and
		887	returns a guard object. When the guard object is destroyed the callbacks
		888	are disabled again.
		889
		890	=cut
		891
		892	sub urxvt::extension::on_disable::DESTROY {
		893	my $disable = shift;
		894
		895	my $term = delete $disable->{""};
		896
		897	while (my ($htype, $id) = each %$disable) {
		898	delete $term->{_hook}[$htype]{$id};
		899	$term->set_should_invoke ($htype, -1);
		900	}
		901	}
		902
		903	sub on {
		904	my ($self, %hook) = @_;
		905
		906	my $term = $self->{term};
		907
		908	my %disable = ( "" => $term );
		909
		910	while (my ($name, $cb) = each %hook) {
		911	my $htype = $HOOKTYPE{uc $name};
		912	defined $htype
		913	or Carp::croak "unsupported hook type '$name'";
		914
		915	$term->set_should_invoke ($htype, +1);
		916	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		917	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		918	}
		919
		920	bless \%disable, "urxvt::extension::on_disable"
		921	}
		922
		923	=item $self->x_resource ($pattern)
		924
		925	=item $self->x_resource_boolean ($pattern)
		926
		927	These methods support an additional C<%> prefix when called on an
		928	extension object - see the description of these methods in the
		929	C<urxvt::term> class for details.
		930
		931	=cut
		932
		933	sub x_resource {
		934	my ($self, $name) = @_;
		935	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		936	$self->{term}->x_resource ($name)
		937	}
		938
		939	sub x_resource_boolean {
		940	my ($self, $name) = @_;
		941	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		942	$self->{term}->x_resource_boolean ($name)
		943	}
		944
		945	=back
		946
		947	=cut
757		948
758	package urxvt::anyevent;	949	package urxvt::anyevent;
759		950
760	=head2 The C<urxvt::anyevent> Class	951	=head2 The C<urxvt::anyevent> Class
761		952
762	The sole purpose of this class is to deliver an interface to the	953	The sole purpose of this class is to deliver an interface to the
763	C<AnyEvent> module - any module using it will work inside urxvt without	954	C<AnyEvent> module - any module using it will work inside urxvt without
764	further programming. The only exception is that you cannot wait on	955	further programming. The only exception is that you cannot wait on
765	condition variables, but non-blocking condvar use is ok. What this means	956	condition variables, but non-blocking condvar use is ok.
766	is that you cannot use blocking APIs, but the non-blocking variant should
767	work.
768		957
769	=cut	958	In practical terms this means is that you cannot use blocking APIs, but
		959	the non-blocking variant should work.
770		960
		961	=cut
		962
771	our $VERSION = 1;	963	our $VERSION = '5.23';
772		964
773	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	965	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
774	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	966	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
775		967
776	sub timer {	968	sub timer {
…		…
778		970
779	my $cb = $arg{cb};	971	my $cb = $arg{cb};
780		972
781	urxvt::timer	973	urxvt::timer
782	->new	974	->new
783	->start (urxvt::NOW + $arg{after})	975	->after ($arg{after}, $arg{interval})
784	->cb (sub {	976	->cb ($arg{interval} ? $cb : sub {
785	$_[0]->stop; # need to cancel manually	977	$_[0]->stop; # need to cancel manually
786	$cb->();	978	$cb->();
787	})	979	})
788	}	980	}
789		981
790	sub io {	982	sub io {
791	my ($class, %arg) = @_;	983	my ($class, %arg) = @_;
792		984
793	my $cb = $arg{cb};	985	my $cb = $arg{cb};
		986	my $fd = fileno $arg{fh};
		987	defined $fd or $fd = $arg{fh};
794		988
795	bless [$arg{fh}, urxvt::iow	989	bless [$arg{fh}, urxvt::iow
796	->new	990	->new
797	->fd (fileno $arg{fh})	991	->fd ($fd)
798	->events (($arg{poll} =~ /r/ ? 1 : 0)	992	->events (($arg{poll} =~ /r/ ? 1 : 0)
799	| ($arg{poll} =~ /w/ ? 2 : 0))	993	| ($arg{poll} =~ /w/ ? 2 : 0))
800	->start	994	->start
801	->cb (sub {	995	->cb ($cb)
802	$cb->(($_[1] & 1 ? 'r' : '')
803	. ($_[1] & 2 ? 'w' : ''));
804	})],
805	urxvt::anyevent::	996	], urxvt::anyevent::
		997	}
		998
		999	sub idle {
		1000	my ($class, %arg) = @_;
		1001
		1002	my $cb = $arg{cb};
		1003
		1004	urxvt::iw
		1005	->new
		1006	->start
		1007	->cb ($cb)
		1008	}
		1009
		1010	sub child {
		1011	my ($class, %arg) = @_;
		1012
		1013	my $cb = $arg{cb};
		1014
		1015	urxvt::pw
		1016	->new
		1017	->start ($arg{pid})
		1018	->cb (sub {
		1019	$_[0]->stop; # need to cancel manually
		1020	$cb->($_[0]->rpid, $_[0]->rstatus);
		1021	})
806	}	1022	}
807		1023
808	sub DESTROY {	1024	sub DESTROY {
809	$_[0][1]->stop;	1025	$_[0][1]->stop;
810	}	1026	}
811		1027
812	sub condvar {	1028	# only needed for AnyEvent < 6 compatibility
813	bless \my $flag, urxvt::anyevent::condvar::	1029	sub one_event {
814	}
815
816	sub urxvt::anyevent::condvar::broadcast {
817	${$_[0]}++;
818	}
819
820	sub urxvt::anyevent::condvar::wait {
821	unless (${$_[0]}) {
822	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1030	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
823	}
824	}	1031	}
825		1032
826	package urxvt::term;	1033	package urxvt::term;
827		1034
828	=head2 The C<urxvt::term> Class	1035	=head2 The C<urxvt::term> Class
…		…
834	# find on_xxx subs in the package and register them	1041	# find on_xxx subs in the package and register them
835	# as hooks	1042	# as hooks
836	sub register_package {	1043	sub register_package {
837	my ($self, $pkg, $argv) = @_;	1044	my ($self, $pkg, $argv) = @_;
838		1045
		1046	no strict 'refs';
		1047
		1048	urxvt::verbose 6, "register package $pkg to $self";
		1049
		1050	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1051
839	my $proxy = bless {	1052	my $proxy = bless {
840	_pkg => $pkg,	1053	_pkg => $pkg,
		1054	_name => ${"$pkg\::_NAME"}, # hackish
841	argv => $argv,	1055	argv => $argv,
842	}, $pkg;	1056	}, $pkg;
843	Scalar::Util::weaken ($proxy->{term} = $self);	1057	Scalar::Util::weaken ($proxy->{term} = $self);
844		1058
845	$self->{_pkg}{$pkg} = $proxy;	1059	$self->{_pkg}{$pkg} = $proxy;
846		1060
…		…
849	$proxy->enable ($name => $ref);	1063	$proxy->enable ($name => $ref);
850	}	1064	}
851	}	1065	}
852	}	1066	}
853		1067
		1068	sub perl_libdirs {
		1069	map { split /:/ }
		1070	$_[0]->resource ("perl_lib"),
		1071	$ENV{URXVT_PERL_LIB},
		1072	"$ENV{HOME}/.urxvt/ext",
		1073	"$LIBDIR/perl"
		1074	}
		1075
		1076	# scan for available extensions and collect their metadata
		1077	sub scan_extensions {
		1078	my ($self) = @_;
		1079
		1080	return if exists $self->{meta};
		1081
		1082	my @libdirs = perl_libdirs $self;
		1083
		1084	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1085
		1086	my %meta;
		1087
		1088	$self->{meta_libdirs} = join "\x00", @libdirs;
		1089	$self->{meta} = \%meta;
		1090
		1091	my %ext;
		1092
		1093	# first gather extensions
		1094	for my $dir (reverse @libdirs) {
		1095	opendir my $fh, $dir
		1096	or next;
		1097	for my $ext (readdir $fh) {
		1098	$ext !~ /^\./
		1099	and open my $fh, "<", "$dir/$ext"
		1100	or next;
		1101
		1102	my %ext = (dir => $dir);
		1103
		1104	while (<$fh>) {
		1105	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1106	my ($pattern, $type, $desc) = split /:/, $1;
		1107	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1108	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1109	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1110	} else {
		1111	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1112	}
		1113	} elsif (/^#:META:BINDING:(.*)/) {
		1114	my ($keysym, $action) = split /:/, $1;
		1115	$ext{binding}{$keysym} = $action;
		1116	} elsif (/^\s*(?:#|$)/) {
		1117	# skip other comments and empty lines
		1118	} else {
		1119	last; # stop parsing on first non-empty non-comment line
		1120	}
		1121	}
		1122
		1123	$meta{$ext} = \%ext;
		1124	}
		1125	}
		1126
		1127	# and now merge resources and bindings
		1128	while (my ($k, $v) = each %ext) {
		1129	#TODO: should check for extensions overriding each other
		1130	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1131	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1132	}
		1133	}
		1134
854	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1135	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
855		1136
856	Creates a new terminal, very similar as if you had started it with system	1137	Creates a new terminal, very similar as if you had started it with system
857	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1138	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
858	hash which defines the environment of the new terminal.	1139	hash which defines the environment of the new terminal.
859		1140
860	Croaks (and probably outputs an error message) if the new instance	1141	Croaks (and probably outputs an error message) if the new instance
861	couldn't be created. Returns C<undef> if the new instance didn't	1142	couldn't be created. Returns C<undef> if the new instance didn't
862	initialise perl, and the terminal object otherwise. The C<init> and	1143	initialise perl, and the terminal object otherwise. The C<init> and
863	C<start> hooks will be called during this call.	1144	C<start> hooks will be called before this call returns, and are free to
		1145	refer to global data (which is race free).
864		1146
865	=cut	1147	=cut
866		1148
867	sub new {	1149	sub new {
868	my ($class, $env, @args) = @_;	1150	my ($class, $env, @args) = @_;
869		1151
		1152	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1153	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1154
870	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1155	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
871	}	1156	}
872		1157
873	=item $term->destroy	1158	=item $term->destroy
874		1159
875	Destroy the terminal object (close the window, free resources	1160	Destroy the terminal object (close the window, free resources
876	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1161	etc.). Please note that urxvt will not exit as long as any event
877	watchers (timers, io watchers) are still active.	1162	watchers (timers, io watchers) are still active.
		1163
		1164	=item $term->exec_async ($cmd[, @args])
		1165
		1166	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1167	("starts") programs in the background. This function takes care of setting
		1168	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1169	be preferred over explicit calls to C<exec> or C<system>.
		1170
		1171	Returns the pid of the subprocess or C<undef> on error.
		1172
		1173	=cut
		1174
		1175	sub exec_async {
		1176	my $self = shift;
		1177
		1178	my $pid = fork;
		1179
		1180	return $pid
		1181	if !defined $pid or $pid;
		1182
		1183	%ENV = %{ $self->env };
		1184
		1185	exec @_;
		1186	urxvt::_exit 255;
		1187	}
878		1188
879	=item $isset = $term->option ($optval[, $set])	1189	=item $isset = $term->option ($optval[, $set])
880		1190
881	Returns true if the option specified by C<$optval> is enabled, and	1191	Returns true if the option specified by C<$optval> is enabled, and
882	optionally change it. All option values are stored by name in the hash	1192	optionally change it. All option values are stored by name in the hash
883	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1193	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
884		1194
885	Here is a a likely non-exhaustive list of option names, please see the	1195	Here is a likely non-exhaustive list of option names, please see the
886	source file F</src/optinc.h> to see the actual list:	1196	source file F</src/optinc.h> to see the actual list:
887		1197
888	borderLess console cursorBlink cursorUnderline hold iconic insecure	1198	borderLess buffered console cursorBlink cursorUnderline hold iconic
889	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1199	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1200	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
890	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1201	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
891	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1202	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
892	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1203	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
893	tripleclickwords utmpInhibit visualBell	1204	urgentOnBell utmpInhibit visualBell
894		1205
895	=item $value = $term->resource ($name[, $newval])	1206	=item $value = $term->resource ($name[, $newval])
896		1207
897	Returns the current resource value associated with a given name and	1208	Returns the current resource value associated with a given name and
898	optionally sets a new value. Setting values is most useful in the C<init>	1209	optionally sets a new value. Setting values is most useful in the C<init>
…		…
907	likely change).	1218	likely change).
908		1219
909	Please note that resource strings will currently only be freed when the	1220	Please note that resource strings will currently only be freed when the
910	terminal is destroyed, so changing options frequently will eat memory.	1221	terminal is destroyed, so changing options frequently will eat memory.
911		1222
912	Here is a a likely non-exhaustive list of resource names, not all of which	1223	Here is a likely non-exhaustive list of resource names, not all of which
913	are supported in every build, please see the source file F</src/rsinc.h>	1224	are supported in every build, please see the source file F</src/rsinc.h>
914	to see the actual list:	1225	to see the actual list:
915		1226
916	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1227	answerbackstring backgroundPixmap backspace_key blurradius
917	borderLess color cursorBlink cursorUnderline cutchars delete_key	1228	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
918	display_name embed ext_bwidth fade font geometry hold iconName	1229	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
919	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1230	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1231	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
920	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1232	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
921	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1233	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
922	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1234	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
923	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1235	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
924	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1236	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
925	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1237	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
926	shade term_name title transparent transparent_all tripleclickwords	1238	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1239	term_name title transient_for transparent tripleclickwords urgentOnBell
927	utmpInhibit visualBell	1240	utmpInhibit visualBell
928		1241
929	=cut	1242	=cut
930		1243
931	sub resource($$;$) {	1244	sub resource($$;$) {
932	my ($self, $name) = (shift, shift);	1245	my ($self, $name) = (shift, shift);
933	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1246	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
934	&urxvt::term::_resource	1247	goto &urxvt::term::_resource
935	}	1248	}
936		1249
937	=item $value = $term->x_resource ($pattern)	1250	=item $value = $term->x_resource ($pattern)
938		1251
939	Returns the X-Resource for the given pattern, excluding the program or	1252	Returns the X-Resource for the given pattern, excluding the program or
940	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1253	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
941	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1254	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
942	resource with that pattern exists.	1255	resource with that pattern exists.
943		1256
		1257	Extensions that define extra resource or command line arguments also need
		1258	to call this method to access their values.
		1259
		1260	If the method is called on an extension object (basically, from an
		1261	extension), then the special prefix C<%.> will be replaced by the name of
		1262	the extension and a dot, and the lone string C<%> will be replaced by the
		1263	extension name itself. This makes it possible to code extensions so you
		1264	can rename them and get a new set of commandline switches and resources
		1265	without having to change the actual code.
		1266
944	This method should only be called during the C<on_start> hook, as there is	1267	This method should only be called during the C<on_start> hook, as there is
945	only one resource database per display, and later invocations might return	1268	only one resource database per display, and later invocations might return
946	the wrong resources.	1269	the wrong resources.
947		1270
948	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1271	=item $value = $term->x_resource_boolean ($pattern)
949		1272
		1273	Like C<x_resource>, above, but interprets the string value as a boolean
		1274	and returns C<1> for true values, C<0> for false values and C<undef> if
		1275	the resource or option isn't specified.
		1276
		1277	You should always use this method to parse boolean resources.
		1278
		1279	=cut
		1280
		1281	sub x_resource_boolean {
		1282	my $res = &x_resource;
		1283
		1284	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1285	}
		1286
		1287	=item $success = $term->bind_action ($key, $octets)
		1288
950	Adds a keymap translation exactly as specified via a resource. See the	1289	Adds a key binding exactly as specified via a C<keysym> resource. See the
951	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1290	C<keysym> resource in the urxvt(1) manpage.
952		1291
953	=item $rend = $term->rstyle ([$new_rstyle])	1292	=item $rend = $term->rstyle ([$new_rstyle])
954		1293
955	Return and optionally change the current rendition. Text that is output by	1294	Return and optionally change the current rendition. Text that is output by
956	the terminal application will use this style.	1295	the terminal application will use this style.
…		…
964		1303
965	=item ($row, $col) = $term->selection_beg ([$row, $col])	1304	=item ($row, $col) = $term->selection_beg ([$row, $col])
966		1305
967	=item ($row, $col) = $term->selection_end ([$row, $col])	1306	=item ($row, $col) = $term->selection_end ([$row, $col])
968		1307
969	Return the current values of the selection mark, begin or end positions,	1308	Return the current values of the selection mark, begin or end positions.
970	and optionally set them to new values.	1309
		1310	When arguments are given, then the selection coordinates are set to
		1311	C<$row> and C<$col>, and the selection screen is set to the current
		1312	screen.
		1313
		1314	=item $screen = $term->selection_screen ([$screen])
		1315
		1316	Returns the current selection screen, and then optionally sets it.
971		1317
972	=item $term->selection_make ($eventtime[, $rectangular])	1318	=item $term->selection_make ($eventtime[, $rectangular])
973		1319
974	Tries to make a selection as set by C<selection_beg> and	1320	Tries to make a selection as set by C<selection_beg> and
975	C<selection_end>. If C<$rectangular> is true (default: false), a	1321	C<selection_end>. If C<$rectangular> is true (default: false), a
976	rectangular selection will be made. This is the prefered function to make	1322	rectangular selection will be made. This is the preferred function to make
977	a selection.	1323	a selection.
978		1324
979	=item $success = $term->selection_grab ($eventtime)	1325	=item $success = $term->selection_grab ($eventtime[, $clipboard])
980		1326
981	Try to request the primary selection text from the server (for example, as	1327	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1328	true) selection from the server. The corresponding text can be set
982	set by the next method). No visual feedback will be given. This function	1329	with the next method. No visual feedback will be given. This function
983	is mostly useful from within C<on_sel_grab> hooks.	1330	is mostly useful from within C<on_sel_grab> hooks.
984		1331
985	=item $oldtext = $term->selection ([$newtext])	1332	=item $oldtext = $term->selection ([$newtext, $clipboard])
986		1333
987	Return the current selection text and optionally replace it by C<$newtext>.	1334	Return the current selection (clipboard if C<$clipboard> is true) text
		1335	and optionally replace it by C<$newtext>.
		1336
		1337	=item $term->selection_clear ([$clipboard])
		1338
		1339	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
988		1340
989	=item $term->overlay_simple ($x, $y, $text)	1341	=item $term->overlay_simple ($x, $y, $text)
990		1342
991	Create a simple multi-line overlay box. See the next method for details.	1343	Create a simple multi-line overlay box. See the next method for details.
992		1344
…		…
1022		1374
1023	The methods currently supported on C<urxvt::overlay> objects are:	1375	The methods currently supported on C<urxvt::overlay> objects are:
1024		1376
1025	=over 4	1377	=over 4
1026		1378
1027	=item $overlay->set ($x, $y, $text, $rend)	1379	=item $overlay->set ($x, $y, $text[, $rend])
1028		1380
1029	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1381	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1030	text in rxvt-unicode's special encoding and an array of rendition values	1382	text in rxvt-unicode's special encoding and an array of rendition values
1031	at a specific position inside the overlay.	1383	at a specific position inside the overlay.
		1384
		1385	If C<$rend> is missing, then the rendition will not be changed.
1032		1386
1033	=item $overlay->hide	1387	=item $overlay->hide
1034		1388
1035	If visible, hide the overlay, but do not destroy it.	1389	If visible, hide the overlay, but do not destroy it.
1036		1390
…		…
1106		1460
1107	Normally its not a good idea to use this function, as programs might be	1461	Normally its not a good idea to use this function, as programs might be
1108	confused by changes in cursor position or scrolling. Its useful inside a	1462	confused by changes in cursor position or scrolling. Its useful inside a
1109	C<on_add_lines> hook, though.	1463	C<on_add_lines> hook, though.
1110		1464
		1465	=item $term->scr_change_screen ($screen)
		1466
		1467	Switch to given screen - 0 primary, 1 secondary.
		1468
1111	=item $term->cmd_parse ($octets)	1469	=item $term->cmd_parse ($octets)
1112		1470
1113	Similar to C<scr_add_lines>, but the argument must be in the	1471	Similar to C<scr_add_lines>, but the argument must be in the
1114	locale-specific encoding of the terminal and can contain command sequences	1472	locale-specific encoding of the terminal and can contain command sequences
1115	(escape codes) that will be interpreted.	1473	(escape codes) that will be interpreted.
1116		1474
1117	=item $term->tt_write ($octets)	1475	=item $term->tt_write ($octets)
1118		1476
1119	Write the octets given in C<$data> to the tty (i.e. as program input). To	1477	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1120	pass characters instead of octets, you should convert your strings first	1478	pass characters instead of octets, you should convert your strings first
1121	to the locale-specific encoding using C<< $term->locale_encode >>.	1479	to the locale-specific encoding using C<< $term->locale_encode >>.
		1480
		1481	=item $term->tt_write_user_input ($octets)
		1482
		1483	Like C<tt_write>, but should be used when writing strings in response to
		1484	the user pressing a key, to invokes the additional actions requested by
		1485	the user for that case (C<tt_write> doesn't do that).
		1486
		1487	The typical use case would be inside C<on_action> hooks.
		1488
		1489	=item $term->tt_paste ($octets)
		1490
		1491	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1492	CR and bracketing the data with control sequences if bracketed paste mode
		1493	is set.
1122		1494
1123	=item $old_events = $term->pty_ev_events ([$new_events])	1495	=item $old_events = $term->pty_ev_events ([$new_events])
1124		1496
1125	Replaces the event mask of the pty watcher by the given event mask. Can	1497	Replaces the event mask of the pty watcher by the given event mask. Can
1126	be used to suppress input and output handling to the pty/tty. See the	1498	be used to suppress input and output handling to the pty/tty. See the
1127	description of C<< urxvt::timer->events >>. Make sure to always restore	1499	description of C<< urxvt::timer->events >>. Make sure to always restore
1128	the previous value.	1500	the previous value.
1129		1501
		1502	=item $fd = $term->pty_fd
		1503
		1504	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1505	is used.
		1506
1130	=item $windowid = $term->parent	1507	=item $windowid = $term->parent
1131		1508
1132	Return the window id of the toplevel window.	1509	Return the window id of the toplevel window.
1133		1510
1134	=item $windowid = $term->vt	1511	=item $windowid = $term->vt
1135		1512
1136	Return the window id of the terminal window.	1513	Return the window id of the terminal window.
1137		1514
		1515	=item $term->vt_emask_add ($x_event_mask)
		1516
		1517	Adds the specified events to the vt event mask. Useful e.g. when you want
		1518	to receive pointer events all the times:
		1519
		1520	$term->vt_emask_add (urxvt::PointerMotionMask);
		1521
		1522	=item $term->set_urgency ($set)
		1523
		1524	Enable/disable the urgency hint on the toplevel window.
		1525
		1526	=item $term->focus_in
		1527
		1528	=item $term->focus_out
		1529
		1530	=item $term->key_press ($state, $keycode[, $time])
		1531
		1532	=item $term->key_release ($state, $keycode[, $time])
		1533
		1534	Deliver various fake events to to terminal.
		1535
1138	=item $window_width = $term->width	1536	=item $window_width = $term->width
1139		1537
1140	=item $window_height = $term->height	1538	=item $window_height = $term->height
1141		1539
1142	=item $font_width = $term->fwidth	1540	=item $font_width = $term->fwidth
…		…
1155		1553
1156	=item $max_scrollback = $term->saveLines	1554	=item $max_scrollback = $term->saveLines
1157		1555
1158	=item $nrow_plus_saveLines = $term->total_rows	1556	=item $nrow_plus_saveLines = $term->total_rows
1159		1557
1160	=item $lines_in_scrollback = $term->nsaved	1558	=item $topmost_scrollback_row = $term->top_row
1161		1559
1162	Return various integers describing terminal characteristics.	1560	Return various integers describing terminal characteristics.
1163		1561
1164	=item $x_display = $term->display_id	1562	=item $x_display = $term->display_id
1165		1563
…		…
1172	=item $env = $term->env	1570	=item $env = $term->env
1173		1571
1174	Returns a copy of the environment in effect for the terminal as a hashref	1572	Returns a copy of the environment in effect for the terminal as a hashref
1175	similar to C<\%ENV>.	1573	similar to C<\%ENV>.
1176		1574
		1575	=item @envv = $term->envv
		1576
		1577	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1578
		1579	=item @argv = $term->argv
		1580
		1581	Return the argument vector as this terminal, similar to @ARGV, but
		1582	includes the program name as first element.
		1583
1177	=cut	1584	=cut
1178		1585
1179	sub env {	1586	sub env {
1180	if (my $env = $_[0]->_env) {
1181	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1587	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1182	} else {
1183	+{ %ENV }
1184	}
1185	}	1588	}
1186		1589
1187	=item $modifiermask = $term->ModLevel3Mask	1590	=item $modifiermask = $term->ModLevel3Mask
1188		1591
1189	=item $modifiermask = $term->ModMetaMask	1592	=item $modifiermask = $term->ModMetaMask
…		…
1191	=item $modifiermask = $term->ModNumLockMask	1594	=item $modifiermask = $term->ModNumLockMask
1192		1595
1193	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1596	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1597	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1195		1598
		1599	=item $screen = $term->current_screen
		1600
		1601	Returns the currently displayed screen (0 primary, 1 secondary).
		1602
		1603	=item $cursor_is_hidden = $term->hidden_cursor
		1604
		1605	Returns whether the cursor is currently hidden or not.
		1606
1196	=item $view_start = $term->view_start ([$newvalue])	1607	=item $view_start = $term->view_start ([$newvalue])
1197		1608
1198	Returns the negative row number of the topmost line. Minimum value is	1609	Returns the row number of the topmost displayed line. Maximum value is
1199	C<0>, which displays the normal terminal contents. Larger values scroll	1610	C<0>, which displays the normal terminal contents. Lower values scroll
1200	this many lines into the scrollback buffer.	1611	this many lines into the scrollback buffer.
1201		1612
1202	=item $term->want_refresh	1613	=item $term->want_refresh
1203		1614
1204	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1615	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1207		1618
1208	Used after changing terminal contents to display them.	1619	Used after changing terminal contents to display them.
1209		1620
1210	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1621	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1211		1622
1212	Returns the text of the entire row with number C<$row_number>. Row C<0>	1623	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1213	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1624	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1214	terminal line. The scrollback buffer starts at line C<-1> and extends to
1215	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1625	terminal line. Nothing will be returned if a nonexistent line
1216	is requested.	1626	is requested.
1217		1627
1218	If C<$new_text> is specified, it will replace characters in the current	1628	If C<$new_text> is specified, it will replace characters in the current
1219	line, starting at column C<$start_col> (default C<0>), which is useful	1629	line, starting at column C<$start_col> (default C<0>), which is useful
1220	to replace only parts of a line. The font index in the rendition will	1630	to replace only parts of a line. The font index in the rendition will
1221	automatically be updated.	1631	automatically be updated.
1222		1632
1223	C<$text> is in a special encoding: tabs and wide characters that use more	1633	C<$text> is in a special encoding: tabs and wide characters that use more
1224	than one cell when displayed are padded with urxvt::NOCHAR characters	1634	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1225	(C<chr 65535>). Characters with combining characters and other characters	1635	characters. Characters with combining characters and other characters that
1226	that do not fit into the normal tetx encoding will be replaced with	1636	do not fit into the normal text encoding will be replaced with characters
1227	characters in the private use area.	1637	in the private use area.
1228		1638
1229	You have to obey this encoding when changing text. The advantage is	1639	You have to obey this encoding when changing text. The advantage is
1230	that C<substr> and similar functions work on screen cells and not on	1640	that C<substr> and similar functions work on screen cells and not on
1231	characters.	1641	characters.
1232		1642
…		…
1316	}	1726	}
1317		1727
1318	sub urxvt::line::t {	1728	sub urxvt::line::t {
1319	my ($self) = @_;	1729	my ($self) = @_;
1320		1730
1321	if (@_ > 1)	1731	if (@_ > 1) {
1322	{
1323	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1732	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1324	for $self->{beg} .. $self->{end};	1733	for $self->{beg} .. $self->{end};
1325	}	1734	}
1326		1735
1327	defined wantarray &&	1736	defined wantarray &&
1328	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1737	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1329	0, $self->{len}	1738	0, $self->{len}
1330	}	1739	}
1331		1740
1332	sub urxvt::line::r {	1741	sub urxvt::line::r {
1333	my ($self) = @_;	1742	my ($self) = @_;
1334		1743
1335	if (@_ > 1)	1744	if (@_ > 1) {
1336	{
1337	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1745	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1338	for $self->{beg} .. $self->{end};	1746	for $self->{beg} .. $self->{end};
1339	}	1747	}
1340		1748
1341	if (defined wantarray) {	1749	if (defined wantarray) {
1342	my $rend = [	1750	my $rend = [
1343	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1751	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1344	];	1752	];
…		…
1376	where one character corresponds to one screen cell. See	1784	where one character corresponds to one screen cell. See
1377	C<< $term->ROW_t >> for details.	1785	C<< $term->ROW_t >> for details.
1378		1786
1379	=item $string = $term->special_decode $text	1787	=item $string = $term->special_decode $text
1380		1788
1381	Converts rxvt-unicodes text reprsentation into a perl string. See	1789	Converts rxvt-unicodes text representation into a perl string. See
1382	C<< $term->ROW_t >> for details.	1790	C<< $term->ROW_t >> for details.
1383		1791
1384	=item $success = $term->grab_button ($button, $modifiermask)	1792	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1385		1793
		1794	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1795
1386	Registers a synchronous button grab. See the XGrabButton manpage.	1796	Register/unregister a synchronous button grab. See the XGrabButton
		1797	manpage.
1387		1798
1388	=item $success = $term->grab ($eventtime[, $sync])	1799	=item $success = $term->grab ($eventtime[, $sync])
1389		1800
1390	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1801	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1391	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1802	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1392		1803
1393	=item $term->allow_events_async	1804	=item $term->allow_events_async
1394		1805
1395	Calls XAllowEvents with AsyncBoth for the most recent grab.	1806	Calls XAllowEvents with AsyncBoth for the most recent grab.
1396		1807
…		…
1403	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1814	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1404	recent grab.	1815	recent grab.
1405		1816
1406	=item $term->ungrab	1817	=item $term->ungrab
1407		1818
1408	Calls XUngrab for the most recent grab. Is called automatically on	1819	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1409	evaluation errors, as it is better to lose the grab in the error case as	1820	evaluation errors, as it is better to lose the grab in the error case as
1410	the session.	1821	the session.
		1822
		1823	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1824
		1825	=item $atom_name = $term->XGetAtomName ($atom)
		1826
		1827	=item @atoms = $term->XListProperties ($window)
		1828
		1829	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1830
		1831	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1832
		1833	=item $term->XDeleteProperty ($window, $property)
		1834
		1835	=item $window = $term->DefaultRootWindow
		1836
		1837	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1838
		1839	=item $term->XMapWindow ($window)
		1840
		1841	=item $term->XUnmapWindow ($window)
		1842
		1843	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1844
		1845	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1846
		1847	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1848
		1849	=item $keysym = $term->XStringToKeysym ($string)
		1850
		1851	=item $string = $term->XKeysymToString ($keysym)
		1852
		1853	Various X or X-related functions. The C<$term> object only serves as
		1854	the source of the display, otherwise those functions map more-or-less
		1855	directly onto the X functions of the same name.
1411		1856
1412	=back	1857	=back
1413		1858
1414	=cut	1859	=cut
1415		1860
…		…
1479	my ($self, $text, $cb) = @_;	1924	my ($self, $text, $cb) = @_;
1480		1925
1481	$self->add_item ({ type => "button", text => $text, activate => $cb});	1926	$self->add_item ({ type => "button", text => $text, activate => $cb});
1482	}	1927	}
1483		1928
1484	=item $popup->add_toggle ($text, $cb, $initial_value)	1929	=item $popup->add_toggle ($text, $initial_value, $cb)
1485		1930
1486	Adds a toggle/checkbox item to the popup. Teh callback gets called	1931	Adds a toggle/checkbox item to the popup. The callback gets called
1487	whenever it gets toggled, with a boolean indicating its value as its first	1932	whenever it gets toggled, with a boolean indicating its new value as its
1488	argument.	1933	first argument.
1489		1934
1490	=cut	1935	=cut
1491		1936
1492	sub add_toggle {	1937	sub add_toggle {
1493	my ($self, $text, $cb, $value) = @_;	1938	my ($self, $text, $value, $cb) = @_;
1494		1939
1495	my $item; $item = {	1940	my $item; $item = {
1496	type => "button",	1941	type => "button",
1497	text => " $text",	1942	text => " $text",
1498	value => $value,	1943	value => $value,
…		…
1517	my $env = $self->{term}->env;	1962	my $env = $self->{term}->env;
1518	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1963	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1519	delete $env->{LC_ALL};	1964	delete $env->{LC_ALL};
1520	$env->{LC_CTYPE} = $self->{term}->locale;	1965	$env->{LC_CTYPE} = $self->{term}->locale;
1521		1966
1522	urxvt::term->new ($env, $self->{term}->resource ("name"),	1967	my $term = urxvt::term->new (
1523	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1968	$env, "popup",
		1969	"--perl-lib" => "", "--perl-ext-common" => "",
		1970	"-pty-fd" => -1, "-sl" => 0,
		1971	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1524	"--transient-for" => $self->{term}->parent,	1972	"--transient-for" => $self->{term}->parent,
1525	"-display" => $self->{term}->display_id,	1973	"-display" => $self->{term}->display_id,
1526	"-pe" => "urxvt-popup")	1974	"-pe" => "urxvt-popup",
1527	or die "unable to create popup window\n";	1975	) or die "unable to create popup window\n";
		1976
		1977	unless (delete $term->{urxvt_popup_init_done}) {
		1978	$term->ungrab;
		1979	$term->destroy;
		1980	die "unable to initialise popup window\n";
		1981	}
1528	}	1982	}
1529		1983
1530	sub DESTROY {	1984	sub DESTROY {
1531	my ($self) = @_;	1985	my ($self) = @_;
1532		1986
1533	delete $self->{term}{_destroy}{$self};	1987	delete $self->{term}{_destroy}{$self};
1534	$self->{term}->ungrab;	1988	$self->{term}->ungrab;
1535	}	1989	}
1536		1990
1537	=back	1991	=back
		1992
		1993	=cut
		1994
		1995	package urxvt::watcher;
1538		1996
1539	=head2 The C<urxvt::timer> Class	1997	=head2 The C<urxvt::timer> Class
1540		1998
1541	This class implements timer watchers/events. Time is represented as a	1999	This class implements timer watchers/events. Time is represented as a
1542	fractional number of seconds since the epoch. Example:	2000	fractional number of seconds since the epoch. Example:
…		…
1546	->new	2004	->new
1547	->interval (1)	2005	->interval (1)
1548	->cb (sub {	2006	->cb (sub {
1549	$term->{overlay}->set (0, 0,	2007	$term->{overlay}->set (0, 0,
1550	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2008	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1551	});	2009	});
1552		2010
1553	=over 4	2011	=over 4
1554		2012
1555	=item $timer = new urxvt::timer	2013	=item $timer = new urxvt::timer
1556		2014
…		…
1559		2017
1560	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2018	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1561		2019
1562	Set the callback to be called when the timer triggers.	2020	Set the callback to be called when the timer triggers.
1563		2021
1564	=item $tstamp = $timer->at
1565
1566	Return the time this watcher will fire next.
1567
1568	=item $timer = $timer->set ($tstamp)	2022	=item $timer = $timer->set ($tstamp[, $interval])
1569		2023
1570	Set the time the event is generated to $tstamp.	2024	Set the time the event is generated to $tstamp (and optionally specifies a
		2025	new $interval).
1571		2026
1572	=item $timer = $timer->interval ($interval)	2027	=item $timer = $timer->interval ($interval)
1573		2028
1574	Normally (and when C<$interval> is C<0>), the timer will automatically	2029	By default (and when C<$interval> is C<0>), the timer will automatically
1575	stop after it has fired once. If C<$interval> is non-zero, then the timer	2030	stop after it has fired once. If C<$interval> is non-zero, then the timer
1576	is automatically rescheduled at the given intervals.	2031	is automatically rescheduled at the given intervals.
1577		2032
1578	=item $timer = $timer->start	2033	=item $timer = $timer->start
1579		2034
1580	Start the timer.	2035	Start the timer.
1581		2036
1582	=item $timer = $timer->start ($tstamp)	2037	=item $timer = $timer->start ($tstamp[, $interval])
1583		2038
1584	Set the event trigger time to C<$tstamp> and start the timer.	2039	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2040	also replaces the interval.
		2041
		2042	=item $timer = $timer->after ($delay[, $interval])
		2043
		2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1585		2045
1586	=item $timer = $timer->stop	2046	=item $timer = $timer->stop
1587		2047
1588	Stop the timer.	2048	Stop the timer.
1589		2049
…		…
1595		2055
1596	$term->{socket} = ...	2056	$term->{socket} = ...
1597	$term->{iow} = urxvt::iow	2057	$term->{iow} = urxvt::iow
1598	->new	2058	->new
1599	->fd (fileno $term->{socket})	2059	->fd (fileno $term->{socket})
1600	->events (urxvt::EVENT_READ)	2060	->events (urxvt::EV_READ)
1601	->start	2061	->start
1602	->cb (sub {	2062	->cb (sub {
1603	my ($iow, $revents) = @_;	2063	my ($iow, $revents) = @_;
1604	# $revents must be 1 here, no need to check	2064	# $revents must be 1 here, no need to check
1605	sysread $term->{socket}, my $buf, 8192	2065	sysread $term->{socket}, my $buf, 8192
…		…
1618	Set the callback to be called when io events are triggered. C<$reventmask>	2078	Set the callback to be called when io events are triggered. C<$reventmask>
1619	is a bitset as described in the C<events> method.	2079	is a bitset as described in the C<events> method.
1620		2080
1621	=item $iow = $iow->fd ($fd)	2081	=item $iow = $iow->fd ($fd)
1622		2082
1623	Set the filedescriptor (not handle) to watch.	2083	Set the file descriptor (not handle) to watch.
1624		2084
1625	=item $iow = $iow->events ($eventmask)	2085	=item $iow = $iow->events ($eventmask)
1626		2086
1627	Set the event mask to watch. The only allowed values are	2087	Set the event mask to watch. The only allowed values are
1628	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2088	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1629	together, or C<urxvt::EVENT_NONE>.	2089	together, or C<urxvt::EV_NONE>.
1630		2090
1631	=item $iow = $iow->start	2091	=item $iow = $iow->start
1632		2092
1633	Start watching for requested events on the given handle.	2093	Start watching for requested events on the given handle.
1634		2094
1635	=item $iow = $iow->stop	2095	=item $iow = $iow->stop
1636		2096
1637	Stop watching for events on the given filehandle.	2097	Stop watching for events on the given file handle.
		2098
		2099	=back
		2100
		2101	=head2 The C<urxvt::iw> Class
		2102
		2103	This class implements idle watchers, that get called automatically when
		2104	the process is idle. They should return as fast as possible, after doing
		2105	some useful work.
		2106
		2107	=over 4
		2108
		2109	=item $iw = new urxvt::iw
		2110
		2111	Create a new idle watcher object in stopped state.
		2112
		2113	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2114
		2115	Set the callback to be called when the watcher triggers.
		2116
		2117	=item $timer = $timer->start
		2118
		2119	Start the watcher.
		2120
		2121	=item $timer = $timer->stop
		2122
		2123	Stop the watcher.
		2124
		2125	=back
		2126
		2127	=head2 The C<urxvt::pw> Class
		2128
		2129	This class implements process watchers. They create an event whenever a
		2130	process exits, after which they stop automatically.
		2131
		2132	my $pid = fork;
		2133	...
		2134	$term->{pw} = urxvt::pw
		2135	->new
		2136	->start ($pid)
		2137	->cb (sub {
		2138	my ($pw, $exit_status) = @_;
		2139	...
		2140	});
		2141
		2142	=over 4
		2143
		2144	=item $pw = new urxvt::pw
		2145
		2146	Create a new process watcher in stopped state.
		2147
		2148	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2149
		2150	Set the callback to be called when the timer triggers.
		2151
		2152	=item $pw = $timer->start ($pid)
		2153
		2154	Tells the watcher to start watching for process C<$pid>.
		2155
		2156	=item $pw = $pw->stop
		2157
		2158	Stop the watcher.
1638		2159
1639	=back	2160	=back
1640		2161
1641	=head1 ENVIRONMENT	2162	=head1 ENVIRONMENT
1642		2163
…		…
1651		2172
1652	=item >= 3 - script loading and management	2173	=item >= 3 - script loading and management
1653		2174
1654	=item >=10 - all called hooks	2175	=item >=10 - all called hooks
1655		2176
1656	=item >=11 - hook reutrn values	2177	=item >=11 - hook return values
1657		2178
1658	=back	2179	=back
1659		2180
1660	=head1 AUTHOR	2181	=head1 AUTHOR
1661		2182
1662	Marc Lehmann <pcg@goof.com>	2183	Marc Lehmann <schmorp@schmorp.de>
1663	http://software.schmorp.de/pkg/rxvt-unicode	2184	http://software.schmorp.de/pkg/rxvt-unicode
1664		2185
1665	=cut	2186	=cut
1666		2187
1667	1	2188	1
		2189
		2190	# vim: sw=3:

Diff Legend

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