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.91 by root, Fri Jan 13 01:09:37 2006 UTC vs.
Revision 1.229 by root, Sat Apr 26 18:53:51 2014 UTC

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

Diff Legend

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