[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.94 by root, Sun Jan 15 06:02:41 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 the following bindable keyboard command:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
…		…
64	runtime.	86	runtime.
65		87
66	=item selection-popup (enabled by default)	88	=item selection-popup (enabled by default)
67		89
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
70		93
71	=item searchable-scrollback (enabled by default)	94	=item searchable-scrollback<hotkey> (enabled by default)
72		95
73	Adds regex search functionality to the scrollback buffer, triggered by a	96	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	suspended, C</> starts an incremental regex search, C<n> searches further,	98	input/output is suspended and a regex is displayed at the bottom of the
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	99	screen.
77	current position and C<escape> returns to the original position.
78		100
79	=item digital-clock	101	Inputting characters appends them to the regex and continues incremental
		102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		104	bottom. C<Escape> leaves search mode and returns to the point where search
		105	was started, while C<Enter> or C<Return> stay at the current position and
		106	additionally stores the first match in the current line into the primary
		107	selection.
80		108
81	Displays a digital clock using the built-in overlay.	109	=item selection-autotransform
		110
		111	This selection allows you to do automatic transforms on a selection
		112	whenever a selection is made.
		113
		114	It works by specifying perl snippets (most useful is a single C<s///>
		115	operator) that modify C<$_> as resources:
		116
		117	URxvt.selection-autotransform.0: transform
		118	URxvt.selection-autotransform.1: transform
		119	...
		120
		121	For example, the following will transform selections of the form
		122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		123	$word>:
		124
		125	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		126
		127	And this example matches the same,but replaces it with vi-commands you can
		128	paste directly into your (vi :) editor:
		129
		130	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		131
		132	Of course, this can be modified to suit your needs and your editor :)
		133
		134	To expand the example above to typical perl error messages ("XXX at
		135	FILENAME line YYY."), you need a slightly more elaborate solution:
		136
		137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		139
		140	The first line tells the selection code to treat the unchanging part of
		141	every error message as a selection pattern, and the second line transforms
		142	the message into vi commands to load the file.
82		143
83	=item mark-urls	144	=item mark-urls
84		145
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	146	Uses per-line display filtering (C<on_line_update>) to underline urls and
		147	make them clickable. When middle-clicked, the program specified in the
		148	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		149	the URL as first argument.
86		150
87	=item block-graphics-to-ascii	151	=item block-graphics-to-ascii
88		152
89	A not very useful example of filtering all text output to the terminal,	153	A not very useful example of filtering all text output to the terminal,
90	by replacing all line-drawing characters (U+2500 .. U+259F) by a	154	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	155	similar-looking ascii character.
92		156
		157	=item digital-clock
		158
		159	Displays a digital clock using the built-in overlay.
		160
93	=item example-refresh-hooks	161	=item example-refresh-hooks
94		162
95	Displays a very simple digital clock in the upper right corner of the	163	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	164	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	165	overlays or changes.
98		166
99	=back	167	=back
		168
		169	=head1 API DOCUMENTATION
100		170
101	=head2 General API Considerations	171	=head2 General API Considerations
102		172
103	All objects (such as terminals, time watchers etc.) are typical	173	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	174	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	187	=over 4
118		188
119	=item $text	189	=item $text
120		190
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	191	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.	192	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		193
124	=item $string	194	=item $string
125		195
126	A perl text string, with an emphasis on I<text>. It can store all unicode	196	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	197	characters and is to be distinguished with text encoded in a specific
…		…
222	=item on_sel_extend $term	292	=item on_sel_extend $term
223		293
224	Called whenever the user tries to extend the selection (e.g. with a double	294	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	295	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	296	should extend the selection itelf and return true to suppress the built-in
227	processing.	297	processing. This can happen multiple times, as long as the callback
		298	returns true, it will be called on every further click by the user and is
		299	supposed to enlarge the selection more and more, if possible.
228		300
229	See the F<selection> example extension.	301	See the F<selection> example extension.
230		302
231	=item on_view_change $term, $offset	303	=item on_view_change $term, $offset
232		304
…		…
299		371
300	Called whenever the user presses a key combination that has a	372	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>	373	C<perl:string> action bound to it (see description of the B<keysym>
302	resource in the @@RXVT_NAME@@(1) manpage).	374	resource in the @@RXVT_NAME@@(1) manpage).
303		375
		376	=item on_x_event $term, $event
		377
		378	Called on every X event received on the vt window (and possibly other
		379	windows). Should only be used as a last resort. Most event structure
		380	members are not passed.
		381
304	=item on_focus_in $term	382	=item on_focus_in $term
305		383
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	384	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	385	does focus in processing.
308		386
…		…
334		412
335	C<on_key_press> additionally receives the string rxvt-unicode would	413	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	414	output, if any, in locale-specific encoding.
337		415
338	subwindow.	416	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		417
450	=back	418	=back
451		419
452	=cut	420	=cut
453		421
…		…
462	our $VERSION = 1;	430	our $VERSION = 1;
463	our $TERM;	431	our $TERM;
464	our @HOOKNAME;	432	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	433	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;	434	our %OPTION;
		435
467	our $LIBDIR;	436	our $LIBDIR;
		437	our $RESNAME;
		438	our $RESCLASS;
		439	our $RXVTNAME;
		440
		441	=head2 Variables in the C<urxvt> Package
		442
		443	=over 4
		444
		445	=item $urxvt::LIBDIR
		446
		447	The rxvt-unicode library directory, where, among other things, the perl
		448	modules and scripts are stored.
		449
		450	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		451
		452	The resource class and name rxvt-unicode uses to look up X resources.
		453
		454	=item $urxvt::RXVTNAME
		455
		456	The basename of the installed binaries, usually C<urxvt>.
		457
		458	=item $urxvt::TERM
		459
		460	The current terminal. This variable stores the current C<urxvt::term>
		461	object, whenever a callback/hook is executing.
		462
		463	=back
		464
		465	=head2 Functions in the C<urxvt> Package
		466
		467	=over 4
		468
		469	=item urxvt::fatal $errormessage
		470
		471	Fatally aborts execution with the given error message. Avoid at all
		472	costs! The only time this is acceptable is when the terminal process
		473	starts up.
		474
		475	=item urxvt::warn $string
		476
		477	Calls C<rxvt_warn> with the given string which should not include a
		478	newline. The module also overwrites the C<warn> builtin with a function
		479	that calls this function.
		480
		481	Using this function has the advantage that its output ends up in the
		482	correct place, e.g. on stderr of the connecting urxvtc client.
		483
		484	Messages have a size limit of 1023 bytes currently.
		485
		486	=item $is_safe = urxvt::safe
		487
		488	Returns true when it is safe to do potentially unsafe things, such as
		489	evaluating perl code specified by the user. This is true when urxvt was
		490	started setuid or setgid.
		491
		492	=item $time = urxvt::NOW
		493
		494	Returns the "current time" (as per the event loop).
		495
		496	=item urxvt::CurrentTime
		497
		498	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		499	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		500	Button4Mask, Button5Mask, AnyModifier
		501
		502	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		503	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		504	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		505	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		506	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		507	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		508	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		509
		510	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		511	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		512	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		513	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		514	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		515	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		516	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		517
		518	Various constants for use in X calls and event processing.
		519
		520	=back
		521
		522	=head2 RENDITION
		523
		524	Rendition bitsets contain information about colour, font, font styles and
		525	similar information for each screen cell.
		526
		527	The following "macros" deal with changes in rendition sets. You should
		528	never just create a bitset, you should always modify an existing one,
		529	as they contain important information required for correct operation of
		530	rxvt-unicode.
		531
		532	=over 4
		533
		534	=item $rend = urxvt::DEFAULT_RSTYLE
		535
		536	Returns the default rendition, as used when the terminal is starting up or
		537	being reset. Useful as a base to start when creating renditions.
		538
		539	=item $rend = urxvt::OVERLAY_RSTYLE
		540
		541	Return the rendition mask used for overlays by default.
		542
		543	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		544
		545	Return the bit that enabled bold, italic, blink, reverse-video and
		546	underline, respectively. To enable such a style, just logically OR it into
		547	the bitset.
		548
		549	=item $foreground = urxvt::GET_BASEFG $rend
		550
		551	=item $background = urxvt::GET_BASEBG $rend
		552
		553	Return the foreground/background colour index, respectively.
		554
		555	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		556
		557	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		558
		559	Replace the foreground/background colour in the rendition mask with the
		560	specified one.
		561
		562	=item $value = urxvt::GET_CUSTOM $rend
		563
		564	Return the "custom" value: Every rendition has 5 bits for use by
		565	extensions. They can be set and changed as you like and are initially
		566	zero.
		567
		568	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		569
		570	Change the custom value.
		571
		572	=back
		573
		574	=cut
468		575
469	BEGIN {	576	BEGIN {
470	urxvt->bootstrap;	577	urxvt->bootstrap;
471		578
472	# overwrite perl's warn	579	# overwrite perl's warn
…		…
475	$msg .= "\n"	582	$msg .= "\n"
476	unless $msg =~ /\n$/;	583	unless $msg =~ /\n$/;
477	urxvt::warn ($msg);	584	urxvt::warn ($msg);
478	};	585	};
479		586
		587	# %ENV is the original startup environment
480	delete $ENV{IFS};	588	delete $ENV{IFS};
481	delete $ENV{CDPATH};	589	delete $ENV{CDPATH};
482	delete $ENV{BASH_ENV};	590	delete $ENV{BASH_ENV};
483	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	591	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
484	}	592	}
485		593
486	my @hook_count;
487	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	594	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
488		595
489	sub verbose {	596	sub verbose {
490	my ($level, $msg) = @_;	597	my ($level, $msg) = @_;
491	warn "$msg\n" if $level <= $verbosity;	598	warn "$msg\n" if $level <= $verbosity;
…		…
573	if ($@) {	680	if ($@) {
574	$TERM->ungrab; # better to lose the grab than the session	681	$TERM->ungrab; # better to lose the grab than the session
575	warn $@;	682	warn $@;
576	}	683	}
577	}	684	}
		685
		686	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		687	if $verbosity >= 11;
