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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.92 by root, Fri Jan 13 04:59:04 2006 UTC vs.
Revision 1.124 by root, Sun Jan 22 11:57:06 2006 UTC

…		…
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
…		…
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
67		71
68	You can look at the source of the selection extension to see more	72	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.	73	interesting uses, such as parsing a line from beginning to end.
70		74
71	This extension also offers the following bindable keyboard command:	75	This extension also offers following bindable keyboard commands:
72		76
73	=over 4	77	=over 4
74		78
75	=item rot13	79	=item rot13
76		80
…		…
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.
		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
93		116
94	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
95		118
96	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
104	bottom. C<Escape> leaves search mode and returns to the point where search	127	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and	128	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary	129	additionally stores the first match in the current line into the primary
107	selection.	130	selection.
108		131
		132	=item readline (enabled by default)
		133
		134	A support package that tries to make editing with readline easier. At the
		135	moment, it reacts to clicking with the left mouse button by trying to
		136	move the text cursor to this position. It does so by generating as many
		137	cursor-left or cursor-right keypresses as required (the this only works
		138	for programs that correctly support wide characters).
		139
		140	To avoid too many false positives, this is only done when:
		141
		142	=over 4
		143
		144	=item - the mouse is on the same (multi-row-) line as the text cursor.
		145
		146	=item - the primary screen is currently being displayed.
		147
		148	=item - the text cursor is visible.
		149
		150	=back
		151
		152	The normal selection mechanism isn't disabled, so quick successive clicks
		153	might interfere with selection creation in harmless ways.
		154
109	=item selection-autotransform	155	=item selection-autotransform
110		156
111	This selection allows you to do automatic transforms on a selection	157	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	158	whenever a selection is made.
113		159
…		…
120		166
121	For example, the following will transform selections of the form	167	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename	168	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:	169	$word>:
124		170
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	171	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		172
127	And this example matches the same,but replaces it with vi-commands you can	173	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	174	paste directly into your (vi :) editor:
129		175
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	176	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		177
132	Of course, this can be modified to suit your needs and your editor :)	178	Of course, this can be modified to suit your needs and your editor :)
133		179
134	To expand the example above to typical perl error messages ("XXX at	180	To expand the example above to typical perl error messages ("XXX at
135	FILENAME line YYY."), you need a slightly more elaborate solution:	181	FILENAME line YYY."), you need a slightly more elaborate solution:
136		182
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	183	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	184	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139		185
140	The first line tells the selection code to treat the unchanging part of	186	The first line tells the selection code to treat the unchanging part of
141	every error message as a selection pattern, and the second line transforms	187	every error message as a selection pattern, and the second line transforms
142	the message into vi commands to load the file.	188	the message into vi commands to load the file.
		189
		190	=item tabbed
		191
		192	This transforms the terminal into a tabbar with additional terminals, that
		193	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		194	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		195	button per tab.
		196
		197	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		198	B<Shift-Right> will switch to the tab left or right of the current one,
		199	while B<Shift-Down> creates a new tab.
143		200
144	=item mark-urls	201	=item mark-urls
145		202
146	Uses per-line display filtering (C<on_line_update>) to underline urls and	203	Uses per-line display filtering (C<on_line_update>) to underline urls and
147	make them clickable. When middle-clicked, the program specified in the	204	make them clickable. When middle-clicked, the program specified in the
148	resource C<urlLauncher> (default C<x-www-browser>) will be started with	205	resource C<urlLauncher> (default C<x-www-browser>) will be started with
149	the URL as first argument.	206	the URL as first argument.
150		207
		208	=item automove-background
		209
		210	This is basically a one-line extension that dynamically changes the background pixmap offset
		211	to the window position, in effect creating the same effect as pseudo transparency with
		212	a custom pixmap. No scaling is supported in this mode. Exmaple:
		213
		214	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		215
151	=item block-graphics-to-ascii	216	=item block-graphics-to-ascii
152		217
153	A not very useful example of filtering all text output to the terminal,	218	A not very useful example of filtering all text output to the terminal,
154	by replacing all line-drawing characters (U+2500 .. U+259F) by a	219	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.	220	similar-looking ascii character.
…		…
161	=item example-refresh-hooks	226	=item example-refresh-hooks
162		227
163	Displays a very simple digital clock in the upper right corner of the	228	Displays a very simple digital clock in the upper right corner of the
164	window. Illustrates overwriting the refresh callbacks to create your own	229	window. Illustrates overwriting the refresh callbacks to create your own
165	overlays or changes.	230	overlays or changes.
		231
		232	=item selection-pastebin
		233
		234	This is a little rarely useful extension that Uploads the selection as
		235	textfile to a remote site (or does other things). (The implementation is
		236	not currently secure for use in a multiuser environment as it writes to
		237	F</tmp> directly.).
		238
		239	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		240	i.e.
		241
		242	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		243
		244	Pressing this combination runs a command with C<%> replaced by the name of
		245	the textfile. This command can be set via a resource:
		246
		247	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		248
		249	And the default is likely not useful to anybody but the few people around
		250	here :)
		251
		252	The name of the textfile is the hex encoded md5 sum of the selection, so
		253	the same content should lead to the same filename.
		254
		255	After a successful upload the selection will be replaced by the text given
		256	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		257	for the filename):
		258
		259	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
166		260
167	=back	261	=back
168		262
169	=head1 API DOCUMENTATION	263	=head1 API DOCUMENTATION
170		264
…		…
243	called whenever the relevant event happens.	337	called whenever the relevant event happens.
244		338
245	The first argument passed to them is an extension oject as described in	339	The first argument passed to them is an extension oject as described in
246	the in the C<Extension Objects> section.	340	the in the C<Extension Objects> section.
247		341
248	B<All> of these hooks must return a boolean value. If it is true, then the	342	B<All> of these hooks must return a boolean value. If any of the called
249	event counts as being I<consumed>, and the invocation of other hooks is	343	hooks returns true, then the event counts as being I<consumed>, and the
250	skipped, and the relevant action might not be carried out by the C++ code.	344	relevant action might not be carried out by the C++ code.
251		345
252	I<< When in doubt, return a false value (preferably C<()>). >>	346	I<< When in doubt, return a false value (preferably C<()>). >>
253		347
254	=over 4	348	=over 4
255		349
256	=item on_init $term	350	=item on_init $term
257		351
258	Called after a new terminal object has been initialized, but before	352	Called after a new terminal object has been initialized, but before
259	windows are created or the command gets run. Most methods are unsafe to	353	windows are created or the command gets run. Most methods are unsafe to
260	call or deliver senseless data, as terminal size and other characteristics	354	call or deliver senseless data, as terminal size and other characteristics
261	have not yet been determined. You can safely query and change resources,	355	have not yet been determined. You can safely query and change resources
262	though.	356	and options, though. For many purposes the C<on_start> hook is a better
		357	place.
		358
		359	=item on_start $term
		360
		361	Called at the very end of initialisation of a new terminal, just before
		362	trying to map (display) the toplevel and returning to the mainloop.
		363
		364	=item on_destroy $term
		365
		366	Called whenever something tries to destroy terminal, before doing anything
		367	yet. If this hook returns true, then destruction is skipped, but this is
		368	rarely a good idea.
263		369
264	=item on_reset $term	370	=item on_reset $term
265		371
266	Called after the screen is "reset" for any reason, such as resizing or	372	Called after the screen is "reset" for any reason, such as resizing or
267	control sequences. Here is where you can react on changes to size-related	373	control sequences. Here is where you can react on changes to size-related
268	variables.	374	variables.
269		375
270	=item on_start $term	376	=item on_child_start $term, $pid
271		377
272	Called at the very end of initialisation of a new terminal, just before	378	Called just after the child process has been C<fork>ed.
273	returning to the mainloop.	379
		380	=item on_child_exit $term, $status
		381
		382	Called just after the child process has exited. C<$status> is the status
		383	from C<waitpid>.
274		384
275	=item on_sel_make $term, $eventtime	385	=item on_sel_make $term, $eventtime
276		386
277	Called whenever a selection has been made by the user, but before the	387	Called whenever a selection has been made by the user, but before the
278	selection text is copied, so changes to the beginning, end or type of the	388	selection text is copied, so changes to the beginning, end or type of the
…		…
387	=item on_focus_out $term	497	=item on_focus_out $term
388		498
389	Called wheneever the window loses keyboard focus, before rxvt-unicode does	499	Called wheneever the window loses keyboard focus, before rxvt-unicode does
390	focus out processing.	500	focus out processing.
391		501
		502	=item on_configure_notify $term, $event
		503
		504	=item on_property_notify $term, $event
		505
392	=item on_key_press $term, $event, $keysym, $octets	506	=item on_key_press $term, $event, $keysym, $octets
393		507
394	=item on_key_release $term, $event, $keysym	508	=item on_key_release $term, $event, $keysym
395		509
396	=item on_button_press $term, $event	510	=item on_button_press $term, $event
…		…
405		519
406	Called whenever the corresponding X event is received for the terminal If	520	Called whenever the corresponding X event is received for the terminal If
407	the hook returns true, then the even will be ignored by rxvt-unicode.	521	the hook returns true, then the even will be ignored by rxvt-unicode.
408		522
409	The event is a hash with most values as named by Xlib (see the XEvent	523	The event is a hash with most values as named by Xlib (see the XEvent
410	manpage), with the additional members C<row> and C<col>, which are the row	524	manpage), with the additional members C<row> and C<col>, which are the
411	and column under the mouse cursor.	525	(real, not screen-based) row and column under the mouse cursor.
412		526
413	C<on_key_press> additionally receives the string rxvt-unicode would	527	C<on_key_press> additionally receives the string rxvt-unicode would
414	output, if any, in locale-specific encoding.	528	output, if any, in locale-specific encoding.
415		529
416	subwindow.	530	subwindow.
		531
		532	=item on_client_message $term, $event
		533
		534	=item on_wm_protocols $term, $event
		535
		536	=item on_wm_delete_window $term, $event
		537
		538	Called when various types of ClientMessage events are received (all with
		539	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
417		540
418	=back	541	=back
419		542
420	=cut	543	=cut
421		544
…		…
427	use Scalar::Util ();	550	use Scalar::Util ();
428	use List::Util ();	551	use List::Util ();
429		552
430	our $VERSION = 1;	553	our $VERSION = 1;
431	our $TERM;	554	our $TERM;
		555	our @TERM_INIT;
		556	our @TERM_EXT;
432	our @HOOKNAME;	557	our @HOOKNAME;
433	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	558	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
434	our %OPTION;	559	our %OPTION;
435		560
436	our $LIBDIR;	561	our $LIBDIR;
437	our $RESNAME;	562	our $RESNAME;
438	our $RESCLASS;	563	our $RESCLASS;
439	our $RXVTNAME;	564	our $RXVTNAME;
440		565
		566	our $NOCHAR = chr 0xffff;
		567
441	=head2 Variables in the C<urxvt> Package	568	=head2 Variables in the C<urxvt> Package
442		569
443	=over 4	570	=over 4
444		571
445	=item $urxvt::LIBDIR	572	=item $urxvt::LIBDIR
…		…
457		584
458	=item $urxvt::TERM	585	=item $urxvt::TERM
459		586
460	The current terminal. This variable stores the current C<urxvt::term>	587	The current terminal. This variable stores the current C<urxvt::term>
461	object, whenever a callback/hook is executing.	588	object, whenever a callback/hook is executing.
		589
		590	=item @urxvt::TERM_INIT
		591
		592	All coderefs in this array will be called as methods of the next newly
		593	created C<urxvt::term> object (during the C<on_init> phase). The array
		594	gets cleared before the codereferences that were in it are being executed,
		595	so coderefs can push themselves onto it again if they so desire.
		596
		597	This complements to the perl-eval commandline option, but gets executed
		598	first.
		599
		600	=item @urxvt::TERM_EXT
		601
		602	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		603	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		604	but before other extensions. Gets cleared just like C<@TERM_INIT>.
462		605
463	=back	606	=back
464		607
465	=head2 Functions in the C<urxvt> Package	608	=head2 Functions in the C<urxvt> Package
466		609
…		…
480		623
481	Using this function has the advantage that its output ends up in the	624	Using this function has the advantage that its output ends up in the
482	correct place, e.g. on stderr of the connecting urxvtc client.	625	correct place, e.g. on stderr of the connecting urxvtc client.
483		626
484	Messages have a size limit of 1023 bytes currently.	627	Messages have a size limit of 1023 bytes currently.
485
486	=item $is_safe = urxvt::safe
487
488	Returns true when it is safe to do potentially unsafe things, such as
489	evaluating perl code specified by the user. This is true when urxvt was
490	started setuid or setgid.
491		628
492	=item $time = urxvt::NOW	629	=item $time = urxvt::NOW
493		630
494	Returns the "current time" (as per the event loop).	631	Returns the "current time" (as per the event loop).
495		632
…		…
572	=back	709	=back
573		710
574	=cut	711	=cut
575		712
576	BEGIN {	713	BEGIN {
577	urxvt->bootstrap;
578
579	# overwrite perl's warn	714	# overwrite perl's warn
580	*CORE::GLOBAL::warn = sub {	715	*CORE::GLOBAL::warn = sub {
581	my $msg = join "", @_;	716	my $msg = join "", @_;
582	$msg .= "\n"	717	$msg .= "\n"
583	unless $msg =~ /\n$/;	718	unless $msg =~ /\n$/;
584	urxvt::warn ($msg);	719	urxvt::warn ($msg);
585	};	720	};
586
587	# %ENV is the original startup environment
588	delete $ENV{IFS};
589	delete $ENV{CDPATH};
590	delete $ENV{BASH_ENV};
591	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
592	}	721	}
		722
		723	no warnings 'utf8';
593		724
594	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	725	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
595		726
596	sub verbose {	727	sub verbose {
597	my ($level, $msg) = @_;	728	my ($level, $msg) = @_;
598	warn "$msg\n" if $level <= $verbosity;	729	warn "$msg\n" if $level <= $verbosity;
599	}	730	}
600		731
601	my $extension_pkg = "extension0000";
602	my %extension_pkg;	732	my %extension_pkg;
603		733
604	# load a single script into its own package, once only	734	# load a single script into its own package, once only
605	sub extension_package($) {	735	sub extension_package($) {
606	my ($path) = @_;	736	my ($path) = @_;
607		737
608	$extension_pkg{$path} \|\|= do {	738	$extension_pkg{$path} \|\|= do {
609	my $pkg = "urxvt::" . ($extension_pkg++);	739	$path =~ /([^\/\\]+)$/;
		740	my $pkg = $1;
		741	$pkg =~ s/[^[:word:]]/_/g;
		742	$pkg = "urxvt::ext::$pkg";
610		743
611	verbose 3, "loading extension '$path' into package '$pkg'";	744	verbose 3, "loading extension '$path' into package '$pkg'";
612		745
613	open my $fh, "<:raw", $path	746	open my $fh, "<:raw", $path
614	or die "$path: $!";	747	or die "$path: $!";
615		748
616	my $source = untaint	749	my $source =
617	"package $pkg; use strict; use utf8;\n"	750	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
618	. "use base urxvt::term::extension::;\n"
619	. "#line 1 \"$path\"\n{\n"	751	. "#line 1 \"$path\"\n{\n"
620	. (do { local $/; <$fh> })	752	. (do { local $/; <$fh> })
621	. "\n};\n1";	753	. "\n};\n1";
622		754
623	eval $source	755	eval $source
…		…
637	if ($htype == 0) { # INIT	769	if ($htype == 0) { # INIT
638	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	770	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
639		771
640	my %ext_arg;	772	my %ext_arg;
641		773
		774	{
		775	my @init = @TERM_INIT;
		776	@TERM_INIT = ();
		777	$_->($TERM) for @init;
		778	my @pkg = @TERM_EXT;
		779	@TERM_EXT = ();
		780	$TERM->register_package ($_) for @pkg;
		781	}
		782
642	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	783	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
643	if ($_ eq "default") {	784	if ($_ eq "default") {
644	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	785	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
645	} elsif (/^-(.*)$/) {	786	} elsif (/^-(.*)$/) {
646	delete $ext_arg{$1};	787	delete $ext_arg{$1};
647	} elsif (/^([^<]+)<(.*)>$/) {	788	} elsif (/^([^<]+)<(.*)>$/) {
648	push @{ $ext_arg{$1} }, $2;	789	push @{ $ext_arg{$1} }, $2;
649	} else {	790	} else {
…		…
672	if $verbosity >= 10;	813	if $verbosity >= 10;
673		814
674	keys %$cb;	815	keys %$cb;
675		816
676	while (my ($pkg, $cb) = each %$cb) {	817	while (my ($pkg, $cb) = each %$cb) {
677	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	818	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
678	and last;	819	$retval \|\|= $retval_;
679		820
680	if ($@) {	821	if ($@) {
681	$TERM->ungrab; # better to lose the grab than the session	822	$TERM->ungrab; # better to lose the grab than the session
682	warn $@;	823	warn $@;
683	}	824	}
…		…
694	# clear package	835	# clear package
695	%$TERM = ();	836	%$TERM = ();
696	}	837	}
697		838
698	$retval	839	$retval
699	}
700
701	sub exec_async(@) {
702	my $pid = fork;
703
704	return
705	if !defined $pid or $pid;
706
707	%ENV = %{ $TERM->env };
708
709	exec @_;
710	_exit 255;
711	}	840	}
712		841
713	# urxvt::term::extension	842	# urxvt::term::extension
714		843
715	package urxvt::term::extension;	844	package urxvt::term::extension;
…		…
854	# find on_xxx subs in the package and register them	983	# find on_xxx subs in the package and register them
855	# as hooks	984	# as hooks
856	sub register_package {	985	sub register_package {
857	my ($self, $pkg, $argv) = @_;	986	my ($self, $pkg, $argv) = @_;
858		987
		988	no strict 'refs';
		989
		990	urxvt::verbose 6, "register package $pkg to $self";
		991
		992	@{"$pkg\::ISA"} = urxvt::term::extension::;
		993
859	my $proxy = bless {	994	my $proxy = bless {
860	_pkg => $pkg,	995	_pkg => $pkg,
861	argv => $argv,	996	argv => $argv,
862	}, $pkg;	997	}, $pkg;
863	Scalar::Util::weaken ($proxy->{term} = $self);	998	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
894		1029
895	Destroy the terminal object (close the window, free resources	1030	Destroy the terminal object (close the window, free resources
896	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1031	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
897	watchers (timers, io watchers) are still active.	1032	watchers (timers, io watchers) are still active.
898		1033
		1034	=item $term->exec_async ($cmd[, @args])
		1035
		1036	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1037	("starts") programs in the background. This function takes care of setting
		1038	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1039	be preferred over explicit calls to C<exec> or C<system>.
		1040
		1041	Returns the pid of the subprocess or C<undef> on error.
		1042
		1043	=cut
		1044
		1045	sub exec_async {
		1046	my $self = shift;
		1047
		1048	my $pid = fork;
		1049
		1050	return $pid
		1051	if !defined $pid or $pid;
		1052
		1053	%ENV = %{ $self->env };
		1054
		1055	exec @_;
		1056	urxvt::_exit 255;
		1057	}
		1058
899	=item $isset = $term->option ($optval[, $set])	1059	=item $isset = $term->option ($optval[, $set])
900		1060
901	Returns true if the option specified by C<$optval> is enabled, and	1061	Returns true if the option specified by C<$optval> is enabled, and
902	optionally change it. All option values are stored by name in the hash	1062	optionally change it. All option values are stored by name in the hash
903	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1063	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
905	Here is a a likely non-exhaustive list of option names, please see the	1065	Here is a a likely non-exhaustive list of option names, please see the
906	source file F</src/optinc.h> to see the actual list:	1066	source file F</src/optinc.h> to see the actual list:
907		1067
908	borderLess console cursorBlink cursorUnderline hold iconic insecure	1068	borderLess console cursorBlink cursorUnderline hold iconic insecure
909	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1069	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
910	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1070	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
911	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1071	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
912	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1072	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
913	tripleclickwords utmpInhibit visualBell	1073	transparent tripleclickwords utmpInhibit visualBell
914		1074
915	=item $value = $term->resource ($name[, $newval])	1075	=item $value = $term->resource ($name[, $newval])
916		1076
917	Returns the current resource value associated with a given name and	1077	Returns the current resource value associated with a given name and
918	optionally sets a new value. Setting values is most useful in the C<init>	1078	optionally sets a new value. Setting values is most useful in the C<init>
…		…
935		1095
936	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1096	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
937	borderLess color cursorBlink cursorUnderline cutchars delete_key	1097	borderLess color cursorBlink cursorUnderline cutchars delete_key
938	display_name embed ext_bwidth fade font geometry hold iconName	1098	display_name embed ext_bwidth fade font geometry hold iconName
939	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1099	imFont imLocale inputMethod insecure int_bwidth intensityStyles
940	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1100	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
941	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1101	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
942	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1102	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
943	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1103	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
944	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1104	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
945	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1105	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
946	shade term_name title transparent transparent_all tripleclickwords	1106	secondaryScreen secondaryScroll selectstyle shade term_name title
947	utmpInhibit visualBell	1107	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1108	visualBell
948		1109
949	=cut	1110	=cut
950		1111
951	sub resource($$;$) {	1112	sub resource($$;$) {
952	my ($self, $name) = (shift, shift);	1113	my ($self, $name) = (shift, shift);
…		…
1126		1287
1127	Normally its not a good idea to use this function, as programs might be	1288	Normally its not a good idea to use this function, as programs might be
1128	confused by changes in cursor position or scrolling. Its useful inside a	1289	confused by changes in cursor position or scrolling. Its useful inside a
1129	C<on_add_lines> hook, though.	1290	C<on_add_lines> hook, though.
1130		1291
		1292	=item $term->scr_change_screen ($screen)
		1293
		1294	Switch to given screen - 0 primary, 1 secondary.
		1295
1131	=item $term->cmd_parse ($octets)	1296	=item $term->cmd_parse ($octets)
1132		1297
1133	Similar to C<scr_add_lines>, but the argument must be in the	1298	Similar to C<scr_add_lines>, but the argument must be in the
1134	locale-specific encoding of the terminal and can contain command sequences	1299	locale-specific encoding of the terminal and can contain command sequences
1135	(escape codes) that will be interpreted.	1300	(escape codes) that will be interpreted.
…		…
1182		1347
1183	=item $max_scrollback = $term->saveLines	1348	=item $max_scrollback = $term->saveLines
1184		1349
1185	=item $nrow_plus_saveLines = $term->total_rows	1350	=item $nrow_plus_saveLines = $term->total_rows
1186		1351
1187	=item $lines_in_scrollback = $term->nsaved	1352	=item $topmost_scrollback_row = $term->top_row
1188		1353
1189	Return various integers describing terminal characteristics.	1354	Return various integers describing terminal characteristics.
1190		1355
1191	=item $x_display = $term->display_id	1356	=item $x_display = $term->display_id
1192		1357
…		…
1218	=item $modifiermask = $term->ModNumLockMask	1383	=item $modifiermask = $term->ModNumLockMask
1219		1384
1220	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1385	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1221	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1386	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1222		1387
		1388	=item $screen = $term->current_screen
		1389
		1390	Returns the currently displayed screen (0 primary, 1 secondary).
		1391
		1392	=item $cursor_is_hidden = $term->hidden_cursor
		1393
		1394	Returns wether the cursor is currently hidden or not.
		1395
1223	=item $view_start = $term->view_start ([$newvalue])	1396	=item $view_start = $term->view_start ([$newvalue])
1224		1397
1225	Returns the negative row number of the topmost line. Minimum value is	1398	Returns the row number of the topmost displayed line. Maximum value is
1226	C<0>, which displays the normal terminal contents. Larger values scroll	1399	C<0>, which displays the normal terminal contents. Lower values scroll
1227	this many lines into the scrollback buffer.	1400	this many lines into the scrollback buffer.
1228		1401
1229	=item $term->want_refresh	1402	=item $term->want_refresh
1230		1403
1231	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1404	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1246	line, starting at column C<$start_col> (default C<0>), which is useful	1419	line, starting at column C<$start_col> (default C<0>), which is useful
1247	to replace only parts of a line. The font index in the rendition will	1420	to replace only parts of a line. The font index in the rendition will
1248	automatically be updated.	1421	automatically be updated.
1249		1422
1250	C<$text> is in a special encoding: tabs and wide characters that use more	1423	C<$text> is in a special encoding: tabs and wide characters that use more
1251	than one cell when displayed are padded with urxvt::NOCHAR characters	1424	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1252	(C<chr 65535>). Characters with combining characters and other characters	1425	characters. Characters with combining characters and other characters that
1253	that do not fit into the normal tetx encoding will be replaced with	1426	do not fit into the normal tetx encoding will be replaced with characters
1254	characters in the private use area.	1427	in the private use area.
1255		1428
1256	You have to obey this encoding when changing text. The advantage is	1429	You have to obey this encoding when changing text. The advantage is
1257	that C<substr> and similar functions work on screen cells and not on	1430	that C<substr> and similar functions work on screen cells and not on
1258	characters.	1431	characters.
1259		1432
…		…
1434		1607
1435	Calls XUngrab for the most recent grab. Is called automatically on	1608	Calls XUngrab for the most recent grab. Is called automatically on
1436	evaluation errors, as it is better to lose the grab in the error case as	1609	evaluation errors, as it is better to lose the grab in the error case as
1437	the session.	1610	the session.
1438		1611
		1612	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1613
		1614	=item $atom_name = $term->XGetAtomName ($atom)
		1615
		1616	=item @atoms = $term->XListProperties ($window)
		1617
		1618	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1619
		1620	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1621
		1622	=item $term->XDeleteProperty ($window, $property)
		1623
		1624	=item $window = $term->DefaultRootWindow
		1625
		1626	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1627
		1628	=item $term->XMapWindow ($window)
		1629
		1630	=item $term->XUnmapWindow ($window)
		1631
		1632	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1633
		1634	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1635
		1636	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1637
		1638	Various X or X-related functions. The C<$term> object only serves as
		1639	the source of the display, otherwise those functions map more-or-less
		1640	directory onto the X functions of the same name.
		1641
1439	=back	1642	=back
1440		1643
1441	=cut	1644	=cut
1442		1645
1443	package urxvt::popup;	1646	package urxvt::popup;
…		…
1544	my $env = $self->{term}->env;	1747	my $env = $self->{term}->env;
1545	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1748	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1546	delete $env->{LC_ALL};	1749	delete $env->{LC_ALL};
1547	$env->{LC_CTYPE} = $self->{term}->locale;	1750	$env->{LC_CTYPE} = $self->{term}->locale;
1548		1751
1549	urxvt::term->new ($env, $self->{term}->resource ("name"),	1752	urxvt::term->new ($env, "popup",
1550	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1753	"--perl-lib" => "", "--perl-ext-common" => "",
		1754	"-pty-fd" => -1, "-sl" => 0,
		1755	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1551	"--transient-for" => $self->{term}->parent,	1756	"--transient-for" => $self->{term}->parent,
1552	"-display" => $self->{term}->display_id,	1757	"-display" => $self->{term}->display_id,
1553	"-pe" => "urxvt-popup")	1758	"-pe" => "urxvt-popup")
1554	or die "unable to create popup window\n";	1759	or die "unable to create popup window\n";
1555	}	1760	}
…		…
1560	delete $self->{term}{_destroy}{$self};	1765	delete $self->{term}{_destroy}{$self};
1561	$self->{term}->ungrab;	1766	$self->{term}->ungrab;
1562	}	1767	}
1563		1768
1564	=back	1769	=back
		1770
		1771	=cut
		1772
		1773	package urxvt::watcher;
		1774
		1775	@urxvt::timer::ISA = __PACKAGE__;
		1776	@urxvt::iow::ISA = __PACKAGE__;
		1777	@urxvt::pw::ISA = __PACKAGE__;
		1778	@urxvt::iw::ISA = __PACKAGE__;
1565		1779
1566	=head2 The C<urxvt::timer> Class	1780	=head2 The C<urxvt::timer> Class
1567		1781
1568	This class implements timer watchers/events. Time is represented as a	1782	This class implements timer watchers/events. Time is represented as a
1569	fractional number of seconds since the epoch. Example:	1783	fractional number of seconds since the epoch. Example:
…		…
1607	Start the timer.	1821	Start the timer.
1608		1822
1609	=item $timer = $timer->start ($tstamp)	1823	=item $timer = $timer->start ($tstamp)
1610		1824
1611	Set the event trigger time to C<$tstamp> and start the timer.	1825	Set the event trigger time to C<$tstamp> and start the timer.
		1826
		1827	=item $timer = $timer->after ($delay)
		1828
		1829	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1612		1830
1613	=item $timer = $timer->stop	1831	=item $timer = $timer->stop
1614		1832
1615	Stop the timer.	1833	Stop the timer.
1616		1834
…		…
1663		1881
1664	Stop watching for events on the given filehandle.	1882	Stop watching for events on the given filehandle.
1665		1883
1666	=back	1884	=back
1667		1885
		1886	=head2 The C<urxvt::iw> Class
		1887
		1888	This class implements idle watchers, that get called automatically when
		1889	the process is idle. They should return as fast as possible, after doing
		1890	some useful work.
		1891
		1892	=over 4
		1893
		1894	=item $iw = new urxvt::iw
		1895
		1896	Create a new idle watcher object in stopped state.
		1897
		1898	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1899
		1900	Set the callback to be called when the watcher triggers.
		1901
		1902	=item $timer = $timer->start
		1903
		1904	Start the watcher.
		1905
		1906	=item $timer = $timer->stop
		1907
		1908	Stop the watcher.
		1909
		1910	=back
		1911
		1912	=head2 The C<urxvt::pw> Class
		1913
		1914	This class implements process watchers. They create an event whenever a
		1915	process exits, after which they stop automatically.
		1916
		1917	my $pid = fork;
		1918	...
		1919	$term->{pw} = urxvt::pw
		1920	->new
		1921	->start ($pid)
		1922	->cb (sub {
		1923	my ($pw, $exit_status) = @_;
		1924	...
		1925	});
		1926
		1927	=over 4
		1928
		1929	=item $pw = new urxvt::pw
		1930
		1931	Create a new process watcher in stopped state.
		1932
		1933	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1934
		1935	Set the callback to be called when the timer triggers.
		1936
		1937	=item $pw = $timer->start ($pid)
		1938
		1939	Tells the wqtcher to start watching for process C<$pid>.
		1940
		1941	=item $pw = $pw->stop
		1942
		1943	Stop the watcher.
		1944
		1945	=back
		1946
1668	=head1 ENVIRONMENT	1947	=head1 ENVIRONMENT
1669		1948
1670	=head2 URXVT_PERL_VERBOSITY	1949	=head2 URXVT_PERL_VERBOSITY
1671		1950
1672	This variable controls the verbosity level of the perl extension. Higher	1951	This variable controls the verbosity level of the perl extension. Higher

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.92 by root, Fri Jan 13 04:59:04 2006 UTC vs. Revision 1.124 by root, Sun Jan 22 11:57:06 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.92 by root, Fri Jan 13 04:59:04 2006 UTC vs.
Revision 1.124 by root, Sun Jan 22 11:57:06 2006 UTC