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

Diff Legend

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