578	}	688	}
579		689
580	if ($htype == 1) { # DESTROY	690	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	691	# clear package objects
589	%$_ = () for values %{ $TERM->{_pkg} };	692	%$_ = () for values %{ $TERM->{_pkg} };
590		693
591	# clear package	694	# clear package
592	%$TERM = ();	695	%$TERM = ();
593	}	696	}
594		697
595	$retval	698	$retval
		699	}
		700
		701	sub exec_async(@) {
		702	my $pid = fork;
		703
		704	return
		705	if !defined $pid or $pid;
		706
		707	%ENV = %{ $TERM->env };
		708
		709	exec @_;
		710	_exit 255;
596	}	711	}
597		712
598	# urxvt::term::extension	713	# urxvt::term::extension
599		714
600	package urxvt::term::extension;	715	package urxvt::term::extension;
…		…
606	while (my ($name, $cb) = each %hook) {	721	while (my ($name, $cb) = each %hook) {
607	my $htype = $HOOKTYPE{uc $name};	722	my $htype = $HOOKTYPE{uc $name};
608	defined $htype	723	defined $htype
609	or Carp::croak "unsupported hook type '$name'";	724	or Carp::croak "unsupported hook type '$name'";
610		725
		726	$self->set_should_invoke ($htype, +1)
611	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	727	unless exists $self->{term}{_hook}[$htype]{$pkg};
612	$hook_count[$htype]++
613	or urxvt::set_should_invoke $htype, 1;
614	}
615		728
616	$self->{term}{_hook}[$htype]{$pkg} = $cb;	729	$self->{term}{_hook}[$htype]{$pkg} = $cb;
617	}	730	}
618	}	731	}
619		732
…		…
624	for my $name (@hook) {	737	for my $name (@hook) {
625	my $htype = $HOOKTYPE{uc $name};	738	my $htype = $HOOKTYPE{uc $name};
626	defined $htype	739	defined $htype
627	or Carp::croak "unsupported hook type '$name'";	740	or Carp::croak "unsupported hook type '$name'";
628		741
		742	$self->set_should_invoke ($htype, -1)
629	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	743	if delete $self->{term}{_hook}[$htype]{$pkg};
630	--$hook_count[$htype]
631	or urxvt::set_should_invoke $htype, 0;
632	}
633	}	744	}
634	}	745	}
635		746
636	our $AUTOLOAD;	747	our $AUTOLOAD;
637		748
…		…
668		779
669	=head2 The C<urxvt::anyevent> Class	780	=head2 The C<urxvt::anyevent> Class
670		781
671	The sole purpose of this class is to deliver an interface to the	782	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	783	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	784	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	785	condition variables, but non-blocking condvar use is ok. What this means
675	cannot use blocking APIs, but the non-blocking variant should work.	786	is that you cannot use blocking APIs, but the non-blocking variant should
		787	work.
676		788
677	=cut	789	=cut
678		790
679	our $VERSION = 1;	791	our $VERSION = 1;
680		792
…		…
757	$proxy->enable ($name => $ref);	869	$proxy->enable ($name => $ref);
758	}	870	}
759	}	871	}
760	}	872	}
761		873
		874	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		875
		876	Creates a new terminal, very similar as if you had started it with system
		877	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		878	hash which defines the environment of the new terminal.
		879
		880	Croaks (and probably outputs an error message) if the new instance
		881	couldn't be created. Returns C<undef> if the new instance didn't
		882	initialise perl, and the terminal object otherwise. The C<init> and
		883	C<start> hooks will be called during this call.
		884
		885	=cut
		886
		887	sub new {
		888	my ($class, $env, @args) = @_;
		889
		890	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		891	}
		892
762	=item $term->destroy	893	=item $term->destroy
763		894
764	Destroy the terminal object (close the window, free resources etc.).	895	Destroy the terminal object (close the window, free resources
		896	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		897	watchers (timers, io watchers) are still active.
765		898
766	=item $isset = $term->option ($optval[, $set])	899	=item $isset = $term->option ($optval[, $set])
767		900
768	Returns true if the option specified by C<$optval> is enabled, and	901	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	902	optionally change it. All option values are stored by name in the hash
…		…
819	my ($self, $name) = (shift, shift);	952	my ($self, $name) = (shift, shift);
820	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	953	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
821	&urxvt::term::_resource	954	&urxvt::term::_resource
822	}	955	}
823		956
		957	=item $value = $term->x_resource ($pattern)
		958
		959	Returns the X-Resource for the given pattern, excluding the program or
		960	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		961	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		962	resource with that pattern exists.
		963
		964	This method should only be called during the C<on_start> hook, as there is
		965	only one resource database per display, and later invocations might return
		966	the wrong resources.
		967
824	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	968	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
825		969
826	Adds a keymap translation exactly as specified via a resource. See the	970	Adds a keymap translation exactly as specified via a resource. See the
827	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	971	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
828		972
…		…
843	=item ($row, $col) = $term->selection_end ([$row, $col])	987	=item ($row, $col) = $term->selection_end ([$row, $col])
844		988
845	Return the current values of the selection mark, begin or end positions,	989	Return the current values of the selection mark, begin or end positions,
846	and optionally set them to new values.	990	and optionally set them to new values.
847		991
		992	=item $term->selection_make ($eventtime[, $rectangular])
		993
		994	Tries to make a selection as set by C<selection_beg> and
		995	C<selection_end>. If C<$rectangular> is true (default: false), a
		996	rectangular selection will be made. This is the prefered function to make
		997	a selection.
		998
848	=item $success = $term->selection_grab ($eventtime)	999	=item $success = $term->selection_grab ($eventtime)
849		1000
850	Try to request the primary selection from the server (for example, as set	1001	Try to request the primary selection text from the server (for example, as
851	by the next method).	1002	set by the next method). No visual feedback will be given. This function
		1003	is mostly useful from within C<on_sel_grab> hooks.
852		1004
853	=item $oldtext = $term->selection ([$newtext])	1005	=item $oldtext = $term->selection ([$newtext])
854		1006
855	Return the current selection text and optionally replace it by C<$newtext>.	1007	Return the current selection text and optionally replace it by C<$newtext>.
856		1008
…		…
949	Convert the given locale-encoded octets into a perl string.	1101	Convert the given locale-encoded octets into a perl string.
950		1102
951	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1103	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
952		1104
953	XORs the rendition values in the given span with the provided value	1105	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	1106	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
955	to the selection.	1107	refresh hooks to provide effects similar to the selection.
956		1108
957	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1109	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
958		1110
959	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1111	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
960	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1112	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	1113	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
962	it instead.	1114	it instead. Both styles I<MUST NOT> contain font styles.
963		1115
964	=item $term->scr_bell	1116	=item $term->scr_bell
965		1117
966	Ring the bell!	1118	Ring the bell!
967		1119
…		…
1001		1153
1002	=item $windowid = $term->vt	1154	=item $windowid = $term->vt
1003		1155
1004	Return the window id of the terminal window.	1156	Return the window id of the terminal window.
1005		1157
		1158	=item $term->vt_emask_add ($x_event_mask)
		1159
		1160	Adds the specified events to the vt event mask. Useful e.g. when you want
		1161	to receive pointer events all the times:
		1162
		1163	$term->vt_emask_add (urxvt::PointerMotionMask);
		1164
1006	=item $window_width = $term->width	1165	=item $window_width = $term->width
1007		1166
1008	=item $window_height = $term->height	1167	=item $window_height = $term->height
1009		1168
1010	=item $font_width = $term->fwidth	1169	=item $font_width = $term->fwidth
…		…
1023		1182
1024	=item $max_scrollback = $term->saveLines	1183	=item $max_scrollback = $term->saveLines
1025		1184
1026	=item $nrow_plus_saveLines = $term->total_rows	1185	=item $nrow_plus_saveLines = $term->total_rows
1027		1186
1028	=item $lines_in_scrollback = $term->nsaved	1187	=item $topmost_scrollback_row = $term->top_row
1029		1188
1030	Return various integers describing terminal characteristics.	1189	Return various integers describing terminal characteristics.
1031		1190
		1191	=item $x_display = $term->display_id
		1192
		1193	Return the DISPLAY used by rxvt-unicode.
		1194
1032	=item $lc_ctype = $term->locale	1195	=item $lc_ctype = $term->locale
1033		1196
1034	Returns the LC_CTYPE category string used by this rxvt-unicode.	1197	Returns the LC_CTYPE category string used by this rxvt-unicode.
1035		1198
1036	=item $x_display = $term->display_id	1199	=item $env = $term->env
1037		1200
1038	Return the DISPLAY used by rxvt-unicode.	1201	Returns a copy of the environment in effect for the terminal as a hashref
		1202	similar to C<\%ENV>.
		1203
		1204	=cut
		1205
		1206	sub env {
		1207	if (my $env = $_[0]->_env) {
		1208	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1209	} else {
		1210	+{ %ENV }
		1211	}
		1212	}
1039		1213
1040	=item $modifiermask = $term->ModLevel3Mask	1214	=item $modifiermask = $term->ModLevel3Mask
1041		1215
1042	=item $modifiermask = $term->ModMetaMask	1216	=item $modifiermask = $term->ModMetaMask
1043		1217
…		…
1046	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1220	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.	1221	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1048		1222
1049	=item $view_start = $term->view_start ([$newvalue])	1223	=item $view_start = $term->view_start ([$newvalue])
1050		1224
1051	Returns the negative row number of the topmost line. Minimum value is	1225	Returns the row number of the topmost displayed line. Maximum value is
1052	C<0>, which displays the normal terminal contents. Larger values scroll	1226	C<0>, which displays the normal terminal contents. Lower values scroll
1053	this many lines into the scrollback buffer.	1227	this many lines into the scrollback buffer.
1054		1228
1055	=item $term->want_refresh	1229	=item $term->want_refresh
1056		1230
1057	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1231	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.	1310	Return the row number of the first/last row of the line, respectively.
1137		1311
1138	=item $offset = $line->offset_of ($row, $col)	1312	=item $offset = $line->offset_of ($row, $col)
1139		1313
1140	Returns the character offset of the given row\|col pair within the logical	1314	Returns the character offset of the given row\|col pair within the logical
1141	line.	1315	line. Works for rows outside the line, too, and returns corresponding
		1316	offsets outside the string.
1142		1317
1143	=item ($row, $col) = $line->coord_of ($offset)	1318	=item ($row, $col) = $line->coord_of ($offset)
1144		1319
1145	Translates a string offset into terminal coordinates again.	1320	Translates a string offset into terminal coordinates again.
1146		1321
…		…
1283	$item->{render} \|\|= sub { $_[0]{text} };	1458	$item->{render} \|\|= sub { $_[0]{text} };
1284		1459
1285	push @{ $self->{item} }, $item;	1460	push @{ $self->{item} }, $item;
1286	}	1461	}
1287		1462
		1463	=item $popup->add_title ($title)
		1464
		1465	Adds a non-clickable title to the popup.
		1466
		1467	=cut
		1468
		1469	sub add_title {
		1470	my ($self, $title) = @_;
		1471
		1472	$self->add_item ({
		1473	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1474	text => $title,
		1475	activate => sub { },
		1476	});
		1477	}
		1478
		1479	=item $popup->add_separator ([$sepchr])
		1480
		1481	Creates a separator, optionally using the character given as C<$sepchr>.
		1482
		1483	=cut
		1484
1288	sub add_separator {	1485	sub add_separator {
1289	my ($self, $sep) = @_;	1486	my ($self, $sep) = @_;
1290		1487
1291	$sep \|\|= "=";	1488	$sep \|\|= "=";
1292		1489
…		…
1296	render => sub { $sep x $self->{term}->ncol },	1493	render => sub { $sep x $self->{term}->ncol },
1297	activate => sub { },	1494	activate => sub { },
1298	});	1495	});
1299	}	1496	}
1300		1497
1301	sub add_title {	1498	=item $popup->add_button ($text, $cb)
1302	my ($self, $title) = @_;
1303		1499
1304	$self->add_item ({	1500	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" },	1501	selected.
1306	text => $title,	1502
1307	activate => sub { },	1503	=cut
1308	});
1309	}
1310		1504
1311	sub add_button {	1505	sub add_button {
1312	my ($self, $text, $cb) = @_;	1506	my ($self, $text, $cb) = @_;
1313		1507
1314	$self->add_item ({ type => "button", text => $text, activate => $cb});	1508	$self->add_item ({ type => "button", text => $text, activate => $cb});
1315	}	1509	}
		1510
		1511	=item $popup->add_toggle ($text, $cb, $initial_value)
		1512
		1513	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1514	whenever it gets toggled, with a boolean indicating its value as its first
		1515	argument.
		1516
		1517	=cut
1316		1518
1317	sub add_toggle {	1519	sub add_toggle {
1318	my ($self, $text, $cb, $value) = @_;	1520	my ($self, $text, $cb, $value) = @_;
1319		1521
1320	my $item; $item = {	1522	my $item; $item = {
1321	type => "button",	1523	type => "button",
1322	text => " $text",	1524	text => " $text",
1323	value => $value,	1525	value => $value,
1324	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1526	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1325	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1527	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1326	};	1528	};
1327		1529
1328	$self->add_item ($item);	1530	$self->add_item ($item);
1329	}	1531	}
		1532
		1533	=item $popup->show
		1534
		1535	Displays the popup (which is initially hidden).
		1536
		1537	=cut
1330		1538
1331	sub show {	1539	sub show {
1332	my ($self) = @_;	1540	my ($self) = @_;
1333		1541
1334	local $urxvt::popup::self = $self;	1542	local $urxvt::popup::self = $self;
1335		1543
		1544	my $env = $self->{term}->env;
		1545	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1546	delete $env->{LC_ALL};
1336	local $ENV{LC_ALL} = $self->{term}->locale;	1547	$env->{LC_CTYPE} = $self->{term}->locale;
1337		1548
		1549	urxvt::term->new ($env, $self->{term}->resource ("name"),
1338	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1550	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1339	"--transient-for" => $self->{term}->parent,	1551	"--transient-for" => $self->{term}->parent,
1340	"-display" => $self->{term}->display_id,	1552	"-display" => $self->{term}->display_id,
1341	"-pe" => "urxvt-popup")	1553	"-pe" => "urxvt-popup")
1342	or die "unable to create popup window\n";	1554	or die "unable to create popup window\n";
1343	}	1555	}
1344		1556
1345	sub DESTROY {	1557	sub DESTROY {
1346	my ($self) = @_;	1558	my ($self) = @_;
1347		1559
1348	delete $self->{term}{_destroy}{$self};	1560	delete $self->{term}{_destroy}{$self};
1349	$self->{term}->ungrab;	1561	$self->{term}->ungrab;
1350	}	1562	}
		1563
		1564	=back
1351		1565
1352	=head2 The C<urxvt::timer> Class	1566	=head2 The C<urxvt::timer> Class
1353		1567
1354	This class implements timer watchers/events. Time is represented as a	1568	This class implements timer watchers/events. Time is represented as a
1355	fractional number of seconds since the epoch. Example:	1569	fractional number of seconds since the epoch. Example:
…		…
1462		1676
1463	=item == 0 - fatal messages	1677	=item == 0 - fatal messages
1464		1678
1465	=item >= 3 - script loading and management	1679	=item >= 3 - script loading and management
1466		1680
1467	=item >=10 - all events received	1681	=item >=10 - all called hooks
		1682
		1683	=item >=11 - hook reutrn values
1468		1684
1469	=back	1685	=back
1470		1686
1471	=head1 AUTHOR	1687	=head1 AUTHOR
1472		1688

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.94 by root, Sun Jan 15 06:02:41 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.94 by root, Sun Jan 15 06:02:41 2006 UTC