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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC vs.
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC

…		…
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
…		…
87		91
88	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
89		93
90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91	text into various other formats/action (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	96	evaluation, web-browser starting etc.), depending on content.
93		97
94	Other extensions can extend this popup menu by pushing a code reference onto	98	Other extensions can extend this popup menu by pushing a code reference
95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.	99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
96		101
97	It's sole argument is the popup menu, which can be modified. The selection	102	It's sole argument is the popup menu, which can be modified. The selection
98	is in C<$_>, which can be used to decide wether to add something or not.	103	is in C<$_>, which can be used to decide wether to add something or not.
99	It should either return nothing or a string and a code reference. The	104	It should either return nothing or a string and a code reference. The
100	string will be used as button text and the code reference will be called	105	string will be used as button text and the code reference will be called
…		…
102		107
103	The following will add an entry C<a to b> that transforms all C<a>s in	108	The following will add an entry C<a to b> that transforms all C<a>s in
104	the selection to C<b>s, but only if the selection currently contains any	109	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	110	C<a>s:
106		111
107	push urxvt::ext::selection_popup::hook, sub {	112	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	113	/a/ ? ("a to be" => sub { s/a/b/g }
109	: ()	114	: ()
110	};	115	};
111		116
112	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
…		…
143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144		149
145	And this example matches the same,but replaces it with vi-commands you can	150	And this example matches the same,but replaces it with vi-commands you can
146	paste directly into your (vi :) editor:	151	paste directly into your (vi :) editor:
147		152
148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149		154
150	Of course, this can be modified to suit your needs and your editor :)	155	Of course, this can be modified to suit your needs and your editor :)
151		156
152	To expand the example above to typical perl error messages ("XXX at	157	To expand the example above to typical perl error messages ("XXX at
153	FILENAME line YYY."), you need a slightly more elaborate solution:	158	FILENAME line YYY."), you need a slightly more elaborate solution:
154		159
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157		162
158	The first line tells the selection code to treat the unchanging part of	163	The first line tells the selection code to treat the unchanging part of
159	every error message as a selection pattern, and the second line transforms	164	every error message as a selection pattern, and the second line transforms
160	the message into vi commands to load the file.	165	the message into vi commands to load the file.
		166
		167	=item readline
		168
		169	A support package that tries to make editing with readline easier. At the
		170	moment, it reacts to clicking with the left mouse button by trying to
		171	move the text cursor to this position. It does so by generating as many
		172	cursor-left or cursor-right keypresses as required (the this only works
		173	for programs that correctly support wide characters).
		174
		175	It only works when clicking into the same line (possibly extended over
		176	multiple rows) as the text cursor and on the primary screen, to reduce the
		177	risk of misinterpreting. The normal selection isn't disabled, so quick
		178	successive clicks might interfere with selection creation in harmless
		179	ways.
		180
		181	=item tabbed
		182
		183	This transforms the terminal into a tabbar with additional terminals, that
		184	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		185	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		186	button per tab.
		187
		188	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		189	B<Shift-Right> will switch to the tab left or right of the current one,
		190	while B<Shift-Down> creates a new tab.
161		191
162	=item mark-urls	192	=item mark-urls
163		193
164	Uses per-line display filtering (C<on_line_update>) to underline urls and	194	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	195	make them clickable. When middle-clicked, the program specified in the
166	resource C<urlLauncher> (default C<x-www-browser>) will be started with	196	resource C<urlLauncher> (default C<x-www-browser>) will be started with
167	the URL as first argument.	197	the URL as first argument.
		198
		199	=item automove-background
		200
		201	This is basically a one-line extension that dynamically changes the background pixmap offset
		202	to the window position, in effect creating the same effect as pseudo transparency with
		203	a custom pixmap. No scaling is supported in this mode. Exmaple:
		204
		205	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
168		206
169	=item block-graphics-to-ascii	207	=item block-graphics-to-ascii
170		208
171	A not very useful example of filtering all text output to the terminal,	209	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	210	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
290	called whenever the relevant event happens.	328	called whenever the relevant event happens.
291		329
292	The first argument passed to them is an extension oject as described in	330	The first argument passed to them is an extension oject as described in
293	the in the C<Extension Objects> section.	331	the in the C<Extension Objects> section.
294		332
295	B<All> of these hooks must return a boolean value. If it is true, then the	333	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	334	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.	335	relevant action might not be carried out by the C++ code.
298		336
299	I<< When in doubt, return a false value (preferably C<()>). >>	337	I<< When in doubt, return a false value (preferably C<()>). >>
300		338
301	=over 4	339	=over 4
302		340
303	=item on_init $term	341	=item on_init $term
304		342
305	Called after a new terminal object has been initialized, but before	343	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	344	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	345	call or deliver senseless data, as terminal size and other characteristics
308	have not yet been determined. You can safely query and change resources,	346	have not yet been determined. You can safely query and change resources
309	though.	347	and options, though. For many purposes the C<on_start> hook is a better
		348	place.
		349
		350	=item on_start $term
		351
		352	Called at the very end of initialisation of a new terminal, just before
		353	trying to map (display) the toplevel and returning to the mainloop.
		354
		355	=item on_destroy $term
		356
		357	Called whenever something tries to destroy terminal, before doing anything
		358	yet. If this hook returns true, then destruction is skipped, but this is
		359	rarely a good idea.
310		360
311	=item on_reset $term	361	=item on_reset $term
312		362
313	Called after the screen is "reset" for any reason, such as resizing or	363	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	364	control sequences. Here is where you can react on changes to size-related
315	variables.	365	variables.
316		366
317	=item on_start $term	367	=item on_child_start $term, $pid
318		368
319	Called at the very end of initialisation of a new terminal, just before	369	Called just after the child process has been C<fork>ed.
320	returning to the mainloop.	370
		371	=item on_child_exit $term, $status
		372
		373	Called just after the child process has exited. C<$status> is the status
		374	from C<waitpid>.
321		375
322	=item on_sel_make $term, $eventtime	376	=item on_sel_make $term, $eventtime
323		377
324	Called whenever a selection has been made by the user, but before the	378	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	379	selection text is copied, so changes to the beginning, end or type of the
…		…
434	=item on_focus_out $term	488	=item on_focus_out $term
435		489
436	Called wheneever the window loses keyboard focus, before rxvt-unicode does	490	Called wheneever the window loses keyboard focus, before rxvt-unicode does
437	focus out processing.	491	focus out processing.
438		492
		493	=item on_configure_notify $term, $event
		494
		495	=item on_property_notify $term, $event
		496
439	=item on_key_press $term, $event, $keysym, $octets	497	=item on_key_press $term, $event, $keysym, $octets
440		498
441	=item on_key_release $term, $event, $keysym	499	=item on_key_release $term, $event, $keysym
442		500
443	=item on_button_press $term, $event	501	=item on_button_press $term, $event
…		…
452		510
453	Called whenever the corresponding X event is received for the terminal If	511	Called whenever the corresponding X event is received for the terminal If
454	the hook returns true, then the even will be ignored by rxvt-unicode.	512	the hook returns true, then the even will be ignored by rxvt-unicode.
455		513
456	The event is a hash with most values as named by Xlib (see the XEvent	514	The event is a hash with most values as named by Xlib (see the XEvent
457	manpage), with the additional members C<row> and C<col>, which are the row	515	manpage), with the additional members C<row> and C<col>, which are the
458	and column under the mouse cursor.	516	(real, not screen-based) row and column under the mouse cursor.
459		517
460	C<on_key_press> additionally receives the string rxvt-unicode would	518	C<on_key_press> additionally receives the string rxvt-unicode would
461	output, if any, in locale-specific encoding.	519	output, if any, in locale-specific encoding.
462		520
463	subwindow.	521	subwindow.
		522
		523	=item on_client_message $term, $event
		524
		525	=item on_wm_protocols $term, $event
		526
		527	=item on_wm_delete_window $term, $event
		528
		529	Called when various types of ClientMessage events are received (all with
		530	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
464		531
465	=back	532	=back
466		533
467	=cut	534	=cut
468		535
…		…
474	use Scalar::Util ();	541	use Scalar::Util ();
475	use List::Util ();	542	use List::Util ();
476		543
477	our $VERSION = 1;	544	our $VERSION = 1;
478	our $TERM;	545	our $TERM;
		546	our @TERM_INIT;
		547	our @TERM_EXT;
479	our @HOOKNAME;	548	our @HOOKNAME;
480	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	549	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
481	our %OPTION;	550	our %OPTION;
482		551
483	our $LIBDIR;	552	our $LIBDIR;
484	our $RESNAME;	553	our $RESNAME;
485	our $RESCLASS;	554	our $RESCLASS;
486	our $RXVTNAME;	555	our $RXVTNAME;
487		556
		557	our $NOCHAR = chr 0xfffe;
		558
488	=head2 Variables in the C<urxvt> Package	559	=head2 Variables in the C<urxvt> Package
489		560
490	=over 4	561	=over 4
491		562
492	=item $urxvt::LIBDIR	563	=item $urxvt::LIBDIR
…		…
504		575
505	=item $urxvt::TERM	576	=item $urxvt::TERM
506		577
507	The current terminal. This variable stores the current C<urxvt::term>	578	The current terminal. This variable stores the current C<urxvt::term>
508	object, whenever a callback/hook is executing.	579	object, whenever a callback/hook is executing.
		580
		581	=item @urxvt::TERM_INIT
		582
		583	All coderefs in this array will be called as methods of the next newly
		584	created C<urxvt::term> object (during the C<on_init> phase). The array
		585	gets cleared before the codereferences that were in it are being executed,
		586	so coderefs can push themselves onto it again if they so desire.
		587
		588	This complements to the perl-eval commandline option, but gets executed
		589	first.
		590
		591	=item @urxvt::TERM_EXT
		592
		593	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		594	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		595	but before other extensions. Gets cleared just like C<@TERM_INIT>.
509		596
510	=back	597	=back
511		598
512	=head2 Functions in the C<urxvt> Package	599	=head2 Functions in the C<urxvt> Package
513		600
…		…
620	my $msg = join "", @_;	707	my $msg = join "", @_;
621	$msg .= "\n"	708	$msg .= "\n"
622	unless $msg =~ /\n$/;	709	unless $msg =~ /\n$/;
623	urxvt::warn ($msg);	710	urxvt::warn ($msg);
624	};	711	};
625
626	# %ENV is the original startup environment
627	delete $ENV{IFS};
628	delete $ENV{CDPATH};
629	delete $ENV{BASH_ENV};
630	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
631	}	712	}
632		713
633	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	714	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
634		715
635	sub verbose {	716	sub verbose {
…		…
640	my %extension_pkg;	721	my %extension_pkg;
641		722
642	# load a single script into its own package, once only	723	# load a single script into its own package, once only
643	sub extension_package($) {	724	sub extension_package($) {
644	my ($path) = @_;	725	my ($path) = @_;
645
646	no strict 'refs';
647		726
648	$extension_pkg{$path} \|\|= do {	727	$extension_pkg{$path} \|\|= do {
649	$path =~ /([^\/\\]+)$/;	728	$path =~ /([^\/\\]+)$/;
650	my $pkg = $1;	729	my $pkg = $1;
651	$pkg =~ s/[^[:word:]]/_/g;	730	$pkg =~ s/[^[:word:]]/_/g;
…		…
654	verbose 3, "loading extension '$path' into package '$pkg'";	733	verbose 3, "loading extension '$path' into package '$pkg'";
655		734
656	open my $fh, "<:raw", $path	735	open my $fh, "<:raw", $path
657	or die "$path: $!";	736	or die "$path: $!";
658		737
659	@{"$pkg\::ISA"} = urxvt::term::extension::;
660
661	my $source =	738	my $source =
662	"package $pkg; use strict; use utf8;\n"	739	"package $pkg; use strict; use utf8;\n"
663	. "#line 1 \"$path\"\n{\n"	740	. "#line 1 \"$path\"\n{\n"
664	. (do { local $/; <$fh> })	741	. (do { local $/; <$fh> })
665	. "\n};\n1";	742	. "\n};\n1";
…		…
681	if ($htype == 0) { # INIT	758	if ($htype == 0) { # INIT
682	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	759	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
683		760
684	my %ext_arg;	761	my %ext_arg;
685		762
		763	{
		764	my @init = @TERM_INIT;
		765	@TERM_INIT = ();
		766	$_->($TERM) for @init;
		767	my @pkg = @TERM_EXT;
		768	@TERM_EXT = ();
		769	$TERM->register_package ($_) for @pkg;
		770	}
		771
686	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	772	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
687	if ($_ eq "default") {	773	if ($_ eq "default") {
688	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	774	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
689	} elsif (/^-(.*)$/) {	775	} elsif (/^-(.*)$/) {
690	delete $ext_arg{$1};	776	delete $ext_arg{$1};
691	} elsif (/^([^<]+)<(.*)>$/) {	777	} elsif (/^([^<]+)<(.*)>$/) {
…		…
716	if $verbosity >= 10;	802	if $verbosity >= 10;
717		803
718	keys %$cb;	804	keys %$cb;
719		805
720	while (my ($pkg, $cb) = each %$cb) {	806	while (my ($pkg, $cb) = each %$cb) {
721	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	807	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
722	and last;	808	$retval \|\|= $retval_;
723		809
724	if ($@) {	810	if ($@) {
725	$TERM->ungrab; # better to lose the grab than the session	811	$TERM->ungrab; # better to lose the grab than the session
726	warn $@;	812	warn $@;
727	}	813	}
…		…
738	# clear package	824	# clear package
739	%$TERM = ();	825	%$TERM = ();
740	}	826	}
741		827
742	$retval	828	$retval
743	}
744
745	sub exec_async(@) {
746	my $pid = fork;
747
748	return
749	if !defined $pid or $pid;
750
751	%ENV = %{ $TERM->env };
752
753	exec @_;
754	_exit 255;
755	}	829	}
756		830
757	# urxvt::term::extension	831	# urxvt::term::extension
758		832
759	package urxvt::term::extension;	833	package urxvt::term::extension;
…		…
898	# find on_xxx subs in the package and register them	972	# find on_xxx subs in the package and register them
899	# as hooks	973	# as hooks
900	sub register_package {	974	sub register_package {
901	my ($self, $pkg, $argv) = @_;	975	my ($self, $pkg, $argv) = @_;
902		976
		977	no strict 'refs';
		978
		979	urxvt::verbose 6, "register package $pkg to $self";
		980
		981	@{"$pkg\::ISA"} = urxvt::term::extension::;
		982
903	my $proxy = bless {	983	my $proxy = bless {
904	_pkg => $pkg,	984	_pkg => $pkg,
905	argv => $argv,	985	argv => $argv,
906	}, $pkg;	986	}, $pkg;
907	Scalar::Util::weaken ($proxy->{term} = $self);	987	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
938		1018
939	Destroy the terminal object (close the window, free resources	1019	Destroy the terminal object (close the window, free resources
940	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1020	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
941	watchers (timers, io watchers) are still active.	1021	watchers (timers, io watchers) are still active.
942		1022
		1023	=item $term->exec_async ($cmd[, @args])
		1024
		1025	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1026	("starts") programs in the background. This function takes care of setting
		1027	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1028	be preferred over explicit calls to C<exec> or C<system>.
		1029
		1030	Returns the pid of the subprocess or C<undef> on error.
		1031
		1032	=cut
		1033
		1034	sub exec_async {
		1035	my $self = shift;
		1036
		1037	my $pid = fork;
		1038
		1039	return $pid
		1040	if !defined $pid or $pid;
		1041
		1042	%ENV = %{ $self->env };
		1043
		1044	exec @_;
		1045	urxvt::_exit 255;
		1046	}
		1047
943	=item $isset = $term->option ($optval[, $set])	1048	=item $isset = $term->option ($optval[, $set])
944		1049
945	Returns true if the option specified by C<$optval> is enabled, and	1050	Returns true if the option specified by C<$optval> is enabled, and
946	optionally change it. All option values are stored by name in the hash	1051	optionally change it. All option values are stored by name in the hash
947	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1052	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
949	Here is a a likely non-exhaustive list of option names, please see the	1054	Here is a a likely non-exhaustive list of option names, please see the
950	source file F</src/optinc.h> to see the actual list:	1055	source file F</src/optinc.h> to see the actual list:
951		1056
952	borderLess console cursorBlink cursorUnderline hold iconic insecure	1057	borderLess console cursorBlink cursorUnderline hold iconic insecure
953	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1058	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
954	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1059	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
955	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1060	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
956	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1061	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
957	tripleclickwords utmpInhibit visualBell	1062	transparent tripleclickwords utmpInhibit visualBell
958		1063
959	=item $value = $term->resource ($name[, $newval])	1064	=item $value = $term->resource ($name[, $newval])
960		1065
961	Returns the current resource value associated with a given name and	1066	Returns the current resource value associated with a given name and
962	optionally sets a new value. Setting values is most useful in the C<init>	1067	optionally sets a new value. Setting values is most useful in the C<init>
…		…
979		1084
980	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1085	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
981	borderLess color cursorBlink cursorUnderline cutchars delete_key	1086	borderLess color cursorBlink cursorUnderline cutchars delete_key
982	display_name embed ext_bwidth fade font geometry hold iconName	1087	display_name embed ext_bwidth fade font geometry hold iconName
983	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1088	imFont imLocale inputMethod insecure int_bwidth intensityStyles
984	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1089	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
985	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1090	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
986	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1091	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
987	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1092	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
988	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1093	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
989	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1094	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
990	shade term_name title transparent transparent_all tripleclickwords	1095	secondaryScreen secondaryScroll selectstyle shade term_name title
991	utmpInhibit visualBell	1096	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1097	visualBell
992		1098
993	=cut	1099	=cut
994		1100
995	sub resource($$;$) {	1101	sub resource($$;$) {
996	my ($self, $name) = (shift, shift);	1102	my ($self, $name) = (shift, shift);
…		…
1169	string is a normal text string, not in locale-dependent encoding.	1275	string is a normal text string, not in locale-dependent encoding.
1170		1276
1171	Normally its not a good idea to use this function, as programs might be	1277	Normally its not a good idea to use this function, as programs might be
1172	confused by changes in cursor position or scrolling. Its useful inside a	1278	confused by changes in cursor position or scrolling. Its useful inside a
1173	C<on_add_lines> hook, though.	1279	C<on_add_lines> hook, though.
		1280
		1281	=item $term->scr_change_screen ($screen)
		1282
		1283	Switch to given screen - 0 primary, 1 secondary.
1174		1284
1175	=item $term->cmd_parse ($octets)	1285	=item $term->cmd_parse ($octets)
1176		1286
1177	Similar to C<scr_add_lines>, but the argument must be in the	1287	Similar to C<scr_add_lines>, but the argument must be in the
1178	locale-specific encoding of the terminal and can contain command sequences	1288	locale-specific encoding of the terminal and can contain command sequences
…		…
1262	=item $modifiermask = $term->ModNumLockMask	1372	=item $modifiermask = $term->ModNumLockMask
1263		1373
1264	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1374	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1265	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1375	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1266		1376
		1377	=item $screen = $term->current_screen
		1378
		1379	Returns the currently displayed screen (0 primary, 1 secondary).
		1380
1267	=item $view_start = $term->view_start ([$newvalue])	1381	=item $view_start = $term->view_start ([$newvalue])
1268		1382
1269	Returns the row number of the topmost displayed line. Maximum value is	1383	Returns the row number of the topmost displayed line. Maximum value is
1270	C<0>, which displays the normal terminal contents. Lower values scroll	1384	C<0>, which displays the normal terminal contents. Lower values scroll
1271	this many lines into the scrollback buffer.	1385	this many lines into the scrollback buffer.
…		…
1289	If C<$new_text> is specified, it will replace characters in the current	1403	If C<$new_text> is specified, it will replace characters in the current
1290	line, starting at column C<$start_col> (default C<0>), which is useful	1404	line, starting at column C<$start_col> (default C<0>), which is useful
1291	to replace only parts of a line. The font index in the rendition will	1405	to replace only parts of a line. The font index in the rendition will
1292	automatically be updated.	1406	automatically be updated.
1293		1407
1294	C<$text> is in a special encoding: tabs and wide characters that use more	1408	C<$text> is in a special encoding: tabs and wide characters that use
1295	than one cell when displayed are padded with urxvt::NOCHAR characters	1409	more than one cell when displayed are padded with C<$urxvt::NOCHAR>
1296	(C<chr 65535>). Characters with combining characters and other characters	1410	characters. Characters with combining characters and other characters that
1297	that do not fit into the normal tetx encoding will be replaced with	1411	do not fit into the normal tetx encoding will be replaced with characters
1298	characters in the private use area.	1412	in the private use area.
1299		1413
1300	You have to obey this encoding when changing text. The advantage is	1414	You have to obey this encoding when changing text. The advantage is
1301	that C<substr> and similar functions work on screen cells and not on	1415	that C<substr> and similar functions work on screen cells and not on
1302	characters.	1416	characters.
1303		1417
…		…
1478		1592
1479	Calls XUngrab for the most recent grab. Is called automatically on	1593	Calls XUngrab for the most recent grab. Is called automatically on
1480	evaluation errors, as it is better to lose the grab in the error case as	1594	evaluation errors, as it is better to lose the grab in the error case as
1481	the session.	1595	the session.
1482		1596
		1597	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1598
		1599	=item $atom_name = $term->XGetAtomName ($atom)
		1600
		1601	=item @atoms = $term->XListProperties ($window)
		1602
		1603	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1604
		1605	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1606
		1607	=item $term->XDeleteProperty ($window, $property)
		1608
		1609	=item $window = $term->DefaultRootWindow
		1610
		1611	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1612
		1613	=item $term->XMapWindow ($window)
		1614
		1615	=item $term->XUnmapWindow ($window)
		1616
		1617	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1618
		1619	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1620
		1621	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1622
		1623	Various X or X-related functions. The C<$term> object only serves as
		1624	the source of the display, otherwise those functions map more-or-less
		1625	directory onto the X functions of the same name.
		1626
1483	=back	1627	=back
1484		1628
1485	=cut	1629	=cut
1486		1630
1487	package urxvt::popup;	1631	package urxvt::popup;
…		…
1588	my $env = $self->{term}->env;	1732	my $env = $self->{term}->env;
1589	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1733	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1590	delete $env->{LC_ALL};	1734	delete $env->{LC_ALL};
1591	$env->{LC_CTYPE} = $self->{term}->locale;	1735	$env->{LC_CTYPE} = $self->{term}->locale;
1592		1736
1593	urxvt::term->new ($env, $self->{term}->resource ("name"),	1737	urxvt::term->new ($env, "popup",
1594	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1738	"--perl-lib" => "", "--perl-ext-common" => "",
		1739	"-pty-fd" => -1, "-sl" => 0,
		1740	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1595	"--transient-for" => $self->{term}->parent,	1741	"--transient-for" => $self->{term}->parent,
1596	"-display" => $self->{term}->display_id,	1742	"-display" => $self->{term}->display_id,
1597	"-pe" => "urxvt-popup")	1743	"-pe" => "urxvt-popup")
1598	or die "unable to create popup window\n";	1744	or die "unable to create popup window\n";
1599	}	1745	}
…		…
1604	delete $self->{term}{_destroy}{$self};	1750	delete $self->{term}{_destroy}{$self};
1605	$self->{term}->ungrab;	1751	$self->{term}->ungrab;
1606	}	1752	}
1607		1753
1608	=back	1754	=back
		1755
		1756	=cut
		1757
		1758	package urxvt::watcher;
		1759
		1760	@urxvt::timer::ISA = __PACKAGE__;
		1761	@urxvt::iow::ISA = __PACKAGE__;
		1762	@urxvt::pw::ISA = __PACKAGE__;
		1763	@urxvt::iw::ISA = __PACKAGE__;
1609		1764
1610	=head2 The C<urxvt::timer> Class	1765	=head2 The C<urxvt::timer> Class
1611		1766
1612	This class implements timer watchers/events. Time is represented as a	1767	This class implements timer watchers/events. Time is represented as a
1613	fractional number of seconds since the epoch. Example:	1768	fractional number of seconds since the epoch. Example:
…		…
1651	Start the timer.	1806	Start the timer.
1652		1807
1653	=item $timer = $timer->start ($tstamp)	1808	=item $timer = $timer->start ($tstamp)
1654		1809
1655	Set the event trigger time to C<$tstamp> and start the timer.	1810	Set the event trigger time to C<$tstamp> and start the timer.
		1811
		1812	=item $timer = $timer->after ($delay)
		1813
		1814	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1656		1815
1657	=item $timer = $timer->stop	1816	=item $timer = $timer->stop
1658		1817
1659	Stop the timer.	1818	Stop the timer.
1660		1819
…		…
1707		1866
1708	Stop watching for events on the given filehandle.	1867	Stop watching for events on the given filehandle.
1709		1868
1710	=back	1869	=back
1711		1870
		1871	=head2 The C<urxvt::iw> Class
		1872
		1873	This class implements idle watchers, that get called automatically when
		1874	the process is idle. They should return as fast as possible, after doing
		1875	some useful work.
		1876
		1877	=over 4
		1878
		1879	=item $iw = new urxvt::iw
		1880
		1881	Create a new idle watcher object in stopped state.
		1882
		1883	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1884
		1885	Set the callback to be called when the watcher triggers.
		1886
		1887	=item $timer = $timer->start
		1888
		1889	Start the watcher.
		1890
		1891	=item $timer = $timer->stop
		1892
		1893	Stop the watcher.
		1894
		1895	=back
		1896
		1897	=head2 The C<urxvt::pw> Class
		1898
		1899	This class implements process watchers. They create an event whenever a
		1900	process exits, after which they stop automatically.
		1901
		1902	my $pid = fork;
		1903	...
		1904	$term->{pw} = urxvt::pw
		1905	->new
		1906	->start ($pid)
		1907	->cb (sub {
		1908	my ($pw, $exit_status) = @_;
		1909	...
		1910	});
		1911
		1912	=over 4
		1913
		1914	=item $pw = new urxvt::pw
		1915
		1916	Create a new process watcher in stopped state.
		1917
		1918	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1919
		1920	Set the callback to be called when the timer triggers.
		1921
		1922	=item $pw = $timer->start ($pid)
		1923
		1924	Tells the wqtcher to start watching for process C<$pid>.
		1925
		1926	=item $pw = $pw->stop
		1927
		1928	Stop the watcher.
		1929
		1930	=back
		1931
1712	=head1 ENVIRONMENT	1932	=head1 ENVIRONMENT
1713		1933
1714	=head2 URXVT_PERL_VERBOSITY	1934	=head2 URXVT_PERL_VERBOSITY
1715		1935
1716	This variable controls the verbosity level of the perl extension. Higher	1936	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.101 by root, Wed Jan 18 10:11:03 2006 UTC vs. Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC vs.
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC