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.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.251 by root, Fri Dec 26 22:52:23 2014 UTC

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

Diff Legend

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