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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC vs.
Revision 1.23 by root, Tue Jan 3 19:42:53 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 (colorful, 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
…		…
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).
198		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
199	=cut	282	=cut
200		283
201	package urxvt;	284	package urxvt;
202		285
203	use strict;	286	use strict;
		287	use Scalar::Util ();
204		288
205	our $term;	289	our $TERM;
206	our @HOOKNAME;	290	our @HOOKNAME;
207	our $LIBDIR;	291	our $LIBDIR;
208		292
209	BEGIN {	293	BEGIN {
210	urxvt->bootstrap;	294	urxvt->bootstrap;
…		…
235	my $name = $HOOKNAME[$htype];	319	my $name = $HOOKNAME[$htype];
236		320
237	my $ref = $pkg->can ("on_" . lc $name)	321	my $ref = $pkg->can ("on_" . lc $name)
238	or next;	322	or next;
239		323
240	$term->{_hook}[$htype]{$ref*1} = $ref;	324	$TERM->{_hook}[$htype]{$pkg} = $ref;
241	$hook_count[$htype]++	325	$hook_count[$htype]++
242	or set_should_invoke $htype, 1;	326	or set_should_invoke $htype, 1;
243	}	327	}
244	}	328	}
245		329
…		…
269	}	353	}
270	}	354	}
271		355
272	# called by the rxvt core	356	# called by the rxvt core
273	sub invoke {	357	sub invoke {
274	local $term = shift;	358	local $TERM = shift;
275	my $htype = shift;	359	my $htype = shift;
276		360
277	if ($htype == 0) { # INIT	361	if ($htype == 0) { # INIT
278	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
279		363
280	for my $ext (split /:/, $term->resource ("perl_ext")) {	364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {
281	my @files = grep -f $_, map "$_/$ext", @dirs;	365	my @files = grep -f $_, map "$_/$ext", @dirs;
282		366
283	if (@files) {	367	if (@files) {
284	register_package script_package $files[0];	368	register_package script_package $files[0];
285	} else {	369	} else {
286	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";
287	}	371	}
288	}	372	}
289		373
290	} elsif ($htype == 1) { # DESTROY	374	} elsif ($htype == 1) { # DESTROY
291	if (my $hook = $term->{_hook}) {	375	if (my $hook = $TERM->{_hook}) {
292	for my $htype (0..$#$hook) {	376	for my $htype (0..$#$hook) {
293	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
294	or set_should_invoke $htype, 0;	378	or set_should_invoke $htype, 0;
295	}	379	}
296	}	380	}
297	}	381	}
298		382
299	my $cb = $term->{_hook}[$htype]	383	my $cb = $TERM->{_hook}[$htype]
300	or return;	384	or return;
301		385
302	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
303	if $verbosity >= 10;	387	if $verbosity >= 10;
304		388
305	while (my ($k, $v) = each %$cb) {	389	while (my ($pkg, $cb) = each %$cb) {
306	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	);
307	}	399	}
308		400
309	0	401	0
310	}	402	}
311		403
312	=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	}
313		418
314	=head2 The C<urxvt::term> Class	419	=head2 The C<urxvt::term> Class
315		420
316	=over 4	421	=over 4
317		422
…		…
373		478
374	=item $oldtext = $term->selection ([$newtext])	479	=item $oldtext = $term->selection ([$newtext])
375		480
376	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>.
377		482
378	=item $term->scr_overlay ($x, $y, $text)	483	#=item $term->overlay ($x, $y, $text)
379		484	#
380	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.
381		486	#
382	=cut	487	#=cut
383		488
384	sub urxvt::term::scr_overlay {	489	sub urxvt::term::scr_overlay {
		490	die;
385	my ($self, $x, $y, $text) = @_;	491	my ($self, $x, $y, $text) = @_;
386		492
387	my @lines = split /\n/, $text;	493	my @lines = split /\n/, $text;
388		494
389	my $w = 0;	495	my $w = 0;
…		…
393		499
394	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	500	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
395	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	501	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
396	}	502	}
397		503
398	=item $term->scr_overlay_new ($x, $y, $width, $height)	504	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
399		505
400	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
401	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
402	C<$y> is negative, then this is counted from the right/bottom side,	508	(default: C<OVERLAY_RSTYLE>).
403	respectively.
404		509
405	=item $term->scr_overlay_off	510	If C<$border> is C<2> (default), then a decorative border will be put
		511	around the box.
406		512
407	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.
408		515
409	=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.
410		518
411	Put a single character (specified numerically) at the given overlay	519	The methods currently supported on C<urxvt::overlay> objects are:
412	position.
413		520
		521	=over 4
		522
414	=item $term->scr_overlay_set ($x, $y, $text)	523	=item $overlay->set ($x, $y, $text, $rend)
415		524
416	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
417		538
418	=item $cellwidth = $term->strwidth $string	539	=item $cellwidth = $term->strwidth $string
419		540
420	Returns the number of screen-cells this string would need. Correctly	541	Returns the number of screen-cells this string would need. Correctly
421	accounts for wide and combining characters.	542	accounts for wide and combining characters.
…		…
466	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
467	line C<< -$term->nsaved >>.	588	line C<< -$term->nsaved >>.
468		589
469	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
470	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
471	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
472	automatically be updated.	593	automatically be updated.
473		594
474	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
475	than one cell when displayed are padded with urxvt::NOCHAR characters	596	than one cell when displayed are padded with urxvt::NOCHAR characters
476	(C<chr 65535>). Characters with combining characters and other characters	597	(C<chr 65535>). Characters with combining characters and other characters
…		…
490	bitsets. Rendition bitsets contain information about colour, font, font	611	bitsets. Rendition bitsets contain information about colour, font, font
491	styles and similar information. See also C<< $term->ROW_t >>.	612	styles and similar information. See also C<< $term->ROW_t >>.
492		613
493	When setting rendition, the font mask will be ignored.	614	When setting rendition, the font mask will be ignored.
494		615
495	See the section on RENDITION, below.	616	See the section on RENDITION, above.
496		617
497	=item $length = $term->ROW_l ($row_number[, $new_length])	618	=item $length = $term->ROW_l ($row_number[, $new_length])
498		619
499	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
500	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
…		…
511	Converts rxvt-unicodes text reprsentation into a perl string. See	632	Converts rxvt-unicodes text reprsentation into a perl string. See
512	C<< $term->ROW_t >> for details.	633	C<< $term->ROW_t >> for details.
513		634
514	=back	635	=back
515		636
516	=head2 RENDITION
517
518	Rendition bitsets contain information about colour, font, font styles and
519	similar information for each screen cell.
520
521	The following "macros" deal with changes in rendition sets. You should
522	never just create a bitset, you should always modify an existing one,
523	as they contain important information required for correct operation of
524	rxvt-unicode.
525
526	=over 4
527
528	=item $rend = urxvt::DEFAULT_RSTYLE
529
530	Returns the default rendition, as used when the terminal is starting up or
531	being reset. Useful as a base
532
533	=back
534
535	=cut
536
537	=head2 The C<urxvt::timer> Class	637	=head2 The C<urxvt::timer> Class
538		638
539	This class implements timer watchers/events. Time is represented as a	639	This class implements timer watchers/events. Time is represented as a
540	fractional number of seconds since the epoch. Example:	640	fractional number of seconds since the epoch. Example:
541		641
542	# create a digital clock display in upper right corner	642	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
543	$term->{timer} = urxvt::timer	643	$term->{timer} = urxvt::timer
544	->new	644	->new
545	->start (urxvt::NOW)	645	->interval (1)
546	->cb (sub {	646	->cb (sub {
547	my ($timer) = @_;
548	my $time = $timer->at;
549	$timer->start ($time + 1);
550	$self->scr_overlay (-1, 0,	647	$term->{overlay}->set (0, 0,
551	POSIX::strftime "%H:%M:%S", localtime $time);	648	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
552	});	649	});
553		650
554	=over 4	651	=over 4
555		652
556	=item $timer = new urxvt::timer	653	=item $timer = new urxvt::timer
557		654
558	Create a new timer object in stopped state.	655	Create a new timer object in started state. It is scheduled to fire
		656	immediately.
559		657
560	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	658	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
561		659
562	Set the callback to be called when the timer triggers.	660	Set the callback to be called when the timer triggers.
563		661
…		…
566	Return the time this watcher will fire next.	664	Return the time this watcher will fire next.
567		665
568	=item $timer = $timer->set ($tstamp)	666	=item $timer = $timer->set ($tstamp)
569		667
570	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.
571		675
572	=item $timer = $timer->start	676	=item $timer = $timer->start
573		677
574	Start the timer.	678	Start the timer.
575		679

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.17 by root, Tue Jan 3 01:45:03 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.17 by root, Tue Jan 3 01:45:03 2006 UTC vs.
Revision 1.23 by root, Tue Jan 3 19:42:53 2006 UTC