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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC vs.
Revision 1.188 by sf-exg, Sat Jul 24 13:04:27 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-selection	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_keyboard_command $term, $string	652	=item on_user_command $term, $string
521		653
522	Called whenever the user presses a key combination that has a	654	Called whenever a user-configured event is being activated (e.g. via
523	C<perl:string> action bound to it (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).
		657
		658	The event is simply the action string. This interface is assumed to change
		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.
525		666
526	=item on_x_event $term, $event	667	=item on_x_event $term, $event
527		668
528	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
529	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
530	members are not passed.	671	members are not passed.
531		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
532	=item on_focus_in $term	677	=item on_focus_in $term
533		678
534	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
535	does focus in processing.	680	does focus in processing.
536		681
537	=item on_focus_out $term	682	=item on_focus_out $term
538		683
539	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
540	focus out processing.	685	focus out processing.
541		686
542	=item on_configure_notify $term, $event	687	=item on_configure_notify $term, $event
543		688
544	=item on_property_notify $term, $event	689	=item on_property_notify $term, $event
…		…
555		700
556	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
557		702
558	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
559		704
560	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
561	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.
562		707
563	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
564	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
565	(real, not screen-based) row and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
566		711
…		…
575		720
576	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
577		722
578	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
579	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.
580		729
581	=back	730	=back
582		731
583	=cut	732	=cut
584		733
…		…
627	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
628	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
629		778
630	=item @urxvt::TERM_INIT	779	=item @urxvt::TERM_INIT
631		780
632	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
633	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
634	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,
635	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.
636		785
637	This complements to the perl-eval commandline option, but gets executed	786	This complements to the perl-eval command line option, but gets executed
638	first.	787	first.
639		788
640	=item @urxvt::TERM_EXT	789	=item @urxvt::TERM_EXT
641		790
642	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
…		…
663		812
664	Using this function has the advantage that its output ends up in the	813	Using this function has the advantage that its output ends up in the
665	correct place, e.g. on stderr of the connecting urxvtc client.	814	correct place, e.g. on stderr of the connecting urxvtc client.
666		815
667	Messages have a size limit of 1023 bytes currently.	816	Messages have a size limit of 1023 bytes currently.
		817
		818	=item @terms = urxvt::termlist
		819
		820	Returns all urxvt::term objects that exist in this process, regardless of
		821	whether they are started, being destroyed etc., so be careful. Only term
		822	objects that have perl extensions attached will be returned (because there
		823	is no urxvt::term objet associated with others).
668		824
669	=item $time = urxvt::NOW	825	=item $time = urxvt::NOW
670		826
671	Returns the "current time" (as per the event loop).	827	Returns the "current time" (as per the event loop).
672		828
…		…
730	Return the foreground/background colour index, respectively.	886	Return the foreground/background colour index, respectively.
731		887
732	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	888	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
733		889
734	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	890	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		891
		892	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
735		893
736	Replace the foreground/background colour in the rendition mask with the	894	Replace the foreground/background colour in the rendition mask with the
737	specified one.	895	specified one.
738		896
739	=item $value = urxvt::GET_CUSTOM $rend	897	=item $value = urxvt::GET_CUSTOM $rend
…		…
806	local $TERM = shift;	964	local $TERM = shift;
807	my $htype = shift;	965	my $htype = shift;
808		966
809	if ($htype == 0) { # INIT	967	if ($htype == 0) { # INIT
810	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	968	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
811		969
812	my %ext_arg;	970	my %ext_arg;
813		971
814	{	972	{
815	my @init = @TERM_INIT;	973	my @init = @TERM_INIT;
816	@TERM_INIT = ();	974	@TERM_INIT = ();
…		…
830	} else {	988	} else {
831	$ext_arg{$_} \|\|= [];	989	$ext_arg{$_} \|\|= [];
832	}	990	}
833	}	991	}
834		992
835	while (my ($ext, $argv) = each %ext_arg) {	993	for my $ext (sort keys %ext_arg) {
836	my @files = grep -f $_, map "$_/$ext", @dirs;	994	my @files = grep -f $_, map "$_/$ext", @dirs;
837		995
838	if (@files) {	996	if (@files) {
839	$TERM->register_package (extension_package $files[0], $argv);	997	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
840	} else {	998	} else {
841	warn "perl extension '$ext' not found in perl library search path\n";	999	warn "perl extension '$ext' not found in perl library search path\n";
842	}	1000	}
843	}	1001	}
844		1002
…		…
850		1008
851	if (my $cb = $TERM->{_hook}[$htype]) {	1009	if (my $cb = $TERM->{_hook}[$htype]) {
852	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1010	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
853	if $verbosity >= 10;	1011	if $verbosity >= 10;
854		1012
855	keys %$cb;	1013	for my $pkg (keys %$cb) {
856
857	while (my ($pkg, $cb) = each %$cb) {
858	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1014	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
859	$retval \|\|= $retval_;	1015	$retval \|\|= $retval_;
860		1016
861	if ($@) {	1017	if ($@) {
862	$TERM->ungrab; # better to lose the grab than the session	1018	$TERM->ungrab; # better to lose the grab than the session
863	warn $@;	1019	warn $@;
…		…
875	# clear package	1031	# clear package
876	%$TERM = ();	1032	%$TERM = ();
877	}	1033	}
878		1034
879	$retval	1035	$retval
		1036	}
		1037
		1038	sub SET_COLOR($$$) {
		1039	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1040	}
		1041
		1042	sub rend2mask {
		1043	no strict 'refs';
		1044	my ($str, $mask) = (@_, 0);
		1045	my %color = ( fg => undef, bg => undef );
		1046	my @failed;
		1047	for my $spec ( split /\s+/, $str ) {
		1048	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1049	$color{lc($1)} = $2;
		1050	} else {
		1051	my $neg = $spec =~ s/^[-^]//;
		1052	unless ( exists &{"RS_$spec"} ) {
		1053	push @failed, $spec;
		1054	next;
		1055	}
		1056	my $cur = &{"RS_$spec"};
		1057	if ( $neg ) {
		1058	$mask &= ~$cur;
		1059	} else {
		1060	$mask \|= $cur;
		1061	}
		1062	}
		1063	}
		1064	($mask, @color{qw(fg bg)}, \@failed)
880	}	1065	}
881		1066
882	# urxvt::term::extension	1067	# urxvt::term::extension
883		1068
884	package urxvt::term::extension;	1069	package urxvt::term::extension;
…		…
955	is that you cannot use blocking APIs, but the non-blocking variant should	1140	is that you cannot use blocking APIs, but the non-blocking variant should
956	work.	1141	work.
957		1142
958	=cut	1143	=cut
959		1144
960	our $VERSION = 1;	1145	our $VERSION = '5.23';
961		1146
962	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1147	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
963	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1148	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
964		1149
965	sub timer {	1150	sub timer {
…		…
967		1152
968	my $cb = $arg{cb};	1153	my $cb = $arg{cb};
969		1154
970	urxvt::timer	1155	urxvt::timer
971	->new	1156	->new
972	->start (urxvt::NOW + $arg{after})	1157	->after ($arg{after}, $arg{interval})
973	->cb (sub {	1158	->cb ($arg{interval} ? $cb : sub {
974	$_[0]->stop; # need to cancel manually	1159	$_[0]->stop; # need to cancel manually
975	$cb->();	1160	$cb->();
976	})	1161	})
977	}	1162	}
978		1163
979	sub io {	1164	sub io {
980	my ($class, %arg) = @_;	1165	my ($class, %arg) = @_;
981		1166
982	my $cb = $arg{cb};	1167	my $cb = $arg{cb};
		1168	my $fd = fileno $arg{fh};
		1169	defined $fd or $fd = $arg{fh};
983		1170
984	bless [$arg{fh}, urxvt::iow	1171	bless [$arg{fh}, urxvt::iow
985	->new	1172	->new
986	->fd (fileno $arg{fh})	1173	->fd ($fd)
987	->events (($arg{poll} =~ /r/ ? 1 : 0)	1174	->events (($arg{poll} =~ /r/ ? 1 : 0)
988	\| ($arg{poll} =~ /w/ ? 2 : 0))	1175	\| ($arg{poll} =~ /w/ ? 2 : 0))
989	->start	1176	->start
990	->cb (sub {	1177	->cb ($cb)
991	$cb->(($_[1] & 1 ? 'r' : '')
992	. ($_[1] & 2 ? 'w' : ''));
993	})],
994	urxvt::anyevent::	1178	], urxvt::anyevent::
		1179	}
		1180
		1181	sub idle {
		1182	my ($class, %arg) = @_;
		1183
		1184	my $cb = $arg{cb};
		1185
		1186	urxvt::iw
		1187	->new
		1188	->start
		1189	->cb ($cb)
		1190	}
		1191
		1192	sub child {
		1193	my ($class, %arg) = @_;
		1194
		1195	my $cb = $arg{cb};
		1196
		1197	urxvt::pw
		1198	->new
		1199	->start ($arg{pid})
		1200	->cb (sub {
		1201	$_[0]->stop; # need to cancel manually
		1202	$cb->($_[0]->rpid, $_[0]->rstatus);
		1203	})
995	}	1204	}
996		1205
997	sub DESTROY {	1206	sub DESTROY {
998	$_[0][1]->stop;	1207	$_[0][1]->stop;
999	}	1208	}
1000		1209
1001	sub condvar {	1210	sub one_event {
1002	bless \my $flag, urxvt::anyevent::condvar::
1003	}
1004
1005	sub urxvt::anyevent::condvar::broadcast {
1006	${$_[0]}++;
1007	}
1008
1009	sub urxvt::anyevent::condvar::wait {
1010	unless (${$_[0]}) {
1011	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1211	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1012	}
1013	}	1212	}
1014		1213
1015	package urxvt::term;	1214	package urxvt::term;
1016		1215
1017	=head2 The C<urxvt::term> Class	1216	=head2 The C<urxvt::term> Class
…		…
1053	hash which defines the environment of the new terminal.	1252	hash which defines the environment of the new terminal.
1054		1253
1055	Croaks (and probably outputs an error message) if the new instance	1254	Croaks (and probably outputs an error message) if the new instance
1056	couldn't be created. Returns C<undef> if the new instance didn't	1255	couldn't be created. Returns C<undef> if the new instance didn't
1057	initialise perl, and the terminal object otherwise. The C<init> and	1256	initialise perl, and the terminal object otherwise. The C<init> and
1058	C<start> hooks will be called during this call.	1257	C<start> hooks will be called before this call returns, and are free to
		1258	refer to global data (which is race free).
1059		1259
1060	=cut	1260	=cut
1061		1261
1062	sub new {	1262	sub new {
1063	my ($class, $env, @args) = @_;	1263	my ($class, $env, @args) = @_;
1064		1264
		1265	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1266	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1267
1065	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1268	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1066	}	1269	}
1067		1270
1068	=item $term->destroy	1271	=item $term->destroy
1069		1272
1070	Destroy the terminal object (close the window, free resources	1273	Destroy the terminal object (close the window, free resources
…		…
1100		1303
1101	Returns true if the option specified by C<$optval> is enabled, and	1304	Returns true if the option specified by C<$optval> is enabled, and
1102	optionally change it. All option values are stored by name in the hash	1305	optionally change it. All option values are stored by name in the hash
1103	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1306	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1104		1307
1105	Here is a a likely non-exhaustive list of option names, please see the	1308	Here is a likely non-exhaustive list of option names, please see the
1106	source file F</src/optinc.h> to see the actual list:	1309	source file F</src/optinc.h> to see the actual list:
1107		1310
1108	borderLess console cursorBlink cursorUnderline hold iconic insecure	1311	borderLess console cursorBlink cursorUnderline hold iconic insecure
1109	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1312	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1110	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1313	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1127	likely change).	1330	likely change).
1128		1331
1129	Please note that resource strings will currently only be freed when the	1332	Please note that resource strings will currently only be freed when the
1130	terminal is destroyed, so changing options frequently will eat memory.	1333	terminal is destroyed, so changing options frequently will eat memory.
1131		1334
1132	Here is a a likely non-exhaustive list of resource names, not all of which	1335	Here is a likely non-exhaustive list of resource names, not all of which
1133	are supported in every build, please see the source file F</src/rsinc.h>	1336	are supported in every build, please see the source file F</src/rsinc.h>
1134	to see the actual list:	1337	to see the actual list:
1135		1338
1136	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1339	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1137	borderLess color cursorBlink cursorUnderline cutchars delete_key	1340	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1138	display_name embed ext_bwidth fade font geometry hold iconName	1341	display_name embed ext_bwidth fade font geometry hold iconName
1139	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1342	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1140	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1343	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1141	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1344	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1142	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1345	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1143	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1346	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1144	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1347	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1145	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1348	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1146	secondaryScreen secondaryScroll selectstyle shade term_name title	1349	secondaryScreen secondaryScroll shade term_name title
1147	transient_for transparent transparent_all tripleclickwords utmpInhibit	1350	transient_for transparent transparent_all tripleclickwords utmpInhibit
1148	visualBell	1351	visualBell
1149		1352
1150	=cut	1353	=cut
1151		1354
1152	sub resource($$;$) {	1355	sub resource($$;$) {
1153	my ($self, $name) = (shift, shift);	1356	my ($self, $name) = (shift, shift);
1154	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1357	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1155	&urxvt::term::_resource	1358	goto &urxvt::term::_resource
1156	}	1359	}
1157		1360
1158	=item $value = $term->x_resource ($pattern)	1361	=item $value = $term->x_resource ($pattern)
1159		1362
1160	Returns the X-Resource for the given pattern, excluding the program or	1363	Returns the X-Resource for the given pattern, excluding the program or
…		…
1185		1388
1186	=item ($row, $col) = $term->selection_beg ([$row, $col])	1389	=item ($row, $col) = $term->selection_beg ([$row, $col])
1187		1390
1188	=item ($row, $col) = $term->selection_end ([$row, $col])	1391	=item ($row, $col) = $term->selection_end ([$row, $col])
1189		1392
1190	Return the current values of the selection mark, begin or end positions,	1393	Return the current values of the selection mark, begin or end positions.
1191	and optionally set them to new values.	1394
		1395	When arguments are given, then the selection coordinates are set to
		1396	C<$row> and C<$col>, and the selection screen is set to the current
		1397	screen.
		1398
		1399	=item $screen = $term->selection_screen ([$screen])
		1400
		1401	Returns the current selection screen, and then optionally sets it.
1192		1402
1193	=item $term->selection_make ($eventtime[, $rectangular])	1403	=item $term->selection_make ($eventtime[, $rectangular])
1194		1404
1195	Tries to make a selection as set by C<selection_beg> and	1405	Tries to make a selection as set by C<selection_beg> and
1196	C<selection_end>. If C<$rectangular> is true (default: false), a	1406	C<selection_end>. If C<$rectangular> is true (default: false), a
1197	rectangular selection will be made. This is the prefered function to make	1407	rectangular selection will be made. This is the preferred function to make
1198	a selection.	1408	a selection.
1199		1409
1200	=item $success = $term->selection_grab ($eventtime)	1410	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1201		1411
1202	Try to request the primary selection text from the server (for example, as	1412	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1413	true) selection from the server. The corresponding text can be set
1203	set by the next method). No visual feedback will be given. This function	1414	with the next method. No visual feedback will be given. This function
1204	is mostly useful from within C<on_sel_grab> hooks.	1415	is mostly useful from within C<on_sel_grab> hooks.
1205		1416
1206	=item $oldtext = $term->selection ([$newtext])	1417	=item $oldtext = $term->selection ([$newtext, $clipboard])
1207		1418
1208	Return the current selection text and optionally replace it by C<$newtext>.	1419	Return the current selection (clipboard if C<$clipboard> is true) text
		1420	and optionally replace it by C<$newtext>.
		1421
		1422	=item $term->selection_clear ([$clipboard])
		1423
		1424	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1209		1425
1210	=item $term->overlay_simple ($x, $y, $text)	1426	=item $term->overlay_simple ($x, $y, $text)
1211		1427
1212	Create a simple multi-line overlay box. See the next method for details.	1428	Create a simple multi-line overlay box. See the next method for details.
1213		1429
…		…
1243		1459
1244	The methods currently supported on C<urxvt::overlay> objects are:	1460	The methods currently supported on C<urxvt::overlay> objects are:
1245		1461
1246	=over 4	1462	=over 4
1247		1463
1248	=item $overlay->set ($x, $y, $text, $rend)	1464	=item $overlay->set ($x, $y, $text[, $rend])
1249		1465
1250	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1466	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1251	text in rxvt-unicode's special encoding and an array of rendition values	1467	text in rxvt-unicode's special encoding and an array of rendition values
1252	at a specific position inside the overlay.	1468	at a specific position inside the overlay.
		1469
		1470	If C<$rend> is missing, then the rendition will not be changed.
1253		1471
1254	=item $overlay->hide	1472	=item $overlay->hide
1255		1473
1256	If visible, hide the overlay, but do not destroy it.	1474	If visible, hide the overlay, but do not destroy it.
1257		1475
…		…
1339	locale-specific encoding of the terminal and can contain command sequences	1557	locale-specific encoding of the terminal and can contain command sequences
1340	(escape codes) that will be interpreted.	1558	(escape codes) that will be interpreted.
1341		1559
1342	=item $term->tt_write ($octets)	1560	=item $term->tt_write ($octets)
1343		1561
1344	Write the octets given in C<$data> to the tty (i.e. as program input). To	1562	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1345	pass characters instead of octets, you should convert your strings first	1563	pass characters instead of octets, you should convert your strings first
1346	to the locale-specific encoding using C<< $term->locale_encode >>.	1564	to the locale-specific encoding using C<< $term->locale_encode >>.
		1565
		1566	=item $term->tt_paste ($octets)
		1567
		1568	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1569	CR and bracketing the data with control sequences if bracketed paste mode
		1570	is set.
1347		1571
1348	=item $old_events = $term->pty_ev_events ([$new_events])	1572	=item $old_events = $term->pty_ev_events ([$new_events])
1349		1573
1350	Replaces the event mask of the pty watcher by the given event mask. Can	1574	Replaces the event mask of the pty watcher by the given event mask. Can
1351	be used to suppress input and output handling to the pty/tty. See the	1575	be used to suppress input and output handling to the pty/tty. See the
…		…
1370	Adds the specified events to the vt event mask. Useful e.g. when you want	1594	Adds the specified events to the vt event mask. Useful e.g. when you want
1371	to receive pointer events all the times:	1595	to receive pointer events all the times:
1372		1596
1373	$term->vt_emask_add (urxvt::PointerMotionMask);	1597	$term->vt_emask_add (urxvt::PointerMotionMask);
1374		1598
		1599	=item $term->focus_in
		1600
		1601	=item $term->focus_out
		1602
		1603	=item $term->key_press ($state, $keycode[, $time])
		1604
		1605	=item $term->key_release ($state, $keycode[, $time])
		1606
		1607	Deliver various fake events to to terminal.
		1608
1375	=item $window_width = $term->width	1609	=item $window_width = $term->width
1376		1610
1377	=item $window_height = $term->height	1611	=item $window_height = $term->height
1378		1612
1379	=item $font_width = $term->fwidth	1613	=item $font_width = $term->fwidth
…		…
1409	=item $env = $term->env	1643	=item $env = $term->env
1410		1644
1411	Returns a copy of the environment in effect for the terminal as a hashref	1645	Returns a copy of the environment in effect for the terminal as a hashref
1412	similar to C<\%ENV>.	1646	similar to C<\%ENV>.
1413		1647
		1648	=item @envv = $term->envv
		1649
		1650	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1651
		1652	=item @argv = $term->argv
		1653
		1654	Return the argument vector as this terminal, similar to @ARGV, but
		1655	includes the program name as first element.
		1656
1414	=cut	1657	=cut
1415		1658
1416	sub env {	1659	sub env {
1417	if (my $env = $_[0]->_env) {
1418	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1660	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1419	} else {
1420	+{ %ENV }
1421	}
1422	}	1661	}
1423		1662
1424	=item $modifiermask = $term->ModLevel3Mask	1663	=item $modifiermask = $term->ModLevel3Mask
1425		1664
1426	=item $modifiermask = $term->ModMetaMask	1665	=item $modifiermask = $term->ModMetaMask
…		…
1434		1673
1435	Returns the currently displayed screen (0 primary, 1 secondary).	1674	Returns the currently displayed screen (0 primary, 1 secondary).
1436		1675
1437	=item $cursor_is_hidden = $term->hidden_cursor	1676	=item $cursor_is_hidden = $term->hidden_cursor
1438		1677
1439	Returns wether the cursor is currently hidden or not.	1678	Returns whether the cursor is currently hidden or not.
1440		1679
1441	=item $view_start = $term->view_start ([$newvalue])	1680	=item $view_start = $term->view_start ([$newvalue])
1442		1681
1443	Returns the row number of the topmost displayed line. Maximum value is	1682	Returns the row number of the topmost displayed line. Maximum value is
1444	C<0>, which displays the normal terminal contents. Lower values scroll	1683	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1452		1691
1453	Used after changing terminal contents to display them.	1692	Used after changing terminal contents to display them.
1454		1693
1455	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1694	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1456		1695
1457	Returns the text of the entire row with number C<$row_number>. Row C<0>	1696	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1458	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1697	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1459	terminal line. The scrollback buffer starts at line C<-1> and extends to
1460	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1698	terminal line. Nothing will be returned if a nonexistent line
1461	is requested.	1699	is requested.
1462		1700
1463	If C<$new_text> is specified, it will replace characters in the current	1701	If C<$new_text> is specified, it will replace characters in the current
1464	line, starting at column C<$start_col> (default C<0>), which is useful	1702	line, starting at column C<$start_col> (default C<0>), which is useful
1465	to replace only parts of a line. The font index in the rendition will	1703	to replace only parts of a line. The font index in the rendition will
1466	automatically be updated.	1704	automatically be updated.
1467		1705
1468	C<$text> is in a special encoding: tabs and wide characters that use more	1706	C<$text> is in a special encoding: tabs and wide characters that use more
1469	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1707	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1470	characters. Characters with combining characters and other characters that	1708	characters. Characters with combining characters and other characters that
1471	do not fit into the normal tetx encoding will be replaced with characters	1709	do not fit into the normal text encoding will be replaced with characters
1472	in the private use area.	1710	in the private use area.
1473		1711
1474	You have to obey this encoding when changing text. The advantage is	1712	You have to obey this encoding when changing text. The advantage is
1475	that C<substr> and similar functions work on screen cells and not on	1713	that C<substr> and similar functions work on screen cells and not on
1476	characters.	1714	characters.
…		…
1621	where one character corresponds to one screen cell. See	1859	where one character corresponds to one screen cell. See
1622	C<< $term->ROW_t >> for details.	1860	C<< $term->ROW_t >> for details.
1623		1861
1624	=item $string = $term->special_decode $text	1862	=item $string = $term->special_decode $text
1625		1863
1626	Converts rxvt-unicodes text reprsentation into a perl string. See	1864	Converts rxvt-unicodes text representation into a perl string. See
1627	C<< $term->ROW_t >> for details.	1865	C<< $term->ROW_t >> for details.
1628		1866
1629	=item $success = $term->grab_button ($button, $modifiermask)	1867	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1630		1868
		1869	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1870
1631	Registers a synchronous button grab. See the XGrabButton manpage.	1871	Register/unregister a synchronous button grab. See the XGrabButton
		1872	manpage.
1632		1873
1633	=item $success = $term->grab ($eventtime[, $sync])	1874	=item $success = $term->grab ($eventtime[, $sync])
1634		1875
1635	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1876	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1636	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1877	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1637		1878
1638	=item $term->allow_events_async	1879	=item $term->allow_events_async
1639		1880
1640	Calls XAllowEvents with AsyncBoth for the most recent grab.	1881	Calls XAllowEvents with AsyncBoth for the most recent grab.
1641		1882
…		…
1648	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1889	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1649	recent grab.	1890	recent grab.
1650		1891
1651	=item $term->ungrab	1892	=item $term->ungrab
1652		1893
1653	Calls XUngrab for the most recent grab. Is called automatically on	1894	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1654	evaluation errors, as it is better to lose the grab in the error case as	1895	evaluation errors, as it is better to lose the grab in the error case as
1655	the session.	1896	the session.
1656		1897
1657	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1898	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1658		1899
…		…
1660		1901
1661	=item @atoms = $term->XListProperties ($window)	1902	=item @atoms = $term->XListProperties ($window)
1662		1903
1663	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1904	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1664		1905
1665	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1906	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1666		1907
1667	=item $term->XDeleteProperty ($window, $property)	1908	=item $term->XDeleteProperty ($window, $property)
1668		1909
1669	=item $window = $term->DefaultRootWindow	1910	=item $window = $term->DefaultRootWindow
1670		1911
…		…
1680		1921
1681	=item $term->XChangeInput ($window, $add_events[, $del_events])	1922	=item $term->XChangeInput ($window, $add_events[, $del_events])
1682		1923
1683	Various X or X-related functions. The C<$term> object only serves as	1924	Various X or X-related functions. The C<$term> object only serves as
1684	the source of the display, otherwise those functions map more-or-less	1925	the source of the display, otherwise those functions map more-or-less
1685	directory onto the X functions of the same name.	1926	directly onto the X functions of the same name.
1686		1927
1687	=back	1928	=back
1688		1929
1689	=cut	1930	=cut
1690		1931
…		…
1754	my ($self, $text, $cb) = @_;	1995	my ($self, $text, $cb) = @_;
1755		1996
1756	$self->add_item ({ type => "button", text => $text, activate => $cb});	1997	$self->add_item ({ type => "button", text => $text, activate => $cb});
1757	}	1998	}
1758		1999
1759	=item $popup->add_toggle ($text, $cb, $initial_value)	2000	=item $popup->add_toggle ($text, $initial_value, $cb)
1760		2001
1761	Adds a toggle/checkbox item to the popup. Teh callback gets called	2002	Adds a toggle/checkbox item to the popup. The callback gets called
1762	whenever it gets toggled, with a boolean indicating its value as its first	2003	whenever it gets toggled, with a boolean indicating its new value as its
1763	argument.	2004	first argument.
1764		2005
1765	=cut	2006	=cut
1766		2007
1767	sub add_toggle {	2008	sub add_toggle {
1768	my ($self, $text, $cb, $value) = @_;	2009	my ($self, $text, $value, $cb) = @_;
1769		2010
1770	my $item; $item = {	2011	my $item; $item = {
1771	type => "button",	2012	type => "button",
1772	text => " $text",	2013	text => " $text",
1773	value => $value,	2014	value => $value,
…		…
1792	my $env = $self->{term}->env;	2033	my $env = $self->{term}->env;
1793	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2034	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1794	delete $env->{LC_ALL};	2035	delete $env->{LC_ALL};
1795	$env->{LC_CTYPE} = $self->{term}->locale;	2036	$env->{LC_CTYPE} = $self->{term}->locale;
1796		2037
1797	urxvt::term->new ($env, "popup",	2038	my $term = urxvt::term->new (
		2039	$env, "popup",
1798	"--perl-lib" => "", "--perl-ext-common" => "",	2040	"--perl-lib" => "", "--perl-ext-common" => "",
1799	"-pty-fd" => -1, "-sl" => 0,	2041	"-pty-fd" => -1, "-sl" => 0,
1800	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2042	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1801	"--transient-for" => $self->{term}->parent,	2043	"--transient-for" => $self->{term}->parent,
1802	"-display" => $self->{term}->display_id,	2044	"-display" => $self->{term}->display_id,
1803	"-pe" => "urxvt-popup")	2045	"-pe" => "urxvt-popup",
1804	or die "unable to create popup window\n";	2046	) or die "unable to create popup window\n";
		2047
		2048	unless (delete $term->{urxvt_popup_init_done}) {
		2049	$term->ungrab;
		2050	$term->destroy;
		2051	die "unable to initialise popup window\n";
		2052	}
1805	}	2053	}
1806		2054
1807	sub DESTROY {	2055	sub DESTROY {
1808	my ($self) = @_;	2056	my ($self) = @_;
1809		2057
…		…
1814	=back	2062	=back
1815		2063
1816	=cut	2064	=cut
1817		2065
1818	package urxvt::watcher;	2066	package urxvt::watcher;
1819
1820	@urxvt::timer::ISA = __PACKAGE__;
1821	@urxvt::iow::ISA = __PACKAGE__;
1822	@urxvt::pw::ISA = __PACKAGE__;
1823	@urxvt::iw::ISA = __PACKAGE__;
1824		2067
1825	=head2 The C<urxvt::timer> Class	2068	=head2 The C<urxvt::timer> Class
1826		2069
1827	This class implements timer watchers/events. Time is represented as a	2070	This class implements timer watchers/events. Time is represented as a
1828	fractional number of seconds since the epoch. Example:	2071	fractional number of seconds since the epoch. Example:
…		…
1832	->new	2075	->new
1833	->interval (1)	2076	->interval (1)
1834	->cb (sub {	2077	->cb (sub {
1835	$term->{overlay}->set (0, 0,	2078	$term->{overlay}->set (0, 0,
1836	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2079	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1837	});	2080	});
1838		2081
1839	=over 4	2082	=over 4
1840		2083
1841	=item $timer = new urxvt::timer	2084	=item $timer = new urxvt::timer
1842		2085
…		…
1845		2088
1846	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2089	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1847		2090
1848	Set the callback to be called when the timer triggers.	2091	Set the callback to be called when the timer triggers.
1849		2092
1850	=item $tstamp = $timer->at
1851
1852	Return the time this watcher will fire next.
1853
1854	=item $timer = $timer->set ($tstamp)	2093	=item $timer = $timer->set ($tstamp[, $interval])
1855		2094
1856	Set the time the event is generated to $tstamp.	2095	Set the time the event is generated to $tstamp (and optionally specifies a
		2096	new $interval).
1857		2097
1858	=item $timer = $timer->interval ($interval)	2098	=item $timer = $timer->interval ($interval)
1859		2099
1860	Normally (and when C<$interval> is C<0>), the timer will automatically	2100	By default (and when C<$interval> is C<0>), the timer will automatically
1861	stop after it has fired once. If C<$interval> is non-zero, then the timer	2101	stop after it has fired once. If C<$interval> is non-zero, then the timer
1862	is automatically rescheduled at the given intervals.	2102	is automatically rescheduled at the given intervals.
1863		2103
1864	=item $timer = $timer->start	2104	=item $timer = $timer->start
1865		2105
1866	Start the timer.	2106	Start the timer.
1867		2107
1868	=item $timer = $timer->start ($tstamp)	2108	=item $timer = $timer->start ($tstamp[, $interval])
1869		2109
1870	Set the event trigger time to C<$tstamp> and start the timer.	2110	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2111	also replaces the interval.
1871		2112
1872	=item $timer = $timer->after ($delay)	2113	=item $timer = $timer->after ($delay[, $interval])
1873		2114
1874	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2115	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1875		2116
1876	=item $timer = $timer->stop	2117	=item $timer = $timer->stop
1877		2118
…		…
1885		2126
1886	$term->{socket} = ...	2127	$term->{socket} = ...
1887	$term->{iow} = urxvt::iow	2128	$term->{iow} = urxvt::iow
1888	->new	2129	->new
1889	->fd (fileno $term->{socket})	2130	->fd (fileno $term->{socket})
1890	->events (urxvt::EVENT_READ)	2131	->events (urxvt::EV_READ)
1891	->start	2132	->start
1892	->cb (sub {	2133	->cb (sub {
1893	my ($iow, $revents) = @_;	2134	my ($iow, $revents) = @_;
1894	# $revents must be 1 here, no need to check	2135	# $revents must be 1 here, no need to check
1895	sysread $term->{socket}, my $buf, 8192	2136	sysread $term->{socket}, my $buf, 8192
…		…
1908	Set the callback to be called when io events are triggered. C<$reventmask>	2149	Set the callback to be called when io events are triggered. C<$reventmask>
1909	is a bitset as described in the C<events> method.	2150	is a bitset as described in the C<events> method.
1910		2151
1911	=item $iow = $iow->fd ($fd)	2152	=item $iow = $iow->fd ($fd)
1912		2153
1913	Set the filedescriptor (not handle) to watch.	2154	Set the file descriptor (not handle) to watch.
1914		2155
1915	=item $iow = $iow->events ($eventmask)	2156	=item $iow = $iow->events ($eventmask)
1916		2157
1917	Set the event mask to watch. The only allowed values are	2158	Set the event mask to watch. The only allowed values are
1918	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2159	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1919	together, or C<urxvt::EVENT_NONE>.	2160	together, or C<urxvt::EV_NONE>.
1920		2161
1921	=item $iow = $iow->start	2162	=item $iow = $iow->start
1922		2163
1923	Start watching for requested events on the given handle.	2164	Start watching for requested events on the given handle.
1924		2165
1925	=item $iow = $iow->stop	2166	=item $iow = $iow->stop
1926		2167
1927	Stop watching for events on the given filehandle.	2168	Stop watching for events on the given file handle.
1928		2169
1929	=back	2170	=back
1930		2171
1931	=head2 The C<urxvt::iw> Class	2172	=head2 The C<urxvt::iw> Class
1932		2173
…		…
1965	->new	2206	->new
1966	->start ($pid)	2207	->start ($pid)
1967	->cb (sub {	2208	->cb (sub {
1968	my ($pw, $exit_status) = @_;	2209	my ($pw, $exit_status) = @_;
1969	...	2210	...
1970	});	2211	});
1971		2212
1972	=over 4	2213	=over 4
1973		2214
1974	=item $pw = new urxvt::pw	2215	=item $pw = new urxvt::pw
1975		2216
…		…
1979		2220
1980	Set the callback to be called when the timer triggers.	2221	Set the callback to be called when the timer triggers.
1981		2222
1982	=item $pw = $timer->start ($pid)	2223	=item $pw = $timer->start ($pid)
1983		2224
1984	Tells the wqtcher to start watching for process C<$pid>.	2225	Tells the watcher to start watching for process C<$pid>.
1985		2226
1986	=item $pw = $pw->stop	2227	=item $pw = $pw->stop
1987		2228
1988	Stop the watcher.	2229	Stop the watcher.
1989		2230
…		…
2002		2243
2003	=item >= 3 - script loading and management	2244	=item >= 3 - script loading and management
2004		2245
2005	=item >=10 - all called hooks	2246	=item >=10 - all called hooks
2006		2247
2007	=item >=11 - hook reutrn values	2248	=item >=11 - hook return values
2008		2249
2009	=back	2250	=back
2010		2251
2011	=head1 AUTHOR	2252	=head1 AUTHOR
2012		2253
…		…
2014	http://software.schmorp.de/pkg/rxvt-unicode	2255	http://software.schmorp.de/pkg/rxvt-unicode
2015		2256
2016	=cut	2257	=cut
2017		2258
2018	1	2259	1
		2260
		2261	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC vs. Revision 1.188 by sf-exg, Sat Jul 24 13:04:27 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC vs.
Revision 1.188 by sf-exg, Sat Jul 24 13:04:27 2010 UTC