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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.134 by root, Sat Feb 11 02:31:13 2006 UTC vs. Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.134 by root, Sat Feb 11 02:31:13 2006 UTC vs.
Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 2011 UTC