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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC vs.
Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC

…		…
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 (enabled by default)	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
…		…
64	runtime.	64	runtime.
65		65
66	=item selection-popup (enabled by default)	66	=item selection-popup (enabled by default)
67		67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	69	text into various other formats/action (such as uri unescaping, perl
		70	evalution, web-browser starting etc.), depending on content.
70		71
71	=item searchable-scrollback (enabled by default)	72	=item searchable-scrollback<hotkey> (enabled by default)
72		73
73	Adds regex search functionality to the scrollback buffer, triggered by a	74	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		76	input/output is suspended.
		77
75	suspended, C</> starts an incremental regex search, C<n> searches further,	78	C</> starts an incremental regex search, C<n> searches further, C<p> or
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
77	current position and C<escape> returns to the original position.	80	history, C<enter> leaves search mode at the current position and C<escape>
		81	returns to the original position.
78		82
79	=item digital-clock	83	=item digital-clock
80		84
81	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
82		86
83	=item mark-urls	87	=item mark-urls
84		88
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	89	Uses per-line display filtering (C<on_line_update>) to underline urls and
		90	make them clickable. When middle-clicked, the program specified in the
		91	resource C<urlLauncher> (default C<x-www-browser>) will be started.
86		92
87	=item block-graphics-to-ascii	93	=item block-graphics-to-ascii
88		94
89	A not very useful example of filtering all text output to the terminal,	95	A not very useful example of filtering all text output to the terminal,
90	by replacing all line-drawing characters (U+2500 .. U+259F) by a	96	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
95	Displays a very simple digital clock in the upper right corner of the	101	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	102	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	103	overlays or changes.
98		104
99	=back	105	=back
		106
		107	=head1 API DOCUMENTATION
100		108
101	=head2 General API Considerations	109	=head2 General API Considerations
102		110
103	All objects (such as terminals, time watchers etc.) are typical	111	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	112	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	125	=over 4
118		126
119	=item $text	127	=item $text
120		128
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	129	Rxvt-unicodes special way of encoding text, where one "unicode" character
122	always represents one screen cell. See L<row_t> for a discussion of this format.	130	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		131
124	=item $string	132	=item $string
125		133
126	A perl text string, with an emphasis on I<text>. It can store all unicode	134	A perl text string, with an emphasis on I<text>. It can store all unicode
127	characters and is to be distinguished with text encoded in a specific	135	characters and is to be distinguished with text encoded in a specific
…		…
222	=item on_sel_extend $term	230	=item on_sel_extend $term
223		231
224	Called whenever the user tries to extend the selection (e.g. with a double	232	Called whenever the user tries to extend the selection (e.g. with a double
225	click) and is either supposed to return false (normal operation), or	233	click) and is either supposed to return false (normal operation), or
226	should extend the selection itelf and return true to suppress the built-in	234	should extend the selection itelf and return true to suppress the built-in
227	processing.	235	processing. This can happen multiple times, as long as the callback
		236	returns true, it will be called on every further click by the user and is
		237	supposed to enlarge the selection more and more, if possible.
228		238
229	See the F<selection> example extension.	239	See the F<selection> example extension.
230		240
231	=item on_view_change $term, $offset	241	=item on_view_change $term, $offset
232		242
…		…
263	can filter/change and output the text yourself by returning a true value	273	can filter/change and output the text yourself by returning a true value
264	and calling C<< $term->scr_add_lines >> yourself. Please note that this	274	and calling C<< $term->scr_add_lines >> yourself. Please note that this
265	might be very slow, however, as your hook is called for B<all> text being	275	might be very slow, however, as your hook is called for B<all> text being
266	output.	276	output.
267		277
		278	=item on_tt_write $term, $octets
		279
		280	Called whenever some data is written to the tty/pty and can be used to
		281	suppress or filter tty input.
		282
268	=item on_line_update $term, $row	283	=item on_line_update $term, $row
269		284
270	Called whenever a line was updated or changed. Can be used to filter	285	Called whenever a line was updated or changed. Can be used to filter
271	screen output (e.g. underline urls or other useless stuff). Only lines	286	screen output (e.g. underline urls or other useless stuff). Only lines
272	that are being shown will be filtered, and, due to performance reasons,	287	that are being shown will be filtered, and, due to performance reasons,
…		…
329		344
330	C<on_key_press> additionally receives the string rxvt-unicode would	345	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	346	output, if any, in locale-specific encoding.
332		347
333	subwindow.	348	subwindow.
334
335	=back
336
337	=head2 Variables in the C<urxvt> Package
338
339	=over 4
340
341	=item $urxvt::TERM
342
343	The current terminal. This variable stores the current C<urxvt::term>
344	object, whenever a callback/hook is executing.
345
346	=back
347
348	=head2 Functions in the C<urxvt> Package
349
350	=over 4
351
352	=item $term = new urxvt [arg...]
353
354	Creates a new terminal, very similar as if you had started it with
355	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
356	if the new instance couldn't be created. Returns C<undef> if the new
357	instance didn't initialise perl, and the terminal object otherwise. The
358	C<init> and C<start> hooks will be called during the call.
359
360	=item urxvt::fatal $errormessage
361
362	Fatally aborts execution with the given error message. Avoid at all
363	costs! The only time this is acceptable is when the terminal process
364	starts up.
365
366	=item urxvt::warn $string
367
368	Calls C<rxvt_warn> with the given string which should not include a
369	newline. The module also overwrites the C<warn> builtin with a function
370	that calls this function.
371
372	Using this function has the advantage that its output ends up in the
373	correct place, e.g. on stderr of the connecting urxvtc client.
374
375	=item $is_safe = urxvt::safe
376
377	Returns true when it is safe to do potentially unsafe things, such as
378	evaluating perl code specified by the user. This is true when urxvt was
379	started setuid or setgid.
380
381	=item $time = urxvt::NOW
382
383	Returns the "current time" (as per the event loop).
384
385	=item urxvt::CurrentTime
386
387	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
388	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
389	Button4Mask, Button5Mask, AnyModifier
390
391	Various constants for use in X calls and event processing.
392
393	=back
394
395	=head2 RENDITION
396
397	Rendition bitsets contain information about colour, font, font styles and
398	similar information for each screen cell.
399
400	The following "macros" deal with changes in rendition sets. You should
401	never just create a bitset, you should always modify an existing one,
402	as they contain important information required for correct operation of
403	rxvt-unicode.
404
405	=over 4
406
407	=item $rend = urxvt::DEFAULT_RSTYLE
408
409	Returns the default rendition, as used when the terminal is starting up or
410	being reset. Useful as a base to start when creating renditions.
411
412	=item $rend = urxvt::OVERLAY_RSTYLE
413
414	Return the rendition mask used for overlays by default.
415
416	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
417
418	Return the bit that enabled bold, italic, blink, reverse-video and
419	underline, respectively. To enable such a style, just logically OR it into
420	the bitset.
421
422	=item $foreground = urxvt::GET_BASEFG $rend
423
424	=item $background = urxvt::GET_BASEBG $rend
425
426	Return the foreground/background colour index, respectively.
427
428	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
429
430	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
431
432	Replace the foreground/background colour in the rendition mask with the
433	specified one.
434
435	=item $value = urxvt::GET_CUSTOM ($rend)
436
437	Return the "custom" value: Every rendition has 5 bits for use by
438	extensions. They can be set and changed as you like and are initially
439	zero.
440
441	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
442
443	Change the custom value.
444		349
445	=back	350	=back
446		351
447	=cut	352	=cut
448		353
…		…
457	our $VERSION = 1;	362	our $VERSION = 1;
458	our $TERM;	363	our $TERM;
459	our @HOOKNAME;	364	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	365	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	366	our %OPTION;
		367
462	our $LIBDIR;	368	our $LIBDIR;
		369	our $RESNAME;
		370	our $RESCLASS;
		371	our $RXVTNAME;
		372
		373	=head2 Variables in the C<urxvt> Package
		374
		375	=over 4
		376
		377	=item $urxvt::LIBDIR
		378
		379	The rxvt-unicode library directory, where, among other things, the perl
		380	modules and scripts are stored.
		381
		382	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		383
		384	The resource class and name rxvt-unicode uses to look up X resources.
		385
		386	=item $urxvt::RXVTNAME
		387
		388	The basename of the installed binaries, usually C<urxvt>.
		389
		390	=item $urxvt::TERM
		391
		392	The current terminal. This variable stores the current C<urxvt::term>
		393	object, whenever a callback/hook is executing.
		394
		395	=back
		396
		397	=head2 Functions in the C<urxvt> Package
		398
		399	=over 4
		400
		401	=item urxvt::fatal $errormessage
		402
		403	Fatally aborts execution with the given error message. Avoid at all
		404	costs! The only time this is acceptable is when the terminal process
		405	starts up.
		406
		407	=item urxvt::warn $string
		408
		409	Calls C<rxvt_warn> with the given string which should not include a
		410	newline. The module also overwrites the C<warn> builtin with a function
		411	that calls this function.
		412
		413	Using this function has the advantage that its output ends up in the
		414	correct place, e.g. on stderr of the connecting urxvtc client.
		415
		416	Messages have a size limit of 1023 bytes currently.
		417
		418	=item $is_safe = urxvt::safe
		419
		420	Returns true when it is safe to do potentially unsafe things, such as
		421	evaluating perl code specified by the user. This is true when urxvt was
		422	started setuid or setgid.
		423
		424	=item $time = urxvt::NOW
		425
		426	Returns the "current time" (as per the event loop).
		427
		428	=item urxvt::CurrentTime
		429
		430	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		431	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		432	Button4Mask, Button5Mask, AnyModifier
		433
		434	Various constants for use in X calls and event processing.
		435
		436	=back
		437
		438	=head2 RENDITION
		439
		440	Rendition bitsets contain information about colour, font, font styles and
		441	similar information for each screen cell.
		442
		443	The following "macros" deal with changes in rendition sets. You should
		444	never just create a bitset, you should always modify an existing one,
		445	as they contain important information required for correct operation of
		446	rxvt-unicode.
		447
		448	=over 4
		449
		450	=item $rend = urxvt::DEFAULT_RSTYLE
		451
		452	Returns the default rendition, as used when the terminal is starting up or
		453	being reset. Useful as a base to start when creating renditions.
		454
		455	=item $rend = urxvt::OVERLAY_RSTYLE
		456
		457	Return the rendition mask used for overlays by default.
		458
		459	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		460
		461	Return the bit that enabled bold, italic, blink, reverse-video and
		462	underline, respectively. To enable such a style, just logically OR it into
		463	the bitset.
		464
		465	=item $foreground = urxvt::GET_BASEFG $rend
		466
		467	=item $background = urxvt::GET_BASEBG $rend
		468
		469	Return the foreground/background colour index, respectively.
		470
		471	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		472
		473	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		474
		475	Replace the foreground/background colour in the rendition mask with the
		476	specified one.
		477
		478	=item $value = urxvt::GET_CUSTOM $rend
		479
		480	Return the "custom" value: Every rendition has 5 bits for use by
		481	extensions. They can be set and changed as you like and are initially
		482	zero.
		483
		484	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		485
		486	Change the custom value.
		487
		488	=back
		489
		490	=cut
463		491
464	BEGIN {	492	BEGIN {
465	urxvt->bootstrap;	493	urxvt->bootstrap;
466		494
467	# overwrite perl's warn	495	# overwrite perl's warn
…		…
470	$msg .= "\n"	498	$msg .= "\n"
471	unless $msg =~ /\n$/;	499	unless $msg =~ /\n$/;
472	urxvt::warn ($msg);	500	urxvt::warn ($msg);
473	};	501	};
474		502
		503	# %ENV is the original startup environment
475	delete $ENV{IFS};	504	delete $ENV{IFS};
476	delete $ENV{CDPATH};	505	delete $ENV{CDPATH};
477	delete $ENV{BASH_ENV};	506	delete $ENV{BASH_ENV};
478	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	507	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
479	}	508	}
…		…
501	open my $fh, "<:raw", $path	530	open my $fh, "<:raw", $path
502	or die "$path: $!";	531	or die "$path: $!";
503		532
504	my $source = untaint	533	my $source = untaint
505	"package $pkg; use strict; use utf8;\n"	534	"package $pkg; use strict; use utf8;\n"
506	. "use base urxvt::term::proxy::;\n"	535	. "use base urxvt::term::extension::;\n"
507	. "#line 1 \"$path\"\n{\n"	536	. "#line 1 \"$path\"\n{\n"
508	. (do { local $/; <$fh> })	537	. (do { local $/; <$fh> })
509	. "\n};\n1";	538	. "\n};\n1";
510		539
511	eval $source	540	eval $source
…		…
568	if ($@) {	597	if ($@) {
569	$TERM->ungrab; # better to lose the grab than the session	598	$TERM->ungrab; # better to lose the grab than the session
570	warn $@;	599	warn $@;
571	}	600	}
572	}	601	}
		602
		603	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		604	if $verbosity >= 11;
573	}	605	}
574		606
575	if ($htype == 1) { # DESTROY	607	if ($htype == 1) { # DESTROY
576	if (my $hook = delete $TERM->{_hook}) {	608	if (my $hook = delete $TERM->{_hook}) {
577	for my $htype (0..$#$hook) {	609	for my $htype (0..$#$hook) {
…		…
588	}	620	}
589		621
590	$retval	622	$retval
591	}	623	}
592		624
593	# urxvt::term::proxy	625	sub exec_async(@) {
		626	my $pid = fork;
594		627
		628	return
		629	if !defined $pid or $pid;
		630
		631	%ENV = %{ $TERM->env };
		632
		633	exec @_;
		634	_exit 255;
		635	}
		636
		637	# urxvt::term::extension
		638
595	package urxvt::term::proxy;	639	package urxvt::term::extension;
596		640
597	sub enable {	641	sub enable {
598	my ($self, %hook) = @_;	642	my ($self, %hook) = @_;
599	my $pkg = $self->{_pkg};	643	my $pkg = $self->{_pkg};
600		644
…		…
663		707
664	=head2 The C<urxvt::anyevent> Class	708	=head2 The C<urxvt::anyevent> Class
665		709
666	The sole purpose of this class is to deliver an interface to the	710	The sole purpose of this class is to deliver an interface to the
667	C<AnyEvent> module - any module using it will work inside urxvt without	711	C<AnyEvent> module - any module using it will work inside urxvt without
668	further work. The only exception is that you cannot wait on condition	712	further programming. The only exception is that you cannot wait on
669	variables, but non-blocking condvar use is ok. What this means is that you	713	condition variables, but non-blocking condvar use is ok. What this means
670	cannot use blocking APIs, but the non-blocking variant should work.	714	is that you cannot use blocking APIs, but the non-blocking variant should
		715	work.
671		716
672	=cut	717	=cut
673		718
674	our $VERSION = 1;	719	our $VERSION = 1;
675		720
…		…
752	$proxy->enable ($name => $ref);	797	$proxy->enable ($name => $ref);
753	}	798	}
754	}	799	}
755	}	800	}
756		801
		802	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		803
		804	Creates a new terminal, very similar as if you had started it with system
		805	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		806	hash which defines the environment of the new terminal.
		807
		808	Croaks (and probably outputs an error message) if the new instance
		809	couldn't be created. Returns C<undef> if the new instance didn't
		810	initialise perl, and the terminal object otherwise. The C<init> and
		811	C<start> hooks will be called during this call.
		812
		813	=cut
		814
		815	sub new {
		816	my ($class, $env, @args) = @_;
		817
		818	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		819	}
		820
757	=item $term->destroy	821	=item $term->destroy
758		822
759	Destroy the terminal object (close the window, free resources etc.).	823	Destroy the terminal object (close the window, free resources
		824	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		825	watchers (timers, io watchers) are still active.
760		826
761	=item $isset = $term->option ($optval[, $set])	827	=item $isset = $term->option ($optval[, $set])
762		828
763	Returns true if the option specified by C<$optval> is enabled, and	829	Returns true if the option specified by C<$optval> is enabled, and
764	optionally change it. All option values are stored by name in the hash	830	optionally change it. All option values are stored by name in the hash
…		…
814	my ($self, $name) = (shift, shift);	880	my ($self, $name) = (shift, shift);
815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	881	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
816	&urxvt::term::_resource	882	&urxvt::term::_resource
817	}	883	}
818		884
		885	=item $value = $term->x_resource ($pattern)
		886
		887	Returns the X-Resource for the given pattern, excluding the program or
		888	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		889	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		890	resource with that pattern exists.
		891
		892	This method should only be called during the C<on_start> hook, as there is
		893	only one resource database per display, and later invocations might return
		894	the wrong resources.
		895
819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	896	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820		897
821	Adds a keymap translation exactly as specified via a resource. See the	898	Adds a keymap translation exactly as specified via a resource. See the
822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	899	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823		900
…		…
838	=item ($row, $col) = $term->selection_end ([$row, $col])	915	=item ($row, $col) = $term->selection_end ([$row, $col])
839		916
840	Return the current values of the selection mark, begin or end positions,	917	Return the current values of the selection mark, begin or end positions,
841	and optionally set them to new values.	918	and optionally set them to new values.
842		919
		920	=item $term->selection_make ($eventtime[, $rectangular])
		921
		922	Tries to make a selection as set by C<selection_beg> and
		923	C<selection_end>. If C<$rectangular> is true (default: false), a
		924	rectangular selection will be made. This is the prefered function to make
		925	a selection.
		926
843	=item $success = $term->selection_grab ($eventtime)	927	=item $success = $term->selection_grab ($eventtime)
844		928
845	Try to request the primary selection from the server (for example, as set	929	Try to request the primary selection text from the server (for example, as
846	by the next method).	930	set by the next method). No visual feedback will be given. This function
		931	is mostly useful from within C<on_sel_grab> hooks.
847		932
848	=item $oldtext = $term->selection ([$newtext])	933	=item $oldtext = $term->selection ([$newtext])
849		934
850	Return the current selection text and optionally replace it by C<$newtext>.	935	Return the current selection text and optionally replace it by C<$newtext>.
851		936
…		…
944	Convert the given locale-encoded octets into a perl string.	1029	Convert the given locale-encoded octets into a perl string.
945		1030
946	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1031	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
947		1032
948	XORs the rendition values in the given span with the provided value	1033	XORs the rendition values in the given span with the provided value
949	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1034	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
950	to the selection.	1035	refresh hooks to provide effects similar to the selection.
951		1036
952	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1037	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
953		1038
954	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1039	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
955	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1040	whitespace will additionally be xored with the C<$rstyle2>, which defaults
956	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1041	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
957	it instead.	1042	it instead. Both styles I<MUST NOT> contain font styles.
958		1043
959	=item $term->scr_bell	1044	=item $term->scr_bell
960		1045
961	Ring the bell!	1046	Ring the bell!
962		1047
…		…
1022		1107
1023	=item $lines_in_scrollback = $term->nsaved	1108	=item $lines_in_scrollback = $term->nsaved
1024		1109
1025	Return various integers describing terminal characteristics.	1110	Return various integers describing terminal characteristics.
1026		1111
		1112	=item $x_display = $term->display_id
		1113
		1114	Return the DISPLAY used by rxvt-unicode.
		1115
1027	=item $lc_ctype = $term->locale	1116	=item $lc_ctype = $term->locale
1028		1117
1029	Returns the LC_CTYPE category string used by this rxvt-unicode.	1118	Returns the LC_CTYPE category string used by this rxvt-unicode.
1030		1119
1031	=item $x_display = $term->display_id	1120	=item $env = $term->env
1032		1121
1033	Return the DISPLAY used by rxvt-unicode.	1122	Returns a copy of the environment in effect for the terminal as a hashref
		1123	similar to C<\%ENV>.
		1124
		1125	=cut
		1126
		1127	sub env {
		1128	if (my $env = $_[0]->_env) {
		1129	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1130	} else {
		1131	+{ %ENV }
		1132	}
		1133	}
1034		1134
1035	=item $modifiermask = $term->ModLevel3Mask	1135	=item $modifiermask = $term->ModLevel3Mask
1036		1136
1037	=item $modifiermask = $term->ModMetaMask	1137	=item $modifiermask = $term->ModMetaMask
1038		1138
…		…
1131	Return the row number of the first/last row of the line, respectively.	1231	Return the row number of the first/last row of the line, respectively.
1132		1232
1133	=item $offset = $line->offset_of ($row, $col)	1233	=item $offset = $line->offset_of ($row, $col)
1134		1234
1135	Returns the character offset of the given row\|col pair within the logical	1235	Returns the character offset of the given row\|col pair within the logical
1136	line.	1236	line. Works for rows outside the line, too, and returns corresponding
		1237	offsets outside the string.
1137		1238
1138	=item ($row, $col) = $line->coord_of ($offset)	1239	=item ($row, $col) = $line->coord_of ($offset)
1139		1240
1140	Translates a string offset into terminal coordinates again.	1241	Translates a string offset into terminal coordinates again.
1141		1242
…		…
1278	$item->{render} \|\|= sub { $_[0]{text} };	1379	$item->{render} \|\|= sub { $_[0]{text} };
1279		1380
1280	push @{ $self->{item} }, $item;	1381	push @{ $self->{item} }, $item;
1281	}	1382	}
1282		1383
		1384	=item $popup->add_title ($title)
		1385
		1386	Adds a non-clickable title to the popup.
		1387
		1388	=cut
		1389
		1390	sub add_title {
		1391	my ($self, $title) = @_;
		1392
		1393	$self->add_item ({
		1394	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1395	text => $title,
		1396	activate => sub { },
		1397	});
		1398	}
		1399
		1400	=item $popup->add_separator ([$sepchr])
		1401
		1402	Creates a separator, optionally using the character given as C<$sepchr>.
		1403
		1404	=cut
		1405
1283	sub add_separator {	1406	sub add_separator {
1284	my ($self, $sep) = @_;	1407	my ($self, $sep) = @_;
1285		1408
1286	$sep \|\|= "=";	1409	$sep \|\|= "=";
1287		1410
…		…
1291	render => sub { $sep x $self->{term}->ncol },	1414	render => sub { $sep x $self->{term}->ncol },
1292	activate => sub { },	1415	activate => sub { },
1293	});	1416	});
1294	}	1417	}
1295		1418
1296	sub add_title {	1419	=item $popup->add_button ($text, $cb)
1297	my ($self, $title) = @_;
1298		1420
1299	$self->add_item ({	1421	Adds a clickable button to the popup. C<$cb> is called whenever it is
1300	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1422	selected.
1301	text => $title,	1423
1302	activate => sub { },	1424	=cut
1303	});
1304	}
1305		1425
1306	sub add_button {	1426	sub add_button {
1307	my ($self, $text, $cb) = @_;	1427	my ($self, $text, $cb) = @_;
1308		1428
1309	$self->add_item ({ type => "button", text => $text, activate => $cb});	1429	$self->add_item ({ type => "button", text => $text, activate => $cb});
1310	}	1430	}
		1431
		1432	=item $popup->add_toggle ($text, $cb, $initial_value)
		1433
		1434	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1435	whenever it gets toggled, with a boolean indicating its value as its first
		1436	argument.
		1437
		1438	=cut
1311		1439
1312	sub add_toggle {	1440	sub add_toggle {
1313	my ($self, $text, $cb, $value) = @_;	1441	my ($self, $text, $cb, $value) = @_;
1314		1442
1315	my $item; $item = {	1443	my $item; $item = {
1316	type => "button",	1444	type => "button",
1317	text => " $text",	1445	text => " $text",
1318	value => $value,	1446	value => $value,
1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1447	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1448	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1321	};	1449	};
1322		1450
1323	$self->add_item ($item);	1451	$self->add_item ($item);
1324	}	1452	}
		1453
		1454	=item $popup->show
		1455
		1456	Displays the popup (which is initially hidden).
		1457
		1458	=cut
1325		1459
1326	sub show {	1460	sub show {
1327	my ($self) = @_;	1461	my ($self) = @_;
1328		1462
1329	local $urxvt::popup::self = $self;	1463	local $urxvt::popup::self = $self;
1330		1464
		1465	my $env = $self->{term}->env;
		1466	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1467	delete $env->{LC_ALL};
1331	local $ENV{LC_ALL} = $self->{term}->locale;	1468	$env->{LC_CTYPE} = $self->{term}->locale;
1332		1469
		1470	urxvt::term->new ($env, $self->{term}->resource ("name"),
1333	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1471	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1334	"--transient-for" => $self->{term}->parent,	1472	"--transient-for" => $self->{term}->parent,
1335	"-display" => $self->{term}->display_id,	1473	"-display" => $self->{term}->display_id,
1336	"-pe" => "urxvt-popup")	1474	"-pe" => "urxvt-popup")
1337	or die "unable to create popup window\n";	1475	or die "unable to create popup window\n";
1338	}	1476	}
1339		1477
1340	sub DESTROY {	1478	sub DESTROY {
1341	my ($self) = @_;	1479	my ($self) = @_;
1342		1480
1343	delete $self->{term}{_destroy}{$self};	1481	delete $self->{term}{_destroy}{$self};
1344	$self->{term}->ungrab;	1482	$self->{term}->ungrab;
1345	}	1483	}
		1484
		1485	=back
1346		1486
1347	=head2 The C<urxvt::timer> Class	1487	=head2 The C<urxvt::timer> Class
1348		1488
1349	This class implements timer watchers/events. Time is represented as a	1489	This class implements timer watchers/events. Time is represented as a
1350	fractional number of seconds since the epoch. Example:	1490	fractional number of seconds since the epoch. Example:
…		…
1457		1597
1458	=item == 0 - fatal messages	1598	=item == 0 - fatal messages
1459		1599
1460	=item >= 3 - script loading and management	1600	=item >= 3 - script loading and management
1461		1601
1462	=item >=10 - all events received	1602	=item >=10 - all called hooks
		1603
		1604	=item >=11 - hook reutrn values
1463		1605
1464	=back	1606	=back
1465		1607
1466	=head1 AUTHOR	1608	=head1 AUTHOR
1467		1609

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC vs. Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC vs.
Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC