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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC vs.
Revision 1.199 by sf-exg, Sun Nov 20 10:49:56 2011 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,
…		…
217	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
218		244
219	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid	245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
220	indices.	246	indices.
221		247
222	=item mark-urls	248	=item matcher
223		249
224	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
225	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
226	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
227	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 or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
		268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
228		278
229	=item xim-onthespot	279	=item xim-onthespot
230		280
231	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
232	not work perfectly, and some input methods don't seem to work well with	282	not work perfectly, and some input methods don't seem to work well with
233	OnTheSpot editing in general, but it seems to work at leats for SCIM and	283	OnTheSpot editing in general, but it seems to work at least for SCIM and
234	kinput2.	284	kinput2.
235		285
236	You enable it by specifying this extension and a preedit style of	286	You enable it by specifying this extension and a preedit style of
237	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
238		288
239	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
240		290
241	=item automove-background	291	=item kuake<hotkey>
242		292
243	This is basically a one-line extension that dynamically changes the background pixmap offset	293	A very primitive quake-console-like extension. It was inspired by a
244	to the window position, in effect creating the same effect as pseudo transparency with	294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
245	a custom pixmap. No scaling is supported in this mode. Exmaple:	295	user presses a global accelerator key (by default C<F10>), the terminal
		296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
246		298
247	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	299	Initially, the window will not be shown when using this extension.
		300
		301	This is useful if you need a single terminal that is not using any desktop
		302	space most of the time but is quickly available at the press of a key.
		303
		304	The accelerator key is grabbed regardless of any modifiers, so this
		305	extension will actually grab a physical key just for this function.
		306
		307	If you want a quake-like animation, tell your window manager to do so
		308	(fvwm can do it).
		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
248		315
249	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
250		317
251	A not very useful example of filtering all text output to the terminal,	318	A not very useful example of filtering all text output to the terminal
252	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
253	similar-looking ascii character.	320	similar-looking ascii character.
254		321
255	=item digital-clock	322	=item digital-clock
256		323
257	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
258		325
259	=item remote-clipboard	326	=item remote-clipboard
260		327
261	Somewhat of a misnomer, this extension adds two menu entries to the	328	Somewhat of a misnomer, this extension adds two menu entries to the
262	selection popup that allows one ti run external commands to store the	329	selection popup that allows one to run external commands to store the
263	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
264		331
265	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
266	means that one command uploads the file to a remote server, and another	333	means that one command uploads the file to a remote server, and another
267	reads it.	334	reads it.
…		…
276	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
277	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
278		345
279	=item selection-pastebin	346	=item selection-pastebin
280		347
281	This is a little rarely useful extension that Uploads the selection as	348	This is a little rarely useful extension that uploads the selection as
282	textfile to a remote site (or does other things). (The implementation is	349	textfile to a remote site (or does other things). (The implementation is
283	not currently secure for use in a multiuser environment as it writes to	350	not currently secure for use in a multiuser environment as it writes to
284	F</tmp> directly.).	351	F</tmp> directly.).
285		352
286	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
303	in the C<selection-pastebin-url> resource (again, the % is the placeholder	370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
304	for the filename):	371	for the filename):
305		372
306	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
307		374
		375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		376	the double C</> characters as comment start. Use C<\057\057> instead,
		377	which works regardless of whether xrdb is used to parse the resource file
		378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
		393
308	=item example-refresh-hooks	394	=item example-refresh-hooks
309		395
310	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
311	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
312	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
313		412
314	=back	413	=back
315		414
316	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
317		416
…		…
333		432
334	=over 4	433	=over 4
335		434
336	=item $text	435	=item $text
337		436
338	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
339	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
340		439
341	=item $string	440	=item $string
342		441
343	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
351		450
352	=back	451	=back
353		452
354	=head2 Extension Objects	453	=head2 Extension Objects
355		454
356	Very perl extension is a perl class. A separate perl object is created	455	Every perl extension is a perl class. A separate perl object is created
357	for each terminal and each extension and passed as the first parameter to	456	for each terminal, and each terminal has its own set of extension objects,
358	hooks. So extensions can use their C<$self> object without having to think	457	which are passed as the first parameter to hooks. So extensions can use
359	about other extensions, with the exception of methods and members that	458	their C<$self> object without having to think about clashes with other
		459	extensions or other terminals, with the exception of methods and members
360	begin with an underscore character C<_>: these are reserved for internal	460	that begin with an underscore character C<_>: these are reserved for
361	use.	461	internal use.
362		462
363	Although it isn't a C<urxvt::term> object, you can call all methods of the	463	Although it isn't a C<urxvt::term> object, you can call all methods of the
364	C<urxvt::term> class on this object.	464	C<urxvt::term> class on this object.
365		465
366	It has the following methods and data members:	466	It has the following methods and data members:
…		…
387	=head2 Hooks	487	=head2 Hooks
388		488
389	The following subroutines can be declared in extension files, and will be	489	The following subroutines can be declared in extension files, and will be
390	called whenever the relevant event happens.	490	called whenever the relevant event happens.
391		491
392	The first argument passed to them is an extension oject as described in	492	The first argument passed to them is an extension object as described in
393	the in the C<Extension Objects> section.	493	the in the C<Extension Objects> section.
394		494
395	B<All> of these hooks must return a boolean value. If any of the called	495	B<All> of these hooks must return a boolean value. If any of the called
396	hooks returns true, then the event counts as being I<consumed>, and the	496	hooks returns true, then the event counts as being I<consumed>, and the
397	relevant action might not be carried out by the C++ code.	497	relevant action might not be carried out by the C++ code.
…		…
410	place.	510	place.
411		511
412	=item on_start $term	512	=item on_start $term
413		513
414	Called at the very end of initialisation of a new terminal, just before	514	Called at the very end of initialisation of a new terminal, just before
415	trying to map (display) the toplevel and returning to the mainloop.	515	trying to map (display) the toplevel and returning to the main loop.
416		516
417	=item on_destroy $term	517	=item on_destroy $term
418		518
419	Called whenever something tries to destroy terminal, when the terminal is	519	Called whenever something tries to destroy terminal, when the terminal is
420	still fully functional (not for long, though).	520	still fully functional (not for long, though).
…		…
447		547
448	Called whenever a selection has been copied, but before the selection is	548	Called whenever a selection has been copied, but before the selection is
449	requested from the server. The selection text can be queried and changed	549	requested from the server. The selection text can be queried and changed
450	by calling C<< $term->selection >>.	550	by calling C<< $term->selection >>.
451		551
452	Returning a true value aborts selection grabbing. It will still be hilighted.	552	Returning a true value aborts selection grabbing. It will still be highlighted.
453		553
454	=item on_sel_extend $term	554	=item on_sel_extend $term
455		555
456	Called whenever the user tries to extend the selection (e.g. with a double	556	Called whenever the user tries to extend the selection (e.g. with a double
457	click) and is either supposed to return false (normal operation), or	557	click) and is either supposed to return false (normal operation), or
458	should extend the selection itelf and return true to suppress the built-in	558	should extend the selection itself and return true to suppress the built-in
459	processing. This can happen multiple times, as long as the callback	559	processing. This can happen multiple times, as long as the callback
460	returns true, it will be called on every further click by the user and is	560	returns true, it will be called on every further click by the user and is
461	supposed to enlarge the selection more and more, if possible.	561	supposed to enlarge the selection more and more, if possible.
462		562
463	See the F<selection> example extension.	563	See the F<selection> example extension.
464		564
465	=item on_view_change $term, $offset	565	=item on_view_change $term, $offset
466		566
467	Called whenever the view offset changes, i..e the user or program	567	Called whenever the view offset changes, i.e. the user or program
468	scrolls. Offset C<0> means display the normal terminal, positive values	568	scrolls. Offset C<0> means display the normal terminal, positive values
469	show this many lines of scrollback.	569	show this many lines of scrollback.
470		570
471	=item on_scroll_back $term, $lines, $saved	571	=item on_scroll_back $term, $lines, $saved
472		572
…		…
476		576
477	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	577	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
478	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	578	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
479	number of lines that will be in the scrollback buffer.	579	number of lines that will be in the scrollback buffer.
480		580
481	=item on_osc_seq $term, $string	581	=item on_osc_seq $term, $op, $args, $resp
		582
		583	Called on every OSC sequence and can be used to suppress it or modify its
		584	behaviour. The default should be to return an empty list. A true value
		585	suppresses execution of the request completely. Make sure you don't get
		586	confused by recursive invocations when you output an OSC sequence within
		587	this callback.
		588
		589	C<on_osc_seq_perl> should be used for new behaviour.
		590
		591	=item on_osc_seq_perl $term, $args, $resp
482		592
483	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	593	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
484	operating system command) is processed. Cursor position and other state	594	operating system command) is processed. Cursor position and other state
485	information is up-to-date when this happens. For interoperability, the	595	information is up-to-date when this happens. For interoperability, the
486	string should start with the extension name and a colon, to distinguish	596	string should start with the extension name (sans -osc) and a semicolon,
487	it from commands for other extensions, and this might be enforced in the	597	to distinguish it from commands for other extensions, and this might be
488	future.	598	enforced in the future.
		599
		600	For example, C<overlay-osc> uses this:
		601
		602	sub on_osc_seq_perl {
		603	my ($self, $osc, $resp) = @_;
		604
		605	return unless $osc =~ s/^overlay;//;
		606
		607	... process remaining $osc string
		608	}
489		609
490	Be careful not ever to trust (in a security sense) the data you receive,	610	Be careful not ever to trust (in a security sense) the data you receive,
491	as its source can not easily be controleld (e-mail content, messages from	611	as its source can not easily be controlled (e-mail content, messages from
492	other users on the same system etc.).	612	other users on the same system etc.).
		613
		614	For responses, C<$resp> contains the end-of-args separator used by the
		615	sender.
493		616
494	=item on_add_lines $term, $string	617	=item on_add_lines $term, $string
495		618
496	Called whenever text is about to be output, with the text as argument. You	619	Called whenever text is about to be output, with the text as argument. You
497	can filter/change and output the text yourself by returning a true value	620	can filter/change and output the text yourself by returning a true value
…		…
502	=item on_tt_write $term, $octets	625	=item on_tt_write $term, $octets
503		626
504	Called whenever some data is written to the tty/pty and can be used to	627	Called whenever some data is written to the tty/pty and can be used to
505	suppress or filter tty input.	628	suppress or filter tty input.
506		629
		630	=item on_tt_paste $term, $octets
		631
		632	Called whenever text is about to be pasted, with the text as argument. You
		633	can filter/change and paste the text yourself by returning a true value
		634	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		635	locale-encoded.
		636
507	=item on_line_update $term, $row	637	=item on_line_update $term, $row
508		638
509	Called whenever a line was updated or changed. Can be used to filter	639	Called whenever a line was updated or changed. Can be used to filter
510	screen output (e.g. underline urls or other useless stuff). Only lines	640	screen output (e.g. underline urls or other useless stuff). Only lines
511	that are being shown will be filtered, and, due to performance reasons,	641	that are being shown will be filtered, and, due to performance reasons,
…		…
518	later with the already-modified line (e.g. if unrelated parts change), so	648	later with the already-modified line (e.g. if unrelated parts change), so
519	you cannot just toggle rendition bits, but only set them.	649	you cannot just toggle rendition bits, but only set them.
520		650
521	=item on_refresh_begin $term	651	=item on_refresh_begin $term
522		652
523	Called just before the screen gets redrawn. Can be used for overlay	653	Called just before the screen gets redrawn. Can be used for overlay or
524	or similar effects by modify terminal contents in refresh_begin, and	654	similar effects by modifying the terminal contents in refresh_begin, and
525	restoring them in refresh_end. The built-in overlay and selection display	655	restoring them in refresh_end. The built-in overlay and selection display
526	code is run after this hook, and takes precedence.	656	code is run after this hook, and takes precedence.
527		657
528	=item on_refresh_end $term	658	=item on_refresh_end $term
529		659
530	Called just after the screen gets redrawn. See C<on_refresh_begin>.	660	Called just after the screen gets redrawn. See C<on_refresh_begin>.
531		661
532	=item on_user_command $term, $string	662	=item on_user_command $term, $string
533		663
534	Called whenever the a user-configured event is being activated (e.g. via	664	Called whenever a user-configured event is being activated (e.g. via
535	a C<perl:string> action bound to a key, see description of the B<keysym>	665	a C<perl:string> action bound to a key, see description of the B<keysym>
536	resource in the @@RXVT_NAME@@(1) manpage).	666	resource in the @@RXVT_NAME@@(1) manpage).
537		667
538	The event is simply the action string. This interface is assumed to change	668	The event is simply the action string. This interface is assumed to change
539	slightly in the future.	669	slightly in the future.
		670
		671	=item on_resize_all_windows $term, $new_width, $new_height
		672
		673	Called just after the new window size has been calculated, but before
		674	windows are actually being resized or hints are being set. If this hook
		675	returns TRUE, setting of the window hints is being skipped.
540		676
541	=item on_x_event $term, $event	677	=item on_x_event $term, $event
542		678
543	Called on every X event received on the vt window (and possibly other	679	Called on every X event received on the vt window (and possibly other
544	windows). Should only be used as a last resort. Most event structure	680	windows). Should only be used as a last resort. Most event structure
545	members are not passed.	681	members are not passed.
546		682
		683	=item on_root_event $term, $event
		684
		685	Like C<on_x_event>, but is called for events on the root window.
		686
547	=item on_focus_in $term	687	=item on_focus_in $term
548		688
549	Called whenever the window gets the keyboard focus, before rxvt-unicode	689	Called whenever the window gets the keyboard focus, before rxvt-unicode
550	does focus in processing.	690	does focus in processing.
551		691
552	=item on_focus_out $term	692	=item on_focus_out $term
553		693
554	Called wheneever the window loses keyboard focus, before rxvt-unicode does	694	Called whenever the window loses keyboard focus, before rxvt-unicode does
555	focus out processing.	695	focus out processing.
556		696
557	=item on_configure_notify $term, $event	697	=item on_configure_notify $term, $event
558		698
559	=item on_property_notify $term, $event	699	=item on_property_notify $term, $event
…		…
570		710
571	=item on_map_notify $term, $event	711	=item on_map_notify $term, $event
572		712
573	=item on_unmap_notify $term, $event	713	=item on_unmap_notify $term, $event
574		714
575	Called whenever the corresponding X event is received for the terminal If	715	Called whenever the corresponding X event is received for the terminal. If
576	the hook returns true, then the even will be ignored by rxvt-unicode.	716	the hook returns true, then the event will be ignored by rxvt-unicode.
577		717
578	The event is a hash with most values as named by Xlib (see the XEvent	718	The event is a hash with most values as named by Xlib (see the XEvent
579	manpage), with the additional members C<row> and C<col>, which are the	719	manpage), with the additional members C<row> and C<col>, which are the
580	(real, not screen-based) row and column under the mouse cursor.	720	(real, not screen-based) row and column under the mouse cursor.
581		721
…		…
590		730
591	=item on_wm_delete_window $term, $event	731	=item on_wm_delete_window $term, $event
592		732
593	Called when various types of ClientMessage events are received (all with	733	Called when various types of ClientMessage events are received (all with
594	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	734	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		735
		736	=item on_bell $term
		737
		738	Called on receipt of a bell character.
595		739
596	=back	740	=back
597		741
598	=cut	742	=cut
599		743
…		…
642	The current terminal. This variable stores the current C<urxvt::term>	786	The current terminal. This variable stores the current C<urxvt::term>
643	object, whenever a callback/hook is executing.	787	object, whenever a callback/hook is executing.
644		788
645	=item @urxvt::TERM_INIT	789	=item @urxvt::TERM_INIT
646		790
647	All coderefs in this array will be called as methods of the next newly	791	All code references in this array will be called as methods of the next newly
648	created C<urxvt::term> object (during the C<on_init> phase). The array	792	created C<urxvt::term> object (during the C<on_init> phase). The array
649	gets cleared before the codereferences that were in it are being executed,	793	gets cleared before the code references that were in it are being executed,
650	so coderefs can push themselves onto it again if they so desire.	794	so references can push themselves onto it again if they so desire.
651		795
652	This complements to the perl-eval commandline option, but gets executed	796	This complements to the perl-eval command line option, but gets executed
653	first.	797	first.
654		798
655	=item @urxvt::TERM_EXT	799	=item @urxvt::TERM_EXT
656		800
657	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	801	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
664		808
665	=over 4	809	=over 4
666		810
667	=item urxvt::fatal $errormessage	811	=item urxvt::fatal $errormessage
668		812
669	Fatally aborts execution with the given error message. Avoid at all	813	Fatally aborts execution with the given error message (which should
670	costs! The only time this is acceptable is when the terminal process	814	include a trailing newline). Avoid at all costs! The only time this
671	starts up.	815	is acceptable (and useful) is in the init hook, where it prevents the
		816	terminal from starting up.
672		817
673	=item urxvt::warn $string	818	=item urxvt::warn $string
674		819
675	Calls C<rxvt_warn> with the given string which should not include a	820	Calls C<rxvt_warn> with the given string which should include a trailing
676	newline. The module also overwrites the C<warn> builtin with a function	821	newline. The module also overwrites the C<warn> builtin with a function
677	that calls this function.	822	that calls this function.
678		823
679	Using this function has the advantage that its output ends up in the	824	Using this function has the advantage that its output ends up in the
680	correct place, e.g. on stderr of the connecting urxvtc client.	825	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
682	Messages have a size limit of 1023 bytes currently.	827	Messages have a size limit of 1023 bytes currently.
683		828
684	=item @terms = urxvt::termlist	829	=item @terms = urxvt::termlist
685		830
686	Returns all urxvt::term objects that exist in this process, regardless of	831	Returns all urxvt::term objects that exist in this process, regardless of
687	wether they are started, being destroyed etc., so be careful. Only term	832	whether they are started, being destroyed etc., so be careful. Only term
688	objects that have perl extensions attached will be returned (because there	833	objects that have perl extensions attached will be returned (because there
689	is no urxvt::term objet associated with others).	834	is no urxvt::term object associated with others).
690		835
691	=item $time = urxvt::NOW	836	=item $time = urxvt::NOW
692		837
693	Returns the "current time" (as per the event loop).	838	Returns the "current time" (as per the event loop).
694		839
…		…
737		882
738	=item $rend = urxvt::OVERLAY_RSTYLE	883	=item $rend = urxvt::OVERLAY_RSTYLE
739		884
740	Return the rendition mask used for overlays by default.	885	Return the rendition mask used for overlays by default.
741		886
742	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	887	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		888	urxvt::RS_RVid, urxvt::RS_Uline
743		889
744	Return the bit that enabled bold, italic, blink, reverse-video and	890	Return the bit that enabled bold, italic, blink, reverse-video and
745	underline, respectively. To enable such a style, just logically OR it into	891	underline, respectively. To enable such a style, just logically OR it into
746	the bitset.	892	the bitset.
747		893
…		…
830	local $TERM = shift;	976	local $TERM = shift;
831	my $htype = shift;	977	my $htype = shift;
832		978
833	if ($htype == 0) { # INIT	979	if ($htype == 0) { # INIT
834	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	980	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
835		981
836	my %ext_arg;	982	my %ext_arg;
837		983
838	{	984	{
839	my @init = @TERM_INIT;	985	my @init = @TERM_INIT;
840	@TERM_INIT = ();	986	@TERM_INIT = ();
…		…
854	} else {	1000	} else {
855	$ext_arg{$_} \|\|= [];	1001	$ext_arg{$_} \|\|= [];
856	}	1002	}
857	}	1003	}
858		1004
859	while (my ($ext, $argv) = each %ext_arg) {	1005	for my $ext (sort keys %ext_arg) {
860	my @files = grep -f $_, map "$_/$ext", @dirs;	1006	my @files = grep -f $_, map "$_/$ext", @dirs;
861		1007
862	if (@files) {	1008	if (@files) {
863	$TERM->register_package (extension_package $files[0], $argv);	1009	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
864	} else {	1010	} else {
865	warn "perl extension '$ext' not found in perl library search path\n";	1011	warn "perl extension '$ext' not found in perl library search path\n";
866	}	1012	}
867	}	1013	}
868		1014
…		…
874		1020
875	if (my $cb = $TERM->{_hook}[$htype]) {	1021	if (my $cb = $TERM->{_hook}[$htype]) {
876	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1022	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
877	if $verbosity >= 10;	1023	if $verbosity >= 10;
878		1024
879	keys %$cb;	1025	for my $pkg (keys %$cb) {
880
881	while (my ($pkg, $cb) = each %$cb) {
882	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1026	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
883	$retval \|\|= $retval_;	1027	$retval \|\|= $retval_;
884		1028
885	if ($@) {	1029	if ($@) {
886	$TERM->ungrab; # better to lose the grab than the session	1030	$TERM->ungrab; # better to lose the grab than the session
887	warn $@;	1031	warn $@;
…		…
903	$retval	1047	$retval
904	}	1048	}
905		1049
906	sub SET_COLOR($$$) {	1050	sub SET_COLOR($$$) {
907	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1051	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1052	}
		1053
		1054	sub rend2mask {
		1055	no strict 'refs';
		1056	my ($str, $mask) = (@_, 0);
		1057	my %color = ( fg => undef, bg => undef );
		1058	my @failed;
		1059	for my $spec ( split /\s+/, $str ) {
		1060	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1061	$color{lc($1)} = $2;
		1062	} else {
		1063	my $neg = $spec =~ s/^[-^]//;
		1064	unless ( exists &{"RS_$spec"} ) {
		1065	push @failed, $spec;
		1066	next;
		1067	}
		1068	my $cur = &{"RS_$spec"};
		1069	if ( $neg ) {
		1070	$mask &= ~$cur;
		1071	} else {
		1072	$mask \|= $cur;
		1073	}
		1074	}
		1075	}
		1076	($mask, @color{qw(fg bg)}, \@failed)
908	}	1077	}
909		1078
910	# urxvt::term::extension	1079	# urxvt::term::extension
911		1080
912	package urxvt::term::extension;	1081	package urxvt::term::extension;
…		…
983	is that you cannot use blocking APIs, but the non-blocking variant should	1152	is that you cannot use blocking APIs, but the non-blocking variant should
984	work.	1153	work.
985		1154
986	=cut	1155	=cut
987		1156
988	our $VERSION = 1;	1157	our $VERSION = '5.23';
989		1158
990	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1159	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
991	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1160	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
992		1161
993	sub timer {	1162	sub timer {
…		…
995		1164
996	my $cb = $arg{cb};	1165	my $cb = $arg{cb};
997		1166
998	urxvt::timer	1167	urxvt::timer
999	->new	1168	->new
1000	->start (urxvt::NOW + $arg{after})	1169	->after ($arg{after}, $arg{interval})
1001	->cb (sub {	1170	->cb ($arg{interval} ? $cb : sub {
1002	$_[0]->stop; # need to cancel manually	1171	$_[0]->stop; # need to cancel manually
1003	$cb->();	1172	$cb->();
1004	})	1173	})
1005	}	1174	}
1006		1175
1007	sub io {	1176	sub io {
1008	my ($class, %arg) = @_;	1177	my ($class, %arg) = @_;
1009		1178
1010	my $cb = $arg{cb};	1179	my $cb = $arg{cb};
		1180	my $fd = fileno $arg{fh};
		1181	defined $fd or $fd = $arg{fh};
1011		1182
1012	bless [$arg{fh}, urxvt::iow	1183	bless [$arg{fh}, urxvt::iow
1013	->new	1184	->new
1014	->fd (fileno $arg{fh})	1185	->fd ($fd)
1015	->events (($arg{poll} =~ /r/ ? 1 : 0)	1186	->events (($arg{poll} =~ /r/ ? 1 : 0)
1016	\| ($arg{poll} =~ /w/ ? 2 : 0))	1187	\| ($arg{poll} =~ /w/ ? 2 : 0))
1017	->start	1188	->start
1018	->cb (sub {	1189	->cb ($cb)
1019	$cb->(($_[1] & 1 ? 'r' : '')
1020	. ($_[1] & 2 ? 'w' : ''));
1021	})],
1022	urxvt::anyevent::	1190	], urxvt::anyevent::
		1191	}
		1192
		1193	sub idle {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::iw
		1199	->new
		1200	->start
		1201	->cb ($cb)
		1202	}
		1203
		1204	sub child {
		1205	my ($class, %arg) = @_;
		1206
		1207	my $cb = $arg{cb};
		1208
		1209	urxvt::pw
		1210	->new
		1211	->start ($arg{pid})
		1212	->cb (sub {
		1213	$_[0]->stop; # need to cancel manually
		1214	$cb->($_[0]->rpid, $_[0]->rstatus);
		1215	})
1023	}	1216	}
1024		1217
1025	sub DESTROY {	1218	sub DESTROY {
1026	$_[0][1]->stop;	1219	$_[0][1]->stop;
1027	}	1220	}
1028		1221
1029	sub condvar {	1222	# only needed for AnyEvent < 6 compatibility
1030	bless \my $flag, urxvt::anyevent::condvar::	1223	sub one_event {
1031	}
1032
1033	sub urxvt::anyevent::condvar::broadcast {
1034	${$_[0]}++;
1035	}
1036
1037	sub urxvt::anyevent::condvar::wait {
1038	unless (${$_[0]}) {
1039	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1224	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1040	}
1041	}	1225	}
1042		1226
1043	package urxvt::term;	1227	package urxvt::term;
1044		1228
1045	=head2 The C<urxvt::term> Class	1229	=head2 The C<urxvt::term> Class
…		…
1132		1316
1133	Returns true if the option specified by C<$optval> is enabled, and	1317	Returns true if the option specified by C<$optval> is enabled, and
1134	optionally change it. All option values are stored by name in the hash	1318	optionally change it. All option values are stored by name in the hash
1135	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1319	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1136		1320
1137	Here is a a likely non-exhaustive list of option names, please see the	1321	Here is a likely non-exhaustive list of option names, please see the
1138	source file F</src/optinc.h> to see the actual list:	1322	source file F</src/optinc.h> to see the actual list:
1139		1323
1140	borderLess console cursorBlink cursorUnderline hold iconic insecure	1324	borderLess buffered console cursorBlink cursorUnderline hold iconic
1141	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1325	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1142	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1326	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1143	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1327	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1144	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1328	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1145	transparent tripleclickwords utmpInhibit visualBell	1329	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1330	urgentOnBell utmpInhibit visualBell
1146		1331
1147	=item $value = $term->resource ($name[, $newval])	1332	=item $value = $term->resource ($name[, $newval])
1148		1333
1149	Returns the current resource value associated with a given name and	1334	Returns the current resource value associated with a given name and
1150	optionally sets a new value. Setting values is most useful in the C<init>	1335	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1159	likely change).	1344	likely change).
1160		1345
1161	Please note that resource strings will currently only be freed when the	1346	Please note that resource strings will currently only be freed when the
1162	terminal is destroyed, so changing options frequently will eat memory.	1347	terminal is destroyed, so changing options frequently will eat memory.
1163		1348
1164	Here is a a likely non-exhaustive list of resource names, not all of which	1349	Here is a likely non-exhaustive list of resource names, not all of which
1165	are supported in every build, please see the source file F</src/rsinc.h>	1350	are supported in every build, please see the source file F</src/rsinc.h>
1166	to see the actual list:	1351	to see the actual list:
1167		1352
1168	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1353	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1169	borderLess color cursorBlink cursorUnderline cutchars delete_key	1354	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1170	display_name embed ext_bwidth fade font geometry hold iconName	1355	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1171	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1356	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1357	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1172	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1358	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1173	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1359	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1174	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1360	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1175	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1361	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1176	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1362	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1177	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1363	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1178	secondaryScreen secondaryScroll selectstyle shade term_name title	1364	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1179	transient_for transparent transparent_all tripleclickwords utmpInhibit	1365	term_name title transient_for transparent tripleclickwords urgentOnBell
1180	visualBell	1366	utmpInhibit visualBell
1181		1367
1182	=cut	1368	=cut
1183		1369
1184	sub resource($$;$) {	1370	sub resource($$;$) {
1185	my ($self, $name) = (shift, shift);	1371	my ($self, $name) = (shift, shift);
1186	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1372	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1187	&urxvt::term::_resource	1373	goto &urxvt::term::_resource
1188	}	1374	}
1189		1375
1190	=item $value = $term->x_resource ($pattern)	1376	=item $value = $term->x_resource ($pattern)
1191		1377
1192	Returns the X-Resource for the given pattern, excluding the program or	1378	Returns the X-Resource for the given pattern, excluding the program or
…		…
1217		1403
1218	=item ($row, $col) = $term->selection_beg ([$row, $col])	1404	=item ($row, $col) = $term->selection_beg ([$row, $col])
1219		1405
1220	=item ($row, $col) = $term->selection_end ([$row, $col])	1406	=item ($row, $col) = $term->selection_end ([$row, $col])
1221		1407
1222	Return the current values of the selection mark, begin or end positions,	1408	Return the current values of the selection mark, begin or end positions.
1223	and optionally set them to new values.	1409
		1410	When arguments are given, then the selection coordinates are set to
		1411	C<$row> and C<$col>, and the selection screen is set to the current
		1412	screen.
		1413
		1414	=item $screen = $term->selection_screen ([$screen])
		1415
		1416	Returns the current selection screen, and then optionally sets it.
1224		1417
1225	=item $term->selection_make ($eventtime[, $rectangular])	1418	=item $term->selection_make ($eventtime[, $rectangular])
1226		1419
1227	Tries to make a selection as set by C<selection_beg> and	1420	Tries to make a selection as set by C<selection_beg> and
1228	C<selection_end>. If C<$rectangular> is true (default: false), a	1421	C<selection_end>. If C<$rectangular> is true (default: false), a
1229	rectangular selection will be made. This is the prefered function to make	1422	rectangular selection will be made. This is the preferred function to make
1230	a selection.	1423	a selection.
1231		1424
1232	=item $success = $term->selection_grab ($eventtime)	1425	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1233		1426
1234	Try to request the primary selection text from the server (for example, as	1427	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1428	true) selection from the server. The corresponding text can be set
1235	set by the next method). No visual feedback will be given. This function	1429	with the next method. No visual feedback will be given. This function
1236	is mostly useful from within C<on_sel_grab> hooks.	1430	is mostly useful from within C<on_sel_grab> hooks.
1237		1431
1238	=item $oldtext = $term->selection ([$newtext])	1432	=item $oldtext = $term->selection ([$newtext, $clipboard])
1239		1433
1240	Return the current selection text and optionally replace it by C<$newtext>.	1434	Return the current selection (clipboard if C<$clipboard> is true) text
		1435	and optionally replace it by C<$newtext>.
		1436
		1437	=item $term->selection_clear ([$clipboard])
		1438
		1439	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1241		1440
1242	=item $term->overlay_simple ($x, $y, $text)	1441	=item $term->overlay_simple ($x, $y, $text)
1243		1442
1244	Create a simple multi-line overlay box. See the next method for details.	1443	Create a simple multi-line overlay box. See the next method for details.
1245		1444
…		…
1275		1474
1276	The methods currently supported on C<urxvt::overlay> objects are:	1475	The methods currently supported on C<urxvt::overlay> objects are:
1277		1476
1278	=over 4	1477	=over 4
1279		1478
1280	=item $overlay->set ($x, $y, $text, $rend)	1479	=item $overlay->set ($x, $y, $text[, $rend])
1281		1480
1282	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1481	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1283	text in rxvt-unicode's special encoding and an array of rendition values	1482	text in rxvt-unicode's special encoding and an array of rendition values
1284	at a specific position inside the overlay.	1483	at a specific position inside the overlay.
		1484
		1485	If C<$rend> is missing, then the rendition will not be changed.
1285		1486
1286	=item $overlay->hide	1487	=item $overlay->hide
1287		1488
1288	If visible, hide the overlay, but do not destroy it.	1489	If visible, hide the overlay, but do not destroy it.
1289		1490
…		…
1371	locale-specific encoding of the terminal and can contain command sequences	1572	locale-specific encoding of the terminal and can contain command sequences
1372	(escape codes) that will be interpreted.	1573	(escape codes) that will be interpreted.
1373		1574
1374	=item $term->tt_write ($octets)	1575	=item $term->tt_write ($octets)
1375		1576
1376	Write the octets given in C<$data> to the tty (i.e. as program input). To	1577	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1377	pass characters instead of octets, you should convert your strings first	1578	pass characters instead of octets, you should convert your strings first
1378	to the locale-specific encoding using C<< $term->locale_encode >>.	1579	to the locale-specific encoding using C<< $term->locale_encode >>.
		1580
		1581	=item $term->tt_paste ($octets)
		1582
		1583	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1584	CR and bracketing the data with control sequences if bracketed paste mode
		1585	is set.
1379		1586
1380	=item $old_events = $term->pty_ev_events ([$new_events])	1587	=item $old_events = $term->pty_ev_events ([$new_events])
1381		1588
1382	Replaces the event mask of the pty watcher by the given event mask. Can	1589	Replaces the event mask of the pty watcher by the given event mask. Can
1383	be used to suppress input and output handling to the pty/tty. See the	1590	be used to suppress input and output handling to the pty/tty. See the
…		…
1451	=item $env = $term->env	1658	=item $env = $term->env
1452		1659
1453	Returns a copy of the environment in effect for the terminal as a hashref	1660	Returns a copy of the environment in effect for the terminal as a hashref
1454	similar to C<\%ENV>.	1661	similar to C<\%ENV>.
1455		1662
		1663	=item @envv = $term->envv
		1664
		1665	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1666
		1667	=item @argv = $term->argv
		1668
		1669	Return the argument vector as this terminal, similar to @ARGV, but
		1670	includes the program name as first element.
		1671
1456	=cut	1672	=cut
1457		1673
1458	sub env {	1674	sub env {
1459	if (my $env = $_[0]->_env) {
1460	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1675	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1461	} else {
1462	+{ %ENV }
1463	}
1464	}	1676	}
1465		1677
1466	=item $modifiermask = $term->ModLevel3Mask	1678	=item $modifiermask = $term->ModLevel3Mask
1467		1679
1468	=item $modifiermask = $term->ModMetaMask	1680	=item $modifiermask = $term->ModMetaMask
…		…
1476		1688
1477	Returns the currently displayed screen (0 primary, 1 secondary).	1689	Returns the currently displayed screen (0 primary, 1 secondary).
1478		1690
1479	=item $cursor_is_hidden = $term->hidden_cursor	1691	=item $cursor_is_hidden = $term->hidden_cursor
1480		1692
1481	Returns wether the cursor is currently hidden or not.	1693	Returns whether the cursor is currently hidden or not.
1482		1694
1483	=item $view_start = $term->view_start ([$newvalue])	1695	=item $view_start = $term->view_start ([$newvalue])
1484		1696
1485	Returns the row number of the topmost displayed line. Maximum value is	1697	Returns the row number of the topmost displayed line. Maximum value is
1486	C<0>, which displays the normal terminal contents. Lower values scroll	1698	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1494		1706
1495	Used after changing terminal contents to display them.	1707	Used after changing terminal contents to display them.
1496		1708
1497	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1709	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1498		1710
1499	Returns the text of the entire row with number C<$row_number>. Row C<0>	1711	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1500	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1712	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1501	terminal line. The scrollback buffer starts at line C<-1> and extends to
1502	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1713	terminal line. Nothing will be returned if a nonexistent line
1503	is requested.	1714	is requested.
1504		1715
1505	If C<$new_text> is specified, it will replace characters in the current	1716	If C<$new_text> is specified, it will replace characters in the current
1506	line, starting at column C<$start_col> (default C<0>), which is useful	1717	line, starting at column C<$start_col> (default C<0>), which is useful
1507	to replace only parts of a line. The font index in the rendition will	1718	to replace only parts of a line. The font index in the rendition will
1508	automatically be updated.	1719	automatically be updated.
1509		1720
1510	C<$text> is in a special encoding: tabs and wide characters that use more	1721	C<$text> is in a special encoding: tabs and wide characters that use more
1511	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1722	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1512	characters. Characters with combining characters and other characters that	1723	characters. Characters with combining characters and other characters that
1513	do not fit into the normal tetx encoding will be replaced with characters	1724	do not fit into the normal text encoding will be replaced with characters
1514	in the private use area.	1725	in the private use area.
1515		1726
1516	You have to obey this encoding when changing text. The advantage is	1727	You have to obey this encoding when changing text. The advantage is
1517	that C<substr> and similar functions work on screen cells and not on	1728	that C<substr> and similar functions work on screen cells and not on
1518	characters.	1729	characters.
…		…
1663	where one character corresponds to one screen cell. See	1874	where one character corresponds to one screen cell. See
1664	C<< $term->ROW_t >> for details.	1875	C<< $term->ROW_t >> for details.
1665		1876
1666	=item $string = $term->special_decode $text	1877	=item $string = $term->special_decode $text
1667		1878
1668	Converts rxvt-unicodes text reprsentation into a perl string. See	1879	Converts rxvt-unicodes text representation into a perl string. See
1669	C<< $term->ROW_t >> for details.	1880	C<< $term->ROW_t >> for details.
1670		1881
1671	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1882	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1672		1883
1673	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1884	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1676	manpage.	1887	manpage.
1677		1888
1678	=item $success = $term->grab ($eventtime[, $sync])	1889	=item $success = $term->grab ($eventtime[, $sync])
1679		1890
1680	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1891	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1681	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1892	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1682		1893
1683	=item $term->allow_events_async	1894	=item $term->allow_events_async
1684		1895
1685	Calls XAllowEvents with AsyncBoth for the most recent grab.	1896	Calls XAllowEvents with AsyncBoth for the most recent grab.
1686		1897
…		…
1693	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1904	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1694	recent grab.	1905	recent grab.
1695		1906
1696	=item $term->ungrab	1907	=item $term->ungrab
1697		1908
1698	Calls XUngrab for the most recent grab. Is called automatically on	1909	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1699	evaluation errors, as it is better to lose the grab in the error case as	1910	evaluation errors, as it is better to lose the grab in the error case as
1700	the session.	1911	the session.
1701		1912
1702	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1913	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1703		1914
…		…
1705		1916
1706	=item @atoms = $term->XListProperties ($window)	1917	=item @atoms = $term->XListProperties ($window)
1707		1918
1708	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1919	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1709		1920
1710	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1921	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1711		1922
1712	=item $term->XDeleteProperty ($window, $property)	1923	=item $term->XDeleteProperty ($window, $property)
1713		1924
1714	=item $window = $term->DefaultRootWindow	1925	=item $window = $term->DefaultRootWindow
1715		1926
…		…
1725		1936
1726	=item $term->XChangeInput ($window, $add_events[, $del_events])	1937	=item $term->XChangeInput ($window, $add_events[, $del_events])
1727		1938
1728	Various X or X-related functions. The C<$term> object only serves as	1939	Various X or X-related functions. The C<$term> object only serves as
1729	the source of the display, otherwise those functions map more-or-less	1940	the source of the display, otherwise those functions map more-or-less
1730	directory onto the X functions of the same name.	1941	directly onto the X functions of the same name.
1731		1942
1732	=back	1943	=back
1733		1944
1734	=cut	1945	=cut
1735		1946
…		…
1799	my ($self, $text, $cb) = @_;	2010	my ($self, $text, $cb) = @_;
1800		2011
1801	$self->add_item ({ type => "button", text => $text, activate => $cb});	2012	$self->add_item ({ type => "button", text => $text, activate => $cb});
1802	}	2013	}
1803		2014
1804	=item $popup->add_toggle ($text, $cb, $initial_value)	2015	=item $popup->add_toggle ($text, $initial_value, $cb)
1805		2016
1806	Adds a toggle/checkbox item to the popup. Teh callback gets called	2017	Adds a toggle/checkbox item to the popup. The callback gets called
1807	whenever it gets toggled, with a boolean indicating its value as its first	2018	whenever it gets toggled, with a boolean indicating its new value as its
1808	argument.	2019	first argument.
1809		2020
1810	=cut	2021	=cut
1811		2022
1812	sub add_toggle {	2023	sub add_toggle {
1813	my ($self, $text, $cb, $value) = @_;	2024	my ($self, $text, $value, $cb) = @_;
1814		2025
1815	my $item; $item = {	2026	my $item; $item = {
1816	type => "button",	2027	type => "button",
1817	text => " $text",	2028	text => " $text",
1818	value => $value,	2029	value => $value,
…		…
1837	my $env = $self->{term}->env;	2048	my $env = $self->{term}->env;
1838	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2049	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1839	delete $env->{LC_ALL};	2050	delete $env->{LC_ALL};
1840	$env->{LC_CTYPE} = $self->{term}->locale;	2051	$env->{LC_CTYPE} = $self->{term}->locale;
1841		2052
1842	urxvt::term->new ($env, "popup",	2053	my $term = urxvt::term->new (
		2054	$env, "popup",
1843	"--perl-lib" => "", "--perl-ext-common" => "",	2055	"--perl-lib" => "", "--perl-ext-common" => "",
1844	"-pty-fd" => -1, "-sl" => 0,	2056	"-pty-fd" => -1, "-sl" => 0,
1845	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2057	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1846	"--transient-for" => $self->{term}->parent,	2058	"--transient-for" => $self->{term}->parent,
1847	"-display" => $self->{term}->display_id,	2059	"-display" => $self->{term}->display_id,
1848	"-pe" => "urxvt-popup")	2060	"-pe" => "urxvt-popup",
1849	or die "unable to create popup window\n";	2061	) or die "unable to create popup window\n";
		2062
		2063	unless (delete $term->{urxvt_popup_init_done}) {
		2064	$term->ungrab;
		2065	$term->destroy;
		2066	die "unable to initialise popup window\n";
		2067	}
1850	}	2068	}
1851		2069
1852	sub DESTROY {	2070	sub DESTROY {
1853	my ($self) = @_;	2071	my ($self) = @_;
1854		2072
…		…
1859	=back	2077	=back
1860		2078
1861	=cut	2079	=cut
1862		2080
1863	package urxvt::watcher;	2081	package urxvt::watcher;
1864
1865	@urxvt::timer::ISA = __PACKAGE__;
1866	@urxvt::iow::ISA = __PACKAGE__;
1867	@urxvt::pw::ISA = __PACKAGE__;
1868	@urxvt::iw::ISA = __PACKAGE__;
1869		2082
1870	=head2 The C<urxvt::timer> Class	2083	=head2 The C<urxvt::timer> Class
1871		2084
1872	This class implements timer watchers/events. Time is represented as a	2085	This class implements timer watchers/events. Time is represented as a
1873	fractional number of seconds since the epoch. Example:	2086	fractional number of seconds since the epoch. Example:
…		…
1877	->new	2090	->new
1878	->interval (1)	2091	->interval (1)
1879	->cb (sub {	2092	->cb (sub {
1880	$term->{overlay}->set (0, 0,	2093	$term->{overlay}->set (0, 0,
1881	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2094	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1882	});	2095	});
1883		2096
1884	=over 4	2097	=over 4
1885		2098
1886	=item $timer = new urxvt::timer	2099	=item $timer = new urxvt::timer
1887		2100
…		…
1890		2103
1891	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2104	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1892		2105
1893	Set the callback to be called when the timer triggers.	2106	Set the callback to be called when the timer triggers.
1894		2107
1895	=item $tstamp = $timer->at
1896
1897	Return the time this watcher will fire next.
1898
1899	=item $timer = $timer->set ($tstamp)	2108	=item $timer = $timer->set ($tstamp[, $interval])
1900		2109
1901	Set the time the event is generated to $tstamp.	2110	Set the time the event is generated to $tstamp (and optionally specifies a
		2111	new $interval).
1902		2112
1903	=item $timer = $timer->interval ($interval)	2113	=item $timer = $timer->interval ($interval)
1904		2114
1905	Normally (and when C<$interval> is C<0>), the timer will automatically	2115	By default (and when C<$interval> is C<0>), the timer will automatically
1906	stop after it has fired once. If C<$interval> is non-zero, then the timer	2116	stop after it has fired once. If C<$interval> is non-zero, then the timer
1907	is automatically rescheduled at the given intervals.	2117	is automatically rescheduled at the given intervals.
1908		2118
1909	=item $timer = $timer->start	2119	=item $timer = $timer->start
1910		2120
1911	Start the timer.	2121	Start the timer.
1912		2122
1913	=item $timer = $timer->start ($tstamp)	2123	=item $timer = $timer->start ($tstamp[, $interval])
1914		2124
1915	Set the event trigger time to C<$tstamp> and start the timer.	2125	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2126	also replaces the interval.
1916		2127
1917	=item $timer = $timer->after ($delay)	2128	=item $timer = $timer->after ($delay[, $interval])
1918		2129
1919	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2130	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1920		2131
1921	=item $timer = $timer->stop	2132	=item $timer = $timer->stop
1922		2133
…		…
1930		2141
1931	$term->{socket} = ...	2142	$term->{socket} = ...
1932	$term->{iow} = urxvt::iow	2143	$term->{iow} = urxvt::iow
1933	->new	2144	->new
1934	->fd (fileno $term->{socket})	2145	->fd (fileno $term->{socket})
1935	->events (urxvt::EVENT_READ)	2146	->events (urxvt::EV_READ)
1936	->start	2147	->start
1937	->cb (sub {	2148	->cb (sub {
1938	my ($iow, $revents) = @_;	2149	my ($iow, $revents) = @_;
1939	# $revents must be 1 here, no need to check	2150	# $revents must be 1 here, no need to check
1940	sysread $term->{socket}, my $buf, 8192	2151	sysread $term->{socket}, my $buf, 8192
…		…
1953	Set the callback to be called when io events are triggered. C<$reventmask>	2164	Set the callback to be called when io events are triggered. C<$reventmask>
1954	is a bitset as described in the C<events> method.	2165	is a bitset as described in the C<events> method.
1955		2166
1956	=item $iow = $iow->fd ($fd)	2167	=item $iow = $iow->fd ($fd)
1957		2168
1958	Set the filedescriptor (not handle) to watch.	2169	Set the file descriptor (not handle) to watch.
1959		2170
1960	=item $iow = $iow->events ($eventmask)	2171	=item $iow = $iow->events ($eventmask)
1961		2172
1962	Set the event mask to watch. The only allowed values are	2173	Set the event mask to watch. The only allowed values are
1963	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2174	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1964	together, or C<urxvt::EVENT_NONE>.	2175	together, or C<urxvt::EV_NONE>.
1965		2176
1966	=item $iow = $iow->start	2177	=item $iow = $iow->start
1967		2178
1968	Start watching for requested events on the given handle.	2179	Start watching for requested events on the given handle.
1969		2180
1970	=item $iow = $iow->stop	2181	=item $iow = $iow->stop
1971		2182
1972	Stop watching for events on the given filehandle.	2183	Stop watching for events on the given file handle.
1973		2184
1974	=back	2185	=back
1975		2186
1976	=head2 The C<urxvt::iw> Class	2187	=head2 The C<urxvt::iw> Class
1977		2188
…		…
2010	->new	2221	->new
2011	->start ($pid)	2222	->start ($pid)
2012	->cb (sub {	2223	->cb (sub {
2013	my ($pw, $exit_status) = @_;	2224	my ($pw, $exit_status) = @_;
2014	...	2225	...
2015	});	2226	});
2016		2227
2017	=over 4	2228	=over 4
2018		2229
2019	=item $pw = new urxvt::pw	2230	=item $pw = new urxvt::pw
2020		2231
…		…
2024		2235
2025	Set the callback to be called when the timer triggers.	2236	Set the callback to be called when the timer triggers.
2026		2237
2027	=item $pw = $timer->start ($pid)	2238	=item $pw = $timer->start ($pid)
2028		2239
2029	Tells the wqtcher to start watching for process C<$pid>.	2240	Tells the watcher to start watching for process C<$pid>.
2030		2241
2031	=item $pw = $pw->stop	2242	=item $pw = $pw->stop
2032		2243
2033	Stop the watcher.	2244	Stop the watcher.
2034		2245
…		…
2047		2258
2048	=item >= 3 - script loading and management	2259	=item >= 3 - script loading and management
2049		2260
2050	=item >=10 - all called hooks	2261	=item >=10 - all called hooks
2051		2262
2052	=item >=11 - hook reutrn values	2263	=item >=11 - hook return values
2053		2264
2054	=back	2265	=back
2055		2266
2056	=head1 AUTHOR	2267	=head1 AUTHOR
2057		2268
2058	Marc Lehmann <pcg@goof.com>	2269	Marc Lehmann <schmorp@schmorp.de>
2059	http://software.schmorp.de/pkg/rxvt-unicode	2270	http://software.schmorp.de/pkg/rxvt-unicode
2060		2271
2061	=cut	2272	=cut
2062		2273
2063	1	2274	1
		2275
		2276	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC vs. Revision 1.199 by sf-exg, Sun Nov 20 10:49:56 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC vs.
Revision 1.199 by sf-exg, Sun Nov 20 10:49:56 2011 UTC