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.98 by root, Tue Jan 17 17:01:54 2006 UTC vs.
Revision 1.263 by sf-exg, Wed Jul 14 12:39:57 2021 UTC

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

Diff Legend

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