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

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.90 by root, Thu Jan 12 12:15:10 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.90 by root, Thu Jan 12 12:15:10 2006 UTC