[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.128 by root, Wed Jan 25 00:57:57 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
166	resource C<urlLauncher> (default C<x-www-browser>) will be started with	214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
167	the URL as first argument.	215	the URL as first argument.
		216
		217	=item xim-onthespot
		218
		219	This (experimental) perl extension implements OnTheSpot editing. It does
		220	not work perfectly, and some input methods don't seem to work well with
		221	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		222	kinput2.
		223
		224	You enable it by specifying this extension and a preedit style of
		225	C<OnTheSpot>, i.e.:
		226
		227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
168		228
169	=item automove-background	229	=item automove-background
170		230
171	This is basically a one-line extension that dynamically changes the background pixmap offset	231	This is basically a one-line extension that dynamically changes the background pixmap offset
172	to the window position, in effect creating the same effect as pseudo transparency with	232	to the window position, in effect creating the same effect as pseudo transparency with
…		…
298	called whenever the relevant event happens.	358	called whenever the relevant event happens.
299		359
300	The first argument passed to them is an extension oject as described in	360	The first argument passed to them is an extension oject as described in
301	the in the C<Extension Objects> section.	361	the in the C<Extension Objects> section.
302		362
303	B<All> of these hooks must return a boolean value. If it is true, then the	363	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	364	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.	365	relevant action might not be carried out by the C++ code.
306		366
307	I<< When in doubt, return a false value (preferably C<()>). >>	367	I<< When in doubt, return a false value (preferably C<()>). >>
308		368
309	=over 4	369	=over 4
310		370
311	=item on_init $term	371	=item on_init $term
312		372
313	Called after a new terminal object has been initialized, but before	373	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	374	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	375	call or deliver senseless data, as terminal size and other characteristics
316	have not yet been determined. You can safely query and change resources,	376	have not yet been determined. You can safely query and change resources
317	though.	377	and options, though. For many purposes the C<on_start> hook is a better
		378	place.
		379
		380	=item on_start $term
		381
		382	Called at the very end of initialisation of a new terminal, just before
		383	trying to map (display) the toplevel and returning to the mainloop.
		384
		385	=item on_destroy $term
		386
		387	Called whenever something tries to destroy terminal, when the terminal is
		388	still fully functional (not for long, though).
318		389
319	=item on_reset $term	390	=item on_reset $term
320		391
321	Called after the screen is "reset" for any reason, such as resizing or	392	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	393	control sequences. Here is where you can react on changes to size-related
323	variables.	394	variables.
324		395
325	=item on_start $term	396	=item on_child_start $term, $pid
326		397
327	Called at the very end of initialisation of a new terminal, just before	398	Called just after the child process has been C<fork>ed.
328	returning to the mainloop.	399
		400	=item on_child_exit $term, $status
		401
		402	Called just after the child process has exited. C<$status> is the status
		403	from C<waitpid>.
329		404
330	=item on_sel_make $term, $eventtime	405	=item on_sel_make $term, $eventtime
331		406
332	Called whenever a selection has been made by the user, but before the	407	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	408	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	519	Called wheneever the window loses keyboard focus, before rxvt-unicode does
445	focus out processing.	520	focus out processing.
446		521
447	=item on_configure_notify $term, $event	522	=item on_configure_notify $term, $event
448		523
		524	=item on_property_notify $term, $event
		525
449	=item on_key_press $term, $event, $keysym, $octets	526	=item on_key_press $term, $event, $keysym, $octets
450		527
451	=item on_key_release $term, $event, $keysym	528	=item on_key_release $term, $event, $keysym
452		529
453	=item on_button_press $term, $event	530	=item on_button_press $term, $event
…		…
462		539
463	Called whenever the corresponding X event is received for the terminal If	540	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.	541	the hook returns true, then the even will be ignored by rxvt-unicode.
465		542
466	The event is a hash with most values as named by Xlib (see the XEvent	543	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	544	manpage), with the additional members C<row> and C<col>, which are the
468	and column under the mouse cursor.	545	(real, not screen-based) row and column under the mouse cursor.
469		546
470	C<on_key_press> additionally receives the string rxvt-unicode would	547	C<on_key_press> additionally receives the string rxvt-unicode would
471	output, if any, in locale-specific encoding.	548	output, if any, in locale-specific encoding.
472		549
473	subwindow.	550	subwindow.
		551
		552	=item on_client_message $term, $event
		553
		554	=item on_wm_protocols $term, $event
		555
		556	=item on_wm_delete_window $term, $event
		557
		558	Called when various types of ClientMessage events are received (all with
		559	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
474		560
475	=back	561	=back
476		562
477	=cut	563	=cut
478		564
…		…
484	use Scalar::Util ();	570	use Scalar::Util ();
485	use List::Util ();	571	use List::Util ();
486		572
487	our $VERSION = 1;	573	our $VERSION = 1;
488	our $TERM;	574	our $TERM;
		575	our @TERM_INIT;
		576	our @TERM_EXT;
489	our @HOOKNAME;	577	our @HOOKNAME;
490	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	578	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491	our %OPTION;	579	our %OPTION;
492		580
493	our $LIBDIR;	581	our $LIBDIR;
494	our $RESNAME;	582	our $RESNAME;
495	our $RESCLASS;	583	our $RESCLASS;
496	our $RXVTNAME;	584	our $RXVTNAME;
497		585
		586	our $NOCHAR = chr 0xffff;
		587
498	=head2 Variables in the C<urxvt> Package	588	=head2 Variables in the C<urxvt> Package
499		589
500	=over 4	590	=over 4
501		591
502	=item $urxvt::LIBDIR	592	=item $urxvt::LIBDIR
…		…
514		604
515	=item $urxvt::TERM	605	=item $urxvt::TERM
516		606
517	The current terminal. This variable stores the current C<urxvt::term>	607	The current terminal. This variable stores the current C<urxvt::term>
518	object, whenever a callback/hook is executing.	608	object, whenever a callback/hook is executing.
		609
		610	=item @urxvt::TERM_INIT
		611
		612	All coderefs in this array will be called as methods of the next newly
		613	created C<urxvt::term> object (during the C<on_init> phase). The array
		614	gets cleared before the codereferences that were in it are being executed,
		615	so coderefs can push themselves onto it again if they so desire.
		616
		617	This complements to the perl-eval commandline option, but gets executed
		618	first.
		619
		620	=item @urxvt::TERM_EXT
		621
		622	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		623	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		624	but before other extensions. Gets cleared just like C<@TERM_INIT>.
519		625
520	=back	626	=back
521		627
522	=head2 Functions in the C<urxvt> Package	628	=head2 Functions in the C<urxvt> Package
523		629
…		…
632	unless $msg =~ /\n$/;	738	unless $msg =~ /\n$/;
633	urxvt::warn ($msg);	739	urxvt::warn ($msg);
634	};	740	};
635	}	741	}
636		742
		743	no warnings 'utf8';
		744
637	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	745	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
638		746
639	sub verbose {	747	sub verbose {
640	my ($level, $msg) = @_;	748	my ($level, $msg) = @_;
641	warn "$msg\n" if $level <= $verbosity;	749	warn "$msg\n" if $level <= $verbosity;
…		…
644	my %extension_pkg;	752	my %extension_pkg;
645		753
646	# load a single script into its own package, once only	754	# load a single script into its own package, once only
647	sub extension_package($) {	755	sub extension_package($) {
648	my ($path) = @_;	756	my ($path) = @_;
649
650	no strict 'refs';
651		757
652	$extension_pkg{$path} \|\|= do {	758	$extension_pkg{$path} \|\|= do {
653	$path =~ /([^\/\\]+)$/;	759	$path =~ /([^\/\\]+)$/;
654	my $pkg = $1;	760	my $pkg = $1;
655	$pkg =~ s/[^[:word:]]/_/g;	761	$pkg =~ s/[^[:word:]]/_/g;
…		…
658	verbose 3, "loading extension '$path' into package '$pkg'";	764	verbose 3, "loading extension '$path' into package '$pkg'";
659		765
660	open my $fh, "<:raw", $path	766	open my $fh, "<:raw", $path
661	or die "$path: $!";	767	or die "$path: $!";
662		768
663	@{"$pkg\::ISA"} = urxvt::term::extension::;
664
665	my $source =	769	my $source =
666	"package $pkg; use strict; use utf8;\n"	770	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
667	. "#line 1 \"$path\"\n{\n"	771	. "#line 1 \"$path\"\n{\n"
668	. (do { local $/; <$fh> })	772	. (do { local $/; <$fh> })
669	. "\n};\n1";	773	. "\n};\n1";
670		774
671	eval $source	775	eval $source
…		…
685	if ($htype == 0) { # INIT	789	if ($htype == 0) { # INIT
686	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	790	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
687		791
688	my %ext_arg;	792	my %ext_arg;
689		793
		794	{
		795	my @init = @TERM_INIT;
		796	@TERM_INIT = ();
		797	$_->($TERM) for @init;
		798	my @pkg = @TERM_EXT;
		799	@TERM_EXT = ();
		800	$TERM->register_package ($_) for @pkg;
		801	}
		802
690	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	803	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
691	if ($_ eq "default") {	804	if ($_ eq "default") {
692	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	805	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
693	} elsif (/^-(.*)$/) {	806	} elsif (/^-(.*)$/) {
694	delete $ext_arg{$1};	807	delete $ext_arg{$1};
695	} elsif (/^([^<]+)<(.*)>$/) {	808	} elsif (/^([^<]+)<(.*)>$/) {
696	push @{ $ext_arg{$1} }, $2;	809	push @{ $ext_arg{$1} }, $2;
697	} else {	810	} else {
…		…
720	if $verbosity >= 10;	833	if $verbosity >= 10;
721		834
722	keys %$cb;	835	keys %$cb;
723		836
724	while (my ($pkg, $cb) = each %$cb) {	837	while (my ($pkg, $cb) = each %$cb) {
725	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	838	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
726	and last;	839	$retval \|\|= $retval_;
727		840
728	if ($@) {	841	if ($@) {
729	$TERM->ungrab; # better to lose the grab than the session	842	$TERM->ungrab; # better to lose the grab than the session
730	warn $@;	843	warn $@;
731	}	844	}
…		…
742	# clear package	855	# clear package
743	%$TERM = ();	856	%$TERM = ();
744	}	857	}
745		858
746	$retval	859	$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	}	860	}
760		861
761	# urxvt::term::extension	862	# urxvt::term::extension
762		863
763	package urxvt::term::extension;	864	package urxvt::term::extension;
…		…
902	# find on_xxx subs in the package and register them	1003	# find on_xxx subs in the package and register them
903	# as hooks	1004	# as hooks
904	sub register_package {	1005	sub register_package {
905	my ($self, $pkg, $argv) = @_;	1006	my ($self, $pkg, $argv) = @_;
906		1007
		1008	no strict 'refs';
		1009
		1010	urxvt::verbose 6, "register package $pkg to $self";
		1011
		1012	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1013
907	my $proxy = bless {	1014	my $proxy = bless {
908	_pkg => $pkg,	1015	_pkg => $pkg,
909	argv => $argv,	1016	argv => $argv,
910	}, $pkg;	1017	}, $pkg;
911	Scalar::Util::weaken ($proxy->{term} = $self);	1018	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
941	=item $term->destroy	1048	=item $term->destroy
942		1049
943	Destroy the terminal object (close the window, free resources	1050	Destroy the terminal object (close the window, free resources
944	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1051	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
945	watchers (timers, io watchers) are still active.	1052	watchers (timers, io watchers) are still active.
		1053
		1054	=item $term->exec_async ($cmd[, @args])
		1055
		1056	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1057	("starts") programs in the background. This function takes care of setting
		1058	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1059	be preferred over explicit calls to C<exec> or C<system>.
		1060
		1061	Returns the pid of the subprocess or C<undef> on error.
		1062
		1063	=cut
		1064
		1065	sub exec_async {
		1066	my $self = shift;
		1067
		1068	my $pid = fork;
		1069
		1070	return $pid
		1071	if !defined $pid or $pid;
		1072
		1073	%ENV = %{ $self->env };
		1074
		1075	exec @_;
		1076	urxvt::_exit 255;
		1077	}
946		1078
947	=item $isset = $term->option ($optval[, $set])	1079	=item $isset = $term->option ($optval[, $set])
948		1080
949	Returns true if the option specified by C<$optval> is enabled, and	1081	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	1082	optionally change it. All option values are stored by name in the hash
…		…
1175		1307
1176	Normally its not a good idea to use this function, as programs might be	1308	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	1309	confused by changes in cursor position or scrolling. Its useful inside a
1178	C<on_add_lines> hook, though.	1310	C<on_add_lines> hook, though.
1179		1311
		1312	=item $term->scr_change_screen ($screen)
		1313
		1314	Switch to given screen - 0 primary, 1 secondary.
		1315
1180	=item $term->cmd_parse ($octets)	1316	=item $term->cmd_parse ($octets)
1181		1317
1182	Similar to C<scr_add_lines>, but the argument must be in the	1318	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	1319	locale-specific encoding of the terminal and can contain command sequences
1184	(escape codes) that will be interpreted.	1320	(escape codes) that will be interpreted.
…		…
1193		1329
1194	Replaces the event mask of the pty watcher by the given event mask. Can	1330	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	1331	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	1332	description of C<< urxvt::timer->events >>. Make sure to always restore
1197	the previous value.	1333	the previous value.
		1334
		1335	=item $fd = $term->pty_fd
		1336
		1337	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1338	is used.
1198		1339
1199	=item $windowid = $term->parent	1340	=item $windowid = $term->parent
1200		1341
1201	Return the window id of the toplevel window.	1342	Return the window id of the toplevel window.
1202		1343
…		…
1267	=item $modifiermask = $term->ModNumLockMask	1408	=item $modifiermask = $term->ModNumLockMask
1268		1409
1269	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1410	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.	1411	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1271		1412
		1413	=item $screen = $term->current_screen
		1414
		1415	Returns the currently displayed screen (0 primary, 1 secondary).
		1416
		1417	=item $cursor_is_hidden = $term->hidden_cursor
		1418
		1419	Returns wether the cursor is currently hidden or not.
		1420
1272	=item $view_start = $term->view_start ([$newvalue])	1421	=item $view_start = $term->view_start ([$newvalue])
1273		1422
1274	Returns the row number of the topmost displayed line. Maximum value is	1423	Returns the row number of the topmost displayed line. Maximum value is
1275	C<0>, which displays the normal terminal contents. Lower values scroll	1424	C<0>, which displays the normal terminal contents. Lower values scroll
1276	this many lines into the scrollback buffer.	1425	this many lines into the scrollback buffer.
…		…
1295	line, starting at column C<$start_col> (default C<0>), which is useful	1444	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	1445	to replace only parts of a line. The font index in the rendition will
1297	automatically be updated.	1446	automatically be updated.
1298		1447
1299	C<$text> is in a special encoding: tabs and wide characters that use more	1448	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	1449	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1301	(C<chr 65535>). Characters with combining characters and other characters	1450	characters. Characters with combining characters and other characters that
1302	that do not fit into the normal tetx encoding will be replaced with	1451	do not fit into the normal tetx encoding will be replaced with characters
1303	characters in the private use area.	1452	in the private use area.
1304		1453
1305	You have to obey this encoding when changing text. The advantage is	1454	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	1455	that C<substr> and similar functions work on screen cells and not on
1307	characters.	1456	characters.
1308		1457
…		…
1482	=item $term->ungrab	1631	=item $term->ungrab
1483		1632
1484	Calls XUngrab for the most recent grab. Is called automatically on	1633	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	1634	evaluation errors, as it is better to lose the grab in the error case as
1486	the session.	1635	the session.
		1636
		1637	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1638
		1639	=item $atom_name = $term->XGetAtomName ($atom)
		1640
		1641	=item @atoms = $term->XListProperties ($window)
		1642
		1643	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1644
		1645	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1646
		1647	=item $term->XDeleteProperty ($window, $property)
		1648
		1649	=item $window = $term->DefaultRootWindow
		1650
		1651	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1652
		1653	=item $term->XMapWindow ($window)
		1654
		1655	=item $term->XUnmapWindow ($window)
		1656
		1657	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1658
		1659	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1660
		1661	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1662
		1663	Various X or X-related functions. The C<$term> object only serves as
		1664	the source of the display, otherwise those functions map more-or-less
		1665	directory onto the X functions of the same name.
1487		1666
1488	=back	1667	=back
1489		1668
1490	=cut	1669	=cut
1491		1670
…		…
1611	delete $self->{term}{_destroy}{$self};	1790	delete $self->{term}{_destroy}{$self};
1612	$self->{term}->ungrab;	1791	$self->{term}->ungrab;
1613	}	1792	}
1614		1793
1615	=back	1794	=back
		1795
		1796	=cut
		1797
		1798	package urxvt::watcher;
		1799
		1800	@urxvt::timer::ISA = __PACKAGE__;
		1801	@urxvt::iow::ISA = __PACKAGE__;
		1802	@urxvt::pw::ISA = __PACKAGE__;
		1803	@urxvt::iw::ISA = __PACKAGE__;
1616		1804
1617	=head2 The C<urxvt::timer> Class	1805	=head2 The C<urxvt::timer> Class
1618		1806
1619	This class implements timer watchers/events. Time is represented as a	1807	This class implements timer watchers/events. Time is represented as a
1620	fractional number of seconds since the epoch. Example:	1808	fractional number of seconds since the epoch. Example:
…		…
1718		1906
1719	Stop watching for events on the given filehandle.	1907	Stop watching for events on the given filehandle.
1720		1908
1721	=back	1909	=back
1722		1910
		1911	=head2 The C<urxvt::iw> Class
		1912
		1913	This class implements idle watchers, that get called automatically when
		1914	the process is idle. They should return as fast as possible, after doing
		1915	some useful work.
		1916
		1917	=over 4
		1918
		1919	=item $iw = new urxvt::iw
		1920
		1921	Create a new idle watcher object in stopped state.
		1922
		1923	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1924
		1925	Set the callback to be called when the watcher triggers.
		1926
		1927	=item $timer = $timer->start
		1928
		1929	Start the watcher.
		1930
		1931	=item $timer = $timer->stop
		1932
		1933	Stop the watcher.
		1934
		1935	=back
		1936
		1937	=head2 The C<urxvt::pw> Class
		1938
		1939	This class implements process watchers. They create an event whenever a
		1940	process exits, after which they stop automatically.
		1941
		1942	my $pid = fork;
		1943	...
		1944	$term->{pw} = urxvt::pw
		1945	->new
		1946	->start ($pid)
		1947	->cb (sub {
		1948	my ($pw, $exit_status) = @_;
		1949	...
		1950	});
		1951
		1952	=over 4
		1953
		1954	=item $pw = new urxvt::pw
		1955
		1956	Create a new process watcher in stopped state.
		1957
		1958	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1959
		1960	Set the callback to be called when the timer triggers.
		1961
		1962	=item $pw = $timer->start ($pid)
		1963
		1964	Tells the wqtcher to start watching for process C<$pid>.
		1965
		1966	=item $pw = $pw->stop
		1967
		1968	Stop the watcher.
		1969
		1970	=back
		1971
1723	=head1 ENVIRONMENT	1972	=head1 ENVIRONMENT
1724		1973
1725	=head2 URXVT_PERL_VERBOSITY	1974	=head2 URXVT_PERL_VERBOSITY
1726		1975
1727	This variable controls the verbosity level of the perl extension. Higher	1976	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.128 by root, Wed Jan 25 00:57:57 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.128 by root, Wed Jan 25 00:57:57 2006 UTC