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.127 by root, Wed Jan 25 00:42:21 2006 UTC vs.
Revision 1.246 by root, Fri Dec 26 18:58:19 2014 UTC

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

Diff Legend

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