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

Diff Legend

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