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.103 by root, Wed Jan 18 11:05:09 2006 UTC vs.
Revision 1.232 by sf-exg, Fri May 2 20:33:56 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 block-graphics-to-ascii
170
171	A not very useful example of filtering all text output to the terminal,
172	by replacing all line-drawing characters (U+2500 .. U+259F) by a
173	similar-looking ascii character.
174
175	=item digital-clock
176
177	Displays a digital clock using the built-in overlay.
178
179	=item example-refresh-hooks
180
181	Displays a very simple digital clock in the upper right corner of the
182	window. Illustrates overwriting the refresh callbacks to create your own
183	overlays or changes.
184
185	=item selection-pastebin
186
187	This is a little rarely useful extension that Uploads the selection as
188	textfile to a remote site (or does other things). (The implementation is
189	not currently secure for use in a multiuser environment as it writes to
190	F</tmp> directly.).
191
192	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
193	i.e.
194
195	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
196
197	Pressing this combination runs a command with C<%> replaced by the name of
198	the textfile. This command can be set via a resource:
199
200	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
201
202	And the default is likely not useful to anybody but the few people around
203	here :)
204
205	The name of the textfile is the hex encoded md5 sum of the selection, so
206	the same content should lead to the same filename.
207
208	After a successful upload the selection will be replaced by the text given
209	in the C<selection-pastebin-url> resource (again, the % is the placeholder
210	for the filename):
211
212	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
213
214	=back
215		50
216	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
217		52
218	=head2 General API Considerations	53	=head2 General API Considerations
219		54
…		…
233		68
234	=over 4	69	=over 4
235		70
236	=item $text	71	=item $text
237		72
238	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
239	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.
240		75
241	=item $string	76	=item $string
242		77
243	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
…		…
247	=item $octets	82	=item $octets
248		83
249	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
250	locale-specific way.	85	locale-specific way.
251		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
252	=back	93	=back
253		94
254	=head2 Extension Objects	95	=head2 Extension Objects
255		96
256	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
257	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,
258	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
259	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
260	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
261	use.	103	internal use.
262		104
263	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
264	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
265		107
266	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
267		109	the C<urxvt::extension> section below.
268	=over 4
269
270	=item $urxvt_term = $self->{term}
271
272	Returns the C<urxvt::term> object associated with this instance of the
273	extension. This member I<must not> be changed in any way.
274
275	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
276
277	Dynamically enable the given hooks (named without the C<on_> prefix) for
278	this extension, replacing any previous hook. This is useful when you want
279	to overwrite time-critical hooks only temporarily.
280
281	=item $self->disable ($hook_name[, $hook_name..])
282
283	Dynamically disable the given hooks.
284
285	=back
286		110
287	=head2 Hooks	111	=head2 Hooks
288		112
289	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
290	called whenever the relevant event happens.	114	called whenever the relevant event happens.
291		115
292	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
293	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
294		118
295	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
296	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
297	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.
298		122
299	I<< When in doubt, return a false value (preferably C<()>). >>	123	I<< When in doubt, return a false value (preferably C<()>). >>
300		124
301	=over 4	125	=over 4
302		126
303	=item on_init $term	127	=item on_init $term
304		128
305	Called after a new terminal object has been initialized, but before	129	Called after a new terminal object has been initialized, but before
306	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
307	call or deliver senseless data, as terminal size and other characteristics	131	call or deliver senseless data, as terminal size and other characteristics
308	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
309	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).
310		145
311	=item on_reset $term	146	=item on_reset $term
312		147
313	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
314	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
315	variables.	150	variables.
316		151
317	=item on_start $term	152	=item on_child_start $term, $pid
318		153
319	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.
320	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>.
321		160
322	=item on_sel_make $term, $eventtime	161	=item on_sel_make $term, $eventtime
323		162
324	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
325	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
…		…
332		171
333	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
334	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
335	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
336		175
337	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.
338		177
339	=item on_sel_extend $term	178	=item on_sel_extend $term
340		179
341	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
342	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
343	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
344	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
345	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
346	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
347		186
348	See the F<selection> example extension.	187	See the F<selection> example extension.
349		188
350	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
351		190
352	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
353	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
354	show this many lines of scrollback.	193	show this many lines of scrollback.
355		194
356	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
357		196
…		…
361		200
362	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,
363	$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
364	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
365		204
366	=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
367		216
368	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
369	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
370	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
371	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,
372	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
373	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	}
374		233
375	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,
376	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
377	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.
378		240
379	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
380		242
381	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
382	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
…		…
387	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
388		250
389	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
390	suppress or filter tty input.	252	suppress or filter tty input.
391		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
392	=item on_line_update $term, $row	261	=item on_line_update $term, $row
393		262
394	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
395	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
396	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,
…		…
403	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
404	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
405		274
406	=item on_refresh_begin $term	275	=item on_refresh_begin $term
407		276
408	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
409	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
410	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
411	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
412		281
413	=item on_refresh_end $term	282	=item on_refresh_end $term
414		283
415	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>.
416		285
417	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
418		287
419	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
420	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>
421	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<< ->register_keysym_action >> method.
		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.
422		300
423	=item on_x_event $term, $event	301	=item on_x_event $term, $event
424		302
425	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
426	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
427	members are not passed.	305	members are not passed.
428		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
429	=item on_focus_in $term	311	=item on_focus_in $term
430		312
431	Called whenever the window gets the keyboard focus, before rxvt-unicode	313	Called whenever the window gets the keyboard focus, before rxvt-unicode
432	does focus in processing.	314	does focus in processing.
433		315
434	=item on_focus_out $term	316	=item on_focus_out $term
435		317
436	Called wheneever the window loses keyboard focus, before rxvt-unicode does	318	Called whenever the window loses keyboard focus, before rxvt-unicode does
437	focus out processing.	319	focus out processing.
438		320
439	=item on_configure_notify $term, $event	321	=item on_configure_notify $term, $event
440		322
		323	=item on_property_notify $term, $event
		324
441	=item on_key_press $term, $event, $keysym, $octets	325	=item on_key_press $term, $event, $keysym, $octets
442		326
443	=item on_key_release $term, $event, $keysym	327	=item on_key_release $term, $event, $keysym
444		328
445	=item on_button_press $term, $event	329	=item on_button_press $term, $event
…		…
450		334
451	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
452		336
453	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
454		338
455	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
456	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.
457		341
458	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
459	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
460	and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
461		345
462	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
463	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
464		348
465	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.
466		361
467	=back	362	=back
468		363
469	=cut	364	=cut
470		365
471	package urxvt;	366	package urxvt;
472		367
473	use utf8;	368	use utf8;
474	use strict;	369	use strict 'vars';
475	use Carp ();	370	use Carp ();
476	use Scalar::Util ();	371	use Scalar::Util ();
477	use List::Util ();	372	use List::Util ();
478		373
479	our $VERSION = 1;	374	our $VERSION = 1;
480	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.
481	our @HOOKNAME;	378	our @HOOKNAME;
482	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
483	our %OPTION;	380	our %OPTION;
484		381
485	our $LIBDIR;	382	our $LIBDIR;
486	our $RESNAME;	383	our $RESNAME;
487	our $RESCLASS;	384	our $RESCLASS;
488	our $RXVTNAME;	385	our $RXVTNAME;
489		386
		387	our $NOCHAR = chr 0xffff;
		388
490	=head2 Variables in the C<urxvt> Package	389	=head2 Variables in the C<urxvt> Package
491		390
492	=over 4	391	=over 4
493		392
494	=item $urxvt::LIBDIR	393	=item $urxvt::LIBDIR
…		…
507	=item $urxvt::TERM	406	=item $urxvt::TERM
508		407
509	The current terminal. This variable stores the current C<urxvt::term>	408	The current terminal. This variable stores the current C<urxvt::term>
510	object, whenever a callback/hook is executing.	409	object, whenever a callback/hook is executing.
511		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
512	=back	427	=back
513		428
514	=head2 Functions in the C<urxvt> Package	429	=head2 Functions in the C<urxvt> Package
515		430
516	=over 4	431	=over 4
517		432
518	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
519		434
520	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
521	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
522	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
523		439
524	=item urxvt::warn $string	440	=item urxvt::warn $string
525		441
526	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
527	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
528	that calls this function.	444	that calls this function.
529		445
530	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
531	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
532		448
533	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).
534		457
535	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
536		459
537	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
538		461
…		…
581		504
582	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
583		506
584	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
585		508
586	=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
587		511
588	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
589	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
590	the bitset.	514	the bitset.
591		515
…		…
596	Return the foreground/background colour index, respectively.	520	Return the foreground/background colour index, respectively.
597		521
598	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	522	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
599		523
600	=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
601		527
602	Replace the foreground/background colour in the rendition mask with the	528	Replace the foreground/background colour in the rendition mask with the
603	specified one.	529	specified one.
604		530
605	=item $value = urxvt::GET_CUSTOM $rend	531	=item $value = urxvt::GET_CUSTOM $rend
…		…
622	my $msg = join "", @_;	548	my $msg = join "", @_;
623	$msg .= "\n"	549	$msg .= "\n"
624	unless $msg =~ /\n$/;	550	unless $msg =~ /\n$/;
625	urxvt::warn ($msg);	551	urxvt::warn ($msg);
626	};	552	};
		553	}
627		554
628	# %ENV is the original startup environment	555	no warnings 'utf8';
629	delete $ENV{IFS};	556
630	delete $ENV{CDPATH};	557	sub parse_resource {
631	delete $ENV{BASH_ENV};	558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
632	$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_meta;
		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_meta;
		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	}
633	}	615	}
634		616
635	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
636		618
637	sub verbose {	619	sub verbose {
…		…
642	my %extension_pkg;	624	my %extension_pkg;
643		625
644	# load a single script into its own package, once only	626	# load a single script into its own package, once only
645	sub extension_package($) {	627	sub extension_package($) {
646	my ($path) = @_;	628	my ($path) = @_;
647
648	no strict 'refs';
649		629
650	$extension_pkg{$path} ||= do {	630	$extension_pkg{$path} ||= do {
651	$path =~ /([^\/\\]+)$/;	631	$path =~ /([^\/\\]+)$/;
652	my $pkg = $1;	632	my $pkg = $1;
653	$pkg =~ s/[^[:word:]]/_/g;	633	$pkg =~ s/[^[:word:]]/_/g;
654	$pkg = "urxvt::ext::$pkg";	634	$pkg = "urxvt::ext::$pkg";
655		635
656	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
657		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		639
658	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
659	or die "$path: $!";	641	or die "$path: $!";
660		642
661	@{"$pkg\::ISA"} = urxvt::term::extension::;
662
663	my $source =	643	my $source =
664	"package $pkg; use strict; use utf8;\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
665	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
666	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
667	. "\n};\n1";	647	. "\n};\n1";
668		648
669	eval $source	649	eval $source
…		…
678	# called by the rxvt core	658	# called by the rxvt core
679	sub invoke {	659	sub invoke {
680	local $TERM = shift;	660	local $TERM = shift;
681	my $htype = shift;	661	my $htype = shift;
682		662
683	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
684	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
685		665
686	my %ext_arg;	666	my %ext_arg;
687		667
		668	{
		669	my @init = @TERM_INIT;
		670	@TERM_INIT = ();
		671	$_->($TERM) for @init;
		672	my @pkg = @TERM_EXT;
		673	@TERM_EXT = ();
		674	$TERM->register_package ($_) for @pkg;
		675	}
		676
		677	for (
		678	@{ delete $TERM->{perl_ext_3} },
688	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	679	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		680	) {
689	if ($_ eq "default") {	681	if ($_ eq "default") {
690	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	682	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
691	} elsif (/^-(.*)$/) {	683	} elsif (/^-(.*)$/) {
692	delete $ext_arg{$1};	684	delete $ext_arg{$1};
693	} elsif (/^([^<]+)<(.*)>$/) {	685	} elsif (/^([^<]+)<(.*)>$/) {
694	push @{ $ext_arg{$1} }, $2;	686	push @{ $ext_arg{$1} }, $2;
695	} else {	687	} else {
696	$ext_arg{$_} ||= [];	688	$ext_arg{$_} ||= [];
697	}	689	}
698	}	690	}
699		691
700	while (my ($ext, $argv) = each %ext_arg) {	692	for my $ext (sort keys %ext_arg) {
701	my @files = grep -f $_, map "$_/$ext", @dirs;	693	my @files = grep -f $_, map "$_/$ext", @dirs;
702		694
703	if (@files) {	695	if (@files) {
704	$TERM->register_package (extension_package $files[0], $argv);	696	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
705	} else {	697	} else {
706	warn "perl extension '$ext' not found in perl library search path\n";	698	warn "perl extension '$ext' not found in perl library search path\n";
707	}	699	}
708	}	700	}
709		701
…		…
715		707
716	if (my $cb = $TERM->{_hook}[$htype]) {	708	if (my $cb = $TERM->{_hook}[$htype]) {
717	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	709	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
718	if $verbosity >= 10;	710	if $verbosity >= 10;
719		711
		712	for my $pkg (
		713	# this hook is only sent to the extension with the name
		714	# matching the first arg
		715	$htype == HOOK_KEYBOARD_DISPATCH
		716	? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef
720	keys %$cb;	717	: keys %$cb
721		718	) {
722	while (my ($pkg, $cb) = each %$cb) {
723	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	719	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
724	and last;	720	$retval ||= $retval_;
725		721
726	if ($@) {	722	if ($@) {
727	$TERM->ungrab; # better to lose the grab than the session	723	$TERM->ungrab; # better to lose the grab than the session
728	warn $@;	724	warn $@;
729	}	725	}
…		…
731		727
732	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	728	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
733	if $verbosity >= 11;	729	if $verbosity >= 11;
734	}	730	}
735		731
736	if ($htype == 1) { # DESTROY	732	if ($htype == HOOK_DESTROY) {
737	# clear package objects	733	# clear package objects
738	%$_ = () for values %{ $TERM->{_pkg} };	734	%$_ = () for values %{ $TERM->{_pkg} };
739		735
740	# clear package	736	# clear package
741	%$TERM = ();	737	%$TERM = ();
742	}	738	}
743		739
744	$retval	740	$retval
745	}	741	}
746		742
747	sub exec_async(@) {	743	sub SET_COLOR($$$) {
748	my $pid = fork;	744	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
749
750	return
751	if !defined $pid or $pid;
752
753	%ENV = %{ $TERM->env };
754
755	exec @_;
756	_exit 255;
757	}	745	}
758		746
759	# urxvt::term::extension	747	sub rend2mask {
		748	no strict 'refs';
		749	my ($str, $mask) = (@_, 0);
		750	my %color = ( fg => undef, bg => undef );
		751	my @failed;
		752	for my $spec ( split /\s+/, $str ) {
		753	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		754	$color{lc($1)} = $2;
		755	} else {
		756	my $neg = $spec =~ s/^[-^]//;
		757	unless ( exists &{"RS_$spec"} ) {
		758	push @failed, $spec;
		759	next;
		760	}
		761	my $cur = &{"RS_$spec"};
		762	if ( $neg ) {
		763	$mask &= ~$cur;
		764	} else {
		765	$mask |= $cur;
		766	}
		767	}
		768	}
		769	($mask, @color{qw(fg bg)}, \@failed)
		770	}
760		771
761	package urxvt::term::extension;	772	package urxvt::term::extension;
762		773
763	sub enable {	774	=head2 The C<urxvt::term::extension> class
764	my ($self, %hook) = @_;
765	my $pkg = $self->{_pkg};
766		775
767	while (my ($name, $cb) = each %hook) {	776	Each extension attached to a terminal object is represented by
768	my $htype = $HOOKTYPE{uc $name};	777	a C<urxvt::term::extension> object.
769	defined $htype
770	or Carp::croak "unsupported hook type '$name'";
771		778
772	$self->set_should_invoke ($htype, +1)	779	You can use these objects, which are passed to all callbacks to store any
773	unless exists $self->{term}{_hook}[$htype]{$pkg};	780	state related to the terminal and extension instance.
774		781
775	$self->{term}{_hook}[$htype]{$pkg} = $cb;	782	The methods (And data members) documented below can be called on extension
776	}	783	objects, in addition to call methods documented for the <urxvt::term>
777	}	784	class.
778		785
779	sub disable {	786	=over 4
780	my ($self, @hook) = @_;
781	my $pkg = $self->{_pkg};
782		787
783	for my $name (@hook) {	788	=item $urxvt_term = $self->{term}
784	my $htype = $HOOKTYPE{uc $name};
785	defined $htype
786	or Carp::croak "unsupported hook type '$name'";
787		789
788	$self->set_should_invoke ($htype, -1)	790	Returns the C<urxvt::term> object associated with this instance of the
789	if delete $self->{term}{_hook}[$htype]{$pkg};	791	extension. This member I<must not> be changed in any way.
790	}	792
791	}	793	=cut
792		794
793	our $AUTOLOAD;	795	our $AUTOLOAD;
794		796
795	sub AUTOLOAD {	797	sub AUTOLOAD {
796	$AUTOLOAD =~ /:([^:]+)$/	798	$AUTOLOAD =~ /:([^:]+)$/
…		…
809		811
810	sub DESTROY {	812	sub DESTROY {
811	# nop	813	# nop
812	}	814	}
813		815
814	# urxvt::destroy_hook	816	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
815		817
816	sub urxvt::destroy_hook::DESTROY {	818	sub urxvt::destroy_hook::DESTROY {
817	${$_[0]}->();	819	${$_[0]}->();
818	}	820	}
819		821
820	sub urxvt::destroy_hook(&) {	822	sub urxvt::destroy_hook(&) {
821	bless \shift, urxvt::destroy_hook::	823	bless \shift, urxvt::destroy_hook::
822	}	824	}
		825
		826	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		827
		828	Dynamically enable the given hooks (named without the C<on_> prefix) for
		829	this extension, replacing any hook previously installed via C<enable> in
		830	this extension.
		831
		832	This is useful when you want to overwrite time-critical hooks only
		833	temporarily.
		834
		835	To install additional callbacks for the same hook, you can use the C<on>
		836	method of the C<urxvt::term> class.
		837
		838	=item $self->disable ($hook_name[, $hook_name..])
		839
		840	Dynamically disable the given hooks.
		841
		842	=cut
		843
		844	sub enable {
		845	my ($self, %hook) = @_;
		846	my $pkg = $self->{_pkg};
		847
		848	while (my ($name, $cb) = each %hook) {
		849	my $htype = $HOOKTYPE{uc $name};
		850	defined $htype
		851	or Carp::croak "unsupported hook type '$name'";
		852
		853	$self->set_should_invoke ($htype, +1)
		854	unless exists $self->{term}{_hook}[$htype]{$pkg};
		855
		856	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		857	}
		858	}
		859
		860	sub disable {
		861	my ($self, @hook) = @_;
		862	my $pkg = $self->{_pkg};
		863
		864	for my $name (@hook) {
		865	my $htype = $HOOKTYPE{uc $name};
		866	defined $htype
		867	or Carp::croak "unsupported hook type '$name'";
		868
		869	$self->set_should_invoke ($htype, -1)
		870	if delete $self->{term}{_hook}[$htype]{$pkg};
		871	}
		872	}
		873
		874	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		875
		876	Similar to the C<enable> enable, but installs additional callbacks for
		877	the given hook(s) (that is, it doesn't replace existing callbacks), and
		878	returns a guard object. When the guard object is destroyed the callbacks
		879	are disabled again.
		880
		881	=cut
		882
		883	sub urxvt::extension::on_disable::DESTROY {
		884	my $disable = shift;
		885
		886	my $term = delete $disable->{""};
		887
		888	while (my ($htype, $id) = each %$disable) {
		889	delete $term->{_hook}[$htype]{$id};
		890	$term->set_should_invoke ($htype, -1);
		891	}
		892	}
		893
		894	sub on {
		895	my ($self, %hook) = @_;
		896
		897	my $term = $self->{term};
		898
		899	my %disable = ( "" => $term );
		900
		901	while (my ($name, $cb) = each %hook) {
		902	my $htype = $HOOKTYPE{uc $name};
		903	defined $htype
		904	or Carp::croak "unsupported hook type '$name'";
		905
		906	$term->set_should_invoke ($htype, +1);
		907	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		908	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		909	}
		910
		911	bless \%disable, "urxvt::extension::on_disable"
		912	}
		913
		914	=item $self->x_resource ($pattern)
		915
		916	=item $self->x_resource_boolean ($pattern)
		917
		918	These methods support an additional C<%> prefix when called on an
		919	extension object - see the description of these methods in the
		920	C<urxvt::term> class for details.
		921
		922	=cut
		923
		924	sub x_resource {
		925	my ($self, $name) = @_;
		926	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		927	$self->{term}->x_resource ($name)
		928	}
		929
		930	sub x_resource_boolean {
		931	my ($self, $name) = @_;
		932	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		933	$self->{term}->x_resource_boolean ($name)
		934	}
		935
		936	=back
		937
		938	=cut
823		939
824	package urxvt::anyevent;	940	package urxvt::anyevent;
825		941
826	=head2 The C<urxvt::anyevent> Class	942	=head2 The C<urxvt::anyevent> Class
827		943
828	The sole purpose of this class is to deliver an interface to the	944	The sole purpose of this class is to deliver an interface to the
829	C<AnyEvent> module - any module using it will work inside urxvt without	945	C<AnyEvent> module - any module using it will work inside urxvt without
830	further programming. The only exception is that you cannot wait on	946	further programming. The only exception is that you cannot wait on
831	condition variables, but non-blocking condvar use is ok. What this means	947	condition variables, but non-blocking condvar use is ok.
832	is that you cannot use blocking APIs, but the non-blocking variant should
833	work.
834		948
835	=cut	949	In practical terms this means is that you cannot use blocking APIs, but
		950	the non-blocking variant should work.
836		951
		952	=cut
		953
837	our $VERSION = 1;	954	our $VERSION = '5.23';
838		955
839	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	956	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
840	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	957	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
841		958
842	sub timer {	959	sub timer {
…		…
844		961
845	my $cb = $arg{cb};	962	my $cb = $arg{cb};
846		963
847	urxvt::timer	964	urxvt::timer
848	->new	965	->new
849	->start (urxvt::NOW + $arg{after})	966	->after ($arg{after}, $arg{interval})
850	->cb (sub {	967	->cb ($arg{interval} ? $cb : sub {
851	$_[0]->stop; # need to cancel manually	968	$_[0]->stop; # need to cancel manually
852	$cb->();	969	$cb->();
853	})	970	})
854	}	971	}
855		972
856	sub io {	973	sub io {
857	my ($class, %arg) = @_;	974	my ($class, %arg) = @_;
858		975
859	my $cb = $arg{cb};	976	my $cb = $arg{cb};
		977	my $fd = fileno $arg{fh};
		978	defined $fd or $fd = $arg{fh};
860		979
861	bless [$arg{fh}, urxvt::iow	980	bless [$arg{fh}, urxvt::iow
862	->new	981	->new
863	->fd (fileno $arg{fh})	982	->fd ($fd)
864	->events (($arg{poll} =~ /r/ ? 1 : 0)	983	->events (($arg{poll} =~ /r/ ? 1 : 0)
865	| ($arg{poll} =~ /w/ ? 2 : 0))	984	| ($arg{poll} =~ /w/ ? 2 : 0))
866	->start	985	->start
867	->cb (sub {	986	->cb ($cb)
868	$cb->(($_[1] & 1 ? 'r' : '')
869	. ($_[1] & 2 ? 'w' : ''));
870	})],
871	urxvt::anyevent::	987	], urxvt::anyevent::
		988	}
		989
		990	sub idle {
		991	my ($class, %arg) = @_;
		992
		993	my $cb = $arg{cb};
		994
		995	urxvt::iw
		996	->new
		997	->start
		998	->cb ($cb)
		999	}
		1000
		1001	sub child {
		1002	my ($class, %arg) = @_;
		1003
		1004	my $cb = $arg{cb};
		1005
		1006	urxvt::pw
		1007	->new
		1008	->start ($arg{pid})
		1009	->cb (sub {
		1010	$_[0]->stop; # need to cancel manually
		1011	$cb->($_[0]->rpid, $_[0]->rstatus);
		1012	})
872	}	1013	}
873		1014
874	sub DESTROY {	1015	sub DESTROY {
875	$_[0][1]->stop;	1016	$_[0][1]->stop;
876	}	1017	}
877		1018
878	sub condvar {	1019	# only needed for AnyEvent < 6 compatibility
879	bless \my $flag, urxvt::anyevent::condvar::	1020	sub one_event {
880	}
881
882	sub urxvt::anyevent::condvar::broadcast {
883	${$_[0]}++;
884	}
885
886	sub urxvt::anyevent::condvar::wait {
887	unless (${$_[0]}) {
888	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1021	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
889	}
890	}	1022	}
891		1023
892	package urxvt::term;	1024	package urxvt::term;
893		1025
894	=head2 The C<urxvt::term> Class	1026	=head2 The C<urxvt::term> Class
…		…
900	# find on_xxx subs in the package and register them	1032	# find on_xxx subs in the package and register them
901	# as hooks	1033	# as hooks
902	sub register_package {	1034	sub register_package {
903	my ($self, $pkg, $argv) = @_;	1035	my ($self, $pkg, $argv) = @_;
904		1036
		1037	no strict 'refs';
		1038
		1039	urxvt::verbose 6, "register package $pkg to $self";
		1040
		1041	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1042
905	my $proxy = bless {	1043	my $proxy = bless {
906	_pkg => $pkg,	1044	_pkg => $pkg,
		1045	_name => ${"$pkg\::_NAME"}, # hackish
907	argv => $argv,	1046	argv => $argv,
908	}, $pkg;	1047	}, $pkg;
909	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
910		1049
911	$self->{_pkg}{$pkg} = $proxy;	1050	$self->{_pkg}{$pkg} = $proxy;
912		1051
…		…
915	$proxy->enable ($name => $ref);	1054	$proxy->enable ($name => $ref);
916	}	1055	}
917	}	1056	}
918	}	1057	}
919		1058
		1059	sub perl_libdirs {
		1060	map { split /:/ }
		1061	$_[0]->resource ("perl_lib"),
		1062	$ENV{URXVT_PERL_LIB},
		1063	"$ENV{HOME}/.urxvt/ext",
		1064	"$LIBDIR/perl"
		1065	}
		1066
		1067	sub scan_meta {
		1068	my ($self) = @_;
		1069	my @libdirs = perl_libdirs $self;
		1070
		1071	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1072
		1073	my %meta;
		1074
		1075	$self->{meta_libdirs} = join "\x00", @libdirs;
		1076	$self->{meta} = \%meta;
		1077
		1078	for my $dir (reverse @libdirs) {
		1079	opendir my $fh, $dir
		1080	or next;
		1081	for my $ext (readdir $fh) {
		1082	$ext !~ /^\./
		1083	and open my $fh, "<", "$dir/$ext"
		1084	or next;
		1085
		1086	while (<$fh>) {
		1087	if (/^#:META:X_RESOURCE:(.*)/) {
		1088	my ($pattern, $type, $desc) = split /:/, $1;
		1089	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1090	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1091	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1092	} else {
		1093	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1094	}
		1095	} elsif (/^\s*(?:#|$)/) {
		1096	# skip other comments and empty lines
		1097	} else {
		1098	last; # stop parsing on first non-empty non-comment line
		1099	}
		1100	}
		1101	}
		1102	}
		1103	}
		1104
920	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1105	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
921		1106
922	Creates a new terminal, very similar as if you had started it with system	1107	Creates a new terminal, very similar as if you had started it with system
923	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1108	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
924	hash which defines the environment of the new terminal.	1109	hash which defines the environment of the new terminal.
925		1110
926	Croaks (and probably outputs an error message) if the new instance	1111	Croaks (and probably outputs an error message) if the new instance
927	couldn't be created. Returns C<undef> if the new instance didn't	1112	couldn't be created. Returns C<undef> if the new instance didn't
928	initialise perl, and the terminal object otherwise. The C<init> and	1113	initialise perl, and the terminal object otherwise. The C<init> and
929	C<start> hooks will be called during this call.	1114	C<start> hooks will be called before this call returns, and are free to
		1115	refer to global data (which is race free).
930		1116
931	=cut	1117	=cut
932		1118
933	sub new {	1119	sub new {
934	my ($class, $env, @args) = @_;	1120	my ($class, $env, @args) = @_;
935		1121
		1122	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1123	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1124
936	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1125	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
937	}	1126	}
938		1127
939	=item $term->destroy	1128	=item $term->destroy
940		1129
941	Destroy the terminal object (close the window, free resources	1130	Destroy the terminal object (close the window, free resources
942	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1131	etc.). Please note that urxvt will not exit as long as any event
943	watchers (timers, io watchers) are still active.	1132	watchers (timers, io watchers) are still active.
		1133
		1134	=item $term->exec_async ($cmd[, @args])
		1135
		1136	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1137	("starts") programs in the background. This function takes care of setting
		1138	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1139	be preferred over explicit calls to C<exec> or C<system>.
		1140
		1141	Returns the pid of the subprocess or C<undef> on error.
		1142
		1143	=cut
		1144
		1145	sub exec_async {
		1146	my $self = shift;
		1147
		1148	my $pid = fork;
		1149
		1150	return $pid
		1151	if !defined $pid or $pid;
		1152
		1153	%ENV = %{ $self->env };
		1154
		1155	exec @_;
		1156	urxvt::_exit 255;
		1157	}
944		1158
945	=item $isset = $term->option ($optval[, $set])	1159	=item $isset = $term->option ($optval[, $set])
946		1160
947	Returns true if the option specified by C<$optval> is enabled, and	1161	Returns true if the option specified by C<$optval> is enabled, and
948	optionally change it. All option values are stored by name in the hash	1162	optionally change it. All option values are stored by name in the hash
949	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1163	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
950		1164
951	Here is a a likely non-exhaustive list of option names, please see the	1165	Here is a likely non-exhaustive list of option names, please see the
952	source file F</src/optinc.h> to see the actual list:	1166	source file F</src/optinc.h> to see the actual list:
953		1167
954	borderLess console cursorBlink cursorUnderline hold iconic insecure	1168	borderLess buffered console cursorBlink cursorUnderline hold iconic
955	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1169	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1170	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
956	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1171	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
957	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1172	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
958	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1173	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
959	tripleclickwords utmpInhibit visualBell	1174	urgentOnBell utmpInhibit visualBell
960		1175
961	=item $value = $term->resource ($name[, $newval])	1176	=item $value = $term->resource ($name[, $newval])
962		1177
963	Returns the current resource value associated with a given name and	1178	Returns the current resource value associated with a given name and
964	optionally sets a new value. Setting values is most useful in the C<init>	1179	optionally sets a new value. Setting values is most useful in the C<init>
…		…
973	likely change).	1188	likely change).
974		1189
975	Please note that resource strings will currently only be freed when the	1190	Please note that resource strings will currently only be freed when the
976	terminal is destroyed, so changing options frequently will eat memory.	1191	terminal is destroyed, so changing options frequently will eat memory.
977		1192
978	Here is a a likely non-exhaustive list of resource names, not all of which	1193	Here is a likely non-exhaustive list of resource names, not all of which
979	are supported in every build, please see the source file F</src/rsinc.h>	1194	are supported in every build, please see the source file F</src/rsinc.h>
980	to see the actual list:	1195	to see the actual list:
981		1196
982	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1197	answerbackstring backgroundPixmap backspace_key blurradius
983	borderLess color cursorBlink cursorUnderline cutchars delete_key	1198	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
984	display_name embed ext_bwidth fade font geometry hold iconName	1199	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
985	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1200	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1201	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
986	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1202	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
987	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1203	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
988	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1204	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
989	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1205	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
990	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1206	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
991	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1207	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
992	shade term_name title transparent transparent_all tripleclickwords	1208	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1209	term_name title transient_for transparent tripleclickwords urgentOnBell
993	utmpInhibit visualBell	1210	utmpInhibit visualBell
994		1211
995	=cut	1212	=cut
996		1213
997	sub resource($$;$) {	1214	sub resource($$;$) {
998	my ($self, $name) = (shift, shift);	1215	my ($self, $name) = (shift, shift);
999	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1216	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1000	&urxvt::term::_resource	1217	goto &urxvt::term::_resource
1001	}	1218	}
1002		1219
1003	=item $value = $term->x_resource ($pattern)	1220	=item $value = $term->x_resource ($pattern)
1004		1221
1005	Returns the X-Resource for the given pattern, excluding the program or	1222	Returns the X-Resource for the given pattern, excluding the program or
1006	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1223	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1007	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1224	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1008	resource with that pattern exists.	1225	resource with that pattern exists.
1009		1226
		1227	Extensions that define extra resource or command line arguments also need
		1228	to call this method to access their values.
		1229
		1230	If the method is called on an extension object (basically, from an
		1231	extension), then the special prefix C<%.> will be replaced by the name of
		1232	the extension and a dot, and the lone string C<%> will be replaced by the
		1233	extension name itself. This makes it possible to code extensions so you
		1234	can rename them and get a new set of commandline switches and resources
		1235	without having to change the actual code.
		1236
1010	This method should only be called during the C<on_start> hook, as there is	1237	This method should only be called during the C<on_start> hook, as there is
1011	only one resource database per display, and later invocations might return	1238	only one resource database per display, and later invocations might return
1012	the wrong resources.	1239	the wrong resources.
1013		1240
1014	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1241	=item $value = $term->x_resource_boolean ($pattern)
1015		1242
		1243	Like C<x_resource>, above, but interprets the string value as a boolean
		1244	and returns C<1> for true values, C<0> for false values and C<undef> if
		1245	the resource or option isn't specified.
		1246
		1247	You should always use this method to parse boolean resources.
		1248
		1249	=cut
		1250
		1251	sub x_resource_boolean {
		1252	my $res = &x_resource;
		1253
		1254	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1255	}
		1256
		1257	=item $success = $term->parse_keysym ($key, $octets)
		1258
1016	Adds a keymap translation exactly as specified via a resource. See the	1259	Adds a key binding exactly as specified via a resource. See the
1017	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1260	C<keysym> resource in the urxvt(1) manpage.
1018		1261
1019	=item $rend = $term->rstyle ([$new_rstyle])	1262	=item $rend = $term->rstyle ([$new_rstyle])
1020		1263
1021	Return and optionally change the current rendition. Text that is output by	1264	Return and optionally change the current rendition. Text that is output by
1022	the terminal application will use this style.	1265	the terminal application will use this style.
…		…
1030		1273
1031	=item ($row, $col) = $term->selection_beg ([$row, $col])	1274	=item ($row, $col) = $term->selection_beg ([$row, $col])
1032		1275
1033	=item ($row, $col) = $term->selection_end ([$row, $col])	1276	=item ($row, $col) = $term->selection_end ([$row, $col])
1034		1277
1035	Return the current values of the selection mark, begin or end positions,	1278	Return the current values of the selection mark, begin or end positions.
1036	and optionally set them to new values.	1279
		1280	When arguments are given, then the selection coordinates are set to
		1281	C<$row> and C<$col>, and the selection screen is set to the current
		1282	screen.
		1283
		1284	=item $screen = $term->selection_screen ([$screen])
		1285
		1286	Returns the current selection screen, and then optionally sets it.
1037		1287
1038	=item $term->selection_make ($eventtime[, $rectangular])	1288	=item $term->selection_make ($eventtime[, $rectangular])
1039		1289
1040	Tries to make a selection as set by C<selection_beg> and	1290	Tries to make a selection as set by C<selection_beg> and
1041	C<selection_end>. If C<$rectangular> is true (default: false), a	1291	C<selection_end>. If C<$rectangular> is true (default: false), a
1042	rectangular selection will be made. This is the prefered function to make	1292	rectangular selection will be made. This is the preferred function to make
1043	a selection.	1293	a selection.
1044		1294
1045	=item $success = $term->selection_grab ($eventtime)	1295	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1046		1296
1047	Try to request the primary selection text from the server (for example, as	1297	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1298	true) selection from the server. The corresponding text can be set
1048	set by the next method). No visual feedback will be given. This function	1299	with the next method. No visual feedback will be given. This function
1049	is mostly useful from within C<on_sel_grab> hooks.	1300	is mostly useful from within C<on_sel_grab> hooks.
1050		1301
1051	=item $oldtext = $term->selection ([$newtext])	1302	=item $oldtext = $term->selection ([$newtext, $clipboard])
1052		1303
1053	Return the current selection text and optionally replace it by C<$newtext>.	1304	Return the current selection (clipboard if C<$clipboard> is true) text
		1305	and optionally replace it by C<$newtext>.
		1306
		1307	=item $term->selection_clear ([$clipboard])
		1308
		1309	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1054		1310
1055	=item $term->overlay_simple ($x, $y, $text)	1311	=item $term->overlay_simple ($x, $y, $text)
1056		1312
1057	Create a simple multi-line overlay box. See the next method for details.	1313	Create a simple multi-line overlay box. See the next method for details.
1058		1314
…		…
1088		1344
1089	The methods currently supported on C<urxvt::overlay> objects are:	1345	The methods currently supported on C<urxvt::overlay> objects are:
1090		1346
1091	=over 4	1347	=over 4
1092		1348
1093	=item $overlay->set ($x, $y, $text, $rend)	1349	=item $overlay->set ($x, $y, $text[, $rend])
1094		1350
1095	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1351	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1096	text in rxvt-unicode's special encoding and an array of rendition values	1352	text in rxvt-unicode's special encoding and an array of rendition values
1097	at a specific position inside the overlay.	1353	at a specific position inside the overlay.
		1354
		1355	If C<$rend> is missing, then the rendition will not be changed.
1098		1356
1099	=item $overlay->hide	1357	=item $overlay->hide
1100		1358
1101	If visible, hide the overlay, but do not destroy it.	1359	If visible, hide the overlay, but do not destroy it.
1102		1360
…		…
1172		1430
1173	Normally its not a good idea to use this function, as programs might be	1431	Normally its not a good idea to use this function, as programs might be
1174	confused by changes in cursor position or scrolling. Its useful inside a	1432	confused by changes in cursor position or scrolling. Its useful inside a
1175	C<on_add_lines> hook, though.	1433	C<on_add_lines> hook, though.
1176		1434
		1435	=item $term->scr_change_screen ($screen)
		1436
		1437	Switch to given screen - 0 primary, 1 secondary.
		1438
1177	=item $term->cmd_parse ($octets)	1439	=item $term->cmd_parse ($octets)
1178		1440
1179	Similar to C<scr_add_lines>, but the argument must be in the	1441	Similar to C<scr_add_lines>, but the argument must be in the
1180	locale-specific encoding of the terminal and can contain command sequences	1442	locale-specific encoding of the terminal and can contain command sequences
1181	(escape codes) that will be interpreted.	1443	(escape codes) that will be interpreted.
1182		1444
1183	=item $term->tt_write ($octets)	1445	=item $term->tt_write ($octets)
1184		1446
1185	Write the octets given in C<$data> to the tty (i.e. as program input). To	1447	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1186	pass characters instead of octets, you should convert your strings first	1448	pass characters instead of octets, you should convert your strings first
1187	to the locale-specific encoding using C<< $term->locale_encode >>.	1449	to the locale-specific encoding using C<< $term->locale_encode >>.
		1450
		1451	=item $term->tt_paste ($octets)
		1452
		1453	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1454	CR and bracketing the data with control sequences if bracketed paste mode
		1455	is set.
1188		1456
1189	=item $old_events = $term->pty_ev_events ([$new_events])	1457	=item $old_events = $term->pty_ev_events ([$new_events])
1190		1458
1191	Replaces the event mask of the pty watcher by the given event mask. Can	1459	Replaces the event mask of the pty watcher by the given event mask. Can
1192	be used to suppress input and output handling to the pty/tty. See the	1460	be used to suppress input and output handling to the pty/tty. See the
1193	description of C<< urxvt::timer->events >>. Make sure to always restore	1461	description of C<< urxvt::timer->events >>. Make sure to always restore
1194	the previous value.	1462	the previous value.
1195		1463
		1464	=item $fd = $term->pty_fd
		1465
		1466	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1467	is used.
		1468
1196	=item $windowid = $term->parent	1469	=item $windowid = $term->parent
1197		1470
1198	Return the window id of the toplevel window.	1471	Return the window id of the toplevel window.
1199		1472
1200	=item $windowid = $term->vt	1473	=item $windowid = $term->vt
…		…
1206	Adds the specified events to the vt event mask. Useful e.g. when you want	1479	Adds the specified events to the vt event mask. Useful e.g. when you want
1207	to receive pointer events all the times:	1480	to receive pointer events all the times:
1208		1481
1209	$term->vt_emask_add (urxvt::PointerMotionMask);	1482	$term->vt_emask_add (urxvt::PointerMotionMask);
1210		1483
		1484	=item $term->set_urgency ($set)
		1485
		1486	Enable/disable the urgency hint on the toplevel window.
		1487
		1488	=item $term->focus_in
		1489
		1490	=item $term->focus_out
		1491
		1492	=item $term->key_press ($state, $keycode[, $time])
		1493
		1494	=item $term->key_release ($state, $keycode[, $time])
		1495
		1496	Deliver various fake events to to terminal.
		1497
1211	=item $window_width = $term->width	1498	=item $window_width = $term->width
1212		1499
1213	=item $window_height = $term->height	1500	=item $window_height = $term->height
1214		1501
1215	=item $font_width = $term->fwidth	1502	=item $font_width = $term->fwidth
…		…
1245	=item $env = $term->env	1532	=item $env = $term->env
1246		1533
1247	Returns a copy of the environment in effect for the terminal as a hashref	1534	Returns a copy of the environment in effect for the terminal as a hashref
1248	similar to C<\%ENV>.	1535	similar to C<\%ENV>.
1249		1536
		1537	=item @envv = $term->envv
		1538
		1539	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1540
		1541	=item @argv = $term->argv
		1542
		1543	Return the argument vector as this terminal, similar to @ARGV, but
		1544	includes the program name as first element.
		1545
1250	=cut	1546	=cut
1251		1547
1252	sub env {	1548	sub env {
1253	if (my $env = $_[0]->_env) {
1254	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1549	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1255	} else {
1256	+{ %ENV }
1257	}
1258	}	1550	}
1259		1551
1260	=item $modifiermask = $term->ModLevel3Mask	1552	=item $modifiermask = $term->ModLevel3Mask
1261		1553
1262	=item $modifiermask = $term->ModMetaMask	1554	=item $modifiermask = $term->ModMetaMask
1263		1555
1264	=item $modifiermask = $term->ModNumLockMask	1556	=item $modifiermask = $term->ModNumLockMask
1265		1557
1266	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1558	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1267	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1559	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1560
		1561	=item $screen = $term->current_screen
		1562
		1563	Returns the currently displayed screen (0 primary, 1 secondary).
		1564
		1565	=item $cursor_is_hidden = $term->hidden_cursor
		1566
		1567	Returns whether the cursor is currently hidden or not.
1268		1568
1269	=item $view_start = $term->view_start ([$newvalue])	1569	=item $view_start = $term->view_start ([$newvalue])
1270		1570
1271	Returns the row number of the topmost displayed line. Maximum value is	1571	Returns the row number of the topmost displayed line. Maximum value is
1272	C<0>, which displays the normal terminal contents. Lower values scroll	1572	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1280		1580
1281	Used after changing terminal contents to display them.	1581	Used after changing terminal contents to display them.
1282		1582
1283	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1583	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1284		1584
1285	Returns the text of the entire row with number C<$row_number>. Row C<0>	1585	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1286	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1586	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1287	terminal line. The scrollback buffer starts at line C<-1> and extends to
1288	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1587	terminal line. Nothing will be returned if a nonexistent line
1289	is requested.	1588	is requested.
1290		1589
1291	If C<$new_text> is specified, it will replace characters in the current	1590	If C<$new_text> is specified, it will replace characters in the current
1292	line, starting at column C<$start_col> (default C<0>), which is useful	1591	line, starting at column C<$start_col> (default C<0>), which is useful
1293	to replace only parts of a line. The font index in the rendition will	1592	to replace only parts of a line. The font index in the rendition will
1294	automatically be updated.	1593	automatically be updated.
1295		1594
1296	C<$text> is in a special encoding: tabs and wide characters that use more	1595	C<$text> is in a special encoding: tabs and wide characters that use more
1297	than one cell when displayed are padded with urxvt::NOCHAR characters	1596	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1298	(C<chr 65535>). Characters with combining characters and other characters	1597	characters. Characters with combining characters and other characters that
1299	that do not fit into the normal tetx encoding will be replaced with	1598	do not fit into the normal text encoding will be replaced with characters
1300	characters in the private use area.	1599	in the private use area.
1301		1600
1302	You have to obey this encoding when changing text. The advantage is	1601	You have to obey this encoding when changing text. The advantage is
1303	that C<substr> and similar functions work on screen cells and not on	1602	that C<substr> and similar functions work on screen cells and not on
1304	characters.	1603	characters.
1305		1604
…		…
1389	}	1688	}
1390		1689
1391	sub urxvt::line::t {	1690	sub urxvt::line::t {
1392	my ($self) = @_;	1691	my ($self) = @_;
1393		1692
1394	if (@_ > 1)	1693	if (@_ > 1) {
1395	{
1396	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1694	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1397	for $self->{beg} .. $self->{end};	1695	for $self->{beg} .. $self->{end};
1398	}	1696	}
1399		1697
1400	defined wantarray &&	1698	defined wantarray &&
1401	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1699	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1402	0, $self->{len}	1700	0, $self->{len}
1403	}	1701	}
1404		1702
1405	sub urxvt::line::r {	1703	sub urxvt::line::r {
1406	my ($self) = @_;	1704	my ($self) = @_;
1407		1705
1408	if (@_ > 1)	1706	if (@_ > 1) {
1409	{
1410	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1707	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1411	for $self->{beg} .. $self->{end};	1708	for $self->{beg} .. $self->{end};
1412	}	1709	}
1413		1710
1414	if (defined wantarray) {	1711	if (defined wantarray) {
1415	my $rend = [	1712	my $rend = [
1416	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1713	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1417	];	1714	];
…		…
1449	where one character corresponds to one screen cell. See	1746	where one character corresponds to one screen cell. See
1450	C<< $term->ROW_t >> for details.	1747	C<< $term->ROW_t >> for details.
1451		1748
1452	=item $string = $term->special_decode $text	1749	=item $string = $term->special_decode $text
1453		1750
1454	Converts rxvt-unicodes text reprsentation into a perl string. See	1751	Converts rxvt-unicodes text representation into a perl string. See
1455	C<< $term->ROW_t >> for details.	1752	C<< $term->ROW_t >> for details.
1456		1753
1457	=item $success = $term->grab_button ($button, $modifiermask)	1754	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1458		1755
		1756	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1757
1459	Registers a synchronous button grab. See the XGrabButton manpage.	1758	Register/unregister a synchronous button grab. See the XGrabButton
		1759	manpage.
1460		1760
1461	=item $success = $term->grab ($eventtime[, $sync])	1761	=item $success = $term->grab ($eventtime[, $sync])
1462		1762
1463	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1763	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1464	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1764	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1465		1765
1466	=item $term->allow_events_async	1766	=item $term->allow_events_async
1467		1767
1468	Calls XAllowEvents with AsyncBoth for the most recent grab.	1768	Calls XAllowEvents with AsyncBoth for the most recent grab.
1469		1769
…		…
1476	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1776	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1477	recent grab.	1777	recent grab.
1478		1778
1479	=item $term->ungrab	1779	=item $term->ungrab
1480		1780
1481	Calls XUngrab for the most recent grab. Is called automatically on	1781	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1482	evaluation errors, as it is better to lose the grab in the error case as	1782	evaluation errors, as it is better to lose the grab in the error case as
1483	the session.	1783	the session.
		1784
		1785	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1786
		1787	=item $atom_name = $term->XGetAtomName ($atom)
		1788
		1789	=item @atoms = $term->XListProperties ($window)
		1790
		1791	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1792
		1793	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1794
		1795	=item $term->XDeleteProperty ($window, $property)
		1796
		1797	=item $window = $term->DefaultRootWindow
		1798
		1799	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1800
		1801	=item $term->XMapWindow ($window)
		1802
		1803	=item $term->XUnmapWindow ($window)
		1804
		1805	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1806
		1807	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1808
		1809	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1810
		1811	=item $keysym = $term->XStringToKeysym ($string)
		1812
		1813	=item $string = $term->XKeysymToString ($keysym)
		1814
		1815	Various X or X-related functions. The C<$term> object only serves as
		1816	the source of the display, otherwise those functions map more-or-less
		1817	directly onto the X functions of the same name.
1484		1818
1485	=back	1819	=back
1486		1820
1487	=cut	1821	=cut
1488		1822
…		…
1552	my ($self, $text, $cb) = @_;	1886	my ($self, $text, $cb) = @_;
1553		1887
1554	$self->add_item ({ type => "button", text => $text, activate => $cb});	1888	$self->add_item ({ type => "button", text => $text, activate => $cb});
1555	}	1889	}
1556		1890
1557	=item $popup->add_toggle ($text, $cb, $initial_value)	1891	=item $popup->add_toggle ($text, $initial_value, $cb)
1558		1892
1559	Adds a toggle/checkbox item to the popup. Teh callback gets called	1893	Adds a toggle/checkbox item to the popup. The callback gets called
1560	whenever it gets toggled, with a boolean indicating its value as its first	1894	whenever it gets toggled, with a boolean indicating its new value as its
1561	argument.	1895	first argument.
1562		1896
1563	=cut	1897	=cut
1564		1898
1565	sub add_toggle {	1899	sub add_toggle {
1566	my ($self, $text, $cb, $value) = @_;	1900	my ($self, $text, $value, $cb) = @_;
1567		1901
1568	my $item; $item = {	1902	my $item; $item = {
1569	type => "button",	1903	type => "button",
1570	text => " $text",	1904	text => " $text",
1571	value => $value,	1905	value => $value,
…		…
1590	my $env = $self->{term}->env;	1924	my $env = $self->{term}->env;
1591	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1925	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1592	delete $env->{LC_ALL};	1926	delete $env->{LC_ALL};
1593	$env->{LC_CTYPE} = $self->{term}->locale;	1927	$env->{LC_CTYPE} = $self->{term}->locale;
1594		1928
1595	urxvt::term->new ($env, "popup",	1929	my $term = urxvt::term->new (
1596	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1930	$env, "popup",
		1931	"--perl-lib" => "", "--perl-ext-common" => "",
		1932	"-pty-fd" => -1, "-sl" => 0,
		1933	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1597	"--transient-for" => $self->{term}->parent,	1934	"--transient-for" => $self->{term}->parent,
1598	"-display" => $self->{term}->display_id,	1935	"-display" => $self->{term}->display_id,
1599	"-pe" => "urxvt-popup")	1936	"-pe" => "urxvt-popup",
1600	or die "unable to create popup window\n";	1937	) or die "unable to create popup window\n";
		1938
		1939	unless (delete $term->{urxvt_popup_init_done}) {
		1940	$term->ungrab;
		1941	$term->destroy;
		1942	die "unable to initialise popup window\n";
		1943	}
1601	}	1944	}
1602		1945
1603	sub DESTROY {	1946	sub DESTROY {
1604	my ($self) = @_;	1947	my ($self) = @_;
1605		1948
1606	delete $self->{term}{_destroy}{$self};	1949	delete $self->{term}{_destroy}{$self};
1607	$self->{term}->ungrab;	1950	$self->{term}->ungrab;
1608	}	1951	}
1609		1952
1610	=back	1953	=back
		1954
		1955	=cut
		1956
		1957	package urxvt::watcher;
1611		1958
1612	=head2 The C<urxvt::timer> Class	1959	=head2 The C<urxvt::timer> Class
1613		1960
1614	This class implements timer watchers/events. Time is represented as a	1961	This class implements timer watchers/events. Time is represented as a
1615	fractional number of seconds since the epoch. Example:	1962	fractional number of seconds since the epoch. Example:
…		…
1619	->new	1966	->new
1620	->interval (1)	1967	->interval (1)
1621	->cb (sub {	1968	->cb (sub {
1622	$term->{overlay}->set (0, 0,	1969	$term->{overlay}->set (0, 0,
1623	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1970	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1624	});	1971	});
1625		1972
1626	=over 4	1973	=over 4
1627		1974
1628	=item $timer = new urxvt::timer	1975	=item $timer = new urxvt::timer
1629		1976
…		…
1632		1979
1633	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1980	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1634		1981
1635	Set the callback to be called when the timer triggers.	1982	Set the callback to be called when the timer triggers.
1636		1983
1637	=item $tstamp = $timer->at
1638
1639	Return the time this watcher will fire next.
1640
1641	=item $timer = $timer->set ($tstamp)	1984	=item $timer = $timer->set ($tstamp[, $interval])
1642		1985
1643	Set the time the event is generated to $tstamp.	1986	Set the time the event is generated to $tstamp (and optionally specifies a
		1987	new $interval).
1644		1988
1645	=item $timer = $timer->interval ($interval)	1989	=item $timer = $timer->interval ($interval)
1646		1990
1647	Normally (and when C<$interval> is C<0>), the timer will automatically	1991	By default (and when C<$interval> is C<0>), the timer will automatically
1648	stop after it has fired once. If C<$interval> is non-zero, then the timer	1992	stop after it has fired once. If C<$interval> is non-zero, then the timer
1649	is automatically rescheduled at the given intervals.	1993	is automatically rescheduled at the given intervals.
1650		1994
1651	=item $timer = $timer->start	1995	=item $timer = $timer->start
1652		1996
1653	Start the timer.	1997	Start the timer.
1654		1998
1655	=item $timer = $timer->start ($tstamp)	1999	=item $timer = $timer->start ($tstamp[, $interval])
1656		2000
1657	Set the event trigger time to C<$tstamp> and start the timer.	2001	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2002	also replaces the interval.
1658		2003
1659	=item $timer = $timer->after ($delay)	2004	=item $timer = $timer->after ($delay[, $interval])
1660		2005
1661	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2006	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1662		2007
1663	=item $timer = $timer->stop	2008	=item $timer = $timer->stop
1664		2009
…		…
1672		2017
1673	$term->{socket} = ...	2018	$term->{socket} = ...
1674	$term->{iow} = urxvt::iow	2019	$term->{iow} = urxvt::iow
1675	->new	2020	->new
1676	->fd (fileno $term->{socket})	2021	->fd (fileno $term->{socket})
1677	->events (urxvt::EVENT_READ)	2022	->events (urxvt::EV_READ)
1678	->start	2023	->start
1679	->cb (sub {	2024	->cb (sub {
1680	my ($iow, $revents) = @_;	2025	my ($iow, $revents) = @_;
1681	# $revents must be 1 here, no need to check	2026	# $revents must be 1 here, no need to check
1682	sysread $term->{socket}, my $buf, 8192	2027	sysread $term->{socket}, my $buf, 8192
…		…
1695	Set the callback to be called when io events are triggered. C<$reventmask>	2040	Set the callback to be called when io events are triggered. C<$reventmask>
1696	is a bitset as described in the C<events> method.	2041	is a bitset as described in the C<events> method.
1697		2042
1698	=item $iow = $iow->fd ($fd)	2043	=item $iow = $iow->fd ($fd)
1699		2044
1700	Set the filedescriptor (not handle) to watch.	2045	Set the file descriptor (not handle) to watch.
1701		2046
1702	=item $iow = $iow->events ($eventmask)	2047	=item $iow = $iow->events ($eventmask)
1703		2048
1704	Set the event mask to watch. The only allowed values are	2049	Set the event mask to watch. The only allowed values are
1705	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2050	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1706	together, or C<urxvt::EVENT_NONE>.	2051	together, or C<urxvt::EV_NONE>.
1707		2052
1708	=item $iow = $iow->start	2053	=item $iow = $iow->start
1709		2054
1710	Start watching for requested events on the given handle.	2055	Start watching for requested events on the given handle.
1711		2056
1712	=item $iow = $iow->stop	2057	=item $iow = $iow->stop
1713		2058
1714	Stop watching for events on the given filehandle.	2059	Stop watching for events on the given file handle.
		2060
		2061	=back
		2062
		2063	=head2 The C<urxvt::iw> Class
		2064
		2065	This class implements idle watchers, that get called automatically when
		2066	the process is idle. They should return as fast as possible, after doing
		2067	some useful work.
		2068
		2069	=over 4
		2070
		2071	=item $iw = new urxvt::iw
		2072
		2073	Create a new idle watcher object in stopped state.
		2074
		2075	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2076
		2077	Set the callback to be called when the watcher triggers.
		2078
		2079	=item $timer = $timer->start
		2080
		2081	Start the watcher.
		2082
		2083	=item $timer = $timer->stop
		2084
		2085	Stop the watcher.
		2086
		2087	=back
		2088
		2089	=head2 The C<urxvt::pw> Class
		2090
		2091	This class implements process watchers. They create an event whenever a
		2092	process exits, after which they stop automatically.
		2093
		2094	my $pid = fork;
		2095	...
		2096	$term->{pw} = urxvt::pw
		2097	->new
		2098	->start ($pid)
		2099	->cb (sub {
		2100	my ($pw, $exit_status) = @_;
		2101	...
		2102	});
		2103
		2104	=over 4
		2105
		2106	=item $pw = new urxvt::pw
		2107
		2108	Create a new process watcher in stopped state.
		2109
		2110	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2111
		2112	Set the callback to be called when the timer triggers.
		2113
		2114	=item $pw = $timer->start ($pid)
		2115
		2116	Tells the watcher to start watching for process C<$pid>.
		2117
		2118	=item $pw = $pw->stop
		2119
		2120	Stop the watcher.
1715		2121
1716	=back	2122	=back
1717		2123
1718	=head1 ENVIRONMENT	2124	=head1 ENVIRONMENT
1719		2125
…		…
1728		2134
1729	=item >= 3 - script loading and management	2135	=item >= 3 - script loading and management
1730		2136
1731	=item >=10 - all called hooks	2137	=item >=10 - all called hooks
1732		2138
1733	=item >=11 - hook reutrn values	2139	=item >=11 - hook return values
1734		2140
1735	=back	2141	=back
1736		2142
1737	=head1 AUTHOR	2143	=head1 AUTHOR
1738		2144
1739	Marc Lehmann <pcg@goof.com>	2145	Marc Lehmann <schmorp@schmorp.de>
1740	http://software.schmorp.de/pkg/rxvt-unicode	2146	http://software.schmorp.de/pkg/rxvt-unicode
1741		2147
1742	=cut	2148	=cut
1743		2149
1744	1	2150	1
		2151
		2152	# vim: sw=3:

Diff Legend

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