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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.86 by root, Thu Jan 12 05:22:47 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). Right now, it tries to
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	select urls and complete shell-quoted arguments, which is very convenient,
47	if your F<ls> supports C<--quoting-style=shell>.	47	too, if your F<ls> supports C<--quoting-style=shell>.
48		48
49	It also offers the following bindable event:	49	It also offers the following bindable keyboard command:
50		50
51	=over 4	51	=over 4
52		52
53	=item rot13	53	=item rot13
54		54
…		…
64	runtime.	64	runtime.
65		65
66	=item selection-popup (enabled by default)	66	=item selection-popup (enabled by default)
67		67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	69	text into various other formats/action (such as uri unescaping, perl
		70	evalution, web-browser starting etc.), depending on content.
70		71
71	=item searchable-scrollback<hotkey> (enabled by default)	72	=item searchable-scrollback<hotkey> (enabled by default)
72		73
73	Adds regex search functionality to the scrollback buffer, triggered	74	Adds regex search functionality to the scrollback buffer, triggered
74	by a hotkey (default: C<M-s>). When in search mode, normal terminal	75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
…		…
83		84
84	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
85		86
86	=item mark-urls	87	=item mark-urls
87		88
88	Uses per-line display filtering (C<on_line_update>) to underline urls.	89	Uses per-line display filtering (C<on_line_update>) to underline urls and
		90	make them clickable. When middle-clicked, the program specified in the
		91	resource C<urlLauncher> (default C<x-www-browser>) will be started.
89		92
90	=item block-graphics-to-ascii	93	=item block-graphics-to-ascii
91		94
92	A not very useful example of filtering all text output to the terminal,	95	A not very useful example of filtering all text output to the terminal,
93	by replacing all line-drawing characters (U+2500 .. U+259F) by a	96	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
98	Displays a very simple digital clock in the upper right corner of the	101	Displays a very simple digital clock in the upper right corner of the
99	window. Illustrates overwriting the refresh callbacks to create your own	102	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	103	overlays or changes.
101		104
102	=back	105	=back
		106
		107	=head1 API DOCUMENTATION
103		108
104	=head2 General API Considerations	109	=head2 General API Considerations
105		110
106	All objects (such as terminals, time watchers etc.) are typical	111	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	112	reference-to-hash objects. The hash can be used to store anything you
…		…
120	=over 4	125	=over 4
121		126
122	=item $text	127	=item $text
123		128
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	129	Rxvt-unicodes special way of encoding text, where one "unicode" character
125	always represents one screen cell. See L<row_t> for a discussion of this format.	130	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		131
127	=item $string	132	=item $string
128		133
129	A perl text string, with an emphasis on I<text>. It can store all unicode	134	A perl text string, with an emphasis on I<text>. It can store all unicode
130	characters and is to be distinguished with text encoded in a specific	135	characters and is to be distinguished with text encoded in a specific
…		…
225	=item on_sel_extend $term	230	=item on_sel_extend $term
226		231
227	Called whenever the user tries to extend the selection (e.g. with a double	232	Called whenever the user tries to extend the selection (e.g. with a double
228	click) and is either supposed to return false (normal operation), or	233	click) and is either supposed to return false (normal operation), or
229	should extend the selection itelf and return true to suppress the built-in	234	should extend the selection itelf and return true to suppress the built-in
230	processing.	235	processing. This can happen multiple times, as long as the callback
		236	returns true, it will be called on every further click by the user and is
		237	supposed to enlarge the selection more and more, if possible.
231		238
232	See the F<selection> example extension.	239	See the F<selection> example extension.
233		240
234	=item on_view_change $term, $offset	241	=item on_view_change $term, $offset
235		242
…		…
340		347
341	subwindow.	348	subwindow.
342		349
343	=back	350	=back
344		351
345	=head2 Variables in the C<urxvt> Package
346
347	=over 4
348
349	=item $urxvt::TERM
350
351	The current terminal. This variable stores the current C<urxvt::term>
352	object, whenever a callback/hook is executing.
353
354	=back
355
356	=head2 Functions in the C<urxvt> Package
357
358	=over 4
359
360	=item $term = new urxvt [arg...]
361
362	Creates a new terminal, very similar as if you had started it with
363	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
364	if the new instance couldn't be created. Returns C<undef> if the new
365	instance didn't initialise perl, and the terminal object otherwise. The
366	C<init> and C<start> hooks will be called during the call.
367
368	=item urxvt::fatal $errormessage
369
370	Fatally aborts execution with the given error message. Avoid at all
371	costs! The only time this is acceptable is when the terminal process
372	starts up.
373
374	=item urxvt::warn $string
375
376	Calls C<rxvt_warn> with the given string which should not include a
377	newline. The module also overwrites the C<warn> builtin with a function
378	that calls this function.
379
380	Using this function has the advantage that its output ends up in the
381	correct place, e.g. on stderr of the connecting urxvtc client.
382
383	=item $is_safe = urxvt::safe
384
385	Returns true when it is safe to do potentially unsafe things, such as
386	evaluating perl code specified by the user. This is true when urxvt was
387	started setuid or setgid.
388
389	=item $time = urxvt::NOW
390
391	Returns the "current time" (as per the event loop).
392
393	=item urxvt::CurrentTime
394
395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
397	Button4Mask, Button5Mask, AnyModifier
398
399	Various constants for use in X calls and event processing.
400
401	=back
402
403	=head2 RENDITION
404
405	Rendition bitsets contain information about colour, font, font styles and
406	similar information for each screen cell.
407
408	The following "macros" deal with changes in rendition sets. You should
409	never just create a bitset, you should always modify an existing one,
410	as they contain important information required for correct operation of
411	rxvt-unicode.
412
413	=over 4
414
415	=item $rend = urxvt::DEFAULT_RSTYLE
416
417	Returns the default rendition, as used when the terminal is starting up or
418	being reset. Useful as a base to start when creating renditions.
419
420	=item $rend = urxvt::OVERLAY_RSTYLE
421
422	Return the rendition mask used for overlays by default.
423
424	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
425
426	Return the bit that enabled bold, italic, blink, reverse-video and
427	underline, respectively. To enable such a style, just logically OR it into
428	the bitset.
429
430	=item $foreground = urxvt::GET_BASEFG $rend
431
432	=item $background = urxvt::GET_BASEBG $rend
433
434	Return the foreground/background colour index, respectively.
435
436	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
437
438	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
439
440	Replace the foreground/background colour in the rendition mask with the
441	specified one.
442
443	=item $value = urxvt::GET_CUSTOM ($rend)
444
445	Return the "custom" value: Every rendition has 5 bits for use by
446	extensions. They can be set and changed as you like and are initially
447	zero.
448
449	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
450
451	Change the custom value.
452
453	=back
454
455	=cut	352	=cut
456		353
457	package urxvt;	354	package urxvt;
458		355
459	use utf8;	356	use utf8;
…		…
470		367
471	our $LIBDIR;	368	our $LIBDIR;
472	our $RESNAME;	369	our $RESNAME;
473	our $RESCLASS;	370	our $RESCLASS;
474	our $RXVTNAME;	371	our $RXVTNAME;
		372
		373	=head2 Variables in the C<urxvt> Package
		374
		375	=over 4
		376
		377	=item $urxvt::LIBDIR
		378
		379	The rxvt-unicode library directory, where, among other things, the perl
		380	modules and scripts are stored.
		381
		382	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		383
		384	The resource class and name rxvt-unicode uses to look up X resources.
		385
		386	=item $urxvt::RXVTNAME
		387
		388	The basename of the installed binaries, usually C<urxvt>.
		389
		390	=item $urxvt::TERM
		391
		392	The current terminal. This variable stores the current C<urxvt::term>
		393	object, whenever a callback/hook is executing.
		394
		395	=back
		396
		397	=head2 Functions in the C<urxvt> Package
		398
		399	=over 4
		400
		401	=item urxvt::fatal $errormessage
		402
		403	Fatally aborts execution with the given error message. Avoid at all
		404	costs! The only time this is acceptable is when the terminal process
		405	starts up.
		406
		407	=item urxvt::warn $string
		408
		409	Calls C<rxvt_warn> with the given string which should not include a
		410	newline. The module also overwrites the C<warn> builtin with a function
		411	that calls this function.
		412
		413	Using this function has the advantage that its output ends up in the
		414	correct place, e.g. on stderr of the connecting urxvtc client.
		415
		416	Messages have a size limit of 1023 bytes currently.
		417
		418	=item $is_safe = urxvt::safe
		419
		420	Returns true when it is safe to do potentially unsafe things, such as
		421	evaluating perl code specified by the user. This is true when urxvt was
		422	started setuid or setgid.
		423
		424	=item $time = urxvt::NOW
		425
		426	Returns the "current time" (as per the event loop).
		427
		428	=item urxvt::CurrentTime
		429
		430	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		431	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		432	Button4Mask, Button5Mask, AnyModifier
		433
		434	Various constants for use in X calls and event processing.
		435
		436	=back
		437
		438	=head2 RENDITION
		439
		440	Rendition bitsets contain information about colour, font, font styles and
		441	similar information for each screen cell.
		442
		443	The following "macros" deal with changes in rendition sets. You should
		444	never just create a bitset, you should always modify an existing one,
		445	as they contain important information required for correct operation of
		446	rxvt-unicode.
		447
		448	=over 4
		449
		450	=item $rend = urxvt::DEFAULT_RSTYLE
		451
		452	Returns the default rendition, as used when the terminal is starting up or
		453	being reset. Useful as a base to start when creating renditions.
		454
		455	=item $rend = urxvt::OVERLAY_RSTYLE
		456
		457	Return the rendition mask used for overlays by default.
		458
		459	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		460
		461	Return the bit that enabled bold, italic, blink, reverse-video and
		462	underline, respectively. To enable such a style, just logically OR it into
		463	the bitset.
		464
		465	=item $foreground = urxvt::GET_BASEFG $rend
		466
		467	=item $background = urxvt::GET_BASEBG $rend
		468
		469	Return the foreground/background colour index, respectively.
		470
		471	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		472
		473	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		474
		475	Replace the foreground/background colour in the rendition mask with the
		476	specified one.
		477
		478	=item $value = urxvt::GET_CUSTOM $rend
		479
		480	Return the "custom" value: Every rendition has 5 bits for use by
		481	extensions. They can be set and changed as you like and are initially
		482	zero.
		483
		484	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		485
		486	Change the custom value.
		487
		488	=back
		489
		490	=cut
475		491
476	BEGIN {	492	BEGIN {
477	urxvt->bootstrap;	493	urxvt->bootstrap;
478		494
479	# overwrite perl's warn	495	# overwrite perl's warn
…		…
482	$msg .= "\n"	498	$msg .= "\n"
483	unless $msg =~ /\n$/;	499	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	500	urxvt::warn ($msg);
485	};	501	};
486		502
		503	# %ENV is the original startup environment
487	delete $ENV{IFS};	504	delete $ENV{IFS};
488	delete $ENV{CDPATH};	505	delete $ENV{CDPATH};
489	delete $ENV{BASH_ENV};	506	delete $ENV{BASH_ENV};
490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	507	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
491	}	508	}
…		…
580	if ($@) {	597	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	598	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	599	warn $@;
583	}	600	}
584	}	601	}
		602
		603	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		604	if $verbosity >= 11;
585	}	605	}
586		606
587	if ($htype == 1) { # DESTROY	607	if ($htype == 1) { # DESTROY
588	if (my $hook = delete $TERM->{_hook}) {	608	if (my $hook = delete $TERM->{_hook}) {
589	for my $htype (0..$#$hook) {	609	for my $htype (0..$#$hook) {
…		…
600	}	620	}
601		621
602	$retval	622	$retval
603	}	623	}
604		624
		625	sub exec_async(@) {
		626	my $pid = fork;
		627
		628	return
		629	if !defined $pid or $pid;
		630
		631	%ENV = %{ $TERM->env };
		632
		633	exec @_;
		634	_exit 255;
		635	}
		636
605	# urxvt::term::extension	637	# urxvt::term::extension
606		638
607	package urxvt::term::extension;	639	package urxvt::term::extension;
608		640
609	sub enable {	641	sub enable {
…		…
675		707
676	=head2 The C<urxvt::anyevent> Class	708	=head2 The C<urxvt::anyevent> Class
677		709
678	The sole purpose of this class is to deliver an interface to the	710	The sole purpose of this class is to deliver an interface to the
679	C<AnyEvent> module - any module using it will work inside urxvt without	711	C<AnyEvent> module - any module using it will work inside urxvt without
680	further work. The only exception is that you cannot wait on condition	712	further programming. The only exception is that you cannot wait on
681	variables, but non-blocking condvar use is ok. What this means is that you	713	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	714	is that you cannot use blocking APIs, but the non-blocking variant should
		715	work.
683		716
684	=cut	717	=cut
685		718
686	our $VERSION = 1;	719	our $VERSION = 1;
687		720
…		…
764	$proxy->enable ($name => $ref);	797	$proxy->enable ($name => $ref);
765	}	798	}
766	}	799	}
767	}	800	}
768		801
		802	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		803
		804	Creates a new terminal, very similar as if you had started it with system
		805	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		806	hash which defines the environment of the new terminal.
		807
		808	Croaks (and probably outputs an error message) if the new instance
		809	couldn't be created. Returns C<undef> if the new instance didn't
		810	initialise perl, and the terminal object otherwise. The C<init> and
		811	C<start> hooks will be called during this call.
		812
		813	=cut
		814
		815	sub new {
		816	my ($class, $env, @args) = @_;
		817
		818	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		819	}
		820
769	=item $term->destroy	821	=item $term->destroy
770		822
771	Destroy the terminal object (close the window, free resources etc.).	823	Destroy the terminal object (close the window, free resources
		824	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		825	watchers (timers, io watchers) are still active.
772		826
773	=item $isset = $term->option ($optval[, $set])	827	=item $isset = $term->option ($optval[, $set])
774		828
775	Returns true if the option specified by C<$optval> is enabled, and	829	Returns true if the option specified by C<$optval> is enabled, and
776	optionally change it. All option values are stored by name in the hash	830	optionally change it. All option values are stored by name in the hash
…		…
826	my ($self, $name) = (shift, shift);	880	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	881	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	882	&urxvt::term::_resource
829	}	883	}
830		884
		885	=item $value = $term->x_resource ($pattern)
		886
		887	Returns the X-Resource for the given pattern, excluding the program or
		888	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		889	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		890	resource with that pattern exists.
		891
		892	This method should only be called during the C<on_start> hook, as there is
		893	only one resource database per display, and later invocations might return
		894	the wrong resources.
		895
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	896	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		897
833	Adds a keymap translation exactly as specified via a resource. See the	898	Adds a keymap translation exactly as specified via a resource. See the
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	899	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835		900
…		…
850	=item ($row, $col) = $term->selection_end ([$row, $col])	915	=item ($row, $col) = $term->selection_end ([$row, $col])
851		916
852	Return the current values of the selection mark, begin or end positions,	917	Return the current values of the selection mark, begin or end positions,
853	and optionally set them to new values.	918	and optionally set them to new values.
854		919
		920	=item $term->selection_make ($eventtime[, $rectangular])
		921
		922	Tries to make a selection as set by C<selection_beg> and
		923	C<selection_end>. If C<$rectangular> is true (default: false), a
		924	rectangular selection will be made. This is the prefered function to make
		925	a selection.
		926
855	=item $success = $term->selection_grab ($eventtime)	927	=item $success = $term->selection_grab ($eventtime)
856		928
857	Try to request the primary selection from the server (for example, as set	929	Try to request the primary selection text from the server (for example, as
858	by the next method).	930	set by the next method). No visual feedback will be given. This function
		931	is mostly useful from within C<on_sel_grab> hooks.
859		932
860	=item $oldtext = $term->selection ([$newtext])	933	=item $oldtext = $term->selection ([$newtext])
861		934
862	Return the current selection text and optionally replace it by C<$newtext>.	935	Return the current selection text and optionally replace it by C<$newtext>.
863		936
…		…
956	Convert the given locale-encoded octets into a perl string.	1029	Convert the given locale-encoded octets into a perl string.
957		1030
958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1031	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959		1032
960	XORs the rendition values in the given span with the provided value	1033	XORs the rendition values in the given span with the provided value
961	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1034	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962	to the selection.	1035	refresh hooks to provide effects similar to the selection.
963		1036
964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1037	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965		1038
966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1039	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1040	whitespace will additionally be xored with the C<$rstyle2>, which defaults
968	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1041	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
969	it instead.	1042	it instead. Both styles I<MUST NOT> contain font styles.
970		1043
971	=item $term->scr_bell	1044	=item $term->scr_bell
972		1045
973	Ring the bell!	1046	Ring the bell!
974		1047
…		…
1034		1107
1035	=item $lines_in_scrollback = $term->nsaved	1108	=item $lines_in_scrollback = $term->nsaved
1036		1109
1037	Return various integers describing terminal characteristics.	1110	Return various integers describing terminal characteristics.
1038		1111
		1112	=item $x_display = $term->display_id
		1113
		1114	Return the DISPLAY used by rxvt-unicode.
		1115
1039	=item $lc_ctype = $term->locale	1116	=item $lc_ctype = $term->locale
1040		1117
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1118	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1119
1043	=item $x_display = $term->display_id	1120	=item $env = $term->env
1044		1121
1045	Return the DISPLAY used by rxvt-unicode.	1122	Returns a copy of the environment in effect for the terminal as a hashref
		1123	similar to C<\%ENV>.
		1124
		1125	=cut
		1126
		1127	sub env {
		1128	if (my $env = $_[0]->_env) {
		1129	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1130	} else {
		1131	+{ %ENV }
		1132	}
		1133	}
1046		1134
1047	=item $modifiermask = $term->ModLevel3Mask	1135	=item $modifiermask = $term->ModLevel3Mask
1048		1136
1049	=item $modifiermask = $term->ModMetaMask	1137	=item $modifiermask = $term->ModMetaMask
1050		1138
…		…
1143	Return the row number of the first/last row of the line, respectively.	1231	Return the row number of the first/last row of the line, respectively.
1144		1232
1145	=item $offset = $line->offset_of ($row, $col)	1233	=item $offset = $line->offset_of ($row, $col)
1146		1234
1147	Returns the character offset of the given row\|col pair within the logical	1235	Returns the character offset of the given row\|col pair within the logical
1148	line.	1236	line. Works for rows outside the line, too, and returns corresponding
		1237	offsets outside the string.
1149		1238
1150	=item ($row, $col) = $line->coord_of ($offset)	1239	=item ($row, $col) = $line->coord_of ($offset)
1151		1240
1152	Translates a string offset into terminal coordinates again.	1241	Translates a string offset into terminal coordinates again.
1153		1242
…		…
1290	$item->{render} \|\|= sub { $_[0]{text} };	1379	$item->{render} \|\|= sub { $_[0]{text} };
1291		1380
1292	push @{ $self->{item} }, $item;	1381	push @{ $self->{item} }, $item;
1293	}	1382	}
1294		1383
		1384	=item $popup->add_title ($title)
		1385
		1386	Adds a non-clickable title to the popup.
		1387
		1388	=cut
		1389
		1390	sub add_title {
		1391	my ($self, $title) = @_;
		1392
		1393	$self->add_item ({
		1394	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1395	text => $title,
		1396	activate => sub { },
		1397	});
		1398	}
		1399
		1400	=item $popup->add_separator ([$sepchr])
		1401
		1402	Creates a separator, optionally using the character given as C<$sepchr>.
		1403
		1404	=cut
		1405
1295	sub add_separator {	1406	sub add_separator {
1296	my ($self, $sep) = @_;	1407	my ($self, $sep) = @_;
1297		1408
1298	$sep \|\|= "=";	1409	$sep \|\|= "=";
1299		1410
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1414	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1415	activate => sub { },
1305	});	1416	});
1306	}	1417	}
1307		1418
1308	sub add_title {	1419	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1420
1311	$self->add_item ({	1421	Adds a clickable button to the popup. C<$cb> is called whenever it is
1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1422	selected.
1313	text => $title,	1423
1314	activate => sub { },	1424	=cut
1315	});
1316	}
1317		1425
1318	sub add_button {	1426	sub add_button {
1319	my ($self, $text, $cb) = @_;	1427	my ($self, $text, $cb) = @_;
1320		1428
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1429	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	1430	}
		1431
		1432	=item $popup->add_toggle ($text, $cb, $initial_value)
		1433
		1434	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1435	whenever it gets toggled, with a boolean indicating its value as its first
		1436	argument.
		1437
		1438	=cut
1323		1439
1324	sub add_toggle {	1440	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1441	my ($self, $text, $cb, $value) = @_;
1326		1442
1327	my $item; $item = {	1443	my $item; $item = {
1328	type => "button",	1444	type => "button",
1329	text => " $text",	1445	text => " $text",
1330	value => $value,	1446	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1447	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1448	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1449	};
1334		1450
1335	$self->add_item ($item);	1451	$self->add_item ($item);
1336	}	1452	}
		1453
		1454	=item $popup->show
		1455
		1456	Displays the popup (which is initially hidden).
		1457
		1458	=cut
1337		1459
1338	sub show {	1460	sub show {
1339	my ($self) = @_;	1461	my ($self) = @_;
1340		1462
1341	local $urxvt::popup::self = $self;	1463	local $urxvt::popup::self = $self;
1342		1464
		1465	my $env = $self->{term}->env;
		1466	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1467	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1468	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1469
		1470	urxvt::term->new ($env, $self->{term}->resource ("name"),
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1471	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1346	"--transient-for" => $self->{term}->parent,	1472	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1473	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1474	"-pe" => "urxvt-popup")
1349	or die "unable to create popup window\n";	1475	or die "unable to create popup window\n";
1350	}	1476	}
1351		1477
1352	sub DESTROY {	1478	sub DESTROY {
1353	my ($self) = @_;	1479	my ($self) = @_;
1354		1480
1355	delete $self->{term}{_destroy}{$self};	1481	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1482	$self->{term}->ungrab;
1357	}	1483	}
		1484
		1485	=back
1358		1486
1359	=head2 The C<urxvt::timer> Class	1487	=head2 The C<urxvt::timer> Class
1360		1488
1361	This class implements timer watchers/events. Time is represented as a	1489	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1490	fractional number of seconds since the epoch. Example:
…		…
1469		1597
1470	=item == 0 - fatal messages	1598	=item == 0 - fatal messages
1471		1599
1472	=item >= 3 - script loading and management	1600	=item >= 3 - script loading and management
1473		1601
1474	=item >=10 - all events received	1602	=item >=10 - all called hooks
		1603
		1604	=item >=11 - hook reutrn values
1475		1605
1476	=back	1606	=back
1477		1607
1478	=head1 AUTHOR	1608	=head1 AUTHOR
1479		1609

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs. Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC