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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.218 by root, Sun Jun 10 17:31:53 2012 UTC vs.
Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 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 vewiwed	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 that add command line parameters or resources on their own are
49	laoded automatically when used.	49	loaded automatically when used.
50		50
51	=head1 API DOCUMENTATION	51	=head1 API DOCUMENTATION
52		52
53	=head2 General API Considerations	53	=head2 General API Considerations
54		54
103	internal use.	103	internal use.
104		104
105	Although it isn't a C<urxvt::term> object, you can call all methods of the	105	Although it isn't a C<urxvt::term> object, you can call all methods of the
106	C<urxvt::term> class on this object.	106	C<urxvt::term> class on this object.
107		107
108	It has the following methods and data members:	108	Additional methods only supported for extension objects are described in
109		109	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	=item $self->disable ($hook_name[, $hook_name..])
124
125	Dynamically disable the given hooks.
126
127	=back
128		110
129	=head2 Hooks	111	=head2 Hooks
130		112
131	The following subroutines can be declared in extension files, and will be	113	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	114	called whenever the relevant event happens.
…		…
299		281
300	=item on_refresh_end $term	282	=item on_refresh_end $term
301		283
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	284	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		285
304	=item on_user_command $term, $string	286	=item on_user_command $term, $string DEPRECATED
305		287
306	Called whenever a user-configured event is being activated (e.g. via	288	Called whenever a user-configured event is being activated (e.g. via
307	a C<perl:string> action bound to a key, see description of the B<keysym>	289	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	290	resource in the urxvt(1) manpage).
309		291
310	The event is simply the action string. This interface is assumed to change	292	The event is simply the action string. This interface is going away in
311	slightly in the future.	293	preference to the C<on_action> hook.
312
313	=item on_register_command $term, $keysym, $modifiermask, $string
314
315	Called after parsing a keysym resource but before registering the
316	associated binding. If this hook returns TRUE the binding is not
317	registered. It can be used to modify a binding by calling
318	C<register_command>.
319		294
320	=item on_resize_all_windows $term, $new_width, $new_height	295	=item on_resize_all_windows $term, $new_width, $new_height
321		296
322	Called just after the new window size has been calculated, but before	297	Called just after the new window size has been calculated, but before
323	windows are actually being resized or hints are being set. If this hook	298	windows are actually being resized or hints are being set. If this hook
324	returns TRUE, setting of the window hints is being skipped.	299	returns a true value, setting of the window hints is being skipped.
325		300
326	=item on_x_event $term, $event	301	=item on_x_event $term, $event
327		302
328	Called on every X event received on the vt window (and possibly other	303	Called on every X event received on the vt window (and possibly other
329	windows). Should only be used as a last resort. Most event structure	304	windows). Should only be used as a last resort. Most event structure
…		…
368	manpage), with the additional members C<row> and C<col>, which are the	343	manpage), with the additional members C<row> and C<col>, which are the
369	(real, not screen-based) row and column under the mouse cursor.	344	(real, not screen-based) row and column under the mouse cursor.
370		345
371	C<on_key_press> additionally receives the string rxvt-unicode would	346	C<on_key_press> additionally receives the string rxvt-unicode would
372	output, if any, in locale-specific encoding.	347	output, if any, in locale-specific encoding.
373
374	subwindow.
375		348
376	=item on_client_message $term, $event	349	=item on_client_message $term, $event
377		350
378	=item on_wm_protocols $term, $event	351	=item on_wm_protocols $term, $event
379		352
…		…
582	no warnings 'utf8';	555	no warnings 'utf8';
583		556
584	sub parse_resource {	557	sub parse_resource {
585	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	558	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
586		559
587	$name =~ y/-/./ if $isarg;
588
589	$term->scan_meta;	560	$term->scan_extensions;
590		561
591	my $r = $term->{meta}{resource};	562	my $r = $term->{meta}{resource};
592	keys %$r; # reste iterator	563	keys %$r; # reset iterator
593	while (my ($pattern, $v) = each %$r) {	564	while (my ($k, $v) = each %$r) {
594	if (	565	my $pattern = $k;
		566	$pattern =~ y/./-/ if $isarg;
		567	my $prefix = $name;
		568	my $suffix;
595	$pattern =~ /\.$/	569	if ($pattern =~ /\-$/) {
596	? $pattern eq substr $name, 0, length $pattern	570	$prefix = substr $name, 0, length $pattern;
597	: $pattern eq $name	571	$suffix = substr $name, length $pattern;
598	) {	572	}
		573	if ($pattern eq $prefix) {
599	$name = "$urxvt::RESCLASS.$name";	574	$name = "$urxvt::RESCLASS.$k$suffix";
600		575
601	push @{ $term->{perl_ext_3} }, $v->[0];	576	push @{ $term->{perl_ext_3} }, $v->[0];
602		577
603	if ($v->[1] eq "boolean") {	578	if ($v->[1] eq "boolean") {
604	$term->put_option_db ($name, $flag ? "true" : "false");	579	$term->put_option_db ($name, $flag ? "true" : "false");
…		…
614	}	589	}
615		590
616	sub usage {	591	sub usage {
617	my ($term, $usage_type) = @_;	592	my ($term, $usage_type) = @_;
618		593
619	$term->scan_meta;	594	$term->scan_extensions;
620		595
621	my $r = $term->{meta}{resource};	596	my $r = $term->{meta}{resource};
622		597
623	for my $pattern (sort keys %$r) {	598	for my $pattern (sort keys %$r) {
624	my ($ext, $type, $desc) = @{ $r->{$pattern} };	599	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
685	# called by the rxvt core	660	# called by the rxvt core
686	sub invoke {	661	sub invoke {
687	local $TERM = shift;	662	local $TERM = shift;
688	my $htype = shift;	663	my $htype = shift;
689		664
690	if ($htype == 0) { # INIT	665	if ($htype == HOOK_INIT) {
691	my @dirs = $TERM->perl_libdirs;	666	my @dirs = $TERM->perl_libdirs;
		667
		668	$TERM->scan_extensions;
692		669
693	my %ext_arg;	670	my %ext_arg;
694		671
695	{	672	{
696	my @init = @TERM_INIT;	673	my @init = @TERM_INIT;
…		…
700	@TERM_EXT = ();	677	@TERM_EXT = ();
701	$TERM->register_package ($_) for @pkg;	678	$TERM->register_package ($_) for @pkg;
702	}	679	}
703		680
704	for (	681	for (
705	@{ delete $TERM->{perl_ext_3} },
706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	682	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
707	) {	683	) {
708	if ($_ eq "default") {	684	if ($_ eq "default") {
709	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	685
		686	$ext_arg{$_} = []
		687	for
		688	qw(selection option-popup selection-popup readline),
		689	@{ delete $TERM->{perl_ext_3} },
		690	map $_->[0], values %{ $TERM->{meta}{binding} };
		691
		692	for ($TERM->_keysym_resources) {
		693	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		694	next unless /^([A-Za-z0-9_\-]+):/;
		695
		696	my $ext = $1;
		697
		698	$ext_arg{$ext} = [];
		699	}
		700
710	} elsif (/^-(.*)$/) {	701	} elsif (/^-(.*)$/) {
711	delete $ext_arg{$1};	702	delete $ext_arg{$1};
		703
712	} elsif (/^([^<]+)<(.*)>$/) {	704	} elsif (/^([^<]+)<(.*)>$/) {
713	push @{ $ext_arg{$1} }, $2;	705	push @{ $ext_arg{$1} }, $2;
		706
714	} else {	707	} else {
715	$ext_arg{$_} \|\|= [];	708	$ext_arg{$_} \|\|= [];
		709	}
		710	}
		711
		712	# now register default key bindings
		713	for my $ext (sort keys %ext_arg) {
		714	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		715	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
716	}	716	}
717	}	717	}
718		718
719	for my $ext (sort keys %ext_arg) {	719	for my $ext (sort keys %ext_arg) {
720	my @files = grep -f $_, map "$_/$ext", @dirs;	720	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
734		734
735	if (my $cb = $TERM->{_hook}[$htype]) {	735	if (my $cb = $TERM->{_hook}[$htype]) {
736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
737	if $verbosity >= 10;	737	if $verbosity >= 10;
738		738
		739	if ($htype == HOOK_ACTION) {
		740	# this hook is only sent to the extension with the name
		741	# matching the first arg
		742	my $pkg = shift;
		743	$pkg =~ y/-/_/;
		744	$pkg = "urxvt::ext::$pkg";
		745
		746	$cb = $cb->{$pkg}
		747	or return undef; #TODO: maybe warn user?
		748
		749	$cb = { $pkg => $cb };
		750	}
		751
739	for my $pkg (keys %$cb) {	752	for my $pkg (keys %$cb) {
740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	753	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
741	$retval \|\|= $retval_;	754	$retval \|\|= $retval_;
742		755
743	if ($@) {	756	if ($@) {
744	$TERM->ungrab; # better to lose the grab than the session	757	$TERM->ungrab; # better to lose the grab than the session
745	warn $@;	758	warn $@;
…		…
748		761
749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	762	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
750	if $verbosity >= 11;	763	if $verbosity >= 11;
751	}	764	}
752		765
753	if ($htype == 1) { # DESTROY	766	if ($htype == HOOK_DESTROY) {
754	# clear package objects	767	# clear package objects
755	%$_ = () for values %{ $TERM->{_pkg} };	768	%$_ = () for values %{ $TERM->{_pkg} };
756		769
757	# clear package	770	# clear package
758	%$TERM = ();	771	%$TERM = ();
…		…
790	($mask, @color{qw(fg bg)}, \@failed)	803	($mask, @color{qw(fg bg)}, \@failed)
791	}	804	}
792		805
793	package urxvt::term::extension;	806	package urxvt::term::extension;
794		807
795	sub enable {	808	=head2 The C<urxvt::term::extension> class
796	my ($self, %hook) = @_;
797	my $pkg = $self->{_pkg};
798		809
799	while (my ($name, $cb) = each %hook) {	810	Each extension attached to a terminal object is represented by
800	my $htype = $HOOKTYPE{uc $name};	811	a C<urxvt::term::extension> object.
801	defined $htype
802	or Carp::croak "unsupported hook type '$name'";
803		812
804	$self->set_should_invoke ($htype, +1)	813	You can use these objects, which are passed to all callbacks to store any
805	unless exists $self->{term}{_hook}[$htype]{$pkg};	814	state related to the terminal and extension instance.
806		815
807	$self->{term}{_hook}[$htype]{$pkg} = $cb;	816	The methods (And data members) documented below can be called on extension
808	}	817	objects, in addition to call methods documented for the <urxvt::term>
809	}	818	class.
810		819
811	sub disable {	820	=over 4
812	my ($self, @hook) = @_;
813	my $pkg = $self->{_pkg};
814		821
815	for my $name (@hook) {	822	=item $urxvt_term = $self->{term}
816	my $htype = $HOOKTYPE{uc $name};
817	defined $htype
818	or Carp::croak "unsupported hook type '$name'";
819		823
820	$self->set_should_invoke ($htype, -1)	824	Returns the C<urxvt::term> object associated with this instance of the
821	if delete $self->{term}{_hook}[$htype]{$pkg};	825	extension. This member I<must not> be changed in any way.
822	}	826
823	}	827	=cut
824		828
825	our $AUTOLOAD;	829	our $AUTOLOAD;
826		830
827	sub AUTOLOAD {	831	sub AUTOLOAD {
828	$AUTOLOAD =~ /:([^:]+)$/	832	$AUTOLOAD =~ /:([^:]+)$/
…		…
841		845
842	sub DESTROY {	846	sub DESTROY {
843	# nop	847	# nop
844	}	848	}
845		849
846	# urxvt::destroy_hook	850	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
847		851
848	sub urxvt::destroy_hook::DESTROY {	852	sub urxvt::destroy_hook::DESTROY {
849	${$_[0]}->();	853	${$_[0]}->();
850	}	854	}
851		855
852	sub urxvt::destroy_hook(&) {	856	sub urxvt::destroy_hook(&) {
853	bless \shift, urxvt::destroy_hook::	857	bless \shift, urxvt::destroy_hook::
854	}	858	}
		859
		860	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		861
		862	Dynamically enable the given hooks (named without the C<on_> prefix) for
		863	this extension, replacing any hook previously installed via C<enable> in
		864	this extension.
		865
		866	This is useful when you want to overwrite time-critical hooks only
		867	temporarily.
		868
		869	To install additional callbacks for the same hook, you can use the C<on>
		870	method of the C<urxvt::term> class.
		871
		872	=item $self->disable ($hook_name[, $hook_name..])
		873
		874	Dynamically disable the given hooks.
		875
		876	=cut
		877
		878	sub enable {
		879	my ($self, %hook) = @_;
		880	my $pkg = $self->{_pkg};
		881
		882	while (my ($name, $cb) = each %hook) {
		883	my $htype = $HOOKTYPE{uc $name};
		884	defined $htype
		885	or Carp::croak "unsupported hook type '$name'";
		886
		887	$self->set_should_invoke ($htype, +1)
		888	unless exists $self->{term}{_hook}[$htype]{$pkg};
		889
		890	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		891	}
		892	}
		893
		894	sub disable {
		895	my ($self, @hook) = @_;
		896	my $pkg = $self->{_pkg};
		897
		898	for my $name (@hook) {
		899	my $htype = $HOOKTYPE{uc $name};
		900	defined $htype
		901	or Carp::croak "unsupported hook type '$name'";
		902
		903	$self->set_should_invoke ($htype, -1)
		904	if delete $self->{term}{_hook}[$htype]{$pkg};
		905	}
		906	}
		907
		908	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		909
		910	Similar to the C<enable> enable, but installs additional callbacks for
		911	the given hook(s) (that is, it doesn't replace existing callbacks), and
		912	returns a guard object. When the guard object is destroyed the callbacks
		913	are disabled again.
		914
		915	=cut
		916
		917	sub urxvt::extension::on_disable::DESTROY {
		918	my $disable = shift;
		919
		920	my $term = delete $disable->{""};
		921
		922	while (my ($htype, $id) = each %$disable) {
		923	delete $term->{_hook}[$htype]{$id};
		924	$term->set_should_invoke ($htype, -1);
		925	}
		926	}
		927
		928	sub on {
		929	my ($self, %hook) = @_;
		930
		931	my $term = $self->{term};
		932
		933	my %disable = ( "" => $term );
		934
		935	while (my ($name, $cb) = each %hook) {
		936	my $htype = $HOOKTYPE{uc $name};
		937	defined $htype
		938	or Carp::croak "unsupported hook type '$name'";
		939
		940	$term->set_should_invoke ($htype, +1);
		941	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		942	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		943	}
		944
		945	bless \%disable, "urxvt::extension::on_disable"
		946	}
		947
		948	=item $self->x_resource ($pattern)
		949
		950	=item $self->x_resource_boolean ($pattern)
		951
		952	These methods support an additional C<%> prefix when called on an
		953	extension object - see the description of these methods in the
		954	C<urxvt::term> class for details.
		955
		956	=cut
855		957
856	sub x_resource {	958	sub x_resource {
857	my ($self, $name) = @_;	959	my ($self, $name) = @_;
858	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	960	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
859	$self->{term}->x_resource ($name)	961	$self->{term}->x_resource ($name)
…		…
862	sub x_resource_boolean {	964	sub x_resource_boolean {
863	my ($self, $name) = @_;	965	my ($self, $name) = @_;
864	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	966	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
865	$self->{term}->x_resource_boolean ($name)	967	$self->{term}->x_resource_boolean ($name)
866	}	968	}
		969
		970	=back
		971
		972	=cut
867		973
868	package urxvt::anyevent;	974	package urxvt::anyevent;
869		975
870	=head2 The C<urxvt::anyevent> Class	976	=head2 The C<urxvt::anyevent> Class
871		977
…		…
990	$ENV{URXVT_PERL_LIB},	1096	$ENV{URXVT_PERL_LIB},
991	"$ENV{HOME}/.urxvt/ext",	1097	"$ENV{HOME}/.urxvt/ext",
992	"$LIBDIR/perl"	1098	"$LIBDIR/perl"
993	}	1099	}
994		1100
995	sub scan_meta {	1101	# scan for available extensions and collect their metadata
		1102	sub scan_extensions {
996	my ($self) = @_;	1103	my ($self) = @_;
		1104
		1105	return if exists $self->{meta};
		1106
997	my @libdirs = perl_libdirs $self;	1107	my @libdirs = perl_libdirs $self;
998		1108
999	return if $self->{meta_libdirs} eq join "\x00", @libdirs;	1109	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1000		1110
1001	my %meta;
1002
1003	$self->{meta_libdirs} = join "\x00", @libdirs;	1111	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1004	$self->{meta} = \%meta;	1112	$self->{meta} = \my %meta;
1005		1113
		1114	# first gather extensions
1006	for my $dir (reverse @libdirs) {	1115	for my $dir (reverse @libdirs) {
1007	opendir my $fh, $dir	1116	opendir my $fh, $dir
1008	or next;	1117	or next;
1009	for my $ext (readdir $fh) {	1118	for my $ext (readdir $fh) {
1010	$ext ne "."	1119	$ext !~ /^\./
1011	and $ext ne ".."
1012	and open my $fh, "<", "$dir/$ext"	1120	and open my $fh, "<", "$dir/$ext"
1013	or next;	1121	or next;
1014		1122
		1123	my %ext = (dir => $dir);
		1124
1015	while (<$fh>) {	1125	while (<$fh>) {
1016	if (/^#:META:X_RESOURCE:(.*)/) {	1126	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1017	my ($pattern, $type, $desc) = split /:/, $1;	1127	my ($pattern, $type, $desc) = split /:/, $1;
1018	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1128	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1129	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1020	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1130	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1021	} else {	1131	} else {
1022	$meta{resource}{$pattern} = [$ext, $type, $desc];	1132	$ext{resource}{$pattern} = [$ext, $type, $desc];
1023	}	1133	}
		1134	} elsif (/^#:META:BINDING:(.*)/) {
		1135	my ($keysym, $action) = split /:/, $1;
		1136	$ext{binding}{$keysym} = [$ext, $action];
1024	} elsif (/^\s*(?:#\|$)/) {	1137	} elsif (/^\s*(?:#\|$)/) {
1025	# skip other comments and empty lines	1138	# skip other comments and empty lines
1026	} else {	1139	} else {
1027	last; # stop parsing on first non-empty non-comment line	1140	last; # stop parsing on first non-empty non-comment line
1028	}	1141	}
1029	}	1142	}
		1143
		1144	$meta{ext}{$ext} = \%ext;
1030	}	1145	}
		1146	}
		1147
		1148	# and now merge resources and bindings
		1149	while (my ($k, $v) = each %{ $meta{ext} }) {
		1150	#TODO: should check for extensions overriding each other
		1151	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1152	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1031	}	1153	}
1032	}	1154	}
1033		1155
1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1156	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1035		1157
…		…
1055	}	1177	}
1056		1178
1057	=item $term->destroy	1179	=item $term->destroy
1058		1180
1059	Destroy the terminal object (close the window, free resources	1181	Destroy the terminal object (close the window, free resources
1060	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1182	etc.). Please note that urxvt will not exit as long as any event
1061	watchers (timers, io watchers) are still active.	1183	watchers (timers, io watchers) are still active.
1062		1184
1063	=item $term->exec_async ($cmd[, @args])	1185	=item $term->exec_async ($cmd[, @args])
1064		1186
1065	Works like the combination of the C<fork>/C<exec> builtins, which executes	1187	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1121		1243
1122	Here is a likely non-exhaustive list of resource names, not all of which	1244	Here is a likely non-exhaustive list of resource names, not all of which
1123	are supported in every build, please see the source file F</src/rsinc.h>	1245	are supported in every build, please see the source file F</src/rsinc.h>
1124	to see the actual list:	1246	to see the actual list:
1125		1247
1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1248	answerbackstring backgroundPixmap backspace_key blurradius
1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1249	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1250	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1129	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1251	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1130	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1252	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1253	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1156	Extensions that define extra resource or command line arguments also need	1278	Extensions that define extra resource or command line arguments also need
1157	to call this method to access their values.	1279	to call this method to access their values.
1158		1280
1159	If the method is called on an extension object (basically, from an	1281	If the method is called on an extension object (basically, from an
1160	extension), then the special prefix C<%.> will be replaced by the name of	1282	extension), then the special prefix C<%.> will be replaced by the name of
1161	the extension and a dot, and the lone string C<%> will be replcaed by the	1283	the extension and a dot, and the lone string C<%> will be replaced by the
1162	extension name itself. This makes it possible to code extensions so you	1284	extension name itself. This makes it possible to code extensions so you
1163	can rename them and get a new set of commandline switches and resources	1285	can rename them and get a new set of commandline switches and resources
1164	without having to change the actual code.	1286	without having to change the actual code.
1165		1287
1166	This method should only be called during the C<on_start> hook, as there is	1288	This method should only be called during the C<on_start> hook, as there is
…		…
1181	my $res = &x_resource;	1303	my $res = &x_resource;
1182		1304
1183	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1305	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1184	}	1306	}
1185		1307
1186	=item $success = $term->parse_keysym ($key, $octets)	1308	=item $success = $term->bind_action ($key, $octets)
1187		1309
1188	Adds a key binding exactly as specified via a resource. See the	1310	Adds a key binding exactly as specified via a C<keysym> resource. See the
1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1311	C<keysym> resource in the urxvt(1) manpage.
1190
1191	=item $term->register_command ($keysym, $modifiermask, $string)
1192
1193	Adds a key binding. This is a lower level api compared to
1194	C<parse_keysym>, as it expects a parsed key description, and can be
1195	used only inside either the C<on_init> hook, to add a binding, or the
1196	C<on_register_command> hook, to modify a parsed binding.
1197		1312
1198	=item $rend = $term->rstyle ([$new_rstyle])	1313	=item $rend = $term->rstyle ([$new_rstyle])
1199		1314
1200	Return and optionally change the current rendition. Text that is output by	1315	Return and optionally change the current rendition. Text that is output by
1201	the terminal application will use this style.	1316	the terminal application will use this style.
…		…
1381	=item $term->tt_write ($octets)	1496	=item $term->tt_write ($octets)
1382		1497
1383	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1498	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1384	pass characters instead of octets, you should convert your strings first	1499	pass characters instead of octets, you should convert your strings first
1385	to the locale-specific encoding using C<< $term->locale_encode >>.	1500	to the locale-specific encoding using C<< $term->locale_encode >>.
		1501
		1502	=item $term->tt_write_user_input ($octets)
		1503
		1504	Like C<tt_write>, but should be used when writing strings in response to
		1505	the user pressing a key, to invoke the additional actions requested by
		1506	the user for that case (C<tt_write> doesn't do that).
		1507
		1508	The typical use case would be inside C<on_action> hooks.
1386		1509
1387	=item $term->tt_paste ($octets)	1510	=item $term->tt_paste ($octets)
1388		1511
1389	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1512	Write the octets given in C<$octets> to the tty as a paste, converting NL to
1390	CR and bracketing the data with control sequences if bracketed paste mode	1513	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1624	}	1747	}
1625		1748
1626	sub urxvt::line::t {	1749	sub urxvt::line::t {
1627	my ($self) = @_;	1750	my ($self) = @_;
1628		1751
1629	if (@_ > 1)	1752	if (@_ > 1) {
1630	{
1631	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1753	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1632	for $self->{beg} .. $self->{end};	1754	for $self->{beg} .. $self->{end};
1633	}	1755	}
1634		1756
1635	defined wantarray &&	1757	defined wantarray &&
1636	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1758	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1637	0, $self->{len}	1759	0, $self->{len}
1638	}	1760	}
1639		1761
1640	sub urxvt::line::r {	1762	sub urxvt::line::r {
1641	my ($self) = @_;	1763	my ($self) = @_;
1642		1764
1643	if (@_ > 1)	1765	if (@_ > 1) {
1644	{
1645	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1766	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1646	for $self->{beg} .. $self->{end};	1767	for $self->{beg} .. $self->{end};
1647	}	1768	}
1648		1769
1649	if (defined wantarray) {	1770	if (defined wantarray) {
1650	my $rend = [	1771	my $rend = [
1651	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1772	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1652	];	1773	];

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.218 by root, Sun Jun 10 17:31:53 2012 UTC vs. Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.218 by root, Sun Jun 10 17:31:53 2012 UTC vs.
Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 2014 UTC