[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.131 by root, Sun Jan 29 20:51:28 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 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' 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	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	The index number (0, 1...) must not have any holes, and each regex must	68	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	69	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	70	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:	71	between two vertical bars:
69		72
70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
71		74
72	Another example: Programs I use often output "absolute path: " at the	75	Another example: Programs I use often output "absolute path: " at the
…		…
94	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
95		98
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.	100	runtime.
98		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
99	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
100		120
101	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
102	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
103	evaluation, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
104		124
105	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107	popup is displayed.	127	popup is being displayed.
108		128
109	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
110	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
111	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
112	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
113	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
114		134
115	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
116	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
117	C<a>s:	137	C<a>s:
118		138
119	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
120	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
121	: ()	141	: ()
122	};	142	};
123		143
124	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
125		145
…		…
132	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
133	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
134	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
135	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
136	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
137	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
138		164
139	=item readline (enabled by default)	165	=item readline (enabled by default)
140		166
141	A support package that tries to make editing with readline easier. At the	167	A support package that tries to make editing with readline easier. At
142	moment, it reacts to clicking with the left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
143	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
144	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
145	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
146		172
147	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
148		174
149	=over 4	175	=over 4
…		…
197	the message into vi commands to load the file.	223	the message into vi commands to load the file.
198		224
199	=item tabbed	225	=item tabbed
200		226
201	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204	button per tab.	230	button per tab.
205		231
206	Clicking a button will activate that tab. Pressing B<Shift-Left> and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
207	B<Shift-Right> will switch to the tab left or right of the current one,	233	B<Shift-Right> will switch to the tab left or right of the current one,
208	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
209		235
210	=item mark-urls	236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
211		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
212	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
213	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
214	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
215	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
216		276
217	=item xim-onthespot	277	=item xim-onthespot
218		278
219	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
220	not work perfectly, and some input methods don't seem to work well with	280	not work perfectly, and some input methods don't seem to work well with
221	OnTheSpot editing in general, but it seems to work at leats for SCIM and	281	OnTheSpot editing in general, but it seems to work at least for SCIM and
222	kinput2.	282	kinput2.
223		283
224	You enable it by specifying this extension and a preedit style of	284	You enable it by specifying this extension and a preedit style of
225	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
226		286
227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
228		288
229	=item automove-background	289	=item kuake<hotkey>
230		290
231	This is basically a one-line extension that dynamically changes the background pixmap offset	291	A very primitive quake-console-like extension. It was inspired by a
232	to the window position, in effect creating the same effect as pseudo transparency with	292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
233	a custom pixmap. No scaling is supported in this mode. Exmaple:	293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
234		296
235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
236		313
237	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
238		315
239	A not very useful example of filtering all text output to the terminal,	316	A not very useful example of filtering all text output to the terminal
240	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
241	similar-looking ascii character.	318	similar-looking ascii character.
242		319
243	=item digital-clock	320	=item digital-clock
244		321
245	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
246		323
247	=item remote-clipboard	324	=item remote-clipboard
248		325
249	Somewhat of a misnomer, this extension adds two menu entries to the	326	Somewhat of a misnomer, this extension adds two menu entries to the
250	selection popup that allows one ti run external commands to store the	327	selection popup that allows one to run external commands to store the
251	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
252		329
253	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
254	means that one command uploads the file to a remote server, and another	331	means that one command uploads the file to a remote server, and another
255	reads it.	332	reads it.
…		…
264	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
265	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
266		343
267	=item selection-pastebin	344	=item selection-pastebin
268		345
269	This is a little rarely useful extension that Uploads the selection as	346	This is a little rarely useful extension that uploads the selection as
270	textfile to a remote site (or does other things). (The implementation is	347	textfile to a remote site (or does other things). (The implementation is
271	not currently secure for use in a multiuser environment as it writes to	348	not currently secure for use in a multiuser environment as it writes to
272	F</tmp> directly.).	349	F</tmp> directly.).
273		350
274	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
291	in the C<selection-pastebin-url> resource (again, the % is the placeholder	368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
292	for the filename):	369	for the filename):
293		370
294	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
295		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of whether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
		391
296	=item example-refresh-hooks	392	=item example-refresh-hooks
297		393
298	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
299	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
300	overlays or changes.	396	overlays or changes.
		397
		398	=item confirm-paste
		399
		400	Displays a confirmation dialog when a paste containing at least a full
		401	line is detected.
301		402
302	=back	403	=back
303		404
304	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
305		406
…		…
321		422
322	=over 4	423	=over 4
323		424
324	=item $text	425	=item $text
325		426
326	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
327	always represents one screen cell. See L<ROW_t> for a discussion of this format.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
328		429
329	=item $string	430	=item $string
330		431
331	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
339		440
340	=back	441	=back
341		442
342	=head2 Extension Objects	443	=head2 Extension Objects
343		444
344	Very perl extension is a perl class. A separate perl object is created	445	Every perl extension is a perl class. A separate perl object is created
345	for each terminal and each extension and passed as the first parameter to	446	for each terminal, and each terminal has its own set of extenion objects,
346	hooks. So extensions can use their C<$self> object without having to think	447	which are passed as the first parameter to hooks. So extensions can use
347	about other extensions, with the exception of methods and members that	448	their C<$self> object without having to think about clashes with other
		449	extensions or other terminals, with the exception of methods and members
348	begin with an underscore character C<_>: these are reserved for internal	450	that begin with an underscore character C<_>: these are reserved for
349	use.	451	internal use.
350		452
351	Although it isn't a C<urxvt::term> object, you can call all methods of the	453	Although it isn't a C<urxvt::term> object, you can call all methods of the
352	C<urxvt::term> class on this object.	454	C<urxvt::term> class on this object.
353		455
354	It has the following methods and data members:	456	It has the following methods and data members:
…		…
375	=head2 Hooks	477	=head2 Hooks
376		478
377	The following subroutines can be declared in extension files, and will be	479	The following subroutines can be declared in extension files, and will be
378	called whenever the relevant event happens.	480	called whenever the relevant event happens.
379		481
380	The first argument passed to them is an extension oject as described in	482	The first argument passed to them is an extension object as described in
381	the in the C<Extension Objects> section.	483	the in the C<Extension Objects> section.
382		484
383	B<All> of these hooks must return a boolean value. If any of the called	485	B<All> of these hooks must return a boolean value. If any of the called
384	hooks returns true, then the event counts as being I<consumed>, and the	486	hooks returns true, then the event counts as being I<consumed>, and the
385	relevant action might not be carried out by the C++ code.	487	relevant action might not be carried out by the C++ code.
…		…
398	place.	500	place.
399		501
400	=item on_start $term	502	=item on_start $term
401		503
402	Called at the very end of initialisation of a new terminal, just before	504	Called at the very end of initialisation of a new terminal, just before
403	trying to map (display) the toplevel and returning to the mainloop.	505	trying to map (display) the toplevel and returning to the main loop.
404		506
405	=item on_destroy $term	507	=item on_destroy $term
406		508
407	Called whenever something tries to destroy terminal, when the terminal is	509	Called whenever something tries to destroy terminal, when the terminal is
408	still fully functional (not for long, though).	510	still fully functional (not for long, though).
…		…
435		537
436	Called whenever a selection has been copied, but before the selection is	538	Called whenever a selection has been copied, but before the selection is
437	requested from the server. The selection text can be queried and changed	539	requested from the server. The selection text can be queried and changed
438	by calling C<< $term->selection >>.	540	by calling C<< $term->selection >>.
439		541
440	Returning a true value aborts selection grabbing. It will still be hilighted.	542	Returning a true value aborts selection grabbing. It will still be highlighted.
441		543
442	=item on_sel_extend $term	544	=item on_sel_extend $term
443		545
444	Called whenever the user tries to extend the selection (e.g. with a double	546	Called whenever the user tries to extend the selection (e.g. with a double
445	click) and is either supposed to return false (normal operation), or	547	click) and is either supposed to return false (normal operation), or
446	should extend the selection itelf and return true to suppress the built-in	548	should extend the selection itself and return true to suppress the built-in
447	processing. This can happen multiple times, as long as the callback	549	processing. This can happen multiple times, as long as the callback
448	returns true, it will be called on every further click by the user and is	550	returns true, it will be called on every further click by the user and is
449	supposed to enlarge the selection more and more, if possible.	551	supposed to enlarge the selection more and more, if possible.
450		552
451	See the F<selection> example extension.	553	See the F<selection> example extension.
452		554
453	=item on_view_change $term, $offset	555	=item on_view_change $term, $offset
454		556
455	Called whenever the view offset changes, i..e the user or program	557	Called whenever the view offset changes, i.e. the user or program
456	scrolls. Offset C<0> means display the normal terminal, positive values	558	scrolls. Offset C<0> means display the normal terminal, positive values
457	show this many lines of scrollback.	559	show this many lines of scrollback.
458		560
459	=item on_scroll_back $term, $lines, $saved	561	=item on_scroll_back $term, $lines, $saved
460		562
…		…
464		566
465	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	567	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
466	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	568	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
467	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
468		570
469	=item on_osc_seq $term, $string	571	=item on_osc_seq $term, $op, $args, $resp
		572
		573	Called on every OSC sequence and can be used to suppress it or modify its
		574	behaviour. The default should be to return an empty list. A true value
		575	suppresses execution of the request completely. Make sure you don't get
		576	confused by recursive invocations when you output an OSC sequence within
		577	this callback.
		578
		579	C<on_osc_seq_perl> should be used for new behaviour.
		580
		581	=item on_osc_seq_perl $term, $args, $resp
470		582
471	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
472	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
473	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
474	string should start with the extension name and a colon, to distinguish	586	string should start with the extension name (sans -osc) and a semicolon,
475	it from commands for other extensions, and this might be enforced in the	587	to distinguish it from commands for other extensions, and this might be
476	future.	588	enforced in the future.
		589
		590	For example, C<overlay-osc> uses this:
		591
		592	sub on_osc_seq_perl {
		593	my ($self, $osc, $resp) = @_;
		594
		595	return unless $osc =~ s/^overlay;//;
		596
		597	... process remaining $osc string
		598	}
477		599
478	Be careful not ever to trust (in a security sense) the data you receive,	600	Be careful not ever to trust (in a security sense) the data you receive,
479	as its source can not easily be controleld (e-mail content, messages from	601	as its source can not easily be controlled (e-mail content, messages from
480	other users on the same system etc.).	602	other users on the same system etc.).
		603
		604	For responses, C<$resp> contains the end-of-args separator used by the
		605	sender.
481		606
482	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
483		608
484	Called whenever text is about to be output, with the text as argument. You	609	Called whenever text is about to be output, with the text as argument. You
485	can filter/change and output the text yourself by returning a true value	610	can filter/change and output the text yourself by returning a true value
…		…
490	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
491		616
492	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
493	suppress or filter tty input.	618	suppress or filter tty input.
494		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
495	=item on_line_update $term, $row	627	=item on_line_update $term, $row
496		628
497	Called whenever a line was updated or changed. Can be used to filter	629	Called whenever a line was updated or changed. Can be used to filter
498	screen output (e.g. underline urls or other useless stuff). Only lines	630	screen output (e.g. underline urls or other useless stuff). Only lines
499	that are being shown will be filtered, and, due to performance reasons,	631	that are being shown will be filtered, and, due to performance reasons,
…		…
506	later with the already-modified line (e.g. if unrelated parts change), so	638	later with the already-modified line (e.g. if unrelated parts change), so
507	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
508		640
509	=item on_refresh_begin $term	641	=item on_refresh_begin $term
510		642
511	Called just before the screen gets redrawn. Can be used for overlay	643	Called just before the screen gets redrawn. Can be used for overlay or
512	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
513	restoring them in refresh_end. The built-in overlay and selection display	645	restoring them in refresh_end. The built-in overlay and selection display
514	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
515		647
516	=item on_refresh_end $term	648	=item on_refresh_end $term
517		649
518	Called just after the screen gets redrawn. See C<on_refresh_begin>.	650	Called just after the screen gets redrawn. See C<on_refresh_begin>.
519		651
520	=item on_user_command $term, $string	652	=item on_user_command $term, $string
521		653
522	Called whenever the a user-configured event is being activated (e.g. via	654	Called whenever a user-configured event is being activated (e.g. via
523	a C<perl:string> action bound to a key, see description of the B<keysym>	655	a C<perl:string> action bound to a key, see description of the B<keysym>
524	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
525		657
526	The event is simply the action string. This interface is assumed to change	658	The event is simply the action string. This interface is assumed to change
527	slightly in the future.	659	slightly in the future.
		660
		661	=item on_resize_all_windows $term, $new_width, $new_height
		662
		663	Called just after the new window size has been calculated, but before
		664	windows are actually being resized or hints are being set. If this hook
		665	returns TRUE, setting of the window hints is being skipped.
528		666
529	=item on_x_event $term, $event	667	=item on_x_event $term, $event
530		668
531	Called on every X event received on the vt window (and possibly other	669	Called on every X event received on the vt window (and possibly other
532	windows). Should only be used as a last resort. Most event structure	670	windows). Should only be used as a last resort. Most event structure
533	members are not passed.	671	members are not passed.
534		672
		673	=item on_root_event $term, $event
		674
		675	Like C<on_x_event>, but is called for events on the root window.
		676
535	=item on_focus_in $term	677	=item on_focus_in $term
536		678
537	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
538	does focus in processing.	680	does focus in processing.
539		681
540	=item on_focus_out $term	682	=item on_focus_out $term
541		683
542	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
543	focus out processing.	685	focus out processing.
544		686
545	=item on_configure_notify $term, $event	687	=item on_configure_notify $term, $event
546		688
547	=item on_property_notify $term, $event	689	=item on_property_notify $term, $event
…		…
558		700
559	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
560		702
561	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
562		704
563	Called whenever the corresponding X event is received for the terminal If	705	Called whenever the corresponding X event is received for the terminal. If
564	the hook returns true, then the even will be ignored by rxvt-unicode.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
565		707
566	The event is a hash with most values as named by Xlib (see the XEvent	708	The event is a hash with most values as named by Xlib (see the XEvent
567	manpage), with the additional members C<row> and C<col>, which are the	709	manpage), with the additional members C<row> and C<col>, which are the
568	(real, not screen-based) row and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
569		711
…		…
578		720
579	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
580		722
581	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
582	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
583		729
584	=back	730	=back
585		731
586	=cut	732	=cut
587		733
…		…
630	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
631	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
632		778
633	=item @urxvt::TERM_INIT	779	=item @urxvt::TERM_INIT
634		780
635	All coderefs in this array will be called as methods of the next newly	781	All code references in this array will be called as methods of the next newly
636	created C<urxvt::term> object (during the C<on_init> phase). The array	782	created C<urxvt::term> object (during the C<on_init> phase). The array
637	gets cleared before the codereferences that were in it are being executed,	783	gets cleared before the code references that were in it are being executed,
638	so coderefs can push themselves onto it again if they so desire.	784	so references can push themselves onto it again if they so desire.
639		785
640	This complements to the perl-eval commandline option, but gets executed	786	This complements to the perl-eval command line option, but gets executed
641	first.	787	first.
642		788
643	=item @urxvt::TERM_EXT	789	=item @urxvt::TERM_EXT
644		790
645	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	791	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
670	Messages have a size limit of 1023 bytes currently.	816	Messages have a size limit of 1023 bytes currently.
671		817
672	=item @terms = urxvt::termlist	818	=item @terms = urxvt::termlist
673		819
674	Returns all urxvt::term objects that exist in this process, regardless of	820	Returns all urxvt::term objects that exist in this process, regardless of
675	wether they are started, being destroyed etc., so be careful. Only term	821	whether they are started, being destroyed etc., so be careful. Only term
676	objects that have perl extensions attached will be returned (because there	822	objects that have perl extensions attached will be returned (because there
677	is no urxvt::term objet associated with others).	823	is no urxvt::term objet associated with others).
678		824
679	=item $time = urxvt::NOW	825	=item $time = urxvt::NOW
680		826
…		…
725		871
726	=item $rend = urxvt::OVERLAY_RSTYLE	872	=item $rend = urxvt::OVERLAY_RSTYLE
727		873
728	Return the rendition mask used for overlays by default.	874	Return the rendition mask used for overlays by default.
729		875
730	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	876	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		877	urxvt::RS_RVid, urxvt::RS_Uline
731		878
732	Return the bit that enabled bold, italic, blink, reverse-video and	879	Return the bit that enabled bold, italic, blink, reverse-video and
733	underline, respectively. To enable such a style, just logically OR it into	880	underline, respectively. To enable such a style, just logically OR it into
734	the bitset.	881	the bitset.
735		882
…		…
740	Return the foreground/background colour index, respectively.	887	Return the foreground/background colour index, respectively.
741		888
742	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	889	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
743		890
744	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	891	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		892
		893	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
745		894
746	Replace the foreground/background colour in the rendition mask with the	895	Replace the foreground/background colour in the rendition mask with the
747	specified one.	896	specified one.
748		897
749	=item $value = urxvt::GET_CUSTOM $rend	898	=item $value = urxvt::GET_CUSTOM $rend
…		…
816	local $TERM = shift;	965	local $TERM = shift;
817	my $htype = shift;	966	my $htype = shift;
818		967
819	if ($htype == 0) { # INIT	968	if ($htype == 0) { # INIT
820	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	969	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
821		970
822	my %ext_arg;	971	my %ext_arg;
823		972
824	{	973	{
825	my @init = @TERM_INIT;	974	my @init = @TERM_INIT;
826	@TERM_INIT = ();	975	@TERM_INIT = ();
…		…
840	} else {	989	} else {
841	$ext_arg{$_} \|\|= [];	990	$ext_arg{$_} \|\|= [];
842	}	991	}
843	}	992	}
844		993
845	while (my ($ext, $argv) = each %ext_arg) {	994	for my $ext (sort keys %ext_arg) {
846	my @files = grep -f $_, map "$_/$ext", @dirs;	995	my @files = grep -f $_, map "$_/$ext", @dirs;
847		996
848	if (@files) {	997	if (@files) {
849	$TERM->register_package (extension_package $files[0], $argv);	998	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
850	} else {	999	} else {
851	warn "perl extension '$ext' not found in perl library search path\n";	1000	warn "perl extension '$ext' not found in perl library search path\n";
852	}	1001	}
853	}	1002	}
854		1003
…		…
860		1009
861	if (my $cb = $TERM->{_hook}[$htype]) {	1010	if (my $cb = $TERM->{_hook}[$htype]) {
862	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1011	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
863	if $verbosity >= 10;	1012	if $verbosity >= 10;
864		1013
865	keys %$cb;	1014	for my $pkg (keys %$cb) {
866
867	while (my ($pkg, $cb) = each %$cb) {
868	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1015	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
869	$retval \|\|= $retval_;	1016	$retval \|\|= $retval_;
870		1017
871	if ($@) {	1018	if ($@) {
872	$TERM->ungrab; # better to lose the grab than the session	1019	$TERM->ungrab; # better to lose the grab than the session
873	warn $@;	1020	warn $@;
…		…
885	# clear package	1032	# clear package
886	%$TERM = ();	1033	%$TERM = ();
887	}	1034	}
888		1035
889	$retval	1036	$retval
		1037	}
		1038
		1039	sub SET_COLOR($$$) {
		1040	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1041	}
		1042
		1043	sub rend2mask {
		1044	no strict 'refs';
		1045	my ($str, $mask) = (@_, 0);
		1046	my %color = ( fg => undef, bg => undef );
		1047	my @failed;
		1048	for my $spec ( split /\s+/, $str ) {
		1049	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1050	$color{lc($1)} = $2;
		1051	} else {
		1052	my $neg = $spec =~ s/^[-^]//;
		1053	unless ( exists &{"RS_$spec"} ) {
		1054	push @failed, $spec;
		1055	next;
		1056	}
		1057	my $cur = &{"RS_$spec"};
		1058	if ( $neg ) {
		1059	$mask &= ~$cur;
		1060	} else {
		1061	$mask \|= $cur;
		1062	}
		1063	}
		1064	}
		1065	($mask, @color{qw(fg bg)}, \@failed)
890	}	1066	}
891		1067
892	# urxvt::term::extension	1068	# urxvt::term::extension
893		1069
894	package urxvt::term::extension;	1070	package urxvt::term::extension;
…		…
965	is that you cannot use blocking APIs, but the non-blocking variant should	1141	is that you cannot use blocking APIs, but the non-blocking variant should
966	work.	1142	work.
967		1143
968	=cut	1144	=cut
969		1145
970	our $VERSION = 1;	1146	our $VERSION = '5.23';
971		1147
972	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1148	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
973	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1149	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
974		1150
975	sub timer {	1151	sub timer {
…		…
977		1153
978	my $cb = $arg{cb};	1154	my $cb = $arg{cb};
979		1155
980	urxvt::timer	1156	urxvt::timer
981	->new	1157	->new
982	->start (urxvt::NOW + $arg{after})	1158	->after ($arg{after}, $arg{interval})
983	->cb (sub {	1159	->cb ($arg{interval} ? $cb : sub {
984	$_[0]->stop; # need to cancel manually	1160	$_[0]->stop; # need to cancel manually
985	$cb->();	1161	$cb->();
986	})	1162	})
987	}	1163	}
988		1164
989	sub io {	1165	sub io {
990	my ($class, %arg) = @_;	1166	my ($class, %arg) = @_;
991		1167
992	my $cb = $arg{cb};	1168	my $cb = $arg{cb};
		1169	my $fd = fileno $arg{fh};
		1170	defined $fd or $fd = $arg{fh};
993		1171
994	bless [$arg{fh}, urxvt::iow	1172	bless [$arg{fh}, urxvt::iow
995	->new	1173	->new
996	->fd (fileno $arg{fh})	1174	->fd ($fd)
997	->events (($arg{poll} =~ /r/ ? 1 : 0)	1175	->events (($arg{poll} =~ /r/ ? 1 : 0)
998	\| ($arg{poll} =~ /w/ ? 2 : 0))	1176	\| ($arg{poll} =~ /w/ ? 2 : 0))
999	->start	1177	->start
1000	->cb (sub {	1178	->cb ($cb)
1001	$cb->(($_[1] & 1 ? 'r' : '')
1002	. ($_[1] & 2 ? 'w' : ''));
1003	})],
1004	urxvt::anyevent::	1179	], urxvt::anyevent::
		1180	}
		1181
		1182	sub idle {
		1183	my ($class, %arg) = @_;
		1184
		1185	my $cb = $arg{cb};
		1186
		1187	urxvt::iw
		1188	->new
		1189	->start
		1190	->cb ($cb)
		1191	}
		1192
		1193	sub child {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::pw
		1199	->new
		1200	->start ($arg{pid})
		1201	->cb (sub {
		1202	$_[0]->stop; # need to cancel manually
		1203	$cb->($_[0]->rpid, $_[0]->rstatus);
		1204	})
1005	}	1205	}
1006		1206
1007	sub DESTROY {	1207	sub DESTROY {
1008	$_[0][1]->stop;	1208	$_[0][1]->stop;
1009	}	1209	}
1010		1210
1011	sub condvar {	1211	sub one_event {
1012	bless \my $flag, urxvt::anyevent::condvar::
1013	}
1014
1015	sub urxvt::anyevent::condvar::broadcast {
1016	${$_[0]}++;
1017	}
1018
1019	sub urxvt::anyevent::condvar::wait {
1020	unless (${$_[0]}) {
1021	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1212	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1022	}
1023	}	1213	}
1024		1214
1025	package urxvt::term;	1215	package urxvt::term;
1026		1216
1027	=head2 The C<urxvt::term> Class	1217	=head2 The C<urxvt::term> Class
…		…
1114		1304
1115	Returns true if the option specified by C<$optval> is enabled, and	1305	Returns true if the option specified by C<$optval> is enabled, and
1116	optionally change it. All option values are stored by name in the hash	1306	optionally change it. All option values are stored by name in the hash
1117	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1307	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1118		1308
1119	Here is a a likely non-exhaustive list of option names, please see the	1309	Here is a likely non-exhaustive list of option names, please see the
1120	source file F</src/optinc.h> to see the actual list:	1310	source file F</src/optinc.h> to see the actual list:
1121		1311
1122	borderLess console cursorBlink cursorUnderline hold iconic insecure	1312	borderLess console cursorBlink cursorUnderline hold iconic insecure
1123	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1313	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1124	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1314	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1141	likely change).	1331	likely change).
1142		1332
1143	Please note that resource strings will currently only be freed when the	1333	Please note that resource strings will currently only be freed when the
1144	terminal is destroyed, so changing options frequently will eat memory.	1334	terminal is destroyed, so changing options frequently will eat memory.
1145		1335
1146	Here is a a likely non-exhaustive list of resource names, not all of which	1336	Here is a likely non-exhaustive list of resource names, not all of which
1147	are supported in every build, please see the source file F</src/rsinc.h>	1337	are supported in every build, please see the source file F</src/rsinc.h>
1148	to see the actual list:	1338	to see the actual list:
1149		1339
1150	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1340	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1151	borderLess color cursorBlink cursorUnderline cutchars delete_key	1341	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1152	display_name embed ext_bwidth fade font geometry hold iconName	1342	display_name embed ext_bwidth fade font geometry hold iconName
1153	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1343	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1154	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1344	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1155	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1345	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1156	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1346	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1157	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1347	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1158	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1348	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1159	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1349	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1160	secondaryScreen secondaryScroll selectstyle shade term_name title	1350	secondaryScreen secondaryScroll shade term_name title
1161	transient_for transparent transparent_all tripleclickwords utmpInhibit	1351	transient_for transparent transparent_all tripleclickwords utmpInhibit
1162	visualBell	1352	visualBell
1163		1353
1164	=cut	1354	=cut
1165		1355
1166	sub resource($$;$) {	1356	sub resource($$;$) {
1167	my ($self, $name) = (shift, shift);	1357	my ($self, $name) = (shift, shift);
1168	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1358	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1169	&urxvt::term::_resource	1359	goto &urxvt::term::_resource
1170	}	1360	}
1171		1361
1172	=item $value = $term->x_resource ($pattern)	1362	=item $value = $term->x_resource ($pattern)
1173		1363
1174	Returns the X-Resource for the given pattern, excluding the program or	1364	Returns the X-Resource for the given pattern, excluding the program or
…		…
1199		1389
1200	=item ($row, $col) = $term->selection_beg ([$row, $col])	1390	=item ($row, $col) = $term->selection_beg ([$row, $col])
1201		1391
1202	=item ($row, $col) = $term->selection_end ([$row, $col])	1392	=item ($row, $col) = $term->selection_end ([$row, $col])
1203		1393
1204	Return the current values of the selection mark, begin or end positions,	1394	Return the current values of the selection mark, begin or end positions.
1205	and optionally set them to new values.	1395
		1396	When arguments are given, then the selection coordinates are set to
		1397	C<$row> and C<$col>, and the selection screen is set to the current
		1398	screen.
		1399
		1400	=item $screen = $term->selection_screen ([$screen])
		1401
		1402	Returns the current selection screen, and then optionally sets it.
1206		1403
1207	=item $term->selection_make ($eventtime[, $rectangular])	1404	=item $term->selection_make ($eventtime[, $rectangular])
1208		1405
1209	Tries to make a selection as set by C<selection_beg> and	1406	Tries to make a selection as set by C<selection_beg> and
1210	C<selection_end>. If C<$rectangular> is true (default: false), a	1407	C<selection_end>. If C<$rectangular> is true (default: false), a
1211	rectangular selection will be made. This is the prefered function to make	1408	rectangular selection will be made. This is the preferred function to make
1212	a selection.	1409	a selection.
1213		1410
1214	=item $success = $term->selection_grab ($eventtime)	1411	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1215		1412
1216	Try to request the primary selection text from the server (for example, as	1413	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1414	true) selection from the server. The corresponding text can be set
1217	set by the next method). No visual feedback will be given. This function	1415	with the next method. No visual feedback will be given. This function
1218	is mostly useful from within C<on_sel_grab> hooks.	1416	is mostly useful from within C<on_sel_grab> hooks.
1219		1417
1220	=item $oldtext = $term->selection ([$newtext])	1418	=item $oldtext = $term->selection ([$newtext, $clipboard])
1221		1419
1222	Return the current selection text and optionally replace it by C<$newtext>.	1420	Return the current selection (clipboard if C<$clipboard> is true) text
		1421	and optionally replace it by C<$newtext>.
		1422
		1423	=item $term->selection_clear ([$clipboard])
		1424
		1425	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1223		1426
1224	=item $term->overlay_simple ($x, $y, $text)	1427	=item $term->overlay_simple ($x, $y, $text)
1225		1428
1226	Create a simple multi-line overlay box. See the next method for details.	1429	Create a simple multi-line overlay box. See the next method for details.
1227		1430
…		…
1257		1460
1258	The methods currently supported on C<urxvt::overlay> objects are:	1461	The methods currently supported on C<urxvt::overlay> objects are:
1259		1462
1260	=over 4	1463	=over 4
1261		1464
1262	=item $overlay->set ($x, $y, $text, $rend)	1465	=item $overlay->set ($x, $y, $text[, $rend])
1263		1466
1264	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1467	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1265	text in rxvt-unicode's special encoding and an array of rendition values	1468	text in rxvt-unicode's special encoding and an array of rendition values
1266	at a specific position inside the overlay.	1469	at a specific position inside the overlay.
		1470
		1471	If C<$rend> is missing, then the rendition will not be changed.
1267		1472
1268	=item $overlay->hide	1473	=item $overlay->hide
1269		1474
1270	If visible, hide the overlay, but do not destroy it.	1475	If visible, hide the overlay, but do not destroy it.
1271		1476
…		…
1353	locale-specific encoding of the terminal and can contain command sequences	1558	locale-specific encoding of the terminal and can contain command sequences
1354	(escape codes) that will be interpreted.	1559	(escape codes) that will be interpreted.
1355		1560
1356	=item $term->tt_write ($octets)	1561	=item $term->tt_write ($octets)
1357		1562
1358	Write the octets given in C<$data> to the tty (i.e. as program input). To	1563	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1359	pass characters instead of octets, you should convert your strings first	1564	pass characters instead of octets, you should convert your strings first
1360	to the locale-specific encoding using C<< $term->locale_encode >>.	1565	to the locale-specific encoding using C<< $term->locale_encode >>.
		1566
		1567	=item $term->tt_paste ($octets)
		1568
		1569	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1570	CR and bracketing the data with control sequences if bracketed paste mode
		1571	is set.
1361		1572
1362	=item $old_events = $term->pty_ev_events ([$new_events])	1573	=item $old_events = $term->pty_ev_events ([$new_events])
1363		1574
1364	Replaces the event mask of the pty watcher by the given event mask. Can	1575	Replaces the event mask of the pty watcher by the given event mask. Can
1365	be used to suppress input and output handling to the pty/tty. See the	1576	be used to suppress input and output handling to the pty/tty. See the
…		…
1384	Adds the specified events to the vt event mask. Useful e.g. when you want	1595	Adds the specified events to the vt event mask. Useful e.g. when you want
1385	to receive pointer events all the times:	1596	to receive pointer events all the times:
1386		1597
1387	$term->vt_emask_add (urxvt::PointerMotionMask);	1598	$term->vt_emask_add (urxvt::PointerMotionMask);
1388		1599
		1600	=item $term->focus_in
		1601
		1602	=item $term->focus_out
		1603
		1604	=item $term->key_press ($state, $keycode[, $time])
		1605
		1606	=item $term->key_release ($state, $keycode[, $time])
		1607
		1608	Deliver various fake events to to terminal.
		1609
1389	=item $window_width = $term->width	1610	=item $window_width = $term->width
1390		1611
1391	=item $window_height = $term->height	1612	=item $window_height = $term->height
1392		1613
1393	=item $font_width = $term->fwidth	1614	=item $font_width = $term->fwidth
…		…
1423	=item $env = $term->env	1644	=item $env = $term->env
1424		1645
1425	Returns a copy of the environment in effect for the terminal as a hashref	1646	Returns a copy of the environment in effect for the terminal as a hashref
1426	similar to C<\%ENV>.	1647	similar to C<\%ENV>.
1427		1648
		1649	=item @envv = $term->envv
		1650
		1651	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1652
		1653	=item @argv = $term->argv
		1654
		1655	Return the argument vector as this terminal, similar to @ARGV, but
		1656	includes the program name as first element.
		1657
1428	=cut	1658	=cut
1429		1659
1430	sub env {	1660	sub env {
1431	if (my $env = $_[0]->_env) {
1432	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1661	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1433	} else {
1434	+{ %ENV }
1435	}
1436	}	1662	}
1437		1663
1438	=item $modifiermask = $term->ModLevel3Mask	1664	=item $modifiermask = $term->ModLevel3Mask
1439		1665
1440	=item $modifiermask = $term->ModMetaMask	1666	=item $modifiermask = $term->ModMetaMask
…		…
1448		1674
1449	Returns the currently displayed screen (0 primary, 1 secondary).	1675	Returns the currently displayed screen (0 primary, 1 secondary).
1450		1676
1451	=item $cursor_is_hidden = $term->hidden_cursor	1677	=item $cursor_is_hidden = $term->hidden_cursor
1452		1678
1453	Returns wether the cursor is currently hidden or not.	1679	Returns whether the cursor is currently hidden or not.
1454		1680
1455	=item $view_start = $term->view_start ([$newvalue])	1681	=item $view_start = $term->view_start ([$newvalue])
1456		1682
1457	Returns the row number of the topmost displayed line. Maximum value is	1683	Returns the row number of the topmost displayed line. Maximum value is
1458	C<0>, which displays the normal terminal contents. Lower values scroll	1684	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1466		1692
1467	Used after changing terminal contents to display them.	1693	Used after changing terminal contents to display them.
1468		1694
1469	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1695	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1470		1696
1471	Returns the text of the entire row with number C<$row_number>. Row C<0>	1697	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1472	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1698	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1473	terminal line. The scrollback buffer starts at line C<-1> and extends to
1474	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1699	terminal line. Nothing will be returned if a nonexistent line
1475	is requested.	1700	is requested.
1476		1701
1477	If C<$new_text> is specified, it will replace characters in the current	1702	If C<$new_text> is specified, it will replace characters in the current
1478	line, starting at column C<$start_col> (default C<0>), which is useful	1703	line, starting at column C<$start_col> (default C<0>), which is useful
1479	to replace only parts of a line. The font index in the rendition will	1704	to replace only parts of a line. The font index in the rendition will
1480	automatically be updated.	1705	automatically be updated.
1481		1706
1482	C<$text> is in a special encoding: tabs and wide characters that use more	1707	C<$text> is in a special encoding: tabs and wide characters that use more
1483	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1708	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1484	characters. Characters with combining characters and other characters that	1709	characters. Characters with combining characters and other characters that
1485	do not fit into the normal tetx encoding will be replaced with characters	1710	do not fit into the normal text encoding will be replaced with characters
1486	in the private use area.	1711	in the private use area.
1487		1712
1488	You have to obey this encoding when changing text. The advantage is	1713	You have to obey this encoding when changing text. The advantage is
1489	that C<substr> and similar functions work on screen cells and not on	1714	that C<substr> and similar functions work on screen cells and not on
1490	characters.	1715	characters.
…		…
1635	where one character corresponds to one screen cell. See	1860	where one character corresponds to one screen cell. See
1636	C<< $term->ROW_t >> for details.	1861	C<< $term->ROW_t >> for details.
1637		1862
1638	=item $string = $term->special_decode $text	1863	=item $string = $term->special_decode $text
1639		1864
1640	Converts rxvt-unicodes text reprsentation into a perl string. See	1865	Converts rxvt-unicodes text representation into a perl string. See
1641	C<< $term->ROW_t >> for details.	1866	C<< $term->ROW_t >> for details.
1642		1867
1643	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1868	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1644		1869
1645	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1870	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1648	manpage.	1873	manpage.
1649		1874
1650	=item $success = $term->grab ($eventtime[, $sync])	1875	=item $success = $term->grab ($eventtime[, $sync])
1651		1876
1652	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1877	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1653	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1878	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1654		1879
1655	=item $term->allow_events_async	1880	=item $term->allow_events_async
1656		1881
1657	Calls XAllowEvents with AsyncBoth for the most recent grab.	1882	Calls XAllowEvents with AsyncBoth for the most recent grab.
1658		1883
…		…
1665	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1890	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1666	recent grab.	1891	recent grab.
1667		1892
1668	=item $term->ungrab	1893	=item $term->ungrab
1669		1894
1670	Calls XUngrab for the most recent grab. Is called automatically on	1895	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1671	evaluation errors, as it is better to lose the grab in the error case as	1896	evaluation errors, as it is better to lose the grab in the error case as
1672	the session.	1897	the session.
1673		1898
1674	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1899	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1675		1900
…		…
1677		1902
1678	=item @atoms = $term->XListProperties ($window)	1903	=item @atoms = $term->XListProperties ($window)
1679		1904
1680	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1905	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1681		1906
1682	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1907	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1683		1908
1684	=item $term->XDeleteProperty ($window, $property)	1909	=item $term->XDeleteProperty ($window, $property)
1685		1910
1686	=item $window = $term->DefaultRootWindow	1911	=item $window = $term->DefaultRootWindow
1687		1912
…		…
1697		1922
1698	=item $term->XChangeInput ($window, $add_events[, $del_events])	1923	=item $term->XChangeInput ($window, $add_events[, $del_events])
1699		1924
1700	Various X or X-related functions. The C<$term> object only serves as	1925	Various X or X-related functions. The C<$term> object only serves as
1701	the source of the display, otherwise those functions map more-or-less	1926	the source of the display, otherwise those functions map more-or-less
1702	directory onto the X functions of the same name.	1927	directly onto the X functions of the same name.
1703		1928
1704	=back	1929	=back
1705		1930
1706	=cut	1931	=cut
1707		1932
…		…
1771	my ($self, $text, $cb) = @_;	1996	my ($self, $text, $cb) = @_;
1772		1997
1773	$self->add_item ({ type => "button", text => $text, activate => $cb});	1998	$self->add_item ({ type => "button", text => $text, activate => $cb});
1774	}	1999	}
1775		2000
1776	=item $popup->add_toggle ($text, $cb, $initial_value)	2001	=item $popup->add_toggle ($text, $initial_value, $cb)
1777		2002
1778	Adds a toggle/checkbox item to the popup. Teh callback gets called	2003	Adds a toggle/checkbox item to the popup. The callback gets called
1779	whenever it gets toggled, with a boolean indicating its value as its first	2004	whenever it gets toggled, with a boolean indicating its new value as its
1780	argument.	2005	first argument.
1781		2006
1782	=cut	2007	=cut
1783		2008
1784	sub add_toggle {	2009	sub add_toggle {
1785	my ($self, $text, $cb, $value) = @_;	2010	my ($self, $text, $value, $cb) = @_;
1786		2011
1787	my $item; $item = {	2012	my $item; $item = {
1788	type => "button",	2013	type => "button",
1789	text => " $text",	2014	text => " $text",
1790	value => $value,	2015	value => $value,
…		…
1809	my $env = $self->{term}->env;	2034	my $env = $self->{term}->env;
1810	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2035	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1811	delete $env->{LC_ALL};	2036	delete $env->{LC_ALL};
1812	$env->{LC_CTYPE} = $self->{term}->locale;	2037	$env->{LC_CTYPE} = $self->{term}->locale;
1813		2038
1814	urxvt::term->new ($env, "popup",	2039	my $term = urxvt::term->new (
		2040	$env, "popup",
1815	"--perl-lib" => "", "--perl-ext-common" => "",	2041	"--perl-lib" => "", "--perl-ext-common" => "",
1816	"-pty-fd" => -1, "-sl" => 0,	2042	"-pty-fd" => -1, "-sl" => 0,
1817	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2043	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1818	"--transient-for" => $self->{term}->parent,	2044	"--transient-for" => $self->{term}->parent,
1819	"-display" => $self->{term}->display_id,	2045	"-display" => $self->{term}->display_id,
1820	"-pe" => "urxvt-popup")	2046	"-pe" => "urxvt-popup",
1821	or die "unable to create popup window\n";	2047	) or die "unable to create popup window\n";
		2048
		2049	unless (delete $term->{urxvt_popup_init_done}) {
		2050	$term->ungrab;
		2051	$term->destroy;
		2052	die "unable to initialise popup window\n";
		2053	}
1822	}	2054	}
1823		2055
1824	sub DESTROY {	2056	sub DESTROY {
1825	my ($self) = @_;	2057	my ($self) = @_;
1826		2058
…		…
1831	=back	2063	=back
1832		2064
1833	=cut	2065	=cut
1834		2066
1835	package urxvt::watcher;	2067	package urxvt::watcher;
1836
1837	@urxvt::timer::ISA = __PACKAGE__;
1838	@urxvt::iow::ISA = __PACKAGE__;
1839	@urxvt::pw::ISA = __PACKAGE__;
1840	@urxvt::iw::ISA = __PACKAGE__;
1841		2068
1842	=head2 The C<urxvt::timer> Class	2069	=head2 The C<urxvt::timer> Class
1843		2070
1844	This class implements timer watchers/events. Time is represented as a	2071	This class implements timer watchers/events. Time is represented as a
1845	fractional number of seconds since the epoch. Example:	2072	fractional number of seconds since the epoch. Example:
…		…
1849	->new	2076	->new
1850	->interval (1)	2077	->interval (1)
1851	->cb (sub {	2078	->cb (sub {
1852	$term->{overlay}->set (0, 0,	2079	$term->{overlay}->set (0, 0,
1853	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2080	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1854	});	2081	});
1855		2082
1856	=over 4	2083	=over 4
1857		2084
1858	=item $timer = new urxvt::timer	2085	=item $timer = new urxvt::timer
1859		2086
…		…
1862		2089
1863	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2090	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1864		2091
1865	Set the callback to be called when the timer triggers.	2092	Set the callback to be called when the timer triggers.
1866		2093
1867	=item $tstamp = $timer->at
1868
1869	Return the time this watcher will fire next.
1870
1871	=item $timer = $timer->set ($tstamp)	2094	=item $timer = $timer->set ($tstamp[, $interval])
1872		2095
1873	Set the time the event is generated to $tstamp.	2096	Set the time the event is generated to $tstamp (and optionally specifies a
		2097	new $interval).
1874		2098
1875	=item $timer = $timer->interval ($interval)	2099	=item $timer = $timer->interval ($interval)
1876		2100
1877	Normally (and when C<$interval> is C<0>), the timer will automatically	2101	By default (and when C<$interval> is C<0>), the timer will automatically
1878	stop after it has fired once. If C<$interval> is non-zero, then the timer	2102	stop after it has fired once. If C<$interval> is non-zero, then the timer
1879	is automatically rescheduled at the given intervals.	2103	is automatically rescheduled at the given intervals.
1880		2104
1881	=item $timer = $timer->start	2105	=item $timer = $timer->start
1882		2106
1883	Start the timer.	2107	Start the timer.
1884		2108
1885	=item $timer = $timer->start ($tstamp)	2109	=item $timer = $timer->start ($tstamp[, $interval])
1886		2110
1887	Set the event trigger time to C<$tstamp> and start the timer.	2111	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2112	also replaces the interval.
1888		2113
1889	=item $timer = $timer->after ($delay)	2114	=item $timer = $timer->after ($delay[, $interval])
1890		2115
1891	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2116	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1892		2117
1893	=item $timer = $timer->stop	2118	=item $timer = $timer->stop
1894		2119
…		…
1902		2127
1903	$term->{socket} = ...	2128	$term->{socket} = ...
1904	$term->{iow} = urxvt::iow	2129	$term->{iow} = urxvt::iow
1905	->new	2130	->new
1906	->fd (fileno $term->{socket})	2131	->fd (fileno $term->{socket})
1907	->events (urxvt::EVENT_READ)	2132	->events (urxvt::EV_READ)
1908	->start	2133	->start
1909	->cb (sub {	2134	->cb (sub {
1910	my ($iow, $revents) = @_;	2135	my ($iow, $revents) = @_;
1911	# $revents must be 1 here, no need to check	2136	# $revents must be 1 here, no need to check
1912	sysread $term->{socket}, my $buf, 8192	2137	sysread $term->{socket}, my $buf, 8192
…		…
1925	Set the callback to be called when io events are triggered. C<$reventmask>	2150	Set the callback to be called when io events are triggered. C<$reventmask>
1926	is a bitset as described in the C<events> method.	2151	is a bitset as described in the C<events> method.
1927		2152
1928	=item $iow = $iow->fd ($fd)	2153	=item $iow = $iow->fd ($fd)
1929		2154
1930	Set the filedescriptor (not handle) to watch.	2155	Set the file descriptor (not handle) to watch.
1931		2156
1932	=item $iow = $iow->events ($eventmask)	2157	=item $iow = $iow->events ($eventmask)
1933		2158
1934	Set the event mask to watch. The only allowed values are	2159	Set the event mask to watch. The only allowed values are
1935	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2160	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1936	together, or C<urxvt::EVENT_NONE>.	2161	together, or C<urxvt::EV_NONE>.
1937		2162
1938	=item $iow = $iow->start	2163	=item $iow = $iow->start
1939		2164
1940	Start watching for requested events on the given handle.	2165	Start watching for requested events on the given handle.
1941		2166
1942	=item $iow = $iow->stop	2167	=item $iow = $iow->stop
1943		2168
1944	Stop watching for events on the given filehandle.	2169	Stop watching for events on the given file handle.
1945		2170
1946	=back	2171	=back
1947		2172
1948	=head2 The C<urxvt::iw> Class	2173	=head2 The C<urxvt::iw> Class
1949		2174
…		…
1982	->new	2207	->new
1983	->start ($pid)	2208	->start ($pid)
1984	->cb (sub {	2209	->cb (sub {
1985	my ($pw, $exit_status) = @_;	2210	my ($pw, $exit_status) = @_;
1986	...	2211	...
1987	});	2212	});
1988		2213
1989	=over 4	2214	=over 4
1990		2215
1991	=item $pw = new urxvt::pw	2216	=item $pw = new urxvt::pw
1992		2217
…		…
1996		2221
1997	Set the callback to be called when the timer triggers.	2222	Set the callback to be called when the timer triggers.
1998		2223
1999	=item $pw = $timer->start ($pid)	2224	=item $pw = $timer->start ($pid)
2000		2225
2001	Tells the wqtcher to start watching for process C<$pid>.	2226	Tells the watcher to start watching for process C<$pid>.
2002		2227
2003	=item $pw = $pw->stop	2228	=item $pw = $pw->stop
2004		2229
2005	Stop the watcher.	2230	Stop the watcher.
2006		2231
…		…
2019		2244
2020	=item >= 3 - script loading and management	2245	=item >= 3 - script loading and management
2021		2246
2022	=item >=10 - all called hooks	2247	=item >=10 - all called hooks
2023		2248
2024	=item >=11 - hook reutrn values	2249	=item >=11 - hook return values
2025		2250
2026	=back	2251	=back
2027		2252
2028	=head1 AUTHOR	2253	=head1 AUTHOR
2029		2254
…		…
2031	http://software.schmorp.de/pkg/rxvt-unicode	2256	http://software.schmorp.de/pkg/rxvt-unicode
2032		2257
2033	=cut	2258	=cut
2034		2259
2035	1	2260	1
		2261
		2262	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.131 by root, Sun Jan 29 20:51:28 2006 UTC vs. Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.131 by root, Sun Jan 29 20:51:28 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC