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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.221 by sf-exg, Thu Jun 21 06:08:05 2012 UTC vs.
Revision 1.243 by sf-exg, Sat Oct 11 22:02:50 2014 UTC

…		…
1	=encoding utf8	1	=encoding utf8
2		2
3	=head1 NAME	3	=head1 NAME
4		4
5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	urxvtperl - rxvt-unicode's embedded perl interpreter
6		6
7	=head1 SYNOPSIS	7	=head1 SYNOPSIS
8		8
9	# create a file grab_test in $HOME:	9	# create a file grab_test in $HOME:
10		10
11	sub on_sel_grab {	11	sub on_sel_grab {
12	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
13	()	13	()
14	}	14	}
15		15
16	# start a @@RXVT_NAME@@ using it:	16	# start a urxvt using it:
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	urxvt --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Every time a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
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 urxvtd, 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	You can disable the embedded perl interpreter by setting both "perl-ext"	31	You can disable the embedded perl interpreter by setting both "perl-ext"
32	and "perl-ext-common" resources to the empty string.	32	and "perl-ext-common" resources to the empty string.
33		33
34	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
35		35
36	A number of extensions are delivered with this release. You can find them	36	A number of extensions are delivered with this release. You can find them
37	in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed	37	in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
38	using F<< man urxvt-<EXTENSIONNAME> >>.	38	F<< man urxvt-<EXTENSIONNAME> >>.
39		39
40	You can activate them like this:	40	You can activate them like this:
41		41
42	@@RXVT_NAME@@ -pe <extensionname>	42	urxvt -pe <extensionname>
43		43
44	Or by adding them to the resource for extensions loaded by default:	44	Or by adding them to the resource for extensions loaded by default:
45		45
46	URxvt.perl-ext-common: default,selection-autotransform	46	URxvt.perl-ext-common: default,selection-autotransform
47		47
48	Extensions that add command line parameters or resources on their own are	48	Extensions may add resources on their own. Similarly to builtin
49	loaded automatically when used.	49	resources, these resources can also be specified on the command line
		50	as long options (with '.' replaced by '-'), in which case the
		51	corresponding extension is loaded automatically.
50		52
51	=head1 API DOCUMENTATION	53	=head1 API DOCUMENTATION
52		54
53	=head2 General API Considerations	55	=head2 General API Considerations
54		56
103	internal use.	105	internal use.
104		106
105	Although it isn't a C<urxvt::term> object, you can call all methods of the	107	Although it isn't a C<urxvt::term> object, you can call all methods of the
106	C<urxvt::term> class on this object.	108	C<urxvt::term> class on this object.
107		109
108	It has the following methods and data members:	110	Additional methods only supported for extension objects are described in
109		111	the C<urxvt::extension> section below.
110	=over 4
111
112	=item $urxvt_term = $self->{term}
113
114	Returns the C<urxvt::term> object associated with this instance of the
115	extension. This member I<must not> be changed in any way.
116
117	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
118
119	Dynamically enable the given hooks (named without the C<on_> prefix) for
120	this extension, replacing any previous hook. This is useful when you want
121	to overwrite time-critical hooks only temporarily.
122
123	To install additional callbacks for the same hook, you can use the C<on>
124	method of the C<urxvt::term> class.
125
126	=item $self->disable ($hook_name[, $hook_name..])
127
128	Dynamically disable the given hooks.
129
130	=item $self->x_resource ($pattern)
131
132	=item $self->x_resource_boolean ($pattern)
133
134	These methods support an additional C<%> prefix when called on an
135	extension object - see the description of these methods in the
136	C<urxvt::term> class for details.
137
138	=back
139		112
140	=head2 Hooks	113	=head2 Hooks
141		114
142	The following subroutines can be declared in extension files, and will be	115	The following subroutines can be declared in extension files, and will be
143	called whenever the relevant event happens.	116	called whenever the relevant event happens.
…		…
310		283
311	=item on_refresh_end $term	284	=item on_refresh_end $term
312		285
313	Called just after the screen gets redrawn. See C<on_refresh_begin>.	286	Called just after the screen gets redrawn. See C<on_refresh_begin>.
314		287
315	=item on_user_command $term, $string	288	=item on_user_command $term, $string DEPRECATED
316		289
317	Called whenever a user-configured event is being activated (e.g. via	290	Called whenever a user-configured event is being activated (e.g. via
318	a C<perl:string> action bound to a key, see description of the B<keysym>	291	a C<perl:string> action bound to a key, see description of the B<keysym>
319	resource in the @@RXVT_NAME@@(1) manpage).	292	resource in the urxvt(1) manpage).
320		293
321	The event is simply the action string. This interface is assumed to change	294	The event is simply the action string. This interface is going away in
322	slightly in the future.	295	preference to the C<on_action> hook.
323
324	=item on_register_command $term, $keysym, $modifiermask, $string
325
326	Called after parsing a keysym resource but before registering the
327	associated binding. If this hook returns TRUE the binding is not
328	registered. It can be used to modify a binding by calling
329	C<register_command>.
330		296
331	=item on_resize_all_windows $term, $new_width, $new_height	297	=item on_resize_all_windows $term, $new_width, $new_height
332		298
333	Called just after the new window size has been calculated, but before	299	Called just after the new window size has been calculated, but before
334	windows are actually being resized or hints are being set. If this hook	300	windows are actually being resized or hints are being set. If this hook
335	returns TRUE, setting of the window hints is being skipped.	301	returns a true value, setting of the window hints is being skipped.
336		302
337	=item on_x_event $term, $event	303	=item on_x_event $term, $event
338		304
339	Called on every X event received on the vt window (and possibly other	305	Called on every X event received on the vt window (and possibly other
340	windows). Should only be used as a last resort. Most event structure	306	windows). Should only be used as a last resort. Most event structure
…		…
379	manpage), with the additional members C<row> and C<col>, which are the	345	manpage), with the additional members C<row> and C<col>, which are the
380	(real, not screen-based) row and column under the mouse cursor.	346	(real, not screen-based) row and column under the mouse cursor.
381		347
382	C<on_key_press> additionally receives the string rxvt-unicode would	348	C<on_key_press> additionally receives the string rxvt-unicode would
383	output, if any, in locale-specific encoding.	349	output, if any, in locale-specific encoding.
384
385	subwindow.
386		350
387	=item on_client_message $term, $event	351	=item on_client_message $term, $event
388		352
389	=item on_wm_protocols $term, $event	353	=item on_wm_protocols $term, $event
390		354
…		…
593	no warnings 'utf8';	557	no warnings 'utf8';
594		558
595	sub parse_resource {	559	sub parse_resource {
596	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	560	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
597		561
598	$name =~ y/-/./ if $isarg;
599
600	$term->scan_meta;	562	$term->scan_extensions;
601		563
602	my $r = $term->{meta}{resource};	564	my $r = $term->{meta}{resource};
603	keys %$r; # reste iterator	565	keys %$r; # reset iterator
604	while (my ($pattern, $v) = each %$r) {	566	while (my ($k, $v) = each %$r) {
605	if (	567	my $pattern = $k;
		568	$pattern =~ y/./-/ if $isarg;
		569	my $prefix = $name;
		570	my $suffix;
606	$pattern =~ /\.$/	571	if ($pattern =~ /\-$/) {
607	? $pattern eq substr $name, 0, length $pattern	572	$prefix = substr $name, 0, length $pattern;
608	: $pattern eq $name	573	$suffix = substr $name, length $pattern;
609	) {	574	}
		575	if ($pattern eq $prefix) {
610	$name = "$urxvt::RESCLASS.$name";	576	$name = "$urxvt::RESCLASS.$k$suffix";
611		577
612	push @{ $term->{perl_ext_3} }, $v->[0];	578	push @{ $term->{perl_ext_3} }, $v->[0];
613		579
614	if ($v->[1] eq "boolean") {	580	if ($v->[1] eq "boolean") {
615	$term->put_option_db ($name, $flag ? "true" : "false");	581	$term->put_option_db ($name, $flag ? "true" : "false");
…		…
625	}	591	}
626		592
627	sub usage {	593	sub usage {
628	my ($term, $usage_type) = @_;	594	my ($term, $usage_type) = @_;
629		595
630	$term->scan_meta;	596	$term->scan_extensions;
631		597
632	my $r = $term->{meta}{resource};	598	my $r = $term->{meta}{resource};
633		599
634	for my $pattern (sort keys %$r) {	600	for my $pattern (sort keys %$r) {
635	my ($ext, $type, $desc) = @{ $r->{$pattern} };	601	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
696	# called by the rxvt core	662	# called by the rxvt core
697	sub invoke {	663	sub invoke {
698	local $TERM = shift;	664	local $TERM = shift;
699	my $htype = shift;	665	my $htype = shift;
700		666
701	if ($htype == 0) { # INIT	667	if ($htype == HOOK_INIT) {
702	my @dirs = $TERM->perl_libdirs;	668	my @dirs = $TERM->perl_libdirs;
		669
		670	$TERM->scan_extensions;
703		671
704	my %ext_arg;	672	my %ext_arg;
705		673
706	{	674	{
707	my @init = @TERM_INIT;	675	my @init = @TERM_INIT;
…		…
711	@TERM_EXT = ();	679	@TERM_EXT = ();
712	$TERM->register_package ($_) for @pkg;	680	$TERM->register_package ($_) for @pkg;
713	}	681	}
714		682
715	for (	683	for (
		684	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
716	@{ delete $TERM->{perl_ext_3} },	685	@{ delete $TERM->{perl_ext_3} }
717	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
718	) {	686	) {
719	if ($_ eq "default") {	687	if ($_ eq "default") {
720	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	688
		689	$ext_arg{$_} = []
		690	for
		691	qw(selection option-popup selection-popup readline),
		692	map $_->[0], values %{ $TERM->{meta}{binding} };
		693
		694	for ($TERM->_keysym_resources) {
		695	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		696	next unless /^([A-Za-z0-9_\-]+):/;
		697
		698	my $ext = $1;
		699
		700	$ext_arg{$ext} = [];
		701	}
		702
721	} elsif (/^-(.*)$/) {	703	} elsif (/^-(.*)$/) {
722	delete $ext_arg{$1};	704	delete $ext_arg{$1};
		705
723	} elsif (/^([^<]+)<(.*)>$/) {	706	} elsif (/^([^<]+)<(.*)>$/) {
724	push @{ $ext_arg{$1} }, $2;	707	push @{ $ext_arg{$1} }, $2;
		708
725	} else {	709	} else {
726	$ext_arg{$_} \|\|= [];	710	$ext_arg{$_} \|\|= [];
		711	}
		712	}
		713
		714	# now register default key bindings
		715	for my $ext (sort keys %ext_arg) {
		716	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		717	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
727	}	718	}
728	}	719	}
729		720
730	for my $ext (sort keys %ext_arg) {	721	for my $ext (sort keys %ext_arg) {
731	my @files = grep -f $_, map "$_/$ext", @dirs;	722	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
745		736
746	if (my $cb = $TERM->{_hook}[$htype]) {	737	if (my $cb = $TERM->{_hook}[$htype]) {
747	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	738	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
748	if $verbosity >= 10;	739	if $verbosity >= 10;
749		740
		741	if ($htype == HOOK_ACTION) {
		742	# this hook is only sent to the extension with the name
		743	# matching the first arg
		744	my $pkg = shift;
		745	$pkg =~ y/-/_/;
		746	$pkg = "urxvt::ext::$pkg";
		747
		748	$cb = $cb->{$pkg}
		749	or return undef; #TODO: maybe warn user?
		750
		751	$cb = { $pkg => $cb };
		752	}
		753
750	for my $pkg (keys %$cb) {	754	for my $pkg (keys %$cb) {
751	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };	755	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
752	$retval \|\|= $retval_;	756	$retval \|\|= $retval_;
753		757
754	if ($@) {	758	if ($@) {
…		…
759		763
760	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	764	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
761	if $verbosity >= 11;	765	if $verbosity >= 11;
762	}	766	}
763		767
764	if ($htype == 1) { # DESTROY	768	if ($htype == HOOK_DESTROY) {
765	# clear package objects	769	# clear package objects
766	%$_ = () for values %{ $TERM->{_pkg} };	770	%$_ = () for values %{ $TERM->{_pkg} };
767		771
768	# clear package	772	# clear package
769	%$TERM = ();	773	%$TERM = ();
…		…
801	($mask, @color{qw(fg bg)}, \@failed)	805	($mask, @color{qw(fg bg)}, \@failed)
802	}	806	}
803		807
804	package urxvt::term::extension;	808	package urxvt::term::extension;
805		809
806	sub enable {	810	=head2 The C<urxvt::term::extension> class
807	my ($self, %hook) = @_;
808	my $pkg = $self->{_pkg};
809		811
810	while (my ($name, $cb) = each %hook) {	812	Each extension attached to a terminal object is represented by
811	my $htype = $HOOKTYPE{uc $name};	813	a C<urxvt::term::extension> object.
812	defined $htype
813	or Carp::croak "unsupported hook type '$name'";
814		814
815	$self->set_should_invoke ($htype, +1)	815	You can use these objects, which are passed to all callbacks to store any
816	unless exists $self->{term}{_hook}[$htype]{$pkg};	816	state related to the terminal and extension instance.
817		817
818	$self->{term}{_hook}[$htype]{$pkg} = $cb;	818	The methods (And data members) documented below can be called on extension
819	}	819	objects, in addition to call methods documented for the <urxvt::term>
820	}	820	class.
821		821
822	sub disable {	822	=over 4
823	my ($self, @hook) = @_;
824	my $pkg = $self->{_pkg};
825		823
826	for my $name (@hook) {	824	=item $urxvt_term = $self->{term}
827	my $htype = $HOOKTYPE{uc $name};
828	defined $htype
829	or Carp::croak "unsupported hook type '$name'";
830		825
831	$self->set_should_invoke ($htype, -1)	826	Returns the C<urxvt::term> object associated with this instance of the
832	if delete $self->{term}{_hook}[$htype]{$pkg};	827	extension. This member I<must not> be changed in any way.
833	}	828
834	}	829	=cut
835		830
836	our $AUTOLOAD;	831	our $AUTOLOAD;
837		832
838	sub AUTOLOAD {	833	sub AUTOLOAD {
839	$AUTOLOAD =~ /:([^:]+)$/	834	$AUTOLOAD =~ /:([^:]+)$/
…		…
852		847
853	sub DESTROY {	848	sub DESTROY {
854	# nop	849	# nop
855	}	850	}
856		851
857	# urxvt::destroy_hook	852	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
858		853
859	sub urxvt::destroy_hook::DESTROY {	854	sub urxvt::destroy_hook::DESTROY {
860	${$_[0]}->();	855	${$_[0]}->();
861	}	856	}
862		857
863	sub urxvt::destroy_hook(&) {	858	sub urxvt::destroy_hook(&) {
864	bless \shift, urxvt::destroy_hook::	859	bless \shift, urxvt::destroy_hook::
865	}	860	}
		861
		862	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		863
		864	Dynamically enable the given hooks (named without the C<on_> prefix) for
		865	this extension, replacing any hook previously installed via C<enable> in
		866	this extension.
		867
		868	This is useful when you want to overwrite time-critical hooks only
		869	temporarily.
		870
		871	To install additional callbacks for the same hook, you can use the C<on>
		872	method of the C<urxvt::term> class.
		873
		874	=item $self->disable ($hook_name[, $hook_name..])
		875
		876	Dynamically disable the given hooks.
		877
		878	=cut
		879
		880	sub enable {
		881	my ($self, %hook) = @_;
		882	my $pkg = $self->{_pkg};
		883
		884	while (my ($name, $cb) = each %hook) {
		885	my $htype = $HOOKTYPE{uc $name};
		886	defined $htype
		887	or Carp::croak "unsupported hook type '$name'";
		888
		889	$self->set_should_invoke ($htype, +1)
		890	unless exists $self->{term}{_hook}[$htype]{$pkg};
		891
		892	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		893	}
		894	}
		895
		896	sub disable {
		897	my ($self, @hook) = @_;
		898	my $pkg = $self->{_pkg};
		899
		900	for my $name (@hook) {
		901	my $htype = $HOOKTYPE{uc $name};
		902	defined $htype
		903	or Carp::croak "unsupported hook type '$name'";
		904
		905	$self->set_should_invoke ($htype, -1)
		906	if delete $self->{term}{_hook}[$htype]{$pkg};
		907	}
		908	}
		909
		910	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		911
		912	Similar to the C<enable> enable, but installs additional callbacks for
		913	the given hook(s) (that is, it doesn't replace existing callbacks), and
		914	returns a guard object. When the guard object is destroyed the callbacks
		915	are disabled again.
		916
		917	=cut
		918
		919	sub urxvt::extension::on_disable::DESTROY {
		920	my $disable = shift;
		921
		922	my $term = delete $disable->{""};
		923
		924	while (my ($htype, $id) = each %$disable) {
		925	delete $term->{_hook}[$htype]{$id};
		926	$term->set_should_invoke ($htype, -1);
		927	}
		928	}
		929
		930	sub on {
		931	my ($self, %hook) = @_;
		932
		933	my $term = $self->{term};
		934
		935	my %disable = ( "" => $term );
		936
		937	while (my ($name, $cb) = each %hook) {
		938	my $htype = $HOOKTYPE{uc $name};
		939	defined $htype
		940	or Carp::croak "unsupported hook type '$name'";
		941
		942	$term->set_should_invoke ($htype, +1);
		943	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		944	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		945	}
		946
		947	bless \%disable, "urxvt::extension::on_disable"
		948	}
		949
		950	=item $self->x_resource ($pattern)
		951
		952	=item $self->x_resource_boolean ($pattern)
		953
		954	These methods support an additional C<%> prefix when called on an
		955	extension object - see the description of these methods in the
		956	C<urxvt::term> class for details.
		957
		958	=cut
866		959
867	sub x_resource {	960	sub x_resource {
868	my ($self, $name) = @_;	961	my ($self, $name) = @_;
869	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	962	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
870	$self->{term}->x_resource ($name)	963	$self->{term}->x_resource ($name)
…		…
873	sub x_resource_boolean {	966	sub x_resource_boolean {
874	my ($self, $name) = @_;	967	my ($self, $name) = @_;
875	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	968	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
876	$self->{term}->x_resource_boolean ($name)	969	$self->{term}->x_resource_boolean ($name)
877	}	970	}
		971
		972	=back
		973
		974	=cut
878		975
879	package urxvt::anyevent;	976	package urxvt::anyevent;
880		977
881	=head2 The C<urxvt::anyevent> Class	978	=head2 The C<urxvt::anyevent> Class
882		979
…		…
1001	$ENV{URXVT_PERL_LIB},	1098	$ENV{URXVT_PERL_LIB},
1002	"$ENV{HOME}/.urxvt/ext",	1099	"$ENV{HOME}/.urxvt/ext",
1003	"$LIBDIR/perl"	1100	"$LIBDIR/perl"
1004	}	1101	}
1005		1102
1006	sub scan_meta {	1103	# scan for available extensions and collect their metadata
		1104	sub scan_extensions {
1007	my ($self) = @_;	1105	my ($self) = @_;
		1106
		1107	return if exists $self->{meta};
		1108
1008	my @libdirs = perl_libdirs $self;	1109	my @libdirs = perl_libdirs $self;
1009		1110
1010	return if $self->{meta_libdirs} eq join "\x00", @libdirs;	1111	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1011		1112
1012	my %meta;
1013
1014	$self->{meta_libdirs} = join "\x00", @libdirs;	1113	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1015	$self->{meta} = \%meta;	1114	$self->{meta} = \my %meta;
1016		1115
		1116	# first gather extensions
1017	for my $dir (reverse @libdirs) {	1117	for my $dir (reverse @libdirs) {
1018	opendir my $fh, $dir	1118	opendir my $fh, $dir
1019	or next;	1119	or next;
1020	for my $ext (readdir $fh) {	1120	for my $ext (readdir $fh) {
1021	$ext ne "."	1121	$ext !~ /^\./
1022	and $ext ne ".."
1023	and open my $fh, "<", "$dir/$ext"	1122	and open my $fh, "<", "$dir/$ext"
1024	or next;	1123	or next;
1025		1124
		1125	my %ext = (dir => $dir);
		1126
1026	while (<$fh>) {	1127	while (<$fh>) {
1027	if (/^#:META:X_RESOURCE:(.*)/) {	1128	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1028	my ($pattern, $type, $desc) = split /:/, $1;	1129	my ($pattern, $type, $desc) = split /:/, $1;
1029	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1130	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1030	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1131	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1031	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1132	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1032	} else {	1133	} else {
1033	$meta{resource}{$pattern} = [$ext, $type, $desc];	1134	$ext{resource}{$pattern} = [$ext, $type, $desc];
1034	}	1135	}
		1136	} elsif (/^#:META:BINDING:(.*)/) {
		1137	my ($keysym, $action) = split /:/, $1;
		1138	$ext{binding}{$keysym} = [$ext, $action];
1035	} elsif (/^\s*(?:#\|$)/) {	1139	} elsif (/^\s*(?:#\|$)/) {
1036	# skip other comments and empty lines	1140	# skip other comments and empty lines
1037	} else {	1141	} else {
1038	last; # stop parsing on first non-empty non-comment line	1142	last; # stop parsing on first non-empty non-comment line
1039	}	1143	}
1040	}	1144	}
		1145
		1146	$meta{ext}{$ext} = \%ext;
1041	}	1147	}
		1148	}
		1149
		1150	# and now merge resources and bindings
		1151	while (my ($k, $v) = each %{ $meta{ext} }) {
		1152	#TODO: should check for extensions overriding each other
		1153	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1154	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1042	}	1155	}
1043	}	1156	}
1044		1157
1045	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1158	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1046		1159
…		…
1066	}	1179	}
1067		1180
1068	=item $term->destroy	1181	=item $term->destroy
1069		1182
1070	Destroy the terminal object (close the window, free resources	1183	Destroy the terminal object (close the window, free resources
1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1184	etc.). Please note that urxvt will not exit as long as any event
1072	watchers (timers, io watchers) are still active.	1185	watchers (timers, io watchers) are still active.
1073
1074	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
1075
1076	Similar to the extension method C<enable>, but installs additional
1077	callbacks for the given hook(s) (existing ones are not replaced), and
1078	returns a guard object. When the guard object is destroyed the callbacks
1079	are disabled again.
1080
1081	Note that these callbacks receive the normal parameters, but the first
1082	argument (normally the extension) is currently undefined.
1083
1084	=cut
1085
1086	sub urxvt::term::on_disable::DESTROY {
1087	my $disable = shift;
1088
1089	my $self = delete $disable->{""};
1090
1091	while (my ($htype, $id) = each %$disable) {
1092	delete $self->{_hook}[$htype]{$id};
1093	$self->set_should_invoke ($htype, -1);
1094	}
1095	}
1096
1097	sub on {
1098	my ($self, %hook) = @_;
1099
1100	my %disable = ( "" => $self );
1101
1102	while (my ($name, $cb) = each %hook) {
1103	my $htype = $HOOKTYPE{uc $name};
1104	defined $htype
1105	or Carp::croak "unsupported hook type '$name'";
1106
1107	my $id = $cb+0;
1108
1109	$self->set_should_invoke ($htype, +1);
1110	$disable{$htype} = $id;
1111	$self->{_hook}[$htype]{$id} = $cb;
1112	}
1113
1114	bless \%disable, "urxvt::term::on_disable"
1115	}
1116		1186
1117	=item $term->exec_async ($cmd[, @args])	1187	=item $term->exec_async ($cmd[, @args])
1118		1188
1119	Works like the combination of the C<fork>/C<exec> builtins, which executes	1189	Works like the combination of the C<fork>/C<exec> builtins, which executes
1120	("starts") programs in the background. This function takes care of setting	1190	("starts") programs in the background. This function takes care of setting
…		…
1205	Returns the X-Resource for the given pattern, excluding the program or	1275	Returns the X-Resource for the given pattern, excluding the program or
1206	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1276	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1207	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1277	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1208	resource with that pattern exists.	1278	resource with that pattern exists.
1209		1279
1210	Extensions that define extra resource or command line arguments also need	1280	Extensions that define extra resources also need to call this method
1211	to call this method to access their values.	1281	to access their values.
1212		1282
1213	If the method is called on an extension object (basically, from an	1283	If the method is called on an extension object (basically, from an
1214	extension), then the special prefix C<%.> will be replaced by the name of	1284	extension), then the special prefix C<%.> will be replaced by the name of
1215	the extension and a dot, and the lone string C<%> will be replaced by the	1285	the extension and a dot, and the lone string C<%> will be replaced by the
1216	extension name itself. This makes it possible to code extensions so you	1286	extension name itself. This makes it possible to code extensions so you
…		…
1235	my $res = &x_resource;	1305	my $res = &x_resource;
1236		1306
1237	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1307	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1238	}	1308	}
1239		1309
1240	=item $success = $term->parse_keysym ($key, $octets)	1310	=item $success = $term->bind_action ($key, $octets)
1241		1311
1242	Adds a key binding exactly as specified via a resource. See the	1312	Adds a key binding exactly as specified via a C<keysym> resource. See the
1243	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1313	C<keysym> resource in the urxvt(1) manpage.
1244
1245	=item $term->register_command ($keysym, $modifiermask, $string)
1246
1247	Adds a key binding. This is a lower level api compared to
1248	C<parse_keysym>, as it expects a parsed key description, and can be
1249	used only inside either the C<on_init> hook, to add a binding, or the
1250	C<on_register_command> hook, to modify a parsed binding.
1251		1314
1252	=item $rend = $term->rstyle ([$new_rstyle])	1315	=item $rend = $term->rstyle ([$new_rstyle])
1253		1316
1254	Return and optionally change the current rendition. Text that is output by	1317	Return and optionally change the current rendition. Text that is output by
1255	the terminal application will use this style.	1318	the terminal application will use this style.
…		…
1435	=item $term->tt_write ($octets)	1498	=item $term->tt_write ($octets)
1436		1499
1437	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1500	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1438	pass characters instead of octets, you should convert your strings first	1501	pass characters instead of octets, you should convert your strings first
1439	to the locale-specific encoding using C<< $term->locale_encode >>.	1502	to the locale-specific encoding using C<< $term->locale_encode >>.
		1503
		1504	=item $term->tt_write_user_input ($octets)
		1505
		1506	Like C<tt_write>, but should be used when writing strings in response to
		1507	the user pressing a key, to invoke the additional actions requested by
		1508	the user for that case (C<tt_write> doesn't do that).
		1509
		1510	The typical use case would be inside C<on_action> hooks.
1440		1511
1441	=item $term->tt_paste ($octets)	1512	=item $term->tt_paste ($octets)
1442		1513
1443	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1514	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1444	CR and bracketing the data with control sequences if bracketed paste mode	1515	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1678	}	1749	}
1679		1750
1680	sub urxvt::line::t {	1751	sub urxvt::line::t {
1681	my ($self) = @_;	1752	my ($self) = @_;
1682		1753
1683	if (@_ > 1)	1754	if (@_ > 1) {
1684	{
1685	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1755	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1686	for $self->{beg} .. $self->{end};	1756	for $self->{beg} .. $self->{end};
1687	}	1757	}
1688		1758
1689	defined wantarray &&	1759	defined wantarray &&
1690	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1760	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1691	0, $self->{len}	1761	0, $self->{len}
1692	}	1762	}
1693		1763
1694	sub urxvt::line::r {	1764	sub urxvt::line::r {
1695	my ($self) = @_;	1765	my ($self) = @_;
1696		1766
1697	if (@_ > 1)	1767	if (@_ > 1) {
1698	{
1699	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1768	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1700	for $self->{beg} .. $self->{end};	1769	for $self->{beg} .. $self->{end};
1701	}	1770	}
1702		1771
1703	if (defined wantarray) {	1772	if (defined wantarray) {
1704	my $rend = [	1773	my $rend = [
1705	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1774	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1706	];	1775	];

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.221 by sf-exg, Thu Jun 21 06:08:05 2012 UTC vs. Revision 1.243 by sf-exg, Sat Oct 11 22:02:50 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.221 by sf-exg, Thu Jun 21 06:08:05 2012 UTC vs.
Revision 1.243 by sf-exg, Sat Oct 11 22:02:50 2014 UTC