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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.23 by root, Tue Jan 3 19:42:53 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	while (my ($pkg, $cb) = each %$cb) {
390	return 1
391	if $cb->(
392	$TERM->{$pkg} \|\|= do {
393	my $proxy = bless { }, urxvt::term::proxy::;
394	Scalar::Util::weaken ($proxy->{term} = $TERM);
395	$proxy
396	},
397	@_,
398	);
399	}
400
401	0
402	}	485	}
403		486
404	sub urxvt::term::proxy::AUTOLOAD {	487	sub urxvt::term::proxy::AUTOLOAD {
405	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	488	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
406	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	489	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
407		490
408	eval qq{	491	eval qq{
409	sub $urxvt::term::proxy::AUTOLOAD {	492	sub $urxvt::term::proxy::AUTOLOAD {
410	unshift \@_, shift->{term};	493	my \$proxy = shift;
411	goto &urxvt::term::$1;	494	\$proxy->{term}->$1 (\@_)
412	}	495	}
413	1	496	1
414	} or die "FATAL: unable to compile method forwarder: $@";	497	} or die "FATAL: unable to compile method forwarder: $@";
415		498
416	goto &$urxvt::term::proxy::AUTOLOAD;	499	goto &$urxvt::term::proxy::AUTOLOAD;
…		…
444	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	527	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
445	borderLess color cursorBlink cursorUnderline cutchars delete_key	528	borderLess color cursorBlink cursorUnderline cutchars delete_key
446	display_name embed ext_bwidth fade font geometry hold iconName	529	display_name embed ext_bwidth fade font geometry hold iconName
447	imFont imLocale inputMethod insecure int_bwidth intensityStyles	530	imFont imLocale inputMethod insecure int_bwidth intensityStyles
448	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	531	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
449	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	532	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
450	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	533	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
451	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	534	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
452	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	535	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
453	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	536	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
454	shade term_name title transparent transparent_all tripleclickwords	537	shade term_name title transparent transparent_all tripleclickwords
…		…
460	my ($self, $name) = (shift, shift);	543	my ($self, $name) = (shift, shift);
461	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	544	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
462	goto &urxvt::term::_resource;	545	goto &urxvt::term::_resource;
463	}	546	}
464		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
465	=item ($row, $col) = $term->selection_mark ([$row, $col])	558	=item ($row, $col) = $term->selection_mark ([$row, $col])
466		559
467	=item ($row, $col) = $term->selection_beg ([$row, $col])	560	=item ($row, $col) = $term->selection_beg ([$row, $col])
468		561
469	=item ($row, $col) = $term->selection_end ([$row, $col])	562	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
483	#=item $term->overlay ($x, $y, $text)	576	#=item $term->overlay ($x, $y, $text)
484	#	577	#
485	#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.
486	#	579	#
487	#=cut	580	#=cut
488		581	#
489	sub urxvt::term::scr_overlay {	582	#sub urxvt::term::scr_overlay {
490	die;
491	my ($self, $x, $y, $text) = @_;	583	# my ($self, $x, $y, $text) = @_;
492		584	#
493	my @lines = split /\n/, $text;	585	# my @lines = split /\n/, $text;
494		586	#
495	my $w = 0;	587	# my $w = 0;
496	for (map $self->strwidth ($_), @lines) {	588	# for (map $self->strwidth ($_), @lines) {
497	$w = $_ if $w < $_;	589	# $w = $_ if $w < $_;
498	}	590	# }
499		591	#
500	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	592	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
501	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	593	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
502	}	594	#}
503		595
504	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	596	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
505		597
506	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
507	width/height. C<$rstyle> defines the initial rendition style	599	width/height. C<$rstyle> defines the initial rendition style
…		…
547		639
548	=item $string = $term->locale_decode $octets	640	=item $string = $term->locale_decode $octets
549		641
550	Convert the given locale-encoded octets into a perl string.	642	Convert the given locale-encoded octets into a perl string.
551		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
552	=item $term->tt_write ($octets)	655	=item $term->tt_write ($octets)
553		656
554	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
555	pass characters instead of octets, you should convert your strings first	658	pass characters instead of octets, you should convert your strings first
556	to the locale-specific encoding using C<< $term->locale_encode >>.	659	to the locale-specific encoding using C<< $term->locale_encode >>.
557		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
558	=item $nrow = $term->nrow	671	=item $terminal_rows = $term->nrow
559		672
560	=item $ncol = $term->ncol	673	=item $terminal_columns = $term->ncol
561		674
562	Return the number of rows/columns of the terminal window (i.e. as	675	=item $has_focus = $term->focus
563	specified by C<-geometry>, excluding any scrollback).
564		676
565	=item $nsaved = $term->nsaved	677	=item $is_mapped = $term->mapped
566		678
567	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.
568		686
569	=item $view_start = $term->view_start ([$newvalue])	687	=item $view_start = $term->view_start ([$newvalue])
570		688
571	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
572	C<0>, which displays the normal terminal contents. Larger values scroll	690	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
583	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	701	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
584		702
585	Returns the text of the entire row with number C<$row_number>. Row C<0>	703	Returns the text of the entire row with number C<$row_number>. Row C<0>
586	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	704	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
587	terminal line. The scrollback buffer starts at line C<-1> and extends to	705	terminal line. The scrollback buffer starts at line C<-1> and extends to
588	line C<< -$term->nsaved >>.	706	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		707	is requested.
589		708
590	If C<$new_text> is specified, it will replace characters in the current	709	If C<$new_text> is specified, it will replace characters in the current
591	line, starting at column C<$start_col> (default C<0>), which is useful	710	line, starting at column C<$start_col> (default C<0>), which is useful
592	to replace only parts of a line. The font index in the rendition will	711	to replace only parts of a line. The font index in the rendition will
593	automatically be updated.	712	automatically be updated.
…		…
615		734
616	See the section on RENDITION, above.	735	See the section on RENDITION, above.
617		736
618	=item $length = $term->ROW_l ($row_number[, $new_length])	737	=item $length = $term->ROW_l ($row_number[, $new_length])
619		738
620	Returns the number of screen cells that are in use ("the line length"). If	739	Returns the number of screen cells that are in use ("the line
621	it is C<-1>, then the line is part of a multiple-row logical "line", which	740	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
622	means all characters are in use and it is continued on the next row.	741	line is joined with the following one.
623		742
		743	=item $bool = $term->is_longer ($row_number)
		744
		745	Returns true if the row is part of a multiple-row logical "line" (i.e.
		746	joined with the following row), which means all characters are in use
		747	and it is continued on the next row (and possibly a continuation of the
		748	previous row(s)).
		749
		750	=item $line = $term->line ($row_number)
		751
		752	Create and return a new C<urxvt::line> object that stores information
		753	about the logical line that row C<$row_number> is part of. It supports the
		754	following methods:
		755
		756	=over 4
		757
		758	=item $text = $line->t ([$new_text])
		759
		760	Returns or replaces the full text of the line, similar to C<ROW_t>
		761
		762	=item $rend = $line->r ([$new_rend])
		763
		764	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		765
		766	=item $length = $line->l
		767
		768	Returns the length of the line in cells, similar to C<ROW_l>.
		769
		770	=item $rownum = $line->beg
		771
		772	=item $rownum = $line->end
		773
		774	Return the row number of the first/last row of the line, respectively.
		775
		776	=item $offset = $line->offset_of ($row, $col)
		777
		778	Returns the character offset of the given row\|col pair within the logical
		779	line.
		780
		781	=item ($row, $col) = $line->coord_of ($offset)
		782
		783	Translates a string offset into terminal coordinates again.
		784
		785	=back
		786
		787	=cut
		788
		789	sub urxvt::term::line {
		790	my ($self, $row) = @_;
		791
		792	my $maxrow = $self->nrow - 1;
		793
		794	my ($beg, $end) = ($row, $row);
		795
		796	--$beg while $self->ROW_is_longer ($beg - 1);
		797	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		798
		799	bless {
		800	term => $self,
		801	beg => $beg,
		802	end => $end,
		803	ncol => $self->ncol,
		804	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		805	}, urxvt::line::
		806	}
		807
		808	sub urxvt::line::t {
		809	my ($self) = @_;
		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 &&
		818	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		819	0, $self->{len}
		820	}
		821
		822	sub urxvt::line::r {
		823	my ($self) = @_;
		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) {
		832	my $rend = [
		833	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		834	];
		835	$#$rend = $self->{len} - 1;
		836	return $rend;
		837	}
		838
		839	()
		840	}
		841
		842	sub urxvt::line::beg { $_[0]{beg} }
		843	sub urxvt::line::end { $_[0]{end} }
		844	sub urxvt::line::l { $_[0]{len} }
		845
		846	sub urxvt::line::offset_of {
		847	my ($self, $row, $col) = @_;
		848
		849	($row - $self->{beg}) * $self->{ncol} + $col
		850	}
		851
		852	sub urxvt::line::coord_of {
		853	my ($self, $offset) = @_;
		854
		855	use integer;
		856
		857	(
		858	$offset / $self->{ncol} + $self->{beg},
		859	$offset % $self->{ncol}
		860	)
		861	}
		862
		863	=item ($row, $col) = $line->coord_of ($offset)
624	=item $text = $term->special_encode $string	864	=item $text = $term->special_encode $string
625		865
626	Converts a perl string into the special encoding used by rxvt-unicode,	866	Converts a perl string into the special encoding used by rxvt-unicode,
627	where one character corresponds to one screen cell. See	867	where one character corresponds to one screen cell. See
628	C<< $term->ROW_t >> for details.	868	C<< $term->ROW_t >> for details.
…		…
742	This variable controls the verbosity level of the perl extension. Higher	982	This variable controls the verbosity level of the perl extension. Higher
743	numbers indicate more verbose output.	983	numbers indicate more verbose output.
744		984
745	=over 4	985	=over 4
746		986
747	=item 0 - only fatal messages	987	=item =0 - only fatal messages
748		988
749	=item 3 - script loading and management	989	=item =3 - script loading and management
750		990
751	=item 10 - all events received	991	=item =10 - all events received
752		992
753	=back	993	=back
754		994
755	=head1 AUTHOR	995	=head1 AUTHOR
756		996

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.23 by root, Tue Jan 3 19:42:53 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.23 by root, Tue Jan 3 19:42:53 2006 UTC vs.
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC