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

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