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

Diff Legend

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