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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.188 by sf-exg, Sat Jul 24 13:04:27 2010 UTC vs.
Revision 1.210 by root, Wed Jun 6 11:46:11 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.
…		…
655	a C<perl:string> action bound to a key, see description of the B<keysym>	671	a C<perl:string> action bound to a key, see description of the B<keysym>
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.
		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>.
660		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
…		…
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
…		…
871		895
872	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
873		897
874	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
875		899
876	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
877		902
878	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
879	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
880	the bitset.	905	the bitset.
881		906
…		…
918	};	943	};
919	}	944	}
920		945
921	no warnings 'utf8';	946	no warnings 'utf8';
922		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	warn "resourece<@_>\n";#d#
		954
		955	my $r = $term->{meta}{resource};
		956	while (my ($pattern, $v) = each %$r) {
		957	$name =~ y/-/./ if $isarg;
		958
		959	if (
		960	$pattern =~ s/\*$//
		961	? $pattern eq substr $name, 0, length $pattern
		962	: $pattern eq $name
		963	) {
		964	$name = "$urxvt::RESCLASS.$name";
		965	warn "set option <$name=$value>\n";#d#
		966	#TODO: queue $v->[0] for loading
		967	if ($v->[1] eq "boolean") {
		968	$term->put_option_db ($name, $flag ? "true" : "false");
		969	return 1;
		970	} else {
		971	$term->put_option_db ($name, $value);
		972	return 1 + 2;
		973	}
		974	}
		975	}
		976
		977	0
		978	}
		979
		980	sub usage {
		981	my ($term, $usage_type) = @_;
		982
		983	$term->scan_meta;
		984
		985	my $r = $term->{meta}{resource};
		986
		987	for my $pattern (sort keys %$r) {
		988	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		989
		990	$desc .= " (-pe $ext)";
		991
		992	if ($usage_type == 1) {
		993	$pattern =~ y/./-/;
		994	$pattern =~ s/\*/.../g;
		995
		996	if ($type eq "boolean") {
		997	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		998	} else {
		999	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		1000	}
		1001	} else {
		1002	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1003	}
		1004	}
		1005	}
		1006
923	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
924		1008
925	sub verbose {	1009	sub verbose {
926	my ($level, $msg) = @_;	1010	my ($level, $msg) = @_;
927	warn "$msg\n" if $level <= $verbosity;	1011	warn "$msg\n" if $level <= $verbosity;
…		…
963	sub invoke {	1047	sub invoke {
964	local $TERM = shift;	1048	local $TERM = shift;
965	my $htype = shift;	1049	my $htype = shift;
966		1050
967	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
968	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
969		1053
970	my %ext_arg;	1054	my %ext_arg;
971		1055
972	{	1056	{
973	my @init = @TERM_INIT;	1057	my @init = @TERM_INIT;
…		…
1134	=head2 The C<urxvt::anyevent> Class	1218	=head2 The C<urxvt::anyevent> Class
1135		1219
1136	The sole purpose of this class is to deliver an interface to the	1220	The sole purpose of this class is to deliver an interface to the
1137	C<AnyEvent> module - any module using it will work inside urxvt without	1221	C<AnyEvent> module - any module using it will work inside urxvt without
1138	further programming. The only exception is that you cannot wait on	1222	further programming. The only exception is that you cannot wait on
1139	condition variables, but non-blocking condvar use is ok. What this means	1223	condition variables, but non-blocking condvar use is ok.
1140	is that you cannot use blocking APIs, but the non-blocking variant should	1224
1141	work.	1225	In practical terms this means is that you cannot use blocking APIs, but
		1226	the non-blocking variant should work.
1142		1227
1143	=cut	1228	=cut
1144		1229
1145	our $VERSION = '5.23';	1230	our $VERSION = '5.23';
1146		1231
…		…
1205		1290
1206	sub DESTROY {	1291	sub DESTROY {
1207	$_[0][1]->stop;	1292	$_[0][1]->stop;
1208	}	1293	}
1209		1294
		1295	# only needed for AnyEvent < 6 compatibility
1210	sub one_event {	1296	sub one_event {
1211	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1297	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1212	}	1298	}
1213		1299
1214	package urxvt::term;	1300	package urxvt::term;
…		…
1243	$proxy->enable ($name => $ref);	1329	$proxy->enable ($name => $ref);
1244	}	1330	}
1245	}	1331	}
1246	}	1332	}
1247		1333
		1334	sub perl_libdirs {
		1335	map { split /:/ }
		1336	$_[0]->resource ("perl_lib"),
		1337	$ENV{URXVT_PERL_LIB},
		1338	"$ENV{HOME}/.urxvt/ext",
		1339	"$LIBDIR/perl"
		1340	}
		1341
		1342	sub scan_meta {
		1343	my ($self) = @_;
		1344	my @libdirs = perl_libdirs $self;
		1345
		1346	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1347
		1348	my %meta;
		1349
		1350	$self->{meta_libdirs} = join "\x00", @libdirs;
		1351	$self->{meta} = \%meta;
		1352
		1353	for my $dir (reverse @libdirs) {
		1354	opendir my $fh, $dir
		1355	or next;
		1356	for my $ext (readdir $fh) {
		1357	$ext ne "."
		1358	and $ext ne ".."
		1359	and open my $fh, "<", "$dir/$ext"
		1360	or next;
		1361
		1362	while (<$fh>) {
		1363	if (/^#:META:X_RESOURCE:(.*)/) {
		1364	my ($pattern, $type, $desc) = split /:/, $1;
		1365	$pattern =~ s/^%\./$ext./g; # $$ in pattern == extension name
		1366	if ($pattern =~ /[^a-zA-Z\*\.]/) {
		1367	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1368	} else {
		1369	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1370	}
		1371	} elsif (/^\s*(?:#\|$)/) {
		1372	# skip other comments and empty lines
		1373	} else {
		1374	last; # stop parsing on first non-empty non-comment line
		1375	}
		1376	}
		1377	}
		1378	}
		1379	}
		1380
1248	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1381	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1249		1382
1250	Creates a new terminal, very similar as if you had started it with system	1383	Creates a new terminal, very similar as if you had started it with system
1251	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1384	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1252	hash which defines the environment of the new terminal.	1385	hash which defines the environment of the new terminal.
…		…
1306	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1439	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1307		1440
1308	Here is a likely non-exhaustive list of option names, please see the	1441	Here is a likely non-exhaustive list of option names, please see the
1309	source file F</src/optinc.h> to see the actual list:	1442	source file F</src/optinc.h> to see the actual list:
1310		1443
1311	borderLess console cursorBlink cursorUnderline hold iconic insecure	1444	borderLess buffered console cursorBlink cursorUnderline hold iconic
1312	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1445	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1313	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1446	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1314	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1447	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1315	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1448	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1316	transparent tripleclickwords utmpInhibit visualBell	1449	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1450	urgentOnBell utmpInhibit visualBell
1317		1451
1318	=item $value = $term->resource ($name[, $newval])	1452	=item $value = $term->resource ($name[, $newval])
1319		1453
1320	Returns the current resource value associated with a given name and	1454	Returns the current resource value associated with a given name and
1321	optionally sets a new value. Setting values is most useful in the C<init>	1455	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1334		1468
1335	Here is a likely non-exhaustive list of resource names, not all of which	1469	Here is a likely non-exhaustive list of resource names, not all of which
1336	are supported in every build, please see the source file F</src/rsinc.h>	1470	are supported in every build, please see the source file F</src/rsinc.h>
1337	to see the actual list:	1471	to see the actual list:
1338		1472
1339	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1473	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1340	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1474	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1341	display_name embed ext_bwidth fade font geometry hold iconName	1475	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1342	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1476	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1343	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8	1477	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
		1478	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1344	modifier mouseWheelScrollPage name override_redirect pastableTabs path	1479	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1345	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1480	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1346	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1481	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1347	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1482	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1348	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1483	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1349	secondaryScreen secondaryScroll shade term_name title	1484	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1350	transient_for transparent transparent_all tripleclickwords utmpInhibit	1485	term_name title transient_for transparent tripleclickwords urgentOnBell
1351	visualBell	1486	utmpInhibit visualBell
1352		1487
1353	=cut	1488	=cut
1354		1489
1355	sub resource($$;$) {	1490	sub resource($$;$) {
1356	my ($self, $name) = (shift, shift);	1491	my ($self, $name) = (shift, shift);
…		…
1367		1502
1368	This method should only be called during the C<on_start> hook, as there is	1503	This method should only be called during the C<on_start> hook, as there is
1369	only one resource database per display, and later invocations might return	1504	only one resource database per display, and later invocations might return
1370	the wrong resources.	1505	the wrong resources.
1371		1506
1372	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1507	=item $success = $term->parse_keysym ($key, $octets)
1373		1508
1374	Adds a keymap translation exactly as specified via a resource. See the	1509	Adds a key binding exactly as specified via a resource. See the
1375	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1510	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1511
		1512	=item $term->register_command ($keysym, $modifiermask, $string)
		1513
		1514	Adds a key binding. This is a lower level api compared to
		1515	C<parse_keysym>, as it expects a parsed key description, and can be
		1516	used only inside either the C<on_init> hook, to add a binding, or the
		1517	C<on_register_command> hook, to modify a parsed binding.
1376		1518
1377	=item $rend = $term->rstyle ([$new_rstyle])	1519	=item $rend = $term->rstyle ([$new_rstyle])
1378		1520
1379	Return and optionally change the current rendition. Text that is output by	1521	Return and optionally change the current rendition. Text that is output by
1380	the terminal application will use this style.	1522	the terminal application will use this style.
…		…
1593		1735
1594	Adds the specified events to the vt event mask. Useful e.g. when you want	1736	Adds the specified events to the vt event mask. Useful e.g. when you want
1595	to receive pointer events all the times:	1737	to receive pointer events all the times:
1596		1738
1597	$term->vt_emask_add (urxvt::PointerMotionMask);	1739	$term->vt_emask_add (urxvt::PointerMotionMask);
		1740
		1741	=item $term->set_urgency ($set)
		1742
		1743	Enable/disable the urgency hint on the toplevel window.
1598		1744
1599	=item $term->focus_in	1745	=item $term->focus_in
1600		1746
1601	=item $term->focus_out	1747	=item $term->focus_out
1602		1748
…		…
1918	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2064	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1919		2065
1920	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2066	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1921		2067
1922	=item $term->XChangeInput ($window, $add_events[, $del_events])	2068	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2069
		2070	=item $keysym = $term->XStringToKeysym ($string)
		2071
		2072	=item $string = $term->XKeysymToString ($keysym)
1923		2073
1924	Various X or X-related functions. The C<$term> object only serves as	2074	Various X or X-related functions. The C<$term> object only serves as
1925	the source of the display, otherwise those functions map more-or-less	2075	the source of the display, otherwise those functions map more-or-less
1926	directly onto the X functions of the same name.	2076	directly onto the X functions of the same name.
1927		2077
…		…
2249		2399
2250	=back	2400	=back
2251		2401
2252	=head1 AUTHOR	2402	=head1 AUTHOR
2253		2403
2254	Marc Lehmann <pcg@goof.com>	2404	Marc Lehmann <schmorp@schmorp.de>
2255	http://software.schmorp.de/pkg/rxvt-unicode	2405	http://software.schmorp.de/pkg/rxvt-unicode
2256		2406
2257	=cut	2407	=cut
2258		2408
2259	1	2409	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.188 by sf-exg, Sat Jul 24 13:04:27 2010 UTC vs. Revision 1.210 by root, Wed Jun 6 11:46:11 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.188 by sf-exg, Sat Jul 24 13:04:27 2010 UTC vs.
Revision 1.210 by root, Wed Jun 6 11:46:11 2012 UTC