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.111 by root, Thu Jan 19 19:52:54 2006 UTC vs.
Revision 1.235 by sf-exg, Sat May 17 15:33:24 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	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions that add command line parameters or resources on their own are
45		49	loaded automatically when used.
46	=item selection (enabled by default)
47
48	(More) intelligent selection. This extension tries to be more intelligent
49	when the user extends selections (double-click and further clicks). Right
50	now, it tries to select words, urls and complete shell-quoted
51	arguments, which is very convenient, too, if your F<ls> supports
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	You can look at the source of the selection extension to see more
73	interesting uses, such as parsing a line from beginning to end.
74
75	This extension also offers following bindable keyboard commands:
76
77	=over 4
78
79	=item rot13
80
81	Rot-13 the selection when activated. Used via keyboard trigger:
82
83	URxvt.keysym.C-M-r: perl:selection:rot13
84
85	=back
86
87	=item option-popup (enabled by default)
88
89	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90	runtime.
91
92	=item selection-popup (enabled by default)
93
94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95	text into various other formats/action (such as uri unescaping, perl
96	evalution, web-browser starting etc.), depending on content.
97
98	Other extensions can extend this popup menu by pushing a code reference
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100	popup is displayed.
101
102	It's sole argument is the popup menu, which can be modified. The selection
103	is in C<$_>, which can be used to decide wether to add something or not.
104	It should either return nothing or a string and a code reference. The
105	string will be used as button text and the code reference will be called
106	when the button gets activated and should transform C<$_>.
107
108	The following will add an entry C<a to b> that transforms all C<a>s in
109	the selection to C<b>s, but only if the selection currently contains any
110	C<a>s:
111
112	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }
114	: ()
115	};
116
117	=item searchable-scrollback<hotkey> (enabled by default)
118
119	Adds regex search functionality to the scrollback buffer, triggered
120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
121	input/output is suspended and a regex is displayed at the bottom of the
122	screen.
123
124	Inputting characters appends them to the regex and continues incremental
125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
127	bottom. C<Escape> leaves search mode and returns to the point where search
128	was started, while C<Enter> or C<Return> stay at the current position and
129	additionally stores the first match in the current line into the primary
130	selection.
131
132	=item selection-autotransform
133
134	This selection allows you to do automatic transforms on a selection
135	whenever a selection is made.
136
137	It works by specifying perl snippets (most useful is a single C<s///>
138	operator) that modify C<$_> as resources:
139
140	URxvt.selection-autotransform.0: transform
141	URxvt.selection-autotransform.1: transform
142	...
143
144	For example, the following will transform selections of the form
145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
146	$word>:
147
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150	And this example matches the same,but replaces it with vi-commands you can
151	paste directly into your (vi :) editor:
152
153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155	Of course, this can be modified to suit your needs and your editor :)
156
157	To expand the example above to typical perl error messages ("XXX at
158	FILENAME line YYY."), you need a slightly more elaborate solution:
159
160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163	The first line tells the selection code to treat the unchanging part of
164	every error message as a selection pattern, and the second line transforms
165	the message into vi commands to load the file.
166
167	=item mark-urls
168
169	Uses per-line display filtering (C<on_line_update>) to underline urls and
170	make them clickable. When middle-clicked, the program specified in the
171	resource C<urlLauncher> (default C<x-www-browser>) will be started with
172	the URL as first argument.
173
174	=item automove-background
175
176	This is basically a one-line extension that dynamically changes the background pixmap offset
177	to the window position, in effect creating the same effect as pseudo transparency with
178	a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
181
182	=item block-graphics-to-ascii
183
184	A not very useful example of filtering all text output to the terminal,
185	by replacing all line-drawing characters (U+2500 .. U+259F) by a
186	similar-looking ascii character.
187
188	=item digital-clock
189
190	Displays a digital clock using the built-in overlay.
191
192	=item example-refresh-hooks
193
194	Displays a very simple digital clock in the upper right corner of the
195	window. Illustrates overwriting the refresh callbacks to create your own
196	overlays or changes.
197
198	=item selection-pastebin
199
200	This is a little rarely useful extension that Uploads the selection as
201	textfile to a remote site (or does other things). (The implementation is
202	not currently secure for use in a multiuser environment as it writes to
203	F</tmp> directly.).
204
205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206	i.e.
207
208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209
210	Pressing this combination runs a command with C<%> replaced by the name of
211	the textfile. This command can be set via a resource:
212
213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214
215	And the default is likely not useful to anybody but the few people around
216	here :)
217
218	The name of the textfile is the hex encoded md5 sum of the selection, so
219	the same content should lead to the same filename.
220
221	After a successful upload the selection will be replaced by the text given
222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
223	for the filename):
224
225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
226
227	=back
228		50
229	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
230		52
231	=head2 General API Considerations	53	=head2 General API Considerations
232		54
…		…
246		68
247	=over 4	69	=over 4
248		70
249	=item $text	71	=item $text
250		72
251	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
252	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.
253		75
254	=item $string	76	=item $string
255		77
256	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
…		…
260	=item $octets	82	=item $octets
261		83
262	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
263	locale-specific way.	85	locale-specific way.
264		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
265	=back	93	=back
266		94
267	=head2 Extension Objects	95	=head2 Extension Objects
268		96
269	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
270	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,
271	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
272	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
273	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
274	use.	103	internal use.
275		104
276	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
277	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
278		107
279	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
280		109	the C<urxvt::extension> section below.
281	=over 4
282
283	=item $urxvt_term = $self->{term}
284
285	Returns the C<urxvt::term> object associated with this instance of the
286	extension. This member I<must not> be changed in any way.
287
288	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
289
290	Dynamically enable the given hooks (named without the C<on_> prefix) for
291	this extension, replacing any previous hook. This is useful when you want
292	to overwrite time-critical hooks only temporarily.
293
294	=item $self->disable ($hook_name[, $hook_name..])
295
296	Dynamically disable the given hooks.
297
298	=back
299		110
300	=head2 Hooks	111	=head2 Hooks
301		112
302	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
303	called whenever the relevant event happens.	114	called whenever the relevant event happens.
304		115
305	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
306	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
307		118
308	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
309	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
310	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.
311		122
312	I<< When in doubt, return a false value (preferably C<()>). >>	123	I<< When in doubt, return a false value (preferably C<()>). >>
313		124
314	=over 4	125	=over 4
315		126
316	=item on_init $term	127	=item on_init $term
317		128
318	Called after a new terminal object has been initialized, but before	129	Called after a new terminal object has been initialized, but before
319	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
320	call or deliver senseless data, as terminal size and other characteristics	131	call or deliver senseless data, as terminal size and other characteristics
321	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
322	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).
323		145
324	=item on_reset $term	146	=item on_reset $term
325		147
326	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
327	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
328	variables.	150	variables.
329		151
330	=item on_start $term
331
332	Called at the very end of initialisation of a new terminal, just before
333	returning to the mainloop.
334
335	=item on_child_start $term, $pid	152	=item on_child_start $term, $pid
336		153
337	Called just after the child process has been C<fork>ed.	154	Called just after the child process has been C<fork>ed.
338		155
339	=item on_child_exit $term, $status	156	=item on_child_exit $term, $status
…		…
354		171
355	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
356	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
357	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
358		175
359	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.
360		177
361	=item on_sel_extend $term	178	=item on_sel_extend $term
362		179
363	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
364	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
365	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
366	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
367	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
368	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
369		186
370	See the F<selection> example extension.	187	See the F<selection> example extension.
371		188
372	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
373		190
374	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
375	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
376	show this many lines of scrollback.	193	show this many lines of scrollback.
377		194
378	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
379		196
…		…
383		200
384	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,
385	$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
386	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
387		204
388	=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
389		216
390	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
391	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
392	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
393	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,
394	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
395	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	}
396		233
397	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,
398	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
399	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.
400		240
401	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
402		242
403	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
404	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
…		…
409	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
410		250
411	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
412	suppress or filter tty input.	252	suppress or filter tty input.
413		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
414	=item on_line_update $term, $row	261	=item on_line_update $term, $row
415		262
416	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
417	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
418	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,
…		…
425	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
426	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
427		274
428	=item on_refresh_begin $term	275	=item on_refresh_begin $term
429		276
430	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
431	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
432	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
433	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
434		281
435	=item on_refresh_end $term	282	=item on_refresh_end $term
436		283
437	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>.
438		285
439	=item on_keyboard_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
440		287
441	Called whenever the user presses a key combination that has a	288	Called whenever a user-configured event is being activated (e.g. via
442	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>
443	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.
444		300
445	=item on_x_event $term, $event	301	=item on_x_event $term, $event
446		302
447	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
448	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
449	members are not passed.	305	members are not passed.
450		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
451	=item on_focus_in $term	311	=item on_focus_in $term
452		312
453	Called whenever the window gets the keyboard focus, before rxvt-unicode	313	Called whenever the window gets the keyboard focus, before rxvt-unicode
454	does focus in processing.	314	does focus in processing.
455		315
456	=item on_focus_out $term	316	=item on_focus_out $term
457		317
458	Called wheneever the window loses keyboard focus, before rxvt-unicode does	318	Called whenever the window loses keyboard focus, before rxvt-unicode does
459	focus out processing.	319	focus out processing.
460		320
461	=item on_configure_notify $term, $event	321	=item on_configure_notify $term, $event
462		322
		323	=item on_property_notify $term, $event
		324
463	=item on_key_press $term, $event, $keysym, $octets	325	=item on_key_press $term, $event, $keysym, $octets
464		326
465	=item on_key_release $term, $event, $keysym	327	=item on_key_release $term, $event, $keysym
466		328
467	=item on_button_press $term, $event	329	=item on_button_press $term, $event
…		…
472		334
473	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
474		336
475	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
476		338
477	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
478	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.
479		341
480	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
481	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
482	and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
483		345
484	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
485	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
486		348
487	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.
488		361
489	=back	362	=back
490		363
491	=cut	364	=cut
492		365
493	package urxvt;	366	package urxvt;
494		367
495	use utf8;	368	use utf8;
496	use strict;	369	use strict 'vars';
497	use Carp ();	370	use Carp ();
498	use Scalar::Util ();	371	use Scalar::Util ();
499	use List::Util ();	372	use List::Util ();
500		373
501	our $VERSION = 1;	374	our $VERSION = 1;
502	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.
503	our @HOOKNAME;	378	our @HOOKNAME;
504	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
505	our %OPTION;	380	our %OPTION;
506		381
507	our $LIBDIR;	382	our $LIBDIR;
508	our $RESNAME;	383	our $RESNAME;
509	our $RESCLASS;	384	our $RESCLASS;
510	our $RXVTNAME;	385	our $RXVTNAME;
511		386
		387	our $NOCHAR = chr 0xffff;
		388
512	=head2 Variables in the C<urxvt> Package	389	=head2 Variables in the C<urxvt> Package
513		390
514	=over 4	391	=over 4
515		392
516	=item $urxvt::LIBDIR	393	=item $urxvt::LIBDIR
…		…
529	=item $urxvt::TERM	406	=item $urxvt::TERM
530		407
531	The current terminal. This variable stores the current C<urxvt::term>	408	The current terminal. This variable stores the current C<urxvt::term>
532	object, whenever a callback/hook is executing.	409	object, whenever a callback/hook is executing.
533		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
534	=back	427	=back
535		428
536	=head2 Functions in the C<urxvt> Package	429	=head2 Functions in the C<urxvt> Package
537		430
538	=over 4	431	=over 4
539		432
540	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
541		434
542	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
543	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
544	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
545		439
546	=item urxvt::warn $string	440	=item urxvt::warn $string
547		441
548	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
549	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
550	that calls this function.	444	that calls this function.
551		445
552	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
553	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
554		448
555	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).
556		457
557	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
558		459
559	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
560		461
…		…
603		504
604	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
605		506
606	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
607		508
608	=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
609		511
610	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
611	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
612	the bitset.	514	the bitset.
613		515
…		…
618	Return the foreground/background colour index, respectively.	520	Return the foreground/background colour index, respectively.
619		521
620	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	522	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
621		523
622	=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
623		527
624	Replace the foreground/background colour in the rendition mask with the	528	Replace the foreground/background colour in the rendition mask with the
625	specified one.	529	specified one.
626		530
627	=item $value = urxvt::GET_CUSTOM $rend	531	=item $value = urxvt::GET_CUSTOM $rend
…		…
646	unless $msg =~ /\n$/;	550	unless $msg =~ /\n$/;
647	urxvt::warn ($msg);	551	urxvt::warn ($msg);
648	};	552	};
649	}	553	}
650		554
		555	no warnings 'utf8';
		556
		557	sub parse_resource {
		558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		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	}
		615	}
		616
651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
652		618
653	sub verbose {	619	sub verbose {
654	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
655	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
…		…
658	my %extension_pkg;	624	my %extension_pkg;
659		625
660	# load a single script into its own package, once only	626	# load a single script into its own package, once only
661	sub extension_package($) {	627	sub extension_package($) {
662	my ($path) = @_;	628	my ($path) = @_;
663
664	no strict 'refs';
665		629
666	$extension_pkg{$path} ||= do {	630	$extension_pkg{$path} ||= do {
667	$path =~ /([^\/\\]+)$/;	631	$path =~ /([^\/\\]+)$/;
668	my $pkg = $1;	632	my $pkg = $1;
669	$pkg =~ s/[^[:word:]]/_/g;	633	$pkg =~ s/[^[:word:]]/_/g;
670	$pkg = "urxvt::ext::$pkg";	634	$pkg = "urxvt::ext::$pkg";
671		635
672	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
673		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		639
674	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
675	or die "$path: $!";	641	or die "$path: $!";
676		642
677	@{"$pkg\::ISA"} = urxvt::term::extension::;
678
679	my $source =	643	my $source =
680	"package $pkg; use strict; use utf8;\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
681	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
682	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
683	. "\n};\n1";	647	. "\n};\n1";
684		648
685	eval $source	649	eval $source
…		…
694	# called by the rxvt core	658	# called by the rxvt core
695	sub invoke {	659	sub invoke {
696	local $TERM = shift;	660	local $TERM = shift;
697	my $htype = shift;	661	my $htype = shift;
698		662
699	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
700	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
701		665
		666	$TERM->scan_extensions;
		667
702	my %ext_arg;	668	my %ext_arg;
703		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 (
		680	@{ delete $TERM->{perl_ext_3} },
704	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	681	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		682	) {
705	if ($_ eq "default") {	683	if ($_ eq "default") {
706	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	684	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
707	} elsif (/^-(.*)$/) {	685	} elsif (/^-(.*)$/) {
708	delete $ext_arg{$1};	686	delete $ext_arg{$1};
709	} elsif (/^([^<]+)<(.*)>$/) {	687	} elsif (/^([^<]+)<(.*)>$/) {
710	push @{ $ext_arg{$1} }, $2;	688	push @{ $ext_arg{$1} }, $2;
711	} else {	689	} else {
712	$ext_arg{$_} ||= [];	690	$ext_arg{$_} ||= [];
713	}	691	}
714	}	692	}
715		693
716	while (my ($ext, $argv) = each %ext_arg) {	694	for my $ext (sort keys %ext_arg) {
717	my @files = grep -f $_, map "$_/$ext", @dirs;	695	my @files = grep -f $_, map "$_/$ext", @dirs;
718		696
719	if (@files) {	697	if (@files) {
720	$TERM->register_package (extension_package $files[0], $argv);	698	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
721	} else {	699	} else {
722	warn "perl extension '$ext' not found in perl library search path\n";	700	warn "perl extension '$ext' not found in perl library search path\n";
723	}	701	}
724	}	702	}
725		703
…		…
731		709
732	if (my $cb = $TERM->{_hook}[$htype]) {	710	if (my $cb = $TERM->{_hook}[$htype]) {
733	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	711	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
734	if $verbosity >= 10;	712	if $verbosity >= 10;
735		713
736	keys %$cb;	714	if ($htype == HOOK_ACTION) {
		715	# this hook is only sent to the extension with the name
		716	# matching the first arg
		717	my $pkg = shift;
		718	$pkg =~ y/-/_/;
		719	$pkg = "urxvt::ext::$pkg";
737		720
738	while (my ($pkg, $cb) = each %$cb) {	721	$cb = $cb->{$pkg}
		722	or return undef; #TODO: maybe warn user?
		723
		724	$cb = { $pkg => $cb };
		725	}
		726
		727	for my $pkg (keys %$cb) {
739	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	728	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
740	and last;	729	$retval ||= $retval_;
741		730
742	if ($@) {	731	if ($@) {
743	$TERM->ungrab; # better to lose the grab than the session	732	$TERM->ungrab; # better to lose the grab than the session
744	warn $@;	733	warn $@;
745	}	734	}
…		…
747		736
748	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	737	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
749	if $verbosity >= 11;	738	if $verbosity >= 11;
750	}	739	}
751		740
752	if ($htype == 1) { # DESTROY	741	if ($htype == HOOK_DESTROY) {
753	# clear package objects	742	# clear package objects
754	%$_ = () for values %{ $TERM->{_pkg} };	743	%$_ = () for values %{ $TERM->{_pkg} };
755		744
756	# clear package	745	# clear package
757	%$TERM = ();	746	%$TERM = ();
758	}	747	}
759		748
760	$retval	749	$retval
761	}	750	}
762		751
763	# urxvt::term::extension	752	sub SET_COLOR($$$) {
		753	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		754	}
		755
		756	sub rend2mask {
		757	no strict 'refs';
		758	my ($str, $mask) = (@_, 0);
		759	my %color = ( fg => undef, bg => undef );
		760	my @failed;
		761	for my $spec ( split /\s+/, $str ) {
		762	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		763	$color{lc($1)} = $2;
		764	} else {
		765	my $neg = $spec =~ s/^[-^]//;
		766	unless ( exists &{"RS_$spec"} ) {
		767	push @failed, $spec;
		768	next;
		769	}
		770	my $cur = &{"RS_$spec"};
		771	if ( $neg ) {
		772	$mask &= ~$cur;
		773	} else {
		774	$mask |= $cur;
		775	}
		776	}
		777	}
		778	($mask, @color{qw(fg bg)}, \@failed)
		779	}
764		780
765	package urxvt::term::extension;	781	package urxvt::term::extension;
766		782
767	sub enable {	783	=head2 The C<urxvt::term::extension> class
768	my ($self, %hook) = @_;
769	my $pkg = $self->{_pkg};
770		784
771	while (my ($name, $cb) = each %hook) {	785	Each extension attached to a terminal object is represented by
772	my $htype = $HOOKTYPE{uc $name};	786	a C<urxvt::term::extension> object.
773	defined $htype
774	or Carp::croak "unsupported hook type '$name'";
775		787
776	$self->set_should_invoke ($htype, +1)	788	You can use these objects, which are passed to all callbacks to store any
777	unless exists $self->{term}{_hook}[$htype]{$pkg};	789	state related to the terminal and extension instance.
778		790
779	$self->{term}{_hook}[$htype]{$pkg} = $cb;	791	The methods (And data members) documented below can be called on extension
780	}	792	objects, in addition to call methods documented for the <urxvt::term>
781	}	793	class.
782		794
783	sub disable {	795	=over 4
784	my ($self, @hook) = @_;
785	my $pkg = $self->{_pkg};
786		796
787	for my $name (@hook) {	797	=item $urxvt_term = $self->{term}
788	my $htype = $HOOKTYPE{uc $name};
789	defined $htype
790	or Carp::croak "unsupported hook type '$name'";
791		798
792	$self->set_should_invoke ($htype, -1)	799	Returns the C<urxvt::term> object associated with this instance of the
793	if delete $self->{term}{_hook}[$htype]{$pkg};	800	extension. This member I<must not> be changed in any way.
794	}	801
795	}	802	=cut
796		803
797	our $AUTOLOAD;	804	our $AUTOLOAD;
798		805
799	sub AUTOLOAD {	806	sub AUTOLOAD {
800	$AUTOLOAD =~ /:([^:]+)$/	807	$AUTOLOAD =~ /:([^:]+)$/
…		…
813		820
814	sub DESTROY {	821	sub DESTROY {
815	# nop	822	# nop
816	}	823	}
817		824
818	# urxvt::destroy_hook	825	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
819		826
820	sub urxvt::destroy_hook::DESTROY {	827	sub urxvt::destroy_hook::DESTROY {
821	${$_[0]}->();	828	${$_[0]}->();
822	}	829	}
823		830
824	sub urxvt::destroy_hook(&) {	831	sub urxvt::destroy_hook(&) {
825	bless \shift, urxvt::destroy_hook::	832	bless \shift, urxvt::destroy_hook::
826	}	833	}
		834
		835	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		836
		837	Dynamically enable the given hooks (named without the C<on_> prefix) for
		838	this extension, replacing any hook previously installed via C<enable> in
		839	this extension.
		840
		841	This is useful when you want to overwrite time-critical hooks only
		842	temporarily.
		843
		844	To install additional callbacks for the same hook, you can use the C<on>
		845	method of the C<urxvt::term> class.
		846
		847	=item $self->disable ($hook_name[, $hook_name..])
		848
		849	Dynamically disable the given hooks.
		850
		851	=cut
		852
		853	sub enable {
		854	my ($self, %hook) = @_;
		855	my $pkg = $self->{_pkg};
		856
		857	while (my ($name, $cb) = each %hook) {
		858	my $htype = $HOOKTYPE{uc $name};
		859	defined $htype
		860	or Carp::croak "unsupported hook type '$name'";
		861
		862	$self->set_should_invoke ($htype, +1)
		863	unless exists $self->{term}{_hook}[$htype]{$pkg};
		864
		865	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		866	}
		867	}
		868
		869	sub disable {
		870	my ($self, @hook) = @_;
		871	my $pkg = $self->{_pkg};
		872
		873	for my $name (@hook) {
		874	my $htype = $HOOKTYPE{uc $name};
		875	defined $htype
		876	or Carp::croak "unsupported hook type '$name'";
		877
		878	$self->set_should_invoke ($htype, -1)
		879	if delete $self->{term}{_hook}[$htype]{$pkg};
		880	}
		881	}
		882
		883	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		884
		885	Similar to the C<enable> enable, but installs additional callbacks for
		886	the given hook(s) (that is, it doesn't replace existing callbacks), and
		887	returns a guard object. When the guard object is destroyed the callbacks
		888	are disabled again.
		889
		890	=cut
		891
		892	sub urxvt::extension::on_disable::DESTROY {
		893	my $disable = shift;
		894
		895	my $term = delete $disable->{""};
		896
		897	while (my ($htype, $id) = each %$disable) {
		898	delete $term->{_hook}[$htype]{$id};
		899	$term->set_should_invoke ($htype, -1);
		900	}
		901	}
		902
		903	sub on {
		904	my ($self, %hook) = @_;
		905
		906	my $term = $self->{term};
		907
		908	my %disable = ( "" => $term );
		909
		910	while (my ($name, $cb) = each %hook) {
		911	my $htype = $HOOKTYPE{uc $name};
		912	defined $htype
		913	or Carp::croak "unsupported hook type '$name'";
		914
		915	$term->set_should_invoke ($htype, +1);
		916	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		917	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		918	}
		919
		920	bless \%disable, "urxvt::extension::on_disable"
		921	}
		922
		923	=item $self->x_resource ($pattern)
		924
		925	=item $self->x_resource_boolean ($pattern)
		926
		927	These methods support an additional C<%> prefix when called on an
		928	extension object - see the description of these methods in the
		929	C<urxvt::term> class for details.
		930
		931	=cut
		932
		933	sub x_resource {
		934	my ($self, $name) = @_;
		935	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		936	$self->{term}->x_resource ($name)
		937	}
		938
		939	sub x_resource_boolean {
		940	my ($self, $name) = @_;
		941	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		942	$self->{term}->x_resource_boolean ($name)
		943	}
		944
		945	=back
		946
		947	=cut
827		948
828	package urxvt::anyevent;	949	package urxvt::anyevent;
829		950
830	=head2 The C<urxvt::anyevent> Class	951	=head2 The C<urxvt::anyevent> Class
831		952
832	The sole purpose of this class is to deliver an interface to the	953	The sole purpose of this class is to deliver an interface to the
833	C<AnyEvent> module - any module using it will work inside urxvt without	954	C<AnyEvent> module - any module using it will work inside urxvt without
834	further programming. The only exception is that you cannot wait on	955	further programming. The only exception is that you cannot wait on
835	condition variables, but non-blocking condvar use is ok. What this means	956	condition variables, but non-blocking condvar use is ok.
836	is that you cannot use blocking APIs, but the non-blocking variant should
837	work.
838		957
839	=cut	958	In practical terms this means is that you cannot use blocking APIs, but
		959	the non-blocking variant should work.
840		960
		961	=cut
		962
841	our $VERSION = 1;	963	our $VERSION = '5.23';
842		964
843	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	965	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
844	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	966	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
845		967
846	sub timer {	968	sub timer {
…		…
848		970
849	my $cb = $arg{cb};	971	my $cb = $arg{cb};
850		972
851	urxvt::timer	973	urxvt::timer
852	->new	974	->new
853	->start (urxvt::NOW + $arg{after})	975	->after ($arg{after}, $arg{interval})
854	->cb (sub {	976	->cb ($arg{interval} ? $cb : sub {
855	$_[0]->stop; # need to cancel manually	977	$_[0]->stop; # need to cancel manually
856	$cb->();	978	$cb->();
857	})	979	})
858	}	980	}
859		981
860	sub io {	982	sub io {
861	my ($class, %arg) = @_;	983	my ($class, %arg) = @_;
862		984
863	my $cb = $arg{cb};	985	my $cb = $arg{cb};
		986	my $fd = fileno $arg{fh};
		987	defined $fd or $fd = $arg{fh};
864		988
865	bless [$arg{fh}, urxvt::iow	989	bless [$arg{fh}, urxvt::iow
866	->new	990	->new
867	->fd (fileno $arg{fh})	991	->fd ($fd)
868	->events (($arg{poll} =~ /r/ ? 1 : 0)	992	->events (($arg{poll} =~ /r/ ? 1 : 0)
869	| ($arg{poll} =~ /w/ ? 2 : 0))	993	| ($arg{poll} =~ /w/ ? 2 : 0))
870	->start	994	->start
871	->cb (sub {	995	->cb ($cb)
872	$cb->(($_[1] & 1 ? 'r' : '')
873	. ($_[1] & 2 ? 'w' : ''));
874	})],
875	urxvt::anyevent::	996	], urxvt::anyevent::
		997	}
		998
		999	sub idle {
		1000	my ($class, %arg) = @_;
		1001
		1002	my $cb = $arg{cb};
		1003
		1004	urxvt::iw
		1005	->new
		1006	->start
		1007	->cb ($cb)
		1008	}
		1009
		1010	sub child {
		1011	my ($class, %arg) = @_;
		1012
		1013	my $cb = $arg{cb};
		1014
		1015	urxvt::pw
		1016	->new
		1017	->start ($arg{pid})
		1018	->cb (sub {
		1019	$_[0]->stop; # need to cancel manually
		1020	$cb->($_[0]->rpid, $_[0]->rstatus);
		1021	})
876	}	1022	}
877		1023
878	sub DESTROY {	1024	sub DESTROY {
879	$_[0][1]->stop;	1025	$_[0][1]->stop;
880	}	1026	}
881		1027
882	sub condvar {	1028	# only needed for AnyEvent < 6 compatibility
883	bless \my $flag, urxvt::anyevent::condvar::	1029	sub one_event {
884	}
885
886	sub urxvt::anyevent::condvar::broadcast {
887	${$_[0]}++;
888	}
889
890	sub urxvt::anyevent::condvar::wait {
891	unless (${$_[0]}) {
892	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1030	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
893	}
894	}	1031	}
895		1032
896	package urxvt::term;	1033	package urxvt::term;
897		1034
898	=head2 The C<urxvt::term> Class	1035	=head2 The C<urxvt::term> Class
…		…
904	# find on_xxx subs in the package and register them	1041	# find on_xxx subs in the package and register them
905	# as hooks	1042	# as hooks
906	sub register_package {	1043	sub register_package {
907	my ($self, $pkg, $argv) = @_;	1044	my ($self, $pkg, $argv) = @_;
908		1045
		1046	no strict 'refs';
		1047
		1048	urxvt::verbose 6, "register package $pkg to $self";
		1049
		1050	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1051
909	my $proxy = bless {	1052	my $proxy = bless {
910	_pkg => $pkg,	1053	_pkg => $pkg,
		1054	_name => ${"$pkg\::_NAME"}, # hackish
911	argv => $argv,	1055	argv => $argv,
912	}, $pkg;	1056	}, $pkg;
913	Scalar::Util::weaken ($proxy->{term} = $self);	1057	Scalar::Util::weaken ($proxy->{term} = $self);
914		1058
915	$self->{_pkg}{$pkg} = $proxy;	1059	$self->{_pkg}{$pkg} = $proxy;
916		1060
…		…
919	$proxy->enable ($name => $ref);	1063	$proxy->enable ($name => $ref);
920	}	1064	}
921	}	1065	}
922	}	1066	}
923		1067
		1068	sub perl_libdirs {
		1069	map { split /:/ }
		1070	$_[0]->resource ("perl_lib"),
		1071	$ENV{URXVT_PERL_LIB},
		1072	"$ENV{HOME}/.urxvt/ext",
		1073	"$LIBDIR/perl"
		1074	}
		1075
		1076	# scan for available extensions and collect their metadata
		1077	sub scan_extensions {
		1078	my ($self) = @_;
		1079
		1080	return if exists $self->{meta};
		1081
		1082	my @libdirs = perl_libdirs $self;
		1083
		1084	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1085
		1086	my %meta;
		1087
		1088	$self->{meta_libdirs} = join "\x00", @libdirs;
		1089	$self->{meta} = \%meta;
		1090
		1091	my %ext;
		1092
		1093	# first gather extensions
		1094	for my $dir (reverse @libdirs) {
		1095	opendir my $fh, $dir
		1096	or next;
		1097	for my $ext (readdir $fh) {
		1098	$ext !~ /^\./
		1099	and open my $fh, "<", "$dir/$ext"
		1100	or next;
		1101
		1102	my %ext = (dir => $dir);
		1103
		1104	while (<$fh>) {
		1105	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1106	my ($pattern, $type, $desc) = split /:/, $1;
		1107	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1108	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1109	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1110	} else {
		1111	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1112	}
		1113	} elsif (/^#:META:BINDING:(.*)/) {
		1114	my ($keysym, $action) = split /:/, $1;
		1115	$ext{binding}{$keysym} = $action;
		1116	} elsif (/^\s*(?:#|$)/) {
		1117	# skip other comments and empty lines
		1118	} else {
		1119	last; # stop parsing on first non-empty non-comment line
		1120	}
		1121	}
		1122
		1123	$meta{$ext} = \%ext;
		1124	}
		1125	}
		1126
		1127	# and now merge resources and bindings
		1128	while (my ($k, $v) = each %ext) {
		1129	#TODO: should check for extensions overriding each other
		1130	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1131	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1132	}
		1133	}
		1134
924	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1135	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
925		1136
926	Creates a new terminal, very similar as if you had started it with system	1137	Creates a new terminal, very similar as if you had started it with system
927	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1138	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
928	hash which defines the environment of the new terminal.	1139	hash which defines the environment of the new terminal.
929		1140
930	Croaks (and probably outputs an error message) if the new instance	1141	Croaks (and probably outputs an error message) if the new instance
931	couldn't be created. Returns C<undef> if the new instance didn't	1142	couldn't be created. Returns C<undef> if the new instance didn't
932	initialise perl, and the terminal object otherwise. The C<init> and	1143	initialise perl, and the terminal object otherwise. The C<init> and
933	C<start> hooks will be called during this call.	1144	C<start> hooks will be called before this call returns, and are free to
		1145	refer to global data (which is race free).
934		1146
935	=cut	1147	=cut
936		1148
937	sub new {	1149	sub new {
938	my ($class, $env, @args) = @_;	1150	my ($class, $env, @args) = @_;
939		1151
		1152	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1153	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1154
940	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1155	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
941	}	1156	}
942		1157
943	=item $term->destroy	1158	=item $term->destroy
944		1159
945	Destroy the terminal object (close the window, free resources	1160	Destroy the terminal object (close the window, free resources
946	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1161	etc.). Please note that urxvt will not exit as long as any event
947	watchers (timers, io watchers) are still active.	1162	watchers (timers, io watchers) are still active.
948		1163
949	=item $term->exec_async ($cmd[, @args])	1164	=item $term->exec_async ($cmd[, @args])
950		1165
951	Works like the combination of the C<fork>/C<exec> builtins, which executes	1166	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
975		1190
976	Returns true if the option specified by C<$optval> is enabled, and	1191	Returns true if the option specified by C<$optval> is enabled, and
977	optionally change it. All option values are stored by name in the hash	1192	optionally change it. All option values are stored by name in the hash
978	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1193	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
979		1194
980	Here is a a likely non-exhaustive list of option names, please see the	1195	Here is a likely non-exhaustive list of option names, please see the
981	source file F</src/optinc.h> to see the actual list:	1196	source file F</src/optinc.h> to see the actual list:
982		1197
983	borderLess console cursorBlink cursorUnderline hold iconic insecure	1198	borderLess buffered console cursorBlink cursorUnderline hold iconic
984	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1199	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
985	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1200	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
986	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1201	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
987	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1202	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
988	transparent tripleclickwords utmpInhibit visualBell	1203	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1204	urgentOnBell utmpInhibit visualBell
989		1205
990	=item $value = $term->resource ($name[, $newval])	1206	=item $value = $term->resource ($name[, $newval])
991		1207
992	Returns the current resource value associated with a given name and	1208	Returns the current resource value associated with a given name and
993	optionally sets a new value. Setting values is most useful in the C<init>	1209	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1002	likely change).	1218	likely change).
1003		1219
1004	Please note that resource strings will currently only be freed when the	1220	Please note that resource strings will currently only be freed when the
1005	terminal is destroyed, so changing options frequently will eat memory.	1221	terminal is destroyed, so changing options frequently will eat memory.
1006		1222
1007	Here is a a likely non-exhaustive list of resource names, not all of which	1223	Here is a likely non-exhaustive list of resource names, not all of which
1008	are supported in every build, please see the source file F</src/rsinc.h>	1224	are supported in every build, please see the source file F</src/rsinc.h>
1009	to see the actual list:	1225	to see the actual list:
1010		1226
1011	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1227	answerbackstring backgroundPixmap backspace_key blurradius
1012	borderLess color cursorBlink cursorUnderline cutchars delete_key	1228	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1013	display_name embed ext_bwidth fade font geometry hold iconName	1229	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1014	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1230	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1231	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1015	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1232	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1016	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1233	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1017	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1234	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1018	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1235	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1019	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1236	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1020	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1237	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1021	secondaryScreen secondaryScroll selectstyle shade term_name title	1238	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1022	transient_for transparent transparent_all tripleclickwords utmpInhibit	1239	term_name title transient_for transparent tripleclickwords urgentOnBell
1023	visualBell	1240	utmpInhibit visualBell
1024		1241
1025	=cut	1242	=cut
1026		1243
1027	sub resource($$;$) {	1244	sub resource($$;$) {
1028	my ($self, $name) = (shift, shift);	1245	my ($self, $name) = (shift, shift);
1029	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1246	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1030	&urxvt::term::_resource	1247	goto &urxvt::term::_resource
1031	}	1248	}
1032		1249
1033	=item $value = $term->x_resource ($pattern)	1250	=item $value = $term->x_resource ($pattern)
1034		1251
1035	Returns the X-Resource for the given pattern, excluding the program or	1252	Returns the X-Resource for the given pattern, excluding the program or
1036	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1253	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1037	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1254	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1038	resource with that pattern exists.	1255	resource with that pattern exists.
1039		1256
		1257	Extensions that define extra resource or command line arguments also need
		1258	to call this method to access their values.
		1259
		1260	If the method is called on an extension object (basically, from an
		1261	extension), then the special prefix C<%.> will be replaced by the name of
		1262	the extension and a dot, and the lone string C<%> will be replaced by the
		1263	extension name itself. This makes it possible to code extensions so you
		1264	can rename them and get a new set of commandline switches and resources
		1265	without having to change the actual code.
		1266
1040	This method should only be called during the C<on_start> hook, as there is	1267	This method should only be called during the C<on_start> hook, as there is
1041	only one resource database per display, and later invocations might return	1268	only one resource database per display, and later invocations might return
1042	the wrong resources.	1269	the wrong resources.
1043		1270
1044	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1271	=item $value = $term->x_resource_boolean ($pattern)
1045		1272
		1273	Like C<x_resource>, above, but interprets the string value as a boolean
		1274	and returns C<1> for true values, C<0> for false values and C<undef> if
		1275	the resource or option isn't specified.
		1276
		1277	You should always use this method to parse boolean resources.
		1278
		1279	=cut
		1280
		1281	sub x_resource_boolean {
		1282	my $res = &x_resource;
		1283
		1284	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1285	}
		1286
		1287	=item $success = $term->bind_action ($key, $octets)
		1288
1046	Adds a keymap translation exactly as specified via a resource. See the	1289	Adds a key binding exactly as specified via a C<keysym> resource. See the
1047	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1290	C<keysym> resource in the urxvt(1) manpage.
1048		1291
1049	=item $rend = $term->rstyle ([$new_rstyle])	1292	=item $rend = $term->rstyle ([$new_rstyle])
1050		1293
1051	Return and optionally change the current rendition. Text that is output by	1294	Return and optionally change the current rendition. Text that is output by
1052	the terminal application will use this style.	1295	the terminal application will use this style.
…		…
1060		1303
1061	=item ($row, $col) = $term->selection_beg ([$row, $col])	1304	=item ($row, $col) = $term->selection_beg ([$row, $col])
1062		1305
1063	=item ($row, $col) = $term->selection_end ([$row, $col])	1306	=item ($row, $col) = $term->selection_end ([$row, $col])
1064		1307
1065	Return the current values of the selection mark, begin or end positions,	1308	Return the current values of the selection mark, begin or end positions.
1066	and optionally set them to new values.	1309
		1310	When arguments are given, then the selection coordinates are set to
		1311	C<$row> and C<$col>, and the selection screen is set to the current
		1312	screen.
		1313
		1314	=item $screen = $term->selection_screen ([$screen])
		1315
		1316	Returns the current selection screen, and then optionally sets it.
1067		1317
1068	=item $term->selection_make ($eventtime[, $rectangular])	1318	=item $term->selection_make ($eventtime[, $rectangular])
1069		1319
1070	Tries to make a selection as set by C<selection_beg> and	1320	Tries to make a selection as set by C<selection_beg> and
1071	C<selection_end>. If C<$rectangular> is true (default: false), a	1321	C<selection_end>. If C<$rectangular> is true (default: false), a
1072	rectangular selection will be made. This is the prefered function to make	1322	rectangular selection will be made. This is the preferred function to make
1073	a selection.	1323	a selection.
1074		1324
1075	=item $success = $term->selection_grab ($eventtime)	1325	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1076		1326
1077	Try to request the primary selection text from the server (for example, as	1327	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1328	true) selection from the server. The corresponding text can be set
1078	set by the next method). No visual feedback will be given. This function	1329	with the next method. No visual feedback will be given. This function
1079	is mostly useful from within C<on_sel_grab> hooks.	1330	is mostly useful from within C<on_sel_grab> hooks.
1080		1331
1081	=item $oldtext = $term->selection ([$newtext])	1332	=item $oldtext = $term->selection ([$newtext, $clipboard])
1082		1333
1083	Return the current selection text and optionally replace it by C<$newtext>.	1334	Return the current selection (clipboard if C<$clipboard> is true) text
		1335	and optionally replace it by C<$newtext>.
		1336
		1337	=item $term->selection_clear ([$clipboard])
		1338
		1339	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1084		1340
1085	=item $term->overlay_simple ($x, $y, $text)	1341	=item $term->overlay_simple ($x, $y, $text)
1086		1342
1087	Create a simple multi-line overlay box. See the next method for details.	1343	Create a simple multi-line overlay box. See the next method for details.
1088		1344
…		…
1118		1374
1119	The methods currently supported on C<urxvt::overlay> objects are:	1375	The methods currently supported on C<urxvt::overlay> objects are:
1120		1376
1121	=over 4	1377	=over 4
1122		1378
1123	=item $overlay->set ($x, $y, $text, $rend)	1379	=item $overlay->set ($x, $y, $text[, $rend])
1124		1380
1125	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1381	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1126	text in rxvt-unicode's special encoding and an array of rendition values	1382	text in rxvt-unicode's special encoding and an array of rendition values
1127	at a specific position inside the overlay.	1383	at a specific position inside the overlay.
		1384
		1385	If C<$rend> is missing, then the rendition will not be changed.
1128		1386
1129	=item $overlay->hide	1387	=item $overlay->hide
1130		1388
1131	If visible, hide the overlay, but do not destroy it.	1389	If visible, hide the overlay, but do not destroy it.
1132		1390
…		…
1202		1460
1203	Normally its not a good idea to use this function, as programs might be	1461	Normally its not a good idea to use this function, as programs might be
1204	confused by changes in cursor position or scrolling. Its useful inside a	1462	confused by changes in cursor position or scrolling. Its useful inside a
1205	C<on_add_lines> hook, though.	1463	C<on_add_lines> hook, though.
1206		1464
		1465	=item $term->scr_change_screen ($screen)
		1466
		1467	Switch to given screen - 0 primary, 1 secondary.
		1468
1207	=item $term->cmd_parse ($octets)	1469	=item $term->cmd_parse ($octets)
1208		1470
1209	Similar to C<scr_add_lines>, but the argument must be in the	1471	Similar to C<scr_add_lines>, but the argument must be in the
1210	locale-specific encoding of the terminal and can contain command sequences	1472	locale-specific encoding of the terminal and can contain command sequences
1211	(escape codes) that will be interpreted.	1473	(escape codes) that will be interpreted.
1212		1474
1213	=item $term->tt_write ($octets)	1475	=item $term->tt_write ($octets)
1214		1476
1215	Write the octets given in C<$data> to the tty (i.e. as program input). To	1477	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1216	pass characters instead of octets, you should convert your strings first	1478	pass characters instead of octets, you should convert your strings first
1217	to the locale-specific encoding using C<< $term->locale_encode >>.	1479	to the locale-specific encoding using C<< $term->locale_encode >>.
		1480
		1481	=item $term->tt_write_user_input ($octets)
		1482
		1483	Like C<tt_write>, but should be used when writing strings in response to
		1484	the user pressing a key, to invokes the additional actions requested by
		1485	the user for that case (C<tt_write> doesn't do that).
		1486
		1487	The typical use case would be inside C<on_action> hooks.
		1488
		1489	=item $term->tt_paste ($octets)
		1490
		1491	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1492	CR and bracketing the data with control sequences if bracketed paste mode
		1493	is set.
1218		1494
1219	=item $old_events = $term->pty_ev_events ([$new_events])	1495	=item $old_events = $term->pty_ev_events ([$new_events])
1220		1496
1221	Replaces the event mask of the pty watcher by the given event mask. Can	1497	Replaces the event mask of the pty watcher by the given event mask. Can
1222	be used to suppress input and output handling to the pty/tty. See the	1498	be used to suppress input and output handling to the pty/tty. See the
1223	description of C<< urxvt::timer->events >>. Make sure to always restore	1499	description of C<< urxvt::timer->events >>. Make sure to always restore
1224	the previous value.	1500	the previous value.
1225		1501
		1502	=item $fd = $term->pty_fd
		1503
		1504	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1505	is used.
		1506
1226	=item $windowid = $term->parent	1507	=item $windowid = $term->parent
1227		1508
1228	Return the window id of the toplevel window.	1509	Return the window id of the toplevel window.
1229		1510
1230	=item $windowid = $term->vt	1511	=item $windowid = $term->vt
…		…
1236	Adds the specified events to the vt event mask. Useful e.g. when you want	1517	Adds the specified events to the vt event mask. Useful e.g. when you want
1237	to receive pointer events all the times:	1518	to receive pointer events all the times:
1238		1519
1239	$term->vt_emask_add (urxvt::PointerMotionMask);	1520	$term->vt_emask_add (urxvt::PointerMotionMask);
1240		1521
		1522	=item $term->set_urgency ($set)
		1523
		1524	Enable/disable the urgency hint on the toplevel window.
		1525
		1526	=item $term->focus_in
		1527
		1528	=item $term->focus_out
		1529
		1530	=item $term->key_press ($state, $keycode[, $time])
		1531
		1532	=item $term->key_release ($state, $keycode[, $time])
		1533
		1534	Deliver various fake events to to terminal.
		1535
1241	=item $window_width = $term->width	1536	=item $window_width = $term->width
1242		1537
1243	=item $window_height = $term->height	1538	=item $window_height = $term->height
1244		1539
1245	=item $font_width = $term->fwidth	1540	=item $font_width = $term->fwidth
…		…
1275	=item $env = $term->env	1570	=item $env = $term->env
1276		1571
1277	Returns a copy of the environment in effect for the terminal as a hashref	1572	Returns a copy of the environment in effect for the terminal as a hashref
1278	similar to C<\%ENV>.	1573	similar to C<\%ENV>.
1279		1574
		1575	=item @envv = $term->envv
		1576
		1577	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1578
		1579	=item @argv = $term->argv
		1580
		1581	Return the argument vector as this terminal, similar to @ARGV, but
		1582	includes the program name as first element.
		1583
1280	=cut	1584	=cut
1281		1585
1282	sub env {	1586	sub env {
1283	if (my $env = $_[0]->_env) {
1284	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1587	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1285	} else {
1286	+{ %ENV }
1287	}
1288	}	1588	}
1289		1589
1290	=item $modifiermask = $term->ModLevel3Mask	1590	=item $modifiermask = $term->ModLevel3Mask
1291		1591
1292	=item $modifiermask = $term->ModMetaMask	1592	=item $modifiermask = $term->ModMetaMask
1293		1593
1294	=item $modifiermask = $term->ModNumLockMask	1594	=item $modifiermask = $term->ModNumLockMask
1295		1595
1296	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1596	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1297	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1597	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1598
		1599	=item $screen = $term->current_screen
		1600
		1601	Returns the currently displayed screen (0 primary, 1 secondary).
		1602
		1603	=item $cursor_is_hidden = $term->hidden_cursor
		1604
		1605	Returns whether the cursor is currently hidden or not.
1298		1606
1299	=item $view_start = $term->view_start ([$newvalue])	1607	=item $view_start = $term->view_start ([$newvalue])
1300		1608
1301	Returns the row number of the topmost displayed line. Maximum value is	1609	Returns the row number of the topmost displayed line. Maximum value is
1302	C<0>, which displays the normal terminal contents. Lower values scroll	1610	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1310		1618
1311	Used after changing terminal contents to display them.	1619	Used after changing terminal contents to display them.
1312		1620
1313	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1621	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1314		1622
1315	Returns the text of the entire row with number C<$row_number>. Row C<0>	1623	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1316	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1624	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1317	terminal line. The scrollback buffer starts at line C<-1> and extends to
1318	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1625	terminal line. Nothing will be returned if a nonexistent line
1319	is requested.	1626	is requested.
1320		1627
1321	If C<$new_text> is specified, it will replace characters in the current	1628	If C<$new_text> is specified, it will replace characters in the current
1322	line, starting at column C<$start_col> (default C<0>), which is useful	1629	line, starting at column C<$start_col> (default C<0>), which is useful
1323	to replace only parts of a line. The font index in the rendition will	1630	to replace only parts of a line. The font index in the rendition will
1324	automatically be updated.	1631	automatically be updated.
1325		1632
1326	C<$text> is in a special encoding: tabs and wide characters that use more	1633	C<$text> is in a special encoding: tabs and wide characters that use more
1327	than one cell when displayed are padded with urxvt::NOCHAR characters	1634	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1328	(C<chr 65535>). Characters with combining characters and other characters	1635	characters. Characters with combining characters and other characters that
1329	that do not fit into the normal tetx encoding will be replaced with	1636	do not fit into the normal text encoding will be replaced with characters
1330	characters in the private use area.	1637	in the private use area.
1331		1638
1332	You have to obey this encoding when changing text. The advantage is	1639	You have to obey this encoding when changing text. The advantage is
1333	that C<substr> and similar functions work on screen cells and not on	1640	that C<substr> and similar functions work on screen cells and not on
1334	characters.	1641	characters.
1335		1642
…		…
1419	}	1726	}
1420		1727
1421	sub urxvt::line::t {	1728	sub urxvt::line::t {
1422	my ($self) = @_;	1729	my ($self) = @_;
1423		1730
1424	if (@_ > 1)	1731	if (@_ > 1) {
1425	{
1426	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1732	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1427	for $self->{beg} .. $self->{end};	1733	for $self->{beg} .. $self->{end};
1428	}	1734	}
1429		1735
1430	defined wantarray &&	1736	defined wantarray &&
1431	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1737	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1432	0, $self->{len}	1738	0, $self->{len}
1433	}	1739	}
1434		1740
1435	sub urxvt::line::r {	1741	sub urxvt::line::r {
1436	my ($self) = @_;	1742	my ($self) = @_;
1437		1743
1438	if (@_ > 1)	1744	if (@_ > 1) {
1439	{
1440	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1745	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1441	for $self->{beg} .. $self->{end};	1746	for $self->{beg} .. $self->{end};
1442	}	1747	}
1443		1748
1444	if (defined wantarray) {	1749	if (defined wantarray) {
1445	my $rend = [	1750	my $rend = [
1446	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1751	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1447	];	1752	];
…		…
1479	where one character corresponds to one screen cell. See	1784	where one character corresponds to one screen cell. See
1480	C<< $term->ROW_t >> for details.	1785	C<< $term->ROW_t >> for details.
1481		1786
1482	=item $string = $term->special_decode $text	1787	=item $string = $term->special_decode $text
1483		1788
1484	Converts rxvt-unicodes text reprsentation into a perl string. See	1789	Converts rxvt-unicodes text representation into a perl string. See
1485	C<< $term->ROW_t >> for details.	1790	C<< $term->ROW_t >> for details.
1486		1791
1487	=item $success = $term->grab_button ($button, $modifiermask)	1792	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1488		1793
		1794	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1795
1489	Registers a synchronous button grab. See the XGrabButton manpage.	1796	Register/unregister a synchronous button grab. See the XGrabButton
		1797	manpage.
1490		1798
1491	=item $success = $term->grab ($eventtime[, $sync])	1799	=item $success = $term->grab ($eventtime[, $sync])
1492		1800
1493	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1801	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1494	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1802	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1495		1803
1496	=item $term->allow_events_async	1804	=item $term->allow_events_async
1497		1805
1498	Calls XAllowEvents with AsyncBoth for the most recent grab.	1806	Calls XAllowEvents with AsyncBoth for the most recent grab.
1499		1807
…		…
1506	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1814	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1507	recent grab.	1815	recent grab.
1508		1816
1509	=item $term->ungrab	1817	=item $term->ungrab
1510		1818
1511	Calls XUngrab for the most recent grab. Is called automatically on	1819	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1512	evaluation errors, as it is better to lose the grab in the error case as	1820	evaluation errors, as it is better to lose the grab in the error case as
1513	the session.	1821	the session.
		1822
		1823	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1824
		1825	=item $atom_name = $term->XGetAtomName ($atom)
		1826
		1827	=item @atoms = $term->XListProperties ($window)
		1828
		1829	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1830
		1831	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1832
		1833	=item $term->XDeleteProperty ($window, $property)
		1834
		1835	=item $window = $term->DefaultRootWindow
		1836
		1837	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1838
		1839	=item $term->XMapWindow ($window)
		1840
		1841	=item $term->XUnmapWindow ($window)
		1842
		1843	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1844
		1845	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1846
		1847	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1848
		1849	=item $keysym = $term->XStringToKeysym ($string)
		1850
		1851	=item $string = $term->XKeysymToString ($keysym)
		1852
		1853	Various X or X-related functions. The C<$term> object only serves as
		1854	the source of the display, otherwise those functions map more-or-less
		1855	directly onto the X functions of the same name.
1514		1856
1515	=back	1857	=back
1516		1858
1517	=cut	1859	=cut
1518		1860
…		…
1582	my ($self, $text, $cb) = @_;	1924	my ($self, $text, $cb) = @_;
1583		1925
1584	$self->add_item ({ type => "button", text => $text, activate => $cb});	1926	$self->add_item ({ type => "button", text => $text, activate => $cb});
1585	}	1927	}
1586		1928
1587	=item $popup->add_toggle ($text, $cb, $initial_value)	1929	=item $popup->add_toggle ($text, $initial_value, $cb)
1588		1930
1589	Adds a toggle/checkbox item to the popup. Teh callback gets called	1931	Adds a toggle/checkbox item to the popup. The callback gets called
1590	whenever it gets toggled, with a boolean indicating its value as its first	1932	whenever it gets toggled, with a boolean indicating its new value as its
1591	argument.	1933	first argument.
1592		1934
1593	=cut	1935	=cut
1594		1936
1595	sub add_toggle {	1937	sub add_toggle {
1596	my ($self, $text, $cb, $value) = @_;	1938	my ($self, $text, $value, $cb) = @_;
1597		1939
1598	my $item; $item = {	1940	my $item; $item = {
1599	type => "button",	1941	type => "button",
1600	text => " $text",	1942	text => " $text",
1601	value => $value,	1943	value => $value,
…		…
1620	my $env = $self->{term}->env;	1962	my $env = $self->{term}->env;
1621	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1963	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1622	delete $env->{LC_ALL};	1964	delete $env->{LC_ALL};
1623	$env->{LC_CTYPE} = $self->{term}->locale;	1965	$env->{LC_CTYPE} = $self->{term}->locale;
1624		1966
1625	urxvt::term->new ($env, "popup",	1967	my $term = urxvt::term->new (
		1968	$env, "popup",
1626	"--perl-lib" => "", "--perl-ext-common" => "",	1969	"--perl-lib" => "", "--perl-ext-common" => "",
1627	"-pty-fd" => -1, "-sl" => 0,	1970	"-pty-fd" => -1, "-sl" => 0,
1628	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1971	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1629	"--transient-for" => $self->{term}->parent,	1972	"--transient-for" => $self->{term}->parent,
1630	"-display" => $self->{term}->display_id,	1973	"-display" => $self->{term}->display_id,
1631	"-pe" => "urxvt-popup")	1974	"-pe" => "urxvt-popup",
1632	or die "unable to create popup window\n";	1975	) or die "unable to create popup window\n";
		1976
		1977	unless (delete $term->{urxvt_popup_init_done}) {
		1978	$term->ungrab;
		1979	$term->destroy;
		1980	die "unable to initialise popup window\n";
		1981	}
1633	}	1982	}
1634		1983
1635	sub DESTROY {	1984	sub DESTROY {
1636	my ($self) = @_;	1985	my ($self) = @_;
1637		1986
1638	delete $self->{term}{_destroy}{$self};	1987	delete $self->{term}{_destroy}{$self};
1639	$self->{term}->ungrab;	1988	$self->{term}->ungrab;
1640	}	1989	}
1641		1990
1642	=back	1991	=back
		1992
		1993	=cut
		1994
		1995	package urxvt::watcher;
1643		1996
1644	=head2 The C<urxvt::timer> Class	1997	=head2 The C<urxvt::timer> Class
1645		1998
1646	This class implements timer watchers/events. Time is represented as a	1999	This class implements timer watchers/events. Time is represented as a
1647	fractional number of seconds since the epoch. Example:	2000	fractional number of seconds since the epoch. Example:
…		…
1651	->new	2004	->new
1652	->interval (1)	2005	->interval (1)
1653	->cb (sub {	2006	->cb (sub {
1654	$term->{overlay}->set (0, 0,	2007	$term->{overlay}->set (0, 0,
1655	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2008	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1656	});	2009	});
1657		2010
1658	=over 4	2011	=over 4
1659		2012
1660	=item $timer = new urxvt::timer	2013	=item $timer = new urxvt::timer
1661		2014
…		…
1664		2017
1665	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2018	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1666		2019
1667	Set the callback to be called when the timer triggers.	2020	Set the callback to be called when the timer triggers.
1668		2021
1669	=item $tstamp = $timer->at
1670
1671	Return the time this watcher will fire next.
1672
1673	=item $timer = $timer->set ($tstamp)	2022	=item $timer = $timer->set ($tstamp[, $interval])
1674		2023
1675	Set the time the event is generated to $tstamp.	2024	Set the time the event is generated to $tstamp (and optionally specifies a
		2025	new $interval).
1676		2026
1677	=item $timer = $timer->interval ($interval)	2027	=item $timer = $timer->interval ($interval)
1678		2028
1679	Normally (and when C<$interval> is C<0>), the timer will automatically	2029	By default (and when C<$interval> is C<0>), the timer will automatically
1680	stop after it has fired once. If C<$interval> is non-zero, then the timer	2030	stop after it has fired once. If C<$interval> is non-zero, then the timer
1681	is automatically rescheduled at the given intervals.	2031	is automatically rescheduled at the given intervals.
1682		2032
1683	=item $timer = $timer->start	2033	=item $timer = $timer->start
1684		2034
1685	Start the timer.	2035	Start the timer.
1686		2036
1687	=item $timer = $timer->start ($tstamp)	2037	=item $timer = $timer->start ($tstamp[, $interval])
1688		2038
1689	Set the event trigger time to C<$tstamp> and start the timer.	2039	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2040	also replaces the interval.
1690		2041
1691	=item $timer = $timer->after ($delay)	2042	=item $timer = $timer->after ($delay[, $interval])
1692		2043
1693	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1694		2045
1695	=item $timer = $timer->stop	2046	=item $timer = $timer->stop
1696		2047
…		…
1704		2055
1705	$term->{socket} = ...	2056	$term->{socket} = ...
1706	$term->{iow} = urxvt::iow	2057	$term->{iow} = urxvt::iow
1707	->new	2058	->new
1708	->fd (fileno $term->{socket})	2059	->fd (fileno $term->{socket})
1709	->events (urxvt::EVENT_READ)	2060	->events (urxvt::EV_READ)
1710	->start	2061	->start
1711	->cb (sub {	2062	->cb (sub {
1712	my ($iow, $revents) = @_;	2063	my ($iow, $revents) = @_;
1713	# $revents must be 1 here, no need to check	2064	# $revents must be 1 here, no need to check
1714	sysread $term->{socket}, my $buf, 8192	2065	sysread $term->{socket}, my $buf, 8192
…		…
1727	Set the callback to be called when io events are triggered. C<$reventmask>	2078	Set the callback to be called when io events are triggered. C<$reventmask>
1728	is a bitset as described in the C<events> method.	2079	is a bitset as described in the C<events> method.
1729		2080
1730	=item $iow = $iow->fd ($fd)	2081	=item $iow = $iow->fd ($fd)
1731		2082
1732	Set the filedescriptor (not handle) to watch.	2083	Set the file descriptor (not handle) to watch.
1733		2084
1734	=item $iow = $iow->events ($eventmask)	2085	=item $iow = $iow->events ($eventmask)
1735		2086
1736	Set the event mask to watch. The only allowed values are	2087	Set the event mask to watch. The only allowed values are
1737	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2088	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1738	together, or C<urxvt::EVENT_NONE>.	2089	together, or C<urxvt::EV_NONE>.
1739		2090
1740	=item $iow = $iow->start	2091	=item $iow = $iow->start
1741		2092
1742	Start watching for requested events on the given handle.	2093	Start watching for requested events on the given handle.
1743		2094
1744	=item $iow = $iow->stop	2095	=item $iow = $iow->stop
1745		2096
1746	Stop watching for events on the given filehandle.	2097	Stop watching for events on the given file handle.
		2098
		2099	=back
		2100
		2101	=head2 The C<urxvt::iw> Class
		2102
		2103	This class implements idle watchers, that get called automatically when
		2104	the process is idle. They should return as fast as possible, after doing
		2105	some useful work.
		2106
		2107	=over 4
		2108
		2109	=item $iw = new urxvt::iw
		2110
		2111	Create a new idle watcher object in stopped state.
		2112
		2113	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2114
		2115	Set the callback to be called when the watcher triggers.
		2116
		2117	=item $timer = $timer->start
		2118
		2119	Start the watcher.
		2120
		2121	=item $timer = $timer->stop
		2122
		2123	Stop the watcher.
		2124
		2125	=back
		2126
		2127	=head2 The C<urxvt::pw> Class
		2128
		2129	This class implements process watchers. They create an event whenever a
		2130	process exits, after which they stop automatically.
		2131
		2132	my $pid = fork;
		2133	...
		2134	$term->{pw} = urxvt::pw
		2135	->new
		2136	->start ($pid)
		2137	->cb (sub {
		2138	my ($pw, $exit_status) = @_;
		2139	...
		2140	});
		2141
		2142	=over 4
		2143
		2144	=item $pw = new urxvt::pw
		2145
		2146	Create a new process watcher in stopped state.
		2147
		2148	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2149
		2150	Set the callback to be called when the timer triggers.
		2151
		2152	=item $pw = $timer->start ($pid)
		2153
		2154	Tells the watcher to start watching for process C<$pid>.
		2155
		2156	=item $pw = $pw->stop
		2157
		2158	Stop the watcher.
1747		2159
1748	=back	2160	=back
1749		2161
1750	=head1 ENVIRONMENT	2162	=head1 ENVIRONMENT
1751		2163
…		…
1760		2172
1761	=item >= 3 - script loading and management	2173	=item >= 3 - script loading and management
1762		2174
1763	=item >=10 - all called hooks	2175	=item >=10 - all called hooks
1764		2176
1765	=item >=11 - hook reutrn values	2177	=item >=11 - hook return values
1766		2178
1767	=back	2179	=back
1768		2180
1769	=head1 AUTHOR	2181	=head1 AUTHOR
1770		2182
1771	Marc Lehmann <pcg@goof.com>	2183	Marc Lehmann <schmorp@schmorp.de>
1772	http://software.schmorp.de/pkg/rxvt-unicode	2184	http://software.schmorp.de/pkg/rxvt-unicode
1773		2185
1774	=cut	2186	=cut
1775		2187
1776	1	2188	1
		2189
		2190	# vim: sw=3:

Diff Legend

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