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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC vs.
Revision 1.74 by root, Tue Jan 10 04:26:54 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 etxension tries to be more intelligent when the user	44	Intelligent selection. This extension tries to be more intelligent when
45	extends selections (double-click).	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>.
46		48
47	It also offers the following bindable event:	49	It also offers the following bindable event:
48		50
49	=over 4	51	=over 4
50		52
…		…
54		56
55	URxvt.keysym.C-M-r: perl:selection:rot13	57	URxvt.keysym.C-M-r: perl:selection:rot13
56		58
57	=back	59	=back
58		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 searchable-scrollback<hotkey> (enabled by default)
		72
		73	Adds regex search functionality to the scrollback buffer, triggered
		74	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		75	input/output is suspended.
		76
		77	C</> starts an incremental regex search, C<n> searches further, C<p> or
		78	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		79	history, C<enter> leaves search mode at the current position and C<escape>
		80	returns to the original position.
		81
59	=item digital-clock	82	=item digital-clock
60		83
61	Displays a digital clock using the built-in overlay.	84	Displays a digital clock using the built-in overlay.
		85
		86	=item mark-urls
		87
		88	Uses per-line display filtering (C<on_line_update>) to underline urls.
		89
		90	=item block-graphics-to-ascii
		91
		92	A not very useful example of filtering all text output to the terminal,
		93	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		94	similar-looking ascii character.
62		95
63	=item example-refresh-hooks	96	=item example-refresh-hooks
64		97
65	Displays a very simple digital clock in the upper right corner of the	98	Displays a very simple digital clock in the upper right corner of the
66	window. Illustrates overwriting the refresh callbacks to create your own	99	window. Illustrates overwriting the refresh callbacks to create your own
…		…
79	When objects are destroyed on the C++ side, the perl object hashes are	112	When objects are destroyed on the C++ side, the perl object hashes are
80	emptied, so its best to store related objects such as time watchers and	113	emptied, so its best to store related objects such as time watchers and
81	the like inside the terminal object so they get destroyed as soon as the	114	the like inside the terminal object so they get destroyed as soon as the
82	terminal is destroyed.	115	terminal is destroyed.
83		116
		117	Argument names also often indicate the type of a parameter. Here are some
		118	hints on what they mean:
		119
		120	=over 4
		121
		122	=item $text
		123
		124	Rxvt-unicodes special way of encoding text, where one "unicode" character
		125	always represents one screen cell. See L<row_t> for a discussion of this format.
		126
		127	=item $string
		128
		129	A perl text string, with an emphasis on I<text>. It can store all unicode
		130	characters and is to be distinguished with text encoded in a specific
		131	encoding (often locale-specific) and binary data.
		132
		133	=item $octets
		134
		135	Either binary data or - more common - a text string encoded in a
		136	locale-specific way.
		137
		138	=back
		139
		140	=head2 Extension Objects
		141
		142	Very perl extension is a perl class. A separate perl object is created
		143	for each terminal and each extension and passed as the first parameter to
		144	hooks. So extensions can use their C<$self> object without having to think
		145	about other extensions, with the exception of methods and members that
		146	begin with an underscore character C<_>: these are reserved for internal
		147	use.
		148
		149	Although it isn't a C<urxvt::term> object, you can call all methods of the
		150	C<urxvt::term> class on this object.
		151
		152	It has the following methods and data members:
		153
		154	=over 4
		155
		156	=item $urxvt_term = $self->{term}
		157
		158	Returns the C<urxvt::term> object associated with this instance of the
		159	extension. This member I<must not> be changed in any way.
		160
		161	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		162
		163	Dynamically enable the given hooks (named without the C<on_> prefix) for
		164	this extension, replacing any previous hook. This is useful when you want
		165	to overwrite time-critical hooks only temporarily.
		166
		167	=item $self->disable ($hook_name[, $hook_name..])
		168
		169	Dynamically disable the given hooks.
		170
		171	=back
		172
84	=head2 Hooks	173	=head2 Hooks
85		174
86	The following subroutines can be declared in loaded scripts, and will be	175	The following subroutines can be declared in extension files, and will be
87	called whenever the relevant event happens.	176	called whenever the relevant event happens.
88		177
89	The first argument passed to them is an object private to each terminal	178	The first argument passed to them is an extension oject as described in
90	and extension package. You can call all C<urxvt::term> methods on it, but	179	the in the C<Extension Objects> section.
91	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
92	object that is shared between all packages is stored in the C<term>
93	member.
94		180
95	All of them must return a boolean value. If it is true, then the event	181	B<All> of these hooks must return a boolean value. If it is true, then the
96	counts as being I<consumed>, and the invocation of other hooks is skipped,	182	event counts as being I<consumed>, and the invocation of other hooks is
97	and the relevant action might not be carried out by the C++ code.	183	skipped, and the relevant action might not be carried out by the C++ code.
98		184
99	When in doubt, return a false value (preferably C<()>).	185	I<< When in doubt, return a false value (preferably C<()>). >>
100		186
101	=over 4	187	=over 4
102		188
103	=item on_init $term	189	=item on_init $term
104		190
105	Called after a new terminal object has been initialized, but before	191	Called after a new terminal object has been initialized, but before
106	windows are created or the command gets run.	192	windows are created or the command gets run. Most methods are unsafe to
		193	call or deliver senseless data, as terminal size and other characteristics
		194	have not yet been determined. You can safely query and change resources,
		195	though.
107		196
108	=item on_reset $term	197	=item on_reset $term
109		198
110	Called after the screen is "reset" for any reason, such as resizing or	199	Called after the screen is "reset" for any reason, such as resizing or
111	control sequences. Here is where you can react on changes to size-related	200	control sequences. Here is where you can react on changes to size-related
…		…
140	should extend the selection itelf and return true to suppress the built-in	229	should extend the selection itelf and return true to suppress the built-in
141	processing.	230	processing.
142		231
143	See the F<selection> example extension.	232	See the F<selection> example extension.
144		233
145	=item on_focus_in $term
146
147	Called whenever the window gets the keyboard focus, before urxvt does
148	focus in processing.
149
150	=item on_focus_out $term
151
152	Called wheneever the window loses keyboard focus, before urxvt does focus
153	out processing.
154
155	=item on_view_change $term, $offset	234	=item on_view_change $term, $offset
156		235
157	Called whenever the view offset changes, i..e the user or program	236	Called whenever the view offset changes, i..e the user or program
158	scrolls. Offset C<0> means display the normal terminal, positive values	237	scrolls. Offset C<0> means display the normal terminal, positive values
159	show this many lines of scrollback.	238	show this many lines of scrollback.
…		…
166		245
167	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	246	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
168	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	247	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
169	number of lines that will be in the scrollback buffer.	248	number of lines that will be in the scrollback buffer.
170		249
171	=item on_tty_activity $term NYI	250	=item on_osc_seq $term, $string
172		251
173	Called whenever the program(s) running in the urxvt window send output.	252	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
		253	operating system command) is processed. Cursor position and other state
		254	information is up-to-date when this happens. For interoperability, the
		255	string should start with the extension name and a colon, to distinguish
		256	it from commands for other extensions, and this might be enforced in the
		257	future.
		258
		259	Be careful not ever to trust (in a security sense) the data you receive,
		260	as its source can not easily be controleld (e-mail content, messages from
		261	other users on the same system etc.).
		262
		263	=item on_add_lines $term, $string
		264
		265	Called whenever text is about to be output, with the text as argument. You
		266	can filter/change and output the text yourself by returning a true value
		267	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		268	might be very slow, however, as your hook is called for B<all> text being
		269	output.
		270
		271	=item on_tt_write $term, $octets
		272
		273	Called whenever some data is written to the tty/pty and can be used to
		274	suppress or filter tty input.
		275
		276	=item on_line_update $term, $row
		277
		278	Called whenever a line was updated or changed. Can be used to filter
		279	screen output (e.g. underline urls or other useless stuff). Only lines
		280	that are being shown will be filtered, and, due to performance reasons,
		281	not always immediately.
		282
		283	The row number is always the topmost row of the line if the line spans
		284	multiple rows.
		285
		286	Please note that, if you change the line, then the hook might get called
		287	later with the already-modified line (e.g. if unrelated parts change), so
		288	you cannot just toggle rendition bits, but only set them.
174		289
175	=item on_refresh_begin $term	290	=item on_refresh_begin $term
176		291
177	Called just before the screen gets redrawn. Can be used for overlay	292	Called just before the screen gets redrawn. Can be used for overlay
178	or similar effects by modify terminal contents in refresh_begin, and	293	or similar effects by modify terminal contents in refresh_begin, and
…		…
187		302
188	Called whenever the user presses a key combination that has a	303	Called whenever the user presses a key combination that has a
189	C<perl:string> action bound to it (see description of the B<keysym>	304	C<perl:string> action bound to it (see description of the B<keysym>
190	resource in the @@RXVT_NAME@@(1) manpage).	305	resource in the @@RXVT_NAME@@(1) manpage).
191		306
		307	=item on_focus_in $term
		308
		309	Called whenever the window gets the keyboard focus, before rxvt-unicode
		310	does focus in processing.
		311
		312	=item on_focus_out $term
		313
		314	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		315	focus out processing.
		316
		317	=item on_key_press $term, $event, $keysym, $octets
		318
		319	=item on_key_release $term, $event, $keysym
		320
		321	=item on_button_press $term, $event
		322
		323	=item on_button_release $term, $event
		324
		325	=item on_motion_notify $term, $event
		326
		327	=item on_map_notify $term, $event
		328
		329	=item on_unmap_notify $term, $event
		330
		331	Called whenever the corresponding X event is received for the terminal If
		332	the hook returns true, then the even will be ignored by rxvt-unicode.
		333
		334	The event is a hash with most values as named by Xlib (see the XEvent
		335	manpage), with the additional members C<row> and C<col>, which are the row
		336	and column under the mouse cursor.
		337
		338	C<on_key_press> additionally receives the string rxvt-unicode would
		339	output, if any, in locale-specific encoding.
		340
		341	subwindow.
		342
192	=back	343	=back
193		344
194	=head2 Variables in the C<urxvt> Package	345	=head2 Variables in the C<urxvt> Package
195		346
196	=over 4	347	=over 4
197		348
198	=item $urxvt::TERM	349	=item $urxvt::TERM
199		350
200	The current terminal. Whenever a callback/Hook is bein executed, this	351	The current terminal. This variable stores the current C<urxvt::term>
201	variable stores the current C<urxvt::term> object.	352	object, whenever a callback/hook is executing.
202		353
203	=back	354	=back
204		355
205	=head2 Functions in the C<urxvt> Package	356	=head2 Functions in the C<urxvt> Package
206		357
207	=over 4	358	=over 4
		359
		360	=item $term = new urxvt [arg...]
		361
		362	Creates a new terminal, very similar as if you had started it with
		363	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		364	if the new instance couldn't be created. Returns C<undef> if the new
		365	instance didn't initialise perl, and the terminal object otherwise. The
		366	C<init> and C<start> hooks will be called during the call.
208		367
209	=item urxvt::fatal $errormessage	368	=item urxvt::fatal $errormessage
210		369
211	Fatally aborts execution with the given error message. Avoid at all	370	Fatally aborts execution with the given error message. Avoid at all
212	costs! The only time this is acceptable is when the terminal process	371	costs! The only time this is acceptable is when the terminal process
…		…
219	that calls this function.	378	that calls this function.
220		379
221	Using this function has the advantage that its output ends up in the	380	Using this function has the advantage that its output ends up in the
222	correct place, e.g. on stderr of the connecting urxvtc client.	381	correct place, e.g. on stderr of the connecting urxvtc client.
223		382
		383	=item $is_safe = urxvt::safe
		384
		385	Returns true when it is safe to do potentially unsafe things, such as
		386	evaluating perl code specified by the user. This is true when urxvt was
		387	started setuid or setgid.
		388
224	=item $time = urxvt::NOW	389	=item $time = urxvt::NOW
225		390
226	Returns the "current time" (as per the event loop).	391	Returns the "current time" (as per the event loop).
		392
		393	=item urxvt::CurrentTime
		394
		395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		397	Button4Mask, Button5Mask, AnyModifier
		398
		399	Various constants for use in X calls and event processing.
227		400
228	=back	401	=back
229		402
230	=head2 RENDITION	403	=head2 RENDITION
231		404
…		…
281		454
282	=cut	455	=cut
283		456
284	package urxvt;	457	package urxvt;
285		458
		459	use utf8;
286	use strict;	460	use strict;
		461	use Carp ();
287	use Scalar::Util ();	462	use Scalar::Util ();
		463	use List::Util ();
288		464
		465	our $VERSION = 1;
289	our $TERM;	466	our $TERM;
290	our @HOOKNAME;	467	our @HOOKNAME;
		468	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		469	our %OPTION;
		470
291	our $LIBDIR;	471	our $LIBDIR;
		472	our $RESNAME;
		473	our $RESCLASS;
		474	our $RXVTNAME;
292		475
293	BEGIN {	476	BEGIN {
294	urxvt->bootstrap;	477	urxvt->bootstrap;
295		478
296	# overwrite perl's warn	479	# overwrite perl's warn
…		…
298	my $msg = join "", @_;	481	my $msg = join "", @_;
299	$msg .= "\n"	482	$msg .= "\n"
300	unless $msg =~ /\n$/;	483	unless $msg =~ /\n$/;
301	urxvt::warn ($msg);	484	urxvt::warn ($msg);
302	};	485	};
		486
		487	delete $ENV{IFS};
		488	delete $ENV{CDPATH};
		489	delete $ENV{BASH_ENV};
		490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
303	}	491	}
304		492
305	my @hook_count;	493	my @hook_count;
306	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
307		495
308	sub verbose {	496	sub verbose {
309	my ($level, $msg) = @_;	497	my ($level, $msg) = @_;
310	warn "$msg\n" if $level <= $verbosity;	498	warn "$msg\n" if $level <= $verbosity;
311	}	499	}
312		500
313	# find on_xxx subs in the package and register them	501	my $extension_pkg = "extension0000";
314	# as hooks	502	my %extension_pkg;
315	sub register_package($) {
316	my ($pkg) = @_;
317
318	for my $htype (0.. $#HOOKNAME) {
319	my $name = $HOOKNAME[$htype];
320
321	my $ref = $pkg->can ("on_" . lc $name)
322	or next;
323
324	$TERM->{_hook}[$htype]{$pkg} = $ref;
325	$hook_count[$htype]++
326	or set_should_invoke $htype, 1;
327	}
328	}
329
330	my $script_pkg = "script0000";
331	my %script_pkg;
332		503
333	# load a single script into its own package, once only	504	# load a single script into its own package, once only
334	sub script_package($) {	505	sub extension_package($) {
335	my ($path) = @_;	506	my ($path) = @_;
336		507
337	$script_pkg{$path} \|\|= do {	508	$extension_pkg{$path} \|\|= do {
338	my $pkg = "urxvt::" . ($script_pkg++);	509	my $pkg = "urxvt::" . ($extension_pkg++);
339		510
340	verbose 3, "loading script '$path' into package '$pkg'";	511	verbose 3, "loading extension '$path' into package '$pkg'";
341		512
342	open my $fh, "<:raw", $path	513	open my $fh, "<:raw", $path
343	or die "$path: $!";	514	or die "$path: $!";
344		515
		516	my $source = untaint
345	my $source = "package $pkg; use strict; use utf8;\n"	517	"package $pkg; use strict; use utf8;\n"
		518	. "use base urxvt::term::extension::;\n"
346	. "#line 1 \"$path\"\n{\n"	519	. "#line 1 \"$path\"\n{\n"
347	. (do { local $/; <$fh> })	520	. (do { local $/; <$fh> })
348	. "\n};\n1";	521	. "\n};\n1";
349		522
		523	eval $source
350	eval $source or die "$path: $@";	524	or die "$path: $@";
351		525
352	$pkg	526	$pkg
353	}	527	}
354	}	528	}
		529
		530	our $retval; # return value for urxvt
355		531
356	# called by the rxvt core	532	# called by the rxvt core
357	sub invoke {	533	sub invoke {
358	local $TERM = shift;	534	local $TERM = shift;
359	my $htype = shift;	535	my $htype = shift;
360		536
361	if ($htype == 0) { # INIT	537	if ($htype == 0) { # INIT
362	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	538	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		539
		540	my %ext_arg;
363		541
364	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	542	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		543	if ($_ eq "default") {
		544	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		545	} elsif (/^-(.*)$/) {
		546	delete $ext_arg{$1};
		547	} elsif (/^([^<]+)<(.*)>$/) {
		548	push @{ $ext_arg{$1} }, $2;
		549	} else {
		550	$ext_arg{$_} \|\|= [];
		551	}
		552	}
		553
		554	while (my ($ext, $argv) = each %ext_arg) {
365	my @files = grep -f $_, map "$_/$ext", @dirs;	555	my @files = grep -f $_, map "$_/$ext", @dirs;
366		556
367	if (@files) {	557	if (@files) {
368	register_package script_package $files[0];	558	$TERM->register_package (extension_package $files[0], $argv);
369	} else {	559	} else {
370	warn "perl extension '$ext' not found in perl library search path\n";	560	warn "perl extension '$ext' not found in perl library search path\n";
371	}	561	}
372	}	562	}
373		563
		564	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		565	warn $@ if $@;
		566	}
		567
		568	$retval = undef;
		569
		570	if (my $cb = $TERM->{_hook}[$htype]) {
		571	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		572	if $verbosity >= 10;
		573
		574	keys %$cb;
		575
		576	while (my ($pkg, $cb) = each %$cb) {
		577	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
		578	and last;
		579
		580	if ($@) {
		581	$TERM->ungrab; # better to lose the grab than the session
		582	warn $@;
		583	}
		584	}
		585	}
		586
374	} elsif ($htype == 1) { # DESTROY	587	if ($htype == 1) { # DESTROY
375	if (my $hook = $TERM->{_hook}) {	588	if (my $hook = delete $TERM->{_hook}) {
376	for my $htype (0..$#$hook) {	589	for my $htype (0..$#$hook) {
377	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
378	or set_should_invoke $htype, 0;	591	or set_should_invoke $htype, 0;
379	}	592	}
380	}	593	}
		594
		595	# clear package objects
		596	%$_ = () for values %{ $TERM->{_pkg} };
		597
		598	# clear package
		599	%$TERM = ();
381	}	600	}
382		601
383	my $cb = $TERM->{_hook}[$htype]	602	$retval
384	or return;	603	}
385		604
386	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	605	# urxvt::term::extension
387	if $verbosity >= 10;
388		606
389	keys %$cb;	607	package urxvt::term::extension;
390		608
		609	sub enable {
		610	my ($self, %hook) = @_;
		611	my $pkg = $self->{_pkg};
		612
391	while (my ($pkg, $cb) = each %$cb) {	613	while (my ($name, $cb) = each %hook) {
392	return 1	614	my $htype = $HOOKTYPE{uc $name};
393	if $cb->(	615	defined $htype
394	$TERM->{$pkg} \|\|= do {	616	or Carp::croak "unsupported hook type '$name'";
395	my $proxy = bless { }, urxvt::term::proxy::;	617
396	Scalar::Util::weaken ($proxy->{term} = $TERM);	618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
397	$proxy	619	$hook_count[$htype]++
398	},	620	or urxvt::set_should_invoke $htype, 1;
399	@_,	621	}
400	);	622
		623	$self->{term}{_hook}[$htype]{$pkg} = $cb;
401	}	624	}
		625	}
402		626
		627	sub disable {
		628	my ($self, @hook) = @_;
		629	my $pkg = $self->{_pkg};
		630
		631	for my $name (@hook) {
		632	my $htype = $HOOKTYPE{uc $name};
		633	defined $htype
		634	or Carp::croak "unsupported hook type '$name'";
		635
		636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		637	--$hook_count[$htype]
		638	or urxvt::set_should_invoke $htype, 0;
		639	}
403	0	640	}
404	}	641	}
405		642
406	sub urxvt::term::proxy::AUTOLOAD {	643	our $AUTOLOAD;
407	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	644
		645	sub AUTOLOAD {
		646	$AUTOLOAD =~ /:([^:]+)$/
408	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	647	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
409		648
410	eval qq{	649	eval qq{
411	sub $urxvt::term::proxy::AUTOLOAD {	650	sub $AUTOLOAD {
412	my \$proxy = shift;	651	my \$proxy = shift;
413	\$proxy->{term}->$1 (\@_)	652	\$proxy->{term}->$1 (\@_)
414	}	653	}
415	1	654	1
416	} or die "FATAL: unable to compile method forwarder: $@";	655	} or die "FATAL: unable to compile method forwarder: $@";
417		656
418	goto &$urxvt::term::proxy::AUTOLOAD;	657	goto &$AUTOLOAD;
419	}	658	}
		659
		660	sub DESTROY {
		661	# nop
		662	}
		663
		664	# urxvt::destroy_hook
		665
		666	sub urxvt::destroy_hook::DESTROY {
		667	${$_[0]}->();
		668	}
		669
		670	sub urxvt::destroy_hook(&) {
		671	bless \shift, urxvt::destroy_hook::
		672	}
		673
		674	package urxvt::anyevent;
		675
		676	=head2 The C<urxvt::anyevent> Class
		677
		678	The sole purpose of this class is to deliver an interface to the
		679	C<AnyEvent> module - any module using it will work inside urxvt without
		680	further work. The only exception is that you cannot wait on condition
		681	variables, but non-blocking condvar use is ok. What this means is that you
		682	cannot use blocking APIs, but the non-blocking variant should work.
		683
		684	=cut
		685
		686	our $VERSION = 1;
		687
		688	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		689	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		690
		691	sub timer {
		692	my ($class, %arg) = @_;
		693
		694	my $cb = $arg{cb};
		695
		696	urxvt::timer
		697	->new
		698	->start (urxvt::NOW + $arg{after})
		699	->cb (sub {
		700	$_[0]->stop; # need to cancel manually
		701	$cb->();
		702	})
		703	}
		704
		705	sub io {
		706	my ($class, %arg) = @_;
		707
		708	my $cb = $arg{cb};
		709
		710	bless [$arg{fh}, urxvt::iow
		711	->new
		712	->fd (fileno $arg{fh})
		713	->events (($arg{poll} =~ /r/ ? 1 : 0)
		714	\| ($arg{poll} =~ /w/ ? 2 : 0))
		715	->start
		716	->cb (sub {
		717	$cb->(($_[1] & 1 ? 'r' : '')
		718	. ($_[1] & 2 ? 'w' : ''));
		719	})],
		720	urxvt::anyevent::
		721	}
		722
		723	sub DESTROY {
		724	$_[0][1]->stop;
		725	}
		726
		727	sub condvar {
		728	bless \my $flag, urxvt::anyevent::condvar::
		729	}
		730
		731	sub urxvt::anyevent::condvar::broadcast {
		732	${$_[0]}++;
		733	}
		734
		735	sub urxvt::anyevent::condvar::wait {
		736	unless (${$_[0]}) {
		737	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		738	}
		739	}
		740
		741	package urxvt::term;
420		742
421	=head2 The C<urxvt::term> Class	743	=head2 The C<urxvt::term> Class
422		744
423	=over 4	745	=over 4
		746
		747	=cut
		748
		749	# find on_xxx subs in the package and register them
		750	# as hooks
		751	sub register_package {
		752	my ($self, $pkg, $argv) = @_;
		753
		754	my $proxy = bless {
		755	_pkg => $pkg,
		756	argv => $argv,
		757	}, $pkg;
		758	Scalar::Util::weaken ($proxy->{term} = $self);
		759
		760	$self->{_pkg}{$pkg} = $proxy;
		761
		762	for my $name (@HOOKNAME) {
		763	if (my $ref = $pkg->can ("on_" . lc $name)) {
		764	$proxy->enable ($name => $ref);
		765	}
		766	}
		767	}
		768
		769	=item $term->destroy
		770
		771	Destroy the terminal object (close the window, free resources etc.).
		772
		773	=item $isset = $term->option ($optval[, $set])
		774
		775	Returns true if the option specified by C<$optval> is enabled, and
		776	optionally change it. All option values are stored by name in the hash
		777	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		778
		779	Here is a a likely non-exhaustive list of option names, please see the
		780	source file F</src/optinc.h> to see the actual list:
		781
		782	borderLess console cursorBlink cursorUnderline hold iconic insecure
		783	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		784	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		785	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		786	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		787	tripleclickwords utmpInhibit visualBell
424		788
425	=item $value = $term->resource ($name[, $newval])	789	=item $value = $term->resource ($name[, $newval])
426		790
427	Returns the current resource value associated with a given name and	791	Returns the current resource value associated with a given name and
428	optionally sets a new value. Setting values is most useful in the C<init>	792	optionally sets a new value. Setting values is most useful in the C<init>
…		…
438		802
439	Please note that resource strings will currently only be freed when the	803	Please note that resource strings will currently only be freed when the
440	terminal is destroyed, so changing options frequently will eat memory.	804	terminal is destroyed, so changing options frequently will eat memory.
441		805
442	Here is a a likely non-exhaustive list of resource names, not all of which	806	Here is a a likely non-exhaustive list of resource names, not all of which
443	are supported in every build, please see the source to see the actual	807	are supported in every build, please see the source file F</src/rsinc.h>
444	list:	808	to see the actual list:
445		809
446	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	810	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447	borderLess color cursorBlink cursorUnderline cutchars delete_key	811	borderLess color cursorBlink cursorUnderline cutchars delete_key
448	display_name embed ext_bwidth fade font geometry hold iconName	812	display_name embed ext_bwidth fade font geometry hold iconName
449	imFont imLocale inputMethod insecure int_bwidth intensityStyles	813	imFont imLocale inputMethod insecure int_bwidth intensityStyles
450	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	814	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
451	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	815	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
452	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	816	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
453	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	817	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
454	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	818	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
455	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	819	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
456	shade term_name title transparent transparent_all tripleclickwords	820	shade term_name title transparent transparent_all tripleclickwords
457	utmpInhibit visualBell	821	utmpInhibit visualBell
458		822
459	=cut	823	=cut
460		824
461	sub urxvt::term::resource($$;$) {	825	sub resource($$;$) {
462	my ($self, $name) = (shift, shift);	826	my ($self, $name) = (shift, shift);
463	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
464	goto &urxvt::term::_resource;	828	&urxvt::term::_resource
465	}	829	}
		830
		831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		832
		833	Adds a keymap translation exactly as specified via a resource. See the
		834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		835
		836	=item $rend = $term->rstyle ([$new_rstyle])
		837
		838	Return and optionally change the current rendition. Text that is output by
		839	the terminal application will use this style.
		840
		841	=item ($row, $col) = $term->screen_cur ([$row, $col])
		842
		843	Return the current coordinates of the text cursor position and optionally
		844	set it (which is usually bad as applications don't expect that).
466		845
467	=item ($row, $col) = $term->selection_mark ([$row, $col])	846	=item ($row, $col) = $term->selection_mark ([$row, $col])
468		847
469	=item ($row, $col) = $term->selection_beg ([$row, $col])	848	=item ($row, $col) = $term->selection_beg ([$row, $col])
470		849
…		…
480		859
481	=item $oldtext = $term->selection ([$newtext])	860	=item $oldtext = $term->selection ([$newtext])
482		861
483	Return the current selection text and optionally replace it by C<$newtext>.	862	Return the current selection text and optionally replace it by C<$newtext>.
484		863
485	#=item $term->overlay ($x, $y, $text)	864	=item $term->overlay_simple ($x, $y, $text)
486	#	865
487	#Create a simple multi-line overlay box. See the next method for details.	866	Create a simple multi-line overlay box. See the next method for details.
488	#	867
489	#=cut	868	=cut
490		869
491	sub urxvt::term::scr_overlay {	870	sub overlay_simple {
492	die;
493	my ($self, $x, $y, $text) = @_;	871	my ($self, $x, $y, $text) = @_;
494		872
495	my @lines = split /\n/, $text;	873	my @lines = split /\n/, $text;
496		874
497	my $w = 0;	875	my $w = List::Util::max map $self->strwidth ($_), @lines;
498	for (map $self->strwidth ($_), @lines) {
499	$w = $_ if $w < $_;
500	}
501		876
502	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	877	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
503	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	878	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		879
		880	$overlay
504	}	881	}
505		882
506	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	883	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
507		884
508	Create a new (empty) overlay at the given position with the given	885	Create a new (empty) overlay at the given position with the given
…		…
536		913
537	If hidden, display the overlay again.	914	If hidden, display the overlay again.
538		915
539	=back	916	=back
540		917
		918	=item $popup = $term->popup ($event)
		919
		920	Creates a new C<urxvt::popup> object that implements a popup menu. The
		921	C<$event> I<must> be the event causing the menu to pop up (a button event,
		922	currently).
		923
		924	=cut
		925
		926	sub popup {
		927	my ($self, $event) = @_;
		928
		929	$self->grab ($event->{time}, 1)
		930	or return;
		931
		932	my $popup = bless {
		933	term => $self,
		934	event => $event,
		935	}, urxvt::popup::;
		936
		937	Scalar::Util::weaken $popup->{term};
		938
		939	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		940	Scalar::Util::weaken $self->{_destroy}{$popup};
		941
		942	$popup
		943	}
		944
541	=item $cellwidth = $term->strwidth $string	945	=item $cellwidth = $term->strwidth ($string)
542		946
543	Returns the number of screen-cells this string would need. Correctly	947	Returns the number of screen-cells this string would need. Correctly
544	accounts for wide and combining characters.	948	accounts for wide and combining characters.
545		949
546	=item $octets = $term->locale_encode $string	950	=item $octets = $term->locale_encode ($string)
547		951
548	Convert the given text string into the corresponding locale encoding.	952	Convert the given text string into the corresponding locale encoding.
549		953
550	=item $string = $term->locale_decode $octets	954	=item $string = $term->locale_decode ($octets)
551		955
552	Convert the given locale-encoded octets into a perl string.	956	Convert the given locale-encoded octets into a perl string.
		957
		958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		959
		960	XORs the rendition values in the given span with the provided value
		961	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		962	to the selection.
		963
		964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		965
		966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		967	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		968	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		969	it instead.
		970
		971	=item $term->scr_bell
		972
		973	Ring the bell!
		974
		975	=item $term->scr_add_lines ($string)
		976
		977	Write the given text string to the screen, as if output by the application
		978	running inside the terminal. It may not contain command sequences (escape
		979	codes), but is free to use line feeds, carriage returns and tabs. The
		980	string is a normal text string, not in locale-dependent encoding.
		981
		982	Normally its not a good idea to use this function, as programs might be
		983	confused by changes in cursor position or scrolling. Its useful inside a
		984	C<on_add_lines> hook, though.
		985
		986	=item $term->cmd_parse ($octets)
		987
		988	Similar to C<scr_add_lines>, but the argument must be in the
		989	locale-specific encoding of the terminal and can contain command sequences
		990	(escape codes) that will be interpreted.
553		991
554	=item $term->tt_write ($octets)	992	=item $term->tt_write ($octets)
555		993
556	Write the octets given in C<$data> to the tty (i.e. as program input). To	994	Write the octets given in C<$data> to the tty (i.e. as program input). To
557	pass characters instead of octets, you should convert your strings first	995	pass characters instead of octets, you should convert your strings first
558	to the locale-specific encoding using C<< $term->locale_encode >>.	996	to the locale-specific encoding using C<< $term->locale_encode >>.
559		997
		998	=item $old_events = $term->pty_ev_events ([$new_events])
		999
		1000	Replaces the event mask of the pty watcher by the given event mask. Can
		1001	be used to suppress input and output handling to the pty/tty. See the
		1002	description of C<< urxvt::timer->events >>. Make sure to always restore
		1003	the previous value.
		1004
		1005	=item $windowid = $term->parent
		1006
		1007	Return the window id of the toplevel window.
		1008
		1009	=item $windowid = $term->vt
		1010
		1011	Return the window id of the terminal window.
		1012
		1013	=item $window_width = $term->width
		1014
		1015	=item $window_height = $term->height
		1016
		1017	=item $font_width = $term->fwidth
		1018
		1019	=item $font_height = $term->fheight
		1020
		1021	=item $font_ascent = $term->fbase
		1022
560	=item $nrow = $term->nrow	1023	=item $terminal_rows = $term->nrow
561		1024
562	=item $ncol = $term->ncol	1025	=item $terminal_columns = $term->ncol
563		1026
564	Return the number of rows/columns of the terminal window (i.e. as	1027	=item $has_focus = $term->focus
565	specified by C<-geometry>, excluding any scrollback).
566		1028
567	=item $nsaved = $term->nsaved	1029	=item $is_mapped = $term->mapped
568		1030
569	Returns the number of lines in the scrollback buffer.	1031	=item $max_scrollback = $term->saveLines
		1032
		1033	=item $nrow_plus_saveLines = $term->total_rows
		1034
		1035	=item $lines_in_scrollback = $term->nsaved
		1036
		1037	Return various integers describing terminal characteristics.
		1038
		1039	=item $lc_ctype = $term->locale
		1040
		1041	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1042
		1043	=item $x_display = $term->display_id
		1044
		1045	Return the DISPLAY used by rxvt-unicode.
		1046
		1047	=item $modifiermask = $term->ModLevel3Mask
		1048
		1049	=item $modifiermask = $term->ModMetaMask
		1050
		1051	=item $modifiermask = $term->ModNumLockMask
		1052
		1053	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1054	AltGr), the meta key (often Alt) and the num lock key, if applicable.
570		1055
571	=item $view_start = $term->view_start ([$newvalue])	1056	=item $view_start = $term->view_start ([$newvalue])
572		1057
573	Returns the negative row number of the topmost line. Minimum value is	1058	Returns the negative row number of the topmost line. Minimum value is
574	C<0>, which displays the normal terminal contents. Larger values scroll	1059	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
637	about the logical line that row C<$row_number> is part of. It supports the	1122	about the logical line that row C<$row_number> is part of. It supports the
638	following methods:	1123	following methods:
639		1124
640	=over 4	1125	=over 4
641		1126
642	=item $text = $line->t	1127	=item $text = $line->t ([$new_text])
643		1128
644	Returns the full text of the line, similar to C<ROW_t>	1129	Returns or replaces the full text of the line, similar to C<ROW_t>
645		1130
646	=item $rend = $line->r	1131	=item $rend = $line->r ([$new_rend])
647		1132
648	Returns the full rendition array of the line, similar to C<ROW_r>	1133	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
649		1134
650	=item $length = $line->l	1135	=item $length = $line->l
651		1136
652	Returns the length of the line in cells, similar to C<ROW_l>.	1137	Returns the length of the line in cells, similar to C<ROW_l>.
653		1138
…		…
668		1153
669	=back	1154	=back
670		1155
671	=cut	1156	=cut
672		1157
673	sub urxvt::term::line {	1158	sub line {
674	my ($self, $row) = @_;	1159	my ($self, $row) = @_;
675		1160
676	my $maxrow = $self->nrow - 1;	1161	my $maxrow = $self->nrow - 1;
677		1162
678	my ($beg, $end) = ($row, $row);	1163	my ($beg, $end) = ($row, $row);
…		…
682		1167
683	bless {	1168	bless {
684	term => $self,	1169	term => $self,
685	beg => $beg,	1170	beg => $beg,
686	end => $end,	1171	end => $end,
		1172	ncol => $self->ncol,
687	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1173	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
688	}, urxvt::line::	1174	}, urxvt::line::
689	}	1175	}
690		1176
691	sub urxvt::line::t {	1177	sub urxvt::line::t {
692	my ($self) = @_;	1178	my ($self) = @_;
693		1179
		1180	if (@_ > 1)
		1181	{
		1182	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1183	for $self->{beg} .. $self->{end};
		1184	}
		1185
		1186	defined wantarray &&
694	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1187	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
695	0, $self->{len}	1188	0, $self->{len}
696	}	1189	}
697		1190
698	sub urxvt::line::r {	1191	sub urxvt::line::r {
699	my ($self) = @_;	1192	my ($self) = @_;
700		1193
		1194	if (@_ > 1)
		1195	{
		1196	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1197	for $self->{beg} .. $self->{end};
		1198	}
		1199
		1200	if (defined wantarray) {
701	my $rend = [	1201	my $rend = [
702	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1202	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
703	];	1203	];
704	$#$rend = $self->{len} - 1;	1204	$#$rend = $self->{len} - 1;
705	$rend	1205	return $rend;
		1206	}
		1207
		1208	()
706	}	1209	}
707		1210
708	sub urxvt::line::beg { $_[0]{beg} }	1211	sub urxvt::line::beg { $_[0]{beg} }
709	sub urxvt::line::end { $_[0]{end} }	1212	sub urxvt::line::end { $_[0]{end} }
710	sub urxvt::line::l { $_[0]{len} }	1213	sub urxvt::line::l { $_[0]{len} }
711		1214
712	sub urxvt::line::offset_of {	1215	sub urxvt::line::offset_of {
713	my ($self, $row, $col) = @_;	1216	my ($self, $row, $col) = @_;
714		1217
715	($row - $self->{beg}) * $self->{term}->ncol + $col	1218	($row - $self->{beg}) * $self->{ncol} + $col
716	}	1219	}
717		1220
718	sub urxvt::line::coord_of {	1221	sub urxvt::line::coord_of {
719	my ($self, $offset) = @_;	1222	my ($self, $offset) = @_;
720		1223
721	use integer;	1224	use integer;
722		1225
723	(	1226	(
724	$offset / $self->{term}->ncol + $self->{beg},	1227	$offset / $self->{ncol} + $self->{beg},
725	$offset % $self->{term}->ncol	1228	$offset % $self->{ncol}
726	)	1229	)
727	}	1230	}
728		1231
729	=item ($row, $col) = $line->coord_of ($offset)
730	=item $text = $term->special_encode $string	1232	=item $text = $term->special_encode $string
731		1233
732	Converts a perl string into the special encoding used by rxvt-unicode,	1234	Converts a perl string into the special encoding used by rxvt-unicode,
733	where one character corresponds to one screen cell. See	1235	where one character corresponds to one screen cell. See
734	C<< $term->ROW_t >> for details.	1236	C<< $term->ROW_t >> for details.
…		…
736	=item $string = $term->special_decode $text	1238	=item $string = $term->special_decode $text
737		1239
738	Converts rxvt-unicodes text reprsentation into a perl string. See	1240	Converts rxvt-unicodes text reprsentation into a perl string. See
739	C<< $term->ROW_t >> for details.	1241	C<< $term->ROW_t >> for details.
740		1242
		1243	=item $success = $term->grab_button ($button, $modifiermask)
		1244
		1245	Registers a synchronous button grab. See the XGrabButton manpage.
		1246
		1247	=item $success = $term->grab ($eventtime[, $sync])
		1248
		1249	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1250	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1251
		1252	=item $term->allow_events_async
		1253
		1254	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1255
		1256	=item $term->allow_events_sync
		1257
		1258	Calls XAllowEvents with SyncBoth for the most recent grab.
		1259
		1260	=item $term->allow_events_replay
		1261
		1262	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1263	recent grab.
		1264
		1265	=item $term->ungrab
		1266
		1267	Calls XUngrab for the most recent grab. Is called automatically on
		1268	evaluation errors, as it is better to lose the grab in the error case as
		1269	the session.
		1270
741	=back	1271	=back
		1272
		1273	=cut
		1274
		1275	package urxvt::popup;
		1276
		1277	=head2 The C<urxvt::popup> Class
		1278
		1279	=over 4
		1280
		1281	=cut
		1282
		1283	sub add_item {
		1284	my ($self, $item) = @_;
		1285
		1286	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1287	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1288	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1289
		1290	$item->{render} \|\|= sub { $_[0]{text} };
		1291
		1292	push @{ $self->{item} }, $item;
		1293	}
		1294
		1295	sub add_separator {
		1296	my ($self, $sep) = @_;
		1297
		1298	$sep \|\|= "=";
		1299
		1300	$self->add_item ({
		1301	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1302	text => "",
		1303	render => sub { $sep x $self->{term}->ncol },
		1304	activate => sub { },
		1305	});
		1306	}
		1307
		1308	sub add_title {
		1309	my ($self, $title) = @_;
		1310
		1311	$self->add_item ({
		1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1313	text => $title,
		1314	activate => sub { },
		1315	});
		1316	}
		1317
		1318	sub add_button {
		1319	my ($self, $text, $cb) = @_;
		1320
		1321	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1322	}
		1323
		1324	sub add_toggle {
		1325	my ($self, $text, $cb, $value) = @_;
		1326
		1327	my $item; $item = {
		1328	type => "button",
		1329	text => " $text",
		1330	value => $value,
		1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
		1333	};
		1334
		1335	$self->add_item ($item);
		1336	}
		1337
		1338	sub show {
		1339	my ($self) = @_;
		1340
		1341	local $urxvt::popup::self = $self;
		1342
		1343	local $ENV{LC_ALL} = $self->{term}->locale;
		1344
		1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1346	"--transient-for" => $self->{term}->parent,
		1347	"-display" => $self->{term}->display_id,
		1348	"-pe" => "urxvt-popup")
		1349	or die "unable to create popup window\n";
		1350	}
		1351
		1352	sub DESTROY {
		1353	my ($self) = @_;
		1354
		1355	delete $self->{term}{_destroy}{$self};
		1356	$self->{term}->ungrab;
		1357	}
742		1358
743	=head2 The C<urxvt::timer> Class	1359	=head2 The C<urxvt::timer> Class
744		1360
745	This class implements timer watchers/events. Time is represented as a	1361	This class implements timer watchers/events. Time is represented as a
746	fractional number of seconds since the epoch. Example:	1362	fractional number of seconds since the epoch. Example:
…		…
799		1415
800	$term->{socket} = ...	1416	$term->{socket} = ...
801	$term->{iow} = urxvt::iow	1417	$term->{iow} = urxvt::iow
802	->new	1418	->new
803	->fd (fileno $term->{socket})	1419	->fd (fileno $term->{socket})
804	->events (1) # wait for read data	1420	->events (urxvt::EVENT_READ)
805	->start	1421	->start
806	->cb (sub {	1422	->cb (sub {
807	my ($iow, $revents) = @_;	1423	my ($iow, $revents) = @_;
808	# $revents must be 1 here, no need to check	1424	# $revents must be 1 here, no need to check
809	sysread $term->{socket}, my $buf, 8192	1425	sysread $term->{socket}, my $buf, 8192
…		…
826		1442
827	Set the filedescriptor (not handle) to watch.	1443	Set the filedescriptor (not handle) to watch.
828		1444
829	=item $iow = $iow->events ($eventmask)	1445	=item $iow = $iow->events ($eventmask)
830		1446
831	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1447	Set the event mask to watch. The only allowed values are
832	data, Bit #1 (value C<2>) enables watching for write data.	1448	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1449	together, or C<urxvt::EVENT_NONE>.
833		1450
834	=item $iow = $iow->start	1451	=item $iow = $iow->start
835		1452
836	Start watching for requested events on the given handle.	1453	Start watching for requested events on the given handle.
837		1454
…		…
848	This variable controls the verbosity level of the perl extension. Higher	1465	This variable controls the verbosity level of the perl extension. Higher
849	numbers indicate more verbose output.	1466	numbers indicate more verbose output.
850		1467
851	=over 4	1468	=over 4
852		1469
853	=item 0 - only fatal messages	1470	=item == 0 - fatal messages
854		1471
855	=item 3 - script loading and management	1472	=item >= 3 - script loading and management
856		1473
857	=item 10 - all events received	1474	=item >=10 - all events received
858		1475
859	=back	1476	=back
860		1477
861	=head1 AUTHOR	1478	=head1 AUTHOR
862		1479

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC vs. Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.25 by root, Tue Jan 3 21:08:39 2006 UTC vs.
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC