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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.6 by root, Mon Jan 2 18:20:23 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
36	like. The only reserved member is C<_ptr>, which must not be changed.	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).
37		75
38	When objects are destroyed on the C++ side, the perl object hashes are	76	When objects are destroyed on the C++ side, the perl object hashes are
39	emptied, so its best to store related objects such as time watchers and	77	emptied, so its best to store related objects such as time watchers and
40	the like inside the terminal object so they get destroyed as soon as the	78	the like inside the terminal object so they get destroyed as soon as the
41	terminal is destroyed.	79	terminal is destroyed.
125		163
126	=item on_refresh_end $term	164	=item on_refresh_end $term
127		165
128	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>.
129		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
130	=back	174	=back
131		175
132	=head2 Functions in the C<urxvt> Package	176	=head2 Functions in the C<urxvt> Package
133		177
134	=over 4	178	=over 4
…		…
149	correct place, e.g. on stderr of the connecting urxvtc client.	193	correct place, e.g. on stderr of the connecting urxvtc client.
150		194
151	=item $time = urxvt::NOW	195	=item $time = urxvt::NOW
152		196
153	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
154		250
155	=cut	251	=cut
156		252
157	package urxvt;	253	package urxvt;
158		254
…		…
172	unless $msg =~ /\n$/;	268	unless $msg =~ /\n$/;
173	urxvt::warn ($msg);	269	urxvt::warn ($msg);
174	};	270	};
175	}	271	}
176		272
		273	my @hook_count;
177	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	274	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
178		275
179	sub verbose {	276	sub verbose {
180	my ($level, $msg) = @_;	277	my ($level, $msg) = @_;
181	warn "$msg\n"; #d#	278	warn "$msg\n" if $level <= $verbosity;
182	}	279	}
183		280
184	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	}
185		323
186	# called by the rxvt core	324	# called by the rxvt core
187	sub invoke {	325	sub invoke {
188	local $term = shift;	326	local $term = shift;
189	my $htype = shift;	327	my $htype = shift;
190		328
191	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;
192		353
193	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	354	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
194	if $verbosity >= 10;	355	if $verbosity >= 10;
195		356
196	while (my ($k, $v) = each %$cb) {	357	while (my ($k, $v) = each %$cb) {
197	return 1 if $v->($term, @_);	358	return 1 if $v->($term, @_);
198	}	359	}
199		360
200	0	361	0
201	}	362	}
202
203	# find on_xxx subs in the package and register them
204	# as hooks
205	sub register_package($) {
206	my ($pkg) = @_;
207
208	for my $hook (0.. $#HOOKNAME) {
209	my $name = $HOOKNAME[$hook];
210
211	my $ref = $pkg->can ("on_" . lc $name)
212	or next;
213
214	$invoke_cb[$hook]{$ref*1} = $ref;
215	set_should_invoke $hook, 1;
216	}
217	}
218
219	my $script_pkg = "script0000";
220	my %script_pkg;
221
222	# load a single script into its own package, once only
223	sub load_script($) {
224	my ($path) = @_;
225
226	$script_pkg{$path} \|\|= do {
227	my $pkg = $script_pkg++;
228	verbose 3, "loading script '$path' into package '$pkg'";
229
230	open my $fh, "<:raw", $path
231	or die "$path: $!";
232
233	eval "package $pkg; use strict; use utf8;\n"
234	. "#line 1 \"$path\"\n"
235	. do { local $/; <$fh> }
236	or die "$path: $@";
237
238	register_package $pkg;
239
240	$pkg
241	};
242	}
243
244	sub load_scripts($) {
245	my ($dir) = @_;
246
247	verbose 3, "loading scripts from '$dir'";
248
249	load_script $_
250	for grep -f $_,
251	<$dir/perl-ext/*>;
252	}
253
254	sub on_init {
255	my ($term) = @_;
256
257	my $libdir = $term->resource ("perl_lib");
258
259	load_scripts $libdir
260	if defined $libdir;
261	}
262
263	register_package __PACKAGE__;
264	load_scripts $LIBDIR;
265		363
266	=back	364	=back
267		365
268	=head2 The C<urxvt::term> Class	366	=head2 The C<urxvt::term> Class
269		367
…		…
292		390
293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	391	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
294	borderLess color cursorBlink cursorUnderline cutchars delete_key	392	borderLess color cursorBlink cursorUnderline cutchars delete_key
295	display_name embed ext_bwidth fade font geometry hold iconName	393	display_name embed ext_bwidth fade font geometry hold iconName
296	imFont imLocale inputMethod insecure int_bwidth intensityStyles	394	imFont imLocale inputMethod insecure int_bwidth intensityStyles
297	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	395	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
298	modifier mouseWheelScrollPage name pastableTabs path perl perl_eval	396	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
299	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	397	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
300	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	398	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
301	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	399	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
302	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	400	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
303	shade term_name title transparent transparent_all tripleclickwords	401	shade term_name title transparent transparent_all tripleclickwords
…		…
327		425
328	=item $oldtext = $term->selection ([$newtext])	426	=item $oldtext = $term->selection ([$newtext])
329		427
330	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>.
331		429
332	=item $term->scr_overlay ($x, $y, $text)	430	#=item $term->overlay ($x, $y, $text)
333		431	#
334	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.
335		433	#
336	=cut	434	#=cut
337		435
338	sub urxvt::term::scr_overlay {	436	sub urxvt::term::scr_overlay {
		437	die;
339	my ($self, $x, $y, $text) = @_;	438	my ($self, $x, $y, $text) = @_;
340		439
341	my @lines = split /\n/, $text;	440	my @lines = split /\n/, $text;
342		441
343	my $w = 0;	442	my $w = 0;
…		…
347		446
348	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	447	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
349	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	448	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
350	}	449	}
351		450
352	=item $term->scr_overlay_new ($x, $y, $width, $height)	451	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
353		452
354	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
355	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
356	C<$y> is negative, then this is counted from the right/bottom side,	455	(default: C<OVERLAY_RSTYLE>).
357	respectively.
358		456
359	=item $term->scr_overlay_off	457	If C<$border> is C<2> (default), then a decorative border will be put
		458	around the box.
360		459
361	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.
362		462
363	=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.
364		465
365	Put a single character (specified numerically) at the given overlay	466	Currently, the only method on the C<urxvt::overlay> object is C<set>:
366	position.
367		467
368	=item $term->scr_overlay_set ($x, $y, $text)	468	=item $overlay->set ($x, $y, $text, $rend)
369		469
370	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.
371		473
372	=item $cellwidth = $term->strwidth $string	474	=item $cellwidth = $term->strwidth $string
373		475
374	Returns the number of screen-cells this string would need. Correctly	476	Returns the number of screen-cells this string would need. Correctly
375	accounts for wide and combining characters.	477	accounts for wide and combining characters.
…		…
383	Convert the given locale-encoded octets into a perl string.	485	Convert the given locale-encoded octets into a perl string.
384		486
385	=item $term->tt_write ($octets)	487	=item $term->tt_write ($octets)
386		488
387	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
388	pass characters instead of octets, you should convetr you strings first to	490	pass characters instead of octets, you should convert your strings first
389	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.
390		569
391	=back	570	=back
392		571
393	=head2 The C<urxvt::timer> Class	572	=head2 The C<urxvt::timer> Class
394		573
395	This class implements timer watchers/events. Time is represented as a	574	This class implements timer watchers/events. Time is represented as a
396	fractional number of seconds since the epoch. Example:	575	fractional number of seconds since the epoch. Example:
397		576
398	# create a digital clock display in upper right corner	577	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
399	$term->{timer} = urxvt::timer	578	$term->{timer} = urxvt::timer
400	->new	579	->new
401	->start (urxvt::NOW)	580	->interval (1)
402	->cb (sub {	581	->cb (sub {
403	my ($timer) = @_;
404	my $time = $timer->at;
405	$timer->start ($time + 1);
406	$self->scr_overlay (-1, 0,	582	$term->{overlay}->set (0, 0,
407	POSIX::strftime "%H:%M:%S", localtime $time);	583	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
408	});	584	});
409		585
410	=over 4	586	=over 4
411		587
412	=item $timer = new urxvt::timer	588	=item $timer = new urxvt::timer
413		589
414	Create a new timer object in stopped state.	590	Create a new timer object in started state. It is scheduled to fire
		591	immediately.
415		592
416	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	593	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
417		594
418	Set the callback to be called when the timer triggers.	595	Set the callback to be called when the timer triggers.
419		596
…		…
422	Return the time this watcher will fire next.	599	Return the time this watcher will fire next.
423		600
424	=item $timer = $timer->set ($tstamp)	601	=item $timer = $timer->set ($tstamp)
425		602
426	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.
427		610
428	=item $timer = $timer->start	611	=item $timer = $timer->start
429		612
430	Start the timer.	613	Start the timer.
431		614

Diff Legend

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

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