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

Diff Legend

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