[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.101 by root, Wed Jan 18 10:11:03 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
…		…
67		89
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action (such as uri unescaping, perl	91	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.	92	evalution, web-browser starting etc.), depending on content.
71		93
		94	Other extensions can extend this popup menu by pushing a code reference onto
		95	C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed.
		96
		97	It's sole argument is the popup menu, which can be modified. The selection
		98	is in C<$_>, which can be used to decide wether to add something or not.
		99	It should either return nothing or a string and a code reference. The
		100	string will be used as button text and the code reference will be called
		101	when the button gets activated and should transform C<$_>.
		102
		103	The following will add an entry C<a to b> that transforms all C<a>s in
		104	the selection to C<b>s, but only if the selection currently contains any
		105	C<a>s:
		106
		107	push urxvt::ext::selection_popup::hook, sub {
		108	/a/ ? ("a to be" => sub { s/a/b/g }
		109	: ()
		110	};
		111
72	=item searchable-scrollback<hotkey> (enabled by default)	112	=item searchable-scrollback<hotkey> (enabled by default)
73		113
74	Adds regex search functionality to the scrollback buffer, triggered	114	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	115	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	116	input/output is suspended and a regex is displayed at the bottom of the
		117	screen.
77		118
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	119	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	120	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>	121	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	122	bottom. C<Escape> leaves search mode and returns to the point where search
		123	was started, while C<Enter> or C<Return> stay at the current position and
		124	additionally stores the first match in the current line into the primary
		125	selection.
82		126
83	=item digital-clock	127	=item selection-autotransform
84		128
85	Displays a digital clock using the built-in overlay.	129	This selection allows you to do automatic transforms on a selection
		130	whenever a selection is made.
		131
		132	It works by specifying perl snippets (most useful is a single C<s///>
		133	operator) that modify C<$_> as resources:
		134
		135	URxvt.selection-autotransform.0: transform
		136	URxvt.selection-autotransform.1: transform
		137	...
		138
		139	For example, the following will transform selections of the form
		140	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		141	$word>:
		142
		143	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		144
		145	And this example matches the same,but replaces it with vi-commands you can
		146	paste directly into your (vi :) editor:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		149
		150	Of course, this can be modified to suit your needs and your editor :)
		151
		152	To expand the example above to typical perl error messages ("XXX at
		153	FILENAME line YYY."), you need a slightly more elaborate solution:
		154
		155	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		156	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		157
		158	The first line tells the selection code to treat the unchanging part of
		159	every error message as a selection pattern, and the second line transforms
		160	the message into vi commands to load the file.
86		161
87	=item mark-urls	162	=item mark-urls
88		163
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	164	Uses per-line display filtering (C<on_line_update>) to underline urls and
		165	make them clickable. When middle-clicked, the program specified in the
		166	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		167	the URL as first argument.
90		168
91	=item block-graphics-to-ascii	169	=item block-graphics-to-ascii
92		170
93	A not very useful example of filtering all text output to the terminal,	171	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	172	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	173	similar-looking ascii character.
96		174
		175	=item digital-clock
		176
		177	Displays a digital clock using the built-in overlay.
		178
97	=item example-refresh-hooks	179	=item example-refresh-hooks
98		180
99	Displays a very simple digital clock in the upper right corner of the	181	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	182	window. Illustrates overwriting the refresh callbacks to create your own
101	overlays or changes.	183	overlays or changes.
		184
		185	=item selection-pastebin
		186
		187	This is a little rarely useful extension that Uploads the selection as
		188	textfile to a remote site (or does other things). (The implementation is
		189	not currently secure for use in a multiuser environment as it writes to
		190	F</tmp> directly.).
		191
		192	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		193	i.e.
		194
		195	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		196
		197	Pressing this combination runs a command with C<%> replaced by the name of
		198	the textfile. This command can be set via a resource:
		199
		200	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		201
		202	And the default is likely not useful to anybody but the few people around
		203	here :)
		204
		205	The name of the textfile is the hex encoded md5 sum of the selection, so
		206	the same content should lead to the same filename.
		207
		208	After a successful upload the selection will be replaced by the text given
		209	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		210	for the filename):
		211
		212	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
102		213
103	=back	214	=back
104		215
105	=head1 API DOCUMENTATION	216	=head1 API DOCUMENTATION
106		217
…		…
123	=over 4	234	=over 4
124		235
125	=item $text	236	=item $text
126		237
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	238	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.	239	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		240
130	=item $string	241	=item $string
131		242
132	A perl text string, with an emphasis on I<text>. It can store all unicode	243	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	244	characters and is to be distinguished with text encoded in a specific
…		…
228	=item on_sel_extend $term	339	=item on_sel_extend $term
229		340
230	Called whenever the user tries to extend the selection (e.g. with a double	341	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	342	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	343	should extend the selection itelf and return true to suppress the built-in
233	processing.	344	processing. This can happen multiple times, as long as the callback
		345	returns true, it will be called on every further click by the user and is
		346	supposed to enlarge the selection more and more, if possible.
234		347
235	See the F<selection> example extension.	348	See the F<selection> example extension.
236		349
237	=item on_view_change $term, $offset	350	=item on_view_change $term, $offset
238		351
…		…
305		418
306	Called whenever the user presses a key combination that has a	419	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>	420	C<perl:string> action bound to it (see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	421	resource in the @@RXVT_NAME@@(1) manpage).
309		422
		423	=item on_x_event $term, $event
		424
		425	Called on every X event received on the vt window (and possibly other
		426	windows). Should only be used as a last resort. Most event structure
		427	members are not passed.
		428
310	=item on_focus_in $term	429	=item on_focus_in $term
311		430
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	431	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	432	does focus in processing.
314		433
…		…
340		459
341	C<on_key_press> additionally receives the string rxvt-unicode would	460	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	461	output, if any, in locale-specific encoding.
343		462
344	subwindow.	463	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		464
471	=back	465	=back
472		466
473	=cut	467	=cut
474		468
…		…
489	our $LIBDIR;	483	our $LIBDIR;
490	our $RESNAME;	484	our $RESNAME;
491	our $RESCLASS;	485	our $RESCLASS;
492	our $RXVTNAME;	486	our $RXVTNAME;
493		487
		488	=head2 Variables in the C<urxvt> Package
		489
		490	=over 4
		491
		492	=item $urxvt::LIBDIR
		493
		494	The rxvt-unicode library directory, where, among other things, the perl
		495	modules and scripts are stored.
		496
		497	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		498
		499	The resource class and name rxvt-unicode uses to look up X resources.
		500
		501	=item $urxvt::RXVTNAME
		502
		503	The basename of the installed binaries, usually C<urxvt>.
		504
		505	=item $urxvt::TERM
		506
		507	The current terminal. This variable stores the current C<urxvt::term>
		508	object, whenever a callback/hook is executing.
		509
		510	=back
		511
		512	=head2 Functions in the C<urxvt> Package
		513
		514	=over 4
		515
		516	=item urxvt::fatal $errormessage
		517
		518	Fatally aborts execution with the given error message. Avoid at all
		519	costs! The only time this is acceptable is when the terminal process
		520	starts up.
		521
		522	=item urxvt::warn $string
		523
		524	Calls C<rxvt_warn> with the given string which should not include a
		525	newline. The module also overwrites the C<warn> builtin with a function
		526	that calls this function.
		527
		528	Using this function has the advantage that its output ends up in the
		529	correct place, e.g. on stderr of the connecting urxvtc client.
		530
		531	Messages have a size limit of 1023 bytes currently.
		532
		533	=item $time = urxvt::NOW
		534
		535	Returns the "current time" (as per the event loop).
		536
		537	=item urxvt::CurrentTime
		538
		539	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		540	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		541	Button4Mask, Button5Mask, AnyModifier
		542
		543	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		544	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		545	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		546	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		547	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		548	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		549	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		550
		551	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		552	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		553	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		554	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		555	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		556	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		557	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		558
		559	Various constants for use in X calls and event processing.
		560
		561	=back
		562
		563	=head2 RENDITION
		564
		565	Rendition bitsets contain information about colour, font, font styles and
		566	similar information for each screen cell.
		567
		568	The following "macros" deal with changes in rendition sets. You should
		569	never just create a bitset, you should always modify an existing one,
		570	as they contain important information required for correct operation of
		571	rxvt-unicode.
		572
		573	=over 4
		574
		575	=item $rend = urxvt::DEFAULT_RSTYLE
		576
		577	Returns the default rendition, as used when the terminal is starting up or
		578	being reset. Useful as a base to start when creating renditions.
		579
		580	=item $rend = urxvt::OVERLAY_RSTYLE
		581
		582	Return the rendition mask used for overlays by default.
		583
		584	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		585
		586	Return the bit that enabled bold, italic, blink, reverse-video and
		587	underline, respectively. To enable such a style, just logically OR it into
		588	the bitset.
		589
		590	=item $foreground = urxvt::GET_BASEFG $rend
		591
		592	=item $background = urxvt::GET_BASEBG $rend
		593
		594	Return the foreground/background colour index, respectively.
		595
		596	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		597
		598	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		599
		600	Replace the foreground/background colour in the rendition mask with the
		601	specified one.
		602
		603	=item $value = urxvt::GET_CUSTOM $rend
		604
		605	Return the "custom" value: Every rendition has 5 bits for use by
		606	extensions. They can be set and changed as you like and are initially
		607	zero.
		608
		609	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		610
		611	Change the custom value.
		612
		613	=back
		614
		615	=cut
		616
494	BEGIN {	617	BEGIN {
495	urxvt->bootstrap;
496
497	# overwrite perl's warn	618	# overwrite perl's warn
498	*CORE::GLOBAL::warn = sub {	619	*CORE::GLOBAL::warn = sub {
499	my $msg = join "", @_;	620	my $msg = join "", @_;
500	$msg .= "\n"	621	$msg .= "\n"
501	unless $msg =~ /\n$/;	622	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	623	urxvt::warn ($msg);
503	};	624	};
504		625
		626	# %ENV is the original startup environment
505	delete $ENV{IFS};	627	delete $ENV{IFS};
506	delete $ENV{CDPATH};	628	delete $ENV{CDPATH};
507	delete $ENV{BASH_ENV};	629	delete $ENV{BASH_ENV};
508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	630	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509	}	631	}
510		632
511	my @hook_count;
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	633	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		634
514	sub verbose {	635	sub verbose {
515	my ($level, $msg) = @_;	636	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	637	warn "$msg\n" if $level <= $verbosity;
517	}	638	}
518		639
519	my $extension_pkg = "extension0000";
520	my %extension_pkg;	640	my %extension_pkg;
521		641
522	# load a single script into its own package, once only	642	# load a single script into its own package, once only
523	sub extension_package($) {	643	sub extension_package($) {
524	my ($path) = @_;	644	my ($path) = @_;
525		645
		646	no strict 'refs';
		647
526	$extension_pkg{$path} \|\|= do {	648	$extension_pkg{$path} \|\|= do {
527	my $pkg = "urxvt::" . ($extension_pkg++);	649	$path =~ /([^\/\\]+)$/;
		650	my $pkg = $1;
		651	$pkg =~ s/[^[:word:]]/_/g;
		652	$pkg = "urxvt::ext::$pkg";
528		653
529	verbose 3, "loading extension '$path' into package '$pkg'";	654	verbose 3, "loading extension '$path' into package '$pkg'";
530		655
531	open my $fh, "<:raw", $path	656	open my $fh, "<:raw", $path
532	or die "$path: $!";	657	or die "$path: $!";
533		658
		659	@{"$pkg\::ISA"} = urxvt::term::extension::;
		660
534	my $source = untaint	661	my $source =
535	"package $pkg; use strict; use utf8;\n"	662	"package $pkg; use strict; use utf8;\n"
536	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	663	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	664	. (do { local $/; <$fh> })
539	. "\n};\n1";	665	. "\n};\n1";
540		666
541	eval $source	667	eval $source
…		…
598	if ($@) {	724	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	725	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	726	warn $@;
601	}	727	}
602	}	728	}
		729
		730	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		731	if $verbosity >= 11;
603	}	732	}
604		733
605	if ($htype == 1) { # DESTROY	734	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	735	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	736	%$_ = () for values %{ $TERM->{_pkg} };
615		737
616	# clear package	738	# clear package
617	%$TERM = ();	739	%$TERM = ();
618	}	740	}
619		741
620	$retval	742	$retval
		743	}
		744
		745	sub exec_async(@) {
		746	my $pid = fork;
		747
		748	return
		749	if !defined $pid or $pid;
		750
		751	%ENV = %{ $TERM->env };
		752
		753	exec @_;
		754	_exit 255;
621	}	755	}
622		756
623	# urxvt::term::extension	757	# urxvt::term::extension
624		758
625	package urxvt::term::extension;	759	package urxvt::term::extension;
…		…
631	while (my ($name, $cb) = each %hook) {	765	while (my ($name, $cb) = each %hook) {
632	my $htype = $HOOKTYPE{uc $name};	766	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	767	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	768	or Carp::croak "unsupported hook type '$name'";
635		769
		770	$self->set_should_invoke ($htype, +1)
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	771	unless exists $self->{term}{_hook}[$htype]{$pkg};
637	$hook_count[$htype]++
638	or urxvt::set_should_invoke $htype, 1;
639	}
640		772
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	773	$self->{term}{_hook}[$htype]{$pkg} = $cb;
642	}	774	}
643	}	775	}
644		776
…		…
649	for my $name (@hook) {	781	for my $name (@hook) {
650	my $htype = $HOOKTYPE{uc $name};	782	my $htype = $HOOKTYPE{uc $name};
651	defined $htype	783	defined $htype
652	or Carp::croak "unsupported hook type '$name'";	784	or Carp::croak "unsupported hook type '$name'";
653		785
		786	$self->set_should_invoke ($htype, -1)
654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	787	if delete $self->{term}{_hook}[$htype]{$pkg};
655	--$hook_count[$htype]
656	or urxvt::set_should_invoke $htype, 0;
657	}
658	}	788	}
659	}	789	}
660		790
661	our $AUTOLOAD;	791	our $AUTOLOAD;
662		792
…		…
781	for my $name (@HOOKNAME) {	911	for my $name (@HOOKNAME) {
782	if (my $ref = $pkg->can ("on_" . lc $name)) {	912	if (my $ref = $pkg->can ("on_" . lc $name)) {
783	$proxy->enable ($name => $ref);	913	$proxy->enable ($name => $ref);
784	}	914	}
785	}	915	}
		916	}
		917
		918	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		919
		920	Creates a new terminal, very similar as if you had started it with system
		921	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		922	hash which defines the environment of the new terminal.
		923
		924	Croaks (and probably outputs an error message) if the new instance
		925	couldn't be created. Returns C<undef> if the new instance didn't
		926	initialise perl, and the terminal object otherwise. The C<init> and
		927	C<start> hooks will be called during this call.
		928
		929	=cut
		930
		931	sub new {
		932	my ($class, $env, @args) = @_;
		933
		934	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
786	}	935	}
787		936
788	=item $term->destroy	937	=item $term->destroy
789		938
790	Destroy the terminal object (close the window, free resources	939	Destroy the terminal object (close the window, free resources
…		…
847	my ($self, $name) = (shift, shift);	996	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	997	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	998	&urxvt::term::_resource
850	}	999	}
851		1000
		1001	=item $value = $term->x_resource ($pattern)
		1002
		1003	Returns the X-Resource for the given pattern, excluding the program or
		1004	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1005	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1006	resource with that pattern exists.
		1007
		1008	This method should only be called during the C<on_start> hook, as there is
		1009	only one resource database per display, and later invocations might return
		1010	the wrong resources.
		1011
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1012	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		1013
854	Adds a keymap translation exactly as specified via a resource. See the	1014	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1015	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		1016
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	1031	=item ($row, $col) = $term->selection_end ([$row, $col])
872		1032
873	Return the current values of the selection mark, begin or end positions,	1033	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	1034	and optionally set them to new values.
875		1035
		1036	=item $term->selection_make ($eventtime[, $rectangular])
		1037
		1038	Tries to make a selection as set by C<selection_beg> and
		1039	C<selection_end>. If C<$rectangular> is true (default: false), a
		1040	rectangular selection will be made. This is the prefered function to make
		1041	a selection.
		1042
876	=item $success = $term->selection_grab ($eventtime)	1043	=item $success = $term->selection_grab ($eventtime)
877		1044
878	Try to request the primary selection from the server (for example, as set	1045	Try to request the primary selection text from the server (for example, as
879	by the next method).	1046	set by the next method). No visual feedback will be given. This function
		1047	is mostly useful from within C<on_sel_grab> hooks.
880		1048
881	=item $oldtext = $term->selection ([$newtext])	1049	=item $oldtext = $term->selection ([$newtext])
882		1050
883	Return the current selection text and optionally replace it by C<$newtext>.	1051	Return the current selection text and optionally replace it by C<$newtext>.
884		1052
…		…
977	Convert the given locale-encoded octets into a perl string.	1145	Convert the given locale-encoded octets into a perl string.
978		1146
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1147	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1148
981	XORs the rendition values in the given span with the provided value	1149	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	1150	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1151	refresh hooks to provide effects similar to the selection.
984		1152
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1153	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1154
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1155	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1156	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	1157	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
990	it instead.	1158	it instead. Both styles I<MUST NOT> contain font styles.
991		1159
992	=item $term->scr_bell	1160	=item $term->scr_bell
993		1161
994	Ring the bell!	1162	Ring the bell!
995		1163
…		…
1029		1197
1030	=item $windowid = $term->vt	1198	=item $windowid = $term->vt
1031		1199
1032	Return the window id of the terminal window.	1200	Return the window id of the terminal window.
1033		1201
		1202	=item $term->vt_emask_add ($x_event_mask)
		1203
		1204	Adds the specified events to the vt event mask. Useful e.g. when you want
		1205	to receive pointer events all the times:
		1206
		1207	$term->vt_emask_add (urxvt::PointerMotionMask);
		1208
1034	=item $window_width = $term->width	1209	=item $window_width = $term->width
1035		1210
1036	=item $window_height = $term->height	1211	=item $window_height = $term->height
1037		1212
1038	=item $font_width = $term->fwidth	1213	=item $font_width = $term->fwidth
…		…
1051		1226
1052	=item $max_scrollback = $term->saveLines	1227	=item $max_scrollback = $term->saveLines
1053		1228
1054	=item $nrow_plus_saveLines = $term->total_rows	1229	=item $nrow_plus_saveLines = $term->total_rows
1055		1230
1056	=item $lines_in_scrollback = $term->nsaved	1231	=item $topmost_scrollback_row = $term->top_row
1057		1232
1058	Return various integers describing terminal characteristics.	1233	Return various integers describing terminal characteristics.
1059		1234
		1235	=item $x_display = $term->display_id
		1236
		1237	Return the DISPLAY used by rxvt-unicode.
		1238
1060	=item $lc_ctype = $term->locale	1239	=item $lc_ctype = $term->locale
1061		1240
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1241	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1242
1064	=item $x_display = $term->display_id	1243	=item $env = $term->env
1065		1244
1066	Return the DISPLAY used by rxvt-unicode.	1245	Returns a copy of the environment in effect for the terminal as a hashref
		1246	similar to C<\%ENV>.
		1247
		1248	=cut
		1249
		1250	sub env {
		1251	if (my $env = $_[0]->_env) {
		1252	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1253	} else {
		1254	+{ %ENV }
		1255	}
		1256	}
1067		1257
1068	=item $modifiermask = $term->ModLevel3Mask	1258	=item $modifiermask = $term->ModLevel3Mask
1069		1259
1070	=item $modifiermask = $term->ModMetaMask	1260	=item $modifiermask = $term->ModMetaMask
1071		1261
…		…
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1264	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.	1265	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1266
1077	=item $view_start = $term->view_start ([$newvalue])	1267	=item $view_start = $term->view_start ([$newvalue])
1078		1268
1079	Returns the negative row number of the topmost line. Minimum value is	1269	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1270	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1271	this many lines into the scrollback buffer.
1082		1272
1083	=item $term->want_refresh	1273	=item $term->want_refresh
1084		1274
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1275	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.	1354	Return the row number of the first/last row of the line, respectively.
1165		1355
1166	=item $offset = $line->offset_of ($row, $col)	1356	=item $offset = $line->offset_of ($row, $col)
1167		1357
1168	Returns the character offset of the given row\|col pair within the logical	1358	Returns the character offset of the given row\|col pair within the logical
1169	line.	1359	line. Works for rows outside the line, too, and returns corresponding
		1360	offsets outside the string.
1170		1361
1171	=item ($row, $col) = $line->coord_of ($offset)	1362	=item ($row, $col) = $line->coord_of ($offset)
1172		1363
1173	Translates a string offset into terminal coordinates again.	1364	Translates a string offset into terminal coordinates again.
1174		1365
…		…
1311	$item->{render} \|\|= sub { $_[0]{text} };	1502	$item->{render} \|\|= sub { $_[0]{text} };
1312		1503
1313	push @{ $self->{item} }, $item;	1504	push @{ $self->{item} }, $item;
1314	}	1505	}
1315		1506
		1507	=item $popup->add_title ($title)
		1508
		1509	Adds a non-clickable title to the popup.
		1510
		1511	=cut
		1512
		1513	sub add_title {
		1514	my ($self, $title) = @_;
		1515
		1516	$self->add_item ({
		1517	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1518	text => $title,
		1519	activate => sub { },
		1520	});
		1521	}
		1522
		1523	=item $popup->add_separator ([$sepchr])
		1524
		1525	Creates a separator, optionally using the character given as C<$sepchr>.
		1526
		1527	=cut
		1528
1316	sub add_separator {	1529	sub add_separator {
1317	my ($self, $sep) = @_;	1530	my ($self, $sep) = @_;
1318		1531
1319	$sep \|\|= "=";	1532	$sep \|\|= "=";
1320		1533
…		…
1324	render => sub { $sep x $self->{term}->ncol },	1537	render => sub { $sep x $self->{term}->ncol },
1325	activate => sub { },	1538	activate => sub { },
1326	});	1539	});
1327	}	1540	}
1328		1541
1329	sub add_title {	1542	=item $popup->add_button ($text, $cb)
1330	my ($self, $title) = @_;
1331		1543
1332	$self->add_item ({	1544	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" },	1545	selected.
1334	text => $title,	1546
1335	activate => sub { },	1547	=cut
1336	});
1337	}
1338		1548
1339	sub add_button {	1549	sub add_button {
1340	my ($self, $text, $cb) = @_;	1550	my ($self, $text, $cb) = @_;
1341		1551
1342	$self->add_item ({ type => "button", text => $text, activate => $cb});	1552	$self->add_item ({ type => "button", text => $text, activate => $cb});
1343	}	1553	}
		1554
		1555	=item $popup->add_toggle ($text, $cb, $initial_value)
		1556
		1557	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1558	whenever it gets toggled, with a boolean indicating its value as its first
		1559	argument.
		1560
		1561	=cut
1344		1562
1345	sub add_toggle {	1563	sub add_toggle {
1346	my ($self, $text, $cb, $value) = @_;	1564	my ($self, $text, $cb, $value) = @_;
1347		1565
1348	my $item; $item = {	1566	my $item; $item = {
1349	type => "button",	1567	type => "button",
1350	text => " $text",	1568	text => " $text",
1351	value => $value,	1569	value => $value,
1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1570	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1571	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354	};	1572	};
1355		1573
1356	$self->add_item ($item);	1574	$self->add_item ($item);
1357	}	1575	}
		1576
		1577	=item $popup->show
		1578
		1579	Displays the popup (which is initially hidden).
		1580
		1581	=cut
1358		1582
1359	sub show {	1583	sub show {
1360	my ($self) = @_;	1584	my ($self) = @_;
1361		1585
1362	local $urxvt::popup::self = $self;	1586	local $urxvt::popup::self = $self;
1363		1587
		1588	my $env = $self->{term}->env;
		1589	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1590	delete $env->{LC_ALL};
1364	local $ENV{LC_ALL} = $self->{term}->locale;	1591	$env->{LC_CTYPE} = $self->{term}->locale;
1365		1592
		1593	urxvt::term->new ($env, $self->{term}->resource ("name"),
1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1594	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1367	"--transient-for" => $self->{term}->parent,	1595	"--transient-for" => $self->{term}->parent,
1368	"-display" => $self->{term}->display_id,	1596	"-display" => $self->{term}->display_id,
1369	"-pe" => "urxvt-popup")	1597	"-pe" => "urxvt-popup")
1370	or die "unable to create popup window\n";	1598	or die "unable to create popup window\n";
1371	}	1599	}
1372		1600
1373	sub DESTROY {	1601	sub DESTROY {
1374	my ($self) = @_;	1602	my ($self) = @_;
1375		1603
1376	delete $self->{term}{_destroy}{$self};	1604	delete $self->{term}{_destroy}{$self};
1377	$self->{term}->ungrab;	1605	$self->{term}->ungrab;
1378	}	1606	}
		1607
		1608	=back
1379		1609
1380	=head2 The C<urxvt::timer> Class	1610	=head2 The C<urxvt::timer> Class
1381		1611
1382	This class implements timer watchers/events. Time is represented as a	1612	This class implements timer watchers/events. Time is represented as a
1383	fractional number of seconds since the epoch. Example:	1613	fractional number of seconds since the epoch. Example:
…		…
1490		1720
1491	=item == 0 - fatal messages	1721	=item == 0 - fatal messages
1492		1722
1493	=item >= 3 - script loading and management	1723	=item >= 3 - script loading and management
1494		1724
1495	=item >=10 - all events received	1725	=item >=10 - all called hooks
		1726
		1727	=item >=11 - hook reutrn values
1496		1728
1497	=back	1729	=back
1498		1730
1499	=head1 AUTHOR	1731	=head1 AUTHOR
1500		1732

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.101 by root, Wed Jan 18 10:11:03 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.101 by root, Wed Jan 18 10:11:03 2006 UTC