[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.11 by root, Mon Jan 2 21:41:51 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
36	like. The only reserved member is C<_ptr>, which must not be changed.	33	like. All members starting with an underscore (such as C<_ptr> or
		34	C<_hook>) are reserved for internal uses and must not be accessed or
		35	modified).
37		36
38	When objects are destroyed on the C++ side, the perl object hashes are	37	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	38	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	39	the like inside the terminal object so they get destroyed as soon as the
41	terminal is destroyed.	40	terminal is destroyed.
124	code is run after this hook, and takes precedence.	123	code is run after this hook, and takes precedence.
125		124
126	=item on_refresh_end $term	125	=item on_refresh_end $term
127		126
128	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).
129		134
130	=back	135	=back
131		136
132	=head2 Functions in the C<urxvt> Package	137	=head2 Functions in the C<urxvt> Package
133		138
…		…
172	unless $msg =~ /\n$/;	177	unless $msg =~ /\n$/;
173	urxvt::warn ($msg);	178	urxvt::warn ($msg);
174	};	179	};
175	}	180	}
176		181
		182	my @hook_count;
177	my $verbosity = $ENV{URXVT_PERL_VERBOSITY} \|\| 10;	183	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
178		184
179	sub verbose {	185	sub verbose {
180	my ($level, $msg) = @_;	186	my ($level, $msg) = @_;
181	warn "$msg\n"; #d#	187	warn "$msg\n" if $level <= $verbosity;
182	}	188	}
183		189
184	my @invoke_cb;	190	# find on_xxx subs in the package and register them
		191	# as hooks
		192	sub register_package($) {
		193	my ($pkg) = @_;
		194
		195	for my $htype (0.. $#HOOKNAME) {
		196	my $name = $HOOKNAME[$htype];
		197
		198	my $ref = $pkg->can ("on_" . lc $name)
		199	or next;
		200
		201	$term->{_hook}[$htype]{$ref*1} = $ref;
		202	$hook_count[$htype]++
		203	or set_should_invoke $htype, 1;
		204	}
		205	}
		206
		207	my $script_pkg = "script0000";
		208	my %script_pkg;
		209
		210	# load a single script into its own package, once only
		211	sub script_package($) {
		212	my ($path) = @_;
		213
		214	$script_pkg{$path} \|\|= do {
		215	my $pkg = "urxvt::" . ($script_pkg++);
		216
		217	verbose 3, "loading script '$path' into package '$pkg'";
		218
		219	open my $fh, "<:raw", $path
		220	or die "$path: $!";
		221
		222	my $source = "package $pkg; use strict; use utf8;\n"
		223	. "#line 1 \"$path\"\n{\n"
		224	. (do { local $/; <$fh> })
		225	. "\n};\n1";
		226
		227	eval $source or die "$path: $@";
		228
		229	$pkg
		230	}
		231	}
185		232
186	# called by the rxvt core	233	# called by the rxvt core
187	sub invoke {	234	sub invoke {
188	local $term = shift;	235	local $term = shift;
189	my $htype = shift;	236	my $htype = shift;
190		237
191	my $cb = $invoke_cb[$htype];	238	if ($htype == 0) { # INIT
		239	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");
		240
		241	for my $ext (split /:/, $term->resource ("perl_ext")) {
		242	my @files = grep -f $_, map "$_/$ext", @dirs;
		243
		244	if (@files) {
		245	register_package script_package $files[0];
		246	} else {
		247	warn "perl extension '$ext' not found in perl library search path\n";
		248	}
		249	}
		250
		251	} elsif ($htype == 1) { # DESTROY
		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]
		261	or return;
192		262
193	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	263	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
194	if $verbosity >= 10;	264	if $verbosity >= 10;
195		265
196	while (my ($k, $v) = each %$cb) {	266	while (my ($k, $v) = each %$cb) {
197	return 1 if $v->($term, @_);	267	return 1 if $v->($term, @_);
198	}	268	}
199		269
200	0	270	0
201	}	271	}
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		272
266	=back	273	=back
267		274
268	=head2 The C<urxvt::term> Class	275	=head2 The C<urxvt::term> Class
269		276
…		…
292		299
293	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	300	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
294	borderLess color cursorBlink cursorUnderline cutchars delete_key	301	borderLess color cursorBlink cursorUnderline cutchars delete_key
295	display_name embed ext_bwidth fade font geometry hold iconName	302	display_name embed ext_bwidth fade font geometry hold iconName
296	imFont imLocale inputMethod insecure int_bwidth intensityStyles	303	imFont imLocale inputMethod insecure int_bwidth intensityStyles
297	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8	304	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
298	modifier mouseWheelScrollPage name pastableTabs path perl perl_eval	305	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
299	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	306	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
300	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	307	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
301	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	308	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
302	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	309	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
303	shade term_name title transparent transparent_all tripleclickwords	310	shade term_name title transparent transparent_all tripleclickwords

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.11 by root, Mon Jan 2 21:41:51 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.11 by root, Mon Jan 2 21:41:51 2006 UTC