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.64 by root, Mon Jan 9 06:29:47 2006 UTC vs.
Revision 1.233 by sf-exg, Fri May 2 20:34:24 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	=head2 Prepackaged Extensions	31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
32		33
33	This section describes the extensiosn delivered with this version. You can	34	=head1 PREPACKAGED EXTENSIONS
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	35
		36	A number of extensions are delivered with this release. You can find them
		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	Intelligent selection. This extension tries to be more intelligent when	48	Extensions that add command line parameters or resources on their own are
45	the user extends selections (double-click). Right now, it tries to select	49	loaded automatically when used.
46	urls and complete shell-quoted arguments, which is very convenient, too,
47	if your F<ls> supports C<--quoting-style=shell>.
48		50
49	It also offers the following bindable event:	51	=head1 API DOCUMENTATION
50
51	=over 4
52
53	=item rot13
54
55	Rot-13 the selection when activated. Used via keyboard trigger:
56
57	URxvt.keysym.C-M-r: perl:selection:rot13
58
59	=back
60
61	=item option-popup (enabled by default)
62
63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.
65
66	=item selection-popup (enabled by default)
67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.
70
71	=item digital-clock
72
73	Displays a digital clock using the built-in overlay.
74
75	=item mark-urls
76
77	Uses per-line display filtering (C<on_line_update>) to underline urls.
78
79	=item block-graphics-to-ascii
80
81	A not very useful example of filtering all text output to the terminal,
82	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.
84
85	=item example-refresh-hooks
86
87	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.
90
91	=back
92		52
93	=head2 General API Considerations	53	=head2 General API Considerations
94		54
95	All objects (such as terminals, time watchers etc.) are typical	55	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	56	reference-to-hash objects. The hash can be used to store anything you
…		…
108		68
109	=over 4	69	=over 4
110		70
111	=item $text	71	=item $text
112		72
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
114	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.
115		75
116	=item $string	76	=item $string
117		77
118	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
119	characters and is to be distinguished with text encoded in a specific	79	characters and is to be distinguished with text encoded in a specific
…		…
122	=item $octets	82	=item $octets
123		83
124	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
125	locale-specific way.	85	locale-specific way.
126		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
127	=back	93	=back
		94
		95	=head2 Extension Objects
		96
		97	Every perl extension is a perl class. A separate perl object is created
		98	for each terminal, and each terminal has its own set of extension objects,
		99	which are passed as the first parameter to hooks. So extensions can use
		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
		102	that begin with an underscore character C<_>: these are reserved for
		103	internal use.
		104
		105	Although it isn't a C<urxvt::term> object, you can call all methods of the
		106	C<urxvt::term> class on this object.
		107
		108	Additional methods only supported for extension objects are described in
		109	the C<urxvt::extension> section below.
128		110
129	=head2 Hooks	111	=head2 Hooks
130		112
131	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
132	called whenever the relevant event happens.	114	called whenever the relevant event happens.
133		115
134	The first argument passed to them is an object private to each terminal	116	The first argument passed to them is an extension object as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	117	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		118
141	All of them must return a boolean value. If it is true, then the event	119	B<All> of these hooks must return a boolean value. If any of the called
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	120	hooks returns true, then the event counts as being I<consumed>, and the
143	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.
144		122
145	When in doubt, return a false value (preferably C<()>).	123	I<< When in doubt, return a false value (preferably C<()>). >>
146		124
147	=over 4	125	=over 4
148		126
149	=item on_init $term	127	=item on_init $term
150		128
151	Called after a new terminal object has been initialized, but before	129	Called after a new terminal object has been initialized, but before
152	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
153	call or deliver senseless data, as terminal size and other characteristics	131	call or deliver senseless data, as terminal size and other characteristics
154	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
155	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).
156		145
157	=item on_reset $term	146	=item on_reset $term
158		147
159	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
160	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
161	variables.	150	variables.
162		151
163	=item on_start $term	152	=item on_child_start $term, $pid
164		153
165	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.
166	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>.
167		160
168	=item on_sel_make $term, $eventtime	161	=item on_sel_make $term, $eventtime
169		162
170	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
171	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
…		…
178		171
179	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
180	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
181	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
182		175
183	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.
184		177
185	=item on_sel_extend $term	178	=item on_sel_extend $term
186		179
187	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
188	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
189	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
190	processing.	183	processing. This can happen multiple times, as long as the callback
		184	returns true, it will be called on every further click by the user and is
		185	supposed to enlarge the selection more and more, if possible.
191		186
192	See the F<selection> example extension.	187	See the F<selection> example extension.
193		188
194	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
195		190
196	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
197	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	193	show this many lines of scrollback.
199		194
200	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
201		196
…		…
205		200
206	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,
207	$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
208	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
209		204
210	=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
211		216
212	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
213	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
214	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
215	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,
216	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
217	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	}
218		233
219	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,
220	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
221	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.
222		240
223	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
224		242
225	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
226	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
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	245	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	246	might be very slow, however, as your hook is called for B<all> text being
229	output.	247	output.
230		248
		249	=item on_tt_write $term, $octets
		250
		251	Called whenever some data is written to the tty/pty and can be used to
		252	suppress or filter tty input.
		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
231	=item on_line_update $term, $row	261	=item on_line_update $term, $row
232		262
233	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
234	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
235	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,
…		…
242	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
243	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
244		274
245	=item on_refresh_begin $term	275	=item on_refresh_begin $term
246		276
247	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
248	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
249	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
250	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
251		281
252	=item on_refresh_end $term	282	=item on_refresh_end $term
253		283
254	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>.
255		285
256	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
257		287
258	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
259	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>
260	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
		291
		292	The event is simply the action string. This interface is going away in
		293	preference to the C<< ->register_keysym_action >> method.
		294
		295	=item on_resize_all_windows $term, $new_width, $new_height
		296
		297	Called just after the new window size has been calculated, but before
		298	windows are actually being resized or hints are being set. If this hook
		299	returns a true value, setting of the window hints is being skipped.
		300
		301	=item on_x_event $term, $event
		302
		303	Called on every X event received on the vt window (and possibly other
		304	windows). Should only be used as a last resort. Most event structure
		305	members are not passed.
		306
		307	=item on_root_event $term, $event
		308
		309	Like C<on_x_event>, but is called for events on the root window.
261		310
262	=item on_focus_in $term	311	=item on_focus_in $term
263		312
264	Called whenever the window gets the keyboard focus, before rxvt-unicode	313	Called whenever the window gets the keyboard focus, before rxvt-unicode
265	does focus in processing.	314	does focus in processing.
266		315
267	=item on_focus_out $term	316	=item on_focus_out $term
268		317
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	318	Called whenever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	319	focus out processing.
271		320
		321	=item on_configure_notify $term, $event
		322
		323	=item on_property_notify $term, $event
		324
272	=item on_key_press $term, $event, $octets	325	=item on_key_press $term, $event, $keysym, $octets
273		326
274	=item on_key_release $term, $event	327	=item on_key_release $term, $event, $keysym
275		328
276	=item on_button_press $term, $event	329	=item on_button_press $term, $event
277		330
278	=item on_button_release $term, $event	331	=item on_button_release $term, $event
279		332
…		…
281		334
282	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
283		336
284	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
285		338
286	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
287	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.
288		341
289	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
290	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
291	and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
292		345
293	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
294	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
295		348
296	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.
297		361
298	=back	362	=back
299		363
		364	=cut
		365
		366	package urxvt;
		367
		368	use utf8;
		369	use strict 'vars';
		370	use Carp ();
		371	use Scalar::Util ();
		372	use List::Util ();
		373
		374	our $VERSION = 1;
		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.
		378	our @HOOKNAME;
		379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		380	our %OPTION;
		381
		382	our $LIBDIR;
		383	our $RESNAME;
		384	our $RESCLASS;
		385	our $RXVTNAME;
		386
		387	our $NOCHAR = chr 0xffff;
		388
300	=head2 Variables in the C<urxvt> Package	389	=head2 Variables in the C<urxvt> Package
301		390
302	=over 4	391	=over 4
		392
		393	=item $urxvt::LIBDIR
		394
		395	The rxvt-unicode library directory, where, among other things, the perl
		396	modules and scripts are stored.
		397
		398	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		399
		400	The resource class and name rxvt-unicode uses to look up X resources.
		401
		402	=item $urxvt::RXVTNAME
		403
		404	The basename of the installed binaries, usually C<urxvt>.
303		405
304	=item $urxvt::TERM	406	=item $urxvt::TERM
305		407
306	The current terminal. This variable stores the current C<urxvt::term>	408	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	409	object, whenever a callback/hook is executing.
308		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
309	=back	427	=back
310		428
311	=head2 Functions in the C<urxvt> Package	429	=head2 Functions in the C<urxvt> Package
312		430
313	=over 4	431	=over 4
314		432
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322
323	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
324		434
325	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
326	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
327	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
328		439
329	=item urxvt::warn $string	440	=item urxvt::warn $string
330		441
331	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
332	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
333	that calls this function.	444	that calls this function.
334		445
335	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
336	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
337		448
338	=item $is_safe = urxvt::safe	449	Messages have a size limit of 1023 bytes currently.
339		450
340	Returns true when it is safe to do potentially unsafe things, such as	451	=item @terms = urxvt::termlist
341	evaluating perl code specified by the user. This is true when urxvt was	452
342	started setuid or setgid.	453	Returns all urxvt::term objects that exist in this process, regardless of
		454	whether they are started, being destroyed etc., so be careful. Only term
		455	objects that have perl extensions attached will be returned (because there
		456	is no urxvt::term object associated with others).
343		457
344	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
345		459
346	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
347		461
348	=item urxvt::CurrentTime	462	=item urxvt::CurrentTime
349		463
350	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	464	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
351	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	465	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
352	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
353		483
354	Various constants for use in X calls and event processing.	484	Various constants for use in X calls and event processing.
355		485
356	=back	486	=back
357		487
…		…
374		504
375	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
376		506
377	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
378		508
379	=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
380		511
381	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
382	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
383	the bitset.	514	the bitset.
384		515
…		…
386		517
387	=item $background = urxvt::GET_BASEBG $rend	518	=item $background = urxvt::GET_BASEBG $rend
388		519
389	Return the foreground/background colour index, respectively.	520	Return the foreground/background colour index, respectively.
390		521
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	522	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		523
393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	524	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		525
		526	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
394		527
395	Replace the foreground/background colour in the rendition mask with the	528	Replace the foreground/background colour in the rendition mask with the
396	specified one.	529	specified one.
397		530
398	=item $value = urxvt::GET_CUSTOM ($rend)	531	=item $value = urxvt::GET_CUSTOM $rend
399		532
400	Return the "custom" value: Every rendition has 5 bits for use by	533	Return the "custom" value: Every rendition has 5 bits for use by
401	extensions. They can be set and changed as you like and are initially	534	extensions. They can be set and changed as you like and are initially
402	zero.	535	zero.
403		536
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	537	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		538
406	Change the custom value.	539	Change the custom value.
407		540
408	=back	541	=back
409		542
410	=cut	543	=cut
411		544
412	package urxvt;
413
414	use utf8;
415	use strict;
416	use Scalar::Util ();
417	use List::Util ();
418
419	our $VERSION = 1;
420	our $TERM;
421	our @HOOKNAME;
422	our %OPTION;
423	our $LIBDIR;
424
425	BEGIN {	545	BEGIN {
426	urxvt->bootstrap;
427
428	# overwrite perl's warn	546	# overwrite perl's warn
429	*CORE::GLOBAL::warn = sub {	547	*CORE::GLOBAL::warn = sub {
430	my $msg = join "", @_;	548	my $msg = join "", @_;
431	$msg .= "\n"	549	$msg .= "\n"
432	unless $msg =~ /\n$/;	550	unless $msg =~ /\n$/;
433	urxvt::warn ($msg);	551	urxvt::warn ($msg);
434	};	552	};
435
436	delete $ENV{IFS};
437	delete $ENV{CDPATH};
438	delete $ENV{BASH_ENV};
439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
440	}	553	}
441		554
442	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_meta;
		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_meta;
		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
443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
444		618
445	sub verbose {	619	sub verbose {
446	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
448	}	622	}
449		623
450	# find on_xxx subs in the package and register them
451	# as hooks
452	sub register_package($) {
453	my ($pkg) = @_;
454
455	for my $htype (0.. $#HOOKNAME) {
456	my $name = $HOOKNAME[$htype];
457
458	my $ref = $pkg->can ("on_" . lc $name)
459	or next;
460
461	$TERM->{_hook}[$htype]{$pkg} = $ref;
462	$hook_count[$htype]++
463	or set_should_invoke $htype, 1;
464	}
465	}
466
467	my $extension_pkg = "extension0000";
468	my %extension_pkg;	624	my %extension_pkg;
469		625
470	# load a single script into its own package, once only	626	# load a single script into its own package, once only
471	sub extension_package($) {	627	sub extension_package($) {
472	my ($path) = @_;	628	my ($path) = @_;
473		629
474	$extension_pkg{$path} ||= do {	630	$extension_pkg{$path} ||= do {
475	my $pkg = "urxvt::" . ($extension_pkg++);	631	$path =~ /([^\/\\]+)$/;
		632	my $pkg = $1;
		633	$pkg =~ s/[^[:word:]]/_/g;
		634	$pkg = "urxvt::ext::$pkg";
476		635
477	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
478		639
479	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
480	or die "$path: $!";	641	or die "$path: $!";
481		642
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	643	my $source =
483	. "use base urxvt::term::proxy::;\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
484	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
486	. "\n};\n1";	647	. "\n};\n1";
487		648
		649	eval $source
488	eval $source or die "$path: $@";	650	or die "$path: $@";
489		651
490	$pkg	652	$pkg
491	}	653	}
492	}	654	}
493		655
…		…
496	# called by the rxvt core	658	# called by the rxvt core
497	sub invoke {	659	sub invoke {
498	local $TERM = shift;	660	local $TERM = shift;
499	my $htype = shift;	661	my $htype = shift;
500		662
501	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
		665
		666	my %ext_arg;
		667
503		668	{
504	my %want_ext;	669	my @init = @TERM_INIT;
		670	@TERM_INIT = ();
		671	$_->($TERM) for @init;
		672	my @pkg = @TERM_EXT;
		673	@TERM_EXT = ();
		674	$TERM->register_package ($_) for @pkg;
		675	}
505		676
		677	for (
		678	@{ delete $TERM->{perl_ext_3} },
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	679	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		680	) {
507	if ($_ eq "default") {	681	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	682	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
509	} elsif (/^-(.*)$/) {	683	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	684	delete $ext_arg{$1};
		685	} elsif (/^([^<]+)<(.*)>$/) {
		686	push @{ $ext_arg{$1} }, $2;
511	} else {	687	} else {
512	$want_ext{$_}++;	688	$ext_arg{$_} ||= [];
513	}	689	}
514	}	690	}
515		691
516	for my $ext (keys %want_ext) {	692	for my $ext (sort keys %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	693	my @files = grep -f $_, map "$_/$ext", @dirs;
518		694
519	if (@files) {	695	if (@files) {
520	register_package extension_package $files[0];	696	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
521	} else {	697	} else {
522	warn "perl extension '$ext' not found in perl library search path\n";	698	warn "perl extension '$ext' not found in perl library search path\n";
523	}	699	}
524	}	700	}
525		701
…		…
531		707
532	if (my $cb = $TERM->{_hook}[$htype]) {	708	if (my $cb = $TERM->{_hook}[$htype]) {
533	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	709	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
534	if $verbosity >= 10;	710	if $verbosity >= 10;
535		711
		712	for my $pkg (
		713	# this hook is only sent to the extension with the name
		714	# matching the first arg
		715	$htype == HOOK_KEYBOARD_DISPATCH
		716	? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
536	keys %$cb;	717	: keys %$cb
		718	) {
		719	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
		720	$retval ||= $retval_;
537		721
538	while (my ($pkg, $cb) = each %$cb) {
539	eval {
540	$retval = $cb->(
541	$TERM->{_pkg}{$pkg} ||= do {
542	my $proxy = bless { }, $pkg;
543	Scalar::Util::weaken ($proxy->{term} = $TERM);
544	$proxy
545	},
546	@_,
547	) and last;
548	};
549	if ($@) {	722	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	723	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	724	warn $@;
552	}	725	}
553	}	726	}
		727
		728	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		729	if $verbosity >= 11;
554	}	730	}
555		731
556	if ($htype == 1) { # DESTROY	732	if ($htype == HOOK_DESTROY) {
557	# remove hooks if unused
558	if (my $hook = $TERM->{_hook}) {
559	for my $htype (0..$#$hook) {
560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
561	or set_should_invoke $htype, 0;
562	}
563	}
564
565	# clear package objects	733	# clear package objects
566	%$_ = () for values %{ $TERM->{_pkg} };	734	%$_ = () for values %{ $TERM->{_pkg} };
567		735
568	# clear package	736	# clear package
569	%$TERM = ();	737	%$TERM = ();
570	}	738	}
571		739
572	$retval	740	$retval
573	}	741	}
574		742
575	# urxvt::term::proxy	743	sub SET_COLOR($$$) {
		744	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		745	}
576		746
577	sub urxvt::term::proxy::AUTOLOAD {	747	sub rend2mask {
578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	748	no strict 'refs';
		749	my ($str, $mask) = (@_, 0);
		750	my %color = ( fg => undef, bg => undef );
		751	my @failed;
		752	for my $spec ( split /\s+/, $str ) {
		753	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		754	$color{lc($1)} = $2;
		755	} else {
		756	my $neg = $spec =~ s/^[-^]//;
		757	unless ( exists &{"RS_$spec"} ) {
		758	push @failed, $spec;
		759	next;
		760	}
		761	my $cur = &{"RS_$spec"};
		762	if ( $neg ) {
		763	$mask &= ~$cur;
		764	} else {
		765	$mask |= $cur;
		766	}
		767	}
		768	}
		769	($mask, @color{qw(fg bg)}, \@failed)
		770	}
		771
		772	package urxvt::term::extension;
		773
		774	=head2 The C<urxvt::term::extension> class
		775
		776	Each extension attached to a terminal object is represented by
		777	a C<urxvt::term::extension> object.
		778
		779	You can use these objects, which are passed to all callbacks to store any
		780	state related to the terminal and extension instance.
		781
		782	The methods (And data members) documented below can be called on extension
		783	objects, in addition to call methods documented for the <urxvt::term>
		784	class.
		785
		786	=over 4
		787
		788	=item $urxvt_term = $self->{term}
		789
		790	Returns the C<urxvt::term> object associated with this instance of the
		791	extension. This member I<must not> be changed in any way.
		792
		793	=cut
		794
		795	our $AUTOLOAD;
		796
		797	sub AUTOLOAD {
		798	$AUTOLOAD =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	799	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		800
581	eval qq{	801	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	802	sub $AUTOLOAD {
583	my \$proxy = shift;	803	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	804	\$proxy->{term}->$1 (\@_)
585	}	805	}
586	1	806	1
587	} or die "FATAL: unable to compile method forwarder: $@";	807	} or die "FATAL: unable to compile method forwarder: $@";
588		808
589	goto &$urxvt::term::proxy::AUTOLOAD;	809	goto &$AUTOLOAD;
590	}	810	}
591		811
592	sub urxvt::term::proxy::DESTROY {	812	sub DESTROY {
593	# nop	813	# nop
594	}	814	}
595		815
596	# urxvt::destroy_hook	816	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
597		817
598	sub urxvt::destroy_hook::DESTROY {	818	sub urxvt::destroy_hook::DESTROY {
599	${$_[0]}->();	819	${$_[0]}->();
600	}	820	}
601		821
602	sub urxvt::destroy_hook(&) {	822	sub urxvt::destroy_hook(&) {
603	bless \shift, urxvt::destroy_hook::	823	bless \shift, urxvt::destroy_hook::
604	}	824	}
605		825
		826	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		827
		828	Dynamically enable the given hooks (named without the C<on_> prefix) for
		829	this extension, replacing any hook previously installed via C<enable> in
		830	this extension.
		831
		832	This is useful when you want to overwrite time-critical hooks only
		833	temporarily.
		834
		835	To install additional callbacks for the same hook, you can use the C<on>
		836	method of the C<urxvt::term> class.
		837
		838	=item $self->disable ($hook_name[, $hook_name..])
		839
		840	Dynamically disable the given hooks.
		841
		842	=cut
		843
		844	sub enable {
		845	my ($self, %hook) = @_;
		846	my $pkg = $self->{_pkg};
		847
		848	while (my ($name, $cb) = each %hook) {
		849	my $htype = $HOOKTYPE{uc $name};
		850	defined $htype
		851	or Carp::croak "unsupported hook type '$name'";
		852
		853	$self->set_should_invoke ($htype, +1)
		854	unless exists $self->{term}{_hook}[$htype]{$pkg};
		855
		856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		857	}
		858	}
		859
		860	sub disable {
		861	my ($self, @hook) = @_;
		862	my $pkg = $self->{_pkg};
		863
		864	for my $name (@hook) {
		865	my $htype = $HOOKTYPE{uc $name};
		866	defined $htype
		867	or Carp::croak "unsupported hook type '$name'";
		868
		869	$self->set_should_invoke ($htype, -1)
		870	if delete $self->{term}{_hook}[$htype]{$pkg};
		871	}
		872	}
		873
		874	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		875
		876	Similar to the C<enable> enable, but installs additional callbacks for
		877	the given hook(s) (that is, it doesn't replace existing callbacks), and
		878	returns a guard object. When the guard object is destroyed the callbacks
		879	are disabled again.
		880
		881	=cut
		882
		883	sub urxvt::extension::on_disable::DESTROY {
		884	my $disable = shift;
		885
		886	my $term = delete $disable->{""};
		887
		888	while (my ($htype, $id) = each %$disable) {
		889	delete $term->{_hook}[$htype]{$id};
		890	$term->set_should_invoke ($htype, -1);
		891	}
		892	}
		893
		894	sub on {
		895	my ($self, %hook) = @_;
		896
		897	my $term = $self->{term};
		898
		899	my %disable = ( "" => $term );
		900
		901	while (my ($name, $cb) = each %hook) {
		902	my $htype = $HOOKTYPE{uc $name};
		903	defined $htype
		904	or Carp::croak "unsupported hook type '$name'";
		905
		906	$term->set_should_invoke ($htype, +1);
		907	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		908	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		909	}
		910
		911	bless \%disable, "urxvt::extension::on_disable"
		912	}
		913
		914	=item $self->x_resource ($pattern)
		915
		916	=item $self->x_resource_boolean ($pattern)
		917
		918	These methods support an additional C<%> prefix when called on an
		919	extension object - see the description of these methods in the
		920	C<urxvt::term> class for details.
		921
		922	=cut
		923
		924	sub x_resource {
		925	my ($self, $name) = @_;
		926	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		927	$self->{term}->x_resource ($name)
		928	}
		929
		930	sub x_resource_boolean {
		931	my ($self, $name) = @_;
		932	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		933	$self->{term}->x_resource_boolean ($name)
		934	}
		935
		936	=back
		937
		938	=cut
		939
606	package urxvt::anyevent;	940	package urxvt::anyevent;
607		941
608	=head2 The C<urxvt::anyevent> Class	942	=head2 The C<urxvt::anyevent> Class
609		943
610	The sole purpose of this class is to deliver an interface to the	944	The sole purpose of this class is to deliver an interface to the
611	C<AnyEvent> module - any module using it will work inside urxvt without	945	C<AnyEvent> module - any module using it will work inside urxvt without
612	further work. The only exception is that you cannot wait on condition	946	further programming. The only exception is that you cannot wait on
613	variables, but non-blocking condvar use is ok. What this means is that you	947	condition variables, but non-blocking condvar use is ok.
614	cannot use blocking APIs, but the non-blocking variant should work.
615		948
616	=cut	949	In practical terms this means is that you cannot use blocking APIs, but
		950	the non-blocking variant should work.
617		951
		952	=cut
		953
618	our $VERSION = 1;	954	our $VERSION = '5.23';
619		955
620	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	956	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
621	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	957	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
622		958
623	sub timer {	959	sub timer {
…		…
625		961
626	my $cb = $arg{cb};	962	my $cb = $arg{cb};
627		963
628	urxvt::timer	964	urxvt::timer
629	->new	965	->new
630	->start (urxvt::NOW + $arg{after})	966	->after ($arg{after}, $arg{interval})
631	->cb (sub {	967	->cb ($arg{interval} ? $cb : sub {
632	$_[0]->stop; # need to cancel manually	968	$_[0]->stop; # need to cancel manually
633	$cb->();	969	$cb->();
634	})	970	})
635	}	971	}
636		972
637	sub io {	973	sub io {
638	my ($class, %arg) = @_;	974	my ($class, %arg) = @_;
639		975
640	my $cb = $arg{cb};	976	my $cb = $arg{cb};
		977	my $fd = fileno $arg{fh};
		978	defined $fd or $fd = $arg{fh};
641		979
642	bless [$arg{fh}, urxvt::iow	980	bless [$arg{fh}, urxvt::iow
643	->new	981	->new
644	->fd (fileno $arg{fh})	982	->fd ($fd)
645	->events (($arg{poll} =~ /r/ ? 1 : 0)	983	->events (($arg{poll} =~ /r/ ? 1 : 0)
646	| ($arg{poll} =~ /w/ ? 2 : 0))	984	| ($arg{poll} =~ /w/ ? 2 : 0))
647	->start	985	->start
648	->cb (sub {	986	->cb ($cb)
649	$cb->(($_[1] & 1 ? 'r' : '')
650	. ($_[1] & 2 ? 'w' : ''));
651	})],
652	urxvt::anyevent::	987	], urxvt::anyevent::
		988	}
		989
		990	sub idle {
		991	my ($class, %arg) = @_;
		992
		993	my $cb = $arg{cb};
		994
		995	urxvt::iw
		996	->new
		997	->start
		998	->cb ($cb)
		999	}
		1000
		1001	sub child {
		1002	my ($class, %arg) = @_;
		1003
		1004	my $cb = $arg{cb};
		1005
		1006	urxvt::pw
		1007	->new
		1008	->start ($arg{pid})
		1009	->cb (sub {
		1010	$_[0]->stop; # need to cancel manually
		1011	$cb->($_[0]->rpid, $_[0]->rstatus);
		1012	})
653	}	1013	}
654		1014
655	sub DESTROY {	1015	sub DESTROY {
656	$_[0][1]->stop;	1016	$_[0][1]->stop;
657	}	1017	}
658		1018
659	sub condvar {	1019	# only needed for AnyEvent < 6 compatibility
660	bless \my $flag, urxvt::anyevent::condvar::	1020	sub one_event {
661	}
662
663	sub urxvt::anyevent::condvar::broadcast {
664	${$_[0]}++;
665	}
666
667	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {
669	require Carp;
670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	1021	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1022	}
		1023
		1024	package urxvt::term;
		1025
		1026	=head2 The C<urxvt::term> Class
		1027
		1028	=over 4
		1029
		1030	=cut
		1031
		1032	# find on_xxx subs in the package and register them
		1033	# as hooks
		1034	sub register_package {
		1035	my ($self, $pkg, $argv) = @_;
		1036
		1037	no strict 'refs';
		1038
		1039	urxvt::verbose 6, "register package $pkg to $self";
		1040
		1041	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1042
		1043	my $proxy = bless {
		1044	_pkg => $pkg,
		1045	_name => ${"$pkg\::_NAME"}, # hackish
		1046	argv => $argv,
		1047	}, $pkg;
		1048	Scalar::Util::weaken ($proxy->{term} = $self);
		1049
		1050	$self->{_pkg}{$pkg} = $proxy;
		1051
		1052	for my $name (@HOOKNAME) {
		1053	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1054	$proxy->enable ($name => $ref);
		1055	}
671	}	1056	}
672	}	1057	}
673		1058
674	package urxvt::term;	1059	sub perl_libdirs {
		1060	map { split /:/ }
		1061	$_[0]->resource ("perl_lib"),
		1062	$ENV{URXVT_PERL_LIB},
		1063	"$ENV{HOME}/.urxvt/ext",
		1064	"$LIBDIR/perl"
		1065	}
675		1066
676	=head2 The C<urxvt::term> Class	1067	sub scan_meta {
		1068	my ($self) = @_;
		1069	my @libdirs = perl_libdirs $self;
677		1070
678	=over 4	1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1072
		1073	my %meta;
		1074
		1075	$self->{meta_libdirs} = join "\x00", @libdirs;
		1076	$self->{meta} = \%meta;
		1077
		1078	for my $dir (reverse @libdirs) {
		1079	opendir my $fh, $dir
		1080	or next;
		1081	for my $ext (readdir $fh) {
		1082	$ext !~ /^\./
		1083	and open my $fh, "<", "$dir/$ext"
		1084	or next;
		1085
		1086	while (<$fh>) {
		1087	if (/^#:META:X_RESOURCE:(.*)/) {
		1088	my ($pattern, $type, $desc) = split /:/, $1;
		1089	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1090	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1091	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1092	} else {
		1093	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1094	}
		1095	} elsif (/^\s*(?:#|$)/) {
		1096	# skip other comments and empty lines
		1097	} else {
		1098	last; # stop parsing on first non-empty non-comment line
		1099	}
		1100	}
		1101	}
		1102	}
		1103	}
		1104
		1105	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1106
		1107	Creates a new terminal, very similar as if you had started it with system
		1108	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1109	hash which defines the environment of the new terminal.
		1110
		1111	Croaks (and probably outputs an error message) if the new instance
		1112	couldn't be created. Returns C<undef> if the new instance didn't
		1113	initialise perl, and the terminal object otherwise. The C<init> and
		1114	C<start> hooks will be called before this call returns, and are free to
		1115	refer to global data (which is race free).
		1116
		1117	=cut
		1118
		1119	sub new {
		1120	my ($class, $env, @args) = @_;
		1121
		1122	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1123	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1124
		1125	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1126	}
679		1127
680	=item $term->destroy	1128	=item $term->destroy
681		1129
682	Destroy the terminal object (close the window, free resources etc.).	1130	Destroy the terminal object (close the window, free resources
		1131	etc.). Please note that urxvt will not exit as long as any event
		1132	watchers (timers, io watchers) are still active.
		1133
		1134	=item $term->exec_async ($cmd[, @args])
		1135
		1136	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1137	("starts") programs in the background. This function takes care of setting
		1138	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1139	be preferred over explicit calls to C<exec> or C<system>.
		1140
		1141	Returns the pid of the subprocess or C<undef> on error.
		1142
		1143	=cut
		1144
		1145	sub exec_async {
		1146	my $self = shift;
		1147
		1148	my $pid = fork;
		1149
		1150	return $pid
		1151	if !defined $pid or $pid;
		1152
		1153	%ENV = %{ $self->env };
		1154
		1155	exec @_;
		1156	urxvt::_exit 255;
		1157	}
683		1158
684	=item $isset = $term->option ($optval[, $set])	1159	=item $isset = $term->option ($optval[, $set])
685		1160
686	Returns true if the option specified by C<$optval> is enabled, and	1161	Returns true if the option specified by C<$optval> is enabled, and
687	optionally change it. All option values are stored by name in the hash	1162	optionally change it. All option values are stored by name in the hash
688	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1163	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
689		1164
690	Here is a a likely non-exhaustive list of option names, please see the	1165	Here is a likely non-exhaustive list of option names, please see the
691	source file F</src/optinc.h> to see the actual list:	1166	source file F</src/optinc.h> to see the actual list:
692		1167
693	borderLess console cursorBlink cursorUnderline hold iconic insecure	1168	borderLess buffered console cursorBlink cursorUnderline hold iconic
694	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1169	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1170	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
695	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1171	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
696	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1172	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
697	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1173	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
698	tripleclickwords utmpInhibit visualBell	1174	urgentOnBell utmpInhibit visualBell
699		1175
700	=item $value = $term->resource ($name[, $newval])	1176	=item $value = $term->resource ($name[, $newval])
701		1177
702	Returns the current resource value associated with a given name and	1178	Returns the current resource value associated with a given name and
703	optionally sets a new value. Setting values is most useful in the C<init>	1179	optionally sets a new value. Setting values is most useful in the C<init>
…		…
712	likely change).	1188	likely change).
713		1189
714	Please note that resource strings will currently only be freed when the	1190	Please note that resource strings will currently only be freed when the
715	terminal is destroyed, so changing options frequently will eat memory.	1191	terminal is destroyed, so changing options frequently will eat memory.
716		1192
717	Here is a a likely non-exhaustive list of resource names, not all of which	1193	Here is a likely non-exhaustive list of resource names, not all of which
718	are supported in every build, please see the source file F</src/rsinc.h>	1194	are supported in every build, please see the source file F</src/rsinc.h>
719	to see the actual list:	1195	to see the actual list:
720		1196
721	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1197	answerbackstring backgroundPixmap backspace_key blurradius
722	borderLess color cursorBlink cursorUnderline cutchars delete_key	1198	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
723	display_name embed ext_bwidth fade font geometry hold iconName	1199	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
724	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1200	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1201	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
725	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1202	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
726	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1203	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
727	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1204	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
728	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1205	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
729	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1206	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
730	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1207	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
731	shade term_name title transparent transparent_all tripleclickwords	1208	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1209	term_name title transient_for transparent tripleclickwords urgentOnBell
732	utmpInhibit visualBell	1210	utmpInhibit visualBell
733		1211
734	=cut	1212	=cut
735		1213
736	sub resource($$;$) {	1214	sub resource($$;$) {
737	my ($self, $name) = (shift, shift);	1215	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1216	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	1217	goto &urxvt::term::_resource
740	}	1218	}
		1219
		1220	=item $value = $term->x_resource ($pattern)
		1221
		1222	Returns the X-Resource for the given pattern, excluding the program or
		1223	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1224	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1225	resource with that pattern exists.
		1226
		1227	Extensions that define extra resource or command line arguments also need
		1228	to call this method to access their values.
		1229
		1230	If the method is called on an extension object (basically, from an
		1231	extension), then the special prefix C<%.> will be replaced by the name of
		1232	the extension and a dot, and the lone string C<%> will be replaced by the
		1233	extension name itself. This makes it possible to code extensions so you
		1234	can rename them and get a new set of commandline switches and resources
		1235	without having to change the actual code.
		1236
		1237	This method should only be called during the C<on_start> hook, as there is
		1238	only one resource database per display, and later invocations might return
		1239	the wrong resources.
		1240
		1241	=item $value = $term->x_resource_boolean ($pattern)
		1242
		1243	Like C<x_resource>, above, but interprets the string value as a boolean
		1244	and returns C<1> for true values, C<0> for false values and C<undef> if
		1245	the resource or option isn't specified.
		1246
		1247	You should always use this method to parse boolean resources.
		1248
		1249	=cut
		1250
		1251	sub x_resource_boolean {
		1252	my $res = &x_resource;
		1253
		1254	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1255	}
		1256
		1257	=item $success = $term->bind_action ($key, $octets)
		1258
		1259	Adds a key binding exactly as specified via a resource. See the
		1260	C<keysym> resource in the urxvt(1) manpage.
741		1261
742	=item $rend = $term->rstyle ([$new_rstyle])	1262	=item $rend = $term->rstyle ([$new_rstyle])
743		1263
744	Return and optionally change the current rendition. Text that is output by	1264	Return and optionally change the current rendition. Text that is output by
745	the terminal application will use this style.	1265	the terminal application will use this style.
…		…
753		1273
754	=item ($row, $col) = $term->selection_beg ([$row, $col])	1274	=item ($row, $col) = $term->selection_beg ([$row, $col])
755		1275
756	=item ($row, $col) = $term->selection_end ([$row, $col])	1276	=item ($row, $col) = $term->selection_end ([$row, $col])
757		1277
758	Return the current values of the selection mark, begin or end positions,	1278	Return the current values of the selection mark, begin or end positions.
759	and optionally set them to new values.
760		1279
		1280	When arguments are given, then the selection coordinates are set to
		1281	C<$row> and C<$col>, and the selection screen is set to the current
		1282	screen.
		1283
		1284	=item $screen = $term->selection_screen ([$screen])
		1285
		1286	Returns the current selection screen, and then optionally sets it.
		1287
		1288	=item $term->selection_make ($eventtime[, $rectangular])
		1289
		1290	Tries to make a selection as set by C<selection_beg> and
		1291	C<selection_end>. If C<$rectangular> is true (default: false), a
		1292	rectangular selection will be made. This is the preferred function to make
		1293	a selection.
		1294
761	=item $success = $term->selection_grab ($eventtime)	1295	=item $success = $term->selection_grab ($eventtime[, $clipboard])
762		1296
763	Try to request the primary selection from the server (for example, as set	1297	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
764	by the next method).	1298	true) selection from the server. The corresponding text can be set
		1299	with the next method. No visual feedback will be given. This function
		1300	is mostly useful from within C<on_sel_grab> hooks.
765		1301
766	=item $oldtext = $term->selection ([$newtext])	1302	=item $oldtext = $term->selection ([$newtext, $clipboard])
767		1303
768	Return the current selection text and optionally replace it by C<$newtext>.	1304	Return the current selection (clipboard if C<$clipboard> is true) text
		1305	and optionally replace it by C<$newtext>.
769		1306
		1307	=item $term->selection_clear ([$clipboard])
		1308
		1309	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1310
770	#=item $term->overlay ($x, $y, $text)	1311	=item $term->overlay_simple ($x, $y, $text)
771	#	1312
772	#Create a simple multi-line overlay box. See the next method for details.	1313	Create a simple multi-line overlay box. See the next method for details.
773	#	1314
774	#=cut	1315	=cut
775	#	1316
776	#sub urxvt::term::scr_overlay {	1317	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	1318	my ($self, $x, $y, $text) = @_;
778	#	1319
779	# my @lines = split /\n/, $text;	1320	my @lines = split /\n/, $text;
780	#	1321
781	# my $w = 0;	1322	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	1323
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1324	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1325	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	1326
		1327	$overlay
		1328	}
789		1329
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1330	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		1331
792	Create a new (empty) overlay at the given position with the given	1332	Create a new (empty) overlay at the given position with the given
793	width/height. C<$rstyle> defines the initial rendition style	1333	width/height. C<$rstyle> defines the initial rendition style
…		…
804		1344
805	The methods currently supported on C<urxvt::overlay> objects are:	1345	The methods currently supported on C<urxvt::overlay> objects are:
806		1346
807	=over 4	1347	=over 4
808		1348
809	=item $overlay->set ($x, $y, $text, $rend)	1349	=item $overlay->set ($x, $y, $text[, $rend])
810		1350
811	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1351	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
812	text in rxvt-unicode's special encoding and an array of rendition values	1352	text in rxvt-unicode's special encoding and an array of rendition values
813	at a specific position inside the overlay.	1353	at a specific position inside the overlay.
		1354
		1355	If C<$rend> is missing, then the rendition will not be changed.
814		1356
815	=item $overlay->hide	1357	=item $overlay->hide
816		1358
817	If visible, hide the overlay, but do not destroy it.	1359	If visible, hide the overlay, but do not destroy it.
818		1360
…		…
860		1402
861	=item $string = $term->locale_decode ($octets)	1403	=item $string = $term->locale_decode ($octets)
862		1404
863	Convert the given locale-encoded octets into a perl string.	1405	Convert the given locale-encoded octets into a perl string.
864		1406
		1407	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1408
		1409	XORs the rendition values in the given span with the provided value
		1410	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1411	refresh hooks to provide effects similar to the selection.
		1412
		1413	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1414
		1415	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1416	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1417	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1418	it instead. Both styles I<MUST NOT> contain font styles.
		1419
		1420	=item $term->scr_bell
		1421
		1422	Ring the bell!
		1423
865	=item $term->scr_add_lines ($string)	1424	=item $term->scr_add_lines ($string)
866		1425
867	Write the given text string to the screen, as if output by the application	1426	Write the given text string to the screen, as if output by the application
868	running inside the terminal. It may not contain command sequences (escape	1427	running inside the terminal. It may not contain command sequences (escape
869	codes), but is free to use line feeds, carriage returns and tabs. The	1428	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
871		1430
872	Normally its not a good idea to use this function, as programs might be	1431	Normally its not a good idea to use this function, as programs might be
873	confused by changes in cursor position or scrolling. Its useful inside a	1432	confused by changes in cursor position or scrolling. Its useful inside a
874	C<on_add_lines> hook, though.	1433	C<on_add_lines> hook, though.
875		1434
		1435	=item $term->scr_change_screen ($screen)
		1436
		1437	Switch to given screen - 0 primary, 1 secondary.
		1438
876	=item $term->cmd_parse ($octets)	1439	=item $term->cmd_parse ($octets)
877		1440
878	Similar to C<scr_add_lines>, but the argument must be in the	1441	Similar to C<scr_add_lines>, but the argument must be in the
879	locale-specific encoding of the terminal and can contain command sequences	1442	locale-specific encoding of the terminal and can contain command sequences
880	(escape codes) that will be interpreted.	1443	(escape codes) that will be interpreted.
881		1444
882	=item $term->tt_write ($octets)	1445	=item $term->tt_write ($octets)
883		1446
884	Write the octets given in C<$data> to the tty (i.e. as program input). To	1447	Write the octets given in C<$octets> to the tty (i.e. as program input). To
885	pass characters instead of octets, you should convert your strings first	1448	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	1449	to the locale-specific encoding using C<< $term->locale_encode >>.
887		1450
		1451	=item $term->tt_paste ($octets)
		1452
		1453	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1454	CR and bracketing the data with control sequences if bracketed paste mode
		1455	is set.
		1456
		1457	=item $old_events = $term->pty_ev_events ([$new_events])
		1458
		1459	Replaces the event mask of the pty watcher by the given event mask. Can
		1460	be used to suppress input and output handling to the pty/tty. See the
		1461	description of C<< urxvt::timer->events >>. Make sure to always restore
		1462	the previous value.
		1463
		1464	=item $fd = $term->pty_fd
		1465
		1466	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1467	is used.
		1468
888	=item $windowid = $term->parent	1469	=item $windowid = $term->parent
889		1470
890	Return the window id of the toplevel window.	1471	Return the window id of the toplevel window.
891		1472
892	=item $windowid = $term->vt	1473	=item $windowid = $term->vt
893		1474
894	Return the window id of the terminal window.	1475	Return the window id of the terminal window.
895		1476
		1477	=item $term->vt_emask_add ($x_event_mask)
		1478
		1479	Adds the specified events to the vt event mask. Useful e.g. when you want
		1480	to receive pointer events all the times:
		1481
		1482	$term->vt_emask_add (urxvt::PointerMotionMask);
		1483
		1484	=item $term->set_urgency ($set)
		1485
		1486	Enable/disable the urgency hint on the toplevel window.
		1487
		1488	=item $term->focus_in
		1489
		1490	=item $term->focus_out
		1491
		1492	=item $term->key_press ($state, $keycode[, $time])
		1493
		1494	=item $term->key_release ($state, $keycode[, $time])
		1495
		1496	Deliver various fake events to to terminal.
		1497
896	=item $window_width = $term->width	1498	=item $window_width = $term->width
897		1499
898	=item $window_height = $term->height	1500	=item $window_height = $term->height
899		1501
900	=item $font_width = $term->fwidth	1502	=item $font_width = $term->fwidth
…		…
913		1515
914	=item $max_scrollback = $term->saveLines	1516	=item $max_scrollback = $term->saveLines
915		1517
916	=item $nrow_plus_saveLines = $term->total_rows	1518	=item $nrow_plus_saveLines = $term->total_rows
917		1519
918	=item $lines_in_scrollback = $term->nsaved	1520	=item $topmost_scrollback_row = $term->top_row
919		1521
920	Return various integers describing terminal characteristics.	1522	Return various integers describing terminal characteristics.
		1523
		1524	=item $x_display = $term->display_id
		1525
		1526	Return the DISPLAY used by rxvt-unicode.
		1527
		1528	=item $lc_ctype = $term->locale
		1529
		1530	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1531
		1532	=item $env = $term->env
		1533
		1534	Returns a copy of the environment in effect for the terminal as a hashref
		1535	similar to C<\%ENV>.
		1536
		1537	=item @envv = $term->envv
		1538
		1539	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1540
		1541	=item @argv = $term->argv
		1542
		1543	Return the argument vector as this terminal, similar to @ARGV, but
		1544	includes the program name as first element.
		1545
		1546	=cut
		1547
		1548	sub env {
		1549	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1550	}
921		1551
922	=item $modifiermask = $term->ModLevel3Mask	1552	=item $modifiermask = $term->ModLevel3Mask
923		1553
924	=item $modifiermask = $term->ModMetaMask	1554	=item $modifiermask = $term->ModMetaMask
925		1555
926	=item $modifiermask = $term->ModNumLockMask	1556	=item $modifiermask = $term->ModNumLockMask
927		1557
928	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1558	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
929	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1559	AltGr), the meta key (often Alt) and the num lock key, if applicable.
930		1560
		1561	=item $screen = $term->current_screen
		1562
		1563	Returns the currently displayed screen (0 primary, 1 secondary).
		1564
		1565	=item $cursor_is_hidden = $term->hidden_cursor
		1566
		1567	Returns whether the cursor is currently hidden or not.
		1568
931	=item $view_start = $term->view_start ([$newvalue])	1569	=item $view_start = $term->view_start ([$newvalue])
932		1570
933	Returns the negative row number of the topmost line. Minimum value is	1571	Returns the row number of the topmost displayed line. Maximum value is
934	C<0>, which displays the normal terminal contents. Larger values scroll	1572	C<0>, which displays the normal terminal contents. Lower values scroll
935	this many lines into the scrollback buffer.	1573	this many lines into the scrollback buffer.
936		1574
937	=item $term->want_refresh	1575	=item $term->want_refresh
938		1576
939	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1577	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
942		1580
943	Used after changing terminal contents to display them.	1581	Used after changing terminal contents to display them.
944		1582
945	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1583	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
946		1584
947	Returns the text of the entire row with number C<$row_number>. Row C<0>	1585	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
948	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1586	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
949	terminal line. The scrollback buffer starts at line C<-1> and extends to
950	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1587	terminal line. Nothing will be returned if a nonexistent line
951	is requested.	1588	is requested.
952		1589
953	If C<$new_text> is specified, it will replace characters in the current	1590	If C<$new_text> is specified, it will replace characters in the current
954	line, starting at column C<$start_col> (default C<0>), which is useful	1591	line, starting at column C<$start_col> (default C<0>), which is useful
955	to replace only parts of a line. The font index in the rendition will	1592	to replace only parts of a line. The font index in the rendition will
956	automatically be updated.	1593	automatically be updated.
957		1594
958	C<$text> is in a special encoding: tabs and wide characters that use more	1595	C<$text> is in a special encoding: tabs and wide characters that use more
959	than one cell when displayed are padded with urxvt::NOCHAR characters	1596	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
960	(C<chr 65535>). Characters with combining characters and other characters	1597	characters. Characters with combining characters and other characters that
961	that do not fit into the normal tetx encoding will be replaced with	1598	do not fit into the normal text encoding will be replaced with characters
962	characters in the private use area.	1599	in the private use area.
963		1600
964	You have to obey this encoding when changing text. The advantage is	1601	You have to obey this encoding when changing text. The advantage is
965	that C<substr> and similar functions work on screen cells and not on	1602	that C<substr> and similar functions work on screen cells and not on
966	characters.	1603	characters.
967		1604
…		…
1018	Return the row number of the first/last row of the line, respectively.	1655	Return the row number of the first/last row of the line, respectively.
1019		1656
1020	=item $offset = $line->offset_of ($row, $col)	1657	=item $offset = $line->offset_of ($row, $col)
1021		1658
1022	Returns the character offset of the given row|col pair within the logical	1659	Returns the character offset of the given row|col pair within the logical
1023	line.	1660	line. Works for rows outside the line, too, and returns corresponding
		1661	offsets outside the string.
1024		1662
1025	=item ($row, $col) = $line->coord_of ($offset)	1663	=item ($row, $col) = $line->coord_of ($offset)
1026		1664
1027	Translates a string offset into terminal coordinates again.	1665	Translates a string offset into terminal coordinates again.
1028		1666
…		…
1050	}	1688	}
1051		1689
1052	sub urxvt::line::t {	1690	sub urxvt::line::t {
1053	my ($self) = @_;	1691	my ($self) = @_;
1054		1692
1055	if (@_ > 1)	1693	if (@_ > 1) {
1056	{
1057	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1694	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1058	for $self->{beg} .. $self->{end};	1695	for $self->{beg} .. $self->{end};
1059	}	1696	}
1060		1697
1061	defined wantarray &&	1698	defined wantarray &&
1062	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1699	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1063	0, $self->{len}	1700	0, $self->{len}
1064	}	1701	}
1065		1702
1066	sub urxvt::line::r {	1703	sub urxvt::line::r {
1067	my ($self) = @_;	1704	my ($self) = @_;
1068		1705
1069	if (@_ > 1)	1706	if (@_ > 1) {
1070	{
1071	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1707	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1072	for $self->{beg} .. $self->{end};	1708	for $self->{beg} .. $self->{end};
1073	}	1709	}
1074		1710
1075	if (defined wantarray) {	1711	if (defined wantarray) {
1076	my $rend = [	1712	my $rend = [
1077	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1713	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1078	];	1714	];
…		…
1110	where one character corresponds to one screen cell. See	1746	where one character corresponds to one screen cell. See
1111	C<< $term->ROW_t >> for details.	1747	C<< $term->ROW_t >> for details.
1112		1748
1113	=item $string = $term->special_decode $text	1749	=item $string = $term->special_decode $text
1114		1750
1115	Converts rxvt-unicodes text reprsentation into a perl string. See	1751	Converts rxvt-unicodes text representation into a perl string. See
1116	C<< $term->ROW_t >> for details.	1752	C<< $term->ROW_t >> for details.
1117		1753
1118	=item $success = $term->grab_button ($button, $modifiermask)	1754	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1119		1755
		1756	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1757
1120	Registers a synchronous button grab. See the XGrabButton manpage.	1758	Register/unregister a synchronous button grab. See the XGrabButton
		1759	manpage.
1121		1760
1122	=item $success = $term->grab ($eventtime[, $sync])	1761	=item $success = $term->grab ($eventtime[, $sync])
1123		1762
1124	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1763	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1125	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1764	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1126		1765
1127	=item $term->allow_events_async	1766	=item $term->allow_events_async
1128		1767
1129	Calls XAllowEvents with AsyncBoth for the most recent grab.	1768	Calls XAllowEvents with AsyncBoth for the most recent grab.
1130		1769
…		…
1137	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1776	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1138	recent grab.	1777	recent grab.
1139		1778
1140	=item $term->ungrab	1779	=item $term->ungrab
1141		1780
1142	Calls XUngrab for the most recent grab. Is called automatically on	1781	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1143	evaluation errors, as it is better to lose the grab in the error case as	1782	evaluation errors, as it is better to lose the grab in the error case as
1144	the session.	1783	the session.
		1784
		1785	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1786
		1787	=item $atom_name = $term->XGetAtomName ($atom)
		1788
		1789	=item @atoms = $term->XListProperties ($window)
		1790
		1791	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1792
		1793	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1794
		1795	=item $term->XDeleteProperty ($window, $property)
		1796
		1797	=item $window = $term->DefaultRootWindow
		1798
		1799	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1800
		1801	=item $term->XMapWindow ($window)
		1802
		1803	=item $term->XUnmapWindow ($window)
		1804
		1805	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1806
		1807	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1808
		1809	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1810
		1811	=item $keysym = $term->XStringToKeysym ($string)
		1812
		1813	=item $string = $term->XKeysymToString ($keysym)
		1814
		1815	Various X or X-related functions. The C<$term> object only serves as
		1816	the source of the display, otherwise those functions map more-or-less
		1817	directly onto the X functions of the same name.
1145		1818
1146	=back	1819	=back
1147		1820
1148	=cut	1821	=cut
1149		1822
…		…
1165	$item->{render} ||= sub { $_[0]{text} };	1838	$item->{render} ||= sub { $_[0]{text} };
1166		1839
1167	push @{ $self->{item} }, $item;	1840	push @{ $self->{item} }, $item;
1168	}	1841	}
1169		1842
1170	sub add_separator {	1843	=item $popup->add_title ($title)
1171	my ($self, $sep) = @_;
1172		1844
1173	$sep ||= "═";	1845	Adds a non-clickable title to the popup.
1174		1846
1175	$self->add_item ({	1847	=cut
1176	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1177	text => "",
1178	render => sub { $sep x $urxvt::TERM->ncol },
1179	activate => sub { },
1180	});
1181	}
1182		1848
1183	sub add_title {	1849	sub add_title {
1184	my ($self, $title) = @_;	1850	my ($self, $title) = @_;
1185		1851
1186	$self->add_item ({	1852	$self->add_item ({
…		…
1188	text => $title,	1854	text => $title,
1189	activate => sub { },	1855	activate => sub { },
1190	});	1856	});
1191	}	1857	}
1192		1858
		1859	=item $popup->add_separator ([$sepchr])
		1860
		1861	Creates a separator, optionally using the character given as C<$sepchr>.
		1862
		1863	=cut
		1864
		1865	sub add_separator {
		1866	my ($self, $sep) = @_;
		1867
		1868	$sep ||= "=";
		1869
		1870	$self->add_item ({
		1871	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1872	text => "",
		1873	render => sub { $sep x $self->{term}->ncol },
		1874	activate => sub { },
		1875	});
		1876	}
		1877
		1878	=item $popup->add_button ($text, $cb)
		1879
		1880	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1881	selected.
		1882
		1883	=cut
		1884
1193	sub add_button {	1885	sub add_button {
1194	my ($self, $text, $cb) = @_;	1886	my ($self, $text, $cb) = @_;
1195		1887
1196	$self->add_item ({ type => "button", text => $text, activate => $cb});	1888	$self->add_item ({ type => "button", text => $text, activate => $cb});
1197	}	1889	}
1198		1890
		1891	=item $popup->add_toggle ($text, $initial_value, $cb)
		1892
		1893	Adds a toggle/checkbox item to the popup. The callback gets called
		1894	whenever it gets toggled, with a boolean indicating its new value as its
		1895	first argument.
		1896
		1897	=cut
		1898
1199	sub add_toggle {	1899	sub add_toggle {
1200	my ($self, $text, $cb, $value) = @_;	1900	my ($self, $text, $value, $cb) = @_;
1201		1901
1202	my $item; $item = {	1902	my $item; $item = {
1203	type => "button",	1903	type => "button",
1204	text => " $text",	1904	text => " $text",
1205	value => $value,	1905	value => $value,
1206	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1906	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1207	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1907	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1208	};	1908	};
1209		1909
1210	$self->add_item ($item);	1910	$self->add_item ($item);
1211	}	1911	}
		1912
		1913	=item $popup->show
		1914
		1915	Displays the popup (which is initially hidden).
		1916
		1917	=cut
1212		1918
1213	sub show {	1919	sub show {
1214	my ($self) = @_;	1920	my ($self) = @_;
1215		1921
1216	local $urxvt::popup::self = $self;	1922	local $urxvt::popup::self = $self;
1217		1923
1218	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1924	my $env = $self->{term}->env;
		1925	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1926	delete $env->{LC_ALL};
		1927	$env->{LC_CTYPE} = $self->{term}->locale;
		1928
		1929	my $term = urxvt::term->new (
		1930	$env, "popup",
		1931	"--perl-lib" => "", "--perl-ext-common" => "",
		1932	"-pty-fd" => -1, "-sl" => 0,
		1933	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1219	"--transient-for" => $self->{term}->parent,	1934	"--transient-for" => $self->{term}->parent,
1220	"-display" => $self->{term}->display_id,	1935	"-display" => $self->{term}->display_id,
1221	"-pe" => "urxvt-popup")	1936	"-pe" => "urxvt-popup",
1222	or die "unable to create popup window\n";	1937	) or die "unable to create popup window\n";
		1938
		1939	unless (delete $term->{urxvt_popup_init_done}) {
		1940	$term->ungrab;
		1941	$term->destroy;
		1942	die "unable to initialise popup window\n";
		1943	}
1223	}	1944	}
1224		1945
1225	sub DESTROY {	1946	sub DESTROY {
1226	my ($self) = @_;	1947	my ($self) = @_;
1227		1948
1228	delete $self->{term}{_destroy}{$self};	1949	delete $self->{term}{_destroy}{$self};
1229	$self->{term}->ungrab;	1950	$self->{term}->ungrab;
1230	}	1951	}
		1952
		1953	=back
		1954
		1955	=cut
		1956
		1957	package urxvt::watcher;
1231		1958
1232	=head2 The C<urxvt::timer> Class	1959	=head2 The C<urxvt::timer> Class
1233		1960
1234	This class implements timer watchers/events. Time is represented as a	1961	This class implements timer watchers/events. Time is represented as a
1235	fractional number of seconds since the epoch. Example:	1962	fractional number of seconds since the epoch. Example:
…		…
1239	->new	1966	->new
1240	->interval (1)	1967	->interval (1)
1241	->cb (sub {	1968	->cb (sub {
1242	$term->{overlay}->set (0, 0,	1969	$term->{overlay}->set (0, 0,
1243	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1970	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1244	});	1971	});
1245		1972
1246	=over 4	1973	=over 4
1247		1974
1248	=item $timer = new urxvt::timer	1975	=item $timer = new urxvt::timer
1249		1976
…		…
1252		1979
1253	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1980	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1254		1981
1255	Set the callback to be called when the timer triggers.	1982	Set the callback to be called when the timer triggers.
1256		1983
1257	=item $tstamp = $timer->at
1258
1259	Return the time this watcher will fire next.
1260
1261	=item $timer = $timer->set ($tstamp)	1984	=item $timer = $timer->set ($tstamp[, $interval])
1262		1985
1263	Set the time the event is generated to $tstamp.	1986	Set the time the event is generated to $tstamp (and optionally specifies a
		1987	new $interval).
1264		1988
1265	=item $timer = $timer->interval ($interval)	1989	=item $timer = $timer->interval ($interval)
1266		1990
1267	Normally (and when C<$interval> is C<0>), the timer will automatically	1991	By default (and when C<$interval> is C<0>), the timer will automatically
1268	stop after it has fired once. If C<$interval> is non-zero, then the timer	1992	stop after it has fired once. If C<$interval> is non-zero, then the timer
1269	is automatically rescheduled at the given intervals.	1993	is automatically rescheduled at the given intervals.
1270		1994
1271	=item $timer = $timer->start	1995	=item $timer = $timer->start
1272		1996
1273	Start the timer.	1997	Start the timer.
1274		1998
1275	=item $timer = $timer->start ($tstamp)	1999	=item $timer = $timer->start ($tstamp[, $interval])
1276		2000
1277	Set the event trigger time to C<$tstamp> and start the timer.	2001	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2002	also replaces the interval.
		2003
		2004	=item $timer = $timer->after ($delay[, $interval])
		2005
		2006	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1278		2007
1279	=item $timer = $timer->stop	2008	=item $timer = $timer->stop
1280		2009
1281	Stop the timer.	2010	Stop the timer.
1282		2011
…		…
1288		2017
1289	$term->{socket} = ...	2018	$term->{socket} = ...
1290	$term->{iow} = urxvt::iow	2019	$term->{iow} = urxvt::iow
1291	->new	2020	->new
1292	->fd (fileno $term->{socket})	2021	->fd (fileno $term->{socket})
1293	->events (1) # wait for read data	2022	->events (urxvt::EV_READ)
1294	->start	2023	->start
1295	->cb (sub {	2024	->cb (sub {
1296	my ($iow, $revents) = @_;	2025	my ($iow, $revents) = @_;
1297	# $revents must be 1 here, no need to check	2026	# $revents must be 1 here, no need to check
1298	sysread $term->{socket}, my $buf, 8192	2027	sysread $term->{socket}, my $buf, 8192
…		…
1311	Set the callback to be called when io events are triggered. C<$reventmask>	2040	Set the callback to be called when io events are triggered. C<$reventmask>
1312	is a bitset as described in the C<events> method.	2041	is a bitset as described in the C<events> method.
1313		2042
1314	=item $iow = $iow->fd ($fd)	2043	=item $iow = $iow->fd ($fd)
1315		2044
1316	Set the filedescriptor (not handle) to watch.	2045	Set the file descriptor (not handle) to watch.
1317		2046
1318	=item $iow = $iow->events ($eventmask)	2047	=item $iow = $iow->events ($eventmask)
1319		2048
1320	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2049	Set the event mask to watch. The only allowed values are
1321	data, Bit #1 (value C<2>) enables watching for write data.	2050	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		2051	together, or C<urxvt::EV_NONE>.
1322		2052
1323	=item $iow = $iow->start	2053	=item $iow = $iow->start
1324		2054
1325	Start watching for requested events on the given handle.	2055	Start watching for requested events on the given handle.
1326		2056
1327	=item $iow = $iow->stop	2057	=item $iow = $iow->stop
1328		2058
1329	Stop watching for events on the given filehandle.	2059	Stop watching for events on the given file handle.
		2060
		2061	=back
		2062
		2063	=head2 The C<urxvt::iw> Class
		2064
		2065	This class implements idle watchers, that get called automatically when
		2066	the process is idle. They should return as fast as possible, after doing
		2067	some useful work.
		2068
		2069	=over 4
		2070
		2071	=item $iw = new urxvt::iw
		2072
		2073	Create a new idle watcher object in stopped state.
		2074
		2075	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2076
		2077	Set the callback to be called when the watcher triggers.
		2078
		2079	=item $timer = $timer->start
		2080
		2081	Start the watcher.
		2082
		2083	=item $timer = $timer->stop
		2084
		2085	Stop the watcher.
		2086
		2087	=back
		2088
		2089	=head2 The C<urxvt::pw> Class
		2090
		2091	This class implements process watchers. They create an event whenever a
		2092	process exits, after which they stop automatically.
		2093
		2094	my $pid = fork;
		2095	...
		2096	$term->{pw} = urxvt::pw
		2097	->new
		2098	->start ($pid)
		2099	->cb (sub {
		2100	my ($pw, $exit_status) = @_;
		2101	...
		2102	});
		2103
		2104	=over 4
		2105
		2106	=item $pw = new urxvt::pw
		2107
		2108	Create a new process watcher in stopped state.
		2109
		2110	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2111
		2112	Set the callback to be called when the timer triggers.
		2113
		2114	=item $pw = $timer->start ($pid)
		2115
		2116	Tells the watcher to start watching for process C<$pid>.
		2117
		2118	=item $pw = $pw->stop
		2119
		2120	Stop the watcher.
1330		2121
1331	=back	2122	=back
1332		2123
1333	=head1 ENVIRONMENT	2124	=head1 ENVIRONMENT
1334		2125
…		…
1341		2132
1342	=item == 0 - fatal messages	2133	=item == 0 - fatal messages
1343		2134
1344	=item >= 3 - script loading and management	2135	=item >= 3 - script loading and management
1345		2136
1346	=item >=10 - all events received	2137	=item >=10 - all called hooks
		2138
		2139	=item >=11 - hook return values
1347		2140
1348	=back	2141	=back
1349		2142
1350	=head1 AUTHOR	2143	=head1 AUTHOR
1351		2144
1352	Marc Lehmann <pcg@goof.com>	2145	Marc Lehmann <schmorp@schmorp.de>
1353	http://software.schmorp.de/pkg/rxvt-unicode	2146	http://software.schmorp.de/pkg/rxvt-unicode
1354		2147
1355	=cut	2148	=cut
1356		2149
1357	1	2150	1
		2151
		2152	# vim: sw=3:

Diff Legend

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