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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC vs.
Revision 1.127 by root, Wed Jan 25 00:42:21 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.
93		104
94	Other extensions can extend this popup menu by pushing a code reference onto	105	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.	106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		107	popup is displayed.
96		108
97	It's sole argument is the popup menu, which can be modified. The selection	109	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.	110	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	111	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	112	string will be used as button text and the code reference will be called
…		…
102		114
103	The following will add an entry C<a to b> that transforms all C<a>s in	115	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	116	the selection to C<b>s, but only if the selection currently contains any
105	C<a>s:	117	C<a>s:
106		118
107	push urxvt::ext::selection_popup::hook, sub {	119	push @{ $self->{term}{selection_popup_hook} }, sub {
108	/a/ ? ("a to be" => sub { s/a/b/g }	120	/a/ ? ("a to be" => sub { s/a/b/g }
109	: ()	121	: ()
110	};	122	};
111		123
112	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
…		…
122	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
123	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
124	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
125	selection.	137	selection.
126		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
127	=item selection-autotransform	164	=item selection-autotransform
128		165
129	This selection allows you to do automatic transforms on a selection	166	This selection allows you to do automatic transforms on a selection
130	whenever a selection is made.	167	whenever a selection is made.
131		168
…		…
143	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/
144		181
145	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
146	paste directly into your (vi :) editor:	183	paste directly into your (vi :) editor:
147		184
148	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/
149		186
150	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 :)
151		188
152	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
153	FILENAME line YYY."), you need a slightly more elaborate solution:	190	FILENAME line YYY."), you need a slightly more elaborate solution:
154		191
155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156	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/
157		194
158	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
159	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
160	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.
161		209
162	=item mark-urls	210	=item mark-urls
163		211
164	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
165	make them clickable. When middle-clicked, the program specified in the	213	make them clickable. When middle-clicked, the program specified in the
…		…
298	called whenever the relevant event happens.	346	called whenever the relevant event happens.
299		347
300	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
301	the in the C<Extension Objects> section.	349	the in the C<Extension Objects> section.
302		350
303	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
304	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
305	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.
306		354
307	I<< When in doubt, return a false value (preferably C<()>). >>	355	I<< When in doubt, return a false value (preferably C<()>). >>
308		356
309	=over 4	357	=over 4
310		358
311	=item on_init $term	359	=item on_init $term
312		360
313	Called after a new terminal object has been initialized, but before	361	Called after a new terminal object has been initialized, but before
314	windows are created or the command gets run. Most methods are unsafe to	362	windows are created or the command gets run. Most methods are unsafe to
315	call or deliver senseless data, as terminal size and other characteristics	363	call or deliver senseless data, as terminal size and other characteristics
316	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
317	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, when the terminal is
		376	still fully functional (not for long, though).
318		377
319	=item on_reset $term	378	=item on_reset $term
320		379
321	Called after the screen is "reset" for any reason, such as resizing or	380	Called after the screen is "reset" for any reason, such as resizing or
322	control sequences. Here is where you can react on changes to size-related	381	control sequences. Here is where you can react on changes to size-related
323	variables.	382	variables.
324		383
325	=item on_start $term	384	=item on_child_start $term, $pid
326		385
327	Called at the very end of initialisation of a new terminal, just before	386	Called just after the child process has been C<fork>ed.
328	returning to the mainloop.	387
		388	=item on_child_exit $term, $status
		389
		390	Called just after the child process has exited. C<$status> is the status
		391	from C<waitpid>.
329		392
330	=item on_sel_make $term, $eventtime	393	=item on_sel_make $term, $eventtime
331		394
332	Called whenever a selection has been made by the user, but before the	395	Called whenever a selection has been made by the user, but before the
333	selection text is copied, so changes to the beginning, end or type of the	396	selection text is copied, so changes to the beginning, end or type of the
…		…
444	Called wheneever the window loses keyboard focus, before rxvt-unicode does	507	Called wheneever the window loses keyboard focus, before rxvt-unicode does
445	focus out processing.	508	focus out processing.
446		509
447	=item on_configure_notify $term, $event	510	=item on_configure_notify $term, $event
448		511
		512	=item on_property_notify $term, $event
		513
449	=item on_key_press $term, $event, $keysym, $octets	514	=item on_key_press $term, $event, $keysym, $octets
450		515
451	=item on_key_release $term, $event, $keysym	516	=item on_key_release $term, $event, $keysym
452		517
453	=item on_button_press $term, $event	518	=item on_button_press $term, $event
…		…
462		527
463	Called whenever the corresponding X event is received for the terminal If	528	Called whenever the corresponding X event is received for the terminal If
464	the hook returns true, then the even will be ignored by rxvt-unicode.	529	the hook returns true, then the even will be ignored by rxvt-unicode.
465		530
466	The event is a hash with most values as named by Xlib (see the XEvent	531	The event is a hash with most values as named by Xlib (see the XEvent
467	manpage), with the additional members C<row> and C<col>, which are the row	532	manpage), with the additional members C<row> and C<col>, which are the
468	and column under the mouse cursor.	533	(real, not screen-based) row and column under the mouse cursor.
469		534
470	C<on_key_press> additionally receives the string rxvt-unicode would	535	C<on_key_press> additionally receives the string rxvt-unicode would
471	output, if any, in locale-specific encoding.	536	output, if any, in locale-specific encoding.
472		537
473	subwindow.	538	subwindow.
		539
		540	=item on_client_message $term, $event
		541
		542	=item on_wm_protocols $term, $event
		543
		544	=item on_wm_delete_window $term, $event
		545
		546	Called when various types of ClientMessage events are received (all with
		547	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
474		548
475	=back	549	=back
476		550
477	=cut	551	=cut
478		552
…		…
484	use Scalar::Util ();	558	use Scalar::Util ();
485	use List::Util ();	559	use List::Util ();
486		560
487	our $VERSION = 1;	561	our $VERSION = 1;
488	our $TERM;	562	our $TERM;
		563	our @TERM_INIT;
		564	our @TERM_EXT;
489	our @HOOKNAME;	565	our @HOOKNAME;
490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	566	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491	our %OPTION;	567	our %OPTION;
492		568
493	our $LIBDIR;	569	our $LIBDIR;
494	our $RESNAME;	570	our $RESNAME;
495	our $RESCLASS;	571	our $RESCLASS;
496	our $RXVTNAME;	572	our $RXVTNAME;
497		573
		574	our $NOCHAR = chr 0xffff;
		575
498	=head2 Variables in the C<urxvt> Package	576	=head2 Variables in the C<urxvt> Package
499		577
500	=over 4	578	=over 4
501		579
502	=item $urxvt::LIBDIR	580	=item $urxvt::LIBDIR
…		…
514		592
515	=item $urxvt::TERM	593	=item $urxvt::TERM
516		594
517	The current terminal. This variable stores the current C<urxvt::term>	595	The current terminal. This variable stores the current C<urxvt::term>
518	object, whenever a callback/hook is executing.	596	object, whenever a callback/hook is executing.
		597
		598	=item @urxvt::TERM_INIT
		599
		600	All coderefs in this array will be called as methods of the next newly
		601	created C<urxvt::term> object (during the C<on_init> phase). The array
		602	gets cleared before the codereferences that were in it are being executed,
		603	so coderefs can push themselves onto it again if they so desire.
		604
		605	This complements to the perl-eval commandline option, but gets executed
		606	first.
		607
		608	=item @urxvt::TERM_EXT
		609
		610	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		611	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		612	but before other extensions. Gets cleared just like C<@TERM_INIT>.
519		613
520	=back	614	=back
521		615
522	=head2 Functions in the C<urxvt> Package	616	=head2 Functions in the C<urxvt> Package
523		617
…		…
632	unless $msg =~ /\n$/;	726	unless $msg =~ /\n$/;
633	urxvt::warn ($msg);	727	urxvt::warn ($msg);
634	};	728	};
635	}	729	}
636		730
		731	no warnings 'utf8';
		732
637	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	733	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
638		734
639	sub verbose {	735	sub verbose {
640	my ($level, $msg) = @_;	736	my ($level, $msg) = @_;
641	warn "$msg\n" if $level <= $verbosity;	737	warn "$msg\n" if $level <= $verbosity;
…		…
644	my %extension_pkg;	740	my %extension_pkg;
645		741
646	# load a single script into its own package, once only	742	# load a single script into its own package, once only
647	sub extension_package($) {	743	sub extension_package($) {
648	my ($path) = @_;	744	my ($path) = @_;
649
650	no strict 'refs';
651		745
652	$extension_pkg{$path} \|\|= do {	746	$extension_pkg{$path} \|\|= do {
653	$path =~ /([^\/\\]+)$/;	747	$path =~ /([^\/\\]+)$/;
654	my $pkg = $1;	748	my $pkg = $1;
655	$pkg =~ s/[^[:word:]]/_/g;	749	$pkg =~ s/[^[:word:]]/_/g;
…		…
658	verbose 3, "loading extension '$path' into package '$pkg'";	752	verbose 3, "loading extension '$path' into package '$pkg'";
659		753
660	open my $fh, "<:raw", $path	754	open my $fh, "<:raw", $path
661	or die "$path: $!";	755	or die "$path: $!";
662		756
663	@{"$pkg\::ISA"} = urxvt::term::extension::;
664
665	my $source =	757	my $source =
666	"package $pkg; use strict; use utf8;\n"	758	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
667	. "#line 1 \"$path\"\n{\n"	759	. "#line 1 \"$path\"\n{\n"
668	. (do { local $/; <$fh> })	760	. (do { local $/; <$fh> })
669	. "\n};\n1";	761	. "\n};\n1";
670		762
671	eval $source	763	eval $source
…		…
685	if ($htype == 0) { # INIT	777	if ($htype == 0) { # INIT
686	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	778	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
687		779
688	my %ext_arg;	780	my %ext_arg;
689		781
		782	{
		783	my @init = @TERM_INIT;
		784	@TERM_INIT = ();
		785	$_->($TERM) for @init;
		786	my @pkg = @TERM_EXT;
		787	@TERM_EXT = ();
		788	$TERM->register_package ($_) for @pkg;
		789	}
		790
690	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	791	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
691	if ($_ eq "default") {	792	if ($_ eq "default") {
692	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	793	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
693	} elsif (/^-(.*)$/) {	794	} elsif (/^-(.*)$/) {
694	delete $ext_arg{$1};	795	delete $ext_arg{$1};
695	} elsif (/^([^<]+)<(.*)>$/) {	796	} elsif (/^([^<]+)<(.*)>$/) {
696	push @{ $ext_arg{$1} }, $2;	797	push @{ $ext_arg{$1} }, $2;
697	} else {	798	} else {
…		…
720	if $verbosity >= 10;	821	if $verbosity >= 10;
721		822
722	keys %$cb;	823	keys %$cb;
723		824
724	while (my ($pkg, $cb) = each %$cb) {	825	while (my ($pkg, $cb) = each %$cb) {
725	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	826	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
726	and last;	827	$retval \|\|= $retval_;
727		828
728	if ($@) {	829	if ($@) {
729	$TERM->ungrab; # better to lose the grab than the session	830	$TERM->ungrab; # better to lose the grab than the session
730	warn $@;	831	warn $@;
731	}	832	}
…		…
742	# clear package	843	# clear package
743	%$TERM = ();	844	%$TERM = ();
744	}	845	}
745		846
746	$retval	847	$retval
747	}
748
749	sub exec_async(@) {
750	my $pid = fork;
751
752	return
753	if !defined $pid or $pid;
754
755	%ENV = %{ $TERM->env };
756
757	exec @_;
758	_exit 255;
759	}	848	}
760		849
761	# urxvt::term::extension	850	# urxvt::term::extension
762		851
763	package urxvt::term::extension;	852	package urxvt::term::extension;
…		…
902	# find on_xxx subs in the package and register them	991	# find on_xxx subs in the package and register them
903	# as hooks	992	# as hooks
904	sub register_package {	993	sub register_package {
905	my ($self, $pkg, $argv) = @_;	994	my ($self, $pkg, $argv) = @_;
906		995
		996	no strict 'refs';
		997
		998	urxvt::verbose 6, "register package $pkg to $self";
		999
		1000	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1001
907	my $proxy = bless {	1002	my $proxy = bless {
908	_pkg => $pkg,	1003	_pkg => $pkg,
909	argv => $argv,	1004	argv => $argv,
910	}, $pkg;	1005	}, $pkg;
911	Scalar::Util::weaken ($proxy->{term} = $self);	1006	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
941	=item $term->destroy	1036	=item $term->destroy
942		1037
943	Destroy the terminal object (close the window, free resources	1038	Destroy the terminal object (close the window, free resources
944	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1039	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
945	watchers (timers, io watchers) are still active.	1040	watchers (timers, io watchers) are still active.
		1041
		1042	=item $term->exec_async ($cmd[, @args])
		1043
		1044	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1045	("starts") programs in the background. This function takes care of setting
		1046	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1047	be preferred over explicit calls to C<exec> or C<system>.
		1048
		1049	Returns the pid of the subprocess or C<undef> on error.
		1050
		1051	=cut
		1052
		1053	sub exec_async {
		1054	my $self = shift;
		1055
		1056	my $pid = fork;
		1057
		1058	return $pid
		1059	if !defined $pid or $pid;
		1060
		1061	%ENV = %{ $self->env };
		1062
		1063	exec @_;
		1064	urxvt::_exit 255;
		1065	}
946		1066
947	=item $isset = $term->option ($optval[, $set])	1067	=item $isset = $term->option ($optval[, $set])
948		1068
949	Returns true if the option specified by C<$optval> is enabled, and	1069	Returns true if the option specified by C<$optval> is enabled, and
950	optionally change it. All option values are stored by name in the hash	1070	optionally change it. All option values are stored by name in the hash
…		…
1175		1295
1176	Normally its not a good idea to use this function, as programs might be	1296	Normally its not a good idea to use this function, as programs might be
1177	confused by changes in cursor position or scrolling. Its useful inside a	1297	confused by changes in cursor position or scrolling. Its useful inside a
1178	C<on_add_lines> hook, though.	1298	C<on_add_lines> hook, though.
1179		1299
		1300	=item $term->scr_change_screen ($screen)
		1301
		1302	Switch to given screen - 0 primary, 1 secondary.
		1303
1180	=item $term->cmd_parse ($octets)	1304	=item $term->cmd_parse ($octets)
1181		1305
1182	Similar to C<scr_add_lines>, but the argument must be in the	1306	Similar to C<scr_add_lines>, but the argument must be in the
1183	locale-specific encoding of the terminal and can contain command sequences	1307	locale-specific encoding of the terminal and can contain command sequences
1184	(escape codes) that will be interpreted.	1308	(escape codes) that will be interpreted.
…		…
1193		1317
1194	Replaces the event mask of the pty watcher by the given event mask. Can	1318	Replaces the event mask of the pty watcher by the given event mask. Can
1195	be used to suppress input and output handling to the pty/tty. See the	1319	be used to suppress input and output handling to the pty/tty. See the
1196	description of C<< urxvt::timer->events >>. Make sure to always restore	1320	description of C<< urxvt::timer->events >>. Make sure to always restore
1197	the previous value.	1321	the previous value.
		1322
		1323	=item $fd = $term->pty_fd
		1324
		1325	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1326	is used.
1198		1327
1199	=item $windowid = $term->parent	1328	=item $windowid = $term->parent
1200		1329
1201	Return the window id of the toplevel window.	1330	Return the window id of the toplevel window.
1202		1331
…		…
1267	=item $modifiermask = $term->ModNumLockMask	1396	=item $modifiermask = $term->ModNumLockMask
1268		1397
1269	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1398	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1270	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1399	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1271		1400
		1401	=item $screen = $term->current_screen
		1402
		1403	Returns the currently displayed screen (0 primary, 1 secondary).
		1404
		1405	=item $cursor_is_hidden = $term->hidden_cursor
		1406
		1407	Returns wether the cursor is currently hidden or not.
		1408
1272	=item $view_start = $term->view_start ([$newvalue])	1409	=item $view_start = $term->view_start ([$newvalue])
1273		1410
1274	Returns the row number of the topmost displayed line. Maximum value is	1411	Returns the row number of the topmost displayed line. Maximum value is
1275	C<0>, which displays the normal terminal contents. Lower values scroll	1412	C<0>, which displays the normal terminal contents. Lower values scroll
1276	this many lines into the scrollback buffer.	1413	this many lines into the scrollback buffer.
…		…
1295	line, starting at column C<$start_col> (default C<0>), which is useful	1432	line, starting at column C<$start_col> (default C<0>), which is useful
1296	to replace only parts of a line. The font index in the rendition will	1433	to replace only parts of a line. The font index in the rendition will
1297	automatically be updated.	1434	automatically be updated.
1298		1435
1299	C<$text> is in a special encoding: tabs and wide characters that use more	1436	C<$text> is in a special encoding: tabs and wide characters that use more
1300	than one cell when displayed are padded with urxvt::NOCHAR characters	1437	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1301	(C<chr 65535>). Characters with combining characters and other characters	1438	characters. Characters with combining characters and other characters that
1302	that do not fit into the normal tetx encoding will be replaced with	1439	do not fit into the normal tetx encoding will be replaced with characters
1303	characters in the private use area.	1440	in the private use area.
1304		1441
1305	You have to obey this encoding when changing text. The advantage is	1442	You have to obey this encoding when changing text. The advantage is
1306	that C<substr> and similar functions work on screen cells and not on	1443	that C<substr> and similar functions work on screen cells and not on
1307	characters.	1444	characters.
1308		1445
…		…
1482	=item $term->ungrab	1619	=item $term->ungrab
1483		1620
1484	Calls XUngrab for the most recent grab. Is called automatically on	1621	Calls XUngrab for the most recent grab. Is called automatically on
1485	evaluation errors, as it is better to lose the grab in the error case as	1622	evaluation errors, as it is better to lose the grab in the error case as
1486	the session.	1623	the session.
		1624
		1625	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1626
		1627	=item $atom_name = $term->XGetAtomName ($atom)
		1628
		1629	=item @atoms = $term->XListProperties ($window)
		1630
		1631	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1632
		1633	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1634
		1635	=item $term->XDeleteProperty ($window, $property)
		1636
		1637	=item $window = $term->DefaultRootWindow
		1638
		1639	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1640
		1641	=item $term->XMapWindow ($window)
		1642
		1643	=item $term->XUnmapWindow ($window)
		1644
		1645	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1646
		1647	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1648
		1649	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1650
		1651	Various X or X-related functions. The C<$term> object only serves as
		1652	the source of the display, otherwise those functions map more-or-less
		1653	directory onto the X functions of the same name.
1487		1654
1488	=back	1655	=back
1489		1656
1490	=cut	1657	=cut
1491		1658
…		…
1611	delete $self->{term}{_destroy}{$self};	1778	delete $self->{term}{_destroy}{$self};
1612	$self->{term}->ungrab;	1779	$self->{term}->ungrab;
1613	}	1780	}
1614		1781
1615	=back	1782	=back
		1783
		1784	=cut
		1785
		1786	package urxvt::watcher;
		1787
		1788	@urxvt::timer::ISA = __PACKAGE__;
		1789	@urxvt::iow::ISA = __PACKAGE__;
		1790	@urxvt::pw::ISA = __PACKAGE__;
		1791	@urxvt::iw::ISA = __PACKAGE__;
1616		1792
1617	=head2 The C<urxvt::timer> Class	1793	=head2 The C<urxvt::timer> Class
1618		1794
1619	This class implements timer watchers/events. Time is represented as a	1795	This class implements timer watchers/events. Time is represented as a
1620	fractional number of seconds since the epoch. Example:	1796	fractional number of seconds since the epoch. Example:
…		…
1718		1894
1719	Stop watching for events on the given filehandle.	1895	Stop watching for events on the given filehandle.
1720		1896
1721	=back	1897	=back
1722		1898
		1899	=head2 The C<urxvt::iw> Class
		1900
		1901	This class implements idle watchers, that get called automatically when
		1902	the process is idle. They should return as fast as possible, after doing
		1903	some useful work.
		1904
		1905	=over 4
		1906
		1907	=item $iw = new urxvt::iw
		1908
		1909	Create a new idle watcher object in stopped state.
		1910
		1911	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1912
		1913	Set the callback to be called when the watcher triggers.
		1914
		1915	=item $timer = $timer->start
		1916
		1917	Start the watcher.
		1918
		1919	=item $timer = $timer->stop
		1920
		1921	Stop the watcher.
		1922
		1923	=back
		1924
		1925	=head2 The C<urxvt::pw> Class
		1926
		1927	This class implements process watchers. They create an event whenever a
		1928	process exits, after which they stop automatically.
		1929
		1930	my $pid = fork;
		1931	...
		1932	$term->{pw} = urxvt::pw
		1933	->new
		1934	->start ($pid)
		1935	->cb (sub {
		1936	my ($pw, $exit_status) = @_;
		1937	...
		1938	});
		1939
		1940	=over 4
		1941
		1942	=item $pw = new urxvt::pw
		1943
		1944	Create a new process watcher in stopped state.
		1945
		1946	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1947
		1948	Set the callback to be called when the timer triggers.
		1949
		1950	=item $pw = $timer->start ($pid)
		1951
		1952	Tells the wqtcher to start watching for process C<$pid>.
		1953
		1954	=item $pw = $pw->stop
		1955
		1956	Stop the watcher.
		1957
		1958	=back
		1959
1723	=head1 ENVIRONMENT	1960	=head1 ENVIRONMENT
1724		1961
1725	=head2 URXVT_PERL_VERBOSITY	1962	=head2 URXVT_PERL_VERBOSITY
1726		1963
1727	This variable controls the verbosity level of the perl extension. Higher	1964	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.107 by root, Wed Jan 18 21:30:50 2006 UTC vs. Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.107 by root, Wed Jan 18 21:30:50 2006 UTC vs.
Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC