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.132 by root, Mon Feb 6 05:40:15 2006 UTC vs.
Revision 1.229 by root, Sat Apr 26 18:53:51 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	The tabbar itself can be configured similarly to a normal terminal, but
211	with a resource class of C<URxvt.tabbed>. In addition, it supports the
212	following four resources (shown with defaults):
213
214	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
215	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
216	URxvt.tabbed.tab-fg: <colour-index, default 0>
217	URxvt.tabbed.tab-bg: <colour-index, default 1>
218
219	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
220	indices.
221
222	=item mark-urls
223
224	Uses per-line display filtering (C<on_line_update>) to underline urls and
225	make them clickable. When middle-clicked, the program specified in the
226	resource C<urlLauncher> (default C<x-www-browser>) will be started with
227	the URL as first argument.
228
229	=item xim-onthespot
230
231	This (experimental) perl extension implements OnTheSpot editing. It does
232	not work perfectly, and some input methods don't seem to work well with
233	OnTheSpot editing in general, but it seems to work at leats for SCIM and
234	kinput2.
235
236	You enable it by specifying this extension and a preedit style of
237	C<OnTheSpot>, i.e.:
238
239	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
240
241	=item automove-background
242
243	This is basically a one-line extension that dynamically changes the background pixmap offset
244	to the window position, in effect creating the same effect as pseudo transparency with
245	a custom pixmap. No scaling is supported in this mode. Exmaple:
246
247	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
248
249	=item block-graphics-to-ascii
250
251	A not very useful example of filtering all text output to the terminal,
252	by replacing all line-drawing characters (U+2500 .. U+259F) by a
253	similar-looking ascii character.
254
255	=item digital-clock
256
257	Displays a digital clock using the built-in overlay.
258
259	=item remote-clipboard
260
261	Somewhat of a misnomer, this extension adds two menu entries to the
262	selection popup that allows one ti run external commands to store the
263	selection somewhere and fetch it again.
264
265	We use it to implement a "distributed selection mechanism", which just
266	means that one command uploads the file to a remote server, and another
267	reads it.
268
269	The commands can be set using the C<URxvt.remote-selection.store> and
270	C<URxvt.remote-selection.fetch> resources. The first should read the
271	selection to store from STDIN (always in UTF-8), the second should provide
272	the selection data on STDOUT (also in UTF-8).
273
274	The defaults (which are likely useless to you) use rsh and cat:
275
276	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
277	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
278
279	=item selection-pastebin
280
281	This is a little rarely useful extension that Uploads the selection as
282	textfile to a remote site (or does other things). (The implementation is
283	not currently secure for use in a multiuser environment as it writes to
284	F</tmp> directly.).
285
286	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
287	i.e.
288
289	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
290
291	Pressing this combination runs a command with C<%> replaced by the name of
292	the textfile. This command can be set via a resource:
293
294	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
295
296	And the default is likely not useful to anybody but the few people around
297	here :)
298
299	The name of the textfile is the hex encoded md5 sum of the selection, so
300	the same content should lead to the same filename.
301
302	After a successful upload the selection will be replaced by the text given
303	in the C<selection-pastebin-url> resource (again, the % is the placeholder
304	for the filename):
305
306	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
307
308	=item example-refresh-hooks
309
310	Displays a very simple digital clock in the upper right corner of the
311	window. Illustrates overwriting the refresh callbacks to create your own
312	overlays or changes.
313
314	=back
315		50
316	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
317		52
318	=head2 General API Considerations	53	=head2 General API Considerations
319		54
…		…
333		68
334	=over 4	69	=over 4
335		70
336	=item $text	71	=item $text
337		72
338	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
339	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.
340		75
341	=item $string	76	=item $string
342		77
343	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
…		…
347	=item $octets	82	=item $octets
348		83
349	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
350	locale-specific way.	85	locale-specific way.
351		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
352	=back	93	=back
353		94
354	=head2 Extension Objects	95	=head2 Extension Objects
355		96
356	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
357	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,
358	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
359	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
360	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
361	use.	103	internal use.
362		104
363	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
364	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
365		107
366	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
367		109	the C<urxvt::extension> section below.
368	=over 4
369
370	=item $urxvt_term = $self->{term}
371
372	Returns the C<urxvt::term> object associated with this instance of the
373	extension. This member I<must not> be changed in any way.
374
375	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
376
377	Dynamically enable the given hooks (named without the C<on_> prefix) for
378	this extension, replacing any previous hook. This is useful when you want
379	to overwrite time-critical hooks only temporarily.
380
381	=item $self->disable ($hook_name[, $hook_name..])
382
383	Dynamically disable the given hooks.
384
385	=back
386		110
387	=head2 Hooks	111	=head2 Hooks
388		112
389	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
390	called whenever the relevant event happens.	114	called whenever the relevant event happens.
391		115
392	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
393	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
394		118
395	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
396	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
397	relevant action might not be carried out by the C++ code.	121	relevant action might not be carried out by the C++ code.
…		…
410	place.	134	place.
411		135
412	=item on_start $term	136	=item on_start $term
413		137
414	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
415	trying to map (display) the toplevel and returning to the mainloop.	139	trying to map (display) the toplevel and returning to the main loop.
416		140
417	=item on_destroy $term	141	=item on_destroy $term
418		142
419	Called whenever something tries to destroy terminal, when the terminal is	143	Called whenever something tries to destroy terminal, when the terminal is
420	still fully functional (not for long, though).	144	still fully functional (not for long, though).
…		…
447		171
448	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
449	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
450	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
451		175
452	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.
453		177
454	=item on_sel_extend $term	178	=item on_sel_extend $term
455		179
456	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
457	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
458	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
459	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
460	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
461	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
462		186
463	See the F<selection> example extension.	187	See the F<selection> example extension.
464		188
465	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
466		190
467	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
468	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
469	show this many lines of scrollback.	193	show this many lines of scrollback.
470		194
471	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
472		196
…		…
476		200
477	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,
478	$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
479	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
480		204
481	=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
482		216
483	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
484	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
485	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
486	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,
487	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
488	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	}
489		233
490	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,
491	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
492	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.
493		240
494	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
495		242
496	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
497	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
…		…
502	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
503		250
504	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
505	suppress or filter tty input.	252	suppress or filter tty input.
506		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
507	=item on_line_update $term, $row	261	=item on_line_update $term, $row
508		262
509	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
510	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
511	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,
…		…
518	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
519	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
520		274
521	=item on_refresh_begin $term	275	=item on_refresh_begin $term
522		276
523	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
524	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
525	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
526	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
527		281
528	=item on_refresh_end $term	282	=item on_refresh_end $term
529		283
530	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>.
531		285
532	=item on_user_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
533		287
534	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
535	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>
536	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
537		291
538	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
539	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.
540		307
541	=item on_x_event $term, $event	308	=item on_x_event $term, $event
542		309
543	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
544	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
545	members are not passed.	312	members are not passed.
546		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
547	=item on_focus_in $term	318	=item on_focus_in $term
548		319
549	Called whenever the window gets the keyboard focus, before rxvt-unicode	320	Called whenever the window gets the keyboard focus, before rxvt-unicode
550	does focus in processing.	321	does focus in processing.
551		322
552	=item on_focus_out $term	323	=item on_focus_out $term
553		324
554	Called wheneever the window loses keyboard focus, before rxvt-unicode does	325	Called whenever the window loses keyboard focus, before rxvt-unicode does
555	focus out processing.	326	focus out processing.
556		327
557	=item on_configure_notify $term, $event	328	=item on_configure_notify $term, $event
558		329
559	=item on_property_notify $term, $event	330	=item on_property_notify $term, $event
…		…
570		341
571	=item on_map_notify $term, $event	342	=item on_map_notify $term, $event
572		343
573	=item on_unmap_notify $term, $event	344	=item on_unmap_notify $term, $event
574		345
575	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
576	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.
577		348
578	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
579	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
580	(real, not screen-based) row and column under the mouse cursor.	351	(real, not screen-based) row and column under the mouse cursor.
581		352
…		…
591	=item on_wm_delete_window $term, $event	362	=item on_wm_delete_window $term, $event
592		363
593	Called when various types of ClientMessage events are received (all with	364	Called when various types of ClientMessage events are received (all with
594	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	365	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
595		366
		367	=item on_bell $term
		368
		369	Called on receipt of a bell character.
		370
596	=back	371	=back
597		372
598	=cut	373	=cut
599		374
600	package urxvt;	375	package urxvt;
601		376
602	use utf8;	377	use utf8;
603	use strict;	378	use strict 'vars';
604	use Carp ();	379	use Carp ();
605	use Scalar::Util ();	380	use Scalar::Util ();
606	use List::Util ();	381	use List::Util ();
607		382
608	our $VERSION = 1;	383	our $VERSION = 1;
609	our $TERM;	384	our $TERM;
610	our @TERM_INIT;	385	our @TERM_INIT; # should go, prevents async I/O etc.
611	our @TERM_EXT;	386	our @TERM_EXT; # should go, prevents async I/O etc.
612	our @HOOKNAME;	387	our @HOOKNAME;
613	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	388	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
614	our %OPTION;	389	our %OPTION;
615		390
616	our $LIBDIR;	391	our $LIBDIR;
…		…
642	The current terminal. This variable stores the current C<urxvt::term>	417	The current terminal. This variable stores the current C<urxvt::term>
643	object, whenever a callback/hook is executing.	418	object, whenever a callback/hook is executing.
644		419
645	=item @urxvt::TERM_INIT	420	=item @urxvt::TERM_INIT
646		421
647	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
648	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
649	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,
650	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.
651		426
652	This complements to the perl-eval commandline option, but gets executed	427	This complements to the perl-eval command line option, but gets executed
653	first.	428	first.
654		429
655	=item @urxvt::TERM_EXT	430	=item @urxvt::TERM_EXT
656		431
657	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
…		…
664		439
665	=over 4	440	=over 4
666		441
667	=item urxvt::fatal $errormessage	442	=item urxvt::fatal $errormessage
668		443
669	Fatally aborts execution with the given error message. Avoid at all	444	Fatally aborts execution with the given error message (which should
670	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
671	starts up.	446	is acceptable (and useful) is in the init hook, where it prevents the
		447	terminal from starting up.
672		448
673	=item urxvt::warn $string	449	=item urxvt::warn $string
674		450
675	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
676	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
677	that calls this function.	453	that calls this function.
678		454
679	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
680	correct place, e.g. on stderr of the connecting urxvtc client.	456	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
682	Messages have a size limit of 1023 bytes currently.	458	Messages have a size limit of 1023 bytes currently.
683		459
684	=item @terms = urxvt::termlist	460	=item @terms = urxvt::termlist
685		461
686	Returns all urxvt::term objects that exist in this process, regardless of	462	Returns all urxvt::term objects that exist in this process, regardless of
687	wether they are started, being destroyed etc., so be careful. Only term	463	whether they are started, being destroyed etc., so be careful. Only term
688	objects that have perl extensions attached will be returned (because there	464	objects that have perl extensions attached will be returned (because there
689	is no urxvt::term objet associated with others).	465	is no urxvt::term object associated with others).
690		466
691	=item $time = urxvt::NOW	467	=item $time = urxvt::NOW
692		468
693	Returns the "current time" (as per the event loop).	469	Returns the "current time" (as per the event loop).
694		470
…		…
737		513
738	=item $rend = urxvt::OVERLAY_RSTYLE	514	=item $rend = urxvt::OVERLAY_RSTYLE
739		515
740	Return the rendition mask used for overlays by default.	516	Return the rendition mask used for overlays by default.
741		517
742	=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
743		520
744	Return the bit that enabled bold, italic, blink, reverse-video and	521	Return the bit that enabled bold, italic, blink, reverse-video and
745	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
746	the bitset.	523	the bitset.
747		524
…		…
784	};	561	};
785	}	562	}
786		563
787	no warnings 'utf8';	564	no warnings 'utf8';
788		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
789	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	626	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
790		627
791	sub verbose {	628	sub verbose {
792	my ($level, $msg) = @_;	629	my ($level, $msg) = @_;
793	warn "$msg\n" if $level <= $verbosity;	630	warn "$msg\n" if $level <= $verbosity;
…		…
805	$pkg =~ s/[^[:word:]]/_/g;	642	$pkg =~ s/[^[:word:]]/_/g;
806	$pkg = "urxvt::ext::$pkg";	643	$pkg = "urxvt::ext::$pkg";
807		644
808	verbose 3, "loading extension '$path' into package '$pkg'";	645	verbose 3, "loading extension '$path' into package '$pkg'";
809		646
		647	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		648
810	open my $fh, "<:raw", $path	649	open my $fh, "<:raw", $path
811	or die "$path: $!";	650	or die "$path: $!";
812		651
813	my $source =	652	my $source =
814	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	653	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
815	. "#line 1 \"$path\"\n{\n"	654	. "#line 1 \"$path\"\n{\n"
816	. (do { local $/; <$fh> })	655	. (do { local $/; <$fh> })
817	. "\n};\n1";	656	. "\n};\n1";
818		657
819	eval $source	658	eval $source
…		…
829	sub invoke {	668	sub invoke {
830	local $TERM = shift;	669	local $TERM = shift;
831	my $htype = shift;	670	my $htype = shift;
832		671
833	if ($htype == 0) { # INIT	672	if ($htype == 0) { # INIT
834	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	673	my @dirs = $TERM->perl_libdirs;
835		674
836	my %ext_arg;	675	my %ext_arg;
837		676
838	{	677	{
839	my @init = @TERM_INIT;	678	my @init = @TERM_INIT;
840	@TERM_INIT = ();	679	@TERM_INIT = ();
…		…
842	my @pkg = @TERM_EXT;	681	my @pkg = @TERM_EXT;
843	@TERM_EXT = ();	682	@TERM_EXT = ();
844	$TERM->register_package ($_) for @pkg;	683	$TERM->register_package ($_) for @pkg;
845	}	684	}
846		685
		686	for (
		687	@{ delete $TERM->{perl_ext_3} },
847	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	688	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		689	) {
848	if ($_ eq "default") {	690	if ($_ eq "default") {
849	$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);
850	} elsif (/^-(.*)$/) {	692	} elsif (/^-(.*)$/) {
851	delete $ext_arg{$1};	693	delete $ext_arg{$1};
852	} elsif (/^([^<]+)<(.*)>$/) {	694	} elsif (/^([^<]+)<(.*)>$/) {
…		…
854	} else {	696	} else {
855	$ext_arg{$_} ||= [];	697	$ext_arg{$_} ||= [];
856	}	698	}
857	}	699	}
858		700
859	while (my ($ext, $argv) = each %ext_arg) {	701	for my $ext (sort keys %ext_arg) {
860	my @files = grep -f $_, map "$_/$ext", @dirs;	702	my @files = grep -f $_, map "$_/$ext", @dirs;
861		703
862	if (@files) {	704	if (@files) {
863	$TERM->register_package (extension_package $files[0], $argv);	705	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
864	} else {	706	} else {
865	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";
866	}	708	}
867	}	709	}
868		710
…		…
874		716
875	if (my $cb = $TERM->{_hook}[$htype]) {	717	if (my $cb = $TERM->{_hook}[$htype]) {
876	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	718	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
877	if $verbosity >= 10;	719	if $verbosity >= 10;
878		720
879	keys %$cb;	721	for my $pkg (keys %$cb) {
880
881	while (my ($pkg, $cb) = each %$cb) {
882	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	722	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
883	$retval ||= $retval_;	723	$retval ||= $retval_;
884		724
885	if ($@) {	725	if ($@) {
886	$TERM->ungrab; # better to lose the grab than the session	726	$TERM->ungrab; # better to lose the grab than the session
887	warn $@;	727	warn $@;
…		…
905		745
906	sub SET_COLOR($$$) {	746	sub SET_COLOR($$$) {
907	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	747	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
908	}	748	}
909		749
910	# urxvt::term::extension	750	sub rend2mask {
		751	no strict 'refs';
		752	my ($str, $mask) = (@_, 0);
		753	my %color = ( fg => undef, bg => undef );
		754	my @failed;
		755	for my $spec ( split /\s+/, $str ) {
		756	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		757	$color{lc($1)} = $2;
		758	} else {
		759	my $neg = $spec =~ s/^[-^]//;
		760	unless ( exists &{"RS_$spec"} ) {
		761	push @failed, $spec;
		762	next;
		763	}
		764	my $cur = &{"RS_$spec"};
		765	if ( $neg ) {
		766	$mask &= ~$cur;
		767	} else {
		768	$mask |= $cur;
		769	}
		770	}
		771	}
		772	($mask, @color{qw(fg bg)}, \@failed)
		773	}
911		774
912	package urxvt::term::extension;	775	package urxvt::term::extension;
913		776
914	sub enable {	777	=head2 The C<urxvt::term::extension> class
915	my ($self, %hook) = @_;
916	my $pkg = $self->{_pkg};
917		778
918	while (my ($name, $cb) = each %hook) {	779	Each extension attached to a terminal object is represented by
919	my $htype = $HOOKTYPE{uc $name};	780	a C<urxvt::term::extension> object.
920	defined $htype
921	or Carp::croak "unsupported hook type '$name'";
922		781
923	$self->set_should_invoke ($htype, +1)	782	You can use these objects, which are passed to all callbacks to store any
924	unless exists $self->{term}{_hook}[$htype]{$pkg};	783	state related to the terminal and extension instance.
925		784
926	$self->{term}{_hook}[$htype]{$pkg} = $cb;	785	The methods (And data members) documented below can be called on extension
927	}	786	objects, in addition to call methods documented for the <urxvt::term>
928	}	787	class.
929		788
930	sub disable {	789	=over 4
931	my ($self, @hook) = @_;
932	my $pkg = $self->{_pkg};
933		790
934	for my $name (@hook) {	791	=item $urxvt_term = $self->{term}
935	my $htype = $HOOKTYPE{uc $name};
936	defined $htype
937	or Carp::croak "unsupported hook type '$name'";
938		792
939	$self->set_should_invoke ($htype, -1)	793	Returns the C<urxvt::term> object associated with this instance of the
940	if delete $self->{term}{_hook}[$htype]{$pkg};	794	extension. This member I<must not> be changed in any way.
941	}	795
942	}	796	=cut
943		797
944	our $AUTOLOAD;	798	our $AUTOLOAD;
945		799
946	sub AUTOLOAD {	800	sub AUTOLOAD {
947	$AUTOLOAD =~ /:([^:]+)$/	801	$AUTOLOAD =~ /:([^:]+)$/
…		…
960		814
961	sub DESTROY {	815	sub DESTROY {
962	# nop	816	# nop
963	}	817	}
964		818
965	# urxvt::destroy_hook	819	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
966		820
967	sub urxvt::destroy_hook::DESTROY {	821	sub urxvt::destroy_hook::DESTROY {
968	${$_[0]}->();	822	${$_[0]}->();
969	}	823	}
970		824
971	sub urxvt::destroy_hook(&) {	825	sub urxvt::destroy_hook(&) {
972	bless \shift, urxvt::destroy_hook::	826	bless \shift, urxvt::destroy_hook::
973	}	827	}
		828
		829	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		830
		831	Dynamically enable the given hooks (named without the C<on_> prefix) for
		832	this extension, replacing any hook previously installed via C<enable> in
		833	this extension.
		834
		835	This is useful when you want to overwrite time-critical hooks only
		836	temporarily.
		837
		838	To install additional callbacks for the same hook, you can use the C<on>
		839	method of the C<urxvt::term> class.
		840
		841	=item $self->disable ($hook_name[, $hook_name..])
		842
		843	Dynamically disable the given hooks.
		844
		845	=cut
		846
		847	sub enable {
		848	my ($self, %hook) = @_;
		849	my $pkg = $self->{_pkg};
		850
		851	while (my ($name, $cb) = each %hook) {
		852	my $htype = $HOOKTYPE{uc $name};
		853	defined $htype
		854	or Carp::croak "unsupported hook type '$name'";
		855
		856	$self->set_should_invoke ($htype, +1)
		857	unless exists $self->{term}{_hook}[$htype]{$pkg};
		858
		859	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		860	}
		861	}
		862
		863	sub disable {
		864	my ($self, @hook) = @_;
		865	my $pkg = $self->{_pkg};
		866
		867	for my $name (@hook) {
		868	my $htype = $HOOKTYPE{uc $name};
		869	defined $htype
		870	or Carp::croak "unsupported hook type '$name'";
		871
		872	$self->set_should_invoke ($htype, -1)
		873	if delete $self->{term}{_hook}[$htype]{$pkg};
		874	}
		875	}
		876
		877	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		878
		879	Similar to the C<enable> enable, but installs additional callbacks for
		880	the given hook(s) (that is, it doesn't replace existing callbacks), and
		881	returns a guard object. When the guard object is destroyed the callbacks
		882	are disabled again.
		883
		884	=cut
		885
		886	sub urxvt::extension::on_disable::DESTROY {
		887	my $disable = shift;
		888
		889	my $term = delete $disable->{""};
		890
		891	while (my ($htype, $id) = each %$disable) {
		892	delete $term->{_hook}[$htype]{$id};
		893	$term->set_should_invoke ($htype, -1);
		894	}
		895	}
		896
		897	sub on {
		898	my ($self, %hook) = @_;
		899
		900	my $term = $self->{term};
		901
		902	my %disable = ( "" => $term );
		903
		904	while (my ($name, $cb) = each %hook) {
		905	my $htype = $HOOKTYPE{uc $name};
		906	defined $htype
		907	or Carp::croak "unsupported hook type '$name'";
		908
		909	$term->set_should_invoke ($htype, +1);
		910	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		911	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		912	}
		913
		914	bless \%disable, "urxvt::extension::on_disable"
		915	}
		916
		917	=item $self->x_resource ($pattern)
		918
		919	=item $self->x_resource_boolean ($pattern)
		920
		921	These methods support an additional C<%> prefix when called on an
		922	extension object - see the description of these methods in the
		923	C<urxvt::term> class for details.
		924
		925	=cut
		926
		927	sub x_resource {
		928	my ($self, $name) = @_;
		929	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		930	$self->{term}->x_resource ($name)
		931	}
		932
		933	sub x_resource_boolean {
		934	my ($self, $name) = @_;
		935	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		936	$self->{term}->x_resource_boolean ($name)
		937	}
		938
		939	=back
		940
		941	=cut
974		942
975	package urxvt::anyevent;	943	package urxvt::anyevent;
976		944
977	=head2 The C<urxvt::anyevent> Class	945	=head2 The C<urxvt::anyevent> Class
978		946
979	The sole purpose of this class is to deliver an interface to the	947	The sole purpose of this class is to deliver an interface to the
980	C<AnyEvent> module - any module using it will work inside urxvt without	948	C<AnyEvent> module - any module using it will work inside urxvt without
981	further programming. The only exception is that you cannot wait on	949	further programming. The only exception is that you cannot wait on
982	condition variables, but non-blocking condvar use is ok. What this means	950	condition variables, but non-blocking condvar use is ok.
983	is that you cannot use blocking APIs, but the non-blocking variant should
984	work.
985		951
986	=cut	952	In practical terms this means is that you cannot use blocking APIs, but
		953	the non-blocking variant should work.
987		954
		955	=cut
		956
988	our $VERSION = 1;	957	our $VERSION = '5.23';
989		958
990	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	959	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
991	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	960	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
992		961
993	sub timer {	962	sub timer {
…		…
995		964
996	my $cb = $arg{cb};	965	my $cb = $arg{cb};
997		966
998	urxvt::timer	967	urxvt::timer
999	->new	968	->new
1000	->start (urxvt::NOW + $arg{after})	969	->after ($arg{after}, $arg{interval})
1001	->cb (sub {	970	->cb ($arg{interval} ? $cb : sub {
1002	$_[0]->stop; # need to cancel manually	971	$_[0]->stop; # need to cancel manually
1003	$cb->();	972	$cb->();
1004	})	973	})
1005	}	974	}
1006		975
1007	sub io {	976	sub io {
1008	my ($class, %arg) = @_;	977	my ($class, %arg) = @_;
1009		978
1010	my $cb = $arg{cb};	979	my $cb = $arg{cb};
		980	my $fd = fileno $arg{fh};
		981	defined $fd or $fd = $arg{fh};
1011		982
1012	bless [$arg{fh}, urxvt::iow	983	bless [$arg{fh}, urxvt::iow
1013	->new	984	->new
1014	->fd (fileno $arg{fh})	985	->fd ($fd)
1015	->events (($arg{poll} =~ /r/ ? 1 : 0)	986	->events (($arg{poll} =~ /r/ ? 1 : 0)
1016	| ($arg{poll} =~ /w/ ? 2 : 0))	987	| ($arg{poll} =~ /w/ ? 2 : 0))
1017	->start	988	->start
1018	->cb (sub {	989	->cb ($cb)
1019	$cb->(($_[1] & 1 ? 'r' : '')
1020	. ($_[1] & 2 ? 'w' : ''));
1021	})],
1022	urxvt::anyevent::	990	], urxvt::anyevent::
		991	}
		992
		993	sub idle {
		994	my ($class, %arg) = @_;
		995
		996	my $cb = $arg{cb};
		997
		998	urxvt::iw
		999	->new
		1000	->start
		1001	->cb ($cb)
		1002	}
		1003
		1004	sub child {
		1005	my ($class, %arg) = @_;
		1006
		1007	my $cb = $arg{cb};
		1008
		1009	urxvt::pw
		1010	->new
		1011	->start ($arg{pid})
		1012	->cb (sub {
		1013	$_[0]->stop; # need to cancel manually
		1014	$cb->($_[0]->rpid, $_[0]->rstatus);
		1015	})
1023	}	1016	}
1024		1017
1025	sub DESTROY {	1018	sub DESTROY {
1026	$_[0][1]->stop;	1019	$_[0][1]->stop;
1027	}	1020	}
1028		1021
1029	sub condvar {	1022	# only needed for AnyEvent < 6 compatibility
1030	bless \my $flag, urxvt::anyevent::condvar::	1023	sub one_event {
1031	}
1032
1033	sub urxvt::anyevent::condvar::broadcast {
1034	${$_[0]}++;
1035	}
1036
1037	sub urxvt::anyevent::condvar::wait {
1038	unless (${$_[0]}) {
1039	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1024	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1040	}
1041	}	1025	}
1042		1026
1043	package urxvt::term;	1027	package urxvt::term;
1044		1028
1045	=head2 The C<urxvt::term> Class	1029	=head2 The C<urxvt::term> Class
…		…
1058	urxvt::verbose 6, "register package $pkg to $self";	1042	urxvt::verbose 6, "register package $pkg to $self";
1059		1043
1060	@{"$pkg\::ISA"} = urxvt::term::extension::;	1044	@{"$pkg\::ISA"} = urxvt::term::extension::;
1061		1045
1062	my $proxy = bless {	1046	my $proxy = bless {
1063	_pkg => $pkg,	1047	_pkg => $pkg,
		1048	_name => ${"$pkg\::_NAME"}, # hackish
1064	argv => $argv,	1049	argv => $argv,
1065	}, $pkg;	1050	}, $pkg;
1066	Scalar::Util::weaken ($proxy->{term} = $self);	1051	Scalar::Util::weaken ($proxy->{term} = $self);
1067		1052
1068	$self->{_pkg}{$pkg} = $proxy;	1053	$self->{_pkg}{$pkg} = $proxy;
1069		1054
…		…
1072	$proxy->enable ($name => $ref);	1057	$proxy->enable ($name => $ref);
1073	}	1058	}
1074	}	1059	}
1075	}	1060	}
1076		1061
		1062	sub perl_libdirs {
		1063	map { split /:/ }
		1064	$_[0]->resource ("perl_lib"),
		1065	$ENV{URXVT_PERL_LIB},
		1066	"$ENV{HOME}/.urxvt/ext",
		1067	"$LIBDIR/perl"
		1068	}
		1069
		1070	sub scan_meta {
		1071	my ($self) = @_;
		1072	my @libdirs = perl_libdirs $self;
		1073
		1074	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1075
		1076	my %meta;
		1077
		1078	$self->{meta_libdirs} = join "\x00", @libdirs;
		1079	$self->{meta} = \%meta;
		1080
		1081	for my $dir (reverse @libdirs) {
		1082	opendir my $fh, $dir
		1083	or next;
		1084	for my $ext (readdir $fh) {
		1085	$ext !~ /^\./
		1086	and open my $fh, "<", "$dir/$ext"
		1087	or next;
		1088
		1089	while (<$fh>) {
		1090	if (/^#:META:X_RESOURCE:(.*)/) {
		1091	my ($pattern, $type, $desc) = split /:/, $1;
		1092	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1093	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1094	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1095	} else {
		1096	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1097	}
		1098	} elsif (/^\s*(?:#|$)/) {
		1099	# skip other comments and empty lines
		1100	} else {
		1101	last; # stop parsing on first non-empty non-comment line
		1102	}
		1103	}
		1104	}
		1105	}
		1106	}
		1107
1077	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1108	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1078		1109
1079	Creates a new terminal, very similar as if you had started it with system	1110	Creates a new terminal, very similar as if you had started it with system
1080	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1111	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1081	hash which defines the environment of the new terminal.	1112	hash which defines the environment of the new terminal.
…		…
1098	}	1129	}
1099		1130
1100	=item $term->destroy	1131	=item $term->destroy
1101		1132
1102	Destroy the terminal object (close the window, free resources	1133	Destroy the terminal object (close the window, free resources
1103	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1134	etc.). Please note that urxvt will not exit as long as any event
1104	watchers (timers, io watchers) are still active.	1135	watchers (timers, io watchers) are still active.
1105		1136
1106	=item $term->exec_async ($cmd[, @args])	1137	=item $term->exec_async ($cmd[, @args])
1107		1138
1108	Works like the combination of the C<fork>/C<exec> builtins, which executes	1139	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1132		1163
1133	Returns true if the option specified by C<$optval> is enabled, and	1164	Returns true if the option specified by C<$optval> is enabled, and
1134	optionally change it. All option values are stored by name in the hash	1165	optionally change it. All option values are stored by name in the hash
1135	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1166	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1136		1167
1137	Here is a a likely non-exhaustive list of option names, please see the	1168	Here is a likely non-exhaustive list of option names, please see the
1138	source file F</src/optinc.h> to see the actual list:	1169	source file F</src/optinc.h> to see the actual list:
1139		1170
1140	borderLess console cursorBlink cursorUnderline hold iconic insecure	1171	borderLess buffered console cursorBlink cursorUnderline hold iconic
1141	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1172	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1142	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1173	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1143	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1174	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1144	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1175	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1145	transparent tripleclickwords utmpInhibit visualBell	1176	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1177	urgentOnBell utmpInhibit visualBell
1146		1178
1147	=item $value = $term->resource ($name[, $newval])	1179	=item $value = $term->resource ($name[, $newval])
1148		1180
1149	Returns the current resource value associated with a given name and	1181	Returns the current resource value associated with a given name and
1150	optionally sets a new value. Setting values is most useful in the C<init>	1182	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1159	likely change).	1191	likely change).
1160		1192
1161	Please note that resource strings will currently only be freed when the	1193	Please note that resource strings will currently only be freed when the
1162	terminal is destroyed, so changing options frequently will eat memory.	1194	terminal is destroyed, so changing options frequently will eat memory.
1163		1195
1164	Here is a a likely non-exhaustive list of resource names, not all of which	1196	Here is a likely non-exhaustive list of resource names, not all of which
1165	are supported in every build, please see the source file F</src/rsinc.h>	1197	are supported in every build, please see the source file F</src/rsinc.h>
1166	to see the actual list:	1198	to see the actual list:
1167		1199
1168	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1200	answerbackstring backgroundPixmap backspace_key blurradius
1169	borderLess color cursorBlink cursorUnderline cutchars delete_key	1201	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1170	display_name embed ext_bwidth fade font geometry hold iconName	1202	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1171	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1203	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1204	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1172	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1205	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1173	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1206	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1174	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1207	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1175	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1208	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1176	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1209	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1177	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1210	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1178	secondaryScreen secondaryScroll selectstyle shade term_name title	1211	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1179	transient_for transparent transparent_all tripleclickwords utmpInhibit	1212	term_name title transient_for transparent tripleclickwords urgentOnBell
1180	visualBell	1213	utmpInhibit visualBell
1181		1214
1182	=cut	1215	=cut
1183		1216
1184	sub resource($$;$) {	1217	sub resource($$;$) {
1185	my ($self, $name) = (shift, shift);	1218	my ($self, $name) = (shift, shift);
1186	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1219	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1187	&urxvt::term::_resource	1220	goto &urxvt::term::_resource
1188	}	1221	}
1189		1222
1190	=item $value = $term->x_resource ($pattern)	1223	=item $value = $term->x_resource ($pattern)
1191		1224
1192	Returns the X-Resource for the given pattern, excluding the program or	1225	Returns the X-Resource for the given pattern, excluding the program or
1193	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1226	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1194	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1227	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1195	resource with that pattern exists.	1228	resource with that pattern exists.
1196		1229
		1230	Extensions that define extra resource or command line arguments also need
		1231	to call this method to access their values.
		1232
		1233	If the method is called on an extension object (basically, from an
		1234	extension), then the special prefix C<%.> will be replaced by the name of
		1235	the extension and a dot, and the lone string C<%> will be replaced by the
		1236	extension name itself. This makes it possible to code extensions so you
		1237	can rename them and get a new set of commandline switches and resources
		1238	without having to change the actual code.
		1239
1197	This method should only be called during the C<on_start> hook, as there is	1240	This method should only be called during the C<on_start> hook, as there is
1198	only one resource database per display, and later invocations might return	1241	only one resource database per display, and later invocations might return
1199	the wrong resources.	1242	the wrong resources.
1200		1243
1201	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1244	=item $value = $term->x_resource_boolean ($pattern)
1202		1245
		1246	Like C<x_resource>, above, but interprets the string value as a boolean
		1247	and returns C<1> for true values, C<0> for false values and C<undef> if
		1248	the resource or option isn't specified.
		1249
		1250	You should always use this method to parse boolean resources.
		1251
		1252	=cut
		1253
		1254	sub x_resource_boolean {
		1255	my $res = &x_resource;
		1256
		1257	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1258	}
		1259
		1260	=item $success = $term->parse_keysym ($key, $octets)
		1261
1203	Adds a keymap translation exactly as specified via a resource. See the	1262	Adds a key binding exactly as specified via a resource. See the
1204	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1263	C<keysym> resource in the urxvt(1) manpage.
		1264
		1265	=item $term->register_command ($keysym, $modifiermask, $string)
		1266
		1267	Adds a key binding. This is a lower level api compared to
		1268	C<parse_keysym>, as it expects a parsed key description, and can be
		1269	used only inside either the C<on_init> hook, to add a binding, or the
		1270	C<on_register_command> hook, to modify a parsed binding.
1205		1271
1206	=item $rend = $term->rstyle ([$new_rstyle])	1272	=item $rend = $term->rstyle ([$new_rstyle])
1207		1273
1208	Return and optionally change the current rendition. Text that is output by	1274	Return and optionally change the current rendition. Text that is output by
1209	the terminal application will use this style.	1275	the terminal application will use this style.
…		…
1217		1283
1218	=item ($row, $col) = $term->selection_beg ([$row, $col])	1284	=item ($row, $col) = $term->selection_beg ([$row, $col])
1219		1285
1220	=item ($row, $col) = $term->selection_end ([$row, $col])	1286	=item ($row, $col) = $term->selection_end ([$row, $col])
1221		1287
1222	Return the current values of the selection mark, begin or end positions,	1288	Return the current values of the selection mark, begin or end positions.
1223	and optionally set them to new values.	1289
		1290	When arguments are given, then the selection coordinates are set to
		1291	C<$row> and C<$col>, and the selection screen is set to the current
		1292	screen.
		1293
		1294	=item $screen = $term->selection_screen ([$screen])
		1295
		1296	Returns the current selection screen, and then optionally sets it.
1224		1297
1225	=item $term->selection_make ($eventtime[, $rectangular])	1298	=item $term->selection_make ($eventtime[, $rectangular])
1226		1299
1227	Tries to make a selection as set by C<selection_beg> and	1300	Tries to make a selection as set by C<selection_beg> and
1228	C<selection_end>. If C<$rectangular> is true (default: false), a	1301	C<selection_end>. If C<$rectangular> is true (default: false), a
1229	rectangular selection will be made. This is the prefered function to make	1302	rectangular selection will be made. This is the preferred function to make
1230	a selection.	1303	a selection.
1231		1304
1232	=item $success = $term->selection_grab ($eventtime)	1305	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1233		1306
1234	Try to request the primary selection text from the server (for example, as	1307	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1308	true) selection from the server. The corresponding text can be set
1235	set by the next method). No visual feedback will be given. This function	1309	with the next method. No visual feedback will be given. This function
1236	is mostly useful from within C<on_sel_grab> hooks.	1310	is mostly useful from within C<on_sel_grab> hooks.
1237		1311
1238	=item $oldtext = $term->selection ([$newtext])	1312	=item $oldtext = $term->selection ([$newtext, $clipboard])
1239		1313
1240	Return the current selection text and optionally replace it by C<$newtext>.	1314	Return the current selection (clipboard if C<$clipboard> is true) text
		1315	and optionally replace it by C<$newtext>.
		1316
		1317	=item $term->selection_clear ([$clipboard])
		1318
		1319	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1241		1320
1242	=item $term->overlay_simple ($x, $y, $text)	1321	=item $term->overlay_simple ($x, $y, $text)
1243		1322
1244	Create a simple multi-line overlay box. See the next method for details.	1323	Create a simple multi-line overlay box. See the next method for details.
1245		1324
…		…
1275		1354
1276	The methods currently supported on C<urxvt::overlay> objects are:	1355	The methods currently supported on C<urxvt::overlay> objects are:
1277		1356
1278	=over 4	1357	=over 4
1279		1358
1280	=item $overlay->set ($x, $y, $text, $rend)	1359	=item $overlay->set ($x, $y, $text[, $rend])
1281		1360
1282	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1361	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1283	text in rxvt-unicode's special encoding and an array of rendition values	1362	text in rxvt-unicode's special encoding and an array of rendition values
1284	at a specific position inside the overlay.	1363	at a specific position inside the overlay.
		1364
		1365	If C<$rend> is missing, then the rendition will not be changed.
1285		1366
1286	=item $overlay->hide	1367	=item $overlay->hide
1287		1368
1288	If visible, hide the overlay, but do not destroy it.	1369	If visible, hide the overlay, but do not destroy it.
1289		1370
…		…
1371	locale-specific encoding of the terminal and can contain command sequences	1452	locale-specific encoding of the terminal and can contain command sequences
1372	(escape codes) that will be interpreted.	1453	(escape codes) that will be interpreted.
1373		1454
1374	=item $term->tt_write ($octets)	1455	=item $term->tt_write ($octets)
1375		1456
1376	Write the octets given in C<$data> to the tty (i.e. as program input). To	1457	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1377	pass characters instead of octets, you should convert your strings first	1458	pass characters instead of octets, you should convert your strings first
1378	to the locale-specific encoding using C<< $term->locale_encode >>.	1459	to the locale-specific encoding using C<< $term->locale_encode >>.
		1460
		1461	=item $term->tt_paste ($octets)
		1462
		1463	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1464	CR and bracketing the data with control sequences if bracketed paste mode
		1465	is set.
1379		1466
1380	=item $old_events = $term->pty_ev_events ([$new_events])	1467	=item $old_events = $term->pty_ev_events ([$new_events])
1381		1468
1382	Replaces the event mask of the pty watcher by the given event mask. Can	1469	Replaces the event mask of the pty watcher by the given event mask. Can
1383	be used to suppress input and output handling to the pty/tty. See the	1470	be used to suppress input and output handling to the pty/tty. See the
…		…
1402	Adds the specified events to the vt event mask. Useful e.g. when you want	1489	Adds the specified events to the vt event mask. Useful e.g. when you want
1403	to receive pointer events all the times:	1490	to receive pointer events all the times:
1404		1491
1405	$term->vt_emask_add (urxvt::PointerMotionMask);	1492	$term->vt_emask_add (urxvt::PointerMotionMask);
1406		1493
		1494	=item $term->set_urgency ($set)
		1495
		1496	Enable/disable the urgency hint on the toplevel window.
		1497
1407	=item $term->focus_in	1498	=item $term->focus_in
1408		1499
1409	=item $term->focus_out	1500	=item $term->focus_out
1410		1501
1411	=item $term->key_press ($state, $keycode[, $time])	1502	=item $term->key_press ($state, $keycode[, $time])
…		…
1451	=item $env = $term->env	1542	=item $env = $term->env
1452		1543
1453	Returns a copy of the environment in effect for the terminal as a hashref	1544	Returns a copy of the environment in effect for the terminal as a hashref
1454	similar to C<\%ENV>.	1545	similar to C<\%ENV>.
1455		1546
		1547	=item @envv = $term->envv
		1548
		1549	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1550
		1551	=item @argv = $term->argv
		1552
		1553	Return the argument vector as this terminal, similar to @ARGV, but
		1554	includes the program name as first element.
		1555
1456	=cut	1556	=cut
1457		1557
1458	sub env {	1558	sub env {
1459	if (my $env = $_[0]->_env) {
1460	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1559	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1461	} else {
1462	+{ %ENV }
1463	}
1464	}	1560	}
1465		1561
1466	=item $modifiermask = $term->ModLevel3Mask	1562	=item $modifiermask = $term->ModLevel3Mask
1467		1563
1468	=item $modifiermask = $term->ModMetaMask	1564	=item $modifiermask = $term->ModMetaMask
…		…
1476		1572
1477	Returns the currently displayed screen (0 primary, 1 secondary).	1573	Returns the currently displayed screen (0 primary, 1 secondary).
1478		1574
1479	=item $cursor_is_hidden = $term->hidden_cursor	1575	=item $cursor_is_hidden = $term->hidden_cursor
1480		1576
1481	Returns wether the cursor is currently hidden or not.	1577	Returns whether the cursor is currently hidden or not.
1482		1578
1483	=item $view_start = $term->view_start ([$newvalue])	1579	=item $view_start = $term->view_start ([$newvalue])
1484		1580
1485	Returns the row number of the topmost displayed line. Maximum value is	1581	Returns the row number of the topmost displayed line. Maximum value is
1486	C<0>, which displays the normal terminal contents. Lower values scroll	1582	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1494		1590
1495	Used after changing terminal contents to display them.	1591	Used after changing terminal contents to display them.
1496		1592
1497	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1593	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1498		1594
1499	Returns the text of the entire row with number C<$row_number>. Row C<0>	1595	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1500	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1596	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1501	terminal line. The scrollback buffer starts at line C<-1> and extends to
1502	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1597	terminal line. Nothing will be returned if a nonexistent line
1503	is requested.	1598	is requested.
1504		1599
1505	If C<$new_text> is specified, it will replace characters in the current	1600	If C<$new_text> is specified, it will replace characters in the current
1506	line, starting at column C<$start_col> (default C<0>), which is useful	1601	line, starting at column C<$start_col> (default C<0>), which is useful
1507	to replace only parts of a line. The font index in the rendition will	1602	to replace only parts of a line. The font index in the rendition will
1508	automatically be updated.	1603	automatically be updated.
1509		1604
1510	C<$text> is in a special encoding: tabs and wide characters that use more	1605	C<$text> is in a special encoding: tabs and wide characters that use more
1511	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1606	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1512	characters. Characters with combining characters and other characters that	1607	characters. Characters with combining characters and other characters that
1513	do not fit into the normal tetx encoding will be replaced with characters	1608	do not fit into the normal text encoding will be replaced with characters
1514	in the private use area.	1609	in the private use area.
1515		1610
1516	You have to obey this encoding when changing text. The advantage is	1611	You have to obey this encoding when changing text. The advantage is
1517	that C<substr> and similar functions work on screen cells and not on	1612	that C<substr> and similar functions work on screen cells and not on
1518	characters.	1613	characters.
…		…
1603	}	1698	}
1604		1699
1605	sub urxvt::line::t {	1700	sub urxvt::line::t {
1606	my ($self) = @_;	1701	my ($self) = @_;
1607		1702
1608	if (@_ > 1)	1703	if (@_ > 1) {
1609	{
1610	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1704	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1611	for $self->{beg} .. $self->{end};	1705	for $self->{beg} .. $self->{end};
1612	}	1706	}
1613		1707
1614	defined wantarray &&	1708	defined wantarray &&
1615	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1616	0, $self->{len}	1710	0, $self->{len}
1617	}	1711	}
1618		1712
1619	sub urxvt::line::r {	1713	sub urxvt::line::r {
1620	my ($self) = @_;	1714	my ($self) = @_;
1621		1715
1622	if (@_ > 1)	1716	if (@_ > 1) {
1623	{
1624	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1717	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1625	for $self->{beg} .. $self->{end};	1718	for $self->{beg} .. $self->{end};
1626	}	1719	}
1627		1720
1628	if (defined wantarray) {	1721	if (defined wantarray) {
1629	my $rend = [	1722	my $rend = [
1630	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1723	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1631	];	1724	];
…		…
1663	where one character corresponds to one screen cell. See	1756	where one character corresponds to one screen cell. See
1664	C<< $term->ROW_t >> for details.	1757	C<< $term->ROW_t >> for details.
1665		1758
1666	=item $string = $term->special_decode $text	1759	=item $string = $term->special_decode $text
1667		1760
1668	Converts rxvt-unicodes text reprsentation into a perl string. See	1761	Converts rxvt-unicodes text representation into a perl string. See
1669	C<< $term->ROW_t >> for details.	1762	C<< $term->ROW_t >> for details.
1670		1763
1671	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1764	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1672		1765
1673	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1766	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1676	manpage.	1769	manpage.
1677		1770
1678	=item $success = $term->grab ($eventtime[, $sync])	1771	=item $success = $term->grab ($eventtime[, $sync])
1679		1772
1680	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1773	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1681	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1774	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1682		1775
1683	=item $term->allow_events_async	1776	=item $term->allow_events_async
1684		1777
1685	Calls XAllowEvents with AsyncBoth for the most recent grab.	1778	Calls XAllowEvents with AsyncBoth for the most recent grab.
1686		1779
…		…
1693	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1786	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1694	recent grab.	1787	recent grab.
1695		1788
1696	=item $term->ungrab	1789	=item $term->ungrab
1697		1790
1698	Calls XUngrab for the most recent grab. Is called automatically on	1791	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1699	evaluation errors, as it is better to lose the grab in the error case as	1792	evaluation errors, as it is better to lose the grab in the error case as
1700	the session.	1793	the session.
1701		1794
1702	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1795	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1703		1796
…		…
1705		1798
1706	=item @atoms = $term->XListProperties ($window)	1799	=item @atoms = $term->XListProperties ($window)
1707		1800
1708	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1801	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1709		1802
1710	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1803	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1711		1804
1712	=item $term->XDeleteProperty ($window, $property)	1805	=item $term->XDeleteProperty ($window, $property)
1713		1806
1714	=item $window = $term->DefaultRootWindow	1807	=item $window = $term->DefaultRootWindow
1715		1808
…		…
1722	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1815	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1723		1816
1724	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1817	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1725		1818
1726	=item $term->XChangeInput ($window, $add_events[, $del_events])	1819	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1820
		1821	=item $keysym = $term->XStringToKeysym ($string)
		1822
		1823	=item $string = $term->XKeysymToString ($keysym)
1727		1824
1728	Various X or X-related functions. The C<$term> object only serves as	1825	Various X or X-related functions. The C<$term> object only serves as
1729	the source of the display, otherwise those functions map more-or-less	1826	the source of the display, otherwise those functions map more-or-less
1730	directory onto the X functions of the same name.	1827	directly onto the X functions of the same name.
1731		1828
1732	=back	1829	=back
1733		1830
1734	=cut	1831	=cut
1735		1832
…		…
1799	my ($self, $text, $cb) = @_;	1896	my ($self, $text, $cb) = @_;
1800		1897
1801	$self->add_item ({ type => "button", text => $text, activate => $cb});	1898	$self->add_item ({ type => "button", text => $text, activate => $cb});
1802	}	1899	}
1803		1900
1804	=item $popup->add_toggle ($text, $cb, $initial_value)	1901	=item $popup->add_toggle ($text, $initial_value, $cb)
1805		1902
1806	Adds a toggle/checkbox item to the popup. Teh callback gets called	1903	Adds a toggle/checkbox item to the popup. The callback gets called
1807	whenever it gets toggled, with a boolean indicating its value as its first	1904	whenever it gets toggled, with a boolean indicating its new value as its
1808	argument.	1905	first argument.
1809		1906
1810	=cut	1907	=cut
1811		1908
1812	sub add_toggle {	1909	sub add_toggle {
1813	my ($self, $text, $cb, $value) = @_;	1910	my ($self, $text, $value, $cb) = @_;
1814		1911
1815	my $item; $item = {	1912	my $item; $item = {
1816	type => "button",	1913	type => "button",
1817	text => " $text",	1914	text => " $text",
1818	value => $value,	1915	value => $value,
…		…
1837	my $env = $self->{term}->env;	1934	my $env = $self->{term}->env;
1838	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1935	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1839	delete $env->{LC_ALL};	1936	delete $env->{LC_ALL};
1840	$env->{LC_CTYPE} = $self->{term}->locale;	1937	$env->{LC_CTYPE} = $self->{term}->locale;
1841		1938
1842	urxvt::term->new ($env, "popup",	1939	my $term = urxvt::term->new (
		1940	$env, "popup",
1843	"--perl-lib" => "", "--perl-ext-common" => "",	1941	"--perl-lib" => "", "--perl-ext-common" => "",
1844	"-pty-fd" => -1, "-sl" => 0,	1942	"-pty-fd" => -1, "-sl" => 0,
1845	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1943	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1846	"--transient-for" => $self->{term}->parent,	1944	"--transient-for" => $self->{term}->parent,
1847	"-display" => $self->{term}->display_id,	1945	"-display" => $self->{term}->display_id,
1848	"-pe" => "urxvt-popup")	1946	"-pe" => "urxvt-popup",
1849	or die "unable to create popup window\n";	1947	) or die "unable to create popup window\n";
		1948
		1949	unless (delete $term->{urxvt_popup_init_done}) {
		1950	$term->ungrab;
		1951	$term->destroy;
		1952	die "unable to initialise popup window\n";
		1953	}
1850	}	1954	}
1851		1955
1852	sub DESTROY {	1956	sub DESTROY {
1853	my ($self) = @_;	1957	my ($self) = @_;
1854		1958
…		…
1859	=back	1963	=back
1860		1964
1861	=cut	1965	=cut
1862		1966
1863	package urxvt::watcher;	1967	package urxvt::watcher;
1864
1865	@urxvt::timer::ISA = __PACKAGE__;
1866	@urxvt::iow::ISA = __PACKAGE__;
1867	@urxvt::pw::ISA = __PACKAGE__;
1868	@urxvt::iw::ISA = __PACKAGE__;
1869		1968
1870	=head2 The C<urxvt::timer> Class	1969	=head2 The C<urxvt::timer> Class
1871		1970
1872	This class implements timer watchers/events. Time is represented as a	1971	This class implements timer watchers/events. Time is represented as a
1873	fractional number of seconds since the epoch. Example:	1972	fractional number of seconds since the epoch. Example:
…		…
1877	->new	1976	->new
1878	->interval (1)	1977	->interval (1)
1879	->cb (sub {	1978	->cb (sub {
1880	$term->{overlay}->set (0, 0,	1979	$term->{overlay}->set (0, 0,
1881	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1980	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1882	});	1981	});
1883		1982
1884	=over 4	1983	=over 4
1885		1984
1886	=item $timer = new urxvt::timer	1985	=item $timer = new urxvt::timer
1887		1986
…		…
1890		1989
1891	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1990	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1892		1991
1893	Set the callback to be called when the timer triggers.	1992	Set the callback to be called when the timer triggers.
1894		1993
1895	=item $tstamp = $timer->at
1896
1897	Return the time this watcher will fire next.
1898
1899	=item $timer = $timer->set ($tstamp)	1994	=item $timer = $timer->set ($tstamp[, $interval])
1900		1995
1901	Set the time the event is generated to $tstamp.	1996	Set the time the event is generated to $tstamp (and optionally specifies a
		1997	new $interval).
1902		1998
1903	=item $timer = $timer->interval ($interval)	1999	=item $timer = $timer->interval ($interval)
1904		2000
1905	Normally (and when C<$interval> is C<0>), the timer will automatically	2001	By default (and when C<$interval> is C<0>), the timer will automatically
1906	stop after it has fired once. If C<$interval> is non-zero, then the timer	2002	stop after it has fired once. If C<$interval> is non-zero, then the timer
1907	is automatically rescheduled at the given intervals.	2003	is automatically rescheduled at the given intervals.
1908		2004
1909	=item $timer = $timer->start	2005	=item $timer = $timer->start
1910		2006
1911	Start the timer.	2007	Start the timer.
1912		2008
1913	=item $timer = $timer->start ($tstamp)	2009	=item $timer = $timer->start ($tstamp[, $interval])
1914		2010
1915	Set the event trigger time to C<$tstamp> and start the timer.	2011	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2012	also replaces the interval.
1916		2013
1917	=item $timer = $timer->after ($delay)	2014	=item $timer = $timer->after ($delay[, $interval])
1918		2015
1919	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2016	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1920		2017
1921	=item $timer = $timer->stop	2018	=item $timer = $timer->stop
1922		2019
…		…
1930		2027
1931	$term->{socket} = ...	2028	$term->{socket} = ...
1932	$term->{iow} = urxvt::iow	2029	$term->{iow} = urxvt::iow
1933	->new	2030	->new
1934	->fd (fileno $term->{socket})	2031	->fd (fileno $term->{socket})
1935	->events (urxvt::EVENT_READ)	2032	->events (urxvt::EV_READ)
1936	->start	2033	->start
1937	->cb (sub {	2034	->cb (sub {
1938	my ($iow, $revents) = @_;	2035	my ($iow, $revents) = @_;
1939	# $revents must be 1 here, no need to check	2036	# $revents must be 1 here, no need to check
1940	sysread $term->{socket}, my $buf, 8192	2037	sysread $term->{socket}, my $buf, 8192
…		…
1953	Set the callback to be called when io events are triggered. C<$reventmask>	2050	Set the callback to be called when io events are triggered. C<$reventmask>
1954	is a bitset as described in the C<events> method.	2051	is a bitset as described in the C<events> method.
1955		2052
1956	=item $iow = $iow->fd ($fd)	2053	=item $iow = $iow->fd ($fd)
1957		2054
1958	Set the filedescriptor (not handle) to watch.	2055	Set the file descriptor (not handle) to watch.
1959		2056
1960	=item $iow = $iow->events ($eventmask)	2057	=item $iow = $iow->events ($eventmask)
1961		2058
1962	Set the event mask to watch. The only allowed values are	2059	Set the event mask to watch. The only allowed values are
1963	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2060	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1964	together, or C<urxvt::EVENT_NONE>.	2061	together, or C<urxvt::EV_NONE>.
1965		2062
1966	=item $iow = $iow->start	2063	=item $iow = $iow->start
1967		2064
1968	Start watching for requested events on the given handle.	2065	Start watching for requested events on the given handle.
1969		2066
1970	=item $iow = $iow->stop	2067	=item $iow = $iow->stop
1971		2068
1972	Stop watching for events on the given filehandle.	2069	Stop watching for events on the given file handle.
1973		2070
1974	=back	2071	=back
1975		2072
1976	=head2 The C<urxvt::iw> Class	2073	=head2 The C<urxvt::iw> Class
1977		2074
…		…
2010	->new	2107	->new
2011	->start ($pid)	2108	->start ($pid)
2012	->cb (sub {	2109	->cb (sub {
2013	my ($pw, $exit_status) = @_;	2110	my ($pw, $exit_status) = @_;
2014	...	2111	...
2015	});	2112	});
2016		2113
2017	=over 4	2114	=over 4
2018		2115
2019	=item $pw = new urxvt::pw	2116	=item $pw = new urxvt::pw
2020		2117
…		…
2024		2121
2025	Set the callback to be called when the timer triggers.	2122	Set the callback to be called when the timer triggers.
2026		2123
2027	=item $pw = $timer->start ($pid)	2124	=item $pw = $timer->start ($pid)
2028		2125
2029	Tells the wqtcher to start watching for process C<$pid>.	2126	Tells the watcher to start watching for process C<$pid>.
2030		2127
2031	=item $pw = $pw->stop	2128	=item $pw = $pw->stop
2032		2129
2033	Stop the watcher.	2130	Stop the watcher.
2034		2131
…		…
2047		2144
2048	=item >= 3 - script loading and management	2145	=item >= 3 - script loading and management
2049		2146
2050	=item >=10 - all called hooks	2147	=item >=10 - all called hooks
2051		2148
2052	=item >=11 - hook reutrn values	2149	=item >=11 - hook return values
2053		2150
2054	=back	2151	=back
2055		2152
2056	=head1 AUTHOR	2153	=head1 AUTHOR
2057		2154
2058	Marc Lehmann <pcg@goof.com>	2155	Marc Lehmann <schmorp@schmorp.de>
2059	http://software.schmorp.de/pkg/rxvt-unicode	2156	http://software.schmorp.de/pkg/rxvt-unicode
2060		2157
2061	=cut	2158	=cut
2062		2159
2063	1	2160	1
		2161
		2162	# vim: sw=3:

Diff Legend

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