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.130 by root, Wed Jan 25 15:32:48 2006 UTC vs.
Revision 1.230 by root, Sat Apr 26 20:51:12 2014 UTC

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

Diff Legend

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