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.153 by root, Sat Jun 2 05:23:11 2007 UTC vs.
Revision 1.252 by root, Sat Dec 27 19:27:42 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	Every time a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions may add additional resources and C<actions>, i.e., methods
45		49	which can be bound to a key and invoked by the user. An extension can
46	=item selection (enabled by default)	50	define the resources it support using so called META comments,
47		51	described below. Similarly to builtin resources, extension resources
48	(More) intelligent selection. This extension tries to be more intelligent	52	can also be specified on the command line as long options (with C<.>
49	when the user extends selections (double-click and further clicks). Right	53	replaced by C<->), in which case the corresponding extension is loaded
50	now, it tries to select words, urls and complete shell-quoted	54	automatically. For this to work the extension B<must> define META
51	arguments, which is very convenient, too, if your F<ls> supports	55	comments for its resources.
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 following 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 whether 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 referred 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 matcher
246
247	Uses per-line display filtering (C<on_line_update>) to underline text
248	matching a certain pattern and make it clickable. When clicked with the
249	mouse button specified in the C<matcher.button> resource (default 2, or
250	middle), the program specified in the C<matcher.launcher> resource
251	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
252	with the matched text as first argument. The default configuration is
253	suitable for matching URLs and launching a web browser, like the
254	former "mark-urls" extension.
255
256	The default pattern to match URLs can be overridden with the
257	C<matcher.pattern.0> resource, and additional patterns can be specified
258	with numbered patterns, in a manner similar to the "selection" extension.
259	The launcher can also be overridden on a per-pattern basis.
260
261	Example configuration:
262
263	URxvt.perl-ext: default,matcher
264	URxvt.urlLauncher: sensible-browser
265	URxvt.keysym.C-Delete: perl:matcher
266	URxvt.matcher.button: 1
267	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
268	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
269	URxvt.matcher.launcher.2: gvim +$2 $1
270
271	=item xim-onthespot
272
273	This (experimental) perl extension implements OnTheSpot editing. It does
274	not work perfectly, and some input methods don't seem to work well with
275	OnTheSpot editing in general, but it seems to work at leats for SCIM and
276	kinput2.
277
278	You enable it by specifying this extension and a preedit style of
279	C<OnTheSpot>, i.e.:
280
281	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
282
283	=item kuake<hotkey>
284
285	A very primitive quake-console-like extension. It was inspired by a
286	description of how the programs C<kuake> and C<yakuake> work: Whenever the
287	user presses a global accelerator key (by default C<F10>), the terminal
288	will show or hide itself. Another press of the accelerator key will hide
289	or show it again.
290
291	Initially, the window will not be shown when using this extension.
292
293	This is useful if you need a single terminal thats not using any desktop
294	space most of the time but is quickly available at the press of a key.
295
296	The accelerator key is grabbed regardless of any modifiers, so this
297	extension will actually grab a physical key just for this function.
298
299	If you want a quake-like animation, tell your window manager to do so
300	(fvwm can do it).
301
302	=item automove-background
303
304	This is basically a very small extension that dynamically changes the
305	background pixmap offset to the window position, in effect creating the
306	same effect as pseudo transparency with a custom pixmap. No scaling is
307	supported in this mode. Example:
308
309	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
310
311	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
312	shows how this extension can be used to implement an automatically blurred
313	transparent background.
314
315	=item block-graphics-to-ascii
316
317	A not very useful example of filtering all text output to the terminal
318	by replacing all line-drawing characters (U+2500 .. U+259F) by a
319	similar-looking ascii character.
320
321	=item digital-clock
322
323	Displays a digital clock using the built-in overlay.
324
325	=item remote-clipboard
326
327	Somewhat of a misnomer, this extension adds two menu entries to the
328	selection popup that allows one ti run external commands to store the
329	selection somewhere and fetch it again.
330
331	We use it to implement a "distributed selection mechanism", which just
332	means that one command uploads the file to a remote server, and another
333	reads it.
334
335	The commands can be set using the C<URxvt.remote-selection.store> and
336	C<URxvt.remote-selection.fetch> resources. The first should read the
337	selection to store from STDIN (always in UTF-8), the second should provide
338	the selection data on STDOUT (also in UTF-8).
339
340	The defaults (which are likely useless to you) use rsh and cat:
341
342	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
343	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
344
345	=item selection-pastebin
346
347	This is a little rarely useful extension that Uploads the selection as
348	textfile to a remote site (or does other things). (The implementation is
349	not currently secure for use in a multiuser environment as it writes to
350	F</tmp> directly.).
351
352	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
353	i.e.
354
355	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
356
357	Pressing this combination runs a command with C<%> replaced by the name of
358	the textfile. This command can be set via a resource:
359
360	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
361
362	And the default is likely not useful to anybody but the few people around
363	here :)
364
365	The name of the textfile is the hex encoded md5 sum of the selection, so
366	the same content should lead to the same filename.
367
368	After a successful upload the selection will be replaced by the text given
369	in the C<selection-pastebin-url> resource (again, the % is the placeholder
370	for the filename):
371
372	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
373
374	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
375	the double C</> characters as comment start. Use C<\057\057> instead,
376	which works regardless of wether xrdb is used to parse the resource file
377	or not.
378
379	=item example-refresh-hooks
380
381	Displays a very simple digital clock in the upper right corner of the
382	window. Illustrates overwriting the refresh callbacks to create your own
383	overlays or changes.
384
385	=back
386		56
387	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
388		58
389	=head2 General API Considerations	59	=head2 General API Considerations
390		60
…		…
404		74
405	=over 4	75	=over 4
406		76
407	=item $text	77	=item $text
408		78
409	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
410	always represents one screen cell. See L<ROW_t> for a discussion of this format.	80	always represents one screen cell. See L<ROW_t> for a discussion of this format.
411		81
412	=item $string	82	=item $string
413		83
414	A perl text string, with an emphasis on I<text>. It can store all unicode	84	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
418	=item $octets	88	=item $octets
419		89
420	Either binary data or - more common - a text string encoded in a	90	Either binary data or - more common - a text string encoded in a
421	locale-specific way.	91	locale-specific way.
422		92
		93	=item $keysym
		94
		95	an integer that is a valid X11 keysym code. You can convert a string
		96	into a keysym and viceversa by using C<XStringToKeysym> and
		97	C<XKeysymToString>.
		98
423	=back	99	=back
424		100
425	=head2 Extension Objects	101	=head2 Extension Objects
426		102
427	Every perl extension is a perl class. A separate perl object is created	103	Every perl extension is a perl class. A separate perl object is created
428	for each terminal, and each terminal has its own set of extenion objects,	104	for each terminal, and each terminal has its own set of extension objects,
429	which are passed as the first parameter to hooks. So extensions can use	105	which are passed as the first parameter to hooks. So extensions can use
430	their C<$self> object without having to think about clashes with other	106	their C<$self> object without having to think about clashes with other
431	extensions or other terminals, with the exception of methods and members	107	extensions or other terminals, with the exception of methods and members
432	that begin with an underscore character C<_>: these are reserved for	108	that begin with an underscore character C<_>: these are reserved for
433	internal use.	109	internal use.
434		110
435	Although it isn't a C<urxvt::term> object, you can call all methods of the	111	Although it isn't a C<urxvt::term> object, you can call all methods of the
436	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
437		113
438	It has the following methods and data members:	114	Additional methods only supported for extension objects are described in
		115	the C<urxvt::extension> section below.
		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata.
		121
		122	Currently, it recognises only one such comment:
439		123
440	=over 4	124	=over 4
441		125
442	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
443		127
444	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
445	extension. This member I<must not> be changed in any way.	129	C<name> is the resource name, C<type> is the resource type, C<boolean>
446		130	or C<string>, and C<desc> is the resource description.
447	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
448
449	Dynamically enable the given hooks (named without the C<on_> prefix) for
450	this extension, replacing any previous hook. This is useful when you want
451	to overwrite time-critical hooks only temporarily.
452
453	=item $self->disable ($hook_name[, $hook_name..])
454
455	Dynamically disable the given hooks.
456		131
457	=back	132	=back
458		133
459	=head2 Hooks	134	=head2 Hooks
460		135
…		…
548		223
549	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	224	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
550	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	225	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
551	number of lines that will be in the scrollback buffer.	226	number of lines that will be in the scrollback buffer.
552		227
553	=item on_osc_seq $term, $op, $args	228	=item on_osc_seq $term, $op, $args, $resp
554		229
555	Called on every OSC sequence and can be used to suppress it or modify its	230	Called on every OSC sequence and can be used to suppress it or modify its
556	behaviour. The default should be to return an empty list. A true value	231	behaviour. The default should be to return an empty list. A true value
557	suppresses execution of the request completely. Make sure you don't get	232	suppresses execution of the request completely. Make sure you don't get
558	confused by recursive invocations when you output an osc sequence within	233	confused by recursive invocations when you output an OSC sequence within
559	this callback.	234	this callback.
560		235
561	C<on_osc_seq_perl> should be used for new behaviour.	236	C<on_osc_seq_perl> should be used for new behaviour.
562		237
563	=item on_osc_seq_perl $term, $string	238	=item on_osc_seq_perl $term, $args, $resp
564		239
565	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	240	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
566	operating system command) is processed. Cursor position and other state	241	operating system command) is processed. Cursor position and other state
567	information is up-to-date when this happens. For interoperability, the	242	information is up-to-date when this happens. For interoperability, the
568	string should start with the extension name and a colon, to distinguish	243	string should start with the extension name (sans -osc) and a semicolon,
569	it from commands for other extensions, and this might be enforced in the	244	to distinguish it from commands for other extensions, and this might be
570	future.	245	enforced in the future.
		246
		247	For example, C<overlay-osc> uses this:
		248
		249	sub on_osc_seq_perl {
		250	my ($self, $osc, $resp) = @_;
		251
		252	return unless $osc =~ s/^overlay;//;
		253
		254	... process remaining $osc string
		255	}
571		256
572	Be careful not ever to trust (in a security sense) the data you receive,	257	Be careful not ever to trust (in a security sense) the data you receive,
573	as its source can not easily be controlled (e-mail content, messages from	258	as its source can not easily be controlled (e-mail content, messages from
574	other users on the same system etc.).	259	other users on the same system etc.).
		260
		261	For responses, C<$resp> contains the end-of-args separator used by the
		262	sender.
575		263
576	=item on_add_lines $term, $string	264	=item on_add_lines $term, $string
577		265
578	Called whenever text is about to be output, with the text as argument. You	266	Called whenever text is about to be output, with the text as argument. You
579	can filter/change and output the text yourself by returning a true value	267	can filter/change and output the text yourself by returning a true value
…		…
584	=item on_tt_write $term, $octets	272	=item on_tt_write $term, $octets
585		273
586	Called whenever some data is written to the tty/pty and can be used to	274	Called whenever some data is written to the tty/pty and can be used to
587	suppress or filter tty input.	275	suppress or filter tty input.
588		276
		277	=item on_tt_paste $term, $octets
		278
		279	Called whenever text is about to be pasted, with the text as argument. You
		280	can filter/change and paste the text yourself by returning a true value
		281	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		282	locale-encoded.
		283
589	=item on_line_update $term, $row	284	=item on_line_update $term, $row
590		285
591	Called whenever a line was updated or changed. Can be used to filter	286	Called whenever a line was updated or changed. Can be used to filter
592	screen output (e.g. underline urls or other useless stuff). Only lines	287	screen output (e.g. underline urls or other useless stuff). Only lines
593	that are being shown will be filtered, and, due to performance reasons,	288	that are being shown will be filtered, and, due to performance reasons,
…		…
600	later with the already-modified line (e.g. if unrelated parts change), so	295	later with the already-modified line (e.g. if unrelated parts change), so
601	you cannot just toggle rendition bits, but only set them.	296	you cannot just toggle rendition bits, but only set them.
602		297
603	=item on_refresh_begin $term	298	=item on_refresh_begin $term
604		299
605	Called just before the screen gets redrawn. Can be used for overlay	300	Called just before the screen gets redrawn. Can be used for overlay or
606	or similar effects by modify terminal contents in refresh_begin, and	301	similar effects by modifying the terminal contents in refresh_begin, and
607	restoring them in refresh_end. The built-in overlay and selection display	302	restoring them in refresh_end. The built-in overlay and selection display
608	code is run after this hook, and takes precedence.	303	code is run after this hook, and takes precedence.
609		304
610	=item on_refresh_end $term	305	=item on_refresh_end $term
611		306
612	Called just after the screen gets redrawn. See C<on_refresh_begin>.	307	Called just after the screen gets redrawn. See C<on_refresh_begin>.
613		308
		309	=item on_action $term, $string
		310
		311	Called whenever an action is invoked for the corresponding extension
		312	(e.g. via a C<extension:string> builtin action bound to a key, see
		313	description of the B<keysym> resource in the urxvt(1) manpage). The
		314	event is simply the action string. Note that an action event is always
		315	associated to a single extension.
		316
614	=item on_user_command $term, $string	317	=item on_user_command $term, $string *DEPRECATED*
615		318
616	Called whenever a user-configured event is being activated (e.g. via	319	Called whenever a user-configured event is being activated (e.g. via
617	a C<perl:string> action bound to a key, see description of the B<keysym>	320	a C<perl:string> action bound to a key, see description of the B<keysym>
618	resource in the @@RXVT_NAME@@(1) manpage).	321	resource in the urxvt(1) manpage).
619		322
620	The event is simply the action string. This interface is assumed to change	323	The event is simply the action string. This interface is going away in
621	slightly in the future.	324	preference to the C<on_action> hook.
622		325
623	=item on_resize_all_windows $tern, $new_width, $new_height	326	=item on_resize_all_windows $term, $new_width, $new_height
624		327
625	Called just after the new window size has been calculated, but before	328	Called just after the new window size has been calculated, but before
626	windows are actually being resized or hints are being set. If this hook	329	windows are actually being resized or hints are being set. If this hook
627	returns TRUE, setting of the window hints is being skipped.	330	returns a true value, setting of the window hints is being skipped.
628		331
629	=item on_x_event $term, $event	332	=item on_x_event $term, $event
630		333
631	Called on every X event received on the vt window (and possibly other	334	Called on every X event received on the vt window (and possibly other
632	windows). Should only be used as a last resort. Most event structure	335	windows). Should only be used as a last resort. Most event structure
…		…
662		365
663	=item on_map_notify $term, $event	366	=item on_map_notify $term, $event
664		367
665	=item on_unmap_notify $term, $event	368	=item on_unmap_notify $term, $event
666		369
667	Called whenever the corresponding X event is received for the terminal If	370	Called whenever the corresponding X event is received for the terminal. If
668	the hook returns true, then the even will be ignored by rxvt-unicode.	371	the hook returns true, then the event will be ignored by rxvt-unicode.
669		372
670	The event is a hash with most values as named by Xlib (see the XEvent	373	The event is a hash with most values as named by Xlib (see the XEvent
671	manpage), with the additional members C<row> and C<col>, which are the	374	manpage), with the additional members C<row> and C<col>, which are the
672	(real, not screen-based) row and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
673		376
674	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
675	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
676		379
677	subwindow.
678
679	=item on_client_message $term, $event	380	=item on_client_message $term, $event
680		381
681	=item on_wm_protocols $term, $event	382	=item on_wm_protocols $term, $event
682		383
683	=item on_wm_delete_window $term, $event	384	=item on_wm_delete_window $term, $event
684		385
685	Called when various types of ClientMessage events are received (all with	386	Called when various types of ClientMessage events are received (all with
686	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	387	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
687		388
		389	=item on_bell $term
		390
		391	Called on receipt of a bell character.
		392
688	=back	393	=back
689		394
690	=cut	395	=cut
691		396
692	package urxvt;	397	package urxvt;
693		398
694	use utf8;	399	use utf8;
695	use strict;	400	use strict 'vars';
696	use Carp ();	401	use Carp ();
697	use Scalar::Util ();	402	use Scalar::Util ();
698	use List::Util ();	403	use List::Util ();
699		404
700	our $VERSION = 1;	405	our $VERSION = 1;
701	our $TERM;	406	our $TERM;
702	our @TERM_INIT;	407	our @TERM_INIT; # should go, prevents async I/O etc.
703	our @TERM_EXT;	408	our @TERM_EXT; # should go, prevents async I/O etc.
704	our @HOOKNAME;	409	our @HOOKNAME;
705	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	410	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
706	our %OPTION;	411	our %OPTION;
707		412
708	our $LIBDIR;	413	our $LIBDIR;
…		…
756		461
757	=over 4	462	=over 4
758		463
759	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
760		465
761	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
762	costs! The only time this is acceptable is when the terminal process	467	include a trailing newline). Avoid at all costs! The only time this
763	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
764		470
765	=item urxvt::warn $string	471	=item urxvt::warn $string
766		472
767	Calls C<rxvt_warn> with the given string which should not include a	473	Calls C<rxvt_warn> with the given string which should include a trailing
768	newline. The module also overwrites the C<warn> builtin with a function	474	newline. The module also overwrites the C<warn> builtin with a function
769	that calls this function.	475	that calls this function.
770		476
771	Using this function has the advantage that its output ends up in the	477	Using this function has the advantage that its output ends up in the
772	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
776	=item @terms = urxvt::termlist	482	=item @terms = urxvt::termlist
777		483
778	Returns all urxvt::term objects that exist in this process, regardless of	484	Returns all urxvt::term objects that exist in this process, regardless of
779	whether they are started, being destroyed etc., so be careful. Only term	485	whether they are started, being destroyed etc., so be careful. Only term
780	objects that have perl extensions attached will be returned (because there	486	objects that have perl extensions attached will be returned (because there
781	is no urxvt::term objet associated with others).	487	is no urxvt::term object associated with others).
782		488
783	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
784		490
785	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
786		492
…		…
829		535
830	=item $rend = urxvt::OVERLAY_RSTYLE	536	=item $rend = urxvt::OVERLAY_RSTYLE
831		537
832	Return the rendition mask used for overlays by default.	538	Return the rendition mask used for overlays by default.
833		539
834	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	540	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		541	urxvt::RS_RVid, urxvt::RS_Uline
835		542
836	Return the bit that enabled bold, italic, blink, reverse-video and	543	Return the bit that enabled bold, italic, blink, reverse-video and
837	underline, respectively. To enable such a style, just logically OR it into	544	underline, respectively. To enable such a style, just logically OR it into
838	the bitset.	545	the bitset.
839		546
…		…
876	};	583	};
877	}	584	}
878		585
879	no warnings 'utf8';	586	no warnings 'utf8';
880		587
		588	sub parse_resource {
		589	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		590
		591	$term->scan_extensions;
		592
		593	my $r = $term->{meta}{resource};
		594	keys %$r; # reset iterator
		595	while (my ($k, $v) = each %$r) {
		596	my $pattern = $k;
		597	$pattern =~ y/./-/ if $isarg;
		598	my $prefix = $name;
		599	my $suffix;
		600	if ($pattern =~ /\-$/) {
		601	$prefix = substr $name, 0, length $pattern;
		602	$suffix = substr $name, length $pattern;
		603	}
		604	if ($pattern eq $prefix) {
		605	$name = "$urxvt::RESCLASS.$k$suffix";
		606
		607	push @{ $term->{perl_ext_3} }, $v->[0];
		608
		609	if ($v->[1] eq "boolean") {
		610	$term->put_option_db ($name, $flag ? "true" : "false");
		611	return 1;
		612	} else {
		613	$term->put_option_db ($name, $value);
		614	return 1 + 2;
		615	}
		616	}
		617	}
		618
		619	0
		620	}
		621
		622	sub usage {
		623	my ($term, $usage_type) = @_;
		624
		625	$term->scan_extensions;
		626
		627	my $r = $term->{meta}{resource};
		628
		629	for my $pattern (sort keys %$r) {
		630	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		631
		632	$desc .= " (-pe $ext)";
		633
		634	if ($usage_type == 1) {
		635	$pattern =~ y/./-/;
		636	$pattern =~ s/-$/-.../g;
		637
		638	if ($type eq "boolean") {
		639	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		640	} else {
		641	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		642	}
		643	} else {
		644	$pattern =~ s/\.$/.*/g;
		645	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		646	}
		647	}
		648	}
		649
881	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	650	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
882		651
883	sub verbose {	652	sub verbose {
884	my ($level, $msg) = @_;	653	my ($level, $msg) = @_;
885	warn "$msg\n" if $level <= $verbosity;	654	warn "$msg\n" if $level <= $verbosity;
…		…
897	$pkg =~ s/[^[:word:]]/_/g;	666	$pkg =~ s/[^[:word:]]/_/g;
898	$pkg = "urxvt::ext::$pkg";	667	$pkg = "urxvt::ext::$pkg";
899		668
900	verbose 3, "loading extension '$path' into package '$pkg'";	669	verbose 3, "loading extension '$path' into package '$pkg'";
901		670
		671	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		672
902	open my $fh, "<:raw", $path	673	open my $fh, "<:raw", $path
903	or die "$path: $!";	674	or die "$path: $!";
904		675
905	my $source =	676	my $source =
906	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	677	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
907	. "#line 1 \"$path\"\n{\n"	678	. "#line 1 \"$path\"\n{\n"
908	. (do { local $/; <$fh> })	679	. (do { local $/; <$fh> })
909	. "\n};\n1";	680	. "\n};\n1";
910		681
911	eval $source	682	eval $source
…		…
920	# called by the rxvt core	691	# called by the rxvt core
921	sub invoke {	692	sub invoke {
922	local $TERM = shift;	693	local $TERM = shift;
923	my $htype = shift;	694	my $htype = shift;
924		695
925	if ($htype == 0) { # INIT	696	if ($htype == HOOK_INIT) {
926	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	697	my @dirs = $TERM->perl_libdirs;
927		698
		699	$TERM->scan_extensions;
		700
928	my %ext_arg;	701	my %ext_arg;
929		702
930	{	703	{
931	my @init = @TERM_INIT;	704	my @init = @TERM_INIT;
932	@TERM_INIT = ();	705	@TERM_INIT = ();
…		…
934	my @pkg = @TERM_EXT;	707	my @pkg = @TERM_EXT;
935	@TERM_EXT = ();	708	@TERM_EXT = ();
936	$TERM->register_package ($_) for @pkg;	709	$TERM->register_package ($_) for @pkg;
937	}	710	}
938		711
		712	for (
939	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	713	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		714	@{ delete $TERM->{perl_ext_3} }
		715	) {
940	if ($_ eq "default") {	716	if ($_ eq "default") {
		717
		718	$ext_arg{$_} = []
941	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	719	for qw(selection option-popup selection-popup readline searchable-scrollback);
		720
		721	for ($TERM->_keysym_resources) {
		722	next if /^(?:string|command|builtin|builtin-string|perl)/;
		723	next unless /^([A-Za-z0-9_\-]+):/;
		724
		725	my $ext = $1;
		726
		727	$ext_arg{$ext} = [];
		728	}
		729
942	} elsif (/^-(.*)$/) {	730	} elsif (/^-(.*)$/) {
943	delete $ext_arg{$1};	731	delete $ext_arg{$1};
		732
944	} elsif (/^([^<]+)<(.*)>$/) {	733	} elsif (/^([^<]+)<(.*)>$/) {
945	push @{ $ext_arg{$1} }, $2;	734	push @{ $ext_arg{$1} }, $2;
		735
946	} else {	736	} else {
947	$ext_arg{$_} ||= [];	737	$ext_arg{$_} ||= [];
948	}	738	}
949	}	739	}
950		740
…		…
966		756
967	if (my $cb = $TERM->{_hook}[$htype]) {	757	if (my $cb = $TERM->{_hook}[$htype]) {
968	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	758	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
969	if $verbosity >= 10;	759	if $verbosity >= 10;
970		760
		761	if ($htype == HOOK_ACTION) {
		762	# this hook is only sent to the extension with the name
		763	# matching the first arg
		764	my $pkg = shift;
		765	$pkg =~ y/-/_/;
		766	$pkg = "urxvt::ext::$pkg";
		767
		768	$cb = $cb->{$pkg}
		769	or return undef; #TODO: maybe warn user?
		770
		771	$cb = { $pkg => $cb };
		772	}
		773
971	for my $pkg (keys %$cb) {	774	for my $pkg (keys %$cb) {
972	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	775	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
973	$retval ||= $retval_;	776	$retval ||= $retval_;
974		777
975	if ($@) {	778	if ($@) {
976	$TERM->ungrab; # better to lose the grab than the session	779	$TERM->ungrab; # better to lose the grab than the session
977	warn $@;	780	warn $@;
…		…
980		783
981	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	784	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
982	if $verbosity >= 11;	785	if $verbosity >= 11;
983	}	786	}
984		787
985	if ($htype == 1) { # DESTROY	788	if ($htype == HOOK_DESTROY) {
986	# clear package objects	789	# clear package objects
987	%$_ = () for values %{ $TERM->{_pkg} };	790	%$_ = () for values %{ $TERM->{_pkg} };
988		791
989	# clear package	792	# clear package
990	%$TERM = ();	793	%$TERM = ();
…		…
1020	}	823	}
1021	}	824	}
1022	($mask, @color{qw(fg bg)}, \@failed)	825	($mask, @color{qw(fg bg)}, \@failed)
1023	}	826	}
1024		827
1025	# urxvt::term::extension
1026
1027	package urxvt::term::extension;	828	package urxvt::term::extension;
1028		829
1029	sub enable {	830	=head2 The C<urxvt::term::extension> class
1030	my ($self, %hook) = @_;
1031	my $pkg = $self->{_pkg};
1032		831
1033	while (my ($name, $cb) = each %hook) {	832	Each extension attached to a terminal object is represented by
1034	my $htype = $HOOKTYPE{uc $name};	833	a C<urxvt::term::extension> object.
1035	defined $htype
1036	or Carp::croak "unsupported hook type '$name'";
1037		834
1038	$self->set_should_invoke ($htype, +1)	835	You can use these objects, which are passed to all callbacks to store any
1039	unless exists $self->{term}{_hook}[$htype]{$pkg};	836	state related to the terminal and extension instance.
1040		837
1041	$self->{term}{_hook}[$htype]{$pkg} = $cb;	838	The methods (And data members) documented below can be called on extension
1042	}	839	objects, in addition to call methods documented for the <urxvt::term>
1043	}	840	class.
1044		841
1045	sub disable {	842	=over 4
1046	my ($self, @hook) = @_;
1047	my $pkg = $self->{_pkg};
1048		843
1049	for my $name (@hook) {	844	=item $urxvt_term = $self->{term}
1050	my $htype = $HOOKTYPE{uc $name};
1051	defined $htype
1052	or Carp::croak "unsupported hook type '$name'";
1053		845
1054	$self->set_should_invoke ($htype, -1)	846	Returns the C<urxvt::term> object associated with this instance of the
1055	if delete $self->{term}{_hook}[$htype]{$pkg};	847	extension. This member I<must not> be changed in any way.
1056	}	848
1057	}	849	=cut
1058		850
1059	our $AUTOLOAD;	851	our $AUTOLOAD;
1060		852
1061	sub AUTOLOAD {	853	sub AUTOLOAD {
1062	$AUTOLOAD =~ /:([^:]+)$/	854	$AUTOLOAD =~ /:([^:]+)$/
…		…
1075		867
1076	sub DESTROY {	868	sub DESTROY {
1077	# nop	869	# nop
1078	}	870	}
1079		871
1080	# urxvt::destroy_hook	872	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1081		873
1082	sub urxvt::destroy_hook::DESTROY {	874	sub urxvt::destroy_hook::DESTROY {
1083	${$_[0]}->();	875	${$_[0]}->();
1084	}	876	}
1085		877
1086	sub urxvt::destroy_hook(&) {	878	sub urxvt::destroy_hook(&) {
1087	bless \shift, urxvt::destroy_hook::	879	bless \shift, urxvt::destroy_hook::
1088	}	880	}
		881
		882	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		883
		884	Dynamically enable the given hooks (named without the C<on_> prefix) for
		885	this extension, replacing any hook previously installed via C<enable> in
		886	this extension.
		887
		888	This is useful when you want to overwrite time-critical hooks only
		889	temporarily.
		890
		891	To install additional callbacks for the same hook, you can use the C<on>
		892	method of the C<urxvt::term> class.
		893
		894	=item $self->disable ($hook_name[, $hook_name..])
		895
		896	Dynamically disable the given hooks.
		897
		898	=cut
		899
		900	sub enable {
		901	my ($self, %hook) = @_;
		902	my $pkg = $self->{_pkg};
		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	$self->set_should_invoke ($htype, +1)
		910	unless exists $self->{term}{_hook}[$htype]{$pkg};
		911
		912	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		913	}
		914	}
		915
		916	sub disable {
		917	my ($self, @hook) = @_;
		918	my $pkg = $self->{_pkg};
		919
		920	for my $name (@hook) {
		921	my $htype = $HOOKTYPE{uc $name};
		922	defined $htype
		923	or Carp::croak "unsupported hook type '$name'";
		924
		925	$self->set_should_invoke ($htype, -1)
		926	if delete $self->{term}{_hook}[$htype]{$pkg};
		927	}
		928	}
		929
		930	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		931
		932	Similar to the C<enable> enable, but installs additional callbacks for
		933	the given hook(s) (that is, it doesn't replace existing callbacks), and
		934	returns a guard object. When the guard object is destroyed the callbacks
		935	are disabled again.
		936
		937	=cut
		938
		939	sub urxvt::extension::on_disable::DESTROY {
		940	my $disable = shift;
		941
		942	my $term = delete $disable->{""};
		943
		944	while (my ($htype, $id) = each %$disable) {
		945	delete $term->{_hook}[$htype]{$id};
		946	$term->set_should_invoke ($htype, -1);
		947	}
		948	}
		949
		950	sub on {
		951	my ($self, %hook) = @_;
		952
		953	my $term = $self->{term};
		954
		955	my %disable = ( "" => $term );
		956
		957	while (my ($name, $cb) = each %hook) {
		958	my $htype = $HOOKTYPE{uc $name};
		959	defined $htype
		960	or Carp::croak "unsupported hook type '$name'";
		961
		962	$term->set_should_invoke ($htype, +1);
		963	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		964	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		965	}
		966
		967	bless \%disable, "urxvt::extension::on_disable"
		968	}
		969
		970	=item $self->bind_action ($hotkey, $action)
		971
		972	=item $self->x_resource ($pattern)
		973
		974	=item $self->x_resource_boolean ($pattern)
		975
		976	These methods support an additional C<%> prefix for C<$action> or
		977	C<$pattern> when called on an extension object, compared to the
		978	C<urxvt::term> methods of the same name - see the description of these
		979	methods in the C<urxvt::term> class for details.
		980
		981	=cut
		982
		983	sub bind_action {
		984	my ($self, $hotkey, $action) = @_;
		985	$action =~ s/^%:/$_[0]{_name}:/;
		986	$self->{term}->bind_action ($hotkey, $action)
		987	}
		988
		989	sub x_resource {
		990	my ($self, $name) = @_;
		991	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		992	$self->{term}->x_resource ($name)
		993	}
		994
		995	sub x_resource_boolean {
		996	my ($self, $name) = @_;
		997	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		998	$self->{term}->x_resource_boolean ($name)
		999	}
		1000
		1001	=back
		1002
		1003	=cut
1089		1004
1090	package urxvt::anyevent;	1005	package urxvt::anyevent;
1091		1006
1092	=head2 The C<urxvt::anyevent> Class	1007	=head2 The C<urxvt::anyevent> Class
1093		1008
1094	The sole purpose of this class is to deliver an interface to the	1009	The sole purpose of this class is to deliver an interface to the
1095	C<AnyEvent> module - any module using it will work inside urxvt without	1010	C<AnyEvent> module - any module using it will work inside urxvt without
1096	further programming. The only exception is that you cannot wait on	1011	further programming. The only exception is that you cannot wait on
1097	condition variables, but non-blocking condvar use is ok. What this means	1012	condition variables, but non-blocking condvar use is ok.
1098	is that you cannot use blocking APIs, but the non-blocking variant should
1099	work.
1100		1013
1101	=cut	1014	In practical terms this means is that you cannot use blocking APIs, but
		1015	the non-blocking variant should work.
1102		1016
		1017	=cut
		1018
1103	our $VERSION = 1;	1019	our $VERSION = '5.23';
1104		1020
1105	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1021	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1106	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1022	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1107		1023
1108	sub timer {	1024	sub timer {
…		…
1110		1026
1111	my $cb = $arg{cb};	1027	my $cb = $arg{cb};
1112		1028
1113	urxvt::timer	1029	urxvt::timer
1114	->new	1030	->new
1115	->start (urxvt::NOW + $arg{after})	1031	->after ($arg{after}, $arg{interval})
1116	->cb (sub {	1032	->cb ($arg{interval} ? $cb : sub {
1117	$_[0]->stop; # need to cancel manually	1033	$_[0]->stop; # need to cancel manually
1118	$cb->();	1034	$cb->();
1119	})	1035	})
1120	}	1036	}
1121		1037
1122	sub io {	1038	sub io {
1123	my ($class, %arg) = @_;	1039	my ($class, %arg) = @_;
1124		1040
1125	my $cb = $arg{cb};	1041	my $cb = $arg{cb};
		1042	my $fd = fileno $arg{fh};
		1043	defined $fd or $fd = $arg{fh};
1126		1044
1127	bless [$arg{fh}, urxvt::iow	1045	bless [$arg{fh}, urxvt::iow
1128	->new	1046	->new
1129	->fd (fileno $arg{fh})	1047	->fd ($fd)
1130	->events (($arg{poll} =~ /r/ ? 1 : 0)	1048	->events (($arg{poll} =~ /r/ ? 1 : 0)
1131	| ($arg{poll} =~ /w/ ? 2 : 0))	1049	| ($arg{poll} =~ /w/ ? 2 : 0))
1132	->start	1050	->start
1133	->cb (sub {	1051	->cb ($cb)
1134	$cb->(($_[1] & 1 ? 'r' : '')
1135	. ($_[1] & 2 ? 'w' : ''));
1136	})],
1137	urxvt::anyevent::	1052	], urxvt::anyevent::
		1053	}
		1054
		1055	sub idle {
		1056	my ($class, %arg) = @_;
		1057
		1058	my $cb = $arg{cb};
		1059
		1060	urxvt::iw
		1061	->new
		1062	->start
		1063	->cb ($cb)
		1064	}
		1065
		1066	sub child {
		1067	my ($class, %arg) = @_;
		1068
		1069	my $cb = $arg{cb};
		1070
		1071	urxvt::pw
		1072	->new
		1073	->start ($arg{pid})
		1074	->cb (sub {
		1075	$_[0]->stop; # need to cancel manually
		1076	$cb->($_[0]->rpid, $_[0]->rstatus);
		1077	})
1138	}	1078	}
1139		1079
1140	sub DESTROY {	1080	sub DESTROY {
1141	$_[0][1]->stop;	1081	$_[0][1]->stop;
1142	}	1082	}
1143		1083
1144	sub condvar {	1084	# only needed for AnyEvent < 6 compatibility
1145	bless \my $flag, urxvt::anyevent::
1146	}
1147
1148	sub broadcast {
1149	${$_[0]}++;
1150	}
1151
1152	sub wait {
1153	unless (${$_[0]}) {
1154	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1155	}
1156	}
1157
1158	sub one_event {	1085	sub one_event {
1159	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1086	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1160	}	1087	}
1161		1088
1162	package urxvt::term;	1089	package urxvt::term;
…		…
1177	urxvt::verbose 6, "register package $pkg to $self";	1104	urxvt::verbose 6, "register package $pkg to $self";
1178		1105
1179	@{"$pkg\::ISA"} = urxvt::term::extension::;	1106	@{"$pkg\::ISA"} = urxvt::term::extension::;
1180		1107
1181	my $proxy = bless {	1108	my $proxy = bless {
1182	_pkg => $pkg,	1109	_pkg => $pkg,
		1110	_name => ${"$pkg\::_NAME"}, # hackish
1183	argv => $argv,	1111	argv => $argv,
1184	}, $pkg;	1112	}, $pkg;
1185	Scalar::Util::weaken ($proxy->{term} = $self);	1113	Scalar::Util::weaken ($proxy->{term} = $self);
1186		1114
1187	$self->{_pkg}{$pkg} = $proxy;	1115	$self->{_pkg}{$pkg} = $proxy;
1188		1116
…		…
1191	$proxy->enable ($name => $ref);	1119	$proxy->enable ($name => $ref);
1192	}	1120	}
1193	}	1121	}
1194	}	1122	}
1195		1123
		1124	sub perl_libdirs {
		1125	map { split /:/ }
		1126	$_[0]->resource ("perl_lib"),
		1127	$ENV{URXVT_PERL_LIB},
		1128	"$ENV{HOME}/.urxvt/ext",
		1129	"$LIBDIR/perl"
		1130	}
		1131
		1132	# scan for available extensions and collect their metadata
		1133	sub scan_extensions {
		1134	my ($self) = @_;
		1135
		1136	return if exists $self->{meta};
		1137
		1138	my @urxvtdirs = perl_libdirs $self;
		1139	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1140
		1141	$self->{meta} = \my %meta;
		1142
		1143	# first gather extensions
		1144
		1145	my $gather = sub {
		1146	my ($dir, $core) = @_;
		1147
		1148	opendir my $fh, $dir
		1149	or return;
		1150
		1151	for my $ext (readdir $fh) {
		1152	$ext !~ /^\./
		1153	or next;
		1154
		1155	open my $fh, "<", "$dir/$ext"
		1156	or next;
		1157
		1158	-f $fh
		1159	or next;
		1160
		1161	$ext =~ s/\.uext$// or $core
		1162	or next;
		1163
		1164	my %ext = (dir => $dir);
		1165
		1166	while (<$fh>) {
		1167	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1168	my ($pattern, $type, $desc) = split /:/, $1;
		1169	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1170	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1171	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1172	} else {
		1173	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1174	}
		1175	} elsif (/^\s*(?:#|$)/) {
		1176	# skip other comments and empty lines
		1177	} else {
		1178	last; # stop parsing on first non-empty non-comment line
		1179	}
		1180	}
		1181
		1182	$meta{ext}{$ext} = \%ext;
		1183	}
		1184	};
		1185
		1186	# $gather->($_, 0) for @cpandirs;
		1187	$gather->($_, 1) for @urxvtdirs;
		1188
		1189	# and now merge resources
		1190
		1191	$meta{resource} = \my %resource;
		1192
		1193	while (my ($k, $v) = each %{ $meta{ext} }) {
		1194	#TODO: should check for extensions overriding each other
		1195	%resource = (%resource, %{ $v->{resource} });
		1196	}
		1197	}
		1198
1196	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1199	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1197		1200
1198	Creates a new terminal, very similar as if you had started it with system	1201	Creates a new terminal, very similar as if you had started it with system
1199	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1202	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1200	hash which defines the environment of the new terminal.	1203	hash which defines the environment of the new terminal.
…		…
1217	}	1220	}
1218		1221
1219	=item $term->destroy	1222	=item $term->destroy
1220		1223
1221	Destroy the terminal object (close the window, free resources	1224	Destroy the terminal object (close the window, free resources
1222	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1225	etc.). Please note that urxvt will not exit as long as any event
1223	watchers (timers, io watchers) are still active.	1226	watchers (timers, io watchers) are still active.
1224		1227
1225	=item $term->exec_async ($cmd[, @args])	1228	=item $term->exec_async ($cmd[, @args])
1226		1229
1227	Works like the combination of the C<fork>/C<exec> builtins, which executes	1230	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1254	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1257	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1255		1258
1256	Here is a likely non-exhaustive list of option names, please see the	1259	Here is a likely non-exhaustive list of option names, please see the
1257	source file F</src/optinc.h> to see the actual list:	1260	source file F</src/optinc.h> to see the actual list:
1258		1261
1259	borderLess console cursorBlink cursorUnderline hold iconic insecure	1262	borderLess buffered console cursorBlink cursorUnderline hold iconic
1260	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1263	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1261	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1264	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1262	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1265	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1263	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1266	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1264	transparent tripleclickwords utmpInhibit visualBell	1267	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1268	urgentOnBell utmpInhibit visualBell
1265		1269
1266	=item $value = $term->resource ($name[, $newval])	1270	=item $value = $term->resource ($name[, $newval])
1267		1271
1268	Returns the current resource value associated with a given name and	1272	Returns the current resource value associated with a given name and
1269	optionally sets a new value. Setting values is most useful in the C<init>	1273	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1282		1286
1283	Here is a likely non-exhaustive list of resource names, not all of which	1287	Here is a likely non-exhaustive list of resource names, not all of which
1284	are supported in every build, please see the source file F</src/rsinc.h>	1288	are supported in every build, please see the source file F</src/rsinc.h>
1285	to see the actual list:	1289	to see the actual list:
1286		1290
1287	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1291	answerbackstring backgroundPixmap backspace_key blurradius
1288	borderLess color cursorBlink cursorUnderline cutchars delete_key	1292	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1289	display_name embed ext_bwidth fade font geometry hold iconName	1293	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1290	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1294	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1295	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1291	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1296	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1292	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1297	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1293	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1298	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1294	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1299	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1295	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1300	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1296	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1301	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1297	secondaryScreen secondaryScroll selectstyle shade term_name title	1302	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1298	transient_for transparent transparent_all tripleclickwords utmpInhibit	1303	term_name title transient_for transparent tripleclickwords urgentOnBell
1299	visualBell	1304	utmpInhibit visualBell
1300		1305
1301	=cut	1306	=cut
1302		1307
1303	sub resource($$;$) {	1308	sub resource($$;$) {
1304	my ($self, $name) = (shift, shift);	1309	my ($self, $name) = (shift, shift);
1305	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1310	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1306	&urxvt::term::_resource	1311	goto &urxvt::term::_resource
1307	}	1312	}
1308		1313
1309	=item $value = $term->x_resource ($pattern)	1314	=item $value = $term->x_resource ($pattern)
1310		1315
1311	Returns the X-Resource for the given pattern, excluding the program or	1316	Returns the X-Resource for the given pattern, excluding the program or
1312	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1317	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1313	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1318	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1314	resource with that pattern exists.	1319	resource with that pattern exists.
1315		1320
		1321	Extensions that define extra resources also need to call this method
		1322	to access their values.
		1323
		1324	If the method is called on an extension object (basically, from an
		1325	extension), then the special prefix C<%.> will be replaced by the name of
		1326	the extension and a dot, and the lone string C<%> will be replaced by the
		1327	extension name itself. This makes it possible to code extensions so you
		1328	can rename them and get a new set of resources without having to change
		1329	the actual code.
		1330
1316	This method should only be called during the C<on_start> hook, as there is	1331	This method should only be called during the C<on_start> hook, as there is
1317	only one resource database per display, and later invocations might return	1332	only one resource database per display, and later invocations might return
1318	the wrong resources.	1333	the wrong resources.
1319		1334
1320	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1335	=item $value = $term->x_resource_boolean ($pattern)
1321		1336
		1337	Like C<x_resource>, above, but interprets the string value as a boolean
		1338	and returns C<1> for true values, C<0> for false values and C<undef> if
		1339	the resource or option isn't specified.
		1340
		1341	You should always use this method to parse boolean resources.
		1342
		1343	=cut
		1344
		1345	sub x_resource_boolean {
		1346	my $res = &x_resource;
		1347
		1348	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1349	}
		1350
		1351	=item $success = $term->bind_action ($key, $action)
		1352
1322	Adds a keymap translation exactly as specified via a resource. See the	1353	Adds a key binding exactly as specified via a C<keysym> resource. See the
1323	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1354	C<keysym> resource in the urxvt(1) manpage.
		1355
		1356	To add default bindings for actions, an extension should call C<<
		1357	->bind_action >> in its C<init> hook for every such binding. Doing it
		1358	in the C<init> hook allows users to override or remove the binding
		1359	again.
		1360
		1361	Example: the C<searchable-scrollback> by default binds itself
		1362	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1363	$term->bind_action >>.
		1364
		1365	sub init {
		1366	my ($self) = @_;
		1367
		1368	$self->bind_action ("M-s" => "%:start");
		1369	}
1324		1370
1325	=item $rend = $term->rstyle ([$new_rstyle])	1371	=item $rend = $term->rstyle ([$new_rstyle])
1326		1372
1327	Return and optionally change the current rendition. Text that is output by	1373	Return and optionally change the current rendition. Text that is output by
1328	the terminal application will use this style.	1374	the terminal application will use this style.
…		…
1336		1382
1337	=item ($row, $col) = $term->selection_beg ([$row, $col])	1383	=item ($row, $col) = $term->selection_beg ([$row, $col])
1338		1384
1339	=item ($row, $col) = $term->selection_end ([$row, $col])	1385	=item ($row, $col) = $term->selection_end ([$row, $col])
1340		1386
1341	Return the current values of the selection mark, begin or end positions,	1387	Return the current values of the selection mark, begin or end positions.
1342	and optionally set them to new values.	1388
		1389	When arguments are given, then the selection coordinates are set to
		1390	C<$row> and C<$col>, and the selection screen is set to the current
		1391	screen.
		1392
		1393	=item $screen = $term->selection_screen ([$screen])
		1394
		1395	Returns the current selection screen, and then optionally sets it.
1343		1396
1344	=item $term->selection_make ($eventtime[, $rectangular])	1397	=item $term->selection_make ($eventtime[, $rectangular])
1345		1398
1346	Tries to make a selection as set by C<selection_beg> and	1399	Tries to make a selection as set by C<selection_beg> and
1347	C<selection_end>. If C<$rectangular> is true (default: false), a	1400	C<selection_end>. If C<$rectangular> is true (default: false), a
1348	rectangular selection will be made. This is the prefered function to make	1401	rectangular selection will be made. This is the preferred function to make
1349	a selection.	1402	a selection.
1350		1403
1351	=item $success = $term->selection_grab ($eventtime)	1404	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1352		1405
1353	Try to request the primary selection text from the server (for example, as	1406	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1407	true) selection from the server. The corresponding text can be set
1354	set by the next method). No visual feedback will be given. This function	1408	with the next method. No visual feedback will be given. This function
1355	is mostly useful from within C<on_sel_grab> hooks.	1409	is mostly useful from within C<on_sel_grab> hooks.
1356		1410
1357	=item $oldtext = $term->selection ([$newtext])	1411	=item $oldtext = $term->selection ([$newtext, $clipboard])
1358		1412
1359	Return the current selection text and optionally replace it by C<$newtext>.	1413	Return the current selection (clipboard if C<$clipboard> is true) text
		1414	and optionally replace it by C<$newtext>.
		1415
		1416	=item $term->selection_clear ([$clipboard])
		1417
		1418	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1360		1419
1361	=item $term->overlay_simple ($x, $y, $text)	1420	=item $term->overlay_simple ($x, $y, $text)
1362		1421
1363	Create a simple multi-line overlay box. See the next method for details.	1422	Create a simple multi-line overlay box. See the next method for details.
1364		1423
…		…
1394		1453
1395	The methods currently supported on C<urxvt::overlay> objects are:	1454	The methods currently supported on C<urxvt::overlay> objects are:
1396		1455
1397	=over 4	1456	=over 4
1398		1457
1399	=item $overlay->set ($x, $y, $text, $rend)	1458	=item $overlay->set ($x, $y, $text[, $rend])
1400		1459
1401	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1460	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1402	text in rxvt-unicode's special encoding and an array of rendition values	1461	text in rxvt-unicode's special encoding and an array of rendition values
1403	at a specific position inside the overlay.	1462	at a specific position inside the overlay.
		1463
		1464	If C<$rend> is missing, then the rendition will not be changed.
1404		1465
1405	=item $overlay->hide	1466	=item $overlay->hide
1406		1467
1407	If visible, hide the overlay, but do not destroy it.	1468	If visible, hide the overlay, but do not destroy it.
1408		1469
…		…
1471		1532
1472	=item $term->scr_add_lines ($string)	1533	=item $term->scr_add_lines ($string)
1473		1534
1474	Write the given text string to the screen, as if output by the application	1535	Write the given text string to the screen, as if output by the application
1475	running inside the terminal. It may not contain command sequences (escape	1536	running inside the terminal. It may not contain command sequences (escape
1476	codes), but is free to use line feeds, carriage returns and tabs. The	1537	codes - see C<cmd_parse> for that), but is free to use line feeds,
1477	string is a normal text string, not in locale-dependent encoding.	1538	carriage returns and tabs. The string is a normal text string, not in
		1539	locale-dependent encoding.
1478		1540
1479	Normally its not a good idea to use this function, as programs might be	1541	Normally its not a good idea to use this function, as programs might be
1480	confused by changes in cursor position or scrolling. Its useful inside a	1542	confused by changes in cursor position or scrolling. Its useful inside a
1481	C<on_add_lines> hook, though.	1543	C<on_add_lines> hook, though.
1482		1544
…		…
1490	locale-specific encoding of the terminal and can contain command sequences	1552	locale-specific encoding of the terminal and can contain command sequences
1491	(escape codes) that will be interpreted.	1553	(escape codes) that will be interpreted.
1492		1554
1493	=item $term->tt_write ($octets)	1555	=item $term->tt_write ($octets)
1494		1556
1495	Write the octets given in C<$data> to the tty (i.e. as program input). To	1557	Write the octets given in C<$octets> to the tty (i.e. as user input
		1558	to the program, see C<cmd_parse> for the opposite direction). To pass
1496	pass characters instead of octets, you should convert your strings first	1559	characters instead of octets, you should convert your strings first to the
1497	to the locale-specific encoding using C<< $term->locale_encode >>.	1560	locale-specific encoding using C<< $term->locale_encode >>.
		1561
		1562	=item $term->tt_write_user_input ($octets)
		1563
		1564	Like C<tt_write>, but should be used when writing strings in response to
		1565	the user pressing a key, to invoke the additional actions requested by
		1566	the user for that case (C<tt_write> doesn't do that).
		1567
		1568	The typical use case would be inside C<on_action> hooks.
		1569
		1570	=item $term->tt_paste ($octets)
		1571
		1572	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1573	CR and bracketing the data with control sequences if bracketed paste mode
		1574	is set.
1498		1575
1499	=item $old_events = $term->pty_ev_events ([$new_events])	1576	=item $old_events = $term->pty_ev_events ([$new_events])
1500		1577
1501	Replaces the event mask of the pty watcher by the given event mask. Can	1578	Replaces the event mask of the pty watcher by the given event mask. Can
1502	be used to suppress input and output handling to the pty/tty. See the	1579	be used to suppress input and output handling to the pty/tty. See the
…		…
1521	Adds the specified events to the vt event mask. Useful e.g. when you want	1598	Adds the specified events to the vt event mask. Useful e.g. when you want
1522	to receive pointer events all the times:	1599	to receive pointer events all the times:
1523		1600
1524	$term->vt_emask_add (urxvt::PointerMotionMask);	1601	$term->vt_emask_add (urxvt::PointerMotionMask);
1525		1602
		1603	=item $term->set_urgency ($set)
		1604
		1605	Enable/disable the urgency hint on the toplevel window.
		1606
1526	=item $term->focus_in	1607	=item $term->focus_in
1527		1608
1528	=item $term->focus_out	1609	=item $term->focus_out
1529		1610
1530	=item $term->key_press ($state, $keycode[, $time])	1611	=item $term->key_press ($state, $keycode[, $time])
…		…
1618		1699
1619	Used after changing terminal contents to display them.	1700	Used after changing terminal contents to display them.
1620		1701
1621	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1702	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1622		1703
1623	Returns the text of the entire row with number C<$row_number>. Row C<0>	1704	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1624	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1705	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1625	terminal line. The scrollback buffer starts at line C<-1> and extends to
1626	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1706	terminal line. Nothing will be returned if a nonexistent line
1627	is requested.	1707	is requested.
1628		1708
1629	If C<$new_text> is specified, it will replace characters in the current	1709	If C<$new_text> is specified, it will replace characters in the current
1630	line, starting at column C<$start_col> (default C<0>), which is useful	1710	line, starting at column C<$start_col> (default C<0>), which is useful
1631	to replace only parts of a line. The font index in the rendition will	1711	to replace only parts of a line. The font index in the rendition will
1632	automatically be updated.	1712	automatically be updated.
1633		1713
1634	C<$text> is in a special encoding: tabs and wide characters that use more	1714	C<$text> is in a special encoding: tabs and wide characters that use more
1635	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1715	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1636	characters. Characters with combining characters and other characters that	1716	characters. Characters with combining characters and other characters that
1637	do not fit into the normal tetx encoding will be replaced with characters	1717	do not fit into the normal text encoding will be replaced with characters
1638	in the private use area.	1718	in the private use area.
1639		1719
1640	You have to obey this encoding when changing text. The advantage is	1720	You have to obey this encoding when changing text. The advantage is
1641	that C<substr> and similar functions work on screen cells and not on	1721	that C<substr> and similar functions work on screen cells and not on
1642	characters.	1722	characters.
…		…
1727	}	1807	}
1728		1808
1729	sub urxvt::line::t {	1809	sub urxvt::line::t {
1730	my ($self) = @_;	1810	my ($self) = @_;
1731		1811
1732	if (@_ > 1)	1812	if (@_ > 1) {
1733	{
1734	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1813	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1735	for $self->{beg} .. $self->{end};	1814	for $self->{beg} .. $self->{end};
1736	}	1815	}
1737		1816
1738	defined wantarray &&	1817	defined wantarray &&
1739	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1818	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1740	0, $self->{len}	1819	0, $self->{len}
1741	}	1820	}
1742		1821
1743	sub urxvt::line::r {	1822	sub urxvt::line::r {
1744	my ($self) = @_;	1823	my ($self) = @_;
1745		1824
1746	if (@_ > 1)	1825	if (@_ > 1) {
1747	{
1748	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1826	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1749	for $self->{beg} .. $self->{end};	1827	for $self->{beg} .. $self->{end};
1750	}	1828	}
1751		1829
1752	if (defined wantarray) {	1830	if (defined wantarray) {
1753	my $rend = [	1831	my $rend = [
1754	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1832	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1755	];	1833	];
…		…
1817	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1895	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1818	recent grab.	1896	recent grab.
1819		1897
1820	=item $term->ungrab	1898	=item $term->ungrab
1821		1899
1822	Calls XUngrab for the most recent grab. Is called automatically on	1900	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1823	evaluation errors, as it is better to lose the grab in the error case as	1901	evaluation errors, as it is better to lose the grab in the error case as
1824	the session.	1902	the session.
1825		1903
1826	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1904	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1827		1905
…		…
1829		1907
1830	=item @atoms = $term->XListProperties ($window)	1908	=item @atoms = $term->XListProperties ($window)
1831		1909
1832	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1910	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1833		1911
1834	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1912	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1835		1913
1836	=item $term->XDeleteProperty ($window, $property)	1914	=item $term->XDeleteProperty ($window, $property)
1837		1915
1838	=item $window = $term->DefaultRootWindow	1916	=item $window = $term->DefaultRootWindow
1839		1917
…		…
1846	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1924	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1847		1925
1848	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1926	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1849		1927
1850	=item $term->XChangeInput ($window, $add_events[, $del_events])	1928	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1929
		1930	=item $keysym = $term->XStringToKeysym ($string)
		1931
		1932	=item $string = $term->XKeysymToString ($keysym)
1851		1933
1852	Various X or X-related functions. The C<$term> object only serves as	1934	Various X or X-related functions. The C<$term> object only serves as
1853	the source of the display, otherwise those functions map more-or-less	1935	the source of the display, otherwise those functions map more-or-less
1854	directory onto the X functions of the same name.	1936	directly onto the X functions of the same name.
1855		1937
1856	=back	1938	=back
1857		1939
1858	=cut	1940	=cut
1859		1941
…		…
1961	my $env = $self->{term}->env;	2043	my $env = $self->{term}->env;
1962	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2044	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1963	delete $env->{LC_ALL};	2045	delete $env->{LC_ALL};
1964	$env->{LC_CTYPE} = $self->{term}->locale;	2046	$env->{LC_CTYPE} = $self->{term}->locale;
1965		2047
1966	urxvt::term->new ($env, "popup",	2048	my $term = urxvt::term->new (
		2049	$env, "popup",
1967	"--perl-lib" => "", "--perl-ext-common" => "",	2050	"--perl-lib" => "", "--perl-ext-common" => "",
1968	"-pty-fd" => -1, "-sl" => 0,	2051	"-pty-fd" => -1, "-sl" => 0,
1969	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2052	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1970	"--transient-for" => $self->{term}->parent,	2053	"--transient-for" => $self->{term}->parent,
1971	"-display" => $self->{term}->display_id,	2054	"-display" => $self->{term}->display_id,
1972	"-pe" => "urxvt-popup")	2055	"-pe" => "urxvt-popup",
1973	or die "unable to create popup window\n";	2056	) or die "unable to create popup window\n";
		2057
		2058	unless (delete $term->{urxvt_popup_init_done}) {
		2059	$term->ungrab;
		2060	$term->destroy;
		2061	die "unable to initialise popup window\n";
		2062	}
1974	}	2063	}
1975		2064
1976	sub DESTROY {	2065	sub DESTROY {
1977	my ($self) = @_;	2066	my ($self) = @_;
1978		2067
…		…
1996	->new	2085	->new
1997	->interval (1)	2086	->interval (1)
1998	->cb (sub {	2087	->cb (sub {
1999	$term->{overlay}->set (0, 0,	2088	$term->{overlay}->set (0, 0,
2000	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2089	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2001	});	2090	});
2002		2091
2003	=over 4	2092	=over 4
2004		2093
2005	=item $timer = new urxvt::timer	2094	=item $timer = new urxvt::timer
2006		2095
…		…
2009		2098
2010	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2099	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011		2100
2012	Set the callback to be called when the timer triggers.	2101	Set the callback to be called when the timer triggers.
2013		2102
2014	=item $tstamp = $timer->at
2015
2016	Return the time this watcher will fire next.
2017
2018	=item $timer = $timer->set ($tstamp)	2103	=item $timer = $timer->set ($tstamp[, $interval])
2019		2104
2020	Set the time the event is generated to $tstamp.	2105	Set the time the event is generated to $tstamp (and optionally specifies a
		2106	new $interval).
2021		2107
2022	=item $timer = $timer->interval ($interval)	2108	=item $timer = $timer->interval ($interval)
2023		2109
2024	Normally (and when C<$interval> is C<0>), the timer will automatically	2110	By default (and when C<$interval> is C<0>), the timer will automatically
2025	stop after it has fired once. If C<$interval> is non-zero, then the timer	2111	stop after it has fired once. If C<$interval> is non-zero, then the timer
2026	is automatically rescheduled at the given intervals.	2112	is automatically rescheduled at the given intervals.
2027		2113
2028	=item $timer = $timer->start	2114	=item $timer = $timer->start
2029		2115
2030	Start the timer.	2116	Start the timer.
2031		2117
2032	=item $timer = $timer->start ($tstamp)	2118	=item $timer = $timer->start ($tstamp[, $interval])
2033		2119
2034	Set the event trigger time to C<$tstamp> and start the timer.	2120	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2121	also replaces the interval.
2035		2122
2036	=item $timer = $timer->after ($delay)	2123	=item $timer = $timer->after ($delay[, $interval])
2037		2124
2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2125	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2039		2126
2040	=item $timer = $timer->stop	2127	=item $timer = $timer->stop
2041		2128
…		…
2049		2136
2050	$term->{socket} = ...	2137	$term->{socket} = ...
2051	$term->{iow} = urxvt::iow	2138	$term->{iow} = urxvt::iow
2052	->new	2139	->new
2053	->fd (fileno $term->{socket})	2140	->fd (fileno $term->{socket})
2054	->events (urxvt::EVENT_READ)	2141	->events (urxvt::EV_READ)
2055	->start	2142	->start
2056	->cb (sub {	2143	->cb (sub {
2057	my ($iow, $revents) = @_;	2144	my ($iow, $revents) = @_;
2058	# $revents must be 1 here, no need to check	2145	# $revents must be 1 here, no need to check
2059	sysread $term->{socket}, my $buf, 8192	2146	sysread $term->{socket}, my $buf, 8192
…		…
2077	Set the file descriptor (not handle) to watch.	2164	Set the file descriptor (not handle) to watch.
2078		2165
2079	=item $iow = $iow->events ($eventmask)	2166	=item $iow = $iow->events ($eventmask)
2080		2167
2081	Set the event mask to watch. The only allowed values are	2168	Set the event mask to watch. The only allowed values are
2082	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2169	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2083	together, or C<urxvt::EVENT_NONE>.	2170	together, or C<urxvt::EV_NONE>.
2084		2171
2085	=item $iow = $iow->start	2172	=item $iow = $iow->start
2086		2173
2087	Start watching for requested events on the given handle.	2174	Start watching for requested events on the given handle.
2088		2175
…		…
2129	->new	2216	->new
2130	->start ($pid)	2217	->start ($pid)
2131	->cb (sub {	2218	->cb (sub {
2132	my ($pw, $exit_status) = @_;	2219	my ($pw, $exit_status) = @_;
2133	...	2220	...
2134	});	2221	});
2135		2222
2136	=over 4	2223	=over 4
2137		2224
2138	=item $pw = new urxvt::pw	2225	=item $pw = new urxvt::pw
2139		2226
…		…
2172		2259
2173	=back	2260	=back
2174		2261
2175	=head1 AUTHOR	2262	=head1 AUTHOR
2176		2263
2177	Marc Lehmann <pcg@goof.com>	2264	Marc Lehmann <schmorp@schmorp.de>
2178	http://software.schmorp.de/pkg/rxvt-unicode	2265	http://software.schmorp.de/pkg/rxvt-unicode
2179		2266
2180	=cut	2267	=cut
2181		2268
2182	1	2269	1

Diff Legend

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