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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.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<hotkey> (enabled by default)	111	=item searchable-scrollback<hotkey> (enabled by default)
72		112
73	Adds regex search functionality to the scrollback buffer, triggered	113	Adds regex search functionality to the scrollback buffer, triggered
74	by a hotkey (default: C<M-s>). When in search mode, normal terminal	114	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	input/output is suspended.	115	input/output is suspended and a regex is displayed at the bottom of the
		116	screen.
76		117
77	C</> starts an incremental regex search, C<n> searches further, C<p> or	118	Inputting characters appends them to the regex and continues incremental
78	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	119	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
79	history, C<enter> leaves search mode at the current position and C<escape>	120	search upwards/downwards in the scrollback buffer, C<End> jumps to the
80	returns to the original position.	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.
81		125
82	=item digital-clock	126	=item selection-autotransform
83		127
84	Displays a digital clock using the built-in overlay.	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.
85		160
86	=item mark-urls	161	=item mark-urls
87		162
88	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.
89		167
90	=item block-graphics-to-ascii	168	=item block-graphics-to-ascii
91		169
92	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,
93	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
94	similar-looking ascii character.	172	similar-looking ascii character.
95		173
		174	=item digital-clock
		175
		176	Displays a digital clock using the built-in overlay.
		177
96	=item example-refresh-hooks	178	=item example-refresh-hooks
97		179
98	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
99	window. Illustrates overwriting the refresh callbacks to create your own	181	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	182	overlays or changes.
101		183
102	=back	184	=back
		185
		186	=head1 API DOCUMENTATION
103		187
104	=head2 General API Considerations	188	=head2 General API Considerations
105		189
106	All objects (such as terminals, time watchers etc.) are typical	190	All objects (such as terminals, time watchers etc.) are typical
107	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
…		…
120	=over 4	204	=over 4
121		205
122	=item $text	206	=item $text
123		207
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	208	Rxvt-unicodes special way of encoding text, where one "unicode" character
125	always represents one screen cell. See L<row_t> for a discussion of this format.	209	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		210
127	=item $string	211	=item $string
128		212
129	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
130	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
…		…
225	=item on_sel_extend $term	309	=item on_sel_extend $term
226		310
227	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
228	click) and is either supposed to return false (normal operation), or	312	click) and is either supposed to return false (normal operation), or
229	should extend the selection itelf and return true to suppress the built-in	313	should extend the selection itelf and return true to suppress the built-in
230	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.
231		317
232	See the F<selection> example extension.	318	See the F<selection> example extension.
233		319
234	=item on_view_change $term, $offset	320	=item on_view_change $term, $offset
235		321
…		…
302		388
303	Called whenever the user presses a key combination that has a	389	Called whenever the user presses a key combination that has a
304	C<perl:string> action bound to it (see description of the B<keysym>	390	C<perl:string> action bound to it (see description of the B<keysym>
305	resource in the @@RXVT_NAME@@(1) manpage).	391	resource in the @@RXVT_NAME@@(1) manpage).
306		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
307	=item on_focus_in $term	399	=item on_focus_in $term
308		400
309	Called whenever the window gets the keyboard focus, before rxvt-unicode	401	Called whenever the window gets the keyboard focus, before rxvt-unicode
310	does focus in processing.	402	does focus in processing.
311		403
…		…
337		429
338	C<on_key_press> additionally receives the string rxvt-unicode would	430	C<on_key_press> additionally receives the string rxvt-unicode would
339	output, if any, in locale-specific encoding.	431	output, if any, in locale-specific encoding.
340		432
341	subwindow.	433	subwindow.
342
343	=back
344
345	=head2 Variables in the C<urxvt> Package
346
347	=over 4
348
349	=item $urxvt::TERM
350
351	The current terminal. This variable stores the current C<urxvt::term>
352	object, whenever a callback/hook is executing.
353
354	=back
355
356	=head2 Functions in the C<urxvt> Package
357
358	=over 4
359
360	=item $term = new urxvt [arg...]
361
362	Creates a new terminal, very similar as if you had started it with
363	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
364	if the new instance couldn't be created. Returns C<undef> if the new
365	instance didn't initialise perl, and the terminal object otherwise. The
366	C<init> and C<start> hooks will be called during the call.
367
368	=item urxvt::fatal $errormessage
369
370	Fatally aborts execution with the given error message. Avoid at all
371	costs! The only time this is acceptable is when the terminal process
372	starts up.
373
374	=item urxvt::warn $string
375
376	Calls C<rxvt_warn> with the given string which should not include a
377	newline. The module also overwrites the C<warn> builtin with a function
378	that calls this function.
379
380	Using this function has the advantage that its output ends up in the
381	correct place, e.g. on stderr of the connecting urxvtc client.
382
383	=item $is_safe = urxvt::safe
384
385	Returns true when it is safe to do potentially unsafe things, such as
386	evaluating perl code specified by the user. This is true when urxvt was
387	started setuid or setgid.
388
389	=item $time = urxvt::NOW
390
391	Returns the "current time" (as per the event loop).
392
393	=item urxvt::CurrentTime
394
395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
397	Button4Mask, Button5Mask, AnyModifier
398
399	Various constants for use in X calls and event processing.
400
401	=back
402
403	=head2 RENDITION
404
405	Rendition bitsets contain information about colour, font, font styles and
406	similar information for each screen cell.
407
408	The following "macros" deal with changes in rendition sets. You should
409	never just create a bitset, you should always modify an existing one,
410	as they contain important information required for correct operation of
411	rxvt-unicode.
412
413	=over 4
414
415	=item $rend = urxvt::DEFAULT_RSTYLE
416
417	Returns the default rendition, as used when the terminal is starting up or
418	being reset. Useful as a base to start when creating renditions.
419
420	=item $rend = urxvt::OVERLAY_RSTYLE
421
422	Return the rendition mask used for overlays by default.
423
424	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
425
426	Return the bit that enabled bold, italic, blink, reverse-video and
427	underline, respectively. To enable such a style, just logically OR it into
428	the bitset.
429
430	=item $foreground = urxvt::GET_BASEFG $rend
431
432	=item $background = urxvt::GET_BASEBG $rend
433
434	Return the foreground/background colour index, respectively.
435
436	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
437
438	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
439
440	Replace the foreground/background colour in the rendition mask with the
441	specified one.
442
443	=item $value = urxvt::GET_CUSTOM ($rend)
444
445	Return the "custom" value: Every rendition has 5 bits for use by
446	extensions. They can be set and changed as you like and are initially
447	zero.
448
449	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
450
451	Change the custom value.
452		434
453	=back	435	=back
454		436
455	=cut	437	=cut
456		438
…		…
470		452
471	our $LIBDIR;	453	our $LIBDIR;
472	our $RESNAME;	454	our $RESNAME;
473	our $RESCLASS;	455	our $RESCLASS;
474	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
475		592
476	BEGIN {	593	BEGIN {
477	urxvt->bootstrap;	594	urxvt->bootstrap;
478		595
479	# overwrite perl's warn	596	# overwrite perl's warn
…		…
482	$msg .= "\n"	599	$msg .= "\n"
483	unless $msg =~ /\n$/;	600	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	601	urxvt::warn ($msg);
485	};	602	};
486		603
		604	# %ENV is the original startup environment
487	delete $ENV{IFS};	605	delete $ENV{IFS};
488	delete $ENV{CDPATH};	606	delete $ENV{CDPATH};
489	delete $ENV{BASH_ENV};	607	delete $ENV{BASH_ENV};
490	$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";
491	}	609	}
492		610
493	my @hook_count;
494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	611	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495		612
496	sub verbose {	613	sub verbose {
497	my ($level, $msg) = @_;	614	my ($level, $msg) = @_;
498	warn "$msg\n" if $level <= $verbosity;	615	warn "$msg\n" if $level <= $verbosity;
…		…
580	if ($@) {	697	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	698	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	699	warn $@;
583	}	700	}
584	}	701	}
		702
		703	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		704	if $verbosity >= 11;
585	}	705	}
586		706
587	if ($htype == 1) { # DESTROY	707	if ($htype == 1) { # DESTROY
588	if (my $hook = delete $TERM->{_hook}) {
589	for my $htype (0..$#$hook) {
590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
591	or set_should_invoke $htype, 0;
592	}
593	}
594
595	# clear package objects	708	# clear package objects
596	%$_ = () for values %{ $TERM->{_pkg} };	709	%$_ = () for values %{ $TERM->{_pkg} };
597		710
598	# clear package	711	# clear package
599	%$TERM = ();	712	%$TERM = ();
600	}	713	}
601		714
602	$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;
603	}	728	}
604		729
605	# urxvt::term::extension	730	# urxvt::term::extension
606		731
607	package urxvt::term::extension;	732	package urxvt::term::extension;
…		…
613	while (my ($name, $cb) = each %hook) {	738	while (my ($name, $cb) = each %hook) {
614	my $htype = $HOOKTYPE{uc $name};	739	my $htype = $HOOKTYPE{uc $name};
615	defined $htype	740	defined $htype
616	or Carp::croak "unsupported hook type '$name'";	741	or Carp::croak "unsupported hook type '$name'";
617		742
		743	$self->set_should_invoke ($htype, +1)
618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	744	unless exists $self->{term}{_hook}[$htype]{$pkg};
619	$hook_count[$htype]++
620	or urxvt::set_should_invoke $htype, 1;
621	}
622		745
623	$self->{term}{_hook}[$htype]{$pkg} = $cb;	746	$self->{term}{_hook}[$htype]{$pkg} = $cb;
624	}	747	}
625	}	748	}
626		749
…		…
631	for my $name (@hook) {	754	for my $name (@hook) {
632	my $htype = $HOOKTYPE{uc $name};	755	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	756	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	757	or Carp::croak "unsupported hook type '$name'";
635		758
		759	$self->set_should_invoke ($htype, -1)
636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	760	if delete $self->{term}{_hook}[$htype]{$pkg};
637	--$hook_count[$htype]
638	or urxvt::set_should_invoke $htype, 0;
639	}
640	}	761	}
641	}	762	}
642		763
643	our $AUTOLOAD;	764	our $AUTOLOAD;
644		765
…		…
675		796
676	=head2 The C<urxvt::anyevent> Class	797	=head2 The C<urxvt::anyevent> Class
677		798
678	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
679	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
680	further work. The only exception is that you cannot wait on condition	801	further programming. The only exception is that you cannot wait on
681	variables, but non-blocking condvar use is ok. What this means is that you	802	condition variables, but non-blocking condvar use is ok. What this means
682	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.
683		805
684	=cut	806	=cut
685		807
686	our $VERSION = 1;	808	our $VERSION = 1;
687		809
…		…
764	$proxy->enable ($name => $ref);	886	$proxy->enable ($name => $ref);
765	}	887	}
766	}	888	}
767	}	889	}
768		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
769	=item $term->destroy	910	=item $term->destroy
770		911
771	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.
772		915
773	=item $isset = $term->option ($optval[, $set])	916	=item $isset = $term->option ($optval[, $set])
774		917
775	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
776	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
…		…
826	my ($self, $name) = (shift, shift);	969	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	970	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	971	&urxvt::term::_resource
829	}	972	}
830		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
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	985	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		986
833	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
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	988	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835		989
…		…
850	=item ($row, $col) = $term->selection_end ([$row, $col])	1004	=item ($row, $col) = $term->selection_end ([$row, $col])
851		1005
852	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,
853	and optionally set them to new values.	1007	and optionally set them to new values.
854		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
855	=item $success = $term->selection_grab ($eventtime)	1016	=item $success = $term->selection_grab ($eventtime)
856		1017
857	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
858	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.
859		1021
860	=item $oldtext = $term->selection ([$newtext])	1022	=item $oldtext = $term->selection ([$newtext])
861		1023
862	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>.
863		1025
…		…
956	Convert the given locale-encoded octets into a perl string.	1118	Convert the given locale-encoded octets into a perl string.
957		1119
958	=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])
959		1121
960	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
961	(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
962	to the selection.	1124	refresh hooks to provide effects similar to the selection.
963		1125
964	=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]])
965		1127
966	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
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1129	whitespace will additionally be xored with the C<$rstyle2>, which defaults
968	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1130	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
969	it instead.	1131	it instead. Both styles I<MUST NOT> contain font styles.
970		1132
971	=item $term->scr_bell	1133	=item $term->scr_bell
972		1134
973	Ring the bell!	1135	Ring the bell!
974		1136
…		…
1008		1170
1009	=item $windowid = $term->vt	1171	=item $windowid = $term->vt
1010		1172
1011	Return the window id of the terminal window.	1173	Return the window id of the terminal window.
1012		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
1013	=item $window_width = $term->width	1182	=item $window_width = $term->width
1014		1183
1015	=item $window_height = $term->height	1184	=item $window_height = $term->height
1016		1185
1017	=item $font_width = $term->fwidth	1186	=item $font_width = $term->fwidth
…		…
1030		1199
1031	=item $max_scrollback = $term->saveLines	1200	=item $max_scrollback = $term->saveLines
1032		1201
1033	=item $nrow_plus_saveLines = $term->total_rows	1202	=item $nrow_plus_saveLines = $term->total_rows
1034		1203
1035	=item $lines_in_scrollback = $term->nsaved	1204	=item $topmost_scrollback_row = $term->top_row
1036		1205
1037	Return various integers describing terminal characteristics.	1206	Return various integers describing terminal characteristics.
1038		1207
		1208	=item $x_display = $term->display_id
		1209
		1210	Return the DISPLAY used by rxvt-unicode.
		1211
1039	=item $lc_ctype = $term->locale	1212	=item $lc_ctype = $term->locale
1040		1213
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1214	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1215
1043	=item $x_display = $term->display_id	1216	=item $env = $term->env
1044		1217
1045	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	}
1046		1230
1047	=item $modifiermask = $term->ModLevel3Mask	1231	=item $modifiermask = $term->ModLevel3Mask
1048		1232
1049	=item $modifiermask = $term->ModMetaMask	1233	=item $modifiermask = $term->ModMetaMask
1050		1234
…		…
1053	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
1054	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.
1055		1239
1056	=item $view_start = $term->view_start ([$newvalue])	1240	=item $view_start = $term->view_start ([$newvalue])
1057		1241
1058	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
1059	C<0>, which displays the normal terminal contents. Larger values scroll	1243	C<0>, which displays the normal terminal contents. Lower values scroll
1060	this many lines into the scrollback buffer.	1244	this many lines into the scrollback buffer.
1061		1245
1062	=item $term->want_refresh	1246	=item $term->want_refresh
1063		1247
1064	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1248	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1143	Return the row number of the first/last row of the line, respectively.	1327	Return the row number of the first/last row of the line, respectively.
1144		1328
1145	=item $offset = $line->offset_of ($row, $col)	1329	=item $offset = $line->offset_of ($row, $col)
1146		1330
1147	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
1148	line.	1332	line. Works for rows outside the line, too, and returns corresponding
		1333	offsets outside the string.
1149		1334
1150	=item ($row, $col) = $line->coord_of ($offset)	1335	=item ($row, $col) = $line->coord_of ($offset)
1151		1336
1152	Translates a string offset into terminal coordinates again.	1337	Translates a string offset into terminal coordinates again.
1153		1338
…		…
1290	$item->{render} \|\|= sub { $_[0]{text} };	1475	$item->{render} \|\|= sub { $_[0]{text} };
1291		1476
1292	push @{ $self->{item} }, $item;	1477	push @{ $self->{item} }, $item;
1293	}	1478	}
1294		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
1295	sub add_separator {	1502	sub add_separator {
1296	my ($self, $sep) = @_;	1503	my ($self, $sep) = @_;
1297		1504
1298	$sep \|\|= "=";	1505	$sep \|\|= "=";
1299		1506
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1510	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1511	activate => sub { },
1305	});	1512	});
1306	}	1513	}
1307		1514
1308	sub add_title {	1515	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1516
1311	$self->add_item ({	1517	Adds a clickable button to the popup. C<$cb> is called whenever it is
1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1518	selected.
1313	text => $title,	1519
1314	activate => sub { },	1520	=cut
1315	});
1316	}
1317		1521
1318	sub add_button {	1522	sub add_button {
1319	my ($self, $text, $cb) = @_;	1523	my ($self, $text, $cb) = @_;
1320		1524
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1525	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	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
1323		1535
1324	sub add_toggle {	1536	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1537	my ($self, $text, $cb, $value) = @_;
1326		1538
1327	my $item; $item = {	1539	my $item; $item = {
1328	type => "button",	1540	type => "button",
1329	text => " $text",	1541	text => " $text",
1330	value => $value,	1542	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1543	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1544	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1545	};
1334		1546
1335	$self->add_item ($item);	1547	$self->add_item ($item);
1336	}	1548	}
		1549
		1550	=item $popup->show
		1551
		1552	Displays the popup (which is initially hidden).
		1553
		1554	=cut
1337		1555
1338	sub show {	1556	sub show {
1339	my ($self) = @_;	1557	my ($self) = @_;
1340		1558
1341	local $urxvt::popup::self = $self;	1559	local $urxvt::popup::self = $self;
1342		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};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1564	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1565
		1566	urxvt::term->new ($env, $self->{term}->resource ("name"),
1345	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,
1346	"--transient-for" => $self->{term}->parent,	1568	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1569	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1570	"-pe" => "urxvt-popup")
1349	or die "unable to create popup window\n";	1571	or die "unable to create popup window\n";
1350	}	1572	}
1351		1573
1352	sub DESTROY {	1574	sub DESTROY {
1353	my ($self) = @_;	1575	my ($self) = @_;
1354		1576
1355	delete $self->{term}{_destroy}{$self};	1577	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1578	$self->{term}->ungrab;
1357	}	1579	}
		1580
		1581	=back
1358		1582
1359	=head2 The C<urxvt::timer> Class	1583	=head2 The C<urxvt::timer> Class
1360		1584
1361	This class implements timer watchers/events. Time is represented as a	1585	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1586	fractional number of seconds since the epoch. Example:
…		…
1469		1693
1470	=item == 0 - fatal messages	1694	=item == 0 - fatal messages
1471		1695
1472	=item >= 3 - script loading and management	1696	=item >= 3 - script loading and management
1473		1697
1474	=item >=10 - all events received	1698	=item >=10 - all called hooks
		1699
		1700	=item >=11 - hook reutrn values
1475		1701
1476	=back	1702	=back
1477		1703
1478	=head1 AUTHOR	1704	=head1 AUTHOR
1479		1705

Diff Legend

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

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

Diff Legend

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