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

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.89 by root, Thu Jan 12 12:10:06 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.89 by root, Thu Jan 12 12:10:06 2006 UTC