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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.28 by root, Wed Jan 4 00:09:12 2006 UTC vs.
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC

…		…
60		60
61	=item digital-clock	61	=item digital-clock
62		62
63	Displays a digital clock using the built-in overlay.	63	Displays a digital clock using the built-in overlay.
64		64
		65	=item mark-urls
		66
		67	Uses per-line filtering (C<on_line_update>) to underline urls.
		68
65	=item example-refresh-hooks	69	=item example-refresh-hooks
66		70
67	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
68	window. Illustrates overwriting the refresh callbacks to create your own	72	window. Illustrates overwriting the refresh callbacks to create your own
69	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.
70		81
71	=back	82	=back
72		83
73	=head2 General API Considerations	84	=head2 General API Considerations
74		85
…		…
81	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
82	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
83	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
84	terminal is destroyed.	95	terminal is destroyed.
85		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
86	=head2 Hooks	120	=head2 Hooks
87		121
88	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
89	called whenever the relevant event happens.	123	called whenever the relevant event happens.
90		124
…		…
174		208
175	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.
176		210
177	=item on_osc_seq $term, $string	211	=item on_osc_seq $term, $string
178		212
179	Called whenever the B<ESC ] 777 ; string ST> command sequence is	213	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
180	processed. Cursor position and other state information is up-to-date when	214	operating system command) is processed. Cursor position and other state
181	this happens. For interoperability, the string should start with the	215	information is up-to-date when this happens. For interoperability, the
182	extension name and a colon, to distinguish it from commands for other	216	string should start with the extension name and a colon, to distinguish
183	extensions, and this might be enforced in the future.	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.
184		245
185	=item on_refresh_begin $term	246	=item on_refresh_begin $term
186		247
187	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
188	or similar effects by modify terminal contents in refresh_begin, and	249	or similar effects by modify terminal contents in refresh_begin, and
…		…
361		422
362	$pkg	423	$pkg
363	}	424	}
364	}	425	}
365		426
		427	our $retval; # return value for urxvt
		428
366	# called by the rxvt core	429	# called by the rxvt core
367	sub invoke {	430	sub invoke {
368	local $TERM = shift;	431	local $TERM = shift;
369	my $htype = shift;	432	my $htype = shift;
370		433
371	if ($htype == 0) { # INIT	434	if ($htype == 0) { # INIT
372	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	435	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
373		436
374	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	437	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
375	my @files = grep -f $_, map "$_/$ext", @dirs;	438	my @files = grep -f $_, map "$_/$ext", @dirs;
376		439
377	if (@files) {	440	if (@files) {
378	register_package script_package $files[0];	441	register_package script_package $files[0];
379	} else {	442	} else {
380	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";
381	}	444	}
382	}	445	}
		446	}
383		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
384	} elsif ($htype == 1) { # DESTROY	468	if ($htype == 1) { # DESTROY
		469	# remove hooks if unused
385	if (my $hook = $TERM->{_hook}) {	470	if (my $hook = $TERM->{_hook}) {
386	for my $htype (0..$#$hook) {	471	for my $htype (0..$#$hook) {
387	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	472	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
388	or set_should_invoke $htype, 0;	473	or set_should_invoke $htype, 0;
389	}	474	}
390	}	475	}
		476
		477	# clear package objects
		478	%$_ = () for values %{ $TERM->{_pkg} };
		479
		480	# clear package
		481	%$TERM = ();
391	}	482	}
392		483
393	my $cb = $TERM->{_hook}[$htype]	484	$retval
394	or return;
395
396	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
397	if $verbosity >= 10;
398
399	keys %$cb;
400
401	while (my ($pkg, $cb) = each %$cb) {
402	return 1
403	if $cb->(
404	$TERM->{$pkg} \|\|= do {
405	my $proxy = bless { }, urxvt::term::proxy::;
406	Scalar::Util::weaken ($proxy->{term} = $TERM);
407	$proxy
408	},
409	@_,
410	);
411	}
412
413	0
414	}	485	}
415		486
416	sub urxvt::term::proxy::AUTOLOAD {	487	sub urxvt::term::proxy::AUTOLOAD {
417	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	488	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
418	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	489	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
…		…
456	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	527	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
457	borderLess color cursorBlink cursorUnderline cutchars delete_key	528	borderLess color cursorBlink cursorUnderline cutchars delete_key
458	display_name embed ext_bwidth fade font geometry hold iconName	529	display_name embed ext_bwidth fade font geometry hold iconName
459	imFont imLocale inputMethod insecure int_bwidth intensityStyles	530	imFont imLocale inputMethod insecure int_bwidth intensityStyles
460	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	531	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
461	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	532	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
462	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	533	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
463	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	534	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
464	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	535	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
465	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	536	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
466	shade term_name title transparent transparent_all tripleclickwords	537	shade term_name title transparent transparent_all tripleclickwords
…		…
472	my ($self, $name) = (shift, shift);	543	my ($self, $name) = (shift, shift);
473	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	544	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
474	goto &urxvt::term::_resource;	545	goto &urxvt::term::_resource;
475	}	546	}
476		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
477	=item ($row, $col) = $term->selection_mark ([$row, $col])	558	=item ($row, $col) = $term->selection_mark ([$row, $col])
478		559
479	=item ($row, $col) = $term->selection_beg ([$row, $col])	560	=item ($row, $col) = $term->selection_beg ([$row, $col])
480		561
481	=item ($row, $col) = $term->selection_end ([$row, $col])	562	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
495	#=item $term->overlay ($x, $y, $text)	576	#=item $term->overlay ($x, $y, $text)
496	#	577	#
497	#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.
498	#	579	#
499	#=cut	580	#=cut
500		581	#
501	sub urxvt::term::scr_overlay {	582	#sub urxvt::term::scr_overlay {
502	die;
503	my ($self, $x, $y, $text) = @_;	583	# my ($self, $x, $y, $text) = @_;
504		584	#
505	my @lines = split /\n/, $text;	585	# my @lines = split /\n/, $text;
506		586	#
507	my $w = 0;	587	# my $w = 0;
508	for (map $self->strwidth ($_), @lines) {	588	# for (map $self->strwidth ($_), @lines) {
509	$w = $_ if $w < $_;	589	# $w = $_ if $w < $_;
510	}	590	# }
511		591	#
512	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	592	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
513	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	593	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
514	}	594	#}
515		595
516	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	596	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
517		597
518	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
519	width/height. C<$rstyle> defines the initial rendition style	599	width/height. C<$rstyle> defines the initial rendition style
…		…
559		639
560	=item $string = $term->locale_decode $octets	640	=item $string = $term->locale_decode $octets
561		641
562	Convert the given locale-encoded octets into a perl string.	642	Convert the given locale-encoded octets into a perl string.
563		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
564	=item $term->tt_write ($octets)	655	=item $term->tt_write ($octets)
565		656
566	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
567	pass characters instead of octets, you should convert your strings first	658	pass characters instead of octets, you should convert your strings first
568	to the locale-specific encoding using C<< $term->locale_encode >>.	659	to the locale-specific encoding using C<< $term->locale_encode >>.
569		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
570	=item $nrow = $term->nrow	671	=item $terminal_rows = $term->nrow
571		672
572	=item $ncol = $term->ncol	673	=item $terminal_columns = $term->ncol
573		674
574	Return the number of rows/columns of the terminal window (i.e. as	675	=item $has_focus = $term->focus
575	specified by C<-geometry>, excluding any scrollback).
576		676
577	=item $nsaved = $term->nsaved	677	=item $is_mapped = $term->mapped
578		678
579	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.
580		686
581	=item $view_start = $term->view_start ([$newvalue])	687	=item $view_start = $term->view_start ([$newvalue])
582		688
583	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
584	C<0>, which displays the normal terminal contents. Larger values scroll	690	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
647	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
648	following methods:	754	following methods:
649		755
650	=over 4	756	=over 4
651		757
652	=item $text = $line->t	758	=item $text = $line->t ([$new_text])
653		759
654	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>
655		761
656	=item $rend = $line->r	762	=item $rend = $line->r ([$new_rend])
657		763
658	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>
659		765
660	=item $length = $line->l	766	=item $length = $line->l
661		767
662	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>.
663		769
…		…
692		798
693	bless {	799	bless {
694	term => $self,	800	term => $self,
695	beg => $beg,	801	beg => $beg,
696	end => $end,	802	end => $end,
		803	ncol => $self->ncol,
697	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	804	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
698	}, urxvt::line::	805	}, urxvt::line::
699	}	806	}
700		807
701	sub urxvt::line::t {	808	sub urxvt::line::t {
702	my ($self) = @_;	809	my ($self) = @_;
703		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 &&
704	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	818	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
705	0, $self->{len}	819	0, $self->{len}
706	}	820	}
707		821
708	sub urxvt::line::r {	822	sub urxvt::line::r {
709	my ($self) = @_;	823	my ($self) = @_;
710		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) {
711	my $rend = [	832	my $rend = [
712	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	833	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
713	];	834	];
714	$#$rend = $self->{len} - 1;	835	$#$rend = $self->{len} - 1;
715	$rend	836	return $rend;
		837	}
		838
		839	()
716	}	840	}
717		841
718	sub urxvt::line::beg { $_[0]{beg} }	842	sub urxvt::line::beg { $_[0]{beg} }
719	sub urxvt::line::end { $_[0]{end} }	843	sub urxvt::line::end { $_[0]{end} }
720	sub urxvt::line::l { $_[0]{len} }	844	sub urxvt::line::l { $_[0]{len} }
721		845
722	sub urxvt::line::offset_of {	846	sub urxvt::line::offset_of {
723	my ($self, $row, $col) = @_;	847	my ($self, $row, $col) = @_;
724		848
725	($row - $self->{beg}) * $self->{term}->ncol + $col	849	($row - $self->{beg}) * $self->{ncol} + $col
726	}	850	}
727		851
728	sub urxvt::line::coord_of {	852	sub urxvt::line::coord_of {
729	my ($self, $offset) = @_;	853	my ($self, $offset) = @_;
730		854
731	use integer;	855	use integer;
732		856
733	(	857	(
734	$offset / $self->{term}->ncol + $self->{beg},	858	$offset / $self->{ncol} + $self->{beg},
735	$offset % $self->{term}->ncol	859	$offset % $self->{ncol}
736	)	860	)
737	}	861	}
738		862
739	=item ($row, $col) = $line->coord_of ($offset)	863	=item ($row, $col) = $line->coord_of ($offset)
740	=item $text = $term->special_encode $string	864	=item $text = $term->special_encode $string

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.28 by root, Wed Jan 4 00:09:12 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.28 by root, Wed Jan 4 00:09:12 2006 UTC vs.
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC