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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC vs.
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	47	arguments, which is very convenient, too, if your F<ls> supports
		48	C<--quoting-style=shell>.
48		49
49	It also offers the following bindable event:	50	A double-click usually selects the word under the cursor, further clicks
		51	will enlarge the selection.
		52
		53	The selection works by trying to match a number of regexes and displaying
		54	them in increasing order of length. You can add your own regexes by
		55	specifying resources of the form:
		56
		57	URxvt.selection.pattern-0: perl-regex
		58	URxvt.selection.pattern-1: perl-regex
		59	...
		60
		61	The index number (0, 1...) must not have any holes, and each regex must
		62	contain at least one pair of capturing parentheses, which will be used for
		63	the match. For example, the followign adds a regex that matches everything
		64	between two vertical bars:
		65
		66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		67
		68	You can look at the source of the selection extension to see more
		69	interesting uses, such as parsing a line from beginning to end.
		70
		71	This extension also offers following bindable keyboard commands:
50		72
51	=over 4	73	=over 4
52		74
53	=item rot13	75	=item rot13
54		76
…		…
64	runtime.	86	runtime.
65		87
66	=item selection-popup (enabled by default)	88	=item selection-popup (enabled by default)
67		89
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	90	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	91	text into various other formats/action (such as uri unescaping, perl
		92	evalution, web-browser starting etc.), depending on content.
70		93
71	=item searchable-scrollback (enabled by default)	94	=item searchable-scrollback<hotkey> (enabled by default)
72		95
73	Adds regex search functionality to the scrollback buffer, triggered by a	96	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	97	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	suspended, C</> starts an incremental regex search, C<n> searches further,	98	input/output is suspended and a regex is displayed at the bottom of the
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	99	screen.
77	current position and C<escape> returns to the original position.
78		100
79	=item digital-clock	101	Inputting characters appends them to the regex and continues incremental
		102	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		103	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		104	bottom. C<Escape> leaves search mode and returns to the point where search
		105	was started, while C<Enter> or C<Return> stay at the current position and
		106	additionally stores the first match in the current line into the primary
		107	selection.
80		108
81	Displays a digital clock using the built-in overlay.	109	=item selection-autotransform
		110
		111	This selection allows you to do automatic transforms on a selection
		112	whenever a selection is made.
		113
		114	It works by specifying perl snippets (most useful is a single C<s///>
		115	operator) that modify C<$_> as resources:
		116
		117	URxvt.selection-autotransform.0: transform
		118	URxvt.selection-autotransform.1: transform
		119	...
		120
		121	For example, the following will transform selections of the form
		122	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		123	$word>:
		124
		125	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		126
		127	And this example matches the same,but replaces it with vi-commands you can
		128	paste directly into your (vi :) editor:
		129
		130	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
		131
		132	Of course, this can be modified to suit your needs and your editor :)
		133
		134	To expand the example above to typical perl error messages ("XXX at
		135	FILENAME line YYY."), you need a slightly more elaborate solution:
		136
		137	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
		138	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
		139
		140	The first line tells the selection code to treat the unchanging part of
		141	every error message as a selection pattern, and the second line transforms
		142	the message into vi commands to load the file.
82		143
83	=item mark-urls	144	=item mark-urls
84		145
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	146	Uses per-line display filtering (C<on_line_update>) to underline urls and
		147	make them clickable. When middle-clicked, the program specified in the
		148	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		149	the URL as first argument.
86		150
87	=item block-graphics-to-ascii	151	=item block-graphics-to-ascii
88		152
89	A not very useful example of filtering all text output to the terminal,	153	A not very useful example of filtering all text output to the terminal,
90	by replacing all line-drawing characters (U+2500 .. U+259F) by a	154	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	155	similar-looking ascii character.
92		156
		157	=item digital-clock
		158
		159	Displays a digital clock using the built-in overlay.
		160
93	=item example-refresh-hooks	161	=item example-refresh-hooks
94		162
95	Displays a very simple digital clock in the upper right corner of the	163	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	164	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	165	overlays or changes.
98		166
		167	=item selection-pastebin
		168
		169	This is a little rarely useful extension that Uploads the selection as
		170	textfile to a remote site (or does other things).
		171
		172	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		173	i.e.
		174
		175	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		176
		177	Pressing this combination runs a command with C<%> replaced by the name of
		178	the textfile. This command can be set via a resource:
		179
		180	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		181
		182	And the default is likely not useful to anybody but the few people around
		183	here :)
		184
		185	The name of the textfile is the hex encoded md5 sum of the selection, so
		186	the same content should lead to the same filename.
		187
		188	After a successful upload the selection will be replaced by the text given
		189	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		190	for the filename):
		191
		192	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		193
99	=back	194	=back
		195
		196	=head1 API DOCUMENTATION
100		197
101	=head2 General API Considerations	198	=head2 General API Considerations
102		199
103	All objects (such as terminals, time watchers etc.) are typical	200	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	201	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	214	=over 4
118		215
119	=item $text	216	=item $text
120		217
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	218	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.	219	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		220
124	=item $string	221	=item $string
125		222
126	A perl text string, with an emphasis on I<text>. It can store all unicode	223	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	224	characters and is to be distinguished with text encoded in a specific
…		…
222	=item on_sel_extend $term	319	=item on_sel_extend $term
223		320
224	Called whenever the user tries to extend the selection (e.g. with a double	321	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	322	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	323	should extend the selection itelf and return true to suppress the built-in
227	processing.	324	processing. This can happen multiple times, as long as the callback
		325	returns true, it will be called on every further click by the user and is
		326	supposed to enlarge the selection more and more, if possible.
228		327
229	See the F<selection> example extension.	328	See the F<selection> example extension.
230		329
231	=item on_view_change $term, $offset	330	=item on_view_change $term, $offset
232		331
…		…
263	can filter/change and output the text yourself by returning a true value	362	can filter/change and output the text yourself by returning a true value
264	and calling C<< $term->scr_add_lines >> yourself. Please note that this	363	and calling C<< $term->scr_add_lines >> yourself. Please note that this
265	might be very slow, however, as your hook is called for B<all> text being	364	might be very slow, however, as your hook is called for B<all> text being
266	output.	365	output.
267		366
		367	=item on_tt_write $term, $octets
		368
		369	Called whenever some data is written to the tty/pty and can be used to
		370	suppress or filter tty input.
		371
268	=item on_line_update $term, $row	372	=item on_line_update $term, $row
269		373
270	Called whenever a line was updated or changed. Can be used to filter	374	Called whenever a line was updated or changed. Can be used to filter
271	screen output (e.g. underline urls or other useless stuff). Only lines	375	screen output (e.g. underline urls or other useless stuff). Only lines
272	that are being shown will be filtered, and, due to performance reasons,	376	that are being shown will be filtered, and, due to performance reasons,
…		…
294		398
295	Called whenever the user presses a key combination that has a	399	Called whenever the user presses a key combination that has a
296	C<perl:string> action bound to it (see description of the B<keysym>	400	C<perl:string> action bound to it (see description of the B<keysym>
297	resource in the @@RXVT_NAME@@(1) manpage).	401	resource in the @@RXVT_NAME@@(1) manpage).
298		402
		403	=item on_x_event $term, $event
		404
		405	Called on every X event received on the vt window (and possibly other
		406	windows). Should only be used as a last resort. Most event structure
		407	members are not passed.
		408
299	=item on_focus_in $term	409	=item on_focus_in $term
300		410
301	Called whenever the window gets the keyboard focus, before rxvt-unicode	411	Called whenever the window gets the keyboard focus, before rxvt-unicode
302	does focus in processing.	412	does focus in processing.
303		413
…		…
329		439
330	C<on_key_press> additionally receives the string rxvt-unicode would	440	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	441	output, if any, in locale-specific encoding.
332		442
333	subwindow.	443	subwindow.
334
335	=back
336
337	=head2 Variables in the C<urxvt> Package
338
339	=over 4
340
341	=item $urxvt::TERM
342
343	The current terminal. This variable stores the current C<urxvt::term>
344	object, whenever a callback/hook is executing.
345
346	=back
347
348	=head2 Functions in the C<urxvt> Package
349
350	=over 4
351
352	=item $term = new urxvt [arg...]
353
354	Creates a new terminal, very similar as if you had started it with
355	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
356	if the new instance couldn't be created. Returns C<undef> if the new
357	instance didn't initialise perl, and the terminal object otherwise. The
358	C<init> and C<start> hooks will be called during the call.
359
360	=item urxvt::fatal $errormessage
361
362	Fatally aborts execution with the given error message. Avoid at all
363	costs! The only time this is acceptable is when the terminal process
364	starts up.
365
366	=item urxvt::warn $string
367
368	Calls C<rxvt_warn> with the given string which should not include a
369	newline. The module also overwrites the C<warn> builtin with a function
370	that calls this function.
371
372	Using this function has the advantage that its output ends up in the
373	correct place, e.g. on stderr of the connecting urxvtc client.
374
375	=item $is_safe = urxvt::safe
376
377	Returns true when it is safe to do potentially unsafe things, such as
378	evaluating perl code specified by the user. This is true when urxvt was
379	started setuid or setgid.
380
381	=item $time = urxvt::NOW
382
383	Returns the "current time" (as per the event loop).
384
385	=item urxvt::CurrentTime
386
387	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
388	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
389	Button4Mask, Button5Mask, AnyModifier
390
391	Various constants for use in X calls and event processing.
392
393	=back
394
395	=head2 RENDITION
396
397	Rendition bitsets contain information about colour, font, font styles and
398	similar information for each screen cell.
399
400	The following "macros" deal with changes in rendition sets. You should
401	never just create a bitset, you should always modify an existing one,
402	as they contain important information required for correct operation of
403	rxvt-unicode.
404
405	=over 4
406
407	=item $rend = urxvt::DEFAULT_RSTYLE
408
409	Returns the default rendition, as used when the terminal is starting up or
410	being reset. Useful as a base to start when creating renditions.
411
412	=item $rend = urxvt::OVERLAY_RSTYLE
413
414	Return the rendition mask used for overlays by default.
415
416	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
417
418	Return the bit that enabled bold, italic, blink, reverse-video and
419	underline, respectively. To enable such a style, just logically OR it into
420	the bitset.
421
422	=item $foreground = urxvt::GET_BASEFG $rend
423
424	=item $background = urxvt::GET_BASEBG $rend
425
426	Return the foreground/background colour index, respectively.
427
428	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
429
430	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
431
432	Replace the foreground/background colour in the rendition mask with the
433	specified one.
434
435	=item $value = urxvt::GET_CUSTOM ($rend)
436
437	Return the "custom" value: Every rendition has 5 bits for use by
438	extensions. They can be set and changed as you like and are initially
439	zero.
440
441	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
442
443	Change the custom value.
444		444
445	=back	445	=back
446		446
447	=cut	447	=cut
448		448
…		…
457	our $VERSION = 1;	457	our $VERSION = 1;
458	our $TERM;	458	our $TERM;
459	our @HOOKNAME;	459	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	461	our %OPTION;
		462
462	our $LIBDIR;	463	our $LIBDIR;
		464	our $RESNAME;
		465	our $RESCLASS;
		466	our $RXVTNAME;
		467
		468	=head2 Variables in the C<urxvt> Package
		469
		470	=over 4
		471
		472	=item $urxvt::LIBDIR
		473
		474	The rxvt-unicode library directory, where, among other things, the perl
		475	modules and scripts are stored.
		476
		477	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		478
		479	The resource class and name rxvt-unicode uses to look up X resources.
		480
		481	=item $urxvt::RXVTNAME
		482
		483	The basename of the installed binaries, usually C<urxvt>.
		484
		485	=item $urxvt::TERM
		486
		487	The current terminal. This variable stores the current C<urxvt::term>
		488	object, whenever a callback/hook is executing.
		489
		490	=back
		491
		492	=head2 Functions in the C<urxvt> Package
		493
		494	=over 4
		495
		496	=item urxvt::fatal $errormessage
		497
		498	Fatally aborts execution with the given error message. Avoid at all
		499	costs! The only time this is acceptable is when the terminal process
		500	starts up.
		501
		502	=item urxvt::warn $string
		503
		504	Calls C<rxvt_warn> with the given string which should not include a
		505	newline. The module also overwrites the C<warn> builtin with a function
		506	that calls this function.
		507
		508	Using this function has the advantage that its output ends up in the
		509	correct place, e.g. on stderr of the connecting urxvtc client.
		510
		511	Messages have a size limit of 1023 bytes currently.
		512
		513	=item $time = urxvt::NOW
		514
		515	Returns the "current time" (as per the event loop).
		516
		517	=item urxvt::CurrentTime
		518
		519	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		520	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		521	Button4Mask, Button5Mask, AnyModifier
		522
		523	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		524	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		525	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		526	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		527	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		528	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		529	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		530
		531	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		532	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		533	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		534	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		535	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		536	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		537	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		538
		539	Various constants for use in X calls and event processing.
		540
		541	=back
		542
		543	=head2 RENDITION
		544
		545	Rendition bitsets contain information about colour, font, font styles and
		546	similar information for each screen cell.
		547
		548	The following "macros" deal with changes in rendition sets. You should
		549	never just create a bitset, you should always modify an existing one,
		550	as they contain important information required for correct operation of
		551	rxvt-unicode.
		552
		553	=over 4
		554
		555	=item $rend = urxvt::DEFAULT_RSTYLE
		556
		557	Returns the default rendition, as used when the terminal is starting up or
		558	being reset. Useful as a base to start when creating renditions.
		559
		560	=item $rend = urxvt::OVERLAY_RSTYLE
		561
		562	Return the rendition mask used for overlays by default.
		563
		564	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		565
		566	Return the bit that enabled bold, italic, blink, reverse-video and
		567	underline, respectively. To enable such a style, just logically OR it into
		568	the bitset.
		569
		570	=item $foreground = urxvt::GET_BASEFG $rend
		571
		572	=item $background = urxvt::GET_BASEBG $rend
		573
		574	Return the foreground/background colour index, respectively.
		575
		576	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		577
		578	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		579
		580	Replace the foreground/background colour in the rendition mask with the
		581	specified one.
		582
		583	=item $value = urxvt::GET_CUSTOM $rend
		584
		585	Return the "custom" value: Every rendition has 5 bits for use by
		586	extensions. They can be set and changed as you like and are initially
		587	zero.
		588
		589	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		590
		591	Change the custom value.
		592
		593	=back
		594
		595	=cut
463		596
464	BEGIN {	597	BEGIN {
465	urxvt->bootstrap;	598	urxvt->bootstrap;
466		599
467	# overwrite perl's warn	600	# overwrite perl's warn
…		…
470	$msg .= "\n"	603	$msg .= "\n"
471	unless $msg =~ /\n$/;	604	unless $msg =~ /\n$/;
472	urxvt::warn ($msg);	605	urxvt::warn ($msg);
473	};	606	};
474		607
		608	# %ENV is the original startup environment
475	delete $ENV{IFS};	609	delete $ENV{IFS};
476	delete $ENV{CDPATH};	610	delete $ENV{CDPATH};
477	delete $ENV{BASH_ENV};	611	delete $ENV{BASH_ENV};
478	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	612	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
479	}	613	}
480		614
481	my @hook_count;
482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	615	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
483		616
484	sub verbose {	617	sub verbose {
485	my ($level, $msg) = @_;	618	my ($level, $msg) = @_;
486	warn "$msg\n" if $level <= $verbosity;	619	warn "$msg\n" if $level <= $verbosity;
…		…
499	verbose 3, "loading extension '$path' into package '$pkg'";	632	verbose 3, "loading extension '$path' into package '$pkg'";
500		633
501	open my $fh, "<:raw", $path	634	open my $fh, "<:raw", $path
502	or die "$path: $!";	635	or die "$path: $!";
503		636
504	my $source = untaint	637	my $source =
505	"package $pkg; use strict; use utf8;\n"	638	"package $pkg; use strict; use utf8;\n"
506	. "use base urxvt::term::proxy::;\n"	639	. "use base urxvt::term::extension::;\n"
507	. "#line 1 \"$path\"\n{\n"	640	. "#line 1 \"$path\"\n{\n"
508	. (do { local $/; <$fh> })	641	. (do { local $/; <$fh> })
509	. "\n};\n1";	642	. "\n};\n1";
510		643
511	eval $source	644	eval $source
…		…
568	if ($@) {	701	if ($@) {
569	$TERM->ungrab; # better to lose the grab than the session	702	$TERM->ungrab; # better to lose the grab than the session
570	warn $@;	703	warn $@;
571	}	704	}
572	}	705	}
		706
		707	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		708	if $verbosity >= 11;
573	}	709	}
574		710
575	if ($htype == 1) { # DESTROY	711	if ($htype == 1) { # DESTROY
576	if (my $hook = delete $TERM->{_hook}) {
577	for my $htype (0..$#$hook) {
578	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
579	or set_should_invoke $htype, 0;
580	}
581	}
582
583	# clear package objects	712	# clear package objects
584	%$_ = () for values %{ $TERM->{_pkg} };	713	%$_ = () for values %{ $TERM->{_pkg} };
585		714
586	# clear package	715	# clear package
587	%$TERM = ();	716	%$TERM = ();
588	}	717	}
589		718
590	$retval	719	$retval
591	}	720	}
592		721
593	# urxvt::term::proxy	722	sub exec_async(@) {
		723	my $pid = fork;
594		724
		725	return
		726	if !defined $pid or $pid;
		727
		728	%ENV = %{ $TERM->env };
		729
		730	exec @_;
		731	_exit 255;
		732	}
		733
		734	# urxvt::term::extension
		735
595	package urxvt::term::proxy;	736	package urxvt::term::extension;
596		737
597	sub enable {	738	sub enable {
598	my ($self, %hook) = @_;	739	my ($self, %hook) = @_;
599	my $pkg = $self->{_pkg};	740	my $pkg = $self->{_pkg};
600		741
601	while (my ($name, $cb) = each %hook) {	742	while (my ($name, $cb) = each %hook) {
602	my $htype = $HOOKTYPE{uc $name};	743	my $htype = $HOOKTYPE{uc $name};
603	defined $htype	744	defined $htype
604	or Carp::croak "unsupported hook type '$name'";	745	or Carp::croak "unsupported hook type '$name'";
605		746
		747	$self->set_should_invoke ($htype, +1)
606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	748	unless exists $self->{term}{_hook}[$htype]{$pkg};
607	$hook_count[$htype]++
608	or urxvt::set_should_invoke $htype, 1;
609	}
610		749
611	$self->{term}{_hook}[$htype]{$pkg} = $cb;	750	$self->{term}{_hook}[$htype]{$pkg} = $cb;
612	}	751	}
613	}	752	}
614		753
…		…
619	for my $name (@hook) {	758	for my $name (@hook) {
620	my $htype = $HOOKTYPE{uc $name};	759	my $htype = $HOOKTYPE{uc $name};
621	defined $htype	760	defined $htype
622	or Carp::croak "unsupported hook type '$name'";	761	or Carp::croak "unsupported hook type '$name'";
623		762
		763	$self->set_should_invoke ($htype, -1)
624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	764	if delete $self->{term}{_hook}[$htype]{$pkg};
625	--$hook_count[$htype]
626	or urxvt::set_should_invoke $htype, 0;
627	}
628	}	765	}
629	}	766	}
630		767
631	our $AUTOLOAD;	768	our $AUTOLOAD;
632		769
…		…
663		800
664	=head2 The C<urxvt::anyevent> Class	801	=head2 The C<urxvt::anyevent> Class
665		802
666	The sole purpose of this class is to deliver an interface to the	803	The sole purpose of this class is to deliver an interface to the
667	C<AnyEvent> module - any module using it will work inside urxvt without	804	C<AnyEvent> module - any module using it will work inside urxvt without
668	further work. The only exception is that you cannot wait on condition	805	further programming. The only exception is that you cannot wait on
669	variables, but non-blocking condvar use is ok. What this means is that you	806	condition variables, but non-blocking condvar use is ok. What this means
670	cannot use blocking APIs, but the non-blocking variant should work.	807	is that you cannot use blocking APIs, but the non-blocking variant should
		808	work.
671		809
672	=cut	810	=cut
673		811
674	our $VERSION = 1;	812	our $VERSION = 1;
675		813
…		…
752	$proxy->enable ($name => $ref);	890	$proxy->enable ($name => $ref);
753	}	891	}
754	}	892	}
755	}	893	}
756		894
		895	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		896
		897	Creates a new terminal, very similar as if you had started it with system
		898	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		899	hash which defines the environment of the new terminal.
		900
		901	Croaks (and probably outputs an error message) if the new instance
		902	couldn't be created. Returns C<undef> if the new instance didn't
		903	initialise perl, and the terminal object otherwise. The C<init> and
		904	C<start> hooks will be called during this call.
		905
		906	=cut
		907
		908	sub new {
		909	my ($class, $env, @args) = @_;
		910
		911	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		912	}
		913
757	=item $term->destroy	914	=item $term->destroy
758		915
759	Destroy the terminal object (close the window, free resources etc.).	916	Destroy the terminal object (close the window, free resources
		917	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		918	watchers (timers, io watchers) are still active.
760		919
761	=item $isset = $term->option ($optval[, $set])	920	=item $isset = $term->option ($optval[, $set])
762		921
763	Returns true if the option specified by C<$optval> is enabled, and	922	Returns true if the option specified by C<$optval> is enabled, and
764	optionally change it. All option values are stored by name in the hash	923	optionally change it. All option values are stored by name in the hash
…		…
814	my ($self, $name) = (shift, shift);	973	my ($self, $name) = (shift, shift);
815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	974	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
816	&urxvt::term::_resource	975	&urxvt::term::_resource
817	}	976	}
818		977
		978	=item $value = $term->x_resource ($pattern)
		979
		980	Returns the X-Resource for the given pattern, excluding the program or
		981	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		982	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		983	resource with that pattern exists.
		984
		985	This method should only be called during the C<on_start> hook, as there is
		986	only one resource database per display, and later invocations might return
		987	the wrong resources.
		988
819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	989	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820		990
821	Adds a keymap translation exactly as specified via a resource. See the	991	Adds a keymap translation exactly as specified via a resource. See the
822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	992	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823		993
…		…
838	=item ($row, $col) = $term->selection_end ([$row, $col])	1008	=item ($row, $col) = $term->selection_end ([$row, $col])
839		1009
840	Return the current values of the selection mark, begin or end positions,	1010	Return the current values of the selection mark, begin or end positions,
841	and optionally set them to new values.	1011	and optionally set them to new values.
842		1012
		1013	=item $term->selection_make ($eventtime[, $rectangular])
		1014
		1015	Tries to make a selection as set by C<selection_beg> and
		1016	C<selection_end>. If C<$rectangular> is true (default: false), a
		1017	rectangular selection will be made. This is the prefered function to make
		1018	a selection.
		1019
843	=item $success = $term->selection_grab ($eventtime)	1020	=item $success = $term->selection_grab ($eventtime)
844		1021
845	Try to request the primary selection from the server (for example, as set	1022	Try to request the primary selection text from the server (for example, as
846	by the next method).	1023	set by the next method). No visual feedback will be given. This function
		1024	is mostly useful from within C<on_sel_grab> hooks.
847		1025
848	=item $oldtext = $term->selection ([$newtext])	1026	=item $oldtext = $term->selection ([$newtext])
849		1027
850	Return the current selection text and optionally replace it by C<$newtext>.	1028	Return the current selection text and optionally replace it by C<$newtext>.
851		1029
…		…
944	Convert the given locale-encoded octets into a perl string.	1122	Convert the given locale-encoded octets into a perl string.
945		1123
946	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1124	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
947		1125
948	XORs the rendition values in the given span with the provided value	1126	XORs the rendition values in the given span with the provided value
949	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1127	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
950	to the selection.	1128	refresh hooks to provide effects similar to the selection.
951		1129
952	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1130	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
953		1131
954	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1132	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
955	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1133	whitespace will additionally be xored with the C<$rstyle2>, which defaults
956	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1134	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
957	it instead.	1135	it instead. Both styles I<MUST NOT> contain font styles.
958		1136
959	=item $term->scr_bell	1137	=item $term->scr_bell
960		1138
961	Ring the bell!	1139	Ring the bell!
962		1140
…		…
996		1174
997	=item $windowid = $term->vt	1175	=item $windowid = $term->vt
998		1176
999	Return the window id of the terminal window.	1177	Return the window id of the terminal window.
1000		1178
		1179	=item $term->vt_emask_add ($x_event_mask)
		1180
		1181	Adds the specified events to the vt event mask. Useful e.g. when you want
		1182	to receive pointer events all the times:
		1183
		1184	$term->vt_emask_add (urxvt::PointerMotionMask);
		1185
1001	=item $window_width = $term->width	1186	=item $window_width = $term->width
1002		1187
1003	=item $window_height = $term->height	1188	=item $window_height = $term->height
1004		1189
1005	=item $font_width = $term->fwidth	1190	=item $font_width = $term->fwidth
…		…
1018		1203
1019	=item $max_scrollback = $term->saveLines	1204	=item $max_scrollback = $term->saveLines
1020		1205
1021	=item $nrow_plus_saveLines = $term->total_rows	1206	=item $nrow_plus_saveLines = $term->total_rows
1022		1207
1023	=item $lines_in_scrollback = $term->nsaved	1208	=item $topmost_scrollback_row = $term->top_row
1024		1209
1025	Return various integers describing terminal characteristics.	1210	Return various integers describing terminal characteristics.
1026		1211
		1212	=item $x_display = $term->display_id
		1213
		1214	Return the DISPLAY used by rxvt-unicode.
		1215
1027	=item $lc_ctype = $term->locale	1216	=item $lc_ctype = $term->locale
1028		1217
1029	Returns the LC_CTYPE category string used by this rxvt-unicode.	1218	Returns the LC_CTYPE category string used by this rxvt-unicode.
1030		1219
1031	=item $x_display = $term->display_id	1220	=item $env = $term->env
1032		1221
1033	Return the DISPLAY used by rxvt-unicode.	1222	Returns a copy of the environment in effect for the terminal as a hashref
		1223	similar to C<\%ENV>.
		1224
		1225	=cut
		1226
		1227	sub env {
		1228	if (my $env = $_[0]->_env) {
		1229	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1230	} else {
		1231	+{ %ENV }
		1232	}
		1233	}
1034		1234
1035	=item $modifiermask = $term->ModLevel3Mask	1235	=item $modifiermask = $term->ModLevel3Mask
1036		1236
1037	=item $modifiermask = $term->ModMetaMask	1237	=item $modifiermask = $term->ModMetaMask
1038		1238
…		…
1041	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1241	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1042	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1242	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1043		1243
1044	=item $view_start = $term->view_start ([$newvalue])	1244	=item $view_start = $term->view_start ([$newvalue])
1045		1245
1046	Returns the negative row number of the topmost line. Minimum value is	1246	Returns the row number of the topmost displayed line. Maximum value is
1047	C<0>, which displays the normal terminal contents. Larger values scroll	1247	C<0>, which displays the normal terminal contents. Lower values scroll
1048	this many lines into the scrollback buffer.	1248	this many lines into the scrollback buffer.
1049		1249
1050	=item $term->want_refresh	1250	=item $term->want_refresh
1051		1251
1052	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1252	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1131	Return the row number of the first/last row of the line, respectively.	1331	Return the row number of the first/last row of the line, respectively.
1132		1332
1133	=item $offset = $line->offset_of ($row, $col)	1333	=item $offset = $line->offset_of ($row, $col)
1134		1334
1135	Returns the character offset of the given row\|col pair within the logical	1335	Returns the character offset of the given row\|col pair within the logical
1136	line.	1336	line. Works for rows outside the line, too, and returns corresponding
		1337	offsets outside the string.
1137		1338
1138	=item ($row, $col) = $line->coord_of ($offset)	1339	=item ($row, $col) = $line->coord_of ($offset)
1139		1340
1140	Translates a string offset into terminal coordinates again.	1341	Translates a string offset into terminal coordinates again.
1141		1342
…		…
1278	$item->{render} \|\|= sub { $_[0]{text} };	1479	$item->{render} \|\|= sub { $_[0]{text} };
1279		1480
1280	push @{ $self->{item} }, $item;	1481	push @{ $self->{item} }, $item;
1281	}	1482	}
1282		1483
		1484	=item $popup->add_title ($title)
		1485
		1486	Adds a non-clickable title to the popup.
		1487
		1488	=cut
		1489
		1490	sub add_title {
		1491	my ($self, $title) = @_;
		1492
		1493	$self->add_item ({
		1494	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1495	text => $title,
		1496	activate => sub { },
		1497	});
		1498	}
		1499
		1500	=item $popup->add_separator ([$sepchr])
		1501
		1502	Creates a separator, optionally using the character given as C<$sepchr>.
		1503
		1504	=cut
		1505
