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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.70 by root, Mon Jan 9 23:00:07 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
…		…
263	can filter/change and output the text yourself by returning a true value	322	can filter/change and output the text yourself by returning a true value
264	and calling C<< $term->scr_add_lines >> yourself. Please note that this	323	and calling C<< $term->scr_add_lines >> yourself. Please note that this
265	might be very slow, however, as your hook is called for B<all> text being	324	might be very slow, however, as your hook is called for B<all> text being
266	output.	325	output.
267		326
		327	=item on_tt_write $term, $octets
		328
		329	Called whenever some data is written to the tty/pty and can be used to
		330	suppress or filter tty input.
		331
268	=item on_line_update $term, $row	332	=item on_line_update $term, $row
269		333
270	Called whenever a line was updated or changed. Can be used to filter	334	Called whenever a line was updated or changed. Can be used to filter
271	screen output (e.g. underline urls or other useless stuff). Only lines	335	screen output (e.g. underline urls or other useless stuff). Only lines
272	that are being shown will be filtered, and, due to performance reasons,	336	that are being shown will be filtered, and, due to performance reasons,
…		…
329		393
330	C<on_key_press> additionally receives the string rxvt-unicode would	394	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	395	output, if any, in locale-specific encoding.
332		396
333	subwindow.	397	subwindow.
334
335	=back
336
337	=head2 Variables in the C<urxvt> Package
338
339	=over 4
340
341	=item $urxvt::TERM
342
343	The current terminal. This variable stores the current C<urxvt::term>
344	object, whenever a callback/hook is executing.
345
346	=back
347
348	=head2 Functions in the C<urxvt> Package
349
350	=over 4
351
352	=item $term = new urxvt [arg...]
353
354	Creates a new terminal, very similar as if you had started it with
355	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
356	if the new instance couldn't be created. Returns C<undef> if the new
357	instance didn't initialise perl, and the terminal object otherwise. The
358	C<init> and C<start> hooks will be called during the call.
359
360	=item urxvt::fatal $errormessage
361
362	Fatally aborts execution with the given error message. Avoid at all
363	costs! The only time this is acceptable is when the terminal process
364	starts up.
365
366	=item urxvt::warn $string
367
368	Calls C<rxvt_warn> with the given string which should not include a
369	newline. The module also overwrites the C<warn> builtin with a function
370	that calls this function.
371
372	Using this function has the advantage that its output ends up in the
373	correct place, e.g. on stderr of the connecting urxvtc client.
374
375	=item $is_safe = urxvt::safe
376
377	Returns true when it is safe to do potentially unsafe things, such as
378	evaluating perl code specified by the user. This is true when urxvt was
379	started setuid or setgid.
380
381	=item $time = urxvt::NOW
382
383	Returns the "current time" (as per the event loop).
384
385	=item urxvt::CurrentTime
386
387	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
388	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
389	Button4Mask, Button5Mask, AnyModifier
390
391	Various constants for use in X calls and event processing.
392
393	=back
394
395	=head2 RENDITION
396
397	Rendition bitsets contain information about colour, font, font styles and
398	similar information for each screen cell.
399
400	The following "macros" deal with changes in rendition sets. You should
401	never just create a bitset, you should always modify an existing one,
402	as they contain important information required for correct operation of
403	rxvt-unicode.
404
405	=over 4
406
407	=item $rend = urxvt::DEFAULT_RSTYLE
408
409	Returns the default rendition, as used when the terminal is starting up or
410	being reset. Useful as a base to start when creating renditions.
411
412	=item $rend = urxvt::OVERLAY_RSTYLE
413
414	Return the rendition mask used for overlays by default.
415
416	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
417
418	Return the bit that enabled bold, italic, blink, reverse-video and
419	underline, respectively. To enable such a style, just logically OR it into
420	the bitset.
421
422	=item $foreground = urxvt::GET_BASEFG $rend
423
424	=item $background = urxvt::GET_BASEBG $rend
425
426	Return the foreground/background colour index, respectively.
427
428	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
429
430	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
431
432	Replace the foreground/background colour in the rendition mask with the
433	specified one.
434
435	=item $value = urxvt::GET_CUSTOM ($rend)
436
437	Return the "custom" value: Every rendition has 5 bits for use by
438	extensions. They can be set and changed as you like and are initially
439	zero.
440
441	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
442
443	Change the custom value.
444		398
445	=back	399	=back
446		400
447	=cut	401	=cut
448		402
…		…
457	our $VERSION = 1;	411	our $VERSION = 1;
458	our $TERM;	412	our $TERM;
459	our @HOOKNAME;	413	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	414	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	415	our %OPTION;
		416
462	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
463		540
464	BEGIN {	541	BEGIN {
465	urxvt->bootstrap;	542	urxvt->bootstrap;
466		543
467	# overwrite perl's warn	544	# overwrite perl's warn
…		…
470	$msg .= "\n"	547	$msg .= "\n"
471	unless $msg =~ /\n$/;	548	unless $msg =~ /\n$/;
472	urxvt::warn ($msg);	549	urxvt::warn ($msg);
473	};	550	};
474		551
		552	# %ENV is the original startup environment
475	delete $ENV{IFS};	553	delete $ENV{IFS};
476	delete $ENV{CDPATH};	554	delete $ENV{CDPATH};
477	delete $ENV{BASH_ENV};	555	delete $ENV{BASH_ENV};
478	$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";
479	}	557	}
…		…
501	open my $fh, "<:raw", $path	579	open my $fh, "<:raw", $path
502	or die "$path: $!";	580	or die "$path: $!";
503		581
504	my $source = untaint	582	my $source = untaint
505	"package $pkg; use strict; use utf8;\n"	583	"package $pkg; use strict; use utf8;\n"
506	. "use base urxvt::term::proxy::;\n"	584	. "use base urxvt::term::extension::;\n"
507	. "#line 1 \"$path\"\n{\n"	585	. "#line 1 \"$path\"\n{\n"
508	. (do { local $/; <$fh> })	586	. (do { local $/; <$fh> })
509	. "\n};\n1";	587	. "\n};\n1";
510		588
511	eval $source	589	eval $source
…		…
568	if ($@) {	646	if ($@) {
569	$TERM->ungrab; # better to lose the grab than the session	647	$TERM->ungrab; # better to lose the grab than the session
570	warn $@;	648	warn $@;
571	}	649	}
572	}	650	}
		651
		652	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		653	if $verbosity >= 11;
573	}	654	}
574		655
575	if ($htype == 1) { # DESTROY	656	if ($htype == 1) { # DESTROY
576	if (my $hook = delete $TERM->{_hook}) {	657	if (my $hook = delete $TERM->{_hook}) {
577	for my $htype (0..$#$hook) {	658	for my $htype (0..$#$hook) {
…		…
588	}	669	}
589		670
590	$retval	671	$retval
591	}	672	}
592		673
593	# urxvt::term::proxy	674	sub exec_async(@) {
		675	my $pid = fork;
594		676
		677	return
		678	if !defined $pid or $pid;
		679
		680	%ENV = %{ $TERM->env };
		681
		682	exec @_;
		683	_exit 255;
		684	}
		685
		686	# urxvt::term::extension
		687
595	package urxvt::term::proxy;	688	package urxvt::term::extension;
596		689
597	sub enable {	690	sub enable {
598	my ($self, %hook) = @_;	691	my ($self, %hook) = @_;
599	my $pkg = $self->{_pkg};	692	my $pkg = $self->{_pkg};
600		693
…		…
663		756
664	=head2 The C<urxvt::anyevent> Class	757	=head2 The C<urxvt::anyevent> Class
665		758
666	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
667	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
668	further work. The only exception is that you cannot wait on condition	761	further programming. The only exception is that you cannot wait on
669	variables, but non-blocking condvar use is ok. What this means is that you	762	condition variables, but non-blocking condvar use is ok. What this means
670	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.
671		765
672	=cut	766	=cut
673		767
674	our $VERSION = 1;	768	our $VERSION = 1;
675		769
…		…
752	$proxy->enable ($name => $ref);	846	$proxy->enable ($name => $ref);
753	}	847	}
754	}	848	}
755	}	849	}
756		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
757	=item $term->destroy	870	=item $term->destroy
758		871
759	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.
760		875
761	=item $isset = $term->option ($optval[, $set])	876	=item $isset = $term->option ($optval[, $set])
762		877
763	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
764	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
…		…
814	my ($self, $name) = (shift, shift);	929	my ($self, $name) = (shift, shift);
815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	930	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
816	&urxvt::term::_resource	931	&urxvt::term::_resource
817	}	932	}
818		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
819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	945	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820		946
821	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
822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	948	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823		949
…		…
838	=item ($row, $col) = $term->selection_end ([$row, $col])	964	=item ($row, $col) = $term->selection_end ([$row, $col])
839		965
840	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,
841	and optionally set them to new values.	967	and optionally set them to new values.
842		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
843	=item $success = $term->selection_grab ($eventtime)	976	=item $success = $term->selection_grab ($eventtime)
844		977
845	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
846	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.
847		981
848	=item $oldtext = $term->selection ([$newtext])	982	=item $oldtext = $term->selection ([$newtext])
849		983
850	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>.
851		985
…		…
944	Convert the given locale-encoded octets into a perl string.	1078	Convert the given locale-encoded octets into a perl string.
945		1079
946	=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])
947		1081
948	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
949	(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
950	to the selection.	1084	refresh hooks to provide effects similar to the selection.
951		1085
952	=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]])
953		1087
954	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
955	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1089	whitespace will additionally be xored with the C<$rstyle2>, which defaults
956	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
957	it instead.	1091	it instead. Both styles I<MUST NOT> contain font styles.
958		1092
959	=item $term->scr_bell	1093	=item $term->scr_bell
960		1094
961	Ring the bell!	1095	Ring the bell!
962		1096
…		…
1022		1156
1023	=item $lines_in_scrollback = $term->nsaved	1157	=item $lines_in_scrollback = $term->nsaved
1024		1158
1025	Return various integers describing terminal characteristics.	1159	Return various integers describing terminal characteristics.
1026		1160
		1161	=item $x_display = $term->display_id
		1162
		1163	Return the DISPLAY used by rxvt-unicode.
		1164
1027	=item $lc_ctype = $term->locale	1165	=item $lc_ctype = $term->locale
1028		1166
1029	Returns the LC_CTYPE category string used by this rxvt-unicode.	1167	Returns the LC_CTYPE category string used by this rxvt-unicode.
1030		1168
1031	=item $x_display = $term->display_id	1169	=item $env = $term->env
1032		1170
1033	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	}
1034		1183
1035	=item $modifiermask = $term->ModLevel3Mask	1184	=item $modifiermask = $term->ModLevel3Mask
1036		1185
1037	=item $modifiermask = $term->ModMetaMask	1186	=item $modifiermask = $term->ModMetaMask
1038		1187
…		…
1131	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.
1132		1281
1133	=item $offset = $line->offset_of ($row, $col)	1282	=item $offset = $line->offset_of ($row, $col)
1134		1283
1135	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
1136	line.	1285	line. Works for rows outside the line, too, and returns corresponding
		1286	offsets outside the string.
1137		1287
1138	=item ($row, $col) = $line->coord_of ($offset)	1288	=item ($row, $col) = $line->coord_of ($offset)
1139		1289
1140	Translates a string offset into terminal coordinates again.	1290	Translates a string offset into terminal coordinates again.
1141		1291
…		…
1278	$item->{render} \|\|= sub { $_[0]{text} };	1428	$item->{render} \|\|= sub { $_[0]{text} };
1279		1429
1280	push @{ $self->{item} }, $item;	1430	push @{ $self->{item} }, $item;
1281	}	1431	}
1282		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
1283	sub add_separator {	1455	sub add_separator {
1284	my ($self, $sep) = @_;	1456	my ($self, $sep) = @_;
1285		1457
1286	$sep \|\|= "=";	1458	$sep \|\|= "=";
1287		1459
…		…
1291	render => sub { $sep x $self->{term}->ncol },	1463	render => sub { $sep x $self->{term}->ncol },
1292	activate => sub { },	1464	activate => sub { },
1293	});	1465	});
1294	}	1466	}
1295		1467
1296	sub add_title {	1468	=item $popup->add_button ($text, $cb)
1297	my ($self, $title) = @_;
1298		1469
1299	$self->add_item ({	1470	Adds a clickable button to the popup. C<$cb> is called whenever it is
1300	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1471	selected.
1301	text => $title,	1472
1302	activate => sub { },	1473	=cut
1303	});
1304	}
1305		1474
1306	sub add_button {	1475	sub add_button {
1307	my ($self, $text, $cb) = @_;	1476	my ($self, $text, $cb) = @_;
1308		1477
1309	$self->add_item ({ type => "button", text => $text, activate => $cb});	1478	$self->add_item ({ type => "button", text => $text, activate => $cb});
1310	}	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
1311		1488
1312	sub add_toggle {	1489	sub add_toggle {
1313	my ($self, $text, $cb, $value) = @_;	1490	my ($self, $text, $cb, $value) = @_;
1314		1491
1315	my $item; $item = {	1492	my $item; $item = {
1316	type => "button",	1493	type => "button",
1317	text => " $text",	1494	text => " $text",
1318	value => $value,	1495	value => $value,
1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1496	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1497	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1321	};	1498	};
1322		1499
1323	$self->add_item ($item);	1500	$self->add_item ($item);
1324	}	1501	}
		1502
		1503	=item $popup->show
		1504
		1505	Displays the popup (which is initially hidden).
		1506
		1507	=cut
1325		1508
1326	sub show {	1509	sub show {
1327	my ($self) = @_;	1510	my ($self) = @_;
1328		1511
1329	local $urxvt::popup::self = $self;	1512	local $urxvt::popup::self = $self;
1330		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};
1331	local $ENV{LC_ALL} = $self->{term}->locale;	1517	$env->{LC_CTYPE} = $self->{term}->locale;
1332		1518
		1519	urxvt::term->new ($env, $self->{term}->resource ("name"),
1333	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,
1334	"--transient-for" => $self->{term}->parent,	1521	"--transient-for" => $self->{term}->parent,
1335	"-display" => $self->{term}->display_id,	1522	"-display" => $self->{term}->display_id,
1336	"-pe" => "urxvt-popup")	1523	"-pe" => "urxvt-popup")
1337	or die "unable to create popup window\n";	1524	or die "unable to create popup window\n";
1338	}	1525	}
1339		1526
1340	sub DESTROY {	1527	sub DESTROY {
1341	my ($self) = @_;	1528	my ($self) = @_;
1342		1529
1343	delete $self->{term}{_destroy}{$self};	1530	delete $self->{term}{_destroy}{$self};
1344	$self->{term}->ungrab;	1531	$self->{term}->ungrab;
1345	}	1532	}
		1533
		1534	=back
1346		1535
1347	=head2 The C<urxvt::timer> Class	1536	=head2 The C<urxvt::timer> Class
1348		1537
1349	This class implements timer watchers/events. Time is represented as a	1538	This class implements timer watchers/events. Time is represented as a
1350	fractional number of seconds since the epoch. Example:	1539	fractional number of seconds since the epoch. Example:
…		…
1457		1646
1458	=item == 0 - fatal messages	1647	=item == 0 - fatal messages
1459		1648
1460	=item >= 3 - script loading and management	1649	=item >= 3 - script loading and management
1461		1650
1462	=item >=10 - all events received	1651	=item >=10 - all called hooks
		1652
		1653	=item >=11 - hook reutrn values
1463		1654
1464	=back	1655	=back
1465		1656
1466	=head1 AUTHOR	1657	=head1 AUTHOR
1467		1658

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.70 by root, Mon Jan 9 23:00:07 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.70 by root, Mon Jan 9 23:00:07 2006 UTC vs.
Revision 1.88 by root, Thu Jan 12 12:05:28 2006 UTC