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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC vs.
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC vs. Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.27 by root, Tue Jan 3 23:41:37 2006 UTC vs.
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC