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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.97 by elmex, Tue Jan 17 16:53:47 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 (enabled by default)	94	=item searchable-scrollback<hotkey> (enabled by default)
72		95
73	Adds regex search functionality to the scrollback buffer, triggered by a	96	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	suspended, C</> starts an incremental regex search, C<n> searches further,	98	input/output is suspended and a regex is displayed at the bottom of the
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	99	screen.
77	current position and C<escape> returns to the original position.
78		100
79	=item digital-clock	101	Inputting characters appends them to the regex and continues incremental
		102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		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.
80		108
81	Displays a digital clock using the built-in overlay.	109	=item selection-autotransform
		110
		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.
82		143
83	=item mark-urls	144	=item mark-urls
84		145
85	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.
86		150
87	=item block-graphics-to-ascii	151	=item block-graphics-to-ascii
88		152
89	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,
90	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
91	similar-looking ascii character.	155	similar-looking ascii character.
92		156
		157	=item digital-clock
		158
		159	Displays a digital clock using the built-in overlay.
		160
93	=item example-refresh-hooks	161	=item example-refresh-hooks
94		162
95	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
96	window. Illustrates overwriting the refresh callbacks to create your own	164	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	165	overlays or changes.
98		166
		167	=item selection-pastebin
		168
		169	Uploads the selection as textfile to a remote site.
		170
		171	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		172
		173	To set the command to upload the file set this resource:
		174
		175	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		176
		177	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
		178	md5 sum of the selection.
		179	After an successful upload the selection will be replaced by the following url
		180	(the % is the placeholder for the filename):
		181
		182	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
		183
99	=back	184	=back
		185
		186	=head1 API DOCUMENTATION
100		187
101	=head2 General API Considerations	188	=head2 General API Considerations
102		189
103	All objects (such as terminals, time watchers etc.) are typical	190	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	191	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	204	=over 4
118		205
119	=item $text	206	=item $text
120		207
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	208	Rxvt-unicodes special way of encoding text, where one "unicode" character
122	always represents one screen cell. See L<row_t> for a discussion of this format.	209	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		210
124	=item $string	211	=item $string
125		212
126	A perl text string, with an emphasis on I<text>. It can store all unicode	213	A perl text string, with an emphasis on I<text>. It can store all unicode
127	characters and is to be distinguished with text encoded in a specific	214	characters and is to be distinguished with text encoded in a specific
…		…
222	=item on_sel_extend $term	309	=item on_sel_extend $term
223		310
224	Called whenever the user tries to extend the selection (e.g. with a double	311	Called whenever the user tries to extend the selection (e.g. with a double
225	click) and is either supposed to return false (normal operation), or	312	click) and is either supposed to return false (normal operation), or
226	should extend the selection itelf and return true to suppress the built-in	313	should extend the selection itelf and return true to suppress the built-in
227	processing.	314	processing. This can happen multiple times, as long as the callback
		315	returns true, it will be called on every further click by the user and is
		316	supposed to enlarge the selection more and more, if possible.
228		317
229	See the F<selection> example extension.	318	See the F<selection> example extension.
230		319
231	=item on_view_change $term, $offset	320	=item on_view_change $term, $offset
232		321
…		…
299		388
300	Called whenever the user presses a key combination that has a	389	Called whenever the user presses a key combination that has a
301	C<perl:string> action bound to it (see description of the B<keysym>	390	C<perl:string> action bound to it (see description of the B<keysym>
302	resource in the @@RXVT_NAME@@(1) manpage).	391	resource in the @@RXVT_NAME@@(1) manpage).
303		392
		393	=item on_x_event $term, $event
		394
		395	Called on every X event received on the vt window (and possibly other
		396	windows). Should only be used as a last resort. Most event structure
		397	members are not passed.
		398
304	=item on_focus_in $term	399	=item on_focus_in $term
305		400
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	401	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	402	does focus in processing.
308		403
…		…
334		429
335	C<on_key_press> additionally receives the string rxvt-unicode would	430	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	431	output, if any, in locale-specific encoding.
337		432
338	subwindow.	433	subwindow.
339
340	=back
341
342	=head2 Variables in the C<urxvt> Package
343
344	=over 4
345
346	=item $urxvt::TERM
347
348	The current terminal. This variable stores the current C<urxvt::term>
349	object, whenever a callback/hook is executing.
350
351	=back
352
353	=head2 Functions in the C<urxvt> Package
354
355	=over 4
356
357	=item $term = new urxvt [arg...]
358
359	Creates a new terminal, very similar as if you had started it with
360	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361	if the new instance couldn't be created. Returns C<undef> if the new
362	instance didn't initialise perl, and the terminal object otherwise. The
363	C<init> and C<start> hooks will be called during the call.
364
365	=item urxvt::fatal $errormessage
366
367	Fatally aborts execution with the given error message. Avoid at all
368	costs! The only time this is acceptable is when the terminal process
369	starts up.
370
371	=item urxvt::warn $string
372
373	Calls C<rxvt_warn> with the given string which should not include a
374	newline. The module also overwrites the C<warn> builtin with a function
375	that calls this function.
376
377	Using this function has the advantage that its output ends up in the
378	correct place, e.g. on stderr of the connecting urxvtc client.
379
380	=item $is_safe = urxvt::safe
381
382	Returns true when it is safe to do potentially unsafe things, such as
383	evaluating perl code specified by the user. This is true when urxvt was
384	started setuid or setgid.
385
386	=item $time = urxvt::NOW
387
388	Returns the "current time" (as per the event loop).
389
390	=item urxvt::CurrentTime
391
392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394	Button4Mask, Button5Mask, AnyModifier
395
396	Various constants for use in X calls and event processing.
397
398	=back
399
400	=head2 RENDITION
401
402	Rendition bitsets contain information about colour, font, font styles and
403	similar information for each screen cell.
404
405	The following "macros" deal with changes in rendition sets. You should
406	never just create a bitset, you should always modify an existing one,
407	as they contain important information required for correct operation of
408	rxvt-unicode.
409
410	=over 4
411
412	=item $rend = urxvt::DEFAULT_RSTYLE
413
414	Returns the default rendition, as used when the terminal is starting up or
415	being reset. Useful as a base to start when creating renditions.
416
417	=item $rend = urxvt::OVERLAY_RSTYLE
418
419	Return the rendition mask used for overlays by default.
420
421	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
422
423	Return the bit that enabled bold, italic, blink, reverse-video and
424	underline, respectively. To enable such a style, just logically OR it into
425	the bitset.
426
427	=item $foreground = urxvt::GET_BASEFG $rend
428
429	=item $background = urxvt::GET_BASEBG $rend
430
431	Return the foreground/background colour index, respectively.
432
433	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
434
435	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
436
437	Replace the foreground/background colour in the rendition mask with the
438	specified one.
439
440	=item $value = urxvt::GET_CUSTOM ($rend)
441
442	Return the "custom" value: Every rendition has 5 bits for use by
443	extensions. They can be set and changed as you like and are initially
444	zero.
445
446	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
447
448	Change the custom value.
449		434
450	=back	435	=back
451		436
452	=cut	437	=cut
453		438
…		…
467		452
468	our $LIBDIR;	453	our $LIBDIR;
469	our $RESNAME;	454	our $RESNAME;
470	our $RESCLASS;	455	our $RESCLASS;
471	our $RXVTNAME;	456	our $RXVTNAME;
		457
		458	=head2 Variables in the C<urxvt> Package
		459
		460	=over 4
		461
		462	=item $urxvt::LIBDIR
		463
		464	The rxvt-unicode library directory, where, among other things, the perl
		465	modules and scripts are stored.
		466
		467	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		468
		469	The resource class and name rxvt-unicode uses to look up X resources.
		470
		471	=item $urxvt::RXVTNAME
		472
		473	The basename of the installed binaries, usually C<urxvt>.
		474
		475	=item $urxvt::TERM
		476
		477	The current terminal. This variable stores the current C<urxvt::term>
		478	object, whenever a callback/hook is executing.
		479
		480	=back
		481
		482	=head2 Functions in the C<urxvt> Package
		483
		484	=over 4
		485
		486	=item urxvt::fatal $errormessage
		487
		488	Fatally aborts execution with the given error message. Avoid at all
		489	costs! The only time this is acceptable is when the terminal process
		490	starts up.
		491
		492	=item urxvt::warn $string
		493
		494	Calls C<rxvt_warn> with the given string which should not include a
		495	newline. The module also overwrites the C<warn> builtin with a function
		496	that calls this function.
		497
		498	Using this function has the advantage that its output ends up in the
		499	correct place, e.g. on stderr of the connecting urxvtc client.
		500
		501	Messages have a size limit of 1023 bytes currently.
		502
		503	=item $time = urxvt::NOW
		504
		505	Returns the "current time" (as per the event loop).
		506
		507	=item urxvt::CurrentTime
		508
		509	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		510	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		511	Button4Mask, Button5Mask, AnyModifier
		512
		513	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		514	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		515	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		516	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		517	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		518	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		519	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		520
		521	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		522	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		523	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		524	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		525	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		526	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		527	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		528
		529	Various constants for use in X calls and event processing.
		530
		531	=back
		532
		533	=head2 RENDITION
		534
		535	Rendition bitsets contain information about colour, font, font styles and
		536	similar information for each screen cell.
		537
		538	The following "macros" deal with changes in rendition sets. You should
		539	never just create a bitset, you should always modify an existing one,
		540	as they contain important information required for correct operation of
		541	rxvt-unicode.
		542
		543	=over 4
		544
		545	=item $rend = urxvt::DEFAULT_RSTYLE
		546
		547	Returns the default rendition, as used when the terminal is starting up or
		548	being reset. Useful as a base to start when creating renditions.
		549
		550	=item $rend = urxvt::OVERLAY_RSTYLE
		551
		552	Return the rendition mask used for overlays by default.
		553
		554	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		555
		556	Return the bit that enabled bold, italic, blink, reverse-video and
		557	underline, respectively. To enable such a style, just logically OR it into
		558	the bitset.
		559
		560	=item $foreground = urxvt::GET_BASEFG $rend
		561
		562	=item $background = urxvt::GET_BASEBG $rend
		563
		564	Return the foreground/background colour index, respectively.
		565
		566	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		567
		568	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		569
		570	Replace the foreground/background colour in the rendition mask with the
		571	specified one.
		572
		573	=item $value = urxvt::GET_CUSTOM $rend
		574
		575	Return the "custom" value: Every rendition has 5 bits for use by
		576	extensions. They can be set and changed as you like and are initially
		577	zero.
		578
		579	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		580
		581	Change the custom value.
		582
		583	=back
		584
		585	=cut
472		586
473	BEGIN {	587	BEGIN {
474	urxvt->bootstrap;	588	urxvt->bootstrap;
475		589
476	# overwrite perl's warn	590	# overwrite perl's warn
…		…
479	$msg .= "\n"	593	$msg .= "\n"
480	unless $msg =~ /\n$/;	594	unless $msg =~ /\n$/;
481	urxvt::warn ($msg);	595	urxvt::warn ($msg);
482	};	596	};
483		597
		598	# %ENV is the original startup environment
484	delete $ENV{IFS};	599	delete $ENV{IFS};
485	delete $ENV{CDPATH};	600	delete $ENV{CDPATH};
486	delete $ENV{BASH_ENV};	601	delete $ENV{BASH_ENV};
487	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	602	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
488	}	603	}
489		604
490	my @hook_count;
491	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	605	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
492		606
493	sub verbose {	607	sub verbose {
494	my ($level, $msg) = @_;	608	my ($level, $msg) = @_;
495	warn "$msg\n" if $level <= $verbosity;	609	warn "$msg\n" if $level <= $verbosity;
…		…
508	verbose 3, "loading extension '$path' into package '$pkg'";	622	verbose 3, "loading extension '$path' into package '$pkg'";
509		623
510	open my $fh, "<:raw", $path	624	open my $fh, "<:raw", $path
511	or die "$path: $!";	625	or die "$path: $!";
512		626
513	my $source = untaint	627	my $source =
514	"package $pkg; use strict; use utf8;\n"	628	"package $pkg; use strict; use utf8;\n"
515	. "use base urxvt::term::extension::;\n"	629	. "use base urxvt::term::extension::;\n"
516	. "#line 1 \"$path\"\n{\n"	630	. "#line 1 \"$path\"\n{\n"
517	. (do { local $/; <$fh> })	631	. (do { local $/; <$fh> })
518	. "\n};\n1";	632	. "\n};\n1";
…		…
577	if ($@) {	691	if ($@) {
578	$TERM->ungrab; # better to lose the grab than the session	692	$TERM->ungrab; # better to lose the grab than the session
579	warn $@;	693	warn $@;
580	}	694	}
581	}	695	}
		696
		697	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		698	if $verbosity >= 11;
582	}	699	}
583		700
584	if ($htype == 1) { # DESTROY	701	if ($htype == 1) { # DESTROY
585	if (my $hook = delete $TERM->{_hook}) {
586	for my $htype (0..$#$hook) {
587	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
588	or set_should_invoke $htype, 0;
589	}
590	}
591
592	# clear package objects	702	# clear package objects
593	%$_ = () for values %{ $TERM->{_pkg} };	703	%$_ = () for values %{ $TERM->{_pkg} };
594		704
595	# clear package	705	# clear package
596	%$TERM = ();	706	%$TERM = ();
597	}	707	}
598		708
599	$retval	709	$retval
		710	}
		711
		712	sub exec_async(@) {
		713	my $pid = fork;
		714
		715	return
		716	if !defined $pid or $pid;
		717
		718	%ENV = %{ $TERM->env };
		719
		720	exec @_;
		721	_exit 255;
600	}	722	}
601		723
602	# urxvt::term::extension	724	# urxvt::term::extension
603		725
604	package urxvt::term::extension;	726	package urxvt::term::extension;
…		…
610	while (my ($name, $cb) = each %hook) {	732	while (my ($name, $cb) = each %hook) {
611	my $htype = $HOOKTYPE{uc $name};	733	my $htype = $HOOKTYPE{uc $name};
612	defined $htype	734	defined $htype
613	or Carp::croak "unsupported hook type '$name'";	735	or Carp::croak "unsupported hook type '$name'";
614		736
		737	$self->set_should_invoke ($htype, +1)
615	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	738	unless exists $self->{term}{_hook}[$htype]{$pkg};
616	$hook_count[$htype]++
617	or urxvt::set_should_invoke $htype, 1;
618	}
619		739
620	$self->{term}{_hook}[$htype]{$pkg} = $cb;	740	$self->{term}{_hook}[$htype]{$pkg} = $cb;
621	}	741	}
622	}	742	}
623		743
…		…
628	for my $name (@hook) {	748	for my $name (@hook) {
629	my $htype = $HOOKTYPE{uc $name};	749	my $htype = $HOOKTYPE{uc $name};
630	defined $htype	750	defined $htype
631	or Carp::croak "unsupported hook type '$name'";	751	or Carp::croak "unsupported hook type '$name'";
632		752
		753	$self->set_should_invoke ($htype, -1)
633	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	754	if delete $self->{term}{_hook}[$htype]{$pkg};
634	--$hook_count[$htype]
635	or urxvt::set_should_invoke $htype, 0;
636	}
637	}	755	}
638	}	756	}
639		757
640	our $AUTOLOAD;	758	our $AUTOLOAD;
641		759
…		…
672		790
673	=head2 The C<urxvt::anyevent> Class	791	=head2 The C<urxvt::anyevent> Class
674		792
675	The sole purpose of this class is to deliver an interface to the	793	The sole purpose of this class is to deliver an interface to the
676	C<AnyEvent> module - any module using it will work inside urxvt without	794	C<AnyEvent> module - any module using it will work inside urxvt without
677	further work. The only exception is that you cannot wait on condition	795	further programming. The only exception is that you cannot wait on
678	variables, but non-blocking condvar use is ok. What this means is that you	796	condition variables, but non-blocking condvar use is ok. What this means
679	cannot use blocking APIs, but the non-blocking variant should work.	797	is that you cannot use blocking APIs, but the non-blocking variant should
		798	work.
680		799
681	=cut	800	=cut
682		801
683	our $VERSION = 1;	802	our $VERSION = 1;
684		803
…		…
761	$proxy->enable ($name => $ref);	880	$proxy->enable ($name => $ref);
762	}	881	}
763	}	882	}
764	}	883	}
765		884
		885	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		886
		887	Creates a new terminal, very similar as if you had started it with system
		888	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		889	hash which defines the environment of the new terminal.
		890
		891	Croaks (and probably outputs an error message) if the new instance
		892	couldn't be created. Returns C<undef> if the new instance didn't
		893	initialise perl, and the terminal object otherwise. The C<init> and
		894	C<start> hooks will be called during this call.
		895
		896	=cut
		897
		898	sub new {
		899	my ($class, $env, @args) = @_;
		900
		901	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		902	}
		903
766	=item $term->destroy	904	=item $term->destroy
767		905
768	Destroy the terminal object (close the window, free resources etc.).	906	Destroy the terminal object (close the window, free resources
		907	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		908	watchers (timers, io watchers) are still active.
769		909
770	=item $isset = $term->option ($optval[, $set])	910	=item $isset = $term->option ($optval[, $set])
771		911
772	Returns true if the option specified by C<$optval> is enabled, and	912	Returns true if the option specified by C<$optval> is enabled, and
773	optionally change it. All option values are stored by name in the hash	913	optionally change it. All option values are stored by name in the hash
…		…
823	my ($self, $name) = (shift, shift);	963	my ($self, $name) = (shift, shift);
824	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	964	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
825	&urxvt::term::_resource	965	&urxvt::term::_resource
826	}	966	}
827		967
		968	=item $value = $term->x_resource ($pattern)
		969
		970	Returns the X-Resource for the given pattern, excluding the program or
		971	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		972	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		973	resource with that pattern exists.
		974
		975	This method should only be called during the C<on_start> hook, as there is
		976	only one resource database per display, and later invocations might return
		977	the wrong resources.
		978
828	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	979	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
829		980
830	Adds a keymap translation exactly as specified via a resource. See the	981	Adds a keymap translation exactly as specified via a resource. See the
831	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	982	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
832		983
…		…
847	=item ($row, $col) = $term->selection_end ([$row, $col])	998	=item ($row, $col) = $term->selection_end ([$row, $col])
848		999
849	Return the current values of the selection mark, begin or end positions,	1000	Return the current values of the selection mark, begin or end positions,
850	and optionally set them to new values.	1001	and optionally set them to new values.
851		1002
		1003	=item $term->selection_make ($eventtime[, $rectangular])
		1004
		1005	Tries to make a selection as set by C<selection_beg> and
		1006	C<selection_end>. If C<$rectangular> is true (default: false), a
		1007	rectangular selection will be made. This is the prefered function to make
		1008	a selection.
		1009
852	=item $success = $term->selection_grab ($eventtime)	1010	=item $success = $term->selection_grab ($eventtime)
853		1011
854	Try to request the primary selection from the server (for example, as set	1012	Try to request the primary selection text from the server (for example, as
855	by the next method).	1013	set by the next method). No visual feedback will be given. This function
		1014	is mostly useful from within C<on_sel_grab> hooks.
856		1015
857	=item $oldtext = $term->selection ([$newtext])	1016	=item $oldtext = $term->selection ([$newtext])
858		1017
859	Return the current selection text and optionally replace it by C<$newtext>.	1018	Return the current selection text and optionally replace it by C<$newtext>.
860		1019
…		…
953	Convert the given locale-encoded octets into a perl string.	1112	Convert the given locale-encoded octets into a perl string.
954		1113
955	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1114	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
956		1115
957	XORs the rendition values in the given span with the provided value	1116	XORs the rendition values in the given span with the provided value
958	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1117	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
959	to the selection.	1118	refresh hooks to provide effects similar to the selection.
960		1119
961	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1120	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
962		1121
963	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1122	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
964	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1123	whitespace will additionally be xored with the C<$rstyle2>, which defaults
965	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1124	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
966	it instead.	1125	it instead. Both styles I<MUST NOT> contain font styles.
967		1126
968	=item $term->scr_bell	1127	=item $term->scr_bell
969		1128
970	Ring the bell!	1129	Ring the bell!
971		1130
…		…
1005		1164
1006	=item $windowid = $term->vt	1165	=item $windowid = $term->vt
1007		1166
1008	Return the window id of the terminal window.	1167	Return the window id of the terminal window.
1009		1168
		1169	=item $term->vt_emask_add ($x_event_mask)
		1170
		1171	Adds the specified events to the vt event mask. Useful e.g. when you want
		1172	to receive pointer events all the times:
		1173
		1174	$term->vt_emask_add (urxvt::PointerMotionMask);
		1175
1010	=item $window_width = $term->width	1176	=item $window_width = $term->width
1011		1177
1012	=item $window_height = $term->height	1178	=item $window_height = $term->height
1013		1179
1014	=item $font_width = $term->fwidth	1180	=item $font_width = $term->fwidth
…		…
1027		1193
1028	=item $max_scrollback = $term->saveLines	1194	=item $max_scrollback = $term->saveLines
1029		1195
1030	=item $nrow_plus_saveLines = $term->total_rows	1196	=item $nrow_plus_saveLines = $term->total_rows
1031		1197
1032	=item $lines_in_scrollback = $term->nsaved	1198	=item $topmost_scrollback_row = $term->top_row
1033		1199
1034	Return various integers describing terminal characteristics.	1200	Return various integers describing terminal characteristics.
1035		1201
		1202	=item $x_display = $term->display_id
		1203
		1204	Return the DISPLAY used by rxvt-unicode.
		1205
1036	=item $lc_ctype = $term->locale	1206	=item $lc_ctype = $term->locale
1037		1207
1038	Returns the LC_CTYPE category string used by this rxvt-unicode.	1208	Returns the LC_CTYPE category string used by this rxvt-unicode.
1039		1209
1040	=item $x_display = $term->display_id	1210	=item $env = $term->env
1041		1211
1042	Return the DISPLAY used by rxvt-unicode.	1212	Returns a copy of the environment in effect for the terminal as a hashref
		1213	similar to C<\%ENV>.
		1214
		1215	=cut
		1216
		1217	sub env {
		1218	if (my $env = $_[0]->_env) {
		1219	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1220	} else {
		1221	+{ %ENV }
		1222	}
		1223	}
1043		1224
1044	=item $modifiermask = $term->ModLevel3Mask	1225	=item $modifiermask = $term->ModLevel3Mask
1045		1226
1046	=item $modifiermask = $term->ModMetaMask	1227	=item $modifiermask = $term->ModMetaMask
1047		1228
…		…
1050	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1231	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1051	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1232	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1052		1233
1053	=item $view_start = $term->view_start ([$newvalue])	1234	=item $view_start = $term->view_start ([$newvalue])
1054		1235
1055	Returns the negative row number of the topmost line. Minimum value is	1236	Returns the row number of the topmost displayed line. Maximum value is
1056	C<0>, which displays the normal terminal contents. Larger values scroll	1237	C<0>, which displays the normal terminal contents. Lower values scroll
1057	this many lines into the scrollback buffer.	1238	this many lines into the scrollback buffer.
1058		1239
1059	=item $term->want_refresh	1240	=item $term->want_refresh
1060		1241
1061	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1242	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1140	Return the row number of the first/last row of the line, respectively.	1321	Return the row number of the first/last row of the line, respectively.
1141		1322
1142	=item $offset = $line->offset_of ($row, $col)	1323	=item $offset = $line->offset_of ($row, $col)
1143		1324
1144	Returns the character offset of the given row\|col pair within the logical	1325	Returns the character offset of the given row\|col pair within the logical
1145	line.	1326	line. Works for rows outside the line, too, and returns corresponding
		1327	offsets outside the string.
1146		1328
1147	=item ($row, $col) = $line->coord_of ($offset)	1329	=item ($row, $col) = $line->coord_of ($offset)
1148		1330
1149	Translates a string offset into terminal coordinates again.	1331	Translates a string offset into terminal coordinates again.
1150		1332
…		…
1287	$item->{render} \|\|= sub { $_[0]{text} };	1469	$item->{render} \|\|= sub { $_[0]{text} };
1288		1470
1289	push @{ $self->{item} }, $item;	1471	push @{ $self->{item} }, $item;
1290	}	1472	}
1291		1473
		1474	=item $popup->add_title ($title)
		1475
		1476	Adds a non-clickable title to the popup.
		1477
		1478	=cut
		1479
		1480	sub add_title {
		1481	my ($self, $title) = @_;
		1482
		1483	$self->add_item ({
		1484	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1485	text => $title,
		1486	activate => sub { },
		1487	});
		1488	}
		1489
		1490	=item $popup->add_separator ([$sepchr])
		1491
		1492	Creates a separator, optionally using the character given as C<$sepchr>.
		1493
		1494	=cut
		1495
1292	sub add_separator {	1496	sub add_separator {
1293	my ($self, $sep) = @_;	1497	my ($self, $sep) = @_;
1294		1498
1295	$sep \|\|= "=";	1499	$sep \|\|= "=";
1296		1500
…		…
1300	render => sub { $sep x $self->{term}->ncol },	1504	render => sub { $sep x $self->{term}->ncol },
1301	activate => sub { },	1505	activate => sub { },
1302	});	1506	});
1303	}	1507	}
1304		1508
1305	sub add_title {	1509	=item $popup->add_button ($text, $cb)
1306	my ($self, $title) = @_;
1307		1510
1308	$self->add_item ({	1511	Adds a clickable button to the popup. C<$cb> is called whenever it is
1309	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1512	selected.
1310	text => $title,	1513
1311	activate => sub { },	1514	=cut
1312	});
1313	}
1314		1515
1315	sub add_button {	1516	sub add_button {
1316	my ($self, $text, $cb) = @_;	1517	my ($self, $text, $cb) = @_;
1317		1518
1318	$self->add_item ({ type => "button", text => $text, activate => $cb});	1519	$self->add_item ({ type => "button", text => $text, activate => $cb});
1319	}	1520	}
		1521
		1522	=item $popup->add_toggle ($text, $cb, $initial_value)
		1523
		1524	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1525	whenever it gets toggled, with a boolean indicating its value as its first
		1526	argument.
		1527
		1528	=cut
1320		1529
1321	sub add_toggle {	1530	sub add_toggle {
1322	my ($self, $text, $cb, $value) = @_;	1531	my ($self, $text, $cb, $value) = @_;
1323		1532
1324	my $item; $item = {	1533	my $item; $item = {
1325	type => "button",	1534	type => "button",
1326	text => " $text",	1535	text => " $text",
1327	value => $value,	1536	value => $value,
1328	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1537	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1329	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1538	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1330	};	1539	};
1331		1540
1332	$self->add_item ($item);	1541	$self->add_item ($item);
1333	}	1542	}
		1543
		1544	=item $popup->show
		1545
		1546	Displays the popup (which is initially hidden).
		1547
		1548	=cut
1334		1549
1335	sub show {	1550	sub show {
1336	my ($self) = @_;	1551	my ($self) = @_;
1337		1552
1338	local $urxvt::popup::self = $self;	1553	local $urxvt::popup::self = $self;
1339		1554
		1555	my $env = $self->{term}->env;
		1556	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1557	delete $env->{LC_ALL};
1340	local $ENV{LC_ALL} = $self->{term}->locale;	1558	$env->{LC_CTYPE} = $self->{term}->locale;
1341		1559
		1560	urxvt::term->new ($env, $self->{term}->resource ("name"),
1342	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1561	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1343	"--transient-for" => $self->{term}->parent,	1562	"--transient-for" => $self->{term}->parent,
1344	"-display" => $self->{term}->display_id,	1563	"-display" => $self->{term}->display_id,
1345	"-pe" => "urxvt-popup")	1564	"-pe" => "urxvt-popup")
1346	or die "unable to create popup window\n";	1565	or die "unable to create popup window\n";
1347	}	1566	}
1348		1567
1349	sub DESTROY {	1568	sub DESTROY {
1350	my ($self) = @_;	1569	my ($self) = @_;
1351		1570
1352	delete $self->{term}{_destroy}{$self};	1571	delete $self->{term}{_destroy}{$self};
1353	$self->{term}->ungrab;	1572	$self->{term}->ungrab;
1354	}	1573	}
		1574
		1575	=back
1355		1576
1356	=head2 The C<urxvt::timer> Class	1577	=head2 The C<urxvt::timer> Class
1357		1578
1358	This class implements timer watchers/events. Time is represented as a	1579	This class implements timer watchers/events. Time is represented as a
1359	fractional number of seconds since the epoch. Example:	1580	fractional number of seconds since the epoch. Example:
…		…
1466		1687
1467	=item == 0 - fatal messages	1688	=item == 0 - fatal messages
1468		1689
1469	=item >= 3 - script loading and management	1690	=item >= 3 - script loading and management
1470		1691
1471	=item >=10 - all events received	1692	=item >=10 - all called hooks
		1693
		1694	=item >=11 - hook reutrn values
1472		1695
1473	=back	1696	=back
1474		1697
1475	=head1 AUTHOR	1698	=head1 AUTHOR
1476		1699

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs. Revision 1.97 by elmex, Tue Jan 17 16:53:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.97 by elmex, Tue Jan 17 16:53:47 2006 UTC