[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.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 (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<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/
82		130
83	=item mark-urls	131	=item mark-urls
84		132
85	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.
86		137
87	=item block-graphics-to-ascii	138	=item block-graphics-to-ascii
88		139
89	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,
90	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
91	similar-looking ascii character.	142	similar-looking ascii character.
92		143
		144	=item digital-clock
		145
		146	Displays a digital clock using the built-in overlay.
		147
93	=item example-refresh-hooks	148	=item example-refresh-hooks
94		149
95	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
96	window. Illustrates overwriting the refresh callbacks to create your own	151	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	152	overlays or changes.
98		153
99	=back	154	=back
		155
		156	=head1 API DOCUMENTATION
100		157
101	=head2 General API Considerations	158	=head2 General API Considerations
102		159
103	All objects (such as terminals, time watchers etc.) are typical	160	All objects (such as terminals, time watchers etc.) are typical
104	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
…		…
117	=over 4	174	=over 4
118		175
119	=item $text	176	=item $text
120		177
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	178	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.	179	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		180
124	=item $string	181	=item $string
125		182
126	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
127	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
…		…
222	=item on_sel_extend $term	279	=item on_sel_extend $term
223		280
224	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
225	click) and is either supposed to return false (normal operation), or	282	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	283	should extend the selection itelf and return true to suppress the built-in
227	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.
228		287
229	See the F<selection> example extension.	288	See the F<selection> example extension.
230		289
231	=item on_view_change $term, $offset	290	=item on_view_change $term, $offset
232		291
…		…
337		396
338	subwindow.	397	subwindow.
339		398
340	=back	399	=back
341		400
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	401	=cut
453		402
454	package urxvt;	403	package urxvt;
455		404
456	use utf8;	405	use utf8;
…		…
462	our $VERSION = 1;	411	our $VERSION = 1;
463	our $TERM;	412	our $TERM;
464	our @HOOKNAME;	413	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	414	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;	415	our %OPTION;
		416
467	our $LIBDIR;	417	our $LIBDIR;
		418	our $RESNAME;
		419	our $RESCLASS;
		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
468		540
469	BEGIN {	541	BEGIN {
470	urxvt->bootstrap;	542	urxvt->bootstrap;
471		543
472	# overwrite perl's warn	544	# overwrite perl's warn
…		…
475	$msg .= "\n"	547	$msg .= "\n"
476	unless $msg =~ /\n$/;	548	unless $msg =~ /\n$/;
477	urxvt::warn ($msg);	549	urxvt::warn ($msg);
478	};	550	};
479		551
		552	# %ENV is the original startup environment
480	delete $ENV{IFS};	553	delete $ENV{IFS};
481	delete $ENV{CDPATH};	554	delete $ENV{CDPATH};
482	delete $ENV{BASH_ENV};	555	delete $ENV{BASH_ENV};
483	$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";
484	}	557	}
…		…
573	if ($@) {	646	if ($@) {
574	$TERM->ungrab; # better to lose the grab than the session	647	$TERM->ungrab; # better to lose the grab than the session
575	warn $@;	648	warn $@;
576	}	649	}
577	}	650	}
		651
		652	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		653	if $verbosity >= 11;
578	}	654	}
579		655
580	if ($htype == 1) { # DESTROY	656	if ($htype == 1) { # DESTROY
581	if (my $hook = delete $TERM->{_hook}) {	657	if (my $hook = delete $TERM->{_hook}) {
582	for my $htype (0..$#$hook) {	658	for my $htype (0..$#$hook) {
…		…
593	}	669	}
594		670
595	$retval	671	$retval
596	}	672	}
597		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
598	# urxvt::term::extension	686	# urxvt::term::extension
599		687
600	package urxvt::term::extension;	688	package urxvt::term::extension;
601		689
602	sub enable {	690	sub enable {
…		…
668		756
669	=head2 The C<urxvt::anyevent> Class	757	=head2 The C<urxvt::anyevent> Class
670		758
671	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
672	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
673	further work. The only exception is that you cannot wait on condition	761	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	762	condition variables, but non-blocking condvar use is ok. What this means
675	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.
676		765
677	=cut	766	=cut
678		767
679	our $VERSION = 1;	768	our $VERSION = 1;
680		769
…		…
757	$proxy->enable ($name => $ref);	846	$proxy->enable ($name => $ref);
758	}	847	}
759	}	848	}
760	}	849	}
761		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
762	=item $term->destroy	870	=item $term->destroy
763		871
764	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.
765		875
766	=item $isset = $term->option ($optval[, $set])	876	=item $isset = $term->option ($optval[, $set])
767		877
768	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
769	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
…		…
819	my ($self, $name) = (shift, shift);	929	my ($self, $name) = (shift, shift);
820	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	930	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
821	&urxvt::term::_resource	931	&urxvt::term::_resource
822	}	932	}
823		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
824	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	945	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
825		946
826	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
827	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	948	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
828		949
…		…
843	=item ($row, $col) = $term->selection_end ([$row, $col])	964	=item ($row, $col) = $term->selection_end ([$row, $col])
844		965
845	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,
846	and optionally set them to new values.	967	and optionally set them to new values.
847		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
848	=item $success = $term->selection_grab ($eventtime)	976	=item $success = $term->selection_grab ($eventtime)
849		977
850	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
851	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.
852		981
853	=item $oldtext = $term->selection ([$newtext])	982	=item $oldtext = $term->selection ([$newtext])
854		983
855	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>.
856		985
…		…
949	Convert the given locale-encoded octets into a perl string.	1078	Convert the given locale-encoded octets into a perl string.
950		1079
951	=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])
952		1081
953	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
954	(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
955	to the selection.	1084	refresh hooks to provide effects similar to the selection.
956		1085
957	=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]])
958		1087
959	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
960	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1089	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	1090	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
962	it instead.	1091	it instead. Both styles I<MUST NOT> contain font styles.
963		1092
964	=item $term->scr_bell	1093	=item $term->scr_bell
965		1094
966	Ring the bell!	1095	Ring the bell!
967		1096
…		…
1027		1156
1028	=item $lines_in_scrollback = $term->nsaved	1157	=item $lines_in_scrollback = $term->nsaved
1029		1158
1030	Return various integers describing terminal characteristics.	1159	Return various integers describing terminal characteristics.
1031		1160
		1161	=item $x_display = $term->display_id
		1162
		1163	Return the DISPLAY used by rxvt-unicode.
		1164
1032	=item $lc_ctype = $term->locale	1165	=item $lc_ctype = $term->locale
1033		1166
1034	Returns the LC_CTYPE category string used by this rxvt-unicode.	1167	Returns the LC_CTYPE category string used by this rxvt-unicode.
1035		1168
1036	=item $x_display = $term->display_id	1169	=item $env = $term->env
1037		1170
1038	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	}
1039		1183
1040	=item $modifiermask = $term->ModLevel3Mask	1184	=item $modifiermask = $term->ModLevel3Mask
1041		1185
1042	=item $modifiermask = $term->ModMetaMask	1186	=item $modifiermask = $term->ModMetaMask
1043		1187
…		…
1136	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.
1137		1281
1138	=item $offset = $line->offset_of ($row, $col)	1282	=item $offset = $line->offset_of ($row, $col)
1139		1283
1140	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
1141	line.	1285	line. Works for rows outside the line, too, and returns corresponding
		1286	offsets outside the string.
1142		1287
1143	=item ($row, $col) = $line->coord_of ($offset)	1288	=item ($row, $col) = $line->coord_of ($offset)
1144		1289
1145	Translates a string offset into terminal coordinates again.	1290	Translates a string offset into terminal coordinates again.
1146		1291
…		…
1283	$item->{render} \|\|= sub { $_[0]{text} };	1428	$item->{render} \|\|= sub { $_[0]{text} };
1284		1429
1285	push @{ $self->{item} }, $item;	1430	push @{ $self->{item} }, $item;
1286	}	1431	}
1287		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
1288	sub add_separator {	1455	sub add_separator {
1289	my ($self, $sep) = @_;	1456	my ($self, $sep) = @_;
1290		1457
1291	$sep \|\|= "=";	1458	$sep \|\|= "=";
1292		1459
…		…
1296	render => sub { $sep x $self->{term}->ncol },	1463	render => sub { $sep x $self->{term}->ncol },
1297	activate => sub { },	1464	activate => sub { },
1298	});	1465	});
1299	}	1466	}
1300		1467
1301	sub add_title {	1468	=item $popup->add_button ($text, $cb)
1302	my ($self, $title) = @_;
1303		1469
1304	$self->add_item ({	1470	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" },	1471	selected.
1306	text => $title,	1472
1307	activate => sub { },	1473	=cut
1308	});
1309	}
1310		1474
1311	sub add_button {	1475	sub add_button {
1312	my ($self, $text, $cb) = @_;	1476	my ($self, $text, $cb) = @_;
1313		1477
1314	$self->add_item ({ type => "button", text => $text, activate => $cb});	1478	$self->add_item ({ type => "button", text => $text, activate => $cb});
1315	}	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
1316		1488
1317	sub add_toggle {	1489	sub add_toggle {
1318	my ($self, $text, $cb, $value) = @_;	1490	my ($self, $text, $cb, $value) = @_;
1319		1491
1320	my $item; $item = {	1492	my $item; $item = {
1321	type => "button",	1493	type => "button",
1322	text => " $text",	1494	text => " $text",
1323	value => $value,	1495	value => $value,
1324	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1496	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1325	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1497	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1326	};	1498	};
1327		1499
1328	$self->add_item ($item);	1500	$self->add_item ($item);
1329	}	1501	}
		1502
		1503	=item $popup->show
		1504
		1505	Displays the popup (which is initially hidden).
		1506
		1507	=cut
1330		1508
1331	sub show {	1509	sub show {
1332	my ($self) = @_;	1510	my ($self) = @_;
1333		1511
1334	local $urxvt::popup::self = $self;	1512	local $urxvt::popup::self = $self;
1335		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};
1336	local $ENV{LC_ALL} = $self->{term}->locale;	1517	$env->{LC_CTYPE} = $self->{term}->locale;
1337		1518
		1519	urxvt::term->new ($env, $self->{term}->resource ("name"),
1338	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,
1339	"--transient-for" => $self->{term}->parent,	1521	"--transient-for" => $self->{term}->parent,
1340	"-display" => $self->{term}->display_id,	1522	"-display" => $self->{term}->display_id,
1341	"-pe" => "urxvt-popup")	1523	"-pe" => "urxvt-popup")
1342	or die "unable to create popup window\n";	1524	or die "unable to create popup window\n";
1343	}	1525	}
1344		1526
1345	sub DESTROY {	1527	sub DESTROY {
1346	my ($self) = @_;	1528	my ($self) = @_;
1347		1529
1348	delete $self->{term}{_destroy}{$self};	1530	delete $self->{term}{_destroy}{$self};
1349	$self->{term}->ungrab;	1531	$self->{term}->ungrab;
1350	}	1532	}
		1533
		1534	=back
1351		1535
1352	=head2 The C<urxvt::timer> Class	1536	=head2 The C<urxvt::timer> Class
1353		1537
1354	This class implements timer watchers/events. Time is represented as a	1538	This class implements timer watchers/events. Time is represented as a
1355	fractional number of seconds since the epoch. Example:	1539	fractional number of seconds since the epoch. Example:
…		…
1462		1646
1463	=item == 0 - fatal messages	1647	=item == 0 - fatal messages
1464		1648
1465	=item >= 3 - script loading and management	1649	=item >= 3 - script loading and management
1466		1650
1467	=item >=10 - all events received	1651	=item >=10 - all called hooks
		1652
		1653	=item >=11 - hook reutrn values
1468		1654
1469	=back	1655	=back
1470		1656
1471	=head1 AUTHOR	1657	=head1 AUTHOR
1472		1658

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.88 by root, Thu Jan 12 12:05:28 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.88 by root, Thu Jan 12 12:05:28 2006 UTC