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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.16 by root, Tue Jan 3 01:41:06 2006 UTC vs.
Revision 1.23 by root, Tue Jan 3 19:42:53 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
24	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
25		27
26	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
27	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
28		30
29	=head1 PACKAGED EXTENSIONS	31	=head2 Prepackaged Extensions
30		32
31	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensiosn delivered with this version. You can
32	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
33		35
34	You can activate them like this:	36	You can activate them like this:
…		…
37		39
38	=over 4	40	=over 4
39		41
40	=item selection	42	=item selection
41		43
42	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:
43		48
44	=over 4	49	=over 4
45		50
46	=item rot13	51	=item rot13
47		52
…		…
50	URxvt.keysym.C-M-r: perl:selection:rot13	55	URxvt.keysym.C-M-r: perl:selection:rot13
51		56
52	=back	57	=back
53		58
54	=item digital-clock	59	=item digital-clock
		60
		61	Displays a digital clock using the built-in overlay.
		62
		63	=item example-refresh-hooks
55		64
56	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
57	window. Illustrates overwriting the refresh callbacks to create your own	66	window. Illustrates overwriting the refresh callbacks to create your own
58	overlays or changes.	67	overlays or changes.
59		68
60	=item simple-overlay-clock
61
62	Displays a digital clock using the built-in overlay (colorful, useless).
63
64	=back	69	=back
65		70
66	=head2 General API Considerations	71	=head2 General API Considerations
67		72
68	All objects (such as terminals, time watchers etc.) are typical	73	All objects (such as terminals, time watchers etc.) are typical
69	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
70	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
71	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
72	modified).	77	modified).
73		78
74	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
75	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
76	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
77	terminal is destroyed.	82	terminal is destroyed.
78		83
79	=head2 Hooks	84	=head2 Hooks
80		85
81	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
82	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.
83		94
84	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
85	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,
86	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.
87		98
…		…
119	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
120	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
121	by calling C<< $term->selection >>.	132	by calling C<< $term->selection >>.
122		133
123	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.
124		144
125	=item on_focus_in $term	145	=item on_focus_in $term
126		146
127	Called whenever the window gets the keyboard focus, before urxvt does	147	Called whenever the window gets the keyboard focus, before urxvt does
128	focus in processing.	148	focus in processing.
…		…
169	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>
170	resource in the @@RXVT_NAME@@(1) manpage).	190	resource in the @@RXVT_NAME@@(1) manpage).
171		191
172	=back	192	=back
173		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
174	=head2 Functions in the C<urxvt> Package	205	=head2 Functions in the C<urxvt> Package
175		206
176	=over 4	207	=over 4
177		208
178	=item urxvt::fatal $errormessage	209	=item urxvt::fatal $errormessage
…		…
192		223
193	=item $time = urxvt::NOW	224	=item $time = urxvt::NOW
194		225
195	Returns the "current time" (as per the event loop).	226	Returns the "current time" (as per the event loop).
196		227
		228	=back
		229
		230	=head2 RENDITION
		231
		232	Rendition bitsets contain information about colour, font, font styles and
		233	similar information for each screen cell.
		234
		235	The following "macros" deal with changes in rendition sets. You should
		236	never just create a bitset, you should always modify an existing one,
		237	as they contain important information required for correct operation of
		238	rxvt-unicode.
		239
		240	=over 4
		241
		242	=item $rend = urxvt::DEFAULT_RSTYLE
		243
		244	Returns the default rendition, as used when the terminal is starting up or
		245	being reset. Useful as a base to start when creating renditions.
		246
		247	=item $rend = urxvt::OVERLAY_RSTYLE
		248
		249	Return the rendition mask used for overlays by default.
		250
		251	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		252
		253	Return the bit that enabled bold, italic, blink, reverse-video and
		254	underline, respectively. To enable such a style, just logically OR it into
		255	the bitset.
		256
		257	=item $foreground = urxvt::GET_BASEFG $rend
		258
		259	=item $background = urxvt::GET_BASEBG $rend
		260
		261	Return the foreground/background colour index, respectively.
		262
		263	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		264
		265	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		266
		267	Replace the foreground/background colour in the rendition mask with the
		268	specified one.
		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
		280	=back
		281
197	=cut	282	=cut
198		283
199	package urxvt;	284	package urxvt;
200		285
201	use strict;	286	use strict;
		287	use Scalar::Util ();
202		288
203	our $term;	289	our $TERM;
204	our @HOOKNAME;	290	our @HOOKNAME;
205	our $LIBDIR;	291	our $LIBDIR;
206		292
207	BEGIN {	293	BEGIN {
208	urxvt->bootstrap;	294	urxvt->bootstrap;
…		…
233	my $name = $HOOKNAME[$htype];	319	my $name = $HOOKNAME[$htype];
234		320
235	my $ref = $pkg->can ("on_" . lc $name)	321	my $ref = $pkg->can ("on_" . lc $name)
236	or next;	322	or next;
237		323
238	$term->{_hook}[$htype]{$ref*1} = $ref;	324	$TERM->{_hook}[$htype]{$pkg} = $ref;
239	$hook_count[$htype]++	325	$hook_count[$htype]++
240	or set_should_invoke $htype, 1;	326	or set_should_invoke $htype, 1;
241	}	327	}
242	}	328	}
243		329
…		…
267	}	353	}
268	}	354	}
269		355
270	# called by the rxvt core	356	# called by the rxvt core
271	sub invoke {	357	sub invoke {
272	local $term = shift;	358	local $TERM = shift;
273	my $htype = shift;	359	my $htype = shift;
274		360
275	if ($htype == 0) { # INIT	361	if ($htype == 0) { # INIT
276	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
277		363
278	for my $ext (split /:/, $term->resource ("perl_ext")) {	364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {
279	my @files = grep -f $_, map "$_/$ext", @dirs;	365	my @files = grep -f $_, map "$_/$ext", @dirs;
280		366
281	if (@files) {	367	if (@files) {
282	register_package script_package $files[0];	368	register_package script_package $files[0];
283	} else {	369	} else {
284	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";
285	}	371	}
286	}	372	}
287		373
288	} elsif ($htype == 1) { # DESTROY	374	} elsif ($htype == 1) { # DESTROY
289	if (my $hook = $term->{_hook}) {	375	if (my $hook = $TERM->{_hook}) {
290	for my $htype (0..$#$hook) {	376	for my $htype (0..$#$hook) {
291	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
292	or set_should_invoke $htype, 0;	378	or set_should_invoke $htype, 0;
293	}	379	}
294	}	380	}
295	}	381	}
296		382
297	my $cb = $term->{_hook}[$htype]	383	my $cb = $TERM->{_hook}[$htype]
298	or return;	384	or return;
299		385
300	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
301	if $verbosity >= 10;	387	if $verbosity >= 10;
302		388
303	while (my ($k, $v) = each %$cb) {	389	while (my ($pkg, $cb) = each %$cb) {
304	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	);
305	}	399	}
306		400
307	0	401	0
308	}	402	}
309		403
310	=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	unshift \@_, shift->{term};
		411	goto &urxvt::term::$1;
		412	}
		413	1
		414	} or die "FATAL: unable to compile method forwarder: $@";
		415
		416	goto &$urxvt::term::proxy::AUTOLOAD;
		417	}
311		418
312	=head2 The C<urxvt::term> Class	419	=head2 The C<urxvt::term> Class
313		420
314	=over 4	421	=over 4
315		422
…		…
371		478
372	=item $oldtext = $term->selection ([$newtext])	479	=item $oldtext = $term->selection ([$newtext])
373		480
374	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>.
375		482
376	=item $term->scr_overlay ($x, $y, $text)	483	#=item $term->overlay ($x, $y, $text)
377		484	#
378	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.
379		486	#
380	=cut	487	#=cut
381		488
382	sub urxvt::term::scr_overlay {	489	sub urxvt::term::scr_overlay {
		490	die;
383	my ($self, $x, $y, $text) = @_;	491	my ($self, $x, $y, $text) = @_;
384		492
385	my @lines = split /\n/, $text;	493	my @lines = split /\n/, $text;
386		494
387	my $w = 0;	495	my $w = 0;
…		…
391		499
392	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	500	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
393	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	501	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
394	}	502	}
395		503
396	=item $term->scr_overlay_new ($x, $y, $width, $height)	504	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
397		505
398	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
399	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
400	C<$y> is negative, then this is counted from the right/bottom side,	508	(default: C<OVERLAY_RSTYLE>).
401	respectively.
402		509
403	=item $term->scr_overlay_off	510	If C<$border> is C<2> (default), then a decorative border will be put
		511	around the box.
404		512
405	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.
406		515
407	=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.
408		518
409	Put a single character (specified numerically) at the given overlay	519	The methods currently supported on C<urxvt::overlay> objects are:
410	position.
411		520
		521	=over 4
		522
412	=item $term->scr_overlay_set ($x, $y, $text)	523	=item $overlay->set ($x, $y, $text, $rend)
413		524
414	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
415		538
416	=item $cellwidth = $term->strwidth $string	539	=item $cellwidth = $term->strwidth $string
417		540
418	Returns the number of screen-cells this string would need. Correctly	541	Returns the number of screen-cells this string would need. Correctly
419	accounts for wide and combining characters.	542	accounts for wide and combining characters.
…		…
464	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
465	line C<< -$term->nsaved >>.	588	line C<< -$term->nsaved >>.
466		589
467	If C<$new_text> is specified, it will replace characters in the current	590	If C<$new_text> is specified, it will replace characters in the current
468	line, starting at column C<$start_col> (default C<0>), which is useful	591	line, starting at column C<$start_col> (default C<0>), which is useful
469	to replace only parts of a line. The font iindex in the rendition will	592	to replace only parts of a line. The font index in the rendition will
470	automatically be updated.	593	automatically be updated.
471		594
472	C<$text> is in a special encoding: tabs and wide characters that use more	595	C<$text> is in a special encoding: tabs and wide characters that use more
473	than one cell when displayed are padded with urxvt::NOCHAR characters	596	than one cell when displayed are padded with urxvt::NOCHAR characters
474	(C<chr 65535>). Characters with combining characters and other characters	597	(C<chr 65535>). Characters with combining characters and other characters
…		…
488	bitsets. Rendition bitsets contain information about colour, font, font	611	bitsets. Rendition bitsets contain information about colour, font, font
489	styles and similar information. See also C<< $term->ROW_t >>.	612	styles and similar information. See also C<< $term->ROW_t >>.
490		613
491	When setting rendition, the font mask will be ignored.	614	When setting rendition, the font mask will be ignored.
492		615
493	See the section on RENDITION, below.	616	See the section on RENDITION, above.
494		617
495	=item $length = $term->ROW_l ($row_number[, $new_length])	618	=item $length = $term->ROW_l ($row_number[, $new_length])
496		619
497	Returns the number of screen cells that are in use ("the line length"). If	620	Returns the number of screen cells that are in use ("the line length"). If
498	it is C<-1>, then the line is part of a multiple-row logical "line", which	621	it is C<-1>, then the line is part of a multiple-row logical "line", which
…		…
509	Converts rxvt-unicodes text reprsentation into a perl string. See	632	Converts rxvt-unicodes text reprsentation into a perl string. See
510	C<< $term->ROW_t >> for details.	633	C<< $term->ROW_t >> for details.
511		634
512	=back	635	=back
513		636
514	=head2 RENDITION
515
516	Rendition bitsets contain information about colour, font, font styles and
517	similar information for each screen cell.
518
519	The following "macros" deal with changes in rendition sets. You should
520	never just create a bitset, you should always modify an existing one,
521	as they contain important information required for correct operation of
522	rxvt-unicode.
523
524	=over 4
525
526	=item $rend = urxvt::DEFAULT_RSTYLE
527
528	Returns the default rendition, as used when the terminal is starting up or
529	being reset. Useful as a base
530
531	=back
532
533	=cut
534
535	=head2 The C<urxvt::timer> Class	637	=head2 The C<urxvt::timer> Class
536		638
537	This class implements timer watchers/events. Time is represented as a	639	This class implements timer watchers/events. Time is represented as a
538	fractional number of seconds since the epoch. Example:	640	fractional number of seconds since the epoch. Example:
539		641
540	# create a digital clock display in upper right corner	642	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
541	$term->{timer} = urxvt::timer	643	$term->{timer} = urxvt::timer
542	->new	644	->new
543	->start (urxvt::NOW)	645	->interval (1)
544	->cb (sub {	646	->cb (sub {
545	my ($timer) = @_;
546	my $time = $timer->at;
547	$timer->start ($time + 1);
548	$self->scr_overlay (-1, 0,	647	$term->{overlay}->set (0, 0,
549	POSIX::strftime "%H:%M:%S", localtime $time);	648	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
550	});	649	});
551		650
552	=over 4	651	=over 4
553		652
554	=item $timer = new urxvt::timer	653	=item $timer = new urxvt::timer
555		654
556	Create a new timer object in stopped state.	655	Create a new timer object in started state. It is scheduled to fire
		656	immediately.
557		657
558	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	658	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
559		659
560	Set the callback to be called when the timer triggers.	660	Set the callback to be called when the timer triggers.
561		661
…		…
564	Return the time this watcher will fire next.	664	Return the time this watcher will fire next.
565		665
566	=item $timer = $timer->set ($tstamp)	666	=item $timer = $timer->set ($tstamp)
567		667
568	Set the time the event is generated to $tstamp.	668	Set the time the event is generated to $tstamp.
		669
		670	=item $timer = $timer->interval ($interval)
		671
		672	Normally (and when C<$interval> is C<0>), the timer will automatically
		673	stop after it has fired once. If C<$interval> is non-zero, then the timer
		674	is automatically rescheduled at the given intervals.
569		675
570	=item $timer = $timer->start	676	=item $timer = $timer->start
571		677
572	Start the timer.	678	Start the timer.
573		679

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.16 by root, Tue Jan 3 01:41:06 2006 UTC vs. Revision 1.23 by root, Tue Jan 3 19:42:53 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.16 by root, Tue Jan 3 01:41:06 2006 UTC vs.
Revision 1.23 by root, Tue Jan 3 19:42:53 2006 UTC