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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.97 by elmex, Tue Jan 17 16:53:47 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.
		104
		105	Other extensions can extend this popup menu by pushing a code reference
		106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		107	popup is displayed.
		108
		109	It's sole argument is the popup menu, which can be modified. The selection
		110	is in C<$_>, which can be used to decide wether to add something or not.
		111	It should either return nothing or a string and a code reference. The
		112	string will be used as button text and the code reference will be called
		113	when the button gets activated and should transform C<$_>.
		114
		115	The following will add an entry C<a to b> that transforms all C<a>s in
		116	the selection to C<b>s, but only if the selection currently contains any
		117	C<a>s:
		118
		119	push @{ $self->{term}{selection_popup_hook} }, sub {
		120	/a/ ? ("a to be" => sub { s/a/b/g }
		121	: ()
		122	};
93		123
94	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
95		125
96	Adds regex search functionality to the scrollback buffer, triggered	126	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	127	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	134	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	135	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	136	additionally stores the first match in the current line into the primary
107	selection.	137	selection.
108		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
109	=item selection-autotransform	164	=item selection-autotransform
110		165
111	This selection allows you to do automatic transforms on a selection	166	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	167	whenever a selection is made.
113		168
…		…
125	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/
126		181
127	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
128	paste directly into your (vi :) editor:	183	paste directly into your (vi :) editor:
129		184
130	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/
131		186
132	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 :)
133		188
134	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
135	FILENAME line YYY."), you need a slightly more elaborate solution:	190	FILENAME line YYY."), you need a slightly more elaborate solution:
136		191
137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138	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/
139		194
140	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
141	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
142	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.
143		209
144	=item mark-urls	210	=item mark-urls
145		211
146	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
147	make them clickable. When middle-clicked, the program specified in the	213	make them clickable. When middle-clicked, the program specified in the
148	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
149	the URL as first argument.	215	the URL as first argument.
150		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
		228
		229	=item automove-background
		230
		231	This is basically a one-line extension that dynamically changes the background pixmap offset
		232	to the window position, in effect creating the same effect as pseudo transparency with
		233	a custom pixmap. No scaling is supported in this mode. Exmaple:
		234
		235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		236
151	=item block-graphics-to-ascii	237	=item block-graphics-to-ascii
152		238
153	A not very useful example of filtering all text output to the terminal,	239	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	240	by replacing all line-drawing characters (U+2500 .. U+259F) by a
155	similar-looking ascii character.	241	similar-looking ascii character.
…		…
164	window. Illustrates overwriting the refresh callbacks to create your own	250	window. Illustrates overwriting the refresh callbacks to create your own
165	overlays or changes.	251	overlays or changes.
166		252
167	=item selection-pastebin	253	=item selection-pastebin
168		254
169	Uploads the selection as textfile to a remote site.	255	This is a little rarely useful extension that Uploads the selection as
		256	textfile to a remote site (or does other things). (The implementation is
		257	not currently secure for use in a multiuser environment as it writes to
		258	F</tmp> directly.).
		259
		260	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		261	i.e.
170		262
171	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin	263	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
172		264
173	To set the command to upload the file set this resource:	265	Pressing this combination runs a command with C<%> replaced by the name of
		266	the textfile. This command can be set via a resource:
174		267
175	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.	268	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
176		269
177	The % is the placeholder for the textfile. The name of the textfile is the hex encoded	270	And the default is likely not useful to anybody but the few people around
178	md5 sum of the selection.	271	here :)
		272
		273	The name of the textfile is the hex encoded md5 sum of the selection, so
		274	the same content should lead to the same filename.
		275
179	After an successful upload the selection will be replaced by the following url	276	After a successful upload the selection will be replaced by the text given
180	(the % is the placeholder for the filename):	277	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		278	for the filename):
181		279
182	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%	280	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
183		281
184	=back	282	=back
185		283
186	=head1 API DOCUMENTATION	284	=head1 API DOCUMENTATION
187		285
…		…
260	called whenever the relevant event happens.	358	called whenever the relevant event happens.
261		359
262	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
263	the in the C<Extension Objects> section.	361	the in the C<Extension Objects> section.
264		362
265	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
266	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
267	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.
268		366
269	I<< When in doubt, return a false value (preferably C<()>). >>	367	I<< When in doubt, return a false value (preferably C<()>). >>
270		368
271	=over 4	369	=over 4
272		370
273	=item on_init $term	371	=item on_init $term
274		372
275	Called after a new terminal object has been initialized, but before	373	Called after a new terminal object has been initialized, but before
276	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
277	call or deliver senseless data, as terminal size and other characteristics	375	call or deliver senseless data, as terminal size and other characteristics
278	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
279	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).
280		389
281	=item on_reset $term	390	=item on_reset $term
282		391
283	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
284	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
285	variables.	394	variables.
286		395
287	=item on_start $term	396	=item on_child_start $term, $pid
288		397
289	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.
290	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>.
291		404
292	=item on_sel_make $term, $eventtime	405	=item on_sel_make $term, $eventtime
293		406
294	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
295	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
…		…
404	=item on_focus_out $term	517	=item on_focus_out $term
405		518
406	Called wheneever the window loses keyboard focus, before rxvt-unicode does	519	Called wheneever the window loses keyboard focus, before rxvt-unicode does
407	focus out processing.	520	focus out processing.
408		521
		522	=item on_configure_notify $term, $event
		523
		524	=item on_property_notify $term, $event
		525
409	=item on_key_press $term, $event, $keysym, $octets	526	=item on_key_press $term, $event, $keysym, $octets
410		527
411	=item on_key_release $term, $event, $keysym	528	=item on_key_release $term, $event, $keysym
412		529
413	=item on_button_press $term, $event	530	=item on_button_press $term, $event
…		…
422		539
423	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
424	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.
425		542
426	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
427	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
428	and column under the mouse cursor.	545	(real, not screen-based) row and column under the mouse cursor.
429		546
430	C<on_key_press> additionally receives the string rxvt-unicode would	547	C<on_key_press> additionally receives the string rxvt-unicode would
431	output, if any, in locale-specific encoding.	548	output, if any, in locale-specific encoding.
432		549
433	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).
434		560
435	=back	561	=back
436		562
437	=cut	563	=cut
438		564
…		…
444	use Scalar::Util ();	570	use Scalar::Util ();
445	use List::Util ();	571	use List::Util ();
446		572
447	our $VERSION = 1;	573	our $VERSION = 1;
448	our $TERM;	574	our $TERM;
		575	our @TERM_INIT;
		576	our @TERM_EXT;
449	our @HOOKNAME;	577	our @HOOKNAME;
450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	578	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451	our %OPTION;	579	our %OPTION;
452		580
453	our $LIBDIR;	581	our $LIBDIR;
454	our $RESNAME;	582	our $RESNAME;
455	our $RESCLASS;	583	our $RESCLASS;
456	our $RXVTNAME;	584	our $RXVTNAME;
457		585
		586	our $NOCHAR = chr 0xffff;
		587
458	=head2 Variables in the C<urxvt> Package	588	=head2 Variables in the C<urxvt> Package
459		589
460	=over 4	590	=over 4
461		591
462	=item $urxvt::LIBDIR	592	=item $urxvt::LIBDIR
…		…
474		604
475	=item $urxvt::TERM	605	=item $urxvt::TERM
476		606
477	The current terminal. This variable stores the current C<urxvt::term>	607	The current terminal. This variable stores the current C<urxvt::term>
478	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>.
479		625
480	=back	626	=back
481		627
482	=head2 Functions in the C<urxvt> Package	628	=head2 Functions in the C<urxvt> Package
483		629
…		…
583	=back	729	=back
584		730
585	=cut	731	=cut
586		732
587	BEGIN {	733	BEGIN {
588	urxvt->bootstrap;
589
590	# overwrite perl's warn	734	# overwrite perl's warn
591	*CORE::GLOBAL::warn = sub {	735	*CORE::GLOBAL::warn = sub {
592	my $msg = join "", @_;	736	my $msg = join "", @_;
593	$msg .= "\n"	737	$msg .= "\n"
594	unless $msg =~ /\n$/;	738	unless $msg =~ /\n$/;
595	urxvt::warn ($msg);	739	urxvt::warn ($msg);
596	};	740	};
597
598	# %ENV is the original startup environment
599	delete $ENV{IFS};
600	delete $ENV{CDPATH};
601	delete $ENV{BASH_ENV};
602	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
603	}	741	}
		742
		743	no warnings 'utf8';
604		744
605	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	745	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
606		746
607	sub verbose {	747	sub verbose {
608	my ($level, $msg) = @_;	748	my ($level, $msg) = @_;
609	warn "$msg\n" if $level <= $verbosity;	749	warn "$msg\n" if $level <= $verbosity;
610	}	750	}
611		751
612	my $extension_pkg = "extension0000";
613	my %extension_pkg;	752	my %extension_pkg;
614		753
615	# load a single script into its own package, once only	754	# load a single script into its own package, once only
616	sub extension_package($) {	755	sub extension_package($) {
617	my ($path) = @_;	756	my ($path) = @_;
618		757
619	$extension_pkg{$path} \|\|= do {	758	$extension_pkg{$path} \|\|= do {
620	my $pkg = "urxvt::" . ($extension_pkg++);	759	$path =~ /([^\/\\]+)$/;
		760	my $pkg = $1;
		761	$pkg =~ s/[^[:word:]]/_/g;
		762	$pkg = "urxvt::ext::$pkg";
621		763
622	verbose 3, "loading extension '$path' into package '$pkg'";	764	verbose 3, "loading extension '$path' into package '$pkg'";
623		765
624	open my $fh, "<:raw", $path	766	open my $fh, "<:raw", $path
625	or die "$path: $!";	767	or die "$path: $!";
626		768
627	my $source =	769	my $source =
628	"package $pkg; use strict; use utf8;\n"	770	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
629	. "use base urxvt::term::extension::;\n"
630	. "#line 1 \"$path\"\n{\n"	771	. "#line 1 \"$path\"\n{\n"
631	. (do { local $/; <$fh> })	772	. (do { local $/; <$fh> })
632	. "\n};\n1";	773	. "\n};\n1";
633		774
634	eval $source	775	eval $source
…		…
648	if ($htype == 0) { # INIT	789	if ($htype == 0) { # INIT
649	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	790	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
650		791
651	my %ext_arg;	792	my %ext_arg;
652		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
653	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	803	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
654	if ($_ eq "default") {	804	if ($_ eq "default") {
655	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	805	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
656	} elsif (/^-(.*)$/) {	806	} elsif (/^-(.*)$/) {
657	delete $ext_arg{$1};	807	delete $ext_arg{$1};
658	} elsif (/^([^<]+)<(.*)>$/) {	808	} elsif (/^([^<]+)<(.*)>$/) {
659	push @{ $ext_arg{$1} }, $2;	809	push @{ $ext_arg{$1} }, $2;
660	} else {	810	} else {
…		…
683	if $verbosity >= 10;	833	if $verbosity >= 10;
684		834
685	keys %$cb;	835	keys %$cb;
686		836
687	while (my ($pkg, $cb) = each %$cb) {	837	while (my ($pkg, $cb) = each %$cb) {
688	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	838	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
689	and last;	839	$retval \|\|= $retval_;
690		840
691	if ($@) {	841	if ($@) {
692	$TERM->ungrab; # better to lose the grab than the session	842	$TERM->ungrab; # better to lose the grab than the session
693	warn $@;	843	warn $@;
694	}	844	}
…		…
705	# clear package	855	# clear package
706	%$TERM = ();	856	%$TERM = ();
707	}	857	}
708		858
709	$retval	859	$retval
710	}
711
712	sub exec_async(@) {
713	my $pid = fork;
714
715	return
716	if !defined $pid or $pid;
717
718	%ENV = %{ $TERM->env };
719
720	exec @_;
721	_exit 255;
722	}	860	}
723		861
724	# urxvt::term::extension	862	# urxvt::term::extension
725		863
726	package urxvt::term::extension;	864	package urxvt::term::extension;
…		…
865	# find on_xxx subs in the package and register them	1003	# find on_xxx subs in the package and register them
866	# as hooks	1004	# as hooks
867	sub register_package {	1005	sub register_package {
868	my ($self, $pkg, $argv) = @_;	1006	my ($self, $pkg, $argv) = @_;
869		1007
		1008	no strict 'refs';
		1009
		1010	urxvt::verbose 6, "register package $pkg to $self";
		1011
		1012	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1013
870	my $proxy = bless {	1014	my $proxy = bless {
871	_pkg => $pkg,	1015	_pkg => $pkg,
872	argv => $argv,	1016	argv => $argv,
873	}, $pkg;	1017	}, $pkg;
874	Scalar::Util::weaken ($proxy->{term} = $self);	1018	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
905		1049
906	Destroy the terminal object (close the window, free resources	1050	Destroy the terminal object (close the window, free resources
907	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
908	watchers (timers, io watchers) are still active.	1052	watchers (timers, io watchers) are still active.
909		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	}
		1078
910	=item $isset = $term->option ($optval[, $set])	1079	=item $isset = $term->option ($optval[, $set])
911		1080
912	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
913	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
914	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1083	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
916	Here is a a likely non-exhaustive list of option names, please see the	1085	Here is a a likely non-exhaustive list of option names, please see the
917	source file F</src/optinc.h> to see the actual list:	1086	source file F</src/optinc.h> to see the actual list:
918		1087
919	borderLess console cursorBlink cursorUnderline hold iconic insecure	1088	borderLess console cursorBlink cursorUnderline hold iconic insecure
920	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1089	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
921	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1090	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
922	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1091	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
923	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1092	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
924	tripleclickwords utmpInhibit visualBell	1093	transparent tripleclickwords utmpInhibit visualBell
925		1094
926	=item $value = $term->resource ($name[, $newval])	1095	=item $value = $term->resource ($name[, $newval])
927		1096
928	Returns the current resource value associated with a given name and	1097	Returns the current resource value associated with a given name and
929	optionally sets a new value. Setting values is most useful in the C<init>	1098	optionally sets a new value. Setting values is most useful in the C<init>
…		…
946		1115
947	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1116	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
948	borderLess color cursorBlink cursorUnderline cutchars delete_key	1117	borderLess color cursorBlink cursorUnderline cutchars delete_key
949	display_name embed ext_bwidth fade font geometry hold iconName	1118	display_name embed ext_bwidth fade font geometry hold iconName
950	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1119	imFont imLocale inputMethod insecure int_bwidth intensityStyles
951	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1120	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
952	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1121	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
953	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1122	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
954	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1123	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
955	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1124	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
956	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1125	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
957	shade term_name title transparent transparent_all tripleclickwords	1126	secondaryScreen secondaryScroll selectstyle shade term_name title
958	utmpInhibit visualBell	1127	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1128	visualBell
959		1129
960	=cut	1130	=cut
961		1131
962	sub resource($$;$) {	1132	sub resource($$;$) {
963	my ($self, $name) = (shift, shift);	1133	my ($self, $name) = (shift, shift);
…		…
1137		1307
1138	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
1139	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
1140	C<on_add_lines> hook, though.	1310	C<on_add_lines> hook, though.
1141		1311
		1312	=item $term->scr_change_screen ($screen)
		1313
		1314	Switch to given screen - 0 primary, 1 secondary.
		1315
1142	=item $term->cmd_parse ($octets)	1316	=item $term->cmd_parse ($octets)
1143		1317
1144	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
1145	locale-specific encoding of the terminal and can contain command sequences	1319	locale-specific encoding of the terminal and can contain command sequences
1146	(escape codes) that will be interpreted.	1320	(escape codes) that will be interpreted.
…		…
1155		1329
1156	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
1157	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
1158	description of C<< urxvt::timer->events >>. Make sure to always restore	1332	description of C<< urxvt::timer->events >>. Make sure to always restore
1159	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.
1160		1339
1161	=item $windowid = $term->parent	1340	=item $windowid = $term->parent
1162		1341
1163	Return the window id of the toplevel window.	1342	Return the window id of the toplevel window.
1164		1343
…		…
1229	=item $modifiermask = $term->ModNumLockMask	1408	=item $modifiermask = $term->ModNumLockMask
1230		1409
1231	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
1232	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.
1233		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
1234	=item $view_start = $term->view_start ([$newvalue])	1421	=item $view_start = $term->view_start ([$newvalue])
1235		1422
1236	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
1237	C<0>, which displays the normal terminal contents. Lower values scroll	1424	C<0>, which displays the normal terminal contents. Lower values scroll
1238	this many lines into the scrollback buffer.	1425	this many lines into the scrollback buffer.
…		…
1257	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
1258	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
1259	automatically be updated.	1446	automatically be updated.
1260		1447
1261	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
1262	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)
1263	(C<chr 65535>). Characters with combining characters and other characters	1450	characters. Characters with combining characters and other characters that
1264	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
1265	characters in the private use area.	1452	in the private use area.
1266		1453
1267	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
1268	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
1269	characters.	1456	characters.
1270		1457
…		…
1445		1632
1446	Calls XUngrab for the most recent grab. Is called automatically on	1633	Calls XUngrab for the most recent grab. Is called automatically on
1447	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
1448	the session.	1635	the session.
1449		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.
		1666
1450	=back	1667	=back
1451		1668
1452	=cut	1669	=cut
1453		1670
1454	package urxvt::popup;	1671	package urxvt::popup;
…		…
1555	my $env = $self->{term}->env;	1772	my $env = $self->{term}->env;
1556	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1773	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1557	delete $env->{LC_ALL};	1774	delete $env->{LC_ALL};
1558	$env->{LC_CTYPE} = $self->{term}->locale;	1775	$env->{LC_CTYPE} = $self->{term}->locale;
1559		1776
1560	urxvt::term->new ($env, $self->{term}->resource ("name"),	1777	urxvt::term->new ($env, "popup",
1561	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1778	"--perl-lib" => "", "--perl-ext-common" => "",
		1779	"-pty-fd" => -1, "-sl" => 0,
		1780	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1562	"--transient-for" => $self->{term}->parent,	1781	"--transient-for" => $self->{term}->parent,
1563	"-display" => $self->{term}->display_id,	1782	"-display" => $self->{term}->display_id,
1564	"-pe" => "urxvt-popup")	1783	"-pe" => "urxvt-popup")
1565	or die "unable to create popup window\n";	1784	or die "unable to create popup window\n";
1566	}	1785	}
…		…
1571	delete $self->{term}{_destroy}{$self};	1790	delete $self->{term}{_destroy}{$self};
1572	$self->{term}->ungrab;	1791	$self->{term}->ungrab;
1573	}	1792	}
1574		1793
1575	=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__;
1576		1804
1577	=head2 The C<urxvt::timer> Class	1805	=head2 The C<urxvt::timer> Class
1578		1806
1579	This class implements timer watchers/events. Time is represented as a	1807	This class implements timer watchers/events. Time is represented as a
1580	fractional number of seconds since the epoch. Example:	1808	fractional number of seconds since the epoch. Example:
…		…
1618	Start the timer.	1846	Start the timer.
1619		1847
1620	=item $timer = $timer->start ($tstamp)	1848	=item $timer = $timer->start ($tstamp)
1621		1849
1622	Set the event trigger time to C<$tstamp> and start the timer.	1850	Set the event trigger time to C<$tstamp> and start the timer.
		1851
		1852	=item $timer = $timer->after ($delay)
		1853
		1854	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1623		1855
1624	=item $timer = $timer->stop	1856	=item $timer = $timer->stop
1625		1857
1626	Stop the timer.	1858	Stop the timer.
1627		1859
…		…
1674		1906
1675	Stop watching for events on the given filehandle.	1907	Stop watching for events on the given filehandle.
1676		1908
1677	=back	1909	=back
1678		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
1679	=head1 ENVIRONMENT	1972	=head1 ENVIRONMENT
1680		1973
1681	=head2 URXVT_PERL_VERBOSITY	1974	=head2 URXVT_PERL_VERBOSITY
1682		1975
1683	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.97 by elmex, Tue Jan 17 16:53:47 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.97 by elmex, Tue Jan 17 16:53:47 2006 UTC vs.
Revision 1.128 by root, Wed Jan 25 00:57:57 2006 UTC