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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.14 by root, Tue Jan 3 01:15:00 2006 UTC vs.
Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC

…		…
		1	=encoding utf8
		2
1	=head1 NAME	3	=head1 NAME
2		4
3	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter	5	@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
4		6
5	=head1 SYNOPSIS	7	=head1 SYNOPSIS
15		17
16	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
17		19
18	=head1 DESCRIPTION	20	=head1 DESCRIPTION
19		21
20	Everytime a terminal object gets created, scripts specified via the	22	Everytime a terminal object gets created, extension scripts specified via
21	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
22		24
23	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
24	thus must be encoded as UTF-8.	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 (But not enabled) for all terminals.	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 (enabled by default)
		43
		44	Intelligent selection. This extension tries to be more intelligent when
		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,
		47	if your F<ls> supports C<--quoting-style=shell>.
		48
		49	It also offers the following bindable event:
		50
		51	=over 4
		52
		53	=item rot13
		54
		55	Rot-13 the selection when activated. Used via keyboard trigger:
		56
		57	URxvt.keysym.C-M-r: perl:selection:rot13
		58
		59	=back
		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
		71	=item digital-clock
		72
		73	Displays a digital clock using the built-in overlay.
		74
		75	=item mark-urls
		76
		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.
		84
		85	=item example-refresh-hooks
		86
		87	Displays a very simple digital clock in the upper right corner of the
		88	window. Illustrates overwriting the refresh callbacks to create your own
		89	overlays or changes.
		90
		91	=back
28		92
29	=head2 General API Considerations	93	=head2 General API Considerations
30		94
31	All objects (such as terminals, time watchers etc.) are typical	95	All objects (such as terminals, time watchers etc.) are typical
32	reference-to-hash objects. The hash can be used to store anything you	96	reference-to-hash objects. The hash can be used to store anything you
33	like. All members starting with an underscore (such as C<_ptr> or	97	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	98	C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
35	modified).	99	modified).
36		100
37	When objects are destroyed on the C++ side, the perl object hashes are	101	When objects are destroyed on the C++ side, the perl object hashes are
38	emptied, so its best to store related objects such as time watchers and	102	emptied, so its best to store related objects such as time watchers and
39	the like inside the terminal object so they get destroyed as soon as the	103	the like inside the terminal object so they get destroyed as soon as the
40	terminal is destroyed.	104	terminal is destroyed.
41		105
		106	Argument names also often indicate the type of a parameter. Here are some
		107	hints on what they mean:
		108
		109	=over 4
		110
		111	=item $text
		112
		113	Rxvt-unicodes special way of encoding text, where one "unicode" character
		114	always represents one screen cell. See L<row_t> for a discussion of this format.
		115
		116	=item $string
		117
		118	A perl text string, with an emphasis on I<text>. It can store all unicode
		119	characters and is to be distinguished with text encoded in a specific
		120	encoding (often locale-specific) and binary data.
		121
		122	=item $octets
		123
		124	Either binary data or - more common - a text string encoded in a
		125	locale-specific way.
		126
		127	=back
		128
42	=head2 Hooks	129	=head2 Hooks
43		130
44	The following subroutines can be declared in loaded scripts, and will be called	131	The following subroutines can be declared in extension files, and will be
45	whenever the relevant event happens.	132	called whenever the relevant event happens.
		133
		134	The first argument passed to them is an object private to each terminal
		135	and extension package. You can call all C<urxvt::term> methods on it, but
		136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
		137	object that is shared between all packages is stored in the C<term>
		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.
46		140
47	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
48	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,
49	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.
50		144
…		…
53	=over 4	147	=over 4
54		148
55	=item on_init $term	149	=item on_init $term
56		150
57	Called after a new terminal object has been initialized, but before	151	Called after a new terminal object has been initialized, but before
58	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.
59		156
60	=item on_reset $term	157	=item on_reset $term
61		158
62	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
63	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
…		…
83	requested from the server. The selection text can be queried and changed	180	requested from the server. The selection text can be queried and changed
84	by calling C<< $term->selection >>.	181	by calling C<< $term->selection >>.
85		182
86	Returning a true value aborts selection grabbing. It will still be hilighted.	183	Returning a true value aborts selection grabbing. It will still be hilighted.
87		184
88	=item on_focus_in $term	185	=item on_sel_extend $term
89		186
90	Called whenever the window gets the keyboard focus, before urxvt does	187	Called whenever the user tries to extend the selection (e.g. with a double
91	focus in processing.	188	click) and is either supposed to return false (normal operation), or
92		189	should extend the selection itelf and return true to suppress the built-in
93	=item on_focus_out $term
94
95	Called wheneever the window loses keyboard focus, before urxvt does focus
96	out processing.	190	processing.
		191
		192	See the F<selection> example extension.
97		193
98	=item on_view_change $term, $offset	194	=item on_view_change $term, $offset
99		195
100	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
101	scrolls. Offset C<0> means display the normal terminal, positive values	197	scrolls. Offset C<0> means display the normal terminal, positive values
…		…
109		205
110	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,
111	$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
112	number of lines that will be in the scrollback buffer.	208	number of lines that will be in the scrollback buffer.
113		209
114	=item on_tty_activity $term NYI	210	=item on_osc_seq $term, $string
115		211
116	Called whenever the program(s) running in the urxvt window send output.	212	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		213	operating system command) is processed. Cursor position and other state
		214	information is up-to-date when this happens. For interoperability, the
		215	string should start with the extension name and a colon, to distinguish
		216	it from commands for other extensions, and this might be enforced in the
		217	future.
		218
		219	Be careful not ever to trust (in a security sense) the data you receive,
		220	as its source can not easily be controleld (e-mail content, messages from
		221	other users on the same system etc.).
		222
		223	=item on_add_lines $term, $string
		224
		225	Called whenever text is about to be output, with the text as argument. You
		226	can filter/change and output the text yourself by returning a true value
		227	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		228	might be very slow, however, as your hook is called for B<all> text being
		229	output.
		230
		231	=item on_line_update $term, $row
		232
		233	Called whenever a line was updated or changed. Can be used to filter
		234	screen output (e.g. underline urls or other useless stuff). Only lines
		235	that are being shown will be filtered, and, due to performance reasons,
		236	not always immediately.
		237
		238	The row number is always the topmost row of the line if the line spans
		239	multiple rows.
		240
		241	Please note that, if you change the line, then the hook might get called
		242	later with the already-modified line (e.g. if unrelated parts change), so
		243	you cannot just toggle rendition bits, but only set them.
117		244
118	=item on_refresh_begin $term	245	=item on_refresh_begin $term
119		246
120	Called just before the screen gets redrawn. Can be used for overlay	247	Called just before the screen gets redrawn. Can be used for overlay
121	or similar effects by modify terminal contents in refresh_begin, and	248	or similar effects by modify terminal contents in refresh_begin, and
…		…
130		257
131	Called whenever the user presses a key combination that has a	258	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>	259	C<perl:string> action bound to it (see description of the B<keysym>
133	resource in the @@RXVT_NAME@@(1) manpage).	260	resource in the @@RXVT_NAME@@(1) manpage).
134		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
135	=back	298	=back
136		299
		300	=head2 Variables in the C<urxvt> Package
		301
		302	=over 4
		303
		304	=item $urxvt::TERM
		305
		306	The current terminal. This variable stores the current C<urxvt::term>
		307	object, whenever a callback/hook is executing.
		308
		309	=back
		310
137	=head2 Functions in the C<urxvt> Package	311	=head2 Functions in the C<urxvt> Package
138		312
139	=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.
140		322
141	=item urxvt::fatal $errormessage	323	=item urxvt::fatal $errormessage
142		324
143	Fatally aborts execution with the given error message. Avoid at all	325	Fatally aborts execution with the given error message. Avoid at all
144	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
…		…
151	that calls this function.	333	that calls this function.
152		334
153	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
154	correct place, e.g. on stderr of the connecting urxvtc client.	336	correct place, e.g. on stderr of the connecting urxvtc client.
155		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
156	=item $time = urxvt::NOW	344	=item $time = urxvt::NOW
157		345
158	Returns the "current time" (as per the event loop).	346	Returns the "current time" (as per the event loop).
159		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.
		355
		356	=back
		357
		358	=head2 RENDITION
		359
		360	Rendition bitsets contain information about colour, font, font styles and
		361	similar information for each screen cell.
		362
		363	The following "macros" deal with changes in rendition sets. You should
		364	never just create a bitset, you should always modify an existing one,
		365	as they contain important information required for correct operation of
		366	rxvt-unicode.
		367
		368	=over 4
		369
		370	=item $rend = urxvt::DEFAULT_RSTYLE
		371
		372	Returns the default rendition, as used when the terminal is starting up or
		373	being reset. Useful as a base to start when creating renditions.
		374
		375	=item $rend = urxvt::OVERLAY_RSTYLE
		376
		377	Return the rendition mask used for overlays by default.
		378
		379	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		380
		381	Return the bit that enabled bold, italic, blink, reverse-video and
		382	underline, respectively. To enable such a style, just logically OR it into
		383	the bitset.
		384
		385	=item $foreground = urxvt::GET_BASEFG $rend
		386
		387	=item $background = urxvt::GET_BASEBG $rend
		388
		389	Return the foreground/background colour index, respectively.
		390
		391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
		392
		393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
		394
		395	Replace the foreground/background colour in the rendition mask with the
		396	specified one.
		397
		398	=item $value = urxvt::GET_CUSTOM ($rend)
		399
		400	Return the "custom" value: Every rendition has 5 bits for use by
		401	extensions. They can be set and changed as you like and are initially
		402	zero.
		403
		404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
		405
		406	Change the custom value.
		407
		408	=back
		409
160	=cut	410	=cut
161		411
162	package urxvt;	412	package urxvt;
163		413
		414	use utf8;
164	use strict;	415	use strict;
		416	use Scalar::Util ();
		417	use List::Util ();
165		418
166	our $term;	419	our $VERSION = 1;
		420	our $TERM;
167	our @HOOKNAME;	421	our @HOOKNAME;
		422	our %OPTION;
168	our $LIBDIR;	423	our $LIBDIR;
169		424
170	BEGIN {	425	BEGIN {
171	urxvt->bootstrap;	426	urxvt->bootstrap;
172		427
…		…
175	my $msg = join "", @_;	430	my $msg = join "", @_;
176	$msg .= "\n"	431	$msg .= "\n"
177	unless $msg =~ /\n$/;	432	unless $msg =~ /\n$/;
178	urxvt::warn ($msg);	433	urxvt::warn ($msg);
179	};	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";
180	}	440	}
181		441
182	my @hook_count;	442	my @hook_count;
183	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
184		444
185	sub verbose {	445	sub verbose {
186	my ($level, $msg) = @_;	446	my ($level, $msg) = @_;
187	warn "$msg\n" if $level <= $verbosity;	447	warn "$msg\n" if $level <= $verbosity;
188	}	448	}
189		449
190	# find on_xxx subs in the package and register them	450	my $extension_pkg = "extension0000";
191	# as hooks	451	my %extension_pkg;
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		452
210	# load a single script into its own package, once only	453	# load a single script into its own package, once only
211	sub script_package($) {	454	sub extension_package($) {
212	my ($path) = @_;	455	my ($path) = @_;
213		456
214	$script_pkg{$path} \|\|= do {	457	$extension_pkg{$path} \|\|= do {
215	my $pkg = "urxvt::" . ($script_pkg++);	458	my $pkg = "urxvt::" . ($extension_pkg++);
216		459
217	verbose 3, "loading script '$path' into package '$pkg'";	460	verbose 3, "loading extension '$path' into package '$pkg'";
218		461
219	open my $fh, "<:raw", $path	462	open my $fh, "<:raw", $path
220	or die "$path: $!";	463	or die "$path: $!";
221		464
222	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"
223	. "#line 1 \"$path\"\n{\n"	467	. "#line 1 \"$path\"\n{\n"
224	. (do { local $/; <$fh> })	468	. (do { local $/; <$fh> })
225	. "\n};\n1";	469	. "\n};\n1";
226		470
227	eval $source or die "$path: $@";	471	eval $source or die "$path: $@";
228		472
229	$pkg	473	$pkg
230	}	474	}
231	}	475	}
232		476
		477	our $retval; # return value for urxvt
		478
233	# called by the rxvt core	479	# called by the rxvt core
234	sub invoke {	480	sub invoke {
235	local $term = shift;	481	local $TERM = shift;
236	my $htype = shift;	482	my $htype = shift;
237		483
238	if ($htype == 0) { # INIT	484	if ($htype == 0) { # INIT
239	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	485	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		486
		487	my %ext_arg;
240		488
241	for my $ext (split /:/, $term->resource ("perl_ext")) {	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) {
242	my @files = grep -f $_, map "$_/$ext", @dirs;	502	my @files = grep -f $_, map "$_/$ext", @dirs;
243		503
244	if (@files) {	504	if (@files) {
245	register_package script_package $files[0];	505	$TERM->register_package (extension_package $files[0], $argv);
246	} else {	506	} else {
247	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";
248	}	508	}
249	}	509	}
250		510
		511	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		512	warn $@ if $@;
		513	}
		514
		515	$retval = undef;
		516
		517	if (my $cb = $TERM->{_hook}[$htype]) {
		518	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		519	if $verbosity >= 10;
		520
		521	keys %$cb;
		522
		523	while (my ($pkg, $cb) = each %$cb) {
		524	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
		525	and last;
		526
		527	if ($@) {
		528	$TERM->ungrab; # better to lose the grab than the session
		529	warn $@;
		530	}
		531	}
		532	}
		533
251	} elsif ($htype == 1) { # DESTROY	534	if ($htype == 1) { # DESTROY
		535	# remove hooks if unused
252	if (my $hook = $term->{_hook}) {	536	if (my $hook = $TERM->{_hook}) {
253	for my $htype (0..$#$hook) {	537	for my $htype (0..$#$hook) {
254	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	538	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
255	or set_should_invoke $htype, 0;	539	or set_should_invoke $htype, 0;
256	}	540	}
257	}	541	}
		542
		543	# clear package objects
		544	%$_ = () for values %{ $TERM->{_pkg} };
		545
		546	# clear package
		547	%$TERM = ();
258	}	548	}
259		549
260	my $cb = $term->{_hook}[$htype]	550	$retval
261	or return;	551	}
262		552
263	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	553	# urxvt::term::proxy
264	if $verbosity >= 10;
265		554
266	while (my ($k, $v) = each %$cb) {	555	sub urxvt::term::proxy::AUTOLOAD {
267	return 1 if $v->($term, @_);	556	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
		557	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
		558
		559	eval qq{
		560	sub $urxvt::term::proxy::AUTOLOAD {
		561	my \$proxy = shift;
		562	\$proxy->{term}->$1 (\@_)
		563	}
		564	1
		565	} or die "FATAL: unable to compile method forwarder: $@";
		566
		567	goto &$urxvt::term::proxy::AUTOLOAD;
		568	}
		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");
268	}	649	}
269
270	0
271	}	650	}
272		651
273	=back	652	package urxvt::term;
274		653
275	=head2 The C<urxvt::term> Class	654	=head2 The C<urxvt::term> Class
276		655
277	=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
278		701
279	=item $value = $term->resource ($name[, $newval])	702	=item $value = $term->resource ($name[, $newval])
280		703
281	Returns the current resource value associated with a given name and	704	Returns the current resource value associated with a given name and
282	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>
…		…
292		715
293	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
294	terminal is destroyed, so changing options frequently will eat memory.	717	terminal is destroyed, so changing options frequently will eat memory.
295		718
296	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
297	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>
298	list:	721	to see the actual list:
299		722
300	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	723	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
301	borderLess color cursorBlink cursorUnderline cutchars delete_key	724	borderLess color cursorBlink cursorUnderline cutchars delete_key
302	display_name embed ext_bwidth fade font geometry hold iconName	725	display_name embed ext_bwidth fade font geometry hold iconName
303	imFont imLocale inputMethod insecure int_bwidth intensityStyles	726	imFont imLocale inputMethod insecure int_bwidth intensityStyles
304	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	727	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
305	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	728	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
306	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	729	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
307	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	730	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
308	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	731	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
309	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	732	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
310	shade term_name title transparent transparent_all tripleclickwords	733	shade term_name title transparent transparent_all tripleclickwords
311	utmpInhibit visualBell	734	utmpInhibit visualBell
312		735
313	=cut	736	=cut
314		737
315	sub urxvt::term::resource($$;$) {	738	sub resource($$;$) {
316	my ($self, $name) = (shift, shift);	739	my ($self, $name) = (shift, shift);
317	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	740	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
318	goto &urxvt::term::_resource;	741	&urxvt::term::_resource
319	}	742	}
		743
		744	=item $rend = $term->rstyle ([$new_rstyle])
		745
		746	Return and optionally change the current rendition. Text that is output by
		747	the terminal application will use this style.
		748
		749	=item ($row, $col) = $term->screen_cur ([$row, $col])
		750
		751	Return the current coordinates of the text cursor position and optionally
		752	set it (which is usually bad as applications don't expect that).
320		753
321	=item ($row, $col) = $term->selection_mark ([$row, $col])	754	=item ($row, $col) = $term->selection_mark ([$row, $col])
322		755
323	=item ($row, $col) = $term->selection_beg ([$row, $col])	756	=item ($row, $col) = $term->selection_beg ([$row, $col])
324		757
…		…
334		767
335	=item $oldtext = $term->selection ([$newtext])	768	=item $oldtext = $term->selection ([$newtext])
336		769
337	Return the current selection text and optionally replace it by C<$newtext>.	770	Return the current selection text and optionally replace it by C<$newtext>.
338		771
339	=item $term->scr_overlay ($x, $y, $text)	772	#=item $term->overlay ($x, $y, $text)
340		773	#
341	Create a simple multi-line overlay box. See the next method for details.	774	#Create a simple multi-line overlay box. See the next method for details.
		775	#
		776	#=cut
		777	#
		778	#sub urxvt::term::scr_overlay {
		779	# my ($self, $x, $y, $text) = @_;
		780	#
		781	# my @lines = split /\n/, $text;
		782	#
		783	# my $w = 0;
		784	# for (map $self->strwidth ($_), @lines) {
		785	# $w = $_ if $w < $_;
		786	# }
		787	#
		788	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);
		789	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
		790	#}
		791
		792	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
		793
		794	Create a new (empty) overlay at the given position with the given
		795	width/height. C<$rstyle> defines the initial rendition style
		796	(default: C<OVERLAY_RSTYLE>).
		797
		798	If C<$border> is C<2> (default), then a decorative border will be put
		799	around the box.
		800
		801	If either C<$x> or C<$y> is negative, then this is counted from the
		802	right/bottom side, respectively.
		803
		804	This method returns an urxvt::overlay object. The overlay will be visible
		805	as long as the perl object is referenced.
		806
		807	The methods currently supported on C<urxvt::overlay> objects are:
		808
		809	=over 4
		810
		811	=item $overlay->set ($x, $y, $text, $rend)
		812
		813	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
		814	text in rxvt-unicode's special encoding and an array of rendition values
		815	at a specific position inside the overlay.
		816
		817	=item $overlay->hide
		818
		819	If visible, hide the overlay, but do not destroy it.
		820
		821	=item $overlay->show
		822
		823	If hidden, display the overlay again.
		824
		825	=back
		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).
342		832
343	=cut	833	=cut
344		834
345	sub urxvt::term::scr_overlay {	835	sub popup {
346	my ($self, $x, $y, $text) = @_;	836	my ($self, $event) = @_;
347		837
348	my @lines = split /\n/, $text;	838	$self->grab ($event->{time}, 1)
		839	or return;
349		840
350	my $w = 0;	841	my $popup = bless {
351	for (map $self->strwidth ($_), @lines) {	842	term => $self,
352	$w = $_ if $w < $_;	843	event => $event,
353	}	844	}, urxvt::popup::;
354		845
355	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	846	Scalar::Util::weaken $popup->{term};
356	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
357	}
358		847
359	=item $term->scr_overlay_new ($x, $y, $width, $height)	848	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		849	Scalar::Util::weaken $self->{_destroy}{$popup};
360		850
361	Create a new (empty) overlay at the given position with the given	851	$popup
362	width/height. A border will be put around the box. If either C<$x> or	852	}
363	C<$y> is negative, then this is counted from the right/bottom side,
364	respectively.
365		853
366	=item $term->scr_overlay_off
367
368	Switch the overlay off again.
369
370	=item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)
371
372	Put a single character (specified numerically) at the given overlay
373	position.
374
375	=item $term->scr_overlay_set ($x, $y, $text)
376
377	Write a string at the given position into the overlay.
378
379	=item $cellwidth = $term->strwidth $string	854	=item $cellwidth = $term->strwidth ($string)
380		855
381	Returns the number of screen-cells this string would need. Correctly	856	Returns the number of screen-cells this string would need. Correctly
382	accounts for wide and combining characters.	857	accounts for wide and combining characters.
383		858
384	=item $octets = $term->locale_encode $string	859	=item $octets = $term->locale_encode ($string)
385		860
386	Convert the given text string into the corresponding locale encoding.	861	Convert the given text string into the corresponding locale encoding.
387		862
388	=item $string = $term->locale_decode $octets	863	=item $string = $term->locale_decode ($octets)
389		864
390	Convert the given locale-encoded octets into a perl string.	865	Convert the given locale-encoded octets into a perl string.
		866
		867	=item $term->scr_add_lines ($string)
		868
		869	Write the given text string to the screen, as if output by the application
		870	running inside the terminal. It may not contain command sequences (escape
		871	codes), but is free to use line feeds, carriage returns and tabs. The
		872	string is a normal text string, not in locale-dependent encoding.
		873
		874	Normally its not a good idea to use this function, as programs might be
		875	confused by changes in cursor position or scrolling. Its useful inside a
		876	C<on_add_lines> hook, though.
		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.
391		883
392	=item $term->tt_write ($octets)	884	=item $term->tt_write ($octets)
393		885
394	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
395	pass characters instead of octets, you should convert your strings first	887	pass characters instead of octets, you should convert your strings first
396	to the locale-specific encoding using C<< $term->locale_encode >>.	888	to the locale-specific encoding using C<< $term->locale_encode >>.
397		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
		898	=item $window_width = $term->width
		899
		900	=item $window_height = $term->height
		901
		902	=item $font_width = $term->fwidth
		903
		904	=item $font_height = $term->fheight
		905
		906	=item $font_ascent = $term->fbase
		907
398	=item $nrow = $term->nrow	908	=item $terminal_rows = $term->nrow
399		909
400	=item $ncol = $term->ncol	910	=item $terminal_columns = $term->ncol
401		911
402	Return the number of rows/columns of the terminal window (i.e. as	912	=item $has_focus = $term->focus
403	specified by C<-geometry>, excluding any scrollback).
404		913
405	=item $nsaved = $term->nsaved	914	=item $is_mapped = $term->mapped
406		915
407	Returns the number of lines in the scrollback buffer.	916	=item $max_scrollback = $term->saveLines
		917
		918	=item $nrow_plus_saveLines = $term->total_rows
		919
		920	=item $lines_in_scrollback = $term->nsaved
		921
		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.
408		940
409	=item $view_start = $term->view_start ([$newvalue])	941	=item $view_start = $term->view_start ([$newvalue])
410		942
411	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
412	C<0>, which displays the normal terminal contents. Larger values scroll	944	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
423	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	955	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
424		956
425	Returns the text of the entire row with number C<$row_number>. Row C<0>	957	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	958	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	959	terminal line. The scrollback buffer starts at line C<-1> and extends to
428	line C<< -$term->nsaved >>.	960	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
		961	is requested.
429		962
430	If C<$new_text> is specified, it will replace characters in the current	963	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	964	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	965	to replace only parts of a line. The font index in the rendition will
433	automatically be updated.	966	automatically be updated.
434		967
435	C<$text> is in a special encoding: tabs and wide characters that use more	968	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	969	than one cell when displayed are padded with urxvt::NOCHAR characters
437	(C<chr 65535>). Characters with combining characters and other characters	970	(C<chr 65535>). Characters with combining characters and other characters
…		…
451	bitsets. Rendition bitsets contain information about colour, font, font	984	bitsets. Rendition bitsets contain information about colour, font, font
452	styles and similar information. See also C<< $term->ROW_t >>.	985	styles and similar information. See also C<< $term->ROW_t >>.
453		986
454	When setting rendition, the font mask will be ignored.	987	When setting rendition, the font mask will be ignored.
455		988
456	See the section on RENDITION, below.	989	See the section on RENDITION, above.
457		990
458	=item $length = $term->ROW_l ($row_number[, $new_length])	991	=item $length = $term->ROW_l ($row_number[, $new_length])
459		992
460	Returns the number of screen cells that are in use ("the line length"). If	993	Returns the number of screen cells that are in use ("the line
461	it is C<-1>, then the line is part of a multiple-row logical "line", which	994	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
462	means all characters are in use and it is continued on the next row.	995	line is joined with the following one.
		996
		997	=item $bool = $term->is_longer ($row_number)
		998
		999	Returns true if the row is part of a multiple-row logical "line" (i.e.
		1000	joined with the following row), which means all characters are in use
		1001	and it is continued on the next row (and possibly a continuation of the
		1002	previous row(s)).
		1003
		1004	=item $line = $term->line ($row_number)
		1005
		1006	Create and return a new C<urxvt::line> object that stores information
		1007	about the logical line that row C<$row_number> is part of. It supports the
		1008	following methods:
		1009
		1010	=over 4
		1011
		1012	=item $text = $line->t ([$new_text])
		1013
		1014	Returns or replaces the full text of the line, similar to C<ROW_t>
		1015
		1016	=item $rend = $line->r ([$new_rend])
		1017
		1018	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		1019
		1020	=item $length = $line->l
		1021
		1022	Returns the length of the line in cells, similar to C<ROW_l>.
		1023
		1024	=item $rownum = $line->beg
		1025
		1026	=item $rownum = $line->end
		1027
		1028	Return the row number of the first/last row of the line, respectively.
		1029
		1030	=item $offset = $line->offset_of ($row, $col)
		1031
		1032	Returns the character offset of the given row\|col pair within the logical
		1033	line.
		1034
		1035	=item ($row, $col) = $line->coord_of ($offset)
		1036
		1037	Translates a string offset into terminal coordinates again.
		1038
		1039	=back
		1040
		1041	=cut
		1042
		1043	sub line {
		1044	my ($self, $row) = @_;
		1045
		1046	my $maxrow = $self->nrow - 1;
		1047
		1048	my ($beg, $end) = ($row, $row);
		1049
		1050	--$beg while $self->ROW_is_longer ($beg - 1);
		1051	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1052
		1053	bless {
		1054	term => $self,
		1055	beg => $beg,
		1056	end => $end,
		1057	ncol => $self->ncol,
		1058	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1059	}, urxvt::line::
		1060	}
		1061
		1062	sub urxvt::line::t {
		1063	my ($self) = @_;
		1064
		1065	if (@_ > 1)
		1066	{
		1067	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1068	for $self->{beg} .. $self->{end};
		1069	}
		1070
		1071	defined wantarray &&
		1072	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1073	0, $self->{len}
		1074	}
		1075
		1076	sub urxvt::line::r {
		1077	my ($self) = @_;
		1078
		1079	if (@_ > 1)
		1080	{
		1081	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1082	for $self->{beg} .. $self->{end};
		1083	}
		1084
		1085	if (defined wantarray) {
		1086	my $rend = [
		1087	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1088	];
		1089	$#$rend = $self->{len} - 1;
		1090	return $rend;
		1091	}
		1092
		1093	()
		1094	}
		1095
		1096	sub urxvt::line::beg { $_[0]{beg} }
		1097	sub urxvt::line::end { $_[0]{end} }
		1098	sub urxvt::line::l { $_[0]{len} }
		1099
		1100	sub urxvt::line::offset_of {
		1101	my ($self, $row, $col) = @_;
		1102
		1103	($row - $self->{beg}) * $self->{ncol} + $col
		1104	}
		1105
		1106	sub urxvt::line::coord_of {
		1107	my ($self, $offset) = @_;
		1108
		1109	use integer;
		1110
		1111	(
		1112	$offset / $self->{ncol} + $self->{beg},
		1113	$offset % $self->{ncol}
		1114	)
		1115	}
463		1116
464	=item $text = $term->special_encode $string	1117	=item $text = $term->special_encode $string
465		1118
466	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,
467	where one character corresponds to one screen cell. See	1120	where one character corresponds to one screen cell. See
…		…
470	=item $string = $term->special_decode $text	1123	=item $string = $term->special_decode $text
471		1124
472	Converts rxvt-unicodes text reprsentation into a perl string. See	1125	Converts rxvt-unicodes text reprsentation into a perl string. See
473	C<< $term->ROW_t >> for details.	1126	C<< $term->ROW_t >> for details.
474		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
475	=back	1156	=back
476		1157
477	=head2 RENDITION	1158	=cut
478		1159
479	Rendition bitsets contain information about colour, font, font styles and	1160	package urxvt::popup;
480	similar information for each screen cell.
481		1161
482	The following "macros" deal with changes in rendition sets. You should	1162	=head2 The C<urxvt::popup> Class
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		1163
487	=over 4	1164	=over 4
488		1165
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	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	}
497		1243
498	=head2 The C<urxvt::timer> Class	1244	=head2 The C<urxvt::timer> Class
499		1245
500	This class implements timer watchers/events. Time is represented as a	1246	This class implements timer watchers/events. Time is represented as a
501	fractional number of seconds since the epoch. Example:	1247	fractional number of seconds since the epoch. Example:
502		1248
503	# create a digital clock display in upper right corner	1249	$term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
504	$term->{timer} = urxvt::timer	1250	$term->{timer} = urxvt::timer
505	->new	1251	->new
506	->start (urxvt::NOW)	1252	->interval (1)
507	->cb (sub {	1253	->cb (sub {
508	my ($timer) = @_;
509	my $time = $timer->at;
510	$timer->start ($time + 1);
511	$self->scr_overlay (-1, 0,	1254	$term->{overlay}->set (0, 0,
512	POSIX::strftime "%H:%M:%S", localtime $time);	1255	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
513	});	1256	});
514		1257
515	=over 4	1258	=over 4
516		1259
517	=item $timer = new urxvt::timer	1260	=item $timer = new urxvt::timer
518		1261
519	Create a new timer object in stopped state.	1262	Create a new timer object in started state. It is scheduled to fire
		1263	immediately.
520		1264
521	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	1265	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
522		1266
523	Set the callback to be called when the timer triggers.	1267	Set the callback to be called when the timer triggers.
524		1268
…		…
527	Return the time this watcher will fire next.	1271	Return the time this watcher will fire next.
528		1272
529	=item $timer = $timer->set ($tstamp)	1273	=item $timer = $timer->set ($tstamp)
530		1274
531	Set the time the event is generated to $tstamp.	1275	Set the time the event is generated to $tstamp.
		1276
		1277	=item $timer = $timer->interval ($interval)
		1278
		1279	Normally (and when C<$interval> is C<0>), the timer will automatically
		1280	stop after it has fired once. If C<$interval> is non-zero, then the timer
		1281	is automatically rescheduled at the given intervals.
532		1282
533	=item $timer = $timer->start	1283	=item $timer = $timer->start
534		1284
535	Start the timer.	1285	Start the timer.
536		1286
…		…
599	This variable controls the verbosity level of the perl extension. Higher	1349	This variable controls the verbosity level of the perl extension. Higher
600	numbers indicate more verbose output.	1350	numbers indicate more verbose output.
601		1351
602	=over 4	1352	=over 4
603		1353
604	=item 0 - only fatal messages	1354	=item == 0 - fatal messages
605		1355
606	=item 3 - script loading and management	1356	=item >= 3 - script loading and management
607		1357
608	=item 10 - all events received	1358	=item >=10 - all events received
609		1359
610	=back	1360	=back
611		1361
612	=head1 AUTHOR	1362	=head1 AUTHOR
613		1363

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.14 by root, Tue Jan 3 01:15:00 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.14 by root, Tue Jan 3 01:15:00 2006 UTC vs.
Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC