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.143 by root, Thu Jul 6 23:48:11 2006 UTC vs.
Revision 1.235 by sf-exg, Sat May 17 15:33:24 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	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.
102
103	It's sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as
107	first argument.
108
109	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:
111
112	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};
115
116	=item selection-popup (enabled by default)
117
118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119	text into various other formats/action (such as uri unescaping, perl
120	evaluation, web-browser starting etc.), depending on content.
121
122	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.
125
126	It's sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide wether to add something or not.
128	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.
131
132	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:
135
136	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }
138	: ()
139	};
140
141	=item searchable-scrollback<hotkey> (enabled by default)
142
143	Adds regex search functionality to the scrollback buffer, triggered
144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
145	input/output is suspended and a regex is displayed at the bottom of the
146	screen.
147
148	Inputting characters appends them to the regex and continues incremental
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary
154	selection.
155
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.
159
160	See L<perlre> for more info about perl regular expression syntax.
161
162	=item readline (enabled by default)
163
164	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to
166	move the text cursor to this position. It does so by generating as many
167	cursor-left or cursor-right keypresses as required (the this only works
168	for programs that correctly support wide characters).
169
170	To avoid too many false positives, this is only done when:
171
172	=over 4
173
174	=item - the tty is in ICANON state.
175
176	=item - the text cursor is visible.
177
178	=item - the primary screen is currently being displayed.
179
180	=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182	=back
183
184	The normal selection mechanism isn't disabled, so quick successive clicks
185	might interfere with selection creation in harmless ways.
186
187	=item selection-autotransform
188
189	This selection allows you to do automatic transforms on a selection
190	whenever a selection is made.
191
192	It works by specifying perl snippets (most useful is a single C<s///>
193	operator) that modify C<$_> as resources:
194
195	URxvt.selection-autotransform.0: transform
196	URxvt.selection-autotransform.1: transform
197	...
198
199	For example, the following will transform selections of the form
200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
201	$word>:
202
203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
204
205	And this example matches the same,but replaces it with vi-commands you can
206	paste directly into your (vi :) editor:
207
208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
209
210	Of course, this can be modified to suit your needs and your editor :)
211
212	To expand the example above to typical perl error messages ("XXX at
213	FILENAME line YYY."), you need a slightly more elaborate solution:
214
215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
217
218	The first line tells the selection code to treat the unchanging part of
219	every error message as a selection pattern, and the second line transforms
220	the message into vi commands to load the file.
221
222	=item tabbed
223
224	This transforms the terminal into a tabbar with additional terminals, that
225	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227	button per tab.
228
229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
230	B<Shift-Right> will switch to the tab left or right of the current one,
231	while B<Shift-Down> creates a new tab.
232
233	The tabbar itself can be configured similarly to a normal terminal, but
234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
235	following four resources (shown with defaults):
236
237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239	URxvt.tabbed.tab-fg: <colour-index, default 0>
240	URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243	indices.
244
245	=item mark-urls
246
247	Uses per-line display filtering (C<on_line_update>) to underline urls and
248	make them clickable. When middle-clicked, the program specified in the
249	resource C<urlLauncher> (default C<x-www-browser>) will be started with
250	the URL as first argument.
251
252	=item xim-onthespot
253
254	This (experimental) perl extension implements OnTheSpot editing. It does
255	not work perfectly, and some input methods don't seem to work well with
256	OnTheSpot editing in general, but it seems to work at leats for SCIM and
257	kinput2.
258
259	You enable it by specifying this extension and a preedit style of
260	C<OnTheSpot>, i.e.:
261
262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263
264	=item kuake<hotkey>
265
266	A very primitive quake-console-like extension. It was inspired by a
267	description of how the programs C<kuake> and C<yakuake> work: Whenever the
268	user presses a global accelerator key (by default C<F10>), the terminal
269	will show or hide itself. Another press of the accelerator key will hide
270	or show it again.
271
272	Initially, the window will not be shown when using this extension.
273
274	This is useful if you need a single terminal thats not using any desktop
275	space most of the time but is quickly available at the press of a key.
276
277	The accelerator key is grabbed regardless of any modifers, so this
278	extension will actually grab a physical key just for this function.
279
280	If you want a quake-like animation, tell your window manager to do so
281	(fvwm can do it).
282
283	=item automove-background
284
285	This is basically a very small extension that dynamically changes the
286	background pixmap offset to the window position, in effect creating the
287	same effect as pseudo transparency with a custom pixmap. No scaling is
288	supported in this mode. Exmaple:
289
290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291
292	=item block-graphics-to-ascii
293
294	A not very useful example of filtering all text output to the terminal
295	by replacing all line-drawing characters (U+2500 .. U+259F) by a
296	similar-looking ascii character.
297
298	=item digital-clock
299
300	Displays a digital clock using the built-in overlay.
301
302	=item remote-clipboard
303
304	Somewhat of a misnomer, this extension adds two menu entries to the
305	selection popup that allows one ti run external commands to store the
306	selection somewhere and fetch it again.
307
308	We use it to implement a "distributed selection mechanism", which just
309	means that one command uploads the file to a remote server, and another
310	reads it.
311
312	The commands can be set using the C<URxvt.remote-selection.store> and
313	C<URxvt.remote-selection.fetch> resources. The first should read the
314	selection to store from STDIN (always in UTF-8), the second should provide
315	the selection data on STDOUT (also in UTF-8).
316
317	The defaults (which are likely useless to you) use rsh and cat:
318
319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321
322	=item selection-pastebin
323
324	This is a little rarely useful extension that Uploads the selection as
325	textfile to a remote site (or does other things). (The implementation is
326	not currently secure for use in a multiuser environment as it writes to
327	F</tmp> directly.).
328
329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
330	i.e.
331
332	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
333
334	Pressing this combination runs a command with C<%> replaced by the name of
335	the textfile. This command can be set via a resource:
336
337	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
338
339	And the default is likely not useful to anybody but the few people around
340	here :)
341
342	The name of the textfile is the hex encoded md5 sum of the selection, so
343	the same content should lead to the same filename.
344
345	After a successful upload the selection will be replaced by the text given
346	in the C<selection-pastebin-url> resource (again, the % is the placeholder
347	for the filename):
348
349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350
351	=item example-refresh-hooks
352
353	Displays a very simple digital clock in the upper right corner of the
354	window. Illustrates overwriting the refresh callbacks to create your own
355	overlays or changes.
356
357	=back
358		50
359	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
360		52
361	=head2 General API Considerations	53	=head2 General API Considerations
362		54
…		…
376		68
377	=over 4	69	=over 4
378		70
379	=item $text	71	=item $text
380		72
381	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
382	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.
383		75
384	=item $string	76	=item $string
385		77
386	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
…		…
390	=item $octets	82	=item $octets
391		83
392	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
393	locale-specific way.	85	locale-specific way.
394		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
395	=back	93	=back
396		94
397	=head2 Extension Objects	95	=head2 Extension Objects
398		96
399	Every 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
400	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,
401	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
402	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
403	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
404	use.	103	internal use.
405		104
406	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
407	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
408		107
409	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
410		109	the C<urxvt::extension> section below.
411	=over 4
412
413	=item $urxvt_term = $self->{term}
414
415	Returns the C<urxvt::term> object associated with this instance of the
416	extension. This member I<must not> be changed in any way.
417
418	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
419
420	Dynamically enable the given hooks (named without the C<on_> prefix) for
421	this extension, replacing any previous hook. This is useful when you want
422	to overwrite time-critical hooks only temporarily.
423
424	=item $self->disable ($hook_name[, $hook_name..])
425
426	Dynamically disable the given hooks.
427
428	=back
429		110
430	=head2 Hooks	111	=head2 Hooks
431		112
432	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
433	called whenever the relevant event happens.	114	called whenever the relevant event happens.
434		115
435	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
436	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
437		118
438	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
439	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
440	relevant action might not be carried out by the C++ code.	121	relevant action might not be carried out by the C++ code.
…		…
453	place.	134	place.
454		135
455	=item on_start $term	136	=item on_start $term
456		137
457	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
458	trying to map (display) the toplevel and returning to the mainloop.	139	trying to map (display) the toplevel and returning to the main loop.
459		140
460	=item on_destroy $term	141	=item on_destroy $term
461		142
462	Called whenever something tries to destroy terminal, when the terminal is	143	Called whenever something tries to destroy terminal, when the terminal is
463	still fully functional (not for long, though).	144	still fully functional (not for long, though).
…		…
490		171
491	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
492	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
493	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
494		175
495	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.
496		177
497	=item on_sel_extend $term	178	=item on_sel_extend $term
498		179
499	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
500	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
501	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
502	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
503	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
504	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
505		186
506	See the F<selection> example extension.	187	See the F<selection> example extension.
507		188
508	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
509		190
510	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
511	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
512	show this many lines of scrollback.	193	show this many lines of scrollback.
513		194
514	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
515		196
…		…
519		200
520	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,
521	$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
522	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
523		204
524	=item on_osc_seq $term, $op, $args	205	=item on_osc_seq $term, $op, $args, $resp
525		206
526	Called on every OSC sequence and can be used to suppress it or modify its	207	Called on every OSC sequence and can be used to suppress it or modify its
527	behaviour. The default should be to return an empty list. A true value	208	behaviour. The default should be to return an empty list. A true value
528	suppresses execution of the request completely. Make sure you don't get	209	suppresses execution of the request completely. Make sure you don't get
529	confused by recursive invocations when you output an osc sequence within	210	confused by recursive invocations when you output an OSC sequence within
530	this callback.	211	this callback.
531		212
532	C<on_osc_seq_perl> should be used for new behaviour.	213	C<on_osc_seq_perl> should be used for new behaviour.
533		214
534	=item on_osc_seq_perl $term, $string	215	=item on_osc_seq_perl $term, $args, $resp
535		216
536	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
537	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
538	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
539	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,
540	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
541	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	}
542		233
543	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,
544	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
545	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.
546		240
547	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
548		242
549	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
550	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
…		…
555	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
556		250
557	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
558	suppress or filter tty input.	252	suppress or filter tty input.
559		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
560	=item on_line_update $term, $row	261	=item on_line_update $term, $row
561		262
562	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
563	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
564	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,
…		…
571	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
572	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
573		274
574	=item on_refresh_begin $term	275	=item on_refresh_begin $term
575		276
576	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
577	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
578	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
579	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
580		281
581	=item on_refresh_end $term	282	=item on_refresh_end $term
582		283
583	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>.
584		285
585	=item on_user_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
586		287
587	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
588	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>
589	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
590		291
591	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
592	slightly in the future.	293	preference to the C<on_action> hook.
593		294
594	=item on_resize_all_windows $tern, $new_width, $new_height	295	=item on_resize_all_windows $term, $new_width, $new_height
595		296
596	Called just after the new window size has been calculcated, but before	297	Called just after the new window size has been calculated, but before
597	windows are actually being resized or hints are being set. If this hook	298	windows are actually being resized or hints are being set. If this hook
598	returns TRUE, setting of the window hints is being skipped.	299	returns a true value, setting of the window hints is being skipped.
599		300
600	=item on_x_event $term, $event	301	=item on_x_event $term, $event
601		302
602	Called on every X event received on the vt window (and possibly other	303	Called on every X event received on the vt window (and possibly other
603	windows). Should only be used as a last resort. Most event structure	304	windows). Should only be used as a last resort. Most event structure
…		…
612	Called whenever the window gets the keyboard focus, before rxvt-unicode	313	Called whenever the window gets the keyboard focus, before rxvt-unicode
613	does focus in processing.	314	does focus in processing.
614		315
615	=item on_focus_out $term	316	=item on_focus_out $term
616		317
617	Called wheneever the window loses keyboard focus, before rxvt-unicode does	318	Called whenever the window loses keyboard focus, before rxvt-unicode does
618	focus out processing.	319	focus out processing.
619		320
620	=item on_configure_notify $term, $event	321	=item on_configure_notify $term, $event
621		322
622	=item on_property_notify $term, $event	323	=item on_property_notify $term, $event
…		…
633		334
634	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
635		336
636	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
637		338
638	Called whenever the corresponding X event is received for the terminal If	339	Called whenever the corresponding X event is received for the terminal. If
639	the hook returns true, then the even will be ignored by rxvt-unicode.	340	the hook returns true, then the event will be ignored by rxvt-unicode.
640		341
641	The event is a hash with most values as named by Xlib (see the XEvent	342	The event is a hash with most values as named by Xlib (see the XEvent
642	manpage), with the additional members C<row> and C<col>, which are the	343	manpage), with the additional members C<row> and C<col>, which are the
643	(real, not screen-based) row and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
644		345
645	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
646	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
647		348
648	subwindow.
649
650	=item on_client_message $term, $event	349	=item on_client_message $term, $event
651		350
652	=item on_wm_protocols $term, $event	351	=item on_wm_protocols $term, $event
653		352
654	=item on_wm_delete_window $term, $event	353	=item on_wm_delete_window $term, $event
655		354
656	Called when various types of ClientMessage events are received (all with	355	Called when various types of ClientMessage events are received (all with
657	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	356	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
658		357
		358	=item on_bell $term
		359
		360	Called on receipt of a bell character.
		361
659	=back	362	=back
660		363
661	=cut	364	=cut
662		365
663	package urxvt;	366	package urxvt;
664		367
665	use utf8;	368	use utf8;
666	use strict;	369	use strict 'vars';
667	use Carp ();	370	use Carp ();
668	use Scalar::Util ();	371	use Scalar::Util ();
669	use List::Util ();	372	use List::Util ();
670		373
671	our $VERSION = 1;	374	our $VERSION = 1;
672	our $TERM;	375	our $TERM;
673	our @TERM_INIT;	376	our @TERM_INIT; # should go, prevents async I/O etc.
674	our @TERM_EXT;	377	our @TERM_EXT; # should go, prevents async I/O etc.
675	our @HOOKNAME;	378	our @HOOKNAME;
676	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
677	our %OPTION;	380	our %OPTION;
678		381
679	our $LIBDIR;	382	our $LIBDIR;
…		…
705	The current terminal. This variable stores the current C<urxvt::term>	408	The current terminal. This variable stores the current C<urxvt::term>
706	object, whenever a callback/hook is executing.	409	object, whenever a callback/hook is executing.
707		410
708	=item @urxvt::TERM_INIT	411	=item @urxvt::TERM_INIT
709		412
710	All coderefs in this array will be called as methods of the next newly	413	All code references in this array will be called as methods of the next newly
711	created C<urxvt::term> object (during the C<on_init> phase). The array	414	created C<urxvt::term> object (during the C<on_init> phase). The array
712	gets cleared before the codereferences that were in it are being executed,	415	gets cleared before the code references that were in it are being executed,
713	so coderefs can push themselves onto it again if they so desire.	416	so references can push themselves onto it again if they so desire.
714		417
715	This complements to the perl-eval commandline option, but gets executed	418	This complements to the perl-eval command line option, but gets executed
716	first.	419	first.
717		420
718	=item @urxvt::TERM_EXT	421	=item @urxvt::TERM_EXT
719		422
720	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	423	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
727		430
728	=over 4	431	=over 4
729		432
730	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
731		434
732	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
733	costs! The only time this is acceptable is when the terminal process	436	include a trailing newline). Avoid at all costs! The only time this
734	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
735		439
736	=item urxvt::warn $string	440	=item urxvt::warn $string
737		441
738	Calls C<rxvt_warn> with the given string which should not include a	442	Calls C<rxvt_warn> with the given string which should include a trailing
739	newline. The module also overwrites the C<warn> builtin with a function	443	newline. The module also overwrites the C<warn> builtin with a function
740	that calls this function.	444	that calls this function.
741		445
742	Using this function has the advantage that its output ends up in the	446	Using this function has the advantage that its output ends up in the
743	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
745	Messages have a size limit of 1023 bytes currently.	449	Messages have a size limit of 1023 bytes currently.
746		450
747	=item @terms = urxvt::termlist	451	=item @terms = urxvt::termlist
748		452
749	Returns all urxvt::term objects that exist in this process, regardless of	453	Returns all urxvt::term objects that exist in this process, regardless of
750	wether they are started, being destroyed etc., so be careful. Only term	454	whether they are started, being destroyed etc., so be careful. Only term
751	objects that have perl extensions attached will be returned (because there	455	objects that have perl extensions attached will be returned (because there
752	is no urxvt::term objet associated with others).	456	is no urxvt::term object associated with others).
753		457
754	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
755		459
756	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
757		461
…		…
800		504
801	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
802		506
803	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
804		508
805	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	509	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		510	urxvt::RS_RVid, urxvt::RS_Uline
806		511
807	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
808	underline, respectively. To enable such a style, just logically OR it into	513	underline, respectively. To enable such a style, just logically OR it into
809	the bitset.	514	the bitset.
810		515
…		…
847	};	552	};
848	}	553	}
849		554
850	no warnings 'utf8';	555	no warnings 'utf8';
851		556
		557	sub parse_resource {
		558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		559
		560	$name =~ y/-/./ if $isarg;
		561
		562	$term->scan_extensions;
		563
		564	my $r = $term->{meta}{resource};
		565	keys %$r; # reset iterator
		566	while (my ($pattern, $v) = each %$r) {
		567	if (
		568	$pattern =~ /\.$/
		569	? $pattern eq substr $name, 0, length $pattern
		570	: $pattern eq $name
		571	) {
		572	$name = "$urxvt::RESCLASS.$name";
		573
		574	push @{ $term->{perl_ext_3} }, $v->[0];
		575
		576	if ($v->[1] eq "boolean") {
		577	$term->put_option_db ($name, $flag ? "true" : "false");
		578	return 1;
		579	} else {
		580	$term->put_option_db ($name, $value);
		581	return 1 + 2;
		582	}
		583	}
		584	}
		585
		586	0
		587	}
		588
		589	sub usage {
		590	my ($term, $usage_type) = @_;
		591
		592	$term->scan_extensions;
		593
		594	my $r = $term->{meta}{resource};
		595
		596	for my $pattern (sort keys %$r) {
		597	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		598
		599	$desc .= " (-pe $ext)";
		600
		601	if ($usage_type == 1) {
		602	$pattern =~ y/./-/;
		603	$pattern =~ s/-$/-.../g;
		604
		605	if ($type eq "boolean") {
		606	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		607	} else {
		608	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		609	}
		610	} else {
		611	$pattern =~ s/\.$/.*/g;
		612	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		613	}
		614	}
		615	}
		616
852	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
853		618
854	sub verbose {	619	sub verbose {
855	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
856	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
…		…
868	$pkg =~ s/[^[:word:]]/_/g;	633	$pkg =~ s/[^[:word:]]/_/g;
869	$pkg = "urxvt::ext::$pkg";	634	$pkg = "urxvt::ext::$pkg";
870		635
871	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
872		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		639
873	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
874	or die "$path: $!";	641	or die "$path: $!";
875		642
876	my $source =	643	my $source =
877	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
878	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
879	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
880	. "\n};\n1";	647	. "\n};\n1";
881		648
882	eval $source	649	eval $source
…		…
891	# called by the rxvt core	658	# called by the rxvt core
892	sub invoke {	659	sub invoke {
893	local $TERM = shift;	660	local $TERM = shift;
894	my $htype = shift;	661	my $htype = shift;
895		662
896	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
897	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
898		665
		666	$TERM->scan_extensions;
		667
899	my %ext_arg;	668	my %ext_arg;
900		669
901	{	670	{
902	my @init = @TERM_INIT;	671	my @init = @TERM_INIT;
903	@TERM_INIT = ();	672	@TERM_INIT = ();
…		…
905	my @pkg = @TERM_EXT;	674	my @pkg = @TERM_EXT;
906	@TERM_EXT = ();	675	@TERM_EXT = ();
907	$TERM->register_package ($_) for @pkg;	676	$TERM->register_package ($_) for @pkg;
908	}	677	}
909		678
		679	for (
		680	@{ delete $TERM->{perl_ext_3} },
910	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	681	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		682	) {
911	if ($_ eq "default") {	683	if ($_ eq "default") {
912	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	684	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
913	} elsif (/^-(.*)$/) {	685	} elsif (/^-(.*)$/) {
914	delete $ext_arg{$1};	686	delete $ext_arg{$1};
915	} elsif (/^([^<]+)<(.*)>$/) {	687	} elsif (/^([^<]+)<(.*)>$/) {
…		…
937		709
938	if (my $cb = $TERM->{_hook}[$htype]) {	710	if (my $cb = $TERM->{_hook}[$htype]) {
939	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	711	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
940	if $verbosity >= 10;	712	if $verbosity >= 10;
941		713
		714	if ($htype == HOOK_ACTION) {
		715	# this hook is only sent to the extension with the name
		716	# matching the first arg
		717	my $pkg = shift;
		718	$pkg =~ y/-/_/;
		719	$pkg = "urxvt::ext::$pkg";
		720
		721	$cb = $cb->{$pkg}
		722	or return undef; #TODO: maybe warn user?
		723
		724	$cb = { $pkg => $cb };
		725	}
		726
942	for my $pkg (keys %$cb) {	727	for my $pkg (keys %$cb) {
943	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	728	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
944	$retval ||= $retval_;	729	$retval ||= $retval_;
945		730
946	if ($@) {	731	if ($@) {
947	$TERM->ungrab; # better to lose the grab than the session	732	$TERM->ungrab; # better to lose the grab than the session
948	warn $@;	733	warn $@;
…		…
951		736
952	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	737	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
953	if $verbosity >= 11;	738	if $verbosity >= 11;
954	}	739	}
955		740
956	if ($htype == 1) { # DESTROY	741	if ($htype == HOOK_DESTROY) {
957	# clear package objects	742	# clear package objects
958	%$_ = () for values %{ $TERM->{_pkg} };	743	%$_ = () for values %{ $TERM->{_pkg} };
959		744
960	# clear package	745	# clear package
961	%$TERM = ();	746	%$TERM = ();
…		…
966		751
967	sub SET_COLOR($$$) {	752	sub SET_COLOR($$$) {
968	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	753	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
969	}	754	}
970		755
971	# urxvt::term::extension	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	}
972		780
973	package urxvt::term::extension;	781	package urxvt::term::extension;
974		782
975	sub enable {	783	=head2 The C<urxvt::term::extension> class
976	my ($self, %hook) = @_;
977	my $pkg = $self->{_pkg};
978		784
979	while (my ($name, $cb) = each %hook) {	785	Each extension attached to a terminal object is represented by
980	my $htype = $HOOKTYPE{uc $name};	786	a C<urxvt::term::extension> object.
981	defined $htype
982	or Carp::croak "unsupported hook type '$name'";
983		787
984	$self->set_should_invoke ($htype, +1)	788	You can use these objects, which are passed to all callbacks to store any
985	unless exists $self->{term}{_hook}[$htype]{$pkg};	789	state related to the terminal and extension instance.
986		790
987	$self->{term}{_hook}[$htype]{$pkg} = $cb;	791	The methods (And data members) documented below can be called on extension
988	}	792	objects, in addition to call methods documented for the <urxvt::term>
989	}	793	class.
990		794
991	sub disable {	795	=over 4
992	my ($self, @hook) = @_;
993	my $pkg = $self->{_pkg};
994		796
995	for my $name (@hook) {	797	=item $urxvt_term = $self->{term}
996	my $htype = $HOOKTYPE{uc $name};
997	defined $htype
998	or Carp::croak "unsupported hook type '$name'";
999		798
1000	$self->set_should_invoke ($htype, -1)	799	Returns the C<urxvt::term> object associated with this instance of the
1001	if delete $self->{term}{_hook}[$htype]{$pkg};	800	extension. This member I<must not> be changed in any way.
1002	}	801
1003	}	802	=cut
1004		803
1005	our $AUTOLOAD;	804	our $AUTOLOAD;
1006		805
1007	sub AUTOLOAD {	806	sub AUTOLOAD {
1008	$AUTOLOAD =~ /:([^:]+)$/	807	$AUTOLOAD =~ /:([^:]+)$/
…		…
1021		820
1022	sub DESTROY {	821	sub DESTROY {
1023	# nop	822	# nop
1024	}	823	}
1025		824
1026	# urxvt::destroy_hook	825	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1027		826
1028	sub urxvt::destroy_hook::DESTROY {	827	sub urxvt::destroy_hook::DESTROY {
1029	${$_[0]}->();	828	${$_[0]}->();
1030	}	829	}
1031		830
1032	sub urxvt::destroy_hook(&) {	831	sub urxvt::destroy_hook(&) {
1033	bless \shift, urxvt::destroy_hook::	832	bless \shift, urxvt::destroy_hook::
1034	}	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
1035		948
1036	package urxvt::anyevent;	949	package urxvt::anyevent;
1037		950
1038	=head2 The C<urxvt::anyevent> Class	951	=head2 The C<urxvt::anyevent> Class
1039		952
1040	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
1041	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
1042	further programming. The only exception is that you cannot wait on	955	further programming. The only exception is that you cannot wait on
1043	condition variables, but non-blocking condvar use is ok. What this means	956	condition variables, but non-blocking condvar use is ok.
1044	is that you cannot use blocking APIs, but the non-blocking variant should
1045	work.
1046		957
1047	=cut	958	In practical terms this means is that you cannot use blocking APIs, but
		959	the non-blocking variant should work.
1048		960
		961	=cut
		962
1049	our $VERSION = 1;	963	our $VERSION = '5.23';
1050		964
1051	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	965	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1052	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	966	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1053		967
1054	sub timer {	968	sub timer {
…		…
1056		970
1057	my $cb = $arg{cb};	971	my $cb = $arg{cb};
1058		972
1059	urxvt::timer	973	urxvt::timer
1060	->new	974	->new
1061	->start (urxvt::NOW + $arg{after})	975	->after ($arg{after}, $arg{interval})
1062	->cb (sub {	976	->cb ($arg{interval} ? $cb : sub {
1063	$_[0]->stop; # need to cancel manually	977	$_[0]->stop; # need to cancel manually
1064	$cb->();	978	$cb->();
1065	})	979	})
1066	}	980	}
1067		981
1068	sub io {	982	sub io {
1069	my ($class, %arg) = @_;	983	my ($class, %arg) = @_;
1070		984
1071	my $cb = $arg{cb};	985	my $cb = $arg{cb};
		986	my $fd = fileno $arg{fh};
		987	defined $fd or $fd = $arg{fh};
1072		988
1073	bless [$arg{fh}, urxvt::iow	989	bless [$arg{fh}, urxvt::iow
1074	->new	990	->new
1075	->fd (fileno $arg{fh})	991	->fd ($fd)
1076	->events (($arg{poll} =~ /r/ ? 1 : 0)	992	->events (($arg{poll} =~ /r/ ? 1 : 0)
1077	| ($arg{poll} =~ /w/ ? 2 : 0))	993	| ($arg{poll} =~ /w/ ? 2 : 0))
1078	->start	994	->start
1079	->cb (sub {	995	->cb ($cb)
1080	$cb->(($_[1] & 1 ? 'r' : '')
1081	. ($_[1] & 2 ? 'w' : ''));
1082	})],
1083	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	})
1084	}	1022	}
1085		1023
1086	sub DESTROY {	1024	sub DESTROY {
1087	$_[0][1]->stop;	1025	$_[0][1]->stop;
1088	}	1026	}
1089		1027
1090	sub condvar {	1028	# only needed for AnyEvent < 6 compatibility
1091	bless \my $flag, urxvt::anyevent::condvar::	1029	sub one_event {
1092	}
1093
1094	sub urxvt::anyevent::condvar::broadcast {
1095	${$_[0]}++;
1096	}
1097
1098	sub urxvt::anyevent::condvar::wait {
1099	unless (${$_[0]}) {
1100	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";
1101	}
1102	}	1031	}
1103		1032
1104	package urxvt::term;	1033	package urxvt::term;
1105		1034
1106	=head2 The C<urxvt::term> Class	1035	=head2 The C<urxvt::term> Class
…		…
1119	urxvt::verbose 6, "register package $pkg to $self";	1048	urxvt::verbose 6, "register package $pkg to $self";
1120		1049
1121	@{"$pkg\::ISA"} = urxvt::term::extension::;	1050	@{"$pkg\::ISA"} = urxvt::term::extension::;
1122		1051
1123	my $proxy = bless {	1052	my $proxy = bless {
1124	_pkg => $pkg,	1053	_pkg => $pkg,
		1054	_name => ${"$pkg\::_NAME"}, # hackish
1125	argv => $argv,	1055	argv => $argv,
1126	}, $pkg;	1056	}, $pkg;
1127	Scalar::Util::weaken ($proxy->{term} = $self);	1057	Scalar::Util::weaken ($proxy->{term} = $self);
1128		1058
1129	$self->{_pkg}{$pkg} = $proxy;	1059	$self->{_pkg}{$pkg} = $proxy;
1130		1060
…		…
1133	$proxy->enable ($name => $ref);	1063	$proxy->enable ($name => $ref);
1134	}	1064	}
1135	}	1065	}
1136	}	1066	}
1137		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	# scan for available extensions and collect their metadata
		1077	sub scan_extensions {
		1078	my ($self) = @_;
		1079
		1080	return if exists $self->{meta};
		1081
		1082	my @libdirs = perl_libdirs $self;
		1083
		1084	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1085
		1086	my %meta;
		1087
		1088	$self->{meta_libdirs} = join "\x00", @libdirs;
		1089	$self->{meta} = \%meta;
		1090
		1091	my %ext;
		1092
		1093	# first gather extensions
		1094	for my $dir (reverse @libdirs) {
		1095	opendir my $fh, $dir
		1096	or next;
		1097	for my $ext (readdir $fh) {
		1098	$ext !~ /^\./
		1099	and open my $fh, "<", "$dir/$ext"
		1100	or next;
		1101
		1102	my %ext = (dir => $dir);
		1103
		1104	while (<$fh>) {
		1105	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1106	my ($pattern, $type, $desc) = split /:/, $1;
		1107	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1108	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1109	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1110	} else {
		1111	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1112	}
		1113	} elsif (/^#:META:BINDING:(.*)/) {
		1114	my ($keysym, $action) = split /:/, $1;
		1115	$ext{binding}{$keysym} = $action;
		1116	} elsif (/^\s*(?:#|$)/) {
		1117	# skip other comments and empty lines
		1118	} else {
		1119	last; # stop parsing on first non-empty non-comment line
		1120	}
		1121	}
		1122
		1123	$meta{$ext} = \%ext;
		1124	}
		1125	}
		1126
		1127	# and now merge resources and bindings
		1128	while (my ($k, $v) = each %ext) {
		1129	#TODO: should check for extensions overriding each other
		1130	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1131	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1132	}
		1133	}
		1134
1138	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1135	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1139		1136
1140	Creates a new terminal, very similar as if you had started it with system	1137	Creates a new terminal, very similar as if you had started it with system
1141	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1138	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1142	hash which defines the environment of the new terminal.	1139	hash which defines the environment of the new terminal.
…		…
1159	}	1156	}
1160		1157
1161	=item $term->destroy	1158	=item $term->destroy
1162		1159
1163	Destroy the terminal object (close the window, free resources	1160	Destroy the terminal object (close the window, free resources
1164	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1161	etc.). Please note that urxvt will not exit as long as any event
1165	watchers (timers, io watchers) are still active.	1162	watchers (timers, io watchers) are still active.
1166		1163
1167	=item $term->exec_async ($cmd[, @args])	1164	=item $term->exec_async ($cmd[, @args])
1168		1165
1169	Works like the combination of the C<fork>/C<exec> builtins, which executes	1166	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1193		1190
1194	Returns true if the option specified by C<$optval> is enabled, and	1191	Returns true if the option specified by C<$optval> is enabled, and
1195	optionally change it. All option values are stored by name in the hash	1192	optionally change it. All option values are stored by name in the hash
1196	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1193	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1197		1194
1198	Here is a a likely non-exhaustive list of option names, please see the	1195	Here is a likely non-exhaustive list of option names, please see the
1199	source file F</src/optinc.h> to see the actual list:	1196	source file F</src/optinc.h> to see the actual list:
1200		1197
1201	borderLess console cursorBlink cursorUnderline hold iconic insecure	1198	borderLess buffered console cursorBlink cursorUnderline hold iconic
1202	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1199	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1203	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1200	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1204	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1201	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1205	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1202	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1206	transparent tripleclickwords utmpInhibit visualBell	1203	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1204	urgentOnBell utmpInhibit visualBell
1207		1205
1208	=item $value = $term->resource ($name[, $newval])	1206	=item $value = $term->resource ($name[, $newval])
1209		1207
1210	Returns the current resource value associated with a given name and	1208	Returns the current resource value associated with a given name and
1211	optionally sets a new value. Setting values is most useful in the C<init>	1209	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1220	likely change).	1218	likely change).
1221		1219
1222	Please note that resource strings will currently only be freed when the	1220	Please note that resource strings will currently only be freed when the
1223	terminal is destroyed, so changing options frequently will eat memory.	1221	terminal is destroyed, so changing options frequently will eat memory.
1224		1222
1225	Here is a a likely non-exhaustive list of resource names, not all of which	1223	Here is a likely non-exhaustive list of resource names, not all of which
1226	are supported in every build, please see the source file F</src/rsinc.h>	1224	are supported in every build, please see the source file F</src/rsinc.h>
1227	to see the actual list:	1225	to see the actual list:
1228		1226
1229	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1227	answerbackstring backgroundPixmap backspace_key blurradius
1230	borderLess color cursorBlink cursorUnderline cutchars delete_key	1228	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1231	display_name embed ext_bwidth fade font geometry hold iconName	1229	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1232	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1230	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1231	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1233	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1232	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1234	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1233	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1235	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1234	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1236	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1235	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1237	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1236	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1238	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1237	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1239	secondaryScreen secondaryScroll selectstyle shade term_name title	1238	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1240	transient_for transparent transparent_all tripleclickwords utmpInhibit	1239	term_name title transient_for transparent tripleclickwords urgentOnBell
1241	visualBell	1240	utmpInhibit visualBell
1242		1241
1243	=cut	1242	=cut
1244		1243
1245	sub resource($$;$) {	1244	sub resource($$;$) {
1246	my ($self, $name) = (shift, shift);	1245	my ($self, $name) = (shift, shift);
1247	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1246	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1248	&urxvt::term::_resource	1247	goto &urxvt::term::_resource
1249	}	1248	}
1250		1249
1251	=item $value = $term->x_resource ($pattern)	1250	=item $value = $term->x_resource ($pattern)
1252		1251
1253	Returns the X-Resource for the given pattern, excluding the program or	1252	Returns the X-Resource for the given pattern, excluding the program or
1254	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1253	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1255	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1254	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1256	resource with that pattern exists.	1255	resource with that pattern exists.
1257		1256
		1257	Extensions that define extra resource or command line arguments also need
		1258	to call this method to access their values.
		1259
		1260	If the method is called on an extension object (basically, from an
		1261	extension), then the special prefix C<%.> will be replaced by the name of
		1262	the extension and a dot, and the lone string C<%> will be replaced by the
		1263	extension name itself. This makes it possible to code extensions so you
		1264	can rename them and get a new set of commandline switches and resources
		1265	without having to change the actual code.
		1266
1258	This method should only be called during the C<on_start> hook, as there is	1267	This method should only be called during the C<on_start> hook, as there is
1259	only one resource database per display, and later invocations might return	1268	only one resource database per display, and later invocations might return
1260	the wrong resources.	1269	the wrong resources.
1261		1270
1262	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1271	=item $value = $term->x_resource_boolean ($pattern)
1263		1272
		1273	Like C<x_resource>, above, but interprets the string value as a boolean
		1274	and returns C<1> for true values, C<0> for false values and C<undef> if
		1275	the resource or option isn't specified.
		1276
		1277	You should always use this method to parse boolean resources.
		1278
		1279	=cut
		1280
		1281	sub x_resource_boolean {
		1282	my $res = &x_resource;
		1283
		1284	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1285	}
		1286
		1287	=item $success = $term->bind_action ($key, $octets)
		1288
1264	Adds a keymap translation exactly as specified via a resource. See the	1289	Adds a key binding exactly as specified via a C<keysym> resource. See the
1265	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1290	C<keysym> resource in the urxvt(1) manpage.
1266		1291
1267	=item $rend = $term->rstyle ([$new_rstyle])	1292	=item $rend = $term->rstyle ([$new_rstyle])
1268		1293
1269	Return and optionally change the current rendition. Text that is output by	1294	Return and optionally change the current rendition. Text that is output by
1270	the terminal application will use this style.	1295	the terminal application will use this style.
…		…
1278		1303
1279	=item ($row, $col) = $term->selection_beg ([$row, $col])	1304	=item ($row, $col) = $term->selection_beg ([$row, $col])
1280		1305
1281	=item ($row, $col) = $term->selection_end ([$row, $col])	1306	=item ($row, $col) = $term->selection_end ([$row, $col])
1282		1307
1283	Return the current values of the selection mark, begin or end positions,	1308	Return the current values of the selection mark, begin or end positions.
1284	and optionally set them to new values.	1309
		1310	When arguments are given, then the selection coordinates are set to
		1311	C<$row> and C<$col>, and the selection screen is set to the current
		1312	screen.
		1313
		1314	=item $screen = $term->selection_screen ([$screen])
		1315
		1316	Returns the current selection screen, and then optionally sets it.
1285		1317
1286	=item $term->selection_make ($eventtime[, $rectangular])	1318	=item $term->selection_make ($eventtime[, $rectangular])
1287		1319
1288	Tries to make a selection as set by C<selection_beg> and	1320	Tries to make a selection as set by C<selection_beg> and
1289	C<selection_end>. If C<$rectangular> is true (default: false), a	1321	C<selection_end>. If C<$rectangular> is true (default: false), a
1290	rectangular selection will be made. This is the prefered function to make	1322	rectangular selection will be made. This is the preferred function to make
1291	a selection.	1323	a selection.
1292		1324
1293	=item $success = $term->selection_grab ($eventtime)	1325	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1294		1326
1295	Try to request the primary selection text from the server (for example, as	1327	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1328	true) selection from the server. The corresponding text can be set
1296	set by the next method). No visual feedback will be given. This function	1329	with the next method. No visual feedback will be given. This function
1297	is mostly useful from within C<on_sel_grab> hooks.	1330	is mostly useful from within C<on_sel_grab> hooks.
1298		1331
1299	=item $oldtext = $term->selection ([$newtext])	1332	=item $oldtext = $term->selection ([$newtext, $clipboard])
1300		1333
1301	Return the current selection text and optionally replace it by C<$newtext>.	1334	Return the current selection (clipboard if C<$clipboard> is true) text
		1335	and optionally replace it by C<$newtext>.
		1336
		1337	=item $term->selection_clear ([$clipboard])
		1338
		1339	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1302		1340
1303	=item $term->overlay_simple ($x, $y, $text)	1341	=item $term->overlay_simple ($x, $y, $text)
1304		1342
1305	Create a simple multi-line overlay box. See the next method for details.	1343	Create a simple multi-line overlay box. See the next method for details.
1306		1344
…		…
1336		1374
1337	The methods currently supported on C<urxvt::overlay> objects are:	1375	The methods currently supported on C<urxvt::overlay> objects are:
1338		1376
1339	=over 4	1377	=over 4
1340		1378
1341	=item $overlay->set ($x, $y, $text, $rend)	1379	=item $overlay->set ($x, $y, $text[, $rend])
1342		1380
1343	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1381	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1344	text in rxvt-unicode's special encoding and an array of rendition values	1382	text in rxvt-unicode's special encoding and an array of rendition values
1345	at a specific position inside the overlay.	1383	at a specific position inside the overlay.
		1384
		1385	If C<$rend> is missing, then the rendition will not be changed.
1346		1386
1347	=item $overlay->hide	1387	=item $overlay->hide
1348		1388
1349	If visible, hide the overlay, but do not destroy it.	1389	If visible, hide the overlay, but do not destroy it.
1350		1390
…		…
1432	locale-specific encoding of the terminal and can contain command sequences	1472	locale-specific encoding of the terminal and can contain command sequences
1433	(escape codes) that will be interpreted.	1473	(escape codes) that will be interpreted.
1434		1474
1435	=item $term->tt_write ($octets)	1475	=item $term->tt_write ($octets)
1436		1476
1437	Write the octets given in C<$data> to the tty (i.e. as program input). To	1477	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1438	pass characters instead of octets, you should convert your strings first	1478	pass characters instead of octets, you should convert your strings first
1439	to the locale-specific encoding using C<< $term->locale_encode >>.	1479	to the locale-specific encoding using C<< $term->locale_encode >>.
		1480
		1481	=item $term->tt_write_user_input ($octets)
		1482
		1483	Like C<tt_write>, but should be used when writing strings in response to
		1484	the user pressing a key, to invokes the additional actions requested by
		1485	the user for that case (C<tt_write> doesn't do that).
		1486
		1487	The typical use case would be inside C<on_action> hooks.
		1488
		1489	=item $term->tt_paste ($octets)
		1490
		1491	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1492	CR and bracketing the data with control sequences if bracketed paste mode
		1493	is set.
1440		1494
1441	=item $old_events = $term->pty_ev_events ([$new_events])	1495	=item $old_events = $term->pty_ev_events ([$new_events])
1442		1496
1443	Replaces the event mask of the pty watcher by the given event mask. Can	1497	Replaces the event mask of the pty watcher by the given event mask. Can
1444	be used to suppress input and output handling to the pty/tty. See the	1498	be used to suppress input and output handling to the pty/tty. See the
…		…
1463	Adds the specified events to the vt event mask. Useful e.g. when you want	1517	Adds the specified events to the vt event mask. Useful e.g. when you want
1464	to receive pointer events all the times:	1518	to receive pointer events all the times:
1465		1519
1466	$term->vt_emask_add (urxvt::PointerMotionMask);	1520	$term->vt_emask_add (urxvt::PointerMotionMask);
1467		1521
		1522	=item $term->set_urgency ($set)
		1523
		1524	Enable/disable the urgency hint on the toplevel window.
		1525
1468	=item $term->focus_in	1526	=item $term->focus_in
1469		1527
1470	=item $term->focus_out	1528	=item $term->focus_out
1471		1529
1472	=item $term->key_press ($state, $keycode[, $time])	1530	=item $term->key_press ($state, $keycode[, $time])
…		…
1542		1600
1543	Returns the currently displayed screen (0 primary, 1 secondary).	1601	Returns the currently displayed screen (0 primary, 1 secondary).
1544		1602
1545	=item $cursor_is_hidden = $term->hidden_cursor	1603	=item $cursor_is_hidden = $term->hidden_cursor
1546		1604
1547	Returns wether the cursor is currently hidden or not.	1605	Returns whether the cursor is currently hidden or not.
1548		1606
1549	=item $view_start = $term->view_start ([$newvalue])	1607	=item $view_start = $term->view_start ([$newvalue])
1550		1608
1551	Returns the row number of the topmost displayed line. Maximum value is	1609	Returns the row number of the topmost displayed line. Maximum value is
1552	C<0>, which displays the normal terminal contents. Lower values scroll	1610	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1560		1618
1561	Used after changing terminal contents to display them.	1619	Used after changing terminal contents to display them.
1562		1620
1563	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1621	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1564		1622
1565	Returns the text of the entire row with number C<$row_number>. Row C<0>	1623	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1566	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1624	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1567	terminal line. The scrollback buffer starts at line C<-1> and extends to
1568	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1625	terminal line. Nothing will be returned if a nonexistent line
1569	is requested.	1626	is requested.
1570		1627
1571	If C<$new_text> is specified, it will replace characters in the current	1628	If C<$new_text> is specified, it will replace characters in the current
1572	line, starting at column C<$start_col> (default C<0>), which is useful	1629	line, starting at column C<$start_col> (default C<0>), which is useful
1573	to replace only parts of a line. The font index in the rendition will	1630	to replace only parts of a line. The font index in the rendition will
1574	automatically be updated.	1631	automatically be updated.
1575		1632
1576	C<$text> is in a special encoding: tabs and wide characters that use more	1633	C<$text> is in a special encoding: tabs and wide characters that use more
1577	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1634	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1578	characters. Characters with combining characters and other characters that	1635	characters. Characters with combining characters and other characters that
1579	do not fit into the normal tetx encoding will be replaced with characters	1636	do not fit into the normal text encoding will be replaced with characters
1580	in the private use area.	1637	in the private use area.
1581		1638
1582	You have to obey this encoding when changing text. The advantage is	1639	You have to obey this encoding when changing text. The advantage is
1583	that C<substr> and similar functions work on screen cells and not on	1640	that C<substr> and similar functions work on screen cells and not on
1584	characters.	1641	characters.
…		…
1669	}	1726	}
1670		1727
1671	sub urxvt::line::t {	1728	sub urxvt::line::t {
1672	my ($self) = @_;	1729	my ($self) = @_;
1673		1730
1674	if (@_ > 1)	1731	if (@_ > 1) {
1675	{
1676	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1732	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1677	for $self->{beg} .. $self->{end};	1733	for $self->{beg} .. $self->{end};
1678	}	1734	}
1679		1735
1680	defined wantarray &&	1736	defined wantarray &&
1681	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1737	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1682	0, $self->{len}	1738	0, $self->{len}
1683	}	1739	}
1684		1740
1685	sub urxvt::line::r {	1741	sub urxvt::line::r {
1686	my ($self) = @_;	1742	my ($self) = @_;
1687		1743
1688	if (@_ > 1)	1744	if (@_ > 1) {
1689	{
1690	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1745	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1691	for $self->{beg} .. $self->{end};	1746	for $self->{beg} .. $self->{end};
1692	}	1747	}
1693		1748
1694	if (defined wantarray) {	1749	if (defined wantarray) {
1695	my $rend = [	1750	my $rend = [
1696	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1751	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1697	];	1752	];
…		…
1729	where one character corresponds to one screen cell. See	1784	where one character corresponds to one screen cell. See
1730	C<< $term->ROW_t >> for details.	1785	C<< $term->ROW_t >> for details.
1731		1786
1732	=item $string = $term->special_decode $text	1787	=item $string = $term->special_decode $text
1733		1788
1734	Converts rxvt-unicodes text reprsentation into a perl string. See	1789	Converts rxvt-unicodes text representation into a perl string. See
1735	C<< $term->ROW_t >> for details.	1790	C<< $term->ROW_t >> for details.
1736		1791
1737	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1792	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1738		1793
1739	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1794	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1742	manpage.	1797	manpage.
1743		1798
1744	=item $success = $term->grab ($eventtime[, $sync])	1799	=item $success = $term->grab ($eventtime[, $sync])
1745		1800
1746	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1801	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1747	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1802	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1748		1803
1749	=item $term->allow_events_async	1804	=item $term->allow_events_async
1750		1805
1751	Calls XAllowEvents with AsyncBoth for the most recent grab.	1806	Calls XAllowEvents with AsyncBoth for the most recent grab.
1752		1807
…		…
1759	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1814	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1760	recent grab.	1815	recent grab.
1761		1816
1762	=item $term->ungrab	1817	=item $term->ungrab
1763		1818
1764	Calls XUngrab for the most recent grab. Is called automatically on	1819	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1765	evaluation errors, as it is better to lose the grab in the error case as	1820	evaluation errors, as it is better to lose the grab in the error case as
1766	the session.	1821	the session.
1767		1822
1768	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1823	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1769		1824
…		…
1771		1826
1772	=item @atoms = $term->XListProperties ($window)	1827	=item @atoms = $term->XListProperties ($window)
1773		1828
1774	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1829	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1775		1830
1776	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1831	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1777		1832
1778	=item $term->XDeleteProperty ($window, $property)	1833	=item $term->XDeleteProperty ($window, $property)
1779		1834
1780	=item $window = $term->DefaultRootWindow	1835	=item $window = $term->DefaultRootWindow
1781		1836
…		…
1788	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1843	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1789		1844
1790	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1845	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1791		1846
1792	=item $term->XChangeInput ($window, $add_events[, $del_events])	1847	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1848
		1849	=item $keysym = $term->XStringToKeysym ($string)
		1850
		1851	=item $string = $term->XKeysymToString ($keysym)
1793		1852
1794	Various X or X-related functions. The C<$term> object only serves as	1853	Various X or X-related functions. The C<$term> object only serves as
1795	the source of the display, otherwise those functions map more-or-less	1854	the source of the display, otherwise those functions map more-or-less
1796	directory onto the X functions of the same name.	1855	directly onto the X functions of the same name.
1797		1856
1798	=back	1857	=back
1799		1858
1800	=cut	1859	=cut
1801		1860
…		…
1903	my $env = $self->{term}->env;	1962	my $env = $self->{term}->env;
1904	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1963	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1905	delete $env->{LC_ALL};	1964	delete $env->{LC_ALL};
1906	$env->{LC_CTYPE} = $self->{term}->locale;	1965	$env->{LC_CTYPE} = $self->{term}->locale;
1907		1966
1908	urxvt::term->new ($env, "popup",	1967	my $term = urxvt::term->new (
		1968	$env, "popup",
1909	"--perl-lib" => "", "--perl-ext-common" => "",	1969	"--perl-lib" => "", "--perl-ext-common" => "",
1910	"-pty-fd" => -1, "-sl" => 0,	1970	"-pty-fd" => -1, "-sl" => 0,
1911	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1971	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1912	"--transient-for" => $self->{term}->parent,	1972	"--transient-for" => $self->{term}->parent,
1913	"-display" => $self->{term}->display_id,	1973	"-display" => $self->{term}->display_id,
1914	"-pe" => "urxvt-popup")	1974	"-pe" => "urxvt-popup",
1915	or die "unable to create popup window\n";	1975	) or die "unable to create popup window\n";
		1976
		1977	unless (delete $term->{urxvt_popup_init_done}) {
		1978	$term->ungrab;
		1979	$term->destroy;
		1980	die "unable to initialise popup window\n";
		1981	}
1916	}	1982	}
1917		1983
1918	sub DESTROY {	1984	sub DESTROY {
1919	my ($self) = @_;	1985	my ($self) = @_;
1920		1986
…		…
1925	=back	1991	=back
1926		1992
1927	=cut	1993	=cut
1928		1994
1929	package urxvt::watcher;	1995	package urxvt::watcher;
1930
1931	@urxvt::timer::ISA = __PACKAGE__;
1932	@urxvt::iow::ISA = __PACKAGE__;
1933	@urxvt::pw::ISA = __PACKAGE__;
1934	@urxvt::iw::ISA = __PACKAGE__;
1935		1996
1936	=head2 The C<urxvt::timer> Class	1997	=head2 The C<urxvt::timer> Class
1937		1998
1938	This class implements timer watchers/events. Time is represented as a	1999	This class implements timer watchers/events. Time is represented as a
1939	fractional number of seconds since the epoch. Example:	2000	fractional number of seconds since the epoch. Example:
…		…
1943	->new	2004	->new
1944	->interval (1)	2005	->interval (1)
1945	->cb (sub {	2006	->cb (sub {
1946	$term->{overlay}->set (0, 0,	2007	$term->{overlay}->set (0, 0,
1947	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2008	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1948	});	2009	});
1949		2010
1950	=over 4	2011	=over 4
1951		2012
1952	=item $timer = new urxvt::timer	2013	=item $timer = new urxvt::timer
1953		2014
…		…
1956		2017
1957	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2018	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1958		2019
1959	Set the callback to be called when the timer triggers.	2020	Set the callback to be called when the timer triggers.
1960		2021
1961	=item $tstamp = $timer->at
1962
1963	Return the time this watcher will fire next.
1964
1965	=item $timer = $timer->set ($tstamp)	2022	=item $timer = $timer->set ($tstamp[, $interval])
1966		2023
1967	Set the time the event is generated to $tstamp.	2024	Set the time the event is generated to $tstamp (and optionally specifies a
		2025	new $interval).
1968		2026
1969	=item $timer = $timer->interval ($interval)	2027	=item $timer = $timer->interval ($interval)
1970		2028
1971	Normally (and when C<$interval> is C<0>), the timer will automatically	2029	By default (and when C<$interval> is C<0>), the timer will automatically
1972	stop after it has fired once. If C<$interval> is non-zero, then the timer	2030	stop after it has fired once. If C<$interval> is non-zero, then the timer
1973	is automatically rescheduled at the given intervals.	2031	is automatically rescheduled at the given intervals.
1974		2032
1975	=item $timer = $timer->start	2033	=item $timer = $timer->start
1976		2034
1977	Start the timer.	2035	Start the timer.
1978		2036
1979	=item $timer = $timer->start ($tstamp)	2037	=item $timer = $timer->start ($tstamp[, $interval])
1980		2038
1981	Set the event trigger time to C<$tstamp> and start the timer.	2039	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2040	also replaces the interval.
1982		2041
1983	=item $timer = $timer->after ($delay)	2042	=item $timer = $timer->after ($delay[, $interval])
1984		2043
1985	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1986		2045
1987	=item $timer = $timer->stop	2046	=item $timer = $timer->stop
1988		2047
…		…
1996		2055
1997	$term->{socket} = ...	2056	$term->{socket} = ...
1998	$term->{iow} = urxvt::iow	2057	$term->{iow} = urxvt::iow
1999	->new	2058	->new
2000	->fd (fileno $term->{socket})	2059	->fd (fileno $term->{socket})
2001	->events (urxvt::EVENT_READ)	2060	->events (urxvt::EV_READ)
2002	->start	2061	->start
2003	->cb (sub {	2062	->cb (sub {
2004	my ($iow, $revents) = @_;	2063	my ($iow, $revents) = @_;
2005	# $revents must be 1 here, no need to check	2064	# $revents must be 1 here, no need to check
2006	sysread $term->{socket}, my $buf, 8192	2065	sysread $term->{socket}, my $buf, 8192
…		…
2019	Set the callback to be called when io events are triggered. C<$reventmask>	2078	Set the callback to be called when io events are triggered. C<$reventmask>
2020	is a bitset as described in the C<events> method.	2079	is a bitset as described in the C<events> method.
2021		2080
2022	=item $iow = $iow->fd ($fd)	2081	=item $iow = $iow->fd ($fd)
2023		2082
2024	Set the filedescriptor (not handle) to watch.	2083	Set the file descriptor (not handle) to watch.
2025		2084
2026	=item $iow = $iow->events ($eventmask)	2085	=item $iow = $iow->events ($eventmask)
2027		2086
2028	Set the event mask to watch. The only allowed values are	2087	Set the event mask to watch. The only allowed values are
2029	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2088	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2030	together, or C<urxvt::EVENT_NONE>.	2089	together, or C<urxvt::EV_NONE>.
2031		2090
2032	=item $iow = $iow->start	2091	=item $iow = $iow->start
2033		2092
2034	Start watching for requested events on the given handle.	2093	Start watching for requested events on the given handle.
2035		2094
2036	=item $iow = $iow->stop	2095	=item $iow = $iow->stop
2037		2096
2038	Stop watching for events on the given filehandle.	2097	Stop watching for events on the given file handle.
2039		2098
2040	=back	2099	=back
2041		2100
2042	=head2 The C<urxvt::iw> Class	2101	=head2 The C<urxvt::iw> Class
2043		2102
…		…
2076	->new	2135	->new
2077	->start ($pid)	2136	->start ($pid)
2078	->cb (sub {	2137	->cb (sub {
2079	my ($pw, $exit_status) = @_;	2138	my ($pw, $exit_status) = @_;
2080	...	2139	...
2081	});	2140	});
2082		2141
2083	=over 4	2142	=over 4
2084		2143
2085	=item $pw = new urxvt::pw	2144	=item $pw = new urxvt::pw
2086		2145
…		…
2090		2149
2091	Set the callback to be called when the timer triggers.	2150	Set the callback to be called when the timer triggers.
2092		2151
2093	=item $pw = $timer->start ($pid)	2152	=item $pw = $timer->start ($pid)
2094		2153
2095	Tells the wqtcher to start watching for process C<$pid>.	2154	Tells the watcher to start watching for process C<$pid>.
2096		2155
2097	=item $pw = $pw->stop	2156	=item $pw = $pw->stop
2098		2157
2099	Stop the watcher.	2158	Stop the watcher.
2100		2159
…		…
2113		2172
2114	=item >= 3 - script loading and management	2173	=item >= 3 - script loading and management
2115		2174
2116	=item >=10 - all called hooks	2175	=item >=10 - all called hooks
2117		2176
2118	=item >=11 - hook reutrn values	2177	=item >=11 - hook return values
2119		2178
2120	=back	2179	=back
2121		2180
2122	=head1 AUTHOR	2181	=head1 AUTHOR
2123		2182
2124	Marc Lehmann <pcg@goof.com>	2183	Marc Lehmann <schmorp@schmorp.de>
2125	http://software.schmorp.de/pkg/rxvt-unicode	2184	http://software.schmorp.de/pkg/rxvt-unicode
2126		2185
2127	=cut	2186	=cut
2128		2187
2129	1	2188	1
		2189
		2190	# vim: sw=3:

Diff Legend

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