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.106 by root, Wed Jan 18 19:44:22 2006 UTC vs.
Revision 1.240 by sf-exg, Fri Oct 10 14:32:32 2014 UTC

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

Diff Legend

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