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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.125 by root, Sun Jan 22 20:39:47 2006 UTC vs.
Revision 1.180 by root, Sat Dec 26 09:42:16 2009 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: \\\|([^\|]+)\\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
71		81
72	You can look at the source of the selection extension to see more	82	You can look at the source of the selection extension to see more
73	interesting uses, such as parsing a line from beginning to end.	83	interesting uses, such as parsing a line from beginning to end.
74		84
75	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
86		96
87	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
88		98
89	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
90	runtime.	100	runtime.
		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	};
91		118
92	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
93		120
94	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
95	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
96	evaluation, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
97		124
98	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
99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100	popup is displayed.	127	popup is being displayed.
101		128
102	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
103	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.
104	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
105	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
106	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
107		134
108	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
109	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
110	C<a>s:	137	C<a>s:
111		138
112	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
113	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
114	: ()	141	: ()
115	};	142	};
116		143
117	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
118		145
…		…
125	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>
126	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
127	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
128	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
129	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
130	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.
131		164
132	=item readline (enabled by default)	165	=item readline (enabled by default)
133		166
134	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
135	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
136	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
137	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
138	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
139		172
140	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
141		174
142	=over 4	175	=over 4
…		…
190	the message into vi commands to load the file.	223	the message into vi commands to load the file.
191		224
192	=item tabbed	225	=item tabbed
193		226
194	This transforms the terminal into a tabbar with additional terminals, that	227	This transforms the terminal into a tabbar with additional terminals, that
195	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
196	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
197	button per tab.	230	button per tab.
198		231
199	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
200	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,
201	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
202		235
203	=item mark-urls	236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
204		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
205	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
206	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
207	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
208	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.
209		258
210	=item automove-background	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.
211		263
212	This is basically a one-line extension that dynamically changes the background pixmap offset	264	It is possible to activate the most recently seen match from the keyboard.
213	to the window position, in effect creating the same effect as pseudo transparency with	265	Simply bind a keysym to "perl:matcher" as seen in the example below.
214	a custom pixmap. No scaling is supported in this mode. Exmaple:
215		266
216	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background	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
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		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.
		296
		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.
217		313
218	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
219		315
220	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
221	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
222	similar-looking ascii character.	318	similar-looking ascii character.
223		319
224	=item digital-clock	320	=item digital-clock
225		321
226	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
227		323
228	=item example-refresh-hooks	324	=item remote-clipboard
229		325
230	Displays a very simple digital clock in the upper right corner of the	326	Somewhat of a misnomer, this extension adds two menu entries to the
231	window. Illustrates overwriting the refresh callbacks to create your own	327	selection popup that allows one to run external commands to store the
232	overlays or changes.	328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
233		343
234	=item selection-pastebin	344	=item selection-pastebin
235		345
236	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
237	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
…		…
257	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
258	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
259	for the filename):	369	for the filename):
260		370
261	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 wether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-pastebin and macosx-pastebin-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<maxosx-pastebin> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
		391
		392	=item example-refresh-hooks
		393
		394	Displays a very simple digital clock in the upper right corner of the
		395	window. Illustrates overwriting the refresh callbacks to create your own
		396	overlays or changes.
262		397
263	=back	398	=back
264		399
265	=head1 API DOCUMENTATION	400	=head1 API DOCUMENTATION
266		401
…		…
300		435
301	=back	436	=back
302		437
303	=head2 Extension Objects	438	=head2 Extension Objects
304		439
305	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
306	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,
307	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
308	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
309	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
310	use.	446	internal use.
311		447
312	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
313	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
314		450
315	It has the following methods and data members:	451	It has the following methods and data members:
…		…
336	=head2 Hooks	472	=head2 Hooks
337		473
338	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
339	called whenever the relevant event happens.	475	called whenever the relevant event happens.
340		476
341	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
342	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
343		479
344	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
345	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
346	relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
…		…
359	place.	495	place.
360		496
361	=item on_start $term	497	=item on_start $term
362		498
363	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
364	trying to map (display) the toplevel and returning to the mainloop.	500	trying to map (display) the toplevel and returning to the main loop.
365		501
366	=item on_destroy $term	502	=item on_destroy $term
367		503
368	Called whenever something tries to destroy terminal, before doing anything	504	Called whenever something tries to destroy terminal, when the terminal is
369	yet. If this hook returns true, then destruction is skipped, but this is	505	still fully functional (not for long, though).
370	rarely a good idea.
371		506
372	=item on_reset $term	507	=item on_reset $term
373		508
374	Called after the screen is "reset" for any reason, such as resizing or	509	Called after the screen is "reset" for any reason, such as resizing or
375	control sequences. Here is where you can react on changes to size-related	510	control sequences. Here is where you can react on changes to size-related
…		…
397		532
398	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
399	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
400	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
401		536
402	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.
403		538
404	=item on_sel_extend $term	539	=item on_sel_extend $term
405		540
406	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
407	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
408	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
409	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
410	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
411	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
412		547
413	See the F<selection> example extension.	548	See the F<selection> example extension.
414		549
415	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
416		551
417	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
418	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
419	show this many lines of scrollback.	554	show this many lines of scrollback.
420		555
421	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
422		557
…		…
426		561
427	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,
428	$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
429	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
430		565
431	=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
432		577
433	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
434	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
435	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
436	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,
437	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
438	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	}
439		594
440	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,
441	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
442	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.
443		601
444	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
445		603
446	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
447	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
…		…
468	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
469	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
470		628
471	=item on_refresh_begin $term	629	=item on_refresh_begin $term
472		630
473	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
474	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
475	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
476	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
477		635
478	=item on_refresh_end $term	636	=item on_refresh_end $term
479		637
480	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
481		639
482	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
483		641
484	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
485	C<perl:string> action bound to it (see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
486	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
		645
		646	The event is simply the action string. This interface is assumed to change
		647	slightly in the future.
		648
		649	=item on_resize_all_windows $tern, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
487		654
488	=item on_x_event $term, $event	655	=item on_x_event $term, $event
489		656
490	Called on every X event received on the vt window (and possibly other	657	Called on every X event received on the vt window (and possibly other
491	windows). Should only be used as a last resort. Most event structure	658	windows). Should only be used as a last resort. Most event structure
492	members are not passed.	659	members are not passed.
493		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
		664
494	=item on_focus_in $term	665	=item on_focus_in $term
495		666
496	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
497	does focus in processing.	668	does focus in processing.
498		669
499	=item on_focus_out $term	670	=item on_focus_out $term
500		671
501	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
502	focus out processing.	673	focus out processing.
503		674
504	=item on_configure_notify $term, $event	675	=item on_configure_notify $term, $event
505		676
506	=item on_property_notify $term, $event	677	=item on_property_notify $term, $event
…		…
589	The current terminal. This variable stores the current C<urxvt::term>	760	The current terminal. This variable stores the current C<urxvt::term>
590	object, whenever a callback/hook is executing.	761	object, whenever a callback/hook is executing.
591		762
592	=item @urxvt::TERM_INIT	763	=item @urxvt::TERM_INIT
593		764
594	All coderefs in this array will be called as methods of the next newly	765	All code references in this array will be called as methods of the next newly
595	created C<urxvt::term> object (during the C<on_init> phase). The array	766	created C<urxvt::term> object (during the C<on_init> phase). The array
596	gets cleared before the codereferences that were in it are being executed,	767	gets cleared before the code references that were in it are being executed,
597	so coderefs can push themselves onto it again if they so desire.	768	so references can push themselves onto it again if they so desire.
598		769
599	This complements to the perl-eval commandline option, but gets executed	770	This complements to the perl-eval command line option, but gets executed
600	first.	771	first.
601		772
602	=item @urxvt::TERM_EXT	773	=item @urxvt::TERM_EXT
603		774
604	Works similar to C<@TERM_INIT>, but contains perl package/class names, which	775	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
…		…
625		796
626	Using this function has the advantage that its output ends up in the	797	Using this function has the advantage that its output ends up in the
627	correct place, e.g. on stderr of the connecting urxvtc client.	798	correct place, e.g. on stderr of the connecting urxvtc client.
628		799
629	Messages have a size limit of 1023 bytes currently.	800	Messages have a size limit of 1023 bytes currently.
		801
		802	=item @terms = urxvt::termlist
		803
		804	Returns all urxvt::term objects that exist in this process, regardless of
		805	whether they are started, being destroyed etc., so be careful. Only term
		806	objects that have perl extensions attached will be returned (because there
		807	is no urxvt::term objet associated with others).
630		808
631	=item $time = urxvt::NOW	809	=item $time = urxvt::NOW
632		810
633	Returns the "current time" (as per the event loop).	811	Returns the "current time" (as per the event loop).
634		812
…		…
692	Return the foreground/background colour index, respectively.	870	Return the foreground/background colour index, respectively.
693		871
694	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	872	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
695		873
696	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	874	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		875
		876	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
697		877
698	Replace the foreground/background colour in the rendition mask with the	878	Replace the foreground/background colour in the rendition mask with the
699	specified one.	879	specified one.
700		880
701	=item $value = urxvt::GET_CUSTOM $rend	881	=item $value = urxvt::GET_CUSTOM $rend
…		…
768	local $TERM = shift;	948	local $TERM = shift;
769	my $htype = shift;	949	my $htype = shift;
770		950
771	if ($htype == 0) { # INIT	951	if ($htype == 0) { # INIT
772	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
773		953
774	my %ext_arg;	954	my %ext_arg;
775		955
776	{	956	{
777	my @init = @TERM_INIT;	957	my @init = @TERM_INIT;
778	@TERM_INIT = ();	958	@TERM_INIT = ();
…		…
792	} else {	972	} else {
793	$ext_arg{$_} \|\|= [];	973	$ext_arg{$_} \|\|= [];
794	}	974	}
795	}	975	}
796		976
797	while (my ($ext, $argv) = each %ext_arg) {	977	for my $ext (sort keys %ext_arg) {
798	my @files = grep -f $_, map "$_/$ext", @dirs;	978	my @files = grep -f $_, map "$_/$ext", @dirs;
799		979
800	if (@files) {	980	if (@files) {
801	$TERM->register_package (extension_package $files[0], $argv);	981	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
802	} else {	982	} else {
803	warn "perl extension '$ext' not found in perl library search path\n";	983	warn "perl extension '$ext' not found in perl library search path\n";
804	}	984	}
805	}	985	}
806		986
…		…
812		992
813	if (my $cb = $TERM->{_hook}[$htype]) {	993	if (my $cb = $TERM->{_hook}[$htype]) {
814	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	994	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
815	if $verbosity >= 10;	995	if $verbosity >= 10;
816		996
817	keys %$cb;	997	for my $pkg (keys %$cb) {
818
819	while (my ($pkg, $cb) = each %$cb) {
820	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	998	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
821	$retval \|\|= $retval_;	999	$retval \|\|= $retval_;
822		1000
823	if ($@) {	1001	if ($@) {
824	$TERM->ungrab; # better to lose the grab than the session	1002	$TERM->ungrab; # better to lose the grab than the session
825	warn $@;	1003	warn $@;
…		…
837	# clear package	1015	# clear package
838	%$TERM = ();	1016	%$TERM = ();
839	}	1017	}
840		1018
841	$retval	1019	$retval
		1020	}
		1021
		1022	sub SET_COLOR($$$) {
		1023	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1024	}
		1025
		1026	sub rend2mask {
		1027	no strict 'refs';
		1028	my ($str, $mask) = (@_, 0);
		1029	my %color = ( fg => undef, bg => undef );
		1030	my @failed;
		1031	for my $spec ( split /\s+/, $str ) {
		1032	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1033	$color{lc($1)} = $2;
		1034	} else {
		1035	my $neg = $spec =~ s/^[-^]//;
		1036	unless ( exists &{"RS_$spec"} ) {
		1037	push @failed, $spec;
		1038	next;
		1039	}
		1040	my $cur = &{"RS_$spec"};
		1041	if ( $neg ) {
		1042	$mask &= ~$cur;
		1043	} else {
		1044	$mask \|= $cur;
		1045	}
		1046	}
		1047	}
		1048	($mask, @color{qw(fg bg)}, \@failed)
842	}	1049	}
843		1050
844	# urxvt::term::extension	1051	# urxvt::term::extension
845		1052
846	package urxvt::term::extension;	1053	package urxvt::term::extension;
…		…
917	is that you cannot use blocking APIs, but the non-blocking variant should	1124	is that you cannot use blocking APIs, but the non-blocking variant should
918	work.	1125	work.
919		1126
920	=cut	1127	=cut
921		1128
922	our $VERSION = 1;	1129	our $VERSION = '5.23';
923		1130
924	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
925	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
926		1133
927	sub timer {	1134	sub timer {
…		…
929		1136
930	my $cb = $arg{cb};	1137	my $cb = $arg{cb};
931		1138
932	urxvt::timer	1139	urxvt::timer
933	->new	1140	->new
934	->start (urxvt::NOW + $arg{after})	1141	->after ($arg{after}, $arg{interval})
935	->cb (sub {	1142	->cb ($arg{interval} ? $cb : sub {
936	$_[0]->stop; # need to cancel manually	1143	$_[0]->stop; # need to cancel manually
937	$cb->();	1144	$cb->();
938	})	1145	})
939	}	1146	}
940		1147
941	sub io {	1148	sub io {
942	my ($class, %arg) = @_;	1149	my ($class, %arg) = @_;
943		1150
944	my $cb = $arg{cb};	1151	my $cb = $arg{cb};
		1152	my $fd = fileno $arg{fh};
		1153	defined $fd or $fd = $arg{fh};
945		1154
946	bless [$arg{fh}, urxvt::iow	1155	bless [$arg{fh}, urxvt::iow
947	->new	1156	->new
948	->fd (fileno $arg{fh})	1157	->fd ($fd)
949	->events (($arg{poll} =~ /r/ ? 1 : 0)	1158	->events (($arg{poll} =~ /r/ ? 1 : 0)
950	\| ($arg{poll} =~ /w/ ? 2 : 0))	1159	\| ($arg{poll} =~ /w/ ? 2 : 0))
951	->start	1160	->start
952	->cb (sub {	1161	->cb ($cb)
953	$cb->(($_[1] & 1 ? 'r' : '')
954	. ($_[1] & 2 ? 'w' : ''));
955	})],
956	urxvt::anyevent::	1162	], urxvt::anyevent::
		1163	}
		1164
		1165	sub idle {
		1166	my ($class, %arg) = @_;
		1167
		1168	my $cb = $arg{cb};
		1169
		1170	urxvt::iw
		1171	->new
		1172	->start
		1173	->cb ($cb)
		1174	}
		1175
		1176	sub child {
		1177	my ($class, %arg) = @_;
		1178
		1179	my $cb = $arg{cb};
		1180
		1181	urxvt::pw
		1182	->new
		1183	->start ($arg{pid})
		1184	->cb (sub {
		1185	$_[0]->stop; # need to cancel manually
		1186	$cb->($_[0]->rpid, $_[0]->rstatus);
		1187	})
957	}	1188	}
958		1189
959	sub DESTROY {	1190	sub DESTROY {
960	$_[0][1]->stop;	1191	$_[0][1]->stop;
961	}	1192	}
962		1193
963	sub condvar {	1194	sub one_event {
964	bless \my $flag, urxvt::anyevent::condvar::
965	}
966
967	sub urxvt::anyevent::condvar::broadcast {
968	${$_[0]}++;
969	}
970
971	sub urxvt::anyevent::condvar::wait {
972	unless (${$_[0]}) {
973	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1195	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
974	}
975	}	1196	}
976		1197
977	package urxvt::term;	1198	package urxvt::term;
978		1199
979	=head2 The C<urxvt::term> Class	1200	=head2 The C<urxvt::term> Class
…		…
1015	hash which defines the environment of the new terminal.	1236	hash which defines the environment of the new terminal.
1016		1237
1017	Croaks (and probably outputs an error message) if the new instance	1238	Croaks (and probably outputs an error message) if the new instance
1018	couldn't be created. Returns C<undef> if the new instance didn't	1239	couldn't be created. Returns C<undef> if the new instance didn't
1019	initialise perl, and the terminal object otherwise. The C<init> and	1240	initialise perl, and the terminal object otherwise. The C<init> and
1020	C<start> hooks will be called during this call.	1241	C<start> hooks will be called before this call returns, and are free to
		1242	refer to global data (which is race free).
1021		1243
1022	=cut	1244	=cut
1023		1245
1024	sub new {	1246	sub new {
1025	my ($class, $env, @args) = @_;	1247	my ($class, $env, @args) = @_;
1026		1248
		1249	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1250	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1251
1027	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1252	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1028	}	1253	}
1029		1254
1030	=item $term->destroy	1255	=item $term->destroy
1031		1256
1032	Destroy the terminal object (close the window, free resources	1257	Destroy the terminal object (close the window, free resources
…		…
1062		1287
1063	Returns true if the option specified by C<$optval> is enabled, and	1288	Returns true if the option specified by C<$optval> is enabled, and
1064	optionally change it. All option values are stored by name in the hash	1289	optionally change it. All option values are stored by name in the hash
1065	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1290	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1066		1291
1067	Here is a a likely non-exhaustive list of option names, please see the	1292	Here is a likely non-exhaustive list of option names, please see the
1068	source file F</src/optinc.h> to see the actual list:	1293	source file F</src/optinc.h> to see the actual list:
1069		1294
1070	borderLess console cursorBlink cursorUnderline hold iconic insecure	1295	borderLess console cursorBlink cursorUnderline hold iconic insecure
1071	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1296	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1072	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1297	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1089	likely change).	1314	likely change).
1090		1315
1091	Please note that resource strings will currently only be freed when the	1316	Please note that resource strings will currently only be freed when the
1092	terminal is destroyed, so changing options frequently will eat memory.	1317	terminal is destroyed, so changing options frequently will eat memory.
1093		1318
1094	Here is a a likely non-exhaustive list of resource names, not all of which	1319	Here is a likely non-exhaustive list of resource names, not all of which
1095	are supported in every build, please see the source file F</src/rsinc.h>	1320	are supported in every build, please see the source file F</src/rsinc.h>
1096	to see the actual list:	1321	to see the actual list:
1097		1322
1098	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1323	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1099	borderLess color cursorBlink cursorUnderline cutchars delete_key	1324	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1100	display_name embed ext_bwidth fade font geometry hold iconName	1325	display_name embed ext_bwidth fade font geometry hold iconName
1101	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1326	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1102	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1327	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1103	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1328	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1104	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1329	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1105	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1330	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1106	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1331	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1107	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1332	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1108	secondaryScreen secondaryScroll selectstyle shade term_name title	1333	secondaryScreen secondaryScroll shade term_name title
1109	transient_for transparent transparent_all tripleclickwords utmpInhibit	1334	transient_for transparent transparent_all tripleclickwords utmpInhibit
1110	visualBell	1335	visualBell
1111		1336
1112	=cut	1337	=cut
1113		1338
1114	sub resource($$;$) {	1339	sub resource($$;$) {
1115	my ($self, $name) = (shift, shift);	1340	my ($self, $name) = (shift, shift);
1116	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1341	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1117	&urxvt::term::_resource	1342	goto &urxvt::term::_resource
1118	}	1343	}
1119		1344
1120	=item $value = $term->x_resource ($pattern)	1345	=item $value = $term->x_resource ($pattern)
1121		1346
1122	Returns the X-Resource for the given pattern, excluding the program or	1347	Returns the X-Resource for the given pattern, excluding the program or
…		…
1147		1372
1148	=item ($row, $col) = $term->selection_beg ([$row, $col])	1373	=item ($row, $col) = $term->selection_beg ([$row, $col])
1149		1374
1150	=item ($row, $col) = $term->selection_end ([$row, $col])	1375	=item ($row, $col) = $term->selection_end ([$row, $col])
1151		1376
1152	Return the current values of the selection mark, begin or end positions,	1377	Return the current values of the selection mark, begin or end positions.
1153	and optionally set them to new values.	1378
		1379	When arguments are given, then the selection coordinates are set to
		1380	C<$row> and C<$col>, and the selection screen is set to the current
		1381	screen.
		1382
		1383	=item $screen = $term->selection_screen ([$screen])
		1384
		1385	Returns the current selection screen, and then optionally sets it.
1154		1386
1155	=item $term->selection_make ($eventtime[, $rectangular])	1387	=item $term->selection_make ($eventtime[, $rectangular])
1156		1388
1157	Tries to make a selection as set by C<selection_beg> and	1389	Tries to make a selection as set by C<selection_beg> and
1158	C<selection_end>. If C<$rectangular> is true (default: false), a	1390	C<selection_end>. If C<$rectangular> is true (default: false), a
…		…
1205		1437
1206	The methods currently supported on C<urxvt::overlay> objects are:	1438	The methods currently supported on C<urxvt::overlay> objects are:
1207		1439
1208	=over 4	1440	=over 4
1209		1441
1210	=item $overlay->set ($x, $y, $text, $rend)	1442	=item $overlay->set ($x, $y, $text[, $rend])
1211		1443
1212	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1444	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1213	text in rxvt-unicode's special encoding and an array of rendition values	1445	text in rxvt-unicode's special encoding and an array of rendition values
1214	at a specific position inside the overlay.	1446	at a specific position inside the overlay.
		1447
		1448	If C<$rend> is missing, then the rendition will not be changed.
1215		1449
1216	=item $overlay->hide	1450	=item $overlay->hide
1217		1451
1218	If visible, hide the overlay, but do not destroy it.	1452	If visible, hide the overlay, but do not destroy it.
1219		1453
…		…
1332	Adds the specified events to the vt event mask. Useful e.g. when you want	1566	Adds the specified events to the vt event mask. Useful e.g. when you want
1333	to receive pointer events all the times:	1567	to receive pointer events all the times:
1334		1568
1335	$term->vt_emask_add (urxvt::PointerMotionMask);	1569	$term->vt_emask_add (urxvt::PointerMotionMask);
1336		1570
		1571	=item $term->focus_in
		1572
		1573	=item $term->focus_out
		1574
		1575	=item $term->key_press ($state, $keycode[, $time])
		1576
		1577	=item $term->key_release ($state, $keycode[, $time])
		1578
		1579	Deliver various fake events to to terminal.
		1580
1337	=item $window_width = $term->width	1581	=item $window_width = $term->width
1338		1582
1339	=item $window_height = $term->height	1583	=item $window_height = $term->height
1340		1584
1341	=item $font_width = $term->fwidth	1585	=item $font_width = $term->fwidth
…		…
1371	=item $env = $term->env	1615	=item $env = $term->env
1372		1616
1373	Returns a copy of the environment in effect for the terminal as a hashref	1617	Returns a copy of the environment in effect for the terminal as a hashref
1374	similar to C<\%ENV>.	1618	similar to C<\%ENV>.
1375		1619
		1620	=item @envv = $term->envv
		1621
		1622	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1623
		1624	=item @argv = $term->argv
		1625
		1626	Return the argument vector as this terminal, similar to @ARGV, but
		1627	includes the program name as first element.
		1628
1376	=cut	1629	=cut
1377		1630
1378	sub env {	1631	sub env {
1379	if (my $env = $_[0]->_env) {
1380	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1632	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1381	} else {
1382	+{ %ENV }
1383	}
1384	}	1633	}
1385		1634
1386	=item $modifiermask = $term->ModLevel3Mask	1635	=item $modifiermask = $term->ModLevel3Mask
1387		1636
1388	=item $modifiermask = $term->ModMetaMask	1637	=item $modifiermask = $term->ModMetaMask
…		…
1396		1645
1397	Returns the currently displayed screen (0 primary, 1 secondary).	1646	Returns the currently displayed screen (0 primary, 1 secondary).
1398		1647
1399	=item $cursor_is_hidden = $term->hidden_cursor	1648	=item $cursor_is_hidden = $term->hidden_cursor
1400		1649
1401	Returns wether the cursor is currently hidden or not.	1650	Returns whether the cursor is currently hidden or not.
1402		1651
1403	=item $view_start = $term->view_start ([$newvalue])	1652	=item $view_start = $term->view_start ([$newvalue])
1404		1653
1405	Returns the row number of the topmost displayed line. Maximum value is	1654	Returns the row number of the topmost displayed line. Maximum value is
1406	C<0>, which displays the normal terminal contents. Lower values scroll	1655	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1414		1663
1415	Used after changing terminal contents to display them.	1664	Used after changing terminal contents to display them.
1416		1665
1417	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1666	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1418		1667
1419	Returns the text of the entire row with number C<$row_number>. Row C<0>	1668	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1420	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1669	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1421	terminal line. The scrollback buffer starts at line C<-1> and extends to
1422	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1670	terminal line. Nothing will be returned if a nonexistent line
1423	is requested.	1671	is requested.
1424		1672
1425	If C<$new_text> is specified, it will replace characters in the current	1673	If C<$new_text> is specified, it will replace characters in the current
1426	line, starting at column C<$start_col> (default C<0>), which is useful	1674	line, starting at column C<$start_col> (default C<0>), which is useful
1427	to replace only parts of a line. The font index in the rendition will	1675	to replace only parts of a line. The font index in the rendition will
1428	automatically be updated.	1676	automatically be updated.
1429		1677
1430	C<$text> is in a special encoding: tabs and wide characters that use more	1678	C<$text> is in a special encoding: tabs and wide characters that use more
1431	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1679	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1432	characters. Characters with combining characters and other characters that	1680	characters. Characters with combining characters and other characters that
1433	do not fit into the normal tetx encoding will be replaced with characters	1681	do not fit into the normal text encoding will be replaced with characters
1434	in the private use area.	1682	in the private use area.
1435		1683
1436	You have to obey this encoding when changing text. The advantage is	1684	You have to obey this encoding when changing text. The advantage is
1437	that C<substr> and similar functions work on screen cells and not on	1685	that C<substr> and similar functions work on screen cells and not on
1438	characters.	1686	characters.
…		…
1583	where one character corresponds to one screen cell. See	1831	where one character corresponds to one screen cell. See
1584	C<< $term->ROW_t >> for details.	1832	C<< $term->ROW_t >> for details.
1585		1833
1586	=item $string = $term->special_decode $text	1834	=item $string = $term->special_decode $text
1587		1835
1588	Converts rxvt-unicodes text reprsentation into a perl string. See	1836	Converts rxvt-unicodes text representation into a perl string. See
1589	C<< $term->ROW_t >> for details.	1837	C<< $term->ROW_t >> for details.
1590		1838
1591	=item $success = $term->grab_button ($button, $modifiermask)	1839	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1592		1840
		1841	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1842
1593	Registers a synchronous button grab. See the XGrabButton manpage.	1843	Register/unregister a synchronous button grab. See the XGrabButton
		1844	manpage.
1594		1845
1595	=item $success = $term->grab ($eventtime[, $sync])	1846	=item $success = $term->grab ($eventtime[, $sync])
1596		1847
1597	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1848	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1598	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1849	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1599		1850
1600	=item $term->allow_events_async	1851	=item $term->allow_events_async
1601		1852
1602	Calls XAllowEvents with AsyncBoth for the most recent grab.	1853	Calls XAllowEvents with AsyncBoth for the most recent grab.
1603		1854
…		…
1622		1873
1623	=item @atoms = $term->XListProperties ($window)	1874	=item @atoms = $term->XListProperties ($window)
1624		1875
1625	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1876	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1626		1877
1627	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1878	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1628		1879
1629	=item $term->XDeleteProperty ($window, $property)	1880	=item $term->XDeleteProperty ($window, $property)
1630		1881
1631	=item $window = $term->DefaultRootWindow	1882	=item $window = $term->DefaultRootWindow
1632		1883
…		…
1716	my ($self, $text, $cb) = @_;	1967	my ($self, $text, $cb) = @_;
1717		1968
1718	$self->add_item ({ type => "button", text => $text, activate => $cb});	1969	$self->add_item ({ type => "button", text => $text, activate => $cb});
1719	}	1970	}
1720		1971
1721	=item $popup->add_toggle ($text, $cb, $initial_value)	1972	=item $popup->add_toggle ($text, $initial_value, $cb)
1722		1973
1723	Adds a toggle/checkbox item to the popup. Teh callback gets called	1974	Adds a toggle/checkbox item to the popup. The callback gets called
1724	whenever it gets toggled, with a boolean indicating its value as its first	1975	whenever it gets toggled, with a boolean indicating its new value as its
1725	argument.	1976	first argument.
1726		1977
1727	=cut	1978	=cut
1728		1979
1729	sub add_toggle {	1980	sub add_toggle {
1730	my ($self, $text, $cb, $value) = @_;	1981	my ($self, $text, $value, $cb) = @_;
1731		1982
1732	my $item; $item = {	1983	my $item; $item = {
1733	type => "button",	1984	type => "button",
1734	text => " $text",	1985	text => " $text",
1735	value => $value,	1986	value => $value,
…		…
1754	my $env = $self->{term}->env;	2005	my $env = $self->{term}->env;
1755	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2006	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1756	delete $env->{LC_ALL};	2007	delete $env->{LC_ALL};
1757	$env->{LC_CTYPE} = $self->{term}->locale;	2008	$env->{LC_CTYPE} = $self->{term}->locale;
1758		2009
1759	urxvt::term->new ($env, "popup",	2010	my $term = urxvt::term->new (
		2011	$env, "popup",
1760	"--perl-lib" => "", "--perl-ext-common" => "",	2012	"--perl-lib" => "", "--perl-ext-common" => "",
1761	"-pty-fd" => -1, "-sl" => 0,	2013	"-pty-fd" => -1, "-sl" => 0,
1762	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2014	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1763	"--transient-for" => $self->{term}->parent,	2015	"--transient-for" => $self->{term}->parent,
1764	"-display" => $self->{term}->display_id,	2016	"-display" => $self->{term}->display_id,
1765	"-pe" => "urxvt-popup")	2017	"-pe" => "urxvt-popup",
1766	or die "unable to create popup window\n";	2018	) or die "unable to create popup window\n";
		2019
		2020	unless (delete $term->{urxvt_popup_init_done}) {
		2021	$term->ungrab;
		2022	$term->destroy;
		2023	die "unable to initialise popup window\n";
		2024	}
1767	}	2025	}
1768		2026
1769	sub DESTROY {	2027	sub DESTROY {
1770	my ($self) = @_;	2028	my ($self) = @_;
1771		2029
…		…
1776	=back	2034	=back
1777		2035
1778	=cut	2036	=cut
1779		2037
1780	package urxvt::watcher;	2038	package urxvt::watcher;
1781
1782	@urxvt::timer::ISA = __PACKAGE__;
1783	@urxvt::iow::ISA = __PACKAGE__;
1784	@urxvt::pw::ISA = __PACKAGE__;
1785	@urxvt::iw::ISA = __PACKAGE__;
1786		2039
1787	=head2 The C<urxvt::timer> Class	2040	=head2 The C<urxvt::timer> Class
1788		2041
1789	This class implements timer watchers/events. Time is represented as a	2042	This class implements timer watchers/events. Time is represented as a
1790	fractional number of seconds since the epoch. Example:	2043	fractional number of seconds since the epoch. Example:
…		…
1794	->new	2047	->new
1795	->interval (1)	2048	->interval (1)
1796	->cb (sub {	2049	->cb (sub {
1797	$term->{overlay}->set (0, 0,	2050	$term->{overlay}->set (0, 0,
1798	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2051	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1799	});	2052	});
1800		2053
1801	=over 4	2054	=over 4
1802		2055
1803	=item $timer = new urxvt::timer	2056	=item $timer = new urxvt::timer
1804		2057
…		…
1807		2060
1808	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2061	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1809		2062
1810	Set the callback to be called when the timer triggers.	2063	Set the callback to be called when the timer triggers.
1811		2064
1812	=item $tstamp = $timer->at
1813
1814	Return the time this watcher will fire next.
1815
1816	=item $timer = $timer->set ($tstamp)	2065	=item $timer = $timer->set ($tstamp[, $interval])
1817		2066
1818	Set the time the event is generated to $tstamp.	2067	Set the time the event is generated to $tstamp (and optionally specifies a
		2068	new $interval).
1819		2069
1820	=item $timer = $timer->interval ($interval)	2070	=item $timer = $timer->interval ($interval)
1821		2071
1822	Normally (and when C<$interval> is C<0>), the timer will automatically	2072	By default (and when C<$interval> is C<0>), the timer will automatically
1823	stop after it has fired once. If C<$interval> is non-zero, then the timer	2073	stop after it has fired once. If C<$interval> is non-zero, then the timer
1824	is automatically rescheduled at the given intervals.	2074	is automatically rescheduled at the given intervals.
1825		2075
1826	=item $timer = $timer->start	2076	=item $timer = $timer->start
1827		2077
1828	Start the timer.	2078	Start the timer.
1829		2079
1830	=item $timer = $timer->start ($tstamp)	2080	=item $timer = $timer->start ($tstamp[, $interval])
1831		2081
1832	Set the event trigger time to C<$tstamp> and start the timer.	2082	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2083	also replaces the interval.
1833		2084
1834	=item $timer = $timer->after ($delay)	2085	=item $timer = $timer->after ($delay[, $interval])
1835		2086
1836	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2087	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1837		2088
1838	=item $timer = $timer->stop	2089	=item $timer = $timer->stop
1839		2090
…		…
1847		2098
1848	$term->{socket} = ...	2099	$term->{socket} = ...
1849	$term->{iow} = urxvt::iow	2100	$term->{iow} = urxvt::iow
1850	->new	2101	->new
1851	->fd (fileno $term->{socket})	2102	->fd (fileno $term->{socket})
1852	->events (urxvt::EVENT_READ)	2103	->events (urxvt::EV_READ)
1853	->start	2104	->start
1854	->cb (sub {	2105	->cb (sub {
1855	my ($iow, $revents) = @_;	2106	my ($iow, $revents) = @_;
1856	# $revents must be 1 here, no need to check	2107	# $revents must be 1 here, no need to check
1857	sysread $term->{socket}, my $buf, 8192	2108	sysread $term->{socket}, my $buf, 8192
…		…
1870	Set the callback to be called when io events are triggered. C<$reventmask>	2121	Set the callback to be called when io events are triggered. C<$reventmask>
1871	is a bitset as described in the C<events> method.	2122	is a bitset as described in the C<events> method.
1872		2123
1873	=item $iow = $iow->fd ($fd)	2124	=item $iow = $iow->fd ($fd)
1874		2125
1875	Set the filedescriptor (not handle) to watch.	2126	Set the file descriptor (not handle) to watch.
1876		2127
1877	=item $iow = $iow->events ($eventmask)	2128	=item $iow = $iow->events ($eventmask)
1878		2129
1879	Set the event mask to watch. The only allowed values are	2130	Set the event mask to watch. The only allowed values are
1880	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2131	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1881	together, or C<urxvt::EVENT_NONE>.	2132	together, or C<urxvt::EV_NONE>.
1882		2133
1883	=item $iow = $iow->start	2134	=item $iow = $iow->start
1884		2135
1885	Start watching for requested events on the given handle.	2136	Start watching for requested events on the given handle.
1886		2137
1887	=item $iow = $iow->stop	2138	=item $iow = $iow->stop
1888		2139
1889	Stop watching for events on the given filehandle.	2140	Stop watching for events on the given file handle.
1890		2141
1891	=back	2142	=back
1892		2143
1893	=head2 The C<urxvt::iw> Class	2144	=head2 The C<urxvt::iw> Class
1894		2145
…		…
1927	->new	2178	->new
1928	->start ($pid)	2179	->start ($pid)
1929	->cb (sub {	2180	->cb (sub {
1930	my ($pw, $exit_status) = @_;	2181	my ($pw, $exit_status) = @_;
1931	...	2182	...
1932	});	2183	});
1933		2184
1934	=over 4	2185	=over 4
1935		2186
1936	=item $pw = new urxvt::pw	2187	=item $pw = new urxvt::pw
1937		2188
…		…
1941		2192
1942	Set the callback to be called when the timer triggers.	2193	Set the callback to be called when the timer triggers.
1943		2194
1944	=item $pw = $timer->start ($pid)	2195	=item $pw = $timer->start ($pid)
1945		2196
1946	Tells the wqtcher to start watching for process C<$pid>.	2197	Tells the watcher to start watching for process C<$pid>.
1947		2198
1948	=item $pw = $pw->stop	2199	=item $pw = $pw->stop
1949		2200
1950	Stop the watcher.	2201	Stop the watcher.
1951		2202
…		…
1964		2215
1965	=item >= 3 - script loading and management	2216	=item >= 3 - script loading and management
1966		2217
1967	=item >=10 - all called hooks	2218	=item >=10 - all called hooks
1968		2219
1969	=item >=11 - hook reutrn values	2220	=item >=11 - hook return values
1970		2221
1971	=back	2222	=back
1972		2223
1973	=head1 AUTHOR	2224	=head1 AUTHOR
1974		2225
…		…
1976	http://software.schmorp.de/pkg/rxvt-unicode	2227	http://software.schmorp.de/pkg/rxvt-unicode
1977		2228
1978	=cut	2229	=cut
1979		2230
1980	1	2231	1
		2232
		2233	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.125 by root, Sun Jan 22 20:39:47 2006 UTC vs. Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.125 by root, Sun Jan 22 20:39:47 2006 UTC vs.
Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC