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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.99 by root, Tue Jan 17 17:09:26 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	now, it tries to select words, urls and complete shell-quoted
47	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
49	It also offers the following bindable event:	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
		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
…		…
64	runtime.	86	runtime.
65		87
66	=item selection-popup (enabled by default)	88	=item selection-popup (enabled by default)
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.	91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
70		93
71	=item searchable-scrollback<hotkey> (enabled by default)	94	=item searchable-scrollback<hotkey> (enabled by default)
72		95
73	Adds regex search functionality to the scrollback buffer, triggered	96	Adds regex search functionality to the scrollback buffer, triggered
74	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
75	input/output is suspended.	98	input/output is suspended and a regex is displayed at the bottom of the
		99	screen.
76		100
77	C</> starts an incremental regex search, C<n> searches further, C<p> or	101	Inputting characters appends them to the regex and continues incremental
78	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>
79	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
80	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.
81		108
82	=item digital-clock	109	=item selection-autotransform
83		110
84	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.
85		143
86	=item mark-urls	144	=item mark-urls
87		145
88	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.
89		150
90	=item block-graphics-to-ascii	151	=item block-graphics-to-ascii
91		152
92	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,
93	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
94	similar-looking ascii character.	155	similar-looking ascii character.
95		156
		157	=item digital-clock
		158
		159	Displays a digital clock using the built-in overlay.
		160
96	=item example-refresh-hooks	161	=item example-refresh-hooks
97		162
98	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
99	window. Illustrates overwriting the refresh callbacks to create your own	164	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	165	overlays or changes.
101		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/%
		195
102	=back	196	=back
		197
		198	=head1 API DOCUMENTATION
103		199
104	=head2 General API Considerations	200	=head2 General API Considerations
105		201
106	All objects (such as terminals, time watchers etc.) are typical	202	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	203	reference-to-hash objects. The hash can be used to store anything you
…		…
120	=over 4	216	=over 4
121		217
122	=item $text	218	=item $text
123		219
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	220	Rxvt-unicodes special way of encoding text, where one "unicode" character
125	always represents one screen cell. See L<row_t> for a discussion of this format.	221	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		222
127	=item $string	223	=item $string
128		224
129	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
130	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
…		…
225	=item on_sel_extend $term	321	=item on_sel_extend $term
226		322
227	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
228	click) and is either supposed to return false (normal operation), or	324	click) and is either supposed to return false (normal operation), or
229	should extend the selection itelf and return true to suppress the built-in	325	should extend the selection itelf and return true to suppress the built-in
230	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.
231		329
232	See the F<selection> example extension.	330	See the F<selection> example extension.
233		331
234	=item on_view_change $term, $offset	332	=item on_view_change $term, $offset
235		333
…		…
302		400
303	Called whenever the user presses a key combination that has a	401	Called whenever the user presses a key combination that has a
304	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>
305	resource in the @@RXVT_NAME@@(1) manpage).	403	resource in the @@RXVT_NAME@@(1) manpage).
306		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
307	=item on_focus_in $term	411	=item on_focus_in $term
308		412
309	Called whenever the window gets the keyboard focus, before rxvt-unicode	413	Called whenever the window gets the keyboard focus, before rxvt-unicode
310	does focus in processing.	414	does focus in processing.
311		415
…		…
337		441
338	C<on_key_press> additionally receives the string rxvt-unicode would	442	C<on_key_press> additionally receives the string rxvt-unicode would
339	output, if any, in locale-specific encoding.	443	output, if any, in locale-specific encoding.
340		444
341	subwindow.	445	subwindow.
342
343	=back
344
345	=head2 Variables in the C<urxvt> Package
346
347	=over 4
348
349	=item $urxvt::TERM
350
351	The current terminal. This variable stores the current C<urxvt::term>
352	object, whenever a callback/hook is executing.
353
354	=back
355
356	=head2 Functions in the C<urxvt> Package
357
358	=over 4
359
360	=item $term = new urxvt [arg...]
361
362	Creates a new terminal, very similar as if you had started it with
363	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
364	if the new instance couldn't be created. Returns C<undef> if the new
365	instance didn't initialise perl, and the terminal object otherwise. The
366	C<init> and C<start> hooks will be called during the call.
367
368	=item urxvt::fatal $errormessage
369
370	Fatally aborts execution with the given error message. Avoid at all
371	costs! The only time this is acceptable is when the terminal process
372	starts up.
373
374	=item urxvt::warn $string
375
376	Calls C<rxvt_warn> with the given string which should not include a
377	newline. The module also overwrites the C<warn> builtin with a function
378	that calls this function.
379
380	Using this function has the advantage that its output ends up in the
381	correct place, e.g. on stderr of the connecting urxvtc client.
382
383	=item $is_safe = urxvt::safe
384
385	Returns true when it is safe to do potentially unsafe things, such as
386	evaluating perl code specified by the user. This is true when urxvt was
387	started setuid or setgid.
388
389	=item $time = urxvt::NOW
390
391	Returns the "current time" (as per the event loop).
392
393	=item urxvt::CurrentTime
394
395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
397	Button4Mask, Button5Mask, AnyModifier
398
399	Various constants for use in X calls and event processing.
400
401	=back
402
403	=head2 RENDITION
404
405	Rendition bitsets contain information about colour, font, font styles and
406	similar information for each screen cell.
407
408	The following "macros" deal with changes in rendition sets. You should
409	never just create a bitset, you should always modify an existing one,
410	as they contain important information required for correct operation of
411	rxvt-unicode.
412
413	=over 4
414
415	=item $rend = urxvt::DEFAULT_RSTYLE
416
417	Returns the default rendition, as used when the terminal is starting up or
418	being reset. Useful as a base to start when creating renditions.
419
420	=item $rend = urxvt::OVERLAY_RSTYLE
421
422	Return the rendition mask used for overlays by default.
423
424	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
425
426	Return the bit that enabled bold, italic, blink, reverse-video and
427	underline, respectively. To enable such a style, just logically OR it into
428	the bitset.
429
430	=item $foreground = urxvt::GET_BASEFG $rend
431
432	=item $background = urxvt::GET_BASEBG $rend
433
434	Return the foreground/background colour index, respectively.
435
436	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
437
438	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
439
440	Replace the foreground/background colour in the rendition mask with the
441	specified one.
442
443	=item $value = urxvt::GET_CUSTOM ($rend)
444
445	Return the "custom" value: Every rendition has 5 bits for use by
446	extensions. They can be set and changed as you like and are initially
447	zero.
448
449	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
450
451	Change the custom value.
452		446
453	=back	447	=back
454		448
455	=cut	449	=cut
456		450
…		…
470		464
471	our $LIBDIR;	465	our $LIBDIR;
472	our $RESNAME;	466	our $RESNAME;
473	our $RESCLASS;	467	our $RESCLASS;
474	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
475		598
476	BEGIN {	599	BEGIN {
477	urxvt->bootstrap;	600	urxvt->bootstrap;
478		601
479	# overwrite perl's warn	602	# overwrite perl's warn
…		…
482	$msg .= "\n"	605	$msg .= "\n"
483	unless $msg =~ /\n$/;	606	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	607	urxvt::warn ($msg);
485	};	608	};
486		609
		610	# %ENV is the original startup environment
487	delete $ENV{IFS};	611	delete $ENV{IFS};
488	delete $ENV{CDPATH};	612	delete $ENV{CDPATH};
489	delete $ENV{BASH_ENV};	613	delete $ENV{BASH_ENV};
490	$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";
491	}	615	}
492		616
493	my @hook_count;
494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	617	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495		618
496	sub verbose {	619	sub verbose {
497	my ($level, $msg) = @_;	620	my ($level, $msg) = @_;
498	warn "$msg\n" if $level <= $verbosity;	621	warn "$msg\n" if $level <= $verbosity;
…		…
511	verbose 3, "loading extension '$path' into package '$pkg'";	634	verbose 3, "loading extension '$path' into package '$pkg'";
512		635
513	open my $fh, "<:raw", $path	636	open my $fh, "<:raw", $path
514	or die "$path: $!";	637	or die "$path: $!";
515		638
516	my $source = untaint	639	my $source =
517	"package $pkg; use strict; use utf8;\n"	640	"package $pkg; use strict; use utf8;\n"
518	. "use base urxvt::term::extension::;\n"	641	. "use base urxvt::term::extension::;\n"
519	. "#line 1 \"$path\"\n{\n"	642	. "#line 1 \"$path\"\n{\n"
520	. (do { local $/; <$fh> })	643	. (do { local $/; <$fh> })
521	. "\n};\n1";	644	. "\n};\n1";
…		…
580	if ($@) {	703	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	704	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	705	warn $@;
583	}	706	}
584	}	707	}
		708
		709	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		710	if $verbosity >= 11;
585	}	711	}
586		712
587	if ($htype == 1) { # DESTROY	713	if ($htype == 1) { # DESTROY
588	if (my $hook = delete $TERM->{_hook}) {
589	for my $htype (0..$#$hook) {
590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
591	or set_should_invoke $htype, 0;
592	}
593	}
594
595	# clear package objects	714	# clear package objects
596	%$_ = () for values %{ $TERM->{_pkg} };	715	%$_ = () for values %{ $TERM->{_pkg} };
597		716
598	# clear package	717	# clear package
599	%$TERM = ();	718	%$TERM = ();
600	}	719	}
601		720
602	$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;
603	}	734	}
604		735
605	# urxvt::term::extension	736	# urxvt::term::extension
606		737
607	package urxvt::term::extension;	738	package urxvt::term::extension;
…		…
613	while (my ($name, $cb) = each %hook) {	744	while (my ($name, $cb) = each %hook) {
614	my $htype = $HOOKTYPE{uc $name};	745	my $htype = $HOOKTYPE{uc $name};
615	defined $htype	746	defined $htype
616	or Carp::croak "unsupported hook type '$name'";	747	or Carp::croak "unsupported hook type '$name'";
617		748
		749	$self->set_should_invoke ($htype, +1)
618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	750	unless exists $self->{term}{_hook}[$htype]{$pkg};
619	$hook_count[$htype]++
620	or urxvt::set_should_invoke $htype, 1;
621	}
622		751
623	$self->{term}{_hook}[$htype]{$pkg} = $cb;	752	$self->{term}{_hook}[$htype]{$pkg} = $cb;
624	}	753	}
625	}	754	}
626		755
…		…
631	for my $name (@hook) {	760	for my $name (@hook) {
632	my $htype = $HOOKTYPE{uc $name};	761	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	762	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	763	or Carp::croak "unsupported hook type '$name'";
635		764
		765	$self->set_should_invoke ($htype, -1)
636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	766	if delete $self->{term}{_hook}[$htype]{$pkg};
637	--$hook_count[$htype]
638	or urxvt::set_should_invoke $htype, 0;
639	}
640	}	767	}
641	}	768	}
642		769
643	our $AUTOLOAD;	770	our $AUTOLOAD;
644		771
…		…
675		802
676	=head2 The C<urxvt::anyevent> Class	803	=head2 The C<urxvt::anyevent> Class
677		804
678	The sole purpose of this class is to deliver an interface to the	805	The sole purpose of this class is to deliver an interface to the
679	C<AnyEvent> module - any module using it will work inside urxvt without	806	C<AnyEvent> module - any module using it will work inside urxvt without
680	further work. The only exception is that you cannot wait on condition	807	further programming. The only exception is that you cannot wait on
681	variables, but non-blocking condvar use is ok. What this means is that you	808	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	809	is that you cannot use blocking APIs, but the non-blocking variant should
		810	work.
683		811
684	=cut	812	=cut
685		813
686	our $VERSION = 1;	814	our $VERSION = 1;
687		815
…		…
764	$proxy->enable ($name => $ref);	892	$proxy->enable ($name => $ref);
765	}	893	}
766	}	894	}
767	}	895	}
768		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);
		914	}
		915
769	=item $term->destroy	916	=item $term->destroy
770		917
771	Destroy the terminal object (close the window, free resources etc.).	918	Destroy the terminal object (close the window, free resources
		919	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		920	watchers (timers, io watchers) are still active.
772		921
773	=item $isset = $term->option ($optval[, $set])	922	=item $isset = $term->option ($optval[, $set])
774		923
775	Returns true if the option specified by C<$optval> is enabled, and	924	Returns true if the option specified by C<$optval> is enabled, and
776	optionally change it. All option values are stored by name in the hash	925	optionally change it. All option values are stored by name in the hash
…		…
826	my ($self, $name) = (shift, shift);	975	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	976	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	977	&urxvt::term::_resource
829	}	978	}
830		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
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	991	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		992
833	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
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	994	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835		995
…		…
850	=item ($row, $col) = $term->selection_end ([$row, $col])	1010	=item ($row, $col) = $term->selection_end ([$row, $col])
851		1011
852	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,
853	and optionally set them to new values.	1013	and optionally set them to new values.
854		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
855	=item $success = $term->selection_grab ($eventtime)	1022	=item $success = $term->selection_grab ($eventtime)
856		1023
857	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
858	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.
859		1027
860	=item $oldtext = $term->selection ([$newtext])	1028	=item $oldtext = $term->selection ([$newtext])
861		1029
862	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>.
863		1031
…		…
956	Convert the given locale-encoded octets into a perl string.	1124	Convert the given locale-encoded octets into a perl string.
957		1125
958	=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])
959		1127
960	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
961	(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
962	to the selection.	1130	refresh hooks to provide effects similar to the selection.
963		1131
964	=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]])
965		1133
966	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
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1135	whitespace will additionally be xored with the C<$rstyle2>, which defaults
968	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1136	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
969	it instead.	1137	it instead. Both styles I<MUST NOT> contain font styles.
970		1138
971	=item $term->scr_bell	1139	=item $term->scr_bell
972		1140
973	Ring the bell!	1141	Ring the bell!
974		1142
…		…
1008		1176
1009	=item $windowid = $term->vt	1177	=item $windowid = $term->vt
1010		1178
1011	Return the window id of the terminal window.	1179	Return the window id of the terminal window.
1012		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
1013	=item $window_width = $term->width	1188	=item $window_width = $term->width
1014		1189
1015	=item $window_height = $term->height	1190	=item $window_height = $term->height
1016		1191
1017	=item $font_width = $term->fwidth	1192	=item $font_width = $term->fwidth
…		…
1030		1205
1031	=item $max_scrollback = $term->saveLines	1206	=item $max_scrollback = $term->saveLines
1032		1207
1033	=item $nrow_plus_saveLines = $term->total_rows	1208	=item $nrow_plus_saveLines = $term->total_rows
1034		1209
1035	=item $lines_in_scrollback = $term->nsaved	1210	=item $topmost_scrollback_row = $term->top_row
1036		1211
1037	Return various integers describing terminal characteristics.	1212	Return various integers describing terminal characteristics.
1038		1213
		1214	=item $x_display = $term->display_id
		1215
		1216	Return the DISPLAY used by rxvt-unicode.
		1217
1039	=item $lc_ctype = $term->locale	1218	=item $lc_ctype = $term->locale
1040		1219
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1220	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1221
1043	=item $x_display = $term->display_id	1222	=item $env = $term->env
1044		1223
1045	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	}
1046		1236
1047	=item $modifiermask = $term->ModLevel3Mask	1237	=item $modifiermask = $term->ModLevel3Mask
1048		1238
1049	=item $modifiermask = $term->ModMetaMask	1239	=item $modifiermask = $term->ModMetaMask
1050		1240
…		…
1053	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
1054	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.
1055		1245
1056	=item $view_start = $term->view_start ([$newvalue])	1246	=item $view_start = $term->view_start ([$newvalue])
1057		1247
1058	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
1059	C<0>, which displays the normal terminal contents. Larger values scroll	1249	C<0>, which displays the normal terminal contents. Lower values scroll
1060	this many lines into the scrollback buffer.	1250	this many lines into the scrollback buffer.
1061		1251
1062	=item $term->want_refresh	1252	=item $term->want_refresh
1063		1253
1064	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1254	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1143	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.
1144		1334
1145	=item $offset = $line->offset_of ($row, $col)	1335	=item $offset = $line->offset_of ($row, $col)
1146		1336
1147	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
1148	line.	1338	line. Works for rows outside the line, too, and returns corresponding
		1339	offsets outside the string.
1149		1340
1150	=item ($row, $col) = $line->coord_of ($offset)	1341	=item ($row, $col) = $line->coord_of ($offset)
1151		1342
1152	Translates a string offset into terminal coordinates again.	1343	Translates a string offset into terminal coordinates again.
1153		1344
…		…
1290	$item->{render} \|\|= sub { $_[0]{text} };	1481	$item->{render} \|\|= sub { $_[0]{text} };
1291		1482
1292	push @{ $self->{item} }, $item;	1483	push @{ $self->{item} }, $item;
1293	}	1484	}
1294		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
1295	sub add_separator {	1508	sub add_separator {
1296	my ($self, $sep) = @_;	1509	my ($self, $sep) = @_;
1297		1510
1298	$sep \|\|= "=";	1511	$sep \|\|= "=";
1299		1512
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1516	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1517	activate => sub { },
1305	});	1518	});
1306	}	1519	}
1307		1520
1308	sub add_title {	1521	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1522
1311	$self->add_item ({	1523	Adds a clickable button to the popup. C<$cb> is called whenever it is
1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1524	selected.
1313	text => $title,	1525
1314	activate => sub { },	1526	=cut
1315	});
1316	}
1317		1527
1318	sub add_button {	1528	sub add_button {
1319	my ($self, $text, $cb) = @_;	1529	my ($self, $text, $cb) = @_;
1320		1530
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1531	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	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
1323		1541
1324	sub add_toggle {	1542	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1543	my ($self, $text, $cb, $value) = @_;
1326		1544
1327	my $item; $item = {	1545	my $item; $item = {
1328	type => "button",	1546	type => "button",
1329	text => " $text",	1547	text => " $text",
1330	value => $value,	1548	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1549	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1550	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1551	};
1334		1552
1335	$self->add_item ($item);	1553	$self->add_item ($item);
1336	}	1554	}
		1555
		1556	=item $popup->show
		1557
		1558	Displays the popup (which is initially hidden).
		1559
		1560	=cut
1337		1561
1338	sub show {	1562	sub show {
1339	my ($self) = @_;	1563	my ($self) = @_;
1340		1564
1341	local $urxvt::popup::self = $self;	1565	local $urxvt::popup::self = $self;
1342		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};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1570	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1571
		1572	urxvt::term->new ($env, $self->{term}->resource ("name"),
1345	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,
1346	"--transient-for" => $self->{term}->parent,	1574	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1575	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1576	"-pe" => "urxvt-popup")
1349	or die "unable to create popup window\n";	1577	or die "unable to create popup window\n";
1350	}	1578	}
1351		1579
1352	sub DESTROY {	1580	sub DESTROY {
1353	my ($self) = @_;	1581	my ($self) = @_;
1354		1582
1355	delete $self->{term}{_destroy}{$self};	1583	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1584	$self->{term}->ungrab;
1357	}	1585	}
		1586
		1587	=back
1358		1588
1359	=head2 The C<urxvt::timer> Class	1589	=head2 The C<urxvt::timer> Class
1360		1590
1361	This class implements timer watchers/events. Time is represented as a	1591	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1592	fractional number of seconds since the epoch. Example:
…		…
1469		1699
1470	=item == 0 - fatal messages	1700	=item == 0 - fatal messages
1471		1701
1472	=item >= 3 - script loading and management	1702	=item >= 3 - script loading and management
1473		1703
1474	=item >=10 - all events received	1704	=item >=10 - all called hooks
		1705
		1706	=item >=11 - hook reutrn values
1475		1707
1476	=back	1708	=back
1477		1709
1478	=head1 AUTHOR	1710	=head1 AUTHOR
1479		1711

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs. Revision 1.99 by root, Tue Jan 17 17:09:26 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.99 by root, Tue Jan 17 17:09:26 2006 UTC