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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.2 by root, Mon Jan 2 15:36:27 2006 UTC vs.
Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	urxvt - 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 $LIBDIR/perl-init/, 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 written in 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;
		13	()
17	}	14	}
18		15
19	1	16	# start a @@RXVT_NAME@@ using it:
		17
		18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
20		19
21	=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 very simple digital clock in the upper right corner of the
		59	window. Illustrates overwriting the refresh callbacks to create your own
		60	overlays or changes.
		61
		62	=item simple-overlay-clock
		63
		64	Displays a digital clock using the built-in overlay (colorful, useless).
		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.
22		80
23	=head2 Hooks	81	=head2 Hooks
24		82
25	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
26	whenever the relevant event happens.	84	whenever the relevant event happens.
105		163
106	=item on_refresh_end $term	164	=item on_refresh_end $term
107		165
108	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>.
109		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
110	=back	174	=back
111		175
112	=head2 Functions in the C<urxvt> Package	176	=head2 Functions in the C<urxvt> Package
113		177
114	=over 4	178	=over 4
…		…
119	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
120	starts up.	184	starts up.
121		185
122	=item urxvt::warn $string	186	=item urxvt::warn $string
123		187
124	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
125	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
126	that calls this function.	190	that calls this function.
127		191
128	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
129	correct place, e.g. on stderr of the connecting urxvtc client.	193	correct place, e.g. on stderr of the connecting urxvtc client.
130
131	=item $cellwidth = urxvt::wcswidth $string
132
133	Returns the number of screen-cells this string would need. Correctly
134	accounts for wide and combining characters.
135		194
136	=item $time = urxvt::NOW	195	=item $time = urxvt::NOW
137		196
138	Returns the "current time" (as per the event loop).	197	Returns the "current time" (as per the event loop).
139		198
…		…
157	unless $msg =~ /\n$/;	216	unless $msg =~ /\n$/;
158	urxvt::warn ($msg);	217	urxvt::warn ($msg);
159	};	218	};
160	}	219	}
161		220
		221	my @hook_count;
162	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	222	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
163		223
164	sub verbose {	224	sub verbose {
165	my ($level, $msg) = @_;	225	my ($level, $msg) = @_;
166	warn "$msg\n"; #d#	226	warn "$msg\n" if $level <= $verbosity;
167	}	227	}
168		228
169	my @invoke_cb;	229	# find on_xxx subs in the package and register them
		230	# as hooks
		231	sub register_package($) {
		232	my ($pkg) = @_;
		233
		234	for my $htype (0.. $#HOOKNAME) {
		235	my $name = $HOOKNAME[$htype];
		236
		237	my $ref = $pkg->can ("on_" . lc $name)
		238	or next;
		239
		240	$term->{_hook}[$htype]{$ref*1} = $ref;
		241	$hook_count[$htype]++
		242	or set_should_invoke $htype, 1;
		243	}
		244	}
		245
		246	my $script_pkg = "script0000";
		247	my %script_pkg;
		248
		249	# load a single script into its own package, once only
		250	sub script_package($) {
		251	my ($path) = @_;
		252
		253	$script_pkg{$path} \|\|= do {
		254	my $pkg = "urxvt::" . ($script_pkg++);
		255
		256	verbose 3, "loading script '$path' into package '$pkg'";
		257
		258	open my $fh, "<:raw", $path
		259	or die "$path: $!";
		260
		261	my $source = "package $pkg; use strict; use utf8;\n"
		262	. "#line 1 \"$path\"\n{\n"
		263	. (do { local $/; <$fh> })
		264	. "\n};\n1";
		265
		266	eval $source or die "$path: $@";
		267
		268	$pkg
		269	}
		270	}
170		271
171	# called by the rxvt core	272	# called by the rxvt core
172	sub invoke {	273	sub invoke {
173	local $term = shift;	274	local $term = shift;
174	my $htype = shift;	275	my $htype = shift;
175		276
176	my $cb = $invoke_cb[$htype];	277	if ($htype == 0) { # INIT
		278	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");
		279
		280	for my $ext (split /:/, $term->resource ("perl_ext")) {
		281	my @files = grep -f $_, map "$_/$ext", @dirs;
		282
		283	if (@files) {
		284	register_package script_package $files[0];
		285	} else {
		286	warn "perl extension '$ext' not found in perl library search path\n";
		287	}
		288	}
		289
		290	} elsif ($htype == 1) { # DESTROY
		291	if (my $hook = $term->{_hook}) {
		292	for my $htype (0..$#$hook) {
		293	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		294	or set_should_invoke $htype, 0;
		295	}
		296	}
		297	}
		298
		299	my $cb = $term->{_hook}[$htype]
		300	or return;
177		301
178	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	302	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
179	if $verbosity >= 10;	303	if $verbosity >= 10;
180		304
181	while (my ($k, $v) = each %$cb) {	305	while (my ($k, $v) = each %$cb) {
…		…
183	}	307	}
184		308
185	0	309	0
186	}	310	}
187		311
188	# find on_xxx subs in the package and register them	312	=back
189	# as hooks
190	sub register_package($) {
191	my ($pkg) = @_;
192		313
193	for my $hook (0.. $#HOOKNAME) {	314	=head2 The C<urxvt::term> Class
194	my $name = $HOOKNAME[$hook];
195		315
196	my $ref = $pkg->can ("on_" . lc $name)	316	=over 4
197	or next;
198		317
199	$invoke_cb[$hook]{$ref*1} = $ref;	318	=item $value = $term->resource ($name[, $newval])
200	set_should_invoke $hook, 1;	319
201	}	320	Returns the current resource value associated with a given name and
		321	optionally sets a new value. Setting values is most useful in the C<init>
		322	hook. Unset resources are returned and accepted as C<undef>.
		323
		324	The new value must be properly encoded to a suitable character encoding
		325	before passing it to this method. Similarly, the returned value may need
		326	to be converted from the used encoding to text.
		327
		328	Resource names are as defined in F<src/rsinc.h>. Colours can be specified
		329	as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
		330	likely change).
		331
		332	Please note that resource strings will currently only be freed when the
		333	terminal is destroyed, so changing options frequently will eat memory.
		334
		335	Here is a a likely non-exhaustive list of resource names, not all of which
		336	are supported in every build, please see the source to see the actual
		337	list:
		338
		339	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
		340	borderLess color cursorBlink cursorUnderline cutchars delete_key
		341	display_name embed ext_bwidth fade font geometry hold iconName
		342	imFont imLocale inputMethod insecure int_bwidth intensityStyles
		343	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
		344	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
		345	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
		346	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
		347	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
		348	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
		349	shade term_name title transparent transparent_all tripleclickwords
		350	utmpInhibit visualBell
		351
		352	=cut
		353
		354	sub urxvt::term::resource($$;$) {
		355	my ($self, $name) = (shift, shift);
		356	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
		357	goto &urxvt::term::_resource;
202	}	358	}
203
204	my $script_pkg = "script0000";
205	my %script_pkg;
206
207	# load a single script into its own package, once only
208	sub load_script($) {
209	my ($path) = @_;
210
211	$script_pkg{$path} \|\|= do {
212	my $pkg = $script_pkg++;
213	verbose 3, "loading script '$path' into package '$pkg'";
214
215	open my $fh, "<:raw", $path
216	or die "$path: $!";
217
218	eval "package $pkg; use strict; use utf8;\n"
219	. "#line 1 \"$path\"\n"
220	. do { local $/; <$fh> }
221	or die "$path: $@";
222
223	register_package $pkg;
224
225	$pkg
226	};
227	}
228
229	load_script $_ for grep -f $_, <$LIBDIR/perl-ext/*>;
230
231
232	=back
233
234	=head2 The C<urxvt::term> Class
235
236	=over 4
237		359
238	=item ($row, $col) = $term->selection_mark ([$row, $col])	360	=item ($row, $col) = $term->selection_mark ([$row, $col])
239		361
240	=item ($row, $col) = $term->selection_beg ([$row, $col])	362	=item ($row, $col) = $term->selection_beg ([$row, $col])
241		363
…		…
263	my ($self, $x, $y, $text) = @_;	385	my ($self, $x, $y, $text) = @_;
264		386
265	my @lines = split /\n/, $text;	387	my @lines = split /\n/, $text;
266		388
267	my $w = 0;	389	my $w = 0;
268	for (map urxvt::wcswidth $_, @lines) {	390	for (map $self->strwidth ($_), @lines) {
269	$w = $_ if $w < $_;	391	$w = $_ if $w < $_;
270	}	392	}
271		393
272	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	394	$self->scr_overlay_new ($x, $y, $w, scalar @lines);
273	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	395	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
…		…
291		413
292	=item $term->scr_overlay_set ($x, $y, $text)	414	=item $term->scr_overlay_set ($x, $y, $text)
293		415
294	Write a string at the given position into the overlay.	416	Write a string at the given position into the overlay.
295		417
		418	=item $cellwidth = $term->strwidth $string
		419
		420	Returns the number of screen-cells this string would need. Correctly
		421	accounts for wide and combining characters.
		422
		423	=item $octets = $term->locale_encode $string
		424
		425	Convert the given text string into the corresponding locale encoding.
		426
		427	=item $string = $term->locale_decode $octets
		428
		429	Convert the given locale-encoded octets into a perl string.
		430
		431	=item $term->tt_write ($octets)
		432
		433	Write the octets given in C<$data> to the tty (i.e. as program input). To
		434	pass characters instead of octets, you should convert your strings first
		435	to the locale-specific encoding using C<< $term->locale_encode >>.
		436
		437	=item $nrow = $term->nrow
		438
		439	=item $ncol = $term->ncol
		440
		441	Return the number of rows/columns of the terminal window (i.e. as
		442	specified by C<-geometry>, excluding any scrollback).
		443
		444	=item $nsaved = $term->nsaved
		445
		446	Returns the number of lines in the scrollback buffer.
		447
		448	=item $view_start = $term->view_start ([$newvalue])
		449
		450	Returns the negative row number of the topmost line. Minimum value is
		451	C<0>, which displays the normal terminal contents. Larger values scroll
		452	this many lines into the scrollback buffer.
		453
		454	=item $term->want_refresh
		455
		456	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		457	compare the on-screen display with its stored representation. If they
		458	differ, it redraws the differences.
		459
		460	Used after changing terminal contents to display them.
		461
		462	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		463
		464	Returns the text of the entire row with number C<$row_number>. Row C<0>
		465	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		466	terminal line. The scrollback buffer starts at line C<-1> and extends to
		467	line C<< -$term->nsaved >>.
		468
		469	If C<$new_text> is specified, it will replace characters in the current
		470	line, starting at column C<$start_col> (default C<0>), which is useful
		471	to replace only parts of a line. The font iindex in the rendition will
		472	automatically be updated.
		473
		474	C<$text> is in a special encoding: tabs and wide characters that use more
		475	than one cell when displayed are padded with urxvt::NOCHAR characters
		476	(C<chr 65535>). Characters with combining characters and other characters
		477	that do not fit into the normal tetx encoding will be replaced with
		478	characters in the private use area.
		479
		480	You have to obey this encoding when changing text. The advantage is
		481	that C<substr> and similar functions work on screen cells and not on
		482	characters.
		483
		484	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		485	can be used to convert normal strings into this encoding and vice versa.
		486
		487	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		488
		489	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		490	bitsets. Rendition bitsets contain information about colour, font, font
		491	styles and similar information. See also C<< $term->ROW_t >>.
		492
		493	When setting rendition, the font mask will be ignored.
		494
		495	See the section on RENDITION, below.
		496
		497	=item $length = $term->ROW_l ($row_number[, $new_length])
		498
		499	Returns the number of screen cells that are in use ("the line length"). If
		500	it is C<-1>, then the line is part of a multiple-row logical "line", which
		501	means all characters are in use and it is continued on the next row.
		502
		503	=item $text = $term->special_encode $string
		504
		505	Converts a perl string into the special encoding used by rxvt-unicode,
		506	where one character corresponds to one screen cell. See
		507	C<< $term->ROW_t >> for details.
		508
		509	=item $string = $term->special_decode $text
		510
		511	Converts rxvt-unicodes text reprsentation into a perl string. See
		512	C<< $term->ROW_t >> for details.
		513
296	=back	514	=back
		515
		516	=head2 RENDITION
		517
		518	Rendition bitsets contain information about colour, font, font styles and
		519	similar information for each screen cell.
		520
		521	The following "macros" deal with changes in rendition sets. You should
		522	never just create a bitset, you should always modify an existing one,
		523	as they contain important information required for correct operation of
		524	rxvt-unicode.
		525
		526	=over 4
		527
		528	=item $rend = urxvt::DEFAULT_RSTYLE
		529
		530	Returns the default rendition, as used when the terminal is starting up or
		531	being reset. Useful as a base
		532
		533	=back
		534
		535	=cut
297		536
298	=head2 The C<urxvt::timer> Class	537	=head2 The C<urxvt::timer> Class
299		538
300	This class implements timer watchers/events. Time is represented as a	539	This class implements timer watchers/events. Time is represented as a
301	fractional number of seconds since the epoch. Example:	540	fractional number of seconds since the epoch. Example:
…		…
390		629
391	Stop watching for events on the given filehandle.	630	Stop watching for events on the given filehandle.
392		631
393	=back	632	=back
394		633
		634	=head1 ENVIRONMENT
		635
		636	=head2 URXVT_PERL_VERBOSITY
		637
		638	This variable controls the verbosity level of the perl extension. Higher
		639	numbers indicate more verbose output.
		640
		641	=over 4
		642
		643	=item 0 - only fatal messages
		644
		645	=item 3 - script loading and management
		646
		647	=item 10 - all events received
		648
		649	=back
		650
395	=head1 AUTHOR	651	=head1 AUTHOR
396		652
397	Marc Lehmann <pcg@goof.com>	653	Marc Lehmann <pcg@goof.com>
398	http://software.schmorp.de/pkg/rxvt-unicode	654	http://software.schmorp.de/pkg/rxvt-unicode
399		655

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.2 by root, Mon Jan 2 15:36:27 2006 UTC vs. Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.2 by root, Mon Jan 2 15:36:27 2006 UTC vs.
Revision 1.17 by root, Tue Jan 3 01:45:03 2006 UTC