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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC vs.
Revision 1.26 by root, Tue Jan 3 21:22:22 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 extension tries to be more intelligent when
		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>.
		48
		49	It also offers the following bindable event:
45		50
46	=over 4	51	=over 4
47		52
48	=item rot13	53	=item rot13
49		54
…		…
52	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
53		58
54	=back	59	=back
55		60
56	=item digital-clock	61	=item digital-clock
		62
		63	Displays a digital clock using the built-in overlay.
		64
		65	=item example-refresh-hooks
57		66
58	Displays a very simple digital clock in the upper right corner of the	67	Displays a very simple digital clock in the upper right corner of the
59	window. Illustrates overwriting the refresh callbacks to create your own	68	window. Illustrates overwriting the refresh callbacks to create your own
60	overlays or changes.	69	overlays or changes.
61		70
62	=item simple-overlay-clock
63
64	Displays a digital clock using the built-in overlay (colourful, useless).
65
66	=back	71	=back
67		72
68	=head2 General API Considerations	73	=head2 General API Considerations
69		74
70	All objects (such as terminals, time watchers etc.) are typical	75	All objects (such as terminals, time watchers etc.) are typical
71	reference-to-hash objects. The hash can be used to store anything you	76	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	77	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	78	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
74	modified).	79	modified).
75		80
76	When objects are destroyed on the C++ side, the perl object hashes are	81	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	82	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	83	the like inside the terminal object so they get destroyed as soon as the
79	terminal is destroyed.	84	terminal is destroyed.
80		85
81	=head2 Hooks	86	=head2 Hooks
82		87
83	The following subroutines can be declared in loaded scripts, and will be called	88	The following subroutines can be declared in loaded scripts, and will be
84	whenever the relevant event happens.	89	called whenever the relevant event happens.
		90
		91	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
		93	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>
		95	member.
85		96
86	All of them must return a boolean value. If it is true, then the event	97	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,	98	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.	99	and the relevant action might not be carried out by the C++ code.
89		100
…		…
121	Called whenever a selection has been copied, but before the selection is	132	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	133	requested from the server. The selection text can be queried and changed
123	by calling C<< $term->selection >>.	134	by calling C<< $term->selection >>.
124		135
125	Returning a true value aborts selection grabbing. It will still be hilighted.	136	Returning a true value aborts selection grabbing. It will still be hilighted.
		137
		138	=item on_sel_extend $term
		139
		140	Called whenever the user tries to extend the selection (e.g. with a double
		141	click) and is either supposed to return false (normal operation), or
		142	should extend the selection itelf and return true to suppress the built-in
		143	processing.
		144
		145	See the F<selection> example extension.
126		146
127	=item on_focus_in $term	147	=item on_focus_in $term
128		148
129	Called whenever the window gets the keyboard focus, before urxvt does	149	Called whenever the window gets the keyboard focus, before urxvt does
130	focus in processing.	150	focus in processing.
…		…
171	C<perl:string> action bound to it (see description of the B<keysym>	191	C<perl:string> action bound to it (see description of the B<keysym>
172	resource in the @@RXVT_NAME@@(1) manpage).	192	resource in the @@RXVT_NAME@@(1) manpage).
173		193
174	=back	194	=back
175		195
		196	=head2 Variables in the C<urxvt> Package
		197
		198	=over 4
		199
		200	=item $urxvt::TERM
		201
		202	The current terminal. Whenever a callback/Hook is bein executed, this
		203	variable stores the current C<urxvt::term> object.
		204
		205	=back
		206
176	=head2 Functions in the C<urxvt> Package	207	=head2 Functions in the C<urxvt> Package
177		208
178	=over 4	209	=over 4
179		210
180	=item urxvt::fatal $errormessage	211	=item urxvt::fatal $errormessage
…		…
193	correct place, e.g. on stderr of the connecting urxvtc client.	224	correct place, e.g. on stderr of the connecting urxvtc client.
194		225
195	=item $time = urxvt::NOW	226	=item $time = urxvt::NOW
196		227
197	Returns the "current time" (as per the event loop).	228	Returns the "current time" (as per the event loop).
		229
		230	=back
198		231
199	=head2 RENDITION	232	=head2 RENDITION
200		233
201	Rendition bitsets contain information about colour, font, font styles and	234	Rendition bitsets contain information about colour, font, font styles and
202	similar information for each screen cell.	235	similar information for each screen cell.
…		…
251	=cut	284	=cut
252		285
253	package urxvt;	286	package urxvt;
254		287
255	use strict;	288	use strict;
		289	use Scalar::Util ();
256		290
257	our $term;	291	our $TERM;
258	our @HOOKNAME;	292	our @HOOKNAME;
259	our $LIBDIR;	293	our $LIBDIR;
260		294
261	BEGIN {	295	BEGIN {
262	urxvt->bootstrap;	296	urxvt->bootstrap;
…		…
287	my $name = $HOOKNAME[$htype];	321	my $name = $HOOKNAME[$htype];
288		322
289	my $ref = $pkg->can ("on_" . lc $name)	323	my $ref = $pkg->can ("on_" . lc $name)
290	or next;	324	or next;
291		325
292	$term->{_hook}[$htype]{$ref*1} = $ref;	326	$TERM->{_hook}[$htype]{$pkg} = $ref;
293	$hook_count[$htype]++	327	$hook_count[$htype]++
294	or set_should_invoke $htype, 1;	328	or set_should_invoke $htype, 1;
295	}	329	}
296	}	330	}
297		331
…		…
321	}	355	}
322	}	356	}
323		357
324	# called by the rxvt core	358	# called by the rxvt core
325	sub invoke {	359	sub invoke {
326	local $term = shift;	360	local $TERM = shift;
327	my $htype = shift;	361	my $htype = shift;
328		362
329	if ($htype == 0) { # INIT	363	if ($htype == 0) { # INIT
330	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	364	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
331		365
332	for my $ext (split /:/, $term->resource ("perl_ext")) {	366	for my $ext (split /:/, $TERM->resource ("perl_ext")) {
333	my @files = grep -f $_, map "$_/$ext", @dirs;	367	my @files = grep -f $_, map "$_/$ext", @dirs;
334		368
335	if (@files) {	369	if (@files) {
336	register_package script_package $files[0];	370	register_package script_package $files[0];
337	} else {	371	} else {
338	warn "perl extension '$ext' not found in perl library search path\n";	372	warn "perl extension '$ext' not found in perl library search path\n";
339	}	373	}
340	}	374	}
341		375
342	} elsif ($htype == 1) { # DESTROY	376	} elsif ($htype == 1) { # DESTROY
343	if (my $hook = $term->{_hook}) {	377	if (my $hook = $TERM->{_hook}) {
344	for my $htype (0..$#$hook) {	378	for my $htype (0..$#$hook) {
345	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	379	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
346	or set_should_invoke $htype, 0;	380	or set_should_invoke $htype, 0;
347	}	381	}
348	}	382	}
349	}	383	}
350		384
351	my $cb = $term->{_hook}[$htype]	385	my $cb = $TERM->{_hook}[$htype]
352	or return;	386	or return;
353		387
354	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	388	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
355	if $verbosity >= 10;	389	if $verbosity >= 10;
356		390
		391	keys %$cb;
		392
357	while (my ($k, $v) = each %$cb) {	393	while (my ($pkg, $cb) = each %$cb) {
358	return 1 if $v->($term, @_);	394	return 1
		395	if $cb->(
		396	$TERM->{$pkg} \|\|= do {
		397	my $proxy = bless { }, urxvt::term::proxy::;
		398	Scalar::Util::weaken ($proxy->{term} = $TERM);
		399	$proxy
		400	},
		401	@_,
		402	);
359	}	403	}
360		404
361	0	405	0
362	}	406	}
363		407
364	=back	408	sub urxvt::term::proxy::AUTOLOAD {
		409	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		410	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		411
		412	eval qq{
		413	sub $urxvt::term::proxy::AUTOLOAD {
		414	my \$proxy = shift;
		415	\$proxy->{term}->$1 (\@_)
		416	}
		417	1
		418	} or die "FATAL: unable to compile method forwarder: $@";
		419
		420	goto &$urxvt::term::proxy::AUTOLOAD;
		421	}
365		422
366	=head2 The C<urxvt::term> Class	423	=head2 The C<urxvt::term> Class
367		424
368	=over 4	425	=over 4
369		426
…		…
425		482
426	=item $oldtext = $term->selection ([$newtext])	483	=item $oldtext = $term->selection ([$newtext])
427		484
428	Return the current selection text and optionally replace it by C<$newtext>.	485	Return the current selection text and optionally replace it by C<$newtext>.
429		486
430	=item $term->scr_overlay ($x, $y, $text)	487	#=item $term->overlay ($x, $y, $text)
431		488	#
432	Create a simple multi-line overlay box. See the next method for details.	489	#Create a simple multi-line overlay box. See the next method for details.
433		490	#
434	=cut	491	#=cut
435		492
436	sub urxvt::term::scr_overlay {	493	sub urxvt::term::scr_overlay {
		494	die;
437	my ($self, $x, $y, $text) = @_;	495	my ($self, $x, $y, $text) = @_;
438		496
439	my @lines = split /\n/, $text;	497	my @lines = split /\n/, $text;
440		498
441	my $w = 0;	499	my $w = 0;
…		…
445		503
446	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	504	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
447	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	505	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
448	}	506	}
449		507
450	=item $term->scr_overlay_new ($x, $y, $width, $height)	508	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
451		509
452	Create a new (empty) overlay at the given position with the given	510	Create a new (empty) overlay at the given position with the given
453	width/height. A border will be put around the box. If either C<$x> or	511	width/height. C<$rstyle> defines the initial rendition style
454	C<$y> is negative, then this is counted from the right/bottom side,	512	(default: C<OVERLAY_RSTYLE>).
455	respectively.
456		513
457	=item $term->scr_overlay_off	514	If C<$border> is C<2> (default), then a decorative border will be put
		515	around the box.
458		516
459	Switch the overlay off again.	517	If either C<$x> or C<$y> is negative, then this is counted from the
		518	right/bottom side, respectively.
460		519
461	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	520	This method returns an urxvt::overlay object. The overlay will be visible
		521	as long as the perl object is referenced.
462		522
463	Put a single character (specified numerically) at the given overlay	523	The methods currently supported on C<urxvt::overlay> objects are:
464	position.
465		524
		525	=over 4
		526
466	=item $term->scr_overlay_set ($x, $y, $text)	527	=item $overlay->set ($x, $y, $text, $rend)
467		528
468	Write a string at the given position into the overlay.	529	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		530	text in rxvt-unicode's special encoding and an array of rendition values
		531	at a specific position inside the overlay.
		532
		533	=item $overlay->hide
		534
		535	If visible, hide the overlay, but do not destroy it.
		536
		537	=item $overlay->show
		538
		539	If hidden, display the overlay again.
		540
		541	=back
469		542
470	=item $cellwidth = $term->strwidth $string	543	=item $cellwidth = $term->strwidth $string
471		544
472	Returns the number of screen-cells this string would need. Correctly	545	Returns the number of screen-cells this string would need. Correctly
473	accounts for wide and combining characters.	546	accounts for wide and combining characters.
…		…
514	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	587	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
515		588
516	Returns the text of the entire row with number C<$row_number>. Row C<0>	589	Returns the text of the entire row with number C<$row_number>. Row C<0>
517	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	590	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
518	terminal line. The scrollback buffer starts at line C<-1> and extends to	591	terminal line. The scrollback buffer starts at line C<-1> and extends to
519	line C<< -$term->nsaved >>.	592	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		593	is requested.
520		594
521	If C<$new_text> is specified, it will replace characters in the current	595	If C<$new_text> is specified, it will replace characters in the current
522	line, starting at column C<$start_col> (default C<0>), which is useful	596	line, starting at column C<$start_col> (default C<0>), which is useful
523	to replace only parts of a line. The font index in the rendition will	597	to replace only parts of a line. The font index in the rendition will
524	automatically be updated.	598	automatically be updated.
…		…
546		620
547	See the section on RENDITION, above.	621	See the section on RENDITION, above.
548		622
549	=item $length = $term->ROW_l ($row_number[, $new_length])	623	=item $length = $term->ROW_l ($row_number[, $new_length])
550		624
551	Returns the number of screen cells that are in use ("the line length"). If	625	Returns the number of screen cells that are in use ("the line
552	it is C<-1>, then the line is part of a multiple-row logical "line", which	626	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
553	means all characters are in use and it is continued on the next row.	627	line is joined with the following one.
554		628
		629	=item $bool = $term->is_longer ($row_number)
		630
		631	Returns true if the row is part of a multiple-row logical "line" (i.e.
		632	joined with the following row), which means all characters are in use
		633	and it is continued on the next row (and possibly a continuation of the
		634	previous row(s)).
		635
		636	=item $line = $term->line ($row_number)
		637
		638	Create and return a new C<urxvt::line> object that stores information
		639	about the logical line that row C<$row_number> is part of. It supports the
		640	following methods:
		641
		642	=over 4
		643
		644	=item $text = $line->t
		645
		646	Returns the full text of the line, similar to C<ROW_t>
		647
		648	=item $rend = $line->r
		649
		650	Returns the full rendition array of the line, similar to C<ROW_r>
		651
		652	=item $length = $line->l
		653
		654	Returns the length of the line in cells, similar to C<ROW_l>.
		655
		656	=item $rownum = $line->beg
		657
		658	=item $rownum = $line->end
		659
		660	Return the row number of the first/last row of the line, respectively.
		661
		662	=item $offset = $line->offset_of ($row, $col)
		663
		664	Returns the character offset of the given row\|col pair within the logical
		665	line.
		666
		667	=item ($row, $col) = $line->coord_of ($offset)
		668
		669	Translates a string offset into terminal coordinates again.
		670
		671	=back
		672
		673	=cut
		674
		675	sub urxvt::term::line {
		676	my ($self, $row) = @_;
		677
		678	my $maxrow = $self->nrow - 1;
		679
		680	my ($beg, $end) = ($row, $row);
		681
		682	--$beg while $self->ROW_is_longer ($beg - 1);
		683	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		684
		685	bless {
		686	term => $self,
		687	beg => $beg,
		688	end => $end,
		689	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		690	}, urxvt::line::
		691	}
		692
		693	sub urxvt::line::t {
		694	my ($self) = @_;
		695
		696	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		697	0, $self->{len}
		698	}
		699
		700	sub urxvt::line::r {
		701	my ($self) = @_;
		702
		703	my $rend = [
		704	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		705	];
		706	$#$rend = $self->{len} - 1;
		707	$rend
		708	}
		709
		710	sub urxvt::line::beg { $_[0]{beg} }
		711	sub urxvt::line::end { $_[0]{end} }
		712	sub urxvt::line::l { $_[0]{len} }
		713
		714	sub urxvt::line::offset_of {
		715	my ($self, $row, $col) = @_;
		716
		717	($row - $self->{beg}) * $self->{term}->ncol + $col
		718	}
		719
		720	sub urxvt::line::coord_of {
		721	my ($self, $offset) = @_;
		722
		723	use integer;
		724
		725	(
		726	$offset / $self->{term}->ncol + $self->{beg},
		727	$offset % $self->{term}->ncol
		728	)
		729	}
		730
		731	=item ($row, $col) = $line->coord_of ($offset)
555	=item $text = $term->special_encode $string	732	=item $text = $term->special_encode $string
556		733
557	Converts a perl string into the special encoding used by rxvt-unicode,	734	Converts a perl string into the special encoding used by rxvt-unicode,
558	where one character corresponds to one screen cell. See	735	where one character corresponds to one screen cell. See
559	C<< $term->ROW_t >> for details.	736	C<< $term->ROW_t >> for details.
…		…
568	=head2 The C<urxvt::timer> Class	745	=head2 The C<urxvt::timer> Class
569		746
570	This class implements timer watchers/events. Time is represented as a	747	This class implements timer watchers/events. Time is represented as a
571	fractional number of seconds since the epoch. Example:	748	fractional number of seconds since the epoch. Example:
572		749
573	# create a digital clock display in upper right corner	750	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
574	$term->{timer} = urxvt::timer	751	$term->{timer} = urxvt::timer
575	->new	752	->new
576	->start (urxvt::NOW)	753	->interval (1)
577	->cb (sub {	754	->cb (sub {
578	my ($timer) = @_;
579	my $time = $timer->at;
580	$timer->start ($time + 1);
581	$self->scr_overlay (-1, 0,	755	$term->{overlay}->set (0, 0,
582	POSIX::strftime "%H:%M:%S", localtime $time);	756	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
583	});	757	});
584		758
585	=over 4	759	=over 4
586		760
587	=item $timer = new urxvt::timer	761	=item $timer = new urxvt::timer
588		762
589	Create a new timer object in stopped state.	763	Create a new timer object in started state. It is scheduled to fire
		764	immediately.
590		765
591	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	766	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
592		767
593	Set the callback to be called when the timer triggers.	768	Set the callback to be called when the timer triggers.
594		769
…		…
597	Return the time this watcher will fire next.	772	Return the time this watcher will fire next.
598		773
599	=item $timer = $timer->set ($tstamp)	774	=item $timer = $timer->set ($tstamp)
600		775
601	Set the time the event is generated to $tstamp.	776	Set the time the event is generated to $tstamp.
		777
		778	=item $timer = $timer->interval ($interval)
		779
		780	Normally (and when C<$interval> is C<0>), the timer will automatically
		781	stop after it has fired once. If C<$interval> is non-zero, then the timer
		782	is automatically rescheduled at the given intervals.
602		783
603	=item $timer = $timer->start	784	=item $timer = $timer->start
604		785
605	Start the timer.	786	Start the timer.
606		787

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC vs. Revision 1.26 by root, Tue Jan 3 21:22:22 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.19 by root, Tue Jan 3 02:42:17 2006 UTC vs.
Revision 1.26 by root, Tue Jan 3 21:22:22 2006 UTC