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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.96 by root, Tue Jan 17 16:22:41 2006 UTC vs.
Revision 1.126 by root, Tue Jan 24 19:14:36 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
…		…
76		87
77	Rot-13 the selection when activated. Used via keyboard trigger:	88	Rot-13 the selection when activated. Used via keyboard trigger:
78		89
79	URxvt.keysym.C-M-r: perl:selection:rot13	90	URxvt.keysym.C-M-r: perl:selection:rot13
80		91
81	=item remote-pastebin
82
83	Upload the selection as textfile to a remote site.
84
85	URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87	To set the command to upload the file set this resource:
88
89	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92	md5 sum of the selection.
93	After an successful upload the selection will be replaced by the following url
94	(the % is the placeholder for the filename):
95
96	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
97
98	=back	92	=back
99		93
100	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
101		95
102	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
…		…
104		98
105	=item selection-popup (enabled by default)	99	=item selection-popup (enabled by default)
106		100
107	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
108	text into various other formats/action (such as uri unescaping, perl	102	text into various other formats/action (such as uri unescaping, perl
109	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	};
110		123
111	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
112		125
113	Adds regex search functionality to the scrollback buffer, triggered	126	Adds regex search functionality to the scrollback buffer, triggered
114	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
…		…
121	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
122	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
123	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
124	selection.	137	selection.
125		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
126	=item selection-autotransform	164	=item selection-autotransform
127		165
128	This selection allows you to do automatic transforms on a selection	166	This selection allows you to do automatic transforms on a selection
129	whenever a selection is made.	167	whenever a selection is made.
130		168
…		…
142	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/
143		181
144	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
145	paste directly into your (vi :) editor:	183	paste directly into your (vi :) editor:
146		184
147	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/
148		186
149	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 :)
150		188
151	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
152	FILENAME line YYY."), you need a slightly more elaborate solution:	190	FILENAME line YYY."), you need a slightly more elaborate solution:
153		191
154	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
155	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/
156		194
157	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
158	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
159	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.
160		209
161	=item mark-urls	210	=item mark-urls
162		211
163	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
164	make them clickable. When middle-clicked, the program specified in the	213	make them clickable. When middle-clicked, the program specified in the
165	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
166	the URL as first argument.	215	the URL as first argument.
167		216
		217	=item automove-background
		218
		219	This is basically a one-line extension that dynamically changes the background pixmap offset
		220	to the window position, in effect creating the same effect as pseudo transparency with
		221	a custom pixmap. No scaling is supported in this mode. Exmaple:
		222
		223	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		224
168	=item block-graphics-to-ascii	225	=item block-graphics-to-ascii
169		226
170	A not very useful example of filtering all text output to the terminal,	227	A not very useful example of filtering all text output to the terminal,
171	by replacing all line-drawing characters (U+2500 .. U+259F) by a	228	by replacing all line-drawing characters (U+2500 .. U+259F) by a
172	similar-looking ascii character.	229	similar-looking ascii character.
…		…
178	=item example-refresh-hooks	235	=item example-refresh-hooks
179		236
180	Displays a very simple digital clock in the upper right corner of the	237	Displays a very simple digital clock in the upper right corner of the
181	window. Illustrates overwriting the refresh callbacks to create your own	238	window. Illustrates overwriting the refresh callbacks to create your own
182	overlays or changes.	239	overlays or changes.
		240
		241	=item selection-pastebin
		242
		243	This is a little rarely useful extension that Uploads the selection as
		244	textfile to a remote site (or does other things). (The implementation is
		245	not currently secure for use in a multiuser environment as it writes to
		246	F</tmp> directly.).
		247
		248	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		249	i.e.
		250
		251	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		252
		253	Pressing this combination runs a command with C<%> replaced by the name of
		254	the textfile. This command can be set via a resource:
		255
		256	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		257
		258	And the default is likely not useful to anybody but the few people around
		259	here :)
		260
		261	The name of the textfile is the hex encoded md5 sum of the selection, so
		262	the same content should lead to the same filename.
		263
		264	After a successful upload the selection will be replaced by the text given
		265	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		266	for the filename):
		267
		268	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
183		269
184	=back	270	=back
185		271
186	=head1 API DOCUMENTATION	272	=head1 API DOCUMENTATION
187		273
…		…
260	called whenever the relevant event happens.	346	called whenever the relevant event happens.
261		347
262	The first argument passed to them is an extension oject as described in	348	The first argument passed to them is an extension oject as described in
263	the in the C<Extension Objects> section.	349	the in the C<Extension Objects> section.
264		350
265	B<All> of these hooks must return a boolean value. If it is true, then the	351	B<All> of these hooks must return a boolean value. If any of the called
266	event counts as being I<consumed>, and the invocation of other hooks is	352	hooks returns true, then the event counts as being I<consumed>, and the
267	skipped, and the relevant action might not be carried out by the C++ code.	353	relevant action might not be carried out by the C++ code.
268		354
269	I<< When in doubt, return a false value (preferably C<()>). >>	355	I<< When in doubt, return a false value (preferably C<()>). >>
270		356
271	=over 4	357	=over 4
272		358
273	=item on_init $term	359	=item on_init $term
274		360
275	Called after a new terminal object has been initialized, but before	361	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	362	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	363	call or deliver senseless data, as terminal size and other characteristics
278	have not yet been determined. You can safely query and change resources,	364	have not yet been determined. You can safely query and change resources
279	though.	365	and options, though. For many purposes the C<on_start> hook is a better
		366	place.
		367
		368	=item on_start $term
		369
		370	Called at the very end of initialisation of a new terminal, just before
		371	trying to map (display) the toplevel and returning to the mainloop.
		372
		373	=item on_destroy $term
		374
		375	Called whenever something tries to destroy terminal, before doing anything
		376	yet. If this hook returns true, then destruction is skipped, but this is
		377	rarely a good idea.
280		378
281	=item on_reset $term	379	=item on_reset $term
282		380
283	Called after the screen is "reset" for any reason, such as resizing or	381	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	382	control sequences. Here is where you can react on changes to size-related
285	variables.	383	variables.
286		384
287	=item on_start $term	385	=item on_child_start $term, $pid
288		386
289	Called at the very end of initialisation of a new terminal, just before	387	Called just after the child process has been C<fork>ed.
290	returning to the mainloop.	388
		389	=item on_child_exit $term, $status
		390
		391	Called just after the child process has exited. C<$status> is the status
		392	from C<waitpid>.
291		393
292	=item on_sel_make $term, $eventtime	394	=item on_sel_make $term, $eventtime
293		395
294	Called whenever a selection has been made by the user, but before the	396	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	397	selection text is copied, so changes to the beginning, end or type of the
…		…
404	=item on_focus_out $term	506	=item on_focus_out $term
405		507
406	Called wheneever the window loses keyboard focus, before rxvt-unicode does	508	Called wheneever the window loses keyboard focus, before rxvt-unicode does
407	focus out processing.	509	focus out processing.
408		510
		511	=item on_configure_notify $term, $event
		512
		513	=item on_property_notify $term, $event
		514
409	=item on_key_press $term, $event, $keysym, $octets	515	=item on_key_press $term, $event, $keysym, $octets
410		516
411	=item on_key_release $term, $event, $keysym	517	=item on_key_release $term, $event, $keysym
412		518
413	=item on_button_press $term, $event	519	=item on_button_press $term, $event
…		…
422		528
423	Called whenever the corresponding X event is received for the terminal If	529	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.	530	the hook returns true, then the even will be ignored by rxvt-unicode.
425		531
426	The event is a hash with most values as named by Xlib (see the XEvent	532	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	533	manpage), with the additional members C<row> and C<col>, which are the
428	and column under the mouse cursor.	534	(real, not screen-based) row and column under the mouse cursor.
429		535
430	C<on_key_press> additionally receives the string rxvt-unicode would	536	C<on_key_press> additionally receives the string rxvt-unicode would
431	output, if any, in locale-specific encoding.	537	output, if any, in locale-specific encoding.
432		538
433	subwindow.	539	subwindow.
		540
		541	=item on_client_message $term, $event
		542
		543	=item on_wm_protocols $term, $event
		544
		545	=item on_wm_delete_window $term, $event
		546
		547	Called when various types of ClientMessage events are received (all with
		548	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
434		549
435	=back	550	=back
436		551
437	=cut	552	=cut
438		553
…		…
444	use Scalar::Util ();	559	use Scalar::Util ();
445	use List::Util ();	560	use List::Util ();
446		561
447	our $VERSION = 1;	562	our $VERSION = 1;
448	our $TERM;	563	our $TERM;
		564	our @TERM_INIT;
		565	our @TERM_EXT;
449	our @HOOKNAME;	566	our @HOOKNAME;
450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	567	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451	our %OPTION;	568	our %OPTION;
452		569
453	our $LIBDIR;	570	our $LIBDIR;
454	our $RESNAME;	571	our $RESNAME;
455	our $RESCLASS;	572	our $RESCLASS;
456	our $RXVTNAME;	573	our $RXVTNAME;
457		574
		575	our $NOCHAR = chr 0xffff;
		576
458	=head2 Variables in the C<urxvt> Package	577	=head2 Variables in the C<urxvt> Package
459		578
460	=over 4	579	=over 4
461		580
462	=item $urxvt::LIBDIR	581	=item $urxvt::LIBDIR
…		…
474		593
475	=item $urxvt::TERM	594	=item $urxvt::TERM
476		595
477	The current terminal. This variable stores the current C<urxvt::term>	596	The current terminal. This variable stores the current C<urxvt::term>
478	object, whenever a callback/hook is executing.	597	object, whenever a callback/hook is executing.
		598
		599	=item @urxvt::TERM_INIT
		600
		601	All coderefs in this array will be called as methods of the next newly
		602	created C<urxvt::term> object (during the C<on_init> phase). The array
		603	gets cleared before the codereferences that were in it are being executed,
		604	so coderefs can push themselves onto it again if they so desire.
		605
		606	This complements to the perl-eval commandline option, but gets executed
		607	first.
		608
		609	=item @urxvt::TERM_EXT
		610
		611	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		612	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		613	but before other extensions. Gets cleared just like C<@TERM_INIT>.
479		614
480	=back	615	=back
481		616
482	=head2 Functions in the C<urxvt> Package	617	=head2 Functions in the C<urxvt> Package
483		618
…		…
583	=back	718	=back
584		719
585	=cut	720	=cut
586		721
587	BEGIN {	722	BEGIN {
588	urxvt->bootstrap;
589
590	# overwrite perl's warn	723	# overwrite perl's warn
591	*CORE::GLOBAL::warn = sub {	724	*CORE::GLOBAL::warn = sub {
592	my $msg = join "", @_;	725	my $msg = join "", @_;
593	$msg .= "\n"	726	$msg .= "\n"
594	unless $msg =~ /\n$/;	727	unless $msg =~ /\n$/;
595	urxvt::warn ($msg);	728	urxvt::warn ($msg);
596	};	729	};
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	}	730	}
		731
		732	no warnings 'utf8';
604		733
605	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	734	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
606		735
607	sub verbose {	736	sub verbose {
608	my ($level, $msg) = @_;	737	my ($level, $msg) = @_;
609	warn "$msg\n" if $level <= $verbosity;	738	warn "$msg\n" if $level <= $verbosity;
610	}	739	}
611		740
612	my $extension_pkg = "extension0000";
613	my %extension_pkg;	741	my %extension_pkg;
614		742
615	# load a single script into its own package, once only	743	# load a single script into its own package, once only
616	sub extension_package($) {	744	sub extension_package($) {
617	my ($path) = @_;	745	my ($path) = @_;
618		746
619	$extension_pkg{$path} \|\|= do {	747	$extension_pkg{$path} \|\|= do {
620	my $pkg = "urxvt::" . ($extension_pkg++);	748	$path =~ /([^\/\\]+)$/;
		749	my $pkg = $1;
		750	$pkg =~ s/[^[:word:]]/_/g;
		751	$pkg = "urxvt::ext::$pkg";
621		752
622	verbose 3, "loading extension '$path' into package '$pkg'";	753	verbose 3, "loading extension '$path' into package '$pkg'";
623		754
624	open my $fh, "<:raw", $path	755	open my $fh, "<:raw", $path
625	or die "$path: $!";	756	or die "$path: $!";
626		757
627	my $source =	758	my $source =
628	"package $pkg; use strict; use utf8;\n"	759	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
629	. "use base urxvt::term::extension::;\n"
630	. "#line 1 \"$path\"\n{\n"	760	. "#line 1 \"$path\"\n{\n"
631	. (do { local $/; <$fh> })	761	. (do { local $/; <$fh> })
632	. "\n};\n1";	762	. "\n};\n1";
633		763
634	eval $source	764	eval $source
…		…
648	if ($htype == 0) { # INIT	778	if ($htype == 0) { # INIT
649	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	779	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
650		780
651	my %ext_arg;	781	my %ext_arg;
652		782
		783	{
		784	my @init = @TERM_INIT;
		785	@TERM_INIT = ();
		786	$_->($TERM) for @init;
		787	my @pkg = @TERM_EXT;
		788	@TERM_EXT = ();
		789	$TERM->register_package ($_) for @pkg;
		790	}
		791
653	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	792	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
654	if ($_ eq "default") {	793	if ($_ eq "default") {
655	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	794	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
656	} elsif (/^-(.*)$/) {	795	} elsif (/^-(.*)$/) {
657	delete $ext_arg{$1};	796	delete $ext_arg{$1};
658	} elsif (/^([^<]+)<(.*)>$/) {	797	} elsif (/^([^<]+)<(.*)>$/) {
659	push @{ $ext_arg{$1} }, $2;	798	push @{ $ext_arg{$1} }, $2;
660	} else {	799	} else {
…		…
683	if $verbosity >= 10;	822	if $verbosity >= 10;
684		823
685	keys %$cb;	824	keys %$cb;
686		825
687	while (my ($pkg, $cb) = each %$cb) {	826	while (my ($pkg, $cb) = each %$cb) {
688	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	827	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
689	and last;	828	$retval \|\|= $retval_;
690		829
691	if ($@) {	830	if ($@) {
692	$TERM->ungrab; # better to lose the grab than the session	831	$TERM->ungrab; # better to lose the grab than the session
693	warn $@;	832	warn $@;
694	}	833	}
…		…
705	# clear package	844	# clear package
706	%$TERM = ();	845	%$TERM = ();
707	}	846	}
708		847
709	$retval	848	$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	}	849	}
723		850
724	# urxvt::term::extension	851	# urxvt::term::extension
725		852
726	package urxvt::term::extension;	853	package urxvt::term::extension;
…		…
865	# find on_xxx subs in the package and register them	992	# find on_xxx subs in the package and register them
866	# as hooks	993	# as hooks
867	sub register_package {	994	sub register_package {
868	my ($self, $pkg, $argv) = @_;	995	my ($self, $pkg, $argv) = @_;
869		996
		997	no strict 'refs';
		998
		999	urxvt::verbose 6, "register package $pkg to $self";
		1000
		1001	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1002
870	my $proxy = bless {	1003	my $proxy = bless {
871	_pkg => $pkg,	1004	_pkg => $pkg,
872	argv => $argv,	1005	argv => $argv,
873	}, $pkg;	1006	}, $pkg;
874	Scalar::Util::weaken ($proxy->{term} = $self);	1007	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
905		1038
906	Destroy the terminal object (close the window, free resources	1039	Destroy the terminal object (close the window, free resources
907	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1040	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
908	watchers (timers, io watchers) are still active.	1041	watchers (timers, io watchers) are still active.
909		1042
		1043	=item $term->exec_async ($cmd[, @args])
		1044
		1045	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1046	("starts") programs in the background. This function takes care of setting
		1047	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1048	be preferred over explicit calls to C<exec> or C<system>.
		1049
		1050	Returns the pid of the subprocess or C<undef> on error.
		1051
		1052	=cut
		1053
		1054	sub exec_async {
		1055	my $self = shift;
		1056
		1057	my $pid = fork;
		1058
		1059	return $pid
		1060	if !defined $pid or $pid;
		1061
		1062	%ENV = %{ $self->env };
		1063
		1064	exec @_;
		1065	urxvt::_exit 255;
		1066	}
		1067
910	=item $isset = $term->option ($optval[, $set])	1068	=item $isset = $term->option ($optval[, $set])
911		1069
912	Returns true if the option specified by C<$optval> is enabled, and	1070	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	1071	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.	1072	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	1074	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:	1075	source file F</src/optinc.h> to see the actual list:
918		1076
919	borderLess console cursorBlink cursorUnderline hold iconic insecure	1077	borderLess console cursorBlink cursorUnderline hold iconic insecure
920	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1078	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
921	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1079	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
922	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1080	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
923	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1081	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
924	tripleclickwords utmpInhibit visualBell	1082	transparent tripleclickwords utmpInhibit visualBell
925		1083
926	=item $value = $term->resource ($name[, $newval])	1084	=item $value = $term->resource ($name[, $newval])
927		1085
928	Returns the current resource value associated with a given name and	1086	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>	1087	optionally sets a new value. Setting values is most useful in the C<init>
…		…
946		1104
947	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1105	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
948	borderLess color cursorBlink cursorUnderline cutchars delete_key	1106	borderLess color cursorBlink cursorUnderline cutchars delete_key
949	display_name embed ext_bwidth fade font geometry hold iconName	1107	display_name embed ext_bwidth fade font geometry hold iconName
950	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1108	imFont imLocale inputMethod insecure int_bwidth intensityStyles
951	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1109	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
952	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1110	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
953	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1111	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
954	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1112	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
955	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1113	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
956	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1114	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
957	shade term_name title transparent transparent_all tripleclickwords	1115	secondaryScreen secondaryScroll selectstyle shade term_name title
958	utmpInhibit visualBell	1116	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1117	visualBell
959		1118
960	=cut	1119	=cut
961		1120
962	sub resource($$;$) {	1121	sub resource($$;$) {
963	my ($self, $name) = (shift, shift);	1122	my ($self, $name) = (shift, shift);
…		…
1137		1296
1138	Normally its not a good idea to use this function, as programs might be	1297	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	1298	confused by changes in cursor position or scrolling. Its useful inside a
1140	C<on_add_lines> hook, though.	1299	C<on_add_lines> hook, though.
1141		1300
		1301	=item $term->scr_change_screen ($screen)
		1302
		1303	Switch to given screen - 0 primary, 1 secondary.
		1304
1142	=item $term->cmd_parse ($octets)	1305	=item $term->cmd_parse ($octets)
1143		1306
1144	Similar to C<scr_add_lines>, but the argument must be in the	1307	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	1308	locale-specific encoding of the terminal and can contain command sequences
1146	(escape codes) that will be interpreted.	1309	(escape codes) that will be interpreted.
…		…
1155		1318
1156	Replaces the event mask of the pty watcher by the given event mask. Can	1319	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	1320	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	1321	description of C<< urxvt::timer->events >>. Make sure to always restore
1159	the previous value.	1322	the previous value.
		1323
		1324	=item $fd = $term->pty_fd
		1325
		1326	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1327	is used.
1160		1328
1161	=item $windowid = $term->parent	1329	=item $windowid = $term->parent
1162		1330
1163	Return the window id of the toplevel window.	1331	Return the window id of the toplevel window.
1164		1332
…		…
1229	=item $modifiermask = $term->ModNumLockMask	1397	=item $modifiermask = $term->ModNumLockMask
1230		1398
1231	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1399	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.	1400	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1233		1401
		1402	=item $screen = $term->current_screen
		1403
		1404	Returns the currently displayed screen (0 primary, 1 secondary).
		1405
		1406	=item $cursor_is_hidden = $term->hidden_cursor
		1407
		1408	Returns wether the cursor is currently hidden or not.
		1409
1234	=item $view_start = $term->view_start ([$newvalue])	1410	=item $view_start = $term->view_start ([$newvalue])
1235		1411
1236	Returns the row number of the topmost displayed line. Maximum value is	1412	Returns the row number of the topmost displayed line. Maximum value is
1237	C<0>, which displays the normal terminal contents. Lower values scroll	1413	C<0>, which displays the normal terminal contents. Lower values scroll
1238	this many lines into the scrollback buffer.	1414	this many lines into the scrollback buffer.
…		…
1257	line, starting at column C<$start_col> (default C<0>), which is useful	1433	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	1434	to replace only parts of a line. The font index in the rendition will
1259	automatically be updated.	1435	automatically be updated.
1260		1436
1261	C<$text> is in a special encoding: tabs and wide characters that use more	1437	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	1438	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1263	(C<chr 65535>). Characters with combining characters and other characters	1439	characters. Characters with combining characters and other characters that
1264	that do not fit into the normal tetx encoding will be replaced with	1440	do not fit into the normal tetx encoding will be replaced with characters
1265	characters in the private use area.	1441	in the private use area.
1266		1442
1267	You have to obey this encoding when changing text. The advantage is	1443	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	1444	that C<substr> and similar functions work on screen cells and not on
1269	characters.	1445	characters.
1270		1446
…		…
1445		1621
1446	Calls XUngrab for the most recent grab. Is called automatically on	1622	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	1623	evaluation errors, as it is better to lose the grab in the error case as
1448	the session.	1624	the session.
1449		1625
		1626	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1627
		1628	=item $atom_name = $term->XGetAtomName ($atom)
		1629
		1630	=item @atoms = $term->XListProperties ($window)
		1631
		1632	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1633
		1634	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1635
		1636	=item $term->XDeleteProperty ($window, $property)
		1637
		1638	=item $window = $term->DefaultRootWindow
		1639
		1640	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1641
		1642	=item $term->XMapWindow ($window)
		1643
		1644	=item $term->XUnmapWindow ($window)
		1645
		1646	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1647
		1648	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1649
		1650	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1651
		1652	Various X or X-related functions. The C<$term> object only serves as
		1653	the source of the display, otherwise those functions map more-or-less
		1654	directory onto the X functions of the same name.
		1655
1450	=back	1656	=back
1451		1657
1452	=cut	1658	=cut
1453		1659
1454	package urxvt::popup;	1660	package urxvt::popup;
…		…
1555	my $env = $self->{term}->env;	1761	my $env = $self->{term}->env;
1556	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1762	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1557	delete $env->{LC_ALL};	1763	delete $env->{LC_ALL};
1558	$env->{LC_CTYPE} = $self->{term}->locale;	1764	$env->{LC_CTYPE} = $self->{term}->locale;
1559		1765
1560	urxvt::term->new ($env, $self->{term}->resource ("name"),	1766	urxvt::term->new ($env, "popup",
1561	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1767	"--perl-lib" => "", "--perl-ext-common" => "",
		1768	"-pty-fd" => -1, "-sl" => 0,
		1769	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1562	"--transient-for" => $self->{term}->parent,	1770	"--transient-for" => $self->{term}->parent,
1563	"-display" => $self->{term}->display_id,	1771	"-display" => $self->{term}->display_id,
1564	"-pe" => "urxvt-popup")	1772	"-pe" => "urxvt-popup")
1565	or die "unable to create popup window\n";	1773	or die "unable to create popup window\n";
1566	}	1774	}
…		…
1571	delete $self->{term}{_destroy}{$self};	1779	delete $self->{term}{_destroy}{$self};
1572	$self->{term}->ungrab;	1780	$self->{term}->ungrab;
1573	}	1781	}
1574		1782
1575	=back	1783	=back
		1784
		1785	=cut
		1786
		1787	package urxvt::watcher;
		1788
		1789	@urxvt::timer::ISA = __PACKAGE__;
		1790	@urxvt::iow::ISA = __PACKAGE__;
		1791	@urxvt::pw::ISA = __PACKAGE__;
		1792	@urxvt::iw::ISA = __PACKAGE__;
1576		1793
1577	=head2 The C<urxvt::timer> Class	1794	=head2 The C<urxvt::timer> Class
1578		1795
1579	This class implements timer watchers/events. Time is represented as a	1796	This class implements timer watchers/events. Time is represented as a
1580	fractional number of seconds since the epoch. Example:	1797	fractional number of seconds since the epoch. Example:
…		…
1618	Start the timer.	1835	Start the timer.
1619		1836
1620	=item $timer = $timer->start ($tstamp)	1837	=item $timer = $timer->start ($tstamp)
1621		1838
1622	Set the event trigger time to C<$tstamp> and start the timer.	1839	Set the event trigger time to C<$tstamp> and start the timer.
		1840
		1841	=item $timer = $timer->after ($delay)
		1842
		1843	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1623		1844
1624	=item $timer = $timer->stop	1845	=item $timer = $timer->stop
1625		1846
1626	Stop the timer.	1847	Stop the timer.
1627		1848
…		…
1674		1895
1675	Stop watching for events on the given filehandle.	1896	Stop watching for events on the given filehandle.
1676		1897
1677	=back	1898	=back
1678		1899
		1900	=head2 The C<urxvt::iw> Class
		1901
		1902	This class implements idle watchers, that get called automatically when
		1903	the process is idle. They should return as fast as possible, after doing
		1904	some useful work.
		1905
		1906	=over 4
		1907
		1908	=item $iw = new urxvt::iw
		1909
		1910	Create a new idle watcher object in stopped state.
		1911
		1912	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1913
		1914	Set the callback to be called when the watcher triggers.
		1915
		1916	=item $timer = $timer->start
		1917
		1918	Start the watcher.
		1919
		1920	=item $timer = $timer->stop
		1921
		1922	Stop the watcher.
		1923
		1924	=back
		1925
		1926	=head2 The C<urxvt::pw> Class
		1927
		1928	This class implements process watchers. They create an event whenever a
		1929	process exits, after which they stop automatically.
		1930
		1931	my $pid = fork;
		1932	...
		1933	$term->{pw} = urxvt::pw
		1934	->new
		1935	->start ($pid)
		1936	->cb (sub {
		1937	my ($pw, $exit_status) = @_;
		1938	...
		1939	});
		1940
		1941	=over 4
		1942
		1943	=item $pw = new urxvt::pw
		1944
		1945	Create a new process watcher in stopped state.
		1946
		1947	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1948
		1949	Set the callback to be called when the timer triggers.
		1950
		1951	=item $pw = $timer->start ($pid)
		1952
		1953	Tells the wqtcher to start watching for process C<$pid>.
		1954
		1955	=item $pw = $pw->stop
		1956
		1957	Stop the watcher.
		1958
		1959	=back
		1960
1679	=head1 ENVIRONMENT	1961	=head1 ENVIRONMENT
1680		1962
1681	=head2 URXVT_PERL_VERBOSITY	1963	=head2 URXVT_PERL_VERBOSITY
1682		1964
1683	This variable controls the verbosity level of the perl extension. Higher	1965	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.96 by root, Tue Jan 17 16:22:41 2006 UTC vs. Revision 1.126 by root, Tue Jan 24 19:14:36 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.96 by root, Tue Jan 17 16:22:41 2006 UTC vs.
Revision 1.126 by root, Tue Jan 24 19:14:36 2006 UTC