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.234 by root, Sat May 17 15:25:04 2014 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=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_extensions;
		563
		564	my $r = $term->{meta}{resource};
		565	keys %$r; # reset iterator
		566	while (my ($pattern, $v) = each %$r) {
		567	if (
		568	$pattern =~ /\.$/
		569	? $pattern eq substr $name, 0, length $pattern
		570	: $pattern eq $name
		571	) {
		572	$name = "$urxvt::RESCLASS.$name";
		573
		574	push @{ $term->{perl_ext_3} }, $v->[0];
		575
		576	if ($v->[1] eq "boolean") {
		577	$term->put_option_db ($name, $flag ? "true" : "false");
		578	return 1;
		579	} else {
		580	$term->put_option_db ($name, $value);
		581	return 1 + 2;
		582	}
		583	}
		584	}
		585
		586	0
		587	}
		588
		589	sub usage {
		590	my ($term, $usage_type) = @_;
		591
		592	$term->scan_extensions;
		593
		594	my $r = $term->{meta}{resource};
		595
		596	for my $pattern (sort keys %$r) {
		597	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		598
		599	$desc .= " (-pe $ext)";
		600
		601	if ($usage_type == 1) {
		602	$pattern =~ y/./-/;
		603	$pattern =~ s/-$/-.../g;
		604
		605	if ($type eq "boolean") {
		606	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		607	} else {
		608	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		609	}
		610	} else {
		611	$pattern =~ s/\.$/.*/g;
		612	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		613	}
		614	}
		615	}
		616
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	$TERM->scan_extensions;
		667
		668	my %ext_arg;
		669
503		670	{
504	my %want_ext;	671	my @init = @TERM_INIT;
		672	@TERM_INIT = ();
		673	$_->($TERM) for @init;
		674	my @pkg = @TERM_EXT;
		675	@TERM_EXT = ();
		676	$TERM->register_package ($_) for @pkg;
		677	}
505		678
		679	for (
		680	@{ delete $TERM->{perl_ext_3} },
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	681	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		682	) {
507	if ($_ eq "default") {	683	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	684	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
509	} elsif (/^-(.*)$/) {	685	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	686	delete $ext_arg{$1};
		687	} elsif (/^([^<]+)<(.*)>$/) {
		688	push @{ $ext_arg{$1} }, $2;
511	} else {	689	} else {
512	$want_ext{$_}++;	690	$ext_arg{$_} ||= [];
513	}	691	}
514	}	692	}
515		693
516	for my $ext (keys %want_ext) {	694	for my $ext (sort keys %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	695	my @files = grep -f $_, map "$_/$ext", @dirs;
518		696
519	if (@files) {	697	if (@files) {
520	register_package extension_package $files[0];	698	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
521	} else {	699	} else {
522	warn "perl extension '$ext' not found in perl library search path\n";	700	warn "perl extension '$ext' not found in perl library search path\n";
523	}	701	}
524	}	702	}
525		703
…		…
531		709
532	if (my $cb = $TERM->{_hook}[$htype]) {	710	if (my $cb = $TERM->{_hook}[$htype]) {
533	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	711	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
534	if $verbosity >= 10;	712	if $verbosity >= 10;
535		713
536	keys %$cb;	714	if ($htype == HOOK_ACTION) {
		715	# this hook is only sent to the extension with the name
		716	# matching the first arg
		717	my $pkg = shift;
		718	$pkg =~ y/-/_/;
		719	$pkg = "urxvt::ext::$pkg";
537		720
538	while (my ($pkg, $cb) = each %$cb) {	721	$cb = $cb->{$pkg}
539	eval {	722	or return undef; #TODO: maybe warn user?
540	$retval = $cb->(	723
541	$TERM->{_pkg}{$pkg} ||= do {	724	$cb = { $pkg => $cb };
542	my $proxy = bless { }, $pkg;
543	Scalar::Util::weaken ($proxy->{term} = $TERM);
544	$proxy
545	},
546	@_,
547	) and last;
548	};	725	}
		726
		727	for my $pkg (keys %$cb) {
		728	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
		729	$retval ||= $retval_;
		730
549	if ($@) {	731	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	732	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	733	warn $@;
552	}	734	}
553	}	735	}
		736
		737	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		738	if $verbosity >= 11;
554	}	739	}
555		740
556	if ($htype == 1) { # DESTROY	741	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	742	# clear package objects
566	%$_ = () for values %{ $TERM->{_pkg} };	743	%$_ = () for values %{ $TERM->{_pkg} };
567		744
568	# clear package	745	# clear package
569	%$TERM = ();	746	%$TERM = ();
570	}	747	}
571		748
572	$retval	749	$retval
573	}	750	}
574		751
575	# urxvt::term::proxy	752	sub SET_COLOR($$$) {
		753	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		754	}
576		755
577	sub urxvt::term::proxy::AUTOLOAD {	756	sub rend2mask {
578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	757	no strict 'refs';
		758	my ($str, $mask) = (@_, 0);
		759	my %color = ( fg => undef, bg => undef );
		760	my @failed;
		761	for my $spec ( split /\s+/, $str ) {
		762	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		763	$color{lc($1)} = $2;
		764	} else {
		765	my $neg = $spec =~ s/^[-^]//;
		766	unless ( exists &{"RS_$spec"} ) {
		767	push @failed, $spec;
		768	next;
		769	}
		770	my $cur = &{"RS_$spec"};
		771	if ( $neg ) {
		772	$mask &= ~$cur;
		773	} else {
		774	$mask |= $cur;
		775	}
		776	}
		777	}
		778	($mask, @color{qw(fg bg)}, \@failed)
		779	}
		780
		781	package urxvt::term::extension;
		782
		783	=head2 The C<urxvt::term::extension> class
		784
		785	Each extension attached to a terminal object is represented by
		786	a C<urxvt::term::extension> object.
		787
		788	You can use these objects, which are passed to all callbacks to store any
		789	state related to the terminal and extension instance.
		790
		791	The methods (And data members) documented below can be called on extension
		792	objects, in addition to call methods documented for the <urxvt::term>
		793	class.
		794
		795	=over 4
		796
		797	=item $urxvt_term = $self->{term}
		798
		799	Returns the C<urxvt::term> object associated with this instance of the
		800	extension. This member I<must not> be changed in any way.
		801
		802	=cut
		803
		804	our $AUTOLOAD;
		805
		806	sub AUTOLOAD {
		807	$AUTOLOAD =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	808	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		809
581	eval qq{	810	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	811	sub $AUTOLOAD {
583	my \$proxy = shift;	812	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	813	\$proxy->{term}->$1 (\@_)
585	}	814	}
586	1	815	1
587	} or die "FATAL: unable to compile method forwarder: $@";	816	} or die "FATAL: unable to compile method forwarder: $@";
588		817
589	goto &$urxvt::term::proxy::AUTOLOAD;	818	goto &$AUTOLOAD;
590	}	819	}
591		820
592	sub urxvt::term::proxy::DESTROY {	821	sub DESTROY {
593	# nop	822	# nop
594	}	823	}
595		824
596	# urxvt::destroy_hook	825	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
597		826
598	sub urxvt::destroy_hook::DESTROY {	827	sub urxvt::destroy_hook::DESTROY {
599	${$_[0]}->();	828	${$_[0]}->();
600	}	829	}
601		830
602	sub urxvt::destroy_hook(&) {	831	sub urxvt::destroy_hook(&) {
603	bless \shift, urxvt::destroy_hook::	832	bless \shift, urxvt::destroy_hook::
604	}	833	}
605		834
		835	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		836
		837	Dynamically enable the given hooks (named without the C<on_> prefix) for
		838	this extension, replacing any hook previously installed via C<enable> in
		839	this extension.
		840
		841	This is useful when you want to overwrite time-critical hooks only
		842	temporarily.
		843
		844	To install additional callbacks for the same hook, you can use the C<on>
		845	method of the C<urxvt::term> class.
		846
		847	=item $self->disable ($hook_name[, $hook_name..])
		848
		849	Dynamically disable the given hooks.
		850
		851	=cut
		852
		853	sub enable {
		854	my ($self, %hook) = @_;
		855	my $pkg = $self->{_pkg};
		856
		857	while (my ($name, $cb) = each %hook) {
		858	my $htype = $HOOKTYPE{uc $name};
		859	defined $htype
		860	or Carp::croak "unsupported hook type '$name'";
		861
		862	$self->set_should_invoke ($htype, +1)
		863	unless exists $self->{term}{_hook}[$htype]{$pkg};
		864
		865	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		866	}
		867	}
		868
		869	sub disable {
		870	my ($self, @hook) = @_;
		871	my $pkg = $self->{_pkg};
		872
		873	for my $name (@hook) {
		874	my $htype = $HOOKTYPE{uc $name};
		875	defined $htype
		876	or Carp::croak "unsupported hook type '$name'";
		877
		878	$self->set_should_invoke ($htype, -1)
		879	if delete $self->{term}{_hook}[$htype]{$pkg};
		880	}
		881	}
		882
		883	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		884
		885	Similar to the C<enable> enable, but installs additional callbacks for
		886	the given hook(s) (that is, it doesn't replace existing callbacks), and
		887	returns a guard object. When the guard object is destroyed the callbacks
		888	are disabled again.
		889
		890	=cut
		891
		892	sub urxvt::extension::on_disable::DESTROY {
		893	my $disable = shift;
		894
		895	my $term = delete $disable->{""};
		896
		897	while (my ($htype, $id) = each %$disable) {
		898	delete $term->{_hook}[$htype]{$id};
		899	$term->set_should_invoke ($htype, -1);
		900	}
		901	}
		902
		903	sub on {
		904	my ($self, %hook) = @_;
		905
		906	my $term = $self->{term};
		907
		908	my %disable = ( "" => $term );
		909
		910	while (my ($name, $cb) = each %hook) {
		911	my $htype = $HOOKTYPE{uc $name};
		912	defined $htype
		913	or Carp::croak "unsupported hook type '$name'";
		914
		915	$term->set_should_invoke ($htype, +1);
		916	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		917	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		918	}
		919
		920	bless \%disable, "urxvt::extension::on_disable"
		921	}
		922
		923	=item $self->x_resource ($pattern)
		924
		925	=item $self->x_resource_boolean ($pattern)
		926
		927	These methods support an additional C<%> prefix when called on an
		928	extension object - see the description of these methods in the
		929	C<urxvt::term> class for details.
		930
		931	=cut
		932
		933	sub x_resource {
		934	my ($self, $name) = @_;
		935	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		936	$self->{term}->x_resource ($name)
		937	}
		938
		939	sub x_resource_boolean {
		940	my ($self, $name) = @_;
		941	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		942	$self->{term}->x_resource_boolean ($name)
		943	}
		944
		945	=back
		946
		947	=cut
		948
606	package urxvt::anyevent;	949	package urxvt::anyevent;
607		950
608	=head2 The C<urxvt::anyevent> Class	951	=head2 The C<urxvt::anyevent> Class
609		952
610	The sole purpose of this class is to deliver an interface to the	953	The sole purpose of this class is to deliver an interface to the
611	C<AnyEvent> module - any module using it will work inside urxvt without	954	C<AnyEvent> module - any module using it will work inside urxvt without
612	further work. The only exception is that you cannot wait on condition	955	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	956	condition variables, but non-blocking condvar use is ok.
614	cannot use blocking APIs, but the non-blocking variant should work.
615		957
616	=cut	958	In practical terms this means is that you cannot use blocking APIs, but
		959	the non-blocking variant should work.
617		960
		961	=cut
		962
618	our $VERSION = 1;	963	our $VERSION = '5.23';
619		964
620	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	965	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
621	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	966	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
622		967
623	sub timer {	968	sub timer {
…		…
625		970
626	my $cb = $arg{cb};	971	my $cb = $arg{cb};
627		972
628	urxvt::timer	973	urxvt::timer
629	->new	974	->new
630	->start (urxvt::NOW + $arg{after})	975	->after ($arg{after}, $arg{interval})
631	->cb (sub {	976	->cb ($arg{interval} ? $cb : sub {
632	$_[0]->stop; # need to cancel manually	977	$_[0]->stop; # need to cancel manually
633	$cb->();	978	$cb->();
634	})	979	})
635	}	980	}
636		981
637	sub io {	982	sub io {
638	my ($class, %arg) = @_;	983	my ($class, %arg) = @_;
639		984
640	my $cb = $arg{cb};	985	my $cb = $arg{cb};
		986	my $fd = fileno $arg{fh};
		987	defined $fd or $fd = $arg{fh};
641		988
642	bless [$arg{fh}, urxvt::iow	989	bless [$arg{fh}, urxvt::iow
643	->new	990	->new
644	->fd (fileno $arg{fh})	991	->fd ($fd)
645	->events (($arg{poll} =~ /r/ ? 1 : 0)	992	->events (($arg{poll} =~ /r/ ? 1 : 0)
646	| ($arg{poll} =~ /w/ ? 2 : 0))	993	| ($arg{poll} =~ /w/ ? 2 : 0))
647	->start	994	->start
648	->cb (sub {	995	->cb ($cb)
649	$cb->(($_[1] & 1 ? 'r' : '')
650	. ($_[1] & 2 ? 'w' : ''));
651	})],
652	urxvt::anyevent::	996	], urxvt::anyevent::
		997	}
		998
		999	sub idle {
		1000	my ($class, %arg) = @_;
		1001
		1002	my $cb = $arg{cb};
		1003
		1004	urxvt::iw
		1005	->new
		1006	->start
		1007	->cb ($cb)
		1008	}
		1009
		1010	sub child {
		1011	my ($class, %arg) = @_;
		1012
		1013	my $cb = $arg{cb};
		1014
		1015	urxvt::pw
		1016	->new
		1017	->start ($arg{pid})
		1018	->cb (sub {
		1019	$_[0]->stop; # need to cancel manually
		1020	$cb->($_[0]->rpid, $_[0]->rstatus);
		1021	})
653	}	1022	}
654		1023
655	sub DESTROY {	1024	sub DESTROY {
656	$_[0][1]->stop;	1025	$_[0][1]->stop;
657	}	1026	}
658		1027
659	sub condvar {	1028	# only needed for AnyEvent < 6 compatibility
660	bless \my $flag, urxvt::anyevent::condvar::	1029	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");	1030	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1031	}
		1032
		1033	package urxvt::term;
		1034
		1035	=head2 The C<urxvt::term> Class
		1036
		1037	=over 4
		1038
		1039	=cut
		1040
		1041	# find on_xxx subs in the package and register them
		1042	# as hooks
		1043	sub register_package {
		1044	my ($self, $pkg, $argv) = @_;
		1045
		1046	no strict 'refs';
		1047
		1048	urxvt::verbose 6, "register package $pkg to $self";
		1049
		1050	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1051
		1052	my $proxy = bless {
		1053	_pkg => $pkg,
		1054	_name => ${"$pkg\::_NAME"}, # hackish
		1055	argv => $argv,
		1056	}, $pkg;
		1057	Scalar::Util::weaken ($proxy->{term} = $self);
		1058
		1059	$self->{_pkg}{$pkg} = $proxy;
		1060
		1061	for my $name (@HOOKNAME) {
		1062	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1063	$proxy->enable ($name => $ref);
		1064	}
671	}	1065	}
672	}	1066	}
673		1067
674	package urxvt::term;	1068	sub perl_libdirs {
		1069	map { split /:/ }
		1070	$_[0]->resource ("perl_lib"),
		1071	$ENV{URXVT_PERL_LIB},
		1072	"$ENV{HOME}/.urxvt/ext",
		1073	"$LIBDIR/perl"
		1074	}
675		1075
676	=head2 The C<urxvt::term> Class	1076	# scan for available extensions and collect their metadata
		1077	sub scan_extensions {
		1078	my ($self) = @_;
677		1079
678	=over 4	1080	return if exists $self->{meta};
		1081
		1082	my @libdirs = perl_libdirs $self;
		1083
		1084	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1085
		1086	my %meta;
		1087
		1088	$self->{meta_libdirs} = join "\x00", @libdirs;
		1089	$self->{meta} = \%meta;
		1090
		1091	my %ext;
		1092
		1093	# first gather extensions
		1094	for my $dir (reverse @libdirs) {
		1095	opendir my $fh, $dir
		1096	or next;
		1097	for my $ext (readdir $fh) {
		1098	$ext !~ /^\./
		1099	and open my $fh, "<", "$dir/$ext"
		1100	or next;
		1101
		1102	my %ext = (dir => $dir);
		1103
		1104	while (<$fh>) {
		1105	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1106	my ($pattern, $type, $desc) = split /:/, $1;
		1107	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1108	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1109	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1110	} else {
		1111	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1112	}
		1113	} elsif (/^#:META:BINDING:(.*)/) {
		1114	my ($keysym, $action) = split /:/, $1;
		1115	$ext{binding}{$keysym} = $action;
		1116	} elsif (/^\s*(?:#|$)/) {
		1117	# skip other comments and empty lines
		1118	} else {
		1119	last; # stop parsing on first non-empty non-comment line
		1120	}
		1121	}
		1122
		1123	$meta{$ext} = \%ext;
		1124	}
		1125	}
		1126
		1127	# and now merge resources and bindings
		1128	while (my ($k, $v) = each %ext) {
		1129	#TODO: should check for extensions overriding each other
		1130	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1131	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1132	}
		1133	}
		1134
		1135	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1136
		1137	Creates a new terminal, very similar as if you had started it with system
		1138	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1139	hash which defines the environment of the new terminal.
		1140
		1141	Croaks (and probably outputs an error message) if the new instance
		1142	couldn't be created. Returns C<undef> if the new instance didn't
		1143	initialise perl, and the terminal object otherwise. The C<init> and
		1144	C<start> hooks will be called before this call returns, and are free to
		1145	refer to global data (which is race free).
		1146
		1147	=cut
		1148
		1149	sub new {
		1150	my ($class, $env, @args) = @_;
		1151
		1152	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1153	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1154
		1155	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1156	}
679		1157
680	=item $term->destroy	1158	=item $term->destroy
681		1159
682	Destroy the terminal object (close the window, free resources etc.).	1160	Destroy the terminal object (close the window, free resources
		1161	etc.). Please note that urxvt will not exit as long as any event
		1162	watchers (timers, io watchers) are still active.
		1163
		1164	=item $term->exec_async ($cmd[, @args])
		1165
		1166	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1167	("starts") programs in the background. This function takes care of setting
		1168	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1169	be preferred over explicit calls to C<exec> or C<system>.
		1170
		1171	Returns the pid of the subprocess or C<undef> on error.
		1172
		1173	=cut
		1174
		1175	sub exec_async {
		1176	my $self = shift;
		1177
		1178	my $pid = fork;
		1179
		1180	return $pid
		1181	if !defined $pid or $pid;
		1182
		1183	%ENV = %{ $self->env };
		1184
		1185	exec @_;
		1186	urxvt::_exit 255;
		1187	}
683		1188
684	=item $isset = $term->option ($optval[, $set])	1189	=item $isset = $term->option ($optval[, $set])
685		1190
686	Returns true if the option specified by C<$optval> is enabled, and	1191	Returns true if the option specified by C<$optval> is enabled, and
687	optionally change it. All option values are stored by name in the hash	1192	optionally change it. All option values are stored by name in the hash
688	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1193	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
689		1194
690	Here is a a likely non-exhaustive list of option names, please see the	1195	Here is a likely non-exhaustive list of option names, please see the
691	source file F</src/optinc.h> to see the actual list:	1196	source file F</src/optinc.h> to see the actual list:
692		1197
693	borderLess console cursorBlink cursorUnderline hold iconic insecure	1198	borderLess buffered console cursorBlink cursorUnderline hold iconic
694	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1199	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1200	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
695	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1201	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
696	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1202	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
697	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1203	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
698	tripleclickwords utmpInhibit visualBell	1204	urgentOnBell utmpInhibit visualBell
699		1205
700	=item $value = $term->resource ($name[, $newval])	1206	=item $value = $term->resource ($name[, $newval])
701		1207
702	Returns the current resource value associated with a given name and	1208	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>	1209	optionally sets a new value. Setting values is most useful in the C<init>
…		…
712	likely change).	1218	likely change).
713		1219
714	Please note that resource strings will currently only be freed when the	1220	Please note that resource strings will currently only be freed when the
715	terminal is destroyed, so changing options frequently will eat memory.	1221	terminal is destroyed, so changing options frequently will eat memory.
716		1222
717	Here is a a likely non-exhaustive list of resource names, not all of which	1223	Here is a likely non-exhaustive list of resource names, not all of which
718	are supported in every build, please see the source file F</src/rsinc.h>	1224	are supported in every build, please see the source file F</src/rsinc.h>
719	to see the actual list:	1225	to see the actual list:
720		1226
721	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1227	answerbackstring backgroundPixmap backspace_key blurradius
722	borderLess color cursorBlink cursorUnderline cutchars delete_key	1228	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
723	display_name embed ext_bwidth fade font geometry hold iconName	1229	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
724	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1230	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1231	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
725	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1232	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
726	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1233	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
727	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1234	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
728	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1235	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
729	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1236	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
730	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1237	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
731	shade term_name title transparent transparent_all tripleclickwords	1238	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1239	term_name title transient_for transparent tripleclickwords urgentOnBell
732	utmpInhibit visualBell	1240	utmpInhibit visualBell
733		1241
734	=cut	1242	=cut
735		1243
736	sub resource($$;$) {	1244	sub resource($$;$) {
737	my ($self, $name) = (shift, shift);	1245	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1246	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	1247	goto &urxvt::term::_resource
740	}	1248	}
		1249
		1250	=item $value = $term->x_resource ($pattern)
		1251
		1252	Returns the X-Resource for the given pattern, excluding the program or
		1253	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1254	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1255	resource with that pattern exists.
		1256
		1257	Extensions that define extra resource or command line arguments also need
		1258	to call this method to access their values.
		1259
		1260	If the method is called on an extension object (basically, from an
		1261	extension), then the special prefix C<%.> will be replaced by the name of
		1262	the extension and a dot, and the lone string C<%> will be replaced by the
		1263	extension name itself. This makes it possible to code extensions so you
		1264	can rename them and get a new set of commandline switches and resources
		1265	without having to change the actual code.
		1266
		1267	This method should only be called during the C<on_start> hook, as there is
		1268	only one resource database per display, and later invocations might return
		1269	the wrong resources.
		1270
		1271	=item $value = $term->x_resource_boolean ($pattern)
		1272
		1273	Like C<x_resource>, above, but interprets the string value as a boolean
		1274	and returns C<1> for true values, C<0> for false values and C<undef> if
		1275	the resource or option isn't specified.
		1276
		1277	You should always use this method to parse boolean resources.
		1278
		1279	=cut
		1280
		1281	sub x_resource_boolean {
		1282	my $res = &x_resource;
		1283
		1284	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1285	}
		1286
		1287	=item $success = $term->bind_action ($key, $octets)
		1288
		1289	Adds a key binding exactly as specified via a C<keysym> resource. See the
		1290	C<keysym> resource in the urxvt(1) manpage.
741		1291
742	=item $rend = $term->rstyle ([$new_rstyle])	1292	=item $rend = $term->rstyle ([$new_rstyle])
743		1293
744	Return and optionally change the current rendition. Text that is output by	1294	Return and optionally change the current rendition. Text that is output by
745	the terminal application will use this style.	1295	the terminal application will use this style.
…		…
753		1303
754	=item ($row, $col) = $term->selection_beg ([$row, $col])	1304	=item ($row, $col) = $term->selection_beg ([$row, $col])
755		1305
756	=item ($row, $col) = $term->selection_end ([$row, $col])	1306	=item ($row, $col) = $term->selection_end ([$row, $col])
757		1307
758	Return the current values of the selection mark, begin or end positions,	1308	Return the current values of the selection mark, begin or end positions.
759	and optionally set them to new values.
760		1309
		1310	When arguments are given, then the selection coordinates are set to
		1311	C<$row> and C<$col>, and the selection screen is set to the current
		1312	screen.
		1313
		1314	=item $screen = $term->selection_screen ([$screen])
		1315
		1316	Returns the current selection screen, and then optionally sets it.
		1317
		1318	=item $term->selection_make ($eventtime[, $rectangular])
		1319
		1320	Tries to make a selection as set by C<selection_beg> and
		1321	C<selection_end>. If C<$rectangular> is true (default: false), a
		1322	rectangular selection will be made. This is the preferred function to make
		1323	a selection.
		1324
761	=item $success = $term->selection_grab ($eventtime)	1325	=item $success = $term->selection_grab ($eventtime[, $clipboard])
762		1326
763	Try to request the primary selection from the server (for example, as set	1327	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
764	by the next method).	1328	true) selection from the server. The corresponding text can be set
		1329	with the next method. No visual feedback will be given. This function
		1330	is mostly useful from within C<on_sel_grab> hooks.
765		1331
766	=item $oldtext = $term->selection ([$newtext])	1332	=item $oldtext = $term->selection ([$newtext, $clipboard])
767		1333
768	Return the current selection text and optionally replace it by C<$newtext>.	1334	Return the current selection (clipboard if C<$clipboard> is true) text
		1335	and optionally replace it by C<$newtext>.
769		1336
		1337	=item $term->selection_clear ([$clipboard])
		1338
		1339	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1340
770	#=item $term->overlay ($x, $y, $text)	1341	=item $term->overlay_simple ($x, $y, $text)
771	#	1342
772	#Create a simple multi-line overlay box. See the next method for details.	1343	Create a simple multi-line overlay box. See the next method for details.
773	#	1344
774	#=cut	1345	=cut
775	#	1346
776	#sub urxvt::term::scr_overlay {	1347	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	1348	my ($self, $x, $y, $text) = @_;
778	#	1349
779	# my @lines = split /\n/, $text;	1350	my @lines = split /\n/, $text;
780	#	1351
781	# my $w = 0;	1352	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	1353
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1354	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1355	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	1356
		1357	$overlay
		1358	}
789		1359
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1360	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		1361
792	Create a new (empty) overlay at the given position with the given	1362	Create a new (empty) overlay at the given position with the given
793	width/height. C<$rstyle> defines the initial rendition style	1363	width/height. C<$rstyle> defines the initial rendition style
…		…
804		1374
805	The methods currently supported on C<urxvt::overlay> objects are:	1375	The methods currently supported on C<urxvt::overlay> objects are:
806		1376
807	=over 4	1377	=over 4
808		1378
809	=item $overlay->set ($x, $y, $text, $rend)	1379	=item $overlay->set ($x, $y, $text[, $rend])
810		1380
811	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1381	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
812	text in rxvt-unicode's special encoding and an array of rendition values	1382	text in rxvt-unicode's special encoding and an array of rendition values
813	at a specific position inside the overlay.	1383	at a specific position inside the overlay.
		1384
		1385	If C<$rend> is missing, then the rendition will not be changed.
814		1386
815	=item $overlay->hide	1387	=item $overlay->hide
816		1388
817	If visible, hide the overlay, but do not destroy it.	1389	If visible, hide the overlay, but do not destroy it.
818		1390
…		…
860		1432
861	=item $string = $term->locale_decode ($octets)	1433	=item $string = $term->locale_decode ($octets)
862		1434
863	Convert the given locale-encoded octets into a perl string.	1435	Convert the given locale-encoded octets into a perl string.
864		1436
		1437	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1438
		1439	XORs the rendition values in the given span with the provided value
		1440	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1441	refresh hooks to provide effects similar to the selection.
		1442
		1443	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1444
		1445	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1446	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1447	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1448	it instead. Both styles I<MUST NOT> contain font styles.
		1449
		1450	=item $term->scr_bell
		1451
		1452	Ring the bell!
		1453
865	=item $term->scr_add_lines ($string)	1454	=item $term->scr_add_lines ($string)
866		1455
867	Write the given text string to the screen, as if output by the application	1456	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	1457	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	1458	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
871		1460
872	Normally its not a good idea to use this function, as programs might be	1461	Normally its not a good idea to use this function, as programs might be
873	confused by changes in cursor position or scrolling. Its useful inside a	1462	confused by changes in cursor position or scrolling. Its useful inside a
874	C<on_add_lines> hook, though.	1463	C<on_add_lines> hook, though.
875		1464
		1465	=item $term->scr_change_screen ($screen)
		1466
		1467	Switch to given screen - 0 primary, 1 secondary.
		1468
876	=item $term->cmd_parse ($octets)	1469	=item $term->cmd_parse ($octets)
877		1470
878	Similar to C<scr_add_lines>, but the argument must be in the	1471	Similar to C<scr_add_lines>, but the argument must be in the
879	locale-specific encoding of the terminal and can contain command sequences	1472	locale-specific encoding of the terminal and can contain command sequences
880	(escape codes) that will be interpreted.	1473	(escape codes) that will be interpreted.
881		1474
882	=item $term->tt_write ($octets)	1475	=item $term->tt_write ($octets)
883		1476
884	Write the octets given in C<$data> to the tty (i.e. as program input). To	1477	Write the octets given in C<$octets> to the tty (i.e. as program input). To
885	pass characters instead of octets, you should convert your strings first	1478	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	1479	to the locale-specific encoding using C<< $term->locale_encode >>.
887		1480
		1481	=item $term->tt_write_user_input ($octets)
		1482
		1483	Like C<tt_write>, but should be used when writing strings in response to
		1484	the user pressing a key, to invokes the additional actions requested by
		1485	the user for that case (C<tt_write> doesn't do that).
		1486
		1487	The typical use case would be inside C<on_action> hooks.
		1488
		1489	=item $term->tt_paste ($octets)
		1490
		1491	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1492	CR and bracketing the data with control sequences if bracketed paste mode
		1493	is set.
		1494
		1495	=item $old_events = $term->pty_ev_events ([$new_events])
		1496
		1497	Replaces the event mask of the pty watcher by the given event mask. Can
		1498	be used to suppress input and output handling to the pty/tty. See the
		1499	description of C<< urxvt::timer->events >>. Make sure to always restore
		1500	the previous value.
		1501
		1502	=item $fd = $term->pty_fd
		1503
		1504	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1505	is used.
		1506
888	=item $windowid = $term->parent	1507	=item $windowid = $term->parent
889		1508
890	Return the window id of the toplevel window.	1509	Return the window id of the toplevel window.
891		1510
892	=item $windowid = $term->vt	1511	=item $windowid = $term->vt
893		1512
894	Return the window id of the terminal window.	1513	Return the window id of the terminal window.
895		1514
		1515	=item $term->vt_emask_add ($x_event_mask)
		1516
		1517	Adds the specified events to the vt event mask. Useful e.g. when you want
		1518	to receive pointer events all the times:
		1519
		1520	$term->vt_emask_add (urxvt::PointerMotionMask);
		1521
		1522	=item $term->set_urgency ($set)
		1523
		1524	Enable/disable the urgency hint on the toplevel window.
		1525
		1526	=item $term->focus_in
		1527
		1528	=item $term->focus_out
		1529
		1530	=item $term->key_press ($state, $keycode[, $time])
		1531
		1532	=item $term->key_release ($state, $keycode[, $time])
		1533
		1534	Deliver various fake events to to terminal.
		1535
896	=item $window_width = $term->width	1536	=item $window_width = $term->width
897		1537
898	=item $window_height = $term->height	1538	=item $window_height = $term->height
899		1539
900	=item $font_width = $term->fwidth	1540	=item $font_width = $term->fwidth
…		…
913		1553
914	=item $max_scrollback = $term->saveLines	1554	=item $max_scrollback = $term->saveLines
915		1555
916	=item $nrow_plus_saveLines = $term->total_rows	1556	=item $nrow_plus_saveLines = $term->total_rows
917		1557
918	=item $lines_in_scrollback = $term->nsaved	1558	=item $topmost_scrollback_row = $term->top_row
919		1559
920	Return various integers describing terminal characteristics.	1560	Return various integers describing terminal characteristics.
		1561
		1562	=item $x_display = $term->display_id
		1563
		1564	Return the DISPLAY used by rxvt-unicode.
		1565
		1566	=item $lc_ctype = $term->locale
		1567
		1568	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1569
		1570	=item $env = $term->env
		1571
		1572	Returns a copy of the environment in effect for the terminal as a hashref
		1573	similar to C<\%ENV>.
		1574
		1575	=item @envv = $term->envv
		1576
		1577	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1578
		1579	=item @argv = $term->argv
		1580
		1581	Return the argument vector as this terminal, similar to @ARGV, but
		1582	includes the program name as first element.
		1583
		1584	=cut
		1585
		1586	sub env {
		1587	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1588	}
921		1589
922	=item $modifiermask = $term->ModLevel3Mask	1590	=item $modifiermask = $term->ModLevel3Mask
923		1591
924	=item $modifiermask = $term->ModMetaMask	1592	=item $modifiermask = $term->ModMetaMask
925		1593
926	=item $modifiermask = $term->ModNumLockMask	1594	=item $modifiermask = $term->ModNumLockMask
927		1595
928	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1596	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
929	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1597	AltGr), the meta key (often Alt) and the num lock key, if applicable.
930		1598
		1599	=item $screen = $term->current_screen
		1600
		1601	Returns the currently displayed screen (0 primary, 1 secondary).
		1602
		1603	=item $cursor_is_hidden = $term->hidden_cursor
		1604
		1605	Returns whether the cursor is currently hidden or not.
		1606
931	=item $view_start = $term->view_start ([$newvalue])	1607	=item $view_start = $term->view_start ([$newvalue])
932		1608
933	Returns the negative row number of the topmost line. Minimum value is	1609	Returns the row number of the topmost displayed line. Maximum value is
934	C<0>, which displays the normal terminal contents. Larger values scroll	1610	C<0>, which displays the normal terminal contents. Lower values scroll
935	this many lines into the scrollback buffer.	1611	this many lines into the scrollback buffer.
936		1612
937	=item $term->want_refresh	1613	=item $term->want_refresh
938		1614
939	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1615	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
942		1618
943	Used after changing terminal contents to display them.	1619	Used after changing terminal contents to display them.
944		1620
945	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1621	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
946		1622
947	Returns the text of the entire row with number C<$row_number>. Row C<0>	1623	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
948	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1624	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
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	1625	terminal line. Nothing will be returned if a nonexistent line
951	is requested.	1626	is requested.
952		1627
953	If C<$new_text> is specified, it will replace characters in the current	1628	If C<$new_text> is specified, it will replace characters in the current
954	line, starting at column C<$start_col> (default C<0>), which is useful	1629	line, starting at column C<$start_col> (default C<0>), which is useful
955	to replace only parts of a line. The font index in the rendition will	1630	to replace only parts of a line. The font index in the rendition will
956	automatically be updated.	1631	automatically be updated.
957		1632
958	C<$text> is in a special encoding: tabs and wide characters that use more	1633	C<$text> is in a special encoding: tabs and wide characters that use more
959	than one cell when displayed are padded with urxvt::NOCHAR characters	1634	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
960	(C<chr 65535>). Characters with combining characters and other characters	1635	characters. Characters with combining characters and other characters that
961	that do not fit into the normal tetx encoding will be replaced with	1636	do not fit into the normal text encoding will be replaced with characters
962	characters in the private use area.	1637	in the private use area.
963		1638
964	You have to obey this encoding when changing text. The advantage is	1639	You have to obey this encoding when changing text. The advantage is
965	that C<substr> and similar functions work on screen cells and not on	1640	that C<substr> and similar functions work on screen cells and not on
966	characters.	1641	characters.
967		1642
…		…
1018	Return the row number of the first/last row of the line, respectively.	1693	Return the row number of the first/last row of the line, respectively.
1019		1694
1020	=item $offset = $line->offset_of ($row, $col)	1695	=item $offset = $line->offset_of ($row, $col)
1021		1696
1022	Returns the character offset of the given row|col pair within the logical	1697	Returns the character offset of the given row|col pair within the logical
1023	line.	1698	line. Works for rows outside the line, too, and returns corresponding
		1699	offsets outside the string.
1024		1700
1025	=item ($row, $col) = $line->coord_of ($offset)	1701	=item ($row, $col) = $line->coord_of ($offset)
1026		1702
1027	Translates a string offset into terminal coordinates again.	1703	Translates a string offset into terminal coordinates again.
1028		1704
…		…
1050	}	1726	}
1051		1727
1052	sub urxvt::line::t {	1728	sub urxvt::line::t {
1053	my ($self) = @_;	1729	my ($self) = @_;
1054		1730
1055	if (@_ > 1)	1731	if (@_ > 1) {
1056	{
1057	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1732	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1058	for $self->{beg} .. $self->{end};	1733	for $self->{beg} .. $self->{end};
1059	}	1734	}
1060		1735
1061	defined wantarray &&	1736	defined wantarray &&
1062	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1737	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1063	0, $self->{len}	1738	0, $self->{len}
1064	}	1739	}
1065		1740
1066	sub urxvt::line::r {	1741	sub urxvt::line::r {
1067	my ($self) = @_;	1742	my ($self) = @_;
1068		1743
1069	if (@_ > 1)	1744	if (@_ > 1) {
1070	{
1071	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1745	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1072	for $self->{beg} .. $self->{end};	1746	for $self->{beg} .. $self->{end};
1073	}	1747	}
1074		1748
1075	if (defined wantarray) {	1749	if (defined wantarray) {
1076	my $rend = [	1750	my $rend = [
1077	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1751	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1078	];	1752	];
…		…
1110	where one character corresponds to one screen cell. See	1784	where one character corresponds to one screen cell. See
1111	C<< $term->ROW_t >> for details.	1785	C<< $term->ROW_t >> for details.
1112		1786
1113	=item $string = $term->special_decode $text	1787	=item $string = $term->special_decode $text
1114		1788
1115	Converts rxvt-unicodes text reprsentation into a perl string. See	1789	Converts rxvt-unicodes text representation into a perl string. See
1116	C<< $term->ROW_t >> for details.	1790	C<< $term->ROW_t >> for details.
1117		1791
1118	=item $success = $term->grab_button ($button, $modifiermask)	1792	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1119		1793
		1794	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1795
1120	Registers a synchronous button grab. See the XGrabButton manpage.	1796	Register/unregister a synchronous button grab. See the XGrabButton
		1797	manpage.
1121		1798
1122	=item $success = $term->grab ($eventtime[, $sync])	1799	=item $success = $term->grab ($eventtime[, $sync])
1123		1800
1124	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1801	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1125	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1802	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1126		1803
1127	=item $term->allow_events_async	1804	=item $term->allow_events_async
1128		1805
1129	Calls XAllowEvents with AsyncBoth for the most recent grab.	1806	Calls XAllowEvents with AsyncBoth for the most recent grab.
1130		1807
…		…
1137	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1814	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1138	recent grab.	1815	recent grab.
1139		1816
1140	=item $term->ungrab	1817	=item $term->ungrab
1141		1818
1142	Calls XUngrab for the most recent grab. Is called automatically on	1819	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1143	evaluation errors, as it is better to lose the grab in the error case as	1820	evaluation errors, as it is better to lose the grab in the error case as
1144	the session.	1821	the session.
		1822
		1823	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1824
		1825	=item $atom_name = $term->XGetAtomName ($atom)
		1826
		1827	=item @atoms = $term->XListProperties ($window)
		1828
		1829	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1830
		1831	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1832
		1833	=item $term->XDeleteProperty ($window, $property)
		1834
		1835	=item $window = $term->DefaultRootWindow
		1836
		1837	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1838
		1839	=item $term->XMapWindow ($window)
		1840
		1841	=item $term->XUnmapWindow ($window)
		1842
		1843	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1844
		1845	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1846
		1847	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1848
		1849	=item $keysym = $term->XStringToKeysym ($string)
		1850
		1851	=item $string = $term->XKeysymToString ($keysym)
		1852
		1853	Various X or X-related functions. The C<$term> object only serves as
		1854	the source of the display, otherwise those functions map more-or-less
		1855	directly onto the X functions of the same name.
1145		1856
1146	=back	1857	=back
1147		1858
1148	=cut	1859	=cut
1149		1860
…		…
1165	$item->{render} ||= sub { $_[0]{text} };	1876	$item->{render} ||= sub { $_[0]{text} };
1166		1877
1167	push @{ $self->{item} }, $item;	1878	push @{ $self->{item} }, $item;
1168	}	1879	}
1169		1880
1170	sub add_separator {	1881	=item $popup->add_title ($title)
1171	my ($self, $sep) = @_;
1172		1882
1173	$sep ||= "═";	1883	Adds a non-clickable title to the popup.
1174		1884
1175	$self->add_item ({	1885	=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		1886
1183	sub add_title {	1887	sub add_title {
1184	my ($self, $title) = @_;	1888	my ($self, $title) = @_;
1185		1889
1186	$self->add_item ({	1890	$self->add_item ({
…		…
1188	text => $title,	1892	text => $title,
1189	activate => sub { },	1893	activate => sub { },
1190	});	1894	});
1191	}	1895	}
1192		1896
		1897	=item $popup->add_separator ([$sepchr])
		1898
		1899	Creates a separator, optionally using the character given as C<$sepchr>.
		1900
		1901	=cut
		1902
		1903	sub add_separator {
		1904	my ($self, $sep) = @_;
		1905
		1906	$sep ||= "=";
		1907
		1908	$self->add_item ({
		1909	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1910	text => "",
		1911	render => sub { $sep x $self->{term}->ncol },
		1912	activate => sub { },
		1913	});
		1914	}
		1915
		1916	=item $popup->add_button ($text, $cb)
		1917
		1918	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1919	selected.
		1920
		1921	=cut
		1922
1193	sub add_button {	1923	sub add_button {
1194	my ($self, $text, $cb) = @_;	1924	my ($self, $text, $cb) = @_;
1195		1925
1196	$self->add_item ({ type => "button", text => $text, activate => $cb});	1926	$self->add_item ({ type => "button", text => $text, activate => $cb});
1197	}	1927	}
1198		1928
		1929	=item $popup->add_toggle ($text, $initial_value, $cb)
		1930
		1931	Adds a toggle/checkbox item to the popup. The callback gets called
		1932	whenever it gets toggled, with a boolean indicating its new value as its
		1933	first argument.
		1934
		1935	=cut
		1936
1199	sub add_toggle {	1937	sub add_toggle {
1200	my ($self, $text, $cb, $value) = @_;	1938	my ($self, $text, $value, $cb) = @_;
1201		1939
1202	my $item; $item = {	1940	my $item; $item = {
1203	type => "button",	1941	type => "button",
1204	text => " $text",	1942	text => " $text",
1205	value => $value,	1943	value => $value,
1206	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1944	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1207	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1945	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1208	};	1946	};
1209		1947
1210	$self->add_item ($item);	1948	$self->add_item ($item);
1211	}	1949	}
		1950
		1951	=item $popup->show
		1952
		1953	Displays the popup (which is initially hidden).
		1954
		1955	=cut
1212		1956
1213	sub show {	1957	sub show {
1214	my ($self) = @_;	1958	my ($self) = @_;
1215		1959
1216	local $urxvt::popup::self = $self;	1960	local $urxvt::popup::self = $self;
1217		1961
1218	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1962	my $env = $self->{term}->env;
		1963	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1964	delete $env->{LC_ALL};
		1965	$env->{LC_CTYPE} = $self->{term}->locale;
		1966
		1967	my $term = urxvt::term->new (
		1968	$env, "popup",
		1969	"--perl-lib" => "", "--perl-ext-common" => "",
		1970	"-pty-fd" => -1, "-sl" => 0,
		1971	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1219	"--transient-for" => $self->{term}->parent,	1972	"--transient-for" => $self->{term}->parent,
1220	"-display" => $self->{term}->display_id,	1973	"-display" => $self->{term}->display_id,
1221	"-pe" => "urxvt-popup")	1974	"-pe" => "urxvt-popup",
1222	or die "unable to create popup window\n";	1975	) or die "unable to create popup window\n";
		1976
		1977	unless (delete $term->{urxvt_popup_init_done}) {
		1978	$term->ungrab;
		1979	$term->destroy;
		1980	die "unable to initialise popup window\n";
		1981	}
1223	}	1982	}
1224		1983
1225	sub DESTROY {	1984	sub DESTROY {
1226	my ($self) = @_;	1985	my ($self) = @_;
1227		1986
1228	delete $self->{term}{_destroy}{$self};	1987	delete $self->{term}{_destroy}{$self};
1229	$self->{term}->ungrab;	1988	$self->{term}->ungrab;
1230	}	1989	}
		1990
		1991	=back
		1992
		1993	=cut
		1994
		1995	package urxvt::watcher;
1231		1996
1232	=head2 The C<urxvt::timer> Class	1997	=head2 The C<urxvt::timer> Class
1233		1998
1234	This class implements timer watchers/events. Time is represented as a	1999	This class implements timer watchers/events. Time is represented as a
1235	fractional number of seconds since the epoch. Example:	2000	fractional number of seconds since the epoch. Example:
…		…
1239	->new	2004	->new
1240	->interval (1)	2005	->interval (1)
1241	->cb (sub {	2006	->cb (sub {
1242	$term->{overlay}->set (0, 0,	2007	$term->{overlay}->set (0, 0,
1243	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2008	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1244	});	2009	});
1245		2010
1246	=over 4	2011	=over 4
1247		2012
1248	=item $timer = new urxvt::timer	2013	=item $timer = new urxvt::timer
1249		2014
…		…
1252		2017
1253	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2018	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1254		2019
1255	Set the callback to be called when the timer triggers.	2020	Set the callback to be called when the timer triggers.
1256		2021
1257	=item $tstamp = $timer->at
1258
1259	Return the time this watcher will fire next.
1260
1261	=item $timer = $timer->set ($tstamp)	2022	=item $timer = $timer->set ($tstamp[, $interval])
1262		2023
1263	Set the time the event is generated to $tstamp.	2024	Set the time the event is generated to $tstamp (and optionally specifies a
		2025	new $interval).
1264		2026
1265	=item $timer = $timer->interval ($interval)	2027	=item $timer = $timer->interval ($interval)
1266		2028
1267	Normally (and when C<$interval> is C<0>), the timer will automatically	2029	By default (and when C<$interval> is C<0>), the timer will automatically
1268	stop after it has fired once. If C<$interval> is non-zero, then the timer	2030	stop after it has fired once. If C<$interval> is non-zero, then the timer
1269	is automatically rescheduled at the given intervals.	2031	is automatically rescheduled at the given intervals.
1270		2032
1271	=item $timer = $timer->start	2033	=item $timer = $timer->start
1272		2034
1273	Start the timer.	2035	Start the timer.
1274		2036
1275	=item $timer = $timer->start ($tstamp)	2037	=item $timer = $timer->start ($tstamp[, $interval])
1276		2038
1277	Set the event trigger time to C<$tstamp> and start the timer.	2039	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2040	also replaces the interval.
		2041
		2042	=item $timer = $timer->after ($delay[, $interval])
		2043
		2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1278		2045
1279	=item $timer = $timer->stop	2046	=item $timer = $timer->stop
1280		2047
1281	Stop the timer.	2048	Stop the timer.
1282		2049
…		…
1288		2055
1289	$term->{socket} = ...	2056	$term->{socket} = ...
1290	$term->{iow} = urxvt::iow	2057	$term->{iow} = urxvt::iow
1291	->new	2058	->new
1292	->fd (fileno $term->{socket})	2059	->fd (fileno $term->{socket})
1293	->events (1) # wait for read data	2060	->events (urxvt::EV_READ)
1294	->start	2061	->start
1295	->cb (sub {	2062	->cb (sub {
1296	my ($iow, $revents) = @_;	2063	my ($iow, $revents) = @_;
1297	# $revents must be 1 here, no need to check	2064	# $revents must be 1 here, no need to check
1298	sysread $term->{socket}, my $buf, 8192	2065	sysread $term->{socket}, my $buf, 8192
…		…
1311	Set the callback to be called when io events are triggered. C<$reventmask>	2078	Set the callback to be called when io events are triggered. C<$reventmask>
1312	is a bitset as described in the C<events> method.	2079	is a bitset as described in the C<events> method.
1313		2080
1314	=item $iow = $iow->fd ($fd)	2081	=item $iow = $iow->fd ($fd)
1315		2082
1316	Set the filedescriptor (not handle) to watch.	2083	Set the file descriptor (not handle) to watch.
1317		2084
1318	=item $iow = $iow->events ($eventmask)	2085	=item $iow = $iow->events ($eventmask)
1319		2086
1320	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2087	Set the event mask to watch. The only allowed values are
1321	data, Bit #1 (value C<2>) enables watching for write data.	2088	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		2089	together, or C<urxvt::EV_NONE>.
1322		2090
1323	=item $iow = $iow->start	2091	=item $iow = $iow->start
1324		2092
1325	Start watching for requested events on the given handle.	2093	Start watching for requested events on the given handle.
1326		2094
1327	=item $iow = $iow->stop	2095	=item $iow = $iow->stop
1328		2096
1329	Stop watching for events on the given filehandle.	2097	Stop watching for events on the given file handle.
		2098
		2099	=back
		2100
		2101	=head2 The C<urxvt::iw> Class
		2102
		2103	This class implements idle watchers, that get called automatically when
		2104	the process is idle. They should return as fast as possible, after doing
		2105	some useful work.
		2106
		2107	=over 4
		2108
		2109	=item $iw = new urxvt::iw
		2110
		2111	Create a new idle watcher object in stopped state.
		2112
		2113	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2114
		2115	Set the callback to be called when the watcher triggers.
		2116
		2117	=item $timer = $timer->start
		2118
		2119	Start the watcher.
		2120
		2121	=item $timer = $timer->stop
		2122
		2123	Stop the watcher.
		2124
		2125	=back
		2126
		2127	=head2 The C<urxvt::pw> Class
		2128
		2129	This class implements process watchers. They create an event whenever a
		2130	process exits, after which they stop automatically.
		2131
		2132	my $pid = fork;
		2133	...
		2134	$term->{pw} = urxvt::pw
		2135	->new
		2136	->start ($pid)
		2137	->cb (sub {
		2138	my ($pw, $exit_status) = @_;
		2139	...
		2140	});
		2141
		2142	=over 4
		2143
		2144	=item $pw = new urxvt::pw
		2145
		2146	Create a new process watcher in stopped state.
		2147
		2148	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2149
		2150	Set the callback to be called when the timer triggers.
		2151
		2152	=item $pw = $timer->start ($pid)
		2153
		2154	Tells the watcher to start watching for process C<$pid>.
		2155
		2156	=item $pw = $pw->stop
		2157
		2158	Stop the watcher.
1330		2159
1331	=back	2160	=back
1332		2161
1333	=head1 ENVIRONMENT	2162	=head1 ENVIRONMENT
1334		2163
…		…
1341		2170
1342	=item == 0 - fatal messages	2171	=item == 0 - fatal messages
1343		2172
1344	=item >= 3 - script loading and management	2173	=item >= 3 - script loading and management
1345		2174
1346	=item >=10 - all events received	2175	=item >=10 - all called hooks
		2176
		2177	=item >=11 - hook return values
1347		2178
1348	=back	2179	=back
1349		2180
1350	=head1 AUTHOR	2181	=head1 AUTHOR
1351		2182
1352	Marc Lehmann <pcg@goof.com>	2183	Marc Lehmann <schmorp@schmorp.de>
1353	http://software.schmorp.de/pkg/rxvt-unicode	2184	http://software.schmorp.de/pkg/rxvt-unicode
1354		2185
1355	=cut	2186	=cut
1356		2187
1357	1	2188	1
		2189
		2190	# vim: sw=3:

Diff Legend

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