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.139 by root, Sat Jul 1 19:04:43 2006 UTC vs.
Revision 1.265 by root, Sat Jul 24 09:48:43 2021 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 some directory:
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 instance using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib path/to/somedirectory -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 may add additional resources and C<actions>, i.e., methods
45		49	which can be bound to a key and invoked by the user. An extension can
46	=item selection (enabled by default)	50	define the resources it support using so called META comments,
47		51	described below. Similarly to builtin resources, extension resources
48	(More) intelligent selection. This extension tries to be more intelligent	52	can also be specified on the command line as long options (with C<.>
49	when the user extends selections (double-click and further clicks). Right	53	replaced by C<->), in which case the corresponding extension is loaded
50	now, it tries to select words, urls and complete shell-quoted	54	automatically. For this to work the extension B<must> define META
51	arguments, which is very convenient, too, if your F<ls> supports	55	comments for its resources.
52	C<--quoting-style=shell>.
53
54	A double-click usually selects the word under the cursor, further clicks
55	will enlarge the selection.
56
57	The selection works by trying to match a number of regexes and displaying
58	them in increasing order of length. You can add your own regexes by
59	specifying resources of the form:
60
61	URxvt.selection.pattern-0: perl-regex
62	URxvt.selection.pattern-1: perl-regex
63	...
64
65	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the 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		56
333	=head1 API DOCUMENTATION	57	=head1 API DOCUMENTATION
334		58
335	=head2 General API Considerations	59	=head2 General API Considerations
336		60
…		…
346	terminal is destroyed.	70	terminal is destroyed.
347		71
348	Argument names also often indicate the type of a parameter. Here are some	72	Argument names also often indicate the type of a parameter. Here are some
349	hints on what they mean:	73	hints on what they mean:
350		74
351	=over 4	75	=over
352		76
353	=item $text	77	=item $text
354		78
355	Rxvt-unicodes special way of encoding text, where one "unicode" character	79	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.	80	always represents one screen cell. See L<ROW_t> for a discussion of this format.
357		81
358	=item $string	82	=item $string
359		83
360	A perl text string, with an emphasis on I<text>. It can store all unicode	84	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
364	=item $octets	88	=item $octets
365		89
366	Either binary data or - more common - a text string encoded in a	90	Either binary data or - more common - a text string encoded in a
367	locale-specific way.	91	locale-specific way.
368		92
		93	=item $keysym
		94
		95	an integer that is a valid X11 keysym code. You can convert a string
		96	into a keysym and viceversa by using C<XStringToKeysym> and
		97	C<XKeysymToString>.
		98
369	=back	99	=back
370		100
371	=head2 Extension Objects	101	=head2 Extension Objects
372		102
373	Every perl extension is a perl class. A separate perl object is created	103	Every perl extension is a perl class. A separate perl object is created
374	for each terminal and each extension and passed as the first parameter to	104	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	105	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	106	their C<$self> object without having to think about clashes with other
		107	extensions or other terminals, with the exception of methods and members
377	begin with an underscore character C<_>: these are reserved for internal	108	that begin with an underscore character C<_>: these are reserved for
378	use.	109	internal use.
379		110
380	Although it isn't a C<urxvt::term> object, you can call all methods of the	111	Although it isn't a C<urxvt::term> object, you can call all methods of the
381	C<urxvt::term> class on this object.	112	C<urxvt::term> class on this object.
382		113
383	It has the following methods and data members:	114	Additional methods only supported for extension objects are described in
		115	the C<urxvt::extension> section below.
384		116
		117	=head2 META comments
		118
		119	Rxvt-unicode recognizes special meta comments in extensions that define
		120	different types of metadata. These comments are scanned whenever a
		121	terminal is created and are typically used to autoload extensions when
		122	their resources or command line parameters are used.
		123
		124	Currently, it recognises only one such comment:
		125
385	=over 4	126	=over
386		127
387	=item $urxvt_term = $self->{term}	128	=item #:META:RESOURCE:name:type:desc
388		129
389	Returns the C<urxvt::term> object associated with this instance of the	130	The RESOURCE comment defines a resource used by the extension, where
390	extension. This member I<must not> be changed in any way.	131	C<name> is the resource name, C<type> is the resource type, C<boolean>
		132	or C<string>, and C<desc> is the resource description.
391		133
392	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	134	The extension will be autoloaded when this resource is specified or used
393		135	as a command line parameter.
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		136
402	=back	137	=back
403		138
404	=head2 Hooks	139	=head2 Hooks
405		140
406	The following subroutines can be declared in extension files, and will be	141	The following subroutines can be declared in extension files, and will be
407	called whenever the relevant event happens.	142	called whenever the relevant event happens.
408		143
409	The first argument passed to them is an extension oject as described in	144	The first argument passed to them is an extension object as described in
410	the in the C<Extension Objects> section.	145	the in the C<Extension Objects> section.
411		146
412	B<All> of these hooks must return a boolean value. If any of the called	147	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	148	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.	149	relevant action might not be carried out by the C++ code.
415		150
416	I<< When in doubt, return a false value (preferably C<()>). >>	151	I<< When in doubt, return a false value (preferably C<()>). >>
417		152
418	=over 4	153	=over
419		154
420	=item on_init $term	155	=item on_init $term
421		156
422	Called after a new terminal object has been initialized, but before	157	Called after a new terminal object has been initialized, but before
423	windows are created or the command gets run. Most methods are unsafe to	158	windows are created or the command gets run. Most methods are unsafe to
…		…
427	place.	162	place.
428		163
429	=item on_start $term	164	=item on_start $term
430		165
431	Called at the very end of initialisation of a new terminal, just before	166	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.	167	trying to map (display) the toplevel and returning to the main loop.
433		168
434	=item on_destroy $term	169	=item on_destroy $term
435		170
436	Called whenever something tries to destroy terminal, when the terminal is	171	Called whenever something tries to destroy terminal, when the terminal is
437	still fully functional (not for long, though).	172	still fully functional (not for long, though).
…		…
464		199
465	Called whenever a selection has been copied, but before the selection is	200	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	201	requested from the server. The selection text can be queried and changed
467	by calling C<< $term->selection >>.	202	by calling C<< $term->selection >>.
468		203
469	Returning a true value aborts selection grabbing. It will still be hilighted.	204	Returning a true value aborts selection grabbing. It will still be highlighted.
470		205
471	=item on_sel_extend $term	206	=item on_sel_extend $term
472		207
473	Called whenever the user tries to extend the selection (e.g. with a double	208	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	209	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	210	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	211	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	212	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.	213	supposed to enlarge the selection more and more, if possible.
479		214
480	See the F<selection> example extension.	215	See the F<selection> example extension.
481		216
482	=item on_view_change $term, $offset	217	=item on_view_change $term, $offset
483		218
484	Called whenever the view offset changes, i..e the user or program	219	Called whenever the view offset changes, i.e. the user or program
485	scrolls. Offset C<0> means display the normal terminal, positive values	220	scrolls. Offset C<0> means display the normal terminal, positive values
486	show this many lines of scrollback.	221	show this many lines of scrollback.
487		222
488	=item on_scroll_back $term, $lines, $saved	223	=item on_scroll_back $term, $lines, $saved
489		224
…		…
493		228
494	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	229	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	230	$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.	231	number of lines that will be in the scrollback buffer.
497		232
498	=item on_osc_seq $term, $op, $args	233	=item on_osc_seq $term, $op, $args, $resp
499		234
500	Called on every OSC sequence and can be used to suppress it or modify its	235	Called on every OSC sequence and can be used to suppress it or modify its
501	behaviour. The default should be to return an empty list. A true value	236	behaviour. The default should be to return an empty list. A true value
502	suppresses execution of the request completely. Make sure you don't get	237	suppresses execution of the request completely. Make sure you don't get
503	confused by recursive invocations when you output an osc sequence within	238	confused by recursive invocations when you output an OSC sequence within
504	this callback.	239	this callback.
505		240
506	C<on_osc_seq_perl> should be used for new behaviour.	241	C<on_osc_seq_perl> should be used for new behaviour.
507		242
508	=item on_osc_seq_perl $term, $string	243	=item on_osc_seq_perl $term, $args, $resp
509		244
510	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	245	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
511	operating system command) is processed. Cursor position and other state	246	operating system command) is processed. Cursor position and other state
512	information is up-to-date when this happens. For interoperability, the	247	information is up-to-date when this happens. For interoperability, the
513	string should start with the extension name and a colon, to distinguish	248	string should start with the extension name (sans -osc) and a semicolon,
514	it from commands for other extensions, and this might be enforced in the	249	to distinguish it from commands for other extensions, and this might be
515	future.	250	enforced in the future.
		251
		252	For example, C<overlay-osc> uses this:
		253
		254	sub on_osc_seq_perl {
		255	my ($self, $osc, $resp) = @_;
		256
		257	return unless $osc =~ s/^overlay;//;
		258
		259	... process remaining $osc string
		260	}
516		261
517	Be careful not ever to trust (in a security sense) the data you receive,	262	Be careful not ever to trust (in a security sense) the data you receive,
518	as its source can not easily be controleld (e-mail content, messages from	263	as its source can not easily be controlled (e-mail content, messages from
519	other users on the same system etc.).	264	other users on the same system etc.).
		265
		266	For responses, C<$resp> contains the end-of-args separator used by the
		267	sender.
520		268
521	=item on_add_lines $term, $string	269	=item on_add_lines $term, $string
522		270
523	Called whenever text is about to be output, with the text as argument. You	271	Called whenever text is about to be output, with the text as argument. You
524	can filter/change and output the text yourself by returning a true value	272	can filter/change and output the text yourself by returning a true value
…		…
529	=item on_tt_write $term, $octets	277	=item on_tt_write $term, $octets
530		278
531	Called whenever some data is written to the tty/pty and can be used to	279	Called whenever some data is written to the tty/pty and can be used to
532	suppress or filter tty input.	280	suppress or filter tty input.
533		281
		282	=item on_tt_paste $term, $octets
		283
		284	Called whenever text is about to be pasted, with the text as argument. You
		285	can filter/change and paste the text yourself by returning a true value
		286	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		287	locale-encoded.
		288
534	=item on_line_update $term, $row	289	=item on_line_update $term, $row
535		290
536	Called whenever a line was updated or changed. Can be used to filter	291	Called whenever a line was updated or changed. Can be used to filter
537	screen output (e.g. underline urls or other useless stuff). Only lines	292	screen output (e.g. underline urls or other useless stuff). Only lines
538	that are being shown will be filtered, and, due to performance reasons,	293	that are being shown will be filtered, and, due to performance reasons,
…		…
545	later with the already-modified line (e.g. if unrelated parts change), so	300	later with the already-modified line (e.g. if unrelated parts change), so
546	you cannot just toggle rendition bits, but only set them.	301	you cannot just toggle rendition bits, but only set them.
547		302
548	=item on_refresh_begin $term	303	=item on_refresh_begin $term
549		304
550	Called just before the screen gets redrawn. Can be used for overlay	305	Called just before the screen gets redrawn. Can be used for overlay or
551	or similar effects by modify terminal contents in refresh_begin, and	306	similar effects by modifying the terminal contents in refresh_begin, and
552	restoring them in refresh_end. The built-in overlay and selection display	307	restoring them in refresh_end. The built-in overlay and selection display
553	code is run after this hook, and takes precedence.	308	code is run after this hook, and takes precedence.
554		309
555	=item on_refresh_end $term	310	=item on_refresh_end $term
556		311
557	Called just after the screen gets redrawn. See C<on_refresh_begin>.	312	Called just after the screen gets redrawn. See C<on_refresh_begin>.
558		313
		314	=item on_action $term, $string
		315
		316	Called whenever an action is invoked for the corresponding extension
		317	(e.g. via a C<extension:string> builtin action bound to a key, see
		318	description of the B<keysym> resource in the urxvt(1) manpage). The
		319	event is simply the action string. Note that an action event is always
		320	associated to a single extension.
		321
559	=item on_user_command $term, $string	322	=item on_user_command $term, $string *DEPRECATED*
560		323
561	Called whenever the a user-configured event is being activated (e.g. via	324	Called whenever a user-configured event is being activated (e.g. via
562	a C<perl:string> action bound to a key, see description of the B<keysym>	325	a C<perl:string> action bound to a key, see description of the B<keysym>
563	resource in the @@RXVT_NAME@@(1) manpage).	326	resource in the urxvt(1) manpage).
564		327
565	The event is simply the action string. This interface is assumed to change	328	The event is simply the action string. This interface is going away in
566	slightly in the future.	329	preference to the C<on_action> hook.
567		330
568	=item on_resize_all_windows $tern, $new_width, $new_height	331	=item on_resize_all_windows $term, $new_width, $new_height
569		332
570	Called just after the new window size has been calculcated, but before	333	Called just after the new window size has been calculated, but before
571	windows are actually being resized or hints are being set. If this hook	334	windows are actually being resized or hints are being set. If this hook
572	returns TRUE, setting of the window hints is being skipped.	335	returns a true value, setting of the window hints is being skipped.
573		336
574	=item on_x_event $term, $event	337	=item on_x_event $term, $event
575		338
576	Called on every X event received on the vt window (and possibly other	339	Called on every X event received on the vt window (and possibly other
577	windows). Should only be used as a last resort. Most event structure	340	windows). Should only be used as a last resort. Most event structure
578	members are not passed.	341	members are not passed.
579		342
		343	=item on_root_event $term, $event
		344
		345	Like C<on_x_event>, but is called for events on the root window.
		346
580	=item on_focus_in $term	347	=item on_focus_in $term
581		348
582	Called whenever the window gets the keyboard focus, before rxvt-unicode	349	Called whenever the window gets the keyboard focus, before rxvt-unicode
583	does focus in processing.	350	does focus in processing.
584		351
585	=item on_focus_out $term	352	=item on_focus_out $term
586		353
587	Called wheneever the window loses keyboard focus, before rxvt-unicode does	354	Called whenever the window loses keyboard focus, before rxvt-unicode does
588	focus out processing.	355	focus out processing.
589		356
590	=item on_configure_notify $term, $event	357	=item on_configure_notify $term, $event
591		358
592	=item on_property_notify $term, $event	359	=item on_property_notify $term, $event
…		…
603		370
604	=item on_map_notify $term, $event	371	=item on_map_notify $term, $event
605		372
606	=item on_unmap_notify $term, $event	373	=item on_unmap_notify $term, $event
607		374
608	Called whenever the corresponding X event is received for the terminal If	375	Called whenever the corresponding X event is received for the terminal. If
609	the hook returns true, then the even will be ignored by rxvt-unicode.	376	the hook returns true, then the event will be ignored by rxvt-unicode.
610		377
611	The event is a hash with most values as named by Xlib (see the XEvent	378	The event is a hash with most values as named by Xlib (see the XEvent
612	manpage), with the additional members C<row> and C<col>, which are the	379	manpage), with the additional members C<row> and C<col>, which are the
613	(real, not screen-based) row and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
614		381
615	C<on_key_press> additionally receives the string rxvt-unicode would	382	C<on_key_press> additionally receives the string rxvt-unicode would
616	output, if any, in locale-specific encoding.	383	output, if any, in locale-specific encoding.
617		384
618	subwindow.
619
620	=item on_client_message $term, $event	385	=item on_client_message $term, $event
621		386
622	=item on_wm_protocols $term, $event	387	=item on_wm_protocols $term, $event
623		388
624	=item on_wm_delete_window $term, $event	389	=item on_wm_delete_window $term, $event
625		390
626	Called when various types of ClientMessage events are received (all with	391	Called when various types of ClientMessage events are received (all with
627	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	392	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
628		393
		394	=item on_bell $term
		395
		396	Called on receipt of a bell character.
		397
629	=back	398	=back
630		399
631	=cut	400	=cut
632		401
633	package urxvt;	402	package urxvt;
634		403
635	use utf8;	404	use utf8;
636	use strict;	405	use strict 'vars';
637	use Carp ();	406	use Carp ();
638	use Scalar::Util ();	407	use Scalar::Util ();
639	use List::Util ();	408	use List::Util ();
640		409
641	our $VERSION = 1;	410	our $VERSION = 1;
642	our $TERM;	411	our $TERM;
643	our @TERM_INIT;	412	our @TERM_INIT; # should go, prevents async I/O etc.
644	our @TERM_EXT;	413	our @TERM_EXT; # should go, prevents async I/O etc.
645	our @HOOKNAME;	414	our @HOOKNAME;
646	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	415	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
647	our %OPTION;	416	our %OPTION;
648		417
649	our $LIBDIR;	418	our $LIBDIR;
…		…
653		422
654	our $NOCHAR = chr 0xffff;	423	our $NOCHAR = chr 0xffff;
655		424
656	=head2 Variables in the C<urxvt> Package	425	=head2 Variables in the C<urxvt> Package
657		426
658	=over 4	427	=over
659		428
660	=item $urxvt::LIBDIR	429	=item $urxvt::LIBDIR
661		430
662	The rxvt-unicode library directory, where, among other things, the perl	431	The rxvt-unicode library directory, where, among other things, the perl
663	modules and scripts are stored.	432	modules and scripts are stored.
…		…
675	The current terminal. This variable stores the current C<urxvt::term>	444	The current terminal. This variable stores the current C<urxvt::term>
676	object, whenever a callback/hook is executing.	445	object, whenever a callback/hook is executing.
677		446
678	=item @urxvt::TERM_INIT	447	=item @urxvt::TERM_INIT
679		448
680	All coderefs in this array will be called as methods of the next newly	449	All code references in this array will be called as methods of the next newly
681	created C<urxvt::term> object (during the C<on_init> phase). The array	450	created C<urxvt::term> object (during the C<on_init> phase). The array
682	gets cleared before the codereferences that were in it are being executed,	451	gets cleared before the code references that were in it are being executed,
683	so coderefs can push themselves onto it again if they so desire.	452	so references can push themselves onto it again if they so desire.
684		453
685	This complements to the perl-eval commandline option, but gets executed	454	This complements to the perl-eval command line option, but gets executed
686	first.	455	first.
687		456
688	=item @urxvt::TERM_EXT	457	=item @urxvt::TERM_EXT
689		458
690	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	459	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
693		462
694	=back	463	=back
695		464
696	=head2 Functions in the C<urxvt> Package	465	=head2 Functions in the C<urxvt> Package
697		466
698	=over 4	467	=over
699		468
700	=item urxvt::fatal $errormessage	469	=item urxvt::fatal $errormessage
701		470
702	Fatally aborts execution with the given error message. Avoid at all	471	Fatally aborts execution with the given error message (which should
703	costs! The only time this is acceptable is when the terminal process	472	include a trailing newline). Avoid at all costs! The only time this
704	starts up.	473	is acceptable (and useful) is in the init hook, where it prevents the
		474	terminal from starting up.
705		475
706	=item urxvt::warn $string	476	=item urxvt::warn $string
707		477
708	Calls C<rxvt_warn> with the given string which should not include a	478	Calls C<rxvt_warn> with the given string which should include a trailing
709	newline. The module also overwrites the C<warn> builtin with a function	479	newline. The module also overwrites the C<warn> builtin with a function
710	that calls this function.	480	that calls this function.
711		481
712	Using this function has the advantage that its output ends up in the	482	Using this function has the advantage that its output ends up in the
713	correct place, e.g. on stderr of the connecting urxvtc client.	483	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
715	Messages have a size limit of 1023 bytes currently.	485	Messages have a size limit of 1023 bytes currently.
716		486
717	=item @terms = urxvt::termlist	487	=item @terms = urxvt::termlist
718		488
719	Returns all urxvt::term objects that exist in this process, regardless of	489	Returns all urxvt::term objects that exist in this process, regardless of
720	wether they are started, being destroyed etc., so be careful. Only term	490	whether they are started, being destroyed etc., so be careful. Only term
721	objects that have perl extensions attached will be returned (because there	491	objects that have perl extensions attached will be returned (because there
722	is no urxvt::term objet associated with others).	492	is no urxvt::term object associated with others).
723		493
724	=item $time = urxvt::NOW	494	=item $time = urxvt::NOW
725		495
726	Returns the "current time" (as per the event loop).	496	Returns the "current time" (as per the event loop).
727		497
…		…
747	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,	517	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
748	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify	518	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
749		519
750	Various constants for use in X calls and event processing.	520	Various constants for use in X calls and event processing.
751		521
		522	=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
		523	PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
		524	PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
		525	PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
		526	PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
		527	PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
		528	PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
		529	PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
		530	PrivMode_Default
		531
		532	Constants for checking DEC private modes.
		533
752	=back	534	=back
753		535
754	=head2 RENDITION	536	=head2 RENDITION
755		537
756	Rendition bitsets contain information about colour, font, font styles and	538	Rendition bitsets contain information about colour, font, font styles and
…		…
759	The following "macros" deal with changes in rendition sets. You should	541	The following "macros" deal with changes in rendition sets. You should
760	never just create a bitset, you should always modify an existing one,	542	never just create a bitset, you should always modify an existing one,
761	as they contain important information required for correct operation of	543	as they contain important information required for correct operation of
762	rxvt-unicode.	544	rxvt-unicode.
763		545
764	=over 4	546	=over
765		547
766	=item $rend = urxvt::DEFAULT_RSTYLE	548	=item $rend = urxvt::DEFAULT_RSTYLE
767		549
768	Returns the default rendition, as used when the terminal is starting up or	550	Returns the default rendition, as used when the terminal is starting up or
769	being reset. Useful as a base to start when creating renditions.	551	being reset. Useful as a base to start when creating renditions.
770		552
771	=item $rend = urxvt::OVERLAY_RSTYLE	553	=item $rend = urxvt::OVERLAY_RSTYLE
772		554
773	Return the rendition mask used for overlays by default.	555	Return the rendition mask used for overlays by default.
774		556
775	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	557	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		558	urxvt::RS_RVid, urxvt::RS_Uline
776		559
777	Return the bit that enabled bold, italic, blink, reverse-video and	560	Return the bit that enabled bold, italic, blink, reverse-video and
778	underline, respectively. To enable such a style, just logically OR it into	561	underline, respectively. To enable such a style, just logically OR it into
779	the bitset.	562	the bitset.
780		563
…		…
817	};	600	};
818	}	601	}
819		602
820	no warnings 'utf8';	603	no warnings 'utf8';
821		604
		605	sub parse_resource {
		606	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		607
		608	$term->scan_extensions;
		609
		610	# iterating over all resources has quadratic time overhead
		611	# overall, maybe this could be optimised?
		612	my $r = $term->{meta}{resource};
		613	keys %$r; # reset iterator
		614	while (my ($k, $v) = each %$r) {
		615	my $pattern = $k;
		616	$pattern =~ y/./-/ if $isarg;
		617	my $prefix = $name;
		618	my $suffix;
		619	if ($pattern =~ /\-$/) {
		620	$prefix = substr $name, 0, length $pattern;
		621	$suffix = substr $name, length $pattern;
		622	}
		623	if ($pattern eq $prefix) {
		624	$name = "$urxvt::RESCLASS.$k$suffix";
		625
		626	push @{ $term->{perl_ext_3} }, $v->[0];
		627
		628	return 1 unless $isarg;
		629
		630	if ($v->[1] eq "boolean") {
		631	$term->put_option_db ($name, $flag ? "true" : "false");
		632	return 1;
		633	} else {
		634	$term->put_option_db ($name, $value);
		635	return 1 + 2;
		636	}
		637	}
		638	}
		639
		640	0
		641	}
		642
		643	sub usage {
		644	my ($term, $usage_type) = @_;
		645
		646	$term->scan_extensions;
		647
		648	my $r = $term->{meta}{resource};
		649
		650	for my $pattern (sort keys %$r) {
		651	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		652
		653	$desc .= " (-pe $ext)";
		654
		655	if ($usage_type == 1) {
		656	$pattern =~ y/./-/;
		657	$pattern =~ s/-$/-.../g;
		658
		659	if ($type eq "boolean") {
		660	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		661	} else {
		662	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		663	}
		664	} else {
		665	$pattern =~ s/\.$/.*/g;
		666	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		667	}
		668	}
		669	}
		670
822	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	671	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
823		672
824	sub verbose {	673	sub verbose {
825	my ($level, $msg) = @_;	674	my ($level, $msg) = @_;
826	warn "$msg\n" if $level <= $verbosity;	675	warn "$msg\n" if $level <= $verbosity;
…		…
838	$pkg =~ s/[^[:word:]]/_/g;	687	$pkg =~ s/[^[:word:]]/_/g;
839	$pkg = "urxvt::ext::$pkg";	688	$pkg = "urxvt::ext::$pkg";
840		689
841	verbose 3, "loading extension '$path' into package '$pkg'";	690	verbose 3, "loading extension '$path' into package '$pkg'";
842		691
		692	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		693
843	open my $fh, "<:raw", $path	694	open my $fh, "<:raw", $path
844	or die "$path: $!";	695	or die "$path: $!";
845		696
846	my $source =	697	my $source =
847	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	698	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
848	. "#line 1 \"$path\"\n{\n"	699	. "#line 1 \"$path\"\n{\n"
849	. (do { local $/; <$fh> })	700	. (do { local $/; <$fh> })
850	. "\n};\n1";	701	. "\n};\n1";
851		702
852	eval $source	703	eval $source
…		…
861	# called by the rxvt core	712	# called by the rxvt core
862	sub invoke {	713	sub invoke {
863	local $TERM = shift;	714	local $TERM = shift;
864	my $htype = shift;	715	my $htype = shift;
865		716
866	if ($htype == 0) { # INIT	717	if ($htype == HOOK_INIT) {
867	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	718	my @dirs = $TERM->perl_libdirs;
868		719
		720	$TERM->scan_extensions;
		721
869	my %ext_arg;	722	my %ext_arg;
870		723
871	{	724	{
872	my @init = @TERM_INIT;	725	my @init = @TERM_INIT;
873	@TERM_INIT = ();	726	@TERM_INIT = ();
…		…
875	my @pkg = @TERM_EXT;	728	my @pkg = @TERM_EXT;
876	@TERM_EXT = ();	729	@TERM_EXT = ();
877	$TERM->register_package ($_) for @pkg;	730	$TERM->register_package ($_) for @pkg;
878	}	731	}
879		732
		733	for (
		734	@{ delete $TERM->{perl_ext_3} },
880	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	735	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
		736	) {
881	if ($_ eq "default") {	737	if ($_ eq "default") {
		738
		739	$ext_arg{$_} = []
882	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	740	for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
		741
		742	for ($TERM->_keysym_resources) {
		743	next if /^(?:string|command|builtin|builtin-string|perl)/;
		744	next unless /^([A-Za-z0-9_\-]+):/;
		745
		746	my $ext = $1;
		747
		748	$ext_arg{$ext} = [];
		749	}
		750
883	} elsif (/^-(.*)$/) {	751	} elsif (/^-(.*)$/) {
884	delete $ext_arg{$1};	752	delete $ext_arg{$1};
		753
885	} elsif (/^([^<]+)<(.*)>$/) {	754	} elsif (/^([^<]+)<(.*)>$/) {
886	push @{ $ext_arg{$1} }, $2;	755	push @{ $ext_arg{$1} }, $2;
		756
887	} else {	757	} else {
888	$ext_arg{$_} ||= [];	758	$ext_arg{$_} ||= [];
889	}	759	}
890	}	760	}
891		761
…		…
907		777
908	if (my $cb = $TERM->{_hook}[$htype]) {	778	if (my $cb = $TERM->{_hook}[$htype]) {
909	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	779	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
910	if $verbosity >= 10;	780	if $verbosity >= 10;
911		781
		782	if ($htype == HOOK_ACTION) {
		783	# this hook is only sent to the extension with the name
		784	# matching the first arg
		785	my $pkg = shift;
		786	$pkg =~ y/-/_/;
		787	$pkg = "urxvt::ext::$pkg";
		788
		789	$cb = $cb->{$pkg}
		790	or return undef; #TODO: maybe warn user?
		791
		792	$cb = { $pkg => $cb };
		793	}
		794
912	for my $pkg (keys %$cb) {	795	for my $pkg (keys %$cb) {
913	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	796	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
914	$retval ||= $retval_;	797	$retval ||= $retval_;
915		798
916	if ($@) {	799	if ($@) {
917	$TERM->ungrab; # better to lose the grab than the session	800	$TERM->ungrab; # better to lose the grab than the session
918	warn $@;	801	warn $@;
…		…
921		804
922	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	805	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
923	if $verbosity >= 11;	806	if $verbosity >= 11;
924	}	807	}
925		808
926	if ($htype == 1) { # DESTROY	809	if ($htype == HOOK_DESTROY) {
927	# clear package objects	810	# clear package objects
928	%$_ = () for values %{ $TERM->{_pkg} };	811	%$_ = () for values %{ $TERM->{_pkg} };
929		812
930	# clear package	813	# clear package
931	%$TERM = ();	814	%$TERM = ();
…		…
936		819
937	sub SET_COLOR($$$) {	820	sub SET_COLOR($$$) {
938	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	821	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
939	}	822	}
940		823
941	# urxvt::term::extension	824	sub rend2mask {
		825	no strict 'refs';
		826	my ($str, $mask) = (@_, 0);
		827	my %color = ( fg => undef, bg => undef );
		828	my @failed;
		829	for my $spec ( split /\s+/, $str ) {
		830	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		831	$color{lc($1)} = $2;
		832	} else {
		833	my $neg = $spec =~ s/^[-^]//;
		834	unless ( exists &{"RS_$spec"} ) {
		835	push @failed, $spec;
		836	next;
		837	}
		838	my $cur = &{"RS_$spec"};
		839	if ( $neg ) {
		840	$mask &= ~$cur;
		841	} else {
		842	$mask |= $cur;
		843	}
		844	}
		845	}
		846	($mask, @color{qw(fg bg)}, \@failed)
		847	}
942		848
943	package urxvt::term::extension;	849	package urxvt::term::extension;
944		850
945	sub enable {	851	=head2 The C<urxvt::term::extension> class
946	my ($self, %hook) = @_;
947	my $pkg = $self->{_pkg};
948		852
949	while (my ($name, $cb) = each %hook) {	853	Each extension attached to a terminal object is represented by
950	my $htype = $HOOKTYPE{uc $name};	854	a C<urxvt::term::extension> object.
951	defined $htype
952	or Carp::croak "unsupported hook type '$name'";
953		855
954	$self->set_should_invoke ($htype, +1)	856	You can use these objects, which are passed to all callbacks to store any
955	unless exists $self->{term}{_hook}[$htype]{$pkg};	857	state related to the terminal and extension instance.
956		858
957	$self->{term}{_hook}[$htype]{$pkg} = $cb;	859	The methods (And data members) documented below can be called on extension
958	}	860	objects, in addition to call methods documented for the <urxvt::term>
959	}	861	class.
960		862
961	sub disable {	863	=over
962	my ($self, @hook) = @_;
963	my $pkg = $self->{_pkg};
964		864
965	for my $name (@hook) {	865	=item $urxvt_term = $self->{term}
966	my $htype = $HOOKTYPE{uc $name};
967	defined $htype
968	or Carp::croak "unsupported hook type '$name'";
969		866
970	$self->set_should_invoke ($htype, -1)	867	Returns the C<urxvt::term> object associated with this instance of the
971	if delete $self->{term}{_hook}[$htype]{$pkg};	868	extension. This member I<must not> be changed in any way.
972	}	869
973	}	870	=cut
974		871
975	our $AUTOLOAD;	872	our $AUTOLOAD;
976		873
977	sub AUTOLOAD {	874	sub AUTOLOAD {
978	$AUTOLOAD =~ /:([^:]+)$/	875	$AUTOLOAD =~ /:([^:]+)$/
…		…
991		888
992	sub DESTROY {	889	sub DESTROY {
993	# nop	890	# nop
994	}	891	}
995		892
996	# urxvt::destroy_hook	893	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
997		894
998	sub urxvt::destroy_hook::DESTROY {	895	sub urxvt::destroy_hook::DESTROY {
999	${$_[0]}->();	896	${$_[0]}->();
1000	}	897	}
1001		898
1002	sub urxvt::destroy_hook(&) {	899	sub urxvt::destroy_hook(&) {
1003	bless \shift, urxvt::destroy_hook::	900	bless \shift, urxvt::destroy_hook::
1004	}	901	}
		902
		903	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		904
		905	Dynamically enable the given hooks (named without the C<on_> prefix) for
		906	this extension, replacing any hook previously installed via C<enable> in
		907	this extension.
		908
		909	This is useful when you want to overwrite time-critical hooks only
		910	temporarily.
		911
		912	To install additional callbacks for the same hook, you can use the C<on>
		913	method of the C<urxvt::term> class.
		914
		915	=item $self->disable ($hook_name[, $hook_name..])
		916
		917	Dynamically disable the given hooks.
		918
		919	=cut
		920
		921	sub enable {
		922	my ($self, %hook) = @_;
		923	my $pkg = $self->{_pkg};
		924
		925	while (my ($name, $cb) = each %hook) {
		926	my $htype = $HOOKTYPE{uc $name};
		927	defined $htype
		928	or Carp::croak "unsupported hook type '$name'";
		929
		930	$self->set_should_invoke ($htype, +1)
		931	unless exists $self->{term}{_hook}[$htype]{$pkg};
		932
		933	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		934	}
		935	}
		936
		937	sub disable {
		938	my ($self, @hook) = @_;
		939	my $pkg = $self->{_pkg};
		940
		941	for my $name (@hook) {
		942	my $htype = $HOOKTYPE{uc $name};
		943	defined $htype
		944	or Carp::croak "unsupported hook type '$name'";
		945
		946	$self->set_should_invoke ($htype, -1)
		947	if delete $self->{term}{_hook}[$htype]{$pkg};
		948	}
		949	}
		950
		951	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		952
		953	Similar to the C<enable> enable, but installs additional callbacks for
		954	the given hook(s) (that is, it doesn't replace existing callbacks), and
		955	returns a guard object. When the guard object is destroyed the callbacks
		956	are disabled again.
		957
		958	=cut
		959
		960	sub urxvt::extension::on_disable::DESTROY {
		961	my $disable = shift;
		962
		963	my $term = delete $disable->{""};
		964
		965	while (my ($htype, $id) = each %$disable) {
		966	delete $term->{_hook}[$htype]{$id};
		967	$term->set_should_invoke ($htype, -1);
		968	}
		969	}
		970
		971	sub on {
		972	my ($self, %hook) = @_;
		973
		974	my $term = $self->{term};
		975
		976	my %disable = ( "" => $term );
		977
		978	while (my ($name, $cb) = each %hook) {
		979	my $htype = $HOOKTYPE{uc $name};
		980	defined $htype
		981	or Carp::croak "unsupported hook type '$name'";
		982
		983	$term->set_should_invoke ($htype, +1);
		984	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		985	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		986	}
		987
		988	bless \%disable, "urxvt::extension::on_disable"
		989	}
		990
		991	=item $self->bind_action ($hotkey, $action)
		992
		993	=item $self->x_resource ($pattern)
		994
		995	=item $self->x_resource_boolean ($pattern)
		996
		997	These methods support an additional C<%> prefix for C<$action> or
		998	C<$pattern> when called on an extension object, compared to the
		999	C<urxvt::term> methods of the same name - see the description of these
		1000	methods in the C<urxvt::term> class for details.
		1001
		1002	=cut
		1003
		1004	sub bind_action {
		1005	my ($self, $hotkey, $action) = @_;
		1006	$action =~ s/^%:/$_[0]{_name}:/;
		1007	$self->{term}->bind_action ($hotkey, $action)
		1008	}
		1009
		1010	sub x_resource {
		1011	my ($self, $name) = @_;
		1012	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1013	$self->{term}->x_resource ($name)
		1014	}
		1015
		1016	sub x_resource_boolean {
		1017	my ($self, $name) = @_;
		1018	$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
		1019	$self->{term}->x_resource_boolean ($name)
		1020	}
		1021
		1022	=back
		1023
		1024	=cut
1005		1025
1006	package urxvt::anyevent;	1026	package urxvt::anyevent;
1007		1027
1008	=head2 The C<urxvt::anyevent> Class	1028	=head2 The C<urxvt::anyevent> Class
1009		1029
1010	The sole purpose of this class is to deliver an interface to the	1030	The sole purpose of this class is to deliver an interface to the
1011	C<AnyEvent> module - any module using it will work inside urxvt without	1031	C<AnyEvent> module - any module using it will work inside urxvt without
1012	further programming. The only exception is that you cannot wait on	1032	further programming. The only exception is that you cannot wait on
1013	condition variables, but non-blocking condvar use is ok. What this means	1033	condition variables, but non-blocking condvar use is ok.
1014	is that you cannot use blocking APIs, but the non-blocking variant should
1015	work.
1016		1034
1017	=cut	1035	In practical terms this means is that you cannot use blocking APIs, but
		1036	the non-blocking variant should work.
1018		1037
		1038	=cut
		1039
1019	our $VERSION = 1;	1040	our $VERSION = '5.23';
1020		1041
1021	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1042	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1022	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1043	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1023		1044
1024	sub timer {	1045	sub timer {
…		…
1026		1047
1027	my $cb = $arg{cb};	1048	my $cb = $arg{cb};
1028		1049
1029	urxvt::timer	1050	urxvt::timer
1030	->new	1051	->new
1031	->start (urxvt::NOW + $arg{after})	1052	->after ($arg{after}, $arg{interval})
1032	->cb (sub {	1053	->cb ($arg{interval} ? $cb : sub {
1033	$_[0]->stop; # need to cancel manually	1054	$_[0]->stop; # need to cancel manually
1034	$cb->();	1055	$cb->();
1035	})	1056	})
1036	}	1057	}
1037		1058
1038	sub io {	1059	sub io {
1039	my ($class, %arg) = @_;	1060	my ($class, %arg) = @_;
1040		1061
1041	my $cb = $arg{cb};	1062	my $cb = $arg{cb};
		1063	my $fd = fileno $arg{fh};
		1064	defined $fd or $fd = $arg{fh};
1042		1065
1043	bless [$arg{fh}, urxvt::iow	1066	bless [$arg{fh}, urxvt::iow
1044	->new	1067	->new
1045	->fd (fileno $arg{fh})	1068	->fd ($fd)
1046	->events (($arg{poll} =~ /r/ ? 1 : 0)	1069	->events (($arg{poll} =~ /r/ ? 1 : 0)
1047	| ($arg{poll} =~ /w/ ? 2 : 0))	1070	| ($arg{poll} =~ /w/ ? 2 : 0))
1048	->start	1071	->start
1049	->cb (sub {	1072	->cb ($cb)
1050	$cb->(($_[1] & 1 ? 'r' : '')
1051	. ($_[1] & 2 ? 'w' : ''));
1052	})],
1053	urxvt::anyevent::	1073	], urxvt::anyevent::
		1074	}
		1075
		1076	sub idle {
		1077	my ($class, %arg) = @_;
		1078
		1079	my $cb = $arg{cb};
		1080
		1081	urxvt::iw
		1082	->new
		1083	->start
		1084	->cb ($cb)
		1085	}
		1086
		1087	sub child {
		1088	my ($class, %arg) = @_;
		1089
		1090	my $cb = $arg{cb};
		1091
		1092	urxvt::pw
		1093	->new
		1094	->start ($arg{pid})
		1095	->cb (sub {
		1096	$_[0]->stop; # need to cancel manually
		1097	$cb->($_[0]->rpid, $_[0]->rstatus);
		1098	})
1054	}	1099	}
1055		1100
1056	sub DESTROY {	1101	sub DESTROY {
1057	$_[0][1]->stop;	1102	$_[0][1]->stop;
1058	}	1103	}
1059		1104
1060	sub condvar {	1105	# only needed for AnyEvent < 6 compatibility
1061	bless \my $flag, urxvt::anyevent::condvar::	1106	sub one_event {
1062	}
1063
1064	sub urxvt::anyevent::condvar::broadcast {
1065	${$_[0]}++;
1066	}
1067
1068	sub urxvt::anyevent::condvar::wait {
1069	unless (${$_[0]}) {
1070	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1107	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1071	}
1072	}	1108	}
1073		1109
1074	package urxvt::term;	1110	package urxvt::term;
1075		1111
1076	=head2 The C<urxvt::term> Class	1112	=head2 The C<urxvt::term> Class
1077		1113
1078	=over 4	1114	=over
1079		1115
1080	=cut	1116	=cut
1081		1117
1082	# find on_xxx subs in the package and register them	1118	# find on_xxx subs in the package and register them
1083	# as hooks	1119	# as hooks
…		…
1089	urxvt::verbose 6, "register package $pkg to $self";	1125	urxvt::verbose 6, "register package $pkg to $self";
1090		1126
1091	@{"$pkg\::ISA"} = urxvt::term::extension::;	1127	@{"$pkg\::ISA"} = urxvt::term::extension::;
1092		1128
1093	my $proxy = bless {	1129	my $proxy = bless {
1094	_pkg => $pkg,	1130	_pkg => $pkg,
		1131	_name => ${"$pkg\::_NAME"}, # hackish
1095	argv => $argv,	1132	argv => $argv,
1096	}, $pkg;	1133	}, $pkg;
1097	Scalar::Util::weaken ($proxy->{term} = $self);	1134	Scalar::Util::weaken ($proxy->{term} = $self);
1098		1135
1099	$self->{_pkg}{$pkg} = $proxy;	1136	$self->{_pkg}{$pkg} = $proxy;
1100		1137
…		…
1103	$proxy->enable ($name => $ref);	1140	$proxy->enable ($name => $ref);
1104	}	1141	}
1105	}	1142	}
1106	}	1143	}
1107		1144
		1145	sub perl_libdirs {
		1146	map { split /:/ }
		1147	$_[0]->resource ("perl_lib"),
		1148	$ENV{URXVT_PERL_LIB},
		1149	"$ENV{HOME}/.urxvt/ext",
		1150	"$LIBDIR/perl"
		1151	}
		1152
		1153	# scan for available extensions and collect their metadata
		1154	sub scan_extensions {
		1155	my ($self) = @_;
		1156
		1157	return if exists $self->{meta};
		1158
		1159	my @urxvtdirs = perl_libdirs $self;
		1160	# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
		1161
		1162	$self->{meta} = \my %meta;
		1163
		1164	# first gather extensions
		1165
		1166	my $gather = sub {
		1167	my ($dir, $core) = @_;
		1168
		1169	opendir my $fh, $dir
		1170	or return;
		1171
		1172	for my $ext (readdir $fh) {
		1173	$ext !~ /^\./
		1174	or next;
		1175
		1176	open my $fh, "<", "$dir/$ext"
		1177	or next;
		1178
		1179	-f $fh
		1180	or next;
		1181
		1182	$ext =~ s/\.uext$// or $core
		1183	or next;
		1184
		1185	my %ext = (dir => $dir);
		1186
		1187	while (<$fh>) {
		1188	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
		1189	my ($pattern, $type, $desc) = split /:/, $1;
		1190	$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
		1191	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1192	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1193	} else {
		1194	$ext{resource}{$pattern} = [$ext, $type, $desc];
		1195	}
		1196	} elsif (/^\s*(?:#|$)/) {
		1197	# skip other comments and empty lines
		1198	} else {
		1199	last; # stop parsing on first non-empty non-comment line
		1200	}
		1201	}
		1202
		1203	$meta{ext}{$ext} = \%ext;
		1204	}
		1205	};
		1206
		1207	# $gather->($_, 0) for @cpandirs;
		1208	$gather->($_, 1) for @urxvtdirs;
		1209
		1210	# and now merge resources
		1211
		1212	$meta{resource} = \my %resource;
		1213
		1214	while (my ($k, $v) = each %{ $meta{ext} }) {
		1215	#TODO: should check for extensions overriding each other
		1216	%resource = (%resource, %{ $v->{resource} });
		1217	}
		1218	}
		1219
1108	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1220	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1109		1221
1110	Creates a new terminal, very similar as if you had started it with system	1222	Creates a new terminal, very similar as if you had started it with system
1111	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1223	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1112	hash which defines the environment of the new terminal.	1224	hash which defines the environment of the new terminal.
…		…
1129	}	1241	}
1130		1242
1131	=item $term->destroy	1243	=item $term->destroy
1132		1244
1133	Destroy the terminal object (close the window, free resources	1245	Destroy the terminal object (close the window, free resources
1134	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1246	etc.). Please note that urxvt will not exit as long as any event
1135	watchers (timers, io watchers) are still active.	1247	watchers (timers, io watchers) are still active.
1136		1248
1137	=item $term->exec_async ($cmd[, @args])	1249	=item $term->exec_async ($cmd[, @args])
1138		1250
1139	Works like the combination of the C<fork>/C<exec> builtins, which executes	1251	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1163		1275
1164	Returns true if the option specified by C<$optval> is enabled, and	1276	Returns true if the option specified by C<$optval> is enabled, and
1165	optionally change it. All option values are stored by name in the hash	1277	optionally change it. All option values are stored by name in the hash
1166	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1278	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1167		1279
1168	Here is a a likely non-exhaustive list of option names, please see the	1280	Here is a likely non-exhaustive list of option names, please see the
1169	source file F</src/optinc.h> to see the actual list:	1281	source file F</src/optinc.h> to see the actual list:
1170		1282
1171	borderLess console cursorBlink cursorUnderline hold iconic insecure	1283	borderLess buffered console cursorBlink cursorUnderline hold iconic
1172	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1284	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1173	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1285	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1174	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1286	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1175	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1287	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1176	transparent tripleclickwords utmpInhibit visualBell	1288	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1289	urgentOnBell utmpInhibit visualBell disablePasteBrackets
1177		1290
1178	=item $value = $term->resource ($name[, $newval])	1291	=item $value = $term->resource ($name[, $newval])
1179		1292
1180	Returns the current resource value associated with a given name and	1293	Returns the current resource value associated with a given name and
1181	optionally sets a new value. Setting values is most useful in the C<init>	1294	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1190	likely change).	1303	likely change).
1191		1304
1192	Please note that resource strings will currently only be freed when the	1305	Please note that resource strings will currently only be freed when the
1193	terminal is destroyed, so changing options frequently will eat memory.	1306	terminal is destroyed, so changing options frequently will eat memory.
1194		1307
1195	Here is a a likely non-exhaustive list of resource names, not all of which	1308	Here is a likely non-exhaustive list of resource names, not all of which
1196	are supported in every build, please see the source file F</src/rsinc.h>	1309	are supported in every build, please see the source file F</src/rsinc.h>
1197	to see the actual list:	1310	to see the actual list:
1198		1311
1199	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1312	answerbackstring backgroundPixmap backspace_key blurradius
1200	borderLess color cursorBlink cursorUnderline cutchars delete_key	1313	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1201	display_name embed ext_bwidth fade font geometry hold iconName	1314	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1202	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1315	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1316	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1203	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1317	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1204	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1318	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1205	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1319	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1206	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1320	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1207	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1321	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1208	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1322	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1209	secondaryScreen secondaryScroll selectstyle shade term_name title	1323	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1210	transient_for transparent transparent_all tripleclickwords utmpInhibit	1324	term_name title transient_for transparent tripleclickwords urgentOnBell
1211	visualBell	1325	utmpInhibit visualBell rewrapMode disablePasteBrackets
1212		1326
1213	=cut	1327	=cut
1214		1328
1215	sub resource($$;$) {	1329	sub resource($$;$) {
1216	my ($self, $name) = (shift, shift);	1330	my ($self, $name) = (shift, shift);
1217	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1331	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1218	&urxvt::term::_resource	1332	goto &urxvt::term::_resource
1219	}	1333	}
1220		1334
1221	=item $value = $term->x_resource ($pattern)	1335	=item $value = $term->x_resource ($pattern)
1222		1336
1223	Returns the X-Resource for the given pattern, excluding the program or	1337	Returns the X-Resource for the given pattern, excluding the program or
1224	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1338	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1225	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1339	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1226	resource with that pattern exists.	1340	resource with that pattern exists.
1227		1341
		1342	Extensions that define extra resources also need to call this method
		1343	to access their values.
		1344
		1345	If the method is called on an extension object (basically, from an
		1346	extension), then the special prefix C<%.> will be replaced by the name of
		1347	the extension and a dot, and the lone string C<%> will be replaced by the
		1348	extension name itself. This makes it possible to code extensions so you
		1349	can rename them and get a new set of resources without having to change
		1350	the actual code.
		1351
1228	This method should only be called during the C<on_start> hook, as there is	1352	This method should only be called during the C<on_start> hook, as there is
1229	only one resource database per display, and later invocations might return	1353	only one resource database per display, and later invocations might return
1230	the wrong resources.	1354	the wrong resources.
1231		1355
1232	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1356	=item $value = $term->x_resource_boolean ($pattern)
1233		1357
		1358	Like C<x_resource>, above, but interprets the string value as a boolean
		1359	and returns C<1> for true values, C<0> for false values and C<undef> if
		1360	the resource or option isn't specified.
		1361
		1362	You should always use this method to parse boolean resources.
		1363
		1364	=cut
		1365
		1366	sub x_resource_boolean {
		1367	my $res = &x_resource;
		1368
		1369	$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
		1370	}
		1371
		1372	=item $action = $term->lookup_keysym ($keysym, $state)
		1373
		1374	Returns the action bound to key combination C<($keysym, $state)>,
		1375	if a binding for it exists, and C<undef> otherwise.
		1376
		1377	=item $success = $term->bind_action ($key, $action)
		1378
1234	Adds a keymap translation exactly as specified via a resource. See the	1379	Adds a key binding exactly as specified via a C<keysym> resource. See the
1235	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1380	C<keysym> resource in the urxvt(1) manpage.
		1381
		1382	To add default bindings for actions, an extension should call C<<
		1383	->bind_action >> in its C<init> hook for every such binding. Doing it
		1384	in the C<init> hook allows users to override or remove the binding
		1385	again.
		1386
		1387	Example: the C<searchable-scrollback> by default binds itself
		1388	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
		1389	$term->bind_action >>.
		1390
		1391	sub init {
		1392	my ($self) = @_;
		1393
		1394	$self->bind_action ("M-s" => "%:start");
		1395	}
1236		1396
1237	=item $rend = $term->rstyle ([$new_rstyle])	1397	=item $rend = $term->rstyle ([$new_rstyle])
1238		1398
1239	Return and optionally change the current rendition. Text that is output by	1399	Return and optionally change the current rendition. Text that is output by
1240	the terminal application will use this style.	1400	the terminal application will use this style.
…		…
1248		1408
1249	=item ($row, $col) = $term->selection_beg ([$row, $col])	1409	=item ($row, $col) = $term->selection_beg ([$row, $col])
1250		1410
1251	=item ($row, $col) = $term->selection_end ([$row, $col])	1411	=item ($row, $col) = $term->selection_end ([$row, $col])
1252		1412
1253	Return the current values of the selection mark, begin or end positions,	1413	Return the current values of the selection mark, begin or end positions.
1254	and optionally set them to new values.	1414
		1415	When arguments are given, then the selection coordinates are set to
		1416	C<$row> and C<$col>, and the selection screen is set to the current
		1417	screen.
		1418
		1419	=item $screen = $term->selection_screen ([$screen])
		1420
		1421	Returns the current selection screen, and then optionally sets it.
1255		1422
1256	=item $term->selection_make ($eventtime[, $rectangular])	1423	=item $term->selection_make ($eventtime[, $rectangular])
1257		1424
1258	Tries to make a selection as set by C<selection_beg> and	1425	Tries to make a selection as set by C<selection_beg> and
1259	C<selection_end>. If C<$rectangular> is true (default: false), a	1426	C<selection_end>. If C<$rectangular> is true (default: false), a
1260	rectangular selection will be made. This is the prefered function to make	1427	rectangular selection will be made. This is the preferred function to make
1261	a selection.	1428	a selection.
1262		1429
1263	=item $success = $term->selection_grab ($eventtime)	1430	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1264		1431
1265	Try to request the primary selection text from the server (for example, as	1432	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1433	true) selection from the server. The corresponding text can be set
1266	set by the next method). No visual feedback will be given. This function	1434	with the next method. No visual feedback will be given. This function
1267	is mostly useful from within C<on_sel_grab> hooks.	1435	is mostly useful from within C<on_sel_grab> hooks.
1268		1436
1269	=item $oldtext = $term->selection ([$newtext])	1437	=item $oldtext = $term->selection ([$newtext, $clipboard])
1270		1438
1271	Return the current selection text and optionally replace it by C<$newtext>.	1439	Return the current selection (clipboard if C<$clipboard> is true) text
		1440	and optionally replace it by C<$newtext>.
		1441
		1442	=item $term->selection_clear ([$clipboard])
		1443
		1444	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1272		1445
1273	=item $term->overlay_simple ($x, $y, $text)	1446	=item $term->overlay_simple ($x, $y, $text)
1274		1447
1275	Create a simple multi-line overlay box. See the next method for details.	1448	Create a simple multi-line overlay box. See the next method for details.
1276		1449
…		…
1304	This method returns an urxvt::overlay object. The overlay will be visible	1477	This method returns an urxvt::overlay object. The overlay will be visible
1305	as long as the perl object is referenced.	1478	as long as the perl object is referenced.
1306		1479
1307	The methods currently supported on C<urxvt::overlay> objects are:	1480	The methods currently supported on C<urxvt::overlay> objects are:
1308		1481
1309	=over 4	1482	=over
1310		1483
1311	=item $overlay->set ($x, $y, $text, $rend)	1484	=item $overlay->set ($x, $y, $text[, $rend])
1312		1485
1313	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1486	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1314	text in rxvt-unicode's special encoding and an array of rendition values	1487	text in rxvt-unicode's special encoding and an array of rendition values
1315	at a specific position inside the overlay.	1488	at a specific position inside the overlay.
		1489
		1490	If C<$rend> is missing, then the rendition will not be changed.
1316		1491
1317	=item $overlay->hide	1492	=item $overlay->hide
1318		1493
1319	If visible, hide the overlay, but do not destroy it.	1494	If visible, hide the overlay, but do not destroy it.
1320		1495
…		…
1383		1558
1384	=item $term->scr_add_lines ($string)	1559	=item $term->scr_add_lines ($string)
1385		1560
1386	Write the given text string to the screen, as if output by the application	1561	Write the given text string to the screen, as if output by the application
1387	running inside the terminal. It may not contain command sequences (escape	1562	running inside the terminal. It may not contain command sequences (escape
1388	codes), but is free to use line feeds, carriage returns and tabs. The	1563	codes - see C<cmd_parse> for that), but is free to use line feeds,
1389	string is a normal text string, not in locale-dependent encoding.	1564	carriage returns and tabs. The string is a normal text string, not in
		1565	locale-dependent encoding.
1390		1566
1391	Normally its not a good idea to use this function, as programs might be	1567	Normally its not a good idea to use this function, as programs might be
1392	confused by changes in cursor position or scrolling. Its useful inside a	1568	confused by changes in cursor position or scrolling. Its useful inside a
1393	C<on_add_lines> hook, though.	1569	C<on_add_lines> hook, though.
1394		1570
…		…
1402	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1403	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1404		1580
1405	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1406		1582
1407	Write the octets given in C<$data> to the tty (i.e. as program input). To	1583	Write the octets given in C<$octets> to the tty (i.e. as user input
		1584	to the program, see C<cmd_parse> for the opposite direction). To pass
1408	pass characters instead of octets, you should convert your strings first	1585	characters instead of octets, you should convert your strings first to the
1409	to the locale-specific encoding using C<< $term->locale_encode >>.	1586	locale-specific encoding using C<< $term->locale_encode >>.
		1587
		1588	=item $term->tt_write_user_input ($octets)
		1589
		1590	Like C<tt_write>, but should be used when writing strings in response to
		1591	the user pressing a key, to invoke the additional actions requested by
		1592	the user for that case (C<tt_write> doesn't do that).
		1593
		1594	The typical use case would be inside C<on_action> hooks.
		1595
		1596	=item $term->tt_paste ($octets)
		1597
		1598	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1599	CR and bracketing the data with control sequences if bracketed paste mode
		1600	is set.
1410		1601
1411	=item $old_events = $term->pty_ev_events ([$new_events])	1602	=item $old_events = $term->pty_ev_events ([$new_events])
1412		1603
1413	Replaces the event mask of the pty watcher by the given event mask. Can	1604	Replaces the event mask of the pty watcher by the given event mask. Can
1414	be used to suppress input and output handling to the pty/tty. See the	1605	be used to suppress input and output handling to the pty/tty. See the
…		…
1433	Adds the specified events to the vt event mask. Useful e.g. when you want	1624	Adds the specified events to the vt event mask. Useful e.g. when you want
1434	to receive pointer events all the times:	1625	to receive pointer events all the times:
1435		1626
1436	$term->vt_emask_add (urxvt::PointerMotionMask);	1627	$term->vt_emask_add (urxvt::PointerMotionMask);
1437		1628
		1629	=item $term->set_urgency ($set)
		1630
		1631	Enable/disable the urgency hint on the toplevel window.
		1632
1438	=item $term->focus_in	1633	=item $term->focus_in
1439		1634
1440	=item $term->focus_out	1635	=item $term->focus_out
1441		1636
1442	=item $term->key_press ($state, $keycode[, $time])	1637	=item $term->key_press ($state, $keycode[, $time])
1443		1638
1444	=item $term->key_release ($state, $keycode[, $time])	1639	=item $term->key_release ($state, $keycode[, $time])
1445		1640
1446	Deliver various fake events to to terminal.	1641	Deliver various fake events to to terminal.
1447		1642
1448	=item $window_width = $term->width	1643	=item $window_width = $term->width ([$new_value])
1449		1644
1450	=item $window_height = $term->height	1645	=item $window_height = $term->height ([$new_value])
1451		1646
1452	=item $font_width = $term->fwidth	1647	=item $font_width = $term->fwidth ([$new_value])
1453		1648
1454	=item $font_height = $term->fheight	1649	=item $font_height = $term->fheight ([$new_value])
1455		1650
1456	=item $font_ascent = $term->fbase	1651	=item $font_ascent = $term->fbase ([$new_value])
1457		1652
1458	=item $terminal_rows = $term->nrow	1653	=item $terminal_rows = $term->nrow ([$new_value])
1459		1654
1460	=item $terminal_columns = $term->ncol	1655	=item $terminal_columns = $term->ncol ([$new_value])
1461		1656
1462	=item $has_focus = $term->focus	1657	=item $has_focus = $term->focus ([$new_value])
1463		1658
1464	=item $is_mapped = $term->mapped	1659	=item $is_mapped = $term->mapped ([$new_value])
1465		1660
1466	=item $max_scrollback = $term->saveLines	1661	=item $max_scrollback = $term->saveLines ([$new_value])
1467		1662
1468	=item $nrow_plus_saveLines = $term->total_rows	1663	=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1469		1664
1470	=item $topmost_scrollback_row = $term->top_row	1665	=item $topmost_scrollback_row = $term->top_row ([$new_value])
1471		1666
1472	Return various integers describing terminal characteristics.	1667	Return various integers describing terminal characteristics. If an
		1668	argument is given, changes the value and returns the previous one.
1473		1669
1474	=item $x_display = $term->display_id	1670	=item $x_display = $term->display_id
1475		1671
1476	Return the DISPLAY used by rxvt-unicode.	1672	Return the DISPLAY used by rxvt-unicode.
1477		1673
…		…
1512		1708
1513	Returns the currently displayed screen (0 primary, 1 secondary).	1709	Returns the currently displayed screen (0 primary, 1 secondary).
1514		1710
1515	=item $cursor_is_hidden = $term->hidden_cursor	1711	=item $cursor_is_hidden = $term->hidden_cursor
1516		1712
1517	Returns wether the cursor is currently hidden or not.	1713	Returns whether the cursor is currently hidden or not.
		1714
		1715	=item $priv_modes = $term->priv_modes
		1716
		1717	Returns a bitset with the state of DEC private modes.
		1718
		1719	Example:
		1720
		1721	if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
		1722	# mouse reporting is turned on
		1723	}
1518		1724
1519	=item $view_start = $term->view_start ([$newvalue])	1725	=item $view_start = $term->view_start ([$newvalue])
1520		1726
1521	Returns the row number of the topmost displayed line. Maximum value is	1727	Returns the row number of the topmost displayed line and changes it,
1522	C<0>, which displays the normal terminal contents. Lower values scroll	1728	if an argument is given. Values greater than or equal to C<0> display
1523	this many lines into the scrollback buffer.	1729	the terminal contents. Lower values scroll this many lines into the
		1730	scrollback buffer.
1524		1731
1525	=item $term->want_refresh	1732	=item $term->want_refresh
1526		1733
1527	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1734	Requests a screen refresh. At the next opportunity, rxvt-unicode will
1528	compare the on-screen display with its stored representation. If they	1735	compare the on-screen display with its stored representation. If they
1529	differ, it redraws the differences.	1736	differ, it redraws the differences.
1530		1737
1531	Used after changing terminal contents to display them.	1738	Used after changing terminal contents to display them.
1532		1739
		1740	=item $term->refresh_check
		1741
		1742	Checks if a refresh has been requested and, if so, schedules one.
		1743
1533	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1744	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1534		1745
1535	Returns the text of the entire row with number C<$row_number>. Row C<0>	1746	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1536	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1747	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1537	terminal line. The scrollback buffer starts at line C<-1> and extends to
1538	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1748	terminal line. Nothing will be returned if a nonexistent line
1539	is requested.	1749	is requested.
1540		1750
1541	If C<$new_text> is specified, it will replace characters in the current	1751	If C<$new_text> is specified, it will replace characters in the current
1542	line, starting at column C<$start_col> (default C<0>), which is useful	1752	line, starting at column C<$start_col> (default C<0>), which is useful
1543	to replace only parts of a line. The font index in the rendition will	1753	to replace only parts of a line. The font index in the rendition will
1544	automatically be updated.	1754	automatically be updated.
1545		1755
1546	C<$text> is in a special encoding: tabs and wide characters that use more	1756	C<$text> is in a special encoding: tabs and wide characters that use more
1547	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1757	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1548	characters. Characters with combining characters and other characters that	1758	characters. Characters with combining characters and other characters that
1549	do not fit into the normal tetx encoding will be replaced with characters	1759	do not fit into the normal text encoding will be replaced with characters
1550	in the private use area.	1760	in the private use area.
1551		1761
1552	You have to obey this encoding when changing text. The advantage is	1762	You have to obey this encoding when changing text. The advantage is
1553	that C<substr> and similar functions work on screen cells and not on	1763	that C<substr> and similar functions work on screen cells and not on
1554	characters.	1764	characters.
…		…
1583		1793
1584	Create and return a new C<urxvt::line> object that stores information	1794	Create and return a new C<urxvt::line> object that stores information
1585	about the logical line that row C<$row_number> is part of. It supports the	1795	about the logical line that row C<$row_number> is part of. It supports the
1586	following methods:	1796	following methods:
1587		1797
1588	=over 4	1798	=over
1589		1799
1590	=item $text = $line->t ([$new_text])	1800	=item $text = $line->t ([$new_text])
1591		1801
1592	Returns or replaces the full text of the line, similar to C<ROW_t>	1802	Returns or replaces the full text of the line, similar to C<ROW_t>
1593		1803
…		…
1639	}	1849	}
1640		1850
1641	sub urxvt::line::t {	1851	sub urxvt::line::t {
1642	my ($self) = @_;	1852	my ($self) = @_;
1643		1853
1644	if (@_ > 1)	1854	if (@_ > 1) {
1645	{
1646	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1855	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1647	for $self->{beg} .. $self->{end};	1856	for $self->{beg} .. $self->{end};
1648	}	1857	}
1649		1858
1650	defined wantarray &&	1859	defined wantarray &&
1651	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1860	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1652	0, $self->{len}	1861	0, $self->{len}
1653	}	1862	}
1654		1863
1655	sub urxvt::line::r {	1864	sub urxvt::line::r {
1656	my ($self) = @_;	1865	my ($self) = @_;
1657		1866
1658	if (@_ > 1)	1867	if (@_ > 1) {
1659	{
1660	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1868	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1661	for $self->{beg} .. $self->{end};	1869	for $self->{beg} .. $self->{end};
1662	}	1870	}
1663		1871
1664	if (defined wantarray) {	1872	if (defined wantarray) {
1665	my $rend = [	1873	my $rend = [
1666	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1874	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1667	];	1875	];
…		…
1699	where one character corresponds to one screen cell. See	1907	where one character corresponds to one screen cell. See
1700	C<< $term->ROW_t >> for details.	1908	C<< $term->ROW_t >> for details.
1701		1909
1702	=item $string = $term->special_decode $text	1910	=item $string = $term->special_decode $text
1703		1911
1704	Converts rxvt-unicodes text reprsentation into a perl string. See	1912	Converts rxvt-unicodes text representation into a perl string. See
1705	C<< $term->ROW_t >> for details.	1913	C<< $term->ROW_t >> for details.
1706		1914
1707	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1915	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1708		1916
1709	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1917	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1712	manpage.	1920	manpage.
1713		1921
1714	=item $success = $term->grab ($eventtime[, $sync])	1922	=item $success = $term->grab ($eventtime[, $sync])
1715		1923
1716	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1924	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1717	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1925	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1718		1926
1719	=item $term->allow_events_async	1927	=item $term->allow_events_async
1720		1928
1721	Calls XAllowEvents with AsyncBoth for the most recent grab.	1929	Calls XAllowEvents with AsyncBoth for the most recent grab.
1722		1930
…		…
1729	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1937	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1730	recent grab.	1938	recent grab.
1731		1939
1732	=item $term->ungrab	1940	=item $term->ungrab
1733		1941
1734	Calls XUngrab for the most recent grab. Is called automatically on	1942	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1735	evaluation errors, as it is better to lose the grab in the error case as	1943	evaluation errors, as it is better to lose the grab in the error case as
1736	the session.	1944	the session.
1737		1945
1738	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1946	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1739		1947
…		…
1741		1949
1742	=item @atoms = $term->XListProperties ($window)	1950	=item @atoms = $term->XListProperties ($window)
1743		1951
1744	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1952	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1745		1953
1746	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1954	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1747		1955
1748	=item $term->XDeleteProperty ($window, $property)	1956	=item $term->XDeleteProperty ($window, $property)
1749		1957
1750	=item $window = $term->DefaultRootWindow	1958	=item $window = $term->DefaultRootWindow
1751		1959
…		…
1758	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1966	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1759		1967
1760	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1968	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1761		1969
1762	=item $term->XChangeInput ($window, $add_events[, $del_events])	1970	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1971
		1972	=item $keysym = $term->XStringToKeysym ($string)
		1973
		1974	=item $string = $term->XKeysymToString ($keysym)
1763		1975
1764	Various X or X-related functions. The C<$term> object only serves as	1976	Various X or X-related functions. The C<$term> object only serves as
1765	the source of the display, otherwise those functions map more-or-less	1977	the source of the display, otherwise those functions map more-or-less
1766	directory onto the X functions of the same name.	1978	directly onto the X functions of the same name.
1767		1979
1768	=back	1980	=back
1769		1981
1770	=cut	1982	=cut
1771		1983
1772	package urxvt::popup;	1984	package urxvt::popup;
1773		1985
1774	=head2 The C<urxvt::popup> Class	1986	=head2 The C<urxvt::popup> Class
1775		1987
1776	=over 4	1988	=over
1777		1989
1778	=cut	1990	=cut
1779		1991
1780	sub add_item {	1992	sub add_item {
1781	my ($self, $item) = @_;	1993	my ($self, $item) = @_;
…		…
1873	my $env = $self->{term}->env;	2085	my $env = $self->{term}->env;
1874	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2086	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1875	delete $env->{LC_ALL};	2087	delete $env->{LC_ALL};
1876	$env->{LC_CTYPE} = $self->{term}->locale;	2088	$env->{LC_CTYPE} = $self->{term}->locale;
1877		2089
1878	urxvt::term->new ($env, "popup",	2090	my $term = urxvt::term->new (
		2091	$env, "popup",
1879	"--perl-lib" => "", "--perl-ext-common" => "",	2092	"--perl-lib" => "", "--perl-ext-common" => "",
1880	"-pty-fd" => -1, "-sl" => 0,	2093	"-pty-fd" => -1, "-sl" => 0,
1881	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2094	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1882	"--transient-for" => $self->{term}->parent,	2095	"--transient-for" => $self->{term}->parent,
1883	"-display" => $self->{term}->display_id,	2096	"-display" => $self->{term}->display_id,
1884	"-pe" => "urxvt-popup")	2097	"-pe" => "urxvt-popup",
1885	or die "unable to create popup window\n";	2098	) or die "unable to create popup window\n";
		2099
		2100	unless (delete $term->{urxvt_popup_init_done}) {
		2101	$term->ungrab;
		2102	$term->destroy;
		2103	die "unable to initialise popup window\n";
		2104	}
1886	}	2105	}
1887		2106
1888	sub DESTROY {	2107	sub DESTROY {
1889	my ($self) = @_;	2108	my ($self) = @_;
1890		2109
…		…
1895	=back	2114	=back
1896		2115
1897	=cut	2116	=cut
1898		2117
1899	package urxvt::watcher;	2118	package urxvt::watcher;
1900
1901	@urxvt::timer::ISA = __PACKAGE__;
1902	@urxvt::iow::ISA = __PACKAGE__;
1903	@urxvt::pw::ISA = __PACKAGE__;
1904	@urxvt::iw::ISA = __PACKAGE__;
1905		2119
1906	=head2 The C<urxvt::timer> Class	2120	=head2 The C<urxvt::timer> Class
1907		2121
1908	This class implements timer watchers/events. Time is represented as a	2122	This class implements timer watchers/events. Time is represented as a
1909	fractional number of seconds since the epoch. Example:	2123	fractional number of seconds since the epoch. Example:
…		…
1913	->new	2127	->new
1914	->interval (1)	2128	->interval (1)
1915	->cb (sub {	2129	->cb (sub {
1916	$term->{overlay}->set (0, 0,	2130	$term->{overlay}->set (0, 0,
1917	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2131	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1918	});	2132	});
1919		2133
1920	=over 4	2134	=over
1921		2135
1922	=item $timer = new urxvt::timer	2136	=item $timer = new urxvt::timer
1923		2137
1924	Create a new timer object in started state. It is scheduled to fire	2138	Create a new timer object in started state. It is scheduled to fire
1925	immediately.	2139	immediately.
1926		2140
1927	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2141	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1928		2142
1929	Set the callback to be called when the timer triggers.	2143	Set the callback to be called when the timer triggers.
1930		2144
1931	=item $tstamp = $timer->at
1932
1933	Return the time this watcher will fire next.
1934
1935	=item $timer = $timer->set ($tstamp)	2145	=item $timer = $timer->set ($tstamp[, $interval])
1936		2146
1937	Set the time the event is generated to $tstamp.	2147	Set the time the event is generated to $tstamp (and optionally specifies a
		2148	new $interval).
1938		2149
1939	=item $timer = $timer->interval ($interval)	2150	=item $timer = $timer->interval ($interval)
1940		2151
1941	Normally (and when C<$interval> is C<0>), the timer will automatically	2152	By default (and when C<$interval> is C<0>), the timer will automatically
1942	stop after it has fired once. If C<$interval> is non-zero, then the timer	2153	stop after it has fired once. If C<$interval> is non-zero, then the timer
1943	is automatically rescheduled at the given intervals.	2154	is automatically rescheduled at the given intervals.
1944		2155
1945	=item $timer = $timer->start	2156	=item $timer = $timer->start
1946		2157
1947	Start the timer.	2158	Start the timer.
1948		2159
1949	=item $timer = $timer->start ($tstamp)	2160	=item $timer = $timer->start ($tstamp[, $interval])
1950		2161
1951	Set the event trigger time to C<$tstamp> and start the timer.	2162	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2163	also replaces the interval.
1952		2164
1953	=item $timer = $timer->after ($delay)	2165	=item $timer = $timer->after ($delay[, $interval])
1954		2166
1955	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2167	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1956		2168
1957	=item $timer = $timer->stop	2169	=item $timer = $timer->stop
1958		2170
…		…
1966		2178
1967	$term->{socket} = ...	2179	$term->{socket} = ...
1968	$term->{iow} = urxvt::iow	2180	$term->{iow} = urxvt::iow
1969	->new	2181	->new
1970	->fd (fileno $term->{socket})	2182	->fd (fileno $term->{socket})
1971	->events (urxvt::EVENT_READ)	2183	->events (urxvt::EV_READ)
1972	->start	2184	->start
1973	->cb (sub {	2185	->cb (sub {
1974	my ($iow, $revents) = @_;	2186	my ($iow, $revents) = @_;
1975	# $revents must be 1 here, no need to check	2187	# $revents must be 1 here, no need to check
1976	sysread $term->{socket}, my $buf, 8192	2188	sysread $term->{socket}, my $buf, 8192
1977	or end-of-file;	2189	or end-of-file;
1978	});	2190	});
1979		2191
1980		2192
1981	=over 4	2193	=over
1982		2194
1983	=item $iow = new urxvt::iow	2195	=item $iow = new urxvt::iow
1984		2196
1985	Create a new io watcher object in stopped state.	2197	Create a new io watcher object in stopped state.
1986		2198
…		…
1989	Set the callback to be called when io events are triggered. C<$reventmask>	2201	Set the callback to be called when io events are triggered. C<$reventmask>
1990	is a bitset as described in the C<events> method.	2202	is a bitset as described in the C<events> method.
1991		2203
1992	=item $iow = $iow->fd ($fd)	2204	=item $iow = $iow->fd ($fd)
1993		2205
1994	Set the filedescriptor (not handle) to watch.	2206	Set the file descriptor (not handle) to watch.
1995		2207
1996	=item $iow = $iow->events ($eventmask)	2208	=item $iow = $iow->events ($eventmask)
1997		2209
1998	Set the event mask to watch. The only allowed values are	2210	Set the event mask to watch. The only allowed values are
1999	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2211	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2000	together, or C<urxvt::EVENT_NONE>.	2212	together, or C<urxvt::EV_NONE>.
2001		2213
2002	=item $iow = $iow->start	2214	=item $iow = $iow->start
2003		2215
2004	Start watching for requested events on the given handle.	2216	Start watching for requested events on the given handle.
2005		2217
2006	=item $iow = $iow->stop	2218	=item $iow = $iow->stop
2007		2219
2008	Stop watching for events on the given filehandle.	2220	Stop watching for events on the given file handle.
2009		2221
2010	=back	2222	=back
2011		2223
2012	=head2 The C<urxvt::iw> Class	2224	=head2 The C<urxvt::iw> Class
2013		2225
2014	This class implements idle watchers, that get called automatically when	2226	This class implements idle watchers, that get called automatically when
2015	the process is idle. They should return as fast as possible, after doing	2227	the process is idle. They should return as fast as possible, after doing
2016	some useful work.	2228	some useful work.
2017		2229
2018	=over 4	2230	=over
2019		2231
2020	=item $iw = new urxvt::iw	2232	=item $iw = new urxvt::iw
2021		2233
2022	Create a new idle watcher object in stopped state.	2234	Create a new idle watcher object in stopped state.
2023		2235
…		…
2046	->new	2258	->new
2047	->start ($pid)	2259	->start ($pid)
2048	->cb (sub {	2260	->cb (sub {
2049	my ($pw, $exit_status) = @_;	2261	my ($pw, $exit_status) = @_;
2050	...	2262	...
2051	});	2263	});
2052		2264
2053	=over 4	2265	=over
2054		2266
2055	=item $pw = new urxvt::pw	2267	=item $pw = new urxvt::pw
2056		2268
2057	Create a new process watcher in stopped state.	2269	Create a new process watcher in stopped state.
2058		2270
…		…
2060		2272
2061	Set the callback to be called when the timer triggers.	2273	Set the callback to be called when the timer triggers.
2062		2274
2063	=item $pw = $timer->start ($pid)	2275	=item $pw = $timer->start ($pid)
2064		2276
2065	Tells the wqtcher to start watching for process C<$pid>.	2277	Tells the watcher to start watching for process C<$pid>.
2066		2278
2067	=item $pw = $pw->stop	2279	=item $pw = $pw->stop
2068		2280
2069	Stop the watcher.	2281	Stop the watcher.
2070		2282
…		…
2075	=head2 URXVT_PERL_VERBOSITY	2287	=head2 URXVT_PERL_VERBOSITY
2076		2288
2077	This variable controls the verbosity level of the perl extension. Higher	2289	This variable controls the verbosity level of the perl extension. Higher
2078	numbers indicate more verbose output.	2290	numbers indicate more verbose output.
2079		2291
2080	=over 4	2292	=over
2081		2293
2082	=item == 0 - fatal messages	2294	=item == 0 - fatal messages
2083		2295
2084	=item >= 3 - script loading and management	2296	=item >= 3 - script loading and management
2085		2297
2086	=item >=10 - all called hooks	2298	=item >=10 - all called hooks
2087		2299
2088	=item >=11 - hook reutrn values	2300	=item >=11 - hook return values
2089		2301
2090	=back	2302	=back
2091		2303
2092	=head1 AUTHOR	2304	=head1 AUTHOR
2093		2305
2094	Marc Lehmann <pcg@goof.com>	2306	Marc Lehmann <schmorp@schmorp.de>
2095	http://software.schmorp.de/pkg/rxvt-unicode	2307	http://software.schmorp.de/pkg/rxvt-unicode
2096		2308
2097	=cut	2309	=cut
2098		2310
2099	1	2311	1
		2312
		2313	# vim: sw=3:

Diff Legend

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