[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.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.
…		…
218	Return the rendition mask used for overlays by default.	251	Return the rendition mask used for overlays by default.
219		252
220	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	253	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
221		254
222	Return the bit that enabled bold, italic, blink, reverse-video and	255	Return the bit that enabled bold, italic, blink, reverse-video and
223	underline, respectively. To enable such a style, just or it onto the	256	underline, respectively. To enable such a style, just logically OR it into
224	bitset.	257	the bitset.
225		258
226	=item $foreground = urxvt::GET_BASEFG $rend	259	=item $foreground = urxvt::GET_BASEFG $rend
227		260
228	=item $background = urxvt::GET_BASEBG $rend	261	=item $background = urxvt::GET_BASEBG $rend
229		262
…		…
234	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	267	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
235		268
236	Replace the foreground/background colour in the rendition mask with the	269	Replace the foreground/background colour in the rendition mask with the
237	specified one.	270	specified one.
238		271
		272	=item $value = urxvt::GET_CUSTOM ($rend)
		273
		274	Return the "custom" value: Every rendition has 5 bits for use by
		275	extensions. They can be set and changed as you like and are initially
		276	zero.
		277
		278	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		279
		280	Change the custom value.
		281
239	=back	282	=back
240		283
241	=cut	284	=cut
242		285
243	package urxvt;	286	package urxvt;
244		287
245	use strict;	288	use strict;
		289	use Scalar::Util ();
246		290
247	our $term;	291	our $TERM;
248	our @HOOKNAME;	292	our @HOOKNAME;
249	our $LIBDIR;	293	our $LIBDIR;
250		294
251	BEGIN {	295	BEGIN {
252	urxvt->bootstrap;	296	urxvt->bootstrap;
…		…
277	my $name = $HOOKNAME[$htype];	321	my $name = $HOOKNAME[$htype];
278		322
279	my $ref = $pkg->can ("on_" . lc $name)	323	my $ref = $pkg->can ("on_" . lc $name)
280	or next;	324	or next;
281		325
282	$term->{_hook}[$htype]{$ref*1} = $ref;	326	$TERM->{_hook}[$htype]{$pkg} = $ref;
283	$hook_count[$htype]++	327	$hook_count[$htype]++
284	or set_should_invoke $htype, 1;	328	or set_should_invoke $htype, 1;
285	}	329	}
286	}	330	}
287		331
…		…
311	}	355	}
312	}	356	}
313		357
314	# called by the rxvt core	358	# called by the rxvt core
315	sub invoke {	359	sub invoke {
316	local $term = shift;	360	local $TERM = shift;
317	my $htype = shift;	361	my $htype = shift;
318		362
319	if ($htype == 0) { # INIT	363	if ($htype == 0) { # INIT
320	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	364	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
321		365
322	for my $ext (split /:/, $term->resource ("perl_ext")) {	366	for my $ext (split /:/, $TERM->resource ("perl_ext")) {
323	my @files = grep -f $_, map "$_/$ext", @dirs;	367	my @files = grep -f $_, map "$_/$ext", @dirs;
324		368
325	if (@files) {	369	if (@files) {
326	register_package script_package $files[0];	370	register_package script_package $files[0];
327	} else {	371	} else {
328	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";
329	}	373	}
330	}	374	}
331		375
332	} elsif ($htype == 1) { # DESTROY	376	} elsif ($htype == 1) { # DESTROY
333	if (my $hook = $term->{_hook}) {	377	if (my $hook = $TERM->{_hook}) {
334	for my $htype (0..$#$hook) {	378	for my $htype (0..$#$hook) {
335	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	379	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
336	or set_should_invoke $htype, 0;	380	or set_should_invoke $htype, 0;
337	}	381	}
338	}	382	}
339	}	383	}
340		384
341	my $cb = $term->{_hook}[$htype]	385	my $cb = $TERM->{_hook}[$htype]
342	or return;	386	or return;
343		387
344	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	388	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
345	if $verbosity >= 10;	389	if $verbosity >= 10;
346		390
		391	keys %$cb;
		392
347	while (my ($k, $v) = each %$cb) {	393	while (my ($pkg, $cb) = each %$cb) {
348	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	);
349	}	403	}
350		404
351	0	405	0
352	}	406	}
353		407
354	=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	}
355		422
356	=head2 The C<urxvt::term> Class	423	=head2 The C<urxvt::term> Class
357		424
358	=over 4	425	=over 4
359		426
…		…
415		482
416	=item $oldtext = $term->selection ([$newtext])	483	=item $oldtext = $term->selection ([$newtext])
417		484
418	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>.
419		486
420	=item $term->scr_overlay ($x, $y, $text)	487	#=item $term->overlay ($x, $y, $text)
421		488	#
422	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.
423		490	#
424	=cut	491	#=cut
425		492
426	sub urxvt::term::scr_overlay {	493	sub urxvt::term::scr_overlay {
		494	die;
427	my ($self, $x, $y, $text) = @_;	495	my ($self, $x, $y, $text) = @_;
428		496
429	my @lines = split /\n/, $text;	497	my @lines = split /\n/, $text;
430		498
431	my $w = 0;	499	my $w = 0;
…		…
435		503
436	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	504	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
437	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	505	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
438	}	506	}
439		507
440	=item $term->scr_overlay_new ($x, $y, $width, $height)	508	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
441		509
442	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
443	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
444	C<$y> is negative, then this is counted from the right/bottom side,	512	(default: C<OVERLAY_RSTYLE>).
445	respectively.
446		513
447	=item $term->scr_overlay_off	514	If C<$border> is C<2> (default), then a decorative border will be put
		515	around the box.
448		516
449	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.
450		519
451	=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.
452		522
453	Put a single character (specified numerically) at the given overlay	523	The methods currently supported on C<urxvt::overlay> objects are:
454	position.
455		524
		525	=over 4
		526
456	=item $term->scr_overlay_set ($x, $y, $text)	527	=item $overlay->set ($x, $y, $text, $rend)
457		528
458	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
459		542
460	=item $cellwidth = $term->strwidth $string	543	=item $cellwidth = $term->strwidth $string
461		544
462	Returns the number of screen-cells this string would need. Correctly	545	Returns the number of screen-cells this string would need. Correctly
463	accounts for wide and combining characters.	546	accounts for wide and combining characters.
…		…
504	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	587	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
505		588
506	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>
507	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
508	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
509	line C<< -$term->nsaved >>.	592	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		593	is requested.
510		594
511	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
512	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
513	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
514	automatically be updated.	598	automatically be updated.
…		…
536		620
537	See the section on RENDITION, above.	621	See the section on RENDITION, above.
538		622
539	=item $length = $term->ROW_l ($row_number[, $new_length])	623	=item $length = $term->ROW_l ($row_number[, $new_length])
540		624
541	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
542	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
543	means all characters are in use and it is continued on the next row.	627	line is joined with the following one.
544		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)
545	=item $text = $term->special_encode $string	732	=item $text = $term->special_encode $string
546		733
547	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,
548	where one character corresponds to one screen cell. See	735	where one character corresponds to one screen cell. See
549	C<< $term->ROW_t >> for details.	736	C<< $term->ROW_t >> for details.
…		…
558	=head2 The C<urxvt::timer> Class	745	=head2 The C<urxvt::timer> Class
559		746
560	This class implements timer watchers/events. Time is represented as a	747	This class implements timer watchers/events. Time is represented as a
561	fractional number of seconds since the epoch. Example:	748	fractional number of seconds since the epoch. Example:
562		749
563	# create a digital clock display in upper right corner	750	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
564	$term->{timer} = urxvt::timer	751	$term->{timer} = urxvt::timer
565	->new	752	->new
566	->start (urxvt::NOW)	753	->interval (1)
567	->cb (sub {	754	->cb (sub {
568	my ($timer) = @_;
569	my $time = $timer->at;
570	$timer->start ($time + 1);
571	$self->scr_overlay (-1, 0,	755	$term->{overlay}->set (0, 0,
572	POSIX::strftime "%H:%M:%S", localtime $time);	756	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
573	});	757	});
574		758
575	=over 4	759	=over 4
576		760
577	=item $timer = new urxvt::timer	761	=item $timer = new urxvt::timer
578		762
579	Create a new timer object in stopped state.	763	Create a new timer object in started state. It is scheduled to fire
		764	immediately.
580		765
581	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	766	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
582		767
583	Set the callback to be called when the timer triggers.	768	Set the callback to be called when the timer triggers.
584		769
…		…
587	Return the time this watcher will fire next.	772	Return the time this watcher will fire next.
588		773
589	=item $timer = $timer->set ($tstamp)	774	=item $timer = $timer->set ($tstamp)
590		775
591	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.
592		783
593	=item $timer = $timer->start	784	=item $timer = $timer->start
594		785
595	Start the timer.	786	Start the timer.
596		787

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.26 by root, Tue Jan 3 21:22:22 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.26 by root, Tue Jan 3 21:22:22 2006 UTC