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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.18 by root, Tue Jan 3 02:01:27 2006 UTC vs.
Revision 1.24 by root, Tue Jan 3 20:47:36 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
…		…
52	URxvt.keysym.C-M-r: perl:selection:rot13	55	URxvt.keysym.C-M-r: perl:selection:rot13
53		56
54	=back	57	=back
55		58
56	=item digital-clock	59	=item digital-clock
		60
		61	Displays a digital clock using the built-in overlay.
		62
		63	=item example-refresh-hooks
57		64
58	Displays a very simple digital clock in the upper right corner of the	65	Displays a very simple digital clock in the upper right corner of the
59	window. Illustrates overwriting the refresh callbacks to create your own	66	window. Illustrates overwriting the refresh callbacks to create your own
60	overlays or changes.	67	overlays or changes.
61		68
62	=item simple-overlay-clock
63
64	Displays a digital clock using the built-in overlay (colourful, useless).
65
66	=back	69	=back
67		70
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
…		…
193	correct place, e.g. on stderr of the connecting urxvtc client.	222	correct place, e.g. on stderr of the connecting urxvtc client.
194		223
195	=item $time = urxvt::NOW	224	=item $time = urxvt::NOW
196		225
197	Returns the "current time" (as per the event loop).	226	Returns the "current time" (as per the event loop).
		227
		228	=back
198		229
199	=head2 RENDITION	230	=head2 RENDITION
200		231
201	Rendition bitsets contain information about colour, font, font styles and	232	Rendition bitsets contain information about colour, font, font styles and
202	similar information for each screen cell.	233	similar information for each screen cell.
…		…
218	Return the rendition mask used for overlays by default.	249	Return the rendition mask used for overlays by default.
219		250
220	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	251	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
221		252
222	Return the bit that enabled bold, italic, blink, reverse-video and	253	Return the bit that enabled bold, italic, blink, reverse-video and
223	underline, respectively. To enable such a style, just or it onto the	254	underline, respectively. To enable such a style, just logically OR it into
224	bitset.	255	the bitset.
225		256
226	=item $foreground = urxvt::GET_BASEFG $rend	257	=item $foreground = urxvt::GET_BASEFG $rend
227		258
228	=item $background = urxvt::GET_BASEBG $rend	259	=item $background = urxvt::GET_BASEBG $rend
229		260
…		…
234	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	265	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
235		266
236	Replace the foreground/background colour in the rendition mask with the	267	Replace the foreground/background colour in the rendition mask with the
237	specified one.	268	specified one.
238		269
		270	=item $value = urxvt::GET_CUSTOM ($rend)
		271
		272	Return the "custom" value: Every rendition has 5 bits for use by
		273	extensions. They can be set and changed as you like and are initially
		274	zero.
		275
		276	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		277
		278	Change the custom value.
		279
239	=back	280	=back
240		281
241	=cut	282	=cut
242		283
243	package urxvt;	284	package urxvt;
244		285
245	use strict;	286	use strict;
		287	use Scalar::Util ();
246		288
247	our $term;	289	our $TERM;
248	our @HOOKNAME;	290	our @HOOKNAME;
249	our $LIBDIR;	291	our $LIBDIR;
250		292
251	BEGIN {	293	BEGIN {
252	urxvt->bootstrap;	294	urxvt->bootstrap;
…		…
277	my $name = $HOOKNAME[$htype];	319	my $name = $HOOKNAME[$htype];
278		320
279	my $ref = $pkg->can ("on_" . lc $name)	321	my $ref = $pkg->can ("on_" . lc $name)
280	or next;	322	or next;
281		323
282	$term->{_hook}[$htype]{$ref*1} = $ref;	324	$TERM->{_hook}[$htype]{$pkg} = $ref;
283	$hook_count[$htype]++	325	$hook_count[$htype]++
284	or set_should_invoke $htype, 1;	326	or set_should_invoke $htype, 1;
285	}	327	}
286	}	328	}
287		329
…		…
311	}	353	}
312	}	354	}
313		355
314	# called by the rxvt core	356	# called by the rxvt core
315	sub invoke {	357	sub invoke {
316	local $term = shift;	358	local $TERM = shift;
317	my $htype = shift;	359	my $htype = shift;
318		360
319	if ($htype == 0) { # INIT	361	if ($htype == 0) { # INIT
320	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
321		363
322	for my $ext (split /:/, $term->resource ("perl_ext")) {	364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {
323	my @files = grep -f $_, map "$_/$ext", @dirs;	365	my @files = grep -f $_, map "$_/$ext", @dirs;
324		366
325	if (@files) {	367	if (@files) {
326	register_package script_package $files[0];	368	register_package script_package $files[0];
327	} else {	369	} else {
328	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";
329	}	371	}
330	}	372	}
331		373
332	} elsif ($htype == 1) { # DESTROY	374	} elsif ($htype == 1) { # DESTROY
333	if (my $hook = $term->{_hook}) {	375	if (my $hook = $TERM->{_hook}) {
334	for my $htype (0..$#$hook) {	376	for my $htype (0..$#$hook) {
335	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
336	or set_should_invoke $htype, 0;	378	or set_should_invoke $htype, 0;
337	}	379	}
338	}	380	}
339	}	381	}
340		382
341	my $cb = $term->{_hook}[$htype]	383	my $cb = $TERM->{_hook}[$htype]
342	or return;	384	or return;
343		385
344	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
345	if $verbosity >= 10;	387	if $verbosity >= 10;
346		388
347	while (my ($k, $v) = each %$cb) {	389	while (my ($pkg, $cb) = each %$cb) {
348	return 1 if $v->($term, @_);	390	return 1
		391	if $cb->(
		392	$TERM->{$pkg} \|\|= do {
		393	my $proxy = bless { }, urxvt::term::proxy::;
		394	Scalar::Util::weaken ($proxy->{term} = $TERM);
		395	$proxy
		396	},
		397	@_,
		398	);
349	}	399	}
350		400
351	0	401	0
352	}	402	}
353		403
354	=back	404	sub urxvt::term::proxy::AUTOLOAD {
		405	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		406	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		407
		408	eval qq{
		409	sub $urxvt::term::proxy::AUTOLOAD {
		410	my \$proxy = shift;
		411	\$proxy->{term}->$1 (\@_)
		412	}
		413	1
		414	} or die "FATAL: unable to compile method forwarder: $@";
		415
		416	goto &$urxvt::term::proxy::AUTOLOAD;
		417	}
355		418
356	=head2 The C<urxvt::term> Class	419	=head2 The C<urxvt::term> Class
357		420
358	=over 4	421	=over 4
359		422
…		…
415		478
416	=item $oldtext = $term->selection ([$newtext])	479	=item $oldtext = $term->selection ([$newtext])
417		480
418	Return the current selection text and optionally replace it by C<$newtext>.	481	Return the current selection text and optionally replace it by C<$newtext>.
419		482
420	=item $term->scr_overlay ($x, $y, $text)	483	#=item $term->overlay ($x, $y, $text)
421		484	#
422	Create a simple multi-line overlay box. See the next method for details.	485	#Create a simple multi-line overlay box. See the next method for details.
423		486	#
424	=cut	487	#=cut
425		488
426	sub urxvt::term::scr_overlay {	489	sub urxvt::term::scr_overlay {
		490	die;
427	my ($self, $x, $y, $text) = @_;	491	my ($self, $x, $y, $text) = @_;
428		492
429	my @lines = split /\n/, $text;	493	my @lines = split /\n/, $text;
430		494
431	my $w = 0;	495	my $w = 0;
…		…
435		499
436	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	500	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
437	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	501	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
438	}	502	}
439		503
440	=item $term->scr_overlay_new ($x, $y, $width, $height)	504	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
441		505
442	Create a new (empty) overlay at the given position with the given	506	Create a new (empty) overlay at the given position with the given
443	width/height. A border will be put around the box. If either C<$x> or	507	width/height. C<$rstyle> defines the initial rendition style
444	C<$y> is negative, then this is counted from the right/bottom side,	508	(default: C<OVERLAY_RSTYLE>).
445	respectively.
446		509
447	=item $term->scr_overlay_off	510	If C<$border> is C<2> (default), then a decorative border will be put
		511	around the box.
448		512
449	Switch the overlay off again.	513	If either C<$x> or C<$y> is negative, then this is counted from the
		514	right/bottom side, respectively.
450		515
451	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	516	This method returns an urxvt::overlay object. The overlay will be visible
		517	as long as the perl object is referenced.
452		518
453	Put a single character (specified numerically) at the given overlay	519	The methods currently supported on C<urxvt::overlay> objects are:
454	position.
455		520
		521	=over 4
		522
456	=item $term->scr_overlay_set ($x, $y, $text)	523	=item $overlay->set ($x, $y, $text, $rend)
457		524
458	Write a string at the given position into the overlay.	525	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		526	text in rxvt-unicode's special encoding and an array of rendition values
		527	at a specific position inside the overlay.
		528
		529	=item $overlay->hide
		530
		531	If visible, hide the overlay, but do not destroy it.
		532
		533	=item $overlay->show
		534
		535	If hidden, display the overlay again.
		536
		537	=back
459		538
460	=item $cellwidth = $term->strwidth $string	539	=item $cellwidth = $term->strwidth $string
461		540
462	Returns the number of screen-cells this string would need. Correctly	541	Returns the number of screen-cells this string would need. Correctly
463	accounts for wide and combining characters.	542	accounts for wide and combining characters.
…		…
504	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	583	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
505		584
506	Returns the text of the entire row with number C<$row_number>. Row C<0>	585	Returns the text of the entire row with number C<$row_number>. Row C<0>
507	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	586	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
508	terminal line. The scrollback buffer starts at line C<-1> and extends to	587	terminal line. The scrollback buffer starts at line C<-1> and extends to
509	line C<< -$term->nsaved >>.	588	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		589	is requested.
510		590
511	If C<$new_text> is specified, it will replace characters in the current	591	If C<$new_text> is specified, it will replace characters in the current
512	line, starting at column C<$start_col> (default C<0>), which is useful	592	line, starting at column C<$start_col> (default C<0>), which is useful
513	to replace only parts of a line. The font index in the rendition will	593	to replace only parts of a line. The font index in the rendition will
514	automatically be updated.	594	automatically be updated.
…		…
536		616
537	See the section on RENDITION, above.	617	See the section on RENDITION, above.
538		618
539	=item $length = $term->ROW_l ($row_number[, $new_length])	619	=item $length = $term->ROW_l ($row_number[, $new_length])
540		620
541	Returns the number of screen cells that are in use ("the line length"). If	621	Returns the number of screen cells that are in use ("the line
542	it is C<-1>, then the line is part of a multiple-row logical "line", which	622	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
543	means all characters are in use and it is continued on the next row.	623	line is joined with the following one.
544		624
		625	=item $bool = $term->is_longer ($row_number)
		626
		627	Returns true if the row is part of a multiple-row logical "line" (i.e.
		628	joined with the following row), which means all characters are in use
		629	and it is continued on the next row (and possibly a continuation of the
		630	previous row(s)).
		631
		632	=item $line = $term->line ($row_number)
		633
		634	Create and return a new C<urxvt::line> object that stores information
		635	about the logical line that row C<$row_number> is part of. It supports the
		636	following methods:
		637
		638	=over 4
		639
		640	=item $text = $line->t
		641
		642	Returns the full text of the line, similar to C<ROW_t>
		643
		644	=item $rend = $line->r
		645
		646	Returns the full rendition array of the line, similar to C<ROW_r>
		647
		648	=item $length = $line->l
		649
		650	Returns the length of the line in cells, similar to C<ROW_l>.
		651
		652	=item $rownum = $line->beg
		653
		654	=item $rownum = $line->end
		655
		656	Return the row number of the first/last row of the line, respectively.
		657
		658	=item $offset = $line->offset_of ($row, $col)
		659
		660	Returns the character offset of the given row\|col pair within the logical
		661	line.
		662
		663	=item ($row, $col) = $line->coord_of ($offset)
		664
		665	Translates a string offset into terminal coordinates again.
		666
		667	=back
		668
		669	=cut
		670
		671	sub urxvt::term::line {
		672	my ($self, $row) = @_;
		673
		674	my $maxrow = $self->nrow - 1;
		675
		676	my ($beg, $end) = ($row, $row);
		677
		678	--$beg while $self->ROW_is_longer ($beg - 1);
		679	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		680
		681	bless {
		682	term => $self,
		683	beg => $beg,
		684	end => $end,
		685	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		686	}, urxvt::line::
		687	}
		688
		689	sub urxvt::line::t {
		690	my ($self) = @_;
		691
		692	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		693	0, $self->{len}
		694	}
		695
		696	sub urxvt::line::r {
		697	my ($self) = @_;
		698
		699	my $rend = [
		700	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		701	];
		702	$#$rend = $self->{len} - 1;
		703	$rend
		704	}
		705
		706	sub urxvt::line::beg { $_[0]{beg} }
		707	sub urxvt::line::end { $_[0]{end} }
		708	sub urxvt::line::l { $_[0]{len} }
		709
		710	sub urxvt::line::offset_of {
		711	my ($self, $row, $col) = @_;
		712
		713	($row - $self->{beg}) * $self->{term}->ncol + $col
		714	}
		715
		716	sub urxvt::line::coord_of {
		717	my ($self, $offset) = @_;
		718
		719	use integer;
		720
		721	(
		722	$offset / $self->{term}->ncol + $self->{beg},
		723	$offset % $self->{term}->ncol
		724	)
		725	}
		726
		727	=item ($row, $col) = $line->coord_of ($offset)
545	=item $text = $term->special_encode $string	728	=item $text = $term->special_encode $string
546		729
547	Converts a perl string into the special encoding used by rxvt-unicode,	730	Converts a perl string into the special encoding used by rxvt-unicode,
548	where one character corresponds to one screen cell. See	731	where one character corresponds to one screen cell. See
549	C<< $term->ROW_t >> for details.	732	C<< $term->ROW_t >> for details.
…		…
558	=head2 The C<urxvt::timer> Class	741	=head2 The C<urxvt::timer> Class
559		742
560	This class implements timer watchers/events. Time is represented as a	743	This class implements timer watchers/events. Time is represented as a
561	fractional number of seconds since the epoch. Example:	744	fractional number of seconds since the epoch. Example:
562		745
563	# create a digital clock display in upper right corner	746	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
564	$term->{timer} = urxvt::timer	747	$term->{timer} = urxvt::timer
565	->new	748	->new
566	->start (urxvt::NOW)	749	->interval (1)
567	->cb (sub {	750	->cb (sub {
568	my ($timer) = @_;
569	my $time = $timer->at;
570	$timer->start ($time + 1);
571	$self->scr_overlay (-1, 0,	751	$term->{overlay}->set (0, 0,
572	POSIX::strftime "%H:%M:%S", localtime $time);	752	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
573	});	753	});
574		754
575	=over 4	755	=over 4
576		756
577	=item $timer = new urxvt::timer	757	=item $timer = new urxvt::timer
578		758
579	Create a new timer object in stopped state.	759	Create a new timer object in started state. It is scheduled to fire
		760	immediately.
580		761
581	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	762	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
582		763
583	Set the callback to be called when the timer triggers.	764	Set the callback to be called when the timer triggers.
584		765
…		…
587	Return the time this watcher will fire next.	768	Return the time this watcher will fire next.
588		769
589	=item $timer = $timer->set ($tstamp)	770	=item $timer = $timer->set ($tstamp)
590		771
591	Set the time the event is generated to $tstamp.	772	Set the time the event is generated to $tstamp.
		773
		774	=item $timer = $timer->interval ($interval)
		775
		776	Normally (and when C<$interval> is C<0>), the timer will automatically
		777	stop after it has fired once. If C<$interval> is non-zero, then the timer
		778	is automatically rescheduled at the given intervals.
592		779
593	=item $timer = $timer->start	780	=item $timer = $timer->start
594		781
595	Start the timer.	782	Start the timer.
596		783

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.18 by root, Tue Jan 3 02:01:27 2006 UTC vs. Revision 1.24 by root, Tue Jan 3 20:47:36 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.18 by root, Tue Jan 3 02:01:27 2006 UTC vs.
Revision 1.24 by root, Tue Jan 3 20:47:36 2006 UTC