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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC vs.
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC

…		…
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection
43		43
44	Intelligent selection. This etxension tries to be more intelligent when the user	44	Intelligent selection. This extension tries to be more intelligent when
45	extends selections (double-click).	45	the user extends selections (double-click). Right now, it tries to select
		46	urls and complete shell-quoted arguments, which is very convenient, too,
		47	if your F<ls> supports C<--quoting-style=shell>.
46		48
47	It also offers the following bindable event:	49	It also offers the following bindable event:
48		50
49	=over 4	51	=over 4
50		52
…		…
57	=back	59	=back
58		60
59	=item digital-clock	61	=item digital-clock
60		62
61	Displays a digital clock using the built-in overlay.	63	Displays a digital clock using the built-in overlay.
		64
		65	=item mark-urls
		66
		67	Uses per-line filtering (C<on_line_update>) to underline urls.
62		68
63	=item example-refresh-hooks	69	=item example-refresh-hooks
64		70
65	Displays a very simple digital clock in the upper right corner of the	71	Displays a very simple digital clock in the upper right corner of the
66	window. Illustrates overwriting the refresh callbacks to create your own	72	window. Illustrates overwriting the refresh callbacks to create your own
67	overlays or changes.	73	overlays or changes.
		74
		75	=item example-filter-input
		76
		77	A not very useful example of filtering all text output to the terminal, by
		78	underlining all urls that matches a certain regex (i.e. some urls :). It
		79	is not very useful because urls that are output in multiple steps (e.g.
		80	when typing them) do not get marked.
68		81
69	=back	82	=back
70		83
71	=head2 General API Considerations	84	=head2 General API Considerations
72		85
…		…
79	When objects are destroyed on the C++ side, the perl object hashes are	92	When objects are destroyed on the C++ side, the perl object hashes are
80	emptied, so its best to store related objects such as time watchers and	93	emptied, so its best to store related objects such as time watchers and
81	the like inside the terminal object so they get destroyed as soon as the	94	the like inside the terminal object so they get destroyed as soon as the
82	terminal is destroyed.	95	terminal is destroyed.
83		96
		97	Argument names also often indicate the type of a parameter. Here are some
		98	hints on what they mean:
		99
		100	=over 4
		101
		102	=item $text
		103
		104	Rxvt-unicodes special way of encoding text, where one "unicode" character
		105	always represents one screen cell. See L<row_t> for a discussion of this format.
		106
		107	=item $string
		108
		109	A perl text string, with an emphasis on I<text>. It can store all unicode
		110	characters and is to be distinguished with text encoded in a specific
		111	encoding (often locale-specific) and binary data.
		112
		113	=item $octets
		114
		115	Either binary data or - more common - a text string encoded in a
		116	locale-specific way.
		117
		118	=back
		119
84	=head2 Hooks	120	=head2 Hooks
85		121
86	The following subroutines can be declared in loaded scripts, and will be	122	The following subroutines can be declared in loaded scripts, and will be
87	called whenever the relevant event happens.	123	called whenever the relevant event happens.
88		124
…		…
169	number of lines that will be in the scrollback buffer.	205	number of lines that will be in the scrollback buffer.
170		206
171	=item on_tty_activity $term NYI	207	=item on_tty_activity $term NYI
172		208
173	Called whenever the program(s) running in the urxvt window send output.	209	Called whenever the program(s) running in the urxvt window send output.
		210
		211	=item on_osc_seq $term, $string
		212
		213	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		214	operating system command) is processed. Cursor position and other state
		215	information is up-to-date when this happens. For interoperability, the
		216	string should start with the extension name and a colon, to distinguish
		217	it from commands for other extensions, and this might be enforced in the
		218	future.
		219
		220	Be careful not ever to trust (in a security sense) the data you receive,
		221	as its source can not easily be controleld (e-mail content, messages from
		222	other users on the same system etc.).
		223
		224	=item on_add_lines $term, $string
		225
		226	Called whenever text is about to be output, with the text as argument. You
		227	can filter/change and output the text yourself by returning a true value
		228	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		229	might be very slow, however, as your hook is called for B<all> text being
		230	output.
		231
		232	=item on_line_update $term, $row
		233
		234	Called whenever a line was updated or changed. Can be used to filter
		235	screen output (e.g. underline urls or other useless stuff). Only lines
		236	that are being shown will be filtered, and, due to performance reasons,
		237	not always immediately.
		238
		239	The row number is always the topmost row of the line if the line spans
		240	multiple rows.
		241
		242	Please note that, if you change the line, then the hook might get called
		243	later with the already-modified line (e.g. if unrelated parts change), so
		244	you cannot just toggle rendition bits, but only set them.
174		245
175	=item on_refresh_begin $term	246	=item on_refresh_begin $term
176		247
177	Called just before the screen gets redrawn. Can be used for overlay	248	Called just before the screen gets redrawn. Can be used for overlay
178	or similar effects by modify terminal contents in refresh_begin, and	249	or similar effects by modify terminal contents in refresh_begin, and
…		…
351		422
352	$pkg	423	$pkg
353	}	424	}
354	}	425	}
355		426
		427	our $retval; # return value for urxvt
		428
356	# called by the rxvt core	429	# called by the rxvt core
357	sub invoke {	430	sub invoke {
358	local $TERM = shift;	431	local $TERM = shift;
359	my $htype = shift;	432	my $htype = shift;
360		433
361	if ($htype == 0) { # INIT	434	if ($htype == 0) { # INIT
362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	435	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
363		436
364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	437	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
365	my @files = grep -f $_, map "$_/$ext", @dirs;	438	my @files = grep -f $_, map "$_/$ext", @dirs;
366		439
367	if (@files) {	440	if (@files) {
368	register_package script_package $files[0];	441	register_package script_package $files[0];
369	} else {	442	} else {
370	warn "perl extension '$ext' not found in perl library search path\n";	443	warn "perl extension '$ext' not found in perl library search path\n";
371	}	444	}
372	}	445	}
		446	}
373		447
		448	$retval = undef;
		449
		450	if (my $cb = $TERM->{_hook}[$htype]) {
		451	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		452	if $verbosity >= 10;
		453
		454	keys %$cb;
		455
		456	while (my ($pkg, $cb) = each %$cb) {
		457	$retval = $cb->(
		458	$TERM->{_pkg}{$pkg} \|\|= do {
		459	my $proxy = bless { }, urxvt::term::proxy::;
		460	Scalar::Util::weaken ($proxy->{term} = $TERM);
		461	$proxy
		462	},
		463	@_,
		464	) and last;
		465	}
		466	}
		467
374	} elsif ($htype == 1) { # DESTROY	468	if ($htype == 1) { # DESTROY
		469	# remove hooks if unused
375	if (my $hook = $TERM->{_hook}) {	470	if (my $hook = $TERM->{_hook}) {
376	for my $htype (0..$#$hook) {	471	for my $htype (0..$#$hook) {
377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	472	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
378	or set_should_invoke $htype, 0;	473	or set_should_invoke $htype, 0;
379	}	474	}
380	}	475	}
		476
		477	# clear package objects
		478	%$_ = () for values %{ $TERM->{_pkg} };
		479
		480	# clear package
		481	%$TERM = ();
381	}	482	}
382		483
383	my $cb = $TERM->{_hook}[$htype]	484	$retval
384	or return;
385
386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
387	if $verbosity >= 10;
388
389	keys %$cb;
390
391	while (my ($pkg, $cb) = each %$cb) {
392	return 1
393	if $cb->(
394	$TERM->{$pkg} \|\|= do {
395	my $proxy = bless { }, urxvt::term::proxy::;
396	Scalar::Util::weaken ($proxy->{term} = $TERM);
397	$proxy
398	},
399	@_,
400	);
401	}
402
403	0
404	}	485	}
405		486
406	sub urxvt::term::proxy::AUTOLOAD {	487	sub urxvt::term::proxy::AUTOLOAD {
407	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	488	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
408	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	489	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
…		…
446	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	527	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447	borderLess color cursorBlink cursorUnderline cutchars delete_key	528	borderLess color cursorBlink cursorUnderline cutchars delete_key
448	display_name embed ext_bwidth fade font geometry hold iconName	529	display_name embed ext_bwidth fade font geometry hold iconName
449	imFont imLocale inputMethod insecure int_bwidth intensityStyles	530	imFont imLocale inputMethod insecure int_bwidth intensityStyles
450	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	531	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
451	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	532	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
452	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	533	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
453	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	534	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
454	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	535	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
455	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	536	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
456	shade term_name title transparent transparent_all tripleclickwords	537	shade term_name title transparent transparent_all tripleclickwords
…		…
462	my ($self, $name) = (shift, shift);	543	my ($self, $name) = (shift, shift);
463	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	544	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
464	goto &urxvt::term::_resource;	545	goto &urxvt::term::_resource;
465	}	546	}
466		547
		548	=item $rend = $term->rstyle ([$new_rstyle])
		549
		550	Return and optionally change the current rendition. Text that is output by
		551	the terminal application will use this style.
		552
		553	=item ($row, $col) = $term->screen_cur ([$row, $col])
		554
		555	Return the current coordinates of the text cursor position and optionally
		556	set it (which is usually bad as applications don't expect that).
		557
467	=item ($row, $col) = $term->selection_mark ([$row, $col])	558	=item ($row, $col) = $term->selection_mark ([$row, $col])
468		559
469	=item ($row, $col) = $term->selection_beg ([$row, $col])	560	=item ($row, $col) = $term->selection_beg ([$row, $col])
470		561
471	=item ($row, $col) = $term->selection_end ([$row, $col])	562	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
485	#=item $term->overlay ($x, $y, $text)	576	#=item $term->overlay ($x, $y, $text)
486	#	577	#
487	#Create a simple multi-line overlay box. See the next method for details.	578	#Create a simple multi-line overlay box. See the next method for details.
488	#	579	#
489	#=cut	580	#=cut
490		581	#
491	sub urxvt::term::scr_overlay {	582	#sub urxvt::term::scr_overlay {
492	die;
493	my ($self, $x, $y, $text) = @_;	583	# my ($self, $x, $y, $text) = @_;
494		584	#
495	my @lines = split /\n/, $text;	585	# my @lines = split /\n/, $text;
496		586	#
497	my $w = 0;	587	# my $w = 0;
498	for (map $self->strwidth ($_), @lines) {	588	# for (map $self->strwidth ($_), @lines) {
499	$w = $_ if $w < $_;	589	# $w = $_ if $w < $_;
500	}	590	# }
501		591	#
502	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	592	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
503	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	593	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
504	}	594	#}
505		595
506	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	596	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
507		597
508	Create a new (empty) overlay at the given position with the given	598	Create a new (empty) overlay at the given position with the given
509	width/height. C<$rstyle> defines the initial rendition style	599	width/height. C<$rstyle> defines the initial rendition style
…		…
549		639
550	=item $string = $term->locale_decode $octets	640	=item $string = $term->locale_decode $octets
551		641
552	Convert the given locale-encoded octets into a perl string.	642	Convert the given locale-encoded octets into a perl string.
553		643
		644	=item $term->scr_add_lines ($string)
		645
		646	Write the given text string to the screen, as if output by the application
		647	running inside the terminal. It may not contain command sequences (escape
		648	codes), but is free to use line feeds, carriage returns and tabs. The
		649	string is a normal text string, not in locale-dependent encoding.
		650
		651	Normally its not a good idea to use this function, as programs might be
		652	confused by changes in cursor position or scrolling. Its useful inside a
		653	C<on_add_lines> hook, though.
		654
554	=item $term->tt_write ($octets)	655	=item $term->tt_write ($octets)
555		656
556	Write the octets given in C<$data> to the tty (i.e. as program input). To	657	Write the octets given in C<$data> to the tty (i.e. as program input). To
557	pass characters instead of octets, you should convert your strings first	658	pass characters instead of octets, you should convert your strings first
558	to the locale-specific encoding using C<< $term->locale_encode >>.	659	to the locale-specific encoding using C<< $term->locale_encode >>.
559		660
		661	=item $window_width = $term->width
		662
		663	=item $window_height = $term->height
		664
		665	=item $font_width = $term->fwidth
		666
		667	=item $font_height = $term->fheight
		668
		669	=item $font_ascent = $term->fbase
		670
560	=item $nrow = $term->nrow	671	=item $terminal_rows = $term->nrow
561		672
562	=item $ncol = $term->ncol	673	=item $terminal_columns = $term->ncol
563		674
564	Return the number of rows/columns of the terminal window (i.e. as	675	=item $has_focus = $term->focus
565	specified by C<-geometry>, excluding any scrollback).
566		676
567	=item $nsaved = $term->nsaved	677	=item $is_mapped = $term->mapped
568		678
569	Returns the number of lines in the scrollback buffer.	679	=item $max_scrollback = $term->saveLines
		680
		681	=item $nrow_plus_saveLines = $term->total_rows
		682
		683	=item $lines_in_scrollback = $term->nsaved
		684
		685	Return various integers describing terminal characteristics.
570		686
571	=item $view_start = $term->view_start ([$newvalue])	687	=item $view_start = $term->view_start ([$newvalue])
572		688
573	Returns the negative row number of the topmost line. Minimum value is	689	Returns the negative row number of the topmost line. Minimum value is
574	C<0>, which displays the normal terminal contents. Larger values scroll	690	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
637	about the logical line that row C<$row_number> is part of. It supports the	753	about the logical line that row C<$row_number> is part of. It supports the
638	following methods:	754	following methods:
639		755
640	=over 4	756	=over 4
641		757
642	=item $text = $line->t	758	=item $text = $line->t ([$new_text])
643		759
644	Returns the full text of the line, similar to C<ROW_t>	760	Returns or replaces the full text of the line, similar to C<ROW_t>
645		761
646	=item $rend = $line->r	762	=item $rend = $line->r ([$new_rend])
647		763
648	Returns the full rendition array of the line, similar to C<ROW_r>	764	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
649		765
650	=item $length = $line->l	766	=item $length = $line->l
651		767
652	Returns the length of the line in cells, similar to C<ROW_l>.	768	Returns the length of the line in cells, similar to C<ROW_l>.
653		769
…		…
682		798
683	bless {	799	bless {
684	term => $self,	800	term => $self,
685	beg => $beg,	801	beg => $beg,
686	end => $end,	802	end => $end,
		803	ncol => $self->ncol,
687	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	804	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
688	}, urxvt::line::	805	}, urxvt::line::
689	}	806	}
690		807
691	sub urxvt::line::t {	808	sub urxvt::line::t {
692	my ($self) = @_;	809	my ($self) = @_;
693		810
		811	if (@_ > 1)
		812	{
		813	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		814	for $self->{beg} .. $self->{end};
		815	}
		816
		817	defined wantarray &&
694	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	818	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
695	0, $self->{len}	819	0, $self->{len}
696	}	820	}
697		821
698	sub urxvt::line::r {	822	sub urxvt::line::r {
699	my ($self) = @_;	823	my ($self) = @_;
700		824
		825	if (@_ > 1)
		826	{
		827	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		828	for $self->{beg} .. $self->{end};
		829	}
		830
		831	if (defined wantarray) {
701	my $rend = [	832	my $rend = [
702	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	833	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
703	];	834	];
704	$#$rend = $self->{len} - 1;	835	$#$rend = $self->{len} - 1;
705	$rend	836	return $rend;
		837	}
		838
		839	()
706	}	840	}
707		841
708	sub urxvt::line::beg { $_[0]{beg} }	842	sub urxvt::line::beg { $_[0]{beg} }
709	sub urxvt::line::end { $_[0]{end} }	843	sub urxvt::line::end { $_[0]{end} }
710	sub urxvt::line::l { $_[0]{len} }	844	sub urxvt::line::l { $_[0]{len} }
711		845
712	sub urxvt::line::offset_of {	846	sub urxvt::line::offset_of {
713	my ($self, $row, $col) = @_;	847	my ($self, $row, $col) = @_;
714		848
715	($row - $self->{beg}) * $self->{term}->ncol + $col	849	($row - $self->{beg}) * $self->{ncol} + $col
716	}	850	}
717		851
718	sub urxvt::line::coord_of {	852	sub urxvt::line::coord_of {
719	my ($self, $offset) = @_;	853	my ($self, $offset) = @_;
720		854
721	use integer;	855	use integer;
722		856
723	(	857	(
724	$offset / $self->{term}->ncol + $self->{beg},	858	$offset / $self->{ncol} + $self->{beg},
725	$offset % $self->{term}->ncol	859	$offset % $self->{ncol}
726	)	860	)
727	}	861	}
728		862
729	=item ($row, $col) = $line->coord_of ($offset)	863	=item ($row, $col) = $line->coord_of ($offset)
730	=item $text = $term->special_encode $string	864	=item $text = $term->special_encode $string
…		…
848	This variable controls the verbosity level of the perl extension. Higher	982	This variable controls the verbosity level of the perl extension. Higher
849	numbers indicate more verbose output.	983	numbers indicate more verbose output.
850		984
851	=over 4	985	=over 4
852		986
853	=item 0 - only fatal messages	987	=item =0 - only fatal messages
854		988
855	=item 3 - script loading and management	989	=item =3 - script loading and management
856		990
857	=item 10 - all events received	991	=item =10 - all events received
858		992
859	=back	993	=back
860		994
861	=head1 AUTHOR	995	=head1 AUTHOR
862		996

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC vs. Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC vs.
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC