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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.133 by root, Mon Feb 6 06:14:08 2006 UTC vs.
Revision 1.197 by sf-tpope, Fri Aug 19 23:08:35 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
…		…
98		101
99	Other extensions can extend this popup menu by pushing a code reference	102	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the	103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.	104	popup is being displayed.
102		105
103	It's sole argument is the popup menu, which can be modified. It should	106	Its sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code	107	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference	108	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as	109	will be called when the toggle changes, with the new boolean value as
107	first argument.	110	first argument.
108		111
109	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
111		114
112	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};	117	};
115		118
…		…
121		124
122	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
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.	127	popup is being displayed.
125		128
126	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
127	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.
128	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
129	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
130	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
131		134
132	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
133	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
134	C<a>s:	137	C<a>s:
135		138
136	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
138	: ()	141	: ()
139	};	142	};
140		143
141	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
142		145
…		…
149	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>
150	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
151	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
152	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
153	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
154	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.
155		164
156	=item readline (enabled by default)	165	=item readline (enabled by default)
157		166
158	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
159	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
160	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
161	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
162	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
163		172
164	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
165		174
166	=over 4	175	=over 4
…		…
214	the message into vi commands to load the file.	223	the message into vi commands to load the file.
215		224
216	=item tabbed	225	=item tabbed
217		226
218	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
220	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
221	button per tab.	230	button per tab.
222		231
223	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
224	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,
…		…
234	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
235		244
236	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
237	indices.	246	indices.
238		247
239	=item mark-urls	248	=item matcher
240		249
241	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
242	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
243	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
244	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
245		278
246	=item xim-onthespot	279	=item xim-onthespot
247		280
248	This (experimental) perl extension implements OnTheSpot editing. It does	281	This (experimental) perl extension implements OnTheSpot editing. It does
249	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
250	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
251	kinput2.	284	kinput2.
252		285
253	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
254	C<OnTheSpot>, i.e.:	287	C<OnTheSpot>, i.e.:
255		288
256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257		290
258	=item automove-background	291	=item kuake<hotkey>
259		292
260	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
261	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
262	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.
263		298
264	@@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.
265		315
266	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
267		317
268	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
269	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
270	similar-looking ascii character.	320	similar-looking ascii character.
271		321
272	=item digital-clock	322	=item digital-clock
273		323
274	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
275		325
276	=item remote-clipboard	326	=item remote-clipboard
277		327
278	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
279	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
280	selection somewhere and fetch it again.	330	selection somewhere and fetch it again.
281		331
282	We use it to implement a "distributed selection mechanism", which just	332	We use it to implement a "distributed selection mechanism", which just
283	means that one command uploads the file to a remote server, and another	333	means that one command uploads the file to a remote server, and another
284	reads it.	334	reads it.
…		…
293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
295		345
296	=item selection-pastebin	346	=item selection-pastebin
297		347
298	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
299	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
300	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
301	F</tmp> directly.).	351	F</tmp> directly.).
302		352
303	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
320	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
321	for the filename):	371	for the filename):
322		372
323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
324		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
325	=item example-refresh-hooks	394	=item example-refresh-hooks
326		395
327	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
328	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
329	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.
330		404
331	=back	405	=back
332		406
333	=head1 API DOCUMENTATION	407	=head1 API DOCUMENTATION
334		408
…		…
350		424
351	=over 4	425	=over 4
352		426
353	=item $text	427	=item $text
354		428
355	Rxvt-unicodes special way of encoding text, where one "unicode" character	429	Rxvt-unicode's special way of encoding text, where one "unicode" character
356	always represents one screen cell. See L<ROW_t> for a discussion of this format.	430	always represents one screen cell. See L<ROW_t> for a discussion of this format.
357		431
358	=item $string	432	=item $string
359		433
360	A perl text string, with an emphasis on I<text>. It can store all unicode	434	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
368		442
369	=back	443	=back
370		444
371	=head2 Extension Objects	445	=head2 Extension Objects
372		446
373	Very perl extension is a perl class. A separate perl object is created	447	Every perl extension is a perl class. A separate perl object is created
374	for each terminal and each extension and passed as the first parameter to	448	for each terminal, and each terminal has its own set of extension objects,
375	hooks. So extensions can use their C<$self> object without having to think	449	which are passed as the first parameter to hooks. So extensions can use
376	about other extensions, with the exception of methods and members that	450	their C<$self> object without having to think about clashes with other
		451	extensions or other terminals, with the exception of methods and members
377	begin with an underscore character C<_>: these are reserved for internal	452	that begin with an underscore character C<_>: these are reserved for
378	use.	453	internal use.
379		454
380	Although it isn't a C<urxvt::term> object, you can call all methods of the	455	Although it isn't a C<urxvt::term> object, you can call all methods of the
381	C<urxvt::term> class on this object.	456	C<urxvt::term> class on this object.
382		457
383	It has the following methods and data members:	458	It has the following methods and data members:
…		…
404	=head2 Hooks	479	=head2 Hooks
405		480
406	The following subroutines can be declared in extension files, and will be	481	The following subroutines can be declared in extension files, and will be
407	called whenever the relevant event happens.	482	called whenever the relevant event happens.
408		483
409	The first argument passed to them is an extension oject as described in	484	The first argument passed to them is an extension object as described in
410	the in the C<Extension Objects> section.	485	the in the C<Extension Objects> section.
411		486
412	B<All> of these hooks must return a boolean value. If any of the called	487	B<All> of these hooks must return a boolean value. If any of the called
413	hooks returns true, then the event counts as being I<consumed>, and the	488	hooks returns true, then the event counts as being I<consumed>, and the
414	relevant action might not be carried out by the C++ code.	489	relevant action might not be carried out by the C++ code.
…		…
427	place.	502	place.
428		503
429	=item on_start $term	504	=item on_start $term
430		505
431	Called at the very end of initialisation of a new terminal, just before	506	Called at the very end of initialisation of a new terminal, just before
432	trying to map (display) the toplevel and returning to the mainloop.	507	trying to map (display) the toplevel and returning to the main loop.
433		508
434	=item on_destroy $term	509	=item on_destroy $term
435		510
436	Called whenever something tries to destroy terminal, when the terminal is	511	Called whenever something tries to destroy terminal, when the terminal is
437	still fully functional (not for long, though).	512	still fully functional (not for long, though).
…		…
464		539
465	Called whenever a selection has been copied, but before the selection is	540	Called whenever a selection has been copied, but before the selection is
466	requested from the server. The selection text can be queried and changed	541	requested from the server. The selection text can be queried and changed
467	by calling C<< $term->selection >>.	542	by calling C<< $term->selection >>.
468		543
469	Returning a true value aborts selection grabbing. It will still be hilighted.	544	Returning a true value aborts selection grabbing. It will still be highlighted.
470		545
471	=item on_sel_extend $term	546	=item on_sel_extend $term
472		547
473	Called whenever the user tries to extend the selection (e.g. with a double	548	Called whenever the user tries to extend the selection (e.g. with a double
474	click) and is either supposed to return false (normal operation), or	549	click) and is either supposed to return false (normal operation), or
475	should extend the selection itelf and return true to suppress the built-in	550	should extend the selection itself and return true to suppress the built-in
476	processing. This can happen multiple times, as long as the callback	551	processing. This can happen multiple times, as long as the callback
477	returns true, it will be called on every further click by the user and is	552	returns true, it will be called on every further click by the user and is
478	supposed to enlarge the selection more and more, if possible.	553	supposed to enlarge the selection more and more, if possible.
479		554
480	See the F<selection> example extension.	555	See the F<selection> example extension.
481		556
482	=item on_view_change $term, $offset	557	=item on_view_change $term, $offset
483		558
484	Called whenever the view offset changes, i..e the user or program	559	Called whenever the view offset changes, i.e. the user or program
485	scrolls. Offset C<0> means display the normal terminal, positive values	560	scrolls. Offset C<0> means display the normal terminal, positive values
486	show this many lines of scrollback.	561	show this many lines of scrollback.
487		562
488	=item on_scroll_back $term, $lines, $saved	563	=item on_scroll_back $term, $lines, $saved
489		564
…		…
493		568
494	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	569	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
495	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	570	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
496	number of lines that will be in the scrollback buffer.	571	number of lines that will be in the scrollback buffer.
497		572
498	=item on_osc_seq $term, $string	573	=item on_osc_seq $term, $op, $args, $resp
		574
		575	Called on every OSC sequence and can be used to suppress it or modify its
		576	behaviour. The default should be to return an empty list. A true value
		577	suppresses execution of the request completely. Make sure you don't get
		578	confused by recursive invocations when you output an OSC sequence within
		579	this callback.
		580
		581	C<on_osc_seq_perl> should be used for new behaviour.
		582
		583	=item on_osc_seq_perl $term, $args, $resp
499		584
500	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	585	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
501	operating system command) is processed. Cursor position and other state	586	operating system command) is processed. Cursor position and other state
502	information is up-to-date when this happens. For interoperability, the	587	information is up-to-date when this happens. For interoperability, the
503	string should start with the extension name and a colon, to distinguish	588	string should start with the extension name (sans -osc) and a semicolon,
504	it from commands for other extensions, and this might be enforced in the	589	to distinguish it from commands for other extensions, and this might be
505	future.	590	enforced in the future.
		591
		592	For example, C<overlay-osc> uses this:
		593
		594	sub on_osc_seq_perl {
		595	my ($self, $osc, $resp) = @_;
		596
		597	return unless $osc =~ s/^overlay;//;
		598
		599	... process remaining $osc string
		600	}
506		601
507	Be careful not ever to trust (in a security sense) the data you receive,	602	Be careful not ever to trust (in a security sense) the data you receive,
508	as its source can not easily be controleld (e-mail content, messages from	603	as its source can not easily be controlled (e-mail content, messages from
509	other users on the same system etc.).	604	other users on the same system etc.).
		605
		606	For responses, C<$resp> contains the end-of-args separator used by the
		607	sender.
510		608
511	=item on_add_lines $term, $string	609	=item on_add_lines $term, $string
512		610
513	Called whenever text is about to be output, with the text as argument. You	611	Called whenever text is about to be output, with the text as argument. You
514	can filter/change and output the text yourself by returning a true value	612	can filter/change and output the text yourself by returning a true value
…		…
519	=item on_tt_write $term, $octets	617	=item on_tt_write $term, $octets
520		618
521	Called whenever some data is written to the tty/pty and can be used to	619	Called whenever some data is written to the tty/pty and can be used to
522	suppress or filter tty input.	620	suppress or filter tty input.
523		621
		622	=item on_tt_paste $term, $octets
		623
		624	Called whenever text is about to be pasted, with the text as argument. You
		625	can filter/change and paste the text yourself by returning a true value
		626	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		627	locale-encoded.
		628
524	=item on_line_update $term, $row	629	=item on_line_update $term, $row
525		630
526	Called whenever a line was updated or changed. Can be used to filter	631	Called whenever a line was updated or changed. Can be used to filter
527	screen output (e.g. underline urls or other useless stuff). Only lines	632	screen output (e.g. underline urls or other useless stuff). Only lines
528	that are being shown will be filtered, and, due to performance reasons,	633	that are being shown will be filtered, and, due to performance reasons,
…		…
535	later with the already-modified line (e.g. if unrelated parts change), so	640	later with the already-modified line (e.g. if unrelated parts change), so
536	you cannot just toggle rendition bits, but only set them.	641	you cannot just toggle rendition bits, but only set them.
537		642
538	=item on_refresh_begin $term	643	=item on_refresh_begin $term
539		644
540	Called just before the screen gets redrawn. Can be used for overlay	645	Called just before the screen gets redrawn. Can be used for overlay or
541	or similar effects by modify terminal contents in refresh_begin, and	646	similar effects by modifying the terminal contents in refresh_begin, and
542	restoring them in refresh_end. The built-in overlay and selection display	647	restoring them in refresh_end. The built-in overlay and selection display
543	code is run after this hook, and takes precedence.	648	code is run after this hook, and takes precedence.
544		649
545	=item on_refresh_end $term	650	=item on_refresh_end $term
546		651
547	Called just after the screen gets redrawn. See C<on_refresh_begin>.	652	Called just after the screen gets redrawn. See C<on_refresh_begin>.
548		653
549	=item on_user_command $term, $string	654	=item on_user_command $term, $string
550		655
551	Called whenever the a user-configured event is being activated (e.g. via	656	Called whenever a user-configured event is being activated (e.g. via
552	a C<perl:string> action bound to a key, see description of the B<keysym>	657	a C<perl:string> action bound to a key, see description of the B<keysym>
553	resource in the @@RXVT_NAME@@(1) manpage).	658	resource in the @@RXVT_NAME@@(1) manpage).
554		659
555	The event is simply the action string. This interface is assumed to change	660	The event is simply the action string. This interface is assumed to change
556	slightly in the future.	661	slightly in the future.
		662
		663	=item on_resize_all_windows $term, $new_width, $new_height
		664
		665	Called just after the new window size has been calculated, but before
		666	windows are actually being resized or hints are being set. If this hook
		667	returns TRUE, setting of the window hints is being skipped.
557		668
558	=item on_x_event $term, $event	669	=item on_x_event $term, $event
559		670
560	Called on every X event received on the vt window (and possibly other	671	Called on every X event received on the vt window (and possibly other
561	windows). Should only be used as a last resort. Most event structure	672	windows). Should only be used as a last resort. Most event structure
562	members are not passed.	673	members are not passed.
563		674
		675	=item on_root_event $term, $event
		676
		677	Like C<on_x_event>, but is called for events on the root window.
		678
564	=item on_focus_in $term	679	=item on_focus_in $term
565		680
566	Called whenever the window gets the keyboard focus, before rxvt-unicode	681	Called whenever the window gets the keyboard focus, before rxvt-unicode
567	does focus in processing.	682	does focus in processing.
568		683
569	=item on_focus_out $term	684	=item on_focus_out $term
570		685
571	Called wheneever the window loses keyboard focus, before rxvt-unicode does	686	Called whenever the window loses keyboard focus, before rxvt-unicode does
572	focus out processing.	687	focus out processing.
573		688
574	=item on_configure_notify $term, $event	689	=item on_configure_notify $term, $event
575		690
576	=item on_property_notify $term, $event	691	=item on_property_notify $term, $event
…		…
587		702
588	=item on_map_notify $term, $event	703	=item on_map_notify $term, $event
589		704
590	=item on_unmap_notify $term, $event	705	=item on_unmap_notify $term, $event
591		706
592	Called whenever the corresponding X event is received for the terminal If	707	Called whenever the corresponding X event is received for the terminal. If
593	the hook returns true, then the even will be ignored by rxvt-unicode.	708	the hook returns true, then the event will be ignored by rxvt-unicode.
594		709
595	The event is a hash with most values as named by Xlib (see the XEvent	710	The event is a hash with most values as named by Xlib (see the XEvent
596	manpage), with the additional members C<row> and C<col>, which are the	711	manpage), with the additional members C<row> and C<col>, which are the
597	(real, not screen-based) row and column under the mouse cursor.	712	(real, not screen-based) row and column under the mouse cursor.
598		713
…		…
607		722
608	=item on_wm_delete_window $term, $event	723	=item on_wm_delete_window $term, $event
609		724
610	Called when various types of ClientMessage events are received (all with	725	Called when various types of ClientMessage events are received (all with
611	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	726	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		727
		728	=item on_bell $term
		729
		730	Called on receipt of a bell character.
612		731
613	=back	732	=back
614		733
615	=cut	734	=cut
616		735
…		…
659	The current terminal. This variable stores the current C<urxvt::term>	778	The current terminal. This variable stores the current C<urxvt::term>
660	object, whenever a callback/hook is executing.	779	object, whenever a callback/hook is executing.
661		780
662	=item @urxvt::TERM_INIT	781	=item @urxvt::TERM_INIT
663		782
664	All coderefs in this array will be called as methods of the next newly	783	All code references in this array will be called as methods of the next newly
665	created C<urxvt::term> object (during the C<on_init> phase). The array	784	created C<urxvt::term> object (during the C<on_init> phase). The array
666	gets cleared before the codereferences that were in it are being executed,	785	gets cleared before the code references that were in it are being executed,
667	so coderefs can push themselves onto it again if they so desire.	786	so references can push themselves onto it again if they so desire.
668		787
669	This complements to the perl-eval commandline option, but gets executed	788	This complements to the perl-eval command line option, but gets executed
670	first.	789	first.
671		790
672	=item @urxvt::TERM_EXT	791	=item @urxvt::TERM_EXT
673		792
674	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	793	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
681		800
682	=over 4	801	=over 4
683		802
684	=item urxvt::fatal $errormessage	803	=item urxvt::fatal $errormessage
685		804
686	Fatally aborts execution with the given error message. Avoid at all	805	Fatally aborts execution with the given error message (which should
687	costs! The only time this is acceptable is when the terminal process	806	include a trailing newline). Avoid at all costs! The only time this
688	starts up.	807	is acceptable (and useful) is in the init hook, where it prevents the
		808	terminal from starting up.
689		809
690	=item urxvt::warn $string	810	=item urxvt::warn $string
691		811
692	Calls C<rxvt_warn> with the given string which should not include a	812	Calls C<rxvt_warn> with the given string which should include a trailing
693	newline. The module also overwrites the C<warn> builtin with a function	813	newline. The module also overwrites the C<warn> builtin with a function
694	that calls this function.	814	that calls this function.
695		815
696	Using this function has the advantage that its output ends up in the	816	Using this function has the advantage that its output ends up in the
697	correct place, e.g. on stderr of the connecting urxvtc client.	817	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
699	Messages have a size limit of 1023 bytes currently.	819	Messages have a size limit of 1023 bytes currently.
700		820
701	=item @terms = urxvt::termlist	821	=item @terms = urxvt::termlist
702		822
703	Returns all urxvt::term objects that exist in this process, regardless of	823	Returns all urxvt::term objects that exist in this process, regardless of
704	wether they are started, being destroyed etc., so be careful. Only term	824	whether they are started, being destroyed etc., so be careful. Only term
705	objects that have perl extensions attached will be returned (because there	825	objects that have perl extensions attached will be returned (because there
706	is no urxvt::term objet associated with others).	826	is no urxvt::term object associated with others).
707		827
708	=item $time = urxvt::NOW	828	=item $time = urxvt::NOW
709		829
710	Returns the "current time" (as per the event loop).	830	Returns the "current time" (as per the event loop).
711		831
…		…
754		874
755	=item $rend = urxvt::OVERLAY_RSTYLE	875	=item $rend = urxvt::OVERLAY_RSTYLE
756		876
757	Return the rendition mask used for overlays by default.	877	Return the rendition mask used for overlays by default.
758		878
759	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	879	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		880	urxvt::RS_RVid, urxvt::RS_Uline
760		881
761	Return the bit that enabled bold, italic, blink, reverse-video and	882	Return the bit that enabled bold, italic, blink, reverse-video and
762	underline, respectively. To enable such a style, just logically OR it into	883	underline, respectively. To enable such a style, just logically OR it into
763	the bitset.	884	the bitset.
764		885
…		…
847	local $TERM = shift;	968	local $TERM = shift;
848	my $htype = shift;	969	my $htype = shift;
849		970
850	if ($htype == 0) { # INIT	971	if ($htype == 0) { # INIT
851	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	972	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
852		973
853	my %ext_arg;	974	my %ext_arg;
854		975
855	{	976	{
856	my @init = @TERM_INIT;	977	my @init = @TERM_INIT;
857	@TERM_INIT = ();	978	@TERM_INIT = ();
…		…
891		1012
892	if (my $cb = $TERM->{_hook}[$htype]) {	1013	if (my $cb = $TERM->{_hook}[$htype]) {
893	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1014	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
894	if $verbosity >= 10;	1015	if $verbosity >= 10;
895		1016
896	keys %$cb;	1017	for my $pkg (keys %$cb) {
897
898	while (my ($pkg, $cb) = each %$cb) {
899	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1018	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
900	$retval \|\|= $retval_;	1019	$retval \|\|= $retval_;
901		1020
902	if ($@) {	1021	if ($@) {
903	$TERM->ungrab; # better to lose the grab than the session	1022	$TERM->ungrab; # better to lose the grab than the session
904	warn $@;	1023	warn $@;
…		…
920	$retval	1039	$retval
921	}	1040	}
922		1041
923	sub SET_COLOR($$$) {	1042	sub SET_COLOR($$$) {
924	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1043	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1044	}
		1045
		1046	sub rend2mask {
		1047	no strict 'refs';
		1048	my ($str, $mask) = (@_, 0);
		1049	my %color = ( fg => undef, bg => undef );
		1050	my @failed;
		1051	for my $spec ( split /\s+/, $str ) {
		1052	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1053	$color{lc($1)} = $2;
		1054	} else {
		1055	my $neg = $spec =~ s/^[-^]//;
		1056	unless ( exists &{"RS_$spec"} ) {
		1057	push @failed, $spec;
		1058	next;
		1059	}
		1060	my $cur = &{"RS_$spec"};
		1061	if ( $neg ) {
		1062	$mask &= ~$cur;
		1063	} else {
		1064	$mask \|= $cur;
		1065	}
		1066	}
		1067	}
		1068	($mask, @color{qw(fg bg)}, \@failed)
925	}	1069	}
926		1070
927	# urxvt::term::extension	1071	# urxvt::term::extension
928		1072
929	package urxvt::term::extension;	1073	package urxvt::term::extension;
…		…
1000	is that you cannot use blocking APIs, but the non-blocking variant should	1144	is that you cannot use blocking APIs, but the non-blocking variant should
1001	work.	1145	work.
1002		1146
1003	=cut	1147	=cut
1004		1148
1005	our $VERSION = 1;	1149	our $VERSION = '5.23';
1006		1150
1007	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1151	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1008	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1152	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1009		1153
1010	sub timer {	1154	sub timer {
…		…
1012		1156
1013	my $cb = $arg{cb};	1157	my $cb = $arg{cb};
1014		1158
1015	urxvt::timer	1159	urxvt::timer
1016	->new	1160	->new
1017	->start (urxvt::NOW + $arg{after})	1161	->after ($arg{after}, $arg{interval})
1018	->cb (sub {	1162	->cb ($arg{interval} ? $cb : sub {
1019	$_[0]->stop; # need to cancel manually	1163	$_[0]->stop; # need to cancel manually
1020	$cb->();	1164	$cb->();
1021	})	1165	})
1022	}	1166	}
1023		1167
1024	sub io {	1168	sub io {
1025	my ($class, %arg) = @_;	1169	my ($class, %arg) = @_;
1026		1170
1027	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
		1172	my $fd = fileno $arg{fh};
		1173	defined $fd or $fd = $arg{fh};
1028		1174
1029	bless [$arg{fh}, urxvt::iow	1175	bless [$arg{fh}, urxvt::iow
1030	->new	1176	->new
1031	->fd (fileno $arg{fh})	1177	->fd ($fd)
1032	->events (($arg{poll} =~ /r/ ? 1 : 0)	1178	->events (($arg{poll} =~ /r/ ? 1 : 0)
1033	\| ($arg{poll} =~ /w/ ? 2 : 0))	1179	\| ($arg{poll} =~ /w/ ? 2 : 0))
1034	->start	1180	->start
1035	->cb (sub {	1181	->cb ($cb)
1036	$cb->(($_[1] & 1 ? 'r' : '')
1037	. ($_[1] & 2 ? 'w' : ''));
1038	})],
1039	urxvt::anyevent::	1182	], urxvt::anyevent::
		1183	}
		1184
		1185	sub idle {
		1186	my ($class, %arg) = @_;
		1187
		1188	my $cb = $arg{cb};
		1189
		1190	urxvt::iw
		1191	->new
		1192	->start
		1193	->cb ($cb)
		1194	}
		1195
		1196	sub child {
		1197	my ($class, %arg) = @_;
		1198
		1199	my $cb = $arg{cb};
		1200
		1201	urxvt::pw
		1202	->new
		1203	->start ($arg{pid})
		1204	->cb (sub {
		1205	$_[0]->stop; # need to cancel manually
		1206	$cb->($_[0]->rpid, $_[0]->rstatus);
		1207	})
1040	}	1208	}
1041		1209
1042	sub DESTROY {	1210	sub DESTROY {
1043	$_[0][1]->stop;	1211	$_[0][1]->stop;
1044	}	1212	}
1045		1213
1046	sub condvar {	1214	sub one_event {
1047	bless \my $flag, urxvt::anyevent::condvar::
1048	}
1049
1050	sub urxvt::anyevent::condvar::broadcast {
1051	${$_[0]}++;
1052	}
1053
1054	sub urxvt::anyevent::condvar::wait {
1055	unless (${$_[0]}) {
1056	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1215	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1057	}
1058	}	1216	}
1059		1217
1060	package urxvt::term;	1218	package urxvt::term;
1061		1219
1062	=head2 The C<urxvt::term> Class	1220	=head2 The C<urxvt::term> Class
…		…
1149		1307
1150	Returns true if the option specified by C<$optval> is enabled, and	1308	Returns true if the option specified by C<$optval> is enabled, and
1151	optionally change it. All option values are stored by name in the hash	1309	optionally change it. All option values are stored by name in the hash
1152	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1310	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1153		1311
1154	Here is a a likely non-exhaustive list of option names, please see the	1312	Here is a likely non-exhaustive list of option names, please see the
1155	source file F</src/optinc.h> to see the actual list:	1313	source file F</src/optinc.h> to see the actual list:
1156		1314
1157	borderLess console cursorBlink cursorUnderline hold iconic insecure	1315	borderLess buffered console cursorBlink cursorUnderline hold iconic
1158	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1316	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1159	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1317	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1160	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1318	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1161	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1319	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1162	transparent tripleclickwords utmpInhibit visualBell	1320	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1321	urgentOnBell utmpInhibit visualBell
1163		1322
1164	=item $value = $term->resource ($name[, $newval])	1323	=item $value = $term->resource ($name[, $newval])
1165		1324
1166	Returns the current resource value associated with a given name and	1325	Returns the current resource value associated with a given name and
1167	optionally sets a new value. Setting values is most useful in the C<init>	1326	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1176	likely change).	1335	likely change).
1177		1336
1178	Please note that resource strings will currently only be freed when the	1337	Please note that resource strings will currently only be freed when the
1179	terminal is destroyed, so changing options frequently will eat memory.	1338	terminal is destroyed, so changing options frequently will eat memory.
1180		1339
1181	Here is a a likely non-exhaustive list of resource names, not all of which	1340	Here is a likely non-exhaustive list of resource names, not all of which
1182	are supported in every build, please see the source file F</src/rsinc.h>	1341	are supported in every build, please see the source file F</src/rsinc.h>
1183	to see the actual list:	1342	to see the actual list:
1184		1343
1185	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1344	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1186	borderLess color cursorBlink cursorUnderline cutchars delete_key	1345	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1187	display_name embed ext_bwidth fade font geometry hold iconName	1346	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1188	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1347	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1348	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1189	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1349	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1190	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1350	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1191	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1351	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1192	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1352	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1193	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1353	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1194	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1354	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1195	secondaryScreen secondaryScroll selectstyle shade term_name title	1355	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1196	transient_for transparent transparent_all tripleclickwords utmpInhibit	1356	term_name title transient_for transparent tripleclickwords urgentOnBell
1197	visualBell	1357	utmpInhibit visualBell
1198		1358
1199	=cut	1359	=cut
1200		1360
1201	sub resource($$;$) {	1361	sub resource($$;$) {
1202	my ($self, $name) = (shift, shift);	1362	my ($self, $name) = (shift, shift);
1203	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1363	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1204	&urxvt::term::_resource	1364	goto &urxvt::term::_resource
1205	}	1365	}
1206		1366
1207	=item $value = $term->x_resource ($pattern)	1367	=item $value = $term->x_resource ($pattern)
1208		1368
1209	Returns the X-Resource for the given pattern, excluding the program or	1369	Returns the X-Resource for the given pattern, excluding the program or
…		…
1234		1394
1235	=item ($row, $col) = $term->selection_beg ([$row, $col])	1395	=item ($row, $col) = $term->selection_beg ([$row, $col])
1236		1396
1237	=item ($row, $col) = $term->selection_end ([$row, $col])	1397	=item ($row, $col) = $term->selection_end ([$row, $col])
1238		1398
1239	Return the current values of the selection mark, begin or end positions,	1399	Return the current values of the selection mark, begin or end positions.
1240	and optionally set them to new values.	1400
		1401	When arguments are given, then the selection coordinates are set to
		1402	C<$row> and C<$col>, and the selection screen is set to the current
		1403	screen.
		1404
		1405	=item $screen = $term->selection_screen ([$screen])
		1406
		1407	Returns the current selection screen, and then optionally sets it.
1241		1408
1242	=item $term->selection_make ($eventtime[, $rectangular])	1409	=item $term->selection_make ($eventtime[, $rectangular])
1243		1410
1244	Tries to make a selection as set by C<selection_beg> and	1411	Tries to make a selection as set by C<selection_beg> and
1245	C<selection_end>. If C<$rectangular> is true (default: false), a	1412	C<selection_end>. If C<$rectangular> is true (default: false), a
1246	rectangular selection will be made. This is the prefered function to make	1413	rectangular selection will be made. This is the preferred function to make
1247	a selection.	1414	a selection.
1248		1415
1249	=item $success = $term->selection_grab ($eventtime)	1416	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1250		1417
1251	Try to request the primary selection text from the server (for example, as	1418	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1419	true) selection from the server. The corresponding text can be set
1252	set by the next method). No visual feedback will be given. This function	1420	with the next method. No visual feedback will be given. This function
1253	is mostly useful from within C<on_sel_grab> hooks.	1421	is mostly useful from within C<on_sel_grab> hooks.
1254		1422
1255	=item $oldtext = $term->selection ([$newtext])	1423	=item $oldtext = $term->selection ([$newtext, $clipboard])
1256		1424
1257	Return the current selection text and optionally replace it by C<$newtext>.	1425	Return the current selection (clipboard if C<$clipboard> is true) text
		1426	and optionally replace it by C<$newtext>.
		1427
		1428	=item $term->selection_clear ([$clipboard])
		1429
		1430	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1258		1431
1259	=item $term->overlay_simple ($x, $y, $text)	1432	=item $term->overlay_simple ($x, $y, $text)
1260		1433
1261	Create a simple multi-line overlay box. See the next method for details.	1434	Create a simple multi-line overlay box. See the next method for details.
1262		1435
…		…
1292		1465
1293	The methods currently supported on C<urxvt::overlay> objects are:	1466	The methods currently supported on C<urxvt::overlay> objects are:
1294		1467
1295	=over 4	1468	=over 4
1296		1469
1297	=item $overlay->set ($x, $y, $text, $rend)	1470	=item $overlay->set ($x, $y, $text[, $rend])
1298		1471
1299	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1472	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1300	text in rxvt-unicode's special encoding and an array of rendition values	1473	text in rxvt-unicode's special encoding and an array of rendition values
1301	at a specific position inside the overlay.	1474	at a specific position inside the overlay.
		1475
		1476	If C<$rend> is missing, then the rendition will not be changed.
1302		1477
1303	=item $overlay->hide	1478	=item $overlay->hide
1304		1479
1305	If visible, hide the overlay, but do not destroy it.	1480	If visible, hide the overlay, but do not destroy it.
1306		1481
…		…
1388	locale-specific encoding of the terminal and can contain command sequences	1563	locale-specific encoding of the terminal and can contain command sequences
1389	(escape codes) that will be interpreted.	1564	(escape codes) that will be interpreted.
1390		1565
1391	=item $term->tt_write ($octets)	1566	=item $term->tt_write ($octets)
1392		1567
1393	Write the octets given in C<$data> to the tty (i.e. as program input). To	1568	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1394	pass characters instead of octets, you should convert your strings first	1569	pass characters instead of octets, you should convert your strings first
1395	to the locale-specific encoding using C<< $term->locale_encode >>.	1570	to the locale-specific encoding using C<< $term->locale_encode >>.
		1571
		1572	=item $term->tt_paste ($octets)
		1573
		1574	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1575	CR and bracketing the data with control sequences if bracketed paste mode
		1576	is set.
1396		1577
1397	=item $old_events = $term->pty_ev_events ([$new_events])	1578	=item $old_events = $term->pty_ev_events ([$new_events])
1398		1579
1399	Replaces the event mask of the pty watcher by the given event mask. Can	1580	Replaces the event mask of the pty watcher by the given event mask. Can
1400	be used to suppress input and output handling to the pty/tty. See the	1581	be used to suppress input and output handling to the pty/tty. See the
…		…
1468	=item $env = $term->env	1649	=item $env = $term->env
1469		1650
1470	Returns a copy of the environment in effect for the terminal as a hashref	1651	Returns a copy of the environment in effect for the terminal as a hashref
1471	similar to C<\%ENV>.	1652	similar to C<\%ENV>.
1472		1653
		1654	=item @envv = $term->envv
		1655
		1656	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1657
		1658	=item @argv = $term->argv
		1659
		1660	Return the argument vector as this terminal, similar to @ARGV, but
		1661	includes the program name as first element.
		1662
1473	=cut	1663	=cut
1474		1664
1475	sub env {	1665	sub env {
1476	if (my $env = $_[0]->_env) {
1477	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1666	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1478	} else {
1479	+{ %ENV }
1480	}
1481	}	1667	}
1482		1668
1483	=item $modifiermask = $term->ModLevel3Mask	1669	=item $modifiermask = $term->ModLevel3Mask
1484		1670
1485	=item $modifiermask = $term->ModMetaMask	1671	=item $modifiermask = $term->ModMetaMask
…		…
1493		1679
1494	Returns the currently displayed screen (0 primary, 1 secondary).	1680	Returns the currently displayed screen (0 primary, 1 secondary).
1495		1681
1496	=item $cursor_is_hidden = $term->hidden_cursor	1682	=item $cursor_is_hidden = $term->hidden_cursor
1497		1683
1498	Returns wether the cursor is currently hidden or not.	1684	Returns whether the cursor is currently hidden or not.
1499		1685
1500	=item $view_start = $term->view_start ([$newvalue])	1686	=item $view_start = $term->view_start ([$newvalue])
1501		1687
1502	Returns the row number of the topmost displayed line. Maximum value is	1688	Returns the row number of the topmost displayed line. Maximum value is
1503	C<0>, which displays the normal terminal contents. Lower values scroll	1689	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1511		1697
1512	Used after changing terminal contents to display them.	1698	Used after changing terminal contents to display them.
1513		1699
1514	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1700	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1515		1701
1516	Returns the text of the entire row with number C<$row_number>. Row C<0>	1702	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1517	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1703	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1518	terminal line. The scrollback buffer starts at line C<-1> and extends to
1519	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1704	terminal line. Nothing will be returned if a nonexistent line
1520	is requested.	1705	is requested.
1521		1706
1522	If C<$new_text> is specified, it will replace characters in the current	1707	If C<$new_text> is specified, it will replace characters in the current
1523	line, starting at column C<$start_col> (default C<0>), which is useful	1708	line, starting at column C<$start_col> (default C<0>), which is useful
1524	to replace only parts of a line. The font index in the rendition will	1709	to replace only parts of a line. The font index in the rendition will
1525	automatically be updated.	1710	automatically be updated.
1526		1711
1527	C<$text> is in a special encoding: tabs and wide characters that use more	1712	C<$text> is in a special encoding: tabs and wide characters that use more
1528	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1713	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1529	characters. Characters with combining characters and other characters that	1714	characters. Characters with combining characters and other characters that
1530	do not fit into the normal tetx encoding will be replaced with characters	1715	do not fit into the normal text encoding will be replaced with characters
1531	in the private use area.	1716	in the private use area.
1532		1717
1533	You have to obey this encoding when changing text. The advantage is	1718	You have to obey this encoding when changing text. The advantage is
1534	that C<substr> and similar functions work on screen cells and not on	1719	that C<substr> and similar functions work on screen cells and not on
1535	characters.	1720	characters.
…		…
1680	where one character corresponds to one screen cell. See	1865	where one character corresponds to one screen cell. See
1681	C<< $term->ROW_t >> for details.	1866	C<< $term->ROW_t >> for details.
1682		1867
1683	=item $string = $term->special_decode $text	1868	=item $string = $term->special_decode $text
1684		1869
1685	Converts rxvt-unicodes text reprsentation into a perl string. See	1870	Converts rxvt-unicodes text representation into a perl string. See
1686	C<< $term->ROW_t >> for details.	1871	C<< $term->ROW_t >> for details.
1687		1872
1688	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1873	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1689		1874
1690	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1875	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1693	manpage.	1878	manpage.
1694		1879
1695	=item $success = $term->grab ($eventtime[, $sync])	1880	=item $success = $term->grab ($eventtime[, $sync])
1696		1881
1697	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1882	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1698	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1883	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1699		1884
1700	=item $term->allow_events_async	1885	=item $term->allow_events_async
1701		1886
1702	Calls XAllowEvents with AsyncBoth for the most recent grab.	1887	Calls XAllowEvents with AsyncBoth for the most recent grab.
1703		1888
…		…
1710	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1895	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1711	recent grab.	1896	recent grab.
1712		1897
1713	=item $term->ungrab	1898	=item $term->ungrab
1714		1899
1715	Calls XUngrab for the most recent grab. Is called automatically on	1900	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1716	evaluation errors, as it is better to lose the grab in the error case as	1901	evaluation errors, as it is better to lose the grab in the error case as
1717	the session.	1902	the session.
1718		1903
1719	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1904	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1720		1905
…		…
1722		1907
1723	=item @atoms = $term->XListProperties ($window)	1908	=item @atoms = $term->XListProperties ($window)
1724		1909
1725	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1910	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1726		1911
1727	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1912	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1728		1913
1729	=item $term->XDeleteProperty ($window, $property)	1914	=item $term->XDeleteProperty ($window, $property)
1730		1915
1731	=item $window = $term->DefaultRootWindow	1916	=item $window = $term->DefaultRootWindow
1732		1917
…		…
1742		1927
1743	=item $term->XChangeInput ($window, $add_events[, $del_events])	1928	=item $term->XChangeInput ($window, $add_events[, $del_events])
1744		1929
1745	Various X or X-related functions. The C<$term> object only serves as	1930	Various X or X-related functions. The C<$term> object only serves as
1746	the source of the display, otherwise those functions map more-or-less	1931	the source of the display, otherwise those functions map more-or-less
1747	directory onto the X functions of the same name.	1932	directly onto the X functions of the same name.
1748		1933
1749	=back	1934	=back
1750		1935
1751	=cut	1936	=cut
1752		1937
…		…
1854	my $env = $self->{term}->env;	2039	my $env = $self->{term}->env;
1855	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2040	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1856	delete $env->{LC_ALL};	2041	delete $env->{LC_ALL};
1857	$env->{LC_CTYPE} = $self->{term}->locale;	2042	$env->{LC_CTYPE} = $self->{term}->locale;
1858		2043
1859	urxvt::term->new ($env, "popup",	2044	my $term = urxvt::term->new (
		2045	$env, "popup",
1860	"--perl-lib" => "", "--perl-ext-common" => "",	2046	"--perl-lib" => "", "--perl-ext-common" => "",
1861	"-pty-fd" => -1, "-sl" => 0,	2047	"-pty-fd" => -1, "-sl" => 0,
1862	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2048	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1863	"--transient-for" => $self->{term}->parent,	2049	"--transient-for" => $self->{term}->parent,
1864	"-display" => $self->{term}->display_id,	2050	"-display" => $self->{term}->display_id,
1865	"-pe" => "urxvt-popup")	2051	"-pe" => "urxvt-popup",
1866	or die "unable to create popup window\n";	2052	) or die "unable to create popup window\n";
		2053
		2054	unless (delete $term->{urxvt_popup_init_done}) {
		2055	$term->ungrab;
		2056	$term->destroy;
		2057	die "unable to initialise popup window\n";
		2058	}
1867	}	2059	}
1868		2060
1869	sub DESTROY {	2061	sub DESTROY {
1870	my ($self) = @_;	2062	my ($self) = @_;
1871		2063
…		…
1876	=back	2068	=back
1877		2069
1878	=cut	2070	=cut
1879		2071
1880	package urxvt::watcher;	2072	package urxvt::watcher;
1881
1882	@urxvt::timer::ISA = __PACKAGE__;
1883	@urxvt::iow::ISA = __PACKAGE__;
1884	@urxvt::pw::ISA = __PACKAGE__;
1885	@urxvt::iw::ISA = __PACKAGE__;
1886		2073
1887	=head2 The C<urxvt::timer> Class	2074	=head2 The C<urxvt::timer> Class
1888		2075
1889	This class implements timer watchers/events. Time is represented as a	2076	This class implements timer watchers/events. Time is represented as a
1890	fractional number of seconds since the epoch. Example:	2077	fractional number of seconds since the epoch. Example:
…		…
1894	->new	2081	->new
1895	->interval (1)	2082	->interval (1)
1896	->cb (sub {	2083	->cb (sub {
1897	$term->{overlay}->set (0, 0,	2084	$term->{overlay}->set (0, 0,
1898	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2085	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1899	});	2086	});
1900		2087
1901	=over 4	2088	=over 4
1902		2089
1903	=item $timer = new urxvt::timer	2090	=item $timer = new urxvt::timer
1904		2091
…		…
1907		2094
1908	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2095	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1909		2096
1910	Set the callback to be called when the timer triggers.	2097	Set the callback to be called when the timer triggers.
1911		2098
1912	=item $tstamp = $timer->at
1913
1914	Return the time this watcher will fire next.
1915
1916	=item $timer = $timer->set ($tstamp)	2099	=item $timer = $timer->set ($tstamp[, $interval])
1917		2100
1918	Set the time the event is generated to $tstamp.	2101	Set the time the event is generated to $tstamp (and optionally specifies a
		2102	new $interval).
1919		2103
1920	=item $timer = $timer->interval ($interval)	2104	=item $timer = $timer->interval ($interval)
1921		2105
1922	Normally (and when C<$interval> is C<0>), the timer will automatically	2106	By default (and when C<$interval> is C<0>), the timer will automatically
1923	stop after it has fired once. If C<$interval> is non-zero, then the timer	2107	stop after it has fired once. If C<$interval> is non-zero, then the timer
1924	is automatically rescheduled at the given intervals.	2108	is automatically rescheduled at the given intervals.
1925		2109
1926	=item $timer = $timer->start	2110	=item $timer = $timer->start
1927		2111
1928	Start the timer.	2112	Start the timer.
1929		2113
1930	=item $timer = $timer->start ($tstamp)	2114	=item $timer = $timer->start ($tstamp[, $interval])
1931		2115
1932	Set the event trigger time to C<$tstamp> and start the timer.	2116	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2117	also replaces the interval.
1933		2118
1934	=item $timer = $timer->after ($delay)	2119	=item $timer = $timer->after ($delay[, $interval])
1935		2120
1936	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2121	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1937		2122
1938	=item $timer = $timer->stop	2123	=item $timer = $timer->stop
1939		2124
…		…
1947		2132
1948	$term->{socket} = ...	2133	$term->{socket} = ...
1949	$term->{iow} = urxvt::iow	2134	$term->{iow} = urxvt::iow
1950	->new	2135	->new
1951	->fd (fileno $term->{socket})	2136	->fd (fileno $term->{socket})
1952	->events (urxvt::EVENT_READ)	2137	->events (urxvt::EV_READ)
1953	->start	2138	->start
1954	->cb (sub {	2139	->cb (sub {
1955	my ($iow, $revents) = @_;	2140	my ($iow, $revents) = @_;
1956	# $revents must be 1 here, no need to check	2141	# $revents must be 1 here, no need to check
1957	sysread $term->{socket}, my $buf, 8192	2142	sysread $term->{socket}, my $buf, 8192
…		…
1970	Set the callback to be called when io events are triggered. C<$reventmask>	2155	Set the callback to be called when io events are triggered. C<$reventmask>
1971	is a bitset as described in the C<events> method.	2156	is a bitset as described in the C<events> method.
1972		2157
1973	=item $iow = $iow->fd ($fd)	2158	=item $iow = $iow->fd ($fd)
1974		2159
1975	Set the filedescriptor (not handle) to watch.	2160	Set the file descriptor (not handle) to watch.
1976		2161
1977	=item $iow = $iow->events ($eventmask)	2162	=item $iow = $iow->events ($eventmask)
1978		2163
1979	Set the event mask to watch. The only allowed values are	2164	Set the event mask to watch. The only allowed values are
1980	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2165	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1981	together, or C<urxvt::EVENT_NONE>.	2166	together, or C<urxvt::EV_NONE>.
1982		2167
1983	=item $iow = $iow->start	2168	=item $iow = $iow->start
1984		2169
1985	Start watching for requested events on the given handle.	2170	Start watching for requested events on the given handle.
1986		2171
1987	=item $iow = $iow->stop	2172	=item $iow = $iow->stop
1988		2173
1989	Stop watching for events on the given filehandle.	2174	Stop watching for events on the given file handle.
1990		2175
1991	=back	2176	=back
1992		2177
1993	=head2 The C<urxvt::iw> Class	2178	=head2 The C<urxvt::iw> Class
1994		2179
…		…
2027	->new	2212	->new
2028	->start ($pid)	2213	->start ($pid)
2029	->cb (sub {	2214	->cb (sub {
2030	my ($pw, $exit_status) = @_;	2215	my ($pw, $exit_status) = @_;
2031	...	2216	...
2032	});	2217	});
2033		2218
2034	=over 4	2219	=over 4
2035		2220
2036	=item $pw = new urxvt::pw	2221	=item $pw = new urxvt::pw
2037		2222
…		…
2041		2226
2042	Set the callback to be called when the timer triggers.	2227	Set the callback to be called when the timer triggers.
2043		2228
2044	=item $pw = $timer->start ($pid)	2229	=item $pw = $timer->start ($pid)
2045		2230
2046	Tells the wqtcher to start watching for process C<$pid>.	2231	Tells the watcher to start watching for process C<$pid>.
2047		2232
2048	=item $pw = $pw->stop	2233	=item $pw = $pw->stop
2049		2234
2050	Stop the watcher.	2235	Stop the watcher.
2051		2236
…		…
2064		2249
2065	=item >= 3 - script loading and management	2250	=item >= 3 - script loading and management
2066		2251
2067	=item >=10 - all called hooks	2252	=item >=10 - all called hooks
2068		2253
2069	=item >=11 - hook reutrn values	2254	=item >=11 - hook return values
2070		2255
2071	=back	2256	=back
2072		2257
2073	=head1 AUTHOR	2258	=head1 AUTHOR
2074		2259
2075	Marc Lehmann <pcg@goof.com>	2260	Marc Lehmann <schmorp@schmorp.de>
2076	http://software.schmorp.de/pkg/rxvt-unicode	2261	http://software.schmorp.de/pkg/rxvt-unicode
2077		2262
2078	=cut	2263	=cut
2079		2264
2080	1	2265	1
		2266
		2267	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.133 by root, Mon Feb 6 06:14:08 2006 UTC vs. Revision 1.197 by sf-tpope, Fri Aug 19 23:08:35 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.133 by root, Mon Feb 6 06:14:08 2006 UTC vs.
Revision 1.197 by sf-tpope, Fri Aug 19 23:08:35 2011 UTC