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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC vs.
Revision 1.100 by root, Wed Jan 18 08:33:34 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). (The implementation is
		171	not currently secure for use in a multiuser environment as it writes to
		172	F</tmp> directly.).
		173
		174	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		175	i.e.
		176
		177	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		178
		179	Pressing this combination runs a command with C<%> replaced by the name of
		180	the textfile. This command can be set via a resource:
		181
		182	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		183
		184	And the default is likely not useful to anybody but the few people around
		185	here :)
		186
		187	The name of the textfile is the hex encoded md5 sum of the selection, so
		188	the same content should lead to the same filename.
		189
		190	After a successful upload the selection will be replaced by the text given
		191	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		192	for the filename):
		193
		194	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		195
99	=back	196	=back
		197
		198	=head1 API DOCUMENTATION
100		199
101	=head2 General API Considerations	200	=head2 General API Considerations
102		201
103	All objects (such as terminals, time watchers etc.) are typical	202	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	203	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	216	=over 4
118		217
119	=item $text	218	=item $text
120		219
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	220	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.	221	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		222
124	=item $string	223	=item $string
125		224
126	A perl text string, with an emphasis on I<text>. It can store all unicode	225	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	226	characters and is to be distinguished with text encoded in a specific
…		…
222	=item on_sel_extend $term	321	=item on_sel_extend $term
223		322
224	Called whenever the user tries to extend the selection (e.g. with a double	323	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	324	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	325	should extend the selection itelf and return true to suppress the built-in
227	processing.	326	processing. This can happen multiple times, as long as the callback
		327	returns true, it will be called on every further click by the user and is
		328	supposed to enlarge the selection more and more, if possible.
228		329
229	See the F<selection> example extension.	330	See the F<selection> example extension.
230		331
231	=item on_view_change $term, $offset	332	=item on_view_change $term, $offset
232		333
…		…
263	can filter/change and output the text yourself by returning a true value	364	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	365	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	366	might be very slow, however, as your hook is called for B<all> text being
266	output.	367	output.
267		368
		369	=item on_tt_write $term, $octets
		370
		371	Called whenever some data is written to the tty/pty and can be used to
		372	suppress or filter tty input.
		373
268	=item on_line_update $term, $row	374	=item on_line_update $term, $row
269		375
270	Called whenever a line was updated or changed. Can be used to filter	376	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	377	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,	378	that are being shown will be filtered, and, due to performance reasons,
…		…
294		400
295	Called whenever the user presses a key combination that has a	401	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>	402	C<perl:string> action bound to it (see description of the B<keysym>
297	resource in the @@RXVT_NAME@@(1) manpage).	403	resource in the @@RXVT_NAME@@(1) manpage).
298		404
		405	=item on_x_event $term, $event
		406
		407	Called on every X event received on the vt window (and possibly other
		408	windows). Should only be used as a last resort. Most event structure
		409	members are not passed.
		410
299	=item on_focus_in $term	411	=item on_focus_in $term
300		412
301	Called whenever the window gets the keyboard focus, before rxvt-unicode	413	Called whenever the window gets the keyboard focus, before rxvt-unicode
302	does focus in processing.	414	does focus in processing.
303		415
…		…
329		441
330	C<on_key_press> additionally receives the string rxvt-unicode would	442	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	443	output, if any, in locale-specific encoding.
332		444
333	subwindow.	445	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		446
445	=back	447	=back
446		448
447	=cut	449	=cut
448		450
…		…
457	our $VERSION = 1;	459	our $VERSION = 1;
458	our $TERM;	460	our $TERM;
459	our @HOOKNAME;	461	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	462	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	463	our %OPTION;
		464
462	our $LIBDIR;	465	our $LIBDIR;
		466	our $RESNAME;
		467	our $RESCLASS;
		468	our $RXVTNAME;
		469
		470	=head2 Variables in the C<urxvt> Package
		471
		472	=over 4
		473
		474	=item $urxvt::LIBDIR
		475
		476	The rxvt-unicode library directory, where, among other things, the perl
		477	modules and scripts are stored.
		478
		479	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		480
		481	The resource class and name rxvt-unicode uses to look up X resources.
		482
		483	=item $urxvt::RXVTNAME
		484
		485	The basename of the installed binaries, usually C<urxvt>.
		486
		487	=item $urxvt::TERM
		488
		489	The current terminal. This variable stores the current C<urxvt::term>
		490	object, whenever a callback/hook is executing.
		491
		492	=back
		493
		494	=head2 Functions in the C<urxvt> Package
		495
		496	=over 4
		497
		498	=item urxvt::fatal $errormessage
		499
		500	Fatally aborts execution with the given error message. Avoid at all
		501	costs! The only time this is acceptable is when the terminal process
		502	starts up.
		503
		504	=item urxvt::warn $string
		505
		506	Calls C<rxvt_warn> with the given string which should not include a
		507	newline. The module also overwrites the C<warn> builtin with a function
		508	that calls this function.
		509
		510	Using this function has the advantage that its output ends up in the
		511	correct place, e.g. on stderr of the connecting urxvtc client.
		512
		513	Messages have a size limit of 1023 bytes currently.
		514
		515	=item $time = urxvt::NOW
		516
		517	Returns the "current time" (as per the event loop).
		518
		519	=item urxvt::CurrentTime
		520
		521	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		522	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		523	Button4Mask, Button5Mask, AnyModifier
		524
		525	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		526	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		527	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		528	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		529	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		530	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		531	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		532
		533	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		534	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		535	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		536	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		537	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		538	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		539	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		540
		541	Various constants for use in X calls and event processing.
		542
		543	=back
		544
		545	=head2 RENDITION
		546
		547	Rendition bitsets contain information about colour, font, font styles and
		548	similar information for each screen cell.
		549
		550	The following "macros" deal with changes in rendition sets. You should
		551	never just create a bitset, you should always modify an existing one,
		552	as they contain important information required for correct operation of
		553	rxvt-unicode.
		554
		555	=over 4
		556
		557	=item $rend = urxvt::DEFAULT_RSTYLE
		558
		559	Returns the default rendition, as used when the terminal is starting up or
		560	being reset. Useful as a base to start when creating renditions.
		561
		562	=item $rend = urxvt::OVERLAY_RSTYLE
		563
		564	Return the rendition mask used for overlays by default.
		565
		566	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		567
		568	Return the bit that enabled bold, italic, blink, reverse-video and
		569	underline, respectively. To enable such a style, just logically OR it into
		570	the bitset.
		571
		572	=item $foreground = urxvt::GET_BASEFG $rend
		573
		574	=item $background = urxvt::GET_BASEBG $rend
		575
		576	Return the foreground/background colour index, respectively.
		577
		578	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		579
		580	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		581
		582	Replace the foreground/background colour in the rendition mask with the
		583	specified one.
		584
		585	=item $value = urxvt::GET_CUSTOM $rend
		586
		587	Return the "custom" value: Every rendition has 5 bits for use by
		588	extensions. They can be set and changed as you like and are initially
		589	zero.
		590
		591	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		592
		593	Change the custom value.
		594
		595	=back
		596
		597	=cut
463		598
464	BEGIN {	599	BEGIN {
465	urxvt->bootstrap;
466
467	# overwrite perl's warn	600	# overwrite perl's warn
468	*CORE::GLOBAL::warn = sub {	601	*CORE::GLOBAL::warn = sub {
469	my $msg = join "", @_;	602	my $msg = join "", @_;
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;
487	}	620	}
488		621
489	my $extension_pkg = "extension0000";
490	my %extension_pkg;	622	my %extension_pkg;
491		623
492	# load a single script into its own package, once only	624	# load a single script into its own package, once only
493	sub extension_package($) {	625	sub extension_package($) {
494	my ($path) = @_;	626	my ($path) = @_;
495		627
		628	no strict 'refs';
		629
496	$extension_pkg{$path} \|\|= do {	630	$extension_pkg{$path} \|\|= do {
497	my $pkg = "urxvt::" . ($extension_pkg++);	631	$path =~ /([^\/\\]+)$/;
		632	my $pkg = $1;
		633	$pkg =~ s/[^[:word:]]/_/g;
		634	$pkg = "urxvt::ext::$pkg";
498		635
499	verbose 3, "loading extension '$path' into package '$pkg'";	636	verbose 3, "loading extension '$path' into package '$pkg'";
500		637
501	open my $fh, "<:raw", $path	638	open my $fh, "<:raw", $path
502	or die "$path: $!";	639	or die "$path: $!";
503		640
		641	@{"$pkg\::ISA"} = urxvt::term::extension::;
		642
504	my $source = untaint	643	my $source =
505	"package $pkg; use strict; use utf8;\n"	644	"package $pkg; use strict; use utf8;\n"
506	. "use base urxvt::term::proxy::;\n"
507	. "#line 1 \"$path\"\n{\n"	645	. "#line 1 \"$path\"\n{\n"
508	. (do { local $/; <$fh> })	646	. (do { local $/; <$fh> })
509	. "\n};\n1";	647	. "\n};\n1";
510		648
511	eval $source	649	eval $source
…		…
568	if ($@) {	706	if ($@) {
569	$TERM->ungrab; # better to lose the grab than the session	707	$TERM->ungrab; # better to lose the grab than the session
570	warn $@;	708	warn $@;
571	}	709	}
572	}	710	}
		711
		712	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		713	if $verbosity >= 11;
573	}	714	}
574		715
575	if ($htype == 1) { # DESTROY	716	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	717	# clear package objects
584	%$_ = () for values %{ $TERM->{_pkg} };	718	%$_ = () for values %{ $TERM->{_pkg} };
585		719
586	# clear package	720	# clear package
587	%$TERM = ();	721	%$TERM = ();
588	}	722	}
589		723
590	$retval	724	$retval
591	}	725	}
592		726
593	# urxvt::term::proxy	727	sub exec_async(@) {
		728	my $pid = fork;
594		729
		730	return
		731	if !defined $pid or $pid;
		732
		733	%ENV = %{ $TERM->env };
		734
		735	exec @_;
		736	_exit 255;
		737	}
		738
		739	# urxvt::term::extension
		740
595	package urxvt::term::proxy;	741	package urxvt::term::extension;
596		742
597	sub enable {	743	sub enable {
598	my ($self, %hook) = @_;	744	my ($self, %hook) = @_;
599	my $pkg = $self->{_pkg};	745	my $pkg = $self->{_pkg};
600		746
601	while (my ($name, $cb) = each %hook) {	747	while (my ($name, $cb) = each %hook) {
602	my $htype = $HOOKTYPE{uc $name};	748	my $htype = $HOOKTYPE{uc $name};
603	defined $htype	749	defined $htype
604	or Carp::croak "unsupported hook type '$name'";	750	or Carp::croak "unsupported hook type '$name'";
605		751
		752	$self->set_should_invoke ($htype, +1)
606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	753	unless exists $self->{term}{_hook}[$htype]{$pkg};
607	$hook_count[$htype]++
608	or urxvt::set_should_invoke $htype, 1;
609	}
610		754
611	$self->{term}{_hook}[$htype]{$pkg} = $cb;	755	$self->{term}{_hook}[$htype]{$pkg} = $cb;
612	}	756	}
613	}	757	}
614		758
…		…
619	for my $name (@hook) {	763	for my $name (@hook) {
620	my $htype = $HOOKTYPE{uc $name};	764	my $htype = $HOOKTYPE{uc $name};
621	defined $htype	765	defined $htype
622	or Carp::croak "unsupported hook type '$name'";	766	or Carp::croak "unsupported hook type '$name'";
623		767
		768	$self->set_should_invoke ($htype, -1)
624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	769	if delete $self->{term}{_hook}[$htype]{$pkg};
625	--$hook_count[$htype]
626	or urxvt::set_should_invoke $htype, 0;
627	}
628	}	770	}
629	}	771	}
630		772
631	our $AUTOLOAD;	773	our $AUTOLOAD;
632		774
…		…
663		805
664	=head2 The C<urxvt::anyevent> Class	806	=head2 The C<urxvt::anyevent> Class
665		807
666	The sole purpose of this class is to deliver an interface to the	808	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	809	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	810	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	811	condition variables, but non-blocking condvar use is ok. What this means
670	cannot use blocking APIs, but the non-blocking variant should work.	812	is that you cannot use blocking APIs, but the non-blocking variant should
		813	work.
671		814
672	=cut	815	=cut
673		816
674	our $VERSION = 1;	817	our $VERSION = 1;
675		818
…		…
752	$proxy->enable ($name => $ref);	895	$proxy->enable ($name => $ref);
753	}	896	}
754	}	897	}
755	}	898	}
756		899
		900	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		901
		902	Creates a new terminal, very similar as if you had started it with system
		903	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		904	hash which defines the environment of the new terminal.
		905
		906	Croaks (and probably outputs an error message) if the new instance
		907	couldn't be created. Returns C<undef> if the new instance didn't
		908	initialise perl, and the terminal object otherwise. The C<init> and
		909	C<start> hooks will be called during this call.
		910
		911	=cut
		912
		913	sub new {
		914	my ($class, $env, @args) = @_;
		915
		916	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		917	}
		918
757	=item $term->destroy	919	=item $term->destroy
758		920
759	Destroy the terminal object (close the window, free resources etc.).	921	Destroy the terminal object (close the window, free resources
		922	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		923	watchers (timers, io watchers) are still active.
760		924
761	=item $isset = $term->option ($optval[, $set])	925	=item $isset = $term->option ($optval[, $set])
762		926
763	Returns true if the option specified by C<$optval> is enabled, and	927	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	928	optionally change it. All option values are stored by name in the hash
…		…
814	my ($self, $name) = (shift, shift);	978	my ($self, $name) = (shift, shift);
815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	979	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
816	&urxvt::term::_resource	980	&urxvt::term::_resource
817	}	981	}
818		982
		983	=item $value = $term->x_resource ($pattern)
		984
		985	Returns the X-Resource for the given pattern, excluding the program or
		986	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		987	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		988	resource with that pattern exists.
		989
		990	This method should only be called during the C<on_start> hook, as there is
		991	only one resource database per display, and later invocations might return
		992	the wrong resources.
		993
819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	994	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820		995
821	Adds a keymap translation exactly as specified via a resource. See the	996	Adds a keymap translation exactly as specified via a resource. See the
822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	997	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823		998
…		…
838	=item ($row, $col) = $term->selection_end ([$row, $col])	1013	=item ($row, $col) = $term->selection_end ([$row, $col])
839		1014
840	Return the current values of the selection mark, begin or end positions,	1015	Return the current values of the selection mark, begin or end positions,
841	and optionally set them to new values.	1016	and optionally set them to new values.
842		1017
		1018	=item $term->selection_make ($eventtime[, $rectangular])
		1019
		1020	Tries to make a selection as set by C<selection_beg> and
		1021	C<selection_end>. If C<$rectangular> is true (default: false), a
		1022	rectangular selection will be made. This is the prefered function to make
		1023	a selection.
		1024
843	=item $success = $term->selection_grab ($eventtime)	1025	=item $success = $term->selection_grab ($eventtime)
844		1026
845	Try to request the primary selection from the server (for example, as set	1027	Try to request the primary selection text from the server (for example, as
846	by the next method).	1028	set by the next method). No visual feedback will be given. This function
		1029	is mostly useful from within C<on_sel_grab> hooks.
847		1030
848	=item $oldtext = $term->selection ([$newtext])	1031	=item $oldtext = $term->selection ([$newtext])
849		1032
850	Return the current selection text and optionally replace it by C<$newtext>.	1033	Return the current selection text and optionally replace it by C<$newtext>.
851		1034
…		…
941		1124
942	=item $string = $term->locale_decode ($octets)	1125	=item $string = $term->locale_decode ($octets)
943		1126
944	Convert the given locale-encoded octets into a perl string.	1127	Convert the given locale-encoded octets into a perl string.
945		1128
		1129	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1130
		1131	XORs the rendition values in the given span with the provided value
		1132	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1133	refresh hooks to provide effects similar to the selection.
		1134
		1135	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1136
		1137	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1138	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1139	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1140	it instead. Both styles I<MUST NOT> contain font styles.
		1141
946	=item $term->scr_bell	1142	=item $term->scr_bell
947		1143
948	Ring the bell!	1144	Ring the bell!
949		1145
950	=item $term->scr_add_lines ($string)	1146	=item $term->scr_add_lines ($string)
…		…
983		1179
984	=item $windowid = $term->vt	1180	=item $windowid = $term->vt
985		1181
986	Return the window id of the terminal window.	1182	Return the window id of the terminal window.
987		1183
		1184	=item $term->vt_emask_add ($x_event_mask)
		1185
		1186	Adds the specified events to the vt event mask. Useful e.g. when you want
		1187	to receive pointer events all the times:
		1188
		1189	$term->vt_emask_add (urxvt::PointerMotionMask);
		1190
988	=item $window_width = $term->width	1191	=item $window_width = $term->width
989		1192
990	=item $window_height = $term->height	1193	=item $window_height = $term->height
991		1194
992	=item $font_width = $term->fwidth	1195	=item $font_width = $term->fwidth
…		…
1005		1208
1006	=item $max_scrollback = $term->saveLines	1209	=item $max_scrollback = $term->saveLines
1007		1210
1008	=item $nrow_plus_saveLines = $term->total_rows	1211	=item $nrow_plus_saveLines = $term->total_rows
1009		1212
1010	=item $lines_in_scrollback = $term->nsaved	1213	=item $topmost_scrollback_row = $term->top_row
1011		1214
1012	Return various integers describing terminal characteristics.	1215	Return various integers describing terminal characteristics.
1013		1216
		1217	=item $x_display = $term->display_id
		1218
		1219	Return the DISPLAY used by rxvt-unicode.
		1220
1014	=item $lc_ctype = $term->locale	1221	=item $lc_ctype = $term->locale
1015		1222
1016	Returns the LC_CTYPE category string used by this rxvt-unicode.	1223	Returns the LC_CTYPE category string used by this rxvt-unicode.
1017		1224
1018	=item $x_display = $term->display_id	1225	=item $env = $term->env
1019		1226
1020	Return the DISPLAY used by rxvt-unicode.	1227	Returns a copy of the environment in effect for the terminal as a hashref
		1228	similar to C<\%ENV>.
		1229
		1230	=cut
		1231
		1232	sub env {
		1233	if (my $env = $_[0]->_env) {
		1234	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1235	} else {
		1236	+{ %ENV }
		1237	}
		1238	}
1021		1239
1022	=item $modifiermask = $term->ModLevel3Mask	1240	=item $modifiermask = $term->ModLevel3Mask
1023		1241
1024	=item $modifiermask = $term->ModMetaMask	1242	=item $modifiermask = $term->ModMetaMask
1025		1243
…		…
1028	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1246	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1029	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1247	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1030		1248
1031	=item $view_start = $term->view_start ([$newvalue])	1249	=item $view_start = $term->view_start ([$newvalue])
1032		1250
1033	Returns the negative row number of the topmost line. Minimum value is	1251	Returns the row number of the topmost displayed line. Maximum value is
1034	C<0>, which displays the normal terminal contents. Larger values scroll	1252	C<0>, which displays the normal terminal contents. Lower values scroll
1035	this many lines into the scrollback buffer.	1253	this many lines into the scrollback buffer.
1036		1254
1037	=item $term->want_refresh	1255	=item $term->want_refresh
1038		1256
1039	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1257	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1118	Return the row number of the first/last row of the line, respectively.	1336	Return the row number of the first/last row of the line, respectively.
1119		1337
1120	=item $offset = $line->offset_of ($row, $col)	1338	=item $offset = $line->offset_of ($row, $col)
1121		1339
1122	Returns the character offset of the given row\|col pair within the logical	1340	Returns the character offset of the given row\|col pair within the logical
1123	line.	1341	line. Works for rows outside the line, too, and returns corresponding
		1342	offsets outside the string.
1124		1343
1125	=item ($row, $col) = $line->coord_of ($offset)	1344	=item ($row, $col) = $line->coord_of ($offset)
1126		1345
1127	Translates a string offset into terminal coordinates again.	1346	Translates a string offset into terminal coordinates again.
1128		1347
…		…
1265	$item->{render} \|\|= sub { $_[0]{text} };	1484	$item->{render} \|\|= sub { $_[0]{text} };
1266		1485
1267	push @{ $self->{item} }, $item;	1486	push @{ $self->{item} }, $item;
1268	}	1487	}
1269		1488
		1489	=item $popup->add_title ($title)
		1490
		1491	Adds a non-clickable title to the popup.
		1492
		1493	=cut
		1494
		1495	sub add_title {
		1496	my ($self, $title) = @_;
		1497
		1498	$self->add_item ({
		1499	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1500	text => $title,
		1501	activate => sub { },
		1502	});
		1503	}
		1504
		1505	=item $popup->add_separator ([$sepchr])
		1506
		1507	Creates a separator, optionally using the character given as C<$sepchr>.
		1508
		1509	=cut
		1510
1270	sub add_separator {	1511	sub add_separator {
1271	my ($self, $sep) = @_;	1512	my ($self, $sep) = @_;
1272		1513
1273	$sep \|\|= "=";	1514	$sep \|\|= "=";
1274		1515
…		…
1278	render => sub { $sep x $self->{term}->ncol },	1519	render => sub { $sep x $self->{term}->ncol },
1279	activate => sub { },	1520	activate => sub { },
1280	});	1521	});
1281	}	1522	}
1282		1523
1283	sub add_title {	1524	=item $popup->add_button ($text, $cb)
1284	my ($self, $title) = @_;
1285		1525
1286	$self->add_item ({	1526	Adds a clickable button to the popup. C<$cb> is called whenever it is
1287	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1527	selected.
1288	text => $title,	1528
1289	activate => sub { },	1529	=cut
1290	});
1291	}
1292		1530
1293	sub add_button {	1531	sub add_button {
1294	my ($self, $text, $cb) = @_;	1532	my ($self, $text, $cb) = @_;
1295		1533
1296	$self->add_item ({ type => "button", text => $text, activate => $cb});	1534	$self->add_item ({ type => "button", text => $text, activate => $cb});
1297	}	1535	}
		1536
		1537	=item $popup->add_toggle ($text, $cb, $initial_value)
		1538
		1539	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1540	whenever it gets toggled, with a boolean indicating its value as its first
		1541	argument.
		1542
		1543	=cut
1298		1544
1299	sub add_toggle {	1545	sub add_toggle {
1300	my ($self, $text, $cb, $value) = @_;	1546	my ($self, $text, $cb, $value) = @_;
1301		1547
1302	my $item; $item = {	1548	my $item; $item = {
1303	type => "button",	1549	type => "button",
1304	text => " $text",	1550	text => " $text",
1305	value => $value,	1551	value => $value,
1306	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1552	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1307	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1553	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1308	};	1554	};
1309		1555
1310	$self->add_item ($item);	1556	$self->add_item ($item);
1311	}	1557	}
		1558
		1559	=item $popup->show
		1560
		1561	Displays the popup (which is initially hidden).
		1562
		1563	=cut
1312		1564
1313	sub show {	1565	sub show {
1314	my ($self) = @_;	1566	my ($self) = @_;
1315		1567
1316	local $urxvt::popup::self = $self;	1568	local $urxvt::popup::self = $self;
1317		1569
		1570	my $env = $self->{term}->env;
		1571	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1572	delete $env->{LC_ALL};
1318	local $ENV{LC_ALL} = $self->{term}->locale;	1573	$env->{LC_CTYPE} = $self->{term}->locale;
1319		1574
		1575	urxvt::term->new ($env, $self->{term}->resource ("name"),
1320	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1576	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1321	"--transient-for" => $self->{term}->parent,	1577	"--transient-for" => $self->{term}->parent,
1322	"-display" => $self->{term}->display_id,	1578	"-display" => $self->{term}->display_id,
1323	"-pe" => "urxvt-popup")	1579	"-pe" => "urxvt-popup")
1324	or die "unable to create popup window\n";	1580	or die "unable to create popup window\n";
1325	}	1581	}
1326		1582
1327	sub DESTROY {	1583	sub DESTROY {
1328	my ($self) = @_;	1584	my ($self) = @_;
1329		1585
1330	delete $self->{term}{_destroy}{$self};	1586	delete $self->{term}{_destroy}{$self};
1331	$self->{term}->ungrab;	1587	$self->{term}->ungrab;
1332	}	1588	}
		1589
		1590	=back
1333		1591
1334	=head2 The C<urxvt::timer> Class	1592	=head2 The C<urxvt::timer> Class
1335		1593
1336	This class implements timer watchers/events. Time is represented as a	1594	This class implements timer watchers/events. Time is represented as a
1337	fractional number of seconds since the epoch. Example:	1595	fractional number of seconds since the epoch. Example:
…		…
1444		1702
1445	=item == 0 - fatal messages	1703	=item == 0 - fatal messages
1446		1704
1447	=item >= 3 - script loading and management	1705	=item >= 3 - script loading and management
1448		1706
1449	=item >=10 - all events received	1707	=item >=10 - all called hooks
		1708
		1709	=item >=11 - hook reutrn values
1450		1710
1451	=back	1711	=back
1452		1712
1453	=head1 AUTHOR	1713	=head1 AUTHOR
1454		1714

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC vs. Revision 1.100 by root, Wed Jan 18 08:33:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC vs.
Revision 1.100 by root, Wed Jan 18 08:33:34 2006 UTC