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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.101 by root, Wed Jan 18 10:11:03 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
		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
71	=item searchable-scrollback (enabled by default)	112	=item searchable-scrollback<hotkey> (enabled by default)
72		113
73	Adds regex search functionality to the scrollback buffer, triggered by a	114	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	115	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,	116	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	117	screen.
77	current position and C<escape> returns to the original position.
78		118
79	=item digital-clock	119	Inputting characters appends them to the regex and continues incremental
		120	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		121	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		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.
80		126
81	Displays a digital clock using the built-in overlay.	127	=item selection-autotransform
		128
		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.
82		161
83	=item mark-urls	162	=item mark-urls
84		163
85	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.
86		168
87	=item block-graphics-to-ascii	169	=item block-graphics-to-ascii
88		170
89	A not very useful example of filtering all text output to the terminal,	171	A not very useful example of filtering all text output to the terminal,
90	by replacing all line-drawing characters (U+2500 .. U+259F) by a	172	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	173	similar-looking ascii character.
92		174
		175	=item digital-clock
		176
		177	Displays a digital clock using the built-in overlay.
		178
93	=item example-refresh-hooks	179	=item example-refresh-hooks
94		180
95	Displays a very simple digital clock in the upper right corner of the	181	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	182	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	183	overlays or changes.
98		184
		185	=item selection-pastebin
		186
		187	This is a little rarely useful extension that Uploads the selection as
		188	textfile to a remote site (or does other things). (The implementation is
		189	not currently secure for use in a multiuser environment as it writes to
		190	F</tmp> directly.).
		191
		192	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		193	i.e.
		194
		195	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		196
		197	Pressing this combination runs a command with C<%> replaced by the name of
		198	the textfile. This command can be set via a resource:
		199
		200	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		201
		202	And the default is likely not useful to anybody but the few people around
		203	here :)
		204
		205	The name of the textfile is the hex encoded md5 sum of the selection, so
		206	the same content should lead to the same filename.
		207
		208	After a successful upload the selection will be replaced by the text given
		209	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		210	for the filename):
		211
		212	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		213
99	=back	214	=back
		215
		216	=head1 API DOCUMENTATION
100		217
101	=head2 General API Considerations	218	=head2 General API Considerations
102		219
103	All objects (such as terminals, time watchers etc.) are typical	220	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	221	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	234	=over 4
118		235
119	=item $text	236	=item $text
120		237
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	238	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.	239	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		240
124	=item $string	241	=item $string
125		242
126	A perl text string, with an emphasis on I<text>. It can store all unicode	243	A perl text string, with an emphasis on I<text>. It can store all unicode
127	characters and is to be distinguished with text encoded in a specific	244	characters and is to be distinguished with text encoded in a specific
…		…
222	=item on_sel_extend $term	339	=item on_sel_extend $term
223		340
224	Called whenever the user tries to extend the selection (e.g. with a double	341	Called whenever the user tries to extend the selection (e.g. with a double
225	click) and is either supposed to return false (normal operation), or	342	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	343	should extend the selection itelf and return true to suppress the built-in
227	processing.	344	processing. This can happen multiple times, as long as the callback
		345	returns true, it will be called on every further click by the user and is
		346	supposed to enlarge the selection more and more, if possible.
228		347
229	See the F<selection> example extension.	348	See the F<selection> example extension.
230		349
231	=item on_view_change $term, $offset	350	=item on_view_change $term, $offset
232		351
…		…
299		418
300	Called whenever the user presses a key combination that has a	419	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>	420	C<perl:string> action bound to it (see description of the B<keysym>
302	resource in the @@RXVT_NAME@@(1) manpage).	421	resource in the @@RXVT_NAME@@(1) manpage).
303		422
		423	=item on_x_event $term, $event
		424
		425	Called on every X event received on the vt window (and possibly other
		426	windows). Should only be used as a last resort. Most event structure
		427	members are not passed.
		428
304	=item on_focus_in $term	429	=item on_focus_in $term
305		430
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	431	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	432	does focus in processing.
308		433
…		…
334		459
335	C<on_key_press> additionally receives the string rxvt-unicode would	460	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	461	output, if any, in locale-specific encoding.
337		462
338	subwindow.	463	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		464
450	=back	465	=back
451		466
452	=cut	467	=cut
453		468
…		…
462	our $VERSION = 1;	477	our $VERSION = 1;
463	our $TERM;	478	our $TERM;
464	our @HOOKNAME;	479	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	480	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;	481	our %OPTION;
		482
467	our $LIBDIR;	483	our $LIBDIR;
		484	our $RESNAME;
		485	our $RESCLASS;
		486	our $RXVTNAME;
		487
		488	=head2 Variables in the C<urxvt> Package
		489
		490	=over 4
		491
		492	=item $urxvt::LIBDIR
		493
		494	The rxvt-unicode library directory, where, among other things, the perl
		495	modules and scripts are stored.
		496
		497	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		498
		499	The resource class and name rxvt-unicode uses to look up X resources.
		500
		501	=item $urxvt::RXVTNAME
		502
		503	The basename of the installed binaries, usually C<urxvt>.
		504
		505	=item $urxvt::TERM
		506
		507	The current terminal. This variable stores the current C<urxvt::term>
		508	object, whenever a callback/hook is executing.
		509
		510	=back
		511
		512	=head2 Functions in the C<urxvt> Package
		513
		514	=over 4
		515
		516	=item urxvt::fatal $errormessage
		517
		518	Fatally aborts execution with the given error message. Avoid at all
		519	costs! The only time this is acceptable is when the terminal process
		520	starts up.
		521
		522	=item urxvt::warn $string
		523
		524	Calls C<rxvt_warn> with the given string which should not include a
		525	newline. The module also overwrites the C<warn> builtin with a function
		526	that calls this function.
		527
		528	Using this function has the advantage that its output ends up in the
		529	correct place, e.g. on stderr of the connecting urxvtc client.
		530
		531	Messages have a size limit of 1023 bytes currently.
		532
		533	=item $time = urxvt::NOW
		534
		535	Returns the "current time" (as per the event loop).
		536
		537	=item urxvt::CurrentTime
		538
		539	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		540	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		541	Button4Mask, Button5Mask, AnyModifier
		542
		543	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		544	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		545	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		546	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		547	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		548	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		549	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		550
		551	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		552	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		553	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		554	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		555	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		556	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		557	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		558
		559	Various constants for use in X calls and event processing.
		560
		561	=back
		562
		563	=head2 RENDITION
		564
		565	Rendition bitsets contain information about colour, font, font styles and
		566	similar information for each screen cell.
		567
		568	The following "macros" deal with changes in rendition sets. You should
		569	never just create a bitset, you should always modify an existing one,
		570	as they contain important information required for correct operation of
		571	rxvt-unicode.
		572
		573	=over 4
		574
		575	=item $rend = urxvt::DEFAULT_RSTYLE
		576
		577	Returns the default rendition, as used when the terminal is starting up or
		578	being reset. Useful as a base to start when creating renditions.
		579
		580	=item $rend = urxvt::OVERLAY_RSTYLE
		581
		582	Return the rendition mask used for overlays by default.
		583
		584	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		585
		586	Return the bit that enabled bold, italic, blink, reverse-video and
		587	underline, respectively. To enable such a style, just logically OR it into
		588	the bitset.
		589
		590	=item $foreground = urxvt::GET_BASEFG $rend
		591
		592	=item $background = urxvt::GET_BASEBG $rend
		593
		594	Return the foreground/background colour index, respectively.
		595
		596	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		597
		598	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		599
		600	Replace the foreground/background colour in the rendition mask with the
		601	specified one.
		602
		603	=item $value = urxvt::GET_CUSTOM $rend
		604
		605	Return the "custom" value: Every rendition has 5 bits for use by
		606	extensions. They can be set and changed as you like and are initially
		607	zero.
		608
		609	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		610
		611	Change the custom value.
		612
		613	=back
		614
		615	=cut
468		616
469	BEGIN {	617	BEGIN {
470	urxvt->bootstrap;
471
472	# overwrite perl's warn	618	# overwrite perl's warn
473	*CORE::GLOBAL::warn = sub {	619	*CORE::GLOBAL::warn = sub {
474	my $msg = join "", @_;	620	my $msg = join "", @_;
475	$msg .= "\n"	621	$msg .= "\n"
476	unless $msg =~ /\n$/;	622	unless $msg =~ /\n$/;
477	urxvt::warn ($msg);	623	urxvt::warn ($msg);
478	};	624	};
479		625
		626	# %ENV is the original startup environment
480	delete $ENV{IFS};	627	delete $ENV{IFS};
481	delete $ENV{CDPATH};	628	delete $ENV{CDPATH};
482	delete $ENV{BASH_ENV};	629	delete $ENV{BASH_ENV};
483	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	630	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
484	}	631	}
485		632
486	my @hook_count;
487	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	633	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
488		634
489	sub verbose {	635	sub verbose {
490	my ($level, $msg) = @_;	636	my ($level, $msg) = @_;
491	warn "$msg\n" if $level <= $verbosity;	637	warn "$msg\n" if $level <= $verbosity;
492	}	638	}
493		639
494	my $extension_pkg = "extension0000";
495	my %extension_pkg;	640	my %extension_pkg;
496		641
497	# load a single script into its own package, once only	642	# load a single script into its own package, once only
498	sub extension_package($) {	643	sub extension_package($) {
499	my ($path) = @_;	644	my ($path) = @_;
500		645
		646	no strict 'refs';
		647
501	$extension_pkg{$path} \|\|= do {	648	$extension_pkg{$path} \|\|= do {
502	my $pkg = "urxvt::" . ($extension_pkg++);	649	$path =~ /([^\/\\]+)$/;
		650	my $pkg = $1;
		651	$pkg =~ s/[^[:word:]]/_/g;
		652	$pkg = "urxvt::ext::$pkg";
503		653
504	verbose 3, "loading extension '$path' into package '$pkg'";	654	verbose 3, "loading extension '$path' into package '$pkg'";
505		655
506	open my $fh, "<:raw", $path	656	open my $fh, "<:raw", $path
507	or die "$path: $!";	657	or die "$path: $!";
508		658
		659	@{"$pkg\::ISA"} = urxvt::term::extension::;
		660
509	my $source = untaint	661	my $source =
510	"package $pkg; use strict; use utf8;\n"	662	"package $pkg; use strict; use utf8;\n"
511	. "use base urxvt::term::extension::;\n"
512	. "#line 1 \"$path\"\n{\n"	663	. "#line 1 \"$path\"\n{\n"
513	. (do { local $/; <$fh> })	664	. (do { local $/; <$fh> })
514	. "\n};\n1";	665	. "\n};\n1";
515		666
516	eval $source	667	eval $source
…		…
573	if ($@) {	724	if ($@) {
574	$TERM->ungrab; # better to lose the grab than the session	725	$TERM->ungrab; # better to lose the grab than the session
575	warn $@;	726	warn $@;
576	}	727	}
577	}	728	}
		729
		730	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		731	if $verbosity >= 11;
578	}	732	}
579		733
580	if ($htype == 1) { # DESTROY	734	if ($htype == 1) { # DESTROY
581	if (my $hook = delete $TERM->{_hook}) {
582	for my $htype (0..$#$hook) {
583	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
584	or set_should_invoke $htype, 0;
585	}
586	}
587
588	# clear package objects	735	# clear package objects
589	%$_ = () for values %{ $TERM->{_pkg} };	736	%$_ = () for values %{ $TERM->{_pkg} };
590		737
591	# clear package	738	# clear package
592	%$TERM = ();	739	%$TERM = ();
593	}	740	}
594		741
595	$retval	742	$retval
		743	}
		744
		745	sub exec_async(@) {
		746	my $pid = fork;
		747
		748	return
		749	if !defined $pid or $pid;
		750
		751	%ENV = %{ $TERM->env };
		752
		753	exec @_;
		754	_exit 255;
596	}	755	}
597		756
598	# urxvt::term::extension	757	# urxvt::term::extension
599		758
600	package urxvt::term::extension;	759	package urxvt::term::extension;
…		…
606	while (my ($name, $cb) = each %hook) {	765	while (my ($name, $cb) = each %hook) {
607	my $htype = $HOOKTYPE{uc $name};	766	my $htype = $HOOKTYPE{uc $name};
608	defined $htype	767	defined $htype
609	or Carp::croak "unsupported hook type '$name'";	768	or Carp::croak "unsupported hook type '$name'";
610		769
		770	$self->set_should_invoke ($htype, +1)
611	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	771	unless exists $self->{term}{_hook}[$htype]{$pkg};
612	$hook_count[$htype]++
613	or urxvt::set_should_invoke $htype, 1;
614	}
615		772
616	$self->{term}{_hook}[$htype]{$pkg} = $cb;	773	$self->{term}{_hook}[$htype]{$pkg} = $cb;
617	}	774	}
618	}	775	}
619		776
…		…
624	for my $name (@hook) {	781	for my $name (@hook) {
625	my $htype = $HOOKTYPE{uc $name};	782	my $htype = $HOOKTYPE{uc $name};
626	defined $htype	783	defined $htype
627	or Carp::croak "unsupported hook type '$name'";	784	or Carp::croak "unsupported hook type '$name'";
628		785
		786	$self->set_should_invoke ($htype, -1)
629	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	787	if delete $self->{term}{_hook}[$htype]{$pkg};
630	--$hook_count[$htype]
631	or urxvt::set_should_invoke $htype, 0;
632	}
633	}	788	}
634	}	789	}
635		790
636	our $AUTOLOAD;	791	our $AUTOLOAD;
637		792
…		…
668		823
669	=head2 The C<urxvt::anyevent> Class	824	=head2 The C<urxvt::anyevent> Class
670		825
671	The sole purpose of this class is to deliver an interface to the	826	The sole purpose of this class is to deliver an interface to the
672	C<AnyEvent> module - any module using it will work inside urxvt without	827	C<AnyEvent> module - any module using it will work inside urxvt without
673	further work. The only exception is that you cannot wait on condition	828	further programming. The only exception is that you cannot wait on
674	variables, but non-blocking condvar use is ok. What this means is that you	829	condition variables, but non-blocking condvar use is ok. What this means
675	cannot use blocking APIs, but the non-blocking variant should work.	830	is that you cannot use blocking APIs, but the non-blocking variant should
		831	work.
676		832
677	=cut	833	=cut
678		834
679	our $VERSION = 1;	835	our $VERSION = 1;
680		836
…		…
757	$proxy->enable ($name => $ref);	913	$proxy->enable ($name => $ref);
758	}	914	}
759	}	915	}
760	}	916	}
761		917
		918	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		919
		920	Creates a new terminal, very similar as if you had started it with system
		921	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		922	hash which defines the environment of the new terminal.
		923
		924	Croaks (and probably outputs an error message) if the new instance
		925	couldn't be created. Returns C<undef> if the new instance didn't
		926	initialise perl, and the terminal object otherwise. The C<init> and
		927	C<start> hooks will be called during this call.
		928
		929	=cut
		930
		931	sub new {
		932	my ($class, $env, @args) = @_;
		933
		934	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		935	}
		936
762	=item $term->destroy	937	=item $term->destroy
763		938
764	Destroy the terminal object (close the window, free resources etc.).	939	Destroy the terminal object (close the window, free resources
		940	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		941	watchers (timers, io watchers) are still active.
765		942
766	=item $isset = $term->option ($optval[, $set])	943	=item $isset = $term->option ($optval[, $set])
767		944
768	Returns true if the option specified by C<$optval> is enabled, and	945	Returns true if the option specified by C<$optval> is enabled, and
769	optionally change it. All option values are stored by name in the hash	946	optionally change it. All option values are stored by name in the hash
…		…
819	my ($self, $name) = (shift, shift);	996	my ($self, $name) = (shift, shift);
820	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	997	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
821	&urxvt::term::_resource	998	&urxvt::term::_resource
822	}	999	}
823		1000
		1001	=item $value = $term->x_resource ($pattern)
		1002
		1003	Returns the X-Resource for the given pattern, excluding the program or
		1004	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1005	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1006	resource with that pattern exists.
		1007
		1008	This method should only be called during the C<on_start> hook, as there is
		1009	only one resource database per display, and later invocations might return
		1010	the wrong resources.
		1011
824	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1012	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
825		1013
826	Adds a keymap translation exactly as specified via a resource. See the	1014	Adds a keymap translation exactly as specified via a resource. See the
827	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1015	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
828		1016
…		…
843	=item ($row, $col) = $term->selection_end ([$row, $col])	1031	=item ($row, $col) = $term->selection_end ([$row, $col])
844		1032
845	Return the current values of the selection mark, begin or end positions,	1033	Return the current values of the selection mark, begin or end positions,
846	and optionally set them to new values.	1034	and optionally set them to new values.
847		1035
		1036	=item $term->selection_make ($eventtime[, $rectangular])
		1037
		1038	Tries to make a selection as set by C<selection_beg> and
		1039	C<selection_end>. If C<$rectangular> is true (default: false), a
		1040	rectangular selection will be made. This is the prefered function to make
		1041	a selection.
		1042
848	=item $success = $term->selection_grab ($eventtime)	1043	=item $success = $term->selection_grab ($eventtime)
849		1044
850	Try to request the primary selection from the server (for example, as set	1045	Try to request the primary selection text from the server (for example, as
851	by the next method).	1046	set by the next method). No visual feedback will be given. This function
		1047	is mostly useful from within C<on_sel_grab> hooks.
852		1048
853	=item $oldtext = $term->selection ([$newtext])	1049	=item $oldtext = $term->selection ([$newtext])
854		1050
855	Return the current selection text and optionally replace it by C<$newtext>.	1051	Return the current selection text and optionally replace it by C<$newtext>.
856		1052
…		…
949	Convert the given locale-encoded octets into a perl string.	1145	Convert the given locale-encoded octets into a perl string.
950		1146
951	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1147	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
952		1148
953	XORs the rendition values in the given span with the provided value	1149	XORs the rendition values in the given span with the provided value
954	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1150	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
955	to the selection.	1151	refresh hooks to provide effects similar to the selection.
956		1152
957	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1153	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
958		1154
959	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1155	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
960	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1156	whitespace will additionally be xored with the C<$rstyle2>, which defaults
961	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1157	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
962	it instead.	1158	it instead. Both styles I<MUST NOT> contain font styles.
963		1159
964	=item $term->scr_bell	1160	=item $term->scr_bell
965		1161
966	Ring the bell!	1162	Ring the bell!
967		1163
…		…
1001		1197
1002	=item $windowid = $term->vt	1198	=item $windowid = $term->vt
1003		1199
1004	Return the window id of the terminal window.	1200	Return the window id of the terminal window.
1005		1201
		1202	=item $term->vt_emask_add ($x_event_mask)
		1203
		1204	Adds the specified events to the vt event mask. Useful e.g. when you want
		1205	to receive pointer events all the times:
		1206
		1207	$term->vt_emask_add (urxvt::PointerMotionMask);
		1208
1006	=item $window_width = $term->width	1209	=item $window_width = $term->width
1007		1210
1008	=item $window_height = $term->height	1211	=item $window_height = $term->height
1009		1212
1010	=item $font_width = $term->fwidth	1213	=item $font_width = $term->fwidth
…		…
1023		1226
1024	=item $max_scrollback = $term->saveLines	1227	=item $max_scrollback = $term->saveLines
1025		1228
1026	=item $nrow_plus_saveLines = $term->total_rows	1229	=item $nrow_plus_saveLines = $term->total_rows
1027		1230
1028	=item $lines_in_scrollback = $term->nsaved	1231	=item $topmost_scrollback_row = $term->top_row
1029		1232
1030	Return various integers describing terminal characteristics.	1233	Return various integers describing terminal characteristics.
1031		1234
		1235	=item $x_display = $term->display_id
		1236
		1237	Return the DISPLAY used by rxvt-unicode.
		1238
1032	=item $lc_ctype = $term->locale	1239	=item $lc_ctype = $term->locale
1033		1240
1034	Returns the LC_CTYPE category string used by this rxvt-unicode.	1241	Returns the LC_CTYPE category string used by this rxvt-unicode.
1035		1242
1036	=item $x_display = $term->display_id	1243	=item $env = $term->env
1037		1244
1038	Return the DISPLAY used by rxvt-unicode.	1245	Returns a copy of the environment in effect for the terminal as a hashref
		1246	similar to C<\%ENV>.
		1247
		1248	=cut
		1249
		1250	sub env {
		1251	if (my $env = $_[0]->_env) {
		1252	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1253	} else {
		1254	+{ %ENV }
		1255	}
		1256	}
1039		1257
1040	=item $modifiermask = $term->ModLevel3Mask	1258	=item $modifiermask = $term->ModLevel3Mask
1041		1259
1042	=item $modifiermask = $term->ModMetaMask	1260	=item $modifiermask = $term->ModMetaMask
1043		1261
…		…
1046	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1264	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1047	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1265	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1048		1266
1049	=item $view_start = $term->view_start ([$newvalue])	1267	=item $view_start = $term->view_start ([$newvalue])
1050		1268
1051	Returns the negative row number of the topmost line. Minimum value is	1269	Returns the row number of the topmost displayed line. Maximum value is
1052	C<0>, which displays the normal terminal contents. Larger values scroll	1270	C<0>, which displays the normal terminal contents. Lower values scroll
1053	this many lines into the scrollback buffer.	1271	this many lines into the scrollback buffer.
1054		1272
1055	=item $term->want_refresh	1273	=item $term->want_refresh
1056		1274
1057	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1275	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1136	Return the row number of the first/last row of the line, respectively.	1354	Return the row number of the first/last row of the line, respectively.
1137		1355
1138	=item $offset = $line->offset_of ($row, $col)	1356	=item $offset = $line->offset_of ($row, $col)
1139		1357
1140	Returns the character offset of the given row\|col pair within the logical	1358	Returns the character offset of the given row\|col pair within the logical
1141	line.	1359	line. Works for rows outside the line, too, and returns corresponding
		1360	offsets outside the string.
1142		1361
1143	=item ($row, $col) = $line->coord_of ($offset)	1362	=item ($row, $col) = $line->coord_of ($offset)
1144		1363
1145	Translates a string offset into terminal coordinates again.	1364	Translates a string offset into terminal coordinates again.
1146		1365
…		…
1283	$item->{render} \|\|= sub { $_[0]{text} };	1502	$item->{render} \|\|= sub { $_[0]{text} };
1284		1503
1285	push @{ $self->{item} }, $item;	1504	push @{ $self->{item} }, $item;
1286	}	1505	}
1287		1506
		1507	=item $popup->add_title ($title)
		1508
		1509	Adds a non-clickable title to the popup.
		1510
		1511	=cut
		1512
		1513	sub add_title {
		1514	my ($self, $title) = @_;
		1515
		1516	$self->add_item ({
		1517	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1518	text => $title,
		1519	activate => sub { },
		1520	});
		1521	}
		1522
		1523	=item $popup->add_separator ([$sepchr])
		1524
		1525	Creates a separator, optionally using the character given as C<$sepchr>.
		1526
		1527	=cut
		1528
1288	sub add_separator {	1529	sub add_separator {
1289	my ($self, $sep) = @_;	1530	my ($self, $sep) = @_;
1290		1531
1291	$sep \|\|= "=";	1532	$sep \|\|= "=";
1292		1533
…		…
1296	render => sub { $sep x $self->{term}->ncol },	1537	render => sub { $sep x $self->{term}->ncol },
1297	activate => sub { },	1538	activate => sub { },
1298	});	1539	});
1299	}	1540	}
1300		1541
1301	sub add_title {	1542	=item $popup->add_button ($text, $cb)
1302	my ($self, $title) = @_;
1303		1543
1304	$self->add_item ({	1544	Adds a clickable button to the popup. C<$cb> is called whenever it is
1305	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1545	selected.
1306	text => $title,	1546
1307	activate => sub { },	1547	=cut
1308	});
1309	}
1310		1548
1311	sub add_button {	1549	sub add_button {
1312	my ($self, $text, $cb) = @_;	1550	my ($self, $text, $cb) = @_;
1313		1551
1314	$self->add_item ({ type => "button", text => $text, activate => $cb});	1552	$self->add_item ({ type => "button", text => $text, activate => $cb});
1315	}	1553	}
		1554
		1555	=item $popup->add_toggle ($text, $cb, $initial_value)
		1556
		1557	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1558	whenever it gets toggled, with a boolean indicating its value as its first
		1559	argument.
		1560
		1561	=cut
1316		1562
1317	sub add_toggle {	1563	sub add_toggle {
1318	my ($self, $text, $cb, $value) = @_;	1564	my ($self, $text, $cb, $value) = @_;
1319		1565
1320	my $item; $item = {	1566	my $item; $item = {
1321	type => "button",	1567	type => "button",
1322	text => " $text",	1568	text => " $text",
1323	value => $value,	1569	value => $value,
1324	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1570	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1325	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1571	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1326	};	1572	};
1327		1573
1328	$self->add_item ($item);	1574	$self->add_item ($item);
1329	}	1575	}
		1576
		1577	=item $popup->show
		1578
		1579	Displays the popup (which is initially hidden).
		1580
		1581	=cut
1330		1582
1331	sub show {	1583	sub show {
1332	my ($self) = @_;	1584	my ($self) = @_;
1333		1585
1334	local $urxvt::popup::self = $self;	1586	local $urxvt::popup::self = $self;
1335		1587
		1588	my $env = $self->{term}->env;
		1589	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1590	delete $env->{LC_ALL};
1336	local $ENV{LC_ALL} = $self->{term}->locale;	1591	$env->{LC_CTYPE} = $self->{term}->locale;
1337		1592
		1593	urxvt::term->new ($env, $self->{term}->resource ("name"),
1338	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1594	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1339	"--transient-for" => $self->{term}->parent,	1595	"--transient-for" => $self->{term}->parent,
1340	"-display" => $self->{term}->display_id,	1596	"-display" => $self->{term}->display_id,
1341	"-pe" => "urxvt-popup")	1597	"-pe" => "urxvt-popup")
1342	or die "unable to create popup window\n";	1598	or die "unable to create popup window\n";
1343	}	1599	}
1344		1600
1345	sub DESTROY {	1601	sub DESTROY {
1346	my ($self) = @_;	1602	my ($self) = @_;
1347		1603
1348	delete $self->{term}{_destroy}{$self};	1604	delete $self->{term}{_destroy}{$self};
1349	$self->{term}->ungrab;	1605	$self->{term}->ungrab;
1350	}	1606	}
		1607
		1608	=back
1351		1609
1352	=head2 The C<urxvt::timer> Class	1610	=head2 The C<urxvt::timer> Class
1353		1611
1354	This class implements timer watchers/events. Time is represented as a	1612	This class implements timer watchers/events. Time is represented as a
1355	fractional number of seconds since the epoch. Example:	1613	fractional number of seconds since the epoch. Example:
…		…
1462		1720
1463	=item == 0 - fatal messages	1721	=item == 0 - fatal messages
1464		1722
1465	=item >= 3 - script loading and management	1723	=item >= 3 - script loading and management
1466		1724
1467	=item >=10 - all events received	1725	=item >=10 - all called hooks
		1726
		1727	=item >=11 - hook reutrn values
1468		1728
1469	=back	1729	=back
1470		1730
1471	=head1 AUTHOR	1731	=head1 AUTHOR
1472		1732

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs. Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.101 by root, Wed Jan 18 10:11:03 2006 UTC