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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC vs.
Revision 1.125 by root, Sun Jan 22 20:39:47 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.
		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
93		116
94	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
95		118
96	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
104	bottom. C<Escape> leaves search mode and returns to the point where search	127	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and	128	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary	129	additionally stores the first match in the current line into the primary
107	selection.	130	selection.
108		131
		132	=item readline (enabled by default)
		133
		134	A support package that tries to make editing with readline easier. At the
		135	moment, it reacts to clicking with the left mouse button by trying to
		136	move the text cursor to this position. It does so by generating as many
		137	cursor-left or cursor-right keypresses as required (the this only works
		138	for programs that correctly support wide characters).
		139
		140	To avoid too many false positives, this is only done when:
		141
		142	=over 4
		143
		144	=item - the tty is in ICANON state.
		145
		146	=item - the text cursor is visible.
		147
		148	=item - the primary screen is currently being displayed.
		149
		150	=item - the mouse is on the same (multi-row-) line as the text cursor.
		151
		152	=back
		153
		154	The normal selection mechanism isn't disabled, so quick successive clicks
		155	might interfere with selection creation in harmless ways.
		156
109	=item selection-autotransform	157	=item selection-autotransform
110		158
111	This selection allows you to do automatic transforms on a selection	159	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	160	whenever a selection is made.
113		161
…		…
125	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	173	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		174
127	And this example matches the same,but replaces it with vi-commands you can	175	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	176	paste directly into your (vi :) editor:
129		177
130	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	178	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		179
132	Of course, this can be modified to suit your needs and your editor :)	180	Of course, this can be modified to suit your needs and your editor :)
133		181
134	To expand the example above to typical perl error messages ("XXX at	182	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:	183	FILENAME line YYY."), you need a slightly more elaborate solution:
136		184
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	185	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	186	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139		187
140	The first line tells the selection code to treat the unchanging part of	188	The first line tells the selection code to treat the unchanging part of
141	every error message as a selection pattern, and the second line transforms	189	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.	190	the message into vi commands to load the file.
		191
		192	=item tabbed
		193
		194	This transforms the terminal into a tabbar with additional terminals, that
		195	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		196	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		197	button per tab.
		198
		199	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		200	B<Shift-Right> will switch to the tab left or right of the current one,
		201	while B<Shift-Down> creates a new tab.
143		202
144	=item mark-urls	203	=item mark-urls
145		204
146	Uses per-line display filtering (C<on_line_update>) to underline urls and	205	Uses per-line display filtering (C<on_line_update>) to underline urls and
147	make them clickable. When middle-clicked, the program specified in the	206	make them clickable. When middle-clicked, the program specified in the
148	resource C<urlLauncher> (default C<x-www-browser>) will be started with	207	resource C<urlLauncher> (default C<x-www-browser>) will be started with
149	the URL as first argument.	208	the URL as first argument.
150		209
		210	=item automove-background
		211
		212	This is basically a one-line extension that dynamically changes the background pixmap offset
		213	to the window position, in effect creating the same effect as pseudo transparency with
		214	a custom pixmap. No scaling is supported in this mode. Exmaple:
		215
		216	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		217
151	=item block-graphics-to-ascii	218	=item block-graphics-to-ascii
152		219
153	A not very useful example of filtering all text output to the terminal,	220	A not very useful example of filtering all text output to the terminal,
154	by replacing all line-drawing characters (U+2500 .. U+259F) by a	221	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.	222	similar-looking ascii character.
…		…
165	overlays or changes.	232	overlays or changes.
166		233
167	=item selection-pastebin	234	=item selection-pastebin
168		235
169	This is a little rarely useful extension that Uploads the selection as	236	This is a little rarely useful extension that Uploads the selection as
170	textfile to a remote site (or does other things).	237	textfile to a remote site (or does other things). (The implementation is
		238	not currently secure for use in a multiuser environment as it writes to
		239	F</tmp> directly.).
171		240
172	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	241	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
173	i.e.	242	i.e.
174		243
175	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin	244	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
…		…
270	called whenever the relevant event happens.	339	called whenever the relevant event happens.
271		340
272	The first argument passed to them is an extension oject as described in	341	The first argument passed to them is an extension oject as described in
273	the in the C<Extension Objects> section.	342	the in the C<Extension Objects> section.
274		343
275	B<All> of these hooks must return a boolean value. If it is true, then the	344	B<All> of these hooks must return a boolean value. If any of the called
276	event counts as being I<consumed>, and the invocation of other hooks is	345	hooks returns true, then the event counts as being I<consumed>, and the
277	skipped, and the relevant action might not be carried out by the C++ code.	346	relevant action might not be carried out by the C++ code.
278		347
279	I<< When in doubt, return a false value (preferably C<()>). >>	348	I<< When in doubt, return a false value (preferably C<()>). >>
280		349
281	=over 4	350	=over 4
282		351
283	=item on_init $term	352	=item on_init $term
284		353
285	Called after a new terminal object has been initialized, but before	354	Called after a new terminal object has been initialized, but before
286	windows are created or the command gets run. Most methods are unsafe to	355	windows are created or the command gets run. Most methods are unsafe to
287	call or deliver senseless data, as terminal size and other characteristics	356	call or deliver senseless data, as terminal size and other characteristics
288	have not yet been determined. You can safely query and change resources,	357	have not yet been determined. You can safely query and change resources
289	though.	358	and options, though. For many purposes the C<on_start> hook is a better
		359	place.
		360
		361	=item on_start $term
		362
		363	Called at the very end of initialisation of a new terminal, just before
		364	trying to map (display) the toplevel and returning to the mainloop.
		365
		366	=item on_destroy $term
		367
		368	Called whenever something tries to destroy terminal, before doing anything
		369	yet. If this hook returns true, then destruction is skipped, but this is
		370	rarely a good idea.
290		371
291	=item on_reset $term	372	=item on_reset $term
292		373
293	Called after the screen is "reset" for any reason, such as resizing or	374	Called after the screen is "reset" for any reason, such as resizing or
294	control sequences. Here is where you can react on changes to size-related	375	control sequences. Here is where you can react on changes to size-related
295	variables.	376	variables.
296		377
297	=item on_start $term	378	=item on_child_start $term, $pid
298		379
299	Called at the very end of initialisation of a new terminal, just before	380	Called just after the child process has been C<fork>ed.
300	returning to the mainloop.	381
		382	=item on_child_exit $term, $status
		383
		384	Called just after the child process has exited. C<$status> is the status
		385	from C<waitpid>.
301		386
302	=item on_sel_make $term, $eventtime	387	=item on_sel_make $term, $eventtime
303		388
304	Called whenever a selection has been made by the user, but before the	389	Called whenever a selection has been made by the user, but before the
305	selection text is copied, so changes to the beginning, end or type of the	390	selection text is copied, so changes to the beginning, end or type of the
…		…
414	=item on_focus_out $term	499	=item on_focus_out $term
415		500
416	Called wheneever the window loses keyboard focus, before rxvt-unicode does	501	Called wheneever the window loses keyboard focus, before rxvt-unicode does
417	focus out processing.	502	focus out processing.
418		503
		504	=item on_configure_notify $term, $event
		505
		506	=item on_property_notify $term, $event
		507
419	=item on_key_press $term, $event, $keysym, $octets	508	=item on_key_press $term, $event, $keysym, $octets
420		509
421	=item on_key_release $term, $event, $keysym	510	=item on_key_release $term, $event, $keysym
422		511
423	=item on_button_press $term, $event	512	=item on_button_press $term, $event
…		…
432		521
433	Called whenever the corresponding X event is received for the terminal If	522	Called whenever the corresponding X event is received for the terminal If
434	the hook returns true, then the even will be ignored by rxvt-unicode.	523	the hook returns true, then the even will be ignored by rxvt-unicode.
435		524
436	The event is a hash with most values as named by Xlib (see the XEvent	525	The event is a hash with most values as named by Xlib (see the XEvent
437	manpage), with the additional members C<row> and C<col>, which are the row	526	manpage), with the additional members C<row> and C<col>, which are the
438	and column under the mouse cursor.	527	(real, not screen-based) row and column under the mouse cursor.
439		528
440	C<on_key_press> additionally receives the string rxvt-unicode would	529	C<on_key_press> additionally receives the string rxvt-unicode would
441	output, if any, in locale-specific encoding.	530	output, if any, in locale-specific encoding.
442		531
443	subwindow.	532	subwindow.
		533
		534	=item on_client_message $term, $event
		535
		536	=item on_wm_protocols $term, $event
		537
		538	=item on_wm_delete_window $term, $event
		539
		540	Called when various types of ClientMessage events are received (all with
		541	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
444		542
445	=back	543	=back
446		544
447	=cut	545	=cut
448		546
…		…
454	use Scalar::Util ();	552	use Scalar::Util ();
455	use List::Util ();	553	use List::Util ();
456		554
457	our $VERSION = 1;	555	our $VERSION = 1;
458	our $TERM;	556	our $TERM;
		557	our @TERM_INIT;
		558	our @TERM_EXT;
459	our @HOOKNAME;	559	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	560	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	561	our %OPTION;
462		562
463	our $LIBDIR;	563	our $LIBDIR;
464	our $RESNAME;	564	our $RESNAME;
465	our $RESCLASS;	565	our $RESCLASS;
466	our $RXVTNAME;	566	our $RXVTNAME;
467		567
		568	our $NOCHAR = chr 0xffff;
		569
468	=head2 Variables in the C<urxvt> Package	570	=head2 Variables in the C<urxvt> Package
469		571
470	=over 4	572	=over 4
471		573
472	=item $urxvt::LIBDIR	574	=item $urxvt::LIBDIR
…		…
484		586
485	=item $urxvt::TERM	587	=item $urxvt::TERM
486		588
487	The current terminal. This variable stores the current C<urxvt::term>	589	The current terminal. This variable stores the current C<urxvt::term>
488	object, whenever a callback/hook is executing.	590	object, whenever a callback/hook is executing.
		591
		592	=item @urxvt::TERM_INIT
		593
		594	All coderefs in this array will be called as methods of the next newly
		595	created C<urxvt::term> object (during the C<on_init> phase). The array
		596	gets cleared before the codereferences that were in it are being executed,
		597	so coderefs can push themselves onto it again if they so desire.
		598
		599	This complements to the perl-eval commandline option, but gets executed
		600	first.
		601
		602	=item @urxvt::TERM_EXT
		603
		604	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		605	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		606	but before other extensions. Gets cleared just like C<@TERM_INIT>.
489		607
490	=back	608	=back
491		609
492	=head2 Functions in the C<urxvt> Package	610	=head2 Functions in the C<urxvt> Package
493		611
…		…
593	=back	711	=back
594		712
595	=cut	713	=cut
596		714
597	BEGIN {	715	BEGIN {
598	urxvt->bootstrap;
599
600	# overwrite perl's warn	716	# overwrite perl's warn
601	*CORE::GLOBAL::warn = sub {	717	*CORE::GLOBAL::warn = sub {
602	my $msg = join "", @_;	718	my $msg = join "", @_;
603	$msg .= "\n"	719	$msg .= "\n"
604	unless $msg =~ /\n$/;	720	unless $msg =~ /\n$/;
605	urxvt::warn ($msg);	721	urxvt::warn ($msg);
606	};	722	};
607
608	# %ENV is the original startup environment
609	delete $ENV{IFS};
610	delete $ENV{CDPATH};
611	delete $ENV{BASH_ENV};
612	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
613	}	723	}
		724
		725	no warnings 'utf8';
614		726
615	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	727	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616		728
617	sub verbose {	729	sub verbose {
618	my ($level, $msg) = @_;	730	my ($level, $msg) = @_;
619	warn "$msg\n" if $level <= $verbosity;	731	warn "$msg\n" if $level <= $verbosity;
620	}	732	}
621		733
622	my $extension_pkg = "extension0000";
623	my %extension_pkg;	734	my %extension_pkg;
624		735
625	# load a single script into its own package, once only	736	# load a single script into its own package, once only
626	sub extension_package($) {	737	sub extension_package($) {
627	my ($path) = @_;	738	my ($path) = @_;
628		739
629	$extension_pkg{$path} \|\|= do {	740	$extension_pkg{$path} \|\|= do {
630	my $pkg = "urxvt::" . ($extension_pkg++);	741	$path =~ /([^\/\\]+)$/;
		742	my $pkg = $1;
		743	$pkg =~ s/[^[:word:]]/_/g;
		744	$pkg = "urxvt::ext::$pkg";
631		745
632	verbose 3, "loading extension '$path' into package '$pkg'";	746	verbose 3, "loading extension '$path' into package '$pkg'";
633		747
634	open my $fh, "<:raw", $path	748	open my $fh, "<:raw", $path
635	or die "$path: $!";	749	or die "$path: $!";
636		750
637	my $source =	751	my $source =
638	"package $pkg; use strict; use utf8;\n"	752	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
639	. "use base urxvt::term::extension::;\n"
640	. "#line 1 \"$path\"\n{\n"	753	. "#line 1 \"$path\"\n{\n"
641	. (do { local $/; <$fh> })	754	. (do { local $/; <$fh> })
642	. "\n};\n1";	755	. "\n};\n1";
643		756
644	eval $source	757	eval $source
…		…
658	if ($htype == 0) { # INIT	771	if ($htype == 0) { # INIT
659	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	772	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
660		773
661	my %ext_arg;	774	my %ext_arg;
662		775
		776	{
		777	my @init = @TERM_INIT;
		778	@TERM_INIT = ();
		779	$_->($TERM) for @init;
		780	my @pkg = @TERM_EXT;
		781	@TERM_EXT = ();
		782	$TERM->register_package ($_) for @pkg;
		783	}
		784
663	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	785	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
664	if ($_ eq "default") {	786	if ($_ eq "default") {
665	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	787	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
666	} elsif (/^-(.*)$/) {	788	} elsif (/^-(.*)$/) {
667	delete $ext_arg{$1};	789	delete $ext_arg{$1};
668	} elsif (/^([^<]+)<(.*)>$/) {	790	} elsif (/^([^<]+)<(.*)>$/) {
669	push @{ $ext_arg{$1} }, $2;	791	push @{ $ext_arg{$1} }, $2;
670	} else {	792	} else {
…		…
693	if $verbosity >= 10;	815	if $verbosity >= 10;
694		816
695	keys %$cb;	817	keys %$cb;
696		818
697	while (my ($pkg, $cb) = each %$cb) {	819	while (my ($pkg, $cb) = each %$cb) {
698	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	820	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
699	and last;	821	$retval \|\|= $retval_;
700		822
701	if ($@) {	823	if ($@) {
702	$TERM->ungrab; # better to lose the grab than the session	824	$TERM->ungrab; # better to lose the grab than the session
703	warn $@;	825	warn $@;
704	}	826	}
…		…
715	# clear package	837	# clear package
716	%$TERM = ();	838	%$TERM = ();
717	}	839	}
718		840
719	$retval	841	$retval
720	}
721
722	sub exec_async(@) {
723	my $pid = fork;
724
725	return
726	if !defined $pid or $pid;
727
728	%ENV = %{ $TERM->env };
729
730	exec @_;
731	_exit 255;
732	}	842	}
733		843
734	# urxvt::term::extension	844	# urxvt::term::extension
735		845
736	package urxvt::term::extension;	846	package urxvt::term::extension;
…		…
875	# find on_xxx subs in the package and register them	985	# find on_xxx subs in the package and register them
876	# as hooks	986	# as hooks
877	sub register_package {	987	sub register_package {
878	my ($self, $pkg, $argv) = @_;	988	my ($self, $pkg, $argv) = @_;
879		989
		990	no strict 'refs';
		991
		992	urxvt::verbose 6, "register package $pkg to $self";
		993
		994	@{"$pkg\::ISA"} = urxvt::term::extension::;
		995
880	my $proxy = bless {	996	my $proxy = bless {
881	_pkg => $pkg,	997	_pkg => $pkg,
882	argv => $argv,	998	argv => $argv,
883	}, $pkg;	999	}, $pkg;
884	Scalar::Util::weaken ($proxy->{term} = $self);	1000	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
915		1031
916	Destroy the terminal object (close the window, free resources	1032	Destroy the terminal object (close the window, free resources
917	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1033	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
918	watchers (timers, io watchers) are still active.	1034	watchers (timers, io watchers) are still active.
919		1035
		1036	=item $term->exec_async ($cmd[, @args])
		1037
		1038	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1039	("starts") programs in the background. This function takes care of setting
		1040	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1041	be preferred over explicit calls to C<exec> or C<system>.
		1042
		1043	Returns the pid of the subprocess or C<undef> on error.
		1044
		1045	=cut
		1046
		1047	sub exec_async {
		1048	my $self = shift;
		1049
		1050	my $pid = fork;
		1051
		1052	return $pid
		1053	if !defined $pid or $pid;
		1054
		1055	%ENV = %{ $self->env };
		1056
		1057	exec @_;
		1058	urxvt::_exit 255;
		1059	}
		1060
920	=item $isset = $term->option ($optval[, $set])	1061	=item $isset = $term->option ($optval[, $set])
921		1062
922	Returns true if the option specified by C<$optval> is enabled, and	1063	Returns true if the option specified by C<$optval> is enabled, and
923	optionally change it. All option values are stored by name in the hash	1064	optionally change it. All option values are stored by name in the hash
924	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1065	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
926	Here is a a likely non-exhaustive list of option names, please see the	1067	Here is a a likely non-exhaustive list of option names, please see the
927	source file F</src/optinc.h> to see the actual list:	1068	source file F</src/optinc.h> to see the actual list:
928		1069
929	borderLess console cursorBlink cursorUnderline hold iconic insecure	1070	borderLess console cursorBlink cursorUnderline hold iconic insecure
930	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1071	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
931	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1072	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
932	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1073	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
933	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1074	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
934	tripleclickwords utmpInhibit visualBell	1075	transparent tripleclickwords utmpInhibit visualBell
935		1076
936	=item $value = $term->resource ($name[, $newval])	1077	=item $value = $term->resource ($name[, $newval])
937		1078
938	Returns the current resource value associated with a given name and	1079	Returns the current resource value associated with a given name and
939	optionally sets a new value. Setting values is most useful in the C<init>	1080	optionally sets a new value. Setting values is most useful in the C<init>
…		…
956		1097
957	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1098	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
958	borderLess color cursorBlink cursorUnderline cutchars delete_key	1099	borderLess color cursorBlink cursorUnderline cutchars delete_key
959	display_name embed ext_bwidth fade font geometry hold iconName	1100	display_name embed ext_bwidth fade font geometry hold iconName
960	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1101	imFont imLocale inputMethod insecure int_bwidth intensityStyles
961	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1102	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
962	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1103	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
963	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1104	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
964	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1105	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
965	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1106	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
966	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1107	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
967	shade term_name title transparent transparent_all tripleclickwords	1108	secondaryScreen secondaryScroll selectstyle shade term_name title
968	utmpInhibit visualBell	1109	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1110	visualBell
969		1111
970	=cut	1112	=cut
971		1113
972	sub resource($$;$) {	1114	sub resource($$;$) {
973	my ($self, $name) = (shift, shift);	1115	my ($self, $name) = (shift, shift);
…		…
1147		1289
1148	Normally its not a good idea to use this function, as programs might be	1290	Normally its not a good idea to use this function, as programs might be
1149	confused by changes in cursor position or scrolling. Its useful inside a	1291	confused by changes in cursor position or scrolling. Its useful inside a
1150	C<on_add_lines> hook, though.	1292	C<on_add_lines> hook, though.
1151		1293
		1294	=item $term->scr_change_screen ($screen)
		1295
		1296	Switch to given screen - 0 primary, 1 secondary.
		1297
1152	=item $term->cmd_parse ($octets)	1298	=item $term->cmd_parse ($octets)
1153		1299
1154	Similar to C<scr_add_lines>, but the argument must be in the	1300	Similar to C<scr_add_lines>, but the argument must be in the
1155	locale-specific encoding of the terminal and can contain command sequences	1301	locale-specific encoding of the terminal and can contain command sequences
1156	(escape codes) that will be interpreted.	1302	(escape codes) that will be interpreted.
…		…
1165		1311
1166	Replaces the event mask of the pty watcher by the given event mask. Can	1312	Replaces the event mask of the pty watcher by the given event mask. Can
1167	be used to suppress input and output handling to the pty/tty. See the	1313	be used to suppress input and output handling to the pty/tty. See the
1168	description of C<< urxvt::timer->events >>. Make sure to always restore	1314	description of C<< urxvt::timer->events >>. Make sure to always restore
1169	the previous value.	1315	the previous value.
		1316
		1317	=item $fd = $term->pty_fd
		1318
		1319	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1320	is used.
1170		1321
1171	=item $windowid = $term->parent	1322	=item $windowid = $term->parent
1172		1323
1173	Return the window id of the toplevel window.	1324	Return the window id of the toplevel window.
1174		1325
…		…
1239	=item $modifiermask = $term->ModNumLockMask	1390	=item $modifiermask = $term->ModNumLockMask
1240		1391
1241	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1392	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1242	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1393	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1243		1394
		1395	=item $screen = $term->current_screen
		1396
		1397	Returns the currently displayed screen (0 primary, 1 secondary).
		1398
		1399	=item $cursor_is_hidden = $term->hidden_cursor
		1400
		1401	Returns wether the cursor is currently hidden or not.
		1402
1244	=item $view_start = $term->view_start ([$newvalue])	1403	=item $view_start = $term->view_start ([$newvalue])
1245		1404
1246	Returns the row number of the topmost displayed line. Maximum value is	1405	Returns the row number of the topmost displayed line. Maximum value is
1247	C<0>, which displays the normal terminal contents. Lower values scroll	1406	C<0>, which displays the normal terminal contents. Lower values scroll
1248	this many lines into the scrollback buffer.	1407	this many lines into the scrollback buffer.
…		…
1267	line, starting at column C<$start_col> (default C<0>), which is useful	1426	line, starting at column C<$start_col> (default C<0>), which is useful
1268	to replace only parts of a line. The font index in the rendition will	1427	to replace only parts of a line. The font index in the rendition will
1269	automatically be updated.	1428	automatically be updated.
1270		1429
1271	C<$text> is in a special encoding: tabs and wide characters that use more	1430	C<$text> is in a special encoding: tabs and wide characters that use more
1272	than one cell when displayed are padded with urxvt::NOCHAR characters	1431	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1273	(C<chr 65535>). Characters with combining characters and other characters	1432	characters. Characters with combining characters and other characters that
1274	that do not fit into the normal tetx encoding will be replaced with	1433	do not fit into the normal tetx encoding will be replaced with characters
1275	characters in the private use area.	1434	in the private use area.
1276		1435
1277	You have to obey this encoding when changing text. The advantage is	1436	You have to obey this encoding when changing text. The advantage is
1278	that C<substr> and similar functions work on screen cells and not on	1437	that C<substr> and similar functions work on screen cells and not on
1279	characters.	1438	characters.
1280		1439
…		…
1455		1614
1456	Calls XUngrab for the most recent grab. Is called automatically on	1615	Calls XUngrab for the most recent grab. Is called automatically on
1457	evaluation errors, as it is better to lose the grab in the error case as	1616	evaluation errors, as it is better to lose the grab in the error case as
1458	the session.	1617	the session.
1459		1618
		1619	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1620
		1621	=item $atom_name = $term->XGetAtomName ($atom)
		1622
		1623	=item @atoms = $term->XListProperties ($window)
		1624
		1625	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1626
		1627	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1628
		1629	=item $term->XDeleteProperty ($window, $property)
		1630
		1631	=item $window = $term->DefaultRootWindow
		1632
		1633	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1634
		1635	=item $term->XMapWindow ($window)
		1636
		1637	=item $term->XUnmapWindow ($window)
		1638
		1639	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1640
		1641	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1642
		1643	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1644
		1645	Various X or X-related functions. The C<$term> object only serves as
		1646	the source of the display, otherwise those functions map more-or-less
		1647	directory onto the X functions of the same name.
		1648
1460	=back	1649	=back
1461		1650
1462	=cut	1651	=cut
1463		1652
1464	package urxvt::popup;	1653	package urxvt::popup;
…		…
1565	my $env = $self->{term}->env;	1754	my $env = $self->{term}->env;
1566	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1755	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1567	delete $env->{LC_ALL};	1756	delete $env->{LC_ALL};
1568	$env->{LC_CTYPE} = $self->{term}->locale;	1757	$env->{LC_CTYPE} = $self->{term}->locale;
1569		1758
1570	urxvt::term->new ($env, $self->{term}->resource ("name"),	1759	urxvt::term->new ($env, "popup",
1571	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1760	"--perl-lib" => "", "--perl-ext-common" => "",
		1761	"-pty-fd" => -1, "-sl" => 0,
		1762	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1572	"--transient-for" => $self->{term}->parent,	1763	"--transient-for" => $self->{term}->parent,
1573	"-display" => $self->{term}->display_id,	1764	"-display" => $self->{term}->display_id,
1574	"-pe" => "urxvt-popup")	1765	"-pe" => "urxvt-popup")
1575	or die "unable to create popup window\n";	1766	or die "unable to create popup window\n";
1576	}	1767	}
…		…
1581	delete $self->{term}{_destroy}{$self};	1772	delete $self->{term}{_destroy}{$self};
1582	$self->{term}->ungrab;	1773	$self->{term}->ungrab;
1583	}	1774	}
1584		1775
1585	=back	1776	=back
		1777
		1778	=cut
		1779
		1780	package urxvt::watcher;
		1781
		1782	@urxvt::timer::ISA = __PACKAGE__;
		1783	@urxvt::iow::ISA = __PACKAGE__;
		1784	@urxvt::pw::ISA = __PACKAGE__;
		1785	@urxvt::iw::ISA = __PACKAGE__;
1586		1786
1587	=head2 The C<urxvt::timer> Class	1787	=head2 The C<urxvt::timer> Class
1588		1788
1589	This class implements timer watchers/events. Time is represented as a	1789	This class implements timer watchers/events. Time is represented as a
1590	fractional number of seconds since the epoch. Example:	1790	fractional number of seconds since the epoch. Example:
…		…
1628	Start the timer.	1828	Start the timer.
1629		1829
1630	=item $timer = $timer->start ($tstamp)	1830	=item $timer = $timer->start ($tstamp)
1631		1831
1632	Set the event trigger time to C<$tstamp> and start the timer.	1832	Set the event trigger time to C<$tstamp> and start the timer.
		1833
		1834	=item $timer = $timer->after ($delay)
		1835
		1836	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1633		1837
1634	=item $timer = $timer->stop	1838	=item $timer = $timer->stop
1635		1839
1636	Stop the timer.	1840	Stop the timer.
1637		1841
…		…
1684		1888
1685	Stop watching for events on the given filehandle.	1889	Stop watching for events on the given filehandle.
1686		1890
1687	=back	1891	=back
1688		1892
		1893	=head2 The C<urxvt::iw> Class
		1894
		1895	This class implements idle watchers, that get called automatically when
		1896	the process is idle. They should return as fast as possible, after doing
		1897	some useful work.
		1898
		1899	=over 4
		1900
		1901	=item $iw = new urxvt::iw
		1902
		1903	Create a new idle watcher object in stopped state.
		1904
		1905	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1906
		1907	Set the callback to be called when the watcher triggers.
		1908
		1909	=item $timer = $timer->start
		1910
		1911	Start the watcher.
		1912
		1913	=item $timer = $timer->stop
		1914
		1915	Stop the watcher.
		1916
		1917	=back
		1918
		1919	=head2 The C<urxvt::pw> Class
		1920
		1921	This class implements process watchers. They create an event whenever a
		1922	process exits, after which they stop automatically.
		1923
		1924	my $pid = fork;
		1925	...
		1926	$term->{pw} = urxvt::pw
		1927	->new
		1928	->start ($pid)
		1929	->cb (sub {
		1930	my ($pw, $exit_status) = @_;
		1931	...
		1932	});
		1933
		1934	=over 4
		1935
		1936	=item $pw = new urxvt::pw
		1937
		1938	Create a new process watcher in stopped state.
		1939
		1940	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1941
		1942	Set the callback to be called when the timer triggers.
		1943
		1944	=item $pw = $timer->start ($pid)
		1945
		1946	Tells the wqtcher to start watching for process C<$pid>.
		1947
		1948	=item $pw = $pw->stop
		1949
		1950	Stop the watcher.
		1951
		1952	=back
		1953
1689	=head1 ENVIRONMENT	1954	=head1 ENVIRONMENT
1690		1955
1691	=head2 URXVT_PERL_VERBOSITY	1956	=head2 URXVT_PERL_VERBOSITY
1692		1957
1693	This variable controls the verbosity level of the perl extension. Higher	1958	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.98 by root, Tue Jan 17 17:01:54 2006 UTC vs. Revision 1.125 by root, Sun Jan 22 20:39:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC vs.
Revision 1.125 by root, Sun Jan 22 20:39:47 2006 UTC