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.136 by root, Mon Feb 20 20:44:22 2006 UTC vs.
Revision 1.220 by root, Tue Jun 19 18:17:56 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 one-line extension that dynamically changes the background pixmap offset
261	to the window position, in effect creating the same effect as pseudo transparency with
262	a custom pixmap. No scaling is supported in this mode. Exmaple:
263
264	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
265
266	=item block-graphics-to-ascii
267
268	A not very useful example of filtering all text output to the terminal,
269	by replacing all line-drawing characters (U+2500 .. U+259F) by a
270	similar-looking ascii character.
271
272	=item digital-clock
273
274	Displays a digital clock using the built-in overlay.
275
276	=item remote-clipboard
277
278	Somewhat of a misnomer, this extension adds two menu entries to the
279	selection popup that allows one ti run external commands to store the
280	selection somewhere and fetch it again.
281
282	We use it to implement a "distributed selection mechanism", which just
283	means that one command uploads the file to a remote server, and another
284	reads it.
285
286	The commands can be set using the C<URxvt.remote-selection.store> and
287	C<URxvt.remote-selection.fetch> resources. The first should read the
288	selection to store from STDIN (always in UTF-8), the second should provide
289	the selection data on STDOUT (also in UTF-8).
290
291	The defaults (which are likely useless to you) use rsh and cat:
292
293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
295
296	=item selection-pastebin
297
298	This is a little rarely useful extension that Uploads the selection as
299	textfile to a remote site (or does other things). (The implementation is
300	not currently secure for use in a multiuser environment as it writes to
301	F</tmp> directly.).
302
303	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
304	i.e.
305
306	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
307
308	Pressing this combination runs a command with C<%> replaced by the name of
309	the textfile. This command can be set via a resource:
310
311	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
312
313	And the default is likely not useful to anybody but the few people around
314	here :)
315
316	The name of the textfile is the hex encoded md5 sum of the selection, so
317	the same content should lead to the same filename.
318
319	After a successful upload the selection will be replaced by the text given
320	in the C<selection-pastebin-url> resource (again, the % is the placeholder
321	for the filename):
322
323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
324
325	=item example-refresh-hooks
326
327	Displays a very simple digital clock in the upper right corner of the
328	window. Illustrates overwriting the refresh callbacks to create your own
329	overlays or changes.
330
331	=back
332		50
333	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
334		52
335	=head2 General API Considerations	53	=head2 General API Considerations
336		54
…		…
350		68
351	=over 4	69	=over 4
352		70
353	=item $text	71	=item $text
354		72
355	Rxvt-unicodes special way of encoding text, where one "unicode" character	73	Rxvt-unicode's special way of encoding text, where one "unicode" character
356	always represents one screen cell. See L<ROW_t> for a discussion of this format.	74	always represents one screen cell. See L<ROW_t> for a discussion of this format.
357		75
358	=item $string	76	=item $string
359		77
360	A perl text string, with an emphasis on I<text>. It can store all unicode	78	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
364	=item $octets	82	=item $octets
365		83
366	Either binary data or - more common - a text string encoded in a	84	Either binary data or - more common - a text string encoded in a
367	locale-specific way.	85	locale-specific way.
368		86
		87	=item $keysym
		88
		89	an integer that is a valid X11 keysym code. You can convert a string
		90	into a keysym and viceversa by using C<XStringToKeysym> and
		91	C<XKeysymToString>.
		92
369	=back	93	=back
370		94
371	=head2 Extension Objects	95	=head2 Extension Objects
372		96
373	Very perl extension is a perl class. A separate perl object is created	97	Every perl extension is a perl class. A separate perl object is created
374	for each terminal and each extension and passed as the first parameter to	98	for each terminal, and each terminal has its own set of extension objects,
375	hooks. So extensions can use their C<$self> object without having to think	99	which are passed as the first parameter to hooks. So extensions can use
376	about other extensions, with the exception of methods and members that	100	their C<$self> object without having to think about clashes with other
		101	extensions or other terminals, with the exception of methods and members
377	begin with an underscore character C<_>: these are reserved for internal	102	that begin with an underscore character C<_>: these are reserved for
378	use.	103	internal use.
379		104
380	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
381	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
382		107
383	It has the following methods and data members:	108	It has the following methods and data members:
…		…
387	=item $urxvt_term = $self->{term}	112	=item $urxvt_term = $self->{term}
388		113
389	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
390	extension. This member I<must not> be changed in any way.	115	extension. This member I<must not> be changed in any way.
391		116
392	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])	117	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
393		118
394	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
395	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
396	to overwrite time-critical hooks only temporarily.	121	to overwrite time-critical hooks only temporarily.
397		122
		123	To install additional callbacks for the same hook, you cna use the C<on>
		124	method of the C<urxvt::term> class.
		125
398	=item $self->disable ($hook_name[, $hook_name..])	126	=item $self->disable ($hook_name[, $hook_name..])
399		127
400	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.
401		137
402	=back	138	=back
403		139
404	=head2 Hooks	140	=head2 Hooks
405		141
406	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
407	called whenever the relevant event happens.	143	called whenever the relevant event happens.
408		144
409	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
410	the in the C<Extension Objects> section.	146	the in the C<Extension Objects> section.
411		147
412	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
413	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
414	relevant action might not be carried out by the C++ code.	150	relevant action might not be carried out by the C++ code.
…		…
427	place.	163	place.
428		164
429	=item on_start $term	165	=item on_start $term
430		166
431	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
432	trying to map (display) the toplevel and returning to the mainloop.	168	trying to map (display) the toplevel and returning to the main loop.
433		169
434	=item on_destroy $term	170	=item on_destroy $term
435		171
436	Called whenever something tries to destroy terminal, when the terminal is	172	Called whenever something tries to destroy terminal, when the terminal is
437	still fully functional (not for long, though).	173	still fully functional (not for long, though).
…		…
464		200
465	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
466	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
467	by calling C<< $term->selection >>.	203	by calling C<< $term->selection >>.
468		204
469	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.
470		206
471	=item on_sel_extend $term	207	=item on_sel_extend $term
472		208
473	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
474	click) and is either supposed to return false (normal operation), or	210	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	211	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	212	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	213	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.	214	supposed to enlarge the selection more and more, if possible.
479		215
480	See the F<selection> example extension.	216	See the F<selection> example extension.
481		217
482	=item on_view_change $term, $offset	218	=item on_view_change $term, $offset
483		219
484	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
485	scrolls. Offset C<0> means display the normal terminal, positive values	221	scrolls. Offset C<0> means display the normal terminal, positive values
486	show this many lines of scrollback.	222	show this many lines of scrollback.
487		223
488	=item on_scroll_back $term, $lines, $saved	224	=item on_scroll_back $term, $lines, $saved
489		225
…		…
493		229
494	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,
495	$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
496	number of lines that will be in the scrollback buffer.	232	number of lines that will be in the scrollback buffer.
497		233
498	=item on_osc_seq $term, $string	234	=item on_osc_seq $term, $op, $args, $resp
		235
		236	Called on every OSC sequence and can be used to suppress it or modify its
		237	behaviour. The default should be to return an empty list. A true value
		238	suppresses execution of the request completely. Make sure you don't get
		239	confused by recursive invocations when you output an OSC sequence within
		240	this callback.
		241
		242	C<on_osc_seq_perl> should be used for new behaviour.
		243
		244	=item on_osc_seq_perl $term, $args, $resp
499		245
500	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	246	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
501	operating system command) is processed. Cursor position and other state	247	operating system command) is processed. Cursor position and other state
502	information is up-to-date when this happens. For interoperability, the	248	information is up-to-date when this happens. For interoperability, the
503	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,
504	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
505	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	}
506		262
507	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,
508	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
509	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.
510		269
511	=item on_add_lines $term, $string	270	=item on_add_lines $term, $string
512		271
513	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
514	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
…		…
519	=item on_tt_write $term, $octets	278	=item on_tt_write $term, $octets
520		279
521	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
522	suppress or filter tty input.	281	suppress or filter tty input.
523		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
524	=item on_line_update $term, $row	290	=item on_line_update $term, $row
525		291
526	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
527	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
528	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,
…		…
535	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
536	you cannot just toggle rendition bits, but only set them.	302	you cannot just toggle rendition bits, but only set them.
537		303
538	=item on_refresh_begin $term	304	=item on_refresh_begin $term
539		305
540	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
541	or similar effects by modify terminal contents in refresh_begin, and	307	similar effects by modifying the terminal contents in refresh_begin, and
542	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
543	code is run after this hook, and takes precedence.	309	code is run after this hook, and takes precedence.
544		310
545	=item on_refresh_end $term	311	=item on_refresh_end $term
546		312
547	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>.
548		314
549	=item on_user_command $term, $string	315	=item on_user_command $term, $string
550		316
551	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
552	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>
553	resource in the @@RXVT_NAME@@(1) manpage).	319	resource in the @@RXVT_NAME@@(1) manpage).
554		320
555	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
556	slightly in the future.	322	slightly in the future.
557		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
558	=item on_resize_all_windows $tern, $new_width, $new_height	331	=item on_resize_all_windows $term, $new_width, $new_height
559		332
560	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
561	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
562	returns TRUE, setting of the window hints is being skipped.	335	returns TRUE, setting of the window hints is being skipped.
563		336
564	=item on_x_event $term, $event	337	=item on_x_event $term, $event
565		338
566	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
567	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
568	members are not passed.	341	members are not passed.
569		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
570	=item on_focus_in $term	347	=item on_focus_in $term
571		348
572	Called whenever the window gets the keyboard focus, before rxvt-unicode	349	Called whenever the window gets the keyboard focus, before rxvt-unicode
573	does focus in processing.	350	does focus in processing.
574		351
575	=item on_focus_out $term	352	=item on_focus_out $term
576		353
577	Called wheneever the window loses keyboard focus, before rxvt-unicode does	354	Called whenever the window loses keyboard focus, before rxvt-unicode does
578	focus out processing.	355	focus out processing.
579		356
580	=item on_configure_notify $term, $event	357	=item on_configure_notify $term, $event
581		358
582	=item on_property_notify $term, $event	359	=item on_property_notify $term, $event
…		…
593		370
594	=item on_map_notify $term, $event	371	=item on_map_notify $term, $event
595		372
596	=item on_unmap_notify $term, $event	373	=item on_unmap_notify $term, $event
597		374
598	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
599	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.
600		377
601	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
602	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
603	(real, not screen-based) row and column under the mouse cursor.	380	(real, not screen-based) row and column under the mouse cursor.
604		381
…		…
614	=item on_wm_delete_window $term, $event	391	=item on_wm_delete_window $term, $event
615		392
616	Called when various types of ClientMessage events are received (all with	393	Called when various types of ClientMessage events are received (all with
617	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	394	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
618		395
		396	=item on_bell $term
		397
		398	Called on receipt of a bell character.
		399
619	=back	400	=back
620		401
621	=cut	402	=cut
622		403
623	package urxvt;	404	package urxvt;
624		405
625	use utf8;	406	use utf8;
626	use strict;	407	use strict 'vars';
627	use Carp ();	408	use Carp ();
628	use Scalar::Util ();	409	use Scalar::Util ();
629	use List::Util ();	410	use List::Util ();
630		411
631	our $VERSION = 1;	412	our $VERSION = 1;
632	our $TERM;	413	our $TERM;
633	our @TERM_INIT;	414	our @TERM_INIT; # should go, prevents async I/O etc.
634	our @TERM_EXT;	415	our @TERM_EXT; # should go, prevents async I/O etc.
635	our @HOOKNAME;	416	our @HOOKNAME;
636	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
637	our %OPTION;	418	our %OPTION;
638		419
639	our $LIBDIR;	420	our $LIBDIR;
…		…
665	The current terminal. This variable stores the current C<urxvt::term>	446	The current terminal. This variable stores the current C<urxvt::term>
666	object, whenever a callback/hook is executing.	447	object, whenever a callback/hook is executing.
667		448
668	=item @urxvt::TERM_INIT	449	=item @urxvt::TERM_INIT
669		450
670	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
671	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
672	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,
673	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.
674		455
675	This complements to the perl-eval commandline option, but gets executed	456	This complements to the perl-eval command line option, but gets executed
676	first.	457	first.
677		458
678	=item @urxvt::TERM_EXT	459	=item @urxvt::TERM_EXT
679		460
680	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
…		…
687		468
688	=over 4	469	=over 4
689		470
690	=item urxvt::fatal $errormessage	471	=item urxvt::fatal $errormessage
691		472
692	Fatally aborts execution with the given error message. Avoid at all	473	Fatally aborts execution with the given error message (which should
693	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
694	starts up.	475	is acceptable (and useful) is in the init hook, where it prevents the
		476	terminal from starting up.
695		477
696	=item urxvt::warn $string	478	=item urxvt::warn $string
697		479
698	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
699	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
700	that calls this function.	482	that calls this function.
701		483
702	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
703	correct place, e.g. on stderr of the connecting urxvtc client.	485	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
705	Messages have a size limit of 1023 bytes currently.	487	Messages have a size limit of 1023 bytes currently.
706		488
707	=item @terms = urxvt::termlist	489	=item @terms = urxvt::termlist
708		490
709	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
710	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
711	objects that have perl extensions attached will be returned (because there	493	objects that have perl extensions attached will be returned (because there
712	is no urxvt::term objet associated with others).	494	is no urxvt::term object associated with others).
713		495
714	=item $time = urxvt::NOW	496	=item $time = urxvt::NOW
715		497
716	Returns the "current time" (as per the event loop).	498	Returns the "current time" (as per the event loop).
717		499
…		…
760		542
761	=item $rend = urxvt::OVERLAY_RSTYLE	543	=item $rend = urxvt::OVERLAY_RSTYLE
762		544
763	Return the rendition mask used for overlays by default.	545	Return the rendition mask used for overlays by default.
764		546
765	=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
766		549
767	Return the bit that enabled bold, italic, blink, reverse-video and	550	Return the bit that enabled bold, italic, blink, reverse-video and
768	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
769	the bitset.	552	the bitset.
770		553
…		…
807	};	590	};
808	}	591	}
809		592
810	no warnings 'utf8';	593	no warnings 'utf8';
811		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
812	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	655	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
813		656
814	sub verbose {	657	sub verbose {
815	my ($level, $msg) = @_;	658	my ($level, $msg) = @_;
816	warn "$msg\n" if $level <= $verbosity;	659	warn "$msg\n" if $level <= $verbosity;
…		…
828	$pkg =~ s/[^[:word:]]/_/g;	671	$pkg =~ s/[^[:word:]]/_/g;
829	$pkg = "urxvt::ext::$pkg";	672	$pkg = "urxvt::ext::$pkg";
830		673
831	verbose 3, "loading extension '$path' into package '$pkg'";	674	verbose 3, "loading extension '$path' into package '$pkg'";
832		675
		676	(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
		677
833	open my $fh, "<:raw", $path	678	open my $fh, "<:raw", $path
834	or die "$path: $!";	679	or die "$path: $!";
835		680
836	my $source =	681	my $source =
837	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"	682	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
838	. "#line 1 \"$path\"\n{\n"	683	. "#line 1 \"$path\"\n{\n"
839	. (do { local $/; <$fh> })	684	. (do { local $/; <$fh> })
840	. "\n};\n1";	685	. "\n};\n1";
841		686
842	eval $source	687	eval $source
…		…
852	sub invoke {	697	sub invoke {
853	local $TERM = shift;	698	local $TERM = shift;
854	my $htype = shift;	699	my $htype = shift;
855		700
856	if ($htype == 0) { # INIT	701	if ($htype == 0) { # INIT
857	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	702	my @dirs = $TERM->perl_libdirs;
858		703
859	my %ext_arg;	704	my %ext_arg;
860		705
861	{	706	{
862	my @init = @TERM_INIT;	707	my @init = @TERM_INIT;
863	@TERM_INIT = ();	708	@TERM_INIT = ();
…		…
865	my @pkg = @TERM_EXT;	710	my @pkg = @TERM_EXT;
866	@TERM_EXT = ();	711	@TERM_EXT = ();
867	$TERM->register_package ($_) for @pkg;	712	$TERM->register_package ($_) for @pkg;
868	}	713	}
869		714
		715	for (
		716	@{ delete $TERM->{perl_ext_3} },
870	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	717	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		718	) {
871	if ($_ eq "default") {	719	if ($_ eq "default") {
872	$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);
873	} elsif (/^-(.*)$/) {	721	} elsif (/^-(.*)$/) {
874	delete $ext_arg{$1};	722	delete $ext_arg{$1};
875	} elsif (/^([^<]+)<(.*)>$/) {	723	} elsif (/^([^<]+)<(.*)>$/) {
…		…
897		745
898	if (my $cb = $TERM->{_hook}[$htype]) {	746	if (my $cb = $TERM->{_hook}[$htype]) {
899	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
900	if $verbosity >= 10;	748	if $verbosity >= 10;
901		749
902	keys %$cb;	750	for my $pkg (keys %$cb) {
903
904	while (my ($pkg, $cb) = each %$cb) {
905	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
906	$retval ||= $retval_;	752	$retval ||= $retval_;
907		753
908	if ($@) {	754	if ($@) {
909	$TERM->ungrab; # better to lose the grab than the session	755	$TERM->ungrab; # better to lose the grab than the session
910	warn $@;	756	warn $@;
…		…
928		774
929	sub SET_COLOR($$$) {	775	sub SET_COLOR($$$) {
930	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	776	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
931	}	777	}
932		778
933	# 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	}
934		803
935	package urxvt::term::extension;	804	package urxvt::term::extension;
936		805
937	sub enable {	806	sub enable {
938	my ($self, %hook) = @_;	807	my ($self, %hook) = @_;
…		…
993		862
994	sub urxvt::destroy_hook(&) {	863	sub urxvt::destroy_hook(&) {
995	bless \shift, urxvt::destroy_hook::	864	bless \shift, urxvt::destroy_hook::
996	}	865	}
997		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
998	package urxvt::anyevent;	879	package urxvt::anyevent;
999		880
1000	=head2 The C<urxvt::anyevent> Class	881	=head2 The C<urxvt::anyevent> Class
1001		882
1002	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
1003	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
1004	further programming. The only exception is that you cannot wait on	885	further programming. The only exception is that you cannot wait on
1005	condition variables, but non-blocking condvar use is ok. What this means	886	condition variables, but non-blocking condvar use is ok.
1006	is that you cannot use blocking APIs, but the non-blocking variant should	887
1007	work.	888	In practical terms this means is that you cannot use blocking APIs, but
		889	the non-blocking variant should work.
1008		890
1009	=cut	891	=cut
1010		892
1011	our $VERSION = 1;	893	our $VERSION = '5.23';
1012		894
1013	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	895	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1014	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	896	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1015		897
1016	sub timer {	898	sub timer {
…		…
1018		900
1019	my $cb = $arg{cb};	901	my $cb = $arg{cb};
1020		902
1021	urxvt::timer	903	urxvt::timer
1022	->new	904	->new
1023	->start (urxvt::NOW + $arg{after})	905	->after ($arg{after}, $arg{interval})
1024	->cb (sub {	906	->cb ($arg{interval} ? $cb : sub {
1025	$_[0]->stop; # need to cancel manually	907	$_[0]->stop; # need to cancel manually
1026	$cb->();	908	$cb->();
1027	})	909	})
1028	}	910	}
1029		911
1030	sub io {	912	sub io {
1031	my ($class, %arg) = @_;	913	my ($class, %arg) = @_;
1032		914
1033	my $cb = $arg{cb};	915	my $cb = $arg{cb};
		916	my $fd = fileno $arg{fh};
		917	defined $fd or $fd = $arg{fh};
1034		918
1035	bless [$arg{fh}, urxvt::iow	919	bless [$arg{fh}, urxvt::iow
1036	->new	920	->new
1037	->fd (fileno $arg{fh})	921	->fd ($fd)
1038	->events (($arg{poll} =~ /r/ ? 1 : 0)	922	->events (($arg{poll} =~ /r/ ? 1 : 0)
1039	| ($arg{poll} =~ /w/ ? 2 : 0))	923	| ($arg{poll} =~ /w/ ? 2 : 0))
1040	->start	924	->start
1041	->cb (sub {	925	->cb ($cb)
1042	$cb->(($_[1] & 1 ? 'r' : '')
1043	. ($_[1] & 2 ? 'w' : ''));
1044	})],
1045	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	})
1046	}	952	}
1047		953
1048	sub DESTROY {	954	sub DESTROY {
1049	$_[0][1]->stop;	955	$_[0][1]->stop;
1050	}	956	}
1051		957
1052	sub condvar {	958	# only needed for AnyEvent < 6 compatibility
1053	bless \my $flag, urxvt::anyevent::condvar::	959	sub one_event {
1054	}
1055
1056	sub urxvt::anyevent::condvar::broadcast {
1057	${$_[0]}++;
1058	}
1059
1060	sub urxvt::anyevent::condvar::wait {
1061	unless (${$_[0]}) {
1062	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	960	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1063	}
1064	}	961	}
1065		962
1066	package urxvt::term;	963	package urxvt::term;
1067		964
1068	=head2 The C<urxvt::term> Class	965	=head2 The C<urxvt::term> Class
…		…
1081	urxvt::verbose 6, "register package $pkg to $self";	978	urxvt::verbose 6, "register package $pkg to $self";
1082		979
1083	@{"$pkg\::ISA"} = urxvt::term::extension::;	980	@{"$pkg\::ISA"} = urxvt::term::extension::;
1084		981
1085	my $proxy = bless {	982	my $proxy = bless {
1086	_pkg => $pkg,	983	_pkg => $pkg,
		984	_name => ${"$pkg\::_NAME"}, # hackish
1087	argv => $argv,	985	argv => $argv,
1088	}, $pkg;	986	}, $pkg;
1089	Scalar::Util::weaken ($proxy->{term} = $self);	987	Scalar::Util::weaken ($proxy->{term} = $self);
1090		988
1091	$self->{_pkg}{$pkg} = $proxy;	989	$self->{_pkg}{$pkg} = $proxy;
1092		990
…		…
1095	$proxy->enable ($name => $ref);	993	$proxy->enable ($name => $ref);
1096	}	994	}
1097	}	995	}
1098	}	996	}
1099		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
1100	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1045	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1101		1046
1102	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
1103	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
1104	hash which defines the environment of the new terminal.	1049	hash which defines the environment of the new terminal.
…		…
1124		1069
1125	Destroy the terminal object (close the window, free resources	1070	Destroy the terminal object (close the window, free resources
1126	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
1127	watchers (timers, io watchers) are still active.	1072	watchers (timers, io watchers) are still active.
1128		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 givne 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 paramaters, 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
1129	=item $term->exec_async ($cmd[, @args])	1117	=item $term->exec_async ($cmd[, @args])
1130		1118
1131	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
1132	("starts") programs in the background. This function takes care of setting	1120	("starts") programs in the background. This function takes care of setting
1133	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
…		…
1155		1143
1156	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
1157	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
1158	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.
1159		1147
1160	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
1161	source file F</src/optinc.h> to see the actual list:	1149	source file F</src/optinc.h> to see the actual list:
1162		1150
1163	borderLess console cursorBlink cursorUnderline hold iconic insecure	1151	borderLess buffered console cursorBlink cursorUnderline hold iconic
1164	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1152	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1165	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1153	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1166	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1154	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1167	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1155	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1168	transparent tripleclickwords utmpInhibit visualBell	1156	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1157	urgentOnBell utmpInhibit visualBell
1169		1158
1170	=item $value = $term->resource ($name[, $newval])	1159	=item $value = $term->resource ($name[, $newval])
1171		1160
1172	Returns the current resource value associated with a given name and	1161	Returns the current resource value associated with a given name and
1173	optionally sets a new value. Setting values is most useful in the C<init>	1162	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1182	likely change).	1171	likely change).
1183		1172
1184	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
1185	terminal is destroyed, so changing options frequently will eat memory.	1174	terminal is destroyed, so changing options frequently will eat memory.
1186		1175
1187	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
1188	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>
1189	to see the actual list:	1178	to see the actual list:
1190		1179
1191	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1180	answerbackstring backgroundPixmap backspace_key blurradius
1192	borderLess color cursorBlink cursorUnderline cutchars delete_key	1181	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1193	display_name embed ext_bwidth fade font geometry hold iconName	1182	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1194	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
1195	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1185	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1196	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1186	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1197	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1187	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1198	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1188	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1199	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1189	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1200	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1190	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1201	secondaryScreen secondaryScroll selectstyle shade term_name title	1191	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1202	transient_for transparent transparent_all tripleclickwords utmpInhibit	1192	term_name title transient_for transparent tripleclickwords urgentOnBell
1203	visualBell	1193	utmpInhibit visualBell
1204		1194
1205	=cut	1195	=cut
1206		1196
1207	sub resource($$;$) {	1197	sub resource($$;$) {
1208	my ($self, $name) = (shift, shift);	1198	my ($self, $name) = (shift, shift);
1209	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1199	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1210	&urxvt::term::_resource	1200	goto &urxvt::term::_resource
1211	}	1201	}
1212		1202
1213	=item $value = $term->x_resource ($pattern)	1203	=item $value = $term->x_resource ($pattern)
1214		1204
1215	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
1216	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
1217	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
1218	resource with that pattern exists.	1208	resource with that pattern exists.
1219		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
1220	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
1221	only one resource database per display, and later invocations might return	1221	only one resource database per display, and later invocations might return
1222	the wrong resources.	1222	the wrong resources.
1223		1223
1224	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1224	=item $value = $term->x_resource_boolean ($pattern)
1225		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
1226	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
1227	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.
1228		1251
1229	=item $rend = $term->rstyle ([$new_rstyle])	1252	=item $rend = $term->rstyle ([$new_rstyle])
1230		1253
1231	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
1232	the terminal application will use this style.	1255	the terminal application will use this style.
…		…
1240		1263
1241	=item ($row, $col) = $term->selection_beg ([$row, $col])	1264	=item ($row, $col) = $term->selection_beg ([$row, $col])
1242		1265
1243	=item ($row, $col) = $term->selection_end ([$row, $col])	1266	=item ($row, $col) = $term->selection_end ([$row, $col])
1244		1267
1245	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.
1246	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.
1247		1277
1248	=item $term->selection_make ($eventtime[, $rectangular])	1278	=item $term->selection_make ($eventtime[, $rectangular])
1249		1279
1250	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
1251	C<selection_end>. If C<$rectangular> is true (default: false), a	1281	C<selection_end>. If C<$rectangular> is true (default: false), a
1252	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
1253	a selection.	1283	a selection.
1254		1284
1255	=item $success = $term->selection_grab ($eventtime)	1285	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1256		1286
1257	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
1258	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
1259	is mostly useful from within C<on_sel_grab> hooks.	1290	is mostly useful from within C<on_sel_grab> hooks.
1260		1291
1261	=item $oldtext = $term->selection ([$newtext])	1292	=item $oldtext = $term->selection ([$newtext, $clipboard])
1262		1293
1263	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.
1264		1300
1265	=item $term->overlay_simple ($x, $y, $text)	1301	=item $term->overlay_simple ($x, $y, $text)
1266		1302
1267	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.
1268		1304
…		…
1298		1334
1299	The methods currently supported on C<urxvt::overlay> objects are:	1335	The methods currently supported on C<urxvt::overlay> objects are:
1300		1336
1301	=over 4	1337	=over 4
1302		1338
1303	=item $overlay->set ($x, $y, $text, $rend)	1339	=item $overlay->set ($x, $y, $text[, $rend])
1304		1340
1305	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
1306	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
1307	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.
1308		1346
1309	=item $overlay->hide	1347	=item $overlay->hide
1310		1348
1311	If visible, hide the overlay, but do not destroy it.	1349	If visible, hide the overlay, but do not destroy it.
1312		1350
…		…
1394	locale-specific encoding of the terminal and can contain command sequences	1432	locale-specific encoding of the terminal and can contain command sequences
1395	(escape codes) that will be interpreted.	1433	(escape codes) that will be interpreted.
1396		1434
1397	=item $term->tt_write ($octets)	1435	=item $term->tt_write ($octets)
1398		1436
1399	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
1400	pass characters instead of octets, you should convert your strings first	1438	pass characters instead of octets, you should convert your strings first
1401	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.
1402		1446
1403	=item $old_events = $term->pty_ev_events ([$new_events])	1447	=item $old_events = $term->pty_ev_events ([$new_events])
1404		1448
1405	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
1406	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
…		…
1425	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
1426	to receive pointer events all the times:	1470	to receive pointer events all the times:
1427		1471
1428	$term->vt_emask_add (urxvt::PointerMotionMask);	1472	$term->vt_emask_add (urxvt::PointerMotionMask);
1429		1473
		1474	=item $term->set_urgency ($set)
		1475
		1476	Enable/disable the urgency hint on the toplevel window.
		1477
1430	=item $term->focus_in	1478	=item $term->focus_in
1431		1479
1432	=item $term->focus_out	1480	=item $term->focus_out
1433		1481
1434	=item $term->key_press ($state, $keycode[, $time])	1482	=item $term->key_press ($state, $keycode[, $time])
…		…
1504		1552
1505	Returns the currently displayed screen (0 primary, 1 secondary).	1553	Returns the currently displayed screen (0 primary, 1 secondary).
1506		1554
1507	=item $cursor_is_hidden = $term->hidden_cursor	1555	=item $cursor_is_hidden = $term->hidden_cursor
1508		1556
1509	Returns wether the cursor is currently hidden or not.	1557	Returns whether the cursor is currently hidden or not.
1510		1558
1511	=item $view_start = $term->view_start ([$newvalue])	1559	=item $view_start = $term->view_start ([$newvalue])
1512		1560
1513	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
1514	C<0>, which displays the normal terminal contents. Lower values scroll	1562	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1522		1570
1523	Used after changing terminal contents to display them.	1571	Used after changing terminal contents to display them.
1524		1572
1525	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1573	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1526		1574
1527	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 >>
1528	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
1529	terminal line. The scrollback buffer starts at line C<-1> and extends to
1530	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1577	terminal line. Nothing will be returned if a nonexistent line
1531	is requested.	1578	is requested.
1532		1579
1533	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
1534	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
1535	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
1536	automatically be updated.	1583	automatically be updated.
1537		1584
1538	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
1539	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)
1540	characters. Characters with combining characters and other characters that	1587	characters. Characters with combining characters and other characters that
1541	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
1542	in the private use area.	1589	in the private use area.
1543		1590
1544	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
1545	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
1546	characters.	1593	characters.
…		…
1691	where one character corresponds to one screen cell. See	1738	where one character corresponds to one screen cell. See
1692	C<< $term->ROW_t >> for details.	1739	C<< $term->ROW_t >> for details.
1693		1740
1694	=item $string = $term->special_decode $text	1741	=item $string = $term->special_decode $text
1695		1742
1696	Converts rxvt-unicodes text reprsentation into a perl string. See	1743	Converts rxvt-unicodes text representation into a perl string. See
1697	C<< $term->ROW_t >> for details.	1744	C<< $term->ROW_t >> for details.
1698		1745
1699	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1746	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1700		1747
1701	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1748	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1704	manpage.	1751	manpage.
1705		1752
1706	=item $success = $term->grab ($eventtime[, $sync])	1753	=item $success = $term->grab ($eventtime[, $sync])
1707		1754
1708	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1755	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1709	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1756	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1710		1757
1711	=item $term->allow_events_async	1758	=item $term->allow_events_async
1712		1759
1713	Calls XAllowEvents with AsyncBoth for the most recent grab.	1760	Calls XAllowEvents with AsyncBoth for the most recent grab.
1714		1761
…		…
1721	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1768	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1722	recent grab.	1769	recent grab.
1723		1770
1724	=item $term->ungrab	1771	=item $term->ungrab
1725		1772
1726	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
1727	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
1728	the session.	1775	the session.
1729		1776
1730	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1777	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1731		1778
…		…
1733		1780
1734	=item @atoms = $term->XListProperties ($window)	1781	=item @atoms = $term->XListProperties ($window)
1735		1782
1736	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1783	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1737		1784
1738	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1785	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1739		1786
1740	=item $term->XDeleteProperty ($window, $property)	1787	=item $term->XDeleteProperty ($window, $property)
1741		1788
1742	=item $window = $term->DefaultRootWindow	1789	=item $window = $term->DefaultRootWindow
1743		1790
…		…
1750	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1797	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1751		1798
1752	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1799	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1753		1800
1754	=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)
1755		1806
1756	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
1757	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
1758	directory onto the X functions of the same name.	1809	directly onto the X functions of the same name.
1759		1810
1760	=back	1811	=back
1761		1812
1762	=cut	1813	=cut
1763		1814
…		…
1865	my $env = $self->{term}->env;	1916	my $env = $self->{term}->env;
1866	# 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.
1867	delete $env->{LC_ALL};	1918	delete $env->{LC_ALL};
1868	$env->{LC_CTYPE} = $self->{term}->locale;	1919	$env->{LC_CTYPE} = $self->{term}->locale;
1869		1920
1870	urxvt::term->new ($env, "popup",	1921	my $term = urxvt::term->new (
		1922	$env, "popup",
1871	"--perl-lib" => "", "--perl-ext-common" => "",	1923	"--perl-lib" => "", "--perl-ext-common" => "",
1872	"-pty-fd" => -1, "-sl" => 0,	1924	"-pty-fd" => -1, "-sl" => 0,
1873	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	1925	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1874	"--transient-for" => $self->{term}->parent,	1926	"--transient-for" => $self->{term}->parent,
1875	"-display" => $self->{term}->display_id,	1927	"-display" => $self->{term}->display_id,
1876	"-pe" => "urxvt-popup")	1928	"-pe" => "urxvt-popup",
1877	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	}
1878	}	1936	}
1879		1937
1880	sub DESTROY {	1938	sub DESTROY {
1881	my ($self) = @_;	1939	my ($self) = @_;
1882		1940
…		…
1887	=back	1945	=back
1888		1946
1889	=cut	1947	=cut
1890		1948
1891	package urxvt::watcher;	1949	package urxvt::watcher;
1892
1893	@urxvt::timer::ISA = __PACKAGE__;
1894	@urxvt::iow::ISA = __PACKAGE__;
1895	@urxvt::pw::ISA = __PACKAGE__;
1896	@urxvt::iw::ISA = __PACKAGE__;
1897		1950
1898	=head2 The C<urxvt::timer> Class	1951	=head2 The C<urxvt::timer> Class
1899		1952
1900	This class implements timer watchers/events. Time is represented as a	1953	This class implements timer watchers/events. Time is represented as a
1901	fractional number of seconds since the epoch. Example:	1954	fractional number of seconds since the epoch. Example:
…		…
1905	->new	1958	->new
1906	->interval (1)	1959	->interval (1)
1907	->cb (sub {	1960	->cb (sub {
1908	$term->{overlay}->set (0, 0,	1961	$term->{overlay}->set (0, 0,
1909	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1962	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1910	});	1963	});
1911		1964
1912	=over 4	1965	=over 4
1913		1966
1914	=item $timer = new urxvt::timer	1967	=item $timer = new urxvt::timer
1915		1968
…		…
1918		1971
1919	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1972	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1920		1973
1921	Set the callback to be called when the timer triggers.	1974	Set the callback to be called when the timer triggers.
1922		1975
1923	=item $tstamp = $timer->at
1924
1925	Return the time this watcher will fire next.
1926
1927	=item $timer = $timer->set ($tstamp)	1976	=item $timer = $timer->set ($tstamp[, $interval])
1928		1977
1929	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).
1930		1980
1931	=item $timer = $timer->interval ($interval)	1981	=item $timer = $timer->interval ($interval)
1932		1982
1933	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
1934	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
1935	is automatically rescheduled at the given intervals.	1985	is automatically rescheduled at the given intervals.
1936		1986
1937	=item $timer = $timer->start	1987	=item $timer = $timer->start
1938		1988
1939	Start the timer.	1989	Start the timer.
1940		1990
1941	=item $timer = $timer->start ($tstamp)	1991	=item $timer = $timer->start ($tstamp[, $interval])
1942		1992
1943	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.
1944		1995
1945	=item $timer = $timer->after ($delay)	1996	=item $timer = $timer->after ($delay[, $interval])
1946		1997
1947	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>.
1948		1999
1949	=item $timer = $timer->stop	2000	=item $timer = $timer->stop
1950		2001
…		…
1958		2009
1959	$term->{socket} = ...	2010	$term->{socket} = ...
1960	$term->{iow} = urxvt::iow	2011	$term->{iow} = urxvt::iow
1961	->new	2012	->new
1962	->fd (fileno $term->{socket})	2013	->fd (fileno $term->{socket})
1963	->events (urxvt::EVENT_READ)	2014	->events (urxvt::EV_READ)
1964	->start	2015	->start
1965	->cb (sub {	2016	->cb (sub {
1966	my ($iow, $revents) = @_;	2017	my ($iow, $revents) = @_;
1967	# $revents must be 1 here, no need to check	2018	# $revents must be 1 here, no need to check
1968	sysread $term->{socket}, my $buf, 8192	2019	sysread $term->{socket}, my $buf, 8192
…		…
1981	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>
1982	is a bitset as described in the C<events> method.	2033	is a bitset as described in the C<events> method.
1983		2034
1984	=item $iow = $iow->fd ($fd)	2035	=item $iow = $iow->fd ($fd)
1985		2036
1986	Set the filedescriptor (not handle) to watch.	2037	Set the file descriptor (not handle) to watch.
1987		2038
1988	=item $iow = $iow->events ($eventmask)	2039	=item $iow = $iow->events ($eventmask)
1989		2040
1990	Set the event mask to watch. The only allowed values are	2041	Set the event mask to watch. The only allowed values are
1991	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
1992	together, or C<urxvt::EVENT_NONE>.	2043	together, or C<urxvt::EV_NONE>.
1993		2044
1994	=item $iow = $iow->start	2045	=item $iow = $iow->start
1995		2046
1996	Start watching for requested events on the given handle.	2047	Start watching for requested events on the given handle.
1997		2048
1998	=item $iow = $iow->stop	2049	=item $iow = $iow->stop
1999		2050
2000	Stop watching for events on the given filehandle.	2051	Stop watching for events on the given file handle.
2001		2052
2002	=back	2053	=back
2003		2054
2004	=head2 The C<urxvt::iw> Class	2055	=head2 The C<urxvt::iw> Class
2005		2056
…		…
2038	->new	2089	->new
2039	->start ($pid)	2090	->start ($pid)
2040	->cb (sub {	2091	->cb (sub {
2041	my ($pw, $exit_status) = @_;	2092	my ($pw, $exit_status) = @_;
2042	...	2093	...
2043	});	2094	});
2044		2095
2045	=over 4	2096	=over 4
2046		2097
2047	=item $pw = new urxvt::pw	2098	=item $pw = new urxvt::pw
2048		2099
…		…
2052		2103
2053	Set the callback to be called when the timer triggers.	2104	Set the callback to be called when the timer triggers.
2054		2105
2055	=item $pw = $timer->start ($pid)	2106	=item $pw = $timer->start ($pid)
2056		2107
2057	Tells the wqtcher to start watching for process C<$pid>.	2108	Tells the watcher to start watching for process C<$pid>.
2058		2109
2059	=item $pw = $pw->stop	2110	=item $pw = $pw->stop
2060		2111
2061	Stop the watcher.	2112	Stop the watcher.
2062		2113
…		…
2075		2126
2076	=item >= 3 - script loading and management	2127	=item >= 3 - script loading and management
2077		2128
2078	=item >=10 - all called hooks	2129	=item >=10 - all called hooks
2079		2130
2080	=item >=11 - hook reutrn values	2131	=item >=11 - hook return values
2081		2132
2082	=back	2133	=back
2083		2134
2084	=head1 AUTHOR	2135	=head1 AUTHOR
2085		2136
2086	Marc Lehmann <pcg@goof.com>	2137	Marc Lehmann <schmorp@schmorp.de>
2087	http://software.schmorp.de/pkg/rxvt-unicode	2138	http://software.schmorp.de/pkg/rxvt-unicode
2088		2139
2089	=cut	2140	=cut
2090		2141
2091	1	2142	1
		2143
		2144	# vim: sw=3:

Diff Legend

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