[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.96 by root, Tue Jan 17 16:22:41 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 following bindable keyboard commands:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
55	Rot-13 the selection when activated. Used via keyboard trigger:	77	Rot-13 the selection when activated. Used via keyboard trigger:
56		78
57	URxvt.keysym.C-M-r: perl:selection:rot13	79	URxvt.keysym.C-M-r: perl:selection:rot13
		80
		81	=item remote-pastebin
		82
		83	Upload the selection as textfile to a remote site.
		84
		85	URxvt.keysym.C-M-e: perl:selection:remote-pastebin
		86
		87	To set the command to upload the file set this resource:
		88
		89	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		90
		91	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
		92	md5 sum of the selection.
		93	After an successful upload the selection will be replaced by the following url
		94	(the % is the placeholder for the filename):
		95
		96	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
58		97
59	=back	98	=back
60		99
61	=item option-popup (enabled by default)	100	=item option-popup (enabled by default)
62		101
…		…
70	evalution, web-browser starting etc.), depending on content.	109	evalution, web-browser starting etc.), depending on content.
71		110
72	=item searchable-scrollback<hotkey> (enabled by default)	111	=item searchable-scrollback<hotkey> (enabled by default)
73		112
74	Adds regex search functionality to the scrollback buffer, triggered	113	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	114	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	115	input/output is suspended and a regex is displayed at the bottom of the
		116	screen.
77		117
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	118	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	119	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>	120	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	121	bottom. C<Escape> leaves search mode and returns to the point where search
		122	was started, while C<Enter> or C<Return> stay at the current position and
		123	additionally stores the first match in the current line into the primary
		124	selection.
82		125
83	=item digital-clock	126	=item selection-autotransform
84		127
85	Displays a digital clock using the built-in overlay.	128	This selection allows you to do automatic transforms on a selection
		129	whenever a selection is made.
		130
		131	It works by specifying perl snippets (most useful is a single C<s///>
		132	operator) that modify C<$_> as resources:
		133
		134	URxvt.selection-autotransform.0: transform
		135	URxvt.selection-autotransform.1: transform
		136	...
		137
		138	For example, the following will transform selections of the form
		139	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		140	$word>:
		141
		142	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		143
		144	And this example matches the same,but replaces it with vi-commands you can
		145	paste directly into your (vi :) editor:
		146
		147	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		148
		149	Of course, this can be modified to suit your needs and your editor :)
		150
		151	To expand the example above to typical perl error messages ("XXX at
		152	FILENAME line YYY."), you need a slightly more elaborate solution:
		153
		154	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		155	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		156
		157	The first line tells the selection code to treat the unchanging part of
		158	every error message as a selection pattern, and the second line transforms
		159	the message into vi commands to load the file.
86		160
87	=item mark-urls	161	=item mark-urls
88		162
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	163	Uses per-line display filtering (C<on_line_update>) to underline urls and
		164	make them clickable. When middle-clicked, the program specified in the
		165	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		166	the URL as first argument.
90		167
91	=item block-graphics-to-ascii	168	=item block-graphics-to-ascii
92		169
93	A not very useful example of filtering all text output to the terminal,	170	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	171	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	172	similar-looking ascii character.
		173
		174	=item digital-clock
		175
		176	Displays a digital clock using the built-in overlay.
96		177
97	=item example-refresh-hooks	178	=item example-refresh-hooks
98		179
99	Displays a very simple digital clock in the upper right corner of the	180	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	181	window. Illustrates overwriting the refresh callbacks to create your own
…		…
123	=over 4	204	=over 4
124		205
125	=item $text	206	=item $text
126		207
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	208	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.	209	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		210
130	=item $string	211	=item $string
131		212
132	A perl text string, with an emphasis on I<text>. It can store all unicode	213	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	214	characters and is to be distinguished with text encoded in a specific
…		…
228	=item on_sel_extend $term	309	=item on_sel_extend $term
229		310
230	Called whenever the user tries to extend the selection (e.g. with a double	311	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	312	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	313	should extend the selection itelf and return true to suppress the built-in
233	processing.	314	processing. This can happen multiple times, as long as the callback
		315	returns true, it will be called on every further click by the user and is
		316	supposed to enlarge the selection more and more, if possible.
234		317
235	See the F<selection> example extension.	318	See the F<selection> example extension.
236		319
237	=item on_view_change $term, $offset	320	=item on_view_change $term, $offset
238		321
…		…
305		388
306	Called whenever the user presses a key combination that has a	389	Called whenever the user presses a key combination that has a
307	C<perl:string> action bound to it (see description of the B<keysym>	390	C<perl:string> action bound to it (see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	391	resource in the @@RXVT_NAME@@(1) manpage).
309		392
		393	=item on_x_event $term, $event
		394
		395	Called on every X event received on the vt window (and possibly other
		396	windows). Should only be used as a last resort. Most event structure
		397	members are not passed.
		398
310	=item on_focus_in $term	399	=item on_focus_in $term
311		400
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	401	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	402	does focus in processing.
314		403
…		…
340		429
341	C<on_key_press> additionally receives the string rxvt-unicode would	430	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	431	output, if any, in locale-specific encoding.
343		432
344	subwindow.	433	subwindow.
345
346	=back
347
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		434
471	=back	435	=back
472		436
473	=cut	437	=cut
474		438
…		…
488		452
489	our $LIBDIR;	453	our $LIBDIR;
490	our $RESNAME;	454	our $RESNAME;
491	our $RESCLASS;	455	our $RESCLASS;
492	our $RXVTNAME;	456	our $RXVTNAME;
		457
		458	=head2 Variables in the C<urxvt> Package
		459
		460	=over 4
		461
		462	=item $urxvt::LIBDIR
		463
		464	The rxvt-unicode library directory, where, among other things, the perl
		465	modules and scripts are stored.
		466
		467	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		468
		469	The resource class and name rxvt-unicode uses to look up X resources.
		470
		471	=item $urxvt::RXVTNAME
		472
		473	The basename of the installed binaries, usually C<urxvt>.
		474
		475	=item $urxvt::TERM
		476
		477	The current terminal. This variable stores the current C<urxvt::term>
		478	object, whenever a callback/hook is executing.
		479
		480	=back
		481
		482	=head2 Functions in the C<urxvt> Package
		483
		484	=over 4
		485
		486	=item urxvt::fatal $errormessage
		487
		488	Fatally aborts execution with the given error message. Avoid at all
		489	costs! The only time this is acceptable is when the terminal process
		490	starts up.
		491
		492	=item urxvt::warn $string
		493
		494	Calls C<rxvt_warn> with the given string which should not include a
		495	newline. The module also overwrites the C<warn> builtin with a function
		496	that calls this function.
		497
		498	Using this function has the advantage that its output ends up in the
		499	correct place, e.g. on stderr of the connecting urxvtc client.
		500
		501	Messages have a size limit of 1023 bytes currently.
		502
		503	=item $time = urxvt::NOW
		504
		505	Returns the "current time" (as per the event loop).
		506
		507	=item urxvt::CurrentTime
		508
		509	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		510	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		511	Button4Mask, Button5Mask, AnyModifier
		512
		513	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		514	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		515	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		516	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		517	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		518	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		519	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		520
		521	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		522	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		523	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		524	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		525	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		526	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		527	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		528
		529	Various constants for use in X calls and event processing.
		530
		531	=back
		532
		533	=head2 RENDITION
		534
		535	Rendition bitsets contain information about colour, font, font styles and
		536	similar information for each screen cell.
		537
		538	The following "macros" deal with changes in rendition sets. You should
		539	never just create a bitset, you should always modify an existing one,
		540	as they contain important information required for correct operation of
		541	rxvt-unicode.
		542
		543	=over 4
		544
		545	=item $rend = urxvt::DEFAULT_RSTYLE
		546
		547	Returns the default rendition, as used when the terminal is starting up or
		548	being reset. Useful as a base to start when creating renditions.
		549
		550	=item $rend = urxvt::OVERLAY_RSTYLE
		551
		552	Return the rendition mask used for overlays by default.
		553
		554	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		555
		556	Return the bit that enabled bold, italic, blink, reverse-video and
		557	underline, respectively. To enable such a style, just logically OR it into
		558	the bitset.
		559
		560	=item $foreground = urxvt::GET_BASEFG $rend
		561
		562	=item $background = urxvt::GET_BASEBG $rend
		563
		564	Return the foreground/background colour index, respectively.
		565
		566	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		567
		568	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		569
		570	Replace the foreground/background colour in the rendition mask with the
		571	specified one.
		572
		573	=item $value = urxvt::GET_CUSTOM $rend
		574
		575	Return the "custom" value: Every rendition has 5 bits for use by
		576	extensions. They can be set and changed as you like and are initially
		577	zero.
		578
		579	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		580
		581	Change the custom value.
		582
		583	=back
		584
		585	=cut
493		586
494	BEGIN {	587	BEGIN {
495	urxvt->bootstrap;	588	urxvt->bootstrap;
496		589
497	# overwrite perl's warn	590	# overwrite perl's warn
…		…
500	$msg .= "\n"	593	$msg .= "\n"
501	unless $msg =~ /\n$/;	594	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	595	urxvt::warn ($msg);
503	};	596	};
504		597
		598	# %ENV is the original startup environment
505	delete $ENV{IFS};	599	delete $ENV{IFS};
506	delete $ENV{CDPATH};	600	delete $ENV{CDPATH};
507	delete $ENV{BASH_ENV};	601	delete $ENV{BASH_ENV};
508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	602	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509	}	603	}
510		604
511	my @hook_count;
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	605	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		606
514	sub verbose {	607	sub verbose {
515	my ($level, $msg) = @_;	608	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	609	warn "$msg\n" if $level <= $verbosity;
…		…
529	verbose 3, "loading extension '$path' into package '$pkg'";	622	verbose 3, "loading extension '$path' into package '$pkg'";
530		623
531	open my $fh, "<:raw", $path	624	open my $fh, "<:raw", $path
532	or die "$path: $!";	625	or die "$path: $!";
533		626
534	my $source = untaint	627	my $source =
535	"package $pkg; use strict; use utf8;\n"	628	"package $pkg; use strict; use utf8;\n"
536	. "use base urxvt::term::extension::;\n"	629	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	630	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	631	. (do { local $/; <$fh> })
539	. "\n};\n1";	632	. "\n};\n1";
…		…
598	if ($@) {	691	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	692	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	693	warn $@;
601	}	694	}
602	}	695	}
		696
		697	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		698	if $verbosity >= 11;
603	}	699	}
604		700
605	if ($htype == 1) { # DESTROY	701	if ($htype == 1) { # DESTROY
606	if (my $hook = delete $TERM->{_hook}) {
607	for my $htype (0..$#$hook) {
608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
609	or set_should_invoke $htype, 0;
610	}
611	}
612
613	# clear package objects	702	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	703	%$_ = () for values %{ $TERM->{_pkg} };
615		704
616	# clear package	705	# clear package
617	%$TERM = ();	706	%$TERM = ();
618	}	707	}
619		708
620	$retval	709	$retval
		710	}
		711
		712	sub exec_async(@) {
		713	my $pid = fork;
		714
		715	return
		716	if !defined $pid or $pid;
		717
		718	%ENV = %{ $TERM->env };
		719
		720	exec @_;
		721	_exit 255;
621	}	722	}
622		723
623	# urxvt::term::extension	724	# urxvt::term::extension
624		725
625	package urxvt::term::extension;	726	package urxvt::term::extension;
…		…
631	while (my ($name, $cb) = each %hook) {	732	while (my ($name, $cb) = each %hook) {
632	my $htype = $HOOKTYPE{uc $name};	733	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	734	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	735	or Carp::croak "unsupported hook type '$name'";
635		736
		737	$self->set_should_invoke ($htype, +1)
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	738	unless exists $self->{term}{_hook}[$htype]{$pkg};
637	$hook_count[$htype]++
638	or urxvt::set_should_invoke $htype, 1;
639	}
640		739
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	740	$self->{term}{_hook}[$htype]{$pkg} = $cb;
642	}	741	}
643	}	742	}
644		743
…		…
649	for my $name (@hook) {	748	for my $name (@hook) {
650	my $htype = $HOOKTYPE{uc $name};	749	my $htype = $HOOKTYPE{uc $name};
651	defined $htype	750	defined $htype
652	or Carp::croak "unsupported hook type '$name'";	751	or Carp::croak "unsupported hook type '$name'";
653		752
		753	$self->set_should_invoke ($htype, -1)
654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	754	if delete $self->{term}{_hook}[$htype]{$pkg};
655	--$hook_count[$htype]
656	or urxvt::set_should_invoke $htype, 0;
657	}
658	}	755	}
659	}	756	}
660		757
661	our $AUTOLOAD;	758	our $AUTOLOAD;
662		759
…		…
781	for my $name (@HOOKNAME) {	878	for my $name (@HOOKNAME) {
782	if (my $ref = $pkg->can ("on_" . lc $name)) {	879	if (my $ref = $pkg->can ("on_" . lc $name)) {
783	$proxy->enable ($name => $ref);	880	$proxy->enable ($name => $ref);
784	}	881	}
785	}	882	}
		883	}
		884
		885	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		886
		887	Creates a new terminal, very similar as if you had started it with system
		888	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		889	hash which defines the environment of the new terminal.
		890
		891	Croaks (and probably outputs an error message) if the new instance
		892	couldn't be created. Returns C<undef> if the new instance didn't
		893	initialise perl, and the terminal object otherwise. The C<init> and
		894	C<start> hooks will be called during this call.
		895
		896	=cut
		897
		898	sub new {
		899	my ($class, $env, @args) = @_;
		900
		901	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
786	}	902	}
787		903
788	=item $term->destroy	904	=item $term->destroy
789		905
790	Destroy the terminal object (close the window, free resources	906	Destroy the terminal object (close the window, free resources
…		…
847	my ($self, $name) = (shift, shift);	963	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	964	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	965	&urxvt::term::_resource
850	}	966	}
851		967
		968	=item $value = $term->x_resource ($pattern)
		969
		970	Returns the X-Resource for the given pattern, excluding the program or
		971	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		972	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		973	resource with that pattern exists.
		974
		975	This method should only be called during the C<on_start> hook, as there is
		976	only one resource database per display, and later invocations might return
		977	the wrong resources.
		978
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	979	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		980
854	Adds a keymap translation exactly as specified via a resource. See the	981	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	982	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		983
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	998	=item ($row, $col) = $term->selection_end ([$row, $col])
872		999
873	Return the current values of the selection mark, begin or end positions,	1000	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	1001	and optionally set them to new values.
875		1002
		1003	=item $term->selection_make ($eventtime[, $rectangular])
		1004
		1005	Tries to make a selection as set by C<selection_beg> and
		1006	C<selection_end>. If C<$rectangular> is true (default: false), a
		1007	rectangular selection will be made. This is the prefered function to make
		1008	a selection.
		1009
876	=item $success = $term->selection_grab ($eventtime)	1010	=item $success = $term->selection_grab ($eventtime)
877		1011
878	Try to request the primary selection from the server (for example, as set	1012	Try to request the primary selection text from the server (for example, as
879	by the next method).	1013	set by the next method). No visual feedback will be given. This function
		1014	is mostly useful from within C<on_sel_grab> hooks.
880		1015
881	=item $oldtext = $term->selection ([$newtext])	1016	=item $oldtext = $term->selection ([$newtext])
882		1017
883	Return the current selection text and optionally replace it by C<$newtext>.	1018	Return the current selection text and optionally replace it by C<$newtext>.
884		1019
…		…
977	Convert the given locale-encoded octets into a perl string.	1112	Convert the given locale-encoded octets into a perl string.
978		1113
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1114	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1115
981	XORs the rendition values in the given span with the provided value	1116	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	1117	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1118	refresh hooks to provide effects similar to the selection.
984		1119
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1120	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1121
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1122	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1123	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	1124	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
990	it instead.	1125	it instead. Both styles I<MUST NOT> contain font styles.
991		1126
992	=item $term->scr_bell	1127	=item $term->scr_bell
993		1128
994	Ring the bell!	1129	Ring the bell!
995		1130
…		…
1029		1164
1030	=item $windowid = $term->vt	1165	=item $windowid = $term->vt
1031		1166
1032	Return the window id of the terminal window.	1167	Return the window id of the terminal window.
1033		1168
		1169	=item $term->vt_emask_add ($x_event_mask)
		1170
		1171	Adds the specified events to the vt event mask. Useful e.g. when you want
		1172	to receive pointer events all the times:
		1173
		1174	$term->vt_emask_add (urxvt::PointerMotionMask);
		1175
1034	=item $window_width = $term->width	1176	=item $window_width = $term->width
1035		1177
1036	=item $window_height = $term->height	1178	=item $window_height = $term->height
1037		1179
1038	=item $font_width = $term->fwidth	1180	=item $font_width = $term->fwidth
…		…
1051		1193
1052	=item $max_scrollback = $term->saveLines	1194	=item $max_scrollback = $term->saveLines
1053		1195
1054	=item $nrow_plus_saveLines = $term->total_rows	1196	=item $nrow_plus_saveLines = $term->total_rows
1055		1197
1056	=item $lines_in_scrollback = $term->nsaved	1198	=item $topmost_scrollback_row = $term->top_row
1057		1199
1058	Return various integers describing terminal characteristics.	1200	Return various integers describing terminal characteristics.
1059		1201
		1202	=item $x_display = $term->display_id
		1203
		1204	Return the DISPLAY used by rxvt-unicode.
		1205
1060	=item $lc_ctype = $term->locale	1206	=item $lc_ctype = $term->locale
1061		1207
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1208	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1209
1064	=item $x_display = $term->display_id	1210	=item $env = $term->env
1065		1211
1066	Return the DISPLAY used by rxvt-unicode.	1212	Returns a copy of the environment in effect for the terminal as a hashref
		1213	similar to C<\%ENV>.
		1214
		1215	=cut
		1216
		1217	sub env {
		1218	if (my $env = $_[0]->_env) {
		1219	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1220	} else {
		1221	+{ %ENV }
		1222	}
		1223	}
1067		1224
1068	=item $modifiermask = $term->ModLevel3Mask	1225	=item $modifiermask = $term->ModLevel3Mask
1069		1226
1070	=item $modifiermask = $term->ModMetaMask	1227	=item $modifiermask = $term->ModMetaMask
1071		1228
…		…
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1231	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1075	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1232	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1233
1077	=item $view_start = $term->view_start ([$newvalue])	1234	=item $view_start = $term->view_start ([$newvalue])
1078		1235
1079	Returns the negative row number of the topmost line. Minimum value is	1236	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1237	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1238	this many lines into the scrollback buffer.
1082		1239
1083	=item $term->want_refresh	1240	=item $term->want_refresh
1084		1241
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1242	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1164	Return the row number of the first/last row of the line, respectively.	1321	Return the row number of the first/last row of the line, respectively.
1165		1322
1166	=item $offset = $line->offset_of ($row, $col)	1323	=item $offset = $line->offset_of ($row, $col)
1167		1324
1168	Returns the character offset of the given row\|col pair within the logical	1325	Returns the character offset of the given row\|col pair within the logical
1169	line.	1326	line. Works for rows outside the line, too, and returns corresponding
		1327	offsets outside the string.
1170		1328
1171	=item ($row, $col) = $line->coord_of ($offset)	1329	=item ($row, $col) = $line->coord_of ($offset)
1172		1330
1173	Translates a string offset into terminal coordinates again.	1331	Translates a string offset into terminal coordinates again.
1174		1332
…		…
1311	$item->{render} \|\|= sub { $_[0]{text} };	1469	$item->{render} \|\|= sub { $_[0]{text} };
1312		1470
1313	push @{ $self->{item} }, $item;	1471	push @{ $self->{item} }, $item;
1314	}	1472	}
1315		1473
		1474	=item $popup->add_title ($title)
		1475
		1476	Adds a non-clickable title to the popup.
		1477
		1478	=cut
		1479
		1480	sub add_title {
		1481	my ($self, $title) = @_;
		1482
		1483	$self->add_item ({
		1484	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1485	text => $title,
		1486	activate => sub { },
		1487	});
		1488	}
		1489
		1490	=item $popup->add_separator ([$sepchr])
		1491
		1492	Creates a separator, optionally using the character given as C<$sepchr>.
		1493
		1494	=cut
		1495
1316	sub add_separator {	1496	sub add_separator {
1317	my ($self, $sep) = @_;	1497	my ($self, $sep) = @_;
1318		1498
1319	$sep \|\|= "=";	1499	$sep \|\|= "=";
1320		1500
…		…
1324	render => sub { $sep x $self->{term}->ncol },	1504	render => sub { $sep x $self->{term}->ncol },
1325	activate => sub { },	1505	activate => sub { },
1326	});	1506	});
1327	}	1507	}
1328		1508
1329	sub add_title {	1509	=item $popup->add_button ($text, $cb)
1330	my ($self, $title) = @_;
1331		1510
1332	$self->add_item ({	1511	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" },	1512	selected.
1334	text => $title,	1513
1335	activate => sub { },	1514	=cut
1336	});
1337	}
1338		1515
1339	sub add_button {	1516	sub add_button {
1340	my ($self, $text, $cb) = @_;	1517	my ($self, $text, $cb) = @_;
1341		1518
1342	$self->add_item ({ type => "button", text => $text, activate => $cb});	1519	$self->add_item ({ type => "button", text => $text, activate => $cb});
1343	}	1520	}
		1521
		1522	=item $popup->add_toggle ($text, $cb, $initial_value)
		1523
		1524	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1525	whenever it gets toggled, with a boolean indicating its value as its first
		1526	argument.
		1527
		1528	=cut
1344		1529
1345	sub add_toggle {	1530	sub add_toggle {
1346	my ($self, $text, $cb, $value) = @_;	1531	my ($self, $text, $cb, $value) = @_;
1347		1532
1348	my $item; $item = {	1533	my $item; $item = {
1349	type => "button",	1534	type => "button",
1350	text => " $text",	1535	text => " $text",
1351	value => $value,	1536	value => $value,
1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1537	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1538	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354	};	1539	};
1355		1540
1356	$self->add_item ($item);	1541	$self->add_item ($item);
1357	}	1542	}
		1543
		1544	=item $popup->show
		1545
		1546	Displays the popup (which is initially hidden).
		1547
		1548	=cut
1358		1549
1359	sub show {	1550	sub show {
1360	my ($self) = @_;	1551	my ($self) = @_;
1361		1552
1362	local $urxvt::popup::self = $self;	1553	local $urxvt::popup::self = $self;
1363		1554
		1555	my $env = $self->{term}->env;
		1556	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1557	delete $env->{LC_ALL};
1364	local $ENV{LC_ALL} = $self->{term}->locale;	1558	$env->{LC_CTYPE} = $self->{term}->locale;
1365		1559
		1560	urxvt::term->new ($env, $self->{term}->resource ("name"),
1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1561	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1367	"--transient-for" => $self->{term}->parent,	1562	"--transient-for" => $self->{term}->parent,
1368	"-display" => $self->{term}->display_id,	1563	"-display" => $self->{term}->display_id,
1369	"-pe" => "urxvt-popup")	1564	"-pe" => "urxvt-popup")
1370	or die "unable to create popup window\n";	1565	or die "unable to create popup window\n";
1371	}	1566	}
1372		1567
1373	sub DESTROY {	1568	sub DESTROY {
1374	my ($self) = @_;	1569	my ($self) = @_;
1375		1570
1376	delete $self->{term}{_destroy}{$self};	1571	delete $self->{term}{_destroy}{$self};
1377	$self->{term}->ungrab;	1572	$self->{term}->ungrab;
1378	}	1573	}
		1574
		1575	=back
1379		1576
1380	=head2 The C<urxvt::timer> Class	1577	=head2 The C<urxvt::timer> Class
1381		1578
1382	This class implements timer watchers/events. Time is represented as a	1579	This class implements timer watchers/events. Time is represented as a
1383	fractional number of seconds since the epoch. Example:	1580	fractional number of seconds since the epoch. Example:
…		…
1490		1687
1491	=item == 0 - fatal messages	1688	=item == 0 - fatal messages
1492		1689
1493	=item >= 3 - script loading and management	1690	=item >= 3 - script loading and management
1494		1691
1495	=item >=10 - all events received	1692	=item >=10 - all called hooks
		1693
		1694	=item >=11 - hook reutrn values
1496		1695
1497	=back	1696	=back
1498		1697
1499	=head1 AUTHOR	1698	=head1 AUTHOR
1500		1699

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.96 by root, Tue Jan 17 16:22:41 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.96 by root, Tue Jan 17 16:22:41 2006 UTC