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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
…		…
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
40	Or by adding them to the resource for extensions loaded by default:	43	Or by adding them to the resource for extensions loaded by default:
41		44
42	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
43		46
44	=over 4	47	=over 4
45		48
46	=item selection (enabled by default)	49	=item selection (enabled by default)
47		50
…		…
62	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
63	...	66	...
64		67
65	The index number (0, 1...) must not have any holes, and each regex must	68	The index number (0, 1...) must not have any holes, and each regex must
66	contain at least one pair of capturing parentheses, which will be used for	69	contain at least one pair of capturing parentheses, which will be used for
67	the match. For example, the followign adds a regex that matches everything	70	the match. For example, the following adds a regex that matches everything
68	between two vertical bars:	71	between two vertical bars:
69		72
70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
71		74
72	Another example: Programs I use often output "absolute path: " at the	75	Another example: Programs I use often output "absolute path: " at the
…		…
94	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
95		98
96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97	runtime.	100	runtime.
98		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
99	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
100		120
101	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
102	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
103	evaluation, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
104		124
105	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107	popup is displayed.	127	popup is being displayed.
108		128
109	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
110	is in C<$_>, which can be used to decide wether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
111	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
112	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
113	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
114		134
115	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
116	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
117	C<a>s:	137	C<a>s:
118		138
119	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
120	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
121	: ()	141	: ()
122	};	142	};
123		143
124	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
125		145
…		…
132	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
133	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
134	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
135	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
136	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
137	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
138		164
139	=item readline (enabled by default)	165	=item readline (enabled by default)
140		166
141	A support package that tries to make editing with readline easier. At the	167	A support package that tries to make editing with readline easier. At
142	moment, it reacts to clicking with the left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
143	move the text cursor to this position. It does so by generating as many	169	move the text cursor to this position. It does so by generating as many
144	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
145	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
146		172
147	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
148		174
149	=over 4	175	=over 4
…		…
197	the message into vi commands to load the file.	223	the message into vi commands to load the file.
198		224
199	=item tabbed	225	=item tabbed
200		226
201	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line	228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one	229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204	button per tab.	230	button per tab.
205		231
206	Clicking a button will activate that tab. Pressing B<Shift-Left> and	232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
207	B<Shift-Right> will switch to the tab left or right of the current one,	233	B<Shift-Right> will switch to the tab left or right of the current one,
…		…
217	URxvt.tabbed.tab-bg: <colour-index, default 1>	243	URxvt.tabbed.tab-bg: <colour-index, default 1>
218		244
219	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid	245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
220	indices.	246	indices.
221		247
222	=item mark-urls	248	=item matcher
223		249
224	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
225	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
226	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
227	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match 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
228		276
229	=item xim-onthespot	277	=item xim-onthespot
230		278
231	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
232	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
233	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
234	kinput2.	282	kinput2.
235		283
236	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
237	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
238		286
239	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot	287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
240		288
241	=item automove-background	289	=item kuake<hotkey>
242		290
243	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
244	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
245	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.
246		296
247	@@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.
248		313
249	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
250		315
251	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
252	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
253	similar-looking ascii character.	318	similar-looking ascii character.
254		319
255	=item digital-clock	320	=item digital-clock
256		321
257	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
258		323
259	=item remote-clipboard	324	=item remote-clipboard
260		325
261	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
262	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
263	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
264		329
265	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
266	means that one command uploads the file to a remote server, and another	331	means that one command uploads the file to a remote server, and another
267	reads it.	332	reads it.
…		…
276	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
277	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
278		343
279	=item selection-pastebin	344	=item selection-pastebin
280		345
281	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
282	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
283	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
284	F</tmp> directly.).	349	F</tmp> directly.).
285		350
286	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
302	After a successful upload the selection will be replaced by the text given	367	After a successful upload the selection will be replaced by the text given
303	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
304	for the filename):	369	for the filename):
305		370
306	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of whether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
307		391
308	=item example-refresh-hooks	392	=item example-refresh-hooks
309		393
310	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
311	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
333		417
334	=over 4	418	=over 4
335		419
336	=item $text	420	=item $text
337		421
338	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
339	always represents one screen cell. See L<ROW_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
340		424
341	=item $string	425	=item $string
342		426
343	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
351		435
352	=back	436	=back
353		437
354	=head2 Extension Objects	438	=head2 Extension Objects
355		439
356	Very perl extension is a perl class. A separate perl object is created	440	Every perl extension is a perl class. A separate perl object is created
357	for each terminal and each extension and passed as the first parameter to	441	for each terminal, and each terminal has its own set of extenion objects,
358	hooks. So extensions can use their C<$self> object without having to think	442	which are passed as the first parameter to hooks. So extensions can use
359	about other extensions, with the exception of methods and members that	443	their C<$self> object without having to think about clashes with other
		444	extensions or other terminals, with the exception of methods and members
360	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
361	use.	446	internal use.
362		447
363	Although it isn't a C<urxvt::term> object, you can call all methods of the	448	Although it isn't a C<urxvt::term> object, you can call all methods of the
364	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
365		450
366	It has the following methods and data members:	451	It has the following methods and data members:
…		…
387	=head2 Hooks	472	=head2 Hooks
388		473
389	The following subroutines can be declared in extension files, and will be	474	The following subroutines can be declared in extension files, and will be
390	called whenever the relevant event happens.	475	called whenever the relevant event happens.
391		476
392	The first argument passed to them is an extension oject as described in	477	The first argument passed to them is an extension object as described in
393	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
394		479
395	B<All> of these hooks must return a boolean value. If any of the called	480	B<All> of these hooks must return a boolean value. If any of the called
396	hooks returns true, then the event counts as being I<consumed>, and the	481	hooks returns true, then the event counts as being I<consumed>, and the
397	relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
…		…
410	place.	495	place.
411		496
412	=item on_start $term	497	=item on_start $term
413		498
414	Called at the very end of initialisation of a new terminal, just before	499	Called at the very end of initialisation of a new terminal, just before
415	trying to map (display) the toplevel and returning to the mainloop.	500	trying to map (display) the toplevel and returning to the main loop.
416		501
417	=item on_destroy $term	502	=item on_destroy $term
418		503
419	Called whenever something tries to destroy terminal, when the terminal is	504	Called whenever something tries to destroy terminal, when the terminal is
420	still fully functional (not for long, though).	505	still fully functional (not for long, though).
…		…
447		532
448	Called whenever a selection has been copied, but before the selection is	533	Called whenever a selection has been copied, but before the selection is
449	requested from the server. The selection text can be queried and changed	534	requested from the server. The selection text can be queried and changed
450	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
451		536
452	Returning a true value aborts selection grabbing. It will still be hilighted.	537	Returning a true value aborts selection grabbing. It will still be highlighted.
453		538
454	=item on_sel_extend $term	539	=item on_sel_extend $term
455		540
456	Called whenever the user tries to extend the selection (e.g. with a double	541	Called whenever the user tries to extend the selection (e.g. with a double
457	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
458	should extend the selection itelf and return true to suppress the built-in	543	should extend the selection itself and return true to suppress the built-in
459	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
460	returns true, it will be called on every further click by the user and is	545	returns true, it will be called on every further click by the user and is
461	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
462		547
463	See the F<selection> example extension.	548	See the F<selection> example extension.
464		549
465	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
466		551
467	Called whenever the view offset changes, i..e the user or program	552	Called whenever the view offset changes, i.e. the user or program
468	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
469	show this many lines of scrollback.	554	show this many lines of scrollback.
470		555
471	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
472		557
…		…
476		561
477	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
478	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
479	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
480		565
481	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
		567
		568	Called on every OSC sequence and can be used to suppress it or modify its
		569	behaviour. The default should be to return an empty list. A true value
		570	suppresses execution of the request completely. Make sure you don't get
		571	confused by recursive invocations when you output an OSC sequence within
		572	this callback.
		573
		574	C<on_osc_seq_perl> should be used for new behaviour.
		575
		576	=item on_osc_seq_perl $term, $args, $resp
482		577
483	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
484	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
485	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
486	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
487	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
488	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
489		594
490	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
491	as its source can not easily be controleld (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
492	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
493		601
494	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
495		603
496	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
497	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
502	=item on_tt_write $term, $octets	610	=item on_tt_write $term, $octets
503		611
504	Called whenever some data is written to the tty/pty and can be used to	612	Called whenever some data is written to the tty/pty and can be used to
505	suppress or filter tty input.	613	suppress or filter tty input.
506		614
		615	=item on_tt_paste $term, $octets
		616
		617	Called whenever text is about to be pasted, with the text as argument. You
		618	can filter/change and paste the text yourself by returning a true value
		619	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		620	locale-encoded.
		621
507	=item on_line_update $term, $row	622	=item on_line_update $term, $row
508		623
509	Called whenever a line was updated or changed. Can be used to filter	624	Called whenever a line was updated or changed. Can be used to filter
510	screen output (e.g. underline urls or other useless stuff). Only lines	625	screen output (e.g. underline urls or other useless stuff). Only lines
511	that are being shown will be filtered, and, due to performance reasons,	626	that are being shown will be filtered, and, due to performance reasons,
…		…
518	later with the already-modified line (e.g. if unrelated parts change), so	633	later with the already-modified line (e.g. if unrelated parts change), so
519	you cannot just toggle rendition bits, but only set them.	634	you cannot just toggle rendition bits, but only set them.
520		635
521	=item on_refresh_begin $term	636	=item on_refresh_begin $term
522		637
523	Called just before the screen gets redrawn. Can be used for overlay	638	Called just before the screen gets redrawn. Can be used for overlay or
524	or similar effects by modify terminal contents in refresh_begin, and	639	similar effects by modifying the terminal contents in refresh_begin, and
525	restoring them in refresh_end. The built-in overlay and selection display	640	restoring them in refresh_end. The built-in overlay and selection display
526	code is run after this hook, and takes precedence.	641	code is run after this hook, and takes precedence.
527		642
528	=item on_refresh_end $term	643	=item on_refresh_end $term
529		644
530	Called just after the screen gets redrawn. See C<on_refresh_begin>.	645	Called just after the screen gets redrawn. See C<on_refresh_begin>.
531		646
532	=item on_user_command $term, $string	647	=item on_user_command $term, $string
533		648
534	Called whenever the a user-configured event is being activated (e.g. via	649	Called whenever a user-configured event is being activated (e.g. via
535	a C<perl:string> action bound to a key, see description of the B<keysym>	650	a C<perl:string> action bound to a key, see description of the B<keysym>
536	resource in the @@RXVT_NAME@@(1) manpage).	651	resource in the @@RXVT_NAME@@(1) manpage).
537		652
538	The event is simply the action string. This interface is assumed to change	653	The event is simply the action string. This interface is assumed to change
539	slightly in the future.	654	slightly in the future.
		655
		656	=item on_resize_all_windows $term, $new_width, $new_height
		657
		658	Called just after the new window size has been calculated, but before
		659	windows are actually being resized or hints are being set. If this hook
		660	returns TRUE, setting of the window hints is being skipped.
540		661
541	=item on_x_event $term, $event	662	=item on_x_event $term, $event
542		663
543	Called on every X event received on the vt window (and possibly other	664	Called on every X event received on the vt window (and possibly other
544	windows). Should only be used as a last resort. Most event structure	665	windows). Should only be used as a last resort. Most event structure
545	members are not passed.	666	members are not passed.
546		667
		668	=item on_root_event $term, $event
		669
		670	Like C<on_x_event>, but is called for events on the root window.
		671
547	=item on_focus_in $term	672	=item on_focus_in $term
548		673
549	Called whenever the window gets the keyboard focus, before rxvt-unicode	674	Called whenever the window gets the keyboard focus, before rxvt-unicode
550	does focus in processing.	675	does focus in processing.
551		676
552	=item on_focus_out $term	677	=item on_focus_out $term
553		678
554	Called wheneever the window loses keyboard focus, before rxvt-unicode does	679	Called whenever the window loses keyboard focus, before rxvt-unicode does
555	focus out processing.	680	focus out processing.
556		681
557	=item on_configure_notify $term, $event	682	=item on_configure_notify $term, $event
558		683
559	=item on_property_notify $term, $event	684	=item on_property_notify $term, $event
…		…
570		695
571	=item on_map_notify $term, $event	696	=item on_map_notify $term, $event
572		697
573	=item on_unmap_notify $term, $event	698	=item on_unmap_notify $term, $event
574		699
575	Called whenever the corresponding X event is received for the terminal If	700	Called whenever the corresponding X event is received for the terminal. If
576	the hook returns true, then the even will be ignored by rxvt-unicode.	701	the hook returns true, then the event will be ignored by rxvt-unicode.
577		702
578	The event is a hash with most values as named by Xlib (see the XEvent	703	The event is a hash with most values as named by Xlib (see the XEvent
579	manpage), with the additional members C<row> and C<col>, which are the	704	manpage), with the additional members C<row> and C<col>, which are the
580	(real, not screen-based) row and column under the mouse cursor.	705	(real, not screen-based) row and column under the mouse cursor.
581		706
…		…
590		715
591	=item on_wm_delete_window $term, $event	716	=item on_wm_delete_window $term, $event
592		717
593	Called when various types of ClientMessage events are received (all with	718	Called when various types of ClientMessage events are received (all with
594	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	719	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		720
		721	=item on_bell $term
		722
		723	Called on receipt of a bell character.
595		724
596	=back	725	=back
597		726
598	=cut	727	=cut
599		728
…		…
642	The current terminal. This variable stores the current C<urxvt::term>	771	The current terminal. This variable stores the current C<urxvt::term>
643	object, whenever a callback/hook is executing.	772	object, whenever a callback/hook is executing.
644		773
645	=item @urxvt::TERM_INIT	774	=item @urxvt::TERM_INIT
646		775
647	All coderefs in this array will be called as methods of the next newly	776	All code references in this array will be called as methods of the next newly
648	created C<urxvt::term> object (during the C<on_init> phase). The array	777	created C<urxvt::term> object (during the C<on_init> phase). The array
649	gets cleared before the codereferences that were in it are being executed,	778	gets cleared before the code references that were in it are being executed,
650	so coderefs can push themselves onto it again if they so desire.	779	so references can push themselves onto it again if they so desire.
651		780
652	This complements to the perl-eval commandline option, but gets executed	781	This complements to the perl-eval command line option, but gets executed
653	first.	782	first.
654		783
655	=item @urxvt::TERM_EXT	784	=item @urxvt::TERM_EXT
656		785
657	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	786	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
682	Messages have a size limit of 1023 bytes currently.	811	Messages have a size limit of 1023 bytes currently.
683		812
684	=item @terms = urxvt::termlist	813	=item @terms = urxvt::termlist
685		814
686	Returns all urxvt::term objects that exist in this process, regardless of	815	Returns all urxvt::term objects that exist in this process, regardless of
687	wether they are started, being destroyed etc., so be careful. Only term	816	whether they are started, being destroyed etc., so be careful. Only term
688	objects that have perl extensions attached will be returned (because there	817	objects that have perl extensions attached will be returned (because there
689	is no urxvt::term objet associated with others).	818	is no urxvt::term objet associated with others).
690		819
691	=item $time = urxvt::NOW	820	=item $time = urxvt::NOW
692		821
…		…
830	local $TERM = shift;	959	local $TERM = shift;
831	my $htype = shift;	960	my $htype = shift;
832		961
833	if ($htype == 0) { # INIT	962	if ($htype == 0) { # INIT
834	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	963	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
835		964
836	my %ext_arg;	965	my %ext_arg;
837		966
838	{	967	{
839	my @init = @TERM_INIT;	968	my @init = @TERM_INIT;
840	@TERM_INIT = ();	969	@TERM_INIT = ();
…		…
854	} else {	983	} else {
855	$ext_arg{$_} \|\|= [];	984	$ext_arg{$_} \|\|= [];
856	}	985	}
857	}	986	}
858		987
859	while (my ($ext, $argv) = each %ext_arg) {	988	for my $ext (sort keys %ext_arg) {
860	my @files = grep -f $_, map "$_/$ext", @dirs;	989	my @files = grep -f $_, map "$_/$ext", @dirs;
861		990
862	if (@files) {	991	if (@files) {
863	$TERM->register_package (extension_package $files[0], $argv);	992	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
864	} else {	993	} else {
865	warn "perl extension '$ext' not found in perl library search path\n";	994	warn "perl extension '$ext' not found in perl library search path\n";
866	}	995	}
867	}	996	}
868		997
…		…
874		1003
875	if (my $cb = $TERM->{_hook}[$htype]) {	1004	if (my $cb = $TERM->{_hook}[$htype]) {
876	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1005	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
877	if $verbosity >= 10;	1006	if $verbosity >= 10;
878		1007
879	keys %$cb;	1008	for my $pkg (keys %$cb) {
880
881	while (my ($pkg, $cb) = each %$cb) {
882	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	1009	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
883	$retval \|\|= $retval_;	1010	$retval \|\|= $retval_;
884		1011
885	if ($@) {	1012	if ($@) {
886	$TERM->ungrab; # better to lose the grab than the session	1013	$TERM->ungrab; # better to lose the grab than the session
887	warn $@;	1014	warn $@;
…		…
903	$retval	1030	$retval
904	}	1031	}
905		1032
906	sub SET_COLOR($$$) {	1033	sub SET_COLOR($$$) {
907	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])	1034	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1035	}
		1036
		1037	sub rend2mask {
		1038	no strict 'refs';
		1039	my ($str, $mask) = (@_, 0);
		1040	my %color = ( fg => undef, bg => undef );
		1041	my @failed;
		1042	for my $spec ( split /\s+/, $str ) {
		1043	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1044	$color{lc($1)} = $2;
		1045	} else {
		1046	my $neg = $spec =~ s/^[-^]//;
		1047	unless ( exists &{"RS_$spec"} ) {
		1048	push @failed, $spec;
		1049	next;
		1050	}
		1051	my $cur = &{"RS_$spec"};
		1052	if ( $neg ) {
		1053	$mask &= ~$cur;
		1054	} else {
		1055	$mask \|= $cur;
		1056	}
		1057	}
		1058	}
		1059	($mask, @color{qw(fg bg)}, \@failed)
908	}	1060	}
909		1061
910	# urxvt::term::extension	1062	# urxvt::term::extension
911		1063
912	package urxvt::term::extension;	1064	package urxvt::term::extension;
…		…
983	is that you cannot use blocking APIs, but the non-blocking variant should	1135	is that you cannot use blocking APIs, but the non-blocking variant should
984	work.	1136	work.
985		1137
986	=cut	1138	=cut
987		1139
988	our $VERSION = 1;	1140	our $VERSION = '5.23';
989		1141
990	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1142	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
991	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1143	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
992		1144
993	sub timer {	1145	sub timer {
…		…
995		1147
996	my $cb = $arg{cb};	1148	my $cb = $arg{cb};
997		1149
998	urxvt::timer	1150	urxvt::timer
999	->new	1151	->new
1000	->start (urxvt::NOW + $arg{after})	1152	->after ($arg{after}, $arg{interval})
1001	->cb (sub {	1153	->cb ($arg{interval} ? $cb : sub {
1002	$_[0]->stop; # need to cancel manually	1154	$_[0]->stop; # need to cancel manually
1003	$cb->();	1155	$cb->();
1004	})	1156	})
1005	}	1157	}
1006		1158
1007	sub io {	1159	sub io {
1008	my ($class, %arg) = @_;	1160	my ($class, %arg) = @_;
1009		1161
1010	my $cb = $arg{cb};	1162	my $cb = $arg{cb};
		1163	my $fd = fileno $arg{fh};
		1164	defined $fd or $fd = $arg{fh};
1011		1165
1012	bless [$arg{fh}, urxvt::iow	1166	bless [$arg{fh}, urxvt::iow
1013	->new	1167	->new
1014	->fd (fileno $arg{fh})	1168	->fd ($fd)
1015	->events (($arg{poll} =~ /r/ ? 1 : 0)	1169	->events (($arg{poll} =~ /r/ ? 1 : 0)
1016	\| ($arg{poll} =~ /w/ ? 2 : 0))	1170	\| ($arg{poll} =~ /w/ ? 2 : 0))
1017	->start	1171	->start
1018	->cb (sub {	1172	->cb ($cb)
1019	$cb->(($_[1] & 1 ? 'r' : '')
1020	. ($_[1] & 2 ? 'w' : ''));
1021	})],
1022	urxvt::anyevent::	1173	], urxvt::anyevent::
		1174	}
		1175
		1176	sub idle {
		1177	my ($class, %arg) = @_;
		1178
		1179	my $cb = $arg{cb};
		1180
		1181	urxvt::iw
		1182	->new
		1183	->start
		1184	->cb ($cb)
		1185	}
		1186
		1187	sub child {
		1188	my ($class, %arg) = @_;
		1189
		1190	my $cb = $arg{cb};
		1191
		1192	urxvt::pw
		1193	->new
		1194	->start ($arg{pid})
		1195	->cb (sub {
		1196	$_[0]->stop; # need to cancel manually
		1197	$cb->($_[0]->rpid, $_[0]->rstatus);
		1198	})
1023	}	1199	}
1024		1200
1025	sub DESTROY {	1201	sub DESTROY {
1026	$_[0][1]->stop;	1202	$_[0][1]->stop;
1027	}	1203	}
1028		1204
1029	sub condvar {	1205	sub one_event {
1030	bless \my $flag, urxvt::anyevent::condvar::
1031	}
1032
1033	sub urxvt::anyevent::condvar::broadcast {
1034	${$_[0]}++;
1035	}
1036
1037	sub urxvt::anyevent::condvar::wait {
1038	unless (${$_[0]}) {
1039	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1206	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1040	}
1041	}	1207	}
1042		1208
1043	package urxvt::term;	1209	package urxvt::term;
1044		1210
1045	=head2 The C<urxvt::term> Class	1211	=head2 The C<urxvt::term> Class
…		…
1132		1298
1133	Returns true if the option specified by C<$optval> is enabled, and	1299	Returns true if the option specified by C<$optval> is enabled, and
1134	optionally change it. All option values are stored by name in the hash	1300	optionally change it. All option values are stored by name in the hash
1135	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1301	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1136		1302
1137	Here is a a likely non-exhaustive list of option names, please see the	1303	Here is a likely non-exhaustive list of option names, please see the
1138	source file F</src/optinc.h> to see the actual list:	1304	source file F</src/optinc.h> to see the actual list:
1139		1305
1140	borderLess console cursorBlink cursorUnderline hold iconic insecure	1306	borderLess console cursorBlink cursorUnderline hold iconic insecure
1141	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1307	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1142	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1308	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1159	likely change).	1325	likely change).
1160		1326
1161	Please note that resource strings will currently only be freed when the	1327	Please note that resource strings will currently only be freed when the
1162	terminal is destroyed, so changing options frequently will eat memory.	1328	terminal is destroyed, so changing options frequently will eat memory.
1163		1329
1164	Here is a a likely non-exhaustive list of resource names, not all of which	1330	Here is a likely non-exhaustive list of resource names, not all of which
1165	are supported in every build, please see the source file F</src/rsinc.h>	1331	are supported in every build, please see the source file F</src/rsinc.h>
1166	to see the actual list:	1332	to see the actual list:
1167		1333
1168	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1334	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1169	borderLess color cursorBlink cursorUnderline cutchars delete_key	1335	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1170	display_name embed ext_bwidth fade font geometry hold iconName	1336	display_name embed ext_bwidth fade font geometry hold iconName
1171	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1337	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1172	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1338	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1173	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1339	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1174	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1340	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1175	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1341	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1176	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1342	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1177	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1343	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1178	secondaryScreen secondaryScroll selectstyle shade term_name title	1344	secondaryScreen secondaryScroll shade term_name title
1179	transient_for transparent transparent_all tripleclickwords utmpInhibit	1345	transient_for transparent transparent_all tripleclickwords utmpInhibit
1180	visualBell	1346	visualBell
1181		1347
1182	=cut	1348	=cut
1183		1349
1184	sub resource($$;$) {	1350	sub resource($$;$) {
1185	my ($self, $name) = (shift, shift);	1351	my ($self, $name) = (shift, shift);
1186	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1352	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1187	&urxvt::term::_resource	1353	goto &urxvt::term::_resource
1188	}	1354	}
1189		1355
1190	=item $value = $term->x_resource ($pattern)	1356	=item $value = $term->x_resource ($pattern)
1191		1357
1192	Returns the X-Resource for the given pattern, excluding the program or	1358	Returns the X-Resource for the given pattern, excluding the program or
…		…
1217		1383
1218	=item ($row, $col) = $term->selection_beg ([$row, $col])	1384	=item ($row, $col) = $term->selection_beg ([$row, $col])
1219		1385
1220	=item ($row, $col) = $term->selection_end ([$row, $col])	1386	=item ($row, $col) = $term->selection_end ([$row, $col])
1221		1387
1222	Return the current values of the selection mark, begin or end positions,	1388	Return the current values of the selection mark, begin or end positions.
1223	and optionally set them to new values.	1389
		1390	When arguments are given, then the selection coordinates are set to
		1391	C<$row> and C<$col>, and the selection screen is set to the current
		1392	screen.
		1393
		1394	=item $screen = $term->selection_screen ([$screen])
		1395
		1396	Returns the current selection screen, and then optionally sets it.
1224		1397
1225	=item $term->selection_make ($eventtime[, $rectangular])	1398	=item $term->selection_make ($eventtime[, $rectangular])
1226		1399
1227	Tries to make a selection as set by C<selection_beg> and	1400	Tries to make a selection as set by C<selection_beg> and
1228	C<selection_end>. If C<$rectangular> is true (default: false), a	1401	C<selection_end>. If C<$rectangular> is true (default: false), a
1229	rectangular selection will be made. This is the prefered function to make	1402	rectangular selection will be made. This is the preferred function to make
1230	a selection.	1403	a selection.
1231		1404
1232	=item $success = $term->selection_grab ($eventtime)	1405	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1233		1406
1234	Try to request the primary selection text from the server (for example, as	1407	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1408	true) selection from the server. The corresponding text can be set
1235	set by the next method). No visual feedback will be given. This function	1409	with the next method. No visual feedback will be given. This function
1236	is mostly useful from within C<on_sel_grab> hooks.	1410	is mostly useful from within C<on_sel_grab> hooks.
1237		1411
1238	=item $oldtext = $term->selection ([$newtext])	1412	=item $oldtext = $term->selection ([$newtext, $clipboard])
1239		1413
1240	Return the current selection text and optionally replace it by C<$newtext>.	1414	Return the current selection (clipboard if C<$clipboard> is true) text
		1415	and optionally replace it by C<$newtext>.
		1416
		1417	=item $term->selection_clear ([$clipboard])
		1418
		1419	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1241		1420
1242	=item $term->overlay_simple ($x, $y, $text)	1421	=item $term->overlay_simple ($x, $y, $text)
1243		1422
1244	Create a simple multi-line overlay box. See the next method for details.	1423	Create a simple multi-line overlay box. See the next method for details.
1245		1424
…		…
1275		1454
1276	The methods currently supported on C<urxvt::overlay> objects are:	1455	The methods currently supported on C<urxvt::overlay> objects are:
1277		1456
1278	=over 4	1457	=over 4
1279		1458
1280	=item $overlay->set ($x, $y, $text, $rend)	1459	=item $overlay->set ($x, $y, $text[, $rend])
1281		1460
1282	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1461	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1283	text in rxvt-unicode's special encoding and an array of rendition values	1462	text in rxvt-unicode's special encoding and an array of rendition values
1284	at a specific position inside the overlay.	1463	at a specific position inside the overlay.
		1464
		1465	If C<$rend> is missing, then the rendition will not be changed.
1285		1466
1286	=item $overlay->hide	1467	=item $overlay->hide
1287		1468
1288	If visible, hide the overlay, but do not destroy it.	1469	If visible, hide the overlay, but do not destroy it.
1289		1470
…		…
1371	locale-specific encoding of the terminal and can contain command sequences	1552	locale-specific encoding of the terminal and can contain command sequences
1372	(escape codes) that will be interpreted.	1553	(escape codes) that will be interpreted.
1373		1554
1374	=item $term->tt_write ($octets)	1555	=item $term->tt_write ($octets)
1375		1556
1376	Write the octets given in C<$data> to the tty (i.e. as program input). To	1557	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1377	pass characters instead of octets, you should convert your strings first	1558	pass characters instead of octets, you should convert your strings first
1378	to the locale-specific encoding using C<< $term->locale_encode >>.	1559	to the locale-specific encoding using C<< $term->locale_encode >>.
		1560
		1561	=item $term->tt_paste ($octets)
		1562
		1563	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1564	CR and bracketing the data with control sequences if bracketed paste mode
		1565	is set.
1379		1566
1380	=item $old_events = $term->pty_ev_events ([$new_events])	1567	=item $old_events = $term->pty_ev_events ([$new_events])
1381		1568
1382	Replaces the event mask of the pty watcher by the given event mask. Can	1569	Replaces the event mask of the pty watcher by the given event mask. Can
1383	be used to suppress input and output handling to the pty/tty. See the	1570	be used to suppress input and output handling to the pty/tty. See the
…		…
1451	=item $env = $term->env	1638	=item $env = $term->env
1452		1639
1453	Returns a copy of the environment in effect for the terminal as a hashref	1640	Returns a copy of the environment in effect for the terminal as a hashref
1454	similar to C<\%ENV>.	1641	similar to C<\%ENV>.
1455		1642
		1643	=item @envv = $term->envv
		1644
		1645	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1646
		1647	=item @argv = $term->argv
		1648
		1649	Return the argument vector as this terminal, similar to @ARGV, but
		1650	includes the program name as first element.
		1651
1456	=cut	1652	=cut
1457		1653
1458	sub env {	1654	sub env {
1459	if (my $env = $_[0]->_env) {
1460	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1655	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1461	} else {
1462	+{ %ENV }
1463	}
1464	}	1656	}
1465		1657
1466	=item $modifiermask = $term->ModLevel3Mask	1658	=item $modifiermask = $term->ModLevel3Mask
1467		1659
1468	=item $modifiermask = $term->ModMetaMask	1660	=item $modifiermask = $term->ModMetaMask
…		…
1476		1668
1477	Returns the currently displayed screen (0 primary, 1 secondary).	1669	Returns the currently displayed screen (0 primary, 1 secondary).
1478		1670
1479	=item $cursor_is_hidden = $term->hidden_cursor	1671	=item $cursor_is_hidden = $term->hidden_cursor
1480		1672
1481	Returns wether the cursor is currently hidden or not.	1673	Returns whether the cursor is currently hidden or not.
1482		1674
1483	=item $view_start = $term->view_start ([$newvalue])	1675	=item $view_start = $term->view_start ([$newvalue])
1484		1676
1485	Returns the row number of the topmost displayed line. Maximum value is	1677	Returns the row number of the topmost displayed line. Maximum value is
1486	C<0>, which displays the normal terminal contents. Lower values scroll	1678	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1494		1686
1495	Used after changing terminal contents to display them.	1687	Used after changing terminal contents to display them.
1496		1688
1497	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1689	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1498		1690
1499	Returns the text of the entire row with number C<$row_number>. Row C<0>	1691	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1500	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1692	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1501	terminal line. The scrollback buffer starts at line C<-1> and extends to
1502	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1693	terminal line. Nothing will be returned if a nonexistent line
1503	is requested.	1694	is requested.
1504		1695
1505	If C<$new_text> is specified, it will replace characters in the current	1696	If C<$new_text> is specified, it will replace characters in the current
1506	line, starting at column C<$start_col> (default C<0>), which is useful	1697	line, starting at column C<$start_col> (default C<0>), which is useful
1507	to replace only parts of a line. The font index in the rendition will	1698	to replace only parts of a line. The font index in the rendition will
1508	automatically be updated.	1699	automatically be updated.
1509		1700
1510	C<$text> is in a special encoding: tabs and wide characters that use more	1701	C<$text> is in a special encoding: tabs and wide characters that use more
1511	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1702	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1512	characters. Characters with combining characters and other characters that	1703	characters. Characters with combining characters and other characters that
1513	do not fit into the normal tetx encoding will be replaced with characters	1704	do not fit into the normal text encoding will be replaced with characters
1514	in the private use area.	1705	in the private use area.
1515		1706
1516	You have to obey this encoding when changing text. The advantage is	1707	You have to obey this encoding when changing text. The advantage is
1517	that C<substr> and similar functions work on screen cells and not on	1708	that C<substr> and similar functions work on screen cells and not on
1518	characters.	1709	characters.
…		…
1663	where one character corresponds to one screen cell. See	1854	where one character corresponds to one screen cell. See
1664	C<< $term->ROW_t >> for details.	1855	C<< $term->ROW_t >> for details.
1665		1856
1666	=item $string = $term->special_decode $text	1857	=item $string = $term->special_decode $text
1667		1858
1668	Converts rxvt-unicodes text reprsentation into a perl string. See	1859	Converts rxvt-unicodes text representation into a perl string. See
1669	C<< $term->ROW_t >> for details.	1860	C<< $term->ROW_t >> for details.
1670		1861
1671	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])	1862	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1672		1863
1673	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])	1864	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
…		…
1676	manpage.	1867	manpage.
1677		1868
1678	=item $success = $term->grab ($eventtime[, $sync])	1869	=item $success = $term->grab ($eventtime[, $sync])
1679		1870
1680	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1871	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1681	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1872	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1682		1873
1683	=item $term->allow_events_async	1874	=item $term->allow_events_async
1684		1875
1685	Calls XAllowEvents with AsyncBoth for the most recent grab.	1876	Calls XAllowEvents with AsyncBoth for the most recent grab.
1686		1877
…		…
1693	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1884	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1694	recent grab.	1885	recent grab.
1695		1886
1696	=item $term->ungrab	1887	=item $term->ungrab
1697		1888
1698	Calls XUngrab for the most recent grab. Is called automatically on	1889	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1699	evaluation errors, as it is better to lose the grab in the error case as	1890	evaluation errors, as it is better to lose the grab in the error case as
1700	the session.	1891	the session.
1701		1892
1702	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1893	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1703		1894
…		…
1705		1896
1706	=item @atoms = $term->XListProperties ($window)	1897	=item @atoms = $term->XListProperties ($window)
1707		1898
1708	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1899	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1709		1900
1710	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1901	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1711		1902
1712	=item $term->XDeleteProperty ($window, $property)	1903	=item $term->XDeleteProperty ($window, $property)
1713		1904
1714	=item $window = $term->DefaultRootWindow	1905	=item $window = $term->DefaultRootWindow
1715		1906
…		…
1725		1916
1726	=item $term->XChangeInput ($window, $add_events[, $del_events])	1917	=item $term->XChangeInput ($window, $add_events[, $del_events])
1727		1918
1728	Various X or X-related functions. The C<$term> object only serves as	1919	Various X or X-related functions. The C<$term> object only serves as
1729	the source of the display, otherwise those functions map more-or-less	1920	the source of the display, otherwise those functions map more-or-less
1730	directory onto the X functions of the same name.	1921	directly onto the X functions of the same name.
1731		1922
1732	=back	1923	=back
1733		1924
1734	=cut	1925	=cut
1735		1926
…		…
1799	my ($self, $text, $cb) = @_;	1990	my ($self, $text, $cb) = @_;
1800		1991
1801	$self->add_item ({ type => "button", text => $text, activate => $cb});	1992	$self->add_item ({ type => "button", text => $text, activate => $cb});
1802	}	1993	}
1803		1994
1804	=item $popup->add_toggle ($text, $cb, $initial_value)	1995	=item $popup->add_toggle ($text, $initial_value, $cb)
1805		1996
1806	Adds a toggle/checkbox item to the popup. Teh callback gets called	1997	Adds a toggle/checkbox item to the popup. The callback gets called
1807	whenever it gets toggled, with a boolean indicating its value as its first	1998	whenever it gets toggled, with a boolean indicating its new value as its
1808	argument.	1999	first argument.
1809		2000
1810	=cut	2001	=cut
1811		2002
1812	sub add_toggle {	2003	sub add_toggle {
1813	my ($self, $text, $cb, $value) = @_;	2004	my ($self, $text, $value, $cb) = @_;
1814		2005
1815	my $item; $item = {	2006	my $item; $item = {
1816	type => "button",	2007	type => "button",
1817	text => " $text",	2008	text => " $text",
1818	value => $value,	2009	value => $value,
…		…
1837	my $env = $self->{term}->env;	2028	my $env = $self->{term}->env;
1838	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2029	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1839	delete $env->{LC_ALL};	2030	delete $env->{LC_ALL};
1840	$env->{LC_CTYPE} = $self->{term}->locale;	2031	$env->{LC_CTYPE} = $self->{term}->locale;
1841		2032
1842	urxvt::term->new ($env, "popup",	2033	my $term = urxvt::term->new (
		2034	$env, "popup",
1843	"--perl-lib" => "", "--perl-ext-common" => "",	2035	"--perl-lib" => "", "--perl-ext-common" => "",
1844	"-pty-fd" => -1, "-sl" => 0,	2036	"-pty-fd" => -1, "-sl" => 0,
1845	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2037	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1846	"--transient-for" => $self->{term}->parent,	2038	"--transient-for" => $self->{term}->parent,
1847	"-display" => $self->{term}->display_id,	2039	"-display" => $self->{term}->display_id,
1848	"-pe" => "urxvt-popup")	2040	"-pe" => "urxvt-popup",
1849	or die "unable to create popup window\n";	2041	) or die "unable to create popup window\n";
		2042
		2043	unless (delete $term->{urxvt_popup_init_done}) {
		2044	$term->ungrab;
		2045	$term->destroy;
		2046	die "unable to initialise popup window\n";
		2047	}
1850	}	2048	}
1851		2049
1852	sub DESTROY {	2050	sub DESTROY {
1853	my ($self) = @_;	2051	my ($self) = @_;
1854		2052
…		…
1859	=back	2057	=back
1860		2058
1861	=cut	2059	=cut
1862		2060
1863	package urxvt::watcher;	2061	package urxvt::watcher;
1864
1865	@urxvt::timer::ISA = __PACKAGE__;
1866	@urxvt::iow::ISA = __PACKAGE__;
1867	@urxvt::pw::ISA = __PACKAGE__;
1868	@urxvt::iw::ISA = __PACKAGE__;
1869		2062
1870	=head2 The C<urxvt::timer> Class	2063	=head2 The C<urxvt::timer> Class
1871		2064
1872	This class implements timer watchers/events. Time is represented as a	2065	This class implements timer watchers/events. Time is represented as a
1873	fractional number of seconds since the epoch. Example:	2066	fractional number of seconds since the epoch. Example:
…		…
1877	->new	2070	->new
1878	->interval (1)	2071	->interval (1)
1879	->cb (sub {	2072	->cb (sub {
1880	$term->{overlay}->set (0, 0,	2073	$term->{overlay}->set (0, 0,
1881	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2074	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1882	});	2075	});
1883		2076
1884	=over 4	2077	=over 4
1885		2078
1886	=item $timer = new urxvt::timer	2079	=item $timer = new urxvt::timer
1887		2080
…		…
1890		2083
1891	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2084	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1892		2085
1893	Set the callback to be called when the timer triggers.	2086	Set the callback to be called when the timer triggers.
1894		2087
1895	=item $tstamp = $timer->at
1896
1897	Return the time this watcher will fire next.
1898
1899	=item $timer = $timer->set ($tstamp)	2088	=item $timer = $timer->set ($tstamp[, $interval])
1900		2089
1901	Set the time the event is generated to $tstamp.	2090	Set the time the event is generated to $tstamp (and optionally specifies a
		2091	new $interval).
1902		2092
1903	=item $timer = $timer->interval ($interval)	2093	=item $timer = $timer->interval ($interval)
1904		2094
1905	Normally (and when C<$interval> is C<0>), the timer will automatically	2095	By default (and when C<$interval> is C<0>), the timer will automatically
1906	stop after it has fired once. If C<$interval> is non-zero, then the timer	2096	stop after it has fired once. If C<$interval> is non-zero, then the timer
1907	is automatically rescheduled at the given intervals.	2097	is automatically rescheduled at the given intervals.
1908		2098
1909	=item $timer = $timer->start	2099	=item $timer = $timer->start
1910		2100
1911	Start the timer.	2101	Start the timer.
1912		2102
1913	=item $timer = $timer->start ($tstamp)	2103	=item $timer = $timer->start ($tstamp[, $interval])
1914		2104
1915	Set the event trigger time to C<$tstamp> and start the timer.	2105	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2106	also replaces the interval.
1916		2107
1917	=item $timer = $timer->after ($delay)	2108	=item $timer = $timer->after ($delay[, $interval])
1918		2109
1919	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2110	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1920		2111
1921	=item $timer = $timer->stop	2112	=item $timer = $timer->stop
1922		2113
…		…
1930		2121
1931	$term->{socket} = ...	2122	$term->{socket} = ...
1932	$term->{iow} = urxvt::iow	2123	$term->{iow} = urxvt::iow
1933	->new	2124	->new
1934	->fd (fileno $term->{socket})	2125	->fd (fileno $term->{socket})
1935	->events (urxvt::EVENT_READ)	2126	->events (urxvt::EV_READ)
1936	->start	2127	->start
1937	->cb (sub {	2128	->cb (sub {
1938	my ($iow, $revents) = @_;	2129	my ($iow, $revents) = @_;
1939	# $revents must be 1 here, no need to check	2130	# $revents must be 1 here, no need to check
1940	sysread $term->{socket}, my $buf, 8192	2131	sysread $term->{socket}, my $buf, 8192
…		…
1953	Set the callback to be called when io events are triggered. C<$reventmask>	2144	Set the callback to be called when io events are triggered. C<$reventmask>
1954	is a bitset as described in the C<events> method.	2145	is a bitset as described in the C<events> method.
1955		2146
1956	=item $iow = $iow->fd ($fd)	2147	=item $iow = $iow->fd ($fd)
1957		2148
1958	Set the filedescriptor (not handle) to watch.	2149	Set the file descriptor (not handle) to watch.
1959		2150
1960	=item $iow = $iow->events ($eventmask)	2151	=item $iow = $iow->events ($eventmask)
1961		2152
1962	Set the event mask to watch. The only allowed values are	2153	Set the event mask to watch. The only allowed values are
1963	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2154	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1964	together, or C<urxvt::EVENT_NONE>.	2155	together, or C<urxvt::EV_NONE>.
1965		2156
1966	=item $iow = $iow->start	2157	=item $iow = $iow->start
1967		2158
1968	Start watching for requested events on the given handle.	2159	Start watching for requested events on the given handle.
1969		2160
1970	=item $iow = $iow->stop	2161	=item $iow = $iow->stop
1971		2162
1972	Stop watching for events on the given filehandle.	2163	Stop watching for events on the given file handle.
1973		2164
1974	=back	2165	=back
1975		2166
1976	=head2 The C<urxvt::iw> Class	2167	=head2 The C<urxvt::iw> Class
1977		2168
…		…
2010	->new	2201	->new
2011	->start ($pid)	2202	->start ($pid)
2012	->cb (sub {	2203	->cb (sub {
2013	my ($pw, $exit_status) = @_;	2204	my ($pw, $exit_status) = @_;
2014	...	2205	...
2015	});	2206	});
2016		2207
2017	=over 4	2208	=over 4
2018		2209
2019	=item $pw = new urxvt::pw	2210	=item $pw = new urxvt::pw
2020		2211
…		…
2024		2215
2025	Set the callback to be called when the timer triggers.	2216	Set the callback to be called when the timer triggers.
2026		2217
2027	=item $pw = $timer->start ($pid)	2218	=item $pw = $timer->start ($pid)
2028		2219
2029	Tells the wqtcher to start watching for process C<$pid>.	2220	Tells the watcher to start watching for process C<$pid>.
2030		2221
2031	=item $pw = $pw->stop	2222	=item $pw = $pw->stop
2032		2223
2033	Stop the watcher.	2224	Stop the watcher.
2034		2225
…		…
2047		2238
2048	=item >= 3 - script loading and management	2239	=item >= 3 - script loading and management
2049		2240
2050	=item >=10 - all called hooks	2241	=item >=10 - all called hooks
2051		2242
2052	=item >=11 - hook reutrn values	2243	=item >=11 - hook return values
2053		2244
2054	=back	2245	=back
2055		2246
2056	=head1 AUTHOR	2247	=head1 AUTHOR
2057		2248
…		…
2059	http://software.schmorp.de/pkg/rxvt-unicode	2250	http://software.schmorp.de/pkg/rxvt-unicode
2060		2251
2061	=cut	2252	=cut
2062		2253
2063	1	2254	1
		2255
		2256	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC vs. Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.132 by root, Mon Feb 6 05:40:15 2006 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC