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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.29 by root, Wed Jan 4 00:12:12 2006 UTC vs.
Revision 1.36 by root, Fri Jan 6 02:58:02 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
…		…
103	=over 4	137	=over 4
104		138
105	=item on_init $term	139	=item on_init $term
106		140
107	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
108	windows are created or the command gets run.	142	windows are created or the command gets run. Most methods are unsafe to
		143	call or deliver senseless data, as terminal size and other characteristics
		144	have not yet been determined. You can safely query and change resources,
		145	though.
109		146
110	=item on_reset $term	147	=item on_reset $term
111		148
112	Called after the screen is "reset" for any reason, such as resizing or	149	Called after the screen is "reset" for any reason, such as resizing or
113	control sequences. Here is where you can react on changes to size-related	150	control sequences. Here is where you can react on changes to size-related
…		…
185		222
186	Be careful not ever to trust (in a security sense) the data you receive,	223	Be careful not ever to trust (in a security sense) the data you receive,
187	as its source can not easily be controleld (e-mail content, messages from	224	as its source can not easily be controleld (e-mail content, messages from
188	other users on the same system etc.).	225	other users on the same system etc.).
189		226
		227	=item on_add_lines $term, $string
		228
		229	Called whenever text is about to be output, with the text as argument. You
		230	can filter/change and output the text yourself by returning a true value
		231	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		232	might be very slow, however, as your hook is called for B<all> text being
		233	output.
		234
		235	=item on_line_update $term, $row
		236
		237	Called whenever a line was updated or changed. Can be used to filter
		238	screen output (e.g. underline urls or other useless stuff). Only lines
		239	that are being shown will be filtered, and, due to performance reasons,
		240	not always immediately.
		241
		242	The row number is always the topmost row of the line if the line spans
		243	multiple rows.
		244
		245	Please note that, if you change the line, then the hook might get called
		246	later with the already-modified line (e.g. if unrelated parts change), so
		247	you cannot just toggle rendition bits, but only set them.
		248
190	=item on_refresh_begin $term	249	=item on_refresh_begin $term
191		250
192	Called just before the screen gets redrawn. Can be used for overlay	251	Called just before the screen gets redrawn. Can be used for overlay
193	or similar effects by modify terminal contents in refresh_begin, and	252	or similar effects by modify terminal contents in refresh_begin, and
194	restoring them in refresh_end. The built-in overlay and selection display	253	restoring them in refresh_end. The built-in overlay and selection display
…		…
218	=back	277	=back
219		278
220	=head2 Functions in the C<urxvt> Package	279	=head2 Functions in the C<urxvt> Package
221		280
222	=over 4	281	=over 4
		282
		283	=item $term = new urxvt [arg...]
		284
		285	Creates a new terminal, very similar as if you had started it with
		286	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		287	if the new instance couldn't be created. Returns C<undef> if the new
		288	instance didn't initialise perl, and the terminal object otherwise. The
		289	C<init> and C<start> hooks will be called during the call.
223		290
224	=item urxvt::fatal $errormessage	291	=item urxvt::fatal $errormessage
225		292
226	Fatally aborts execution with the given error message. Avoid at all	293	Fatally aborts execution with the given error message. Avoid at all
227	costs! The only time this is acceptable is when the terminal process	294	costs! The only time this is acceptable is when the terminal process
…		…
366		433
367	$pkg	434	$pkg
368	}	435	}
369	}	436	}
370		437
		438	our $retval; # return value for urxvt
		439
371	# called by the rxvt core	440	# called by the rxvt core
372	sub invoke {	441	sub invoke {
373	local $TERM = shift;	442	local $TERM = shift;
374	my $htype = shift;	443	my $htype = shift;
375		444
376	if ($htype == 0) { # INIT	445	if ($htype == 0) { # INIT
377	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	446	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
378		447
379	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	448	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
380	my @files = grep -f $_, map "$_/$ext", @dirs;	449	my @files = grep -f $_, map "$_/$ext", @dirs;
381		450
382	if (@files) {	451	if (@files) {
383	register_package script_package $files[0];	452	register_package script_package $files[0];
384	} else {	453	} else {
385	warn "perl extension '$ext' not found in perl library search path\n";	454	warn "perl extension '$ext' not found in perl library search path\n";
386	}	455	}
387	}	456	}
		457	}
388		458
		459	$retval = undef;
		460
		461	if (my $cb = $TERM->{_hook}[$htype]) {
		462	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		463	if $verbosity >= 10;
		464
		465	keys %$cb;
		466
		467	while (my ($pkg, $cb) = each %$cb) {
		468	$retval = $cb->(
		469	$TERM->{_pkg}{$pkg} \|\|= do {
		470	my $proxy = bless { }, urxvt::term::proxy::;
		471	Scalar::Util::weaken ($proxy->{term} = $TERM);
		472	$proxy
		473	},
		474	@_,
		475	) and last;
		476	}
		477	}
		478
389	} elsif ($htype == 1) { # DESTROY	479	if ($htype == 1) { # DESTROY
		480	# remove hooks if unused
390	if (my $hook = $TERM->{_hook}) {	481	if (my $hook = $TERM->{_hook}) {
391	for my $htype (0..$#$hook) {	482	for my $htype (0..$#$hook) {
392	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	483	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
393	or set_should_invoke $htype, 0;	484	or set_should_invoke $htype, 0;
394	}	485	}
395	}	486	}
		487
		488	# clear package objects
		489	%$_ = () for values %{ $TERM->{_pkg} };
		490
		491	# clear package
		492	%$TERM = ();
396	}	493	}
397		494
398	my $cb = $TERM->{_hook}[$htype]	495	$retval
399	or return;
400
401	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
402	if $verbosity >= 10;
403
404	keys %$cb;
405
406	while (my ($pkg, $cb) = each %$cb) {
407	return 1
408	if $cb->(
409	$TERM->{$pkg} \|\|= do {
410	my $proxy = bless { }, urxvt::term::proxy::;
411	Scalar::Util::weaken ($proxy->{term} = $TERM);
412	$proxy
413	},
414	@_,
415	);
416	}
417
418	0
419	}	496	}
420		497
421	sub urxvt::term::proxy::AUTOLOAD {	498	sub urxvt::term::proxy::AUTOLOAD {
422	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	499	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
423	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	500	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
…		…
435		512
436	=head2 The C<urxvt::term> Class	513	=head2 The C<urxvt::term> Class
437		514
438	=over 4	515	=over 4
439		516
		517	=item $term->destroy
		518
		519	Destroy the terminal object (close the window, free resources etc.).
		520
440	=item $value = $term->resource ($name[, $newval])	521	=item $value = $term->resource ($name[, $newval])
441		522
442	Returns the current resource value associated with a given name and	523	Returns the current resource value associated with a given name and
443	optionally sets a new value. Setting values is most useful in the C<init>	524	optionally sets a new value. Setting values is most useful in the C<init>
444	hook. Unset resources are returned and accepted as C<undef>.	525	hook. Unset resources are returned and accepted as C<undef>.
…		…
461	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	542	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
462	borderLess color cursorBlink cursorUnderline cutchars delete_key	543	borderLess color cursorBlink cursorUnderline cutchars delete_key
463	display_name embed ext_bwidth fade font geometry hold iconName	544	display_name embed ext_bwidth fade font geometry hold iconName
464	imFont imLocale inputMethod insecure int_bwidth intensityStyles	545	imFont imLocale inputMethod insecure int_bwidth intensityStyles
465	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	546	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
466	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	547	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
467	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	548	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
468	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	549	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
469	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	550	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
470	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	551	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
471	shade term_name title transparent transparent_all tripleclickwords	552	shade term_name title transparent transparent_all tripleclickwords
…		…
477	my ($self, $name) = (shift, shift);	558	my ($self, $name) = (shift, shift);
478	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	559	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
479	goto &urxvt::term::_resource;	560	goto &urxvt::term::_resource;
480	}	561	}
481		562
		563	=item $rend = $term->rstyle ([$new_rstyle])
		564
		565	Return and optionally change the current rendition. Text that is output by
		566	the terminal application will use this style.
		567
		568	=item ($row, $col) = $term->screen_cur ([$row, $col])
		569
		570	Return the current coordinates of the text cursor position and optionally
		571	set it (which is usually bad as applications don't expect that).
		572
482	=item ($row, $col) = $term->selection_mark ([$row, $col])	573	=item ($row, $col) = $term->selection_mark ([$row, $col])
483		574
484	=item ($row, $col) = $term->selection_beg ([$row, $col])	575	=item ($row, $col) = $term->selection_beg ([$row, $col])
485		576
486	=item ($row, $col) = $term->selection_end ([$row, $col])	577	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
500	#=item $term->overlay ($x, $y, $text)	591	#=item $term->overlay ($x, $y, $text)
501	#	592	#
502	#Create a simple multi-line overlay box. See the next method for details.	593	#Create a simple multi-line overlay box. See the next method for details.
503	#	594	#
504	#=cut	595	#=cut
505		596	#
506	sub urxvt::term::scr_overlay {	597	#sub urxvt::term::scr_overlay {
507	die;
508	my ($self, $x, $y, $text) = @_;	598	# my ($self, $x, $y, $text) = @_;
509		599	#
510	my @lines = split /\n/, $text;	600	# my @lines = split /\n/, $text;
511		601	#
512	my $w = 0;	602	# my $w = 0;
513	for (map $self->strwidth ($_), @lines) {	603	# for (map $self->strwidth ($_), @lines) {
514	$w = $_ if $w < $_;	604	# $w = $_ if $w < $_;
515	}	605	# }
516		606	#
517	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	607	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
518	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	608	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
519	}	609	#}
520		610
521	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	611	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
522		612
523	Create a new (empty) overlay at the given position with the given	613	Create a new (empty) overlay at the given position with the given
524	width/height. C<$rstyle> defines the initial rendition style	614	width/height. C<$rstyle> defines the initial rendition style
…		…
564		654
565	=item $string = $term->locale_decode $octets	655	=item $string = $term->locale_decode $octets
566		656
567	Convert the given locale-encoded octets into a perl string.	657	Convert the given locale-encoded octets into a perl string.
568		658
		659	=item $term->scr_add_lines ($string)
		660
		661	Write the given text string to the screen, as if output by the application
		662	running inside the terminal. It may not contain command sequences (escape
		663	codes), but is free to use line feeds, carriage returns and tabs. The
		664	string is a normal text string, not in locale-dependent encoding.
		665
		666	Normally its not a good idea to use this function, as programs might be
		667	confused by changes in cursor position or scrolling. Its useful inside a
		668	C<on_add_lines> hook, though.
		669
		670	=item $term->cmd_parse ($octets)
		671
		672	Similar to C<scr_add_lines>, but the argument must be in the
		673	locale-specific encoding of the terminal and can contain command sequences
		674	(escape codes) that will be interpreted.
		675
569	=item $term->tt_write ($octets)	676	=item $term->tt_write ($octets)
570		677
571	Write the octets given in C<$data> to the tty (i.e. as program input). To	678	Write the octets given in C<$data> to the tty (i.e. as program input). To
572	pass characters instead of octets, you should convert your strings first	679	pass characters instead of octets, you should convert your strings first
573	to the locale-specific encoding using C<< $term->locale_encode >>.	680	to the locale-specific encoding using C<< $term->locale_encode >>.
574		681
		682	=item $window_width = $term->width
		683
		684	=item $window_height = $term->height
		685
		686	=item $font_width = $term->fwidth
		687
		688	=item $font_height = $term->fheight
		689
		690	=item $font_ascent = $term->fbase
		691
575	=item $nrow = $term->nrow	692	=item $terminal_rows = $term->nrow
576		693
577	=item $ncol = $term->ncol	694	=item $terminal_columns = $term->ncol
578		695
579	Return the number of rows/columns of the terminal window (i.e. as	696	=item $has_focus = $term->focus
580	specified by C<-geometry>, excluding any scrollback).
581		697
582	=item $nsaved = $term->nsaved	698	=item $is_mapped = $term->mapped
583		699
584	Returns the number of lines in the scrollback buffer.	700	=item $max_scrollback = $term->saveLines
		701
		702	=item $nrow_plus_saveLines = $term->total_rows
		703
		704	=item $lines_in_scrollback = $term->nsaved
		705
		706	Return various integers describing terminal characteristics.
585		707
586	=item $view_start = $term->view_start ([$newvalue])	708	=item $view_start = $term->view_start ([$newvalue])
587		709
588	Returns the negative row number of the topmost line. Minimum value is	710	Returns the negative row number of the topmost line. Minimum value is
589	C<0>, which displays the normal terminal contents. Larger values scroll	711	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
652	about the logical line that row C<$row_number> is part of. It supports the	774	about the logical line that row C<$row_number> is part of. It supports the
653	following methods:	775	following methods:
654		776
655	=over 4	777	=over 4
656		778
657	=item $text = $line->t	779	=item $text = $line->t ([$new_text])
658		780
659	Returns the full text of the line, similar to C<ROW_t>	781	Returns or replaces the full text of the line, similar to C<ROW_t>
660		782
661	=item $rend = $line->r	783	=item $rend = $line->r ([$new_rend])
662		784
663	Returns the full rendition array of the line, similar to C<ROW_r>	785	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
664		786
665	=item $length = $line->l	787	=item $length = $line->l
666		788
667	Returns the length of the line in cells, similar to C<ROW_l>.	789	Returns the length of the line in cells, similar to C<ROW_l>.
668		790
…		…
697		819
698	bless {	820	bless {
699	term => $self,	821	term => $self,
700	beg => $beg,	822	beg => $beg,
701	end => $end,	823	end => $end,
		824	ncol => $self->ncol,
702	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	825	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
703	}, urxvt::line::	826	}, urxvt::line::
704	}	827	}
705		828
706	sub urxvt::line::t {	829	sub urxvt::line::t {
707	my ($self) = @_;	830	my ($self) = @_;
708		831
		832	if (@_ > 1)
		833	{
		834	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		835	for $self->{beg} .. $self->{end};
		836	}
		837
		838	defined wantarray &&
709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	839	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
710	0, $self->{len}	840	0, $self->{len}
711	}	841	}
712		842
713	sub urxvt::line::r {	843	sub urxvt::line::r {
714	my ($self) = @_;	844	my ($self) = @_;
715		845
		846	if (@_ > 1)
		847	{
		848	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		849	for $self->{beg} .. $self->{end};
		850	}
		851
		852	if (defined wantarray) {
716	my $rend = [	853	my $rend = [
717	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	854	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
718	];	855	];
719	$#$rend = $self->{len} - 1;	856	$#$rend = $self->{len} - 1;
720	$rend	857	return $rend;
		858	}
		859
		860	()
721	}	861	}
722		862
723	sub urxvt::line::beg { $_[0]{beg} }	863	sub urxvt::line::beg { $_[0]{beg} }
724	sub urxvt::line::end { $_[0]{end} }	864	sub urxvt::line::end { $_[0]{end} }
725	sub urxvt::line::l { $_[0]{len} }	865	sub urxvt::line::l { $_[0]{len} }
726		866
727	sub urxvt::line::offset_of {	867	sub urxvt::line::offset_of {
728	my ($self, $row, $col) = @_;	868	my ($self, $row, $col) = @_;
729		869
730	($row - $self->{beg}) * $self->{term}->ncol + $col	870	($row - $self->{beg}) * $self->{ncol} + $col
731	}	871	}
732		872
733	sub urxvt::line::coord_of {	873	sub urxvt::line::coord_of {
734	my ($self, $offset) = @_;	874	my ($self, $offset) = @_;
735		875
736	use integer;	876	use integer;
737		877
738	(	878	(
739	$offset / $self->{term}->ncol + $self->{beg},	879	$offset / $self->{ncol} + $self->{beg},
740	$offset % $self->{term}->ncol	880	$offset % $self->{ncol}
741	)	881	)
742	}	882	}
743		883
744	=item ($row, $col) = $line->coord_of ($offset)	884	=item ($row, $col) = $line->coord_of ($offset)
745	=item $text = $term->special_encode $string	885	=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.29 by root, Wed Jan 4 00:12:12 2006 UTC vs. Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.29 by root, Wed Jan 4 00:12:12 2006 UTC vs.
Revision 1.36 by root, Fri Jan 6 02:58:02 2006 UTC