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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.87 by root, Thu Jan 12 05:37:34 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
		50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
49	It also offers the following bindable event:	53	It also offers the following bindable keyboard command:
50		54
51	=over 4	55	=over 4
52		56
53	=item rot13	57	=item rot13
54		58
…		…
64	runtime.	68	runtime.
65		69
66	=item selection-popup (enabled by default)	70	=item selection-popup (enabled by default)
67		71
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	72	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	73	text into various other formats/action (such as uri unescaping, perl
		74	evalution, web-browser starting etc.), depending on content.
		75
		76	=item searchable-scrollback<hotkey> (enabled by default)
		77
		78	Adds regex search functionality to the scrollback buffer, triggered
		79	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		80	input/output is suspended and a regex is displayed at the bottom of the
		81	screen.
		82
		83	Inputting characters appends them to the regex and continues incremental
		84	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		85	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		86	bottom. C<Escape> leaves search mode and returns to the point where search
		87	was started, while C<Enter> or C<Return> stay at the current position and
		88	additionally stores the first match in the current line into the primary
		89	selection.
70		90
71	=item digital-clock	91	=item digital-clock
72		92
73	Displays a digital clock using the built-in overlay.	93	Displays a digital clock using the built-in overlay.
74		94
75	=item mark-urls	95	=item mark-urls
76		96
77	Uses per-line display filtering (C<on_line_update>) to underline urls.	97	Uses per-line display filtering (C<on_line_update>) to underline urls and
		98	make them clickable. When middle-clicked, the program specified in the
		99	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		100	the URL as first argument.
78		101
79	=item block-graphics-to-ascii	102	=item block-graphics-to-ascii
80		103
81	A not very useful example of filtering all text output to the terminal,	104	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	105	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
87	Displays a very simple digital clock in the upper right corner of the	110	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	111	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	112	overlays or changes.
90		113
91	=back	114	=back
		115
		116	=head1 API DOCUMENTATION
92		117
93	=head2 General API Considerations	118	=head2 General API Considerations
94		119
95	All objects (such as terminals, time watchers etc.) are typical	120	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	121	reference-to-hash objects. The hash can be used to store anything you
…		…
109	=over 4	134	=over 4
110		135
111	=item $text	136	=item $text
112		137
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	138	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.	139	always represents one screen cell. See L<ROW_t> for a discussion of this format.
115		140
116	=item $string	141	=item $string
117		142
118	A perl text string, with an emphasis on I<text>. It can store all unicode	143	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	144	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	149	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	150	locale-specific way.
126		151
127	=back	152	=back
128		153
		154	=head2 Extension Objects
		155
		156	Very perl extension is a perl class. A separate perl object is created
		157	for each terminal and each extension and passed as the first parameter to
		158	hooks. So extensions can use their C<$self> object without having to think
		159	about other extensions, with the exception of methods and members that
		160	begin with an underscore character C<_>: these are reserved for internal
		161	use.
		162
		163	Although it isn't a C<urxvt::term> object, you can call all methods of the
		164	C<urxvt::term> class on this object.
		165
		166	It has the following methods and data members:
		167
		168	=over 4
		169
		170	=item $urxvt_term = $self->{term}
		171
		172	Returns the C<urxvt::term> object associated with this instance of the
		173	extension. This member I<must not> be changed in any way.
		174
		175	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		176
		177	Dynamically enable the given hooks (named without the C<on_> prefix) for
		178	this extension, replacing any previous hook. This is useful when you want
		179	to overwrite time-critical hooks only temporarily.
		180
		181	=item $self->disable ($hook_name[, $hook_name..])
		182
		183	Dynamically disable the given hooks.
		184
		185	=back
		186
129	=head2 Hooks	187	=head2 Hooks
130		188
131	The following subroutines can be declared in extension files, and will be	189	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	190	called whenever the relevant event happens.
133		191
134	The first argument passed to them is an object private to each terminal	192	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	193	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		194
141	All of them must return a boolean value. If it is true, then the event	195	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,	196	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.	197	skipped, and the relevant action might not be carried out by the C++ code.
144		198
145	When in doubt, return a false value (preferably C<()>).	199	I<< When in doubt, return a false value (preferably C<()>). >>
146		200
147	=over 4	201	=over 4
148		202
149	=item on_init $term	203	=item on_init $term
150		204
…		…
185	=item on_sel_extend $term	239	=item on_sel_extend $term
186		240
187	Called whenever the user tries to extend the selection (e.g. with a double	241	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	242	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	243	should extend the selection itelf and return true to suppress the built-in
190	processing.	244	processing. This can happen multiple times, as long as the callback
		245	returns true, it will be called on every further click by the user and is
		246	supposed to enlarge the selection more and more, if possible.
191		247
192	See the F<selection> example extension.	248	See the F<selection> example extension.
193		249
194	=item on_view_change $term, $offset	250	=item on_view_change $term, $offset
195		251
…		…
226	can filter/change and output the text yourself by returning a true value	282	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	283	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	284	might be very slow, however, as your hook is called for B<all> text being
229	output.	285	output.
230		286
		287	=item on_tt_write $term, $octets
		288
		289	Called whenever some data is written to the tty/pty and can be used to
		290	suppress or filter tty input.
		291
231	=item on_line_update $term, $row	292	=item on_line_update $term, $row
232		293
233	Called whenever a line was updated or changed. Can be used to filter	294	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	295	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,	296	that are being shown will be filtered, and, due to performance reasons,
…		…
267	=item on_focus_out $term	328	=item on_focus_out $term
268		329
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	330	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	331	focus out processing.
271		332
272	=item on_key_press $term, $event, $octets	333	=item on_key_press $term, $event, $keysym, $octets
273		334
274	=item on_key_release $term, $event	335	=item on_key_release $term, $event, $keysym
275		336
276	=item on_button_press $term, $event	337	=item on_button_press $term, $event
277		338
278	=item on_button_release $term, $event	339	=item on_button_release $term, $event
279		340
…		…
295		356
296	subwindow.	357	subwindow.
297		358
298	=back	359	=back
299		360
		361	=cut
		362
		363	package urxvt;
		364
		365	use utf8;
		366	use strict;
		367	use Carp ();
		368	use Scalar::Util ();
		369	use List::Util ();
		370
		371	our $VERSION = 1;
		372	our $TERM;
		373	our @HOOKNAME;
		374	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		375	our %OPTION;
		376
		377	our $LIBDIR;
		378	our $RESNAME;
		379	our $RESCLASS;
		380	our $RXVTNAME;
		381
300	=head2 Variables in the C<urxvt> Package	382	=head2 Variables in the C<urxvt> Package
301		383
302	=over 4	384	=over 4
		385
		386	=item $urxvt::LIBDIR
		387
		388	The rxvt-unicode library directory, where, among other things, the perl
		389	modules and scripts are stored.
		390
		391	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		392
		393	The resource class and name rxvt-unicode uses to look up X resources.
		394
		395	=item $urxvt::RXVTNAME
		396
		397	The basename of the installed binaries, usually C<urxvt>.
303		398
304	=item $urxvt::TERM	399	=item $urxvt::TERM
305		400
306	The current terminal. This variable stores the current C<urxvt::term>	401	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	402	object, whenever a callback/hook is executing.
…		…
309	=back	404	=back
310		405
311	=head2 Functions in the C<urxvt> Package	406	=head2 Functions in the C<urxvt> Package
312		407
313	=over 4	408	=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		409
323	=item urxvt::fatal $errormessage	410	=item urxvt::fatal $errormessage
324		411
325	Fatally aborts execution with the given error message. Avoid at all	412	Fatally aborts execution with the given error message. Avoid at all
326	costs! The only time this is acceptable is when the terminal process	413	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	419	newline. The module also overwrites the C<warn> builtin with a function
333	that calls this function.	420	that calls this function.
334		421
335	Using this function has the advantage that its output ends up in the	422	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.	423	correct place, e.g. on stderr of the connecting urxvtc client.
		424
		425	Messages have a size limit of 1023 bytes currently.
		426
		427	=item $is_safe = urxvt::safe
		428
		429	Returns true when it is safe to do potentially unsafe things, such as
		430	evaluating perl code specified by the user. This is true when urxvt was
		431	started setuid or setgid.
337		432
338	=item $time = urxvt::NOW	433	=item $time = urxvt::NOW
339		434
340	Returns the "current time" (as per the event loop).	435	Returns the "current time" (as per the event loop).
341		436
…		…
380		475
381	=item $background = urxvt::GET_BASEBG $rend	476	=item $background = urxvt::GET_BASEBG $rend
382		477
383	Return the foreground/background colour index, respectively.	478	Return the foreground/background colour index, respectively.
384		479
385	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	480	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
386		481
387	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	482	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
388		483
389	Replace the foreground/background colour in the rendition mask with the	484	Replace the foreground/background colour in the rendition mask with the
390	specified one.	485	specified one.
391		486
392	=item $value = urxvt::GET_CUSTOM ($rend)	487	=item $value = urxvt::GET_CUSTOM $rend
393		488
394	Return the "custom" value: Every rendition has 5 bits for use by	489	Return the "custom" value: Every rendition has 5 bits for use by
395	extensions. They can be set and changed as you like and are initially	490	extensions. They can be set and changed as you like and are initially
396	zero.	491	zero.
397		492
398	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	493	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
399		494
400	Change the custom value.	495	Change the custom value.
401		496
402	=back	497	=back
403		498
404	=cut	499	=cut
405
406	package urxvt;
407
408	use utf8;
409	use strict;
410	use Scalar::Util ();
411	use List::Util ();
412
413	our $VERSION = 1;
414	our $TERM;
415	our @HOOKNAME;
416	our %OPTION;
417	our $LIBDIR;
418		500
419	BEGIN {	501	BEGIN {
420	urxvt->bootstrap;	502	urxvt->bootstrap;
421		503
422	# overwrite perl's warn	504	# overwrite perl's warn
…		…
425	$msg .= "\n"	507	$msg .= "\n"
426	unless $msg =~ /\n$/;	508	unless $msg =~ /\n$/;
427	urxvt::warn ($msg);	509	urxvt::warn ($msg);
428	};	510	};
429		511
		512	# %ENV is the original startup environment
430	delete $ENV{IFS};	513	delete $ENV{IFS};
431	delete $ENV{CDPATH};	514	delete $ENV{CDPATH};
432	delete $ENV{BASH_ENV};	515	delete $ENV{BASH_ENV};
433	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	516	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
434	}	517	}
…		…
439	sub verbose {	522	sub verbose {
440	my ($level, $msg) = @_;	523	my ($level, $msg) = @_;
441	warn "$msg\n" if $level <= $verbosity;	524	warn "$msg\n" if $level <= $verbosity;
442	}	525	}
443		526
444	# find on_xxx subs in the package and register them
445	# as hooks
446	sub register_package($) {
447	my ($pkg) = @_;
448
449	for my $htype (0.. $#HOOKNAME) {
450	my $name = $HOOKNAME[$htype];
451
452	my $ref = $pkg->can ("on_" . lc $name)
453	or next;
454
455	$TERM->{_hook}[$htype]{$pkg} = $ref;
456	$hook_count[$htype]++
457	or set_should_invoke $htype, 1;
458	}
459	}
460
461	my $extension_pkg = "extension0000";	527	my $extension_pkg = "extension0000";
462	my %extension_pkg;	528	my %extension_pkg;
463		529
464	# load a single script into its own package, once only	530	# load a single script into its own package, once only
465	sub extension_package($) {	531	sub extension_package($) {
…		…
471	verbose 3, "loading extension '$path' into package '$pkg'";	537	verbose 3, "loading extension '$path' into package '$pkg'";
472		538
473	open my $fh, "<:raw", $path	539	open my $fh, "<:raw", $path
474	or die "$path: $!";	540	or die "$path: $!";
475		541
		542	my $source = untaint
476	my $source = untaint "package $pkg; use strict; use utf8;\n"	543	"package $pkg; use strict; use utf8;\n"
477	. "use base urxvt::term::proxy::;\n"	544	. "use base urxvt::term::extension::;\n"
478	. "#line 1 \"$path\"\n{\n"	545	. "#line 1 \"$path\"\n{\n"
479	. (do { local $/; <$fh> })	546	. (do { local $/; <$fh> })
480	. "\n};\n1";	547	. "\n};\n1";
481		548
		549	eval $source
482	eval $source or die "$path: $@";	550	or die "$path: $@";
483		551
484	$pkg	552	$pkg
485	}	553	}
486	}	554	}
487		555
…		…
493	my $htype = shift;	561	my $htype = shift;
494		562
495	if ($htype == 0) { # INIT	563	if ($htype == 0) { # INIT
496	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	564	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
497		565
498	my %want_ext;	566	my %ext_arg;
499		567
500	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	568	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
501	if ($_ eq "default") {	569	if ($_ eq "default") {
502	$want_ext{$_}++ for qw(selection option-popup selection-popup);	570	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
503	} elsif (/^-(.*)$/) {	571	} elsif (/^-(.*)$/) {
504	delete $want_ext{$1};	572	delete $ext_arg{$1};
		573	} elsif (/^([^<]+)<(.*)>$/) {
		574	push @{ $ext_arg{$1} }, $2;
505	} else {	575	} else {
506	$want_ext{$_}++;	576	$ext_arg{$_} \|\|= [];
507	}	577	}
508	}	578	}
509		579
510	for my $ext (keys %want_ext) {	580	while (my ($ext, $argv) = each %ext_arg) {
511	my @files = grep -f $_, map "$_/$ext", @dirs;	581	my @files = grep -f $_, map "$_/$ext", @dirs;
512		582
513	if (@files) {	583	if (@files) {
514	register_package extension_package $files[0];	584	$TERM->register_package (extension_package $files[0], $argv);
515	} else {	585	} else {
516	warn "perl extension '$ext' not found in perl library search path\n";	586	warn "perl extension '$ext' not found in perl library search path\n";
517	}	587	}
518	}	588	}
519		589
…		…
528	if $verbosity >= 10;	598	if $verbosity >= 10;
529		599
530	keys %$cb;	600	keys %$cb;
531		601
532	while (my ($pkg, $cb) = each %$cb) {	602	while (my ($pkg, $cb) = each %$cb) {
533	eval {	603	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
534	$retval = $cb->(
535	$TERM->{_pkg}{$pkg} \|\|= do {
536	my $proxy = bless { }, $pkg;
537	Scalar::Util::weaken ($proxy->{term} = $TERM);
538	$proxy
539	},
540	@_,
541	) and last;	604	and last;
542	};	605
543	if ($@) {	606	if ($@) {
544	$TERM->ungrab; # better to lose the grab than the session	607	$TERM->ungrab; # better to lose the grab than the session
545	warn $@;	608	warn $@;
546	}	609	}
547	}	610	}
		611
		612	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		613	if $verbosity >= 11;
548	}	614	}
549		615
550	if ($htype == 1) { # DESTROY	616	if ($htype == 1) { # DESTROY
551	# remove hooks if unused
552	if (my $hook = $TERM->{_hook}) {	617	if (my $hook = delete $TERM->{_hook}) {
553	for my $htype (0..$#$hook) {	618	for my $htype (0..$#$hook) {
554	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	619	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
555	or set_should_invoke $htype, 0;	620	or set_should_invoke $htype, 0;
556	}	621	}
557	}	622	}
…		…
564	}	629	}
565		630
566	$retval	631	$retval
567	}	632	}
568		633
569	# urxvt::term::proxy	634	sub exec_async(@) {
		635	my $pid = fork;
570		636
571	sub urxvt::term::proxy::AUTOLOAD {	637	return
572	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	638	if !defined $pid or $pid;
		639
		640	%ENV = %{ $TERM->env };
		641
		642	exec @_;
		643	_exit 255;
		644	}
		645
		646	# urxvt::term::extension
		647
		648	package urxvt::term::extension;
		649
		650	sub enable {
		651	my ($self, %hook) = @_;
		652	my $pkg = $self->{_pkg};
		653
		654	while (my ($name, $cb) = each %hook) {
		655	my $htype = $HOOKTYPE{uc $name};
		656	defined $htype
		657	or Carp::croak "unsupported hook type '$name'";
		658
		659	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		660	$hook_count[$htype]++
		661	or urxvt::set_should_invoke $htype, 1;
		662	}
		663
		664	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		665	}
		666	}
		667
		668	sub disable {
		669	my ($self, @hook) = @_;
		670	my $pkg = $self->{_pkg};
		671
		672	for my $name (@hook) {
		673	my $htype = $HOOKTYPE{uc $name};
		674	defined $htype
		675	or Carp::croak "unsupported hook type '$name'";
		676
		677	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		678	--$hook_count[$htype]
		679	or urxvt::set_should_invoke $htype, 0;
		680	}
		681	}
		682	}
		683
		684	our $AUTOLOAD;
		685
		686	sub AUTOLOAD {
		687	$AUTOLOAD =~ /:([^:]+)$/
573	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	688	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
574		689
575	eval qq{	690	eval qq{
576	sub $urxvt::term::proxy::AUTOLOAD {	691	sub $AUTOLOAD {
577	my \$proxy = shift;	692	my \$proxy = shift;
578	\$proxy->{term}->$1 (\@_)	693	\$proxy->{term}->$1 (\@_)
579	}	694	}
580	1	695	1
581	} or die "FATAL: unable to compile method forwarder: $@";	696	} or die "FATAL: unable to compile method forwarder: $@";
582		697
583	goto &$urxvt::term::proxy::AUTOLOAD;	698	goto &$AUTOLOAD;
584	}	699	}
585		700
586	sub urxvt::term::proxy::DESTROY {	701	sub DESTROY {
587	# nop	702	# nop
588	}	703	}
589		704
590	# urxvt::destroy_hook	705	# urxvt::destroy_hook
591		706
…		…
601		716
602	=head2 The C<urxvt::anyevent> Class	717	=head2 The C<urxvt::anyevent> Class
603		718
604	The sole purpose of this class is to deliver an interface to the	719	The sole purpose of this class is to deliver an interface to the
605	C<AnyEvent> module - any module using it will work inside urxvt without	720	C<AnyEvent> module - any module using it will work inside urxvt without
606	further work. The only exception is that you cannot wait on condition	721	further programming. The only exception is that you cannot wait on
607	variables, but non-blocking condvar use is ok. What this means is that you	722	condition variables, but non-blocking condvar use is ok. What this means
608	cannot use blocking APIs, but the non-blocking variant should work.	723	is that you cannot use blocking APIs, but the non-blocking variant should
		724	work.
609		725
610	=cut	726	=cut
611		727
612	our $VERSION = 1;	728	our $VERSION = 1;
613		729
…		…
658	${$_[0]}++;	774	${$_[0]}++;
659	}	775	}
660		776
661	sub urxvt::anyevent::condvar::wait {	777	sub urxvt::anyevent::condvar::wait {
662	unless (${$_[0]}) {	778	unless (${$_[0]}) {
663	require Carp;
664	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	779	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
665	}	780	}
666	}	781	}
667		782
668	package urxvt::term;	783	package urxvt::term;
669		784
670	=head2 The C<urxvt::term> Class	785	=head2 The C<urxvt::term> Class
671		786
672	=over 4	787	=over 4
673		788
		789	=cut
		790
		791	# find on_xxx subs in the package and register them
		792	# as hooks
		793	sub register_package {
		794	my ($self, $pkg, $argv) = @_;
		795
		796	my $proxy = bless {
		797	_pkg => $pkg,
		798	argv => $argv,
		799	}, $pkg;
		800	Scalar::Util::weaken ($proxy->{term} = $self);
		801
		802	$self->{_pkg}{$pkg} = $proxy;
		803
		804	for my $name (@HOOKNAME) {
		805	if (my $ref = $pkg->can ("on_" . lc $name)) {
		806	$proxy->enable ($name => $ref);
		807	}
		808	}
		809	}
		810
		811	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		812
		813	Creates a new terminal, very similar as if you had started it with system
		814	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		815	hash which defines the environment of the new terminal.
		816
		817	Croaks (and probably outputs an error message) if the new instance
		818	couldn't be created. Returns C<undef> if the new instance didn't
		819	initialise perl, and the terminal object otherwise. The C<init> and
		820	C<start> hooks will be called during this call.
		821
		822	=cut
		823
		824	sub new {
		825	my ($class, $env, @args) = @_;
		826
		827	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		828	}
		829
674	=item $term->destroy	830	=item $term->destroy
675		831
676	Destroy the terminal object (close the window, free resources etc.).	832	Destroy the terminal object (close the window, free resources
		833	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		834	watchers (timers, io watchers) are still active.
677		835
678	=item $isset = $term->option ($optval[, $set])	836	=item $isset = $term->option ($optval[, $set])
679		837
680	Returns true if the option specified by C<$optval> is enabled, and	838	Returns true if the option specified by C<$optval> is enabled, and
681	optionally change it. All option values are stored by name in the hash	839	optionally change it. All option values are stored by name in the hash
…		…
731	my ($self, $name) = (shift, shift);	889	my ($self, $name) = (shift, shift);
732	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	890	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
733	&urxvt::term::_resource	891	&urxvt::term::_resource
734	}	892	}
735		893
		894	=item $value = $term->x_resource ($pattern)
		895
		896	Returns the X-Resource for the given pattern, excluding the program or
		897	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		898	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		899	resource with that pattern exists.
		900
		901	This method should only be called during the C<on_start> hook, as there is
		902	only one resource database per display, and later invocations might return
		903	the wrong resources.
		904
		905	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		906
		907	Adds a keymap translation exactly as specified via a resource. See the
		908	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		909
736	=item $rend = $term->rstyle ([$new_rstyle])	910	=item $rend = $term->rstyle ([$new_rstyle])
737		911
738	Return and optionally change the current rendition. Text that is output by	912	Return and optionally change the current rendition. Text that is output by
739	the terminal application will use this style.	913	the terminal application will use this style.
740		914
…		…
750	=item ($row, $col) = $term->selection_end ([$row, $col])	924	=item ($row, $col) = $term->selection_end ([$row, $col])
751		925
752	Return the current values of the selection mark, begin or end positions,	926	Return the current values of the selection mark, begin or end positions,
753	and optionally set them to new values.	927	and optionally set them to new values.
754		928
		929	=item $term->selection_make ($eventtime[, $rectangular])
		930
		931	Tries to make a selection as set by C<selection_beg> and
		932	C<selection_end>. If C<$rectangular> is true (default: false), a
		933	rectangular selection will be made. This is the prefered function to make
		934	a selection.
		935
755	=item $success = $term->selection_grab ($eventtime)	936	=item $success = $term->selection_grab ($eventtime)
756		937
757	Try to request the primary selection from the server (for example, as set	938	Try to request the primary selection text from the server (for example, as
758	by the next method).	939	set by the next method). No visual feedback will be given. This function
		940	is mostly useful from within C<on_sel_grab> hooks.
759		941
760	=item $oldtext = $term->selection ([$newtext])	942	=item $oldtext = $term->selection ([$newtext])
761		943
762	Return the current selection text and optionally replace it by C<$newtext>.	944	Return the current selection text and optionally replace it by C<$newtext>.
763		945
764	#=item $term->overlay ($x, $y, $text)	946	=item $term->overlay_simple ($x, $y, $text)
765	#	947
766	#Create a simple multi-line overlay box. See the next method for details.	948	Create a simple multi-line overlay box. See the next method for details.
767	#	949
768	#=cut	950	=cut
769	#	951
770	#sub urxvt::term::scr_overlay {	952	sub overlay_simple {
771	# my ($self, $x, $y, $text) = @_;	953	my ($self, $x, $y, $text) = @_;
772	#	954
773	# my @lines = split /\n/, $text;	955	my @lines = split /\n/, $text;
774	#	956
775	# my $w = 0;	957	my $w = List::Util::max map $self->strwidth ($_), @lines;
776	# for (map $self->strwidth ($_), @lines) {	958
777	# $w = $_ if $w < $_;
778	# }
779	#
780	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	959	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
781	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	960	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
782	#}	961
		962	$overlay
		963	}
783		964
784	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	965	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
785		966
786	Create a new (empty) overlay at the given position with the given	967	Create a new (empty) overlay at the given position with the given
787	width/height. C<$rstyle> defines the initial rendition style	968	width/height. C<$rstyle> defines the initial rendition style
…		…
854		1035
855	=item $string = $term->locale_decode ($octets)	1036	=item $string = $term->locale_decode ($octets)
856		1037
857	Convert the given locale-encoded octets into a perl string.	1038	Convert the given locale-encoded octets into a perl string.
858		1039
		1040	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1041
		1042	XORs the rendition values in the given span with the provided value
		1043	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1044	refresh hooks to provide effects similar to the selection.
		1045
		1046	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1047
		1048	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1049	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1050	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1051	it instead. Both styles I<MUST NOT> contain font styles.
		1052
		1053	=item $term->scr_bell
		1054
		1055	Ring the bell!
		1056
859	=item $term->scr_add_lines ($string)	1057	=item $term->scr_add_lines ($string)
860		1058
861	Write the given text string to the screen, as if output by the application	1059	Write the given text string to the screen, as if output by the application
862	running inside the terminal. It may not contain command sequences (escape	1060	running inside the terminal. It may not contain command sequences (escape
863	codes), but is free to use line feeds, carriage returns and tabs. The	1061	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
877		1075
878	Write the octets given in C<$data> to the tty (i.e. as program input). To	1076	Write the octets given in C<$data> to the tty (i.e. as program input). To
879	pass characters instead of octets, you should convert your strings first	1077	pass characters instead of octets, you should convert your strings first
880	to the locale-specific encoding using C<< $term->locale_encode >>.	1078	to the locale-specific encoding using C<< $term->locale_encode >>.
881		1079
		1080	=item $old_events = $term->pty_ev_events ([$new_events])
		1081
		1082	Replaces the event mask of the pty watcher by the given event mask. Can
		1083	be used to suppress input and output handling to the pty/tty. See the
		1084	description of C<< urxvt::timer->events >>. Make sure to always restore
		1085	the previous value.
		1086
882	=item $windowid = $term->parent	1087	=item $windowid = $term->parent
883		1088
884	Return the window id of the toplevel window.	1089	Return the window id of the toplevel window.
885		1090
886	=item $windowid = $term->vt	1091	=item $windowid = $term->vt
…		…
910	=item $nrow_plus_saveLines = $term->total_rows	1115	=item $nrow_plus_saveLines = $term->total_rows
911		1116
912	=item $lines_in_scrollback = $term->nsaved	1117	=item $lines_in_scrollback = $term->nsaved
913		1118
914	Return various integers describing terminal characteristics.	1119	Return various integers describing terminal characteristics.
		1120
		1121	=item $x_display = $term->display_id
		1122
		1123	Return the DISPLAY used by rxvt-unicode.
		1124
		1125	=item $lc_ctype = $term->locale
		1126
		1127	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1128
		1129	=item $env = $term->env
		1130
		1131	Returns a copy of the environment in effect for the terminal as a hashref
		1132	similar to C<\%ENV>.
		1133
		1134	=cut
		1135
		1136	sub env {
		1137	if (my $env = $_[0]->_env) {
		1138	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1139	} else {
		1140	+{ %ENV }
		1141	}
		1142	}
915		1143
916	=item $modifiermask = $term->ModLevel3Mask	1144	=item $modifiermask = $term->ModLevel3Mask
917		1145
918	=item $modifiermask = $term->ModMetaMask	1146	=item $modifiermask = $term->ModMetaMask
919		1147
…		…
1012	Return the row number of the first/last row of the line, respectively.	1240	Return the row number of the first/last row of the line, respectively.
1013		1241
1014	=item $offset = $line->offset_of ($row, $col)	1242	=item $offset = $line->offset_of ($row, $col)
1015		1243
1016	Returns the character offset of the given row\|col pair within the logical	1244	Returns the character offset of the given row\|col pair within the logical
1017	line.	1245	line. Works for rows outside the line, too, and returns corresponding
		1246	offsets outside the string.
1018		1247
1019	=item ($row, $col) = $line->coord_of ($offset)	1248	=item ($row, $col) = $line->coord_of ($offset)
1020		1249
1021	Translates a string offset into terminal coordinates again.	1250	Translates a string offset into terminal coordinates again.
1022		1251
…		…
1109	Converts rxvt-unicodes text reprsentation into a perl string. See	1338	Converts rxvt-unicodes text reprsentation into a perl string. See
1110	C<< $term->ROW_t >> for details.	1339	C<< $term->ROW_t >> for details.
1111		1340
1112	=item $success = $term->grab_button ($button, $modifiermask)	1341	=item $success = $term->grab_button ($button, $modifiermask)
1113		1342
1114	Registers a synchronous button grab. See XGrabButton.	1343	Registers a synchronous button grab. See the XGrabButton manpage.
1115		1344
1116	=item $success = $term->grab ($eventtime[, $sync])	1345	=item $success = $term->grab ($eventtime[, $sync])
1117		1346
1118	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1347	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1119	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1348	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1159	$item->{render} \|\|= sub { $_[0]{text} };	1388	$item->{render} \|\|= sub { $_[0]{text} };
1160		1389
1161	push @{ $self->{item} }, $item;	1390	push @{ $self->{item} }, $item;
1162	}	1391	}
1163		1392
1164	sub add_separator {	1393	=item $popup->add_title ($title)
1165	my ($self, $sep) = @_;
1166		1394
1167	$sep \|\|= "═";	1395	Adds a non-clickable title to the popup.
1168		1396
1169	$self->add_item ({	1397	=cut
1170	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1171	text => "",
1172	render => sub { $sep x $urxvt::TERM->ncol },
1173	activate => sub { },
1174	});
1175	}
1176		1398
1177	sub add_title {	1399	sub add_title {
1178	my ($self, $title) = @_;	1400	my ($self, $title) = @_;
1179		1401
1180	$self->add_item ({	1402	$self->add_item ({
…		…
1182	text => $title,	1404	text => $title,
1183	activate => sub { },	1405	activate => sub { },
1184	});	1406	});
1185	}	1407	}
1186		1408
		1409	=item $popup->add_separator ([$sepchr])
		1410
		1411	Creates a separator, optionally using the character given as C<$sepchr>.
		1412
		1413	=cut
		1414
		1415	sub add_separator {
		1416	my ($self, $sep) = @_;
		1417
		1418	$sep \|\|= "=";
		1419
		1420	$self->add_item ({
		1421	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1422	text => "",
		1423	render => sub { $sep x $self->{term}->ncol },
		1424	activate => sub { },
		1425	});
		1426	}
		1427
		1428	=item $popup->add_button ($text, $cb)
		1429
		1430	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1431	selected.
		1432
		1433	=cut
		1434
1187	sub add_button {	1435	sub add_button {
1188	my ($self, $text, $cb) = @_;	1436	my ($self, $text, $cb) = @_;
1189		1437
1190	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1438	$self->add_item ({ type => "button", text => $text, activate => $cb});
1191	}	1439	}
		1440
		1441	=item $popup->add_toggle ($text, $cb, $initial_value)
		1442
		1443	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1444	whenever it gets toggled, with a boolean indicating its value as its first
		1445	argument.
		1446
		1447	=cut
1192		1448
1193	sub add_toggle {	1449	sub add_toggle {
1194	my ($self, $text, $cb, $value) = @_;	1450	my ($self, $text, $cb, $value) = @_;
1195		1451
1196	my $item; $item = {	1452	my $item; $item = {
1197	type => "button",	1453	type => "button",
1198	text => " $text",	1454	text => " $text",
1199	value => $value,	1455	value => $value,
1200	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1456	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1201	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1457	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1202	};	1458	};
1203		1459
1204	$self->add_item ($item);	1460	$self->add_item ($item);
1205	}	1461	}
		1462
		1463	=item $popup->show
		1464
		1465	Displays the popup (which is initially hidden).
		1466
		1467	=cut
1206		1468
1207	sub show {	1469	sub show {
1208	my ($self) = @_;	1470	my ($self) = @_;
1209		1471
1210	local $urxvt::popup::self = $self;	1472	local $urxvt::popup::self = $self;
1211		1473
		1474	my $env = $self->{term}->env;
		1475	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1476	delete $env->{LC_ALL};
		1477	$env->{LC_CTYPE} = $self->{term}->locale;
		1478
		1479	urxvt::term->new ($env, $self->{term}->resource ("name"),
1212	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1480	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1213	"--transient-for" => $self->{term}->parent,	1481	"--transient-for" => $self->{term}->parent,
		1482	"-display" => $self->{term}->display_id,
1214	"-pe" => "urxvt-popup")	1483	"-pe" => "urxvt-popup")
1215	or die "unable to create popup window\n";	1484	or die "unable to create popup window\n";
1216	}	1485	}
1217		1486
1218	sub DESTROY {	1487	sub DESTROY {
1219	my ($self) = @_;	1488	my ($self) = @_;
1220		1489
1221	delete $self->{term}{_destroy}{$self};	1490	delete $self->{term}{_destroy}{$self};
1222	$self->{term}->ungrab;	1491	$self->{term}->ungrab;
1223	}	1492	}
		1493
		1494	=back
1224		1495
1225	=head2 The C<urxvt::timer> Class	1496	=head2 The C<urxvt::timer> Class
1226		1497
1227	This class implements timer watchers/events. Time is represented as a	1498	This class implements timer watchers/events. Time is represented as a
1228	fractional number of seconds since the epoch. Example:	1499	fractional number of seconds since the epoch. Example:
…		…
1281		1552
1282	$term->{socket} = ...	1553	$term->{socket} = ...
1283	$term->{iow} = urxvt::iow	1554	$term->{iow} = urxvt::iow
1284	->new	1555	->new
1285	->fd (fileno $term->{socket})	1556	->fd (fileno $term->{socket})
1286	->events (1) # wait for read data	1557	->events (urxvt::EVENT_READ)
1287	->start	1558	->start
1288	->cb (sub {	1559	->cb (sub {
1289	my ($iow, $revents) = @_;	1560	my ($iow, $revents) = @_;
1290	# $revents must be 1 here, no need to check	1561	# $revents must be 1 here, no need to check
1291	sysread $term->{socket}, my $buf, 8192	1562	sysread $term->{socket}, my $buf, 8192
…		…
1308		1579
1309	Set the filedescriptor (not handle) to watch.	1580	Set the filedescriptor (not handle) to watch.
1310		1581
1311	=item $iow = $iow->events ($eventmask)	1582	=item $iow = $iow->events ($eventmask)
1312		1583
1313	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1584	Set the event mask to watch. The only allowed values are
1314	data, Bit #1 (value C<2>) enables watching for write data.	1585	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1586	together, or C<urxvt::EVENT_NONE>.
1315		1587
1316	=item $iow = $iow->start	1588	=item $iow = $iow->start
1317		1589
1318	Start watching for requested events on the given handle.	1590	Start watching for requested events on the given handle.
1319		1591
…		…
1334		1606
1335	=item == 0 - fatal messages	1607	=item == 0 - fatal messages
1336		1608
1337	=item >= 3 - script loading and management	1609	=item >= 3 - script loading and management
1338		1610
1339	=item >=10 - all events received	1611	=item >=10 - all called hooks
		1612
		1613	=item >=11 - hook reutrn values
1340		1614
1341	=back	1615	=back
1342		1616
1343	=head1 AUTHOR	1617	=head1 AUTHOR
1344		1618

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs. Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC