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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC vs.
Revision 1.211 by root, Wed Jun 6 14:34:03 2012 UTC

…		…
259	The default pattern to match URLs can be overridden with the	259	The default pattern to match URLs can be overridden with the
260	C<matcher.pattern.0> resource, and additional patterns can be specified	260	C<matcher.pattern.0> resource, and additional patterns can be specified
261	with numbered patterns, in a manner similar to the "selection" extension.	261	with numbered patterns, in a manner similar to the "selection" extension.
262	The launcher can also be overridden on a per-pattern basis.	262	The launcher can also be overridden on a per-pattern basis.
263		263
264	It is possible to activate the most recently seen match from the keyboard.	264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
265	Simply bind a keysym to "perl:matcher" as seen in the example below.	266	"perl:matcher:list" as seen in the example below.
266		267
267	Example configuration:	268	Example configuration:
268		269
269	URxvt.perl-ext: default,matcher	270	URxvt.perl-ext: default,matcher
270	URxvt.urlLauncher: sensible-browser	271	URxvt.urlLauncher: sensible-browser
271	URxvt.keysym.C-Delete: perl:matcher	272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
272	URxvt.matcher.button: 1	274	URxvt.matcher.button: 1
273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]	275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)	276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
275	URxvt.matcher.launcher.2: gvim +$2 $1	277	URxvt.matcher.launcher.2: gvim +$2 $1
276		278
…		…
398	=item confirm-paste	400	=item confirm-paste
399		401
400	Displays a confirmation dialog when a paste containing at least a full	402	Displays a confirmation dialog when a paste containing at least a full
401	line is detected.	403	line is detected.
402		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
		412
403	=back	413	=back
404		414
405	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
406		416
407	=head2 General API Considerations	417	=head2 General API Considerations
…		…
436	=item $octets	446	=item $octets
437		447
438	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
439	locale-specific way.	449	locale-specific way.
440		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
441	=back	457	=back
442		458
443	=head2 Extension Objects	459	=head2 Extension Objects
444		460
445	Every perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
446	for each terminal, and each terminal has its own set of extenion objects,	462	for each terminal, and each terminal has its own set of extension objects,
447	which are passed as the first parameter to hooks. So extensions can use	463	which are passed as the first parameter to hooks. So extensions can use
448	their C<$self> object without having to think about clashes with other	464	their C<$self> object without having to think about clashes with other
449	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
450	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
451	internal use.	467	internal use.
…		…
656	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
657		673
658	The event is simply the action string. This interface is assumed to change	674	The event is simply the action string. This interface is assumed to change
659	slightly in the future.	675	slightly in the future.
660		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
661	=item on_resize_all_windows $term, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
662		685
663	Called just after the new window size has been calculated, but before	686	Called just after the new window size has been calculated, but before
664	windows are actually being resized or hints are being set. If this hook	687	windows are actually being resized or hints are being set. If this hook
665	returns TRUE, setting of the window hints is being skipped.	688	returns TRUE, setting of the window hints is being skipped.
…		…
739	use Scalar::Util ();	762	use Scalar::Util ();
740	use List::Util ();	763	use List::Util ();
741		764
742	our $VERSION = 1;	765	our $VERSION = 1;
743	our $TERM;	766	our $TERM;
744	our @TERM_INIT;	767	our @TERM_INIT; # should go, prevents async I/O etc.
745	our @TERM_EXT;	768	our @TERM_EXT; # should go, prevents async I/O etc.
746	our @HOOKNAME;	769	our @HOOKNAME;
747	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
748	our %OPTION;	771	our %OPTION;
749		772
750	our $LIBDIR;	773	our $LIBDIR;
…		…
798		821
799	=over 4	822	=over 4
800		823
801	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
802		825
803	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
804	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
805	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
806		830
807	=item urxvt::warn $string	831	=item urxvt::warn $string
808		832
809	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
810	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
811	that calls this function.	835	that calls this function.
812		836
813	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
814	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
818	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
819		843
820	Returns all urxvt::term objects that exist in this process, regardless of	844	Returns all urxvt::term objects that exist in this process, regardless of
821	whether they are started, being destroyed etc., so be careful. Only term	845	whether they are started, being destroyed etc., so be careful. Only term
822	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
823	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
824		848
825	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
826		850
827	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
828		852
…		…
919	};	943	};
920	}	944	}
921		945
922	no warnings 'utf8';	946	no warnings 'utf8';
923		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	my $r = $term->{meta}{resource};
		954	while (my ($pattern, $v) = each %$r) {
		955	$name =~ y/-/./ if $isarg;
		956
		957	if (
		958	$pattern =~ s/\*$//
		959	? $pattern eq substr $name, 0, length $pattern
		960	: $pattern eq $name
		961	) {
		962	$name = "$urxvt::RESCLASS.$name";
		963
		964	push @TERM_EXT, $v->[0];
		965
		966	if ($v->[1] eq "boolean") {
		967	$term->put_option_db ($name, $flag ? "true" : "false");
		968	return 1;
		969	} else {
		970	$term->put_option_db ($name, $value);
		971	return 1 + 2;
		972	}
		973	}
		974	}
		975
		976	0
		977	}
		978
		979	sub usage {
		980	my ($term, $usage_type) = @_;
		981
		982	$term->scan_meta;
		983
		984	my $r = $term->{meta}{resource};
		985
		986	for my $pattern (sort keys %$r) {
		987	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		988
		989	$desc .= " (-pe $ext)";
		990
		991	if ($usage_type == 1) {
		992	$pattern =~ y/./-/;
		993	$pattern =~ s/\*/.../g;
		994
		995	if ($type eq "boolean") {
		996	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		997	} else {
		998	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		999	}
		1000	} else {
		1001	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1002	}
		1003	}
		1004	}
		1005
924	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1006	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
925		1007
926	sub verbose {	1008	sub verbose {
927	my ($level, $msg) = @_;	1009	my ($level, $msg) = @_;
928	warn "$msg\n" if $level <= $verbosity;	1010	warn "$msg\n" if $level <= $verbosity;
…		…
964	sub invoke {	1046	sub invoke {
965	local $TERM = shift;	1047	local $TERM = shift;
966	my $htype = shift;	1048	my $htype = shift;
967		1049
968	if ($htype == 0) { # INIT	1050	if ($htype == 0) { # INIT
969	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1051	my @dirs = $TERM->perl_libdirs;
970		1052
971	my %ext_arg;	1053	my %ext_arg;
972		1054
973	{	1055	{
974	my @init = @TERM_INIT;	1056	my @init = @TERM_INIT;
…		…
1135	=head2 The C<urxvt::anyevent> Class	1217	=head2 The C<urxvt::anyevent> Class
1136		1218
1137	The sole purpose of this class is to deliver an interface to the	1219	The sole purpose of this class is to deliver an interface to the
1138	C<AnyEvent> module - any module using it will work inside urxvt without	1220	C<AnyEvent> module - any module using it will work inside urxvt without
1139	further programming. The only exception is that you cannot wait on	1221	further programming. The only exception is that you cannot wait on
1140	condition variables, but non-blocking condvar use is ok. What this means	1222	condition variables, but non-blocking condvar use is ok.
1141	is that you cannot use blocking APIs, but the non-blocking variant should	1223
1142	work.	1224	In practical terms this means is that you cannot use blocking APIs, but
		1225	the non-blocking variant should work.
1143		1226
1144	=cut	1227	=cut
1145		1228
1146	our $VERSION = '5.23';	1229	our $VERSION = '5.23';
1147		1230
…		…
1206		1289
1207	sub DESTROY {	1290	sub DESTROY {
1208	$_[0][1]->stop;	1291	$_[0][1]->stop;
1209	}	1292	}
1210		1293
		1294	# only needed for AnyEvent < 6 compatibility
1211	sub one_event {	1295	sub one_event {
1212	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1296	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1213	}	1297	}
1214		1298
1215	package urxvt::term;	1299	package urxvt::term;
…		…
1244	$proxy->enable ($name => $ref);	1328	$proxy->enable ($name => $ref);
1245	}	1329	}
1246	}	1330	}
1247	}	1331	}
1248		1332
		1333	sub perl_libdirs {
		1334	map { split /:/ }
		1335	$_[0]->resource ("perl_lib"),
		1336	$ENV{URXVT_PERL_LIB},
		1337	"$ENV{HOME}/.urxvt/ext",
		1338	"$LIBDIR/perl"
		1339	}
		1340
		1341	sub scan_meta {
		1342	my ($self) = @_;
		1343	my @libdirs = perl_libdirs $self;
		1344
		1345	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1346
		1347	my %meta;
		1348
		1349	$self->{meta_libdirs} = join "\x00", @libdirs;
		1350	$self->{meta} = \%meta;
		1351
		1352	for my $dir (reverse @libdirs) {
		1353	opendir my $fh, $dir
		1354	or next;
		1355	for my $ext (readdir $fh) {
		1356	$ext ne "."
		1357	and $ext ne ".."
		1358	and open my $fh, "<", "$dir/$ext"
		1359	or next;
		1360
		1361	while (<$fh>) {
		1362	if (/^#:META:X_RESOURCE:(.*)/) {
		1363	my ($pattern, $type, $desc) = split /:/, $1;
		1364	$pattern =~ s/^%\./$ext./g; # $$ in pattern == extension name
		1365	if ($pattern =~ /[^a-zA-Z\*\.]/) {
		1366	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1367	} else {
		1368	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1369	}
		1370	} elsif (/^\s*(?:#\|$)/) {
		1371	# skip other comments and empty lines
		1372	} else {
		1373	last; # stop parsing on first non-empty non-comment line
		1374	}
		1375	}
		1376	}
		1377	}
		1378	}
		1379
1249	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1380	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1250		1381
1251	Creates a new terminal, very similar as if you had started it with system	1382	Creates a new terminal, very similar as if you had started it with system
1252	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1383	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1253	hash which defines the environment of the new terminal.	1384	hash which defines the environment of the new terminal.
…		…
1307	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1438	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1308		1439
1309	Here is a likely non-exhaustive list of option names, please see the	1440	Here is a likely non-exhaustive list of option names, please see the
1310	source file F</src/optinc.h> to see the actual list:	1441	source file F</src/optinc.h> to see the actual list:
1311		1442
1312	borderLess console cursorBlink cursorUnderline hold iconic insecure	1443	borderLess buffered console cursorBlink cursorUnderline hold iconic
1313	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1444	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1314	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1445	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1315	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1446	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1316	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1447	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1317	transparent tripleclickwords utmpInhibit visualBell	1448	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1449	urgentOnBell utmpInhibit visualBell
1318		1450
1319	=item $value = $term->resource ($name[, $newval])	1451	=item $value = $term->resource ($name[, $newval])
1320		1452
1321	Returns the current resource value associated with a given name and	1453	Returns the current resource value associated with a given name and
1322	optionally sets a new value. Setting values is most useful in the C<init>	1454	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1335		1467
1336	Here is a likely non-exhaustive list of resource names, not all of which	1468	Here is a likely non-exhaustive list of resource names, not all of which
1337	are supported in every build, please see the source file F</src/rsinc.h>	1469	are supported in every build, please see the source file F</src/rsinc.h>
1338	to see the actual list:	1470	to see the actual list:
1339		1471
1340	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1472	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1341	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1473	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1342	display_name embed ext_bwidth fade font geometry hold iconName	1474	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1343	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1475	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1344	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8	1476	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
		1477	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1345	modifier mouseWheelScrollPage name override_redirect pastableTabs path	1478	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1346	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1479	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1347	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1480	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1348	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1481	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1349	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1482	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1350	secondaryScreen secondaryScroll shade term_name title	1483	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1351	transient_for transparent transparent_all tripleclickwords utmpInhibit	1484	term_name title transient_for transparent tripleclickwords urgentOnBell
1352	visualBell	1485	utmpInhibit visualBell
1353		1486
1354	=cut	1487	=cut
1355		1488
1356	sub resource($$;$) {	1489	sub resource($$;$) {
1357	my ($self, $name) = (shift, shift);	1490	my ($self, $name) = (shift, shift);
…		…
1368		1501
1369	This method should only be called during the C<on_start> hook, as there is	1502	This method should only be called during the C<on_start> hook, as there is
1370	only one resource database per display, and later invocations might return	1503	only one resource database per display, and later invocations might return
1371	the wrong resources.	1504	the wrong resources.
1372		1505
1373	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1506	=item $value = $term->x_resource_boolean ($pattern)
1374		1507
		1508	Like C<x_resource>, above, but interprets the string value as a boolean
		1509	and returns C<1> for true values, C<0> for false values and C<undef> if
		1510	the resource or option isn't specified.
		1511
		1512	You should always use this method to parse boolean resources.
		1513
		1514	=cut
		1515
		1516	sub x_resource_boolean {
		1517	my $res = &x_resource;
		1518
		1519	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1520	}
		1521
		1522	=item $success = $term->parse_keysym ($key, $octets)
		1523
1375	Adds a keymap translation exactly as specified via a resource. See the	1524	Adds a key binding exactly as specified via a resource. See the
1376	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1525	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1526
		1527	=item $term->register_command ($keysym, $modifiermask, $string)
		1528
		1529	Adds a key binding. This is a lower level api compared to
		1530	C<parse_keysym>, as it expects a parsed key description, and can be
		1531	used only inside either the C<on_init> hook, to add a binding, or the
		1532	C<on_register_command> hook, to modify a parsed binding.
1377		1533
1378	=item $rend = $term->rstyle ([$new_rstyle])	1534	=item $rend = $term->rstyle ([$new_rstyle])
1379		1535
1380	Return and optionally change the current rendition. Text that is output by	1536	Return and optionally change the current rendition. Text that is output by
1381	the terminal application will use this style.	1537	the terminal application will use this style.
…		…
1594		1750
1595	Adds the specified events to the vt event mask. Useful e.g. when you want	1751	Adds the specified events to the vt event mask. Useful e.g. when you want
1596	to receive pointer events all the times:	1752	to receive pointer events all the times:
1597		1753
1598	$term->vt_emask_add (urxvt::PointerMotionMask);	1754	$term->vt_emask_add (urxvt::PointerMotionMask);
		1755
		1756	=item $term->set_urgency ($set)
		1757
		1758	Enable/disable the urgency hint on the toplevel window.
1599		1759
1600	=item $term->focus_in	1760	=item $term->focus_in
1601		1761
1602	=item $term->focus_out	1762	=item $term->focus_out
1603		1763
…		…
1919	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2079	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1920		2080
1921	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2081	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1922		2082
1923	=item $term->XChangeInput ($window, $add_events[, $del_events])	2083	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2084
		2085	=item $keysym = $term->XStringToKeysym ($string)
		2086
		2087	=item $string = $term->XKeysymToString ($keysym)
1924		2088
1925	Various X or X-related functions. The C<$term> object only serves as	2089	Various X or X-related functions. The C<$term> object only serves as
1926	the source of the display, otherwise those functions map more-or-less	2090	the source of the display, otherwise those functions map more-or-less
1927	directly onto the X functions of the same name.	2091	directly onto the X functions of the same name.
1928		2092
…		…
2250		2414
2251	=back	2415	=back
2252		2416
2253	=head1 AUTHOR	2417	=head1 AUTHOR
2254		2418
2255	Marc Lehmann <pcg@goof.com>	2419	Marc Lehmann <schmorp@schmorp.de>
2256	http://software.schmorp.de/pkg/rxvt-unicode	2420	http://software.schmorp.de/pkg/rxvt-unicode
2257		2421
2258	=cut	2422	=cut
2259		2423
2260	1	2424	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC vs. Revision 1.211 by root, Wed Jun 6 14:34:03 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC vs.
Revision 1.211 by root, Wed Jun 6 14:34:03 2012 UTC