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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.72 by root, Mon Jan 9 23:30:01 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 (enabled by default)	94	=item searchable-scrollback<hotkey> (enabled by default)
72		95
73	Adds regex search functionality to the scrollback buffer, triggered by a	96	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	97	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,	98	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	99	screen.
77	current position and C<escape> returns to the original position.
78		100
79	=item digital-clock	101	Inputting characters appends them to the regex and continues incremental
		102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		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.
80		108
81	Displays a digital clock using the built-in overlay.	109	=item selection-autotransform
		110
		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 :)
82		133
83	=item mark-urls	134	=item mark-urls
84		135
85	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.
86		140
87	=item block-graphics-to-ascii	141	=item block-graphics-to-ascii
88		142
89	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,
90	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
91	similar-looking ascii character.	145	similar-looking ascii character.
92		146
		147	=item digital-clock
		148
		149	Displays a digital clock using the built-in overlay.
		150
93	=item example-refresh-hooks	151	=item example-refresh-hooks
94		152
95	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
96	window. Illustrates overwriting the refresh callbacks to create your own	154	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	155	overlays or changes.
98		156
99	=back	157	=back
		158
		159	=head1 API DOCUMENTATION
100		160
101	=head2 General API Considerations	161	=head2 General API Considerations
102		162
103	All objects (such as terminals, time watchers etc.) are typical	163	All objects (such as terminals, time watchers etc.) are typical
104	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
…		…
117	=over 4	177	=over 4
118		178
119	=item $text	179	=item $text
120		180
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	181	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.	182	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		183
124	=item $string	184	=item $string
125		185
126	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
127	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
…		…
222	=item on_sel_extend $term	282	=item on_sel_extend $term
223		283
224	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
225	click) and is either supposed to return false (normal operation), or	285	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	286	should extend the selection itelf and return true to suppress the built-in
227	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.
228		290
229	See the F<selection> example extension.	291	See the F<selection> example extension.
230		292
231	=item on_view_change $term, $offset	293	=item on_view_change $term, $offset
232		294
…		…
337		399
338	subwindow.	400	subwindow.
339		401
340	=back	402	=back
341		403
342	=head2 Variables in the C<urxvt> Package
343
344	=over 4
345
346	=item $urxvt::TERM
347
348	The current terminal. This variable stores the current C<urxvt::term>
349	object, whenever a callback/hook is executing.
350
351	=back
352
353	=head2 Functions in the C<urxvt> Package
354
355	=over 4
356
357	=item $term = new urxvt [arg...]
358
359	Creates a new terminal, very similar as if you had started it with
360	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361	if the new instance couldn't be created. Returns C<undef> if the new
362	instance didn't initialise perl, and the terminal object otherwise. The
363	C<init> and C<start> hooks will be called during the call.
364
365	=item urxvt::fatal $errormessage
366
367	Fatally aborts execution with the given error message. Avoid at all
368	costs! The only time this is acceptable is when the terminal process
369	starts up.
370
371	=item urxvt::warn $string
372
373	Calls C<rxvt_warn> with the given string which should not include a
374	newline. The module also overwrites the C<warn> builtin with a function
375	that calls this function.
376
377	Using this function has the advantage that its output ends up in the
378	correct place, e.g. on stderr of the connecting urxvtc client.
379
380	=item $is_safe = urxvt::safe
381
382	Returns true when it is safe to do potentially unsafe things, such as
383	evaluating perl code specified by the user. This is true when urxvt was
384	started setuid or setgid.
385
386	=item $time = urxvt::NOW
387
388	Returns the "current time" (as per the event loop).
389
390	=item urxvt::CurrentTime
391
392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394	Button4Mask, Button5Mask, AnyModifier
395
396	Various constants for use in X calls and event processing.
397
398	=back
399
400	=head2 RENDITION
401
402	Rendition bitsets contain information about colour, font, font styles and
403	similar information for each screen cell.
404
405	The following "macros" deal with changes in rendition sets. You should
406	never just create a bitset, you should always modify an existing one,
407	as they contain important information required for correct operation of
408	rxvt-unicode.
409
410	=over 4
411
412	=item $rend = urxvt::DEFAULT_RSTYLE
413
414	Returns the default rendition, as used when the terminal is starting up or
415	being reset. Useful as a base to start when creating renditions.
416
417	=item $rend = urxvt::OVERLAY_RSTYLE
418
419	Return the rendition mask used for overlays by default.
420
421	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
422
423	Return the bit that enabled bold, italic, blink, reverse-video and
424	underline, respectively. To enable such a style, just logically OR it into
425	the bitset.
426
427	=item $foreground = urxvt::GET_BASEFG $rend
428
429	=item $background = urxvt::GET_BASEBG $rend
430
431	Return the foreground/background colour index, respectively.
432
433	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
434
435	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
436
437	Replace the foreground/background colour in the rendition mask with the
438	specified one.
439
440	=item $value = urxvt::GET_CUSTOM ($rend)
441
442	Return the "custom" value: Every rendition has 5 bits for use by
443	extensions. They can be set and changed as you like and are initially
444	zero.
445
446	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
447
448	Change the custom value.
449
450	=back
451
452	=cut	404	=cut
453		405
454	package urxvt;	406	package urxvt;
455		407
456	use utf8;	408	use utf8;
…		…
462	our $VERSION = 1;	414	our $VERSION = 1;
463	our $TERM;	415	our $TERM;
464	our @HOOKNAME;	416	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;	418	our %OPTION;
		419
467	our $LIBDIR;	420	our $LIBDIR;
		421	our $RESNAME;
		422	our $RESCLASS;
		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
468		543
469	BEGIN {	544	BEGIN {
470	urxvt->bootstrap;	545	urxvt->bootstrap;
471		546
472	# overwrite perl's warn	547	# overwrite perl's warn
…		…
475	$msg .= "\n"	550	$msg .= "\n"
476	unless $msg =~ /\n$/;	551	unless $msg =~ /\n$/;
477	urxvt::warn ($msg);	552	urxvt::warn ($msg);
478	};	553	};
479		554
		555	# %ENV is the original startup environment
480	delete $ENV{IFS};	556	delete $ENV{IFS};
481	delete $ENV{CDPATH};	557	delete $ENV{CDPATH};
482	delete $ENV{BASH_ENV};	558	delete $ENV{BASH_ENV};
483	$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";
484	}	560	}
…		…
573	if ($@) {	649	if ($@) {
574	$TERM->ungrab; # better to lose the grab than the session	650	$TERM->ungrab; # better to lose the grab than the session
575	warn $@;	651	warn $@;
576	}	652	}
577	}	653	}
		654
		655	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		656	if $verbosity >= 11;
578	}	657	}
579		658
580	if ($htype == 1) { # DESTROY	659	if ($htype == 1) { # DESTROY
581	if (my $hook = delete $TERM->{_hook}) {	660	if (my $hook = delete $TERM->{_hook}) {
582	for my $htype (0..$#$hook) {	661	for my $htype (0..$#$hook) {
…		…
593	}	672	}
594		673
595	$retval	674	$retval
596	}	675	}
597		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
598	# urxvt::term::extension	689	# urxvt::term::extension
599		690
600	package urxvt::term::extension;	691	package urxvt::term::extension;
601		692
602	sub enable {	693	sub enable {
…		…
668		759
669	=head2 The C<urxvt::anyevent> Class	760	=head2 The C<urxvt::anyevent> Class
670		761
671	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
672	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
673	further work. The only exception is that you cannot wait on condition	764	further programming. The only exception is that you cannot wait on
674	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
675	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.
676		768
677	=cut	769	=cut
678		770
679	our $VERSION = 1;	771	our $VERSION = 1;
680		772
…		…
757	$proxy->enable ($name => $ref);	849	$proxy->enable ($name => $ref);
758	}	850	}
759	}	851	}
760	}	852	}
761		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
762	=item $term->destroy	873	=item $term->destroy
763		874
764	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.
765		878
766	=item $isset = $term->option ($optval[, $set])	879	=item $isset = $term->option ($optval[, $set])
767		880
768	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
769	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
…		…
819	my ($self, $name) = (shift, shift);	932	my ($self, $name) = (shift, shift);
820	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	933	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
821	&urxvt::term::_resource	934	&urxvt::term::_resource
822	}	935	}
823		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
824	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	948	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
825		949
826	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
827	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	951	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
828		952
…		…
843	=item ($row, $col) = $term->selection_end ([$row, $col])	967	=item ($row, $col) = $term->selection_end ([$row, $col])
844		968
845	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,
846	and optionally set them to new values.	970	and optionally set them to new values.
847		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
848	=item $success = $term->selection_grab ($eventtime)	979	=item $success = $term->selection_grab ($eventtime)
849		980
850	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
851	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.
852		984
853	=item $oldtext = $term->selection ([$newtext])	985	=item $oldtext = $term->selection ([$newtext])
854		986
855	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>.
856		988
…		…
949	Convert the given locale-encoded octets into a perl string.	1081	Convert the given locale-encoded octets into a perl string.
950		1082
951	=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])
952		1084
953	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
954	(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
955	to the selection.	1087	refresh hooks to provide effects similar to the selection.
956		1088
957	=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]])
958		1090
959	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
960	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1092	whitespace will additionally be xored with the C<$rstyle2>, which defaults
961	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
962	it instead.	1094	it instead. Both styles I<MUST NOT> contain font styles.
963		1095
964	=item $term->scr_bell	1096	=item $term->scr_bell
965		1097
966	Ring the bell!	1098	Ring the bell!
967		1099
…		…
1027		1159
1028	=item $lines_in_scrollback = $term->nsaved	1160	=item $lines_in_scrollback = $term->nsaved
1029		1161
1030	Return various integers describing terminal characteristics.	1162	Return various integers describing terminal characteristics.
1031		1163
		1164	=item $x_display = $term->display_id
		1165
		1166	Return the DISPLAY used by rxvt-unicode.
		1167
1032	=item $lc_ctype = $term->locale	1168	=item $lc_ctype = $term->locale
1033		1169
1034	Returns the LC_CTYPE category string used by this rxvt-unicode.	1170	Returns the LC_CTYPE category string used by this rxvt-unicode.
1035		1171
1036	=item $x_display = $term->display_id	1172	=item $env = $term->env
1037		1173
1038	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	}
1039		1186
1040	=item $modifiermask = $term->ModLevel3Mask	1187	=item $modifiermask = $term->ModLevel3Mask
1041		1188
1042	=item $modifiermask = $term->ModMetaMask	1189	=item $modifiermask = $term->ModMetaMask
1043		1190
…		…
1136	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.
1137		1284
1138	=item $offset = $line->offset_of ($row, $col)	1285	=item $offset = $line->offset_of ($row, $col)
1139		1286
1140	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
1141	line.	1288	line. Works for rows outside the line, too, and returns corresponding
		1289	offsets outside the string.
1142		1290
1143	=item ($row, $col) = $line->coord_of ($offset)	1291	=item ($row, $col) = $line->coord_of ($offset)
1144		1292
1145	Translates a string offset into terminal coordinates again.	1293	Translates a string offset into terminal coordinates again.
1146		1294
…		…
1283	$item->{render} \|\|= sub { $_[0]{text} };	1431	$item->{render} \|\|= sub { $_[0]{text} };
1284		1432
1285	push @{ $self->{item} }, $item;	1433	push @{ $self->{item} }, $item;
1286	}	1434	}
1287		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
1288	sub add_separator {	1458	sub add_separator {
1289	my ($self, $sep) = @_;	1459	my ($self, $sep) = @_;
1290		1460
1291	$sep \|\|= "=";	1461	$sep \|\|= "=";
1292		1462
…		…
1296	render => sub { $sep x $self->{term}->ncol },	1466	render => sub { $sep x $self->{term}->ncol },
1297	activate => sub { },	1467	activate => sub { },
1298	});	1468	});
1299	}	1469	}
1300		1470
1301	sub add_title {	1471	=item $popup->add_button ($text, $cb)
1302	my ($self, $title) = @_;
1303		1472
1304	$self->add_item ({	1473	Adds a clickable button to the popup. C<$cb> is called whenever it is
1305	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1474	selected.
1306	text => $title,	1475
1307	activate => sub { },	1476	=cut
1308	});
1309	}
1310		1477
1311	sub add_button {	1478	sub add_button {
1312	my ($self, $text, $cb) = @_;	1479	my ($self, $text, $cb) = @_;
1313		1480
1314	$self->add_item ({ type => "button", text => $text, activate => $cb});	1481	$self->add_item ({ type => "button", text => $text, activate => $cb});
1315	}	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
1316		1491
1317	sub add_toggle {	1492	sub add_toggle {
1318	my ($self, $text, $cb, $value) = @_;	1493	my ($self, $text, $cb, $value) = @_;
1319		1494
1320	my $item; $item = {	1495	my $item; $item = {
1321	type => "button",	1496	type => "button",
1322	text => " $text",	1497	text => " $text",
1323	value => $value,	1498	value => $value,
1324	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1499	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1325	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1500	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1326	};	1501	};
1327		1502
1328	$self->add_item ($item);	1503	$self->add_item ($item);
1329	}	1504	}
		1505
		1506	=item $popup->show
		1507
		1508	Displays the popup (which is initially hidden).
		1509
		1510	=cut
1330		1511
1331	sub show {	1512	sub show {
1332	my ($self) = @_;	1513	my ($self) = @_;
1333		1514
1334	local $urxvt::popup::self = $self;	1515	local $urxvt::popup::self = $self;
1335		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};
1336	local $ENV{LC_ALL} = $self->{term}->locale;	1520	$env->{LC_CTYPE} = $self->{term}->locale;
1337		1521
		1522	urxvt::term->new ($env, $self->{term}->resource ("name"),
1338	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,
1339	"--transient-for" => $self->{term}->parent,	1524	"--transient-for" => $self->{term}->parent,
1340	"-display" => $self->{term}->display_id,	1525	"-display" => $self->{term}->display_id,
1341	"-pe" => "urxvt-popup")	1526	"-pe" => "urxvt-popup")
1342	or die "unable to create popup window\n";	1527	or die "unable to create popup window\n";
1343	}	1528	}
1344		1529
1345	sub DESTROY {	1530	sub DESTROY {
1346	my ($self) = @_;	1531	my ($self) = @_;
1347		1532
1348	delete $self->{term}{_destroy}{$self};	1533	delete $self->{term}{_destroy}{$self};
1349	$self->{term}->ungrab;	1534	$self->{term}->ungrab;
1350	}	1535	}
		1536
		1537	=back
1351		1538
1352	=head2 The C<urxvt::timer> Class	1539	=head2 The C<urxvt::timer> Class
1353		1540
1354	This class implements timer watchers/events. Time is represented as a	1541	This class implements timer watchers/events. Time is represented as a
1355	fractional number of seconds since the epoch. Example:	1542	fractional number of seconds since the epoch. Example:
…		…
1462		1649
1463	=item == 0 - fatal messages	1650	=item == 0 - fatal messages
1464		1651
1465	=item >= 3 - script loading and management	1652	=item >= 3 - script loading and management
1466		1653
1467	=item >=10 - all events received	1654	=item >=10 - all called hooks
		1655
		1656	=item >=11 - hook reutrn values
1468		1657
1469	=back	1658	=back
1470		1659
1471	=head1 AUTHOR	1660	=head1 AUTHOR
1472		1661

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.72 by root, Mon Jan 9 23:30:01 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.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC