[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.14 by root, Tue Jan 3 01:15:00 2006 UTC

…		…
1	=head1 NAME	1	=head1 NAME
2		2
3	rxvtperl - rxvt-unicode's embedded perl interpreter	3	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		4
5	=head1 SYNOPSIS	5	=head1 SYNOPSIS
6		6
7	* Put your scripts into F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, they will be loaded automatically.	7	# 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		8
12	sub on_sel_grab {	9	sub on_sel_grab {
13	warn "you selected ", $_[0]->selection;	10	warn "you selected ", $_[0]->selection;
14	()	11	()
15	}	12	}
16		13
17	1	14	# start a @@RXVT_NAME@@ using it:
		15
		16	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
18		17
19	=head1 DESCRIPTION	18	=head1 DESCRIPTION
20		19
21	On startup, @@RXVT_NAME@@ will scan F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>	20	Everytime a terminal object gets created, scripts specified via the
22	for files and will load them. Everytime a terminal object gets created,	21	C<perl> resource are loaded and associated with it.
23	the directory specified by the C<perl-lib> resource will be additionally	22
24	scanned.	23	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
		24	thus must be encoded as UTF-8.
25		25
26	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	26	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
27	scripts will be shared for all terminals.	27	scripts will be shared (But not enabled) for all terminals.
28
29	Hooks in scripts specified by C<perl-lib> will only be called for the
30	terminals created with that specific option value.
31		28
32	=head2 General API Considerations	29	=head2 General API Considerations
33		30
34	All objects (such as terminals, time watchers etc.) are typical	31	All objects (such as terminals, time watchers etc.) are typical
35	reference-to-hash objects. The hash can be used to store anything you	32	reference-to-hash objects. The hash can be used to store anything you
126	code is run after this hook, and takes precedence.	123	code is run after this hook, and takes precedence.
127		124
128	=item on_refresh_end $term	125	=item on_refresh_end $term
129		126
130	Called just after the screen gets redrawn. See C<on_refresh_begin>.	127	Called just after the screen gets redrawn. See C<on_refresh_begin>.
		128
		129	=item on_keyboard_command $term, $string
		130
		131	Called whenever the user presses a key combination that has a
		132	C<perl:string> action bound to it (see description of the B<keysym>
		133	resource in the @@RXVT_NAME@@(1) manpage).
131		134
132	=back	135	=back
133		136
134	=head2 Functions in the C<urxvt> Package	137	=head2 Functions in the C<urxvt> Package
135		138
…		…
174	unless $msg =~ /\n$/;	177	unless $msg =~ /\n$/;
175	urxvt::warn ($msg);	178	urxvt::warn ($msg);
176	};	179	};
177	}	180	}
178		181
		182	my @hook_count;
179	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	183	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
180		184
181	sub verbose {	185	sub verbose {
182	my ($level, $msg) = @_;	186	my ($level, $msg) = @_;
183	warn "$msg\n" if $level < $verbosity;	187	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	}	188	}
207		189
208	# find on_xxx subs in the package and register them	190	# find on_xxx subs in the package and register them
209	# as hooks	191	# as hooks
210	sub register_package($) {	192	sub register_package($) {
…		…
228	# load a single script into its own package, once only	210	# load a single script into its own package, once only
229	sub script_package($) {	211	sub script_package($) {
230	my ($path) = @_;	212	my ($path) = @_;
231		213
232	$script_pkg{$path} \|\|= do {	214	$script_pkg{$path} \|\|= do {
233	my $pkg = $script_pkg++;	215	my $pkg = "urxvt::" . ($script_pkg++);
		216
234	verbose 3, "loading script '$path' into package '$pkg'";	217	verbose 3, "loading script '$path' into package '$pkg'";
235		218
236	open my $fh, "<:raw", $path	219	open my $fh, "<:raw", $path
237	or die "$path: $!";	220	or die "$path: $!";
238		221
239	eval "package $pkg; use strict; use utf8;\n"	222	my $source = "package $pkg; use strict; use utf8;\n"
240	. "#line 1 \"$path\"\n"	223	. "#line 1 \"$path\"\n{\n"
241	. do { local $/; <$fh> }	224	. (do { local $/; <$fh> })
		225	. "\n};\n1";
		226
242	or die "$path: $@";	227	eval $source or die "$path: $@";
243		228
244	$pkg	229	$pkg
245	}	230	}
246	}	231	}
247		232
248	sub load_scripts($) {	233	# called by the rxvt core
249	my ($dir) = @_;	234	sub invoke {
		235	local $term = shift;
		236	my $htype = shift;
250		237
251	verbose 3, "loading scripts from '$dir'";	238	if ($htype == 0) { # INIT
		239	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");
252		240
		241	for my $ext (split /:/, $term->resource ("perl_ext")) {
		242	my @files = grep -f $_, map "$_/$ext", @dirs;
		243
		244	if (@files) {
253	register_package script_package $_	245	register_package script_package $files[0];
254	for grep -f $_,	246	} else {
255	<$dir/*>;	247	warn "perl extension '$ext' not found in perl library search path\n";
256	}	248	}
		249	}
257		250
258	sub on_init {	251	} 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}	252	if (my $hook = $term->{_hook}) {
		253	for my $htype (0..$#$hook) {
		254	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
		255	or set_should_invoke $htype, 0;
		256	}
		257	}
		258	}
		259
		260	my $cb = $term->{_hook}[$htype]
271	or return;	261	or return;
272		262
273	for my $htype (0..$#$hook) {	263	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
274	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	264	if $verbosity >= 10;
275	or set_should_invoke $htype, 0;	265
		266	while (my ($k, $v) = each %$cb) {
		267	return 1 if $v->($term, @_);
276	}	268	}
277	}
278		269
279	{	270	0
280	local $term = \%hook_global;
281
282	register_package __PACKAGE__;
283	load_scripts "$LIBDIR/perl-ext";
284	}	271	}
285		272
286	=back	273	=back
287		274
288	=head2 The C<urxvt::term> Class	275	=head2 The C<urxvt::term> Class
…		…
312		299
313	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	300	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
314	borderLess color cursorBlink cursorUnderline cutchars delete_key	301	borderLess color cursorBlink cursorUnderline cutchars delete_key
315	display_name embed ext_bwidth fade font geometry hold iconName	302	display_name embed ext_bwidth fade font geometry hold iconName
316	imFont imLocale inputMethod insecure int_bwidth intensityStyles	303	imFont imLocale inputMethod insecure int_bwidth intensityStyles
317	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	304	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
318	modifier mouseWheelScrollPage name pastableTabs path perl perl_eval	305	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
319	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	306	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
320	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	307	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
321	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	308	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
322	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	309	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
323	shade term_name title transparent transparent_all tripleclickwords	310	shade term_name title transparent transparent_all tripleclickwords
…		…
403	Convert the given locale-encoded octets into a perl string.	390	Convert the given locale-encoded octets into a perl string.
404		391
405	=item $term->tt_write ($octets)	392	=item $term->tt_write ($octets)
406		393
407	Write the octets given in C<$data> to the tty (i.e. as program input). To	394	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	395	pass characters instead of octets, you should convert your strings first
409	the locale-specific encoding using C<< $term->locale_encode >>.	396	to the locale-specific encoding using C<< $term->locale_encode >>.
		397
		398	=item $nrow = $term->nrow
		399
		400	=item $ncol = $term->ncol
		401
		402	Return the number of rows/columns of the terminal window (i.e. as
		403	specified by C<-geometry>, excluding any scrollback).
		404
		405	=item $nsaved = $term->nsaved
		406
		407	Returns the number of lines in the scrollback buffer.
		408
		409	=item $view_start = $term->view_start ([$newvalue])
		410
		411	Returns the negative row number of the topmost line. Minimum value is
		412	C<0>, which displays the normal terminal contents. Larger values scroll
		413	this many lines into the scrollback buffer.
		414
		415	=item $term->want_refresh
		416
		417	Requests a screen refresh. At the next opportunity, rxvt-unicode will
		418	compare the on-screen display with its stored representation. If they
		419	differ, it redraws the differences.
		420
		421	Used after changing terminal contents to display them.
		422
		423	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
		424
		425	Returns the text of the entire row with number C<$row_number>. Row C<0>
		426	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
		427	terminal line. The scrollback buffer starts at line C<-1> and extends to
		428	line C<< -$term->nsaved >>.
		429
		430	If C<$new_text> is specified, it will replace characters in the current
		431	line, starting at column C<$start_col> (default C<0>), which is useful
		432	to replace only parts of a line. The font iindex in the rendition will
		433	automatically be updated.
		434
		435	C<$text> is in a special encoding: tabs and wide characters that use more
		436	than one cell when displayed are padded with urxvt::NOCHAR characters
		437	(C<chr 65535>). Characters with combining characters and other characters
		438	that do not fit into the normal tetx encoding will be replaced with
		439	characters in the private use area.
		440
		441	You have to obey this encoding when changing text. The advantage is
		442	that C<substr> and similar functions work on screen cells and not on
		443	characters.
		444
		445	The methods C<< $term->special_encode >> and C<< $term->special_decode >>
		446	can be used to convert normal strings into this encoding and vice versa.
		447
		448	=item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
		449
		450	Like C<< $term->ROW_t >>, but returns an arrayref with rendition
		451	bitsets. Rendition bitsets contain information about colour, font, font
		452	styles and similar information. See also C<< $term->ROW_t >>.
		453
		454	When setting rendition, the font mask will be ignored.
		455
		456	See the section on RENDITION, below.
		457
		458	=item $length = $term->ROW_l ($row_number[, $new_length])
		459
		460	Returns the number of screen cells that are in use ("the line length"). If
		461	it is C<-1>, then the line is part of a multiple-row logical "line", which
		462	means all characters are in use and it is continued on the next row.
		463
		464	=item $text = $term->special_encode $string
		465
		466	Converts a perl string into the special encoding used by rxvt-unicode,
		467	where one character corresponds to one screen cell. See
		468	C<< $term->ROW_t >> for details.
		469
		470	=item $string = $term->special_decode $text
		471
		472	Converts rxvt-unicodes text reprsentation into a perl string. See
		473	C<< $term->ROW_t >> for details.
410		474
411	=back	475	=back
		476
		477	=head2 RENDITION
		478
		479	Rendition bitsets contain information about colour, font, font styles and
		480	similar information for each screen cell.
		481
		482	The following "macros" deal with changes in rendition sets. You should
		483	never just create a bitset, you should always modify an existing one,
		484	as they contain important information required for correct operation of
		485	rxvt-unicode.
		486
		487	=over 4
		488
		489	=item $rend = urxvt::DEFAULT_RSTYLE
		490
		491	Returns the default rendition, as used when the terminal is starting up or
		492	being reset. Useful as a base
		493
		494	=back
		495
		496	=cut
412		497
413	=head2 The C<urxvt::timer> Class	498	=head2 The C<urxvt::timer> Class
414		499
415	This class implements timer watchers/events. Time is represented as a	500	This class implements timer watchers/events. Time is represented as a
416	fractional number of seconds since the epoch. Example:	501	fractional number of seconds since the epoch. Example:

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.14 by root, Tue Jan 3 01:15:00 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.14 by root, Tue Jan 3 01:15:00 2006 UTC