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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.130 by root, Wed Jan 25 15:32:48 2006 UTC vs.
Revision 1.183 by sf-exg, Wed Mar 31 13:14:50 2010 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:	71	between two vertical bars:
69		72
70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
71		74
72	Another example: Programs I use often output "absolute path: " at the	75	Another example: Programs I use often output "absolute path: " at the
…		…
94	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
95		98
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.	100	runtime.
98		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
99	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
100		120
101	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
102	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
103	evaluation, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
104		124
105	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107	popup is displayed.	127	popup is being displayed.
108		128
109	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
110	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
111	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
112	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
113	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
114		134
115	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
116	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
117	C<a>s:	137	C<a>s:
118		138
119	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
120	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
121	: ()	141	: ()
122	};	142	};
123		143
124	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
125		145
…		…
132	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
133	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
134	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
135	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
136	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
137	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
138		164
139	=item readline (enabled by default)	165	=item readline (enabled by default)
140		166
141	A support package that tries to make editing with readline easier. At the	167	A support package that tries to make editing with readline easier. At
142	moment, it reacts to clicking with the left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
143	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
144	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
145	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
146		172
147	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
148		174
149	=over 4	175	=over 4
…		…
197	the message into vi commands to load the file.	223	the message into vi commands to load the file.
198		224
199	=item tabbed	225	=item tabbed
200		226
201	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204	button per tab.	230	button per tab.
205		231
206	Clicking a button will activate that tab. Pressing B<Shift-Left> and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
207	B<Shift-Right> will switch to the tab left or right of the current one,	233	B<Shift-Right> will switch to the tab left or right of the current one,
208	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
209		235
210	=item mark-urls	236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
211		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
212	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
213	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
214	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
215	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
216		276
217	=item xim-onthespot	277	=item xim-onthespot
218		278
219	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
220	not work perfectly, and some input methods don't seem to work well with	280	not work perfectly, and some input methods don't seem to work well with
221	OnTheSpot editing in general, but it seems to work at leats for SCIM and	281	OnTheSpot editing in general, but it seems to work at least for SCIM and
222	kinput2.	282	kinput2.
223		283
224	You enable it by specifying this extension and a preedit style of	284	You enable it by specifying this extension and a preedit style of
225	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
226		286
227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
228		288
229	=item automove-background	289	=item kuake<hotkey>
230		290
231	This is basically a one-line extension that dynamically changes the background pixmap offset	291	A very primitive quake-console-like extension. It was inspired by a
232	to the window position, in effect creating the same effect as pseudo transparency with	292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
233	a custom pixmap. No scaling is supported in this mode. Exmaple:	293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
234		296
235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
236		313
237	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
238		315
239	A not very useful example of filtering all text output to the terminal,	316	A not very useful example of filtering all text output to the terminal
240	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
241	similar-looking ascii character.	318	similar-looking ascii character.
242		319
243	=item digital-clock	320	=item digital-clock
244		321
245	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
246		323
247	=item remote-clipboard	324	=item remote-clipboard
248		325
249	Somewhat of a misnomer, this extension adds two menu entries to the	326	Somewhat of a misnomer, this extension adds two menu entries to the
250	selection popup that allows one ti run external commands to store the	327	selection popup that allows one to run external commands to store the
251	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
252		329
253	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
254	means that one command uploads the file to a remote server, and another	331	means that one command uploads the file to a remote server, and another
255	reads it.	332	reads it.
…		…
264	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
265	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
266		343
267	=item selection-pastebin	344	=item selection-pastebin
268		345
269	This is a little rarely useful extension that Uploads the selection as	346	This is a little rarely useful extension that uploads the selection as
270	textfile to a remote site (or does other things). (The implementation is	347	textfile to a remote site (or does other things). (The implementation is
271	not currently secure for use in a multiuser environment as it writes to	348	not currently secure for use in a multiuser environment as it writes to
272	F</tmp> directly.).	349	F</tmp> directly.).
273		350
274	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
290	After a successful upload the selection will be replaced by the text given	367	After a successful upload the selection will be replaced by the text given
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/%
		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.
295		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
…		…
321		417
322	=over 4	418	=over 4
323		419
324	=item $text	420	=item $text
325		421
326	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	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.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
328		424
329	=item $string	425	=item $string
330		426
331	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
339		435
340	=back	436	=back
341		437
342	=head2 Extension Objects	438	=head2 Extension Objects
343		439
344	Very perl extension is a perl class. A separate perl object is created	440	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	441	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	442	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	443	their C<$self> object without having to think about clashes with other
		444	extensions or other terminals, with the exception of methods and members
348	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
349	use.	446	internal use.
350		447
351	Although it isn't a C<urxvt::term> object, you can call all methods of the	448	Although it isn't a C<urxvt::term> object, you can call all methods of the
352	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
353		450
354	It has the following methods and data members:	451	It has the following methods and data members:
…		…
375	=head2 Hooks	472	=head2 Hooks
376		473
377	The following subroutines can be declared in extension files, and will be	474	The following subroutines can be declared in extension files, and will be
378	called whenever the relevant event happens.	475	called whenever the relevant event happens.
379		476
380	The first argument passed to them is an extension oject as described in	477	The first argument passed to them is an extension object as described in
381	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
382		479
383	B<All> of these hooks must return a boolean value. If any of the called	480	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	481	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.	482	relevant action might not be carried out by the C++ code.
…		…
398	place.	495	place.
399		496
400	=item on_start $term	497	=item on_start $term
401		498
402	Called at the very end of initialisation of a new terminal, just before	499	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.	500	trying to map (display) the toplevel and returning to the main loop.
404		501
405	=item on_destroy $term	502	=item on_destroy $term
406		503
407	Called whenever something tries to destroy terminal, when the terminal is	504	Called whenever something tries to destroy terminal, when the terminal is
408	still fully functional (not for long, though).	505	still fully functional (not for long, though).
…		…
435		532
436	Called whenever a selection has been copied, but before the selection is	533	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	534	requested from the server. The selection text can be queried and changed
438	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
439		536
440	Returning a true value aborts selection grabbing. It will still be hilighted.	537	Returning a true value aborts selection grabbing. It will still be highlighted.
441		538
442	=item on_sel_extend $term	539	=item on_sel_extend $term
443		540
444	Called whenever the user tries to extend the selection (e.g. with a double	541	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	542	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	543	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	544	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	545	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.	546	supposed to enlarge the selection more and more, if possible.
450		547
451	See the F<selection> example extension.	548	See the F<selection> example extension.
452		549
453	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
454		551
455	Called whenever the view offset changes, i..e the user or program	552	Called whenever the view offset changes, i.e. the user or program
456	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
457	show this many lines of scrollback.	554	show this many lines of scrollback.
458		555
459	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
460		557
…		…
464		561
465	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	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	563	$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.	564	number of lines that will be in the scrollback buffer.
468		565
469	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
		567
		568	Called on every OSC sequence and can be used to suppress it or modify its
		569	behaviour. The default should be to return an empty list. A true value
		570	suppresses execution of the request completely. Make sure you don't get
		571	confused by recursive invocations when you output an OSC sequence within
		572	this callback.
		573
		574	C<on_osc_seq_perl> should be used for new behaviour.
		575
		576	=item on_osc_seq_perl $term, $args, $resp
470		577
471	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
472	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
473	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
474	string should start with the extension name and a colon, to distinguish	581	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	582	to distinguish it from commands for other extensions, and this might be
476	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
477		594
478	Be careful not ever to trust (in a security sense) the data you receive,	595	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	596	as its source can not easily be controlled (e-mail content, messages from
480	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
481		601
482	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
483		603
484	Called whenever text is about to be output, with the text as argument. You	604	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	605	can filter/change and output the text yourself by returning a true value
…		…
506	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
507	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
508		628
509	=item on_refresh_begin $term	629	=item on_refresh_begin $term
510		630
511	Called just before the screen gets redrawn. Can be used for overlay	631	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	632	similar effects by modifying the terminal contents in refresh_begin, and
513	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
514	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
515		635
516	=item on_refresh_end $term	636	=item on_refresh_end $term
517		637
518	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
519		639
520	=item on_user_command $term, $string	640	=item on_user_command $term, $string
521		641
522	Called whenever the a user-configured event is being activated (e.g. via	642	Called whenever a user-configured event is being activated (e.g. via
523	a C<perl:string> action bound to a key, see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
524	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
525		645
526	The event is simply the action string. This interface is assumed to change	646	The event is simply the action string. This interface is assumed to change
527	slightly in the future.	647	slightly in the future.
		648
		649	=item on_resize_all_windows $tern, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
528		654
529	=item on_x_event $term, $event	655	=item on_x_event $term, $event
530		656
531	Called on every X event received on the vt window (and possibly other	657	Called on every X event received on the vt window (and possibly other
532	windows). Should only be used as a last resort. Most event structure	658	windows). Should only be used as a last resort. Most event structure
533	members are not passed.	659	members are not passed.
534		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
		664
535	=item on_focus_in $term	665	=item on_focus_in $term
536		666
537	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
538	does focus in processing.	668	does focus in processing.
539		669
540	=item on_focus_out $term	670	=item on_focus_out $term
541		671
542	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
543	focus out processing.	673	focus out processing.
544		674
545	=item on_configure_notify $term, $event	675	=item on_configure_notify $term, $event
546		676
547	=item on_property_notify $term, $event	677	=item on_property_notify $term, $event
…		…
558		688
559	=item on_map_notify $term, $event	689	=item on_map_notify $term, $event
560		690
561	=item on_unmap_notify $term, $event	691	=item on_unmap_notify $term, $event
562		692
563	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal. If
564	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the event will be ignored by rxvt-unicode.
565		695
566	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
567	manpage), with the additional members C<row> and C<col>, which are the	697	manpage), with the additional members C<row> and C<col>, which are the
568	(real, not screen-based) row and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
569		699
…		…
578		708
579	=item on_wm_delete_window $term, $event	709	=item on_wm_delete_window $term, $event
580		710
581	Called when various types of ClientMessage events are received (all with	711	Called when various types of ClientMessage events are received (all with
582	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		713
		714	=item on_bell $term
		715
		716	Called on receipt of a bell character.
583		717
584	=back	718	=back
585		719
586	=cut	720	=cut
587		721
…		…
630	The current terminal. This variable stores the current C<urxvt::term>	764	The current terminal. This variable stores the current C<urxvt::term>
631	object, whenever a callback/hook is executing.	765	object, whenever a callback/hook is executing.
632		766
633	=item @urxvt::TERM_INIT	767	=item @urxvt::TERM_INIT
634		768
635	All coderefs in this array will be called as methods of the next newly	769	All code references in this array will be called as methods of the next newly
636	created C<urxvt::term> object (during the C<on_init> phase). The array	770	created C<urxvt::term> object (during the C<on_init> phase). The array
637	gets cleared before the codereferences that were in it are being executed,	771	gets cleared before the code references that were in it are being executed,
638	so coderefs can push themselves onto it again if they so desire.	772	so references can push themselves onto it again if they so desire.
639		773
640	This complements to the perl-eval commandline option, but gets executed	774	This complements to the perl-eval command line option, but gets executed
641	first.	775	first.
642		776
643	=item @urxvt::TERM_EXT	777	=item @urxvt::TERM_EXT
644		778
645	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	779	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
666		800
667	Using this function has the advantage that its output ends up in the	801	Using this function has the advantage that its output ends up in the
668	correct place, e.g. on stderr of the connecting urxvtc client.	802	correct place, e.g. on stderr of the connecting urxvtc client.
669		803
670	Messages have a size limit of 1023 bytes currently.	804	Messages have a size limit of 1023 bytes currently.
		805
		806	=item @terms = urxvt::termlist
		807
		808	Returns all urxvt::term objects that exist in this process, regardless of
		809	whether they are started, being destroyed etc., so be careful. Only term
		810	objects that have perl extensions attached will be returned (because there
		811	is no urxvt::term objet associated with others).
671		812
672	=item $time = urxvt::NOW	813	=item $time = urxvt::NOW
673		814
674	Returns the "current time" (as per the event loop).	815	Returns the "current time" (as per the event loop).
675		816
…		…
733	Return the foreground/background colour index, respectively.	874	Return the foreground/background colour index, respectively.
734		875
735	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	876	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
736		877
737	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	878	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		879
		880	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
738		881
739	Replace the foreground/background colour in the rendition mask with the	882	Replace the foreground/background colour in the rendition mask with the
740	specified one.	883	specified one.
741		884
742	=item $value = urxvt::GET_CUSTOM $rend	885	=item $value = urxvt::GET_CUSTOM $rend
…		…
809	local $TERM = shift;	952	local $TERM = shift;
810	my $htype = shift;	953	my $htype = shift;
811		954
812	if ($htype == 0) { # INIT	955	if ($htype == 0) { # INIT
813	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	956	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
814		957
815	my %ext_arg;	958	my %ext_arg;
816		959
817	{	960	{
818	my @init = @TERM_INIT;	961	my @init = @TERM_INIT;
819	@TERM_INIT = ();	962	@TERM_INIT = ();
…		…
833	} else {	976	} else {
834	$ext_arg{$_} \|\|= [];	977	$ext_arg{$_} \|\|= [];
835	}	978	}
836	}	979	}
837		980
838	while (my ($ext, $argv) = each %ext_arg) {	981	for my $ext (sort keys %ext_arg) {
839	my @files = grep -f $_, map "$_/$ext", @dirs;	982	my @files = grep -f $_, map "$_/$ext", @dirs;
840		983
841	if (@files) {	984	if (@files) {
842	$TERM->register_package (extension_package $files[0], $argv);	985	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
843	} else {	986	} else {
844	warn "perl extension '$ext' not found in perl library search path\n";	987	warn "perl extension '$ext' not found in perl library search path\n";
845	}	988	}
846	}	989	}
847		990
…		…
853		996
854	if (my $cb = $TERM->{_hook}[$htype]) {	997	if (my $cb = $TERM->{_hook}[$htype]) {
855	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	998	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
856	if $verbosity >= 10;	999	if $verbosity >= 10;
857		1000
858	keys %$cb;	1001	for my $pkg (keys %$cb) {
859
860	while (my ($pkg, $cb) = each %$cb) {
861	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1002	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
862	$retval \|\|= $retval_;	1003	$retval \|\|= $retval_;
863		1004
864	if ($@) {	1005	if ($@) {
865	$TERM->ungrab; # better to lose the grab than the session	1006	$TERM->ungrab; # better to lose the grab than the session
866	warn $@;	1007	warn $@;
…		…
878	# clear package	1019	# clear package
879	%$TERM = ();	1020	%$TERM = ();
880	}	1021	}
881		1022
882	$retval	1023	$retval
		1024	}
		1025
		1026	sub SET_COLOR($$$) {
		1027	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1028	}
		1029
		1030	sub rend2mask {
		1031	no strict 'refs';
		1032	my ($str, $mask) = (@_, 0);
		1033	my %color = ( fg => undef, bg => undef );
		1034	my @failed;
		1035	for my $spec ( split /\s+/, $str ) {
		1036	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1037	$color{lc($1)} = $2;
		1038	} else {
		1039	my $neg = $spec =~ s/^[-^]//;
		1040	unless ( exists &{"RS_$spec"} ) {
		1041	push @failed, $spec;
		1042	next;
		1043	}
		1044	my $cur = &{"RS_$spec"};
		1045	if ( $neg ) {
		1046	$mask &= ~$cur;
		1047	} else {
		1048	$mask \|= $cur;
		1049	}
		1050	}
		1051	}
		1052	($mask, @color{qw(fg bg)}, \@failed)
883	}	1053	}
884		1054
885	# urxvt::term::extension	1055	# urxvt::term::extension
886		1056
887	package urxvt::term::extension;	1057	package urxvt::term::extension;
…		…
958	is that you cannot use blocking APIs, but the non-blocking variant should	1128	is that you cannot use blocking APIs, but the non-blocking variant should
959	work.	1129	work.
960		1130
961	=cut	1131	=cut
962		1132
963	our $VERSION = 1;	1133	our $VERSION = '5.23';
964		1134
965	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1135	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
966	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1136	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
967		1137
968	sub timer {	1138	sub timer {
…		…
970		1140
971	my $cb = $arg{cb};	1141	my $cb = $arg{cb};
972		1142
973	urxvt::timer	1143	urxvt::timer
974	->new	1144	->new
975	->start (urxvt::NOW + $arg{after})	1145	->after ($arg{after}, $arg{interval})
976	->cb (sub {	1146	->cb ($arg{interval} ? $cb : sub {
977	$_[0]->stop; # need to cancel manually	1147	$_[0]->stop; # need to cancel manually
978	$cb->();	1148	$cb->();
979	})	1149	})
980	}	1150	}
981		1151
982	sub io {	1152	sub io {
983	my ($class, %arg) = @_;	1153	my ($class, %arg) = @_;
984		1154
985	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
		1156	my $fd = fileno $arg{fh};
		1157	defined $fd or $fd = $arg{fh};
986		1158
987	bless [$arg{fh}, urxvt::iow	1159	bless [$arg{fh}, urxvt::iow
988	->new	1160	->new
989	->fd (fileno $arg{fh})	1161	->fd ($fd)
990	->events (($arg{poll} =~ /r/ ? 1 : 0)	1162	->events (($arg{poll} =~ /r/ ? 1 : 0)
991	\| ($arg{poll} =~ /w/ ? 2 : 0))	1163	\| ($arg{poll} =~ /w/ ? 2 : 0))
992	->start	1164	->start
993	->cb (sub {	1165	->cb ($cb)
994	$cb->(($_[1] & 1 ? 'r' : '')
995	. ($_[1] & 2 ? 'w' : ''));
996	})],
997	urxvt::anyevent::	1166	], urxvt::anyevent::
		1167	}
		1168
		1169	sub idle {
		1170	my ($class, %arg) = @_;
		1171
		1172	my $cb = $arg{cb};
		1173
		1174	urxvt::iw
		1175	->new
		1176	->start
		1177	->cb ($cb)
		1178	}
		1179
		1180	sub child {
		1181	my ($class, %arg) = @_;
		1182
		1183	my $cb = $arg{cb};
		1184
		1185	urxvt::pw
		1186	->new
		1187	->start ($arg{pid})
		1188	->cb (sub {
		1189	$_[0]->stop; # need to cancel manually
		1190	$cb->($_[0]->rpid, $_[0]->rstatus);
		1191	})
998	}	1192	}
999		1193
1000	sub DESTROY {	1194	sub DESTROY {
1001	$_[0][1]->stop;	1195	$_[0][1]->stop;
1002	}	1196	}
1003		1197
1004	sub condvar {	1198	sub one_event {
1005	bless \my $flag, urxvt::anyevent::condvar::
1006	}
1007
1008	sub urxvt::anyevent::condvar::broadcast {
1009	${$_[0]}++;
1010	}
1011
1012	sub urxvt::anyevent::condvar::wait {
1013	unless (${$_[0]}) {
1014	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1199	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1015	}
1016	}	1200	}
1017		1201
1018	package urxvt::term;	1202	package urxvt::term;
1019		1203
1020	=head2 The C<urxvt::term> Class	1204	=head2 The C<urxvt::term> Class
…		…
1056	hash which defines the environment of the new terminal.	1240	hash which defines the environment of the new terminal.
1057		1241
1058	Croaks (and probably outputs an error message) if the new instance	1242	Croaks (and probably outputs an error message) if the new instance
1059	couldn't be created. Returns C<undef> if the new instance didn't	1243	couldn't be created. Returns C<undef> if the new instance didn't
1060	initialise perl, and the terminal object otherwise. The C<init> and	1244	initialise perl, and the terminal object otherwise. The C<init> and
1061	C<start> hooks will be called during this call.	1245	C<start> hooks will be called before this call returns, and are free to
		1246	refer to global data (which is race free).
1062		1247
1063	=cut	1248	=cut
1064		1249
1065	sub new {	1250	sub new {
1066	my ($class, $env, @args) = @_;	1251	my ($class, $env, @args) = @_;
1067		1252
		1253	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1254	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1255
1068	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1256	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1069	}	1257	}
1070		1258
1071	=item $term->destroy	1259	=item $term->destroy
1072		1260
1073	Destroy the terminal object (close the window, free resources	1261	Destroy the terminal object (close the window, free resources
…		…
1103		1291
1104	Returns true if the option specified by C<$optval> is enabled, and	1292	Returns true if the option specified by C<$optval> is enabled, and
1105	optionally change it. All option values are stored by name in the hash	1293	optionally change it. All option values are stored by name in the hash
1106	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1294	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1107		1295
1108	Here is a a likely non-exhaustive list of option names, please see the	1296	Here is a likely non-exhaustive list of option names, please see the
1109	source file F</src/optinc.h> to see the actual list:	1297	source file F</src/optinc.h> to see the actual list:
1110		1298
1111	borderLess console cursorBlink cursorUnderline hold iconic insecure	1299	borderLess console cursorBlink cursorUnderline hold iconic insecure
1112	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1300	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1113	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1301	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1130	likely change).	1318	likely change).
1131		1319
1132	Please note that resource strings will currently only be freed when the	1320	Please note that resource strings will currently only be freed when the
1133	terminal is destroyed, so changing options frequently will eat memory.	1321	terminal is destroyed, so changing options frequently will eat memory.
1134		1322
1135	Here is a a likely non-exhaustive list of resource names, not all of which	1323	Here is a likely non-exhaustive list of resource names, not all of which
1136	are supported in every build, please see the source file F</src/rsinc.h>	1324	are supported in every build, please see the source file F</src/rsinc.h>
1137	to see the actual list:	1325	to see the actual list:
1138		1326
1139	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1327	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1140	borderLess color cursorBlink cursorUnderline cutchars delete_key	1328	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1141	display_name embed ext_bwidth fade font geometry hold iconName	1329	display_name embed ext_bwidth fade font geometry hold iconName
1142	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1330	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1143	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1331	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1144	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1332	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1145	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1333	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1146	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1334	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1147	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1335	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1148	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1336	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1149	secondaryScreen secondaryScroll selectstyle shade term_name title	1337	secondaryScreen secondaryScroll shade term_name title
1150	transient_for transparent transparent_all tripleclickwords utmpInhibit	1338	transient_for transparent transparent_all tripleclickwords utmpInhibit
1151	visualBell	1339	visualBell
1152		1340
1153	=cut	1341	=cut
1154		1342
1155	sub resource($$;$) {	1343	sub resource($$;$) {
1156	my ($self, $name) = (shift, shift);	1344	my ($self, $name) = (shift, shift);
1157	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1345	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1158	&urxvt::term::_resource	1346	goto &urxvt::term::_resource
1159	}	1347	}
1160		1348
1161	=item $value = $term->x_resource ($pattern)	1349	=item $value = $term->x_resource ($pattern)
1162		1350
1163	Returns the X-Resource for the given pattern, excluding the program or	1351	Returns the X-Resource for the given pattern, excluding the program or
…		…
1188		1376
1189	=item ($row, $col) = $term->selection_beg ([$row, $col])	1377	=item ($row, $col) = $term->selection_beg ([$row, $col])
1190		1378
1191	=item ($row, $col) = $term->selection_end ([$row, $col])	1379	=item ($row, $col) = $term->selection_end ([$row, $col])
1192		1380
1193	Return the current values of the selection mark, begin or end positions,	1381	Return the current values of the selection mark, begin or end positions.
1194	and optionally set them to new values.	1382
		1383	When arguments are given, then the selection coordinates are set to
		1384	C<$row> and C<$col>, and the selection screen is set to the current
		1385	screen.
		1386
		1387	=item $screen = $term->selection_screen ([$screen])
		1388
		1389	Returns the current selection screen, and then optionally sets it.
1195		1390
1196	=item $term->selection_make ($eventtime[, $rectangular])	1391	=item $term->selection_make ($eventtime[, $rectangular])
1197		1392
1198	Tries to make a selection as set by C<selection_beg> and	1393	Tries to make a selection as set by C<selection_beg> and
1199	C<selection_end>. If C<$rectangular> is true (default: false), a	1394	C<selection_end>. If C<$rectangular> is true (default: false), a
…		…
1246		1441
1247	The methods currently supported on C<urxvt::overlay> objects are:	1442	The methods currently supported on C<urxvt::overlay> objects are:
1248		1443
1249	=over 4	1444	=over 4
1250		1445
1251	=item $overlay->set ($x, $y, $text, $rend)	1446	=item $overlay->set ($x, $y, $text[, $rend])
1252		1447
1253	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1448	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1254	text in rxvt-unicode's special encoding and an array of rendition values	1449	text in rxvt-unicode's special encoding and an array of rendition values
1255	at a specific position inside the overlay.	1450	at a specific position inside the overlay.
		1451
		1452	If C<$rend> is missing, then the rendition will not be changed.
1256		1453
1257	=item $overlay->hide	1454	=item $overlay->hide
1258		1455
1259	If visible, hide the overlay, but do not destroy it.	1456	If visible, hide the overlay, but do not destroy it.
1260		1457
…		…
1373	Adds the specified events to the vt event mask. Useful e.g. when you want	1570	Adds the specified events to the vt event mask. Useful e.g. when you want
1374	to receive pointer events all the times:	1571	to receive pointer events all the times:
1375		1572
1376	$term->vt_emask_add (urxvt::PointerMotionMask);	1573	$term->vt_emask_add (urxvt::PointerMotionMask);
1377		1574
		1575	=item $term->focus_in
		1576
		1577	=item $term->focus_out
		1578
		1579	=item $term->key_press ($state, $keycode[, $time])
		1580
		1581	=item $term->key_release ($state, $keycode[, $time])
		1582
		1583	Deliver various fake events to to terminal.
		1584
1378	=item $window_width = $term->width	1585	=item $window_width = $term->width
1379		1586
1380	=item $window_height = $term->height	1587	=item $window_height = $term->height
1381		1588
1382	=item $font_width = $term->fwidth	1589	=item $font_width = $term->fwidth
…		…
1412	=item $env = $term->env	1619	=item $env = $term->env
1413		1620
1414	Returns a copy of the environment in effect for the terminal as a hashref	1621	Returns a copy of the environment in effect for the terminal as a hashref
1415	similar to C<\%ENV>.	1622	similar to C<\%ENV>.
1416		1623
		1624	=item @envv = $term->envv
		1625
		1626	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1627
		1628	=item @argv = $term->argv
		1629
		1630	Return the argument vector as this terminal, similar to @ARGV, but
		1631	includes the program name as first element.
		1632
1417	=cut	1633	=cut
1418		1634
1419	sub env {	1635	sub env {
1420	if (my $env = $_[0]->_env) {
1421	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1636	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1422	} else {
1423	+{ %ENV }
1424	}
1425	}	1637	}
1426		1638
1427	=item $modifiermask = $term->ModLevel3Mask	1639	=item $modifiermask = $term->ModLevel3Mask
1428		1640
1429	=item $modifiermask = $term->ModMetaMask	1641	=item $modifiermask = $term->ModMetaMask
…		…
1437		1649
1438	Returns the currently displayed screen (0 primary, 1 secondary).	1650	Returns the currently displayed screen (0 primary, 1 secondary).
1439		1651
1440	=item $cursor_is_hidden = $term->hidden_cursor	1652	=item $cursor_is_hidden = $term->hidden_cursor
1441		1653
1442	Returns wether the cursor is currently hidden or not.	1654	Returns whether the cursor is currently hidden or not.
1443		1655
1444	=item $view_start = $term->view_start ([$newvalue])	1656	=item $view_start = $term->view_start ([$newvalue])
1445		1657
1446	Returns the row number of the topmost displayed line. Maximum value is	1658	Returns the row number of the topmost displayed line. Maximum value is
1447	C<0>, which displays the normal terminal contents. Lower values scroll	1659	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1455		1667
1456	Used after changing terminal contents to display them.	1668	Used after changing terminal contents to display them.
1457		1669
1458	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1670	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1459		1671
1460	Returns the text of the entire row with number C<$row_number>. Row C<0>	1672	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1461	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1673	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1462	terminal line. The scrollback buffer starts at line C<-1> and extends to
1463	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1674	terminal line. Nothing will be returned if a nonexistent line
1464	is requested.	1675	is requested.
1465		1676
1466	If C<$new_text> is specified, it will replace characters in the current	1677	If C<$new_text> is specified, it will replace characters in the current
1467	line, starting at column C<$start_col> (default C<0>), which is useful	1678	line, starting at column C<$start_col> (default C<0>), which is useful
1468	to replace only parts of a line. The font index in the rendition will	1679	to replace only parts of a line. The font index in the rendition will
1469	automatically be updated.	1680	automatically be updated.
1470		1681
1471	C<$text> is in a special encoding: tabs and wide characters that use more	1682	C<$text> is in a special encoding: tabs and wide characters that use more
1472	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1683	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1473	characters. Characters with combining characters and other characters that	1684	characters. Characters with combining characters and other characters that
1474	do not fit into the normal tetx encoding will be replaced with characters	1685	do not fit into the normal text encoding will be replaced with characters
1475	in the private use area.	1686	in the private use area.
1476		1687
1477	You have to obey this encoding when changing text. The advantage is	1688	You have to obey this encoding when changing text. The advantage is
1478	that C<substr> and similar functions work on screen cells and not on	1689	that C<substr> and similar functions work on screen cells and not on
1479	characters.	1690	characters.
…		…
1624	where one character corresponds to one screen cell. See	1835	where one character corresponds to one screen cell. See
1625	C<< $term->ROW_t >> for details.	1836	C<< $term->ROW_t >> for details.
1626		1837
1627	=item $string = $term->special_decode $text	1838	=item $string = $term->special_decode $text
1628		1839
1629	Converts rxvt-unicodes text reprsentation into a perl string. See	1840	Converts rxvt-unicodes text representation into a perl string. See
1630	C<< $term->ROW_t >> for details.	1841	C<< $term->ROW_t >> for details.
1631		1842
1632	=item $success = $term->grab_button ($button, $modifiermask)	1843	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1633		1844
		1845	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1846
1634	Registers a synchronous button grab. See the XGrabButton manpage.	1847	Register/unregister a synchronous button grab. See the XGrabButton
		1848	manpage.
1635		1849
1636	=item $success = $term->grab ($eventtime[, $sync])	1850	=item $success = $term->grab ($eventtime[, $sync])
1637		1851
1638	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1852	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1639	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1853	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1640		1854
1641	=item $term->allow_events_async	1855	=item $term->allow_events_async
1642		1856
1643	Calls XAllowEvents with AsyncBoth for the most recent grab.	1857	Calls XAllowEvents with AsyncBoth for the most recent grab.
1644		1858
…		…
1651	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1865	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1652	recent grab.	1866	recent grab.
1653		1867
1654	=item $term->ungrab	1868	=item $term->ungrab
1655		1869
1656	Calls XUngrab for the most recent grab. Is called automatically on	1870	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1657	evaluation errors, as it is better to lose the grab in the error case as	1871	evaluation errors, as it is better to lose the grab in the error case as
1658	the session.	1872	the session.
1659		1873
1660	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1874	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1661		1875
…		…
1663		1877
1664	=item @atoms = $term->XListProperties ($window)	1878	=item @atoms = $term->XListProperties ($window)
1665		1879
1666	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1880	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1667		1881
1668	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1882	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1669		1883
1670	=item $term->XDeleteProperty ($window, $property)	1884	=item $term->XDeleteProperty ($window, $property)
1671		1885
1672	=item $window = $term->DefaultRootWindow	1886	=item $window = $term->DefaultRootWindow
1673		1887
…		…
1683		1897
1684	=item $term->XChangeInput ($window, $add_events[, $del_events])	1898	=item $term->XChangeInput ($window, $add_events[, $del_events])
1685		1899
1686	Various X or X-related functions. The C<$term> object only serves as	1900	Various X or X-related functions. The C<$term> object only serves as
1687	the source of the display, otherwise those functions map more-or-less	1901	the source of the display, otherwise those functions map more-or-less
1688	directory onto the X functions of the same name.	1902	directly onto the X functions of the same name.
1689		1903
1690	=back	1904	=back
1691		1905
1692	=cut	1906	=cut
1693		1907
…		…
1757	my ($self, $text, $cb) = @_;	1971	my ($self, $text, $cb) = @_;
1758		1972
1759	$self->add_item ({ type => "button", text => $text, activate => $cb});	1973	$self->add_item ({ type => "button", text => $text, activate => $cb});
1760	}	1974	}
1761		1975
1762	=item $popup->add_toggle ($text, $cb, $initial_value)	1976	=item $popup->add_toggle ($text, $initial_value, $cb)
1763		1977
1764	Adds a toggle/checkbox item to the popup. Teh callback gets called	1978	Adds a toggle/checkbox item to the popup. The callback gets called
1765	whenever it gets toggled, with a boolean indicating its value as its first	1979	whenever it gets toggled, with a boolean indicating its new value as its
1766	argument.	1980	first argument.
1767		1981
1768	=cut	1982	=cut
1769		1983
1770	sub add_toggle {	1984	sub add_toggle {
1771	my ($self, $text, $cb, $value) = @_;	1985	my ($self, $text, $value, $cb) = @_;
1772		1986
1773	my $item; $item = {	1987	my $item; $item = {
1774	type => "button",	1988	type => "button",
1775	text => " $text",	1989	text => " $text",
1776	value => $value,	1990	value => $value,
…		…
1795	my $env = $self->{term}->env;	2009	my $env = $self->{term}->env;
1796	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2010	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1797	delete $env->{LC_ALL};	2011	delete $env->{LC_ALL};
1798	$env->{LC_CTYPE} = $self->{term}->locale;	2012	$env->{LC_CTYPE} = $self->{term}->locale;
1799		2013
1800	urxvt::term->new ($env, "popup",	2014	my $term = urxvt::term->new (
		2015	$env, "popup",
1801	"--perl-lib" => "", "--perl-ext-common" => "",	2016	"--perl-lib" => "", "--perl-ext-common" => "",
1802	"-pty-fd" => -1, "-sl" => 0,	2017	"-pty-fd" => -1, "-sl" => 0,
1803	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2018	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1804	"--transient-for" => $self->{term}->parent,	2019	"--transient-for" => $self->{term}->parent,
1805	"-display" => $self->{term}->display_id,	2020	"-display" => $self->{term}->display_id,
1806	"-pe" => "urxvt-popup")	2021	"-pe" => "urxvt-popup",
1807	or die "unable to create popup window\n";	2022	) or die "unable to create popup window\n";
		2023
		2024	unless (delete $term->{urxvt_popup_init_done}) {
		2025	$term->ungrab;
		2026	$term->destroy;
		2027	die "unable to initialise popup window\n";
		2028	}
1808	}	2029	}
1809		2030
1810	sub DESTROY {	2031	sub DESTROY {
1811	my ($self) = @_;	2032	my ($self) = @_;
1812		2033
…		…
1817	=back	2038	=back
1818		2039
1819	=cut	2040	=cut
1820		2041
1821	package urxvt::watcher;	2042	package urxvt::watcher;
1822
1823	@urxvt::timer::ISA = __PACKAGE__;
1824	@urxvt::iow::ISA = __PACKAGE__;
1825	@urxvt::pw::ISA = __PACKAGE__;
1826	@urxvt::iw::ISA = __PACKAGE__;
1827		2043
1828	=head2 The C<urxvt::timer> Class	2044	=head2 The C<urxvt::timer> Class
1829		2045
1830	This class implements timer watchers/events. Time is represented as a	2046	This class implements timer watchers/events. Time is represented as a
1831	fractional number of seconds since the epoch. Example:	2047	fractional number of seconds since the epoch. Example:
…		…
1835	->new	2051	->new
1836	->interval (1)	2052	->interval (1)
1837	->cb (sub {	2053	->cb (sub {
1838	$term->{overlay}->set (0, 0,	2054	$term->{overlay}->set (0, 0,
1839	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2055	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1840	});	2056	});
1841		2057
1842	=over 4	2058	=over 4
1843		2059
1844	=item $timer = new urxvt::timer	2060	=item $timer = new urxvt::timer
1845		2061
…		…
1848		2064
1849	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2065	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1850		2066
1851	Set the callback to be called when the timer triggers.	2067	Set the callback to be called when the timer triggers.
1852		2068
1853	=item $tstamp = $timer->at
1854
1855	Return the time this watcher will fire next.
1856
1857	=item $timer = $timer->set ($tstamp)	2069	=item $timer = $timer->set ($tstamp[, $interval])
1858		2070
1859	Set the time the event is generated to $tstamp.	2071	Set the time the event is generated to $tstamp (and optionally specifies a
		2072	new $interval).
1860		2073
1861	=item $timer = $timer->interval ($interval)	2074	=item $timer = $timer->interval ($interval)
1862		2075
1863	Normally (and when C<$interval> is C<0>), the timer will automatically	2076	By default (and when C<$interval> is C<0>), the timer will automatically
1864	stop after it has fired once. If C<$interval> is non-zero, then the timer	2077	stop after it has fired once. If C<$interval> is non-zero, then the timer
1865	is automatically rescheduled at the given intervals.	2078	is automatically rescheduled at the given intervals.
1866		2079
1867	=item $timer = $timer->start	2080	=item $timer = $timer->start
1868		2081
1869	Start the timer.	2082	Start the timer.
1870		2083
1871	=item $timer = $timer->start ($tstamp)	2084	=item $timer = $timer->start ($tstamp[, $interval])
1872		2085
1873	Set the event trigger time to C<$tstamp> and start the timer.	2086	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2087	also replaces the interval.
1874		2088
1875	=item $timer = $timer->after ($delay)	2089	=item $timer = $timer->after ($delay[, $interval])
1876		2090
1877	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2091	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1878		2092
1879	=item $timer = $timer->stop	2093	=item $timer = $timer->stop
1880		2094
…		…
1888		2102
1889	$term->{socket} = ...	2103	$term->{socket} = ...
1890	$term->{iow} = urxvt::iow	2104	$term->{iow} = urxvt::iow
1891	->new	2105	->new
1892	->fd (fileno $term->{socket})	2106	->fd (fileno $term->{socket})
1893	->events (urxvt::EVENT_READ)	2107	->events (urxvt::EV_READ)
1894	->start	2108	->start
1895	->cb (sub {	2109	->cb (sub {
1896	my ($iow, $revents) = @_;	2110	my ($iow, $revents) = @_;
1897	# $revents must be 1 here, no need to check	2111	# $revents must be 1 here, no need to check
1898	sysread $term->{socket}, my $buf, 8192	2112	sysread $term->{socket}, my $buf, 8192
…		…
1911	Set the callback to be called when io events are triggered. C<$reventmask>	2125	Set the callback to be called when io events are triggered. C<$reventmask>
1912	is a bitset as described in the C<events> method.	2126	is a bitset as described in the C<events> method.
1913		2127
1914	=item $iow = $iow->fd ($fd)	2128	=item $iow = $iow->fd ($fd)
1915		2129
1916	Set the filedescriptor (not handle) to watch.	2130	Set the file descriptor (not handle) to watch.
1917		2131
1918	=item $iow = $iow->events ($eventmask)	2132	=item $iow = $iow->events ($eventmask)
1919		2133
1920	Set the event mask to watch. The only allowed values are	2134	Set the event mask to watch. The only allowed values are
1921	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2135	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1922	together, or C<urxvt::EVENT_NONE>.	2136	together, or C<urxvt::EV_NONE>.
1923		2137
1924	=item $iow = $iow->start	2138	=item $iow = $iow->start
1925		2139
1926	Start watching for requested events on the given handle.	2140	Start watching for requested events on the given handle.
1927		2141
1928	=item $iow = $iow->stop	2142	=item $iow = $iow->stop
1929		2143
1930	Stop watching for events on the given filehandle.	2144	Stop watching for events on the given file handle.
1931		2145
1932	=back	2146	=back
1933		2147
1934	=head2 The C<urxvt::iw> Class	2148	=head2 The C<urxvt::iw> Class
1935		2149
…		…
1968	->new	2182	->new
1969	->start ($pid)	2183	->start ($pid)
1970	->cb (sub {	2184	->cb (sub {
1971	my ($pw, $exit_status) = @_;	2185	my ($pw, $exit_status) = @_;
1972	...	2186	...
1973	});	2187	});
1974		2188
1975	=over 4	2189	=over 4
1976		2190
1977	=item $pw = new urxvt::pw	2191	=item $pw = new urxvt::pw
1978		2192
…		…
1982		2196
1983	Set the callback to be called when the timer triggers.	2197	Set the callback to be called when the timer triggers.
1984		2198
1985	=item $pw = $timer->start ($pid)	2199	=item $pw = $timer->start ($pid)
1986		2200
1987	Tells the wqtcher to start watching for process C<$pid>.	2201	Tells the watcher to start watching for process C<$pid>.
1988		2202
1989	=item $pw = $pw->stop	2203	=item $pw = $pw->stop
1990		2204
1991	Stop the watcher.	2205	Stop the watcher.
1992		2206
…		…
2005		2219
2006	=item >= 3 - script loading and management	2220	=item >= 3 - script loading and management
2007		2221
2008	=item >=10 - all called hooks	2222	=item >=10 - all called hooks
2009		2223
2010	=item >=11 - hook reutrn values	2224	=item >=11 - hook return values
2011		2225
2012	=back	2226	=back
2013		2227
2014	=head1 AUTHOR	2228	=head1 AUTHOR
2015		2229
…		…
2017	http://software.schmorp.de/pkg/rxvt-unicode	2231	http://software.schmorp.de/pkg/rxvt-unicode
2018		2232
2019	=cut	2233	=cut
2020		2234
2021	1	2235	1
		2236
		2237	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.130 by root, Wed Jan 25 15:32:48 2006 UTC vs. Revision 1.183 by sf-exg, Wed Mar 31 13:14:50 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.130 by root, Wed Jan 25 15:32:48 2006 UTC vs.
Revision 1.183 by sf-exg, Wed Mar 31 13:14:50 2010 UTC