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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC vs.
Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC vs. Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC vs.
Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC