[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.28 by root, Wed Jan 4 00:09:12 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
…		…
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.
126		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.
		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.
131		151
…		…
151	number of lines that will be in the scrollback buffer.	171	number of lines that will be in the scrollback buffer.
152		172
153	=item on_tty_activity $term NYI	173	=item on_tty_activity $term NYI
154		174
155	Called whenever the program(s) running in the urxvt window send output.	175	Called whenever the program(s) running in the urxvt window send output.
		176
		177	=item on_osc_seq $term, $string
		178
		179	Called whenever the B<ESC ] 777 ; string ST> command sequence is
		180	processed. Cursor position and other state information is up-to-date when
		181	this happens. For interoperability, the string should start with the
		182	extension name and a colon, to distinguish it from commands for other
		183	extensions, and this might be enforced in the future.
156		184
157	=item on_refresh_begin $term	185	=item on_refresh_begin $term
158		186
159	Called just before the screen gets redrawn. Can be used for overlay	187	Called just before the screen gets redrawn. Can be used for overlay
160	or similar effects by modify terminal contents in refresh_begin, and	188	or similar effects by modify terminal contents in refresh_begin, and
…		…
171	C<perl:string> action bound to it (see description of the B<keysym>	199	C<perl:string> action bound to it (see description of the B<keysym>
172	resource in the @@RXVT_NAME@@(1) manpage).	200	resource in the @@RXVT_NAME@@(1) manpage).
173		201
174	=back	202	=back
175		203
		204	=head2 Variables in the C<urxvt> Package
		205
		206	=over 4
		207
		208	=item $urxvt::TERM
		209
		210	The current terminal. Whenever a callback/Hook is bein executed, this
		211	variable stores the current C<urxvt::term> object.
		212
		213	=back
		214
176	=head2 Functions in the C<urxvt> Package	215	=head2 Functions in the C<urxvt> Package
177		216
178	=over 4	217	=over 4
179		218
180	=item urxvt::fatal $errormessage	219	=item urxvt::fatal $errormessage
…		…
193	correct place, e.g. on stderr of the connecting urxvtc client.	232	correct place, e.g. on stderr of the connecting urxvtc client.
194		233
195	=item $time = urxvt::NOW	234	=item $time = urxvt::NOW
196		235
197	Returns the "current time" (as per the event loop).	236	Returns the "current time" (as per the event loop).
		237
		238	=back
198		239
199	=head2 RENDITION	240	=head2 RENDITION
200		241
201	Rendition bitsets contain information about colour, font, font styles and	242	Rendition bitsets contain information about colour, font, font styles and
202	similar information for each screen cell.	243	similar information for each screen cell.
…		…
251	=cut	292	=cut
252		293
253	package urxvt;	294	package urxvt;
254		295
255	use strict;	296	use strict;
		297	use Scalar::Util ();
256		298
257	our $term;	299	our $TERM;
258	our @HOOKNAME;	300	our @HOOKNAME;
259	our $LIBDIR;	301	our $LIBDIR;
260		302
261	BEGIN {	303	BEGIN {
262	urxvt->bootstrap;	304	urxvt->bootstrap;
…		…
287	my $name = $HOOKNAME[$htype];	329	my $name = $HOOKNAME[$htype];
288		330
289	my $ref = $pkg->can ("on_" . lc $name)	331	my $ref = $pkg->can ("on_" . lc $name)
290	or next;	332	or next;
291		333
292	$term->{_hook}[$htype]{$ref*1} = $ref;	334	$TERM->{_hook}[$htype]{$pkg} = $ref;
293	$hook_count[$htype]++	335	$hook_count[$htype]++
294	or set_should_invoke $htype, 1;	336	or set_should_invoke $htype, 1;
295	}	337	}
296	}	338	}
297		339
…		…
321	}	363	}
322	}	364	}
323		365
324	# called by the rxvt core	366	# called by the rxvt core
325	sub invoke {	367	sub invoke {
326	local $term = shift;	368	local $TERM = shift;
327	my $htype = shift;	369	my $htype = shift;
328		370
329	if ($htype == 0) { # INIT	371	if ($htype == 0) { # INIT
330	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	372	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
331		373
332	for my $ext (split /:/, $term->resource ("perl_ext")) {	374	for my $ext (split /:/, $TERM->resource ("perl_ext")) {
333	my @files = grep -f $_, map "$_/$ext", @dirs;	375	my @files = grep -f $_, map "$_/$ext", @dirs;
334		376
335	if (@files) {	377	if (@files) {
336	register_package script_package $files[0];	378	register_package script_package $files[0];
337	} else {	379	} else {
338	warn "perl extension '$ext' not found in perl library search path\n";	380	warn "perl extension '$ext' not found in perl library search path\n";
339	}	381	}
340	}	382	}
341		383
342	} elsif ($htype == 1) { # DESTROY	384	} elsif ($htype == 1) { # DESTROY
343	if (my $hook = $term->{_hook}) {	385	if (my $hook = $TERM->{_hook}) {
344	for my $htype (0..$#$hook) {	386	for my $htype (0..$#$hook) {
345	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	387	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
346	or set_should_invoke $htype, 0;	388	or set_should_invoke $htype, 0;
347	}	389	}
348	}	390	}
349	}	391	}
350		392
351	my $cb = $term->{_hook}[$htype]	393	my $cb = $TERM->{_hook}[$htype]
352	or return;	394	or return;
353		395
354	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	396	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
355	if $verbosity >= 10;	397	if $verbosity >= 10;
356		398
		399	keys %$cb;
		400
357	while (my ($k, $v) = each %$cb) {	401	while (my ($pkg, $cb) = each %$cb) {
358	return 1 if $v->($term, @_);	402	return 1
		403	if $cb->(
		404	$TERM->{$pkg} \|\|= do {
		405	my $proxy = bless { }, urxvt::term::proxy::;
		406	Scalar::Util::weaken ($proxy->{term} = $TERM);
		407	$proxy
		408	},
		409	@_,
		410	);
359	}	411	}
360		412
361	0	413	0
362	}	414	}
363		415
364	=back	416	sub urxvt::term::proxy::AUTOLOAD {
		417	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		418	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		419
		420	eval qq{
		421	sub $urxvt::term::proxy::AUTOLOAD {
		422	my \$proxy = shift;
		423	\$proxy->{term}->$1 (\@_)
		424	}
		425	1
		426	} or die "FATAL: unable to compile method forwarder: $@";
		427
		428	goto &$urxvt::term::proxy::AUTOLOAD;
		429	}
365		430
366	=head2 The C<urxvt::term> Class	431	=head2 The C<urxvt::term> Class
367		432
368	=over 4	433	=over 4
369		434
…		…
425		490
426	=item $oldtext = $term->selection ([$newtext])	491	=item $oldtext = $term->selection ([$newtext])
427		492
428	Return the current selection text and optionally replace it by C<$newtext>.	493	Return the current selection text and optionally replace it by C<$newtext>.
429		494
430	=item $term->scr_overlay ($x, $y, $text)	495	#=item $term->overlay ($x, $y, $text)
431		496	#
432	Create a simple multi-line overlay box. See the next method for details.	497	#Create a simple multi-line overlay box. See the next method for details.
433		498	#
434	=cut	499	#=cut
435		500
436	sub urxvt::term::scr_overlay {	501	sub urxvt::term::scr_overlay {
		502	die;
437	my ($self, $x, $y, $text) = @_;	503	my ($self, $x, $y, $text) = @_;
438		504
439	my @lines = split /\n/, $text;	505	my @lines = split /\n/, $text;
440		506
441	my $w = 0;	507	my $w = 0;
…		…
445		511
446	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	512	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
447	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	513	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
448	}	514	}
449		515
450	=item $term->scr_overlay_new ($x, $y, $width, $height)	516	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
451		517
452	Create a new (empty) overlay at the given position with the given	518	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	519	width/height. C<$rstyle> defines the initial rendition style
454	C<$y> is negative, then this is counted from the right/bottom side,	520	(default: C<OVERLAY_RSTYLE>).
455	respectively.
456		521
457	=item $term->scr_overlay_off	522	If C<$border> is C<2> (default), then a decorative border will be put
		523	around the box.
458		524
459	Switch the overlay off again.	525	If either C<$x> or C<$y> is negative, then this is counted from the
		526	right/bottom side, respectively.
460		527
461	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	528	This method returns an urxvt::overlay object. The overlay will be visible
		529	as long as the perl object is referenced.
462		530
463	Put a single character (specified numerically) at the given overlay	531	The methods currently supported on C<urxvt::overlay> objects are:
464	position.
465		532
		533	=over 4
		534
466	=item $term->scr_overlay_set ($x, $y, $text)	535	=item $overlay->set ($x, $y, $text, $rend)
467		536
468	Write a string at the given position into the overlay.	537	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		538	text in rxvt-unicode's special encoding and an array of rendition values
		539	at a specific position inside the overlay.
		540
		541	=item $overlay->hide
		542
		543	If visible, hide the overlay, but do not destroy it.
		544
		545	=item $overlay->show
		546
		547	If hidden, display the overlay again.
		548
		549	=back
469		550
470	=item $cellwidth = $term->strwidth $string	551	=item $cellwidth = $term->strwidth $string
471		552
472	Returns the number of screen-cells this string would need. Correctly	553	Returns the number of screen-cells this string would need. Correctly
473	accounts for wide and combining characters.	554	accounts for wide and combining characters.
…		…
514	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	595	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
515		596
516	Returns the text of the entire row with number C<$row_number>. Row C<0>	597	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	598	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	599	terminal line. The scrollback buffer starts at line C<-1> and extends to
519	line C<< -$term->nsaved >>.	600	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		601	is requested.
520		602
521	If C<$new_text> is specified, it will replace characters in the current	603	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	604	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	605	to replace only parts of a line. The font index in the rendition will
524	automatically be updated.	606	automatically be updated.
…		…
546		628
547	See the section on RENDITION, above.	629	See the section on RENDITION, above.
548		630
549	=item $length = $term->ROW_l ($row_number[, $new_length])	631	=item $length = $term->ROW_l ($row_number[, $new_length])
550		632
551	Returns the number of screen cells that are in use ("the line length"). If	633	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	634	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.	635	line is joined with the following one.
554		636
		637	=item $bool = $term->is_longer ($row_number)
		638
		639	Returns true if the row is part of a multiple-row logical "line" (i.e.
		640	joined with the following row), which means all characters are in use
		641	and it is continued on the next row (and possibly a continuation of the
		642	previous row(s)).
		643
		644	=item $line = $term->line ($row_number)
		645
		646	Create and return a new C<urxvt::line> object that stores information
		647	about the logical line that row C<$row_number> is part of. It supports the
		648	following methods:
		649
		650	=over 4
		651
		652	=item $text = $line->t
		653
		654	Returns the full text of the line, similar to C<ROW_t>
		655
		656	=item $rend = $line->r
		657
		658	Returns the full rendition array of the line, similar to C<ROW_r>
		659
		660	=item $length = $line->l
		661
		662	Returns the length of the line in cells, similar to C<ROW_l>.
		663
		664	=item $rownum = $line->beg
		665
		666	=item $rownum = $line->end
		667
		668	Return the row number of the first/last row of the line, respectively.
		669
		670	=item $offset = $line->offset_of ($row, $col)
		671
		672	Returns the character offset of the given row\|col pair within the logical
		673	line.
		674
		675	=item ($row, $col) = $line->coord_of ($offset)
		676
		677	Translates a string offset into terminal coordinates again.
		678
		679	=back
		680
		681	=cut
		682
		683	sub urxvt::term::line {
		684	my ($self, $row) = @_;
		685
		686	my $maxrow = $self->nrow - 1;
		687
		688	my ($beg, $end) = ($row, $row);
		689
		690	--$beg while $self->ROW_is_longer ($beg - 1);
		691	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		692
		693	bless {
		694	term => $self,
		695	beg => $beg,
		696	end => $end,
		697	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		698	}, urxvt::line::
		699	}
		700
		701	sub urxvt::line::t {
		702	my ($self) = @_;
		703
		704	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		705	0, $self->{len}
		706	}
		707
		708	sub urxvt::line::r {
		709	my ($self) = @_;
		710
		711	my $rend = [
		712	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		713	];
		714	$#$rend = $self->{len} - 1;
		715	$rend
		716	}
		717
		718	sub urxvt::line::beg { $_[0]{beg} }
		719	sub urxvt::line::end { $_[0]{end} }
		720	sub urxvt::line::l { $_[0]{len} }
		721
		722	sub urxvt::line::offset_of {
		723	my ($self, $row, $col) = @_;
		724
		725	($row - $self->{beg}) * $self->{term}->ncol + $col
		726	}
		727
		728	sub urxvt::line::coord_of {
		729	my ($self, $offset) = @_;
		730
		731	use integer;
		732
		733	(
		734	$offset / $self->{term}->ncol + $self->{beg},
		735	$offset % $self->{term}->ncol
		736	)
		737	}
		738
		739	=item ($row, $col) = $line->coord_of ($offset)
555	=item $text = $term->special_encode $string	740	=item $text = $term->special_encode $string
556		741
557	Converts a perl string into the special encoding used by rxvt-unicode,	742	Converts a perl string into the special encoding used by rxvt-unicode,
558	where one character corresponds to one screen cell. See	743	where one character corresponds to one screen cell. See
559	C<< $term->ROW_t >> for details.	744	C<< $term->ROW_t >> for details.
…		…
568	=head2 The C<urxvt::timer> Class	753	=head2 The C<urxvt::timer> Class
569		754
570	This class implements timer watchers/events. Time is represented as a	755	This class implements timer watchers/events. Time is represented as a
571	fractional number of seconds since the epoch. Example:	756	fractional number of seconds since the epoch. Example:
572		757
573	# create a digital clock display in upper right corner	758	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
574	$term->{timer} = urxvt::timer	759	$term->{timer} = urxvt::timer
575	->new	760	->new
576	->start (urxvt::NOW)	761	->interval (1)
577	->cb (sub {	762	->cb (sub {
578	my ($timer) = @_;
579	my $time = $timer->at;
580	$timer->start ($time + 1);
581	$self->scr_overlay (-1, 0,	763	$term->{overlay}->set (0, 0,
582	POSIX::strftime "%H:%M:%S", localtime $time);	764	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
583	});	765	});
584		766
585	=over 4	767	=over 4
586		768
587	=item $timer = new urxvt::timer	769	=item $timer = new urxvt::timer
588		770
589	Create a new timer object in stopped state.	771	Create a new timer object in started state. It is scheduled to fire
		772	immediately.
590		773
591	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	774	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
592		775
593	Set the callback to be called when the timer triggers.	776	Set the callback to be called when the timer triggers.
594		777
…		…
597	Return the time this watcher will fire next.	780	Return the time this watcher will fire next.
598		781
599	=item $timer = $timer->set ($tstamp)	782	=item $timer = $timer->set ($tstamp)
600		783
601	Set the time the event is generated to $tstamp.	784	Set the time the event is generated to $tstamp.
		785
		786	=item $timer = $timer->interval ($interval)
		787
		788	Normally (and when C<$interval> is C<0>), the timer will automatically
		789	stop after it has fired once. If C<$interval> is non-zero, then the timer
		790	is automatically rescheduled at the given intervals.
602		791
603	=item $timer = $timer->start	792	=item $timer = $timer->start
604		793
605	Start the timer.	794	Start the timer.
606		795
…		…
669	This variable controls the verbosity level of the perl extension. Higher	858	This variable controls the verbosity level of the perl extension. Higher
670	numbers indicate more verbose output.	859	numbers indicate more verbose output.
671		860
672	=over 4	861	=over 4
673		862
674	=item 0 - only fatal messages	863	=item =0 - only fatal messages
675		864
676	=item 3 - script loading and management	865	=item =3 - script loading and management
677		866
678	=item 10 - all events received	867	=item =10 - all events received
679		868
680	=back	869	=back
681		870
682	=head1 AUTHOR	871	=head1 AUTHOR
683		872

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.28 by root, Wed Jan 4 00:09:12 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.28 by root, Wed Jan 4 00:09:12 2006 UTC