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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC vs.
Revision 1.122 by root, Sat Jan 21 08:07:38 2006 UTC

…		…
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
…		…
87		91
88	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
89		93
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	96	evaluation, web-browser starting etc.), depending on content.
93		97
94	Other extensions can extend this popup menu by pushing a code reference onto	98	Other extensions can extend this popup menu by pushing a code reference
95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.	99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
96		101
97	It's sole argument is the popup menu, which can be modified. The selection	102	It's sole argument is the popup menu, which can be modified. The selection
98	is in C<$_>, which can be used to decide wether to add something or not.	103	is in C<$_>, which can be used to decide wether to add something or not.
99	It should either return nothing or a string and a code reference. The	104	It should either return nothing or a string and a code reference. The
100	string will be used as button text and the code reference will be called	105	string will be used as button text and the code reference will be called
…		…
102		107
103	The following will add an entry C<a to b> that transforms all C<a>s in	108	The following will add an entry C<a to b> that transforms all C<a>s in
104	the selection to C<b>s, but only if the selection currently contains any	109	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	110	C<a>s:
106		111
107	push urxvt::ext::selection_popup::hook, sub {	112	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	113	/a/ ? ("a to be" => sub { s/a/b/g }
109	: ()	114	: ()
110	};	115	};
111		116
112	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
…		…
143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144		149
145	And this example matches the same,but replaces it with vi-commands you can	150	And this example matches the same,but replaces it with vi-commands you can
146	paste directly into your (vi :) editor:	151	paste directly into your (vi :) editor:
147		152
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149		154
150	Of course, this can be modified to suit your needs and your editor :)	155	Of course, this can be modified to suit your needs and your editor :)
151		156
152	To expand the example above to typical perl error messages ("XXX at	157	To expand the example above to typical perl error messages ("XXX at
153	FILENAME line YYY."), you need a slightly more elaborate solution:	158	FILENAME line YYY."), you need a slightly more elaborate solution:
154		159
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157		162
158	The first line tells the selection code to treat the unchanging part of	163	The first line tells the selection code to treat the unchanging part of
159	every error message as a selection pattern, and the second line transforms	164	every error message as a selection pattern, and the second line transforms
160	the message into vi commands to load the file.	165	the message into vi commands to load the file.
		166
		167	=item readline
		168
		169	A support package that tries to make editing with readline easier. At the
		170	moment, it reacts to clicking with the left mouse button by trying to
		171	move the text cursor to this position. It does so by generating as many
		172	cursor-left or cursor-right keypresses as required (the this only works
		173	for programs that correctly support wide characters).
		174
		175	To avoid too many false positives, this is only done when:
		176
		177	=over 4
		178
		179	=item - the mouse is on the same (multi-row-) line as the text cursor.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the text cursor is visible.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
		189
		190	=item tabbed
		191
		192	This transforms the terminal into a tabbar with additional terminals, that
		193	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		194	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		195	button per tab.
		196
		197	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		198	B<Shift-Right> will switch to the tab left or right of the current one,
		199	while B<Shift-Down> creates a new tab.
161		200
162	=item mark-urls	201	=item mark-urls
163		202
164	Uses per-line display filtering (C<on_line_update>) to underline urls and	203	Uses per-line display filtering (C<on_line_update>) to underline urls and
165	make them clickable. When middle-clicked, the program specified in the	204	make them clickable. When middle-clicked, the program specified in the
…		…
298	called whenever the relevant event happens.	337	called whenever the relevant event happens.
299		338
300	The first argument passed to them is an extension oject as described in	339	The first argument passed to them is an extension oject as described in
301	the in the C<Extension Objects> section.	340	the in the C<Extension Objects> section.
302		341
303	B<All> of these hooks must return a boolean value. If it is true, then the	342	B<All> of these hooks must return a boolean value. If any of the called
304	event counts as being I<consumed>, and the invocation of other hooks is	343	hooks returns true, then the event counts as being I<consumed>, and the
305	skipped, and the relevant action might not be carried out by the C++ code.	344	relevant action might not be carried out by the C++ code.
306		345
307	I<< When in doubt, return a false value (preferably C<()>). >>	346	I<< When in doubt, return a false value (preferably C<()>). >>
308		347
309	=over 4	348	=over 4
310		349
311	=item on_init $term	350	=item on_init $term
312		351
313	Called after a new terminal object has been initialized, but before	352	Called after a new terminal object has been initialized, but before
314	windows are created or the command gets run. Most methods are unsafe to	353	windows are created or the command gets run. Most methods are unsafe to
315	call or deliver senseless data, as terminal size and other characteristics	354	call or deliver senseless data, as terminal size and other characteristics
316	have not yet been determined. You can safely query and change resources,	355	have not yet been determined. You can safely query and change resources
317	though.	356	and options, though. For many purposes the C<on_start> hook is a better
		357	place.
		358
		359	=item on_start $term
		360
		361	Called at the very end of initialisation of a new terminal, just before
		362	trying to map (display) the toplevel and returning to the mainloop.
		363
		364	=item on_destroy $term
		365
		366	Called whenever something tries to destroy terminal, before doing anything
		367	yet. If this hook returns true, then destruction is skipped, but this is
		368	rarely a good idea.
318		369
319	=item on_reset $term	370	=item on_reset $term
320		371
321	Called after the screen is "reset" for any reason, such as resizing or	372	Called after the screen is "reset" for any reason, such as resizing or
322	control sequences. Here is where you can react on changes to size-related	373	control sequences. Here is where you can react on changes to size-related
323	variables.	374	variables.
324		375
325	=item on_start $term	376	=item on_child_start $term, $pid
326		377
327	Called at the very end of initialisation of a new terminal, just before	378	Called just after the child process has been C<fork>ed.
328	returning to the mainloop.	379
		380	=item on_child_exit $term, $status
		381
		382	Called just after the child process has exited. C<$status> is the status
		383	from C<waitpid>.
329		384
330	=item on_sel_make $term, $eventtime	385	=item on_sel_make $term, $eventtime
331		386
332	Called whenever a selection has been made by the user, but before the	387	Called whenever a selection has been made by the user, but before the
333	selection text is copied, so changes to the beginning, end or type of the	388	selection text is copied, so changes to the beginning, end or type of the
…		…
444	Called wheneever the window loses keyboard focus, before rxvt-unicode does	499	Called wheneever the window loses keyboard focus, before rxvt-unicode does
445	focus out processing.	500	focus out processing.
446		501
447	=item on_configure_notify $term, $event	502	=item on_configure_notify $term, $event
448		503
		504	=item on_property_notify $term, $event
		505
449	=item on_key_press $term, $event, $keysym, $octets	506	=item on_key_press $term, $event, $keysym, $octets
450		507
451	=item on_key_release $term, $event, $keysym	508	=item on_key_release $term, $event, $keysym
452		509
453	=item on_button_press $term, $event	510	=item on_button_press $term, $event
…		…
462		519
463	Called whenever the corresponding X event is received for the terminal If	520	Called whenever the corresponding X event is received for the terminal If
464	the hook returns true, then the even will be ignored by rxvt-unicode.	521	the hook returns true, then the even will be ignored by rxvt-unicode.
465		522
466	The event is a hash with most values as named by Xlib (see the XEvent	523	The event is a hash with most values as named by Xlib (see the XEvent
467	manpage), with the additional members C<row> and C<col>, which are the row	524	manpage), with the additional members C<row> and C<col>, which are the
468	and column under the mouse cursor.	525	(real, not screen-based) row and column under the mouse cursor.
469		526
470	C<on_key_press> additionally receives the string rxvt-unicode would	527	C<on_key_press> additionally receives the string rxvt-unicode would
471	output, if any, in locale-specific encoding.	528	output, if any, in locale-specific encoding.
472		529
473	subwindow.	530	subwindow.
		531
		532	=item on_client_message $term, $event
		533
		534	=item on_wm_protocols $term, $event
		535
		536	=item on_wm_delete_window $term, $event
		537
		538	Called when various types of ClientMessage events are received (all with
		539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
474		540
475	=back	541	=back
476		542
477	=cut	543	=cut
478		544
…		…
484	use Scalar::Util ();	550	use Scalar::Util ();
485	use List::Util ();	551	use List::Util ();
486		552
487	our $VERSION = 1;	553	our $VERSION = 1;
488	our $TERM;	554	our $TERM;
		555	our @TERM_INIT;
		556	our @TERM_EXT;
489	our @HOOKNAME;	557	our @HOOKNAME;
490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	558	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491	our %OPTION;	559	our %OPTION;
492		560
493	our $LIBDIR;	561	our $LIBDIR;
494	our $RESNAME;	562	our $RESNAME;
495	our $RESCLASS;	563	our $RESCLASS;
496	our $RXVTNAME;	564	our $RXVTNAME;
497		565
		566	our $NOCHAR = chr 0xfffe;
		567
498	=head2 Variables in the C<urxvt> Package	568	=head2 Variables in the C<urxvt> Package
499		569
500	=over 4	570	=over 4
501		571
502	=item $urxvt::LIBDIR	572	=item $urxvt::LIBDIR
…		…
514		584
515	=item $urxvt::TERM	585	=item $urxvt::TERM
516		586
517	The current terminal. This variable stores the current C<urxvt::term>	587	The current terminal. This variable stores the current C<urxvt::term>
518	object, whenever a callback/hook is executing.	588	object, whenever a callback/hook is executing.
		589
		590	=item @urxvt::TERM_INIT
		591
		592	All coderefs in this array will be called as methods of the next newly
		593	created C<urxvt::term> object (during the C<on_init> phase). The array
		594	gets cleared before the codereferences that were in it are being executed,
		595	so coderefs can push themselves onto it again if they so desire.
		596
		597	This complements to the perl-eval commandline option, but gets executed
		598	first.
		599
		600	=item @urxvt::TERM_EXT
		601
		602	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		603	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		604	but before other extensions. Gets cleared just like C<@TERM_INIT>.
519		605
520	=back	606	=back
521		607
522	=head2 Functions in the C<urxvt> Package	608	=head2 Functions in the C<urxvt> Package
523		609
…		…
630	my $msg = join "", @_;	716	my $msg = join "", @_;
631	$msg .= "\n"	717	$msg .= "\n"
632	unless $msg =~ /\n$/;	718	unless $msg =~ /\n$/;
633	urxvt::warn ($msg);	719	urxvt::warn ($msg);
634	};	720	};
635
636	# %ENV is the original startup environment
637	delete $ENV{IFS};
638	delete $ENV{CDPATH};
639	delete $ENV{BASH_ENV};
640	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
641	}	721	}
642		722
643	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	723	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
644		724
645	sub verbose {	725	sub verbose {
…		…
650	my %extension_pkg;	730	my %extension_pkg;
651		731
652	# load a single script into its own package, once only	732	# load a single script into its own package, once only
653	sub extension_package($) {	733	sub extension_package($) {
654	my ($path) = @_;	734	my ($path) = @_;
655
656	no strict 'refs';
657		735
658	$extension_pkg{$path} \|\|= do {	736	$extension_pkg{$path} \|\|= do {
659	$path =~ /([^\/\\]+)$/;	737	$path =~ /([^\/\\]+)$/;
660	my $pkg = $1;	738	my $pkg = $1;
661	$pkg =~ s/[^[:word:]]/_/g;	739	$pkg =~ s/[^[:word:]]/_/g;
…		…
664	verbose 3, "loading extension '$path' into package '$pkg'";	742	verbose 3, "loading extension '$path' into package '$pkg'";
665		743
666	open my $fh, "<:raw", $path	744	open my $fh, "<:raw", $path
667	or die "$path: $!";	745	or die "$path: $!";
668		746
669	@{"$pkg\::ISA"} = urxvt::term::extension::;
670
671	my $source =	747	my $source =
672	"package $pkg; use strict; use utf8;\n"	748	"package $pkg; use strict; use utf8;\n"
673	. "#line 1 \"$path\"\n{\n"	749	. "#line 1 \"$path\"\n{\n"
674	. (do { local $/; <$fh> })	750	. (do { local $/; <$fh> })
675	. "\n};\n1";	751	. "\n};\n1";
…		…
691	if ($htype == 0) { # INIT	767	if ($htype == 0) { # INIT
692	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	768	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
693		769
694	my %ext_arg;	770	my %ext_arg;
695		771
		772	{
		773	my @init = @TERM_INIT;
		774	@TERM_INIT = ();
		775	$_->($TERM) for @init;
		776	my @pkg = @TERM_EXT;
		777	@TERM_EXT = ();
		778	$TERM->register_package ($_) for @pkg;
		779	}
		780
696	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	781	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
697	if ($_ eq "default") {	782	if ($_ eq "default") {
698	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	783	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
699	} elsif (/^-(.*)$/) {	784	} elsif (/^-(.*)$/) {
700	delete $ext_arg{$1};	785	delete $ext_arg{$1};
701	} elsif (/^([^<]+)<(.*)>$/) {	786	} elsif (/^([^<]+)<(.*)>$/) {
…		…
726	if $verbosity >= 10;	811	if $verbosity >= 10;
727		812
728	keys %$cb;	813	keys %$cb;
729		814
730	while (my ($pkg, $cb) = each %$cb) {	815	while (my ($pkg, $cb) = each %$cb) {
731	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	816	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
732	and last;	817	$retval \|\|= $retval_;
733		818
734	if ($@) {	819	if ($@) {
735	$TERM->ungrab; # better to lose the grab than the session	820	$TERM->ungrab; # better to lose the grab than the session
736	warn $@;	821	warn $@;
737	}	822	}
…		…
748	# clear package	833	# clear package
749	%$TERM = ();	834	%$TERM = ();
750	}	835	}
751		836
752	$retval	837	$retval
753	}
754
755	sub exec_async(@) {
756	my $pid = fork;
757
758	return
759	if !defined $pid or $pid;
760
761	%ENV = %{ $TERM->env };
762
763	exec @_;
764	_exit 255;
765	}	838	}
766		839
767	# urxvt::term::extension	840	# urxvt::term::extension
768		841
769	package urxvt::term::extension;	842	package urxvt::term::extension;
…		…
908	# find on_xxx subs in the package and register them	981	# find on_xxx subs in the package and register them
909	# as hooks	982	# as hooks
910	sub register_package {	983	sub register_package {
911	my ($self, $pkg, $argv) = @_;	984	my ($self, $pkg, $argv) = @_;
912		985
		986	no strict 'refs';
		987
		988	urxvt::verbose 6, "register package $pkg to $self";
		989
		990	@{"$pkg\::ISA"} = urxvt::term::extension::;
		991
913	my $proxy = bless {	992	my $proxy = bless {
914	_pkg => $pkg,	993	_pkg => $pkg,
915	argv => $argv,	994	argv => $argv,
916	}, $pkg;	995	}, $pkg;
917	Scalar::Util::weaken ($proxy->{term} = $self);	996	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
948		1027
949	Destroy the terminal object (close the window, free resources	1028	Destroy the terminal object (close the window, free resources
950	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1029	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
951	watchers (timers, io watchers) are still active.	1030	watchers (timers, io watchers) are still active.
952		1031
		1032	=item $term->exec_async ($cmd[, @args])
		1033
		1034	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1035	("starts") programs in the background. This function takes care of setting
		1036	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1037	be preferred over explicit calls to C<exec> or C<system>.
		1038
		1039	Returns the pid of the subprocess or C<undef> on error.
		1040
		1041	=cut
		1042
		1043	sub exec_async {
		1044	my $self = shift;
		1045
		1046	my $pid = fork;
		1047
		1048	return $pid
		1049	if !defined $pid or $pid;
		1050
		1051	%ENV = %{ $self->env };
		1052
		1053	exec @_;
		1054	urxvt::_exit 255;
		1055	}
		1056
953	=item $isset = $term->option ($optval[, $set])	1057	=item $isset = $term->option ($optval[, $set])
954		1058
955	Returns true if the option specified by C<$optval> is enabled, and	1059	Returns true if the option specified by C<$optval> is enabled, and
956	optionally change it. All option values are stored by name in the hash	1060	optionally change it. All option values are stored by name in the hash
957	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1061	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
959	Here is a a likely non-exhaustive list of option names, please see the	1063	Here is a a likely non-exhaustive list of option names, please see the
960	source file F</src/optinc.h> to see the actual list:	1064	source file F</src/optinc.h> to see the actual list:
961		1065
962	borderLess console cursorBlink cursorUnderline hold iconic insecure	1066	borderLess console cursorBlink cursorUnderline hold iconic insecure
963	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1067	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
964	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1068	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
965	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1069	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
966	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1070	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
967	tripleclickwords utmpInhibit visualBell	1071	transparent tripleclickwords utmpInhibit visualBell
968		1072
969	=item $value = $term->resource ($name[, $newval])	1073	=item $value = $term->resource ($name[, $newval])
970		1074
971	Returns the current resource value associated with a given name and	1075	Returns the current resource value associated with a given name and
972	optionally sets a new value. Setting values is most useful in the C<init>	1076	optionally sets a new value. Setting values is most useful in the C<init>
…		…
989		1093
990	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1094	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
991	borderLess color cursorBlink cursorUnderline cutchars delete_key	1095	borderLess color cursorBlink cursorUnderline cutchars delete_key
992	display_name embed ext_bwidth fade font geometry hold iconName	1096	display_name embed ext_bwidth fade font geometry hold iconName
993	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1097	imFont imLocale inputMethod insecure int_bwidth intensityStyles
994	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1098	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
995	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1099	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
996	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1100	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
997	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1101	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
998	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1102	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
999	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1103	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1000	shade term_name title transparent transparent_all tripleclickwords	1104	secondaryScreen secondaryScroll selectstyle shade term_name title
1001	utmpInhibit visualBell	1105	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1106	visualBell
1002		1107
1003	=cut	1108	=cut
1004		1109
1005	sub resource($$;$) {	1110	sub resource($$;$) {
1006	my ($self, $name) = (shift, shift);	1111	my ($self, $name) = (shift, shift);
…		…
1179	string is a normal text string, not in locale-dependent encoding.	1284	string is a normal text string, not in locale-dependent encoding.
1180		1285
1181	Normally its not a good idea to use this function, as programs might be	1286	Normally its not a good idea to use this function, as programs might be
1182	confused by changes in cursor position or scrolling. Its useful inside a	1287	confused by changes in cursor position or scrolling. Its useful inside a
1183	C<on_add_lines> hook, though.	1288	C<on_add_lines> hook, though.
		1289
		1290	=item $term->scr_change_screen ($screen)
		1291
		1292	Switch to given screen - 0 primary, 1 secondary.
1184		1293
1185	=item $term->cmd_parse ($octets)	1294	=item $term->cmd_parse ($octets)
1186		1295
1187	Similar to C<scr_add_lines>, but the argument must be in the	1296	Similar to C<scr_add_lines>, but the argument must be in the
1188	locale-specific encoding of the terminal and can contain command sequences	1297	locale-specific encoding of the terminal and can contain command sequences
…		…
1272	=item $modifiermask = $term->ModNumLockMask	1381	=item $modifiermask = $term->ModNumLockMask
1273		1382
1274	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1383	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1275	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1384	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1276		1385
		1386	=item $screen = $term->current_screen
		1387
		1388	Returns the currently displayed screen (0 primary, 1 secondary).
		1389
		1390	=item $cursor_is_hidden = $term->hidden_cursor
		1391
		1392	Returns wether the cursor is currently hidden or not.
		1393
1277	=item $view_start = $term->view_start ([$newvalue])	1394	=item $view_start = $term->view_start ([$newvalue])
1278		1395
1279	Returns the row number of the topmost displayed line. Maximum value is	1396	Returns the row number of the topmost displayed line. Maximum value is
1280	C<0>, which displays the normal terminal contents. Lower values scroll	1397	C<0>, which displays the normal terminal contents. Lower values scroll
1281	this many lines into the scrollback buffer.	1398	this many lines into the scrollback buffer.
…		…
1299	If C<$new_text> is specified, it will replace characters in the current	1416	If C<$new_text> is specified, it will replace characters in the current
1300	line, starting at column C<$start_col> (default C<0>), which is useful	1417	line, starting at column C<$start_col> (default C<0>), which is useful
1301	to replace only parts of a line. The font index in the rendition will	1418	to replace only parts of a line. The font index in the rendition will
1302	automatically be updated.	1419	automatically be updated.
1303		1420
1304	C<$text> is in a special encoding: tabs and wide characters that use more	1421	C<$text> is in a special encoding: tabs and wide characters that use
1305	than one cell when displayed are padded with urxvt::NOCHAR characters	1422	more than one cell when displayed are padded with C<$urxvt::NOCHAR>
1306	(C<chr 65535>). Characters with combining characters and other characters	1423	characters. Characters with combining characters and other characters that
1307	that do not fit into the normal tetx encoding will be replaced with	1424	do not fit into the normal tetx encoding will be replaced with characters
1308	characters in the private use area.	1425	in the private use area.
1309		1426
1310	You have to obey this encoding when changing text. The advantage is	1427	You have to obey this encoding when changing text. The advantage is
1311	that C<substr> and similar functions work on screen cells and not on	1428	that C<substr> and similar functions work on screen cells and not on
1312	characters.	1429	characters.
1313		1430
…		…
1488		1605
1489	Calls XUngrab for the most recent grab. Is called automatically on	1606	Calls XUngrab for the most recent grab. Is called automatically on
1490	evaluation errors, as it is better to lose the grab in the error case as	1607	evaluation errors, as it is better to lose the grab in the error case as
1491	the session.	1608	the session.
1492		1609
		1610	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1611
		1612	=item $atom_name = $term->XGetAtomName ($atom)
		1613
		1614	=item @atoms = $term->XListProperties ($window)
		1615
		1616	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1617
		1618	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1619
		1620	=item $term->XDeleteProperty ($window, $property)
		1621
		1622	=item $window = $term->DefaultRootWindow
		1623
		1624	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1625
		1626	=item $term->XMapWindow ($window)
		1627
		1628	=item $term->XUnmapWindow ($window)
		1629
		1630	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1631
		1632	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1633
		1634	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1635
		1636	Various X or X-related functions. The C<$term> object only serves as
		1637	the source of the display, otherwise those functions map more-or-less
		1638	directory onto the X functions of the same name.
		1639
1493	=back	1640	=back
1494		1641
1495	=cut	1642	=cut
1496		1643
1497	package urxvt::popup;	1644	package urxvt::popup;
…		…
1599	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1746	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1600	delete $env->{LC_ALL};	1747	delete $env->{LC_ALL};
1601	$env->{LC_CTYPE} = $self->{term}->locale;	1748	$env->{LC_CTYPE} = $self->{term}->locale;
1602		1749
1603	urxvt::term->new ($env, "popup",	1750	urxvt::term->new ($env, "popup",
1604	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1751	"--perl-lib" => "", "--perl-ext-common" => "",
		1752	"-pty-fd" => -1, "-sl" => 0,
		1753	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1605	"--transient-for" => $self->{term}->parent,	1754	"--transient-for" => $self->{term}->parent,
1606	"-display" => $self->{term}->display_id,	1755	"-display" => $self->{term}->display_id,
1607	"-pe" => "urxvt-popup")	1756	"-pe" => "urxvt-popup")
1608	or die "unable to create popup window\n";	1757	or die "unable to create popup window\n";
1609	}	1758	}
…		…
1614	delete $self->{term}{_destroy}{$self};	1763	delete $self->{term}{_destroy}{$self};
1615	$self->{term}->ungrab;	1764	$self->{term}->ungrab;
1616	}	1765	}
1617		1766
1618	=back	1767	=back
		1768
		1769	=cut
		1770
		1771	package urxvt::watcher;
		1772
		1773	@urxvt::timer::ISA = __PACKAGE__;
		1774	@urxvt::iow::ISA = __PACKAGE__;
		1775	@urxvt::pw::ISA = __PACKAGE__;
		1776	@urxvt::iw::ISA = __PACKAGE__;
1619		1777
1620	=head2 The C<urxvt::timer> Class	1778	=head2 The C<urxvt::timer> Class
1621		1779
1622	This class implements timer watchers/events. Time is represented as a	1780	This class implements timer watchers/events. Time is represented as a
1623	fractional number of seconds since the epoch. Example:	1781	fractional number of seconds since the epoch. Example:
…		…
1721		1879
1722	Stop watching for events on the given filehandle.	1880	Stop watching for events on the given filehandle.
1723		1881
1724	=back	1882	=back
1725		1883
		1884	=head2 The C<urxvt::iw> Class
		1885
		1886	This class implements idle watchers, that get called automatically when
		1887	the process is idle. They should return as fast as possible, after doing
		1888	some useful work.
		1889
		1890	=over 4
		1891
		1892	=item $iw = new urxvt::iw
		1893
		1894	Create a new idle watcher object in stopped state.
		1895
		1896	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1897
		1898	Set the callback to be called when the watcher triggers.
		1899
		1900	=item $timer = $timer->start
		1901
		1902	Start the watcher.
		1903
		1904	=item $timer = $timer->stop
		1905
		1906	Stop the watcher.
		1907
		1908	=back
		1909
		1910	=head2 The C<urxvt::pw> Class
		1911
		1912	This class implements process watchers. They create an event whenever a
		1913	process exits, after which they stop automatically.
		1914
		1915	my $pid = fork;
		1916	...
		1917	$term->{pw} = urxvt::pw
		1918	->new
		1919	->start ($pid)
		1920	->cb (sub {
		1921	my ($pw, $exit_status) = @_;
		1922	...
		1923	});
		1924
		1925	=over 4
		1926
		1927	=item $pw = new urxvt::pw
		1928
		1929	Create a new process watcher in stopped state.
		1930
		1931	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1932
		1933	Set the callback to be called when the timer triggers.
		1934
		1935	=item $pw = $timer->start ($pid)
		1936
		1937	Tells the wqtcher to start watching for process C<$pid>.
		1938
		1939	=item $pw = $pw->stop
		1940
		1941	Stop the watcher.
		1942
		1943	=back
		1944
1726	=head1 ENVIRONMENT	1945	=head1 ENVIRONMENT
1727		1946
1728	=head2 URXVT_PERL_VERBOSITY	1947	=head2 URXVT_PERL_VERBOSITY
1729		1948
1730	This variable controls the verbosity level of the perl extension. Higher	1949	This variable controls the verbosity level of the perl extension. Higher

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC vs. Revision 1.122 by root, Sat Jan 21 08:07:38 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.104 by root, Wed Jan 18 17:49:47 2006 UTC vs.
Revision 1.122 by root, Sat Jan 21 08:07:38 2006 UTC