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.99 by root, Tue Jan 17 17:09:26 2006 UTC vs.
Revision 1.265 by root, Sat Jul 24 09:48:43 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 some directory:
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 instance using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib path/to/somedirectory -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). (The implementation is
171	not currently secure for use in a multiuser environment as it writes to
172	F</tmp> directly.).
173
174	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
175	i.e.
176
177	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
178
179	Pressing this combination runs a command with C<%> replaced by the name of
180	the textfile. This command can be set via a resource:
181
182	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
183
184	And the default is likely not useful to anybody but the few people around
185	here :)
186
187	The name of the textfile is the hex encoded md5 sum of the selection, so
188	the same content should lead to the same filename.
189
190	After a successful upload the selection will be replaced by the text given
191	in the C<selection-pastebin-url> resource (again, the % is the placeholder
192	for the filename):
193
194	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
195
196	=back
197		56
198	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
199		58
200	=head2 General API Considerations	59	=head2 General API Considerations
201		60
…		…
211	terminal is destroyed.	70	terminal is destroyed.
212		71
213	Argument names also often indicate the type of a parameter. Here are some	72	Argument names also often indicate the type of a parameter. Here are some
214	hints on what they mean:	73	hints on what they mean:
215		74
216	=over 4	75	=over
217		76
218	=item $text	77	=item $text
219		78
220	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
221	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.
222		81
223	=item $string	82	=item $string
224		83
225	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
…		…
229	=item $octets	88	=item $octets
230		89
231	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
232	locale-specific way.	91	locale-specific way.
233		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
234	=back	99	=back
235		100
236	=head2 Extension Objects	101	=head2 Extension Objects
237		102
238	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
239	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,
240	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
241	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
242	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
243	use.	109	internal use.
244		110
245	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
246	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
247		113
248	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.
249		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:
		125
250	=over 4	126	=over
251		127
252	=item $urxvt_term = $self->{term}	128	=item #:META:RESOURCE:name:type:desc
253		129
254	Returns the C<urxvt::term> object associated with this instance of the	130	The RESOURCE comment defines a resource used by the extension, where
255	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.
256		133
257	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	134	The extension will be autoloaded when this resource is specified or used
258		135	as a command line parameter.
259	Dynamically enable the given hooks (named without the C<on_> prefix) for
260	this extension, replacing any previous hook. This is useful when you want
261	to overwrite time-critical hooks only temporarily.
262
263	=item $self->disable ($hook_name[, $hook_name..])
264
265	Dynamically disable the given hooks.
266		136
267	=back	137	=back
268		138
269	=head2 Hooks	139	=head2 Hooks
270		140
271	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
272	called whenever the relevant event happens.	142	called whenever the relevant event happens.
273		143
274	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
275	the in the C<Extension Objects> section.	145	the in the C<Extension Objects> section.
276		146
277	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
278	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
279	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.
280		150
281	I<< When in doubt, return a false value (preferably C<()>). >>	151	I<< When in doubt, return a false value (preferably C<()>). >>
282		152
283	=over 4	153	=over
284		154
285	=item on_init $term	155	=item on_init $term
286		156
287	Called after a new terminal object has been initialized, but before	157	Called after a new terminal object has been initialized, but before
288	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
289	call or deliver senseless data, as terminal size and other characteristics	159	call or deliver senseless data, as terminal size and other characteristics
290	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
291	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).
292		173
293	=item on_reset $term	174	=item on_reset $term
294		175
295	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
296	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
297	variables.	178	variables.
298		179
299	=item on_start $term	180	=item on_child_start $term, $pid
300		181
301	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.
302	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>.
303		188
304	=item on_sel_make $term, $eventtime	189	=item on_sel_make $term, $eventtime
305		190
306	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
307	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
…		…
314		199
315	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
316	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
317	by calling C<< $term->selection >>.	202	by calling C<< $term->selection >>.
318		203
319	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.
320		205
321	=item on_sel_extend $term	206	=item on_sel_extend $term
322		207
323	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
324	click) and is either supposed to return false (normal operation), or	209	click) and is either supposed to return false (normal operation), or
325	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
326	processing. This can happen multiple times, as long as the callback	211	processing. This can happen multiple times, as long as the callback
327	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
328	supposed to enlarge the selection more and more, if possible.	213	supposed to enlarge the selection more and more, if possible.
329		214
330	See the F<selection> example extension.	215	See the F<selection> example extension.
331		216
332	=item on_view_change $term, $offset	217	=item on_view_change $term, $offset
333		218
334	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
335	scrolls. Offset C<0> means display the normal terminal, positive values	220	scrolls. Offset C<0> means display the normal terminal, positive values
336	show this many lines of scrollback.	221	show this many lines of scrollback.
337		222
338	=item on_scroll_back $term, $lines, $saved	223	=item on_scroll_back $term, $lines, $saved
339		224
…		…
343		228
344	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,
345	$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
346	number of lines that will be in the scrollback buffer.	231	number of lines that will be in the scrollback buffer.
347		232
348	=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
349		244
350	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	245	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
351	operating system command) is processed. Cursor position and other state	246	operating system command) is processed. Cursor position and other state
352	information is up-to-date when this happens. For interoperability, the	247	information is up-to-date when this happens. For interoperability, the
353	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,
354	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
355	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	}
356		261
357	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,
358	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
359	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.
360		268
361	=item on_add_lines $term, $string	269	=item on_add_lines $term, $string
362		270
363	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
364	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
…		…
369	=item on_tt_write $term, $octets	277	=item on_tt_write $term, $octets
370		278
371	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
372	suppress or filter tty input.	280	suppress or filter tty input.
373		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
374	=item on_line_update $term, $row	289	=item on_line_update $term, $row
375		290
376	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
377	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
378	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,
…		…
385	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
386	you cannot just toggle rendition bits, but only set them.	301	you cannot just toggle rendition bits, but only set them.
387		302
388	=item on_refresh_begin $term	303	=item on_refresh_begin $term
389		304
390	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
391	or similar effects by modify terminal contents in refresh_begin, and	306	similar effects by modifying the terminal contents in refresh_begin, and
392	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
393	code is run after this hook, and takes precedence.	308	code is run after this hook, and takes precedence.
394		309
395	=item on_refresh_end $term	310	=item on_refresh_end $term
396		311
397	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>.
398		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
399	=item on_keyboard_command $term, $string	322	=item on_user_command $term, $string *DEPRECATED*
400		323
401	Called whenever the user presses a key combination that has a	324	Called whenever a user-configured event is being activated (e.g. via
402	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>
403	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.
404		336
405	=item on_x_event $term, $event	337	=item on_x_event $term, $event
406		338
407	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
408	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
409	members are not passed.	341	members are not passed.
410		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
411	=item on_focus_in $term	347	=item on_focus_in $term
412		348
413	Called whenever the window gets the keyboard focus, before rxvt-unicode	349	Called whenever the window gets the keyboard focus, before rxvt-unicode
414	does focus in processing.	350	does focus in processing.
415		351
416	=item on_focus_out $term	352	=item on_focus_out $term
417		353
418	Called wheneever the window loses keyboard focus, before rxvt-unicode does	354	Called whenever the window loses keyboard focus, before rxvt-unicode does
419	focus out processing.	355	focus out processing.
420		356
		357	=item on_configure_notify $term, $event
		358
		359	=item on_property_notify $term, $event
		360
421	=item on_key_press $term, $event, $keysym, $octets	361	=item on_key_press $term, $event, $keysym, $octets
422		362
423	=item on_key_release $term, $event, $keysym	363	=item on_key_release $term, $event, $keysym
424		364
425	=item on_button_press $term, $event	365	=item on_button_press $term, $event
…		…
430		370
431	=item on_map_notify $term, $event	371	=item on_map_notify $term, $event
432		372
433	=item on_unmap_notify $term, $event	373	=item on_unmap_notify $term, $event
434		374
435	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
436	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.
437		377
438	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
439	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
440	and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
441		381
442	C<on_key_press> additionally receives the string rxvt-unicode would	382	C<on_key_press> additionally receives the string rxvt-unicode would
443	output, if any, in locale-specific encoding.	383	output, if any, in locale-specific encoding.
444		384
445	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.
446		397
447	=back	398	=back
448		399
449	=cut	400	=cut
450		401
451	package urxvt;	402	package urxvt;
452		403
453	use utf8;	404	use utf8;
454	use strict;	405	use strict 'vars';
455	use Carp ();	406	use Carp ();
456	use Scalar::Util ();	407	use Scalar::Util ();
457	use List::Util ();	408	use List::Util ();
458		409
459	our $VERSION = 1;	410	our $VERSION = 1;
460	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.
461	our @HOOKNAME;	414	our @HOOKNAME;
462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
463	our %OPTION;	416	our %OPTION;
464		417
465	our $LIBDIR;	418	our $LIBDIR;
466	our $RESNAME;	419	our $RESNAME;
467	our $RESCLASS;	420	our $RESCLASS;
468	our $RXVTNAME;	421	our $RXVTNAME;
469		422
		423	our $NOCHAR = chr 0xffff;
		424
470	=head2 Variables in the C<urxvt> Package	425	=head2 Variables in the C<urxvt> Package
471		426
472	=over 4	427	=over
473		428
474	=item $urxvt::LIBDIR	429	=item $urxvt::LIBDIR
475		430
476	The rxvt-unicode library directory, where, among other things, the perl	431	The rxvt-unicode library directory, where, among other things, the perl
477	modules and scripts are stored.	432	modules and scripts are stored.
…		…
487	=item $urxvt::TERM	442	=item $urxvt::TERM
488		443
489	The current terminal. This variable stores the current C<urxvt::term>	444	The current terminal. This variable stores the current C<urxvt::term>
490	object, whenever a callback/hook is executing.	445	object, whenever a callback/hook is executing.
491		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
492	=back	463	=back
493		464
494	=head2 Functions in the C<urxvt> Package	465	=head2 Functions in the C<urxvt> Package
495		466
496	=over 4	467	=over
497		468
498	=item urxvt::fatal $errormessage	469	=item urxvt::fatal $errormessage
499		470
500	Fatally aborts execution with the given error message. Avoid at all	471	Fatally aborts execution with the given error message (which should
501	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
502	starts up.	473	is acceptable (and useful) is in the init hook, where it prevents the
		474	terminal from starting up.
503		475
504	=item urxvt::warn $string	476	=item urxvt::warn $string
505		477
506	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
507	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
508	that calls this function.	480	that calls this function.
509		481
510	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
511	correct place, e.g. on stderr of the connecting urxvtc client.	483	correct place, e.g. on stderr of the connecting urxvtc client.
512		484
513	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).
514		493
515	=item $time = urxvt::NOW	494	=item $time = urxvt::NOW
516		495
517	Returns the "current time" (as per the event loop).	496	Returns the "current time" (as per the event loop).
518		497
…		…
538	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
539	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
540		519
541	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
542		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
543	=back	534	=back
544		535
545	=head2 RENDITION	536	=head2 RENDITION
546		537
547	Rendition bitsets contain information about colour, font, font styles and	538	Rendition bitsets contain information about colour, font, font styles and
…		…
550	The following "macros" deal with changes in rendition sets. You should	541	The following "macros" deal with changes in rendition sets. You should
551	never just create a bitset, you should always modify an existing one,	542	never just create a bitset, you should always modify an existing one,
552	as they contain important information required for correct operation of	543	as they contain important information required for correct operation of
553	rxvt-unicode.	544	rxvt-unicode.
554		545
555	=over 4	546	=over
556		547
557	=item $rend = urxvt::DEFAULT_RSTYLE	548	=item $rend = urxvt::DEFAULT_RSTYLE
558		549
559	Returns the default rendition, as used when the terminal is starting up or	550	Returns the default rendition, as used when the terminal is starting up or
560	being reset. Useful as a base to start when creating renditions.	551	being reset. Useful as a base to start when creating renditions.
561		552
562	=item $rend = urxvt::OVERLAY_RSTYLE	553	=item $rend = urxvt::OVERLAY_RSTYLE
563		554
564	Return the rendition mask used for overlays by default.	555	Return the rendition mask used for overlays by default.
565		556
566	=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
567		559
568	Return the bit that enabled bold, italic, blink, reverse-video and	560	Return the bit that enabled bold, italic, blink, reverse-video and
569	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
570	the bitset.	562	the bitset.
571		563
…		…
577		569
578	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	570	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
579		571
580	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	572	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
581		573
		574	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		575
582	Replace the foreground/background colour in the rendition mask with the	576	Replace the foreground/background colour in the rendition mask with the
583	specified one.	577	specified one.
584		578
585	=item $value = urxvt::GET_CUSTOM $rend	579	=item $value = urxvt::GET_CUSTOM $rend
586		580
…		…
595	=back	589	=back
596		590
597	=cut	591	=cut
598		592
599	BEGIN {	593	BEGIN {
600	urxvt->bootstrap;
601
602	# overwrite perl's warn	594	# overwrite perl's warn
603	*CORE::GLOBAL::warn = sub {	595	*CORE::GLOBAL::warn = sub {
604	my $msg = join "", @_;	596	my $msg = join "", @_;
605	$msg .= "\n"	597	$msg .= "\n"
606	unless $msg =~ /\n$/;	598	unless $msg =~ /\n$/;
607	urxvt::warn ($msg);	599	urxvt::warn ($msg);
608	};	600	};
		601	}
609		602
610	# %ENV is the original startup environment	603	no warnings 'utf8';
611	delete $ENV{IFS};	604
612	delete $ENV{CDPATH};	605	sub parse_resource {
613	delete $ENV{BASH_ENV};	606	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
614	$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	}
615	}	669	}
616		670
617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	671	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
618		672
619	sub verbose {	673	sub verbose {
620	my ($level, $msg) = @_;	674	my ($level, $msg) = @_;
621	warn "$msg\n" if $level <= $verbosity;	675	warn "$msg\n" if $level <= $verbosity;
622	}	676	}
623		677
624	my $extension_pkg = "extension0000";
625	my %extension_pkg;	678	my %extension_pkg;
626		679
627	# load a single script into its own package, once only	680	# load a single script into its own package, once only
628	sub extension_package($) {	681	sub extension_package($) {
629	my ($path) = @_;	682	my ($path) = @_;
630		683
631	$extension_pkg{$path} ||= do {	684	$extension_pkg{$path} ||= do {
632	my $pkg = "urxvt::" . ($extension_pkg++);	685	$path =~ /([^\/\\]+)$/;
		686	my $pkg = $1;
		687	$pkg =~ s/[^[:word:]]/_/g;
		688	$pkg = "urxvt::ext::$pkg";
633		689
634	verbose 3, "loading extension '$path' into package '$pkg'";	690	verbose 3, "loading extension '$path' into package '$pkg'";
		691
		692	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
635		693
636	open my $fh, "<:raw", $path	694	open my $fh, "<:raw", $path
637	or die "$path: $!";	695	or die "$path: $!";
638		696
639	my $source =	697	my $source =
640	"package $pkg; use strict; use utf8;\n"	698	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
641	. "use base urxvt::term::extension::;\n"
642	. "#line 1 \"$path\"\n{\n"	699	. "#line 1 \"$path\"\n{\n"
643	. (do { local $/; <$fh> })	700	. (do { local $/; <$fh> })
644	. "\n};\n1";	701	. "\n};\n1";
645		702
646	eval $source	703	eval $source
…		…
655	# called by the rxvt core	712	# called by the rxvt core
656	sub invoke {	713	sub invoke {
657	local $TERM = shift;	714	local $TERM = shift;
658	my $htype = shift;	715	my $htype = shift;
659		716
660	if ($htype == 0) { # INIT	717	if ($htype == HOOK_INIT) {
661	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	718	my @dirs = $TERM->perl_libdirs;
662		719
		720	$TERM->scan_extensions;
		721
663	my %ext_arg;	722	my %ext_arg;
664		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} },
665	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	735	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		736	) {
666	if ($_ eq "default") {	737	if ($_ eq "default") {
		738
		739	$ext_arg{$_} = []
667	$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
668	} elsif (/^-(.*)$/) {	751	} elsif (/^-(.*)$/) {
669	delete $ext_arg{$1};	752	delete $ext_arg{$1};
		753
670	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
671	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
		756
672	} else {	757	} else {
673	$ext_arg{$_} ||= [];	758	$ext_arg{$_} ||= [];
674	}	759	}
675	}	760	}
676		761
677	while (my ($ext, $argv) = each %ext_arg) {	762	for my $ext (sort keys %ext_arg) {
678	my @files = grep -f $_, map "$_/$ext", @dirs;	763	my @files = grep -f $_, map "$_/$ext", @dirs;
679		764
680	if (@files) {	765	if (@files) {
681	$TERM->register_package (extension_package $files[0], $argv);	766	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
682	} else {	767	} else {
683	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";
684	}	769	}
685	}	770	}
686		771
…		…
692		777
693	if (my $cb = $TERM->{_hook}[$htype]) {	778	if (my $cb = $TERM->{_hook}[$htype]) {
694	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	779	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
695	if $verbosity >= 10;	780	if $verbosity >= 10;
696		781
697	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";
698		788
699	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) {
700	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	796	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
701	and last;	797	$retval ||= $retval_;
702		798
703	if ($@) {	799	if ($@) {
704	$TERM->ungrab; # better to lose the grab than the session	800	$TERM->ungrab; # better to lose the grab than the session
705	warn $@;	801	warn $@;
706	}	802	}
…		…
708		804
709	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	805	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
710	if $verbosity >= 11;	806	if $verbosity >= 11;
711	}	807	}
712		808
713	if ($htype == 1) { # DESTROY	809	if ($htype == HOOK_DESTROY) {
714	# clear package objects	810	# clear package objects
715	%$_ = () for values %{ $TERM->{_pkg} };	811	%$_ = () for values %{ $TERM->{_pkg} };
716		812
717	# clear package	813	# clear package
718	%$TERM = ();	814	%$TERM = ();
719	}	815	}
720		816
721	$retval	817	$retval
722	}	818	}
723		819
724	sub exec_async(@) {	820	sub SET_COLOR($$$) {
725	my $pid = fork;	821	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
726
727	return
728	if !defined $pid or $pid;
729
730	%ENV = %{ $TERM->env };
731
732	exec @_;
733	_exit 255;
734	}	822	}
735		823
736	# 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	}
737		848
738	package urxvt::term::extension;	849	package urxvt::term::extension;
739		850
740	sub enable {	851	=head2 The C<urxvt::term::extension> class
741	my ($self, %hook) = @_;
742	my $pkg = $self->{_pkg};
743		852
744	while (my ($name, $cb) = each %hook) {	853	Each extension attached to a terminal object is represented by
745	my $htype = $HOOKTYPE{uc $name};	854	a C<urxvt::term::extension> object.
746	defined $htype
747	or Carp::croak "unsupported hook type '$name'";
748		855
749	$self->set_should_invoke ($htype, +1)	856	You can use these objects, which are passed to all callbacks to store any
750	unless exists $self->{term}{_hook}[$htype]{$pkg};	857	state related to the terminal and extension instance.
751		858
752	$self->{term}{_hook}[$htype]{$pkg} = $cb;	859	The methods (And data members) documented below can be called on extension
753	}	860	objects, in addition to call methods documented for the <urxvt::term>
754	}	861	class.
755		862
756	sub disable {	863	=over
757	my ($self, @hook) = @_;
758	my $pkg = $self->{_pkg};
759		864
760	for my $name (@hook) {	865	=item $urxvt_term = $self->{term}
761	my $htype = $HOOKTYPE{uc $name};
762	defined $htype
763	or Carp::croak "unsupported hook type '$name'";
764		866
765	$self->set_should_invoke ($htype, -1)	867	Returns the C<urxvt::term> object associated with this instance of the
766	if delete $self->{term}{_hook}[$htype]{$pkg};	868	extension. This member I<must not> be changed in any way.
767	}	869
768	}	870	=cut
769		871
770	our $AUTOLOAD;	872	our $AUTOLOAD;
771		873
772	sub AUTOLOAD {	874	sub AUTOLOAD {
773	$AUTOLOAD =~ /:([^:]+)$/	875	$AUTOLOAD =~ /:([^:]+)$/
…		…
786		888
787	sub DESTROY {	889	sub DESTROY {
788	# nop	890	# nop
789	}	891	}
790		892
791	# urxvt::destroy_hook	893	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
792		894
793	sub urxvt::destroy_hook::DESTROY {	895	sub urxvt::destroy_hook::DESTROY {
794	${$_[0]}->();	896	${$_[0]}->();
795	}	897	}
796		898
797	sub urxvt::destroy_hook(&) {	899	sub urxvt::destroy_hook(&) {
798	bless \shift, urxvt::destroy_hook::	900	bless \shift, urxvt::destroy_hook::
799	}	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
800		1025
801	package urxvt::anyevent;	1026	package urxvt::anyevent;
802		1027
803	=head2 The C<urxvt::anyevent> Class	1028	=head2 The C<urxvt::anyevent> Class
804		1029
805	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
806	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
807	further programming. The only exception is that you cannot wait on	1032	further programming. The only exception is that you cannot wait on
808	condition variables, but non-blocking condvar use is ok. What this means	1033	condition variables, but non-blocking condvar use is ok.
809	is that you cannot use blocking APIs, but the non-blocking variant should
810	work.
811		1034
812	=cut	1035	In practical terms this means is that you cannot use blocking APIs, but
		1036	the non-blocking variant should work.
813		1037
		1038	=cut
		1039
814	our $VERSION = 1;	1040	our $VERSION = '5.23';
815		1041
816	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1042	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
817	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1043	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
818		1044
819	sub timer {	1045	sub timer {
…		…
821		1047
822	my $cb = $arg{cb};	1048	my $cb = $arg{cb};
823		1049
824	urxvt::timer	1050	urxvt::timer
825	->new	1051	->new
826	->start (urxvt::NOW + $arg{after})	1052	->after ($arg{after}, $arg{interval})
827	->cb (sub {	1053	->cb ($arg{interval} ? $cb : sub {
828	$_[0]->stop; # need to cancel manually	1054	$_[0]->stop; # need to cancel manually
829	$cb->();	1055	$cb->();
830	})	1056	})
831	}	1057	}
832		1058
833	sub io {	1059	sub io {
834	my ($class, %arg) = @_;	1060	my ($class, %arg) = @_;
835		1061
836	my $cb = $arg{cb};	1062	my $cb = $arg{cb};
		1063	my $fd = fileno $arg{fh};
		1064	defined $fd or $fd = $arg{fh};
837		1065
838	bless [$arg{fh}, urxvt::iow	1066	bless [$arg{fh}, urxvt::iow
839	->new	1067	->new
840	->fd (fileno $arg{fh})	1068	->fd ($fd)
841	->events (($arg{poll} =~ /r/ ? 1 : 0)	1069	->events (($arg{poll} =~ /r/ ? 1 : 0)
842	| ($arg{poll} =~ /w/ ? 2 : 0))	1070	| ($arg{poll} =~ /w/ ? 2 : 0))
843	->start	1071	->start
844	->cb (sub {	1072	->cb ($cb)
845	$cb->(($_[1] & 1 ? 'r' : '')
846	. ($_[1] & 2 ? 'w' : ''));
847	})],
848	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	})
849	}	1099	}
850		1100
851	sub DESTROY {	1101	sub DESTROY {
852	$_[0][1]->stop;	1102	$_[0][1]->stop;
853	}	1103	}
854		1104
855	sub condvar {	1105	# only needed for AnyEvent < 6 compatibility
856	bless \my $flag, urxvt::anyevent::condvar::	1106	sub one_event {
857	}
858
859	sub urxvt::anyevent::condvar::broadcast {
860	${$_[0]}++;
861	}
862
863	sub urxvt::anyevent::condvar::wait {
864	unless (${$_[0]}) {
865	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";
866	}
867	}	1108	}
868		1109
869	package urxvt::term;	1110	package urxvt::term;
870		1111
871	=head2 The C<urxvt::term> Class	1112	=head2 The C<urxvt::term> Class
872		1113
873	=over 4	1114	=over
874		1115
875	=cut	1116	=cut
876		1117
877	# find on_xxx subs in the package and register them	1118	# find on_xxx subs in the package and register them
878	# as hooks	1119	# as hooks
879	sub register_package {	1120	sub register_package {
880	my ($self, $pkg, $argv) = @_;	1121	my ($self, $pkg, $argv) = @_;
881		1122
		1123	no strict 'refs';
		1124
		1125	urxvt::verbose 6, "register package $pkg to $self";
		1126
		1127	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1128
882	my $proxy = bless {	1129	my $proxy = bless {
883	_pkg => $pkg,	1130	_pkg => $pkg,
		1131	_name => ${"$pkg\::_NAME"}, # hackish
884	argv => $argv,	1132	argv => $argv,
885	}, $pkg;	1133	}, $pkg;
886	Scalar::Util::weaken ($proxy->{term} = $self);	1134	Scalar::Util::weaken ($proxy->{term} = $self);
887		1135
888	$self->{_pkg}{$pkg} = $proxy;	1136	$self->{_pkg}{$pkg} = $proxy;
889		1137
…		…
892	$proxy->enable ($name => $ref);	1140	$proxy->enable ($name => $ref);
893	}	1141	}
894	}	1142	}
895	}	1143	}
896		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
897	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
898		1221
899	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
900	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
901	hash which defines the environment of the new terminal.	1224	hash which defines the environment of the new terminal.
902		1225
903	Croaks (and probably outputs an error message) if the new instance	1226	Croaks (and probably outputs an error message) if the new instance
904	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
905	initialise perl, and the terminal object otherwise. The C<init> and	1228	initialise perl, and the terminal object otherwise. The C<init> and
906	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).
907		1231
908	=cut	1232	=cut
909		1233
910	sub new {	1234	sub new {
911	my ($class, $env, @args) = @_;	1235	my ($class, $env, @args) = @_;
912		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
913	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1240	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
914	}	1241	}
915		1242
916	=item $term->destroy	1243	=item $term->destroy
917		1244
918	Destroy the terminal object (close the window, free resources	1245	Destroy the terminal object (close the window, free resources
919	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
920	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	}
921		1273
922	=item $isset = $term->option ($optval[, $set])	1274	=item $isset = $term->option ($optval[, $set])
923		1275
924	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
925	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
926	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.
927		1279
928	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
929	source file F</src/optinc.h> to see the actual list:	1281	source file F</src/optinc.h> to see the actual list:
930		1282
931	borderLess console cursorBlink cursorUnderline hold iconic insecure	1283	borderLess buffered console cursorBlink cursorUnderline hold iconic
932	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1284	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1285	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
933	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1286	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
934	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1287	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
935	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1288	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
936	tripleclickwords utmpInhibit visualBell	1289	urgentOnBell utmpInhibit visualBell disablePasteBrackets
937		1290
938	=item $value = $term->resource ($name[, $newval])	1291	=item $value = $term->resource ($name[, $newval])
939		1292
940	Returns the current resource value associated with a given name and	1293	Returns the current resource value associated with a given name and
941	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>
…		…
950	likely change).	1303	likely change).
951		1304
952	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
953	terminal is destroyed, so changing options frequently will eat memory.	1306	terminal is destroyed, so changing options frequently will eat memory.
954		1307
955	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
956	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>
957	to see the actual list:	1310	to see the actual list:
958		1311
959	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1312	answerbackstring backgroundPixmap backspace_key blurradius
960	borderLess color cursorBlink cursorUnderline cutchars delete_key	1313	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
961	display_name embed ext_bwidth fade font geometry hold iconName	1314	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
962	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
963	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1317	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
964	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1318	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
965	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1319	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
966	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1320	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
967	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1321	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
968	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1322	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
969	shade term_name title transparent transparent_all tripleclickwords	1323	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
970	utmpInhibit visualBell	1324	term_name title transient_for transparent tripleclickwords urgentOnBell
		1325	utmpInhibit visualBell rewrapMode disablePasteBrackets
971		1326
972	=cut	1327	=cut
973		1328
974	sub resource($$;$) {	1329	sub resource($$;$) {
975	my ($self, $name) = (shift, shift);	1330	my ($self, $name) = (shift, shift);
976	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1331	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
977	&urxvt::term::_resource	1332	goto &urxvt::term::_resource
978	}	1333	}
979		1334
980	=item $value = $term->x_resource ($pattern)	1335	=item $value = $term->x_resource ($pattern)
981		1336
982	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
983	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
984	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
985	resource with that pattern exists.	1340	resource with that pattern exists.
986		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
987	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
988	only one resource database per display, and later invocations might return	1353	only one resource database per display, and later invocations might return
989	the wrong resources.	1354	the wrong resources.
990		1355
991	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1356	=item $value = $term->x_resource_boolean ($pattern)
992		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
993	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
994	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	}
995		1396
996	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
997		1398
998	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
999	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1007		1408
1008	=item ($row, $col) = $term->selection_beg ([$row, $col])	1409	=item ($row, $col) = $term->selection_beg ([$row, $col])
1009		1410
1010	=item ($row, $col) = $term->selection_end ([$row, $col])	1411	=item ($row, $col) = $term->selection_end ([$row, $col])
1011		1412
1012	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.
1013	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.
1014		1422
1015	=item $term->selection_make ($eventtime[, $rectangular])	1423	=item $term->selection_make ($eventtime[, $rectangular])
1016		1424
1017	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
1018	C<selection_end>. If C<$rectangular> is true (default: false), a	1426	C<selection_end>. If C<$rectangular> is true (default: false), a
1019	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
1020	a selection.	1428	a selection.
1021		1429
1022	=item $success = $term->selection_grab ($eventtime)	1430	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1023		1431
1024	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
1025	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
1026	is mostly useful from within C<on_sel_grab> hooks.	1435	is mostly useful from within C<on_sel_grab> hooks.
1027		1436
1028	=item $oldtext = $term->selection ([$newtext])	1437	=item $oldtext = $term->selection ([$newtext, $clipboard])
1029		1438
1030	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.
1031		1445
1032	=item $term->overlay_simple ($x, $y, $text)	1446	=item $term->overlay_simple ($x, $y, $text)
1033		1447
1034	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.
1035		1449
…		…
1063	This method returns an urxvt::overlay object. The overlay will be visible	1477	This method returns an urxvt::overlay object. The overlay will be visible
1064	as long as the perl object is referenced.	1478	as long as the perl object is referenced.
1065		1479
1066	The methods currently supported on C<urxvt::overlay> objects are:	1480	The methods currently supported on C<urxvt::overlay> objects are:
1067		1481
1068	=over 4	1482	=over
1069		1483
1070	=item $overlay->set ($x, $y, $text, $rend)	1484	=item $overlay->set ($x, $y, $text[, $rend])
1071		1485
1072	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
1073	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
1074	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.
1075		1491
1076	=item $overlay->hide	1492	=item $overlay->hide
1077		1493
1078	If visible, hide the overlay, but do not destroy it.	1494	If visible, hide the overlay, but do not destroy it.
1079		1495
…		…
1142		1558
1143	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1144		1560
1145	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
1146	running inside the terminal. It may not contain command sequences (escape	1562	running inside the terminal. It may not contain command sequences (escape
1147	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,
1148	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.
1149		1566
1150	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
1151	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
1152	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1153		1570
		1571	=item $term->scr_change_screen ($screen)
		1572
		1573	Switch to given screen - 0 primary, 1 secondary.
		1574
1154	=item $term->cmd_parse ($octets)	1575	=item $term->cmd_parse ($octets)
1155		1576
1156	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
1157	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1158	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1159		1580
1160	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1161		1582
1162	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
1163	pass characters instead of octets, you should convert your strings first	1585	characters instead of octets, you should convert your strings first to the
1164	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.
1165		1601
1166	=item $old_events = $term->pty_ev_events ([$new_events])	1602	=item $old_events = $term->pty_ev_events ([$new_events])
1167		1603
1168	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
1169	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
1170	description of C<< urxvt::timer->events >>. Make sure to always restore	1606	description of C<< urxvt::timer->events >>. Make sure to always restore
1171	the previous value.	1607	the previous value.
1172		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
1173	=item $windowid = $term->parent	1614	=item $windowid = $term->parent
1174		1615
1175	Return the window id of the toplevel window.	1616	Return the window id of the toplevel window.
1176		1617
1177	=item $windowid = $term->vt	1618	=item $windowid = $term->vt
…		…
1183	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
1184	to receive pointer events all the times:	1625	to receive pointer events all the times:
1185		1626
1186	$term->vt_emask_add (urxvt::PointerMotionMask);	1627	$term->vt_emask_add (urxvt::PointerMotionMask);
1187		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
1188	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1189		1644
1190	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1191		1646
1192	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1193		1648
1194	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1195		1650
1196	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1197		1652
1198	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1199		1654
1200	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1201		1656
1202	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1203		1658
1204	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1205		1660
1206	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1207		1662
1208	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1209		1664
1210	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1211		1666
1212	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.
1213		1669
1214	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1215		1671
1216	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1217		1673
…		…
1222	=item $env = $term->env	1678	=item $env = $term->env
1223		1679
1224	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
1225	similar to C<\%ENV>.	1681	similar to C<\%ENV>.
1226		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
1227	=cut	1692	=cut
1228		1693
1229	sub env {	1694	sub env {
1230	if (my $env = $_[0]->_env) {
1231	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1695	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1232	} else {
1233	+{ %ENV }
1234	}
1235	}	1696	}
1236		1697
1237	=item $modifiermask = $term->ModLevel3Mask	1698	=item $modifiermask = $term->ModLevel3Mask
1238		1699
1239	=item $modifiermask = $term->ModMetaMask	1700	=item $modifiermask = $term->ModMetaMask
…		…
1241	=item $modifiermask = $term->ModNumLockMask	1702	=item $modifiermask = $term->ModNumLockMask
1242		1703
1243	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
1244	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.
1245		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
1246	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1247		1726
1248	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,
1249	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
1250	this many lines into the scrollback buffer.	1729	the terminal contents. Lower values scroll this many lines into the
		1730	scrollback buffer.
1251		1731
1252	=item $term->want_refresh	1732	=item $term->want_refresh
1253		1733
1254	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1734	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1255	compare the on-screen display with its stored representation. If they	1735	compare the on-screen display with its stored representation. If they
1256	differ, it redraws the differences.	1736	differ, it redraws the differences.
1257		1737
1258	Used after changing terminal contents to display them.	1738	Used after changing terminal contents to display them.
1259		1739
		1740	=item $term->refresh_check
		1741
		1742	Checks if a refresh has been requested and, if so, schedules one.
		1743
1260	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1744	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1261		1745
1262	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 >>
1263	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
1264	terminal line. The scrollback buffer starts at line C<-1> and extends to
1265	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1748	terminal line. Nothing will be returned if a nonexistent line
1266	is requested.	1749	is requested.
1267		1750
1268	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
1269	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
1270	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
1271	automatically be updated.	1754	automatically be updated.
1272		1755
1273	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
1274	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)
1275	(C<chr 65535>). Characters with combining characters and other characters	1758	characters. Characters with combining characters and other characters that
1276	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
1277	characters in the private use area.	1760	in the private use area.
1278		1761
1279	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
1280	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
1281	characters.	1764	characters.
1282		1765
…		…
1310		1793
1311	Create and return a new C<urxvt::line> object that stores information	1794	Create and return a new C<urxvt::line> object that stores information
1312	about the logical line that row C<$row_number> is part of. It supports the	1795	about the logical line that row C<$row_number> is part of. It supports the
1313	following methods:	1796	following methods:
1314		1797
1315	=over 4	1798	=over
1316		1799
1317	=item $text = $line->t ([$new_text])	1800	=item $text = $line->t ([$new_text])
1318		1801
1319	Returns or replaces the full text of the line, similar to C<ROW_t>	1802	Returns or replaces the full text of the line, similar to C<ROW_t>
1320		1803
…		…
1366	}	1849	}
1367		1850
1368	sub urxvt::line::t {	1851	sub urxvt::line::t {
1369	my ($self) = @_;	1852	my ($self) = @_;
1370		1853
1371	if (@_ > 1)	1854	if (@_ > 1) {
1372	{
1373	$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})
1374	for $self->{beg} .. $self->{end};	1856	for $self->{beg} .. $self->{end};
1375	}	1857	}
1376		1858
1377	defined wantarray &&	1859	defined wantarray &&
1378	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1860	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1379	0, $self->{len}	1861	0, $self->{len}
1380	}	1862	}
1381		1863
1382	sub urxvt::line::r {	1864	sub urxvt::line::r {
1383	my ($self) = @_;	1865	my ($self) = @_;
1384		1866
1385	if (@_ > 1)	1867	if (@_ > 1) {
1386	{
1387	$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})
1388	for $self->{beg} .. $self->{end};	1869	for $self->{beg} .. $self->{end};
1389	}	1870	}
1390		1871
1391	if (defined wantarray) {	1872	if (defined wantarray) {
1392	my $rend = [	1873	my $rend = [
1393	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1874	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1394	];	1875	];
…		…
1426	where one character corresponds to one screen cell. See	1907	where one character corresponds to one screen cell. See
1427	C<< $term->ROW_t >> for details.	1908	C<< $term->ROW_t >> for details.
1428		1909
1429	=item $string = $term->special_decode $text	1910	=item $string = $term->special_decode $text
1430		1911
1431	Converts rxvt-unicodes text reprsentation into a perl string. See	1912	Converts rxvt-unicodes text representation into a perl string. See
1432	C<< $term->ROW_t >> for details.	1913	C<< $term->ROW_t >> for details.
1433		1914
1434	=item $success = $term->grab_button ($button, $modifiermask)	1915	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1435		1916
		1917	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1918
1436	Registers a synchronous button grab. See the XGrabButton manpage.	1919	Register/unregister a synchronous button grab. See the XGrabButton
		1920	manpage.
1437		1921
1438	=item $success = $term->grab ($eventtime[, $sync])	1922	=item $success = $term->grab ($eventtime[, $sync])
1439		1923
1440	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1924	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1441	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1925	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1442		1926
1443	=item $term->allow_events_async	1927	=item $term->allow_events_async
1444		1928
1445	Calls XAllowEvents with AsyncBoth for the most recent grab.	1929	Calls XAllowEvents with AsyncBoth for the most recent grab.
1446		1930
…		…
1453	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1937	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1454	recent grab.	1938	recent grab.
1455		1939
1456	=item $term->ungrab	1940	=item $term->ungrab
1457		1941
1458	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
1459	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
1460	the session.	1944	the session.
1461		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.
		1979
1462	=back	1980	=back
1463		1981
1464	=cut	1982	=cut
1465		1983
1466	package urxvt::popup;	1984	package urxvt::popup;
1467		1985
1468	=head2 The C<urxvt::popup> Class	1986	=head2 The C<urxvt::popup> Class
1469		1987
1470	=over 4	1988	=over
1471		1989
1472	=cut	1990	=cut
1473		1991
1474	sub add_item {	1992	sub add_item {
1475	my ($self, $item) = @_;	1993	my ($self, $item) = @_;
…		…
1529	my ($self, $text, $cb) = @_;	2047	my ($self, $text, $cb) = @_;
1530		2048
1531	$self->add_item ({ type => "button", text => $text, activate => $cb});	2049	$self->add_item ({ type => "button", text => $text, activate => $cb});
1532	}	2050	}
1533		2051
1534	=item $popup->add_toggle ($text, $cb, $initial_value)	2052	=item $popup->add_toggle ($text, $initial_value, $cb)
1535		2053
1536	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
1537	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
1538	argument.	2056	first argument.
1539		2057
1540	=cut	2058	=cut
1541		2059
1542	sub add_toggle {	2060	sub add_toggle {
1543	my ($self, $text, $cb, $value) = @_;	2061	my ($self, $text, $value, $cb) = @_;
1544		2062
1545	my $item; $item = {	2063	my $item; $item = {
1546	type => "button",	2064	type => "button",
1547	text => " $text",	2065	text => " $text",
1548	value => $value,	2066	value => $value,
…		…
1567	my $env = $self->{term}->env;	2085	my $env = $self->{term}->env;
1568	# 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.
1569	delete $env->{LC_ALL};	2087	delete $env->{LC_ALL};
1570	$env->{LC_CTYPE} = $self->{term}->locale;	2088	$env->{LC_CTYPE} = $self->{term}->locale;
1571		2089
1572	urxvt::term->new ($env, $self->{term}->resource ("name"),	2090	my $term = urxvt::term->new (
1573	"--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",
1574	"--transient-for" => $self->{term}->parent,	2095	"--transient-for" => $self->{term}->parent,
1575	"-display" => $self->{term}->display_id,	2096	"-display" => $self->{term}->display_id,
1576	"-pe" => "urxvt-popup")	2097	"-pe" => "urxvt-popup",
1577	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	}
1578	}	2105	}
1579		2106
1580	sub DESTROY {	2107	sub DESTROY {
1581	my ($self) = @_;	2108	my ($self) = @_;
1582		2109
1583	delete $self->{term}{_destroy}{$self};	2110	delete $self->{term}{_destroy}{$self};
1584	$self->{term}->ungrab;	2111	$self->{term}->ungrab;
1585	}	2112	}
1586		2113
1587	=back	2114	=back
		2115
		2116	=cut
		2117
		2118	package urxvt::watcher;
1588		2119
1589	=head2 The C<urxvt::timer> Class	2120	=head2 The C<urxvt::timer> Class
1590		2121
1591	This class implements timer watchers/events. Time is represented as a	2122	This class implements timer watchers/events. Time is represented as a
1592	fractional number of seconds since the epoch. Example:	2123	fractional number of seconds since the epoch. Example:
…		…
1596	->new	2127	->new
1597	->interval (1)	2128	->interval (1)
1598	->cb (sub {	2129	->cb (sub {
1599	$term->{overlay}->set (0, 0,	2130	$term->{overlay}->set (0, 0,
1600	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2131	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1601	});	2132	});
1602		2133
1603	=over 4	2134	=over
1604		2135
1605	=item $timer = new urxvt::timer	2136	=item $timer = new urxvt::timer
1606		2137
1607	Create a new timer object in started state. It is scheduled to fire	2138	Create a new timer object in started state. It is scheduled to fire
1608	immediately.	2139	immediately.
1609		2140
1610	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2141	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1611		2142
1612	Set the callback to be called when the timer triggers.	2143	Set the callback to be called when the timer triggers.
1613		2144
1614	=item $tstamp = $timer->at
1615
1616	Return the time this watcher will fire next.
1617
1618	=item $timer = $timer->set ($tstamp)	2145	=item $timer = $timer->set ($tstamp[, $interval])
1619		2146
1620	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).
1621		2149
1622	=item $timer = $timer->interval ($interval)	2150	=item $timer = $timer->interval ($interval)
1623		2151
1624	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
1625	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
1626	is automatically rescheduled at the given intervals.	2154	is automatically rescheduled at the given intervals.
1627		2155
1628	=item $timer = $timer->start	2156	=item $timer = $timer->start
1629		2157
1630	Start the timer.	2158	Start the timer.
1631		2159
1632	=item $timer = $timer->start ($tstamp)	2160	=item $timer = $timer->start ($tstamp[, $interval])
1633		2161
1634	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>.
1635		2168
1636	=item $timer = $timer->stop	2169	=item $timer = $timer->stop
1637		2170
1638	Stop the timer.	2171	Stop the timer.
1639		2172
…		…
1645		2178
1646	$term->{socket} = ...	2179	$term->{socket} = ...
1647	$term->{iow} = urxvt::iow	2180	$term->{iow} = urxvt::iow
1648	->new	2181	->new
1649	->fd (fileno $term->{socket})	2182	->fd (fileno $term->{socket})
1650	->events (urxvt::EVENT_READ)	2183	->events (urxvt::EV_READ)
1651	->start	2184	->start
1652	->cb (sub {	2185	->cb (sub {
1653	my ($iow, $revents) = @_;	2186	my ($iow, $revents) = @_;
1654	# $revents must be 1 here, no need to check	2187	# $revents must be 1 here, no need to check
1655	sysread $term->{socket}, my $buf, 8192	2188	sysread $term->{socket}, my $buf, 8192
1656	or end-of-file;	2189	or end-of-file;
1657	});	2190	});
1658		2191
1659		2192
1660	=over 4	2193	=over
1661		2194
1662	=item $iow = new urxvt::iow	2195	=item $iow = new urxvt::iow
1663		2196
1664	Create a new io watcher object in stopped state.	2197	Create a new io watcher object in stopped state.
1665		2198
…		…
1668	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>
1669	is a bitset as described in the C<events> method.	2202	is a bitset as described in the C<events> method.
1670		2203
1671	=item $iow = $iow->fd ($fd)	2204	=item $iow = $iow->fd ($fd)
1672		2205
1673	Set the filedescriptor (not handle) to watch.	2206	Set the file descriptor (not handle) to watch.
1674		2207
1675	=item $iow = $iow->events ($eventmask)	2208	=item $iow = $iow->events ($eventmask)
1676		2209
1677	Set the event mask to watch. The only allowed values are	2210	Set the event mask to watch. The only allowed values are
1678	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
1679	together, or C<urxvt::EVENT_NONE>.	2212	together, or C<urxvt::EV_NONE>.
1680		2213
1681	=item $iow = $iow->start	2214	=item $iow = $iow->start
1682		2215
1683	Start watching for requested events on the given handle.	2216	Start watching for requested events on the given handle.
1684		2217
1685	=item $iow = $iow->stop	2218	=item $iow = $iow->stop
1686		2219
1687	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
		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
		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.
1688		2282
1689	=back	2283	=back
1690		2284
1691	=head1 ENVIRONMENT	2285	=head1 ENVIRONMENT
1692		2286
1693	=head2 URXVT_PERL_VERBOSITY	2287	=head2 URXVT_PERL_VERBOSITY
1694		2288
1695	This variable controls the verbosity level of the perl extension. Higher	2289	This variable controls the verbosity level of the perl extension. Higher
1696	numbers indicate more verbose output.	2290	numbers indicate more verbose output.
1697		2291
1698	=over 4	2292	=over
1699		2293
1700	=item == 0 - fatal messages	2294	=item == 0 - fatal messages
1701		2295
1702	=item >= 3 - script loading and management	2296	=item >= 3 - script loading and management
1703		2297
1704	=item >=10 - all called hooks	2298	=item >=10 - all called hooks
1705		2299
1706	=item >=11 - hook reutrn values	2300	=item >=11 - hook return values
1707		2301
1708	=back	2302	=back
1709		2303
1710	=head1 AUTHOR	2304	=head1 AUTHOR
1711		2305
1712	Marc Lehmann <pcg@goof.com>	2306	Marc Lehmann <schmorp@schmorp.de>
1713	http://software.schmorp.de/pkg/rxvt-unicode	2307	http://software.schmorp.de/pkg/rxvt-unicode
1714		2308
1715	=cut	2309	=cut
1716		2310
1717	1	2311	1
		2312
		2313	# vim: sw=3:

Diff Legend

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