[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.37 by root, Fri Jan 6 03:40:19 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
…		…
174		211
175	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.
176		213
177	=item on_osc_seq $term, $string	214	=item on_osc_seq $term, $string
178		215
179	Called whenever the B<ESC ] 777 ; string ST> command sequence is	216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
180	processed. Cursor position and other state information is up-to-date when	217	operating system command) is processed. Cursor position and other state
181	this happens. For interoperability, the string should start with the	218	information is up-to-date when this happens. For interoperability, the
182	extension name and a colon, to distinguish it from commands for other	219	string should start with the extension name and a colon, to distinguish
183	extensions, and this might be enforced in the future.	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.
184		248
185	=item on_refresh_begin $term	249	=item on_refresh_begin $term
186		250
187	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
188	or similar effects by modify terminal contents in refresh_begin, and	252	or similar effects by modify terminal contents in refresh_begin, and
…		…
197		261
198	Called whenever the user presses a key combination that has a	262	Called whenever the user presses a key combination that has a
199	C<perl:string> action bound to it (see description of the B<keysym>	263	C<perl:string> action bound to it (see description of the B<keysym>
200	resource in the @@RXVT_NAME@@(1) manpage).	264	resource in the @@RXVT_NAME@@(1) manpage).
201		265
		266	=item on_key_press $term, $event
		267
		268	=item on_key_release $term, $event
		269
		270	=item on_button_press $term, $event
		271
		272	=item on_button_release $term, $event
		273
		274	=item on_motion_notify $term, $event
		275
		276	Called whenever the corresponding X event is received for the terminal. If
		277	the hook returns true, then the even will be ignored by rxvt-unicode.
		278
		279	subwindow.
		280
202	=back	281	=back
203		282
204	=head2 Variables in the C<urxvt> Package	283	=head2 Variables in the C<urxvt> Package
205		284
206	=over 4	285	=over 4
…		…
213	=back	292	=back
214		293
215	=head2 Functions in the C<urxvt> Package	294	=head2 Functions in the C<urxvt> Package
216		295
217	=over 4	296	=over 4
		297
		298	=item $term = new urxvt [arg...]
		299
		300	Creates a new terminal, very similar as if you had started it with
		301	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		302	if the new instance couldn't be created. Returns C<undef> if the new
		303	instance didn't initialise perl, and the terminal object otherwise. The
		304	C<init> and C<start> hooks will be called during the call.
218		305
219	=item urxvt::fatal $errormessage	306	=item urxvt::fatal $errormessage
220		307
221	Fatally aborts execution with the given error message. Avoid at all	308	Fatally aborts execution with the given error message. Avoid at all
222	costs! The only time this is acceptable is when the terminal process	309	costs! The only time this is acceptable is when the terminal process
…		…
361		448
362	$pkg	449	$pkg
363	}	450	}
364	}	451	}
365		452
		453	our $retval; # return value for urxvt
		454
366	# called by the rxvt core	455	# called by the rxvt core
367	sub invoke {	456	sub invoke {
368	local $TERM = shift;	457	local $TERM = shift;
369	my $htype = shift;	458	my $htype = shift;
370		459
371	if ($htype == 0) { # INIT	460	if ($htype == 0) { # INIT
372	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	461	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
373		462
374	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	463	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
375	my @files = grep -f $_, map "$_/$ext", @dirs;	464	my @files = grep -f $_, map "$_/$ext", @dirs;
376		465
377	if (@files) {	466	if (@files) {
378	register_package script_package $files[0];	467	register_package script_package $files[0];
379	} else {	468	} else {
380	warn "perl extension '$ext' not found in perl library search path\n";	469	warn "perl extension '$ext' not found in perl library search path\n";
381	}	470	}
382	}	471	}
		472	}
383		473
		474	$retval = undef;
		475
		476	if (my $cb = $TERM->{_hook}[$htype]) {
		477	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		478	if $verbosity >= 10;
		479
		480	keys %$cb;
		481
		482	while (my ($pkg, $cb) = each %$cb) {
		483	$retval = $cb->(
		484	$TERM->{_pkg}{$pkg} \|\|= do {
		485	my $proxy = bless { }, urxvt::term::proxy::;
		486	Scalar::Util::weaken ($proxy->{term} = $TERM);
		487	$proxy
		488	},
		489	@_,
		490	) and last;
		491	}
		492	}
		493
384	} elsif ($htype == 1) { # DESTROY	494	if ($htype == 1) { # DESTROY
		495	# remove hooks if unused
385	if (my $hook = $TERM->{_hook}) {	496	if (my $hook = $TERM->{_hook}) {
386	for my $htype (0..$#$hook) {	497	for my $htype (0..$#$hook) {
387	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	498	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
388	or set_should_invoke $htype, 0;	499	or set_should_invoke $htype, 0;
389	}	500	}
390	}	501	}
		502
		503	# clear package objects
		504	%$_ = () for values %{ $TERM->{_pkg} };
		505
		506	# clear package
		507	%$TERM = ();
391	}	508	}
392		509
393	my $cb = $TERM->{_hook}[$htype]	510	$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	}	511	}
415		512
416	sub urxvt::term::proxy::AUTOLOAD {	513	sub urxvt::term::proxy::AUTOLOAD {
417	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	514	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
418	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	515	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
…		…
430		527
431	=head2 The C<urxvt::term> Class	528	=head2 The C<urxvt::term> Class
432		529
433	=over 4	530	=over 4
434		531
		532	=item $term->destroy
		533
		534	Destroy the terminal object (close the window, free resources etc.).
		535
435	=item $value = $term->resource ($name[, $newval])	536	=item $value = $term->resource ($name[, $newval])
436		537
437	Returns the current resource value associated with a given name and	538	Returns the current resource value associated with a given name and
438	optionally sets a new value. Setting values is most useful in the C<init>	539	optionally sets a new value. Setting values is most useful in the C<init>
439	hook. Unset resources are returned and accepted as C<undef>.	540	hook. Unset resources are returned and accepted as C<undef>.
…		…
456	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	557	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
457	borderLess color cursorBlink cursorUnderline cutchars delete_key	558	borderLess color cursorBlink cursorUnderline cutchars delete_key
458	display_name embed ext_bwidth fade font geometry hold iconName	559	display_name embed ext_bwidth fade font geometry hold iconName
459	imFont imLocale inputMethod insecure int_bwidth intensityStyles	560	imFont imLocale inputMethod insecure int_bwidth intensityStyles
460	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	561	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
461	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	562	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
462	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	563	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
463	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	564	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
464	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	565	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
465	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	566	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
466	shade term_name title transparent transparent_all tripleclickwords	567	shade term_name title transparent transparent_all tripleclickwords
…		…
472	my ($self, $name) = (shift, shift);	573	my ($self, $name) = (shift, shift);
473	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	574	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
474	goto &urxvt::term::_resource;	575	goto &urxvt::term::_resource;
475	}	576	}
476		577
		578	=item $rend = $term->rstyle ([$new_rstyle])
		579
		580	Return and optionally change the current rendition. Text that is output by
		581	the terminal application will use this style.
		582
		583	=item ($row, $col) = $term->screen_cur ([$row, $col])
		584
		585	Return the current coordinates of the text cursor position and optionally
		586	set it (which is usually bad as applications don't expect that).
		587
477	=item ($row, $col) = $term->selection_mark ([$row, $col])	588	=item ($row, $col) = $term->selection_mark ([$row, $col])
478		589
479	=item ($row, $col) = $term->selection_beg ([$row, $col])	590	=item ($row, $col) = $term->selection_beg ([$row, $col])
480		591
481	=item ($row, $col) = $term->selection_end ([$row, $col])	592	=item ($row, $col) = $term->selection_end ([$row, $col])
…		…
495	#=item $term->overlay ($x, $y, $text)	606	#=item $term->overlay ($x, $y, $text)
496	#	607	#
497	#Create a simple multi-line overlay box. See the next method for details.	608	#Create a simple multi-line overlay box. See the next method for details.
498	#	609	#
499	#=cut	610	#=cut
500		611	#
501	sub urxvt::term::scr_overlay {	612	#sub urxvt::term::scr_overlay {
502	die;
503	my ($self, $x, $y, $text) = @_;	613	# my ($self, $x, $y, $text) = @_;
504		614	#
505	my @lines = split /\n/, $text;	615	# my @lines = split /\n/, $text;
506		616	#
507	my $w = 0;	617	# my $w = 0;
508	for (map $self->strwidth ($_), @lines) {	618	# for (map $self->strwidth ($_), @lines) {
509	$w = $_ if $w < $_;	619	# $w = $_ if $w < $_;
510	}	620	# }
511		621	#
512	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	622	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
513	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	623	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
514	}	624	#}
515		625
516	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	626	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
517		627
518	Create a new (empty) overlay at the given position with the given	628	Create a new (empty) overlay at the given position with the given
519	width/height. C<$rstyle> defines the initial rendition style	629	width/height. C<$rstyle> defines the initial rendition style
…		…
559		669
560	=item $string = $term->locale_decode $octets	670	=item $string = $term->locale_decode $octets
561		671
562	Convert the given locale-encoded octets into a perl string.	672	Convert the given locale-encoded octets into a perl string.
563		673
		674	=item $term->scr_add_lines ($string)
		675
		676	Write the given text string to the screen, as if output by the application
		677	running inside the terminal. It may not contain command sequences (escape
		678	codes), but is free to use line feeds, carriage returns and tabs. The
		679	string is a normal text string, not in locale-dependent encoding.
		680
		681	Normally its not a good idea to use this function, as programs might be
		682	confused by changes in cursor position or scrolling. Its useful inside a
		683	C<on_add_lines> hook, though.
		684
		685	=item $term->cmd_parse ($octets)
		686
		687	Similar to C<scr_add_lines>, but the argument must be in the
		688	locale-specific encoding of the terminal and can contain command sequences
		689	(escape codes) that will be interpreted.
		690
564	=item $term->tt_write ($octets)	691	=item $term->tt_write ($octets)
565		692
566	Write the octets given in C<$data> to the tty (i.e. as program input). To	693	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	694	pass characters instead of octets, you should convert your strings first
568	to the locale-specific encoding using C<< $term->locale_encode >>.	695	to the locale-specific encoding using C<< $term->locale_encode >>.
569		696
		697	=item $window_width = $term->width
		698
		699	=item $window_height = $term->height
		700
		701	=item $font_width = $term->fwidth
		702
		703	=item $font_height = $term->fheight
		704
		705	=item $font_ascent = $term->fbase
		706
570	=item $nrow = $term->nrow	707	=item $terminal_rows = $term->nrow
571		708
572	=item $ncol = $term->ncol	709	=item $terminal_columns = $term->ncol
573		710
574	Return the number of rows/columns of the terminal window (i.e. as	711	=item $has_focus = $term->focus
575	specified by C<-geometry>, excluding any scrollback).
576		712
577	=item $nsaved = $term->nsaved	713	=item $is_mapped = $term->mapped
578		714
579	Returns the number of lines in the scrollback buffer.	715	=item $max_scrollback = $term->saveLines
		716
		717	=item $nrow_plus_saveLines = $term->total_rows
		718
		719	=item $lines_in_scrollback = $term->nsaved
		720
		721	Return various integers describing terminal characteristics.
580		722
581	=item $view_start = $term->view_start ([$newvalue])	723	=item $view_start = $term->view_start ([$newvalue])
582		724
583	Returns the negative row number of the topmost line. Minimum value is	725	Returns the negative row number of the topmost line. Minimum value is
584	C<0>, which displays the normal terminal contents. Larger values scroll	726	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	789	about the logical line that row C<$row_number> is part of. It supports the
648	following methods:	790	following methods:
649		791
650	=over 4	792	=over 4
651		793
652	=item $text = $line->t	794	=item $text = $line->t ([$new_text])
653		795
654	Returns the full text of the line, similar to C<ROW_t>	796	Returns or replaces the full text of the line, similar to C<ROW_t>
655		797
656	=item $rend = $line->r	798	=item $rend = $line->r ([$new_rend])
657		799
658	Returns the full rendition array of the line, similar to C<ROW_r>	800	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
659		801
660	=item $length = $line->l	802	=item $length = $line->l
661		803
662	Returns the length of the line in cells, similar to C<ROW_l>.	804	Returns the length of the line in cells, similar to C<ROW_l>.
663		805
…		…
692		834
693	bless {	835	bless {
694	term => $self,	836	term => $self,
695	beg => $beg,	837	beg => $beg,
696	end => $end,	838	end => $end,
		839	ncol => $self->ncol,
697	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	840	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
698	}, urxvt::line::	841	}, urxvt::line::
699	}	842	}
700		843
701	sub urxvt::line::t {	844	sub urxvt::line::t {
702	my ($self) = @_;	845	my ($self) = @_;
703		846
		847	if (@_ > 1)
		848	{
		849	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		850	for $self->{beg} .. $self->{end};
		851	}
		852
		853	defined wantarray &&
704	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	854	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
705	0, $self->{len}	855	0, $self->{len}
706	}	856	}
707		857
708	sub urxvt::line::r {	858	sub urxvt::line::r {
709	my ($self) = @_;	859	my ($self) = @_;
710		860
		861	if (@_ > 1)
		862	{
		863	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		864	for $self->{beg} .. $self->{end};
		865	}
		866
		867	if (defined wantarray) {
711	my $rend = [	868	my $rend = [
712	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	869	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
713	];	870	];
714	$#$rend = $self->{len} - 1;	871	$#$rend = $self->{len} - 1;
715	$rend	872	return $rend;
		873	}
		874
		875	()
716	}	876	}
717		877
718	sub urxvt::line::beg { $_[0]{beg} }	878	sub urxvt::line::beg { $_[0]{beg} }
719	sub urxvt::line::end { $_[0]{end} }	879	sub urxvt::line::end { $_[0]{end} }
720	sub urxvt::line::l { $_[0]{len} }	880	sub urxvt::line::l { $_[0]{len} }
721		881
722	sub urxvt::line::offset_of {	882	sub urxvt::line::offset_of {
723	my ($self, $row, $col) = @_;	883	my ($self, $row, $col) = @_;
724		884
725	($row - $self->{beg}) * $self->{term}->ncol + $col	885	($row - $self->{beg}) * $self->{ncol} + $col
726	}	886	}
727		887
728	sub urxvt::line::coord_of {	888	sub urxvt::line::coord_of {
729	my ($self, $offset) = @_;	889	my ($self, $offset) = @_;
730		890
731	use integer;	891	use integer;
732		892
733	(	893	(
734	$offset / $self->{term}->ncol + $self->{beg},	894	$offset / $self->{ncol} + $self->{beg},
735	$offset % $self->{term}->ncol	895	$offset % $self->{ncol}
736	)	896	)
737	}	897	}
738		898
739	=item ($row, $col) = $line->coord_of ($offset)	899	=item ($row, $col) = $line->coord_of ($offset)
740	=item $text = $term->special_encode $string	900	=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.37 by root, Fri Jan 6 03:40:19 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.37 by root, Fri Jan 6 03:40:19 2006 UTC