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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.67 by root, Mon Jan 9 19:29:06 2006 UTC vs. Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.67 by root, Mon Jan 9 19:29:06 2006 UTC vs.
Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC