[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.17 by root, Tue Jan 3 01:45:03 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 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
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
126	code is run after this hook, and takes precedence.	162	code is run after this hook, and takes precedence.
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>.
		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).
131		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
…		…
174	unless $msg =~ /\n$/;	216	unless $msg =~ /\n$/;
175	urxvt::warn ($msg);	217	urxvt::warn ($msg);
176	};	218	};
177	}	219	}
178		220
		221	my @hook_count;
179	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	222	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
180		223
181	sub verbose {	224	sub verbose {
182	my ($level, $msg) = @_;	225	my ($level, $msg) = @_;
183	warn "$msg\n" if $level < $verbosity;	226	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	}	227	}
207		228
208	# find on_xxx subs in the package and register them	229	# find on_xxx subs in the package and register them
209	# as hooks	230	# as hooks
210	sub register_package($) {	231	sub register_package($) {
…		…
228	# load a single script into its own package, once only	249	# load a single script into its own package, once only
229	sub script_package($) {	250	sub script_package($) {
230	my ($path) = @_;	251	my ($path) = @_;
231		252
232	$script_pkg{$path} \|\|= do {	253	$script_pkg{$path} \|\|= do {
233	my $pkg = $script_pkg++;	254	my $pkg = "urxvt::" . ($script_pkg++);
		255
234	verbose 3, "loading script '$path' into package '$pkg'";	256	verbose 3, "loading script '$path' into package '$pkg'";
235		257
236	open my $fh, "<:raw", $path	258	open my $fh, "<:raw", $path
237	or die "$path: $!";	259	or die "$path: $!";
238		260
239	eval "package $pkg; use strict; use utf8;\n"	261	my $source = "package $pkg; use strict; use utf8;\n"
240	. "#line 1 \"$path\"\n"	262	. "#line 1 \"$path\"\n{\n"
241	. do { local $/; <$fh> }	263	. (do { local $/; <$fh> })
		264	. "\n};\n1";
		265
242	or die "$path: $@";	266	eval $source or die "$path: $@";
243		267
244	$pkg	268	$pkg
245	}	269	}
246	}	270	}
247		271
248	sub load_scripts($) {	272	# called by the rxvt core
249	my ($dir) = @_;	273	sub invoke {
		274	local $term = shift;
		275	my $htype = shift;
250		276
251	verbose 3, "loading scripts from '$dir'";	277	if ($htype == 0) { # INIT
		278	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");
252		279
		280	for my $ext (split /:/, $term->resource ("perl_ext")) {
		281	my @files = grep -f $_, map "$_/$ext", @dirs;
		282
		283	if (@files) {
253	register_package script_package $_	284	register_package script_package $files[0];
254	for grep -f $_,	285	} else {
255	<$dir/*>;	286	warn "perl extension '$ext' not found in perl library search path\n";
256	}	287	}
		288	}
257		289
258	sub on_init {	290	} 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}	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]
271	or return;	300	or return;
272		301
273	for my $htype (0..$#$hook) {	302	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
274	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	303	if $verbosity >= 10;
275	or set_should_invoke $htype, 0;	304
		305	while (my ($k, $v) = each %$cb) {
		306	return 1 if $v->($term, @_);
276	}	307	}
277	}
278		308
279	{	309	0
280	local $term = \%hook_global;
281
282	register_package __PACKAGE__;
283	load_scripts "$LIBDIR/perl-ext";
284	}	310	}
285		311
286	=back	312	=back
287		313
288	=head2 The C<urxvt::term> Class	314	=head2 The C<urxvt::term> Class
…		…
312		338
313	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	339	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
314	borderLess color cursorBlink cursorUnderline cutchars delete_key	340	borderLess color cursorBlink cursorUnderline cutchars delete_key
315	display_name embed ext_bwidth fade font geometry hold iconName	341	display_name embed ext_bwidth fade font geometry hold iconName
316	imFont imLocale inputMethod insecure int_bwidth intensityStyles	342	imFont imLocale inputMethod insecure int_bwidth intensityStyles
317	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	343	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
318	modifier mouseWheelScrollPage name pastableTabs path perl perl_eval	344	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
319	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	345	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
320	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	346	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
321	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	347	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
322	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	348	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
323	shade term_name title transparent transparent_all tripleclickwords	349	shade term_name title transparent transparent_all tripleclickwords
…		…
403	Convert the given locale-encoded octets into a perl string.	429	Convert the given locale-encoded octets into a perl string.
404		430
405	=item $term->tt_write ($octets)	431	=item $term->tt_write ($octets)
406		432
407	Write the octets given in C<$data> to the tty (i.e. as program input). To	433	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	434	pass characters instead of octets, you should convert your strings first
409	the locale-specific encoding using C<< $term->locale_encode >>.	435	to the locale-specific encoding using C<< $term->locale_encode >>.
410		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
411	=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
412		536
413	=head2 The C<urxvt::timer> Class	537	=head2 The C<urxvt::timer> Class
414		538
415	This class implements timer watchers/events. Time is represented as a	539	This class implements timer watchers/events. Time is represented as a
416	fractional number of seconds since the epoch. Example:	540	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.17 by root, Tue Jan 3 01:45:03 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.17 by root, Tue Jan 3 01:45:03 2006 UTC