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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.152 by tpope, Tue Jan 9 16:18:56 2007 UTC vs.
Revision 1.190 by root, Fri Jan 7 21:17:08 2011 UTC

…		…
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
…		…
98		101
99	Other extensions can extend this popup menu by pushing a code reference	102	Other extensions can extend this popup menu by pushing a code reference
100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the	103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101	popup is being displayed.	104	popup is being displayed.
102		105
103	It's sole argument is the popup menu, which can be modified. It should	106	Its sole argument is the popup menu, which can be modified. It should
104	either return nothing or a string, the initial boolean value and a code	107	either return nothing or a string, the initial boolean value and a code
105	reference. The string will be used as button text and the code reference	108	reference. The string will be used as button text and the code reference
106	will be called when the toggle changes, with the new boolean value as	109	will be called when the toggle changes, with the new boolean value as
107	first argument.	110	first argument.
108		111
109	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
110	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
111		114
112	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114	};	117	};
115		118
…		…
121		124
122	Other extensions can extend this popup menu by pushing a code reference	125	Other extensions can extend this popup menu by pushing a code reference
123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the	126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124	popup is being displayed.	127	popup is being displayed.
125		128
126	It's sole argument is the popup menu, which can be modified. The selection	129	Its sole argument is the popup menu, which can be modified. The selection
127	is in C<$_>, which can be used to decide whether to add something or not.	130	is in C<$_>, which can be used to decide whether to add something or not.
128	It should either return nothing or a string and a code reference. The	131	It should either return nothing or a string and a code reference. The
129	string will be used as button text and the code reference will be called	132	string will be used as button text and the code reference will be called
130	when the button gets activated and should transform C<$_>.	133	when the button gets activated and should transform C<$_>.
131		134
132	The following will add an entry C<a to b> that transforms all C<a>s in	135	The following will add an entry C<a to b> that transforms all C<a>s in
133	the selection to C<b>s, but only if the selection currently contains any	136	the selection to C<b>s, but only if the selection currently contains any
134	C<a>s:	137	C<a>s:
135		138
136	push @{ $self->{term}{selection_popup_hook} }, sub {	139	push @{ $self->{term}{selection_popup_hook} }, sub {
137	/a/ ? ("a to be" => sub { s/a/b/g }	140	/a/ ? ("a to b" => sub { s/a/b/g }
138	: ()	141	: ()
139	};	142	};
140		143
141	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
142		145
…		…
149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
151	bottom. C<Escape> leaves search mode and returns to the point where search	154	bottom. C<Escape> leaves search mode and returns to the point where search
152	was started, while C<Enter> or C<Return> stay at the current position and	155	was started, while C<Enter> or C<Return> stay at the current position and
153	additionally stores the first match in the current line into the primary	156	additionally stores the first match in the current line into the primary
154	selection.	157	selection if the C<Shift> modifier is active.
155		158
156	The regex defaults to "(?i)", resulting in a case-insensitive search. To	159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
157	get a case-sensitive search you can delete this prefix using C<BackSpace>	160	get a case-sensitive search you can delete this prefix using C<BackSpace>
158	or simply use an uppercase character which removes the "(?i)" prefix.	161	or simply use an uppercase character which removes the "(?i)" prefix.
159		162
…		…
162	=item readline (enabled by default)	165	=item readline (enabled by default)
163		166
164	A support package that tries to make editing with readline easier. At	167	A support package that tries to make editing with readline easier. At
165	the moment, it reacts to clicking shift-left mouse button by trying to	168	the moment, it reacts to clicking shift-left mouse button by trying to
166	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
167	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
168	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
169		172
170	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
171		174
172	=over 4	175	=over 4
…		…
256	The default pattern to match URLs can be overridden with the	259	The default pattern to match URLs can be overridden with the
257	C<matcher.pattern.0> resource, and additional patterns can be specified	260	C<matcher.pattern.0> resource, and additional patterns can be specified
258	with numbered patterns, in a manner similar to the "selection" extension.	261	with numbered patterns, in a manner similar to the "selection" extension.
259	The launcher can also be overridden on a per-pattern basis.	262	The launcher can also be overridden on a per-pattern basis.
260		263
		264	It is possible to activate the most recently seen match from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
261	Example configuration:	267	Example configuration:
262		268
263	URxvt.perl-ext: default,matcher	269	URxvt.perl-ext: default,matcher
264	URxvt.urlLauncher: sensible-browser	270	URxvt.urlLauncher: sensible-browser
265	URxvt.keysym.C-Delete: perl:matcher	271	URxvt.keysym.C-Delete: perl:matcher
…		…
270		276
271	=item xim-onthespot	277	=item xim-onthespot
272		278
273	This (experimental) perl extension implements OnTheSpot editing. It does	279	This (experimental) perl extension implements OnTheSpot editing. It does
274	not work perfectly, and some input methods don't seem to work well with	280	not work perfectly, and some input methods don't seem to work well with
275	OnTheSpot editing in general, but it seems to work at leats for SCIM and	281	OnTheSpot editing in general, but it seems to work at least for SCIM and
276	kinput2.	282	kinput2.
277		283
278	You enable it by specifying this extension and a preedit style of	284	You enable it by specifying this extension and a preedit style of
279	C<OnTheSpot>, i.e.:	285	C<OnTheSpot>, i.e.:
280		286
…		…
288	will show or hide itself. Another press of the accelerator key will hide	294	will show or hide itself. Another press of the accelerator key will hide
289	or show it again.	295	or show it again.
290		296
291	Initially, the window will not be shown when using this extension.	297	Initially, the window will not be shown when using this extension.
292		298
293	This is useful if you need a single terminal thats not using any desktop	299	This is useful if you need a single terminal that is not using any desktop
294	space most of the time but is quickly available at the press of a key.	300	space most of the time but is quickly available at the press of a key.
295		301
296	The accelerator key is grabbed regardless of any modifiers, so this	302	The accelerator key is grabbed regardless of any modifiers, so this
297	extension will actually grab a physical key just for this function.	303	extension will actually grab a physical key just for this function.
298		304
299	If you want a quake-like animation, tell your window manager to do so	305	If you want a quake-like animation, tell your window manager to do so
300	(fvwm can do it).	306	(fvwm can do it).
301		307
302	=item automove-background	308	=item overlay-osc
303		309
304	This is basically a very small extension that dynamically changes the	310	This extension implements some OSC commands to display timed popups on the
305	background pixmap offset to the window position, in effect creating the	311	screen - useful for status displays from within scripts. You have to read
306	same effect as pseudo transparency with a custom pixmap. No scaling is	312	the sources for more info.
307	supported in this mode. Example:
308
309	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
310		313
311	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
312		315
313	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
314	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
…		…
319	Displays a digital clock using the built-in overlay.	322	Displays a digital clock using the built-in overlay.
320		323
321	=item remote-clipboard	324	=item remote-clipboard
322		325
323	Somewhat of a misnomer, this extension adds two menu entries to the	326	Somewhat of a misnomer, this extension adds two menu entries to the
324	selection popup that allows one ti run external commands to store the	327	selection popup that allows one to run external commands to store the
325	selection somewhere and fetch it again.	328	selection somewhere and fetch it again.
326		329
327	We use it to implement a "distributed selection mechanism", which just	330	We use it to implement a "distributed selection mechanism", which just
328	means that one command uploads the file to a remote server, and another	331	means that one command uploads the file to a remote server, and another
329	reads it.	332	reads it.
…		…
338	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
339	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
340		343
341	=item selection-pastebin	344	=item selection-pastebin
342		345
343	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
344	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
345	not currently secure for use in a multiuser environment as it writes to	348	not currently secure for use in a multiuser environment as it writes to
346	F</tmp> directly.).	349	F</tmp> directly.).
347		350
348	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
367		370
368	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
369		372
370	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
371	the double C</> characters as comment start. Use C<\057\057> instead,	374	the double C</> characters as comment start. Use C<\057\057> instead,
372	which works regardless of wether xrdb is used to parse the resource file	375	which works regardless of whether xrdb is used to parse the resource file
373	or not.	376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
374		391
375	=item example-refresh-hooks	392	=item example-refresh-hooks
376		393
377	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
378	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
379	overlays or changes.	396	overlays or changes.
		397
		398	=item confirm-paste
		399
		400	Displays a confirmation dialog when a paste containing at least a full
		401	line is detected.
380		402
381	=back	403	=back
382		404
383	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
384		406
…		…
400		422
401	=over 4	423	=over 4
402		424
403	=item $text	425	=item $text
404		426
405	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
406	always represents one screen cell. See L<ROW_t> for a discussion of this format.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
407		429
408	=item $string	430	=item $string
409		431
410	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
544		566
545	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	567	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
546	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	568	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
547	number of lines that will be in the scrollback buffer.	569	number of lines that will be in the scrollback buffer.
548		570
549	=item on_osc_seq $term, $op, $args	571	=item on_osc_seq $term, $op, $args, $resp
550		572
551	Called on every OSC sequence and can be used to suppress it or modify its	573	Called on every OSC sequence and can be used to suppress it or modify its
552	behaviour. The default should be to return an empty list. A true value	574	behaviour. The default should be to return an empty list. A true value
553	suppresses execution of the request completely. Make sure you don't get	575	suppresses execution of the request completely. Make sure you don't get
554	confused by recursive invocations when you output an osc sequence within	576	confused by recursive invocations when you output an OSC sequence within
555	this callback.	577	this callback.
556		578
557	C<on_osc_seq_perl> should be used for new behaviour.	579	C<on_osc_seq_perl> should be used for new behaviour.
558		580
559	=item on_osc_seq_perl $term, $string	581	=item on_osc_seq_perl $term, $args, $resp
560		582
561	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	583	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
562	operating system command) is processed. Cursor position and other state	584	operating system command) is processed. Cursor position and other state
563	information is up-to-date when this happens. For interoperability, the	585	information is up-to-date when this happens. For interoperability, the
564	string should start with the extension name and a colon, to distinguish	586	string should start with the extension name (sans -osc) and a semicolon,
565	it from commands for other extensions, and this might be enforced in the	587	to distinguish it from commands for other extensions, and this might be
566	future.	588	enforced in the future.
		589
		590	For example, C<overlay-osc> uses this:
		591
		592	sub on_osc_seq_perl {
		593	my ($self, $osc, $resp) = @_;
		594
		595	return unless $osc =~ s/^overlay;//;
		596
		597	... process remaining $osc string
		598	}
567		599
568	Be careful not ever to trust (in a security sense) the data you receive,	600	Be careful not ever to trust (in a security sense) the data you receive,
569	as its source can not easily be controlled (e-mail content, messages from	601	as its source can not easily be controlled (e-mail content, messages from
570	other users on the same system etc.).	602	other users on the same system etc.).
		603
		604	For responses, C<$resp> contains the end-of-args separator used by the
		605	sender.
571		606
572	=item on_add_lines $term, $string	607	=item on_add_lines $term, $string
573		608
574	Called whenever text is about to be output, with the text as argument. You	609	Called whenever text is about to be output, with the text as argument. You
575	can filter/change and output the text yourself by returning a true value	610	can filter/change and output the text yourself by returning a true value
…		…
580	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
581		616
582	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
583	suppress or filter tty input.	618	suppress or filter tty input.
584		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
585	=item on_line_update $term, $row	627	=item on_line_update $term, $row
586		628
587	Called whenever a line was updated or changed. Can be used to filter	629	Called whenever a line was updated or changed. Can be used to filter
588	screen output (e.g. underline urls or other useless stuff). Only lines	630	screen output (e.g. underline urls or other useless stuff). Only lines
589	that are being shown will be filtered, and, due to performance reasons,	631	that are being shown will be filtered, and, due to performance reasons,
…		…
596	later with the already-modified line (e.g. if unrelated parts change), so	638	later with the already-modified line (e.g. if unrelated parts change), so
597	you cannot just toggle rendition bits, but only set them.	639	you cannot just toggle rendition bits, but only set them.
598		640
599	=item on_refresh_begin $term	641	=item on_refresh_begin $term
600		642
601	Called just before the screen gets redrawn. Can be used for overlay	643	Called just before the screen gets redrawn. Can be used for overlay or
602	or similar effects by modify terminal contents in refresh_begin, and	644	similar effects by modifying the terminal contents in refresh_begin, and
603	restoring them in refresh_end. The built-in overlay and selection display	645	restoring them in refresh_end. The built-in overlay and selection display
604	code is run after this hook, and takes precedence.	646	code is run after this hook, and takes precedence.
605		647
606	=item on_refresh_end $term	648	=item on_refresh_end $term
607		649
…		…
614	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
615		657
616	The event is simply the action string. This interface is assumed to change	658	The event is simply the action string. This interface is assumed to change
617	slightly in the future.	659	slightly in the future.
618		660
619	=item on_resize_all_windows $tern, $new_width, $new_height	661	=item on_resize_all_windows $term, $new_width, $new_height
620		662
621	Called just after the new window size has been calculated, but before	663	Called just after the new window size has been calculated, but before
622	windows are actually being resized or hints are being set. If this hook	664	windows are actually being resized or hints are being set. If this hook
623	returns TRUE, setting of the window hints is being skipped.	665	returns TRUE, setting of the window hints is being skipped.
624		666
…		…
658		700
659	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
660		702
661	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
662		704
663	Called whenever the corresponding X event is received for the terminal If	705	Called whenever the corresponding X event is received for the terminal. If
664	the hook returns true, then the even will be ignored by rxvt-unicode.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
665		707
666	The event is a hash with most values as named by Xlib (see the XEvent	708	The event is a hash with most values as named by Xlib (see the XEvent
667	manpage), with the additional members C<row> and C<col>, which are the	709	manpage), with the additional members C<row> and C<col>, which are the
668	(real, not screen-based) row and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
669		711
…		…
678		720
679	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
680		722
681	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
682	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
683		729
684	=back	730	=back
685		731
686	=cut	732	=cut
687		733
…		…
752		798
753	=over 4	799	=over 4
754		800
755	=item urxvt::fatal $errormessage	801	=item urxvt::fatal $errormessage
756		802
757	Fatally aborts execution with the given error message. Avoid at all	803	Fatally aborts execution with the given error message (which should
758	costs! The only time this is acceptable is when the terminal process	804	include a trailing newline). Avoid at all costs! The only time this
759	starts up.	805	is acceptable (and useful) is in the init hook, where it prevents the
		806	temrinal from starting up.
760		807
761	=item urxvt::warn $string	808	=item urxvt::warn $string
762		809
763	Calls C<rxvt_warn> with the given string which should not include a	810	Calls C<rxvt_warn> with the given string which should include a trailing
764	newline. The module also overwrites the C<warn> builtin with a function	811	newline. The module also overwrites the C<warn> builtin with a function
765	that calls this function.	812	that calls this function.
766		813
767	Using this function has the advantage that its output ends up in the	814	Using this function has the advantage that its output ends up in the
768	correct place, e.g. on stderr of the connecting urxvtc client.	815	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
825		872
826	=item $rend = urxvt::OVERLAY_RSTYLE	873	=item $rend = urxvt::OVERLAY_RSTYLE
827		874
828	Return the rendition mask used for overlays by default.	875	Return the rendition mask used for overlays by default.
829		876
830	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	877	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		878	urxvt::RS_RVid, urxvt::RS_Uline
831		879
832	Return the bit that enabled bold, italic, blink, reverse-video and	880	Return the bit that enabled bold, italic, blink, reverse-video and
833	underline, respectively. To enable such a style, just logically OR it into	881	underline, respectively. To enable such a style, just logically OR it into
834	the bitset.	882	the bitset.
835		883
…		…
918	local $TERM = shift;	966	local $TERM = shift;
919	my $htype = shift;	967	my $htype = shift;
920		968
921	if ($htype == 0) { # INIT	969	if ($htype == 0) { # INIT
922	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	970	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
923		971
924	my %ext_arg;	972	my %ext_arg;
925		973
926	{	974	{
927	my @init = @TERM_INIT;	975	my @init = @TERM_INIT;
928	@TERM_INIT = ();	976	@TERM_INIT = ();
…		…
1094	is that you cannot use blocking APIs, but the non-blocking variant should	1142	is that you cannot use blocking APIs, but the non-blocking variant should
1095	work.	1143	work.
1096		1144
1097	=cut	1145	=cut
1098		1146
1099	our $VERSION = 1;	1147	our $VERSION = '5.23';
1100		1148
1101	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1102	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1103		1151
1104	sub timer {	1152	sub timer {
…		…
1106		1154
1107	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
1108		1156
1109	urxvt::timer	1157	urxvt::timer
1110	->new	1158	->new
1111	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
1112	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
1113	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
1114	$cb->();	1162	$cb->();
1115	})	1163	})
1116	}	1164	}
1117		1165
1118	sub io {	1166	sub io {
1119	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
1120		1168
1121	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
1122		1172
1123	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
1124	->new	1174	->new
1125	->fd (fileno $arg{fh})	1175	->fd ($fd)
1126	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
1127	\| ($arg{poll} =~ /w/ ? 2 : 0))	1177	\| ($arg{poll} =~ /w/ ? 2 : 0))
1128	->start	1178	->start
1129	->cb (sub {	1179	->cb ($cb)
1130	$cb->(($_[1] & 1 ? 'r' : '')
1131	. ($_[1] & 2 ? 'w' : ''));
1132	})],
1133	urxvt::anyevent::	1180	], urxvt::anyevent::
		1181	}
		1182
		1183	sub idle {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::iw
		1189	->new
		1190	->start
		1191	->cb ($cb)
		1192	}
		1193
		1194	sub child {
		1195	my ($class, %arg) = @_;
		1196
		1197	my $cb = $arg{cb};
		1198
		1199	urxvt::pw
		1200	->new
		1201	->start ($arg{pid})
		1202	->cb (sub {
		1203	$_[0]->stop; # need to cancel manually
		1204	$cb->($_[0]->rpid, $_[0]->rstatus);
		1205	})
1134	}	1206	}
1135		1207
1136	sub DESTROY {	1208	sub DESTROY {
1137	$_[0][1]->stop;	1209	$_[0][1]->stop;
1138	}
1139
1140	sub condvar {
1141	bless \my $flag, urxvt::anyevent::
1142	}
1143
1144	sub broadcast {
1145	${$_[0]}++;
1146	}
1147
1148	sub wait {
1149	unless (${$_[0]}) {
1150	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1151	}
1152	}	1210	}
1153		1211
1154	sub one_event {	1212	sub one_event {
1155	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1213	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1156	}	1214	}
…		…
1279	Here is a likely non-exhaustive list of resource names, not all of which	1337	Here is a likely non-exhaustive list of resource names, not all of which
1280	are supported in every build, please see the source file F</src/rsinc.h>	1338	are supported in every build, please see the source file F</src/rsinc.h>
1281	to see the actual list:	1339	to see the actual list:
1282		1340
1283	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1341	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1284	borderLess color cursorBlink cursorUnderline cutchars delete_key	1342	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1285	display_name embed ext_bwidth fade font geometry hold iconName	1343	display_name embed ext_bwidth fade font geometry hold iconName
1286	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1344	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1287	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1345	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1288	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1346	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1289	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1347	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1290	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1348	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1291	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1349	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1292	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1350	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1293	secondaryScreen secondaryScroll selectstyle shade term_name title	1351	secondaryScreen secondaryScroll shade term_name title
1294	transient_for transparent transparent_all tripleclickwords utmpInhibit	1352	transient_for transparent transparent_all tripleclickwords utmpInhibit
1295	visualBell	1353	visualBell
1296		1354
1297	=cut	1355	=cut
1298		1356
1299	sub resource($$;$) {	1357	sub resource($$;$) {
1300	my ($self, $name) = (shift, shift);	1358	my ($self, $name) = (shift, shift);
1301	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1359	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1302	&urxvt::term::_resource	1360	goto &urxvt::term::_resource
1303	}	1361	}
1304		1362
1305	=item $value = $term->x_resource ($pattern)	1363	=item $value = $term->x_resource ($pattern)
1306		1364
1307	Returns the X-Resource for the given pattern, excluding the program or	1365	Returns the X-Resource for the given pattern, excluding the program or
…		…
1332		1390
1333	=item ($row, $col) = $term->selection_beg ([$row, $col])	1391	=item ($row, $col) = $term->selection_beg ([$row, $col])
1334		1392
1335	=item ($row, $col) = $term->selection_end ([$row, $col])	1393	=item ($row, $col) = $term->selection_end ([$row, $col])
1336		1394
1337	Return the current values of the selection mark, begin or end positions,	1395	Return the current values of the selection mark, begin or end positions.
1338	and optionally set them to new values.	1396
		1397	When arguments are given, then the selection coordinates are set to
		1398	C<$row> and C<$col>, and the selection screen is set to the current
		1399	screen.
		1400
		1401	=item $screen = $term->selection_screen ([$screen])
		1402
		1403	Returns the current selection screen, and then optionally sets it.
