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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC vs.
Revision 1.124 by root, Sun Jan 22 11:57:06 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)
…		…
122	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
123	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
124	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
125	selection.	130	selection.
126		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 mouse is on the same (multi-row-) line as the text cursor.
		145
		146	=item - the primary screen is currently being displayed.
		147
		148	=item - the text cursor is visible.
		149
		150	=back
		151
		152	The normal selection mechanism isn't disabled, so quick successive clicks
		153	might interfere with selection creation in harmless ways.
		154
127	=item selection-autotransform	155	=item selection-autotransform
128		156
129	This selection allows you to do automatic transforms on a selection	157	This selection allows you to do automatic transforms on a selection
130	whenever a selection is made.	158	whenever a selection is made.
131		159
…		…
143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	171	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144		172
145	And this example matches the same,but replaces it with vi-commands you can	173	And this example matches the same,but replaces it with vi-commands you can
146	paste directly into your (vi :) editor:	174	paste directly into your (vi :) editor:
147		175
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	176	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149		177
150	Of course, this can be modified to suit your needs and your editor :)	178	Of course, this can be modified to suit your needs and your editor :)
151		179
152	To expand the example above to typical perl error messages ("XXX at	180	To expand the example above to typical perl error messages ("XXX at
153	FILENAME line YYY."), you need a slightly more elaborate solution:	181	FILENAME line YYY."), you need a slightly more elaborate solution:
154		182
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	183	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	184	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157		185
158	The first line tells the selection code to treat the unchanging part of	186	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	187	every error message as a selection pattern, and the second line transforms
160	the message into vi commands to load the file.	188	the message into vi commands to load the file.
		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
166	resource C<urlLauncher> (default C<x-www-browser>) will be started with	205	resource C<urlLauncher> (default C<x-www-browser>) will be started with
167	the URL as first argument.	206	the URL as first argument.
		207
		208	=item automove-background
		209
		210	This is basically a one-line extension that dynamically changes the background pixmap offset
		211	to the window position, in effect creating the same effect as pseudo transparency with
		212	a custom pixmap. No scaling is supported in this mode. Exmaple:
		213
		214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
168		215
169	=item block-graphics-to-ascii	216	=item block-graphics-to-ascii
170		217
171	A not very useful example of filtering all text output to the terminal,	218	A not very useful example of filtering all text output to the terminal,
172	by replacing all line-drawing characters (U+2500 .. U+259F) by a	219	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
290	called whenever the relevant event happens.	337	called whenever the relevant event happens.
291		338
292	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
293	the in the C<Extension Objects> section.	340	the in the C<Extension Objects> section.
294		341
295	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
296	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
297	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.
298		345
299	I<< When in doubt, return a false value (preferably C<()>). >>	346	I<< When in doubt, return a false value (preferably C<()>). >>
300		347
301	=over 4	348	=over 4
302		349
303	=item on_init $term	350	=item on_init $term
304		351
305	Called after a new terminal object has been initialized, but before	352	Called after a new terminal object has been initialized, but before
306	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
307	call or deliver senseless data, as terminal size and other characteristics	354	call or deliver senseless data, as terminal size and other characteristics
308	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
309	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.
310		369
311	=item on_reset $term	370	=item on_reset $term
312		371
313	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
314	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
315	variables.	374	variables.
316		375
317	=item on_start $term	376	=item on_child_start $term, $pid
318		377
319	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.
320	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>.
321		384
322	=item on_sel_make $term, $eventtime	385	=item on_sel_make $term, $eventtime
323		386
324	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
325	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
…		…
436	Called wheneever the window loses keyboard focus, before rxvt-unicode does	499	Called wheneever the window loses keyboard focus, before rxvt-unicode does
437	focus out processing.	500	focus out processing.
438		501
439	=item on_configure_notify $term, $event	502	=item on_configure_notify $term, $event
440		503
		504	=item on_property_notify $term, $event
		505
441	=item on_key_press $term, $event, $keysym, $octets	506	=item on_key_press $term, $event, $keysym, $octets
442		507
443	=item on_key_release $term, $event, $keysym	508	=item on_key_release $term, $event, $keysym
444		509
445	=item on_button_press $term, $event	510	=item on_button_press $term, $event
…		…
454		519
455	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
456	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.
457		522
458	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
459	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
460	and column under the mouse cursor.	525	(real, not screen-based) row and column under the mouse cursor.
461		526
462	C<on_key_press> additionally receives the string rxvt-unicode would	527	C<on_key_press> additionally receives the string rxvt-unicode would
463	output, if any, in locale-specific encoding.	528	output, if any, in locale-specific encoding.
464		529
465	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).
466		540
467	=back	541	=back
468		542
469	=cut	543	=cut
470		544
…		…
476	use Scalar::Util ();	550	use Scalar::Util ();
477	use List::Util ();	551	use List::Util ();
478		552
479	our $VERSION = 1;	553	our $VERSION = 1;
480	our $TERM;	554	our $TERM;
		555	our @TERM_INIT;
		556	our @TERM_EXT;
481	our @HOOKNAME;	557	our @HOOKNAME;
482	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	558	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
483	our %OPTION;	559	our %OPTION;
484		560
485	our $LIBDIR;	561	our $LIBDIR;
486	our $RESNAME;	562	our $RESNAME;
487	our $RESCLASS;	563	our $RESCLASS;
488	our $RXVTNAME;	564	our $RXVTNAME;
489		565
		566	our $NOCHAR = chr 0xffff;
		567
490	=head2 Variables in the C<urxvt> Package	568	=head2 Variables in the C<urxvt> Package
491		569
492	=over 4	570	=over 4
493		571
494	=item $urxvt::LIBDIR	572	=item $urxvt::LIBDIR
…		…
506		584
507	=item $urxvt::TERM	585	=item $urxvt::TERM
508		586
509	The current terminal. This variable stores the current C<urxvt::term>	587	The current terminal. This variable stores the current C<urxvt::term>
510	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>.
511		605
512	=back	606	=back
513		607
514	=head2 Functions in the C<urxvt> Package	608	=head2 Functions in the C<urxvt> Package
515		609
…		…
622	my $msg = join "", @_;	716	my $msg = join "", @_;
623	$msg .= "\n"	717	$msg .= "\n"
624	unless $msg =~ /\n$/;	718	unless $msg =~ /\n$/;
625	urxvt::warn ($msg);	719	urxvt::warn ($msg);
626	};	720	};
627
628	# %ENV is the original startup environment
629	delete $ENV{IFS};
630	delete $ENV{CDPATH};
631	delete $ENV{BASH_ENV};
632	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
633	}	721	}
		722
		723	no warnings 'utf8';
634		724
635	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	725	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
636		726
637	sub verbose {	727	sub verbose {
638	my ($level, $msg) = @_;	728	my ($level, $msg) = @_;
…		…
642	my %extension_pkg;	732	my %extension_pkg;
643		733
644	# load a single script into its own package, once only	734	# load a single script into its own package, once only
645	sub extension_package($) {	735	sub extension_package($) {
646	my ($path) = @_;	736	my ($path) = @_;
647
648	no strict 'refs';
649		737
650	$extension_pkg{$path} \|\|= do {	738	$extension_pkg{$path} \|\|= do {
651	$path =~ /([^\/\\]+)$/;	739	$path =~ /([^\/\\]+)$/;
652	my $pkg = $1;	740	my $pkg = $1;
653	$pkg =~ s/[^[:word:]]/_/g;	741	$pkg =~ s/[^[:word:]]/_/g;
…		…
656	verbose 3, "loading extension '$path' into package '$pkg'";	744	verbose 3, "loading extension '$path' into package '$pkg'";
657		745
658	open my $fh, "<:raw", $path	746	open my $fh, "<:raw", $path
659	or die "$path: $!";	747	or die "$path: $!";
660		748
661	@{"$pkg\::ISA"} = urxvt::term::extension::;
662
663	my $source =	749	my $source =
664	"package $pkg; use strict; use utf8;\n"	750	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
665	. "#line 1 \"$path\"\n{\n"	751	. "#line 1 \"$path\"\n{\n"
666	. (do { local $/; <$fh> })	752	. (do { local $/; <$fh> })
667	. "\n};\n1";	753	. "\n};\n1";
668		754
669	eval $source	755	eval $source
…		…
683	if ($htype == 0) { # INIT	769	if ($htype == 0) { # INIT
684	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	770	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
685		771
686	my %ext_arg;	772	my %ext_arg;
687		773
		774	{
		775	my @init = @TERM_INIT;
		776	@TERM_INIT = ();
		777	$_->($TERM) for @init;
		778	my @pkg = @TERM_EXT;
		779	@TERM_EXT = ();
		780	$TERM->register_package ($_) for @pkg;
		781	}
		782
688	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	783	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
689	if ($_ eq "default") {	784	if ($_ eq "default") {
690	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	785	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
691	} elsif (/^-(.*)$/) {	786	} elsif (/^-(.*)$/) {
692	delete $ext_arg{$1};	787	delete $ext_arg{$1};
693	} elsif (/^([^<]+)<(.*)>$/) {	788	} elsif (/^([^<]+)<(.*)>$/) {
694	push @{ $ext_arg{$1} }, $2;	789	push @{ $ext_arg{$1} }, $2;
695	} else {	790	} else {
…		…
718	if $verbosity >= 10;	813	if $verbosity >= 10;
719		814
720	keys %$cb;	815	keys %$cb;
721		816
722	while (my ($pkg, $cb) = each %$cb) {	817	while (my ($pkg, $cb) = each %$cb) {
723	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	818	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
724	and last;	819	$retval \|\|= $retval_;
725		820
726	if ($@) {	821	if ($@) {
727	$TERM->ungrab; # better to lose the grab than the session	822	$TERM->ungrab; # better to lose the grab than the session
728	warn $@;	823	warn $@;
729	}	824	}
…		…
740	# clear package	835	# clear package
741	%$TERM = ();	836	%$TERM = ();
742	}	837	}
743		838
744	$retval	839	$retval
745	}
746
747	sub exec_async(@) {
748	my $pid = fork;
749
750	return
751	if !defined $pid or $pid;
752
753	%ENV = %{ $TERM->env };
754
755	exec @_;
756	_exit 255;
757	}	840	}
758		841
759	# urxvt::term::extension	842	# urxvt::term::extension
760		843
761	package urxvt::term::extension;	844	package urxvt::term::extension;
…		…
900	# find on_xxx subs in the package and register them	983	# find on_xxx subs in the package and register them
901	# as hooks	984	# as hooks
902	sub register_package {	985	sub register_package {
903	my ($self, $pkg, $argv) = @_;	986	my ($self, $pkg, $argv) = @_;
904		987
		988	no strict 'refs';
		989
		990	urxvt::verbose 6, "register package $pkg to $self";
		991
		992	@{"$pkg\::ISA"} = urxvt::term::extension::;
		993
905	my $proxy = bless {	994	my $proxy = bless {
906	_pkg => $pkg,	995	_pkg => $pkg,
907	argv => $argv,	996	argv => $argv,
908	}, $pkg;	997	}, $pkg;
909	Scalar::Util::weaken ($proxy->{term} = $self);	998	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
940		1029
941	Destroy the terminal object (close the window, free resources	1030	Destroy the terminal object (close the window, free resources
942	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1031	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
943	watchers (timers, io watchers) are still active.	1032	watchers (timers, io watchers) are still active.
944		1033
		1034	=item $term->exec_async ($cmd[, @args])
		1035
		1036	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1037	("starts") programs in the background. This function takes care of setting
		1038	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1039	be preferred over explicit calls to C<exec> or C<system>.
		1040
		1041	Returns the pid of the subprocess or C<undef> on error.
		1042
		1043	=cut
		1044
		1045	sub exec_async {
		1046	my $self = shift;
		1047
		1048	my $pid = fork;
		1049
		1050	return $pid
		1051	if !defined $pid or $pid;
		1052
		1053	%ENV = %{ $self->env };
		1054
		1055	exec @_;
		1056	urxvt::_exit 255;
		1057	}
		1058
945	=item $isset = $term->option ($optval[, $set])	1059	=item $isset = $term->option ($optval[, $set])
946		1060
947	Returns true if the option specified by C<$optval> is enabled, and	1061	Returns true if the option specified by C<$optval> is enabled, and
948	optionally change it. All option values are stored by name in the hash	1062	optionally change it. All option values are stored by name in the hash
949	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1063	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
951	Here is a a likely non-exhaustive list of option names, please see the	1065	Here is a a likely non-exhaustive list of option names, please see the
952	source file F</src/optinc.h> to see the actual list:	1066	source file F</src/optinc.h> to see the actual list:
953		1067
954	borderLess console cursorBlink cursorUnderline hold iconic insecure	1068	borderLess console cursorBlink cursorUnderline hold iconic insecure
955	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1069	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
956	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1070	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
957	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1071	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
958	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1072	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
959	tripleclickwords utmpInhibit visualBell	1073	transparent tripleclickwords utmpInhibit visualBell
960		1074
961	=item $value = $term->resource ($name[, $newval])	1075	=item $value = $term->resource ($name[, $newval])
962		1076
963	Returns the current resource value associated with a given name and	1077	Returns the current resource value associated with a given name and
964	optionally sets a new value. Setting values is most useful in the C<init>	1078	optionally sets a new value. Setting values is most useful in the C<init>
…		…
981		1095
982	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1096	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
983	borderLess color cursorBlink cursorUnderline cutchars delete_key	1097	borderLess color cursorBlink cursorUnderline cutchars delete_key
984	display_name embed ext_bwidth fade font geometry hold iconName	1098	display_name embed ext_bwidth fade font geometry hold iconName
985	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1099	imFont imLocale inputMethod insecure int_bwidth intensityStyles
986	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1100	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
987	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1101	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
988	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1102	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
989	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1103	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
990	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1104	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
991	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1105	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
992	shade term_name title transparent transparent_all tripleclickwords	1106	secondaryScreen secondaryScroll selectstyle shade term_name title
993	utmpInhibit visualBell	1107	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1108	visualBell
994		1109
995	=cut	1110	=cut
996		1111
997	sub resource($$;$) {	1112	sub resource($$;$) {
998	my ($self, $name) = (shift, shift);	1113	my ($self, $name) = (shift, shift);
…		…
1171	string is a normal text string, not in locale-dependent encoding.	1286	string is a normal text string, not in locale-dependent encoding.
1172		1287
1173	Normally its not a good idea to use this function, as programs might be	1288	Normally its not a good idea to use this function, as programs might be
1174	confused by changes in cursor position or scrolling. Its useful inside a	1289	confused by changes in cursor position or scrolling. Its useful inside a
1175	C<on_add_lines> hook, though.	1290	C<on_add_lines> hook, though.
		1291
		1292	=item $term->scr_change_screen ($screen)
		1293
		1294	Switch to given screen - 0 primary, 1 secondary.
1176		1295
1177	=item $term->cmd_parse ($octets)	1296	=item $term->cmd_parse ($octets)
1178		1297
1179	Similar to C<scr_add_lines>, but the argument must be in the	1298	Similar to C<scr_add_lines>, but the argument must be in the
1180	locale-specific encoding of the terminal and can contain command sequences	1299	locale-specific encoding of the terminal and can contain command sequences
…		…
1264	=item $modifiermask = $term->ModNumLockMask	1383	=item $modifiermask = $term->ModNumLockMask
1265		1384
1266	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1385	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1267	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1386	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1268		1387
		1388	=item $screen = $term->current_screen
		1389
		1390	Returns the currently displayed screen (0 primary, 1 secondary).
		1391
		1392	=item $cursor_is_hidden = $term->hidden_cursor
		1393
		1394	Returns wether the cursor is currently hidden or not.
		1395
1269	=item $view_start = $term->view_start ([$newvalue])	1396	=item $view_start = $term->view_start ([$newvalue])
1270		1397
1271	Returns the row number of the topmost displayed line. Maximum value is	1398	Returns the row number of the topmost displayed line. Maximum value is
1272	C<0>, which displays the normal terminal contents. Lower values scroll	1399	C<0>, which displays the normal terminal contents. Lower values scroll
1273	this many lines into the scrollback buffer.	1400	this many lines into the scrollback buffer.
…		…
1292	line, starting at column C<$start_col> (default C<0>), which is useful	1419	line, starting at column C<$start_col> (default C<0>), which is useful
1293	to replace only parts of a line. The font index in the rendition will	1420	to replace only parts of a line. The font index in the rendition will
1294	automatically be updated.	1421	automatically be updated.
1295		1422
1296	C<$text> is in a special encoding: tabs and wide characters that use more	1423	C<$text> is in a special encoding: tabs and wide characters that use more
1297	than one cell when displayed are padded with urxvt::NOCHAR characters	1424	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1298	(C<chr 65535>). Characters with combining characters and other characters	1425	characters. Characters with combining characters and other characters that
1299	that do not fit into the normal tetx encoding will be replaced with	1426	do not fit into the normal tetx encoding will be replaced with characters
1300	characters in the private use area.	1427	in the private use area.
1301		1428
1302	You have to obey this encoding when changing text. The advantage is	1429	You have to obey this encoding when changing text. The advantage is
1303	that C<substr> and similar functions work on screen cells and not on	1430	that C<substr> and similar functions work on screen cells and not on
1304	characters.	1431	characters.
1305		1432
…		…
1480		1607
1481	Calls XUngrab for the most recent grab. Is called automatically on	1608	Calls XUngrab for the most recent grab. Is called automatically on
1482	evaluation errors, as it is better to lose the grab in the error case as	1609	evaluation errors, as it is better to lose the grab in the error case as
1483	the session.	1610	the session.
1484		1611
		1612	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1613
		1614	=item $atom_name = $term->XGetAtomName ($atom)
		1615
		1616	=item @atoms = $term->XListProperties ($window)
		1617
		1618	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1619
		1620	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1621
		1622	=item $term->XDeleteProperty ($window, $property)
		1623
		1624	=item $window = $term->DefaultRootWindow
		1625
		1626	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1627
		1628	=item $term->XMapWindow ($window)
		1629
		1630	=item $term->XUnmapWindow ($window)
		1631
		1632	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1633
		1634	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1635
		1636	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1637
		1638	Various X or X-related functions. The C<$term> object only serves as
		1639	the source of the display, otherwise those functions map more-or-less
		1640	directory onto the X functions of the same name.
		1641
1485	=back	1642	=back
1486		1643
1487	=cut	1644	=cut
1488		1645
1489	package urxvt::popup;	1646	package urxvt::popup;
…		…
1590	my $env = $self->{term}->env;	1747	my $env = $self->{term}->env;
1591	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1748	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1592	delete $env->{LC_ALL};	1749	delete $env->{LC_ALL};
1593	$env->{LC_CTYPE} = $self->{term}->locale;	1750	$env->{LC_CTYPE} = $self->{term}->locale;
1594		1751
1595	urxvt::term->new ($env, $self->{term}->resource ("name"),	1752	urxvt::term->new ($env, "popup",
1596	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1753	"--perl-lib" => "", "--perl-ext-common" => "",
		1754	"-pty-fd" => -1, "-sl" => 0,
		1755	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1597	"--transient-for" => $self->{term}->parent,	1756	"--transient-for" => $self->{term}->parent,
1598	"-display" => $self->{term}->display_id,	1757	"-display" => $self->{term}->display_id,
1599	"-pe" => "urxvt-popup")	1758	"-pe" => "urxvt-popup")
1600	or die "unable to create popup window\n";	1759	or die "unable to create popup window\n";
1601	}	1760	}
…		…
1606	delete $self->{term}{_destroy}{$self};	1765	delete $self->{term}{_destroy}{$self};
1607	$self->{term}->ungrab;	1766	$self->{term}->ungrab;
1608	}	1767	}
1609		1768
1610	=back	1769	=back
		1770
		1771	=cut
		1772
		1773	package urxvt::watcher;
		1774
		1775	@urxvt::timer::ISA = __PACKAGE__;
		1776	@urxvt::iow::ISA = __PACKAGE__;
		1777	@urxvt::pw::ISA = __PACKAGE__;
		1778	@urxvt::iw::ISA = __PACKAGE__;
1611		1779
1612	=head2 The C<urxvt::timer> Class	1780	=head2 The C<urxvt::timer> Class
1613		1781
1614	This class implements timer watchers/events. Time is represented as a	1782	This class implements timer watchers/events. Time is represented as a
1615	fractional number of seconds since the epoch. Example:	1783	fractional number of seconds since the epoch. Example:
…		…
1653	Start the timer.	1821	Start the timer.
1654		1822
1655	=item $timer = $timer->start ($tstamp)	1823	=item $timer = $timer->start ($tstamp)
1656		1824
1657	Set the event trigger time to C<$tstamp> and start the timer.	1825	Set the event trigger time to C<$tstamp> and start the timer.
		1826
		1827	=item $timer = $timer->after ($delay)
		1828
		1829	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1658		1830
1659	=item $timer = $timer->stop	1831	=item $timer = $timer->stop
1660		1832
1661	Stop the timer.	1833	Stop the timer.
1662		1834
…		…
1709		1881
1710	Stop watching for events on the given filehandle.	1882	Stop watching for events on the given filehandle.
1711		1883
1712	=back	1884	=back
1713		1885
		1886	=head2 The C<urxvt::iw> Class
		1887
		1888	This class implements idle watchers, that get called automatically when
		1889	the process is idle. They should return as fast as possible, after doing
		1890	some useful work.
		1891
		1892	=over 4
		1893
		1894	=item $iw = new urxvt::iw
		1895
		1896	Create a new idle watcher object in stopped state.
		1897
		1898	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1899
		1900	Set the callback to be called when the watcher triggers.
		1901
		1902	=item $timer = $timer->start
		1903
		1904	Start the watcher.
		1905
		1906	=item $timer = $timer->stop
		1907
		1908	Stop the watcher.
		1909
		1910	=back
		1911
		1912	=head2 The C<urxvt::pw> Class
		1913
		1914	This class implements process watchers. They create an event whenever a
		1915	process exits, after which they stop automatically.
		1916
		1917	my $pid = fork;
		1918	...
		1919	$term->{pw} = urxvt::pw
		1920	->new
		1921	->start ($pid)
		1922	->cb (sub {
		1923	my ($pw, $exit_status) = @_;
		1924	...
		1925	});
		1926
		1927	=over 4
		1928
		1929	=item $pw = new urxvt::pw
		1930
		1931	Create a new process watcher in stopped state.
		1932
		1933	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1934
		1935	Set the callback to be called when the timer triggers.
		1936
		1937	=item $pw = $timer->start ($pid)
		1938
		1939	Tells the wqtcher to start watching for process C<$pid>.
		1940
		1941	=item $pw = $pw->stop
		1942
		1943	Stop the watcher.
		1944
		1945	=back
		1946
1714	=head1 ENVIRONMENT	1947	=head1 ENVIRONMENT
1715		1948
1716	=head2 URXVT_PERL_VERBOSITY	1949	=head2 URXVT_PERL_VERBOSITY
1717		1950
1718	This variable controls the verbosity level of the perl extension. Higher	1951	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.102 by root, Wed Jan 18 10:31:37 2006 UTC vs. Revision 1.124 by root, Sun Jan 22 11:57:06 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.102 by root, Wed Jan 18 10:31:37 2006 UTC vs.
Revision 1.124 by root, Sun Jan 22 11:57:06 2006 UTC