[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.91 by root, Fri Jan 13 01:09:37 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 :)
		133
		134	To expand the example above to typical perl error messages ("XXX at
		135	FILENAME line YYY."), you need a slightly more elaborate solution:
		136
		137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		139
		140	The first line tells the selection code to treat the unchanging part of
		141	every error message as a selection pattern, and the second line transforms
		142	the message into vi commands to load the file.
82		143
83	=item mark-urls	144	=item mark-urls
84		145
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	146	Uses per-line display filtering (C<on_line_update>) to underline urls and
		147	make them clickable. When middle-clicked, the program specified in the
		148	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		149	the URL as first argument.
86		150
87	=item block-graphics-to-ascii	151	=item block-graphics-to-ascii
88		152
89	A not very useful example of filtering all text output to the terminal,	153	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	154	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	155	similar-looking ascii character.
92		156
		157	=item digital-clock
		158
		159	Displays a digital clock using the built-in overlay.
		160
93	=item example-refresh-hooks	161	=item example-refresh-hooks
94		162
95	Displays a very simple digital clock in the upper right corner of the	163	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	164	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	165	overlays or changes.
98		166
99	=back	167	=back
		168
		169	=head1 API DOCUMENTATION
100		170
101	=head2 General API Considerations	171	=head2 General API Considerations
102		172
103	All objects (such as terminals, time watchers etc.) are typical	173	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	174	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	187	=over 4
118		188
119	=item $text	189	=item $text
120		190
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	191	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.	192	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		193
124	=item $string	194	=item $string
125		195
126	A perl text string, with an emphasis on I<text>. It can store all unicode	196	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	197	characters and is to be distinguished with text encoded in a specific
…		…
222	=item on_sel_extend $term	292	=item on_sel_extend $term
223		293
224	Called whenever the user tries to extend the selection (e.g. with a double	294	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	295	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	296	should extend the selection itelf and return true to suppress the built-in
227	processing.	297	processing. This can happen multiple times, as long as the callback
		298	returns true, it will be called on every further click by the user and is
		299	supposed to enlarge the selection more and more, if possible.
228		300
229	See the F<selection> example extension.	301	See the F<selection> example extension.
230		302
231	=item on_view_change $term, $offset	303	=item on_view_change $term, $offset
232		304
…		…
263	can filter/change and output the text yourself by returning a true value	335	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	336	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	337	might be very slow, however, as your hook is called for B<all> text being
266	output.	338	output.
267		339
		340	=item on_tt_write $term, $octets
		341
		342	Called whenever some data is written to the tty/pty and can be used to
		343	suppress or filter tty input.
		344
268	=item on_line_update $term, $row	345	=item on_line_update $term, $row
269		346
270	Called whenever a line was updated or changed. Can be used to filter	347	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	348	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,	349	that are being shown will be filtered, and, due to performance reasons,
…		…
329		406
330	C<on_key_press> additionally receives the string rxvt-unicode would	407	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	408	output, if any, in locale-specific encoding.
332		409
333	subwindow.	410	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		411
445	=back	412	=back
446		413
447	=cut	414	=cut
448		415
…		…
457	our $VERSION = 1;	424	our $VERSION = 1;
458	our $TERM;	425	our $TERM;
459	our @HOOKNAME;	426	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	427	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	428	our %OPTION;
		429
462	our $LIBDIR;	430	our $LIBDIR;
		431	our $RESNAME;
		432	our $RESCLASS;
		433	our $RXVTNAME;
		434
		435	=head2 Variables in the C<urxvt> Package
		436
		437	=over 4
		438
		439	=item $urxvt::LIBDIR
		440
		441	The rxvt-unicode library directory, where, among other things, the perl
		442	modules and scripts are stored.
		443
		444	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		445
		446	The resource class and name rxvt-unicode uses to look up X resources.
		447
		448	=item $urxvt::RXVTNAME
		449
		450	The basename of the installed binaries, usually C<urxvt>.
		451
		452	=item $urxvt::TERM
		453
		454	The current terminal. This variable stores the current C<urxvt::term>
		455	object, whenever a callback/hook is executing.
		456
		457	=back
		458
		459	=head2 Functions in the C<urxvt> Package
		460
		461	=over 4
		462
		463	=item urxvt::fatal $errormessage
		464
		465	Fatally aborts execution with the given error message. Avoid at all
		466	costs! The only time this is acceptable is when the terminal process
		467	starts up.
		468
		469	=item urxvt::warn $string
		470
		471	Calls C<rxvt_warn> with the given string which should not include a
		472	newline. The module also overwrites the C<warn> builtin with a function
		473	that calls this function.
		474
		475	Using this function has the advantage that its output ends up in the
		476	correct place, e.g. on stderr of the connecting urxvtc client.
		477
		478	Messages have a size limit of 1023 bytes currently.
		479
		480	=item $is_safe = urxvt::safe
		481
		482	Returns true when it is safe to do potentially unsafe things, such as
		483	evaluating perl code specified by the user. This is true when urxvt was
		484	started setuid or setgid.
		485
		486	=item $time = urxvt::NOW
		487
		488	Returns the "current time" (as per the event loop).
		489
		490	=item urxvt::CurrentTime
		491
		492	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		493	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		494	Button4Mask, Button5Mask, AnyModifier
		495
		496	Various constants for use in X calls and event processing.
		497
		498	=back
		499
		500	=head2 RENDITION
		501
		502	Rendition bitsets contain information about colour, font, font styles and
		503	similar information for each screen cell.
		504
		505	The following "macros" deal with changes in rendition sets. You should
		506	never just create a bitset, you should always modify an existing one,
		507	as they contain important information required for correct operation of
		508	rxvt-unicode.
		509
		510	=over 4
		511
		512	=item $rend = urxvt::DEFAULT_RSTYLE
		513
		514	Returns the default rendition, as used when the terminal is starting up or
		515	being reset. Useful as a base to start when creating renditions.
		516
		517	=item $rend = urxvt::OVERLAY_RSTYLE
		518
		519	Return the rendition mask used for overlays by default.
		520
		521	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		522
		523	Return the bit that enabled bold, italic, blink, reverse-video and
		524	underline, respectively. To enable such a style, just logically OR it into
		525	the bitset.
		526
		527	=item $foreground = urxvt::GET_BASEFG $rend
		528
		529	=item $background = urxvt::GET_BASEBG $rend
		530
		531	Return the foreground/background colour index, respectively.
		532
		533	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		534
		535	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		536
		537	Replace the foreground/background colour in the rendition mask with the
		538	specified one.
		539
		540	=item $value = urxvt::GET_CUSTOM $rend
		541
		542	Return the "custom" value: Every rendition has 5 bits for use by
		543	extensions. They can be set and changed as you like and are initially
		544	zero.
		545
		546	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		547
		548	Change the custom value.
		549
		550	=back
		551
		552	=cut
463		553
464	BEGIN {	554	BEGIN {
465	urxvt->bootstrap;	555	urxvt->bootstrap;
466		556
467	# overwrite perl's warn	557	# overwrite perl's warn
…		…
470	$msg .= "\n"	560	$msg .= "\n"
471	unless $msg =~ /\n$/;	561	unless $msg =~ /\n$/;
472	urxvt::warn ($msg);	562	urxvt::warn ($msg);
473	};	563	};
474		564
		565	# %ENV is the original startup environment
475	delete $ENV{IFS};	566	delete $ENV{IFS};
476	delete $ENV{CDPATH};	567	delete $ENV{CDPATH};
477	delete $ENV{BASH_ENV};	568	delete $ENV{BASH_ENV};
478	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	569	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
479	}	570	}
…		…
568	if ($@) {	659	if ($@) {
569	$TERM->ungrab; # better to lose the grab than the session	660	$TERM->ungrab; # better to lose the grab than the session
570	warn $@;	661	warn $@;
571	}	662	}
572	}	663	}
		664
		665	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		666	if $verbosity >= 11;
573	}	667	}
574		668
575	if ($htype == 1) { # DESTROY	669	if ($htype == 1) { # DESTROY
576	if (my $hook = delete $TERM->{_hook}) {	670	if (my $hook = delete $TERM->{_hook}) {
577	for my $htype (0..$#$hook) {	671	for my $htype (0..$#$hook) {
…		…
588	}	682	}
589		683
590	$retval	684	$retval
591	}	685	}
592		686
		687	sub exec_async(@) {
		688	my $pid = fork;
		689
		690	return
		691	if !defined $pid or $pid;
		692
		693	%ENV = %{ $TERM->env };
		694
		695	exec @_;
		696	_exit 255;
		697	}
		698
593	# urxvt::term::extension	699	# urxvt::term::extension
594		700
595	package urxvt::term::extension;	701	package urxvt::term::extension;
596		702
597	sub enable {	703	sub enable {
…		…
663		769
664	=head2 The C<urxvt::anyevent> Class	770	=head2 The C<urxvt::anyevent> Class
665		771
666	The sole purpose of this class is to deliver an interface to the	772	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	773	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	774	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	775	condition variables, but non-blocking condvar use is ok. What this means
670	cannot use blocking APIs, but the non-blocking variant should work.	776	is that you cannot use blocking APIs, but the non-blocking variant should
		777	work.
671		778
672	=cut	779	=cut
673		780
674	our $VERSION = 1;	781	our $VERSION = 1;
675		782
…		…
752	$proxy->enable ($name => $ref);	859	$proxy->enable ($name => $ref);
753	}	860	}
754	}	861	}
755	}	862	}
756		863
		864	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		865
		866	Creates a new terminal, very similar as if you had started it with system
		867	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		868	hash which defines the environment of the new terminal.
		869
		870	Croaks (and probably outputs an error message) if the new instance
		871	couldn't be created. Returns C<undef> if the new instance didn't
		872	initialise perl, and the terminal object otherwise. The C<init> and
		873	C<start> hooks will be called during this call.
		874
		875	=cut
		876
		877	sub new {
		878	my ($class, $env, @args) = @_;
		879
		880	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		881	}
		882
757	=item $term->destroy	883	=item $term->destroy
758		884
759	Destroy the terminal object (close the window, free resources etc.).	885	Destroy the terminal object (close the window, free resources
		886	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		887	watchers (timers, io watchers) are still active.
760		888
761	=item $isset = $term->option ($optval[, $set])	889	=item $isset = $term->option ($optval[, $set])
762		890
763	Returns true if the option specified by C<$optval> is enabled, and	891	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	892	optionally change it. All option values are stored by name in the hash
…		…
814	my ($self, $name) = (shift, shift);	942	my ($self, $name) = (shift, shift);
815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	943	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
816	&urxvt::term::_resource	944	&urxvt::term::_resource
817	}	945	}
818		946
		947	=item $value = $term->x_resource ($pattern)
		948
		949	Returns the X-Resource for the given pattern, excluding the program or
		950	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		951	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		952	resource with that pattern exists.
		953
		954	This method should only be called during the C<on_start> hook, as there is
		955	only one resource database per display, and later invocations might return
		956	the wrong resources.
		957
819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	958	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820		959
821	Adds a keymap translation exactly as specified via a resource. See the	960	Adds a keymap translation exactly as specified via a resource. See the
822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	961	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823		962
…		…
838	=item ($row, $col) = $term->selection_end ([$row, $col])	977	=item ($row, $col) = $term->selection_end ([$row, $col])
839		978
840	Return the current values of the selection mark, begin or end positions,	979	Return the current values of the selection mark, begin or end positions,
841	and optionally set them to new values.	980	and optionally set them to new values.
842		981
		982	=item $term->selection_make ($eventtime[, $rectangular])
		983
		984	Tries to make a selection as set by C<selection_beg> and
		985	C<selection_end>. If C<$rectangular> is true (default: false), a
		986	rectangular selection will be made. This is the prefered function to make
		987	a selection.
		988
843	=item $success = $term->selection_grab ($eventtime)	989	=item $success = $term->selection_grab ($eventtime)
844		990
845	Try to request the primary selection from the server (for example, as set	991	Try to request the primary selection text from the server (for example, as
846	by the next method).	992	set by the next method). No visual feedback will be given. This function
		993	is mostly useful from within C<on_sel_grab> hooks.
847		994
848	=item $oldtext = $term->selection ([$newtext])	995	=item $oldtext = $term->selection ([$newtext])
849		996
850	Return the current selection text and optionally replace it by C<$newtext>.	997	Return the current selection text and optionally replace it by C<$newtext>.
851		998
…		…
944	Convert the given locale-encoded octets into a perl string.	1091	Convert the given locale-encoded octets into a perl string.
945		1092
946	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1093	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
947		1094
948	XORs the rendition values in the given span with the provided value	1095	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	1096	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
950	to the selection.	1097	refresh hooks to provide effects similar to the selection.
951		1098
952	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1099	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
953		1100
954	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1101	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
955	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1102	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	1103	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
957	it instead.	1104	it instead. Both styles I<MUST NOT> contain font styles.
958		1105
959	=item $term->scr_bell	1106	=item $term->scr_bell
960		1107
961	Ring the bell!	1108	Ring the bell!
962		1109
…		…
1022		1169
1023	=item $lines_in_scrollback = $term->nsaved	1170	=item $lines_in_scrollback = $term->nsaved
1024		1171
1025	Return various integers describing terminal characteristics.	1172	Return various integers describing terminal characteristics.
1026		1173
		1174	=item $x_display = $term->display_id
		1175
		1176	Return the DISPLAY used by rxvt-unicode.
		1177
1027	=item $lc_ctype = $term->locale	1178	=item $lc_ctype = $term->locale
1028		1179
1029	Returns the LC_CTYPE category string used by this rxvt-unicode.	1180	Returns the LC_CTYPE category string used by this rxvt-unicode.
1030		1181
1031	=item $x_display = $term->display_id	1182	=item $env = $term->env
1032		1183
1033	Return the DISPLAY used by rxvt-unicode.	1184	Returns a copy of the environment in effect for the terminal as a hashref
		1185	similar to C<\%ENV>.
		1186
		1187	=cut
		1188
		1189	sub env {
		1190	if (my $env = $_[0]->_env) {
		1191	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1192	} else {
		1193	+{ %ENV }
		1194	}
		1195	}
1034		1196
1035	=item $modifiermask = $term->ModLevel3Mask	1197	=item $modifiermask = $term->ModLevel3Mask
1036		1198
1037	=item $modifiermask = $term->ModMetaMask	1199	=item $modifiermask = $term->ModMetaMask
1038		1200
…		…
1131	Return the row number of the first/last row of the line, respectively.	1293	Return the row number of the first/last row of the line, respectively.
1132		1294
1133	=item $offset = $line->offset_of ($row, $col)	1295	=item $offset = $line->offset_of ($row, $col)
1134		1296
1135	Returns the character offset of the given row\|col pair within the logical	1297	Returns the character offset of the given row\|col pair within the logical
1136	line.	1298	line. Works for rows outside the line, too, and returns corresponding
		1299	offsets outside the string.
1137		1300
1138	=item ($row, $col) = $line->coord_of ($offset)	1301	=item ($row, $col) = $line->coord_of ($offset)
1139		1302
1140	Translates a string offset into terminal coordinates again.	1303	Translates a string offset into terminal coordinates again.
1141		1304
…		…
1278	$item->{render} \|\|= sub { $_[0]{text} };	1441	$item->{render} \|\|= sub { $_[0]{text} };
1279		1442
1280	push @{ $self->{item} }, $item;	1443	push @{ $self->{item} }, $item;
1281	}	1444	}
1282		1445
		1446	=item $popup->add_title ($title)
		1447
		1448	Adds a non-clickable title to the popup.
		1449
		1450	=cut
		1451
		1452	sub add_title {
		1453	my ($self, $title) = @_;
		1454
		1455	$self->add_item ({
		1456	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1457	text => $title,
		1458	activate => sub { },
		1459	});
		1460	}
		1461
		1462	=item $popup->add_separator ([$sepchr])
		1463
		1464	Creates a separator, optionally using the character given as C<$sepchr>.
		1465
		1466	=cut
		1467
1283	sub add_separator {	1468	sub add_separator {
1284	my ($self, $sep) = @_;	1469	my ($self, $sep) = @_;
1285		1470
1286	$sep \|\|= "=";	1471	$sep \|\|= "=";
1287		1472
…		…
1291	render => sub { $sep x $self->{term}->ncol },	1476	render => sub { $sep x $self->{term}->ncol },
1292	activate => sub { },	1477	activate => sub { },
1293	});	1478	});
1294	}	1479	}
1295		1480
1296	sub add_title {	1481	=item $popup->add_button ($text, $cb)
1297	my ($self, $title) = @_;
1298		1482
1299	$self->add_item ({	1483	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" },	1484	selected.
1301	text => $title,	1485
1302	activate => sub { },	1486	=cut
1303	});
1304	}
1305		1487
1306	sub add_button {	1488	sub add_button {
1307	my ($self, $text, $cb) = @_;	1489	my ($self, $text, $cb) = @_;
1308		1490
1309	$self->add_item ({ type => "button", text => $text, activate => $cb});	1491	$self->add_item ({ type => "button", text => $text, activate => $cb});
1310	}	1492	}
		1493
		1494	=item $popup->add_toggle ($text, $cb, $initial_value)
		1495
		1496	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1497	whenever it gets toggled, with a boolean indicating its value as its first
		1498	argument.
		1499
		1500	=cut
1311		1501
1312	sub add_toggle {	1502	sub add_toggle {
1313	my ($self, $text, $cb, $value) = @_;	1503	my ($self, $text, $cb, $value) = @_;
1314		1504
1315	my $item; $item = {	1505	my $item; $item = {
1316	type => "button",	1506	type => "button",
1317	text => " $text",	1507	text => " $text",
1318	value => $value,	1508	value => $value,
1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1509	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1510	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1321	};	1511	};
1322		1512
1323	$self->add_item ($item);	1513	$self->add_item ($item);
1324	}	1514	}
		1515
		1516	=item $popup->show
		1517
		1518	Displays the popup (which is initially hidden).
		1519
		1520	=cut
1325		1521
1326	sub show {	1522	sub show {
1327	my ($self) = @_;	1523	my ($self) = @_;
1328		1524
1329	local $urxvt::popup::self = $self;	1525	local $urxvt::popup::self = $self;
1330		1526
		1527	my $env = $self->{term}->env;
		1528	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1529	delete $env->{LC_ALL};
1331	local $ENV{LC_ALL} = $self->{term}->locale;	1530	$env->{LC_CTYPE} = $self->{term}->locale;
1332		1531
		1532	urxvt::term->new ($env, $self->{term}->resource ("name"),
1333	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1533	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1334	"--transient-for" => $self->{term}->parent,	1534	"--transient-for" => $self->{term}->parent,
1335	"-display" => $self->{term}->display_id,	1535	"-display" => $self->{term}->display_id,
1336	"-pe" => "urxvt-popup")	1536	"-pe" => "urxvt-popup")
1337	or die "unable to create popup window\n";	1537	or die "unable to create popup window\n";
1338	}	1538	}
1339		1539
1340	sub DESTROY {	1540	sub DESTROY {
1341	my ($self) = @_;	1541	my ($self) = @_;
1342		1542
1343	delete $self->{term}{_destroy}{$self};	1543	delete $self->{term}{_destroy}{$self};
1344	$self->{term}->ungrab;	1544	$self->{term}->ungrab;
1345	}	1545	}
		1546
		1547	=back
1346		1548
1347	=head2 The C<urxvt::timer> Class	1549	=head2 The C<urxvt::timer> Class
1348		1550
1349	This class implements timer watchers/events. Time is represented as a	1551	This class implements timer watchers/events. Time is represented as a
1350	fractional number of seconds since the epoch. Example:	1552	fractional number of seconds since the epoch. Example:
…		…
1457		1659
1458	=item == 0 - fatal messages	1660	=item == 0 - fatal messages
1459		1661
1460	=item >= 3 - script loading and management	1662	=item >= 3 - script loading and management
1461		1663
1462	=item >=10 - all events received	1664	=item >=10 - all called hooks
		1665
		1666	=item >=11 - hook reutrn values
1463		1667
1464	=back	1668	=back
1465		1669
1466	=head1 AUTHOR	1670	=head1 AUTHOR
1467		1671

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.91 by root, Fri Jan 13 01:09:37 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.91 by root, Fri Jan 13 01:09:37 2006 UTC