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.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.237 by root, Sun May 18 18:09:52 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	It also offers the following bindable keyboard command:
54
55	=over 4
56
57	=item rot13
58
59	Rot-13 the selection when activated. Used via keyboard trigger:
60
61	URxvt.keysym.C-M-r: perl:selection:rot13
62
63	=back
64
65	=item option-popup (enabled by default)
66
67	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
68	runtime.
69
70	=item selection-popup (enabled by default)
71
72	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
73	text into various other formats/action (such as uri unescaping, perl
74	evalution, web-browser starting etc.), depending on content.
75
76	=item searchable-scrollback<hotkey> (enabled by default)
77
78	Adds regex search functionality to the scrollback buffer, triggered
79	by a hotkey (default: C<M-s>). While in search mode, normal terminal
80	input/output is suspended and a regex is displayed at the bottom of the
81	screen.
82
83	Inputting characters appends them to the regex and continues incremental
84	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
85	search upwards/downwards in the scrollback buffer, C<End> jumps to the
86	bottom. C<Escape> leaves search mode and returns to the point where search
87	was started, while C<Enter> or C<Return> stay at the current position and
88	additionally stores the first match in the current line into the primary
89	selection.
90
91	=item digital-clock
92
93	Displays a digital clock using the built-in overlay.
94
95	=item mark-urls
96
97	Uses per-line display filtering (C<on_line_update>) to underline urls and
98	make them clickable. When middle-clicked, the program specified in the
99	resource C<urlLauncher> (default C<x-www-browser>) will be started with
100	the URL as first argument.
101
102	=item block-graphics-to-ascii
103
104	A not very useful example of filtering all text output to the terminal,
105	by replacing all line-drawing characters (U+2500 .. U+259F) by a
106	similar-looking ascii character.
107
108	=item example-refresh-hooks
109
110	Displays a very simple digital clock in the upper right corner of the
111	window. Illustrates overwriting the refresh callbacks to create your own
112	overlays or changes.
113
114	=back
115		50
116	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
117		52
118	=head2 General API Considerations	53	=head2 General API Considerations
119		54
…		…
133		68
134	=over 4	69	=over 4
135		70
136	=item $text	71	=item $text
137		72
138	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
139	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.
140		75
141	=item $string	76	=item $string
142		77
143	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
…		…
147	=item $octets	82	=item $octets
148		83
149	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
150	locale-specific way.	85	locale-specific way.
151		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
152	=back	93	=back
153		94
154	=head2 Extension Objects	95	=head2 Extension Objects
155		96
156	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
157	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,
158	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
159	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
160	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
161	use.	103	internal use.
162		104
163	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
164	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
165		107
166	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
167		109	the C<urxvt::extension> section below.
168	=over 4
169
170	=item $urxvt_term = $self->{term}
171
172	Returns the C<urxvt::term> object associated with this instance of the
173	extension. This member I<must not> be changed in any way.
174
175	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
176
177	Dynamically enable the given hooks (named without the C<on_> prefix) for
178	this extension, replacing any previous hook. This is useful when you want
179	to overwrite time-critical hooks only temporarily.
180
181	=item $self->disable ($hook_name[, $hook_name..])
182
183	Dynamically disable the given hooks.
184
185	=back
186		110
187	=head2 Hooks	111	=head2 Hooks
188		112
189	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
190	called whenever the relevant event happens.	114	called whenever the relevant event happens.
191		115
192	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
193	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
194		118
195	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
196	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
197	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.
198		122
199	I<< When in doubt, return a false value (preferably C<()>). >>	123	I<< When in doubt, return a false value (preferably C<()>). >>
200		124
201	=over 4	125	=over 4
202		126
203	=item on_init $term	127	=item on_init $term
204		128
205	Called after a new terminal object has been initialized, but before	129	Called after a new terminal object has been initialized, but before
206	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
207	call or deliver senseless data, as terminal size and other characteristics	131	call or deliver senseless data, as terminal size and other characteristics
208	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
209	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).
210		145
211	=item on_reset $term	146	=item on_reset $term
212		147
213	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
214	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
215	variables.	150	variables.
216		151
217	=item on_start $term	152	=item on_child_start $term, $pid
218		153
219	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.
220	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>.
221		160
222	=item on_sel_make $term, $eventtime	161	=item on_sel_make $term, $eventtime
223		162
224	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
225	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
…		…
232		171
233	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
234	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
235	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
236		175
237	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.
238		177
239	=item on_sel_extend $term	178	=item on_sel_extend $term
240		179
241	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
242	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
243	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
244	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
245	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
246	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
247		186
248	See the F<selection> example extension.	187	See the F<selection> example extension.
249		188
250	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
251		190
252	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
253	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
254	show this many lines of scrollback.	193	show this many lines of scrollback.
255		194
256	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
257		196
…		…
261		200
262	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,
263	$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
264	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
265		204
266	=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
267		216
268	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
269	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
270	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
271	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,
272	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
273	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	}
274		233
275	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,
276	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
277	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.
278		240
279	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
280		242
281	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
282	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
…		…
287	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
288		250
289	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
290	suppress or filter tty input.	252	suppress or filter tty input.
291		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
292	=item on_line_update $term, $row	261	=item on_line_update $term, $row
293		262
294	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
295	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
296	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,
…		…
303	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
304	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
305		274
306	=item on_refresh_begin $term	275	=item on_refresh_begin $term
307		276
308	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
309	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
310	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
311	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
312		281
313	=item on_refresh_end $term	282	=item on_refresh_end $term
314		283
315	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>.
316		285
317	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
318		287
319	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
320	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>
321	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
		291
		292	The event is simply the action string. This interface is going away in
		293	preference to the C<on_action> hook.
		294
		295	=item on_resize_all_windows $term, $new_width, $new_height
		296
		297	Called just after the new window size has been calculated, but before
		298	windows are actually being resized or hints are being set. If this hook
		299	returns a true value, setting of the window hints is being skipped.
		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.
322		310
323	=item on_focus_in $term	311	=item on_focus_in $term
324		312
325	Called whenever the window gets the keyboard focus, before rxvt-unicode	313	Called whenever the window gets the keyboard focus, before rxvt-unicode
326	does focus in processing.	314	does focus in processing.
327		315
328	=item on_focus_out $term	316	=item on_focus_out $term
329		317
330	Called wheneever the window loses keyboard focus, before rxvt-unicode does	318	Called whenever the window loses keyboard focus, before rxvt-unicode does
331	focus out processing.	319	focus out processing.
332		320
		321	=item on_configure_notify $term, $event
		322
		323	=item on_property_notify $term, $event
		324
333	=item on_key_press $term, $event, $keysym, $octets	325	=item on_key_press $term, $event, $keysym, $octets
334		326
335	=item on_key_release $term, $event, $keysym	327	=item on_key_release $term, $event, $keysym
336		328
337	=item on_button_press $term, $event	329	=item on_button_press $term, $event
…		…
342		334
343	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
344		336
345	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
346		338
347	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
348	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.
349		341
350	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
351	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
352	and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
353		345
354	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
355	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
356		348
357	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.
358		361
359	=back	362	=back
360		363
361	=cut	364	=cut
362		365
363	package urxvt;	366	package urxvt;
364		367
365	use utf8;	368	use utf8;
366	use strict;	369	use strict 'vars';
367	use Carp ();	370	use Carp ();
368	use Scalar::Util ();	371	use Scalar::Util ();
369	use List::Util ();	372	use List::Util ();
370		373
371	our $VERSION = 1;	374	our $VERSION = 1;
372	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.
373	our @HOOKNAME;	378	our @HOOKNAME;
374	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
375	our %OPTION;	380	our %OPTION;
376		381
377	our $LIBDIR;	382	our $LIBDIR;
378	our $RESNAME;	383	our $RESNAME;
379	our $RESCLASS;	384	our $RESCLASS;
380	our $RXVTNAME;	385	our $RXVTNAME;
381		386
		387	our $NOCHAR = chr 0xffff;
		388
382	=head2 Variables in the C<urxvt> Package	389	=head2 Variables in the C<urxvt> Package
383		390
384	=over 4	391	=over 4
385		392
386	=item $urxvt::LIBDIR	393	=item $urxvt::LIBDIR
…		…
399	=item $urxvt::TERM	406	=item $urxvt::TERM
400		407
401	The current terminal. This variable stores the current C<urxvt::term>	408	The current terminal. This variable stores the current C<urxvt::term>
402	object, whenever a callback/hook is executing.	409	object, whenever a callback/hook is executing.
403		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
404	=back	427	=back
405		428
406	=head2 Functions in the C<urxvt> Package	429	=head2 Functions in the C<urxvt> Package
407		430
408	=over 4	431	=over 4
409		432
410	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
411		434
412	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
413	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
414	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
415		439
416	=item urxvt::warn $string	440	=item urxvt::warn $string
417		441
418	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
419	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
420	that calls this function.	444	that calls this function.
421		445
422	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
423	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
424		448
425	Messages have a size limit of 1023 bytes currently.	449	Messages have a size limit of 1023 bytes currently.
426		450
427	=item $is_safe = urxvt::safe	451	=item @terms = urxvt::termlist
428		452
429	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
430	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
431	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).
432		457
433	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
434		459
435	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
436		461
437	=item urxvt::CurrentTime	462	=item urxvt::CurrentTime
438		463
439	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	464	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	465	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441	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
442		483
443	Various constants for use in X calls and event processing.	484	Various constants for use in X calls and event processing.
444		485
445	=back	486	=back
446		487
…		…
463		504
464	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
465		506
466	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
467		508
468	=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
469		511
470	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
471	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
472	the bitset.	514	the bitset.
473		515
…		…
479		521
480	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	522	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
481		523
482	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	524	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
483		525
		526	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		527
484	Replace the foreground/background colour in the rendition mask with the	528	Replace the foreground/background colour in the rendition mask with the
485	specified one.	529	specified one.
486		530
487	=item $value = urxvt::GET_CUSTOM $rend	531	=item $value = urxvt::GET_CUSTOM $rend
488		532
…		…
497	=back	541	=back
498		542
499	=cut	543	=cut
500		544
501	BEGIN {	545	BEGIN {
502	urxvt->bootstrap;
503
504	# overwrite perl's warn	546	# overwrite perl's warn
505	*CORE::GLOBAL::warn = sub {	547	*CORE::GLOBAL::warn = sub {
506	my $msg = join "", @_;	548	my $msg = join "", @_;
507	$msg .= "\n"	549	$msg .= "\n"
508	unless $msg =~ /\n$/;	550	unless $msg =~ /\n$/;
509	urxvt::warn ($msg);	551	urxvt::warn ($msg);
510	};	552	};
511
512	# %ENV is the original startup environment
513	delete $ENV{IFS};
514	delete $ENV{CDPATH};
515	delete $ENV{BASH_ENV};
516	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
517	}	553	}
518		554
519	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
520	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521		618
522	sub verbose {	619	sub verbose {
523	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
524	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
525	}	622	}
526		623
527	my $extension_pkg = "extension0000";
528	my %extension_pkg;	624	my %extension_pkg;
529		625
530	# load a single script into its own package, once only	626	# load a single script into its own package, once only
531	sub extension_package($) {	627	sub extension_package($) {
532	my ($path) = @_;	628	my ($path) = @_;
533		629
534	$extension_pkg{$path} ||= do {	630	$extension_pkg{$path} ||= do {
535	my $pkg = "urxvt::" . ($extension_pkg++);	631	$path =~ /([^\/\\]+)$/;
		632	my $pkg = $1;
		633	$pkg =~ s/[^[:word:]]/_/g;
		634	$pkg = "urxvt::ext::$pkg";
536		635
537	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
538		639
539	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
540	or die "$path: $!";	641	or die "$path: $!";
541		642
542	my $source = untaint	643	my $source =
543	"package $pkg; use strict; use utf8;\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
544	. "use base urxvt::term::extension::;\n"
545	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
546	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
547	. "\n};\n1";	647	. "\n};\n1";
548		648
549	eval $source	649	eval $source
…		…
558	# called by the rxvt core	658	# called by the rxvt core
559	sub invoke {	659	sub invoke {
560	local $TERM = shift;	660	local $TERM = shift;
561	my $htype = shift;	661	my $htype = shift;
562		662
563	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
564	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
565		665
		666	$TERM->scan_extensions;
		667
566	my %ext_arg;	668	my %ext_arg;
567		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} },
568	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	681	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		682	) {
569	if ($_ eq "default") {	683	if ($_ eq "default") {
570	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	684
		685	$ext_arg{$_} = []
		686	for
		687	qw(selection option-popup selection-popup readline),
		688	map $_->[0], values %{ $TERM->{meta}{binding} };
		689
		690	for ($TERM->_keysym_resources) {
		691	next if /^(?:string|command|builtin|builtin-string|perl)/;
		692	next unless /^([A-Za-z0-9_\-]+):/;
		693
		694	my $ext = $1;
		695	$ext =~ y/-/_/;
		696
		697	$ext_arg{$ext} = [];
		698	}
		699
571	} elsif (/^-(.*)$/) {	700	} elsif (/^-(.*)$/) {
572	delete $ext_arg{$1};	701	delete $ext_arg{$1};
		702
573	} elsif (/^([^<]+)<(.*)>$/) {	703	} elsif (/^([^<]+)<(.*)>$/) {
574	push @{ $ext_arg{$1} }, $2;	704	push @{ $ext_arg{$1} }, $2;
		705
575	} else {	706	} else {
576	$ext_arg{$_} ||= [];	707	$ext_arg{$_} ||= [];
577	}	708	}
578	}	709	}
579		710
580	while (my ($ext, $argv) = each %ext_arg) {	711	# now register default key bindings
		712	for my $ext (sort keys %ext_arg) {
		713	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		714	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
		715	}
		716	}
		717
		718	for my $ext (sort keys %ext_arg) {
581	my @files = grep -f $_, map "$_/$ext", @dirs;	719	my @files = grep -f $_, map "$_/$ext", @dirs;
582		720
583	if (@files) {	721	if (@files) {
584	$TERM->register_package (extension_package $files[0], $argv);	722	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
585	} else {	723	} else {
586	warn "perl extension '$ext' not found in perl library search path\n";	724	warn "perl extension '$ext' not found in perl library search path\n";
587	}	725	}
588	}	726	}
589		727
…		…
595		733
596	if (my $cb = $TERM->{_hook}[$htype]) {	734	if (my $cb = $TERM->{_hook}[$htype]) {
597	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	735	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
598	if $verbosity >= 10;	736	if $verbosity >= 10;
599		737
600	keys %$cb;	738	if ($htype == HOOK_ACTION) {
		739	# this hook is only sent to the extension with the name
		740	# matching the first arg
		741	my $pkg = shift;
		742	$pkg =~ y/-/_/;
		743	$pkg = "urxvt::ext::$pkg";
601		744
602	while (my ($pkg, $cb) = each %$cb) {	745	$cb = $cb->{$pkg}
		746	or return undef; #TODO: maybe warn user?
		747
		748	$cb = { $pkg => $cb };
		749	}
		750
		751	for my $pkg (keys %$cb) {
603	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	752	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
604	and last;	753	$retval ||= $retval_;
605		754
606	if ($@) {	755	if ($@) {
607	$TERM->ungrab; # better to lose the grab than the session	756	$TERM->ungrab; # better to lose the grab than the session
608	warn $@;	757	warn $@;
609	}	758	}
…		…
611		760
612	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	761	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613	if $verbosity >= 11;	762	if $verbosity >= 11;
614	}	763	}
615		764
616	if ($htype == 1) { # DESTROY	765	if ($htype == HOOK_DESTROY) {
617	if (my $hook = delete $TERM->{_hook}) {
618	for my $htype (0..$#$hook) {
619	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
620	or set_should_invoke $htype, 0;
621	}
622	}
623
624	# clear package objects	766	# clear package objects
625	%$_ = () for values %{ $TERM->{_pkg} };	767	%$_ = () for values %{ $TERM->{_pkg} };
626		768
627	# clear package	769	# clear package
628	%$TERM = ();	770	%$TERM = ();
629	}	771	}
630		772
631	$retval	773	$retval
632	}	774	}
633		775
634	sub exec_async(@) {	776	sub SET_COLOR($$$) {
635	my $pid = fork;	777	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
636
637	return
638	if !defined $pid or $pid;
639
640	%ENV = %{ $TERM->env };
641
642	exec @_;
643	_exit 255;
644	}	778	}
645		779
646	# urxvt::term::extension	780	sub rend2mask {
647		781	no strict 'refs';
648	package urxvt::term::extension;	782	my ($str, $mask) = (@_, 0);
649		783	my %color = ( fg => undef, bg => undef );
650	sub enable {	784	my @failed;
651	my ($self, %hook) = @_;	785	for my $spec ( split /\s+/, $str ) {
652	my $pkg = $self->{_pkg};	786	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
653		787	$color{lc($1)} = $2;
654	while (my ($name, $cb) = each %hook) {	788	} else {
655	my $htype = $HOOKTYPE{uc $name};	789	my $neg = $spec =~ s/^[-^]//;
656	defined $htype	790	unless ( exists &{"RS_$spec"} ) {
657	or Carp::croak "unsupported hook type '$name'";	791	push @failed, $spec;
658		792	next;
659	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
660	$hook_count[$htype]++
661	or urxvt::set_should_invoke $htype, 1;
662	}	793	}
663		794	my $cur = &{"RS_$spec"};
664	$self->{term}{_hook}[$htype]{$pkg} = $cb;	795	if ( $neg ) {
665	}	796	$mask &= ~$cur;
666	}	797	} else {
667		798	$mask |= $cur;
668	sub disable {	799	}
669	my ($self, @hook) = @_;
670	my $pkg = $self->{_pkg};
671
672	for my $name (@hook) {
673	my $htype = $HOOKTYPE{uc $name};
674	defined $htype
675	or Carp::croak "unsupported hook type '$name'";
676
677	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
678	--$hook_count[$htype]
679	or urxvt::set_should_invoke $htype, 0;
680	}	800	}
681	}	801	}
		802	($mask, @color{qw(fg bg)}, \@failed)
682	}	803	}
		804
		805	package urxvt::term::extension;
		806
		807	=head2 The C<urxvt::term::extension> class
		808
		809	Each extension attached to a terminal object is represented by
		810	a C<urxvt::term::extension> object.
		811
		812	You can use these objects, which are passed to all callbacks to store any
		813	state related to the terminal and extension instance.
		814
		815	The methods (And data members) documented below can be called on extension
		816	objects, in addition to call methods documented for the <urxvt::term>
		817	class.
		818
		819	=over 4
		820
		821	=item $urxvt_term = $self->{term}
		822
		823	Returns the C<urxvt::term> object associated with this instance of the
		824	extension. This member I<must not> be changed in any way.
		825
		826	=cut
683		827
684	our $AUTOLOAD;	828	our $AUTOLOAD;
685		829
686	sub AUTOLOAD {	830	sub AUTOLOAD {
687	$AUTOLOAD =~ /:([^:]+)$/	831	$AUTOLOAD =~ /:([^:]+)$/
…		…
700		844
701	sub DESTROY {	845	sub DESTROY {
702	# nop	846	# nop
703	}	847	}
704		848
705	# urxvt::destroy_hook	849	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
706		850
707	sub urxvt::destroy_hook::DESTROY {	851	sub urxvt::destroy_hook::DESTROY {
708	${$_[0]}->();	852	${$_[0]}->();
709	}	853	}
710		854
711	sub urxvt::destroy_hook(&) {	855	sub urxvt::destroy_hook(&) {
712	bless \shift, urxvt::destroy_hook::	856	bless \shift, urxvt::destroy_hook::
713	}	857	}
		858
		859	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		860
		861	Dynamically enable the given hooks (named without the C<on_> prefix) for
		862	this extension, replacing any hook previously installed via C<enable> in
		863	this extension.
		864
		865	This is useful when you want to overwrite time-critical hooks only
		866	temporarily.
		867
		868	To install additional callbacks for the same hook, you can use the C<on>
		869	method of the C<urxvt::term> class.
		870
		871	=item $self->disable ($hook_name[, $hook_name..])
		872
		873	Dynamically disable the given hooks.
		874
		875	=cut
		876
		877	sub enable {
		878	my ($self, %hook) = @_;
		879	my $pkg = $self->{_pkg};
		880
		881	while (my ($name, $cb) = each %hook) {
		882	my $htype = $HOOKTYPE{uc $name};
		883	defined $htype
		884	or Carp::croak "unsupported hook type '$name'";
		885
		886	$self->set_should_invoke ($htype, +1)
		887	unless exists $self->{term}{_hook}[$htype]{$pkg};
		888
		889	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		890	}
		891	}
		892
		893	sub disable {
		894	my ($self, @hook) = @_;
		895	my $pkg = $self->{_pkg};
		896
		897	for my $name (@hook) {
		898	my $htype = $HOOKTYPE{uc $name};
		899	defined $htype
		900	or Carp::croak "unsupported hook type '$name'";
		901
		902	$self->set_should_invoke ($htype, -1)
		903	if delete $self->{term}{_hook}[$htype]{$pkg};
		904	}
		905	}
		906
		907	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		908
		909	Similar to the C<enable> enable, but installs additional callbacks for
		910	the given hook(s) (that is, it doesn't replace existing callbacks), and
		911	returns a guard object. When the guard object is destroyed the callbacks
		912	are disabled again.
		913
		914	=cut
		915
		916	sub urxvt::extension::on_disable::DESTROY {
		917	my $disable = shift;
		918
		919	my $term = delete $disable->{""};
		920
		921	while (my ($htype, $id) = each %$disable) {
		922	delete $term->{_hook}[$htype]{$id};
		923	$term->set_should_invoke ($htype, -1);
		924	}
		925	}
		926
		927	sub on {
		928	my ($self, %hook) = @_;
		929
		930	my $term = $self->{term};
		931
		932	my %disable = ( "" => $term );
		933
		934	while (my ($name, $cb) = each %hook) {
		935	my $htype = $HOOKTYPE{uc $name};
		936	defined $htype
		937	or Carp::croak "unsupported hook type '$name'";
		938
		939	$term->set_should_invoke ($htype, +1);
		940	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		941	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		942	}
		943
		944	bless \%disable, "urxvt::extension::on_disable"
		945	}
		946
		947	=item $self->x_resource ($pattern)
		948
		949	=item $self->x_resource_boolean ($pattern)
		950
		951	These methods support an additional C<%> prefix when called on an
		952	extension object - see the description of these methods in the
		953	C<urxvt::term> class for details.
		954
		955	=cut
		956
		957	sub x_resource {
		958	my ($self, $name) = @_;
		959	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		960	$self->{term}->x_resource ($name)
		961	}
		962
		963	sub x_resource_boolean {
		964	my ($self, $name) = @_;
		965	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		966	$self->{term}->x_resource_boolean ($name)
		967	}
		968
		969	=back
		970
		971	=cut
714		972
715	package urxvt::anyevent;	973	package urxvt::anyevent;
716		974
717	=head2 The C<urxvt::anyevent> Class	975	=head2 The C<urxvt::anyevent> Class
718		976
719	The sole purpose of this class is to deliver an interface to the	977	The sole purpose of this class is to deliver an interface to the
720	C<AnyEvent> module - any module using it will work inside urxvt without	978	C<AnyEvent> module - any module using it will work inside urxvt without
721	further programming. The only exception is that you cannot wait on	979	further programming. The only exception is that you cannot wait on
722	condition variables, but non-blocking condvar use is ok. What this means	980	condition variables, but non-blocking condvar use is ok.
723	is that you cannot use blocking APIs, but the non-blocking variant should
724	work.
725		981
726	=cut	982	In practical terms this means is that you cannot use blocking APIs, but
		983	the non-blocking variant should work.
727		984
		985	=cut
		986
728	our $VERSION = 1;	987	our $VERSION = '5.23';
729		988
730	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	989	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
731	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	990	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
732		991
733	sub timer {	992	sub timer {
…		…
735		994
736	my $cb = $arg{cb};	995	my $cb = $arg{cb};
737		996
738	urxvt::timer	997	urxvt::timer
739	->new	998	->new
740	->start (urxvt::NOW + $arg{after})	999	->after ($arg{after}, $arg{interval})
741	->cb (sub {	1000	->cb ($arg{interval} ? $cb : sub {
742	$_[0]->stop; # need to cancel manually	1001	$_[0]->stop; # need to cancel manually
743	$cb->();	1002	$cb->();
744	})	1003	})
745	}	1004	}
746		1005
747	sub io {	1006	sub io {
748	my ($class, %arg) = @_;	1007	my ($class, %arg) = @_;
749		1008
750	my $cb = $arg{cb};	1009	my $cb = $arg{cb};
		1010	my $fd = fileno $arg{fh};
		1011	defined $fd or $fd = $arg{fh};
751		1012
752	bless [$arg{fh}, urxvt::iow	1013	bless [$arg{fh}, urxvt::iow
753	->new	1014	->new
754	->fd (fileno $arg{fh})	1015	->fd ($fd)
755	->events (($arg{poll} =~ /r/ ? 1 : 0)	1016	->events (($arg{poll} =~ /r/ ? 1 : 0)
756	| ($arg{poll} =~ /w/ ? 2 : 0))	1017	| ($arg{poll} =~ /w/ ? 2 : 0))
757	->start	1018	->start
758	->cb (sub {	1019	->cb ($cb)
759	$cb->(($_[1] & 1 ? 'r' : '')
760	. ($_[1] & 2 ? 'w' : ''));
761	})],
762	urxvt::anyevent::	1020	], urxvt::anyevent::
		1021	}
		1022
		1023	sub idle {
		1024	my ($class, %arg) = @_;
		1025
		1026	my $cb = $arg{cb};
		1027
		1028	urxvt::iw
		1029	->new
		1030	->start
		1031	->cb ($cb)
		1032	}
		1033
		1034	sub child {
		1035	my ($class, %arg) = @_;
		1036
		1037	my $cb = $arg{cb};
		1038
		1039	urxvt::pw
		1040	->new
		1041	->start ($arg{pid})
		1042	->cb (sub {
		1043	$_[0]->stop; # need to cancel manually
		1044	$cb->($_[0]->rpid, $_[0]->rstatus);
		1045	})
763	}	1046	}
764		1047
765	sub DESTROY {	1048	sub DESTROY {
766	$_[0][1]->stop;	1049	$_[0][1]->stop;
767	}	1050	}
768		1051
769	sub condvar {	1052	# only needed for AnyEvent < 6 compatibility
770	bless \my $flag, urxvt::anyevent::condvar::	1053	sub one_event {
771	}
772
773	sub urxvt::anyevent::condvar::broadcast {
774	${$_[0]}++;
775	}
776
777	sub urxvt::anyevent::condvar::wait {
778	unless (${$_[0]}) {
779	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1054	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
780	}
781	}	1055	}
782		1056
783	package urxvt::term;	1057	package urxvt::term;
784		1058
785	=head2 The C<urxvt::term> Class	1059	=head2 The C<urxvt::term> Class
…		…
791	# find on_xxx subs in the package and register them	1065	# find on_xxx subs in the package and register them
792	# as hooks	1066	# as hooks
793	sub register_package {	1067	sub register_package {
794	my ($self, $pkg, $argv) = @_;	1068	my ($self, $pkg, $argv) = @_;
795		1069
		1070	no strict 'refs';
		1071
		1072	urxvt::verbose 6, "register package $pkg to $self";
		1073
		1074	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1075
796	my $proxy = bless {	1076	my $proxy = bless {
797	_pkg => $pkg,	1077	_pkg => $pkg,
		1078	_name => ${"$pkg\::_NAME"}, # hackish
798	argv => $argv,	1079	argv => $argv,
799	}, $pkg;	1080	}, $pkg;
800	Scalar::Util::weaken ($proxy->{term} = $self);	1081	Scalar::Util::weaken ($proxy->{term} = $self);
801		1082
802	$self->{_pkg}{$pkg} = $proxy;	1083	$self->{_pkg}{$pkg} = $proxy;
803		1084
…		…
806	$proxy->enable ($name => $ref);	1087	$proxy->enable ($name => $ref);
807	}	1088	}
808	}	1089	}
809	}	1090	}
810		1091
		1092	sub perl_libdirs {
		1093	map { split /:/ }
		1094	$_[0]->resource ("perl_lib"),
		1095	$ENV{URXVT_PERL_LIB},
		1096	"$ENV{HOME}/.urxvt/ext",
		1097	"$LIBDIR/perl"
		1098	}
		1099
		1100	# scan for available extensions and collect their metadata
		1101	sub scan_extensions {
		1102	my ($self) = @_;
		1103
		1104	return if exists $self->{meta};
		1105
		1106	my @libdirs = perl_libdirs $self;
		1107
		1108	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1109
		1110	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1111	$self->{meta} = \my %meta;
		1112
		1113	# first gather extensions
		1114	for my $dir (reverse @libdirs) {
		1115	opendir my $fh, $dir
		1116	or next;
		1117	for my $ext (readdir $fh) {
		1118	$ext !~ /^\./
		1119	and open my $fh, "<", "$dir/$ext"
		1120	or next;
		1121
		1122	my %ext = (dir => $dir);
		1123
		1124	while (<$fh>) {
		1125	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1126	my ($pattern, $type, $desc) = split /:/, $1;
		1127	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1128	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1129	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1130	} else {
		1131	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1132	}
		1133	} elsif (/^#:META:BINDING:(.*)/) {
		1134	my ($keysym, $action) = split /:/, $1;
		1135	$ext{binding}{$keysym} = [$ext, $action];
		1136	} elsif (/^\s*(?:#|$)/) {
		1137	# skip other comments and empty lines
		1138	} else {
		1139	last; # stop parsing on first non-empty non-comment line
		1140	}
		1141	}
		1142
		1143	$meta{ext}{$ext} = \%ext;
		1144	}
		1145	}
		1146
		1147	# and now merge resources and bindings
		1148	while (my ($k, $v) = each %{ $meta{ext} }) {
		1149	#TODO: should check for extensions overriding each other
		1150	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1151	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1152	}
		1153	}
		1154
811	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1155	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
812		1156
813	Creates a new terminal, very similar as if you had started it with system	1157	Creates a new terminal, very similar as if you had started it with system
814	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1158	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
815	hash which defines the environment of the new terminal.	1159	hash which defines the environment of the new terminal.
816		1160
817	Croaks (and probably outputs an error message) if the new instance	1161	Croaks (and probably outputs an error message) if the new instance
818	couldn't be created. Returns C<undef> if the new instance didn't	1162	couldn't be created. Returns C<undef> if the new instance didn't
819	initialise perl, and the terminal object otherwise. The C<init> and	1163	initialise perl, and the terminal object otherwise. The C<init> and
820	C<start> hooks will be called during this call.	1164	C<start> hooks will be called before this call returns, and are free to
		1165	refer to global data (which is race free).
821		1166
822	=cut	1167	=cut
823		1168
824	sub new {	1169	sub new {
825	my ($class, $env, @args) = @_;	1170	my ($class, $env, @args) = @_;
826		1171
		1172	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1173	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1174
827	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1175	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
828	}	1176	}
829		1177
830	=item $term->destroy	1178	=item $term->destroy
831		1179
832	Destroy the terminal object (close the window, free resources	1180	Destroy the terminal object (close the window, free resources
833	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1181	etc.). Please note that urxvt will not exit as long as any event
834	watchers (timers, io watchers) are still active.	1182	watchers (timers, io watchers) are still active.
		1183
		1184	=item $term->exec_async ($cmd[, @args])
		1185
		1186	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1187	("starts") programs in the background. This function takes care of setting
		1188	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1189	be preferred over explicit calls to C<exec> or C<system>.
		1190
		1191	Returns the pid of the subprocess or C<undef> on error.
		1192
		1193	=cut
		1194
		1195	sub exec_async {
		1196	my $self = shift;
		1197
		1198	my $pid = fork;
		1199
		1200	return $pid
		1201	if !defined $pid or $pid;
		1202
		1203	%ENV = %{ $self->env };
		1204
		1205	exec @_;
		1206	urxvt::_exit 255;
		1207	}
835		1208
836	=item $isset = $term->option ($optval[, $set])	1209	=item $isset = $term->option ($optval[, $set])
837		1210
838	Returns true if the option specified by C<$optval> is enabled, and	1211	Returns true if the option specified by C<$optval> is enabled, and
839	optionally change it. All option values are stored by name in the hash	1212	optionally change it. All option values are stored by name in the hash
840	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1213	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
841		1214
842	Here is a a likely non-exhaustive list of option names, please see the	1215	Here is a likely non-exhaustive list of option names, please see the
843	source file F</src/optinc.h> to see the actual list:	1216	source file F</src/optinc.h> to see the actual list:
844		1217
845	borderLess console cursorBlink cursorUnderline hold iconic insecure	1218	borderLess buffered console cursorBlink cursorUnderline hold iconic
846	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1219	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1220	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
847	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1221	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
848	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1222	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
849	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1223	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
850	tripleclickwords utmpInhibit visualBell	1224	urgentOnBell utmpInhibit visualBell
851		1225
852	=item $value = $term->resource ($name[, $newval])	1226	=item $value = $term->resource ($name[, $newval])
853		1227
854	Returns the current resource value associated with a given name and	1228	Returns the current resource value associated with a given name and
855	optionally sets a new value. Setting values is most useful in the C<init>	1229	optionally sets a new value. Setting values is most useful in the C<init>
…		…
864	likely change).	1238	likely change).
865		1239
866	Please note that resource strings will currently only be freed when the	1240	Please note that resource strings will currently only be freed when the
867	terminal is destroyed, so changing options frequently will eat memory.	1241	terminal is destroyed, so changing options frequently will eat memory.
868		1242
869	Here is a a likely non-exhaustive list of resource names, not all of which	1243	Here is a likely non-exhaustive list of resource names, not all of which
870	are supported in every build, please see the source file F</src/rsinc.h>	1244	are supported in every build, please see the source file F</src/rsinc.h>
871	to see the actual list:	1245	to see the actual list:
872		1246
873	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1247	answerbackstring backgroundPixmap backspace_key blurradius
874	borderLess color cursorBlink cursorUnderline cutchars delete_key	1248	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
875	display_name embed ext_bwidth fade font geometry hold iconName	1249	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
876	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1250	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1251	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
877	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1252	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
878	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1253	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
879	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1254	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
880	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1255	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
881	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1256	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
882	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1257	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
883	shade term_name title transparent transparent_all tripleclickwords	1258	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1259	term_name title transient_for transparent tripleclickwords urgentOnBell
884	utmpInhibit visualBell	1260	utmpInhibit visualBell
885		1261
886	=cut	1262	=cut
887		1263
888	sub resource($$;$) {	1264	sub resource($$;$) {
889	my ($self, $name) = (shift, shift);	1265	my ($self, $name) = (shift, shift);
890	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1266	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
891	&urxvt::term::_resource	1267	goto &urxvt::term::_resource
892	}	1268	}
893		1269
894	=item $value = $term->x_resource ($pattern)	1270	=item $value = $term->x_resource ($pattern)
895		1271
896	Returns the X-Resource for the given pattern, excluding the program or	1272	Returns the X-Resource for the given pattern, excluding the program or
897	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1273	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
898	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1274	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
899	resource with that pattern exists.	1275	resource with that pattern exists.
900		1276
		1277	Extensions that define extra resource or command line arguments also need
		1278	to call this method to access their values.
		1279
		1280	If the method is called on an extension object (basically, from an
		1281	extension), then the special prefix C<%.> will be replaced by the name of
		1282	the extension and a dot, and the lone string C<%> will be replaced by the
		1283	extension name itself. This makes it possible to code extensions so you
		1284	can rename them and get a new set of commandline switches and resources
		1285	without having to change the actual code.
		1286
901	This method should only be called during the C<on_start> hook, as there is	1287	This method should only be called during the C<on_start> hook, as there is
902	only one resource database per display, and later invocations might return	1288	only one resource database per display, and later invocations might return
903	the wrong resources.	1289	the wrong resources.
904		1290
905	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1291	=item $value = $term->x_resource_boolean ($pattern)
906		1292
		1293	Like C<x_resource>, above, but interprets the string value as a boolean
		1294	and returns C<1> for true values, C<0> for false values and C<undef> if
		1295	the resource or option isn't specified.
		1296
		1297	You should always use this method to parse boolean resources.
		1298
		1299	=cut
		1300
		1301	sub x_resource_boolean {
		1302	my $res = &x_resource;
		1303
		1304	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1305	}
		1306
		1307	=item $success = $term->bind_action ($key, $octets)
		1308
907	Adds a keymap translation exactly as specified via a resource. See the	1309	Adds a key binding exactly as specified via a C<keysym> resource. See the
908	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1310	C<keysym> resource in the urxvt(1) manpage.
909		1311
910	=item $rend = $term->rstyle ([$new_rstyle])	1312	=item $rend = $term->rstyle ([$new_rstyle])
911		1313
912	Return and optionally change the current rendition. Text that is output by	1314	Return and optionally change the current rendition. Text that is output by
913	the terminal application will use this style.	1315	the terminal application will use this style.
…		…
921		1323
922	=item ($row, $col) = $term->selection_beg ([$row, $col])	1324	=item ($row, $col) = $term->selection_beg ([$row, $col])
923		1325
924	=item ($row, $col) = $term->selection_end ([$row, $col])	1326	=item ($row, $col) = $term->selection_end ([$row, $col])
925		1327
926	Return the current values of the selection mark, begin or end positions,	1328	Return the current values of the selection mark, begin or end positions.
927	and optionally set them to new values.	1329
		1330	When arguments are given, then the selection coordinates are set to
		1331	C<$row> and C<$col>, and the selection screen is set to the current
		1332	screen.
		1333
		1334	=item $screen = $term->selection_screen ([$screen])
		1335
		1336	Returns the current selection screen, and then optionally sets it.
928		1337
929	=item $term->selection_make ($eventtime[, $rectangular])	1338	=item $term->selection_make ($eventtime[, $rectangular])
930		1339
931	Tries to make a selection as set by C<selection_beg> and	1340	Tries to make a selection as set by C<selection_beg> and
932	C<selection_end>. If C<$rectangular> is true (default: false), a	1341	C<selection_end>. If C<$rectangular> is true (default: false), a
933	rectangular selection will be made. This is the prefered function to make	1342	rectangular selection will be made. This is the preferred function to make
934	a selection.	1343	a selection.
935		1344
936	=item $success = $term->selection_grab ($eventtime)	1345	=item $success = $term->selection_grab ($eventtime[, $clipboard])
937		1346
938	Try to request the primary selection text from the server (for example, as	1347	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1348	true) selection from the server. The corresponding text can be set
939	set by the next method). No visual feedback will be given. This function	1349	with the next method. No visual feedback will be given. This function
940	is mostly useful from within C<on_sel_grab> hooks.	1350	is mostly useful from within C<on_sel_grab> hooks.
941		1351
942	=item $oldtext = $term->selection ([$newtext])	1352	=item $oldtext = $term->selection ([$newtext, $clipboard])
943		1353
944	Return the current selection text and optionally replace it by C<$newtext>.	1354	Return the current selection (clipboard if C<$clipboard> is true) text
		1355	and optionally replace it by C<$newtext>.
		1356
		1357	=item $term->selection_clear ([$clipboard])
		1358
		1359	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
945		1360
946	=item $term->overlay_simple ($x, $y, $text)	1361	=item $term->overlay_simple ($x, $y, $text)
947		1362
948	Create a simple multi-line overlay box. See the next method for details.	1363	Create a simple multi-line overlay box. See the next method for details.
949		1364
…		…
979		1394
980	The methods currently supported on C<urxvt::overlay> objects are:	1395	The methods currently supported on C<urxvt::overlay> objects are:
981		1396
982	=over 4	1397	=over 4
983		1398
984	=item $overlay->set ($x, $y, $text, $rend)	1399	=item $overlay->set ($x, $y, $text[, $rend])
985		1400
986	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1401	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
987	text in rxvt-unicode's special encoding and an array of rendition values	1402	text in rxvt-unicode's special encoding and an array of rendition values
988	at a specific position inside the overlay.	1403	at a specific position inside the overlay.
		1404
		1405	If C<$rend> is missing, then the rendition will not be changed.
989		1406
990	=item $overlay->hide	1407	=item $overlay->hide
991		1408
992	If visible, hide the overlay, but do not destroy it.	1409	If visible, hide the overlay, but do not destroy it.
993		1410
…		…
1063		1480
1064	Normally its not a good idea to use this function, as programs might be	1481	Normally its not a good idea to use this function, as programs might be
1065	confused by changes in cursor position or scrolling. Its useful inside a	1482	confused by changes in cursor position or scrolling. Its useful inside a
1066	C<on_add_lines> hook, though.	1483	C<on_add_lines> hook, though.
1067		1484
		1485	=item $term->scr_change_screen ($screen)
		1486
		1487	Switch to given screen - 0 primary, 1 secondary.
		1488
1068	=item $term->cmd_parse ($octets)	1489	=item $term->cmd_parse ($octets)
1069		1490
1070	Similar to C<scr_add_lines>, but the argument must be in the	1491	Similar to C<scr_add_lines>, but the argument must be in the
1071	locale-specific encoding of the terminal and can contain command sequences	1492	locale-specific encoding of the terminal and can contain command sequences
1072	(escape codes) that will be interpreted.	1493	(escape codes) that will be interpreted.
1073		1494
1074	=item $term->tt_write ($octets)	1495	=item $term->tt_write ($octets)
1075		1496
1076	Write the octets given in C<$data> to the tty (i.e. as program input). To	1497	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1077	pass characters instead of octets, you should convert your strings first	1498	pass characters instead of octets, you should convert your strings first
1078	to the locale-specific encoding using C<< $term->locale_encode >>.	1499	to the locale-specific encoding using C<< $term->locale_encode >>.
		1500
		1501	=item $term->tt_write_user_input ($octets)
		1502
		1503	Like C<tt_write>, but should be used when writing strings in response to
		1504	the user pressing a key, to invokes the additional actions requested by
		1505	the user for that case (C<tt_write> doesn't do that).
		1506
		1507	The typical use case would be inside C<on_action> hooks.
		1508
		1509	=item $term->tt_paste ($octets)
		1510
		1511	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1512	CR and bracketing the data with control sequences if bracketed paste mode
		1513	is set.
1079		1514
1080	=item $old_events = $term->pty_ev_events ([$new_events])	1515	=item $old_events = $term->pty_ev_events ([$new_events])
1081		1516
1082	Replaces the event mask of the pty watcher by the given event mask. Can	1517	Replaces the event mask of the pty watcher by the given event mask. Can
1083	be used to suppress input and output handling to the pty/tty. See the	1518	be used to suppress input and output handling to the pty/tty. See the
1084	description of C<< urxvt::timer->events >>. Make sure to always restore	1519	description of C<< urxvt::timer->events >>. Make sure to always restore
1085	the previous value.	1520	the previous value.
1086		1521
		1522	=item $fd = $term->pty_fd
		1523
		1524	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1525	is used.
		1526
1087	=item $windowid = $term->parent	1527	=item $windowid = $term->parent
1088		1528
1089	Return the window id of the toplevel window.	1529	Return the window id of the toplevel window.
1090		1530
1091	=item $windowid = $term->vt	1531	=item $windowid = $term->vt
1092		1532
1093	Return the window id of the terminal window.	1533	Return the window id of the terminal window.
1094		1534
		1535	=item $term->vt_emask_add ($x_event_mask)
		1536
		1537	Adds the specified events to the vt event mask. Useful e.g. when you want
		1538	to receive pointer events all the times:
		1539
		1540	$term->vt_emask_add (urxvt::PointerMotionMask);
		1541
		1542	=item $term->set_urgency ($set)
		1543
		1544	Enable/disable the urgency hint on the toplevel window.
		1545
		1546	=item $term->focus_in
		1547
		1548	=item $term->focus_out
		1549
		1550	=item $term->key_press ($state, $keycode[, $time])
		1551
		1552	=item $term->key_release ($state, $keycode[, $time])
		1553
		1554	Deliver various fake events to to terminal.
		1555
1095	=item $window_width = $term->width	1556	=item $window_width = $term->width
1096		1557
1097	=item $window_height = $term->height	1558	=item $window_height = $term->height
1098		1559
1099	=item $font_width = $term->fwidth	1560	=item $font_width = $term->fwidth
…		…
1112		1573
1113	=item $max_scrollback = $term->saveLines	1574	=item $max_scrollback = $term->saveLines
1114		1575
1115	=item $nrow_plus_saveLines = $term->total_rows	1576	=item $nrow_plus_saveLines = $term->total_rows
1116		1577
1117	=item $lines_in_scrollback = $term->nsaved	1578	=item $topmost_scrollback_row = $term->top_row
1118		1579
1119	Return various integers describing terminal characteristics.	1580	Return various integers describing terminal characteristics.
1120		1581
1121	=item $x_display = $term->display_id	1582	=item $x_display = $term->display_id
1122		1583
…		…
1129	=item $env = $term->env	1590	=item $env = $term->env
1130		1591
1131	Returns a copy of the environment in effect for the terminal as a hashref	1592	Returns a copy of the environment in effect for the terminal as a hashref
1132	similar to C<\%ENV>.	1593	similar to C<\%ENV>.
1133		1594
		1595	=item @envv = $term->envv
		1596
		1597	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1598
		1599	=item @argv = $term->argv
		1600
		1601	Return the argument vector as this terminal, similar to @ARGV, but
		1602	includes the program name as first element.
		1603
1134	=cut	1604	=cut
1135		1605
1136	sub env {	1606	sub env {
1137	if (my $env = $_[0]->_env) {
1138	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1607	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1139	} else {
1140	+{ %ENV }
1141	}
1142	}	1608	}
1143		1609
1144	=item $modifiermask = $term->ModLevel3Mask	1610	=item $modifiermask = $term->ModLevel3Mask
1145		1611
1146	=item $modifiermask = $term->ModMetaMask	1612	=item $modifiermask = $term->ModMetaMask
…		…
1148	=item $modifiermask = $term->ModNumLockMask	1614	=item $modifiermask = $term->ModNumLockMask
1149		1615
1150	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1616	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1151	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1617	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1152		1618
		1619	=item $screen = $term->current_screen
		1620
		1621	Returns the currently displayed screen (0 primary, 1 secondary).
		1622
		1623	=item $cursor_is_hidden = $term->hidden_cursor
		1624
		1625	Returns whether the cursor is currently hidden or not.
		1626
1153	=item $view_start = $term->view_start ([$newvalue])	1627	=item $view_start = $term->view_start ([$newvalue])
1154		1628
1155	Returns the negative row number of the topmost line. Minimum value is	1629	Returns the row number of the topmost displayed line. Maximum value is
1156	C<0>, which displays the normal terminal contents. Larger values scroll	1630	C<0>, which displays the normal terminal contents. Lower values scroll
1157	this many lines into the scrollback buffer.	1631	this many lines into the scrollback buffer.
1158		1632
1159	=item $term->want_refresh	1633	=item $term->want_refresh
1160		1634
1161	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1635	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1164		1638
1165	Used after changing terminal contents to display them.	1639	Used after changing terminal contents to display them.
1166		1640
1167	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1641	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1168		1642
1169	Returns the text of the entire row with number C<$row_number>. Row C<0>	1643	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1170	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1644	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1171	terminal line. The scrollback buffer starts at line C<-1> and extends to
1172	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1645	terminal line. Nothing will be returned if a nonexistent line
1173	is requested.	1646	is requested.
1174		1647
1175	If C<$new_text> is specified, it will replace characters in the current	1648	If C<$new_text> is specified, it will replace characters in the current
1176	line, starting at column C<$start_col> (default C<0>), which is useful	1649	line, starting at column C<$start_col> (default C<0>), which is useful
1177	to replace only parts of a line. The font index in the rendition will	1650	to replace only parts of a line. The font index in the rendition will
1178	automatically be updated.	1651	automatically be updated.
1179		1652
1180	C<$text> is in a special encoding: tabs and wide characters that use more	1653	C<$text> is in a special encoding: tabs and wide characters that use more
1181	than one cell when displayed are padded with urxvt::NOCHAR characters	1654	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1182	(C<chr 65535>). Characters with combining characters and other characters	1655	characters. Characters with combining characters and other characters that
1183	that do not fit into the normal tetx encoding will be replaced with	1656	do not fit into the normal text encoding will be replaced with characters
1184	characters in the private use area.	1657	in the private use area.
1185		1658
1186	You have to obey this encoding when changing text. The advantage is	1659	You have to obey this encoding when changing text. The advantage is
1187	that C<substr> and similar functions work on screen cells and not on	1660	that C<substr> and similar functions work on screen cells and not on
1188	characters.	1661	characters.
1189		1662
…		…
1273	}	1746	}
1274		1747
1275	sub urxvt::line::t {	1748	sub urxvt::line::t {
1276	my ($self) = @_;	1749	my ($self) = @_;
1277		1750
1278	if (@_ > 1)	1751	if (@_ > 1) {
1279	{
1280	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1752	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1281	for $self->{beg} .. $self->{end};	1753	for $self->{beg} .. $self->{end};
1282	}	1754	}
1283		1755
1284	defined wantarray &&	1756	defined wantarray &&
1285	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1757	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1286	0, $self->{len}	1758	0, $self->{len}
1287	}	1759	}
1288		1760
1289	sub urxvt::line::r {	1761	sub urxvt::line::r {
1290	my ($self) = @_;	1762	my ($self) = @_;
1291		1763
1292	if (@_ > 1)	1764	if (@_ > 1) {
1293	{
1294	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1765	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1295	for $self->{beg} .. $self->{end};	1766	for $self->{beg} .. $self->{end};
1296	}	1767	}
1297		1768
1298	if (defined wantarray) {	1769	if (defined wantarray) {
1299	my $rend = [	1770	my $rend = [
1300	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1771	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1301	];	1772	];
…		…
1333	where one character corresponds to one screen cell. See	1804	where one character corresponds to one screen cell. See
1334	C<< $term->ROW_t >> for details.	1805	C<< $term->ROW_t >> for details.
1335		1806
1336	=item $string = $term->special_decode $text	1807	=item $string = $term->special_decode $text
1337		1808
1338	Converts rxvt-unicodes text reprsentation into a perl string. See	1809	Converts rxvt-unicodes text representation into a perl string. See
1339	C<< $term->ROW_t >> for details.	1810	C<< $term->ROW_t >> for details.
1340		1811
1341	=item $success = $term->grab_button ($button, $modifiermask)	1812	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1342		1813
		1814	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1815
1343	Registers a synchronous button grab. See the XGrabButton manpage.	1816	Register/unregister a synchronous button grab. See the XGrabButton
		1817	manpage.
1344		1818
1345	=item $success = $term->grab ($eventtime[, $sync])	1819	=item $success = $term->grab ($eventtime[, $sync])
1346		1820
1347	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1821	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1348	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1822	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1349		1823
1350	=item $term->allow_events_async	1824	=item $term->allow_events_async
1351		1825
1352	Calls XAllowEvents with AsyncBoth for the most recent grab.	1826	Calls XAllowEvents with AsyncBoth for the most recent grab.
1353		1827
…		…
1360	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1834	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1361	recent grab.	1835	recent grab.
1362		1836
1363	=item $term->ungrab	1837	=item $term->ungrab
1364		1838
1365	Calls XUngrab for the most recent grab. Is called automatically on	1839	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1366	evaluation errors, as it is better to lose the grab in the error case as	1840	evaluation errors, as it is better to lose the grab in the error case as
1367	the session.	1841	the session.
		1842
		1843	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1844
		1845	=item $atom_name = $term->XGetAtomName ($atom)
		1846
		1847	=item @atoms = $term->XListProperties ($window)
		1848
		1849	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1850
		1851	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1852
		1853	=item $term->XDeleteProperty ($window, $property)
		1854
		1855	=item $window = $term->DefaultRootWindow
		1856
		1857	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1858
		1859	=item $term->XMapWindow ($window)
		1860
		1861	=item $term->XUnmapWindow ($window)
		1862
		1863	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1864
		1865	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1866
		1867	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1868
		1869	=item $keysym = $term->XStringToKeysym ($string)
		1870
		1871	=item $string = $term->XKeysymToString ($keysym)
		1872
		1873	Various X or X-related functions. The C<$term> object only serves as
		1874	the source of the display, otherwise those functions map more-or-less
		1875	directly onto the X functions of the same name.
1368		1876
1369	=back	1877	=back
1370		1878
1371	=cut	1879	=cut
1372		1880
…		…
1436	my ($self, $text, $cb) = @_;	1944	my ($self, $text, $cb) = @_;
1437		1945
1438	$self->add_item ({ type => "button", text => $text, activate => $cb});	1946	$self->add_item ({ type => "button", text => $text, activate => $cb});
1439	}	1947	}
1440		1948
1441	=item $popup->add_toggle ($text, $cb, $initial_value)	1949	=item $popup->add_toggle ($text, $initial_value, $cb)
1442		1950
1443	Adds a toggle/checkbox item to the popup. Teh callback gets called	1951	Adds a toggle/checkbox item to the popup. The callback gets called
1444	whenever it gets toggled, with a boolean indicating its value as its first	1952	whenever it gets toggled, with a boolean indicating its new value as its
1445	argument.	1953	first argument.
1446		1954
1447	=cut	1955	=cut
1448		1956
1449	sub add_toggle {	1957	sub add_toggle {
1450	my ($self, $text, $cb, $value) = @_;	1958	my ($self, $text, $value, $cb) = @_;
1451		1959
1452	my $item; $item = {	1960	my $item; $item = {
1453	type => "button",	1961	type => "button",
1454	text => " $text",	1962	text => " $text",
1455	value => $value,	1963	value => $value,
…		…
1474	my $env = $self->{term}->env;	1982	my $env = $self->{term}->env;
1475	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1983	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1476	delete $env->{LC_ALL};	1984	delete $env->{LC_ALL};
1477	$env->{LC_CTYPE} = $self->{term}->locale;	1985	$env->{LC_CTYPE} = $self->{term}->locale;
1478		1986
1479	urxvt::term->new ($env, $self->{term}->resource ("name"),	1987	my $term = urxvt::term->new (
1480	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1988	$env, "popup",
		1989	"--perl-lib" => "", "--perl-ext-common" => "",
		1990	"-pty-fd" => -1, "-sl" => 0,
		1991	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1481	"--transient-for" => $self->{term}->parent,	1992	"--transient-for" => $self->{term}->parent,
1482	"-display" => $self->{term}->display_id,	1993	"-display" => $self->{term}->display_id,
1483	"-pe" => "urxvt-popup")	1994	"-pe" => "urxvt-popup",
1484	or die "unable to create popup window\n";	1995	) or die "unable to create popup window\n";
		1996
		1997	unless (delete $term->{urxvt_popup_init_done}) {
		1998	$term->ungrab;
		1999	$term->destroy;
		2000	die "unable to initialise popup window\n";
		2001	}
1485	}	2002	}
1486		2003
1487	sub DESTROY {	2004	sub DESTROY {
1488	my ($self) = @_;	2005	my ($self) = @_;
1489		2006
1490	delete $self->{term}{_destroy}{$self};	2007	delete $self->{term}{_destroy}{$self};
1491	$self->{term}->ungrab;	2008	$self->{term}->ungrab;
1492	}	2009	}
1493		2010
1494	=back	2011	=back
		2012
		2013	=cut
		2014
		2015	package urxvt::watcher;
1495		2016
1496	=head2 The C<urxvt::timer> Class	2017	=head2 The C<urxvt::timer> Class
1497		2018
1498	This class implements timer watchers/events. Time is represented as a	2019	This class implements timer watchers/events. Time is represented as a
1499	fractional number of seconds since the epoch. Example:	2020	fractional number of seconds since the epoch. Example:
…		…
1503	->new	2024	->new
1504	->interval (1)	2025	->interval (1)
1505	->cb (sub {	2026	->cb (sub {
1506	$term->{overlay}->set (0, 0,	2027	$term->{overlay}->set (0, 0,
1507	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2028	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1508	});	2029	});
1509		2030
1510	=over 4	2031	=over 4
1511		2032
1512	=item $timer = new urxvt::timer	2033	=item $timer = new urxvt::timer
1513		2034
…		…
1516		2037
1517	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2038	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1518		2039
1519	Set the callback to be called when the timer triggers.	2040	Set the callback to be called when the timer triggers.
1520		2041
1521	=item $tstamp = $timer->at
1522
1523	Return the time this watcher will fire next.
1524
1525	=item $timer = $timer->set ($tstamp)	2042	=item $timer = $timer->set ($tstamp[, $interval])
1526		2043
1527	Set the time the event is generated to $tstamp.	2044	Set the time the event is generated to $tstamp (and optionally specifies a
		2045	new $interval).
1528		2046
1529	=item $timer = $timer->interval ($interval)	2047	=item $timer = $timer->interval ($interval)
1530		2048
1531	Normally (and when C<$interval> is C<0>), the timer will automatically	2049	By default (and when C<$interval> is C<0>), the timer will automatically
1532	stop after it has fired once. If C<$interval> is non-zero, then the timer	2050	stop after it has fired once. If C<$interval> is non-zero, then the timer
1533	is automatically rescheduled at the given intervals.	2051	is automatically rescheduled at the given intervals.
1534		2052
1535	=item $timer = $timer->start	2053	=item $timer = $timer->start
1536		2054
1537	Start the timer.	2055	Start the timer.
1538		2056
1539	=item $timer = $timer->start ($tstamp)	2057	=item $timer = $timer->start ($tstamp[, $interval])
1540		2058
1541	Set the event trigger time to C<$tstamp> and start the timer.	2059	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2060	also replaces the interval.
		2061
		2062	=item $timer = $timer->after ($delay[, $interval])
		2063
		2064	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1542		2065
1543	=item $timer = $timer->stop	2066	=item $timer = $timer->stop
1544		2067
1545	Stop the timer.	2068	Stop the timer.
1546		2069
…		…
1552		2075
1553	$term->{socket} = ...	2076	$term->{socket} = ...
1554	$term->{iow} = urxvt::iow	2077	$term->{iow} = urxvt::iow
1555	->new	2078	->new
1556	->fd (fileno $term->{socket})	2079	->fd (fileno $term->{socket})
1557	->events (urxvt::EVENT_READ)	2080	->events (urxvt::EV_READ)
1558	->start	2081	->start
1559	->cb (sub {	2082	->cb (sub {
1560	my ($iow, $revents) = @_;	2083	my ($iow, $revents) = @_;
1561	# $revents must be 1 here, no need to check	2084	# $revents must be 1 here, no need to check
1562	sysread $term->{socket}, my $buf, 8192	2085	sysread $term->{socket}, my $buf, 8192
…		…
1575	Set the callback to be called when io events are triggered. C<$reventmask>	2098	Set the callback to be called when io events are triggered. C<$reventmask>
1576	is a bitset as described in the C<events> method.	2099	is a bitset as described in the C<events> method.
1577		2100
1578	=item $iow = $iow->fd ($fd)	2101	=item $iow = $iow->fd ($fd)
1579		2102
1580	Set the filedescriptor (not handle) to watch.	2103	Set the file descriptor (not handle) to watch.
1581		2104
1582	=item $iow = $iow->events ($eventmask)	2105	=item $iow = $iow->events ($eventmask)
1583		2106
1584	Set the event mask to watch. The only allowed values are	2107	Set the event mask to watch. The only allowed values are
1585	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2108	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1586	together, or C<urxvt::EVENT_NONE>.	2109	together, or C<urxvt::EV_NONE>.
1587		2110
1588	=item $iow = $iow->start	2111	=item $iow = $iow->start
1589		2112
1590	Start watching for requested events on the given handle.	2113	Start watching for requested events on the given handle.
1591		2114
1592	=item $iow = $iow->stop	2115	=item $iow = $iow->stop
1593		2116
1594	Stop watching for events on the given filehandle.	2117	Stop watching for events on the given file handle.
		2118
		2119	=back
		2120
		2121	=head2 The C<urxvt::iw> Class
		2122
		2123	This class implements idle watchers, that get called automatically when
		2124	the process is idle. They should return as fast as possible, after doing
		2125	some useful work.
		2126
		2127	=over 4
		2128
		2129	=item $iw = new urxvt::iw
		2130
		2131	Create a new idle watcher object in stopped state.
		2132
		2133	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2134
		2135	Set the callback to be called when the watcher triggers.
		2136
		2137	=item $timer = $timer->start
		2138
		2139	Start the watcher.
		2140
		2141	=item $timer = $timer->stop
		2142
		2143	Stop the watcher.
		2144
		2145	=back
		2146
		2147	=head2 The C<urxvt::pw> Class
		2148
		2149	This class implements process watchers. They create an event whenever a
		2150	process exits, after which they stop automatically.
		2151
		2152	my $pid = fork;
		2153	...
		2154	$term->{pw} = urxvt::pw
		2155	->new
		2156	->start ($pid)
		2157	->cb (sub {
		2158	my ($pw, $exit_status) = @_;
		2159	...
		2160	});
		2161
		2162	=over 4
		2163
		2164	=item $pw = new urxvt::pw
		2165
		2166	Create a new process watcher in stopped state.
		2167
		2168	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2169
		2170	Set the callback to be called when the timer triggers.
		2171
		2172	=item $pw = $timer->start ($pid)
		2173
		2174	Tells the watcher to start watching for process C<$pid>.
		2175
		2176	=item $pw = $pw->stop
		2177
		2178	Stop the watcher.
1595		2179
1596	=back	2180	=back
1597		2181
1598	=head1 ENVIRONMENT	2182	=head1 ENVIRONMENT
1599		2183
…		…
1608		2192
1609	=item >= 3 - script loading and management	2193	=item >= 3 - script loading and management
1610		2194
1611	=item >=10 - all called hooks	2195	=item >=10 - all called hooks
1612		2196
1613	=item >=11 - hook reutrn values	2197	=item >=11 - hook return values
1614		2198
1615	=back	2199	=back
1616		2200
1617	=head1 AUTHOR	2201	=head1 AUTHOR
1618		2202
1619	Marc Lehmann <pcg@goof.com>	2203	Marc Lehmann <schmorp@schmorp.de>
1620	http://software.schmorp.de/pkg/rxvt-unicode	2204	http://software.schmorp.de/pkg/rxvt-unicode
1621		2205
1622	=cut	2206	=cut
1623		2207
1624	1	2208	1
		2209
		2210	# vim: sw=3:

Diff Legend

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