1339		1404
1340	=item $term->selection_make ($eventtime[, $rectangular])	1405	=item $term->selection_make ($eventtime[, $rectangular])
1341		1406
1342	Tries to make a selection as set by C<selection_beg> and	1407	Tries to make a selection as set by C<selection_beg> and
1343	C<selection_end>. If C<$rectangular> is true (default: false), a	1408	C<selection_end>. If C<$rectangular> is true (default: false), a
1344	rectangular selection will be made. This is the prefered function to make	1409	rectangular selection will be made. This is the preferred function to make
1345	a selection.	1410	a selection.
1346		1411
1347	=item $success = $term->selection_grab ($eventtime)	1412	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1348		1413
1349	Try to request the primary selection text from the server (for example, as	1414	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1415	true) selection from the server. The corresponding text can be set
1350	set by the next method). No visual feedback will be given. This function	1416	with the next method. No visual feedback will be given. This function
1351	is mostly useful from within C<on_sel_grab> hooks.	1417	is mostly useful from within C<on_sel_grab> hooks.
1352		1418
1353	=item $oldtext = $term->selection ([$newtext])	1419	=item $oldtext = $term->selection ([$newtext, $clipboard])
1354		1420
1355	Return the current selection text and optionally replace it by C<$newtext>.	1421	Return the current selection (clipboard if C<$clipboard> is true) text
		1422	and optionally replace it by C<$newtext>.
		1423
		1424	=item $term->selection_clear ([$clipboard])
		1425
		1426	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1356		1427
1357	=item $term->overlay_simple ($x, $y, $text)	1428	=item $term->overlay_simple ($x, $y, $text)
1358		1429
1359	Create a simple multi-line overlay box. See the next method for details.	1430	Create a simple multi-line overlay box. See the next method for details.
1360		1431
…		…
1390		1461
1391	The methods currently supported on C<urxvt::overlay> objects are:	1462	The methods currently supported on C<urxvt::overlay> objects are:
1392		1463
1393	=over 4	1464	=over 4
1394		1465
1395	=item $overlay->set ($x, $y, $text, $rend)	1466	=item $overlay->set ($x, $y, $text[, $rend])
1396		1467
1397	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1468	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1398	text in rxvt-unicode's special encoding and an array of rendition values	1469	text in rxvt-unicode's special encoding and an array of rendition values
1399	at a specific position inside the overlay.	1470	at a specific position inside the overlay.
		1471
		1472	If C<$rend> is missing, then the rendition will not be changed.
1400		1473
1401	=item $overlay->hide	1474	=item $overlay->hide
1402		1475
1403	If visible, hide the overlay, but do not destroy it.	1476	If visible, hide the overlay, but do not destroy it.
1404		1477
…		…
1486	locale-specific encoding of the terminal and can contain command sequences	1559	locale-specific encoding of the terminal and can contain command sequences
1487	(escape codes) that will be interpreted.	1560	(escape codes) that will be interpreted.
1488		1561
1489	=item $term->tt_write ($octets)	1562	=item $term->tt_write ($octets)
1490		1563
1491	Write the octets given in C<$data> to the tty (i.e. as program input). To	1564	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1492	pass characters instead of octets, you should convert your strings first	1565	pass characters instead of octets, you should convert your strings first
1493	to the locale-specific encoding using C<< $term->locale_encode >>.	1566	to the locale-specific encoding using C<< $term->locale_encode >>.
		1567
		1568	=item $term->tt_paste ($octets)
		1569
		1570	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1571	CR and bracketing the data with control sequences if bracketed paste mode
		1572	is set.
1494		1573
1495	=item $old_events = $term->pty_ev_events ([$new_events])	1574	=item $old_events = $term->pty_ev_events ([$new_events])
1496		1575
1497	Replaces the event mask of the pty watcher by the given event mask. Can	1576	Replaces the event mask of the pty watcher by the given event mask. Can
1498	be used to suppress input and output handling to the pty/tty. See the	1577	be used to suppress input and output handling to the pty/tty. See the
…		…
1614		1693
1615	Used after changing terminal contents to display them.	1694	Used after changing terminal contents to display them.
1616		1695
1617	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1696	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1618		1697
1619	Returns the text of the entire row with number C<$row_number>. Row C<0>	1698	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1620	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1699	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1621	terminal line. The scrollback buffer starts at line C<-1> and extends to
1622	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1700	terminal line. Nothing will be returned if a nonexistent line
1623	is requested.	1701	is requested.
1624		1702
1625	If C<$new_text> is specified, it will replace characters in the current	1703	If C<$new_text> is specified, it will replace characters in the current
1626	line, starting at column C<$start_col> (default C<0>), which is useful	1704	line, starting at column C<$start_col> (default C<0>), which is useful
1627	to replace only parts of a line. The font index in the rendition will	1705	to replace only parts of a line. The font index in the rendition will
1628	automatically be updated.	1706	automatically be updated.
1629		1707
1630	C<$text> is in a special encoding: tabs and wide characters that use more	1708	C<$text> is in a special encoding: tabs and wide characters that use more
1631	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1709	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1632	characters. Characters with combining characters and other characters that	1710	characters. Characters with combining characters and other characters that
1633	do not fit into the normal tetx encoding will be replaced with characters	1711	do not fit into the normal text encoding will be replaced with characters
1634	in the private use area.	1712	in the private use area.
1635		1713
1636	You have to obey this encoding when changing text. The advantage is	1714	You have to obey this encoding when changing text. The advantage is
1637	that C<substr> and similar functions work on screen cells and not on	1715	that C<substr> and similar functions work on screen cells and not on
1638	characters.	1716	characters.
…		…
1813	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1891	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1814	recent grab.	1892	recent grab.
1815		1893
1816	=item $term->ungrab	1894	=item $term->ungrab
1817		1895
1818	Calls XUngrab for the most recent grab. Is called automatically on	1896	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1819	evaluation errors, as it is better to lose the grab in the error case as	1897	evaluation errors, as it is better to lose the grab in the error case as
1820	the session.	1898	the session.
1821		1899
1822	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1900	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1823		1901
…		…
1825		1903
1826	=item @atoms = $term->XListProperties ($window)	1904	=item @atoms = $term->XListProperties ($window)
1827		1905
1828	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1906	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1829		1907
1830	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1908	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1831		1909
1832	=item $term->XDeleteProperty ($window, $property)	1910	=item $term->XDeleteProperty ($window, $property)
1833		1911
1834	=item $window = $term->DefaultRootWindow	1912	=item $window = $term->DefaultRootWindow
1835		1913
…		…
1845		1923
1846	=item $term->XChangeInput ($window, $add_events[, $del_events])	1924	=item $term->XChangeInput ($window, $add_events[, $del_events])
1847		1925
1848	Various X or X-related functions. The C<$term> object only serves as	1926	Various X or X-related functions. The C<$term> object only serves as
1849	the source of the display, otherwise those functions map more-or-less	1927	the source of the display, otherwise those functions map more-or-less
1850	directory onto the X functions of the same name.	1928	directly onto the X functions of the same name.
1851		1929
1852	=back	1930	=back
1853		1931
1854	=cut	1932	=cut
1855		1933
…		…
1957	my $env = $self->{term}->env;	2035	my $env = $self->{term}->env;
1958	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2036	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1959	delete $env->{LC_ALL};	2037	delete $env->{LC_ALL};
1960	$env->{LC_CTYPE} = $self->{term}->locale;	2038	$env->{LC_CTYPE} = $self->{term}->locale;
1961		2039
1962	urxvt::term->new ($env, "popup",	2040	my $term = urxvt::term->new (
		2041	$env, "popup",
1963	"--perl-lib" => "", "--perl-ext-common" => "",	2042	"--perl-lib" => "", "--perl-ext-common" => "",
1964	"-pty-fd" => -1, "-sl" => 0,	2043	"-pty-fd" => -1, "-sl" => 0,
1965	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2044	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1966	"--transient-for" => $self->{term}->parent,	2045	"--transient-for" => $self->{term}->parent,
1967	"-display" => $self->{term}->display_id,	2046	"-display" => $self->{term}->display_id,
1968	"-pe" => "urxvt-popup")	2047	"-pe" => "urxvt-popup",
1969	or die "unable to create popup window\n";	2048	) or die "unable to create popup window\n";
		2049
		2050	unless (delete $term->{urxvt_popup_init_done}) {
		2051	$term->ungrab;
		2052	$term->destroy;
		2053	die "unable to initialise popup window\n";
		2054	}
1970	}	2055	}
1971		2056
1972	sub DESTROY {	2057	sub DESTROY {
1973	my ($self) = @_;	2058	my ($self) = @_;
1974		2059
…		…
1992	->new	2077	->new
1993	->interval (1)	2078	->interval (1)
1994	->cb (sub {	2079	->cb (sub {
1995	$term->{overlay}->set (0, 0,	2080	$term->{overlay}->set (0, 0,
1996	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2081	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1997	});	2082	});
1998		2083
1999	=over 4	2084	=over 4
2000		2085
2001	=item $timer = new urxvt::timer	2086	=item $timer = new urxvt::timer
2002		2087
…		…
2005		2090
2006	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2091	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2007		2092
2008	Set the callback to be called when the timer triggers.	2093	Set the callback to be called when the timer triggers.
2009		2094
2010	=item $tstamp = $timer->at
2011
2012	Return the time this watcher will fire next.
2013
2014	=item $timer = $timer->set ($tstamp)	2095	=item $timer = $timer->set ($tstamp[, $interval])
2015		2096
2016	Set the time the event is generated to $tstamp.	2097	Set the time the event is generated to $tstamp (and optionally specifies a
		2098	new $interval).
2017		2099
2018	=item $timer = $timer->interval ($interval)	2100	=item $timer = $timer->interval ($interval)
2019		2101
2020	Normally (and when C<$interval> is C<0>), the timer will automatically	2102	By default (and when C<$interval> is C<0>), the timer will automatically
2021	stop after it has fired once. If C<$interval> is non-zero, then the timer	2103	stop after it has fired once. If C<$interval> is non-zero, then the timer
2022	is automatically rescheduled at the given intervals.	2104	is automatically rescheduled at the given intervals.
2023		2105
2024	=item $timer = $timer->start	2106	=item $timer = $timer->start
2025		2107
2026	Start the timer.	2108	Start the timer.
2027		2109
2028	=item $timer = $timer->start ($tstamp)	2110	=item $timer = $timer->start ($tstamp[, $interval])
2029		2111
2030	Set the event trigger time to C<$tstamp> and start the timer.	2112	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2113	also replaces the interval.
2031		2114
2032	=item $timer = $timer->after ($delay)	2115	=item $timer = $timer->after ($delay[, $interval])
2033		2116
2034	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2117	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2035		2118
2036	=item $timer = $timer->stop	2119	=item $timer = $timer->stop
2037		2120
…		…
2045		2128
2046	$term->{socket} = ...	2129	$term->{socket} = ...
2047	$term->{iow} = urxvt::iow	2130	$term->{iow} = urxvt::iow
2048	->new	2131	->new
2049	->fd (fileno $term->{socket})	2132	->fd (fileno $term->{socket})
2050	->events (urxvt::EVENT_READ)	2133	->events (urxvt::EV_READ)
2051	->start	2134	->start
2052	->cb (sub {	2135	->cb (sub {
2053	my ($iow, $revents) = @_;	2136	my ($iow, $revents) = @_;
2054	# $revents must be 1 here, no need to check	2137	# $revents must be 1 here, no need to check
2055	sysread $term->{socket}, my $buf, 8192	2138	sysread $term->{socket}, my $buf, 8192
…		…
2073	Set the file descriptor (not handle) to watch.	2156	Set the file descriptor (not handle) to watch.
2074		2157
2075	=item $iow = $iow->events ($eventmask)	2158	=item $iow = $iow->events ($eventmask)
2076		2159
2077	Set the event mask to watch. The only allowed values are	2160	Set the event mask to watch. The only allowed values are
2078	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2161	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2079	together, or C<urxvt::EVENT_NONE>.	2162	together, or C<urxvt::EV_NONE>.
2080		2163
2081	=item $iow = $iow->start	2164	=item $iow = $iow->start
2082		2165
2083	Start watching for requested events on the given handle.	2166	Start watching for requested events on the given handle.
2084		2167
…		…
2125	->new	2208	->new
2126	->start ($pid)	2209	->start ($pid)
2127	->cb (sub {	2210	->cb (sub {
2128	my ($pw, $exit_status) = @_;	2211	my ($pw, $exit_status) = @_;
2129	...	2212	...
2130	});	2213	});
2131		2214
2132	=over 4	2215	=over 4
2133		2216
2134	=item $pw = new urxvt::pw	2217	=item $pw = new urxvt::pw
2135		2218

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.152 by tpope, Tue Jan 9 16:18:56 2007 UTC vs. Revision 1.190 by root, Fri Jan 7 21:17:08 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.152 by tpope, Tue Jan 9 16:18:56 2007 UTC vs.
Revision 1.190 by root, Fri Jan 7 21:17:08 2011 UTC