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.152 by tpope, Tue Jan 9 16:18:56 2007 UTC vs.
Revision 1.250 by sf-exg, Fri Dec 26 21:49:11 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	=item block-graphics-to-ascii
312
313	A not very useful example of filtering all text output to the terminal
314	by replacing all line-drawing characters (U+2500 .. U+259F) by a
315	similar-looking ascii character.
316
317	=item digital-clock
318
319	Displays a digital clock using the built-in overlay.
320
321	=item remote-clipboard
322
323	Somewhat of a misnomer, this extension adds two menu entries to the
324	selection popup that allows one ti run external commands to store the
325	selection somewhere and fetch it again.
326
327	We use it to implement a "distributed selection mechanism", which just
328	means that one command uploads the file to a remote server, and another
329	reads it.
330
331	The commands can be set using the C<URxvt.remote-selection.store> and
332	C<URxvt.remote-selection.fetch> resources. The first should read the
333	selection to store from STDIN (always in UTF-8), the second should provide
334	the selection data on STDOUT (also in UTF-8).
335
336	The defaults (which are likely useless to you) use rsh and cat:
337
338	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
339	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
340
341	=item selection-pastebin
342
343	This is a little rarely useful extension that Uploads the selection as
344	textfile to a remote site (or does other things). (The implementation is
345	not currently secure for use in a multiuser environment as it writes to
346	F</tmp> directly.).
347
348	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
349	i.e.
350
351	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
352
353	Pressing this combination runs a command with C<%> replaced by the name of
354	the textfile. This command can be set via a resource:
355
356	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
357
358	And the default is likely not useful to anybody but the few people around
359	here :)
360
361	The name of the textfile is the hex encoded md5 sum of the selection, so
362	the same content should lead to the same filename.
363
364	After a successful upload the selection will be replaced by the text given
365	in the C<selection-pastebin-url> resource (again, the % is the placeholder
366	for the filename):
367
368	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
369
370	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
371	the double C</> characters as comment start. Use C<\057\057> instead,
372	which works regardless of wether xrdb is used to parse the resource file
373	or not.
374
375	=item example-refresh-hooks
376
377	Displays a very simple digital clock in the upper right corner of the
378	window. Illustrates overwriting the refresh callbacks to create your own
379	overlays or changes.
380
381	=back
382		56
383	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
384		58
385	=head2 General API Considerations	59	=head2 General API Considerations
386		60
…		…
400		74
401	=over 4	75	=over 4
402		76
403	=item $text	77	=item $text
404		78
405	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	Rxvt-unicode's special way of encoding text, where one "unicode" character
406	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.
407		81
408	=item $string	82	=item $string
409		83
410	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
…		…
414	=item $octets	88	=item $octets
415		89
416	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
417	locale-specific way.	91	locale-specific way.
418		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
419	=back	99	=back
420		100
421	=head2 Extension Objects	101	=head2 Extension Objects
422		102
423	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
424	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,
425	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
426	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
427	extensions or other terminals, with the exception of methods and members	107	extensions or other terminals, with the exception of methods and members
428	that begin with an underscore character C<_>: these are reserved for	108	that begin with an underscore character C<_>: these are reserved for
429	internal use.	109	internal use.
430		110
431	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
432	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
433		113
434	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:
435		123
436	=over 4	124	=over 4
437		125
438	=item $urxvt_term = $self->{term}	126	=item #:META:RESOURCE:name:type:desc
439		127
440	Returns the C<urxvt::term> object associated with this instance of the	128	The RESOURCE comment defines a resource used by the extension, where
441	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>
442		130	or C<string>, and C<desc> is the resource description.
443	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
444
445	Dynamically enable the given hooks (named without the C<on_> prefix) for
446	this extension, replacing any previous hook. This is useful when you want
447	to overwrite time-critical hooks only temporarily.
448
449	=item $self->disable ($hook_name[, $hook_name..])
450
451	Dynamically disable the given hooks.
452		131
453	=back	132	=back
454		133
455	=head2 Hooks	134	=head2 Hooks
456		135
…		…
544		223
545	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,
546	$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
547	number of lines that will be in the scrollback buffer.	226	number of lines that will be in the scrollback buffer.
548		227
549	=item on_osc_seq $term, $op, $args	228	=item on_osc_seq $term, $op, $args, $resp
550		229
551	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
552	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
553	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
554	confused by recursive invocations when you output an osc sequence within	233	confused by recursive invocations when you output an OSC sequence within
555	this callback.	234	this callback.
556		235
557	C<on_osc_seq_perl> should be used for new behaviour.	236	C<on_osc_seq_perl> should be used for new behaviour.
558		237
559	=item on_osc_seq_perl $term, $string	238	=item on_osc_seq_perl $term, $args, $resp
560		239
561	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	240	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
562	operating system command) is processed. Cursor position and other state	241	operating system command) is processed. Cursor position and other state
563	information is up-to-date when this happens. For interoperability, the	242	information is up-to-date when this happens. For interoperability, the
564	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,
565	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
566	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	}
567		256
568	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,
569	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
570	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.
571		263
572	=item on_add_lines $term, $string	264	=item on_add_lines $term, $string
573		265
574	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
575	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
…		…
580	=item on_tt_write $term, $octets	272	=item on_tt_write $term, $octets
581		273
582	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
583	suppress or filter tty input.	275	suppress or filter tty input.
584		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
585	=item on_line_update $term, $row	284	=item on_line_update $term, $row
586		285
587	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
588	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
589	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,
…		…
596	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
597	you cannot just toggle rendition bits, but only set them.	296	you cannot just toggle rendition bits, but only set them.
598		297
599	=item on_refresh_begin $term	298	=item on_refresh_begin $term
600		299
601	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
602	or similar effects by modify terminal contents in refresh_begin, and	301	similar effects by modifying the terminal contents in refresh_begin, and
603	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
604	code is run after this hook, and takes precedence.	303	code is run after this hook, and takes precedence.
605		304
606	=item on_refresh_end $term	305	=item on_refresh_end $term
607		306
608	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>.
609		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
610	=item on_user_command $term, $string	317	=item on_user_command $term, $string *DEPRECATED*
611		318
612	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
613	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>
614	resource in the @@RXVT_NAME@@(1) manpage).	321	resource in the urxvt(1) manpage).
615		322
616	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
617	slightly in the future.	324	preference to the C<on_action> hook.
618		325
619	=item on_resize_all_windows $tern, $new_width, $new_height	326	=item on_resize_all_windows $term, $new_width, $new_height
620		327
621	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
622	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
623	returns TRUE, setting of the window hints is being skipped.	330	returns a true value, setting of the window hints is being skipped.
624		331
625	=item on_x_event $term, $event	332	=item on_x_event $term, $event
626		333
627	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
628	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
…		…
658		365
659	=item on_map_notify $term, $event	366	=item on_map_notify $term, $event
660		367
661	=item on_unmap_notify $term, $event	368	=item on_unmap_notify $term, $event
662		369
663	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
664	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.
665		372
666	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
667	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
668	(real, not screen-based) row and column under the mouse cursor.	375	(real, not screen-based) row and column under the mouse cursor.
669		376
670	C<on_key_press> additionally receives the string rxvt-unicode would	377	C<on_key_press> additionally receives the string rxvt-unicode would
671	output, if any, in locale-specific encoding.	378	output, if any, in locale-specific encoding.
672		379
673	subwindow.
674
675	=item on_client_message $term, $event	380	=item on_client_message $term, $event
676		381
677	=item on_wm_protocols $term, $event	382	=item on_wm_protocols $term, $event
678		383
679	=item on_wm_delete_window $term, $event	384	=item on_wm_delete_window $term, $event
680		385
681	Called when various types of ClientMessage events are received (all with	386	Called when various types of ClientMessage events are received (all with
682	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	387	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
683		388
		389	=item on_bell $term
		390
		391	Called on receipt of a bell character.
		392
684	=back	393	=back
685		394
686	=cut	395	=cut
687		396
688	package urxvt;	397	package urxvt;
689		398
690	use utf8;	399	use utf8;
691	use strict;	400	use strict 'vars';
692	use Carp ();	401	use Carp ();
693	use Scalar::Util ();	402	use Scalar::Util ();
694	use List::Util ();	403	use List::Util ();
695		404
696	our $VERSION = 1;	405	our $VERSION = 1;
697	our $TERM;	406	our $TERM;
698	our @TERM_INIT;	407	our @TERM_INIT; # should go, prevents async I/O etc.
699	our @TERM_EXT;	408	our @TERM_EXT; # should go, prevents async I/O etc.
700	our @HOOKNAME;	409	our @HOOKNAME;
701	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	410	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
702	our %OPTION;	411	our %OPTION;
703		412
704	our $LIBDIR;	413	our $LIBDIR;
…		…
752		461
753	=over 4	462	=over 4
754		463
755	=item urxvt::fatal $errormessage	464	=item urxvt::fatal $errormessage
756		465
757	Fatally aborts execution with the given error message. Avoid at all	466	Fatally aborts execution with the given error message (which should
758	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
759	starts up.	468	is acceptable (and useful) is in the init hook, where it prevents the
		469	terminal from starting up.
760		470
761	=item urxvt::warn $string	471	=item urxvt::warn $string
762		472
763	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
764	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
765	that calls this function.	475	that calls this function.
766		476
767	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
768	correct place, e.g. on stderr of the connecting urxvtc client.	478	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
772	=item @terms = urxvt::termlist	482	=item @terms = urxvt::termlist
773		483
774	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
775	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
776	objects that have perl extensions attached will be returned (because there	486	objects that have perl extensions attached will be returned (because there
777	is no urxvt::term objet associated with others).	487	is no urxvt::term object associated with others).
778		488
779	=item $time = urxvt::NOW	489	=item $time = urxvt::NOW
780		490
781	Returns the "current time" (as per the event loop).	491	Returns the "current time" (as per the event loop).
782		492
…		…
825		535
826	=item $rend = urxvt::OVERLAY_RSTYLE	536	=item $rend = urxvt::OVERLAY_RSTYLE
827		537
828	Return the rendition mask used for overlays by default.	538	Return the rendition mask used for overlays by default.
829		539
830	=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
831		542
832	Return the bit that enabled bold, italic, blink, reverse-video and	543	Return the bit that enabled bold, italic, blink, reverse-video and
833	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
834	the bitset.	545	the bitset.
835		546
…		…
872	};	583	};
873	}	584	}
874		585
875	no warnings 'utf8';	586	no warnings 'utf8';
876		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
877	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	650	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
878		651
879	sub verbose {	652	sub verbose {
880	my ($level, $msg) = @_;	653	my ($level, $msg) = @_;
881	warn "$msg\n" if $level <= $verbosity;	654	warn "$msg\n" if $level <= $verbosity;
…		…
893	$pkg =~ s/[^[:word:]]/_/g;	666	$pkg =~ s/[^[:word:]]/_/g;
894	$pkg = "urxvt::ext::$pkg";	667	$pkg = "urxvt::ext::$pkg";
895		668
896	verbose 3, "loading extension '$path' into package '$pkg'";	669	verbose 3, "loading extension '$path' into package '$pkg'";
897		670
		671	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		672
898	open my $fh, "<:raw", $path	673	open my $fh, "<:raw", $path
899	or die "$path: $!";	674	or die "$path: $!";
900		675
901	my $source =	676	my $source =
902	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	677	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
903	. "#line 1 \"$path\"\n{\n"	678	. "#line 1 \"$path\"\n{\n"
904	. (do { local $/; <$fh> })	679	. (do { local $/; <$fh> })
905	. "\n};\n1";	680	. "\n};\n1";
906		681
907	eval $source	682	eval $source
…		…
916	# called by the rxvt core	691	# called by the rxvt core
917	sub invoke {	692	sub invoke {
918	local $TERM = shift;	693	local $TERM = shift;
919	my $htype = shift;	694	my $htype = shift;
920		695
921	if ($htype == 0) { # INIT	696	if ($htype == HOOK_INIT) {
922	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	697	my @dirs = $TERM->perl_libdirs;
923		698
		699	$TERM->scan_extensions;
		700
924	my %ext_arg;	701	my %ext_arg;
925		702
926	{	703	{
927	my @init = @TERM_INIT;	704	my @init = @TERM_INIT;
928	@TERM_INIT = ();	705	@TERM_INIT = ();
…		…
930	my @pkg = @TERM_EXT;	707	my @pkg = @TERM_EXT;
931	@TERM_EXT = ();	708	@TERM_EXT = ();
932	$TERM->register_package ($_) for @pkg;	709	$TERM->register_package ($_) for @pkg;
933	}	710	}
934		711
		712	for (
935	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	) {
936	if ($_ eq "default") {	716	if ($_ eq "default") {
		717
		718	$ext_arg{$_} = []
937	$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
938	} elsif (/^-(.*)$/) {	730	} elsif (/^-(.*)$/) {
939	delete $ext_arg{$1};	731	delete $ext_arg{$1};
		732
940	} elsif (/^([^<]+)<(.*)>$/) {	733	} elsif (/^([^<]+)<(.*)>$/) {
941	push @{ $ext_arg{$1} }, $2;	734	push @{ $ext_arg{$1} }, $2;
		735
942	} else {	736	} else {
943	$ext_arg{$_} ||= [];	737	$ext_arg{$_} ||= [];
944	}	738	}
945	}	739	}
946		740
…		…
962		756
963	if (my $cb = $TERM->{_hook}[$htype]) {	757	if (my $cb = $TERM->{_hook}[$htype]) {
964	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	758	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
965	if $verbosity >= 10;	759	if $verbosity >= 10;
966		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
967	for my $pkg (keys %$cb) {	774	for my $pkg (keys %$cb) {
968	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	775	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
969	$retval ||= $retval_;	776	$retval ||= $retval_;
970		777
971	if ($@) {	778	if ($@) {
972	$TERM->ungrab; # better to lose the grab than the session	779	$TERM->ungrab; # better to lose the grab than the session
973	warn $@;	780	warn $@;
…		…
976		783
977	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	784	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
978	if $verbosity >= 11;	785	if $verbosity >= 11;
979	}	786	}
980		787
981	if ($htype == 1) { # DESTROY	788	if ($htype == HOOK_DESTROY) {
982	# clear package objects	789	# clear package objects
983	%$_ = () for values %{ $TERM->{_pkg} };	790	%$_ = () for values %{ $TERM->{_pkg} };
984		791
985	# clear package	792	# clear package
986	%$TERM = ();	793	%$TERM = ();
…		…
1016	}	823	}
1017	}	824	}
1018	($mask, @color{qw(fg bg)}, \@failed)	825	($mask, @color{qw(fg bg)}, \@failed)
1019	}	826	}
1020		827
1021	# urxvt::term::extension
1022
1023	package urxvt::term::extension;	828	package urxvt::term::extension;
1024		829
1025	sub enable {	830	=head2 The C<urxvt::term::extension> class
1026	my ($self, %hook) = @_;
1027	my $pkg = $self->{_pkg};
1028		831
1029	while (my ($name, $cb) = each %hook) {	832	Each extension attached to a terminal object is represented by
1030	my $htype = $HOOKTYPE{uc $name};	833	a C<urxvt::term::extension> object.
1031	defined $htype
1032	or Carp::croak "unsupported hook type '$name'";
1033		834
1034	$self->set_should_invoke ($htype, +1)	835	You can use these objects, which are passed to all callbacks to store any
1035	unless exists $self->{term}{_hook}[$htype]{$pkg};	836	state related to the terminal and extension instance.
1036		837
1037	$self->{term}{_hook}[$htype]{$pkg} = $cb;	838	The methods (And data members) documented below can be called on extension
1038	}	839	objects, in addition to call methods documented for the <urxvt::term>
1039	}	840	class.
1040		841
1041	sub disable {	842	=over 4
1042	my ($self, @hook) = @_;
1043	my $pkg = $self->{_pkg};
1044		843
1045	for my $name (@hook) {	844	=item $urxvt_term = $self->{term}
1046	my $htype = $HOOKTYPE{uc $name};
1047	defined $htype
1048	or Carp::croak "unsupported hook type '$name'";
1049		845
1050	$self->set_should_invoke ($htype, -1)	846	Returns the C<urxvt::term> object associated with this instance of the
1051	if delete $self->{term}{_hook}[$htype]{$pkg};	847	extension. This member I<must not> be changed in any way.
1052	}	848
1053	}	849	=cut
1054		850
1055	our $AUTOLOAD;	851	our $AUTOLOAD;
1056		852
1057	sub AUTOLOAD {	853	sub AUTOLOAD {
1058	$AUTOLOAD =~ /:([^:]+)$/	854	$AUTOLOAD =~ /:([^:]+)$/
…		…
1071		867
1072	sub DESTROY {	868	sub DESTROY {
1073	# nop	869	# nop
1074	}	870	}
1075		871
1076	# urxvt::destroy_hook	872	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1077		873
1078	sub urxvt::destroy_hook::DESTROY {	874	sub urxvt::destroy_hook::DESTROY {
1079	${$_[0]}->();	875	${$_[0]}->();
1080	}	876	}
1081		877
1082	sub urxvt::destroy_hook(&) {	878	sub urxvt::destroy_hook(&) {
1083	bless \shift, urxvt::destroy_hook::	879	bless \shift, urxvt::destroy_hook::
1084	}	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
1085		1004
1086	package urxvt::anyevent;	1005	package urxvt::anyevent;
1087		1006
1088	=head2 The C<urxvt::anyevent> Class	1007	=head2 The C<urxvt::anyevent> Class
1089		1008
1090	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
1091	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
1092	further programming. The only exception is that you cannot wait on	1011	further programming. The only exception is that you cannot wait on
1093	condition variables, but non-blocking condvar use is ok. What this means	1012	condition variables, but non-blocking condvar use is ok.
1094	is that you cannot use blocking APIs, but the non-blocking variant should
1095	work.
1096		1013
1097	=cut	1014	In practical terms this means is that you cannot use blocking APIs, but
		1015	the non-blocking variant should work.
1098		1016
		1017	=cut
		1018
1099	our $VERSION = 1;	1019	our $VERSION = '5.23';
1100		1020
1101	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1021	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1102	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1022	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1103		1023
1104	sub timer {	1024	sub timer {
…		…
1106		1026
1107	my $cb = $arg{cb};	1027	my $cb = $arg{cb};
1108		1028
1109	urxvt::timer	1029	urxvt::timer
1110	->new	1030	->new
1111	->start (urxvt::NOW + $arg{after})	1031	->after ($arg{after}, $arg{interval})
1112	->cb (sub {	1032	->cb ($arg{interval} ? $cb : sub {
1113	$_[0]->stop; # need to cancel manually	1033	$_[0]->stop; # need to cancel manually
1114	$cb->();	1034	$cb->();
1115	})	1035	})
1116	}	1036	}
1117		1037
1118	sub io {	1038	sub io {
1119	my ($class, %arg) = @_;	1039	my ($class, %arg) = @_;
1120		1040
1121	my $cb = $arg{cb};	1041	my $cb = $arg{cb};
		1042	my $fd = fileno $arg{fh};
		1043	defined $fd or $fd = $arg{fh};
1122		1044
1123	bless [$arg{fh}, urxvt::iow	1045	bless [$arg{fh}, urxvt::iow
1124	->new	1046	->new
1125	->fd (fileno $arg{fh})	1047	->fd ($fd)
1126	->events (($arg{poll} =~ /r/ ? 1 : 0)	1048	->events (($arg{poll} =~ /r/ ? 1 : 0)
1127	| ($arg{poll} =~ /w/ ? 2 : 0))	1049	| ($arg{poll} =~ /w/ ? 2 : 0))
1128	->start	1050	->start
1129	->cb (sub {	1051	->cb ($cb)
1130	$cb->(($_[1] & 1 ? 'r' : '')
1131	. ($_[1] & 2 ? 'w' : ''));
1132	})],
1133	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	})
1134	}	1078	}
1135		1079
1136	sub DESTROY {	1080	sub DESTROY {
1137	$_[0][1]->stop;	1081	$_[0][1]->stop;
1138	}	1082	}
1139		1083
1140	sub condvar {	1084	# only needed for AnyEvent < 6 compatibility
1141	bless \my $flag, urxvt::anyevent::
1142	}
1143
1144	sub broadcast {
1145	${$_[0]}++;
1146	}
1147
1148	sub wait {
1149	unless (${$_[0]}) {
1150	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1151	}
1152	}
1153
1154	sub one_event {	1085	sub one_event {
1155	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";
1156	}	1087	}
1157		1088
1158	package urxvt::term;	1089	package urxvt::term;
…		…
1173	urxvt::verbose 6, "register package $pkg to $self";	1104	urxvt::verbose 6, "register package $pkg to $self";
1174		1105
1175	@{"$pkg\::ISA"} = urxvt::term::extension::;	1106	@{"$pkg\::ISA"} = urxvt::term::extension::;
1176		1107
1177	my $proxy = bless {	1108	my $proxy = bless {
1178	_pkg => $pkg,	1109	_pkg => $pkg,
		1110	_name => ${"$pkg\::_NAME"}, # hackish
1179	argv => $argv,	1111	argv => $argv,
1180	}, $pkg;	1112	}, $pkg;
1181	Scalar::Util::weaken ($proxy->{term} = $self);	1113	Scalar::Util::weaken ($proxy->{term} = $self);
1182		1114
1183	$self->{_pkg}{$pkg} = $proxy;	1115	$self->{_pkg}{$pkg} = $proxy;
1184		1116
…		…
1187	$proxy->enable ($name => $ref);	1119	$proxy->enable ($name => $ref);
1188	}	1120	}
1189	}	1121	}
1190	}	1122	}
1191		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	while (my ($k, $v) = each %{ $meta{ext} }) {
		1191	#TODO: should check for extensions overriding each other
		1192	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1193	}
		1194	}
		1195
1192	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1196	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1193		1197
1194	Creates a new terminal, very similar as if you had started it with system	1198	Creates a new terminal, very similar as if you had started it with system
1195	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1199	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1196	hash which defines the environment of the new terminal.	1200	hash which defines the environment of the new terminal.
…		…
1213	}	1217	}
1214		1218
1215	=item $term->destroy	1219	=item $term->destroy
1216		1220
1217	Destroy the terminal object (close the window, free resources	1221	Destroy the terminal object (close the window, free resources
1218	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1222	etc.). Please note that urxvt will not exit as long as any event
1219	watchers (timers, io watchers) are still active.	1223	watchers (timers, io watchers) are still active.
1220		1224
1221	=item $term->exec_async ($cmd[, @args])	1225	=item $term->exec_async ($cmd[, @args])
1222		1226
1223	Works like the combination of the C<fork>/C<exec> builtins, which executes	1227	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1250	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1254	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1251		1255
1252	Here is a likely non-exhaustive list of option names, please see the	1256	Here is a likely non-exhaustive list of option names, please see the
1253	source file F</src/optinc.h> to see the actual list:	1257	source file F</src/optinc.h> to see the actual list:
1254		1258
1255	borderLess console cursorBlink cursorUnderline hold iconic insecure	1259	borderLess buffered console cursorBlink cursorUnderline hold iconic
1256	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1260	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1257	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1261	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1258	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1262	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1259	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1263	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1260	transparent tripleclickwords utmpInhibit visualBell	1264	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1265	urgentOnBell utmpInhibit visualBell
1261		1266
1262	=item $value = $term->resource ($name[, $newval])	1267	=item $value = $term->resource ($name[, $newval])
1263		1268
1264	Returns the current resource value associated with a given name and	1269	Returns the current resource value associated with a given name and
1265	optionally sets a new value. Setting values is most useful in the C<init>	1270	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1278		1283
1279	Here is a likely non-exhaustive list of resource names, not all of which	1284	Here is a likely non-exhaustive list of resource names, not all of which
1280	are supported in every build, please see the source file F</src/rsinc.h>	1285	are supported in every build, please see the source file F</src/rsinc.h>
1281	to see the actual list:	1286	to see the actual list:
1282		1287
1283	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1288	answerbackstring backgroundPixmap backspace_key blurradius
1284	borderLess color cursorBlink cursorUnderline cutchars delete_key	1289	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1285	display_name embed ext_bwidth fade font geometry hold iconName	1290	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1286	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1291	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1292	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1287	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1293	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1288	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1294	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1289	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1295	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1290	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1296	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1291	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1297	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1292	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1298	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1293	secondaryScreen secondaryScroll selectstyle shade term_name title	1299	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1294	transient_for transparent transparent_all tripleclickwords utmpInhibit	1300	term_name title transient_for transparent tripleclickwords urgentOnBell
1295	visualBell	1301	utmpInhibit visualBell
1296		1302
1297	=cut	1303	=cut
1298		1304
1299	sub resource($$;$) {	1305	sub resource($$;$) {
1300	my ($self, $name) = (shift, shift);	1306	my ($self, $name) = (shift, shift);
1301	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1307	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1302	&urxvt::term::_resource	1308	goto &urxvt::term::_resource
1303	}	1309	}
1304		1310
1305	=item $value = $term->x_resource ($pattern)	1311	=item $value = $term->x_resource ($pattern)
1306		1312
1307	Returns the X-Resource for the given pattern, excluding the program or	1313	Returns the X-Resource for the given pattern, excluding the program or
1308	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1314	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1309	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1315	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1310	resource with that pattern exists.	1316	resource with that pattern exists.
1311		1317
		1318	Extensions that define extra resources also need to call this method
		1319	to access their values.
		1320
		1321	If the method is called on an extension object (basically, from an
		1322	extension), then the special prefix C<%.> will be replaced by the name of
		1323	the extension and a dot, and the lone string C<%> will be replaced by the
		1324	extension name itself. This makes it possible to code extensions so you
		1325	can rename them and get a new set of resources without having to change
		1326	the actual code.
		1327
1312	This method should only be called during the C<on_start> hook, as there is	1328	This method should only be called during the C<on_start> hook, as there is
1313	only one resource database per display, and later invocations might return	1329	only one resource database per display, and later invocations might return
1314	the wrong resources.	1330	the wrong resources.
1315		1331
1316	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1332	=item $value = $term->x_resource_boolean ($pattern)
1317		1333
		1334	Like C<x_resource>, above, but interprets the string value as a boolean
		1335	and returns C<1> for true values, C<0> for false values and C<undef> if
		1336	the resource or option isn't specified.
		1337
		1338	You should always use this method to parse boolean resources.
		1339
		1340	=cut
		1341
		1342	sub x_resource_boolean {
		1343	my $res = &x_resource;
		1344
		1345	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1346	}
		1347
		1348	=item $success = $term->bind_action ($key, $action)
		1349
1318	Adds a keymap translation exactly as specified via a resource. See the	1350	Adds a key binding exactly as specified via a C<keysym> resource. See the
1319	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1351	C<keysym> resource in the urxvt(1) manpage.
		1352
		1353	To add default bindings for actions, an extension should call C<<
		1354	->bind_action >> in its C<init> hook for every such binding. Doing it
		1355	in the C<init> hook allows users to override or remove the binding
		1356	again.
		1357
		1358	Example: the C<searchable-scrollback> by default binds itself
		1359	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1360	$term->bind_action >>.
		1361
		1362	sub init {
		1363	my ($self) = @_;
		1364
		1365	$self->bind_action ("M-s" => "%:start");
		1366	}
1320		1367
1321	=item $rend = $term->rstyle ([$new_rstyle])	1368	=item $rend = $term->rstyle ([$new_rstyle])
1322		1369
1323	Return and optionally change the current rendition. Text that is output by	1370	Return and optionally change the current rendition. Text that is output by
1324	the terminal application will use this style.	1371	the terminal application will use this style.
…		…
1332		1379
1333	=item ($row, $col) = $term->selection_beg ([$row, $col])	1380	=item ($row, $col) = $term->selection_beg ([$row, $col])
1334		1381
1335	=item ($row, $col) = $term->selection_end ([$row, $col])	1382	=item ($row, $col) = $term->selection_end ([$row, $col])
1336		1383
1337	Return the current values of the selection mark, begin or end positions,	1384	Return the current values of the selection mark, begin or end positions.
1338	and optionally set them to new values.	1385
		1386	When arguments are given, then the selection coordinates are set to
		1387	C<$row> and C<$col>, and the selection screen is set to the current
		1388	screen.
		1389
		1390	=item $screen = $term->selection_screen ([$screen])
		1391
		1392	Returns the current selection screen, and then optionally sets it.
1339		1393
1340	=item $term->selection_make ($eventtime[, $rectangular])	1394	=item $term->selection_make ($eventtime[, $rectangular])
1341		1395
1342	Tries to make a selection as set by C<selection_beg> and	1396	Tries to make a selection as set by C<selection_beg> and
1343	C<selection_end>. If C<$rectangular> is true (default: false), a	1397	C<selection_end>. If C<$rectangular> is true (default: false), a
1344	rectangular selection will be made. This is the prefered function to make	1398	rectangular selection will be made. This is the preferred function to make
1345	a selection.	1399	a selection.
1346		1400
1347	=item $success = $term->selection_grab ($eventtime)	1401	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1348		1402
1349	Try to request the primary selection text from the server (for example, as	1403	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1404	true) selection from the server. The corresponding text can be set
1350	set by the next method). No visual feedback will be given. This function	1405	with the next method. No visual feedback will be given. This function
1351	is mostly useful from within C<on_sel_grab> hooks.	1406	is mostly useful from within C<on_sel_grab> hooks.
1352		1407
1353	=item $oldtext = $term->selection ([$newtext])	1408	=item $oldtext = $term->selection ([$newtext, $clipboard])
1354		1409
1355	Return the current selection text and optionally replace it by C<$newtext>.	1410	Return the current selection (clipboard if C<$clipboard> is true) text
		1411	and optionally replace it by C<$newtext>.
		1412
		1413	=item $term->selection_clear ([$clipboard])
		1414
		1415	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1356		1416
1357	=item $term->overlay_simple ($x, $y, $text)	1417	=item $term->overlay_simple ($x, $y, $text)
1358		1418
1359	Create a simple multi-line overlay box. See the next method for details.	1419	Create a simple multi-line overlay box. See the next method for details.
1360		1420
…		…
1390		1450
1391	The methods currently supported on C<urxvt::overlay> objects are:	1451	The methods currently supported on C<urxvt::overlay> objects are:
1392		1452
1393	=over 4	1453	=over 4
1394		1454
1395	=item $overlay->set ($x, $y, $text, $rend)	1455	=item $overlay->set ($x, $y, $text[, $rend])
1396		1456
1397	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1457	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1398	text in rxvt-unicode's special encoding and an array of rendition values	1458	text in rxvt-unicode's special encoding and an array of rendition values
1399	at a specific position inside the overlay.	1459	at a specific position inside the overlay.
		1460
		1461	If C<$rend> is missing, then the rendition will not be changed.
1400		1462
1401	=item $overlay->hide	1463	=item $overlay->hide
1402		1464
1403	If visible, hide the overlay, but do not destroy it.	1465	If visible, hide the overlay, but do not destroy it.
1404		1466
…		…
1467		1529
1468	=item $term->scr_add_lines ($string)	1530	=item $term->scr_add_lines ($string)
1469		1531
1470	Write the given text string to the screen, as if output by the application	1532	Write the given text string to the screen, as if output by the application
1471	running inside the terminal. It may not contain command sequences (escape	1533	running inside the terminal. It may not contain command sequences (escape
1472	codes), but is free to use line feeds, carriage returns and tabs. The	1534	codes - see C<cmd_parse> for that), but is free to use line feeds,
1473	string is a normal text string, not in locale-dependent encoding.	1535	carriage returns and tabs. The string is a normal text string, not in
		1536	locale-dependent encoding.
1474		1537
1475	Normally its not a good idea to use this function, as programs might be	1538	Normally its not a good idea to use this function, as programs might be
1476	confused by changes in cursor position or scrolling. Its useful inside a	1539	confused by changes in cursor position or scrolling. Its useful inside a
1477	C<on_add_lines> hook, though.	1540	C<on_add_lines> hook, though.
1478		1541
…		…
1486	locale-specific encoding of the terminal and can contain command sequences	1549	locale-specific encoding of the terminal and can contain command sequences
1487	(escape codes) that will be interpreted.	1550	(escape codes) that will be interpreted.
1488		1551
1489	=item $term->tt_write ($octets)	1552	=item $term->tt_write ($octets)
1490		1553
1491	Write the octets given in C<$data> to the tty (i.e. as program input). To	1554	Write the octets given in C<$octets> to the tty (i.e. as user input
		1555	to the program, see C<cmd_parse> for the opposite direction). To pass
1492	pass characters instead of octets, you should convert your strings first	1556	characters instead of octets, you should convert your strings first to the
1493	to the locale-specific encoding using C<< $term->locale_encode >>.	1557	locale-specific encoding using C<< $term->locale_encode >>.
		1558
		1559	=item $term->tt_write_user_input ($octets)
		1560
		1561	Like C<tt_write>, but should be used when writing strings in response to
		1562	the user pressing a key, to invoke the additional actions requested by
		1563	the user for that case (C<tt_write> doesn't do that).
		1564
		1565	The typical use case would be inside C<on_action> hooks.
		1566
		1567	=item $term->tt_paste ($octets)
		1568
		1569	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1570	CR and bracketing the data with control sequences if bracketed paste mode
		1571	is set.
1494		1572
1495	=item $old_events = $term->pty_ev_events ([$new_events])	1573	=item $old_events = $term->pty_ev_events ([$new_events])
1496		1574
1497	Replaces the event mask of the pty watcher by the given event mask. Can	1575	Replaces the event mask of the pty watcher by the given event mask. Can
1498	be used to suppress input and output handling to the pty/tty. See the	1576	be used to suppress input and output handling to the pty/tty. See the
…		…
1517	Adds the specified events to the vt event mask. Useful e.g. when you want	1595	Adds the specified events to the vt event mask. Useful e.g. when you want
1518	to receive pointer events all the times:	1596	to receive pointer events all the times:
1519		1597
1520	$term->vt_emask_add (urxvt::PointerMotionMask);	1598	$term->vt_emask_add (urxvt::PointerMotionMask);
1521		1599
		1600	=item $term->set_urgency ($set)
		1601
		1602	Enable/disable the urgency hint on the toplevel window.
		1603
1522	=item $term->focus_in	1604	=item $term->focus_in
1523		1605
1524	=item $term->focus_out	1606	=item $term->focus_out
1525		1607
1526	=item $term->key_press ($state, $keycode[, $time])	1608	=item $term->key_press ($state, $keycode[, $time])
…		…
1614		1696
1615	Used after changing terminal contents to display them.	1697	Used after changing terminal contents to display them.
1616		1698
1617	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1699	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1618		1700
1619	Returns the text of the entire row with number C<$row_number>. Row C<0>	1701	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1620	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1702	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1621	terminal line. The scrollback buffer starts at line C<-1> and extends to
1622	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1703	terminal line. Nothing will be returned if a nonexistent line
1623	is requested.	1704	is requested.
1624		1705
1625	If C<$new_text> is specified, it will replace characters in the current	1706	If C<$new_text> is specified, it will replace characters in the current
1626	line, starting at column C<$start_col> (default C<0>), which is useful	1707	line, starting at column C<$start_col> (default C<0>), which is useful
1627	to replace only parts of a line. The font index in the rendition will	1708	to replace only parts of a line. The font index in the rendition will
1628	automatically be updated.	1709	automatically be updated.
1629		1710
1630	C<$text> is in a special encoding: tabs and wide characters that use more	1711	C<$text> is in a special encoding: tabs and wide characters that use more
1631	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1712	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1632	characters. Characters with combining characters and other characters that	1713	characters. Characters with combining characters and other characters that
1633	do not fit into the normal tetx encoding will be replaced with characters	1714	do not fit into the normal text encoding will be replaced with characters
1634	in the private use area.	1715	in the private use area.
1635		1716
1636	You have to obey this encoding when changing text. The advantage is	1717	You have to obey this encoding when changing text. The advantage is
1637	that C<substr> and similar functions work on screen cells and not on	1718	that C<substr> and similar functions work on screen cells and not on
1638	characters.	1719	characters.
…		…
1723	}	1804	}
1724		1805
1725	sub urxvt::line::t {	1806	sub urxvt::line::t {
1726	my ($self) = @_;	1807	my ($self) = @_;
1727		1808
1728	if (@_ > 1)	1809	if (@_ > 1) {
1729	{
1730	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1810	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1731	for $self->{beg} .. $self->{end};	1811	for $self->{beg} .. $self->{end};
1732	}	1812	}
1733		1813
1734	defined wantarray &&	1814	defined wantarray &&
1735	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1815	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1736	0, $self->{len}	1816	0, $self->{len}
1737	}	1817	}
1738		1818
1739	sub urxvt::line::r {	1819	sub urxvt::line::r {
1740	my ($self) = @_;	1820	my ($self) = @_;
1741		1821
1742	if (@_ > 1)	1822	if (@_ > 1) {
1743	{
1744	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1823	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1745	for $self->{beg} .. $self->{end};	1824	for $self->{beg} .. $self->{end};
1746	}	1825	}
1747		1826
1748	if (defined wantarray) {	1827	if (defined wantarray) {
1749	my $rend = [	1828	my $rend = [
1750	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1829	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1751	];	1830	];
…		…
1813	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1892	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1814	recent grab.	1893	recent grab.
1815		1894
1816	=item $term->ungrab	1895	=item $term->ungrab
1817		1896
1818	Calls XUngrab for the most recent grab. Is called automatically on	1897	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1819	evaluation errors, as it is better to lose the grab in the error case as	1898	evaluation errors, as it is better to lose the grab in the error case as
1820	the session.	1899	the session.
1821		1900
1822	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1901	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1823		1902
…		…
1825		1904
1826	=item @atoms = $term->XListProperties ($window)	1905	=item @atoms = $term->XListProperties ($window)
1827		1906
1828	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1907	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1829		1908
1830	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1909	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1831		1910
1832	=item $term->XDeleteProperty ($window, $property)	1911	=item $term->XDeleteProperty ($window, $property)
1833		1912
1834	=item $window = $term->DefaultRootWindow	1913	=item $window = $term->DefaultRootWindow
1835		1914
…		…
1842	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1921	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1843		1922
1844	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1923	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1845		1924
1846	=item $term->XChangeInput ($window, $add_events[, $del_events])	1925	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1926
		1927	=item $keysym = $term->XStringToKeysym ($string)
		1928
		1929	=item $string = $term->XKeysymToString ($keysym)
1847		1930
1848	Various X or X-related functions. The C<$term> object only serves as	1931	Various X or X-related functions. The C<$term> object only serves as
1849	the source of the display, otherwise those functions map more-or-less	1932	the source of the display, otherwise those functions map more-or-less
1850	directory onto the X functions of the same name.	1933	directly onto the X functions of the same name.
1851		1934
1852	=back	1935	=back
1853		1936
1854	=cut	1937	=cut
1855		1938
…		…
1957	my $env = $self->{term}->env;	2040	my $env = $self->{term}->env;
1958	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2041	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1959	delete $env->{LC_ALL};	2042	delete $env->{LC_ALL};
1960	$env->{LC_CTYPE} = $self->{term}->locale;	2043	$env->{LC_CTYPE} = $self->{term}->locale;
1961		2044
1962	urxvt::term->new ($env, "popup",	2045	my $term = urxvt::term->new (
		2046	$env, "popup",
1963	"--perl-lib" => "", "--perl-ext-common" => "",	2047	"--perl-lib" => "", "--perl-ext-common" => "",
1964	"-pty-fd" => -1, "-sl" => 0,	2048	"-pty-fd" => -1, "-sl" => 0,
1965	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2049	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1966	"--transient-for" => $self->{term}->parent,	2050	"--transient-for" => $self->{term}->parent,
1967	"-display" => $self->{term}->display_id,	2051	"-display" => $self->{term}->display_id,
1968	"-pe" => "urxvt-popup")	2052	"-pe" => "urxvt-popup",
1969	or die "unable to create popup window\n";	2053	) or die "unable to create popup window\n";
		2054
		2055	unless (delete $term->{urxvt_popup_init_done}) {
		2056	$term->ungrab;
		2057	$term->destroy;
		2058	die "unable to initialise popup window\n";
		2059	}
1970	}	2060	}
1971		2061
1972	sub DESTROY {	2062	sub DESTROY {
1973	my ($self) = @_;	2063	my ($self) = @_;
1974		2064
…		…
1992	->new	2082	->new
1993	->interval (1)	2083	->interval (1)
1994	->cb (sub {	2084	->cb (sub {
1995	$term->{overlay}->set (0, 0,	2085	$term->{overlay}->set (0, 0,
1996	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2086	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1997	});	2087	});
1998		2088
1999	=over 4	2089	=over 4
2000		2090
2001	=item $timer = new urxvt::timer	2091	=item $timer = new urxvt::timer
2002		2092
…		…
2005		2095
2006	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2096	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2007		2097
2008	Set the callback to be called when the timer triggers.	2098	Set the callback to be called when the timer triggers.
2009		2099
2010	=item $tstamp = $timer->at
2011
2012	Return the time this watcher will fire next.
2013
2014	=item $timer = $timer->set ($tstamp)	2100	=item $timer = $timer->set ($tstamp[, $interval])
2015		2101
2016	Set the time the event is generated to $tstamp.	2102	Set the time the event is generated to $tstamp (and optionally specifies a
		2103	new $interval).
2017		2104
2018	=item $timer = $timer->interval ($interval)	2105	=item $timer = $timer->interval ($interval)
2019		2106
2020	Normally (and when C<$interval> is C<0>), the timer will automatically	2107	By default (and when C<$interval> is C<0>), the timer will automatically
2021	stop after it has fired once. If C<$interval> is non-zero, then the timer	2108	stop after it has fired once. If C<$interval> is non-zero, then the timer
2022	is automatically rescheduled at the given intervals.	2109	is automatically rescheduled at the given intervals.
2023		2110
2024	=item $timer = $timer->start	2111	=item $timer = $timer->start
2025		2112
2026	Start the timer.	2113	Start the timer.
2027		2114
2028	=item $timer = $timer->start ($tstamp)	2115	=item $timer = $timer->start ($tstamp[, $interval])
2029		2116
2030	Set the event trigger time to C<$tstamp> and start the timer.	2117	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2118	also replaces the interval.
2031		2119
2032	=item $timer = $timer->after ($delay)	2120	=item $timer = $timer->after ($delay[, $interval])
2033		2121
2034	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2122	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2035		2123
2036	=item $timer = $timer->stop	2124	=item $timer = $timer->stop
2037		2125
…		…
2045		2133
2046	$term->{socket} = ...	2134	$term->{socket} = ...
2047	$term->{iow} = urxvt::iow	2135	$term->{iow} = urxvt::iow
2048	->new	2136	->new
2049	->fd (fileno $term->{socket})	2137	->fd (fileno $term->{socket})
2050	->events (urxvt::EVENT_READ)	2138	->events (urxvt::EV_READ)
2051	->start	2139	->start
2052	->cb (sub {	2140	->cb (sub {
2053	my ($iow, $revents) = @_;	2141	my ($iow, $revents) = @_;
2054	# $revents must be 1 here, no need to check	2142	# $revents must be 1 here, no need to check
2055	sysread $term->{socket}, my $buf, 8192	2143	sysread $term->{socket}, my $buf, 8192
…		…
2073	Set the file descriptor (not handle) to watch.	2161	Set the file descriptor (not handle) to watch.
2074		2162
2075	=item $iow = $iow->events ($eventmask)	2163	=item $iow = $iow->events ($eventmask)
2076		2164
2077	Set the event mask to watch. The only allowed values are	2165	Set the event mask to watch. The only allowed values are
2078	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2166	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2079	together, or C<urxvt::EVENT_NONE>.	2167	together, or C<urxvt::EV_NONE>.
2080		2168
2081	=item $iow = $iow->start	2169	=item $iow = $iow->start
2082		2170
2083	Start watching for requested events on the given handle.	2171	Start watching for requested events on the given handle.
2084		2172
…		…
2125	->new	2213	->new
2126	->start ($pid)	2214	->start ($pid)
2127	->cb (sub {	2215	->cb (sub {
2128	my ($pw, $exit_status) = @_;	2216	my ($pw, $exit_status) = @_;
2129	...	2217	...
2130	});	2218	});
2131		2219
2132	=over 4	2220	=over 4
2133		2221
2134	=item $pw = new urxvt::pw	2222	=item $pw = new urxvt::pw
2135		2223
…		…
2168		2256
2169	=back	2257	=back
2170		2258
2171	=head1 AUTHOR	2259	=head1 AUTHOR
2172		2260
2173	Marc Lehmann <pcg@goof.com>	2261	Marc Lehmann <schmorp@schmorp.de>
2174	http://software.schmorp.de/pkg/rxvt-unicode	2262	http://software.schmorp.de/pkg/rxvt-unicode
2175		2263
2176	=cut	2264	=cut
2177		2265
2178	1	2266	1

Diff Legend

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