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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC vs.
Revision 1.87 by root, Thu Jan 12 05:37:34 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 and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	47	arguments, which is very convenient, too, if your F<ls> supports
		48	C<--quoting-style=shell>.
48		49
		50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
49	It also offers the following bindable event:	53	It also offers the following bindable keyboard command:
50		54
51	=over 4	55	=over 4
52		56
53	=item rot13	57	=item rot13
54		58
…		…
64	runtime.	68	runtime.
65		69
66	=item selection-popup (enabled by default)	70	=item selection-popup (enabled by default)
67		71
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	72	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	73	text into various other formats/action (such as uri unescaping, perl
		74	evalution, web-browser starting etc.), depending on content.
70		75
71	=item searchable-scrollback (enabled by default)	76	=item searchable-scrollback<hotkey> (enabled by default)
72		77
73	Adds regex search functionality to the scrollback buffer, triggered by a	78	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	79	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	suspended, C</> starts an incremental regex search, C<n> searches further,	80	input/output is suspended and a regex is displayed at the bottom of the
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	81	screen.
77	current position and C<escape> returns to the original position.	82
		83	Inputting characters appends them to the regex and continues incremental
		84	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		85	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		86	bottom. C<Escape> leaves search mode and returns to the point where search
		87	was started, while C<Enter> or C<Return> stay at the current position and
		88	additionally stores the first match in the current line into the primary
		89	selection.
78		90
79	=item digital-clock	91	=item digital-clock
80		92
81	Displays a digital clock using the built-in overlay.	93	Displays a digital clock using the built-in overlay.
82		94
83	=item mark-urls	95	=item mark-urls
84		96
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	97	Uses per-line display filtering (C<on_line_update>) to underline urls and
		98	make them clickable. When middle-clicked, the program specified in the
		99	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		100	the URL as first argument.
86		101
87	=item block-graphics-to-ascii	102	=item block-graphics-to-ascii
88		103
89	A not very useful example of filtering all text output to the terminal,	104	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	105	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	110	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	111	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	112	overlays or changes.
98		113
99	=back	114	=back
		115
		116	=head1 API DOCUMENTATION
100		117
101	=head2 General API Considerations	118	=head2 General API Considerations
102		119
103	All objects (such as terminals, time watchers etc.) are typical	120	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	121	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	134	=over 4
118		135
119	=item $text	136	=item $text
120		137
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	138	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.	139	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		140
124	=item $string	141	=item $string
125		142
126	A perl text string, with an emphasis on I<text>. It can store all unicode	143	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	144	characters and is to be distinguished with text encoded in a specific
…		…
222	=item on_sel_extend $term	239	=item on_sel_extend $term
223		240
224	Called whenever the user tries to extend the selection (e.g. with a double	241	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	242	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	243	should extend the selection itelf and return true to suppress the built-in
227	processing.	244	processing. This can happen multiple times, as long as the callback
		245	returns true, it will be called on every further click by the user and is
		246	supposed to enlarge the selection more and more, if possible.
228		247
229	See the F<selection> example extension.	248	See the F<selection> example extension.
230		249
231	=item on_view_change $term, $offset	250	=item on_view_change $term, $offset
232		251
…		…
263	can filter/change and output the text yourself by returning a true value	282	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	283	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	284	might be very slow, however, as your hook is called for B<all> text being
266	output.	285	output.
267		286
		287	=item on_tt_write $term, $octets
		288
		289	Called whenever some data is written to the tty/pty and can be used to
		290	suppress or filter tty input.
		291
268	=item on_line_update $term, $row	292	=item on_line_update $term, $row
269		293
270	Called whenever a line was updated or changed. Can be used to filter	294	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	295	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,	296	that are being shown will be filtered, and, due to performance reasons,
…		…
329		353
330	C<on_key_press> additionally receives the string rxvt-unicode would	354	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	355	output, if any, in locale-specific encoding.
332		356
333	subwindow.	357	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		358
445	=back	359	=back
446		360
447	=cut	361	=cut
448		362
…		…
457	our $VERSION = 1;	371	our $VERSION = 1;
458	our $TERM;	372	our $TERM;
459	our @HOOKNAME;	373	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	374	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	375	our %OPTION;
		376
462	our $LIBDIR;	377	our $LIBDIR;
		378	our $RESNAME;
		379	our $RESCLASS;
		380	our $RXVTNAME;
		381
		382	=head2 Variables in the C<urxvt> Package
		383
		384	=over 4
		385
		386	=item $urxvt::LIBDIR
		387
		388	The rxvt-unicode library directory, where, among other things, the perl
		389	modules and scripts are stored.
		390
		391	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		392
		393	The resource class and name rxvt-unicode uses to look up X resources.
		394
		395	=item $urxvt::RXVTNAME
		396
		397	The basename of the installed binaries, usually C<urxvt>.
		398
		399	=item $urxvt::TERM
		400
		401	The current terminal. This variable stores the current C<urxvt::term>
		402	object, whenever a callback/hook is executing.
		403
		404	=back
		405
		406	=head2 Functions in the C<urxvt> Package
		407
		408	=over 4
		409
		410	=item urxvt::fatal $errormessage
		411
		412	Fatally aborts execution with the given error message. Avoid at all
		413	costs! The only time this is acceptable is when the terminal process
		414	starts up.
		415
		416	=item urxvt::warn $string
		417
		418	Calls C<rxvt_warn> with the given string which should not include a
		419	newline. The module also overwrites the C<warn> builtin with a function
		420	that calls this function.
		421
		422	Using this function has the advantage that its output ends up in the
		423	correct place, e.g. on stderr of the connecting urxvtc client.
		424
		425	Messages have a size limit of 1023 bytes currently.
		426
		427	=item $is_safe = urxvt::safe
		428
		429	Returns true when it is safe to do potentially unsafe things, such as
		430	evaluating perl code specified by the user. This is true when urxvt was
		431	started setuid or setgid.
		432
		433	=item $time = urxvt::NOW
		434
		435	Returns the "current time" (as per the event loop).
		436
		437	=item urxvt::CurrentTime
		438
		439	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		440	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		441	Button4Mask, Button5Mask, AnyModifier
		442
		443	Various constants for use in X calls and event processing.
		444
		445	=back
		446
		447	=head2 RENDITION
		448
		449	Rendition bitsets contain information about colour, font, font styles and
		450	similar information for each screen cell.
		451
		452	The following "macros" deal with changes in rendition sets. You should
		453	never just create a bitset, you should always modify an existing one,
		454	as they contain important information required for correct operation of
		455	rxvt-unicode.
		456
		457	=over 4
		458
		459	=item $rend = urxvt::DEFAULT_RSTYLE
		460
		461	Returns the default rendition, as used when the terminal is starting up or
		462	being reset. Useful as a base to start when creating renditions.
		463
		464	=item $rend = urxvt::OVERLAY_RSTYLE
		465
		466	Return the rendition mask used for overlays by default.
		467
		468	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		469
		470	Return the bit that enabled bold, italic, blink, reverse-video and
		471	underline, respectively. To enable such a style, just logically OR it into
		472	the bitset.
		473
		474	=item $foreground = urxvt::GET_BASEFG $rend
		475
		476	=item $background = urxvt::GET_BASEBG $rend
		477
		478	Return the foreground/background colour index, respectively.
		479
		480	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		481
		482	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		483
		484	Replace the foreground/background colour in the rendition mask with the
		485	specified one.
		486
		487	=item $value = urxvt::GET_CUSTOM $rend
		488
		489	Return the "custom" value: Every rendition has 5 bits for use by
		490	extensions. They can be set and changed as you like and are initially
		491	zero.
		492
		493	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		494
		495	Change the custom value.
		496
		497	=back
		498
		499	=cut
463		500
464	BEGIN {	501	BEGIN {
465	urxvt->bootstrap;	502	urxvt->bootstrap;
466		503
467	# overwrite perl's warn	504	# overwrite perl's warn
…		…
470	$msg .= "\n"	507	$msg .= "\n"
471	unless $msg =~ /\n$/;	508	unless $msg =~ /\n$/;
472	urxvt::warn ($msg);	509	urxvt::warn ($msg);
473	};	510	};
474		511
		512	# %ENV is the original startup environment
475	delete $ENV{IFS};	513	delete $ENV{IFS};
476	delete $ENV{CDPATH};	514	delete $ENV{CDPATH};
477	delete $ENV{BASH_ENV};	515	delete $ENV{BASH_ENV};
478	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	516	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
479	}	517	}
…		…
501	open my $fh, "<:raw", $path	539	open my $fh, "<:raw", $path
502	or die "$path: $!";	540	or die "$path: $!";
503		541
504	my $source = untaint	542	my $source = untaint
505	"package $pkg; use strict; use utf8;\n"	543	"package $pkg; use strict; use utf8;\n"
506	. "use base urxvt::term::proxy::;\n"	544	. "use base urxvt::term::extension::;\n"
507	. "#line 1 \"$path\"\n{\n"	545	. "#line 1 \"$path\"\n{\n"
508	. (do { local $/; <$fh> })	546	. (do { local $/; <$fh> })
509	. "\n};\n1";	547	. "\n};\n1";
510		548
511	eval $source	549	eval $source
…		…
568	if ($@) {	606	if ($@) {
569	$TERM->ungrab; # better to lose the grab than the session	607	$TERM->ungrab; # better to lose the grab than the session
570	warn $@;	608	warn $@;
571	}	609	}
572	}	610	}
		611
		612	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		613	if $verbosity >= 11;
573	}	614	}
574		615
575	if ($htype == 1) { # DESTROY	616	if ($htype == 1) { # DESTROY
576	if (my $hook = delete $TERM->{_hook}) {	617	if (my $hook = delete $TERM->{_hook}) {
577	for my $htype (0..$#$hook) {	618	for my $htype (0..$#$hook) {
…		…
588	}	629	}
589		630
590	$retval	631	$retval
591	}	632	}
592		633
593	# urxvt::term::proxy	634	sub exec_async(@) {
		635	my $pid = fork;
594		636
		637	return
		638	if !defined $pid or $pid;
		639
		640	%ENV = %{ $TERM->env };
		641
		642	exec @_;
		643	_exit 255;
		644	}
		645
		646	# urxvt::term::extension
		647
595	package urxvt::term::proxy;	648	package urxvt::term::extension;
596		649
597	sub enable {	650	sub enable {
598	my ($self, %hook) = @_;	651	my ($self, %hook) = @_;
599	my $pkg = $self->{_pkg};	652	my $pkg = $self->{_pkg};
600		653
…		…
663		716
664	=head2 The C<urxvt::anyevent> Class	717	=head2 The C<urxvt::anyevent> Class
665		718
666	The sole purpose of this class is to deliver an interface to the	719	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	720	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	721	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	722	condition variables, but non-blocking condvar use is ok. What this means
670	cannot use blocking APIs, but the non-blocking variant should work.	723	is that you cannot use blocking APIs, but the non-blocking variant should
		724	work.
671		725
672	=cut	726	=cut
673		727
674	our $VERSION = 1;	728	our $VERSION = 1;
675		729
…		…
752	$proxy->enable ($name => $ref);	806	$proxy->enable ($name => $ref);
753	}	807	}
754	}	808	}
755	}	809	}
756		810
		811	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		812
		813	Creates a new terminal, very similar as if you had started it with system
		814	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		815	hash which defines the environment of the new terminal.
		816
		817	Croaks (and probably outputs an error message) if the new instance
		818	couldn't be created. Returns C<undef> if the new instance didn't
		819	initialise perl, and the terminal object otherwise. The C<init> and
		820	C<start> hooks will be called during this call.
		821
		822	=cut
		823
		824	sub new {
		825	my ($class, $env, @args) = @_;
		826
		827	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		828	}
		829
757	=item $term->destroy	830	=item $term->destroy
758		831
759	Destroy the terminal object (close the window, free resources etc.).	832	Destroy the terminal object (close the window, free resources
		833	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		834	watchers (timers, io watchers) are still active.
760		835
761	=item $isset = $term->option ($optval[, $set])	836	=item $isset = $term->option ($optval[, $set])
762		837
763	Returns true if the option specified by C<$optval> is enabled, and	838	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	839	optionally change it. All option values are stored by name in the hash
…		…
814	my ($self, $name) = (shift, shift);	889	my ($self, $name) = (shift, shift);
815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	890	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
816	&urxvt::term::_resource	891	&urxvt::term::_resource
817	}	892	}
818		893
		894	=item $value = $term->x_resource ($pattern)
		895
		896	Returns the X-Resource for the given pattern, excluding the program or
		897	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		898	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		899	resource with that pattern exists.
		900
		901	This method should only be called during the C<on_start> hook, as there is
		902	only one resource database per display, and later invocations might return
		903	the wrong resources.
		904
819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	905	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820		906
821	Adds a keymap translation exactly as specified via a resource. See the	907	Adds a keymap translation exactly as specified via a resource. See the
822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	908	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823		909
…		…
838	=item ($row, $col) = $term->selection_end ([$row, $col])	924	=item ($row, $col) = $term->selection_end ([$row, $col])
839		925
840	Return the current values of the selection mark, begin or end positions,	926	Return the current values of the selection mark, begin or end positions,
841	and optionally set them to new values.	927	and optionally set them to new values.
842		928
		929	=item $term->selection_make ($eventtime[, $rectangular])
		930
		931	Tries to make a selection as set by C<selection_beg> and
		932	C<selection_end>. If C<$rectangular> is true (default: false), a
		933	rectangular selection will be made. This is the prefered function to make
		934	a selection.
		935
843	=item $success = $term->selection_grab ($eventtime)	936	=item $success = $term->selection_grab ($eventtime)
844		937
845	Try to request the primary selection from the server (for example, as set	938	Try to request the primary selection text from the server (for example, as
846	by the next method).	939	set by the next method). No visual feedback will be given. This function
		940	is mostly useful from within C<on_sel_grab> hooks.
847		941
848	=item $oldtext = $term->selection ([$newtext])	942	=item $oldtext = $term->selection ([$newtext])
849		943
850	Return the current selection text and optionally replace it by C<$newtext>.	944	Return the current selection text and optionally replace it by C<$newtext>.
851		945
…		…
941		1035
942	=item $string = $term->locale_decode ($octets)	1036	=item $string = $term->locale_decode ($octets)
943		1037
944	Convert the given locale-encoded octets into a perl string.	1038	Convert the given locale-encoded octets into a perl string.
945		1039
		1040	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1041
		1042	XORs the rendition values in the given span with the provided value
		1043	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1044	refresh hooks to provide effects similar to the selection.
		1045
		1046	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1047
		1048	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1049	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1050	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1051	it instead. Both styles I<MUST NOT> contain font styles.
		1052
946	=item $term->scr_bell	1053	=item $term->scr_bell
947		1054
948	Ring the bell!	1055	Ring the bell!
949		1056
950	=item $term->scr_add_lines ($string)	1057	=item $term->scr_add_lines ($string)
…		…
1009		1116
1010	=item $lines_in_scrollback = $term->nsaved	1117	=item $lines_in_scrollback = $term->nsaved
1011		1118
1012	Return various integers describing terminal characteristics.	1119	Return various integers describing terminal characteristics.
1013		1120
		1121	=item $x_display = $term->display_id
		1122
		1123	Return the DISPLAY used by rxvt-unicode.
		1124
1014	=item $lc_ctype = $term->locale	1125	=item $lc_ctype = $term->locale
1015		1126
1016	Returns the LC_CTYPE category string used by this rxvt-unicode.	1127	Returns the LC_CTYPE category string used by this rxvt-unicode.
1017		1128
1018	=item $x_display = $term->display_id	1129	=item $env = $term->env
1019		1130
1020	Return the DISPLAY used by rxvt-unicode.	1131	Returns a copy of the environment in effect for the terminal as a hashref
		1132	similar to C<\%ENV>.
		1133
		1134	=cut
		1135
		1136	sub env {
		1137	if (my $env = $_[0]->_env) {
		1138	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1139	} else {
		1140	+{ %ENV }
		1141	}
		1142	}
1021		1143
1022	=item $modifiermask = $term->ModLevel3Mask	1144	=item $modifiermask = $term->ModLevel3Mask
1023		1145
1024	=item $modifiermask = $term->ModMetaMask	1146	=item $modifiermask = $term->ModMetaMask
1025		1147
…		…
1118	Return the row number of the first/last row of the line, respectively.	1240	Return the row number of the first/last row of the line, respectively.
1119		1241
1120	=item $offset = $line->offset_of ($row, $col)	1242	=item $offset = $line->offset_of ($row, $col)
1121		1243
1122	Returns the character offset of the given row\|col pair within the logical	1244	Returns the character offset of the given row\|col pair within the logical
1123	line.	1245	line. Works for rows outside the line, too, and returns corresponding
		1246	offsets outside the string.
1124		1247
1125	=item ($row, $col) = $line->coord_of ($offset)	1248	=item ($row, $col) = $line->coord_of ($offset)
1126		1249
1127	Translates a string offset into terminal coordinates again.	1250	Translates a string offset into terminal coordinates again.
1128		1251
…		…
1265	$item->{render} \|\|= sub { $_[0]{text} };	1388	$item->{render} \|\|= sub { $_[0]{text} };
1266		1389
1267	push @{ $self->{item} }, $item;	1390	push @{ $self->{item} }, $item;
1268	}	1391	}
1269		1392
		1393	=item $popup->add_title ($title)
		1394
		1395	Adds a non-clickable title to the popup.
		1396
		1397	=cut
		1398
		1399	sub add_title {
		1400	my ($self, $title) = @_;
		1401
		1402	$self->add_item ({
		1403	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1404	text => $title,
		1405	activate => sub { },
		1406	});
		1407	}
		1408
		1409	=item $popup->add_separator ([$sepchr])
		1410
		1411	Creates a separator, optionally using the character given as C<$sepchr>.
		1412
		1413	=cut
		1414
1270	sub add_separator {	1415	sub add_separator {
1271	my ($self, $sep) = @_;	1416	my ($self, $sep) = @_;
1272		1417
1273	$sep \|\|= "=";	1418	$sep \|\|= "=";
1274		1419
…		…
1278	render => sub { $sep x $self->{term}->ncol },	1423	render => sub { $sep x $self->{term}->ncol },
1279	activate => sub { },	1424	activate => sub { },
1280	});	1425	});
1281	}	1426	}
1282		1427
1283	sub add_title {	1428	=item $popup->add_button ($text, $cb)
1284	my ($self, $title) = @_;
1285		1429
1286	$self->add_item ({	1430	Adds a clickable button to the popup. C<$cb> is called whenever it is
1287	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1431	selected.
1288	text => $title,	1432
1289	activate => sub { },	1433	=cut
1290	});
1291	}
1292		1434
1293	sub add_button {	1435	sub add_button {
1294	my ($self, $text, $cb) = @_;	1436	my ($self, $text, $cb) = @_;
1295		1437
1296	$self->add_item ({ type => "button", text => $text, activate => $cb});	1438	$self->add_item ({ type => "button", text => $text, activate => $cb});
1297	}	1439	}
		1440
		1441	=item $popup->add_toggle ($text, $cb, $initial_value)
		1442
		1443	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1444	whenever it gets toggled, with a boolean indicating its value as its first
		1445	argument.
		1446
		1447	=cut
1298		1448
1299	sub add_toggle {	1449	sub add_toggle {
1300	my ($self, $text, $cb, $value) = @_;	1450	my ($self, $text, $cb, $value) = @_;
1301		1451
1302	my $item; $item = {	1452	my $item; $item = {
1303	type => "button",	1453	type => "button",
1304	text => " $text",	1454	text => " $text",
1305	value => $value,	1455	value => $value,
1306	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1456	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1307	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1457	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1308	};	1458	};
1309		1459
1310	$self->add_item ($item);	1460	$self->add_item ($item);
1311	}	1461	}
		1462
		1463	=item $popup->show
		1464
		1465	Displays the popup (which is initially hidden).
		1466
		1467	=cut
1312		1468
1313	sub show {	1469	sub show {
1314	my ($self) = @_;	1470	my ($self) = @_;
1315		1471
1316	local $urxvt::popup::self = $self;	1472	local $urxvt::popup::self = $self;
1317		1473
		1474	my $env = $self->{term}->env;
		1475	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1476	delete $env->{LC_ALL};
1318	local $ENV{LC_ALL} = $self->{term}->locale;	1477	$env->{LC_CTYPE} = $self->{term}->locale;
1319		1478
		1479	urxvt::term->new ($env, $self->{term}->resource ("name"),
1320	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1480	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1321	"--transient-for" => $self->{term}->parent,	1481	"--transient-for" => $self->{term}->parent,
1322	"-display" => $self->{term}->display_id,	1482	"-display" => $self->{term}->display_id,
1323	"-pe" => "urxvt-popup")	1483	"-pe" => "urxvt-popup")
1324	or die "unable to create popup window\n";	1484	or die "unable to create popup window\n";
1325	}	1485	}
1326		1486
1327	sub DESTROY {	1487	sub DESTROY {
1328	my ($self) = @_;	1488	my ($self) = @_;
1329		1489
1330	delete $self->{term}{_destroy}{$self};	1490	delete $self->{term}{_destroy}{$self};
1331	$self->{term}->ungrab;	1491	$self->{term}->ungrab;
1332	}	1492	}
		1493
		1494	=back
1333		1495
1334	=head2 The C<urxvt::timer> Class	1496	=head2 The C<urxvt::timer> Class
1335		1497
1336	This class implements timer watchers/events. Time is represented as a	1498	This class implements timer watchers/events. Time is represented as a
1337	fractional number of seconds since the epoch. Example:	1499	fractional number of seconds since the epoch. Example:
…		…
1444		1606
1445	=item == 0 - fatal messages	1607	=item == 0 - fatal messages
1446		1608
1447	=item >= 3 - script loading and management	1609	=item >= 3 - script loading and management
1448		1610
1449	=item >=10 - all events received	1611	=item >=10 - all called hooks
		1612
		1613	=item >=11 - hook reutrn values
1450		1614
1451	=back	1615	=back
1452		1616
1453	=head1 AUTHOR	1617	=head1 AUTHOR
1454		1618

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC vs. Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC vs.
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC