[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.36 by root, Fri Jan 6 02:58:02 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
…		…
101	=over 4	137	=over 4
102		138
103	=item on_init $term	139	=item on_init $term
104		140
105	Called after a new terminal object has been initialized, but before	141	Called after a new terminal object has been initialized, but before
106	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.
107		146
108	=item on_reset $term	147	=item on_reset $term
109		148
110	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
111	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
…		…
170		209
171	=item on_tty_activity $term NYI	210	=item on_tty_activity $term NYI
172		211
173	Called whenever the program(s) running in the urxvt window send output.	212	Called whenever the program(s) running in the urxvt window send output.
174		213
		214	=item on_osc_seq $term, $string
		215
		216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		217	operating system command) is processed. Cursor position and other state
		218	information is up-to-date when this happens. For interoperability, the
		219	string should start with the extension name and a colon, to distinguish
		220	it from commands for other extensions, and this might be enforced in the
		221	future.
		222
		223	Be careful not ever to trust (in a security sense) the data you receive,
		224	as its source can not easily be controleld (e-mail content, messages from
		225	other users on the same system etc.).
		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
175	=item on_refresh_begin $term	249	=item on_refresh_begin $term
176		250
177	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
178	or similar effects by modify terminal contents in refresh_begin, and	252	or similar effects by modify terminal contents in refresh_begin, and
179	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
…		…
203	=back	277	=back
204		278
205	=head2 Functions in the C<urxvt> Package	279	=head2 Functions in the C<urxvt> Package
206		280
207	=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.
208		290
209	=item urxvt::fatal $errormessage	291	=item urxvt::fatal $errormessage
210		292
211	Fatally aborts execution with the given error message. Avoid at all	293	Fatally aborts execution with the given error message. Avoid at all
212	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
…		…
351		433
352	$pkg	434	$pkg
353	}	435	}
354	}	436	}
355		437
		438	our $retval; # return value for urxvt
		439
356	# called by the rxvt core	440	# called by the rxvt core
357	sub invoke {	441	sub invoke {
358	local $TERM = shift;	442	local $TERM = shift;
359	my $htype = shift;	443	my $htype = shift;
360		444
361	if ($htype == 0) { # INIT	445	if ($htype == 0) { # INIT
362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	446	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
363		447
364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	448	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
365	my @files = grep -f $_, map "$_/$ext", @dirs;	449	my @files = grep -f $_, map "$_/$ext", @dirs;
366		450
367	if (@files) {	451	if (@files) {
368	register_package script_package $files[0];	452	register_package script_package $files[0];
369	} else {	453	} else {
370	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";
371	}	455	}
372	}	456	}
		457	}
373		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
374	} elsif ($htype == 1) { # DESTROY	479	if ($htype == 1) { # DESTROY
		480	# remove hooks if unused
375	if (my $hook = $TERM->{_hook}) {	481	if (my $hook = $TERM->{_hook}) {
376	for my $htype (0..$#$hook) {	482	for my $htype (0..$#$hook) {
377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	483	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
378	or set_should_invoke $htype, 0;	484	or set_should_invoke $htype, 0;
379	}	485	}
380	}	486	}
		487
		488	# clear package objects
		489	%$_ = () for values %{ $TERM->{_pkg} };
		490
		491	# clear package
		492	%$TERM = ();
381	}	493	}
382		494
383	my $cb = $TERM->{_hook}[$htype]	495	$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	}	496	}
405		497
406	sub urxvt::term::proxy::AUTOLOAD {	498	sub urxvt::term::proxy::AUTOLOAD {
407	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	499	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
408	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	500	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
…		…
420		512
421	=head2 The C<urxvt::term> Class	513	=head2 The C<urxvt::term> Class
422		514
423	=over 4	515	=over 4
424		516
		517	=item $term->destroy
		518
		519	Destroy the terminal object (close the window, free resources etc.).
		520
425	=item $value = $term->resource ($name[, $newval])	521	=item $value = $term->resource ($name[, $newval])
426		522
427	Returns the current resource value associated with a given name and	523	Returns the current resource value associated with a given name and
428	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>
429	hook. Unset resources are returned and accepted as C<undef>.	525	hook. Unset resources are returned and accepted as C<undef>.
…		…
446	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	542	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447	borderLess color cursorBlink cursorUnderline cutchars delete_key	543	borderLess color cursorBlink cursorUnderline cutchars delete_key
448	display_name embed ext_bwidth fade font geometry hold iconName	544	display_name embed ext_bwidth fade font geometry hold iconName
449	imFont imLocale inputMethod insecure int_bwidth intensityStyles	545	imFont imLocale inputMethod insecure int_bwidth intensityStyles
450	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	546	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
451	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	547	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
452	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	548	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
453	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	549	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
454	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	550	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
455	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	551	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
456	shade term_name title transparent transparent_all tripleclickwords	552	shade term_name title transparent transparent_all tripleclickwords
…		…
462	my ($self, $name) = (shift, shift);	558	my ($self, $name) = (shift, shift);
463	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	559	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
464	goto &urxvt::term::_resource;	560	goto &urxvt::term::_resource;
465	}	561	}
466		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
467	=item ($row, $col) = $term->selection_mark ([$row, $col])	573	=item ($row, $col) = $term->selection_mark ([$row, $col])
468		574
469	=item ($row, $col) = $term->selection_beg ([$row, $col])	575	=item ($row, $col) = $term->selection_beg ([$row, $col])
470		576
471	=item ($row, $col) = $term->selection_end ([$row, $col])	577	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
485	#=item $term->overlay ($x, $y, $text)	591	#=item $term->overlay ($x, $y, $text)
486	#	592	#
487	#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.
488	#	594	#
489	#=cut	595	#=cut
490		596	#
491	sub urxvt::term::scr_overlay {	597	#sub urxvt::term::scr_overlay {
492	die;
493	my ($self, $x, $y, $text) = @_;	598	# my ($self, $x, $y, $text) = @_;
494		599	#
495	my @lines = split /\n/, $text;	600	# my @lines = split /\n/, $text;
496		601	#
497	my $w = 0;	602	# my $w = 0;
498	for (map $self->strwidth ($_), @lines) {	603	# for (map $self->strwidth ($_), @lines) {
499	$w = $_ if $w < $_;	604	# $w = $_ if $w < $_;
500	}	605	# }
501		606	#
502	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	607	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
503	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	608	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
504	}	609	#}
505		610
506	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	611	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
507		612
508	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
509	width/height. C<$rstyle> defines the initial rendition style	614	width/height. C<$rstyle> defines the initial rendition style
…		…
549		654
550	=item $string = $term->locale_decode $octets	655	=item $string = $term->locale_decode $octets
551		656
552	Convert the given locale-encoded octets into a perl string.	657	Convert the given locale-encoded octets into a perl string.
553		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
554	=item $term->tt_write ($octets)	676	=item $term->tt_write ($octets)
555		677
556	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
557	pass characters instead of octets, you should convert your strings first	679	pass characters instead of octets, you should convert your strings first
558	to the locale-specific encoding using C<< $term->locale_encode >>.	680	to the locale-specific encoding using C<< $term->locale_encode >>.
559		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
560	=item $nrow = $term->nrow	692	=item $terminal_rows = $term->nrow
561		693
562	=item $ncol = $term->ncol	694	=item $terminal_columns = $term->ncol
563		695
564	Return the number of rows/columns of the terminal window (i.e. as	696	=item $has_focus = $term->focus
565	specified by C<-geometry>, excluding any scrollback).
566		697
567	=item $nsaved = $term->nsaved	698	=item $is_mapped = $term->mapped
568		699
569	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.
570		707
571	=item $view_start = $term->view_start ([$newvalue])	708	=item $view_start = $term->view_start ([$newvalue])
572		709
573	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
574	C<0>, which displays the normal terminal contents. Larger values scroll	711	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	774	about the logical line that row C<$row_number> is part of. It supports the
638	following methods:	775	following methods:
639		776
640	=over 4	777	=over 4
641		778
642	=item $text = $line->t	779	=item $text = $line->t ([$new_text])
643		780
644	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>
645		782
646	=item $rend = $line->r	783	=item $rend = $line->r ([$new_rend])
647		784
648	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>
649		786
650	=item $length = $line->l	787	=item $length = $line->l
651		788
652	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>.
653		790
…		…
682		819
683	bless {	820	bless {
684	term => $self,	821	term => $self,
685	beg => $beg,	822	beg => $beg,
686	end => $end,	823	end => $end,
		824	ncol => $self->ncol,
687	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	825	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
688	}, urxvt::line::	826	}, urxvt::line::
689	}	827	}
690		828
691	sub urxvt::line::t {	829	sub urxvt::line::t {
692	my ($self) = @_;	830	my ($self) = @_;
693		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 &&
694	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	839	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
695	0, $self->{len}	840	0, $self->{len}
696	}	841	}
697		842
698	sub urxvt::line::r {	843	sub urxvt::line::r {
699	my ($self) = @_;	844	my ($self) = @_;
700		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) {
701	my $rend = [	853	my $rend = [
702	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	854	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
703	];	855	];
704	$#$rend = $self->{len} - 1;	856	$#$rend = $self->{len} - 1;
705	$rend	857	return $rend;
		858	}
		859
		860	()
706	}	861	}
707		862
708	sub urxvt::line::beg { $_[0]{beg} }	863	sub urxvt::line::beg { $_[0]{beg} }
709	sub urxvt::line::end { $_[0]{end} }	864	sub urxvt::line::end { $_[0]{end} }
710	sub urxvt::line::l { $_[0]{len} }	865	sub urxvt::line::l { $_[0]{len} }
711		866
712	sub urxvt::line::offset_of {	867	sub urxvt::line::offset_of {
713	my ($self, $row, $col) = @_;	868	my ($self, $row, $col) = @_;
714		869
715	($row - $self->{beg}) * $self->{term}->ncol + $col	870	($row - $self->{beg}) * $self->{ncol} + $col
716	}	871	}
717		872
718	sub urxvt::line::coord_of {	873	sub urxvt::line::coord_of {
719	my ($self, $offset) = @_;	874	my ($self, $offset) = @_;
720		875
721	use integer;	876	use integer;
722		877
723	(	878	(
724	$offset / $self->{term}->ncol + $self->{beg},	879	$offset / $self->{ncol} + $self->{beg},
725	$offset % $self->{term}->ncol	880	$offset % $self->{ncol}
726	)	881	)
727	}	882	}
728		883
729	=item ($row, $col) = $line->coord_of ($offset)	884	=item ($row, $col) = $line->coord_of ($offset)
730	=item $text = $term->special_encode $string	885	=item $text = $term->special_encode $string
…		…
848	This variable controls the verbosity level of the perl extension. Higher	1003	This variable controls the verbosity level of the perl extension. Higher
849	numbers indicate more verbose output.	1004	numbers indicate more verbose output.
850		1005
851	=over 4	1006	=over 4
852		1007
853	=item 0 - only fatal messages	1008	=item =0 - only fatal messages
854		1009
855	=item 3 - script loading and management	1010	=item =3 - script loading and management
856		1011
857	=item 10 - all events received	1012	=item =10 - all events received
858		1013
859	=back	1014	=back
860		1015
861	=head1 AUTHOR	1016	=head1 AUTHOR
862		1017

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.36 by root, Fri Jan 6 02:58:02 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.36 by root, Fri Jan 6 02:58:02 2006 UTC