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.141 by root, Mon Jul 3 19:11:41 2006 UTC vs.
Revision 1.221 by sf-exg, Thu Jun 21 06:08:05 2012 UTC

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

Diff Legend

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