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

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.86 by root, Thu Jan 12 05:22:47 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.86 by root, Thu Jan 12 05:22:47 2006 UTC