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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC

…		…
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection
43		43
44	Miscellaneous selection modifications.	44	Intelligent selection. This etxension tries to be more intelligent when the user
		45	extends selections (double-click).
		46
		47	It also offers the following bindable event:
45		48
46	=over 4	49	=over 4
47		50
48	=item rot13	51	=item rot13
49		52
…		…
68	=head2 General API Considerations	71	=head2 General API Considerations
69		72
70	All objects (such as terminals, time watchers etc.) are typical	73	All objects (such as terminals, time watchers etc.) are typical
71	reference-to-hash objects. The hash can be used to store anything you	74	reference-to-hash objects. The hash can be used to store anything you
72	like. All members starting with an underscore (such as C<_ptr> or	75	like. All members starting with an underscore (such as C<_ptr> or
73	C<_hook>) are reserved for internal uses and must not be accessed or	76	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
74	modified).	77	modified).
75		78
76	When objects are destroyed on the C++ side, the perl object hashes are	79	When objects are destroyed on the C++ side, the perl object hashes are
77	emptied, so its best to store related objects such as time watchers and	80	emptied, so its best to store related objects such as time watchers and
78	the like inside the terminal object so they get destroyed as soon as the	81	the like inside the terminal object so they get destroyed as soon as the
79	terminal is destroyed.	82	terminal is destroyed.
80		83
81	=head2 Hooks	84	=head2 Hooks
82		85
83	The following subroutines can be declared in loaded scripts, and will be called	86	The following subroutines can be declared in loaded scripts, and will be
84	whenever the relevant event happens.	87	called whenever the relevant event happens.
		88
		89	The first argument passed to them is an object private to each terminal
		90	and extension package. You can call all C<urxvt::term> methods on it, but
		91	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		92	object that is shared between all packages is stored in the C<term>
		93	member.
85		94
86	All of them must return a boolean value. If it is true, then the event	95	All of them must return a boolean value. If it is true, then the event
87	counts as being I<consumed>, and the invocation of other hooks is skipped,	96	counts as being I<consumed>, and the invocation of other hooks is skipped,
88	and the relevant action might not be carried out by the C++ code.	97	and the relevant action might not be carried out by the C++ code.
89		98
…		…
121	Called whenever a selection has been copied, but before the selection is	130	Called whenever a selection has been copied, but before the selection is
122	requested from the server. The selection text can be queried and changed	131	requested from the server. The selection text can be queried and changed
123	by calling C<< $term->selection >>.	132	by calling C<< $term->selection >>.
124		133
125	Returning a true value aborts selection grabbing. It will still be hilighted.	134	Returning a true value aborts selection grabbing. It will still be hilighted.
		135
		136	=item on_sel_extend $term
		137
		138	Called whenever the user tries to extend the selection (e.g. with a double
		139	click) and is either supposed to return false (normal operation), or
		140	should extend the selection itelf and return true to suppress the built-in
		141	processing.
		142
		143	See the F<selection> example extension.
126		144
127	=item on_focus_in $term	145	=item on_focus_in $term
128		146
129	Called whenever the window gets the keyboard focus, before urxvt does	147	Called whenever the window gets the keyboard focus, before urxvt does
130	focus in processing.	148	focus in processing.
…		…
171	C<perl:string> action bound to it (see description of the B<keysym>	189	C<perl:string> action bound to it (see description of the B<keysym>
172	resource in the @@RXVT_NAME@@(1) manpage).	190	resource in the @@RXVT_NAME@@(1) manpage).
173		191
174	=back	192	=back
175		193
		194	=head2 Variables in the C<urxvt> Package
		195
		196	=over 4
		197
		198	=item $urxvt::TERM
		199
		200	The current terminal. Whenever a callback/Hook is bein executed, this
		201	variable stores the current C<urxvt::term> object.
		202
		203	=back
		204
176	=head2 Functions in the C<urxvt> Package	205	=head2 Functions in the C<urxvt> Package
177		206
178	=over 4	207	=over 4
179		208
180	=item urxvt::fatal $errormessage	209	=item urxvt::fatal $errormessage
…		…
253	=cut	282	=cut
254		283
255	package urxvt;	284	package urxvt;
256		285
257	use strict;	286	use strict;
		287	use Scalar::Util ();
258		288
259	our $term;	289	our $TERM;
260	our @HOOKNAME;	290	our @HOOKNAME;
261	our $LIBDIR;	291	our $LIBDIR;
262		292
263	BEGIN {	293	BEGIN {
264	urxvt->bootstrap;	294	urxvt->bootstrap;
…		…
289	my $name = $HOOKNAME[$htype];	319	my $name = $HOOKNAME[$htype];
290		320
291	my $ref = $pkg->can ("on_" . lc $name)	321	my $ref = $pkg->can ("on_" . lc $name)
292	or next;	322	or next;
293		323
294	$term->{_hook}[$htype]{$ref*1} = $ref;	324	$TERM->{_hook}[$htype]{$pkg} = $ref;
295	$hook_count[$htype]++	325	$hook_count[$htype]++
296	or set_should_invoke $htype, 1;	326	or set_should_invoke $htype, 1;
297	}	327	}
298	}	328	}
299		329
…		…
323	}	353	}
324	}	354	}
325		355
326	# called by the rxvt core	356	# called by the rxvt core
327	sub invoke {	357	sub invoke {
328	local $term = shift;	358	local $TERM = shift;
329	my $htype = shift;	359	my $htype = shift;
330		360
331	if ($htype == 0) { # INIT	361	if ($htype == 0) { # INIT
332	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
333		363
334	for my $ext (split /:/, $term->resource ("perl_ext")) {	364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {
335	my @files = grep -f $_, map "$_/$ext", @dirs;	365	my @files = grep -f $_, map "$_/$ext", @dirs;
336		366
337	if (@files) {	367	if (@files) {
338	register_package script_package $files[0];	368	register_package script_package $files[0];
339	} else {	369	} else {
340	warn "perl extension '$ext' not found in perl library search path\n";	370	warn "perl extension '$ext' not found in perl library search path\n";
341	}	371	}
342	}	372	}
343		373
344	} elsif ($htype == 1) { # DESTROY	374	} elsif ($htype == 1) { # DESTROY
345	if (my $hook = $term->{_hook}) {	375	if (my $hook = $TERM->{_hook}) {
346	for my $htype (0..$#$hook) {	376	for my $htype (0..$#$hook) {
347	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
348	or set_should_invoke $htype, 0;	378	or set_should_invoke $htype, 0;
349	}	379	}
350	}	380	}
351	}	381	}
352		382
353	my $cb = $term->{_hook}[$htype]	383	my $cb = $TERM->{_hook}[$htype]
354	or return;	384	or return;
355		385
356	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
357	if $verbosity >= 10;	387	if $verbosity >= 10;
358		388
		389	keys %$cb;
		390
359	while (my ($k, $v) = each %$cb) {	391	while (my ($pkg, $cb) = each %$cb) {
360	return 1 if $v->($term, @_);	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	);
361	}	401	}
362		402
363	0	403	0
		404	}
		405
		406	sub urxvt::term::proxy::AUTOLOAD {
		407	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		408	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		409
		410	eval qq{
		411	sub $urxvt::term::proxy::AUTOLOAD {
		412	my \$proxy = shift;
		413	\$proxy->{term}->$1 (\@_)
		414	}
		415	1
		416	} or die "FATAL: unable to compile method forwarder: $@";
		417
		418	goto &$urxvt::term::proxy::AUTOLOAD;
364	}	419	}
365		420
366	=head2 The C<urxvt::term> Class	421	=head2 The C<urxvt::term> Class
367		422
368	=over 4	423	=over 4
…		…
461	right/bottom side, respectively.	516	right/bottom side, respectively.
462		517
463	This method returns an urxvt::overlay object. The overlay will be visible	518	This method returns an urxvt::overlay object. The overlay will be visible
464	as long as the perl object is referenced.	519	as long as the perl object is referenced.
465		520
466	Currently, the only method on the C<urxvt::overlay> object is C<set>:	521	The methods currently supported on C<urxvt::overlay> objects are:
		522
		523	=over 4
467		524
468	=item $overlay->set ($x, $y, $text, $rend)	525	=item $overlay->set ($x, $y, $text, $rend)
469		526
470	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	527	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
471	text in rxvt-unicode's special encoding and an array of rendition values	528	text in rxvt-unicode's special encoding and an array of rendition values
472	at a specific position inside the overlay.	529	at a specific position inside the overlay.
473		530
		531	=item $overlay->hide
		532
		533	If visible, hide the overlay, but do not destroy it.
		534
		535	=item $overlay->show
		536
		537	If hidden, display the overlay again.
		538
		539	=back
		540
474	=item $cellwidth = $term->strwidth $string	541	=item $cellwidth = $term->strwidth $string
475		542
476	Returns the number of screen-cells this string would need. Correctly	543	Returns the number of screen-cells this string would need. Correctly
477	accounts for wide and combining characters.	544	accounts for wide and combining characters.
478		545
…		…
518	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	585	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
519		586
520	Returns the text of the entire row with number C<$row_number>. Row C<0>	587	Returns the text of the entire row with number C<$row_number>. Row C<0>
521	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	588	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
522	terminal line. The scrollback buffer starts at line C<-1> and extends to	589	terminal line. The scrollback buffer starts at line C<-1> and extends to
523	line C<< -$term->nsaved >>.	590	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		591	is requested.
524		592
525	If C<$new_text> is specified, it will replace characters in the current	593	If C<$new_text> is specified, it will replace characters in the current
526	line, starting at column C<$start_col> (default C<0>), which is useful	594	line, starting at column C<$start_col> (default C<0>), which is useful
527	to replace only parts of a line. The font index in the rendition will	595	to replace only parts of a line. The font index in the rendition will
528	automatically be updated.	596	automatically be updated.
…		…
550		618
551	See the section on RENDITION, above.	619	See the section on RENDITION, above.
552		620
553	=item $length = $term->ROW_l ($row_number[, $new_length])	621	=item $length = $term->ROW_l ($row_number[, $new_length])
554		622
555	Returns the number of screen cells that are in use ("the line length"). If	623	Returns the number of screen cells that are in use ("the line
556	it is C<-1>, then the line is part of a multiple-row logical "line", which	624	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
557	means all characters are in use and it is continued on the next row.	625	line is joined with the following one.
558		626
		627	=item $bool = $term->is_longer ($row_number)
		628
		629	Returns true if the row is part of a multiple-row logical "line" (i.e.
		630	joined with the following row), which means all characters are in use
		631	and it is continued on the next row (and possibly a continuation of the
		632	previous row(s)).
		633
		634	=item $line = $term->line ($row_number)
		635
		636	Create and return a new C<urxvt::line> object that stores information
		637	about the logical line that row C<$row_number> is part of. It supports the
		638	following methods:
		639
		640	=over 4
		641
		642	=item $text = $line->t
		643
		644	Returns the full text of the line, similar to C<ROW_t>
		645
		646	=item $rend = $line->r
		647
		648	Returns the full rendition array of the line, similar to C<ROW_r>
		649
		650	=item $length = $line->l
		651
		652	Returns the length of the line in cells, similar to C<ROW_l>.
		653
		654	=item $rownum = $line->beg
		655
		656	=item $rownum = $line->end
		657
		658	Return the row number of the first/last row of the line, respectively.
		659
		660	=item $offset = $line->offset_of ($row, $col)
		661
		662	Returns the character offset of the given row\|col pair within the logical
		663	line.
		664
		665	=item ($row, $col) = $line->coord_of ($offset)
		666
		667	Translates a string offset into terminal coordinates again.
		668
		669	=back
		670
		671	=cut
		672
		673	sub urxvt::term::line {
		674	my ($self, $row) = @_;
		675
		676	my $maxrow = $self->nrow - 1;
		677
		678	my ($beg, $end) = ($row, $row);
		679
		680	--$beg while $self->ROW_is_longer ($beg - 1);
		681	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		682
		683	bless {
		684	term => $self,
		685	beg => $beg,
		686	end => $end,
		687	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		688	}, urxvt::line::
		689	}
		690
		691	sub urxvt::line::t {
		692	my ($self) = @_;
		693
		694	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		695	0, $self->{len}
		696	}
		697
		698	sub urxvt::line::r {
		699	my ($self) = @_;
		700
		701	my $rend = [
		702	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		703	];
		704	$#$rend = $self->{len} - 1;
		705	$rend
		706	}
		707
		708	sub urxvt::line::beg { $_[0]{beg} }
		709	sub urxvt::line::end { $_[0]{end} }
		710	sub urxvt::line::l { $_[0]{len} }
		711
		712	sub urxvt::line::offset_of {
		713	my ($self, $row, $col) = @_;
		714
		715	($row - $self->{beg}) * $self->{term}->ncol + $col
		716	}
		717
		718	sub urxvt::line::coord_of {
		719	my ($self, $offset) = @_;
		720
		721	use integer;
		722
		723	(
		724	$offset / $self->{term}->ncol + $self->{beg},
		725	$offset % $self->{term}->ncol
		726	)
		727	}
		728
		729	=item ($row, $col) = $line->coord_of ($offset)
559	=item $text = $term->special_encode $string	730	=item $text = $term->special_encode $string
560		731
561	Converts a perl string into the special encoding used by rxvt-unicode,	732	Converts a perl string into the special encoding used by rxvt-unicode,
562	where one character corresponds to one screen cell. See	733	where one character corresponds to one screen cell. See
563	C<< $term->ROW_t >> for details.	734	C<< $term->ROW_t >> for details.

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC vs. Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC vs.
Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC