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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC

…		…
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 @@RXVT_NAME@@d, 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	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	47	arguments, which is very convenient, too, if your F<ls> supports
		48	C<--quoting-style=shell>.
48		49
49	It also offers the following bindable event:	50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
		53	The selection works by trying to match a number of regexes and displaying
		54	them in increasing order of length. You can add your own regexes by
		55	specifying resources of the form:
		56
		57	URxvt.selection.pattern-0: perl-regex
		58	URxvt.selection.pattern-1: perl-regex
		59	...
		60
		61	The index number (0, 1...) must not have any holes, and each regex must
		62	contain at least one pair of capturing parentheses, which will be used for
		63	the match. For example, the followign adds a regex that matches everything
		64	between two vertical bars:
		65
		66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		67
		68	You can look at the source of the selection extension to see more
		69	interesting uses, such as parsing a line from beginning to end.
		70
		71	This extension also offers the following bindable keyboard command:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
…		…
64	runtime.	86	runtime.
65		87
66	=item selection-popup (enabled by default)	88	=item selection-popup (enabled by default)
67		89
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
70		93
71	=item digital-clock	94	=item searchable-scrollback<hotkey> (enabled by default)
72		95
73	Displays a digital clock using the built-in overlay.	96	Adds regex search functionality to the scrollback buffer, triggered
		97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		98	input/output is suspended and a regex is displayed at the bottom of the
		99	screen.
		100
		101	Inputting characters appends them to the regex and continues incremental
		102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		104	bottom. C<Escape> leaves search mode and returns to the point where search
		105	was started, while C<Enter> or C<Return> stay at the current position and
		106	additionally stores the first match in the current line into the primary
		107	selection.
		108
		109	=item selection-autotransform
		110
		111	This selection allows you to do automatic transforms on a selection
		112	whenever a selection is made.
		113
		114	It works by specifying perl snippets (most useful is a single C<s///>
		115	operator) that modify C<$_> as resources:
		116
		117	URxvt.selection-autotransform.0: transform
		118	URxvt.selection-autotransform.1: transform
		119	...
		120
		121	For example, the following will transform selections of the form
		122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		123	$word>:
		124
		125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		126
		127	And this example matches the same,but replaces it with vi-commands you can
		128	paste directly into your (vi :) editor:
		129
		130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		131
		132	Of course, this can be modified to suit your needs and your editor :)
74		133
75	=item mark-urls	134	=item mark-urls
76		135
77	Uses per-line display filtering (C<on_line_update>) to underline urls.	136	Uses per-line display filtering (C<on_line_update>) to underline urls and
		137	make them clickable. When middle-clicked, the program specified in the
		138	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		139	the URL as first argument.
78		140
79	=item block-graphics-to-ascii	141	=item block-graphics-to-ascii
80		142
81	A not very useful example of filtering all text output to the terminal,	143	A not very useful example of filtering all text output to the terminal,
82	by replacing all line-drawing characters (U+2500 .. U+259F) by a	144	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.	145	similar-looking ascii character.
84		146
		147	=item digital-clock
		148
		149	Displays a digital clock using the built-in overlay.
		150
85	=item example-refresh-hooks	151	=item example-refresh-hooks
86		152
87	Displays a very simple digital clock in the upper right corner of the	153	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	154	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	155	overlays or changes.
90		156
91	=back	157	=back
		158
		159	=head1 API DOCUMENTATION
92		160
93	=head2 General API Considerations	161	=head2 General API Considerations
94		162
95	All objects (such as terminals, time watchers etc.) are typical	163	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	164	reference-to-hash objects. The hash can be used to store anything you
…		…
109	=over 4	177	=over 4
110		178
111	=item $text	179	=item $text
112		180
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	181	Rxvt-unicodes special way of encoding text, where one "unicode" character
114	always represents one screen cell. See L<row_t> for a discussion of this format.	182	always represents one screen cell. See L<ROW_t> for a discussion of this format.
115		183
116	=item $string	184	=item $string
117		185
118	A perl text string, with an emphasis on I<text>. It can store all unicode	186	A perl text string, with an emphasis on I<text>. It can store all unicode
119	characters and is to be distinguished with text encoded in a specific	187	characters and is to be distinguished with text encoded in a specific
…		…
124	Either binary data or - more common - a text string encoded in a	192	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	193	locale-specific way.
126		194
127	=back	195	=back
128		196
		197	=head2 Extension Objects
		198
		199	Very perl extension is a perl class. A separate perl object is created
		200	for each terminal and each extension and passed as the first parameter to
		201	hooks. So extensions can use their C<$self> object without having to think
		202	about other extensions, with the exception of methods and members that
		203	begin with an underscore character C<_>: these are reserved for internal
		204	use.
		205
		206	Although it isn't a C<urxvt::term> object, you can call all methods of the
		207	C<urxvt::term> class on this object.
		208
		209	It has the following methods and data members:
		210
		211	=over 4
		212
		213	=item $urxvt_term = $self->{term}
		214
		215	Returns the C<urxvt::term> object associated with this instance of the
		216	extension. This member I<must not> be changed in any way.
		217
		218	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		219
		220	Dynamically enable the given hooks (named without the C<on_> prefix) for
		221	this extension, replacing any previous hook. This is useful when you want
		222	to overwrite time-critical hooks only temporarily.
		223
		224	=item $self->disable ($hook_name[, $hook_name..])
		225
		226	Dynamically disable the given hooks.
		227
		228	=back
		229
129	=head2 Hooks	230	=head2 Hooks
130		231
131	The following subroutines can be declared in extension files, and will be	232	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	233	called whenever the relevant event happens.
133		234
134	The first argument passed to them is an object private to each terminal	235	The first argument passed to them is an extension oject as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	236	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		237
141	All of them must return a boolean value. If it is true, then the event	238	B<All> of these hooks must return a boolean value. If it is true, then the
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	239	event counts as being I<consumed>, and the invocation of other hooks is
143	and the relevant action might not be carried out by the C++ code.	240	skipped, and the relevant action might not be carried out by the C++ code.
144		241
145	When in doubt, return a false value (preferably C<()>).	242	I<< When in doubt, return a false value (preferably C<()>). >>
146		243
147	=over 4	244	=over 4
148		245
149	=item on_init $term	246	=item on_init $term
150		247
…		…
185	=item on_sel_extend $term	282	=item on_sel_extend $term
186		283
187	Called whenever the user tries to extend the selection (e.g. with a double	284	Called whenever the user tries to extend the selection (e.g. with a double
188	click) and is either supposed to return false (normal operation), or	285	click) and is either supposed to return false (normal operation), or
189	should extend the selection itelf and return true to suppress the built-in	286	should extend the selection itelf and return true to suppress the built-in
190	processing.	287	processing. This can happen multiple times, as long as the callback
		288	returns true, it will be called on every further click by the user and is
		289	supposed to enlarge the selection more and more, if possible.
191		290
192	See the F<selection> example extension.	291	See the F<selection> example extension.
193		292
194	=item on_view_change $term, $offset	293	=item on_view_change $term, $offset
195		294
…		…
226	can filter/change and output the text yourself by returning a true value	325	can filter/change and output the text yourself by returning a true value
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	326	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	327	might be very slow, however, as your hook is called for B<all> text being
229	output.	328	output.
230		329
		330	=item on_tt_write $term, $octets
		331
		332	Called whenever some data is written to the tty/pty and can be used to
		333	suppress or filter tty input.
		334
231	=item on_line_update $term, $row	335	=item on_line_update $term, $row
232		336
233	Called whenever a line was updated or changed. Can be used to filter	337	Called whenever a line was updated or changed. Can be used to filter
234	screen output (e.g. underline urls or other useless stuff). Only lines	338	screen output (e.g. underline urls or other useless stuff). Only lines
235	that are being shown will be filtered, and, due to performance reasons,	339	that are being shown will be filtered, and, due to performance reasons,
…		…
267	=item on_focus_out $term	371	=item on_focus_out $term
268		372
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	373	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	374	focus out processing.
271		375
272	=item on_key_press $term, $event, $octets	376	=item on_key_press $term, $event, $keysym, $octets
273		377
274	=item on_key_release $term, $event	378	=item on_key_release $term, $event, $keysym
275		379
276	=item on_button_press $term, $event	380	=item on_button_press $term, $event
277		381
278	=item on_button_release $term, $event	382	=item on_button_release $term, $event
279		383
…		…
295		399
296	subwindow.	400	subwindow.
297		401
298	=back	402	=back
299		403
		404	=cut
		405
		406	package urxvt;
		407
		408	use utf8;
		409	use strict;
		410	use Carp ();
		411	use Scalar::Util ();
		412	use List::Util ();
		413
		414	our $VERSION = 1;
		415	our $TERM;
		416	our @HOOKNAME;
		417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		418	our %OPTION;
		419
		420	our $LIBDIR;
		421	our $RESNAME;
		422	our $RESCLASS;
		423	our $RXVTNAME;
		424
300	=head2 Variables in the C<urxvt> Package	425	=head2 Variables in the C<urxvt> Package
301		426
302	=over 4	427	=over 4
		428
		429	=item $urxvt::LIBDIR
		430
		431	The rxvt-unicode library directory, where, among other things, the perl
		432	modules and scripts are stored.
		433
		434	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		435
		436	The resource class and name rxvt-unicode uses to look up X resources.
		437
		438	=item $urxvt::RXVTNAME
		439
		440	The basename of the installed binaries, usually C<urxvt>.
303		441
304	=item $urxvt::TERM	442	=item $urxvt::TERM
305		443
306	The current terminal. This variable stores the current C<urxvt::term>	444	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	445	object, whenever a callback/hook is executing.
…		…
309	=back	447	=back
310		448
311	=head2 Functions in the C<urxvt> Package	449	=head2 Functions in the C<urxvt> Package
312		450
313	=over 4	451	=over 4
314
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322		452
323	=item urxvt::fatal $errormessage	453	=item urxvt::fatal $errormessage
324		454
325	Fatally aborts execution with the given error message. Avoid at all	455	Fatally aborts execution with the given error message. Avoid at all
326	costs! The only time this is acceptable is when the terminal process	456	costs! The only time this is acceptable is when the terminal process
…		…
332	newline. The module also overwrites the C<warn> builtin with a function	462	newline. The module also overwrites the C<warn> builtin with a function
333	that calls this function.	463	that calls this function.
334		464
335	Using this function has the advantage that its output ends up in the	465	Using this function has the advantage that its output ends up in the
336	correct place, e.g. on stderr of the connecting urxvtc client.	466	correct place, e.g. on stderr of the connecting urxvtc client.
		467
		468	Messages have a size limit of 1023 bytes currently.
		469
		470	=item $is_safe = urxvt::safe
		471
		472	Returns true when it is safe to do potentially unsafe things, such as
		473	evaluating perl code specified by the user. This is true when urxvt was
		474	started setuid or setgid.
337		475
338	=item $time = urxvt::NOW	476	=item $time = urxvt::NOW
339		477
340	Returns the "current time" (as per the event loop).	478	Returns the "current time" (as per the event loop).
341		479
…		…
380		518
381	=item $background = urxvt::GET_BASEBG $rend	519	=item $background = urxvt::GET_BASEBG $rend
382		520
383	Return the foreground/background colour index, respectively.	521	Return the foreground/background colour index, respectively.
384		522
385	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	523	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
386		524
387	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	525	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
388		526
389	Replace the foreground/background colour in the rendition mask with the	527	Replace the foreground/background colour in the rendition mask with the
390	specified one.	528	specified one.
391		529
392	=item $value = urxvt::GET_CUSTOM ($rend)	530	=item $value = urxvt::GET_CUSTOM $rend
393		531
394	Return the "custom" value: Every rendition has 5 bits for use by	532	Return the "custom" value: Every rendition has 5 bits for use by
395	extensions. They can be set and changed as you like and are initially	533	extensions. They can be set and changed as you like and are initially
396	zero.	534	zero.
397		535
398	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	536	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
399		537
400	Change the custom value.	538	Change the custom value.
401		539
402	=back	540	=back
403		541
404	=cut	542	=cut
405
406	package urxvt;
407
408	use utf8;
409	use strict;
410	use Scalar::Util ();
411	use List::Util ();
412
413	our $VERSION = 1;
414	our $TERM;
415	our @HOOKNAME;
416	our %OPTION;
417	our $LIBDIR;
418		543
419	BEGIN {	544	BEGIN {
420	urxvt->bootstrap;	545	urxvt->bootstrap;
421		546
422	# overwrite perl's warn	547	# overwrite perl's warn
…		…
425	$msg .= "\n"	550	$msg .= "\n"
426	unless $msg =~ /\n$/;	551	unless $msg =~ /\n$/;
427	urxvt::warn ($msg);	552	urxvt::warn ($msg);
428	};	553	};
429		554
		555	# %ENV is the original startup environment
430	delete $ENV{IFS};	556	delete $ENV{IFS};
431	delete $ENV{CDPATH};	557	delete $ENV{CDPATH};
432	delete $ENV{BASH_ENV};	558	delete $ENV{BASH_ENV};
433	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	559	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
434	}	560	}
…		…
439	sub verbose {	565	sub verbose {
440	my ($level, $msg) = @_;	566	my ($level, $msg) = @_;
441	warn "$msg\n" if $level <= $verbosity;	567	warn "$msg\n" if $level <= $verbosity;
442	}	568	}
443		569
444	# find on_xxx subs in the package and register them
445	# as hooks
446	sub register_package($) {
447	my ($pkg) = @_;
448
449	for my $htype (0.. $#HOOKNAME) {
450	my $name = $HOOKNAME[$htype];
451
452	my $ref = $pkg->can ("on_" . lc $name)
453	or next;
454
455	$TERM->{_hook}[$htype]{$pkg} = $ref;
456	$hook_count[$htype]++
457	or set_should_invoke $htype, 1;
458	}
459	}
460
461	my $extension_pkg = "extension0000";	570	my $extension_pkg = "extension0000";
462	my %extension_pkg;	571	my %extension_pkg;
463		572
464	# load a single script into its own package, once only	573	# load a single script into its own package, once only
465	sub extension_package($) {	574	sub extension_package($) {
…		…
471	verbose 3, "loading extension '$path' into package '$pkg'";	580	verbose 3, "loading extension '$path' into package '$pkg'";
472		581
473	open my $fh, "<:raw", $path	582	open my $fh, "<:raw", $path
474	or die "$path: $!";	583	or die "$path: $!";
475		584
		585	my $source = untaint
476	my $source = untaint "package $pkg; use strict; use utf8;\n"	586	"package $pkg; use strict; use utf8;\n"
477	. "use base urxvt::term::proxy::;\n"	587	. "use base urxvt::term::extension::;\n"
478	. "#line 1 \"$path\"\n{\n"	588	. "#line 1 \"$path\"\n{\n"
479	. (do { local $/; <$fh> })	589	. (do { local $/; <$fh> })
480	. "\n};\n1";	590	. "\n};\n1";
481		591
		592	eval $source
482	eval $source or die "$path: $@";	593	or die "$path: $@";
483		594
484	$pkg	595	$pkg
485	}	596	}
486	}	597	}
487		598
…		…
493	my $htype = shift;	604	my $htype = shift;
494		605
495	if ($htype == 0) { # INIT	606	if ($htype == 0) { # INIT
496	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	607	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
497		608
498	my %want_ext;	609	my %ext_arg;
499		610
500	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	611	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
501	if ($_ eq "default") {	612	if ($_ eq "default") {
502	$want_ext{$_}++ for qw(selection option-popup selection-popup);	613	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
503	} elsif (/^-(.*)$/) {	614	} elsif (/^-(.*)$/) {
504	delete $want_ext{$1};	615	delete $ext_arg{$1};
		616	} elsif (/^([^<]+)<(.*)>$/) {
		617	push @{ $ext_arg{$1} }, $2;
505	} else {	618	} else {
506	$want_ext{$_}++;	619	$ext_arg{$_} \|\|= [];
507	}	620	}
508	}	621	}
509		622
510	for my $ext (keys %want_ext) {	623	while (my ($ext, $argv) = each %ext_arg) {
511	my @files = grep -f $_, map "$_/$ext", @dirs;	624	my @files = grep -f $_, map "$_/$ext", @dirs;
512		625
513	if (@files) {	626	if (@files) {
514	register_package extension_package $files[0];	627	$TERM->register_package (extension_package $files[0], $argv);
515	} else {	628	} else {
516	warn "perl extension '$ext' not found in perl library search path\n";	629	warn "perl extension '$ext' not found in perl library search path\n";
517	}	630	}
518	}	631	}
519		632
…		…
528	if $verbosity >= 10;	641	if $verbosity >= 10;
529		642
530	keys %$cb;	643	keys %$cb;
531		644
532	while (my ($pkg, $cb) = each %$cb) {	645	while (my ($pkg, $cb) = each %$cb) {
533	eval {	646	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
534	$retval = $cb->(
535	$TERM->{_pkg}{$pkg} \|\|= do {
536	my $proxy = bless { }, $pkg;
537	Scalar::Util::weaken ($proxy->{term} = $TERM);
538	$proxy
539	},
540	@_,
541	) and last;	647	and last;
542	};	648
543	if ($@) {	649	if ($@) {
544	$TERM->ungrab; # better to lose the grab than the session	650	$TERM->ungrab; # better to lose the grab than the session
545	warn $@;	651	warn $@;
546	}	652	}
547	}	653	}
		654
		655	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		656	if $verbosity >= 11;
548	}	657	}
549		658
550	if ($htype == 1) { # DESTROY	659	if ($htype == 1) { # DESTROY
551	# remove hooks if unused
552	if (my $hook = $TERM->{_hook}) {	660	if (my $hook = delete $TERM->{_hook}) {
553	for my $htype (0..$#$hook) {	661	for my $htype (0..$#$hook) {
554	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	662	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
555	or set_should_invoke $htype, 0;	663	or set_should_invoke $htype, 0;
556	}	664	}
557	}	665	}
…		…
564	}	672	}
565		673
566	$retval	674	$retval
567	}	675	}
568		676
569	# urxvt::term::proxy	677	sub exec_async(@) {
		678	my $pid = fork;
570		679
571	sub urxvt::term::proxy::AUTOLOAD {	680	return
572	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	681	if !defined $pid or $pid;
		682
		683	%ENV = %{ $TERM->env };
		684
		685	exec @_;
		686	_exit 255;
		687	}
		688
		689	# urxvt::term::extension
		690
		691	package urxvt::term::extension;
		692
		693	sub enable {
		694	my ($self, %hook) = @_;
		695	my $pkg = $self->{_pkg};
		696
		697	while (my ($name, $cb) = each %hook) {
		698	my $htype = $HOOKTYPE{uc $name};
		699	defined $htype
		700	or Carp::croak "unsupported hook type '$name'";
		701
		702	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		703	$hook_count[$htype]++
		704	or urxvt::set_should_invoke $htype, 1;
		705	}
		706
		707	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		708	}
		709	}
		710
		711	sub disable {
		712	my ($self, @hook) = @_;
		713	my $pkg = $self->{_pkg};
		714
		715	for my $name (@hook) {
		716	my $htype = $HOOKTYPE{uc $name};
		717	defined $htype
		718	or Carp::croak "unsupported hook type '$name'";
		719
		720	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		721	--$hook_count[$htype]
		722	or urxvt::set_should_invoke $htype, 0;
		723	}
		724	}
		725	}
		726
		727	our $AUTOLOAD;
		728
		729	sub AUTOLOAD {
		730	$AUTOLOAD =~ /:([^:]+)$/
573	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	731	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
574		732
575	eval qq{	733	eval qq{
576	sub $urxvt::term::proxy::AUTOLOAD {	734	sub $AUTOLOAD {
577	my \$proxy = shift;	735	my \$proxy = shift;
578	\$proxy->{term}->$1 (\@_)	736	\$proxy->{term}->$1 (\@_)
579	}	737	}
580	1	738	1
581	} or die "FATAL: unable to compile method forwarder: $@";	739	} or die "FATAL: unable to compile method forwarder: $@";
582		740
583	goto &$urxvt::term::proxy::AUTOLOAD;	741	goto &$AUTOLOAD;
584	}	742	}
585		743
586	sub urxvt::term::proxy::DESTROY {	744	sub DESTROY {
587	# nop	745	# nop
588	}	746	}
589		747
590	# urxvt::destroy_hook	748	# urxvt::destroy_hook
591		749
…		…
601		759
602	=head2 The C<urxvt::anyevent> Class	760	=head2 The C<urxvt::anyevent> Class
603		761
604	The sole purpose of this class is to deliver an interface to the	762	The sole purpose of this class is to deliver an interface to the
605	C<AnyEvent> module - any module using it will work inside urxvt without	763	C<AnyEvent> module - any module using it will work inside urxvt without
606	further work. The only exception is that you cannot wait on condition	764	further programming. The only exception is that you cannot wait on
607	variables, but non-blocking condvar use is ok. What this means is that you	765	condition variables, but non-blocking condvar use is ok. What this means
608	cannot use blocking APIs, but the non-blocking variant should work.	766	is that you cannot use blocking APIs, but the non-blocking variant should
		767	work.
609		768
610	=cut	769	=cut
611		770
612	our $VERSION = 1;	771	our $VERSION = 1;
613		772
…		…
658	${$_[0]}++;	817	${$_[0]}++;
659	}	818	}
660		819
661	sub urxvt::anyevent::condvar::wait {	820	sub urxvt::anyevent::condvar::wait {
662	unless (${$_[0]}) {	821	unless (${$_[0]}) {
663	require Carp;
664	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	822	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
665	}	823	}
666	}	824	}
667		825
668	package urxvt::term;	826	package urxvt::term;
669		827
670	=head2 The C<urxvt::term> Class	828	=head2 The C<urxvt::term> Class
671		829
672	=over 4	830	=over 4
673		831
		832	=cut
		833
		834	# find on_xxx subs in the package and register them
		835	# as hooks
		836	sub register_package {
		837	my ($self, $pkg, $argv) = @_;
		838
		839	my $proxy = bless {
		840	_pkg => $pkg,
		841	argv => $argv,
		842	}, $pkg;
		843	Scalar::Util::weaken ($proxy->{term} = $self);
		844
		845	$self->{_pkg}{$pkg} = $proxy;
		846
		847	for my $name (@HOOKNAME) {
		848	if (my $ref = $pkg->can ("on_" . lc $name)) {
		849	$proxy->enable ($name => $ref);
		850	}
		851	}
		852	}
		853
		854	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		855
		856	Creates a new terminal, very similar as if you had started it with system
		857	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		858	hash which defines the environment of the new terminal.
		859
		860	Croaks (and probably outputs an error message) if the new instance
		861	couldn't be created. Returns C<undef> if the new instance didn't
		862	initialise perl, and the terminal object otherwise. The C<init> and
		863	C<start> hooks will be called during this call.
		864
		865	=cut
		866
		867	sub new {
		868	my ($class, $env, @args) = @_;
		869
		870	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		871	}
		872
674	=item $term->destroy	873	=item $term->destroy
675		874
676	Destroy the terminal object (close the window, free resources etc.).	875	Destroy the terminal object (close the window, free resources
		876	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		877	watchers (timers, io watchers) are still active.
677		878
678	=item $isset = $term->option ($optval[, $set])	879	=item $isset = $term->option ($optval[, $set])
679		880
680	Returns true if the option specified by C<$optval> is enabled, and	881	Returns true if the option specified by C<$optval> is enabled, and
681	optionally change it. All option values are stored by name in the hash	882	optionally change it. All option values are stored by name in the hash
…		…
731	my ($self, $name) = (shift, shift);	932	my ($self, $name) = (shift, shift);
732	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	933	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
733	&urxvt::term::_resource	934	&urxvt::term::_resource
734	}	935	}
735		936
		937	=item $value = $term->x_resource ($pattern)
		938
		939	Returns the X-Resource for the given pattern, excluding the program or
		940	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		941	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		942	resource with that pattern exists.
		943
		944	This method should only be called during the C<on_start> hook, as there is
		945	only one resource database per display, and later invocations might return
		946	the wrong resources.
		947
		948	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		949
		950	Adds a keymap translation exactly as specified via a resource. See the
		951	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		952
736	=item $rend = $term->rstyle ([$new_rstyle])	953	=item $rend = $term->rstyle ([$new_rstyle])
737		954
738	Return and optionally change the current rendition. Text that is output by	955	Return and optionally change the current rendition. Text that is output by
739	the terminal application will use this style.	956	the terminal application will use this style.
740		957
…		…
750	=item ($row, $col) = $term->selection_end ([$row, $col])	967	=item ($row, $col) = $term->selection_end ([$row, $col])
751		968
752	Return the current values of the selection mark, begin or end positions,	969	Return the current values of the selection mark, begin or end positions,
753	and optionally set them to new values.	970	and optionally set them to new values.
754		971
		972	=item $term->selection_make ($eventtime[, $rectangular])
		973
		974	Tries to make a selection as set by C<selection_beg> and
		975	C<selection_end>. If C<$rectangular> is true (default: false), a
		976	rectangular selection will be made. This is the prefered function to make
		977	a selection.
		978
755	=item $success = $term->selection_grab ($eventtime)	979	=item $success = $term->selection_grab ($eventtime)
756		980
757	Try to request the primary selection from the server (for example, as set	981	Try to request the primary selection text from the server (for example, as
758	by the next method).	982	set by the next method). No visual feedback will be given. This function
		983	is mostly useful from within C<on_sel_grab> hooks.
759		984
760	=item $oldtext = $term->selection ([$newtext])	985	=item $oldtext = $term->selection ([$newtext])
761		986
762	Return the current selection text and optionally replace it by C<$newtext>.	987	Return the current selection text and optionally replace it by C<$newtext>.
763		988
764	#=item $term->overlay ($x, $y, $text)	989	=item $term->overlay_simple ($x, $y, $text)
765	#	990
766	#Create a simple multi-line overlay box. See the next method for details.	991	Create a simple multi-line overlay box. See the next method for details.
767	#	992
768	#=cut	993	=cut
769	#	994
770	#sub urxvt::term::scr_overlay {	995	sub overlay_simple {
771	# my ($self, $x, $y, $text) = @_;	996	my ($self, $x, $y, $text) = @_;
772	#	997
773	# my @lines = split /\n/, $text;	998	my @lines = split /\n/, $text;
774	#	999
775	# my $w = 0;	1000	my $w = List::Util::max map $self->strwidth ($_), @lines;
776	# for (map $self->strwidth ($_), @lines) {	1001
777	# $w = $_ if $w < $_;
778	# }
779	#
780	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1002	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
781	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1003	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
782	#}	1004
		1005	$overlay
		1006	}
783		1007
784	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1008	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
785		1009
786	Create a new (empty) overlay at the given position with the given	1010	Create a new (empty) overlay at the given position with the given
787	width/height. C<$rstyle> defines the initial rendition style	1011	width/height. C<$rstyle> defines the initial rendition style
…		…
854		1078
855	=item $string = $term->locale_decode ($octets)	1079	=item $string = $term->locale_decode ($octets)
856		1080
857	Convert the given locale-encoded octets into a perl string.	1081	Convert the given locale-encoded octets into a perl string.
858		1082
		1083	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1084
		1085	XORs the rendition values in the given span with the provided value
		1086	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1087	refresh hooks to provide effects similar to the selection.
		1088
		1089	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1090
		1091	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1092	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1093	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1094	it instead. Both styles I<MUST NOT> contain font styles.
		1095
		1096	=item $term->scr_bell
		1097
		1098	Ring the bell!
		1099
859	=item $term->scr_add_lines ($string)	1100	=item $term->scr_add_lines ($string)
860		1101
861	Write the given text string to the screen, as if output by the application	1102	Write the given text string to the screen, as if output by the application
862	running inside the terminal. It may not contain command sequences (escape	1103	running inside the terminal. It may not contain command sequences (escape
863	codes), but is free to use line feeds, carriage returns and tabs. The	1104	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
877		1118
878	Write the octets given in C<$data> to the tty (i.e. as program input). To	1119	Write the octets given in C<$data> to the tty (i.e. as program input). To
879	pass characters instead of octets, you should convert your strings first	1120	pass characters instead of octets, you should convert your strings first
880	to the locale-specific encoding using C<< $term->locale_encode >>.	1121	to the locale-specific encoding using C<< $term->locale_encode >>.
881		1122
		1123	=item $old_events = $term->pty_ev_events ([$new_events])
		1124
		1125	Replaces the event mask of the pty watcher by the given event mask. Can
		1126	be used to suppress input and output handling to the pty/tty. See the
		1127	description of C<< urxvt::timer->events >>. Make sure to always restore
		1128	the previous value.
		1129
882	=item $windowid = $term->parent	1130	=item $windowid = $term->parent
883		1131
884	Return the window id of the toplevel window.	1132	Return the window id of the toplevel window.
885		1133
886	=item $windowid = $term->vt	1134	=item $windowid = $term->vt
…		…
910	=item $nrow_plus_saveLines = $term->total_rows	1158	=item $nrow_plus_saveLines = $term->total_rows
911		1159
912	=item $lines_in_scrollback = $term->nsaved	1160	=item $lines_in_scrollback = $term->nsaved
913		1161
914	Return various integers describing terminal characteristics.	1162	Return various integers describing terminal characteristics.
		1163
		1164	=item $x_display = $term->display_id
		1165
		1166	Return the DISPLAY used by rxvt-unicode.
		1167
		1168	=item $lc_ctype = $term->locale
		1169
		1170	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1171
		1172	=item $env = $term->env
		1173
		1174	Returns a copy of the environment in effect for the terminal as a hashref
		1175	similar to C<\%ENV>.
		1176
		1177	=cut
		1178
		1179	sub env {
		1180	if (my $env = $_[0]->_env) {
		1181	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1182	} else {
		1183	+{ %ENV }
		1184	}
		1185	}
915		1186
916	=item $modifiermask = $term->ModLevel3Mask	1187	=item $modifiermask = $term->ModLevel3Mask
917		1188
918	=item $modifiermask = $term->ModMetaMask	1189	=item $modifiermask = $term->ModMetaMask
919		1190
…		…
1012	Return the row number of the first/last row of the line, respectively.	1283	Return the row number of the first/last row of the line, respectively.
1013		1284
1014	=item $offset = $line->offset_of ($row, $col)	1285	=item $offset = $line->offset_of ($row, $col)
1015		1286
1016	Returns the character offset of the given row\|col pair within the logical	1287	Returns the character offset of the given row\|col pair within the logical
1017	line.	1288	line. Works for rows outside the line, too, and returns corresponding
		1289	offsets outside the string.
1018		1290
1019	=item ($row, $col) = $line->coord_of ($offset)	1291	=item ($row, $col) = $line->coord_of ($offset)
1020		1292
1021	Translates a string offset into terminal coordinates again.	1293	Translates a string offset into terminal coordinates again.
1022		1294
…		…
1109	Converts rxvt-unicodes text reprsentation into a perl string. See	1381	Converts rxvt-unicodes text reprsentation into a perl string. See
1110	C<< $term->ROW_t >> for details.	1382	C<< $term->ROW_t >> for details.
1111		1383
1112	=item $success = $term->grab_button ($button, $modifiermask)	1384	=item $success = $term->grab_button ($button, $modifiermask)
1113		1385
1114	Registers a synchronous button grab. See XGrabButton.	1386	Registers a synchronous button grab. See the XGrabButton manpage.
1115		1387
1116	=item $success = $term->grab ($eventtime[, $sync])	1388	=item $success = $term->grab ($eventtime[, $sync])
1117		1389
1118	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1390	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1119	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1391	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1159	$item->{render} \|\|= sub { $_[0]{text} };	1431	$item->{render} \|\|= sub { $_[0]{text} };
1160		1432
1161	push @{ $self->{item} }, $item;	1433	push @{ $self->{item} }, $item;
1162	}	1434	}
1163		1435
1164	sub add_separator {	1436	=item $popup->add_title ($title)
1165	my ($self, $sep) = @_;
1166		1437
1167	$sep \|\|= "═";	1438	Adds a non-clickable title to the popup.
1168		1439
1169	$self->add_item ({	1440	=cut
1170	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1171	text => "",
1172	render => sub { $sep x $urxvt::TERM->ncol },
1173	activate => sub { },
1174	});
1175	}
1176		1441
1177	sub add_title {	1442	sub add_title {
1178	my ($self, $title) = @_;	1443	my ($self, $title) = @_;
1179		1444
1180	$self->add_item ({	1445	$self->add_item ({
…		…
1182	text => $title,	1447	text => $title,
1183	activate => sub { },	1448	activate => sub { },
1184	});	1449	});
1185	}	1450	}
1186		1451
		1452	=item $popup->add_separator ([$sepchr])
		1453
		1454	Creates a separator, optionally using the character given as C<$sepchr>.
		1455
		1456	=cut
		1457
		1458	sub add_separator {
		1459	my ($self, $sep) = @_;
		1460
		1461	$sep \|\|= "=";
		1462
		1463	$self->add_item ({
		1464	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1465	text => "",
		1466	render => sub { $sep x $self->{term}->ncol },
		1467	activate => sub { },
		1468	});
		1469	}
		1470
		1471	=item $popup->add_button ($text, $cb)
		1472
		1473	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1474	selected.
		1475
		1476	=cut
		1477
1187	sub add_button {	1478	sub add_button {
1188	my ($self, $text, $cb) = @_;	1479	my ($self, $text, $cb) = @_;
1189		1480
1190	$self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});	1481	$self->add_item ({ type => "button", text => $text, activate => $cb});
1191	}	1482	}
		1483
		1484	=item $popup->add_toggle ($text, $cb, $initial_value)
		1485
		1486	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1487	whenever it gets toggled, with a boolean indicating its value as its first
		1488	argument.
		1489
		1490	=cut
1192		1491
1193	sub add_toggle {	1492	sub add_toggle {
1194	my ($self, $text, $cb, $value) = @_;	1493	my ($self, $text, $cb, $value) = @_;
1195		1494
1196	my $item; $item = {	1495	my $item; $item = {
1197	type => "button",	1496	type => "button",
1198	text => " $text",	1497	text => " $text",
1199	value => $value,	1498	value => $value,
1200	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1499	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1201	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1500	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1202	};	1501	};
1203		1502
1204	$self->add_item ($item);	1503	$self->add_item ($item);
1205	}	1504	}
		1505
		1506	=item $popup->show
		1507
		1508	Displays the popup (which is initially hidden).
		1509
		1510	=cut
1206		1511
1207	sub show {	1512	sub show {
1208	my ($self) = @_;	1513	my ($self) = @_;
1209		1514
1210	local $urxvt::popup::self = $self;	1515	local $urxvt::popup::self = $self;
1211		1516
		1517	my $env = $self->{term}->env;
		1518	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1519	delete $env->{LC_ALL};
		1520	$env->{LC_CTYPE} = $self->{term}->locale;
		1521
		1522	urxvt::term->new ($env, $self->{term}->resource ("name"),
1212	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1523	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1213	"--transient-for" => $self->{term}->parent,	1524	"--transient-for" => $self->{term}->parent,
		1525	"-display" => $self->{term}->display_id,
1214	"-pe" => "urxvt-popup")	1526	"-pe" => "urxvt-popup")
1215	or die "unable to create popup window\n";	1527	or die "unable to create popup window\n";
1216	}	1528	}
1217		1529
1218	sub DESTROY {	1530	sub DESTROY {
1219	my ($self) = @_;	1531	my ($self) = @_;
1220		1532
1221	delete $self->{term}{_destroy}{$self};	1533	delete $self->{term}{_destroy}{$self};
1222	$self->{term}->ungrab;	1534	$self->{term}->ungrab;
1223	}	1535	}
		1536
		1537	=back
1224		1538
1225	=head2 The C<urxvt::timer> Class	1539	=head2 The C<urxvt::timer> Class
1226		1540
1227	This class implements timer watchers/events. Time is represented as a	1541	This class implements timer watchers/events. Time is represented as a
1228	fractional number of seconds since the epoch. Example:	1542	fractional number of seconds since the epoch. Example:
…		…
1281		1595
1282	$term->{socket} = ...	1596	$term->{socket} = ...
1283	$term->{iow} = urxvt::iow	1597	$term->{iow} = urxvt::iow
1284	->new	1598	->new
1285	->fd (fileno $term->{socket})	1599	->fd (fileno $term->{socket})
1286	->events (1) # wait for read data	1600	->events (urxvt::EVENT_READ)
1287	->start	1601	->start
1288	->cb (sub {	1602	->cb (sub {
1289	my ($iow, $revents) = @_;	1603	my ($iow, $revents) = @_;
1290	# $revents must be 1 here, no need to check	1604	# $revents must be 1 here, no need to check
1291	sysread $term->{socket}, my $buf, 8192	1605	sysread $term->{socket}, my $buf, 8192
…		…
1308		1622
1309	Set the filedescriptor (not handle) to watch.	1623	Set the filedescriptor (not handle) to watch.
1310		1624
1311	=item $iow = $iow->events ($eventmask)	1625	=item $iow = $iow->events ($eventmask)
1312		1626
1313	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1627	Set the event mask to watch. The only allowed values are
1314	data, Bit #1 (value C<2>) enables watching for write data.	1628	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1629	together, or C<urxvt::EVENT_NONE>.
1315		1630
1316	=item $iow = $iow->start	1631	=item $iow = $iow->start
1317		1632
1318	Start watching for requested events on the given handle.	1633	Start watching for requested events on the given handle.
1319		1634
…		…
1334		1649
1335	=item == 0 - fatal messages	1650	=item == 0 - fatal messages
1336		1651
1337	=item >= 3 - script loading and management	1652	=item >= 3 - script loading and management
1338		1653
1339	=item >=10 - all events received	1654	=item >=10 - all called hooks
		1655
		1656	=item >=11 - hook reutrn values
1340		1657
1341	=back	1658	=back
1342		1659
1343	=head1 AUTHOR	1660	=head1 AUTHOR
1344		1661

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs. Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.61 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC