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