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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC vs.
Revision 1.78 by root, Wed Jan 11 01:01:52 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
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
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	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click). Right now, it tries to
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	select urls and complete shell-quoted arguments, which is very convenient,
47	if your F<ls> supports C<--quoting-style=shell>.	47	too, if your F<ls> supports C<--quoting-style=shell>.
48		48
49	It also offers the following bindable event:	49	It also offers the following bindable keyboard command:
50		50
51	=over 4	51	=over 4
52		52
53	=item rot13	53	=item rot13
54		54
…		…
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 (such as uri unescaping, perl
		70	evalution, web-browser starting etc.), depending on content.
		71
		72	=item searchable-scrollback<hotkey> (enabled by default)
		73
		74	Adds regex search functionality to the scrollback buffer, triggered
		75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		76	input/output is suspended.
		77
		78	C</> starts an incremental regex search, C<n> searches further, C<p> or
		79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
		80	history, C<enter> leaves search mode at the current position and C<escape>
		81	returns to the original position.
		82
61	=item digital-clock	83	=item digital-clock
62		84
63	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
		86
		87	=item mark-urls
		88
		89	Uses per-line display filtering (C<on_line_update>) to underline urls.
		90
		91	=item block-graphics-to-ascii
		92
		93	A not very useful example of filtering all text output to the terminal,
		94	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		95	similar-looking ascii character.
64		96
65	=item example-refresh-hooks	97	=item example-refresh-hooks
66		98
67	Displays a very simple digital clock in the upper right corner of the	99	Displays a very simple digital clock in the upper right corner of the
68	window. Illustrates overwriting the refresh callbacks to create your own	100	window. Illustrates overwriting the refresh callbacks to create your own
69	overlays or changes.	101	overlays or changes.
70		102
71	=item mark-urls
72
73	A not very useful example of filtering all text output to the terminal, by
74	underlining all urls that matches a certain regex (i.e. some urls :). It
75	is not very useful because urls that are output in multiple steps (e.g.
76	when typing them) do not get marked.
77
78	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
79		106
80	=head2 General API Considerations	107	=head2 General API Considerations
81		108
82	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
83	reference-to-hash objects. The hash can be used to store anything you	110	reference-to-hash objects. The hash can be used to store anything you
…		…
96	=over 4	123	=over 4
97		124
98	=item $text	125	=item $text
99		126
100	Rxvt-unicodes special way of encoding text, where one "unicode" character	127	Rxvt-unicodes special way of encoding text, where one "unicode" character
101	always represents one screen cell. See L<row_t> for a discussion of this format.	128	always represents one screen cell. See L<ROW_t> for a discussion of this format.
102		129
103	=item $string	130	=item $string
104		131
105	A perl text string, with an emphasis on I<text>. It can store all unicode	132	A perl text string, with an emphasis on I<text>. It can store all unicode
106	characters and is to be distinguished with text encoded in a specific	133	characters and is to be distinguished with text encoded in a specific
…		…
111	Either binary data or - more common - a text string encoded in a	138	Either binary data or - more common - a text string encoded in a
112	locale-specific way.	139	locale-specific way.
113		140
114	=back	141	=back
115		142
		143	=head2 Extension Objects
		144
		145	Very perl extension is a perl class. A separate perl object is created
		146	for each terminal and each extension and passed as the first parameter to
		147	hooks. So extensions can use their C<$self> object without having to think
		148	about other extensions, with the exception of methods and members that
		149	begin with an underscore character C<_>: these are reserved for internal
		150	use.
		151
		152	Although it isn't a C<urxvt::term> object, you can call all methods of the
		153	C<urxvt::term> class on this object.
		154
		155	It has the following methods and data members:
		156
		157	=over 4
		158
		159	=item $urxvt_term = $self->{term}
		160
		161	Returns the C<urxvt::term> object associated with this instance of the
		162	extension. This member I<must not> be changed in any way.
		163
		164	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		165
		166	Dynamically enable the given hooks (named without the C<on_> prefix) for
		167	this extension, replacing any previous hook. This is useful when you want
		168	to overwrite time-critical hooks only temporarily.
		169
		170	=item $self->disable ($hook_name[, $hook_name..])
		171
		172	Dynamically disable the given hooks.
		173
		174	=back
		175
116	=head2 Hooks	176	=head2 Hooks
117		177
118	The following subroutines can be declared in loaded scripts, and will be	178	The following subroutines can be declared in extension files, and will be
119	called whenever the relevant event happens.	179	called whenever the relevant event happens.
120		180
121	The first argument passed to them is an object private to each terminal	181	The first argument passed to them is an extension oject as described in
122	and extension package. You can call all C<urxvt::term> methods on it, but	182	the in the C<Extension Objects> section.
123	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
124	object that is shared between all packages is stored in the C<term>
125	member.
126		183
127	All of them must return a boolean value. If it is true, then the event	184	B<All> of these hooks must return a boolean value. If it is true, then the
128	counts as being I<consumed>, and the invocation of other hooks is skipped,	185	event counts as being I<consumed>, and the invocation of other hooks is
129	and the relevant action might not be carried out by the C++ code.	186	skipped, and the relevant action might not be carried out by the C++ code.
130		187
131	When in doubt, return a false value (preferably C<()>).	188	I<< When in doubt, return a false value (preferably C<()>). >>
132		189
133	=over 4	190	=over 4
134		191
135	=item on_init $term	192	=item on_init $term
136		193
137	Called after a new terminal object has been initialized, but before	194	Called after a new terminal object has been initialized, but before
138	windows are created or the command gets run.	195	windows are created or the command gets run. Most methods are unsafe to
		196	call or deliver senseless data, as terminal size and other characteristics
		197	have not yet been determined. You can safely query and change resources,
		198	though.
139		199
140	=item on_reset $term	200	=item on_reset $term
141		201
142	Called after the screen is "reset" for any reason, such as resizing or	202	Called after the screen is "reset" for any reason, such as resizing or
143	control sequences. Here is where you can react on changes to size-related	203	control sequences. Here is where you can react on changes to size-related
…		…
172	should extend the selection itelf and return true to suppress the built-in	232	should extend the selection itelf and return true to suppress the built-in
173	processing.	233	processing.
174		234
175	See the F<selection> example extension.	235	See the F<selection> example extension.
176		236
177	=item on_focus_in $term
178
179	Called whenever the window gets the keyboard focus, before urxvt does
180	focus in processing.
181
182	=item on_focus_out $term
183
184	Called wheneever the window loses keyboard focus, before urxvt does focus
185	out processing.
186
187	=item on_view_change $term, $offset	237	=item on_view_change $term, $offset
188		238
189	Called whenever the view offset changes, i..e the user or program	239	Called whenever the view offset changes, i..e the user or program
190	scrolls. Offset C<0> means display the normal terminal, positive values	240	scrolls. Offset C<0> means display the normal terminal, positive values
191	show this many lines of scrollback.	241	show this many lines of scrollback.
…		…
197	than the scroll back buffer or the terminal.	247	than the scroll back buffer or the terminal.
198		248
199	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	249	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
200	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	250	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
201	number of lines that will be in the scrollback buffer.	251	number of lines that will be in the scrollback buffer.
202
203	=item on_tty_activity $term NYI
204
205	Called whenever the program(s) running in the urxvt window send output.
206		252
207	=item on_osc_seq $term, $string	253	=item on_osc_seq $term, $string
208		254
209	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
210	operating system command) is processed. Cursor position and other state	256	operating system command) is processed. Cursor position and other state
…		…
223	can filter/change and output the text yourself by returning a true value	269	can filter/change and output the text yourself by returning a true value
224	and calling C<< $term->scr_add_lines >> yourself. Please note that this	270	and calling C<< $term->scr_add_lines >> yourself. Please note that this
225	might be very slow, however, as your hook is called for B<all> text being	271	might be very slow, however, as your hook is called for B<all> text being
226	output.	272	output.
227		273
		274	=item on_tt_write $term, $octets
		275
		276	Called whenever some data is written to the tty/pty and can be used to
		277	suppress or filter tty input.
		278
		279	=item on_line_update $term, $row
		280
		281	Called whenever a line was updated or changed. Can be used to filter
		282	screen output (e.g. underline urls or other useless stuff). Only lines
		283	that are being shown will be filtered, and, due to performance reasons,
		284	not always immediately.
		285
		286	The row number is always the topmost row of the line if the line spans
		287	multiple rows.
		288
		289	Please note that, if you change the line, then the hook might get called
		290	later with the already-modified line (e.g. if unrelated parts change), so
		291	you cannot just toggle rendition bits, but only set them.
		292
228	=item on_refresh_begin $term	293	=item on_refresh_begin $term
229		294
230	Called just before the screen gets redrawn. Can be used for overlay	295	Called just before the screen gets redrawn. Can be used for overlay
231	or similar effects by modify terminal contents in refresh_begin, and	296	or similar effects by modify terminal contents in refresh_begin, and
232	restoring them in refresh_end. The built-in overlay and selection display	297	restoring them in refresh_end. The built-in overlay and selection display
…		…
240		305
241	Called whenever the user presses a key combination that has a	306	Called whenever the user presses a key combination that has a
242	C<perl:string> action bound to it (see description of the B<keysym>	307	C<perl:string> action bound to it (see description of the B<keysym>
243	resource in the @@RXVT_NAME@@(1) manpage).	308	resource in the @@RXVT_NAME@@(1) manpage).
244		309
		310	=item on_focus_in $term
		311
		312	Called whenever the window gets the keyboard focus, before rxvt-unicode
		313	does focus in processing.
		314
		315	=item on_focus_out $term
		316
		317	Called wheneever the window loses keyboard focus, before rxvt-unicode does
		318	focus out processing.
		319
		320	=item on_key_press $term, $event, $keysym, $octets
		321
		322	=item on_key_release $term, $event, $keysym
		323
		324	=item on_button_press $term, $event
		325
		326	=item on_button_release $term, $event
		327
		328	=item on_motion_notify $term, $event
		329
		330	=item on_map_notify $term, $event
		331
		332	=item on_unmap_notify $term, $event
		333
		334	Called whenever the corresponding X event is received for the terminal If
		335	the hook returns true, then the even will be ignored by rxvt-unicode.
		336
		337	The event is a hash with most values as named by Xlib (see the XEvent
		338	manpage), with the additional members C<row> and C<col>, which are the row
		339	and column under the mouse cursor.
		340
		341	C<on_key_press> additionally receives the string rxvt-unicode would
		342	output, if any, in locale-specific encoding.
		343
		344	subwindow.
		345
245	=back	346	=back
246		347
		348	=cut
		349
		350	package urxvt;
		351
		352	use utf8;
		353	use strict;
		354	use Carp ();
		355	use Scalar::Util ();
		356	use List::Util ();
		357
		358	our $VERSION = 1;
		359	our $TERM;
		360	our @HOOKNAME;
		361	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		362	our %OPTION;
		363
		364	our $LIBDIR;
		365	our $RESNAME;
		366	our $RESCLASS;
		367	our $RXVTNAME;
		368
247	=head2 Variables in the C<urxvt> Package	369	=head2 Variables in the C<urxvt> Package
248		370
249	=over 4	371	=over 4
250		372
		373	=item $urxvt::LIBDIR
		374
		375	The rxvt-unicode library directory, where, among other things, the perl
		376	modules and scripts are stored.
		377
		378	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		379
		380	The resource class and name rxvt-unicode uses to look up X resources.
		381
		382	=item $urxvt::RXVTNAME
		383
		384	The basename of the installed binaries, usually C<urxvt>.
		385
251	=item $urxvt::TERM	386	=item $urxvt::TERM
252		387
253	The current terminal. Whenever a callback/Hook is bein executed, this	388	The current terminal. This variable stores the current C<urxvt::term>
254	variable stores the current C<urxvt::term> object.	389	object, whenever a callback/hook is executing.
255		390
256	=back	391	=back
257		392
258	=head2 Functions in the C<urxvt> Package	393	=head2 Functions in the C<urxvt> Package
259		394
…		…
272	that calls this function.	407	that calls this function.
273		408
274	Using this function has the advantage that its output ends up in the	409	Using this function has the advantage that its output ends up in the
275	correct place, e.g. on stderr of the connecting urxvtc client.	410	correct place, e.g. on stderr of the connecting urxvtc client.
276		411
		412	Messages have a size limit of 1023 bytes currently.
		413
		414	=item $is_safe = urxvt::safe
		415
		416	Returns true when it is safe to do potentially unsafe things, such as
		417	evaluating perl code specified by the user. This is true when urxvt was
		418	started setuid or setgid.
		419
277	=item $time = urxvt::NOW	420	=item $time = urxvt::NOW
278		421
279	Returns the "current time" (as per the event loop).	422	Returns the "current time" (as per the event loop).
		423
		424	=item urxvt::CurrentTime
		425
		426	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		427	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		428	Button4Mask, Button5Mask, AnyModifier
		429
		430	Various constants for use in X calls and event processing.
280		431
281	=back	432	=back
282		433
283	=head2 RENDITION	434	=head2 RENDITION
284		435
…		…
311		462
312	=item $background = urxvt::GET_BASEBG $rend	463	=item $background = urxvt::GET_BASEBG $rend
313		464
314	Return the foreground/background colour index, respectively.	465	Return the foreground/background colour index, respectively.
315		466
316	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	467	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
317		468
318	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	469	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
319		470
320	Replace the foreground/background colour in the rendition mask with the	471	Replace the foreground/background colour in the rendition mask with the
321	specified one.	472	specified one.
322		473
323	=item $value = urxvt::GET_CUSTOM ($rend)	474	=item $value = urxvt::GET_CUSTOM $rend
324		475
325	Return the "custom" value: Every rendition has 5 bits for use by	476	Return the "custom" value: Every rendition has 5 bits for use by
326	extensions. They can be set and changed as you like and are initially	477	extensions. They can be set and changed as you like and are initially
327	zero.	478	zero.
328		479
329	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	480	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
330		481
331	Change the custom value.	482	Change the custom value.
332		483
333	=back	484	=back
334		485
335	=cut	486	=cut
336
337	package urxvt;
338
339	use strict;
340	use Scalar::Util ();
341
342	our $TERM;
343	our @HOOKNAME;
344	our $LIBDIR;
345		487
346	BEGIN {	488	BEGIN {
347	urxvt->bootstrap;	489	urxvt->bootstrap;
348		490
349	# overwrite perl's warn	491	# overwrite perl's warn
…		…
351	my $msg = join "", @_;	493	my $msg = join "", @_;
352	$msg .= "\n"	494	$msg .= "\n"
353	unless $msg =~ /\n$/;	495	unless $msg =~ /\n$/;
354	urxvt::warn ($msg);	496	urxvt::warn ($msg);
355	};	497	};
		498
		499	delete $ENV{IFS};
		500	delete $ENV{CDPATH};
		501	delete $ENV{BASH_ENV};
		502	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
356	}	503	}
357		504
358	my @hook_count;	505	my @hook_count;
359	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	506	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
360		507
361	sub verbose {	508	sub verbose {
362	my ($level, $msg) = @_;	509	my ($level, $msg) = @_;
363	warn "$msg\n" if $level <= $verbosity;	510	warn "$msg\n" if $level <= $verbosity;
364	}	511	}
365		512
366	# find on_xxx subs in the package and register them	513	my $extension_pkg = "extension0000";
367	# as hooks	514	my %extension_pkg;
368	sub register_package($) {
369	my ($pkg) = @_;
370
371	for my $htype (0.. $#HOOKNAME) {
372	my $name = $HOOKNAME[$htype];
373
374	my $ref = $pkg->can ("on_" . lc $name)
375	or next;
376
377	$TERM->{_hook}[$htype]{$pkg} = $ref;
378	$hook_count[$htype]++
379	or set_should_invoke $htype, 1;
380	}
381	}
382
383	my $script_pkg = "script0000";
384	my %script_pkg;
385		515
386	# load a single script into its own package, once only	516	# load a single script into its own package, once only
387	sub script_package($) {	517	sub extension_package($) {
388	my ($path) = @_;	518	my ($path) = @_;
389		519
390	$script_pkg{$path} \|\|= do {	520	$extension_pkg{$path} \|\|= do {
391	my $pkg = "urxvt::" . ($script_pkg++);	521	my $pkg = "urxvt::" . ($extension_pkg++);
392		522
393	verbose 3, "loading script '$path' into package '$pkg'";	523	verbose 3, "loading extension '$path' into package '$pkg'";
394		524
395	open my $fh, "<:raw", $path	525	open my $fh, "<:raw", $path
396	or die "$path: $!";	526	or die "$path: $!";
397		527
		528	my $source = untaint
398	my $source = "package $pkg; use strict; use utf8;\n"	529	"package $pkg; use strict; use utf8;\n"
		530	. "use base urxvt::term::extension::;\n"
399	. "#line 1 \"$path\"\n{\n"	531	. "#line 1 \"$path\"\n{\n"
400	. (do { local $/; <$fh> })	532	. (do { local $/; <$fh> })
401	. "\n};\n1";	533	. "\n};\n1";
402		534
		535	eval $source
403	eval $source or die "$path: $@";	536	or die "$path: $@";
404		537
405	$pkg	538	$pkg
406	}	539	}
407	}	540	}
408		541
…		…
413	local $TERM = shift;	546	local $TERM = shift;
414	my $htype = shift;	547	my $htype = shift;
415		548
416	if ($htype == 0) { # INIT	549	if ($htype == 0) { # INIT
417	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	550	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		551
		552	my %ext_arg;
418		553
419	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	554	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		555	if ($_ eq "default") {
		556	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		557	} elsif (/^-(.*)$/) {
		558	delete $ext_arg{$1};
		559	} elsif (/^([^<]+)<(.*)>$/) {
		560	push @{ $ext_arg{$1} }, $2;
		561	} else {
		562	$ext_arg{$_} \|\|= [];
		563	}
		564	}
		565
		566	while (my ($ext, $argv) = each %ext_arg) {
420	my @files = grep -f $_, map "$_/$ext", @dirs;	567	my @files = grep -f $_, map "$_/$ext", @dirs;
421		568
422	if (@files) {	569	if (@files) {
423	register_package script_package $files[0];	570	$TERM->register_package (extension_package $files[0], $argv);
424	} else {	571	} else {
425	warn "perl extension '$ext' not found in perl library search path\n";	572	warn "perl extension '$ext' not found in perl library search path\n";
426	}	573	}
427	}	574	}
		575
		576	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		577	warn $@ if $@;
428	}	578	}
429		579
430	$retval = undef;	580	$retval = undef;
431		581
432	if (my $cb = $TERM->{_hook}[$htype]) {	582	if (my $cb = $TERM->{_hook}[$htype]) {
…		…
434	if $verbosity >= 10;	584	if $verbosity >= 10;
435		585
436	keys %$cb;	586	keys %$cb;
437		587
438	while (my ($pkg, $cb) = each %$cb) {	588	while (my ($pkg, $cb) = each %$cb) {
439	$retval = $cb->(	589	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
440	$TERM->{_pkg}{$pkg} \|\|= do {
441	my $proxy = bless { }, urxvt::term::proxy::;
442	Scalar::Util::weaken ($proxy->{term} = $TERM);
443	$proxy
444	},
445	@_,
446	) and last;	590	and last;
		591
		592	if ($@) {
		593	$TERM->ungrab; # better to lose the grab than the session
		594	warn $@;
		595	}
447	}	596	}
448	}	597	}
449		598
450	if ($htype == 1) { # DESTROY	599	if ($htype == 1) { # DESTROY
451	# remove hooks if unused
452	if (my $hook = $TERM->{_hook}) {	600	if (my $hook = delete $TERM->{_hook}) {
453	for my $htype (0..$#$hook) {	601	for my $htype (0..$#$hook) {
454	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	602	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
455	or set_should_invoke $htype, 0;	603	or set_should_invoke $htype, 0;
456	}	604	}
457	}	605	}
…		…
464	}	612	}
465		613
466	$retval	614	$retval
467	}	615	}
468		616
469	sub urxvt::term::proxy::AUTOLOAD {	617	# urxvt::term::extension
470	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	618
		619	package urxvt::term::extension;
		620
		621	sub enable {
		622	my ($self, %hook) = @_;
		623	my $pkg = $self->{_pkg};
		624
		625	while (my ($name, $cb) = each %hook) {
		626	my $htype = $HOOKTYPE{uc $name};
		627	defined $htype
		628	or Carp::croak "unsupported hook type '$name'";
		629
		630	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
		631	$hook_count[$htype]++
		632	or urxvt::set_should_invoke $htype, 1;
		633	}
		634
		635	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		636	}
		637	}
		638
		639	sub disable {
		640	my ($self, @hook) = @_;
		641	my $pkg = $self->{_pkg};
		642
		643	for my $name (@hook) {
		644	my $htype = $HOOKTYPE{uc $name};
		645	defined $htype
		646	or Carp::croak "unsupported hook type '$name'";
		647
		648	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		649	--$hook_count[$htype]
		650	or urxvt::set_should_invoke $htype, 0;
		651	}
		652	}
		653	}
		654
		655	our $AUTOLOAD;
		656
		657	sub AUTOLOAD {
		658	$AUTOLOAD =~ /:([^:]+)$/
471	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	659	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
472		660
473	eval qq{	661	eval qq{
474	sub $urxvt::term::proxy::AUTOLOAD {	662	sub $AUTOLOAD {
475	my \$proxy = shift;	663	my \$proxy = shift;
476	\$proxy->{term}->$1 (\@_)	664	\$proxy->{term}->$1 (\@_)
477	}	665	}
478	1	666	1
479	} or die "FATAL: unable to compile method forwarder: $@";	667	} or die "FATAL: unable to compile method forwarder: $@";
480		668
481	goto &$urxvt::term::proxy::AUTOLOAD;	669	goto &$AUTOLOAD;
482	}	670	}
		671
		672	sub DESTROY {
		673	# nop
		674	}
		675
		676	# urxvt::destroy_hook
		677
		678	sub urxvt::destroy_hook::DESTROY {
		679	${$_[0]}->();
		680	}
		681
		682	sub urxvt::destroy_hook(&) {
		683	bless \shift, urxvt::destroy_hook::
		684	}
		685
		686	package urxvt::anyevent;
		687
		688	=head2 The C<urxvt::anyevent> Class
		689
		690	The sole purpose of this class is to deliver an interface to the
		691	C<AnyEvent> module - any module using it will work inside urxvt without
		692	further programming. The only exception is that you cannot wait on
		693	condition variables, but non-blocking condvar use is ok. What this means
		694	is that you cannot use blocking APIs, but the non-blocking variant should
		695	work.
		696
		697	=cut
		698
		699	our $VERSION = 1;
		700
		701	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		702	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		703
		704	sub timer {
		705	my ($class, %arg) = @_;
		706
		707	my $cb = $arg{cb};
		708
		709	urxvt::timer
		710	->new
		711	->start (urxvt::NOW + $arg{after})
		712	->cb (sub {
		713	$_[0]->stop; # need to cancel manually
		714	$cb->();
		715	})
		716	}
		717
		718	sub io {
		719	my ($class, %arg) = @_;
		720
		721	my $cb = $arg{cb};
		722
		723	bless [$arg{fh}, urxvt::iow
		724	->new
		725	->fd (fileno $arg{fh})
		726	->events (($arg{poll} =~ /r/ ? 1 : 0)
		727	\| ($arg{poll} =~ /w/ ? 2 : 0))
		728	->start
		729	->cb (sub {
		730	$cb->(($_[1] & 1 ? 'r' : '')
		731	. ($_[1] & 2 ? 'w' : ''));
		732	})],
		733	urxvt::anyevent::
		734	}
		735
		736	sub DESTROY {
		737	$_[0][1]->stop;
		738	}
		739
		740	sub condvar {
		741	bless \my $flag, urxvt::anyevent::condvar::
		742	}
		743
		744	sub urxvt::anyevent::condvar::broadcast {
		745	${$_[0]}++;
		746	}
		747
		748	sub urxvt::anyevent::condvar::wait {
		749	unless (${$_[0]}) {
		750	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		751	}
		752	}
		753
		754	package urxvt::term;
483		755
484	=head2 The C<urxvt::term> Class	756	=head2 The C<urxvt::term> Class
485		757
486	=over 4	758	=over 4
		759
		760	=cut
		761
		762	# find on_xxx subs in the package and register them
		763	# as hooks
		764	sub register_package {
		765	my ($self, $pkg, $argv) = @_;
		766
		767	my $proxy = bless {
		768	_pkg => $pkg,
		769	argv => $argv,
		770	}, $pkg;
		771	Scalar::Util::weaken ($proxy->{term} = $self);
		772
		773	$self->{_pkg}{$pkg} = $proxy;
		774
		775	for my $name (@HOOKNAME) {
		776	if (my $ref = $pkg->can ("on_" . lc $name)) {
		777	$proxy->enable ($name => $ref);
		778	}
		779	}
		780	}
		781
		782	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		783
		784	Creates a new terminal, very similar as if you had started it with system
		785	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		786	hash which defines the environment of the new terminal.
		787
		788	Croaks (and probably outputs an error message) if the new instance
		789	couldn't be created. Returns C<undef> if the new instance didn't
		790	initialise perl, and the terminal object otherwise. The C<init> and
		791	C<start> hooks will be called during this call.
		792
		793	=cut
		794
		795	sub new {
		796	my ($class, $env, @args) = @_;
		797
		798	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		799	}
		800
		801	=item $term->destroy
		802
		803	Destroy the terminal object (close the window, free resources
		804	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		805	watchers (timers, io watchers) are still active.
		806
		807	=item $isset = $term->option ($optval[, $set])
		808
		809	Returns true if the option specified by C<$optval> is enabled, and
		810	optionally change it. All option values are stored by name in the hash
		811	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		812
		813	Here is a a likely non-exhaustive list of option names, please see the
		814	source file F</src/optinc.h> to see the actual list:
		815
		816	borderLess console cursorBlink cursorUnderline hold iconic insecure
		817	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		818	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		819	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		820	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		821	tripleclickwords utmpInhibit visualBell
487		822
488	=item $value = $term->resource ($name[, $newval])	823	=item $value = $term->resource ($name[, $newval])
489		824
490	Returns the current resource value associated with a given name and	825	Returns the current resource value associated with a given name and
491	optionally sets a new value. Setting values is most useful in the C<init>	826	optionally sets a new value. Setting values is most useful in the C<init>
…		…
501		836
502	Please note that resource strings will currently only be freed when the	837	Please note that resource strings will currently only be freed when the
503	terminal is destroyed, so changing options frequently will eat memory.	838	terminal is destroyed, so changing options frequently will eat memory.
504		839
505	Here is a a likely non-exhaustive list of resource names, not all of which	840	Here is a a likely non-exhaustive list of resource names, not all of which
506	are supported in every build, please see the source to see the actual	841	are supported in every build, please see the source file F</src/rsinc.h>
507	list:	842	to see the actual list:
508		843
509	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	844	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
510	borderLess color cursorBlink cursorUnderline cutchars delete_key	845	borderLess color cursorBlink cursorUnderline cutchars delete_key
511	display_name embed ext_bwidth fade font geometry hold iconName	846	display_name embed ext_bwidth fade font geometry hold iconName
512	imFont imLocale inputMethod insecure int_bwidth intensityStyles	847	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
519	shade term_name title transparent transparent_all tripleclickwords	854	shade term_name title transparent transparent_all tripleclickwords
520	utmpInhibit visualBell	855	utmpInhibit visualBell
521		856
522	=cut	857	=cut
523		858
524	sub urxvt::term::resource($$;$) {	859	sub resource($$;$) {
525	my ($self, $name) = (shift, shift);	860	my ($self, $name) = (shift, shift);
526	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	861	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
527	goto &urxvt::term::_resource;	862	&urxvt::term::_resource
528	}	863	}
		864
		865	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		866
		867	Adds a keymap translation exactly as specified via a resource. See the
		868	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
529		869
530	=item $rend = $term->rstyle ([$new_rstyle])	870	=item $rend = $term->rstyle ([$new_rstyle])
531		871
532	Return and optionally change the current rendition. Text that is output by	872	Return and optionally change the current rendition. Text that is output by
533	the terminal application will use this style.	873	the terminal application will use this style.
…		…
553		893
554	=item $oldtext = $term->selection ([$newtext])	894	=item $oldtext = $term->selection ([$newtext])
555		895
556	Return the current selection text and optionally replace it by C<$newtext>.	896	Return the current selection text and optionally replace it by C<$newtext>.
557		897
558	#=item $term->overlay ($x, $y, $text)	898	=item $term->overlay_simple ($x, $y, $text)
559	#	899
560	#Create a simple multi-line overlay box. See the next method for details.	900	Create a simple multi-line overlay box. See the next method for details.
561	#	901
562	#=cut	902	=cut
563	#	903
564	#sub urxvt::term::scr_overlay {	904	sub overlay_simple {
565	# my ($self, $x, $y, $text) = @_;	905	my ($self, $x, $y, $text) = @_;
566	#	906
567	# my @lines = split /\n/, $text;	907	my @lines = split /\n/, $text;
568	#	908
569	# my $w = 0;	909	my $w = List::Util::max map $self->strwidth ($_), @lines;
570	# for (map $self->strwidth ($_), @lines) {	910
571	# $w = $_ if $w < $_;
572	# }
573	#
574	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	911	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
575	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	912	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
576	#}	913
		914	$overlay
		915	}
577		916
578	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	917	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
579		918
580	Create a new (empty) overlay at the given position with the given	919	Create a new (empty) overlay at the given position with the given
581	width/height. C<$rstyle> defines the initial rendition style	920	width/height. C<$rstyle> defines the initial rendition style
…		…
608		947
609	If hidden, display the overlay again.	948	If hidden, display the overlay again.
610		949
611	=back	950	=back
612		951
		952	=item $popup = $term->popup ($event)
		953
		954	Creates a new C<urxvt::popup> object that implements a popup menu. The
		955	C<$event> I<must> be the event causing the menu to pop up (a button event,
		956	currently).
		957
		958	=cut
		959
		960	sub popup {
		961	my ($self, $event) = @_;
		962
		963	$self->grab ($event->{time}, 1)
		964	or return;
		965
		966	my $popup = bless {
		967	term => $self,
		968	event => $event,
		969	}, urxvt::popup::;
		970
		971	Scalar::Util::weaken $popup->{term};
		972
		973	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		974	Scalar::Util::weaken $self->{_destroy}{$popup};
		975
		976	$popup
		977	}
		978
613	=item $cellwidth = $term->strwidth $string	979	=item $cellwidth = $term->strwidth ($string)
614		980
615	Returns the number of screen-cells this string would need. Correctly	981	Returns the number of screen-cells this string would need. Correctly
616	accounts for wide and combining characters.	982	accounts for wide and combining characters.
617		983
618	=item $octets = $term->locale_encode $string	984	=item $octets = $term->locale_encode ($string)
619		985
620	Convert the given text string into the corresponding locale encoding.	986	Convert the given text string into the corresponding locale encoding.
621		987
622	=item $string = $term->locale_decode $octets	988	=item $string = $term->locale_decode ($octets)
623		989
624	Convert the given locale-encoded octets into a perl string.	990	Convert the given locale-encoded octets into a perl string.
		991
		992	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		993
		994	XORs the rendition values in the given span with the provided value
		995	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		996	to the selection.
		997
		998	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		999
		1000	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1001	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1002	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1003	it instead.
		1004
		1005	=item $term->scr_bell
		1006
		1007	Ring the bell!
625		1008
626	=item $term->scr_add_lines ($string)	1009	=item $term->scr_add_lines ($string)
627		1010
628	Write the given text string to the screen, as if output by the application	1011	Write the given text string to the screen, as if output by the application
629	running inside the terminal. It may not contain command sequences (escape	1012	running inside the terminal. It may not contain command sequences (escape
…		…
632		1015
633	Normally its not a good idea to use this function, as programs might be	1016	Normally its not a good idea to use this function, as programs might be
634	confused by changes in cursor position or scrolling. Its useful inside a	1017	confused by changes in cursor position or scrolling. Its useful inside a
635	C<on_add_lines> hook, though.	1018	C<on_add_lines> hook, though.
636		1019
		1020	=item $term->cmd_parse ($octets)
		1021
		1022	Similar to C<scr_add_lines>, but the argument must be in the
		1023	locale-specific encoding of the terminal and can contain command sequences
		1024	(escape codes) that will be interpreted.
		1025
637	=item $term->tt_write ($octets)	1026	=item $term->tt_write ($octets)
638		1027
639	Write the octets given in C<$data> to the tty (i.e. as program input). To	1028	Write the octets given in C<$data> to the tty (i.e. as program input). To
640	pass characters instead of octets, you should convert your strings first	1029	pass characters instead of octets, you should convert your strings first
641	to the locale-specific encoding using C<< $term->locale_encode >>.	1030	to the locale-specific encoding using C<< $term->locale_encode >>.
642		1031
		1032	=item $old_events = $term->pty_ev_events ([$new_events])
		1033
		1034	Replaces the event mask of the pty watcher by the given event mask. Can
		1035	be used to suppress input and output handling to the pty/tty. See the
		1036	description of C<< urxvt::timer->events >>. Make sure to always restore
		1037	the previous value.
		1038
		1039	=item $windowid = $term->parent
		1040
		1041	Return the window id of the toplevel window.
		1042
		1043	=item $windowid = $term->vt
		1044
		1045	Return the window id of the terminal window.
		1046
643	=item $window_width = $term->width	1047	=item $window_width = $term->width
644		1048
645	=item $window_height = $term->height	1049	=item $window_height = $term->height
646		1050
647	=item $font_width = $term->fwidth	1051	=item $font_width = $term->fwidth
…		…
663	=item $nrow_plus_saveLines = $term->total_rows	1067	=item $nrow_plus_saveLines = $term->total_rows
664		1068
665	=item $lines_in_scrollback = $term->nsaved	1069	=item $lines_in_scrollback = $term->nsaved
666		1070
667	Return various integers describing terminal characteristics.	1071	Return various integers describing terminal characteristics.
		1072
		1073	=item $x_display = $term->display_id
		1074
		1075	Return the DISPLAY used by rxvt-unicode.
		1076
		1077	=item $lc_ctype = $term->locale
		1078
		1079	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1080
		1081	=item $env = $term->env
		1082
		1083	Returns a copy of the environment in effect for the terminal as a hashref
		1084	similar to C<\%ENV>.
		1085
		1086	=cut
		1087
		1088	sub env {
		1089	if (my $env = $_[0]->_env) {
		1090	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1091	} else {
		1092	+{ %ENV }
		1093	}
		1094	}
		1095
		1096	=item $modifiermask = $term->ModLevel3Mask
		1097
		1098	=item $modifiermask = $term->ModMetaMask
		1099
		1100	=item $modifiermask = $term->ModNumLockMask
		1101
		1102	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1103	AltGr), the meta key (often Alt) and the num lock key, if applicable.
668		1104
669	=item $view_start = $term->view_start ([$newvalue])	1105	=item $view_start = $term->view_start ([$newvalue])
670		1106
671	Returns the negative row number of the topmost line. Minimum value is	1107	Returns the negative row number of the topmost line. Minimum value is
672	C<0>, which displays the normal terminal contents. Larger values scroll	1108	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
735	about the logical line that row C<$row_number> is part of. It supports the	1171	about the logical line that row C<$row_number> is part of. It supports the
736	following methods:	1172	following methods:
737		1173
738	=over 4	1174	=over 4
739		1175
740	=item $text = $line->t	1176	=item $text = $line->t ([$new_text])
741		1177
742	Returns the full text of the line, similar to C<ROW_t>	1178	Returns or replaces the full text of the line, similar to C<ROW_t>
743		1179
744	=item $rend = $line->r	1180	=item $rend = $line->r ([$new_rend])
745		1181
746	Returns the full rendition array of the line, similar to C<ROW_r>	1182	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
747		1183
748	=item $length = $line->l	1184	=item $length = $line->l
749		1185
750	Returns the length of the line in cells, similar to C<ROW_l>.	1186	Returns the length of the line in cells, similar to C<ROW_l>.
751		1187
…		…
766		1202
767	=back	1203	=back
768		1204
769	=cut	1205	=cut
770		1206
771	sub urxvt::term::line {	1207	sub line {
772	my ($self, $row) = @_;	1208	my ($self, $row) = @_;
773		1209
774	my $maxrow = $self->nrow - 1;	1210	my $maxrow = $self->nrow - 1;
775		1211
776	my ($beg, $end) = ($row, $row);	1212	my ($beg, $end) = ($row, $row);
…		…
780		1216
781	bless {	1217	bless {
782	term => $self,	1218	term => $self,
783	beg => $beg,	1219	beg => $beg,
784	end => $end,	1220	end => $end,
		1221	ncol => $self->ncol,
785	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1222	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
786	}, urxvt::line::	1223	}, urxvt::line::
787	}	1224	}
788		1225
789	sub urxvt::line::t {	1226	sub urxvt::line::t {
790	my ($self) = @_;	1227	my ($self) = @_;
791		1228
		1229	if (@_ > 1)
		1230	{
		1231	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1232	for $self->{beg} .. $self->{end};
		1233	}
		1234
		1235	defined wantarray &&
792	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1236	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
793	0, $self->{len}	1237	0, $self->{len}
794	}	1238	}
795		1239
796	sub urxvt::line::r {	1240	sub urxvt::line::r {
797	my ($self) = @_;	1241	my ($self) = @_;
798		1242
		1243	if (@_ > 1)
		1244	{
		1245	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1246	for $self->{beg} .. $self->{end};
		1247	}
		1248
		1249	if (defined wantarray) {
799	my $rend = [	1250	my $rend = [
800	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1251	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
801	];	1252	];
802	$#$rend = $self->{len} - 1;	1253	$#$rend = $self->{len} - 1;
803	$rend	1254	return $rend;
		1255	}
		1256
		1257	()
804	}	1258	}
805		1259
806	sub urxvt::line::beg { $_[0]{beg} }	1260	sub urxvt::line::beg { $_[0]{beg} }
807	sub urxvt::line::end { $_[0]{end} }	1261	sub urxvt::line::end { $_[0]{end} }
808	sub urxvt::line::l { $_[0]{len} }	1262	sub urxvt::line::l { $_[0]{len} }
809		1263
810	sub urxvt::line::offset_of {	1264	sub urxvt::line::offset_of {
811	my ($self, $row, $col) = @_;	1265	my ($self, $row, $col) = @_;
812		1266
813	($row - $self->{beg}) * $self->{term}->ncol + $col	1267	($row - $self->{beg}) * $self->{ncol} + $col
814	}	1268	}
815		1269
816	sub urxvt::line::coord_of {	1270	sub urxvt::line::coord_of {
817	my ($self, $offset) = @_;	1271	my ($self, $offset) = @_;
818		1272
819	use integer;	1273	use integer;
820		1274
821	(	1275	(
822	$offset / $self->{term}->ncol + $self->{beg},	1276	$offset / $self->{ncol} + $self->{beg},
823	$offset % $self->{term}->ncol	1277	$offset % $self->{ncol}
824	)	1278	)
825	}	1279	}
826		1280
827	=item ($row, $col) = $line->coord_of ($offset)
828	=item $text = $term->special_encode $string	1281	=item $text = $term->special_encode $string
829		1282
830	Converts a perl string into the special encoding used by rxvt-unicode,	1283	Converts a perl string into the special encoding used by rxvt-unicode,
831	where one character corresponds to one screen cell. See	1284	where one character corresponds to one screen cell. See
832	C<< $term->ROW_t >> for details.	1285	C<< $term->ROW_t >> for details.
833		1286
834	=item $string = $term->special_decode $text	1287	=item $string = $term->special_decode $text
835		1288
836	Converts rxvt-unicodes text reprsentation into a perl string. See	1289	Converts rxvt-unicodes text reprsentation into a perl string. See
837	C<< $term->ROW_t >> for details.	1290	C<< $term->ROW_t >> for details.
		1291
		1292	=item $success = $term->grab_button ($button, $modifiermask)
		1293
		1294	Registers a synchronous button grab. See the XGrabButton manpage.
		1295
		1296	=item $success = $term->grab ($eventtime[, $sync])
		1297
		1298	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1299	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1300
		1301	=item $term->allow_events_async
		1302
		1303	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1304
		1305	=item $term->allow_events_sync
		1306
		1307	Calls XAllowEvents with SyncBoth for the most recent grab.
		1308
		1309	=item $term->allow_events_replay
		1310
		1311	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1312	recent grab.
		1313
		1314	=item $term->ungrab
		1315
		1316	Calls XUngrab for the most recent grab. Is called automatically on
		1317	evaluation errors, as it is better to lose the grab in the error case as
		1318	the session.
		1319
		1320	=back
		1321
		1322	=cut
		1323
		1324	package urxvt::popup;
		1325
		1326	=head2 The C<urxvt::popup> Class
		1327
		1328	=over 4
		1329
		1330	=cut
		1331
		1332	sub add_item {
		1333	my ($self, $item) = @_;
		1334
		1335	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1336	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1337	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1338
		1339	$item->{render} \|\|= sub { $_[0]{text} };
		1340
		1341	push @{ $self->{item} }, $item;
		1342	}
		1343
		1344	=item $popup->add_title ($title)
		1345
		1346	Adds a non-clickable title to the popup.
		1347
		1348	=cut
		1349
		1350	sub add_title {
		1351	my ($self, $title) = @_;
		1352
		1353	$self->add_item ({
		1354	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1355	text => $title,
		1356	activate => sub { },
		1357	});
		1358	}
		1359
		1360	=item $popup->add_separator ([$sepchr])
		1361
		1362	Creates a separator, optionally using the character given as C<$sepchr>.
		1363
		1364	=cut
		1365
		1366	sub add_separator {
		1367	my ($self, $sep) = @_;
		1368
		1369	$sep \|\|= "=";
		1370
		1371	$self->add_item ({
		1372	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1373	text => "",
		1374	render => sub { $sep x $self->{term}->ncol },
		1375	activate => sub { },
		1376	});
		1377	}
		1378
		1379	=item $popup->add_button ($text, $cb)
		1380
		1381	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1382	selected.
		1383
		1384	=cut
		1385
		1386	sub add_button {
		1387	my ($self, $text, $cb) = @_;
		1388
		1389	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1390	}
		1391
		1392	=item $popup->add_toggle ($text, $cb, $initial_value)
		1393
		1394	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1395	whenever it gets toggled, with a boolean indicating its value as its first
		1396	argument.
		1397
		1398	=cut
		1399
		1400	sub add_toggle {
		1401	my ($self, $text, $cb, $value) = @_;
		1402
		1403	my $item; $item = {
		1404	type => "button",
		1405	text => " $text",
		1406	value => $value,
		1407	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1408	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1409	};
		1410
		1411	$self->add_item ($item);
		1412	}
		1413
		1414	=item $popup->show
		1415
		1416	Displays the popup (which is initially hidden).
		1417
		1418	=cut
		1419
		1420	sub show {
		1421	my ($self) = @_;
		1422
		1423	local $urxvt::popup::self = $self;
		1424
		1425	my $env = $self->{term}->env;
		1426	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1427	delete $env->{LC_ALL};
		1428	$env->{LC_CTYPE} = $self->{term}->locale;
		1429
		1430	urxvt::term->new ($env, $self->{term}->resource ("name"),
		1431	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1432	"--transient-for" => $self->{term}->parent,
		1433	"-display" => $self->{term}->display_id,
		1434	"-pe" => "urxvt-popup")
		1435	or die "unable to create popup window\n";
		1436	}
		1437
		1438	sub DESTROY {
		1439	my ($self) = @_;
		1440
		1441	delete $self->{term}{_destroy}{$self};
		1442	$self->{term}->ungrab;
		1443	}
838		1444
839	=back	1445	=back
840		1446
841	=head2 The C<urxvt::timer> Class	1447	=head2 The C<urxvt::timer> Class
842		1448
…		…
897		1503
898	$term->{socket} = ...	1504	$term->{socket} = ...
899	$term->{iow} = urxvt::iow	1505	$term->{iow} = urxvt::iow
900	->new	1506	->new
901	->fd (fileno $term->{socket})	1507	->fd (fileno $term->{socket})
902	->events (1) # wait for read data	1508	->events (urxvt::EVENT_READ)
903	->start	1509	->start
904	->cb (sub {	1510	->cb (sub {
905	my ($iow, $revents) = @_;	1511	my ($iow, $revents) = @_;
906	# $revents must be 1 here, no need to check	1512	# $revents must be 1 here, no need to check
907	sysread $term->{socket}, my $buf, 8192	1513	sysread $term->{socket}, my $buf, 8192
…		…
924		1530
925	Set the filedescriptor (not handle) to watch.	1531	Set the filedescriptor (not handle) to watch.
926		1532
927	=item $iow = $iow->events ($eventmask)	1533	=item $iow = $iow->events ($eventmask)
928		1534
929	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1535	Set the event mask to watch. The only allowed values are
930	data, Bit #1 (value C<2>) enables watching for write data.	1536	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1537	together, or C<urxvt::EVENT_NONE>.
931		1538
932	=item $iow = $iow->start	1539	=item $iow = $iow->start
933		1540
934	Start watching for requested events on the given handle.	1541	Start watching for requested events on the given handle.
935		1542
…		…
946	This variable controls the verbosity level of the perl extension. Higher	1553	This variable controls the verbosity level of the perl extension. Higher
947	numbers indicate more verbose output.	1554	numbers indicate more verbose output.
948		1555
949	=over 4	1556	=over 4
950		1557
951	=item =0 - only fatal messages	1558	=item == 0 - fatal messages
952		1559
953	=item =3 - script loading and management	1560	=item >= 3 - script loading and management
954		1561
955	=item =10 - all events received	1562	=item >=10 - all events received
956		1563
957	=back	1564	=back
958		1565
959	=head1 AUTHOR	1566	=head1 AUTHOR
960		1567

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC vs. Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.33 by root, Thu Jan 5 01:04:10 2006 UTC vs.
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC