[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.99 by root, Tue Jan 17 17:09:26 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
…		…
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/^([^:[:space:]]+):(\\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/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		131
		132	Of course, this can be modified to suit your needs and your editor :)
		133
		134	To expand the example above to typical perl error messages ("XXX at
		135	FILENAME line YYY."), you need a slightly more elaborate solution:
		136
		137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		139
		140	The first line tells the selection code to treat the unchanging part of
		141	every error message as a selection pattern, and the second line transforms
		142	the message into vi commands to load the file.
86		143
87	=item mark-urls	144	=item mark-urls
88		145
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	146	Uses per-line display filtering (C<on_line_update>) to underline urls and
		147	make them clickable. When middle-clicked, the program specified in the
		148	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		149	the URL as first argument.
90		150
91	=item block-graphics-to-ascii	151	=item block-graphics-to-ascii
92		152
93	A not very useful example of filtering all text output to the terminal,	153	A not very useful example of filtering all text output to the terminal,
94	by replacing all line-drawing characters (U+2500 .. U+259F) by a	154	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	155	similar-looking ascii character.
96		156
		157	=item digital-clock
		158
		159	Displays a digital clock using the built-in overlay.
		160
97	=item example-refresh-hooks	161	=item example-refresh-hooks
98		162
99	Displays a very simple digital clock in the upper right corner of the	163	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	164	window. Illustrates overwriting the refresh callbacks to create your own
101	overlays or changes.	165	overlays or changes.
		166
		167	=item selection-pastebin
		168
		169	This is a little rarely useful extension that Uploads the selection as
		170	textfile to a remote site (or does other things). (The implementation is
		171	not currently secure for use in a multiuser environment as it writes to
		172	F</tmp> directly.).
		173
		174	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		175	i.e.
		176
		177	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		178
		179	Pressing this combination runs a command with C<%> replaced by the name of
		180	the textfile. This command can be set via a resource:
		181
		182	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		183
		184	And the default is likely not useful to anybody but the few people around
		185	here :)
		186
		187	The name of the textfile is the hex encoded md5 sum of the selection, so
		188	the same content should lead to the same filename.
		189
		190	After a successful upload the selection will be replaced by the text given
		191	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		192	for the filename):
		193
		194	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
102		195
103	=back	196	=back
104		197
105	=head1 API DOCUMENTATION	198	=head1 API DOCUMENTATION
106		199
…		…
123	=over 4	216	=over 4
124		217
125	=item $text	218	=item $text
126		219
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	220	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.	221	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		222
130	=item $string	223	=item $string
131		224
132	A perl text string, with an emphasis on I<text>. It can store all unicode	225	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	226	characters and is to be distinguished with text encoded in a specific
…		…
228	=item on_sel_extend $term	321	=item on_sel_extend $term
229		322
230	Called whenever the user tries to extend the selection (e.g. with a double	323	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	324	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	325	should extend the selection itelf and return true to suppress the built-in
233	processing.	326	processing. This can happen multiple times, as long as the callback
		327	returns true, it will be called on every further click by the user and is
		328	supposed to enlarge the selection more and more, if possible.
234		329
235	See the F<selection> example extension.	330	See the F<selection> example extension.
236		331
237	=item on_view_change $term, $offset	332	=item on_view_change $term, $offset
238		333
…		…
305		400
306	Called whenever the user presses a key combination that has a	401	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>	402	C<perl:string> action bound to it (see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	403	resource in the @@RXVT_NAME@@(1) manpage).
309		404
		405	=item on_x_event $term, $event
		406
		407	Called on every X event received on the vt window (and possibly other
		408	windows). Should only be used as a last resort. Most event structure
		409	members are not passed.
		410
310	=item on_focus_in $term	411	=item on_focus_in $term
311		412
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	413	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	414	does focus in processing.
314		415
…		…
340		441
341	C<on_key_press> additionally receives the string rxvt-unicode would	442	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	443	output, if any, in locale-specific encoding.
343		444
344	subwindow.	445	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		446
471	=back	447	=back
472		448
473	=cut	449	=cut
474		450
…		…
488		464
489	our $LIBDIR;	465	our $LIBDIR;
490	our $RESNAME;	466	our $RESNAME;
491	our $RESCLASS;	467	our $RESCLASS;
492	our $RXVTNAME;	468	our $RXVTNAME;
		469
		470	=head2 Variables in the C<urxvt> Package
		471
		472	=over 4
		473
		474	=item $urxvt::LIBDIR
		475
		476	The rxvt-unicode library directory, where, among other things, the perl
		477	modules and scripts are stored.
		478
		479	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		480
		481	The resource class and name rxvt-unicode uses to look up X resources.
		482
		483	=item $urxvt::RXVTNAME
		484
		485	The basename of the installed binaries, usually C<urxvt>.
		486
		487	=item $urxvt::TERM
		488
		489	The current terminal. This variable stores the current C<urxvt::term>
		490	object, whenever a callback/hook is executing.
		491
		492	=back
		493
		494	=head2 Functions in the C<urxvt> Package
		495
		496	=over 4
		497
		498	=item urxvt::fatal $errormessage
		499
		500	Fatally aborts execution with the given error message. Avoid at all
		501	costs! The only time this is acceptable is when the terminal process
		502	starts up.
		503
		504	=item urxvt::warn $string
		505
		506	Calls C<rxvt_warn> with the given string which should not include a
		507	newline. The module also overwrites the C<warn> builtin with a function
		508	that calls this function.
		509
		510	Using this function has the advantage that its output ends up in the
		511	correct place, e.g. on stderr of the connecting urxvtc client.
		512
		513	Messages have a size limit of 1023 bytes currently.
		514
		515	=item $time = urxvt::NOW
		516
		517	Returns the "current time" (as per the event loop).
		518
		519	=item urxvt::CurrentTime
		520
		521	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		522	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		523	Button4Mask, Button5Mask, AnyModifier
		524
		525	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		526	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		527	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		528	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		529	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		530	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		531	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		532
		533	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		534	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		535	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		536	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		537	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		538	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		539	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		540
		541	Various constants for use in X calls and event processing.
		542
		543	=back
		544
		545	=head2 RENDITION
		546
		547	Rendition bitsets contain information about colour, font, font styles and
		548	similar information for each screen cell.
		549
		550	The following "macros" deal with changes in rendition sets. You should
		551	never just create a bitset, you should always modify an existing one,
		552	as they contain important information required for correct operation of
		553	rxvt-unicode.
		554
		555	=over 4
		556
		557	=item $rend = urxvt::DEFAULT_RSTYLE
		558
		559	Returns the default rendition, as used when the terminal is starting up or
		560	being reset. Useful as a base to start when creating renditions.
		561
		562	=item $rend = urxvt::OVERLAY_RSTYLE
		563
		564	Return the rendition mask used for overlays by default.
		565
		566	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		567
		568	Return the bit that enabled bold, italic, blink, reverse-video and
		569	underline, respectively. To enable such a style, just logically OR it into
		570	the bitset.
		571
		572	=item $foreground = urxvt::GET_BASEFG $rend
		573
		574	=item $background = urxvt::GET_BASEBG $rend
		575
		576	Return the foreground/background colour index, respectively.
		577
		578	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		579
		580	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		581
		582	Replace the foreground/background colour in the rendition mask with the
		583	specified one.
		584
		585	=item $value = urxvt::GET_CUSTOM $rend
		586
		587	Return the "custom" value: Every rendition has 5 bits for use by
		588	extensions. They can be set and changed as you like and are initially
		589	zero.
		590
		591	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		592
		593	Change the custom value.
		594
		595	=back
		596
		597	=cut
493		598
494	BEGIN {	599	BEGIN {
495	urxvt->bootstrap;	600	urxvt->bootstrap;
496		601
497	# overwrite perl's warn	602	# overwrite perl's warn
…		…
500	$msg .= "\n"	605	$msg .= "\n"
501	unless $msg =~ /\n$/;	606	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	607	urxvt::warn ($msg);
503	};	608	};
504		609
		610	# %ENV is the original startup environment
505	delete $ENV{IFS};	611	delete $ENV{IFS};
506	delete $ENV{CDPATH};	612	delete $ENV{CDPATH};
507	delete $ENV{BASH_ENV};	613	delete $ENV{BASH_ENV};
508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	614	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509	}	615	}
510		616
511	my @hook_count;
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		618
514	sub verbose {	619	sub verbose {
515	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
…		…
529	verbose 3, "loading extension '$path' into package '$pkg'";	634	verbose 3, "loading extension '$path' into package '$pkg'";
530		635
531	open my $fh, "<:raw", $path	636	open my $fh, "<:raw", $path
532	or die "$path: $!";	637	or die "$path: $!";
533		638
534	my $source = untaint	639	my $source =
535	"package $pkg; use strict; use utf8;\n"	640	"package $pkg; use strict; use utf8;\n"
536	. "use base urxvt::term::extension::;\n"	641	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	642	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	643	. (do { local $/; <$fh> })
539	. "\n};\n1";	644	. "\n};\n1";
…		…
598	if ($@) {	703	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	704	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	705	warn $@;
601	}	706	}
602	}	707	}
		708
		709	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		710	if $verbosity >= 11;
603	}	711	}
604		712
605	if ($htype == 1) { # DESTROY	713	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	714	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	715	%$_ = () for values %{ $TERM->{_pkg} };
615		716
616	# clear package	717	# clear package
617	%$TERM = ();	718	%$TERM = ();
618	}	719	}
619		720
620	$retval	721	$retval
		722	}
		723
		724	sub exec_async(@) {
		725	my $pid = fork;
		726
		727	return
		728	if !defined $pid or $pid;
		729
		730	%ENV = %{ $TERM->env };
		731
		732	exec @_;
		733	_exit 255;
621	}	734	}
622		735
623	# urxvt::term::extension	736	# urxvt::term::extension
624		737
625	package urxvt::term::extension;	738	package urxvt::term::extension;
…		…
631	while (my ($name, $cb) = each %hook) {	744	while (my ($name, $cb) = each %hook) {
632	my $htype = $HOOKTYPE{uc $name};	745	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	746	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	747	or Carp::croak "unsupported hook type '$name'";
635		748
		749	$self->set_should_invoke ($htype, +1)
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	750	unless exists $self->{term}{_hook}[$htype]{$pkg};
637	$hook_count[$htype]++
638	or urxvt::set_should_invoke $htype, 1;
639	}
640		751
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	752	$self->{term}{_hook}[$htype]{$pkg} = $cb;
642	}	753	}
643	}	754	}
644		755
…		…
649	for my $name (@hook) {	760	for my $name (@hook) {
650	my $htype = $HOOKTYPE{uc $name};	761	my $htype = $HOOKTYPE{uc $name};
651	defined $htype	762	defined $htype
652	or Carp::croak "unsupported hook type '$name'";	763	or Carp::croak "unsupported hook type '$name'";
653		764
		765	$self->set_should_invoke ($htype, -1)
654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	766	if delete $self->{term}{_hook}[$htype]{$pkg};
655	--$hook_count[$htype]
656	or urxvt::set_should_invoke $htype, 0;
657	}
658	}	767	}
659	}	768	}
660		769
661	our $AUTOLOAD;	770	our $AUTOLOAD;
662		771
…		…
781	for my $name (@HOOKNAME) {	890	for my $name (@HOOKNAME) {
782	if (my $ref = $pkg->can ("on_" . lc $name)) {	891	if (my $ref = $pkg->can ("on_" . lc $name)) {
783	$proxy->enable ($name => $ref);	892	$proxy->enable ($name => $ref);
784	}	893	}
785	}	894	}
		895	}
		896
		897	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		898
		899	Creates a new terminal, very similar as if you had started it with system
		900	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		901	hash which defines the environment of the new terminal.
		902
		903	Croaks (and probably outputs an error message) if the new instance
		904	couldn't be created. Returns C<undef> if the new instance didn't
		905	initialise perl, and the terminal object otherwise. The C<init> and
		906	C<start> hooks will be called during this call.
		907
		908	=cut
		909
		910	sub new {
		911	my ($class, $env, @args) = @_;
		912
		913	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
786	}	914	}
787		915
788	=item $term->destroy	916	=item $term->destroy
789		917
790	Destroy the terminal object (close the window, free resources	918	Destroy the terminal object (close the window, free resources
…		…
847	my ($self, $name) = (shift, shift);	975	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	976	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	977	&urxvt::term::_resource
850	}	978	}
851		979
		980	=item $value = $term->x_resource ($pattern)
		981
		982	Returns the X-Resource for the given pattern, excluding the program or
		983	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		984	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		985	resource with that pattern exists.
		986
		987	This method should only be called during the C<on_start> hook, as there is
		988	only one resource database per display, and later invocations might return
		989	the wrong resources.
		990
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	991	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		992
854	Adds a keymap translation exactly as specified via a resource. See the	993	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	994	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		995
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	1010	=item ($row, $col) = $term->selection_end ([$row, $col])
872		1011
873	Return the current values of the selection mark, begin or end positions,	1012	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	1013	and optionally set them to new values.
875		1014
		1015	=item $term->selection_make ($eventtime[, $rectangular])
		1016
		1017	Tries to make a selection as set by C<selection_beg> and
		1018	C<selection_end>. If C<$rectangular> is true (default: false), a
		1019	rectangular selection will be made. This is the prefered function to make
		1020	a selection.
		1021
876	=item $success = $term->selection_grab ($eventtime)	1022	=item $success = $term->selection_grab ($eventtime)
877		1023
878	Try to request the primary selection from the server (for example, as set	1024	Try to request the primary selection text from the server (for example, as
879	by the next method).	1025	set by the next method). No visual feedback will be given. This function
		1026	is mostly useful from within C<on_sel_grab> hooks.
880		1027
881	=item $oldtext = $term->selection ([$newtext])	1028	=item $oldtext = $term->selection ([$newtext])
882		1029
883	Return the current selection text and optionally replace it by C<$newtext>.	1030	Return the current selection text and optionally replace it by C<$newtext>.
884		1031
…		…
977	Convert the given locale-encoded octets into a perl string.	1124	Convert the given locale-encoded octets into a perl string.
978		1125
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1126	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1127
981	XORs the rendition values in the given span with the provided value	1128	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	1129	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1130	refresh hooks to provide effects similar to the selection.
984		1131
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1132	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1133
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1134	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1135	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	1136	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
990	it instead.	1137	it instead. Both styles I<MUST NOT> contain font styles.
991		1138
992	=item $term->scr_bell	1139	=item $term->scr_bell
993		1140
994	Ring the bell!	1141	Ring the bell!
995		1142
…		…
1029		1176
1030	=item $windowid = $term->vt	1177	=item $windowid = $term->vt
1031		1178
1032	Return the window id of the terminal window.	1179	Return the window id of the terminal window.
1033		1180
		1181	=item $term->vt_emask_add ($x_event_mask)
		1182
		1183	Adds the specified events to the vt event mask. Useful e.g. when you want
		1184	to receive pointer events all the times:
		1185
		1186	$term->vt_emask_add (urxvt::PointerMotionMask);
		1187
1034	=item $window_width = $term->width	1188	=item $window_width = $term->width
1035		1189
1036	=item $window_height = $term->height	1190	=item $window_height = $term->height
1037		1191
1038	=item $font_width = $term->fwidth	1192	=item $font_width = $term->fwidth
…		…
1051		1205
1052	=item $max_scrollback = $term->saveLines	1206	=item $max_scrollback = $term->saveLines
1053		1207
1054	=item $nrow_plus_saveLines = $term->total_rows	1208	=item $nrow_plus_saveLines = $term->total_rows
1055		1209
1056	=item $lines_in_scrollback = $term->nsaved	1210	=item $topmost_scrollback_row = $term->top_row
1057		1211
1058	Return various integers describing terminal characteristics.	1212	Return various integers describing terminal characteristics.
1059		1213
		1214	=item $x_display = $term->display_id
		1215
		1216	Return the DISPLAY used by rxvt-unicode.
		1217
1060	=item $lc_ctype = $term->locale	1218	=item $lc_ctype = $term->locale
1061		1219
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1220	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1221
1064	=item $x_display = $term->display_id	1222	=item $env = $term->env
1065		1223
1066	Return the DISPLAY used by rxvt-unicode.	1224	Returns a copy of the environment in effect for the terminal as a hashref
		1225	similar to C<\%ENV>.
		1226
		1227	=cut
		1228
		1229	sub env {
		1230	if (my $env = $_[0]->_env) {
		1231	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1232	} else {
		1233	+{ %ENV }
		1234	}
		1235	}
1067		1236
1068	=item $modifiermask = $term->ModLevel3Mask	1237	=item $modifiermask = $term->ModLevel3Mask
1069		1238
1070	=item $modifiermask = $term->ModMetaMask	1239	=item $modifiermask = $term->ModMetaMask
1071		1240
…		…
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1243	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.	1244	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1245
1077	=item $view_start = $term->view_start ([$newvalue])	1246	=item $view_start = $term->view_start ([$newvalue])
1078		1247
1079	Returns the negative row number of the topmost line. Minimum value is	1248	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1249	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1250	this many lines into the scrollback buffer.
1082		1251
1083	=item $term->want_refresh	1252	=item $term->want_refresh
1084		1253
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1254	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.	1333	Return the row number of the first/last row of the line, respectively.
1165		1334
1166	=item $offset = $line->offset_of ($row, $col)	1335	=item $offset = $line->offset_of ($row, $col)
1167		1336
1168	Returns the character offset of the given row\|col pair within the logical	1337	Returns the character offset of the given row\|col pair within the logical
1169	line.	1338	line. Works for rows outside the line, too, and returns corresponding
		1339	offsets outside the string.
1170		1340
1171	=item ($row, $col) = $line->coord_of ($offset)	1341	=item ($row, $col) = $line->coord_of ($offset)
1172		1342
1173	Translates a string offset into terminal coordinates again.	1343	Translates a string offset into terminal coordinates again.
1174		1344
…		…
1311	$item->{render} \|\|= sub { $_[0]{text} };	1481	$item->{render} \|\|= sub { $_[0]{text} };
1312		1482
1313	push @{ $self->{item} }, $item;	1483	push @{ $self->{item} }, $item;
1314	}	1484	}
1315		1485
		1486	=item $popup->add_title ($title)
		1487
		1488	Adds a non-clickable title to the popup.
		1489
		1490	=cut
		1491
		1492	sub add_title {
		1493	my ($self, $title) = @_;
		1494
		1495	$self->add_item ({
		1496	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1497	text => $title,
		1498	activate => sub { },
		1499	});
		1500	}
		1501
		1502	=item $popup->add_separator ([$sepchr])
		1503
		1504	Creates a separator, optionally using the character given as C<$sepchr>.
		1505
		1506	=cut
		1507
1316	sub add_separator {	1508	sub add_separator {
1317	my ($self, $sep) = @_;	1509	my ($self, $sep) = @_;
1318		1510
1319	$sep \|\|= "=";	1511	$sep \|\|= "=";
1320		1512
…		…
1324	render => sub { $sep x $self->{term}->ncol },	1516	render => sub { $sep x $self->{term}->ncol },
1325	activate => sub { },	1517	activate => sub { },
1326	});	1518	});
1327	}	1519	}
1328		1520
1329	sub add_title {	1521	=item $popup->add_button ($text, $cb)
1330	my ($self, $title) = @_;
1331		1522
1332	$self->add_item ({	1523	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" },	1524	selected.
1334	text => $title,	1525
1335	activate => sub { },	1526	=cut
1336	});
1337	}
1338		1527
1339	sub add_button {	1528	sub add_button {
1340	my ($self, $text, $cb) = @_;	1529	my ($self, $text, $cb) = @_;
1341		1530
1342	$self->add_item ({ type => "button", text => $text, activate => $cb});	1531	$self->add_item ({ type => "button", text => $text, activate => $cb});
1343	}	1532	}
		1533
		1534	=item $popup->add_toggle ($text, $cb, $initial_value)
		1535
		1536	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1537	whenever it gets toggled, with a boolean indicating its value as its first
		1538	argument.
		1539
		1540	=cut
1344		1541
1345	sub add_toggle {	1542	sub add_toggle {
1346	my ($self, $text, $cb, $value) = @_;	1543	my ($self, $text, $cb, $value) = @_;
1347		1544
1348	my $item; $item = {	1545	my $item; $item = {
1349	type => "button",	1546	type => "button",
1350	text => " $text",	1547	text => " $text",
1351	value => $value,	1548	value => $value,
1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1549	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1550	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354	};	1551	};
1355		1552
1356	$self->add_item ($item);	1553	$self->add_item ($item);
1357	}	1554	}
		1555
		1556	=item $popup->show
		1557
		1558	Displays the popup (which is initially hidden).
		1559
		1560	=cut
1358		1561
1359	sub show {	1562	sub show {
1360	my ($self) = @_;	1563	my ($self) = @_;
1361		1564
1362	local $urxvt::popup::self = $self;	1565	local $urxvt::popup::self = $self;
1363		1566
		1567	my $env = $self->{term}->env;
		1568	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1569	delete $env->{LC_ALL};
1364	local $ENV{LC_ALL} = $self->{term}->locale;	1570	$env->{LC_CTYPE} = $self->{term}->locale;
1365		1571
		1572	urxvt::term->new ($env, $self->{term}->resource ("name"),
1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1573	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1367	"--transient-for" => $self->{term}->parent,	1574	"--transient-for" => $self->{term}->parent,
1368	"-display" => $self->{term}->display_id,	1575	"-display" => $self->{term}->display_id,
1369	"-pe" => "urxvt-popup")	1576	"-pe" => "urxvt-popup")
1370	or die "unable to create popup window\n";	1577	or die "unable to create popup window\n";
1371	}	1578	}
1372		1579
1373	sub DESTROY {	1580	sub DESTROY {
1374	my ($self) = @_;	1581	my ($self) = @_;
1375		1582
1376	delete $self->{term}{_destroy}{$self};	1583	delete $self->{term}{_destroy}{$self};
1377	$self->{term}->ungrab;	1584	$self->{term}->ungrab;
1378	}	1585	}
		1586
		1587	=back
1379		1588
1380	=head2 The C<urxvt::timer> Class	1589	=head2 The C<urxvt::timer> Class
1381		1590
1382	This class implements timer watchers/events. Time is represented as a	1591	This class implements timer watchers/events. Time is represented as a
1383	fractional number of seconds since the epoch. Example:	1592	fractional number of seconds since the epoch. Example:
…		…
1490		1699
1491	=item == 0 - fatal messages	1700	=item == 0 - fatal messages
1492		1701
1493	=item >= 3 - script loading and management	1702	=item >= 3 - script loading and management
1494		1703
1495	=item >=10 - all events received	1704	=item >=10 - all called hooks
		1705
		1706	=item >=11 - hook reutrn values
1496		1707
1497	=back	1708	=back
1498		1709
1499	=head1 AUTHOR	1710	=head1 AUTHOR
1500		1711

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.99 by root, Tue Jan 17 17:09:26 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.99 by root, Tue Jan 17 17:09:26 2006 UTC