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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
…		…
59	=back	59	=back
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
		65	=item mark-urls
		66
		67	Uses per-line display filtering (C<on_line_update>) to underline urls.
		68
		69	=item block-graphics-to-ascii
		70
		71	A not very useful example of filtering all text output to the terminal,
		72	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		73	similar-looking ascii character.
64		74
65	=item example-refresh-hooks	75	=item example-refresh-hooks
66		76
67	Displays a very simple digital clock in the upper right corner of the	77	Displays a very simple digital clock in the upper right corner of the
68	window. Illustrates overwriting the refresh callbacks to create your own	78	window. Illustrates overwriting the refresh callbacks to create your own
…		…
81	When objects are destroyed on the C++ side, the perl object hashes are	91	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	92	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	93	the like inside the terminal object so they get destroyed as soon as the
84	terminal is destroyed.	94	terminal is destroyed.
85		95
		96	Argument names also often indicate the type of a parameter. Here are some
		97	hints on what they mean:
		98
		99	=over 4
		100
		101	=item $text
		102
		103	Rxvt-unicodes special way of encoding text, where one "unicode" character
		104	always represents one screen cell. See L<row_t> for a discussion of this format.
		105
		106	=item $string
		107
		108	A perl text string, with an emphasis on I<text>. It can store all unicode
		109	characters and is to be distinguished with text encoded in a specific
		110	encoding (often locale-specific) and binary data.
		111
		112	=item $octets
		113
		114	Either binary data or - more common - a text string encoded in a
		115	locale-specific way.
		116
		117	=back
		118
86	=head2 Hooks	119	=head2 Hooks
87		120
88	The following subroutines can be declared in loaded scripts, and will be	121	The following subroutines can be declared in extension files, and will be
89	called whenever the relevant event happens.	122	called whenever the relevant event happens.
90		123
91	The first argument passed to them is an object private to each terminal	124	The first argument passed to them is an object private to each terminal
92	and extension package. You can call all C<urxvt::term> methods on it, but	125	and extension package. You can call all C<urxvt::term> methods on it, but
93	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>	126	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
94	object that is shared between all packages is stored in the C<term>	127	object that is shared between all packages is stored in the C<term>
95	member.	128	member. It is, however, blessed intot he package of the extension script,
		129	so for all practical purposes you can treat an extension script as a class.
96		130
97	All of them must return a boolean value. If it is true, then the event	131	All of them must return a boolean value. If it is true, then the event
98	counts as being I<consumed>, and the invocation of other hooks is skipped,	132	counts as being I<consumed>, and the invocation of other hooks is skipped,
99	and the relevant action might not be carried out by the C++ code.	133	and the relevant action might not be carried out by the C++ code.
100		134
…		…
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 If
		277	the hook returns true, then the even will be ignored by rxvt-unicode.
		278
		279	The event is a hash with most values as named by Xlib (see the XEvent
		280	manpage), with the additional members C<row> and C<col>, which are the row
		281	and column under the mouse cursor.
		282
		283	C<on_key_press> additionally receives the string rxvt-unicode would
		284	output, if any, in locale-specific encoding.
		285
		286	subwindow.
		287
207	=back	288	=back
208		289
209	=head2 Variables in the C<urxvt> Package	290	=head2 Variables in the C<urxvt> Package
210		291
211	=over 4	292	=over 4
212		293
213	=item $urxvt::TERM	294	=item $urxvt::TERM
214		295
215	The current terminal. Whenever a callback/Hook is bein executed, this	296	The current terminal. This variable stores the current C<urxvt::term>
216	variable stores the current C<urxvt::term> object.	297	object, whenever a callback/hook is executing.
217		298
218	=back	299	=back
219		300
220	=head2 Functions in the C<urxvt> Package	301	=head2 Functions in the C<urxvt> Package
221		302
222	=over 4	303	=over 4
		304
		305	=item $term = new urxvt [arg...]
		306
		307	Creates a new terminal, very similar as if you had started it with
		308	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		309	if the new instance couldn't be created. Returns C<undef> if the new
		310	instance didn't initialise perl, and the terminal object otherwise. The
		311	C<init> and C<start> hooks will be called during the call.
223		312
224	=item urxvt::fatal $errormessage	313	=item urxvt::fatal $errormessage
225		314
226	Fatally aborts execution with the given error message. Avoid at all	315	Fatally aborts execution with the given error message. Avoid at all
227	costs! The only time this is acceptable is when the terminal process	316	costs! The only time this is acceptable is when the terminal process
…		…
340	$hook_count[$htype]++	429	$hook_count[$htype]++
341	or set_should_invoke $htype, 1;	430	or set_should_invoke $htype, 1;
342	}	431	}
343	}	432	}
344		433
345	my $script_pkg = "script0000";	434	my $extension_pkg = "extension0000";
346	my %script_pkg;	435	my %extension_pkg;
347		436
348	# load a single script into its own package, once only	437	# load a single script into its own package, once only
349	sub script_package($) {	438	sub extension_package($) {
350	my ($path) = @_;	439	my ($path) = @_;
351		440
352	$script_pkg{$path} \|\|= do {	441	$extension_pkg{$path} \|\|= do {
353	my $pkg = "urxvt::" . ($script_pkg++);	442	my $pkg = "urxvt::" . ($extension_pkg++);
354		443
355	verbose 3, "loading script '$path' into package '$pkg'";	444	verbose 3, "loading extension '$path' into package '$pkg'";
356		445
357	open my $fh, "<:raw", $path	446	open my $fh, "<:raw", $path
358	or die "$path: $!";	447	or die "$path: $!";
359		448
360	my $source = "package $pkg; use strict; use utf8;\n"	449	my $source = "package $pkg; use strict; use utf8;\n"
		450	. "use base urxvt::term::proxy::;\n"
361	. "#line 1 \"$path\"\n{\n"	451	. "#line 1 \"$path\"\n{\n"
362	. (do { local $/; <$fh> })	452	. (do { local $/; <$fh> })
363	. "\n};\n1";	453	. "\n};\n1";
364		454
365	eval $source or die "$path: $@";	455	eval $source or die "$path: $@";
…		…
376	my $htype = shift;	466	my $htype = shift;
377		467
378	if ($htype == 0) { # INIT	468	if ($htype == 0) { # INIT
379	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	469	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
380		470
381	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	471	for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
382	my @files = grep -f $_, map "$_/$ext", @dirs;	472	my @files = grep -f $_, map "$_/$ext", @dirs;
383		473
384	if (@files) {	474	if (@files) {
385	register_package script_package $files[0];	475	register_package extension_package $files[0];
386	} else {	476	} else {
387	warn "perl extension '$ext' not found in perl library search path\n";	477	warn "perl extension '$ext' not found in perl library search path\n";
388	}	478	}
389	}	479	}
390	}	480	}
…		…
396	if $verbosity >= 10;	486	if $verbosity >= 10;
397		487
398	keys %$cb;	488	keys %$cb;
399		489
400	while (my ($pkg, $cb) = each %$cb) {	490	while (my ($pkg, $cb) = each %$cb) {
		491	eval {
401	$retval = $cb->(	492	$retval = $cb->(
402	$TERM->{_pkg}{$pkg} \|\|= do {	493	$TERM->{_pkg}{$pkg} \|\|= do {
403	my $proxy = bless { }, urxvt::term::proxy::;	494	my $proxy = bless { }, $pkg;
404	Scalar::Util::weaken ($proxy->{term} = $TERM);	495	Scalar::Util::weaken ($proxy->{term} = $TERM);
405	$proxy	496	$proxy
406	},	497	},
407	@_,	498	@_,
408	) and last;	499	) and last;
		500	};
		501	warn $@ if $@;#d#
409	}	502	}
410	}	503	}
411		504
412	if ($htype == 1) { # DESTROY	505	if ($htype == 1) { # DESTROY
413	# remove hooks if unused	506	# remove hooks if unused
…		…
444	}	537	}
445		538
446	=head2 The C<urxvt::term> Class	539	=head2 The C<urxvt::term> Class
447		540
448	=over 4	541	=over 4
		542
		543	=item $term->destroy
		544
		545	Destroy the terminal object (close the window, free resources etc.).
449		546
450	=item $value = $term->resource ($name[, $newval])	547	=item $value = $term->resource ($name[, $newval])
451		548
452	Returns the current resource value associated with a given name and	549	Returns the current resource value associated with a given name and
453	optionally sets a new value. Setting values is most useful in the C<init>	550	optionally sets a new value. Setting values is most useful in the C<init>
…		…
487	my ($self, $name) = (shift, shift);	584	my ($self, $name) = (shift, shift);
488	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	585	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
489	goto &urxvt::term::_resource;	586	goto &urxvt::term::_resource;
490	}	587	}
491		588
492	=item $rend = $term->screen_rstyle ([$new_rstyle])	589	=item $rend = $term->rstyle ([$new_rstyle])
493		590
494	Return and optionally change the current rendition. Text thta is output by	591	Return and optionally change the current rendition. Text that is output by
495	the temrianl application will use this style.	592	the terminal application will use this style.
496		593
497	=item ($row, $col) = $term->screen_cur ([$row, $col])	594	=item ($row, $col) = $term->screen_cur ([$row, $col])
498		595
499	Return the current coordinates of the text cursor position and optionally	596	Return the current coordinates of the text cursor position and optionally
500	set it (which is usually bad as applications don't expect that).	597	set it (which is usually bad as applications don't expect that).
…		…
520	#=item $term->overlay ($x, $y, $text)	617	#=item $term->overlay ($x, $y, $text)
521	#	618	#
522	#Create a simple multi-line overlay box. See the next method for details.	619	#Create a simple multi-line overlay box. See the next method for details.
523	#	620	#
524	#=cut	621	#=cut
525		622	#
526	sub urxvt::term::scr_overlay {	623	#sub urxvt::term::scr_overlay {
527	die;
528	my ($self, $x, $y, $text) = @_;	624	# my ($self, $x, $y, $text) = @_;
529		625	#
530	my @lines = split /\n/, $text;	626	# my @lines = split /\n/, $text;
531		627	#
532	my $w = 0;	628	# my $w = 0;
533	for (map $self->strwidth ($_), @lines) {	629	# for (map $self->strwidth ($_), @lines) {
534	$w = $_ if $w < $_;	630	# $w = $_ if $w < $_;
535	}	631	# }
536		632	#
537	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	633	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
538	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	634	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
539	}	635	#}
540		636
541	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	637	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
542		638
543	Create a new (empty) overlay at the given position with the given	639	Create a new (empty) overlay at the given position with the given
544	width/height. C<$rstyle> defines the initial rendition style	640	width/height. C<$rstyle> defines the initial rendition style
…		…
571		667
572	If hidden, display the overlay again.	668	If hidden, display the overlay again.
573		669
574	=back	670	=back
575		671
576	=item $cellwidth = $term->strwidth $string	672	=item $cellwidth = $term->strwidth ($string)
577		673
578	Returns the number of screen-cells this string would need. Correctly	674	Returns the number of screen-cells this string would need. Correctly
579	accounts for wide and combining characters.	675	accounts for wide and combining characters.
580		676
581	=item $octets = $term->locale_encode $string	677	=item $octets = $term->locale_encode ($string)
582		678
583	Convert the given text string into the corresponding locale encoding.	679	Convert the given text string into the corresponding locale encoding.
584		680
585	=item $string = $term->locale_decode $octets	681	=item $string = $term->locale_decode ($octets)
586		682
587	Convert the given locale-encoded octets into a perl string.	683	Convert the given locale-encoded octets into a perl string.
		684
		685	=item $term->scr_add_lines ($string)
		686
		687	Write the given text string to the screen, as if output by the application
		688	running inside the terminal. It may not contain command sequences (escape
		689	codes), but is free to use line feeds, carriage returns and tabs. The
		690	string is a normal text string, not in locale-dependent encoding.
		691
		692	Normally its not a good idea to use this function, as programs might be
		693	confused by changes in cursor position or scrolling. Its useful inside a
		694	C<on_add_lines> hook, though.
		695
		696	=item $term->cmd_parse ($octets)
		697
		698	Similar to C<scr_add_lines>, but the argument must be in the
		699	locale-specific encoding of the terminal and can contain command sequences
		700	(escape codes) that will be interpreted.
588		701
589	=item $term->tt_write ($octets)	702	=item $term->tt_write ($octets)
590		703
591	Write the octets given in C<$data> to the tty (i.e. as program input). To	704	Write the octets given in C<$data> to the tty (i.e. as program input). To
592	pass characters instead of octets, you should convert your strings first	705	pass characters instead of octets, you should convert your strings first
593	to the locale-specific encoding using C<< $term->locale_encode >>.	706	to the locale-specific encoding using C<< $term->locale_encode >>.
		707
		708	=item $windowid = $term->parent
		709
		710	Return the window id of the toplevel window.
		711
		712	=item $windowid = $term->vt
		713
		714	Return the window id of the terminal window.
594		715
595	=item $window_width = $term->width	716	=item $window_width = $term->width
596		717
597	=item $window_height = $term->height	718	=item $window_height = $term->height
598		719
…		…
687	about the logical line that row C<$row_number> is part of. It supports the	808	about the logical line that row C<$row_number> is part of. It supports the
688	following methods:	809	following methods:
689		810
690	=over 4	811	=over 4
691		812
692	=item $text = $line->t	813	=item $text = $line->t ([$new_text])
693		814
694	Returns the full text of the line, similar to C<ROW_t>	815	Returns or replaces the full text of the line, similar to C<ROW_t>
695		816
696	=item $rend = $line->r	817	=item $rend = $line->r ([$new_rend])
697		818
698	Returns the full rendition array of the line, similar to C<ROW_r>	819	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
699		820
700	=item $length = $line->l	821	=item $length = $line->l
701		822
702	Returns the length of the line in cells, similar to C<ROW_l>.	823	Returns the length of the line in cells, similar to C<ROW_l>.
703		824
…		…
732		853
733	bless {	854	bless {
734	term => $self,	855	term => $self,
735	beg => $beg,	856	beg => $beg,
736	end => $end,	857	end => $end,
		858	ncol => $self->ncol,
737	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	859	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
738	}, urxvt::line::	860	}, urxvt::line::
739	}	861	}
740		862
741	sub urxvt::line::t {	863	sub urxvt::line::t {
742	my ($self) = @_;	864	my ($self) = @_;
743		865
		866	if (@_ > 1)
		867	{
		868	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		869	for $self->{beg} .. $self->{end};
		870	}
		871
		872	defined wantarray &&
744	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	873	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
745	0, $self->{len}	874	0, $self->{len}
746	}	875	}
747		876
748	sub urxvt::line::r {	877	sub urxvt::line::r {
749	my ($self) = @_;	878	my ($self) = @_;
750		879
		880	if (@_ > 1)
		881	{
		882	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		883	for $self->{beg} .. $self->{end};
		884	}
		885
		886	if (defined wantarray) {
751	my $rend = [	887	my $rend = [
752	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	888	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
753	];	889	];
754	$#$rend = $self->{len} - 1;	890	$#$rend = $self->{len} - 1;
755	$rend	891	return $rend;
		892	}
		893
		894	()
756	}	895	}
757		896
758	sub urxvt::line::beg { $_[0]{beg} }	897	sub urxvt::line::beg { $_[0]{beg} }
759	sub urxvt::line::end { $_[0]{end} }	898	sub urxvt::line::end { $_[0]{end} }
760	sub urxvt::line::l { $_[0]{len} }	899	sub urxvt::line::l { $_[0]{len} }
761		900
762	sub urxvt::line::offset_of {	901	sub urxvt::line::offset_of {
763	my ($self, $row, $col) = @_;	902	my ($self, $row, $col) = @_;
764		903
765	($row - $self->{beg}) * $self->{term}->ncol + $col	904	($row - $self->{beg}) * $self->{ncol} + $col
766	}	905	}
767		906
768	sub urxvt::line::coord_of {	907	sub urxvt::line::coord_of {
769	my ($self, $offset) = @_;	908	my ($self, $offset) = @_;
770		909
771	use integer;	910	use integer;
772		911
773	(	912	(
774	$offset / $self->{term}->ncol + $self->{beg},	913	$offset / $self->{ncol} + $self->{beg},
775	$offset % $self->{term}->ncol	914	$offset % $self->{ncol}
776	)	915	)
777	}	916	}
778		917
779	=item ($row, $col) = $line->coord_of ($offset)	918	=item ($row, $col) = $line->coord_of ($offset)
780	=item $text = $term->special_encode $string	919	=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.32 by root, Wed Jan 4 21:37:55 2006 UTC vs. Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.44 by root, Sat Jan 7 19:29:17 2006 UTC