[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.237 by root, Sun May 18 18:09:52 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
…		…
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;	560	$name =~ y/-/./ if $isarg;
588		561
589	$term->scan_meta;	562	$term->scan_extensions;
590		563
591	my $r = $term->{meta}{resource};	564	my $r = $term->{meta}{resource};
592	keys %$r; # reste iterator	565	keys %$r; # reset iterator
593	while (my ($pattern, $v) = each %$r) {	566	while (my ($pattern, $v) = each %$r) {
594	if (	567	if (
595	$pattern =~ /\.$/	568	$pattern =~ /\.$/
596	? $pattern eq substr $name, 0, length $pattern	569	? $pattern eq substr $name, 0, length $pattern
597	: $pattern eq $name	570	: $pattern eq $name
…		…
614	}	587	}
615		588
616	sub usage {	589	sub usage {
617	my ($term, $usage_type) = @_;	590	my ($term, $usage_type) = @_;
618		591
619	$term->scan_meta;	592	$term->scan_extensions;
620		593
621	my $r = $term->{meta}{resource};	594	my $r = $term->{meta}{resource};
622		595
623	for my $pattern (sort keys %$r) {	596	for my $pattern (sort keys %$r) {
624	my ($ext, $type, $desc) = @{ $r->{$pattern} };	597	my ($ext, $type, $desc) = @{ $r->{$pattern} };
…		…
685	# called by the rxvt core	658	# called by the rxvt core
686	sub invoke {	659	sub invoke {
687	local $TERM = shift;	660	local $TERM = shift;
688	my $htype = shift;	661	my $htype = shift;
689		662
690	if ($htype == 0) { # INIT	663	if ($htype == HOOK_INIT) {
691	my @dirs = $TERM->perl_libdirs;	664	my @dirs = $TERM->perl_libdirs;
		665
		666	$TERM->scan_extensions;
692		667
693	my %ext_arg;	668	my %ext_arg;
694		669
695	{	670	{
696	my @init = @TERM_INIT;	671	my @init = @TERM_INIT;
…		…
704	for (	679	for (
705	@{ delete $TERM->{perl_ext_3} },	680	@{ delete $TERM->{perl_ext_3} },
706	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2	681	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
707	) {	682	) {
708	if ($_ eq "default") {	683	if ($_ eq "default") {
709	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);	684
		685	$ext_arg{$_} = []
		686	for
		687	qw(selection option-popup selection-popup readline),
		688	map $_->[0], values %{ $TERM->{meta}{binding} };
		689
		690	for ($TERM->_keysym_resources) {
		691	next if /^(?:string\|command\|builtin\|builtin-string\|perl)/;
		692	next unless /^([A-Za-z0-9_\-]+):/;
		693
		694	my $ext = $1;
		695	$ext =~ y/-/_/;
		696
		697	$ext_arg{$ext} = [];
		698	}
		699
710	} elsif (/^-(.*)$/) {	700	} elsif (/^-(.*)$/) {
711	delete $ext_arg{$1};	701	delete $ext_arg{$1};
		702
712	} elsif (/^([^<]+)<(.*)>$/) {	703	} elsif (/^([^<]+)<(.*)>$/) {
713	push @{ $ext_arg{$1} }, $2;	704	push @{ $ext_arg{$1} }, $2;
		705
714	} else {	706	} else {
715	$ext_arg{$_} \|\|= [];	707	$ext_arg{$_} \|\|= [];
		708	}
		709	}
		710
		711	# now register default key bindings
		712	for my $ext (sort keys %ext_arg) {
		713	while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
		714	$TERM->bind_action ($k, "$v->[0]:$v->[1]");
716	}	715	}
717	}	716	}
718		717
719	for my $ext (sort keys %ext_arg) {	718	for my $ext (sort keys %ext_arg) {
720	my @files = grep -f $_, map "$_/$ext", @dirs;	719	my @files = grep -f $_, map "$_/$ext", @dirs;
…		…
734		733
735	if (my $cb = $TERM->{_hook}[$htype]) {	734	if (my $cb = $TERM->{_hook}[$htype]) {
736	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	735	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
737	if $verbosity >= 10;	736	if $verbosity >= 10;
738		737
		738	if ($htype == HOOK_ACTION) {
		739	# this hook is only sent to the extension with the name
		740	# matching the first arg
		741	my $pkg = shift;
		742	$pkg =~ y/-/_/;
		743	$pkg = "urxvt::ext::$pkg";
		744
		745	$cb = $cb->{$pkg}
		746	or return undef; #TODO: maybe warn user?
		747
		748	$cb = { $pkg => $cb };
		749	}
		750
739	for my $pkg (keys %$cb) {	751	for my $pkg (keys %$cb) {
740	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };	752	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} \|\| $TERM, @_) };
741	$retval \|\|= $retval_;	753	$retval \|\|= $retval_;
742		754
743	if ($@) {	755	if ($@) {
744	$TERM->ungrab; # better to lose the grab than the session	756	$TERM->ungrab; # better to lose the grab than the session
745	warn $@;	757	warn $@;
…		…
748		760
749	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	761	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
750	if $verbosity >= 11;	762	if $verbosity >= 11;
751	}	763	}
752		764
753	if ($htype == 1) { # DESTROY	765	if ($htype == HOOK_DESTROY) {
754	# clear package objects	766	# clear package objects
755	%$_ = () for values %{ $TERM->{_pkg} };	767	%$_ = () for values %{ $TERM->{_pkg} };
756		768
757	# clear package	769	# clear package
758	%$TERM = ();	770	%$TERM = ();
…		…
790	($mask, @color{qw(fg bg)}, \@failed)	802	($mask, @color{qw(fg bg)}, \@failed)
791	}	803	}
792		804
793	package urxvt::term::extension;	805	package urxvt::term::extension;
794		806
795	sub enable {	807	=head2 The C<urxvt::term::extension> class
796	my ($self, %hook) = @_;
797	my $pkg = $self->{_pkg};
798		808
799	while (my ($name, $cb) = each %hook) {	809	Each extension attached to a terminal object is represented by
800	my $htype = $HOOKTYPE{uc $name};	810	a C<urxvt::term::extension> object.
801	defined $htype
802	or Carp::croak "unsupported hook type '$name'";
803		811
804	$self->set_should_invoke ($htype, +1)	812	You can use these objects, which are passed to all callbacks to store any
805	unless exists $self->{term}{_hook}[$htype]{$pkg};	813	state related to the terminal and extension instance.
806		814
807	$self->{term}{_hook}[$htype]{$pkg} = $cb;	815	The methods (And data members) documented below can be called on extension
808	}	816	objects, in addition to call methods documented for the <urxvt::term>
809	}	817	class.
810		818
811	sub disable {	819	=over 4
812	my ($self, @hook) = @_;
813	my $pkg = $self->{_pkg};
814		820
815	for my $name (@hook) {	821	=item $urxvt_term = $self->{term}
816	my $htype = $HOOKTYPE{uc $name};
817	defined $htype
818	or Carp::croak "unsupported hook type '$name'";
819		822
820	$self->set_should_invoke ($htype, -1)	823	Returns the C<urxvt::term> object associated with this instance of the
821	if delete $self->{term}{_hook}[$htype]{$pkg};	824	extension. This member I<must not> be changed in any way.
822	}	825
823	}	826	=cut
824		827
825	our $AUTOLOAD;	828	our $AUTOLOAD;
826		829
827	sub AUTOLOAD {	830	sub AUTOLOAD {
828	$AUTOLOAD =~ /:([^:]+)$/	831	$AUTOLOAD =~ /:([^:]+)$/
…		…
841		844
842	sub DESTROY {	845	sub DESTROY {
843	# nop	846	# nop
844	}	847	}
845		848
846	# urxvt::destroy_hook	849	# urxvt::destroy_hook (basically a cheap Guard:: implementation)
847		850
848	sub urxvt::destroy_hook::DESTROY {	851	sub urxvt::destroy_hook::DESTROY {
849	${$_[0]}->();	852	${$_[0]}->();
850	}	853	}
851		854
852	sub urxvt::destroy_hook(&) {	855	sub urxvt::destroy_hook(&) {
853	bless \shift, urxvt::destroy_hook::	856	bless \shift, urxvt::destroy_hook::
854	}	857	}
		858
		859	=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
		860
		861	Dynamically enable the given hooks (named without the C<on_> prefix) for
		862	this extension, replacing any hook previously installed via C<enable> in
		863	this extension.
		864
		865	This is useful when you want to overwrite time-critical hooks only
		866	temporarily.
		867
		868	To install additional callbacks for the same hook, you can use the C<on>
		869	method of the C<urxvt::term> class.
		870
		871	=item $self->disable ($hook_name[, $hook_name..])
		872
		873	Dynamically disable the given hooks.
		874
		875	=cut
		876
		877	sub enable {
		878	my ($self, %hook) = @_;
		879	my $pkg = $self->{_pkg};
		880
		881	while (my ($name, $cb) = each %hook) {
		882	my $htype = $HOOKTYPE{uc $name};
		883	defined $htype
		884	or Carp::croak "unsupported hook type '$name'";
		885
		886	$self->set_should_invoke ($htype, +1)
		887	unless exists $self->{term}{_hook}[$htype]{$pkg};
		888
		889	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		890	}
		891	}
		892
		893	sub disable {
		894	my ($self, @hook) = @_;
		895	my $pkg = $self->{_pkg};
		896
		897	for my $name (@hook) {
		898	my $htype = $HOOKTYPE{uc $name};
		899	defined $htype
		900	or Carp::croak "unsupported hook type '$name'";
		901
		902	$self->set_should_invoke ($htype, -1)
		903	if delete $self->{term}{_hook}[$htype]{$pkg};
		904	}
		905	}
		906
		907	=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
		908
		909	Similar to the C<enable> enable, but installs additional callbacks for
		910	the given hook(s) (that is, it doesn't replace existing callbacks), and
		911	returns a guard object. When the guard object is destroyed the callbacks
		912	are disabled again.
		913
		914	=cut
		915
		916	sub urxvt::extension::on_disable::DESTROY {
		917	my $disable = shift;
		918
		919	my $term = delete $disable->{""};
		920
		921	while (my ($htype, $id) = each %$disable) {
		922	delete $term->{_hook}[$htype]{$id};
		923	$term->set_should_invoke ($htype, -1);
		924	}
		925	}
		926
		927	sub on {
		928	my ($self, %hook) = @_;
		929
		930	my $term = $self->{term};
		931
		932	my %disable = ( "" => $term );
		933
		934	while (my ($name, $cb) = each %hook) {
		935	my $htype = $HOOKTYPE{uc $name};
		936	defined $htype
		937	or Carp::croak "unsupported hook type '$name'";
		938
		939	$term->set_should_invoke ($htype, +1);
		940	$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
		941	= sub { shift; $cb->($self, @_) }; # very ugly indeed
		942	}
		943
		944	bless \%disable, "urxvt::extension::on_disable"
		945	}
		946
		947	=item $self->x_resource ($pattern)
		948
		949	=item $self->x_resource_boolean ($pattern)
		950
		951	These methods support an additional C<%> prefix when called on an
		952	extension object - see the description of these methods in the
		953	C<urxvt::term> class for details.
		954
		955	=cut
855		956
856	sub x_resource {	957	sub x_resource {
857	my ($self, $name) = @_;	958	my ($self, $name) = @_;
858	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	959	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
859	$self->{term}->x_resource ($name)	960	$self->{term}->x_resource ($name)
…		…
862	sub x_resource_boolean {	963	sub x_resource_boolean {
863	my ($self, $name) = @_;	964	my ($self, $name) = @_;
864	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;	965	$name =~ s/^%(\.\|$)/$_[0]{_name}$1/;
865	$self->{term}->x_resource_boolean ($name)	966	$self->{term}->x_resource_boolean ($name)
866	}	967	}
		968
		969	=back
		970
		971	=cut
867		972
868	package urxvt::anyevent;	973	package urxvt::anyevent;
869		974
870	=head2 The C<urxvt::anyevent> Class	975	=head2 The C<urxvt::anyevent> Class
871		976
…		…
990	$ENV{URXVT_PERL_LIB},	1095	$ENV{URXVT_PERL_LIB},
991	"$ENV{HOME}/.urxvt/ext",	1096	"$ENV{HOME}/.urxvt/ext",
992	"$LIBDIR/perl"	1097	"$LIBDIR/perl"
993	}	1098	}
994		1099
995	sub scan_meta {	1100	# scan for available extensions and collect their metadata
		1101	sub scan_extensions {
996	my ($self) = @_;	1102	my ($self) = @_;
		1103
		1104	return if exists $self->{meta};
		1105
997	my @libdirs = perl_libdirs $self;	1106	my @libdirs = perl_libdirs $self;
998		1107
999	return if $self->{meta_libdirs} eq join "\x00", @libdirs;	1108	# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1000		1109
1001	my %meta;
1002
1003	$self->{meta_libdirs} = join "\x00", @libdirs;	1110	# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1004	$self->{meta} = \%meta;	1111	$self->{meta} = \my %meta;
1005		1112
		1113	# first gather extensions
1006	for my $dir (reverse @libdirs) {	1114	for my $dir (reverse @libdirs) {
1007	opendir my $fh, $dir	1115	opendir my $fh, $dir
1008	or next;	1116	or next;
1009	for my $ext (readdir $fh) {	1117	for my $ext (readdir $fh) {
1010	$ext ne "."	1118	$ext !~ /^\./
1011	and $ext ne ".."
1012	and open my $fh, "<", "$dir/$ext"	1119	and open my $fh, "<", "$dir/$ext"
1013	or next;	1120	or next;
1014		1121
		1122	my %ext = (dir => $dir);
		1123
1015	while (<$fh>) {	1124	while (<$fh>) {
1016	if (/^#:META:X_RESOURCE:(.*)/) {	1125	if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1017	my ($pattern, $type, $desc) = split /:/, $1;	1126	my ($pattern, $type, $desc) = split /:/, $1;
1018	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name	1127	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
1019	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {	1128	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1020	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";	1129	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1021	} else {	1130	} else {
1022	$meta{resource}{$pattern} = [$ext, $type, $desc];	1131	$ext{resource}{$pattern} = [$ext, $type, $desc];
1023	}	1132	}
		1133	} elsif (/^#:META:BINDING:(.*)/) {
		1134	my ($keysym, $action) = split /:/, $1;
		1135	$ext{binding}{$keysym} = [$ext, $action];
1024	} elsif (/^\s*(?:#\|$)/) {	1136	} elsif (/^\s*(?:#\|$)/) {
1025	# skip other comments and empty lines	1137	# skip other comments and empty lines
1026	} else {	1138	} else {
1027	last; # stop parsing on first non-empty non-comment line	1139	last; # stop parsing on first non-empty non-comment line
1028	}	1140	}
1029	}	1141	}
		1142
		1143	$meta{ext}{$ext} = \%ext;
1030	}	1144	}
		1145	}
		1146
		1147	# and now merge resources and bindings
		1148	while (my ($k, $v) = each %{ $meta{ext} }) {
		1149	#TODO: should check for extensions overriding each other
		1150	%{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
		1151	%{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1031	}	1152	}
1032	}	1153	}
1033		1154
1034	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1155	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1035		1156
…		…
1055	}	1176	}
1056		1177
1057	=item $term->destroy	1178	=item $term->destroy
1058		1179
1059	Destroy the terminal object (close the window, free resources	1180	Destroy the terminal object (close the window, free resources
1060	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1181	etc.). Please note that urxvt will not exit as long as any event
1061	watchers (timers, io watchers) are still active.	1182	watchers (timers, io watchers) are still active.
1062		1183
1063	=item $term->exec_async ($cmd[, @args])	1184	=item $term->exec_async ($cmd[, @args])
1064		1185
1065	Works like the combination of the C<fork>/C<exec> builtins, which executes	1186	Works like the combination of the C<fork>/C<exec> builtins, which executes
…		…
1121		1242
1122	Here is a likely non-exhaustive list of resource names, not all of which	1243	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>	1244	are supported in every build, please see the source file F</src/rsinc.h>
1124	to see the actual list:	1245	to see the actual list:
1125		1246
1126	answerbackstring backgroundPixmap backspace_key blendtype blurradius	1247	answerbackstring backgroundPixmap backspace_key blurradius
1127	boldFont boldItalicFont borderLess buffered chdir color cursorBlink	1248	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1128	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth	1249	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1129	fade font geometry hold iconName iconfile imFont imLocale inputMethod	1250	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1130	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont	1251	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1131	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier	1252	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
…		…
1156	Extensions that define extra resource or command line arguments also need	1277	Extensions that define extra resource or command line arguments also need
1157	to call this method to access their values.	1278	to call this method to access their values.
1158		1279
1159	If the method is called on an extension object (basically, from an	1280	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	1281	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	1282	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	1283	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	1284	can rename them and get a new set of commandline switches and resources
1164	without having to change the actual code.	1285	without having to change the actual code.
1165		1286
1166	This method should only be called during the C<on_start> hook, as there is	1287	This method should only be called during the C<on_start> hook, as there is
…		…
1181	my $res = &x_resource;	1302	my $res = &x_resource;
1182		1303
1183	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0	1304	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
1184	}	1305	}
1185		1306
1186	=item $success = $term->parse_keysym ($key, $octets)	1307	=item $success = $term->bind_action ($key, $octets)
1187		1308
1188	Adds a key binding exactly as specified via a resource. See the	1309	Adds a key binding exactly as specified via a C<keysym> resource. See the
1189	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1310	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		1311
1198	=item $rend = $term->rstyle ([$new_rstyle])	1312	=item $rend = $term->rstyle ([$new_rstyle])
1199		1313
1200	Return and optionally change the current rendition. Text that is output by	1314	Return and optionally change the current rendition. Text that is output by
1201	the terminal application will use this style.	1315	the terminal application will use this style.
…		…
1381	=item $term->tt_write ($octets)	1495	=item $term->tt_write ($octets)
1382		1496
1383	Write the octets given in C<$octets> to the tty (i.e. as program input). To	1497	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	1498	pass characters instead of octets, you should convert your strings first
1385	to the locale-specific encoding using C<< $term->locale_encode >>.	1499	to the locale-specific encoding using C<< $term->locale_encode >>.
		1500
		1501	=item $term->tt_write_user_input ($octets)
		1502
		1503	Like C<tt_write>, but should be used when writing strings in response to
		1504	the user pressing a key, to invokes the additional actions requested by
		1505	the user for that case (C<tt_write> doesn't do that).
		1506
		1507	The typical use case would be inside C<on_action> hooks.
1386		1508
1387	=item $term->tt_paste ($octets)	1509	=item $term->tt_paste ($octets)
1388		1510
1389	Write the octets given in C<$octets> to the tty as a paste, converting NL to	1511	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	1512	CR and bracketing the data with control sequences if bracketed paste mode
…		…
1624	}	1746	}
1625		1747
1626	sub urxvt::line::t {	1748	sub urxvt::line::t {
1627	my ($self) = @_;	1749	my ($self) = @_;
1628		1750
1629	if (@_ > 1)	1751	if (@_ > 1) {
1630	{
1631	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1752	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1632	for $self->{beg} .. $self->{end};	1753	for $self->{beg} .. $self->{end};
1633	}	1754	}
1634		1755
1635	defined wantarray &&	1756	defined wantarray &&
1636	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1757	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1637	0, $self->{len}	1758	0, $self->{len}
1638	}	1759	}
1639		1760
1640	sub urxvt::line::r {	1761	sub urxvt::line::r {
1641	my ($self) = @_;	1762	my ($self) = @_;
1642		1763
1643	if (@_ > 1)	1764	if (@_ > 1) {
1644	{
1645	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})	1765	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1646	for $self->{beg} .. $self->{end};	1766	for $self->{beg} .. $self->{end};
1647	}	1767	}
1648		1768
1649	if (defined wantarray) {	1769	if (defined wantarray) {
1650	my $rend = [	1770	my $rend = [
1651	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1771	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1652	];	1772	];

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.237 by root, Sun May 18 18:09:52 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.237 by root, Sun May 18 18:09:52 2014 UTC