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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.88 by root, Thu Jan 12 12:05:28 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
49	It also offers the following bindable event:	50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
		53	The selection works by trying to match a number of regexes and displaying
		54	them in increasing order of length. You can add your own regexes by
		55	specifying resources of the form:
		56
		57	URxvt.selection.pattern-0: perl-regex
		58	URxvt.selection.pattern-1: perl-regex
		59	...
		60
		61	The index number (0, 1...) must not have any holes, and each regex must
		62	contain at least one pair of capturing parentheses, which will be used for
		63	the match. For example, the followign adds a regex that matches everything
		64	between two vertical bars:
		65
		66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		67
		68	You can look at the source of the selection extension to see more
		69	interesting uses, such as parsing a line from beginning to end.
		70
		71	This extension also offers the following bindable keyboard command:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
…		…
64	runtime.	86	runtime.
65		87
66	=item selection-popup (enabled by default)	88	=item selection-popup (enabled by default)
67		89
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
70		93
71	=item searchable-scrollback<hotkey> (enabled by default)	94	=item searchable-scrollback<hotkey> (enabled by default)
72		95
73	Adds regex search functionality to the scrollback buffer, triggered	96	Adds regex search functionality to the scrollback buffer, triggered
74	by a hotkey (default: C<M-s>). When in search mode, normal terminal	97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	input/output is suspended.	98	input/output is suspended and a regex is displayed at the bottom of the
		99	screen.
76		100
77	C</> starts an incremental regex search, C<n> searches further, C<p> or	101	Inputting characters appends them to the regex and continues incremental
78	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
79	history, C<enter> leaves search mode at the current position and C<escape>	103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
80	returns to the original position.	104	bottom. C<Escape> leaves search mode and returns to the point where search
		105	was started, while C<Enter> or C<Return> stay at the current position and
		106	additionally stores the first match in the current line into the primary
		107	selection.
81		108
82	=item digital-clock	109	=item selection-autotransform
83		110
84	Displays a digital clock using the built-in overlay.	111	This selection allows you to do automatic transforms on a selection
		112	whenever a selection is made.
		113
		114	It works by specifying perl snippets (most useful is a single C<s///>
		115	operator) that modify C<$_> as resources:
		116
		117	URxvt.selection-autotransform.0: transform
		118	URxvt.selection-autotransform.1: transform
		119	...
		120
		121	For example, the following will transform selections of the form
		122	C<word:number> into C<vi +$number $word>:
		123
		124	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/
		125
		126	And this example matches the same,but replaces it with vi-commands you can
		127	paste directory into your (vi :) editor:
		128
		129	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/
85		130
86	=item mark-urls	131	=item mark-urls
87		132
88	Uses per-line display filtering (C<on_line_update>) to underline urls.	133	Uses per-line display filtering (C<on_line_update>) to underline urls and
		134	make them clickable. When middle-clicked, the program specified in the
		135	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		136	the URL as first argument.
89		137
90	=item block-graphics-to-ascii	138	=item block-graphics-to-ascii
91		139
92	A not very useful example of filtering all text output to the terminal,	140	A not very useful example of filtering all text output to the terminal,
93	by replacing all line-drawing characters (U+2500 .. U+259F) by a	141	by replacing all line-drawing characters (U+2500 .. U+259F) by a
94	similar-looking ascii character.	142	similar-looking ascii character.
95		143
		144	=item digital-clock
		145
		146	Displays a digital clock using the built-in overlay.
		147
96	=item example-refresh-hooks	148	=item example-refresh-hooks
97		149
98	Displays a very simple digital clock in the upper right corner of the	150	Displays a very simple digital clock in the upper right corner of the
99	window. Illustrates overwriting the refresh callbacks to create your own	151	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	152	overlays or changes.
101		153
102	=back	154	=back
		155
		156	=head1 API DOCUMENTATION
103		157
104	=head2 General API Considerations	158	=head2 General API Considerations
105		159
106	All objects (such as terminals, time watchers etc.) are typical	160	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	161	reference-to-hash objects. The hash can be used to store anything you
…		…
120	=over 4	174	=over 4
121		175
122	=item $text	176	=item $text
123		177
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	178	Rxvt-unicodes special way of encoding text, where one "unicode" character
125	always represents one screen cell. See L<row_t> for a discussion of this format.	179	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		180
127	=item $string	181	=item $string
128		182
129	A perl text string, with an emphasis on I<text>. It can store all unicode	183	A perl text string, with an emphasis on I<text>. It can store all unicode
130	characters and is to be distinguished with text encoded in a specific	184	characters and is to be distinguished with text encoded in a specific
…		…
225	=item on_sel_extend $term	279	=item on_sel_extend $term
226		280
227	Called whenever the user tries to extend the selection (e.g. with a double	281	Called whenever the user tries to extend the selection (e.g. with a double
228	click) and is either supposed to return false (normal operation), or	282	click) and is either supposed to return false (normal operation), or
229	should extend the selection itelf and return true to suppress the built-in	283	should extend the selection itelf and return true to suppress the built-in
230	processing.	284	processing. This can happen multiple times, as long as the callback
		285	returns true, it will be called on every further click by the user and is
		286	supposed to enlarge the selection more and more, if possible.
231		287
232	See the F<selection> example extension.	288	See the F<selection> example extension.
233		289
234	=item on_view_change $term, $offset	290	=item on_view_change $term, $offset
235		291
…		…
340		396
341	subwindow.	397	subwindow.
342		398
343	=back	399	=back
344		400
345	=head2 Variables in the C<urxvt> Package
346
347	=over 4
348
349	=item $urxvt::TERM
350
351	The current terminal. This variable stores the current C<urxvt::term>
352	object, whenever a callback/hook is executing.
353
354	=back
355
356	=head2 Functions in the C<urxvt> Package
357
358	=over 4
359
360	=item $term = new urxvt [arg...]
361
362	Creates a new terminal, very similar as if you had started it with
363	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
364	if the new instance couldn't be created. Returns C<undef> if the new
365	instance didn't initialise perl, and the terminal object otherwise. The
366	C<init> and C<start> hooks will be called during the call.
367
368	=item urxvt::fatal $errormessage
369
370	Fatally aborts execution with the given error message. Avoid at all
371	costs! The only time this is acceptable is when the terminal process
372	starts up.
373
374	=item urxvt::warn $string
375
376	Calls C<rxvt_warn> with the given string which should not include a
377	newline. The module also overwrites the C<warn> builtin with a function
378	that calls this function.
379
380	Using this function has the advantage that its output ends up in the
381	correct place, e.g. on stderr of the connecting urxvtc client.
382
383	=item $is_safe = urxvt::safe
384
385	Returns true when it is safe to do potentially unsafe things, such as
386	evaluating perl code specified by the user. This is true when urxvt was
387	started setuid or setgid.
388
389	=item $time = urxvt::NOW
390
391	Returns the "current time" (as per the event loop).
392
393	=item urxvt::CurrentTime
394
395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
397	Button4Mask, Button5Mask, AnyModifier
398
399	Various constants for use in X calls and event processing.
400
401	=back
402
403	=head2 RENDITION
404
405	Rendition bitsets contain information about colour, font, font styles and
406	similar information for each screen cell.
407
408	The following "macros" deal with changes in rendition sets. You should
409	never just create a bitset, you should always modify an existing one,
410	as they contain important information required for correct operation of
411	rxvt-unicode.
412
413	=over 4
414
415	=item $rend = urxvt::DEFAULT_RSTYLE
416
417	Returns the default rendition, as used when the terminal is starting up or
418	being reset. Useful as a base to start when creating renditions.
419
420	=item $rend = urxvt::OVERLAY_RSTYLE
421
422	Return the rendition mask used for overlays by default.
423
424	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
425
426	Return the bit that enabled bold, italic, blink, reverse-video and
427	underline, respectively. To enable such a style, just logically OR it into
428	the bitset.
429
430	=item $foreground = urxvt::GET_BASEFG $rend
431
432	=item $background = urxvt::GET_BASEBG $rend
433
434	Return the foreground/background colour index, respectively.
435
436	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
437
438	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
439
440	Replace the foreground/background colour in the rendition mask with the
441	specified one.
442
443	=item $value = urxvt::GET_CUSTOM ($rend)
444
445	Return the "custom" value: Every rendition has 5 bits for use by
446	extensions. They can be set and changed as you like and are initially
447	zero.
448
449	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
450
451	Change the custom value.
452
453	=back
454
455	=cut	401	=cut
456		402
457	package urxvt;	403	package urxvt;
458		404
459	use utf8;	405	use utf8;
…		…
470		416
471	our $LIBDIR;	417	our $LIBDIR;
472	our $RESNAME;	418	our $RESNAME;
473	our $RESCLASS;	419	our $RESCLASS;
474	our $RXVTNAME;	420	our $RXVTNAME;
		421
		422	=head2 Variables in the C<urxvt> Package
		423
		424	=over 4
		425
		426	=item $urxvt::LIBDIR
		427
		428	The rxvt-unicode library directory, where, among other things, the perl
		429	modules and scripts are stored.
		430
		431	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		432
		433	The resource class and name rxvt-unicode uses to look up X resources.
		434
		435	=item $urxvt::RXVTNAME
		436
		437	The basename of the installed binaries, usually C<urxvt>.
		438
		439	=item $urxvt::TERM
		440
		441	The current terminal. This variable stores the current C<urxvt::term>
		442	object, whenever a callback/hook is executing.
		443
		444	=back
		445
		446	=head2 Functions in the C<urxvt> Package
		447
		448	=over 4
		449
		450	=item urxvt::fatal $errormessage
		451
		452	Fatally aborts execution with the given error message. Avoid at all
		453	costs! The only time this is acceptable is when the terminal process
		454	starts up.
		455
		456	=item urxvt::warn $string
		457
		458	Calls C<rxvt_warn> with the given string which should not include a
		459	newline. The module also overwrites the C<warn> builtin with a function
		460	that calls this function.
		461
		462	Using this function has the advantage that its output ends up in the
		463	correct place, e.g. on stderr of the connecting urxvtc client.
		464
		465	Messages have a size limit of 1023 bytes currently.
		466
		467	=item $is_safe = urxvt::safe
		468
		469	Returns true when it is safe to do potentially unsafe things, such as
		470	evaluating perl code specified by the user. This is true when urxvt was
		471	started setuid or setgid.
		472
		473	=item $time = urxvt::NOW
		474
		475	Returns the "current time" (as per the event loop).
		476
		477	=item urxvt::CurrentTime
		478
		479	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		480	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		481	Button4Mask, Button5Mask, AnyModifier
		482
		483	Various constants for use in X calls and event processing.
		484
		485	=back
		486
		487	=head2 RENDITION
		488
		489	Rendition bitsets contain information about colour, font, font styles and
		490	similar information for each screen cell.
		491
		492	The following "macros" deal with changes in rendition sets. You should
		493	never just create a bitset, you should always modify an existing one,
		494	as they contain important information required for correct operation of
		495	rxvt-unicode.
		496
		497	=over 4
		498
		499	=item $rend = urxvt::DEFAULT_RSTYLE
		500
		501	Returns the default rendition, as used when the terminal is starting up or
		502	being reset. Useful as a base to start when creating renditions.
		503
		504	=item $rend = urxvt::OVERLAY_RSTYLE
		505
		506	Return the rendition mask used for overlays by default.
		507
		508	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		509
		510	Return the bit that enabled bold, italic, blink, reverse-video and
		511	underline, respectively. To enable such a style, just logically OR it into
		512	the bitset.
		513
		514	=item $foreground = urxvt::GET_BASEFG $rend
		515
		516	=item $background = urxvt::GET_BASEBG $rend
		517
		518	Return the foreground/background colour index, respectively.
		519
		520	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		521
		522	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		523
		524	Replace the foreground/background colour in the rendition mask with the
		525	specified one.
		526
		527	=item $value = urxvt::GET_CUSTOM $rend
		528
		529	Return the "custom" value: Every rendition has 5 bits for use by
		530	extensions. They can be set and changed as you like and are initially
		531	zero.
		532
		533	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		534
		535	Change the custom value.
		536
		537	=back
		538
		539	=cut
475		540
476	BEGIN {	541	BEGIN {
477	urxvt->bootstrap;	542	urxvt->bootstrap;
478		543
479	# overwrite perl's warn	544	# overwrite perl's warn
…		…
482	$msg .= "\n"	547	$msg .= "\n"
483	unless $msg =~ /\n$/;	548	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	549	urxvt::warn ($msg);
485	};	550	};
486		551
		552	# %ENV is the original startup environment
487	delete $ENV{IFS};	553	delete $ENV{IFS};
488	delete $ENV{CDPATH};	554	delete $ENV{CDPATH};
489	delete $ENV{BASH_ENV};	555	delete $ENV{BASH_ENV};
490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	556	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
491	}	557	}
…		…
580	if ($@) {	646	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	647	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	648	warn $@;
583	}	649	}
584	}	650	}
		651
		652	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		653	if $verbosity >= 11;
585	}	654	}
586		655
587	if ($htype == 1) { # DESTROY	656	if ($htype == 1) { # DESTROY
588	if (my $hook = delete $TERM->{_hook}) {	657	if (my $hook = delete $TERM->{_hook}) {
589	for my $htype (0..$#$hook) {	658	for my $htype (0..$#$hook) {
…		…
600	}	669	}
601		670
602	$retval	671	$retval
603	}	672	}
604		673
		674	sub exec_async(@) {
		675	my $pid = fork;
		676
		677	return
		678	if !defined $pid or $pid;
		679
		680	%ENV = %{ $TERM->env };
		681
		682	exec @_;
		683	_exit 255;
		684	}
		685
605	# urxvt::term::extension	686	# urxvt::term::extension
606		687
607	package urxvt::term::extension;	688	package urxvt::term::extension;
608		689
609	sub enable {	690	sub enable {
…		…
675		756
676	=head2 The C<urxvt::anyevent> Class	757	=head2 The C<urxvt::anyevent> Class
677		758
678	The sole purpose of this class is to deliver an interface to the	759	The sole purpose of this class is to deliver an interface to the
679	C<AnyEvent> module - any module using it will work inside urxvt without	760	C<AnyEvent> module - any module using it will work inside urxvt without
680	further work. The only exception is that you cannot wait on condition	761	further programming. The only exception is that you cannot wait on
681	variables, but non-blocking condvar use is ok. What this means is that you	762	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	763	is that you cannot use blocking APIs, but the non-blocking variant should
		764	work.
683		765
684	=cut	766	=cut
685		767
686	our $VERSION = 1;	768	our $VERSION = 1;
687		769
…		…
764	$proxy->enable ($name => $ref);	846	$proxy->enable ($name => $ref);
765	}	847	}
766	}	848	}
767	}	849	}
768		850
		851	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		852
		853	Creates a new terminal, very similar as if you had started it with system
		854	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		855	hash which defines the environment of the new terminal.
		856
		857	Croaks (and probably outputs an error message) if the new instance
		858	couldn't be created. Returns C<undef> if the new instance didn't
		859	initialise perl, and the terminal object otherwise. The C<init> and
		860	C<start> hooks will be called during this call.
		861
		862	=cut
		863
		864	sub new {
		865	my ($class, $env, @args) = @_;
		866
		867	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		868	}
		869
769	=item $term->destroy	870	=item $term->destroy
770		871
771	Destroy the terminal object (close the window, free resources etc.).	872	Destroy the terminal object (close the window, free resources
		873	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		874	watchers (timers, io watchers) are still active.
772		875
773	=item $isset = $term->option ($optval[, $set])	876	=item $isset = $term->option ($optval[, $set])
774		877
775	Returns true if the option specified by C<$optval> is enabled, and	878	Returns true if the option specified by C<$optval> is enabled, and
776	optionally change it. All option values are stored by name in the hash	879	optionally change it. All option values are stored by name in the hash
…		…
826	my ($self, $name) = (shift, shift);	929	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	930	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	931	&urxvt::term::_resource
829	}	932	}
830		933
		934	=item $value = $term->x_resource ($pattern)
		935
		936	Returns the X-Resource for the given pattern, excluding the program or
		937	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		938	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		939	resource with that pattern exists.
		940
		941	This method should only be called during the C<on_start> hook, as there is
		942	only one resource database per display, and later invocations might return
		943	the wrong resources.
		944
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	945	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		946
833	Adds a keymap translation exactly as specified via a resource. See the	947	Adds a keymap translation exactly as specified via a resource. See the
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	948	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835		949
…		…
850	=item ($row, $col) = $term->selection_end ([$row, $col])	964	=item ($row, $col) = $term->selection_end ([$row, $col])
851		965
852	Return the current values of the selection mark, begin or end positions,	966	Return the current values of the selection mark, begin or end positions,
853	and optionally set them to new values.	967	and optionally set them to new values.
854		968
		969	=item $term->selection_make ($eventtime[, $rectangular])
		970
		971	Tries to make a selection as set by C<selection_beg> and
		972	C<selection_end>. If C<$rectangular> is true (default: false), a
		973	rectangular selection will be made. This is the prefered function to make
		974	a selection.
		975
855	=item $success = $term->selection_grab ($eventtime)	976	=item $success = $term->selection_grab ($eventtime)
856		977
857	Try to request the primary selection from the server (for example, as set	978	Try to request the primary selection text from the server (for example, as
858	by the next method).	979	set by the next method). No visual feedback will be given. This function
		980	is mostly useful from within C<on_sel_grab> hooks.
859		981
860	=item $oldtext = $term->selection ([$newtext])	982	=item $oldtext = $term->selection ([$newtext])
861		983
862	Return the current selection text and optionally replace it by C<$newtext>.	984	Return the current selection text and optionally replace it by C<$newtext>.
863		985
…		…
956	Convert the given locale-encoded octets into a perl string.	1078	Convert the given locale-encoded octets into a perl string.
957		1079
958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1080	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959		1081
960	XORs the rendition values in the given span with the provided value	1082	XORs the rendition values in the given span with the provided value
961	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1083	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962	to the selection.	1084	refresh hooks to provide effects similar to the selection.
963		1085
964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1086	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965		1087
966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1088	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1089	whitespace will additionally be xored with the C<$rstyle2>, which defaults
968	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1090	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
969	it instead.	1091	it instead. Both styles I<MUST NOT> contain font styles.
970		1092
971	=item $term->scr_bell	1093	=item $term->scr_bell
972		1094
973	Ring the bell!	1095	Ring the bell!
974		1096
…		…
1034		1156
1035	=item $lines_in_scrollback = $term->nsaved	1157	=item $lines_in_scrollback = $term->nsaved
1036		1158
1037	Return various integers describing terminal characteristics.	1159	Return various integers describing terminal characteristics.
1038		1160
		1161	=item $x_display = $term->display_id
		1162
		1163	Return the DISPLAY used by rxvt-unicode.
		1164
1039	=item $lc_ctype = $term->locale	1165	=item $lc_ctype = $term->locale
1040		1166
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1167	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1168
1043	=item $x_display = $term->display_id	1169	=item $env = $term->env
1044		1170
1045	Return the DISPLAY used by rxvt-unicode.	1171	Returns a copy of the environment in effect for the terminal as a hashref
		1172	similar to C<\%ENV>.
		1173
		1174	=cut
		1175
		1176	sub env {
		1177	if (my $env = $_[0]->_env) {
		1178	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1179	} else {
		1180	+{ %ENV }
		1181	}
		1182	}
1046		1183
1047	=item $modifiermask = $term->ModLevel3Mask	1184	=item $modifiermask = $term->ModLevel3Mask
1048		1185
1049	=item $modifiermask = $term->ModMetaMask	1186	=item $modifiermask = $term->ModMetaMask
1050		1187
…		…
1143	Return the row number of the first/last row of the line, respectively.	1280	Return the row number of the first/last row of the line, respectively.
1144		1281
1145	=item $offset = $line->offset_of ($row, $col)	1282	=item $offset = $line->offset_of ($row, $col)
1146		1283
1147	Returns the character offset of the given row\|col pair within the logical	1284	Returns the character offset of the given row\|col pair within the logical
1148	line.	1285	line. Works for rows outside the line, too, and returns corresponding
		1286	offsets outside the string.
1149		1287
1150	=item ($row, $col) = $line->coord_of ($offset)	1288	=item ($row, $col) = $line->coord_of ($offset)
1151		1289
1152	Translates a string offset into terminal coordinates again.	1290	Translates a string offset into terminal coordinates again.
1153		1291
…		…
1290	$item->{render} \|\|= sub { $_[0]{text} };	1428	$item->{render} \|\|= sub { $_[0]{text} };
1291		1429
1292	push @{ $self->{item} }, $item;	1430	push @{ $self->{item} }, $item;
1293	}	1431	}
1294		1432
		1433	=item $popup->add_title ($title)
		1434
		1435	Adds a non-clickable title to the popup.
		1436
		1437	=cut
		1438
		1439	sub add_title {
		1440	my ($self, $title) = @_;
		1441
		1442	$self->add_item ({
		1443	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1444	text => $title,
		1445	activate => sub { },
		1446	});
		1447	}
		1448
		1449	=item $popup->add_separator ([$sepchr])
		1450
		1451	Creates a separator, optionally using the character given as C<$sepchr>.
		1452
		1453	=cut
		1454
1295	sub add_separator {	1455	sub add_separator {
1296	my ($self, $sep) = @_;	1456	my ($self, $sep) = @_;
1297		1457
1298	$sep \|\|= "=";	1458	$sep \|\|= "=";
1299		1459
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1463	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1464	activate => sub { },
1305	});	1465	});
1306	}	1466	}
1307		1467
1308	sub add_title {	1468	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1469
1311	$self->add_item ({	1470	Adds a clickable button to the popup. C<$cb> is called whenever it is
1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1471	selected.
1313	text => $title,	1472
1314	activate => sub { },	1473	=cut
1315	});
1316	}
1317		1474
1318	sub add_button {	1475	sub add_button {
1319	my ($self, $text, $cb) = @_;	1476	my ($self, $text, $cb) = @_;
1320		1477
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1478	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	1479	}
		1480
		1481	=item $popup->add_toggle ($text, $cb, $initial_value)
		1482
		1483	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1484	whenever it gets toggled, with a boolean indicating its value as its first
		1485	argument.
		1486
		1487	=cut
1323		1488
1324	sub add_toggle {	1489	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1490	my ($self, $text, $cb, $value) = @_;
1326		1491
1327	my $item; $item = {	1492	my $item; $item = {
1328	type => "button",	1493	type => "button",
1329	text => " $text",	1494	text => " $text",
1330	value => $value,	1495	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1496	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1497	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1498	};
1334		1499
1335	$self->add_item ($item);	1500	$self->add_item ($item);
1336	}	1501	}
		1502
		1503	=item $popup->show
		1504
		1505	Displays the popup (which is initially hidden).
		1506
		1507	=cut
1337		1508
1338	sub show {	1509	sub show {
1339	my ($self) = @_;	1510	my ($self) = @_;
1340		1511
1341	local $urxvt::popup::self = $self;	1512	local $urxvt::popup::self = $self;
1342		1513
		1514	my $env = $self->{term}->env;
		1515	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1516	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1517	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1518
		1519	urxvt::term->new ($env, $self->{term}->resource ("name"),
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1520	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1346	"--transient-for" => $self->{term}->parent,	1521	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1522	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1523	"-pe" => "urxvt-popup")
1349	or die "unable to create popup window\n";	1524	or die "unable to create popup window\n";
1350	}	1525	}
1351		1526
1352	sub DESTROY {	1527	sub DESTROY {
1353	my ($self) = @_;	1528	my ($self) = @_;
1354		1529
1355	delete $self->{term}{_destroy}{$self};	1530	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1531	$self->{term}->ungrab;
1357	}	1532	}
		1533
		1534	=back
1358		1535
1359	=head2 The C<urxvt::timer> Class	1536	=head2 The C<urxvt::timer> Class
1360		1537
1361	This class implements timer watchers/events. Time is represented as a	1538	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1539	fractional number of seconds since the epoch. Example:
…		…
1469		1646
1470	=item == 0 - fatal messages	1647	=item == 0 - fatal messages
1471		1648
1472	=item >= 3 - script loading and management	1649	=item >= 3 - script loading and management
1473		1650
1474	=item >=10 - all events received	1651	=item >=10 - all called hooks
		1652
		1653	=item >=11 - hook reutrn values
1475		1654
1476	=back	1655	=back
1477		1656
1478	=head1 AUTHOR	1657	=head1 AUTHOR
1479		1658

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs. Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC