[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.189 by root, Sat Dec 18 15:37:10 2010 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:	71	between two vertical bars:
69		72
70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
71		74
72	Another example: Programs I use often output "absolute path: " at the	75	Another example: Programs I use often output "absolute path: " at the
…		…
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 extenion 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.
		660
		661	=item on_resize_all_windows $term, $new_width, $new_height
		662
		663	Called just after the new window size has been calculated, but before
		664	windows are actually being resized or hints are being set. If this hook
		665	returns TRUE, setting of the window hints is being skipped.
557		666
558	=item on_x_event $term, $event	667	=item on_x_event $term, $event
559		668
560	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
561	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
562	members are not passed.	671	members are not passed.
563		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
564	=item on_focus_in $term	677	=item on_focus_in $term
565		678
566	Called whenever the window gets the keyboard focus, before rxvt-unicode	679	Called whenever the window gets the keyboard focus, before rxvt-unicode
567	does focus in processing.	680	does focus in processing.
568		681
569	=item on_focus_out $term	682	=item on_focus_out $term
570		683
571	Called wheneever the window loses keyboard focus, before rxvt-unicode does	684	Called whenever the window loses keyboard focus, before rxvt-unicode does
572	focus out processing.	685	focus out processing.
573		686
574	=item on_configure_notify $term, $event	687	=item on_configure_notify $term, $event
575		688
576	=item on_property_notify $term, $event	689	=item on_property_notify $term, $event
…		…
587		700
588	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
589		702
590	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
591		704
592	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
593	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.
594		707
595	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
596	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
597	(real, not screen-based) row and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
598		711
…		…
607		720
608	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
609		722
610	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
611	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.
612		729
613	=back	730	=back
614		731
615	=cut	732	=cut
616		733
…		…
659	The current terminal. This variable stores the current C<urxvt::term>	776	The current terminal. This variable stores the current C<urxvt::term>
660	object, whenever a callback/hook is executing.	777	object, whenever a callback/hook is executing.
661		778
662	=item @urxvt::TERM_INIT	779	=item @urxvt::TERM_INIT
663		780
664	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
665	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
666	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,
667	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.
668		785
669	This complements to the perl-eval commandline option, but gets executed	786	This complements to the perl-eval command line option, but gets executed
670	first.	787	first.
671		788
672	=item @urxvt::TERM_EXT	789	=item @urxvt::TERM_EXT
673		790
674	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
…		…
699	Messages have a size limit of 1023 bytes currently.	816	Messages have a size limit of 1023 bytes currently.
700		817
701	=item @terms = urxvt::termlist	818	=item @terms = urxvt::termlist
702		819
703	Returns all urxvt::term objects that exist in this process, regardless of	820	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	821	whether they are started, being destroyed etc., so be careful. Only term
705	objects that have perl extensions attached will be returned (because there	822	objects that have perl extensions attached will be returned (because there
706	is no urxvt::term objet associated with others).	823	is no urxvt::term objet associated with others).
707		824
708	=item $time = urxvt::NOW	825	=item $time = urxvt::NOW
709		826
…		…
754		871
755	=item $rend = urxvt::OVERLAY_RSTYLE	872	=item $rend = urxvt::OVERLAY_RSTYLE
756		873
757	Return the rendition mask used for overlays by default.	874	Return the rendition mask used for overlays by default.
758		875
759	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	876	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		877	urxvt::RS_RVid, urxvt::RS_Uline
760		878
761	Return the bit that enabled bold, italic, blink, reverse-video and	879	Return the bit that enabled bold, italic, blink, reverse-video and
762	underline, respectively. To enable such a style, just logically OR it into	880	underline, respectively. To enable such a style, just logically OR it into
763	the bitset.	881	the bitset.
764		882
…		…
847	local $TERM = shift;	965	local $TERM = shift;
848	my $htype = shift;	966	my $htype = shift;
849		967
850	if ($htype == 0) { # INIT	968	if ($htype == 0) { # INIT
851	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	969	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
852		970
853	my %ext_arg;	971	my %ext_arg;
854		972
855	{	973	{
856	my @init = @TERM_INIT;	974	my @init = @TERM_INIT;
857	@TERM_INIT = ();	975	@TERM_INIT = ();
…		…
891		1009
892	if (my $cb = $TERM->{_hook}[$htype]) {	1010	if (my $cb = $TERM->{_hook}[$htype]) {
893	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1011	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
894	if $verbosity >= 10;	1012	if $verbosity >= 10;
895		1013
896	keys %$cb;	1014	for my $pkg (keys %$cb) {
897
898	while (my ($pkg, $cb) = each %$cb) {
899	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1015	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
900	$retval \|\|= $retval_;	1016	$retval \|\|= $retval_;
901		1017
902	if ($@) {	1018	if ($@) {
903	$TERM->ungrab; # better to lose the grab than the session	1019	$TERM->ungrab; # better to lose the grab than the session
904	warn $@;	1020	warn $@;
…		…
920	$retval	1036	$retval
921	}	1037	}
922		1038
923	sub SET_COLOR($$$) {	1039	sub SET_COLOR($$$) {
924	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1040	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1041	}
		1042
		1043	sub rend2mask {
		1044	no strict 'refs';
		1045	my ($str, $mask) = (@_, 0);
		1046	my %color = ( fg => undef, bg => undef );
		1047	my @failed;
		1048	for my $spec ( split /\s+/, $str ) {
		1049	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1050	$color{lc($1)} = $2;
		1051	} else {
		1052	my $neg = $spec =~ s/^[-^]//;
		1053	unless ( exists &{"RS_$spec"} ) {
		1054	push @failed, $spec;
		1055	next;
		1056	}
		1057	my $cur = &{"RS_$spec"};
		1058	if ( $neg ) {
		1059	$mask &= ~$cur;
		1060	} else {
		1061	$mask \|= $cur;
		1062	}
		1063	}
		1064	}
		1065	($mask, @color{qw(fg bg)}, \@failed)
925	}	1066	}
926		1067
927	# urxvt::term::extension	1068	# urxvt::term::extension
928		1069
929	package urxvt::term::extension;	1070	package urxvt::term::extension;
…		…
1000	is that you cannot use blocking APIs, but the non-blocking variant should	1141	is that you cannot use blocking APIs, but the non-blocking variant should
1001	work.	1142	work.
1002		1143
1003	=cut	1144	=cut
1004		1145
1005	our $VERSION = 1;	1146	our $VERSION = '5.23';
1006		1147
1007	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1148	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1008	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1149	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1009		1150
1010	sub timer {	1151	sub timer {
…		…
1012		1153
1013	my $cb = $arg{cb};	1154	my $cb = $arg{cb};
1014		1155
1015	urxvt::timer	1156	urxvt::timer
1016	->new	1157	->new
1017	->start (urxvt::NOW + $arg{after})	1158	->after ($arg{after}, $arg{interval})
1018	->cb (sub {	1159	->cb ($arg{interval} ? $cb : sub {
1019	$_[0]->stop; # need to cancel manually	1160	$_[0]->stop; # need to cancel manually
1020	$cb->();	1161	$cb->();
1021	})	1162	})
1022	}	1163	}
1023		1164
1024	sub io {	1165	sub io {
1025	my ($class, %arg) = @_;	1166	my ($class, %arg) = @_;
1026		1167
1027	my $cb = $arg{cb};	1168	my $cb = $arg{cb};
		1169	my $fd = fileno $arg{fh};
		1170	defined $fd or $fd = $arg{fh};
1028		1171
1029	bless [$arg{fh}, urxvt::iow	1172	bless [$arg{fh}, urxvt::iow
1030	->new	1173	->new
1031	->fd (fileno $arg{fh})	1174	->fd ($fd)
1032	->events (($arg{poll} =~ /r/ ? 1 : 0)	1175	->events (($arg{poll} =~ /r/ ? 1 : 0)
1033	\| ($arg{poll} =~ /w/ ? 2 : 0))	1176	\| ($arg{poll} =~ /w/ ? 2 : 0))
1034	->start	1177	->start
1035	->cb (sub {	1178	->cb ($cb)
1036	$cb->(($_[1] & 1 ? 'r' : '')
1037	. ($_[1] & 2 ? 'w' : ''));
1038	})],
1039	urxvt::anyevent::	1179	], urxvt::anyevent::
		1180	}
		1181
		1182	sub idle {
		1183	my ($class, %arg) = @_;
		1184
		1185	my $cb = $arg{cb};
		1186
		1187	urxvt::iw
		1188	->new
		1189	->start
		1190	->cb ($cb)
		1191	}
		1192
		1193	sub child {
		1194	my ($class, %arg) = @_;
		1195
		1196	my $cb = $arg{cb};
		1197
		1198	urxvt::pw
		1199	->new
		1200	->start ($arg{pid})
		1201	->cb (sub {
		1202	$_[0]->stop; # need to cancel manually
		1203	$cb->($_[0]->rpid, $_[0]->rstatus);
		1204	})
1040	}	1205	}
1041		1206
1042	sub DESTROY {	1207	sub DESTROY {
1043	$_[0][1]->stop;	1208	$_[0][1]->stop;
1044	}	1209	}
1045		1210
1046	sub condvar {	1211	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";	1212	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1057	}
1058	}	1213	}
1059		1214
1060	package urxvt::term;	1215	package urxvt::term;
1061		1216
1062	=head2 The C<urxvt::term> Class	1217	=head2 The C<urxvt::term> Class
…		…
1149		1304
1150	Returns true if the option specified by C<$optval> is enabled, and	1305	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	1306	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.	1307	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1153		1308
1154	Here is a a likely non-exhaustive list of option names, please see the	1309	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:	1310	source file F</src/optinc.h> to see the actual list:
1156		1311
1157	borderLess console cursorBlink cursorUnderline hold iconic insecure	1312	borderLess console cursorBlink cursorUnderline hold iconic insecure
1158	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1313	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1159	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1314	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1176	likely change).	1331	likely change).
1177		1332
1178	Please note that resource strings will currently only be freed when the	1333	Please note that resource strings will currently only be freed when the
1179	terminal is destroyed, so changing options frequently will eat memory.	1334	terminal is destroyed, so changing options frequently will eat memory.
1180		1335
1181	Here is a a likely non-exhaustive list of resource names, not all of which	1336	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>	1337	are supported in every build, please see the source file F</src/rsinc.h>
1183	to see the actual list:	1338	to see the actual list:
1184		1339
1185	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1340	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1186	borderLess color cursorBlink cursorUnderline cutchars delete_key	1341	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1187	display_name embed ext_bwidth fade font geometry hold iconName	1342	display_name embed ext_bwidth fade font geometry hold iconName
1188	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1343	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1189	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1344	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1190	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1345	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1191	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1346	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1192	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1347	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1193	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1348	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1194	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1349	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1195	secondaryScreen secondaryScroll selectstyle shade term_name title	1350	secondaryScreen secondaryScroll shade term_name title
1196	transient_for transparent transparent_all tripleclickwords utmpInhibit	1351	transient_for transparent transparent_all tripleclickwords utmpInhibit
1197	visualBell	1352	visualBell
1198		1353
1199	=cut	1354	=cut
1200		1355
1201	sub resource($$;$) {	1356	sub resource($$;$) {
1202	my ($self, $name) = (shift, shift);	1357	my ($self, $name) = (shift, shift);
1203	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1358	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1204	&urxvt::term::_resource	1359	goto &urxvt::term::_resource
1205	}	1360	}
1206		1361
1207	=item $value = $term->x_resource ($pattern)	1362	=item $value = $term->x_resource ($pattern)
1208		1363
1209	Returns the X-Resource for the given pattern, excluding the program or	1364	Returns the X-Resource for the given pattern, excluding the program or
…		…
1234		1389
1235	=item ($row, $col) = $term->selection_beg ([$row, $col])	1390	=item ($row, $col) = $term->selection_beg ([$row, $col])
1236		1391
1237	=item ($row, $col) = $term->selection_end ([$row, $col])	1392	=item ($row, $col) = $term->selection_end ([$row, $col])
1238		1393
1239	Return the current values of the selection mark, begin or end positions,	1394	Return the current values of the selection mark, begin or end positions.
1240	and optionally set them to new values.	1395
		1396	When arguments are given, then the selection coordinates are set to
		1397	C<$row> and C<$col>, and the selection screen is set to the current
		1398	screen.
		1399
		1400	=item $screen = $term->selection_screen ([$screen])
		1401
		1402	Returns the current selection screen, and then optionally sets it.
1241		1403
1242	=item $term->selection_make ($eventtime[, $rectangular])	1404	=item $term->selection_make ($eventtime[, $rectangular])
1243		1405
1244	Tries to make a selection as set by C<selection_beg> and	1406	Tries to make a selection as set by C<selection_beg> and
1245	C<selection_end>. If C<$rectangular> is true (default: false), a	1407	C<selection_end>. If C<$rectangular> is true (default: false), a
1246	rectangular selection will be made. This is the prefered function to make	1408	rectangular selection will be made. This is the preferred function to make
1247	a selection.	1409	a selection.
1248		1410
1249	=item $success = $term->selection_grab ($eventtime)	1411	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1250		1412
1251	Try to request the primary selection text from the server (for example, as	1413	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1414	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	1415	with the next method. No visual feedback will be given. This function
1253	is mostly useful from within C<on_sel_grab> hooks.	1416	is mostly useful from within C<on_sel_grab> hooks.
1254		1417
1255	=item $oldtext = $term->selection ([$newtext])	1418	=item $oldtext = $term->selection ([$newtext, $clipboard])
1256		1419
1257	Return the current selection text and optionally replace it by C<$newtext>.	1420	Return the current selection (clipboard if C<$clipboard> is true) text
		1421	and optionally replace it by C<$newtext>.
		1422
		1423	=item $term->selection_clear ([$clipboard])
		1424
		1425	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1258		1426
1259	=item $term->overlay_simple ($x, $y, $text)	1427	=item $term->overlay_simple ($x, $y, $text)
1260		1428
1261	Create a simple multi-line overlay box. See the next method for details.	1429	Create a simple multi-line overlay box. See the next method for details.
1262		1430
…		…
1292		1460
1293	The methods currently supported on C<urxvt::overlay> objects are:	1461	The methods currently supported on C<urxvt::overlay> objects are:
1294		1462
1295	=over 4	1463	=over 4
1296		1464
1297	=item $overlay->set ($x, $y, $text, $rend)	1465	=item $overlay->set ($x, $y, $text[, $rend])
1298		1466
1299	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1467	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	1468	text in rxvt-unicode's special encoding and an array of rendition values
1301	at a specific position inside the overlay.	1469	at a specific position inside the overlay.
		1470
		1471	If C<$rend> is missing, then the rendition will not be changed.
1302		1472
1303	=item $overlay->hide	1473	=item $overlay->hide
1304		1474
1305	If visible, hide the overlay, but do not destroy it.	1475	If visible, hide the overlay, but do not destroy it.
1306		1476
…		…
1388	locale-specific encoding of the terminal and can contain command sequences	1558	locale-specific encoding of the terminal and can contain command sequences
1389	(escape codes) that will be interpreted.	1559	(escape codes) that will be interpreted.
1390		1560
1391	=item $term->tt_write ($octets)	1561	=item $term->tt_write ($octets)
1392		1562
1393	Write the octets given in C<$data> to the tty (i.e. as program input). To	1563	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	1564	pass characters instead of octets, you should convert your strings first
1395	to the locale-specific encoding using C<< $term->locale_encode >>.	1565	to the locale-specific encoding using C<< $term->locale_encode >>.
		1566
		1567	=item $term->tt_paste ($octets)
		1568
		1569	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1570	CR and bracketing the data with control sequences if bracketed paste mode
		1571	is set.
1396		1572
1397	=item $old_events = $term->pty_ev_events ([$new_events])	1573	=item $old_events = $term->pty_ev_events ([$new_events])
1398		1574
1399	Replaces the event mask of the pty watcher by the given event mask. Can	1575	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	1576	be used to suppress input and output handling to the pty/tty. See the
…		…
1468	=item $env = $term->env	1644	=item $env = $term->env
1469		1645
1470	Returns a copy of the environment in effect for the terminal as a hashref	1646	Returns a copy of the environment in effect for the terminal as a hashref
1471	similar to C<\%ENV>.	1647	similar to C<\%ENV>.
1472		1648
		1649	=item @envv = $term->envv
		1650
		1651	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1652
		1653	=item @argv = $term->argv
		1654
		1655	Return the argument vector as this terminal, similar to @ARGV, but
		1656	includes the program name as first element.
		1657
1473	=cut	1658	=cut
1474		1659
1475	sub env {	1660	sub env {
1476	if (my $env = $_[0]->_env) {
1477	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1661	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1478	} else {
1479	+{ %ENV }
1480	}
1481	}	1662	}
1482		1663
1483	=item $modifiermask = $term->ModLevel3Mask	1664	=item $modifiermask = $term->ModLevel3Mask
1484		1665
1485	=item $modifiermask = $term->ModMetaMask	1666	=item $modifiermask = $term->ModMetaMask
…		…
1493		1674
1494	Returns the currently displayed screen (0 primary, 1 secondary).	1675	Returns the currently displayed screen (0 primary, 1 secondary).
1495		1676
1496	=item $cursor_is_hidden = $term->hidden_cursor	1677	=item $cursor_is_hidden = $term->hidden_cursor
1497		1678
1498	Returns wether the cursor is currently hidden or not.	1679	Returns whether the cursor is currently hidden or not.
1499		1680
1500	=item $view_start = $term->view_start ([$newvalue])	1681	=item $view_start = $term->view_start ([$newvalue])
1501		1682
1502	Returns the row number of the topmost displayed line. Maximum value is	1683	Returns the row number of the topmost displayed line. Maximum value is
1503	C<0>, which displays the normal terminal contents. Lower values scroll	1684	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1511		1692
1512	Used after changing terminal contents to display them.	1693	Used after changing terminal contents to display them.
1513		1694
1514	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1695	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1515		1696
1516	Returns the text of the entire row with number C<$row_number>. Row C<0>	1697	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	1698	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	1699	terminal line. Nothing will be returned if a nonexistent line
1520	is requested.	1700	is requested.
1521		1701
1522	If C<$new_text> is specified, it will replace characters in the current	1702	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	1703	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	1704	to replace only parts of a line. The font index in the rendition will
1525	automatically be updated.	1705	automatically be updated.
1526		1706
1527	C<$text> is in a special encoding: tabs and wide characters that use more	1707	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)	1708	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1529	characters. Characters with combining characters and other characters that	1709	characters. Characters with combining characters and other characters that
1530	do not fit into the normal tetx encoding will be replaced with characters	1710	do not fit into the normal text encoding will be replaced with characters
1531	in the private use area.	1711	in the private use area.
1532		1712
1533	You have to obey this encoding when changing text. The advantage is	1713	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	1714	that C<substr> and similar functions work on screen cells and not on
1535	characters.	1715	characters.
…		…
1680	where one character corresponds to one screen cell. See	1860	where one character corresponds to one screen cell. See
1681	C<< $term->ROW_t >> for details.	1861	C<< $term->ROW_t >> for details.
1682		1862
1683	=item $string = $term->special_decode $text	1863	=item $string = $term->special_decode $text
1684		1864
1685	Converts rxvt-unicodes text reprsentation into a perl string. See	1865	Converts rxvt-unicodes text representation into a perl string. See
1686	C<< $term->ROW_t >> for details.	1866	C<< $term->ROW_t >> for details.
1687		1867
1688	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1868	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1689		1869
1690	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1870	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1693	manpage.	1873	manpage.
1694		1874
1695	=item $success = $term->grab ($eventtime[, $sync])	1875	=item $success = $term->grab ($eventtime[, $sync])
1696		1876
1697	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1877	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1698	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1878	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1699		1879
1700	=item $term->allow_events_async	1880	=item $term->allow_events_async
1701		1881
1702	Calls XAllowEvents with AsyncBoth for the most recent grab.	1882	Calls XAllowEvents with AsyncBoth for the most recent grab.
1703		1883
…		…
1710	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1890	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1711	recent grab.	1891	recent grab.
1712		1892
1713	=item $term->ungrab	1893	=item $term->ungrab
1714		1894
1715	Calls XUngrab for the most recent grab. Is called automatically on	1895	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	1896	evaluation errors, as it is better to lose the grab in the error case as
1717	the session.	1897	the session.
1718		1898
1719	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1899	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1720		1900
…		…
1722		1902
1723	=item @atoms = $term->XListProperties ($window)	1903	=item @atoms = $term->XListProperties ($window)
1724		1904
1725	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1905	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1726		1906
1727	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1907	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1728		1908
1729	=item $term->XDeleteProperty ($window, $property)	1909	=item $term->XDeleteProperty ($window, $property)
1730		1910
1731	=item $window = $term->DefaultRootWindow	1911	=item $window = $term->DefaultRootWindow
1732		1912
…		…
1742		1922
1743	=item $term->XChangeInput ($window, $add_events[, $del_events])	1923	=item $term->XChangeInput ($window, $add_events[, $del_events])
1744		1924
1745	Various X or X-related functions. The C<$term> object only serves as	1925	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	1926	the source of the display, otherwise those functions map more-or-less
1747	directory onto the X functions of the same name.	1927	directly onto the X functions of the same name.
1748		1928
1749	=back	1929	=back
1750		1930
1751	=cut	1931	=cut
1752		1932
…		…
1854	my $env = $self->{term}->env;	2034	my $env = $self->{term}->env;
1855	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2035	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1856	delete $env->{LC_ALL};	2036	delete $env->{LC_ALL};
1857	$env->{LC_CTYPE} = $self->{term}->locale;	2037	$env->{LC_CTYPE} = $self->{term}->locale;
1858		2038
1859	urxvt::term->new ($env, "popup",	2039	my $term = urxvt::term->new (
		2040	$env, "popup",
1860	"--perl-lib" => "", "--perl-ext-common" => "",	2041	"--perl-lib" => "", "--perl-ext-common" => "",
1861	"-pty-fd" => -1, "-sl" => 0,	2042	"-pty-fd" => -1, "-sl" => 0,
1862	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2043	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1863	"--transient-for" => $self->{term}->parent,	2044	"--transient-for" => $self->{term}->parent,
1864	"-display" => $self->{term}->display_id,	2045	"-display" => $self->{term}->display_id,
1865	"-pe" => "urxvt-popup")	2046	"-pe" => "urxvt-popup",
1866	or die "unable to create popup window\n";	2047	) or die "unable to create popup window\n";
		2048
		2049	unless (delete $term->{urxvt_popup_init_done}) {
		2050	$term->ungrab;
		2051	$term->destroy;
		2052	die "unable to initialise popup window\n";
		2053	}
1867	}	2054	}
1868		2055
1869	sub DESTROY {	2056	sub DESTROY {
1870	my ($self) = @_;	2057	my ($self) = @_;
1871		2058
…		…
1876	=back	2063	=back
1877		2064
1878	=cut	2065	=cut
1879		2066
1880	package urxvt::watcher;	2067	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		2068
1887	=head2 The C<urxvt::timer> Class	2069	=head2 The C<urxvt::timer> Class
1888		2070
1889	This class implements timer watchers/events. Time is represented as a	2071	This class implements timer watchers/events. Time is represented as a
1890	fractional number of seconds since the epoch. Example:	2072	fractional number of seconds since the epoch. Example:
…		…
1894	->new	2076	->new
1895	->interval (1)	2077	->interval (1)
1896	->cb (sub {	2078	->cb (sub {
1897	$term->{overlay}->set (0, 0,	2079	$term->{overlay}->set (0, 0,
1898	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2080	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1899	});	2081	});
1900		2082
1901	=over 4	2083	=over 4
1902		2084
1903	=item $timer = new urxvt::timer	2085	=item $timer = new urxvt::timer
1904		2086
…		…
1907		2089
1908	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2090	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1909		2091
1910	Set the callback to be called when the timer triggers.	2092	Set the callback to be called when the timer triggers.
1911		2093
1912	=item $tstamp = $timer->at
1913
1914	Return the time this watcher will fire next.
1915
1916	=item $timer = $timer->set ($tstamp)	2094	=item $timer = $timer->set ($tstamp[, $interval])
1917		2095
1918	Set the time the event is generated to $tstamp.	2096	Set the time the event is generated to $tstamp (and optionally specifies a
		2097	new $interval).
1919		2098
1920	=item $timer = $timer->interval ($interval)	2099	=item $timer = $timer->interval ($interval)
1921		2100
1922	Normally (and when C<$interval> is C<0>), the timer will automatically	2101	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	2102	stop after it has fired once. If C<$interval> is non-zero, then the timer
1924	is automatically rescheduled at the given intervals.	2103	is automatically rescheduled at the given intervals.
1925		2104
1926	=item $timer = $timer->start	2105	=item $timer = $timer->start
1927		2106
1928	Start the timer.	2107	Start the timer.
1929		2108
1930	=item $timer = $timer->start ($tstamp)	2109	=item $timer = $timer->start ($tstamp[, $interval])
1931		2110
1932	Set the event trigger time to C<$tstamp> and start the timer.	2111	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2112	also replaces the interval.
1933		2113
1934	=item $timer = $timer->after ($delay)	2114	=item $timer = $timer->after ($delay[, $interval])
1935		2115
1936	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2116	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1937		2117
1938	=item $timer = $timer->stop	2118	=item $timer = $timer->stop
1939		2119
…		…
1947		2127
1948	$term->{socket} = ...	2128	$term->{socket} = ...
1949	$term->{iow} = urxvt::iow	2129	$term->{iow} = urxvt::iow
1950	->new	2130	->new
1951	->fd (fileno $term->{socket})	2131	->fd (fileno $term->{socket})
1952	->events (urxvt::EVENT_READ)	2132	->events (urxvt::EV_READ)
1953	->start	2133	->start
1954	->cb (sub {	2134	->cb (sub {
1955	my ($iow, $revents) = @_;	2135	my ($iow, $revents) = @_;
1956	# $revents must be 1 here, no need to check	2136	# $revents must be 1 here, no need to check
1957	sysread $term->{socket}, my $buf, 8192	2137	sysread $term->{socket}, my $buf, 8192
…		…
1970	Set the callback to be called when io events are triggered. C<$reventmask>	2150	Set the callback to be called when io events are triggered. C<$reventmask>
1971	is a bitset as described in the C<events> method.	2151	is a bitset as described in the C<events> method.
1972		2152
1973	=item $iow = $iow->fd ($fd)	2153	=item $iow = $iow->fd ($fd)
1974		2154
1975	Set the filedescriptor (not handle) to watch.	2155	Set the file descriptor (not handle) to watch.
1976		2156
1977	=item $iow = $iow->events ($eventmask)	2157	=item $iow = $iow->events ($eventmask)
1978		2158
1979	Set the event mask to watch. The only allowed values are	2159	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	2160	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1981	together, or C<urxvt::EVENT_NONE>.	2161	together, or C<urxvt::EV_NONE>.
1982		2162
1983	=item $iow = $iow->start	2163	=item $iow = $iow->start
1984		2164
1985	Start watching for requested events on the given handle.	2165	Start watching for requested events on the given handle.
1986		2166
1987	=item $iow = $iow->stop	2167	=item $iow = $iow->stop
1988		2168
1989	Stop watching for events on the given filehandle.	2169	Stop watching for events on the given file handle.
1990		2170
1991	=back	2171	=back
1992		2172
1993	=head2 The C<urxvt::iw> Class	2173	=head2 The C<urxvt::iw> Class
1994		2174
…		…
2027	->new	2207	->new
2028	->start ($pid)	2208	->start ($pid)
2029	->cb (sub {	2209	->cb (sub {
2030	my ($pw, $exit_status) = @_;	2210	my ($pw, $exit_status) = @_;
2031	...	2211	...
2032	});	2212	});
2033		2213
2034	=over 4	2214	=over 4
2035		2215
2036	=item $pw = new urxvt::pw	2216	=item $pw = new urxvt::pw
2037		2217
…		…
2041		2221
2042	Set the callback to be called when the timer triggers.	2222	Set the callback to be called when the timer triggers.
2043		2223
2044	=item $pw = $timer->start ($pid)	2224	=item $pw = $timer->start ($pid)
2045		2225
2046	Tells the wqtcher to start watching for process C<$pid>.	2226	Tells the watcher to start watching for process C<$pid>.
2047		2227
2048	=item $pw = $pw->stop	2228	=item $pw = $pw->stop
2049		2229
2050	Stop the watcher.	2230	Stop the watcher.
2051		2231
…		…
2064		2244
2065	=item >= 3 - script loading and management	2245	=item >= 3 - script loading and management
2066		2246
2067	=item >=10 - all called hooks	2247	=item >=10 - all called hooks
2068		2248
2069	=item >=11 - hook reutrn values	2249	=item >=11 - hook return values
2070		2250
2071	=back	2251	=back
2072		2252
2073	=head1 AUTHOR	2253	=head1 AUTHOR
2074		2254
…		…
2076	http://software.schmorp.de/pkg/rxvt-unicode	2256	http://software.schmorp.de/pkg/rxvt-unicode
2077		2257
2078	=cut	2258	=cut
2079		2259
2080	1	2260	1
		2261
		2262	# 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.189 by root, Sat Dec 18 15:37:10 2010 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.189 by root, Sat Dec 18 15:37:10 2010 UTC