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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.12 by root, Mon Jan 2 22:23:26 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
22		24
23	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
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.
		30
		31	=head2 Prepackaged Extensions
		32
		33	This section describes the extensiosn delivered with this version. You can
		34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
		35
		36	You can activate them like this:
		37
		38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	=over 4
		41
		42	=item selection
		43
		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:
		48
		49	=over 4
		50
		51	=item rot13
		52
		53	Rot-13 the selection when activated. Used via keyboard trigger:
		54
		55	URxvt.keysym.C-M-r: perl:selection:rot13
		56
		57	=back
		58
		59	=item digital-clock
		60
		61	Displays a digital clock using the built-in overlay.
		62
		63	=item example-refresh-hooks
		64
		65	Displays a very simple digital clock in the upper right corner of the
		66	window. Illustrates overwriting the refresh callbacks to create your own
		67	overlays or changes.
		68
		69	=back
28		70
29	=head2 General API Considerations	71	=head2 General API Considerations
30		72
31	All objects (such as terminals, time watchers etc.) are typical	73	All objects (such as terminals, time watchers etc.) are typical
32	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
33	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
34	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
35	modified).	77	modified).
36		78
37	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
38	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
39	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
40	terminal is destroyed.	82	terminal is destroyed.
41		83
42	=head2 Hooks	84	=head2 Hooks
43		85
44	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
45	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.
46		94
47	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
48	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,
49	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.
50		98
…		…
82	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
83	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
84	by calling C<< $term->selection >>.	132	by calling C<< $term->selection >>.
85		133
86	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.
87		144
88	=item on_focus_in $term	145	=item on_focus_in $term
89		146
90	Called whenever the window gets the keyboard focus, before urxvt does	147	Called whenever the window gets the keyboard focus, before urxvt does
91	focus in processing.	148	focus in processing.
…		…
132	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>
133	resource in the @@RXVT_NAME@@(1) manpage).	190	resource in the @@RXVT_NAME@@(1) manpage).
134		191
135	=back	192	=back
136		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
137	=head2 Functions in the C<urxvt> Package	205	=head2 Functions in the C<urxvt> Package
138		206
139	=over 4	207	=over 4
140		208
141	=item urxvt::fatal $errormessage	209	=item urxvt::fatal $errormessage
…		…
155		223
156	=item $time = urxvt::NOW	224	=item $time = urxvt::NOW
157		225
158	Returns the "current time" (as per the event loop).	226	Returns the "current time" (as per the event loop).
159		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
160	=cut	282	=cut
161		283
162	package urxvt;	284	package urxvt;
163		285
164	use strict;	286	use strict;
		287	use Scalar::Util ();
165		288
166	our $term;	289	our $TERM;
167	our @HOOKNAME;	290	our @HOOKNAME;
168	our $LIBDIR;	291	our $LIBDIR;
169		292
170	BEGIN {	293	BEGIN {
171	urxvt->bootstrap;	294	urxvt->bootstrap;
…		…
196	my $name = $HOOKNAME[$htype];	319	my $name = $HOOKNAME[$htype];
197		320
198	my $ref = $pkg->can ("on_" . lc $name)	321	my $ref = $pkg->can ("on_" . lc $name)
199	or next;	322	or next;
200		323
201	$term->{_hook}[$htype]{$ref*1} = $ref;	324	$TERM->{_hook}[$htype]{$pkg} = $ref;
202	$hook_count[$htype]++	325	$hook_count[$htype]++
203	or set_should_invoke $htype, 1;	326	or set_should_invoke $htype, 1;
204	}	327	}
205	}	328	}
206		329
…		…
230	}	353	}
231	}	354	}
232		355
233	# called by the rxvt core	356	# called by the rxvt core
234	sub invoke {	357	sub invoke {
235	local $term = shift;	358	local $TERM = shift;
236	my $htype = shift;	359	my $htype = shift;
237		360
238	if ($htype == 0) { # INIT	361	if ($htype == 0) { # INIT
239	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
240		363
241	for my $ext (split /:/, $term->resource ("perl_ext")) {	364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {
242	my @files = grep -f $_, map "$_/$ext", @dirs;	365	my @files = grep -f $_, map "$_/$ext", @dirs;
243		366
244	if (@files) {	367	if (@files) {
245	register_package script_package $files[0];	368	register_package script_package $files[0];
246	} else {	369	} else {
247	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";
248	}	371	}
249	}	372	}
250		373
251	} elsif ($htype == 1) { # DESTROY	374	} elsif ($htype == 1) { # DESTROY
252	if (my $hook = $term->{_hook}) {	375	if (my $hook = $TERM->{_hook}) {
253	for my $htype (0..$#$hook) {	376	for my $htype (0..$#$hook) {
254	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
255	or set_should_invoke $htype, 0;	378	or set_should_invoke $htype, 0;
256	}	379	}
257	}	380	}
258	}	381	}
259		382
260	my $cb = $term->{_hook}[$htype]	383	my $cb = $TERM->{_hook}[$htype]
261	or return;	384	or return;
262		385
263	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
264	if $verbosity >= 10;	387	if $verbosity >= 10;
265		388
266	while (my ($k, $v) = each %$cb) {	389	while (my ($pkg, $cb) = each %$cb) {
267	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	);
268	}	399	}
269		400
270	0	401	0
271	}	402	}
272		403
273	=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	}
274		418
275	=head2 The C<urxvt::term> Class	419	=head2 The C<urxvt::term> Class
276		420
277	=over 4	421	=over 4
278		422
…		…
334		478
335	=item $oldtext = $term->selection ([$newtext])	479	=item $oldtext = $term->selection ([$newtext])
336		480
337	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>.
338		482
339	=item $term->scr_overlay ($x, $y, $text)	483	#=item $term->overlay ($x, $y, $text)
340		484	#
341	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.
342		486	#
343	=cut	487	#=cut
344		488
345	sub urxvt::term::scr_overlay {	489	sub urxvt::term::scr_overlay {
		490	die;
346	my ($self, $x, $y, $text) = @_;	491	my ($self, $x, $y, $text) = @_;
347		492
348	my @lines = split /\n/, $text;	493	my @lines = split /\n/, $text;
349		494
350	my $w = 0;	495	my $w = 0;
…		…
354		499
355	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	500	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
356	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	501	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
357	}	502	}
358		503
359	=item $term->scr_overlay_new ($x, $y, $width, $height)	504	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
360		505
361	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
362	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
363	C<$y> is negative, then this is counted from the right/bottom side,	508	(default: C<OVERLAY_RSTYLE>).
364	respectively.
365		509
366	=item $term->scr_overlay_off	510	If C<$border> is C<2> (default), then a decorative border will be put
		511	around the box.
367		512
368	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.
369		515
370	=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.
371		518
372	Put a single character (specified numerically) at the given overlay	519	The methods currently supported on C<urxvt::overlay> objects are:
373	position.
374		520
		521	=over 4
		522
375	=item $term->scr_overlay_set ($x, $y, $text)	523	=item $overlay->set ($x, $y, $text, $rend)
376		524
377	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
378		538
379	=item $cellwidth = $term->strwidth $string	539	=item $cellwidth = $term->strwidth $string
380		540
381	Returns the number of screen-cells this string would need. Correctly	541	Returns the number of screen-cells this string would need. Correctly
382	accounts for wide and combining characters.	542	accounts for wide and combining characters.
…		…
393		553
394	Write the octets given in C<$data> to the tty (i.e. as program input). To	554	Write the octets given in C<$data> to the tty (i.e. as program input). To
395	pass characters instead of octets, you should convert your strings first	555	pass characters instead of octets, you should convert your strings first
396	to the locale-specific encoding using C<< $term->locale_encode >>.	556	to the locale-specific encoding using C<< $term->locale_encode >>.
397		557
		558	=item $nrow = $term->nrow
		559
		560	=item $ncol = $term->ncol
		561
		562	Return the number of rows/columns of the terminal window (i.e. as
		563	specified by C<-geometry>, excluding any scrollback).
		564
398	=item $nsaved = $term->nsaved	565	=item $nsaved = $term->nsaved
399		566
400	Returns the number of lines in the scrollback buffer.	567	Returns the number of lines in the scrollback buffer.
401		568
402	=item $view_start = $term->view_start ([$newvalue])	569	=item $view_start = $term->view_start ([$newvalue])
403		570
404	Returns the negative row number of the topmost line. Minimum value is	571	Returns the negative row number of the topmost line. Minimum value is
405	C<0>, which displays the normal terminal contents. Larger values scroll	572	C<0>, which displays the normal terminal contents. Larger values scroll
406	this many lines into the scrollback buffer.	573	this many lines into the scrollback buffer.
407		574
		575	=item $term->want_refresh
		576
		577	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		578	compare the on-screen display with its stored representation. If they
		579	differ, it redraws the differences.
		580
		581	Used after changing terminal contents to display them.
		582
408	=item $text = $term->ROW_t ($row_number[, $new_text])	583	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
409		584
410	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>
411	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
412	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
413	line C<< -$term->nsaved >>.	588	line C<< -$term->nsaved >>.
414		589
415	If C<$new_text> is specified, it will completely replace the current line.	590	If C<$new_text> is specified, it will replace characters in the current
		591	line, starting at column C<$start_col> (default C<0>), which is useful
		592	to replace only parts of a line. The font index in the rendition will
		593	automatically be updated.
416		594
417	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
418	than one cell when displayed are padded with urxvt::NOCHAR characters	596	than one cell when displayed are padded with urxvt::NOCHAR characters
419	(C<chr 65535>). Characters with combining characters and other characters	597	(C<chr 65535>). Characters with combining characters and other characters
420	that do not fit into the normal tetx encoding will be replaced with	598	that do not fit into the normal tetx encoding will be replaced with
…		…
425	characters.	603	characters.
426		604
427	The methods C<< $term->special_encode >> and C<< $term->special_decode >>	605	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
428	can be used to convert normal strings into this encoding and vice versa.	606	can be used to convert normal strings into this encoding and vice versa.
429		607
430	=item $rend = $term->ROW_r ($row_number[, $new_rend])	608	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
431		609
432	Like C<< $term->ROW_t >>	610	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		611	bitsets. Rendition bitsets contain information about colour, font, font
		612	styles and similar information. See also C<< $term->ROW_t >>.
		613
		614	When setting rendition, the font mask will be ignored.
		615
		616	See the section on RENDITION, above.
		617
		618	=item $length = $term->ROW_l ($row_number[, $new_length])
		619
		620	Returns the number of screen cells that are in use ("the line length"). If
		621	it is C<-1>, then the line is part of a multiple-row logical "line", which
		622	means all characters are in use and it is continued on the next row.
433		623
434	=item $text = $term->special_encode $string	624	=item $text = $term->special_encode $string
435		625
436	Converts a perl string into the special encoding used by rxvt-unicode,	626	Converts a perl string into the special encoding used by rxvt-unicode,
437	where one character corresponds to one screen cell. See	627	where one character corresponds to one screen cell. See
…		…
447	=head2 The C<urxvt::timer> Class	637	=head2 The C<urxvt::timer> Class
448		638
449	This class implements timer watchers/events. Time is represented as a	639	This class implements timer watchers/events. Time is represented as a
450	fractional number of seconds since the epoch. Example:	640	fractional number of seconds since the epoch. Example:
451		641
452	# create a digital clock display in upper right corner	642	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
453	$term->{timer} = urxvt::timer	643	$term->{timer} = urxvt::timer
454	->new	644	->new
455	->start (urxvt::NOW)	645	->interval (1)
456	->cb (sub {	646	->cb (sub {
457	my ($timer) = @_;
458	my $time = $timer->at;
459	$timer->start ($time + 1);
460	$self->scr_overlay (-1, 0,	647	$term->{overlay}->set (0, 0,
461	POSIX::strftime "%H:%M:%S", localtime $time);	648	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
462	});	649	});
463		650
464	=over 4	651	=over 4
465		652
466	=item $timer = new urxvt::timer	653	=item $timer = new urxvt::timer
467		654
468	Create a new timer object in stopped state.	655	Create a new timer object in started state. It is scheduled to fire
		656	immediately.
469		657
470	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	658	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
471		659
472	Set the callback to be called when the timer triggers.	660	Set the callback to be called when the timer triggers.
473		661
…		…
476	Return the time this watcher will fire next.	664	Return the time this watcher will fire next.
477		665
478	=item $timer = $timer->set ($tstamp)	666	=item $timer = $timer->set ($tstamp)
479		667
480	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.
481		675
482	=item $timer = $timer->start	676	=item $timer = $timer->start
483		677
484	Start the timer.	678	Start the timer.
485		679

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.12 by root, Mon Jan 2 22:23:26 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.12 by root, Mon Jan 2 22:23:26 2006 UTC vs.
Revision 1.23 by root, Tue Jan 3 19:42:53 2006 UTC