1283	sub add_separator {	1506	sub add_separator {
1284	my ($self, $sep) = @_;	1507	my ($self, $sep) = @_;
1285		1508
1286	$sep \|\|= "=";	1509	$sep \|\|= "=";
1287		1510
…		…
1291	render => sub { $sep x $self->{term}->ncol },	1514	render => sub { $sep x $self->{term}->ncol },
1292	activate => sub { },	1515	activate => sub { },
1293	});	1516	});
1294	}	1517	}
1295		1518
1296	sub add_title {	1519	=item $popup->add_button ($text, $cb)
1297	my ($self, $title) = @_;
1298		1520
1299	$self->add_item ({	1521	Adds a clickable button to the popup. C<$cb> is called whenever it is
1300	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1522	selected.
1301	text => $title,	1523
1302	activate => sub { },	1524	=cut
1303	});
1304	}
1305		1525
1306	sub add_button {	1526	sub add_button {
1307	my ($self, $text, $cb) = @_;	1527	my ($self, $text, $cb) = @_;
1308		1528
1309	$self->add_item ({ type => "button", text => $text, activate => $cb});	1529	$self->add_item ({ type => "button", text => $text, activate => $cb});
1310	}	1530	}
		1531
		1532	=item $popup->add_toggle ($text, $cb, $initial_value)
		1533
		1534	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1535	whenever it gets toggled, with a boolean indicating its value as its first
		1536	argument.
		1537
		1538	=cut
1311		1539
1312	sub add_toggle {	1540	sub add_toggle {
1313	my ($self, $text, $cb, $value) = @_;	1541	my ($self, $text, $cb, $value) = @_;
1314		1542
1315	my $item; $item = {	1543	my $item; $item = {
1316	type => "button",	1544	type => "button",
1317	text => " $text",	1545	text => " $text",
1318	value => $value,	1546	value => $value,
1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1547	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1548	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1321	};	1549	};
1322		1550
1323	$self->add_item ($item);	1551	$self->add_item ($item);
1324	}	1552	}
		1553
		1554	=item $popup->show
		1555
		1556	Displays the popup (which is initially hidden).
		1557
		1558	=cut
1325		1559
1326	sub show {	1560	sub show {
1327	my ($self) = @_;	1561	my ($self) = @_;
1328		1562
1329	local $urxvt::popup::self = $self;	1563	local $urxvt::popup::self = $self;
1330		1564
		1565	my $env = $self->{term}->env;
		1566	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1567	delete $env->{LC_ALL};
1331	local $ENV{LC_ALL} = $self->{term}->locale;	1568	$env->{LC_CTYPE} = $self->{term}->locale;
1332		1569
		1570	urxvt::term->new ($env, $self->{term}->resource ("name"),
1333	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1571	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1334	"--transient-for" => $self->{term}->parent,	1572	"--transient-for" => $self->{term}->parent,
1335	"-display" => $self->{term}->display_id,	1573	"-display" => $self->{term}->display_id,
1336	"-pe" => "urxvt-popup")	1574	"-pe" => "urxvt-popup")
1337	or die "unable to create popup window\n";	1575	or die "unable to create popup window\n";
1338	}	1576	}
1339		1577
1340	sub DESTROY {	1578	sub DESTROY {
1341	my ($self) = @_;	1579	my ($self) = @_;
1342		1580
1343	delete $self->{term}{_destroy}{$self};	1581	delete $self->{term}{_destroy}{$self};
1344	$self->{term}->ungrab;	1582	$self->{term}->ungrab;
1345	}	1583	}
		1584
		1585	=back
1346		1586
1347	=head2 The C<urxvt::timer> Class	1587	=head2 The C<urxvt::timer> Class
1348		1588
1349	This class implements timer watchers/events. Time is represented as a	1589	This class implements timer watchers/events. Time is represented as a
1350	fractional number of seconds since the epoch. Example:	1590	fractional number of seconds since the epoch. Example:
…		…
1457		1697
1458	=item == 0 - fatal messages	1698	=item == 0 - fatal messages
1459		1699
1460	=item >= 3 - script loading and management	1700	=item >= 3 - script loading and management
1461		1701
1462	=item >=10 - all events received	1702	=item >=10 - all called hooks
		1703
		1704	=item >=11 - hook reutrn values
1463		1705
1464	=back	1706	=back
1465		1707
1466	=head1 AUTHOR	1708	=head1 AUTHOR
1467		1709

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC vs. Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC vs.
Revision 1.98 by root, Tue Jan 17 17:01:54 2006 UTC