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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.9 by root, Mon Jan 2 20:40:20 2006 UTC vs.
Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	rxvtperl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
6		8
7	* Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl/>, they will be loaded automatically.	9	# create a file grab_test in $HOME:
8
9	* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
10	thus must be encoded as UTF-8.
11		10
12	sub on_sel_grab {	11	sub on_sel_grab {
13	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
14	()	13	()
15	}	14	}
16		15
17	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
18		19
19	=head1 DESCRIPTION	20	=head1 DESCRIPTION
20		21
21	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, scripts specified via the
22	C<perl> resource are associated with it.	23	C<perl> resource are loaded and associated with it.
		24
		25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		26	thus must be encoded as UTF-8.
23		27
24	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
25	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	Miscellaneous selection modifications.
		45
		46	=over 4
		47
		48	=item rot13
		49
		50	Rot-13 the selection when activated. Used via keyboard trigger:
		51
		52	URxvt.keysym.C-M-r: perl:selection:rot13
		53
		54	=back
		55
		56	=item digital-clock
		57
		58	Displays a digital clock using the built-in overlay.
		59
		60	=item example-refresh-hooks
		61
		62	Displays a very simple digital clock in the upper right corner of the
		63	window. Illustrates overwriting the refresh callbacks to create your own
		64	overlays or changes.
		65
		66	=back
26		67
27	=head2 General API Considerations	68	=head2 General API Considerations
28		69
29	All objects (such as terminals, time watchers etc.) are typical	70	All objects (such as terminals, time watchers etc.) are typical
30	reference-to-hash objects. The hash can be used to store anything you	71	reference-to-hash objects. The hash can be used to store anything you
122		163
123	=item on_refresh_end $term	164	=item on_refresh_end $term
124		165
125	Called just after the screen gets redrawn. See C<on_refresh_begin>.	166	Called just after the screen gets redrawn. See C<on_refresh_begin>.
126		167
		168	=item on_keyboard_command $term, $string
		169
		170	Called whenever the user presses a key combination that has a
		171	C<perl:string> action bound to it (see description of the B<keysym>
		172	resource in the @@RXVT_NAME@@(1) manpage).
		173
127	=back	174	=back
128		175
129	=head2 Functions in the C<urxvt> Package	176	=head2 Functions in the C<urxvt> Package
130		177
131	=over 4	178	=over 4
…		…
146	correct place, e.g. on stderr of the connecting urxvtc client.	193	correct place, e.g. on stderr of the connecting urxvtc client.
147		194
148	=item $time = urxvt::NOW	195	=item $time = urxvt::NOW
149		196
150	Returns the "current time" (as per the event loop).	197	Returns the "current time" (as per the event loop).
		198
		199	=back
		200
		201	=head2 RENDITION
		202
		203	Rendition bitsets contain information about colour, font, font styles and
		204	similar information for each screen cell.
		205
		206	The following "macros" deal with changes in rendition sets. You should
		207	never just create a bitset, you should always modify an existing one,
		208	as they contain important information required for correct operation of
		209	rxvt-unicode.
		210
		211	=over 4
		212
		213	=item $rend = urxvt::DEFAULT_RSTYLE
		214
		215	Returns the default rendition, as used when the terminal is starting up or
		216	being reset. Useful as a base to start when creating renditions.
		217
		218	=item $rend = urxvt::OVERLAY_RSTYLE
		219
		220	Return the rendition mask used for overlays by default.
		221
		222	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		223
		224	Return the bit that enabled bold, italic, blink, reverse-video and
		225	underline, respectively. To enable such a style, just logically OR it into
		226	the bitset.
		227
		228	=item $foreground = urxvt::GET_BASEFG $rend
		229
		230	=item $background = urxvt::GET_BASEBG $rend
		231
		232	Return the foreground/background colour index, respectively.
		233
		234	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		235
		236	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		237
		238	Replace the foreground/background colour in the rendition mask with the
		239	specified one.
		240
		241	=item $value = urxvt::GET_CUSTOM ($rend)
		242
		243	Return the "custom" value: Every rendition has 5 bits for use by
		244	extensions. They can be set and changed as you like and are initially
		245	zero.
		246
		247	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		248
		249	Change the custom value.
		250
		251	=back
151		252
152	=cut	253	=cut
153		254
154	package urxvt;	255	package urxvt;
155		256
…		…
259	return 1 if $v->($term, @_);	360	return 1 if $v->($term, @_);
260	}	361	}
261		362
262	0	363	0
263	}	364	}
264
265	=back
266		365
267	=head2 The C<urxvt::term> Class	366	=head2 The C<urxvt::term> Class
268		367
269	=over 4	368	=over 4
270		369
…		…
326		425
327	=item $oldtext = $term->selection ([$newtext])	426	=item $oldtext = $term->selection ([$newtext])
328		427
329	Return the current selection text and optionally replace it by C<$newtext>.	428	Return the current selection text and optionally replace it by C<$newtext>.
330		429
331	=item $term->scr_overlay ($x, $y, $text)	430	#=item $term->overlay ($x, $y, $text)
332		431	#
333	Create a simple multi-line overlay box. See the next method for details.	432	#Create a simple multi-line overlay box. See the next method for details.
334		433	#
335	=cut	434	#=cut
336		435
337	sub urxvt::term::scr_overlay {	436	sub urxvt::term::scr_overlay {
		437	die;
338	my ($self, $x, $y, $text) = @_;	438	my ($self, $x, $y, $text) = @_;
339		439
340	my @lines = split /\n/, $text;	440	my @lines = split /\n/, $text;
341		441
342	my $w = 0;	442	my $w = 0;
…		…
346		446
347	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	447	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
348	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	448	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
349	}	449	}
350		450
351	=item $term->scr_overlay_new ($x, $y, $width, $height)	451	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
352		452
353	Create a new (empty) overlay at the given position with the given	453	Create a new (empty) overlay at the given position with the given
354	width/height. A border will be put around the box. If either C<$x> or	454	width/height. C<$rstyle> defines the initial rendition style
355	C<$y> is negative, then this is counted from the right/bottom side,	455	(default: C<OVERLAY_RSTYLE>).
356	respectively.
357		456
358	=item $term->scr_overlay_off	457	If C<$border> is C<2> (default), then a decorative border will be put
		458	around the box.
359		459
360	Switch the overlay off again.	460	If either C<$x> or C<$y> is negative, then this is counted from the
		461	right/bottom side, respectively.
361		462
362	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)	463	This method returns an urxvt::overlay object. The overlay will be visible
		464	as long as the perl object is referenced.
363		465
364	Put a single character (specified numerically) at the given overlay	466	Currently, the only method on the C<urxvt::overlay> object is C<set>:
365	position.
366		467
367	=item $term->scr_overlay_set ($x, $y, $text)	468	=item $overlay->set ($x, $y, $text, $rend)
368		469
369	Write a string at the given position into the overlay.	470	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		471	text in rxvt-unicode's special encoding and an array of rendition values
		472	at a specific position inside the overlay.
370		473
371	=item $cellwidth = $term->strwidth $string	474	=item $cellwidth = $term->strwidth $string
372		475
373	Returns the number of screen-cells this string would need. Correctly	476	Returns the number of screen-cells this string would need. Correctly
374	accounts for wide and combining characters.	477	accounts for wide and combining characters.
…		…
382	Convert the given locale-encoded octets into a perl string.	485	Convert the given locale-encoded octets into a perl string.
383		486
384	=item $term->tt_write ($octets)	487	=item $term->tt_write ($octets)
385		488
386	Write the octets given in C<$data> to the tty (i.e. as program input). To	489	Write the octets given in C<$data> to the tty (i.e. as program input). To
387	pass characters instead of octets, you should convetr you strings first to	490	pass characters instead of octets, you should convert your strings first
388	the locale-specific encoding using C<< $term->locale_encode >>.	491	to the locale-specific encoding using C<< $term->locale_encode >>.
		492
		493	=item $nrow = $term->nrow
		494
		495	=item $ncol = $term->ncol
		496
		497	Return the number of rows/columns of the terminal window (i.e. as
		498	specified by C<-geometry>, excluding any scrollback).
		499
		500	=item $nsaved = $term->nsaved
		501
		502	Returns the number of lines in the scrollback buffer.
		503
		504	=item $view_start = $term->view_start ([$newvalue])
		505
		506	Returns the negative row number of the topmost line. Minimum value is
		507	C<0>, which displays the normal terminal contents. Larger values scroll
		508	this many lines into the scrollback buffer.
		509
		510	=item $term->want_refresh
		511
		512	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		513	compare the on-screen display with its stored representation. If they
		514	differ, it redraws the differences.
		515
		516	Used after changing terminal contents to display them.
		517
		518	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		519
		520	Returns the text of the entire row with number C<$row_number>. Row C<0>
		521	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		522	terminal line. The scrollback buffer starts at line C<-1> and extends to
		523	line C<< -$term->nsaved >>.
		524
		525	If C<$new_text> is specified, it will replace characters in the current
		526	line, starting at column C<$start_col> (default C<0>), which is useful
		527	to replace only parts of a line. The font index in the rendition will
		528	automatically be updated.
		529
		530	C<$text> is in a special encoding: tabs and wide characters that use more
		531	than one cell when displayed are padded with urxvt::NOCHAR characters
		532	(C<chr 65535>). Characters with combining characters and other characters
		533	that do not fit into the normal tetx encoding will be replaced with
		534	characters in the private use area.
		535
		536	You have to obey this encoding when changing text. The advantage is
		537	that C<substr> and similar functions work on screen cells and not on
		538	characters.
		539
		540	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		541	can be used to convert normal strings into this encoding and vice versa.
		542
		543	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		544
		545	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		546	bitsets. Rendition bitsets contain information about colour, font, font
		547	styles and similar information. See also C<< $term->ROW_t >>.
		548
		549	When setting rendition, the font mask will be ignored.
		550
		551	See the section on RENDITION, above.
		552
		553	=item $length = $term->ROW_l ($row_number[, $new_length])
		554
		555	Returns the number of screen cells that are in use ("the line length"). If
		556	it is C<-1>, then the line is part of a multiple-row logical "line", which
		557	means all characters are in use and it is continued on the next row.
		558
		559	=item $text = $term->special_encode $string
		560
		561	Converts a perl string into the special encoding used by rxvt-unicode,
		562	where one character corresponds to one screen cell. See
		563	C<< $term->ROW_t >> for details.
		564
		565	=item $string = $term->special_decode $text
		566
		567	Converts rxvt-unicodes text reprsentation into a perl string. See
		568	C<< $term->ROW_t >> for details.
389		569
390	=back	570	=back
391		571
392	=head2 The C<urxvt::timer> Class	572	=head2 The C<urxvt::timer> Class
393		573
394	This class implements timer watchers/events. Time is represented as a	574	This class implements timer watchers/events. Time is represented as a
395	fractional number of seconds since the epoch. Example:	575	fractional number of seconds since the epoch. Example:
396		576
397	# create a digital clock display in upper right corner	577	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
398	$term->{timer} = urxvt::timer	578	$term->{timer} = urxvt::timer
399	->new	579	->new
400	->start (urxvt::NOW)	580	->interval (1)
401	->cb (sub {	581	->cb (sub {
402	my ($timer) = @_;
403	my $time = $timer->at;
404	$timer->start ($time + 1);
405	$self->scr_overlay (-1, 0,	582	$term->{overlay}->set (0, 0,
406	POSIX::strftime "%H:%M:%S", localtime $time);	583	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
407	});	584	});
408		585
409	=over 4	586	=over 4
410		587
411	=item $timer = new urxvt::timer	588	=item $timer = new urxvt::timer
412		589
413	Create a new timer object in stopped state.	590	Create a new timer object in started state. It is scheduled to fire
		591	immediately.
414		592
415	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	593	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
416		594
417	Set the callback to be called when the timer triggers.	595	Set the callback to be called when the timer triggers.
418		596
…		…
421	Return the time this watcher will fire next.	599	Return the time this watcher will fire next.
422		600
423	=item $timer = $timer->set ($tstamp)	601	=item $timer = $timer->set ($tstamp)
424		602
425	Set the time the event is generated to $tstamp.	603	Set the time the event is generated to $tstamp.
		604
		605	=item $timer = $timer->interval ($interval)
		606
		607	Normally (and when C<$interval> is C<0>), the timer will automatically
		608	stop after it has fired once. If C<$interval> is non-zero, then the timer
		609	is automatically rescheduled at the given intervals.
426		610
427	=item $timer = $timer->start	611	=item $timer = $timer->start
428		612
429	Start the timer.	613	Start the timer.
430		614

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.9 by root, Mon Jan 2 20:40:20 2006 UTC vs. Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.9 by root, Mon Jan 2 20:40:20 2006 UTC vs.
Revision 1.21 by root, Tue Jan 3 04:20:37 2006 UTC