[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.105 by root, Wed Jan 18 19:43:51 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.
		168
		169	=item automove-background
		170
		171	This is basically a one-line extension that dynamically changes the background pixmap offset
		172	to the window position, in effect creating the same effect as pseudo transparency with
		173	a custom pixmap. No scaling is supported in this mode. Exmaple:
		174
		175	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90		176
91	=item block-graphics-to-ascii	177	=item block-graphics-to-ascii
92		178
93	A not very useful example of filtering all text output to the terminal,	179	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	180	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	181	similar-looking ascii character.
96		182
		183	=item digital-clock
		184
		185	Displays a digital clock using the built-in overlay.
		186
97	=item example-refresh-hooks	187	=item example-refresh-hooks
98		188
99	Displays a very simple digital clock in the upper right corner of the	189	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	190	window. Illustrates overwriting the refresh callbacks to create your own
101	overlays or changes.	191	overlays or changes.
		192
		193	=item selection-pastebin
		194
		195	This is a little rarely useful extension that Uploads the selection as
		196	textfile to a remote site (or does other things). (The implementation is
		197	not currently secure for use in a multiuser environment as it writes to
		198	F</tmp> directly.).
		199
		200	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		201	i.e.
		202
		203	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		204
		205	Pressing this combination runs a command with C<%> replaced by the name of
		206	the textfile. This command can be set via a resource:
		207
		208	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		209
		210	And the default is likely not useful to anybody but the few people around
		211	here :)
		212
		213	The name of the textfile is the hex encoded md5 sum of the selection, so
		214	the same content should lead to the same filename.
		215
		216	After a successful upload the selection will be replaced by the text given
		217	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		218	for the filename):
		219
		220	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
102		221
103	=back	222	=back
104		223
105	=head1 API DOCUMENTATION	224	=head1 API DOCUMENTATION
106		225
…		…
123	=over 4	242	=over 4
124		243
125	=item $text	244	=item $text
126		245
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	246	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.	247	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		248
130	=item $string	249	=item $string
131		250
132	A perl text string, with an emphasis on I<text>. It can store all unicode	251	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	252	characters and is to be distinguished with text encoded in a specific
…		…
228	=item on_sel_extend $term	347	=item on_sel_extend $term
229		348
230	Called whenever the user tries to extend the selection (e.g. with a double	349	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	350	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	351	should extend the selection itelf and return true to suppress the built-in
233	processing.	352	processing. This can happen multiple times, as long as the callback
		353	returns true, it will be called on every further click by the user and is
		354	supposed to enlarge the selection more and more, if possible.
234		355
235	See the F<selection> example extension.	356	See the F<selection> example extension.
236		357
237	=item on_view_change $term, $offset	358	=item on_view_change $term, $offset
238		359
…		…
305		426
306	Called whenever the user presses a key combination that has a	427	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>	428	C<perl:string> action bound to it (see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	429	resource in the @@RXVT_NAME@@(1) manpage).
309		430
		431	=item on_x_event $term, $event
		432
		433	Called on every X event received on the vt window (and possibly other
		434	windows). Should only be used as a last resort. Most event structure
		435	members are not passed.
		436
310	=item on_focus_in $term	437	=item on_focus_in $term
311		438
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	439	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	440	does focus in processing.
314		441
315	=item on_focus_out $term	442	=item on_focus_out $term
316		443
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	444	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	445	focus out processing.
		446
		447	=item on_configure_notify $term, $event
319		448
320	=item on_key_press $term, $event, $keysym, $octets	449	=item on_key_press $term, $event, $keysym, $octets
321		450
322	=item on_key_release $term, $event, $keysym	451	=item on_key_release $term, $event, $keysym
323		452
…		…
340		469
341	C<on_key_press> additionally receives the string rxvt-unicode would	470	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	471	output, if any, in locale-specific encoding.
343		472
344	subwindow.	473	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		474
471	=back	475	=back
472		476
473	=cut	477	=cut
474		478
…		…
489	our $LIBDIR;	493	our $LIBDIR;
490	our $RESNAME;	494	our $RESNAME;
491	our $RESCLASS;	495	our $RESCLASS;
492	our $RXVTNAME;	496	our $RXVTNAME;
493		497
		498	=head2 Variables in the C<urxvt> Package
		499
		500	=over 4
		501
		502	=item $urxvt::LIBDIR
		503
		504	The rxvt-unicode library directory, where, among other things, the perl
		505	modules and scripts are stored.
		506
		507	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		508
		509	The resource class and name rxvt-unicode uses to look up X resources.
		510
		511	=item $urxvt::RXVTNAME
		512
		513	The basename of the installed binaries, usually C<urxvt>.
		514
		515	=item $urxvt::TERM
		516
		517	The current terminal. This variable stores the current C<urxvt::term>
		518	object, whenever a callback/hook is executing.
		519
		520	=back
		521
		522	=head2 Functions in the C<urxvt> Package
		523
		524	=over 4
		525
		526	=item urxvt::fatal $errormessage
		527
		528	Fatally aborts execution with the given error message. Avoid at all
		529	costs! The only time this is acceptable is when the terminal process
		530	starts up.
		531
		532	=item urxvt::warn $string
		533
		534	Calls C<rxvt_warn> with the given string which should not include a
		535	newline. The module also overwrites the C<warn> builtin with a function
		536	that calls this function.
		537
		538	Using this function has the advantage that its output ends up in the
		539	correct place, e.g. on stderr of the connecting urxvtc client.
		540
		541	Messages have a size limit of 1023 bytes currently.
		542
		543	=item $time = urxvt::NOW
		544
		545	Returns the "current time" (as per the event loop).
		546
		547	=item urxvt::CurrentTime
		548
		549	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		550	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		551	Button4Mask, Button5Mask, AnyModifier
		552
		553	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		554	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		555	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		556	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		557	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		558	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		559	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		560
		561	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		562	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		563	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		564	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		565	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		566	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		567	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		568
		569	Various constants for use in X calls and event processing.
		570
		571	=back
		572
		573	=head2 RENDITION
		574
		575	Rendition bitsets contain information about colour, font, font styles and
		576	similar information for each screen cell.
		577
		578	The following "macros" deal with changes in rendition sets. You should
		579	never just create a bitset, you should always modify an existing one,
		580	as they contain important information required for correct operation of
		581	rxvt-unicode.
		582
		583	=over 4
		584
		585	=item $rend = urxvt::DEFAULT_RSTYLE
		586
		587	Returns the default rendition, as used when the terminal is starting up or
		588	being reset. Useful as a base to start when creating renditions.
		589
		590	=item $rend = urxvt::OVERLAY_RSTYLE
		591
		592	Return the rendition mask used for overlays by default.
		593
		594	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		595
		596	Return the bit that enabled bold, italic, blink, reverse-video and
		597	underline, respectively. To enable such a style, just logically OR it into
		598	the bitset.
		599
		600	=item $foreground = urxvt::GET_BASEFG $rend
		601
		602	=item $background = urxvt::GET_BASEBG $rend
		603
		604	Return the foreground/background colour index, respectively.
		605
		606	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		607
		608	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		609
		610	Replace the foreground/background colour in the rendition mask with the
		611	specified one.
		612
		613	=item $value = urxvt::GET_CUSTOM $rend
		614
		615	Return the "custom" value: Every rendition has 5 bits for use by
		616	extensions. They can be set and changed as you like and are initially
		617	zero.
		618
		619	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		620
		621	Change the custom value.
		622
		623	=back
		624
		625	=cut
		626
494	BEGIN {	627	BEGIN {
495	urxvt->bootstrap;
496
497	# overwrite perl's warn	628	# overwrite perl's warn
498	*CORE::GLOBAL::warn = sub {	629	*CORE::GLOBAL::warn = sub {
499	my $msg = join "", @_;	630	my $msg = join "", @_;
500	$msg .= "\n"	631	$msg .= "\n"
501	unless $msg =~ /\n$/;	632	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	633	urxvt::warn ($msg);
503	};	634	};
504		635
		636	# %ENV is the original startup environment
505	delete $ENV{IFS};	637	delete $ENV{IFS};
506	delete $ENV{CDPATH};	638	delete $ENV{CDPATH};
507	delete $ENV{BASH_ENV};	639	delete $ENV{BASH_ENV};
508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	640	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509	}	641	}
510		642
511	my @hook_count;
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	643	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		644
514	sub verbose {	645	sub verbose {
515	my ($level, $msg) = @_;	646	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	647	warn "$msg\n" if $level <= $verbosity;
517	}	648	}
518		649
519	my $extension_pkg = "extension0000";
520	my %extension_pkg;	650	my %extension_pkg;
521		651
522	# load a single script into its own package, once only	652	# load a single script into its own package, once only
523	sub extension_package($) {	653	sub extension_package($) {
524	my ($path) = @_;	654	my ($path) = @_;
525		655
		656	no strict 'refs';
		657
526	$extension_pkg{$path} \|\|= do {	658	$extension_pkg{$path} \|\|= do {
527	my $pkg = "urxvt::" . ($extension_pkg++);	659	$path =~ /([^\/\\]+)$/;
		660	my $pkg = $1;
		661	$pkg =~ s/[^[:word:]]/_/g;
		662	$pkg = "urxvt::ext::$pkg";
528		663
529	verbose 3, "loading extension '$path' into package '$pkg'";	664	verbose 3, "loading extension '$path' into package '$pkg'";
530		665
531	open my $fh, "<:raw", $path	666	open my $fh, "<:raw", $path
532	or die "$path: $!";	667	or die "$path: $!";
533		668
		669	@{"$pkg\::ISA"} = urxvt::term::extension::;
		670
534	my $source = untaint	671	my $source =
535	"package $pkg; use strict; use utf8;\n"	672	"package $pkg; use strict; use utf8;\n"
536	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	673	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	674	. (do { local $/; <$fh> })
539	. "\n};\n1";	675	. "\n};\n1";
540		676
541	eval $source	677	eval $source
…		…
598	if ($@) {	734	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	735	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	736	warn $@;
601	}	737	}
602	}	738	}
		739
		740	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		741	if $verbosity >= 11;
603	}	742	}
604		743
605	if ($htype == 1) { # DESTROY	744	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	745	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	746	%$_ = () for values %{ $TERM->{_pkg} };
615		747
616	# clear package	748	# clear package
617	%$TERM = ();	749	%$TERM = ();
618	}	750	}
619		751
620	$retval	752	$retval
		753	}
		754
		755	sub exec_async(@) {
		756	my $pid = fork;
		757
		758	return
		759	if !defined $pid or $pid;
		760
		761	%ENV = %{ $TERM->env };
		762
		763	exec @_;
		764	_exit 255;
621	}	765	}
622		766
623	# urxvt::term::extension	767	# urxvt::term::extension
624		768
625	package urxvt::term::extension;	769	package urxvt::term::extension;
…		…
631	while (my ($name, $cb) = each %hook) {	775	while (my ($name, $cb) = each %hook) {
632	my $htype = $HOOKTYPE{uc $name};	776	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	777	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	778	or Carp::croak "unsupported hook type '$name'";
635		779
		780	$self->set_should_invoke ($htype, +1)
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	781	unless exists $self->{term}{_hook}[$htype]{$pkg};
637	$hook_count[$htype]++
638	or urxvt::set_should_invoke $htype, 1;
639	}
640		782
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	783	$self->{term}{_hook}[$htype]{$pkg} = $cb;
642	}	784	}
643	}	785	}
644		786
…		…
649	for my $name (@hook) {	791	for my $name (@hook) {
650	my $htype = $HOOKTYPE{uc $name};	792	my $htype = $HOOKTYPE{uc $name};
651	defined $htype	793	defined $htype
652	or Carp::croak "unsupported hook type '$name'";	794	or Carp::croak "unsupported hook type '$name'";
653		795
		796	$self->set_should_invoke ($htype, -1)
654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	797	if delete $self->{term}{_hook}[$htype]{$pkg};
655	--$hook_count[$htype]
656	or urxvt::set_should_invoke $htype, 0;
657	}
658	}	798	}
659	}	799	}
660		800
661	our $AUTOLOAD;	801	our $AUTOLOAD;
662		802
…		…
783	$proxy->enable ($name => $ref);	923	$proxy->enable ($name => $ref);
784	}	924	}
785	}	925	}
786	}	926	}
787		927
		928	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		929
		930	Creates a new terminal, very similar as if you had started it with system
		931	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		932	hash which defines the environment of the new terminal.
		933
		934	Croaks (and probably outputs an error message) if the new instance
		935	couldn't be created. Returns C<undef> if the new instance didn't
		936	initialise perl, and the terminal object otherwise. The C<init> and
		937	C<start> hooks will be called during this call.
		938
		939	=cut
		940
		941	sub new {
		942	my ($class, $env, @args) = @_;
		943
		944	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		945	}
		946
788	=item $term->destroy	947	=item $term->destroy
789		948
790	Destroy the terminal object (close the window, free resources	949	Destroy the terminal object (close the window, free resources
791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	950	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792	watchers (timers, io watchers) are still active.	951	watchers (timers, io watchers) are still active.
…		…
800	Here is a a likely non-exhaustive list of option names, please see the	959	Here is a a likely non-exhaustive list of option names, please see the
801	source file F</src/optinc.h> to see the actual list:	960	source file F</src/optinc.h> to see the actual list:
802		961
803	borderLess console cursorBlink cursorUnderline hold iconic insecure	962	borderLess console cursorBlink cursorUnderline hold iconic insecure
804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	963	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	964	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	965	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	966	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808	tripleclickwords utmpInhibit visualBell	967	transparent tripleclickwords utmpInhibit visualBell
809		968
810	=item $value = $term->resource ($name[, $newval])	969	=item $value = $term->resource ($name[, $newval])
811		970
812	Returns the current resource value associated with a given name and	971	Returns the current resource value associated with a given name and
813	optionally sets a new value. Setting values is most useful in the C<init>	972	optionally sets a new value. Setting values is most useful in the C<init>
…		…
830		989
831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	990	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832	borderLess color cursorBlink cursorUnderline cutchars delete_key	991	borderLess color cursorBlink cursorUnderline cutchars delete_key
833	display_name embed ext_bwidth fade font geometry hold iconName	992	display_name embed ext_bwidth fade font geometry hold iconName
834	imFont imLocale inputMethod insecure int_bwidth intensityStyles	993	imFont imLocale inputMethod insecure int_bwidth intensityStyles
835	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	994	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	995	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	996	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	997	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	998	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	999	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841	shade term_name title transparent transparent_all tripleclickwords	1000	secondaryScreen secondaryScroll selectstyle shade term_name title
842	utmpInhibit visualBell	1001	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1002	visualBell
843		1003
844	=cut	1004	=cut
845		1005
846	sub resource($$;$) {	1006	sub resource($$;$) {
847	my ($self, $name) = (shift, shift);	1007	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1008	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	1009	&urxvt::term::_resource
850	}	1010	}
851		1011
		1012	=item $value = $term->x_resource ($pattern)
		1013
		1014	Returns the X-Resource for the given pattern, excluding the program or
		1015	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1016	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1017	resource with that pattern exists.
		1018
		1019	This method should only be called during the C<on_start> hook, as there is
		1020	only one resource database per display, and later invocations might return
		1021	the wrong resources.
		1022
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1023	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		1024
854	Adds a keymap translation exactly as specified via a resource. See the	1025	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1026	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		1027
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	1042	=item ($row, $col) = $term->selection_end ([$row, $col])
872		1043
873	Return the current values of the selection mark, begin or end positions,	1044	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	1045	and optionally set them to new values.
875		1046
		1047	=item $term->selection_make ($eventtime[, $rectangular])
		1048
		1049	Tries to make a selection as set by C<selection_beg> and
		1050	C<selection_end>. If C<$rectangular> is true (default: false), a
		1051	rectangular selection will be made. This is the prefered function to make
		1052	a selection.
		1053
876	=item $success = $term->selection_grab ($eventtime)	1054	=item $success = $term->selection_grab ($eventtime)
877		1055
878	Try to request the primary selection from the server (for example, as set	1056	Try to request the primary selection text from the server (for example, as
879	by the next method).	1057	set by the next method). No visual feedback will be given. This function
		1058	is mostly useful from within C<on_sel_grab> hooks.
880		1059
881	=item $oldtext = $term->selection ([$newtext])	1060	=item $oldtext = $term->selection ([$newtext])
882		1061
883	Return the current selection text and optionally replace it by C<$newtext>.	1062	Return the current selection text and optionally replace it by C<$newtext>.
884		1063
…		…
977	Convert the given locale-encoded octets into a perl string.	1156	Convert the given locale-encoded octets into a perl string.
978		1157
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1158	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1159
981	XORs the rendition values in the given span with the provided value	1160	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	1161	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1162	refresh hooks to provide effects similar to the selection.
984		1163
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1164	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1165
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1166	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1167	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	1168	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
990	it instead.	1169	it instead. Both styles I<MUST NOT> contain font styles.
991		1170
992	=item $term->scr_bell	1171	=item $term->scr_bell
993		1172
994	Ring the bell!	1173	Ring the bell!
995		1174
…		…
1029		1208
1030	=item $windowid = $term->vt	1209	=item $windowid = $term->vt
1031		1210
1032	Return the window id of the terminal window.	1211	Return the window id of the terminal window.
1033		1212
		1213	=item $term->vt_emask_add ($x_event_mask)
		1214
		1215	Adds the specified events to the vt event mask. Useful e.g. when you want
		1216	to receive pointer events all the times:
		1217
		1218	$term->vt_emask_add (urxvt::PointerMotionMask);
		1219
1034	=item $window_width = $term->width	1220	=item $window_width = $term->width
1035		1221
1036	=item $window_height = $term->height	1222	=item $window_height = $term->height
1037		1223
1038	=item $font_width = $term->fwidth	1224	=item $font_width = $term->fwidth
…		…
1051		1237
1052	=item $max_scrollback = $term->saveLines	1238	=item $max_scrollback = $term->saveLines
1053		1239
1054	=item $nrow_plus_saveLines = $term->total_rows	1240	=item $nrow_plus_saveLines = $term->total_rows
1055		1241
1056	=item $lines_in_scrollback = $term->nsaved	1242	=item $topmost_scrollback_row = $term->top_row
1057		1243
1058	Return various integers describing terminal characteristics.	1244	Return various integers describing terminal characteristics.
1059		1245
		1246	=item $x_display = $term->display_id
		1247
		1248	Return the DISPLAY used by rxvt-unicode.
		1249
1060	=item $lc_ctype = $term->locale	1250	=item $lc_ctype = $term->locale
1061		1251
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1252	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1253
1064	=item $x_display = $term->display_id	1254	=item $env = $term->env
1065		1255
1066	Return the DISPLAY used by rxvt-unicode.	1256	Returns a copy of the environment in effect for the terminal as a hashref
		1257	similar to C<\%ENV>.
		1258
		1259	=cut
		1260
		1261	sub env {
		1262	if (my $env = $_[0]->_env) {
		1263	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1264	} else {
		1265	+{ %ENV }
		1266	}
		1267	}
1067		1268
1068	=item $modifiermask = $term->ModLevel3Mask	1269	=item $modifiermask = $term->ModLevel3Mask
1069		1270
1070	=item $modifiermask = $term->ModMetaMask	1271	=item $modifiermask = $term->ModMetaMask
1071		1272
…		…
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1275	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.	1276	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1277
1077	=item $view_start = $term->view_start ([$newvalue])	1278	=item $view_start = $term->view_start ([$newvalue])
1078		1279
1079	Returns the negative row number of the topmost line. Minimum value is	1280	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1281	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1282	this many lines into the scrollback buffer.
1082		1283
1083	=item $term->want_refresh	1284	=item $term->want_refresh
1084		1285
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1286	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.	1365	Return the row number of the first/last row of the line, respectively.
1165		1366
1166	=item $offset = $line->offset_of ($row, $col)	1367	=item $offset = $line->offset_of ($row, $col)
1167		1368
1168	Returns the character offset of the given row\|col pair within the logical	1369	Returns the character offset of the given row\|col pair within the logical
1169	line.	1370	line. Works for rows outside the line, too, and returns corresponding
		1371	offsets outside the string.
1170		1372
1171	=item ($row, $col) = $line->coord_of ($offset)	1373	=item ($row, $col) = $line->coord_of ($offset)
1172		1374
1173	Translates a string offset into terminal coordinates again.	1375	Translates a string offset into terminal coordinates again.
1174		1376
…		…
1311	$item->{render} \|\|= sub { $_[0]{text} };	1513	$item->{render} \|\|= sub { $_[0]{text} };
1312		1514
1313	push @{ $self->{item} }, $item;	1515	push @{ $self->{item} }, $item;
1314	}	1516	}
1315		1517
		1518	=item $popup->add_title ($title)
		1519
		1520	Adds a non-clickable title to the popup.
		1521
		1522	=cut
		1523
		1524	sub add_title {
		1525	my ($self, $title) = @_;
		1526
		1527	$self->add_item ({
		1528	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1529	text => $title,
		1530	activate => sub { },
		1531	});
		1532	}
		1533
		1534	=item $popup->add_separator ([$sepchr])
		1535
		1536	Creates a separator, optionally using the character given as C<$sepchr>.
		1537
		1538	=cut
		1539
1316	sub add_separator {	1540	sub add_separator {
1317	my ($self, $sep) = @_;	1541	my ($self, $sep) = @_;
1318		1542
1319	$sep \|\|= "=";	1543	$sep \|\|= "=";
1320		1544
…		…
1324	render => sub { $sep x $self->{term}->ncol },	1548	render => sub { $sep x $self->{term}->ncol },
1325	activate => sub { },	1549	activate => sub { },
1326	});	1550	});
1327	}	1551	}
1328		1552
1329	sub add_title {	1553	=item $popup->add_button ($text, $cb)
1330	my ($self, $title) = @_;
1331		1554
1332	$self->add_item ({	1555	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" },	1556	selected.
1334	text => $title,	1557
1335	activate => sub { },	1558	=cut
1336	});
1337	}
1338		1559
1339	sub add_button {	1560	sub add_button {
1340	my ($self, $text, $cb) = @_;	1561	my ($self, $text, $cb) = @_;
1341		1562
1342	$self->add_item ({ type => "button", text => $text, activate => $cb});	1563	$self->add_item ({ type => "button", text => $text, activate => $cb});
1343	}	1564	}
		1565
		1566	=item $popup->add_toggle ($text, $cb, $initial_value)
		1567
		1568	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1569	whenever it gets toggled, with a boolean indicating its value as its first
		1570	argument.
		1571
		1572	=cut
1344		1573
1345	sub add_toggle {	1574	sub add_toggle {
1346	my ($self, $text, $cb, $value) = @_;	1575	my ($self, $text, $cb, $value) = @_;
1347		1576
1348	my $item; $item = {	1577	my $item; $item = {
1349	type => "button",	1578	type => "button",
1350	text => " $text",	1579	text => " $text",
1351	value => $value,	1580	value => $value,
1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1581	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1582	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354	};	1583	};
1355		1584
1356	$self->add_item ($item);	1585	$self->add_item ($item);
1357	}	1586	}
		1587
		1588	=item $popup->show
		1589
		1590	Displays the popup (which is initially hidden).
		1591
		1592	=cut
1358		1593
1359	sub show {	1594	sub show {
1360	my ($self) = @_;	1595	my ($self) = @_;
1361		1596
1362	local $urxvt::popup::self = $self;	1597	local $urxvt::popup::self = $self;
1363		1598
		1599	my $env = $self->{term}->env;
		1600	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1601	delete $env->{LC_ALL};
1364	local $ENV{LC_ALL} = $self->{term}->locale;	1602	$env->{LC_CTYPE} = $self->{term}->locale;
1365		1603
1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1604	urxvt::term->new ($env, "popup",
		1605	"--perl-lib" => "", "--perl-ext-common" => "",
		1606	"-pty-fd" => -1, "-sl" => 0, "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1367	"--transient-for" => $self->{term}->parent,	1607	"--transient-for" => $self->{term}->parent,
1368	"-display" => $self->{term}->display_id,	1608	"-display" => $self->{term}->display_id,
1369	"-pe" => "urxvt-popup")	1609	"-pe" => "urxvt-popup")
1370	or die "unable to create popup window\n";	1610	or die "unable to create popup window\n";
1371	}	1611	}
1372		1612
1373	sub DESTROY {	1613	sub DESTROY {
1374	my ($self) = @_;	1614	my ($self) = @_;
1375		1615
1376	delete $self->{term}{_destroy}{$self};	1616	delete $self->{term}{_destroy}{$self};
1377	$self->{term}->ungrab;	1617	$self->{term}->ungrab;
1378	}	1618	}
		1619
		1620	=back
1379		1621
1380	=head2 The C<urxvt::timer> Class	1622	=head2 The C<urxvt::timer> Class
1381		1623
1382	This class implements timer watchers/events. Time is represented as a	1624	This class implements timer watchers/events. Time is represented as a
1383	fractional number of seconds since the epoch. Example:	1625	fractional number of seconds since the epoch. Example:
…		…
1421	Start the timer.	1663	Start the timer.
1422		1664
1423	=item $timer = $timer->start ($tstamp)	1665	=item $timer = $timer->start ($tstamp)
1424		1666
1425	Set the event trigger time to C<$tstamp> and start the timer.	1667	Set the event trigger time to C<$tstamp> and start the timer.
		1668
		1669	=item $timer = $timer->after ($delay)
		1670
		1671	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1426		1672
1427	=item $timer = $timer->stop	1673	=item $timer = $timer->stop
1428		1674
1429	Stop the timer.	1675	Stop the timer.
1430		1676
…		…
1490		1736
1491	=item == 0 - fatal messages	1737	=item == 0 - fatal messages
1492		1738
1493	=item >= 3 - script loading and management	1739	=item >= 3 - script loading and management
1494		1740
1495	=item >=10 - all events received	1741	=item >=10 - all called hooks
		1742
		1743	=item >=11 - hook reutrn values
1496		1744
1497	=back	1745	=back
1498		1746
1499	=head1 AUTHOR	1747	=head1 AUTHOR
1500		1748

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.105 by root, Wed Jan 18 19:43:51 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.105 by root, Wed Jan 18 19:43:51 2006 UTC