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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.4 by root, Mon Jan 2 17:17:02 2006 UTC vs.
Revision 1.20 by root, Tue Jan 3 04:18:47 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-ext/>, they will be loaded automatically.	9	# create a file grab_test in $HOME:
8
9	* Each script will only be loaded once, even in urxvtd, and will be valid
10	globally.
11
12	* Scripts are evaluated in a 'use strict' and 'use utf8' environment, and
13	thus must be encoded as UTF-8.
14		10
15	sub on_sel_grab {	11	sub on_sel_grab {
16	warn "you selected ", $_[0]->selection;	12	warn "you selected ", $_[0]->selection;
17	()	13	()
18	}	14	}
19		15
20	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
21		19
22	=head1 DESCRIPTION	20	=head1 DESCRIPTION
		21
		22	Everytime a terminal object gets created, scripts specified via the
		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.
		27
		28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
		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
		67
		68	=head2 General API Considerations
		69
		70	All objects (such as terminals, time watchers etc.) are typical
		71	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
		73	C<_hook>) are reserved for internal uses and must not be accessed or
		74	modified).
		75
		76	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
		78	the like inside the terminal object so they get destroyed as soon as the
		79	terminal is destroyed.
23		80
24	=head2 Hooks	81	=head2 Hooks
25		82
26	The following subroutines can be declared in loaded scripts, and will be called	83	The following subroutines can be declared in loaded scripts, and will be called
27	whenever the relevant event happens.	84	whenever the relevant event happens.
106		163
107	=item on_refresh_end $term	164	=item on_refresh_end $term
108		165
109	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>.
110		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
111	=back	174	=back
112		175
113	=head2 Functions in the C<urxvt> Package	176	=head2 Functions in the C<urxvt> Package
114		177
115	=over 4	178	=over 4
…		…
120	costs! The only time this is acceptable is when the terminal process	183	costs! The only time this is acceptable is when the terminal process
121	starts up.	184	starts up.
122		185
123	=item urxvt::warn $string	186	=item urxvt::warn $string
124		187
125	Calls C<rxvt_warn> witht eh given string which should not include a	188	Calls C<rxvt_warn> with the given string which should not include a
126	newline. The module also overwrites the C<warn> builtin with a function	189	newline. The module also overwrites the C<warn> builtin with a function
127	that calls this function.	190	that calls this function.
128		191
129	Using this function has the advantage that its output ends up in the	192	Using this function has the advantage that its output ends up in the
130	correct place, e.g. on stderr of the connecting urxvtc client.	193	correct place, e.g. on stderr of the connecting urxvtc client.
131		194
132	=item $cellwidth = urxvt::wcswidth $string
133
134	Returns the number of screen-cells this string would need. Correctly
135	accounts for wide and combining characters.
136
137	=item $time = urxvt::NOW	195	=item $time = urxvt::NOW
138		196
139	Returns the "current time" (as per the event loop).	197	Returns the "current time" (as per the event loop).
		198
		199	=head2 RENDITION
		200
		201	Rendition bitsets contain information about colour, font, font styles and
		202	similar information for each screen cell.
		203
		204	The following "macros" deal with changes in rendition sets. You should
		205	never just create a bitset, you should always modify an existing one,
		206	as they contain important information required for correct operation of
		207	rxvt-unicode.
		208
		209	=over 4
		210
		211	=item $rend = urxvt::DEFAULT_RSTYLE
		212
		213	Returns the default rendition, as used when the terminal is starting up or
		214	being reset. Useful as a base to start when creating renditions.
		215
		216	=item $rend = urxvt::OVERLAY_RSTYLE
		217
		218	Return the rendition mask used for overlays by default.
		219
		220	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		221
		222	Return the bit that enabled bold, italic, blink, reverse-video and
		223	underline, respectively. To enable such a style, just logically OR it into
		224	the bitset.
		225
		226	=item $foreground = urxvt::GET_BASEFG $rend
		227
		228	=item $background = urxvt::GET_BASEBG $rend
		229
		230	Return the foreground/background colour index, respectively.
		231
		232	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		233
		234	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		235
		236	Replace the foreground/background colour in the rendition mask with the
		237	specified one.
		238
		239	=item $value = urxvt::GET_CUSTOM ($rend)
		240
		241	Return the "custom" value: Every rendition has 5 bits for use by
		242	extensions. They can be set and changed as you like and are initially
		243	zero.
		244
		245	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		246
		247	Change the custom value.
		248
		249	=back
140		250
141	=cut	251	=cut
142		252
143	package urxvt;	253	package urxvt;
144		254
…		…
158	unless $msg =~ /\n$/;	268	unless $msg =~ /\n$/;
159	urxvt::warn ($msg);	269	urxvt::warn ($msg);
160	};	270	};
161	}	271	}
162		272
		273	my @hook_count;
163	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	274	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
164		275
165	sub verbose {	276	sub verbose {
166	my ($level, $msg) = @_;	277	my ($level, $msg) = @_;
167	warn "$msg\n"; #d#	278	warn "$msg\n" if $level <= $verbosity;
168	}	279	}
169		280
170	my @invoke_cb;	281	# find on_xxx subs in the package and register them
		282	# as hooks
		283	sub register_package($) {
		284	my ($pkg) = @_;
		285
		286	for my $htype (0.. $#HOOKNAME) {
		287	my $name = $HOOKNAME[$htype];
		288
		289	my $ref = $pkg->can ("on_" . lc $name)
		290	or next;
		291
		292	$term->{_hook}[$htype]{$ref*1} = $ref;
		293	$hook_count[$htype]++
		294	or set_should_invoke $htype, 1;
		295	}
		296	}
		297
		298	my $script_pkg = "script0000";
		299	my %script_pkg;
		300
		301	# load a single script into its own package, once only
		302	sub script_package($) {
		303	my ($path) = @_;
		304
		305	$script_pkg{$path} \|\|= do {
		306	my $pkg = "urxvt::" . ($script_pkg++);
		307
		308	verbose 3, "loading script '$path' into package '$pkg'";
		309
		310	open my $fh, "<:raw", $path
		311	or die "$path: $!";
		312
		313	my $source = "package $pkg; use strict; use utf8;\n"
		314	. "#line 1 \"$path\"\n{\n"
		315	. (do { local $/; <$fh> })
		316	. "\n};\n1";
		317
		318	eval $source or die "$path: $@";
		319
		320	$pkg
		321	}
		322	}
171		323
172	# called by the rxvt core	324	# called by the rxvt core
173	sub invoke {	325	sub invoke {
174	local $term = shift;	326	local $term = shift;
175	my $htype = shift;	327	my $htype = shift;
176		328
177	my $cb = $invoke_cb[$htype];	329	if ($htype == 0) { # INIT
		330	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");
		331
		332	for my $ext (split /:/, $term->resource ("perl_ext")) {
		333	my @files = grep -f $_, map "$_/$ext", @dirs;
		334
		335	if (@files) {
		336	register_package script_package $files[0];
		337	} else {
		338	warn "perl extension '$ext' not found in perl library search path\n";
		339	}
		340	}
		341
		342	} elsif ($htype == 1) { # DESTROY
		343	if (my $hook = $term->{_hook}) {
		344	for my $htype (0..$#$hook) {
		345	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		346	or set_should_invoke $htype, 0;
		347	}
		348	}
		349	}
		350
		351	my $cb = $term->{_hook}[$htype]
		352	or return;
178		353
179	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	354	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
180	if $verbosity >= 10;	355	if $verbosity >= 10;
181		356
182	while (my ($k, $v) = each %$cb) {	357	while (my ($k, $v) = each %$cb) {
…		…
184	}	359	}
185		360
186	0	361	0
187	}	362	}
188		363
189	# find on_xxx subs in the package and register them
190	# as hooks
191	sub register_package($) {
192	my ($pkg) = @_;
193
194	for my $hook (0.. $#HOOKNAME) {
195	my $name = $HOOKNAME[$hook];
196
197	my $ref = $pkg->can ("on_" . lc $name)
198	or next;
199
200	$invoke_cb[$hook]{$ref*1} = $ref;
201	set_should_invoke $hook, 1;
202	}
203	}
204
205	my $script_pkg = "script0000";
206	my %script_pkg;
207
208	# load a single script into its own package, once only
209	sub load_script($) {
210	my ($path) = @_;
211
212	$script_pkg{$path} \|\|= do {
213	my $pkg = $script_pkg++;
214	verbose 3, "loading script '$path' into package '$pkg'";
215
216	open my $fh, "<:raw", $path
217	or die "$path: $!";
218
219	eval "package $pkg; use strict; use utf8;\n"
220	. "#line 1 \"$path\"\n"
221	. do { local $/; <$fh> }
222	or die "$path: $@";
223
224	register_package $pkg;
225
226	$pkg
227	};
228	}
229
230	load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>;
231
232	=back	364	=back
233		365
234	=head2 The C<urxvt::term> Class	366	=head2 The C<urxvt::term> Class
235		367
236	=over 4	368	=over 4
…		…
249	as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will	381	as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
250	likely change).	382	likely change).
251		383
252	Please note that resource strings will currently only be freed when the	384	Please note that resource strings will currently only be freed when the
253	terminal is destroyed, so changing options frequently will eat memory.	385	terminal is destroyed, so changing options frequently will eat memory.
		386
		387	Here is a a likely non-exhaustive list of resource names, not all of which
		388	are supported in every build, please see the source to see the actual
		389	list:
		390
		391	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
		392	borderLess color cursorBlink cursorUnderline cutchars delete_key
		393	display_name embed ext_bwidth fade font geometry hold iconName
		394	imFont imLocale inputMethod insecure int_bwidth intensityStyles
		395	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
		396	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
		397	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
		398	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
		399	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
		400	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
		401	shade term_name title transparent transparent_all tripleclickwords
		402	utmpInhibit visualBell
254		403
255	=cut	404	=cut
256		405
257	sub urxvt::term::resource($$;$) {	406	sub urxvt::term::resource($$;$) {
258	my ($self, $name) = (shift, shift);	407	my ($self, $name) = (shift, shift);
…		…
276		425
277	=item $oldtext = $term->selection ([$newtext])	426	=item $oldtext = $term->selection ([$newtext])
278		427
279	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>.
280		429
281	=item $term->scr_overlay ($x, $y, $text)	430	#=item $term->overlay ($x, $y, $text)
282		431	#
283	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.
284		433	#
285	=cut	434	#=cut
286		435
287	sub urxvt::term::scr_overlay {	436	sub urxvt::term::scr_overlay {
		437	die;
288	my ($self, $x, $y, $text) = @_;	438	my ($self, $x, $y, $text) = @_;
289		439
290	my @lines = split /\n/, $text;	440	my @lines = split /\n/, $text;
291		441
292	my $w = 0;	442	my $w = 0;
293	for (map urxvt::wcswidth $_, @lines) {	443	for (map $self->strwidth ($_), @lines) {
294	$w = $_ if $w < $_;	444	$w = $_ if $w < $_;
295	}	445	}
296		446
297	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	447	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
298	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	448	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
299	}	449	}
300		450
301	=item $term->scr_overlay_new ($x, $y, $width, $height)	451	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
302		452
303	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
304	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
305	C<$y> is negative, then this is counted from the right/bottom side,	455	(default: C<OVERLAY_RSTYLE>).
306	respectively.
307		456
308	=item $term->scr_overlay_off	457	If C<$border> is C<2> (default), then a decorative border will be put
		458	around the box.
309		459
310	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.
311		462
312	=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.
313		465
314	Put a single character (specified numerically) at the given overlay	466	Currently, the only method on the C<urxvt::overlay> object is C<set>:
315	position.
316		467
317	=item $term->scr_overlay_set ($x, $y, $text)	468	=item $overlay->set ($x, $y, $text, $rend)
318		469
319	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.
		473
		474	=item $cellwidth = $term->strwidth $string
		475
		476	Returns the number of screen-cells this string would need. Correctly
		477	accounts for wide and combining characters.
		478
		479	=item $octets = $term->locale_encode $string
		480
		481	Convert the given text string into the corresponding locale encoding.
		482
		483	=item $string = $term->locale_decode $octets
		484
		485	Convert the given locale-encoded octets into a perl string.
		486
		487	=item $term->tt_write ($octets)
		488
		489	Write the octets given in C<$data> to the tty (i.e. as program input). To
		490	pass characters instead of octets, you should convert your strings first
		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.
320		569
321	=back	570	=back
322		571
323	=head2 The C<urxvt::timer> Class	572	=head2 The C<urxvt::timer> Class
324		573
325	This class implements timer watchers/events. Time is represented as a	574	This class implements timer watchers/events. Time is represented as a
326	fractional number of seconds since the epoch. Example:	575	fractional number of seconds since the epoch. Example:
327		576
328	# create a digital clock display in upper right corner	577	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
329	$term->{timer} = urxvt::timer	578	$term->{timer} = urxvt::timer
330	->new	579	->new
331	->start (urxvt::NOW)	580	->interval (1)
332	->cb (sub {	581	->cb (sub {
333	my ($timer) = @_;
334	my $time = $timer->at;
335	$timer->start ($time + 1);
336	$self->scr_overlay (-1, 0,	582	$term->{overlay}->set (0, 0,
337	POSIX::strftime "%H:%M:%S", localtime $time);	583	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
338	});	584	});
339		585
340	=over 4	586	=over 4
341		587
342	=item $timer = new urxvt::timer	588	=item $timer = new urxvt::timer
343		589
344	Create a new timer object in stopped state.	590	Create a new timer object in started state. It is scheduled to fire
		591	immediately.
345		592
346	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	593	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
347		594
348	Set the callback to be called when the timer triggers.	595	Set the callback to be called when the timer triggers.
349		596
…		…
352	Return the time this watcher will fire next.	599	Return the time this watcher will fire next.
353		600
354	=item $timer = $timer->set ($tstamp)	601	=item $timer = $timer->set ($tstamp)
355		602
356	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.
357		610
358	=item $timer = $timer->start	611	=item $timer = $timer->start
359		612
360	Start the timer.	613	Start the timer.
361		614

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.4 by root, Mon Jan 2 17:17:02 2006 UTC vs. Revision 1.20 by root, Tue Jan 3 04:18:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.4 by root, Mon Jan 2 17:17:02 2006 UTC vs.
Revision 1.20 by root, Tue Jan 3 04:18:47 2006 UTC