ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC vs.
Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 2014 UTC

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

Diff Legend

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