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.135 by root, Sun Feb 12 05:31:53 2006 UTC vs.
Revision 1.236 by root, Sat May 17 17:12:29 2014 UTC

1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in urxvtd, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	A number of extensions are delivered with this release. You can find them
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
		38	F<< man urxvt-<EXTENSIONNAME> >>.
35		39
36	You can activate them like this:	40	You can activate them like this:
37		41
38	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
39		43
40	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
41		45
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
43		47
44	=over 4	48	Extensions that add command line parameters or resources on their own are
45		49	loaded automatically when used.
46	=item selection (enabled by default)
47
48	(More) intelligent selection. This extension tries to be more intelligent
49	when the user extends selections (double-click and further clicks). Right
50	now, it tries to select words, urls and complete shell-quoted
51	arguments, which is very convenient, too, if your F<ls> supports
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything
68	between two vertical bars:
69
70	URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72	Another example: Programs I use often output "absolute path: " at the
73	beginning of a line when they process multiple files. The following
74	pattern matches the filename (note, there is a single space at the very
75	end):
76
77	URxvt.selection.pattern-0: ^(/[^:]+):\
78
79	You can look at the source of the selection extension to see more
80	interesting uses, such as parsing a line from beginning to end.
81
82	This extension also offers following bindable keyboard commands:
83
84	=over 4
85
86	=item rot13
87
88	Rot-13 the selection when activated. Used via keyboard trigger:
89
90	URxvt.keysym.C-M-r: perl:selection:rot13
91
92	=back
93
94	=item option-popup (enabled by default)
95
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.
98
99	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.
102
103	It's sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as
107	first argument.
108
109	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:
111
112	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};
115
116	=item selection-popup (enabled by default)
117
118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119	text into various other formats/action (such as uri unescaping, perl
120	evaluation, web-browser starting etc.), depending on content.
121
122	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.
125
126	It's sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide wether to add something or not.
128	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.
131
132	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:
135
136	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }
138	: ()
139	};
140
141	=item searchable-scrollback<hotkey> (enabled by default)
142
143	Adds regex search functionality to the scrollback buffer, triggered
144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
145	input/output is suspended and a regex is displayed at the bottom of the
146	screen.
147
148	Inputting characters appends them to the regex and continues incremental
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary
154	selection.
155
156	=item readline (enabled by default)
157
158	A support package that tries to make editing with readline easier. At
159	the moment, it reacts to clicking shift-left mouse button by trying to
160	move the text cursor to this position. It does so by generating as many
161	cursor-left or cursor-right keypresses as required (the this only works
162	for programs that correctly support wide characters).
163
164	To avoid too many false positives, this is only done when:
165
166	=over 4
167
168	=item - the tty is in ICANON state.
169
170	=item - the text cursor is visible.
171
172	=item - the primary screen is currently being displayed.
173
174	=item - the mouse is on the same (multi-row-) line as the text cursor.
175
176	=back
177
178	The normal selection mechanism isn't disabled, so quick successive clicks
179	might interfere with selection creation in harmless ways.
180
181	=item selection-autotransform
182
183	This selection allows you to do automatic transforms on a selection
184	whenever a selection is made.
185
186	It works by specifying perl snippets (most useful is a single C<s///>
187	operator) that modify C<$_> as resources:
188
189	URxvt.selection-autotransform.0: transform
190	URxvt.selection-autotransform.1: transform
191	...
192
193	For example, the following will transform selections of the form
194	C<filename:number>, often seen in compiler messages, into C<vi +$filename
195	$word>:
196
197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
198
199	And this example matches the same,but replaces it with vi-commands you can
200	paste directly into your (vi :) editor:
201
202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
203
204	Of course, this can be modified to suit your needs and your editor :)
205
206	To expand the example above to typical perl error messages ("XXX at
207	FILENAME line YYY."), you need a slightly more elaborate solution:
208
209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
211
212	The first line tells the selection code to treat the unchanging part of
213	every error message as a selection pattern, and the second line transforms
214	the message into vi commands to load the file.
215
216	=item tabbed
217
218	This transforms the terminal into a tabbar with additional terminals, that
219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
221	button per tab.
222
223	Clicking a button will activate that tab. Pressing B<Shift-Left> and
224	B<Shift-Right> will switch to the tab left or right of the current one,
225	while B<Shift-Down> creates a new tab.
226
227	The tabbar itself can be configured similarly to a normal terminal, but
228	with a resource class of C<URxvt.tabbed>. In addition, it supports the
229	following four resources (shown with defaults):
230
231	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
232	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
233	URxvt.tabbed.tab-fg: <colour-index, default 0>
234	URxvt.tabbed.tab-bg: <colour-index, default 1>
235
236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237	indices.
238
239	=item mark-urls
240
241	Uses per-line display filtering (C<on_line_update>) to underline urls and
242	make them clickable. When middle-clicked, the program specified in the
243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
244	the URL as first argument.
245
246	=item xim-onthespot
247
248	This (experimental) perl extension implements OnTheSpot editing. It does
249	not work perfectly, and some input methods don't seem to work well with
250	OnTheSpot editing in general, but it seems to work at leats for SCIM and
251	kinput2.
252
253	You enable it by specifying this extension and a preedit style of
254	C<OnTheSpot>, i.e.:
255
256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257
258	=item automove-background
259
260	This is basically a one-line extension that dynamically changes the background pixmap offset
261	to the window position, in effect creating the same effect as pseudo transparency with
262	a custom pixmap. No scaling is supported in this mode. Exmaple:
263
264	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
265
266	=item block-graphics-to-ascii
267
268	A not very useful example of filtering all text output to the terminal,
269	by replacing all line-drawing characters (U+2500 .. U+259F) by a
270	similar-looking ascii character.
271
272	=item digital-clock
273
274	Displays a digital clock using the built-in overlay.
275
276	=item remote-clipboard
277
278	Somewhat of a misnomer, this extension adds two menu entries to the
279	selection popup that allows one ti run external commands to store the
280	selection somewhere and fetch it again.
281
282	We use it to implement a "distributed selection mechanism", which just
283	means that one command uploads the file to a remote server, and another
284	reads it.
285
286	The commands can be set using the C<URxvt.remote-selection.store> and
287	C<URxvt.remote-selection.fetch> resources. The first should read the
288	selection to store from STDIN (always in UTF-8), the second should provide
289	the selection data on STDOUT (also in UTF-8).
290
291	The defaults (which are likely useless to you) use rsh and cat:
292
293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
295
296	=item selection-pastebin
297
298	This is a little rarely useful extension that Uploads the selection as
299	textfile to a remote site (or does other things). (The implementation is
300	not currently secure for use in a multiuser environment as it writes to
301	F</tmp> directly.).
302
303	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
304	i.e.
305
306	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
307
308	Pressing this combination runs a command with C<%> replaced by the name of
309	the textfile. This command can be set via a resource:
310
311	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
312
313	And the default is likely not useful to anybody but the few people around
314	here :)
315
316	The name of the textfile is the hex encoded md5 sum of the selection, so
317	the same content should lead to the same filename.
318
319	After a successful upload the selection will be replaced by the text given
320	in the C<selection-pastebin-url> resource (again, the % is the placeholder
321	for the filename):
322
323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
324
325	=item example-refresh-hooks
326
327	Displays a very simple digital clock in the upper right corner of the
328	window. Illustrates overwriting the refresh callbacks to create your own
329	overlays or changes.
330
331	=back
332		50
333	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
334		52
335	=head2 General API Considerations	53	=head2 General API Considerations
336		54
…		…
350		68
351	=over 4	69	=over 4
352		70
353	=item $text	71	=item $text
354		72
355	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
356	always represents one screen cell. See L<ROW_t> for a discussion of this format.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
357		75
358	=item $string	76	=item $string
359		77
360	A perl text string, with an emphasis on I<text>. It can store all unicode	78	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
364	=item $octets	82	=item $octets
365		83
366	Either binary data or - more common - a text string encoded in a	84	Either binary data or - more common - a text string encoded in a
367	locale-specific way.	85	locale-specific way.
368		86
		87	=item $keysym
		88
		89	an integer that is a valid X11 keysym code. You can convert a string
		90	into a keysym and viceversa by using C<XStringToKeysym> and
		91	C<XKeysymToString>.
		92
369	=back	93	=back
370		94
371	=head2 Extension Objects	95	=head2 Extension Objects
372		96
373	Very perl extension is a perl class. A separate perl object is created	97	Every perl extension is a perl class. A separate perl object is created
374	for each terminal and each extension and passed as the first parameter to	98	for each terminal, and each terminal has its own set of extension objects,
375	hooks. So extensions can use their C<$self> object without having to think	99	which are passed as the first parameter to hooks. So extensions can use
376	about other extensions, with the exception of methods and members that	100	their C<$self> object without having to think about clashes with other
		101	extensions or other terminals, with the exception of methods and members
377	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
378	use.	103	internal use.
379		104
380	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
381	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
382		107
383	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
384		109	the C<urxvt::extension> section below.
385	=over 4
386
387	=item $urxvt_term = $self->{term}
388
389	Returns the C<urxvt::term> object associated with this instance of the
390	extension. This member I<must not> be changed in any way.
391
392	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
393
394	Dynamically enable the given hooks (named without the C<on_> prefix) for
395	this extension, replacing any previous hook. This is useful when you want
396	to overwrite time-critical hooks only temporarily.
397
398	=item $self->disable ($hook_name[, $hook_name..])
399
400	Dynamically disable the given hooks.
401
402	=back
403		110
404	=head2 Hooks	111	=head2 Hooks
405		112
406	The following subroutines can be declared in extension files, and will be	113	The following subroutines can be declared in extension files, and will be
407	called whenever the relevant event happens.	114	called whenever the relevant event happens.
408		115
409	The first argument passed to them is an extension oject as described in	116	The first argument passed to them is an extension object as described in
410	the in the C<Extension Objects> section.	117	the in the C<Extension Objects> section.
411		118
412	B<All> of these hooks must return a boolean value. If any of the called	119	B<All> of these hooks must return a boolean value. If any of the called
413	hooks returns true, then the event counts as being I<consumed>, and the	120	hooks returns true, then the event counts as being I<consumed>, and the
414	relevant action might not be carried out by the C++ code.	121	relevant action might not be carried out by the C++ code.
…		…
427	place.	134	place.
428		135
429	=item on_start $term	136	=item on_start $term
430		137
431	Called at the very end of initialisation of a new terminal, just before	138	Called at the very end of initialisation of a new terminal, just before
432	trying to map (display) the toplevel and returning to the mainloop.	139	trying to map (display) the toplevel and returning to the main loop.
433		140
434	=item on_destroy $term	141	=item on_destroy $term
435		142
436	Called whenever something tries to destroy terminal, when the terminal is	143	Called whenever something tries to destroy terminal, when the terminal is
437	still fully functional (not for long, though).	144	still fully functional (not for long, though).
…		…
464		171
465	Called whenever a selection has been copied, but before the selection is	172	Called whenever a selection has been copied, but before the selection is
466	requested from the server. The selection text can be queried and changed	173	requested from the server. The selection text can be queried and changed
467	by calling C<< $term->selection >>.	174	by calling C<< $term->selection >>.
468		175
469	Returning a true value aborts selection grabbing. It will still be hilighted.	176	Returning a true value aborts selection grabbing. It will still be highlighted.
470		177
471	=item on_sel_extend $term	178	=item on_sel_extend $term
472		179
473	Called whenever the user tries to extend the selection (e.g. with a double	180	Called whenever the user tries to extend the selection (e.g. with a double
474	click) and is either supposed to return false (normal operation), or	181	click) and is either supposed to return false (normal operation), or
475	should extend the selection itelf and return true to suppress the built-in	182	should extend the selection itself and return true to suppress the built-in
476	processing. This can happen multiple times, as long as the callback	183	processing. This can happen multiple times, as long as the callback
477	returns true, it will be called on every further click by the user and is	184	returns true, it will be called on every further click by the user and is
478	supposed to enlarge the selection more and more, if possible.	185	supposed to enlarge the selection more and more, if possible.
479		186
480	See the F<selection> example extension.	187	See the F<selection> example extension.
481		188
482	=item on_view_change $term, $offset	189	=item on_view_change $term, $offset
483		190
484	Called whenever the view offset changes, i..e the user or program	191	Called whenever the view offset changes, i.e. the user or program
485	scrolls. Offset C<0> means display the normal terminal, positive values	192	scrolls. Offset C<0> means display the normal terminal, positive values
486	show this many lines of scrollback.	193	show this many lines of scrollback.
487		194
488	=item on_scroll_back $term, $lines, $saved	195	=item on_scroll_back $term, $lines, $saved
489		196
…		…
493		200
494	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	201	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
495	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	202	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
496	number of lines that will be in the scrollback buffer.	203	number of lines that will be in the scrollback buffer.
497		204
498	=item on_osc_seq $term, $string	205	=item on_osc_seq $term, $op, $args, $resp
		206
		207	Called on every OSC sequence and can be used to suppress it or modify its
		208	behaviour. The default should be to return an empty list. A true value
		209	suppresses execution of the request completely. Make sure you don't get
		210	confused by recursive invocations when you output an OSC sequence within
		211	this callback.
		212
		213	C<on_osc_seq_perl> should be used for new behaviour.
		214
		215	=item on_osc_seq_perl $term, $args, $resp
499		216
500	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	217	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
501	operating system command) is processed. Cursor position and other state	218	operating system command) is processed. Cursor position and other state
502	information is up-to-date when this happens. For interoperability, the	219	information is up-to-date when this happens. For interoperability, the
503	string should start with the extension name and a colon, to distinguish	220	string should start with the extension name (sans -osc) and a semicolon,
504	it from commands for other extensions, and this might be enforced in the	221	to distinguish it from commands for other extensions, and this might be
505	future.	222	enforced in the future.
		223
		224	For example, C<overlay-osc> uses this:
		225
		226	sub on_osc_seq_perl {
		227	my ($self, $osc, $resp) = @_;
		228
		229	return unless $osc =~ s/^overlay;//;
		230
		231	... process remaining $osc string
		232	}
506		233
507	Be careful not ever to trust (in a security sense) the data you receive,	234	Be careful not ever to trust (in a security sense) the data you receive,
508	as its source can not easily be controleld (e-mail content, messages from	235	as its source can not easily be controlled (e-mail content, messages from
509	other users on the same system etc.).	236	other users on the same system etc.).
		237
		238	For responses, C<$resp> contains the end-of-args separator used by the
		239	sender.
510		240
511	=item on_add_lines $term, $string	241	=item on_add_lines $term, $string
512		242
513	Called whenever text is about to be output, with the text as argument. You	243	Called whenever text is about to be output, with the text as argument. You
514	can filter/change and output the text yourself by returning a true value	244	can filter/change and output the text yourself by returning a true value
…		…
519	=item on_tt_write $term, $octets	249	=item on_tt_write $term, $octets
520		250
521	Called whenever some data is written to the tty/pty and can be used to	251	Called whenever some data is written to the tty/pty and can be used to
522	suppress or filter tty input.	252	suppress or filter tty input.
523		253
		254	=item on_tt_paste $term, $octets
		255
		256	Called whenever text is about to be pasted, with the text as argument. You
		257	can filter/change and paste the text yourself by returning a true value
		258	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		259	locale-encoded.
		260
524	=item on_line_update $term, $row	261	=item on_line_update $term, $row
525		262
526	Called whenever a line was updated or changed. Can be used to filter	263	Called whenever a line was updated or changed. Can be used to filter
527	screen output (e.g. underline urls or other useless stuff). Only lines	264	screen output (e.g. underline urls or other useless stuff). Only lines
528	that are being shown will be filtered, and, due to performance reasons,	265	that are being shown will be filtered, and, due to performance reasons,
…		…
535	later with the already-modified line (e.g. if unrelated parts change), so	272	later with the already-modified line (e.g. if unrelated parts change), so
536	you cannot just toggle rendition bits, but only set them.	273	you cannot just toggle rendition bits, but only set them.
537		274
538	=item on_refresh_begin $term	275	=item on_refresh_begin $term
539		276
540	Called just before the screen gets redrawn. Can be used for overlay	277	Called just before the screen gets redrawn. Can be used for overlay or
541	or similar effects by modify terminal contents in refresh_begin, and	278	similar effects by modifying the terminal contents in refresh_begin, and
542	restoring them in refresh_end. The built-in overlay and selection display	279	restoring them in refresh_end. The built-in overlay and selection display
543	code is run after this hook, and takes precedence.	280	code is run after this hook, and takes precedence.
544		281
545	=item on_refresh_end $term	282	=item on_refresh_end $term
546		283
547	Called just after the screen gets redrawn. See C<on_refresh_begin>.	284	Called just after the screen gets redrawn. See C<on_refresh_begin>.
548		285
549	=item on_user_command $term, $string	286	=item on_user_command $term, $string *DEPRECATED*
550		287
551	Called whenever the a user-configured event is being activated (e.g. via	288	Called whenever a user-configured event is being activated (e.g. via
552	a C<perl:string> action bound to a key, see description of the B<keysym>	289	a C<perl:string> action bound to a key, see description of the B<keysym>
553	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
554		291
555	The event is simply the action string. This interface is assumed to change	292	The event is simply the action string. This interface is going away in
556	slightly in the future.	293	preference to the C<on_action> hook.
557		294
558	=item on_resize_all_windows $tern, $new_width, $new_height	295	=item on_resize_all_windows $term, $new_width, $new_height
559		296
560	Called just after the new window size has been calculcated, but before	297	Called just after the new window size has been calculated, but before
561	windows are actually being resized or hints are being set. If this hook	298	windows are actually being resized or hints are being set. If this hook
562	returns TRUE, setting of the window hints is being skipped.	299	returns a true value, setting of the window hints is being skipped.
563		300
564	=item on_x_event $term, $event	301	=item on_x_event $term, $event
565		302
566	Called on every X event received on the vt window (and possibly other	303	Called on every X event received on the vt window (and possibly other
567	windows). Should only be used as a last resort. Most event structure	304	windows). Should only be used as a last resort. Most event structure
568	members are not passed.	305	members are not passed.
569		306
		307	=item on_root_event $term, $event
		308
		309	Like C<on_x_event>, but is called for events on the root window.
		310
570	=item on_focus_in $term	311	=item on_focus_in $term
571		312
572	Called whenever the window gets the keyboard focus, before rxvt-unicode	313	Called whenever the window gets the keyboard focus, before rxvt-unicode
573	does focus in processing.	314	does focus in processing.
574		315
575	=item on_focus_out $term	316	=item on_focus_out $term
576		317
577	Called wheneever the window loses keyboard focus, before rxvt-unicode does	318	Called whenever the window loses keyboard focus, before rxvt-unicode does
578	focus out processing.	319	focus out processing.
579		320
580	=item on_configure_notify $term, $event	321	=item on_configure_notify $term, $event
581		322
582	=item on_property_notify $term, $event	323	=item on_property_notify $term, $event
…		…
593		334
594	=item on_map_notify $term, $event	335	=item on_map_notify $term, $event
595		336
596	=item on_unmap_notify $term, $event	337	=item on_unmap_notify $term, $event
597		338
598	Called whenever the corresponding X event is received for the terminal If	339	Called whenever the corresponding X event is received for the terminal. If
599	the hook returns true, then the even will be ignored by rxvt-unicode.	340	the hook returns true, then the event will be ignored by rxvt-unicode.
600		341
601	The event is a hash with most values as named by Xlib (see the XEvent	342	The event is a hash with most values as named by Xlib (see the XEvent
602	manpage), with the additional members C<row> and C<col>, which are the	343	manpage), with the additional members C<row> and C<col>, which are the
603	(real, not screen-based) row and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
604		345
605	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
606	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
607		348
608	subwindow.
609
610	=item on_client_message $term, $event	349	=item on_client_message $term, $event
611		350
612	=item on_wm_protocols $term, $event	351	=item on_wm_protocols $term, $event
613		352
614	=item on_wm_delete_window $term, $event	353	=item on_wm_delete_window $term, $event
615		354
616	Called when various types of ClientMessage events are received (all with	355	Called when various types of ClientMessage events are received (all with
617	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	356	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
618		357
		358	=item on_bell $term
		359
		360	Called on receipt of a bell character.
		361
619	=back	362	=back
620		363
621	=cut	364	=cut
622		365
623	package urxvt;	366	package urxvt;
624		367
625	use utf8;	368	use utf8;
626	use strict;	369	use strict 'vars';
627	use Carp ();	370	use Carp ();
628	use Scalar::Util ();	371	use Scalar::Util ();
629	use List::Util ();	372	use List::Util ();
630		373
631	our $VERSION = 1;	374	our $VERSION = 1;
632	our $TERM;	375	our $TERM;
633	our @TERM_INIT;	376	our @TERM_INIT; # should go, prevents async I/O etc.
634	our @TERM_EXT;	377	our @TERM_EXT; # should go, prevents async I/O etc.
635	our @HOOKNAME;	378	our @HOOKNAME;
636	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	379	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
637	our %OPTION;	380	our %OPTION;
638		381
639	our $LIBDIR;	382	our $LIBDIR;
…		…
665	The current terminal. This variable stores the current C<urxvt::term>	408	The current terminal. This variable stores the current C<urxvt::term>
666	object, whenever a callback/hook is executing.	409	object, whenever a callback/hook is executing.
667		410
668	=item @urxvt::TERM_INIT	411	=item @urxvt::TERM_INIT
669		412
670	All coderefs in this array will be called as methods of the next newly	413	All code references in this array will be called as methods of the next newly
671	created C<urxvt::term> object (during the C<on_init> phase). The array	414	created C<urxvt::term> object (during the C<on_init> phase). The array
672	gets cleared before the codereferences that were in it are being executed,	415	gets cleared before the code references that were in it are being executed,
673	so coderefs can push themselves onto it again if they so desire.	416	so references can push themselves onto it again if they so desire.
674		417
675	This complements to the perl-eval commandline option, but gets executed	418	This complements to the perl-eval command line option, but gets executed
676	first.	419	first.
677		420
678	=item @urxvt::TERM_EXT	421	=item @urxvt::TERM_EXT
679		422
680	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	423	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
687		430
688	=over 4	431	=over 4
689		432
690	=item urxvt::fatal $errormessage	433	=item urxvt::fatal $errormessage
691		434
692	Fatally aborts execution with the given error message. Avoid at all	435	Fatally aborts execution with the given error message (which should
693	costs! The only time this is acceptable is when the terminal process	436	include a trailing newline). Avoid at all costs! The only time this
694	starts up.	437	is acceptable (and useful) is in the init hook, where it prevents the
		438	terminal from starting up.
695		439
696	=item urxvt::warn $string	440	=item urxvt::warn $string
697		441
698	Calls C<rxvt_warn> with the given string which should not include a	442	Calls C<rxvt_warn> with the given string which should include a trailing
699	newline. The module also overwrites the C<warn> builtin with a function	443	newline. The module also overwrites the C<warn> builtin with a function
700	that calls this function.	444	that calls this function.
701		445
702	Using this function has the advantage that its output ends up in the	446	Using this function has the advantage that its output ends up in the
703	correct place, e.g. on stderr of the connecting urxvtc client.	447	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
705	Messages have a size limit of 1023 bytes currently.	449	Messages have a size limit of 1023 bytes currently.
706		450
707	=item @terms = urxvt::termlist	451	=item @terms = urxvt::termlist
708		452
709	Returns all urxvt::term objects that exist in this process, regardless of	453	Returns all urxvt::term objects that exist in this process, regardless of
710	wether they are started, being destroyed etc., so be careful. Only term	454	whether they are started, being destroyed etc., so be careful. Only term
711	objects that have perl extensions attached will be returned (because there	455	objects that have perl extensions attached will be returned (because there
712	is no urxvt::term objet associated with others).	456	is no urxvt::term object associated with others).
713		457
714	=item $time = urxvt::NOW	458	=item $time = urxvt::NOW
715		459
716	Returns the "current time" (as per the event loop).	460	Returns the "current time" (as per the event loop).
717		461
…		…
760		504
761	=item $rend = urxvt::OVERLAY_RSTYLE	505	=item $rend = urxvt::OVERLAY_RSTYLE
762		506
763	Return the rendition mask used for overlays by default.	507	Return the rendition mask used for overlays by default.
764		508
765	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	509	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		510	urxvt::RS_RVid, urxvt::RS_Uline
766		511
767	Return the bit that enabled bold, italic, blink, reverse-video and	512	Return the bit that enabled bold, italic, blink, reverse-video and
768	underline, respectively. To enable such a style, just logically OR it into	513	underline, respectively. To enable such a style, just logically OR it into
769	the bitset.	514	the bitset.
770		515
…		…
807	};	552	};
808	}	553	}
809		554
810	no warnings 'utf8';	555	no warnings 'utf8';
811		556
		557	sub parse_resource {
		558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		559
		560	$name =~ y/-/./ if $isarg;
		561
		562	$term->scan_extensions;
		563
		564	my $r = $term->{meta}{resource};
		565	keys %$r; # reset iterator
		566	while (my ($pattern, $v) = each %$r) {
		567	if (
		568	$pattern =~ /\.$/
		569	? $pattern eq substr $name, 0, length $pattern
		570	: $pattern eq $name
		571	) {
		572	$name = "$urxvt::RESCLASS.$name";
		573
		574	push @{ $term->{perl_ext_3} }, $v->[0];
		575
		576	if ($v->[1] eq "boolean") {
		577	$term->put_option_db ($name, $flag ? "true" : "false");
		578	return 1;
		579	} else {
		580	$term->put_option_db ($name, $value);
		581	return 1 + 2;
		582	}
		583	}
		584	}
		585
		586	0
		587	}
		588
		589	sub usage {
		590	my ($term, $usage_type) = @_;
		591
		592	$term->scan_extensions;
		593
		594	my $r = $term->{meta}{resource};
		595
		596	for my $pattern (sort keys %$r) {
		597	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		598
		599	$desc .= " (-pe $ext)";
		600
		601	if ($usage_type == 1) {
		602	$pattern =~ y/./-/;
		603	$pattern =~ s/-$/-.../g;
		604
		605	if ($type eq "boolean") {
		606	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		607	} else {
		608	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		609	}
		610	} else {
		611	$pattern =~ s/\.$/.*/g;
		612	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		613	}
		614	}
		615	}
		616
812	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
813		618
814	sub verbose {	619	sub verbose {
815	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
816	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
…		…
828	$pkg =~ s/[^[:word:]]/_/g;	633	$pkg =~ s/[^[:word:]]/_/g;
829	$pkg = "urxvt::ext::$pkg";	634	$pkg = "urxvt::ext::$pkg";
830		635
831	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
832		637
		638	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		639
833	open my $fh, "<:raw", $path	640	open my $fh, "<:raw", $path
834	or die "$path: $!";	641	or die "$path: $!";
835		642
836	my $source =	643	my $source =
837	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	644	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
838	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
839	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
840	. "\n};\n1";	647	. "\n};\n1";
841		648
842	eval $source	649	eval $source
…		…
851	# called by the rxvt core	658	# called by the rxvt core
852	sub invoke {	659	sub invoke {
853	local $TERM = shift;	660	local $TERM = shift;
854	my $htype = shift;	661	my $htype = shift;
855		662
856	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
857	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	664	my @dirs = $TERM->perl_libdirs;
858		665
		666	$TERM->scan_extensions;
		667
859	my %ext_arg;	668	my %ext_arg;
860		669
861	{	670	{
862	my @init = @TERM_INIT;	671	my @init = @TERM_INIT;
863	@TERM_INIT = ();	672	@TERM_INIT = ();
…		…
865	my @pkg = @TERM_EXT;	674	my @pkg = @TERM_EXT;
866	@TERM_EXT = ();	675	@TERM_EXT = ();
867	$TERM->register_package ($_) for @pkg;	676	$TERM->register_package ($_) for @pkg;
868	}	677	}
869		678
		679	for (
		680	@{ delete $TERM->{perl_ext_3} },
870	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	681	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		682	) {
871	if ($_ eq "default") {	683	if ($_ eq "default") {
872	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	684
		685	$ext_arg{$_} ||= []
		686	for
		687	qw(selection option-popup selection-popup readline),
		688	map $_->[0], values %{ $TERM->{meta}{binding} };
		689
873	} elsif (/^-(.*)$/) {	690	} elsif (/^-(.*)$/) {
874	delete $ext_arg{$1};	691	delete $ext_arg{$1};
		692
875	} elsif (/^([^<]+)<(.*)>$/) {	693	} elsif (/^([^<]+)<(.*)>$/) {
876	push @{ $ext_arg{$1} }, $2;	694	push @{ $ext_arg{$1} }, $2;
		695
877	} else {	696	} else {
878	$ext_arg{$_} ||= [];	697	$ext_arg{$_} ||= [];
879	}	698	}
		699	}
		700
		701	# now register default key bindings
		702	while (my ($k, $v) = each %{ $TERM->{meta}{binding} }) {
		703	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
880	}	704	}
881		705
882	for my $ext (sort keys %ext_arg) {	706	for my $ext (sort keys %ext_arg) {
883	my @files = grep -f $_, map "$_/$ext", @dirs;	707	my @files = grep -f $_, map "$_/$ext", @dirs;
884		708
…		…
897		721
898	if (my $cb = $TERM->{_hook}[$htype]) {	722	if (my $cb = $TERM->{_hook}[$htype]) {
899	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	723	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
900	if $verbosity >= 10;	724	if $verbosity >= 10;
901		725
902	keys %$cb;	726	if ($htype == HOOK_ACTION) {
		727	# this hook is only sent to the extension with the name
		728	# matching the first arg
		729	my $pkg = shift;
		730	$pkg =~ y/-/_/;
		731	$pkg = "urxvt::ext::$pkg";
903		732
904	while (my ($pkg, $cb) = each %$cb) {	733	$cb = $cb->{$pkg}
		734	or return undef; #TODO: maybe warn user?
		735
		736	$cb = { $pkg => $cb };
		737	}
		738
		739	for my $pkg (keys %$cb) {
905	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
906	$retval ||= $retval_;	741	$retval ||= $retval_;
907		742
908	if ($@) {	743	if ($@) {
909	$TERM->ungrab; # better to lose the grab than the session	744	$TERM->ungrab; # better to lose the grab than the session
910	warn $@;	745	warn $@;
…		…
913		748
914	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
915	if $verbosity >= 11;	750	if $verbosity >= 11;
916	}	751	}
917		752
918	if ($htype == 1) { # DESTROY	753	if ($htype == HOOK_DESTROY) {
919	# clear package objects	754	# clear package objects
920	%$_ = () for values %{ $TERM->{_pkg} };	755	%$_ = () for values %{ $TERM->{_pkg} };
921		756
922	# clear package	757	# clear package
923	%$TERM = ();	758	%$TERM = ();
…		…
928		763
929	sub SET_COLOR($$$) {	764	sub SET_COLOR($$$) {
930	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	765	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
931	}	766	}
932		767
933	# urxvt::term::extension	768	sub rend2mask {
		769	no strict 'refs';
		770	my ($str, $mask) = (@_, 0);
		771	my %color = ( fg => undef, bg => undef );
		772	my @failed;
		773	for my $spec ( split /\s+/, $str ) {
		774	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		775	$color{lc($1)} = $2;
		776	} else {
		777	my $neg = $spec =~ s/^[-^]//;
		778	unless ( exists &{"RS_$spec"} ) {
		779	push @failed, $spec;
		780	next;
		781	}
		782	my $cur = &{"RS_$spec"};
		783	if ( $neg ) {
		784	$mask &= ~$cur;
		785	} else {
		786	$mask |= $cur;
		787	}
		788	}
		789	}
		790	($mask, @color{qw(fg bg)}, \@failed)
		791	}
934		792
935	package urxvt::term::extension;	793	package urxvt::term::extension;
936		794
937	sub enable {	795	=head2 The C<urxvt::term::extension> class
938	my ($self, %hook) = @_;
939	my $pkg = $self->{_pkg};
940		796
941	while (my ($name, $cb) = each %hook) {	797	Each extension attached to a terminal object is represented by
942	my $htype = $HOOKTYPE{uc $name};	798	a C<urxvt::term::extension> object.
943	defined $htype
944	or Carp::croak "unsupported hook type '$name'";
945		799
946	$self->set_should_invoke ($htype, +1)	800	You can use these objects, which are passed to all callbacks to store any
947	unless exists $self->{term}{_hook}[$htype]{$pkg};	801	state related to the terminal and extension instance.
948		802
949	$self->{term}{_hook}[$htype]{$pkg} = $cb;	803	The methods (And data members) documented below can be called on extension
950	}	804	objects, in addition to call methods documented for the <urxvt::term>
951	}	805	class.
952		806
953	sub disable {	807	=over 4
954	my ($self, @hook) = @_;
955	my $pkg = $self->{_pkg};
956		808
957	for my $name (@hook) {	809	=item $urxvt_term = $self->{term}
958	my $htype = $HOOKTYPE{uc $name};
959	defined $htype
960	or Carp::croak "unsupported hook type '$name'";
961		810
962	$self->set_should_invoke ($htype, -1)	811	Returns the C<urxvt::term> object associated with this instance of the
963	if delete $self->{term}{_hook}[$htype]{$pkg};	812	extension. This member I<must not> be changed in any way.
964	}	813
965	}	814	=cut
966		815
967	our $AUTOLOAD;	816	our $AUTOLOAD;
968		817
969	sub AUTOLOAD {	818	sub AUTOLOAD {
970	$AUTOLOAD =~ /:([^:]+)$/	819	$AUTOLOAD =~ /:([^:]+)$/
…		…
983		832
984	sub DESTROY {	833	sub DESTROY {
985	# nop	834	# nop
986	}	835	}
987		836
988	# urxvt::destroy_hook	837	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
989		838
990	sub urxvt::destroy_hook::DESTROY {	839	sub urxvt::destroy_hook::DESTROY {
991	${$_[0]}->();	840	${$_[0]}->();
992	}	841	}
993		842
994	sub urxvt::destroy_hook(&) {	843	sub urxvt::destroy_hook(&) {
995	bless \shift, urxvt::destroy_hook::	844	bless \shift, urxvt::destroy_hook::
996	}	845	}
		846
		847	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		848
		849	Dynamically enable the given hooks (named without the C<on_> prefix) for
		850	this extension, replacing any hook previously installed via C<enable> in
		851	this extension.
		852
		853	This is useful when you want to overwrite time-critical hooks only
		854	temporarily.
		855
		856	To install additional callbacks for the same hook, you can use the C<on>
		857	method of the C<urxvt::term> class.
		858
		859	=item $self->disable ($hook_name[, $hook_name..])
		860
		861	Dynamically disable the given hooks.
		862
		863	=cut
		864
		865	sub enable {
		866	my ($self, %hook) = @_;
		867	my $pkg = $self->{_pkg};
		868
		869	while (my ($name, $cb) = each %hook) {
		870	my $htype = $HOOKTYPE{uc $name};
		871	defined $htype
		872	or Carp::croak "unsupported hook type '$name'";
		873
		874	$self->set_should_invoke ($htype, +1)
		875	unless exists $self->{term}{_hook}[$htype]{$pkg};
		876
		877	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		878	}
		879	}
		880
		881	sub disable {
		882	my ($self, @hook) = @_;
		883	my $pkg = $self->{_pkg};
		884
		885	for my $name (@hook) {
		886	my $htype = $HOOKTYPE{uc $name};
		887	defined $htype
		888	or Carp::croak "unsupported hook type '$name'";
		889
		890	$self->set_should_invoke ($htype, -1)
		891	if delete $self->{term}{_hook}[$htype]{$pkg};
		892	}
		893	}
		894
		895	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		896
		897	Similar to the C<enable> enable, but installs additional callbacks for
		898	the given hook(s) (that is, it doesn't replace existing callbacks), and
		899	returns a guard object. When the guard object is destroyed the callbacks
		900	are disabled again.
		901
		902	=cut
		903
		904	sub urxvt::extension::on_disable::DESTROY {
		905	my $disable = shift;
		906
		907	my $term = delete $disable->{""};
		908
		909	while (my ($htype, $id) = each %$disable) {
		910	delete $term->{_hook}[$htype]{$id};
		911	$term->set_should_invoke ($htype, -1);
		912	}
		913	}
		914
		915	sub on {
		916	my ($self, %hook) = @_;
		917
		918	my $term = $self->{term};
		919
		920	my %disable = ( "" => $term );
		921
		922	while (my ($name, $cb) = each %hook) {
		923	my $htype = $HOOKTYPE{uc $name};
		924	defined $htype
		925	or Carp::croak "unsupported hook type '$name'";
		926
		927	$term->set_should_invoke ($htype, +1);
		928	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		929	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		930	}
		931
		932	bless \%disable, "urxvt::extension::on_disable"
		933	}
		934
		935	=item $self->x_resource ($pattern)
		936
		937	=item $self->x_resource_boolean ($pattern)
		938
		939	These methods support an additional C<%> prefix when called on an
		940	extension object - see the description of these methods in the
		941	C<urxvt::term> class for details.
		942
		943	=cut
		944
		945	sub x_resource {
		946	my ($self, $name) = @_;
		947	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		948	$self->{term}->x_resource ($name)
		949	}
		950
		951	sub x_resource_boolean {
		952	my ($self, $name) = @_;
		953	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		954	$self->{term}->x_resource_boolean ($name)
		955	}
		956
		957	=back
		958
		959	=cut
997		960
998	package urxvt::anyevent;	961	package urxvt::anyevent;
999		962
1000	=head2 The C<urxvt::anyevent> Class	963	=head2 The C<urxvt::anyevent> Class
1001		964
1002	The sole purpose of this class is to deliver an interface to the	965	The sole purpose of this class is to deliver an interface to the
1003	C<AnyEvent> module - any module using it will work inside urxvt without	966	C<AnyEvent> module - any module using it will work inside urxvt without
1004	further programming. The only exception is that you cannot wait on	967	further programming. The only exception is that you cannot wait on
1005	condition variables, but non-blocking condvar use is ok. What this means	968	condition variables, but non-blocking condvar use is ok.
1006	is that you cannot use blocking APIs, but the non-blocking variant should
1007	work.
1008		969
1009	=cut	970	In practical terms this means is that you cannot use blocking APIs, but
		971	the non-blocking variant should work.
1010		972
		973	=cut
		974
1011	our $VERSION = 1;	975	our $VERSION = '5.23';
1012		976
1013	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	977	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1014	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	978	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1015		979
1016	sub timer {	980	sub timer {
…		…
1018		982
1019	my $cb = $arg{cb};	983	my $cb = $arg{cb};
1020		984
1021	urxvt::timer	985	urxvt::timer
1022	->new	986	->new
1023	->start (urxvt::NOW + $arg{after})	987	->after ($arg{after}, $arg{interval})
1024	->cb (sub {	988	->cb ($arg{interval} ? $cb : sub {
1025	$_[0]->stop; # need to cancel manually	989	$_[0]->stop; # need to cancel manually
1026	$cb->();	990	$cb->();
1027	})	991	})
1028	}	992	}
1029		993
1030	sub io {	994	sub io {
1031	my ($class, %arg) = @_;	995	my ($class, %arg) = @_;
1032		996
1033	my $cb = $arg{cb};	997	my $cb = $arg{cb};
		998	my $fd = fileno $arg{fh};
		999	defined $fd or $fd = $arg{fh};
1034		1000
1035	bless [$arg{fh}, urxvt::iow	1001	bless [$arg{fh}, urxvt::iow
1036	->new	1002	->new
1037	->fd (fileno $arg{fh})	1003	->fd ($fd)
1038	->events (($arg{poll} =~ /r/ ? 1 : 0)	1004	->events (($arg{poll} =~ /r/ ? 1 : 0)
1039	| ($arg{poll} =~ /w/ ? 2 : 0))	1005	| ($arg{poll} =~ /w/ ? 2 : 0))
1040	->start	1006	->start
1041	->cb (sub {	1007	->cb ($cb)
1042	$cb->(($_[1] & 1 ? 'r' : '')
1043	. ($_[1] & 2 ? 'w' : ''));
1044	})],
1045	urxvt::anyevent::	1008	], urxvt::anyevent::
		1009	}
		1010
		1011	sub idle {
		1012	my ($class, %arg) = @_;
		1013
		1014	my $cb = $arg{cb};
		1015
		1016	urxvt::iw
		1017	->new
		1018	->start
		1019	->cb ($cb)
		1020	}
		1021
		1022	sub child {
		1023	my ($class, %arg) = @_;
		1024
		1025	my $cb = $arg{cb};
		1026
		1027	urxvt::pw
		1028	->new
		1029	->start ($arg{pid})
		1030	->cb (sub {
		1031	$_[0]->stop; # need to cancel manually
		1032	$cb->($_[0]->rpid, $_[0]->rstatus);
		1033	})
1046	}	1034	}
1047		1035
1048	sub DESTROY {	1036	sub DESTROY {
1049	$_[0][1]->stop;	1037	$_[0][1]->stop;
1050	}	1038	}
1051		1039
1052	sub condvar {	1040	# only needed for AnyEvent < 6 compatibility
1053	bless \my $flag, urxvt::anyevent::condvar::	1041	sub one_event {
1054	}
1055
1056	sub urxvt::anyevent::condvar::broadcast {
1057	${$_[0]}++;
1058	}
1059
1060	sub urxvt::anyevent::condvar::wait {
1061	unless (${$_[0]}) {
1062	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1042	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1063	}
1064	}	1043	}
1065		1044
1066	package urxvt::term;	1045	package urxvt::term;
1067		1046
1068	=head2 The C<urxvt::term> Class	1047	=head2 The C<urxvt::term> Class
…		…
1081	urxvt::verbose 6, "register package $pkg to $self";	1060	urxvt::verbose 6, "register package $pkg to $self";
1082		1061
1083	@{"$pkg\::ISA"} = urxvt::term::extension::;	1062	@{"$pkg\::ISA"} = urxvt::term::extension::;
1084		1063
1085	my $proxy = bless {	1064	my $proxy = bless {
1086	_pkg => $pkg,	1065	_pkg => $pkg,
		1066	_name => ${"$pkg\::_NAME"}, # hackish
1087	argv => $argv,	1067	argv => $argv,
1088	}, $pkg;	1068	}, $pkg;
1089	Scalar::Util::weaken ($proxy->{term} = $self);	1069	Scalar::Util::weaken ($proxy->{term} = $self);
1090		1070
1091	$self->{_pkg}{$pkg} = $proxy;	1071	$self->{_pkg}{$pkg} = $proxy;
1092		1072
…		…
1095	$proxy->enable ($name => $ref);	1075	$proxy->enable ($name => $ref);
1096	}	1076	}
1097	}	1077	}
1098	}	1078	}
1099		1079
		1080	sub perl_libdirs {
		1081	map { split /:/ }
		1082	$_[0]->resource ("perl_lib"),
		1083	$ENV{URXVT_PERL_LIB},
		1084	"$ENV{HOME}/.urxvt/ext",
		1085	"$LIBDIR/perl"
		1086	}
		1087
		1088	# scan for available extensions and collect their metadata
		1089	sub scan_extensions {
		1090	my ($self) = @_;
		1091
		1092	return if exists $self->{meta};
		1093
		1094	my @libdirs = perl_libdirs $self;
		1095
		1096	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
		1097
		1098	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
		1099	$self->{meta} = \my %meta;
		1100
		1101	# first gather extensions
		1102	for my $dir (reverse @libdirs) {
		1103	opendir my $fh, $dir
		1104	or next;
		1105	for my $ext (readdir $fh) {
		1106	$ext !~ /^\./
		1107	and open my $fh, "<", "$dir/$ext"
		1108	or next;
		1109
		1110	my %ext = (dir => $dir);
		1111
		1112	while (<$fh>) {
		1113	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1114	my ($pattern, $type, $desc) = split /:/, $1;
		1115	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1116	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1117	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1118	} else {
		1119	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1120	}
		1121	} elsif (/^#:META:BINDING:(.*)/) {
		1122	my ($keysym, $action) = split /:/, $1;
		1123	$ext{binding}{$keysym} = [$ext, $action];
		1124	} elsif (/^\s*(?:#|$)/) {
		1125	# skip other comments and empty lines
		1126	} else {
		1127	last; # stop parsing on first non-empty non-comment line
		1128	}
		1129	}
		1130
		1131	$meta{ext}{$ext} = \%ext;
		1132	}
		1133	}
		1134
		1135	# and now merge resources and bindings
		1136	while (my ($k, $v) = each %{ $meta{ext} }) {
		1137	#TODO: should check for extensions overriding each other
		1138	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1139	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
		1140	}
		1141	}
		1142
1100	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1143	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1101		1144
1102	Creates a new terminal, very similar as if you had started it with system	1145	Creates a new terminal, very similar as if you had started it with system
1103	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1146	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1104	hash which defines the environment of the new terminal.	1147	hash which defines the environment of the new terminal.
…		…
1121	}	1164	}
1122		1165
1123	=item $term->destroy	1166	=item $term->destroy
1124		1167
1125	Destroy the terminal object (close the window, free resources	1168	Destroy the terminal object (close the window, free resources
1126	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1169	etc.). Please note that urxvt will not exit as long as any event
1127	watchers (timers, io watchers) are still active.	1170	watchers (timers, io watchers) are still active.
1128		1171
1129	=item $term->exec_async ($cmd[, @args])	1172	=item $term->exec_async ($cmd[, @args])
1130		1173
1131	Works like the combination of the C<fork>/C<exec> builtins, which executes	1174	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1155		1198
1156	Returns true if the option specified by C<$optval> is enabled, and	1199	Returns true if the option specified by C<$optval> is enabled, and
1157	optionally change it. All option values are stored by name in the hash	1200	optionally change it. All option values are stored by name in the hash
1158	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1201	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1159		1202
1160	Here is a a likely non-exhaustive list of option names, please see the	1203	Here is a likely non-exhaustive list of option names, please see the
1161	source file F</src/optinc.h> to see the actual list:	1204	source file F</src/optinc.h> to see the actual list:
1162		1205
1163	borderLess console cursorBlink cursorUnderline hold iconic insecure	1206	borderLess buffered console cursorBlink cursorUnderline hold iconic
1164	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1207	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1165	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1208	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1166	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1209	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1167	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1210	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1168	transparent tripleclickwords utmpInhibit visualBell	1211	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1212	urgentOnBell utmpInhibit visualBell
1169		1213
1170	=item $value = $term->resource ($name[, $newval])	1214	=item $value = $term->resource ($name[, $newval])
1171		1215
1172	Returns the current resource value associated with a given name and	1216	Returns the current resource value associated with a given name and
1173	optionally sets a new value. Setting values is most useful in the C<init>	1217	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1182	likely change).	1226	likely change).
1183		1227
1184	Please note that resource strings will currently only be freed when the	1228	Please note that resource strings will currently only be freed when the
1185	terminal is destroyed, so changing options frequently will eat memory.	1229	terminal is destroyed, so changing options frequently will eat memory.
1186		1230
1187	Here is a a likely non-exhaustive list of resource names, not all of which	1231	Here is a likely non-exhaustive list of resource names, not all of which
1188	are supported in every build, please see the source file F</src/rsinc.h>	1232	are supported in every build, please see the source file F</src/rsinc.h>
1189	to see the actual list:	1233	to see the actual list:
1190		1234
1191	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1235	answerbackstring backgroundPixmap backspace_key blurradius
1192	borderLess color cursorBlink cursorUnderline cutchars delete_key	1236	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1193	display_name embed ext_bwidth fade font geometry hold iconName	1237	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1194	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1238	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1239	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1195	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1240	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1196	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1241	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1197	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1242	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1198	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1243	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1199	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1244	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1200	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1245	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1201	secondaryScreen secondaryScroll selectstyle shade term_name title	1246	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1202	transient_for transparent transparent_all tripleclickwords utmpInhibit	1247	term_name title transient_for transparent tripleclickwords urgentOnBell
1203	visualBell	1248	utmpInhibit visualBell
1204		1249
1205	=cut	1250	=cut
1206		1251
1207	sub resource($$;$) {	1252	sub resource($$;$) {
1208	my ($self, $name) = (shift, shift);	1253	my ($self, $name) = (shift, shift);
1209	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1254	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1210	&urxvt::term::_resource	1255	goto &urxvt::term::_resource
1211	}	1256	}
1212		1257
1213	=item $value = $term->x_resource ($pattern)	1258	=item $value = $term->x_resource ($pattern)
1214		1259
1215	Returns the X-Resource for the given pattern, excluding the program or	1260	Returns the X-Resource for the given pattern, excluding the program or
1216	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1261	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1217	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1262	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1218	resource with that pattern exists.	1263	resource with that pattern exists.
1219		1264
		1265	Extensions that define extra resource or command line arguments also need
		1266	to call this method to access their values.
		1267
		1268	If the method is called on an extension object (basically, from an
		1269	extension), then the special prefix C<%.> will be replaced by the name of
		1270	the extension and a dot, and the lone string C<%> will be replaced by the
		1271	extension name itself. This makes it possible to code extensions so you
		1272	can rename them and get a new set of commandline switches and resources
		1273	without having to change the actual code.
		1274
1220	This method should only be called during the C<on_start> hook, as there is	1275	This method should only be called during the C<on_start> hook, as there is
1221	only one resource database per display, and later invocations might return	1276	only one resource database per display, and later invocations might return
1222	the wrong resources.	1277	the wrong resources.
1223		1278
1224	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1279	=item $value = $term->x_resource_boolean ($pattern)
1225		1280
		1281	Like C<x_resource>, above, but interprets the string value as a boolean
		1282	and returns C<1> for true values, C<0> for false values and C<undef> if
		1283	the resource or option isn't specified.
		1284
		1285	You should always use this method to parse boolean resources.
		1286
		1287	=cut
		1288
		1289	sub x_resource_boolean {
		1290	my $res = &x_resource;
		1291
		1292	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1293	}
		1294
		1295	=item $success = $term->bind_action ($key, $octets)
		1296
1226	Adds a keymap translation exactly as specified via a resource. See the	1297	Adds a key binding exactly as specified via a C<keysym> resource. See the
1227	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1298	C<keysym> resource in the urxvt(1) manpage.
1228		1299
1229	=item $rend = $term->rstyle ([$new_rstyle])	1300	=item $rend = $term->rstyle ([$new_rstyle])
1230		1301
1231	Return and optionally change the current rendition. Text that is output by	1302	Return and optionally change the current rendition. Text that is output by
1232	the terminal application will use this style.	1303	the terminal application will use this style.
…		…
1240		1311
1241	=item ($row, $col) = $term->selection_beg ([$row, $col])	1312	=item ($row, $col) = $term->selection_beg ([$row, $col])
1242		1313
1243	=item ($row, $col) = $term->selection_end ([$row, $col])	1314	=item ($row, $col) = $term->selection_end ([$row, $col])
1244		1315
1245	Return the current values of the selection mark, begin or end positions,	1316	Return the current values of the selection mark, begin or end positions.
1246	and optionally set them to new values.	1317
		1318	When arguments are given, then the selection coordinates are set to
		1319	C<$row> and C<$col>, and the selection screen is set to the current
		1320	screen.
		1321
		1322	=item $screen = $term->selection_screen ([$screen])
		1323
		1324	Returns the current selection screen, and then optionally sets it.
1247		1325
1248	=item $term->selection_make ($eventtime[, $rectangular])	1326	=item $term->selection_make ($eventtime[, $rectangular])
1249		1327
1250	Tries to make a selection as set by C<selection_beg> and	1328	Tries to make a selection as set by C<selection_beg> and
1251	C<selection_end>. If C<$rectangular> is true (default: false), a	1329	C<selection_end>. If C<$rectangular> is true (default: false), a
1252	rectangular selection will be made. This is the prefered function to make	1330	rectangular selection will be made. This is the preferred function to make
1253	a selection.	1331	a selection.
1254		1332
1255	=item $success = $term->selection_grab ($eventtime)	1333	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1256		1334
1257	Try to request the primary selection text from the server (for example, as	1335	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1336	true) selection from the server. The corresponding text can be set
1258	set by the next method). No visual feedback will be given. This function	1337	with the next method. No visual feedback will be given. This function
1259	is mostly useful from within C<on_sel_grab> hooks.	1338	is mostly useful from within C<on_sel_grab> hooks.
1260		1339
1261	=item $oldtext = $term->selection ([$newtext])	1340	=item $oldtext = $term->selection ([$newtext, $clipboard])
1262		1341
1263	Return the current selection text and optionally replace it by C<$newtext>.	1342	Return the current selection (clipboard if C<$clipboard> is true) text
		1343	and optionally replace it by C<$newtext>.
		1344
		1345	=item $term->selection_clear ([$clipboard])
		1346
		1347	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1264		1348
1265	=item $term->overlay_simple ($x, $y, $text)	1349	=item $term->overlay_simple ($x, $y, $text)
1266		1350
1267	Create a simple multi-line overlay box. See the next method for details.	1351	Create a simple multi-line overlay box. See the next method for details.
1268		1352
…		…
1298		1382
1299	The methods currently supported on C<urxvt::overlay> objects are:	1383	The methods currently supported on C<urxvt::overlay> objects are:
1300		1384
1301	=over 4	1385	=over 4
1302		1386
1303	=item $overlay->set ($x, $y, $text, $rend)	1387	=item $overlay->set ($x, $y, $text[, $rend])
1304		1388
1305	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1389	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1306	text in rxvt-unicode's special encoding and an array of rendition values	1390	text in rxvt-unicode's special encoding and an array of rendition values
1307	at a specific position inside the overlay.	1391	at a specific position inside the overlay.
		1392
		1393	If C<$rend> is missing, then the rendition will not be changed.
1308		1394
1309	=item $overlay->hide	1395	=item $overlay->hide
1310		1396
1311	If visible, hide the overlay, but do not destroy it.	1397	If visible, hide the overlay, but do not destroy it.
1312		1398
…		…
1394	locale-specific encoding of the terminal and can contain command sequences	1480	locale-specific encoding of the terminal and can contain command sequences
1395	(escape codes) that will be interpreted.	1481	(escape codes) that will be interpreted.
1396		1482
1397	=item $term->tt_write ($octets)	1483	=item $term->tt_write ($octets)
1398		1484
1399	Write the octets given in C<$data> to the tty (i.e. as program input). To	1485	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1400	pass characters instead of octets, you should convert your strings first	1486	pass characters instead of octets, you should convert your strings first
1401	to the locale-specific encoding using C<< $term->locale_encode >>.	1487	to the locale-specific encoding using C<< $term->locale_encode >>.
		1488
		1489	=item $term->tt_write_user_input ($octets)
		1490
		1491	Like C<tt_write>, but should be used when writing strings in response to
		1492	the user pressing a key, to invokes the additional actions requested by
		1493	the user for that case (C<tt_write> doesn't do that).
		1494
		1495	The typical use case would be inside C<on_action> hooks.
		1496
		1497	=item $term->tt_paste ($octets)
		1498
		1499	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1500	CR and bracketing the data with control sequences if bracketed paste mode
		1501	is set.
1402		1502
1403	=item $old_events = $term->pty_ev_events ([$new_events])	1503	=item $old_events = $term->pty_ev_events ([$new_events])
1404		1504
1405	Replaces the event mask of the pty watcher by the given event mask. Can	1505	Replaces the event mask of the pty watcher by the given event mask. Can
1406	be used to suppress input and output handling to the pty/tty. See the	1506	be used to suppress input and output handling to the pty/tty. See the
…		…
1425	Adds the specified events to the vt event mask. Useful e.g. when you want	1525	Adds the specified events to the vt event mask. Useful e.g. when you want
1426	to receive pointer events all the times:	1526	to receive pointer events all the times:
1427		1527
1428	$term->vt_emask_add (urxvt::PointerMotionMask);	1528	$term->vt_emask_add (urxvt::PointerMotionMask);
1429		1529
		1530	=item $term->set_urgency ($set)
		1531
		1532	Enable/disable the urgency hint on the toplevel window.
		1533
1430	=item $term->focus_in	1534	=item $term->focus_in
1431		1535
1432	=item $term->focus_out	1536	=item $term->focus_out
1433		1537
1434	=item $term->key_press ($state, $keycode[, $time])	1538	=item $term->key_press ($state, $keycode[, $time])
…		…
1474	=item $env = $term->env	1578	=item $env = $term->env
1475		1579
1476	Returns a copy of the environment in effect for the terminal as a hashref	1580	Returns a copy of the environment in effect for the terminal as a hashref
1477	similar to C<\%ENV>.	1581	similar to C<\%ENV>.
1478		1582
		1583	=item @envv = $term->envv
		1584
		1585	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1586
		1587	=item @argv = $term->argv
		1588
		1589	Return the argument vector as this terminal, similar to @ARGV, but
		1590	includes the program name as first element.
		1591
1479	=cut	1592	=cut
1480		1593
1481	sub env {	1594	sub env {
1482	if (my $env = $_[0]->_env) {
1483	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1595	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1484	} else {
1485	+{ %ENV }
1486	}
1487	}	1596	}
1488		1597
1489	=item $modifiermask = $term->ModLevel3Mask	1598	=item $modifiermask = $term->ModLevel3Mask
1490		1599
1491	=item $modifiermask = $term->ModMetaMask	1600	=item $modifiermask = $term->ModMetaMask
…		…
1499		1608
1500	Returns the currently displayed screen (0 primary, 1 secondary).	1609	Returns the currently displayed screen (0 primary, 1 secondary).
1501		1610
1502	=item $cursor_is_hidden = $term->hidden_cursor	1611	=item $cursor_is_hidden = $term->hidden_cursor
1503		1612
1504	Returns wether the cursor is currently hidden or not.	1613	Returns whether the cursor is currently hidden or not.
1505		1614
1506	=item $view_start = $term->view_start ([$newvalue])	1615	=item $view_start = $term->view_start ([$newvalue])
1507		1616
1508	Returns the row number of the topmost displayed line. Maximum value is	1617	Returns the row number of the topmost displayed line. Maximum value is
1509	C<0>, which displays the normal terminal contents. Lower values scroll	1618	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1517		1626
1518	Used after changing terminal contents to display them.	1627	Used after changing terminal contents to display them.
1519		1628
1520	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1629	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1521		1630
1522	Returns the text of the entire row with number C<$row_number>. Row C<0>	1631	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1523	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1632	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1524	terminal line. The scrollback buffer starts at line C<-1> and extends to
1525	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1633	terminal line. Nothing will be returned if a nonexistent line
1526	is requested.	1634	is requested.
1527		1635
1528	If C<$new_text> is specified, it will replace characters in the current	1636	If C<$new_text> is specified, it will replace characters in the current
1529	line, starting at column C<$start_col> (default C<0>), which is useful	1637	line, starting at column C<$start_col> (default C<0>), which is useful
1530	to replace only parts of a line. The font index in the rendition will	1638	to replace only parts of a line. The font index in the rendition will
1531	automatically be updated.	1639	automatically be updated.
1532		1640
1533	C<$text> is in a special encoding: tabs and wide characters that use more	1641	C<$text> is in a special encoding: tabs and wide characters that use more
1534	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1642	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1535	characters. Characters with combining characters and other characters that	1643	characters. Characters with combining characters and other characters that
1536	do not fit into the normal tetx encoding will be replaced with characters	1644	do not fit into the normal text encoding will be replaced with characters
1537	in the private use area.	1645	in the private use area.
1538		1646
1539	You have to obey this encoding when changing text. The advantage is	1647	You have to obey this encoding when changing text. The advantage is
1540	that C<substr> and similar functions work on screen cells and not on	1648	that C<substr> and similar functions work on screen cells and not on
1541	characters.	1649	characters.
…		…
1626	}	1734	}
1627		1735
1628	sub urxvt::line::t {	1736	sub urxvt::line::t {
1629	my ($self) = @_;	1737	my ($self) = @_;
1630		1738
1631	if (@_ > 1)	1739	if (@_ > 1) {
1632	{
1633	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1740	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1634	for $self->{beg} .. $self->{end};	1741	for $self->{beg} .. $self->{end};
1635	}	1742	}
1636		1743
1637	defined wantarray &&	1744	defined wantarray &&
1638	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1745	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1639	0, $self->{len}	1746	0, $self->{len}
1640	}	1747	}
1641		1748
1642	sub urxvt::line::r {	1749	sub urxvt::line::r {
1643	my ($self) = @_;	1750	my ($self) = @_;
1644		1751
1645	if (@_ > 1)	1752	if (@_ > 1) {
1646	{
1647	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1753	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1648	for $self->{beg} .. $self->{end};	1754	for $self->{beg} .. $self->{end};
1649	}	1755	}
1650		1756
1651	if (defined wantarray) {	1757	if (defined wantarray) {
1652	my $rend = [	1758	my $rend = [
1653	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1759	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1654	];	1760	];
…		…
1686	where one character corresponds to one screen cell. See	1792	where one character corresponds to one screen cell. See
1687	C<< $term->ROW_t >> for details.	1793	C<< $term->ROW_t >> for details.
1688		1794
1689	=item $string = $term->special_decode $text	1795	=item $string = $term->special_decode $text
1690		1796
1691	Converts rxvt-unicodes text reprsentation into a perl string. See	1797	Converts rxvt-unicodes text representation into a perl string. See
1692	C<< $term->ROW_t >> for details.	1798	C<< $term->ROW_t >> for details.
1693		1799
1694	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1800	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1695		1801
1696	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1802	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1699	manpage.	1805	manpage.
1700		1806
1701	=item $success = $term->grab ($eventtime[, $sync])	1807	=item $success = $term->grab ($eventtime[, $sync])
1702		1808
1703	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1809	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1704	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1810	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1705		1811
1706	=item $term->allow_events_async	1812	=item $term->allow_events_async
1707		1813
1708	Calls XAllowEvents with AsyncBoth for the most recent grab.	1814	Calls XAllowEvents with AsyncBoth for the most recent grab.
1709		1815
…		…
1716	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1822	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1717	recent grab.	1823	recent grab.
1718		1824
1719	=item $term->ungrab	1825	=item $term->ungrab
1720		1826
1721	Calls XUngrab for the most recent grab. Is called automatically on	1827	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1722	evaluation errors, as it is better to lose the grab in the error case as	1828	evaluation errors, as it is better to lose the grab in the error case as
1723	the session.	1829	the session.
1724		1830
1725	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1831	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1726		1832
…		…
1728		1834
1729	=item @atoms = $term->XListProperties ($window)	1835	=item @atoms = $term->XListProperties ($window)
1730		1836
1731	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1837	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1732		1838
1733	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1839	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1734		1840
1735	=item $term->XDeleteProperty ($window, $property)	1841	=item $term->XDeleteProperty ($window, $property)
1736		1842
1737	=item $window = $term->DefaultRootWindow	1843	=item $window = $term->DefaultRootWindow
1738		1844
…		…
1745	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1851	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1746		1852
1747	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1853	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1748		1854
1749	=item $term->XChangeInput ($window, $add_events[, $del_events])	1855	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1856
		1857	=item $keysym = $term->XStringToKeysym ($string)
		1858
		1859	=item $string = $term->XKeysymToString ($keysym)
1750		1860
1751	Various X or X-related functions. The C<$term> object only serves as	1861	Various X or X-related functions. The C<$term> object only serves as
1752	the source of the display, otherwise those functions map more-or-less	1862	the source of the display, otherwise those functions map more-or-less
1753	directory onto the X functions of the same name.	1863	directly onto the X functions of the same name.
1754		1864
1755	=back	1865	=back
1756		1866
1757	=cut	1867	=cut
1758		1868
…		…
1860	my $env = $self->{term}->env;	1970	my $env = $self->{term}->env;
1861	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1971	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1862	delete $env->{LC_ALL};	1972	delete $env->{LC_ALL};
1863	$env->{LC_CTYPE} = $self->{term}->locale;	1973	$env->{LC_CTYPE} = $self->{term}->locale;
1864		1974
1865	urxvt::term->new ($env, "popup",	1975	my $term = urxvt::term->new (
		1976	$env, "popup",
1866	"--perl-lib" => "", "--perl-ext-common" => "",	1977	"--perl-lib" => "", "--perl-ext-common" => "",
1867	"-pty-fd" => -1, "-sl" => 0,	1978	"-pty-fd" => -1, "-sl" => 0,
1868	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1979	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1869	"--transient-for" => $self->{term}->parent,	1980	"--transient-for" => $self->{term}->parent,
1870	"-display" => $self->{term}->display_id,	1981	"-display" => $self->{term}->display_id,
1871	"-pe" => "urxvt-popup")	1982	"-pe" => "urxvt-popup",
1872	or die "unable to create popup window\n";	1983	) or die "unable to create popup window\n";
		1984
		1985	unless (delete $term->{urxvt_popup_init_done}) {
		1986	$term->ungrab;
		1987	$term->destroy;
		1988	die "unable to initialise popup window\n";
		1989	}
1873	}	1990	}
1874		1991
1875	sub DESTROY {	1992	sub DESTROY {
1876	my ($self) = @_;	1993	my ($self) = @_;
1877		1994
…		…
1882	=back	1999	=back
1883		2000
1884	=cut	2001	=cut
1885		2002
1886	package urxvt::watcher;	2003	package urxvt::watcher;
1887
1888	@urxvt::timer::ISA = __PACKAGE__;
1889	@urxvt::iow::ISA = __PACKAGE__;
1890	@urxvt::pw::ISA = __PACKAGE__;
1891	@urxvt::iw::ISA = __PACKAGE__;
1892		2004
1893	=head2 The C<urxvt::timer> Class	2005	=head2 The C<urxvt::timer> Class
1894		2006
1895	This class implements timer watchers/events. Time is represented as a	2007	This class implements timer watchers/events. Time is represented as a
1896	fractional number of seconds since the epoch. Example:	2008	fractional number of seconds since the epoch. Example:
…		…
1900	->new	2012	->new
1901	->interval (1)	2013	->interval (1)
1902	->cb (sub {	2014	->cb (sub {
1903	$term->{overlay}->set (0, 0,	2015	$term->{overlay}->set (0, 0,
1904	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2016	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1905	});	2017	});
1906		2018
1907	=over 4	2019	=over 4
1908		2020
1909	=item $timer = new urxvt::timer	2021	=item $timer = new urxvt::timer
1910		2022
…		…
1913		2025
1914	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2026	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1915		2027
1916	Set the callback to be called when the timer triggers.	2028	Set the callback to be called when the timer triggers.
1917		2029
1918	=item $tstamp = $timer->at
1919
1920	Return the time this watcher will fire next.
1921
1922	=item $timer = $timer->set ($tstamp)	2030	=item $timer = $timer->set ($tstamp[, $interval])
1923		2031
1924	Set the time the event is generated to $tstamp.	2032	Set the time the event is generated to $tstamp (and optionally specifies a
		2033	new $interval).
1925		2034
1926	=item $timer = $timer->interval ($interval)	2035	=item $timer = $timer->interval ($interval)
1927		2036
1928	Normally (and when C<$interval> is C<0>), the timer will automatically	2037	By default (and when C<$interval> is C<0>), the timer will automatically
1929	stop after it has fired once. If C<$interval> is non-zero, then the timer	2038	stop after it has fired once. If C<$interval> is non-zero, then the timer
1930	is automatically rescheduled at the given intervals.	2039	is automatically rescheduled at the given intervals.
1931		2040
1932	=item $timer = $timer->start	2041	=item $timer = $timer->start
1933		2042
1934	Start the timer.	2043	Start the timer.
1935		2044
1936	=item $timer = $timer->start ($tstamp)	2045	=item $timer = $timer->start ($tstamp[, $interval])
1937		2046
1938	Set the event trigger time to C<$tstamp> and start the timer.	2047	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2048	also replaces the interval.
1939		2049
1940	=item $timer = $timer->after ($delay)	2050	=item $timer = $timer->after ($delay[, $interval])
1941		2051
1942	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2052	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1943		2053
1944	=item $timer = $timer->stop	2054	=item $timer = $timer->stop
1945		2055
…		…
1953		2063
1954	$term->{socket} = ...	2064	$term->{socket} = ...
1955	$term->{iow} = urxvt::iow	2065	$term->{iow} = urxvt::iow
1956	->new	2066	->new
1957	->fd (fileno $term->{socket})	2067	->fd (fileno $term->{socket})
1958	->events (urxvt::EVENT_READ)	2068	->events (urxvt::EV_READ)
1959	->start	2069	->start
1960	->cb (sub {	2070	->cb (sub {
1961	my ($iow, $revents) = @_;	2071	my ($iow, $revents) = @_;
1962	# $revents must be 1 here, no need to check	2072	# $revents must be 1 here, no need to check
1963	sysread $term->{socket}, my $buf, 8192	2073	sysread $term->{socket}, my $buf, 8192
…		…
1976	Set the callback to be called when io events are triggered. C<$reventmask>	2086	Set the callback to be called when io events are triggered. C<$reventmask>
1977	is a bitset as described in the C<events> method.	2087	is a bitset as described in the C<events> method.
1978		2088
1979	=item $iow = $iow->fd ($fd)	2089	=item $iow = $iow->fd ($fd)
1980		2090
1981	Set the filedescriptor (not handle) to watch.	2091	Set the file descriptor (not handle) to watch.
1982		2092
1983	=item $iow = $iow->events ($eventmask)	2093	=item $iow = $iow->events ($eventmask)
1984		2094
1985	Set the event mask to watch. The only allowed values are	2095	Set the event mask to watch. The only allowed values are
1986	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2096	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1987	together, or C<urxvt::EVENT_NONE>.	2097	together, or C<urxvt::EV_NONE>.
1988		2098
1989	=item $iow = $iow->start	2099	=item $iow = $iow->start
1990		2100
1991	Start watching for requested events on the given handle.	2101	Start watching for requested events on the given handle.
1992		2102
1993	=item $iow = $iow->stop	2103	=item $iow = $iow->stop
1994		2104
1995	Stop watching for events on the given filehandle.	2105	Stop watching for events on the given file handle.
1996		2106
1997	=back	2107	=back
1998		2108
1999	=head2 The C<urxvt::iw> Class	2109	=head2 The C<urxvt::iw> Class
2000		2110
…		…
2033	->new	2143	->new
2034	->start ($pid)	2144	->start ($pid)
2035	->cb (sub {	2145	->cb (sub {
2036	my ($pw, $exit_status) = @_;	2146	my ($pw, $exit_status) = @_;
2037	...	2147	...
2038	});	2148	});
2039		2149
2040	=over 4	2150	=over 4
2041		2151
2042	=item $pw = new urxvt::pw	2152	=item $pw = new urxvt::pw
2043		2153
…		…
2047		2157
2048	Set the callback to be called when the timer triggers.	2158	Set the callback to be called when the timer triggers.
2049		2159
2050	=item $pw = $timer->start ($pid)	2160	=item $pw = $timer->start ($pid)
2051		2161
2052	Tells the wqtcher to start watching for process C<$pid>.	2162	Tells the watcher to start watching for process C<$pid>.
2053		2163
2054	=item $pw = $pw->stop	2164	=item $pw = $pw->stop
2055		2165
2056	Stop the watcher.	2166	Stop the watcher.
2057		2167
…		…
2070		2180
2071	=item >= 3 - script loading and management	2181	=item >= 3 - script loading and management
2072		2182
2073	=item >=10 - all called hooks	2183	=item >=10 - all called hooks
2074		2184
2075	=item >=11 - hook reutrn values	2185	=item >=11 - hook return values
2076		2186
2077	=back	2187	=back
2078		2188
2079	=head1 AUTHOR	2189	=head1 AUTHOR
2080		2190
2081	Marc Lehmann <pcg@goof.com>	2191	Marc Lehmann <schmorp@schmorp.de>
2082	http://software.schmorp.de/pkg/rxvt-unicode	2192	http://software.schmorp.de/pkg/rxvt-unicode
2083		2193
2084	=cut	2194	=cut
2085		2195
2086	1	2196	1
		2197
		2198	# vim: sw=3:

Diff Legend

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