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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.30 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.76 by root, Tue Jan 10 19:46:28 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	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
72		106
73	=head2 General API Considerations	107	=head2 General API Considerations
74		108
75	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
76	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
…		…
81	When objects are destroyed on the C++ side, the perl object hashes are	115	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	116	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	117	the like inside the terminal object so they get destroyed as soon as the
84	terminal is destroyed.	118	terminal is destroyed.
85		119
		120	Argument names also often indicate the type of a parameter. Here are some
		121	hints on what they mean:
		122
		123	=over 4
		124
		125	=item $text
		126
		127	Rxvt-unicodes special way of encoding text, where one "unicode" character
		128	always represents one screen cell. See L<row_t> for a discussion of this format.
		129
		130	=item $string
		131
		132	A perl text string, with an emphasis on I<text>. It can store all unicode
		133	characters and is to be distinguished with text encoded in a specific
		134	encoding (often locale-specific) and binary data.
		135
		136	=item $octets
		137
		138	Either binary data or - more common - a text string encoded in a
		139	locale-specific way.
		140
		141	=back
		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
86	=head2 Hooks	176	=head2 Hooks
87		177
88	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
89	called whenever the relevant event happens.	179	called whenever the relevant event happens.
90		180
91	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
92	and extension package. You can call all C<urxvt::term> methods on it, but	182	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		183
97	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
98	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
99	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.
100		187
101	When in doubt, return a false value (preferably C<()>).	188	I<< When in doubt, return a false value (preferably C<()>). >>
102		189
103	=over 4	190	=over 4
104		191
105	=item on_init $term	192	=item on_init $term
106		193
107	Called after a new terminal object has been initialized, but before	194	Called after a new terminal object has been initialized, but before
108	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.
109		199
110	=item on_reset $term	200	=item on_reset $term
111		201
112	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
113	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
…		…
142	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
143	processing.	233	processing.
144		234
145	See the F<selection> example extension.	235	See the F<selection> example extension.
146		236
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	237	=item on_view_change $term, $offset
158		238
159	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
160	scrolls. Offset C<0> means display the normal terminal, positive values	240	scrolls. Offset C<0> means display the normal terminal, positive values
161	show this many lines of scrollback.	241	show this many lines of scrollback.
…		…
167	than the scroll back buffer or the terminal.	247	than the scroll back buffer or the terminal.
168		248
169	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,
170	$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
171	number of lines that will be in the scrollback buffer.	251	number of lines that will be in the scrollback buffer.
172
173	=item on_tty_activity $term NYI
174
175	Called whenever the program(s) running in the urxvt window send output.
176		252
177	=item on_osc_seq $term, $string	253	=item on_osc_seq $term, $string
178		254
179	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
180	operating system command) is processed. Cursor position and other state	256	operating system command) is processed. Cursor position and other state
…		…
185		261
186	Be careful not ever to trust (in a security sense) the data you receive,	262	Be careful not ever to trust (in a security sense) the data you receive,
187	as its source can not easily be controleld (e-mail content, messages from	263	as its source can not easily be controleld (e-mail content, messages from
188	other users on the same system etc.).	264	other users on the same system etc.).
189		265
		266	=item on_add_lines $term, $string
		267
		268	Called whenever text is about to be output, with the text as argument. You
		269	can filter/change and output the text yourself by returning a true value
		270	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		271	might be very slow, however, as your hook is called for B<all> text being
		272	output.
		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
190	=item on_refresh_begin $term	293	=item on_refresh_begin $term
191		294
192	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
193	or similar effects by modify terminal contents in refresh_begin, and	296	or similar effects by modify terminal contents in refresh_begin, and
194	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
…		…
202		305
203	Called whenever the user presses a key combination that has a	306	Called whenever the user presses a key combination that has a
204	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>
205	resource in the @@RXVT_NAME@@(1) manpage).	308	resource in the @@RXVT_NAME@@(1) manpage).
206		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
207	=back	346	=back
208		347
209	=head2 Variables in the C<urxvt> Package	348	=head2 Variables in the C<urxvt> Package
210		349
211	=over 4	350	=over 4
212		351
		352	=item $urxvt::LIBDIR
		353
		354	The rxvt-unicode library directory, where, among other things, the perl
		355	modules and scripts are stored.
		356
		357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		358
		359	The resource class and name rxvt-unicode uses to look up X resources.
		360
		361	=item $urxvt::RXVTNAME
		362
		363	The basename of the installed binaries, usually C<urxvt>.
		364
213	=item $urxvt::TERM	365	=item $urxvt::TERM
214		366
215	The current terminal. Whenever a callback/Hook is bein executed, this	367	The current terminal. This variable stores the current C<urxvt::term>
216	variable stores the current C<urxvt::term> object.	368	object, whenever a callback/hook is executing.
		369
		370	=item
217		371
218	=back	372	=back
219		373
220	=head2 Functions in the C<urxvt> Package	374	=head2 Functions in the C<urxvt> Package
221		375
222	=over 4	376	=over 4
		377
		378	=item $term = new urxvt [arg...]
		379
		380	Creates a new terminal, very similar as if you had started it with
		381	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
		382	if the new instance couldn't be created. Returns C<undef> if the new
		383	instance didn't initialise perl, and the terminal object otherwise. The
		384	C<init> and C<start> hooks will be called during the call.
223		385
224	=item urxvt::fatal $errormessage	386	=item urxvt::fatal $errormessage
225		387
226	Fatally aborts execution with the given error message. Avoid at all	388	Fatally aborts execution with the given error message. Avoid at all
227	costs! The only time this is acceptable is when the terminal process	389	costs! The only time this is acceptable is when the terminal process
…		…
234	that calls this function.	396	that calls this function.
235		397
236	Using this function has the advantage that its output ends up in the	398	Using this function has the advantage that its output ends up in the
237	correct place, e.g. on stderr of the connecting urxvtc client.	399	correct place, e.g. on stderr of the connecting urxvtc client.
238		400
		401	=item $is_safe = urxvt::safe
		402
		403	Returns true when it is safe to do potentially unsafe things, such as
		404	evaluating perl code specified by the user. This is true when urxvt was
		405	started setuid or setgid.
		406
239	=item $time = urxvt::NOW	407	=item $time = urxvt::NOW
240		408
241	Returns the "current time" (as per the event loop).	409	Returns the "current time" (as per the event loop).
		410
		411	=item urxvt::CurrentTime
		412
		413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		415	Button4Mask, Button5Mask, AnyModifier
		416
		417	Various constants for use in X calls and event processing.
242		418
243	=back	419	=back
244		420
245	=head2 RENDITION	421	=head2 RENDITION
246		422
…		…
273		449
274	=item $background = urxvt::GET_BASEBG $rend	450	=item $background = urxvt::GET_BASEBG $rend
275		451
276	Return the foreground/background colour index, respectively.	452	Return the foreground/background colour index, respectively.
277		453
278	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
279		455
280	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
281		457
282	Replace the foreground/background colour in the rendition mask with the	458	Replace the foreground/background colour in the rendition mask with the
283	specified one.	459	specified one.
284		460
285	=item $value = urxvt::GET_CUSTOM ($rend)	461	=item $value = urxvt::GET_CUSTOM $rend
286		462
287	Return the "custom" value: Every rendition has 5 bits for use by	463	Return the "custom" value: Every rendition has 5 bits for use by
288	extensions. They can be set and changed as you like and are initially	464	extensions. They can be set and changed as you like and are initially
289	zero.	465	zero.
290		466
291	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
292		468
293	Change the custom value.	469	Change the custom value.
294		470
295	=back	471	=back
296		472
297	=cut	473	=cut
298		474
299	package urxvt;	475	package urxvt;
300		476
		477	use utf8;
301	use strict;	478	use strict;
		479	use Carp ();
302	use Scalar::Util ();	480	use Scalar::Util ();
		481	use List::Util ();
303		482
		483	our $VERSION = 1;
304	our $TERM;	484	our $TERM;
305	our @HOOKNAME;	485	our @HOOKNAME;
		486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		487	our %OPTION;
		488
306	our $LIBDIR;	489	our $LIBDIR;
		490	our $RESNAME;
		491	our $RESCLASS;
		492	our $RXVTNAME;
307		493
308	BEGIN {	494	BEGIN {
309	urxvt->bootstrap;	495	urxvt->bootstrap;
310		496
311	# overwrite perl's warn	497	# overwrite perl's warn
…		…
313	my $msg = join "", @_;	499	my $msg = join "", @_;
314	$msg .= "\n"	500	$msg .= "\n"
315	unless $msg =~ /\n$/;	501	unless $msg =~ /\n$/;
316	urxvt::warn ($msg);	502	urxvt::warn ($msg);
317	};	503	};
		504
		505	delete $ENV{IFS};
		506	delete $ENV{CDPATH};
		507	delete $ENV{BASH_ENV};
		508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
318	}	509	}
319		510
320	my @hook_count;	511	my @hook_count;
321	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
322		513
323	sub verbose {	514	sub verbose {
324	my ($level, $msg) = @_;	515	my ($level, $msg) = @_;
325	warn "$msg\n" if $level <= $verbosity;	516	warn "$msg\n" if $level <= $verbosity;
326	}	517	}
327		518
328	# find on_xxx subs in the package and register them	519	my $extension_pkg = "extension0000";
329	# as hooks	520	my %extension_pkg;
330	sub register_package($) {
331	my ($pkg) = @_;
332
333	for my $htype (0.. $#HOOKNAME) {
334	my $name = $HOOKNAME[$htype];
335
336	my $ref = $pkg->can ("on_" . lc $name)
337	or next;
338
339	$TERM->{_hook}[$htype]{$pkg} = $ref;
340	$hook_count[$htype]++
341	or set_should_invoke $htype, 1;
342	}
343	}
344
345	my $script_pkg = "script0000";
346	my %script_pkg;
347		521
348	# load a single script into its own package, once only	522	# load a single script into its own package, once only
349	sub script_package($) {	523	sub extension_package($) {
350	my ($path) = @_;	524	my ($path) = @_;
351		525
352	$script_pkg{$path} \|\|= do {	526	$extension_pkg{$path} \|\|= do {
353	my $pkg = "urxvt::" . ($script_pkg++);	527	my $pkg = "urxvt::" . ($extension_pkg++);
354		528
355	verbose 3, "loading script '$path' into package '$pkg'";	529	verbose 3, "loading extension '$path' into package '$pkg'";
356		530
357	open my $fh, "<:raw", $path	531	open my $fh, "<:raw", $path
358	or die "$path: $!";	532	or die "$path: $!";
359		533
		534	my $source = untaint
360	my $source = "package $pkg; use strict; use utf8;\n"	535	"package $pkg; use strict; use utf8;\n"
		536	. "use base urxvt::term::extension::;\n"
361	. "#line 1 \"$path\"\n{\n"	537	. "#line 1 \"$path\"\n{\n"
362	. (do { local $/; <$fh> })	538	. (do { local $/; <$fh> })
363	. "\n};\n1";	539	. "\n};\n1";
364		540
		541	eval $source
365	eval $source or die "$path: $@";	542	or die "$path: $@";
366		543
367	$pkg	544	$pkg
368	}	545	}
369	}	546	}
		547
		548	our $retval; # return value for urxvt
370		549
371	# called by the rxvt core	550	# called by the rxvt core
372	sub invoke {	551	sub invoke {
373	local $TERM = shift;	552	local $TERM = shift;
374	my $htype = shift;	553	my $htype = shift;
375		554
376	if ($htype == 0) { # INIT	555	if ($htype == 0) { # INIT
377	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
		557
		558	my %ext_arg;
378		559
379	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		561	if ($_ eq "default") {
		562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
		563	} elsif (/^-(.*)$/) {
		564	delete $ext_arg{$1};
		565	} elsif (/^([^<]+)<(.*)>$/) {
		566	push @{ $ext_arg{$1} }, $2;
		567	} else {
		568	$ext_arg{$_} \|\|= [];
		569	}
		570	}
		571
		572	while (my ($ext, $argv) = each %ext_arg) {
380	my @files = grep -f $_, map "$_/$ext", @dirs;	573	my @files = grep -f $_, map "$_/$ext", @dirs;
381		574
382	if (@files) {	575	if (@files) {
383	register_package script_package $files[0];	576	$TERM->register_package (extension_package $files[0], $argv);
384	} else {	577	} else {
385	warn "perl extension '$ext' not found in perl library search path\n";	578	warn "perl extension '$ext' not found in perl library search path\n";
386	}	579	}
387	}	580	}
388		581
		582	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		583	warn $@ if $@;
		584	}
		585
		586	$retval = undef;
		587
		588	if (my $cb = $TERM->{_hook}[$htype]) {
		589	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		590	if $verbosity >= 10;
		591
		592	keys %$cb;
		593
		594	while (my ($pkg, $cb) = each %$cb) {
		595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
		596	and last;
		597
		598	if ($@) {
		599	$TERM->ungrab; # better to lose the grab than the session
		600	warn $@;
		601	}
		602	}
		603	}
		604
389	} elsif ($htype == 1) { # DESTROY	605	if ($htype == 1) { # DESTROY
390	if (my $hook = $TERM->{_hook}) {	606	if (my $hook = delete $TERM->{_hook}) {
391	for my $htype (0..$#$hook) {	607	for my $htype (0..$#$hook) {
392	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }	608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
393	or set_should_invoke $htype, 0;	609	or set_should_invoke $htype, 0;
394	}	610	}
395	}	611	}
		612
		613	# clear package objects
		614	%$_ = () for values %{ $TERM->{_pkg} };
		615
		616	# clear package
		617	%$TERM = ();
396	}	618	}
397		619
398	my $cb = $TERM->{_hook}[$htype]	620	$retval
399	or return;	621	}
400		622
401	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	623	# urxvt::term::extension
402	if $verbosity >= 10;
403		624
404	keys %$cb;	625	package urxvt::term::extension;
405		626
		627	sub enable {
		628	my ($self, %hook) = @_;
		629	my $pkg = $self->{_pkg};
		630
406	while (my ($pkg, $cb) = each %$cb) {	631	while (my ($name, $cb) = each %hook) {
407	return 1	632	my $htype = $HOOKTYPE{uc $name};
408	if $cb->(	633	defined $htype
409	$TERM->{$pkg} \|\|= do {	634	or Carp::croak "unsupported hook type '$name'";
410	my $proxy = bless { }, urxvt::term::proxy::;	635
411	Scalar::Util::weaken ($proxy->{term} = $TERM);	636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
412	$proxy	637	$hook_count[$htype]++
413	},	638	or urxvt::set_should_invoke $htype, 1;
414	@_,	639	}
415	);	640
		641	$self->{term}{_hook}[$htype]{$pkg} = $cb;
416	}	642	}
		643	}
417		644
		645	sub disable {
		646	my ($self, @hook) = @_;
		647	my $pkg = $self->{_pkg};
		648
		649	for my $name (@hook) {
		650	my $htype = $HOOKTYPE{uc $name};
		651	defined $htype
		652	or Carp::croak "unsupported hook type '$name'";
		653
		654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {
		655	--$hook_count[$htype]
		656	or urxvt::set_should_invoke $htype, 0;
		657	}
418	0	658	}
419	}	659	}
420		660
421	sub urxvt::term::proxy::AUTOLOAD {	661	our $AUTOLOAD;
422	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	662
		663	sub AUTOLOAD {
		664	$AUTOLOAD =~ /:([^:]+)$/
423	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	665	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
424		666
425	eval qq{	667	eval qq{
426	sub $urxvt::term::proxy::AUTOLOAD {	668	sub $AUTOLOAD {
427	my \$proxy = shift;	669	my \$proxy = shift;
428	\$proxy->{term}->$1 (\@_)	670	\$proxy->{term}->$1 (\@_)
429	}	671	}
430	1	672	1
431	} or die "FATAL: unable to compile method forwarder: $@";	673	} or die "FATAL: unable to compile method forwarder: $@";
432		674
433	goto &$urxvt::term::proxy::AUTOLOAD;	675	goto &$AUTOLOAD;
434	}	676	}
		677
		678	sub DESTROY {
		679	# nop
		680	}
		681
		682	# urxvt::destroy_hook
		683
		684	sub urxvt::destroy_hook::DESTROY {
		685	${$_[0]}->();
		686	}
		687
		688	sub urxvt::destroy_hook(&) {
		689	bless \shift, urxvt::destroy_hook::
		690	}
		691
		692	package urxvt::anyevent;
		693
		694	=head2 The C<urxvt::anyevent> Class
		695
		696	The sole purpose of this class is to deliver an interface to the
		697	C<AnyEvent> module - any module using it will work inside urxvt without
		698	further programming. The only exception is that you cannot wait on
		699	condition variables, but non-blocking condvar use is ok. What this means
		700	is that you cannot use blocking APIs, but the non-blocking variant should
		701	work.
		702
		703	=cut
		704
		705	our $VERSION = 1;
		706
		707	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		708	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		709
		710	sub timer {
		711	my ($class, %arg) = @_;
		712
		713	my $cb = $arg{cb};
		714
		715	urxvt::timer
		716	->new
		717	->start (urxvt::NOW + $arg{after})
		718	->cb (sub {
		719	$_[0]->stop; # need to cancel manually
		720	$cb->();
		721	})
		722	}
		723
		724	sub io {
		725	my ($class, %arg) = @_;
		726
		727	my $cb = $arg{cb};
		728
		729	bless [$arg{fh}, urxvt::iow
		730	->new
		731	->fd (fileno $arg{fh})
		732	->events (($arg{poll} =~ /r/ ? 1 : 0)
		733	\| ($arg{poll} =~ /w/ ? 2 : 0))
		734	->start
		735	->cb (sub {
		736	$cb->(($_[1] & 1 ? 'r' : '')
		737	. ($_[1] & 2 ? 'w' : ''));
		738	})],
		739	urxvt::anyevent::
		740	}
		741
		742	sub DESTROY {
		743	$_[0][1]->stop;
		744	}
		745
		746	sub condvar {
		747	bless \my $flag, urxvt::anyevent::condvar::
		748	}
		749
		750	sub urxvt::anyevent::condvar::broadcast {
		751	${$_[0]}++;
		752	}
		753
		754	sub urxvt::anyevent::condvar::wait {
		755	unless (${$_[0]}) {
		756	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
		757	}
		758	}
		759
		760	package urxvt::term;
