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

Diff Legend

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