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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.89 by root, Thu Jan 12 12:10:06 2006 UTC

…		…
40	=over 4	40	=over 4
41		41
42	=item selection (enabled by default)	42	=item selection (enabled by default)
43		43
44	(More) intelligent selection. This extension tries to be more intelligent	44	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	45	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	46	now, it tries to select words, urls and complete shell-quoted
47	too, 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
		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
49	It also offers the following bindable keyboard command:	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
…		…
70	evalution, web-browser starting etc.), depending on content.	92	evalution, web-browser starting etc.), depending on content.
71		93
72	=item searchable-scrollback<hotkey> (enabled by default)	94	=item searchable-scrollback<hotkey> (enabled by default)
73		95
74	Adds regex search functionality to the scrollback buffer, triggered	96	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	98	input/output is suspended and a regex is displayed at the bottom of the
		99	screen.
77		100
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	101	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	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.
82		108
83	=item digital-clock	109	=item selection-autotransform
84		110
85	Displays a digital clock using the built-in overlay.	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/
86		131
87	=item mark-urls	132	=item mark-urls
88		133
89	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.
90		138
91	=item block-graphics-to-ascii	139	=item block-graphics-to-ascii
92		140
93	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,
94	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
95	similar-looking ascii character.	143	similar-looking ascii character.
		144
		145	=item digital-clock
		146
		147	Displays a digital clock using the built-in overlay.
96		148
97	=item example-refresh-hooks	149	=item example-refresh-hooks
98		150
99	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
100	window. Illustrates overwriting the refresh callbacks to create your own	152	window. Illustrates overwriting the refresh callbacks to create your own
…		…
123	=over 4	175	=over 4
124		176
125	=item $text	177	=item $text
126		178
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	179	Rxvt-unicodes special way of encoding text, where one "unicode" character
128	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.
129		181
130	=item $string	182	=item $string
131		183
132	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
133	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
…		…
228	=item on_sel_extend $term	280	=item on_sel_extend $term
229		281
230	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
231	click) and is either supposed to return false (normal operation), or	283	click) and is either supposed to return false (normal operation), or
232	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
233	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.
234		288
235	See the F<selection> example extension.	289	See the F<selection> example extension.
236		290
237	=item on_view_change $term, $offset	291	=item on_view_change $term, $offset
238		292
…		…
343		397
344	subwindow.	398	subwindow.
345		399
346	=back	400	=back
347		401
348	=head2 Variables in the C<urxvt> Package
349
350	=over 4
351
352	=item $urxvt::LIBDIR
353
354	The rxvt-unicode library directory, where, among other things, the perl
355	modules and scripts are stored.
356
357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
358
359	The resource class and name rxvt-unicode uses to look up X resources.
360
361	=item $urxvt::RXVTNAME
362
363	The basename of the installed binaries, usually C<urxvt>.
364
365	=item $urxvt::TERM
366
367	The current terminal. This variable stores the current C<urxvt::term>
368	object, whenever a callback/hook is executing.
369
370	=item
371
372	=back
373
374	=head2 Functions in the C<urxvt> Package
375
376	=over 4
377
378	=item $term = new urxvt [arg...]
379
380	Creates a new terminal, very similar as if you had started it with
381	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
382	if the new instance couldn't be created. Returns C<undef> if the new
383	instance didn't initialise perl, and the terminal object otherwise. The
384	C<init> and C<start> hooks will be called during the call.
385
386	=item urxvt::fatal $errormessage
387
388	Fatally aborts execution with the given error message. Avoid at all
389	costs! The only time this is acceptable is when the terminal process
390	starts up.
391
392	=item urxvt::warn $string
393
394	Calls C<rxvt_warn> with the given string which should not include a
395	newline. The module also overwrites the C<warn> builtin with a function
396	that calls this function.
397
398	Using this function has the advantage that its output ends up in the
399	correct place, e.g. on stderr of the connecting urxvtc client.
400
401	=item $is_safe = urxvt::safe
402
403	Returns true when it is safe to do potentially unsafe things, such as
404	evaluating perl code specified by the user. This is true when urxvt was
405	started setuid or setgid.
406
407	=item $time = urxvt::NOW
408
409	Returns the "current time" (as per the event loop).
410
411	=item urxvt::CurrentTime
412
413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415	Button4Mask, Button5Mask, AnyModifier
416
417	Various constants for use in X calls and event processing.
418
419	=back
420
421	=head2 RENDITION
422
423	Rendition bitsets contain information about colour, font, font styles and
424	similar information for each screen cell.
425
426	The following "macros" deal with changes in rendition sets. You should
427	never just create a bitset, you should always modify an existing one,
428	as they contain important information required for correct operation of
429	rxvt-unicode.
430
431	=over 4
432
433	=item $rend = urxvt::DEFAULT_RSTYLE
434
435	Returns the default rendition, as used when the terminal is starting up or
436	being reset. Useful as a base to start when creating renditions.
437
438	=item $rend = urxvt::OVERLAY_RSTYLE
439
440	Return the rendition mask used for overlays by default.
441
442	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
443
444	Return the bit that enabled bold, italic, blink, reverse-video and
445	underline, respectively. To enable such a style, just logically OR it into
446	the bitset.
447
448	=item $foreground = urxvt::GET_BASEFG $rend
449
450	=item $background = urxvt::GET_BASEBG $rend
451
452	Return the foreground/background colour index, respectively.
453
454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455
456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457
458	Replace the foreground/background colour in the rendition mask with the
459	specified one.
460
461	=item $value = urxvt::GET_CUSTOM $rend
462
463	Return the "custom" value: Every rendition has 5 bits for use by
464	extensions. They can be set and changed as you like and are initially
465	zero.
466
467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
468
469	Change the custom value.
470
471	=back
472
473	=cut	402	=cut
474		403
475	package urxvt;	404	package urxvt;
476		405
477	use utf8;	406	use utf8;
…		…
488		417
489	our $LIBDIR;	418	our $LIBDIR;
490	our $RESNAME;	419	our $RESNAME;
491	our $RESCLASS;	420	our $RESCLASS;
492	our $RXVTNAME;	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
493		541
494	BEGIN {	542	BEGIN {
495	urxvt->bootstrap;	543	urxvt->bootstrap;
496		544
497	# overwrite perl's warn	545	# overwrite perl's warn
…		…
500	$msg .= "\n"	548	$msg .= "\n"
501	unless $msg =~ /\n$/;	549	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	550	urxvt::warn ($msg);
503	};	551	};
504		552
		553	# %ENV is the original startup environment
505	delete $ENV{IFS};	554	delete $ENV{IFS};
506	delete $ENV{CDPATH};	555	delete $ENV{CDPATH};
507	delete $ENV{BASH_ENV};	556	delete $ENV{BASH_ENV};
508	$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";
509	}	558	}
…		…
598	if ($@) {	647	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	648	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	649	warn $@;
601	}	650	}
602	}	651	}
		652
		653	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		654	if $verbosity >= 11;
603	}	655	}
604		656
605	if ($htype == 1) { # DESTROY	657	if ($htype == 1) { # DESTROY
606	if (my $hook = delete $TERM->{_hook}) {	658	if (my $hook = delete $TERM->{_hook}) {
607	for my $htype (0..$#$hook) {	659	for my $htype (0..$#$hook) {
…		…
616	# clear package	668	# clear package
617	%$TERM = ();	669	%$TERM = ();
618	}	670	}
619		671
620	$retval	672	$retval
		673	}
		674
		675	sub exec_async(@) {
		676	my $pid = fork;
		677
		678	return
		679	if !defined $pid or $pid;
		680
		681	%ENV = %{ $TERM->env };
		682
		683	exec @_;
		684	_exit 255;
621	}	685	}
622		686
623	# urxvt::term::extension	687	# urxvt::term::extension
624		688
625	package urxvt::term::extension;	689	package urxvt::term::extension;
…		…
781	for my $name (@HOOKNAME) {	845	for my $name (@HOOKNAME) {
782	if (my $ref = $pkg->can ("on_" . lc $name)) {	846	if (my $ref = $pkg->can ("on_" . lc $name)) {
783	$proxy->enable ($name => $ref);	847	$proxy->enable ($name => $ref);
784	}	848	}
785	}	849	}
		850	}
		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);
786	}	869	}
787		870
788	=item $term->destroy	871	=item $term->destroy
789		872
790	Destroy the terminal object (close the window, free resources	873	Destroy the terminal object (close the window, free resources
…		…
847	my ($self, $name) = (shift, shift);	930	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	931	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	932	&urxvt::term::_resource
850	}	933	}
851		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
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	946	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		947
854	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
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	949	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		950
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	965	=item ($row, $col) = $term->selection_end ([$row, $col])
872		966
873	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,
874	and optionally set them to new values.	968	and optionally set them to new values.
875		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
876	=item $success = $term->selection_grab ($eventtime)	977	=item $success = $term->selection_grab ($eventtime)
877		978
878	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
879	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.
880		982
881	=item $oldtext = $term->selection ([$newtext])	983	=item $oldtext = $term->selection ([$newtext])
882		984
883	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>.
884		986
…		…
977	Convert the given locale-encoded octets into a perl string.	1079	Convert the given locale-encoded octets into a perl string.
978		1080
979	=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])
980		1082
981	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
982	(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
983	to the selection.	1085	refresh hooks to provide effects similar to the selection.
984		1086
985	=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]])
986		1088
987	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
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1090	whitespace will additionally be xored with the C<$rstyle2>, which defaults
989	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
990	it instead.	1092	it instead. Both styles I<MUST NOT> contain font styles.
991		1093
992	=item $term->scr_bell	1094	=item $term->scr_bell
993		1095
994	Ring the bell!	1096	Ring the bell!
995		1097
…		…
1055		1157
1056	=item $lines_in_scrollback = $term->nsaved	1158	=item $lines_in_scrollback = $term->nsaved
1057		1159
1058	Return various integers describing terminal characteristics.	1160	Return various integers describing terminal characteristics.
1059		1161
		1162	=item $x_display = $term->display_id
		1163
		1164	Return the DISPLAY used by rxvt-unicode.
		1165
1060	=item $lc_ctype = $term->locale	1166	=item $lc_ctype = $term->locale
1061		1167
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1168	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1169
1064	=item $x_display = $term->display_id	1170	=item $env = $term->env
1065		1171
1066	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	}
1067		1184
1068	=item $modifiermask = $term->ModLevel3Mask	1185	=item $modifiermask = $term->ModLevel3Mask
1069		1186
1070	=item $modifiermask = $term->ModMetaMask	1187	=item $modifiermask = $term->ModMetaMask
1071		1188
…		…
1164	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.
1165		1282
1166	=item $offset = $line->offset_of ($row, $col)	1283	=item $offset = $line->offset_of ($row, $col)
1167		1284
1168	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
1169	line.	1286	line. Works for rows outside the line, too, and returns corresponding
		1287	offsets outside the string.
1170		1288
1171	=item ($row, $col) = $line->coord_of ($offset)	1289	=item ($row, $col) = $line->coord_of ($offset)
1172		1290
1173	Translates a string offset into terminal coordinates again.	1291	Translates a string offset into terminal coordinates again.
1174		1292
…		…
1311	$item->{render} \|\|= sub { $_[0]{text} };	1429	$item->{render} \|\|= sub { $_[0]{text} };
1312		1430
1313	push @{ $self->{item} }, $item;	1431	push @{ $self->{item} }, $item;
1314	}	1432	}
1315		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
1316	sub add_separator {	1456	sub add_separator {
1317	my ($self, $sep) = @_;	1457	my ($self, $sep) = @_;
1318		1458
1319	$sep \|\|= "=";	1459	$sep \|\|= "=";
1320		1460
…		…
1324	render => sub { $sep x $self->{term}->ncol },	1464	render => sub { $sep x $self->{term}->ncol },
1325	activate => sub { },	1465	activate => sub { },
1326	});	1466	});
1327	}	1467	}
1328		1468
1329	sub add_title {	1469	=item $popup->add_button ($text, $cb)
1330	my ($self, $title) = @_;
1331		1470
1332	$self->add_item ({	1471	Adds a clickable button to the popup. C<$cb> is called whenever it is
1333	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1472	selected.
1334	text => $title,	1473
1335	activate => sub { },	1474	=cut
1336	});
1337	}
1338		1475
1339	sub add_button {	1476	sub add_button {
1340	my ($self, $text, $cb) = @_;	1477	my ($self, $text, $cb) = @_;
1341		1478
1342	$self->add_item ({ type => "button", text => $text, activate => $cb});	1479	$self->add_item ({ type => "button", text => $text, activate => $cb});
1343	}	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
1344		1489
1345	sub add_toggle {	1490	sub add_toggle {
1346	my ($self, $text, $cb, $value) = @_;	1491	my ($self, $text, $cb, $value) = @_;
1347		1492
1348	my $item; $item = {	1493	my $item; $item = {
1349	type => "button",	1494	type => "button",
1350	text => " $text",	1495	text => " $text",
1351	value => $value,	1496	value => $value,
1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1497	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1498	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354	};	1499	};
1355		1500
1356	$self->add_item ($item);	1501	$self->add_item ($item);
1357	}	1502	}
		1503
		1504	=item $popup->show
		1505
		1506	Displays the popup (which is initially hidden).
		1507
		1508	=cut
1358		1509
1359	sub show {	1510	sub show {
1360	my ($self) = @_;	1511	my ($self) = @_;
1361		1512
1362	local $urxvt::popup::self = $self;	1513	local $urxvt::popup::self = $self;
1363		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};
1364	local $ENV{LC_ALL} = $self->{term}->locale;	1518	$env->{LC_CTYPE} = $self->{term}->locale;
1365		1519
		1520	urxvt::term->new ($env, $self->{term}->resource ("name"),
1366	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,
1367	"--transient-for" => $self->{term}->parent,	1522	"--transient-for" => $self->{term}->parent,
1368	"-display" => $self->{term}->display_id,	1523	"-display" => $self->{term}->display_id,
1369	"-pe" => "urxvt-popup")	1524	"-pe" => "urxvt-popup")
1370	or die "unable to create popup window\n";	1525	or die "unable to create popup window\n";
1371	}	1526	}
1372		1527
1373	sub DESTROY {	1528	sub DESTROY {
1374	my ($self) = @_;	1529	my ($self) = @_;
1375		1530
1376	delete $self->{term}{_destroy}{$self};	1531	delete $self->{term}{_destroy}{$self};
1377	$self->{term}->ungrab;	1532	$self->{term}->ungrab;
1378	}	1533	}
		1534
		1535	=back
1379		1536
1380	=head2 The C<urxvt::timer> Class	1537	=head2 The C<urxvt::timer> Class
1381		1538
1382	This class implements timer watchers/events. Time is represented as a	1539	This class implements timer watchers/events. Time is represented as a
1383	fractional number of seconds since the epoch. Example:	1540	fractional number of seconds since the epoch. Example:
…		…
1490		1647
1491	=item == 0 - fatal messages	1648	=item == 0 - fatal messages
1492		1649
1493	=item >= 3 - script loading and management	1650	=item >= 3 - script loading and management
1494		1651
1495	=item >=10 - all events received	1652	=item >=10 - all called hooks
		1653
		1654	=item >=11 - hook reutrn values
1496		1655
1497	=back	1656	=back
1498		1657
1499	=head1 AUTHOR	1658	=head1 AUTHOR
1500		1659

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.75 by root, Tue Jan 10 05:00:13 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.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.89 by root, Thu Jan 12 12:10:06 2006 UTC