435		761
436	=head2 The C<urxvt::term> Class	762	=head2 The C<urxvt::term> Class
437		763
438	=over 4	764	=over 4
		765
		766	=cut
		767
		768	# find on_xxx subs in the package and register them
		769	# as hooks
		770	sub register_package {
		771	my ($self, $pkg, $argv) = @_;
		772
		773	my $proxy = bless {
		774	_pkg => $pkg,
		775	argv => $argv,
		776	}, $pkg;
		777	Scalar::Util::weaken ($proxy->{term} = $self);
		778
		779	$self->{_pkg}{$pkg} = $proxy;
		780
		781	for my $name (@HOOKNAME) {
		782	if (my $ref = $pkg->can ("on_" . lc $name)) {
		783	$proxy->enable ($name => $ref);
		784	}
		785	}
		786	}
		787
		788	=item $term->destroy
		789
		790	Destroy the terminal object (close the window, free resources
		791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		792	watchers (timers, io watchers) are still active.
		793
		794	=item $isset = $term->option ($optval[, $set])
		795
		796	Returns true if the option specified by C<$optval> is enabled, and
		797	optionally change it. All option values are stored by name in the hash
		798	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		799
		800	Here is a a likely non-exhaustive list of option names, please see the
		801	source file F</src/optinc.h> to see the actual list:
		802
		803	borderLess console cursorBlink cursorUnderline hold iconic insecure
		804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
		806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
		807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
		808	tripleclickwords utmpInhibit visualBell
439		809
440	=item $value = $term->resource ($name[, $newval])	810	=item $value = $term->resource ($name[, $newval])
441		811
442	Returns the current resource value associated with a given name and	812	Returns the current resource value associated with a given name and
443	optionally sets a new value. Setting values is most useful in the C<init>	813	optionally sets a new value. Setting values is most useful in the C<init>
…		…
453		823
454	Please note that resource strings will currently only be freed when the	824	Please note that resource strings will currently only be freed when the
455	terminal is destroyed, so changing options frequently will eat memory.	825	terminal is destroyed, so changing options frequently will eat memory.
456		826
457	Here is a a likely non-exhaustive list of resource names, not all of which	827	Here is a a likely non-exhaustive list of resource names, not all of which
458	are supported in every build, please see the source to see the actual	828	are supported in every build, please see the source file F</src/rsinc.h>
459	list:	829	to see the actual list:
460		830
461	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
462	borderLess color cursorBlink cursorUnderline cutchars delete_key	832	borderLess color cursorBlink cursorUnderline cutchars delete_key
463	display_name embed ext_bwidth fade font geometry hold iconName	833	display_name embed ext_bwidth fade font geometry hold iconName
464	imFont imLocale inputMethod insecure int_bwidth intensityStyles	834	imFont imLocale inputMethod insecure int_bwidth intensityStyles
…		…
471	shade term_name title transparent transparent_all tripleclickwords	841	shade term_name title transparent transparent_all tripleclickwords
472	utmpInhibit visualBell	842	utmpInhibit visualBell
473		843
474	=cut	844	=cut
475		845
476	sub urxvt::term::resource($$;$) {	846	sub resource($$;$) {
477	my ($self, $name) = (shift, shift);	847	my ($self, $name) = (shift, shift);
478	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
479	goto &urxvt::term::_resource;	849	&urxvt::term::_resource
480	}	850	}
		851
		852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		853
		854	Adds a keymap translation exactly as specified via a resource. See the
		855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		856
		857	=item $rend = $term->rstyle ([$new_rstyle])
		858
		859	Return and optionally change the current rendition. Text that is output by
		860	the terminal application will use this style.
		861
		862	=item ($row, $col) = $term->screen_cur ([$row, $col])
		863
		864	Return the current coordinates of the text cursor position and optionally
		865	set it (which is usually bad as applications don't expect that).
481		866
482	=item ($row, $col) = $term->selection_mark ([$row, $col])	867	=item ($row, $col) = $term->selection_mark ([$row, $col])
483		868
484	=item ($row, $col) = $term->selection_beg ([$row, $col])	869	=item ($row, $col) = $term->selection_beg ([$row, $col])
485		870
…		…
495		880
496	=item $oldtext = $term->selection ([$newtext])	881	=item $oldtext = $term->selection ([$newtext])
497		882
498	Return the current selection text and optionally replace it by C<$newtext>.	883	Return the current selection text and optionally replace it by C<$newtext>.
499		884
500	#=item $term->overlay ($x, $y, $text)	885	=item $term->overlay_simple ($x, $y, $text)
501	#	886
502	#Create a simple multi-line overlay box. See the next method for details.	887	Create a simple multi-line overlay box. See the next method for details.
503	#	888
504	#=cut	889	=cut
505		890
506	sub urxvt::term::scr_overlay {	891	sub overlay_simple {
507	die;
508	my ($self, $x, $y, $text) = @_;	892	my ($self, $x, $y, $text) = @_;
509		893
510	my @lines = split /\n/, $text;	894	my @lines = split /\n/, $text;
511		895
512	my $w = 0;	896	my $w = List::Util::max map $self->strwidth ($_), @lines;
513	for (map $self->strwidth ($_), @lines) {
514	$w = $_ if $w < $_;
515	}
516		897
517	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	898	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
518	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	899	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		900
		901	$overlay
519	}	902	}
520		903
521	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	904	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
522		905
523	Create a new (empty) overlay at the given position with the given	906	Create a new (empty) overlay at the given position with the given
…		…
551		934
552	If hidden, display the overlay again.	935	If hidden, display the overlay again.
553		936
554	=back	937	=back
555		938
		939	=item $popup = $term->popup ($event)
		940
		941	Creates a new C<urxvt::popup> object that implements a popup menu. The
		942	C<$event> I<must> be the event causing the menu to pop up (a button event,
		943	currently).
		944
		945	=cut
		946
		947	sub popup {
		948	my ($self, $event) = @_;
		949
		950	$self->grab ($event->{time}, 1)
		951	or return;
		952
		953	my $popup = bless {
		954	term => $self,
		955	event => $event,
		956	}, urxvt::popup::;
		957
		958	Scalar::Util::weaken $popup->{term};
		959
		960	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		961	Scalar::Util::weaken $self->{_destroy}{$popup};
		962
		963	$popup
		964	}
		965
556	=item $cellwidth = $term->strwidth $string	966	=item $cellwidth = $term->strwidth ($string)
557		967
558	Returns the number of screen-cells this string would need. Correctly	968	Returns the number of screen-cells this string would need. Correctly
559	accounts for wide and combining characters.	969	accounts for wide and combining characters.
560		970
561	=item $octets = $term->locale_encode $string	971	=item $octets = $term->locale_encode ($string)
562		972
563	Convert the given text string into the corresponding locale encoding.	973	Convert the given text string into the corresponding locale encoding.
564		974
565	=item $string = $term->locale_decode $octets	975	=item $string = $term->locale_decode ($octets)
566		976
567	Convert the given locale-encoded octets into a perl string.	977	Convert the given locale-encoded octets into a perl string.
		978
		979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		980
		981	XORs the rendition values in the given span with the provided value
		982	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
		983	to the selection.
		984
		985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		986
		987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		988	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		989	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		990	it instead.
		991
		992	=item $term->scr_bell
		993
		994	Ring the bell!
		995
		996	=item $term->scr_add_lines ($string)
		997
		998	Write the given text string to the screen, as if output by the application
		999	running inside the terminal. It may not contain command sequences (escape
		1000	codes), but is free to use line feeds, carriage returns and tabs. The
		1001	string is a normal text string, not in locale-dependent encoding.
		1002
		1003	Normally its not a good idea to use this function, as programs might be
		1004	confused by changes in cursor position or scrolling. Its useful inside a
		1005	C<on_add_lines> hook, though.
		1006
		1007	=item $term->cmd_parse ($octets)
		1008
		1009	Similar to C<scr_add_lines>, but the argument must be in the
		1010	locale-specific encoding of the terminal and can contain command sequences
		1011	(escape codes) that will be interpreted.
568		1012
569	=item $term->tt_write ($octets)	1013	=item $term->tt_write ($octets)
570		1014
571	Write the octets given in C<$data> to the tty (i.e. as program input). To	1015	Write the octets given in C<$data> to the tty (i.e. as program input). To
572	pass characters instead of octets, you should convert your strings first	1016	pass characters instead of octets, you should convert your strings first
573	to the locale-specific encoding using C<< $term->locale_encode >>.	1017	to the locale-specific encoding using C<< $term->locale_encode >>.
574		1018
		1019	=item $old_events = $term->pty_ev_events ([$new_events])
		1020
		1021	Replaces the event mask of the pty watcher by the given event mask. Can
		1022	be used to suppress input and output handling to the pty/tty. See the
		1023	description of C<< urxvt::timer->events >>. Make sure to always restore
		1024	the previous value.
		1025
		1026	=item $windowid = $term->parent
		1027
		1028	Return the window id of the toplevel window.
		1029
		1030	=item $windowid = $term->vt
		1031
		1032	Return the window id of the terminal window.
		1033
		1034	=item $window_width = $term->width
		1035
		1036	=item $window_height = $term->height
		1037
		1038	=item $font_width = $term->fwidth
		1039
		1040	=item $font_height = $term->fheight
		1041
		1042	=item $font_ascent = $term->fbase
		1043
575	=item $nrow = $term->nrow	1044	=item $terminal_rows = $term->nrow
576		1045
577	=item $ncol = $term->ncol	1046	=item $terminal_columns = $term->ncol
578		1047
579	Return the number of rows/columns of the terminal window (i.e. as	1048	=item $has_focus = $term->focus
580	specified by C<-geometry>, excluding any scrollback).
581		1049
582	=item $nsaved = $term->nsaved	1050	=item $is_mapped = $term->mapped
583		1051
584	Returns the number of lines in the scrollback buffer.	1052	=item $max_scrollback = $term->saveLines
		1053
		1054	=item $nrow_plus_saveLines = $term->total_rows
		1055
		1056	=item $lines_in_scrollback = $term->nsaved
		1057
		1058	Return various integers describing terminal characteristics.
		1059
		1060	=item $lc_ctype = $term->locale
		1061
		1062	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1063
		1064	=item $x_display = $term->display_id
		1065
		1066	Return the DISPLAY used by rxvt-unicode.
		1067
		1068	=item $modifiermask = $term->ModLevel3Mask
		1069
		1070	=item $modifiermask = $term->ModMetaMask
		1071
		1072	=item $modifiermask = $term->ModNumLockMask
		1073
		1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1075	AltGr), the meta key (often Alt) and the num lock key, if applicable.
585		1076
586	=item $view_start = $term->view_start ([$newvalue])	1077	=item $view_start = $term->view_start ([$newvalue])
587		1078
588	Returns the negative row number of the topmost line. Minimum value is	1079	Returns the negative row number of the topmost line. Minimum value is
589	C<0>, which displays the normal terminal contents. Larger values scroll	1080	C<0>, which displays the normal terminal contents. Larger values scroll
…		…
652	about the logical line that row C<$row_number> is part of. It supports the	1143	about the logical line that row C<$row_number> is part of. It supports the
653	following methods:	1144	following methods:
654		1145
655	=over 4	1146	=over 4
656		1147
657	=item $text = $line->t	1148	=item $text = $line->t ([$new_text])
658		1149
659	Returns the full text of the line, similar to C<ROW_t>	1150	Returns or replaces the full text of the line, similar to C<ROW_t>
660		1151
661	=item $rend = $line->r	1152	=item $rend = $line->r ([$new_rend])
662		1153
663	Returns the full rendition array of the line, similar to C<ROW_r>	1154	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
664		1155
665	=item $length = $line->l	1156	=item $length = $line->l
666		1157
667	Returns the length of the line in cells, similar to C<ROW_l>.	1158	Returns the length of the line in cells, similar to C<ROW_l>.
668		1159
…		…
683		1174
684	=back	1175	=back
685		1176
686	=cut	1177	=cut
687		1178
688	sub urxvt::term::line {	1179	sub line {
689	my ($self, $row) = @_;	1180	my ($self, $row) = @_;
690		1181
691	my $maxrow = $self->nrow - 1;	1182	my $maxrow = $self->nrow - 1;
692		1183
693	my ($beg, $end) = ($row, $row);	1184	my ($beg, $end) = ($row, $row);
…		…
697		1188
698	bless {	1189	bless {
699	term => $self,	1190	term => $self,
700	beg => $beg,	1191	beg => $beg,
701	end => $end,	1192	end => $end,
		1193	ncol => $self->ncol,
702	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1194	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
703	}, urxvt::line::	1195	}, urxvt::line::
704	}	1196	}
705		1197
706	sub urxvt::line::t {	1198	sub urxvt::line::t {
707	my ($self) = @_;	1199	my ($self) = @_;
708		1200
		1201	if (@_ > 1)
		1202	{
		1203	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1204	for $self->{beg} .. $self->{end};
		1205	}
		1206
		1207	defined wantarray &&
709	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1208	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
710	0, $self->{len}	1209	0, $self->{len}
711	}	1210	}
712		1211
713	sub urxvt::line::r {	1212	sub urxvt::line::r {
714	my ($self) = @_;	1213	my ($self) = @_;
715		1214
		1215	if (@_ > 1)
		1216	{
		1217	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1218	for $self->{beg} .. $self->{end};
		1219	}
		1220
		1221	if (defined wantarray) {
716	my $rend = [	1222	my $rend = [
717	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1223	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
718	];	1224	];
719	$#$rend = $self->{len} - 1;	1225	$#$rend = $self->{len} - 1;
720	$rend	1226	return $rend;
		1227	}
		1228
		1229	()
721	}	1230	}
722		1231
723	sub urxvt::line::beg { $_[0]{beg} }	1232	sub urxvt::line::beg { $_[0]{beg} }
724	sub urxvt::line::end { $_[0]{end} }	1233	sub urxvt::line::end { $_[0]{end} }
725	sub urxvt::line::l { $_[0]{len} }	1234	sub urxvt::line::l { $_[0]{len} }
726		1235
727	sub urxvt::line::offset_of {	1236	sub urxvt::line::offset_of {
728	my ($self, $row, $col) = @_;	1237	my ($self, $row, $col) = @_;
729		1238
730	($row - $self->{beg}) * $self->{term}->ncol + $col	1239	($row - $self->{beg}) * $self->{ncol} + $col
731	}	1240	}
732		1241
733	sub urxvt::line::coord_of {	1242	sub urxvt::line::coord_of {
734	my ($self, $offset) = @_;	1243	my ($self, $offset) = @_;
735		1244
736	use integer;	1245	use integer;
737		1246
738	(	1247	(
739	$offset / $self->{term}->ncol + $self->{beg},	1248	$offset / $self->{ncol} + $self->{beg},
740	$offset % $self->{term}->ncol	1249	$offset % $self->{ncol}
741	)	1250	)
742	}	1251	}
743		1252
744	=item ($row, $col) = $line->coord_of ($offset)
745	=item $text = $term->special_encode $string	1253	=item $text = $term->special_encode $string
746		1254
747	Converts a perl string into the special encoding used by rxvt-unicode,	1255	Converts a perl string into the special encoding used by rxvt-unicode,
748	where one character corresponds to one screen cell. See	1256	where one character corresponds to one screen cell. See
749	C<< $term->ROW_t >> for details.	1257	C<< $term->ROW_t >> for details.
…		…
751	=item $string = $term->special_decode $text	1259	=item $string = $term->special_decode $text
752		1260
753	Converts rxvt-unicodes text reprsentation into a perl string. See	1261	Converts rxvt-unicodes text reprsentation into a perl string. See
754	C<< $term->ROW_t >> for details.	1262	C<< $term->ROW_t >> for details.
755		1263
		1264	=item $success = $term->grab_button ($button, $modifiermask)
		1265
		1266	Registers a synchronous button grab. See the XGrabButton manpage.
		1267
		1268	=item $success = $term->grab ($eventtime[, $sync])
		1269
		1270	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1271	synchronous (C<$sync> is true). Also remembers the grab timestampe.
		1272
		1273	=item $term->allow_events_async
		1274
		1275	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1276
		1277	=item $term->allow_events_sync
		1278
		1279	Calls XAllowEvents with SyncBoth for the most recent grab.
		1280
		1281	=item $term->allow_events_replay
		1282
		1283	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1284	recent grab.
		1285
		1286	=item $term->ungrab
		1287
		1288	Calls XUngrab for the most recent grab. Is called automatically on
		1289	evaluation errors, as it is better to lose the grab in the error case as
		1290	the session.
		1291
756	=back	1292	=back
		1293
		1294	=cut
		1295
		1296	package urxvt::popup;
		1297
		1298	=head2 The C<urxvt::popup> Class
		1299
		1300	=over 4
		1301
		1302	=cut
		1303
		1304	sub add_item {
		1305	my ($self, $item) = @_;
		1306
		1307	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1308	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1309	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1310
		1311	$item->{render} \|\|= sub { $_[0]{text} };
		1312
		1313	push @{ $self->{item} }, $item;
		1314	}
		1315
		1316	=item $popup->add_title ($title)
		1317
		1318	Adds a non-clickable title to the popup.
		1319
		1320	=cut
		1321
		1322	sub add_title {
		1323	my ($self, $title) = @_;
		1324
		1325	$self->add_item ({
		1326	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1327	text => $title,
		1328	activate => sub { },
		1329	});
		1330	}
		1331
		1332	=item $popup->add_separator ([$sepchr])
		1333
		1334	Creates a separator, optionally using the character given as C<$sepchr>.
		1335
		1336	=cut
		1337
		1338	sub add_separator {
		1339	my ($self, $sep) = @_;
		1340
		1341	$sep \|\|= "=";
		1342
		1343	$self->add_item ({
		1344	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1345	text => "",
		1346	render => sub { $sep x $self->{term}->ncol },
		1347	activate => sub { },
		1348	});
		1349	}
		1350
		1351	=item $popup->add_button ($text, $cb)
		1352
		1353	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1354	selected.
		1355
		1356	=cut
		1357
		1358	sub add_button {
		1359	my ($self, $text, $cb) = @_;
		1360
		1361	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1362	}
		1363
		1364	=item $popup->add_toggle ($text, $cb, $initial_value)
		1365
		1366	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1367	whenever it gets toggled, with a boolean indicating its value as its first
		1368	argument.
		1369
		1370	=cut
		1371
		1372	sub add_toggle {
		1373	my ($self, $text, $cb, $value) = @_;
		1374
		1375	my $item; $item = {
		1376	type => "button",
		1377	text => " $text",
		1378	value => $value,
		1379	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		1380	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		1381	};
		1382
		1383	$self->add_item ($item);
		1384	}
		1385
		1386	=item $popup->show
		1387
		1388	Displays the popup (which is initially hidden).
		1389
		1390	=cut
		1391
		1392	sub show {
		1393	my ($self) = @_;
		1394
		1395	local $urxvt::popup::self = $self;
		1396
		1397	local $ENV{LC_ALL} = $self->{term}->locale;
		1398
		1399	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
		1400	"--transient-for" => $self->{term}->parent,
		1401	"-display" => $self->{term}->display_id,
		1402	"-pe" => "urxvt-popup")
		1403	or die "unable to create popup window\n";
		1404	}
		1405
		1406	sub DESTROY {
		1407	my ($self) = @_;
		1408
		1409	delete $self->{term}{_destroy}{$self};
		1410	$self->{term}->ungrab;
		1411	}
757		1412
758	=head2 The C<urxvt::timer> Class	1413	=head2 The C<urxvt::timer> Class
759		1414
760	This class implements timer watchers/events. Time is represented as a	1415	This class implements timer watchers/events. Time is represented as a
761	fractional number of seconds since the epoch. Example:	1416	fractional number of seconds since the epoch. Example:
…		…
814		1469
815	$term->{socket} = ...	1470	$term->{socket} = ...
816	$term->{iow} = urxvt::iow	1471	$term->{iow} = urxvt::iow
817	->new	1472	->new
818	->fd (fileno $term->{socket})	1473	->fd (fileno $term->{socket})
819	->events (1) # wait for read data	1474	->events (urxvt::EVENT_READ)
820	->start	1475	->start
821	->cb (sub {	1476	->cb (sub {
822	my ($iow, $revents) = @_;	1477	my ($iow, $revents) = @_;
823	# $revents must be 1 here, no need to check	1478	# $revents must be 1 here, no need to check
824	sysread $term->{socket}, my $buf, 8192	1479	sysread $term->{socket}, my $buf, 8192
…		…
841		1496
842	Set the filedescriptor (not handle) to watch.	1497	Set the filedescriptor (not handle) to watch.
843		1498
844	=item $iow = $iow->events ($eventmask)	1499	=item $iow = $iow->events ($eventmask)
845		1500
846	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1501	Set the event mask to watch. The only allowed values are
847	data, Bit #1 (value C<2>) enables watching for write data.	1502	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1503	together, or C<urxvt::EVENT_NONE>.
848		1504
849	=item $iow = $iow->start	1505	=item $iow = $iow->start
850		1506
851	Start watching for requested events on the given handle.	1507	Start watching for requested events on the given handle.
852		1508
…		…
863	This variable controls the verbosity level of the perl extension. Higher	1519	This variable controls the verbosity level of the perl extension. Higher
864	numbers indicate more verbose output.	1520	numbers indicate more verbose output.
865		1521
866	=over 4	1522	=over 4
867		1523
868	=item =0 - only fatal messages	1524	=item == 0 - fatal messages
869		1525
870	=item =3 - script loading and management	1526	=item >= 3 - script loading and management
871		1527
872	=item =10 - all events received	1528	=item >=10 - all events received
873		1529
874	=back	1530	=back
875		1531
876	=head1 AUTHOR	1532	=head1 AUTHOR
877		1533

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.30 by root, Wed Jan 4 05:35:34 2006 UTC vs. Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.30 by root, Wed Jan 4 05:35:34 2006 UTC vs.
Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC