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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.7 by root, Mon Jan 2 19:05:05 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	* 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	On startup, @@RXVT_NAME@@ will scan F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>	22	Everytime a terminal object gets created, scripts specified via the
22	for files and will load them. Everytime a terminal object gets created,	23	C<perl> resource are loaded and associated with it.
23	the directory specified by the C<perl-lib> resource will be additionally	24
24	scanned.	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		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 for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
28		30
29	Hooks in scripts specified by C<perl-lib> will only be called for the	31	=head2 Prepackaged Extensions
30	terminals created with that specific option value.	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
31		67
32	=head2 General API Considerations	68	=head2 General API Considerations
33		69
34	All objects (such as terminals, time watchers etc.) are typical	70	All objects (such as terminals, time watchers etc.) are typical
35	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
127		163
128	=item on_refresh_end $term	164	=item on_refresh_end $term
129		165
130	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>.
131		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
132	=back	174	=back
133		175
134	=head2 Functions in the C<urxvt> Package	176	=head2 Functions in the C<urxvt> Package
135		177
136	=over 4	178	=over 4
…		…
151	correct place, e.g. on stderr of the connecting urxvtc client.	193	correct place, e.g. on stderr of the connecting urxvtc client.
152		194
153	=item $time = urxvt::NOW	195	=item $time = urxvt::NOW
154		196
155	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
156		250
157	=cut	251	=cut
158		252
159	package urxvt;	253	package urxvt;
160		254
…		…
174	unless $msg =~ /\n$/;	268	unless $msg =~ /\n$/;
175	urxvt::warn ($msg);	269	urxvt::warn ($msg);
176	};	270	};
177	}	271	}
178		272
		273	my @hook_count;
179	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	274	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
180		275
181	sub verbose {	276	sub verbose {
182	my ($level, $msg) = @_;	277	my ($level, $msg) = @_;
183	warn "$msg\n" if $level < $verbosity;	278	warn "$msg\n" if $level <= $verbosity;
184	}
185
186	my %hook_global;
187	my @hook_count;
188
189	# called by the rxvt core
190	sub invoke {
191	local $term = shift;
192	my $htype = shift;
193
194	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
195	if $verbosity >= 10;
196
197	for my $cb ($hook_global{_hook}[$htype], $term->{_hook}[$htype]) {
198	$cb or next;
199
200	while (my ($k, $v) = each %$cb) {
201	return 1 if $v->($term, @_);
202	}
203	}
204
205	0
206	}	279	}
207		280
208	# find on_xxx subs in the package and register them	281	# find on_xxx subs in the package and register them
209	# as hooks	282	# as hooks
210	sub register_package($) {	283	sub register_package($) {
…		…
228	# load a single script into its own package, once only	301	# load a single script into its own package, once only
229	sub script_package($) {	302	sub script_package($) {
230	my ($path) = @_;	303	my ($path) = @_;
231		304
232	$script_pkg{$path} \|\|= do {	305	$script_pkg{$path} \|\|= do {
233	my $pkg = $script_pkg++;	306	my $pkg = "urxvt::" . ($script_pkg++);
		307
234	verbose 3, "loading script '$path' into package '$pkg'";	308	verbose 3, "loading script '$path' into package '$pkg'";
235		309
236	open my $fh, "<:raw", $path	310	open my $fh, "<:raw", $path
237	or die "$path: $!";	311	or die "$path: $!";
238		312
239	eval "package $pkg; use strict; use utf8;\n"	313	my $source = "package $pkg; use strict; use utf8;\n"
240	. "#line 1 \"$path\"\n"	314	. "#line 1 \"$path\"\n{\n"
241	. do { local $/; <$fh> }	315	. (do { local $/; <$fh> })
		316	. "\n};\n1";
		317
242	or die "$path: $@";	318	eval $source or die "$path: $@";
243		319
244	$pkg	320	$pkg
245	}	321	}
246	}	322	}
247		323
248	sub load_scripts($) {	324	# called by the rxvt core
249	my ($dir) = @_;	325	sub invoke {
		326	local $term = shift;
		327	my $htype = shift;
250		328
251	verbose 3, "loading scripts from '$dir'";	329	if ($htype == 0) { # INIT
		330	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");
252		331
		332	for my $ext (split /:/, $term->resource ("perl_ext")) {
		333	my @files = grep -f $_, map "$_/$ext", @dirs;
		334
		335	if (@files) {
253	register_package script_package $_	336	register_package script_package $files[0];
254	for grep -f $_,	337	} else {
255	<$dir/*>;	338	warn "perl extension '$ext' not found in perl library search path\n";
256	}	339	}
		340	}
257		341
258	sub on_init {	342	} elsif ($htype == 1) { # DESTROY
259	my ($term) = @_;
260
261	my $libdir = $term->resource ("perl_lib");
262
263	load_scripts $libdir
264	if defined $libdir;
265	}
266
267	sub on_destroy {
268	my ($term) = @_;
269
270	my $hook = $term->{_hook}	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]
271	or return;	352	or return;
272		353
273	for my $htype (0..$#$hook) {	354	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
274	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	355	if $verbosity >= 10;
275	or set_should_invoke $htype, 0;	356
		357	while (my ($k, $v) = each %$cb) {
		358	return 1 if $v->($term, @_);
276	}	359	}
277	}
278		360
279	{	361	0
280	local $term = \%hook_global;
281
282	register_package __PACKAGE__;
283	load_scripts "$LIBDIR/perl-ext";
284	}	362	}
285		363
286	=back	364	=back
287		365
288	=head2 The C<urxvt::term> Class	366	=head2 The C<urxvt::term> Class
…		…
312		390
313	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	391	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
314	borderLess color cursorBlink cursorUnderline cutchars delete_key	392	borderLess color cursorBlink cursorUnderline cutchars delete_key
315	display_name embed ext_bwidth fade font geometry hold iconName	393	display_name embed ext_bwidth fade font geometry hold iconName
316	imFont imLocale inputMethod insecure int_bwidth intensityStyles	394	imFont imLocale inputMethod insecure int_bwidth intensityStyles
317	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	395	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
318	modifier mouseWheelScrollPage name pastableTabs path perl perl_eval	396	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
319	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	397	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
320	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	398	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
321	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	399	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
322	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	400	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
323	shade term_name title transparent transparent_all tripleclickwords	401	shade term_name title transparent transparent_all tripleclickwords
…		…
347		425
348	=item $oldtext = $term->selection ([$newtext])	426	=item $oldtext = $term->selection ([$newtext])
349		427
350	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>.
351		429
352	=item $term->scr_overlay ($x, $y, $text)	430	#=item $term->overlay ($x, $y, $text)
353		431	#
354	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.
355		433	#
356	=cut	434	#=cut
357		435
358	sub urxvt::term::scr_overlay {	436	sub urxvt::term::scr_overlay {
		437	die;
359	my ($self, $x, $y, $text) = @_;	438	my ($self, $x, $y, $text) = @_;
360		439
361	my @lines = split /\n/, $text;	440	my @lines = split /\n/, $text;
362		441
363	my $w = 0;	442	my $w = 0;
…		…
367		446
368	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	447	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
369	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	448	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
370	}	449	}
371		450
372	=item $term->scr_overlay_new ($x, $y, $width, $height)	451	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
373		452
374	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
375	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
376	C<$y> is negative, then this is counted from the right/bottom side,	455	(default: C<OVERLAY_RSTYLE>).
377	respectively.
378		456
379	=item $term->scr_overlay_off	457	If C<$border> is C<2> (default), then a decorative border will be put
		458	around the box.
380		459
381	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.
382		462
383	=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.
384		465
385	Put a single character (specified numerically) at the given overlay	466	Currently, the only method on the C<urxvt::overlay> object is C<set>:
386	position.
387		467
388	=item $term->scr_overlay_set ($x, $y, $text)	468	=item $overlay->set ($x, $y, $text, $rend)
389		469
390	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.
391		473
392	=item $cellwidth = $term->strwidth $string	474	=item $cellwidth = $term->strwidth $string
393		475
394	Returns the number of screen-cells this string would need. Correctly	476	Returns the number of screen-cells this string would need. Correctly
395	accounts for wide and combining characters.	477	accounts for wide and combining characters.
…		…
403	Convert the given locale-encoded octets into a perl string.	485	Convert the given locale-encoded octets into a perl string.
404		486
405	=item $term->tt_write ($octets)	487	=item $term->tt_write ($octets)
406		488
407	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
408	pass characters instead of octets, you should convetr you strings first to	490	pass characters instead of octets, you should convert your strings first
409	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.
410		569
411	=back	570	=back
412		571
413	=head2 The C<urxvt::timer> Class	572	=head2 The C<urxvt::timer> Class
414		573
415	This class implements timer watchers/events. Time is represented as a	574	This class implements timer watchers/events. Time is represented as a
416	fractional number of seconds since the epoch. Example:	575	fractional number of seconds since the epoch. Example:
417		576
418	# create a digital clock display in upper right corner	577	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
419	$term->{timer} = urxvt::timer	578	$term->{timer} = urxvt::timer
420	->new	579	->new
421	->start (urxvt::NOW)	580	->interval (1)
422	->cb (sub {	581	->cb (sub {
423	my ($timer) = @_;
424	my $time = $timer->at;
425	$timer->start ($time + 1);
426	$self->scr_overlay (-1, 0,	582	$term->{overlay}->set (0, 0,
427	POSIX::strftime "%H:%M:%S", localtime $time);	583	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
428	});	584	});
429		585
430	=over 4	586	=over 4
431		587
432	=item $timer = new urxvt::timer	588	=item $timer = new urxvt::timer
433		589
434	Create a new timer object in stopped state.	590	Create a new timer object in started state. It is scheduled to fire
		591	immediately.
435		592
436	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	593	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
437		594
438	Set the callback to be called when the timer triggers.	595	Set the callback to be called when the timer triggers.
439		596
…		…
442	Return the time this watcher will fire next.	599	Return the time this watcher will fire next.
443		600
444	=item $timer = $timer->set ($tstamp)	601	=item $timer = $timer->set ($tstamp)
445		602
446	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.
447		610
448	=item $timer = $timer->start	611	=item $timer = $timer->start
449		612
450	Start the timer.	613	Start the timer.
451		614

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.7 by root, Mon Jan 2 19:05:05 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.7 by root, Mon Jan 2 19:05:05 2006 UTC vs.
Revision 1.20 by root, Tue Jan 3 04:18:47 2006 UTC