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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.159 by root, Sun Nov 11 04:08:00 2007 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC

…		…
40		40
41	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
42		42
43	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:
44		44
45	URxvt.perl-ext-common: default,automove-background,selection-autotransform	45	URxvt.perl-ext-common: default,selection-autotransform
46		46
47	=over 4	47	=over 4
48		48
49	=item selection (enabled by default)	49	=item selection (enabled by default)
50		50
…		…
108	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
109	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
110	first argument.	110	first argument.
111		111
112	The following will add an entry C<myoption> that changes	112	The following will add an entry C<myoption> that changes
113	C<$self->{myoption}>:	113	C<< $self->{myoption} >>:
114		114
115	push @{ $self->{term}{option_popup_hook} }, sub {	115	push @{ $self->{term}{option_popup_hook} }, sub {
116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })	116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117	};	117	};
118		118
…		…
165	=item readline (enabled by default)	165	=item readline (enabled by default)
166		166
167	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
168	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
169	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
170	cursor-left or cursor-right keypresses as required (the this only works	170	cursor-left or cursor-right keypresses as required (this only works
171	for programs that correctly support wide characters).	171	for programs that correctly support wide characters).
172		172
173	To avoid too many false positives, this is only done when:	173	To avoid too many false positives, this is only done when:
174		174
175	=over 4	175	=over 4
…		…
259	The default pattern to match URLs can be overridden with the	259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified	260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.	261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.	262	The launcher can also be overridden on a per-pattern basis.
263		263
264	It is possible to activate the most recently seen match from the keyboard.	264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
265	Simply bind a keysym to "perl:matcher" as seen in the example below.	266	"perl:matcher:list" as seen in the example below.
266		267
267	Example configuration:	268	Example configuration:
268		269
269	URxvt.perl-ext: default,matcher	270	URxvt.perl-ext: default,matcher
270	URxvt.urlLauncher: sensible-browser	271	URxvt.urlLauncher: sensible-browser
271	URxvt.keysym.C-Delete: perl:matcher	272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
272	URxvt.matcher.button: 1	274	URxvt.matcher.button: 1
273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]	275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)	276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
275	URxvt.matcher.launcher.2: gvim +$2 $1	277	URxvt.matcher.launcher.2: gvim +$2 $1
276		278
…		…
303	extension will actually grab a physical key just for this function.	305	extension will actually grab a physical key just for this function.
304		306
305	If you want a quake-like animation, tell your window manager to do so	307	If you want a quake-like animation, tell your window manager to do so
306	(fvwm can do it).	308	(fvwm can do it).
307		309
308	=item automove-background	310	=item overlay-osc
309		311
310	This is basically a very small extension that dynamically changes the	312	This extension implements some OSC commands to display timed popups on the
311	background pixmap offset to the window position, in effect creating the	313	screen - useful for status displays from within scripts. You have to read
312	same effect as pseudo transparency with a custom pixmap. No scaling is	314	the sources for more info.
313	supported in this mode. Example:
314
315	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
316
317	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
318	shows how this extension can be used to implement an automatically blurred
319	transparent background.
320		315
321	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
322		317
323	A not very useful example of filtering all text output to the terminal	318	A not very useful example of filtering all text output to the terminal
324	by replacing all line-drawing characters (U+2500 .. U+259F) by a	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
348	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
349	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
350		345
351	=item selection-pastebin	346	=item selection-pastebin
352		347
353	This is a little rarely useful extension that Uploads the selection as	348	This is a little rarely useful extension that uploads the selection as
354	textfile to a remote site (or does other things). (The implementation is	349	textfile to a remote site (or does other things). (The implementation is
355	not currently secure for use in a multiuser environment as it writes to	350	not currently secure for use in a multiuser environment as it writes to
356	F</tmp> directly.).	351	F</tmp> directly.).
357		352
358	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
377		372
378	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
379		374
380	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
381	the double C</> characters as comment start. Use C<\057\057> instead,	376	the double C</> characters as comment start. Use C<\057\057> instead,
382	which works regardless of wether xrdb is used to parse the resource file	377	which works regardless of whether xrdb is used to parse the resource file
383	or not.	378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
384		393
385	=item example-refresh-hooks	394	=item example-refresh-hooks
386		395
387	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
388	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
389	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
390		412
391	=back	413	=back
392		414
393	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
394		416
…		…
410		432
411	=over 4	433	=over 4
412		434
413	=item $text	435	=item $text
414		436
415	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
416	always represents one screen cell. See L<ROW_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
417		439
418	=item $string	440	=item $string
419		441
420	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
424	=item $octets	446	=item $octets
425		447
426	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
427	locale-specific way.	449	locale-specific way.
428		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
429	=back	457	=back
430		458
431	=head2 Extension Objects	459	=head2 Extension Objects
432		460
433	Every perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
434	for each terminal, and each terminal has its own set of extenion objects,	462	for each terminal, and each terminal has its own set of extension objects,
435	which are passed as the first parameter to hooks. So extensions can use	463	which are passed as the first parameter to hooks. So extensions can use
436	their C<$self> object without having to think about clashes with other	464	their C<$self> object without having to think about clashes with other
437	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
438	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
439	internal use.	467	internal use.
…		…
554		582
555	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
556	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	584	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
557	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
558		586
559	=item on_osc_seq $term, $op, $args	587	=item on_osc_seq $term, $op, $args, $resp
560		588
561	Called on every OSC sequence and can be used to suppress it or modify its	589	Called on every OSC sequence and can be used to suppress it or modify its
562	behaviour. The default should be to return an empty list. A true value	590	behaviour. The default should be to return an empty list. A true value
563	suppresses execution of the request completely. Make sure you don't get	591	suppresses execution of the request completely. Make sure you don't get
564	confused by recursive invocations when you output an osc sequence within	592	confused by recursive invocations when you output an OSC sequence within
565	this callback.	593	this callback.
566		594
567	C<on_osc_seq_perl> should be used for new behaviour.	595	C<on_osc_seq_perl> should be used for new behaviour.
568		596
569	=item on_osc_seq_perl $term, $string	597	=item on_osc_seq_perl $term, $args, $resp
570		598
571	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
572	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
573	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
574	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
575	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
576	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
577		615
578	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
579	as its source can not easily be controlled (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
580	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
581		622
582	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
583		624
584	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
585	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
…		…
590	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
591		632
592	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
593	suppress or filter tty input.	634	suppress or filter tty input.
594		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
595	=item on_line_update $term, $row	643	=item on_line_update $term, $row
596		644
597	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
598	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
599	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
606	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
607	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
608		656
609	=item on_refresh_begin $term	657	=item on_refresh_begin $term
610		658
611	Called just before the screen gets redrawn. Can be used for overlay	659	Called just before the screen gets redrawn. Can be used for overlay or
612	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
613	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
614	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
615		663
616	=item on_refresh_end $term	664	=item on_refresh_end $term
617		665
…		…
624	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
625		673
626	The event is simply the action string. This interface is assumed to change	674	The event is simply the action string. This interface is assumed to change
627	slightly in the future.	675	slightly in the future.
628		676
629	=item on_resize_all_windows $tern, $new_width, $new_height	677	=item on_resize_all_windows $term, $new_width, $new_height
630		678
631	Called just after the new window size has been calculated, but before	679	Called just after the new window size has been calculated, but before
632	windows are actually being resized or hints are being set. If this hook	680	windows are actually being resized or hints are being set. If this hook
633	returns TRUE, setting of the window hints is being skipped.	681	returns TRUE, setting of the window hints is being skipped.
634		682
…		…
668		716
669	=item on_map_notify $term, $event	717	=item on_map_notify $term, $event
670		718
671	=item on_unmap_notify $term, $event	719	=item on_unmap_notify $term, $event
672		720
673	Called whenever the corresponding X event is received for the terminal If	721	Called whenever the corresponding X event is received for the terminal. If
674	the hook returns true, then the even will be ignored by rxvt-unicode.	722	the hook returns true, then the event will be ignored by rxvt-unicode.
675		723
676	The event is a hash with most values as named by Xlib (see the XEvent	724	The event is a hash with most values as named by Xlib (see the XEvent
677	manpage), with the additional members C<row> and C<col>, which are the	725	manpage), with the additional members C<row> and C<col>, which are the
678	(real, not screen-based) row and column under the mouse cursor.	726	(real, not screen-based) row and column under the mouse cursor.
679		727
…		…
688		736
689	=item on_wm_delete_window $term, $event	737	=item on_wm_delete_window $term, $event
690		738
691	Called when various types of ClientMessage events are received (all with	739	Called when various types of ClientMessage events are received (all with
692	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	740	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		741
		742	=item on_bell $term
		743
		744	Called on receipt of a bell character.
693		745
694	=back	746	=back
695		747
696	=cut	748	=cut
697		749
…		…
762		814
763	=over 4	815	=over 4
764		816
765	=item urxvt::fatal $errormessage	817	=item urxvt::fatal $errormessage
766		818
767	Fatally aborts execution with the given error message. Avoid at all	819	Fatally aborts execution with the given error message (which should
768	costs! The only time this is acceptable is when the terminal process	820	include a trailing newline). Avoid at all costs! The only time this
769	starts up.	821	is acceptable (and useful) is in the init hook, where it prevents the
		822	terminal from starting up.
770		823
771	=item urxvt::warn $string	824	=item urxvt::warn $string
772		825
773	Calls C<rxvt_warn> with the given string which should not include a	826	Calls C<rxvt_warn> with the given string which should include a trailing
774	newline. The module also overwrites the C<warn> builtin with a function	827	newline. The module also overwrites the C<warn> builtin with a function
775	that calls this function.	828	that calls this function.
776		829
777	Using this function has the advantage that its output ends up in the	830	Using this function has the advantage that its output ends up in the
778	correct place, e.g. on stderr of the connecting urxvtc client.	831	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
782	=item @terms = urxvt::termlist	835	=item @terms = urxvt::termlist
783		836
784	Returns all urxvt::term objects that exist in this process, regardless of	837	Returns all urxvt::term objects that exist in this process, regardless of
785	whether they are started, being destroyed etc., so be careful. Only term	838	whether they are started, being destroyed etc., so be careful. Only term
786	objects that have perl extensions attached will be returned (because there	839	objects that have perl extensions attached will be returned (because there
787	is no urxvt::term objet associated with others).	840	is no urxvt::term object associated with others).
788		841
789	=item $time = urxvt::NOW	842	=item $time = urxvt::NOW
790		843
791	Returns the "current time" (as per the event loop).	844	Returns the "current time" (as per the event loop).
792		845
…		…
835		888
836	=item $rend = urxvt::OVERLAY_RSTYLE	889	=item $rend = urxvt::OVERLAY_RSTYLE
837		890
838	Return the rendition mask used for overlays by default.	891	Return the rendition mask used for overlays by default.
839		892
840	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	893	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		894	urxvt::RS_RVid, urxvt::RS_Uline
841		895
842	Return the bit that enabled bold, italic, blink, reverse-video and	896	Return the bit that enabled bold, italic, blink, reverse-video and
843	underline, respectively. To enable such a style, just logically OR it into	897	underline, respectively. To enable such a style, just logically OR it into
844	the bitset.	898	the bitset.
845		899
…		…
927	sub invoke {	981	sub invoke {
928	local $TERM = shift;	982	local $TERM = shift;
929	my $htype = shift;	983	my $htype = shift;
930		984
931	if ($htype == 0) { # INIT	985	if ($htype == 0) { # INIT
932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	986	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
933		987
934	my %ext_arg;	988	my %ext_arg;
935		989
936	{	990	{
937	my @init = @TERM_INIT;	991	my @init = @TERM_INIT;
…		…
1104	is that you cannot use blocking APIs, but the non-blocking variant should	1158	is that you cannot use blocking APIs, but the non-blocking variant should
1105	work.	1159	work.
1106		1160
1107	=cut	1161	=cut
1108		1162
1109	our $VERSION = 1;	1163	our $VERSION = '5.23';
1110		1164
1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1165	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1166	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113		1167
1114	sub timer {	1168	sub timer {
…		…
1116		1170
1117	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
1118		1172
1119	urxvt::timer	1173	urxvt::timer
1120	->new	1174	->new
1121	->start (urxvt::NOW + $arg{after})	1175	->after ($arg{after}, $arg{interval})
1122	->cb (sub {	1176	->cb ($arg{interval} ? $cb : sub {
1123	$_[0]->stop; # need to cancel manually	1177	$_[0]->stop; # need to cancel manually
1124	$cb->();	1178	$cb->();
1125	})	1179	})
1126	}	1180	}
1127		1181
1128	sub io {	1182	sub io {
1129	my ($class, %arg) = @_;	1183	my ($class, %arg) = @_;
1130		1184
1131	my $cb = $arg{cb};	1185	my $cb = $arg{cb};
		1186	my $fd = fileno $arg{fh};
		1187	defined $fd or $fd = $arg{fh};
1132		1188
1133	bless [$arg{fh}, urxvt::iow	1189	bless [$arg{fh}, urxvt::iow
1134	->new	1190	->new
1135	->fd (fileno $arg{fh})	1191	->fd ($fd)
1136	->events (($arg{poll} =~ /r/ ? 1 : 0)	1192	->events (($arg{poll} =~ /r/ ? 1 : 0)
1137	\| ($arg{poll} =~ /w/ ? 2 : 0))	1193	\| ($arg{poll} =~ /w/ ? 2 : 0))
1138	->start	1194	->start
1139	->cb (sub {	1195	->cb ($cb)
1140	$cb->(($_[1] & 1 ? 'r' : '')
1141	. ($_[1] & 2 ? 'w' : ''));
1142	})],
1143	urxvt::anyevent::	1196	], urxvt::anyevent::
		1197	}
		1198
		1199	sub idle {
		1200	my ($class, %arg) = @_;
		1201
		1202	my $cb = $arg{cb};
		1203
		1204	urxvt::iw
		1205	->new
		1206	->start
		1207	->cb ($cb)
		1208	}
		1209
		1210	sub child {
		1211	my ($class, %arg) = @_;
		1212
		1213	my $cb = $arg{cb};
		1214
		1215	urxvt::pw
		1216	->new
		1217	->start ($arg{pid})
		1218	->cb (sub {
		1219	$_[0]->stop; # need to cancel manually
		1220	$cb->($_[0]->rpid, $_[0]->rstatus);
		1221	})
1144	}	1222	}
1145		1223
1146	sub DESTROY {	1224	sub DESTROY {
1147	$_[0][1]->stop;	1225	$_[0][1]->stop;
1148	}	1226	}
1149		1227
1150	sub condvar {	1228	# only needed for AnyEvent < 6 compatibility
1151	bless \my $flag, urxvt::anyevent::
1152	}
1153
1154	sub broadcast {
1155	${$_[0]}++;
1156	}
1157
1158	sub wait {
1159	unless (${$_[0]}) {
1160	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1161	}
1162	}
1163
1164	sub one_event {	1229	sub one_event {
1165	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1230	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1166	}	1231	}
1167		1232
1168	package urxvt::term;	1233	package urxvt::term;
…		…
1260	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1325	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1261		1326
1262	Here is a likely non-exhaustive list of option names, please see the	1327	Here is a likely non-exhaustive list of option names, please see the
1263	source file F</src/optinc.h> to see the actual list:	1328	source file F</src/optinc.h> to see the actual list:
1264		1329
1265	borderLess console cursorBlink cursorUnderline hold iconic insecure	1330	borderLess buffered console cursorBlink cursorUnderline hold iconic
1266	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1331	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1267	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1332	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1268	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1333	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1269	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1334	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1270	transparent tripleclickwords utmpInhibit visualBell	1335	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1336	urgentOnBell utmpInhibit visualBell
1271		1337
1272	=item $value = $term->resource ($name[, $newval])	1338	=item $value = $term->resource ($name[, $newval])
1273		1339
1274	Returns the current resource value associated with a given name and	1340	Returns the current resource value associated with a given name and
1275	optionally sets a new value. Setting values is most useful in the C<init>	1341	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1288		1354
1289	Here is a likely non-exhaustive list of resource names, not all of which	1355	Here is a likely non-exhaustive list of resource names, not all of which
1290	are supported in every build, please see the source file F</src/rsinc.h>	1356	are supported in every build, please see the source file F</src/rsinc.h>
1291	to see the actual list:	1357	to see the actual list:
1292		1358
1293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1359	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1294	borderLess color cursorBlink cursorUnderline cutchars delete_key	1360	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1295	display_name embed ext_bwidth fade font geometry hold iconName	1361	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1296	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1362	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1363	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1297	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1364	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1298	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1365	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1299	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1366	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1367	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1368	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1369	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303	secondaryScreen secondaryScroll selectstyle shade term_name title	1370	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1304	transient_for transparent transparent_all tripleclickwords utmpInhibit	1371	term_name title transient_for transparent tripleclickwords urgentOnBell
1305	visualBell	1372	utmpInhibit visualBell
1306		1373
1307	=cut	1374	=cut
1308		1375
1309	sub resource($$;$) {	1376	sub resource($$;$) {
1310	my ($self, $name) = (shift, shift);	1377	my ($self, $name) = (shift, shift);
1311	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1378	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
1312	&urxvt::term::_resource	1379	goto &urxvt::term::_resource
1313	}	1380	}
1314		1381
1315	=item $value = $term->x_resource ($pattern)	1382	=item $value = $term->x_resource ($pattern)
1316		1383
1317	Returns the X-Resource for the given pattern, excluding the program or	1384	Returns the X-Resource for the given pattern, excluding the program or
…		…
1321		1388
1322	This method should only be called during the C<on_start> hook, as there is	1389	This method should only be called during the C<on_start> hook, as there is
1323	only one resource database per display, and later invocations might return	1390	only one resource database per display, and later invocations might return
1324	the wrong resources.	1391	the wrong resources.
1325		1392
1326	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1393	=item $success = $term->parse_keysym ($key, $octets)
1327		1394
1328	Adds a keymap translation exactly as specified via a resource. See the	1395	Adds a key binding exactly as specified via a resource. See the
1329	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1396	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1330		1397
1331	=item $rend = $term->rstyle ([$new_rstyle])	1398	=item $rend = $term->rstyle ([$new_rstyle])
1332		1399
1333	Return and optionally change the current rendition. Text that is output by	1400	Return and optionally change the current rendition. Text that is output by
…		…
1342		1409
1343	=item ($row, $col) = $term->selection_beg ([$row, $col])	1410	=item ($row, $col) = $term->selection_beg ([$row, $col])
1344		1411
1345	=item ($row, $col) = $term->selection_end ([$row, $col])	1412	=item ($row, $col) = $term->selection_end ([$row, $col])
1346		1413
1347	Return the current values of the selection mark, begin or end positions,	1414	Return the current values of the selection mark, begin or end positions.
1348	and optionally set them to new values.	1415
		1416	When arguments are given, then the selection coordinates are set to
		1417	C<$row> and C<$col>, and the selection screen is set to the current
		1418	screen.
		1419
		1420	=item $screen = $term->selection_screen ([$screen])
		1421
		1422	Returns the current selection screen, and then optionally sets it.
1349		1423
1350	=item $term->selection_make ($eventtime[, $rectangular])	1424	=item $term->selection_make ($eventtime[, $rectangular])
1351		1425
1352	Tries to make a selection as set by C<selection_beg> and	1426	Tries to make a selection as set by C<selection_beg> and
1353	C<selection_end>. If C<$rectangular> is true (default: false), a	1427	C<selection_end>. If C<$rectangular> is true (default: false), a
1354	rectangular selection will be made. This is the prefered function to make	1428	rectangular selection will be made. This is the preferred function to make
1355	a selection.	1429	a selection.
1356		1430
1357	=item $success = $term->selection_grab ($eventtime)	1431	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1358		1432
1359	Try to request the primary selection text from the server (for example, as	1433	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1434	true) selection from the server. The corresponding text can be set
1360	set by the next method). No visual feedback will be given. This function	1435	with the next method. No visual feedback will be given. This function
1361	is mostly useful from within C<on_sel_grab> hooks.	1436	is mostly useful from within C<on_sel_grab> hooks.
1362		1437
1363	=item $oldtext = $term->selection ([$newtext])	1438	=item $oldtext = $term->selection ([$newtext, $clipboard])
1364		1439
1365	Return the current selection text and optionally replace it by C<$newtext>.	1440	Return the current selection (clipboard if C<$clipboard> is true) text
		1441	and optionally replace it by C<$newtext>.
		1442
		1443	=item $term->selection_clear ([$clipboard])
		1444
		1445	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1366		1446
1367	=item $term->overlay_simple ($x, $y, $text)	1447	=item $term->overlay_simple ($x, $y, $text)
1368		1448
1369	Create a simple multi-line overlay box. See the next method for details.	1449	Create a simple multi-line overlay box. See the next method for details.
1370		1450
…		…
1400		1480
1401	The methods currently supported on C<urxvt::overlay> objects are:	1481	The methods currently supported on C<urxvt::overlay> objects are:
1402		1482
1403	=over 4	1483	=over 4
1404		1484
1405	=item $overlay->set ($x, $y, $text, $rend)	1485	=item $overlay->set ($x, $y, $text[, $rend])
1406		1486
1407	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1487	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1408	text in rxvt-unicode's special encoding and an array of rendition values	1488	text in rxvt-unicode's special encoding and an array of rendition values
1409	at a specific position inside the overlay.	1489	at a specific position inside the overlay.
		1490
		1491	If C<$rend> is missing, then the rendition will not be changed.
1410		1492
1411	=item $overlay->hide	1493	=item $overlay->hide
1412		1494
1413	If visible, hide the overlay, but do not destroy it.	1495	If visible, hide the overlay, but do not destroy it.
1414		1496
…		…
1496	locale-specific encoding of the terminal and can contain command sequences	1578	locale-specific encoding of the terminal and can contain command sequences
1497	(escape codes) that will be interpreted.	1579	(escape codes) that will be interpreted.
1498		1580
1499	=item $term->tt_write ($octets)	1581	=item $term->tt_write ($octets)
1500		1582
1501	Write the octets given in C<$data> to the tty (i.e. as program input). To	1583	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1502	pass characters instead of octets, you should convert your strings first	1584	pass characters instead of octets, you should convert your strings first
1503	to the locale-specific encoding using C<< $term->locale_encode >>.	1585	to the locale-specific encoding using C<< $term->locale_encode >>.
		1586
		1587	=item $term->tt_paste ($octets)
		1588
		1589	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1590	CR and bracketing the data with control sequences if bracketed paste mode
		1591	is set.
1504		1592
1505	=item $old_events = $term->pty_ev_events ([$new_events])	1593	=item $old_events = $term->pty_ev_events ([$new_events])
1506		1594
1507	Replaces the event mask of the pty watcher by the given event mask. Can	1595	Replaces the event mask of the pty watcher by the given event mask. Can
1508	be used to suppress input and output handling to the pty/tty. See the	1596	be used to suppress input and output handling to the pty/tty. See the
…		…
1624		1712
1625	Used after changing terminal contents to display them.	1713	Used after changing terminal contents to display them.
1626		1714
1627	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1715	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1628		1716
1629	Returns the text of the entire row with number C<$row_number>. Row C<0>	1717	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1630	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1718	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1631	terminal line. The scrollback buffer starts at line C<-1> and extends to
1632	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1719	terminal line. Nothing will be returned if a nonexistent line
1633	is requested.	1720	is requested.
1634		1721
1635	If C<$new_text> is specified, it will replace characters in the current	1722	If C<$new_text> is specified, it will replace characters in the current
1636	line, starting at column C<$start_col> (default C<0>), which is useful	1723	line, starting at column C<$start_col> (default C<0>), which is useful
1637	to replace only parts of a line. The font index in the rendition will	1724	to replace only parts of a line. The font index in the rendition will
1638	automatically be updated.	1725	automatically be updated.
1639		1726
1640	C<$text> is in a special encoding: tabs and wide characters that use more	1727	C<$text> is in a special encoding: tabs and wide characters that use more
1641	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)	1728	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642	characters. Characters with combining characters and other characters that	1729	characters. Characters with combining characters and other characters that
1643	do not fit into the normal tetx encoding will be replaced with characters	1730	do not fit into the normal text encoding will be replaced with characters
1644	in the private use area.	1731	in the private use area.
1645		1732
1646	You have to obey this encoding when changing text. The advantage is	1733	You have to obey this encoding when changing text. The advantage is
1647	that C<substr> and similar functions work on screen cells and not on	1734	that C<substr> and similar functions work on screen cells and not on
1648	characters.	1735	characters.
…		…
1823	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1910	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1824	recent grab.	1911	recent grab.
1825		1912
1826	=item $term->ungrab	1913	=item $term->ungrab
1827		1914
1828	Calls XUngrab for the most recent grab. Is called automatically on	1915	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1829	evaluation errors, as it is better to lose the grab in the error case as	1916	evaluation errors, as it is better to lose the grab in the error case as
1830	the session.	1917	the session.
1831		1918
1832	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1919	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1833		1920
…		…
1835		1922
1836	=item @atoms = $term->XListProperties ($window)	1923	=item @atoms = $term->XListProperties ($window)
1837		1924
1838	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)	1925	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839		1926
1840	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)	1927	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1841		1928
1842	=item $term->XDeleteProperty ($window, $property)	1929	=item $term->XDeleteProperty ($window, $property)
1843		1930
1844	=item $window = $term->DefaultRootWindow	1931	=item $window = $term->DefaultRootWindow
1845		1932
…		…
1852	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	1939	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1853		1940
1854	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	1941	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1855		1942
1856	=item $term->XChangeInput ($window, $add_events[, $del_events])	1943	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1944
		1945	=item $keysym = $term->XStringToKeysym ($string)
		1946
		1947	=item $string = $term->XKeysymToString ($keysym)
1857		1948
1858	Various X or X-related functions. The C<$term> object only serves as	1949	Various X or X-related functions. The C<$term> object only serves as
1859	the source of the display, otherwise those functions map more-or-less	1950	the source of the display, otherwise those functions map more-or-less
1860	directory onto the X functions of the same name.	1951	directly onto the X functions of the same name.
1861		1952
1862	=back	1953	=back
1863		1954
1864	=cut	1955	=cut
1865		1956
…		…
1967	my $env = $self->{term}->env;	2058	my $env = $self->{term}->env;
1968	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2059	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969	delete $env->{LC_ALL};	2060	delete $env->{LC_ALL};
1970	$env->{LC_CTYPE} = $self->{term}->locale;	2061	$env->{LC_CTYPE} = $self->{term}->locale;
1971		2062
1972	urxvt::term->new ($env, "popup",	2063	my $term = urxvt::term->new (
		2064	$env, "popup",
1973	"--perl-lib" => "", "--perl-ext-common" => "",	2065	"--perl-lib" => "", "--perl-ext-common" => "",
1974	"-pty-fd" => -1, "-sl" => 0,	2066	"-pty-fd" => -1, "-sl" => 0,
1975	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",	2067	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976	"--transient-for" => $self->{term}->parent,	2068	"--transient-for" => $self->{term}->parent,
1977	"-display" => $self->{term}->display_id,	2069	"-display" => $self->{term}->display_id,
1978	"-pe" => "urxvt-popup")	2070	"-pe" => "urxvt-popup",
1979	or die "unable to create popup window\n";	2071	) or die "unable to create popup window\n";
		2072
		2073	unless (delete $term->{urxvt_popup_init_done}) {
		2074	$term->ungrab;
		2075	$term->destroy;
		2076	die "unable to initialise popup window\n";
		2077	}
1980	}	2078	}
1981		2079
1982	sub DESTROY {	2080	sub DESTROY {
1983	my ($self) = @_;	2081	my ($self) = @_;
1984		2082
…		…
2015		2113
2016	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2114	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017		2115
2018	Set the callback to be called when the timer triggers.	2116	Set the callback to be called when the timer triggers.
2019		2117
2020	=item $tstamp = $timer->at
2021
2022	Return the time this watcher will fire next.
2023
2024	=item $timer = $timer->set ($tstamp)	2118	=item $timer = $timer->set ($tstamp[, $interval])
2025		2119
2026	Set the time the event is generated to $tstamp.	2120	Set the time the event is generated to $tstamp (and optionally specifies a
		2121	new $interval).
2027		2122
2028	=item $timer = $timer->interval ($interval)	2123	=item $timer = $timer->interval ($interval)
2029		2124
2030	Normally (and when C<$interval> is C<0>), the timer will automatically	2125	By default (and when C<$interval> is C<0>), the timer will automatically
2031	stop after it has fired once. If C<$interval> is non-zero, then the timer	2126	stop after it has fired once. If C<$interval> is non-zero, then the timer
2032	is automatically rescheduled at the given intervals.	2127	is automatically rescheduled at the given intervals.
2033		2128
2034	=item $timer = $timer->start	2129	=item $timer = $timer->start
2035		2130
2036	Start the timer.	2131	Start the timer.
2037		2132
2038	=item $timer = $timer->start ($tstamp)	2133	=item $timer = $timer->start ($tstamp[, $interval])
2039		2134
2040	Set the event trigger time to C<$tstamp> and start the timer.	2135	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2136	also replaces the interval.
2041		2137
2042	=item $timer = $timer->after ($delay)	2138	=item $timer = $timer->after ($delay[, $interval])
2043		2139
2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2140	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045		2141
2046	=item $timer = $timer->stop	2142	=item $timer = $timer->stop
2047		2143
…		…
2178		2274
2179	=back	2275	=back
2180		2276
2181	=head1 AUTHOR	2277	=head1 AUTHOR
2182		2278
2183	Marc Lehmann <pcg@goof.com>	2279	Marc Lehmann <schmorp@schmorp.de>
2184	http://software.schmorp.de/pkg/rxvt-unicode	2280	http://software.schmorp.de/pkg/rxvt-unicode
2185		2281
2186	=cut	2282	=cut
2187		2283
2188	1	2284	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.159 by root, Sun Nov 11 04:08:00 2007 UTC vs. Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.159 by root, Sun Nov 11 04:08:00 2007 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC