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

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

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