[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.248 by root, Fri Dec 26 21:01:46 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 may add additional resources and C<actions>, i.e., methods
49	laoded automatically when used.	49	which can be bound to a key and invoked by the user. An extension can
		50	define the resources it support and also default bindings for one or
		51	more actions it provides using so called META comments, described
		52	below. Similarly to builtin resources, extension resources can also be
		53	specified on the command line as long options (with C<.> replaced by
		54	C<->), in which case the corresponding extension is loaded
		55	automatically. For this to work the extension B<must> define META
		56	comments for its resources.
50		57
51	=head1 API DOCUMENTATION	58	=head1 API DOCUMENTATION
52		59
53	=head2 General API Considerations	60	=head2 General API Considerations
54		61
103	internal use.	110	internal use.
104		111
105	Although it isn't a C<urxvt::term> object, you can call all methods of the	112	Although it isn't a C<urxvt::term> object, you can call all methods of the
106	C<urxvt::term> class on this object.	113	C<urxvt::term> class on this object.
107		114
108	It has the following methods and data members:	115	Additional methods only supported for extension objects are described in
		116	the C<urxvt::extension> section below.
		117
		118	=head2 META comments
		119
		120	Rxvt-unicode recognizes special meta comments in extensions that define
		121	different types of metadata.
		122
		123	Currently, it recxognises only one such comment:
109		124
110	=over 4	125	=over 4
111		126
112	=item $urxvt_term = $self->{term}	127	=item #:META:RESOURCE:name:type:desc
113		128
114	Returns the C<urxvt::term> object associated with this instance of the	129	The RESOURCE comment defines a resource used by the extension, where
115	extension. This member I<must not> be changed in any way.	130	C<name> is the resource name, C<type> is the resource type, C<boolean>
116		131	or C<string>, and C<desc> is the resource description.
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		132
127	=back	133	=back
128		134
129	=head2 Hooks	135	=head2 Hooks
130		136
…		…
299		305
300	=item on_refresh_end $term	306	=item on_refresh_end $term
301		307
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	308	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		309
		310	=item on_action $term, $string
		311
		312	Called whenever an action is invoked for the corresponding extension
		313	(e.g. via a C<extension:string> builtin action bound to a key, see
		314	description of the B<keysym> resource in the urxvt(1) manpage). The
		315	event is simply the action string. Note that an action event is always
		316	associated to a single extension.
		317
304	=item on_user_command $term, $string	318	=item on_user_command $term, $string DEPRECATED
305		319
306	Called whenever a user-configured event is being activated (e.g. via	320	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>	321	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	322	resource in the urxvt(1) manpage).
309		323
310	The event is simply the action string. This interface is assumed to change	324	The event is simply the action string. This interface is going away in
311	slightly in the future.	325	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		326
320	=item on_resize_all_windows $term, $new_width, $new_height	327	=item on_resize_all_windows $term, $new_width, $new_height
321		328
322	Called just after the new window size has been calculated, but before	329	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	330	windows are actually being resized or hints are being set. If this hook
324	returns TRUE, setting of the window hints is being skipped.	331	returns a true value, setting of the window hints is being skipped.
325		332
326	=item on_x_event $term, $event	333	=item on_x_event $term, $event
327		334
328	Called on every X event received on the vt window (and possibly other	335	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	336	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	375	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.	376	(real, not screen-based) row and column under the mouse cursor.
370		377
371	C<on_key_press> additionally receives the string rxvt-unicode would	378	C<on_key_press> additionally receives the string rxvt-unicode would
372	output, if any, in locale-specific encoding.	379	output, if any, in locale-specific encoding.
373
374	subwindow.
375		380
376	=item on_client_message $term, $event	381	=item on_client_message $term, $event
377		382
378	=item on_wm_protocols $term, $event	383	=item on_wm_protocols $term, $event
379		384
…		…
582	no warnings 'utf8';	587	no warnings 'utf8';
583		588
584	sub parse_resource {	589	sub parse_resource {
585	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;	590	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
586		591
587	$name =~ y/-/./ if $isarg;
588
589	$term->scan_meta;	592	$term->scan_extensions;
590		593
591	my $r = $term->{meta}{resource};	594	my $r = $term->{meta}{resource};
592	keys %$r; # reste iterator	595	keys %$r; # reset iterator
593	while (my ($pattern, $v) = each %$r) {	596	while (my ($k, $v) = each %$r) {
594	if (	597	my $pattern = $k;
		598	$pattern =~ y/./-/ if $isarg;
		599	my $prefix = $name;
		600	my $suffix;
595	$pattern =~ /\.$/	601	if ($pattern =~ /\-$/) {
596	? $pattern eq substr $name, 0, length $pattern	602	$prefix = substr $name, 0, length $pattern;
597	: $pattern eq $name	603	$suffix = substr $name, length $pattern;
598	) {	604	}
		605	if ($pattern eq $prefix) {
599	$name = "$urxvt::RESCLASS.$name";	606	$name = "$urxvt::RESCLASS.$k$suffix";
600		607
601	push @{ $term->{perl_ext_3} }, $v->[0];	608	push @{ $term->{perl_ext_3} }, $v->[0];
602		609
603	if ($v->[1] eq "boolean") {	610	if ($v->[1] eq "boolean") {
604	$term->put_option_db ($name, $flag ? "true" : "false");	611	$term->put_option_db ($name, $flag ? "true" : "false");
…		…
614	}	621	}
615		622
616	sub usage {	623	sub usage {
617	my ($term, $usage_type) = @_;	624	my ($term, $usage_type) = @_;
618		625
619	$term->scan_meta;	626	$term->scan_extensions;
620		627
621	my $r = $term->{meta}{resource};	628	my $r = $term->{meta}{resource};
622		629
623	for my $pattern (sort keys %$r) {	630	for my $pattern (sort keys %$r) {
624	my ($ext, $type, $desc) = @{ $r->{$pattern} };	631	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
685	# called by the rxvt core	692	# called by the rxvt core
686	sub invoke {	693	sub invoke {
687	local $TERM = shift;	694	local $TERM = shift;
688	my $htype = shift;	695	my $htype = shift;
689		696
690	if ($htype == 0) { # INIT	697	if ($htype == HOOK_INIT) {
691	my @dirs = $TERM->perl_libdirs;	698	my @dirs = $TERM->perl_libdirs;
		699
		700	$TERM->scan_extensions;
692		701
693	my %ext_arg;	702	my %ext_arg;
694		703
695	{	704	{
696	my @init = @TERM_INIT;	705	my @init = @TERM_INIT;
…		…
700	@TERM_EXT = ();	709	@TERM_EXT = ();
701	$TERM->register_package ($_) for @pkg;	710	$TERM->register_package ($_) for @pkg;
702	}	711	}
703		712
704	for (	713	for (
		714	(grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
705	@{ delete $TERM->{perl_ext_3} },	715	@{ delete $TERM->{perl_ext_3} }
706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
707	) {	716	) {
708	if ($_ eq "default") {	717	if ($_ eq "default") {
		718
		719	$ext_arg{$_} = []
709	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	720	for qw(selection option-popup selection-popup readline searchable-scrollback);
		721
		722	for ($TERM->_keysym_resources) {
		723	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		724	next unless /^([A-Za-z0-9_\-]+):/;
		725
		726	my $ext = $1;
		727
		728	$ext_arg{$ext} = [];
		729	}
		730
710	} elsif (/^-(.*)$/) {	731	} elsif (/^-(.*)$/) {
711	delete $ext_arg{$1};	732	delete $ext_arg{$1};
		733
712	} elsif (/^([^<]+)<(.*)>$/) {	734	} elsif (/^([^<]+)<(.*)>$/) {
713	push @{ $ext_arg{$1} }, $2;	735	push @{ $ext_arg{$1} }, $2;
		736
714	} else {	737	} else {
715	$ext_arg{$_} \|\|= [];	738	$ext_arg{$_} \|\|= [];
716	}	739	}
717	}	740	}
718		741
…		…
734		757
735	if (my $cb = $TERM->{_hook}[$htype]) {	758	if (my $cb = $TERM->{_hook}[$htype]) {
736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	759	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
737	if $verbosity >= 10;	760	if $verbosity >= 10;
738		761
		762	if ($htype == HOOK_ACTION) {
		763	# this hook is only sent to the extension with the name
		764	# matching the first arg
		765	my $pkg = shift;
		766	$pkg =~ y/-/_/;
		767	$pkg = "urxvt::ext::$pkg";
		768
		769	$cb = $cb->{$pkg}
		770	or return undef; #TODO: maybe warn user?
		771
		772	$cb = { $pkg => $cb };
		773	}
		774
739	for my $pkg (keys %$cb) {	775	for my $pkg (keys %$cb) {
740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	776	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
741	$retval \|\|= $retval_;	777	$retval \|\|= $retval_;
742		778
743	if ($@) {	779	if ($@) {
744	$TERM->ungrab; # better to lose the grab than the session	780	$TERM->ungrab; # better to lose the grab than the session
745	warn $@;	781	warn $@;
…		…
748		784
749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	785	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
750	if $verbosity >= 11;	786	if $verbosity >= 11;
751	}	787	}
752		788
753	if ($htype == 1) { # DESTROY	789	if ($htype == HOOK_DESTROY) {
754	# clear package objects	790	# clear package objects
755	%$_ = () for values %{ $TERM->{_pkg} };	791	%$_ = () for values %{ $TERM->{_pkg} };
756		792
757	# clear package	793	# clear package
758	%$TERM = ();	794	%$TERM = ();
…		…
790	($mask, @color{qw(fg bg)}, \@failed)	826	($mask, @color{qw(fg bg)}, \@failed)
791	}	827	}
792		828
793	package urxvt::term::extension;	829	package urxvt::term::extension;
794		830
795	sub enable {	831	=head2 The C<urxvt::term::extension> class
796	my ($self, %hook) = @_;
797	my $pkg = $self->{_pkg};
798		832
799	while (my ($name, $cb) = each %hook) {	833	Each extension attached to a terminal object is represented by
800	my $htype = $HOOKTYPE{uc $name};	834	a C<urxvt::term::extension> object.
801	defined $htype
802	or Carp::croak "unsupported hook type '$name'";
803		835
804	$self->set_should_invoke ($htype, +1)	836	You can use these objects, which are passed to all callbacks to store any
805	unless exists $self->{term}{_hook}[$htype]{$pkg};	837	state related to the terminal and extension instance.
806		838
807	$self->{term}{_hook}[$htype]{$pkg} = $cb;	839	The methods (And data members) documented below can be called on extension
808	}	840	objects, in addition to call methods documented for the <urxvt::term>
809	}	841	class.
810		842
811	sub disable {	843	=over 4
812	my ($self, @hook) = @_;
813	my $pkg = $self->{_pkg};
814		844
815	for my $name (@hook) {	845	=item $urxvt_term = $self->{term}
816	my $htype = $HOOKTYPE{uc $name};
817	defined $htype
818	or Carp::croak "unsupported hook type '$name'";
819		846
820	$self->set_should_invoke ($htype, -1)	847	Returns the C<urxvt::term> object associated with this instance of the
821	if delete $self->{term}{_hook}[$htype]{$pkg};	848	extension. This member I<must not> be changed in any way.
822	}	849
823	}	850	=cut
824		851
825	our $AUTOLOAD;	852	our $AUTOLOAD;
826		853
827	sub AUTOLOAD {	854	sub AUTOLOAD {
828	$AUTOLOAD =~ /:([^:]+)$/	855	$AUTOLOAD =~ /:([^:]+)$/
…		…
841		868
842	sub DESTROY {	869	sub DESTROY {
843	# nop	870	# nop
844	}	871	}
845		872
846	# urxvt::destroy_hook	873	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
847		874
848	sub urxvt::destroy_hook::DESTROY {	875	sub urxvt::destroy_hook::DESTROY {
849	${$_[0]}->();	876	${$_[0]}->();
850	}	877	}
851		878
852	sub urxvt::destroy_hook(&) {	879	sub urxvt::destroy_hook(&) {
853	bless \shift, urxvt::destroy_hook::	880	bless \shift, urxvt::destroy_hook::
		881	}
		882
		883	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		884
		885	Dynamically enable the given hooks (named without the C<on_> prefix) for
		886	this extension, replacing any hook previously installed via C<enable> in
		887	this extension.
		888
		889	This is useful when you want to overwrite time-critical hooks only
		890	temporarily.
		891
		892	To install additional callbacks for the same hook, you can use the C<on>
		893	method of the C<urxvt::term> class.
		894
		895	=item $self->disable ($hook_name[, $hook_name..])
		896
		897	Dynamically disable the given hooks.
		898
		899	=cut
		900
		901	sub enable {
		902	my ($self, %hook) = @_;
		903	my $pkg = $self->{_pkg};
		904
		905	while (my ($name, $cb) = each %hook) {
		906	my $htype = $HOOKTYPE{uc $name};
		907	defined $htype
		908	or Carp::croak "unsupported hook type '$name'";
		909
		910	$self->set_should_invoke ($htype, +1)
		911	unless exists $self->{term}{_hook}[$htype]{$pkg};
		912
		913	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		914	}
		915	}
		916
		917	sub disable {
		918	my ($self, @hook) = @_;
		919	my $pkg = $self->{_pkg};
		920
		921	for my $name (@hook) {
		922	my $htype = $HOOKTYPE{uc $name};
		923	defined $htype
		924	or Carp::croak "unsupported hook type '$name'";
		925
		926	$self->set_should_invoke ($htype, -1)
		927	if delete $self->{term}{_hook}[$htype]{$pkg};
		928	}
		929	}
		930
		931	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		932
		933	Similar to the C<enable> enable, but installs additional callbacks for
		934	the given hook(s) (that is, it doesn't replace existing callbacks), and
		935	returns a guard object. When the guard object is destroyed the callbacks
		936	are disabled again.
		937
		938	=cut
		939
		940	sub urxvt::extension::on_disable::DESTROY {
		941	my $disable = shift;
		942
		943	my $term = delete $disable->{""};
		944
		945	while (my ($htype, $id) = each %$disable) {
		946	delete $term->{_hook}[$htype]{$id};
		947	$term->set_should_invoke ($htype, -1);
		948	}
		949	}
		950
		951	sub on {
		952	my ($self, %hook) = @_;
		953
		954	my $term = $self->{term};
		955
		956	my %disable = ( "" => $term );
		957
		958	while (my ($name, $cb) = each %hook) {
		959	my $htype = $HOOKTYPE{uc $name};
		960	defined $htype
		961	or Carp::croak "unsupported hook type '$name'";
		962
		963	$term->set_should_invoke ($htype, +1);
		964	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		965	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		966	}
		967
		968	bless \%disable, "urxvt::extension::on_disable"
		969	}
		970
		971	=item $self->bind_action ($hotkey, $action)
		972
		973	=item $self->x_resource ($pattern)
		974
		975	=item $self->x_resource_boolean ($pattern)
		976
		977	These methods support an additional C<%> prefix for C<$action> or
		978	C<$pattern> when called on an extension object, compared to the
		979	C<urxvt::term> methods of the same name - see the description of these
		980	methods in the C<urxvt::term> class for details.
		981
		982	=cut
		983
		984	sub bind_action {
		985	my ($self, $hotkey, $action) = @_;
		986	$action =~ s/^%:/$_[0]{_name}:/;
		987	$self->{term}->bind_action ($hotkey, $action)
854	}	988	}
855		989
856	sub x_resource {	990	sub x_resource {
857	my ($self, $name) = @_;	991	my ($self, $name) = @_;
858	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	992	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
…		…
862	sub x_resource_boolean {	996	sub x_resource_boolean {
863	my ($self, $name) = @_;	997	my ($self, $name) = @_;
864	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	998	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
865	$self->{term}->x_resource_boolean ($name)	999	$self->{term}->x_resource_boolean ($name)
866	}	1000	}
		1001
		1002	=back
		1003
		1004	=cut
867		1005
868	package urxvt::anyevent;	1006	package urxvt::anyevent;
869		1007
870	=head2 The C<urxvt::anyevent> Class	1008	=head2 The C<urxvt::anyevent> Class
871		1009
…		…
990	$ENV{URXVT_PERL_LIB},	1128	$ENV{URXVT_PERL_LIB},
991	"$ENV{HOME}/.urxvt/ext",	1129	"$ENV{HOME}/.urxvt/ext",
992	"$LIBDIR/perl"	1130	"$LIBDIR/perl"
993	}	1131	}
994		1132
995	sub scan_meta {	1133	# scan for available extensions and collect their metadata
		1134	sub scan_extensions {
996	my ($self) = @_;	1135	my ($self) = @_;
		1136
		1137	return if exists $self->{meta};
		1138
997	my @libdirs = perl_libdirs $self;	1139	my @libdirs = perl_libdirs $self;
998		1140
999	return if $self->{meta_libdirs} eq join "\x00", @libdirs;	1141	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1000		1142
1001	my %meta;
1002
1003	$self->{meta_libdirs} = join "\x00", @libdirs;	1143	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1004	$self->{meta} = \%meta;	1144	$self->{meta} = \my %meta;
1005		1145
		1146	# first gather extensions
1006	for my $dir (reverse @libdirs) {	1147	for my $dir (reverse @libdirs) {
1007	opendir my $fh, $dir	1148	opendir my $fh, $dir
1008	or next;	1149	or next;
1009	for my $ext (readdir $fh) {	1150	for my $ext (readdir $fh) {
1010	$ext ne "."	1151	$ext !~ /^\./
1011	and $ext ne ".."
1012	and open my $fh, "<", "$dir/$ext"	1152	and open my $fh, "<", "$dir/$ext"
1013	or next;	1153	or next;
1014		1154
		1155	my %ext = (dir => $dir);
		1156
1015	while (<$fh>) {	1157	while (<$fh>) {
1016	if (/^#:META:X_RESOURCE:(.*)/) {	1158	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1017	my ($pattern, $type, $desc) = split /:/, $1;	1159	my ($pattern, $type, $desc) = split /:/, $1;
1018	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1160	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1161	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1020	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1162	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1021	} else {	1163	} else {
1022	$meta{resource}{$pattern} = [$ext, $type, $desc];	1164	$ext{resource}{$pattern} = [$ext, $type, $desc];
1023	}	1165	}
1024	} elsif (/^\s*(?:#\|$)/) {	1166	} elsif (/^\s*(?:#\|$)/) {
1025	# skip other comments and empty lines	1167	# skip other comments and empty lines
1026	} else {	1168	} else {
1027	last; # stop parsing on first non-empty non-comment line	1169	last; # stop parsing on first non-empty non-comment line
1028	}	1170	}
1029	}	1171	}
		1172
		1173	$meta{ext}{$ext} = \%ext;
1030	}	1174	}
		1175	}
		1176
		1177	# and now merge resources
		1178	while (my ($k, $v) = each %{ $meta{ext} }) {
		1179	#TODO: should check for extensions overriding each other
		1180	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
1031	}	1181	}
1032	}	1182	}
1033		1183
1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1184	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1035		1185
…		…
1055	}	1205	}
1056		1206
1057	=item $term->destroy	1207	=item $term->destroy
1058		1208
1059	Destroy the terminal object (close the window, free resources	1209	Destroy the terminal object (close the window, free resources
1060	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1210	etc.). Please note that urxvt will not exit as long as any event
1061	watchers (timers, io watchers) are still active.	1211	watchers (timers, io watchers) are still active.
1062		1212
1063	=item $term->exec_async ($cmd[, @args])	1213	=item $term->exec_async ($cmd[, @args])
1064		1214
1065	Works like the combination of the C<fork>/C<exec> builtins, which executes	1215	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1121		1271
1122	Here is a likely non-exhaustive list of resource names, not all of which	1272	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>	1273	are supported in every build, please see the source file F</src/rsinc.h>
1124	to see the actual list:	1274	to see the actual list:
1125		1275
1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1276	answerbackstring backgroundPixmap backspace_key blurradius
1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1277	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1278	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1129	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1279	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1130	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1280	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1281	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1151	Returns the X-Resource for the given pattern, excluding the program or	1301	Returns the X-Resource for the given pattern, excluding the program or
1152	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the	1302	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1153	same value as used by this instance of rxvt-unicode. Returns C<undef> if no	1303	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1154	resource with that pattern exists.	1304	resource with that pattern exists.
1155		1305
1156	Extensions that define extra resource or command line arguments also need	1306	Extensions that define extra resources also need to call this method
1157	to call this method to access their values.	1307	to access their values.
1158		1308
1159	If the method is called on an extension object (basically, from an	1309	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	1310	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	1311	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	1312	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	1313	can rename them and get a new set of resources without having to change
1164	without having to change the actual code.	1314	the actual code.
1165		1315
1166	This method should only be called during the C<on_start> hook, as there is	1316	This method should only be called during the C<on_start> hook, as there is
1167	only one resource database per display, and later invocations might return	1317	only one resource database per display, and later invocations might return
1168	the wrong resources.	1318	the wrong resources.
1169		1319
…		…
1181	my $res = &x_resource;	1331	my $res = &x_resource;
1182		1332
1183	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1333	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1184	}	1334	}
1185		1335
1186	=item $success = $term->parse_keysym ($key, $octets)	1336	=item $success = $term->bind_action ($key, $action)
1187		1337
1188	Adds a key binding exactly as specified via a resource. See the	1338	Adds a key binding exactly as specified via a C<keysym> resource. See the
1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1339	C<keysym> resource in the urxvt(1) manpage.
1190		1340
1191	=item $term->register_command ($keysym, $modifiermask, $string)	1341	To add default bindings for an extension, the extension should call C<<
		1342	->bind_action >> on it's C<init> hook for every such binding. Doing it
		1343	in the C<init> hook allows users the override or remove the the binding
		1344	again.
1192		1345
1193	Adds a key binding. This is a lower level api compared to	1346	Example: the C<searchable-scrollback> by default binds itself
1194	C<parse_keysym>, as it expects a parsed key description, and can be	1347	on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1195	used only inside either the C<on_init> hook, to add a binding, or the	1348	$term->bind_action >>.
1196	C<on_register_command> hook, to modify a parsed binding.	1349
		1350	sub init {
		1351	my ($self) = @_;
		1352
		1353	$self->bind_action ("M-s" => "%:start");
		1354	}
1197		1355
1198	=item $rend = $term->rstyle ([$new_rstyle])	1356	=item $rend = $term->rstyle ([$new_rstyle])
1199		1357
1200	Return and optionally change the current rendition. Text that is output by	1358	Return and optionally change the current rendition. Text that is output by
1201	the terminal application will use this style.	1359	the terminal application will use this style.
…		…
1359		1517
1360	=item $term->scr_add_lines ($string)	1518	=item $term->scr_add_lines ($string)
1361		1519
1362	Write the given text string to the screen, as if output by the application	1520	Write the given text string to the screen, as if output by the application
1363	running inside the terminal. It may not contain command sequences (escape	1521	running inside the terminal. It may not contain command sequences (escape
1364	codes), but is free to use line feeds, carriage returns and tabs. The	1522	codes - see C<cmd_parse> for that), but is free to use line feeds,
1365	string is a normal text string, not in locale-dependent encoding.	1523	carriage returns and tabs. The string is a normal text string, not in
		1524	locale-dependent encoding.
1366		1525
1367	Normally its not a good idea to use this function, as programs might be	1526	Normally its not a good idea to use this function, as programs might be
1368	confused by changes in cursor position or scrolling. Its useful inside a	1527	confused by changes in cursor position or scrolling. Its useful inside a
1369	C<on_add_lines> hook, though.	1528	C<on_add_lines> hook, though.
1370		1529
…		…
1378	locale-specific encoding of the terminal and can contain command sequences	1537	locale-specific encoding of the terminal and can contain command sequences
1379	(escape codes) that will be interpreted.	1538	(escape codes) that will be interpreted.
1380		1539
1381	=item $term->tt_write ($octets)	1540	=item $term->tt_write ($octets)
1382		1541
1383	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1542	Write the octets given in C<$octets> to the tty (i.e. as user input
		1543	to the program, see C<cmd_parse> for the opposite direction). To pass
1384	pass characters instead of octets, you should convert your strings first	1544	characters instead of octets, you should convert your strings first to the
1385	to the locale-specific encoding using C<< $term->locale_encode >>.	1545	locale-specific encoding using C<< $term->locale_encode >>.
		1546
		1547	=item $term->tt_write_user_input ($octets)
		1548
		1549	Like C<tt_write>, but should be used when writing strings in response to
		1550	the user pressing a key, to invoke the additional actions requested by
		1551	the user for that case (C<tt_write> doesn't do that).
		1552
		1553	The typical use case would be inside C<on_action> hooks.
1386		1554
1387	=item $term->tt_paste ($octets)	1555	=item $term->tt_paste ($octets)
1388		1556
1389	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1557	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	1558	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1624	}	1792	}
1625		1793
1626	sub urxvt::line::t {	1794	sub urxvt::line::t {
1627	my ($self) = @_;	1795	my ($self) = @_;
1628		1796
1629	if (@_ > 1)	1797	if (@_ > 1) {
1630	{
1631	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1798	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1632	for $self->{beg} .. $self->{end};	1799	for $self->{beg} .. $self->{end};
1633	}	1800	}
1634		1801
1635	defined wantarray &&	1802	defined wantarray &&
1636	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1803	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1637	0, $self->{len}	1804	0, $self->{len}
1638	}	1805	}
1639		1806
1640	sub urxvt::line::r {	1807	sub urxvt::line::r {
1641	my ($self) = @_;	1808	my ($self) = @_;
1642		1809
1643	if (@_ > 1)	1810	if (@_ > 1) {
1644	{
1645	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1811	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1646	for $self->{beg} .. $self->{end};	1812	for $self->{beg} .. $self->{end};
1647	}	1813	}
1648		1814
1649	if (defined wantarray) {	1815	if (defined wantarray) {
1650	my $rend = [	1816	my $rend = [
1651	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1817	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1652	];	1818	];

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.248 by root, Fri Dec 26 21:01:46 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.248 by root, Fri Dec 26 21:01:46 2014 UTC