[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.95 by elmex, Tue Jan 17 13:19:45 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
55	Rot-13 the selection when activated. Used via keyboard trigger:	77	Rot-13 the selection when activated. Used via keyboard trigger:
56		78
57	URxvt.keysym.C-M-r: perl:selection:rot13	79	URxvt.keysym.C-M-r: perl:selection:rot13
		80
		81	=item remote-pastebin
		82
		83	Upload the selection as textfile to a remote site.
		84
		85	URxvt.keysym.C-M-e: perl:selection:remote-pastebin
		86
		87	To set the command to upload the file set this resource:
		88
		89	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		90
		91	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
		92	md5 sum of the selection.
		93	After an successful upload the selection will be replaced by the following url
		94	(the % is the placeholder for the filename):
		95
		96	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
58		97
59	=back	98	=back
60		99
61	=item option-popup (enabled by default)	100	=item option-popup (enabled by default)
62		101
…		…
64	runtime.	103	runtime.
65		104
66	=item selection-popup (enabled by default)	105	=item selection-popup (enabled by default)
67		106
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	107	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	108	text into various other formats/action (such as uri unescaping, perl
		109	evalution, web-browser starting etc.), depending on content.
70		110
71	=item searchable-scrollback (enabled by default)	111	=item searchable-scrollback<hotkey> (enabled by default)
72		112
73	Adds regex search functionality to the scrollback buffer, triggered by a	113	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	114	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,	115	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	116	screen.
77	current position and C<escape> returns to the original position.
78		117
79	=item digital-clock	118	Inputting characters appends them to the regex and continues incremental
		119	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		120	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		121	bottom. C<Escape> leaves search mode and returns to the point where search
		122	was started, while C<Enter> or C<Return> stay at the current position and
		123	additionally stores the first match in the current line into the primary
		124	selection.
80		125
81	Displays a digital clock using the built-in overlay.	126	=item selection-autotransform
		127
		128	This selection allows you to do automatic transforms on a selection
		129	whenever a selection is made.
		130
		131	It works by specifying perl snippets (most useful is a single C<s///>
		132	operator) that modify C<$_> as resources:
		133
		134	URxvt.selection-autotransform.0: transform
		135	URxvt.selection-autotransform.1: transform
		136	...
		137
		138	For example, the following will transform selections of the form
		139	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		140	$word>:
		141
		142	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		143
		144	And this example matches the same,but replaces it with vi-commands you can
		145	paste directly into your (vi :) editor:
		146
		147	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		148
		149	Of course, this can be modified to suit your needs and your editor :)
		150
		151	To expand the example above to typical perl error messages ("XXX at
		152	FILENAME line YYY."), you need a slightly more elaborate solution:
		153
		154	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		155	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		156
		157	The first line tells the selection code to treat the unchanging part of
		158	every error message as a selection pattern, and the second line transforms
		159	the message into vi commands to load the file.
82		160
83	=item mark-urls	161	=item mark-urls
84		162
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	163	Uses per-line display filtering (C<on_line_update>) to underline urls and
		164	make them clickable. When middle-clicked, the program specified in the
		165	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		166	the URL as first argument.
86		167
87	=item block-graphics-to-ascii	168	=item block-graphics-to-ascii
88		169
89	A not very useful example of filtering all text output to the terminal,	170	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	171	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	172	similar-looking ascii character.
92		173
		174	=item digital-clock
		175
		176	Displays a digital clock using the built-in overlay.
		177
93	=item example-refresh-hooks	178	=item example-refresh-hooks
94		179
95	Displays a very simple digital clock in the upper right corner of the	180	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	181	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	182	overlays or changes.
98		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 $is_safe = urxvt::safe
		504
		505	Returns true when it is safe to do potentially unsafe things, such as
		506	evaluating perl code specified by the user. This is true when urxvt was
		507	started setuid or setgid.
		508
		509	=item $time = urxvt::NOW
		510
		511	Returns the "current time" (as per the event loop).
		512
		513	=item urxvt::CurrentTime
		514
		515	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		516	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		517	Button4Mask, Button5Mask, AnyModifier
		518
		519	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		520	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		521	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		522	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		523	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		524	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		525	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		526
		527	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		528	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		529	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		530	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		531	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		532	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		533	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		534
		535	Various constants for use in X calls and event processing.
		536
		537	=back
		538
		539	=head2 RENDITION
		540
		541	Rendition bitsets contain information about colour, font, font styles and
		542	similar information for each screen cell.
		543
		544	The following "macros" deal with changes in rendition sets. You should
		545	never just create a bitset, you should always modify an existing one,
		546	as they contain important information required for correct operation of
		547	rxvt-unicode.
		548
		549	=over 4
		550
		551	=item $rend = urxvt::DEFAULT_RSTYLE
		552
		553	Returns the default rendition, as used when the terminal is starting up or
		554	being reset. Useful as a base to start when creating renditions.
		555
		556	=item $rend = urxvt::OVERLAY_RSTYLE
		557
		558	Return the rendition mask used for overlays by default.
		559
		560	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		561
		562	Return the bit that enabled bold, italic, blink, reverse-video and
		563	underline, respectively. To enable such a style, just logically OR it into
		564	the bitset.
		565
		566	=item $foreground = urxvt::GET_BASEFG $rend
		567
		568	=item $background = urxvt::GET_BASEBG $rend
		569
		570	Return the foreground/background colour index, respectively.
		571
		572	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		573
		574	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		575
		576	Replace the foreground/background colour in the rendition mask with the
		577	specified one.
		578
		579	=item $value = urxvt::GET_CUSTOM $rend
		580
		581	Return the "custom" value: Every rendition has 5 bits for use by
		582	extensions. They can be set and changed as you like and are initially
		583	zero.
		584
		585	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		586
		587	Change the custom value.
		588
		589	=back
		590
		591	=cut
472		592
473	BEGIN {	593	BEGIN {
474	urxvt->bootstrap;	594	urxvt->bootstrap;
475		595
476	# overwrite perl's warn	596	# overwrite perl's warn
…		…
479	$msg .= "\n"	599	$msg .= "\n"
480	unless $msg =~ /\n$/;	600	unless $msg =~ /\n$/;
481	urxvt::warn ($msg);	601	urxvt::warn ($msg);
482	};	602	};
483		603
		604	# %ENV is the original startup environment
484	delete $ENV{IFS};	605	delete $ENV{IFS};
485	delete $ENV{CDPATH};	606	delete $ENV{CDPATH};
486	delete $ENV{BASH_ENV};	607	delete $ENV{BASH_ENV};
487	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	608	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
488	}	609	}
489		610
490	my @hook_count;
491	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	611	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
492		612
493	sub verbose {	613	sub verbose {
494	my ($level, $msg) = @_;	614	my ($level, $msg) = @_;
495	warn "$msg\n" if $level <= $verbosity;	615	warn "$msg\n" if $level <= $verbosity;
…		…
577	if ($@) {	697	if ($@) {
578	$TERM->ungrab; # better to lose the grab than the session	698	$TERM->ungrab; # better to lose the grab than the session
579	warn $@;	699	warn $@;
580	}	700	}
581	}	701	}
		702
		703	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		704	if $verbosity >= 11;
582	}	705	}
583		706
584	if ($htype == 1) { # DESTROY	707	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	708	# clear package objects
593	%$_ = () for values %{ $TERM->{_pkg} };	709	%$_ = () for values %{ $TERM->{_pkg} };
594		710
595	# clear package	711	# clear package
596	%$TERM = ();	712	%$TERM = ();
597	}	713	}
598		714
599	$retval	715	$retval
		716	}
		717
		718	sub exec_async(@) {
		719	my $pid = fork;
		720
		721	return
		722	if !defined $pid or $pid;
		723
		724	%ENV = %{ $TERM->env };
		725
		726	exec @_;
		727	_exit 255;
600	}	728	}
601		729
602	# urxvt::term::extension	730	# urxvt::term::extension
603		731
604	package urxvt::term::extension;	732	package urxvt::term::extension;
…		…
610	while (my ($name, $cb) = each %hook) {	738	while (my ($name, $cb) = each %hook) {
611	my $htype = $HOOKTYPE{uc $name};	739	my $htype = $HOOKTYPE{uc $name};
612	defined $htype	740	defined $htype
613	or Carp::croak "unsupported hook type '$name'";	741	or Carp::croak "unsupported hook type '$name'";
614		742
		743	$self->set_should_invoke ($htype, +1)
615	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	744	unless exists $self->{term}{_hook}[$htype]{$pkg};
616	$hook_count[$htype]++
617	or urxvt::set_should_invoke $htype, 1;
618	}
619		745
620	$self->{term}{_hook}[$htype]{$pkg} = $cb;	746	$self->{term}{_hook}[$htype]{$pkg} = $cb;
621	}	747	}
622	}	748	}
623		749
…		…
628	for my $name (@hook) {	754	for my $name (@hook) {
629	my $htype = $HOOKTYPE{uc $name};	755	my $htype = $HOOKTYPE{uc $name};
630	defined $htype	756	defined $htype
631	or Carp::croak "unsupported hook type '$name'";	757	or Carp::croak "unsupported hook type '$name'";
632		758
		759	$self->set_should_invoke ($htype, -1)
633	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	760	if delete $self->{term}{_hook}[$htype]{$pkg};
634	--$hook_count[$htype]
635	or urxvt::set_should_invoke $htype, 0;
636	}
637	}	761	}
638	}	762	}
639		763
640	our $AUTOLOAD;	764	our $AUTOLOAD;
641		765
…		…
672		796
673	=head2 The C<urxvt::anyevent> Class	797	=head2 The C<urxvt::anyevent> Class
674		798
675	The sole purpose of this class is to deliver an interface to the	799	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	800	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	801	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	802	condition variables, but non-blocking condvar use is ok. What this means
679	cannot use blocking APIs, but the non-blocking variant should work.	803	is that you cannot use blocking APIs, but the non-blocking variant should
		804	work.
680		805
681	=cut	806	=cut
682		807
683	our $VERSION = 1;	808	our $VERSION = 1;
684		809
…		…
761	$proxy->enable ($name => $ref);	886	$proxy->enable ($name => $ref);
762	}	887	}
763	}	888	}
764	}	889	}
765		890
		891	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		892
		893	Creates a new terminal, very similar as if you had started it with system
		894	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		895	hash which defines the environment of the new terminal.
		896
		897	Croaks (and probably outputs an error message) if the new instance
		898	couldn't be created. Returns C<undef> if the new instance didn't
		899	initialise perl, and the terminal object otherwise. The C<init> and
		900	C<start> hooks will be called during this call.
		901
		902	=cut
		903
		904	sub new {
		905	my ($class, $env, @args) = @_;
		906
		907	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		908	}
		909
766	=item $term->destroy	910	=item $term->destroy
767		911
768	Destroy the terminal object (close the window, free resources etc.).	912	Destroy the terminal object (close the window, free resources
		913	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		914	watchers (timers, io watchers) are still active.
769		915
770	=item $isset = $term->option ($optval[, $set])	916	=item $isset = $term->option ($optval[, $set])
771		917
772	Returns true if the option specified by C<$optval> is enabled, and	918	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	919	optionally change it. All option values are stored by name in the hash
…		…
823	my ($self, $name) = (shift, shift);	969	my ($self, $name) = (shift, shift);
824	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	970	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
825	&urxvt::term::_resource	971	&urxvt::term::_resource
826	}	972	}
827		973
		974	=item $value = $term->x_resource ($pattern)
		975
		976	Returns the X-Resource for the given pattern, excluding the program or
		977	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		978	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		979	resource with that pattern exists.
		980
		981	This method should only be called during the C<on_start> hook, as there is
		982	only one resource database per display, and later invocations might return
		983	the wrong resources.
		984
828	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	985	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
829		986
830	Adds a keymap translation exactly as specified via a resource. See the	987	Adds a keymap translation exactly as specified via a resource. See the
831	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	988	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
832		989
…		…
847	=item ($row, $col) = $term->selection_end ([$row, $col])	1004	=item ($row, $col) = $term->selection_end ([$row, $col])
848		1005
849	Return the current values of the selection mark, begin or end positions,	1006	Return the current values of the selection mark, begin or end positions,
850	and optionally set them to new values.	1007	and optionally set them to new values.
851		1008
		1009	=item $term->selection_make ($eventtime[, $rectangular])
		1010
		1011	Tries to make a selection as set by C<selection_beg> and
		1012	C<selection_end>. If C<$rectangular> is true (default: false), a
		1013	rectangular selection will be made. This is the prefered function to make
		1014	a selection.
		1015
852	=item $success = $term->selection_grab ($eventtime)	1016	=item $success = $term->selection_grab ($eventtime)
853		1017
854	Try to request the primary selection from the server (for example, as set	1018	Try to request the primary selection text from the server (for example, as
855	by the next method).	1019	set by the next method). No visual feedback will be given. This function
		1020	is mostly useful from within C<on_sel_grab> hooks.
856		1021
857	=item $oldtext = $term->selection ([$newtext])	1022	=item $oldtext = $term->selection ([$newtext])
858		1023
859	Return the current selection text and optionally replace it by C<$newtext>.	1024	Return the current selection text and optionally replace it by C<$newtext>.
860		1025
…		…
953	Convert the given locale-encoded octets into a perl string.	1118	Convert the given locale-encoded octets into a perl string.
954		1119
955	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1120	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
956		1121
957	XORs the rendition values in the given span with the provided value	1122	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	1123	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
959	to the selection.	1124	refresh hooks to provide effects similar to the selection.
960		1125
961	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1126	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
962		1127
963	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1128	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
964	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1129	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	1130	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
966	it instead.	1131	it instead. Both styles I<MUST NOT> contain font styles.
967		1132
968	=item $term->scr_bell	1133	=item $term->scr_bell
969		1134
970	Ring the bell!	1135	Ring the bell!
971		1136
…		…
1005		1170
1006	=item $windowid = $term->vt	1171	=item $windowid = $term->vt
1007		1172
1008	Return the window id of the terminal window.	1173	Return the window id of the terminal window.
1009		1174
		1175	=item $term->vt_emask_add ($x_event_mask)
		1176
		1177	Adds the specified events to the vt event mask. Useful e.g. when you want
		1178	to receive pointer events all the times:
		1179
		1180	$term->vt_emask_add (urxvt::PointerMotionMask);
		1181
1010	=item $window_width = $term->width	1182	=item $window_width = $term->width
1011		1183
1012	=item $window_height = $term->height	1184	=item $window_height = $term->height
1013		1185
1014	=item $font_width = $term->fwidth	1186	=item $font_width = $term->fwidth
…		…
1027		1199
1028	=item $max_scrollback = $term->saveLines	1200	=item $max_scrollback = $term->saveLines
1029		1201
1030	=item $nrow_plus_saveLines = $term->total_rows	1202	=item $nrow_plus_saveLines = $term->total_rows
1031		1203
1032	=item $lines_in_scrollback = $term->nsaved	1204	=item $topmost_scrollback_row = $term->top_row
1033		1205
1034	Return various integers describing terminal characteristics.	1206	Return various integers describing terminal characteristics.
1035		1207
		1208	=item $x_display = $term->display_id
		1209
		1210	Return the DISPLAY used by rxvt-unicode.
		1211
1036	=item $lc_ctype = $term->locale	1212	=item $lc_ctype = $term->locale
1037		1213
1038	Returns the LC_CTYPE category string used by this rxvt-unicode.	1214	Returns the LC_CTYPE category string used by this rxvt-unicode.
1039		1215
1040	=item $x_display = $term->display_id	1216	=item $env = $term->env
1041		1217
1042	Return the DISPLAY used by rxvt-unicode.	1218	Returns a copy of the environment in effect for the terminal as a hashref
		1219	similar to C<\%ENV>.
		1220
		1221	=cut
		1222
		1223	sub env {
		1224	if (my $env = $_[0]->_env) {
		1225	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1226	} else {
		1227	+{ %ENV }
		1228	}
		1229	}
1043		1230
1044	=item $modifiermask = $term->ModLevel3Mask	1231	=item $modifiermask = $term->ModLevel3Mask
1045		1232
1046	=item $modifiermask = $term->ModMetaMask	1233	=item $modifiermask = $term->ModMetaMask
1047		1234
…		…
1050	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1237	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.	1238	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1052		1239
1053	=item $view_start = $term->view_start ([$newvalue])	1240	=item $view_start = $term->view_start ([$newvalue])
1054		1241
1055	Returns the negative row number of the topmost line. Minimum value is	1242	Returns the row number of the topmost displayed line. Maximum value is
1056	C<0>, which displays the normal terminal contents. Larger values scroll	1243	C<0>, which displays the normal terminal contents. Lower values scroll
1057	this many lines into the scrollback buffer.	1244	this many lines into the scrollback buffer.
1058		1245
1059	=item $term->want_refresh	1246	=item $term->want_refresh
1060		1247
1061	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1248	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.	1327	Return the row number of the first/last row of the line, respectively.
1141		1328
1142	=item $offset = $line->offset_of ($row, $col)	1329	=item $offset = $line->offset_of ($row, $col)
1143		1330
1144	Returns the character offset of the given row\|col pair within the logical	1331	Returns the character offset of the given row\|col pair within the logical
1145	line.	1332	line. Works for rows outside the line, too, and returns corresponding
		1333	offsets outside the string.
1146		1334
1147	=item ($row, $col) = $line->coord_of ($offset)	1335	=item ($row, $col) = $line->coord_of ($offset)
1148		1336
1149	Translates a string offset into terminal coordinates again.	1337	Translates a string offset into terminal coordinates again.
1150		1338
…		…
1287	$item->{render} \|\|= sub { $_[0]{text} };	1475	$item->{render} \|\|= sub { $_[0]{text} };
1288		1476
1289	push @{ $self->{item} }, $item;	1477	push @{ $self->{item} }, $item;
1290	}	1478	}
1291		1479
		1480	=item $popup->add_title ($title)
		1481
		1482	Adds a non-clickable title to the popup.
		1483
		1484	=cut
		1485
		1486	sub add_title {
		1487	my ($self, $title) = @_;
		1488
		1489	$self->add_item ({
		1490	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1491	text => $title,
		1492	activate => sub { },
		1493	});
		1494	}
		1495
		1496	=item $popup->add_separator ([$sepchr])
		1497
		1498	Creates a separator, optionally using the character given as C<$sepchr>.
		1499
		1500	=cut
		1501
1292	sub add_separator {	1502	sub add_separator {
1293	my ($self, $sep) = @_;	1503	my ($self, $sep) = @_;
1294		1504
1295	$sep \|\|= "=";	1505	$sep \|\|= "=";
1296		1506
…		…
1300	render => sub { $sep x $self->{term}->ncol },	1510	render => sub { $sep x $self->{term}->ncol },
1301	activate => sub { },	1511	activate => sub { },
1302	});	1512	});
1303	}	1513	}
1304		1514
1305	sub add_title {	1515	=item $popup->add_button ($text, $cb)
1306	my ($self, $title) = @_;
1307		1516
1308	$self->add_item ({	1517	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" },	1518	selected.
1310	text => $title,	1519
1311	activate => sub { },	1520	=cut
1312	});
1313	}
1314		1521
1315	sub add_button {	1522	sub add_button {
1316	my ($self, $text, $cb) = @_;	1523	my ($self, $text, $cb) = @_;
1317		1524
1318	$self->add_item ({ type => "button", text => $text, activate => $cb});	1525	$self->add_item ({ type => "button", text => $text, activate => $cb});
1319	}	1526	}
		1527
		1528	=item $popup->add_toggle ($text, $cb, $initial_value)
		1529
		1530	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1531	whenever it gets toggled, with a boolean indicating its value as its first
		1532	argument.
		1533
		1534	=cut
1320		1535
1321	sub add_toggle {	1536	sub add_toggle {
1322	my ($self, $text, $cb, $value) = @_;	1537	my ($self, $text, $cb, $value) = @_;
1323		1538
1324	my $item; $item = {	1539	my $item; $item = {
1325	type => "button",	1540	type => "button",
1326	text => " $text",	1541	text => " $text",
1327	value => $value,	1542	value => $value,
1328	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1543	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1329	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1544	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1330	};	1545	};
1331		1546
1332	$self->add_item ($item);	1547	$self->add_item ($item);
1333	}	1548	}
		1549
		1550	=item $popup->show
		1551
		1552	Displays the popup (which is initially hidden).
		1553
		1554	=cut
1334		1555
1335	sub show {	1556	sub show {
1336	my ($self) = @_;	1557	my ($self) = @_;
1337		1558
1338	local $urxvt::popup::self = $self;	1559	local $urxvt::popup::self = $self;
1339		1560
		1561	my $env = $self->{term}->env;
		1562	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1563	delete $env->{LC_ALL};
1340	local $ENV{LC_ALL} = $self->{term}->locale;	1564	$env->{LC_CTYPE} = $self->{term}->locale;
1341		1565
		1566	urxvt::term->new ($env, $self->{term}->resource ("name"),
1342	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1567	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1343	"--transient-for" => $self->{term}->parent,	1568	"--transient-for" => $self->{term}->parent,
1344	"-display" => $self->{term}->display_id,	1569	"-display" => $self->{term}->display_id,
1345	"-pe" => "urxvt-popup")	1570	"-pe" => "urxvt-popup")
1346	or die "unable to create popup window\n";	1571	or die "unable to create popup window\n";
1347	}	1572	}
1348		1573
1349	sub DESTROY {	1574	sub DESTROY {
1350	my ($self) = @_;	1575	my ($self) = @_;
1351		1576
1352	delete $self->{term}{_destroy}{$self};	1577	delete $self->{term}{_destroy}{$self};
1353	$self->{term}->ungrab;	1578	$self->{term}->ungrab;
1354	}	1579	}
		1580
		1581	=back
1355		1582
1356	=head2 The C<urxvt::timer> Class	1583	=head2 The C<urxvt::timer> Class
1357		1584
1358	This class implements timer watchers/events. Time is represented as a	1585	This class implements timer watchers/events. Time is represented as a
1359	fractional number of seconds since the epoch. Example:	1586	fractional number of seconds since the epoch. Example:
…		…
1466		1693
1467	=item == 0 - fatal messages	1694	=item == 0 - fatal messages
1468		1695
1469	=item >= 3 - script loading and management	1696	=item >= 3 - script loading and management
1470		1697
1471	=item >=10 - all events received	1698	=item >=10 - all called hooks
		1699
		1700	=item >=11 - hook reutrn values
1472		1701
1473	=back	1702	=back
1474		1703
1475	=head1 AUTHOR	1704	=head1 AUTHOR
1476		1705

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.95 by elmex, Tue Jan 17 13:19:45 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.95 by elmex, Tue Jan 17 13:19:45 2006 UTC