[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.126 by root, Tue Jan 24 19:14:36 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
…		…
63	the match. For example, the followign adds a regex that matches everything	67	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:	68	between two vertical bars:
65		69
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
67		71
		72	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
		78
68	You can look at the source of the selection extension to see more	79	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	80	interesting uses, such as parsing a line from beginning to end.
70		81
71	This extension also offers following bindable keyboard commands:	82	This extension also offers following bindable keyboard commands:
72		83
…		…
87		98
88	=item selection-popup (enabled by default)	99	=item selection-popup (enabled by default)
89		100
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	101	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	102	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	103	evaluation, web-browser starting etc.), depending on content.
		104
		105	Other extensions can extend this popup menu by pushing a code reference
		106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		107	popup is displayed.
		108
		109	It's sole argument is the popup menu, which can be modified. The selection
		110	is in C<$_>, which can be used to decide wether to add something or not.
		111	It should either return nothing or a string and a code reference. The
		112	string will be used as button text and the code reference will be called
		113	when the button gets activated and should transform C<$_>.
		114
		115	The following will add an entry C<a to b> that transforms all C<a>s in
		116	the selection to C<b>s, but only if the selection currently contains any
		117	C<a>s:
		118
		119	push @{ $self->{term}{selection_popup_hook} }, sub {
		120	/a/ ? ("a to be" => sub { s/a/b/g }
		121	: ()
		122	};
93		123
94	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
95		125
96	Adds regex search functionality to the scrollback buffer, triggered	126	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	127	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	134	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	135	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	136	additionally stores the first match in the current line into the primary
107	selection.	137	selection.
108		138
		139	=item readline (enabled by default)
		140
		141	A support package that tries to make editing with readline easier. At the
		142	moment, it reacts to clicking with the left mouse button by trying to
		143	move the text cursor to this position. It does so by generating as many
		144	cursor-left or cursor-right keypresses as required (the this only works
		145	for programs that correctly support wide characters).
		146
		147	To avoid too many false positives, this is only done when:
		148
		149	=over 4
		150
		151	=item - the tty is in ICANON state.
		152
		153	=item - the text cursor is visible.
		154
		155	=item - the primary screen is currently being displayed.
		156
		157	=item - the mouse is on the same (multi-row-) line as the text cursor.
		158
		159	=back
		160
		161	The normal selection mechanism isn't disabled, so quick successive clicks
		162	might interfere with selection creation in harmless ways.
		163
109	=item selection-autotransform	164	=item selection-autotransform
110		165
111	This selection allows you to do automatic transforms on a selection	166	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	167	whenever a selection is made.
113		168
…		…
125	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		181
127	And this example matches the same,but replaces it with vi-commands you can	182	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	183	paste directly into your (vi :) editor:
129		184
130	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		186
132	Of course, this can be modified to suit your needs and your editor :)	187	Of course, this can be modified to suit your needs and your editor :)
133		188
134	To expand the example above to typical perl error messages ("XXX at	189	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:	190	FILENAME line YYY."), you need a slightly more elaborate solution:
136		191
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139		194
140	The first line tells the selection code to treat the unchanging part of	195	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	196	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.	197	the message into vi commands to load the file.
		198
		199	=item tabbed
		200
		201	This transforms the terminal into a tabbar with additional terminals, that
		202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		204	button per tab.
		205
		206	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		207	B<Shift-Right> will switch to the tab left or right of the current one,
		208	while B<Shift-Down> creates a new tab.
143		209
144	=item mark-urls	210	=item mark-urls
145		211
146	Uses per-line display filtering (C<on_line_update>) to underline urls and	212	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	213	make them clickable. When middle-clicked, the program specified in the
148	resource C<urlLauncher> (default C<x-www-browser>) will be started with	214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
149	the URL as first argument.	215	the URL as first argument.
150		216
		217	=item automove-background
		218
		219	This is basically a one-line extension that dynamically changes the background pixmap offset
		220	to the window position, in effect creating the same effect as pseudo transparency with
		221	a custom pixmap. No scaling is supported in this mode. Exmaple:
		222
		223	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		224
151	=item block-graphics-to-ascii	225	=item block-graphics-to-ascii
152		226
153	A not very useful example of filtering all text output to the terminal,	227	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	228	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.	229	similar-looking ascii character.
…		…
165	overlays or changes.	239	overlays or changes.
166		240
167	=item selection-pastebin	241	=item selection-pastebin
168		242
169	This is a little rarely useful extension that Uploads the selection as	243	This is a little rarely useful extension that Uploads the selection as
170	textfile to a remote site (or does other things).	244	textfile to a remote site (or does other things). (The implementation is
		245	not currently secure for use in a multiuser environment as it writes to
		246	F</tmp> directly.).
171		247
172	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	248	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
173	i.e.	249	i.e.
174		250
175	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin	251	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
…		…
270	called whenever the relevant event happens.	346	called whenever the relevant event happens.
271		347
272	The first argument passed to them is an extension oject as described in	348	The first argument passed to them is an extension oject as described in
273	the in the C<Extension Objects> section.	349	the in the C<Extension Objects> section.
274		350
275	B<All> of these hooks must return a boolean value. If it is true, then the	351	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	352	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.	353	relevant action might not be carried out by the C++ code.
278		354
279	I<< When in doubt, return a false value (preferably C<()>). >>	355	I<< When in doubt, return a false value (preferably C<()>). >>
280		356
281	=over 4	357	=over 4
282		358
283	=item on_init $term	359	=item on_init $term
284		360
285	Called after a new terminal object has been initialized, but before	361	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	362	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	363	call or deliver senseless data, as terminal size and other characteristics
288	have not yet been determined. You can safely query and change resources,	364	have not yet been determined. You can safely query and change resources
289	though.	365	and options, though. For many purposes the C<on_start> hook is a better
		366	place.
		367
		368	=item on_start $term
		369
		370	Called at the very end of initialisation of a new terminal, just before
		371	trying to map (display) the toplevel and returning to the mainloop.
		372
		373	=item on_destroy $term
		374
		375	Called whenever something tries to destroy terminal, before doing anything
		376	yet. If this hook returns true, then destruction is skipped, but this is
		377	rarely a good idea.
290		378
291	=item on_reset $term	379	=item on_reset $term
292		380
293	Called after the screen is "reset" for any reason, such as resizing or	381	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	382	control sequences. Here is where you can react on changes to size-related
295	variables.	383	variables.
296		384
297	=item on_start $term	385	=item on_child_start $term, $pid
298		386
299	Called at the very end of initialisation of a new terminal, just before	387	Called just after the child process has been C<fork>ed.
300	returning to the mainloop.	388
		389	=item on_child_exit $term, $status
		390
		391	Called just after the child process has exited. C<$status> is the status
		392	from C<waitpid>.
301		393
302	=item on_sel_make $term, $eventtime	394	=item on_sel_make $term, $eventtime
303		395
304	Called whenever a selection has been made by the user, but before the	396	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	397	selection text is copied, so changes to the beginning, end or type of the
…		…
414	=item on_focus_out $term	506	=item on_focus_out $term
415		507
416	Called wheneever the window loses keyboard focus, before rxvt-unicode does	508	Called wheneever the window loses keyboard focus, before rxvt-unicode does
417	focus out processing.	509	focus out processing.
418		510
		511	=item on_configure_notify $term, $event
		512
		513	=item on_property_notify $term, $event
		514
419	=item on_key_press $term, $event, $keysym, $octets	515	=item on_key_press $term, $event, $keysym, $octets
420		516
421	=item on_key_release $term, $event, $keysym	517	=item on_key_release $term, $event, $keysym
422		518
423	=item on_button_press $term, $event	519	=item on_button_press $term, $event
…		…
432		528
433	Called whenever the corresponding X event is received for the terminal If	529	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.	530	the hook returns true, then the even will be ignored by rxvt-unicode.
435		531
436	The event is a hash with most values as named by Xlib (see the XEvent	532	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	533	manpage), with the additional members C<row> and C<col>, which are the
438	and column under the mouse cursor.	534	(real, not screen-based) row and column under the mouse cursor.
439		535
440	C<on_key_press> additionally receives the string rxvt-unicode would	536	C<on_key_press> additionally receives the string rxvt-unicode would
441	output, if any, in locale-specific encoding.	537	output, if any, in locale-specific encoding.
442		538
443	subwindow.	539	subwindow.
		540
		541	=item on_client_message $term, $event
		542
		543	=item on_wm_protocols $term, $event
		544
		545	=item on_wm_delete_window $term, $event
		546
		547	Called when various types of ClientMessage events are received (all with
		548	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
444		549
445	=back	550	=back
446		551
447	=cut	552	=cut
448		553
…		…
454	use Scalar::Util ();	559	use Scalar::Util ();
455	use List::Util ();	560	use List::Util ();
456		561
457	our $VERSION = 1;	562	our $VERSION = 1;
458	our $TERM;	563	our $TERM;
		564	our @TERM_INIT;
		565	our @TERM_EXT;
459	our @HOOKNAME;	566	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	567	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	568	our %OPTION;
462		569
463	our $LIBDIR;	570	our $LIBDIR;
464	our $RESNAME;	571	our $RESNAME;
465	our $RESCLASS;	572	our $RESCLASS;
466	our $RXVTNAME;	573	our $RXVTNAME;
467		574
		575	our $NOCHAR = chr 0xffff;
		576
468	=head2 Variables in the C<urxvt> Package	577	=head2 Variables in the C<urxvt> Package
469		578
470	=over 4	579	=over 4
471		580
472	=item $urxvt::LIBDIR	581	=item $urxvt::LIBDIR
…		…
484		593
485	=item $urxvt::TERM	594	=item $urxvt::TERM
486		595
487	The current terminal. This variable stores the current C<urxvt::term>	596	The current terminal. This variable stores the current C<urxvt::term>
488	object, whenever a callback/hook is executing.	597	object, whenever a callback/hook is executing.
		598
		599	=item @urxvt::TERM_INIT
		600
		601	All coderefs in this array will be called as methods of the next newly
		602	created C<urxvt::term> object (during the C<on_init> phase). The array
		603	gets cleared before the codereferences that were in it are being executed,
		604	so coderefs can push themselves onto it again if they so desire.
		605
		606	This complements to the perl-eval commandline option, but gets executed
		607	first.
		608
		609	=item @urxvt::TERM_EXT
		610
		611	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		612	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		613	but before other extensions. Gets cleared just like C<@TERM_INIT>.
489		614
490	=back	615	=back
491		616
492	=head2 Functions in the C<urxvt> Package	617	=head2 Functions in the C<urxvt> Package
493		618
…		…
593	=back	718	=back
594		719
595	=cut	720	=cut
596		721
597	BEGIN {	722	BEGIN {
598	urxvt->bootstrap;
599
600	# overwrite perl's warn	723	# overwrite perl's warn
601	*CORE::GLOBAL::warn = sub {	724	*CORE::GLOBAL::warn = sub {
602	my $msg = join "", @_;	725	my $msg = join "", @_;
603	$msg .= "\n"	726	$msg .= "\n"
604	unless $msg =~ /\n$/;	727	unless $msg =~ /\n$/;
605	urxvt::warn ($msg);	728	urxvt::warn ($msg);
606	};	729	};
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	}	730	}
		731
		732	no warnings 'utf8';
614		733
615	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	734	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616		735
617	sub verbose {	736	sub verbose {
618	my ($level, $msg) = @_;	737	my ($level, $msg) = @_;
619	warn "$msg\n" if $level <= $verbosity;	738	warn "$msg\n" if $level <= $verbosity;
620	}	739	}
621		740
622	my $extension_pkg = "extension0000";
623	my %extension_pkg;	741	my %extension_pkg;
624		742
625	# load a single script into its own package, once only	743	# load a single script into its own package, once only
626	sub extension_package($) {	744	sub extension_package($) {
627	my ($path) = @_;	745	my ($path) = @_;
628		746
629	$extension_pkg{$path} \|\|= do {	747	$extension_pkg{$path} \|\|= do {
630	my $pkg = "urxvt::" . ($extension_pkg++);	748	$path =~ /([^\/\\]+)$/;
		749	my $pkg = $1;
		750	$pkg =~ s/[^[:word:]]/_/g;
		751	$pkg = "urxvt::ext::$pkg";
631		752
632	verbose 3, "loading extension '$path' into package '$pkg'";	753	verbose 3, "loading extension '$path' into package '$pkg'";
633		754
634	open my $fh, "<:raw", $path	755	open my $fh, "<:raw", $path
635	or die "$path: $!";	756	or die "$path: $!";
636		757
637	my $source =	758	my $source =
638	"package $pkg; use strict; use utf8;\n"	759	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
639	. "use base urxvt::term::extension::;\n"
640	. "#line 1 \"$path\"\n{\n"	760	. "#line 1 \"$path\"\n{\n"
641	. (do { local $/; <$fh> })	761	. (do { local $/; <$fh> })
642	. "\n};\n1";	762	. "\n};\n1";
643		763
644	eval $source	764	eval $source
…		…
658	if ($htype == 0) { # INIT	778	if ($htype == 0) { # INIT
659	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	779	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
660		780
661	my %ext_arg;	781	my %ext_arg;
662		782
		783	{
		784	my @init = @TERM_INIT;
		785	@TERM_INIT = ();
		786	$_->($TERM) for @init;
		787	my @pkg = @TERM_EXT;
		788	@TERM_EXT = ();
		789	$TERM->register_package ($_) for @pkg;
		790	}
		791
663	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	792	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
664	if ($_ eq "default") {	793	if ($_ eq "default") {
665	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	794	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
666	} elsif (/^-(.*)$/) {	795	} elsif (/^-(.*)$/) {
667	delete $ext_arg{$1};	796	delete $ext_arg{$1};
668	} elsif (/^([^<]+)<(.*)>$/) {	797	} elsif (/^([^<]+)<(.*)>$/) {
669	push @{ $ext_arg{$1} }, $2;	798	push @{ $ext_arg{$1} }, $2;
670	} else {	799	} else {
…		…
693	if $verbosity >= 10;	822	if $verbosity >= 10;
694		823
695	keys %$cb;	824	keys %$cb;
696		825
697	while (my ($pkg, $cb) = each %$cb) {	826	while (my ($pkg, $cb) = each %$cb) {
698	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	827	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
699	and last;	828	$retval \|\|= $retval_;
700		829
701	if ($@) {	830	if ($@) {
702	$TERM->ungrab; # better to lose the grab than the session	831	$TERM->ungrab; # better to lose the grab than the session
703	warn $@;	832	warn $@;
704	}	833	}
…		…
715	# clear package	844	# clear package
716	%$TERM = ();	845	%$TERM = ();
717	}	846	}
718		847
719	$retval	848	$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	}	849	}
733		850
734	# urxvt::term::extension	851	# urxvt::term::extension
735		852
736	package urxvt::term::extension;	853	package urxvt::term::extension;
…		…
875	# find on_xxx subs in the package and register them	992	# find on_xxx subs in the package and register them
876	# as hooks	993	# as hooks
877	sub register_package {	994	sub register_package {
878	my ($self, $pkg, $argv) = @_;	995	my ($self, $pkg, $argv) = @_;
879		996
		997	no strict 'refs';
		998
		999	urxvt::verbose 6, "register package $pkg to $self";
		1000
		1001	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1002
880	my $proxy = bless {	1003	my $proxy = bless {
881	_pkg => $pkg,	1004	_pkg => $pkg,
882	argv => $argv,	1005	argv => $argv,
883	}, $pkg;	1006	}, $pkg;
884	Scalar::Util::weaken ($proxy->{term} = $self);	1007	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
915		1038
916	Destroy the terminal object (close the window, free resources	1039	Destroy the terminal object (close the window, free resources
917	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1040	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
918	watchers (timers, io watchers) are still active.	1041	watchers (timers, io watchers) are still active.
919		1042
		1043	=item $term->exec_async ($cmd[, @args])
		1044
		1045	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1046	("starts") programs in the background. This function takes care of setting
		1047	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1048	be preferred over explicit calls to C<exec> or C<system>.
		1049
		1050	Returns the pid of the subprocess or C<undef> on error.
		1051
		1052	=cut
		1053
		1054	sub exec_async {
		1055	my $self = shift;
		1056
		1057	my $pid = fork;
		1058
		1059	return $pid
		1060	if !defined $pid or $pid;
		1061
		1062	%ENV = %{ $self->env };
		1063
		1064	exec @_;
		1065	urxvt::_exit 255;
		1066	}
		1067
920	=item $isset = $term->option ($optval[, $set])	1068	=item $isset = $term->option ($optval[, $set])
921		1069
922	Returns true if the option specified by C<$optval> is enabled, and	1070	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	1071	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.	1072	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	1074	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:	1075	source file F</src/optinc.h> to see the actual list:
928		1076
929	borderLess console cursorBlink cursorUnderline hold iconic insecure	1077	borderLess console cursorBlink cursorUnderline hold iconic insecure
930	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1078	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
931	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1079	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
932	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1080	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
933	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1081	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
934	tripleclickwords utmpInhibit visualBell	1082	transparent tripleclickwords utmpInhibit visualBell
935		1083
936	=item $value = $term->resource ($name[, $newval])	1084	=item $value = $term->resource ($name[, $newval])
937		1085
938	Returns the current resource value associated with a given name and	1086	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>	1087	optionally sets a new value. Setting values is most useful in the C<init>
…		…
956		1104
957	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1105	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
958	borderLess color cursorBlink cursorUnderline cutchars delete_key	1106	borderLess color cursorBlink cursorUnderline cutchars delete_key
959	display_name embed ext_bwidth fade font geometry hold iconName	1107	display_name embed ext_bwidth fade font geometry hold iconName
960	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1108	imFont imLocale inputMethod insecure int_bwidth intensityStyles
961	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1109	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
962	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1110	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
963	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1111	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
964	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1112	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
965	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1113	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
966	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1114	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
967	shade term_name title transparent transparent_all tripleclickwords	1115	secondaryScreen secondaryScroll selectstyle shade term_name title
968	utmpInhibit visualBell	1116	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1117	visualBell
969		1118
970	=cut	1119	=cut
971		1120
972	sub resource($$;$) {	1121	sub resource($$;$) {
973	my ($self, $name) = (shift, shift);	1122	my ($self, $name) = (shift, shift);
…		…
1147		1296
1148	Normally its not a good idea to use this function, as programs might be	1297	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	1298	confused by changes in cursor position or scrolling. Its useful inside a
1150	C<on_add_lines> hook, though.	1299	C<on_add_lines> hook, though.
1151		1300
		1301	=item $term->scr_change_screen ($screen)
		1302
		1303	Switch to given screen - 0 primary, 1 secondary.
		1304
1152	=item $term->cmd_parse ($octets)	1305	=item $term->cmd_parse ($octets)
1153		1306
1154	Similar to C<scr_add_lines>, but the argument must be in the	1307	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	1308	locale-specific encoding of the terminal and can contain command sequences
1156	(escape codes) that will be interpreted.	1309	(escape codes) that will be interpreted.
…		…
1165		1318
1166	Replaces the event mask of the pty watcher by the given event mask. Can	1319	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	1320	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	1321	description of C<< urxvt::timer->events >>. Make sure to always restore
1169	the previous value.	1322	the previous value.
		1323
		1324	=item $fd = $term->pty_fd
		1325
		1326	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1327	is used.
1170		1328
1171	=item $windowid = $term->parent	1329	=item $windowid = $term->parent
1172		1330
1173	Return the window id of the toplevel window.	1331	Return the window id of the toplevel window.
1174		1332
…		…
1239	=item $modifiermask = $term->ModNumLockMask	1397	=item $modifiermask = $term->ModNumLockMask
1240		1398
1241	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1399	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.	1400	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1243		1401
		1402	=item $screen = $term->current_screen
		1403
		1404	Returns the currently displayed screen (0 primary, 1 secondary).
		1405
		1406	=item $cursor_is_hidden = $term->hidden_cursor
		1407
		1408	Returns wether the cursor is currently hidden or not.
		1409
1244	=item $view_start = $term->view_start ([$newvalue])	1410	=item $view_start = $term->view_start ([$newvalue])
1245		1411
1246	Returns the row number of the topmost displayed line. Maximum value is	1412	Returns the row number of the topmost displayed line. Maximum value is
1247	C<0>, which displays the normal terminal contents. Lower values scroll	1413	C<0>, which displays the normal terminal contents. Lower values scroll
1248	this many lines into the scrollback buffer.	1414	this many lines into the scrollback buffer.
…		…
1267	line, starting at column C<$start_col> (default C<0>), which is useful	1433	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	1434	to replace only parts of a line. The font index in the rendition will
1269	automatically be updated.	1435	automatically be updated.
1270		1436
1271	C<$text> is in a special encoding: tabs and wide characters that use more	1437	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	1438	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1273	(C<chr 65535>). Characters with combining characters and other characters	1439	characters. Characters with combining characters and other characters that
1274	that do not fit into the normal tetx encoding will be replaced with	1440	do not fit into the normal tetx encoding will be replaced with characters
1275	characters in the private use area.	1441	in the private use area.
1276		1442
1277	You have to obey this encoding when changing text. The advantage is	1443	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	1444	that C<substr> and similar functions work on screen cells and not on
1279	characters.	1445	characters.
1280		1446
…		…
1455		1621
1456	Calls XUngrab for the most recent grab. Is called automatically on	1622	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	1623	evaluation errors, as it is better to lose the grab in the error case as
1458	the session.	1624	the session.
1459		1625
		1626	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1627
		1628	=item $atom_name = $term->XGetAtomName ($atom)
		1629
		1630	=item @atoms = $term->XListProperties ($window)
		1631
		1632	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1633
		1634	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1635
		1636	=item $term->XDeleteProperty ($window, $property)
		1637
		1638	=item $window = $term->DefaultRootWindow
		1639
		1640	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1641
		1642	=item $term->XMapWindow ($window)
		1643
		1644	=item $term->XUnmapWindow ($window)
		1645
		1646	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1647
		1648	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1649
		1650	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1651
		1652	Various X or X-related functions. The C<$term> object only serves as
		1653	the source of the display, otherwise those functions map more-or-less
		1654	directory onto the X functions of the same name.
		1655
1460	=back	1656	=back
1461		1657
1462	=cut	1658	=cut
1463		1659
1464	package urxvt::popup;	1660	package urxvt::popup;
…		…
1565	my $env = $self->{term}->env;	1761	my $env = $self->{term}->env;
1566	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1762	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1567	delete $env->{LC_ALL};	1763	delete $env->{LC_ALL};
1568	$env->{LC_CTYPE} = $self->{term}->locale;	1764	$env->{LC_CTYPE} = $self->{term}->locale;
1569		1765
1570	urxvt::term->new ($env, $self->{term}->resource ("name"),	1766	urxvt::term->new ($env, "popup",
1571	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1767	"--perl-lib" => "", "--perl-ext-common" => "",
		1768	"-pty-fd" => -1, "-sl" => 0,
		1769	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1572	"--transient-for" => $self->{term}->parent,	1770	"--transient-for" => $self->{term}->parent,
1573	"-display" => $self->{term}->display_id,	1771	"-display" => $self->{term}->display_id,
1574	"-pe" => "urxvt-popup")	1772	"-pe" => "urxvt-popup")
1575	or die "unable to create popup window\n";	1773	or die "unable to create popup window\n";
1576	}	1774	}
…		…
1581	delete $self->{term}{_destroy}{$self};	1779	delete $self->{term}{_destroy}{$self};
1582	$self->{term}->ungrab;	1780	$self->{term}->ungrab;
1583	}	1781	}
1584		1782
1585	=back	1783	=back
		1784
		1785	=cut
		1786
		1787	package urxvt::watcher;
		1788
		1789	@urxvt::timer::ISA = __PACKAGE__;
		1790	@urxvt::iow::ISA = __PACKAGE__;
		1791	@urxvt::pw::ISA = __PACKAGE__;
		1792	@urxvt::iw::ISA = __PACKAGE__;
1586		1793
1587	=head2 The C<urxvt::timer> Class	1794	=head2 The C<urxvt::timer> Class
1588		1795
1589	This class implements timer watchers/events. Time is represented as a	1796	This class implements timer watchers/events. Time is represented as a
1590	fractional number of seconds since the epoch. Example:	1797	fractional number of seconds since the epoch. Example:
…		…
1628	Start the timer.	1835	Start the timer.
1629		1836
1630	=item $timer = $timer->start ($tstamp)	1837	=item $timer = $timer->start ($tstamp)
1631		1838
1632	Set the event trigger time to C<$tstamp> and start the timer.	1839	Set the event trigger time to C<$tstamp> and start the timer.
		1840
		1841	=item $timer = $timer->after ($delay)
		1842
		1843	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1633		1844
1634	=item $timer = $timer->stop	1845	=item $timer = $timer->stop
1635		1846
1636	Stop the timer.	1847	Stop the timer.
1637		1848
…		…
1684		1895
1685	Stop watching for events on the given filehandle.	1896	Stop watching for events on the given filehandle.
1686		1897
1687	=back	1898	=back
1688		1899
		1900	=head2 The C<urxvt::iw> Class
		1901
		1902	This class implements idle watchers, that get called automatically when
		1903	the process is idle. They should return as fast as possible, after doing
		1904	some useful work.
		1905
		1906	=over 4
		1907
		1908	=item $iw = new urxvt::iw
		1909
		1910	Create a new idle watcher object in stopped state.
		1911
		1912	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1913
		1914	Set the callback to be called when the watcher triggers.
		1915
		1916	=item $timer = $timer->start
		1917
		1918	Start the watcher.
		1919
		1920	=item $timer = $timer->stop
		1921
		1922	Stop the watcher.
		1923
		1924	=back
		1925
		1926	=head2 The C<urxvt::pw> Class
		1927
		1928	This class implements process watchers. They create an event whenever a
		1929	process exits, after which they stop automatically.
		1930
		1931	my $pid = fork;
		1932	...
		1933	$term->{pw} = urxvt::pw
		1934	->new
		1935	->start ($pid)
		1936	->cb (sub {
		1937	my ($pw, $exit_status) = @_;
		1938	...
		1939	});
		1940
		1941	=over 4
		1942
		1943	=item $pw = new urxvt::pw
		1944
		1945	Create a new process watcher in stopped state.
		1946
		1947	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1948
		1949	Set the callback to be called when the timer triggers.
		1950
		1951	=item $pw = $timer->start ($pid)
		1952
		1953	Tells the wqtcher to start watching for process C<$pid>.
		1954
		1955	=item $pw = $pw->stop
		1956
		1957	Stop the watcher.
		1958
		1959	=back
		1960
1689	=head1 ENVIRONMENT	1961	=head1 ENVIRONMENT
1690		1962
1691	=head2 URXVT_PERL_VERBOSITY	1963	=head2 URXVT_PERL_VERBOSITY
1692		1964
1693	This variable controls the verbosity level of the perl extension. Higher	1965	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.126 by root, Tue Jan 24 19:14:36 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.126 by root, Tue Jan 24 19:14:36 2006 UTC