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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC vs.
Revision 1.209 by root, Tue Jun 5 22:38:17 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
…		…
393		395
394	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
395	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
396	overlays or changes.	398	overlays or changes.
397		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		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
398	=back	413	=back
399		414
400	=head1 API DOCUMENTATION	415	=head1 API DOCUMENTATION
401		416
402	=head2 General API Considerations	417	=head2 General API Considerations
…		…
431	=item $octets	446	=item $octets
432		447
433	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
434	locale-specific way.	449	locale-specific way.
435		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
436	=back	457	=back
437		458
438	=head2 Extension Objects	459	=head2 Extension Objects
439		460
440	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
441	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,
442	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
443	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
444	extensions or other terminals, with the exception of methods and members	465	extensions or other terminals, with the exception of methods and members
445	that begin with an underscore character C<_>: these are reserved for	466	that begin with an underscore character C<_>: these are reserved for
446	internal use.	467	internal use.
…		…
650	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>
651	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
652		673
653	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
654	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>.
655		683
656	=item on_resize_all_windows $term, $new_width, $new_height	684	=item on_resize_all_windows $term, $new_width, $new_height
657		685
658	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
659	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
…		…
793		821
794	=over 4	822	=over 4
795		823
796	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
797		825
798	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
799	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
800	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
801		830
802	=item urxvt::warn $string	831	=item urxvt::warn $string
803		832
804	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
805	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
806	that calls this function.	835	that calls this function.
807		836
808	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
809	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
813	=item @terms = urxvt::termlist	842	=item @terms = urxvt::termlist
814		843
815	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
816	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
817	objects that have perl extensions attached will be returned (because there	846	objects that have perl extensions attached will be returned (because there
818	is no urxvt::term objet associated with others).	847	is no urxvt::term object associated with others).
819		848
820	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
821		850
822	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
823		852
…		…
866		895
867	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
868		897
869	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
870		899
871	=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
872		902
873	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
874	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
875	the bitset.	905	the bitset.
876		906
…		…
913	};	943	};
914	}	944	}
915		945
916	no warnings 'utf8';	946	no warnings 'utf8';
917		947
		948	sub resource {
		949	my ($term, $name, $isarg, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	warn "resourece<@_>\n";#d#
		954
		955	0
		956	}
		957
		958	sub usage {
		959	my ($term, $usage_type) = @_;
		960
		961	$term->scan_meta;
		962
		963	my $r = $term->{meta}{resource};
		964
		965	for my $regex (sort keys %$r) {
		966	my ($ext, $type, $desc) = @{ $r->{$regex} };
		967
		968	$desc .= " (-pe $ext)";
		969
		970	if ($usage_type == 1) {
		971	if ($type eq "boolean") {
		972	urxvt::log sprintf " -%-20.20s %s\n", "/+$regex", $desc;
		973	} else {
		974	urxvt::log sprintf " -%-20.20s %s\n", "$regex $type", $desc;
		975	}
		976	} else {
		977	urxvt::log sprintf " %-19.19s %s\n", "$regex:", $type;
		978	}
		979	}
		980	}
		981
918	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	982	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
919		983
920	sub verbose {	984	sub verbose {
921	my ($level, $msg) = @_;	985	my ($level, $msg) = @_;
922	warn "$msg\n" if $level <= $verbosity;	986	warn "$msg\n" if $level <= $verbosity;
…		…
958	sub invoke {	1022	sub invoke {
959	local $TERM = shift;	1023	local $TERM = shift;
960	my $htype = shift;	1024	my $htype = shift;
961		1025
962	if ($htype == 0) { # INIT	1026	if ($htype == 0) { # INIT
963	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1027	my @dirs = $TERM->perl_libdirs;
964		1028
965	my %ext_arg;	1029	my %ext_arg;
966		1030
967	{	1031	{
968	my @init = @TERM_INIT;	1032	my @init = @TERM_INIT;
…		…
1129	=head2 The C<urxvt::anyevent> Class	1193	=head2 The C<urxvt::anyevent> Class
1130		1194
1131	The sole purpose of this class is to deliver an interface to the	1195	The sole purpose of this class is to deliver an interface to the
1132	C<AnyEvent> module - any module using it will work inside urxvt without	1196	C<AnyEvent> module - any module using it will work inside urxvt without
1133	further programming. The only exception is that you cannot wait on	1197	further programming. The only exception is that you cannot wait on
1134	condition variables, but non-blocking condvar use is ok. What this means	1198	condition variables, but non-blocking condvar use is ok.
1135	is that you cannot use blocking APIs, but the non-blocking variant should	1199
1136	work.	1200	In practical terms this means is that you cannot use blocking APIs, but
		1201	the non-blocking variant should work.
1137		1202
1138	=cut	1203	=cut
1139		1204
1140	our $VERSION = '5.23';	1205	our $VERSION = '5.23';
1141		1206
…		…
1200		1265
1201	sub DESTROY {	1266	sub DESTROY {
1202	$_[0][1]->stop;	1267	$_[0][1]->stop;
1203	}	1268	}
1204		1269
		1270	# only needed for AnyEvent < 6 compatibility
1205	sub one_event {	1271	sub one_event {
1206	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";	1272	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1207	}	1273	}
1208		1274
1209	package urxvt::term;	1275	package urxvt::term;
…		…
1238	$proxy->enable ($name => $ref);	1304	$proxy->enable ($name => $ref);
1239	}	1305	}
1240	}	1306	}
1241	}	1307	}
1242		1308
		1309	sub perl_libdirs {
		1310	map { split /:/ }
		1311	$_[0]->resource ("perl_lib"),
		1312	$ENV{URXVT_PERL_LIB},
		1313	"$ENV{HOME}/.urxvt/ext",
		1314	"$LIBDIR/perl"
		1315	}
		1316
		1317	sub scan_meta {
		1318	my ($self) = @_;
		1319	my @libdirs = perl_libdirs $self;
		1320
		1321	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1322
		1323	my %meta;
		1324
		1325	$self->{meta_libdirs} = join "\x00", @libdirs;
		1326	$self->{meta} = \%meta;
		1327
		1328	for my $dir (reverse @libdirs) {
		1329	opendir my $fh, $dir
		1330	or next;
		1331	for my $ext (readdir $fh) {
		1332	$ext ne "."
		1333	and $ext ne ".."
		1334	and open my $fh, "<", "$dir/$ext"
		1335	or next;
		1336
		1337	while (<$fh>) {
		1338	if (/^#:META:RESOURCE:(.*)/) {
		1339	my ($regex, $type, $desc) = split /:/, $1;
		1340	$regex =~ s/\$\$/$ext/g; # $$ in regex == extension name
		1341	$meta{resource}{$regex} = [$ext, $type, $desc];
		1342	} elsif (/^\s*(?:#\|$)/) {
		1343	# skip other comments and empty lines
		1344	} else {
		1345	last; # stop parsing on first non-empty non-comment line
		1346	}
		1347	}
		1348	}
		1349	}
		1350	}
		1351
1243	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1352	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1244		1353
1245	Creates a new terminal, very similar as if you had started it with system	1354	Creates a new terminal, very similar as if you had started it with system
1246	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like	1355	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1247	hash which defines the environment of the new terminal.	1356	hash which defines the environment of the new terminal.
…		…
1301	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1410	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1302		1411
1303	Here is a likely non-exhaustive list of option names, please see the	1412	Here is a likely non-exhaustive list of option names, please see the
1304	source file F</src/optinc.h> to see the actual list:	1413	source file F</src/optinc.h> to see the actual list:
1305		1414
1306	borderLess console cursorBlink cursorUnderline hold iconic insecure	1415	borderLess buffered console cursorBlink cursorUnderline hold iconic
1307	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1416	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1308	override-redirect pastableTabs pointerBlank reverseVideo scrollBar	1417	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1309	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput	1418	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1310	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs	1419	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1311	transparent tripleclickwords utmpInhibit visualBell	1420	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1421	urgentOnBell utmpInhibit visualBell
1312		1422
1313	=item $value = $term->resource ($name[, $newval])	1423	=item $value = $term->resource ($name[, $newval])
1314		1424
1315	Returns the current resource value associated with a given name and	1425	Returns the current resource value associated with a given name and
1316	optionally sets a new value. Setting values is most useful in the C<init>	1426	optionally sets a new value. Setting values is most useful in the C<init>
…		…
1329		1439
1330	Here is a likely non-exhaustive list of resource names, not all of which	1440	Here is a likely non-exhaustive list of resource names, not all of which
1331	are supported in every build, please see the source file F</src/rsinc.h>	1441	are supported in every build, please see the source file F</src/rsinc.h>
1332	to see the actual list:	1442	to see the actual list:
1333		1443
1334	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1444	answerbackstring backgroundPixmap backspace_key blendtype blurradius
1335	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1445	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1336	display_name embed ext_bwidth fade font geometry hold iconName	1446	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1337	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1447	fade font geometry hold iconName iconfile imFont imLocale inputMethod
1338	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8	1448	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
		1449	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1339	modifier mouseWheelScrollPage name override_redirect pastableTabs path	1450	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1340	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1451	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1341	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1452	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1342	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1453	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1343	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1454	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1344	secondaryScreen secondaryScroll shade term_name title	1455	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1345	transient_for transparent transparent_all tripleclickwords utmpInhibit	1456	term_name title transient_for transparent tripleclickwords urgentOnBell
1346	visualBell	1457	utmpInhibit visualBell
1347		1458
1348	=cut	1459	=cut
1349		1460
1350	sub resource($$;$) {	1461	sub resource($$;$) {
1351	my ($self, $name) = (shift, shift);	1462	my ($self, $name) = (shift, shift);
…		…
1362		1473
1363	This method should only be called during the C<on_start> hook, as there is	1474	This method should only be called during the C<on_start> hook, as there is
1364	only one resource database per display, and later invocations might return	1475	only one resource database per display, and later invocations might return
1365	the wrong resources.	1476	the wrong resources.
1366		1477
1367	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1478	=item $success = $term->parse_keysym ($key, $octets)
1368		1479
1369	Adds a keymap translation exactly as specified via a resource. See the	1480	Adds a key binding exactly as specified via a resource. See the
1370	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1481	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1482
		1483	=item $term->register_command ($keysym, $modifiermask, $string)
		1484
		1485	Adds a key binding. This is a lower level api compared to
		1486	C<parse_keysym>, as it expects a parsed key description, and can be
		1487	used only inside either the C<on_init> hook, to add a binding, or the
		1488	C<on_register_command> hook, to modify a parsed binding.
1371		1489
1372	=item $rend = $term->rstyle ([$new_rstyle])	1490	=item $rend = $term->rstyle ([$new_rstyle])
1373		1491
1374	Return and optionally change the current rendition. Text that is output by	1492	Return and optionally change the current rendition. Text that is output by
1375	the terminal application will use this style.	1493	the terminal application will use this style.
…		…
1588		1706
1589	Adds the specified events to the vt event mask. Useful e.g. when you want	1707	Adds the specified events to the vt event mask. Useful e.g. when you want
1590	to receive pointer events all the times:	1708	to receive pointer events all the times:
1591		1709
1592	$term->vt_emask_add (urxvt::PointerMotionMask);	1710	$term->vt_emask_add (urxvt::PointerMotionMask);
		1711
		1712	=item $term->set_urgency ($set)
		1713
		1714	Enable/disable the urgency hint on the toplevel window.
1593		1715
1594	=item $term->focus_in	1716	=item $term->focus_in
1595		1717
1596	=item $term->focus_out	1718	=item $term->focus_out
1597		1719
…		…
1913	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)	2035	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1914		2036
1915	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)	2037	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1916		2038
1917	=item $term->XChangeInput ($window, $add_events[, $del_events])	2039	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2040
		2041	=item $keysym = $term->XStringToKeysym ($string)
		2042
		2043	=item $string = $term->XKeysymToString ($keysym)
1918		2044
1919	Various X or X-related functions. The C<$term> object only serves as	2045	Various X or X-related functions. The C<$term> object only serves as
1920	the source of the display, otherwise those functions map more-or-less	2046	the source of the display, otherwise those functions map more-or-less
1921	directly onto the X functions of the same name.	2047	directly onto the X functions of the same name.
1922		2048
…		…
2244		2370
2245	=back	2371	=back
2246		2372
2247	=head1 AUTHOR	2373	=head1 AUTHOR
2248		2374
2249	Marc Lehmann <pcg@goof.com>	2375	Marc Lehmann <schmorp@schmorp.de>
2250	http://software.schmorp.de/pkg/rxvt-unicode	2376	http://software.schmorp.de/pkg/rxvt-unicode
2251		2377
2252	=cut	2378	=cut
2253		2379
2254	1	2380	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC vs. Revision 1.209 by root, Tue Jun 5 22:38:17 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 UTC vs.
Revision 1.209 by root, Tue Jun 5 22:38:17 2012 UTC