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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.62 by root, Mon Jan 9 02:06:43 2006 UTC vs.
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
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		39
40	=over 4	40	=over 4
41		41
42	=item selection (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	47	arguments, which is very convenient, too, if your F<ls> supports
		48	C<--quoting-style=shell>.
48		49
49	It also offers the following bindable event:	50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
		53	The selection works by trying to match a number of regexes and displaying
		54	them in increasing order of length. You can add your own regexes by
		55	specifying resources of the form:
		56
		57	URxvt.selection.pattern-0: perl-regex
		58	URxvt.selection.pattern-1: perl-regex
		59	...
		60
		61	The index number (0, 1...) must not have any holes, and each regex must
		62	contain at least one pair of capturing parentheses, which will be used for
		63	the match. For example, the followign adds a regex that matches everything
		64	between two vertical bars:
		65
		66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		67
		68	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.
		70
		71	This extension also offers the following bindable keyboard command:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
…		…
64	runtime.	86	runtime.
65		87
66	=item selection-popup (enabled by default)	88	=item selection-popup (enabled by default)
67		89
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
70		93
71	=item digital-clock	94	=item searchable-scrollback<hotkey> (enabled by default)
72		95
73	Displays a digital clock using the built-in overlay.	96	Adds regex search functionality to the scrollback buffer, triggered
		97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		98	input/output is suspended and a regex is displayed at the bottom of the
		99	screen.
		100
		101	Inputting characters appends them to the regex and continues incremental
		102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		104	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
		106	additionally stores the first match in the current line into the primary
		107	selection.
		108
		109	=item selection-autotransform
		110
		111	This selection allows you to do automatic transforms on a selection
		112	whenever a selection is made.
		113
		114	It works by specifying perl snippets (most useful is a single C<s///>
		115	operator) that modify C<$_> as resources:
		116
		117	URxvt.selection-autotransform.0: transform
		118	URxvt.selection-autotransform.1: transform
		119	...
		120
		121	For example, the following will transform selections of the form
		122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		123	$word>:
		124
		125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		126
		127	And this example matches the same,but replaces it with vi-commands you can
		128	paste directly into your (vi :) editor:
		129
		130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		131
		132	Of course, this can be modified to suit your needs and your editor :)
		133
		134	To expand the example above to typical perl error messages ("XXX at
		135	FILENAME line YYY."), you need a slightly more elaborate solution:
		136
		137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		139
		140	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
		142	the message into vi commands to load the file.
74		143
75	=item mark-urls	144	=item mark-urls
76		145
77	Uses per-line display filtering (C<on_line_update>) to underline urls.	146	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
		148	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		149	the URL as first argument.
78		150
79	=item block-graphics-to-ascii	151	=item block-graphics-to-ascii
80		152
81	A not very useful example of filtering all text output to the terminal,	153	A not very useful example of filtering all text output to the terminal,
82	by replacing all line-drawing characters (U+2500 .. U+259F) by a	154	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.	155	similar-looking ascii character.
84		156
		157	=item digital-clock
		158
		159	Displays a digital clock using the built-in overlay.
		160
85	=item example-refresh-hooks	161	=item example-refresh-hooks
86		162
87	Displays a very simple digital clock in the upper right corner of the	163	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	164	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	165	overlays or changes.
90		166
91	=back	167	=back
		168
		169	=head1 API DOCUMENTATION
92		170
93	=head2 General API Considerations	171	=head2 General API Considerations
94		172
95	All objects (such as terminals, time watchers etc.) are typical	173	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	174	reference-to-hash objects. The hash can be used to store anything you
…		…
109	=over 4	187	=over 4
110		188
111	=item $text	189	=item $text
112		190
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	191	Rxvt-unicodes special way of encoding text, where one "unicode" character
114	always represents one screen cell. See L<row_t> for a discussion of this format.	192	always represents one screen cell. See L<ROW_t> for a discussion of this format.
115		193
116	=item $string	194	=item $string
117		195
118	A perl text string, with an emphasis on I<text>. It can store all unicode	196	A perl text string, with an emphasis on I<text>. It can store all unicode
119	characters and is to be distinguished with text encoded in a specific	197	characters and is to be distinguished with text encoded in a specific
…		…
124	Either binary data or - more common - a text string encoded in a	202	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	203	locale-specific way.
126		204
127	=back	205	=back
128		206
		207	=head2 Extension Objects
		208
		209	Very perl extension is a perl class. A separate perl object is created
		210	for each terminal and each extension and passed as the first parameter to
		211	hooks. So extensions can use their C<$self> object without having to think
		212	about other extensions, with the exception of methods and members that
		213	begin with an underscore character C<_>: these are reserved for internal
		214	use.
		215
		216	Although it isn't a C<urxvt::term> object, you can call all methods of the
		217	C<urxvt::term> class on this object.
		218
		219	It has the following methods and data members:
		220
		221	=over 4
		222
		223	=item $urxvt_term = $self->{term}
		224
		225	Returns the C<urxvt::term> object associated with this instance of the
		226	extension. This member I<must not> be changed in any way.
		227
		228	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		229
		230	Dynamically enable the given hooks (named without the C<on_> prefix) for
		231	this extension, replacing any previous hook. This is useful when you want
		232	to overwrite time-critical hooks only temporarily.
		233
		234	=item $self->disable ($hook_name[, $hook_name..])
		235
		236	Dynamically disable the given hooks.
		237
		238	=back
		239
129	=head2 Hooks	240	=head2 Hooks
130		241
131	The following subroutines can be declared in extension files, and will be	242	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	243	called whenever the relevant event happens.
133		244
134	The first argument passed to them is an object private to each terminal	245	The first argument passed to them is an extension oject as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	246	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		247
141	All of them must return a boolean value. If it is true, then the event	248	B<All> of these hooks must return a boolean value. If it is true, then the
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	249	event counts as being I<consumed>, and the invocation of other hooks is
143	and the relevant action might not be carried out by the C++ code.	250	skipped, and the relevant action might not be carried out by the C++ code.
144		251
145	When in doubt, return a false value (preferably C<()>).	252	I<< When in doubt, return a false value (preferably C<()>). >>
146		253
147	=over 4	254	=over 4
148		255
149	=item on_init $term	256	=item on_init $term
150		257
…		…
185	=item on_sel_extend $term	292	=item on_sel_extend $term
186		293
187	Called whenever the user tries to extend the selection (e.g. with a double	294	Called whenever the user tries to extend the selection (e.g. with a double
188	click) and is either supposed to return false (normal operation), or	295	click) and is either supposed to return false (normal operation), or
189	should extend the selection itelf and return true to suppress the built-in	296	should extend the selection itelf and return true to suppress the built-in
190	processing.	297	processing. This can happen multiple times, as long as the callback
		298	returns true, it will be called on every further click by the user and is
		299	supposed to enlarge the selection more and more, if possible.
191		300
192	See the F<selection> example extension.	301	See the F<selection> example extension.
193		302
194	=item on_view_change $term, $offset	303	=item on_view_change $term, $offset
195		304
…		…
226	can filter/change and output the text yourself by returning a true value	335	can filter/change and output the text yourself by returning a true value
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	336	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	337	might be very slow, however, as your hook is called for B<all> text being
229	output.	338	output.
230		339
		340	=item on_tt_write $term, $octets
		341
		342	Called whenever some data is written to the tty/pty and can be used to
		343	suppress or filter tty input.
		344
231	=item on_line_update $term, $row	345	=item on_line_update $term, $row
232		346
233	Called whenever a line was updated or changed. Can be used to filter	347	Called whenever a line was updated or changed. Can be used to filter
234	screen output (e.g. underline urls or other useless stuff). Only lines	348	screen output (e.g. underline urls or other useless stuff). Only lines
235	that are being shown will be filtered, and, due to performance reasons,	349	that are being shown will be filtered, and, due to performance reasons,
…		…
267	=item on_focus_out $term	381	=item on_focus_out $term
268		382
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	383	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	384	focus out processing.
271		385
272	=item on_key_press $term, $event, $octets	386	=item on_key_press $term, $event, $keysym, $octets
273		387
274	=item on_key_release $term, $event	388	=item on_key_release $term, $event, $keysym
275		389
276	=item on_button_press $term, $event	390	=item on_button_press $term, $event
277		391
278	=item on_button_release $term, $event	392	=item on_button_release $term, $event
279		393
…		…
295		409
296	subwindow.	410	subwindow.
297		411
298	=back	412	=back
299		413
		414	=cut
		415
		416	package urxvt;
		417
		418	use utf8;
		419	use strict;
		420	use Carp ();
		421	use Scalar::Util ();
		422	use List::Util ();
		423
		424	our $VERSION = 1;
		425	our $TERM;
		426	our @HOOKNAME;
		427	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		428	our %OPTION;
		429
		430	our $LIBDIR;
		431	our $RESNAME;
		432	our $RESCLASS;
		433	our $RXVTNAME;
		434
300	=head2 Variables in the C<urxvt> Package	435	=head2 Variables in the C<urxvt> Package
301		436
302	=over 4	437	=over 4
		438
		439	=item $urxvt::LIBDIR
		440
		441	The rxvt-unicode library directory, where, among other things, the perl
		442	modules and scripts are stored.
		443
		444	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		445
		446	The resource class and name rxvt-unicode uses to look up X resources.
		447
		448	=item $urxvt::RXVTNAME
		449
		450	The basename of the installed binaries, usually C<urxvt>.
303		451
304	=item $urxvt::TERM	452	=item $urxvt::TERM
305		453
306	The current terminal. This variable stores the current C<urxvt::term>	454	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	455	object, whenever a callback/hook is executing.
…		…
309	=back	457	=back
310		458
311	=head2 Functions in the C<urxvt> Package	459	=head2 Functions in the C<urxvt> Package
312		460
313	=over 4	461	=over 4
314
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322		462
323	=item urxvt::fatal $errormessage	463	=item urxvt::fatal $errormessage
324		464
325	Fatally aborts execution with the given error message. Avoid at all	465	Fatally aborts execution with the given error message. Avoid at all
326	costs! The only time this is acceptable is when the terminal process	466	costs! The only time this is acceptable is when the terminal process
…		…
332	newline. The module also overwrites the C<warn> builtin with a function	472	newline. The module also overwrites the C<warn> builtin with a function
333	that calls this function.	473	that calls this function.
334		474
335	Using this function has the advantage that its output ends up in the	475	Using this function has the advantage that its output ends up in the
336	correct place, e.g. on stderr of the connecting urxvtc client.	476	correct place, e.g. on stderr of the connecting urxvtc client.
		477
		478	Messages have a size limit of 1023 bytes currently.
337		479
338	=item $is_safe = urxvt::safe	480	=item $is_safe = urxvt::safe
339		481
340	Returns true when it is safe to do potentially unsafe things, such as	482	Returns true when it is safe to do potentially unsafe things, such as
341	evaluating perl code specified by the user. This is true when urxvt was	483	evaluating perl code specified by the user. This is true when urxvt was
…		…
386		528
387	=item $background = urxvt::GET_BASEBG $rend	529	=item $background = urxvt::GET_BASEBG $rend
388		530
389	Return the foreground/background colour index, respectively.	531	Return the foreground/background colour index, respectively.
390		532
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	533	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		534
393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	535	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
394		536
395	Replace the foreground/background colour in the rendition mask with the	537	Replace the foreground/background colour in the rendition mask with the
396	specified one.	538	specified one.
397		539
398	=item $value = urxvt::GET_CUSTOM ($rend)	540	=item $value = urxvt::GET_CUSTOM $rend
399		541
400	Return the "custom" value: Every rendition has 5 bits for use by	542	Return the "custom" value: Every rendition has 5 bits for use by
401	extensions. They can be set and changed as you like and are initially	543	extensions. They can be set and changed as you like and are initially
402	zero.	544	zero.
403		545
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	546	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		547
406	Change the custom value.	548	Change the custom value.
407		549
408	=back	550	=back
409		551
410	=cut	552	=cut
411
412	package urxvt;
413
414	use utf8;
415	use strict;
416	use Scalar::Util ();
417	use List::Util ();
418
419	our $VERSION = 1;
420	our $TERM;
421	our @HOOKNAME;
422	our %OPTION;
423	our $LIBDIR;
424		553
425	BEGIN {	554	BEGIN {
426	urxvt->bootstrap;	555	urxvt->bootstrap;
427		556
428	# overwrite perl's warn	557	# overwrite perl's warn
…		…
431	$msg .= "\n"	560	$msg .= "\n"
432	unless $msg =~ /\n$/;	561	unless $msg =~ /\n$/;
433	urxvt::warn ($msg);	562	urxvt::warn ($msg);
434	};	563	};
435		564
		565	# %ENV is the original startup environment
436	delete $ENV{IFS};	566	delete $ENV{IFS};
437	delete $ENV{CDPATH};	567	delete $ENV{CDPATH};
438	delete $ENV{BASH_ENV};	568	delete $ENV{BASH_ENV};
439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	569	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
440	}	570	}
…		…
445	sub verbose {	575	sub verbose {
446	my ($level, $msg) = @_;	576	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	577	warn "$msg\n" if $level <= $verbosity;
448	}	578	}
449		579
450	# find on_xxx subs in the package and register them
451	# as hooks
452	sub register_package($) {
453	my ($pkg) = @_;
454
455	for my $htype (0.. $#HOOKNAME) {
456	my $name = $HOOKNAME[$htype];
457
458	my $ref = $pkg->can ("on_" . lc $name)
459	or next;
460
461	$TERM->{_hook}[$htype]{$pkg} = $ref;
462	$hook_count[$htype]++
463	or set_should_invoke $htype, 1;
464	}
465	}
466
467	my $extension_pkg = "extension0000";	580	my $extension_pkg = "extension0000";
468	my %extension_pkg;	581	my %extension_pkg;
469		582
470	# load a single script into its own package, once only	583	# load a single script into its own package, once only
471	sub extension_package($) {	584	sub extension_package($) {
…		…
477	verbose 3, "loading extension '$path' into package '$pkg'";	590	verbose 3, "loading extension '$path' into package '$pkg'";
478		591
479	open my $fh, "<:raw", $path	592	open my $fh, "<:raw", $path
480	or die "$path: $!";	593	or die "$path: $!";
481		594
		595	my $source = untaint
482	my $source = untaint "package $pkg; use strict; use utf8;\n"	596	"package $pkg; use strict; use utf8;\n"
483	. "use base urxvt::term::proxy::;\n"	597	. "use base urxvt::term::extension::;\n"
484	. "#line 1 \"$path\"\n{\n"	598	. "#line 1 \"$path\"\n{\n"
485	. (do { local $/; <$fh> })	599	. (do { local $/; <$fh> })
486	. "\n};\n1";	600	. "\n};\n1";
487		601
		602	eval $source
488	eval $source or die "$path: $@";	603	or die "$path: $@";
489		604
490	$pkg	605	$pkg
491	}	606	}
492	}	607	}
493		608
…		…
499	my $htype = shift;	614	my $htype = shift;
500		615
501	if ($htype == 0) { # INIT	616	if ($htype == 0) { # INIT
502	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	617	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
503		618
504	my %want_ext;	619	my %ext_arg;
505		620
506	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	621	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
507	if ($_ eq "default") {	622	if ($_ eq "default") {
508	$want_ext{$_}++ for qw(selection option-popup selection-popup);	623	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
509	} elsif (/^-(.*)$/) {	624	} elsif (/^-(.*)$/) {
510	delete $want_ext{$1};	625	delete $ext_arg{$1};
		626	} elsif (/^([^<]+)<(.*)>$/) {
		627	push @{ $ext_arg{$1} }, $2;
511	} else {	628	} else {
512	$want_ext{$_}++;	629	$ext_arg{$_} \|\|= [];
513	}	630	}
514	}	631	}
515		632
516	for my $ext (keys %want_ext) {	633	while (my ($ext, $argv) = each %ext_arg) {
517	my @files = grep -f $_, map "$_/$ext", @dirs;	634	my @files = grep -f $_, map "$_/$ext", @dirs;
518		635
519	if (@files) {	636	if (@files) {
520	register_package extension_package $files[0];	637	$TERM->register_package (extension_package $files[0], $argv);
521	} else {	638	} else {
522	warn "perl extension '$ext' not found in perl library search path\n";	639	warn "perl extension '$ext' not found in perl library search path\n";
523	}	640	}
524	}	641	}
525		642
…		…
534	if $verbosity >= 10;	651	if $verbosity >= 10;
535		652
536	keys %$cb;	653	keys %$cb;
537		654
538	while (my ($pkg, $cb) = each %$cb) {	655	while (my ($pkg, $cb) = each %$cb) {
539	eval {	656	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
540	$retval = $cb->(
541	$TERM->{_pkg}{$pkg} \|\|= do {
542	my $proxy = bless { }, $pkg;
543	Scalar::Util::weaken ($proxy->{term} = $TERM);
544	$proxy
545	},
546	@_,
547	) and last;	657	and last;
548	};	658
549	if ($@) {	659	if ($@) {
550	$TERM->ungrab; # better to lose the grab than the session	660	$TERM->ungrab; # better to lose the grab than the session
551	warn $@;	661	warn $@;
552	}	662	}
553	}	663	}
		664
		665	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		666	if $verbosity >= 11;
554	}	667	}
555		668
556	if ($htype == 1) { # DESTROY	669	if ($htype == 1) { # DESTROY
557	# remove hooks if unused
558	if (my $hook = $TERM->{_hook}) {	670	if (my $hook = delete $TERM->{_hook}) {
559	for my $htype (0..$#$hook) {	671	for my $htype (0..$#$hook) {
560	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	672	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
561	or set_should_invoke $htype, 0;	673	or set_should_invoke $htype, 0;
562	}	674	}
563	}	675	}
…		…
570	}	682	}
571		683
572	$retval	684	$retval
573	}	685	}
574		686
575	# urxvt::term::proxy	687	sub exec_async(@) {
		688	my $pid = fork;
576		689
577	sub urxvt::term::proxy::AUTOLOAD {	690	return
578	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	691	if !defined $pid or $pid;
		692
		693	%ENV = %{ $TERM->env };
		694
		695	exec @_;
		696	_exit 255;
		697	}
		698
		699	# urxvt::term::extension
		700
		701	package urxvt::term::extension;
		702
		703	sub enable {
		704	my ($self, %hook) = @_;
		705	my $pkg = $self->{_pkg};
		706
		707	while (my ($name, $cb) = each %hook) {
		708	my $htype = $HOOKTYPE{uc $name};
		709	defined $htype
		710	or Carp::croak "unsupported hook type '$name'";
		711
		712	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		713	$hook_count[$htype]++
		714	or urxvt::set_should_invoke $htype, 1;
		715	}
		716
		717	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		718	}
		719	}
		720
		721	sub disable {
		722	my ($self, @hook) = @_;
		723	my $pkg = $self->{_pkg};
		724
		725	for my $name (@hook) {
		726	my $htype = $HOOKTYPE{uc $name};
		727	defined $htype
		728	or Carp::croak "unsupported hook type '$name'";
		729
		730	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		731	--$hook_count[$htype]
		732	or urxvt::set_should_invoke $htype, 0;
		733	}
		734	}
		735	}
		736
		737	our $AUTOLOAD;
		738
		739	sub AUTOLOAD {
		740	$AUTOLOAD =~ /:([^:]+)$/
579	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	741	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580		742
581	eval qq{	743	eval qq{
582	sub $urxvt::term::proxy::AUTOLOAD {	744	sub $AUTOLOAD {
583	my \$proxy = shift;	745	my \$proxy = shift;
584	\$proxy->{term}->$1 (\@_)	746	\$proxy->{term}->$1 (\@_)
585	}	747	}
586	1	748	1
587	} or die "FATAL: unable to compile method forwarder: $@";	749	} or die "FATAL: unable to compile method forwarder: $@";
588		750
589	goto &$urxvt::term::proxy::AUTOLOAD;	751	goto &$AUTOLOAD;
590	}	752	}
591		753
592	sub urxvt::term::proxy::DESTROY {	754	sub DESTROY {
593	# nop	755	# nop
594	}	756	}
595		757
596	# urxvt::destroy_hook	758	# urxvt::destroy_hook
597		759
…		…
607		769
608	=head2 The C<urxvt::anyevent> Class	770	=head2 The C<urxvt::anyevent> Class
609		771
610	The sole purpose of this class is to deliver an interface to the	772	The sole purpose of this class is to deliver an interface to the
611	C<AnyEvent> module - any module using it will work inside urxvt without	773	C<AnyEvent> module - any module using it will work inside urxvt without
612	further work. The only exception is that you cannot wait on condition	774	further programming. The only exception is that you cannot wait on
613	variables, but non-blocking condvar use is ok. What this means is that you	775	condition variables, but non-blocking condvar use is ok. What this means
614	cannot use blocking APIs, but the non-blocking variant should work.	776	is that you cannot use blocking APIs, but the non-blocking variant should
		777	work.
615		778
616	=cut	779	=cut
617		780
618	our $VERSION = 1;	781	our $VERSION = 1;
619		782
…		…
664	${$_[0]}++;	827	${$_[0]}++;
665	}	828	}
666		829
667	sub urxvt::anyevent::condvar::wait {	830	sub urxvt::anyevent::condvar::wait {
668	unless (${$_[0]}) {	831	unless (${$_[0]}) {
669	require Carp;
670	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	832	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
671	}	833	}
672	}	834	}
673		835
674	package urxvt::term;	836	package urxvt::term;
675		837
676	=head2 The C<urxvt::term> Class	838	=head2 The C<urxvt::term> Class
677		839
678	=over 4	840	=over 4
679		841
		842	=cut
		843
		844	# find on_xxx subs in the package and register them
		845	# as hooks
		846	sub register_package {
		847	my ($self, $pkg, $argv) = @_;
		848
		849	my $proxy = bless {
		850	_pkg => $pkg,
		851	argv => $argv,
		852	}, $pkg;
		853	Scalar::Util::weaken ($proxy->{term} = $self);
		854
		855	$self->{_pkg}{$pkg} = $proxy;
		856
		857	for my $name (@HOOKNAME) {
		858	if (my $ref = $pkg->can ("on_" . lc $name)) {
		859	$proxy->enable ($name => $ref);
		860	}
		861	}
		862	}
		863
		864	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		865
		866	Creates a new terminal, very similar as if you had started it with system
		867	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		868	hash which defines the environment of the new terminal.
		869
		870	Croaks (and probably outputs an error message) if the new instance
		871	couldn't be created. Returns C<undef> if the new instance didn't
		872	initialise perl, and the terminal object otherwise. The C<init> and
		873	C<start> hooks will be called during this call.
		874
		875	=cut
		876
		877	sub new {
		878	my ($class, $env, @args) = @_;
		879
		880	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		881	}
		882
680	=item $term->destroy	883	=item $term->destroy
681		884
682	Destroy the terminal object (close the window, free resources etc.).	885	Destroy the terminal object (close the window, free resources
		886	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		887	watchers (timers, io watchers) are still active.
683		888
684	=item $isset = $term->option ($optval[, $set])	889	=item $isset = $term->option ($optval[, $set])
685		890
686	Returns true if the option specified by C<$optval> is enabled, and	891	Returns true if the option specified by C<$optval> is enabled, and
687	optionally change it. All option values are stored by name in the hash	892	optionally change it. All option values are stored by name in the hash
…		…
737	my ($self, $name) = (shift, shift);	942	my ($self, $name) = (shift, shift);
738	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	943	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
739	&urxvt::term::_resource	944	&urxvt::term::_resource
740	}	945	}
741		946
		947	=item $value = $term->x_resource ($pattern)
		948
		949	Returns the X-Resource for the given pattern, excluding the program or
		950	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		951	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		952	resource with that pattern exists.
		953
		954	This method should only be called during the C<on_start> hook, as there is
		955	only one resource database per display, and later invocations might return
		956	the wrong resources.
		957
		958	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		959
		960	Adds a keymap translation exactly as specified via a resource. See the
		961	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		962
742	=item $rend = $term->rstyle ([$new_rstyle])	963	=item $rend = $term->rstyle ([$new_rstyle])
743		964
744	Return and optionally change the current rendition. Text that is output by	965	Return and optionally change the current rendition. Text that is output by
745	the terminal application will use this style.	966	the terminal application will use this style.
746		967
…		…
756	=item ($row, $col) = $term->selection_end ([$row, $col])	977	=item ($row, $col) = $term->selection_end ([$row, $col])
757		978
758	Return the current values of the selection mark, begin or end positions,	979	Return the current values of the selection mark, begin or end positions,
759	and optionally set them to new values.	980	and optionally set them to new values.
760		981
		982	=item $term->selection_make ($eventtime[, $rectangular])
		983
		984	Tries to make a selection as set by C<selection_beg> and
		985	C<selection_end>. If C<$rectangular> is true (default: false), a
		986	rectangular selection will be made. This is the prefered function to make
		987	a selection.
		988
761	=item $success = $term->selection_grab ($eventtime)	989	=item $success = $term->selection_grab ($eventtime)
762		990
763	Try to request the primary selection from the server (for example, as set	991	Try to request the primary selection text from the server (for example, as
764	by the next method).	992	set by the next method). No visual feedback will be given. This function
		993	is mostly useful from within C<on_sel_grab> hooks.
765		994
766	=item $oldtext = $term->selection ([$newtext])	995	=item $oldtext = $term->selection ([$newtext])
767		996
768	Return the current selection text and optionally replace it by C<$newtext>.	997	Return the current selection text and optionally replace it by C<$newtext>.
769		998
770	#=item $term->overlay ($x, $y, $text)	999	=item $term->overlay_simple ($x, $y, $text)
771	#	1000
772	#Create a simple multi-line overlay box. See the next method for details.	1001	Create a simple multi-line overlay box. See the next method for details.
773	#	1002
774	#=cut	1003	=cut
775	#	1004
776	#sub urxvt::term::scr_overlay {	1005	sub overlay_simple {
777	# my ($self, $x, $y, $text) = @_;	1006	my ($self, $x, $y, $text) = @_;
778	#	1007
779	# my @lines = split /\n/, $text;	1008	my @lines = split /\n/, $text;
780	#	1009
781	# my $w = 0;	1010	my $w = List::Util::max map $self->strwidth ($_), @lines;
782	# for (map $self->strwidth ($_), @lines) {	1011
783	# $w = $_ if $w < $_;
784	# }
785	#
786	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1012	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1013	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788	#}	1014
		1015	$overlay
		1016	}
789		1017
790	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1018	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791		1019
792	Create a new (empty) overlay at the given position with the given	1020	Create a new (empty) overlay at the given position with the given
793	width/height. C<$rstyle> defines the initial rendition style	1021	width/height. C<$rstyle> defines the initial rendition style
…		…
860		1088
861	=item $string = $term->locale_decode ($octets)	1089	=item $string = $term->locale_decode ($octets)
862		1090
863	Convert the given locale-encoded octets into a perl string.	1091	Convert the given locale-encoded octets into a perl string.
864		1092
		1093	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1094
		1095	XORs the rendition values in the given span with the provided value
		1096	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1097	refresh hooks to provide effects similar to the selection.
		1098
		1099	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1100
		1101	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1102	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1103	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1104	it instead. Both styles I<MUST NOT> contain font styles.
		1105
		1106	=item $term->scr_bell
		1107
		1108	Ring the bell!
		1109
865	=item $term->scr_add_lines ($string)	1110	=item $term->scr_add_lines ($string)
866		1111
867	Write the given text string to the screen, as if output by the application	1112	Write the given text string to the screen, as if output by the application
868	running inside the terminal. It may not contain command sequences (escape	1113	running inside the terminal. It may not contain command sequences (escape
869	codes), but is free to use line feeds, carriage returns and tabs. The	1114	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
883		1128
884	Write the octets given in C<$data> to the tty (i.e. as program input). To	1129	Write the octets given in C<$data> to the tty (i.e. as program input). To
885	pass characters instead of octets, you should convert your strings first	1130	pass characters instead of octets, you should convert your strings first
886	to the locale-specific encoding using C<< $term->locale_encode >>.	1131	to the locale-specific encoding using C<< $term->locale_encode >>.
887		1132
		1133	=item $old_events = $term->pty_ev_events ([$new_events])
		1134
		1135	Replaces the event mask of the pty watcher by the given event mask. Can
		1136	be used to suppress input and output handling to the pty/tty. See the
		1137	description of C<< urxvt::timer->events >>. Make sure to always restore
		1138	the previous value.
		1139
888	=item $windowid = $term->parent	1140	=item $windowid = $term->parent
889		1141
890	Return the window id of the toplevel window.	1142	Return the window id of the toplevel window.
891		1143
892	=item $windowid = $term->vt	1144	=item $windowid = $term->vt
…		…
916	=item $nrow_plus_saveLines = $term->total_rows	1168	=item $nrow_plus_saveLines = $term->total_rows
917		1169
918	=item $lines_in_scrollback = $term->nsaved	1170	=item $lines_in_scrollback = $term->nsaved
919		1171
920	Return various integers describing terminal characteristics.	1172	Return various integers describing terminal characteristics.
		1173
		1174	=item $x_display = $term->display_id
		1175
		1176	Return the DISPLAY used by rxvt-unicode.
		1177
		1178	=item $lc_ctype = $term->locale
		1179
		1180	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1181
		1182	=item $env = $term->env
		1183
		1184	Returns a copy of the environment in effect for the terminal as a hashref
		1185	similar to C<\%ENV>.
		1186
		1187	=cut
		1188
		1189	sub env {
		1190	if (my $env = $_[0]->_env) {
		1191	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1192	} else {
		1193	+{ %ENV }
		1194	}
		1195	}
921		1196
922	=item $modifiermask = $term->ModLevel3Mask	1197	=item $modifiermask = $term->ModLevel3Mask
923		1198
924	=item $modifiermask = $term->ModMetaMask	1199	=item $modifiermask = $term->ModMetaMask
925		1200
…		…
1018	Return the row number of the first/last row of the line, respectively.	1293	Return the row number of the first/last row of the line, respectively.
1019		1294
1020	=item $offset = $line->offset_of ($row, $col)	1295	=item $offset = $line->offset_of ($row, $col)
1021		1296
1022	Returns the character offset of the given row\|col pair within the logical	1297	Returns the character offset of the given row\|col pair within the logical
1023	line.	1298	line. Works for rows outside the line, too, and returns corresponding
		1299	offsets outside the string.
1024		1300
1025	=item ($row, $col) = $line->coord_of ($offset)	1301	=item ($row, $col) = $line->coord_of ($offset)
1026		1302
1027	Translates a string offset into terminal coordinates again.	1303	Translates a string offset into terminal coordinates again.
1028		1304
…		…
1115	Converts rxvt-unicodes text reprsentation into a perl string. See	1391	Converts rxvt-unicodes text reprsentation into a perl string. See
1116	C<< $term->ROW_t >> for details.	1392	C<< $term->ROW_t >> for details.
1117		1393
1118	=item $success = $term->grab_button ($button, $modifiermask)	1394	=item $success = $term->grab_button ($button, $modifiermask)
1119		1395
1120	Registers a synchronous button grab. See XGrabButton.	1396	Registers a synchronous button grab. See the XGrabButton manpage.
1121		1397
1122	=item $success = $term->grab ($eventtime[, $sync])	1398	=item $success = $term->grab ($eventtime[, $sync])
1123		1399
1124	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1400	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1125	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1401	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1165	$item->{render} \|\|= sub { $_[0]{text} };	1441	$item->{render} \|\|= sub { $_[0]{text} };
1166		1442
1167	push @{ $self->{item} }, $item;	1443	push @{ $self->{item} }, $item;
1168	}	1444	}
1169		1445
1170	sub add_separator {	1446	=item $popup->add_title ($title)
1171	my ($self, $sep) = @_;
1172		1447
1173	$sep \|\|= "═";	1448	Adds a non-clickable title to the popup.
1174		1449
1175	$self->add_item ({	1450	=cut
1176	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1177	text => "",
1178	render => sub { $sep x $urxvt::TERM->ncol },
1179	activate => sub { },
1180	});
1181	}
1182		1451
1183	sub add_title {	1452	sub add_title {
1184	my ($self, $title) = @_;	1453	my ($self, $title) = @_;
1185		1454
1186	$self->add_item ({	1455	$self->add_item ({
…		…
1188	text => $title,	1457	text => $title,
1189	activate => sub { },	1458	activate => sub { },
1190	});	1459	});
1191	}	1460	}
1192		1461
		1462	=item $popup->add_separator ([$sepchr])
		1463
		1464	Creates a separator, optionally using the character given as C<$sepchr>.
		1465
		1466	=cut
		1467
		1468	sub add_separator {
		1469	my ($self, $sep) = @_;
		1470
		1471	$sep \|\|= "=";
		1472
		1473	$self->add_item ({
		1474	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1475	text => "",
		1476	render => sub { $sep x $self->{term}->ncol },
		1477	activate => sub { },
		1478	});
		1479	}
		1480
		1481	=item $popup->add_button ($text, $cb)
		1482
		1483	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1484	selected.
		1485
		1486	=cut
		1487
1193	sub add_button {	1488	sub add_button {
1194	my ($self, $text, $cb) = @_;	1489	my ($self, $text, $cb) = @_;
1195		1490
1196	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1491	$self->add_item ({ type => "button", text => $text, activate => $cb});
1197	}	1492	}
		1493
		1494	=item $popup->add_toggle ($text, $cb, $initial_value)
		1495
		1496	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1497	whenever it gets toggled, with a boolean indicating its value as its first
		1498	argument.
		1499
		1500	=cut
1198		1501
1199	sub add_toggle {	1502	sub add_toggle {
1200	my ($self, $text, $cb, $value) = @_;	1503	my ($self, $text, $cb, $value) = @_;
1201		1504
1202	my $item; $item = {	1505	my $item; $item = {
1203	type => "button",	1506	type => "button",
1204	text => " $text",	1507	text => " $text",
1205	value => $value,	1508	value => $value,
1206	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1509	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1207	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1510	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1208	};	1511	};
1209		1512
1210	$self->add_item ($item);	1513	$self->add_item ($item);
1211	}	1514	}
		1515
		1516	=item $popup->show
		1517
		1518	Displays the popup (which is initially hidden).
		1519
		1520	=cut
1212		1521
1213	sub show {	1522	sub show {
1214	my ($self) = @_;	1523	my ($self) = @_;
1215		1524
1216	local $urxvt::popup::self = $self;	1525	local $urxvt::popup::self = $self;
1217		1526
		1527	my $env = $self->{term}->env;
		1528	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1529	delete $env->{LC_ALL};
		1530	$env->{LC_CTYPE} = $self->{term}->locale;
		1531
		1532	urxvt::term->new ($env, $self->{term}->resource ("name"),
1218	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1533	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1219	"--transient-for" => $self->{term}->parent,	1534	"--transient-for" => $self->{term}->parent,
		1535	"-display" => $self->{term}->display_id,
1220	"-pe" => "urxvt-popup")	1536	"-pe" => "urxvt-popup")
1221	or die "unable to create popup window\n";	1537	or die "unable to create popup window\n";
1222	}	1538	}
1223		1539
1224	sub DESTROY {	1540	sub DESTROY {
1225	my ($self) = @_;	1541	my ($self) = @_;
1226		1542
1227	delete $self->{term}{_destroy}{$self};	1543	delete $self->{term}{_destroy}{$self};
1228	$self->{term}->ungrab;	1544	$self->{term}->ungrab;
1229	}	1545	}
		1546
		1547	=back
1230		1548
1231	=head2 The C<urxvt::timer> Class	1549	=head2 The C<urxvt::timer> Class
1232		1550
1233	This class implements timer watchers/events. Time is represented as a	1551	This class implements timer watchers/events. Time is represented as a
1234	fractional number of seconds since the epoch. Example:	1552	fractional number of seconds since the epoch. Example:
…		…
1287		1605
1288	$term->{socket} = ...	1606	$term->{socket} = ...
1289	$term->{iow} = urxvt::iow	1607	$term->{iow} = urxvt::iow
1290	->new	1608	->new
1291	->fd (fileno $term->{socket})	1609	->fd (fileno $term->{socket})
1292	->events (1) # wait for read data	1610	->events (urxvt::EVENT_READ)
1293	->start	1611	->start
1294	->cb (sub {	1612	->cb (sub {
1295	my ($iow, $revents) = @_;	1613	my ($iow, $revents) = @_;
1296	# $revents must be 1 here, no need to check	1614	# $revents must be 1 here, no need to check
1297	sysread $term->{socket}, my $buf, 8192	1615	sysread $term->{socket}, my $buf, 8192
…		…
1314		1632
1315	Set the filedescriptor (not handle) to watch.	1633	Set the filedescriptor (not handle) to watch.
1316		1634
1317	=item $iow = $iow->events ($eventmask)	1635	=item $iow = $iow->events ($eventmask)
1318		1636
1319	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1637	Set the event mask to watch. The only allowed values are
1320	data, Bit #1 (value C<2>) enables watching for write data.	1638	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1639	together, or C<urxvt::EVENT_NONE>.
1321		1640
1322	=item $iow = $iow->start	1641	=item $iow = $iow->start
1323		1642
1324	Start watching for requested events on the given handle.	1643	Start watching for requested events on the given handle.
1325		1644
…		…
1340		1659
1341	=item == 0 - fatal messages	1660	=item == 0 - fatal messages
1342		1661
1343	=item >= 3 - script loading and management	1662	=item >= 3 - script loading and management
1344		1663
1345	=item >=10 - all events received	1664	=item >=10 - all called hooks
		1665
		1666	=item >=11 - hook reutrn values
1346		1667
1347	=back	1668	=back
1348		1669
1349	=head1 AUTHOR	1670	=head1 AUTHOR
1350		1671

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.62 by root, Mon Jan 9 02:06:43 2006 UTC vs. Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.62 by root, Mon Jan 9 02:06:43 2006 UTC vs.
Revision 1.91 by root, Fri Jan 13 01:09:37 2006 UTC