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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.126 by root, Tue Jan 24 19:14:36 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: \\\|([^\|]+)\\\|
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,
208	while B<Shift-Down> creates a new tab.	234	while B<Shift-Down> creates a new tab.
209		235
210	=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):
211		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
212	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
213	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
214	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
215	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.
216		258
217	=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.
218		263
219	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.
220	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.
221	a custom pixmap. No scaling is supported in this mode. Exmaple:
222		266
223	@@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.
224		313
225	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
226		315
227	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
228	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
229	similar-looking ascii character.	318	similar-looking ascii character.
230		319
231	=item digital-clock	320	=item digital-clock
232		321
233	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
234		323
235	=item example-refresh-hooks	324	=item remote-clipboard
236		325
237	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
238	window. Illustrates overwriting the refresh callbacks to create your own	327	selection popup that allows one to run external commands to store the
239	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'
240		343
241	=item selection-pastebin	344	=item selection-pastebin
242		345
243	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
244	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
…		…
264	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
265	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
266	for the filename):	369	for the filename):
267		370
268	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.
269		397
270	=back	398	=back
271		399
272	=head1 API DOCUMENTATION	400	=head1 API DOCUMENTATION
273		401
…		…
307		435
308	=back	436	=back
309		437
310	=head2 Extension Objects	438	=head2 Extension Objects
311		439
312	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
313	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,
314	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
315	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
316	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
317	use.	446	internal use.
318		447
319	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
320	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
321		450
322	It has the following methods and data members:	451	It has the following methods and data members:
…		…
343	=head2 Hooks	472	=head2 Hooks
344		473
345	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
346	called whenever the relevant event happens.	475	called whenever the relevant event happens.
347		476
348	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
349	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
350		479
351	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
352	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
353	relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
…		…
366	place.	495	place.
367		496
368	=item on_start $term	497	=item on_start $term
369		498
370	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
371	trying to map (display) the toplevel and returning to the mainloop.	500	trying to map (display) the toplevel and returning to the main loop.
372		501
373	=item on_destroy $term	502	=item on_destroy $term
374		503
375	Called whenever something tries to destroy terminal, before doing anything	504	Called whenever something tries to destroy terminal, when the terminal is
376	yet. If this hook returns true, then destruction is skipped, but this is	505	still fully functional (not for long, though).
377	rarely a good idea.
378		506
379	=item on_reset $term	507	=item on_reset $term
380		508
381	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
382	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
…		…
404		532
405	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
406	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
407	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
408		536
409	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.
410		538
411	=item on_sel_extend $term	539	=item on_sel_extend $term
412		540
413	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
414	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
415	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
416	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
417	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
418	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
419		547
420	See the F<selection> example extension.	548	See the F<selection> example extension.
421		549
422	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
423		551
424	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
425	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
426	show this many lines of scrollback.	554	show this many lines of scrollback.
427		555
428	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
429		557
…		…
433		561
434	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,
435	$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
436	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
437		565
438	=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
439		577
440	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
441	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
442	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
443	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,
444	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
445	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	}
446		594
447	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,
448	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
449	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.
450		601
451	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
452		603
453	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
454	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
…		…
475	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
476	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
477		628
478	=item on_refresh_begin $term	629	=item on_refresh_begin $term
479		630
480	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
481	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
482	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
483	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
484		635
485	=item on_refresh_end $term	636	=item on_refresh_end $term
486		637
487	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>.
488		639
489	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
490		641
491	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
492	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>
493	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.
494		654
495	=item on_x_event $term, $event	655	=item on_x_event $term, $event
496		656
497	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
498	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
499	members are not passed.	659	members are not passed.
500		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
501	=item on_focus_in $term	665	=item on_focus_in $term
502		666
503	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
504	does focus in processing.	668	does focus in processing.
505		669
506	=item on_focus_out $term	670	=item on_focus_out $term
507		671
508	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
509	focus out processing.	673	focus out processing.
510		674
511	=item on_configure_notify $term, $event	675	=item on_configure_notify $term, $event
512		676
513	=item on_property_notify $term, $event	677	=item on_property_notify $term, $event
…		…
596	The current terminal. This variable stores the current C<urxvt::term>	760	The current terminal. This variable stores the current C<urxvt::term>
597	object, whenever a callback/hook is executing.	761	object, whenever a callback/hook is executing.
598		762
599	=item @urxvt::TERM_INIT	763	=item @urxvt::TERM_INIT
600		764
601	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
602	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
603	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,
604	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.
605		769
606	This complements to the perl-eval commandline option, but gets executed	770	This complements to the perl-eval command line option, but gets executed
607	first.	771	first.
608		772
609	=item @urxvt::TERM_EXT	773	=item @urxvt::TERM_EXT
610		774
611	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
…		…
632		796
633	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
634	correct place, e.g. on stderr of the connecting urxvtc client.	798	correct place, e.g. on stderr of the connecting urxvtc client.
635		799
636	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).
637		808
638	=item $time = urxvt::NOW	809	=item $time = urxvt::NOW
639		810
640	Returns the "current time" (as per the event loop).	811	Returns the "current time" (as per the event loop).
641		812
…		…
699	Return the foreground/background colour index, respectively.	870	Return the foreground/background colour index, respectively.
700		871
701	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	872	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
702		873
703	=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
704		877
705	Replace the foreground/background colour in the rendition mask with the	878	Replace the foreground/background colour in the rendition mask with the
706	specified one.	879	specified one.
707		880
708	=item $value = urxvt::GET_CUSTOM $rend	881	=item $value = urxvt::GET_CUSTOM $rend
…		…
775	local $TERM = shift;	948	local $TERM = shift;
776	my $htype = shift;	949	my $htype = shift;
777		950
778	if ($htype == 0) { # INIT	951	if ($htype == 0) { # INIT
779	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	952	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
780		953
781	my %ext_arg;	954	my %ext_arg;
782		955
783	{	956	{
784	my @init = @TERM_INIT;	957	my @init = @TERM_INIT;
785	@TERM_INIT = ();	958	@TERM_INIT = ();
…		…
799	} else {	972	} else {
800	$ext_arg{$_} \|\|= [];	973	$ext_arg{$_} \|\|= [];
801	}	974	}
802	}	975	}
803		976
804	while (my ($ext, $argv) = each %ext_arg) {	977	for my $ext (sort keys %ext_arg) {
805	my @files = grep -f $_, map "$_/$ext", @dirs;	978	my @files = grep -f $_, map "$_/$ext", @dirs;
806		979
807	if (@files) {	980	if (@files) {
808	$TERM->register_package (extension_package $files[0], $argv);	981	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
809	} else {	982	} else {
810	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";
811	}	984	}
812	}	985	}
813		986
…		…
819		992
820	if (my $cb = $TERM->{_hook}[$htype]) {	993	if (my $cb = $TERM->{_hook}[$htype]) {
821	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	994	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
822	if $verbosity >= 10;	995	if $verbosity >= 10;
823		996
824	keys %$cb;	997	for my $pkg (keys %$cb) {
825
826	while (my ($pkg, $cb) = each %$cb) {
827	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };	998	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
828	$retval \|\|= $retval_;	999	$retval \|\|= $retval_;
829		1000
830	if ($@) {	1001	if ($@) {
831	$TERM->ungrab; # better to lose the grab than the session	1002	$TERM->ungrab; # better to lose the grab than the session
832	warn $@;	1003	warn $@;
…		…
844	# clear package	1015	# clear package
845	%$TERM = ();	1016	%$TERM = ();
846	}	1017	}
847		1018
848	$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)
849	}	1049	}
850		1050
851	# urxvt::term::extension	1051	# urxvt::term::extension
852		1052
853	package urxvt::term::extension;	1053	package urxvt::term::extension;
…		…
924	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
925	work.	1125	work.
926		1126
927	=cut	1127	=cut
928		1128
929	our $VERSION = 1;	1129	our $VERSION = '5.23';
930		1130
931	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1131	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
932	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1132	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
933		1133
934	sub timer {	1134	sub timer {
…		…
936		1136
937	my $cb = $arg{cb};	1137	my $cb = $arg{cb};
938		1138
939	urxvt::timer	1139	urxvt::timer
940	->new	1140	->new
941	->start (urxvt::NOW + $arg{after})	1141	->after ($arg{after}, $arg{interval})
942	->cb (sub {	1142	->cb ($arg{interval} ? $cb : sub {
943	$_[0]->stop; # need to cancel manually	1143	$_[0]->stop; # need to cancel manually
944	$cb->();	1144	$cb->();
945	})	1145	})
946	}	1146	}
947		1147
948	sub io {	1148	sub io {
949	my ($class, %arg) = @_;	1149	my ($class, %arg) = @_;
950		1150
951	my $cb = $arg{cb};	1151	my $cb = $arg{cb};
		1152	my $fd = fileno $arg{fh};
		1153	defined $fd or $fd = $arg{fh};
952		1154
953	bless [$arg{fh}, urxvt::iow	1155	bless [$arg{fh}, urxvt::iow
954	->new	1156	->new
955	->fd (fileno $arg{fh})	1157	->fd ($fd)
956	->events (($arg{poll} =~ /r/ ? 1 : 0)	1158	->events (($arg{poll} =~ /r/ ? 1 : 0)
957	\| ($arg{poll} =~ /w/ ? 2 : 0))	1159	\| ($arg{poll} =~ /w/ ? 2 : 0))
958	->start	1160	->start
959	->cb (sub {	1161	->cb ($cb)
960	$cb->(($_[1] & 1 ? 'r' : '')
961	. ($_[1] & 2 ? 'w' : ''));
962	})],
963	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	})
964	}	1188	}
965		1189
966	sub DESTROY {	1190	sub DESTROY {
967	$_[0][1]->stop;	1191	$_[0][1]->stop;
968	}	1192	}
969		1193
970	sub condvar {	1194	sub one_event {
971	bless \my $flag, urxvt::anyevent::condvar::
972	}
973
974	sub urxvt::anyevent::condvar::broadcast {
975	${$_[0]}++;
976	}
977
978	sub urxvt::anyevent::condvar::wait {
979	unless (${$_[0]}) {
980	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";
981	}
982	}	1196	}
983		1197
984	package urxvt::term;	1198	package urxvt::term;
985		1199
986	=head2 The C<urxvt::term> Class	1200	=head2 The C<urxvt::term> Class
…		…
1022	hash which defines the environment of the new terminal.	1236	hash which defines the environment of the new terminal.
1023		1237
1024	Croaks (and probably outputs an error message) if the new instance	1238	Croaks (and probably outputs an error message) if the new instance
1025	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
1026	initialise perl, and the terminal object otherwise. The C<init> and	1240	initialise perl, and the terminal object otherwise. The C<init> and
1027	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).
1028		1243
1029	=cut	1244	=cut
1030		1245
1031	sub new {	1246	sub new {
1032	my ($class, $env, @args) = @_;	1247	my ($class, $env, @args) = @_;
1033		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
1034	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1252	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1035	}	1253	}
1036		1254
1037	=item $term->destroy	1255	=item $term->destroy
1038		1256
1039	Destroy the terminal object (close the window, free resources	1257	Destroy the terminal object (close the window, free resources
…		…
1069		1287
1070	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
1071	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
1072	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.
1073		1291
1074	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
1075	source file F</src/optinc.h> to see the actual list:	1293	source file F</src/optinc.h> to see the actual list:
1076		1294
1077	borderLess console cursorBlink cursorUnderline hold iconic insecure	1295	borderLess console cursorBlink cursorUnderline hold iconic insecure
1078	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1296	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1079	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1297	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
…		…
1096	likely change).	1314	likely change).
1097		1315
1098	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
1099	terminal is destroyed, so changing options frequently will eat memory.	1317	terminal is destroyed, so changing options frequently will eat memory.
1100		1318
1101	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
1102	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>
1103	to see the actual list:	1321	to see the actual list:
1104		1322
1105	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1323	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1106	borderLess color cursorBlink cursorUnderline cutchars delete_key	1324	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1107	display_name embed ext_bwidth fade font geometry hold iconName	1325	display_name embed ext_bwidth fade font geometry hold iconName
1108	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1326	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1109	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1327	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1110	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1328	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1111	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1329	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1112	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1330	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1113	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1331	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1114	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1332	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1115	secondaryScreen secondaryScroll selectstyle shade term_name title	1333	secondaryScreen secondaryScroll shade term_name title
1116	transient_for transparent transparent_all tripleclickwords utmpInhibit	1334	transient_for transparent transparent_all tripleclickwords utmpInhibit
1117	visualBell	1335	visualBell
1118		1336
1119	=cut	1337	=cut
1120		1338
1121	sub resource($$;$) {	1339	sub resource($$;$) {
1122	my ($self, $name) = (shift, shift);	1340	my ($self, $name) = (shift, shift);
1123	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1341	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1124	&urxvt::term::_resource	1342	goto &urxvt::term::_resource
1125	}	1343	}
1126		1344
1127	=item $value = $term->x_resource ($pattern)	1345	=item $value = $term->x_resource ($pattern)
1128		1346
1129	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
…		…
1154		1372
1155	=item ($row, $col) = $term->selection_beg ([$row, $col])	1373	=item ($row, $col) = $term->selection_beg ([$row, $col])
1156		1374
1157	=item ($row, $col) = $term->selection_end ([$row, $col])	1375	=item ($row, $col) = $term->selection_end ([$row, $col])
1158		1376
1159	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.
1160	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.
1161		1386
1162	=item $term->selection_make ($eventtime[, $rectangular])	1387	=item $term->selection_make ($eventtime[, $rectangular])
1163		1388
1164	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
1165	C<selection_end>. If C<$rectangular> is true (default: false), a	1390	C<selection_end>. If C<$rectangular> is true (default: false), a
…		…
1212		1437
1213	The methods currently supported on C<urxvt::overlay> objects are:	1438	The methods currently supported on C<urxvt::overlay> objects are:
1214		1439
1215	=over 4	1440	=over 4
1216		1441
1217	=item $overlay->set ($x, $y, $text, $rend)	1442	=item $overlay->set ($x, $y, $text[, $rend])
1218		1443
1219	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
1220	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
1221	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.
1222		1449
1223	=item $overlay->hide	1450	=item $overlay->hide
1224		1451
1225	If visible, hide the overlay, but do not destroy it.	1452	If visible, hide the overlay, but do not destroy it.
1226		1453
…		…
1339	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
1340	to receive pointer events all the times:	1567	to receive pointer events all the times:
1341		1568
1342	$term->vt_emask_add (urxvt::PointerMotionMask);	1569	$term->vt_emask_add (urxvt::PointerMotionMask);
1343		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
1344	=item $window_width = $term->width	1581	=item $window_width = $term->width
1345		1582
1346	=item $window_height = $term->height	1583	=item $window_height = $term->height
1347		1584
1348	=item $font_width = $term->fwidth	1585	=item $font_width = $term->fwidth
…		…
1378	=item $env = $term->env	1615	=item $env = $term->env
1379		1616
1380	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
1381	similar to C<\%ENV>.	1618	similar to C<\%ENV>.
1382		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
1383	=cut	1629	=cut
1384		1630
1385	sub env {	1631	sub env {
1386	if (my $env = $_[0]->_env) {
1387	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1632	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1388	} else {
1389	+{ %ENV }
1390	}
1391	}	1633	}
1392		1634
1393	=item $modifiermask = $term->ModLevel3Mask	1635	=item $modifiermask = $term->ModLevel3Mask
1394		1636
1395	=item $modifiermask = $term->ModMetaMask	1637	=item $modifiermask = $term->ModMetaMask
…		…
1403		1645
1404	Returns the currently displayed screen (0 primary, 1 secondary).	1646	Returns the currently displayed screen (0 primary, 1 secondary).
1405		1647
1406	=item $cursor_is_hidden = $term->hidden_cursor	1648	=item $cursor_is_hidden = $term->hidden_cursor
1407		1649
1408	Returns wether the cursor is currently hidden or not.	1650	Returns whether the cursor is currently hidden or not.
1409		1651
1410	=item $view_start = $term->view_start ([$newvalue])	1652	=item $view_start = $term->view_start ([$newvalue])
1411		1653
1412	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
1413	C<0>, which displays the normal terminal contents. Lower values scroll	1655	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1421		1663
1422	Used after changing terminal contents to display them.	1664	Used after changing terminal contents to display them.
1423		1665
1424	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1666	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1425		1667
1426	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 >>
1427	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
1428	terminal line. The scrollback buffer starts at line C<-1> and extends to
1429	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1670	terminal line. Nothing will be returned if a nonexistent line
1430	is requested.	1671	is requested.
1431		1672
1432	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
1433	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
1434	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
1435	automatically be updated.	1676	automatically be updated.
1436		1677
1437	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
1438	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)
1439	characters. Characters with combining characters and other characters that	1680	characters. Characters with combining characters and other characters that
1440	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
1441	in the private use area.	1682	in the private use area.
1442		1683
1443	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
1444	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
1445	characters.	1686	characters.
…		…
1590	where one character corresponds to one screen cell. See	1831	where one character corresponds to one screen cell. See
1591	C<< $term->ROW_t >> for details.	1832	C<< $term->ROW_t >> for details.
1592		1833
1593	=item $string = $term->special_decode $text	1834	=item $string = $term->special_decode $text
1594		1835
1595	Converts rxvt-unicodes text reprsentation into a perl string. See	1836	Converts rxvt-unicodes text representation into a perl string. See
1596	C<< $term->ROW_t >> for details.	1837	C<< $term->ROW_t >> for details.
1597		1838
1598	=item $success = $term->grab_button ($button, $modifiermask)	1839	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1599		1840
		1841	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1842
1600	Registers a synchronous button grab. See the XGrabButton manpage.	1843	Register/unregister a synchronous button grab. See the XGrabButton
		1844	manpage.
1601		1845
1602	=item $success = $term->grab ($eventtime[, $sync])	1846	=item $success = $term->grab ($eventtime[, $sync])
1603		1847
1604	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1848	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1605	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1849	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1606		1850
1607	=item $term->allow_events_async	1851	=item $term->allow_events_async
1608		1852
1609	Calls XAllowEvents with AsyncBoth for the most recent grab.	1853	Calls XAllowEvents with AsyncBoth for the most recent grab.
1610		1854
…		…
1629		1873
1630	=item @atoms = $term->XListProperties ($window)	1874	=item @atoms = $term->XListProperties ($window)
1631		1875
1632	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1876	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1633		1877
1634	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1878	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1635		1879
1636	=item $term->XDeleteProperty ($window, $property)	1880	=item $term->XDeleteProperty ($window, $property)
1637		1881
1638	=item $window = $term->DefaultRootWindow	1882	=item $window = $term->DefaultRootWindow
1639		1883
…		…
1723	my ($self, $text, $cb) = @_;	1967	my ($self, $text, $cb) = @_;
1724		1968
1725	$self->add_item ({ type => "button", text => $text, activate => $cb});	1969	$self->add_item ({ type => "button", text => $text, activate => $cb});
1726	}	1970	}
1727		1971
1728	=item $popup->add_toggle ($text, $cb, $initial_value)	1972	=item $popup->add_toggle ($text, $initial_value, $cb)
1729		1973
1730	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
1731	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
1732	argument.	1976	first argument.
1733		1977
1734	=cut	1978	=cut
1735		1979
1736	sub add_toggle {	1980	sub add_toggle {
1737	my ($self, $text, $cb, $value) = @_;	1981	my ($self, $text, $value, $cb) = @_;
1738		1982
1739	my $item; $item = {	1983	my $item; $item = {
1740	type => "button",	1984	type => "button",
1741	text => " $text",	1985	text => " $text",
1742	value => $value,	1986	value => $value,
…		…
1761	my $env = $self->{term}->env;	2005	my $env = $self->{term}->env;
1762	# 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.
1763	delete $env->{LC_ALL};	2007	delete $env->{LC_ALL};
1764	$env->{LC_CTYPE} = $self->{term}->locale;	2008	$env->{LC_CTYPE} = $self->{term}->locale;
1765		2009
1766	urxvt::term->new ($env, "popup",	2010	my $term = urxvt::term->new (
		2011	$env, "popup",
1767	"--perl-lib" => "", "--perl-ext-common" => "",	2012	"--perl-lib" => "", "--perl-ext-common" => "",
1768	"-pty-fd" => -1, "-sl" => 0,	2013	"-pty-fd" => -1, "-sl" => 0,
1769	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2014	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1770	"--transient-for" => $self->{term}->parent,	2015	"--transient-for" => $self->{term}->parent,
1771	"-display" => $self->{term}->display_id,	2016	"-display" => $self->{term}->display_id,
1772	"-pe" => "urxvt-popup")	2017	"-pe" => "urxvt-popup",
1773	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	}
1774	}	2025	}
1775		2026
1776	sub DESTROY {	2027	sub DESTROY {
1777	my ($self) = @_;	2028	my ($self) = @_;
1778		2029
…		…
1783	=back	2034	=back
1784		2035
1785	=cut	2036	=cut
1786		2037
1787	package urxvt::watcher;	2038	package urxvt::watcher;
1788
1789	@urxvt::timer::ISA = __PACKAGE__;
1790	@urxvt::iow::ISA = __PACKAGE__;
1791	@urxvt::pw::ISA = __PACKAGE__;
1792	@urxvt::iw::ISA = __PACKAGE__;
1793		2039
1794	=head2 The C<urxvt::timer> Class	2040	=head2 The C<urxvt::timer> Class
1795		2041
1796	This class implements timer watchers/events. Time is represented as a	2042	This class implements timer watchers/events. Time is represented as a
1797	fractional number of seconds since the epoch. Example:	2043	fractional number of seconds since the epoch. Example:
…		…
1801	->new	2047	->new
1802	->interval (1)	2048	->interval (1)
1803	->cb (sub {	2049	->cb (sub {
1804	$term->{overlay}->set (0, 0,	2050	$term->{overlay}->set (0, 0,
1805	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2051	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1806	});	2052	});
1807		2053
1808	=over 4	2054	=over 4
1809		2055
1810	=item $timer = new urxvt::timer	2056	=item $timer = new urxvt::timer
1811		2057
…		…
1814		2060
1815	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2061	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1816		2062
1817	Set the callback to be called when the timer triggers.	2063	Set the callback to be called when the timer triggers.
1818		2064
1819	=item $tstamp = $timer->at
1820
1821	Return the time this watcher will fire next.
1822
1823	=item $timer = $timer->set ($tstamp)	2065	=item $timer = $timer->set ($tstamp[, $interval])
1824		2066
1825	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).
1826		2069
1827	=item $timer = $timer->interval ($interval)	2070	=item $timer = $timer->interval ($interval)
1828		2071
1829	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
1830	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
1831	is automatically rescheduled at the given intervals.	2074	is automatically rescheduled at the given intervals.
1832		2075
1833	=item $timer = $timer->start	2076	=item $timer = $timer->start
1834		2077
1835	Start the timer.	2078	Start the timer.
1836		2079
1837	=item $timer = $timer->start ($tstamp)	2080	=item $timer = $timer->start ($tstamp[, $interval])
1838		2081
1839	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.
1840		2084
1841	=item $timer = $timer->after ($delay)	2085	=item $timer = $timer->after ($delay[, $interval])
1842		2086
1843	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>.
1844		2088
1845	=item $timer = $timer->stop	2089	=item $timer = $timer->stop
1846		2090
…		…
1854		2098
1855	$term->{socket} = ...	2099	$term->{socket} = ...
1856	$term->{iow} = urxvt::iow	2100	$term->{iow} = urxvt::iow
1857	->new	2101	->new
1858	->fd (fileno $term->{socket})	2102	->fd (fileno $term->{socket})
1859	->events (urxvt::EVENT_READ)	2103	->events (urxvt::EV_READ)
1860	->start	2104	->start
1861	->cb (sub {	2105	->cb (sub {
1862	my ($iow, $revents) = @_;	2106	my ($iow, $revents) = @_;
1863	# $revents must be 1 here, no need to check	2107	# $revents must be 1 here, no need to check
1864	sysread $term->{socket}, my $buf, 8192	2108	sysread $term->{socket}, my $buf, 8192
…		…
1877	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>
1878	is a bitset as described in the C<events> method.	2122	is a bitset as described in the C<events> method.
1879		2123
1880	=item $iow = $iow->fd ($fd)	2124	=item $iow = $iow->fd ($fd)
1881		2125
1882	Set the filedescriptor (not handle) to watch.	2126	Set the file descriptor (not handle) to watch.
1883		2127
1884	=item $iow = $iow->events ($eventmask)	2128	=item $iow = $iow->events ($eventmask)
1885		2129
1886	Set the event mask to watch. The only allowed values are	2130	Set the event mask to watch. The only allowed values are
1887	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
1888	together, or C<urxvt::EVENT_NONE>.	2132	together, or C<urxvt::EV_NONE>.
1889		2133
1890	=item $iow = $iow->start	2134	=item $iow = $iow->start
1891		2135
1892	Start watching for requested events on the given handle.	2136	Start watching for requested events on the given handle.
1893		2137
1894	=item $iow = $iow->stop	2138	=item $iow = $iow->stop
1895		2139
1896	Stop watching for events on the given filehandle.	2140	Stop watching for events on the given file handle.
1897		2141
1898	=back	2142	=back
1899		2143
1900	=head2 The C<urxvt::iw> Class	2144	=head2 The C<urxvt::iw> Class
1901		2145
…		…
1934	->new	2178	->new
1935	->start ($pid)	2179	->start ($pid)
1936	->cb (sub {	2180	->cb (sub {
1937	my ($pw, $exit_status) = @_;	2181	my ($pw, $exit_status) = @_;
1938	...	2182	...
1939	});	2183	});
1940		2184
1941	=over 4	2185	=over 4
1942		2186
1943	=item $pw = new urxvt::pw	2187	=item $pw = new urxvt::pw
1944		2188
…		…
1948		2192
1949	Set the callback to be called when the timer triggers.	2193	Set the callback to be called when the timer triggers.
1950		2194
1951	=item $pw = $timer->start ($pid)	2195	=item $pw = $timer->start ($pid)
1952		2196
1953	Tells the wqtcher to start watching for process C<$pid>.	2197	Tells the watcher to start watching for process C<$pid>.
1954		2198
1955	=item $pw = $pw->stop	2199	=item $pw = $pw->stop
1956		2200
1957	Stop the watcher.	2201	Stop the watcher.
1958		2202
…		…
1971		2215
1972	=item >= 3 - script loading and management	2216	=item >= 3 - script loading and management
1973		2217
1974	=item >=10 - all called hooks	2218	=item >=10 - all called hooks
1975		2219
1976	=item >=11 - hook reutrn values	2220	=item >=11 - hook return values
1977		2221
1978	=back	2222	=back
1979		2223
1980	=head1 AUTHOR	2224	=head1 AUTHOR
1981		2225
…		…
1983	http://software.schmorp.de/pkg/rxvt-unicode	2227	http://software.schmorp.de/pkg/rxvt-unicode
1984		2228
1985	=cut	2229	=cut
1986		2230
1987	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.126 by root, Tue Jan 24 19:14:36 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.126 by root, Tue Jan 24 19:14:36 2006 UTC vs.
Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC