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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC vs.
Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	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
…		…
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	Intelligent selection. This extension tries to be more intelligent when
45	the user extends selections (double-click). Right now, it tries to select	45	the user extends selections (double-click). Right now, it tries to select
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	urls and complete shell-quoted arguments, which is very convenient, too,
47	if your F<ls> supports C<--quoting-style=shell>.	47	if your F<ls> supports C<--quoting-style=shell>.
…		…
56		56
57	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
58		58
59	=back	59	=back
60		60
		61	=item option-popup (enabled by default)
		62
		63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		64	runtime.
		65
		66	=item selection-popup (enabled by default)
		67
		68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		69	text into various other formats/action.
		70
61	=item digital-clock	71	=item digital-clock
62		72
63	Displays a digital clock using the built-in overlay.	73	Displays a digital clock using the built-in overlay.
64		74
65	=item mark-urls	75	=item mark-urls
66		76
67	Uses per-line filtering (C<on_line_update>) to underline urls.	77	Uses per-line display filtering (C<on_line_update>) to underline urls.
		78
		79	=item block-graphics-to-ascii
		80
		81	A not very useful example of filtering all text output to the terminal,
		82	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		83	similar-looking ascii character.
68		84
69	=item example-refresh-hooks	85	=item example-refresh-hooks
70		86
71	Displays a very simple digital clock in the upper right corner of the	87	Displays a very simple digital clock in the upper right corner of the
72	window. Illustrates overwriting the refresh callbacks to create your own	88	window. Illustrates overwriting the refresh callbacks to create your own
73	overlays or changes.	89	overlays or changes.
74
75	=item example-filter-input
76
77	A not very useful example of filtering all text output to the terminal, by
78	underlining all urls that matches a certain regex (i.e. some urls :). It
79	is not very useful because urls that are output in multiple steps (e.g.
80	when typing them) do not get marked.
81		90
82	=back	91	=back
83		92
84	=head2 General API Considerations	93	=head2 General API Considerations
85		94
…		…
117		126
118	=back	127	=back
119		128
120	=head2 Hooks	129	=head2 Hooks
121		130
122	The following subroutines can be declared in loaded scripts, and will be	131	The following subroutines can be declared in extension files, and will be
123	called whenever the relevant event happens.	132	called whenever the relevant event happens.
124		133
125	The first argument passed to them is an object private to each terminal	134	The first argument passed to them is an object private to each terminal
126	and extension package. You can call all C<urxvt::term> methods on it, but	135	and extension package. You can call all C<urxvt::term> methods on it, but
127	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>	136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
128	object that is shared between all packages is stored in the C<term>	137	object that is shared between all packages is stored in the C<term>
129	member.	138	member. It is, however, blessed intot he package of the extension script,
		139	so for all practical purposes you can treat an extension script as a class.
130		140
131	All of them must return a boolean value. If it is true, then the event	141	All of them must return a boolean value. If it is true, then the event
132	counts as being I<consumed>, and the invocation of other hooks is skipped,	142	counts as being I<consumed>, and the invocation of other hooks is skipped,
133	and the relevant action might not be carried out by the C++ code.	143	and the relevant action might not be carried out by the C++ code.
134		144
…		…
137	=over 4	147	=over 4
138		148
139	=item on_init $term	149	=item on_init $term
140		150
141	Called after a new terminal object has been initialized, but before	151	Called after a new terminal object has been initialized, but before
142	windows are created or the command gets run.	152	windows are created or the command gets run. Most methods are unsafe to
		153	call or deliver senseless data, as terminal size and other characteristics
		154	have not yet been determined. You can safely query and change resources,
		155	though.
143		156
144	=item on_reset $term	157	=item on_reset $term
145		158
146	Called after the screen is "reset" for any reason, such as resizing or	159	Called after the screen is "reset" for any reason, such as resizing or
147	control sequences. Here is where you can react on changes to size-related	160	control sequences. Here is where you can react on changes to size-related
…		…
176	should extend the selection itelf and return true to suppress the built-in	189	should extend the selection itelf and return true to suppress the built-in
177	processing.	190	processing.
178		191
179	See the F<selection> example extension.	192	See the F<selection> example extension.
180		193
181	=item on_focus_in $term
182
183	Called whenever the window gets the keyboard focus, before urxvt does
184	focus in processing.
185
186	=item on_focus_out $term
187
188	Called wheneever the window loses keyboard focus, before urxvt does focus
189	out processing.
190
191	=item on_view_change $term, $offset	194	=item on_view_change $term, $offset
192		195
193	Called whenever the view offset changes, i..e the user or program	196	Called whenever the view offset changes, i..e the user or program
194	scrolls. Offset C<0> means display the normal terminal, positive values	197	scrolls. Offset C<0> means display the normal terminal, positive values
195	show this many lines of scrollback.	198	show this many lines of scrollback.
…		…
201	than the scroll back buffer or the terminal.	204	than the scroll back buffer or the terminal.
202		205
203	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
204	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	207	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
205	number of lines that will be in the scrollback buffer.	208	number of lines that will be in the scrollback buffer.
206
207	=item on_tty_activity $term NYI
208
209	Called whenever the program(s) running in the urxvt window send output.
210		209
211	=item on_osc_seq $term, $string	210	=item on_osc_seq $term, $string
212		211
213	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	212	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
214	operating system command) is processed. Cursor position and other state	213	operating system command) is processed. Cursor position and other state
…		…
258		257
259	Called whenever the user presses a key combination that has a	258	Called whenever the user presses a key combination that has a
260	C<perl:string> action bound to it (see description of the B<keysym>	259	C<perl:string> action bound to it (see description of the B<keysym>
261	resource in the @@RXVT_NAME@@(1) manpage).	260	resource in the @@RXVT_NAME@@(1) manpage).
262		261
		262	=item on_focus_in $term
		263
		264	Called whenever the window gets the keyboard focus, before rxvt-unicode
		265	does focus in processing.
		266
		267	=item on_focus_out $term
		268
		269	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		270	focus out processing.
		271
		272	=item on_key_press $term, $event, $octets
		273
		274	=item on_key_release $term, $event
		275
		276	=item on_button_press $term, $event
		277
		278	=item on_button_release $term, $event
		279
		280	=item on_motion_notify $term, $event
		281
		282	=item on_map_notify $term, $event
		283
		284	=item on_unmap_notify $term, $event
		285
		286	Called whenever the corresponding X event is received for the terminal If
		287	the hook returns true, then the even will be ignored by rxvt-unicode.
		288
		289	The event is a hash with most values as named by Xlib (see the XEvent
		290	manpage), with the additional members C<row> and C<col>, which are the row
		291	and column under the mouse cursor.
		292
		293	C<on_key_press> additionally receives the string rxvt-unicode would
		294	output, if any, in locale-specific encoding.
		295
		296	subwindow.
		297
263	=back	298	=back
264		299
265	=head2 Variables in the C<urxvt> Package	300	=head2 Variables in the C<urxvt> Package
266		301
267	=over 4	302	=over 4
268		303
269	=item $urxvt::TERM	304	=item $urxvt::TERM
270		305
271	The current terminal. Whenever a callback/Hook is bein executed, this	306	The current terminal. This variable stores the current C<urxvt::term>
272	variable stores the current C<urxvt::term> object.	307	object, whenever a callback/hook is executing.
273		308
274	=back	309	=back
275		310
276	=head2 Functions in the C<urxvt> Package	311	=head2 Functions in the C<urxvt> Package
277		312
278	=over 4	313	=over 4
		314
		315	=item $term = new urxvt [arg...]
		316
		317	Creates a new terminal, very similar as if you had started it with
		318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		319	if the new instance couldn't be created. Returns C<undef> if the new
		320	instance didn't initialise perl, and the terminal object otherwise. The
		321	C<init> and C<start> hooks will be called during the call.
279		322
280	=item urxvt::fatal $errormessage	323	=item urxvt::fatal $errormessage
281		324
282	Fatally aborts execution with the given error message. Avoid at all	325	Fatally aborts execution with the given error message. Avoid at all
283	costs! The only time this is acceptable is when the terminal process	326	costs! The only time this is acceptable is when the terminal process
…		…
290	that calls this function.	333	that calls this function.
291		334
292	Using this function has the advantage that its output ends up in the	335	Using this function has the advantage that its output ends up in the
293	correct place, e.g. on stderr of the connecting urxvtc client.	336	correct place, e.g. on stderr of the connecting urxvtc client.
294		337
		338	=item $is_safe = urxvt::safe
		339
		340	Returns true when it is safe to do potentially unsafe things, such as
		341	evaluating perl code specified by the user. This is true when urxvt was
		342	started setuid or setgid.
		343
295	=item $time = urxvt::NOW	344	=item $time = urxvt::NOW
296		345
297	Returns the "current time" (as per the event loop).	346	Returns the "current time" (as per the event loop).
		347
		348	=item urxvt::CurrentTime
		349
		350	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		351	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		352	Button4Mask, Button5Mask, AnyModifier
		353
		354	Various constants for use in X calls and event processing.
298		355
299	=back	356	=back
300		357
301	=head2 RENDITION	358	=head2 RENDITION
302		359
…		…
352		409
353	=cut	410	=cut
354		411
355	package urxvt;	412	package urxvt;
356		413
		414	use utf8;
357	use strict;	415	use strict;
358	use Scalar::Util ();	416	use Scalar::Util ();
		417	use List::Util ();
359		418
		419	our $VERSION = 1;
360	our $TERM;	420	our $TERM;
361	our @HOOKNAME;	421	our @HOOKNAME;
		422	our %OPTION;
362	our $LIBDIR;	423	our $LIBDIR;
363		424
364	BEGIN {	425	BEGIN {
365	urxvt->bootstrap;	426	urxvt->bootstrap;
366		427
…		…
369	my $msg = join "", @_;	430	my $msg = join "", @_;
370	$msg .= "\n"	431	$msg .= "\n"
371	unless $msg =~ /\n$/;	432	unless $msg =~ /\n$/;
372	urxvt::warn ($msg);	433	urxvt::warn ($msg);
373	};	434	};
		435
		436	delete $ENV{IFS};
		437	delete $ENV{CDPATH};
		438	delete $ENV{BASH_ENV};
		439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
374	}	440	}
375		441
376	my @hook_count;	442	my @hook_count;
377	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
378		444
379	sub verbose {	445	sub verbose {
380	my ($level, $msg) = @_;	446	my ($level, $msg) = @_;
381	warn "$msg\n" if $level <= $verbosity;	447	warn "$msg\n" if $level <= $verbosity;
382	}	448	}
383		449
384	# find on_xxx subs in the package and register them	450	my $extension_pkg = "extension0000";
385	# as hooks	451	my %extension_pkg;
386	sub register_package($) {
387	my ($pkg) = @_;
388
389	for my $htype (0.. $#HOOKNAME) {
390	my $name = $HOOKNAME[$htype];
391
392	my $ref = $pkg->can ("on_" . lc $name)
393	or next;
394
395	$TERM->{_hook}[$htype]{$pkg} = $ref;
396	$hook_count[$htype]++
397	or set_should_invoke $htype, 1;
398	}
399	}
400
401	my $script_pkg = "script0000";
402	my %script_pkg;
403		452
404	# load a single script into its own package, once only	453	# load a single script into its own package, once only
405	sub script_package($) {	454	sub extension_package($) {
406	my ($path) = @_;	455	my ($path) = @_;
407		456
408	$script_pkg{$path} \|\|= do {	457	$extension_pkg{$path} \|\|= do {
409	my $pkg = "urxvt::" . ($script_pkg++);	458	my $pkg = "urxvt::" . ($extension_pkg++);
410		459
411	verbose 3, "loading script '$path' into package '$pkg'";	460	verbose 3, "loading extension '$path' into package '$pkg'";
412		461
413	open my $fh, "<:raw", $path	462	open my $fh, "<:raw", $path
414	or die "$path: $!";	463	or die "$path: $!";
415		464
416	my $source = "package $pkg; use strict; use utf8;\n"	465	my $source = untaint "package $pkg; use strict; use utf8;\n"
		466	. "use base urxvt::term::proxy::;\n"
417	. "#line 1 \"$path\"\n{\n"	467	. "#line 1 \"$path\"\n{\n"
418	. (do { local $/; <$fh> })	468	. (do { local $/; <$fh> })
419	. "\n};\n1";	469	. "\n};\n1";
420		470
421	eval $source or die "$path: $@";	471	eval $source or die "$path: $@";
…		…
431	local $TERM = shift;	481	local $TERM = shift;
432	my $htype = shift;	482	my $htype = shift;
433		483
434	if ($htype == 0) { # INIT	484	if ($htype == 0) { # INIT
435	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	485	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		486
		487	my %ext_arg;
436		488
437	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	489	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		490	if ($_ eq "default") {
		491	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup);
		492	} elsif (/^-(.*)$/) {
		493	delete $ext_arg{$1};
		494	} elsif (/^([^<]+)<(.*)>$/) {
		495	push @{ $ext_arg{$1} }, $2;
		496	} else {
		497	$ext_arg{$_} \|\|= [];
		498	}
		499	}
		500
		501	while (my ($ext, $argv) = each %ext_arg) {
438	my @files = grep -f $_, map "$_/$ext", @dirs;	502	my @files = grep -f $_, map "$_/$ext", @dirs;
439		503
440	if (@files) {	504	if (@files) {
441	register_package script_package $files[0];	505	$TERM->register_package (extension_package $files[0], $argv);
442	} else {	506	} else {
443	warn "perl extension '$ext' not found in perl library search path\n";	507	warn "perl extension '$ext' not found in perl library search path\n";
444	}	508	}
445	}	509	}
		510
		511	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		512	warn $@ if $@;
446	}	513	}
447		514
448	$retval = undef;	515	$retval = undef;
449		516
450	if (my $cb = $TERM->{_hook}[$htype]) {	517	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
452	if $verbosity >= 10;	519	if $verbosity >= 10;
453		520
454	keys %$cb;	521	keys %$cb;
455		522
456	while (my ($pkg, $cb) = each %$cb) {	523	while (my ($pkg, $cb) = each %$cb) {
457	$retval = $cb->(	524	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
458	$TERM->{_pkg}{$pkg} \|\|= do {
459	my $proxy = bless { }, urxvt::term::proxy::;
460	Scalar::Util::weaken ($proxy->{term} = $TERM);
461	$proxy
462	},
463	@_,
464	) and last;	525	and last;
		526
		527	if ($@) {
		528	$TERM->ungrab; # better to lose the grab than the session
		529	warn $@;
		530	}
465	}	531	}
466	}	532	}
467		533
468	if ($htype == 1) { # DESTROY	534	if ($htype == 1) { # DESTROY
469	# remove hooks if unused	535	# remove hooks if unused
…		…
482	}	548	}
483		549
484	$retval	550	$retval
485	}	551	}
486		552
		553	# urxvt::term::proxy
		554
487	sub urxvt::term::proxy::AUTOLOAD {	555	sub urxvt::term::proxy::AUTOLOAD {
488	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	556	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
489	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	557	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
490		558
491	eval qq{	559	eval qq{
…		…
497	} or die "FATAL: unable to compile method forwarder: $@";	565	} or die "FATAL: unable to compile method forwarder: $@";
498		566
499	goto &$urxvt::term::proxy::AUTOLOAD;	567	goto &$urxvt::term::proxy::AUTOLOAD;
500	}	568	}
501		569
		570	sub urxvt::term::proxy::DESTROY {
		571	# nop
		572	}
		573
		574	# urxvt::destroy_hook
		575
		576	sub urxvt::destroy_hook::DESTROY {
		577	${$_[0]}->();
		578	}
		579
		580	sub urxvt::destroy_hook(&) {
		581	bless \shift, urxvt::destroy_hook::
		582	}
		583
		584	package urxvt::anyevent;
		585
		586	=head2 The C<urxvt::anyevent> Class
		587
		588	The sole purpose of this class is to deliver an interface to the
		589	C<AnyEvent> module - any module using it will work inside urxvt without
		590	further work. The only exception is that you cannot wait on condition
		591	variables, but non-blocking condvar use is ok. What this means is that you
		592	cannot use blocking APIs, but the non-blocking variant should work.
		593
		594	=cut
		595
		596	our $VERSION = 1;
		597
		598	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		599	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		600
		601	sub timer {
		602	my ($class, %arg) = @_;
		603
		604	my $cb = $arg{cb};
		605
		606	urxvt::timer
		607	->new
		608	->start (urxvt::NOW + $arg{after})
		609	->cb (sub {
		610	$_[0]->stop; # need to cancel manually
		611	$cb->();
		612	})
		613	}
		614
		615	sub io {
		616	my ($class, %arg) = @_;
		617
		618	my $cb = $arg{cb};
		619
		620	bless [$arg{fh}, urxvt::iow
		621	->new
		622	->fd (fileno $arg{fh})
		623	->events (($arg{poll} =~ /r/ ? 1 : 0)
		624	\| ($arg{poll} =~ /w/ ? 2 : 0))
		625	->start
		626	->cb (sub {
		627	$cb->(($_[1] & 1 ? 'r' : '')
		628	. ($_[1] & 2 ? 'w' : ''));
		629	})],
		630	urxvt::anyevent::
		631	}
		632
		633	sub DESTROY {
		634	$_[0][1]->stop;
		635	}
		636
		637	sub condvar {
		638	bless \my $flag, urxvt::anyevent::condvar::
		639	}
		640
		641	sub urxvt::anyevent::condvar::broadcast {
		642	${$_[0]}++;
		643	}
		644
		645	sub urxvt::anyevent::condvar::wait {
		646	unless (${$_[0]}) {
		647	require Carp;
		648	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
		649	}
		650	}
		651
		652	package urxvt::term;
		653
502	=head2 The C<urxvt::term> Class	654	=head2 The C<urxvt::term> Class
503		655
504	=over 4	656	=over 4
		657
		658	=cut
		659
		660	# find on_xxx subs in the package and register them
		661	# as hooks
		662	sub register_package {
		663	my ($self, $pkg, $argv) = @_;
		664
		665	my $proxy = bless { argv => $argv }, $pkg;
		666	Scalar::Util::weaken ($proxy->{term} = $TERM);
		667
		668	$self->{_pkg}{$pkg} = $proxy;
		669
		670	for my $htype (0.. $#HOOKNAME) {
		671	my $name = $HOOKNAME[$htype];
		672
		673	my $ref = $pkg->can ("on_" . lc $name)
		674	or next;
		675
		676	$self->{_hook}[$htype]{$pkg} = $ref;
		677	$hook_count[$htype]++
		678	or urxvt::set_should_invoke $htype, 1;
		679	}
		680	}
		681
		682	=item $term->destroy
		683
		684	Destroy the terminal object (close the window, free resources etc.).
		685
		686	=item $isset = $term->option ($optval[, $set])
		687
		688	Returns true if the option specified by C<$optval> is enabled, and
		689	optionally change it. All option values are stored by name in the hash
		690	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		691
		692	Here is a a likely non-exhaustive list of option names, please see the
		693	source file F</src/optinc.h> to see the actual list:
		694
		695	borderLess console cursorBlink cursorUnderline hold iconic insecure
		696	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		697	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		698	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		699	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		700	tripleclickwords utmpInhibit visualBell
505		701
506	=item $value = $term->resource ($name[, $newval])	702	=item $value = $term->resource ($name[, $newval])
507		703
508	Returns the current resource value associated with a given name and	704	Returns the current resource value associated with a given name and
509	optionally sets a new value. Setting values is most useful in the C<init>	705	optionally sets a new value. Setting values is most useful in the C<init>
…		…
519		715
520	Please note that resource strings will currently only be freed when the	716	Please note that resource strings will currently only be freed when the
521	terminal is destroyed, so changing options frequently will eat memory.	717	terminal is destroyed, so changing options frequently will eat memory.
522		718
523	Here is a a likely non-exhaustive list of resource names, not all of which	719	Here is a a likely non-exhaustive list of resource names, not all of which
524	are supported in every build, please see the source to see the actual	720	are supported in every build, please see the source file F</src/rsinc.h>
525	list:	721	to see the actual list:
526		722
527	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	723	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
528	borderLess color cursorBlink cursorUnderline cutchars delete_key	724	borderLess color cursorBlink cursorUnderline cutchars delete_key
529	display_name embed ext_bwidth fade font geometry hold iconName	725	display_name embed ext_bwidth fade font geometry hold iconName
530	imFont imLocale inputMethod insecure int_bwidth intensityStyles	726	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
537	shade term_name title transparent transparent_all tripleclickwords	733	shade term_name title transparent transparent_all tripleclickwords
538	utmpInhibit visualBell	734	utmpInhibit visualBell
539		735
540	=cut	736	=cut
541		737
542	sub urxvt::term::resource($$;$) {	738	sub resource($$;$) {
543	my ($self, $name) = (shift, shift);	739	my ($self, $name) = (shift, shift);
544	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	740	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
545	goto &urxvt::term::_resource;	741	&urxvt::term::_resource
546	}	742	}
547		743
548	=item $rend = $term->rstyle ([$new_rstyle])	744	=item $rend = $term->rstyle ([$new_rstyle])
549		745
550	Return and optionally change the current rendition. Text that is output by	746	Return and optionally change the current rendition. Text that is output by
…		…
626		822
627	If hidden, display the overlay again.	823	If hidden, display the overlay again.
628		824
629	=back	825	=back
630		826
		827	=item $popup = $term->popup ($event)
		828
		829	Creates a new C<urxvt::popup> object that implements a popup menu. The
		830	C<$event> I<must> be the event causing the menu to pop up (a button event,
		831	currently).
		832
		833	=cut
		834
		835	sub popup {
		836	my ($self, $event) = @_;
		837
		838	$self->grab ($event->{time}, 1)
		839	or return;
		840
		841	my $popup = bless {
		842	term => $self,
		843	event => $event,
		844	}, urxvt::popup::;
		845
		846	Scalar::Util::weaken $popup->{term};
		847
		848	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		849	Scalar::Util::weaken $self->{_destroy}{$popup};
		850
		851	$popup
		852	}
		853
631	=item $cellwidth = $term->strwidth $string	854	=item $cellwidth = $term->strwidth ($string)
632		855
633	Returns the number of screen-cells this string would need. Correctly	856	Returns the number of screen-cells this string would need. Correctly
634	accounts for wide and combining characters.	857	accounts for wide and combining characters.
635		858
636	=item $octets = $term->locale_encode $string	859	=item $octets = $term->locale_encode ($string)
637		860
638	Convert the given text string into the corresponding locale encoding.	861	Convert the given text string into the corresponding locale encoding.
639		862
640	=item $string = $term->locale_decode $octets	863	=item $string = $term->locale_decode ($octets)
641		864
642	Convert the given locale-encoded octets into a perl string.	865	Convert the given locale-encoded octets into a perl string.
643		866
644	=item $term->scr_add_lines ($string)	867	=item $term->scr_add_lines ($string)
645		868
…		…
650		873
651	Normally its not a good idea to use this function, as programs might be	874	Normally its not a good idea to use this function, as programs might be
652	confused by changes in cursor position or scrolling. Its useful inside a	875	confused by changes in cursor position or scrolling. Its useful inside a
653	C<on_add_lines> hook, though.	876	C<on_add_lines> hook, though.
654		877
		878	=item $term->cmd_parse ($octets)
		879
		880	Similar to C<scr_add_lines>, but the argument must be in the
		881	locale-specific encoding of the terminal and can contain command sequences
		882	(escape codes) that will be interpreted.
		883
655	=item $term->tt_write ($octets)	884	=item $term->tt_write ($octets)
656		885
657	Write the octets given in C<$data> to the tty (i.e. as program input). To	886	Write the octets given in C<$data> to the tty (i.e. as program input). To
658	pass characters instead of octets, you should convert your strings first	887	pass characters instead of octets, you should convert your strings first
659	to the locale-specific encoding using C<< $term->locale_encode >>.	888	to the locale-specific encoding using C<< $term->locale_encode >>.
660		889
		890	=item $windowid = $term->parent
		891
		892	Return the window id of the toplevel window.
		893
		894	=item $windowid = $term->vt
		895
		896	Return the window id of the terminal window.
		897
661	=item $window_width = $term->width	898	=item $window_width = $term->width
662		899
663	=item $window_height = $term->height	900	=item $window_height = $term->height
664		901
665	=item $font_width = $term->fwidth	902	=item $font_width = $term->fwidth
…		…
681	=item $nrow_plus_saveLines = $term->total_rows	918	=item $nrow_plus_saveLines = $term->total_rows
682		919
683	=item $lines_in_scrollback = $term->nsaved	920	=item $lines_in_scrollback = $term->nsaved
684		921
685	Return various integers describing terminal characteristics.	922	Return various integers describing terminal characteristics.
		923
		924	=item $lc_ctype = $term->locale
		925
		926	Returns the LC_CTYPE category string used by this rxvt-unicode.
		927
		928	=item $x_display = $term->display_id
		929
		930	Return the DISPLAY used by rxvt-unicode.
		931
		932	=item $modifiermask = $term->ModLevel3Mask
		933
		934	=item $modifiermask = $term->ModMetaMask
		935
		936	=item $modifiermask = $term->ModNumLockMask
		937
		938	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		939	AltGr), the meta key (often Alt) and the num lock key, if applicable.
686		940
687	=item $view_start = $term->view_start ([$newvalue])	941	=item $view_start = $term->view_start ([$newvalue])
688		942
689	Returns the negative row number of the topmost line. Minimum value is	943	Returns the negative row number of the topmost line. Minimum value is
690	C<0>, which displays the normal terminal contents. Larger values scroll	944	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
784		1038
785	=back	1039	=back
786		1040
787	=cut	1041	=cut
788		1042
789	sub urxvt::term::line {	1043	sub line {
790	my ($self, $row) = @_;	1044	my ($self, $row) = @_;
791		1045
792	my $maxrow = $self->nrow - 1;	1046	my $maxrow = $self->nrow - 1;
793		1047
794	my ($beg, $end) = ($row, $row);	1048	my ($beg, $end) = ($row, $row);
…		…
858	$offset / $self->{ncol} + $self->{beg},	1112	$offset / $self->{ncol} + $self->{beg},
859	$offset % $self->{ncol}	1113	$offset % $self->{ncol}
860	)	1114	)
861	}	1115	}
862		1116
863	=item ($row, $col) = $line->coord_of ($offset)
864	=item $text = $term->special_encode $string	1117	=item $text = $term->special_encode $string
865		1118
866	Converts a perl string into the special encoding used by rxvt-unicode,	1119	Converts a perl string into the special encoding used by rxvt-unicode,
867	where one character corresponds to one screen cell. See	1120	where one character corresponds to one screen cell. See
868	C<< $term->ROW_t >> for details.	1121	C<< $term->ROW_t >> for details.
…		…
870	=item $string = $term->special_decode $text	1123	=item $string = $term->special_decode $text
871		1124
872	Converts rxvt-unicodes text reprsentation into a perl string. See	1125	Converts rxvt-unicodes text reprsentation into a perl string. See
873	C<< $term->ROW_t >> for details.	1126	C<< $term->ROW_t >> for details.
874		1127
		1128	=item $success = $term->grab_button ($button, $modifiermask)
		1129
		1130	Registers a synchronous button grab. See the XGrabButton manpage.
		1131
		1132	=item $success = $term->grab ($eventtime[, $sync])
		1133
		1134	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1135	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1136
		1137	=item $term->allow_events_async
		1138
		1139	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1140
		1141	=item $term->allow_events_sync
		1142
		1143	Calls XAllowEvents with SyncBoth for the most recent grab.
		1144
		1145	=item $term->allow_events_replay
		1146
		1147	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1148	recent grab.
		1149
		1150	=item $term->ungrab
		1151
		1152	Calls XUngrab for the most recent grab. Is called automatically on
		1153	evaluation errors, as it is better to lose the grab in the error case as
		1154	the session.
		1155
875	=back	1156	=back
		1157
		1158	=cut
		1159
		1160	package urxvt::popup;
		1161
		1162	=head2 The C<urxvt::popup> Class
		1163
		1164	=over 4
		1165
		1166	=cut
		1167
		1168	sub add_item {
		1169	my ($self, $item) = @_;
		1170
		1171	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1172	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1173	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1174
		1175	$item->{render} \|\|= sub { $_[0]{text} };
		1176
		1177	push @{ $self->{item} }, $item;
		1178	}
		1179
		1180	sub add_separator {
		1181	my ($self, $sep) = @_;
		1182
		1183	$sep \|\|= "=";
		1184
		1185	$self->add_item ({
		1186	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1187	text => "",
		1188	render => sub { $sep x $self->{term}->ncol },
		1189	activate => sub { },
		1190	});
		1191	}
		1192
		1193	sub add_title {
		1194	my ($self, $title) = @_;
		1195
		1196	$self->add_item ({
		1197	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1198	text => $title,
		1199	activate => sub { },
		1200	});
		1201	}
		1202
		1203	sub add_button {
		1204	my ($self, $text, $cb) = @_;
		1205
		1206	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1207	}
		1208
		1209	sub add_toggle {
		1210	my ($self, $text, $cb, $value) = @_;
		1211
		1212	my $item; $item = {
		1213	type => "button",
		1214	text => " $text",
		1215	value => $value,
		1216	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1217	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1218	};
		1219
		1220	$self->add_item ($item);
		1221	}
		1222
		1223	sub show {
		1224	my ($self) = @_;
		1225
		1226	local $urxvt::popup::self = $self;
		1227
		1228	local $ENV{LC_ALL} = $self->{term}->locale;
		1229
		1230	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1231	"--transient-for" => $self->{term}->parent,
		1232	"-display" => $self->{term}->display_id,
		1233	"-pe" => "urxvt-popup")
		1234	or die "unable to create popup window\n";
		1235	}
		1236
		1237	sub DESTROY {
		1238	my ($self) = @_;
		1239
		1240	delete $self->{term}{_destroy}{$self};
		1241	$self->{term}->ungrab;
		1242	}
876		1243
877	=head2 The C<urxvt::timer> Class	1244	=head2 The C<urxvt::timer> Class
878		1245
879	This class implements timer watchers/events. Time is represented as a	1246	This class implements timer watchers/events. Time is represented as a
880	fractional number of seconds since the epoch. Example:	1247	fractional number of seconds since the epoch. Example:
…		…
982	This variable controls the verbosity level of the perl extension. Higher	1349	This variable controls the verbosity level of the perl extension. Higher
983	numbers indicate more verbose output.	1350	numbers indicate more verbose output.
984		1351
985	=over 4	1352	=over 4
986		1353
987	=item =0 - only fatal messages	1354	=item == 0 - fatal messages
988		1355
989	=item =3 - script loading and management	1356	=item >= 3 - script loading and management
990		1357
991	=item =10 - all events received	1358	=item >=10 - all events received
992		1359
993	=back	1360	=back
994		1361
995	=head1 AUTHOR	1362	=head1 AUTHOR
996		1363

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC vs. Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.35 by root, Fri Jan 6 01:27:27 2006 UTC vs.
Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC