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

Diff Legend

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